diff --git a/README.md b/README.md index a2a2850..a02f592 100644 --- a/README.md +++ b/README.md @@ -1,23 +1,5 @@ # NOTICE -**This repository is archived and the content on this branch is out of date.** You can find up-to-date AWS technical documentation on the [AWS Documentation website](https://docs.aws.amazon.com/), where you can also submit feedback and suggestions for improvement. +This repository is archived, read-only, and no longer updated. For more information, read [the announcement on the AWS News Blog](https://aws.amazon.com/blogs/aws/retiring-the-aws-documentation-on-github/). -# Announcement - -This repository will be archived and marked read-only next month (June 2023). For more information, read [the announcement on the AWS News Blog](https://aws.amazon.com/blogs/aws/retiring-the-aws-documentation-on-github/). - -You can find the corresponding content for this repo on [the AWS Documentation website](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide). If you'd like to continue contributing to the quality of AWS documentation, you can submit feedback and suggestions for improvement there. - -## Amazon RDS User Guide - -The open source version of the Amazon RDS docs. You can submit feedback & requests for changes by submitting issues in this repo or by making proposed changes & submitting a pull request. - -## License Summary - -The documentation is made available under the Creative Commons Attribution-ShareAlike 4.0 International License. See the LICENSE file. - -The sample code within this documentation is made available under a modified MIT license. See the LICENSE-SAMPLECODE file. - -## Default branch -The default branch for this repo has changed to `main`. -If you have cloned the previous default branch, please update your local repo to use the `main` branch. +You can find up-to-date AWS technical documentation on the [AWS Documentation website](https://docs.aws.amazon.com/), where you can also submit feedback and suggestions for improvement. diff --git a/doc_source/APITroubleshooting.md b/doc_source/APITroubleshooting.md deleted file mode 100644 index abd87a0..0000000 --- a/doc_source/APITroubleshooting.md +++ /dev/null @@ -1,35 +0,0 @@ -# Troubleshooting applications on Amazon RDS - -Amazon RDS provides specific and descriptive errors to help you troubleshoot problems while interacting with the Amazon RDS API\. - -**Topics** -+ [Retrieving errors](#RetrievingErrors) -+ [Troubleshooting tips](#TroubleshootingTipss) - - For information about troubleshooting for Amazon RDS DB instances, see [Troubleshooting for Amazon RDS](CHAP_Troubleshooting.md)\. - -## Retrieving errors - -Typically, you want your application to check whether a request generated an error before you spend any time processing results\. The easiest way to find out if an error occurred is to look for an `Error` node in the response from the Amazon RDS API\. - -XPath syntax provides a simple way to search for the presence of an `Error` node\. It also provides a relatively easy way to retrieve the error code and message\. The following code snippet uses Perl and the XML::XPath module to determine if an error occurred during a request\. If an error occurred, the code prints the first error code and message in the response\. - -``` -use XML::XPath; - my $xp = XML::XPath->new(xml =>$response); - if ( $xp->find("//Error") ) - {print "There was an error processing your request:\n", " Error code: ", - $xp->findvalue("//Error[1]/Code"), "\n", " ", - $xp->findvalue("//Error[1]/Message"), "\n\n"; } -``` - -## Troubleshooting tips - - We recommend the following processes to diagnose and resolve problems with the Amazon RDS API: -+ Verify that Amazon RDS is operating normally in the AWS Region that you're targeting by checking [http://status\.aws\.amazon\.com](http://status.aws.amazon.com/)\. -+ Check the structure of your request\. - - Each Amazon RDS operation has a reference page in the *Amazon RDS API Reference*\. Double\-check that you are using parameters correctly\. For ideas about what might be wrong, look at the sample requests or user scenarios to see if those examples do similar operations\. -+ Check AWS re:Post\. - - Amazon RDS has a development community where you can search for solutions to problems others have experienced along the way\. To view the topics, go to [AWS re:Post](https://repost.aws/)\. \ No newline at end of file diff --git a/doc_source/Appendix.MariaDB.Options.md b/doc_source/Appendix.MariaDB.Options.md deleted file mode 100644 index 103016f..0000000 --- a/doc_source/Appendix.MariaDB.Options.md +++ /dev/null @@ -1,71 +0,0 @@ -# Options for MariaDB database engine - -Following, you can find descriptions for options, or additional features, that are available for Amazon RDS instances running the MariaDB DB engine\. To turn on these options, you add them to a custom option group, and then associate the option group with your DB instance\. For more information about working with option groups, see [Working with option groups](USER_WorkingWithOptionGroups.md)\. - -Amazon RDS supports the following options for MariaDB: - - -| Option ID | Engine versions | -| --- | --- | -| `MARIADB_AUDIT_PLUGIN` | MariaDB 10\.3 and higher | - -## MariaDB Audit Plugin support - -Amazon RDS supports using the MariaDB Audit Plugin on MariaDB database instances\. The MariaDB Audit Plugin records database activity such as users logging on to the database, queries run against the database, and more\. The record of database activity is stored in a log file\. - -### Audit Plugin option settings - -Amazon RDS supports the following settings for the MariaDB Audit Plugin option\. - -**Note** -If you don't configure an option setting in the RDS console, RDS uses the default setting\. - - -| Option setting | Valid values | Default value | Description | -| --- | --- | --- | --- | -| `SERVER_AUDIT_FILE_PATH` | `/rdsdbdata/log/audit/` | `/rdsdbdata/log/audit/` | The location of the log file\. The log file contains the record of the activity specified in `SERVER_AUDIT_EVENTS`\. For more information, see [Viewing and listing database log files](USER_LogAccess.Procedural.Viewing.md) and [MariaDB database log files](USER_LogAccess.Concepts.MariaDB.md)\. | -| `SERVER_AUDIT_FILE_ROTATE_SIZE` | 1–1000000000 | 1000000 | The size in bytes that when reached, causes the file to rotate\. For more information, see [Log file size](USER_LogAccess.Concepts.MariaDB.md#USER_LogAccess.MariaDB.LogFileSize)\. | -| `SERVER_AUDIT_FILE_ROTATIONS` | 0–100 | 9 | The number of log rotations to save when `server_audit_output_type=file`\. If set to 0, then the log file never rotates\. For more information, see [Log file size](USER_LogAccess.Concepts.MariaDB.md#USER_LogAccess.MariaDB.LogFileSize) and [Downloading a database log file](USER_LogAccess.Procedural.Downloading.md)\. | -| `SERVER_AUDIT_EVENTS` | `CONNECT`, `QUERY`, `TABLE`, `QUERY_DDL`, `QUERY_DML`, `QUERY_DML_NO_SELECT`, `QUERY_DCL` | `CONNECT`, `QUERY` | The types of activity to record in the log\. Installing the MariaDB Audit Plugin is itself logged\. [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Appendix.MariaDB.Options.html) | -| `SERVER_AUDIT_INCL_USERS` | Multiple comma\-separated values | None | Include only activity from the specified users\. By default, activity is recorded for all users\. `SERVER_AUDIT_INCL_USERS` and `SERVER_AUDIT_EXCL_USERS` are mutually exclusive\. If you add values to `SERVER_AUDIT_INCL_USERS`, make sure no values are added to `SERVER_AUDIT_EXCL_USERS`\. | -| `SERVER_AUDIT_EXCL_USERS` | Multiple comma\-separated values | None | Exclude activity from the specified users\. By default, activity is recorded for all users\. `SERVER_AUDIT_INCL_USERS` and `SERVER_AUDIT_EXCL_USERS` are mutually exclusive\. If you add values to `SERVER_AUDIT_EXCL_USERS`, make sure no values are added to `SERVER_AUDIT_INCL_USERS`\. The `rdsadmin` user queries the database every second to check the health of the database\. Depending on your other settings, this activity can possibly cause the size of your log file to grow very large, very quickly\. If you don't need to record this activity, add the `rdsadmin` user to the `SERVER_AUDIT_EXCL_USERS` list\. `CONNECT` activity is always recorded for all users, even if the user is specified for this option setting\. | -| `SERVER_AUDIT_LOGGING` | `ON` | `ON` | Logging is active\. The only valid value is `ON`\. Amazon RDS does not support deactivating logging\. If you want to deactivate logging, remove the MariaDB Audit Plugin\. For more information, see [Removing the MariaDB Audit Plugin](#Appendix.MariaDB.Options.AuditPlugin.Remove)\. | -| `SERVER_AUDIT_QUERY_LOG_LIMIT` | 0–2147483647 | 1024 | The limit on the length of the query string in a record\. | - -### Adding the MariaDB Audit Plugin - -The general process for adding the MariaDB Audit Plugin to a DB instance is the following: - -1. Create a new option group, or copy or modify an existing option group\. - -1. Add the option to the option group\. - -1. Associate the option group with the DB instance\. - -After you add the MariaDB Audit Plugin, you don't need to restart your DB instance\. As soon as the option group is active, auditing begins immediately\. - -**To add the MariaDB Audit Plugin** - -1. Determine the option group you want to use\. You can create a new option group or use an existing option group\. If you want to use an existing option group, skip to the next step\. Otherwise, create a custom DB option group\. Choose **mariadb** for **Engine**, and choose **10\.3** or higher for **Major engine version**\. For more information, see [Creating an option group](USER_WorkingWithOptionGroups.md#USER_WorkingWithOptionGroups.Create)\. - -1. Add the **MARIADB\_AUDIT\_PLUGIN** option to the option group, and configure the option settings\. For more information about adding options, see [Adding an option to an option group](USER_WorkingWithOptionGroups.md#USER_WorkingWithOptionGroups.AddOption)\. For more information about each setting, see [Audit Plugin option settings](#Appendix.MariaDB.Options.AuditPlugin.Options)\. - -1. Apply the option group to a new or existing DB instance\. - + For a new DB instance, you apply the option group when you launch the instance\. For more information, see [Creating an Amazon RDS DB instance](USER_CreateDBInstance.md)\. - + For an existing DB instance, you apply the option group by modifying the DB instance and attaching the new option group\. For more information, see [Modifying an Amazon RDS DB instance](Overview.DBInstance.Modifying.md)\. - -### Viewing and downloading the MariaDB Audit Plugin log - -After you enable the MariaDB Audit Plugin, you access the results in the log files the same way you access any other text\-based log files\. The audit log files are located at `/rdsdbdata/log/audit/`\. For information about viewing the log file in the console, see [Viewing and listing database log files](USER_LogAccess.Procedural.Viewing.md)\. For information about downloading the log file, see [Downloading a database log file](USER_LogAccess.Procedural.Downloading.md)\. - -### Modifying MariaDB Audit Plugin settings - -After you enable the MariaDB Audit Plugin, you can modify settings for the plugin\. For more information about how to modify option settings, see [Modifying an option setting](USER_WorkingWithOptionGroups.md#USER_WorkingWithOptionGroups.ModifyOption)\. For more information about each setting, see [Audit Plugin option settings](#Appendix.MariaDB.Options.AuditPlugin.Options)\. - -### Removing the MariaDB Audit Plugin - -Amazon RDS doesn't support turning off logging in the MariaDB Audit Plugin\. However, you can remove the plugin from a DB instance\. When you remove the MariaDB Audit Plugin, the DB instance is restarted automatically to stop auditing\. - -To remove the MariaDB Audit Plugin from a DB instance, do one of the following: -+ Remove the MariaDB Audit Plugin option from the option group it belongs to\. This change affects all DB instances that use the option group\. For more information, see [Removing an option from an option group](USER_WorkingWithOptionGroups.md#USER_WorkingWithOptionGroups.RemoveOption) -+ Modify the DB instance and specify a different option group that doesn't include the plugin\. This change affects a single DB instance\. You can specify the default \(empty\) option group, or a different custom option group\. For more information, see [Modifying an Amazon RDS DB instance](Overview.DBInstance.Modifying.md)\. \ No newline at end of file diff --git a/doc_source/Appendix.MariaDB.Parameters.md b/doc_source/Appendix.MariaDB.Parameters.md deleted file mode 100644 index 6bfcb4b..0000000 --- a/doc_source/Appendix.MariaDB.Parameters.md +++ /dev/null @@ -1,137 +0,0 @@ -# Parameters for MariaDB - -By default, a MariaDB DB instance uses a DB parameter group that is specific to a MariaDB database\. This parameter group contains some but not all of the parameters contained in the Amazon RDS DB parameter groups for the MySQL database engine\. It also contains a number of new, MariaDB\-specific parameters\. For information about working with parameter groups and setting parameters, see [Working with parameter groups](USER_WorkingWithParamGroups.md)\. - -## Viewing MariaDB parameters - -RDS for MariaDB parameters are set to the default values of the storage engine that you have selected\. For more information about MariaDB parameters, see the [MariaDB documentation](http://mariadb.com/kb/en/mariadb/documentation/)\. For more information about MariaDB storage engines, see [Supported storage engines for MariaDB on Amazon RDS](MariaDB.Concepts.FeatureSupport.md#MariaDB.Concepts.Storage)\. - -You can view the parameters available for a specific RDS for MariaDB version using the RDS console or the AWS CLI\. For information about viewing the parameters in a MariaDB parameter group in the RDS console, see [Viewing parameter values for a DB parameter group](USER_WorkingWithDBInstanceParamGroups.md#USER_WorkingWithParamGroups.Viewing)\. - -Using the AWS CLI, you can view the parameters for an RDS for MariaDB version by running the [https://docs.aws.amazon.com/cli/latest/reference/rds/describe-engine-default-parameters.html](https://docs.aws.amazon.com/cli/latest/reference/rds/describe-engine-default-parameters.html) command\. Specify one of the following values for the `--db-parameter-group-family` option: -+ `mariadb10.6` -+ `mariadb10.5` -+ `mariadb10.4` -+ `mariadb10.3` - -For example, to view the parameters for RDS for MariaDB version 10\.6, run the following command\. - -``` -aws rds describe-engine-default-parameters --db-parameter-group-family mariadb10.6 -``` - -Your output looks similar to the following\. - -``` -{ - "EngineDefaults": { - "Parameters": [ - { - "ParameterName": "alter_algorithm", - "Description": "Specify the alter table algorithm.", - "Source": "engine-default", - "ApplyType": "dynamic", - "DataType": "string", - "AllowedValues": "DEFAULT,COPY,INPLACE,NOCOPY,INSTANT", - "IsModifiable": true - }, - { - "ParameterName": "analyze_sample_percentage", - "Description": "Percentage of rows from the table ANALYZE TABLE will sample to collect table statistics.", - "Source": "engine-default", - "ApplyType": "dynamic", - "DataType": "float", - "AllowedValues": "0-100", - "IsModifiable": true - }, - { - "ParameterName": "aria_block_size", - "Description": "Block size to be used for Aria index pages.", - "Source": "engine-default", - "ApplyType": "static", - "DataType": "integer", - "AllowedValues": "1024-32768", - "IsModifiable": false - }, - { - "ParameterName": "aria_checkpoint_interval", - "Description": "Interval in seconds between automatic checkpoints.", - "Source": "engine-default", - "ApplyType": "dynamic", - "DataType": "integer", - "AllowedValues": "0-4294967295", - "IsModifiable": true - }, - ... -``` - -To list only the modifiable parameters for RDS for MariaDB version 10\.6, run the following command\. - -For Linux, macOS, or Unix: - -``` -aws rds describe-engine-default-parameters --db-parameter-group-family mariadb10.6 \ - --query 'EngineDefaults.Parameters[?IsModifiable==`true`]' -``` - -For Windows: - -``` -aws rds describe-engine-default-parameters --db-parameter-group-family mariadb10.6 ^ - --query "EngineDefaults.Parameters[?IsModifiable==`true`]" -``` - -## MySQL parameters that aren't available - -The following MySQL parameters are not available in MariaDB\-specific DB parameter groups: -+ bind\_address -+ binlog\_error\_action -+ binlog\_gtid\_simple\_recovery -+ binlog\_max\_flush\_queue\_time -+ binlog\_order\_commits -+ binlog\_row\_image -+ binlog\_rows\_query\_log\_events -+ binlogging\_impossible\_mode -+ block\_encryption\_mode -+ core\_file -+ default\_tmp\_storage\_engine -+ div\_precision\_increment -+ end\_markers\_in\_json -+ enforce\_gtid\_consistency -+ eq\_range\_index\_dive\_limit -+ explicit\_defaults\_for\_timestamp -+ gtid\_executed -+ gtid\-mode -+ gtid\_next -+ gtid\_owned -+ gtid\_purged -+ log\_bin\_basename -+ log\_bin\_index -+ log\_bin\_use\_v1\_row\_events -+ log\_slow\_admin\_statements -+ log\_slow\_slave\_statements -+ log\_throttle\_queries\_not\_using\_indexes -+ master\-info\-repository -+ optimizer\_trace -+ optimizer\_trace\_features -+ optimizer\_trace\_limit -+ optimizer\_trace\_max\_mem\_size -+ optimizer\_trace\_offset -+ relay\_log\_info\_repository -+ rpl\_stop\_slave\_timeout -+ slave\_parallel\_workers -+ slave\_pending\_jobs\_size\_max -+ slave\_rows\_search\_algorithms -+ storage\_engine -+ table\_open\_cache\_instances -+ timed\_mutexes -+ transaction\_allow\_batching -+ validate\-password -+ validate\_password\_dictionary\_file -+ validate\_password\_length -+ validate\_password\_mixed\_case\_count -+ validate\_password\_number\_count -+ validate\_password\_policy -+ validate\_password\_special\_char\_count - -For more information on MySQL parameters, see the [MySQL documentation](https://dev.mysql.com/doc/refman/8.0/en/)\. \ No newline at end of file diff --git a/doc_source/Appendix.MariaDB.SQLRef.md b/doc_source/Appendix.MariaDB.SQLRef.md deleted file mode 100644 index 7b2dd24..0000000 --- a/doc_source/Appendix.MariaDB.SQLRef.md +++ /dev/null @@ -1,10 +0,0 @@ -# MariaDB on Amazon RDS SQL reference - -Following, you can find descriptions of system stored procedures that are available for Amazon RDS instances running the MariaDB DB engine\. - -You can use the system stored procedures that are available for MySQL DB instances and MariaDB DB instances\. These stored procedures are documented at [RDS for MySQL stored procedure reference](Appendix.MySQL.SQLRef.md)\. MariaDB DB instances support all of the stored procedures, except for `mysql.rds_start_replication_until` and `mysql.rds_start_replication_until_gtid`\. - -Additionally, the following system stored procedures are supported only for Amazon RDS DB instances running MariaDB: -+ [mysql\.rds\_replica\_status](mysql_rds_replica_status.md) -+ [mysql\.rds\_set\_external\_master\_gtid](mysql_rds_set_external_master_gtid.md) -+ [mysql\.rds\_kill\_query\_id](mysql_rds_kill_query_id.md) \ No newline at end of file diff --git a/doc_source/Appendix.MySQL.CommonDBATasks.Logs.md b/doc_source/Appendix.MySQL.CommonDBATasks.Logs.md deleted file mode 100644 index 4541f40..0000000 --- a/doc_source/Appendix.MySQL.CommonDBATasks.Logs.md +++ /dev/null @@ -1,14 +0,0 @@ -# Managing table\-based MySQL logs - -You can direct the general and slow query logs to tables on the DB instance by creating a DB parameter group and setting the `log_output` server parameter to `TABLE`\. General queries are then logged to the `mysql.general_log` table, and slow queries are logged to the `mysql.slow_log` table\. You can query the tables to access the log information\. Enabling this logging increases the amount of data written to the database, which can degrade performance\. - -Both the general log and the slow query logs are disabled by default\. In order to enable logging to tables, you must also set the `general_log` and `slow_query_log` server parameters to `1`\. - -Log tables keep growing until the respective logging activities are turned off by resetting the appropriate parameter to `0`\. A large amount of data often accumulates over time, which can use up a considerable percentage of your allocated storage space\. Amazon RDS doesn't allow you to truncate the log tables, but you can move their contents\. Rotating a table saves its contents to a backup table and then creates a new empty log table\. You can manually rotate the log tables with the following command line procedures, where the command prompt is indicated by `PROMPT>`: - -``` -PROMPT> CALL mysql.rds_rotate_slow_log; -PROMPT> CALL mysql.rds_rotate_general_log; -``` - -To completely remove the old data and reclaim the disk space, call the appropriate procedure twice in succession\. \ No newline at end of file diff --git a/doc_source/Appendix.MySQL.CommonDBATasks.md b/doc_source/Appendix.MySQL.CommonDBATasks.md deleted file mode 100644 index 353be82..0000000 --- a/doc_source/Appendix.MySQL.CommonDBATasks.md +++ /dev/null @@ -1,179 +0,0 @@ -# Common DBA tasks for MySQL DB instances - -Following, you can find descriptions of the Amazon RDS–specific implementations of some common DBA tasks for DB instances running the MySQL database engine\. To deliver a managed service experience, Amazon RDS doesn't provide shell access to DB instances\. Also, it restricts access to certain system procedures and tables that require advanced privileges\. - -For information about working with MySQL log files on Amazon RDS, see [MySQL database log files](USER_LogAccess.Concepts.MySQL.md)\. - -**Topics** -+ [Ending a session or query](#Appendix.MySQL.CommonDBATasks.End) -+ [Skipping the current replication error](#Appendix.MySQL.CommonDBATasks.SkipError) -+ [Working with InnoDB tablespaces to improve crash recovery times](#Appendix.MySQL.CommonDBATasks.Tables) -+ [Managing the Global Status History](#Appendix.MySQL.CommonDBATasks.GoSH) - -## Ending a session or query - -You can end user sessions or queries on DB instances by using the `rds_kill` and `rds_kill_query` commands\. First connect to your MySQL DB instance, then issue the appropriate command as shown following\. For more information, see [Connecting to a DB instance running the MySQL database engine](USER_ConnectToInstance.md)\. - -``` -CALL mysql.rds_kill(thread-ID) -CALL mysql.rds_kill_query(thread-ID) -``` - -For example, to end the session that is running on thread 99, you would type the following: - -``` -CALL mysql.rds_kill(99); -``` - -To end the query that is running on thread 99, you would type the following: - -``` -CALL mysql.rds_kill_query(99); -``` - -## Skipping the current replication error - -You can skip an error on your read replica if the error is causing your read replica to stop responding and the error doesn't affect the integrity of your data\. - -**Note** -First verify that the error in question can be safely skipped\. In a MySQL utility, connect to the read replica and run the following MySQL command\. - -``` -SHOW REPLICA STATUS\G -``` -For information about the values returned, see [the MySQL documentation](https://dev.mysql.com/doc/refman/8.0/en/show-replica-status.html)\. -Previous versions of and MySQL used `SHOW SLAVE STATUS` instead of `SHOW REPLICA STATUS`\. If you are using a MySQL version before 8\.0\.23, then use `SHOW SLAVE STATUS`\. - -You can skip an error on your read replica in the following ways\. - -**Topics** -+ [Calling the mysql\.rds\_skip\_repl\_error procedure](#Appendix.MySQL.CommonDBATasks.SkipError.procedure) -+ [Setting the slave\_skip\_errors parameter](#Appendix.MySQL.CommonDBATasks.SkipError.parameter) - -### Calling the mysql\.rds\_skip\_repl\_error procedure - -Amazon RDS provides a stored procedure that you can call to skip an error on your read replicas\. First connect to your read replica, then issue the appropriate commands as shown following\. For more information, see [Connecting to a DB instance running the MySQL database engine](USER_ConnectToInstance.md)\. - - To skip the error, issue the following command\. - -``` -CALL mysql.rds_skip_repl_error; -``` - -This command has no effect if you run it on the source DB instance, or on a read replica that hasn't encountered a replication error\. - -For more information, such as the versions of MySQL that support `mysql.rds_skip_repl_error`, see [mysql\.rds\_skip\_repl\_error](mysql-stored-proc-replicating.md#mysql_rds_skip_repl_error)\. - -**Important** -If you attempt to call `mysql.rds_skip_repl_error` and encounter the following error: `ERROR 1305 (42000): PROCEDURE mysql.rds_skip_repl_error does not exist`, then upgrade your MySQL DB instance to the latest minor version or one of the minimum minor versions listed in [mysql\.rds\_skip\_repl\_error](mysql-stored-proc-replicating.md#mysql_rds_skip_repl_error)\. - -### Setting the slave\_skip\_errors parameter - -To skip one or more errors, you can set the `slave_skip_errors` static parameter on the read replica\. You can set this parameter to skip one or more specific replication error codes\. Currently, you can set this parameter only for RDS for MySQL 5\.7 DB instances\. After you change the setting for this parameter, make sure to reboot your DB instance for the new setting to take effect\. For information about setting this parameter, see the [MySQL documentation](https://dev.mysql.com/doc/refman/5.7/en/replication-options-replica.html#sysvar_slave_skip_errors)\. - -We recommend setting this parameter in a separate DB parameter group\. You can associate this DB parameter group only with the read replicas that need to skip errors\. Following this best practice reduces the potential impact on other DB instances and read replicas\. - -**Important** -Setting a nondefault value for this parameter can lead to replication inconsistency\. Only set this parameter to a nondefault value if you have exhausted other options to resolve the problem and you are sure of the potential impact on your read replica's data\. - -## Working with InnoDB tablespaces to improve crash recovery times - -Every table in MySQL consists of a table definition, data, and indexes\. The MySQL storage engine InnoDB stores table data and indexes in a *tablespace*\. InnoDB creates a global shared tablespace that contains a data dictionary and other relevant metadata, and it can contain table data and indexes\. InnoDB can also create separate tablespaces for each table and partition\. These separate tablespaces are stored in files with a \.ibd extension and the header of each tablespace contains a number that uniquely identifies it\. - -Amazon RDS provides a parameter in a MySQL parameter group called `innodb_file_per_table`\. This parameters controls whether InnoDB adds new table data and indexes to the shared tablespace \(by setting the parameter value to 0\) or to individual tablespaces \(by setting the parameter value to 1\)\. Amazon RDS sets the default value for `innodb_file_per_table` parameter to 1, which allows you to drop individual InnoDB tables and reclaim storage used by those tables for the DB instance\. In most use cases, setting the `innodb_file_per_table` parameter to 1 is the recommended setting\. - -You should set the `innodb_file_per_table` parameter to 0 when you have a large number of tables, such as over 1000 tables when you use standard \(magnetic\) or general purpose SSD storage or over 10,000 tables when you use Provisioned IOPS storage\. When you set this parameter to 0, individual tablespaces are not created and this can improve the time it takes for database crash recovery\. - -MySQL processes each metadata file, which includes tablespaces, during the crash recovery cycle\. The time it takes MySQL to process the metadata information in the shared tablespace is negligible compared to the time it takes to process thousands of tablespace files when there are multiple tablespaces\. Because the tablespace number is stored within the header of each file, the aggregate time to read all the tablespace files can take up to several hours\. For example, a million InnoDB tablespaces on standard storage can take from five to eight hours to process during a crash recovery cycle\. In some cases, InnoDB can determine that it needs additional cleanup after a crash recovery cycle so it will begin another crash recovery cycle, which will extend the recovery time\. Keep in mind that a crash recovery cycle also entails rolling\-back transactions, fixing broken pages, and other operations in addition to the processing of tablespace information\. - -Since the `innodb_file_per_table` parameter resides in a parameter group, you can change the parameter value by editing the parameter group used by your DB instance without having to reboot the DB instance\. After the setting is changed, for example, from 1 \(create individual tables\) to 0 \(use shared tablespace\), new InnoDB tables will be added to the shared tablespace while existing tables continue to have individual tablespaces\. To move an InnoDB table to the shared tablespace, you must use the `ALTER TABLE` command\. - -### Migrating multiple tablespaces to the shared tablespace - -You can move an InnoDB table's metadata from its own tablespace to the shared tablespace, which will rebuild the table metadata according to the `innodb_file_per_table` parameter setting\. First connect to your MySQL DB instance, then issue the appropriate commands as shown following\. For more information, see [Connecting to a DB instance running the MySQL database engine](USER_ConnectToInstance.md)\. - -``` -ALTER TABLE table_name ENGINE = InnoDB, ALGORITHM=COPY; -``` - -For example, the following query returns an `ALTER TABLE` statement for every InnoDB table that is not in the shared tablespace\. - -**For MySQL 5\.7 DB instances:** - -``` -SELECT CONCAT('ALTER TABLE `', -REPLACE(LEFT(NAME , INSTR((NAME), '/') - 1), '`', '``'), '`.`', -REPLACE(SUBSTR(NAME FROM INSTR(NAME, '/') + 1), '`', '``'), '` ENGINE=InnoDB, ALGORITHM=COPY;') AS Query -FROM INFORMATION_SCHEMA.INNODB_SYS_TABLES -WHERE SPACE <> 0 AND LEFT(NAME, INSTR((NAME), '/') - 1) NOT IN ('mysql',''); -``` - -**For MySQL 8\.0 DB instances:** - -``` -SELECT CONCAT('ALTER TABLE `', -REPLACE(LEFT(NAME , INSTR((NAME), '/') - 1), '`', '``'), '`.`', -REPLACE(SUBSTR(NAME FROM INSTR(NAME, '/') + 1), '`', '``'), '` ENGINE=InnoDB, ALGORITHM=COPY;') AS Query -FROM INFORMATION_SCHEMA.INNODB_TABLES -WHERE SPACE <> 0 AND LEFT(NAME, INSTR((NAME), '/') - 1) NOT IN ('mysql',''); -``` - -Rebuilding a MySQL table to move the table's metadata to the shared tablespace requires additional storage space temporarily to rebuild the table, so the DB instance must have storage space available\. During rebuilding, the table is locked and inaccessible to queries\. For small tables or tables not frequently accessed, this might not be an issue\. For large tables or tables frequently accessed in a heavily concurrent environment, you can rebuild tables on a read replica\. - -You can create a read replica and migrate table metadata to the shared tablespace on the read replica\. While the ALTER TABLE statement blocks access on the read replica, the source DB instance is not affected\. The source DB instance will continue to generate its binary logs while the read replica lags during the table rebuilding process\. Because the rebuilding requires additional storage space and the replay log file can become large, you should create a read replica with storage allocated that is larger than the source DB instance\. - -To create a read replica and rebuild InnoDB tables to use the shared tablespace, take the following steps: - -1. Make sure that backup retention is enabled on the source DB instance so that binary logging is enabled\. - -1. Use the AWS Management Console or AWS CLI to create a read replica for the source DB instance\. Because the creation of a read replica involves many of the same processes as crash recovery, the creation process can take some time if there is a large number of InnoDB tablespaces\. Allocate more storage space on the read replica than is currently used on the source DB instance\. - -1. When the read replica has been created, create a parameter group with the parameter settings `read_only = 0` and `innodb_file_per_table = 0`\. Then associate the parameter group with the read replica\. - -1. Issue the following SQL statement for all tables that you want migrated on the replica: - - ``` - ALTER TABLE name ENGINE = InnoDB - ``` - -1. When all of your `ALTER TABLE` statements have completed on the read replica, verify that the read replica is connected to the source DB instance and that the two instances are in sync\. - -1. Use the console or CLI to promote the read replica to be the instance\. Make sure that the parameter group used for the new standalone DB instance has the `innodb_file_per_table` parameter set to 0\. Change the name of the new standalone DB instance, and point any applications to the new standalone DB instance\. - -## Managing the Global Status History - -MySQL maintains many status variables that provide information about its operation\. Their value can help you detect locking or memory issues on a DB instance\. The values of these status variables are cumulative since last time the DB instance was started\. You can reset most status variables to 0 by using the `FLUSH STATUS` command\. - -To allow for monitoring of these values over time, Amazon RDS provides a set of procedures that will snapshot the values of these status variables over time and write them to a table, along with any changes since the last snapshot\. This infrastructure, called Global Status History \(GoSH\), is installed on all MySQL DB instances starting with versions 5\.5\.23\. GoSH is disabled by default\. - -To enable GoSH, you first enable the event scheduler from a DB parameter group by setting the parameter event\_scheduler to ON\. For information about creating and modifying a DB parameter group, see [Working with parameter groups](USER_WorkingWithParamGroups.md)\. - -You can then use the procedures in the following table to enable and configure GoSH\. First connect to your MySQL DB instance, then issue the appropriate commands as shown following\. For more information, see [Connecting to a DB instance running the MySQL database engine](USER_ConnectToInstance.md)\. For each procedure, type the following: - -``` -CALL procedure-name; -``` - -Where *procedure\-name* is one of the procedures in the table\. - - -**** - -| Procedure | Description | -| --- | --- | -| `mysql.rds_enable_gsh_collector` | Enables GoSH to take default snapshots at intervals specified by `rds_set_gsh_collector`\. | -| `mysql.rds_set_gsh_collector` | Specifies the interval, in minutes, between snapshots\. Default value is 5\. | -| `mysql.rds_disable_gsh_collector` | Disables snapshots\. | -| `mysql.rds_collect_global_status_history` | Takes a snapshot on demand\. | -| `mysql.rds_enable_gsh_rotation` | Enables rotation of the contents of the `mysql.rds_global_status_history` table to `mysql.rds_global_status_history_old` at intervals specified by `rds_set_gsh_rotation`\. | -| `mysql.rds_set_gsh_rotation` | Specifies the interval, in days, between table rotations\. Default value is 7\. | -| `mysql.rds_disable_gsh_rotation` | Disables table rotation\. | -| `mysql.rds_rotate_global_status_history` | Rotates the contents of the `mysql.rds_global_status_history` table to `mysql.rds_global_status_history_old` on demand\. | - -When GoSH is running, you can query the tables that it writes to\. For example, to query the hit ratio of the Innodb buffer pool, you would issue the following query: - -``` -select a.collection_end, a.collection_start, (( a.variable_Delta-b.variable_delta)/a.variable_delta)*100 as "HitRatio" - from mysql.rds_global_status_history as a join mysql.rds_global_status_history as b on a.collection_end = b.collection_end - where a. variable_name = 'Innodb_buffer_pool_read_requests' and b.variable_name = 'Innodb_buffer_pool_reads' -``` \ No newline at end of file diff --git a/doc_source/Appendix.MySQL.Options.AuditPlugin.md b/doc_source/Appendix.MySQL.Options.AuditPlugin.md deleted file mode 100644 index 5448158..0000000 --- a/doc_source/Appendix.MySQL.Options.AuditPlugin.md +++ /dev/null @@ -1,94 +0,0 @@ -# MariaDB Audit Plugin support for MySQL - -Amazon RDS offers an audit plugin for MySQL database instances based on the open source MariaDB Audit Plugin\. For more information, see the [Audit Plugin for MySQL Server GitHub repository](https://github.com/aws/audit-plugin-for-mysql)\. - -**Note** -The audit plugin for MySQL is based on the MariaDB Audit Plugin\. Throughout this article, we refer to it as MariaDB Audit Plugin\. - -The MariaDB Audit Plugin records database activity, including users logging on to the database and queries run against the database\. The record of database activity is stored in a log file\. - -**Note** -Currently, the MariaDB Audit Plugin is only supported for the following RDS for MySQL versions: -MySQL 8\.0\.28 and higher 8\.0 versions -All MySQL 5\.7 versions - -## Audit Plugin option settings - -Amazon RDS supports the following settings for the MariaDB Audit Plugin option\. - - -**** - -| Option setting | Valid values | Default value | Description | -| --- | --- | --- | --- | -| `SERVER_AUDIT_FILE_PATH` | `/rdsdbdata/log/audit/` | `/rdsdbdata/log/audit/` | The location of the log file\. The log file contains the record of the activity specified in `SERVER_AUDIT_EVENTS`\. For more information, see [Viewing and listing database log files](USER_LogAccess.Procedural.Viewing.md) and [MySQL database log files](USER_LogAccess.Concepts.MySQL.md)\. | -| `SERVER_AUDIT_FILE_ROTATE_SIZE` | 1–1000000000 | 1000000 | The size in bytes that when reached, causes the file to rotate\. For more information, see [Overview of RDS for MySQL database logs](USER_LogAccess.MySQL.LogFileSize.md)\. | -| `SERVER_AUDIT_FILE_ROTATIONS` | 0–100 | 9 | The number of log rotations to save when `server_audit_output_type=file`\. If set to 0, then the log file never rotates\. For more information, see [Overview of RDS for MySQL database logs](USER_LogAccess.MySQL.LogFileSize.md) and [Downloading a database log file](USER_LogAccess.Procedural.Downloading.md)\. | -| `SERVER_AUDIT_EVENTS` | `CONNECT`, `QUERY`, `QUERY_DDL`, `QUERY_DML`, `QUERY_DML_NO_SELECT`, `QUERY_DCL` | `CONNECT`, `QUERY` | The types of activity to record in the log\. Installing the MariaDB Audit Plugin is itself logged\. [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Appendix.MySQL.Options.AuditPlugin.html) For MySQL, `TABLE` is not supported\. | -| `SERVER_AUDIT_INCL_USERS` | Multiple comma\-separated values | None | Include only activity from the specified users\. By default, activity is recorded for all users\. `SERVER_AUDIT_INCL_USERS` and `SERVER_AUDIT_EXCL_USERS` are mutually exclusive\. If you add values to `SERVER_AUDIT_INCL_USERS`, make sure no values are added to `SERVER_AUDIT_EXCL_USERS`\. | -| `SERVER_AUDIT_EXCL_USERS` | Multiple comma\-separated values | None | Exclude activity from the specified users\. By default, activity is recorded for all users\. `SERVER_AUDIT_INCL_USERS` and `SERVER_AUDIT_EXCL_USERS` are mutually exclusive\. If you add values to `SERVER_AUDIT_EXCL_USERS`, make sure no values are added to `SERVER_AUDIT_INCL_USERS`\. The `rdsadmin` user queries the database every second to check the health of the database\. Depending on your other settings, this activity can possibly cause the size of your log file to grow very large, very quickly\. If you don't need to record this activity, add the `rdsadmin` user to the `SERVER_AUDIT_EXCL_USERS` list\. `CONNECT` activity is always recorded for all users, even if the user is specified for this option setting\. | -| `SERVER_AUDIT_LOGGING` | `ON` | `ON` | Logging is active\. The only valid value is `ON`\. Amazon RDS does not support deactivating logging\. If you want to deactivate logging, remove the MariaDB Audit Plugin\. For more information, see [Removing the MariaDB Audit Plugin](#Appendix.MySQL.Options.AuditPlugin.Remove)\. | -| `SERVER_AUDIT_QUERY_LOG_LIMIT` | 0–2147483647 | 1024 | The limit on the length of the query string in a record\. | - -## Adding the MariaDB Audit Plugin - -The general process for adding the MariaDB Audit Plugin to a DB instance is the following: -+ Create a new option group, or copy or modify an existing option group -+ Add the option to the option group -+ Associate the option group with the DB instance - -After you add the MariaDB Audit Plugin, you don't need to restart your DB instance\. As soon as the option group is active, auditing begins immediately\. - -**Important** -Adding the MariaDB Audit Plugin to a DB instance might cause an outage\. We recommend adding the MariaDB Audit Plugin during a maintenance window or during a time of low database workload\. - -**To add the MariaDB Audit Plugin** - -1. Determine the option group you want to use\. You can create a new option group or use an existing option group\. If you want to use an existing option group, skip to the next step\. Otherwise, create a custom DB option group\. Choose **mysql** for **Engine**, and choose **5\.7** or **8\.0** for **Major engine version**\. For more information, see [Creating an option group](USER_WorkingWithOptionGroups.md#USER_WorkingWithOptionGroups.Create)\. - -1. Add the **MARIADB\_AUDIT\_PLUGIN** option to the option group, and configure the option settings\. For more information about adding options, see [Adding an option to an option group](USER_WorkingWithOptionGroups.md#USER_WorkingWithOptionGroups.AddOption)\. For more information about each setting, see [Audit Plugin option settings](#Appendix.MySQL.Options.AuditPlugin.Options)\. - -1. Apply the option group to a new or existing DB instance\. - + For a new DB instance, you apply the option group when you launch the instance\. For more information, see [Creating an Amazon RDS DB instance](USER_CreateDBInstance.md)\. - + For an existing DB instance, you apply the option group by modifying the instance and attaching the new option group\. For more information, see [Modifying an Amazon RDS DB instance](Overview.DBInstance.Modifying.md)\. - -## Audit log format - -Log files are represented as comma\-separated variable \(CSV\) files in UTF\-8 format\. - -**Tip** -Log file entries are not in sequential order\. To order the entries, use the timestamp value\. To see the latest events, you might have to review all log files\. For more flexibility in sorting and searching the log data, turn on the setting to upload the audit logs to CloudWatch and view them using the CloudWatch interface\. - To view audit data with more types of fields and with output in JSON format, you can also use the Database Activity Streams feature\. For more information, see [Monitoring Amazon RDS with Database Activity Streams](DBActivityStreams.md)\. - -The audit log files include the following comma\-delimited information in rows, in the specified order: - - -| Field | Description | -| --- | --- | -| timestamp | The `YYYYMMDD` followed by the `HH:MI:SS` \(24\-hour clock\) for the logged event\. | -| serverhost | The name of the instance that the event is logged for\. | -| username | The connected user name of the user\. | -| host | The host that the user connected from\. | -| connectionid | The connection ID number for the logged operation\. | -| queryid | The query ID number, which can be used for finding the relational table events and related queries\. For `TABLE` events, multiple lines are added\. | -| operation | The recorded action type\. Possible values are: `CONNECT`, `QUERY`, `READ`, `WRITE`, `CREATE`, `ALTER`, `RENAME`, and `DROP`\. | -| database | The active database, as set by the `USE` command\. | -| object | For `QUERY` events, this value indicates the query that the database performed\. For `TABLE` events, it indicates the table name\. | -| retcode | The return code of the logged operation\. | -| connection\_type | The security state of the connection to the server\. Possible values are: [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Appendix.MySQL.Options.AuditPlugin.html) This field is included only for RDS for MySQL version 5\.7\.34 and higher 5\.7 versions, and all 8\.0 versions\. | - -## Viewing and downloading the MariaDB Audit Plugin log - -After you enable the MariaDB Audit Plugin, you access the results in the log files the same way you access any other text\-based log files\. The audit log files are located at `/rdsdbdata/log/audit/`\. For information about viewing the log file in the console, see [Viewing and listing database log files](USER_LogAccess.Procedural.Viewing.md)\. For information about downloading the log file, see [Downloading a database log file](USER_LogAccess.Procedural.Downloading.md)\. - -## Modifying MariaDB Audit Plugin settings - -After you enable the MariaDB Audit Plugin, you can modify the settings\. For more information about how to modify option settings, see [Modifying an option setting](USER_WorkingWithOptionGroups.md#USER_WorkingWithOptionGroups.ModifyOption)\. For more information about each setting, see [Audit Plugin option settings](#Appendix.MySQL.Options.AuditPlugin.Options)\. - -## Removing the MariaDB Audit Plugin - -Amazon RDS doesn't support turning off logging in the MariaDB Audit Plugin\. However, you can remove the plugin from a DB instance\. When you remove the MariaDB Audit Plugin, the DB instance is restarted automatically to stop auditing\. - -To remove the MariaDB Audit Plugin from a DB instance, do one of the following: -+ Remove the MariaDB Audit Plugin option from the option group it belongs to\. This change affects all DB instances that use the option group\. For more information, see [Removing an option from an option group](USER_WorkingWithOptionGroups.md#USER_WorkingWithOptionGroups.RemoveOption) -+ Modify the DB instance and specify a different option group that doesn't include the plugin\. This change affects a single DB instance\. You can specify the default \(empty\) option group, or a different custom option group\. For more information, see [Modifying an Amazon RDS DB instance](Overview.DBInstance.Modifying.md)\. \ No newline at end of file diff --git a/doc_source/Appendix.MySQL.Options.md b/doc_source/Appendix.MySQL.Options.md deleted file mode 100644 index 144e054..0000000 --- a/doc_source/Appendix.MySQL.Options.md +++ /dev/null @@ -1,13 +0,0 @@ -# Options for MySQL DB instances - -Following, you can find a description of options, or additional features, that are available for Amazon RDS instances running the MySQL DB engine\. To enable these options, you can add them to a custom option group, and then associate the option group with your DB instance\. For more information about working with option groups, see [Working with option groups](USER_WorkingWithOptionGroups.md)\. - -Amazon RDS supports the following options for MySQL: - - -**** - -| Option | Option ID | Engine versions | -| --- | --- | --- | -| [MariaDB Audit Plugin support for MySQL](Appendix.MySQL.Options.AuditPlugin.md) | `MARIADB_AUDIT_PLUGIN` | MySQL 8\.0\.28 and higher 8\.0 versions All MySQL 5\.7 versions | -| [MySQL memcached support](Appendix.MySQL.Options.memcached.md) | `MEMCACHED` | All MySQL 5\.7 and 8\.0 versions | \ No newline at end of file diff --git a/doc_source/Appendix.MySQL.Options.memcached.md b/doc_source/Appendix.MySQL.Options.memcached.md deleted file mode 100644 index a4937df..0000000 --- a/doc_source/Appendix.MySQL.Options.memcached.md +++ /dev/null @@ -1,94 +0,0 @@ -# MySQL memcached support - -Amazon RDS supports using the `memcached` interface to InnoDB tables that was introduced in MySQL 5\.6\. The `memcached` API enables applications to use InnoDB tables in a manner similar to NoSQL key\-value data stores\. - -The `memcached` interface is a simple, key\-based cache\. Applications use `memcached` to insert, manipulate, and retrieve key\-value data pairs from the cache\. MySQL 5\.6 introduced a plugin that implements a daemon service that exposes data from InnoDB tables through the `memcached` protocol\. For more information about the MySQL `memcached` plugin, see [InnoDB integration with memcached](https://dev.mysql.com/doc/refman/8.0/en/innodb-memcached.html)\. - -**To enable memcached support for an RDS for MySQL DB instance** - -1. Determine the security group to use for controlling access to the `memcached` interface\. If the set of applications already using the SQL interface are the same set that will access the `memcached` interface, you can use the existing VPC security group used by the SQL interface\. If a different set of applications will access the `memcached` interface, define a new VPC or DB security group\. For more information about managing security groups, see [Controlling access with security groups](Overview.RDSSecurityGroups.md) - -1. Create a custom DB option group, selecting MySQL as the engine type and version\. For more information about creating an option group, see [Creating an option group](USER_WorkingWithOptionGroups.md#USER_WorkingWithOptionGroups.Create)\. - -1. Add the `MEMCACHED` option to the option group\. Specify the port that the `memcached` interface will use, and the security group to use in controlling access to the interface\. For more information about adding options, see [Adding an option to an option group](USER_WorkingWithOptionGroups.md#USER_WorkingWithOptionGroups.AddOption)\. - -1. Modify the option settings to configure the `memcached` parameters, if necessary\. For more information about how to modify option settings, see [Modifying an option setting](USER_WorkingWithOptionGroups.md#USER_WorkingWithOptionGroups.ModifyOption)\. - -1. Apply the option group to an instance\. Amazon RDS enables `memcached` support for that instance when the option group is applied: - + You enable `memcached` support for a new instance by specifying the custom option group when you launch the instance\. For more information about launching a MySQL instance, see [Creating an Amazon RDS DB instance](USER_CreateDBInstance.md)\. - + You enable `memcached` support for an existing instance by specifying the custom option group when you modify the instance\. For more information about modifying a DB instance, see [Modifying an Amazon RDS DB instance](Overview.DBInstance.Modifying.md)\. - -1. Specify which columns in your MySQL tables can be accessed through the `memcached` interface\. The `memcached` plug\-in creates a catalog table named `containers` in a dedicated database named `innodb_memcache`\. You insert a row into the `containers` table to map an InnoDB table for access through `memcached`\. You specify a column in the InnoDB table that is used to store the `memcached` key values, and one or more columns that are used to store the data values associated with the key\. You also specify a name that a `memcached` application uses to refer to that set of columns\. For details on inserting rows in the `containers` table, see [InnoDB memcached plugin internals](https://dev.mysql.com/doc/refman/8.0/en/innodb-memcached-internals.html)\. For an example of mapping an InnoDB table and accessing it through `memcached`, see [Writing applications for the InnoDB memcached plugin](https://dev.mysql.com/doc/refman/8.0/en/innodb-memcached-developing.html)\. - -1. If the applications accessing the `memcached` interface are on different computers or EC2 instances than the applications using the SQL interface, add the connection information for those computers to the VPC security group associated with the MySQL instance\. For more information about managing security groups, see [Controlling access with security groups](Overview.RDSSecurityGroups.md)\. - -You turn off the `memcached` support for an instance by modifying the instance and specifying the default option group for your MySQL version\. For more information about modifying a DB instance, see [Modifying an Amazon RDS DB instance](Overview.DBInstance.Modifying.md)\. - -## MySQL memcached security considerations - -The `memcached` protocol does not support user authentication\. For more information about MySQL `memcached` security considerations, see [Security Considerations for the InnoDB memcached Plugin](https://dev.mysql.com/doc/refman/8.0/en/innodb-memcached-security.html) in the MySQL documentation\. - -You can take the following actions to help increase the security of the `memcached` interface: -+ Specify a different port than the default of 11211 when adding the `MEMCACHED` option to the option group\. -+ Ensure that you associate the `memcached` interface with a VPC security group that limits access to known, trusted client addresses and EC2 instances\. For more information about managing security groups, see [Controlling access with security groups](Overview.RDSSecurityGroups.md)\. - -## MySQL memcached connection information - -To access the `memcached` interface, an application must specify both the DNS name of the Amazon RDS instance and the `memcached` port number\. For example, if an instance has a DNS name of `my-cache-instance.cg034hpkmmjt.region.rds.amazonaws.com` and the memcached interface is using port 11212, the connection information specified in PHP would be: - - - -``` -1. connect('my-cache-instance.cg034hpkmmjt.region.rds.amazonaws.com',11212); -5. ?> -``` - -**To find the DNS name and memcached port of a MySQL DB instance** - -1. Sign in to the AWS Management Console and open the Amazon RDS console at [https://console\.aws\.amazon\.com/rds/](https://console.aws.amazon.com/rds/)\. - -1. In the top right corner of the AWS Management Console, select the region that contains the DB instance\. - -1. In the navigation pane, choose **Databases**\. - -1. Choose the MySQL DB instance name to display its details\. - -1. In the **Connect** section, note the value of the **Endpoint** field\. The DNS name is the same as the endpoint\. Also, note that the port in the **Connect** section is not used to access the `memcached` interface\. - -1. In the **Details** section, note the name listed in the **Option Group** field\. - -1. In the navigation pane, choose **Option groups**\. - -1. Choose the name of the option group used by the MySQL DB instance to show the option group details\. In the **Options** section, note the value of the **Port** setting for the **MEMCACHED** option\. - -## MySQL memcached option settings - -Amazon RDS exposes the MySQL `memcached` parameters as option settings in the Amazon RDS `MEMCACHED` option\. - -### MySQL memcached parameters -+ `DAEMON_MEMCACHED_R_BATCH_SIZE` – an integer that specifies how many `memcached` read operations \(get\) to perform before doing a COMMIT to start a new transaction\. The allowed values are 1 to 4294967295; the default is 1\. The option does not take effect until the instance is restarted\. -+ `DAEMON_MEMCACHED_W_BATCH_SIZE` – an integer that specifies how many `memcached` write operations, such as add, set, or incr, to perform before doing a COMMIT to start a new transaction\. The allowed values are 1 to 4294967295; the default is 1\. The option does not take effect until the instance is restarted\. -+ `INNODB_API_BK_COMMIT_INTERVAL` – an integer that specifies how often to auto\-commit idle connections that use the InnoDB `memcached` interface\. The allowed values are 1 to 1073741824; the default is 5\. The option takes effect immediately, without requiring that you restart the instance\. -+ `INNODB_API_DISABLE_ROWLOCK` – a Boolean that disables \(1 \(true\)\) or enables \(0 \(false\)\) the use of row locks when using the InnoDB `memcached` interface\. The default is 0 \(false\)\. The option does not take effect until the instance is restarted\. -+ `INNODB_API_ENABLE_MDL` – a Boolean that when set to 0 \(false\) locks the table used by the InnoDB `memcached` plugin, so that it cannot be dropped or altered by DDL through the SQL interface\. The default is 0 \(false\)\. The option does not take effect until the instance is restarted\. -+ `INNODB_API_TRX_LEVEL` – an integer that specifies the transaction isolation level for queries processed by the `memcached` interface\. The allowed values are 0 to 3\. The default is 0\. The option does not take effect until the instance is restarted\. - -Amazon RDS configures these MySQL `memcached` parameters, and they cannot be modified: `DAEMON_MEMCACHED_LIB_NAME`, `DAEMON_MEMCACHED_LIB_PATH`, and `INNODB_API_ENABLE_BINLOG`\. The parameters that MySQL administrators set by using `daemon_memcached_options` are available as individual `MEMCACHED` option settings in Amazon RDS\. - -### MySQL daemon\_memcached\_options parameters -+ `BINDING_PROTOCOL` – a string that specifies the binding protocol to use\. The allowed values are `auto`, `ascii`, or `binary`\. The default is `auto`, which means the server automatically negotiates the protocol with the client\. The option does not take effect until the instance is restarted\. -+ `BACKLOG_QUEUE_LIMIT` – an integer that specifies how many network connections can be waiting to be processed by `memcached`\. Increasing this limit may reduce errors received by a client that is not able to connect to the `memcached` instance, but does not improve the performance of the server\. The allowed values are 1 to 2048; the default is 1024\. The option does not take effect until the instance is restarted\. -+ `CAS_DISABLED` – a Boolean that enables \(1 \(true\)\) or disables \(0 \(false\)\) the use of compare and swap \(CAS\), which reduces the per\-item size by 8 bytes\. The default is 0 \(false\)\. The option does not take effect until the instance is restarted\. -+ `CHUNK_SIZE` – an integer that specifies the minimum chunk size, in bytes, to allocate for the smallest item's key, value, and flags\. The allowed values are 1 to 48\. The default is 48 and you can significantly improve memory efficiency with a lower value\. The option does not take effect until the instance is restarted\. -+ `CHUNK_SIZE_GROWTH_FACTOR` – a float that controls the size of new chunks\. The size of a new chunk is the size of the previous chunk times `CHUNK_SIZE_GROWTH_FACTOR`\. The allowed values are 1 to 2; the default is 1\.25\. The option does not take effect until the instance is restarted\. -+ `ERROR_ON_MEMORY_EXHAUSTED` – a Boolean that when set to 1 \(true\) specifies that `memcached` will return an error rather than evicting items when there is no more memory to store items\. If set to 0 \(false\), `memcached` will evict items if there is no more memory\. The default is 0 \(false\)\. The option does not take effect until the instance is restarted\. -+ `MAX_SIMULTANEOUS_CONNECTIONS` – an integer that specifies the maximum number of concurrent connections\. Setting this value to anything under 10 prevents MySQL from starting\. The allowed values are 10 to 1024; the default is 1024\. The option does not take effect until the instance is restarted\. -+ `VERBOSITY` – a string that specifies the level of information logged in the MySQL error log by the `memcached` service\. The default is v\. The option does not take effect until the instance is restarted\. The allowed values are: - + `v` – Logs errors and warnings while running the main event loop\. - + `vv` – In addition to the information logged by v, also logs each client command and the response\. - + `vvv` – In addition to the information logged by vv, also logs internal state transitions\. - -Amazon RDS configures these MySQL `DAEMON_MEMCACHED_OPTIONS` parameters, they cannot be modified: `DAEMON_PROCESS`, `LARGE_MEMORY_PAGES`, `MAXIMUM_CORE_FILE_LIMIT`, `MAX_ITEM_SIZE`, `LOCK_DOWN_PAGE_MEMORY`, `MASK`, `IDFILE`, `REQUESTS_PER_EVENT`, `SOCKET`, and `USER`\. \ No newline at end of file diff --git a/doc_source/Appendix.MySQL.Parameters.md b/doc_source/Appendix.MySQL.Parameters.md deleted file mode 100644 index 628fc67..0000000 --- a/doc_source/Appendix.MySQL.Parameters.md +++ /dev/null @@ -1,70 +0,0 @@ -# Parameters for MySQL - -By default, a MySQL DB instance uses a DB parameter group that is specific to a MySQL database\. This parameter group contains parameters for the MySQL database engine\. For information about working with parameter groups and setting parameters, see [Working with parameter groups](USER_WorkingWithParamGroups.md)\. - -RDS for MySQL parameters are set to the default values of the storage engine that you have selected\. For more information about MySQL parameters, see the [MySQL documentation](https://dev.mysql.com/doc/refman/8.0/en/server-system-variables.html)\. For more information about MySQL storage engines, see [Supported storage engines for RDS for MySQL](MySQL.Concepts.FeatureSupport.md#MySQL.Concepts.Storage)\. - -You can view the parameters available for a specific RDS for MySQL version using the RDS console or the AWS CLI\. For information about viewing the parameters in a MySQL parameter group in the RDS console, see [Viewing parameter values for a DB parameter group](USER_WorkingWithDBInstanceParamGroups.md#USER_WorkingWithParamGroups.Viewing)\. - -Using the AWS CLI, you can view the parameters for an RDS for MySQL version by running the [https://docs.aws.amazon.com/cli/latest/reference/rds/describe-engine-default-parameters.html](https://docs.aws.amazon.com/cli/latest/reference/rds/describe-engine-default-parameters.html) command\. Specify one of the following values for the `--db-parameter-group-family` option: -+ `mysql8.0` -+ `mysql5.7` - -For example, to view the parameters for RDS for MySQL version 8\.0, run the following command\. - -``` -aws rds describe-engine-default-parameters --db-parameter-group-family mysql8.0 -``` - -Your output looks similar to the following\. - -``` -{ - "EngineDefaults": { - "Parameters": [ - { - "ParameterName": "activate_all_roles_on_login", - "ParameterValue": "0", - "Description": "Automatically set all granted roles as active after the user has authenticated successfully.", - "Source": "engine-default", - "ApplyType": "dynamic", - "DataType": "boolean", - "AllowedValues": "0,1", - "IsModifiable": true - }, - { - "ParameterName": "allow-suspicious-udfs", - "Description": "Controls whether user-defined functions that have only an xxx symbol for the main function can be loaded", - "Source": "engine-default", - "ApplyType": "static", - "DataType": "boolean", - "AllowedValues": "0,1", - "IsModifiable": false - }, - { - "ParameterName": "auto_generate_certs", - "Description": "Controls whether the server autogenerates SSL key and certificate files in the data directory, if they do not already exist.", - "Source": "engine-default", - "ApplyType": "static", - "DataType": "boolean", - "AllowedValues": "0,1", - "IsModifiable": false - }, - ... -``` - -To list only the modifiable parameters for RDS for MySQL version 8\.0, run the following command\. - -For Linux, macOS, or Unix: - -``` -aws rds describe-engine-default-parameters --db-parameter-group-family mysql8.0 \ - --query 'EngineDefaults.Parameters[?IsModifiable==`true`]' -``` - -For Windows: - -``` -aws rds describe-engine-default-parameters --db-parameter-group-family mysql8.0 ^ - --query "EngineDefaults.Parameters[?IsModifiable==`true`]" -``` \ No newline at end of file diff --git a/doc_source/Appendix.MySQL.SQLRef.md b/doc_source/Appendix.MySQL.SQLRef.md deleted file mode 100644 index ad6abba..0000000 --- a/doc_source/Appendix.MySQL.SQLRef.md +++ /dev/null @@ -1,11 +0,0 @@ -# RDS for MySQL stored procedure reference - -These topics describe system stored procedures that are available for Amazon RDS instances running the MySQL DB engine\. The master user must run these procedures\. - -**Topics** -+ [Configuring](mysql-stored-proc-configuring.md) -+ [Ending a session or query](mysql-stored-proc-ending.md) -+ [Logging](mysql-stored-proc-logging.md) -+ [Managing the Global Status History](mysql-stored-proc-gsh.md) -+ [Replicating](mysql-stored-proc-replicating.md) -+ [Warming the InnoDB cache](mysql-stored-proc-warming.md) \ No newline at end of file diff --git a/doc_source/Appendix.Oracle.CommonDBATasks.Database.md b/doc_source/Appendix.Oracle.CommonDBATasks.Database.md deleted file mode 100644 index 19f374d..0000000 --- a/doc_source/Appendix.Oracle.CommonDBATasks.Database.md +++ /dev/null @@ -1,826 +0,0 @@ -# Performing common database tasks for Oracle DB instances - -Following, you can find how to perform certain common DBA tasks related to databases on your Amazon RDS DB instances running Oracle\. To deliver a managed service experience, Amazon RDS doesn't provide shell access to DB instances\. Amazon RDS also restricts access to some system procedures and tables that require advanced privileges\. - -**Topics** -+ [Changing the global name of a database](#Appendix.Oracle.CommonDBATasks.RenamingGlobalName) -+ [Creating and sizing tablespaces](#Appendix.Oracle.CommonDBATasks.CreatingTablespacesAndDatafiles) -+ [Setting the default tablespace](#Appendix.Oracle.CommonDBATasks.SettingDefaultTablespace) -+ [Setting the default temporary tablespace](#Appendix.Oracle.CommonDBATasks.SettingDefTempTablespace) -+ [Creating a temporary tablespace on the instance store](#Appendix.Oracle.CommonDBATasks.creating-tts-instance-store) -+ [Adding a tempfile to the instance store on a read replica](#Appendix.Oracle.CommonDBATasks.adding-tempfile-replica) -+ [Dropping tempfiles on a read replica](#Appendix.Oracle.CommonDBATasks.dropping-tempfiles-replica) -+ [Checkpointing a database](#Appendix.Oracle.CommonDBATasks.CheckpointingDatabase) -+ [Setting distributed recovery](#Appendix.Oracle.CommonDBATasks.SettingDistributedRecovery) -+ [Setting the database time zone](#Appendix.Oracle.CommonDBATasks.TimeZoneSupport) -+ [Working with Oracle external tables](#Appendix.Oracle.CommonDBATasks.External_Tables) -+ [Generating performance reports with Automatic Workload Repository \(AWR\)](#Appendix.Oracle.CommonDBATasks.AWR) -+ [Adjusting database links for use with DB instances in a VPC](#Appendix.Oracle.CommonDBATasks.DBLinks) -+ [Setting the default edition for a DB instance](#Appendix.Oracle.CommonDBATasks.DefaultEdition) -+ [Enabling auditing for the SYS\.AUD$ table](#Appendix.Oracle.CommonDBATasks.EnablingAuditing) -+ [Disabling auditing for the SYS\.AUD$ table](#Appendix.Oracle.CommonDBATasks.DisablingAuditing) -+ [Cleaning up interrupted online index builds](#Appendix.Oracle.CommonDBATasks.CleanupIndex) -+ [Skipping corrupt blocks](#Appendix.Oracle.CommonDBATasks.SkippingCorruptBlocks) -+ [Resizing tablespaces, data files, and temp files](#Appendix.Oracle.CommonDBATasks.ResizeTempSpaceReadReplica) -+ [Purging the recycle bin](#Appendix.Oracle.CommonDBATasks.PurgeRecycleBin) -+ [Setting the Data Redaction policy for full redaction](#Appendix.Oracle.CommonDBATasks.FullRedaction) - -## Changing the global name of a database - -To change the global name of a database, use the Amazon RDS procedure `rdsadmin.rdsadmin_util.rename_global_name`\. The `rename_global_name` procedure has the following parameters\. - - -**** - -| Parameter name | Data type | Default | Required | Description | -| --- | --- | --- | --- | --- | -| `p_new_global_name` | varchar2 | — | Yes | The new global name for the database\. | - -The database must be open for the name change to occur\. For more information about changing the global name of a database, see [ALTER DATABASE](http://docs.oracle.com/cd/E11882_01/server.112/e41084/statements_1004.htm#SQLRF52547) in the Oracle documentation\. - -The following example changes the global name of a database to `new_global_name`\. - -``` -EXEC rdsadmin.rdsadmin_util.rename_global_name(p_new_global_name => 'new_global_name'); -``` - -## Creating and sizing tablespaces - -Amazon RDS only supports Oracle Managed Files \(OMF\) for data files, log files, and control files\. When you create data files and log files, you can't specify the physical file names\. - -By default, if you don't specify a data file size, tablespaces are created with the default of `AUTOEXTEND ON`, and no maximum size\. In the following example, the tablespace *users1* is autoextensible\. - -``` -CREATE TABLESPACE users1; -``` - -Because of these default settings, tablespaces can grow to consume all allocated storage\. We recommend that you specify an appropriate maximum size on permanent and temporary tablespaces, and that you carefully monitor space usage\. - -The following example creates a tablespace named *users2* with a starting size of 1 gigabyte\. Because a data file size is specified, but `AUTOEXTEND ON` isn't specified, the tablespace isn't autoextensible\. - -``` -CREATE TABLESPACE users2 DATAFILE SIZE 1G; -``` - -The following example creates a tablespace named *users3* with a starting size of 1 gigabyte, autoextend turned on, and a maximum size of 10 gigabytes\. - -``` -CREATE TABLESPACE users3 DATAFILE SIZE 1G AUTOEXTEND ON MAXSIZE 10G; -``` - -The following example creates a temporary tablespace named *temp01*\. - -``` -CREATE TEMPORARY TABLESPACE temp01; -``` - -We recommend that you don't use smallfile tablespaces because you can't resize smallfile tablespaces with RDS for Oracle\. However, you can add a data file to a smallfile tablespace\. To determine whether a tablespace is bigfile or smallfile, query `DBA_TABLESPACES` as follows\. - -``` -SELECT TABLESPACE NAME, BIGFILE FROM DBA_TABLESPACE; -``` - -You can resize a bigfile tablespace by using `ALTER TABLESPACE`\. You can specify the size in kilobytes \(K\), megabytes \(M\), gigabytes \(G\), or terabytes \(T\)\. The following example resizes a bigfile tablespace named *users\_bf* to 200 MB\. - -``` -ALTER TABLESPACE users_bf RESIZE 200M; -``` - -The following example adds an additional data file to a smallfile tablespace named *users\_sf*\. - -``` -ALTER TABLESPACE users_sf ADD DATAFILE SIZE 100000M AUTOEXTEND ON NEXT 250m MAXSIZE UNLIMITED; -``` - -## Setting the default tablespace - -To set the default tablespace, use the Amazon RDS procedure `rdsadmin.rdsadmin_util.alter_default_tablespace`\. The `alter_default_tablespace` procedure has the following parameters\. - - -**** - -| Parameter name | Data type | Default | Required | Description | -| --- | --- | --- | --- | --- | -| `tablespace_name` | varchar | — | Yes | The name of the default tablespace\. | - -The following example sets the default tablespace to *users2*: - -``` -EXEC rdsadmin.rdsadmin_util.alter_default_tablespace(tablespace_name => 'users2'); -``` - -## Setting the default temporary tablespace - -To set the default temporary tablespace, use the Amazon RDS procedure `rdsadmin.rdsadmin_util.alter_default_temp_tablespace`\. The `alter_default_temp_tablespace` procedure has the following parameters\. - - -**** - -| Parameter name | Data type | Default | Required | Description | -| --- | --- | --- | --- | --- | -| `tablespace_name` | varchar | — | Yes | The name of the default temporary tablespace\. | - -The following example sets the default temporary tablespace to *temp01*\. - -``` -EXEC rdsadmin.rdsadmin_util.alter_default_temp_tablespace(tablespace_name => 'temp01'); -``` - -## Creating a temporary tablespace on the instance store - -To create a temporary tablespace on the instance store, use the Amazon RDS procedure `rdsadmin.rdsadmin_util.create_inst_store_tmp_tblspace`\. The `create_inst_store_tmp_tblspace` procedure has the following parameters\. - - -**** - -| Parameter name | Data type | Default | Required | Description | -| --- | --- | --- | --- | --- | -| `p_tablespace_name` | varchar | — | Yes | The name of the temporary tablespace\. | - -The following example creates the temporary tablespace *temp01* in the instance store\. - -``` -EXEC rdsadmin.rdsadmin_util.create_inst_store_tmp_tblspace(p_tablespace_name => 'temp01'); -``` - -**Important** -When you run `rdsadmin_util.create_inst_store_tmp_tblspace`, the newly created temporary tablespace is not automatically set as the default temporary tablespace\. To set it as the default, see [Setting the default temporary tablespace](#Appendix.Oracle.CommonDBATasks.SettingDefTempTablespace)\. - -For more information, see [Storing temporary data in an RDS for Oracle instance store](CHAP_Oracle.advanced-features.instance-store.md)\. - -## Adding a tempfile to the instance store on a read replica - -When you create a temporary tablespace on a primary DB instance, the read replica doesn't create tempfiles\. Assume that an empty temporary tablespace exists on your read replica for either of the following reasons: -+ You dropped a tempfile from the tablespace on your read replica\. For more information, see [Dropping tempfiles on a read replica](#Appendix.Oracle.CommonDBATasks.dropping-tempfiles-replica)\. -+ You created a new temporary tablespace on the primary DB instance\. In this case, RDS for Oracle synchronizes the metadata to the read replica\. - -You can add a tempfile to the empty temporary tablespace, and store the tempfile in the instance store\. To create a tempfile in the instance store, use the Amazon RDS procedure `rdsadmin.rdsadmin_util.add_inst_store_tempfile`\. You can use this procedure only on a read replica\. The procedure has the following parameters\. - - -**** - -| Parameter name | Data type | Default | Required | Description | -| --- | --- | --- | --- | --- | -| `p_tablespace_name` | varchar | — | Yes | The name of the temporary tablespace on your read replica\. | - -In the following example, the empty temporary tablespace *temp01* exists on your read replica\. Run the following command to create a tempfile for this tablespace, and store it in the instance store\. - -``` -EXEC rdsadmin.rdsadmin_util.add_inst_store_tempfile(p_tablespace_name => 'temp01'); -``` - -For more information, see [Storing temporary data in an RDS for Oracle instance store](CHAP_Oracle.advanced-features.instance-store.md)\. - -## Dropping tempfiles on a read replica - -You can't drop an existing temporary tablespace on a read replica\. You can change the tempfile storage on a read replica from Amazon EBS to the instance store, or from the instance store to Amazon EBS\. To achieve these goals, do the following: - -1. Drop the current tempfiles in the temporary tablespace on the read replica\. - -1. Create new tempfiles on different storage\. - -To drop the tempfiles, use the Amazon RDS procedure `rdsadmin.rdsadmin_util. drop_replica_tempfiles`\. You can use this procedure only on read replicas\. The `drop_replica_tempfiles` procedure has the following parameters\. - - -**** - -| Parameter name | Data type | Default | Required | Description | -| --- | --- | --- | --- | --- | -| `p_tablespace_name` | varchar | — | Yes | The name of the temporary tablespace on your read replica\. | - -Assume that a temporary tablespace named *temp01* resides in the instance store on your read replica\. Drop all tempfiles in this tablespace by running the following command\. - -``` -EXEC rdsadmin.rdsadmin_util.drop_replica_tempfiles(p_tablespace_name => 'temp01'); -``` - -For more information, see [Storing temporary data in an RDS for Oracle instance store](CHAP_Oracle.advanced-features.instance-store.md)\. - -## Checkpointing a database - -To checkpoint the database, use the Amazon RDS procedure `rdsadmin.rdsadmin_util.checkpoint`\. The `checkpoint` procedure has no parameters\. - -The following example checkpoints the database\. - -``` -EXEC rdsadmin.rdsadmin_util.checkpoint; -``` - -## Setting distributed recovery - -To set distributed recovery, use the Amazon RDS procedures `rdsadmin.rdsadmin_util.enable_distr_recovery` and `disable_distr_recovery`\. The procedures have no parameters\. - -The following example enables distributed recovery\. - -``` -EXEC rdsadmin.rdsadmin_util.enable_distr_recovery; -``` - -The following example disables distributed recovery\. - -``` -EXEC rdsadmin.rdsadmin_util.disable_distr_recovery; -``` - -## Setting the database time zone - -You can set the time zone of your Amazon RDS Oracle database in the following ways: -+ The `Timezone` option - - The `Timezone` option changes the time zone at the host level and affects all date columns and values such as `SYSDATE`\. For more information, see [Oracle time zone](Appendix.Oracle.Options.Timezone.md)\. -+ The Amazon RDS procedure `rdsadmin.rdsadmin_util.alter_db_time_zone` - - The `alter_db_time_zone` procedure changes the time zone for only certain data types, and doesn't change `SYSDATE`\. There are additional restrictions on setting the time zone listed in the [Oracle documentation](http://docs.oracle.com/cd/B19306_01/server.102/b14225/ch4datetime.htm#i1006705)\. - -**Note** -You can also set the default time zone for Oracle Scheduler\. For more information, see [Setting the time zone for Oracle Scheduler jobs](Appendix.Oracle.CommonDBATasks.Scheduler.md#Appendix.Oracle.CommonDBATasks.Scheduler.TimeZone)\. - -The `alter_db_time_zone` procedure has the following parameters\. - - -**** - -| Parameter name | Data type | Default | Required | Description | -| --- | --- | --- | --- | --- | -| `p_new_tz` | varchar2 | — | Yes | The new time zone as a named region or an absolute offset from Coordinated Universal Time \(UTC\)\. Valid offsets range from \-12:00 to \+14:00\. | - -The following example changes the time zone to UTC plus three hours\. - -``` -EXEC rdsadmin.rdsadmin_util.alter_db_time_zone(p_new_tz => '+3:00'); -``` - -The following example changes the time zone to the Africa/Algiers time zone\. - -``` -EXEC rdsadmin.rdsadmin_util.alter_db_time_zone(p_new_tz => 'Africa/Algiers'); -``` - -After you alter the time zone by using the `alter_db_time_zone` procedure, reboot your DB instance for the change to take effect\. For more information, see [Rebooting a DB instance](USER_RebootInstance.md)\. For information about upgrading time zones, see [Time zone considerations](USER_UpgradeDBInstance.Oracle.OGPG.md#USER_UpgradeDBInstance.Oracle.OGPG.DST)\. - -## Working with Oracle external tables - -*Oracle external tables *are tables with data that is not in the database\. Instead, the data is in external files that the database can access\. By using external tables, you can access data without loading it into the database\. For more information about external tables, see [Managing external tables](http://docs.oracle.com/database/121/ADMIN/tables.htm#ADMIN01507) in the Oracle documentation\. - -With Amazon RDS, you can store external table files in directory objects\. You can create a directory object, or you can use one that is predefined in the Oracle database, such as the DATA\_PUMP\_DIR directory\. For information about creating directory objects, see [Creating and dropping directories in the main data storage space](Appendix.Oracle.CommonDBATasks.Misc.md#Appendix.Oracle.CommonDBATasks.NewDirectories)\. You can query the ALL\_DIRECTORIES view to list the directory objects for your Amazon RDS Oracle DB instance\. - -**Note** -Directory objects point to the main data storage space \(Amazon EBS volume\) used by your instance\. The space used—along with data files, redo logs, audit, trace, and other files—counts against allocated storage\. - -You can move an external data file from one Oracle database to another by using the [ DBMS\_FILE\_TRANSFER](https://docs.oracle.com/database/121/ARPLS/d_ftran.htm#ARPLS095) package or the [UTL\_FILE](https://docs.oracle.com/database/121/ARPLS/u_file.htm#ARPLS069) package\. The external data file is moved from a directory on the source database to the specified directory on the destination database\. For information about using DBMS\_FILE\_TRANSFER, see [Importing using Oracle Data Pump](Oracle.Procedural.Importing.DataPump.md)\. - -After you move the external data file, you can create an external table with it\. The following example creates an external table that uses the `emp_xt_file1.txt` file in the USER\_DIR1 directory\. - -``` -CREATE TABLE emp_xt ( - emp_id NUMBER, - first_name VARCHAR2(50), - last_name VARCHAR2(50), - user_name VARCHAR2(20) -) -ORGANIZATION EXTERNAL ( - TYPE ORACLE_LOADER - DEFAULT DIRECTORY USER_DIR1 - ACCESS PARAMETERS ( - RECORDS DELIMITED BY NEWLINE - FIELDS TERMINATED BY ',' - MISSING FIELD VALUES ARE NULL - (emp_id,first_name,last_name,user_name) - ) - LOCATION ('emp_xt_file1.txt') -) -PARALLEL -REJECT LIMIT UNLIMITED; -``` - -Suppose that you want to move data that is in an Amazon RDS Oracle DB instance into an external data file\. In this case, you can populate the external data file by creating an external table and selecting the data from the table in the database\. For example, the following SQL statement creates the `orders_xt` external table by querying the `orders` table in the database\. - -``` -CREATE TABLE orders_xt - ORGANIZATION EXTERNAL - ( - TYPE ORACLE_DATAPUMP - DEFAULT DIRECTORY DATA_PUMP_DIR - LOCATION ('orders_xt.dmp') - ) - AS SELECT * FROM orders; -``` - -In this example, the data is populated in the `orders_xt.dmp` file in the DATA\_PUMP\_DIR directory\. - -## Generating performance reports with Automatic Workload Repository \(AWR\) - -To gather performance data and generate reports, Oracle recommends Automatic Workload Repository \(AWR\)\. AWR requires Oracle Database Enterprise Edition and a license for the Diagnostics and Tuning packs\. To enable AWR, set the `CONTROL_MANAGEMENT_PACK_ACCESS` initialization parameter to either `DIAGNOSTIC` or `DIAGNOSTIC+TUNING`\. - -### Working with AWR reports in RDS - -To generate AWR reports, you can run scripts such as `awrrpt.sql`\. These scripts are installed on the database host server\. In Amazon RDS, you don't have direct access to the host\. However, you can get copies of SQL scripts from another installation of Oracle Database\. - -You can also use AWR by running procedures in the `SYS.DBMS_WORKLOAD_REPOSITORY` PL/SQL package\. You can use this package to manage baselines and snapshots, and also to display ASH and AWR reports\. For example, to generate an AWR report in text format run the `DBMS_WORKLOAD_REPOSITORY.AWR_REPORT_TEXT` procedure\. However, you can't reach these AWR reports from the AWS Management Console\. - -When working with AWR, we recommend using the `rdsadmin.rdsadmin_diagnostic_util` procedures\. You can use these procedures to generate the following: -+ AWR reports -+ Active Session History \(ASH\) reports -+ Automatic Database Diagnostic Monitor \(ADDM\) reports -+ Oracle Data Pump Export dump files of AWR data - -The `rdsadmin_diagnostic_util` procedures save the reports to the DB instance file system\. You can access these reports from the console\. You can also access reports using the `rdsadmin.rds_file_util` procedures, and you can access reports that are copied to Amazon S3 using the S3 Integration option\. For more information, see [Reading files in a DB instance directory](Appendix.Oracle.CommonDBATasks.Misc.md#Appendix.Oracle.CommonDBATasks.ReadingFiles) and [Amazon S3 integration](oracle-s3-integration.md)\. - -You can use the `rdsadmin_diagnostic_util` procedures in the following Amazon RDS for Oracle DB engine versions: -+ All Oracle Database 21c versions -+ 19\.0\.0\.0\.ru\-2020\-04\.rur\-2020\-04\.r1 and higher Oracle Database 19c versions -+ 12\.2\.0\.1\.ru\-2020\-04\.rur\-2020\-04\.r1 and higher Oracle Database 12c Release 2 \(12\.2\) versions -+ 12\.1\.0\.2\.v20 and higher Oracle Database 12c Release 1 \(12\.1\) versions - -### Common parameters for the diagnostic utility package - -You typically use the following parameters when managing AWR and ADDM with the `rdsadmin_diagnostic_util` package\. - -[\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Appendix.Oracle.CommonDBATasks.Database.html) - -You typically use the following parameters when managing ASH with the rdsadmin\_diagnostic\_util package\. - -[\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Appendix.Oracle.CommonDBATasks.Database.html) - -### Generating an AWR report - -To generate an AWR report, use the `rdsadmin.rdsadmin_diagnostic_util.awr_report` procedure\. - -The following example generates a AWR report for the snapshot range 101–106\. The output text file is named `awrrpt_101_106.txt`\. You can access this report from the AWS Management Console\. - -``` -EXEC rdsadmin.rdsadmin_diagnostic_util.awr_report(101,106,'TEXT'); -``` - -The following example generates an HTML report for the snapshot range 63–65\. The output HTML file is named `awrrpt_63_65.html`\. The procedure writes the report to the nondefault database directory named `AWR_RPT_DUMP`\. - -``` -EXEC rdsadmin.rdsadmin_diagnostic_util.awr_report(63,65,'HTML','AWR_RPT_DUMP'); -``` - -### Extracting AWR data into a dump file - -To extract AWR data into a dump file, use the `rdsadmin.rdsadmin_diagnostic_util.awr_extract` procedure\. - -The following example extracts the snapshot range 101–106\. The output dump file is named `awrextract_101_106.dmp`\. You can access this file through the console\. - -``` -EXEC rdsadmin.rdsadmin_diagnostic_util.awr_extract(101,106); -``` - -The following example extracts the snapshot range 63–65\. The output dump file is named `awrextract_63_65.dmp`\. The file is stored in the nondefault database directory named `AWR_RPT_DUMP`\. - -``` -EXEC rdsadmin.rdsadmin_diagnostic_util.awr_extract(63,65,'AWR_RPT_DUMP'); -``` - -### Generating an ADDM report - -To generate an ADDM report, use the `rdsadmin.rdsadmin_diagnostic_util.addm_report` procedure\. - -The following example generates an ADDM report for the snapshot range 101–106\. The output text file is named `addmrpt_101_106.txt`\. You can access the report through the console\. - -``` -EXEC rdsadmin.rdsadmin_diagnostic_util.addm_report(101,106); -``` - -The following example generates an ADDM report for the snapshot range 63–65\. The output text file is named `addmrpt_63_65.txt`\. The file is stored in the nondefault database directory named `ADDM_RPT_DUMP`\. - -``` -EXEC rdsadmin.rdsadmin_diagnostic_util.addm_report(63,65,'ADDM_RPT_DUMP'); -``` - -### Generating an ASH report - -To generate an ASH report, use the `rdsadmin.rdsadmin_diagnostic_util.ash_report` procedure\. - -The following example generates an ASH report that includes the data from 14 minutes ago until the current time\. The name of the output file uses the format `ashrptbegin_timeend_time.txt`, where `begin_time` and `end_time` use the format `YYYYMMDDHH24MISS`\. You can access the file through the console\. - -``` -BEGIN - rdsadmin.rdsadmin_diagnostic_util.ash_report( - begin_time => SYSDATE-14/1440, - end_time => SYSDATE, - report_type => 'TEXT'); -END; -/ -``` - -The following example generates an ASH report that includes the data from November 18, 2019, at 6:07 PM through November 18, 2019, at 6:15 PM\. The name of the output HTML report is `ashrpt_20190918180700_20190918181500.html`\. The report is stored in the nondefault database directory named `AWR_RPT_DUMP`\. - -``` -BEGIN - rdsadmin.rdsadmin_diagnostic_util.ash_report( - begin_time => TO_DATE('2019-09-18 18:07:00', 'YYYY-MM-DD HH24:MI:SS'), - end_time => TO_DATE('2019-09-18 18:15:00', 'YYYY-MM-DD HH24:MI:SS'), - report_type => 'html', - dump_directory => 'AWR_RPT_DUMP'); -END; -/ -``` - -### Accessing AWR reports from the console or CLI - -To access AWR reports or export dump files, you can use the AWS Management Console or AWS CLI\. For more information, see [Downloading a database log file](USER_LogAccess.Procedural.Downloading.md)\. - -## Adjusting database links for use with DB instances in a VPC - -To use Oracle database links with Amazon RDS DB instances inside the same virtual private cloud \(VPC\) or peered VPCs, the two DB instances should have a valid route between them\. Verify the valid route between the DB instances by using your VPC routing tables and network access control list \(ACL\)\. - -The security group of each DB instance must allow ingress to and egress from the other DB instance\. The inbound and outbound rules can refer to security groups from the same VPC or a peered VPC\. For more information, see [Updating your security groups to reference peered VPC security groups](https://docs.aws.amazon.com/vpc/latest/peering/working-with-vpc-peering.html#vpc-peering-security-groups)\. - -If you have configured a custom DNS server using the DHCP Option Sets in your VPC, your custom DNS server must be able to resolve the name of the database link target\. For more information, see [Setting up a custom DNS server](Appendix.Oracle.CommonDBATasks.System.md#Appendix.Oracle.CommonDBATasks.CustomDNS)\. - -For more information about using database links with Oracle Data Pump, see [Importing using Oracle Data Pump](Oracle.Procedural.Importing.DataPump.md)\. - -## Setting the default edition for a DB instance - -You can redefine database objects in a private environment called an edition\. You can use edition\-based redefinition to upgrade an application's database objects with minimal downtime\. - -You can set the default edition of an Amazon RDS Oracle DB instance using the Amazon RDS procedure `rdsadmin.rdsadmin_util.alter_default_edition`\. - -The following example sets the default edition for the Amazon RDS Oracle DB instance to `RELEASE_V1`\. - -``` -EXEC rdsadmin.rdsadmin_util.alter_default_edition('RELEASE_V1'); -``` - -The following example sets the default edition for the Amazon RDS Oracle DB instance back to the Oracle default\. - -``` -EXEC rdsadmin.rdsadmin_util.alter_default_edition('ORA$BASE'); -``` - -For more information about Oracle edition\-based redefinition, see [About editions and edition\-based redefinition](https://docs.oracle.com/database/121/ADMIN/general.htm#ADMIN13167) in the Oracle documentation\. - -## Enabling auditing for the SYS\.AUD$ table - -To enable auditing on the database audit trail table `SYS.AUD$`, use the Amazon RDS procedure `rdsadmin.rdsadmin_master_util.audit_all_sys_aud_table`\. The only supported audit property is `ALL`\. You can't audit or not audit individual statements or operations\. - -Enabling auditing is supported for Oracle DB instances running the following versions: -+ Oracle Database 21c \(21\.0\.0\) -+ Oracle Database 19c \(19\.0\.0\) -+ Oracle Database 12c Release 2 \(12\.2\) -+ Oracle Database 12c Release 1 \(12\.1\.0\.2\.v14\) and later - -The `audit_all_sys_aud_table` procedure has the following parameters\. - - -**** - -| Parameter name | Data type | Default | Required | Description | -| --- | --- | --- | --- | --- | -| `p_by_access` | boolean | true | No | Set to `true` to audit `BY ACCESS`\. Set to `false` to audit `BY SESSION`\. | - -**Note** -In a single\-tenant CDB, the following operations work, but no customer\-visible mechanism can detect the current status of the operations\. Auditing information isn't available from within the PDB\. For more information, see [Limitations of a single\-tenant CDB](Oracle.Concepts.limitations.md#Oracle.Concepts.single-tenant-limitations)\. - -The following query returns the current audit configuration for `SYS.AUD$` for a database\. - -``` -SELECT * FROM DBA_OBJ_AUDIT_OPTS WHERE OWNER='SYS' AND OBJECT_NAME='AUD$'; -``` - -The following commands enable audit of `ALL` on `SYS.AUD$` `BY ACCESS`\. - -``` -EXEC rdsadmin.rdsadmin_master_util.audit_all_sys_aud_table; - -EXEC rdsadmin.rdsadmin_master_util.audit_all_sys_aud_table(p_by_access => true); -``` - -The following command enables audit of `ALL` on `SYS.AUD$` `BY SESSION`\. - -``` -EXEC rdsadmin.rdsadmin_master_util.audit_all_sys_aud_table(p_by_access => false); -``` - -For more information, see [AUDIT \(traditional auditing\)](https://docs.oracle.com/en/database/oracle/oracle-database/12.2/sqlrf/AUDIT-Traditional-Auditing.html#GUID-ADF45B07-547A-4096-8144-50241FA2D8DD) in the Oracle documentation\. - -## Disabling auditing for the SYS\.AUD$ table - -To disable auditing on the database audit trail table `SYS.AUD$`, use the Amazon RDS procedure `rdsadmin.rdsadmin_master_util.noaudit_all_sys_aud_table`\. This procedure takes no parameters\. - -The following query returns the current audit configuration for `SYS.AUD$` for a database: - -``` -SELECT * FROM DBA_OBJ_AUDIT_OPTS WHERE OWNER='SYS' AND OBJECT_NAME='AUD$'; -``` - -The following command disables audit of `ALL` on `SYS.AUD$`\. - -``` -EXEC rdsadmin.rdsadmin_master_util.noaudit_all_sys_aud_table; -``` - -For more information, see [NOAUDIT \(traditional auditing\)](https://docs.oracle.com/en/database/oracle/oracle-database/12.2/sqlrf/NOAUDIT-Traditional-Auditing.html#GUID-9D8EAF18-4AB3-4C04-8BF7-37BD0E15434D) in the Oracle documentation\. - -## Cleaning up interrupted online index builds - -To clean up failed online index builds, use the Amazon RDS procedure `rdsadmin.rdsadmin_dbms_repair.online_index_clean`\. - -The `online_index_clean` procedure has the following parameters\. - - -**** - -| Parameter name | Data type | Default | Required | Description | -| --- | --- | --- | --- | --- | -| `object_id` | binary\_integer | `ALL_INDEX_ID` | No | The object ID of the index\. Typically, you can use the object ID from the ORA\-08104 error text\. | -| `wait_for_lock` | binary\_integer | `rdsadmin.rdsadmin_dbms_repair.lock_wait` | No | Specify `rdsadmin.rdsadmin_dbms_repair.lock_wait`, the default, to try to get a lock on the underlying object and retry until an internal limit is reached if the lock fails\. Specify `rdsadmin.rdsadmin_dbms_repair.lock_nowait` to try to get a lock on the underlying object but not retry if the lock fails\. | - -The following example cleans up a failed online index build: - -``` -declare - is_clean boolean; -begin - is_clean := rdsadmin.rdsadmin_dbms_repair.online_index_clean( - object_id => 1234567890, - wait_for_lock => rdsadmin.rdsadmin_dbms_repair.lock_nowait - ); -end; -/ -``` - -For more information, see [ONLINE\_INDEX\_CLEAN function](https://docs.oracle.com/database/121/ARPLS/d_repair.htm#ARPLS67555) in the Oracle documentation\. - -## Skipping corrupt blocks - -To skip corrupt blocks during index and table scans, use the `rdsadmin.rdsadmin_dbms_repair` package\. - -The following procedures wrap the functionality of the `sys.dbms_repair.admin_table` procedure and take no parameters: -+ `rdsadmin.rdsadmin_dbms_repair.create_repair_table` -+ `rdsadmin.rdsadmin_dbms_repair.create_orphan_keys_table` -+ `rdsadmin.rdsadmin_dbms_repair.drop_repair_table` -+ `rdsadmin.rdsadmin_dbms_repair.drop_orphan_keys_table` -+ `rdsadmin.rdsadmin_dbms_repair.purge_repair_table` -+ `rdsadmin.rdsadmin_dbms_repair.purge_orphan_keys_table` - -The following procedures take the same parameters as their counterparts in the `DBMS_REPAIR` package for Oracle databases: -+ `rdsadmin.rdsadmin_dbms_repair.check_object` -+ `rdsadmin.rdsadmin_dbms_repair.dump_orphan_keys` -+ `rdsadmin.rdsadmin_dbms_repair.fix_corrupt_blocks` -+ `rdsadmin.rdsadmin_dbms_repair.rebuild_freelists` -+ `rdsadmin.rdsadmin_dbms_repair.segment_fix_status` -+ `rdsadmin.rdsadmin_dbms_repair.skip_corrupt_blocks` - -For more information about handling database corruption, see [DBMS\_REPAIR](https://docs.oracle.com/en/database/oracle/oracle-database/19/arpls/DBMS_REPAIR.html#GUID-B8EC4AB3-4D6A-46C9-857F-4ED53CD9C948) in the Oracle documentation\. - -**Example Responding to corrupt blocks** -This example shows the basic workflow for responding to corrupt blocks\. Your steps will depend on the location and nature of your block corruption\. -Before attempting to repair corrupt blocks, review the [DBMS\_REPAIR](https://docs.oracle.com/en/database/oracle/oracle-database/19/arpls/DBMS_REPAIR.html#GUID-B8EC4AB3-4D6A-46C9-857F-4ED53CD9C948) documentation carefully\. - -**To skip corrupt blocks during index and table scans** - -1. Run the following procedures to create repair tables if they don't already exist\. - - ``` - EXEC rdsadmin.rdsadmin_dbms_repair.create_repair_table; - EXEC rdsadmin.rdsadmin_dbms_repair.create_orphan_keys_table; - ``` - -1. Run the following procedures to check for existing records and purge them if appropriate\. - - ``` - SELECT COUNT(*) FROM SYS.REPAIR_TABLE; - SELECT COUNT(*) FROM SYS.ORPHAN_KEY_TABLE; - SELECT COUNT(*) FROM SYS.DBA_REPAIR_TABLE; - SELECT COUNT(*) FROM SYS.DBA_ORPHAN_KEY_TABLE; - - EXEC rdsadmin.rdsadmin_dbms_repair.purge_repair_table; - EXEC rdsadmin.rdsadmin_dbms_repair.purge_orphan_keys_table; - ``` - -1. Run the following procedure to check for corrupt blocks\. - - ``` - SET SERVEROUTPUT ON - DECLARE v_num_corrupt INT; - BEGIN - v_num_corrupt := 0; - rdsadmin.rdsadmin_dbms_repair.check_object ( - schema_name => '&corruptionOwner', - object_name => '&corruptionTable', - corrupt_count => v_num_corrupt - ); - dbms_output.put_line('number corrupt: '||to_char(v_num_corrupt)); - END; - / - - COL CORRUPT_DESCRIPTION FORMAT a30 - COL REPAIR_DESCRIPTION FORMAT a30 - - SELECT OBJECT_NAME, BLOCK_ID, CORRUPT_TYPE, MARKED_CORRUPT, - CORRUPT_DESCRIPTION, REPAIR_DESCRIPTION - FROM SYS.REPAIR_TABLE; - - SELECT SKIP_CORRUPT - FROM DBA_TABLES - WHERE OWNER = '&corruptionOwner' - AND TABLE_NAME = '&corruptionTable'; - ``` - -1. Use the `skip_corrupt_blocks` procedure to enable or disable corruption skipping for affected tables\. Depending on the situation, you may also need to extract data to a new table, and then drop the table containing the corrupt block\. - - Run the following procedure to enable corruption skipping for affected tables\. - - ``` - begin - rdsadmin.rdsadmin_dbms_repair.skip_corrupt_blocks ( - schema_name => '&corruptionOwner', - object_name => '&corruptionTable', - object_type => rdsadmin.rdsadmin_dbms_repair.table_object, - flags => rdsadmin.rdsadmin_dbms_repair.skip_flag); - end; - / - select skip_corrupt from dba_tables where owner = '&corruptionOwner' and table_name = '&corruptionTable'; - ``` - - Run the following procedure to disable corruption skipping\. - - ``` - begin - rdsadmin.rdsadmin_dbms_repair.skip_corrupt_blocks ( - schema_name => '&corruptionOwner', - object_name => '&corruptionTable', - object_type => rdsadmin.rdsadmin_dbms_repair.table_object, - flags => rdsadmin.rdsadmin_dbms_repair.noskip_flag); - end; - / - - select skip_corrupt from dba_tables where owner = '&corruptionOwner' and table_name = '&corruptionTable'; - ``` - -1. When you have completed all repair work, run the following procedures to drop the repair tables\. - - ``` - EXEC rdsadmin.rdsadmin_dbms_repair.drop_repair_table; - EXEC rdsadmin.rdsadmin_dbms_repair.drop_orphan_keys_table; - ``` - -## Resizing tablespaces, data files, and temp files - -By default, Oracle tablespaces are created with auto\-extend turned on and no maximum size\. Because of these default settings, tablespaces can sometimes grow too large\. We recommend that you specify an appropriate maximum size on permanent and temporary tablespaces, and that you carefully monitor space usage\. - -### Resizing permanent tablespaces - -To resize a permanent tablespace in an RDS for Oracle DB instance, use any of the following Amazon RDS procedures: -+ `rdsadmin.rdsadmin_util.resize_datafile` -+ `rdsadmin.rdsadmin_util.autoextend_datafile` - -The `resize_datafile` procedure has the following parameters\. - - -**** - -| Parameter name | Data type | Default | Required | Description | -| --- | --- | --- | --- | --- | -| `p_data_file_id` | number | — | Yes | The identifier of the data file to resize\. | -| `p_size` | varchar2 | — | Yes | The size of the data file\. Specify the size in bytes \(the default\), kilobytes \(K\), megabytes \(M\), or gigabytes \(G\)\. | - -The `autoextend_datafile` procedure has the following parameters\. - - -**** - -| Parameter name | Data type | Default | Required | Description | -| --- | --- | --- | --- | --- | -| `p_data_file_id` | number | — | Yes | The identifier of the data file to resize\. | -| `p_autoextend_state` | varchar2 | — | Yes | The state of the autoextension feature\. Specify `ON` to extend the data file automatically and `OFF` to turn off autoextension\. | -| `p_next` | varchar2 | — | No | The size of the next data file increment\. Specify the size in bytes \(the default\), kilobytes \(K\), megabytes \(M\), or gigabytes \(G\)\. | -| `p_maxsize` | varchar2 | — | No | The maximum disk space allowed for automatic extension\. Specify the size in bytes \(the default\), kilobytes \(K\), megabytes \(M\), or gigabytes \(G\)\. You can specify `UNLIMITED` to remove the file size limit\. | - -The following example resizes data file 4 to 500 MB\. - -``` -EXEC rdsadmin.rdsadmin_util.resize_datafile(4,'500M'); -``` - -The following example turns off autoextension for data file 4\. It also turns on autoextension for data file 5, with an increment of 128 MB and no maximum size\. - -``` -EXEC rdsadmin.rdsadmin_util.autoextend_datafile(4,'OFF'); -EXEC rdsadmin.rdsadmin_util.autoextend_datafile(5,'ON','128M','UNLIMITED'); -``` - -### Resizing temporary tablespaces - -To resize a temporary tablespaces in an RDS for Oracle DB instance, including a read replica, use any of the following Amazon RDS procedures: -+ `rdsadmin.rdsadmin_util.resize_temp_tablespace` -+ `rdsadmin.rdsadmin_util.resize_tempfile` -+ `rdsadmin.rdsadmin_util.autoextend_tempfile` - -The `resize_temp_tablespace` procedure has the following parameters\. - - -**** - -| Parameter name | Data type | Default | Required | Description | -| --- | --- | --- | --- | --- | -| `p_temp_tablespace_name` | varchar2 | — | Yes | The name of the temporary tablespace to resize\. | -| `p_size` | varchar2 | — | Yes | The size of the tablespace\. Specify the size in bytes \(the default\), kilobytes \(K\), megabytes \(M\), or gigabytes \(G\)\. | - -The `resize_tempfile` procedure has the following parameters\. - - -**** - -| Parameter name | Data type | Default | Required | Description | -| --- | --- | --- | --- | --- | -| `p_temp_file_id` | number | — | Yes | The identifier of the temp file to resize\. | -| `p_size` | varchar2 | — | Yes | The size of the temp file\. Specify the size in bytes \(the default\), kilobytes \(K\), megabytes \(M\), or gigabytes \(G\)\. | - -The `autoextend_tempfile` procedure has the following parameters\. - - -**** - -| Parameter name | Data type | Default | Required | Description | -| --- | --- | --- | --- | --- | -| `p_temp_file_id` | number | — | Yes | The identifier of the temp file to resize\. | -| `p_autoextend_state` | varchar2 | — | Yes | The state of the autoextension feature\. Specify `ON` to extend the temp file automatically and `OFF` to turn off autoextension\. | -| `p_next` | varchar2 | — | No | The size of the next temp file increment\. Specify the size in bytes \(the default\), kilobytes \(K\), megabytes \(M\), or gigabytes \(G\)\. | -| `p_maxsize` | varchar2 | — | No | The maximum disk space allowed for automatic extension\. Specify the size in bytes \(the default\), kilobytes \(K\), megabytes \(M\), or gigabytes \(G\)\. You can specify `UNLIMITED` to remove the file size limit\. | - -The following examples resize a temporary tablespace named `TEMP` to the size of 4 GB\. - -``` -EXEC rdsadmin.rdsadmin_util.resize_temp_tablespace('TEMP','4G'); -``` - -``` -EXEC rdsadmin.rdsadmin_util.resize_temp_tablespace('TEMP','4096000000'); -``` - -The following example resizes a temporary tablespace based on the temp file with the file identifier `1` to the size of 2 MB\. - -``` -EXEC rdsadmin.rdsadmin_util.resize_tempfile(1,'2M'); -``` - -The following example turns off autoextension for temp file 1\. It also sets the maximum autoextension size of temp file 2 to 10 GB, with an increment of 100 MB\. - -``` -EXEC rdsadmin.rdsadmin_util.autoextend_tempfile(1,'OFF'); -EXEC rdsadmin.rdsadmin_util.autoextend_tempfile(2,'ON','100M','10G'); -``` - -For more information about read replicas for Oracle DB instances see [Working with read replicas for Amazon RDS for Oracle](oracle-read-replicas.md)\. - -## Purging the recycle bin - -When you drop a table, your Oracle database doesn't immediately remove its storage space\. The database renames the table and places it and any associated objects in a recycle bin\. Purging the recycle bin removes these items and releases their storage space\. - -To purge the entire recycle bin, use the Amazon RDS procedure `rdsadmin.rdsadmin_util.purge_dba_recyclebin`\. However, this procedure can't purge the recycle bin of `SYS` and `RDSADMIN` objects\. If you need to purge these objects, contact AWS Support\. - -The following example purges the entire recycle bin\. - -``` -EXEC rdsadmin.rdsadmin_util.purge_dba_recyclebin; -``` - -## Setting the Data Redaction policy for full redaction - -To change the default displayed values for a Data Redaction policy for full redaction on your Amazon RDS Oracle instance, use the Amazon RDS procedure `rdsadmin.rdsadmin_util.dbms_redact_upd_full_rdct_val`\. - -The `dbms_redact_upd_full_rdct_val` procedure has the following parameters\. - - -**** - -| Parameter name | Data type | Default | Required | Description | -| --- | --- | --- | --- | --- | -| `p_number_val` | number | Null | No | Modifies the default value for columns of the NUMBER datatype\. | -| `p_binfloat_val` | binary\_float | Null | No | Modifies the default value for columns of the BINARY\_FLOAT datatype\. | -| `p_bindouble_val` | binary\_double | Null | No | Modifies the default value for columns of the BINARY\_DOUBLE datatype\. | -| `p_char_val` | char | Null | No | Modifies the default value for columns of the CHAR datatype\. | -| `p_varchar_val` | varchar2 | Null | No | Modifies the default value for columns of the VARCHAR2 datatype\. | -| `p_nchar_val` | nchar | Null | No | Modifies the default value for columns of the NCHAR datatype\. | -| `p_nvarchar_val` | nvarchar2 | Null | No | Modifies the default value for columns of the NVARCHAR2 datatype\. | -| `p_date_val` | date | Null | No | Modifies the default value for columns of the DATE datatype\. | -| `p_ts_val` | timestamp | Null | No | Modifies the default value for columns of the TIMESTAMP datatype\. | -| `p_tswtz_val` | timestamp with time zone | Null | No | Modifies the default value for columns of the TIMESTAMP WITH TIME ZONE datatype\. | -| `p_blob_val` | blob | Null | No | Modifies the default value for columns of the BLOB datatype\. | -| `p_clob_val` | clob | Null | No | Modifies the default value for columns of the CLOB datatype\. | -| `p_nclob_val` | nclob | Null | No | Modifies the default value for columns of the NCLOB datatype\. | - -The following example changes the default redacted value to \* for char datatype: - -``` -EXEC rdsadmin.rdsadmin_util.dbms_redact_upd_full_rdct_val(p_char_val => '*'); -``` - -The following example changes the default redacted values for number, date and char datatypes: - -``` -begin - rdsadmin.rdsadmin_util.dbms_redact_upd_full_rdct_val( - p_number_val=>1, - p_date_val=>to_date('1900-01-01','YYYY-MM-DD'), - p_varchar_val=>'X'); -end; -/ -``` - -After you alter the default values for full redaction with the dbms\_redact\_upd\_full\_rdct\_val procedure, reboot your DB instance for the change to take effect\. For more information, see [Rebooting a DB instance](USER_RebootInstance.md)\. \ No newline at end of file diff --git a/doc_source/Appendix.Oracle.CommonDBATasks.Diagnostics.md b/doc_source/Appendix.Oracle.CommonDBATasks.Diagnostics.md deleted file mode 100644 index f8008c6..0000000 --- a/doc_source/Appendix.Oracle.CommonDBATasks.Diagnostics.md +++ /dev/null @@ -1,307 +0,0 @@ -# Performing common diagnostic tasks for Oracle DB instances - -Oracle Database includes a fault diagnosability infrastructure that you can use to investigate database problems\. In Oracle terminology, a *problem* is a critical error such as a code bug or data corruption\. An *incident* is the occurrence of a problem\. If the same error occurs three times, then the infrastructure shows three incidents of this problem\. For more information, see [Diagnosing and resolving problems](https://docs.oracle.com/en/database/oracle/oracle-database/19/admin/diagnosing-and-resolving-problems.html#GUID-8DEB1BE0-8FB9-4FB2-A19A-17CF6F5791C3) in the Oracle Database documentation\. - -The Automatic Diagnostic Repository Command Interpreter \(ADRCI\) utility is an Oracle command\-line tool that you use to manage diagnostic data\. For example, you can use this tool to investigate problems and package diagnostic data\. An *incident package* includes diagnostic data for an incident or all incidents that reference a specific problem\. You can upload an incident package, which is implemented as a \.zip file, to Oracle Support\. - -To deliver a managed service experience, Amazon RDS doesn't provide shell access to ADRCI\. To perform diagnostic tasks for your Oracle instance, instead use the Amazon RDS package `rdsadmin.rdsadmin_adrci_util`\. - -By using the functions in `rdsadmin_adrci_util`, you can list and package problems and incidents, and also show trace files\. All functions return a task ID\. This ID forms part of the name of log file that contains the ADRCI output, as in `dbtask-task_id.log`\. The log file resides in the BDUMP directory\. - -## Common parameters for diagnostic procedures - -To perform diagnostic tasks, use functions in the Amazon RDS package `rdsadmin.rdsadmin_adrci_util`\. The package has the following common parameters\. - - -**** - -| Parameter name | Data type | Valid values | Default | Required | Description | -| --- | --- | --- | --- | --- | --- | -| `incident_id` | number | A valid incident ID or null | Null | No | If the value is null, the function shows all incidents\. If the value isn't null and represents a valid incident ID, the function shows the specified incident\. | -| `problem_id` | number | A valid problem ID or null | Null | No | If the value is null, the function shows all problems\. If the value isn't null and represents a valid problem ID, the function shows the specified problem\. | -| `last` | number | A valid integer greater than 0 or null | Null | No | If the value is null, then the function displays at most 50 items\. If the value isn't null, the function displays the specified number\. | - -## Listing incidents - -To list diagnostic incidents for Oracle, use the Amazon RDS function `rdsadmin.rdsadmin_adrci_util.list_adrci_incidents`\. You can list incidents in either basic or detailed mode\. By default, the function lists the 50 most recent incidents\. - -This function uses the following common parameters: -+ `incident_id` -+ `problem_id` -+ `last` - -If you specify `incident_id` and `problem_id`, then `incident_id` overrides `problem_id`\. For more information, see [Common parameters for diagnostic procedures](#Appendix.Oracle.CommonDBATasks.CommonDiagParameters)\. - -This function uses the following additional parameter\. - - -**** - -| Parameter name | Data type | Valid values | Default | Required | Description | -| --- | --- | --- | --- | --- | --- | -| `detail` | boolean | TRUE or FALSE | `FALSE` | No | If `TRUE`, the function lists incidents in detail mode\. If `FALSE`, the function lists incidents in basic mode\. | - -To list all incidents, query the `rdsadmin.rdsadmin_adrci_util.list_adrci_incidents` function without any arguments\. The query returns the task ID\. - -``` -SQL> SELECT rdsadmin.rdsadmin_adrci_util.list_adrci_incidents AS task_id FROM DUAL; - -TASK_ID ------------------- -1590786706158-3126 -``` - -Or call the `rdsadmin.rdsadmin_adrci_util.list_adrci_incidents` function without any arguments and store the output in a SQL client variable\. You can use the variable in other statements\. - -``` -SQL> VAR task_id VARCHAR2(80); -SQL> EXEC :task_id := rdsadmin.rdsadmin_adrci_util.list_adrci_incidents; - -PL/SQL procedure successfully completed. -``` - -To read the log file, call the Amazon RDS procedure `rdsadmin.rds_file_util.read_text_file`\. Supply the task ID as part of the file name\. The following output shows three incidents: 53523, 53522, and 53521\. - -``` -SQL> SELECT * FROM TABLE(rdsadmin.rds_file_util.read_text_file('BDUMP', 'dbtask-'||:task_id||'.log')); - -TEXT -------------------------------------------------------------------------------------------------------------------------- -2020-05-29 21:11:46.193 UTC [INFO ] Listing ADRCI incidents. -2020-05-29 21:11:46.256 UTC [INFO ] -ADR Home = /rdsdbdata/log/diag/rdbms/orcl_a/ORCL: -************************************************************************* -INCIDENT_ID PROBLEM_KEY CREATE_TIME ------------ ----------------------------------------------------------- ---------------------------------------- -53523 ORA 700 [EVENT_CREATED_INCIDENT] [942] [SIMULATED_ERROR_003 2020-05-29 20:15:20.928000 +00:00 -53522 ORA 700 [EVENT_CREATED_INCIDENT] [942] [SIMULATED_ERROR_002 2020-05-29 20:15:15.247000 +00:00 -53521 ORA 700 [EVENT_CREATED_INCIDENT] [942] [SIMULATED_ERROR_001 2020-05-29 20:15:06.047000 +00:00 -3 rows fetched - - -2020-05-29 21:11:46.256 UTC [INFO ] The ADRCI incidents were successfully listed. -2020-05-29 21:11:46.256 UTC [INFO ] The task finished successfully. - -14 rows selected. -``` - -To list a particular incident, specify its ID using the `incident_id` parameter\. In the following example, you query the log file for incident 53523 only\. - -``` -SQL> EXEC :task_id := rdsadmin.rdsadmin_adrci_util.list_adrci_incidents(incident_id=>53523); - -PL/SQL procedure successfully completed. - -SQL> SELECT * FROM TABLE(rdsadmin.rds_file_util.read_text_file('BDUMP', 'dbtask-'||:task_id||'.log')); - -TEXT ------------------------------------------------------------------------------------------------------------------- -2020-05-29 21:15:25.358 UTC [INFO ] Listing ADRCI incidents. -2020-05-29 21:15:25.426 UTC [INFO ] -ADR Home = /rdsdbdata/log/diag/rdbms/orcl_a/ORCL: -************************************************************************* -INCIDENT_ID PROBLEM_KEY CREATE_TIME --------------------- ----------------------------------------------------------- --------------------------------- -53523 ORA 700 [EVENT_CREATED_INCIDENT] [942] [SIMULATED_ERROR_003 2020-05-29 20:15:20.928000 +00:00 -1 rows fetched - - -2020-05-29 21:15:25.427 UTC [INFO ] The ADRCI incidents were successfully listed. -2020-05-29 21:15:25.427 UTC [INFO ] The task finished successfully. - -12 rows selected. -``` - -## Listing problems - -To list diagnostic problems for Oracle, use the Amazon RDS function `rdsadmin.rdsadmin_adrci_util.list_adrci_problems`\. - -By default, the function lists the 50 most recent problems\. - -This function uses the common parameters `problem_id` and `last`\. For more information, see [Common parameters for diagnostic procedures](#Appendix.Oracle.CommonDBATasks.CommonDiagParameters)\. - -To get the task ID for all problems, call the `rdsadmin.rdsadmin_adrci_util.list_adrci_problems` function without any arguments, and store the output in a SQL client variable\. - -``` -SQL> EXEC :task_id := rdsadmin.rdsadmin_adrci_util.list_adrci_problems; - -PL/SQL procedure successfully completed. -``` - -To read the log file, call the `rdsadmin.rds_file_util.read_text_file` function, supplying the task ID as part of the file name\. In the following output, the log file shows three problems: 1, 2, and 3\. - -``` -SQL> SELECT * FROM TABLE(rdsadmin.rds_file_util.read_text_file('BDUMP', 'dbtask-'||:task_id||'.log')); - -TEXT ----------------------------------------------------------------------------------------------------------------------- -2020-05-29 21:18:50.764 UTC [INFO ] Listing ADRCI problems. -2020-05-29 21:18:50.829 UTC [INFO ] -ADR Home = /rdsdbdata/log/diag/rdbms/orcl_a/ORCL: -************************************************************************* -PROBLEM_ID PROBLEM_KEY LAST_INCIDENT LASTINC_TIME ----------- ----------------------------------------------------------- ------------- --------------------------------- -2 ORA 700 [EVENT_CREATED_INCIDENT] [942] [SIMULATED_ERROR_003 53523 2020-05-29 20:15:20.928000 +00:00 -3 ORA 700 [EVENT_CREATED_INCIDENT] [942] [SIMULATED_ERROR_002 53522 2020-05-29 20:15:15.247000 +00:00 -1 ORA 700 [EVENT_CREATED_INCIDENT] [942] [SIMULATED_ERROR_001 53521 2020-05-29 20:15:06.047000 +00:00 -3 rows fetched - - -2020-05-29 21:18:50.829 UTC [INFO ] The ADRCI problems were successfully listed. -2020-05-29 21:18:50.829 UTC [INFO ] The task finished successfully. - -14 rows selected. -``` - -In the following example, you list problem 3 only\. - -``` -SQL> EXEC :task_id := rdsadmin.rdsadmin_adrci_util.list_adrci_problems(problem_id=>3); - -PL/SQL procedure successfully completed. -``` - -To read the log file for problem 3, call `rdsadmin.rds_file_util.read_text_file`\. Supply the task ID as part of the file name\. - -``` -SQL> SELECT * FROM TABLE(rdsadmin.rds_file_util.read_text_file('BDUMP', 'dbtask-'||:task_id||'.log')); - -TEXT -------------------------------------------------------------------------- -2020-05-29 21:19:42.533 UTC [INFO ] Listing ADRCI problems. -2020-05-29 21:19:42.599 UTC [INFO ] -ADR Home = /rdsdbdata/log/diag/rdbms/orcl_a/ORCL: -************************************************************************* -PROBLEM_ID PROBLEM_KEY LAST_INCIDENT LASTINC_TIME ----------- ----------------------------------------------------------- ------------- --------------------------------- -3 ORA 700 [EVENT_CREATED_INCIDENT] [942] [SIMULATED_ERROR_002 53522 2020-05-29 20:15:15.247000 +00:00 -1 rows fetched - - -2020-05-29 21:19:42.599 UTC [INFO ] The ADRCI problems were successfully listed. -2020-05-29 21:19:42.599 UTC [INFO ] The task finished successfully. - -12 rows selected. -``` - -## Creating incident packages - -You can create incident packages using the Amazon RDS function `rdsadmin.rdsadmin_adrci_util.create_adrci_package`\. The output is a \.zip file that you can supply to Oracle Support\. - -This function uses the following common parameters: -+ `problem_id` -+ `incident_id` - -Make sure to specify one of the preceding parameters\. If you specify both parameters, `incident_id` overrides `problem_id`\. For more information, see [Common parameters for diagnostic procedures](#Appendix.Oracle.CommonDBATasks.CommonDiagParameters)\. - -To create a package for a specific incident, call the Amazon RDS function `rdsadmin.rdsadmin_adrci_util.create_adrci_package` with the `incident_id` parameter\. The following example creates a package for incident 53523\. - -``` -SQL> EXEC :task_id := rdsadmin.rdsadmin_adrci_util.create_adrci_package(incident_id=>53523); - -PL/SQL procedure successfully completed. -``` - -To read the log file, call the `rdsadmin.rds_file_util.read_text_file`\. You can supply the task ID as part of the file name\. The output shows that you generated incident package `ORA700EVE_20200529212043_COM_1.zip`\. - -``` -SQL> SELECT * FROM TABLE(rdsadmin.rds_file_util.read_text_file('BDUMP', 'dbtask-'||:task_id||'.log')); - -TEXT --------------------------------------------------------------------------------------------------------------------------------------- -2020-05-29 21:20:43.031 UTC [INFO ] The ADRCI package is being created. -2020-05-29 21:20:47.641 UTC [INFO ] Generated package 1 in file /rdsdbdata/log/trace/ORA700EVE_20200529212043_COM_1.zip, mode complete -2020-05-29 21:20:47.642 UTC [INFO ] The ADRCI package was successfully created. -2020-05-29 21:20:47.642 UTC [INFO ] The task finished successfully. -``` - -To package diagnostic data for a particular problem, specify its ID using the `problem_id` parameter\. In the following example, you package data for problem 3 only\. - -``` -SQL> EXEC :task_id := rdsadmin.rdsadmin_adrci_util.create_adrci_package(problem_id=>3); - -PL/SQL procedure successfully completed. -``` - -To read the task output, call `rdsadmin.rds_file_util.read_text_file`, supplying the task ID as part of the file name\. The output shows that you generated incident package `ORA700EVE_20200529212111_COM_1.zip`\. - -``` -SQL> SELECT * FROM TABLE(rdsadmin.rds_file_util.read_text_file('BDUMP', 'dbtask-'||:task_id||'.log')); - -TEXT ------------------------------------------------------------------------------------------------------------------------------------------------------------- -2020-05-29 21:21:11.050 UTC [INFO ] The ADRCI package is being created. -2020-05-29 21:21:15.646 UTC [INFO ] Generated package 2 in file /rdsdbdata/log/trace/ORA700EVE_20200529212111_COM_1.zip, mode complete -2020-05-29 21:21:15.646 UTC [INFO ] The ADRCI package was successfully created. -2020-05-29 21:21:15.646 UTC [INFO ] The task finished successfully. -``` - -## Showing trace files - -You can use the Amazon RDS function `rdsadmin.rdsadmin_adrci_util.show_adrci_tracefile` to list trace files under the trace directory and all incident directories under the current ADR home\. You can also show the contents of trace files and incident trace files\. - -This function uses the following parameter\. - - -**** - -| Parameter name | Data type | Valid values | Default | Required | Description | -| --- | --- | --- | --- | --- | --- | -| `filename` | varchar2 | A valid trace file name | Null | No | If the value is null, the function shows all trace files\. If it isn't null, the function shows the specified file\. | - -To show the trace file, call the Amazon RDS function `rdsadmin.rdsadmin_adrci_util.show_adrci_tracefile`\. - -``` -SQL> EXEC :task_id := rdsadmin.rdsadmin_adrci_util.show_adrci_tracefile; - -PL/SQL procedure successfully completed. -``` - -To list the trace file names, call the Amazon RDS procedure `rdsadmin.rds_file_util.read_text_file`, supplying the task ID as part of the file name\. - -``` -SQL> SELECT * FROM TABLE(rdsadmin.rds_file_util.read_text_file('BDUMP', 'dbtask-'||:task_id||'.log')) WHERE TEXT LIKE '%/alert_%'; - -TEXT ---------------------------------------------------------------- - diag/rdbms/orcl_a/ORCL/trace/alert_ORCL.log.2020-05-28 - diag/rdbms/orcl_a/ORCL/trace/alert_ORCL.log.2020-05-27 - diag/rdbms/orcl_a/ORCL/trace/alert_ORCL.log.2020-05-26 - diag/rdbms/orcl_a/ORCL/trace/alert_ORCL.log.2020-05-25 - diag/rdbms/orcl_a/ORCL/trace/alert_ORCL.log.2020-05-24 - diag/rdbms/orcl_a/ORCL/trace/alert_ORCL.log.2020-05-23 - diag/rdbms/orcl_a/ORCL/trace/alert_ORCL.log.2020-05-22 - diag/rdbms/orcl_a/ORCL/trace/alert_ORCL.log.2020-05-21 - diag/rdbms/orcl_a/ORCL/trace/alert_ORCL.log - -9 rows selected. -``` - -In the following example, you generate output for alert\_ORCL\.log\. - -``` -SQL> EXEC :task_id := rdsadmin.rdsadmin_adrci_util.show_adrci_tracefile('diag/rdbms/orcl_a/ORCL/trace/alert_ORCL.log'); - -PL/SQL procedure successfully completed. -``` - -To read the log file, call `rdsadmin.rds_file_util.read_text_file`\. Supply the task ID as part of the file name\. The output shows the first 10 lines of alert\_ORCL\.log\. - -``` -SQL> SELECT * FROM TABLE(rdsadmin.rds_file_util.read_text_file('BDUMP', 'dbtask-'||:task_id||'.log')) WHERE ROWNUM <= 10; - -TEXT ------------------------------------------------------------------------------------------ -2020-05-29 21:24:02.083 UTC [INFO ] The trace files are being displayed. -2020-05-29 21:24:02.128 UTC [INFO ] Thu May 28 23:59:10 2020 -Thread 1 advanced to log sequence 2048 (LGWR switch) - Current log# 3 seq# 2048 mem# 0: /rdsdbdata/db/ORCL_A/onlinelog/o1_mf_3_hbl2p8xs_.log -Thu May 28 23:59:10 2020 -Archived Log entry 2037 added for thread 1 sequence 2047 ID 0x5d62ce43 dest 1: -Fri May 29 00:04:10 2020 -Thread 1 advanced to log sequence 2049 (LGWR switch) - Current log# 4 seq# 2049 mem# 0: /rdsdbdata/db/ORCL_A/onlinelog/o1_mf_4_hbl2qgmh_.log -Fri May 29 00:04:10 2020 - -10 rows selected. -``` \ No newline at end of file diff --git a/doc_source/Appendix.Oracle.CommonDBATasks.Log.md b/doc_source/Appendix.Oracle.CommonDBATasks.Log.md deleted file mode 100644 index 1fd72e0..0000000 --- a/doc_source/Appendix.Oracle.CommonDBATasks.Log.md +++ /dev/null @@ -1,441 +0,0 @@ -# Performing common log\-related tasks for Oracle DB instances - -Following, you can find how to perform certain common DBA tasks related to logging on your Amazon RDS DB instances running Oracle\. To deliver a managed service experience, Amazon RDS doesn't provide shell access to DB instances, and restricts access to certain system procedures and tables that require advanced privileges\. - -For more information, see [Oracle database log files](USER_LogAccess.Concepts.Oracle.md)\. - -**Topics** -+ [Setting force logging](#Appendix.Oracle.CommonDBATasks.SettingForceLogging) -+ [Setting supplemental logging](#Appendix.Oracle.CommonDBATasks.AddingSupplementalLogging) -+ [Switching online log files](#Appendix.Oracle.CommonDBATasks.SwitchingLogfiles) -+ [Adding online redo logs](#Appendix.Oracle.CommonDBATasks.RedoLogs) -+ [Dropping online redo logs](#Appendix.Oracle.CommonDBATasks.DroppingRedoLogs) -+ [Resizing online redo logs](#Appendix.Oracle.CommonDBATasks.ResizingRedoLogs) -+ [Retaining archived redo logs](#Appendix.Oracle.CommonDBATasks.RetainRedoLogs) -+ [Accessing online and archived redo logs](#Appendix.Oracle.CommonDBATasks.Log.Download) -+ [Downloading archived redo logs from Amazon S3](#Appendix.Oracle.CommonDBATasks.download-redo-logs) - -## Setting force logging - -In force logging mode, Oracle logs all changes to the database except changes in temporary tablespaces and temporary segments \(`NOLOGGING` clauses are ignored\)\. For more information, see [Specifying FORCE LOGGING mode](https://docs.oracle.com/cd/E11882_01/server.112/e25494/create.htm#ADMIN11096) in the Oracle documentation\. - -To set force logging, use the Amazon RDS procedure `rdsadmin.rdsadmin_util.force_logging`\. The `force_logging` procedure has the following parameters\. - - -**** - -| Parameter name | Data type | Default | Yes | Description | -| --- | --- | --- | --- | --- | -| `p_enable` | boolean | true | No | Set to `true` to put the database in force logging mode, `false` to remove the database from force logging mode\. | - -The following example puts the database in force logging mode\. - -``` -EXEC rdsadmin.rdsadmin_util.force_logging(p_enable => true); -``` - -## Setting supplemental logging - -If you enable supplemental logging, LogMiner has the necessary information to support chained rows and clustered tables\. For more information, see [Supplemental logging](https://docs.oracle.com/cd/E11882_01/server.112/e22490/logminer.htm#SUTIL1582) in the Oracle documentation\. - -Oracle Database doesn't enable supplemental logging by default\. To enable and disable supplemental logging, use the Amazon RDS procedure `rdsadmin.rdsadmin_util.alter_supplemental_logging`\. For more information about how Amazon RDS manages the retention of archived redo logs for Oracle DB instances, see [Retaining archived redo logs](#Appendix.Oracle.CommonDBATasks.RetainRedoLogs)\. - -The `alter_supplemental_logging` procedure has the following parameters\. - - -**** - -| Parameter name | Data type | Default | Required | Description | -| --- | --- | --- | --- | --- | -| `p_action` | varchar2 | — | Yes | `'ADD'` to add supplemental logging, `'DROP'` to drop supplemental logging\. | -| `p_type` | varchar2 | null | No | The type of supplemental logging\. Valid values are `'ALL'`, `'FOREIGN KEY'`, `'PRIMARY KEY'`, `'UNIQUE'`, or `PROCEDURAL`\. | - -The following example enables supplemental logging\. - -``` -begin - rdsadmin.rdsadmin_util.alter_supplemental_logging( - p_action => 'ADD'); -end; -/ -``` - -The following example enables supplemental logging for all fixed\-length maximum size columns\. - -``` -begin - rdsadmin.rdsadmin_util.alter_supplemental_logging( - p_action => 'ADD', - p_type => 'ALL'); -end; -/ -``` - -The following example enables supplemental logging for primary key columns\. - -``` -begin - rdsadmin.rdsadmin_util.alter_supplemental_logging( - p_action => 'ADD', - p_type => 'PRIMARY KEY'); -end; -/ -``` - -## Switching online log files - -To switch log files, use the Amazon RDS procedure `rdsadmin.rdsadmin_util.switch_logfile`\. The `switch_logfile` procedure has no parameters\. - -The following example switches log files\. - -``` -EXEC rdsadmin.rdsadmin_util.switch_logfile; -``` - -## Adding online redo logs - -An Amazon RDS DB instance running Oracle starts with four online redo logs, 128 MB each\. To add additional redo logs, use the Amazon RDS procedure `rdsadmin.rdsadmin_util.add_logfile`\. - -The `add_logfile` procedure has the following parameters\. - -**Note** -The parameters are mutually exclusive\. - - -**** - -| Parameter name | Data type | Default | Required | Description | -| --- | --- | --- | --- | --- | -| `bytes` | positive | null | No | The size of the log file in bytes\. | -| `p_size` | varchar2 | — | Yes | The size of the log file\. You can specify the size in kilobytes \(K\), megabytes \(M\), or gigabytes \(G\)\. | - -The following command adds a 100 MB log file\. - -``` -EXEC rdsadmin.rdsadmin_util.add_logfile(p_size => '100M'); -``` - -## Dropping online redo logs - -To drop redo logs, use the Amazon RDS procedure `rdsadmin.rdsadmin_util.drop_logfile`\. The `drop_logfile` procedure has the following parameters\. - - -**** - -| Parameter name | Data type | Default | Required | Description | -| --- | --- | --- | --- | --- | -| `grp` | positive | — | Yes | The group number of the log\. | - -The following example drops the log with group number 3\. - -``` -EXEC rdsadmin.rdsadmin_util.drop_logfile(grp => 3); -``` - -You can only drop logs that have a status of unused or inactive\. The following example gets the statuses of the logs\. - -``` -SELECT GROUP#, STATUS FROM V$LOG; - -GROUP# STATUS ----------- ---------------- -1 CURRENT -2 INACTIVE -3 INACTIVE -4 UNUSED -``` - -## Resizing online redo logs - -An Amazon RDS DB instance running Oracle starts with four online redo logs, 128 MB each\. The following example shows how you can use Amazon RDS procedures to resize your logs from 128 MB each to 512 MB each\. - -``` -/* Query V$LOG to see the logs. */ -/* You start with 4 logs of 128 MB each. */ - -SELECT GROUP#, BYTES, STATUS FROM V$LOG; - -GROUP# BYTES STATUS ----------- ---------- ---------------- -1 134217728 INACTIVE -2 134217728 CURRENT -3 134217728 INACTIVE -4 134217728 INACTIVE - - -/* Add four new logs that are each 512 MB */ - -EXEC rdsadmin.rdsadmin_util.add_logfile(bytes => 536870912); -EXEC rdsadmin.rdsadmin_util.add_logfile(bytes => 536870912); -EXEC rdsadmin.rdsadmin_util.add_logfile(bytes => 536870912); -EXEC rdsadmin.rdsadmin_util.add_logfile(bytes => 536870912); - - -/* Query V$LOG to see the logs. */ -/* Now there are 8 logs. */ - -SELECT GROUP#, BYTES, STATUS FROM V$LOG; - -GROUP# BYTES STATUS ----------- ---------- ---------------- -1 134217728 INACTIVE -2 134217728 CURRENT -3 134217728 INACTIVE -4 134217728 INACTIVE -5 536870912 UNUSED -6 536870912 UNUSED -7 536870912 UNUSED -8 536870912 UNUSED - - -/* Drop each inactive log using the group number. */ - -EXEC rdsadmin.rdsadmin_util.drop_logfile(grp => 1); -EXEC rdsadmin.rdsadmin_util.drop_logfile(grp => 3); -EXEC rdsadmin.rdsadmin_util.drop_logfile(grp => 4); - - -/* Query V$LOG to see the logs. */ -/* Now there are 5 logs. */ - -select GROUP#, BYTES, STATUS from V$LOG; - -GROUP# BYTES STATUS ----------- ---------- ---------------- -2 134217728 CURRENT -5 536870912 UNUSED -6 536870912 UNUSED -7 536870912 UNUSED -8 536870912 UNUSED - - -/* Switch logs so that group 2 is no longer current. */ - -EXEC rdsadmin.rdsadmin_util.switch_logfile; - - -/* Query V$LOG to see the logs. */ -/* Now one of the new logs is current. */ - -SQL>SELECT GROUP#, BYTES, STATUS FROM V$LOG; - -GROUP# BYTES STATUS ----------- ---------- ---------------- -2 134217728 ACTIVE -5 536870912 CURRENT -6 536870912 UNUSED -7 536870912 UNUSED -8 536870912 UNUSED - - -/* If the status of log 2 is still "ACTIVE", issue a checkpoint to clear it to "INACTIVE". */ - -EXEC rdsadmin.rdsadmin_util.checkpoint; - - -/* Query V$LOG to see the logs. */ -/* Now the final original log is inactive. */ - -select GROUP#, BYTES, STATUS from V$LOG; - -GROUP# BYTES STATUS ----------- ---------- ---------------- -2 134217728 INACTIVE -5 536870912 CURRENT -6 536870912 UNUSED -7 536870912 UNUSED -8 536870912 UNUSED - - -# Drop the final inactive log. - -EXEC rdsadmin.rdsadmin_util.drop_logfile(grp => 2); - - -/* Query V$LOG to see the logs. */ -/* Now there are four 512 MB logs. */ - -SELECT GROUP#, BYTES, STATUS FROM V$LOG; - -GROUP# BYTES STATUS ----------- ---------- ---------------- -5 536870912 CURRENT -6 536870912 UNUSED -7 536870912 UNUSED -8 536870912 UNUSED -``` - -## Retaining archived redo logs - -You can retain archived redo logs locally on your DB instance for use with products like Oracle LogMiner \(`DBMS_LOGMNR`\)\. After you have retained the redo logs, you can use LogMiner to analyze the logs\. For more information, see [Using LogMiner to analyze redo log files](http://docs.oracle.com/cd/E11882_01/server.112/e22490/logminer.htm) in the Oracle documentation\. - -To retain archived redo logs, use the Amazon RDS procedure `rdsadmin.rdsadmin_util.set_configuration`\. The `set_configuration` procedure has the following parameters\. - - -**** - -| Parameter name | Data type | Default | Required | Description | -| --- | --- | --- | --- | --- | -| `name` | varchar | — | Yes | The name of the configuration to update\. | -| `value` | varchar | — | Yes | The value for the configuration\. | - -The following example retains 24 hours of redo logs\. - -``` -begin - rdsadmin.rdsadmin_util.set_configuration( - name => 'archivelog retention hours', - value => '24'); -end; -/ -commit; -``` - -**Note** -The commit is required for the change to take effect\. - -To view how long archived redo logs are kept for your DB instance, use the Amazon RDS procedure `rdsadmin.rdsadmin_util.show_configuration`\. - -The following example shows the log retention time\. - -``` -set serveroutput on -EXEC rdsadmin.rdsadmin_util.show_configuration; -``` - -The output shows the current setting for `archivelog retention hours`\. The following output shows that archived redo logs are kept for 48 hours\. - -``` -NAME:archivelog retention hours -VALUE:48 -DESCRIPTION:ArchiveLog expiration specifies the duration in hours before archive/redo log files are automatically deleted. -``` - -Because the archived redo logs are retained on your DB instance, ensure that your DB instance has enough allocated storage for the retained logs\. To determine how much space your DB instance has used in the last X hours, you can run the following query, replacing X with the number of hours\. - -``` -SELECT SUM(BLOCKS * BLOCK_SIZE) bytes - FROM V$ARCHIVED_LOG - WHERE FIRST_TIME >= SYSDATE-(X/24) AND DEST_ID=1; -``` - -RDS for Oracle only generates archived redo logs when the backup retention period of your DB instance is greater than zero\. By default the backup retention period is greater than zero\. - -When the archived log retention period expires, RDS for Oracle removes the archived redo logs from your DB instance\. To support restoring your DB instance to a point in time, Amazon RDS retains the archived redo logs outside of your DB instance based on the backup retention period\. To modify the backup retention period, see [Modifying an Amazon RDS DB instance](Overview.DBInstance.Modifying.md)\. - -**Note** -In some cases, you might be using JDBC on Linux to download archived redo logs and experience long latency times and connection resets\. In such cases, the issues might be caused by the default random number generator setting on your Java client\. We recommend setting your JDBC drivers to use a nonblocking random number generator\. - -## Accessing online and archived redo logs - -You might want to access your online and archived redo log files for mining with external tools such as GoldenGate, Attunity, Informatica, and others\. To access these files, do the following: - -1. Create directory objects that provide read\-only access to the physical file paths\. - - Use `rdsadmin.rdsadmin_master_util.create_archivelog_dir` and `rdsadmin.rdsadmin_master_util.create_onlinelog_dir`\. - -1. Read the files using PL/SQL\. - - You can read the files by using PL/SQL\. For more information about reading files from directory objects, see [Listing files in a DB instance directory](Appendix.Oracle.CommonDBATasks.Misc.md#Appendix.Oracle.CommonDBATasks.ListDirectories) and [Reading files in a DB instance directory](Appendix.Oracle.CommonDBATasks.Misc.md#Appendix.Oracle.CommonDBATasks.ReadingFiles)\. - -Accessing transaction logs is supported for the following releases: -+ Oracle Database 21c -+ Oracle Database 19c -+ Oracle Database 12c Release 2 \(12\.2\.0\.1\) -+ Oracle Database 12c Release 1 \(12\.1\) - -The following code creates directories that provide read\-only access to your online and archived redo log files: - -**Important** -This code also revokes the `DROP ANY DIRECTORY` privilege\. - -``` -EXEC rdsadmin.rdsadmin_master_util.create_archivelog_dir; -EXEC rdsadmin.rdsadmin_master_util.create_onlinelog_dir; -``` - -The following code drops the directories for your online and archived redo log files\. - -``` -EXEC rdsadmin.rdsadmin_master_util.drop_archivelog_dir; -EXEC rdsadmin.rdsadmin_master_util.drop_onlinelog_dir; -``` - -The following code grants and revokes the `DROP ANY DIRECTORY` privilege\. - -``` -EXEC rdsadmin.rdsadmin_master_util.revoke_drop_any_directory; -EXEC rdsadmin.rdsadmin_master_util.grant_drop_any_directory; -``` - -## Downloading archived redo logs from Amazon S3 - -You can download archived redo logs on your DB instance using the `rdsadmin.rdsadmin_archive_log_download` package\. If archived redo logs are no longer on your DB instance, you might want to download them again from Amazon S3\. Then you can mine the logs or use them to recover or replicate your database\. - -**Note** -You can't download archived redo logs on read replica instances\. - -### Downloading archived redo logs: basic steps - -The availability of your archived redo logs depends on the following retention policies: -+ Backup retention policy – Logs inside of this policy are available in Amazon S3\. Logs outside of this policy are removed\. -+ Archived log retention policy – Logs inside of this policy are available on your DB instance\. Logs outside of this policy are removed\. - -If logs aren't on your instance but are protected by your backup retention period, use `rdsadmin.rdsadmin_archive_log_download` to download them again\. RDS for Oracle saves the logs to the `/rdsdbdata/log/arch` directory on your DB instance\. - -**To download archived redo logs from Amazon S3** - -1. Increase your archived redo log retention period so that RDS won't delete the logs that you download\. Make sure to `COMMIT` your change\. - - To learn how to set the retention policy, see [Retaining archived redo logs](#Appendix.Oracle.CommonDBATasks.RetainRedoLogs)\. - -1. Wait up to 5 minutes for the archived log retention policy change to take effect\. - -1. Download the archived redo logs from Amazon S3 using `rdsadmin.rdsadmin_archive_log_download`\. - - For more information, see [Downloading a single archived redo log](#Appendix.Oracle.CommonDBATasks.download-redo-logs.single-log) and [Downloading a series of archived redo logs](#Appendix.Oracle.CommonDBATasks.download-redo-logs.series)\. -**Note** -RDS automatically checks the available storage before downloading\. If the requested logs consume a high percentage of space, you receive an alert\. - -1. Confirm that the logs were downloaded from Amazon S3 successfully\. - - You can view the status of your download task in a bdump file\. The bdump files have the path name `/rdsdbdata/log/trace/dbtask-task-id.log`\. In the preceding download step, you run a `SELECT` statement that returns the task ID in a `VARCHAR2` data type\. For more information, see similar examples in [Monitoring the status of a file transfer](oracle-s3-integration.md#oracle-s3-integration.using.task-status)\. - -### Downloading a single archived redo log - -To download a single archived redo log to the `/rdsdbdata/log/arch` directory, use `rdsadmin.rdsadmin_archive_log_download.download_log_with_seqnum`\. This procedure has the following parameter\. - - -**** - -| Parameter name | Data type | Default | Required | Description | -| --- | --- | --- | --- | --- | -| `seqnum` | number | — | Yes | The sequence number of the archived redo log\. | - -The following example downloads the log with sequence number 20\. - -``` -SELECT rdsadmin.rdsadmin_archive_log_download.download_log_with_seqnum(seqnum => 20) - AS TASK_ID -FROM DUAL; -``` - -### Downloading a series of archived redo logs - -To download a series of archived redo logs to the `/rdsdbdata/log/arch` directory, use `download_logs_in_seqnum_range`\. Your download is limited to 300 logs per request\. The `download_logs_in_seqnum_range` procedure has the following parameters\. - - -**** - -| Parameter name | Data type | Default | Required | Description | -| --- | --- | --- | --- | --- | -| `start_seq` | number | — | Yes | The starting sequence number for the series\. | -| `end_seq` | number | — | Yes | The ending sequence number for the series\. | - -The following example downloads the logs from sequence 50 to 100\. - -``` -SELECT rdsadmin.rdsadmin_archive_log_download.download_logs_in_seqnum_range(start_seq => 50, end_seq => 100) - AS TASK_ID -FROM DUAL; -``` \ No newline at end of file diff --git a/doc_source/Appendix.Oracle.CommonDBATasks.Misc.md b/doc_source/Appendix.Oracle.CommonDBATasks.Misc.md deleted file mode 100644 index 13774ed..0000000 --- a/doc_source/Appendix.Oracle.CommonDBATasks.Misc.md +++ /dev/null @@ -1,282 +0,0 @@ -# Performing miscellaneous tasks for Oracle DB instances - -Following, you can find how to perform miscellaneous DBA tasks on your Amazon RDS DB instances running Oracle\. To deliver a managed service experience, Amazon RDS doesn't provide shell access to DB instances, and restricts access to certain system procedures and tables that require advanced privileges\. - -**Topics** -+ [Creating and dropping directories in the main data storage space](#Appendix.Oracle.CommonDBATasks.NewDirectories) -+ [Listing files in a DB instance directory](#Appendix.Oracle.CommonDBATasks.ListDirectories) -+ [Reading files in a DB instance directory](#Appendix.Oracle.CommonDBATasks.ReadingFiles) -+ [Accessing Opatch files](#Appendix.Oracle.CommonDBATasks.accessing-opatch-files) -+ [Managing advisor tasks](#Appendix.Oracle.CommonDBATasks.managing-advisor-tasks) - -## Creating and dropping directories in the main data storage space - -To create directories, use the Amazon RDS procedure `rdsadmin.rdsadmin_util.create_directory`\. You can create up to 10,000 directories, all located in your main data storage space\. To drop directories, use the Amazon RDS procedure `rdsadmin.rdsadmin_util.drop_directory`\. - -The `create_directory` and `drop_directory` procedures have the following required parameter\. - - -**** - -| Parameter name | Data type | Default | Required | Description | -| --- | --- | --- | --- | --- | -| `p_directory_name` | varchar2 | — | Yes | The name of the directory\. | - -The following example creates a new directory named `PRODUCT_DESCRIPTIONS`\. - -``` -EXEC rdsadmin.rdsadmin_util.create_directory(p_directory_name => 'product_descriptions'); -``` - -The data dictionary stores the directory name in uppercase\. You can list the directories by querying `DBA_DIRECTORIES`\. The system chooses the actual host pathname automatically\. The following example gets the directory path for the directory named `PRODUCT_DESCRIPTIONS`: - -``` -SELECT DIRECTORY_PATH - FROM DBA_DIRECTORIES - WHERE DIRECTORY_NAME='PRODUCT_DESCRIPTIONS'; - -DIRECTORY_PATH ----------------------------------------- -/rdsdbdata/userdirs/01 -``` - -The master user name for the DB instance has read and write privileges in the new directory, and can grant access to other users\. `EXECUTE` privileges are not available for directories on a DB instance\. Directories are created in your main data storage space and will consume space and I/O bandwidth\. - -The following example drops the directory named `PRODUCT_DESCRIPTIONS`\. - -``` -EXEC rdsadmin.rdsadmin_util.drop_directory(p_directory_name => 'product_descriptions'); -``` - -**Note** -You can also drop a directory by using the Oracle SQL command `DROP DIRECTORY`\. - -Dropping a directory doesn't remove its contents\. Because the `rdsadmin.rdsadmin_util.create_directory` procedure can reuse pathnames, files in dropped directories can appear in a newly created directory\. Before you drop a directory, we recommend that you use `UTL_FILE.FREMOVE` to remove files from the directory\. For more information, see [FREMOVE procedure](https://docs.oracle.com/database/121/ARPLS/u_file.htm#ARPLS70924) in the Oracle documentation\. - -## Listing files in a DB instance directory - -To list the files in a directory, use the Amazon RDS procedure `rdsadmin.rds_file_util.listdir`\. The `listdir` procedure has the following parameters\. - - -**** - -| Parameter name | Data type | Default | Required | Description | -| --- | --- | --- | --- | --- | -| `p_directory` | varchar2 | — | Yes | The name of the directory to list\. | - -The following example grants read/write privileges on the directory `PRODUCT_DESCRIPTIONS` to user `rdsadmin`, and then lists the files in this directory\. - -``` -GRANT READ,WRITE ON DIRECTORY PRODUCT_DESCRIPTIONS TO rdsadmin; -SELECT * FROM TABLE(rdsadmin.rds_file_util.listdir(p_directory => 'PRODUCT_DESCRIPTIONS')); -``` - -## Reading files in a DB instance directory - -To read a text file, use the Amazon RDS procedure `rdsadmin.rds_file_util.read_text_file`\. The `read_text_file` procedure has the following parameters\. - - -**** - -| Parameter name | Data type | Default | Required | Description | -| --- | --- | --- | --- | --- | -| `p_directory` | varchar2 | — | Yes | The name of the directory that contains the file\. | -| `p_filename` | varchar2 | — | Yes | The name of the file to read\. | - -The following example creates the file `rice.txt` in the directory `PRODUCT_DESCRIPTIONS`\. - -``` -declare - fh sys.utl_file.file_type; -begin - fh := utl_file.fopen(location=>'PRODUCT_DESCRIPTIONS', filename=>'rice.txt', open_mode=>'w'); - utl_file.put(file=>fh, buffer=>'AnyCompany brown rice, 15 lbs'); - utl_file.fclose(file=>fh); -end; -/ -``` - -The following example reads the file `rice.txt` from the directory `PRODUCT_DESCRIPTIONS`\. - -``` -SELECT * FROM TABLE - (rdsadmin.rds_file_util.read_text_file( - p_directory => 'PRODUCT_DESCRIPTIONS', - p_filename => 'rice.txt')); -``` - -## Accessing Opatch files - -Opatch is an Oracle utility that enables the application and rollback of patches to Oracle software\. The Oracle mechanism for determining which patches have been applied to a database is the `opatch lsinventory` command\. To open service requests for Bring Your Own Licence \(BYOL\) customers, Oracle Support requests the `lsinventory` file and sometimes the `lsinventory_detail` file generated by Opatch\. - -To deliver a managed service experience, Amazon RDS doesn't provide shell access to Opatch\. Instead, the `lsinventory-dbv.txt` in the BDUMP directory contains the patch information related to your current engine version\. When you perform a minor or major upgrade, Amazon RDS updates `lsinventory-dbv.txt` within an hour of applying the patch\. To verify the applied patches, read `lsinventory-dbv.txt`\. This action is similar to running the `opatch lsinventory` command\. - -**Note** -The examples in this section assume that the BDUMP directory is named `BDUMP`\. On a read replica, the BDUMP directory name is different\. To learn how to get the BDUMP name by querying `V$DATABASE.DB_UNIQUE_NAME` on a read replica, see [Listing files](USER_LogAccess.Concepts.Oracle.md#USER_LogAccess.Concepts.Oracle.WorkingWithTracefiles.ViewingBackgroundDumpDest)\. - -The inventory files use the Amazon RDS naming convention `lsinventory-dbv.txt` and `lsinventory_detail-dbv.txt`, where *dbv* is the full name of your DB version\. The `lsinventory-dbv.txt` file is available on all DB versions\. The corresponding `lsinventory_detail-dbv.txt` is available on the following DB versions: -+ 19\.0\.0\.0, ru\-2020\-01\.rur\-2020\-01\.r1 or later -+ 12\.2\.0\.1, ru\-2020\-01\.rur\-2020\-01\.r1 or later -+ 12\.1\.0\.2, v19 or later - -For example, if your DB version is 19\.0\.0\.0\.ru\-2021\-07\.rur\-2021\-07\.r1, then your inventory files have the following names\. - -``` -lsinventory-19.0.0.0.ru-2021-07.rur-2021-07.r1.txt -lsinventory_detail-19.0.0.0.ru-2021-07.rur-2021-07.r1.txt -``` - -Ensure that you download the files that match the current version of your DB engine\. - -### Console - -**To download an inventory file using the console** - -1. Open the Amazon RDS console at [https://console\.aws\.amazon\.com/rds/](https://console.aws.amazon.com/rds/)\. - -1. In the navigation pane, choose **Databases**\. - -1. Choose the name of the DB instance that has the log file that you want to view\. - -1. Choose the **Logs & events** tab\. - -1. Scroll down to the **Logs** section\. - -1. In the **Logs** section, search for `lsinventory`\. - -1. Select the file that you want to access, and then choose **Download**\. - -### SQL - -To read the `lsinventory-dbv.txt` in a SQL client, you can use a `SELECT` statement\. For this technique, use either of the following `rdsadmin` functions: `rdsadmin.rds_file_util.read_text_file` or `rdsadmin.tracefile_listing`\. - -In the following sample query, replace *dbv* with your Oracle DB version\. For example, your DB version might be 19\.0\.0\.0\.ru\-2020\-04\.rur\-2020\-04\.r1\. - -``` -SELECT text -FROM TABLE(rdsadmin.rds_file_util.read_text_file('BDUMP', 'lsinventory-dbv.txt')); -``` - -### PL/SQL - -To read the `lsinventory-dbv.txt` in a SQL client, you can write a PL/SQL program\. This program uses `utl_file` to read the file, and `dbms_output` to print it\. These are Oracle\-supplied packages\. - -In the following sample program, replace *dbv* with your Oracle DB version\. For example, your DB version might be 19\.0\.0\.0\.ru\-2020\-04\.rur\-2020\-04\.r1\. - -``` -SET SERVEROUTPUT ON -DECLARE - v_file SYS.UTL_FILE.FILE_TYPE; - v_line VARCHAR2(1000); - v_oracle_home_type VARCHAR2(1000); - c_directory VARCHAR2(30) := 'BDUMP'; - c_output_file VARCHAR2(30) := 'lsinventory-dbv.txt'; -BEGIN - v_file := SYS.UTL_FILE.FOPEN(c_directory, c_output_file, 'r'); - LOOP - BEGIN - SYS.UTL_FILE.GET_LINE(v_file, v_line,1000); - DBMS_OUTPUT.PUT_LINE(v_line); - EXCEPTION - WHEN no_data_found THEN - EXIT; - END; - END LOOP; -END; -/ -``` - -Or query `rdsadmin.tracefile_listing`, and spool the output to a file\. The following example spools the output to `/tmp/tracefile.txt`\. - -``` -SPOOL /tmp/tracefile.txt -SELECT * -FROM rdsadmin.tracefile_listing -WHERE FILENAME LIKE 'lsinventory%'; -SPOOL OFF; -``` - -## Managing advisor tasks - -Oracle Database includes a number of advisors\. Each advisor supports automated and manual tasks\. You can use procedures in the `rdsadmin.rdsadmin_util` package to manage some advisor tasks\. - -The advisor task procedures are available in the following engine versions: -+ Oracle Database 21c \(21\.0\.0\) -+ Version 19\.0\.0\.0\.ru\-2021\-01\.rur\-2021\-01\.r1 and higher Oracle Database 19c versions - - For more information, see [Version 19\.0\.0\.0\.ru\-2021\-01\.rur\-2021\-01\.r1](https://docs.aws.amazon.com/AmazonRDS/latest/OracleReleaseNotes/oracle-version-19-0.html#oracle-version-RU-RUR.19.0.0.0.ru-2021-01.rur-2021-01.r1) in the *Amazon RDS for Oracle Release Notes*\. -+ Version 12\.2\.0\.1\.ru\-2021\-01\.rur\-2021\-01\.r1 and higher Oracle Database 12c \(Release 2\) 12\.2\.0\.1 versions - - For more information, see [Version 12\.2\.0\.1\.ru\-2021\-01\.rur\-2021\-01\.r1](https://docs.aws.amazon.com/AmazonRDS/latest/OracleReleaseNotes/oracle-version-12-2.html#oracle-version-RU-RUR.12.2.0.1.ru-2021-01.rur-2021-01.r1) in the *Amazon RDS for Oracle Release Notes*\. - -**Topics** -+ [Setting parameters for advisor tasks](#Appendix.Oracle.CommonDBATasks.setting-task-parameters) -+ [Disabling AUTO\_STATS\_ADVISOR\_TASK](#Appendix.Oracle.CommonDBATasks.dropping-advisor-task) -+ [Re\-enabling AUTO\_STATS\_ADVISOR\_TASK](#Appendix.Oracle.CommonDBATasks.recreating-advisor-task) - -### Setting parameters for advisor tasks - -To set parameters for some advisor tasks, use the Amazon RDS procedure `rdsadmin.rdsadmin_util.advisor_task_set_parameter`\. The `advisor_task_set_parameter` procedure has the following parameters\. - - -**** - -| Parameter name | Data type | Default | Required | Description | -| --- | --- | --- | --- | --- | -| `p_task_name` | varchar2 | — | Yes | The name of the advisor task whose parameters you want to change\. The following values are valid: [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Appendix.Oracle.CommonDBATasks.Misc.html) | -| `p_parameter` | varchar2 | — | Yes | The name of the task parameter\. To find valid parameters for an advisor task, run the following query\. Substitute *p\_task\_name* with a valid value for `p_task_name`: 
COL PARAMETER_NAME FORMAT a30
COL PARAMETER_VALUE FORMAT a30
SELECT PARAMETER_NAME, PARAMETER_VALUE
FROM DBA_ADVISOR_PARAMETERS
WHERE TASK_NAME='p_task_name'
AND PARAMETER_VALUE != 'UNUSED'
ORDER BY PARAMETER_NAME;
| -| `p_value` | varchar2 | — | Yes | The value for a task parameter\. To find valid values for task parameters, run the following query\. Substitute *p\_task\_name* with a valid value for `p_task_name`: 
COL PARAMETER_NAME FORMAT a30
COL PARAMETER_VALUE FORMAT a30
SELECT PARAMETER_NAME, PARAMETER_VALUE
FROM DBA_ADVISOR_PARAMETERS
WHERE TASK_NAME='p_task_name'
AND PARAMETER_VALUE != 'UNUSED'
ORDER BY PARAMETER_NAME;
| - -The following PL/SQL program sets `ACCEPT_PLANS` to `FALSE` for `SYS_AUTO_SPM_EVOLVE_TASK`\. The SQL Plan Management automated task verifies the plans and generates a report of its findings, but does not evolve the plans automatically\. You can use a report to identify new SQL plan baselines and accept them manually\. - -``` -BEGIN - rdsadmin.rdsadmin_util.advisor_task_set_parameter( - p_task_name => 'SYS_AUTO_SPM_EVOLVE_TASK', - p_parameter => 'ACCEPT_PLANS', - p_value => 'FALSE'); -END; -``` - -The following PL/SQL program sets `EXECUTION_DAYS_TO_EXPIRE` to `10` for `AUTO_STATS_ADVISOR_TASK`\. The predefined task `AUTO_STATS_ADVISOR_TASK` runs automatically in the maintenance window once per day\. The example sets the retention period for the task execution to 10 days\. - -``` -BEGIN - rdsadmin.rdsadmin_util.advisor_task_set_parameter( - p_task_name => 'AUTO_STATS_ADVISOR_TASK', - p_parameter => 'EXECUTION_DAYS_TO_EXPIRE', - p_value => '10'); -END; -``` - -### Disabling AUTO\_STATS\_ADVISOR\_TASK - -To disable `AUTO_STATS_ADVISOR_TASK`, use the Amazon RDS procedure `rdsadmin.rdsadmin_util.advisor_task_drop`\. The `advisor_task_drop` procedure accepts the following parameter\. - -**Note** -This procedure is available in Oracle Database 12c Release 2 \(12\.2\.0\.1\) and later\. - - -**** - -| Parameter name | Data type | Default | Required | Description | -| --- | --- | --- | --- | --- | -| `p_task_name` | varchar2 | — | Yes | The name of the advisor task to be disabled\. The only valid value is `AUTO_STATS_ADVISOR_TASK`\. | - -The following command drops `AUTO_STATS_ADVISOR_TASK`\. - -``` -EXEC rdsadmin.rdsadmin_util.advisor_task_drop('AUTO_STATS_ADVISOR_TASK') -``` - -You can re\-enabling `AUTO_STATS_ADVISOR_TASK` using `rdsadmin.rdsadmin_util.dbms_stats_init`\. - -### Re\-enabling AUTO\_STATS\_ADVISOR\_TASK - -To re\-enable `AUTO_STATS_ADVISOR_TASK`, use the Amazon RDS procedure `rdsadmin.rdsadmin_util.dbms_stats_init`\. The `dbms_stats_init` procedure takes no parameters\. - -The following command re\-enables `AUTO_STATS_ADVISOR_TASK`\. - -``` -EXEC rdsadmin.rdsadmin_util.dbms_stats_init() -``` \ No newline at end of file diff --git a/doc_source/Appendix.Oracle.CommonDBATasks.RMAN.md b/doc_source/Appendix.Oracle.CommonDBATasks.RMAN.md deleted file mode 100644 index 1d46860..0000000 --- a/doc_source/Appendix.Oracle.CommonDBATasks.RMAN.md +++ /dev/null @@ -1,601 +0,0 @@ -# Performing common RMAN tasks for Oracle DB instances - -In the following section, you can find how you can perform Oracle Recovery Manager \(RMAN\) DBA tasks on your Amazon RDS DB instances running Oracle\. To deliver a managed service experience, Amazon RDS doesn't provide shell access to DB instances\. It also restricts access to certain system procedures and tables that require advanced privileges\. - -You can use the Amazon RDS package `rdsadmin.rdsadmin_rman_util` to perform RMAN backups of your Amazon RDS for Oracle database to disk\. The `rdsadmin.rdsadmin_rman_util` package supports full and incremental database file backups, tablespace backups, and archive log backups\. - -RMAN backups consume storage space on the Amazon RDS DB instance host\. When you perform a backup, you specify an Oracle directory object as a parameter in the procedure call\. The backup files are placed in the specified directory\. You can use default directories, such as `DATA_PUMP_DIR`, or create a new directory\. For more information, see [Creating and dropping directories in the main data storage space](Appendix.Oracle.CommonDBATasks.Misc.md#Appendix.Oracle.CommonDBATasks.NewDirectories)\. - -After an RMAN backup has finished, you can copy the backup files off the Amazon RDS for Oracle DB instance host\. You might do this for the purpose of restoring to a non\-RDS host or for long\-term storage of backups\. For example, you can copy the backup files to an Amazon S3 bucket\. For more information, see using [Amazon S3 integration](oracle-s3-integration.md)\. - -The backup files for RMAN backups remain on the Amazon RDS DB instance host until you remove them manually\. You can use the `UTL_FILE.FREMOVE` Oracle procedure to remove files from a directory\. For more information, see [FREMOVE procedure](https://docs.oracle.com/database/121/ARPLS/u_file.htm#ARPLS70924) in the Oracle documentation\. - -When backing up archived redo logs or performing a full or incremental backup that includes archived redo logs, redo log retention must be set to a nonzero value\. For more information, see [Retaining archived redo logs](Appendix.Oracle.CommonDBATasks.Log.md#Appendix.Oracle.CommonDBATasks.RetainRedoLogs)\. - -**Note** -For backing up and restoring to another Amazon RDS for Oracle DB instance, you can continue to use the Amazon RDS backup and restore features\. For more information, see [Backing up and restoring](CHAP_CommonTasks.BackupRestore.md) -Currently, RMAN restore isn't supported for Amazon RDS for Oracle DB instances\. - -**Topics** -+ [Common parameters for RMAN procedures](#Appendix.Oracle.CommonDBATasks.CommonParameters) -+ [Validating DB instance files](#Appendix.Oracle.CommonDBATasks.ValidateDBFiles) -+ [Enabling and disabling block change tracking](#Appendix.Oracle.CommonDBATasks.BlockChangeTracking) -+ [Crosschecking archived redo logs](#Appendix.Oracle.CommonDBATasks.Crosscheck) -+ [Backing up archived redo logs](#Appendix.Oracle.CommonDBATasks.BackupArchivedLogs) -+ [Performing a full database backup](#Appendix.Oracle.CommonDBATasks.BackupDatabaseFull) -+ [Performing an incremental database backup](#Appendix.Oracle.CommonDBATasks.BackupDatabaseIncremental) -+ [Backing up a tablespace](#Appendix.Oracle.CommonDBATasks.BackupTablespace) -+ [Backing up a control file](#Appendix.Oracle.CommonDBATasks.backup-control-file) - -## Common parameters for RMAN procedures - -You can use procedures in the Amazon RDS package `rdsadmin.rdsadmin_rman_util` to perform tasks with RMAN\. Several parameters are common to the procedures in the package\. The package has the following common parameters\. - - -**** - -| Parameter name | Data type | Valid values | Default | Required | Description | -| --- | --- | --- | --- | --- | --- | -| `p_directory_name` | varchar2 | A valid database directory name\. | — | Yes | The name of the directory to contain the backup files\. | -| `p_label` | varchar2 | `a-z`, `A-Z`, `0-9`, `'_'`, `'-'`, `'.'` | — | No | A unique string that is included in the backup file names\. The limit is 30 characters\. | -| `p_owner` | varchar2 | A valid owner of the directory specified in `p_directory_name`\. | — | Yes | The owner of the directory to contain the backup files\. | -| `p_tag` | varchar2 | `a-z`, `A-Z`, `0-9`, `'_'`, `'-'`, `'.'` | NULL | No | A string that can be used to distinguish between backups to indicate the purpose or usage of backups, such as daily, weekly, or incremental\-level backups\. The limit is 30 characters\. The tag is not case\-sensitive\. Tags are always stored in uppercase, regardless of the case used when entering them\. Tags don't need to be unique, so multiple backups can have the same tag\. If you don't specify a tag, then RMAN assigns a default tag automatically using the format `TAGYYYYMMDDTHHMMSS`, where *YYYY* is the year, *MM* is the month, *DD* is the day, *HH* is the hour \(in 24\-hour format\), *MM* is the minutes, and *SS* is the seconds\. The date and time refer to when RMAN started the backup\. For example, a backup might receive a tag `TAG20190927T214517` for a backup that started on 2019\-09\-27 at 21:45:17\. The `p_tag` parameter is supported for the following Amazon RDS for Oracle DB engine versions: [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Appendix.Oracle.CommonDBATasks.RMAN.html) | -| `p_compress` | boolean | `TRUE`, `FALSE` | `FALSE` | No | Specify `TRUE` to enable BASIC backup compression\. Specify `FALSE` to disable BASIC backup compression\. | -| `p_include_archive_logs` | boolean | `TRUE`, `FALSE` | `FALSE` | No | Specify `TRUE` to include archived redo logs in the backup\. Specify `FALSE` to exclude archived redo logs from the backup\. If you include archived redo logs in the backup, set retention to one hour or greater using the `rdsadmin.rdsadmin_util.set_configuration` procedure\. Also, call the `rdsadmin.rdsadmin_rman_util.crosscheck_archivelog` procedure immediately before running the backup\. Otherwise, the backup might fail due to missing archived redo log files that have been deleted by Amazon RDS management procedures\. | -| `p_include_controlfile` | boolean | `TRUE`, `FALSE` | `FALSE` | No | Specify `TRUE` to include the control file in the backup\. Specify `FALSE` to exclude the control file from the backup\. | -| `p_optimize` | boolean | `TRUE`, `FALSE` | `TRUE` | No | Specify `TRUE` to enable backup optimization, if archived redo logs are included, to reduce backup size\. Specify `FALSE` to disable backup optimization\. | -| `p_parallel` | number | A valid integer between `1` and `254` for Oracle Database Enterprise Edition \(EE\) `1` for other Oracle Database editions | `1` | No | Number of channels\. | -| `p_rman_to_dbms_output` | boolean | `TRUE`, `FALSE` | `FALSE` | No | When `TRUE`, the RMAN output is sent to the `DBMS_OUTPUT` package in addition to a file in the `BDUMP` directory\. In SQL\*Plus, use `SET SERVEROUTPUT ON` to see the output\. When `FALSE`, the RMAN output is only sent to a file in the `BDUMP` directory\. | -| `p_section_size_mb` | number | A valid integer | `NULL` | No | The section size in megabytes \(MB\)\. Validates in parallel by dividing each file into the specified section size\. When `NULL`, the parameter is ignored\. | -| `p_validation_type` | varchar2 | `'PHYSICAL'`, `'PHYSICAL+LOGICAL'` | `'PHYSICAL'` | No | The level of corruption detection\. Specify `'PHYSICAL'` to check for physical corruption\. An example of physical corruption is a block with a mismatch in the header and footer\. Specify `'PHYSICAL+LOGICAL'` to check for logical inconsistencies in addition to physical corruption\. An example of logical corruption is a corrupt block\. | - -## Validating DB instance files - -You can use the Amazon RDS package `rdsadmin.rdsadmin_rman_util` to validate Amazon RDS for Oracle DB instance files, such as data files, tablespaces, control files, or server parameter files \(SPFILEs\)\. - -For more information about RMAN validation, see [ Validating database files and backups](https://docs.oracle.com/database/121/BRADV/rcmvalid.htm#BRADV90063) and [ VALIDATE](https://docs.oracle.com/database/121/RCMRF/rcmsynta2025.htm#RCMRF162) in the Oracle documentation\. - -**Topics** -+ [Validating a DB instance](#Appendix.Oracle.CommonDBATasks.ValidateDB) -+ [Validating a tablespace](#Appendix.Oracle.CommonDBATasks.ValidateTablespace) -+ [Validating a control file](#Appendix.Oracle.CommonDBATasks.ValidateControlFile) -+ [Validating an SPFILE](#Appendix.Oracle.CommonDBATasks.ValidateSpfile) -+ [Validating a data file](#Appendix.Oracle.CommonDBATasks.ValidateDataFile) - -### Validating a DB instance - -To validate all of the relevant files used by an Amazon RDS Oracle DB instance, use the Amazon RDS procedure `rdsadmin.rdsadmin_rman_util.validate_database`\. - -This procedure uses the following common parameters for RMAN tasks: -+ `p_validation_type` -+ `p_parallel` -+ `p_section_size_mb` -+ `p_rman_to_dbms_output` - -For more information, see [Common parameters for RMAN procedures](#Appendix.Oracle.CommonDBATasks.CommonParameters)\. - -The following example validates the DB instance using the default values for the parameters\. - -``` -EXEC rdsadmin.rdsadmin_rman_util.validate_database; -``` - -The following example validates the DB instance using the specified values for the parameters\. - -``` -BEGIN - rdsadmin.rdsadmin_rman_util.validate_database( - p_validation_type => 'PHYSICAL+LOGICAL', - p_parallel => 4, - p_section_size_mb => 10, - p_rman_to_dbms_output => FALSE); -END; -/ -``` - -When the `p_rman_to_dbms_output` parameter is set to `FALSE`, the RMAN output is written to a file in the `BDUMP` directory\. - -To view the files in the `BDUMP` directory, run the following `SELECT` statement\. - -``` -SELECT * FROM table(rdsadmin.rds_file_util.listdir('BDUMP')) order by mtime; -``` - -To view the contents of a file in the `BDUMP` directory, run the following `SELECT` statement\. - -``` -SELECT text FROM table(rdsadmin.rds_file_util.read_text_file('BDUMP','rds-rman-validate-nnn.txt')); -``` - -Replace the file name with the name of the file you want to view\. - -### Validating a tablespace - -To validate the files associated with a tablespace, use the Amazon RDS procedure `rdsadmin.rdsadmin_rman_util.validate_tablespace`\. - -This procedure uses the following common parameters for RMAN tasks: -+ `p_validation_type` -+ `p_parallel` -+ `p_section_size_mb` -+ `p_rman_to_dbms_output` - -For more information, see [Common parameters for RMAN procedures](#Appendix.Oracle.CommonDBATasks.CommonParameters)\. - -This procedure also uses the following additional parameter\. - - -**** - -| Parameter name | Data type | Valid values | Default | Required | Description | -| --- | --- | --- | --- | --- | --- | -| `p_tablespace_name` | varchar2 | A valid tablespace name | — | Yes | The name of the tablespace\. | - -### Validating a control file - -To validate only the control file used by an Amazon RDS Oracle DB instance, use the Amazon RDS procedure `rdsadmin.rdsadmin_rman_util.validate_current_controlfile`\. - -This procedure uses the following common parameter for RMAN tasks: -+ `p_validation_type` -+ `p_rman_to_dbms_output` - -For more information, see [Common parameters for RMAN procedures](#Appendix.Oracle.CommonDBATasks.CommonParameters)\. - -### Validating an SPFILE - -To validate only the server parameter file \(SPFILE\) used by an Amazon RDS Oracle DB instance, use the Amazon RDS procedure `rdsadmin.rdsadmin_rman_util.validate_spfile`\. - -This procedure uses the following common parameter for RMAN tasks: -+ `p_validation_type` -+ `p_rman_to_dbms_output` - -For more information, see [Common parameters for RMAN procedures](#Appendix.Oracle.CommonDBATasks.CommonParameters)\. - -### Validating a data file - -To validate a data file, use the Amazon RDS procedure `rdsadmin.rdsadmin_rman_util.validate_datafile`\. - -This procedure uses the following common parameters for RMAN tasks: -+ `p_validation_type` -+ `p_parallel` -+ `p_section_size_mb` -+ `p_rman_to_dbms_output` - -For more information, see [Common parameters for RMAN procedures](#Appendix.Oracle.CommonDBATasks.CommonParameters)\. - -This procedure also uses the following additional parameters\. - - -**** - -| Parameter name | Data type | Valid values | Default | Required | Description | -| --- | --- | --- | --- | --- | --- | -| `p_datafile` | varchar2 | A valid datafile ID number or a valid datafile name including complete path | — | Yes | The datafile ID number \(from `v$datafile.file#`\) or the full datafile name including the path \(from `v$datafile.name`\)\. | -| `p_from_block` | number | A valid integer | `NULL` | No | The number of the block where the validation starts within the data file\. When this is `NULL`, `1` is used\. | -| `p_to_block` | number | A valid integer | `NULL` | No | The number of the block where the validation ends within the data file\. When this is `NULL`, the maximum block in the data file is used\. | - -## Enabling and disabling block change tracking - -Block changing tracking records changed blocks in a tracking file\. This technique can improve the performance of RMAN incremental backups\. For more information, see [Using Block Change Tracking to Improve Incremental Backup Performance](https://docs.oracle.com/en/database/oracle/oracle-database/19/bradv/backing-up-database.html#GUID-4E1F605A-76A7-48D0-9D9B-7343B4327E2A) in the Oracle Database documentation\. - -To enable block change tracking for a DB instance, use the Amazon RDS procedure `rdsadmin.rdsadmin_rman_util.enable_block_change_tracking`\. To disable block change tracking, use `disable_block_change_tracking`\. These procedures take no parameters\. - -Read\-only replicas support block change tracking\. If you create a read\-only replica from a source DB that uses block change tracking, the replica uses block change tracking\. You can't enable block change tracking on a mounted replica\. If you place a mounted replica in read\-only mode, block change tracking isn't enabled, but you can enable it using `enable_block_change_tracking`\. If you promote an Oracle replica to a source DB, you can use block change tracking just as for any other Oracle DB instance\. - -Block change tracking procedures are supported for the following DB engine versions: -+ Oracle Database 21c \(21\.0\.0\) -+ Oracle Database 19c \(19\.0\.0\) -+ Oracle Database 12c Release 2 \(12\.2\), using 12\.2\.0\.1\.ru\-2019\-01\.rur\-2019\-01\.r1 or higher -+ Oracle Database 12c Release 1 \(12\.1\), using 12\.1\.0\.2\.v15 or higher - -**Note** -In a single\-tenant CDB, the following operations work, but no customer\-visible mechanism can detect the current status of the operations\. See also [Limitations of a single\-tenant CDB](Oracle.Concepts.limitations.md#Oracle.Concepts.single-tenant-limitations)\. - -To determine whether block change tracking is enabled for your DB instance, run the following query\. - -``` -SELECT STATUS, FILENAME FROM V$BLOCK_CHANGE_TRACKING; -``` - -The following example enables block change tracking for a DB instance\. - -``` -EXEC rdsadmin.rdsadmin_rman_util.enable_block_change_tracking; -``` - -The following example disables block change tracking for a DB instance\. - -``` -EXEC rdsadmin.rdsadmin_rman_util.disable_block_change_tracking; -``` - -## Crosschecking archived redo logs - -You can crosscheck archived redo logs using the Amazon RDS procedure `rdsadmin.rdsadmin_rman_util.crosscheck_archivelog`\. - -You can use this procedure to crosscheck the archived redo logs registered in the control file and optionally delete the expired logs records\. When RMAN makes a backup, it creates a record in the control file\. Over time, these records increase the size of the control file\. We recommend that you remove expired records periodically\. - -**Note** -Standard Amazon RDS backups don't use RMAN and therefore don't create records in the control file\. - -This procedure uses the common parameter `p_rman_to_dbms_output` for RMAN tasks\. - -For more information, see [Common parameters for RMAN procedures](#Appendix.Oracle.CommonDBATasks.CommonParameters)\. - -This procedure also uses the following additional parameter\. - - -**** - -| Parameter name | Data type | Valid values | Default | Required | Description | -| --- | --- | --- | --- | --- | --- | -| `p_delete_expired` | boolean | `TRUE`, `FALSE` | `TRUE` | No | When `TRUE`, delete expired archived redo log records from the control file\. When `FALSE`, retain the expired archived redo log records in the control file\. | - -This procedure is supported for the following Amazon RDS for Oracle DB engine versions: -+ Oracle Database 21c \(21\.0\.0\) -+ Oracle Database 19c \(19\.0\.0\) -+ Oracle Database 12c Release 2 \(12\.2\), using 12\.2\.0\.1\.ru\-2019\-01\.rur\-2019\-01\.r1 or higher -+ Oracle Database 12c Release 1 \(12\.1\), using 12\.1\.0\.2\.v15 or higher - -The following example marks archived redo log records in the control file as expired, but does not delete the records\. - -``` -BEGIN - rdsadmin.rdsadmin_rman_util.crosscheck_archivelog( - p_delete_expired => FALSE, - p_rman_to_dbms_output => FALSE); -END; -/ -``` - -The following example deletes expired archived redo log records from the control file\. - -``` -BEGIN - rdsadmin.rdsadmin_rman_util.crosscheck_archivelog( - p_delete_expired => TRUE, - p_rman_to_dbms_output => FALSE); -END; -/ -``` - -## Backing up archived redo logs - -You can use the Amazon RDS package `rdsadmin.rdsadmin_rman_util` to back up archived redo logs for an Amazon RDS Oracle DB instance\. - -The procedures for backing up archived redo logs are supported for the following Amazon RDS for Oracle DB engine versions: -+ Oracle Database 21c \(21\.0\.0\) -+ Oracle Database 19c \(19\.0\.0\) -+ Oracle Database 12c Release 2 \(12\.2\), using 12\.2\.0\.1\.ru\-2019\-01\.rur\-2019\-01\.r1 or higher -+ Oracle Database 12c Release 1 \(12\.1\), using 12\.1\.0\.2\.v15 or higher - -**Topics** -+ [Backing up all archived redo logs](#Appendix.Oracle.CommonDBATasks.BackupArchivedLogs.All) -+ [Backing up an archived redo log from a date range](#Appendix.Oracle.CommonDBATasks.BackupArchivedLogs.Date) -+ [Backing up an archived redo log from an SCN range](#Appendix.Oracle.CommonDBATasks.BackupArchivedLogs.SCN) -+ [Backing up an archived redo log from a sequence number range](#Appendix.Oracle.CommonDBATasks.BackupArchivedLogs.Sequence) - -### Backing up all archived redo logs - -To back up all of the archived redo logs for an Amazon RDS Oracle DB instance, use the Amazon RDS procedure `rdsadmin.rdsadmin_rman_util.backup_archivelog_all`\. - -This procedure uses the following common parameters for RMAN tasks: -+ `p_owner` -+ `p_directory_name` -+ `p_label` -+ `p_parallel` -+ `p_compress` -+ `p_rman_to_dbms_output` -+ `p_tag` - -For more information, see [Common parameters for RMAN procedures](#Appendix.Oracle.CommonDBATasks.CommonParameters)\. - -The following example backs up all archived redo logs for the DB instance\. - -``` -BEGIN - rdsadmin.rdsadmin_rman_util.backup_archivelog_all( - p_owner => 'SYS', - p_directory_name => 'MYDIRECTORY', - p_parallel => 4, - p_tag => 'MY_LOG_BACKUP', - p_rman_to_dbms_output => FALSE); -END; -/ -``` - -### Backing up an archived redo log from a date range - -To back up specific archived redo logs for an Amazon RDS Oracle DB instance by specifying a date range, use the Amazon RDS procedure `rdsadmin.rdsadmin_rman_util.backup_archivelog_date`\. The date range specifies which archived redo logs to back up\. - -This procedure uses the following common parameters for RMAN tasks: -+ `p_owner` -+ `p_directory_name` -+ `p_label` -+ `p_parallel` -+ `p_compress` -+ `p_rman_to_dbms_output` -+ `p_tag` - -For more information, see [Common parameters for RMAN procedures](#Appendix.Oracle.CommonDBATasks.CommonParameters)\. - -This procedure also uses the following additional parameters\. - - -**** - -| Parameter name | Data type | Valid values | Default | Required | Description | -| --- | --- | --- | --- | --- | --- | -| `p_from_date` | date | A date that is between the `start_date` and `next_date` of an archived redo log that exists on disk\. The value must be less than or equal to the value specified for `p_to_date`\. | — | Yes | The starting date for the archived log backups\. | -| `p_to_date` | date | A date that is between the `start_date` and `next_date` of an archived redo log that exists on disk\. The value must be greater than or equal to the value specified for `p_from_date`\. | — | Yes | The ending date for the archived log backups\. | - -The following example backs up archived redo logs in the date range for the DB instance\. - -``` -BEGIN - rdsadmin.rdsadmin_rman_util.backup_archivelog_date( - p_owner => 'SYS', - p_directory_name => 'MYDIRECTORY', - p_from_date => '03/01/2019 00:00:00', - p_to_date => '03/02/2019 00:00:00', - p_parallel => 4, - p_tag => 'MY_LOG_BACKUP', - p_rman_to_dbms_output => FALSE); -END; -/ -``` - -### Backing up an archived redo log from an SCN range - -To back up specific archived redo logs for an Amazon RDS Oracle DB instance by specifying a system change number \(SCN\) range, use the Amazon RDS procedure `rdsadmin.rdsadmin_rman_util.backup_archivelog_scn`\. The SCN range specifies which archived redo logs to back up\. - -This procedure uses the following common parameters for RMAN tasks: -+ `p_owner` -+ `p_directory_name` -+ `p_label` -+ `p_parallel` -+ `p_compress` -+ `p_rman_to_dbms_output` -+ `p_tag` - -For more information, see [Common parameters for RMAN procedures](#Appendix.Oracle.CommonDBATasks.CommonParameters)\. - -This procedure also uses the following additional parameters\. - - -**** - -| Parameter name | Data type | Valid values | Default | Required | Description | -| --- | --- | --- | --- | --- | --- | -| `p_from_scn` | number | An SCN of an archived redo log that exists on disk\. The value must be less than or equal to the value specified for `p_to_scn`\. | — | Yes | The starting SCN for the archived log backups\. | -| `p_to_scn` | number | An SCN of an archived redo log that exists on disk\. The value must be greater than or equal to the value specified for `p_from_scn`\. | — | Yes | The ending SCN for the archived log backups\. | - -The following example backs up archived redo logs in the SCN range for the DB instance\. - -``` -BEGIN - rdsadmin.rdsadmin_rman_util.backup_archivelog_scn( - p_owner => 'SYS', - p_directory_name => 'MYDIRECTORY', - p_from_scn => 1533835, - p_to_scn => 1892447, - p_parallel => 4, - p_tag => 'MY_LOG_BACKUP', - p_rman_to_dbms_output => FALSE); -END; -/ -``` - -### Backing up an archived redo log from a sequence number range - -To back up specific archived redo logs for an Amazon RDS Oracle DB instance by specifying a sequence number range, use the Amazon RDS procedure `rdsadmin.rdsadmin_rman_util.backup_archivelog_sequence`\. The sequence number range specifies which archived redo logs to back up\. - -This procedure uses the following common parameters for RMAN tasks: -+ `p_owner` -+ `p_directory_name` -+ `p_label` -+ `p_parallel` -+ `p_compress` -+ `p_rman_to_dbms_output` -+ `p_tag` - -For more information, see [Common parameters for RMAN procedures](#Appendix.Oracle.CommonDBATasks.CommonParameters)\. - -This procedure also uses the following additional parameters\. - - -**** - -| Parameter name | Data type | Valid values | Default | Required | Description | -| --- | --- | --- | --- | --- | --- | -| `p_from_sequence` | number | A sequence number an archived redo log that exists on disk\. The value must be less than or equal to the value specified for `p_to_sequence`\. | — | Yes | The starting sequence number for the archived log backups\. | -| `p_to_sequence` | number | A sequence number of an archived redo log that exists on disk\. The value must be greater than or equal to the value specified for `p_from_sequence`\. | — | Yes | The ending sequence number for the archived log backups\. | - -The following example backs up archived redo logs in the sequence number range for the DB instance\. - -``` -BEGIN - rdsadmin.rdsadmin_rman_util.backup_archivelog_sequence( - p_owner => 'SYS', - p_directory_name => 'MYDIRECTORY', - p_from_sequence => 11160, - p_to_sequence => 11160, - p_parallel => 4, - p_tag => 'MY_LOG_BACKUP', - p_rman_to_dbms_output => FALSE); -END; -/ -``` - -## Performing a full database backup - -You can perform a backup of all blocks of data files included in the backup using Amazon RDS procedure `rdsadmin.rdsadmin_rman_util.backup_database_full`\. - -This procedure uses the following common parameters for RMAN tasks: -+ `p_owner` -+ `p_directory_name` -+ `p_label` -+ `p_parallel` -+ `p_section_size_mb` -+ `p_include_archive_logs` -+ `p_optimize` -+ `p_compress` -+ `p_rman_to_dbms_output` -+ `p_tag` - -For more information, see [Common parameters for RMAN procedures](#Appendix.Oracle.CommonDBATasks.CommonParameters)\. - -This procedure is supported for the following Amazon RDS for Oracle DB engine versions: -+ Oracle Database 21c \(21\.0\.0\) -+ Oracle Database 19c \(19\.0\.0\) -+ Oracle Database 12c Release 2 \(12\.2\), using 12\.2\.0\.1\.ru\-2019\-01\.rur\-2019\-01\.r1 or higher -+ Oracle Database 12c Release 1 \(12\.1\), using 12\.1\.0\.2\.v15 or higher - -The following example performs a full backup of the DB instance using the specified values for the parameters\. - -``` -BEGIN - rdsadmin.rdsadmin_rman_util.backup_database_full( - p_owner => 'SYS', - p_directory_name => 'MYDIRECTORY', - p_parallel => 4, - p_section_size_mb => 10, - p_tag => 'FULL_DB_BACKUP', - p_rman_to_dbms_output => FALSE); -END; -/ -``` - -## Performing an incremental database backup - -You can perform an incremental backup of your DB instance using the Amazon RDS procedure `rdsadmin.rdsadmin_rman_util.backup_database_incremental`\. - -For more information about incremental backups, see [Incremental backups](https://docs.oracle.com/database/121/RCMRF/rcmsynta006.htm#GUID-73642FF2-43C5-48B2-9969-99001C52EB50__BGBHABHH) in the Oracle documentation\. - -This procedure uses the following common parameters for RMAN tasks: -+ `p_owner` -+ `p_directory_name` -+ `p_label` -+ `p_parallel` -+ `p_section_size_mb` -+ `p_include_archive_logs` -+ `p_include_controlfile` -+ `p_optimize` -+ `p_compress` -+ `p_rman_to_dbms_output` -+ `p_tag` - -For more information, see [Common parameters for RMAN procedures](#Appendix.Oracle.CommonDBATasks.CommonParameters)\. - -This procedure is supported for the following Amazon RDS for Oracle DB engine versions: -+ Oracle Database 21c \(21\.0\.0\) -+ Oracle Database 19c \(19\.0\.0\) -+ Oracle Database 12c Release 2 \(12\.2\), using 12\.2\.0\.1\.ru\-2019\-01\.rur\-2019\-01\.r1 or higher -+ Oracle Database 12c Release 1 \(12\.1\), using 12\.1\.0\.2\.v15 or higher - -This procedure also uses the following additional parameter\. - - -**** - -| Parameter name | Data type | Valid values | Default | Required | Description | -| --- | --- | --- | --- | --- | --- | -| `p_level` | number | `0`, `1` | `0` | No | Specify `0` to enable a full incremental backup\. Specify `1` to enable a non\-cumulative incremental backup\. | - -The following example performs an incremental backup of the DB instance using the specified values for the parameters\. - -``` -BEGIN - rdsadmin.rdsadmin_rman_util.backup_database_incremental( - p_owner => 'SYS', - p_directory_name => 'MYDIRECTORY', - p_level => 1, - p_parallel => 4, - p_section_size_mb => 10, - p_tag => 'MY_INCREMENTAL_BACKUP', - p_rman_to_dbms_output => FALSE); -END; -/ -``` - -## Backing up a tablespace - -You can back up a tablespace using the Amazon RDS procedure `rdsadmin.rdsadmin_rman_util.backup_tablespace`\. - -This procedure uses the following common parameters for RMAN tasks: -+ `p_owner` -+ `p_directory_name` -+ `p_label` -+ `p_parallel` -+ `p_section_size_mb` -+ `p_include_archive_logs` -+ `p_include_controlfile` -+ `p_optimize` -+ `p_compress` -+ `p_rman_to_dbms_output` -+ `p_tag` - -For more information, see [Common parameters for RMAN procedures](#Appendix.Oracle.CommonDBATasks.CommonParameters)\. - -This procedure also uses the following additional parameter\. - - -**** - -| Parameter name | Data type | Valid values | Default | Required | Description | -| --- | --- | --- | --- | --- | --- | -| `p_tablespace_name` | varchar2 | A valid tablespace name\. | — | Yes | The name of the tablespace to back up\. | - -This procedure is supported for the following Amazon RDS for Oracle DB engine versions: -+ Oracle Database 21c \(21\.0\.0\) -+ Oracle Database 19c \(19\.0\.0\) -+ Oracle Database 12c Release 2 \(12\.2\), using 12\.2\.0\.1\.ru\-2019\-01\.rur\-2019\-01\.r1 or higher -+ Oracle Database 12c Release 1 \(12\.1\), using 12\.1\.0\.2\.v15 or higher - -The following example performs a tablespace backup using the specified values for the parameters\. - -``` -BEGIN - rdsadmin.rdsadmin_rman_util.backup_tablespace( - p_owner => 'SYS', - p_directory_name => 'MYDIRECTORY', - p_tablespace_name => MYTABLESPACE, - p_parallel => 4, - p_section_size_mb => 10, - p_tag => 'MYTABLESPACE_BACKUP', - p_rman_to_dbms_output => FALSE); -END; -/ -``` - -## Backing up a control file - -You can back up a control file using the Amazon RDS procedure `rdsadmin.rdsadmin_rman_util.backup_current_controlfile`\. - -This procedure uses the following common parameters for RMAN tasks: -+ `p_owner` -+ `p_directory_name` -+ `p_label` -+ `p_compress` -+ `p_rman_to_dbms_output` -+ `p_tag` - -For more information, see [Common parameters for RMAN procedures](#Appendix.Oracle.CommonDBATasks.CommonParameters)\. - -This procedure is supported for the following Amazon RDS for Oracle DB engine versions: -+ Oracle Database 21c \(21\.0\.0\) -+ Oracle Database 19c \(19\.0\.0\) -+ Oracle Database 12c Release 2 \(12\.2\), using 12\.2\.0\.1\.ru\-2019\-01\.rur\-2019\-01\.r1 or higher -+ Oracle Database 12c Release 1 \(12\.1\), using 12\.1\.0\.2\.v15 or higher - -The following example backs up a control file using the specified values for the parameters\. - -``` -BEGIN - rdsadmin.rdsadmin_rman_util.backup_current_controlfile( - p_owner => 'SYS', - p_directory_name => 'MYDIRECTORY', - p_tag => 'CONTROL_FILE_BACKUP', - p_rman_to_dbms_output => FALSE); -END; -/ -``` \ No newline at end of file diff --git a/doc_source/Appendix.Oracle.CommonDBATasks.Scheduler.md b/doc_source/Appendix.Oracle.CommonDBATasks.Scheduler.md deleted file mode 100644 index 440d68e..0000000 --- a/doc_source/Appendix.Oracle.CommonDBATasks.Scheduler.md +++ /dev/null @@ -1,278 +0,0 @@ -# Performing common scheduling tasks for Oracle DB instances - -Some scheduler jobs owned by `SYS` can interfere with normal database operations\. Oracle Support recommends you disable these jobs or modify the schedule\. To perform tasks for Oracle Scheduler jobs owned by `SYS`, use the Amazon RDS package `rdsadmin.rdsadmin_dbms_scheduler`\. - -The `rdsadmin.rdsadmin_dbms_scheduler` procedures are supported for the following Amazon RDS for Oracle DB engine versions: -+ Oracle Database 21c \(21\.0\.0\) -+ Oracle Database 19c -+ Oracle Database 12c Release 2 \(12\.2\) on 12\.2\.0\.2\.ru\-2019\-07\.rur\-2019\-07\.r1 or higher 12\.2 versions -+ Oracle Database 12c Release 1 \(12\.1\) on 12\.1\.0\.2\.v17 or higher 12\.1 versions - -## Common parameters for Oracle Scheduler procedures - -To perform tasks with Oracle Scheduler, use procedures in the Amazon RDS package `rdsadmin.rdsadmin_dbms_scheduler`\. Several parameters are common to the procedures in the package\. The package has the following common parameters\. - - -**** - -| Parameter name | Data type | Valid values | Default | Required | Description | -| --- | --- | --- | --- | --- | --- | -| `name` | varchar2 | `'SYS.BSLN_MAINTAIN_STATS_JOB'`,`'SYS.CLEANUP_ONLINE_IND_BUILD'` | — | Yes | The name of the job to modify\. Currently, you can only modify `SYS.CLEANUP_ONLINE_IND_BUILD` and `SYS.BSLN_MAINTAIN_STATS_JOB` jobs\. | -| `attribute` | varchar2 | `'REPEAT_INTERVAL'`,`'SCHEDULE_NAME'` | – | Yes | Attribute to modify\. To modify the repeat interval for the job, specify `'REPEAT_INTERVAL'`\. To modify the schedule name for the job, specify `'SCHEDULE_NAME'`\. | -| `value` | varchar2 | A valid schedule interval or schedule name, depending on attribute used\. | – | Yes | The new value of the attribute\. | - -## Modifying DBMS\_SCHEDULER jobs - -To modify certain components of Oracle Scheduler, use the Oracle procedure `dbms_scheduler.set_attribute`\. For more information, see [DBMS\_SCHEDULER](https://docs.oracle.com/database/121/ARPLS/d_sched.htm#ARPLS72235) and [SET\_ATTRIBUTE procedure](https://docs.oracle.com/database/121/ARPLS/d_sched.htm#ARPLS72399) in the Oracle documentation\. - -When working with Amazon RDS DB instances, prepend the schema name `SYS` to the object name\. The following example sets the resource plan attribute for the Monday window object\. - -``` -BEGIN - DBMS_SCHEDULER.SET_ATTRIBUTE( - name => 'SYS.MONDAY_WINDOW', - attribute => 'RESOURCE_PLAN', - value => 'resource_plan_1'); -END; -/ -``` - -## Modifying AutoTask maintenance windows - -Amazon RDS for Oracle instances are created with default settings for maintenance windows\. Automated maintenance tasks such as optimizer statistics collection run during these windows\. By default, the maintenance windows turn on Oracle Database Resource Manager\. - -To modify the window, use the `DBMS_SCHEDULER` package\. You might need to modify the maintenance window settings for the following reasons: -+ You want maintenance jobs to run at a different time, with different settings, or not at all\. For example, might want to modify the window duration, or change the repeat time and interval\. -+ You want to avoid the performance impact of enabling Resource Manager during maintenance\. For example, if the default maintenance plan is specified, and if the maintenance window opens while the database is under load, you might see wait events such as `resmgr:cpu quantum`\. This wait event is related to Database Resource Manager\. You have the following options: - + Ensure that maintenance windows are active during off\-peak times for your DB instance\. - + Disable the default maintenance plan by setting the `resource_plan` attribute to an empty string\. - + Set the `resource_manager_plan` parameter to `FORCE:` in your parameter group\. If your instance uses Enterprise Edition, this setting prevents Database Resource Manager plans from activating\. - -**To modify your maintenance window settings** - -1. Connect to your database using an Oracle SQL client\. - -1. Query the current configuration for a scheduler window\. - - The following example queries the configuration for `MONDAY_WINDOW`\. - - ``` - SELECT ENABLED, RESOURCE_PLAN, DURATION, REPEAT_INTERVAL - FROM DBA_SCHEDULER_WINDOWS - WHERE WINDOW_NAME='MONDAY_WINDOW'; - ``` - - The following output shows that the window is using the default values\. - - ``` - ENABLED RESOURCE_PLAN DURATION REPEAT_INTERVAL - --------------- ------------------------------ ---------------- ------------------------------ - TRUE DEFAULT_MAINTENANCE_PLAN +000 04:00:00 freq=daily;byday=MON;byhour=22 - ;byminute=0; bysecond=0 - ``` - -1. Modify the window using the `DBMS_SCHEDULER` package\. - - The following example sets the resource plan to null so that the Resource Manager won't run during the maintenance window\. - - ``` - BEGIN - -- disable the window to make changes - DBMS_SCHEDULER.DISABLE(name=>'"SYS"."MONDAY_WINDOW"',force=>TRUE); - - -- specify the empty string to use no plan - DBMS_SCHEDULER.SET_ATTRIBUTE(name=>'"SYS"."MONDAY_WINDOW"', attribute=>'RESOURCE_PLAN', value=>''); - - -- re-enable the window - DBMS_SCHEDULER.ENABLE(name=>'"SYS"."MONDAY_WINDOW"'); - END; - / - ``` - - The following example sets the maximum duration of the window to 2 hours\. - - ``` - BEGIN - DBMS_SCHEDULER.DISABLE(name=>'"SYS"."MONDAY_WINDOW"',force=>TRUE); - DBMS_SCHEDULER.SET_ATTRIBUTE(name=>'"SYS"."MONDAY_WINDOW"', attribute=>'DURATION', value=>'0 2:00:00'); - DBMS_SCHEDULER.ENABLE(name=>'"SYS"."MONDAY_WINDOW"'); - END; - / - ``` - - The following example sets the repeat interval to every Monday at 10 AM\. - - ``` - BEGIN - DBMS_SCHEDULER.DISABLE(name=>'"SYS"."MONDAY_WINDOW"',force=>TRUE); - DBMS_SCHEDULER.SET_ATTRIBUTE(name=>'"SYS"."MONDAY_WINDOW"', attribute=>'REPEAT_INTERVAL', value=>'freq=daily;byday=MON;byhour=10;byminute=0;bysecond=0'); - DBMS_SCHEDULER.ENABLE(name=>'"SYS"."MONDAY_WINDOW"'); - END; - / - ``` - -## Setting the time zone for Oracle Scheduler jobs - -To modify the time zone for Oracle Scheduler, you can use the Oracle procedure `dbms_scheduler.set_scheduler_attribute`\. For more information about the `dbms_scheduler` package, see [DBMS\_SCHEDULER](https://docs.oracle.com/en/database/oracle/oracle-database/19/arpls/DBMS_SCHEDULER.html) and [SET\_SCHEDULER\_ATTRIBUTE](https://docs.oracle.com/en/database/oracle/oracle-database/19/arpls/DBMS_SCHEDULER.html#GUID-2AB97BF7-7154-4E6C-933F-B2659B18A907) in the Oracle documentation\. - -**To modify the current time zone setting** - -1. Connect to the database using a client such as SQL Developer\. For more information, see [Connecting to your DB instance using Oracle SQL developer](USER_ConnectToOracleInstance.SQLDeveloper.md)\. - -1. Set the default time zone as following, substituting your time zone for `time_zone_name`\. - - ``` - BEGIN - DBMS_SCHEDULER.SET_SCHEDULER_ATTRIBUTE( - attribute => 'default_timezone', - value => 'time_zone_name' - ); - END; - / - ``` - -In the following example, you change the time zone to Asia/Shanghai\. - -Start by querying the current time zone, as shown following\. - -``` -SELECT VALUE FROM DBA_SCHEDULER_GLOBAL_ATTRIBUTE WHERE ATTRIBUTE_NAME='DEFAULT_TIMEZONE'; -``` - -The output shows that the current time zone is ETC/UTC\. - -``` -VALUE -------- -Etc/UTC -``` - -Then you set the time zone to Asia/Shanghai\. - -``` -BEGIN - DBMS_SCHEDULER.SET_SCHEDULER_ATTRIBUTE( - attribute => 'default_timezone', - value => 'Asia/Shanghai' - ); -END; -/ -``` - -For more information about changing the system time zone, see [Oracle time zone](Appendix.Oracle.Options.Timezone.md)\. - -## Turning off Oracle Scheduler jobs owned by SYS - -To disable an Oracle Scheduler job owned by the SYS user, use the `rdsadmin.rdsadmin_dbms_scheduler.disable` procedure\. - -This procedure uses the `name` common parameter for Oracle Scheduler tasks\. For more information, see [Common parameters for Oracle Scheduler procedures](#Appendix.Oracle.CommonDBATasks.Scheduler.CommonParameters)\. - -The following example disables the `SYS.CLEANUP_ONLINE_IND_BUILD` Oracle Scheduler job\. - -``` -BEGIN - rdsadmin.rdsadmin_dbms_scheduler.disable('SYS.CLEANUP_ONLINE_IND_BUILD'); -END; -/ -``` - -## Turning on Oracle Scheduler jobs owned by SYS - -To turn on an Oracle Scheduler job owned by SYS, use the `rdsadmin.rdsadmin_dbms_scheduler.enable` procedure\. - -This procedure uses the `name` common parameter for Oracle Scheduler tasks\. For more information, see [Common parameters for Oracle Scheduler procedures](#Appendix.Oracle.CommonDBATasks.Scheduler.CommonParameters)\. - -The following example enables the `SYS.CLEANUP_ONLINE_IND_BUILD` Oracle Scheduler job\. - -``` -BEGIN - rdsadmin.rdsadmin_dbms_scheduler.enable('SYS.CLEANUP_ONLINE_IND_BUILD'); -END; -/ -``` - -## Modifying the Oracle Scheduler repeat interval for jobs of CALENDAR type - -To modify the repeat interval to modify a SYS\-owned Oracle Scheduler job of `CALENDAR` type, use the `rdsadmin.rdsadmin_dbms_scheduler.disable` procedure\. - -This procedure uses the following common parameters for Oracle Scheduler tasks: -+ `name` -+ `attribute` -+ `value` - -For more information, see [Common parameters for Oracle Scheduler procedures](#Appendix.Oracle.CommonDBATasks.Scheduler.CommonParameters)\. - -The following example modifies the repeat interval of the `SYS.CLEANUP_ONLINE_IND_BUILD` Oracle Scheduler job\. - -``` -BEGIN - rdsadmin.rdsadmin_dbms_scheduler.set_attribute( - name => 'SYS.CLEANUP_ONLINE_IND_BUILD', - attribute => 'repeat_interval', - value => 'freq=daily;byday=FRI,SAT;byhour=20;byminute=0;bysecond=0'); -END; -/ -``` - -## Modifying the Oracle Scheduler repeat interval for jobs of NAMED type - -Some Oracle Scheduler jobs use a schedule name instead of an interval\. For this type of jobs, you must create a new named schedule in the master user schema\. Use the standard Oracle `sys.dbms_scheduler.create_schedule` procedure to do this\. Also, use the `rdsadmin.rdsadmin_dbms_scheduler.set_attribute procedure` to assign the new named schedule to the job\. - -This procedure uses the following common parameter for Oracle Scheduler tasks: -+ `name` -+ `attribute` -+ `value` - -For more information, see [Common parameters for Oracle Scheduler procedures](#Appendix.Oracle.CommonDBATasks.Scheduler.CommonParameters)\. - -The following example modifies the repeat interval of the `SYS.BSLN_MAINTAIN_STATS_JOB` Oracle Scheduler job\. - -``` -BEGIN - DBMS_SCHEDULER.CREATE_SCHEDULE ( - schedule_name => 'rds_master_user.new_schedule', - start_date => SYSTIMESTAMP, - repeat_interval => 'freq=daily;byday=MON,TUE,WED,THU,FRI;byhour=0;byminute=0;bysecond=0', - end_date => NULL, - comments => 'Repeats daily forever'); -END; -/ - -BEGIN - rdsadmin.rdsadmin_dbms_scheduler.set_attribute ( - name => 'SYS.BSLN_MAINTAIN_STATS_JOB', - attribute => 'schedule_name', - value => 'rds_master_user.new_schedule'); -END; -/ -``` - -## Turning off autocommit for Oracle Scheduler job creation - -When `DBMS_SCHEDULER.CREATE_JOB` creates Oracle Scheduler jobs, it creates the jobs immediately and commits the changes\. You might need to incorporate the creation of Oracle Scheduler jobs in the user transaction to do the following: -+ Roll back the Oracle Schedule job when the user transaction is rolled back\. -+ Create the Oracle Scheduler job when the main user transaction is committed\. - -You can use the procedure `rdsadmin.rdsadmin_dbms_scheduler.set_no_commit_flag` to turn on this behavior\. This procedure takes no parameters\. You can use this procedure in the following RDS for Oracle releases: -+ 21\.0\.0\.0\.ru\-2022\-07\.rur\-2022\-07\.r1 and higher -+ 19\.0\.0\.0\.ru\-2022\-07\.rur\-2022\-07\.r1 and higher - -The following example turns off autocommit for Oracle Scheduler, creates an Oracle Scheduler job, and then rolls back the transaction\. Because autocommit is turned off, the database also rolls back the creation of the Oracle Scheduler job\. - -``` -BEGIN - rdsadmin.rdsadmin_dbms_scheduler.set_no_commit_flag; - DBMS_SCHEDULER.CREATE_JOB(job_name => 'EMPTY_JOB', - job_type => 'PLSQL_BLOCK', - job_action => 'begin null; end;', - auto_drop => false); - ROLLBACK; -END; -/ - -PL/SQL procedure successfully completed. - -SELECT * FROM DBA_SCHEDULER_JOBS WHERE JOB_NAME='EMPTY_JOB'; - -no rows selected -``` \ No newline at end of file diff --git a/doc_source/Appendix.Oracle.CommonDBATasks.System.md b/doc_source/Appendix.Oracle.CommonDBATasks.System.md deleted file mode 100644 index 9cb153c..0000000 --- a/doc_source/Appendix.Oracle.CommonDBATasks.System.md +++ /dev/null @@ -1,612 +0,0 @@ -# Performing common system tasks for Oracle DB instances - -Following, you can find how to perform certain common DBA tasks related to the system on your Amazon RDS DB instances running Oracle\. To deliver a managed service experience, Amazon RDS doesn't provide shell access to DB instances, and restricts access to certain system procedures and tables that require advanced privileges\. - -**Topics** -+ [Disconnecting a session](#Appendix.Oracle.CommonDBATasks.DisconnectingSession) -+ [Terminating a session](#Appendix.Oracle.CommonDBATasks.KillingSession) -+ [Canceling a SQL statement in a session](#Appendix.Oracle.CommonDBATasks.CancellingSQL) -+ [Enabling and disabling restricted sessions](#Appendix.Oracle.CommonDBATasks.RestrictedSession) -+ [Flushing the shared pool](#Appendix.Oracle.CommonDBATasks.FlushingSharedPool) -+ [Flushing the buffer cache](#Appendix.Oracle.CommonDBATasks.FlushingBufferCache) -+ [Flushing the database smart flash cache](#Appendix.Oracle.CommonDBATasks.flushing-shared-pool) -+ [Granting SELECT or EXECUTE privileges to SYS objects](#Appendix.Oracle.CommonDBATasks.TransferPrivileges) -+ [Revoking SELECT or EXECUTE privileges on SYS objects](#Appendix.Oracle.CommonDBATasks.RevokePrivileges) -+ [Granting privileges to non\-master users](#Appendix.Oracle.CommonDBATasks.PermissionsNonMasters) -+ [Creating custom functions to verify passwords](#Appendix.Oracle.CommonDBATasks.CustomPassword) -+ [Setting up a custom DNS server](#Appendix.Oracle.CommonDBATasks.CustomDNS) -+ [Setting and unsetting system diagnostic events](#Appendix.Oracle.CommonDBATasks.SystemEvents) - -## Disconnecting a session - -To disconnect the current session by ending the dedicated server process, use the Amazon RDS procedure `rdsadmin.rdsadmin_util.disconnect`\. The `disconnect` procedure has the following parameters\. - - -**** - -| Parameter name | Data type | Default | Required | Description | -| --- | --- | --- | --- | --- | -| `sid` | number | — | Yes | The session identifier\. | -| `serial` | number | — | Yes | The serial number of the session\. | -| `method` | varchar | 'IMMEDIATE' | No | Valid values are `'IMMEDIATE'` or `'POST_TRANSACTION'`\. | - -The following example disconnects a session\. - -``` -begin - rdsadmin.rdsadmin_util.disconnect( - sid => sid, - serial => serial_number); -end; -/ -``` - -To get the session identifier and the session serial number, query the `V$SESSION` view\. The following example gets all sessions for the user `AWSUSER`\. - -``` -SELECT SID, SERIAL#, STATUS FROM V$SESSION WHERE USERNAME = 'AWSUSER'; -``` - -The database must be open to use this method\. For more information about disconnecting a session, see [ALTER SYSTEM](http://docs.oracle.com/cd/E11882_01/server.112/e41084/statements_2014.htm#SQLRF53166) in the Oracle documentation\. - -## Terminating a session - -To terminate a session, use the Amazon RDS procedure `rdsadmin.rdsadmin_util.kill`\. The `kill` procedure has the following parameters\. - - -**** - -| Parameter name | Data type | Default | Required | Description | -| --- | --- | --- | --- | --- | -| `sid` | number | — | Yes | The session identifier\. | -| `serial` | number | — | Yes | The serial number of the session\. | -| `method` | varchar | null | No | Valid values are `'IMMEDIATE'` or `'PROCESS'`\. If you specify `IMMEDIATE`, it has the same effect as running the following statement: 
ALTER SYSTEM KILL SESSION 'sid,serial#' IMMEDIATE
If you specify `PROCESS`, you terminate the processes associated with a session\. Only specify `PROCESS` if terminating the session using `IMMEDIATE` was unsuccessful\. | - -To get the session identifier and the session serial number, query the `V$SESSION` view\. The following example gets all sessions for the user *AWSUSER*\. - -``` -SELECT SID, SERIAL#, STATUS FROM V$SESSION WHERE USERNAME = 'AWSUSER'; -``` - -The following example terminates a session\. - -``` -BEGIN - rdsadmin.rdsadmin_util.kill( - sid => sid, - serial => serial_number, - method => 'IMMEDIATE'); -END; -/ -``` - -The following example terminates the processes associated with a session\. - -``` -BEGIN - rdsadmin.rdsadmin_util.kill( - sid => sid, - serial => serial_number, - method => 'PROCESS'); -END; -/ -``` - -## Canceling a SQL statement in a session - -To cancel a SQL statement in a session, use the Amazon RDS procedure `rdsadmin.rdsadmin_util.cancel`\. - -**Note** -This procedure is supported for Oracle Database 19c \(19\.0\.0\) and all higher major and minor versions of RDS for Oracle\. - -The `cancel` procedure has the following parameters\. - - -**** - -| Parameter name | Data type | Default | Required | Description | -| --- | --- | --- | --- | --- | -| `sid` | number | — | Yes | The session identifier\. | -| `serial` | number | — | Yes | The serial number of the session\. | -| `sql_id` | varchar2 | null | No | The SQL identifier of the SQL statement\. | - -The following example cancels a SQL statement in a session\. - -``` -begin - rdsadmin.rdsadmin_util.cancel( - sid => sid, - serial => serial_number, - sql_id => sql_id); -end; -/ -``` - -To get the session identifier, the session serial number, and the SQL identifier of a SQL statement, query the `V$SESSION` view\. The following example gets all sessions and SQL identifiers for the user `AWSUSER`\. - -``` -select SID, SERIAL#, SQL_ID, STATUS from V$SESSION where USERNAME = 'AWSUSER'; -``` - -## Enabling and disabling restricted sessions - -To enable and disable restricted sessions, use the Amazon RDS procedure `rdsadmin.rdsadmin_util.restricted_session`\. The `restricted_session` procedure has the following parameters\. - - -**** - -| Parameter name | Data type | Default | Yes | Description | -| --- | --- | --- | --- | --- | -| `p_enable` | boolean | true | No | Set to `true` to enable restricted sessions, `false` to disable restricted sessions\. | - -The following example shows how to enable and disable restricted sessions\. - -``` -/* Verify that the database is currently unrestricted. */ - -SELECT LOGINS FROM V$INSTANCE; - -LOGINS -------- -ALLOWED - -/* Enable restricted sessions */ - -EXEC rdsadmin.rdsadmin_util.restricted_session(p_enable => true); - - -/* Verify that the database is now restricted. */ - -SELECT LOGINS FROM V$INSTANCE; - -LOGINS ----------- -RESTRICTED - - -/* Disable restricted sessions */ - -EXEC rdsadmin.rdsadmin_util.restricted_session(p_enable => false); - - -/* Verify that the database is now unrestricted again. */ - -SELECT LOGINS FROM V$INSTANCE; - -LOGINS -------- -ALLOWED -``` - -## Flushing the shared pool - -To flush the shared pool, use the Amazon RDS procedure `rdsadmin.rdsadmin_util.flush_shared_pool`\. The `flush_shared_pool` procedure has no parameters\. - -The following example flushes the shared pool\. - -``` -EXEC rdsadmin.rdsadmin_util.flush_shared_pool; -``` - -## Flushing the buffer cache - -To flush the buffer cache, use the Amazon RDS procedure `rdsadmin.rdsadmin_util.flush_buffer_cache`\. The `flush_buffer_cache` procedure has no parameters\. - -The following example flushes the buffer cache\. - -``` -EXEC rdsadmin.rdsadmin_util.flush_buffer_cache; -``` - -## Flushing the database smart flash cache - -To flush the database smart flash cache, use the Amazon RDS procedure `rdsadmin.rdsadmin_util.flush_flash_cache`\. The `flush_flash_cache` procedure has no parameters\. The following example flushes the database smart flash cache\. - -``` -EXEC rdsadmin.rdsadmin_util.flush_flash_cache; -``` - -For more information about using the database smart flash cache with RDS for Oracle, see [Storing temporary data in an RDS for Oracle instance store](CHAP_Oracle.advanced-features.instance-store.md)\. - -## Granting SELECT or EXECUTE privileges to SYS objects - -Usually you transfer privileges by using roles, which can contain many objects\. To grant privileges to a single object, use the Amazon RDS procedure `rdsadmin.rdsadmin_util.grant_sys_object`\. The procedure grants only privileges that the master user has already been granted through a role or direct grant\. - -The `grant_sys_object` procedure has the following parameters\. - -**Important** -For all parameter values, use uppercase unless you created the user with a case\-sensitive identifier\. For example, if you run `CREATE USER myuser` or `CREATE USER MYUSER`, the data dictionary stores `MYUSER`\. However, if you use double quotes in `CREATE USER "MyUser"`, the data dictionary stores `MyUser`\. - - -**** - -| Parameter name | Data type | Default | Required | Description | -| --- | --- | --- | --- | --- | -| `p_obj_name` | varchar2 | — | Yes | The name of the object to grant privileges for\. The object can be a directory, function, package, procedure, sequence, table, or view\. Object names must be spelled exactly as they appear in `DBA_OBJECTS`\. Most system objects are defined in uppercase, so we recommend that you try that first\. | -| `p_grantee` | varchar2 | — | Yes | The name of the object to grant privileges to\. The object can be a schema or a role\. | -| `p_privilege` | varchar2 | null | Yes | — | -| `p_grant_option` | boolean | false | No | Set to `true` to use the with grant option\. The `p_grant_option` parameter is supported for 12\.1\.0\.2\.v4 and later, all 12\.2\.0\.1 versions, and all 19\.0\.0 versions\. | - -The following example grants select privileges on an object named `V_$SESSION` to a user named `USER1`\. - -``` -begin - rdsadmin.rdsadmin_util.grant_sys_object( - p_obj_name => 'V_$SESSION', - p_grantee => 'USER1', - p_privilege => 'SELECT'); -end; -/ -``` - -The following example grants select privileges on an object named `V_$SESSION` to a user named `USER1` with the grant option\. - -``` -begin - rdsadmin.rdsadmin_util.grant_sys_object( - p_obj_name => 'V_$SESSION', - p_grantee => 'USER1', - p_privilege => 'SELECT', - p_grant_option => true); -end; -/ -``` - -To be able to grant privileges on an object, your account must have those privileges granted to it directly with the grant option, or via a role granted using `with admin option`\. In the most common case, you may want to grant `SELECT` on a DBA view that has been granted to the `SELECT_CATALOG_ROLE` role\. If that role isn't already directly granted to your user using `with admin option`, then you can't transfer the privilege\. If you have the DBA privilege, then you can grant the role directly to another user\. - -The following example grants the `SELECT_CATALOG_ROLE` and `EXECUTE_CATALOG_ROLE` to `USER1`\. Since the `with admin option` is used, `USER1` can now grant access to SYS objects that have been granted to `SELECT_CATALOG_ROLE`\. - -``` -GRANT SELECT_CATALOG_ROLE TO USER1 WITH ADMIN OPTION; -GRANT EXECUTE_CATALOG_ROLE to USER1 WITH ADMIN OPTION; -``` - -Objects already granted to `PUBLIC` do not need to be re\-granted\. If you use the `grant_sys_object` procedure to re\-grant access, the procedure call succeeds\. - -## Revoking SELECT or EXECUTE privileges on SYS objects - -To revoke privileges on a single object, use the Amazon RDS procedure `rdsadmin.rdsadmin_util.revoke_sys_object`\. The procedure only revokes privileges that the master account has already been granted through a role or direct grant\. - -The `revoke_sys_object` procedure has the following parameters\. - - -**** - -| Parameter name | Data type | Default | Required | Description | -| --- | --- | --- | --- | --- | -| `p_obj_name` | varchar2 | — | Yes | The name of the object to revoke privileges for\. The object can be a directory, function, package, procedure, sequence, table, or view\. Object names must be spelled exactly as they appear in `DBA_OBJECTS`\. Most system objects are defined in upper case, so we recommend you try that first\. | -| `p_revokee` | varchar2 | — | Yes | The name of the object to revoke privileges for\. The object can be a schema or a role\. | -| `p_privilege` | varchar2 | null | Yes | — | - -The following example revokes select privileges on an object named `V_$SESSION` from a user named `USER1`\. - -``` -begin - rdsadmin.rdsadmin_util.revoke_sys_object( - p_obj_name => 'V_$SESSION', - p_revokee => 'USER1', - p_privilege => 'SELECT'); -end; -/ -``` - -## Granting privileges to non\-master users - -You can grant select privileges for many objects in the `SYS` schema by using the `SELECT_CATALOG_ROLE` role\. The `SELECT_CATALOG_ROLE` role gives users `SELECT` privileges on data dictionary views\. The following example grants the role `SELECT_CATALOG_ROLE` to a user named `user1`\. - -``` -GRANT SELECT_CATALOG_ROLE TO user1; -``` - -You can grant `EXECUTE` privileges for many objects in the `SYS` schema by using the `EXECUTE_CATALOG_ROLE` role\. The `EXECUTE_CATALOG_ROLE` role gives users `EXECUTE` privileges for packages and procedures in the data dictionary\. The following example grants the role `EXECUTE_CATALOG_ROLE` to a user named *user1*\. - -``` -GRANT EXECUTE_CATALOG_ROLE TO user1; -``` - -The following example gets the permissions that the roles `SELECT_CATALOG_ROLE` and `EXECUTE_CATALOG_ROLE` allow\. - -``` - SELECT * - FROM ROLE_TAB_PRIVS - WHERE ROLE IN ('SELECT_CATALOG_ROLE','EXECUTE_CATALOG_ROLE') -ORDER BY ROLE, TABLE_NAME ASC; -``` - -The following example creates a non\-master user named `user1`, grants the `CREATE SESSION` privilege, and grants the `SELECT` privilege on a database named *sh\.sales*\. - -``` -CREATE USER user1 IDENTIFIED BY PASSWORD; -GRANT CREATE SESSION TO user1; -GRANT SELECT ON sh.sales TO user1; -``` - -## Creating custom functions to verify passwords - -You can create a custom password verification function in the following ways: -+ To use standard verification logic, and to store your function in the `SYS` schema, use the `create_verify_function` procedure\. -+ To use custom verification logic, or to avoid storing your function in the `SYS` schema, use the `create_passthrough_verify_fcn` procedure\. - -### The create\_verify\_function procedure - -You can create a custom function to verify passwords by using the Amazon RDS procedure `rdsadmin.rdsadmin_password_verify.create_verify_function`\. The `create_verify_function` procedure is supported for version 12\.1\.0\.2\.v5 and all higher major and minor versions of RDS for Oracle\. - -The `create_verify_function` procedure has the following parameters\. - - -**** - -| Parameter name | Data type | Default | Required | Description | -| --- | --- | --- | --- | --- | -| `p_verify_function_name` | varchar2 | — | Yes | The name for your custom function\. This function is created for you in the SYS schema\. You assign this function to user profiles\. | -| `p_min_length` | number | 8 | No | The minimum number of characters required\. | -| `p_max_length` | number | 256 | No | The maximum number of characters allowed\. | -| `p_min_letters` | number | 1 | No | The minimum number of letters required\. | -| `p_min_uppercase` | number | 0 | No | The minimum number of uppercase letters required\. | -| `p_min_lowercase` | number | 0 | No | The minimum number of lowercase letters required\. | -| `p_min_digits` | number | 1 | No | The minimum number of digits required\. | -| `p_min_special` | number | 0 | No | The minimum number of special characters required\. | -| `p_min_different_chars` | number | 3 | No | The minimum number of different characters required between the old and new password\. | -| `p_disallow_username` | boolean | true | No | Set to `true` to disallow the user name in the password\. | -| `p_disallow_reverse` | boolean | true | No | Set to `true` to disallow the reverse of the user name in the password\. | -| `p_disallow_db_name` | boolean | true | No | Set to `true` to disallow the database or server name in the password\. | -| `p_disallow_simple_strings` | boolean | true | No | Set to `true` to disallow simple strings as the password\. | -| `p_disallow_whitespace` | boolean | false | No | Set to `true` to disallow white space characters in the password\. | -| `p_disallow_at_sign` | boolean | false | No | Set to `true` to disallow the @ character in the password\. | - -You can create multiple password verification functions\. - -There are restrictions on the name of your custom function\. Your custom function can't have the same name as an existing system object\. The name can be no more than 30 characters long\. Also, the name must include one of the following strings: `PASSWORD`, `VERIFY`, `COMPLEXITY`, `ENFORCE`, or `STRENGTH`\. - -The following example creates a function named `CUSTOM_PASSWORD_FUNCTION`\. The function requires that a password has at least 12 characters, 2 uppercase characters, 1 digit, and 1 special character, and that the password disallows the @ character\. - -``` -begin - rdsadmin.rdsadmin_password_verify.create_verify_function( - p_verify_function_name => 'CUSTOM_PASSWORD_FUNCTION', - p_min_length => 12, - p_min_uppercase => 2, - p_min_digits => 1, - p_min_special => 1, - p_disallow_at_sign => true); -end; -/ -``` - -To see the text of your verification function, query `DBA_SOURCE`\. The following example gets the text of a custom password function named `CUSTOM_PASSWORD_FUNCTION`\. - -``` -COL TEXT FORMAT a150 - - SELECT TEXT - FROM DBA_SOURCE - WHERE OWNER = 'SYS' - AND NAME = 'CUSTOM_PASSWORD_FUNCTION' -ORDER BY LINE; -``` - -To associate your verification function with a user profile, use `alter profile`\. The following example associates a verification function with the `DEFAULT` user profile\. - -``` -ALTER PROFILE DEFAULT LIMIT PASSWORD_VERIFY_FUNCTION CUSTOM_PASSWORD_FUNCTION; -``` - -To see what user profiles are associated with what verification functions, query `DBA_PROFILES`\. The following example gets the profiles that are associated with the custom verification function named `CUSTOM_PASSWORD_FUNCTION`\. - -``` -SELECT * FROM DBA_PROFILES WHERE RESOURCE_NAME = 'PASSWORD' AND LIMIT = 'CUSTOM_PASSWORD_FUNCTION'; - - -PROFILE RESOURCE_NAME RESOURCE LIMIT -------------------------- -------------------------------- -------- ------------------------ -DEFAULT PASSWORD_VERIFY_FUNCTION PASSWORD CUSTOM_PASSWORD_FUNCTION -``` - -The following example gets all profiles and the password verification functions that they are associated with\. - -``` -SELECT * FROM DBA_PROFILES WHERE RESOURCE_NAME = 'PASSWORD_VERIFY_FUNCTION'; - -PROFILE RESOURCE_NAME RESOURCE LIMIT -------------------------- -------------------------------- -------- ------------------------ -DEFAULT PASSWORD_VERIFY_FUNCTION PASSWORD CUSTOM_PASSWORD_FUNCTION -RDSADMIN PASSWORD_VERIFY_FUNCTION PASSWORD NULL -``` - -### The create\_passthrough\_verify\_fcn procedure - -The `create_passthrough_verify_fcn` procedure is supported for version 12\.1\.0\.2\.v7 and all higher major and minor versions of RDS for Oracle\. - -You can create a custom function to verify passwords by using the Amazon RDS procedure `rdsadmin.rdsadmin_password_verify.create_passthrough_verify_fcn`\. The `create_passthrough_verify_fcn` procedure has the following parameters\. - - -**** - -| Parameter name | Data type | Default | Required | Description | -| --- | --- | --- | --- | --- | -| `p_verify_function_name` | varchar2 | — | Yes | The name for your custom verification function\. This is a wrapper function that is created for you in the SYS schema, and it doesn't contain any verification logic\. You assign this function to user profiles\. | -| `p_target_owner` | varchar2 | — | Yes | The schema owner for your custom verification function\. | -| `p_target_function_name` | varchar2 | — | Yes | The name of your existing custom function that contains the verification logic\. Your custom function must return a boolean\. Your function should return `true` if the password is valid and `false` if the password is invalid\. | - -The following example creates a password verification function that uses the logic from the function named `PASSWORD_LOGIC_EXTRA_STRONG`\. - -``` -begin - rdsadmin.rdsadmin_password_verify.create_passthrough_verify_fcn( - p_verify_function_name => 'CUSTOM_PASSWORD_FUNCTION', - p_target_owner => 'TEST_USER', - p_target_function_name => 'PASSWORD_LOGIC_EXTRA_STRONG'); -end; -/ -``` - -To associate the verification function with a user profile, use `alter profile`\. The following example associates the verification function with the `DEFAULT` user profile\. - -``` -ALTER PROFILE DEFAULT LIMIT PASSWORD_VERIFY_FUNCTION CUSTOM_PASSWORD_FUNCTION; -``` - -## Setting up a custom DNS server - -Amazon RDS supports outbound network access on your DB instances running Oracle\. For more information about outbound network access, including prerequisites, see [Configuring UTL\_HTTP access using certificates and an Oracle wallet](Oracle.Concepts.ONA.md)\. - -Amazon RDS Oracle allows Domain Name Service \(DNS\) resolution from a custom DNS server owned by the customer\. You can resolve only fully qualified domain names from your Amazon RDS DB instance through your custom DNS server\. - -After you set up your custom DNS name server, it takes up to 30 minutes to propagate the changes to your DB instance\. After the changes are propagated to your DB instance, all outbound network traffic requiring a DNS lookup queries your DNS server over port 53\. - -To set up a custom DNS server for your Amazon RDS for Oracle DB instance, do the following: -+ From the DHCP options set attached to your virtual private cloud \(VPC\), set the `domain-name-servers` option to the IP address of your DNS name server\. For more information, see [DHCP options sets](https://docs.aws.amazon.com/vpc/latest/userguide/VPC_DHCP_Options.html)\. -**Note** -The `domain-name-servers` option accepts up to four values, but your Amazon RDS DB instance uses only the first value\. -+ Ensure that your DNS server can resolve all lookup queries, including public DNS names, Amazon EC2 private DNS names, and customer\-specific DNS names\. If the outbound network traffic contains any DNS lookups that your DNS server can't handle, your DNS server must have appropriate upstream DNS providers configured\. -+ Configure your DNS server to produce User Datagram Protocol \(UDP\) responses of 512 bytes or less\. -+ Configure your DNS server to produce Transmission Control Protocol \(TCP\) responses of 1024 bytes or less\. -+ Configure your DNS server to allow inbound traffic from your Amazon RDS DB instances over port 53\. If your DNS server is in an Amazon VPC, the VPC must have a security group that contains inbound rules that permit UDP and TCP traffic on port 53\. If your DNS server is not in an Amazon VPC, it must have appropriate firewall allow\-listing to permit UDP and TCP inbound traffic on port 53\. - - For more information, see [Security groups for your VPC](https://docs.aws.amazon.com/vpc/latest/userguide/VPC_SecurityGroups.html) and [Adding and removing rules](https://docs.aws.amazon.com/vpc/latest/userguide/VPC_SecurityGroups.html#AddRemoveRules)\. -+ Configure the VPC of your Amazon RDS DB instance to allow outbound traffic over port 53\. Your VPC must have a security group that contains outbound rules that allow UDP and TCP traffic on port 53\. - - For more information, see [Security groups for your VPC](https://docs.aws.amazon.com/vpc/latest/userguide/VPC_SecurityGroups.html) and [Adding and removing rules](https://docs.aws.amazon.com/vpc/latest/userguide/VPC_SecurityGroups.html#AddRemoveRules)\. -+ The routing path between the Amazon RDS DB instance and the DNS server has to be configured correctly to allow DNS traffic\. - + If the Amazon RDS DB instance and the DNS server are not in the same VPC, a peering connection has to be set up between them\. For more information, see [What is VPC peering?](https://docs.aws.amazon.com/vpc/latest/peering/Welcome.html) - -## Setting and unsetting system diagnostic events - -To set and unset diagnostic events at the session level, you can use the Oracle SQL statement `ALTER SESSION SET EVENTS`\. However, to set events at the system level you can't use Oracle SQL\. Instead, use the system event procedures in the `rdsadmin.rdsadmin_util` package\. The system event procedures are available in the following engine versions: -+ All Oracle Database 21c versions -+ 19\.0\.0\.0\.ru\-2020\-10\.rur\-2020\-10\.r1 and higher Oracle Database 19c versions - - For more information, see [Version 19\.0\.0\.0\.ru\-2020\-10\.rur\-2020\-10\.r1](https://docs.aws.amazon.com/AmazonRDS/latest/OracleReleaseNotes/oracle-version-19-0.html#oracle-version-RU-RUR.19.0.0.0.ru-2020-10.rur-2020-10.r1) in the *Amazon RDS for Oracle Release Notes*\. -+ 12\.2\.0\.1\.ru\-2020\-10\.rur\-2020\-10\.r1 and higher Oracle Database 12c Release 2 \(12\.2\.0\.1\) versions - - For more information, see [Version 12\.2\.0\.1\.ru\-2020\-10\.rur\-2020\-10\.r1](https://docs.aws.amazon.com/AmazonRDS/latest/OracleReleaseNotes/oracle-version-12-2.html#oracle-version-RU-RUR.12.2.0.1.ru-2020-10.rur-2020-10.r1) in the *Amazon RDS for Oracle Release Notes*\. -+ 12\.1\.0\.2\.V22 and higher Oracle Database 12c Release 1 \(12\.1\.0\.2\) versions - - For more information, see [Version 12\.1\.0\.2\.v22](https://docs.aws.amazon.com/AmazonRDS/latest/OracleReleaseNotes/oracle-version-12-1.html#oracle-version-12.1.0.2.v22) in the *Amazon RDS for Oracle Release Notes*\. - -para - -**Important** -Internally, the `rdsadmin.rdsadmin_util` package sets events by using the `ALTER SYSTEM SET EVENTS` statement\. This `ALTER SYSTEM` statement isn't documented in the Oracle Database documentation\. Some system diagnostic events can generate large amounts of tracing information, cause contention, or affect database availability\. We recommend that you test specific diagnostic events in your nonproduction database, and only set events in your production database under guidance of Oracle Support\. - -### Listing allowed system diagnostic events - -To list the system events that you can set, use the Amazon RDS procedure `rdsadmin.rdsadmin_util.list_allowed_system_events`\. This procedure accepts no parameters\. - -The following example lists all system events that you can set\. - -``` -SET SERVEROUTPUT ON -EXEC rdsadmin.rdsadmin_util.list_allowed_system_events; -``` - -The following sample output lists event numbers and their descriptions\. Use the Amazon RDS procedures `set_system_event` to set these events and `unset_system_event` to unset them\. - -``` -604 - error occurred at recursive SQL level -942 - table or view does not exist -1401 - inserted value too large for column -1403 - no data found -1410 - invalid ROWID -1422 - exact fetch returns more than requested number of rows -1426 - numeric overflow -1427 - single-row subquery returns more than one row -1476 - divisor is equal to zero -1483 - invalid length for DATE or NUMBER bind variable -1489 - result of string concatenation is too long -1652 - unable to extend temp segment by in tablespace -1858 - a non-numeric character was found where a numeric was expected -4031 - unable to allocate bytes of shared memory ("","","","") -6502 - PL/SQL: numeric or value error -10027 - Specify Deadlock Trace Information to be Dumped -10046 - enable SQL statement timing -10053 - CBO Enable optimizer trace -10173 - Dynamic Sampling time-out error -10442 - enable trace of kst for ORA-01555 diagnostics -12008 - error in materialized view refresh path -12012 - error on auto execute of job -12504 - TNS:listener was not given the SERVICE_NAME in CONNECT_DATA -14400 - inserted partition key does not map to any partition -31693 - Table data object failed to load/unload and is being skipped due to error: -``` - -**Note** -The list of the allowed system events can change over time\. To make sure that you have the most recent list of eligible events, use `rdsadmin.rdsadmin_util.list_allowed_system_events`\. - -### Setting system diagnostic events - -To set a system event, use the Amazon RDS procedure `rdsadmin.rdsadmin_util.set_system_event`\. You can only set events listed in the output of `rdsadmin.rdsadmin_util.list_allowed_system_events`\. The `set_system_event` procedure accepts the following parameters\. - - -**** - -| Parameter name | Data type | Default | Required | Description | -| --- | --- | --- | --- | --- | -| `p_event` | number | — | Yes | The system event number\. The value must be one of the event numbers reported by `list_allowed_system_events`\. | -| `p_level` | number | — | Yes | The event level\. See the Oracle Database documentation or Oracle Support for descriptions of different level values\. | - -The procedure `set_system_event` constructs and runs the required `ALTER SYSTEM SET EVENTS` statements according to the following principles: -+ The event type \(`context` or `errorstack`\) is determined automatically\. -+ A statement in the form `ALTER SYSTEM SET EVENTS 'event LEVEL event_level'` sets the context events\. This notation is equivalent to `ALTER SYSTEM SET EVENTS 'event TRACE NAME CONTEXT FOREVER, LEVEL event_level'`\. -+ A statement in the form `ALTER SYSTEM SET EVENTS 'event ERRORSTACK (event_level)'` sets the error stack events\. This notation is equivalent to `ALTER SYSTEM SET EVENTS 'event TRACE NAME ERRORSTACK LEVEL event_level'`\. - -The following example sets event 942 at level 3, and event 10442 at level 10\. Sample output is included\. - -``` -SQL> SET SERVEROUTPUT ON -SQL> EXEC rdsadmin.rdsadmin_util.set_system_event(942,3); -Setting system event 942 with: alter system set events '942 errorstack (3)' - -PL/SQL procedure successfully completed. - -SQL> EXEC rdsadmin.rdsadmin_util.set_system_event(10442,10); -Setting system event 10442 with: alter system set events '10442 level 10' - -PL/SQL procedure successfully completed. -``` - -### Listing system diagnostic events that are set - -To list the system events that are currently set, use the Amazon RDS procedure `rdsadmin.rdsadmin_util.list_set_system_events`\. This procedure reports only events set at system level by `set_system_event`\. - -The following example lists the active system events\. - -``` -SET SERVEROUTPUT ON -EXEC rdsadmin.rdsadmin_util.list_set_system_events; -``` - -The following sample output shows the list of events, the event type, the level at which the events are currently set, and the time when the event was set\. - -``` -942 errorstack (3) - set at 2020-11-03 11:42:27 -10442 level 10 - set at 2020-11-03 11:42:41 - -PL/SQL procedure successfully completed. -``` - -### Unsetting system diagnostic events - -To unset a system event, use the Amazon RDS procedure `rdsadmin.rdsadmin_util.unset_system_event`\. You can only unset events listed in the output of `rdsadmin.rdsadmin_util.list_allowed_system_events`\. The `unset_system_event` procedure accepts the following parameter\. - - -**** - -| Parameter name | Data type | Default | Required | Description | -| --- | --- | --- | --- | --- | -| `p_event` | number | — | Yes | The system event number\. The value must be one of the event numbers reported by `list_allowed_system_events`\. | - -The following example unsets events 942 and 10442\. Sample output is included\. - -``` -SQL> SET SERVEROUTPUT ON -SQL> EXEC rdsadmin.rdsadmin_util.unset_system_event(942); -Unsetting system event 942 with: alter system set events '942 off' - -PL/SQL procedure successfully completed. - -SQL> EXEC rdsadmin.rdsadmin_util.unset_system_event(10442); -Unsetting system event 10442 with: alter system set events '10442 off' - -PL/SQL procedure successfully completed. -``` \ No newline at end of file diff --git a/doc_source/Appendix.Oracle.CommonDBATasks.md b/doc_source/Appendix.Oracle.CommonDBATasks.md deleted file mode 100644 index 74448ae..0000000 --- a/doc_source/Appendix.Oracle.CommonDBATasks.md +++ /dev/null @@ -1,62 +0,0 @@ -# Administering your Oracle DB instance - -Following are the common management tasks that you perform with an Amazon RDS DB instance\. Some tasks are the same for all RDS DB instances\. Other tasks are specific to RDS for Oracle\. - -The following tasks are common to all RDS databases, but Oracle has special considerations\. For example, connect to an Oracle Database using the Oracle clients SQL\*Plus and SQL Developer\. - - -**** - -| Task area | Relevant documentation | -| --- | --- | -| **Instance classes, storage, and PIOPS** If you are creating a production instance, learn how instance classes, storage types, and Provisioned IOPS work in Amazon RDS\. | [RDS for Oracle instance classes](Oracle.Concepts.InstanceClasses.md) [Amazon RDS storage types](CHAP_Storage.md#Concepts.Storage) | -| **Multi\-AZ deployments** A production DB instance should use Multi\-AZ deployments\. Multi\-AZ deployments provide increased availability, data durability, and fault tolerance for DB instances\. | [Configuring and managing a Multi\-AZ deployment](Concepts.MultiAZ.md) | -| **Amazon VPC** If your AWS account has a default virtual private cloud \(VPC\), then your DB instance is automatically created inside the default VPC\. If your account doesn't have a default VPC, and you want the DB instance in a VPC, create the VPC and subnet groups before you create the instance\. | [Working with a DB instance in a VPC](USER_VPC.WorkingWithRDSInstanceinaVPC.md) | -| **Security groups** By default, DB instances use a firewall that prevents access\. Make sure that you create a security group with the correct IP addresses and network configuration to access the DB instance\. | [Controlling access with security groups](Overview.RDSSecurityGroups.md) | -| **Parameter groups** If your DB instance is going to require specific database parameters, create a parameter group before you create the DB instance\. | [Working with parameter groups](USER_WorkingWithParamGroups.md) | -| **Option groups** If your DB instance requires specific database options, create an option group before you create the DB instance\. | [Adding options to Oracle DB instances](Appendix.Oracle.Options.md) | -| **Connecting to your DB instance** After creating a security group and associating it to a DB instance, you can connect to the DB instance using any standard SQL client application such as Oracle SQL\*Plus\. | [Connecting to your RDS for Oracle DB instance](USER_ConnectToOracleInstance.md) | -| **Backup and restore** You can configure your DB instance to take automated backups, or take manual snapshots, and then restore instances from the backups or snapshots\. | [Backing up and restoring](CHAP_CommonTasks.BackupRestore.md) | -| **Monitoring** You can monitor an Oracle DB instance by using CloudWatch Amazon RDS metrics, events, and enhanced monitoring\. | [Viewing metrics in the Amazon RDS console](USER_Monitoring.md) [Viewing Amazon RDS events](USER_ListEvents.md) | -| **Log files** You can access the log files for your Oracle DB instance\. | [Monitoring Amazon RDS log files](USER_LogAccess.md) | - -Following, you can find a description for Amazon RDS–specific implementations of common DBA tasks for RDS Oracle\. To deliver a managed service experience, Amazon RDS doesn't provide shell access to DB instances\. Also, RDS restricts access to certain system procedures and tables that require advanced privileges\. In many of the tasks, you run the `rdsadmin` package, which is an Amazon RDS–specific tool that enables you to administer your database\. - -The following are common DBA tasks for DB instances running Oracle: -+ [System tasks](Appendix.Oracle.CommonDBATasks.System.md) -**** -[\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Appendix.Oracle.CommonDBATasks.html) - - -+ [Database tasks](Appendix.Oracle.CommonDBATasks.Database.md) -**** -[\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Appendix.Oracle.CommonDBATasks.html) - - -+ [Log tasks](Appendix.Oracle.CommonDBATasks.Log.md) -**** -[\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Appendix.Oracle.CommonDBATasks.html) - - -+ [RMAN tasks](Appendix.Oracle.CommonDBATasks.RMAN.md) -**** -[\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Appendix.Oracle.CommonDBATasks.html) - - -+ [Oracle Scheduler tasks](Appendix.Oracle.CommonDBATasks.Scheduler.md) -**** -[\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Appendix.Oracle.CommonDBATasks.html) - - -+ [Diagnostic tasks](Appendix.Oracle.CommonDBATasks.Diagnostics.md) -**** -[\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Appendix.Oracle.CommonDBATasks.html) - - -+ [Other tasks](Appendix.Oracle.CommonDBATasks.Misc.md) -**** -[\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Appendix.Oracle.CommonDBATasks.html) - - - -You can also use Amazon RDS procedures for Amazon S3 integration with Oracle and for running OEM Management Agent database tasks\. For more information, see [Amazon S3 integration](oracle-s3-integration.md) and [Performing database tasks with the Management Agent](Oracle.Options.OEMAgent.md#Oracle.Options.OEMAgent.DBTasks)\. \ No newline at end of file diff --git a/doc_source/Appendix.Oracle.Options.APEX.md b/doc_source/Appendix.Oracle.Options.APEX.md deleted file mode 100644 index 159a9df..0000000 --- a/doc_source/Appendix.Oracle.Options.APEX.md +++ /dev/null @@ -1,460 +0,0 @@ -# Oracle Application Express \(APEX\) - -Amazon RDS supports Oracle Application Express \(APEX\) through the use of the `APEX` and `APEX-DEV` options\. You can deploy Oracle APEX as a run\-time environment or as a full development environment for web\-based applications\. Using Oracle APEX, developers can build applications entirely within the web browser\. For more information, see [Oracle application Express](https://apex.oracle.com/) in the Oracle documentation\. - -**Topics** -+ [APEX components](#Appendix.Oracle.Options.APEX.components) -+ [APEX version requirements](#Appendix.Oracle.Options.APEX.versions) -+ [Prerequisites for Oracle APEX and ORDS](#Appendix.Oracle.Options.APEX.PreReqs) -+ [Adding the Amazon RDS APEX options](#Appendix.Oracle.Options.APEX.Add) -+ [Unlocking the public user account](#Appendix.Oracle.Options.APEX.PublicUser) -+ [Configuring RESTful services for Oracle APEX](#Appendix.Oracle.Options.APEX.ConfigureRESTful) -+ [Setting up ORDS for Oracle APEX](#Appendix.Oracle.Options.APEX.ORDS) -+ [Setting up Oracle APEX listener](#Appendix.Oracle.Options.APEX.Listener) -+ [Upgrading the APEX version](#Appendix.Oracle.Options.APEX.Upgrade) -+ [Removing the APEX option](#Appendix.Oracle.Options.APEX.Remove) - -## APEX components - -Oracle APEX consists of the following main components: -+ A *repository* that stores the metadata for APEX applications and components\. The repository consists of tables, indexes, and other objects that are installed in your Amazon RDS DB instance\. -+ A *listener* that manages HTTP communications with Oracle APEX clients\. The listener resides on a separate host such as an Amazon EC2 instance, an on\-premises server at your company, or your desktop computer\. The listener accepts incoming connections from web browsers, forwards them to the Amazon RDS DB instance for processing, and then sends results from the repository back to the browsers\. RDS for Oracle supports the following types of listeners: - + For APEX version 5\.0 and later, use Oracle Rest Data Services \(ORDS\) version 19\.1 and higher\. We recommend that you use the latest supported version of Oracle APEX and ORDS\. This documentation describes older versions for backwards compatibility only\. - + For APEX version 4\.1\.1, you can use Oracle APEX Listener version 1\.1\.4\. - + You can use Oracle HTTP Server and `mod_plsql` listeners\. -**Note** -Amazon RDS doesn't support the Oracle XML DB HTTP server with the embedded PL/SQL gateway; you can't use this as a listener for APEX\. In general, Oracle recommends against using the embedded PL/SQL gateway for applications that run on the internet\. - - For more information about these listener types, see [About choosing a web listener](https://docs.oracle.com/database/apex-5.1/HTMIG/choosing-web-listener.htm#HTMIG29321) in the Oracle documentation\. - -When you add the Amazon RDS APEX options to your RDS for Oracle DB instance, Amazon RDS installs the Oracle APEX repository only\. Install your listener on a separate host\. - -## APEX version requirements - -The APEX option uses storage on the DB instance class for your DB instance\. Following are the supported versions and approximate storage requirements for Oracle APEX\. - - -**** - -| APEX version | Storage requirements | Supported Oracle Database versions | Notes | -| --- | --- | --- | --- | -| Oracle APEX version 22\.2\.v1 | 106 MiB | All | This version includes patch 34628174: PSE BUNDLE FOR APEX 22\.2 \(PSES ON TOP OF 22\.2\.0\), PATCH\_VERSION 4\. | -| Oracle APEX version 22\.1\.v1 | 124 MiB | All | This version includes patch 34020981: PSE BUNDLE FOR APEX 22\.1 \(PSES ON TOP OF 22\.1\.0\), PATCH\_VERSION 6\. | -| Oracle APEX version 21\.2\.v1 | 125 MiB | All | This version includes patch 33420059: PSE BUNDLE FOR APEX 21\.2 \(PSES ON TOP OF 21\.2\.0\), PATCH\_VERSION 8\. | -| Oracle APEX version 21\.1\.v1 | 125 MiB | All | This version includes patch 32598392: PSE BUNDLE FOR APEX 21\.1, PATCH\_VERSION 3\. | -| Oracle APEX version 20\.2\.v1 | 148 MiB | All except 21c | This version includes patch 32006852: PSE BUNDLE FOR APEX 20\.2, PATCH\_VERSION 2020\.11\.12\. You can see the patch number and date by running the following query: 
SELECT PATCH_VERSION, PATCH_NUMBER 
FROM   APEX_PATCHES;
| -| Oracle APEX version 20\.1\.v1 | 173 MiB | All except 21c | This version includes patch 30990551: PSE BUNDLE FOR APEX 20\.1, PATCH\_VERSION 2020\.07\.15\. | -| Oracle APEX version 19\.2\.v1 | 149 MiB | All except 21c | | -| Oracle APEX version 19\.1\.v1 | 148 MiB | All except 21c | | -| Oracle APEX version 18\.2\.v1 | 146 MiB | 12\.1 and 12\.2 only | | -| Oracle APEX version 18\.1\.v1 | 145 MiB | 12\.1 and 12\.2 only | | -| Oracle APEX version 5\.1\.4\.v1 | 220 MiB | 12\.1 and 12\.2 only | | -| Oracle APEX version 5\.1\.2\.v1 | 150 MiB | 12\.1 and 12\.2 only | | -| Oracle APEX version 5\.0\.4\.v1 | 140 MiB | 12\.1 and 12\.2 only | | -| Oracle APEX version 4\.2\.6\.v1 | 160 MiB | 12\.1 only | | - -For downloadable APEX \.zip files, see [ Oracle APEX Prior Release Archives ](https://www.oracle.com/tools/downloads/apex-all-archives-downloads.html) on the Oracle website\. - -## Prerequisites for Oracle APEX and ORDS - -To use Oracle APEX and ORDS, make sure you have the following: -+ The Java Runtime Environment \(JRE\) -+ An Oracle client installation that includes the following: - + SQL\*Plus or SQL Developer for administration tasks - + Oracle Net Services for configuring connections to your Oracle instance - -## Adding the Amazon RDS APEX options - -To add the Amazon RDS APEX options to a DB instance, do the following: - -1. Create a new option group, or copy or modify an existing option group\. - -1. Add the options to the option group\. - -1. Associate the option group with the DB instance\. - -When you add the Amazon RDS APEX options, a brief outage occurs while your DB instance is automatically restarted\. - -**To add the APEX options to a DB instance** - -1. Determine the option group you want to use\. You can create a new option group or use an existing option group\. If you want to use an existing option group, skip to the next step\. Otherwise, create a custom DB option group with the following settings: - - 1. For **Engine**, choose the Oracle edition that you want to use\. The APEX options are supported on all editions\. - - 1. For **Major engine version**, choose the version of your DB instance\. - - For more information, see [Creating an option group](USER_WorkingWithOptionGroups.md#USER_WorkingWithOptionGroups.Create)\. - -1. Add the options to the option group\. If you want to deploy only the Oracle APEX run\-time environment, add only the `APEX` option\. If you want to deploy the full development environment, add both the `APEX` and `APEX-DEV` options\. For Oracle Database 12c, add the **APEX** and **APEX\-DEV** options\. - - For **Version**, choose the version of `APEX` that you want to use\. If you don't choose a version, version 4\.2\.6\.v1 is the default for Oracle Database 12c\. -**Important** -If you add the APEX options to an existing option group that is already attached to one or more DB instances, a brief outage occurs\. During this outage, all the DB instances are automatically restarted\. - - For more information about adding options, see [Adding an option to an option group](USER_WorkingWithOptionGroups.md#USER_WorkingWithOptionGroups.AddOption)\. - -1. Apply the option group to a new or existing DB instance: - + For a new DB instance, you apply the option group when you launch the instance\. For more information, see [Creating an Amazon RDS DB instance](USER_CreateDBInstance.md)\. - + For an existing DB instance, you apply the option group by modifying the instance and attaching the new option group\. When you add the APEX options to an existing DB instance, a brief outage occurs while your DB instance is automatically restarted\. For more information, see [Modifying an Amazon RDS DB instance](Overview.DBInstance.Modifying.md)\. - -## Unlocking the public user account - -After the Amazon RDS APEX options are installed, make sure to do the following: - -1. Change the password for the APEX public user account\. - -1. Unlock the account\. - -You can do this by using the Oracle SQL\*Plus command line utility\. Connect to your DB instance as the master user, and issue the following commands\. Replace `new_password` with a password of your choice\. - -``` -1. ALTER USER APEX_PUBLIC_USER IDENTIFIED BY new_password; -2. ALTER USER APEX_PUBLIC_USER ACCOUNT UNLOCK; -``` - -## Configuring RESTful services for Oracle APEX - -To configure RESTful services in APEX \(not needed for APEX 4\.1\.1\.V1\), use SQL\*Plus to connect to your DB instance as the master user\. After you do this, run the `rdsadmin.rdsadmin_run_apex_rest_config` stored procedure\. When you run the stored procedure, you provide passwords for the following users: -+ `APEX_LISTENER` -+ `APEX_REST_PUBLIC_USER` - -The stored procedure runs the `apex_rest_config.sql` script, which creates new database accounts for these users\. - -**Note** -Configuration isn't required for Oracle APEX version 4\.1\.1\.v1\. For this Oracle APEX version only, you don't need to run the stored procedure\. - -The following command runs the stored procedure\. - -``` -1. EXEC rdsadmin.rdsadmin_run_apex_rest_config('apex_listener_password', 'apex_rest_public_user_password'); -``` - -## Setting up ORDS for Oracle APEX - -You are now ready to install and configure Oracle Rest Data Services \(ORDS\) for use with Oracle APEX\. For APEX version 5\.0 and later, use Oracle Rest Data Services \(ORDS\) version 19\.1 and higher\. - -Install the listener on a separate host such as an Amazon EC2 instance, an on\-premises server at your company, or your desktop computer\. For the examples in this section, we assume that the name of your host is `myapexhost.example.com`, and that your host is running Linux\. - -### Preparing to install ORDS - -Before you can install ORDS, you need to create a nonprivileged OS user, and then download and unzip the APEX installation file\. - -**To prepare for ORDS installation** - -1. Log in to `myapexhost.example.com` as `root`\. - -1. Create a nonprivileged OS user to own the listener installation\. The following command creates a new user named *apexuser*\. - - ``` - useradd -d /home/apexuser apexuser - ``` - - The following command assigns a password to the new user\. - - ``` - passwd apexuser; - ``` - -1. Log in to `myapexhost.example.com` as `apexuser`, and download the APEX installation file from Oracle to your `/home/apexuser` directory: - + [http://www\.oracle\.com/technetwork/developer\-tools/apex/downloads/index\.html](http://www.oracle.com/technetwork/developer-tools/apex/downloads/index.html) - + [Oracle application Express prior release archives](http://www.oracle.com/technetwork/developer-tools/apex/downloads/all-archives-099381.html) - -1. Unzip the file in the `/home/apexuser` directory\. - - ``` - unzip apex_.zip - ``` - - After you unzip the file, there is an `apex` directory in the `/home/apexuser` directory\. - -1. While you are still logged into `myapexhost.example.com` as `apexuser`, download the Oracle REST Data Services file from Oracle to your `/home/apexuser` directory: [http://www\.oracle\.com/technetwork/developer\-tools/apex\-listener/downloads/index\.html](http://www.oracle.com/technetwork/developer-tools/apex-listener/downloads/index.html)\. - -### Installing and configuring ORDS - -Before you can use APEX, you need to download the ords\.war file, use Java to install ORDS, and then start the listener\. - -**To install and configure ORDS for use with Oracle APEX** - -1. Create a new directory based on ORDS, and then unzip the listener file\. - - ``` - mkdir /home/apexuser/ORDS - cd /home/apexuser/ORDS - ``` - -1. Download the file `ords.version.number.zip` from [Oracle REST data services](http://www.oracle.com/technetwork/developer-tools/rest-data-services/downloads/index.html)\. - -1. Unzip the file into the `/home/apexuser/ORDS` directory\. - -1. If you're installing ORDS in a multitenant database, add the following line to the file `/home/apexuser/ORDS/params/ords_params.properties`: - - ``` - pdb.disable.lockdown=false - ``` - -1. Grant the master user the required privileges to install ORDS\. - - After the Amazon RDS APEX option is installed, give the master user the required privileges to install the ORDS schema\. You can do this by connecting to the database and running the following commands\. Replace `MASTER_USER` with the uppercase name of your master user\. -**Important** -When you enter the user name, use uppercase unless you created the user with a case\-sensitive identifier\. For example, if you run `CREATE USER myuser` or `CREATE USER MYUSER`, the data dictionary stores `MYUSER`\. However, if you use double quotes in `CREATE USER "MyUser"`, the data dictionary stores `MyUser`\. For more information, see [Granting SELECT or EXECUTE privileges to SYS objects](Appendix.Oracle.CommonDBATasks.System.md#Appendix.Oracle.CommonDBATasks.TransferPrivileges)\. - - ``` - exec rdsadmin.rdsadmin_util.grant_sys_object('DBA_OBJECTS', 'MASTER_USER', 'SELECT', true); - exec rdsadmin.rdsadmin_util.grant_sys_object('DBA_ROLE_PRIVS', 'MASTER_USER', 'SELECT', true); - exec rdsadmin.rdsadmin_util.grant_sys_object('DBA_TAB_COLUMNS', 'MASTER_USER', 'SELECT', true); - exec rdsadmin.rdsadmin_util.grant_sys_object('USER_CONS_COLUMNS', 'MASTER_USER', 'SELECT', true); - exec rdsadmin.rdsadmin_util.grant_sys_object('USER_CONSTRAINTS', 'MASTER_USER', 'SELECT', true); - exec rdsadmin.rdsadmin_util.grant_sys_object('USER_OBJECTS', 'MASTER_USER', 'SELECT', true); - exec rdsadmin.rdsadmin_util.grant_sys_object('USER_PROCEDURES', 'MASTER_USER', 'SELECT', true); - exec rdsadmin.rdsadmin_util.grant_sys_object('USER_TAB_COLUMNS', 'MASTER_USER', 'SELECT', true); - exec rdsadmin.rdsadmin_util.grant_sys_object('USER_TABLES', 'MASTER_USER', 'SELECT', true); - exec rdsadmin.rdsadmin_util.grant_sys_object('USER_VIEWS', 'MASTER_USER', 'SELECT', true); - exec rdsadmin.rdsadmin_util.grant_sys_object('WPIUTL', 'MASTER_USER', 'EXECUTE', true); - exec rdsadmin.rdsadmin_util.grant_sys_object('DBMS_SESSION', 'MASTER_USER', 'EXECUTE', true); - exec rdsadmin.rdsadmin_util.grant_sys_object('DBMS_UTILITY', 'MASTER_USER', 'EXECUTE', true); - ``` -**Note** -These commands apply to ORDS version 19\.1 and later\. - -1. Install the ORDS schema using the downloaded ords\.war file\. - - ``` - java -jar ords.war install advanced - ``` - - The program prompts you for the following information\. The default values are in brackets\. For more information, see [Introduction to Oracle REST data services](https://docs.oracle.com/en/database/oracle/oracle-rest-data-services/20.2/aelig/installing-REST-data-services.html#GUID-6F7B4E61-B730-4E73-80B8-F53299123730) in the Oracle documentation\. - + Enter the location to store configuration data: - - Enter */home/apexuser/ORDS*\. This is the location of the ORDS configuration files\. - + Specify the database connection type to use\. Enter number for \[1\] Basic \[2\] TNS \[3\] Custom URL \[1\]: - - Choose the desired connection type\. - + Enter the name of the database server \[localhost\]: *DB\_instance\_endpoint* - - Choose the default or enter the correct value\. - + Enter the database listener port \[1521\]: *DB\_instance\_port* - - Choose the default or enter the correct value\. - + Enter 1 to specify the database service name, or 2 to specify the database SID \[1\]: - - Choose `2` to specify the database SID\. - + Database SID \[xe\] - - Choose the default or enter the correct value\. - + Enter 1 if you want to verify/install Oracle REST Data Services schema or 2 to skip this step \[1\]: - - Choose `1`\. This step creates the Oracle REST Data Services proxy user named ORDS\_PUBLIC\_USER\. - + Enter the database password for ORDS\_PUBLIC\_USER: - - Enter the password, and then confirm it\. - + Requires to login with administrator privileges to verify Oracle REST Data Services schema\. - - Enter the administrator user name: *master\_user* - - Enter the database password for *master\_user*: *master\_user\_password* - - Confirm the password: *master\_user\_password* - + Enter the default tablespace for ORDS\_METADATA \[SYSAUX\]\. - - Enter the temporary tablespace for ORDS\_METADATA \[TEMP\]\. - - Enter the default tablespace for ORDS\_PUBLIC\_USER \[USERS\]\. - - Enter the temporary tablespace for ORDS\_PUBLIC\_USER \[TEMP\]\. - + Enter 1 if you want to use PL/SQL Gateway or 2 to skip this step\. If you're using Oracle Application Express or migrating from mod\_plsql, you must enter 1 \[1\]\. - - Choose the default\. - + Enter the PL/SQL Gateway database user name \[APEX\_PUBLIC\_USER\] - - Choose the default\. - + Enter the database password for APEX\_PUBLIC\_USER: - - Enter the password, and then confirm it\. - + Enter 1 to specify passwords for Application Express RESTful Services database users \(APEX\_LISTENER, APEX\_REST\_PUBLIC\_USER\) or 2 to skip this step \[1\]: - - Choose `2` for APEX 4\.1\.1\.V1; choose `1` for all other APEX versions\. - + \[Not needed for APEX 4\.1\.1\.v1\] Database password for APEX\_LISTENER - - Enter the password \(if required\), and then confirm it\. - + \[Not needed for APEX 4\.1\.1\.v1\] Database password for APEX\_REST\_PUBLIC\_USER - - Enter the password \(if required\), and then confirm it\. - + Enter a number to select a feature to enable: - - Enter `1` to enable all features: SQL Developer Web, REST Enabled SQL, and Database API\. - + Enter 1 if you wish to start in standalone mode or 2 to exit \[1\]: - - Enter `1`\. - + Enter the APEX static resources location: - - If you unzipped APEX installation files into `/home/apexuser`, enter `/home/apexuser/apex/images`\. Otherwise, enter `unzip_path/apex/images`, where *unzip\_path* is the directory where you unzipped the file\. - + Enter 1 if using HTTP or 2 if using HTTPS \[1\]: - - If you enter `1`, specify the HTTP port\. If you enter `2`, specify the HTTPS port and the SSL host name\. The HTTPS option prompts you to specify how you will provide the certificate: - + Enter `1` to use the self\-signed certificate\. - + Enter `2` to provide your own certificate\. If you enter `2`, specify the path for the SSL certificate and the path for the SSL certificate private key\. - -1. Set a password for the APEX `admin` user\. To do this, use SQL\*Plus to connect to your DB instance as the master user, and then run the following commands\. - - ``` - 1. EXEC rdsadmin.rdsadmin_util.grant_apex_admin_role; - 2. grant APEX_ADMINISTRATOR_ROLE to master; - 3. @/home/apexuser/apex/apxchpwd.sql - ``` - - Replace `master` with your master user name\. When the `apxchpwd.sql` script prompts you, enter a new `admin` password\. - -1. Start the ORDS listener\. Run the following code\. - - ``` - java -jar ords.war - ``` - - The first time you start ORDS, you are prompted to provide the location of the APEX Static resources\. This images folder is located in the `/apex/images` directory in the installation directory for APEX\. - -1. Return to the APEX administration window in your browser and choose **Administration**\. Next, choose **Application Express Internal Administration**\. When you are prompted for credentials, enter the following information: - + **User name** – `admin` - + **Password** – the password you set using the `apxchpwd.sql` script - - Choose **Login**, and then set a new password for the `admin` user\. - -Your listener is now ready for use\. - -## Setting up Oracle APEX listener - -**Note** -Oracle APEX Listener is deprecated\. - -Amazon RDS for Oracle continues to support APEX version 4\.1\.1 and Oracle APEX Listener version 1\.1\.4\. We recommend that you use the latest supported versions of Oracle APEX and ORDS\. - -Install Oracle APEX Listener on a separate host such as an Amazon EC2 instance, an on\-premises server at your company, or your desktop computer\. We assume that the name of your host is `myapexhost.example.com`, and that your host is running Linux\. - -### Preparing to install Oracle APEX listener - -Before you can install Oracle APEX Listener, you need to create a nonprivileged OS user, and then download and unzip the APEX installation file\. - -**To prepare for Oracle APEX listener installation** - -1. Log in to `myapexhost.example.com` as `root`\. - -1. Create a nonprivileged OS user to own the listener installation\. The following command creates a new user named *apexuser*\. - - ``` - useradd -d /home/apexuser apexuser - ``` - - The following command assigns a password to the new user\. - - ``` - passwd apexuser; - ``` - -1. Log in to `myapexhost.example.com` as `apexuser`, and download the APEX installation file from Oracle to your `/home/apexuser` directory: - + [http://www\.oracle\.com/technetwork/developer\-tools/apex/downloads/index\.html](http://www.oracle.com/technetwork/developer-tools/apex/downloads/index.html) - + [Oracle application Express prior release archives](http://www.oracle.com/technetwork/developer-tools/apex/downloads/all-archives-099381.html) - -1. Unzip the file in the `/home/apexuser` directory\. - - ``` - unzip apex_.zip - ``` - - After you unzip the file, there is an `apex` directory in the `/home/apexuser` directory\. - -1. While you are still logged into `myapexhost.example.com` as `apexuser`, download the Oracle APEX Listener file from Oracle to your `/home/apexuser` directory\. - -### Installing and configuring Oracle APEX listener - -Before you can use APEX, you need to download the apex\.war file, use Java to install Oracle APEX Listener, and then start the listener\. - -**To install and configure Oracle APEX listener** - -1. Create a new directory based on Oracle APEX Listener and open the listener file\. - - Run the following code: - - ``` - mkdir /home/apexuser/apexlistener - cd /home/apexuser/apexlistener - unzip ../apex_listener.version.zip - ``` - -1. Run the following code\. - - ``` - java -Dapex.home=./apex -Dapex.images=/home/apexuser/apex/images -Dapex.erase -jar ./apex.war - ``` - -1. Enter information for the program prompts following: - + The APEX Listener Administrator user name\. The default is *adminlistener*\. - + A password for the APEX Listener Administrator\. - + The APEX Listener Manager user name\. The default is *managerlistener*\. - + A password for the APEX Listener Administrator\. - - The program prints a URL that you need to complete the configuration, as follows\. - - ``` - INFO: Please complete configuration at: http://localhost:8080/apex/listenerConfigure - Database is not yet configured - ``` - -1. Leave Oracle APEX Listener running so that you can use Oracle Application Express\. When you have finished this configuration procedure, you can run the listener in the background\. - -1. From your web browser, go to the URL provided by the APEX Listener program\. The Oracle Application Express Listener administration window appears\. Enter the following information: - + **Username** – `APEX_PUBLIC_USER` - + **Password** – the password for *APEX\_PUBLIC\_USER*\. This password is the one that you specified earlier when you configured the APEX repository\. For more information, see [Unlocking the public user account](#Appendix.Oracle.Options.APEX.PublicUser)\. - + **Connection type** – Basic - + **Hostname** – the endpoint of your Amazon RDS DB instance, such as `mydb.f9rbfa893tft.us-east-1.rds.amazonaws.com`\. - + **Port** – 1521 - + **SID** – the name of the database on your Amazon RDS DB instance, such as `mydb`\. - -1. Choose **Apply**\. The APEX administration window appears\. - -1. Set a password for the APEX `admin` user\. To do this, use SQL\*Plus to connect to your DB instance as the master user, and then run the following commands\. - - ``` - 1. EXEC rdsadmin.rdsadmin_util.grant_apex_admin_role; - 2. grant APEX_ADMINISTRATOR_ROLE to master; - 3. @/home/apexuser/apex/apxchpwd.sql - ``` - - Replace `master` with your master user name\. When the `apxchpwd.sql` script prompts you, enter a new `admin` password\. - -1. Return to the APEX administration window in your browser and choose **Administration**\. Next, choose **Application Express Internal Administration**\. When you are prompted for credentials, enter the following information: - + **User name** – `admin` - + **Password** – the password you set using the `apxchpwd.sql` script - - Choose **Login**, and then set a new password for the `admin` user\. - -Your listener is now ready for use\. - -## Upgrading the APEX version - -**Important** -Back up your DB instance before you upgrade APEX\. For more information, see [Creating a DB snapshot](USER_CreateSnapshot.md) and [Testing an Oracle DB upgrade](USER_UpgradeDBInstance.Oracle.UpgradeTesting.md)\. - -To upgrade APEX with your DB instance, do the following: -+ Create a new option group for the upgraded version of your DB instance\. -+ Add the upgraded versions of APEX and APEX\-DEV to the new option group\. Be sure to include any other options that your DB instance uses\. For more information, see [Option group considerations](USER_UpgradeDBInstance.Oracle.OGPG.md#USER_UpgradeDBInstance.Oracle.OGPG.OG)\. -+ When you upgrade your DB instance, specify the new option group for your upgraded DB instance\. - -After you upgrade your version of APEX, the APEX schema for the previous version might still exist in your database\. If you don't need it anymore, you can drop the old APEX schema from your database after you upgrade\. - -If you upgrade the APEX version and RESTful services were not configured in the previous APEX version, we recommend that you configure RESTful services\. For more information, see [ Configuring RESTful services for Oracle APEX](#Appendix.Oracle.Options.APEX.ConfigureRESTful)\. - -In some cases when you plan to do a major version upgrade of your DB instance, you might find that you're using an APEX version that isn't compatible with your target database version\. In these cases, you can upgrade your version of APEX before you upgrade your DB instance\. Upgrading APEX first can reduce the amount of time that it takes to upgrade your DB instance\. - -**Note** -After upgrading APEX, install and configure a listener for use with the upgraded version\. For instructions, see [Setting up Oracle APEX listener](#Appendix.Oracle.Options.APEX.Listener)\. - -## Removing the APEX option - -You can remove the Amazon RDS APEX options from a DB instance\. To remove the APEX options from a DB instance, do one of the following: -+ To remove the APEX options from multiple DB instances, remove the APEX options from the option group they belong to\. This change affects all DB instances that use the option group\. When you remove the APEX options from an option group that is attached to multiple DB instances, a brief outage occurs while all the DB instances are restarted\. - - For more information, see [Removing an option from an option group](USER_WorkingWithOptionGroups.md#USER_WorkingWithOptionGroups.RemoveOption)\. -+ To remove the APEX options from a single DB instance, modify the DB instance and specify a different option group that doesn't include the APEX options\. You can specify the default \(empty\) option group, or a different custom option group\. When you remove the APEX options, a brief outage occurs while your DB instance is automatically restarted\. - - For more information, see [Modifying an Amazon RDS DB instance](Overview.DBInstance.Modifying.md)\. - -When you remove the APEX options from a DB instance, the APEX schema is removed from your database\. \ No newline at end of file diff --git a/doc_source/Appendix.Oracle.Options.AdvSecurity.md b/doc_source/Appendix.Oracle.Options.AdvSecurity.md deleted file mode 100644 index 09efb02..0000000 --- a/doc_source/Appendix.Oracle.Options.AdvSecurity.md +++ /dev/null @@ -1,69 +0,0 @@ -# Oracle Transparent Data Encryption - -Amazon RDS supports Oracle Transparent Data Encryption \(TDE\), a feature of the Oracle Advanced Security option available in Oracle Enterprise Edition\. This feature automatically encrypts data before it is written to storage and automatically decrypts data when the data is read from storage\. - -Oracle Transparent Data Encryption is used in scenarios where you need to encrypt sensitive data in case data files and backups are obtained by a third party or when you need to address security\-related regulatory compliance issues\. - -The TDE option is a permanent option that can't be removed from an option group\. You can't disable TDE from a DB instance once that instance is associated with an option group with the Oracle TDE option\. You can change the option group of a DB instance that is using the TDE option, but the option group associated with the DB instance must include the TDE option\. You can also modify an option group that includes the TDE option by adding or removing other options\. - -A detailed explanation about Oracle Transparent Data Encryption is beyond the scope of this guide\. For information about using Oracle Transparent Data Encryption, see [Securing stored data using Transparent Data Encryption](http://docs.oracle.com/cd/E11882_01/network.112/e40393/asotrans.htm#BABFGJAG)\. For more information about Oracle Advanced Security, see [Oracle advanced security](http://www.oracle.com/technetwork/database/options/advanced-security/index.html) in the Oracle documentation\. For more information on AWS security, see the [AWS security center](http://aws.amazon.com/security)\. - -**Note** -You can't share a DB snapshot that uses this option\. For more information about sharing DB snapshots, see [Sharing a DB snapshot](USER_ShareSnapshot.md)\. - -## TDE encryption modes - -Oracle Transparent Data Encryption supports two encryption modes: TDE tablespace encryption and TDE column encryption\. TDE tablespace encryption is used to encrypt entire application tables\. TDE column encryption is used to encrypt individual data elements that contain sensitive data\. You can also apply a hybrid encryption solution that uses both TDE tablespace and column encryption\. - -**Note** -Amazon RDS manages the Oracle Wallet and TDE master key for the DB instance\. You do not need to set the encryption key using the command `ALTER SYSTEM set encryption key`\. - -For information about TDE best practices, see [Oracle advanced security Transparent Data Encryption best practices](https://www.oracle.com/br/a/tech/docs/technical-resources/twp-transparent-data-encryption-bestpractices.pdf)\. - -Once the option is enabled, you can check the status of the Oracle Wallet by using the following command: - -``` -SELECT * FROM v$encryption_wallet; -``` - -To create an encrypted tablespace, use the following command: - -``` -CREATE TABLESPACE encrypt_ts ENCRYPTION DEFAULT STORAGE (ENCRYPT); -``` - -To specify the encryption algorithm, use the following command: - -``` -CREATE TABLESPACE encrypt_ts ENCRYPTION USING 'AES256' DEFAULT STORAGE (ENCRYPT); -``` - -Note that the previous commands for encrypting a tablespace are the same as the commands you would use with an Oracle installation not on Amazon RDS, and the ALTER TABLE syntax to encrypt a column is also the same as the commands you would use for an Oracle installation not on Amazon RDS\. - - You should determine if your DB instance is associated with an option group that has the **TDE** option\. To view the option group that a DB instance is associated with, you can use the RDS console, the [describe\-db\-instance](https://docs.aws.amazon.com/cli/latest/reference/rds/describe-db-instances.html) AWS CLI command, or the API operation [DescribeDBInstances](https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_DescribeDBInstances.html)\. - -To comply with several security standards, Amazon RDS is working to implement automatic periodic master key rotation\. - -## Adding the TDE option - -The process for using Oracle Transparent Data Encryption \(TDE\) with Amazon RDS is as follows: - -1. If the DB instance is not associated with an option group that has the **TDE** option enabled, you must either create an option group and add the **TDE** option or modify the associated option group to add the **TDE** option\. For information about creating or modifying an option group, see [Working with option groups](USER_WorkingWithOptionGroups.md)\. For information about adding an option to an option group, see [Adding an option to an option group](USER_WorkingWithOptionGroups.md#USER_WorkingWithOptionGroups.AddOption)\. - -1. Associate the DB instance with the option group with the **TDE** option\. For information about associating a DB instance with an option group, see [Modifying an Amazon RDS DB instance](Overview.DBInstance.Modifying.md)\. - -## Removing the TDE option - -To remove the **TDE** option with a DB instance, complete the following steps: - -1. Decrypt all your data on the DB instance\. - -1. Copy the data to a new DB instance that is not associated with an option group with **TDE** enabled\. - -1. Delete the original instance\. - -You can name the new instance the same name as the previous DB instance\. - -## Using TDE with Oracle Data Pump - -You can use Oracle Data Pump to import or export encrypted dump files\. Amazon RDS supports the password encryption mode \(ENCRYPTION\_MODE=PASSWORD\) for Oracle Data Pump\. Amazon RDS does not support transparent encryption mode \(ENCRYPTION\_MODE=TRANSPARENT\) for Oracle Data Pump\. For more information about using Oracle Data Pump with Amazon RDS, see [Importing using Oracle Data Pump](Oracle.Procedural.Importing.DataPump.md)\. \ No newline at end of file diff --git a/doc_source/Appendix.Oracle.Options.NetworkEncryption.md b/doc_source/Appendix.Oracle.Options.NetworkEncryption.md deleted file mode 100644 index 0e11528..0000000 --- a/doc_source/Appendix.Oracle.Options.NetworkEncryption.md +++ /dev/null @@ -1,133 +0,0 @@ -# Oracle native network encryption - -Amazon RDS supports Oracle native network encryption \(NNE\)\. With native network encryption, you can encrypt data as it moves to and from a DB instance\. Amazon RDS supports NNE for all editions of Oracle Database\. - -A detailed discussion of Oracle native network encryption is beyond the scope of this guide, but you should understand the strengths and weaknesses of each algorithm and key before you decide on a solution for your deployment\. For information about the algorithms and keys that are available through Oracle native network encryption, see [Configuring network data encryption](http://www.oracle.com/webfolder/technetwork/tutorials/obe/db/11g/r2/prod/security/network_encrypt/ntwrkencrypt.htm) in the Oracle documentation\. For more information about AWS security, see the [AWS security center](http://aws.amazon.com/security)\. - -**Note** -You can use Native Network Encryption or Secure Sockets Layer, but not both\. For more information, see [Oracle Secure Sockets Layer](Appendix.Oracle.Options.SSL.md)\. - -## NNE option settings - -You can specify encryption requirements on both the server and the client\. The DB instance can act as a client when, for example, it uses a database link to connect to another database\. You might want to avoid forcing encryption on the server side\. For example, you might not want to force all client communications to use encryption because the server requires it\. In this case, you can force encryption on the client side using the `SQLNET.*CLIENT` options\. - -Amazon RDS supports the following settings for the NNE option\. - -**Note** -When you use commas to separate values for an option setting, don't put a space after the comma\. - - -**** - -| Option setting | Valid values | Default values | Description | -| --- | --- | --- | --- | -| `SQLNET.ALLOW_WEAK_CRYPTO_CLIENTS` | `TRUE`, `FALSE` | `TRUE` | The behavior of the server when a client using a non\-secure cipher attempts to connect to the database\. If `TRUE`, clients can connect even if they aren't patched with the July 2021 PSU\. If the setting is `FALSE`, clients can connect to the database only when they are patched with the July 2021 PSU\. Before you set `SQLNET.ALLOW_WEAK_CRYPTO_CLIENTS` to `FALSE`, make sure that the following conditions are met: [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Appendix.Oracle.Options.NetworkEncryption.html) | -| `SQLNET.ALLOW_WEAK_CRYPTO` | `TRUE`, `FALSE` | `TRUE` | The behavior of the server when a client using a non\-secure cipher attempts to connect to the database\. The following ciphers are considered not secure: [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Appendix.Oracle.Options.NetworkEncryption.html) If the setting is `TRUE`, clients can connect when they use the preceding non\-secure ciphers\. If the setting is `FALSE`, the database prevents clients from connecting when they use the preceding non\-secure ciphers\. Before you set `SQLNET.ALLOW_WEAK_CRYPTO` to `FALSE`, make sure that the following conditions are met: [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Appendix.Oracle.Options.NetworkEncryption.html) | -| `SQLNET.CRYPTO_CHECKSUM_CLIENT` | `Accepted`, `Rejected`, `Requested`, `Required` | `Requested` | The data integrity behavior when a DB instance connects to the client, or a server acting as a client\. When a DB instance uses a database link, it acts as a client\. `Requested` indicates that the client doesn't require the DB instance to perform a checksum\. | -| `SQLNET.CRYPTO_CHECKSUM_SERVER` | `Accepted`, `Rejected`, `Requested`, `Required` | `Requested` | The data integrity behavior when a client, or a server acting as a client, connects to the DB instance\. When a DB instance uses a database link, it acts as a client\. `Requested` indicates that the DB instance doesn't require the client to perform a checksum\. | -| `SQLNET.CRYPTO_CHECKSUM_TYPES_CLIENT` | `SHA256`, `SHA384`, `SHA512`, `SHA1`, `MD5` | `SHA256`, `SHA384`, `SHA512` | A list of checksum algorithms\. You can specify either one value or a comma\-separated list of values\. If you use a comma, don't insert a space after the comma; otherwise, you receive an `InvalidParameterValue` error\. This parameter and `SQLNET.CRYPTO_CHECKSUM_TYPES_SERVER `must have a common cipher\. | -| `SQLNET.CRYPTO_CHECKSUM_TYPES_SERVER` | `SHA256`, `SHA384`, `SHA512`, `SHA1`, `MD5` | `SHA256`, `SHA384`, `SHA512`, `SHA1`, `MD5` | A list of checksum algorithms\. You can specify either one value or a comma\-separated list of values\. If you use a comma, don't insert a space after the comma; otherwise, you receive an `InvalidParameterValue` error\. This parameter and `SQLNET.CRYPTO_CHECKSUM_TYPES_CLIENT` must have a common cipher\. | -| `SQLNET.ENCRYPTION_CLIENT` | `Accepted`, `Rejected`, `Requested`, `Required` | `Requested` | The encryption behavior of the client when a client, or a server acting as a client, connects to the DB instance\. When a DB instance uses a database link, it acts as a client\. `Requested` indicates that the client does not require traffic from the server to be encrypted\. | -| `SQLNET.ENCRYPTION_SERVER` | `Accepted`, `Rejected`, `Requested`, `Required` | `Requested` | The encryption behavior of the server when a client, or a server acting as a client, connects to the DB instance\. When a DB instance uses a database link, it acts as a client\. `Requested` indicates that the DB instance does not require traffic from the client to be encrypted\. | -| `SQLNET.ENCRYPTION_TYPES_CLIENT` | `RC4_256`, `AES256`, `AES192`, `3DES168`, `RC4_128`, `AES128`, `3DES112`, `RC4_56`, `DES`, `RC4_40`, `DES40` | `RC4_256`, `AES256`, `AES192`, `3DES168`, `RC4_128`, `AES128`, `3DES112`, `RC4_56`, `DES`, `RC4_40`, `DES40` | A list of encryption algorithms used by the client\. The client uses each algorithm, in order, to attempt to decrypt the server input until an algorithm succeeds or until the end of the list is reached\. Amazon RDS uses the following default list from Oracle\. You can change the order or limit the algorithms that the DB instance will accept\. [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Appendix.Oracle.Options.NetworkEncryption.html) You can specify either one value or a comma\-separated list of values\. If you a comma, don't insert a space after the comma; otherwise, you receive an `InvalidParameterValue` error\. This parameter and `SQLNET.SQLNET.ENCRYPTION_TYPES_SERVER` must have a common cipher\. | -| `SQLNET.ENCRYPTION_TYPES_SERVER` | `RC4_256`, `AES256`, `AES192`, `3DES168`, `RC4_128`, `AES128`, `3DES112`, `RC4_56`, `DES`, `RC4_40`, `DES40` | `RC4_256`, `AES256`, `AES192`, `3DES168`, `RC4_128`, `AES128`, `3DES112`, `RC4_56`, `DES`, `RC4_40`, `DES40` | A list of encryption algorithms used by the DB instance\. The DB instance uses each algorithm, in order, to attempt to decrypt the client input until an algorithm succeeds or until the end of the list is reached\. Amazon RDS uses the following default list from Oracle\. You can change the order or limit the algorithms that the client will accept\. [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Appendix.Oracle.Options.NetworkEncryption.html) You can specify either one value or a comma\-separated list of values\. If you a comma, don't insert a space after the comma; otherwise, you receive an `InvalidParameterValue` error\. This parameter and `SQLNET.SQLNET.ENCRYPTION_TYPES_SERVER` must have a common cipher\. | - -## Adding the NNE option - -The general process for adding the NNE option to a DB instance is the following: - -1. Create a new option group, or copy or modify an existing option group\. - -1. Add the option to the option group\. - -1. Associate the option group with the DB instance\. - -When the option group is active, NNE is active\. - -**To add the NNE option to a DB instance using the AWS Management Console** - -1. For **Engine**, choose the Oracle edition that you want to use\. NNE is supported on all editions\. - -1. For **Major engine version**, choose the version of your DB instance\. - - For more information, see [Creating an option group](USER_WorkingWithOptionGroups.md#USER_WorkingWithOptionGroups.Create)\. - -1. Add the **NNE** option to the option group\. For more information about adding options, see [Adding an option to an option group](USER_WorkingWithOptionGroups.md#USER_WorkingWithOptionGroups.AddOption)\. -**Note** -After you add the NNE option, you don't need to restart your DB instances\. As soon as the option group is active, NNE is active\. - -1. Apply the option group to a new or existing DB instance: - + For a new DB instance, you apply the option group when you launch the instance\. For more information, see [Creating an Amazon RDS DB instance](USER_CreateDBInstance.md)\. - + For an existing DB instance, you apply the option group by modifying the instance and attaching the new option group\. After you add the NNE option, you don't need to restart your DB instance\. As soon as the option group is active, NNE is active\. For more information, see [Modifying an Amazon RDS DB instance](Overview.DBInstance.Modifying.md)\. - -## Setting NNE values in the sqlnet\.ora - -With Oracle native network encryption, you can set network encryption on the server side and client side\. The client is the computer used to connect to the DB instance\. You can specify the following client settings in the sqlnet\.ora: -+ `SQLNET.ALLOW_WEAK_CRYPTO` -+ `SQLNET.ALLOW_WEAK_CRYPTO_CLIENTS` -+ `SQLNET.CRYPTO_CHECKSUM_CLIENT` -+ `SQLNET.CRYPTO_CHECKSUM_TYPES_CLIENT` -+ `SQLNET.ENCRYPTION_CLIENT` -+ `SQLNET.ENCRYPTION_TYPES_CLIENT` - -For information, see [Configuring network data encryption and integrity for Oracle servers and clients](http://docs.oracle.com/cd/E11882_01/network.112/e40393/asoconfg.htm) in the Oracle documentation\. - -Sometimes, the DB instance rejects a connection request from an application\. For example, a rejection can occur when the encryption algorithms on the client and on the server don't match\. To test Oracle native network encryption, add the following lines to the sqlnet\.ora file on the client: - -``` -DIAG_ADR_ENABLED=off -TRACE_DIRECTORY_CLIENT=/tmp -TRACE_FILE_CLIENT=nettrace -TRACE_LEVEL_CLIENT=16 -``` - -When a connection is attempted, the preceding lines generate a trace file on the client called `/tmp/nettrace*`\. The trace file contains information about the connection\. For more information about connection\-related issues when you are using Oracle Native Network Encryption, see [About negotiating encryption and integrity](http://docs.oracle.com/cd/E11882_01/network.112/e40393/asoconfg.htm#autoId12) in the Oracle Database documentation\. - -## Modifying NNE option settings - -After you enable NNE, you can modify its settings\. Currently, you can modify NNE option settings only with the AWS CLI or RDS API\. You can't use the console\. To learn how to modify option settings using the CLI, see [AWS CLI](USER_WorkingWithOptionGroups.md#USER_WorkingWithOptionGroups.ModifyOption.CLI)\. For more information about each setting, see [NNE option settings](#Oracle.Options.NNE.Options)\. - -**Topics** -+ [Modifying CRYPTO\_CHECKSUM\_\* values](#Oracle.Options.NNE.ModifySettings.checksum) -+ [Modifying ALLOW\_WEAK\_CRYPTO\* settings](#Oracle.Options.NNE.ModifySettings.encryption) - -### Modifying CRYPTO\_CHECKSUM\_\* values - -If you modify NNE option settings, make sure that the following option settings have at least one common cipher: -+ `SQLNET.CRYPTO_CHECKSUM_TYPES_SERVER` -+ `SQLNET.CRYPTO_CHECKSUM_TYPES_CLIENT` - -The following example shows a scenario in which you modify `SQLNET.CRYPTO_CHECKSUM_TYPES_SERVER`\. The configuration is valid because the `CRYPTO_CHECKSUM_TYPES_CLIENT` and `CRYPTO_CHECKSUM_TYPES_SERVER` both use `SHA256`\. - - -| Option setting | Values before modification | Values after modification | -| --- | --- | --- | -| `SQLNET.CRYPTO_CHECKSUM_TYPES_CLIENT` | `SHA256`, `SHA384`, `SHA512` | No change | -| `SQLNET.CRYPTO_CHECKSUM_TYPES_SERVER` | `SHA256`, `SHA384`, `SHA512`, `SHA1`, `MD5` | SHA1,MD5,SHA256 | - -For another example, assume that you want to modify `SQLNET.CRYPTO_CHECKSUM_TYPES_SERVER` from its default setting to `SHA1,MD5`\. In this case, make sure you set `SQLNET.CRYPTO_CHECKSUM_TYPES_CLIENT` to `SHA1` or `MD5`\. These algorithms aren't included in the default values for `SQLNET.CRYPTO_CHECKSUM_TYPES_CLIENT`\. - -### Modifying ALLOW\_WEAK\_CRYPTO\* settings - -To set the `SQLNET.ALLOW_WEAK_CRYPTO*` options from the default value to `FALSE`, make sure that the following conditions are met: -+ `SQLNET.ENCRYPTION_TYPES_SERVER` and `SQLNET.ENCRYPTION_TYPES_CLIENT` have one matching secure encryption method\. A method is considered secure if it's not `DES`, `3DES`, or `RC4` \(all key lengths\)\. -+ `SQLNET.CHECKSUM_TYPES_SERVER` and `SQLNET.CHECKSUM_TYPES_CLIENT` have one matching secure checksumming method\. A method is considered secure if it's not `MD5`\. -+ The client is patched with the July 2021 PSU\. If the client isn't patched, the client loses the connection and receives the `ORA-12269` error\. - -The following example shows sample NNE settings\. Assume that you want to set `SQLNET.ENCRYPTION_TYPES_SERVER` and `SQLNET.ENCRYPTION_TYPES_CLIENT` to FALSE, thereby blocking non\-secure connections\. The checksum option settings meet the prerequisites because they both have `SHA256`\. However, `SQLNET.ENCRYPTION_TYPES_CLIENT` and `SQLNET.ENCRYPTION_TYPES_SERVER` use the `DES`, `3DES`, and `RC4` encryption methods, which are non\-secure\. Therefore, to set the `SQLNET.ALLOW_WEAK_CRYPTO*` options to `FALSE`, first set `SQLNET.ENCRYPTION_TYPES_SERVER` and `SQLNET.ENCRYPTION_TYPES_CLIENT` to a secure encryption method such as `AES256`\. - - -| Option setting | Values | -| --- | --- | -| `SQLNET.CRYPTO_CHECKSUM_TYPES_CLIENT` | `SHA256`, `SHA384`, `SHA512` | -| `SQLNET.CRYPTO_CHECKSUM_TYPES_SERVER` | SHA1,MD5,SHA256 | -| `SQLNET.ENCRYPTION_TYPES_CLIENT` | `RC4_256`, `3DES168`, `DES40` | -| `SQLNET.ENCRYPTION_TYPES_SERVER` | `RC4_256`, `3DES168`, `DES40` | - -## Removing the NNE option - -You can remove NNE from a DB instance\. - -To remove NNE from a DB instance, do one of the following: -+ To remove NNE from multiple DB instances, remove the NNE option from the option group they belong to\. This change affects all DB instances that use the option group\. After you remove the NNE option, you don't need to restart your DB instances\. For more information, see [Removing an option from an option group](USER_WorkingWithOptionGroups.md#USER_WorkingWithOptionGroups.RemoveOption)\. -+ To remove NNE from a single DB instance, modify the DB instance and specify a different option group that doesn't include the NNE option\. You can specify the default \(empty\) option group, or a different custom option group\. After you remove the NNE option, you don't need to restart your DB instance\. For more information, see [Modifying an Amazon RDS DB instance](Overview.DBInstance.Modifying.md)\. \ No newline at end of file diff --git a/doc_source/Appendix.Oracle.Options.OEM_DBControl.md b/doc_source/Appendix.Oracle.Options.OEM_DBControl.md deleted file mode 100644 index ec71841..0000000 --- a/doc_source/Appendix.Oracle.Options.OEM_DBControl.md +++ /dev/null @@ -1,162 +0,0 @@ -# Oracle Enterprise Manager Database Express - -Amazon RDS supports Oracle Enterprise Manager \(OEM\) Database Express through the use of the OEM option\. Amazon RDS supports Oracle Enterprise Manager Database Express for the following releases: -+ Oracle Database 19c \(non\-CDB only\) -+ Oracle Database 12c - -OEM Database Express and Database Control are similar tools that have a web\-based interface for Oracle database administration\. For more information about these tools, see [Accessing Enterprise Manager database Express 18c](https://docs.oracle.com/en/cloud/paas/database-dbaas-cloud/csdbi/access-em-database-express-18c-or-later.html) and [Accessing Enterprise Manager Database Express 12c](https://docs.oracle.com/en/cloud/paas/database-dbaas-cloud/csdbi/access-em-database-express-12c.html) in the Oracle documentation\. - -The following is a limitation for OEM Database Express: -+ OEM Database Express isn't supported on the db\.t3\.micro or db\.t3\.small DB instance classes\. - - For more information about DB instance classes, see [RDS for Oracle instance classes](Oracle.Concepts.InstanceClasses.md)\. - -## OEM Database option settings - -Amazon RDS supports the following settings for the OEM option\. - - -**** - -| Option setting | Valid values | Description | -| --- | --- | --- | -| **Port** | An integer value | The port on the DB instance that listens for OEM Database\. The default for OEM Database Express is 5500\. | -| **Security Groups** | — | A security group that has access to **Port**\. | - -## Adding the OEM Database option - -The general process for adding the OEM option to a DB instance is the following: - -1. Create a new option group, or copy or modify an existing option group\. - -1. Add the option to the option group\. - -1. Associate the option group with the DB instance\. - -When you add the OEM option for an Oracle Database 12c or later DB instance, a brief outage occurs while your DB instance is automatically restarted\. - -**To add the OEM option to a DB instance** - -1. Determine the option group you want to use\. You can create a new option group or use an existing option group\. If you want to use an existing option group, skip to the next step\. Otherwise, create a custom DB option group with the following settings: - - 1. For **Engine** choose the oracle edition for your DB instance\. - - 1. For **Major engine version** choose the version of your DB instance\. - - For more information, see [Creating an option group](USER_WorkingWithOptionGroups.md#USER_WorkingWithOptionGroups.Create)\. - -1. Add the OEM option to the option group, and configure the option settings\. For more information about adding options, see [Adding an option to an option group](USER_WorkingWithOptionGroups.md#USER_WorkingWithOptionGroups.AddOption)\. For more information about each setting, see [OEM Database option settings](#Appendix.Oracle.Options.OEM_DBControl.Options)\. -**Note** -If you add the OEM option to an existing option group that is already attached to one or more Oracle Database 19c \(non\-CDB only\) or Oracle Database 12c DB instances, a brief outage occurs while all the DB instances are automatically restarted\. - -1. Apply the option group to a new or existing DB instance: - + For a new DB instance, you apply the option group when you launch the instance\. For more information, see [Creating an Amazon RDS DB instance](USER_CreateDBInstance.md)\. - + For an existing DB instance, you apply the option group by modifying the instance and attaching the new option group\. When you add the OEM option for an Oracle Database 19c \(non\-CDB only\) or Oracle Database 12c DB instance, a brief outage occurs while your DB instance is automatically restarted\. For more information, see [Modifying an Amazon RDS DB instance](Overview.DBInstance.Modifying.md)\. - -**Note** -You can also use the AWS CLI to add the OEM option\. For examples, see [Adding an option to an option group](USER_WorkingWithOptionGroups.md#USER_WorkingWithOptionGroups.AddOption)\. - -## Accessing OEM through your browser - -After you enable the OEM option, you can begin using the OEM Database tool from your web browser\. - -You can access either OEM Database Control or OEM Database Express from your web browser\. For example, if the endpoint for your Amazon RDS DB instance is `mydb.f9rbfa893tft.us-east-1.rds.amazonaws.com`, and your OEM port is 1158, then the URL to access the OEM Database Control the following\. - -``` -1. https://mydb.f9rbfa893tft.us-east-1.rds.amazonaws.com:1158/em -``` - -When you access either tool from your web browser, a login window appears that prompts you for a user name and password\. Type the master user name and master password for your DB instance\. You are now ready to manage your Oracle databases\. - -## Modifying OEM Database settings - -After you enable OEM Database, you can modify the Security Groups setting for the option\. - -You can't modify the OEM port number after you have associated the option group with a DB instance\. To change the OEM port number for a DB instance, do the following: - -1. Create a new option group\. - -1. Add the OEM option with the new port number to the new option group\. - -1. Remove the existing option group from the DB instance\. - -1. Add the new option group to the DB instance\. - -For more information about how to modify option settings, see [Modifying an option setting](USER_WorkingWithOptionGroups.md#USER_WorkingWithOptionGroups.ModifyOption)\. For more information about each setting, see [OEM Database option settings](#Appendix.Oracle.Options.OEM_DBControl.Options)\. - -## Running OEM Database Express tasks - -You can use Amazon RDS procedures to run certain OEM Database Express tasks\. By running these procedures, you can do the tasks listed following\. - -**Note** -OEM Database Express tasks run asynchronously\. - -**Topics** -+ [Switching the website front end for OEM Database Express to Adobe Flash](#Appendix.Oracle.Options.OEM_DBControl.DBTasks.FrontEndToFlash) -+ [Switching the website front end for OEM Database Express to Oracle JET](#Appendix.Oracle.Options.OEM_DBControl.DBTasks.FrontEndToOracleJET) - -### Switching the website front end for OEM Database Express to Adobe Flash - -**Note** -This task is available only for Oracle Database 19c non\-CDBs\. - -Starting with Oracle Database 19c, Oracle has deprecated the former OEM Database Express user interface, which was based on Adobe Flash\. Instead, OEM Database Express now uses an interface built with Oracle JET\. If you experience difficulties with the new interface, you can switch back to the deprecated Flash\-based interface\. Difficulties you might experience with the new interface include being stuck on a `Loading` screen after logging in to OEM Database Express\. You might also miss certain features that were present in the Flash\-based version of OEM Database Express\. - -To switch the OEM Database Express website front end to Adobe Flash, run the Amazon RDS procedure `rdsadmin.rdsadmin_oem_tasks.em_express_frontend_to_flash`\. This procedure is equivalent to the `execemx emx` SQL command\. - -Security best practices discourage the use of Adobe Flash\. Although you can revert to the Flash\-based OEM Database Express, we recommend the use of the JET\-based OEM Database Express websites if possible\. If you revert to using Adobe Flash and want to switch back to using Oracle JET, use the `rdsadmin.rdsadmin_oem_tasks.em_express_frontend_to_jet` procedure\. After an Oracle database upgrade, a newer version of Oracle JET might resolve JET\-related issues in OEM Database Express\. For more information about switching to Oracle JET, see [Switching the website front end for OEM Database Express to Oracle JET](#Appendix.Oracle.Options.OEM_DBControl.DBTasks.FrontEndToOracleJET)\. - -**Note** -Running this task from the source DB instance for a read replica also causes the read replica to switch its OEM Database Express website front ends to Adobe Flash\. - -The following procedure invocation creates a task to switch the OEM Database Express website to Adobe Flash and returns the ID of the task\. - -``` -SELECT rdsadmin.rdsadmin_oem_tasks.em_express_frontend_to_flash() as TASK_ID from DUAL; -``` - -You can view the result by displaying the task's output file\. - -``` -SELECT text FROM table(rdsadmin.rds_file_util.read_text_file('BDUMP','dbtask-task-id.log')); -``` - -Replace *`task-id`* with the task ID returned by the procedure\. For more information about the Amazon RDS procedure `rdsadmin.rds_file_util.read_text_file`, see [Reading files in a DB instance directory](Appendix.Oracle.CommonDBATasks.Misc.md#Appendix.Oracle.CommonDBATasks.ReadingFiles) - -You can also view the contents of the task's output file in the AWS Management Console by searching the log entries in the **Logs & events** section for the `task-id`\. - -### Switching the website front end for OEM Database Express to Oracle JET - -**Note** -This task is available only for Oracle Database 19c non\-CDBs\. - -To switch the OEM Database Express website front end to Oracle JET, run the Amazon RDS procedure `rdsadmin.rdsadmin_oem_tasks.em_express_frontend_to_jet`\. This procedure is equivalent to the `execemx omx` SQL command\. - -By default, the OEM Database Express websites for Oracle DB instances running 19c or later use Oracle JET\. If you used the `rdsadmin.rdsadmin_oem_tasks.em_express_frontend_to_flash` procedure to switch the OEM Database Express website front end to Adobe Flash, you can switch back to Oracle JET\. To do this, use the `rdsadmin.rdsadmin_oem_tasks.em_express_frontend_to_jet` procedure\. For more information about switching to Adobe Flash, see [Switching the website front end for OEM Database Express to Adobe Flash](#Appendix.Oracle.Options.OEM_DBControl.DBTasks.FrontEndToFlash)\. - -**Note** -Running this task from the source DB instance for a read replica also causes the read replica to switch its OEM Database Express website front ends to Oracle JET\. - -The following procedure invocation creates a task to switch the OEM Database Express website to Oracle JET and returns the ID of the task\. - -``` -SELECT rdsadmin.rdsadmin_oem_tasks.em_express_frontend_to_jet() as TASK_ID from DUAL; -``` - -You can view the result by displaying the task's output file\. - -``` -SELECT text FROM table(rdsadmin.rds_file_util.read_text_file('BDUMP','dbtask-task-id.log')); -``` - -Replace *`task-id`* with the task ID returned by the procedure\. For more information about the Amazon RDS procedure `rdsadmin.rds_file_util.read_text_file`, see [Reading files in a DB instance directory](Appendix.Oracle.CommonDBATasks.Misc.md#Appendix.Oracle.CommonDBATasks.ReadingFiles) - -You can also view the contents of the task's output file in the AWS Management Console by searching the log entries in the **Logs & events** section for the `task-id`\. - -## Removing the OEM Database option - -You can remove the OEM option from a DB instance\. When you remove the OEM option for an Oracle Database 12c or later DB instance, a brief outage occurs while your instance is automatically restarted\. Therefore, after you remove the OEM option, you don't need to restart your DB instance\. - -To remove the OEM option from a DB instance, do one of the following: -+ Remove the OEM option from the option group it belongs to\. This change affects all DB instances that use the option group\. For more information, see [Removing an option from an option group](USER_WorkingWithOptionGroups.md#USER_WorkingWithOptionGroups.RemoveOption)\. -+ Modify the DB instance and specify a different option group that doesn't include the OEM option\. This change affects a single DB instance\. You can specify the default \(empty\) option group, or a different custom option group\. For more information, see [Modifying an Amazon RDS DB instance](Overview.DBInstance.Modifying.md)\. \ No newline at end of file diff --git a/doc_source/Appendix.Oracle.Options.SSL.md b/doc_source/Appendix.Oracle.Options.SSL.md deleted file mode 100644 index b7862e2..0000000 --- a/doc_source/Appendix.Oracle.Options.SSL.md +++ /dev/null @@ -1,330 +0,0 @@ -# Oracle Secure Sockets Layer - -You enable SSL encryption for an RDS for Oracle DB instance by adding the Oracle SSL option to the option group associated with the DB instance\. Amazon RDS uses a second port, as required by Oracle, for SSL connections\. This approach allows both clear text and SSL\-encrypted communication to occur at the same time between a DB instance and SQL\*Plus\. For example, you can use the port with clear text communication to communicate with other resources inside a VPC while using the port with SSL\-encrypted communication to communicate with resources outside the VPC\. - -**Note** -You can use either SSL or Native Network Encryption \(NNE\) on the same RDS for Oracle DB instance, but not both\. If you use SSL encryption, make sure to turn off any other connection encryption\. For more information, see [Oracle native network encryption](Appendix.Oracle.Options.NetworkEncryption.md)\. - -SSL/TLS and NNE are no longer part of Oracle Advanced Security\. In RDS for Oracle, you can use SSL encryption with all licensed editions of the following database versions: -+ Oracle Database 21c \(21\.0\.0\) -+ Oracle Database 19c \(19\.0\.0\) -+ Oracle Database 12c Release 2 \(12\.2\) – this release is no longer supported -+ Oracle Database 12c Release 1 \(12\.1\) – this release is no longer supported - -## TLS versions for the Oracle SSL option - -Amazon RDS for Oracle supports Transport Layer Security \(TLS\) versions 1\.0 and 1\.2\. When you add a new Oracle SSL option, set `SQLNET.SSL_VERSION` explicitly to a valid value\. The following values are allowed for this option setting: -+ `"1.0"` – Clients can connect to the DB instance using TLS 1\.0 only\. For existing Oracle SSL options, `SQLNET.SSL_VERSION` is set to `"1.0"` automatically\. You can change the setting if necessary\. -+ `"1.2"` – Clients can connect to the DB instance using TLS 1\.2 only\. -+ `"1.2 or 1.0"` – Clients can connect to the DB instance using either TLS 1\.2 or 1\.0\. - -## Cipher suites for the Oracle SSL option - -Amazon RDS for Oracle supports multiple SSL cipher suites\. By default, the Oracle SSL option is configured to use the `SSL_RSA_WITH_AES_256_CBC_SHA` cipher suite\. To specify a different cipher suite to use over SSL connections, use the `SQLNET.CIPHER_SUITE` option setting\. - -The following table summarizes SSL support for RDS for Oracle\. The specified Oracle Database releases support all editions\. - - -| Cipher suite \(SQLNET\.CIPHER\_SUITE\) | TLS version support \(SQLNET\.SSL\_VERSION\) | Supported Oracle Database releases | FIPS support | FedRAMP compliant | -| --- | --- | --- | --- | --- | -| SSL\_RSA\_WITH\_AES\_256\_CBC\_SHA \(default\) | 1\.0 and 1\.2 | 12c, 19c, 21c | Yes | No | -| SSL\_RSA\_WITH\_AES\_256\_CBC\_SHA256 | 1\.2 | 12c, 19c, 21c | Yes | No | -| SSL\_RSA\_WITH\_AES\_256\_GCM\_SHA384 | 1\.2 | 12c, 19c, 21c | Yes | No | -| TLS\_ECDHE\_RSA\_WITH\_AES\_256\_GCM\_SHA384 | 1\.2 | 19c, 21c | Yes | Yes | -| TLS\_ECDHE\_RSA\_WITH\_AES\_128\_GCM\_SHA256 | 1\.2 | 19c, 21c | Yes | Yes | -| TLS\_ECDHE\_RSA\_WITH\_AES\_256\_CBC\_SHA384 | 1\.2 | 19c, 21c | Yes | Yes | -| TLS\_ECDHE\_RSA\_WITH\_AES\_128\_CBC\_SHA256 | 1\.2 | 19c, 21c | Yes | Yes | -| TLS\_ECDHE\_RSA\_WITH\_AES\_256\_CBC\_SHA | 1\.2 | 19c, 21c | Yes | Yes | -| TLS\_ECDHE\_RSA\_WITH\_AES\_128\_CBC\_SHA | 1\.2 | 19c, 21c | Yes | Yes | - -## FIPS support - -RDS for Oracle allows you to use the Federal Information Processing Standard \(FIPS\) standard for 140\-2\. FIPS 140\-2 is a United States government standard that defines cryptographic module security requirements\. You turn on the FIPS standard by setting `FIPS.SSLFIPS_140` to `TRUE` for the Oracle SSL option\. When FIPS 140\-2 is configured for SSL, the cryptographic libraries encrypt data between the client and the RDS for Oracle DB instance\. - -Clients must use the cipher suite that is FIPS\-compliant\. When establishing a connection, the client and RDS for Oracle DB instance negotiate which cipher suite to use when transmitting messages back and forth\. The following table shows the FIPS\-compliant SSL cipher suites for each TLS version\. For more information, see [Oracle database FIPS 140\-2 settings](https://docs.oracle.com/en/database/oracle/oracle-database/12.2/dbseg/oracle-database-fips-140-settings.html#GUID-DDBEB3F9-B216-44BB-8C18-43B5E468CBBB) in the Oracle documentation\. - -## Adding the SSL option - -To use SSL, your RDS for Oracle DB instance must be associated with an option group that includes the `SSL` option\. - -### Console - -**To add the SSL option to an option group** - -1. Create a new option group or identify an existing option group to which you can add the `SSL` option\. - - For information about creating an option group, see [Creating an option group](USER_WorkingWithOptionGroups.md#USER_WorkingWithOptionGroups.Create)\. - -1. Add the `SSL` option to the option group\. - - If you want to use only FIPS\-verified cipher suites for SSL connections, set the option `FIPS.SSLFIPS_140` to `TRUE`\. For information about the FIPS standard, see [FIPS support](#Appendix.Oracle.Options.SSL.FIPS)\. - - For information about adding an option to an option group, see [Adding an option to an option group](USER_WorkingWithOptionGroups.md#USER_WorkingWithOptionGroups.AddOption)\. - -1. Create a new RDS for Oracle DB instance and associate the option group with it, or modify an RDS for Oracle DB instance to associate the option group with it\. - - For information about creating an DB instance, see [Creating an Amazon RDS DB instance](USER_CreateDBInstance.md)\. - - For information about modifying an DB instance, see [Modifying an Amazon RDS DB instance](Overview.DBInstance.Modifying.md)\. - -### AWS CLI - -**To add the SSL option to an option group** - -1. Create a new option group or identify an existing option group to which you can add the `SSL` option\. - - For information about creating an option group, see [Creating an option group](USER_WorkingWithOptionGroups.md#USER_WorkingWithOptionGroups.Create)\. - -1. Add the `SSL` option to the option group\. - - Specify the following option settings: - + `Port` – The SSL port number - + `VpcSecurityGroupMemberships` – The VPC security group for which the option is enabled - + `SQLNET.SSL_VERSION` – The TLS version that client can use to connect to the DB instance - - For example, the following AWS CLI command adds the `SSL` option to an option group named `ora-option-group`\. -**Example** - - For Linux, macOS, or Unix: - - ``` - aws rds add-option-to-option-group --option-group-name ora-option-group \ - --options 'OptionName=SSL,Port=2484,VpcSecurityGroupMemberships="sg-68184619",OptionSettings=[{Name=SQLNET.SSL_VERSION,Value=1.0}]' - ``` - - For Windows: - - ``` - aws rds add-option-to-option-group --option-group-name ora-option-group ^ - --options 'OptionName=SSL,Port=2484,VpcSecurityGroupMemberships="sg-68184619",OptionSettings=[{Name=SQLNET.SSL_VERSION,Value=1.0}]' - ``` - -1. Create a new RDS for Oracle DB instance and associate the option group with it, or modify an RDS for Oracle DB instance to associate the option group with it\. - - For information about creating an DB instance, see [Creating an Amazon RDS DB instance](USER_CreateDBInstance.md)\. - - For information about modifying an DB instance, see [Modifying an Amazon RDS DB instance](Overview.DBInstance.Modifying.md)\. - -## Configuring SQL\*Plus to use SSL with an RDS for Oracle DB instance - -Before you can connect to an RDS for Oracle DB instance that uses the Oracle SSL option, you must configure SQL\*Plus before connecting\. - -**Note** -To allow access to the DB instance from the appropriate clients, ensure that your security groups are configured correctly\. For more information, see [Controlling access with security groups](Overview.RDSSecurityGroups.md)\. Also, these instructions are for SQL\*Plus and other clients that directly use an Oracle home\. For JDBC connections, see [Setting up an SSL connection over JDBC](#Appendix.Oracle.Options.SSL.JDBC)\. - -**To configure SQL\*Plus to use SSL to connect to an RDS for Oracle DB instance** - -1. Set the `ORACLE_HOME` environment variable to the location of your Oracle home directory\. - - The path to your Oracle home directory depends on your installation\. The following example sets the `ORACLE_HOME` environment variable\. - - ``` - prompt>export ORACLE_HOME=/home/user/app/user/product/12.1.0/dbhome_1 - ``` - - For information about setting Oracle environment variables, see [SQL\*Plus environment variables](http://docs.oracle.com/database/121/SQPUG/ch_two.htm#SQPUG331) in the Oracle documentation, and also see the Oracle installation guide for your operating system\. - -1. Append `$ORACLE_HOME/lib` to the `LD_LIBRARY_PATH` environment variable\. - - The following is an example that sets the LD\_LIBRARY\_PATH environment variable\. - - ``` - prompt>export LD_LIBRARY_PATH=$LD_LIBRARY_PATH:$ORACLE_HOME/lib - ``` - -1. Create a directory for the Oracle wallet at `$ORACLE_HOME/ssl_wallet`\. - - The following is an example that creates the Oracle wallet directory\. - - ``` - prompt>mkdir $ORACLE_HOME/ssl_wallet - ``` - -1. Download the root certificate that works for all AWS Regions and put the file in the ssl\_wallet directory\. - - For information about downloading the root certificate, see [Using SSL/TLS to encrypt a connection to a DB instance](UsingWithRDS.SSL.md)\. - -1. In the `$ORACLE_HOME/network/admin` directory, modify or create the `tnsnames.ora` file and include the following entry\. - - ``` - net_service_name = - (DESCRIPTION = - (ADDRESS_LIST = - (ADDRESS = - (PROTOCOL = TCPS) - (HOST = endpoint) - (PORT = ssl_port_number) - ) - ) - (CONNECT_DATA = - (SID = database_name) - ) - (SECURITY = - (SSL_SERVER_CERT_DN = "C=US,ST=Washington,L=Seattle,O=Amazon.com,OU=RDS,CN=endpoint") - ) - ) - ``` - -1. In the same directory, modify or create the sqlnet\.ora file and include the following parameters\. -**Note** -To communicate with entities over a TLS secured connection, Oracle requires a wallet with the necessary certificates for authentication\. You can use Oracle's ORAPKI utility to create and maintain Oracle wallets, as shown in step 7\. For more information, see [Setting up Oracle wallet using ORAPKI](https://docs.oracle.com/cd/E92519_02/pt856pbr3/eng/pt/tsvt/task_SettingUpOracleWalletUsingORAPKI.html) in the Oracle documentation\. - - ``` - WALLET_LOCATION = (SOURCE = (METHOD = FILE) (METHOD_DATA = (DIRECTORY = $ORACLE_HOME/ssl_wallet))) - SSL_CLIENT_AUTHENTICATION = FALSE - SSL_VERSION = 1.0 - SSL_CIPHER_SUITES = (SSL_RSA_WITH_AES_256_CBC_SHA) - SSL_SERVER_DN_MATCH = ON - ``` -**Note** -You can set `SSL_VERSION` to a higher value if your DB instance supports it\. - -1. Run the following commands to create the Oracle wallet\. - - ``` - prompt>orapki wallet create -wallet $ORACLE_HOME/ssl_wallet -auto_login_only   - - prompt>orapki wallet add -wallet $ORACLE_HOME/ssl_wallet -trusted_cert -cert - $ORACLE_HOME/ssl_wallet/rds-ca-2019-root.pem -auto_login_only - ``` - - Replace the file name with the one you downloaded\. - -## Connecting to an RDS for Oracle DB instance using SSL - -After you configure SQL\*Plus to use SSL as described previously, you can connect to the RDS for Oracle DB instance with the SSL option\. Optionally, you can first export the `TNS_ADMIN` value that points to the directory that contains the tnsnames\.ora and sqlnet\.ora files\. Doing so ensures that SQL\*Plus can find these files consistently\. The following example exports the `TNS_ADMIN` value\. - -``` -export TNS_ADMIN = ${ORACLE_HOME}/network/admin -``` - -Connect to the DB instance\. For example, you can connect using SQL\*Plus and a ** in a tnsnames\.ora file\. - -``` -sqlplus mydbuser@net_service_name -``` - -You can also connect to the DB instance using SQL\*Plus without using a tnsnames\.ora file by using the following command\. - -``` -sqlplus 'mydbuser@(DESCRIPTION = (ADDRESS = (PROTOCOL = TCPS)(HOST = endpoint) (PORT = ssl_port_number))(CONNECT_DATA = (SID = database_name)))' -``` - -You can also connect to the RDS for Oracle DB instance without using SSL\. For example, the following command connects to the DB instance through the clear text port without SSL encryption\. - -``` -sqlplus 'mydbuser@(DESCRIPTION = (ADDRESS = (PROTOCOL = TCP)(HOST = endpoint) (PORT = port_number))(CONNECT_DATA = (SID = database_name)))' -``` - -If you want to close Transmission Control Protocol \(TCP\) port access, create a security group with no IP address ingresses and add it to the instance\. This addition closes connections over the TCP port, while still allowing connections over the SSL port that are specified from IP addresses within the range permitted by the SSL option security group\. - -## Setting up an SSL connection over JDBC - -To use an SSL connection over JDBC, you must create a keystore, trust the Amazon RDS root CA certificate, and use the code snippet specified following\. - -To create the keystore in JKS format, use the following command\. For more information about creating the keystore, see the [Oracle documentation](https://docs.oracle.com/cd/E19509-01/820-3503/ggfen/index.html)\. - -``` -keytool -keystore clientkeystore -genkey -alias client -``` - -Next, take the following steps to trust the Amazon RDS root CA certificate\. - -**To trust the Amazon RDS root CA certificate** - -1. Download the root certificate that works for all AWS Regions and put the file in the ssl\_wallet directory\. - - For information about downloading the root certificate, see [Using SSL/TLS to encrypt a connection to a DB instance](UsingWithRDS.SSL.md)\. - -1. Convert the certificate to \.der format using the following command\. - - ``` - openssl x509 -outform der -in rds-ca-2019-root.pem -out rds-ca-2019-root.der - ``` - - Replace the file name with the one you downloaded\. - -1. Import the certificate into the keystore using the following command\. - - ``` - keytool -import -alias rds-root -keystore clientkeystore.jks -file rds-ca-2019-root.der - ``` - -1. Confirm that the key store was created successfully\. - - ``` - keytool -list -v -keystore clientkeystore.jks - ``` - - Enter the keystore password when you are prompted for it\. - -The following code example shows how to set up the SSL connection using JDBC\. - -``` -import java.sql.Connection; -import java.sql.DriverManager; -import java.sql.SQLException; -import java.util.Properties; - -public class OracleSslConnectionTest { - private static final String DB_SERVER_NAME = "dns-name-provided-by-amazon-rds"; - private static final Integer SSL_PORT = "ssl-option-port-configured-in-option-group"; - private static final String DB_SID = "oracle-sid"; - private static final String DB_USER = "user-name"; - private static final String DB_PASSWORD = "password"; - // This key store has only the prod root ca. - private static final String KEY_STORE_FILE_PATH = "file-path-to-keystore"; - private static final String KEY_STORE_PASS = "keystore-password"; - - public static void main(String[] args) throws SQLException { - final Properties properties = new Properties(); - final String connectionString = String.format( - "jdbc:oracle:thin:@(DESCRIPTION=(ADDRESS=(PROTOCOL=TCPS)(HOST=%s)(PORT=%d))(CONNECT_DATA=(SID=%s)))", - DB_SERVER_NAME, SSL_PORT, DB_SID); - properties.put("user", DB_USER); - properties.put("password", DB_PASSWORD); - properties.put("oracle.jdbc.J2EE13Compliant", "true"); - properties.put("javax.net.ssl.trustStore", KEY_STORE_FILE_PATH); - properties.put("javax.net.ssl.trustStoreType", "JKS"); - properties.put("javax.net.ssl.trustStorePassword", KEY_STORE_PASS); - final Connection connection = DriverManager.getConnection(connectionString, properties); - // If no exception, that means handshake has passed, and an SSL connection can be opened - } -} -``` - -## Enforcing a DN match with an SSL connection - -You can use the Oracle parameter `SSL_SERVER_DN_MATCH` to enforce that the distinguished name \(DN\) for the database server matches its service name\. If you enforce the match verifications, then SSL ensures that the certificate is from the server\. If you don't enforce the match verification, then SSL performs the check but allows the connection, regardless if there is a match\. If you do not enforce the match, you allow the server to potentially fake its identify\. - -To enforce DN matching, add the DN match property and use the connection string specified below\. - -Add the property to the client connection to enforce DN matching\. - -``` -properties.put("oracle.net.ssl_server_dn_match", "TRUE"); -``` - -Use the following connection string to enforce DN matching when using SSL\. - -``` -final String connectionString = String.format( - "jdbc:oracle:thin:@(DESCRIPTION=(ADDRESS=(PROTOCOL=TCPS)(HOST=%s)(PORT=%d))" + - "(CONNECT_DATA=(SID=%s))" + - "(SECURITY = (SSL_SERVER_CERT_DN = -\"C=US,ST=Washington,L=Seattle,O=Amazon.com,OU=RDS,CN=%s\")))", - DB_SERVER_NAME, SSL_PORT, DB_SID, DB_SERVER_NAME); -``` - -## Troubleshooting SSL connections - -You might query your database and receive the `ORA-28860` error\. - -``` -ORA-28860: Fatal SSL error -28860. 00000 - "Fatal SSL error" -*Cause: An error occurred during the SSL connection to the peer. It is likely that this side sent data which the peer rejected. -*Action: Enable tracing to determine the exact cause of this error. -``` - -This error occurs when the client attempts to connect using a version of TLS that the server doesn't support\. To avoid this error, edit the sqlnet\.ora and set `SSL_VERSION` to the correct TLS version\. For more information, see [Oracle Support Document 2748438\.1](https://support.oracle.com/epmos/faces/DocumentDisplay?id=2748438.1) in My Oracle Support\. \ No newline at end of file diff --git a/doc_source/Appendix.Oracle.Options.Statspack.md b/doc_source/Appendix.Oracle.Options.Statspack.md deleted file mode 100644 index 77c7fd5..0000000 --- a/doc_source/Appendix.Oracle.Options.Statspack.md +++ /dev/null @@ -1,131 +0,0 @@ -# Oracle Statspack - -The Oracle Statspack option installs and enables the Oracle Statspack performance statistics feature\. Oracle Statspack is a collection of SQL, PL/SQL, and SQL\*Plus scripts that collect, store, and display performance data\. For information about using Oracle Statspack, see [Oracle Statspack](http://docs.oracle.com/cd/E13160_01/wli/docs10gr3/dbtuning/statsApdx.html) in the Oracle documentation\. - -**Note** -Oracle Statspack is no longer supported by Oracle and has been replaced by the more advanced Automatic Workload Repository \(AWR\)\. AWR is available only for Oracle Enterprise Edition customers who have purchased the Diagnostics Pack\. You can use Oracle Statspack with any Oracle DB engine on Amazon RDS\. You can't run Oracle Statspack on Amazon RDS read replicas\. - -## Setting up Oracle Statspack - -To run Statspack scripts, you must add the Statspack option\. - -**To set up Oracle Statspack** - -1. In a SQL client, log in to the Oracle DB with an administrative account\. - -1. Do either of the following actions, depending on whether Statspack is installed: - + If Statspack is installed, and the `PERFSTAT` account is associated with Statspack, skip to Step 4\. - + If Statspack is not installed, and the `PERFSTAT` account exists, drop the account as follows: - - ``` - DROP USER PERFSTAT CASCADE; - ``` - - Otherwise, attempting to add the Statspack option generates an error and `RDS-Event-0058`\. - -1. Add the Statspack option to an option group\. See [Adding an option to an option group](USER_WorkingWithOptionGroups.md#USER_WorkingWithOptionGroups.AddOption)\. - - Amazon RDS automatically installs the Statspack scripts on the DB instance and then sets up the `PERFSTAT` account\. - -1. Reset the password using the following SQL statement, replacing *pwd* with your new password: - - ``` - ALTER USER PERFSTAT IDENTIFIED BY pwd ACCOUNT UNLOCK; - ``` - - You can log in using the `PERFSTAT` user account and run the Statspack scripts\. - -1. Do either of the following actions, depending on your DB engine version: - + If you are using Oracle Database 12c Release 2 \(12\.2\) or lower, skip this step\. - + If you are using Oracle Database 19c or higher, grant the `CREATE JOB` privilege to the `PERFSTAT` account using the following statement: - - ``` - GRANT CREATE JOB TO PERFSTAT; - ``` - -1. Ensure that idle wait events in the `PERFSTAT.STATS$IDLE_EVENT` table are populated\. - - Because of Oracle Bug 28523746, the idle wait events in `PERFSTAT.STATS$IDLE_EVENT` may not be populated\. To ensure all idle events are available, run the following statement: - - ``` - INSERT INTO PERFSTAT.STATS$IDLE_EVENT (EVENT) - SELECT NAME FROM V$EVENT_NAME WHERE WAIT_CLASS='Idle' - MINUS - SELECT EVENT FROM PERFSTAT.STATS$IDLE_EVENT; - COMMIT; - ``` - -## Generating Statspack reports - -A Statspack report compares two snapshots\. - -**To generate Statspack reports** - -1. In a SQL client, log in to the Oracle DB with the `PERFSTAT` account\. - -1. Create a snapshot using either of the following techniques: - + Create a Statspack snapshot manually\. - + Create a job that takes a Statspack snapshot after a given time interval\. For example, the following job creates a Statspack snapshot every hour: - - ``` - VARIABLE jn NUMBER; - exec dbms_job.submit(:jn, 'statspack.snap;',SYSDATE,'TRUNC(SYSDATE+1/24,''HH24'')'); - COMMIT; - ``` - -1. View the snapshots using the following query: - - ``` - SELECT SNAP_ID, SNAP_TIME FROM STATS$SNAPSHOT ORDER BY 1; - ``` - -1. Run the Amazon RDS procedure `rdsadmin.rds_run_spreport`, replacing *begin\_snap* and *end\_snap* with the snapshot IDs: - - ``` - exec rdsadmin.rds_run_spreport(begin_snap,end_snap); - ``` - - For example, the following command creates a report based on the interval between Statspack snapshots 1 and 2: - - ``` - exec rdsadmin.rds_run_spreport(1,2); - ``` - - The file name of the Statspack report includes the number of the two snapshots\. For example, a report file created using Statspack snapshots 1 and 2 would be named `ORCL_spreport_1_2.lst`\. - -1. Monitor the output for errors\. - - Oracle Statspack performs checks before running the report\. Therefore, you could also see error messages in the command output\. For example, you might try to generate a report based on an invalid range, where the beginning Statspack snapshot value is larger than the ending value\. In this case, the output shows the error message, but the DB engine does not generate an error file\. - - ``` - exec rdsadmin.rds_run_spreport(2,1); - * - ERROR at line 1: - ORA-20000: Invalid snapshot IDs. Find valid ones in perfstat.stats$snapshot. - ``` - - If you use an invalid number a Statspack snapshot, the output shows an error\. For example, if you try to generate a report for snapshots 1 and 50, but snapshot 50 doesn't exist, the output shows an error\. - - ``` - exec rdsadmin.rds_run_spreport(1,50); - * - ERROR at line 1: - ORA-20000: Could not find both snapshot IDs - ``` - -1. \(Optional\) - - To retrieve the report, call the trace file procedures, as explained in [Working with Oracle trace files](USER_LogAccess.Concepts.Oracle.md#USER_LogAccess.Concepts.Oracle.WorkingWithTracefiles)\. - - Alternatively, download the Statspack report from the RDS console\. Go to the **Log** section of the DB instance details and choose **Download**: -![\[Image NOT FOUND\]](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/images/statspack1.png) - - If an error occurs while generating a report, the DB engine uses the same naming conventions as for a report but with an extension of \.err\. For example, if an error occurred while creating a report using Statspack snapshots 1 and 7, the report file would be named `ORCL_spreport_1_7.err`\. You can download the error report using the same techniques as for a standard Snapshot report\. - -## Removing Statspack files - -To remove Oracle Statspack files, use the following command: - -``` -exec statspack.purge(begin snap, end snap); -``` \ No newline at end of file diff --git a/doc_source/Appendix.Oracle.Options.Timezone-file-autoupgrade.md b/doc_source/Appendix.Oracle.Options.Timezone-file-autoupgrade.md deleted file mode 100644 index 1829d9b..0000000 --- a/doc_source/Appendix.Oracle.Options.Timezone-file-autoupgrade.md +++ /dev/null @@ -1,248 +0,0 @@ -# Oracle time zone file autoupgrade - -With the `TIMEZONE_FILE_AUTOUPGRADE` option, you can upgrade the current time zone file to the latest version on your DB instance\. - -**Topics** -+ [Overview of Oracle time zone files](#Appendix.Oracle.Options.Timezone-file-autoupgrade.tz-overview) -+ [Strategies for updating your time zone file](#Appendix.Oracle.Options.Timezone-file-autoupgrade.strategies) -+ [Downtime during the time zone file update](#Appendix.Oracle.Options.Timezone-file-autoupgrade.considerations) -+ [Preparing to update the time zone file](#Appendix.Oracle.Options.Timezone-file-autoupgrade.preparing) -+ [Adding the time zone file autoupgrade option](#Appendix.Oracle.Options.Timezone-file-autoupgrade.adding) -+ [Checking your data after the update of the time zone file](#Appendix.Oracle.Options.Timezone-file-autoupgrade.checking) - -## Overview of Oracle time zone files - -An Oracle Database *time zone file* stores the following information: -+ Offset from Coordinated Universal Time \(UTC\) -+ Transition times for Daylight Saving Time \(DST\) -+ Abbreviations for standard time and DST - -Oracle Database supplies multiple versions of time zone files\. When you create an Oracle database in an on\-premises environment, you choose the time zone file version\. For more information , see [Choosing a Time Zone File](https://docs.oracle.com/en/database/oracle/oracle-database/19/nlspg/datetime-data-types-and-time-zone-support.html#GUID-805AB986-DE12-4FEA-AF56-5AABCD2132DF) in the *Oracle Database Globalization Support Guide*\. - -If the rules change for DST, Oracle publishes new time zone files\. Oracle releases these new time zone files independently of the schedule for quarterly RUs and RURs\. The time zone files reside on the database host in the directory `$ORACLE_HOME/oracore/zoneinfo/`\. The time zone file names use the format DSTv*version*, as in DSTv35\. - -### How the time zone file affects data transfer - -In Oracle Database, the `TIMESTAMP WITH TIME ZONE` data type stores time stamp and time zone data\. Data with the `TIMESTAMP WITH TIME ZONE` data type uses the rules in the associated time zone file version\. Thus, the existing data is affected when you update the time zone file\. - -Problems can occur when you transfer data between databases that use different versions of the time zone file\. For example, if you try to import data from a source database with a higher time zone file version than the target database, you receive the `ORA-39405` error\. Previously, you had to work around this error by using either of the following techniques: -+ Create an RDS for Oracle DB instance with the desired time zone file, export data from your source database, and then import it into the new database\. -+ Use AWS DMS or logical replication to migrate your data\. - -### Automatic updates using the TIMEZONE\_FILE\_AUTOUPGRADE option - -When you add the `TIMEZONE_FILE_AUTOUPGRADE` option in RDS for Oracle, RDS updates your time zone files automatically\. By ensuring that your databases use the same time zone file version, you avoid time\-consuming manual techniques when you move data between different environments\. - -When you add the `TIMESTAMP WITH TIME ZONE` option to your option group, you can choose whether to add the option immediately or during the maintenance window\. After your DB instance uses the new option, RDS checks whether it can install a newer DSTv*version* file\. The target DSTv*version* depends on the following: -+ The minor engine version that your DB instance is currently running -+ The minor engine version to which you want to upgrade your DB instance - -For example, if your current time zone file version is DSTv33, RDS might determine that DSTv34 is currently available on your DB instance file system\. In this case, when you add the `TIMESTAMP WITH TIME ZONE` option, RDS immediately updates your time zone file to DSTv34\. - -To find the available DST versions in the supported RDS release updates, look at the patches in [Release notes for Amazon Relational Database Service \(Amazon RDS\) for Oracle](https://docs.aws.amazon.com/AmazonRDS/latest/OracleReleaseNotes/Welcome.html)\. For example, [version 19\.0\.0\.0\.ru\-2022\-10\.rur\-2022\-10\.r1](https://docs.aws.amazon.com/AmazonRDS/latest/OracleReleaseNotes/oracle-version-19-0.html#oracle-version-RU-RUR.19.0.0.0.ru-2022-10.rur-2022-10.r1) lists patch 34533061: RDBMS \- DSTV39 UPDATE \- TZDATA2022C\. - -## Strategies for updating your time zone file - -You can upgrade your DB engine and update your time zone file independently\. Thus, you must choose among different update strategies, depending on whether you want to upgrade your database and time zone file at the same time\. - -The examples in this section assume the following: -+ You have not yet added `TIMEZONE_FILE_AUTOUPGRADE` to the option group used by your DB instance\. -+ Your DB instance uses database version 19\.0\.0\.0\.ru\-2019\-07\.rur\-2019\-07\.r1 and time zone file DSTv33\. -+ Your DB instance file system includes file DSTv34\. -+ Release update 19\.0\.0\.0\.ru\-2022\-10\.rur\-2022\-10\.r1 includes DSTv35\. - -To update your time zone file, you can use the following strategies\. - -**Topics** -+ [Update the time zone file without upgrading the engine](#Appendix.Oracle.Options.Timezone-file-autoupgrade.strategies.no-upgrade) -+ [Upgrade the time zone file and DB engine version](#Appendix.Oracle.Options.Timezone-file-autoupgrade.strategies.upgrade) -+ [Upgrade your DB engine version without updating the time zone file](#Appendix.Oracle.Options.Timezone-file-autoupgrade.strategies.upgrade-only) - -### Update the time zone file without upgrading the engine - -In this scenario, your database is using DSTv33, but DSTv34 is available on your DB instance file system\. You want to update the time zone file used by your DB instance from DSTv33 to DSTv34, but you don't want to upgrade your engine to a new minor version, which includes DSTv35\. In your modify DB instance operation, do the following: -+ Add `TIMEZONE_FILE_AUTOUPGRADE` to the option group used by your DB instance\. Specify whether to add the option immediately or defer it to the maintenance window\. -+ Don’t change your engine version\. - -After the `TIMEZONE_FILE_AUTOUPGRADE` option is applied, RDS checks for a new DST version, sees that DSTv34 is available on the file system, and immediately starts the update\. - -### Upgrade the time zone file and DB engine version - -In this scenario, your database is using DSTv33, but DSTv34 is available on your DB instance file system\. You want to upgrade your DB engine to minor version 19\.0\.0\.0\.ru\-2022\-10\.rur\-2022\-10\.r1, which includes DSTv35, and update your time zone file to DSTv35 during the engine upgrade\. Thus, your goal is to skip DSTv34 and update your time zone files directly to DSTv35\. In your modify DB instance operation, do the following: -+ Add `TIMEZONE_FILE_AUTOUPGRADE` to the option group used by your DB instance\. Specify whether to add the option immediately or defer it to the maintenance window\. -+ Change your minor engine version\. - -After the `TIMEZONE_FILE_AUTOUPGRADE` option is applied, RDS checks for a new DST version, sees that DSTv35 is available in 19\.0\.0\.0\.ru\-2022\-10\.rur\-2022\-10\.r1, and immediately starts the update to DSTv35\. At the same time, RDS upgrades your DB engine to version 19\.0\.0\.0\.ru\-2022\-10\.rur\-2022\-10\.r1\. - -### Upgrade your DB engine version without updating the time zone file - -In this scenario, your database is using DSTv33, but DSTv34 is available on your DB instance file system\. You want to upgrade your DB engine to version 19\.0\.0\.0\.ru\-2022\-10\.rur\-2022\-10\.r1, which includes DSTv35, but retain time zone file DSTv33\. You might choose this strategy for the following reasons: -+ Your data doesn't use the `TIMESTAMP WITH TIME ZONE` data type\. -+ Your data uses the `TIMESTAMP WITH TIME ZONE` data type, but your data is not affected by the time zone changes\. -+ You want to postpone updating the time zone file because you can't tolerate the extra downtime\. - -Your strategy depends on which of the following possibilities are true: -+ Your DB instance isn't associated with an option group that includes `TIMEZONE_FILE_AUTOUPGRADE`\. Leave your option group as it is so that RDS doesn't update your time zone file\. -+ Your DB instance is associated with an option group that includes `TIMEZONE_FILE_AUTOUPGRADE`\. Associate your DB instance with an option group that doesn't include `TIMEZONE_FILE_AUTOUPGRADE`, and then upgrade your DB engine to 19\.0\.0\.0\.ru\-2022\-10\.rur\-2022\-10\.r1\. - -## Downtime during the time zone file update - -When RDS updates your time zone file, existing data that uses `TIMESTAMP WITH TIME ZONE` might change\. In this case, your primary consideration is downtime\. - -**Warning** -If you add the `TIMEZONE_FILE_AUTOUPGRADE` option, your engine upgrade might have prolonged downtime\. Updating time zone data for a large database might take hours or even days\. - -The length of the time zone file update depends on factors such as the following: -+ The amount of `TIMESTAMP WITH TIME ZONE` data in your database -+ The DB instance configuration -+ The DB instance class -+ The storage configuration -+ The database configuration -+ The database parameter settings - -Additional downtime can occur when you do the following: -+ Add the option to the option group when the DB instance uses an outdated time zone file -+ Upgrade the Oracle database engine when the new engine version contains a new version of the time zone file - -**Note** -During the time zone file update, RDS for Oracle calls `PURGE DBA_RECYCLEBIN`\. - -## Preparing to update the time zone file - -A time zone file upgrade has two separate phases: prepare and upgrade\. While not required, we strongly recommend that you perform the prepare step\. In this step, you find out which data will be affected by running the PL/SQL procedure `DBMS_DST.FIND_AFFECTED_TABLES`\. For more information about the prepare window, see [Upgrading the Time Zone File and Timestamp with Time Zone Data](https://docs.oracle.com/en/database/oracle/oracle-database/19/nlspg/datetime-data-types-and-time-zone-support.html#GUID-B0ACDB2E-4B49-4EB4-B4CC-9260DAE1567A) in the Oracle Database documentation\. - -**To prepare to update the time zone file** - -1. Connect to your Oracle database using a SQL client\. - -1. Determine the current timezone file version used\. - - ``` - SELECT * FROM V$TIMEZONE_FILE; - ``` - -1. Determine the latest timezone file version available on your DB instance\. This step is only applicable if you use Oracle Database 12c Release 2 \(12\.2\) or higher\. - - ``` - SELECT DBMS_DST.GET_LATEST_TIMEZONE_VERSION FROM DUAL; - ``` - -1. Determine the total size of tables that have columns of type `TIMESTAMP WITH LOCAL TIME ZONE` or `TIMESTAMP WITH TIME ZONE`\. - - ``` - SELECT SUM(BYTES)/1024/1024/1024 "Total_size_w_TSTZ_columns_GB" - FROM DBA_SEGMENTS - WHERE SEGMENT_TYPE LIKE 'TABLE%' - AND (OWNER, SEGMENT_NAME) IN - (SELECT OWNER, TABLE_NAME - FROM DBA_TAB_COLUMNS - WHERE DATA_TYPE LIKE 'TIMESTAMP%TIME ZONE'); - ``` - -1. Determine the names and sizes of segments that have columns of type `TIMESTAMP WITH LOCAL TIME ZONE` or `TIMESTAMP WITH TIME ZONE`\. - - ``` - SELECT OWNER, SEGMENT_NAME, SUM(BYTES)/1024/1024/1024 "SEGMENT_SIZE_W_TSTZ_COLUMNS_GB" - FROM DBA_SEGMENTS - WHERE SEGMENT_TYPE LIKE 'TABLE%' - AND (OWNER, SEGMENT_NAME) IN - (SELECT OWNER, TABLE_NAME - FROM DBA_TAB_COLUMNS - WHERE DATA_TYPE LIKE 'TIMESTAMP%TIME ZONE') - GROUP BY OWNER, SEGMENT_NAME; - ``` - -1. Run the prepare step\. - + The procedure `DBMS_DST.CREATE_AFFECTED_TABLE` creates a table to store any affected data\. You pass the name of this table to the `DBMS_DST.FIND_AFFECTED_TABLES` procedure\. For more information, see [CREATE\_AFFECTED\_TABLE Procedure](https://docs.oracle.com/en/database/oracle/oracle-database/19/arpls/DBMS_DST.html#GUID-C53BAABA-914A-404C-9CD5-823257BE0B00) in the Oracle Database documentation\. - + This procedure `CREATE_ERROR_TABLE` creates a table to log errors\. For more information, see [CREATE\_ERROR\_TABLE Procedure](https://docs.oracle.com/en/database/oracle/oracle-database/19/arpls/DBMS_DST.html#GUID-6A7EA024-B02D-4486-B1D6-EF6ABF5DE507) in the Oracle Database documentation\. - - The following example creates the affected data and error tables, and finds all affected tables\. - - ``` - EXEC DBMS_DST.CREATE_ERROR_TABLE('my_error_table') - EXEC DBMS_DST.CREATE_AFFECTED_TABLE('my_affected_table') - - EXEC DBMS_DST.BEGIN_PREPARE(new_version); - EXEC DBMS_DST.FIND_AFFECTED_TABLES('my_affected_table', TRUE, 'my_error_table'); - EXEC DBMS_DST.END_PREPARE; - - SELECT * FROM my_affected_table; - SELECT * FROM my_error_table; - ``` - -1. Query the affected and error tables\. - - ``` - SELECT * FROM my_affected_table; - SELECT * FROM my_error_table; - ``` - -## Adding the time zone file autoupgrade option - -When you add the option to an option group, the option group is in one of the following states: -+ An existing option group is currently attached to at least one DB instance\. When you add the option, all DB instances that use this option group automatically restart\. This causes a brief outage\. -+ An existing option group is not attached to any DB instance\. You plan to add the option and then associate the existing option group with existing DB instances or with a new DB instance\. -+ You create a new option group and add the option\. You plan to associate the new option group with existing DB instances or with a new DB instance\. - -### Console - -**To add the time zone file autoupgrade option to a DB instance** - -1. Sign in to the AWS Management Console and open the Amazon RDS console at [https://console\.aws\.amazon\.com/rds/](https://console.aws.amazon.com/rds/)\. - -1. In the navigation pane, choose **Option groups**\. - -1. Determine the option group you want to use\. You can create a new option group or use an existing option group\. If you want to use an existing option group, skip to the next step\. Otherwise, create a custom DB option group with the following settings: - - 1. For **Engine** choose the Oracle Database edition for your DB instance\. - - 1. For **Major engine version** choose the version of your DB instance\. - - For more information, see [Creating an option group](USER_WorkingWithOptionGroups.md#USER_WorkingWithOptionGroups.Create)\. - -1. Choose the option group that you want to modify, and then choose **Add option**\. - -1. In the **Add option** window, do the following: - - 1. Choose **TIMEZONE\_FILE\_AUTOUPGRADE**\. - - 1. To enable the option on all associated DB instances as soon as you add it, for **Apply Immediately**, choose **Yes**\. If you choose **No** \(the default\), the option is enabled for each associated DB instance during its next maintenance window\. - -1. When the settings are as you want them, choose **Add option**\. - -### AWS CLI - -The following example uses the AWS CLI [add\-option\-to\-option\-group](https://docs.aws.amazon.com/cli/latest/reference/rds/add-option-to-option-group.html) command to add the `TIMEZONE_FILE_AUTOUPGRADE` option to an option group called `myoptiongroup`\. - -For Linux, macOS, or Unix: - -``` -aws rds add-option-to-option-group \ - --option-group-name "myoptiongroup" \ - --options "OptionName=TIMEZONE_FILE_AUTOUPGRADE" \ - --apply-immediately -``` - -For Windows: - -``` -aws rds add-option-to-option-group ^ - --option-group-name "myoptiongroup" ^ - --options "OptionName=TIMEZONE_FILE_AUTOUPGRADE" ^ - --apply-immediately -``` - -## Checking your data after the update of the time zone file - -We recommend that you check your data after you update the time zone file\. During the prepare step, RDS for Oracle automatically creates the following tables: -+ `rdsadmin.rds_dst_affected_tables` – Lists the tables that contain data affected by the update -+ `rdsadmin.rds_dst_error_table` – Lists the errors generated during the update - -These tables are independent of any tables that you create in the prepare window\. To see the results of the update, query the tables as follows\. - -``` -SELECT * FROM rdsadmin.rds_dst_affected_tables; -SELECT * FROM rdsadmin.rds_dst_error_table; -``` - -For more information about the schema for the affected data and error tables, see [FIND\_AFFECTED\_TABLES Procedure](https://docs.oracle.com/en/database/oracle/oracle-database/19/arpls/DBMS_DST.html#GUID-1F977505-671C-4D5B-8570-86956F136199) in the Oracle documentation\. \ No newline at end of file diff --git a/doc_source/Appendix.Oracle.Options.Timezone.md b/doc_source/Appendix.Oracle.Options.Timezone.md deleted file mode 100644 index df5adb8..0000000 --- a/doc_source/Appendix.Oracle.Options.Timezone.md +++ /dev/null @@ -1,127 +0,0 @@ -# Oracle time zone - -To change the system time zone used by your Oracle DB instance, use the time zone option\. For example, you might change the time zone of a DB instance to be compatible with an on\-premises environment, or a legacy application\. The time zone option changes the time zone at the host level\. Changing the time zone impacts all date columns and values, including `SYSDATE` and `SYSTIMESTAMP`\. - -The time zone option differs from the `rdsadmin_util.alter_db_time_zone` command\. The `alter_db_time_zone` command changes the time zone only for certain data types\. The time zone option changes the time zone for all date columns and values\. For more information about `alter_db_time_zone`, see [Setting the database time zone](Appendix.Oracle.CommonDBATasks.Database.md#Appendix.Oracle.CommonDBATasks.TimeZoneSupport)\. For more information about upgrade considerations, see [Time zone considerations](USER_UpgradeDBInstance.Oracle.OGPG.md#USER_UpgradeDBInstance.Oracle.OGPG.DST)\. - -## Considerations for setting the time zone - -The time zone option is a permanent and persistent option\. Therefore, you can't do the following: -+ Remove the option from an option group after you add the option\. -+ Remove the option group from a DB instance after you add the group\. -+ Modify the time zone setting of the option to a different time zone\. - -If you accidentally set the time zone incorrectly, you must recover your DB instance to its previous time zone setting\. We strongly urge you to use one of the following strategies, depending on your situation: - -Your DB instance currently uses the default option group\. In this case, complete the following steps: - -1. Take a snapshot of your DB instance\. For more information, see [Creating a DB snapshot](USER_CreateSnapshot.md)\. - -1. Add the time zone option to your DB instance\. - -Your DB instance currently uses a nondefault option group\. In this case, complete the following steps: - -1. Take a snapshot of your DB instance\. For more information, see [Creating a DB snapshot](USER_CreateSnapshot.md)\. - -1. Create a new option group with the time zone option\. - -1. Add the option group to your DB instance\. - -We strongly urge you to test the time zone option on a test DB instance before you add it to a production DB instance\. Adding the time zone option can cause problems with tables that use system date to add dates or times\. We recommend that you analyze your data and applications to assess the impact of changing the time zone\. - -## Time zone option settings - -Amazon RDS supports the following settings for the time zone option\. - - -**** - -| Option setting | Valid values | Description | -| --- | --- | --- | -| `TIME_ZONE` | One of the available time zones\. For the full list, see [Available time zones](#Appendix.Oracle.Options.Timezone.Zones)\. | The new time zone for your DB instance\. | - -## Adding the time zone option - -The general process for adding the time zone option to a DB instance is the following: - -1. Create a new option group, or copy or modify an existing option group\. - -1. Add the option to the option group\. - -1. Associate the option group with the DB instance\. - -When you add the time zone option, a brief outage occurs while your DB instance is automatically restarted\. - -### Console - -**To add the time zone option to a DB instance** - -1. Determine the option group you want to use\. You can create a new option group or use an existing option group\. If you want to use an existing option group, skip to the next step\. Otherwise, create a custom DB option group with the following settings: - - 1. For **Engine** choose the oracle edition for your DB instance\. - - 1. For **Major engine version** choose the version of your DB instance\. - - For more information, see [Creating an option group](USER_WorkingWithOptionGroups.md#USER_WorkingWithOptionGroups.Create)\. - -1. Add the **Timezone** option to the option group, and configure the option settings\. -**Important** -If you add the time zone option to an existing option group that is already attached to one or more DB instances, a brief outage occurs while all the DB instances are automatically restarted\. - - For more information about adding options, see [Adding an option to an option group](USER_WorkingWithOptionGroups.md#USER_WorkingWithOptionGroups.AddOption)\. For more information about each setting, see [Time zone option settings](#Appendix.Oracle.Options.Timezone.Options)\. - -1. Apply the option group to a new or existing DB instance: - + For a new DB instance, you apply the option group when you launch the instance\. For more information, see [Creating an Amazon RDS DB instance](USER_CreateDBInstance.md)\. - + For an existing DB instance, you apply the option group by modifying the instance and attaching the new option group\. When you add the time zone option to an existing DB instance, a brief outage occurs while your DB instance is automatically restarted\. For more information, see [Modifying an Amazon RDS DB instance](Overview.DBInstance.Modifying.md)\. - -### AWS CLI - -The following example uses the AWS CLI [add\-option\-to\-option\-group](https://docs.aws.amazon.com/cli/latest/reference/rds/add-option-to-option-group.html) command to add the `Timezone` option and the `TIME_ZONE` option setting to an option group called `myoptiongroup`\. The time zone is set to `Africa/Cairo`\. - -For Linux, macOS, or Unix: - -``` -aws rds add-option-to-option-group \ - --option-group-name "myoptiongroup" \ - --options "OptionName=Timezone,OptionSettings=[{Name=TIME_ZONE,Value=Africa/Cairo}]" \ - --apply-immediately -``` - -For Windows: - -``` -aws rds add-option-to-option-group ^ - --option-group-name "myoptiongroup" ^ - --options "OptionName=Timezone,OptionSettings=[{Name=TIME_ZONE,Value=Africa/Cairo}]" ^ - --apply-immediately -``` - -## Modifying time zone settings - -The time zone option is a permanent and persistent option\. You can't remove the option from an option group after you add it\. You can't remove the option group from a DB instance after you add it\. You can't modify the time zone setting of the option to a different time zone\. If you set the time zone incorrectly, restore a snapshot of your DB instance from before you added the time zone option\. - -## Removing the time zone option - -The time zone option is a permanent and persistent option\. You can't remove the option from an option group after you add it\. You can't remove the option group from a DB instance after you add it\. To remove the time zone option, restore a snapshot of your DB instance from before you added the time zone option\. - -## Available time zones - -You can use the following values for the time zone option\. - - -**** - -| Zone | Time zone | -| --- | --- | -| Africa | Africa/Cairo, Africa/Casablanca, Africa/Harare, Africa/Lagos, Africa/Luanda, Africa/Monrovia, Africa/Nairobi, Africa/Tripoli, Africa/Windhoek | -| America | America/Araguaina, America/Argentina/Buenos\_Aires, America/Asuncion, America/Bogota, America/Caracas, America/Chicago, America/Chihuahua, America/Cuiaba, America/Denver, America/Detroit, America/Fortaleza, America/Godthab, America/Guatemala, America/Halifax, America/Lima, America/Los\_Angeles, America/Manaus, America/Matamoros, America/Mexico\_City, America/Monterrey, America/Montevideo, America/New\_York, America/Phoenix, America/Santiago, America/Sao\_Paulo, America/Tijuana, America/Toronto | -| Asia | Asia/Amman, Asia/Ashgabat, Asia/Baghdad, Asia/Baku, Asia/Bangkok, Asia/Beirut, Asia/Calcutta, Asia/Damascus, Asia/Dhaka, Asia/Hong\_Kong, Asia/Irkutsk, Asia/Jakarta, Asia/Jerusalem, Asia/Kabul, Asia/Karachi, Asia/Kathmandu, Asia/Kolkata, Asia/Krasnoyarsk, Asia/Magadan, Asia/Manila, Asia/Muscat, Asia/Novosibirsk, Asia/Rangoon, Asia/Riyadh, Asia/Seoul, Asia/Shanghai, Asia/Singapore, Asia/Taipei, Asia/Tehran, Asia/Tokyo, Asia/Ulaanbaatar, Asia/Vladivostok, Asia/Yakutsk, Asia/Yerevan | -| Atlantic | Atlantic/Azores, Atlantic/Cape\_Verde | -| Australia | Australia/Adelaide, Australia/Brisbane, Australia/Darwin, Australia/Eucla, Australia/Hobart, Australia/Lord\_Howe, Australia/Perth, Australia/Sydney | -| Brazil | Brazil/DeNoronha, Brazil/East | -| Canada | Canada/Newfoundland, Canada/Saskatchewan | -| Etc | Etc/GMT\-3 | -| Europe | Europe/Amsterdam, Europe/Athens, Europe/Berlin, Europe/Dublin, Europe/Helsinki, Europe/Kaliningrad, Europe/London, Europe/Madrid, Europe/Moscow, Europe/Paris, Europe/Prague, Europe/Rome, Europe/Sarajevo | -| Pacific | Pacific/Apia, Pacific/Auckland, Pacific/Chatham, Pacific/Fiji, Pacific/Guam, Pacific/Honolulu, Pacific/Kiritimati, Pacific/Marquesas, Pacific/Samoa, Pacific/Tongatapu, Pacific/Wake | -| US | US/Alaska, US/Central, US/East\-Indiana, US/Eastern, US/Pacific | -| UTC | UTC | \ No newline at end of file diff --git a/doc_source/Appendix.Oracle.Options.XMLDB.md b/doc_source/Appendix.Oracle.Options.XMLDB.md deleted file mode 100644 index 5fc0594..0000000 --- a/doc_source/Appendix.Oracle.Options.XMLDB.md +++ /dev/null @@ -1,3 +0,0 @@ -# Oracle XML DB - -Oracle XML DB adds native XML support to your DB instance\. With XML DB, you can store and retrieve structured or unstructured XML, in addition to relational data\. XML DB is preinstalled on Oracle version 12c and later\. \ No newline at end of file diff --git a/doc_source/Appendix.Oracle.Options.md b/doc_source/Appendix.Oracle.Options.md deleted file mode 100644 index 32d0bc7..0000000 --- a/doc_source/Appendix.Oracle.Options.md +++ /dev/null @@ -1,25 +0,0 @@ -# Adding options to Oracle DB instances - -In Amazon RDS, an option is an additional feature\. Following, you can find a description of options that you can add to Amazon RDS instances running the Oracle DB engine\. - -**Topics** -+ [Overview of Oracle DB options](Appendix.Oracle.Options.overview.md) -+ [Amazon S3 integration](oracle-s3-integration.md) -+ [Oracle Application Express \(APEX\)](Appendix.Oracle.Options.APEX.md) -+ [Amazon EFS integration](oracle-efs-integration.md) -+ [Oracle Java virtual machine](oracle-options-java.md) -+ [Oracle Enterprise Manager](Oracle.Options.OEM.md) -+ [Oracle Label Security](Oracle.Options.OLS.md) -+ [Oracle Locator](Oracle.Options.Locator.md) -+ [Oracle Multimedia](Oracle.Options.Multimedia.md) -+ [Oracle native network encryption](Appendix.Oracle.Options.NetworkEncryption.md) -+ [Oracle OLAP](Oracle.Options.OLAP.md) -+ [Oracle Secure Sockets Layer](Appendix.Oracle.Options.SSL.md) -+ [Oracle Spatial](Oracle.Options.Spatial.md) -+ [Oracle SQLT](Oracle.Options.SQLT.md) -+ [Oracle Statspack](Appendix.Oracle.Options.Statspack.md) -+ [Oracle time zone](Appendix.Oracle.Options.Timezone.md) -+ [Oracle time zone file autoupgrade](Appendix.Oracle.Options.Timezone-file-autoupgrade.md) -+ [Oracle Transparent Data Encryption](Appendix.Oracle.Options.AdvSecurity.md) -+ [Oracle UTL\_MAIL](Oracle.Options.UTLMAIL.md) -+ [Oracle XML DB](Appendix.Oracle.Options.XMLDB.md) \ No newline at end of file diff --git a/doc_source/Appendix.Oracle.Options.overview.md b/doc_source/Appendix.Oracle.Options.overview.md deleted file mode 100644 index 08877ce..0000000 --- a/doc_source/Appendix.Oracle.Options.overview.md +++ /dev/null @@ -1,52 +0,0 @@ -# Overview of Oracle DB options - -To enable options for your Oracle database, add them to an option group, and then associate the option group with your DB instance\. For more information, see [Working with option groups](USER_WorkingWithOptionGroups.md)\. - -**Topics** -+ [Summary of Oracle Database options](#Appendix.Oracle.Options.summary) -+ [Options supported for different editions](#Appendix.Oracle.Options.editions) -+ [Memory requirements for specific options](#Appendix.Oracle.Options.memory) - -## Summary of Oracle Database options - -You can add the following options for Oracle DB instances\. - - -**** - -| Option | Option ID | -| --- | --- | -| [Amazon S3 integration](oracle-s3-integration.md) | `S3_INTEGRATION` | -| [Oracle Application Express \(APEX\)](Appendix.Oracle.Options.APEX.md) | `APEX` `APEX-DEV` | -| [Oracle Enterprise Manager](Oracle.Options.OEM.md) | `OEM` `OEM_AGENT` | -| [Oracle Java virtual machine](oracle-options-java.md) | `JVM` | -| [Oracle Label Security](Oracle.Options.OLS.md) | `OLS` | -| [Oracle Locator](Oracle.Options.Locator.md) | `LOCATOR` | -| [Oracle Multimedia](Oracle.Options.Multimedia.md) | `MULTIMEDIA` | -| [Oracle native network encryption](Appendix.Oracle.Options.NetworkEncryption.md) | `NATIVE_NETWORK_ENCRYPTION` | -| [Oracle OLAP](Oracle.Options.OLAP.md) | `OLAP` | -| [Oracle Secure Sockets Layer](Appendix.Oracle.Options.SSL.md) | `SSL` | -| [Oracle Spatial](Oracle.Options.Spatial.md) | `SPATIAL` | -| [Oracle SQLT](Oracle.Options.SQLT.md) | `SQLT` | -| [Oracle Statspack](Appendix.Oracle.Options.Statspack.md) | `STATSPACK` | -| [Oracle time zone](Appendix.Oracle.Options.Timezone.md) | `TIMEZONE` | -| [Oracle time zone file autoupgrade](Appendix.Oracle.Options.Timezone-file-autoupgrade.md) | `TIMEZONE_FILE_AUTOUPGRADE` | -| [Oracle Transparent Data Encryption](Appendix.Oracle.Options.AdvSecurity.md) | `TDE` | -| [Oracle UTL\_MAIL](Oracle.Options.UTLMAIL.md) | `UTL_MAIL` | -| [Oracle XML DB](Appendix.Oracle.Options.XMLDB.md) | `XMLDB` | - -## Options supported for different editions - -RDS for Oracle prevents you from adding options to an edition if they aren't supported\. To find out which RDS options are supported in different Oracle Database editions, use the command `aws rds describe-option-group-options`\. The following example lists supported options for Oracle Database 19c Enterprise Edition\. - -``` -aws rds describe-option-group-options \ - --engine-name oracle-ee \ - --major-engine-version 19 -``` - -For more information, see [describe\-option\-group\-options](https://docs.aws.amazon.com/cli/latest/reference/rds/describe-option-group-options.html) in the *AWS CLI Command Reference*\. - -## Memory requirements for specific options - -Some options require additional memory to run on your DB instance\. For example, Oracle Enterprise Manager Database Control uses about 300 MB of RAM\. If you enable this option for a small DB instance, you might encounter performance problems due to memory constraints\. You can adjust the Oracle parameters so that the database requires less RAM\. Alternatively, you can scale up to a larger DB instance\. \ No newline at end of file diff --git a/doc_source/Appendix.Oracle.PatchComposition.11.2.0.4.md b/doc_source/Appendix.Oracle.PatchComposition.11.2.0.4.md deleted file mode 100644 index cec8bf3..0000000 --- a/doc_source/Appendix.Oracle.PatchComposition.11.2.0.4.md +++ /dev/null @@ -1,2477 +0,0 @@ -# Database engine: 11\.2\.0\.4 - -The following versions are available for database engine 11\.2\.0\.4 -+ [Version 11\.2\.0\.4\.v26](#Appendix.Oracle.PatchComposition.11.2.0.4.v26) -+ [Version 11\.2\.0\.4\.v25](#Appendix.Oracle.PatchComposition.11.2.0.4.v25) -+ [Version 11\.2\.0\.4\.v24](#Appendix.Oracle.PatchComposition.11.2.0.4.v24) -+ [Version 11\.2\.0\.4\.v23](#Appendix.Oracle.PatchComposition.11.2.0.4.v23) -+ [Version 11\.2\.0\.4\.v22](#Appendix.Oracle.PatchComposition.11.2.0.4.v22) -+ [Version 11\.2\.0\.4\.v21](#Appendix.Oracle.PatchComposition.11.2.0.4.v21) -+ [Version 11\.2\.0\.4\.v20](#Appendix.Oracle.PatchComposition.11.2.0.4.v20) -+ [Version 11\.2\.0\.4\.v19](#Appendix.Oracle.PatchComposition.11.2.0.4.v19) -+ [Version 11\.2\.0\.4\.v18](#Appendix.Oracle.PatchComposition.11.2.0.4.v18) -+ [Version 11\.2\.0\.4\.v17](#Appendix.Oracle.PatchComposition.11.2.0.4.v17) -+ [Version 11\.2\.0\.4\.v16](#Appendix.Oracle.PatchComposition.11.2.0.4.v16) -+ [Version 11\.2\.0\.4\.v15](#Appendix.Oracle.PatchComposition.11.2.0.4.v15) -+ [Version 11\.2\.0\.4\.v14](#Appendix.Oracle.PatchComposition.11.2.0.4.v14) -+ [Version 11\.2\.0\.4\.v13](#Appendix.Oracle.PatchComposition.11.2.0.4.v13) -+ [Version 11\.2\.0\.4\.v12](#Appendix.Oracle.PatchComposition.11.2.0.4.v12) -+ [Version 11\.2\.0\.4\.v11](#Appendix.Oracle.PatchComposition.11.2.0.4.v11) -+ [Version 11\.2\.0\.4\.v10](#Appendix.Oracle.PatchComposition.11.2.0.4.v10) -+ [Version 11\.2\.0\.4\.v9](#Appendix.Oracle.PatchComposition.11.2.0.4.v9) -+ [Version 11\.2\.0\.4\.v8](#Appendix.Oracle.PatchComposition.11.2.0.4.v8) -+ [Version 11\.2\.0\.4\.v7](#Appendix.Oracle.PatchComposition.11.2.0.4.v7) -+ [Version 11\.2\.0\.4\.v6](#Appendix.Oracle.PatchComposition.11.2.0.4.v6) -+ [Version 11\.2\.0\.4\.v5](#Appendix.Oracle.PatchComposition.11.2.0.4.v5) -+ [Version 11\.2\.0\.4\.v4](#Appendix.Oracle.PatchComposition.11.2.0.4.v4) -+ [Version 11\.2\.0\.4\.v3](#Appendix.Oracle.PatchComposition.11.2.0.4.v3) -+ [Version 11\.2\.0\.4\.v2 \(deprecated\)](#Appendix.Oracle.PatchComposition.11.2.0.4.v2) -+ [Version 11\.2\.0\.4\.v1](#Appendix.Oracle.PatchComposition.11.2.0.4.v1) - -**Important** -RDS for Oracle Database 11g is no longer supported\. This information is only useful if you want to upgrade an Oracle Database 11g snapshot\. - -## Version 11\.2\.0\.4\.v26 - -**Important** -This patch is currently available only for Oracle Database Enterprise Edition\. - -Version 11\.2\.0\.4\.v26 includes the following: -+ Patch 31537677: Oracle Database Patch Set Update 11\.2\.0\.4\.201020 -+ Patch 31668908: Oracle JavaVM Component 11\.2\.0\.4\.201020 Database PSU -+ Patch 22188219: "L1 VALIDATION" WAIT EVENT USED TO BACK OFF WHEN HW ENQUEUE CANNOT BE ACQUIRED -+ Oracle GoldenGate \- Oracle RDBMS Server Recommended Patches -+ Patch 32076719: MERGE REQUEST ON TOP OF DATABASE PSU 11\.2\.0\.4\.201020 FOR BUGS 2990912 13254780 -+ Patch 24010393: MERGE REQUEST ON TOP OF DATABASE PSU 11\.2\.0\.4\.6 FOR BUGS 12897813 21281961 -+ Patch 17031322: OCIXMLDBREWRITEXML RETURNED BIND VARIABLES ARE NOT WHITESPACE PRESERVING -+ Patch 19277336: INTEGRATED REPLICAT INVALIDATES DEPENDENT PACKAGES RESULTING IN AN ORA\-4068 -+ Patch 19306797: HEARTBEAT REDO IS NOT GENERATED NON\-RAC HOSTS WHEN SUPPLIMENTAL LOGGING ENABLED -+ Patch 19440386: FAILED TO RAISE ORA\-1 FOR PK UPDATE WHEN CONSTRAINT=IMMEDIATE -+ Patch 19563715: LOGMINER DOES NOT MAKE PROGRESS WHEN 4GB OR MORE MEMORY IS USED IN GOLDENGATE -+ Patch 20647412: EDITION NAME LOGGED WITH KNLD SHOULD BE THE CURRENT EDITION, NOT SESSION EDITION -+ Patch 26744595: LGSB:APPLY ABORTS W/ ORA\-26786 \(ROW\-EXISTS\) COLLISION WITH HCC\(PR\)\-NO HCC\(SB\) -+ Patch 12668795: ORA\-00600: \[KDUCFA:ENDBIT\] SEEN DURING XSTREAMS ONEWAY REPLICATION -+ PreUpgrade Jar: preupgrade\_19\_cbuild\_8\_lf\.zip -+ Support for [Setting and unsetting system diagnostic events](Appendix.Oracle.CommonDBATasks.System.md#Appendix.Oracle.CommonDBATasks.SystemEvents) using procedures in the `rdsadmin.rdsadmin_util` package -+ Support for the procedure `rdsadmin_util.truncate_apply$_cdr_info` described in [Integrated REPLICAT slow due to query on sys\."\_DBA\_APPLY\_CDR\_INFO"](Appendix.OracleGoldenGate.md#Appendix.OracleGoldenGate.IR) - -### Combined patches for version 11\.2\.0\.4\.v26, released November 2020 - -Bugs fixed: - -``` -2990912, 6599380, 8322815, 9756271, 10136473, 11733603, 11786053 -11883252, 12364061, 12611721, 12668795, 12747740, 12816846, 12897813 -12905058, 12982566, 13254780, 13364795, 13498382, 13558557, 13609098 -13645875, 13680635, 13829543, 13837378, 13853126, 13854364, 13866822 -13871092, 13936038, 13944971, 13951456, 13955826, 13960236, 14010183 -14015842, 14034426, 14054676, 14084247, 14106803, 14133975, 14176370 -14245531, 14285317, 14312810, 14338435, 14354737, 14368995, 14458214 -14521218, 14521849, 14565184, 14602788, 14657740, 14692762, 14705949 -14735792, 14764829, 14774730, 14786201, 14829250, 14852021, 15861775 -15913355, 15955387, 15979965, 15990359, 16042673, 16043574, 16065166 -16069901, 16091637, 16180763, 16194160, 16198143, 16220077, 16228604 -16233738, 16268425, 16285691, 16306373, 16314254, 16315398, 16344544 -16354467, 16360112, 16384983, 16392068, 16399083, 16410570, 16422541 -16450169, 16472716, 16494615, 16524926, 16538760, 16542886, 16571443 -16579084, 16595641, 16596890, 16613964, 16618694, 16668584, 16674686 -16685417, 16692232, 16721594, 16731148, 16756406, 16777840, 16785708 -16799735, 16819962, 16832076, 16833527, 16833845, 16837842, 16850630 -16854386, 16855292, 16863422, 16870214, 16875230, 16875449, 16898135 -16901385, 16903536, 16912439, 16929165, 16934803, 16941434, 16943711 -16956380, 16989630, 16992075, 17006183, 17006570, 17008068, 17011832 -17016369, 17019086, 17019345, 17019356, 17025461, 17027426, 17030189 -17031322, 17036973, 17037130, 17040527, 17040764, 17042658, 17047404 -17050888, 17056813, 17071721, 17080436, 17082359, 17082983, 17088068 -17156148, 17165204, 17174582, 17184721, 17186905, 17201047, 17201159 -17205719, 17208934, 17215560, 17227073, 17227277, 17231779, 17232014 -17235750, 17237521, 17238511, 17239687, 17242746, 17246576, 17254374 -17258090, 17258582, 17265217, 17267114, 17274537, 17279227, 17282229 -17284817, 17285560, 17288409, 17291347, 17296856, 17297939, 17299889 -17302277, 17308789, 17311728, 17313525, 17323222, 17325413, 17332800 -17341326, 17343514, 17344412, 17346091, 17346671, 17348614, 17359610 -17360606, 17365043, 17375354, 17381384, 17385178, 17389192, 17390160 -17390431, 17392698, 17393683, 17393915, 17394950, 17397545, 17432124 -17437634, 17441661, 17443671, 17446237, 17449815, 17465741, 17468141 -17477958, 17478145, 17478514, 17484731, 17484762, 17495022, 17501491 -17518652, 17528315, 17532245, 17532729, 17545847, 17546761, 17546973 -17551063, 17551674, 17551699, 17551709, 17570240, 17570606, 17571039 -17571306, 17586955, 17587063, 17588480, 17596908, 17600719, 17602269 -17610798, 17612828, 17614134, 17614227, 17621643, 17622427, 17630484 -17634921, 17643573, 17644091, 17648596, 17649265, 17655240, 17655634 -17672719, 17694209, 17695685, 17705023, 17716305, 17717883, 17721717 -17722535, 17726838, 17752121, 17752995, 17754782, 17761775, 17762296 -17767676, 17783445, 17783588, 17785870, 17786278, 17786518, 17787259 -17798953, 17801017, 17804361, 17806696, 17811429, 17811438, 17811447 -17811456, 17811789, 17816865, 17820741, 17824637, 17835048, 17835627 -17842825, 17847764, 17848897, 17851160, 17852463, 17853456, 17853498 -17865671, 17877323, 17883081, 17889549, 17889583, 17890099, 17891943 -17891946, 17892268, 17903598, 17912217, 17922254, 17936109, 17945983 -17951233, 17957017, 17982555, 17982832, 18000422, 18009564, 18018515 -18029658, 18031668, 18043064, 18051556, 18061914, 18084625, 18086801 -18090142, 18091059, 18092127, 18093615, 18094246, 18096714, 18098207 -18125929, 18135678, 18139690, 18155762, 18159793, 18166013, 18166577 -18180390, 18189036, 18191164, 18193833, 18199537, 18202441, 18203835 -18203837, 18203838, 18228645, 18230522, 18232865, 18235390, 18244962 -18247991, 18259031, 18260550, 18262334, 18264060, 18272672, 18273830 -18277454, 18280813, 18282562, 18293054, 18306996, 18308268, 18315328 -18316692, 18317531, 18325460, 18328509, 18331812, 18331850, 18334586 -18339044, 18356166, 18362222, 18373438, 18382302, 18384391, 18384537 -18388363, 18411336, 18413820, 18430495, 18436307, 18436647, 18440047 -18440095, 18441944, 18456514, 18458318, 18460587, 18471685, 18482502 -18492302, 18508861, 18510194, 18515268, 18522509, 18554763, 18554871 -18604493, 18604692, 18607546, 18610915, 18614015, 18619917, 18628388 -18641419, 18641451, 18641461, 18662619, 18673304, 18673325, 18673342 -18674024, 18674047, 18674465, 18676416, 18681862, 18682983, 18685892 -18704244, 18705484, 18723434, 18740837, 18744139, 18747196, 18759211 -18762750, 18765602, 18774543, 18783224, 18798250, 18819257, 18828868 -18832544, 18841764, 18849970, 18856106, 18856999, 18868646, 18886413 -18899974, 18933818, 18948177, 18964939, 18973548, 18973907, 18996843 -19006757, 19006849, 19007266, 19013183, 19032777, 19032867, 19049453 -19058059, 19060015, 19121551, 19153980, 19174430, 19175543, 19176885 -19187988, 19197175, 19207117, 19207156, 19211433, 19211724, 19223010 -19231857, 19258504, 19271443, 19272701, 19277336, 19285025, 19289642 -19297917, 19306797, 19309466, 19315668, 19330795, 19358317, 19359219 -19373893, 19374518, 19393542, 19396455, 19403858, 19429927, 19433930 -19440386, 19442102, 19445860, 19455741, 19458377, 19461270, 19463893 -19463897, 19466309, 19469538, 19475971, 19487147, 19490948, 19516448 -19540573, 19544839, 19554106, 19554117, 19563300, 19563715, 19578350 -19584068, 19587324, 19601228, 19601762, 19615136, 19644859, 19680952 -19689979, 19692824, 19693090, 19697993, 19699191, 19699946, 19718981 -19721304, 19727057, 19730508, 19768226, 19769489, 19777862, 19781326 -19788303, 19788842, 19791273, 19794897, 19827973, 19831647, 19835133 -19852360, 19854503, 19871910, 19888853, 19891090, 19895326, 19896336 -19909862, 19915271, 19930276, 19943771, 19972564, 19972566, 19972568 -19972569, 19972570, 20004021, 20004087, 20017509, 20023340, 20031873 -20067212, 20074391, 20134113, 20142975, 20144308, 20169408, 20175161 -20250147, 20273319, 20294666, 20296213, 20299013, 20299015, 20324049 -20331945, 20334344, 20382309, 20387265, 20390564, 20394750, 20408829 -20425790, 20441797, 20448824, 20475845, 20476175, 20506699, 20506706 -20506715, 20509482, 20513399, 20524085, 20558005, 20563314, 20569094 -20596234, 20598042, 20627866, 20631274, 20631846, 20647412, 20657411 -20657441, 20671094, 20672075, 20686773, 20717359, 20725343, 20777150 -20803583, 20828947, 20856766, 20860659, 20861693, 20869721, 20875898 -20879889, 20882568, 20907061, 20914870, 20925795, 20926021, 20936905 -21047407, 21047766, 21051833, 21051840, 21051852, 21051858, 21051862 -21059919, 21063322, 21067387, 21097043, 21132297, 21142837, 21168487 -21172913, 21174504, 21179898, 21197626, 21263635, 21275255, 21281607 -21281961, 21286665, 21330264, 21343775, 21343838, 21343897, 21351877 -21352646, 21354456, 21380789, 21387964, 21394225, 21419850, 21422580 -21424824, 21425496, 21429602, 21453153, 21502702, 21515534, 21516611 -21517440, 21526048, 21532755, 21534893, 21538485, 21538558, 21538567 -21566639, 21566944, 21612959, 21629064, 21641760, 21656630, 21668627 -21698350, 21756661, 21756677, 21756699, 21764119, 21787056, 21794615 -21795111, 21811517, 21820934, 21834568, 21842740, 21847223, 21868720 -21893235, 21897746, 21911701, 21911849, 21972320, 21983325, 22037014 -22083366, 22092979, 22118835, 22148226, 22168163, 22175564, 22185234 -22188219, 22195441, 22195448, 22195457, 22195465, 22195477, 22195485 -22195492, 22228324, 22243719, 22250006, 22253904, 22296366, 22321741 -22321756, 22351572, 22353199, 22380919, 22465352, 22468255, 22499356 -22502493, 22507210, 22507234, 22551446, 22568797, 22594718, 22606521 -22657942, 22666802, 22670385, 22675136, 22683212, 22683225, 22686674 -22730454, 22750215, 22760679, 22782647, 22809871, 22820579, 22826067 -22836801, 22873635, 22893153, 22901797, 22905130, 22977256, 23003979 -23007241, 23008056, 23026585, 23065323, 23082876, 23105538, 23115139 -23140259, 23177648, 23184013, 23194294, 23209741, 23265914, 23266217 -23294548, 23302839, 23315889, 23328639, 23330119, 23330124, 23536835 -23571055, 23614158, 23628685, 23713236, 23725036, 23727132, 24307571 -24316947, 24348685, 24385983, 24411921, 24433711, 24448240, 24473736 -24476265, 24476274, 24528741, 24534298, 24555417, 24560906, 24563422 -24570598, 24589081, 24624166, 24652769, 24662775, 24701840, 24717859 -24719736, 24766121, 24790914, 24817447, 24835538, 24842886, 24908321 -24975421, 25042823, 25067795, 25076732, 25077278, 25093656, 25115178 -25165496, 25205368, 25248384, 25328093, 25364628, 25369547, 25423453 -25427662, 25489607, 25494379, 25505371, 25505382, 25505394, 25505407 -25555252, 25600421, 25634317, 25635149, 25649873, 25654936, 25655390 -25764020, 25775213, 25809524, 25823754, 25879656, 25879984, 25881255 -25885148, 25897615, 25914276, 25947799, 25957038, 26007010, 26023002 -26030218, 26039623, 26078387, 26198926, 26203182, 26243698, 26245237 -26318200, 26336977, 26354017, 26439748, 26474853, 26482376, 26513067 -26544823, 26569225, 26575788, 26631046, 26637592, 26654363, 26667015 -26667023, 26667032, 26679352, 26716835, 26744595, 26746894, 26910644 -26999139, 27000663, 27015449, 27053456, 27072923, 27086138, 27097854 -27255377, 27351628, 27374796, 27404573, 27441326, 27461842, 27534509 -27567477, 27642235, 27710072, 27825893, 27870645, 27952577, 28000269 -28022101, 28076295, 28079127, 28100487, 28125601, 28199085, 28254374 -28305362, 28357401, 28364007, 28384353, 28394726, 28501075, 28502128 -28566241, 28612674, 28730253, 28734355, 28790634, 28806384, 28819280 -28849751, 28852325, 28855981, 28876684, 28915933, 29027694, 29033139 -29200700, 29254615, 29343156, 29434301, 29448234, 29483672, 29483723 -29483771, 29511611, 29621961, 29633753, 29774367, 29782211, 29944660 -29962927, 29962939, 29965888, 29992392, 29997937, 30018017, 30160639 -30179644, 30200680, 30215130, 30237239, 30252098, 30275351, 30275359 -30305880, 30365745, 30387666, 30393318, 30421204, 30517516, 30534664 -30559616, 30561292, 30562891, 30562907, 30562909, 30562923, 30562936 -30578221, 30624864, 30758943, 30772207, 30803210, 30855121, 31001455 -31010960, 31022191, 31022281, 31031715, 31125948, 31172207, 31194264 -31306274, 31335037, 31335142, 31338362, 31476032, 31492144, 31492164 -31492176, 31506720, 31537677, 31668061, 31668867, 31834759, 31883489 -31884535, 31885162, 31885173, 31885179, 31885190, 31885201, 31885213 -31885223, 31885230 -``` - -## Version 11\.2\.0\.4\.v25 - -Version 11\.2\.0\.4\.v25 includes the following: -+ Patch 31103343: Database Patch Set Update 11\.2\.0\.4\.200714 -+ Patch 31219953: Oracle JVM Component Database PSU 11\.2\.0\.4\.200714 -+ Patch 31335037: DSTV35 for RDBMS \(TZDATA2020A\) -+ Patch 31335142: DSTV35 for OJVM \(TZDATA2020A\) -+ Patch 31596256: Oracle GoldenGate \- Oracle RDBMS Server Recommended Patches -+ Patch 22188219: "L1 VALIDATION" WAIT EVENT USED TO BACK OFF WHEN HW ENQUEUE CANNOT BE ACQUIRED -+ Patch 28730253: SUPPORT NEW ERA REIWA FOR JAPANESE IMPERIAL CALENDAR - -### Combined patches for version 11\.2\.0\.4\.v25, released July 2020 - -Bugs fixed: - -``` -2990912, 6599380, 8322815, 9756271, 10136473, 11733603, 11786053 -11883252, 12364061, 12611721, 12668795, 12747740, 12816846, 12897813 -12905058, 12982566, 13254780, 13364795, 13498382, 13558557, 13609098 -13645875, 13680635, 13829543, 13837378, 13853126, 13866822, 13871092 -13936038, 13944971, 13951456, 13955826, 13960236, 14010183, 14015842 -14034426, 14054676, 14084247, 14106803, 14133975, 14176370, 14245531 -14285317, 14312810, 14338435, 14354737, 14368995, 14458214, 14521218 -14521849, 14565184, 14602788, 14657740, 14692762, 14705949, 14735792 -14764829, 14774730, 14829250, 14852021, 15861775, 15913355, 15955387 -15979965, 15990359, 16042673, 16043574, 16065166, 16069901, 16091637 -16180763, 16194160, 16198143, 16220077, 16228604, 16233738, 16268425 -16285691, 16306373, 16314254, 16315398, 16344544, 16354467, 16360112 -16384983, 16392068, 16399083, 16410570, 16422541, 16450169, 16472716 -16494615, 16524926, 16538760, 16542886, 16571443, 16579084, 16595641 -16596890, 16613964, 16618694, 16668584, 16674686, 16685417, 16692232 -16721594, 16731148, 16756406, 16777840, 16785708, 16799735, 16819962 -16832076, 16833527, 16833845, 16837842, 16850630, 16854386, 16855292 -16863422, 16870214, 16875230, 16875449, 16898135, 16901385, 16903536 -16912439, 16929165, 16934803, 16941434, 16943711, 16956380, 16989630 -16992075, 17006183, 17006570, 17008068, 17011832, 17016369, 17019086 -17019345, 17019356, 17025461, 17027426, 17030189, 17031322, 17036973 -17037130, 17040527, 17040764, 17042658, 17047404, 17050888, 17056813 -17071721, 17080436, 17082359, 17082983, 17088068, 17156148, 17165204 -17174582, 17184721, 17186905, 17201047, 17201159, 17205719, 17208934 -17215560, 17227073, 17227277, 17231779, 17232014, 17235750, 17237521 -17238511, 17239687, 17242746, 17246576, 17254374, 17258090, 17258582 -17265217, 17267114, 17274537, 17279227, 17282229, 17284817, 17285560 -17288409, 17291347, 17296856, 17297939, 17299889, 17302277, 17308789 -17311728, 17313525, 17323222, 17325413, 17332800, 17341326, 17343514 -17344412, 17346091, 17346671, 17348614, 17359610, 17360606, 17365043 -17375354, 17381384, 17385178, 17389192, 17390160, 17390431, 17392698 -17393683, 17393915, 17394950, 17397545, 17432124, 17437634, 17441661 -17443671, 17446237, 17449815, 17465741, 17468141, 17477958, 17478145 -17478514, 17484731, 17484762, 17495022, 17501491, 17518652, 17528315 -17532245, 17532729, 17545847, 17546761, 17546973, 17551063, 17551674 -17551699, 17551709, 17570240, 17570606, 17571039, 17571306, 17586955 -17587063, 17588480, 17596908, 17600719, 17602269, 17610798, 17612828 -17614134, 17614227, 17621643, 17622427, 17630484, 17634921, 17643573 -17644091, 17648596, 17649265, 17655240, 17655634, 17672719, 17694209 -17695685, 17705023, 17716305, 17717883, 17721717, 17722535, 17726838 -17752121, 17752995, 17754782, 17761775, 17762296, 17767676, 17783445 -17783588, 17785870, 17786278, 17786518, 17787259, 17798953, 17801017 -17804361, 17806696, 17811429, 17811438, 17811447, 17811456, 17811789 -17816865, 17820741, 17824637, 17835048, 17835627, 17842825, 17847764 -17848897, 17851160, 17852463, 17853456, 17853498, 17865671, 17877323 -17883081, 17889549, 17889583, 17890099, 17891943, 17891946, 17892268 -17903598, 17912217, 17922254, 17936109, 17945983, 17951233, 17957017 -17982555, 17982832, 18000422, 18009564, 18018515, 18029658, 18031668 -18043064, 18051556, 18061914, 18084625, 18086801, 18090142, 18091059 -18092127, 18093615, 18094246, 18096714, 18098207, 18125929, 18135678 -18139690, 18155762, 18159793, 18166013, 18166577, 18180390, 18189036 -18191164, 18193833, 18199537, 18202441, 18203835, 18203837, 18203838 -18228645, 18230522, 18232865, 18235390, 18244962, 18247991, 18259031 -18260550, 18262334, 18264060, 18272672, 18273830, 18277454, 18280813 -18282562, 18293054, 18306996, 18308268, 18315328, 18316692, 18317531 -18325460, 18328509, 18331812, 18331850, 18334586, 18339044, 18356166 -18362222, 18373438, 18382302, 18384391, 18384537, 18388363, 18411336 -18413820, 18430495, 18436307, 18436647, 18440047, 18440095, 18441944 -18456514, 18458318, 18460587, 18471685, 18482502, 18492302, 18508861 -18510194, 18515268, 18522509, 18554763, 18554871, 18604493, 18604692 -18607546, 18610915, 18614015, 18619917, 18628388, 18641419, 18641451 -18641461, 18662619, 18673090, 18673304, 18673325, 18673342, 18674024 -18674047, 18674465, 18676416, 18681862, 18682983, 18685892, 18704244 -18705484, 18723434, 18740837, 18744139, 18747196, 18759211, 18762750 -18765602, 18774543, 18783224, 18798250, 18819257, 18828868, 18832544 -18841764, 18849970, 18856106, 18856999, 18868646, 18886413, 18899974 -18933818, 18948177, 18964939, 18973548, 18973907, 18996843, 19006757 -19006849, 19007266, 19013183, 19032777, 19032867, 19049453, 19058059 -19060015, 19121551, 19153980, 19174430, 19175543, 19176885, 19187988 -19197175, 19207117, 19207156, 19211433, 19211724, 19223010, 19231857 -19258504, 19271443, 19272701, 19277336, 19285025, 19289642, 19297917 -19306797, 19309466, 19315668, 19330795, 19358317, 19359219, 19373893 -19374518, 19393542, 19396455, 19403858, 19429927, 19433930, 19440386 -19442102, 19445860, 19455741, 19458377, 19461270, 19463893, 19463897 -19466309, 19469538, 19475971, 19487147, 19490948, 19516448, 19540573 -19544839, 19554106, 19554117, 19563300, 19563715, 19578350, 19584068 -19587324, 19601228, 19601762, 19615136, 19644859, 19680952, 19689979 -19692824, 19693090, 19697993, 19699191, 19699946, 19718981, 19721304 -19727057, 19730508, 19768226, 19769489, 19777862, 19781326, 19788303 -19788842, 19791273, 19794897, 19827973, 19831647, 19835133, 19852360 -19854503, 19871910, 19888853, 19891090, 19895326, 19896336, 19909862 -19915271, 19930276, 19943771, 19972564, 19972566, 19972568, 19972569 -19972570, 20004021, 20004087, 20017509, 20023340, 20031873, 20067212 -20074391, 20134113, 20142975, 20144308, 20169408, 20175161, 20250147 -20273319, 20294666, 20296213, 20299015, 20324049, 20331945, 20334344 -20382309, 20387265, 20390564, 20394750, 20408829, 20425790, 20441797 -20448824, 20475845, 20476175, 20506699, 20506706, 20506715, 20509482 -20513399, 20524085, 20558005, 20563314, 20569094, 20596234, 20598042 -20627866, 20631274, 20631846, 20647412, 20657411, 20657441, 20671094 -20672075, 20686773, 20717359, 20725343, 20777150, 20803583, 20828947 -20856766, 20860659, 20861693, 20869721, 20875898, 20879889, 20882568 -20907061, 20914870, 20925795, 20926021, 20936905, 21047407, 21047766 -21051833, 21051840, 21051852, 21051858, 21051862, 21059919, 21063322 -21067387, 21097043, 21132297, 21142837, 21168487, 21172913, 21174504 -21179898, 21197626, 21227138, 21263635, 21275255, 21281607, 21281961 -21286665, 21330264, 21343775, 21343838, 21343897, 21351877, 21352646 -21354456, 21380789, 21387964, 21394225, 21419850, 21422580, 21424824 -21425496, 21429602, 21453153, 21502702, 21515534, 21516611, 21517440 -21526048, 21532755, 21534893, 21538485, 21538558, 21538567, 21566639 -21566944, 21612959, 21629064, 21641760, 21656630, 21668627, 21698350 -21756661, 21756677, 21756699, 21764119, 21787056, 21794615, 21795111 -21811517, 21820934, 21834568, 21842740, 21847223, 21868720, 21893235 -21897746, 21911701, 21911849, 21972320, 21983325, 22037014, 22083366 -22092979, 22118835, 22148226, 22168163, 22175564, 22185234, 22188219 -22195441, 22195448, 22195457, 22195465, 22195477, 22195485, 22195492 -22228324, 22243719, 22250006, 22253904, 22296366, 22321741, 22321756 -22351572, 22353199, 22380919, 22465352, 22499356, 22502493, 22507210 -22507234, 22551446, 22568797, 22594718, 22606521, 22657942, 22666802 -22670385, 22675136, 22683212, 22683225, 22686674, 22730454, 22760679 -22782647, 22809871, 22820579, 22836801, 22873635, 22893153, 22901797 -22905130, 22977256, 23003979, 23007241, 23008056, 23026585, 23065323 -23105538, 23115139, 23140259, 23177648, 23194294, 23209741, 23262847 -23265914, 23294548, 23302839, 23315889, 23328639, 23330119, 23330124 -23536835, 23571055, 23614158, 23628685, 23713236, 23725036, 23727132 -24307571, 24316947, 24348685, 24385983, 24411921, 24433711, 24448240 -24476265, 24476274, 24528741, 24534298, 24555417, 24560906, 24563422 -24570598, 24589081, 24624166, 24652769, 24662775, 24701840, 24717859 -24719736, 24766121, 24790914, 24835538, 24842886, 24908321, 24975421 -25042823, 25067795, 25076732, 25077278, 25093656, 25165496, 25248384 -25328093, 25364628, 25369547, 25423453, 25427662, 25489607, 25494379 -25505371, 25505382, 25505394, 25505407, 25555252, 25600421, 25634317 -25635149, 25649873, 25654936, 25655390, 25764020, 25775213, 25809524 -25823754, 25879656, 25879984, 25881255, 25885148, 25897615, 25914276 -25947799, 25957038, 26007010, 26023002, 26030218, 26039623, 26078387 -26198926, 26203182, 26243698, 26245237, 26336977, 26354017, 26439748 -26474853, 26482376, 26513067, 26544823, 26569225, 26575788, 26631046 -26637592, 26654363, 26667015, 26667023, 26667032, 26679352, 26744595 -26746894, 26910644, 26999139, 27000663, 27015449, 27053456, 27072923 -27086138, 27097854, 27255377, 27351628, 27374796, 27441326, 27461842 -27534509, 27567477, 27642235, 27710072, 27825893, 27870645, 27952577 -28000269, 28022101, 28076295, 28079127, 28100487, 28125601, 28199085 -28254374, 28305362, 28357401, 28364007, 28384353, 28501075, 28502128 -28612674, 28730253, 28734355, 28790634, 28806384, 28819280, 28849751 -28852325, 28855981, 28876684, 28915933, 29027694, 29033139, 29200700 -29254615, 29343156, 29434301, 29448234, 29483672, 29483723, 29483771 -29511611, 29621961, 29633753, 29774367, 29944660, 29962927, 29962939 -29992392, 29997937, 30160639, 30179644, 30215130, 30237239, 30252098 -30275351, 30275359, 30305880, 30365745, 30393318, 30534664, 30559616 -30562891, 30562907, 30562909, 30562923, 30562936, 30624864, 30758943 -30772207, 30803210, 30855121, 31001455, 31010960, 31022191, 31022281 -31031715, 31103343, 31125948, 31172207, 31306274, 31335037, 31335142 -31338362, 31492144, 31492164, 31492176 -``` - -## Version 11\.2\.0\.4\.v24 - -Version 11\.2\.0\.4\.v24 includes the following: -+ Patch 30670774: Database PSU 11\.2\.0\.4\.200414 -+ Patch 30805543: Oracle JVM Component Database PSU 11\.2\.0\.4\.200414 -+ Patch 29997937: DSTv34 for RDBMS \(TZDATA2019G\) -+ Patch 29997959: DSTV34 OJVM \(TZDATA2019B\) -+ Patch 31192454: Oracle GoldenGate \- Oracle RDBMS Server Recommended Patches -+ Patch 22188219: "L1 VALIDATION" WAIT EVENT USED TO BACK OFF WHEN HW ENQUEUE CANNOT BE ACQUIRED -+ Patch 28730253: SUPPORT NEW ERA REIWA FOR JAPANESE IMPERIAL CALENDAupport for [Purging the recycle bin](Appendix.Oracle.CommonDBATasks.Database.md#Appendix.Oracle.CommonDBATasks.PurgeRecycleBin)\. -+ Support for [Generating performance reports with Automatic Workload Repository \(AWR\)](Appendix.Oracle.CommonDBATasks.Database.md#Appendix.Oracle.CommonDBATasks.AWR) using the `rdsadmin.rdsadmin_diagnostic_util` package - -### Combined patches for version 11\.2\.0\.4, released April 2020 - -Bugs fixed: - -``` -18619917, 19309466, 28876684, 28855981, 18189036, 19781326, 13609098 -16285691, 16756406, 18430495, 17323222, 29483723, 19915271, 19516448 -14458214, 23713236, 23140259, 29434301, 22502493, 18272672, 16410570 -16494615, 19174430, 21352646, 16901385, 16596890, 22243719, 18996843 -21387964, 20334344, 17174582, 22250006, 17798953, 14015842, 18031668 -15955387, 21534893, 16832076, 16065166, 16579084, 25427662, 21179898 -11786053, 15990359, 24589081, 17982832, 18685892, 20142975, 24835538 -16315398, 20861693, 17037130, 17284817, 17891946, 17279227, 17588480 -17291347, 16731148, 21097043, 24528741, 22321741, 17165204, 26245237 -17891943, 17359610, 17265217, 17465741, 29621961, 22551446, 18191164 -16721594, 18614015, 27825893, 18440095, 19769489, 20596234, 18482502 -16043574, 17360606, 20936905, 22321756, 19211724, 17392698, 19463893 -29033139, 17477958, 17040764, 18362222, 19463897, 24624166, 17853456 -14521849, 17816865, 19692824, 21868720, 17951233, 25505407, 17040527 -31022191, 24975421, 19888853, 18009564, 20882568, 20803583, 23026585 -18604692, 17622427, 16903536, 29483771, 17865671, 17883081, 16228604 -17325413, 17082359, 12747740, 22168163, 16091637, 20569094, 17468141 -30365745, 29962939, 19469538, 29633753, 20598042, 16042673, 23302839 -17437634, 28734355, 19049453, 20387265, 16941434, 16833527, 21343775 -17297939, 16069901, 14285317, 22380919, 18436647, 23065323, 21983325 -17853498, 24790914, 23571055, 16542886, 21286665, 17365043, 17752995 -25914276, 17296856, 18783224, 22353199, 22083366, 28305362, 21419850 -16180763, 23294548, 26679352, 13960236, 25328093, 25423453, 18339044 -17282229, 25600421, 18856999, 18259031, 28806384, 21354456, 23725036 -18471685, 30237239, 17258090, 16344544, 17903598, 17011832, 18135678 -18704244, 17786518, 19718981, 25655390, 17242746, 20250147, 19197175 -17390431, 17835627, 17672719, 17393915, 21566639, 18765602, 21425496 -26544823, 22228324, 29962927, 18682983, 30179644, 25165496, 12816846 -18774543, 18747196, 17824637, 19429927, 21429602, 16524926, 17343514 -19271443, 17019345, 18681862, 17186905, 23330119, 17811438, 26474853 -17215560, 16875449, 21380789, 17184721, 18508861, 19466309, 23330124 -17811429, 17019356, 25654936, 17754782, 17752121, 22809871, 17201159 -18308268, 19777862, 16198143, 29027694, 18828868, 17586955, 28076295 -26654363, 22977256, 16692232, 27374796, 21142837, 20869721, 17649265 -25879656, 17847764, 21756699, 19697993, 28364007, 17787259, 23628685 -30252098, 23007241, 27351628, 18094246, 20031873, 17375354, 21698350 -26513067, 21538567, 22683212, 16450169, 17478145, 17311728, 17648596 -17308789, 22836801, 21756677, 18674047, 14084247, 19788303, 22683225 -27534509, 16833845, 18948177, 17205719, 21756661, 20004021, 17922254 -13837378, 18084625, 17912217, 11883252, 24842886, 12982566, 26203182 -14176370, 14764829, 21847223, 16875230, 28079127, 22568797, 17237521 -29511611, 25635149, 16934803, 17848897, 20441797, 20175161, 16613964 -18334586, 17288409, 17341326, 17449815, 15913355, 16399083, 18740837 -20294666, 14565184, 21517440, 17614134, 19854503, 14245531, 16194160 -18325460, 15979965, 30562923, 20671094, 27870645, 25093656, 18247991 -16912439, 30562936, 24433711, 19930276, 22092979, 20506715, 23003979 -20506706, 13871092, 19272701, 17397545, 16785708, 19461270, 21051862 -13829543, 16220077, 17008068, 18061914, 20448824, 30275359, 18674024 -19689979, 24411921, 30275351, 17596908, 17036973, 22175564, 17612828 -20725343, 28199085, 23194294, 17630484, 21051858, 20017509, 21051852 -17767676, 17232014, 22893153, 12611721, 25555252, 18356166, 17071721 -19315668, 25764020, 16863422, 21051840, 17267114, 17820741, 18043064 -21538558, 26243698, 20324049, 30305880, 16392068, 18744139, 24348685 -26746894, 18628388, 27072923, 14010183, 16595641, 17080436, 17332800 -20777150, 21453153, 20299015, 18413820, 18264060, 16819962, 22465352 -21351877, 21051833, 18673342, 30562907, 30562909, 29200700, 27441326 -16571443, 18328509, 27567477, 18674465, 16422541, 18306996, 19359219 -21424824, 17443671, 17478514, 21067387, 16268425, 17381384, 18723434 -17235750, 23328639, 22195448, 24570598, 21172913, 17655240, 18384391 -16992075, 22195441, 17025461, 30562891, 16472716, 19289642, 21502702 -22195457, 20475845, 22148226, 26030218, 18331850, 17945983, 13498382 -24652769, 18673304, 17610798, 19891090, 25369547, 18456514, 8322815 -22657942, 17313525, 17050888, 18317531, 19835133, 17495022, 11733603 -18798250, 19285025, 18260550, 17390160, 18316692, 19458377, 14368995 -17551063, 21343838, 12905058, 14735792, 28612674, 16855292, 23315889 -13364795, 18235390, 18293054, 18673325, 19393542, 30215130, 14657740 -17532729, 17393683, 17389192, 17783588, 17852463, 19358317, 17441661 -14034426, 28254374, 20631274, 19207117, 26569225, 17518652, 24662775 -19475971, 18282562, 19896336, 17348614, 19827973, 17346671, 31022281 -19791273, 24476274, 22296366, 13853126, 18273830, 17570606, 13558557 -26007010, 16685417, 18180390, 14692762, 18159793, 17027426, 24476265 -23177648, 17851160, 16870214, 18202441, 17227073, 20657411, 19006849 -22606521, 20506699, 28000269, 23536835, 17761775, 20382309, 16306373 -17801017, 19680952, 16850630, 17694209, 26667015, 17877323, 18230522 -24563422, 17446237, 17889549, 17551674, 16233738, 22730454, 17571039 -26667023, 19972570, 18849970, 21532755, 20860659, 22905130, 21168487 -17016369, 21263635, 17231779, 21343897, 17717883, 27710072, 18522509 -23209741, 17484731, 21972320, 19972569, 19972568, 17716305, 21059919 -19972566, 19972564, 26667032, 17394950, 20657441, 17551699, 17006570 -18051556, 12364061, 18029658, 17546973, 18262334, 19699191, 17227277 -18018515, 16943711, 17982555, 20828947, 18098207, 18436307, 19584068 -16898135, 13936038, 19601762, 31010960, 14054676, 25505394, 18228645 -19013183, 25042823, 17721717, 17239687, 25248384, 25634317, 20134113 -20273319, 28501075, 21063322, 17344412, 22507210, 16354467, 21795111 -25505371, 16777840, 25879984, 17811456, 19730508, 17385178, 18166013 -17484762, 10136473, 6599380, 20717359, 20296213, 27097854, 13955826 -18193833, 17545847, 16837842, 18964939, 19871910, 25505382, 17811447 -18554763, 21132297, 25957038, 20004087, 17889583, 19544839, 26631046 -22507234, 24719736, 18868646, 17042658, 20627866, 14106803, 13951456 -18139690, 18277454, 13680635, 25823754, 18554871, 18515268, 20169408 -24908321, 17274537, 17602269, 26575788, 19032867, 17762296, 14829250 -16929165, 14602788, 28849751, 21794615, 18899974, 29944660, 18441944 -17811789, 20074391, 14852021, 17705023, 13645875, 24316947, 16668584 -17786278, 25947799, 20879889, 19578350, 28022101, 22594718, 16384983 -26439748, 17957017, 19121551, 17570240, 19788842, 18382302, 27086138 -21330264, 21197626, 14338435, 13944971, 21656630, 18886413, 17156148 -17936109, 20509482, 27255377, 24717859, 18762750, 21526048, 24560906 -18096714, 17238511, 26078387, 27053456, 20144308, 25364628, 18244962 -19433930, 20476175, 19297917, 21174504, 18280813, 28819280, 17614227 -28357401, 21911701, 17006183, 25809524, 18092127, 19727057, 17695685 -26039623, 22820579, 20856766, 15861775, 17258582, 21668627, 19487147 -20925795, 28100487, 26482376, 19554106, 22760679, 21629064, 18199537 -18091059, 17299889, 21538485, 17546761, 26336977, 25775213, 18155762 -30803210, 16956380, 19207156, 14705949, 23105538, 26198926, 19258504 -16314254, 17246576, 17655634, 17890099, 16989630, 20067212, 19721304 -25077278, 19490948, 18203835, 18203838, 18973907, 18203837, 29483672 -19615136, 17587063, 18000422, 18641451, 18090142, 21641760, 17019086 -30559616, 19373893, 18373438, 21820934, 18641461, 17346091, 21422580 -22351572, 18604493, 23008056, 22901797, 18610915, 17892268, 17501491 -20907061, 14354737, 17835048, 21787056, 22195485, 22782647, 17082983 -18641419, 16618694, 14133975, 22195492, 18331812, 18093615, 24385983 -25897615, 20513399, 21281607, 13866822, 18841764, 17600719, 17842825 -20558005, 17088068, 9756271, 22195465, 18440047, 19211433, 21515534 -20331945, 22686674, 18384537, 18607546, 17254374, 18315328, 23115139 -28790634, 21394225, 16360112, 22195477, 17726838, 18510194, 17571306 -24766121, 17302277, 21842740, 17551709, 26910644, 17634921, 25489607 -16538760, 18933818, 19176885, 17201047, 25649873, 25067795, 28502128 -27952577, 14774730, 27461842, 19153980, 21911849, 23727132, 18166577 -27000663, 24448240, 17056813, 21811517, 19909862, 25494379, 22675136 -24534298, 19895326, 22253904, 17804361, 19231857, 27642235, 26023002 -17528315, 19058059, 30534664, 29992392, 19554117, 19007266, 28915933 -30855121, 30160639, 17285560, 29254615, 22670385, 18458318, 19187988 -23265914, 19699946, 19006757, 19374518, 29774367, 19223010, 29448234 -25076732, 22118835, 26637592, 19852360, 20408829, 21047766, 21566944 -28730253, 16799735, 17432124, 18759211, 19396455, 20875898, 22037014 -22873635, 23614158, 24701840, 25881255, 27015449, 28125601, 28852325 -29997937, 29997959, 26354017, 21893235, 18125929, 19601228, 12668795 -20524085, 19403858, 18086801, 16854386, 21612959, 20563314, 18705484 -16674686, 20425790, 20390564, 19032777, 21275255, 17783445, 19943771 -18973548, 18411336, 18673090, 19768226, 21047407, 17030189, 18856106 -19693090, 21227138, 18492302, 19831647, 12897813, 19563300, 20914870 -19587324, 13254780, 18676416, 21834568, 19794897, 26744595, 17208934 -17031322, 19060015, 19277336, 19455741, 21764119, 17785870, 20631846 -22185234, 20023340, 20647412, 19440386, 21281961, 25885148, 17722535 -20926021, 20686773, 17621643, 18662619, 19563715, 19442102, 21516611 -14312810, 20672075, 21897746, 2990912, 23262847, 19644859, 19175543 -17644091, 20394750, 19306797, 18819257, 22188219 -``` - -## Version 11\.2\.0\.4\.v23 - -Version 11\.2\.0\.4\.v23 includes the following: -+ Patch 30298532: Database Patch Set Update: 11\.2\.0\.4\.200114 -+ Patch 30503372: OJVM PATCH SET UPDATE 11\.2\.0\.4\.200114 -+ Patch 29997937: DSTv34 for RDBMS \(TZDATA2019G\) -+ Patch 29997959: DSTV34 OJVM \(TZDATA2019B\) -+ Oracle GoldenGate \- Oracle RDBMS Server Recommended Patches -+ Patch 19440386: FAILED TO RAISE ORA\-1 FOR PK UPDATE WHEN CONSTRAINT=IMMEDIATE -+ Patch 19277336: INTEGRATED REPLICAT INVALIDATES DEPENDENT PACKAGES RESULTING IN AN ORA\-4068 -+ Patch 24286409: MERGE REQUEST ON TOP OF DATABASE PSU 11\.2\.0\.4\.6 FOR BUGS 20647412 21534893 -+ Patch 24010393: MERGE REQUEST ON TOP OF DATABASE PSU 11\.2\.0\.4\.6 FOR BUGS 12897813 21281961 -+ Patch 19306797: HEARTBEAT REDO IS NOT GENERATED NON\-RAC HOSTS WHEN SUPPLIMENTAL LOGGING ENABLED -+ Patch 19563715: LOGMINER DOES NOT MAKE PROGRESS WHEN 4GB OR MORE MEMORY IS USED IN GOLDENGATE -+ Patch 20425790: LOGMINER PATCHES SHOULD TRANSPARENTLY FUNCTION IN A NON\-PARITIONING ENABLED DB -+ Patch 17031322: 46719: OCIXMLDBREWRITEXML RETURNED BIND VARIABLES ARE NOT WHITESPACE PRESERVING -+ Patch 30303921: MERGE REQUEST ON TOP OF DATABASE PSU 11\.2\.0\.4\.190416 FOR BUGS 29879564 14312810 -+ Patch 30293609: MERGE REQUEST ON TOP OF DATABASE PSU 11\.2\.0\.4\.190416 FOR BUGS 29600521 23262847 -+ Patch 26744595: LGSB:APPLY ABORTS W/ ORA\-26786 \(ROW\-EXISTS\) COLLISION WITH HCC\(PR\)\-NO HCC\(SB\) -+ Patch 28730253: SUPPORT NEW ERA REIWA FOR JAPANESE IMPERIAL CALENDAR - -### Oracle patch 30298532, released January 2020 - -Bugs fixed: - -``` -18619917, 19309466, 28876684, 28855981, 18189036, 19781326, 13609098 -16285691, 16756406, 18430495, 17323222, 29483723, 19915271, 19516448 -14458214, 23713236, 23140259, 29434301, 22502493, 18272672, 16410570 -16494615, 19174430, 21352646, 16901385, 16596890, 22243719, 18996843 -21387964, 20334344, 17174582, 22250006, 17798953, 14015842, 18031668 -15955387, 16832076, 16065166, 16579084, 25427662, 21179898, 11786053 -15990359, 17982832, 18685892, 20142975, 24835538, 16315398, 20861693 -17037130, 17284817, 17891946, 17279227, 17588480, 17291347, 16731148 -21097043, 24528741, 22321741, 17165204, 26245237, 17891943, 17359610 -17265217, 17465741, 22551446, 18191164, 16721594, 18614015, 27825893 -18440095, 19769489, 20596234, 18482502, 16043574, 17360606, 22321756 -19211724, 17392698, 19463893, 29033139, 17477958, 17040764, 18362222 -19463897, 24624166, 17853456, 14521849, 17816865, 19692824, 21868720 -17951233, 25505407, 17040527, 24975421, 19888853, 18009564, 20882568 -20803583, 23026585, 18604692, 17622427, 16903536, 17865671, 29483771 -17883081, 16228604, 17325413, 17082359, 12747740, 22168163, 16091637 -20569094, 17468141, 30365745, 29962939, 19469538, 29633753, 20598042 -16042673, 17437634, 23302839, 28734355, 19049453, 20387265, 16833527 -21343775, 17297939, 16069901, 14285317, 22380919, 18436647, 23065323 -21983325, 17853498, 24790914, 23571055, 16542886, 21286665, 17365043 -17752995, 25914276, 17296856, 18783224, 22353199, 22083366, 28305362 -16180763, 21419850, 23294548, 26679352, 13960236, 25423453, 18339044 -17282229, 25600421, 18856999, 18259031, 28806384, 21354456, 23725036 -18471685, 30237239, 17258090, 16344544, 17903598, 17011832, 18135678 -18704244, 17786518, 19718981, 25655390, 17242746, 20250147, 19197175 -17390431, 17835627, 17672719, 17393915, 21566639, 18765602, 21425496 -26544823, 22228324, 29962927, 18682983, 25165496, 12816846, 18774543 -18747196, 17824637, 19429927, 21429602, 16524926, 17343514, 19271443 -17019345, 18681862, 17186905, 23330119, 17811438, 26474853, 17215560 -16875449, 21380789, 17184721, 18508861, 19466309, 23330124, 17811429 -17019356, 25654936, 17754782, 17752121, 22809871, 17201159, 18308268 -19777862, 16198143, 29027694, 18828868, 17586955, 28076295, 22977256 -16692232, 27374796, 21142837, 20869721, 17649265, 25879656, 21756699 -19697993, 28364007, 17787259, 23628685, 23007241, 30252098, 27351628 -18094246, 20031873, 17375354, 21698350, 21538567, 22683212, 16450169 -17478145, 17311728, 17648596, 17308789, 22836801, 21756677, 18674047 -14084247, 19788303, 22683225, 27534509, 16833845, 18948177, 17205719 -21756661, 20004021, 17922254, 13837378, 18084625, 17912217, 11883252 -24842886, 12982566, 26203182, 14176370, 14764829, 21847223, 16875230 -28079127, 22568797, 17237521, 29511611, 25635149, 16934803, 17848897 -20441797, 16613964, 18334586, 17288409, 17341326, 17449815, 15913355 -16399083, 18740837, 20294666, 14565184, 21517440, 17614134, 19854503 -14245531, 16194160, 18325460, 15979965, 30562923, 20671094, 27870645 -25093656, 18247991, 16912439, 24433711, 19930276, 22092979, 20506715 -23003979, 20506706, 13871092, 19272701, 17397545, 16785708, 19461270 -21051862, 13829543, 16220077, 17008068, 18061914, 20448824, 30275359 -18674024, 19689979, 24411921, 30275351, 17596908, 17036973, 17612828 -20725343, 28199085, 23194294, 17630484, 21051858, 20017509, 21051852 -17767676, 17232014, 22893153, 12611721, 25555252, 18356166, 17071721 -25764020, 16863422, 21051840, 17267114, 18043064, 21538558, 26243698 -20324049, 16392068, 18744139, 24348685, 26746894, 27072923, 14010183 -16595641, 17080436, 17332800, 20777150, 21453153, 20299015, 18413820 -18264060, 16819962, 22465352, 21351877, 21051833, 18673342, 30562907 -30562909, 29200700, 27441326, 16571443, 18328509, 27567477, 18674465 -16422541, 18306996, 17443671, 19359219, 21424824, 17478514, 21067387 -16268425, 17381384, 18723434, 17235750, 23328639, 22195448, 24570598 -21172913, 17655240, 18384391, 16992075, 22195441, 17025461, 30562891 -16472716, 19289642, 21502702, 22195457, 20475845, 22148226, 26030218 -18331850, 17945983, 13498382, 24652769, 18673304, 17610798, 19891090 -25369547, 18456514, 8322815, 22657942, 17313525, 17050888, 18317531 -17495022, 11733603, 18798250, 19285025, 18260550, 17390160, 18316692 -19458377, 14368995, 17551063, 21343838, 12905058, 14735792, 28612674 -16855292, 23315889, 13364795, 18235390, 18293054, 18673325, 19393542 -14657740, 17393683, 17389192, 17783588, 17852463, 19358317, 17441661 -14034426, 28254374, 20631274, 19207117, 26569225, 17518652, 24662775 -19475971, 18282562, 17348614, 19827973, 17346671, 24476274, 22296366 -13853126, 18273830, 17570606, 13558557, 26007010, 16685417, 18180390 -14692762, 17027426, 18159793, 24476265, 23177648, 17851160, 16870214 -18202441, 17227073, 20657411, 19006849, 20506699, 22606521, 28000269 -23536835, 17761775, 20382309, 16306373, 19680952, 16850630, 17694209 -26667015, 17877323, 18230522, 24563422, 17446237, 17889549, 17551674 -16233738, 22730454, 17571039, 26667023, 19972570, 18849970, 21532755 -20860659, 22905130, 21168487, 17016369, 17231779, 21263635, 21343897 -27710072, 18522509, 23209741, 17484731, 21972320, 19972569, 19972568 -17716305, 21059919, 19972566, 19972564, 26667032, 17394950, 20657441 -17551699, 17006570, 18051556, 12364061, 18029658, 17546973, 18262334 -19699191, 17227277, 18018515, 16943711, 17982555, 20828947, 18098207 -18436307, 19584068, 16898135, 13936038, 19601762, 14054676, 25505394 -18228645, 19013183, 25042823, 17721717, 17239687, 25248384, 25634317 -20134113, 20273319, 28501075, 21063322, 17344412, 22507210, 16354467 -21795111, 25505371, 16777840, 25879984, 17811456, 19730508, 17385178 -18166013, 17484762, 10136473, 6599380, 20717359, 20296213, 27097854 -13955826, 18193833, 17545847, 16837842, 18964939, 19871910, 25505382 -17811447, 18554763, 21132297, 25957038, 20004087, 17889583, 19544839 -26631046, 22507234, 24719736, 18868646, 17042658, 20627866, 14106803 -13951456, 18139690, 18277454, 13680635, 25823754, 18554871, 20169408 -18515268, 24908321, 17274537, 17602269, 26575788, 19032867, 17762296 -14829250, 16929165, 14602788, 28849751, 21794615, 18899974, 18441944 -29944660, 17811789, 20074391, 14852021, 17705023, 13645875, 24316947 -16668584, 17786278, 25947799, 20879889, 19578350, 28022101, 22594718 -16384983, 26439748, 17957017, 19121551, 17570240, 19788842, 18382302 -27086138, 21330264, 21197626, 14338435, 13944971, 21656630, 18886413 -17156148, 17936109, 20509482, 27255377, 24717859, 18762750, 21526048 -24560906, 18096714, 17238511, 26078387, 27053456, 20144308, 18244962 -19433930, 20476175, 19297917, 21174504, 18280813, 28819280, 17614227 -28357401, 17006183, 18092127, 19727057, 17695685, 26039623, 22820579 -20856766, 15861775, 17258582, 21668627, 19487147, 20925795, 28100487 -26482376, 19554106, 21629064, 18199537, 18091059, 17299889, 21538485 -17546761, 25775213, 26336977, 18155762, 16956380, 19207156, 14705949 -23105538, 26198926, 19258504, 16314254, 17246576, 17655634, 16989630 -20067212, 19721304, 19490948, 25077278, 18203835, 18203838, 18973907 -18203837, 29483672, 19615136, 17587063, 18000422, 18641451, 18090142 -21641760, 17019086, 30559616, 19373893, 18373438, 18641461, 17346091 -21422580, 22351572, 18604493, 23008056, 22901797, 18610915, 17892268 -17501491, 20907061, 14354737, 17835048, 21787056, 22195485, 22782647 -17082983, 18641419, 16618694, 14133975, 22195492, 18331812, 18093615 -24385983, 25897615, 20513399, 21281607, 13866822, 18841764, 17600719 -17842825, 20558005, 17088068, 9756271, 22195465, 18440047, 19211433 -21515534, 20331945, 22686674, 18384537, 18607546, 17254374, 18315328 -23115139, 28790634, 21394225, 16360112, 22195477, 17726838, 18510194 -17571306, 17302277, 24766121, 21842740, 17551709, 26910644, 17634921 -25489607, 16538760 -``` - -## Version 11\.2\.0\.4\.v22 - -Version 11\.2\.0\.4\.v22 includes the following: -+ Patch 29913194: DATABASE PATCH SET UPDATE 11\.2\.0\.4\.191015 -+ Patch 30132974: OJVM PATCH SET UPDATE 11\.2\.0\.4\.191015 -+ Patch 29997937: DSTv34 for RDBMS \(TZDATA2019G\) -+ Patch 29997959: DSTV34 OJVM \(TZDATA2019B\) -+ Oracle GoldenGate \- Oracle RDBMS Server Recommended Patches -+ Patch 19440386: FAILED TO RAISE ORA\-1 FOR PK UPDATE WHEN CONSTRAINT=IMMEDIATE -+ Patch 19277336: INTEGRATED REPLICAT INVALIDATES DEPENDENT PACKAGES RESULTING IN AN ORA\-4068 -+ Patch 24286409: MERGE REQUEST ON TOP OF DATABASE PSU 11\.2\.0\.4\.6 FOR BUGS 20647412 21534893 -+ Patch 24010393: MERGE REQUEST ON TOP OF DATABASE PSU 11\.2\.0\.4\.6 FOR BUGS 12897813 21281961 -+ Patch 19306797: HEARTBEAT REDO IS NOT GENERATED NON\-RAC HOSTS WHEN SUPPLIMENTAL LOGGING ENABLED -+ Patch 19563715: LOGMINER DOES NOT MAKE PROGRESS WHEN 4GB OR MORE MEMORY IS USED IN GOLDENGATE -+ Patch 20425790: LOGMINER PATCHES SHOULD TRANSPARENTLY FUNCTION IN A NON\-PARITIONING ENABLED DB -+ Patch 17031322: 46719: OCIXMLDBREWRITEXML RETURNED BIND VARIABLES ARE NOT WHITESPACE PRESERVING -+ Patch 30303921: MERGE REQUEST ON TOP OF DATABASE PSU 11\.2\.0\.4\.190416 FOR BUGS 29879564 14312810 -+ Patch 30293609: MERGE REQUEST ON TOP OF DATABASE PSU 11\.2\.0\.4\.190416 FOR BUGS 29600521 23262847 -+ Patch 26744595: LGSB:APPLY ABORTS W/ ORA\-26786 \(ROW\-EXISTS\) COLLISION WITH HCC\(PR\)\-NO HCC\(SB\) -+ Patch 28730253: SUPPORT NEW ERA REIWA FOR JAPANESE IMPERIAL CALENDAR - -### Oracle patch 29913194, released October 2019 - -Bugs fixed: - -``` -17184721, 21174504, 20169408, 21538558, 16091637, 18092127, 17381384 -15979965, 20671094, 16731148, 16314254, 18441944, 13837378, 17835048 -17291347, 23105538, 28254374, 13558557, 21656630, 21842740, 17008068 -18382302, 17201159, 17853498, 25427662, 21197626, 17246576, 20717359 -18356166, 18681862, 18440047, 20569094, 20031873, 16875449, 20387265 -19788842, 17296856, 21330264, 14010183, 17648596, 17025461, 18886413 -17551063, 24719736, 17258582, 17267114, 21063322, 22507210, 17912217 -17889583, 18202441, 17040764, 17478145, 16524926, 25655390, 19358317 -22730454, 22148226, 18747196, 26544823, 18641419, 17036973, 18948177 -17811789, 16542886, 14285317, 18009564, 17359610, 16618694, 8322815 -16832076, 18247991, 16692232, 22507234, 28022101, 17570240, 13871092 -24624166, 26631046, 24348685, 19429927, 17848897, 17441661, 14034426 -17465741, 20273319, 19207156, 16596890, 17437634, 20506706, 18510194 -21343897, 28849751, 18339044, 21453153, 17951233, 21795111, 22321741 -18430495, 21787056, 22380919, 20506715, 19692824, 19469538, 17811429 -17903598, 19721304, 11786053, 29511611, 18230522, 19554106, 19458377 -21281607, 17612828, 6599380, 18029658, 22092979, 19516448, 17040527 -22321756, 17811438, 18641461, 18682983, 14657740, 25635149, 21502702 -13364795, 19490948, 21387964, 17346671, 17588480, 22351572, 18235390 -26474853, 18849970, 17982832, 17889549, 19309466, 16472716, 23008056 -20627866, 24908321, 20134113, 25775213, 20596234, 18331850, 18641451 -17019356, 20882568, 17344412, 19461270, 21179898, 17546761, 24842886 -17231779, 14521849, 18203835, 18203838, 18964939, 18203837, 17313525 -22195457, 18139690, 16837842, 14106803, 22296366, 17842825, 22657942 -21352646, 16360112, 22594718, 20657441, 22195441, 17389192, 26198926 -14565184, 19781326, 17019345, 17205719, 18740837, 18440095, 14764829 -14354737, 22195448, 17019086, 13944971, 16571443, 21868720, 17186905 -17080436, 18673342, 28501075, 22905130, 17027426, 19972569, 27374796 -19972568, 16833845, 19972566, 20144308, 17282229, 19972564, 16870214 -16410570, 21629064, 19615136, 21354456, 26039623, 19871910, 17390431 -18762750, 23007241, 25248384, 16613964, 18098207, 17957017, 17484762 -18471685, 19730508, 18264060, 21538485, 17323222, 17754782, 17600719 -18317531, 17852463, 17596908, 17655634, 18166013, 16228604, 20074391 -27053456, 24790914, 19972570, 26482376, 20856766, 18090142, 19891090 -18996843, 16042673, 19854503, 17835627, 22901797, 20334344, 17393683 -20861693, 18000422, 17551709, 26575788, 23315889, 20506699, 19006849 -18277454, 18456514, 17258090, 19174430, 20657411, 17174582, 25654936 -17242746, 27097854, 16399083, 17824637, 21132297, 17762296, 22465352 -22168163, 28612674, 18604692, 17397545, 16450169, 12364061, 20067212 -19373893, 18856999, 19211724, 19463893, 19463897, 27351628, 21343775 -17853456, 18373438, 18673304, 20004021, 28000269, 26030218, 21668627 -16194160, 17477958, 23140259, 16538760, 12982566, 24570598, 20828947 -27255377, 18259031, 20296213, 21425496, 28855981, 18293054, 17610798 -19699191, 23065323, 17311728, 18135678, 18774543, 23294548, 16785708 -10136473, 22551446, 19777862, 24560906, 17786518, 18315328, 25879984 -18334586, 12747740, 22250006, 18096714, 19032867, 21641760, 17390160 -18899974, 17232014, 20598042, 16354467, 26245237, 26679352, 17484731 -18673325, 16422541, 18155762, 19827973, 14015842, 22683225, 17726838 -18554871, 23177648, 18051556, 20803583, 18282562, 17922254, 15990359 -21972320, 16855292, 16668584, 21343838, 20299015, 29483672, 17446237 -18043064, 18093615, 17694209, 23713236, 17288409, 18308268, 20475845 -17274537, 13955826, 16934803, 18841764, 17634921, 17501491, 16315398 -23725036, 22683212, 17006183, 13829543, 18191164, 26746894, 22809871 -17655240, 28819280, 19393542, 18384391, 29633753, 21538567, 17695685 -16198143, 21847223, 28199085, 25823754, 17892268, 20142975, 19584068 -17165204, 25165496, 27072923, 18604493, 18508861, 21756699, 18554763 -16901385, 21532755, 18189036, 17443671, 17385178, 14829250, 17936109 -20476175, 20925795, 20509482, 17478514, 27441326, 16850630, 13951456 -16595641, 14054676, 15861775, 21142837, 16912439, 17299889, 17297939 -23003979, 16833527, 18619917, 17798953, 17630484, 19697993, 17816865 -25914276, 18607546, 17571306, 21286665, 16898135, 17341326, 16819962 -26910644, 17851160, 17586955, 20558005, 19049453, 21051840, 17587063 -16956380, 18328509, 25042823, 14735792, 25423453, 14133975, 29033139 -19718981, 18061914, 18522509, 16233738, 17518652, 21051833, 18765602 -20294666, 23194294, 20860659, 18272672, 20324049, 18199537, 17332800 -13609098, 22502493, 18384537, 14338435, 17945983, 27710072, 16392068 -21067387, 17752995, 21097043, 21051862, 16863422, 17237521, 25505382 -29483723, 18244962, 19544839, 28357401, 19433930, 24433711, 24717859 -17156148, 18973907, 23026585, 17449815, 17877323, 18180390, 17088068 -17037130, 20004087, 21422580, 19466309, 11733603, 25505371, 18610915 -21051858, 18084625, 29027694, 18674024, 26243698, 21051852, 18091059 -18306996, 16306373, 25369547, 19930276, 17787259, 19915271, 18193833 -20631274, 20513399, 16344544, 26439748, 25879656, 14692762, 18614015 -22782647, 17346091, 18413820, 19297917, 18228645, 17721717, 13960236 -18685892, 18436307, 11883252, 19888853, 21756677, 17891943, 19475971 -22353199, 16384983, 19121551, 27825893, 25634317, 12816846, 17982555 -17761775, 17227073, 13936038, 22243719, 17265217, 25505394, 17071721 -16721594, 18262334, 21756661, 17891946, 15913355, 17672719, 17602269 -17239687, 17042658, 25555252, 17238511, 21059919, 17811456, 17284817 -17752121, 20879889, 28806384, 21380789, 19601762, 17394950, 17011832 -28305362, 16579084, 22195465, 16875230, 14602788, 28790634, 18325460 -27567477, 30275351, 26569225, 24476265, 24476274, 12611721, 18674465 -16903536, 17006570, 19689979, 28076295, 16043574, 18783224, 22836801 -14705949, 24662775, 16494615, 21526048, 17392698, 19197175, 16069901 -17811447, 29200700, 27870645, 28876684, 17308789, 24835538, 22195477 -17865671, 17343514, 19013183, 17325413, 18316692, 16180763, 30275359 -17348614, 14368995, 21983325, 17393915, 16285691, 19788303, 19211433 -20331945, 17883081, 17705023, 24316947, 17614227, 23571055, 19578350 -22195485, 14084247, 24975421, 26078387, 23115139, 13645875, 23328639 -16777840, 19727057, 21698350, 14852021, 18744139, 18674047, 17716305 -19285025, 18482502, 17622427, 19289642, 27534509, 25947799, 22195492 -14458214, 20869721, 21172913, 17767676, 18723434, 25505407, 17786278 -19258504, 17082983, 17365043, 21351877, 13498382, 18331812, 16065166 -25489607, 16685417, 21566639, 18031668, 22893153, 17551674, 16943711 -19272701, 21517440, 25897615, 17649265, 13866822, 18094246, 24528741 -17783588, 14245531, 17082359, 18280813, 26007010, 20448824, 23330119 -16268425, 19487147, 25600421, 18018515, 17302277, 17215560, 24411921 -19271443, 25764020, 14176370, 17016369, 20777150, 16756406, 23330124 -22977256, 20441797, 19769489, 28100487, 17545847, 25093656, 18260550 -13853126, 17227277, 17551699, 23536835, 30237239, 25957038, 24652769 -20725343, 19207117, 9756271, 17495022, 18868646, 17614134, 26667023 -17546973, 19680952, 18704244, 26667015, 17050888, 18273830, 18828868 -17360606, 16992075, 24563422, 17375354, 12905058, 18362222, 21429602 -17254374, 27086138, 28364007, 26667032, 17571039, 17468141, 18436647 -17570606, 17235750, 21168487, 17279227, 16220077, 16929165 -``` - -## Version 11\.2\.0\.4\.v21 - -Version 11\.2\.0\.4\.v21 includes the following: -+ Patch 29497421: DATABASE PATCH SET UPDATE 11\.2\.0\.4\.190716 -+ Patch 29610422: OJVM PATCH SET UPDATE 11\.2\.0\.4\.190716 -+ Patch 28852325: DSTv33 for RDBMS \(TZDATA2018G\) -+ Patch 28852334: DSTv33 for OJVM \(TZDATA2018G\) -+ Patch 30018733: Oracle GoldenGate \- Oracle RDBMS Server Recommended Patches -+ Patch 28730253: SUPPORT NEW ERA REIWA FOR JAPANESE IMPERIAL CALENDAR - -### Oracle patch 29497421, released July 2019 - -Bugs fixed: - -``` -17184721, 21174504, 20169408, 21538558, 16091637, 18092127, 17381384 -15979965, 20671094, 16731148, 16314254, 18441944, 13837378, 17835048 -23105538, 17291347, 28254374, 13558557, 21842740, 21656630, 17008068 -18382302, 17201159, 25427662, 17853498, 21197626, 20717359, 17246576 -18356166, 18681862, 18440047, 20569094, 20031873, 16875449, 20387265 -19788842, 17296856, 21330264, 14010183, 17648596, 17025461, 18886413 -17551063, 17258582, 24719736, 17267114, 21063322, 22507210, 17912217 -17889583, 18202441, 17040764, 17478145, 16524926, 25655390, 19358317 -22730454, 22148226, 18747196, 26544823, 18641419, 17036973, 18948177 -17811789, 16542886, 14285317, 18009564, 17359610, 16618694, 8322815 -16832076, 18247991, 16692232, 22507234, 28022101, 17570240, 13871092 -24624166, 26631046, 24348685, 19429927, 17848897, 17441661, 14034426 -17465741, 20273319, 19207156, 16596890, 17437634, 18510194, 21343897 -20506706, 28849751, 18339044, 21453153, 17951233, 21795111, 22321741 -18430495, 21787056, 22380919, 19692824, 19469538, 20506715, 17811429 -17903598, 19721304, 11786053, 29511611, 18230522, 19554106, 19458377 -21281607, 17612828, 6599380, 18029658, 22092979, 17040527, 22321756 -17811438, 18641461, 18682983, 21502702, 14657740, 25635149, 13364795 -19490948, 21387964, 17346671, 17588480, 22351572, 18235390, 18849970 -26474853, 17889549, 19309466, 16472716, 23008056, 20627866, 24908321 -20134113, 25775213, 20596234, 18331850, 18641451, 20882568, 17019356 -17344412, 19461270, 21179898, 17546761, 24842886, 17231779, 14521849 -18203835, 18203838, 18964939, 18203837, 17313525, 22195457, 18139690 -16837842, 14106803, 22296366, 17842825, 22657942, 21352646, 16360112 -22594718, 20657441, 22195441, 17389192, 26198926, 14565184, 17019345 -19781326, 17205719, 18740837, 18440095, 14764829, 14354737, 22195448 -17019086, 13944971, 16571443, 21868720, 17186905, 17080436, 18673342 -28501075, 22905130, 17027426, 19972569, 27374796, 19972568, 16833845 -19972566, 20144308, 17282229, 19972564, 16870214, 16410570, 21629064 -19615136, 19871910, 21354456, 26039623, 17390431, 18762750, 23007241 -25248384, 16613964, 18098207, 17957017, 17484762, 18471685, 19730508 -18264060, 21538485, 17323222, 17754782, 17600719, 18317531, 17852463 -17596908, 17655634, 18166013, 16228604, 20074391, 27053456, 24790914 -19972570, 26482376, 20856766, 18090142, 19891090, 18996843, 16042673 -19854503, 17835627, 22901797, 20334344, 17393683, 20861693, 18000422 -17551709, 26575788, 23315889, 20506699, 19006849, 18277454, 18456514 -17258090, 19174430, 20657411, 17174582, 25654936, 17242746, 27097854 -16399083, 17824637, 21132297, 22465352, 17762296, 22168163, 28612674 -18604692, 17397545, 16450169, 12364061, 20067212, 18856999, 19211724 -19463893, 19463897, 27351628, 21343775, 17853456, 18373438, 18673304 -20004021, 26030218, 28000269, 21668627, 16194160, 17477958, 23140259 -16538760, 12982566, 24570598, 20828947, 27255377, 18259031, 20296213 -28855981, 21425496, 18293054, 17610798, 19699191, 23065323, 17311728 -18135678, 18774543, 23294548, 16785708, 10136473, 19777862, 22551446 -24560906, 17786518, 18315328, 25879984, 18334586, 22250006, 12747740 -18096714, 19032867, 21641760, 17390160, 18899974, 17232014, 20598042 -26679352, 26245237, 16354467, 17484731, 18673325, 16422541, 18155762 -19827973, 14015842, 22683225, 17726838, 18554871, 23177648, 18051556 -20803583, 18282562, 17922254, 15990359, 21972320, 16855292, 16668584 -21343838, 20299015, 17446237, 18043064, 18093615, 23713236, 17694209 -17288409, 20475845, 18308268, 17274537, 13955826, 16934803, 17634921 -17501491, 16315398, 23725036, 22683212, 17006183, 13829543, 18191164 -26746894, 22809871, 17655240, 28819280, 18384391, 19393542, 21538567 -17695685, 16198143, 21847223, 25823754, 17892268, 20142975, 19584068 -17165204, 25165496, 18604493, 18508861, 21756699, 18554763, 16901385 -21532755, 18189036, 17443671, 17385178, 14829250, 17936109, 20925795 -20509482, 17478514, 27441326, 16850630, 13951456, 16595641, 14054676 -15861775, 21142837, 16912439, 17299889, 17297939, 23003979, 16833527 -18619917, 17798953, 19697993, 17816865, 25914276, 18607546, 17571306 -21286665, 16898135, 17341326, 16819962, 26910644, 17851160, 17586955 -20558005, 19049453, 21051840, 17587063, 16956380, 25042823, 14735792 -18328509, 25423453, 14133975, 29033139, 19718981, 18061914, 16233738 -18522509, 17518652, 21051833, 20294666, 18765602, 23194294, 20860659 -18272672, 20324049, 18199537, 17332800, 13609098, 22502493, 18384537 -14338435, 27710072, 17945983, 16392068, 21067387, 17752995, 21097043 -21051862, 16863422, 17237521, 25505382, 18244962, 28357401, 19544839 -19433930, 24433711, 24717859, 17156148, 18973907, 23026585, 17449815 -17877323, 18180390, 17088068, 17037130, 20004087, 21422580, 19466309 -11733603, 25505371, 18610915, 21051858, 18084625, 29027694, 18674024 -26243698, 21051852, 18091059, 18306996, 25369547, 16306373, 19930276 -17787259, 18193833, 19915271, 20513399, 20631274, 16344544, 26439748 -25879656, 14692762, 18614015, 22782647, 17346091, 18413820, 19297917 -18228645, 17721717, 13960236, 18685892, 18436307, 11883252, 19888853 -21756677, 17891943, 19475971, 22353199, 16384983, 19121551, 27825893 -25634317, 12816846, 17982555, 17761775, 13936038, 17227073, 22243719 -17265217, 25505394, 17071721, 16721594, 18262334, 21756661, 17891946 -15913355, 17672719, 17602269, 17239687, 17042658, 25555252, 17238511 -21059919, 17811456, 17284817, 17752121, 20879889, 28806384, 19601762 -21380789, 17394950, 28305362, 17011832, 16579084, 22195465, 16875230 -14602788, 28790634, 18325460, 27567477, 26569225, 24476265, 24476274 -12611721, 18674465, 16903536, 17006570, 19689979, 28076295, 16043574 -18783224, 22836801, 24662775, 16494615, 21526048, 17392698, 19197175 -16069901, 29200700, 17811447, 27870645, 28876684, 17308789, 24835538 -22195477, 17865671, 17343514, 19013183, 17325413, 18316692, 16180763 -17348614, 14368995, 21983325, 17393915, 16285691, 19211433, 20331945 -17883081, 17705023, 24316947, 23571055, 17614227, 19578350, 22195485 -14084247, 24975421, 26078387, 23115139, 13645875, 23328639, 16777840 -21698350, 19727057, 14852021, 18744139, 18674047, 17716305, 19285025 -18482502, 17622427, 19289642, 27534509, 25947799, 22195492, 14458214 -20869721, 21172913, 17767676, 18723434, 25505407, 17786278, 19258504 -17082983, 17365043, 21351877, 13498382, 18331812, 16065166, 25489607 -16685417, 21566639, 18031668, 22893153, 17551674, 16943711, 19272701 -21517440, 25897615, 17649265, 13866822, 18094246, 24528741, 17783588 -14245531, 17082359, 18280813, 26007010, 20448824, 23330119, 16268425 -19487147, 25600421, 18018515, 17302277, 17215560, 24411921, 19271443 -25764020, 14176370, 17016369, 20777150, 16756406, 23330124, 22977256 -20441797, 19769489, 28100487, 17545847, 25093656, 18260550, 13853126 -17227277, 17551699, 23536835, 25957038, 24652769, 20725343, 19207117 -9756271, 17495022, 18868646, 17614134, 26667023, 17546973, 19680952 -18704244, 26667015, 17050888, 18273830, 18828868, 17360606, 16992075 -24563422, 17375354, 12905058, 18362222, 21429602, 17254374, 27086138 -26667032, 28364007, 17571039, 17468141, 18436647, 17570606, 17235750 -21168487, 17279227, 16220077, 16929165 -``` - -## Version 11\.2\.0\.4\.v20 - -Version 11\.2\.0\.4\.v20 includes the following: -+ Patch 29141056: DATABASE PATCH SET UPDATE 11\.2\.0\.4\.190416 -+ Patch 29251270: OJVM PATCH SET UPDATE 11\.2\.0\.4\.190416 -+ Patch 28852325: DSTv33 for RDBMS \(TZDATA2018G\) -+ Patch 28852334: DSTv33 for OJVM \(TZDATA2018G\) -+ Patch 29638593: Oracle GoldenGate \- Oracle RDBMS Server Recommended Patches -+ Patch 28730253: SUPPORT NEW ERA REIWA FOR JAPANESE IMPERIAL CALENDAR - -### Oracle patch 22768427, released April 2019 - -Bugs fixed: - -``` -17184721, 21174504, 21538558, 16091637, 18092127, 17381384, 15979965 -20671094, 16731148, 16314254, 13837378, 18441944, 17291347, 23105538 -17835048, 28254374, 13558557, 21656630, 21842740, 17008068, 18382302 -17201159, 25427662, 17853498, 21197626, 20717359, 17246576, 18356166 -18681862, 18440047, 20569094, 20031873, 16875449, 20387265, 19788842 -17296856, 21330264, 14010183, 17648596, 18886413, 17025461, 17551063 -24719736, 17267114, 21063322, 22507210, 17912217, 17889583, 18202441 -17040764, 17478145, 16524926, 25655390, 19358317, 22730454, 22148226 -18747196, 26544823, 18641419, 17036973, 18948177, 17811789, 16542886 -14285317, 18009564, 17359610, 16618694, 8322815, 16832076, 18247991 -16692232, 22507234, 17570240, 13871092, 24624166, 26631046, 19429927 -24348685, 17848897, 17441661, 14034426, 17465741, 20273319, 19207156 -16596890, 18510194, 17437634, 21343897, 20506706, 28849751, 18339044 -21453153, 17951233, 21795111, 22321741, 18430495, 21787056, 22380919 -19469538, 19692824, 20506715, 17811429, 17903598, 19721304, 11786053 -18230522, 19554106, 19458377, 21281607, 17612828, 6599380, 22092979 -17040527, 22321756, 17811438, 18641461, 18682983, 14657740, 25635149 -13364795, 19490948, 21387964, 17346671, 17588480, 22351572, 18235390 -18849970, 26474853, 17889549, 19309466, 20627866, 23008056, 16472716 -24908321, 20134113, 25775213, 20596234, 18331850, 18641451, 20882568 -17019356, 17344412, 19461270, 21179898, 17546761, 24842886, 17231779 -14521849, 18203835, 18203838, 18964939, 18203837, 17313525, 22195457 -18139690, 16837842, 14106803, 22296366, 17842825, 22657942, 21352646 -16360112, 22594718, 20657441, 22195441, 17389192, 26198926, 14565184 -19781326, 17019345, 17205719, 18740837, 18440095, 14764829, 14354737 -22195448, 17019086, 13944971, 16571443, 21868720, 17186905, 17080436 -18673342, 22905130, 17027426, 27374796, 19972569, 19972568, 20144308 -19972566, 17282229, 19972564, 16870214, 16410570, 21629064, 19615136 -21354456, 26039623, 17390431, 18762750, 23007241, 16613964, 17957017 -18098207, 17484762, 18471685, 19730508, 18264060, 21538485, 17323222 -17754782, 17600719, 18317531, 17852463, 17596908, 17655634, 18166013 -16228604, 20074391, 27053456, 24790914, 19972570, 20856766, 18090142 -19891090, 18996843, 16042673, 19854503, 17835627, 22901797, 20334344 -17393683, 20861693, 18000422, 17551709, 26575788, 23315889, 20506699 -19006849, 18277454, 18456514, 19174430, 17258090, 17174582, 25654936 -17242746, 27097854, 16399083, 17824637, 21132297, 22465352, 17762296 -22168163, 18604692, 17397545, 16450169, 12364061, 20067212, 18856999 -19211724, 19463893, 27351628, 19463897, 21343775, 17853456, 18373438 -18673304, 20004021, 28000269, 26030218, 21668627, 16194160, 17477958 -23140259, 16538760, 12982566, 24570598, 20828947, 27255377, 18259031 -20296213, 21425496, 28855981, 18293054, 17610798, 19699191, 23065323 -17311728, 18135678, 18774543, 23294548, 16785708, 10136473, 24560906 -19777862, 22551446, 17786518, 25879984, 18315328, 18334586, 12747740 -18096714, 19032867, 21641760, 17390160, 18899974, 17232014, 20598042 -26679352, 26245237, 16354467, 17484731, 18673325, 16422541, 18155762 -19827973, 14015842, 22683225, 17726838, 18554871, 23177648, 18051556 -20803583, 18282562, 21972320, 15990359, 17922254, 16855292, 16668584 -21343838, 20299015, 17446237, 18043064, 18093615, 23713236, 17694209 -17288409, 20475845, 18308268, 17274537, 13955826, 16934803, 17634921 -17501491, 16315398, 23725036, 22683212, 17006183, 13829543, 18191164 -26746894, 22809871, 17655240, 28819280, 18384391, 19393542, 21538567 -16198143, 21847223, 25823754, 17892268, 20142975, 19584068, 17165204 -25165496, 18604493, 21756699, 18508861, 18554763, 16901385, 21532755 -18189036, 17443671, 17385178, 14829250, 17936109, 20925795, 20509482 -17478514, 27441326, 16850630, 13951456, 16595641, 14054676, 15861775 -21142837, 16912439, 17299889, 17297939, 23003979, 16833527, 18619917 -17798953, 19697993, 17816865, 25914276, 18607546, 17571306, 21286665 -16898135, 16819962, 17341326, 26910644, 17851160, 17586955, 20558005 -19049453, 21051840, 17587063, 16956380, 18328509, 25423453, 14133975 -29033139, 19718981, 18061914, 18522509, 17518652, 21051833, 20294666 -18765602, 20860659, 18272672, 20324049, 18199537, 17332800, 13609098 -22502493, 18384537, 14338435, 17945983, 16392068, 21067387, 17752995 -21051862, 16863422, 17237521, 25505382, 18244962, 19544839, 24433711 -24717859, 17156148, 18973907, 23026585, 17449815, 17877323, 18180390 -17088068, 17037130, 20004087, 21422580, 19466309, 11733603, 25505371 -18610915, 21051858, 18084625, 29027694, 18674024, 26243698, 21051852 -18091059, 18306996, 25369547, 16306373, 17787259, 18193833, 19915271 -20513399, 20631274, 26439748, 16344544, 25879656, 14692762, 18614015 -22782647, 17346091, 18228645, 17721717, 13960236, 18685892, 18436307 -11883252, 19888853, 21756677, 17891943, 19475971, 22353199, 16384983 -19121551, 25634317, 27825893, 12816846, 17982555, 17761775, 17227073 -22243719, 17265217, 25505394, 17071721, 16721594, 18262334, 21756661 -17891946, 15913355, 17672719, 17602269, 17239687, 17042658, 25555252 -17238511, 21059919, 17811456, 17284817, 17752121, 20879889, 28806384 -21380789, 17394950, 17011832, 16579084, 22195465, 14602788, 28790634 -18325460, 27567477, 26569225, 24476265, 24476274, 12611721, 18674465 -16903536, 17006570, 19689979, 28076295, 16043574, 18783224, 24662775 -16494615, 21526048, 17392698, 19197175, 16069901, 17811447, 27870645 -28876684, 17308789, 24835538, 22195477, 17865671, 17343514, 19013183 -17325413, 18316692, 16180763, 17348614, 14368995, 21983325, 17393915 -16285691, 19211433, 20331945, 17883081, 17705023, 24316947, 17614227 -19578350, 22195485, 14084247, 24975421, 26078387, 23115139, 13645875 -16777840, 19727057, 14852021, 18744139, 18674047, 17716305, 19285025 -18482502, 17622427, 19289642, 27534509, 25947799, 22195492, 14458214 -20869721, 21172913, 17767676, 18723434, 25505407, 17786278, 19258504 -17082983, 17365043, 21351877, 13498382, 18331812, 16065166, 25489607 -16685417, 18031668, 22893153, 17551674, 16943711, 19272701, 21517440 -25897615, 17649265, 13866822, 18094246, 24528741, 17783588, 14245531 -17082359, 26007010, 18280813, 20448824, 23330119, 16268425, 19487147 -25600421, 18018515, 17302277, 17215560, 24411921, 19271443, 25764020 -14176370, 17016369, 20777150, 16756406, 23330124, 22977256, 20441797 -19769489, 28100487, 17545847, 25093656, 18260550, 13853126, 17227277 -17551699, 23536835, 25957038, 24652769, 20725343, 19207117, 9756271 -18868646, 17614134, 26667023, 17546973, 19680952, 18704244, 26667015 -17050888, 18273830, 18828868, 17360606, 16992075, 24563422, 17375354 -12905058, 18362222, 21429602, 17254374, 26667032, 28364007, 27086138 -17571039, 17468141, 18436647, 17570606, 17235750, 21168487, 17279227 -16220077, 16929165 -``` - -## Version 11\.2\.0\.4\.v19 - -Version 11\.2\.0\.4\.v19 includes the following: -+ Patch 28729262: Oracle Database Patch Set Update 11\.2\.0\.4\.190115 -+ Patch 28790660: Oracle JVM Patch Set Update 11\.2\.0\.4\.190115 -+ Patch 28125601: DSTv32 for RDBMS \(TZDATA2018E\) -+ Patch 27015468: DSTv32 for OJVM \(TZDATA2018E\) -+ Patch 27216420: Oracle GoldenGate \- Oracle RDBMS Server Recommended Patches - -### Oracle patch 28729262, released January 2019 - -Bugs fixed: - -``` -17288409, 21051852, 24316947, 17811429, 17205719, 18607546, 25654936 -17484762, 17816865, 20506699, 24835538, 25957038, 19692824, 23330119 -17922254, 17754782, 13364795, 16934803, 17311728, 18604692, 20387265 -26679352, 17284817, 17441661, 20671094, 24560906, 16992075, 25635149 -17446237, 14015842, 19972569, 21756677, 17375354, 17449815, 20925795 -21538558, 17019086, 19463897, 26575788, 13866822, 17235750, 17982555 -17478514, 18317531, 14338435, 18235390, 19461270, 20803583, 13944971 -19475971, 20142975, 17811789, 16929165, 18704244, 24662775, 20506706 -17546973, 21422580, 17359610, 20334344, 14054676, 25489607, 17088068 -17570606, 18264060, 17346091, 17343514, 21538567, 19680952, 18471685 -19211724, 21132297, 23105538, 13951456, 25775213, 16315398, 21847223 -18744139, 16850630, 23177648, 19049453, 18673304, 18090142, 17883081 -19915271, 18641419, 18262334, 25600421, 17006183, 16065166, 18277454 -18685892, 16833527, 10136473, 18051556, 17865671, 25879984, 18554871 -17852463, 18774543, 17853498, 18334586, 19487147, 20879889, 17551709 -17588480, 19827973, 17344412, 17842825, 18828868, 20509482, 17025461 -13609098, 19429927, 26039623, 11883252, 17239687, 16410570, 23007241 -17602269, 19197175, 22195457, 18316692, 17313525, 12611721, 21174504 -19544839, 18964939, 20294666, 17600719, 26667015, 18191164, 17571306 -19393542, 18482502, 20777150, 27086138, 19466309, 22243719, 17165204 -17040527, 18098207, 16785708, 24790914, 19891090, 17465741, 16180763 -17174582, 12982566, 16777840, 27097854, 19463893, 22195465, 16875449 -22148226, 12816846, 17237521, 6599380, 19358317, 17811438, 25505394 -17811447, 21983325, 17945983, 18762750, 16912439, 17184721, 18061914 -20598042, 26631046, 21380789, 17282229, 18948177, 18331850, 21142837 -18202441, 17082359, 18723434, 19554106, 21532755, 21972320, 25505371 -20273319, 14034426, 18339044, 19458377, 17752995, 20448824, 17891943 -17767676, 17258090, 16668584, 18384391, 21063322, 17040764, 17381384 -15913355, 18356166, 14084247, 20596234, 21641760, 20506715, 13853126 -21756661, 18203837, 18610915, 14245531, 16043574, 21756699, 22195441 -17848897, 17877323, 26667032, 28790634, 19272701, 21453153, 20569094 -17468141, 17786518, 20861693, 17912217, 17037130, 16956380, 18155762 -17478145, 17394950, 18189036, 18641461, 17551674, 18619917, 17027426 -17019356, 21352646, 16268425, 24476274, 22195492, 19584068, 26544823 -18436307, 22507210, 17265217, 13498382, 17634921, 19469538, 21526048 -19258504, 23003979, 16354467, 18043064, 19174430, 20004087, 17443671 -22195485, 18000422, 22321756, 20004021, 17571039, 27053456, 25897615 -16832076, 21067387, 22905130, 16344544, 21429602, 18009564, 14354737 -18135678, 21286665, 18614015, 14521849, 20441797, 28876684, 18362222 -25655390, 16472716, 17835048, 17050888, 17936109, 14010183, 17325413 -18747196, 19207156, 17231779, 21842740, 17761775, 16721594, 17082983 -20067212, 21179898, 17279227, 17302277, 18084625, 20717359, 24624166 -15990359, 24842886, 26746894, 18203835, 23026585, 17297939, 17811456 -16731148, 22380919, 21168487, 14133975, 17215560, 13829543, 18740837 -17694209, 17385178, 18091059, 8322815, 18259031, 17586955, 19689979 -25165496, 28254374, 17201159, 17655634, 18331812, 19730508, 17551699 -17648596, 18868646, 16220077, 16069901, 17393915, 17348614, 17957017 -17274537, 18096714, 17308789, 18436647, 14285317, 19289642, 14764829 -17622427, 18328509, 23115139, 16943711, 22195477, 22502493, 14368995 -17346671, 18996843, 17783588, 18604493, 21343838, 16618694, 17672719 -18856999, 18783224, 17851160, 17546761, 22168163, 17798953, 18273830 -22092979, 16596890, 19972566, 13871092, 20828947, 26667023, 17726838 -16384983, 22296366, 17360606, 13645875, 22321741, 16542886, 18199537 -25879656, 25634317, 21787056, 23140259, 17889549, 21172913, 14565184 -26245237, 20475845, 27825893, 17071721, 21281607, 17610798, 18308268 -20299015, 21343897, 22893153, 22594718, 28076295, 20657441, 17397545 -18230522, 16360112, 19769489, 12905058, 18641451, 12747740, 18430495 -25423453, 17016369, 17042658, 14602788, 17551063, 26243698, 19972568 -21517440, 23725036, 19788842, 18508861, 14657740, 17332800, 13837378 -17186905, 19972564, 17019345, 19699191, 18315328, 27441326, 17437634 -24570598, 22353199, 18093615, 19006849, 28806384, 17392698, 19013183 -17296856, 18674024, 26569225, 17232014, 16855292, 21051840, 14692762 -17762296, 17705023, 23294548, 22351572, 22507234, 19121551, 20324049 -21330264, 26198926, 19854503, 23315889, 26030218, 26910644, 21868720 -19309466, 27567477, 25764020, 18681862, 17365043, 17390160, 18554763 -20031873, 20558005, 24717859, 21795111, 18456514, 13955826, 16306373 -18139690, 17501491, 17752121, 17299889, 21668627, 23713236, 24652769 -17889583, 18673325, 22551446, 17242746, 18293054, 18674465, 19721304 -19211433, 19888853, 25914276, 24563422, 17951233, 18094246, 17649265 -19615136, 17011832, 17477958, 16870214, 18522509, 20631274, 16091637 -17323222, 16595641, 16524926, 18228645, 17484731, 18282562, 17596908 -18272672, 18031668, 17156148, 16494615, 22683225, 20869721, 17545847 -25093656, 28819280, 18682983, 17655240, 24528741, 17614134, 13558557 -25427662, 17341326, 22465352, 29033139, 17891946, 17716305, 22657942 -27374796, 16392068, 18440095, 19271443, 21351877, 20513399, 18092127 -17614227, 18440047, 18849970, 14106803, 16903536, 20725343, 18973907 -18673342, 17389192, 25505382, 22809871, 19032867, 17612828, 17006570 -16194160, 25369547, 25505407, 16685417, 17721717, 21354456, 17390431 -17570240, 16863422, 13960236, 28100487, 18325460, 17008068, 19727057 -28855981, 16422541, 17267114, 19972570, 18244962, 21538485, 18203838 -18765602, 16198143, 17246576, 14829250, 28364007, 17835627, 20860659 -21629064, 18247991, 14458214, 21051862, 17786278, 16692232, 17227277 -24348685, 16042673, 24476265, 24975421, 22901797, 16314254, 19285025 -16228604, 16756406, 14176370, 16837842, 20144308, 17393683, 23536835 -25823754, 18899974, 17787259, 24719736, 20331945, 26078387, 20074391 -19490948, 15861775, 16399083, 25947799, 25555252, 18018515, 22683212 -18260550, 21051858, 17080436, 16613964, 17036973, 16579084, 24433711 -18384537, 27870645, 18280813, 20296213, 16901385, 15979965, 17518652 -23330124, 20856766, 18441944, 16450169, 9756271, 27534509, 22730454 -19718981, 17291347, 17892268, 11733603, 16285691, 17587063, 21343775 -18180390, 16538760, 26474853, 18193833, 21387964, 21051833, 17238511 -19777862, 17824637, 23065323, 21656630, 19697993, 17903598, 16571443 -18306996, 18166013, 19578350, 14852021, 18674047, 17853456, 12364061 -24411921, 19207117, 22195448 -``` - -## Version 11\.2\.0\.4\.v18 - -Version 11\.2\.0\.4\.v18 includes the following: -+ Patch 28204707: Oracle Database Patch Set Update 11\.2\.0\.4\.181016 -+ Patch 28440700: Oracle JVM Patch Set Update 11\.2\.0\.4\.181016 -+ Patch 28125601: DSTv32 for RDBMS \(TZDATA2018E\) -+ Patch 27015468: DSTv32 for OJVM \(TZDATA2018E\) -+ Patch 27216420: Oracle GoldenGate \- Oracle RDBMS Server Recommended Patches -+ Patches 27659043 and 19692824 are now included in the Database Patch Set Update - -### Oracle patch 28204707, released October 2018 - -Bugs fixed: - -``` -17288409, 21051852, 24316947, 17811429, 17205719, 18607546, 25654936 -17484762, 17816865, 20506699, 24835538, 25957038, 19692824, 23330119 -17922254, 17754782, 13364795, 16934803, 17311728, 18604692, 26679352 -20387265, 17284817, 17441661, 20671094, 24560906, 25635149, 16992075 -17446237, 14015842, 19972569, 21756677, 17375354, 21538558, 20925795 -17449815, 17019086, 19463897, 26575788, 13866822, 17235750, 17982555 -17478514, 18317531, 14338435, 18235390, 19461270, 20803583, 13944971 -19475971, 20142975, 17811789, 16929165, 18704244, 24662775, 20506706 -17359610, 17546973, 21422580, 20334344, 14054676, 25489607, 17570606 -17088068, 17346091, 18264060, 17343514, 21538567, 19680952, 18471685 -19211724, 21132297, 25775213, 13951456, 16315398, 21847223, 18744139 -16850630, 23177648, 19049453, 18090142, 18673304, 17883081, 19915271 -18641419, 18262334, 25600421, 17006183, 16065166, 18277454, 18685892 -16833527, 10136473, 18051556, 17865671, 25879984, 18554871, 17852463 -18774543, 17853498, 18334586, 19487147, 20879889, 17551709, 17588480 -19827973, 17344412, 17842825, 18828868, 20509482, 17025461, 26039623 -19429927, 13609098, 11883252, 16410570, 17239687, 23007241, 17602269 -19197175, 22195457, 18316692, 17313525, 12611721, 21174504, 19544839 -20294666, 18964939, 17600719, 26667015, 18191164, 17571306, 19393542 -20777150, 18482502, 27086138, 19466309, 22243719, 17165204, 17040527 -18098207, 24790914, 16785708, 19891090, 17465741, 16180763, 17174582 -12982566, 16777840, 19463893, 22195465, 16875449, 22148226, 12816846 -17237521, 6599380, 19358317, 17811438, 25505394, 17811447, 21983325 -17945983, 18762750, 16912439, 17184721, 18061914, 20598042, 26631046 -21380789, 17282229, 18948177, 18331850, 21142837, 18202441, 17082359 -18723434, 21972320, 21532755, 19554106, 25505371, 20273319, 14034426 -18339044, 19458377, 17752995, 20448824, 17891943, 17767676, 17258090 -16668584, 18384391, 21063322, 17040764, 17381384, 15913355, 18356166 -14084247, 20596234, 21641760, 20506715, 13853126, 21756661, 18610915 -18203837, 14245531, 16043574, 21756699, 22195441, 17848897, 17877323 -26667032, 21453153, 19272701, 20569094, 17468141, 17786518, 20861693 -17912217, 17037130, 16956380, 18155762, 17478145, 17394950, 18641461 -18189036, 17551674, 18619917, 17019356, 17027426, 21352646, 16268425 -24476274, 22195492, 19584068, 26544823, 18436307, 22507210, 17265217 -13498382, 17634921, 19469538, 21526048, 19258504, 23003979, 16354467 -18043064, 19174430, 20004087, 17443671, 22195485, 18000422, 22321756 -20004021, 17571039, 25897615, 27053456, 16832076, 21067387, 22905130 -16344544, 21429602, 18009564, 14354737, 21286665, 18135678, 14521849 -18614015, 20441797, 18362222, 25655390, 16472716, 17835048, 17050888 -17936109, 14010183, 17325413, 18747196, 19207156, 17231779, 21842740 -17761775, 16721594, 17082983, 20067212, 21179898, 17279227, 17302277 -18084625, 20717359, 24624166, 15990359, 24842886, 26746894, 18203835 -23026585, 17297939, 17811456, 16731148, 22380919, 21168487, 14133975 -13829543, 17215560, 18740837, 17694209, 17385178, 18091059, 8322815 -18259031, 28254374, 19689979, 25165496, 17586955, 17201159, 17655634 -18331812, 17551699, 19730508, 17648596, 18868646, 16220077, 16069901 -17393915, 17348614, 17957017, 17274537, 18096714, 17308789, 18436647 -14285317, 19289642, 14764829, 17622427, 18328509, 23115139, 16943711 -22195477, 22502493, 14368995, 17346671, 18996843, 17783588, 18604493 -21343838, 16618694, 17672719, 18856999, 18783224, 17851160, 17546761 -22168163, 17798953, 18273830, 22092979, 16596890, 19972566, 13871092 -20828947, 26667023, 17726838, 16384983, 22296366, 17360606, 13645875 -22321741, 25634317, 16542886, 18199537, 25879656, 21787056, 23140259 -17889549, 21172913, 26245237, 14565184, 27825893, 20475845, 17071721 -21281607, 17610798, 18308268, 20299015, 21343897, 22893153, 22594718 -20657441, 17397545, 18230522, 16360112, 19769489, 12905058, 18641451 -12747740, 18430495, 25423453, 17016369, 17042658, 14602788, 17551063 -26243698, 19972568, 21517440, 23725036, 19788842, 18508861, 14657740 -17332800, 13837378, 17186905, 19972564, 17019345, 19699191, 18315328 -27441326, 17437634, 24570598, 22353199, 18093615, 19006849, 17392698 -19013183, 17296856, 18674024, 26569225, 17232014, 16855292, 21051840 -14692762, 17762296, 17705023, 23294548, 22351572, 22507234, 19121551 -20324049, 21330264, 26198926, 19854503, 23315889, 26910644, 26030218 -21868720, 19309466, 25764020, 18681862, 17365043, 17390160, 20031873 -20558005, 18554763, 24717859, 21795111, 18456514, 13955826, 16306373 -18139690, 17501491, 17752121, 17299889, 21668627, 23713236, 24652769 -17889583, 18673325, 22551446, 18674465, 17242746, 19721304, 18293054 -19211433, 19888853, 25914276, 24563422, 17951233, 18094246, 17649265 -19615136, 17011832, 17477958, 16870214, 18522509, 20631274, 16091637 -17323222, 16595641, 16524926, 17484731, 18228645, 18282562, 17596908 -18272672, 18031668, 17156148, 16494615, 22683225, 20869721, 17545847 -25093656, 18682983, 17655240, 24528741, 17614134, 25427662, 13558557 -17341326, 22465352, 17891946, 17716305, 22657942, 27374796, 16392068 -18440095, 19271443, 21351877, 20513399, 18092127, 17614227, 18440047 -18849970, 16903536, 14106803, 20725343, 18973907, 18673342, 17389192 -19032867, 25505382, 22809871, 17612828, 17006570, 16194160, 25369547 -25505407, 16685417, 17721717, 21354456, 17390431, 17570240, 13960236 -16863422, 28100487, 18325460, 17008068, 19727057, 16422541, 17267114 -19972570, 18244962, 21538485, 18203838, 18765602, 16198143, 17246576 -14829250, 28364007, 17835627, 20860659, 21629064, 18247991, 14458214 -21051862, 17786278, 16692232, 17227277, 24348685, 24476265, 16042673 -24975421, 22901797, 16314254, 19285025, 16228604, 16756406, 14176370 -16837842, 20144308, 17393683, 23536835, 25823754, 18899974, 17787259 -24719736, 20331945, 26078387, 19490948, 20074391, 15861775, 16399083 -25555252, 25947799, 18018515, 22683212, 18260550, 21051858, 17080436 -16613964, 17036973, 16579084, 24433711, 18384537, 27870645, 18280813 -20296213, 16901385, 15979965, 17518652, 23330124, 20856766, 18441944 -16450169, 9756271, 27534509, 22730454, 19718981, 17291347, 17892268 -11733603, 16285691, 17587063, 21343775, 18180390, 26474853, 16538760 -18193833, 21387964, 21051833, 17238511, 19777862, 17824637, 23065323 -21656630, 17903598, 16571443, 18166013, 18306996, 19578350, 14852021 -17853456, 18674047, 12364061, 24411921, 19207117, 22195448 -``` - -## Version 11\.2\.0\.4\.v17 - -Version 11\.2\.0\.4\.v17 includes the following: -+ Patch 27734982: Oracle Database Patch Set Update 11\.2\.0\.4\.180717 -+ Patch 27923163: Oracle JVM Patch Set Update 11\.2\.0\.4\.180717 -+ Patch 28125601: DSTv32 for RDBMS \(TZDATA2018E\) -+ Patch 27015468: DSTv32 for OJVM \(TZDATA2018E\) -+ Patch 27216420: Oracle GoldenGate \- Oracle RDBMS Server Recommended Patches -+ Patch 27659043: MES Bundle 405 -+ Patch 19692824: DBCONTROL is not coming up on OEL 7 - -### Oracle patch 27734982, released July 2018 - -Bugs fixed: - -``` -17288409, 21051852, 24316947, 17811429, 17205719, 18607546, 25654936 -17816865, 20506699, 24835538, 25957038, 23330119, 17922254, 17754782 -13364795, 16934803, 17311728, 20387265, 17284817, 17441661, 20671094 -24560906, 16992075, 17446237, 14015842, 19972569, 21756677, 17375354 -21538558, 20925795, 17449815, 19463897, 26575788, 13866822, 17235750 -17982555, 17478514, 18317531, 14338435, 18235390, 19461270, 20803583 -13944971, 19475971, 20142975, 17811789, 16929165, 18704244, 24662775 -20506706, 17546973, 21422580, 20334344, 14054676, 25489607, 17088068 -17346091, 18264060, 17343514, 21538567, 19680952, 18471685, 19211724 -21132297, 13951456, 16315398, 21847223, 18744139, 16850630, 23177648 -19049453, 18090142, 18673304, 17883081, 19915271, 18641419, 18262334 -25600421, 17006183, 16065166, 18277454, 16833527, 10136473, 18051556 -17865671, 18554871, 17852463, 18774543, 17853498, 18334586, 19487147 -20879889, 17551709, 17588480, 19827973, 17344412, 17842825, 18828868 -20509482, 17025461, 13609098, 11883252, 17239687, 23007241, 17602269 -19197175, 22195457, 18316692, 17313525, 12611721, 21174504, 19544839 -20294666, 18964939, 17600719, 26667015, 18191164, 17571306, 19393542 -20777150, 18482502, 27086138, 19466309, 22243719, 17165204, 17040527 -18098207, 16785708, 17465741, 16180763, 17174582, 12982566, 16777840 -19463893, 22195465, 16875449, 22148226, 12816846, 17237521, 6599380 -19358317, 17811438, 25505394, 17811447, 21983325, 17945983, 18762750 -16912439, 17184721, 18061914, 20598042, 21380789, 17282229, 18948177 -18331850, 21142837, 18202441, 17082359, 18723434, 21972320, 21532755 -19554106, 25505371, 14034426, 18339044, 19458377, 17752995, 20448824 -17891943, 17767676, 17258090, 16668584, 18384391, 17040764, 17381384 -15913355, 18356166, 14084247, 20596234, 21641760, 20506715, 13853126 -21756661, 18203837, 14245531, 16043574, 21756699, 22195441, 17848897 -17877323, 21453153, 19272701, 20569094, 17468141, 17786518, 20861693 -17912217, 17037130, 16956380, 18155762, 17478145, 17394950, 18641461 -18189036, 18619917, 17027426, 21352646, 16268425, 24476274, 22195492 -19584068, 26544823, 18436307, 22507210, 17265217, 13498382, 17634921 -19469538, 21526048, 19258504, 23003979, 18043064, 19174430, 20004087 -17443671, 22195485, 18000422, 20004021, 22321756, 17571039, 27053456 -25897615, 21067387, 16832076, 22905130, 16344544, 21429602, 18009564 -14354737, 21286665, 18135678, 14521849, 18614015, 20441797, 18362222 -25655390, 16472716, 17835048, 17050888, 17936109, 14010183, 17325413 -18747196, 17761775, 16721594, 17082983, 20067212, 21179898, 17302277 -18084625, 20717359, 24624166, 15990359, 24842886, 26746894, 18203835 -23026585, 17297939, 17811456, 16731148, 22380919, 21168487, 14133975 -13829543, 17215560, 17694209, 17385178, 18091059, 8322815, 18259031 -19689979, 25165496, 17586955, 17201159, 17655634, 18331812, 19730508 -17648596, 18868646, 16220077, 16069901, 17393915, 17348614, 17957017 -17274537, 18096714, 17308789, 18436647, 14285317, 19289642, 14764829 -17622427, 18328509, 16943711, 22195477, 22502493, 14368995, 17346671 -18996843, 17783588, 18604493, 21343838, 16618694, 17672719, 18856999 -18783224, 17851160, 17546761, 22168163, 17798953, 18273830, 22092979 -16596890, 19972566, 20828947, 13871092, 26667023, 17726838, 16384983 -22296366, 17360606, 13645875, 22321741, 16542886, 18199537, 25879656 -21787056, 17889549, 21172913, 14565184, 27825893, 20475845, 17071721 -21281607, 18308268, 17610798, 20299015, 21343897, 22893153, 20657441 -17397545, 18230522, 16360112, 19769489, 12905058, 18641451, 12747740 -18430495, 25423453, 17016369, 17042658, 14602788, 17551063, 19972568 -21517440, 23725036, 19788842, 18508861, 14657740, 17332800, 13837378 -17186905, 19972564, 19699191, 18315328, 27441326, 17437634, 24570598 -22353199, 18093615, 19006849, 17392698, 19013183, 17296856, 18674024 -26569225, 17232014, 16855292, 21051840, 14692762, 17762296, 17705023 -23294548, 22351572, 22507234, 19121551, 20324049, 21330264, 26198926 -19854503, 23315889, 26910644, 26030218, 21868720, 19309466, 25764020 -18681862, 17365043, 17390160, 20031873, 20558005, 18554763, 24717859 -21795111, 18456514, 16306373, 13955826, 18139690, 17501491, 17752121 -17299889, 21668627, 23713236, 24652769, 17889583, 18673325, 22551446 -17242746, 19721304, 18293054, 19211433, 19888853, 24563422, 17951233 -18094246, 17649265, 19615136, 17011832, 17477958, 16870214, 18522509 -20631274, 16091637, 17323222, 16595641, 16524926, 18228645, 18282562 -17596908, 18031668, 17156148, 16494615, 22683225, 20869721, 17545847 -25093656, 17655240, 24528741, 17614134, 25427662, 13558557, 17341326 -22465352, 17891946, 17716305, 22657942, 27374796, 16392068, 18440095 -19271443, 21351877, 20513399, 18092127, 17614227, 18440047, 18849970 -16903536, 14106803, 18973907, 18673342, 17389192, 19032867, 25505382 -22809871, 17612828, 17006570, 16194160, 25369547, 25505407, 16685417 -17721717, 21354456, 17390431, 17570240, 16863422, 28100487, 18325460 -17008068, 19727057, 16422541, 17267114, 19972570, 18244962, 21538485 -18203838, 18765602, 16198143, 17246576, 14829250, 17835627, 20860659 -21629064, 18247991, 14458214, 21051862, 17786278, 16692232, 24348685 -17227277, 24476265, 16042673, 16314254, 19285025, 16228604, 16756406 -16837842, 20144308, 17393683, 23536835, 25823754, 18899974, 17787259 -24719736, 20331945, 19490948, 20074391, 15861775, 16399083, 25947799 -18018515, 22683212, 18260550, 21051858, 17080436, 16613964, 17036973 -16579084, 24433711, 18384537, 27870645, 18280813, 20296213, 16901385 -15979965, 23330124, 18441944, 16450169, 27534509, 9756271, 17892268 -11733603, 16285691, 17587063, 21343775, 18180390, 26474853, 16538760 -18193833, 21387964, 21051833, 17238511, 19777862, 17824637, 23065323 -17903598, 16571443, 18306996, 19578350, 14852021, 17853456, 18674047 -12364061, 24411921, 19207117, 22195448 -``` - -## Version 11\.2\.0\.4\.v16 - -Version 11\.2\.0\.4\.v16 includes the following: -+ Patch 27338049: DATABASE PATCH SET UPDATE 11\.2\.0\.4\.180417 -+ Patch 27475598: OJVM PATCH SET UPDATE 11\.2\.0\.4\.180417 -+ Patch 27015449: RDBMS \- PROACTIVE DSTV31 UPDATE \- TZDATA2017C -+ Patch 27015468: PROACTIVE DSTV31 UPDATE \- TZDATA2017C \- NEED OJVM FIX -+ Patch 27216420: Oracle GoldenGate \- Oracle RDBMS Server Recommended Patches -+ Patch 27659043: MES 405 BUNDLE ON TOP OF RDBMS 11\.2\.0\.4\.180116 PSU -+ Patch 19692824: DBCONTROL is not coming up on OEL 7 -+ Support for the `DBMS_ADVANCED_REWRITE` package -+ Fixed a bug where `DBA_LOCKS` and associated views available in new DB instances of 11\.2\.0\.4\.v15 were not created in upgrades to 11\.2\.0\.4\.v15\. Views are now created in new and upgraded DB instances of 11\.2\.0\.4\.v16 and later\. - -### Oracle patch 27338049, released April 2018 - -Bugs fixed: - -``` -21174504, 17184721, 21538558, 16091637, 18092127, 17381384, 15979965 -20671094, 16731148, 16314254, 13837378, 18441944, 17835048, 13558557 -17008068, 17201159, 25427662, 17853498, 20717359, 17246576, 18356166 -18681862, 18440047, 20569094, 20031873, 16875449, 20387265, 19788842 -17296856, 21330264, 14010183, 17648596, 17551063, 17025461, 24719736 -17267114, 22507210, 17912217, 17889583, 18202441, 17040764, 17478145 -16524926, 25655390, 19358317, 22148226, 18747196, 26544823, 18641419 -17036973, 18948177, 17811789, 16542886, 14285317, 18009564, 16618694 -8322815, 16832076, 18247991, 16692232, 22507234, 17570240, 13871092 -24624166, 17848897, 17441661, 14034426, 17465741, 16596890, 17437634 -21343897, 20506706, 21453153, 18339044, 22321741, 21795111, 17951233 -18430495, 21787056, 22380919, 19469538, 20506715, 17811429, 19721304 -17903598, 18230522, 19554106, 19458377, 21281607, 17612828, 6599380 -22092979, 22321756, 17040527, 17811438, 18641461, 14657740, 13364795 -21387964, 19490948, 22351572, 17346671, 17588480, 18235390, 26474853 -18849970, 17889549, 19309466, 16472716, 20596234, 18331850, 18641451 -17344412, 21179898, 19461270, 17546761, 24842886, 14521849, 18203835 -18203838, 18964939, 18203837, 17313525, 22195457, 18139690, 16837842 -22296366, 14106803, 17842825, 21352646, 22657942, 16360112, 20657441 -22195441, 17389192, 26198926, 14565184, 17205719, 18440095, 14764829 -22195448, 14354737, 13944971, 16571443, 21868720, 17186905, 17080436 -18673342, 22905130, 17027426, 27374796, 19972569, 19972568, 20144308 -19972566, 17282229, 19972564, 16870214, 21629064, 19615136, 21354456 -17390431, 18762750, 23007241, 16613964, 17957017, 18098207, 18471685 -19730508, 21538485, 18264060, 17323222, 17754782, 17600719, 18317531 -17852463, 17596908, 17655634, 16228604, 27053456, 20074391, 19972570 -18090142, 18996843, 19854503, 16042673, 17835627, 20334344, 17393683 -20861693, 18000422, 17551709, 26575788, 23315889, 20506699, 19006849 -18277454, 18456514, 19174430, 17258090, 17174582, 25654936, 17242746 -16399083, 17824637, 21132297, 22465352, 17762296, 22168163, 17397545 -16450169, 12364061, 20067212, 18856999, 19211724, 19463893, 19463897 -21343775, 17853456, 18673304, 20004021, 26030218, 21668627, 16194160 -17477958, 16538760, 12982566, 24570598, 20828947, 18259031, 20296213 -18293054, 17610798, 19699191, 23065323, 17311728, 18135678, 18774543 -23294548, 16785708, 10136473, 24560906, 22551446, 19777862, 17786518 -18315328, 18334586, 12747740, 18096714, 19032867, 21641760, 18899974 -17390160, 17232014, 20598042, 18673325, 16422541, 18155762, 14015842 -19827973, 22683225, 17726838, 18554871, 23177648, 18051556, 20803583 -21972320, 15990359, 17922254, 18282562, 16855292, 16668584, 21343838 -20299015, 17446237, 18093615, 18043064, 23713236, 17694209, 17288409 -20475845, 17274537, 13955826, 16934803, 17634921, 17501491, 16315398 -22683212, 17006183, 13829543, 18191164, 17655240, 26746894, 22809871 -18384391, 19393542, 21538567, 16198143, 21847223, 25823754, 17892268 -20142975, 19584068, 17165204, 25165496, 18604493, 21756699, 18508861 -16901385, 18554763, 21532755, 18189036, 17443671, 17385178, 14829250 -17936109, 20925795, 20509482, 17478514, 27441326, 16850630, 13951456 -16595641, 14054676, 15861775, 21142837, 16912439, 17299889, 17297939 -23003979, 18619917, 16833527, 17798953, 17816865, 18607546, 17571306 -21286665, 17341326, 26910644, 17851160, 20558005, 17586955, 19049453 -21051840, 17587063, 16956380, 18328509, 25423453, 14133975, 18061914 -18522509, 21051833, 18765602, 20860659, 20324049, 18199537, 17332800 -13609098, 22502493, 18384537, 14338435, 17945983, 16392068, 21067387 -17752995, 21051862, 16863422, 25505382, 17237521, 18244962, 19544839 -24433711, 24717859, 17156148, 18973907, 23026585, 17877323, 17449815 -18180390, 17088068, 17037130, 20004087, 21422580, 19466309, 11733603 -25505371, 21051858, 18084625, 18674024, 21051852, 18091059, 25369547 -16306373, 18306996, 18193833, 19915271, 17787259, 20513399, 20631274 -25879656, 16344544, 14692762, 18614015, 17346091, 18228645, 17721717 -18436307, 21756677, 19888853, 11883252, 17891943, 19475971, 22353199 -16384983, 19121551, 12816846, 17982555, 17761775, 22243719, 17265217 -25505394, 17071721, 16721594, 21756661, 18262334, 17891946, 15913355 -17672719, 17602269, 17239687, 17042658, 17238511, 17811456, 17284817 -17752121, 20879889, 21380789, 17394950, 17011832, 16579084, 22195465 -14602788, 18325460, 24476265, 26569225, 24476274, 12611721, 16903536 -17006570, 19689979, 16043574, 18783224, 24662775, 16494615, 21526048 -17392698, 19197175, 16069901, 17811447, 17308789, 22195477, 24835538 -17865671, 17343514, 19013183, 17325413, 18316692, 16180763, 17348614 -14368995, 21983325, 17393915, 16285691, 19211433, 20331945, 17883081 -17705023, 24316947, 17614227, 19578350, 22195485, 14084247, 13645875 -16777840, 19727057, 14852021, 18744139, 18674047, 17716305, 19285025 -18482502, 17622427, 19289642, 22195492, 25947799, 14458214, 20869721 -21172913, 17767676, 18723434, 25505407, 17786278, 19258504, 17082983 -21351877, 17365043, 13498382, 18331812, 16065166, 25489607, 16685417 -18031668, 22893153, 16943711, 19272701, 21517440, 25897615, 17649265 -13866822, 18094246, 24528741, 17783588, 14245531, 17082359, 18280813 -20448824, 23330119, 16268425, 19487147, 25600421, 18018515, 17302277 -17215560, 24411921, 19271443, 25764020, 17016369, 20777150, 23330124 -16756406, 20441797, 19769489, 17545847, 25093656, 18260550, 13853126 -17227277, 23536835, 25957038, 24652769, 19207117, 9756271, 18868646 -17614134, 26667023, 17546973, 18704244, 19680952, 26667015, 17050888 -18828868, 18273830, 17360606, 24563422, 16992075, 17375354, 12905058 -18362222, 21429602, 27086138, 17571039, 17468141, 18436647, 17235750 -21168487, 16220077, 16929165 -``` - -## Version 11\.2\.0\.4\.v15 - -Version 11\.2\.0\.4\.v15 includes the following: -+ Patch 26925576: DATABASE PATCH SET UPDATE 11\.2\.0\.4\.180116 -+ Patch 26925532: OJVM PATCH SET UPDATE 11\.2\.0\.4\.180116 -+ Patch 27015449: RDBMS \- PROACTIVE DSTV31 UPDATE \- TZDATA2017C -+ Patch 27015468: PROACTIVE DSTV31 UPDATE \- TZDATA2017C \- NEED OJVM FIX -+ Patch 27216420: Oracle GoldenGate \- Oracle RDBMS Server Recommended Patches -+ Patch 27244661: MES 405 BUNDLE ON TOP OF RDBMS 11\.2\.0\.4\.180116 PSU -+ Patch 19692824: DBCONTROL is not coming up on OEL 7 -+ Support for `DBA_LOCKS` and associated views - -### Oracle patch 26925576, released January 2018 - -Bugs fixed: - -``` -17288409, 21051852, 24316947, 17811429, 17205719, 18607546, 25654936 -17816865, 20506699, 24835538, 25957038, 23330119, 17922254, 17754782 -13364795, 16934803, 17311728, 20387265, 17284817, 17441661, 20671094 -24560906, 16992075, 17446237, 14015842, 19972569, 21756677, 17375354 -21538558, 20925795, 17449815, 26575788, 19463897, 13866822, 17235750 -17982555, 17478514, 18317531, 14338435, 18235390, 20803583, 19461270 -19475971, 13944971, 20142975, 17811789, 16929165, 18704244, 24662775 -20506706, 21422580, 17546973, 20334344, 14054676, 25489607, 17088068 -17346091, 18264060, 17343514, 21538567, 19680952, 18471685, 19211724 -21132297, 13951456, 16315398, 21847223, 18744139, 16850630, 23177648 -19049453, 18090142, 18673304, 17883081, 19915271, 18641419, 18262334 -25600421, 17006183, 16065166, 18277454, 16833527, 10136473, 18051556 -17865671, 18554871, 17852463, 17853498, 18334586, 20879889, 17551709 -17588480, 19827973, 17344412, 17842825, 18828868, 20509482, 17025461 -13609098, 11883252, 17239687, 23007241, 17602269, 19197175, 18316692 -22195457, 17313525, 12611721, 21174504, 19544839, 18964939, 17600719 -26667015, 18191164, 17571306, 19393542, 20777150, 18482502, 19466309 -22243719, 17165204, 17040527, 18098207, 16785708, 17465741, 16180763 -17174582, 12982566, 16777840, 19463893, 22195465, 16875449, 22148226 -12816846, 17237521, 6599380, 19358317, 17811438, 25505394, 17811447 -21983325, 17945983, 18762750, 16912439, 17184721, 20598042, 18061914 -21380789, 17282229, 18948177, 18331850, 21142837, 18202441, 17082359 -18723434, 21972320, 21532755, 19554106, 25505371, 14034426, 18339044 -19458377, 17752995, 20448824, 17891943, 17767676, 17258090, 16668584 -18384391, 17040764, 17381384, 15913355, 18356166, 14084247, 20596234 -21641760, 20506715, 13853126, 21756661, 18203837, 14245531, 16043574 -21756699, 22195441, 17848897, 17877323, 21453153, 19272701, 20569094 -17468141, 17786518, 20861693, 17912217, 17037130, 16956380, 18155762 -17478145, 17394950, 18641461, 18189036, 18619917, 17027426, 21352646 -16268425, 24476274, 22195492, 19584068, 26544823, 18436307, 22507210 -17265217, 13498382, 17634921, 19469538, 21526048, 19258504, 23003979 -19174430, 18043064, 20004087, 17443671, 22195485, 18000422, 20004021 -22321756, 17571039, 25897615, 27053456, 21067387, 16832076, 22905130 -16344544, 21429602, 18009564, 14354737, 21286665, 18135678, 14521849 -18614015, 20441797, 18362222, 25655390, 16472716, 17835048, 17050888 -17936109, 14010183, 17325413, 18747196, 17761775, 16721594, 17082983 -20067212, 21179898, 17302277, 18084625, 20717359, 24624166, 15990359 -26746894, 24842886, 18203835, 23026585, 17297939, 17811456, 16731148 -22380919, 21168487, 14133975, 13829543, 17215560, 17694209, 17385178 -18091059, 8322815, 18259031, 25165496, 19689979, 17586955, 17201159 -17655634, 18331812, 19730508, 18868646, 17648596, 16220077, 16069901 -17393915, 17348614, 17957017, 17274537, 18096714, 17308789, 18436647 -14285317, 19289642, 14764829, 17622427, 18328509, 16943711, 22195477 -22502493, 14368995, 17346671, 18996843, 17783588, 21343838, 16618694 -17672719, 18856999, 18783224, 17851160, 17546761, 22168163, 17798953 -18273830, 22092979, 16596890, 19972566, 20828947, 13871092, 26667023 -17726838, 16384983, 22296366, 17360606, 13645875, 22321741, 16542886 -25879656, 18199537, 21787056, 17889549, 21172913, 14565184, 20475845 -17071721, 21281607, 17610798, 20299015, 21343897, 22893153, 20657441 -17397545, 18230522, 16360112, 19769489, 12905058, 18641451, 12747740 -18430495, 25423453, 17016369, 17042658, 14602788, 17551063, 19972568 -21517440, 19788842, 18508861, 14657740, 17332800, 13837378, 17186905 -19972564, 19699191, 18315328, 17437634, 24570598, 22353199, 18093615 -19006849, 19013183, 17296856, 18674024, 26569225, 17232014, 16855292 -21051840, 14692762, 17762296, 17705023, 23294548, 22507234, 19121551 -20324049, 21330264, 26198926, 19854503, 23315889, 26910644, 26030218 -21868720, 19309466, 25764020, 18681862, 17365043, 20031873, 20558005 -18554763, 17390160, 24717859, 21795111, 18456514, 16306373, 13955826 -18139690, 17501491, 17752121, 21668627, 17299889, 23713236, 24652769 -17889583, 18673325, 22551446, 19721304, 18293054, 17242746, 19211433 -19888853, 17951233, 18094246, 17649265, 19615136, 17011832, 17477958 -16870214, 18522509, 20631274, 16091637, 17323222, 16595641, 16524926 -18228645, 18282562, 17596908, 18031668, 17156148, 16494615, 22683225 -20869721, 17545847, 25093656, 17655240, 24528741, 17614134, 25427662 -13558557, 22465352, 17341326, 17891946, 17716305, 22657942, 16392068 -18440095, 19271443, 21351877, 20513399, 18092127, 17614227, 18440047 -18849970, 16903536, 14106803, 18973907, 18673342, 22809871, 17389192 -19032867, 25505382, 17612828, 17006570, 16194160, 25369547, 16685417 -25505407, 17721717, 21354456, 17390431, 17570240, 16863422, 18325460 -17008068, 19727057, 16422541, 19972570, 17267114, 18244962, 21538485 -18203838, 18765602, 16198143, 17246576, 14829250, 17835627, 20860659 -21629064, 18247991, 14458214, 21051862, 17786278, 16692232, 17227277 -24476265, 16042673, 16314254, 19285025, 16228604, 16756406, 16837842 -20144308, 17393683, 23536835, 25823754, 18899974, 17787259, 24719736 -20331945, 19490948, 20074391, 15861775, 16399083, 25947799, 18018515 -22683212, 21051858, 18260550, 17080436, 16613964, 17036973, 16579084 -24433711, 18384537, 18280813, 20296213, 16901385, 15979965, 23330124 -18441944, 16450169, 9756271, 17892268, 11733603, 16285691, 17587063 -21343775, 18180390, 26474853, 16538760, 18193833, 21387964, 21051833 -17238511, 19777862, 23065323, 17824637, 16571443, 17903598, 18306996 -19578350, 14852021, 17853456, 18674047, 12364061, 19207117, 24411921, 22195448 -``` - -## Version 11\.2\.0\.4\.v14 - -Version 11\.2\.0\.4\.v14 includes the following: -+ Oracle October 2017 PSU, a combination of database PSU \(patch 26392168\) \+ OJVM component PSU \(patch 26635834\) -+ Oracle recommended RDBMS patches for Oracle GoldenGate \(patch 26950781\) -+ RSA Micro\-Edition Suite Bundle \(patch 26963526\) -+ Timezone file DSTv30 \(patch 25881255, OJVM patch 25881271\) - -### Oracle patch 26392168, released October 2017 - -Bugs fixed: - -``` - 17288409, 21051852, 24316947, 17811429, 17205719, 18607546, 25654936 - 20506699, 17816865, 25957038, 23330119, 17922254, 17754782, 13364795 - 16934803, 17311728, 20387265, 17284817, 17441661, 24560906, 16992075 - 17446237, 14015842, 19972569, 21756677, 17375354, 21538558, 20925795 - 17449815, 26575788, 19463897, 13866822, 17235750, 17982555, 17478514 - 18317531, 14338435, 18235390, 20803583, 19461270, 13944971, 20142975 - 17811789, 16929165, 18704244, 24662775, 20506706, 17546973, 20334344 - 25489607, 14054676, 17088068, 17346091, 18264060, 17343514, 21538567 - 19680952, 18471685, 19211724, 21132297, 13951456, 21847223, 16315398 - 18744139, 16850630, 23177648, 19049453, 18673304, 17883081, 19915271 - 18641419, 18262334, 25600421, 17006183, 16065166, 18277454, 16833527 - 10136473, 18051556, 17865671, 17852463, 18554871, 17853498, 18334586 - 20879889, 17551709, 17588480, 19827973, 17344412, 17842825, 18828868 - 20509482, 17025461, 11883252, 13609098, 17239687, 17602269, 19197175 - 18316692, 22195457, 17313525, 12611721, 19544839, 18964939, 26667015 - 17600719, 18191164, 19393542, 17571306, 20777150, 18482502, 19466309 - 22243719, 17040527, 17165204, 18098207, 16785708, 17465741, 16180763 - 17174582, 12982566, 16777840, 19463893, 22195465, 16875449, 22148226 - 12816846, 17237521, 6599380, 19358317, 17811438, 25505394, 17811447 - 17945983, 21983325, 18762750, 16912439, 17184721, 18061914, 17282229 - 18331850, 18202441, 17082359, 18723434, 21532755, 21972320, 19554106 - 25505371, 14034426, 18339044, 19458377, 17752995, 20448824, 17891943 - 17258090, 17767676, 16668584, 18384391, 17040764, 17381384, 15913355 - 18356166, 14084247, 20596234, 20506715, 21756661, 13853126, 18203837 - 14245531, 16043574, 21756699, 22195441, 17848897, 17877323, 19272701 - 21453153, 20569094, 17468141, 20861693, 17786518, 17912217, 17037130 - 16956380, 18155762, 17478145, 17394950, 18641461, 18189036, 18619917 - 17027426, 21352646, 16268425, 24476274, 22195492, 19584068, 26544823 - 18436307, 22507210, 17265217, 17634921, 13498382, 19469538, 21526048 - 19258504, 18043064, 20004087, 17443671, 22195485, 18000422, 20004021 - 22321756, 17571039, 21067387, 16832076, 22905130, 16344544, 21429602 - 18009564, 14354737, 21286665, 18135678, 14521849, 18614015, 20441797 - 18362222, 25655390, 16472716, 17835048, 17050888, 17936109, 14010183 - 17325413, 18747196, 17761775, 16721594, 17082983, 20067212, 21179898 - 17302277, 18084625, 24624166, 15990359, 26746894, 24842886, 23026585 - 18203835, 17297939, 17811456, 16731148, 22380919, 21168487, 14133975 - 13829543, 17215560, 17694209, 17385178, 18091059, 8322815, 18259031 - 19689979, 17586955, 17201159, 17655634, 18331812, 19730508, 18868646 - 17648596, 16220077, 16069901, 17348614, 17393915, 17957017, 17274537 - 18096714, 17308789, 18436647, 14285317, 19289642, 14764829, 17622427 - 18328509, 16943711, 22195477, 14368995, 22502493, 17346671, 18996843 - 17783588, 21343838, 16618694, 17672719, 18856999, 18783224, 17851160 - 17546761, 22168163, 17798953, 18273830, 22092979, 16596890, 19972566 - 20828947, 13871092, 26667023, 17726838, 16384983, 22296366, 17360606 - 22321741, 13645875, 25879656, 18199537, 16542886, 21787056, 17889549 - 14565184, 20475845, 21281607, 17071721, 17610798, 20299015, 21343897 - 22893153, 20657441, 17397545, 18230522, 16360112, 19769489, 12905058 - 18641451, 12747740, 18430495, 25423453, 17016369, 17042658, 14602788 - 17551063, 19972568, 21517440, 19788842, 18508861, 14657740, 17332800 - 13837378, 17186905, 19972564, 19699191, 18315328, 17437634, 22353199 - 18093615, 19006849, 19013183, 17296856, 18674024, 17232014, 16855292 - 17762296, 14692762, 21051840, 17705023, 23294548, 22507234, 19121551 - 21330264, 26198926, 19854503, 23315889, 26030218, 21868720, 19309466 - 18681862, 17365043, 20558005, 18554763, 17390160, 18456514, 16306373 - 13955826, 18139690, 17501491, 17752121, 21668627, 17299889, 23713236 - 24652769, 17889583, 18673325, 22551446, 19721304, 18293054, 17242746 - 19211433, 19888853, 17951233, 18094246, 17649265, 19615136, 17011832 - 16870214, 17477958, 18522509, 20631274, 16091637, 17323222, 16595641 - 16524926, 18228645, 18282562, 17596908, 18031668, 17156148, 16494615 - 22683225, 20869721, 17545847, 25093656, 17655240, 24528741, 17614134 - 25427662, 13558557, 17341326, 17891946, 17716305, 22657942, 18440095 - 16392068, 19271443, 21351877, 18092127, 17614227, 18440047, 18849970 - 16903536, 14106803, 18973907, 18673342, 17389192, 25505382, 19032867 - 17612828, 16194160, 17006570, 25369547, 25505407, 16685417, 17721717 - 17390431, 17570240, 16863422, 18325460, 17008068, 19727057, 16422541 - 19972570, 17267114, 18244962, 21538485, 18203838, 18765602, 16198143 - 17246576, 14829250, 17835627, 18247991, 14458214, 21051862, 17786278 - 16692232, 17227277, 24476265, 16042673, 16314254, 19285025, 16228604 - 16837842, 20144308, 17393683, 23536835, 25823754, 18899974, 17787259 - 24719736, 20331945, 19490948, 20074391, 15861775, 16399083, 25947799 - 18018515, 22683212, 21051858, 18260550, 17080436, 16613964, 17036973 - 16579084, 24433711, 18384537, 18280813, 20296213, 16901385, 15979965 - 23330124, 18441944, 16450169, 9756271, 17892268, 11733603, 16285691 - 17587063, 21343775, 26474853, 18180390, 16538760, 18193833, 21387964 - 21051833, 17238511, 19777862, 23065323, 17824637, 17903598, 16571443 - 18306996, 19578350, 14852021, 17853456, 18674047, 12364061, 24411921 - 19207117, 22195448 -``` - -## Version 11\.2\.0\.4\.v13 - -Version 11\.2\.0\.4\.v13 includes the following: -+ Oracle July 2017 PSU, a combination of database PSU \(patch 26609445\) \+ OJVM component PSU \(patch 26027154\) -+ Oracle recommended RDBMS patches for Oracle GoldenGate \(patch 26554712\) -+ RSA Micro\-Edition Suite Bundle \(patch 26770426\) -+ Timezone file DSTv30 \(patch 25881255, OJVM patch 25881271\) -+ Support for [Validating DB instance files](Appendix.Oracle.CommonDBATasks.RMAN.md#Appendix.Oracle.CommonDBATasks.ValidateDBFiles) with the `RMAN` logical validation utility -+ Support for [Setting the default edition for a DB instance](Appendix.Oracle.CommonDBATasks.Database.md#Appendix.Oracle.CommonDBATasks.DefaultEdition) - -### Oracle patch 26609445, released July 2017 - -Bugs fixed: - -``` -17288409, 21051852, 24316947, 17811429, 17205719, 18607546, 20506699 -17816865, 25957038, 23330119, 17922254, 17754782, 13364795, 16934803 -17311728, 20387265, 17284817, 17441661, 24560906, 16992075, 17446237 -14015842, 19972569, 21756677, 17375354, 21538558, 20925795, 17449815 -26575788, 19463897, 13866822, 17235750, 17982555, 17478514, 18317531 -14338435, 18235390, 20803583, 19461270, 13944971, 20142975, 17811789 -16929165, 18704244, 20506706, 17546973, 20334344, 14054676, 17088068 -17346091, 18264060, 17343514, 21538567, 19680952, 18471685, 19211724 -13951456, 21847223, 16315398, 18744139, 16850630, 23177648, 19049453 -18673304, 17883081, 19915271, 18641419, 18262334, 25600421, 17006183 -16065166, 18277454, 16833527, 10136473, 18051556, 17865671, 17852463 -18554871, 17853498, 18334586, 20879889, 17551709, 17588480, 19827973 -17344412, 17842825, 18828868, 20509482, 17025461, 11883252, 13609098 -17239687, 17602269, 19197175, 18316692, 22195457, 17313525, 12611721 -19544839, 18964939, 17600719, 18191164, 19393542, 17571306, 20777150 -18482502, 19466309, 22243719, 17040527, 17165204, 18098207, 16785708 -17465741, 16180763, 17174582, 12982566, 16777840, 19463893, 22195465 -16875449, 22148226, 12816846, 17237521, 6599380, 19358317, 17811438 -25505394, 17811447, 17945983, 21983325, 18762750, 16912439, 17184721 -18061914, 17282229, 18331850, 18202441, 17082359, 18723434, 21972320 -19554106, 25505371, 14034426, 18339044, 19458377, 17752995, 20448824 -17891943, 17258090, 17767676, 16668584, 18384391, 17040764, 17381384 -15913355, 18356166, 14084247, 20596234, 20506715, 21756661, 13853126 -18203837, 14245531, 16043574, 21756699, 22195441, 17848897, 17877323 -21453153, 17468141, 20861693, 17786518, 17912217, 17037130, 16956380 -18155762, 17478145, 17394950, 18641461, 18189036, 18619917, 17027426 -21352646, 16268425, 24476274, 22195492, 19584068, 26544823, 18436307 -22507210, 17265217, 17634921, 13498382, 19469538, 21526048, 19258504 -18043064, 20004087, 17443671, 22195485, 18000422, 20004021, 22321756 -17571039, 21067387, 16832076, 22905130, 16344544, 18009564, 14354737 -21286665, 18135678, 14521849, 18614015, 20441797, 18362222, 25655390 -16472716, 17835048, 17050888, 17936109, 14010183, 17325413, 18747196 -17761775, 16721594, 17082983, 20067212, 21179898, 17302277, 18084625 -15990359, 24842886, 18203835, 17297939, 17811456, 16731148, 22380919 -21168487, 14133975, 13829543, 17215560, 17694209, 17385178, 18091059 -8322815, 18259031, 19689979, 17586955, 17201159, 17655634, 18331812 -19730508, 18868646, 17648596, 16220077, 16069901, 17348614, 17393915 -17957017, 17274537, 18096714, 17308789, 18436647, 14285317, 19289642 -14764829, 17622427, 18328509, 16943711, 22195477, 14368995, 22502493 -17346671, 18996843, 17783588, 21343838, 16618694, 17672719, 18856999 -18783224, 17851160, 17546761, 22168163, 17798953, 18273830, 22092979 -16596890, 19972566, 13871092, 17726838, 16384983, 22296366, 17360606 -22321741, 13645875, 25879656, 18199537, 16542886, 21787056, 17889549 -14565184, 17071721, 17610798, 20299015, 21343897, 22893153, 20657441 -17397545, 18230522, 16360112, 19769489, 12905058, 18641451, 12747740 -18430495, 25423453, 17016369, 17042658, 14602788, 17551063, 19972568 -21517440, 19788842, 18508861, 14657740, 17332800, 13837378, 17186905 -19972564, 19699191, 18315328, 17437634, 22353199, 18093615, 19006849 -19013183, 17296856, 18674024, 17232014, 16855292, 17762296, 14692762 -21051840, 17705023, 22507234, 19121551, 21330264, 19854503, 26030218 -21868720, 19309466, 18681862, 17365043, 20558005, 18554763, 17390160 -18456514, 16306373, 13955826, 18139690, 17501491, 17752121, 21668627 -17299889, 17889583, 18673325, 19721304, 18293054, 17242746, 19888853 -17951233, 18094246, 17649265, 19615136, 17011832, 16870214, 17477958 -18522509, 20631274, 16091637, 17323222, 16595641, 16524926, 18228645 -18282562, 17596908, 18031668, 17156148, 16494615, 22683225, 17545847 -25093656, 17655240, 24528741, 17614134, 25427662, 13558557, 17341326 -17891946, 17716305, 22657942, 18440095, 16392068, 19271443, 21351877 -18092127, 17614227, 18440047, 16903536, 14106803, 18973907, 18673342 -17389192, 25505382, 19032867, 17612828, 16194160, 17006570, 25369547 -25505407, 16685417, 17721717, 17390431, 17570240, 16863422, 18325460 -19727057, 16422541, 19972570, 17267114, 18244962, 21538485, 18203838 -18765602, 16198143, 17246576, 14829250, 17835627, 18247991, 14458214 -21051862, 16692232, 17786278, 17227277, 24476265, 16042673, 16314254 -16228604, 16837842, 17393683, 23536835, 25823754, 18899974, 17787259 -20331945, 20074391, 15861775, 16399083, 18018515, 22683212, 21051858 -18260550, 17080436, 16613964, 17036973, 16579084, 24433711, 18384537 -18280813, 20296213, 16901385, 15979965, 23330124, 18441944, 16450169 -9756271, 17892268, 11733603, 16285691, 17587063, 21343775, 18180390 -16538760, 18193833, 21387964, 21051833, 17238511, 19777862, 17824637 -16571443, 18306996, 19578350, 14852021, 17853456, 18674047, 12364061 -24411921, 19207117, 22195448 -``` - -## Version 11\.2\.0\.4\.v12 - -Version 11\.2\.0\.4\.v12 includes the following: -+ Oracle patch 25440428, a combination of database PSU \(patch 24732075\) \+ OJVM component PSU \(patch 25434033\) -+ Oracle recommended RDBMS patches for Oracle GoldenGate \(patch 25734992\) -+ MES Bundle \(patch 24975421 for 11\.2\.0\.4\) -+ Timezone file DSTv28 \(patch 24701840\) -+ Support for the `DBMS_CHANGE_NOTIFICATION` package -+ Support for `XSTREAM` packages and views \(may require additional licensing\) - -### Oracle patch 24732075, released April 2017 - -Bugs fixed: - -``` -17288409, 21051852, 24316947, 17811429, 17205719, 18607546, 20506699 -17816865, 17922254, 23330119, 17754782, 16934803, 13364795, 17311728 -17284817, 17441661, 24560906, 16992075, 17446237, 14015842, 19972569 -21756677, 17375354, 20925795, 21538558, 17449815, 19463897, 13866822 -17235750, 17982555, 17478514, 18317531, 14338435, 18235390, 20803583 -13944971, 20142975, 17811789, 16929165, 18704244, 20506706, 17546973 -20334344, 14054676, 17088068, 17346091, 18264060, 17343514, 21538567 -19680952, 18471685, 19211724, 13951456, 21847223, 16315398, 18744139 -16850630, 23177648, 19049453, 18673304, 17883081, 19915271, 18641419 -18262334, 17006183, 16065166, 18277454, 16833527, 10136473, 18051556 -17865671, 17852463, 18554871, 17853498, 18334586, 17551709, 17588480 -19827973, 17344412, 17842825, 18828868, 17025461, 11883252, 13609098 -17239687, 17602269, 19197175, 18316692, 22195457, 17313525, 12611721 -19544839, 18964939, 17600719, 18191164, 19393542, 17571306, 20777150 -18482502, 19466309, 22243719, 17040527, 17165204, 18098207, 16785708 -17465741, 17174582, 16180763, 12982566, 16777840, 19463893, 22195465 -16875449, 12816846, 22148226, 17237521, 6599380, 19358317, 25505394 -17811438, 17811447, 17945983, 21983325, 18762750, 16912439, 17184721 -18061914, 17282229, 18331850, 18202441, 17082359, 18723434, 21972320 -19554106, 25505371, 14034426, 18339044, 19458377, 17752995, 20448824 -17891943, 17258090, 17767676, 16668584, 18384391, 17040764, 17381384 -15913355, 18356166, 14084247, 20596234, 20506715, 21756661, 13853126 -18203837, 14245531, 16043574, 21756699, 22195441, 17848897, 17877323 -21453153, 17468141, 20861693, 17786518, 17912217, 17037130, 16956380 -18155762, 17478145, 17394950, 18641461, 18189036, 18619917, 17027426 -21352646, 16268425, 24476274, 22195492, 19584068, 18436307, 22507210 -17265217, 17634921, 13498382, 21526048, 19258504, 20004087, 17443671 -22195485, 18000422, 22321756, 20004021, 17571039, 21067387, 22905130 -16344544, 18009564, 14354737, 21286665, 18135678, 18614015, 20441797 -18362222, 17835048, 16472716, 17936109, 17050888, 14010183, 17325413 -18747196, 17761775, 16721594, 17082983, 20067212, 21179898, 17302277 -18084625, 15990359, 24842886, 18203835, 17297939, 17811456, 22380919 -16731148, 21168487, 14133975, 13829543, 17215560, 17694209, 17385178 -18091059, 8322815, 17586955, 17201159, 17655634, 18331812, 19730508 -18868646, 17648596, 16220077, 16069901, 17348614, 17393915, 17274537 -17957017, 18096714, 17308789, 18436647, 14285317, 19289642, 14764829 -17622427, 18328509, 16943711, 22195477, 14368995, 22502493, 17346671 -18996843, 17783588, 21343838, 16618694, 17672719, 18856999, 18783224 -17851160, 17546761, 17798953, 18273830, 22092979, 16596890, 19972566 -16384983, 17726838, 22296366, 17360606, 22321741, 13645875, 18199537 -16542886, 21787056, 17889549, 14565184, 17071721, 17610798, 20299015 -21343897, 22893153, 20657441, 17397545, 18230522, 16360112, 19769489 -12905058, 18641451, 12747740, 18430495, 17016369, 17042658, 14602788 -17551063, 19972568, 21517440, 18508861, 19788842, 14657740, 17332800 -13837378, 19972564, 17186905, 18315328, 19699191, 17437634, 22353199 -18093615, 19006849, 19013183, 17296856, 18674024, 17232014, 16855292 -17762296, 14692762, 21051840, 17705023, 22507234, 19121551, 21330264 -19854503, 21868720, 19309466, 18681862, 20558005, 18554763, 17390160 -18456514, 16306373, 13955826, 18139690, 17501491, 17752121, 21668627 -17299889, 17889583, 18673325, 19721304, 18293054, 17242746, 17951233 -18094246, 17649265, 19615136, 17011832, 16870214, 17477958, 18522509 -20631274, 16091637, 17323222, 16595641, 16524926, 18228645, 18282562 -17596908, 18031668, 17156148, 16494615, 22683225, 17545847, 25093656 -17655240, 24528741, 17614134, 13558557, 17341326, 17891946, 17716305 -22657942, 18440095, 16392068, 19271443, 21351877, 18092127, 17614227 -18440047, 16903536, 14106803, 18973907, 18673342, 25505382, 19032867 -17389192, 17612828, 16194160, 17006570, 25369547, 25505407, 17721717 -17390431, 17570240, 16863422, 18325460, 19727057, 16422541, 19972570 -17267114, 18244962, 21538485, 18765602, 18203838, 16198143, 17246576 -14829250, 17835627, 18247991, 14458214, 21051862, 16692232, 17786278 -17227277, 24476265, 16042673, 16314254, 16228604, 16837842, 17393683 -23536835, 17787259, 20331945, 20074391, 15861775, 16399083, 18018515 -22683212, 18260550, 21051858, 17080436, 16613964, 17036973, 16579084 -24433711, 18384537, 18280813, 20296213, 16901385, 15979965, 23330124 -18441944, 16450169, 9756271, 17892268, 11733603, 16285691, 17587063 -21343775, 18180390, 16538760, 18193833, 21387964, 21051833, 17238511 -17824637, 16571443, 18306996, 14852021, 17853456, 18674047, 12364061 -24411921, 22195448 -``` - -## Version 11\.2\.0\.4\.v11 - -Version 11\.2\.0\.4\.v11 includes the following: -+ Oracle patch 24918033, a combination of database PSU \(patch 24006111\) \+ OJVM component PSU \(patch 24917954\) -+ Oracle recommended RDBMS patches for Oracle GoldenGate \(patch 24491261\) -+ MES Bundle \(patch 24975421 for 11\.2\.0\.4\) - -### Oracle patch 24918033, released January 2017 - -Bugs fixed: - -``` -18933818, 19176885, 17201047, 25067795, 14774730, 19153980, 21911849 -23727132, 18166577, 24448240, 17056813, 21811517, 19909862, 22675136 -24534298, 19895326, 22253904, 17804361, 19231857, 17528315, 19058059 -19554117, 19007266, 17285560, 22670385, 18458318, 19187988, 23265914 -19006757, 19374518, 19223010, 25076732, 22118835, 19852360, 20408829 -21047766, 21566944, -17288409, 21051852, 24316947, 17811429, 18607546, 17205719, 20506699 -17816865, 17922254, 23330119, 17754782, 16934803, 13364795, 17311728 -17441661, 17284817, 16992075, 17446237, 14015842, 19972569, 21756677 -17375354, 20925795, 21538558, 17449815, 19463897, 13866822, 17235750 -17982555, 17478514, 18317531, 14338435, 18235390, 20803583, 13944971 -20142975, 17811789, 16929165, 18704244, 20506706, 17546973, 20334344 -14054676, 17088068, 17346091, 18264060, 17343514, 21538567, 19680952 -18471685, 19211724, 13951456, 21847223, 16315398, 18744139, 16850630 -23177648, 19049453, 18673304, 17883081, 19915271, 18641419, 18262334 -17006183, 16065166, 18277454, 16833527, 10136473, 18051556, 17865671 -17852463, 18554871, 17853498, 18334586, 17551709, 17588480, 19827973 -17344412, 17842825, 18828868, 17025461, 11883252, 13609098, 17239687 -17602269, 19197175, 22195457, 18316692, 17313525, 12611721, 19544839 -18964939, 17600719, 18191164, 19393542, 17571306, 20777150, 18482502 -19466309, 22243719, 17040527, 17165204, 18098207, 16785708, 17465741 -17174582, 16180763, 16777840, 12982566, 19463893, 22195465, 22148226 -16875449, 12816846, 17237521, 6599380, 19358317, 17811438, 17811447 -17945983, 21983325, 18762750, 16912439, 17184721, 18061914, 17282229 -18331850, 18202441, 17082359, 18723434, 21972320, 19554106, 14034426 -18339044, 19458377, 17752995, 20448824, 17891943, 17258090, 17767676 -16668584, 18384391, 17040764, 17381384, 15913355, 18356166, 14084247 -20596234, 20506715, 21756661, 13853126, 18203837, 14245531, 16043574 -21756699, 22195441, 17848897, 17877323, 21453153, 17468141, 20861693 -17786518, 17912217, 17037130, 16956380, 18155762, 17478145, 17394950 -18641461, 18189036, 18619917, 17027426, 21352646, 16268425, 24476274 -22195492, 19584068, 18436307, 22507210, 17265217, 17634921, 13498382 -21526048, 19258504, 20004087, 17443671, 22195485, 18000422, 22321756 -20004021, 17571039, 21067387, 16344544, 18009564, 14354737, 21286665 -18135678, 18614015, 20441797, 18362222, 17835048, 16472716, 17936109 -17050888, 17325413, 14010183, 18747196, 17761775, 16721594, 17082983 -20067212, 21179898, 17302277, 18084625, 15990359, 18203835, 17297939 -17811456, 22380919, 16731148, 21168487, 14133975, 13829543, 17215560 -17694209, 17385178, 18091059, 8322815, 17586955, 17201159, 17655634 -18331812, 19730508, 18868646, 17648596, 16220077, 16069901, 17348614 -17393915, 17274537, 17957017, 18096714, 17308789, 18436647, 14285317 -19289642, 14764829, 18328509, 17622427, 16943711, 22195477, 14368995 -22502493, 17346671, 18996843, 17783588, 21343838, 16618694, 17672719 -18856999, 18783224, 17851160, 17546761, 17798953, 18273830, 22092979 -16596890, 19972566, 16384983, 17726838, 22296366, 17360606, 22321741 -13645875, 18199537, 16542886, 21787056, 17889549, 14565184, 17071721 -17610798, 20299015, 21343897, 22893153, 20657441, 17397545, 18230522 -16360112, 19769489, 12905058, 18641451, 12747740, 18430495, 17016369 -17042658, 14602788, 17551063, 19972568, 21517440, 18508861, 19788842 -14657740, 17332800, 13837378, 19972564, 17186905, 18315328, 19699191 -17437634, 22353199, 18093615, 19006849, 19013183, 17296856, 18674024 -17232014, 16855292, 17762296, 14692762, 21051840, 17705023, 22507234 -19121551, 21330264, 19854503, 21868720, 19309466, 18681862, 20558005 -18554763, 17390160, 18456514, 16306373, 13955826, 18139690, 17501491 -17752121, 21668627, 17299889, 17889583, 18673325, 19721304, 18293054 -17242746, 17951233, 18094246, 17649265, 19615136, 17011832, 16870214 -17477958, 18522509, 20631274, 16091637, 17323222, 16595641, 16524926 -18228645, 18282562, 17596908, 18031668, 17156148, 16494615, 22683225 -17545847, 17655240, 24528741, 17614134, 13558557, 17341326, 17891946 -17716305, 22657942, 16392068, 19271443, 21351877, 18092127, 17614227 -18440047, 16903536, 14106803, 18973907, 18673342, 19032867, 17389192 -17612828, 16194160, 17006570, 17721717, 17390431, 17570240, 16863422 -18325460, 19727057, 16422541, 19972570, 17267114, 18244962, 21538485 -18765602, 18203838, 16198143, 17246576, 14829250, 17835627, 18247991 -14458214, 21051862, 16692232, 17786278, 17227277, 24476265, 16042673 -16314254, 16228604, 16837842, 17393683, 23536835, 17787259, 20331945 -20074391, 15861775, 16399083, 18018515, 22683212, 18260550, 21051858 -17080436, 16613964, 17036973, 16579084, 24433711, 18384537, 18280813 -20296213, 16901385, 15979965, 23330124, 18441944, 16450169, 9756271 -17892268, 11733603, 16285691, 17587063, 21343775, 18180390, 16538760 -18193833, 21387964, 21051833, 17238511, 17824637, 16571443, 18306996 -14852021, 17853456, 18674047, 12364061, 22195448 -``` - -## Version 11\.2\.0\.4\.v10 - -Version 11\.2\.0\.4\.v10 includes the following: -+ Oracle patch 24436313, a combination of database PSU \(patch 24006111\) \+ OJVM component PSU \(patch 24315821\) -+ Oracle recommended RDBMS patches for Oracle GoldenGate \(patch 24491261\) -+ MES Bundle \(patch 24975421 for 11\.2\.0\.4\) - -### Baseline: Oracle database patch set update 11\.2\.0\.4\.161018 \(patch 24006111, released October 2016\) - -Bugs fixed: - -``` -17288409, 21051852, 24316947, 17811429, 18607546, 17205719, 20506699 -17816865, 17922254, 23330119, 17754782, 16934803, 13364795, 17311728 -17441661, 17284817, 16992075, 17446237, 14015842, 19972569, 21756677 -17375354, 20925795, 21538558, 17449815, 19463897, 13866822, 17235750 -17982555, 17478514, 18317531, 14338435, 18235390, 20803583, 13944971 -20142975, 17811789, 16929165, 18704244, 20506706, 17546973, 20334344 -14054676, 17088068, 17346091, 18264060, 17343514, 21538567, 19680952 -18471685, 19211724, 13951456, 21847223, 16315398, 18744139, 16850630 -23177648, 19049453, 18673304, 17883081, 19915271, 18641419, 18262334 -17006183, 16065166, 18277454, 16833527, 10136473, 18051556, 17865671 -17852463, 18554871, 17853498, 18334586, 17551709, 17588480, 19827973 -17344412, 17842825, 18828868, 17025461, 11883252, 13609098, 17239687 -17602269, 19197175, 22195457, 18316692, 17313525, 12611721, 19544839 -18964939, 17600719, 18191164, 19393542, 17571306, 20777150, 18482502 -19466309, 22243719, 17040527, 17165204, 18098207, 16785708, 17465741 -17174582, 16180763, 16777840, 12982566, 19463893, 22195465, 22148226 -16875449, 12816846, 17237521, 6599380, 19358317, 17811438, 17811447 -17945983, 21983325, 18762750, 16912439, 17184721, 18061914, 17282229 -18331850, 18202441, 17082359, 18723434, 21972320, 19554106, 14034426 -18339044, 19458377, 17752995, 20448824, 17891943, 17258090, 17767676 -16668584, 18384391, 17040764, 17381384, 15913355, 18356166, 14084247 -20596234, 20506715, 21756661, 13853126, 18203837, 14245531, 16043574 -21756699, 22195441, 17848897, 17877323, 21453153, 17468141, 20861693 -17786518, 17912217, 17037130, 16956380, 18155762, 17478145, 17394950 -18641461, 18189036, 18619917, 17027426, 21352646, 16268425, 24476274 -22195492, 19584068, 18436307, 22507210, 17265217, 17634921, 13498382 -21526048, 19258504, 20004087, 17443671, 22195485, 18000422, 22321756 -20004021, 17571039, 21067387, 16344544, 18009564, 14354737, 21286665 -18135678, 18614015, 20441797, 18362222, 17835048, 16472716, 17936109 -17050888, 17325413, 14010183, 18747196, 17761775, 16721594, 17082983 -20067212, 21179898, 17302277, 18084625, 15990359, 18203835, 17297939 -17811456, 22380919, 16731148, 21168487, 14133975, 13829543, 17215560 -17694209, 17385178, 18091059, 8322815, 17586955, 17201159, 17655634 -18331812, 19730508, 18868646, 17648596, 16220077, 16069901, 17348614 -17393915, 17274537, 17957017, 18096714, 17308789, 18436647, 14285317 -19289642, 14764829, 18328509, 17622427, 16943711, 22195477, 14368995 -22502493, 17346671, 18996843, 17783588, 21343838, 16618694, 17672719 -18856999, 18783224, 17851160, 17546761, 17798953, 18273830, 22092979 -16596890, 19972566, 16384983, 17726838, 22296366, 17360606, 22321741 -13645875, 18199537, 16542886, 21787056, 17889549, 14565184, 17071721 -17610798, 20299015, 21343897, 22893153, 20657441, 17397545, 18230522 -16360112, 19769489, 12905058, 18641451, 12747740, 18430495, 17016369 -17042658, 14602788, 17551063, 19972568, 21517440, 18508861, 19788842 -14657740, 17332800, 13837378, 19972564, 17186905, 18315328, 19699191 -17437634, 22353199, 18093615, 19006849, 19013183, 17296856, 18674024 -17232014, 16855292, 17762296, 14692762, 21051840, 17705023, 22507234 -19121551, 21330264, 19854503, 21868720, 19309466, 18681862, 20558005 -18554763, 17390160, 18456514, 16306373, 13955826, 18139690, 17501491 -17752121, 21668627, 17299889, 17889583, 18673325, 19721304, 18293054 -17242746, 17951233, 18094246, 17649265, 19615136, 17011832, 16870214 -17477958, 18522509, 20631274, 16091637, 17323222, 16595641, 16524926 -18228645, 18282562, 17596908, 18031668, 17156148, 16494615, 22683225 -17545847, 17655240, 24528741, 17614134, 13558557, 17341326, 17891946 -17716305, 22657942, 16392068, 19271443, 21351877, 18092127, 17614227 -18440047, 16903536, 14106803, 18973907, 18673342, 19032867, 17389192 -17612828, 16194160, 17006570, 17721717, 17390431, 17570240, 16863422 -18325460, 19727057, 16422541, 19972570, 17267114, 18244962, 21538485 -18765602, 18203838, 16198143, 17246576, 14829250, 17835627, 18247991 -14458214, 21051862, 16692232, 17786278, 17227277, 24476265, 16042673 -16314254, 16228604, 16837842, 17393683, 23536835, 17787259, 20331945 -20074391, 15861775, 16399083, 18018515, 22683212, 18260550, 21051858 -17080436, 16613964, 17036973, 16579084, 24433711, 18384537, 18280813 -20296213, 16901385, 15979965, 23330124, 18441944, 16450169, 9756271 -17892268, 11733603, 16285691, 17587063, 21343775, 18180390, 16538760 -18193833, 21387964, 21051833, 17238511, 17824637, 16571443, 18306996 -14852021, 17853456, 18674047, 12364061, 22195448 -``` - -## Version 11\.2\.0\.4\.v9 - -Version 11\.2\.0\.4\.v9 includes the following: -+ Oracle patch 23615392, a combination of database PSU \(patch 23054359\) \+ OJVM component PSU \(patch 23177551\) -+ Timezone file DSTv26 \(patch 22873635 for 11\.2\.0\.4\) -+ Oracle recommended RDBMS patches for Oracle GoldenGate \(patch 24320398 for 11\.2\.0\.4\.160719\) -+ MES Bundle \(patch 22695784 for 11\.2\.0\.4\) -+ Added the ability to create custom password verify functions\. For more information, see [Creating custom functions to verify passwords](Appendix.Oracle.CommonDBATasks.System.md#Appendix.Oracle.CommonDBATasks.CustomPassword)\. -+ Fixed a bug that prevented implicit recompilation of views owned by SYS - -### Baseline: Oracle database patch set update 11\.2\.0\.4\.160719 \(patch 23054359, released July 2016\) - -Bugs fixed: - -``` - -17288409, 21051852, 17811429, 18607546, 17205719, 20506699, 17816865 -23330119, 17922254, 17754782, 16934803, 13364795, 17311728, 17441661 -17284817, 16992075, 17446237, 14015842, 19972569, 21756677, 17375354 -21538558, 20925795, 17449815, 19463897, 13866822, 17982555, 17235750 -17478514, 18317531, 14338435, 18235390, 20803583, 13944971, 20142975 -17811789, 16929165, 18704244, 20506706, 17546973, 20334344, 14054676 -17088068, 17346091, 18264060, 17343514, 21538567, 19680952, 18471685 -19211724, 13951456, 21847223, 16315398, 18744139, 16850630, 23177648 -19049453, 18673304, 17883081, 19915271, 18641419, 18262334, 17006183 -16065166, 18277454, 16833527, 10136473, 18051556, 17865671, 17852463 -18554871, 17853498, 18334586, 17551709, 17588480, 19827973, 17344412 -17842825, 18828868, 17025461, 11883252, 13609098, 17239687, 17602269 -19197175, 22195457, 18316692, 17313525, 12611721, 19544839, 18964939 -17600719, 18191164, 19393542, 17571306, 18482502, 20777150, 19466309 -17040527, 17165204, 18098207, 16785708, 17465741, 17174582, 16180763 -16777840, 12982566, 19463893, 22195465, 16875449, 12816846, 17237521 -19358317, 17811438, 17811447, 17945983, 21983325, 18762750, 16912439 -17184721, 18061914, 17282229, 18331850, 18202441, 17082359, 18723434 -21972320, 19554106, 14034426, 18339044, 19458377, 17752995, 20448824 -17891943, 17258090, 17767676, 16668584, 18384391, 17040764, 17381384 -15913355, 18356166, 14084247, 20596234, 20506715, 21756661, 13853126 -18203837, 14245531, 16043574, 21756699, 22195441, 17848897, 17877323 -21453153, 17468141, 20861693, 17786518, 17912217, 17037130, 16956380 -18155762, 17478145, 17394950, 18641461, 18189036, 18619917, 17027426 -21352646, 16268425, 22195492, 19584068, 18436307, 22507210, 17265217 -17634921, 13498382, 21526048, 19258504, 20004087, 17443671, 22195485 -18000422, 22321756, 20004021, 17571039, 21067387, 16344544, 18009564 -14354737, 21286665, 18135678, 18614015, 20441797, 18362222, 17835048 -16472716, 17936109, 17050888, 17325413, 14010183, 18747196, 17761775 -16721594, 17082983, 20067212, 21179898, 17302277, 18084625, 15990359 -18203835, 17297939, 22380919, 17811456, 16731148, 21168487, 13829543 -17215560, 14133975, 17694209, 17385178, 18091059, 8322815, 17586955 -17201159, 17655634, 18331812, 19730508, 18868646, 17648596, 16220077 -16069901, 17348614, 17393915, 17274537, 17957017, 18096714, 17308789 -18436647, 14285317, 19289642, 14764829, 18328509, 17622427, 16943711 -22195477, 14368995, 22502493, 17346671, 18996843, 17783588, 21343838 -16618694, 17672719, 18856999, 18783224, 17851160, 17546761, 17798953 -18273830, 22092979, 16596890, 19972566, 16384983, 17726838, 22296366 -17360606, 22321741, 13645875, 18199537, 16542886, 21787056, 17889549 -14565184, 17071721, 17610798, 20299015, 21343897, 22893153, 20657441 -17397545, 18230522, 16360112, 19769489, 12905058, 18641451, 12747740 -18430495, 17016369, 17042658, 14602788, 17551063, 19972568, 21517440 -18508861, 19788842, 14657740, 17332800, 13837378, 19972564, 17186905 -18315328, 19699191, 17437634, 22353199, 18093615, 19006849, 19013183 -17296856, 18674024, 17232014, 16855292, 17762296, 14692762, 21051840 -17705023, 22507234, 19121551, 21330264, 19854503, 21868720, 19309466 -18681862, 18554763, 20558005, 17390160, 18456514, 16306373, 13955826 -18139690, 17501491, 17752121, 21668627, 17299889, 17889583, 18673325 -19721304, 18293054, 17242746, 17951233, 18094246, 17649265, 19615136 -17011832, 16870214, 17477958, 18522509, 20631274, 16091637, 17323222 -16595641, 16524926, 18228645, 18282562, 17596908, 18031668, 17156148 -16494615, 22683225, 17545847, 17655240, 17614134, 13558557, 17341326 -17891946, 17716305, 16392068, 19271443, 21351877, 18092127, 17614227 -18440047, 16903536, 14106803, 18973907, 18673342, 19032867, 17389192 -17612828, 16194160, 17006570, 17721717, 17390431, 17570240, 16863422 -18325460, 19727057, 16422541, 19972570, 17267114, 18244962, 21538485 -18765602, 18203838, 16198143, 17246576, 14829250, 17835627, 18247991 -14458214, 21051862, 16692232, 17786278, 17227277, 16042673, 16314254 -16228604, 16837842, 17393683, 23536835, 17787259, 20331945, 20074391 -15861775, 16399083, 18018515, 22683212, 18260550, 21051858, 17080436 -16613964, 17036973, 16579084, 18384537, 18280813, 20296213, 16901385 -15979965, 23330124, 18441944, 16450169, 9756271, 17892268, 11733603 -16285691, 17587063, 21343775, 16538760, 18180390, 18193833, 21387964 -21051833, 17238511, 17824637, 16571443, 18306996, 14852021, 17853456 -18674047, 12364061, 22195448 -``` - -## Version 11\.2\.0\.4\.v8 - -Version 11\.2\.0\.4\.v8 includes the following: -+ Oracle PSU 11\.2\.0\.4\.160419 \(22502456\) -+ Timezone file DSTv25 \(patch 22037014\) -+ Oracle recommended RDBMS patches for Oracle GoldenGate \(patch 22576728\) -+ MES Bundle \(patch 22695784 for 11\.2\.0\.4\) -+ Adds the ability for the master user to grant privileges on SYS objects with the grant option using the RDSADMIN\.RDSADMIN\_UTIL\.GRANT\_SYS\_OBJECT procedure -+ Adds master user privileges to support most common schemas created by the Oracle Fusion Middleware Repository Creation Utility \(RCU\) - -### Baseline: Oracle database patch set update 11\.2\.0\.4\.160419 \(patch 22502456, released April 2016\) - -Bugs fixed: - -``` - -17288409, 21051852, 17811429, 18607546, 17205719, 20506699, 17816865 -17922254, 17754782, 16934803, 13364795, 17311728, 17441661, 17284817 -16992075, 17446237, 14015842, 19972569, 21756677, 21538558, 20925795 -17449815, 17375354, 19463897, 13866822, 17982555, 17235750, 17478514 -18317531, 14338435, 18235390, 20803583, 13944971, 20142975, 17811789 -16929165, 18704244, 20506706, 17546973, 20334344, 14054676, 17088068 -17346091, 18264060, 17343514, 21538567, 19680952, 18471685, 19211724 -13951456, 21847223, 16315398, 18744139, 16850630, 19049453, 18673304 -17883081, 19915271, 18641419, 18262334, 17006183, 16065166, 18277454 -16833527, 10136473, 18051556, 17865671, 17852463, 18554871, 17853498 -18334586, 17551709, 17588480, 19827973, 17344412, 17842825, 18828868 -17025461, 11883252, 13609098, 17239687, 17602269, 19197175, 22195457 -18316692, 17313525, 12611721, 19544839, 18964939, 17600719, 18191164 -19393542, 17571306, 18482502, 20777150, 19466309, 17040527, 17165204 -18098207, 16785708, 17465741, 17174582, 16180763, 16777840, 12982566 -19463893, 22195465, 16875449, 12816846, 17237521, 19358317, 17811438 -17811447, 21983325, 17945983, 18762750, 16912439, 17184721, 18061914 -17282229, 18331850, 18202441, 17082359, 18723434, 21972320, 19554106 -14034426, 18339044, 19458377, 17752995, 20448824, 17891943, 17258090 -17767676, 16668584, 18384391, 17040764, 17381384, 15913355, 18356166 -14084247, 20596234, 20506715, 21756661, 13853126, 18203837, 14245531 -21756699, 16043574, 22195441, 17848897, 17877323, 21453153, 17468141 -20861693, 17786518, 17912217, 17037130, 18155762, 16956380, 17478145 -17394950, 18641461, 18189036, 18619917, 17027426, 21352646, 16268425 -22195492, 19584068, 18436307, 17265217, 17634921, 13498382, 21526048 -19258504, 20004087, 17443671, 22195485, 18000422, 20004021, 22321756 -17571039, 21067387, 16344544, 18009564, 14354737, 21286665, 18135678 -18614015, 20441797, 18362222, 17835048, 16472716, 17936109, 17050888 -17325413, 14010183, 18747196, 17761775, 16721594, 17082983, 20067212 -21179898, 17302277, 18084625, 15990359, 18203835, 17297939, 17811456 -16731148, 21168487, 13829543, 17215560, 14133975, 17694209, 17385178 -18091059, 8322815, 17586955, 17201159, 17655634, 18331812, 19730508 -18868646, 17648596, 16220077, 16069901, 17348614, 17393915, 17274537 -17957017, 18096714, 17308789, 18436647, 14285317, 19289642, 14764829 -18328509, 17622427, 22195477, 16943711, 22502493, 14368995, 17346671 -18996843, 17783588, 21343838, 16618694, 17672719, 18856999, 18783224 -17851160, 17546761, 17798953, 18273830, 22092979, 16596890, 19972566 -16384983, 17726838, 17360606, 22321741, 13645875, 18199537, 16542886 -21787056, 17889549, 14565184, 17071721, 17610798, 20299015, 21343897 -22893153, 20657441, 17397545, 18230522, 16360112, 19769489, 12905058 -18641451, 12747740, 18430495, 17016369, 17042658, 14602788, 17551063 -19972568, 21517440, 18508861, 19788842, 14657740, 17332800, 13837378 -19972564, 17186905, 18315328, 19699191, 17437634, 22353199, 18093615 -19006849, 19013183, 17296856, 18674024, 17232014, 16855292, 17762296 -14692762, 21051840, 17705023, 19121551, 21330264, 19854503, 21868720 -19309466, 18681862, 18554763, 20558005, 17390160, 18456514, 16306373 -13955826, 18139690, 17501491, 17752121, 21668627, 17299889, 17889583 -18673325, 19721304, 18293054, 17242746, 17951233, 17649265, 18094246 -19615136, 17011832, 16870214, 17477958, 18522509, 20631274, 16091637 -17323222, 16595641, 16524926, 18228645, 18282562, 17596908, 17156148 -18031668, 16494615, 22683225, 17545847, 17655240, 17614134, 13558557 -17341326, 17891946, 17716305, 16392068, 19271443, 21351877, 18092127 -18440047, 17614227, 14106803, 16903536, 18973907, 18673342, 19032867 -17389192, 17612828, 16194160, 17006570, 17721717, 17390431, 17570240 -16863422, 18325460, 19727057, 16422541, 19972570, 17267114, 18244962 -21538485, 18765602, 18203838, 16198143, 17246576, 14829250, 17835627 -18247991, 14458214, 21051862, 16692232, 17786278, 17227277, 16042673 -16314254, 16228604, 16837842, 17393683, 17787259, 20331945, 20074391 -15861775, 16399083, 18018515, 22683212, 18260550, 21051858, 17036973 -16613964, 17080436, 16579084, 18384537, 18280813, 20296213, 16901385 -15979965, 18441944, 16450169, 9756271, 17892268, 11733603, 16285691 -17587063, 21343775, 16538760, 18180390, 18193833, 21387964, 21051833 -17238511, 17824637, 16571443, 18306996, 14852021, 18674047, 17853456 -12364061, 22195448 -``` - -## Version 11\.2\.0\.4\.v7 - -Version 11\.2\.0\.4\.v7 includes the following: -+ Oracle PSU 11\.2\.0\.4\.160119 \(21948347\) -+ Timezone file DSTv25 \- patch 22037014 for 11\.2\.0\.4 and 12\.1\.0\.2 \(12\.1\.0\.1 includes DSTv24, patch 20875898 \(unchanged from 12\.1\.0\.1\.v3\), as a backport of DSTv25 was unavailable at build time\) -+ Fixed an issue that prevented customers from creating more than 10 Directory objects in the database -+ Fixed an issue that prevented customers from re\-granting read privileges on the ADUMP and BDUMP Directory objects - -### Baseline: Oracle database patch set update 11\.2\.0\.4\.160119 \(patch 21948347, released January 2016\) - -Bugs fixed: - -``` -17288409, 21051852, 18607546, 17205719, 17811429, 17816865, 20506699 -17922254, 17754782, 16934803, 13364795, 17311728, 17441661, 17284817 -16992075, 17446237, 14015842, 19972569, 17449815, 21538558, 20925795 -17375354, 19463897, 17982555, 17235750, 13866822, 17478514, 18317531 -18235390, 14338435, 20803583, 13944971, 20142975, 17811789, 16929165 -18704244, 20506706, 17546973, 20334344, 14054676, 17088068, 18264060 -17346091, 17343514, 21538567, 19680952, 18471685, 19211724, 13951456 -21847223, 16315398, 18744139, 16850630, 19049453, 18673304, 17883081 -19915271, 18641419, 18262334, 17006183, 16065166, 18277454, 16833527 -10136473, 18051556, 17865671, 17852463, 18554871, 17853498, 18334586 -17588480, 17551709, 19827973, 17842825, 17344412, 18828868, 17025461 -11883252, 13609098, 17239687, 17602269, 19197175, 22195457, 18316692 -17313525, 12611721, 19544839, 18964939, 17600719, 18191164, 19393542 -17571306, 18482502, 20777150, 19466309, 17040527, 17165204, 18098207 -16785708, 17174582, 16180763, 17465741, 16777840, 12982566, 19463893 -22195465, 12816846, 16875449, 17237521, 19358317, 17811438, 17811447 -17945983, 18762750, 17184721, 16912439, 18061914, 17282229, 18331850 -18202441, 17082359, 18723434, 21972320, 19554106, 14034426, 18339044 -19458377, 17752995, 20448824, 17891943, 17258090, 17767676, 16668584 -18384391, 17040764, 17381384, 15913355, 18356166, 14084247, 20506715 -13853126, 18203837, 14245531, 21756699, 16043574, 22195441, 17848897 -17877323, 21453153, 17468141, 20861693, 17786518, 17912217, 17037130 -18155762, 16956380, 17478145, 17394950, 18189036, 18641461, 18619917 -17027426, 21352646, 16268425, 22195492, 19584068, 18436307, 17265217 -17634921, 13498382, 21526048, 20004087, 22195485, 17443671, 18000422 -22321756, 20004021, 17571039, 21067387, 16344544, 18009564, 14354737 -18135678, 18614015, 20441797, 18362222, 17835048, 16472716, 17936109 -17050888, 17325413, 14010183, 18747196, 17761775, 16721594, 17082983 -20067212, 21179898, 17302277, 18084625, 15990359, 18203835, 17297939 -17811456, 16731148, 21168487, 17215560, 13829543, 14133975, 17694209 -18091059, 17385178, 8322815, 17586955, 17201159, 17655634, 18331812 -19730508, 18868646, 17648596, 16220077, 16069901, 17348614, 17393915 -17274537, 17957017, 18096714, 17308789, 18436647, 14285317, 19289642 -14764829, 18328509, 17622427, 22195477, 16943711, 14368995, 17346671 -18996843, 17783588, 21343838, 16618694, 17672719, 18856999, 18783224 -17851160, 17546761, 17798953, 18273830, 22092979, 19972566, 16384983 -17726838, 17360606, 22321741, 13645875, 18199537, 16542886, 21787056 -17889549, 14565184, 17071721, 17610798, 20299015, 21343897, 20657441 -17397545, 18230522, 16360112, 19769489, 12905058, 18641451, 12747740 -18430495, 17042658, 17016369, 14602788, 17551063, 19972568, 21517440 -18508861, 19788842, 14657740, 17332800, 13837378, 19972564, 17186905 -18315328, 19699191, 17437634, 19006849, 19013183, 17296856, 18674024 -17232014, 16855292, 21051840, 14692762, 17762296, 17705023, 19121551 -21330264, 19854503, 19309466, 18681862, 18554763, 20558005, 17390160 -18456514, 16306373, 13955826, 18139690, 17501491, 21668627, 17299889 -17752121, 17889583, 18673325, 18293054, 17242746, 17951233, 17649265 -18094246, 19615136, 17011832, 16870214, 17477958, 18522509, 20631274 -16091637, 17323222, 16595641, 16524926, 18228645, 18282562, 17596908 -17156148, 18031668, 16494615, 17545847, 17655240, 17614134, 13558557 -17341326, 17891946, 17716305, 16392068, 19271443, 21351877, 18092127 -18440047, 17614227, 14106803, 16903536, 18973907, 18673342, 19032867 -17389192, 17612828, 16194160, 17006570, 17721717, 17570240, 17390431 -16863422, 18325460, 19727057, 16422541, 19972570, 17267114, 18244962 -21538485, 18765602, 18203838, 16198143, 17246576, 14829250, 17835627 -18247991, 14458214, 21051862, 16692232, 17786278, 17227277, 16042673 -16314254, 16228604, 16837842, 17393683, 17787259, 20331945, 20074391 -15861775, 16399083, 18018515, 21051858, 18260550, 17036973, 16613964 -17080436, 16579084, 18384537, 18280813, 20296213, 16901385, 15979965 -18441944, 16450169, 9756271, 17892268, 11733603, 16285691, 17587063 -21343775, 16538760, 18180390, 18193833, 21051833, 17238511, 17824637 -16571443, 18306996, 14852021, 18674047, 17853456, 12364061, 22195448 -``` - -## Version 11\.2\.0\.4\.v6 - -Version 11\.2\.0\.4\.v6 includes the following: -+ Enable SSL encryption for Standard Edition and Standard Edition One - -## Version 11\.2\.0\.4\.v5 - -Version 11\.2\.0\.4\.v5 includes the following: -+ Oracle PSU 11\.2\.0\.4\.8 \(21352635\) -+ Includes the Daylight Saving Time Patch, patch 20875898: DST\-24, that came out after the April 2015 PSU\. - -### Baseline: Oracle database patch set update 11\.2\.0\.4\.8 \(patch 21352635, released October 2015\) - -Bugs fixed: - -``` -17288409, 21051852, 18607546, 17205719, 17811429, 17816865, 20506699 -17922254, 17754782, 16934803, 13364795, 17311728, 17441661, 17284817 -16992075, 17446237, 14015842, 19972569, 21538558, 20925795, 17449815 -17375354, 19463897, 17982555, 17235750, 13866822, 18317531, 17478514 -18235390, 14338435, 20803583, 13944971, 20142975, 17811789, 16929165 -18704244, 20506706, 17546973, 20334344, 14054676, 17088068, 18264060 -17346091, 17343514, 21538567, 19680952, 18471685, 19211724, 13951456 -16315398, 18744139, 16850630, 19049453, 18673304, 17883081, 19915271 -18641419, 18262334, 17006183, 16065166, 18277454, 16833527, 10136473 -18051556, 17865671, 17852463, 18554871, 17853498, 18334586, 17588480 -17551709, 19827973, 17842825, 17344412, 18828868, 17025461, 11883252 -13609098, 17239687, 17602269, 19197175, 18316692, 17313525, 12611721 -19544839, 18964939, 17600719, 18191164, 19393542, 17571306, 18482502 -20777150, 19466309, 17040527, 17165204, 18098207, 16785708, 17174582 -16180763, 17465741, 16777840, 12982566, 19463893, 12816846, 16875449 -17237521, 19358317, 17811438, 17811447, 17945983, 18762750, 17184721 -16912439, 18061914, 17282229, 18331850, 18202441, 17082359, 18723434 -19554106, 14034426, 18339044, 19458377, 17752995, 20448824, 17891943 -17258090, 17767676, 16668584, 18384391, 17040764, 17381384, 15913355 -18356166, 14084247, 20506715, 13853126, 18203837, 14245531, 16043574 -17848897, 17877323, 17468141, 17786518, 17912217, 17037130, 18155762 -16956380, 17478145, 17394950, 18189036, 18641461, 18619917, 17027426 -21352646, 16268425, 19584068, 18436307, 17265217, 17634921, 13498382 -20004087, 17443671, 18000422, 20004021, 17571039, 21067387, 16344544 -18009564, 14354737, 18135678, 18614015, 20441797, 18362222, 17835048 -16472716, 17936109, 17050888, 17325413, 14010183, 18747196, 17761775 -16721594, 17082983, 20067212, 21179898, 17302277, 18084625, 15990359 -18203835, 17297939, 17811456, 16731148, 17215560, 13829543, 14133975 -17694209, 18091059, 17385178, 8322815, 17586955, 17201159, 17655634 -18331812, 19730508, 18868646, 17648596, 16220077, 16069901, 17348614 -17393915, 17274537, 17957017, 18096714, 17308789, 18436647, 14285317 -19289642, 14764829, 18328509, 17622427, 16943711, 14368995, 17346671 -18996843, 17783588, 16618694, 17672719, 18856999, 18783224, 17851160 -17546761, 17798953, 18273830, 19972566, 16384983, 17726838, 17360606 -13645875, 18199537, 16542886, 17889549, 14565184, 17071721, 20299015 -17610798, 20657441, 17397545, 18230522, 16360112, 19769489, 12905058 -18641451, 12747740, 18430495, 17042658, 17016369, 14602788, 19972568 -18508861, 19788842, 14657740, 17332800, 13837378, 19972564, 17186905 -18315328, 19699191, 17437634, 19006849, 19013183, 17296856, 18674024 -17232014, 16855292, 21051840, 14692762, 17762296, 17705023, 19121551 -19854503, 19309466, 18681862, 18554763, 20558005, 17390160, 18456514 -16306373, 13955826, 18139690, 17501491, 17299889, 17752121, 17889583 -18673325, 18293054, 17242746, 17951233, 17649265, 18094246, 19615136 -17011832, 16870214, 17477958, 18522509, 20631274, 16091637, 17323222 -16595641, 16524926, 18228645, 18282562, 17596908, 17156148, 18031668 -16494615, 17545847, 17614134, 13558557, 17341326, 17891946, 17716305 -16392068, 19271443, 18092127, 18440047, 17614227, 14106803, 16903536 -18973907, 18673342, 17389192, 16194160, 17006570, 17612828, 17721717 -17570240, 17390431, 16863422, 18325460, 19727057, 16422541, 19972570 -17267114, 18244962, 21538485, 18765602, 18203838, 16198143, 17246576 -14829250, 17835627, 18247991, 14458214, 21051862, 16692232, 17786278 -17227277, 16042673, 16314254, 16228604, 16837842, 17393683, 17787259 -20331945, 20074391, 15861775, 16399083, 18018515, 18260550, 21051858 -17036973, 16613964, 17080436, 16579084, 18384537, 18280813, 20296213 -16901385, 15979965, 18441944, 16450169, 9756271, 17892268, 11733603 -16285691, 17587063, 16538760, 18180390, 18193833, 21051833, 17238511 -17824637, 16571443, 18306996, 14852021, 18674047, 17853456, 12364061 -``` - -## Version 11\.2\.0\.4\.v4 - -Version 11\.2\.0\.4\.v4 includes the following: -+ Oracle PSU 11\.2\.0\.4\.6 \(20299013\) -+ Installs additional Oracle Text knowledge bases from Oracle Database\. Examples media \(English and French\) -+ Provides access to DBMS\_REPAIR through RDSADMIN\.RDSADMIN\_DBMS\_REPAIR -+ Grants ALTER DATABASE LINK, ALTER PUBLIC DATABASE LINK, EXEMPT ACCESS POLICY, EXEMPT IDENTITY POLICY, and EXEMPT REDACTION POLICY to master user - -### Baseline: Oracle database patch set update 11\.2\.0\.4\.6 \(patch 20299013, released April 2015\) - -Bugs fixed: - -``` -17288409, 17798953, 18273830, 18607546, 17811429, 17205719, 20506699 -17816865, 19972566, 17922254, 17754782, 16384983, 17726838, 13364795 -16934803, 17311728, 17284817, 17441661, 17360606, 13645875, 18199537 -16992075, 16542886, 17446237, 14015842, 17889549, 14565184, 19972569 -17071721, 20299015, 17610798, 17375354, 17449815, 17397545, 19463897 -18230522, 13866822, 17235750, 17982555, 16360112, 18317531, 17478514 -19769489, 12905058, 14338435, 18235390, 13944971, 18641451, 20142975 -17811789, 16929165, 18704244, 12747740, 18430495, 20506706, 17546973 -14054676, 17088068, 17346091, 18264060, 17016369, 17042658, 17343514 -14602788, 19972568, 19680952, 18471685, 19788842, 18508861, 14657740 -17332800, 19211724, 13837378, 13951456, 16315398, 17186905, 18744139 -19972564, 16850630, 18315328, 17437634, 19049453, 18673304, 17883081 -19006849, 19915271, 19013183, 18641419, 17296856, 18674024, 18262334 -17006183, 18277454, 16833527, 17232014, 16855292, 10136473, 17762296 -14692762, 17705023, 18051556, 17865671, 17852463, 18554871, 17853498 -19121551, 18334586, 19854503, 17551709, 19309466, 17588480, 19827973 -17344412, 17842825, 18828868, 18681862, 18554763, 17390160, 18456514 -16306373, 17025461, 13955826, 18139690, 11883252, 13609098, 17501491 -17239687, 17752121, 17299889, 17602269, 19197175, 17889583, 18316692 -17313525, 18673325, 12611721, 19544839, 18293054, 17242746, 18964939 -17600719, 18191164, 19393542, 17571306, 18482502, 19466309, 17951233 -17649265, 18094246, 19615136, 17040527, 17011832, 17165204, 18098207 -16785708, 16870214, 17465741, 16180763, 17174582, 17477958, 12982566 -16777840, 18522509, 20631274, 16091637, 17323222, 19463893, 16595641 -16875449, 12816846, 16524926, 17237521, 18228645, 18282562, 17596908 -19358317, 17811438, 17811447, 17945983, 18762750, 17156148, 18031668 -16912439, 17184721, 16494615, 18061914, 17282229, 17545847, 18331850 -18202441, 17082359, 18723434, 19554106, 17614134, 13558557, 17341326 -14034426, 17891946, 18339044, 17716305, 19458377, 17752995, 16392068 -19271443, 17891943, 18092127, 17258090, 17767676, 16668584, 18384391 -17614227, 17040764, 16903536, 17381384, 14106803, 15913355, 18973907 -18356166, 18673342, 17389192, 14084247, 16194160, 17612828, 17006570 -20506715, 17721717, 13853126, 17390431, 18203837, 17570240, 14245531 -16043574, 16863422, 17848897, 17877323, 18325460, 19727057, 17468141 -17786518, 17912217, 16422541, 19972570, 17267114, 17037130, 18244962 -18765602, 18203838, 18155762, 16956380, 16198143, 17246576, 17478145 -17394950, 14829250, 18189036, 18641461, 18619917, 17835627, 17027426 -16268425, 18247991, 19584068, 14458214, 18436307, 17265217, 17634921 -13498382, 16692232, 17786278, 17227277, 16042673, 16314254, 17443671 -18000422, 16228604, 16837842, 17571039, 17393683, 16344544, 17787259 -18009564, 20074391, 14354737, 15861775, 18135678, 18614015, 16399083 -18362222, 18018515, 16472716, 17835048, 17050888, 17936109, 14010183 -17325413, 18747196, 17080436, 16613964, 17036973, 17761775, 16579084 -16721594, 17082983, 18384537, 18280813, 20296213, 17302277, 16901385 -18084625, 15979965, 15990359, 18203835, 17297939, 17811456, 16731148 -13829543, 14133975, 17215560, 17694209, 18091059, 17385178, 8322815 -17586955, 18441944, 17201159, 16450169, 9756271, 17655634, 19730508 -17892268, 18868646, 17648596, 16220077, 16069901, 11733603, 16285691 -17587063, 18180390, 16538760, 18193833, 17348614, 17393915, 17957017 -17274537, 18096714, 17308789, 17238511, 18436647, 17824637, 14285317 -19289642, 14764829, 17622427, 18328509, 16571443, 16943711, 14368995 -18306996, 17346671, 14852021, 18996843, 17783588, 16618694, 17853456 -18674047, 17672719, 18856999, 12364061, 18783224, 17851160, 17546761 -``` - -## Version 11\.2\.0\.4\.v3 - -Version 11\.2\.0\.4\.v3 includes the following: -+ Oracle PSU 11\.2\.0\.4\.4 \(19121551\) -+ Latest DST file \(DSTv23 – patch 19396455, released Oct 2014\)\. This patch is incorporated by default in new instances only\. - -### Baseline: Oracle database patch set update 11\.2\.0\.4\.4 \(patch 19121551, released October 2014\) - -Bugs fixed: - -``` -19396455, 18759211, 17432124, 16799735, -17288409, 17205719, 17811429, 17754782, 17726838, 13364795, 17311728 -17284817, 17441661, 13645875, 18199537, 16992075, 16542886, 17446237 -14565184, 17071721, 17610798, 17375354, 17449815, 17397545, 19463897 -18230522, 17235750, 16360112, 13866822, 17982555, 17478514, 12905058 -14338435, 13944971, 16929165, 12747740, 17546973, 14054676, 17088068 -18264060, 17343514, 17016369, 17042658, 14602788, 14657740, 17332800 -19211724, 13951456, 16315398, 17186905, 18744139, 16850630, 17437634 -19049453, 18673304, 17883081, 18641419, 17296856, 18262334, 17006183 -18277454, 17232014, 16855292, 10136473, 17705023, 17865671, 18554871 -19121551, 17588480, 17551709, 17344412, 17842825, 18681862, 17390160 -13955826, 13609098, 18139690, 17501491, 17239687, 17752121, 17299889 -17602269, 18673325, 17313525, 17242746, 19544839, 17600719, 18191164 -17571306, 19466309, 17951233, 18094246, 17165204, 17011832, 17040527 -16785708, 16180763, 17477958, 17174582, 17465741, 18522509, 17323222 -19463893, 16875449, 16524926, 17237521, 17596908, 17811438, 17811447 -18031668, 16912439, 16494615, 18061914, 17545847, 17082359, 19554106 -17614134, 17341326, 17891946, 19458377, 17716305, 17752995, 16392068 -19271443, 17767676, 17614227, 17040764, 17381384, 18973907, 18673342 -14084247, 17389192, 17006570, 17612828, 17721717, 13853126, 18203837 -17390431, 17570240, 14245531, 16043574, 16863422, 19727057, 17468141 -17786518, 17037130, 17267114, 18203838, 16198143, 16956380, 17478145 -14829250, 17394950, 17027426, 16268425, 18247991, 19584068, 14458214 -18436307, 17265217, 13498382, 16692232, 17786278, 17227277, 16042673 -16314254, 17443671, 16228604, 16837842, 17393683, 17787259, 18009564 -15861775, 16399083, 18018515, 16472716, 17050888, 14010183, 17325413 -16613964, 17080436, 17036973, 17761775, 16721594, 18280813, 15979965 -18203835, 17297939, 16731148, 17811456, 14133975, 17385178, 17586955 -16450169, 17655634, 9756271, 17892268, 17648596, 16220077, 16069901 -11733603, 16285691, 17587063, 18180390, 17393915, 18096714, 17238511 -17824637, 14285317, 19289642, 14764829, 18328509, 17622427, 16943711 -17346671, 18996843, 14852021, 17783588, 16618694, 17672719, 17546761 -``` - -## Version 11\.2\.0\.4\.v2 \(deprecated\) - -Version 11\.2\.0\.4\.v2 includes the following: -+ Oracle PSU 11\.2\.0\.4\.3 \(18522509\) -+ User access to DBMS\_TRANSACTION package to clean\-up failed distributed transactions -+ Latest DST file \(DSTv22 – patch 18759211, released June 2014\)\. This patch is incorporated by default only in new Oracle DB instances\. -+ Grants DBMS\_REPUTIL to DBA role \(upgrade to 11\.2\.0\.4 revokes it from public\) -+ Privileges granted on DBMS\_TRANSACTION, `v$pending_xatrans$`, and `v$xatrans$` -+ Resolves a problem with DDL commands when user objects have "SYSTEM" in their names -+ Installs schema objects to support XA Transactions, allowing transactions to be managed by an external transaction manager -+ Permits truncation of temporary SYS and SYSTEM objects, allowing tools like LogMiner to function correctly - -### Baseline: Oracle database patch set update 11\.2\.0\.4\.3 \(patch 18522509, released July 2014\) - -Bugs fixed: - -``` -17432124, 18759211, 18522509, 18031668, 17478514, -17752995, 17288409, 16392068, 17205719, 17811429, 17767676, 17614227 -17040764, 17381384, 17754782, 17726838, 13364795, 17311728, 17389192 -17006570, 17612828, 17284817, 17441661, 13853126, 17721717, 13645875 -18203837, 17390431, 16542886, 16992075, 16043574, 17446237, 16863422 -14565184, 17071721, 17610798, 17468141, 17786518, 17375354, 17397545 -18203838, 16956380, 17478145, 16360112, 17235750, 17394950, 13866822 -17478514, 17027426, 12905058, 14338435, 16268425, 13944971, 18247991 -14458214, 16929165, 17265217, 13498382, 17786278, 17227277, 17546973 -14054676, 17088068, 16314254, 17016369, 14602788, 17443671, 16228604 -16837842, 17332800, 17393683, 13951456, 16315398, 18744139, 17186905 -16850630, 17437634, 19049453, 17883081, 15861775, 17296856, 18277454 -16399083, 16855292, 18018515, 10136473, 16472716, 17050888, 17865671 -17325413, 14010183, 18554871, 17080436, 16613964, 17761775, 16721594 -17588480, 17551709, 17344412, 18681862, 15979965, 13609098, 18139690 -17501491, 17239687, 17752121, 17602269, 18203835, 17297939, 17313525 -16731148, 17811456, 14133975, 17600719, 17385178, 17571306, 16450169 -17655634, 18094246, 17892268, 17165204, 17011832, 17648596, 16785708 -17477958, 16180763, 16220077, 17465741, 17174582, 18522509, 16069901 -16285691, 17323222, 18180390, 17393915, 16875449, 18096714, 17238511 -``` - -## Version 11\.2\.0\.4\.v1 - -Version 11\.2\.0\.4\.v1 includes the following: -+ Oracle PSU 11\.2\.0\.4\.1 -+ [Creating and dropping directories in the main data storage space](Appendix.Oracle.CommonDBATasks.Misc.md#Appendix.Oracle.CommonDBATasks.NewDirectories) - -### Baseline: Oracle database patch set update 11\.2\.0\.4\.1 \(released January 2014\) - -Bugs fixed: - -``` -17432124, 16850630, 17551709, 13944971, 17811447, -13866822, 17811429, 16069901, 16721594, 17443671, -17478514, 17612828, 17610798, 17239687, 17501491 -17446237, 16450169, 17811438, 17288409, 17811456, -12905058, 17088068, 16285691, 17332800 -``` \ No newline at end of file diff --git a/doc_source/Appendix.Oracle.PatchComposition.12.1.0.2.md b/doc_source/Appendix.Oracle.PatchComposition.12.1.0.2.md deleted file mode 100644 index 8d938f7..0000000 --- a/doc_source/Appendix.Oracle.PatchComposition.12.1.0.2.md +++ /dev/null @@ -1,3924 +0,0 @@ -# Database engine: 12\.1\.0\.2 - -The following versions are available for database engine 12\.1\.0\.2: -+ [Version 12\.1\.0\.2\.v26](#Appendix.Oracle.PatchComposition.12.1.0.2.v26) -+ [Version 12\.1\.0\.2\.v25](#Appendix.Oracle.PatchComposition.12.1.0.2.v25) -+ [Version 12\.1\.0\.2\.v24](#Appendix.Oracle.PatchComposition.12.1.0.2.v24) -+ [Version 12\.1\.0\.2\.v23](#Appendix.Oracle.PatchComposition.12.1.0.2.v23) -+ [Version 12\.1\.0\.2\.v22](#Appendix.Oracle.PatchComposition.12.1.0.2.v22) -+ [Version 12\.1\.0\.2\.v21](#Appendix.Oracle.PatchComposition.12.1.0.2.v21) -+ [Version 12\.1\.0\.2\.v20](#Appendix.Oracle.PatchComposition.12.1.0.2.v20) -+ [Version 12\.1\.0\.2\.v19](#Appendix.Oracle.PatchComposition.12.1.0.2.v19) -+ [Version 12\.1\.0\.2\.v18](#Appendix.Oracle.PatchComposition.12.1.0.2.v18) -+ [Version 12\.1\.0\.2\.v17](#Appendix.Oracle.PatchComposition.12.1.0.2.v17) -+ [Version 12\.1\.0\.2\.v16](#Appendix.Oracle.PatchComposition.12.1.0.2.v16) -+ [Version 12\.1\.0\.2\.v15](#Appendix.Oracle.PatchComposition.12.1.0.2.v15) -+ [Version 12\.1\.0\.2\.v14](#Appendix.Oracle.PatchComposition.12.1.0.2.v14) -+ [Version 12\.1\.0\.2\.v13](#Appendix.Oracle.PatchComposition.12.1.0.2.v13) -+ [Version 12\.1\.0\.2\.v12](#Appendix.Oracle.PatchComposition.12.1.0.2.v12) -+ [Version 12\.1\.0\.2\.v11](#Appendix.Oracle.PatchComposition.12.1.0.2.v11) -+ [Version 12\.1\.0\.2\.v10](#Appendix.Oracle.PatchComposition.12.1.0.2.v10) -+ [Version 12\.1\.0\.2\.v9](#Appendix.Oracle.PatchComposition.12.1.0.2.v9) -+ [Version 12\.1\.0\.2\.v8](#Appendix.Oracle.PatchComposition.12.1.0.2.v8) -+ [Version 12\.1\.0\.2\.v7](#Appendix.Oracle.PatchComposition.12.1.0.2.v7) -+ [Version 12\.1\.0\.2\.v6](#Appendix.Oracle.PatchComposition.12.1.0.2.v6) -+ [Version 12\.1\.0\.2\.v5](#Appendix.Oracle.PatchComposition.12.1.0.2.v5) -+ [Version 12\.1\.0\.2\.v4](#Appendix.Oracle.PatchComposition.12.1.0.2.v4) -+ [Version 12\.1\.0\.2\.v3](#Appendix.Oracle.PatchComposition.12.1.0.2.v3) -+ [Version 12\.1\.0\.2\.v2](#Appendix.Oracle.PatchComposition.12.1.0.2.v2) -+ [Version 12\.1\.0\.2\.v1](#Appendix.Oracle.PatchComposition.12.1.0.2.v1) - -## - -### Version 12\.1\.0\.2\.v26 - -Version 12\.1\.0\.2\.v26 includes the following: -+ Patch 33128590 : DATABASE OCT 2021 RELEASE UPDATE 12\.1\.0\.2\.211019 -+ Patch 33192628 : OJVM RELEASE UPDATE 12\.1\.0\.2\.211019 -+ Patch 32327201: RDBMS \- DSTV36 UPDATE \- TZDATA2020E -+ Patch 17969866: Oracle GoldenGate – 46719 ENH REPLICATION SUPPORT FOR INSERTS / FULL UPDATES WITH LARGE VALUE -+ Patch 20394750: Oracle GoldenGate – APPLY CDR RESOLUTION FAILING FOR LOBS, XML, LONG, AND OBJECTS -+ Patch 24835919: Oracle GoldenGate – IR EXECUTING DEPENDENT TRANSACTIONS OUT OF ORDER WITH PARALLELISM GREATER THAN -+ Patch 23262847: Oracle GoldenGate \- MALFORMED REDO CAUSED OGG REPLICATION ABEND -+ Patch 21171382: ADD CONTROL FOR AUTOMATIC CREATION OF STATS EXTENSIONS -+ Patch 21091901: ONLINE MOVE OF HASH OR REF PARTITION CAN LEAVE LOCAL INDEXES INCONSISTENT -+ Patch 25031502: MV QUERY REWRITE WORKLOAD HIT ORA 600 \[KGL\-HEAP\-SIZE\-EXCEEDED\] -+ Patch 23711335: CDB\_UPG PDCDB CDB UPGRADE AS WHOLE TAKES 1 MORE HOUR THAN PREVIOUS LABELS IN MAY -+ Patch 33510113: JSON Bundle Patch -+ PreUpgrade Jar: preupgrade\_12\.1\.0\.2\.0\_18\_crlf\.zip - -#### Combined Patches for Version 12\.1\.0\.2\.v26, Released October 2021 - -Bugs fixed: - -``` -6194865, 6418158, 6599380, 13542050, 13787015, 13854364, 14283239 -14643995, 14705949, 15996848, 16090440, 16354467, 16359751, 16439813 -16619249, 16756406, 16777441, 16799735, 16863642, 16870214, 16875041 -16887946, 16923858, 16938780, 16941434, 17008068, 17210525, 17258582 -17274537, 17319928, 17365043, 17409174, 17414008, 17428816, 17432124 -17495022, 17532729, 17532734, 17533661, 17551063, 17655240, 17722075 -17760068, 17777718, 17835294, 17867700, 17890099, 17969866, 18007682 -18043064, 18051556, 18090142, 18110491, 18122373, 18191823, 18197127 -18202441, 18250893, 18254023, 18272672, 18288842, 18306996, 18307021 -18308268, 18324100, 18354830, 18371441, 18373438, 18382302, 18411216 -18417036, 18419520, 18427406, 18436647, 18440095, 18456643, 18475439 -18492302, 18499088, 18510194, 18542562, 18548246, 18548433, 18549238 -18604493, 18604692, 18607546, 18610915, 18618122, 18628388, 18648816 -18662619, 18673090, 18674024, 18674047, 18681056, 18693124, 18700762 -18705806, 18727933, 18733351, 18740837, 18742258, 18743542, 18758877 -18759211, 18774543, 18775971, 18778801, 18791688, 18797519, 18798250 -18799063, 18799993, 18801391, 18803726, 18810904, 18818069, 18819908 -18840932, 18841764, 18845653, 18849537, 18849970, 18851894, 18856106 -18856999, 18866977, 18868646, 18885870, 18886413, 18893947, 18895170 -18899974, 18900107, 18904062, 18909599, 18913440, 18914624, 18921743 -18940497, 18948177, 18952766, 18952989, 18964939, 18964978, 18966843 -18967382, 18973548, 18974476, 18988834, 18990023, 18990693, 18999568 -19001359, 19001390, 19012119, 19013183, 19016730, 19017309, 19018206 -19018447, 19022470, 19023822, 19024808, 19028800, 19032777, 19035573 -19044962, 19048007, 19050649, 19051460, 19052488, 19054077, 19058490 -19060015, 19065556, 19065677, 19067244, 19068380, 19068610, 19068970 -19074147, 19075256, 19076343, 19077215, 19079752, 19081128, 19124336 -19124589, 19130152, 19130616, 19131386, 19131607, 19134173, 19141838 -19143550, 19146474, 19149990, 19153980, 19154375, 19155797, 19157754 -19165673, 19168167, 19171086, 19174430, 19174521, 19174942, 19176223 -19176326, 19176885, 19178851, 19180394, 19180770, 19183343, 19185876 -19188385, 19188927, 19189317, 19189525, 19195895, 19197175, 19201867 -19207117, 19211433, 19213447, 19223010, 19231857, 19238590, 19243521 -19245191, 19248279, 19248799, 19258504, 19272708, 19279273, 19280225 -19284031, 19285025, 19289642, 19291380, 19297917, 19303936, 19304354 -19306797, 19307662, 19308965, 19309466, 19313563, 19315668, 19315691 -19317646, 19326908, 19327391, 19329654, 19330795, 19332396, 19333670 -19335438, 19339555, 19347458, 19354335, 19354794, 19358317, 19363645 -19364502, 19366375, 19370504, 19371175, 19373893, 19375649, 19382851 -19383839, 19385656, 19390567, 19390620, 19393542, 19396455, 19399918 -19402853, 19404068, 19409212, 19430401, 19433930, 19434529, 19439759 -19440520, 19440586, 19445860, 19448499, 19450116, 19450314, 19452434 -19461270, 19461428, 19468347, 19468612, 19468991, 19469538, 19475971 -19487147, 19490948, 19501299, 19503821, 19504946, 19512341, 19516448 -19518079, 19520602, 19523462, 19524158, 19524384, 19529868, 19532017 -19534363, 19536415, 19543384, 19547370, 19547774, 19548064, 19550902 -19561643, 19562381, 19566592, 19571055, 19571082, 19571367, 19577410 -19578247, 19578350, 19583624, 19587324, 19590877, 19591608, 19593445 -19597439, 19597583, 19601762, 19604659, 19606174, 19617921, 19619732 -19621704, 19623450, 19627012, 19632912, 19637186, 19639483, 19644859 -19647503, 19649152, 19658708, 19662635, 19663176, 19670108, 19676012 -19676905, 19680796, 19684504, 19687159, 19689979, 19693090, 19699191 -19699946, 19701015, 19703301, 19705781, 19706965, 19708342, 19708632 -19718981, 19721304, 19723336, 19730508, 19769480, 19769625, 19777862 -19781326, 19784751, 19790243, 19791273, 19791377, 19799847, 19805359 -19809171, 19811709, 19817386, 19818513, 19824871, 19831647, 19835133 -19841800, 19855285, 19859472, 19865345, 19869255, 19871910, 19873610 -19877336, 19879746, 19880190, 19883092, 19886165, 19888853, 19889230 -19891090, 19895326, 19895362, 19896336, 19902195, 19908836, 19909862 -19915271, 19928926, 19930276, 19931367, 19931709, 19932634, 19933147 -19941352, 19943771, 19945814, 19952975, 19957298, 19978542, 19982584 -19988852, 19989009, 19990037, 19995869, 20001168, 20001466, 20009569 -20009833, 20011515, 20011646, 20011897, 20017509, 20023340, 20031873 -20043616, 20048359, 20052269, 20061399, 20074391, 20076781, 20078186 -20087383, 20093776, 20101006, 20117253, 20118035, 20122715, 20124446 -20134113, 20134339, 20139391, 20144019, 20144308, 20165574, 20169408 -20171986, 20172151, 20173897, 20175161, 20181030, 20212067, 20217801 -20228093, 20229001, 20233181, 20235511, 20245930, 20250147, 20267166 -20273319, 20281121, 20284155, 20294666, 20296619, 20298413, 20302006 -20308238, 20308798, 20315311, 20318889, 20322560, 20324049, 20328248 -20331945, 20347562, 20348653, 20354900, 20356733, 20361671, 20368850 -20373598, 20374572, 20378086, 20382309, 20387265, 20394750, 20397490 -20401975, 20402832, 20408829, 20408866, 20413820, 20415564, 20424183 -20424899, 20425790, 20428621, 20432873, 20437153, 20440930, 20441797 -20446883, 20447445, 20459944, 20464614, 20466322, 20466628, 20468401 -20468490, 20470877, 20471920, 20474192, 20475845, 20476175, 20480209 -20493163, 20505778, 20509482, 20513399, 20524085, 20528052, 20539050 -20543011, 20544065, 20554364, 20557786, 20558005, 20560611, 20562898 -20564072, 20565112, 20565133, 20569094, 20577490, 20581111, 20582405 -20588486, 20588502, 20591183, 20596234, 20598042, 20603378, 20603431 -20613079, 20618595, 20627866, 20635353, 20641666, 20657411, 20657441 -20669434, 20671094, 20673810, 20677396, 20677974, 20684983, 20686773 -20688221, 20703000, 20703629, 20704450, 20705577, 20707932, 20708701 -20711718, 20717081, 20717091, 20717359, 20725343, 20734332, 20736227 -20746251, 20757079, 20764012, 20766180, 20768076, 20778986, 20794034 -20798891, 20800890, 20801783, 20803014, 20825533, 20828947, 20830459 -20831538, 20832516, 20835241, 20838453, 20839705, 20842388, 20844426 -20848335, 20856766, 20859910, 20860659, 20862087, 20868862, 20869721 -20875898, 20877664, 20878790, 20879709, 20879889, 20880215, 20882568 -20890311, 20897759, 20898391, 20898997, 20899461, 20904530, 20907061 -20914870, 20919320, 20920911, 20922010, 20925795, 20926021, 20929771 -20936731, 20936905, 20938170, 20951038, 20952966, 20958816, 20977794 -20978259, 21037905, 21037923, 21047766, 21047803, 21052842, 21059919 -21060755, 21061354, 21063322, 21068507, 21072646, 21080143, 21091431 -21091901, 21095391, 21097043, 21099555, 21101873, 21106027, 21132297 -21133343, 21142837, 21147908, 21153266, 21157728, 21159665, 21164318 -21171382, 21172913, 21174504, 21184223, 21186167, 21188532, 21188537 -21188584, 21196809, 21197626, 21220620, 21225209, 21239530, 21241052 -21241829, 21246723, 21260397, 21260431, 21263635, 21266085, 21270823 -21273804, 21275255, 21281532, 21281607, 21285458, 21291274, 21293600 -21294938, 21296029, 21297872, 21299490, 21300341, 21308727, 21315084 -21322887, 21329301, 21354456, 21373076, 21373473, 21380789, 21383171 -21385422, 21387128, 21387964, 21419850, 21421886, 21422580, 21424824 -21425496, 21429602, 21442094, 21450666, 21475738, 21476308, 21479753 -21492036, 21502702, 21514877, 21516611, 21517440, 21522582, 21526048 -21532755, 21534893, 21542577, 21555660, 21560152, 21566639, 21566944 -21566993, 21575362, 21612959, 21620471, 21623164, 21625179, 21626377 -21629064, 21632821, 21641414, 21641760, 21644640, 21649497, 21656630 -21659726, 21665897, 21668627, 21675340, 21695575, 21698350, 21744290 -21756661, 21756677, 21756699, 21764119, 21773465, 21779541, 21780146 -21785691, 21787056, 21794615, 21795111, 21797203, 21811517, 21820934 -21821302, 21828126, 21834568, 21837606, 21842017, 21842740, 21847223 -21856522, 21863727, 21868720, 21875360, 21889720, 21893235, 21896069 -21899588, 21911701, 21913183, 21915719, 21917884, 21924131, 21960504 -21967197, 21969671, 21977186, 21977392, 22007324, 22018363, 22022760 -22024071, 22037014, 22046677, 22062026, 22062517, 22068305, 22070866 -22072818, 22075064, 22077517, 22083366, 22087683, 22092979, 22118835 -22118851, 22139226, 22146062, 22148226, 22157363, 22160989, 22165897 -22168163, 22173980, 22175564, 22176950, 22178855, 22179537, 22185234 -22205263, 22214989, 22223463, 22228324, 22232606, 22233505, 22238921 -22243719, 22243983, 22250006, 22256431, 22256560, 22258530, 22261050 -22264489, 22268833, 22282748, 22294260, 22296366, 22301880, 22305887 -22346829, 22347493, 22351572, 22353199, 22353346, 22359063, 22364044 -22365117, 22366322, 22366558, 22374754, 22380919, 22454326, 22454940 -22458049, 22465352, 22468255, 22468781, 22470443, 22475617, 22492533 -22495062, 22495673, 22496904, 22499356, 22501616, 22503297, 22507210 -22507234, 22515353, 22517782, 22518784, 22519146, 22520320, 22528741 -22529728, 22533631, 22536802, 22551446, 22568016, 22568177, 22568797 -22606521, 22624709, 22645009, 22654475, 22657942, 22662332, 22670385 -22670413, 22674709, 22675136, 22686674, 22690648, 22695831, 22707244 -22707866, 22721409, 22729345, 22730454, 22733141, 22734547, 22750215 -22757364, 22760595, 22760679, 22762046, 22782647, 22806698, 22808310 -22809871, 22815955, 22816287, 22820579, 22820798, 22826718, 22836801 -22842151, 22855193, 22862134, 22865673, 22873635, 22894101, 22894949 -22897344, 22901797, 22905130, 22916353, 22922076, 22923409, 22950945 -22961508, 22972770, 22977256, 23002524, 23003979, 23007241, 23008056 -23019710, 23020270, 23025340, 23026585, 23028781, 23029562, 23035249 -23053606, 23061453, 23061702, 23065323, 23066146, 23068169, 23080557 -23082876, 23084507, 23088803, 23089357, 23096938, 23101501, 23104033 -23105538, 23108128, 23115139, 23124895, 23125587, 23125826, 23126410 -23140259, 23148260, 23149541, 23151677, 23168363, 23170620, 23172924 -23177536, 23177923, 23184013, 23184263, 23195445, 23197103, 23209741 -23220453, 23229229, 23230647, 23237313, 23240358, 23260854, 23262847 -23265914, 23265965, 23266217, 23272045, 23294548, 23302839, 23314180 -23315153, 23315889, 23324000, 23326313, 23328639, 23338911, 23342170 -23492665, 23501901, 23514710, 23514911, 23521523, 23528412, 23533524 -23533807, 23543183, 23548817, 23555824, 23567857, 23571055, 23572982 -23584909, 23602213, 23614158, 23627427, 23628685, 23642282, 23709062 -23711335, 23713236, 23717151, 23725036, 23727148, 23731896, 23746128 -23854396, 24285405, 24300640, 24303148, 24307571, 24308635, 24315824 -24316947, 24318855, 24321547, 24326444, 24341675, 24350620, 24350831 -24357500, 24365589, 24385625, 24385983, 24386767, 24393981, 24397438 -24401351, 24411921, 24413809, 24415926, 24416451, 24421668, 24423416 -24425998, 24437510, 24448240, 24448282, 24457597, 24461826, 24480567 -24509056, 24523374, 24530364, 24534298, 24555417, 24560906, 24563422 -24570598, 24573817, 24577566, 24589081, 24597536, 24600330, 24623975 -24624166, 24642295, 24642495, 24652769, 24662775, 24674955, 24683149 -24690216, 24693382, 24701840, 24713381, 24717859, 24718260, 24719736 -24737064, 24737403, 24737581, 24737954, 24739928, 24752618, 24766121 -24784414, 24790914, 24792678, 24796092, 24801152, 24802934, 24808595 -24812585, 24817447, 24825843, 24831514, 24835538, 24835919, 24848928 -24907917, 24908321, 24917972, 24920582, 24929210, 24966594, 25029423 -25031502, 25034396, 25042823, 25047724, 25051465, 25056052, 25058080 -25060506, 25067795, 25076732, 25076756, 25077278, 25079710, 25091141 -25093739, 25093872, 25099339, 25107334, 25110233, 25115178, 25123585 -25150925, 25161298, 25165496, 25178179, 25179774, 25192729, 25205368 -25210690, 25240188, 25248384, 25264559, 25288078, 25300427, 25307368 -25313154, 25328093, 25330273, 25353983, 25357142, 25377044, 25392535 -25405687, 25415713, 25417056, 25417958, 25423453, 25427662, 25429959 -25437695, 25437699, 25459958, 25472885, 25475853, 25476125, 25477657 -25482971, 25483815, 25484507, 25486384, 25489342, 25489367, 25489607 -25490238, 25492379, 25494379, 25494413, 25495682, 25539063, 25546608 -25547060, 25551676, 25555252, 25575628, 25579761, 25599425, 25600342 -25600421, 25602488, 25606091, 25612095, 25616268, 25633101, 25634317 -25635149, 25639019, 25643818, 25643931, 25649873, 25653109, 25654936 -25655390, 25669791, 25670786, 25695903, 25699321, 25722055, 25733479 -25740844, 25743479, 25760195, 25764020, 25766822, 25775213, 25780343 -25789277, 25790353, 25809524, 25822410, 25823532, 25823754, 25856821 -25861398, 25879984, 25881255, 25885148, 25890782, 25897615, 25904490 -25914276, 25919622, 25947799, 25957038, 25982666, 25986062, 25997810 -26007010, 26023002, 26023025, 26024732, 26027162, 26029780, 26039623 -26088426, 26089440, 26110259, 26110632, 26111842, 26121990, 26126424 -26153977, 26169341, 26187943, 26198757, 26198926, 26203182, 26243698 -26245237, 26248143, 26256131, 26262953, 26263721, 26318200, 26318627 -26324206, 26325856, 26336977, 26353617, 26366517, 26412540, 26430737 -26439748, 26444887, 26446098, 26482376, 26513067, 26513709, 26544823 -26546664, 26546754, 26556014, 26569225, 26570171, 26575788, 26633558 -26635845, 26637592, 26637824, 26654363, 26658759, 26714910, 26716835 -26729494, 26758193, 26768025, 26784509, 26822620, 26828994, 26832296 -26844406, 26875822, 26898563, 26956036, 26968670, 26999139, 27000663 -27000690, 27001733, 27012701, 27015449, 27033652, 27034890, 27052607 -27060167, 27072923, 27080844, 27086138, 27092508, 27097854, 27101105 -27122162, 27133662, 27169796, 27185188, 27199245, 27207110, 27207634 -27213224, 27217412, 27223075, 27229389, 27255377, 27274536, 27276231 -27285244, 27303938, 27314206, 27314390, 27314697, 27337759, 27348081 -27351628, 27370965, 27375542, 27397048, 27404573, 27424405, 27433385 -27434193, 27441326, 27443406, 27445727, 27452046, 27461789, 27461842 -27468303, 27475603, 27487919, 27534509, 27548131, 27565906, 27567477 -27611612, 27620950, 27623159, 27629756, 27634991, 27642235, 27667128 -27710072, 27726780, 27729678, 27745728, 27751755, 27829295, 27846298 -27847259, 27897759, 27923320, 27929509, 27938623, 27952577, 27952584 -27986817, 27995248, 27997875, 28000269, 28022101, 28023399, 28023482 -28024793, 28025414, 28026866, 28043157, 28072383, 28079127, 28098160 -28125601, 28164480, 28174827, 28199085, 28201045, 28204104, 28215510 -28250929, 28281094, 28302049, 28305362, 28357401, 28369092, 28371123 -28384353, 28390273, 28394726, 28420042, 28423598, 28432129, 28440711 -28491715, 28501075, 28502113, 28502128, 28507324, 28534493, 28542455 -28566241, 28578164, 28587723, 28612674, 28636676, 28639299, 28644756 -28683167, 28708023, 28714988, 28730253, 28758090, 28774416, 28790654 -28797711, 28821847, 28849751, 28852325, 28867992, 28891741, 28891984 -28915933, 28950969, 28986231, 28993590, 29006527, 29009513, 29027694 -29030780, 29061016, 29122367, 29142109, 29163567, 29170232, 29189889 -29200700, 29247712, 29250317, 29251241, 29254615, 29260956, 29265446 -29342099, 29343156, 29372460, 29378913, 29379978, 29388020, 29408136 -29434301, 29437712, 29458132, 29464779, 29477015, 29483626, 29483672 -29483723, 29483771, 29500257, 29500963, 29511611, 29559723, 29621961 -29625065, 29633753, 29635990, 29637560, 29645349, 29655164, 29689697 -29707896, 29719146, 29726695, 29774367, 29774383, 29782211, 29791152 -29796916, 29814995, 29817278, 29828111, 29869404, 29869906, 29884958 -29893132, 29933718, 29944159, 29944660, 29961353, 29962927, 29962939 -29965888, 29997937, 29997959, 30018017, 30025002, 30031027, 30116203 -30117469, 30128197, 30160639, 30164714, 30179644, 30186245, 30193165 -30196358, 30200680, 30215130, 30218044, 30225443, 30248531, 30252098 -30285540, 30295478, 30305880, 30320029, 30365745, 30387666, 30398099 -30421204, 30497057, 30499600, 30502041, 30517516, 30522998, 30534664 -30578221, 30624864, 30659882, 30668407, 30698289, 30758943, 30803210 -30805558, 30816938, 30822919, 30826474, 30855121, 30860803, 30866988 -30889351, 30939307, 30973003, 30987088, 31001455, 31013127, 31022858 -31028986, 31031715, 31046619, 31089270, 31106577, 31156383, 31172207 -31194264, 31219939, 31228670, 31233170, 31306274, 31335037, 31335142 -31404014, 31409964, 31421316, 31501139, 31510891, 31525783, 31527103 -31637680, 31658943, 31667940, 31668061, 31668867, 31668915, 31675539 -31696577, 31711889, 31748000, 31786838, 31799139, 31827339, 31836113 -31848903, 31862611, 31909295, 31927930, 31945038, 32065792, 32097882 -32105135, 32119339, 32119956, 32153619, 32165915, 32166272, 32186646 -32190132, 32190284, 32222473, 32252213, 32296941, 32312586, 32327201 -32327208, 32335769, 32355765, 32359044, 32368792, 32386877, 32425124 -32436757, 32442404, 32473164, 32523233, 32628221, 32676350, 32720458 -32755493, 32775512, 32776891, 32786309, 32834168, 32846272, 32851841 -32876425, 32878039, 32892894, 32988028, 33034103, 33128590, 33131742 -33192628, 33223294 -``` - -### Version 12\.1\.0\.2\.v25 - -Version 12\.1\.0\.2\.v25 includes the following: -+ Patch 32768233: DATABASE PATCH SET UPDATE 12\.1\.0\.2\.210720 -+ Patch 32876425: OJVM PATCH SET UPDATE 12\.1\.0\.2\.210720 -+ Patch 32327201: RDBMS \- DSTV36 UPDATE \- TZDATA2020E -+ Patch 17969866: Oracle GoldenGate – 46719 ENH REPLICATION SUPPORT FOR INSERTS / FULL UPDATES WITH LARGE VALUES -+ Patch 20394750: Oracle GoldenGate – APPLY CDR RESOLUTION FAILING FOR LOBS, XML, LONG, AND OBJECTS -+ Patch 24835919: Oracle GoldenGate – IR EXECUTING DEPENDENT TRANSACTIONS OUT OF ORDER WITH PARALLELISM GREATER THAN -+ Patch 23262847: Oracle GoldenGate \- MALFORMED REDO CAUSED OGG REPLICATION ABEND -+ Patch 21171382: ADD CONTROL FOR AUTOMATIC CREATION OF STATS EXTENSIONS -+ Patch 21091901: ONLINE MOVE OF HASH OR REF PARTITION CAN LEAVE LOCAL INDEXES INCONSISTENT -+ Patch 25031502: MV QUERY REWRITE WORKLOAD HIT ORA 600 \[KGL\-HEAP\-SIZE\-EXCEEDED\] -+ Patch 23711335: CDB\_UPG PDCDB CDB UPGRADE AS WHOLE TAKES 1 MORE HOUR THAN PREVIOUS LABELS IN MAY -+ Patch 33013352: JSON Bundle Patch -+ PreUpgrade Jar: preupgrade\_12\.1\.0\.2\.0\_18\_crlf\.zip - -#### Combined Patches for Version 12\.1\.0\.2\.v25, Released July 2021 - -Bugs fixed: - -``` -6194865, 6418158, 6599380, 13542050, 13787015, 13854364, 14283239 -14643995, 14705949, 15996848, 16090440, 16354467, 16359751, 16439813 -16619249, 16756406, 16777441, 16799735, 16863642, 16870214, 16875041 -16887946, 16923858, 16938780, 16941434, 17008068, 17210525, 17258582 -17274537, 17319928, 17365043, 17409174, 17414008, 17428816, 17432124 -17495022, 17532729, 17532734, 17533661, 17551063, 17655240, 17722075 -17760068, 17835294, 17867700, 17890099, 17969866, 18007682, 18043064 -18051556, 18090142, 18110491, 18122373, 18191823, 18197127, 18202441 -18250893, 18254023, 18272672, 18288842, 18306996, 18307021, 18308268 -18324100, 18354830, 18371441, 18373438, 18382302, 18411216, 18417036 -18419520, 18427406, 18436647, 18440095, 18456643, 18475439, 18492302 -18499088, 18510194, 18542562, 18548246, 18548433, 18549238, 18604493 -18604692, 18607546, 18610915, 18618122, 18628388, 18648816, 18662619 -18673090, 18674024, 18674047, 18681056, 18693124, 18700762, 18705806 -18727933, 18733351, 18740837, 18742258, 18743542, 18758877, 18759211 -18774543, 18775971, 18778801, 18791688, 18797519, 18798250, 18799063 -18799993, 18801391, 18803726, 18810904, 18818069, 18819908, 18840932 -18841764, 18845653, 18849537, 18849970, 18851894, 18856106, 18856999 -18866977, 18868646, 18885870, 18886413, 18893947, 18895170, 18899974 -18900107, 18904062, 18909599, 18913440, 18914624, 18921743, 18940497 -18948177, 18952766, 18952989, 18964939, 18964978, 18966843, 18967382 -18973548, 18974476, 18988834, 18990023, 18990693, 18999568, 19001359 -19001390, 19012119, 19013183, 19016730, 19017309, 19018206, 19018447 -19022470, 19023822, 19024808, 19028800, 19032777, 19035573, 19044962 -19048007, 19050649, 19051460, 19052488, 19054077, 19058490, 19060015 -19065556, 19065677, 19067244, 19068380, 19068610, 19068970, 19074147 -19075256, 19076343, 19077215, 19079752, 19081128, 19124336, 19124589 -19130152, 19130616, 19131386, 19131607, 19134173, 19141838, 19143550 -19146474, 19149990, 19153980, 19154375, 19155797, 19157754, 19165673 -19168167, 19171086, 19174430, 19174521, 19174942, 19176223, 19176326 -19176885, 19178851, 19180394, 19180770, 19183343, 19185876, 19188385 -19188927, 19189317, 19189525, 19195895, 19197175, 19201867, 19207117 -19211433, 19213447, 19223010, 19231857, 19238590, 19243521, 19245191 -19248279, 19248799, 19258504, 19272708, 19279273, 19280225, 19284031 -19285025, 19289642, 19291380, 19297917, 19303936, 19304354, 19306797 -19307662, 19308965, 19309466, 19313563, 19315668, 19315691, 19317646 -19326908, 19327391, 19329654, 19330795, 19332396, 19333670, 19335438 -19339555, 19347458, 19354335, 19354794, 19358317, 19363645, 19364502 -19366375, 19370504, 19371175, 19373893, 19375649, 19382851, 19383839 -19385656, 19390567, 19390620, 19393542, 19396455, 19399918, 19402853 -19404068, 19409212, 19430401, 19433930, 19434529, 19439759, 19440520 -19440586, 19445860, 19448499, 19450116, 19450314, 19452434, 19461270 -19461428, 19468347, 19468612, 19468991, 19469538, 19475971, 19487147 -19490948, 19501299, 19503821, 19504946, 19512341, 19516448, 19518079 -19520602, 19523462, 19524158, 19524384, 19529868, 19532017, 19534363 -19536415, 19543384, 19547370, 19547774, 19548064, 19550902, 19561643 -19562381, 19566592, 19571055, 19571082, 19571367, 19577410, 19578247 -19578350, 19583624, 19587324, 19590877, 19591608, 19593445, 19597439 -19597583, 19601762, 19604659, 19606174, 19617921, 19619732, 19621704 -19623450, 19627012, 19632912, 19637186, 19639483, 19644859, 19647503 -19649152, 19658708, 19662635, 19663176, 19670108, 19676012, 19676905 -19680796, 19684504, 19687159, 19689979, 19693090, 19699191, 19699946 -19701015, 19703301, 19705781, 19706965, 19708342, 19708632, 19718981 -19721304, 19723336, 19730508, 19769480, 19769625, 19777862, 19781326 -19784751, 19790243, 19791273, 19791377, 19799847, 19805359, 19809171 -19811709, 19817386, 19818513, 19824871, 19831647, 19835133, 19841800 -19855285, 19859472, 19865345, 19869255, 19871910, 19873610, 19877336 -19879746, 19880190, 19883092, 19886165, 19888853, 19889230, 19891090 -19895326, 19895362, 19896336, 19902195, 19908836, 19909862, 19915271 -19928926, 19930276, 19931367, 19931709, 19932634, 19933147, 19941352 -19943771, 19945814, 19952975, 19957298, 19978542, 19982584, 19988852 -19989009, 19990037, 19995869, 20001168, 20001466, 20009569, 20009833 -20011515, 20011646, 20011897, 20017509, 20023340, 20031873, 20043616 -20048359, 20052269, 20061399, 20074391, 20076781, 20078186, 20087383 -20093776, 20101006, 20117253, 20118035, 20122715, 20124446, 20134113 -20134339, 20139391, 20144019, 20144308, 20165574, 20169408, 20171986 -20172151, 20173897, 20175161, 20181030, 20212067, 20217801, 20228093 -20229001, 20233181, 20235511, 20245930, 20250147, 20267166, 20273319 -20281121, 20284155, 20294666, 20296619, 20298413, 20302006, 20308238 -20308798, 20315311, 20318889, 20322560, 20324049, 20328248, 20331945 -20347562, 20348653, 20354900, 20356733, 20361671, 20368850, 20373598 -20374572, 20378086, 20382309, 20387265, 20394750, 20397490, 20401975 -20402832, 20408829, 20408866, 20413820, 20415564, 20424183, 20424899 -20425790, 20428621, 20432873, 20437153, 20440930, 20441797, 20446883 -20447445, 20459944, 20464614, 20466322, 20466628, 20468401, 20468490 -20470877, 20471920, 20474192, 20475845, 20476175, 20480209, 20493163 -20505778, 20509482, 20513399, 20524085, 20528052, 20539050, 20543011 -20544065, 20554364, 20557786, 20558005, 20560611, 20562898, 20564072 -20565112, 20565133, 20569094, 20577490, 20581111, 20582405, 20588486 -20588502, 20591183, 20596234, 20598042, 20603378, 20603431, 20613079 -20618595, 20627866, 20635353, 20641666, 20657411, 20657441, 20669434 -20671094, 20673810, 20677396, 20677974, 20684983, 20686773, 20688221 -20703000, 20703629, 20704450, 20705577, 20707932, 20708701, 20711718 -20717081, 20717091, 20717359, 20725343, 20734332, 20736227, 20746251 -20757079, 20764012, 20766180, 20768076, 20778986, 20794034, 20798891 -20800890, 20801783, 20803014, 20825533, 20828947, 20830459, 20831538 -20832516, 20835241, 20839705, 20842388, 20844426, 20848335, 20856766 -20859910, 20860659, 20862087, 20868862, 20869721, 20875898, 20877664 -20878790, 20879709, 20879889, 20880215, 20882568, 20890311, 20897759 -20898391, 20898997, 20899461, 20904530, 20907061, 20914870, 20919320 -20920911, 20922010, 20925795, 20926021, 20929771, 20936731, 20936905 -20938170, 20951038, 20952966, 20958816, 20977794, 20978259, 21037905 -21037923, 21047766, 21047803, 21052842, 21059919, 21060755, 21061354 -21063322, 21068507, 21072646, 21080143, 21091431, 21091901, 21095391 -21097043, 21099555, 21101873, 21106027, 21132297, 21133343, 21142837 -21147908, 21153266, 21157728, 21159665, 21164318, 21171382, 21172913 -21174504, 21184223, 21186167, 21188532, 21188537, 21188584, 21196809 -21197626, 21220620, 21225209, 21239530, 21241052, 21241829, 21246723 -21260397, 21260431, 21263635, 21266085, 21270823, 21273804, 21275255 -21281532, 21281607, 21285458, 21291274, 21293600, 21294938, 21296029 -21297872, 21299490, 21300341, 21308727, 21315084, 21322887, 21329301 -21354456, 21373076, 21373473, 21380789, 21383171, 21385422, 21387128 -21387964, 21419850, 21421886, 21422580, 21424824, 21425496, 21429602 -21442094, 21450666, 21475738, 21476308, 21479753, 21492036, 21502702 -21514877, 21516611, 21517440, 21522582, 21526048, 21532755, 21534893 -21542577, 21555660, 21560152, 21566639, 21566944, 21566993, 21575362 -21612959, 21620471, 21623164, 21625179, 21626377, 21629064, 21632821 -21641414, 21641760, 21644640, 21649497, 21656630, 21659726, 21665897 -21668627, 21675340, 21695575, 21698350, 21744290, 21756661, 21756677 -21756699, 21764119, 21773465, 21780146, 21785691, 21787056, 21794615 -21795111, 21797203, 21811517, 21820934, 21821302, 21828126, 21834568 -21837606, 21842017, 21842740, 21847223, 21856522, 21863727, 21868720 -21875360, 21889720, 21893235, 21896069, 21899588, 21911701, 21913183 -21915719, 21917884, 21924131, 21960504, 21967197, 21969671, 21977186 -21977392, 22007324, 22018363, 22022760, 22024071, 22037014, 22046677 -22062026, 22062517, 22068305, 22070866, 22072818, 22075064, 22077517 -22083366, 22087683, 22092979, 22118835, 22118851, 22139226, 22146062 -22148226, 22157363, 22160989, 22165897, 22168163, 22173980, 22175564 -22176950, 22178855, 22179537, 22185234, 22205263, 22214989, 22223463 -22228324, 22232606, 22233505, 22238921, 22243719, 22243983, 22250006 -22256431, 22256560, 22258530, 22261050, 22264489, 22268833, 22282748 -22294260, 22296366, 22301880, 22305887, 22346829, 22347493, 22351572 -22353199, 22353346, 22359063, 22364044, 22365117, 22366322, 22366558 -22374754, 22380919, 22454326, 22454940, 22458049, 22465352, 22468255 -22468781, 22475617, 22492533, 22495062, 22495673, 22496904, 22499356 -22501616, 22503297, 22507210, 22507234, 22515353, 22517782, 22518784 -22519146, 22520320, 22528741, 22529728, 22533631, 22536802, 22551446 -22568016, 22568177, 22568797, 22606521, 22624709, 22645009, 22654475 -22657942, 22662332, 22670385, 22670413, 22674709, 22675136, 22686674 -22690648, 22695831, 22707244, 22707866, 22721409, 22729345, 22730454 -22733141, 22734547, 22750215, 22757364, 22760595, 22760679, 22762046 -22782647, 22806698, 22808310, 22809871, 22815955, 22816287, 22820579 -22820798, 22826718, 22836801, 22842151, 22855193, 22862134, 22865673 -22873635, 22894101, 22894949, 22897344, 22901797, 22905130, 22916353 -22922076, 22923409, 22950945, 22961508, 22972770, 22977256, 23002524 -23003979, 23007241, 23008056, 23019710, 23020270, 23025340, 23026585 -23028781, 23029562, 23035249, 23053606, 23061453, 23061702, 23065323 -23066146, 23068169, 23080557, 23082876, 23084507, 23088803, 23089357 -23096938, 23101501, 23104033, 23105538, 23108128, 23115139, 23124895 -23125826, 23126410, 23140259, 23148260, 23149541, 23151677, 23168363 -23170620, 23172924, 23177536, 23177923, 23184013, 23184263, 23195445 -23197103, 23209741, 23220453, 23229229, 23230647, 23237313, 23240358 -23260854, 23262847, 23265914, 23265965, 23266217, 23272045, 23294548 -23302839, 23314180, 23315153, 23315889, 23324000, 23326313, 23328639 -23338911, 23342170, 23492665, 23501901, 23514710, 23514911, 23521523 -23528412, 23533524, 23533807, 23543183, 23548817, 23567857, 23571055 -23572982, 23584909, 23602213, 23614158, 23627427, 23628685, 23642282 -23709062, 23711335, 23713236, 23717151, 23725036, 23727148, 23731896 -23746128, 23854396, 24285405, 24300640, 24303148, 24307571, 24308635 -24315824, 24316947, 24321547, 24326444, 24341675, 24350620, 24350831 -24357500, 24365589, 24385625, 24385983, 24386767, 24393981, 24397438 -24401351, 24411921, 24413809, 24415926, 24416451, 24421668, 24423416 -24425998, 24437510, 24448240, 24448282, 24457597, 24461826, 24480567 -24509056, 24523374, 24530364, 24534298, 24555417, 24560906, 24563422 -24570598, 24573817, 24577566, 24589081, 24597536, 24600330, 24623975 -24624166, 24642295, 24642495, 24652769, 24662775, 24674955, 24683149 -24690216, 24693382, 24701840, 24713381, 24717859, 24718260, 24719736 -24737064, 24737403, 24737581, 24737954, 24739928, 24752618, 24766121 -24784414, 24790914, 24792678, 24796092, 24801152, 24802934, 24808595 -24812585, 24817447, 24825843, 24831514, 24835538, 24835919, 24848928 -24907917, 24908321, 24917972, 24920582, 24929210, 24966594, 25029423 -25031502, 25034396, 25042823, 25047724, 25051465, 25056052, 25058080 -25060506, 25067795, 25076732, 25076756, 25077278, 25079710, 25091141 -25093739, 25093872, 25099339, 25107334, 25110233, 25115178, 25123585 -25150925, 25161298, 25165496, 25178179, 25179774, 25192729, 25205368 -25210690, 25240188, 25248384, 25264559, 25288078, 25300427, 25307368 -25313154, 25328093, 25330273, 25353983, 25357142, 25377044, 25392535 -25405687, 25415713, 25417056, 25417958, 25423453, 25427662, 25429959 -25437695, 25437699, 25459958, 25472885, 25475853, 25476125, 25477657 -25482971, 25483815, 25484507, 25486384, 25489342, 25489367, 25489607 -25490238, 25492379, 25494379, 25494413, 25495682, 25539063, 25546608 -25547060, 25551676, 25555252, 25575628, 25579761, 25599425, 25600342 -25600421, 25602488, 25606091, 25612095, 25616268, 25633101, 25634317 -25635149, 25639019, 25643818, 25643931, 25649873, 25653109, 25654936 -25655390, 25669791, 25670786, 25695903, 25699321, 25722055, 25733479 -25740844, 25743479, 25760195, 25764020, 25766822, 25775213, 25780343 -25789277, 25790353, 25809524, 25822410, 25823532, 25823754, 25856821 -25861398, 25879984, 25881255, 25885148, 25890782, 25897615, 25904490 -25914276, 25919622, 25947799, 25957038, 25982666, 25986062, 25997810 -26007010, 26023002, 26023025, 26024732, 26027162, 26029780, 26039623 -26088426, 26089440, 26110259, 26110632, 26111842, 26121990, 26126424 -26153977, 26169341, 26187943, 26198757, 26198926, 26203182, 26243698 -26245237, 26248143, 26256131, 26262953, 26263721, 26318200, 26318627 -26324206, 26325856, 26336977, 26353617, 26366517, 26412540, 26430737 -26439748, 26444887, 26446098, 26482376, 26513067, 26513709, 26544823 -26546664, 26546754, 26556014, 26569225, 26570171, 26575788, 26633558 -26635845, 26637592, 26637824, 26654363, 26658759, 26714910, 26716835 -26729494, 26758193, 26768025, 26784509, 26822620, 26828994, 26832296 -26844406, 26875822, 26898563, 26968670, 26999139, 27000663, 27000690 -27001733, 27012701, 27015449, 27033652, 27034890, 27052607, 27060167 -27072923, 27086138, 27092508, 27097854, 27101105, 27122162, 27133662 -27169796, 27185188, 27199245, 27207110, 27207634, 27213224, 27217412 -27223075, 27229389, 27255377, 27274536, 27276231, 27285244, 27303938 -27314206, 27314390, 27314697, 27337759, 27348081, 27351628, 27370965 -27375542, 27397048, 27404573, 27424405, 27433385, 27434193, 27441326 -27443406, 27445727, 27452046, 27461789, 27461842, 27468303, 27475603 -27487919, 27534509, 27548131, 27565906, 27567477, 27611612, 27620950 -27623159, 27629756, 27634991, 27642235, 27667128, 27710072, 27726780 -27729678, 27745728, 27751755, 27829295, 27846298, 27847259, 27897759 -27923320, 27929509, 27938623, 27952577, 27952584, 27986817, 27995248 -27997875, 28000269, 28022101, 28023399, 28023482, 28024793, 28025414 -28026866, 28043157, 28072383, 28079127, 28098160, 28125601, 28164480 -28174827, 28199085, 28215510, 28250929, 28281094, 28302049, 28305362 -28357401, 28369092, 28371123, 28384353, 28390273, 28394726, 28420042 -28423598, 28432129, 28440711, 28491715, 28501075, 28502113, 28502128 -28507324, 28534493, 28542455, 28566241, 28578164, 28587723, 28612674 -28636676, 28639299, 28644756, 28683167, 28708023, 28714988, 28730253 -28758090, 28774416, 28790654, 28797711, 28821847, 28849751, 28852325 -28867992, 28891741, 28891984, 28915933, 28950969, 28986231, 28993590 -29006527, 29009513, 29027694, 29030780, 29061016, 29142109, 29163567 -29170232, 29189889, 29200700, 29247712, 29250317, 29251241, 29254615 -29260956, 29265446, 29342099, 29343156, 29372460, 29378913, 29379978 -29388020, 29408136, 29434301, 29437712, 29464779, 29477015, 29483626 -29483672, 29483723, 29483771, 29500257, 29500963, 29511611, 29559723 -29621961, 29625065, 29633753, 29637560, 29645349, 29689697, 29707896 -29719146, 29726695, 29774367, 29774383, 29782211, 29791152, 29796916 -29814995, 29817278, 29828111, 29869404, 29869906, 29884958, 29893132 -29933718, 29944660, 29961353, 29962927, 29962939, 29965888, 29997937 -29997959, 30018017, 30025002, 30031027, 30116203, 30117469, 30128197 -30160639, 30164714, 30179644, 30186245, 30196358, 30200680, 30215130 -30218044, 30225443, 30252098, 30295478, 30305880, 30320029, 30365745 -30387666, 30398099, 30421204, 30497057, 30499600, 30502041, 30517516 -30522998, 30534664, 30578221, 30624864, 30659882, 30668407, 30698289 -30758943, 30803210, 30805558, 30816938, 30822919, 30826474, 30855121 -30860803, 30866988, 30889351, 30939307, 30973003, 30987088, 31001455 -31013127, 31022858, 31028986, 31031715, 31046619, 31089270, 31106577 -31156383, 31172207, 31194264, 31219939, 31228670, 31233170, 31306274 -31335037, 31335142, 31409964, 31421316, 31501139, 31510891, 31527103 -31637680, 31658943, 31667940, 31668061, 31668867, 31668915, 31675539 -31696577, 31711889, 31748000, 31786838, 31799139, 31836113, 31848903 -31862611, 31909295, 31927930, 31945038, 32065792, 32097882, 32105135 -32119339, 32119956, 32153619, 32165915, 32186646, 32190132, 32190284 -32222473, 32252213, 32296941, 32312586, 32327201, 32327208, 32335769 -32359044, 32368792, 32386877, 32425124, 32436757, 32442404, 32473164 -32523233, 32628221, 32676350, 32720458, 32768233, 32786309, 32876425 -32892894, 33034103 -``` - -### Version 12\.1\.0\.2\.v24 - -Version 12\.1\.0\.2\.v24 includes the following: -+ Patch 32328635: DATABASE PATCH SET UPDATE 12\.1\.0\.2\.210420 -+ Patch 32473164: OJVM PATCH SET UPDATE 12\.1\.0\.2\.210420 -+ Patch 32327201: RDBMS \- DSTV36 UPDATE \- TZDATA2020E -+ Patch 17969866: Oracle GoldenGate – 46719 ENH REPLICATION SUPPORT FOR INSERTS / FULL UPDATES WITH LARGE VALUES -+ Patch 20394750: Oracle GoldenGate – APPLY CDR RESOLUTION FAILING FOR LOBS, XML, LONG, AND OBJECTS -+ Patch 24835919: Oracle GoldenGate – IR EXECUTING DEPENDENT TRANSACTIONS OUT OF ORDER WITH PARALLELISM GREATER THAN -+ Patch 23262847: Oracle GoldenGate \- MALFORMED REDO CAUSED OGG REPLICATION ABEND -+ Patch 21171382: ADD CONTROL FOR AUTOMATIC CREATION OF STATS EXTENSIONS -+ Patch 21091901: ONLINE MOVE OF HASH OR REF PARTITION CAN LEAVE LOCAL INDEXES INCONSISTENT -+ Patch 25031502: MV QUERY REWRITE WORKLOAD HIT ORA 600 \[KGL\-HEAP\-SIZE\-EXCEEDED\] -+ Patch 23711335: CDB\_UPG PDCDB CDB UPGRADE AS WHOLE TAKES 1 MORE HOUR THAN PREVIOUS LABELS IN MAY -+ Patch 32616600: JSON Bundle Patch -+ PreUpgrade Jar: preupgrade\_12\.1\.0\.2\.0\_18\_crlf\.zip - -#### Combined Patches for Version 12\.1\.0\.2\.v24, Released April 2021 - -Bugs fixed: - -``` -6194865, 6418158, 6599380, 13542050, 13787015, 13854364, 14283239 -14643995, 14705949, 16090440, 16354467, 16359751, 16439813, 16619249 -16756406, 16777441, 16799735, 16863642, 16870214, 16875041, 16887946 -16923858, 16938780, 16941434, 17008068, 17210525, 17258582, 17274537 -17319928, 17365043, 17409174, 17414008, 17432124, 17495022, 17532729 -17532734, 17533661, 17551063, 17655240, 17722075, 17760068, 17835294 -17867700, 17890099, 17969866, 18007682, 18043064, 18051556, 18090142 -18110491, 18122373, 18191823, 18202441, 18250893, 18254023, 18272672 -18288842, 18306996, 18307021, 18308268, 18324100, 18354830, 18371441 -18373438, 18382302, 18411216, 18417036, 18419520, 18427406, 18436647 -18440095, 18456643, 18475439, 18492302, 18499088, 18510194, 18542562 -18548246, 18548433, 18549238, 18604493, 18604692, 18607546, 18610915 -18618122, 18628388, 18648816, 18662619, 18673090, 18674024, 18674047 -18681056, 18693124, 18700762, 18705806, 18727933, 18733351, 18740837 -18742258, 18743542, 18758877, 18759211, 18774543, 18775971, 18778801 -18791688, 18797519, 18798250, 18799063, 18799993, 18801391, 18803726 -18810904, 18818069, 18819908, 18840932, 18841764, 18845653, 18849537 -18849970, 18851894, 18856106, 18856999, 18866977, 18868646, 18885870 -18886413, 18893947, 18895170, 18899974, 18900107, 18904062, 18909599 -18913440, 18914624, 18921743, 18940497, 18948177, 18952766, 18952989 -18964939, 18964978, 18966843, 18967382, 18973548, 18974476, 18988834 -18990023, 18990693, 18999568, 19001359, 19001390, 19012119, 19013183 -19016730, 19017309, 19018206, 19018447, 19022470, 19023822, 19024808 -19028800, 19032777, 19035573, 19044962, 19048007, 19050649, 19052488 -19054077, 19058490, 19060015, 19065556, 19065677, 19067244, 19068380 -19068610, 19068970, 19074147, 19075256, 19076343, 19077215, 19079752 -19081128, 19124336, 19124589, 19130152, 19131386, 19131607, 19134173 -19141838, 19143550, 19146474, 19149990, 19153980, 19154375, 19155797 -19157754, 19165673, 19168167, 19171086, 19174430, 19174521, 19174942 -19176223, 19176326, 19176885, 19178851, 19180394, 19180770, 19183343 -19185876, 19188385, 19188927, 19189317, 19189525, 19195895, 19197175 -19201867, 19207117, 19211433, 19213447, 19223010, 19231857, 19238590 -19243521, 19245191, 19248279, 19248799, 19258504, 19272708, 19279273 -19280225, 19284031, 19285025, 19289642, 19291380, 19297917, 19303936 -19304354, 19306797, 19307662, 19308965, 19309466, 19313563, 19315668 -19315691, 19317646, 19326908, 19327391, 19329654, 19330795, 19332396 -19333670, 19335438, 19339555, 19347458, 19354335, 19354794, 19358317 -19363645, 19364502, 19366375, 19370504, 19371175, 19373893, 19375649 -19382851, 19383839, 19385656, 19390567, 19390620, 19393542, 19396455 -19399918, 19402853, 19404068, 19409212, 19430401, 19433930, 19434529 -19439759, 19440520, 19440586, 19445860, 19448499, 19450116, 19450314 -19452434, 19461270, 19461428, 19468347, 19468612, 19468991, 19469538 -19475971, 19487147, 19490948, 19501299, 19503821, 19512341, 19516448 -19518079, 19520602, 19523462, 19524158, 19524384, 19529868, 19532017 -19534363, 19536415, 19543384, 19547370, 19547774, 19548064, 19550902 -19561643, 19562381, 19566592, 19571055, 19571082, 19571367, 19577410 -19578247, 19578350, 19583624, 19587324, 19590877, 19591608, 19593445 -19597439, 19597583, 19601762, 19604659, 19606174, 19617921, 19619732 -19623450, 19627012, 19632912, 19637186, 19639483, 19644859, 19647503 -19649152, 19658708, 19662635, 19663176, 19670108, 19676012, 19676905 -19680796, 19684504, 19687159, 19689979, 19693090, 19699191, 19699946 -19701015, 19703301, 19705781, 19706965, 19708342, 19708632, 19718981 -19721304, 19723336, 19730508, 19769480, 19769625, 19777862, 19781326 -19784751, 19790243, 19791273, 19791377, 19799847, 19805359, 19809171 -19811709, 19817386, 19818513, 19824871, 19831647, 19835133, 19841800 -19855285, 19859472, 19865345, 19869255, 19871910, 19873610, 19877336 -19879746, 19880190, 19883092, 19886165, 19888853, 19889230, 19891090 -19895326, 19895362, 19896336, 19902195, 19908836, 19909862, 19915271 -19928926, 19930276, 19931367, 19931709, 19932634, 19933147, 19941352 -19943771, 19952975, 19957298, 19978542, 19982584, 19988852, 19989009 -19990037, 19995869, 20001168, 20001466, 20009569, 20009833, 20011515 -20011646, 20011897, 20017509, 20023340, 20031873, 20043616, 20048359 -20052269, 20061399, 20074391, 20076781, 20078186, 20087383, 20093776 -20101006, 20117253, 20118035, 20122715, 20124446, 20134113, 20134339 -20139391, 20144019, 20144308, 20165574, 20169408, 20171986, 20172151 -20173897, 20175161, 20181030, 20212067, 20217801, 20228093, 20229001 -20233181, 20235511, 20245930, 20250147, 20267166, 20273319, 20281121 -20284155, 20294666, 20296619, 20298413, 20302006, 20308798, 20315311 -20318889, 20322560, 20324049, 20328248, 20331945, 20347562, 20348653 -20354900, 20356733, 20361671, 20368850, 20373598, 20374572, 20378086 -20382309, 20387265, 20394750, 20397490, 20401975, 20402832, 20408829 -20408866, 20413820, 20415564, 20424183, 20424899, 20425790, 20428621 -20432873, 20437153, 20440930, 20441797, 20446883, 20447445, 20459944 -20464614, 20466322, 20466628, 20468401, 20468490, 20470877, 20471920 -20474192, 20475845, 20476175, 20480209, 20493163, 20505778, 20509482 -20513399, 20524085, 20528052, 20539050, 20543011, 20544065, 20554364 -20557786, 20558005, 20560611, 20562898, 20564072, 20565112, 20565133 -20569094, 20577490, 20581111, 20582405, 20588486, 20588502, 20591183 -20596234, 20598042, 20603378, 20603431, 20613079, 20618595, 20627866 -20635353, 20641666, 20657411, 20657441, 20669434, 20671094, 20673810 -20677396, 20677974, 20684983, 20686773, 20688221, 20703000, 20703629 -20704450, 20705577, 20707932, 20708701, 20711718, 20717081, 20717091 -20717359, 20725343, 20734332, 20736227, 20746251, 20757079, 20764012 -20766180, 20768076, 20778986, 20794034, 20798891, 20800890, 20801783 -20803014, 20825533, 20828947, 20830459, 20831538, 20832516, 20835241 -20839705, 20842388, 20844426, 20848335, 20856766, 20859910, 20860659 -20862087, 20868862, 20869721, 20875898, 20877664, 20878790, 20879709 -20879889, 20880215, 20882568, 20890311, 20897759, 20898391, 20898997 -20899461, 20904530, 20907061, 20914870, 20919320, 20920911, 20922010 -20925795, 20926021, 20929771, 20936731, 20936905, 20938170, 20951038 -20952966, 20958816, 20977794, 20978259, 21037905, 21037923, 21047766 -21047803, 21052842, 21059919, 21060755, 21061354, 21063322, 21068507 -21072646, 21080143, 21091431, 21091901, 21095391, 21097043, 21099555 -21101873, 21106027, 21132297, 21133343, 21142837, 21147908, 21153266 -21157728, 21159665, 21164318, 21171382, 21172913, 21174504, 21184223 -21186167, 21188532, 21188537, 21188584, 21196809, 21197626, 21220620 -21225209, 21239530, 21241052, 21241829, 21246723, 21260397, 21260431 -21263635, 21266085, 21270823, 21273804, 21275255, 21281532, 21281607 -21285458, 21291274, 21293600, 21294938, 21296029, 21297872, 21299490 -21300341, 21308727, 21315084, 21322887, 21329301, 21354456, 21373076 -21373473, 21380789, 21383171, 21385422, 21387128, 21387964, 21419850 -21421886, 21422580, 21424824, 21425496, 21429602, 21442094, 21450666 -21475738, 21476308, 21479753, 21492036, 21502702, 21514877, 21516611 -21517440, 21522582, 21526048, 21532755, 21534893, 21542577, 21555660 -21560152, 21566639, 21566944, 21566993, 21575362, 21612959, 21620471 -21623164, 21625179, 21626377, 21629064, 21632821, 21641414, 21641760 -21644640, 21649497, 21656630, 21659726, 21665897, 21668627, 21675340 -21695575, 21698350, 21744290, 21756661, 21756677, 21756699, 21764119 -21773465, 21780146, 21785691, 21787056, 21794615, 21795111, 21797203 -21811517, 21820934, 21821302, 21828126, 21834568, 21837606, 21842017 -21842740, 21847223, 21856522, 21863727, 21868720, 21875360, 21889720 -21893235, 21896069, 21899588, 21911701, 21913183, 21915719, 21917884 -21924131, 21960504, 21967197, 21977186, 21977392, 22007324, 22018363 -22022760, 22024071, 22037014, 22046677, 22062026, 22062517, 22068305 -22070866, 22072818, 22075064, 22077517, 22083366, 22087683, 22092979 -22118835, 22118851, 22139226, 22146062, 22148226, 22157363, 22160989 -22165897, 22168163, 22173980, 22175564, 22176950, 22178855, 22179537 -22185234, 22205263, 22214989, 22223463, 22228324, 22232606, 22233505 -22238921, 22243719, 22243983, 22250006, 22256431, 22256560, 22258530 -22261050, 22264489, 22268833, 22282748, 22294260, 22296366, 22301880 -22305887, 22346829, 22347493, 22351572, 22353199, 22353346, 22359063 -22364044, 22365117, 22366322, 22366558, 22374754, 22380919, 22454326 -22454940, 22458049, 22465352, 22468255, 22468781, 22475617, 22492533 -22495062, 22495673, 22496904, 22499356, 22501616, 22503297, 22507210 -22507234, 22515353, 22517782, 22518784, 22519146, 22520320, 22528741 -22529728, 22533631, 22536802, 22551446, 22568016, 22568177, 22568797 -22606521, 22624709, 22645009, 22654475, 22657942, 22662332, 22670385 -22670413, 22674709, 22675136, 22686674, 22690648, 22695831, 22707244 -22707866, 22721409, 22729345, 22730454, 22733141, 22734547, 22750215 -22757364, 22760595, 22760679, 22762046, 22782647, 22806698, 22808310 -22809871, 22815955, 22816287, 22820579, 22820798, 22826718, 22836801 -22842151, 22855193, 22862134, 22865673, 22873635, 22894101, 22894949 -22897344, 22901797, 22905130, 22916353, 22922076, 22923409, 22950945 -22961508, 22972770, 22977256, 23002524, 23003979, 23007241, 23008056 -23019710, 23020270, 23025340, 23026585, 23028781, 23029562, 23035249 -23053606, 23061453, 23061702, 23065323, 23066146, 23068169, 23080557 -23082876, 23084507, 23088803, 23089357, 23096938, 23101501, 23104033 -23105538, 23108128, 23115139, 23124895, 23125826, 23126410, 23140259 -23148260, 23149541, 23151677, 23168363, 23170620, 23172924, 23177536 -23177923, 23184013, 23184263, 23195445, 23197103, 23209741, 23220453 -23229229, 23237313, 23240358, 23260854, 23262847, 23265914, 23265965 -23266217, 23272045, 23294548, 23302839, 23314180, 23315153, 23315889 -23324000, 23326313, 23328639, 23338911, 23342170, 23492665, 23501901 -23514710, 23514911, 23521523, 23528412, 23533524, 23533807, 23543183 -23548817, 23567857, 23571055, 23572982, 23584909, 23602213, 23614158 -23627427, 23628685, 23642282, 23709062, 23711335, 23713236, 23717151 -23725036, 23727148, 23731896, 23746128, 23854396, 24285405, 24300640 -24303148, 24307571, 24308635, 24315824, 24316947, 24321547, 24326444 -24341675, 24350620, 24350831, 24365589, 24385625, 24385983, 24386767 -24393981, 24397438, 24401351, 24411921, 24413809, 24415926, 24416451 -24421668, 24423416, 24425998, 24437510, 24448240, 24448282, 24457597 -24461826, 24480567, 24509056, 24523374, 24530364, 24534298, 24555417 -24560906, 24563422, 24570598, 24573817, 24577566, 24589081, 24597536 -24600330, 24624166, 24642295, 24642495, 24652769, 24662775, 24674955 -24683149, 24690216, 24693382, 24701840, 24713381, 24717859, 24718260 -24719736, 24737064, 24737403, 24737581, 24737954, 24739928, 24752618 -24766121, 24784414, 24790914, 24792678, 24796092, 24801152, 24802934 -24808595, 24812585, 24817447, 24825843, 24831514, 24835538, 24835919 -24848928, 24907917, 24908321, 24917972, 24920582, 24929210, 24966594 -25029423, 25031502, 25034396, 25042823, 25047724, 25051465, 25056052 -25058080, 25060506, 25067795, 25076732, 25076756, 25077278, 25079710 -25091141, 25093739, 25093872, 25099339, 25107334, 25110233, 25115178 -25123585, 25150925, 25161298, 25165496, 25178179, 25179774, 25192729 -25205368, 25210690, 25240188, 25248384, 25264559, 25288078, 25300427 -25307368, 25313154, 25328093, 25330273, 25353983, 25357142, 25377044 -25392535, 25405687, 25415713, 25417056, 25417958, 25423453, 25427662 -25429959, 25437695, 25437699, 25459958, 25472885, 25475853, 25476125 -25477657, 25482971, 25483815, 25484507, 25486384, 25489342, 25489367 -25489607, 25490238, 25492379, 25494379, 25494413, 25495682, 25539063 -25546608, 25547060, 25551676, 25555252, 25575628, 25579761, 25599425 -25600342, 25600421, 25602488, 25606091, 25612095, 25616268, 25633101 -25634317, 25635149, 25639019, 25643818, 25643931, 25649873, 25653109 -25654936, 25655390, 25669791, 25670786, 25695903, 25699321, 25722055 -25733479, 25740844, 25743479, 25760195, 25764020, 25766822, 25775213 -25780343, 25789277, 25790353, 25809524, 25822410, 25823532, 25823754 -25856821, 25861398, 25879984, 25881255, 25885148, 25890782, 25897615 -25904490, 25914276, 25919622, 25947799, 25957038, 25982666, 25986062 -25997810, 26007010, 26023002, 26023025, 26024732, 26027162, 26029780 -26039623, 26088426, 26089440, 26110259, 26110632, 26111842, 26121990 -26126424, 26153977, 26169341, 26187943, 26198757, 26198926, 26203182 -26243698, 26245237, 26248143, 26256131, 26262953, 26263721, 26318200 -26318627, 26324206, 26325856, 26336977, 26353617, 26366517, 26412540 -26430737, 26439748, 26444887, 26446098, 26482376, 26513067, 26513709 -26544823, 26546664, 26546754, 26556014, 26569225, 26570171, 26575788 -26633558, 26635845, 26637592, 26637824, 26654363, 26658759, 26714910 -26716835, 26729494, 26758193, 26768025, 26784509, 26822620, 26828994 -26832296, 26844406, 26875822, 26898563, 26968670, 26999139, 27000663 -27000690, 27001733, 27012701, 27015449, 27033652, 27034890, 27052607 -27060167, 27072923, 27086138, 27092508, 27097854, 27101105, 27122162 -27133662, 27169796, 27185188, 27199245, 27207110, 27207634, 27213224 -27217412, 27223075, 27229389, 27255377, 27274536, 27276231, 27285244 -27303938, 27314206, 27314390, 27314697, 27337759, 27348081, 27351628 -27370965, 27375542, 27397048, 27404573, 27424405, 27433385, 27434193 -27441326, 27443406, 27445727, 27452046, 27461789, 27461842, 27468303 -27475603, 27487919, 27534509, 27548131, 27565906, 27567477, 27611612 -27620950, 27623159, 27629756, 27634991, 27642235, 27667128, 27710072 -27726780, 27729678, 27745728, 27751755, 27829295, 27846298, 27847259 -27897759, 27923320, 27929509, 27938623, 27952577, 27952584, 27986817 -27995248, 27997875, 28000269, 28022101, 28023399, 28023482, 28024793 -28025414, 28026866, 28043157, 28072383, 28079127, 28098160, 28125601 -28164480, 28174827, 28199085, 28215510, 28250929, 28281094, 28302049 -28305362, 28357401, 28369092, 28371123, 28384353, 28390273, 28394726 -28420042, 28423598, 28432129, 28440711, 28501075, 28502113, 28502128 -28507324, 28542455, 28566241, 28578164, 28587723, 28612674, 28636676 -28639299, 28683167, 28708023, 28714988, 28758090, 28774416, 28790654 -28797711, 28821847, 28849751, 28852325, 28867992, 28891741, 28891984 -28915933, 28950969, 28986231, 28993590, 29006527, 29009513, 29027694 -29030780, 29061016, 29142109, 29163567, 29170232, 29189889, 29200700 -29247712, 29250317, 29251241, 29254615, 29260956, 29342099, 29343156 -29372460, 29378913, 29379978, 29388020, 29408136, 29434301, 29437712 -29464779, 29477015, 29483626, 29483672, 29483723, 29483771, 29500257 -29500963, 29511611, 29559723, 29621961, 29625065, 29633753, 29637560 -29645349, 29689697, 29707896, 29719146, 29726695, 29774367, 29774383 -29782211, 29791152, 29796916, 29814995, 29817278, 29828111, 29869404 -29869906, 29884958, 29893132, 29933718, 29944660, 29961353, 29962927 -29962939, 29965888, 29997937, 30018017, 30031027, 30116203, 30117469 -30128197, 30160639, 30164714, 30179644, 30186245, 30196358, 30200680 -30215130, 30218044, 30225443, 30252098, 30295478, 30305880, 30320029 -30365745, 30387666, 30421204, 30497057, 30499600, 30502041, 30517516 -30522998, 30534664, 30578221, 30624864, 30659882, 30668407, 30698289 -30758943, 30803210, 30805558, 30816938, 30822919, 30826474, 30855121 -30860803, 30866988, 30889351, 30973003, 30987088, 31001455, 31013127 -31022858, 31028986, 31031715, 31046619, 31106577, 31156383, 31172207 -31194264, 31219939, 31228670, 31233170, 31306274, 31335037, 31335142 -31501139, 31637680, 31658943, 31668061, 31668867, 31668915, 31675539 -31696577, 31711889, 31748000, 31786838, 31799139, 31836113, 31862611 -31909295, 31927930, 31945038, 32065792, 32097882, 32105135, 32119956 -32165915, 32186646, 32222473, 32296941, 32327201, 32328635, 32436757 -32473164, 32523233 -``` - -### Version 12\.1\.0\.2\.v23 - -Version 12\.1\.0\.2\.v23 includes the following: -+ Patch 31985579: DATABASE PATCH SET UPDATE 12\.1\.0\.2\.210119 -+ Patch 32119956: OJVM PATCH SET UPDATE 12\.1\.0\.2\.210119 -+ Patch 31335037: RDBMS \- DSTV35 UPDATE \- TZDATA2020A -+ Patch 31335142: DSTV35 UPDATE \- TZDATA2020A \- NEED OJVM FIX -+ Patch 28730253: SUPPORT NEW ERA REIWA FOR JAPANESE IMPERIAL CALENDAR -+ Patch 17969866: Oracle GoldenGate – 46719 ENH REPLICATION SUPPORT FOR INSERTS / FULL UPDATES WITH LARGE VALUES -+ Patch 20394750: Oracle GoldenGate – APPLY CDR RESOLUTION FAILING FOR LOBS, XML, LONG, AND OBJECTS -+ Patch 24835919: Oracle GoldenGate – IR EXECUTING DEPENDENT TRANSACTIONS OUT OF ORDER WITH PARALLELISM GREATER THAN -+ Patch 23262847: Oracle GoldenGate \- MALFORMED REDO CAUSED OGG REPLICATION ABEND -+ Patch 21171382: ADD CONTROL FOR AUTOMATIC CREATION OF STATS EXTENSIONS -+ Patch 21091901: ONLINE MOVE OF HASH OR REF PARTITION CAN LEAVE LOCAL INDEXES INCONSISTENT -+ Patch 25031502: MV QUERY REWRITE WORKLOAD HIT ORA 600 \[KGL\-HEAP\-SIZE\-EXCEEDED\] -+ Patch 23711335: CDB\_UPG PDCDB CDB UPGRADE AS WHOLE TAKES 1 MORE HOUR THAN PREVIOUS LABELS IN MAY -+ Patch 32327179: JSON Bundle Patch -+ PreUpgrade Jar: preupgrade\_12\.1\.0\.2\.0\_18\_crlf\.zip -+ Java Cryptography Extension \(JCE\): Unlimited Strength Jurisdiction Policy Files for JVM version 6 - -#### Combined patches for version 12\.1\.0\.2\.v23, released February 2021 - -Bugs fixed: - -``` -6194865, 6418158, 6599380, 13542050, 13787015, 13854364, 14283239 -14643995, 14705949, 16090440, 16354467, 16359751, 16439813, 16619249 -16756406, 16777441, 16799735, 16863642, 16870214, 16875041, 16887946 -16923858, 16938780, 16941434, 17008068, 17210525, 17258582, 17274537 -17319928, 17365043, 17409174, 17414008, 17432124, 17495022, 17532729 -17532734, 17533661, 17551063, 17655240, 17722075, 17760068, 17835294 -17867700, 17890099, 17969866, 18007682, 18043064, 18051556, 18090142 -18110491, 18122373, 18191823, 18202441, 18250893, 18254023, 18272672 -18288842, 18306996, 18307021, 18308268, 18324100, 18354830, 18371441 -18373438, 18382302, 18411216, 18417036, 18419520, 18427406, 18436647 -18440095, 18456643, 18475439, 18492302, 18499088, 18510194, 18542562 -18548246, 18548433, 18549238, 18604493, 18604692, 18607546, 18610915 -18618122, 18628388, 18648816, 18662619, 18673090, 18674024, 18674047 -18681056, 18693124, 18700762, 18705806, 18727933, 18733351, 18740837 -18742258, 18743542, 18758877, 18759211, 18774543, 18775971, 18778801 -18791688, 18797519, 18798250, 18799063, 18799993, 18801391, 18803726 -18810904, 18818069, 18819908, 18840932, 18841764, 18845653, 18849537 -18849970, 18851894, 18856106, 18856999, 18866977, 18868646, 18885870 -18886413, 18893947, 18895170, 18899974, 18900107, 18904062, 18909599 -18913440, 18914624, 18921743, 18940497, 18948177, 18952766, 18952989 -18964939, 18964978, 18966843, 18967382, 18973548, 18974476, 18988834 -18990023, 18990693, 18999568, 19001359, 19001390, 19012119, 19013183 -19016730, 19017309, 19018206, 19018447, 19022470, 19023822, 19024808 -19028800, 19032777, 19035573, 19044962, 19048007, 19050649, 19052488 -19054077, 19058490, 19060015, 19065556, 19065677, 19067244, 19068380 -19068610, 19068970, 19074147, 19075256, 19076343, 19077215, 19079752 -19081128, 19124336, 19124589, 19130152, 19131386, 19131607, 19134173 -19141838, 19143550, 19146474, 19149990, 19153980, 19154375, 19155797 -19157754, 19165673, 19168167, 19171086, 19174430, 19174521, 19174942 -19176223, 19176326, 19176885, 19178851, 19180394, 19180770, 19183343 -19185876, 19188385, 19188927, 19189317, 19189525, 19195895, 19197175 -19201867, 19207117, 19211433, 19213447, 19223010, 19231857, 19238590 -19243521, 19245191, 19248279, 19248799, 19258504, 19272708, 19279273 -19280225, 19284031, 19285025, 19289642, 19291380, 19297917, 19303936 -19304354, 19306797, 19307662, 19308965, 19309466, 19313563, 19315668 -19315691, 19317646, 19326908, 19327391, 19329654, 19330795, 19332396 -19333670, 19335438, 19339555, 19347458, 19354335, 19354794, 19358317 -19363645, 19364502, 19366375, 19370504, 19371175, 19373893, 19375649 -19382851, 19383839, 19385656, 19390567, 19390620, 19393542, 19396455 -19399918, 19402853, 19404068, 19409212, 19430401, 19433930, 19434529 -19439759, 19440520, 19440586, 19445860, 19448499, 19450116, 19450314 -19452434, 19461270, 19461428, 19468347, 19468612, 19468991, 19469538 -19475971, 19487147, 19490948, 19501299, 19503821, 19512341, 19516448 -19518079, 19520602, 19523462, 19524158, 19524384, 19529868, 19532017 -19534363, 19536415, 19543384, 19547370, 19547774, 19548064, 19550902 -19561643, 19562381, 19566592, 19571055, 19571082, 19571367, 19577410 -19578247, 19578350, 19583624, 19587324, 19590877, 19591608, 19593445 -19597439, 19597583, 19601762, 19604659, 19606174, 19617921, 19619732 -19623450, 19627012, 19632912, 19637186, 19639483, 19644859, 19647503 -19649152, 19658708, 19662635, 19663176, 19670108, 19676012, 19676905 -19680796, 19684504, 19687159, 19689979, 19693090, 19699191, 19699946 -19701015, 19703301, 19705781, 19706965, 19708342, 19708632, 19718981 -19721304, 19723336, 19730508, 19769480, 19769625, 19777862, 19781326 -19784751, 19790243, 19791273, 19791377, 19799847, 19805359, 19809171 -19811709, 19817386, 19818513, 19824871, 19831647, 19835133, 19841800 -19855285, 19859472, 19865345, 19869255, 19871910, 19873610, 19877336 -19879746, 19880190, 19883092, 19886165, 19888853, 19889230, 19891090 -19895326, 19895362, 19896336, 19902195, 19908836, 19909862, 19915271 -19928926, 19930276, 19931367, 19931709, 19932634, 19933147, 19941352 -19943771, 19952975, 19957298, 19978542, 19982584, 19988852, 19989009 -19990037, 19995869, 20001168, 20001466, 20009569, 20009833, 20011515 -20011646, 20011897, 20017509, 20023340, 20031873, 20043616, 20048359 -20052269, 20061399, 20074391, 20076781, 20078186, 20087383, 20093776 -20101006, 20117253, 20118035, 20122715, 20124446, 20134113, 20134339 -20139391, 20144019, 20144308, 20165574, 20169408, 20171986, 20172151 -20173897, 20175161, 20181030, 20212067, 20217801, 20228093, 20229001 -20233181, 20235511, 20245930, 20250147, 20267166, 20273319, 20281121 -20284155, 20294666, 20296619, 20298413, 20302006, 20308798, 20315311 -20318889, 20322560, 20324049, 20328248, 20331945, 20347562, 20348653 -20354900, 20356733, 20361671, 20368850, 20373598, 20374572, 20378086 -20382309, 20387265, 20394750, 20397490, 20401975, 20402832, 20408829 -20408866, 20413820, 20415564, 20424183, 20424899, 20425790, 20428621 -20432873, 20437153, 20440930, 20441797, 20446883, 20447445, 20459944 -20464614, 20466322, 20466628, 20468401, 20468490, 20470877, 20471920 -20474192, 20475845, 20476175, 20480209, 20493163, 20505778, 20509482 -20513399, 20524085, 20528052, 20539050, 20543011, 20544065, 20554364 -20557786, 20558005, 20560611, 20562898, 20564072, 20565112, 20565133 -20569094, 20577490, 20581111, 20582405, 20588486, 20588502, 20591183 -20596234, 20598042, 20603378, 20603431, 20613079, 20618595, 20627866 -20635353, 20641666, 20657411, 20657441, 20669434, 20671094, 20673810 -20677396, 20677974, 20684983, 20686773, 20688221, 20703000, 20703629 -20704450, 20705577, 20707932, 20708701, 20711718, 20717081, 20717091 -20717359, 20725343, 20734332, 20736227, 20746251, 20757079, 20764012 -20766180, 20768076, 20778986, 20794034, 20798891, 20800890, 20801783 -20803014, 20825533, 20828947, 20830459, 20831538, 20832516, 20835241 -20839705, 20842388, 20844426, 20848335, 20856766, 20859910, 20860659 -20862087, 20868862, 20869721, 20875898, 20877664, 20878790, 20879709 -20879889, 20880215, 20882568, 20890311, 20897759, 20898391, 20898997 -20899461, 20904530, 20907061, 20914870, 20919320, 20920911, 20922010 -20925795, 20926021, 20929771, 20936731, 20936905, 20938170, 20951038 -20952966, 20958816, 20977794, 20978259, 21037905, 21037923, 21047766 -21047803, 21052842, 21059919, 21060755, 21061354, 21063322, 21068507 -21072646, 21080143, 21091431, 21091901, 21095391, 21097043, 21099555 -21101873, 21106027, 21132297, 21133343, 21142837, 21147908, 21153266 -21157728, 21159665, 21164318, 21171382, 21172913, 21174504, 21184223 -21186167, 21188532, 21188537, 21188584, 21196809, 21197626, 21220620 -21225209, 21239530, 21241052, 21241829, 21246723, 21260397, 21260431 -21263635, 21266085, 21270823, 21273804, 21275255, 21281532, 21281607 -21285458, 21291274, 21293600, 21294938, 21296029, 21297872, 21299490 -21300341, 21308727, 21315084, 21322887, 21329301, 21354456, 21373076 -21373473, 21380789, 21383171, 21385422, 21387128, 21387964, 21419850 -21421886, 21422580, 21424824, 21425496, 21429602, 21442094, 21450666 -21476308, 21479753, 21492036, 21502702, 21514877, 21516611, 21517440 -21522582, 21526048, 21532755, 21534893, 21542577, 21555660, 21560152 -21566639, 21566944, 21566993, 21575362, 21612959, 21620471, 21623164 -21625179, 21626377, 21629064, 21632821, 21641414, 21641760, 21644640 -21649497, 21656630, 21659726, 21665897, 21668627, 21675340, 21695575 -21698350, 21744290, 21756661, 21756677, 21756699, 21764119, 21773465 -21780146, 21785691, 21787056, 21794615, 21795111, 21797203, 21811517 -21820934, 21821302, 21828126, 21834568, 21837606, 21842017, 21842740 -21847223, 21856522, 21863727, 21868720, 21875360, 21889720, 21893235 -21896069, 21899588, 21911701, 21913183, 21915719, 21917884, 21924131 -21960504, 21967197, 21977186, 21977392, 22007324, 22018363, 22022760 -22024071, 22037014, 22046677, 22062026, 22062517, 22068305, 22070866 -22072818, 22075064, 22077517, 22083366, 22087683, 22092979, 22118835 -22118851, 22139226, 22146062, 22148226, 22157363, 22160989, 22165897 -22168163, 22173980, 22175564, 22176950, 22178855, 22179537, 22185234 -22205263, 22214989, 22223463, 22228324, 22232606, 22233505, 22238921 -22243719, 22243983, 22250006, 22256431, 22256560, 22258530, 22261050 -22264489, 22268833, 22282748, 22294260, 22296366, 22301880, 22305887 -22346829, 22347493, 22351572, 22353199, 22353346, 22359063, 22364044 -22365117, 22366322, 22366558, 22374754, 22380919, 22454326, 22454940 -22458049, 22465352, 22468255, 22468781, 22475617, 22492533, 22495062 -22495673, 22496904, 22499356, 22501616, 22503297, 22507210, 22507234 -22515353, 22517782, 22518784, 22519146, 22520320, 22528741, 22529728 -22533631, 22536802, 22551446, 22568016, 22568177, 22568797, 22606521 -22624709, 22645009, 22654475, 22657942, 22662332, 22670385, 22670413 -22674709, 22675136, 22686674, 22690648, 22695831, 22707244, 22707866 -22721409, 22729345, 22730454, 22733141, 22734547, 22750215, 22757364 -22760595, 22760679, 22762046, 22782647, 22806698, 22808310, 22809871 -22815955, 22816287, 22820579, 22820798, 22826718, 22836801, 22842151 -22855193, 22862134, 22865673, 22873635, 22894101, 22894949, 22897344 -22901797, 22905130, 22916353, 22922076, 22923409, 22950945, 22961508 -22972770, 22977256, 23002524, 23003979, 23007241, 23008056, 23019710 -23020270, 23025340, 23026585, 23028781, 23029562, 23035249, 23053606 -23061453, 23061702, 23065323, 23066146, 23068169, 23080557, 23082876 -23084507, 23088803, 23089357, 23096938, 23101501, 23104033, 23105538 -23108128, 23115139, 23124895, 23125826, 23126410, 23140259, 23148260 -23149541, 23151677, 23168363, 23170620, 23172924, 23177536, 23177923 -23184013, 23184263, 23195445, 23197103, 23209741, 23220453, 23229229 -23237313, 23240358, 23260854, 23262847, 23265914, 23265965, 23266217 -23272045, 23294548, 23302839, 23314180, 23315153, 23315889, 23324000 -23326313, 23328639, 23338911, 23342170, 23492665, 23501901, 23514710 -23514911, 23521523, 23528412, 23533524, 23533807, 23543183, 23548817 -23567857, 23571055, 23572982, 23584909, 23602213, 23614158, 23628685 -23642282, 23709062, 23711335, 23713236, 23717151, 23725036, 23727148 -23731896, 23746128, 23854396, 24285405, 24300640, 24303148, 24307571 -24308635, 24315824, 24316947, 24321547, 24326444, 24341675, 24350620 -24350831, 24365589, 24385625, 24385983, 24386767, 24393981, 24397438 -24401351, 24411921, 24413809, 24415926, 24416451, 24421668, 24423416 -24425998, 24437510, 24448240, 24448282, 24457597, 24461826, 24509056 -24523374, 24530364, 24534298, 24555417, 24560906, 24563422, 24570598 -24573817, 24577566, 24589081, 24597536, 24600330, 24624166, 24642295 -24642495, 24652769, 24662775, 24674955, 24683149, 24690216, 24693382 -24701840, 24713381, 24717859, 24718260, 24719736, 24737064, 24737403 -24737581, 24737954, 24739928, 24752618, 24766121, 24784414, 24790914 -24792678, 24796092, 24801152, 24802934, 24808595, 24812585, 24817447 -24825843, 24831514, 24835538, 24835919, 24848928, 24907917, 24908321 -24917972, 24920582, 24929210, 24966594, 25029423, 25031502, 25034396 -25042823, 25047724, 25051465, 25056052, 25058080, 25060506, 25067795 -25076732, 25076756, 25077278, 25079710, 25091141, 25093739, 25093872 -25099339, 25107334, 25110233, 25115178, 25123585, 25150925, 25161298 -25165496, 25178179, 25179774, 25192729, 25205368, 25210690, 25240188 -25248384, 25264559, 25300427, 25307368, 25313154, 25328093, 25330273 -25353983, 25357142, 25377044, 25392535, 25405687, 25415713, 25417056 -25417958, 25423453, 25427662, 25429959, 25437695, 25437699, 25459958 -25472885, 25475853, 25476125, 25477657, 25482971, 25483815, 25484507 -25486384, 25489342, 25489367, 25489607, 25490238, 25492379, 25494379 -25494413, 25495682, 25539063, 25546608, 25547060, 25551676, 25555252 -25575628, 25579761, 25599425, 25600342, 25600421, 25602488, 25606091 -25612095, 25616268, 25633101, 25634317, 25635149, 25639019, 25643818 -25643931, 25649873, 25653109, 25654936, 25655390, 25669791, 25670786 -25695903, 25699321, 25722055, 25733479, 25740844, 25743479, 25760195 -25764020, 25766822, 25775213, 25780343, 25789277, 25790353, 25809524 -25822410, 25823532, 25823754, 25856821, 25861398, 25879984, 25881255 -25885148, 25890782, 25897615, 25904490, 25914276, 25919622, 25947799 -25957038, 25982666, 25986062, 25997810, 26007010, 26023002, 26023025 -26024732, 26027162, 26029780, 26039623, 26088426, 26089440, 26110259 -26110632, 26111842, 26121990, 26126424, 26153977, 26169341, 26187943 -26198757, 26198926, 26203182, 26243698, 26245237, 26248143, 26256131 -26262953, 26263721, 26318200, 26318627, 26324206, 26325856, 26336977 -26353617, 26366517, 26412540, 26430737, 26439748, 26444887, 26446098 -26482376, 26513067, 26513709, 26544823, 26546664, 26546754, 26556014 -26569225, 26570171, 26575788, 26633558, 26635845, 26637592, 26637824 -26654363, 26658759, 26714910, 26716835, 26729494, 26758193, 26768025 -26784509, 26822620, 26828994, 26832296, 26844406, 26875822, 26898563 -26968670, 26999139, 27000663, 27000690, 27001733, 27012701, 27015449 -27033652, 27034890, 27052607, 27060167, 27072923, 27086138, 27092508 -27097854, 27101105, 27122162, 27133662, 27169796, 27185188, 27199245 -27207110, 27207634, 27213224, 27217412, 27223075, 27229389, 27255377 -27274536, 27276231, 27285244, 27303938, 27314206, 27314390, 27314697 -27337759, 27348081, 27351628, 27370965, 27375542, 27397048, 27404573 -27424405, 27433385, 27434193, 27441326, 27445727, 27452046, 27461789 -27461842, 27468303, 27475603, 27487919, 27534509, 27548131, 27565906 -27567477, 27611612, 27620950, 27623159, 27629756, 27634991, 27642235 -27710072, 27726780, 27729678, 27745728, 27751755, 27829295, 27846298 -27847259, 27897759, 27923320, 27929509, 27938623, 27952577, 27952584 -27986817, 27995248, 27997875, 28000269, 28022101, 28023399, 28023482 -28024793, 28025414, 28026866, 28043157, 28072383, 28079127, 28098160 -28125601, 28164480, 28174827, 28199085, 28215510, 28250929, 28281094 -28302049, 28305362, 28357401, 28369092, 28371123, 28384353, 28390273 -28394726, 28420042, 28423598, 28432129, 28440711, 28501075, 28502113 -28502128, 28507324, 28542455, 28566241, 28578164, 28587723, 28612674 -28636676, 28639299, 28683167, 28708023, 28714988, 28730253, 28758090 -28774416, 28790654, 28797711, 28821847, 28849751, 28852325, 28867992 -28891741, 28891984, 28915933, 28950969, 28986231, 28993590, 29006527 -29009513, 29027694, 29030780, 29061016, 29142109, 29163567, 29170232 -29189889, 29200700, 29247712, 29250317, 29251241, 29254615, 29260956 -29342099, 29343156, 29372460, 29378913, 29379978, 29388020, 29408136 -29434301, 29437712, 29464779, 29477015, 29483626, 29483672, 29483723 -29483771, 29500257, 29500963, 29511611, 29559723, 29621961, 29625065 -29633753, 29637560, 29645349, 29707896, 29719146, 29726695, 29774367 -29774383, 29782211, 29791152, 29796916, 29814995, 29817278, 29828111 -29869404, 29869906, 29884958, 29893132, 29944660, 29961353, 29962927 -29962939, 29965888, 29997937, 30018017, 30031027, 30116203, 30117469 -30128197, 30160639, 30164714, 30179644, 30186245, 30196358, 30200680 -30215130, 30218044, 30225443, 30252098, 30295478, 30305880, 30320029 -30365745, 30387666, 30421204, 30497057, 30499600, 30502041, 30517516 -30522998, 30534664, 30578221, 30624864, 30659882, 30668407, 30698289 -30758943, 30803210, 30805558, 30816938, 30826474, 30855121, 30860803 -30866988, 30889351, 30973003, 30987088, 31001455, 31013127, 31022858 -31028986, 31031715, 31046619, 31106577, 31156383, 31172207, 31194264 -31219939, 31228670, 31306274, 31335037, 31335142, 31501139, 31637680 -31668061, 31668867, 31668915, 31675539, 31711889, 31786838, 31799139 -31927930, 31985579, 32065792, 32097882, 32119956, 32165915, 32186646 -32296941 -``` - -### Version 12\.1\.0\.2\.v22 - -Version 12\.1\.0\.2\.v22 includes the following: -+ Patch 31550110: Database Patch Set Update : 12\.1\.0\.2\.201020 \(31550110\) -+ Patch 31668915: Database PSU 12\.1\.0\.2\.201020, Oracle JavaVM Component \(OCT2020\) -+ Patch 31335037: RDBMS \- DSTV35 UPDATE \- TZDATA2020A -+ Patch 31335142: DSTV35 UPDATE \- TZDATA2020A \- NEED OJVM FIX -+ Patch 17969866: Oracle GoldenGate – 46719 ENH REPLICATION SUPPORT FOR INSERTS / FULL UPDATES WITH LARGE VALUES -+ Patch 20394750: Oracle GoldenGate – APPLY CDR RESOLUTION FAILING FOR LOBS, XML, LONG, AND OBJECTS -+ Patch 24835919: Oracle GoldenGate – IR EXECUTING DEPENDENT TRANSACTIONS OUT OF ORDER WITH PARALLELISM GREATER THAN -+ Patch 23262847: Oracle GoldenGate \- MALFORMED REDO CAUSED OGG REPLICATION ABEND -+ Patch 21091901: ONLINE MOVE OF HASH OR REF PARTITION CAN LEAVE LOCAL INDEXES INCONSISTENT -+ Patch 21171382: ADD CONTROL FOR AUTOMATIC CREATION OF STATS EXTENSIONS -+ Patch 23711335: CDB\_UPG PDCDB CDB UPGRADE AS WHOLE TAKES 1 MORE HOUR THAN PREVIOUS LABELS IN MAY -+ Patch 25031502: MV QUERY REWRITE WORKLOAD HIT ORA 600 \[KGL\-HEAP\-SIZE\-EXCEEDED\] -+ Patch 31911280: JSON Bundle Patch -+ PreUpgrade Jar: preupgrade\_12\.1\.0\.2\.0\_18\_crlf\.zip -+ Support for [Setting and unsetting system diagnostic events](Appendix.Oracle.CommonDBATasks.System.md#Appendix.Oracle.CommonDBATasks.SystemEvents) using procedures in the `rdsadmin.rdsadmin_util` package -+ Support for the procedure `rdsadmin_util.truncate_apply$_cdr_info` described in [Integrated REPLICAT slow due to query on sys\."\_DBA\_APPLY\_CDR\_INFO"](Appendix.OracleGoldenGate.md#Appendix.OracleGoldenGate.IR) - -#### Combined patches for version 12\.1\.0\.2\.v22, released October 2020 - -Bugs fixed: - -``` -6194865, 6418158, 6599380, 13542050, 13787015, 13854364, 14283239 -14643995, 14705949, 16090440, 16354467, 16359751, 16439813, 16619249 -16756406, 16777441, 16799735, 16863642, 16870214, 16875041, 16887946 -16923858, 16938780, 16941434, 17008068, 17210525, 17258582, 17274537 -17319928, 17365043, 17409174, 17414008, 17432124, 17495022, 17532729 -17532734, 17533661, 17551063, 17655240, 17722075, 17760068, 17835294 -17867700, 17890099, 17969866, 18007682, 18043064, 18051556, 18090142 -18110491, 18122373, 18191823, 18202441, 18250893, 18254023, 18272672 -18288842, 18306996, 18307021, 18308268, 18324100, 18354830, 18371441 -18373438, 18382302, 18411216, 18417036, 18419520, 18427406, 18436647 -18440095, 18456643, 18475439, 18492302, 18499088, 18510194, 18542562 -18548246, 18548433, 18549238, 18604493, 18604692, 18607546, 18610915 -18618122, 18628388, 18648816, 18662619, 18673090, 18674024, 18674047 -18681056, 18693124, 18700762, 18705806, 18727933, 18733351, 18740837 -18742258, 18743542, 18758877, 18759211, 18774543, 18775971, 18778801 -18791688, 18797519, 18798250, 18799063, 18799993, 18801391, 18803726 -18810904, 18818069, 18819908, 18840932, 18841764, 18845653, 18849537 -18849970, 18851894, 18856106, 18856999, 18866977, 18868646, 18885870 -18886413, 18893947, 18895170, 18899974, 18900107, 18904062, 18909599 -18913440, 18914624, 18921743, 18940497, 18948177, 18952766, 18952989 -18964939, 18964978, 18966843, 18967382, 18973548, 18974476, 18988834 -18990023, 18990693, 18999568, 19001359, 19001390, 19012119, 19013183 -19016730, 19017309, 19018206, 19018447, 19022470, 19023822, 19024808 -19028800, 19032777, 19035573, 19044962, 19048007, 19050649, 19052488 -19054077, 19058490, 19060015, 19065556, 19065677, 19067244, 19068380 -19068610, 19068970, 19074147, 19075256, 19076343, 19077215, 19079752 -19081128, 19124336, 19124589, 19130152, 19131386, 19131607, 19134173 -19141838, 19143550, 19146474, 19149990, 19153980, 19154375, 19155797 -19157754, 19165673, 19168167, 19171086, 19174430, 19174521, 19174942 -19176223, 19176326, 19176885, 19178851, 19180394, 19180770, 19183343 -19185876, 19188385, 19188927, 19189317, 19189525, 19195895, 19197175 -19201867, 19207117, 19211433, 19213447, 19223010, 19231857, 19238590 -19243521, 19245191, 19248279, 19248799, 19258504, 19272708, 19279273 -19280225, 19284031, 19285025, 19289642, 19291380, 19297917, 19303936 -19304354, 19306797, 19307662, 19308965, 19309466, 19313563, 19315668 -19315691, 19317646, 19326908, 19327391, 19329654, 19330795, 19332396 -19333670, 19335438, 19339555, 19347458, 19354335, 19354794, 19358317 -19363645, 19364502, 19366375, 19370504, 19371175, 19373893, 19375649 -19382851, 19383839, 19385656, 19390567, 19390620, 19393542, 19396455 -19399918, 19402853, 19404068, 19409212, 19430401, 19433930, 19434529 -19439759, 19440520, 19440586, 19445860, 19448499, 19450116, 19450314 -19452434, 19461270, 19461428, 19468347, 19468612, 19468991, 19469538 -19475971, 19487147, 19490948, 19501299, 19503821, 19512341, 19516448 -19518079, 19520602, 19523462, 19524158, 19524384, 19529868, 19532017 -19534363, 19536415, 19543384, 19547370, 19547774, 19548064, 19550902 -19561643, 19562381, 19566592, 19571055, 19571082, 19571367, 19577410 -19578247, 19578350, 19583624, 19587324, 19590877, 19591608, 19593445 -19597439, 19597583, 19601762, 19604659, 19606174, 19617921, 19619732 -19623450, 19627012, 19632912, 19637186, 19639483, 19644859, 19647503 -19649152, 19658708, 19662635, 19663176, 19670108, 19676012, 19676905 -19680796, 19684504, 19687159, 19689979, 19693090, 19699191, 19699946 -19701015, 19703301, 19705781, 19706965, 19708342, 19708632, 19718981 -19721304, 19723336, 19730508, 19769480, 19769625, 19777862, 19781326 -19784751, 19790243, 19791273, 19791377, 19799847, 19805359, 19809171 -19811709, 19817386, 19818513, 19824871, 19831647, 19835133, 19841800 -19855285, 19859472, 19865345, 19869255, 19871910, 19873610, 19877336 -19879746, 19880190, 19883092, 19886165, 19888853, 19889230, 19891090 -19895326, 19895362, 19896336, 19902195, 19908836, 19909862, 19915271 -19928926, 19930276, 19931367, 19931709, 19932634, 19933147, 19941352 -19943771, 19952975, 19957298, 19978542, 19982584, 19988852, 19989009 -19990037, 19995869, 20001168, 20001466, 20009569, 20009833, 20011515 -20011646, 20011897, 20017509, 20023340, 20031873, 20043616, 20048359 -20052269, 20061399, 20074391, 20076781, 20078186, 20087383, 20093776 -20101006, 20117253, 20118035, 20122715, 20124446, 20134113, 20134339 -20139391, 20144019, 20144308, 20165574, 20169408, 20171986, 20172151 -20173897, 20175161, 20181030, 20212067, 20217801, 20228093, 20229001 -20233181, 20235511, 20245930, 20250147, 20267166, 20273319, 20281121 -20284155, 20294666, 20296619, 20298413, 20302006, 20308798, 20315311 -20318889, 20322560, 20324049, 20328248, 20331945, 20347562, 20348653 -20354900, 20356733, 20361671, 20368850, 20373598, 20374572, 20378086 -20382309, 20387265, 20394750, 20397490, 20401975, 20402832, 20408829 -20408866, 20413820, 20415564, 20424183, 20424899, 20425790, 20428621 -20432873, 20437153, 20440930, 20441797, 20446883, 20447445, 20459944 -20464614, 20466322, 20466628, 20468401, 20468490, 20470877, 20471920 -20474192, 20475845, 20476175, 20480209, 20493163, 20505778, 20509482 -20513399, 20524085, 20528052, 20539050, 20543011, 20544065, 20554364 -20557786, 20558005, 20560611, 20562898, 20564072, 20565112, 20565133 -20569094, 20577490, 20581111, 20582405, 20588486, 20588502, 20591183 -20596234, 20598042, 20603378, 20603431, 20613079, 20618595, 20627866 -20635353, 20641666, 20657411, 20657441, 20669434, 20671094, 20673810 -20677396, 20677974, 20684983, 20686773, 20688221, 20703000, 20703629 -20704450, 20705577, 20707932, 20708701, 20711718, 20717081, 20717091 -20717359, 20725343, 20734332, 20736227, 20746251, 20757079, 20764012 -20766180, 20768076, 20778986, 20794034, 20798891, 20800890, 20801783 -20803014, 20825533, 20828947, 20830459, 20831538, 20832516, 20835241 -20839705, 20842388, 20844426, 20848335, 20856766, 20859910, 20860659 -20862087, 20868862, 20869721, 20875898, 20877664, 20878790, 20879709 -20879889, 20880215, 20882568, 20890311, 20897759, 20898391, 20898997 -20899461, 20904530, 20907061, 20914870, 20919320, 20920911, 20922010 -20925795, 20926021, 20929771, 20936731, 20936905, 20938170, 20951038 -20952966, 20958816, 20977794, 20978259, 21037905, 21037923, 21047766 -21047803, 21052842, 21059919, 21060755, 21061354, 21063322, 21068507 -21072646, 21080143, 21091431, 21091901, 21095391, 21097043, 21099555 -21101873, 21106027, 21132297, 21133343, 21142837, 21147908, 21153266 -21157728, 21159665, 21164318, 21171382, 21172913, 21174504, 21184223 -21186167, 21188532, 21188537, 21188584, 21196809, 21197626, 21220620 -21225209, 21239530, 21241052, 21241829, 21246723, 21260397, 21260431 -21263635, 21266085, 21270823, 21273804, 21275255, 21281532, 21281607 -21285458, 21291274, 21293600, 21294938, 21296029, 21297872, 21299490 -21300341, 21308727, 21315084, 21322887, 21329301, 21354456, 21373076 -21373473, 21380789, 21383171, 21385422, 21387128, 21387964, 21419850 -21421886, 21422580, 21424824, 21425496, 21429602, 21442094, 21450666 -21476308, 21479753, 21492036, 21502702, 21514877, 21516611, 21517440 -21522582, 21526048, 21532755, 21534893, 21542577, 21555660, 21560152 -21566639, 21566944, 21566993, 21575362, 21612959, 21620471, 21623164 -21625179, 21626377, 21629064, 21632821, 21641414, 21641760, 21644640 -21649497, 21656630, 21659726, 21665897, 21668627, 21675340, 21695575 -21698350, 21744290, 21756661, 21756677, 21756699, 21764119, 21773465 -21780146, 21785691, 21787056, 21794615, 21795111, 21797203, 21811517 -21820934, 21821302, 21828126, 21837606, 21842017, 21842740, 21847223 -21856522, 21863727, 21868720, 21875360, 21889720, 21893235, 21896069 -21899588, 21911701, 21913183, 21915719, 21917884, 21924131, 21960504 -21967197, 21977186, 21977392, 22007324, 22018363, 22022760, 22024071 -22037014, 22046677, 22062026, 22062517, 22068305, 22070866, 22072818 -22075064, 22077517, 22083366, 22087683, 22092979, 22118835, 22118851 -22139226, 22146062, 22148226, 22157363, 22160989, 22165897, 22168163 -22173980, 22175564, 22176950, 22178855, 22179537, 22185234, 22205263 -22214989, 22223463, 22228324, 22232606, 22233505, 22238921, 22243719 -22243983, 22250006, 22256431, 22256560, 22258530, 22261050, 22264489 -22268833, 22282748, 22294260, 22296366, 22301880, 22305887, 22346829 -22347493, 22351572, 22353199, 22353346, 22359063, 22364044, 22365117 -22366322, 22366558, 22374754, 22380919, 22454326, 22454940, 22458049 -22465352, 22468255, 22468781, 22475617, 22492533, 22495062, 22495673 -22496904, 22499356, 22501616, 22503297, 22507210, 22507234, 22515353 -22517782, 22518784, 22519146, 22520320, 22528741, 22529728, 22533631 -22536802, 22551446, 22568016, 22568177, 22568797, 22606521, 22624709 -22645009, 22654475, 22657942, 22670385, 22670413, 22674709, 22675136 -22686674, 22690648, 22695831, 22707244, 22707866, 22721409, 22729345 -22730454, 22733141, 22734547, 22750215, 22757364, 22760595, 22760679 -22762046, 22782647, 22806698, 22808310, 22809871, 22815955, 22816287 -22820579, 22826718, 22836801, 22842151, 22855193, 22862134, 22865673 -22873635, 22894101, 22894949, 22897344, 22901797, 22905130, 22916353 -22922076, 22923409, 22950945, 22961508, 22972770, 22977256, 23002524 -23003979, 23007241, 23008056, 23019710, 23020270, 23025340, 23026585 -23028781, 23029562, 23035249, 23053606, 23061453, 23061702, 23065323 -23066146, 23068169, 23080557, 23082876, 23084507, 23088803, 23089357 -23096938, 23101501, 23104033, 23105538, 23108128, 23115139, 23124895 -23125826, 23126410, 23140259, 23148260, 23149541, 23151677, 23168363 -23170620, 23172924, 23177536, 23177923, 23184013, 23184263, 23195445 -23197103, 23209741, 23220453, 23229229, 23237313, 23240358, 23260854 -23262847, 23265914, 23265965, 23266217, 23272045, 23294548, 23302839 -23314180, 23315153, 23315889, 23324000, 23326313, 23328639, 23338911 -23342170, 23492665, 23501901, 23514710, 23514911, 23521523, 23528412 -23533524, 23533807, 23543183, 23548817, 23567857, 23571055, 23572982 -23584909, 23602213, 23614158, 23628685, 23642282, 23709062, 23711335 -23713236, 23717151, 23725036, 23727148, 23731896, 23746128, 23854396 -24285405, 24300640, 24303148, 24307571, 24308635, 24315824, 24316947 -24321547, 24326444, 24341675, 24350620, 24350831, 24365589, 24385625 -24385983, 24386767, 24393981, 24397438, 24401351, 24411921, 24413809 -24415926, 24416451, 24421668, 24423416, 24425998, 24437510, 24448240 -24448282, 24457597, 24461826, 24509056, 24523374, 24530364, 24534298 -24555417, 24560906, 24563422, 24570598, 24573817, 24577566, 24589081 -24600330, 24624166, 24642295, 24642495, 24652769, 24662775, 24674955 -24683149, 24690216, 24693382, 24701840, 24713381, 24717859, 24718260 -24719736, 24737064, 24737403, 24737581, 24737954, 24739928, 24752618 -24766121, 24790914, 24792678, 24796092, 24801152, 24802934, 24808595 -24812585, 24817447, 24825843, 24831514, 24835538, 24835919, 24848928 -24907917, 24908321, 24917972, 24920582, 24929210, 24966594, 25029423 -25031502, 25034396, 25042823, 25047724, 25051465, 25056052, 25058080 -25060506, 25067795, 25076732, 25076756, 25079710, 25091141, 25093739 -25093872, 25099339, 25107334, 25110233, 25115178, 25123585, 25150925 -25161298, 25165496, 25178179, 25179774, 25192729, 25205368, 25210690 -25240188, 25248384, 25264559, 25300427, 25307368, 25313154, 25328093 -25330273, 25353983, 25357142, 25377044, 25392535, 25405687, 25415713 -25417056, 25417958, 25423453, 25427662, 25429959, 25437695, 25437699 -25459958, 25472885, 25475853, 25476125, 25477657, 25482971, 25483815 -25484507, 25486384, 25489342, 25489367, 25489607, 25490238, 25492379 -25494379, 25494413, 25495682, 25539063, 25546608, 25547060, 25551676 -25555252, 25575628, 25579761, 25599425, 25600342, 25600421, 25602488 -25606091, 25612095, 25616268, 25633101, 25634317, 25635149, 25639019 -25643818, 25643931, 25649873, 25653109, 25654936, 25655390, 25669791 -25670786, 25695903, 25699321, 25722055, 25733479, 25740844, 25743479 -25760195, 25764020, 25766822, 25775213, 25780343, 25789277, 25790353 -25809524, 25822410, 25823532, 25823754, 25856821, 25861398, 25879984 -25881255, 25885148, 25890782, 25897615, 25904490, 25914276, 25919622 -25947799, 25957038, 25982666, 25986062, 25997810, 26007010, 26023002 -26023025, 26024732, 26027162, 26029780, 26039623, 26088426, 26089440 -26110259, 26110632, 26111842, 26121990, 26153977, 26169341, 26187943 -26198757, 26198926, 26203182, 26243698, 26245237, 26248143, 26256131 -26262953, 26263721, 26318200, 26318627, 26324206, 26325856, 26336977 -26353617, 26366517, 26412540, 26430737, 26439748, 26444887, 26446098 -26482376, 26513067, 26513709, 26544823, 26546664, 26546754, 26556014 -26569225, 26570171, 26575788, 26633558, 26635845, 26637592, 26637824 -26654363, 26658759, 26714910, 26716835, 26758193, 26768025, 26784509 -26822620, 26828994, 26832296, 26844406, 26875822, 26898563, 26968670 -26999139, 27000663, 27000690, 27001733, 27012701, 27015449, 27033652 -27034890, 27052607, 27060167, 27072923, 27086138, 27092508, 27097854 -27101105, 27122162, 27133662, 27169796, 27199245, 27207110, 27207634 -27213224, 27217412, 27223075, 27229389, 27255377, 27274536, 27276231 -27285244, 27303938, 27314206, 27314390, 27314697, 27337759, 27348081 -27351628, 27370965, 27375542, 27397048, 27404573, 27424405, 27433385 -27434193, 27441326, 27445727, 27452046, 27461789, 27461842, 27468303 -27475603, 27487919, 27534509, 27548131, 27565906, 27567477, 27611612 -27620950, 27623159, 27629756, 27634991, 27642235, 27710072, 27726780 -27729678, 27745728, 27751755, 27829295, 27846298, 27847259, 27897759 -27923320, 27929509, 27938623, 27952577, 27952584, 27986817, 27995248 -27997875, 28000269, 28022101, 28023399, 28024793, 28025414, 28026866 -28043157, 28072383, 28079127, 28098160, 28125601, 28164480, 28174827 -28199085, 28215510, 28250929, 28281094, 28302049, 28305362, 28357401 -28369092, 28371123, 28384353, 28390273, 28394726, 28420042, 28423598 -28432129, 28440711, 28501075, 28502113, 28502128, 28507324, 28542455 -28566241, 28578164, 28587723, 28612674, 28636676, 28639299, 28683167 -28708023, 28714988, 28730253, 28758090, 28774416, 28790654, 28797711 -28821847, 28849751, 28852325, 28867992, 28891741, 28891984, 28915933 -28950969, 28986231, 28993590, 29006527, 29009513, 29027694, 29030780 -29142109, 29163567, 29189889, 29200700, 29247712, 29250317, 29251241 -29254615, 29260956, 29343156, 29372460, 29378913, 29379978, 29388020 -29408136, 29434301, 29437712, 29464779, 29483626, 29483672, 29483723 -29483771, 29500257, 29500963, 29511611, 29559723, 29621961, 29633753 -29637560, 29645349, 29707896, 29719146, 29726695, 29774367, 29774383 -29782211, 29791152, 29817278, 29828111, 29869404, 29869906, 29893132 -29944660, 29961353, 29962927, 29962939, 29965888, 29997937, 30018017 -30116203, 30128197, 30160639, 30164714, 30179644, 30196358, 30200680 -30215130, 30218044, 30225443, 30252098, 30295478, 30305880, 30320029 -30365745, 30387666, 30421204, 30497057, 30499600, 30502041, 30517516 -30522998, 30534664, 30578221, 30624864, 30659882, 30668407, 30698289 -30758943, 30803210, 30805558, 30816938, 30855121, 30889351, 30973003 -30987088, 31001455, 31013127, 31022858, 31028986, 31031715, 31106577 -31156383, 31172207, 31194264, 31219939, 31228670, 31306274, 31335037 -31335142, 31550110, 31668061, 31668867, 31668915, 31799139 -``` - -### Version 12\.1\.0\.2\.v21 - -Version 12\.1\.0\.2\.v21 includes the following: -+ Patch 31113348: Database Patch Set Update 12\.1\.0\.2\.200714 -+ Patch 31219939: Database PSU 12\.1\.0\.2\.200714, Oracle JavaVM Component \(JUL2020\) -+ Patch 31335037: DSTV35 for RDBMS \(TZDATA2020A\) -+ Patch 31335142: DSTV35 for OJVM \(TZDATA2020A\) -+ Patch 17969866: Oracle GoldenGate \- 46719: ENH: REPLICATION SUPPORT FOR INSERTS / FULL UPDATES WITH LARGE VALUES -+ Patch 20394750: Oracle GoldenGate \- APPLY CDR RESOLUTION FAILING FOR LOBS, XML, LONG, AND OBJECTS -+ Patch 24835919: Oracle GoldenGate \- IR EXECUTING DEPENDENT TRANSACTIONS OUT OF ORDER WITH PARALLELISM GREATER THAN -+ Patch 20033733: PART :IMC:HIT ORA 600 \[KGL\-HEAP\-SIZE\-EXCEEDED\] -+ Patch 28730253: SUPPORT NEW ERA REIWA FOR JAPANESE IMPERIAL CALENDAR -+ Patch 23711335: CDB\_UPG:PDCDB:CDB UPGRADE AS WHOLE TAKES 1 MORE HOUR THAN PREVIOUS LABELS IN MAY -+ Patch 31579750: JSON bundle Patch -+ Patch 21091901: ONLINE MOVE OF HASH OR REF PARTITION CAN LEAVE LOCAL INDEXES INCONSISTENT -+ Patch 21171382: DBMS\_STATS Patch AUTO DOP COMPUTES A HIGH DOP UNNECESSARILY -+ Patch 23262847: Oracle GoldenGate \- MALFORMED REDO CAUSED OGG REPLICATION ABEND -+ PreUpgrade Jar: preupgrade\_12\.1\.0\.2\.0\_18\_crlf\.zip - -#### Combined patches for version 12\.1\.0\.2\.v21, released July 2020 - -Bugs fixed: - -``` -6194865, 6418158, 6599380, 13542050, 13787015, 14283239, 14643995 -14705949, 16090440, 16354467, 16359751, 16439813, 16619249, 16756406 -16777441, 16799735, 16863642, 16870214, 16875041, 16887946, 16923858 -16938780, 16941434, 17008068, 17210525, 17258582, 17274537, 17319928 -17365043, 17409174, 17414008, 17432124, 17495022, 17532729, 17532734 -17533661, 17551063, 17655240, 17722075, 17760068, 17835294, 17867700 -17890099, 17969866, 18007682, 18043064, 18051556, 18090142, 18110491 -18122373, 18191823, 18202441, 18250893, 18254023, 18272672, 18288842 -18306996, 18307021, 18308268, 18354830, 18371441, 18373438, 18382302 -18411216, 18417036, 18419520, 18436647, 18440095, 18456643, 18475439 -18492302, 18499088, 18510194, 18542562, 18548246, 18548433, 18549238 -18604493, 18604692, 18607546, 18610915, 18618122, 18628388, 18648816 -18662619, 18673090, 18674024, 18674047, 18681056, 18693124, 18700762 -18705806, 18727933, 18733351, 18740837, 18742258, 18743542, 18758877 -18759211, 18774543, 18775971, 18778801, 18791688, 18797519, 18798250 -18799063, 18799993, 18801391, 18803726, 18810904, 18818069, 18819908 -18840932, 18841764, 18845653, 18849537, 18849970, 18851894, 18856106 -18856999, 18866977, 18868646, 18885870, 18886413, 18893947, 18895170 -18899974, 18900107, 18904062, 18909599, 18913440, 18914624, 18921743 -18940497, 18948177, 18952766, 18952989, 18964939, 18964978, 18966843 -18967382, 18973548, 18974476, 18988834, 18990023, 18990693, 18999568 -19001359, 19001390, 19012119, 19013183, 19016730, 19017309, 19018206 -19018447, 19022470, 19023822, 19024808, 19028800, 19032777, 19035573 -19044962, 19048007, 19050649, 19052488, 19054077, 19058490, 19060015 -19065556, 19065677, 19067244, 19068380, 19068610, 19068970, 19074147 -19075256, 19076343, 19077215, 19079752, 19081128, 19124336, 19124589 -19130152, 19131386, 19131607, 19134173, 19141838, 19143550, 19146474 -19149990, 19153980, 19154375, 19155797, 19157754, 19165673, 19168167 -19171086, 19174430, 19174521, 19174942, 19176223, 19176326, 19176885 -19178851, 19180394, 19180770, 19183343, 19185876, 19188927, 19189317 -19189525, 19195895, 19197175, 19201867, 19207117, 19211433, 19213447 -19223010, 19231857, 19238590, 19243521, 19245191, 19248279, 19248799 -19258504, 19272708, 19279273, 19280225, 19284031, 19285025, 19289642 -19291380, 19297917, 19303936, 19304354, 19306797, 19307662, 19308965 -19309466, 19313563, 19315668, 19315691, 19317646, 19326908, 19327391 -19329654, 19330795, 19332396, 19333670, 19335438, 19339555, 19347458 -19354335, 19354794, 19358317, 19363645, 19364502, 19366375, 19370504 -19371175, 19373893, 19375649, 19382851, 19383839, 19385656, 19390567 -19390620, 19393542, 19396455, 19399918, 19402853, 19404068, 19409212 -19430401, 19433930, 19434529, 19439759, 19440520, 19440586, 19445860 -19448499, 19450116, 19450314, 19452434, 19461270, 19461428, 19468347 -19468612, 19468991, 19469538, 19475971, 19487147, 19490948, 19501299 -19503821, 19512341, 19516448, 19518079, 19520602, 19523462, 19524158 -19524384, 19529868, 19532017, 19534363, 19536415, 19543384, 19547370 -19547774, 19548064, 19550902, 19561643, 19562381, 19566592, 19571055 -19571082, 19571367, 19577410, 19578247, 19578350, 19583624, 19587324 -19590877, 19591608, 19593445, 19597439, 19597583, 19601762, 19604659 -19606174, 19617921, 19619732, 19623450, 19627012, 19632912, 19637186 -19639483, 19644859, 19647503, 19649152, 19658708, 19662635, 19663176 -19670108, 19676012, 19676905, 19680796, 19684504, 19687159, 19689979 -19693090, 19699191, 19699946, 19701015, 19703301, 19705781, 19706965 -19708342, 19708632, 19718981, 19721304, 19723336, 19730508, 19769480 -19769625, 19777862, 19781326, 19784751, 19790243, 19791273, 19791377 -19799847, 19805359, 19809171, 19811709, 19817386, 19818513, 19824871 -19831647, 19835133, 19841800, 19855285, 19859472, 19865345, 19869255 -19871910, 19873610, 19877336, 19879746, 19880190, 19883092, 19886165 -19888853, 19889230, 19891090, 19895326, 19895362, 19896336, 19902195 -19908836, 19909862, 19915271, 19928926, 19930276, 19931367, 19931709 -19932634, 19933147, 19941352, 19943771, 19952975, 19957298, 19978542 -19982584, 19988852, 19989009, 19990037, 19995869, 20001168, 20009569 -20009833, 20011515, 20011646, 20011897, 20017509, 20023340, 20031873 -20043616, 20048359, 20052269, 20061399, 20074391, 20076781, 20078186 -20087383, 20093776, 20101006, 20117253, 20118035, 20122715, 20124446 -20134113, 20134339, 20139391, 20144019, 20144308, 20165574, 20169408 -20171986, 20172151, 20173897, 20175161, 20181030, 20212067, 20217801 -20228093, 20229001, 20233181, 20235511, 20245930, 20250147, 20267166 -20273319, 20281121, 20284155, 20294666, 20296619, 20298413, 20302006 -20308798, 20315311, 20318889, 20322560, 20324049, 20328248, 20331945 -20347562, 20348653, 20354900, 20356733, 20361671, 20368850, 20373598 -20374572, 20378086, 20382309, 20387265, 20394750, 20397490, 20401975 -20402832, 20408829, 20408866, 20413820, 20415564, 20424183, 20424899 -20425790, 20428621, 20432873, 20437153, 20440930, 20441797, 20446883 -20447445, 20459944, 20464614, 20466322, 20466628, 20468401, 20468490 -20470877, 20471920, 20474192, 20475845, 20476175, 20480209, 20493163 -20505778, 20509482, 20513399, 20524085, 20528052, 20539050, 20543011 -20544065, 20554364, 20557786, 20558005, 20560611, 20562898, 20564072 -20565112, 20565133, 20569094, 20577490, 20581111, 20582405, 20588486 -20588502, 20591183, 20596234, 20598042, 20603378, 20603431, 20613079 -20618595, 20627866, 20635353, 20641666, 20657411, 20657441, 20669434 -20671094, 20673810, 20677396, 20677974, 20684983, 20686773, 20688221 -20703000, 20703629, 20704450, 20705577, 20707932, 20708701, 20711718 -20717081, 20717091, 20717359, 20725343, 20734332, 20736227, 20746251 -20757079, 20764012, 20766180, 20768076, 20778986, 20794034, 20798891 -20800890, 20801783, 20803014, 20825533, 20828947, 20830459, 20831538 -20832516, 20835241, 20839705, 20842388, 20844426, 20848335, 20856766 -20859910, 20860659, 20862087, 20868862, 20869721, 20875898, 20877664 -20878790, 20879709, 20879889, 20880215, 20882568, 20890311, 20897759 -20898391, 20898997, 20899461, 20904530, 20907061, 20914870, 20919320 -20920911, 20922010, 20925795, 20926021, 20929771, 20936731, 20936905 -20938170, 20951038, 20952966, 20958816, 20977794, 20978259, 21037923 -21047766, 21047803, 21052842, 21059919, 21060755, 21061354, 21063322 -21068507, 21072646, 21080143, 21091431, 21091901, 21095391, 21097043 -21099555, 21101873, 21106027, 21132297, 21133343, 21142837, 21147908 -21153266, 21157728, 21159665, 21164318, 21171382, 21172913, 21174504 -21184223, 21186167, 21188532, 21188537, 21188584, 21196809, 21197626 -21220620, 21225209, 21239530, 21241052, 21241829, 21246723, 21260397 -21260431, 21263635, 21266085, 21270823, 21273804, 21275255, 21281532 -21281607, 21285458, 21291274, 21293600, 21294938, 21296029, 21297872 -21299490, 21300341, 21308727, 21315084, 21322887, 21329301, 21354456 -21373076, 21373473, 21380789, 21383171, 21385422, 21387128, 21387964 -21419850, 21421886, 21422580, 21424824, 21425496, 21429602, 21442094 -21450666, 21476308, 21479753, 21492036, 21502702, 21514877, 21516611 -21517440, 21522582, 21526048, 21532755, 21534893, 21542577, 21555660 -21560152, 21566639, 21566944, 21566993, 21575362, 21620471, 21623164 -21625179, 21626377, 21629064, 21632821, 21641414, 21641760, 21644640 -21649497, 21656630, 21659726, 21665897, 21668627, 21675340, 21695575 -21698350, 21744290, 21756661, 21756677, 21756699, 21764119, 21773465 -21780146, 21785691, 21787056, 21794615, 21795111, 21811517, 21820934 -21821302, 21828126, 21837606, 21842017, 21842740, 21847223, 21856522 -21863727, 21868720, 21875360, 21889720, 21893235, 21896069, 21899588 -21911701, 21913183, 21915719, 21917884, 21924131, 21960504, 21967197 -21977186, 21977392, 22007324, 22018363, 22022760, 22024071, 22037014 -22046677, 22062026, 22062517, 22068305, 22070866, 22072818, 22075064 -22077517, 22083366, 22087683, 22092979, 22118835, 22118851, 22139226 -22146062, 22148226, 22160989, 22165897, 22168163, 22173980, 22175564 -22176950, 22178855, 22179537, 22185234, 22205263, 22214989, 22223463 -22228324, 22232606, 22233505, 22238921, 22243719, 22243983, 22250006 -22256431, 22256560, 22258530, 22264489, 22268833, 22282748, 22294260 -22296366, 22301880, 22305887, 22346829, 22347493, 22351572, 22353199 -22353346, 22359063, 22364044, 22365117, 22366322, 22366558, 22374754 -22380919, 22454326, 22458049, 22465352, 22468781, 22475617, 22492533 -22495062, 22495673, 22496904, 22499356, 22501616, 22503297, 22507210 -22507234, 22515353, 22517782, 22518784, 22519146, 22520320, 22528741 -22529728, 22533631, 22536802, 22551446, 22568016, 22568177, 22568797 -22606521, 22624709, 22645009, 22654475, 22657942, 22670385, 22670413 -22674709, 22675136, 22686674, 22690648, 22695831, 22707244, 22707866 -22721409, 22729345, 22730454, 22733141, 22734547, 22750215, 22757364 -22760595, 22760679, 22762046, 22782647, 22806698, 22808310, 22809871 -22815955, 22816287, 22820579, 22826718, 22836801, 22842151, 22855193 -22862134, 22865673, 22873635, 22894949, 22897344, 22901797, 22905130 -22916353, 22922076, 22923409, 22950945, 22961508, 22972770, 22977256 -23002524, 23003979, 23007241, 23008056, 23019710, 23020270, 23025340 -23026585, 23028781, 23029562, 23035249, 23053606, 23061453, 23061702 -23065323, 23066146, 23068169, 23080557, 23084507, 23088803, 23089357 -23096938, 23101501, 23104033, 23105538, 23108128, 23115139, 23124895 -23125826, 23126410, 23140259, 23148260, 23149541, 23151677, 23168363 -23170620, 23172924, 23177536, 23177923, 23184263, 23195445, 23197103 -23209741, 23220453, 23229229, 23237313, 23240358, 23260854, 23262847 -23265914, 23265965, 23266217, 23272045, 23294548, 23302839, 23314180 -23315153, 23315889, 23324000, 23326313, 23328639, 23338911, 23342170 -23492665, 23501901, 23514710, 23514911, 23521523, 23528412, 23533524 -23533807, 23543183, 23548817, 23567857, 23571055, 23572982, 23602213 -23614158, 23628685, 23642282, 23709062, 23711335, 23713236, 23717151 -23725036, 23727148, 23731896, 23746128, 23854396, 24285405, 24300640 -24303148, 24307571, 24308635, 24315824, 24316947, 24321547, 24326444 -24341675, 24350620, 24350831, 24365589, 24385625, 24385983, 24386767 -24393981, 24397438, 24401351, 24411921, 24413809, 24415926, 24416451 -24421668, 24423416, 24425998, 24437510, 24448240, 24448282, 24457597 -24461826, 24509056, 24523374, 24534298, 24555417, 24560906, 24563422 -24570598, 24573817, 24577566, 24589081, 24600330, 24624166, 24642295 -24652769, 24662775, 24674955, 24683149, 24690216, 24693382, 24701840 -24713381, 24717859, 24718260, 24719736, 24737064, 24737403, 24737581 -24737954, 24739928, 24752618, 24766121, 24790914, 24792678, 24796092 -24801152, 24802934, 24808595, 24812585, 24825843, 24831514, 24835538 -24835919, 24848928, 24907917, 24908321, 24917972, 24920582, 24929210 -24966594, 25029423, 25031502, 25034396, 25042823, 25047724, 25051465 -25056052, 25058080, 25060506, 25067795, 25076732, 25076756, 25079710 -25091141, 25093739, 25093872, 25099339, 25107334, 25110233, 25123585 -25150925, 25161298, 25165496, 25178179, 25192729, 25210690, 25240188 -25248384, 25264559, 25300427, 25307368, 25313154, 25328093, 25330273 -25353983, 25357142, 25377044, 25392535, 25405687, 25415713, 25417056 -25417958, 25423453, 25427662, 25429959, 25437695, 25437699, 25459958 -25472885, 25475853, 25476125, 25477657, 25482971, 25483815, 25484507 -25486384, 25489342, 25489367, 25489607, 25490238, 25492379, 25494379 -25494413, 25495682, 25539063, 25546608, 25547060, 25551676, 25555252 -25575628, 25579761, 25599425, 25600342, 25600421, 25602488, 25606091 -25612095, 25616268, 25633101, 25634317, 25635149, 25639019, 25643931 -25649873, 25653109, 25654936, 25655390, 25669791, 25670786, 25695903 -25699321, 25722055, 25733479, 25740844, 25743479, 25760195, 25764020 -25766822, 25775213, 25780343, 25789277, 25790353, 25809524, 25822410 -25823532, 25823754, 25856821, 25861398, 25879984, 25881255, 25885148 -25897615, 25914276, 25919622, 25947799, 25957038, 25982666, 25986062 -25997810, 26007010, 26023002, 26023025, 26024732, 26027162, 26029780 -26039623, 26088426, 26089440, 26110259, 26110632, 26111842, 26121990 -26153977, 26187943, 26198757, 26198926, 26203182, 26243698, 26245237 -26248143, 26256131, 26262953, 26263721, 26318627, 26324206, 26325856 -26336977, 26353617, 26366517, 26412540, 26430737, 26439748, 26444887 -26446098, 26482376, 26513067, 26513709, 26544823, 26546664, 26546754 -26556014, 26569225, 26570171, 26575788, 26633558, 26635845, 26637592 -26637824, 26654363, 26658759, 26714910, 26758193, 26768025, 26784509 -26822620, 26828994, 26832296, 26844406, 26875822, 26898563, 26968670 -26999139, 27000663, 27000690, 27001733, 27012701, 27015449, 27033652 -27034890, 27052607, 27060167, 27072923, 27086138, 27092508, 27097854 -27101105, 27122162, 27133662, 27169796, 27199245, 27207110, 27207634 -27213224, 27217412, 27223075, 27229389, 27255377, 27274536, 27276231 -27303938, 27314206, 27314390, 27314697, 27337759, 27348081, 27351628 -27370965, 27375542, 27397048, 27404573, 27424405, 27433385, 27441326 -27445727, 27461789, 27461842, 27468303, 27475603, 27487919, 27534509 -27548131, 27567477, 27611612, 27620950, 27623159, 27629756, 27634991 -27642235, 27710072, 27726780, 27751755, 27829295, 27846298, 27847259 -27897759, 27923320, 27929509, 27938623, 27952577, 27952584, 27986817 -27995248, 27997875, 28000269, 28022101, 28023399, 28024793, 28025414 -28026866, 28043157, 28079127, 28098160, 28125601, 28164480, 28174827 -28199085, 28215510, 28250929, 28281094, 28302049, 28305362, 28357401 -28369092, 28384353, 28390273, 28420042, 28423598, 28432129, 28440711 -28501075, 28502113, 28502128, 28507324, 28542455, 28566241, 28578164 -28587723, 28612674, 28636676, 28639299, 28683167, 28708023, 28714988 -28730253, 28758090, 28774416, 28790654, 28797711, 28821847, 28849751 -28852325, 28867992, 28891741, 28915933, 28950969, 28986231, 28993590 -29006527, 29009513, 29027694, 29030780, 29142109, 29163567, 29189889 -29200700, 29247712, 29250317, 29251241, 29254615, 29260956, 29343156 -29372460, 29378913, 29379978, 29388020, 29408136, 29434301, 29437712 -29464779, 29483626, 29483672, 29483723, 29483771, 29500257, 29500963 -29511611, 29559723, 29621961, 29633753, 29637560, 29645349, 29707896 -29719146, 29726695, 29774367, 29774383, 29782211, 29791152, 29817278 -29828111, 29869404, 29869906, 29893132, 29944660, 29961353, 29962927 -29962939, 29997937, 30116203, 30128197, 30160639, 30164714, 30179644 -30200680, 30215130, 30218044, 30225443, 30252098, 30295478, 30305880 -30365745, 30497057, 30499600, 30502041, 30522998, 30534664, 30624864 -30659882, 30668407, 30698289, 30758943, 30803210, 30805558, 30816938 -30855121, 30973003, 30987088, 31001455, 31013127, 31022858, 31031715 -31113348, 31156383, 31219939, 31306274, 31335037, 31335142 -``` - -### Version 12\.1\.0\.2\.v20 - -Version 12\.1\.0\.2\.v20 includes the following: -+ Patch 30700212: Database PSU 12\.1\.0\.2\.200414 -+ Patch 30805558: Oracle JVM Component Database PSU 12\.1\.0\.2\.200414 -+ Patch 29997937: DSTv34 for RDBMS \(TZDATA2019G\) -+ Patch 29997959: DSTv34 for OJVM \(TZDATA2019G\) -+ Patch 17969866: Oracle GoldenGate \- 46719: ENH: REPLICATION SUPPORT FOR INSERTS / FULL UPDATES WITH LARGE VALUES -+ Patch 20394750: Oracle GoldenGate \- APPLY CDR RESOLUTION FAILING FOR LOBS, XML, LONG, AND OBJECTS -+ Patch 24835919: Oracle GoldenGate \- IR EXECUTING DEPENDENT TRANSACTIONS OUT OF ORDER WITH PARALLELISM GREATER THAN -+ Patch 23262847: Oracle GoldenGate \- MALFORMED REDO CAUSED OGG REPLICATION ABEND -+ Patch 21171382: DBMS\_STATS Patch -+ Patch 21091901: ONLINE MOVE OF HASH OR REF PARTITION CAN LEAVE LOCAL INDEXES INCONSISTENT -+ Patch 31164857: JSON bundle patch -+ Patch 20033733: PART :IMC:HIT ORA 600 \[KGL\-HEAP\-SIZE\-EXCEEDED\] -+ Patch 28730253: SUPPORT NEW ERA REIWA FOR JAPANESE IMPERIAL CALENDAR -+ PreUpgrade Jar: preupgrade\_12\.1\.0\.2\.0\_18\_crlf\.zipn -+ Support for [Purging the recycle bin](Appendix.Oracle.CommonDBATasks.Database.md#Appendix.Oracle.CommonDBATasks.PurgeRecycleBin) -+ Support for [Generating performance reports with Automatic Workload Repository \(AWR\)](Appendix.Oracle.CommonDBATasks.Database.md#Appendix.Oracle.CommonDBATasks.AWR) using the `rdsadmin.rdsadmin_diagnostic_util` package - -#### Combined patches for version 12\.1\.0\.2, released April 2020 - -Bugs fixed: - -``` -19309466, 19902195, 18250893, 25437699, 19383839, 19781326, 16756406 -18456643, 26546664, 22364044, 29483723, 18913440, 18845653, 28774416 -19915271, 20172151, 18417036, 19516448, 24907917, 23713236, 24796092 -23140259, 21856522, 29434301, 23028781, 19243521, 19658708, 18272672 -21153266, 19174430, 28250929, 18900107, 22243719, 19548064, 26556014 -20493163, 20688221, 22346829, 21387964, 13542050, 25377044, 22072818 -22250006, 22734547, 22243983, 21623164, 21534893, 19012119, 19932634 -19869255, 22232606, 18681056, 23324000, 25427662, 22068305, 24589081 -19439759, 19303936, 18856106, 22916353, 24835538, 22353346, 19790243 -21106027, 20023340, 26444887, 23088803, 22529728, 26256131, 18492302 -19134173, 24303148, 21101873, 20447445, 27122162, 21188584, 19390567 -26513709, 25780343, 19769480, 21097043, 21225209, 27217412, 26245237 -20677396, 19284031, 19450314, 23514911, 19016730, 27303938, 22205263 -22517782, 20919320, 22075064, 29621961, 22551446, 29250317, 22721409 -18440095, 22496904, 27611612, 16439813, 18354830, 20596234, 22022760 -20936905, 22268833, 23197103, 23746128, 22515353, 27897759, 21514877 -19809171, 21186167, 26111842, 18990023, 13787015, 22492533, 25405687 -22233505, 20173897, 24624166, 17210525, 29707896, 21260431, 25579761 -20181030, 25056052, 19370504, 21868720, 24423416, 23068169, 19124589 -22690648, 21383171, 19402853, 19888853, 25107334, 24341675, 17722075 -20882568, 25653109, 23026585, 18604692, 20717081, 25546608, 20768076 -27370965, 19081128, 22173980, 25722055, 23514710, 29483771, 19178851 -20951038, 22168163, 25161298, 20569094, 24308635, 28302049, 19791377 -19050649, 20920911, 29962939, 30365745, 22475617, 19189525, 19060015 -19469538, 27052607, 29633753, 20598042, 22458049, 18988834, 21159665 -23302839, 25307368, 25699321, 21924131, 21837606, 17409174, 20588486 -22729345, 22842151, 25051465, 19238590, 16941434, 20387265, 29378913 -24397438, 20673810, 23108128, 20356733, 28215510, 22380919, 18436647 -21764119, 23065323, 20825533, 19124336, 22294260, 20839705, 24790914 -20284155, 23571055, 6194865, 25539063, 17365043, 25914276, 20952966 -22961508, 19176223, 21300341, 23237313, 18288842, 27223075, 22353199 -20011515, 22083366, 28305362, 27634991, 25670786, 21419850, 26898563 -22495673, 27986817, 19577410, 26248143, 23294548, 25328093, 23101501 -24737064, 19931709, 25423453, 25547060, 23533807, 27726780, 24600330 -20635353, 28384353, 25600421, 18122373, 20043616, 23124895, 18856999 -21450666, 24752618, 18893947, 26633558, 20076781, 20926021, 26029780 -21196809, 21354456, 22533631, 23725036, 20464614, 19562381, 27375542 -24808595, 19189317, 25669791, 18307021, 21917884, 19708632, 28423598 -27213224, 25633101, 29006527, 20711718, 18973548, 25982666, 25472885 -19718981, 20684983, 23567857, 22826718, 25655390, 21773465, 20250147 -20144019, 19197175, 26263721, 19597439, 28867992, 21387128, 22007324 -28797711, 18818069, 21566639, 19180770, 19879746, 21785691, 20539050 -20424183, 24285405, 21425496, 26544823, 19957298, 20322560, 29962927 -22228324, 23172924, 22520320, 29817278, 28164480, 30179644, 27751755 -21575362, 25058080, 22365117, 22645009, 25165496, 28950969, 27133662 -27433385, 18774543, 20124446, 21429602, 29189889, 26153977, 30659882 -19371175, 21863727, 18940497, 19074147, 22923409, 25489342, 21380789 -19154375, 25417056, 19044962, 19532017, 23080557, 19662635, 22374754 -20560611, 25654936, 21492036, 18705806, 28420042, 19578247, 20705577 -22024071, 22238921, 29645349, 22809871, 21184223, 19995869, 23089357 -19404068, 18921743, 19065677, 19018447, 19018206, 18308268, 19777862 -27314697, 29027694, 22223463, 19304354, 22519146, 23020270, 22214989 -19445860, 26654363, 27199245, 22977256, 20890311, 27445727, 28281094 -21142837, 20869721, 22258530, 24555417, 22179537, 21756699, 18801391 -18648816, 20217801, 18819908, 19550902, 22760595, 25483815, 19543384 -23628685, 25482971, 30252098, 23007241, 19593445, 21080143, 27351628 -20582405, 24966594, 20031873, 29828111, 25489367, 20374572, 18618122 -24737581, 21698350, 22501616, 26784509, 28043157, 19306797, 24739928 -18966843, 19077215, 20704450, 19068970, 20543011, 19023822, 24713381 -22836801, 20432873, 21756677, 23168363, 20328248, 18674047, 18849537 -20087383, 25459958, 20315311, 29163567, 22897344, 27534509, 26768025 -20686773, 25178179, 19308965, 18948177, 20764012, 27623159, 19468991 -20868862, 21780146, 23315153, 20466628, 21756661, 20397490, 19706965 -20302006, 24831514, 23240358, 22178855, 19032777, 20862087, 19329654 -18974476, 20603378, 21275255, 20859910, 29500963, 19307662, 26203182 -21847223, 20281121, 28079127, 22568797, 19075256, 19076343, 28026866 -29511611, 18866977, 22808310, 25635149, 20844426, 20904530, 20441797 -20175161, 20296619, 19831647, 18548246, 30497057, 21442094, 25079710 -24674955, 18840932, 18740837, 20294666, 27404573, 21037923, 25602488 -21517440, 22062517, 19180394, 27337759, 19174942, 27092508, 20671094 -21889720, 19347458, 19450116, 18411216, 20117253, 24386767, 24737954 -20641666, 19931367, 25264559, 19930276, 22092979, 25616268, 21625179 -20879709, 23003979, 20165574, 28578164, 19272708, 19547370, 22624709 -23084507, 23184263, 20228093, 21281532, 25093872, 19805359, 26324206 -19461270, 18700762, 19434529, 18799063, 20354900, 29388020, 20378086 -17008068, 21246723, 20831538, 20424899, 20361671, 18674024, 19689979 -24411921, 19873610, 16619249, 20562898, 21641414, 21091431, 19440586 -20001168, 22757364, 22175564, 22499356, 20725343, 21241052, 19561643 -28199085, 21270823, 20736227, 19399918, 19195895, 20830459, 20017509 -18475439, 25790353, 21828126, 21665897, 25555252, 20746251, 19315668 -22568177, 25764020, 25612095, 25357142, 23096938, 19067244, 19943771 -18043064, 19941352, 21329301, 18885870, 26243698, 26187943, 20324049 -30164714, 19536415, 30305880, 23709062, 28174827, 20446883, 27314206 -21299490, 25313154, 18628388, 21744290, 18254023, 27072923, 25047724 -20591183, 27847259, 20459944, 19185876, 18548433, 27207110, 22465352 -24385625, 24326444, 24920582, 20402832, 19627012, 22733141, 29200700 -20468401, 27441326, 27620950, 16863642, 19639483, 19315691, 27567477 -21479753, 19174521, 23177923, 20401975, 18306996, 18851894, 21424824 -27034890, 20581111, 20318889, 20936731, 21060755, 25240188, 26828994 -27629756, 22256560, 19188927, 23328639, 27229389, 20766180, 20229001 -24570598, 25475853, 21172913, 17655240, 29379978, 21266085, 19028800 -19035573, 19366375, 28821847, 24523374, 25599425, 25034396, 19289642 -21502702, 21291274, 18007682, 23521523, 20475845, 29408136, 22148226 -22528741, 25417958, 29500257, 24652769, 26088426, 19326908, 19597583 -17414008, 23019710, 20897759, 26822620, 22046677, 19663176, 20938170 -19891090, 24825843, 26318627, 21960504, 20524085, 24509056, 19054077 -21385422, 26262953, 22657942, 20428621, 21899588, 23326313, 19723336 -28891741, 19835133, 17532734, 17495022, 25300427, 19333670, 21842017 -19285025, 21373473, 29483626, 23260854, 23061453, 19687159, 14643995 -22146062, 20977794, 20734332, 16938780, 17551063, 27548131, 21977392 -28612674, 24461826, 19676012, 20588502, 23315889, 19520602, 23053606 -19841800, 20245930, 19001359, 21476308, 26546754, 19393542, 30215130 -23533524, 21099555, 29961353, 17532729, 27995248, 25429959, 19141838 -19644859, 21915719, 19908836, 21421886, 19358317, 27101105, 19524158 -29869404, 28758090, 23548817, 25861398, 20803014, 23025340, 19335438 -19058490, 23642282, 19207117, 18799993, 25919622, 26569225, 25986062 -20835241, 24662775, 20958816, 19475971, 18967382, 20347562, 25740844 -20348653, 29009513, 19896336, 24812585, 20048359, 21896069, 20468490 -19524384, 25392535, 21147908, 21695575, 30295478, 20440930, 30973003 -25789277, 19171086, 24718260, 17867700, 19791273, 26110632, 27397048 -21241829, 19591608, 18662619, 22707244, 18419520, 22296366, 22654475 -18914624, 19571367, 28636676, 21522582, 29893132, 19501299, 26007010 -19529868, 20425790, 19708342, 27487919, 27997875, 26968670, 16870214 -18202441, 24415926, 18743542, 19001390, 21157728, 20657411, 19332396 -22606521, 21875360, 21821302, 25091141, 28000269, 19149990, 20382309 -22855193, 16777441, 19606174, 28542455, 20848335, 25495682, 19382851 -20528052, 22762046, 24563422, 27468303, 23125826, 22503297, 28993590 -25192729, 23338911, 27274536, 22730454, 19354794, 20757079, 19176326 -20298413, 19048007, 22018363, 24300640, 18849970, 21532755, 20860659 -22905130, 26121990, 21263635, 23602213, 27710072, 23209741, 22160989 -18499088, 18775971, 22894949, 21059919, 18952989, 27348081, 22518784 -25856821, 24457597, 25885148, 25484507, 20794034, 20554364, 21061354 -19468347, 17533661, 19883092, 20657441, 24401351, 21285458, 28023399 -18051556, 25330273, 26412540, 24425998, 19699191, 24437510, 16875041 -20669434, 18964978, 25415713, 23342170, 22972770, 28369092, 20828947 -21373076, 25492379, 25551676, 14283239, 25766822, 21967197, 22922076 -19601762, 25575628, 26110259, 20368850, 21239530, 20437153, 24848928 -20880215, 20798891, 25606091, 19013183, 29782211, 21095391, 25042823 -21133343, 22695831, 24365589, 25248384, 25634317, 20134113, 19587324 -20273319, 28501075, 18542562, 19017309, 26758193, 21063322, 22062026 -24802934, 27829295, 20134339, 22077517, 22815955, 23854396, 24690216 -22507210, 16354467, 20101006, 21795111, 27938623, 23501901, 18797519 -25997810, 23029562, 25879984, 26844406, 21260397, 25029423, 29726695 -19354335, 19730508, 22366558, 19390620, 26658759, 25822410, 6599380 -20717359, 24321547, 27097854, 21297872, 18964939, 19871910, 29437712 -26366517, 21913183, 25695903, 22366322, 20171986, 20603431, 21132297 -25957038, 21542577, 29791152, 22507234, 23170620, 24719736, 25600342 -18868646, 28587723, 29142109, 26637824, 20627866, 18110491, 16923858 -24642295, 19518079, 20914870, 19339555, 20466322, 25823754, 25110233 -20169408, 24908321, 20842388, 17274537, 26575788, 20474192, 21644640 -28849751, 21794615, 18899974, 20471920, 22806698, 19052488, 29944660 -29260956, 26198757, 19503821, 23717151, 24350620, 23126410, 20074391 -25823532, 19157754, 22495062, 21220620, 24316947, 19865345, 19065556 -22816287, 25947799, 20878790, 23492665, 21322887, 22305887, 19617921 -20879889, 24350831, 19578350, 28022101, 26439748, 21893235, 19363645 -21072646, 20898391, 19291380, 27060167, 18382302, 27086138, 22536802 -22087683, 21197626, 21656630, 20373598, 19248799, 22707866, 28432129 -19155797, 19279273, 18886413, 25490238, 20922010, 19990037, 25150925 -20509482, 20778986, 22282748, 27255377, 24717859, 20703000, 22862134 -21526048, 28683167, 24929210, 24560906, 19079752, 25486384, 20144308 -21620471, 19670108, 19068610, 20267166, 25123585, 20476175, 28639299 -18549238, 19297917, 20564072, 22950945, 19385656, 23528412, 19684504 -19330795, 21174504, 28357401, 20899461, 20557786, 21911701, 19143550 -20118035, 19024808, 25809524, 25760195, 20009833, 19604659, 16359751 -26039623, 22820579, 28024793, 19928926, 23314180, 20212067, 24737403 -20480209, 18904062, 29030780, 26430737, 25476125, 20856766, 17258582 -27169796, 21668627, 26325856, 23272045, 20877664, 29247712, 19487147 -23149541, 24577566, 19430401, 19676905, 28025414, 20925795, 26482376 -22760679, 21296029, 21629064, 24416451, 23229229, 22865673, 20708701 -25353983, 19280225, 21315084, 20613079, 19375649, 19213447, 19989009 -18191823, 27314390, 26336977, 25775213, 30803210, 24393981, 22568016 -27033652, 25639019, 17319928, 14705949, 19703301, 20308798, 28390273 -21626377, 20122715, 6418158, 23105538, 25743479, 26198926, 28714988 -19258504, 21188532, 24792678, 23151677, 17890099, 21649497, 26446098 -16887946, 19693090, 26024732, 18791688, 19721304, 27012701, 19490948 -29483672, 19619732, 21164318, 29559723, 21516611, 23148260, 18090142 -21641760, 19818513, 22468781, 23002524, 20139391, 21052842, 24693382 -19978542, 25477657, 23543183, 22165897, 19373893, 22359063, 19409212 -18373438, 23035249, 21820934, 20677974, 18990693, 20470877, 19452434 -21422580, 21632821, 22351572, 20235511, 23220453, 18742258, 18604493 -23008056, 22901797, 18610915, 20978259, 20832516, 24801152, 27276231 -26089440, 20907061, 25733479, 19523462, 18733351, 20505778, 19183343 -21675340, 21787056, 21273804, 22782647, 20544065, 29719146, 25093739 -17835294, 25210690, 28708023, 24413809, 27846298, 18371441, 26714910 -24385983, 20413820, 22176950, 28986231, 24421668, 25897615, 25643931 -23195445, 21281607, 20513399, 18841764, 28098160, 20558005, 20093776 -18909599, 20618595, 23572982, 23104033, 19211433, 20331945, 19512341 -23066146, 22256431, 19637186, 19022470, 22686674, 18607546, 26875822 -24573817, 23115139, 19649152, 19201867, 21294938, 20898997, 18510194 -21293600, 30218044, 21842740, 22454326, 24683149, 19534363, 25489607 -23061702, 30805558, 30855121, 30502041, 30534664, 30128197, 30160639 -22070866, 29774383, 29774367, 29251241, 29254615, 19165673, 28790654 -28915933, 28440711, 28502128, 28502113, 27923320, 27952584, 27952577 -27642235, 27475603, 27461789, 27461842, 25649873, 27001733, 27000663 -27000690, 26635845, 26637592, 26570171, 26027162, 26023002, 26023025 -25437695, 25494413, 25494379, 24917972, 25067795, 24534298, 25076732 -25076756, 24315824, 21659726, 24448240, 24448282, 23177536, 22675136 -23265914, 23265965, 23727148, 22674709, 22670413, 22670385, 21188537 -22139226, 22118835, 22118851, 21555660, 21811517, 19623450, 21566993 -21566944, 19176885, 21068507, 21047803, 21047766, 20415564, 20408829 -20408866, 19877336, 19855285, 19909862, 19895362, 19895326, 19153980 -19231857, 19223010, 19245191, 19699946, 28730253, 16799735, 17432124 -18759211, 19396455, 20875898, 22037014, 22873635, 23614158, 24701840 -25881255, 27015449, 28125601, 28852325, 29997937, 29997959, 17969866 -20394750, 24835919, 23262847, 21171382, 21091901, 18727933, 18758877 -18778801, 18803726, 18810904, 18895170, 18952766, 18999568, 19130152 -19131386, 19131607, 19146474, 19168167, 19248279, 19313563, 19317646 -19327391, 19364502, 19440520, 19448499, 19461428, 19468612, 19547774 -19566592, 19571055, 19571082, 19583624, 19590877, 19632912, 19647503 -19680796, 19701015, 19705781, 19769625, 19784751, 19799847, 19811709 -19817386, 19824871, 19859472, 19880190, 19886165, 19889230, 19933147 -19952975, 19982584, 19988852, 20009569, 20011646, 20011897, 20052269 -20061399, 20233181, 20565112, 20565133, 20577490, 20703629, 20707932 -20717091, 20800890, 20801783, 25031502 -``` - -### Version 12\.1\.0\.2\.v19 - -Version 12\.1\.0\.2\.v19 includes the following: -+ Patch 30340202: DATABASE PATCH SET UPDATE 12\.1\.0\.2\.200114 -+ Patch 30502041: OJVM PATCH SET UPDATE 12\.1\.0\.2\.200114 -+ Patch 29997937: DSTv34 for RDBMS \(TZDATA2019G\) -+ Patch 29997959: DSTv34 for OJVM \(TZDATA2019G\) -+ Patch 17969866: Oracle GoldenGate \- 46719: ENH: REPLICATION SUPPORT FOR INSERTS / FULL UPDATES WITH LARGE VALUES -+ Patch 20394750: Oracle GoldenGate \- APPLY CDR RESOLUTION FAILING FOR LOBS, XML, LONG, AND OBJECTS -+ Patch 24835919: Oracle GoldenGate \- IR EXECUTING DEPENDENT TRANSACTIONS OUT OF ORDER WITH PARALLELISM GREATER THAN -+ Patch 23262847: Oracle GoldenGate \- MALFORMED REDO CAUSED OGG REPLICATION ABEND -+ Patch 21171382: DBMS\_STATS Patch -+ Patch 21091901: ONLINE MOVE OF HASH OR REF PARTITION CAN LEAVE LOCAL INDEXES INCONSISTENT -+ Patch 30708149: JSON bundle patch -+ Patch 20033733: PART :IMC:HIT ORA 600 \[KGL\-HEAP\-SIZE\-EXCEEDED\] -+ Patch 28730253: SUPPORT NEW ERA REIWA FOR JAPANESE IMPERIAL CALENDAR -+ PreUpgrade Jar: preupgrade\_12\.1\.0\.2\.0\_18\_crlf\.zip - -#### Oracle patch 29918340, released January 2020 - -Bugs fixed: - -``` -19309466, 19902195, 18250893, 25437699, 19383839, 19781326, 16756406 -18456643, 26546664, 22364044, 29483723, 18913440, 18845653, 19915271 -20172151, 18417036, 19516448, 24907917, 23713236, 24796092, 23140259 -29434301, 19243521, 19658708, 18272672, 21153266, 19174430, 18900107 -22243719, 19548064, 26556014, 20493163, 20688221, 22346829, 21387964 -13542050, 22072818, 22250006, 22734547, 22243983, 21623164, 19012119 -21534893, 19932634, 19869255, 22232606, 18681056, 23324000, 25427662 -22068305, 24589081, 19439759, 19303936, 18856106, 22916353, 24835538 -22353346, 19790243, 21106027, 26444887, 20023340, 23088803, 22529728 -26256131, 19134173, 18492302, 24303148, 21101873, 20447445, 27122162 -21188584, 19390567, 26513709, 25780343, 19769480, 21097043, 21225209 -26245237, 20677396, 19284031, 19450314, 23514911, 19016730, 22205263 -22517782, 20919320, 22075064, 22551446, 29250317, 22721409, 18440095 -22496904, 16439813, 18354830, 20596234, 22022760, 20936905, 22268833 -23197103, 23746128, 22515353, 27897759, 21514877, 19809171, 21186167 -26111842, 18990023, 13787015, 22492533, 22233505, 20173897, 24624166 -17210525, 29707896, 21260431, 25579761, 20181030, 25056052, 19370504 -21868720, 23068169, 19124589, 22690648, 21383171, 19402853, 19888853 -25107334, 24341675, 17722075, 20882568, 25653109, 23026585, 18604692 -20717081, 25546608, 20768076, 27370965, 19081128, 22173980, 25722055 -23514710, 29483771, 19178851, 20951038, 22168163, 25161298, 20569094 -24308635, 19791377, 19050649, 20920911, 29962939, 30365745, 22475617 -19189525, 19060015, 19469538, 27052607, 29633753, 20598042, 22458049 -18988834, 21159665, 23302839, 25307368, 25699321, 21924131, 17409174 -21837606, 22729345, 22842151, 25051465, 19238590, 16941434, 20387265 -29378913, 24397438, 20673810, 23108128, 20356733, 22380919, 18436647 -21764119, 23065323, 20825533, 19124336, 22294260, 20839705, 24790914 -20284155, 23571055, 6194865, 25539063, 17365043, 25914276, 20952966 -22961508, 19176223, 21300341, 23237313, 18288842, 27223075, 22353199 -20011515, 22083366, 27634991, 25670786, 28305362, 21419850, 26898563 -22495673, 27986817, 19577410, 26248143, 23294548, 23101501, 24737064 -19931709, 25423453, 25547060, 23533807, 27726780, 24600330, 28384353 -20635353, 25600421, 18122373, 20043616, 23124895, 18856999, 21450666 -18893947, 24752618, 26633558, 20076781, 26029780, 20926021, 21196809 -21354456, 22533631, 23725036, 20464614, 19562381, 27375542, 24808595 -19189317, 25669791, 18307021, 21917884, 19708632, 27213224, 25633101 -29006527, 20711718, 18973548, 25982666, 25472885, 19718981, 20684983 -23567857, 22826718, 25655390, 21773465, 20250147, 20144019, 19197175 -26263721, 19597439, 21387128, 28867992, 22007324, 18818069, 21566639 -19180770, 19879746, 21785691, 20539050, 20424183, 24285405, 21425496 -26544823, 19957298, 20322560, 22228324, 29962927, 23172924, 22520320 -29817278, 27751755, 21575362, 25058080, 22365117, 22645009, 25165496 -28950969, 27433385, 18774543, 20124446, 21429602, 29189889, 26153977 -19371175, 21863727, 18940497, 19074147, 22923409, 25489342, 21380789 -19154375, 25417056, 19044962, 19532017, 19662635, 23080557, 22374754 -20560611, 25654936, 21492036, 18705806, 28420042, 19578247, 20705577 -22024071, 22238921, 22809871, 29645349, 21184223, 19995869, 23089357 -19404068, 18921743, 19065677, 19018447, 19018206, 18308268, 19777862 -29027694, 22223463, 19304354, 22519146, 22214989, 19445860, 26654363 -27199245, 22977256, 20890311, 27445727, 21142837, 20869721, 22258530 -24555417, 22179537, 21756699, 18801391, 20217801, 18819908, 19550902 -22760595, 25483815, 19543384, 23628685, 25482971, 23007241, 19593445 -30252098, 21080143, 27351628, 20582405, 24966594, 20031873, 29828111 -25489367, 18618122, 24737581, 21698350, 22501616, 26784509, 28043157 -19306797, 24739928, 18966843, 19077215, 20704450, 19068970, 20543011 -19023822, 24713381, 22836801, 20432873, 21756677, 20328248, 18674047 -18849537, 20087383, 25459958, 20315311, 29163567, 22897344, 27534509 -26768025, 25178179, 19308965, 20686773, 18948177, 20764012, 27623159 -19468991, 20868862, 21780146, 23315153, 20466628, 21756661, 20397490 -19706965, 20302006, 24831514, 23240358, 22178855, 19032777, 20862087 -19329654, 18974476, 20603378, 21275255, 20859910, 19307662, 26203182 -21847223, 20281121, 22568797, 19075256, 28079127, 19076343, 28026866 -29511611, 18866977, 22808310, 25635149, 20844426, 20904530, 20441797 -20296619, 19831647, 18548246, 21442094, 25079710, 24674955, 18840932 -18740837, 20294666, 21037923, 25602488, 21517440, 22062517, 19180394 -27337759, 19174942, 27092508, 20671094, 21889720, 19347458, 19450116 -18411216, 20117253, 24386767, 20641666, 24737954, 19931367, 25264559 -19930276, 22092979, 25616268, 21625179, 20879709, 23003979, 20165574 -28578164, 19272708, 19547370, 22624709, 23084507, 23184263, 20228093 -21281532, 25093872, 19805359, 26324206, 19461270, 19434529, 18799063 -20354900, 29388020, 20378086, 17008068, 21246723, 20831538, 20424899 -20361671, 18674024, 19689979, 24411921, 19873610, 16619249, 20562898 -21641414, 21091431, 19440586, 20001168, 22757364, 22175564, 22499356 -20725343, 21241052, 19561643, 28199085, 20736227, 19399918, 19195895 -20830459, 20017509, 18475439, 25790353, 21828126, 21665897, 25555252 -20746251, 19315668, 22568177, 25764020, 25612095, 25357142, 23096938 -19067244, 19943771, 18043064, 19941352, 21329301, 18885870, 26243698 -26187943, 20324049, 19536415, 30164714, 23709062, 28174827, 20446883 -27314206, 21299490, 25313154, 18628388, 21744290, 18254023, 27072923 -25047724, 20591183, 27847259, 20459944, 19185876, 18548433, 27207110 -22465352, 24385625, 24326444, 20402832, 19627012, 22733141, 29200700 -20468401, 27441326, 27620950, 16863642, 19639483, 19315691, 27567477 -21479753, 19174521, 23177923, 20401975, 18306996, 18851894, 21424824 -27034890, 20581111, 20318889, 20936731, 21060755, 25240188, 26828994 -22256560, 19188927, 23328639, 27229389, 20766180, 20229001, 24570598 -25475853, 21172913, 17655240, 29379978, 21266085, 19028800, 19035573 -19366375, 24523374, 28821847, 25599425, 25034396, 19289642, 21502702 -21291274, 18007682, 23521523, 20475845, 29408136, 22148226, 22528741 -25417958, 29500257, 24652769, 26088426, 19326908, 19597583, 17414008 -23019710, 20897759, 26822620, 22046677, 19663176, 20938170, 19891090 -24825843, 26318627, 21960504, 24509056, 20524085, 19054077, 21385422 -26262953, 22657942, 20428621, 21899588, 23326313, 19723336, 19835133 -17532734, 17495022, 25300427, 19333670, 21842017, 19285025, 21373473 -29483626, 23260854, 23061453, 19687159, 14643995, 22146062, 20977794 -20734332, 16938780, 17551063, 27548131, 21977392, 28612674, 24461826 -19676012, 20588502, 23315889, 19520602, 23053606, 19841800, 20245930 -19001359, 21476308, 26546754, 19393542, 23533524, 21099555, 27995248 -17532729, 25429959, 19141838, 19644859, 21915719, 19908836, 21421886 -19358317, 19524158, 27101105, 29869404, 23548817, 25861398, 20803014 -23025340, 19335438, 19058490, 23642282, 19207117, 18799993, 25919622 -26569225, 25986062, 20835241, 24662775, 19475971, 18967382, 20347562 -20348653, 29009513, 19896336, 24812585, 20048359, 21896069, 20468490 -19524384, 25392535, 21147908, 21695575, 30295478, 20440930, 25789277 -19171086, 24718260, 17867700, 19791273, 26110632, 27397048, 21241829 -19591608, 22707244, 18662619, 18419520, 22296366, 22654475, 18914624 -19571367, 28636676, 21522582, 29893132, 19501299, 26007010, 19529868 -20425790, 19708342, 27997875, 26968670, 16870214, 18202441, 24415926 -18743542, 19001390, 21157728, 20657411, 19332396, 22606521, 21875360 -21821302, 25091141, 28000269, 19149990, 20382309, 22855193, 16777441 -19606174, 28542455, 20848335, 25495682, 19382851, 20528052, 22762046 -24563422, 27468303, 23125826, 22503297, 28993590, 25192729, 23338911 -22730454, 27274536, 19354794, 20757079, 19176326, 20298413, 19048007 -22018363, 24300640, 18849970, 21532755, 20860659, 22905130, 26121990 -21263635, 27710072, 23209741, 22160989, 18499088, 18775971, 22894949 -21059919, 18952989, 27348081, 22518784, 25856821, 24457597, 25484507 -20794034, 25885148, 20554364, 21061354, 19468347, 17533661, 19883092 -20657441, 24401351, 21285458, 28023399, 18051556, 25330273, 26412540 -24425998, 19699191, 24437510, 16875041, 20669434, 18964978, 23342170 -22972770, 20828947, 21373076, 25492379, 25551676, 14283239, 25766822 -21967197, 22922076, 19601762, 25575628, 26110259, 20368850, 21239530 -20437153, 24848928, 20880215, 20798891, 25606091, 19013183, 25042823 -21133343, 22695831, 24365589, 25248384, 25634317, 20134113, 19587324 -20273319, 28501075, 18542562, 19017309, 26758193, 21063322, 22062026 -20134339, 22077517, 22815955, 23854396, 24690216, 22507210, 16354467 -20101006, 21795111, 27938623, 23501901, 18797519, 25997810, 23029562 -25879984, 26844406, 21260397, 25029423, 19354335, 29726695, 19730508 -22366558, 19390620, 26658759, 25822410, 6599380, 20717359, 24321547 -27097854, 21297872, 18964939, 19871910, 29437712, 26366517, 21913183 -25695903, 22366322, 20171986, 20603431, 21132297, 25957038, 21542577 -22507234, 23170620, 24719736, 25600342, 18868646, 28587723, 29142109 -26637824, 20627866, 18110491, 16923858, 24642295, 19518079, 20914870 -19339555, 20466322, 25823754, 25110233, 20169408, 24908321, 20842388 -17274537, 26575788, 20474192, 21644640, 28849751, 21794615, 18899974 -20471920, 22806698, 19052488, 29944660, 29260956, 26198757, 19503821 -23717151, 24350620, 23126410, 20074391, 19157754, 22495062, 21220620 -24316947, 19865345, 19065556, 22816287, 25947799, 20878790, 23492665 -21322887, 22305887, 19617921, 20879889, 24350831, 19578350, 28022101 -26439748, 21893235, 19363645, 21072646, 20898391, 19291380, 27060167 -18382302, 27086138, 22536802, 22087683, 21197626, 21656630, 20373598 -19248799, 22707866, 28432129, 19155797, 19279273, 18886413, 25490238 -20922010, 19990037, 25150925, 20509482, 20778986, 27255377, 24717859 -20703000, 22862134, 21526048, 28683167, 24929210, 24560906, 20144308 -21620471, 19670108, 19068610, 20267166, 25123585, 20476175, 18549238 -28639299, 19297917, 20564072, 22950945, 19385656, 23528412, 19684504 -19330795, 21174504, 28357401, 20899461, 20557786, 21911701, 19143550 -20118035, 19024808, 25760195, 20009833, 19604659, 16359751, 26039623 -22820579, 19928926, 23314180, 20212067, 24737403, 20480209, 18904062 -29030780, 26430737, 20856766, 25476125, 17258582, 27169796, 21668627 -23272045, 20877664, 26325856, 19487147, 23149541, 24577566, 19430401 -19676905, 20925795, 26482376, 21296029, 21629064, 23229229, 22865673 -20708701, 25353983, 19280225, 21315084, 20613079, 19375649, 19213447 -19989009, 18191823, 27314390, 26336977, 25775213, 24393981, 22568016 -25639019, 17319928, 14705949, 19703301, 28390273, 20308798, 21626377 -20122715, 6418158, 23105538, 26198926, 25743479, 19258504, 28714988 -21188532, 24792678, 23151677, 17890099, 21649497, 26446098, 16887946 -26024732, 18791688, 19721304, 27012701, 19490948, 29483672, 19619732 -21164318, 29559723, 21516611, 23148260, 18090142, 21641760, 19818513 -22468781, 23002524, 20139391, 24693382, 19978542, 25477657, 23543183 -22165897, 19373893, 22359063, 19409212, 18373438, 23035249, 21820934 -20677974, 18990693, 20470877, 19452434, 21422580, 21632821, 22351572 -20235511, 23220453, 18742258, 18604493, 23008056, 22901797, 18610915 -20978259, 20832516, 24801152, 26089440, 27276231, 20907061, 25733479 -19523462, 18733351, 20505778, 19183343, 21787056, 21273804, 22782647 -20544065, 25093739, 17835294, 29719146, 25210690, 28708023, 24413809 -27846298, 18371441, 26714910, 24385983, 20413820, 28986231, 24421668 -25897615, 25643931, 23195445, 21281607, 20513399, 18841764, 28098160 -20558005, 20093776, 18909599, 20618595, 23572982, 23104033, 19211433 -20331945, 19512341, 23066146, 22256431, 19637186, 19022470, 22686674 -18607546, 26875822, 24573817, 23115139, 19649152, 19201867, 21294938 -20898997, 18510194, 21293600, 21842740, 22454326, 24683149, 19534363 -25489607, 23061702 -``` - -### Version 12\.1\.0\.2\.v18 - -Version 12\.1\.0\.2\.v18 includes the following: -+ Patch 29918340: DATABASE PATCH SET UPDATE 12\.1\.0\.2\.191015 -+ Patch 30128197: OJVM PATCH SET UPDATE 12\.1\.0\.2\.191015 -+ Patch 29997937: DSTv34 for RDBMS \(TZDATA2019G\) -+ Patch 29997959: DSTv34 for OJVM \(TZDATA2019G\) -+ Patch 17969866: Oracle GoldenGate \- Oracle RDBMS Server Recommended Patches -+ Patch 20394750: Oracle GoldenGate \- Oracle RDBMS Server Recommended Patches -+ Patch 24835919: Oracle GoldenGate \- Oracle RDBMS Server Recommended Patches -+ Patch 21171382: DBMS\_STATS Patch -+ Patch 21091901: ONLINE MOVE OF HASH OR REF PARTITION CAN LEAVE LOCAL INDEXES INCONSISTENT -+ Patch 30370890: JSON bundle patch -+ Patch 20033733: PART :IMC:HIT ORA 600 \[KGL\-HEAP\-SIZE\-EXCEEDED\] -+ Patch 28730253: SUPPORT NEW ERA REIWA FOR JAPANESE IMPERIAL CALENDAR -+ PreUpgrade Jar: preupgrade\_12\.1\.0\.2\.0\_18\_crlf\.zip -+ Support for [Resizing the temporary tablespace in a read replica](Appendix.Oracle.CommonDBATasks.Database.md#Appendix.Oracle.CommonDBATasks.ResizeTempSpaceReadReplica) - -#### Oracle patch 29918340, released October 2019 - -Bugs fixed: - -``` -19309466, 19902195, 18250893, 25437699, 19383839, 19781326, 16756406 -18456643, 26546664, 22364044, 29483723, 18845653, 18913440, 19915271 -20172151, 18417036, 19516448, 24907917, 23713236, 24796092, 23140259 -19243521, 19658708, 18272672, 21153266, 19174430, 18900107, 22243719 -19548064, 26556014, 20493163, 20688221, 22346829, 21387964, 13542050 -22072818, 22250006, 22734547, 22243983, 21623164, 19012119, 19932634 -19869255, 22232606, 18681056, 23324000, 25427662, 22068305, 24589081 -19439759, 19303936, 22916353, 24835538, 22353346, 19790243, 21106027 -26444887, 23088803, 22529728, 26256131, 19134173, 24303148, 21101873 -20447445, 27122162, 21188584, 19390567, 26513709, 25780343, 19769480 -21097043, 21225209, 26245237, 20677396, 19284031, 19450314, 19016730 -23514911, 22205263, 22517782, 20919320, 22075064, 22551446, 29250317 -22721409, 18440095, 22496904, 16439813, 18354830, 20596234, 22022760 -20936905, 22268833, 23197103, 22515353, 23746128, 21514877, 19809171 -21186167, 26111842, 18990023, 13787015, 22492533, 22233505, 20173897 -24624166, 17210525, 21260431, 29707896, 25579761, 20181030, 25056052 -19370504, 21868720, 23068169, 19124589, 22690648, 21383171, 19402853 -19888853, 25107334, 24341675, 17722075, 20882568, 25653109, 23026585 -18604692, 20717081, 25546608, 20768076, 27370965, 19081128, 22173980 -25722055, 23514710, 19178851, 20951038, 22168163, 25161298, 20569094 -24308635, 19791377, 19050649, 20920911, 22475617, 19189525, 19469538 -27052607, 20598042, 29633753, 22458049, 18988834, 21159665, 23302839 -25307368, 25699321, 21924131, 17409174, 22729345, 22842151, 25051465 -19238590, 16941434, 20387265, 29378913, 24397438, 20673810, 23108128 -20356733, 22380919, 18436647, 23065323, 20825533, 19124336, 22294260 -24790914, 20284155, 23571055, 6194865, 25539063, 17365043, 25914276 -20952966, 22961508, 19176223, 21300341, 23237313, 18288842, 27223075 -22353199, 20011515, 22083366, 27634991, 25670786, 21419850, 26898563 -27986817, 19577410, 22495673, 26248143, 23294548, 23101501, 24737064 -19931709, 25423453, 25547060, 23533807, 27726780, 24600330, 28384353 -25600421, 18122373, 20043616, 23124895, 18856999, 21450666, 18893947 -26633558, 20076781, 26029780, 21196809, 21354456, 22533631, 23725036 -20464614, 19562381, 27375542, 24808595, 19189317, 25669791, 18307021 -21917884, 19708632, 27213224, 25633101, 29006527, 20711718, 18973548 -25982666, 19718981, 20684983, 23567857, 22826718, 25655390, 21773465 -20250147, 20144019, 19197175, 26263721, 19597439, 21387128, 22007324 -18818069, 21566639, 19180770, 19879746, 21785691, 20424183, 20539050 -24285405, 21425496, 26544823, 19957298, 20322560, 22228324, 23172924 -22520320, 27751755, 21575362, 25058080, 22365117, 22645009, 25165496 -28950969, 18774543, 20124446, 21429602, 29189889, 26153977, 19371175 -21863727, 18940497, 19074147, 22923409, 25489342, 21380789, 19154375 -25417056, 19044962, 19532017, 19662635, 22374754, 20560611, 25654936 -21492036, 18705806, 28420042, 19578247, 22024071, 22238921, 22809871 -21184223, 19995869, 23089357, 19404068, 18921743, 19065677, 19018447 -19018206, 18308268, 19777862, 29027694, 22223463, 19304354, 22519146 -22214989, 19445860, 26654363, 27199245, 22977256, 20890311, 27445727 -21142837, 20869721, 24555417, 22258530, 22179537, 21756699, 18801391 -20217801, 18819908, 22760595, 19550902, 25483815, 23628685, 19543384 -25482971, 23007241, 19593445, 21080143, 27351628, 20582405, 24966594 -20031873, 25489367, 29828111, 18618122, 24737581, 21698350, 22501616 -26784509, 24739928, 18966843, 19077215, 20704450, 19068970, 20543011 -19023822, 24713381, 22836801, 20432873, 21756677, 20328248, 18674047 -18849537, 20087383, 25459958, 20315311, 22897344, 29163567, 27534509 -26768025, 25178179, 19308965, 18948177, 20764012, 27623159, 19468991 -20868862, 21780146, 23315153, 20466628, 21756661, 20397490, 19706965 -20302006, 24831514, 23240358, 22178855, 19032777, 20862087, 19329654 -18974476, 20603378, 20859910, 19307662, 26203182, 21847223, 20281121 -22568797, 19075256, 19076343, 28026866, 29511611, 18866977, 22808310 -25635149, 20844426, 20904530, 20441797, 20296619, 18548246, 21442094 -25079710, 24674955, 18840932, 18740837, 20294666, 21037923, 25602488 -21517440, 22062517, 19180394, 27337759, 19174942, 20671094, 21889720 -19347458, 19450116, 18411216, 20117253, 24386767, 20641666, 19931367 -25264559, 19930276, 22092979, 25616268, 21625179, 20879709, 23003979 -20165574, 28578164, 19272708, 19547370, 22624709, 23084507, 23184263 -20228093, 21281532, 25093872, 19805359, 26324206, 19461270, 19434529 -18799063, 20354900, 29388020, 20378086, 17008068, 21246723, 20831538 -20424899, 20361671, 18674024, 19689979, 24411921, 19873610, 16619249 -20562898, 21641414, 21091431, 19440586, 20001168, 22757364, 22175564 -22499356, 20725343, 21241052, 19561643, 28199085, 20736227, 19399918 -19195895, 20830459, 20017509, 18475439, 25790353, 21828126, 21665897 -25555252, 20746251, 22568177, 25764020, 25612095, 25357142, 23096938 -19067244, 18043064, 19941352, 21329301, 18885870, 26243698, 26187943 -20324049, 19536415, 23709062, 28174827, 20446883, 27314206, 21299490 -25313154, 18628388, 21744290, 18254023, 27072923, 25047724, 20591183 -27847259, 20459944, 19185876, 18548433, 27207110, 22465352, 24385625 -24326444, 20402832, 19627012, 22733141, 29200700, 20468401, 27441326 -27620950, 16863642, 19639483, 19315691, 27567477, 21479753, 19174521 -23177923, 20401975, 18306996, 18851894, 27034890, 21424824, 20581111 -20318889, 20936731, 21060755, 25240188, 26828994, 22256560, 19188927 -23328639, 27229389, 20766180, 20229001, 24570598, 25475853, 21172913 -17655240, 29379978, 21266085, 19028800, 19035573, 19366375, 24523374 -25599425, 25034396, 19289642, 21502702, 21291274, 18007682, 23521523 -20475845, 29408136, 22148226, 22528741, 25417958, 24652769, 26088426 -19326908, 19597583, 29500257, 17414008, 23019710, 20897759, 26822620 -22046677, 19663176, 20938170, 19891090, 24825843, 26318627, 21960504 -24509056, 19054077, 21385422, 26262953, 22657942, 20428621, 21899588 -23326313, 19723336, 19835133, 17532734, 17495022, 25300427, 19333670 -21842017, 19285025, 21373473, 23260854, 23061453, 19687159, 14643995 -22146062, 20977794, 20734332, 17551063, 16938780, 27548131, 21977392 -28612674, 24461826, 19676012, 20588502, 23315889, 19520602, 23053606 -19841800, 20245930, 19001359, 21476308, 26546754, 19393542, 23533524 -21099555, 27995248, 25429959, 19141838, 19644859, 21915719, 19908836 -21421886, 19358317, 19524158, 23548817, 25861398, 20803014, 23025340 -19335438, 19058490, 23642282, 19207117, 18799993, 25919622, 26569225 -25986062, 20835241, 24662775, 19475971, 18967382, 20347562, 20348653 -19896336, 24812585, 20048359, 21896069, 20468490, 19524384, 25392535 -21147908, 21695575, 20440930, 30295478, 25789277, 19171086, 24718260 -17867700, 19791273, 27397048, 21241829, 19591608, 22707244, 18419520 -22296366, 22654475, 18914624, 19571367, 28636676, 21522582, 19501299 -29893132, 26007010, 19529868, 20425790, 19708342, 27997875, 16870214 -18202441, 24415926, 18743542, 19001390, 21157728, 20657411, 19332396 -22606521, 21875360, 25091141, 21821302, 28000269, 19149990, 20382309 -22855193, 16777441, 19606174, 20848335, 28542455, 25495682, 19382851 -20528052, 22762046, 24563422, 23125826, 22503297, 28993590, 25192729 -23338911, 22730454, 19354794, 20757079, 19176326, 20298413, 19048007 -22018363, 18849970, 21532755, 24300640, 20860659, 22905130, 26121990 -21263635, 27710072, 23209741, 22160989, 18499088, 18775971, 22894949 -21059919, 18952989, 27348081, 22518784, 25856821, 24457597, 25484507 -20794034, 20554364, 21061354, 19468347, 17533661, 19883092, 20657441 -24401351, 21285458, 28023399, 18051556, 25330273, 26412540, 24425998 -19699191, 24437510, 16875041, 20669434, 18964978, 22972770, 23342170 -20828947, 21373076, 25492379, 25551676, 14283239, 25766822, 21967197 -22922076, 19601762, 25575628, 26110259, 20368850, 21239530, 20437153 -24848928, 20880215, 20798891, 25606091, 19013183, 25042823, 21133343 -22695831, 24365589, 25248384, 25634317, 20134113, 19587324, 20273319 -28501075, 18542562, 19017309, 26758193, 21063322, 22062026, 20134339 -22077517, 22815955, 23854396, 24690216, 22507210, 16354467, 20101006 -21795111, 27938623, 23501901, 18797519, 25997810, 23029562, 25879984 -21260397, 25029423, 26844406, 19354335, 19730508, 22366558, 19390620 -26658759, 25822410, 6599380, 20717359, 24321547, 27097854, 21297872 -18964939, 19871910, 29437712, 26366517, 21913183, 25695903, 22366322 -20171986, 20603431, 21132297, 25957038, 21542577, 22507234, 23170620 -24719736, 25600342, 18868646, 28587723, 29142109, 26637824, 20627866 -18110491, 16923858, 24642295, 19518079, 19339555, 20466322, 25823754 -25110233, 20169408, 24908321, 20842388, 17274537, 26575788, 20474192 -21644640, 28849751, 21794615, 18899974, 20471920, 22806698, 19052488 -26198757, 19503821, 23717151, 24350620, 23126410, 20074391, 19157754 -22495062, 21220620, 24316947, 19865345, 19065556, 22816287, 25947799 -20878790, 23492665, 21322887, 22305887, 20879889, 19617921, 24350831 -19578350, 28022101, 26439748, 21893235, 19363645, 21072646, 20898391 -19291380, 27060167, 18382302, 27086138, 22536802, 22087683, 21197626 -21656630, 20373598, 19248799, 22707866, 28432129, 19155797, 19279273 -18886413, 25490238, 20922010, 19990037, 25150925, 20509482, 20778986 -27255377, 24717859, 20703000, 22862134, 21526048, 28683167, 24929210 -24560906, 20144308, 21620471, 19670108, 19068610, 20267166, 25123585 -20476175, 18549238, 19297917, 22950945, 19385656, 20564072, 23528412 -19684504, 19330795, 21174504, 28357401, 20899461, 20557786, 21911701 -19143550, 20118035, 19024808, 25760195, 20009833, 19604659, 16359751 -26039623, 22820579, 19928926, 23314180, 20212067, 24737403, 20480209 -18904062, 29030780, 26430737, 20856766, 17258582, 27169796, 21668627 -23272045, 20877664, 19487147, 23149541, 24577566, 19430401, 19676905 -20925795, 26482376, 21296029, 21629064, 23229229, 22865673, 20708701 -25353983, 19280225, 21315084, 20613079, 19375649, 19213447, 19989009 -18191823, 27314390, 26336977, 25775213, 24393981, 22568016, 25639019 -17319928, 14705949, 19703301, 28390273, 21626377, 20122715, 6418158 -23105538, 26198926, 19258504, 21188532, 24792678, 23151677, 17890099 -21649497, 26446098, 16887946, 26024732, 18791688, 19721304, 27012701 -19490948, 29483672, 19619732, 21164318, 29559723, 23148260, 18090142 -21641760, 19818513, 23002524, 22468781, 20139391, 24693382, 19978542 -25477657, 23543183, 22165897, 19373893, 22359063, 19409212, 18373438 -23035249, 20677974, 18990693, 20470877, 21422580, 21632821, 22351572 -20235511, 23220453, 18742258, 18604493, 23008056, 22901797, 18610915 -20978259, 20832516, 24801152, 26089440, 20907061, 19523462, 25733479 -20505778, 18733351, 19183343, 21787056, 21273804, 22782647, 20544065 -25093739, 17835294, 28708023, 24413809, 27846298, 18371441, 26714910 -24385983, 20413820, 28986231, 24421668, 25897615, 25643931, 23195445 -21281607, 20513399, 18841764, 20558005, 20093776, 18909599, 20618595 -23572982, 23104033, 19211433, 20331945, 19512341, 22256431, 19637186 -23066146, 19022470, 22686674, 18607546, 26875822, 24573817, 23115139 -19649152, 19201867, 21294938, 20898997, 18510194, 21293600, 21842740 -22454326, 24683149, 19534363, 25489607, 23061702 -``` - -### Version 12\.1\.0\.2\.v17 - -Version 12\.1\.0\.2\.v17 includes the following: -+ Patch 29494060: DATABASE PATCH SET UPDATE 12\.1\.0\.2\.190716 -+ Patch 29774383: OJVM PATCH SET UPDATE 12\.1\.0\.2\.190716 -+ Patch 28852325: DSTv33 for RDBMS \(TZDATA2018G\) -+ Patch 28852334: DSTv33 for OJVM \(TZDATA2018G\) -+ Patch 17969866: Oracle GoldenGate \- Oracle RDBMS Server Recommended Patches -+ Patch 20394750: Oracle GoldenGate \- Oracle RDBMS Server Recommended Patches -+ Patch 24835919: Oracle GoldenGate \- Oracle RDBMS Server Recommended Patches -+ Patch 21171382: DBMS\_STATS Patch -+ Patch 21091901: ONLINE MOVE OF HASH OR REF PARTITION CAN LEAVE LOCAL INDEXES INCONSISTENT -+ Patch 29958796: JSON bundle patch -+ Patch 20033733: PART :IMC:HIT ORA 600 \[KGL\-HEAP\-SIZE\-EXCEEDED\] -+ Patch 28730253: SUPPORT NEW ERA REIWA FOR JAPANESE IMPERIAL CALENDAR - -#### Oracle patch 29494060, released July 2019 - -Bugs fixed: - -``` -19309466, 19902195, 18250893, 25437699, 19383839, 19781326, 16756406 -18456643, 26546664, 22364044, 18845653, 19915271, 20172151, 18417036 -19516448, 23713236, 24907917, 24796092, 23140259, 19243521, 19658708 -18272672, 21153266, 19174430, 22243719, 19548064, 26556014, 20493163 -20688221, 21387964, 13542050, 22250006, 22734547, 22243983, 21623164 -19012119, 19932634, 19869255, 22232606, 18681056, 23324000, 25427662 -22068305, 24589081, 19439759, 19303936, 22916353, 24835538, 22353346 -19790243, 21106027, 26444887, 23088803, 22529728, 26256131, 19134173 -24303148, 20447445, 21101873, 21188584, 19390567, 26513709, 25780343 -19769480, 21097043, 21225209, 26245237, 20677396, 19284031, 19450314 -19016730, 22517782, 20919320, 22205263, 22075064, 22551446, 22721409 -18440095, 22496904, 16439813, 18354830, 20596234, 22022760, 20936905 -23197103, 22515353, 21514877, 19809171, 21186167, 26111842, 18990023 -13787015, 22492533, 20173897, 24624166, 17210525, 21260431, 20181030 -25056052, 19370504, 21868720, 23068169, 19124589, 21383171, 19402853 -22690648, 19888853, 24341675, 17722075, 25107334, 20882568, 25653109 -23026585, 18604692, 20717081, 25546608, 27370965, 19081128, 20768076 -22173980, 25722055, 23514710, 19178851, 20951038, 22168163, 25161298 -20569094, 24308635, 19791377, 19050649, 20920911, 22475617, 19189525 -19469538, 27052607, 20598042, 22458049, 18988834, 21159665, 23302839 -25307368, 25699321, 17409174, 22729345, 22842151, 19238590, 25051465 -16941434, 20387265, 24397438, 29378913, 20673810, 23108128, 20356733 -22380919, 18436647, 23065323, 20825533, 19124336, 22294260, 24790914 -20284155, 23571055, 25539063, 17365043, 25914276, 20952966, 22961508 -19176223, 21300341, 23237313, 18288842, 27223075, 22353199, 20011515 -22083366, 27634991, 25670786, 21419850, 26898563, 27986817, 19577410 -26248143, 23294548, 23101501, 24737064, 19931709, 25423453, 25547060 -23533807, 27726780, 24600330, 25600421, 18122373, 20043616, 23124895 -18856999, 21450666, 18893947, 26633558, 20076781, 26029780, 21196809 -21354456, 22533631, 23725036, 20464614, 19562381, 27375542, 24808595 -19189317, 25669791, 18307021, 21917884, 19708632, 27213224, 25633101 -29006527, 20711718, 18973548, 25982666, 19718981, 23567857, 22826718 -25655390, 20684983, 21773465, 20250147, 20144019, 19197175, 26263721 -19597439, 21387128, 22007324, 19180770, 18818069, 21566639, 19879746 -21785691, 20424183, 24285405, 21425496, 26544823, 20322560, 22228324 -23172924, 22520320, 27751755, 21575362, 25058080, 22365117, 22645009 -25165496, 28950969, 18774543, 20124446, 21429602, 26153977, 29189889 -19371175, 21863727, 18940497, 19074147, 22923409, 25489342, 21380789 -19154375, 19044962, 25417056, 19532017, 19662635, 22374754, 20560611 -25654936, 21492036, 18705806, 28420042, 19578247, 22024071, 22238921 -22809871, 21184223, 19995869, 23089357, 19404068, 18921743, 19065677 -19018447, 19018206, 18308268, 19777862, 29027694, 22223463, 19304354 -22519146, 19445860, 26654363, 27199245, 22977256, 20890311, 27445727 -21142837, 20869721, 24555417, 22179537, 21756699, 20217801, 18819908 -22760595, 25483815, 23628685, 23007241, 19593445, 21080143, 27351628 -20582405, 24966594, 20031873, 25489367, 18618122, 24737581, 21698350 -26784509, 24739928, 18966843, 19077215, 20704450, 19068970, 20543011 -19023822, 24713381, 20432873, 21756677, 22836801, 20328248, 18674047 -18849537, 20087383, 25459958, 20315311, 22897344, 27534509, 25178179 -19308965, 18948177, 19468991, 20868862, 21780146, 23315153, 20466628 -21756661, 20397490, 19706965, 20302006, 24831514, 23240358, 22178855 -19032777, 20862087, 19329654, 18974476, 20603378, 20859910, 19307662 -26203182, 21847223, 20281121, 22568797, 19075256, 19076343, 18866977 -28026866, 29511611, 22808310, 25635149, 20844426, 20904530, 20441797 -21442094, 25079710, 24674955, 18840932, 18740837, 20294666, 25602488 -21517440, 22062517, 19180394, 27337759, 19174942, 20671094, 21889720 -19450116, 18411216, 20117253, 24386767, 20641666, 19931367, 25264559 -19930276, 22092979, 25616268, 21625179, 20879709, 23003979, 20165574 -28578164, 19272708, 19547370, 22624709, 23084507, 23184263, 20228093 -21281532, 25093872, 19805359, 26324206, 19461270, 19434529, 18799063 -20354900, 20378086, 29388020, 17008068, 21246723, 20831538, 20424899 -20361671, 18674024, 19689979, 24411921, 19873610, 16619249, 20562898 -21641414, 21091431, 19440586, 20001168, 22757364, 22175564, 20725343 -21241052, 19561643, 20736227, 19399918, 19195895, 20830459, 20017509 -18475439, 25790353, 21828126, 21665897, 25555252, 20746251, 22568177 -25764020, 25612095, 25357142, 23096938, 19067244, 18043064, 21329301 -18885870, 26243698, 26187943, 20324049, 19536415, 23709062, 28174827 -20446883, 27314206, 21299490, 25313154, 18628388, 21744290, 18254023 -25047724, 20591183, 27847259, 19185876, 18548433, 27207110, 22465352 -24385625, 24326444, 20402832, 19627012, 29200700, 20468401, 27441326 -27620950, 16863642, 19639483, 19315691, 27567477, 21479753, 19174521 -23177923, 20401975, 18306996, 18851894, 27034890, 20581111, 20318889 -20936731, 21060755, 25240188, 26828994, 22256560, 19188927, 23328639 -27229389, 20766180, 20229001, 24570598, 25475853, 21172913, 17655240 -21266085, 19028800, 29379978, 19035573, 19366375, 24523374, 25599425 -25034396, 19289642, 21502702, 21291274, 18007682, 23521523, 20475845 -29408136, 22148226, 22528741, 25417958, 24652769, 26088426, 19326908 -19597583, 17414008, 23019710, 20897759, 26822620, 22046677, 19663176 -20938170, 19891090, 24825843, 26318627, 21960504, 24509056, 19054077 -26262953, 22657942, 20428621, 21899588, 23326313, 19723336, 19835133 -17532734, 25300427, 19333670, 17495022, 21842017, 19285025, 21373473 -23260854, 23061453, 19687159, 14643995, 20977794, 20734332, 17551063 -27548131, 21977392, 24461826, 28612674, 19676012, 20588502, 23315889 -19520602, 23053606, 19841800, 20245930, 19001359, 21476308, 26546754 -19393542, 23533524, 21099555, 27995248, 25429959, 19141838, 19644859 -21915719, 19908836, 21421886, 19358317, 19524158, 23548817, 25861398 -20803014, 23025340, 19335438, 19058490, 23642282, 19207117, 18799993 -25919622, 26569225, 25986062, 20835241, 24662775, 19475971, 18967382 -20347562, 20348653, 19896336, 24812585, 20048359, 21896069, 20468490 -19524384, 25392535, 21147908, 21695575, 20440930, 25789277, 19171086 -24718260, 17867700, 19791273, 27397048, 21241829, 19591608, 22707244 -18419520, 22296366, 22654475, 18914624, 19571367, 28636676, 21522582 -19501299, 26007010, 19529868, 20425790, 19708342, 27997875, 16870214 -18202441, 24415926, 18743542, 19001390, 21157728, 20657411, 19332396 -21875360, 22606521, 25091141, 28000269, 19149990, 20382309, 22855193 -16777441, 19606174, 20848335, 25495682, 19382851, 20528052, 22762046 -24563422, 23125826, 22503297, 28993590, 25192729, 23338911, 22730454 -19354794, 20757079, 19176326, 20298413, 19048007, 22018363, 18849970 -21532755, 20860659, 22905130, 26121990, 21263635, 27710072, 22160989 -23209741, 18499088, 22894949, 21059919, 18952989, 27348081, 22518784 -25856821, 24457597, 25484507, 20794034, 21061354, 20554364, 19468347 -17533661, 19883092, 20657441, 24401351, 21285458, 28023399, 18051556 -25330273, 26412540, 19699191, 24437510, 16875041, 20669434, 18964978 -22972770, 20828947, 21373076, 25492379, 25551676, 14283239, 25766822 -21967197, 22922076, 25575628, 19601762, 26110259, 20368850, 21239530 -20437153, 24848928, 20880215, 20798891, 25606091, 19013183, 25042823 -21133343, 22695831, 24365589, 25248384, 25634317, 20134113, 19587324 -20273319, 28501075, 18542562, 19017309, 26758193, 21063322, 22062026 -20134339, 22077517, 22815955, 23854396, 24690216, 22507210, 16354467 -20101006, 21795111, 27938623, 23501901, 18797519, 25997810, 25879984 -21260397, 25029423, 19354335, 19730508, 22366558, 26658759, 25822410 -6599380, 20717359, 24321547, 27097854, 21297872, 18964939, 19871910 -29437712, 26366517, 21913183, 22366322, 20171986, 25695903, 20603431 -21132297, 25957038, 21542577, 22507234, 23170620, 24719736, 25600342 -18868646, 28587723, 29142109, 26637824, 20627866, 18110491, 16923858 -24642295, 19518079, 19339555, 20466322, 25823754, 25110233, 20169408 -24908321, 20842388, 17274537, 26575788, 20474192, 21644640, 28849751 -21794615, 18899974, 20471920, 22806698, 19052488, 26198757, 19503821 -24350620, 20074391, 19157754, 21220620, 22495062, 24316947, 19865345 -19065556, 22816287, 25947799, 20878790, 23492665, 21322887, 22305887 -20879889, 24350831, 19578350, 28022101, 26439748, 21893235, 19363645 -21072646, 20898391, 19291380, 27060167, 18382302, 27086138, 22536802 -22087683, 21197626, 21656630, 20373598, 19248799, 22707866, 28432129 -19155797, 19279273, 18886413, 25490238, 20922010, 19990037, 25150925 -20509482, 27255377, 24717859, 20703000, 22862134, 21526048, 28683167 -24929210, 24560906, 20144308, 21620471, 19670108, 19068610, 20267166 -25123585, 20476175, 18549238, 19297917, 22950945, 19385656, 23528412 -19684504, 19330795, 21174504, 28357401, 20899461, 20557786, 21911701 -19143550, 20118035, 19024808, 25760195, 20009833, 19604659, 16359751 -26039623, 22820579, 19928926, 23314180, 20212067, 24737403, 20480209 -18904062, 29030780, 26430737, 20856766, 17258582, 27169796, 21668627 -20877664, 23272045, 19487147, 23149541, 24577566, 19430401, 19676905 -20925795, 26482376, 21296029, 21629064, 23229229, 22865673, 20708701 -25353983, 19280225, 21315084, 20613079, 19375649, 19213447, 19989009 -18191823, 27314390, 26336977, 25775213, 24393981, 25639019, 17319928 -14705949, 19703301, 28390273, 21626377, 20122715, 6418158, 23105538 -26198926, 19258504, 21188532, 23151677, 24792678, 17890099, 21649497 -26446098, 16887946, 26024732, 18791688, 19721304, 27012701, 19490948 -19619732, 21164318, 23148260, 18090142, 21641760, 19818513, 23002524 -20139391, 24693382, 19978542, 23543183, 22165897, 19373893, 22359063 -19409212, 18373438, 23035249, 20677974, 18990693, 20470877, 21422580 -21632821, 22351572, 20235511, 23220453, 18742258, 18604493, 23008056 -22901797, 18610915, 20978259, 20832516, 24801152, 26089440, 20907061 -19523462, 20505778, 19183343, 21787056, 21273804, 22782647, 25093739 -17835294, 28708023, 24413809, 27846298, 18371441, 26714910, 24385983 -20413820, 24421668, 28986231, 25897615, 25643931, 23195445, 21281607 -20513399, 20558005, 20093776, 18909599, 20618595, 23572982, 19211433 -20331945, 19512341, 22256431, 19637186, 19022470, 18607546, 26875822 -24573817, 23115139, 19649152, 19201867, 21294938, 20898997, 18510194 -21842740, 22454326, 24683149, 19534363, 25489607, 23061702 -``` - -### Version 12\.1\.0\.2\.v16 - -Version 12\.1\.0\.2\.v16 includes the following: -+ Patch 29141015: Database Patch Set Update: 12\.1\.0\.2\.190416 -+ Patch 29251241: OJVM PATCH SET UPDATE 12\.1\.0\.2\.190416 -+ Patch 28852325: DSTv33 for RDBMS \(TZDATA2018G\) -+ Patch 28852334: DSTv33 for OJVM \(TZDATA2018G\) -+ Patch 17969866: Oracle GoldenGate \- Oracle RDBMS Server Recommended Patches -+ Patch 20394750: Oracle GoldenGate \- Oracle RDBMS Server Recommended Patches -+ Patch 24835919: Oracle GoldenGate \- Oracle RDBMS Server Recommended Patches -+ Patch 21171382: DBMS\_STATS Patch -+ Patch 21091901: ONLINE MOVE OF HASH OR REF PARTITION CAN LEAVE LOCAL INDEXES INCONSISTENT -+ Patch 29600862: JSON bundle patch -+ Patch 20033733: PART :IMC:HIT ORA 600 \[KGL\-HEAP\-SIZE\-EXCEEDED\] -+ Patch 28730253: SUPPORT NEW ERA REIWA FOR JAPANESE IMPERIAL CALENDAR - -#### Oracle patch 22785785, released April 2019 - -Bugs fixed: - -``` -19309466, 19902195, 18250893, 25437699, 19383839, 19781326, 16756406 -18456643, 26546664, 22364044, 18845653, 19915271, 20172151, 18417036 -19516448, 23713236, 24796092, 23140259, 19243521, 19658708, 18272672 -21153266, 19174430, 22243719, 26556014, 20493163, 20688221, 21387964 -13542050, 22734547, 22243983, 21623164, 19012119, 19932634, 19869255 -22232606, 18681056, 23324000, 25427662, 22068305, 24589081, 19439759 -19303936, 22916353, 24835538, 22353346, 21106027, 19790243, 26444887 -23088803, 22529728, 26256131, 19134173, 20447445, 21188584, 19390567 -26513709, 25780343, 19769480, 21097043, 21225209, 26245237, 20677396 -19284031, 19450314, 19016730, 20919320, 22517782, 22075064, 22551446 -22721409, 18440095, 22496904, 16439813, 18354830, 20596234, 22022760 -20936905, 23197103, 21514877, 21186167, 26111842, 18990023, 13787015 -22492533, 20173897, 24624166, 17210525, 21260431, 20181030, 25056052 -19370504, 21868720, 23068169, 19124589, 21383171, 19402853, 19888853 -24341675, 17722075, 20882568, 25653109, 23026585, 18604692, 20717081 -25546608, 27370965, 19081128, 22173980, 23514710, 25722055, 19178851 -20951038, 22168163, 25161298, 20569094, 24308635, 19791377, 19050649 -20920911, 22475617, 19189525, 19469538, 27052607, 20598042, 22458049 -18988834, 23302839, 25307368, 17409174, 22729345, 22842151, 19238590 -16941434, 20387265, 24397438, 20673810, 23108128, 20356733, 22380919 -18436647, 23065323, 20825533, 19124336, 22294260, 24790914, 20284155 -23571055, 25539063, 17365043, 25914276, 20952966, 22961508, 19176223 -21300341, 23237313, 18288842, 27223075, 22353199, 20011515, 22083366 -25670786, 27634991, 21419850, 26898563, 19577410, 27986817, 26248143 -23294548, 24737064, 23101501, 19931709, 25423453, 25547060, 23533807 -27726780, 24600330, 25600421, 18122373, 20043616, 23124895, 18856999 -21450666, 18893947, 26633558, 20076781, 26029780, 21196809, 21354456 -23725036, 20464614, 22533631, 19562381, 27375542, 24808595, 19189317 -25669791, 18307021, 21917884, 19708632, 27213224, 25633101, 20711718 -29006527, 18973548, 25982666, 19718981, 23567857, 22826718, 25655390 -21773465, 20250147, 20144019, 19197175, 26263721, 19597439, 21387128 -22007324, 19180770, 19879746, 21785691, 20424183, 24285405, 26544823 -20322560, 22228324, 23172924, 22520320, 21575362, 27751755, 25058080 -22365117, 22645009, 25165496, 28950969, 18774543, 20124446, 21429602 -26153977, 19371175, 21863727, 18940497, 19074147, 22923409, 25489342 -21380789, 19154375, 19044962, 19532017, 19662635, 22374754, 20560611 -25654936, 21492036, 18705806, 28420042, 19578247, 22024071, 22238921 -22809871, 21184223, 19995869, 23089357, 19404068, 18921743, 19065677 -19018447, 19018206, 18308268, 19777862, 22223463, 19304354, 29027694 -22519146, 27199245, 19445860, 26654363, 22977256, 20890311, 27445727 -21142837, 20869721, 24555417, 22179537, 21756699, 20217801, 18819908 -22760595, 25483815, 23628685, 23007241, 19593445, 21080143, 27351628 -20582405, 20031873, 25489367, 18618122, 24737581, 26784509, 24739928 -18966843, 19077215, 20704450, 19068970, 20543011, 19023822, 24713381 -20432873, 21756677, 20328248, 18674047, 18849537, 20087383, 25459958 -20315311, 22897344, 27534509, 25178179, 19308965, 18948177, 19468991 -20868862, 21780146, 23315153, 20466628, 21756661, 20397490, 19706965 -20302006, 24831514, 23240358, 22178855, 19032777, 20862087, 19329654 -18974476, 20603378, 20859910, 19307662, 21847223, 20281121, 22568797 -19075256, 19076343, 18866977, 22808310, 25635149, 20844426, 20904530 -20441797, 21442094, 25079710, 24674955, 18840932, 18740837, 20294666 -25602488, 21517440, 22062517, 27337759, 19174942, 19180394, 20671094 -21889720, 18411216, 20117253, 24386767, 20641666, 25264559, 22092979 -25616268, 21625179, 20879709, 23003979, 20165574, 28578164, 19272708 -19547370, 22624709, 23084507, 23184263, 20228093, 21281532, 25093872 -19805359, 19461270, 26324206, 19434529, 18799063, 20378086, 17008068 -21246723, 20831538, 20424899, 20361671, 18674024, 19689979, 24411921 -19873610, 16619249, 20562898, 21641414, 21091431, 19440586, 22757364 -20001168, 22175564, 20725343, 21241052, 19561643, 20736227, 19399918 -19195895, 20830459, 20017509, 18475439, 25790353, 21828126, 21665897 -25555252, 20746251, 22568177, 25764020, 25612095, 25357142, 23096938 -19067244, 18043064, 21329301, 18885870, 26243698, 26187943, 20324049 -19536415, 23709062, 28174827, 20446883, 27314206, 21299490, 25313154 -18628388, 21744290, 18254023, 25047724, 20591183, 27847259, 19185876 -27207110, 22465352, 24385625, 24326444, 20402832, 19627012, 20468401 -27441326, 27620950, 16863642, 19639483, 19315691, 27567477, 21479753 -19174521, 20401975, 18306996, 18851894, 27034890, 20581111, 20318889 -20936731, 21060755, 25240188, 26828994, 22256560, 19188927, 27229389 -20766180, 20229001, 24570598, 25475853, 21172913, 17655240, 21266085 -19028800, 19035573, 19366375, 24523374, 25599425, 25034396, 19289642 -21502702, 21291274, 18007682, 23521523, 20475845, 22148226, 22528741 -29408136, 25417958, 24652769, 26088426, 19326908, 19597583, 17414008 -23019710, 20897759, 26822620, 22046677, 19663176, 20938170, 19891090 -24825843, 26318627, 21960504, 24509056, 19054077, 26262953, 22657942 -20428621, 21899588, 23326313, 19723336, 19835133, 17532734, 19333670 -25300427, 21842017, 19285025, 21373473, 23260854, 23061453, 19687159 -14643995, 20977794, 20734332, 17551063, 27548131, 21977392, 24461826 -19676012, 20588502, 23315889, 19520602, 23053606, 19841800, 20245930 -19001359, 21476308, 26546754, 19393542, 23533524, 21099555, 27995248 -25429959, 19141838, 19644859, 21915719, 19908836, 21421886, 19358317 -19524158, 23548817, 25861398, 20803014, 23025340, 19335438, 19058490 -23642282, 19207117, 18799993, 25919622, 26569225, 20835241, 25986062 -24662775, 19475971, 18967382, 20347562, 20348653, 19896336, 24812585 -20048359, 21896069, 20468490, 19524384, 25392535, 21147908, 20440930 -25789277, 19171086, 24718260, 17867700, 19791273, 27397048, 21241829 -19591608, 22707244, 18419520, 22296366, 22654475, 18914624, 19571367 -28636676, 21522582, 19501299, 19529868, 20425790, 26007010, 19708342 -27997875, 16870214, 18202441, 24415926, 18743542, 19001390, 21157728 -19332396, 21875360, 25091141, 28000269, 19149990, 20382309, 22855193 -16777441, 19606174, 20848335, 25495682, 19382851, 20528052, 22762046 -24563422, 23125826, 22503297, 28993590, 25192729, 23338911, 22730454 -19176326, 20298413, 19048007, 18849970, 21532755, 20860659, 22905130 -26121990, 21263635, 22160989, 18499088, 22894949, 21059919, 18952989 -22518784, 27348081, 25856821, 24457597, 25484507, 20794034, 21061354 -19468347, 17533661, 19883092, 20657441, 24401351, 21285458, 18051556 -25330273, 28023399, 26412540, 19699191, 24437510, 20669434, 16875041 -18964978, 22972770, 20828947, 21373076, 25492379, 25551676, 14283239 -25766822, 21967197, 22922076, 25575628, 26110259, 20368850, 21239530 -20437153, 24848928, 20880215, 20798891, 25606091, 19013183, 21133343 -22695831, 24365589, 25634317, 19587324, 20134113, 20273319, 18542562 -26758193, 19017309, 21063322, 22062026, 20134339, 22077517, 22815955 -23854396, 24690216, 22507210, 16354467, 20101006, 21795111, 27938623 -23501901, 18797519, 25879984, 21260397, 25029423, 19354335, 19730508 -22366558, 26658759, 25822410, 6599380, 20717359, 24321547, 27097854 -21297872, 18964939, 26366517, 21913183, 22366322, 20171986, 20603431 -21132297, 25957038, 21542577, 22507234, 23170620, 24719736, 25600342 -18868646, 26637824, 20627866, 28587723, 29142109, 18110491, 16923858 -24642295, 19518079, 20466322, 19339555, 25823754, 25110233, 24908321 -20842388, 17274537, 26575788, 20474192, 21644640, 28849751, 21794615 -18899974, 20471920, 22806698, 19052488, 19503821, 24350620, 20074391 -19157754, 21220620, 24316947, 19865345, 19065556, 22816287, 25947799 -20878790, 23492665, 21322887, 22305887, 20879889, 24350831, 19578350 -28022101, 26439748, 21893235, 19363645, 21072646, 20898391, 19291380 -27060167, 27086138, 18382302, 22536802, 22087683, 21197626, 21656630 -20373598, 19248799, 22707866, 19155797, 19279273, 28432129, 18886413 -25490238, 20922010, 19990037, 25150925, 20509482, 27255377, 24717859 -20703000, 22862134, 21526048, 28683167, 24929210, 24560906, 20144308 -21620471, 19670108, 19068610, 20267166, 25123585, 20476175, 18549238 -22950945, 19385656, 23528412, 19684504, 21174504, 20899461, 20557786 -21911701, 19143550, 20118035, 19024808, 25760195, 20009833, 19604659 -16359751, 26039623, 19928926, 23314180, 20212067, 24737403, 20480209 -18904062, 26430737, 29030780, 20856766, 27169796, 21668627, 17258582 -20877664, 19487147, 23149541, 24577566, 19430401, 19676905, 20925795 -21296029, 21629064, 23229229, 22865673, 20708701, 25353983, 19280225 -21315084, 20613079, 19375649, 19213447, 19989009, 18191823, 27314390 -26336977, 25775213, 24393981, 25639019, 17319928, 14705949, 19703301 -21626377, 20122715, 6418158, 23105538, 26198926, 19258504, 21188532 -23151677, 17890099, 21649497, 26446098, 16887946, 26024732, 18791688 -19721304, 27012701, 19490948, 19619732, 21164318, 23148260, 18090142 -21641760, 19818513, 23002524, 20139391, 24693382, 19978542, 23543183 -22165897, 22359063, 19373893, 19409212, 18373438, 23035249, 18990693 -20470877, 21422580, 21632821, 22351572, 20235511, 23220453, 18742258 -18604493, 23008056, 22901797, 18610915, 20978259, 20832516, 24801152 -26089440, 20907061, 19523462, 20505778, 19183343, 21787056, 21273804 -22782647, 25093739, 17835294, 28708023, 24413809, 18371441, 26714910 -24385983, 20413820, 24421668, 25897615, 25643931, 23195445, 21281607 -20513399, 20558005, 20093776, 18909599, 20618595, 23572982, 19211433 -20331945, 19512341, 22256431, 19637186, 19022470, 18607546, 26875822 -24573817, 23115139, 19649152, 19201867, 21294938, 20898997, 18510194 -21842740, 22454326, 24683149, 19534363, 25489607 -``` - -### Version 12\.1\.0\.2\.v15 - -Version 12\.1\.0\.2\.v15 includes the following: -+ Patch 28729169: Oracle Database Patch Set Update 12\.1\.0\.2\.190115 -+ Patch 28790654: Oracle JVM Patch Set Update 12\.1\.0\.2\.190115 -+ Patch 28125601: DSTv32 for RDBMS \(TZDATA2018E\) -+ Patch 28127287: DSTv32 for OJVM \(TZDATA2018E\) -+ Patch 17969866: Oracle GoldenGate \- Oracle RDBMS Server Recommended Patches -+ Patch 20394750: Oracle GoldenGate \- Oracle RDBMS Server Recommended Patches -+ Patch 21171382: DBMS\_STATS Patch -+ Patch 29125200: JSON bundle patch -+ Patch 20033733: KGL heap size patch - -#### Oracle patch 28729169, released January 2019 - -Bugs fixed: - -``` -19309466, 19902195, 18250893, 25437699, 19383839, 16756406, 18456643 -26546664, 22364044, 18845653, 19915271, 20172151, 18417036, 23713236 -24796092, 23140259, 19243521, 19658708, 18272672, 21153266, 19174430 -22243719, 20493163, 20688221, 21387964, 13542050, 22734547, 21623164 -19012119, 19932634, 19869255, 22232606, 18681056, 23324000, 25427662 -22068305, 24589081, 19439759, 19303936, 22916353, 24835538, 22353346 -21106027, 26444887, 23088803, 22529728, 26256131, 19134173, 20447445 -21188584, 19390567, 26513709, 25780343, 19769480, 21097043, 21225209 -26245237, 20677396, 19284031, 19450314, 19016730, 20919320, 22075064 -22551446, 22721409, 18440095, 22496904, 16439813, 18354830, 20596234 -22022760, 20936905, 23197103, 21514877, 26111842, 18990023, 13787015 -22492533, 20173897, 24624166, 17210525, 21260431, 20181030, 25056052 -19370504, 21868720, 23068169, 19124589, 19402853, 21383171, 19888853 -24341675, 17722075, 20882568, 25653109, 23026585, 18604692, 20717081 -25546608, 27370965, 19081128, 22173980, 23514710, 19178851, 20951038 -22168163, 25161298, 20569094, 24308635, 19791377, 19050649, 20920911 -19189525, 22475617, 19469538, 27052607, 20598042, 22458049, 18988834 -23302839, 25307368, 17409174, 22729345, 22842151, 19238590, 16941434 -20387265, 24397438, 20673810, 23108128, 20356733, 22380919, 18436647 -23065323, 20825533, 19124336, 22294260, 24790914, 20284155, 23571055 -25539063, 17365043, 25914276, 20952966, 22961508, 19176223, 21300341 -23237313, 18288842, 22353199, 27223075, 22083366, 25670786, 21419850 -26898563, 19577410, 26248143, 23294548, 24737064, 19931709, 25423453 -25547060, 23533807, 27726780, 24600330, 25600421, 18122373, 20043616 -23124895, 18856999, 21450666, 18893947, 26633558, 20076781, 26029780 -21196809, 21354456, 23725036, 20464614, 19562381, 27375542, 24808595 -19189317, 25669791, 18307021, 21917884, 19708632, 27213224, 25633101 -20711718, 18973548, 25982666, 19718981, 23567857, 22826718, 25655390 -21773465, 20250147, 20144019, 19197175, 26263721, 19597439, 21387128 -22007324, 19180770, 19879746, 21785691, 20424183, 24285405, 26544823 -20322560, 22228324, 23172924, 22520320, 21575362, 25058080, 22365117 -22645009, 25165496, 28950969, 18774543, 20124446, 21429602, 26153977 -19371175, 21863727, 18940497, 19074147, 22923409, 25489342, 21380789 -19154375, 19044962, 19532017, 19662635, 22374754, 20560611, 25654936 -21492036, 18705806, 19578247, 22024071, 22238921, 22809871, 21184223 -23089357, 19404068, 18921743, 19065677, 19018447, 19018206, 18308268 -19777862, 22223463, 19304354, 22519146, 27199245, 22977256, 20890311 -27445727, 21142837, 20869721, 24555417, 22179537, 21756699, 20217801 -18819908, 22760595, 25483815, 23628685, 23007241, 19593445, 21080143 -27351628, 20031873, 25489367, 18618122, 24737581, 26784509, 24739928 -18966843, 19077215, 20704450, 19068970, 20543011, 19023822, 24713381 -20432873, 21756677, 20328248, 18674047, 18849537, 20087383, 25459958 -20315311, 22897344, 27534509, 25178179, 19308965, 18948177, 19468991 -20868862, 21780146, 23315153, 20466628, 21756661, 20397490, 19706965 -20302006, 24831514, 23240358, 22178855, 19032777, 20862087, 19329654 -18974476, 20603378, 20859910, 19307662, 21847223, 20281121, 19075256 -22568797, 19076343, 18866977, 22808310, 25635149, 20844426, 20904530 -20441797, 21442094, 25079710, 24674955, 18840932, 18740837, 20294666 -25602488, 21517440, 22062517, 27337759, 19174942, 20671094, 21889720 -18411216, 20117253, 24386767, 20641666, 25264559, 22092979, 25616268 -21625179, 20879709, 23003979, 20165574, 19272708, 19547370, 22624709 -23084507, 20228093, 21281532, 25093872, 19805359, 19461270, 19434529 -18799063, 20378086, 17008068, 21246723, 20831538, 20424899, 20361671 -18674024, 19689979, 24411921, 19873610, 16619249, 20562898, 21641414 -21091431, 19440586, 22757364, 22175564, 20725343, 21241052, 19561643 -20736227, 19399918, 19195895, 20830459, 20017509, 18475439, 25790353 -21828126, 21665897, 25555252, 20746251, 25764020, 25612095, 22568177 -25357142, 23096938, 19067244, 18043064, 21329301, 18885870, 26243698 -26187943, 20324049, 19536415, 23709062, 28174827, 20446883, 27314206 -21299490, 25313154, 21744290, 18254023, 20591183, 25047724, 27847259 -19185876, 27207110, 22465352, 24326444, 20402832, 19627012, 20468401 -27441326, 27620950, 16863642, 19639483, 19315691, 27567477, 21479753 -19174521, 20401975, 18306996, 18851894, 27034890, 20581111, 20318889 -20936731, 21060755, 25240188, 26828994, 22256560, 19188927, 27229389 -24570598, 20229001, 25475853, 21172913, 17655240, 21266085, 19028800 -19035573, 19366375, 24523374, 25034396, 25599425, 19289642, 21291274 -18007682, 23521523, 20475845, 22148226, 22528741, 25417958, 24652769 -26088426, 19326908, 19597583, 17414008, 23019710, 20897759, 26822620 -22046677, 20938170, 19891090, 24825843, 26318627, 21960504, 24509056 -19054077, 26262953, 22657942, 20428621, 21899588, 23326313, 19723336 -19835133, 17532734, 19333670, 21842017, 19285025, 21373473, 23260854 -23061453, 19687159, 14643995, 20977794, 20734332, 17551063, 27548131 -21977392, 24461826, 19676012, 20588502, 23315889, 19520602, 23053606 -19841800, 20245930, 19001359, 21476308, 26546754, 19393542, 23533524 -21099555, 27995248, 25429959, 19141838, 19644859, 21915719, 19908836 -21421886, 19358317, 19524158, 23548817, 25861398, 20803014, 23025340 -19335438, 19058490, 23642282, 19207117, 18799993, 25919622, 26569225 -20835241, 24662775, 19475971, 18967382, 20347562, 20348653, 19896336 -24812585, 20048359, 21896069, 19524384, 20468490, 25392535, 21147908 -20440930, 25789277, 19171086, 24718260, 17867700, 19791273, 21241829 -27397048, 19591608, 22707244, 18419520, 22296366, 22654475, 18914624 -19571367, 28636676, 21522582, 19501299, 20425790, 19529868, 19708342 -27997875, 16870214, 18202441, 24415926, 18743542, 19001390, 21875360 -25091141, 28000269, 19149990, 20382309, 22855193, 16777441, 19606174 -20848335, 25495682, 19382851, 20528052, 22762046, 24563422, 23125826 -22503297, 28993590, 25192729, 23338911, 22730454, 19176326, 19048007 -18849970, 21532755, 20860659, 22905130, 26121990, 21263635, 22160989 -18499088, 22894949, 21059919, 18952989, 22518784, 25856821, 25484507 -20794034, 19468347, 17533661, 19883092, 20657441, 24401351, 21285458 -18051556, 25330273, 26412540, 19699191, 24437510, 20669434, 18964978 -22972770, 20828947, 21373076, 25492379, 25551676, 14283239, 25766822 -21967197, 22922076, 25575628, 26110259, 20368850, 21239530, 20437153 -24848928, 20880215, 20798891, 25606091, 19013183, 21133343, 22695831 -24365589, 25634317, 19587324, 20273319, 18542562, 26758193, 21063322 -22062026, 20134339, 22077517, 22815955, 24690216, 22507210, 16354467 -20101006, 21795111, 27938623, 23501901, 18797519, 25879984, 21260397 -25029423, 19354335, 19730508, 22366558, 26658759, 25822410, 6599380 -20717359, 24321547, 21297872, 27097854, 18964939, 26366517, 21913183 -22366322, 20171986, 20603431, 21132297, 25957038, 21542577, 22507234 -23170620, 24719736, 25600342, 18868646, 26637824, 20627866, 18110491 -16923858, 24642295, 19518079, 20466322, 25823754, 25110233, 24908321 -20842388, 17274537, 26575788, 20474192, 21644640, 21794615, 18899974 -20471920, 22806698, 19052488, 19503821, 24350620, 20074391, 19157754 -21220620, 24316947, 19865345, 19065556, 22816287, 25947799, 20878790 -23492665, 21322887, 22305887, 20879889, 24350831, 19578350, 28022101 -19363645, 21072646, 20898391, 19291380, 27060167, 27086138, 22536802 -22087683, 21656630, 20373598, 19248799, 22707866, 19155797, 19279273 -18886413, 25490238, 20922010, 19990037, 25150925, 20509482, 24717859 -20703000, 22862134, 21526048, 24929210, 24560906, 28683167, 20144308 -21620471, 19670108, 19068610, 20267166, 25123585, 20476175, 18549238 -22950945, 19385656, 23528412, 19684504, 21174504, 20899461, 20557786 -21911701, 19143550, 20118035, 19024808, 25760195, 20009833, 19604659 -16359751, 26039623, 19928926, 23314180, 20212067, 24737403, 20480209 -26430737, 20856766, 27169796, 21668627, 20877664, 19487147, 23149541 -24577566, 19430401, 19676905, 20925795, 21296029, 21629064, 23229229 -22865673, 20708701, 25353983, 19280225, 21315084, 20613079, 19375649 -19213447, 19989009, 18191823, 27314390, 25775213, 26336977, 24393981 -25639019, 17319928, 19703301, 21626377, 20122715, 6418158, 23105538 -26198926, 19258504, 21188532, 23151677, 17890099, 21649497, 26446098 -16887946, 26024732, 18791688, 19721304, 27012701, 19490948, 19619732 -21164318, 23148260, 18090142, 21641760, 19818513, 20139391, 24693382 -19978542, 23543183, 22165897, 22359063, 19409212, 23035249, 18990693 -20470877, 21422580, 21632821, 22351572, 20235511, 23220453, 18604493 -18742258, 23008056, 22901797, 18610915, 20978259, 20832516, 24801152 -26089440, 20907061, 20505778, 19183343, 21787056, 21273804, 25093739 -17835294, 24413809, 28708023, 18371441, 26714910, 24385983, 20413820 -24421668, 25897615, 25643931, 23195445, 21281607, 20513399, 20558005 -20093776, 18909599, 20618595, 23572982, 19211433, 20331945, 19512341 -22256431, 19637186, 19022470, 18607546, 24573817, 23115139, 19649152 -19201867, 21294938, 20898997, 18510194, 21842740, 22454326, 24683149 -19534363, 25489607 -``` - -### Version 12\.1\.0\.2\.v14 - -Version 12\.1\.0\.2\.v14 includes the following: -+ Patch 28259833: Oracle Database Patch Set Update 12\.1\.0\.2\.181016 -+ Patch 28440711: Oracle JVM Patch Set Update 12\.1\.0\.2\.181016 -+ Patch 28125601: DSTv32 for RDBMS \(TZDATA2018E\) -+ Patch 28127287: DSTv32 for OJVM \(TZDATA2018E\) -+ Patch 17969866: Oracle GoldenGate \- Oracle RDBMS Server Recommended Patches -+ Patch 20394750: Oracle GoldenGate \- Oracle RDBMS Server Recommended Patches -+ Patch 21171382: DBMS\_STATS Patch -+ Patch 28697469: JSON Database Patch -+ Patch 20033733: KGL heap size patch - -#### Oracle patch 28259833, released October 2018 - -Bugs fixed: - -``` -19309466, 19902195, 18250893, 25437699, 19383839, 16756406, 18456643 -26546664, 22364044, 18845653, 19915271, 20172151, 18417036, 23713236 -24796092, 23140259, 19243521, 19658708, 18272672, 21153266, 19174430 -22243719, 20688221, 20493163, 21387964, 13542050, 22734547, 21623164 -19012119, 19932634, 19869255, 22232606, 18681056, 23324000, 25427662 -22068305, 24589081, 19439759, 19303936, 22916353, 24835538, 22353346 -21106027, 26444887, 23088803, 22529728, 26256131, 19134173, 20447445 -21188584, 19390567, 26513709, 25780343, 19769480, 21097043, 21225209 -26245237, 20677396, 19284031, 19450314, 19016730, 20919320, 22075064 -22551446, 22721409, 18440095, 22496904, 16439813, 18354830, 20596234 -22022760, 20936905, 23197103, 21514877, 26111842, 18990023, 22492533 -20173897, 24624166, 17210525, 21260431, 20181030, 25056052, 19370504 -21868720, 23068169, 19124589, 19402853, 19888853, 24341675, 17722075 -20882568, 25653109, 23026585, 18604692, 20717081, 25546608, 27370965 -19081128, 22173980, 23514710, 19178851, 20951038, 22168163, 25161298 -20569094, 24308635, 19791377, 19050649, 20920911, 19189525, 19469538 -27052607, 20598042, 22458049, 18988834, 23302839, 25307368, 17409174 -22729345, 22842151, 19238590, 16941434, 20387265, 24397438, 20673810 -23108128, 20356733, 22380919, 18436647, 23065323, 20825533, 19124336 -22294260, 24790914, 20284155, 25539063, 17365043, 25914276, 20952966 -22961508, 19176223, 21300341, 23237313, 18288842, 22353199, 22083366 -25670786, 21419850, 26898563, 19577410, 23294548, 24737064, 19931709 -25423453, 25547060, 23533807, 27726780, 24600330, 25600421, 18122373 -20043616, 23124895, 18856999, 21450666, 18893947, 20076781, 26633558 -26029780, 21196809, 21354456, 23725036, 20464614, 19562381, 24808595 -27375542, 19189317, 25669791, 18307021, 21917884, 19708632, 27213224 -25633101, 20711718, 18973548, 25982666, 19718981, 22826718, 25655390 -23567857, 21773465, 20250147, 19197175, 26263721, 19597439, 21387128 -22007324, 19180770, 19879746, 21785691, 20424183, 24285405, 26544823 -20322560, 22228324, 23172924, 22520320, 21575362, 25058080, 22365117 -22645009, 25165496, 18774543, 20124446, 21429602, 26153977, 19371175 -21863727, 18940497, 19074147, 22923409, 25489342, 21380789, 19154375 -19044962, 19532017, 19662635, 22374754, 20560611, 25654936, 21492036 -18705806, 19578247, 22024071, 22238921, 22809871, 21184223, 23089357 -19404068, 18921743, 19065677, 19018447, 19018206, 18308268, 19777862 -22223463, 19304354, 22519146, 27199245, 20890311, 22977256, 21142837 -20869721, 24555417, 22179537, 21756699, 20217801, 18819908, 22760595 -25483815, 23007241, 19593445, 21080143, 27351628, 20031873, 18618122 -24737581, 26784509, 24739928, 18966843, 19077215, 20704450, 19068970 -20543011, 19023822, 24713381, 20432873, 21756677, 20328248, 18674047 -18849537, 25459958, 20315311, 22897344, 27534509, 25178179, 19308965 -18948177, 19468991, 20868862, 21780146, 20466628, 21756661, 20397490 -23315153, 19706965, 20302006, 24831514, 23240358, 22178855, 19032777 -20862087, 19329654, 18974476, 20603378, 20859910, 19307662, 21847223 -20281121, 19075256, 19076343, 18866977, 22808310, 25635149, 20844426 -20904530, 20441797, 21442094, 25079710, 24674955, 18840932, 18740837 -20294666, 25602488, 21517440, 22062517, 27337759, 19174942, 20671094 -21889720, 18411216, 20117253, 24386767, 20641666, 25264559, 22092979 -21625179, 20879709, 23003979, 20165574, 19272708, 19547370, 22624709 -23084507, 20228093, 21281532, 19805359, 19461270, 19434529, 18799063 -20378086, 17008068, 21246723, 20831538, 20424899, 20361671, 18674024 -19689979, 24411921, 19873610, 16619249, 20562898, 21641414, 21091431 -19440586, 22757364, 22175564, 21241052, 20725343, 19561643, 20736227 -19399918, 19195895, 20830459, 20017509, 25790353, 21828126, 21665897 -25555252, 20746251, 25764020, 25612095, 25357142, 23096938, 19067244 -18043064, 21329301, 18885870, 26243698, 26187943, 20324049, 19536415 -23709062, 28174827, 20446883, 27314206, 21299490, 25313154, 21744290 -18254023, 20591183, 27847259, 19185876, 27207110, 22465352, 24326444 -20402832, 19627012, 27441326, 27620950, 16863642, 19639483, 19315691 -21479753, 19174521, 20401975, 18306996, 18851894, 27034890, 20581111 -20318889, 20936731, 21060755, 26828994, 22256560, 19188927, 27229389 -24570598, 25475853, 21172913, 17655240, 21266085, 19028800, 19035573 -19366375, 24523374, 25034396, 19289642, 21291274, 18007682, 23521523 -20475845, 22148226, 22528741, 25417958, 24652769, 26088426, 19326908 -19597583, 17414008, 23019710, 20897759, 26822620, 22046677, 20938170 -24825843, 19891090, 21960504, 26318627, 24509056, 19054077, 26262953 -22657942, 20428621, 21899588, 19723336, 19835133, 17532734, 19333670 -21842017, 19285025, 21373473, 23260854, 19687159, 23061453, 14643995 -20977794, 20734332, 17551063, 27548131, 21977392, 24461826, 19676012 -20588502, 23315889, 19520602, 23053606, 19841800, 20245930, 19001359 -21476308, 26546754, 19393542, 23533524, 21099555, 25429959, 19141838 -19644859, 21915719, 19908836, 21421886, 19358317, 19524158, 23548817 -25861398, 20803014, 23025340, 19335438, 19058490, 19207117, 23642282 -18799993, 25919622, 26569225, 20835241, 24662775, 19475971, 18967382 -20347562, 20348653, 19896336, 24812585, 20048359, 21896069, 19524384 -25392535, 21147908, 20440930, 25789277, 19171086, 24718260, 17867700 -19791273, 21241829, 19591608, 22707244, 18419520, 22296366, 18914624 -19571367, 22654475, 21522582, 19501299, 20425790, 19708342, 27997875 -16870214, 18202441, 24415926, 18743542, 19001390, 21875360, 25091141 -28000269, 19149990, 20382309, 22855193, 16777441, 19606174, 20848335 -25495682, 19382851, 20528052, 22762046, 24563422, 23125826, 22503297 -25192729, 23338911, 22730454, 19176326, 19048007, 18849970, 21532755 -20860659, 22905130, 21263635, 22160989, 18499088, 21059919, 18952989 -22894949, 22518784, 25856821, 25484507, 20794034, 19468347, 17533661 -19883092, 20657441, 24401351, 21285458, 18051556, 25330273, 19699191 -24437510, 20669434, 18964978, 22972770, 20828947, 21373076, 25551676 -25492379, 14283239, 25766822, 22922076, 25575628, 20368850, 21239530 -20437153, 24848928, 20880215, 20798891, 25606091, 19013183, 21133343 -22695831, 24365589, 25634317, 19587324, 20273319, 18542562, 26758193 -21063322, 22062026, 20134339, 22077517, 22815955, 24690216, 22507210 -20101006, 16354467, 21795111, 27938623, 23501901, 18797519, 25879984 -21260397, 25029423, 19354335, 19730508, 22366558, 26658759, 6599380 -20717359, 24321547, 21297872, 18964939, 26366517, 21913183, 22366322 -20171986, 20603431, 21132297, 25957038, 21542577, 22507234, 23170620 -24719736, 25600342, 18868646, 20627866, 26637824, 18110491, 16923858 -24642295, 19518079, 20466322, 25823754, 25110233, 24908321, 20842388 -17274537, 26575788, 20474192, 21644640, 21794615, 18899974, 20471920 -22806698, 19052488, 19503821, 24350620, 20074391, 19157754, 21220620 -24316947, 19865345, 19065556, 22816287, 25947799, 20878790, 23492665 -21322887, 22305887, 20879889, 24350831, 19578350, 19363645, 21072646 -20898391, 19291380, 27060167, 27086138, 22536802, 22087683, 21656630 -20373598, 19248799, 22707866, 19155797, 19279273, 18886413, 25490238 -20922010, 19990037, 25150925, 20509482, 24717859, 20703000, 22862134 -21526048, 24929210, 24560906, 20144308, 21620471, 19670108, 19068610 -20267166, 25123585, 20476175, 18549238, 22950945, 19385656, 23528412 -19684504, 21174504, 20899461, 20557786, 21911701, 19143550, 20118035 -19024808, 25760195, 20009833, 19604659, 16359751, 26039623, 19928926 -23314180, 20212067, 24737403, 20480209, 26430737, 20856766, 27169796 -21668627, 20877664, 19487147, 23149541, 24577566, 19430401, 19676905 -20925795, 21296029, 21629064, 23229229, 22865673, 20708701, 25353983 -19280225, 21315084, 19213447, 19989009, 18191823, 27314390, 25775213 -24393981, 25639019, 17319928, 19703301, 21626377, 20122715, 6418158 -23105538, 26198926, 19258504, 21188532, 23151677, 17890099, 21649497 -26446098, 16887946, 26024732, 18791688, 19721304, 19490948, 27012701 -19619732, 21164318, 18090142, 21641760, 19818513, 20139391, 24693382 -19978542, 23543183, 22165897, 22359063, 19409212, 23035249, 18990693 -20470877, 21422580, 21632821, 22351572, 20235511, 23220453, 18604493 -23008056, 22901797, 18610915, 20832516, 24801152, 26089440, 20907061 -20505778, 19183343, 21787056, 21273804, 25093739, 17835294, 24413809 -18371441, 26714910, 24385983, 20413820, 24421668, 25897615, 25643931 -23195445, 21281607, 20513399, 20558005, 20093776, 18909599, 20618595 -23572982, 19211433, 20331945, 19512341, 22256431, 19637186, 19022470 -18607546, 24573817, 19649152, 23115139, 19201867, 21294938, 20898997 -18510194, 21842740, 22454326, 24683149, 19534363, 25489607 -``` - -### Version 12\.1\.0\.2\.v13 - -Version 12\.1\.0\.2\.v13 includes the following: -+ Patch 27547329: Oracle Database Patch Set Update 12\.1\.0\.2\.180717 -+ Patch 27923320: Oracle JVM Patch Set Update 12\.1\.0\.2\.180717 -+ Patch 28125601: DSTv32 for RDBMS \(TZDATA2018E\) -+ Patch 28127287: DSTv32 for OJVM \(TZDATA2018E\) -+ Patch 17969866: Oracle GoldenGate \- Oracle RDBMS Server Recommended Patches -+ Patch 20394750: Oracle GoldenGate \- Oracle RDBMS Server Recommended Patches -+ Patch 21171382: DBMS\_STATS Patch -+ Patch 28307069: JSON Database Patch -+ Patch 20033733: KGL heap size patch - -#### Oracle patch 27547329, released July 2018 - -Bugs fixed: - -``` -19309466, 19902195, 18250893, 25437699, 19383839, 16756406, 18456643 -26546664, 18845653, 19915271, 20172151, 18417036, 23713236, 24796092 -19243521, 19658708, 21153266, 19174430, 22243719, 20688221, 21387964 -13542050, 22734547, 21623164, 19012119, 19932634, 19869255, 22232606 -18681056, 23324000, 25427662, 22068305, 24589081, 19439759, 19303936 -22916353, 24835538, 22353346, 21106027, 26444887, 23088803, 22529728 -26256131, 19134173, 20447445, 21188584, 19390567, 26513709, 19769480 -21097043, 21225209, 20677396, 19284031, 26245237, 19450314, 19016730 -20919320, 22075064, 22551446, 22721409, 18440095, 22496904, 16439813 -18354830, 20596234, 22022760, 20936905, 23197103, 21514877, 26111842 -18990023, 22492533, 20173897, 24624166, 17210525, 21260431, 20181030 -25056052, 19370504, 21868720, 23068169, 19124589, 19402853, 19888853 -24341675, 17722075, 20882568, 23026585, 25653109, 20717081, 25546608 -19081128, 27370965, 22173980, 19178851, 20951038, 22168163, 25161298 -20569094, 24308635, 19791377, 19050649, 20920911, 19189525, 19469538 -20598042, 22458049, 18988834, 17409174, 22729345, 22842151, 19238590 -16941434, 20387265, 24397438, 20673810, 23108128, 20356733, 22380919 -18436647, 23065323, 20825533, 19124336, 22294260, 24790914, 20284155 -25539063, 17365043, 20952966, 22961508, 19176223, 21300341, 23237313 -18288842, 22353199, 22083366, 21419850, 26898563, 19577410, 23294548 -19931709, 25423453, 25547060, 23533807, 24600330, 25600421, 18122373 -20043616, 23124895, 18856999, 21450666, 18893947, 20076781, 26029780 -21196809, 21354456, 20464614, 23725036, 19562381, 24808595, 19189317 -18307021, 25669791, 21917884, 19708632, 27213224, 25633101, 20711718 -18973548, 25982666, 22826718, 25655390, 21773465, 20250147, 19197175 -19597439, 26263721, 21387128, 19180770, 19879746, 21785691, 20424183 -24285405, 26544823, 20322560, 22228324, 22520320, 23172924, 21575362 -22365117, 22645009, 25165496, 18774543, 20124446, 21429602, 19371175 -21863727, 18940497, 19074147, 22923409, 21380789, 19154375, 19044962 -19532017, 19662635, 22374754, 20560611, 25654936, 21492036, 18705806 -19578247, 22024071, 22238921, 22809871, 21184223, 23089357, 19404068 -18921743, 19065677, 19018447, 19018206, 18308268, 19777862, 22223463 -19304354, 22519146, 27199245, 20890311, 21142837, 20869721, 24555417 -22179537, 21756699, 20217801, 18819908, 22760595, 25483815, 23007241 -19593445, 21080143, 20031873, 18618122, 26784509, 24739928, 18966843 -19077215, 20704450, 19068970, 20543011, 19023822, 24713381, 20432873 -21756677, 20328248, 18674047, 18849537, 25459958, 20315311, 22897344 -27534509, 25178179, 19308965, 18948177, 19468991, 20868862, 21780146 -20466628, 21756661, 20397490, 19706965, 24831514, 23240358, 22178855 -20302006, 19032777, 20862087, 19329654, 18974476, 20603378, 20859910 -19307662, 21847223, 20281121, 19075256, 19076343, 18866977, 20844426 -20904530, 20441797, 21442094, 25079710, 24674955, 18840932, 18740837 -20294666, 25602488, 21517440, 22062517, 27337759, 19174942, 20671094 -21889720, 18411216, 20117253, 24386767, 20641666, 25264559, 22092979 -21625179, 20879709, 23003979, 20165574, 19272708, 19547370, 22624709 -23084507, 20228093, 21281532, 19805359, 19461270, 19434529, 18799063 -20378086, 17008068, 21246723, 20831538, 20424899, 20361671, 18674024 -19689979, 24411921, 19873610, 16619249, 20562898, 21091431, 21641414 -19440586, 22757364, 22175564, 21241052, 19561643, 19399918, 19195895 -20830459, 20017509, 25790353, 21828126, 21665897, 20746251, 25764020 -25612095, 25357142, 23096938, 19067244, 18043064, 21329301, 18885870 -26187943, 20324049, 19536415, 20446883, 21299490, 27314206, 25313154 -21744290, 18254023, 20591183, 27847259, 19185876, 22465352, 27207110 -20402832, 19627012, 27441326, 27620950, 16863642, 19639483, 19315691 -21479753, 19174521, 20401975, 18306996, 18851894, 27034890, 20581111 -20318889, 20936731, 21060755, 22256560, 19188927, 24570598, 25475853 -21172913, 17655240, 21266085, 19028800, 19035573, 19366375, 24523374 -25034396, 19289642, 21291274, 18007682, 23521523, 20475845, 22148226 -22528741, 25417958, 24652769, 26088426, 19326908, 19597583, 17414008 -23019710, 20897759, 22046677, 20938170, 24825843, 21960504, 24509056 -19054077, 22657942, 26262953, 20428621, 21899588, 19723336, 19835133 -17532734, 19333670, 21842017, 19285025, 21373473, 23260854, 19687159 -14643995, 20977794, 20734332, 17551063, 27548131, 21977392, 24461826 -19676012, 20588502, 23315889, 19520602, 23053606, 19841800, 20245930 -19001359, 21476308, 26546754, 19393542, 23533524, 21099555, 25429959 -19141838, 19644859, 21915719, 19908836, 21421886, 19358317, 19524158 -23548817, 25861398, 20803014, 23025340, 19335438, 19058490, 19207117 -18799993, 26569225, 25919622, 20835241, 24662775, 19475971, 18967382 -20347562, 20348653, 19896336, 24812585, 20048359, 21896069, 19524384 -25392535, 20440930, 25789277, 19171086, 24718260, 17867700, 19791273 -21241829, 19591608, 22707244, 18419520, 22296366, 18914624, 19571367 -19501299, 20425790, 19708342, 27997875, 16870214, 18202441, 24415926 -18743542, 19001390, 21875360, 25091141, 19149990, 20382309, 22855193 -16777441, 19606174, 20848335, 25495682, 19382851, 20528052, 22762046 -24563422, 23125826, 22503297, 25192729, 23338911, 22730454, 19176326 -19048007, 18849970, 21532755, 20860659, 22905130, 21263635, 22160989 -18499088, 21059919, 18952989, 22518784, 25856821, 25484507, 20794034 -19468347, 17533661, 19883092, 20657441, 24401351, 21285458, 18051556 -25330273, 19699191, 24437510, 20669434, 18964978, 20828947, 21373076 -25551676, 14283239, 25766822, 22922076, 25575628, 20368850, 21239530 -20437153, 20880215, 20798891, 25606091, 19013183, 21133343, 22695831 -24365589, 19587324, 18542562, 26758193, 22062026, 20134339, 22077517 -22815955, 24690216, 22507210, 20101006, 21795111, 27938623, 23501901 -18797519, 21260397, 25029423, 19354335, 19730508, 22366558, 26658759 -6599380, 20717359, 24321547, 21297872, 18964939, 26366517, 21913183 -22366322, 20171986, 20603431, 21132297, 25957038, 21542577, 22507234 -23170620, 24719736, 25600342, 18868646, 20627866, 18110491, 16923858 -24642295, 19518079, 20466322, 25823754, 25110233, 24908321, 20842388 -17274537, 26575788, 20474192, 21644640, 21794615, 18899974, 20471920 -22806698, 19052488, 19503821, 24350620, 20074391, 19157754, 21220620 -24316947, 19865345, 19065556, 22816287, 25947799, 20878790, 23492665 -21322887, 20879889, 24350831, 19578350, 19363645, 21072646, 20898391 -19291380, 27060167, 27086138, 22536802, 22087683, 20373598, 19248799 -22707866, 19155797, 19279273, 18886413, 25490238, 20922010, 19990037 -25150925, 20509482, 24717859, 20703000, 22862134, 21526048, 24929210 -24560906, 20144308, 21620471, 19670108, 19068610, 20267166, 25123585 -20476175, 18549238, 22950945, 19385656, 23528412, 19684504, 21174504 -20899461, 20557786, 21911701, 19143550, 19024808, 20118035, 20009833 -25760195, 19604659, 16359751, 26039623, 19928926, 23314180, 20212067 -24737403, 20480209, 26430737, 27169796, 21668627, 20877664, 19487147 -23149541, 24577566, 19430401, 19676905, 20925795, 21296029, 21629064 -23229229, 22865673, 20708701, 19280225, 25353983, 21315084, 19213447 -19989009, 18191823, 24393981, 25639019, 17319928, 19703301, 21626377 -20122715, 6418158, 23105538, 26198926, 19258504, 21188532, 17890099 -21649497, 26446098, 16887946, 26024732, 18791688, 19721304, 19490948 -19619732, 21164318, 18090142, 21641760, 19818513, 20139391, 24693382 -19978542, 23543183, 22165897, 22359063, 19409212, 23035249, 18990693 -20470877, 21422580, 21632821, 22351572, 20235511, 23220453, 18604493 -23008056, 18610915, 20832516, 24801152, 26089440, 20907061, 20505778 -19183343, 21787056, 21273804, 25093739, 17835294, 24413809, 18371441 -24385983, 20413820, 26714910, 24421668, 25897615, 25643931, 21281607 -20513399, 23195445, 20558005, 20093776, 18909599, 20618595, 23572982 -19211433, 20331945, 19512341, 22256431, 19637186, 19022470, 18607546 -24573817, 19649152, 19201867, 21294938, 20898997, 18510194, 22454326 -19534363, 24683149, 25489607 -``` - -### Version 12\.1\.0\.2\.v12 - -Version 12\.1\.0\.2\.v12 includes the following: -+ Patch 27338041: DATABASE PATCH SET UPDATE 12\.1\.0\.2\.180417 -+ Patch 27475603: OJVM PATCH SET UPDATE 12\.1\.0\.2\.180417 -+ Patch 27015449: RDBMS \- PROACTIVE DSTV31 UPDATE \- TZDATA2017C -+ Patch 27015468: PROACTIVE DSTV31 UPDATE \- TZDATA2017C \- NEED OJVM FIX -+ Patch 17969866: Oracle GoldenGate \- Oracle RDBMS Server Recommended Patches -+ Patch 20394750: Oracle GoldenGate \- Oracle RDBMS Server Recommended Patches -+ Patch 21171382: AUTO DOP COMPUTES A HIGH DOP UNNECESSARILY -+ Patch 27666699: JSON Database Patch -+ Patch 20033733: PART :IMC:HIT ORA 600 \[KGL\-HEAP\-SIZE\-EXCEEDED\] - -#### Oracle patch 27338041, released April 2018 - -Bugs fixed: - -``` -19309466, 24570598, 25475853, 21172913, 19902195, 18250893, 17655240 -25437699, 19383839, 21266085, 19028800, 19035573, 16756406, 19366375 -18456643, 26546664, 24523374, 25034396, 19289642, 18845653, 19915271 -21291274, 18007682, 20172151, 18417036, 23713236, 24796092, 23521523 -20475845, 22148226, 22528741, 19243521, 19658708, 21153266, 24652769 -26088426, 19326908, 19597583, 17414008, 20897759, 23019710, 19174430 -22046677, 22243719, 20938170, 24825843, 21960504, 24509056, 19054077 -22657942, 20688221, 20428621, 21899588, 21387964, 13542050, 19723336 -19835133, 17532734, 19333670, 21842017, 19285025, 21373473, 22734547 -23260854, 19687159, 14643995, 21623164, 20977794, 20734332, 19012119 -19869255, 19932634, 17551063, 18681056, 22232606, 27548131, 21977392 -23324000, 24461826, 19676012, 20588502, 25427662, 22068305, 23315889 -19520602, 23053606, 19841800, 19439759, 20245930, 19303936, 19001359 -21476308, 26546754, 22916353, 19393542, 23533524, 21099555, 24835538 -22353346, 25429959, 19141838, 19644859, 21106027, 21915719, 26444887 -23088803, 19908836, 21421886, 22529728, 26256131, 19358317, 19134173 -19524158, 20447445, 23548817, 25861398, 20803014, 23025340, 21188584 -19335438, 19390567, 19058490, 19207117, 26513709, 18799993, 26569225 -20835241, 24662775, 19769480, 19475971, 21097043, 21225209, 20677396 -19284031, 19450314, 19016730, 18967382, 20919320, 22075064, 20347562 -20348653, 22551446, 19896336, 22721409, 24812585, 20048359, 21896069 -18440095, 22496904, 19524384, 25392535, 16439813, 18354830, 20596234 -20440930, 22022760, 20936905, 19171086, 23197103, 24718260, 17867700 -19791273, 21514877, 26111842, 18990023, 21241829, 19591608, 22707244 -18419520, 22492533, 22296366, 20173897, 24624166, 17210525, 18914624 -19571367, 21260431, 19501299, 20181030, 25056052, 20425790, 19708342 -19370504, 21868720, 23068169, 19124589, 19402853, 19888853, 16870214 -24341675, 17722075, 18202441, 24415926, 18743542, 19001390, 20882568 -23026585, 20717081, 25546608, 19081128, 22173980, 21875360, 25091141 -19178851, 19149990, 20382309, 20951038, 22855193, 22168163, 16777441 -25161298, 19606174, 20569094, 24308635, 20848335, 19791377, 19050649 -19382851, 20920911, 20528052, 22762046, 19189525, 24563422, 23125826 -22503297, 19469538, 25192729, 23338911, 20598042, 22458049, 18988834 -22730454, 19176326, 19048007, 17409174, 22729345, 18849970, 21532755 -20860659, 22842151, 22905130, 19238590, 16941434, 20387265, 21263635 -24397438, 20673810, 23108128, 22160989, 20356733, 22380919, 18499088 -18436647, 23065323, 21059919, 20825533, 18952989, 22518784, 19124336 -25856821, 22294260, 25484507, 20794034, 19468347, 20284155, 17533661 -19883092, 20657441, 24401351, 25539063, 17365043, 21285458, 20952966 -22961508, 18051556, 25330273, 19176223, 21300341, 23237313, 18288842 -19699191, 22353199, 24437510, 22083366, 21419850, 20669434, 18964978 -26898563, 19577410, 23294548, 20828947, 21373076, 25551676, 14283239 -25766822, 19931709, 22922076, 25423453, 25547060, 25575628, 23533807 -20368850, 21239530, 20437153, 20880215, 25600421, 20798891, 25606091 -18122373, 20043616, 23124895, 19013183, 18856999, 21450666, 21133343 -22695831, 18893947, 24365589, 20076781, 21196809, 21354456, 19587324 -20464614, 19562381, 18542562, 26758193, 24808595, 22062026, 19189317 -18307021, 21917884, 19708632, 27213224, 25633101, 20711718, 20134339 -22077517, 22815955, 24690216, 18973548, 25982666, 22507210, 22826718 -25655390, 21773465, 20250147, 20101006, 21795111, 19197175, 23501901 -18797519, 19597439, 21387128, 19180770, 19879746, 19354335, 21785691 -19730508, 20424183, 22366558, 26658759, 24285405, 6599380, 20717359 -26544823, 21297872, 20322560, 18964939, 22520320, 21575362, 26366517 -21913183, 22366322, 20171986, 22365117, 22645009, 25165496, 20603431 -21132297, 25957038, 21542577, 22507234, 18774543, 23170620, 24719736 -25600342, 20627866, 20124446, 18110491, 21429602, 16923858, 24642295 -19518079, 19371175, 20466322, 21863727, 18940497, 19074147, 22923409 -25823754, 25110233, 24908321, 20842388, 17274537, 21380789, 26575788 -19154375, 20474192, 19044962, 19532017, 21644640, 19662635, 22374754 -20560611, 25654936, 21794615, 18899974, 21492036, 18705806, 20471920 -22806698, 19052488, 22024071, 22238921, 19503821, 24350620, 22809871 -20074391, 21184223, 23089357, 19157754, 21220620, 19404068, 24316947 -18921743, 19865345, 19065677, 19065556, 22816287, 19018447, 19018206 -19777862, 25947799, 22223463, 19304354, 20878790, 22519146, 23492665 -21322887, 20879889, 24350831, 20890311, 19578350, 21142837, 20869721 -24555417, 22179537, 21756699, 20217801, 18819908, 19363645, 25483815 -21072646, 20898391, 19291380, 27060167, 27086138, 23007241, 19593445 -21080143, 22536802, 22087683, 20373598, 19248799, 20031873, 22707866 -19155797, 19279273, 18886413, 18618122, 25490238, 20922010, 19990037 -25150925, 20509482, 24739928, 20703000, 18966843, 19077215, 22862134 -21526048, 24929210, 24560906, 20704450, 20144308, 19068970, 20543011 -21620471, 19023822, 19670108, 19068610, 20267166, 24713381, 20432873 -21756677, 20476175, 25123585, 18549238, 20328248, 18674047, 22950945 -19385656, 18849537, 23528412, 19684504, 25459958, 20315311, 22897344 -20899461, 25178179, 20557786, 21911701, 19308965, 19143550, 19024808 -18948177, 19468991, 20009833, 20868862, 21780146, 20466628, 21756661 -20397490, 19706965, 24831514, 23240358, 22178855, 19604659, 16359751 -19032777, 20862087, 19329654, 19928926, 18974476, 23314180, 20212067 -20603378, 24737403, 20480209, 20859910, 26430737, 19307662, 21847223 -21668627, 20281121, 27169796, 19075256, 20877664, 19487147, 19076343 -23149541, 18866977, 24577566, 19430401, 19676905, 20844426, 20904530 -20925795, 20441797, 21296029, 21629064, 21442094, 23229229, 25079710 -22865673, 20708701, 19280225, 21315084, 24674955, 19213447, 18840932 -18740837, 20294666, 19989009, 25602488, 18191823, 21517440, 22062517 -19174942, 27337759, 17319928, 20671094, 21889720, 19703301, 21626377 -20122715, 23105538, 18411216, 6418158, 26198926, 20117253, 19258504 -21188532, 24386767, 17890099, 21649497, 26446098, 16887946, 26024732 -25264559, 18791688, 19721304, 22092979, 19490948, 19619732, 21164318 -21625179, 20879709, 23003979, 20165574, 18090142, 19272708, 21641760 -19818513, 19547370, 22624709, 20139391, 23084507, 24693382, 20228093 -21281532, 19978542, 23543183, 22165897, 22359063, 19409212, 19805359 -19461270, 23035249, 19434529, 18799063, 18990693, 20470877, 20378086 -17008068, 21246723, 21422580, 21632821, 20831538, 22351572, 20424899 -20361671, 18674024, 19689979, 20235511, 23220453, 24411921, 19873610 -16619249, 18604493, 20562898, 21091431, 19440586, 22757364, 18610915 -22175564, 21241052, 19561643, 19399918, 19195895, 20832516, 20830459 -20017509, 24801152, 21828126, 20907061, 21665897, 20746251, 20505778 -19183343, 25764020, 25612095, 25357142, 23096938, 21787056, 21273804 -19067244, 18043064, 21329301, 18885870, 20324049, 26187943, 19536415 -25093739, 17835294, 20446883, 21299490, 25313154, 24413809, 21744290 -18254023, 20591183, 18371441, 24385983, 20413820, 24421668, 25897615 -19185876, 25643931, 21281607, 20513399, 22465352, 20558005, 20402832 -19627012, 20093776, 18909599, 20618595, 27441326, 27620950, 23572982 -16863642, 19639483, 19315691, 19211433, 20331945, 19512341, 22256431 -21479753, 19637186, 19174521, 19022470, 18607546, 20401975, 18306996 -24573817, 18851894, 19649152, 27034890, 20581111, 19201867, 20318889 -20936731, 21060755, 21294938, 20898997, 18510194, 22256560, 22454326 -19534363, 25489607, 19188927 -``` - -### Version 12\.1\.0\.2\.v11 - -Version 12\.1\.0\.2\.v11 includes the following: -+ Patch 26925311: DATABASE PATCH SET UPDATE 12\.1\.0\.2\.180116 -+ Patch 27001733: OJVM PATCH SET UPDATE 12\.1\.0\.2\.180116 -+ Patch 27015449: RDBMS \- PROACTIVE DSTV31 UPDATE \- TZDATA2017C -+ Patch 27015468: PROACTIVE DSTV31 UPDATE \- TZDATA2017C \- NEED OJVM FIX -+ Patch 17969866: Oracle GoldenGate \- Oracle RDBMS Server Recommended Patches -+ Patch 20394750: Oracle GoldenGate \- Oracle RDBMS Server Recommended Patches -+ Patch 21171382: AUTO DOP COMPUTES A HIGH DOP UNNECESSARILY -+ Patch 27315904: JSON Database Patch -+ Patch 20033733: ORA 600 \[KGL\-HEAP\-SIZE\-EXCEEDED\] - -#### Oracle patch 26925311, released January 2018 - -Bugs fixed: - -``` -21099555, 22175564, 19141838, 22083366, 20842388, 19865345, 20117253 -20830459, 19791273, 20671094, 21542577, 23105538, 19243521, 20951038 -22165897, 19238590, 21281532, 17008068, 19908836, 24401351, 24577566 -21184223, 25427662, 20717359, 19134173, 20569094, 20031873, 20387265 -20322560, 21575362, 19149990, 21263635, 18886413, 17551063, 24719736 -22160989, 22519146, 21623164, 22507210, 19703301, 23338911, 19366375 -18007682, 19001390, 18202441, 24285405, 25655390, 20267166, 19358317 -19706965, 19068970, 24739928, 18549238, 22148226, 18797519, 26544823 -20825533, 23521523, 21196809, 18940497, 19670108, 19649152, 18866977 -18948177, 19404068, 22496904, 22826718, 18964978, 19176326, 19035573 -20413820, 20717081, 19176223, 21106027, 20904530, 20134339, 19074147 -20868862, 18411216, 23035249, 25475853, 21072646, 21322887, 22507234 -20425790, 20862087, 18966843, 25861398, 24929210, 24624166, 21329301 -20562898, 19333670, 19468991, 20124446, 19883092, 23543183, 20878790 -22855193, 18510194, 19658708, 19591608, 19402853, 23149541, 24796092 -20618595, 22238921, 21795111, 21787056, 22380919, 19469538, 21266085 -17835294, 19721304, 19068610, 19791377, 22178855, 16777441, 22173980 -20746251, 20048359, 21896069, 19185876, 20898391, 20281121, 20907061 -22950945, 21281607, 6599380, 19577410, 22092979, 19001359, 20603378 -23089357, 23572982, 19490948, 21387964, 22294260, 20832516, 17532734 -22351572, 18849970, 19309466, 19081128, 20627866, 20844426, 24908321 -21188532, 18791688, 21442094, 20890311, 20596234, 20368850, 26366517 -18973548, 19303936, 21296029, 22536802, 20882568, 21479753, 19461270 -20235511, 20936905, 22077517, 21220620, 18964939, 19430401, 22806698 -22296366, 21153266, 19409212, 20703000, 22657942, 20657441, 19879746 -20557786, 26758193, 23237313, 26198926, 19684504, 26088426, 21294938 -19024808, 24693382, 20528052, 20977794, 18799993, 20466322, 24642295 -18740837, 19662635, 18440095, 21794615, 20382309, 20228093, 19065556 -20212067, 25547060, 21868720, 22905130, 20938170, 19524384, 25459958 -24350831, 17722075, 20446883, 20144308, 25056052, 18952989, 24523374 -16870214, 21773465, 19928926, 19835133, 21629064, 21354456, 20466628 -23007241, 24386767, 25490238, 19931709, 19730508, 18819908, 20250147 -23124895, 25643931, 23220453, 19188927, 20074391, 18307021, 23533807 -20356733, 14643995, 26430737, 18090142, 19065677, 19547370, 26024732 -21225209, 21960504, 18371441, 20397490, 26575788, 23315889, 20172151 -18967382, 22729345, 19174430, 22068305, 25654936, 18419520, 21241829 -19536415, 26546664, 19171086, 21889720, 21132297, 20470877, 22465352 -22168163, 19335438, 24397438, 20076781, 20447445, 18856999, 20471920 -19869255, 21620471, 18990693, 23096938, 17890099, 19124336, 24812585 -18990023, 20101006, 21300341, 20848335, 21744290, 21241052, 20897759 -21668627, 19304354, 19052488, 20543011, 20794034, 23025340, 25606091 -23260854, 18681056, 19562381, 24570598, 20952966, 19896336, 20828947 -25539063, 18618122, 20328248, 24365589, 20440930, 18456643, 19699191 -23065323, 22865673, 19201867, 22816287, 21514877, 22022760, 18743542 -20798891, 20347562, 25161298, 23294548, 19777862, 24560906, 22551446 -19687159, 21373076, 19174942, 20424899, 24461826, 21641760, 21899588 -22862134, 18899974, 21476308, 20598042, 21297872, 24308635, 19058490 -19032777, 20171986, 22815955, 25150925, 19399918, 24718260, 19434529 -22492533, 19018447, 21273804, 18051556, 22757364, 18851894, 23125826 -20424183, 21842017, 19022470, 19284031, 18043064, 26898563, 20173897 -23713236, 22062026, 20475845, 17274537, 19440586, 16887946, 22374754 -18974476, 22961508, 24825843, 17319928, 20401975, 20708701, 22062517 -24674955, 17655240, 22809871, 19805359, 16439813, 19155797, 20859910 -19393542, 17210525, 22024071, 19189525, 21847223, 21649497, 19075256 -25079710, 25823754, 19370504, 20315311, 22762046, 22075064, 20936731 -20437153, 25165496, 18845653, 19280225, 19248799, 20560611, 18988834 -21756699, 22256431, 18921743, 20245930, 21532755, 18799063, 22454326 -20373598, 20476175, 19571367, 20925795, 19018206, 25264559, 24385983 -20509482, 20711718, 24509056, 20588502, 20181030, 21911701, 18849537 -23501901, 25034396, 19183343, 22842151, 21917884, 21142837, 20603431 -19189317, 23003979, 19644859, 19390567, 19279273, 26546754, 20669434 -16863642, 22528741, 22707244, 25546608, 19619732, 20348653, 18607546 -19315691, 19676905, 20165574, 17867700, 23528412, 20558005, 20734332 -19532017, 20922010, 19818513, 19450314, 22353346, 16941434, 20361671 -25423453, 20009833, 22366558, 20294666, 23197103, 18191823, 20860659 -22707866, 19195895, 19371175, 19307662, 19154375, 20043616, 20324049 -21977392, 18914624, 22529728, 22256560, 25330273, 19708342, 20139391 -19593445, 21291274, 19382851, 19520602, 19174521, 21875360, 19676012 -19326908, 20217801, 20093776, 18840932, 21097043, 21246723, 20803014 -21665897, 19143550, 23026585, 20428621, 19627012, 24415926, 22087683 -23548817, 14283239, 21422580, 19213447, 19518079, 26446098, 18610915 -23492665, 18674024, 24831514, 21863727, 24413809, 18306996, 19915271 -21626377, 19524158, 20122715, 20513399, 18110491, 22366322, 20284155 -25091141, 21080143, 20017509, 22359063, 19363645, 19597439, 21239530 -23108128, 19888853, 19383839, 20880215, 21756677, 22458049, 19534363 -19354335, 19044962, 19639483, 25982666, 19475971, 22353199, 21060755 -22243719, 22916353, 20378086, 21260431, 21756661, 24808595, 22923409 -19028800, 20877664, 22518784, 21059919, 20879889, 21380789, 19723336 -19077215, 21421886, 19604659, 21285458, 23533524, 26569225, 23170620 -22365117, 18288842, 19048007, 19308965, 19689979, 17409174, 19503821 -23068169, 24662775, 21526048, 25429959, 19197175, 19180770, 24555417 -24573817, 19902195, 26444887, 25313154, 24835538, 23324000, 20318889 -21492036, 19013183, 20591183, 19012119, 20464614, 22645009, 21625179 -19067244, 25178179, 23053606, 21632821, 19841800, 19512341, 19211433 -22695831, 20331945, 19587324, 24316947, 19578350, 19637186, 19054077 -18674047, 19708632, 20898997, 21091431, 19285025, 19289642, 25947799 -21133343, 20835241, 20869721, 21172913, 25602488, 19258504, 17365043 -21419850, 21644640, 19468347, 21373473, 25093739, 22721409, 16359751 -24421668, 21164318, 25484507, 25489607, 22520320, 19769480, 19439759 -19272708, 23088803, 19978542, 19329654, 20402832, 19873610, 23229229 -21517440, 13542050, 25897615, 19291380, 21915719, 25600342, 25192729 -20879709, 20677396, 19076343, 19561643, 19990037, 18909599, 19487147 -22897344, 20831538, 25600421, 19016730, 18250893, 23240358, 22179537 -16619249, 18354830, 24411921, 25764020, 18254023, 16756406, 21188584 -19989009, 25766822, 17414008, 20688221, 20441797, 20704450, 21780146 -25612095, 25957038, 24652769, 25483815, 19157754, 19207117, 24437510 -18885870, 21785691, 20673810, 24341675, 21450666, 18893947, 18705806 -22223463, 18417036, 16923858, 23084507, 23314180, 20919320, 22503297 -20474192, 22046677, 21299490, 19501299, 19385656, 20432873, 18542562 -20920911, 20899461, 21315084, 21429602, 21387128, 18122373, 20581111 -22624709, 26111842, 19606174, 24690216, 18436647, 19023822, 25110233 -19124589, 19178851, 19597583, 20480209, 18499088, 19050649 -``` - -### Version 12\.1\.0\.2\.v10 - -Version 12\.1\.0\.2\.v10 includes the following: -+ Oracle October 2017 PSU, a combination of database PSU \(patch 26713565\) \+ OJVM component PSU \(patch 26635845\) -+ Oracle recommended RDBMS patches for Oracle GoldenGate \(patch 17969866\) -+ DBMS\_STATS AUTO DOP COMPUTES A HIGH DOP UNNECESSARILY \(patch 21171382\) -+ JSON bundle patch \(patch 26750145\) -+ KGL heap size patch \(patch 20033733\) -+ Timezone file DSTv30 \(patch 25881255, OJVM patch 25881271\) - -#### Oracle patch 26713565, released October 2017 - -Bugs fixed: - -``` -21099555, 22175564, 19141838, 22083366, 20842388, 19865345, 20117253 -20830459, 19791273, 20671094, 21542577, 19243521, 20951038, 22165897 -19238590, 21281532, 17008068, 19908836, 24577566, 21184223, 25427662 -19134173, 20569094, 20031873, 20387265, 20322560, 21575362, 19149990 -21263635, 17551063, 18886413, 24719736, 22160989, 22519146, 21623164 -22507210, 23338911, 19703301, 19366375, 18007682, 19001390, 18202441 -24285405, 25655390, 20267166, 19358317, 19706965, 19068970, 24739928 -18549238, 22148226, 18797519, 26544823, 20825533, 23521523, 21196809 -18940497, 19670108, 19649152, 18866977, 18948177, 22496904, 19404068 -18964978, 19176326, 19035573, 20413820, 20717081, 19176223, 21106027 -20904530, 20134339, 19074147, 20868862, 23035249, 18411216, 21072646 -25475853, 21322887, 22507234, 20425790, 20862087, 18966843, 25861398 -21329301, 20562898, 19333670, 19468991, 20124446, 19883092, 22855193 -20878790, 18510194, 19658708, 19591608, 19402853, 23149541, 20618595 -22238921, 21795111, 21787056, 22380919, 19469538, 21266085, 17835294 -19721304, 19068610, 19791377, 22178855, 16777441, 22173980, 20746251 -20048359, 21896069, 19185876, 20898391, 20281121, 20907061, 22950945 -6599380, 19577410, 22092979, 19001359, 20603378, 23089357, 21387964 -19490948, 22294260, 20832516, 17532734, 22351572, 19309466, 19081128 -20627866, 20844426, 24908321, 21188532, 18791688, 21442094, 20890311 -20596234, 20368850, 18973548, 19303936, 21296029, 20882568, 21479753 -19461270, 20235511, 22077517, 20936905, 21220620, 18964939, 19430401 -22806698, 22296366, 21153266, 19409212, 22657942, 20703000, 20657441 -19879746, 20557786, 26198926, 26088426, 19684504, 21294938, 19024808 -24693382, 20528052, 20977794, 18799993, 20466322, 24642295, 18740837 -19662635, 18440095, 21794615, 20228093, 19065556, 20212067, 25547060 -21868720, 20938170, 22905130, 19524384, 25459958, 24350831, 17722075 -20144308, 20446883, 25056052, 18952989, 24523374, 16870214, 19928926 -19835133, 21629064, 21354456, 20466628, 24386767, 25490238, 19931709 -19730508, 18819908, 20250147, 23124895, 25643931, 23220453, 19188927 -20074391, 18307021, 23533807, 20356733, 26430737, 14643995, 18090142 -19065677, 19547370, 21225209, 21960504, 18371441, 20397490, 26575788 -23315889, 20172151, 18967382, 19174430, 22068305, 25654936, 21241829 -19536415, 19171086, 26546664, 21132297, 21889720, 22465352, 22168163 -19335438, 24397438, 20076781, 20447445, 18856999, 20471920, 19869255 -21620471, 18990693, 23096938, 19124336, 17890099, 24812585, 18990023 -21300341, 20101006, 20848335, 21744290, 21241052, 20897759, 21668627 -19304354, 19052488, 20543011, 20794034, 23025340, 25606091, 23260854 -18681056, 19562381, 20952966, 19896336, 20828947, 25539063, 18618122 -20328248, 20440930, 18456643, 19699191, 22865673, 19201867, 22816287 -22022760, 21514877, 18743542, 20798891, 20347562, 25161298, 23294548 -24560906, 22551446, 19777862, 19687159, 21373076, 19174942, 20424899 -21899588, 22862134, 18899974, 21476308, 20598042, 24308635, 21297872 -19058490, 19032777, 20171986, 22815955, 19399918, 19434529, 19018447 -18051556, 21273804, 22757364, 18851894, 23125826, 20424183, 21842017 -19022470, 19284031, 18043064, 23713236, 20173897, 22062026, 20475845 -17274537, 19440586, 22961508, 24825843, 18974476, 22374754, 16887946 -17319928, 20401975, 20708701, 24674955, 22062517, 22809871, 17655240 -19805359, 16439813, 19155797, 20859910, 19393542, 17210525, 22024071 -19189525, 21847223, 21649497, 19075256, 25823754, 25079710, 20315311 -22762046, 22075064, 20936731, 20437153, 18845653, 19280225, 19248799 -20560611, 18988834, 21756699, 22256431, 21532755, 18921743, 20245930 -22454326, 18799063, 20373598, 20476175, 19571367, 20925795, 19018206 -25264559, 20711718, 20509482, 20181030, 20588502, 21911701, 18849537 -23501901, 25034396, 19183343, 22842151, 21917884, 21142837, 20603431 -19189317, 23003979, 19644859, 19390567, 19279273, 26546754, 20669434 -16863642, 22528741, 22707244, 25546608, 19619732, 20348653, 18607546 -19315691, 19676905, 20165574, 17867700, 20558005, 20734332, 19532017 -20922010, 19818513, 19450314, 22353346, 16941434, 20361671, 25423453 -20009833, 22366558, 20294666, 23197103, 18191823, 20860659, 19195895 -19371175, 19307662, 19154375, 20043616, 21977392, 18914624, 22529728 -19708342, 20139391, 25330273, 19593445, 21291274, 19382851, 19520602 -19174521, 21875360, 19676012, 19326908, 20217801, 20093776, 18840932 -21097043, 21246723, 20803014, 21665897, 19143550, 23026585, 20428621 -19627012, 22087683, 23548817, 14283239, 21422580, 19213447, 26446098 -19518079, 23492665, 18610915, 18674024, 21863727, 24413809, 18306996 -19915271, 21626377, 19524158, 20122715, 20513399, 18110491, 20284155 -25091141, 21080143, 20017509, 22359063, 19363645, 19597439, 21239530 -23108128, 19383839, 20880215, 21756677, 19888853, 22458049, 19534363 -19354335, 19044962, 19639483, 25982666, 19475971, 22353199, 21060755 -22243719, 22916353, 20378086, 24808595, 21756661, 21260431, 22923409 -19028800, 20877664, 21059919, 20879889, 21380789, 19723336, 19077215 -21421886, 19604659, 21285458, 23533524, 23170620, 22365117, 18288842 -19048007, 19308965, 19689979, 17409174, 23068169, 19503821, 24662775 -25429959, 21526048, 19197175, 19180770, 24555417, 24573817, 19902195 -26444887, 24835538, 23324000, 20318889, 21492036, 19013183, 20591183 -19012119, 20464614, 21625179, 19067244, 23053606, 21632821, 19841800 -19512341, 22695831, 20331945, 19587324, 24316947, 19578350, 19637186 -19054077, 18674047, 19708632, 20898997, 19285025, 21091431, 19289642 -25947799, 21133343, 20835241, 20869721, 21172913, 25602488, 19258504 -17365043, 21419850, 21644640, 19468347, 21373473, 25093739, 16359751 -24421668, 21164318, 25489607, 25484507, 22520320, 19769480, 19439759 -19272708, 19978542, 19329654, 20402832, 19873610, 23229229, 13542050 -21517440, 25897615, 19291380, 21915719, 25600342, 20879709, 20677396 -19076343, 19561643, 19990037, 22897344, 18909599, 19487147, 25600421 -20831538, 19016730, 18250893, 23240358, 22179537, 16619249, 18354830 -24411921, 18254023, 16756406, 21188584, 19989009, 25766822, 17414008 -20688221, 20441797, 20704450, 21780146, 25612095, 25957038, 24652769 -25483815, 19157754, 19207117, 24437510, 18885870, 21785691, 20673810 -24341675, 21450666, 18893947, 18705806, 22223463, 18417036, 16923858 -23084507, 23314180, 20919320, 22503297, 20474192, 22046677, 21299490 -19501299, 19385656, 20432873, 18542562, 20920911, 20899461, 21429602 -21387128, 21315084, 18122373, 20581111, 26111842, 22624709, 19606174 -24690216, 18436647, 19023822, 25110233, 19124589, 19178851, 19597583 -18499088, 19050649 -``` - -### Version 12\.1\.0\.2\.v9 - -Version 12\.1\.0\.2\.v9 includes the following: -+ Oracle July 2017 PSU, a combination of database PSU \(patch 26609783\) \+ OJVM component PSU \(patch 26027162\) -+ Oracle recommended RDBMS patches for Oracle GoldenGate \(patch 17969866\) -+ DBMS\_STATS AUTO DOP COMPUTES A HIGH DOP UNNECESSARILY \(patch 21171382\) -+ JSON bundle patch \(patch 26083365\) -+ KGL heap size patch \(patch 20033733 for 12\.1\.0\.2\) -+ Timezone file DSTv30 \(patch 25881255, OJVM patch 25881271\) -+ Support for [Validating DB instance files](Appendix.Oracle.CommonDBATasks.RMAN.md#Appendix.Oracle.CommonDBATasks.ValidateDBFiles) with the `RMAN` logical validation utility -+ Support for [Setting the default edition for a DB instance](Appendix.Oracle.CommonDBATasks.Database.md#Appendix.Oracle.CommonDBATasks.DefaultEdition) - -#### Oracle patch 26609783, released July 2017 - -Bugs fixed: - -``` -21099555, 22175564, 19141838, 22083366, 20842388, 19865345, 20117253 -19791273, 20671094, 21542577, 20951038, 19243521, 22165897, 19238590 -21281532, 17008068, 19908836, 24577566, 21184223, 25427662, 19134173 -20569094, 20031873, 20387265, 20322560, 21575362, 19149990, 21263635 -17551063, 18886413, 22160989, 22507210, 19703301, 19366375, 18007682 -19001390, 18202441, 24285405, 25655390, 20267166, 19358317, 19706965 -19068970, 24739928, 18549238, 22148226, 18797519, 26544823, 20825533 -21196809, 18940497, 19670108, 19649152, 18866977, 18948177, 22496904 -19404068, 18964978, 19176326, 19035573, 20413820, 20717081, 19176223 -21106027, 20904530, 20134339, 19074147, 20868862, 18411216, 21072646 -25475853, 21322887, 22507234, 20425790, 20862087, 18966843, 21329301 -20562898, 19333670, 19468991, 20124446, 19883092, 20878790, 18510194 -19658708, 19591608, 19402853, 20618595, 21787056, 22380919, 21266085 -19469538, 17835294, 19721304, 19068610, 19791377, 22178855, 16777441 -22173980, 20746251, 20048359, 21896069, 19185876, 20898391, 20281121 -20907061, 6599380, 19577410, 22092979, 19001359, 20603378, 23089357 -21387964, 19490948, 22294260, 20832516, 17532734, 22351572, 19309466 -19081128, 20627866, 20844426, 24908321, 21188532, 18791688, 21442094 -20890311, 20596234, 20368850, 18973548, 19303936, 21296029, 20882568 -21479753, 19461270, 20235511, 22077517, 20936905, 21220620, 18964939 -19430401, 22296366, 21153266, 19409212, 22657942, 20703000, 20657441 -19879746, 20557786, 19684504, 21294938, 19024808, 24693382, 20528052 -20977794, 18799993, 20466322, 18740837, 19662635, 18440095, 20228093 -19065556, 20212067, 25547060, 21868720, 22905130, 19524384, 25459958 -24350831, 17722075, 20446883, 25056052, 18952989, 24523374, 16870214 -19928926, 19835133, 21629064, 21354456, 20466628, 24386767, 25490238 -19931709, 19730508, 18819908, 20250147, 23124895, 25643931, 23220453 -19188927, 20074391, 18307021, 23533807, 20356733, 14643995, 18090142 -19065677, 19547370, 21225209, 21960504, 26575788, 20397490, 20172151 -18967382, 19174430, 21241829, 19536415, 26546664, 19171086, 21132297 -21889720, 22465352, 22168163, 19335438, 24397438, 20076781, 20447445 -18856999, 20471920, 19869255, 21620471, 18990693, 23096938, 19124336 -17890099, 24812585, 18990023, 21300341, 20101006, 20848335, 21744290 -20897759, 21668627, 19304354, 19052488, 20543011, 20794034, 23025340 -25606091, 23260854, 18681056, 19562381, 20952966, 19896336, 20828947 -25539063, 18618122, 20328248, 20440930, 18456643, 19699191, 22865673 -19201867, 22022760, 21514877, 18743542, 20798891, 20347562, 25161298 -23294548, 24560906, 22551446, 19777862, 19687159, 21373076, 19174942 -20424899, 21899588, 18899974, 21476308, 20598042, 24308635, 21297872 -19058490, 19032777, 20171986, 22815955, 19399918, 19434529, 19018447 -18051556, 21273804, 22757364, 18851894, 19022470, 19284031, 18043064 -20173897, 22062026, 20475845, 17274537, 19440586, 24825843, 18974476 -22374754, 16887946, 17319928, 20401975, 20708701, 24674955, 22062517 -22809871, 17655240, 19805359, 16439813, 19155797, 20859910, 19393542 -17210525, 22024071, 19189525, 21847223, 21649497, 19075256, 25823754 -25079710, 20315311, 22762046, 22075064, 20936731, 20437153, 18845653 -19280225, 19248799, 20560611, 18988834, 21756699, 18921743, 20245930 -18799063, 20373598, 20476175, 19571367, 20925795, 19018206, 25264559 -20711718, 20509482, 20181030, 20588502, 21911701, 18849537, 23501901 -19183343, 21917884, 21142837, 20603431, 19189317, 19644859, 19390567 -26546754, 19279273, 20669434, 16863642, 22528741, 25546608, 19619732 -20348653, 18607546, 19315691, 19676905, 20165574, 17867700, 20558005 -20734332, 19532017, 20922010, 19818513, 19450314, 22353346, 16941434 -20361671, 25423453, 20009833, 22366558, 20294666, 23197103, 18191823 -19195895, 19371175, 19307662, 19154375, 20043616, 21977392, 18914624 -22529728, 20139391, 25330273, 19593445, 21291274, 19382851, 19520602 -19174521, 21875360, 19676012, 19326908, 20217801, 20093776, 18840932 -21097043, 21246723, 20803014, 21665897, 19143550, 23026585, 20428621 -19627012, 14283239, 21422580, 19213447, 19518079, 18610915, 18674024 -24413809, 18306996, 19915271, 21626377, 19524158, 20122715, 20513399 -20284155, 25091141, 21080143, 20017509, 22359063, 19363645, 19597439 -21239530, 19383839, 20880215, 21756677, 19888853, 22458049, 19534363 -19354335, 19044962, 19639483, 25982666, 19475971, 22353199, 21060755 -22243719, 22916353, 20378086, 24808595, 21756661, 21260431, 22923409 -19028800, 20877664, 21059919, 20879889, 21380789, 19723336, 19077215 -21421886, 19604659, 21285458, 23533524, 23170620, 22365117, 18288842 -19048007, 19308965, 19689979, 17409174, 19503821, 21526048, 19197175 -19180770, 24573817, 19902195, 24835538, 23324000, 20318889, 19013183 -20591183, 19012119, 20464614, 19067244, 21632821, 19841800, 19512341 -22695831, 20331945, 19587324, 24316947, 19578350, 19637186, 19054077 -18674047, 19708632, 20898997, 21091431, 19289642, 21133343, 20835241 -20869721, 21172913, 19258504, 17365043, 21419850, 21644640, 19468347 -21373473, 25093739, 16359751, 21164318, 25484507, 22520320, 19769480 -19439759, 19272708, 19978542, 19329654, 20402832, 19873610, 23229229 -13542050, 21517440, 19291380, 21915719, 25600342, 20879709, 20677396 -19076343, 19561643, 19990037, 18909599, 19487147, 25600421, 20831538 -19016730, 18250893, 16619249, 18354830, 24411921, 16756406, 18254023 -21188584, 19989009, 25766822, 17414008, 20688221, 20441797, 20704450 -21780146, 25612095, 25957038, 25483815, 19157754, 19207117, 24437510 -18885870, 21785691, 20673810, 21450666, 18893947, 18705806, 22223463 -18417036, 16923858, 23314180, 20919320, 20474192, 22046677, 21299490 -19501299, 19385656, 20432873, 20920911, 20899461, 21387128, 21315084 -18122373, 20581111, 22624709, 19606174, 24690216, 18436647, 19023822 -25110233, 19124589, 19178851, 19597583, 18499088, 19050649 -``` - -### Version 12\.1\.0\.2\.v8 - -Version 12\.1\.0\.2\.v8 includes the following: -+ Oracle patch 25433980, a combination of database PSU \(patch 25171037\) \+ OJVM component PSU \(patch 25437695\) -+ Oracle recommended RDBMS patches for Oracle GoldenGate \(patch 17969866 for 12\.1\.0\.2\) -+ Oracle Forms patch 18307021 for 12\.1\.0\.2 -+ DBMS\_STATS Patch \(patch 21171382 for 12\.1\.0\.2\) -+ JSON bundle patch \(patch 25531469 for 12\.1\.0\.2\) -+ KGL heap size patch \(patch 20033733 for 12\.1\.0\.2\) -+ Fixed a bug that affected PSU apply after upgrade to 12\.1\.0\.2\.v5, v6, and v7 -+ Timezone file DSTv28 \(patch 24701840\) -+ Support for the `DBMS_CHANGE_NOTIFICATION` package -+ Support for `XSTREAM` packages and views \(may require additional licensing\) - -#### Oracle patch 25171037, released April 2017 - -Bugs fixed: - -``` -21099555, 22175564, 19141838, 22083366, 20842388, 20117253, 19865345 -19791273, 21542577, 20951038, 19243521, 22165897, 17008068, 19908836 -21281532, 19238590, 24577566, 21184223, 19134173, 20569094, 20031873 -20322560, 20387265, 21575362, 19149990, 21263635, 17551063, 18886413 -22160989, 22507210, 19366375, 19703301, 19001390, 24285405, 18202441 -20267166, 19358317, 19706965, 19068970, 18549238, 24739928, 18797519 -22148226, 20825533, 21196809, 19649152, 19670108, 18940497, 18948177 -22496904, 18964978, 19176326, 19035573, 20413820, 19176223, 21106027 -20904530, 20134339, 19074147, 20868862, 18411216, 25475853, 21322887 -21072646, 22507234, 20425790, 20862087, 18966843, 21329301, 20562898 -19333670, 20124446, 19468991, 19883092, 20878790, 18510194, 19658708 -19591608, 19402853, 20618595, 21787056, 22380919, 19469538, 21266085 -17835294, 19721304, 19068610, 19791377, 22178855, 16777441, 22173980 -20048359, 20746251, 21896069, 19185876, 20898391, 20907061, 20281121 -6599380, 19577410, 22092979, 19001359, 20603378, 23089357, 21387964 -19490948, 22294260, 17532734, 20832516, 22351572, 19309466, 20627866 -19081128, 20844426, 21188532, 18791688, 20890311, 21442094, 20596234 -20368850, 18973548, 19303936, 21296029, 20882568, 19461270, 21479753 -22077517, 20936905, 20235511, 21220620, 18964939, 19430401, 22296366 -21153266, 19409212, 20703000, 22657942, 19879746, 20657441, 21294938 -19684504, 19024808, 20528052, 24693382, 20977794, 18799993, 20466322 -18740837, 19662635, 18440095, 20228093, 19065556, 20212067, 21868720 -22905130, 19524384, 24350831, 17722075, 20446883, 25056052, 18952989 -24523374, 16870214, 19928926, 19835133, 21629064, 21354456, 20466628 -24386767, 25490238, 19931709, 19730508, 18819908, 20250147, 23124895 -23220453, 19188927, 20074391, 18307021, 20356733, 14643995, 19065677 -19547370, 21960504, 21225209, 20397490, 18967382, 19174430, 21241829 -19536415, 19171086, 21889720, 22465352, 22168163, 19335438, 24397438 -20447445, 18856999, 19869255, 20471920, 21620471, 23096938, 18990693 -19124336, 17890099, 24812585, 18990023, 21300341, 20101006, 20848335 -21744290, 20897759, 21668627, 19304354, 20543011, 19052488, 20794034 -23025340, 23260854, 18681056, 20952966, 19896336, 25539063, 18618122 -20328248, 20440930, 18456643, 19699191, 19201867, 22865673, 22022760 -20798891, 18743542, 25161298, 20347562, 22551446, 19777862, 19687159 -21373076, 19174942, 20424899, 21899588, 18899974, 21476308, 20598042 -21297872, 24308635, 20171986, 19058490, 19032777, 22815955, 19399918 -19434529, 21273804, 19018447, 22757364, 18851894, 19022470, 19284031 -18043064, 20173897, 22062026, 20475845, 17274537, 19440586, 18974476 -24825843, 22374754, 16887946, 17319928, 20401975, 20708701, 22062517 -22809871, 17655240, 16439813, 19805359, 19155797, 20859910, 19393542 -22024071, 17210525, 19189525, 21847223, 21649497, 25079710, 19075256 -20315311, 22762046, 22075064, 20936731, 18845653, 19280225, 19248799 -20560611, 18988834, 21756699, 18921743, 20245930, 18799063, 20373598 -19571367, 20476175, 20925795, 19018206, 25264559, 20711718, 20509482 -20181030, 20588502, 21911701, 18849537, 23501901, 19183343, 21917884 -21142837, 19189317, 19644859, 19390567, 19279273, 20669434, 16863642 -22528741, 25546608, 19619732, 18607546, 20348653, 19315691, 19676905 -20165574, 17867700, 20558005, 20734332, 19532017, 20922010, 19818513 -19450314, 22353346, 16941434, 20361671, 20009833, 22366558, 20294666 -18191823, 23197103, 19195895, 19371175, 19307662, 19154375, 20043616 -21977392, 18914624, 22529728, 25330273, 20139391, 19593445, 21291274 -19382851, 19520602, 19174521, 21875360, 19676012, 19326908, 20217801 -20093776, 18840932, 21097043, 21246723, 20803014, 21665897, 19143550 -20428621, 19627012, 14283239, 21422580, 19213447, 19518079, 18610915 -18674024, 24413809, 18306996, 19915271, 19524158, 20122715, 20284155 -20017509, 22359063, 19363645, 19597439, 21239530, 19383839, 20880215 -21756677, 19888853, 22458049, 19534363, 19354335, 19044962, 19639483 -19475971, 22353199, 22243719, 21060755, 22916353, 20378086, 24808595 -21756661, 21260431, 22923409, 19028800, 20877664, 21059919, 20879889 -21380789, 19723336, 19077215, 19604659, 21421886, 21285458, 23533524 -23170620, 22365117, 18288842, 19048007, 19308965, 19689979, 19503821 -21526048, 19197175, 19180770, 19902195, 23324000, 20318889, 19013183 -20591183, 19012119, 20464614, 19067244, 21632821, 19841800, 19512341 -22695831, 20331945, 19587324, 24316947, 19578350, 19637186, 19054077 -18674047, 19708632, 20898997, 21091431, 19289642, 21133343, 20869721 -21172913, 19258504, 17365043, 21419850, 19468347, 21373473, 25093739 -16359751, 21164318, 22520320, 19769480, 19439759, 19272708, 19978542 -19329654, 20402832, 19873610, 23229229, 13542050, 21517440, 19291380 -21915719, 20879709, 20677396, 19076343, 19561643, 19990037, 19487147 -18909599, 20831538, 19016730, 18250893, 16619249, 18354830, 24411921 -16756406, 18254023, 21188584, 19989009, 17414008, 20688221, 20704450 -20441797, 25483815, 19157754, 24437510, 18885870, 21785691, 20673810 -21450666, 18893947, 18705806, 22223463, 16923858, 18417036, 23314180 -20919320, 20474192, 22046677, 21299490, 19501299, 19385656, 20920911 -20899461, 21387128, 21315084, 18122373, 20581111, 19606174, 24690216 -18436647, 19023822, 19124589, 19178851, 19597583, 18499088, 19050649 -``` - -### Version 12\.1\.0\.2\.v7 - -Version 12\.1\.0\.2\.v7 includes the following: -+ Oracle patch 24917069, a combination of database PSU \(patch 24732082\) \+ OJVM component PSU \(patch 24917972\) -+ Oracle recommended RDBMS patches for Oracle GoldenGate \(patch 17969866 for 12\.1\.0\.2\) -+ Oracle Forms patch 18307021 for 12\.1\.0\.2 -+ DBMS\_STATS Patch \(patch 21171382 for 12\.1\.0\.2\) -+ JSON bundle patch \(patch 25089615 for 12\.1\.0\.2\) -+ KGL heap size patch \(patch 20033733 for 12\.1\.0\.2\) - -#### Oracle patch 24917069, released January 2017 - -Bugs fixed: - -``` -24917972, 25067795, 24534298, 25076732, 25076756, 24315824, 21659726 -24448240, 24448282, 23177536, 22675136, 23265914, 23265965, 23727148 -22674709, 22670413, 22670385, 21188537, 22139226, 22118835, 22118851 -21555660, 21811517, 19623450, 21566993, 21566944, 19176885, 21068507 -21047803, 21047766, 20415564, 20408829, 20408866, 19877336, 19855285 -19909862, 19895362, 19895326, 19153980, 19231857, 19223010, 19245191, -19699946, -21099555, 22175564, 19141838, 22083366, 20842388, 20117253, 19865345 -19791273, 21542577, 20951038, 19243521, 22165897, 19908836, 21281532 -19238590, 24577566, 21184223, 19134173, 20031873, 20387265, 21575362 -19149990, 21263635, 17551063, 18886413, 22160989, 22507210, 19366375 -19703301, 19001390, 24285405, 18202441, 20267166, 19358317, 19706965 -24739928, 19068970, 18549238, 18797519, 22148226, 20825533, 21196809 -19649152, 19670108, 18940497, 18948177, 22496904, 18964978, 19035573 -19176326, 20413820, 19176223, 21106027, 20904530, 20134339, 19074147 -20868862, 18411216, 21072646, 21322887, 22507234, 20425790, 18966843 -21329301, 20562898, 19333670, 20124446, 19468991, 19883092, 18510194 -19658708, 19591608, 19402853, 20618595, 21787056, 22380919, 19469538 -21266085, 17835294, 19721304, 19791377, 19068610, 22178855, 16777441 -22173980, 20048359, 20746251, 21896069, 20898391, 19185876, 20907061 -20281121, 6599380, 19577410, 22092979, 19001359, 20603378, 23089357 -19490948, 21387964, 22294260, 20832516, 17532734, 19309466, 20627866 -19081128, 20844426, 21188532, 18791688, 20890311, 21442094, 20596234 -18973548, 21296029, 19303936, 20882568, 19461270, 21479753, 22077517 -20936905, 20235511, 21220620, 18964939, 19430401, 22296366, 21153266 -19409212, 22657942, 19879746, 20657441, 21294938, 19684504, 24693382 -20528052, 19024808, 20977794, 18799993, 20466322, 18740837, 19662635 -20228093, 20212067, 19065556, 19524384, 17722075, 20446883, 25056052 -24523374, 18952989, 16870214, 19928926, 19835133, 21629064, 21354456 -20466628, 24386767, 19931709, 19730508, 18819908, 23124895, 23220453 -19188927, 20074391, 18307021, 20356733, 14643995, 19547370, 19065677 -21960504, 21225209, 20397490, 18967382, 19174430, 21241829, 19536415 -19171086, 22465352, 22168163, 19335438, 24397438, 20447445, 18856999 -19869255, 20471920, 21620471, 18990693, 17890099, 24812585, 18990023 -21300341, 20101006, 20848335, 21744290, 20897759, 21668627, 19304354 -19052488, 20794034, 23025340, 23260854, 18681056, 20952966, 19896336 -20328248, 18618122, 20440930, 18456643, 19699191, 19201867, 22865673 -22022760, 20798891, 18743542, 25161298, 20347562, 19777862, 22551446 -19687159, 21373076, 19174942, 20424899, 21899588, 18899974, 21476308 -20598042, 24308635, 19032777, 19058490, 22815955, 19399918, 19434529 -21273804, 19018447, 22757364, 18851894, 19022470, 19284031, 18043064 -20173897, 22062026, 20475845, 17274537, 19440586, 24825843, 18974476 -22374754, 16887946, 17319928, 20401975, 20708701, 22809871, 17655240 -16439813, 19805359, 19155797, 20859910, 19393542, 17210525, 22024071 -21847223, 19189525, 21649497, 19075256, 20315311, 22762046, 22075064 -20936731, 19280225, 18845653, 20560611, 19248799, 21756699, 18988834 -20245930, 18921743, 18799063, 20373598, 19571367, 20476175, 20925795 -25264559, 19018206, 20711718, 20509482, 20181030, 20588502, 18849537 -23501901, 19183343, 21917884, 19189317, 19644859, 19390567, 19279273 -20669434, 22528741, 16863642, 19619732, 18607546, 20348653, 19315691 -19676905, 20165574, 17867700, 20558005, 20734332, 19532017, 20922010 -19818513, 19450314, 22353346, 20361671, 20009833, 22366558, 20294666 -23197103, 18191823, 19195895, 19307662, 19371175, 20043616, 19154375 -18914624, 22529728, 20139391, 21291274, 19382851, 19520602, 19174521 -21875360, 19676012, 19326908, 20217801, 20093776, 18840932, 21097043 -21246723, 20803014, 21665897, 19143550, 20428621, 19627012, 14283239 -19518079, 18610915, 18674024, 24413809, 18306996, 19524158, 19915271 -20122715, 20284155, 20017509, 22359063, 19363645, 19597439, 21239530 -19888853, 21756677, 20880215, 22458049, 19534363, 19354335, 19044962 -19639483, 19475971, 22353199, 21060755, 22243719, 22916353, 20378086 -24808595, 21260431, 21756661, 22923409, 20877664, 19028800, 21059919 -20879889, 21380789, 19723336, 19077215, 19604659, 21421886, 21285458 -23533524, 23170620, 22365117, 18288842, 19308965, 19048007, 19689979 -21526048, 19197175, 19180770, 19902195, 23324000, 20318889, 19013183 -20591183, 19012119, 20464614, 19067244, 21632821, 19512341, 19841800 -22695831, 20331945, 19587324, 24316947, 19578350, 19637186, 18674047 -19054077, 20898997, 19708632, 21091431, 19289642, 21133343, 20869721 -21172913, 19258504, 17365043, 19468347, 21373473, 16359751, 19769480 -19439759, 19272708, 19978542, 20402832, 19329654, 19873610, 23229229 -21517440, 13542050, 19291380, 21915719, 20879709, 20677396, 19076343 -19561643, 19990037, 19487147, 18909599, 20831538, 18250893, 19016730 -16619249, 18354830, 18254023, 21188584, 19989009, 17414008, 20688221 -20704450, 20441797, 19157754, 24437510, 18885870, 21785691, 18893947 -21450666, 18705806, 22223463, 16923858, 18417036, 23314180, 20919320 -20474192, 22046677, 19385656, 19501299, 20920911, 20899461, 21315084 -21387128, 18122373, 20581111, 19606174, 24690216, 18436647, 19023822 -19178851, 19124589, 19597583, 18499088, 19050649 -``` - -### Version 12\.1\.0\.2\.v6 - -Version 12\.1\.0\.2\.v6 includes the following: -+ Oracle patch 24433133, a combination of database PSU \(patch 24006101\) \+ OJVM component PSU \(patch 24315824\) -+ Oracle recommended RDBMS patches for Oracle GoldenGate \(patch 17969866 for 12\.1\.0\.2\) -+ Oracle Forms patch 18307021 for 12\.1\.0\.2 -+ DBMS\_STATS Patch \(patch 21171382 for 12\.1\.0\.2\) -+ JSON bundle patch \(patch 24568656 for 12\.1\.0\.2\) -+ Fixed a bug that caused 12c upgrade scripts to drop customer directories -+ Made DIAG log directory available to customers - -#### Baseline: Oracle database patch set update 12\.1\.0\.2\.161018 \(patch 24006101, released October 2016\) - -Bugs fixed: - -``` - -21099555, 22175564, 19141838, 22083366, 20842388, 20117253, 19865345 -19791273, 19243521, 20951038, 19908836, 21281532, 19238590, 24577566 -21184223, 19134173, 20387265, 19149990, 21263635, 18886413, 17551063 -22160989, 22507210, 19703301, 19366375, 19001390, 18202441, 20267166 -19358317, 19706965, 18549238, 19068970, 18797519, 22148226, 20825533 -19649152, 19670108, 18940497, 18948177, 18964978, 19035573, 19176326 -20413820, 19176223, 20904530, 20134339, 19074147, 20868862, 18411216 -21322887, 22507234, 20425790, 18966843, 21329301, 19333670, 19468991 -20124446, 19883092, 19658708, 19591608, 19402853, 20618595, 21787056 -22380919, 21266085, 17835294, 19721304, 19791377, 19068610, 22178855 -22173980, 20746251, 20048359, 20898391, 19185876, 20281121, 20907061 -6599380, 19577410, 22092979, 20603378, 19001359, 19490948, 21387964 -20832516, 17532734, 19309466, 19081128, 20627866, 20844426, 21188532 -18791688, 21442094, 20890311, 20596234, 18973548, 21296029, 19303936 -19461270, 21479753, 20936905, 20235511, 21220620, 18964939, 19430401 -22296366, 21153266, 19409212, 22657942, 20657441, 19879746, 19684504 -20528052, 19024808, 20977794, 18799993, 20466322, 18740837, 19662635 -20228093, 19065556, 20212067, 19524384, 17722075, 20446883, 18952989 -16870214, 19928926, 19835133, 21629064, 20466628, 24386767, 19931709 -19730508, 18819908, 23124895, 19188927, 20074391, 20356733, 14643995 -19547370, 19065677, 21960504, 21225209, 20397490, 18967382, 19174430 -21241829, 19536415, 19171086, 22465352, 22168163, 19335438, 20447445 -18856999, 20471920, 19869255, 21620471, 18990693, 17890099, 18990023 -20101006, 21300341, 20848335, 21744290, 20897759, 21668627, 19304354 -19052488, 20794034, 23260854, 18681056, 20952966, 19896336, 18618122 -20328248, 20440930, 18456643, 19699191, 19201867, 22865673, 18743542 -20798891, 20347562, 22551446, 19777862, 19687159, 21373076, 19174942 -20424899, 21899588, 18899974, 20598042, 19032777, 19058490, 22815955 -19399918, 19434529, 21273804, 19018447, 22757364, 18851894, 19284031 -19022470, 18043064, 20173897, 22062026, 20475845, 17274537, 19440586 -16887946, 22374754, 17319928, 20708701, 17655240, 16439813, 19805359 -19155797, 20859910, 19393542, 22024071, 17210525, 21847223, 19189525 -21649497, 19075256, 22762046, 22075064, 19280225, 18845653, 20560611 -19248799, 21756699, 18988834, 20245930, 18921743, 18799063, 20373598 -20476175, 19571367, 20925795, 19018206, 20509482, 20711718, 20588502 -18849537, 19183343, 21917884, 19189317, 19644859, 19390567, 19279273 -20669434, 16863642, 22528741, 19619732, 18607546, 20348653, 19315691 -19676905, 20165574, 17867700, 20558005, 20734332, 19532017, 20922010 -19450314, 22353346, 20361671, 20009833, 22366558, 20294666, 18191823 -19307662, 19371175, 19195895, 20043616, 19154375, 18914624, 20139391 -21291274, 19174521, 19520602, 19382851, 21875360, 19676012, 19326908 -20217801, 20093776, 21097043, 21246723, 21665897, 19143550, 20428621 -19627012, 14283239, 19518079, 18610915, 18674024, 18306996, 19524158 -19915271, 20122715, 20284155, 20017509, 19363645, 19597439, 21239530 -19888853, 20880215, 21756677, 19534363, 19354335, 19044962, 19639483 -22353199, 22243719, 22916353, 20378086, 21756661, 21260431, 22923409 -20877664, 19028800, 20879889, 19723336, 19077215, 21421886, 19604659 -19308965, 19048007, 18288842, 19689979, 21526048, 19180770, 19197175 -19902195, 20318889, 19013183, 19012119, 20464614, 19067244, 21632821 -19512341, 19841800, 20331945, 19587324, 24316947, 19578350, 19637186 -18674047, 19054077, 20898997, 19708632, 21091431, 19289642, 20869721 -19258504, 17365043, 19468347, 21373473, 16359751, 19439759, 19769480 -19272708, 19978542, 20402832, 19329654, 19873610, 23229229, 21517440 -13542050, 19291380, 21915719, 19076343, 19561643, 19990037, 19487147 -18909599, 20831538, 18250893, 19016730, 16619249, 18354830, 21188584 -19989009, 17414008, 20688221, 20704450, 20441797, 19157754, 18885870 -21785691, 21450666, 18893947, 18705806, 22223463, 16923858, 18417036 -20919320, 20474192, 22046677, 19385656, 19501299, 20920911, 20899461 -21387128, 21315084, 18122373, 20581111, 19606174, 18436647, 19023822 -19178851, 19124589, 19597583, 18499088, 19050649 -``` - -### Version 12\.1\.0\.2\.v5 - -Version 12\.1\.0\.2\.v5 includes the following: -+ Oracle patch 23615289, a combination of database PSU \(patch 23054246\) \+ OJVM component PSU \(patch 23177536\) -+ Timezone file DSTv26 \(patch 22873635 for 12\.1\.0\.2\) -+ Oracle recommended RDBMS patches for Oracle GoldenGate \(patch 17969866 for 12\.1\.0\.2\) -+ Oracle Forms patch 18307021 for 12\.1\.0\.2 -+ Ability to create custom password verify functions \(see [Creating custom functions to verify passwords](Appendix.Oracle.CommonDBATasks.System.md#Appendix.Oracle.CommonDBATasks.CustomPassword)\) -+ Fixed a bug that prevented implicit recompilation of views owned by SYS - -#### Baseline: Oracle database patch set update 12\.1\.0\.2\.160719 \(patch 23054246, released July 2016\) - -Bugs fixed: - -``` - -19189525, 21847223, 21099555, 21649497, 19075256, 19141838, 22762046 -22075064, 20117253, 19865345, 19791273, 18845653, 19280225, 19248799 -19243521, 20951038, 18988834, 21756699, 21281532, 19238590, 21184223 -18921743, 20245930, 18799063, 19134173, 20373598, 19571367, 20476175 -20925795, 19018206, 20509482, 20711718, 20387265, 20588502, 19149990 -21263635, 18849537, 18886413, 17551063, 22507210, 19183343, 19366375 -19703301, 21917884, 19001390, 18202441, 19189317, 20267166, 19644859 -19390567, 19358317, 19279273, 19706965, 18549238, 16863642, 19068970 -22528741, 18797519, 20825533, 19619732, 18607546, 20348653, 19649152 -19670108, 18940497, 18948177, 19315691, 19676905, 18964978, 19176326 -20165574, 19035573, 20413820, 17867700, 20558005, 19176223, 19532017 -20904530, 20134339, 19450314, 19074147, 22353346, 20868862, 18411216 -22507234, 20361671, 20425790, 18966843, 20009833, 22366558, 21329301 -20294666, 18191823, 19333670, 19195895, 19371175, 19307662, 19154375 -20043616, 20124446, 18914624, 19468991, 19883092, 21291274, 19382851 -19520602, 19174521, 21875360, 19676012, 19326908, 19658708, 19591608 -19402853, 20093776, 20618595, 21787056, 22380919, 21246723, 17835294 -19721304, 19068610, 19791377, 21665897, 22178855, 22173980, 20048359 -20746251, 19143550, 20898391, 19185876, 19627012, 20281121, 19577410 -22092979, 19001359, 14283239, 19518079, 18610915, 19490948, 17532734 -18674024, 18306996, 19309466, 19081128, 19524158, 19915271, 20122715 -21188532, 18791688, 20284155, 20890311, 21442094, 20596234, 18973548 -21296029, 19303936, 19597439, 20936905, 20235511, 21220620, 20880215 -18964939, 21756677, 19888853, 19534363, 19430401, 19354335, 19044962 -19639483, 22296366, 22353199, 21153266, 19409212, 19879746, 20657441 -19684504, 20528052, 19024808, 20977794, 20378086, 18799993, 21756661 -21260431, 18740837, 22923409, 19028800, 20877664, 20228093, 20879889 -19065556, 19723336, 19077215, 19604659, 21421886, 19524384, 17722075 -19308965, 18288842, 19048007, 19689979, 20446883, 18952989, 16870214 -19928926, 19835133, 21629064, 21526048, 19197175, 19180770, 20466628 -19902195, 19931709, 20318889, 19013183, 19730508, 19012119, 19067244 -20074391, 20356733, 14643995, 19512341, 19841800, 20331945, 19587324 -19065677, 19547370, 19578350, 21225209, 19637186, 20397490, 18967382 -19174430, 21241829, 19054077, 18674047, 20898997, 19708632, 19536415 -21091431, 19289642, 20869721, 22168163, 19335438, 19258504, 20447445 -17365043, 18856999, 19468347, 19869255, 20471920, 21373473, 21620471 -16359751, 18990693, 17890099, 19769480, 19439759, 19272708, 18990023 -19978542, 19329654, 20101006, 21300341, 20402832, 19873610, 20848335 -23229229, 21744290, 21668627, 21517440, 13542050, 19304354, 19052488 -20794034, 19291380, 21915719, 23260854, 18681056, 20952966, 19896336 -19076343, 19561643, 18618122, 19990037, 20440930, 18456643, 19699191 -19201867, 19487147, 18909599, 20831538, 19016730, 18250893, 20798891 -18743542, 20347562, 16619249, 18354830, 22551446, 19777862, 19687159 -21373076, 19174942, 20424899, 21188584, 19989009, 17414008, 20688221 -21899588, 20441797, 19157754, 19058490, 19032777, 22815955, 19399918 -18885870, 19434529, 21273804, 19018447, 21450666, 18893947, 18851894 -16923858, 18417036, 20919320, 19022470, 19284031, 20474192, 20173897 -22046677, 22062026, 19501299, 19385656, 20920911, 17274537, 20899461 -21315084, 19440586, 16887946, 22374754, 17319928, 19606174, 20708701 -18436647, 17655240, 19023822, 19124589, 19178851, 16439813, 19805359 -19597583, 18499088, 19155797, 19050649, 19393542 -``` - -### Version 12\.1\.0\.2\.v4 - -Version 12\.1\.0\.2\.v4 includes the following: -+ Oracle PSU 12\.1\.0\.2\.160419 \(22291127\) -+ Timezone file DSTv25 \(patch 22037014\) -+ Oracle recommended RDBMS patches for Oracle GoldenGate \(patch 17969866\) -+ Adds the ability for the master user to grant the EM\_EXPRESS\_BASIC and EM\_EXPRESS\_ALL roles -+ Adds the ability for the master user to grant privileges on SYS objects with the grant option using the RDSADMIN\.RDSADMIN\_UTIL\.GRANT\_SYS\_OBJECT procedure -+ Adds master user privileges to support most common schemas created by the Oracle Fusion Middleware Repository Creation Utility \(RCU\) - -#### Baseline: Oracle database patch set update 12\.1\.0\.2\.160419 \(patch 22291127, released April 2016\) - -Bugs fixed: - -``` - -21847223, 19189525, 19075256, 19141838, 22762046, 20117253, 19865345 -19791273, 19280225, 18845653, 19248799, 20951038, 19243521, 21756699 -18988834, 21281532, 19238590, 18921743, 20245930, 18799063, 19134173 -20373598, 19571367, 20476175, 20925795, 19018206, 20711718, 20387265 -20509482, 20588502, 19149990, 18849537, 17551063, 18886413, 19183343 -19703301, 21917884, 19001390, 18202441, 19189317, 19644859, 19358317 -19390567, 19279273, 19706965, 22528741, 19068970, 20825533, 19619732 -18607546, 20348653, 19649152, 19670108, 18940497, 18948177, 19315691 -19676905, 18964978, 19035573, 20165574, 19176326, 20413820, 20558005 -19176223, 19532017, 20904530, 20134339, 19450314, 22353346, 19074147 -18411216, 20361671, 20425790, 18966843, 21329301, 20294666, 19333670 -19195895, 19307662, 19371175, 20043616, 19154375, 20124446, 18914624 -19468991, 19883092, 19382851, 19520602, 19174521, 21875360, 19676012 -19326908, 19658708, 19591608, 20093776, 20618595, 21787056, 17835294 -19721304, 19791377, 19068610, 22173980, 20746251, 20048359, 19143550 -19185876, 19627012, 20281121, 19577410, 22092979, 19001359, 19518079 -18610915, 19490948, 18674024, 18306996, 19309466, 19081128, 19915271 -20122715, 21188532, 18791688, 20284155, 20890311, 21442094, 20596234 -18973548, 19303936, 19597439, 20936905, 20235511, 19888853, 21756677 -18964939, 19354335, 19430401, 19044962, 19639483, 21153266, 22353199 -19409212, 20657441, 19879746, 19684504, 19024808, 21260431, 21756661 -18799993, 20877664, 19028800, 20879889, 19065556, 19723336, 19077215 -19604659, 21421886, 19524384, 18288842, 19048007, 19689979, 20446883 -18952989, 16870214, 19928926, 19835133, 21526048, 20466628, 19197175 -19180770, 19902195, 20318889, 19730508, 19012119, 19067244, 20074391 -20356733, 14643995, 19512341, 19841800, 20331945, 19587324, 19547370 -19065677, 21225209, 19637186, 20397490, 18967382, 19174430, 19054077 -18674047, 19536415, 19708632, 21091431, 19289642, 22168163, 20869721 -19335438, 19258504, 20447445, 17365043, 18856999, 19468347, 20471920 -19869255, 21620471, 16359751, 18990693, 17890099, 19769480, 19439759 -19272708, 18990023, 19978542, 20402832, 20101006, 21300341, 19329654 -19873610, 21744290, 13542050, 21517440, 21668627, 19304354, 19052488 -20794034, 19291380, 21915719, 18681056, 20952966, 19896336, 19076343 -19561643, 19990037, 18618122, 20440930, 18456643, 19699191, 19487147 -18909599, 20831538, 18250893, 19016730, 18743542, 20347562, 16619249 -18354830, 19777862, 19687159, 19174942, 20424899, 19989009, 20688221 -21899588, 20441797, 19157754, 19032777, 19058490, 19399918, 18885870 -19434529, 21273804, 19018447, 18893947, 16923858, 18417036, 20919320 -19022470, 19284031, 20474192, 22046677, 20173897, 22062026, 19385656 -19501299, 17274537, 20899461, 21315084, 19440586, 22374754, 16887946 -19606174, 18436647, 17655240, 19023822, 19178851, 19124589, 16439813 -19805359, 19597583, 18499088, 19155797, 19050649, 19393542 -``` - -### Version 12\.1\.0\.2\.v3 - -Version 12\.1\.0\.2\.v3 includes the following: -+ Oracle PSU 12\.1\.0\.2\.160119 \(21948354\)\. -+ Timezone file DSTv25 \(patch 22037014 for 12\.1\.0\.2\)\. 12\.1\.0\.1 includes DSTv24, patch 20875898 \(unchanged from 12\.1\.0\.1\.v3\), because a backport of DSTv25 was unavailable at build time\. -+ Fixed an issue that prevented customers from creating more than 10 Directory objects in the database\. -+ Fixed an issue that prevented customers from re\-granting read privileges on the ADUMP and BDUMP Directory objects\. - -#### Baseline: Oracle database patch set update 12\.1\.0\.2\.160119 \(patch 21948354, released January 2016\) - -Bugs fixed: - -``` - -19189525, 19075256, 19141838, 19865345, 19791273, 19280225, 18845653 -20951038, 19243521, 19248799, 21756699, 18988834, 19238590, 21281532 -20245930, 18921743, 18799063, 19134173, 19571367, 20476175, 20925795 -19018206, 20509482, 20387265, 20588502, 19149990, 18849537, 18886413 -17551063, 19183343, 19703301, 19001390, 18202441, 19189317, 19644859 -19358317, 19390567, 19279273, 19706965, 19068970, 19619732, 20348653 -18607546, 18940497, 19670108, 19649152, 18948177, 19315691, 19676905 -18964978, 19035573, 20165574, 19176326, 20413820, 20558005, 19176223 -19532017, 20134339, 19074147, 18411216, 20361671, 20425790, 18966843 -20294666, 19307662, 19371175, 19195895, 19154375, 19468991, 19174521 -19520602, 19382851, 21875360, 19326908, 19658708, 20093776, 20618595 -21787056, 17835294, 19791377, 19068610, 20048359, 20746251, 19143550 -19185876, 19627012, 20281121, 19577410, 22092979, 19001359, 19518079 -18610915, 19490948, 18674024, 18306996, 19309466, 19081128, 19915271 -20122715, 21188532, 20284155, 18791688, 20890311, 21442094, 18973548 -19303936, 19597439, 20235511, 18964939, 19430401, 19044962, 19409212 -19879746, 20657441, 19684504, 19024808, 18799993, 20877664, 19028800 -19065556, 19723336, 19077215, 19604659, 21421886, 19524384, 19048007 -18288842, 19689979, 20446883, 18952989, 16870214, 19928926, 21526048 -19180770, 19197175, 19902195, 20318889, 19730508, 19012119, 19067244 -20074391, 19512341, 19841800, 14643995, 20331945, 19587324, 19547370 -19065677, 19637186, 21225209, 20397490, 18967382, 19174430, 18674047 -19054077, 19536415, 19708632, 19289642, 20869721, 19335438, 17365043 -18856999, 19869255, 20471920, 19468347, 21620471, 16359751, 18990693 -17890099, 19439759, 19769480, 19272708, 19978542, 20101006, 21300341 -20402832, 19329654, 19873610, 21668627, 21517440, 19304354, 19052488 -20794034, 19291380, 18681056, 19896336, 19076343, 19561643, 18618122 -20440930, 18456643, 19699191, 18909599, 19487147, 18250893, 19016730 -18743542, 20347562, 16619249, 18354830, 19687159, 19174942, 20424899 -19989009, 20688221, 20441797, 19157754, 19032777, 19058490, 19399918 -18885870, 19434529, 19018447, 18417036, 20919320, 19022470, 19284031 -20474192, 20173897, 22062026, 19385656, 19501299, 17274537, 20899461 -19440586, 16887946, 19606174, 18436647, 17655240, 19023822, 19178851 -19124589, 19805359, 19597583, 19155797, 19393542, 19050649 -``` - -### Version 12\.1\.0\.2\.v2 - -Version 12\.1\.0\.2\.v2 includes the following: -+ Oracle PSU 12\.1\.0\.2\.5 \(21359755\) -+ Includes the Daylight Saving Time Patch, patch 20875898: DST\-24, that came out after the April 2015 PSU\. - -#### Baseline: Oracle database patch set update 12\.1\.0\.2\.5 \(patch 21359755, released October 2015\) - -Bugs fixed: - -``` -19189525, 19075256, 19865345, 19791273, 19280225, 18845653, 19248799 -19243521, 18988834, 19238590, 21281532, 18921743, 20245930, 19134173 -19571367, 20476175, 20925795, 19018206, 20387265, 19149990, 18849537 -19183343, 19703301, 19001390, 18202441, 19189317, 19644859, 19390567 -19358317, 19279273, 19706965, 19068970, 19619732, 18607546, 20348653 -18940497, 19670108, 19649152, 18948177, 19315691, 19676905, 18964978 -20165574, 19035573, 19176326, 20413820, 20558005, 19176223, 19532017 -20134339, 19074147, 18411216, 20361671, 20425790, 18966843, 20294666 -19371175, 19307662, 19195895, 19154375, 19468991, 19174521, 19520602 -19382851, 19658708, 20093776, 17835294, 19068610, 19791377, 20746251 -20048359, 19143550, 19185876, 19627012, 20281121, 19577410, 19001359 -19518079, 18610915, 18674024, 18306996, 19309466, 19081128, 19915271 -20122715, 20284155, 18791688, 21442094, 19303936, 19597439, 20235511 -18964939, 19430401, 19044962, 19409212, 20657441, 19684504, 19024808 -19028800, 19065556, 19723336, 19077215, 21421886, 19524384, 19048007 -18288842, 18952989, 16870214, 19928926, 19180770, 19197175, 19730508 -19012119, 19067244, 20074391, 19841800, 19512341, 14643995, 20331945 -19587324, 19065677, 19547370, 19637186, 21225209, 20397490, 18967382 -19174430, 18674047, 19054077, 19708632, 19536415, 19289642, 19335438 -17365043, 18856999, 20471920, 19468347, 21620471, 16359751, 18990693 -19439759, 19769480, 19272708, 19978542, 19329654, 20402832, 19873610 -19304354, 19052488, 19291380, 18681056, 19896336, 19076343, 19561643 -18618122, 20440930, 18456643, 19699191, 18909599, 19487147, 18250893 -19016730, 18743542, 20347562, 16619249, 18354830, 19687159, 19174942 -20424899, 19989009, 20688221, 20441797, 19157754, 19058490, 19032777 -19399918, 18885870, 19434529, 19018447, 18417036, 20919320, 19284031 -19022470, 20474192, 22062026, 19385656, 19501299, 17274537, 20899461 -19440586, 19606174, 18436647, 19023822, 19178851, 19124589, 19805359 -19597583, 19155797, 19393542, 19050649 -``` - -### Version 12\.1\.0\.2\.v1 - -Version 12\.1\.0\.2\.v1 includes the following: -+ Oracle PSU 12\.1\.0\.2\.3 \(20299023\) -+ The In\-Memory option allows storing a subset of data in an in\-memory column format optimized for performance\. -+ Installs additional Oracle Text knowledge bases from Oracle Database\. Examples media \(English and French\) -+ Provides access to DBMS\_REPAIR through RDSADMIN\.RDSADMIN\_DBMS\_REPAIR -+ Grants ALTER DATABASE LINK, ALTER PUBLIC DATABASE LINK, EXEMPT ACCESS POLICY, EXEMPT IDENTITY POLICY, and EXEMPT REDACTION POLICY to master user - -**Note** -Version 12\.1\.0\.2\.v1 supports Enterprise Edition only\. - -#### Baseline: Oracle database patch set update 12\.1\.0\.2\.3 \(patch 20299023, released April 2015\) - -Bugs fixed: - -``` - -19189525, 19065556, 19075256, 19723336, 19077215, 19865345, 18845653 -19280225, 19524384, 19248799, 18988834, 19048007, 18288842, 19238590 -18921743, 18952989, 16870214, 19928926, 19134173, 19180770, 19018206 -19197175, 19149990, 18849537, 19730508, 19183343, 19012119, 19001390 -18202441, 19067244, 19189317, 19644859, 19358317, 19390567, 20074391 -19279273, 19706965, 19068970, 19841800, 19512341, 14643995, 19619732 -20348653, 18607546, 18940497, 19670108, 19649152, 19065677, 19547370 -18948177, 19315691, 19637186, 19676905, 18964978, 19035573, 19176326 -18967382, 19174430, 19176223, 19532017, 18674047, 19074147, 19054077 -19536415, 19708632, 19289642, 20425790, 19335438, 18856999, 19371175 -19468347, 19195895, 19154375, 16359751, 18990693, 19439759, 19769480 -19272708, 19978542, 19329654, 19873610, 19174521, 19520602, 19382851 -19658708, 19304354, 19052488, 19291380, 18681056, 19896336, 17835294 -19076343, 19791377, 19068610, 19561643, 18618122, 20440930, 18456643 -18909599, 19487147, 19143550, 19185876, 19016730, 18250893, 20347562 -19627012, 16619249, 18354830, 19577410, 19687159, 19001359, 19174942 -19518079, 18610915, 18674024, 18306996, 19309466, 19081128, 19915271 -19157754, 19058490, 20284155, 18791688, 18885870, 19303936, 19434529 -19018447, 18417036, 19597439, 20235511, 19022470, 18964939, 19430401 -19044962, 19385656, 19501299, 17274537, 19409212, 19440586, 19606174 -18436647, 19023822, 19684504, 19178851, 19124589, 19805359, 19024808 -19597583, 19155797, 19393542, 19050649, 19028800 -``` \ No newline at end of file diff --git a/doc_source/Appendix.Oracle.PatchComposition.md b/doc_source/Appendix.Oracle.PatchComposition.md deleted file mode 100644 index 7a810dd..0000000 --- a/doc_source/Appendix.Oracle.PatchComposition.md +++ /dev/null @@ -1,82 +0,0 @@ -# Oracle database engine release notes - -Updates to your Amazon RDS for Oracle DB instances keep them current\. If you apply updates, you can be confident that your DB instance is running a version of the database software that has been tested by both Oracle and Amazon\. We don't support applying one\-off patches to individual DB instances\. - -You can specify any currently supported Oracle Database version when creating a new DB instance\. You can specify the major version, such as Oracle Database 12c Release 1 \(12\.1\), and any supported minor version for the specified major version\. If no version is specified, Amazon RDS defaults to a supported version, typically the most recent version\. If a major version is specified but a minor version is not, Amazon RDS defaults to a recent release of the major version that you have specified\. To see a list of supported versions and defaults for newly created DB instances, use the [https://docs.aws.amazon.com/cli/latest/reference/rds/describe-db-engine-versions.html](https://docs.aws.amazon.com/cli/latest/reference/rds/describe-db-engine-versions.html) AWS CLI command\. - -## Oracle Database 21c \(21\.0\.0\.0\), Oracle Database 19c \(19\.0\.0\.0\), and Oracle Database 12c Release 2 \(12\.2\.0\.1\) - -For the following releases, Amazon RDS incorporates bug fixes from Oracle by using Release Updates \(RUs\) and Release Updates Revisions \(RURs\): -+ Oracle Database 21c \(21\.0\.0\.0\) -+ Oracle Database 19c \(19\.0\.0\.0\) -+ Oracle Database 18c \(18\.0\.0\.0\) -+ Oracle Database 12c Release 2 \(12\.2\.0\.1\) - -**Note** -Amazon RDS doesn't support applying one\-off patches to individual DB instances\. - -The following table describes the supported RUs and RURs\. - - -**** - -| RU and RUR | Oracle Database 21c \(21\.0\.0\.0\) | Oracle Database 19c \(19\.0\.0\.0\) | Oracle Database 18c \(18\.0\.0\.0\) | Oracle Database 12c Release 2 \(12\.2\.0\.1\) | -| --- | --- | --- | --- | --- | -| 2022 January | [Version 21\.0\.0\.0\.ru\-2022\-01\.rur\-2022\-01\.r1](Appendix.Oracle.RU-RUR.21.0.0.0.md#Appendix.Oracle.RU-RUR.21.0.0.0.ru-2022-01.rur-2022-01.r1) | — | — | — | -| 2021 October | — | [Version 19\.0\.0\.0\.ru\-2021\-10\.rur\-2021\-10\.r1](Appendix.Oracle.RU-RUR.19.0.0.0.md#Appendix.Oracle.RU-RUR.19.0.0.0.ru-2021-10.rur-2021-10.r1) | — | [Version 12\.2\.0\.1\.ru\-2021\-10\.rur\-2021\-10\.r1](Appendix.Oracle.RU-RUR.12.2.0.1.md#Appendix.Oracle.RU-RUR.12.2.0.1.ru-2021-10.rur-2021-10.r1) | -| 2021 July | — | [Version 19\.0\.0\.0\.ru\-2021\-07\.rur\-2021\-07\.r1](Appendix.Oracle.RU-RUR.19.0.0.0.md#Appendix.Oracle.RU-RUR.19.0.0.0.ru-2021-07.rur-2021-07.r1) | — | [Version 12\.2\.0\.1\.ru\-2021\-07\.rur\-2021\-07\.r1](Appendix.Oracle.RU-RUR.12.2.0.1.md#Appendix.Oracle.RU-RUR.12.2.0.1.ru-2021-07.rur-2021-07.r1) | -| 2021 April | — | [Version 19\.0\.0\.0\.ru\-2021\-04\.rur\-2021\-04\.r1](Appendix.Oracle.RU-RUR.19.0.0.0.md#Appendix.Oracle.RU-RUR.19.0.0.0.ru-2021-04.rur-2021-04.r1) | [Version 18\.0\.0\.0\.ru\-2021\-04\.rur\-2021\-04\.r1](Appendix.Oracle.RU-RUR.18.0.0.0.md#Appendix.Oracle.RU-RUR.18.0.0.0.ru-2021-04.rur-2021-04.r1) | [Version 12\.2\.0\.1\.ru\-2021\-04\.rur\-2021\-04\.r1](Appendix.Oracle.RU-RUR.12.2.0.1.md#Appendix.Oracle.RU-RUR.12.2.0.1.ru-2021-04.rur-2021-04.r1) | -| 2021 January | — | [Version 19\.0\.0\.0\.ru\-2021\-01\.rur\-2021\-01\.r2](Appendix.Oracle.RU-RUR.19.0.0.0.md#Appendix.Oracle.RU-RUR.19.0.0.0.ru-2021-01.rur-2021-01.r2) and [Version 19\.0\.0\.0\.ru\-2021\-01\.rur\-2021\-01\.r1](Appendix.Oracle.RU-RUR.19.0.0.0.md#Appendix.Oracle.RU-RUR.19.0.0.0.ru-2021-01.rur-2021-01.r1) | [Version 18\.0\.0\.0\.ru\-2021\-01\.rur\-2021\-01\.r1](Appendix.Oracle.RU-RUR.18.0.0.0.md#Appendix.Oracle.RU-RUR.18.0.0.0.ru-2021-01.rur-2021-01.r1) | [Version 12\.2\.0\.1\.ru\-2021\-01\.rur\-2021\-01\.r1](Appendix.Oracle.RU-RUR.12.2.0.1.md#Appendix.Oracle.RU-RUR.12.2.0.1.ru-2021-01.rur-2021-01.r1) | -| 2020 October | — | [19\.0\.0\.0\.ru\-2020\-10\.rur\-2020\-10\.r1](Appendix.Oracle.RU-RUR.19.0.0.0.md#Appendix.Oracle.RU-RUR.19.0.0.0.ru-2020-10.rur-2020-10.r1) | [18\.0\.0\.0\.ru\-2020\-10\.rur\-2020\-10\.r1](Appendix.Oracle.RU-RUR.18.0.0.0.md#Appendix.Oracle.RU-RUR.18.0.0.0.ru-2020-10.rur-2020-10.r1) | [12\.2\.0\.1\.ru\-2020\-10\.rur\-2020\-10\.r1](Appendix.Oracle.RU-RUR.12.2.0.1.md#Appendix.Oracle.RU-RUR.12.2.0.1.ru-2020-10.rur-2020-10.r1) | -| 2020 July | — | [19\.0\.0\.0\.ru\-2020\-07\.rur\-2020\-07\.r1](Appendix.Oracle.RU-RUR.19.0.0.0.md#Appendix.Oracle.RU-RUR.19.0.0.0.ru-2020-07.rur-2020-07.r1) | [18\.0\.0\.0\.ru\-2020\-07\.rur\-2020\-07\.r1](Appendix.Oracle.RU-RUR.18.0.0.0.md#Appendix.Oracle.RU-RUR.18.0.0.0.ru-2020-07.rur-2020-07.r1) | [12\.2\.0\.1\.ru\-2020\-07\.rur\-2020\-07\.r1](Appendix.Oracle.RU-RUR.12.2.0.1.md#Appendix.Oracle.RU-RUR.12.2.0.1.ru-2020-07.rur-2020-07.r1) | -| 2020 April | — | [19\.0\.0\.0\.ru\-2020\-04\.rur\-2020\-04\.r1](Appendix.Oracle.RU-RUR.19.0.0.0.md#Appendix.Oracle.RU-RUR.19.0.0.0.ru-2020-04.rur-2020-04.r1) | [18\.0\.0\.0\.ru\-2020\-04\.rur\-2020\-04\.r1](Appendix.Oracle.RU-RUR.18.0.0.0.md#Appendix.Oracle.RU-RUR.18.0.0.0.ru-2020-04.rur-2020-04.r1) | [12\.2\.0\.1\.ru\-2020\-04\.rur\-2020\-04\.r1](Appendix.Oracle.RU-RUR.12.2.0.1.md#Appendix.Oracle.RU-RUR.12.2.0.1.ru-2020-04.rur-2020-04.r1) | -| 2020 January | — | [19\.0\.0\.0\.ru\-2020\-01\.rur\-2020\-01\.r1](Appendix.Oracle.RU-RUR.19.0.0.0.md#Appendix.Oracle.RU-RUR.19.0.0.0.ru-2020-01.rur-2020-01.r1) | [18\.0\.0\.0\.ru\-2020\-01\.rur\-2020\-01\.r1](Appendix.Oracle.RU-RUR.18.0.0.0.md#Appendix.Oracle.RU-RUR.18.0.0.0.ru-2020-01.rur-2020-01.r1) | [12\.2\.0\.1\.ru\-2020\-01\.rur\-2020\-01\.r1](Appendix.Oracle.RU-RUR.12.2.0.1.md#Appendix.Oracle.RU-RUR.12.2.0.1.ru-2020-01.rur-2020-01.r1) | -| 2019 October | — | [19\.0\.0\.0\.ru\-2019\-10\.rur\-2019\-10\.r1](Appendix.Oracle.RU-RUR.19.0.0.0.md#Appendix.Oracle.RU-RUR.19.0.0.0.ru-2019-10.rur-2019-10.r1) | [18\.0\.0\.0\.ru\-2019\-10\.rur\-2019\-10\.r1](Appendix.Oracle.RU-RUR.18.0.0.0.md#Appendix.Oracle.RU-RUR.18.0.0.0.ru-2019-10.rur-2019-10.r1) | [12\.2\.0\.1\.ru\-2019\-10\.rur\-2019\-10\.r1](Appendix.Oracle.RU-RUR.12.2.0.1.md#Appendix.Oracle.RU-RUR.12.2.0.1.ru-2019-10.rur-2019-10.r1) | -| 2019 July | — | [19\.0\.0\.0\.ru\-2019\-07\.rur\-2019\-07\.r1](Appendix.Oracle.RU-RUR.19.0.0.0.md#Appendix.Oracle.RU-RUR.19.0.0.0.ru-2019-07.rur-2019-07.r1) | [18\.0\.0\.0\.ru\-2019\-07\.rur\-2019\-07\.r1](Appendix.Oracle.RU-RUR.18.0.0.0.md#Appendix.Oracle.RU-RUR.18.0.0.0.ru-2019-07.rur-2019-07.r1) | [12\.2\.0\.1\.ru\-2019\-07\.rur\-2019\-07\.r1](Appendix.Oracle.RU-RUR.12.2.0.1.md#Appendix.Oracle.RU-RUR.12.2.0.1.ru-2019-07.rur-2019-07.r1) | -| 2019 April | — | — | — | [12\.2\.0\.1\.ru\-2019\-04\.rur\-2019\-04\.r1](Appendix.Oracle.RU-RUR.12.2.0.1.md#Appendix.Oracle.RU-RUR.12.2.0.1.ru-2019-04.rur-2019-04.r1) | -| 2019 January | — | — | — | [12\.2\.0\.1\.ru\-2019\-01\.rur\-2019\-01\.r1](Appendix.Oracle.RU-RUR.12.2.0.1.md#Appendix.Oracle.RU-RUR.12.2.0.1.ru-2019-01.rur-2019-01.r1) | -| 2018 October | — | — | — | [12\.2\.0\.1\.ru\-2018\-10\.rur\-2018\-10\.r1](Appendix.Oracle.RU-RUR.12.2.0.1.md#Appendix.Oracle.RU-RUR.12.2.0.1.ru-2018-10.rur-2018-10.r1) | - -## Oracle versions 12\.1\.0\.2 and 11\.2\.0\.4 - -For Amazon RDS for Oracle Database 12c Release 1 \(12\.1\.0\.2\) and Oracle Database 11g Release 2 \(11\.2\.0\.4\), Amazon RDS incorporates bug fixes from Oracle by using their quarterly Database Patch Set Updates \(PSUs\)\. If you apply updates, you can be confident that your DB instance is running a version of the database software that has been tested by both Oracle and Amazon\. We don't support applying one\-off patches to individual DB instances\. - -**Note** -RDS for Oracle Database 11g is deprecated\. The 11\.2\.0\.4 information in this section is only relevant when you want to upgrade an 11g snapshot\. - -To find what Oracle Patch Set Updates \(PSUs\) are applied to Amazon RDS for Oracle Database 12c Release 1 \(12\.1\.0\.2\) and Oracle Database 11g Release 2 \(11\.2\.0\.4\), see the following table\. - - -**** - -| PSU | Oracle Database 12c Release 1 \(12\.1\.0\.2\) | Oracle Database 11g \(11\.2\.0\.4\) | -| --- | --- | --- | -| 2021 October | [12\.1\.0\.2\.v26](Appendix.Oracle.PatchComposition.12.1.0.2.md#Appendix.Oracle.PatchComposition.12.1.0.2.v26) | — | -| 2021 July | [12\.1\.0\.2\.v25](Appendix.Oracle.PatchComposition.12.1.0.2.md#Appendix.Oracle.PatchComposition.12.1.0.2.v25) | — | -| 2021 April | [12\.1\.0\.2\.v24](Appendix.Oracle.PatchComposition.12.1.0.2.md#Appendix.Oracle.PatchComposition.12.1.0.2.v24) | — | -| 2021 January | [12\.1\.0\.2\.v23](Appendix.Oracle.PatchComposition.12.1.0.2.md#Appendix.Oracle.PatchComposition.12.1.0.2.v23) | — | -| 2020 October | [12\.1\.0\.2\.v22](Appendix.Oracle.PatchComposition.12.1.0.2.md#Appendix.Oracle.PatchComposition.12.1.0.2.v22) | [11\.2\.0\.4\.v26](Appendix.Oracle.PatchComposition.11.2.0.4.md#Appendix.Oracle.PatchComposition.11.2.0.4.v26) | -| 2020 July | [12\.1\.0\.2\.v21](Appendix.Oracle.PatchComposition.12.1.0.2.md#Appendix.Oracle.PatchComposition.12.1.0.2.v21) | [11\.2\.0\.4\.v25](Appendix.Oracle.PatchComposition.11.2.0.4.md#Appendix.Oracle.PatchComposition.11.2.0.4.v25) | -| 2020 April | [12\.1\.0\.2\.v20](Appendix.Oracle.PatchComposition.12.1.0.2.md#Appendix.Oracle.PatchComposition.12.1.0.2.v20) | [11\.2\.0\.4\.v24](Appendix.Oracle.PatchComposition.11.2.0.4.md#Appendix.Oracle.PatchComposition.11.2.0.4.v24) | -| 2020 January | [12\.1\.0\.2\.v19](Appendix.Oracle.PatchComposition.12.1.0.2.md#Appendix.Oracle.PatchComposition.12.1.0.2.v19) | [11\.2\.0\.4\.v23](Appendix.Oracle.PatchComposition.11.2.0.4.md#Appendix.Oracle.PatchComposition.11.2.0.4.v23) | -| 2019 October | [12\.1\.0\.2\.v18](Appendix.Oracle.PatchComposition.12.1.0.2.md#Appendix.Oracle.PatchComposition.12.1.0.2.v18) | [11\.2\.0\.4\.v22](Appendix.Oracle.PatchComposition.11.2.0.4.md#Appendix.Oracle.PatchComposition.11.2.0.4.v22) | -| 2019 July | [12\.1\.0\.2\.v17](Appendix.Oracle.PatchComposition.12.1.0.2.md#Appendix.Oracle.PatchComposition.12.1.0.2.v17) | [11\.2\.0\.4\.v21](Appendix.Oracle.PatchComposition.11.2.0.4.md#Appendix.Oracle.PatchComposition.11.2.0.4.v21) | -| 2019 April | [12\.1\.0\.2\.v16](Appendix.Oracle.PatchComposition.12.1.0.2.md#Appendix.Oracle.PatchComposition.12.1.0.2.v16) | [11\.2\.0\.4\.v20](Appendix.Oracle.PatchComposition.11.2.0.4.md#Appendix.Oracle.PatchComposition.11.2.0.4.v20) | -| 2019 January | [12\.1\.0\.2\.v15](Appendix.Oracle.PatchComposition.12.1.0.2.md#Appendix.Oracle.PatchComposition.12.1.0.2.v15) | [11\.2\.0\.4\.v19](Appendix.Oracle.PatchComposition.11.2.0.4.md#Appendix.Oracle.PatchComposition.11.2.0.4.v19) | -| 2018 October | [12\.1\.0\.2\.v14](Appendix.Oracle.PatchComposition.12.1.0.2.md#Appendix.Oracle.PatchComposition.12.1.0.2.v14) | [11\.2\.0\.4\.v18](Appendix.Oracle.PatchComposition.11.2.0.4.md#Appendix.Oracle.PatchComposition.11.2.0.4.v18) | -| 2018 July | [12\.1\.0\.2\.v13](Appendix.Oracle.PatchComposition.12.1.0.2.md#Appendix.Oracle.PatchComposition.12.1.0.2.v13) | [11\.2\.0\.4\.v17](Appendix.Oracle.PatchComposition.11.2.0.4.md#Appendix.Oracle.PatchComposition.11.2.0.4.v17) | -| 2018 April | [12\.1\.0\.2\.v12](Appendix.Oracle.PatchComposition.12.1.0.2.md#Appendix.Oracle.PatchComposition.12.1.0.2.v12) | [11\.2\.0\.4\.v16](Appendix.Oracle.PatchComposition.11.2.0.4.md#Appendix.Oracle.PatchComposition.11.2.0.4.v16) | -| 2018 January | [12\.1\.0\.2\.v11](Appendix.Oracle.PatchComposition.12.1.0.2.md#Appendix.Oracle.PatchComposition.12.1.0.2.v11) | [11\.2\.0\.4\.v15](Appendix.Oracle.PatchComposition.11.2.0.4.md#Appendix.Oracle.PatchComposition.11.2.0.4.v15) | -| 2017 October | [12\.1\.0\.2\.v10](Appendix.Oracle.PatchComposition.12.1.0.2.md#Appendix.Oracle.PatchComposition.12.1.0.2.v10) | [11\.2\.0\.4\.v14](Appendix.Oracle.PatchComposition.11.2.0.4.md#Appendix.Oracle.PatchComposition.11.2.0.4.v14) | -| 2017 July | [12\.1\.0\.2\.v9](Appendix.Oracle.PatchComposition.12.1.0.2.md#Appendix.Oracle.PatchComposition.12.1.0.2.v9) | [11\.2\.0\.4\.v13](Appendix.Oracle.PatchComposition.11.2.0.4.md#Appendix.Oracle.PatchComposition.11.2.0.4.v13) | -| 2017 April | [12\.1\.0\.2\.v8](Appendix.Oracle.PatchComposition.12.1.0.2.md#Appendix.Oracle.PatchComposition.12.1.0.2.v8) | [11\.2\.0\.4\.v12](Appendix.Oracle.PatchComposition.11.2.0.4.md#Appendix.Oracle.PatchComposition.11.2.0.4.v12) | -| 2017 January | [12\.1\.0\.2\.v7](Appendix.Oracle.PatchComposition.12.1.0.2.md#Appendix.Oracle.PatchComposition.12.1.0.2.v7) | [11\.2\.0\.4\.v11](Appendix.Oracle.PatchComposition.11.2.0.4.md#Appendix.Oracle.PatchComposition.11.2.0.4.v11) | -| 2016 October | [12\.1\.0\.2\.v6](Appendix.Oracle.PatchComposition.12.1.0.2.md#Appendix.Oracle.PatchComposition.12.1.0.2.v6) | [11\.2\.0\.4\.v10](Appendix.Oracle.PatchComposition.11.2.0.4.md#Appendix.Oracle.PatchComposition.11.2.0.4.v10) | -| 2016 July | [12\.1\.0\.2\.v5](Appendix.Oracle.PatchComposition.12.1.0.2.md#Appendix.Oracle.PatchComposition.12.1.0.2.v5) | [11\.2\.0\.4\.v9](Appendix.Oracle.PatchComposition.11.2.0.4.md#Appendix.Oracle.PatchComposition.11.2.0.4.v9) | -| 2016 April | [12\.1\.0\.2\.v4](Appendix.Oracle.PatchComposition.12.1.0.2.md#Appendix.Oracle.PatchComposition.12.1.0.2.v4) | [11\.2\.0\.4\.v8](Appendix.Oracle.PatchComposition.11.2.0.4.md#Appendix.Oracle.PatchComposition.11.2.0.4.v8) | -| 2016 January | [12\.1\.0\.2\.v3](Appendix.Oracle.PatchComposition.12.1.0.2.md#Appendix.Oracle.PatchComposition.12.1.0.2.v3) | [11\.2\.0\.4\.v7](Appendix.Oracle.PatchComposition.11.2.0.4.md#Appendix.Oracle.PatchComposition.11.2.0.4.v7) | -| 2015 October | [12\.1\.0\.2\.v2](Appendix.Oracle.PatchComposition.12.1.0.2.md#Appendix.Oracle.PatchComposition.12.1.0.2.v2) | [11\.2\.0\.4\.v6](Appendix.Oracle.PatchComposition.11.2.0.4.md#Appendix.Oracle.PatchComposition.11.2.0.4.v6) [11\.2\.0\.4\.v5](Appendix.Oracle.PatchComposition.11.2.0.4.md#Appendix.Oracle.PatchComposition.11.2.0.4.v5) | -| 2015 April | [12\.1\.0\.2\.v1](Appendix.Oracle.PatchComposition.12.1.0.2.md#Appendix.Oracle.PatchComposition.12.1.0.2.v1) | [11\.2\.0\.4\.v4](Appendix.Oracle.PatchComposition.11.2.0.4.md#Appendix.Oracle.PatchComposition.11.2.0.4.v4) | -| 2014 October | — | [11\.2\.0\.4\.v3](Appendix.Oracle.PatchComposition.11.2.0.4.md#Appendix.Oracle.PatchComposition.11.2.0.4.v3) | -| 2014 July | — | [11\.2\.0\.4\.v2](Appendix.Oracle.PatchComposition.11.2.0.4.md#Appendix.Oracle.PatchComposition.11.2.0.4.v2) \(Deprecated\) | -| 2014 January | — | [11\.2\.0\.4\.v1](Appendix.Oracle.PatchComposition.11.2.0.4.md#Appendix.Oracle.PatchComposition.11.2.0.4.v1) | \ No newline at end of file diff --git a/doc_source/Appendix.Oracle.RU-RUR.12.2.0.1.md b/doc_source/Appendix.Oracle.RU-RUR.12.2.0.1.md deleted file mode 100644 index eb2e0df..0000000 --- a/doc_source/Appendix.Oracle.RU-RUR.12.2.0.1.md +++ /dev/null @@ -1,3423 +0,0 @@ -# Database engine: 12\.2\.0\.1 - -For Oracle Database 12c Release 2 \(12\.2\.0\.1\), Oracle changed the way it releases Oracle Database updates\. Instead of Patch Set Updates \(PSUs\), Oracle supplies Release Updates \(RUs\) and Release Updates Revisions \(RURs\)\. RUs contain optimizer changes, feature additions, and security fixes\. RURs only contain security fixes for the two preceding quarterly patch cycles\. With this new system, you have more control over the features that you install with each update\. - -The naming conventions have also changed for Oracle Database 12c version Release 2 \(12\.2\.0\.1\) versions\. In previous versions, Amazon RDS for Oracle used the PSU naming convention of *oracle\-version*\.v*patch\-version*\. The *patch\-version* corresponded with an Oracle PSU\. For example, in Oracle for Amazon RDS version 12\.1\.0\.2\.v13, the v13 part of the version number corresponds with an Oracle PSU\. - -Oracle Database 12c Release 2 \(12\.2\.0\.1\) naming conventions account for both RU and RUR updates\. For example, the first Amazon RDS for Oracle version available is 12\.2\.0\.1\.ru\-2018\-10\.rur\-2018\-10\.r1\. In this example, 12\.2 is the major version, and 0\.1 is the minor version\. The revision version has the following parts: -+ ru\-2018\-10 – the October RU -+ rur\-2018\-10 – the October RUR for the October RU -+ r1 – Internal Amazon RDS revision, which lets Amazon RDS differentiate between emergency patches of pre\-existing RU/RURs - -For more information about the new Oracle Database versioning system, see the posts [ Differences between PSU / BP and RU / RUR](https://mikedietrichde.com/2017/10/24/differences-psu-bp-ru-rur/) at the Upgrade your Database – NOW\! blog and [ RU and RUR patches for Oracle Database 12c Release 2 \(12\.2\)](http://oracle-help.com/oracle-12c/oracle-12cr2/ru-rur-patches-oracle-12-2/) at the Oracle–Help blog\. - -The following versions are available for Oracle database engine 12\.2\.0\.1: -+ [Version 12\.2\.0\.1\.ru\-2021\-10\.rur\-2021\-10\.r1](#Appendix.Oracle.RU-RUR.12.2.0.1.ru-2021-10.rur-2021-10.r1) -+ [Version 12\.2\.0\.1\.ru\-2021\-07\.rur\-2021\-07\.r1](#Appendix.Oracle.RU-RUR.12.2.0.1.ru-2021-07.rur-2021-07.r1) -+ [Version 12\.2\.0\.1\.ru\-2021\-04\.rur\-2021\-04\.r1](#Appendix.Oracle.RU-RUR.12.2.0.1.ru-2021-04.rur-2021-04.r1) -+ [Version 12\.2\.0\.1\.ru\-2021\-01\.rur\-2021\-01\.r1](#Appendix.Oracle.RU-RUR.12.2.0.1.ru-2021-01.rur-2021-01.r1) -+ [Version 12\.2\.0\.1\.ru\-2020\-10\.rur\-2020\-10\.r1](#Appendix.Oracle.RU-RUR.12.2.0.1.ru-2020-10.rur-2020-10.r1) -+ [Version 12\.2\.0\.1\.ru\-2020\-07\.rur\-2020\-07\.r1](#Appendix.Oracle.RU-RUR.12.2.0.1.ru-2020-07.rur-2020-07.r1) -+ [Version 12\.2\.0\.1\.ru\-2020\-04\.rur\-2020\-04\.r1](#Appendix.Oracle.RU-RUR.12.2.0.1.ru-2020-04.rur-2020-04.r1) -+ [Version 12\.2\.0\.1\.ru\-2020\-01\.rur\-2020\-01\.r1](#Appendix.Oracle.RU-RUR.12.2.0.1.ru-2020-01.rur-2020-01.r1) -+ [Version 12\.2\.0\.1\.ru\-2019\-10\.rur\-2019\-10\.r1](#Appendix.Oracle.RU-RUR.12.2.0.1.ru-2019-10.rur-2019-10.r1) -+ [Version 12\.2\.0\.1\.ru\-2019\-07\.rur\-2019\-07\.r1](#Appendix.Oracle.RU-RUR.12.2.0.1.ru-2019-07.rur-2019-07.r1) -+ [Version 12\.2\.0\.1\.ru\-2019\-04\.rur\-2019\-04\.r1](#Appendix.Oracle.RU-RUR.12.2.0.1.ru-2019-04.rur-2019-04.r1) -+ [Version 12\.2\.0\.1\.ru\-2019\-01\.rur\-2019\-01\.r1](#Appendix.Oracle.RU-RUR.12.2.0.1.ru-2019-01.rur-2019-01.r1) -+ [Version 12\.2\.0\.1\.ru\-2018\-10\.rur\-2018\-10\.r1](#Appendix.Oracle.RU-RUR.12.2.0.1.ru-2018-10.rur-2018-10.r1) - -## Version 12\.2\.0\.1\.ru\-2021\-10\.rur\-2021\-10\.r1 - -Version 12\.2\.0\.1\.ru\-2021\-10\.rur\-2021\-10\.r1 includes the following: -+ Patch 33261817: DATABASE OCT 2021 RELEASE UPDATE 12\.2\.0\.1\.211019 -+ Patch 33192662: OJVM RELEASE UPDATE 12\.2\.0\.1\.211019 -+ Patch 32327201: RDBMS \- DSTV36 UPDATE \- TZDATA2020E -+ Patch 29213893: DBMS\_STATS FAILING WITH ERROR ORA\-01422 WHEN GATHERING STATS FOR USER$ TABLE -+ Patch 28730253: SUPPORT NEW ERA REIWA FOR JAPANESE IMPERIAL CALENDAR -+ Patch 26352615: SPILLOVER AUDIT FILES CANNOT BE FOUND ORA\-46372 -+ PreUpgrade Jar: preupgrade\_12201\_cbuild\_24\_lf\.zip - -### Combined Patches for Version 12\.2\.0\.1\.ru\-2021\-10\.rur\-2021\-10\.r1, Released October 2021 - -Bugs fixed: - -``` -. -7391838, 8480838, 8932139, 8975044, 12763598, 13554903, 14221306 -14690846, 15931756, 16002385, 16438495, 16727454, 16942578, 17027695 -17533661, 17947871, 17958365, 18308268, 18521691, 18594510, 18774543 -18878420, 18986501, 19072655, 19211433, 19285025, 19327292, 19526548 -19614243, 19647894, 19649997, 19702201, 19721304, 20003668, 20087519 -20118035, 20120236, 20324049, 20436508, 20532077, 20549013, 20588486 -20591151, 20617383, 20620169, 20736227, 20756305, 20866970, 20917487 -20976443, 21070321, 21089435, 21095391, 21143725, 21147908, 21159907 -21178363, 21186167, 21197098, 21216226, 21320338, 21355390, 21433452 -21479706, 21517767, 21520266, 21547051, 21638600, 21744603, 21788462 -21837606, 21882528, 21935698, 21962287, 21981529, 21985256, 22007324 -22070226, 22070473, 22070853, 22072543, 22087683, 22104866, 22107360 -22174392, 22179537, 22282748, 22310426, 22347493, 22363790, 22364044 -22367053, 22379010, 22446455, 22454940, 22468255, 22495673, 22503283 -22503297, 22504793, 22522515, 22530986, 22564336, 22568728, 22581771 -22594071, 22599050, 22628825, 22645009, 22645496, 22654475, 22700845 -22726044, 22729345, 22820798, 22826067, 22843979, 22845846, 22864303 -22898198, 22921674, 22939829, 22950945, 22970869, 22981722, 23018676 -23019710, 23026585, 23035249, 23055900, 23056058, 23061453, 23065002 -23066146, 23080557, 23104033, 23105538, 23109325, 23110523, 23125560 -23126545, 23127945, 23143074, 23151677, 23168363, 23169712, 23177923 -23179662, 23184263, 23197730, 23234232, 23237091, 23249829, 23271203 -23278750, 23281269, 23282973, 23300142, 23306590, 23308065, 23310101 -23312077, 23328639, 23333567, 23336559, 23342170, 23481673, 23491861 -23499004, 23499160, 23521523, 23527363, 23533647, 23548817, 23567857 -23572982, 23581777, 23588722, 23599216, 23600861, 23602213, 23614158 -23627427, 23645516, 23665623, 23709062, 23715460, 23715518, 23730961 -23733981, 23735292, 23738304, 23741944, 23743596, 23746128, 23749454 -23761724, 23763462, 24006569, 24010030, 24289874, 24289895, 24294174 -24303148, 24307571, 24308349, 24318855, 24326444, 24326846, 24328857 -24330708, 24332831, 24334708, 24336249, 24337882, 24341675, 24343905 -24345420, 24346821, 24348685, 24350620, 24352981, 24355111, 24357348 -24368004, 24371491, 24373528, 24373756, 24374976, 24376875, 24376878 -24383086, 24385983, 24401351, 24403922, 24409977, 24415926, 24416451 -24421668, 24423416, 24425056, 24425998, 24432875, 24435982, 24437162 -24440612, 24440648, 24443539, 24445571, 24457597, 24460392, 24461826 -24467122, 24468470, 24470606, 24471079, 24471473, 24473736, 24480567 -24484749, 24485034, 24485161, 24485174, 24485619, 24486059, 24486237 -24509056, 24516314, 24530364, 24534401, 24554533, 24555417, 24556862 -24556967, 24560906, 24563422, 24570214, 24570598, 24573817, 24578718 -24578797, 24588377, 24589081, 24589590, 24591506, 24593740, 24595699 -24596874, 24600330, 24609592, 24609996, 24611527, 24616637, 24617969 -24623975, 24624166, 24642495, 24654629, 24655717, 24664211, 24668398 -24669189, 24669730, 24674197, 24674955, 24676172, 24677696, 24680959 -24687075, 24689376, 24692973, 24693010, 24693290, 24697323, 24699619 -24701840, 24710696, 24713381, 24714096, 24717183, 24717859, 24718260 -24719799, 24735430, 24737064, 24737403, 24737581, 24737954, 24739791 -24744383, 24744686, 24752618, 24757934, 24759556, 24760407, 24763196 -24764085, 24766309, 24784414, 24786669, 24791883, 24792678, 24793511 -24796092, 24797119, 24798481, 24800423, 24801152, 24802934, 24808504 -24811725, 24812047, 24817447, 24818566, 24827228, 24827654, 24831514 -24835919, 24841671, 24843188, 24844549, 24844841, 24845157, 24848746 -24848923, 24850622, 24907917, 24908063, 24908321, 24911709, 24912588 -24920582, 24921478, 24922704, 24923080, 24923215, 24923338, 24923790 -24924667, 24926999, 24929210, 24938784, 24940060, 24942749, 24953434 -24957555, 24960044, 24960809, 24965426, 24966594, 24966788, 24967993 -24968162, 24976007, 24978100, 25022574, 25027852, 25028996, 25029022 -25029423, 25031502, 25032818, 25034396, 25036006, 25036474, 25042823 -25044977, 25045228, 25050160, 25051465, 25051628, 25054064, 25057811 -25058080, 25060506, 25062592, 25063971, 25065563, 25072986, 25077278 -25078611, 25086233, 25087436, 25091141, 25092777, 25093872, 25095982 -25098160, 25099339, 25099497, 25099758, 25100063, 25100579, 25103996 -25107662, 25110233, 25114561, 25115178, 25120284, 25120668, 25120742 -25121089, 25123585, 25124363, 25129925, 25130312, 25140197, 25145163 -25145215, 25150925, 25159176, 25162645, 25164293, 25166187, 25171041 -25171084, 25173124, 25175723, 25176408, 25178032, 25178101, 25178179 -25179774, 25182817, 25184453, 25184555, 25186079, 25189723, 25191872 -25192044, 25192528, 25192729, 25195901, 25199585, 25200101, 25201454 -25202355, 25203656, 25205368, 25205954, 25206864, 25207410, 25209912 -25210268, 25210499, 25210690, 25211628, 25219450, 25223839, 25224242 -25225795, 25226665, 25227381, 25230870, 25230945, 25237577, 25240188 -25240590, 25241448, 25241625, 25244807, 25248384, 25250109, 25251648 -25257085, 25259611, 25262869, 25263960, 25265499, 25269133, 25283790 -25287072, 25288078, 25293659, 25296876, 25299227, 25299807, 25300427 -25303284, 25303756, 25305405, 25307368, 25309116, 25313154, 25313411 -25316758, 25317989, 25320555, 25323525, 25328093, 25328518, 25329664 -25335249, 25335360, 25335790, 25337332, 25337640, 25348567, 25348956 -25353983, 25356118, 25357142, 25360661, 25362958, 25367588, 25367721 -25382812, 25383204, 25384462, 25386748, 25388573, 25388896, 25392535 -25393714, 25395696, 25397936, 25398306, 25404117, 25404202, 25405100 -25405687, 25405813, 25410017, 25410180, 25410802, 25410877, 25411036 -25415713, 25416731, 25417050, 25417056, 25417958, 25425005, 25425451 -25425760, 25427662, 25429959, 25430120, 25433696, 25435038, 25437699 -25440818, 25442559, 25444961, 25445168, 25451531, 25452452, 25455795 -25457409, 25459958, 25462714, 25463844, 25472112, 25472885, 25476125 -25476149, 25477657, 25478885, 25479164, 25481087, 25482971, 25486384 -25489342, 25489367, 25489607, 25492379, 25498930, 25498994, 25516250 -25524955, 25528838, 25530080, 25530814, 25535668, 25536819, 25537470 -25539063, 25540738, 25546580, 25546608, 25547901, 25551676, 25553616 -25554787, 25555252, 25557886, 25558986, 25560487, 25560538, 25561296 -25569149, 25569504, 25570929, 25573623, 25575348, 25575369, 25575628 -25576115, 25579458, 25579761, 25591394, 25594901, 25597525, 25598473 -25599425, 25600342, 25600421, 25601999, 25602488, 25603923, 25606091 -25607726, 25612095, 25614866, 25616268, 25616359, 25616417, 25616645 -25631933, 25633101, 25634317, 25634348, 25635149, 25638456, 25639019 -25643818, 25643889, 25643931, 25646373, 25647325, 25648731, 25653109 -25654459, 25654936, 25655390, 25655966, 25659655, 25660847, 25661819 -25662088, 25662101, 25662524, 25663488, 25667973, 25669791, 25670786 -25671354, 25672640, 25674386, 25680221, 25685152, 25686739, 25687460 -25691904, 25694206, 25695903, 25696520, 25699321, 25700654, 25709368 -25710420, 25715167, 25717371, 25722055, 25722608, 25722720, 25723097 -25723158, 25728085, 25729507, 25730014, 25734963, 25736747, 25739065 -25740844, 25741955, 25743479, 25747569, 25749273, 25752755, 25754606 -25756945, 25757697, 25757748, 25760195, 25762221, 25764020, 25766822 -25768681, 25772669, 25774077, 25775213, 25775444, 25780343, 25783447 -25784002, 25785331, 25785441, 25788879, 25789041, 25789277, 25789579 -25790353, 25792911, 25795865, 25797092, 25797124, 25797305, 25800464 -25802510, 25803364, 25803545, 25807997, 25809524, 25810263, 25810704 -25811105, 25811650, 25812390, 25813931, 25818707, 25822410, 25823532 -25823754, 25824372, 25825910, 25826740, 25830492, 25832935, 25834581 -25835365, 25838361, 25838755, 25852885, 25856821, 25858672, 25861398 -25865785, 25866948, 25870579, 25871177, 25871639, 25871753, 25872127 -25872389, 25873336, 25874050, 25874678, 25881255, 25882264, 25883438 -25885148, 25888073, 25888984, 25890002, 25890046, 25890056, 25890673 -25890782, 25894239, 25895224, 25897615, 25898228, 25904273, 25904490 -25905130, 25906117, 25906886, 25908728, 25911724, 25914276, 25919622 -25932524, 25932728, 25933494, 25941836, 25942868, 25943271, 25945130 -25947799, 25951571, 25953857, 25954022, 25954054, 25957038, 25963024 -25964954, 25967544, 25967985, 25970731, 25971286, 25972417, 25973152 -25975723, 25977302, 25980605, 25980770, 25981498, 25982666, 25986062 -25990907, 25995938, 25997810, 26006257, 26007010, 26019148, 26023042 -26024732, 26024784, 26025681, 26029075, 26029777, 26029780, 26032573 -26034119, 26036748, 26037215, 26038086, 26039623, 26040483, 26045732 -26051656, 26078437, 26078493, 26080410, 26083298, 26087754, 26088426 -26088836, 26089669, 26090767, 26090893, 26091640, 26091786, 26095327 -26095405, 26096382, 26108080, 26108337, 26110259, 26110632, 26111842 -26112621, 26115103, 26121990, 26123175, 26124078, 26130486, 26137367 -26137416, 26138085, 26145560, 26149904, 26153372, 26153977, 26168933 -26169341, 26169345, 26170659, 26170715, 26176002, 26187943, 26189861 -26198757, 26198926, 26201113, 26203182, 26223039, 26237338, 26237431 -26237773, 26238195, 26242031, 26242677, 26243698, 26244115, 26245237 -26248143, 26249718, 26256131, 26257953, 26259265, 26261327, 26263328 -26263721, 26268756, 26269790, 26271001, 26274660, 26275023, 26275415 -26277439, 26281476, 26285062, 26285933, 26301540, 26308650, 26309047 -26317991, 26318200, 26318627, 26323308, 26324206, 26324769, 26325856 -26327418, 26327624, 26327775, 26330994, 26331743, 26333141, 26334602 -26336977, 26338953, 26351334, 26351996, 26352615, 26353617, 26354844 -26356098, 26358670, 26359091, 26362155, 26362821, 26366517, 26367012 -26367460, 26371725, 26373967, 26374791, 26375052, 26375250, 26375330 -26380097, 26385189, 26386858, 26388538, 26396790, 26398675, 26399626 -26399691, 26399839, 26405036, 26406387, 26407408, 26410240, 26412540 -26418088, 26420561, 26421667, 26422277, 26423085, 26426526, 26426967 -26430323, 26430737, 26434436, 26434999, 26435073, 26436168, 26438612 -26439748, 26440142, 26440169, 26440749, 26441345, 26442308, 26444601 -26444887, 26446098, 26451793, 26452606, 26474662, 26474703, 26475419 -26476090, 26476244, 26478970, 26479173, 26482376, 26486365, 26492666 -26492866, 26493289, 26498354, 26513067, 26513709, 26521043, 26522439 -26523432, 26526726, 26526799, 26536320, 26537307, 26542135, 26542236 -26542835, 26544823, 26545688, 26546070, 26546664, 26546754, 26548363 -26556014, 26558437, 26569225, 26570134, 26575788, 26580633, 26582460 -26584641, 26588069, 26597140, 26599395, 26608137, 26608238, 26609942 -26615291, 26615690, 26617804, 26623652, 26626879, 26629381, 26633355 -26633558, 26635897, 26637273, 26637824, 26639167, 26641610, 26641852 -26650226, 26650540, 26654363, 26658759, 26659182, 26669550, 26680105 -26712331, 26714486, 26714910, 26716835, 26717528, 26724511, 26725687 -26727397, 26729494, 26729611, 26740700, 26743240, 26744595, 26745002 -26751106, 26751171, 26755171, 26758193, 26764561, 26765212, 26768025 -26775602, 26784509, 26790923, 26794786, 26797591, 26798411, 26798514 -26798516, 26802503, 26816582, 26820076, 26822314, 26822620, 26824833 -26828994, 26829845, 26830694, 26832296, 26833932, 26837569, 26837702 -26840654, 26844406, 26844870, 26849779, 26855406, 26855855, 26871815 -26875822, 26883456, 26895149, 26896659, 26898563, 26907236, 26907327 -26908788, 26909100, 26909504, 26910716, 26911000, 26923777, 26939314 -26943004, 26944190, 26947373, 26958896, 26963310, 26966616, 26966916 -26967713, 26968670, 26969321, 26970175, 26970717, 26981902, 26983259 -26985002, 26986173, 26992964, 26999139, 27000158, 27000702, 27006120 -27006664, 27009164, 27013146, 27015449, 27028251, 27032785, 27033520 -27033652, 27034890, 27036163, 27037839, 27038986, 27039712, 27044169 -27044297, 27045634, 27052607, 27056711, 27058530, 27060167, 27060859 -27061736, 27072923, 27073314, 27079140, 27079651, 27084613, 27087426 -27090765, 27092508, 27093423, 27097854, 27100800, 27101105, 27105900 -27106179, 27110878, 27115422, 27117822, 27119621, 27119861, 27122162 -27124624, 27125872, 27133662, 27134734, 27135647, 27135993, 27138325 -27142120, 27142373, 27142529, 27144928, 27151826, 27153641, 27160922 -27161071, 27162390, 27162405, 27163928, 27165231, 27169796, 27170305 -27181537, 27181897, 27185188, 27195935, 27199245, 27200959, 27202015 -27203055, 27207110, 27207634, 27208795, 27213224, 27216046, 27217412 -27223075, 27229389, 27231051, 27234962, 27236722, 27242226, 27244337 -27244999, 27248917, 27249531, 27250547, 27251690, 27254335, 27255377 -27256000, 27258578, 27259307, 27262945, 27264464, 27266245, 27274456 -27274536, 27275533, 27276231, 27283960, 27284499, 27285244, 27288638 -27292213, 27293599, 27302711, 27302730, 27303287, 27303938, 27304410 -27304906, 27305039, 27308088, 27314206, 27314390, 27314697, 27320576 -27321179, 27329612, 27333106, 27334316, 27338912, 27338946, 27339115 -27345231, 27346709, 27348081, 27349393, 27350267, 27351628, 27359178 -27364854, 27365014, 27367194, 27369515, 27370965, 27375542, 27381498 -27383281, 27386467, 27392968, 27393570, 27394703, 27395416, 27396624 -27396672, 27396813, 27397048, 27400416, 27400598, 27404573, 27404668 -27405645, 27416997, 27423251, 27424405, 27426363, 27432062, 27432826 -27433385, 27433870, 27434193, 27439835, 27441326, 27442041, 27443406 -27445727, 27452046, 27457891, 27459593, 27459948, 27461740, 27466597 -27468303, 27486805, 27487919, 27489107, 27493674, 27494663, 27501373 -27501413, 27502420, 27504770, 27505229, 27508985, 27510959, 27525909 -27529661, 27533780, 27533819, 27534509, 27539876, 27540613, 27544973 -27548131, 27554074, 27555481, 27558861, 27560602, 27562488, 27565906 -27567477, 27576342, 27576354, 27587905, 27588271, 27589260, 27593501 -27595973, 27601118, 27601441, 27607563, 27611612, 27613080, 27613530 -27613554, 27615649, 27617978, 27620808, 27623159, 27629756, 27629928 -27632114, 27634676, 27634991, 27642235, 27645231, 27657712, 27658186 -27666312, 27671633, 27680669, 27686599, 27687880, 27688036, 27688099 -27688692, 27691920, 27691939, 27693416, 27693713, 27695063, 27698953 -27700466, 27704237, 27709046, 27710072, 27717210, 27719000, 27726780 -27729678, 27739006, 27740424, 27745728, 27748954, 27751755, 27757567 -27757888, 27758544, 27758653, 27758972, 27759077, 27769361, 27779886 -27793533, 27799032, 27801337, 27818389, 27819881, 27824540, 27824543 -27825241, 27828794, 27828892, 27829295, 27833672, 27834551, 27834569 -27835925, 27837219, 27839353, 27839616, 27846298, 27846499, 27847259 -27850112, 27855490, 27861226, 27873412, 27882176, 27886087, 27897759 -27898015, 27902561, 27908396, 27909478, 27927431, 27929287, 27929509 -27931299, 27935493, 27940876, 27945870, 27951817, 27952586, 27959048 -27959594, 27964513, 27966472, 27967484, 27983174, 27986817, 27994325 -27995215, 27995248, 27997875, 27998003, 27999073, 27999638, 28000269 -28007516, 28019592, 28022101, 28023081, 28023399, 28023482, 28024793 -28025414, 28026866, 28033429, 28040776, 28043157, 28045903, 28066655 -28067846, 28071549, 28072383, 28072567, 28073470, 28074713, 28079127 -28090453, 28092783, 28098040, 28098160, 28099662, 28104176, 28108003 -28111583, 28120036, 28120951, 28124631, 28125601, 28125947, 28129791 -28140658, 28157786, 28164480, 28165439, 28171079, 28174827, 28180464 -28181021, 28184554, 28188330, 28190796, 28194173, 28199085, 28201419 -28204262, 28209985, 28215510, 28218832, 28220398, 28223871, 28226179 -28229360, 28236305, 28238264, 28242712, 28250929, 28256164, 28271119 -28276054, 28279837, 28281094, 28282606, 28287484, 28290434, 28294563 -28302049, 28305001, 28305362, 28305607, 28309406, 28319114, 28320399 -28330714, 28330971, 28350595, 28354603, 28357401, 28361221, 28365111 -28369092, 28371123, 28373960, 28375383, 28378446, 28384353, 28386259 -28388910, 28389153, 28390273, 28391210, 28394726, 28396445, 28397317 -28401116, 28402823, 28420042, 28420457, 28423598, 28432129, 28434028 -28435902, 28437315, 28439086, 28454215, 28454242, 28468312, 28468493 -28481149, 28483184, 28489150, 28501075, 28502098, 28502343, 28503038 -28507324, 28508053, 28508557, 28512336, 28521330, 28522441, 28528349 -28530171, 28535127, 28535272, 28537715, 28538439, 28542455, 28545134 -28546290, 28547068, 28547478, 28564479, 28566241, 28571483, 28572407 -28572834, 28578164, 28578945, 28585411, 28587723, 28589509, 28600233 -28602253, 28606598, 28608211, 28612674, 28614372, 28617631, 28617959 -28621470, 28622202, 28627255, 28636676, 28639299, 28642899, 28644756 -28661362, 28678804, 28690694, 28691965, 28692103, 28692275, 28697526 -28697806, 28703812, 28708023, 28709063, 28710469, 28710734, 28714988 -28715655, 28728272, 28730044, 28730253, 28734355, 28740708, 28742555 -28749289, 28749724, 28758090, 28758722, 28774416, 28776431, 28777174 -28791725, 28797711, 28803345, 28808314, 28817449, 28819640, 28820669 -28821847, 28827682, 28830691, 28831971, 28835937, 28836716, 28838066 -28844866, 28847136, 28849751, 28852325, 28852691, 28855922, 28856060 -28856172, 28863263, 28863487, 28867992, 28887305, 28889730, 28891984 -28905390, 28910498, 28915870, 28927452, 28945922, 28948554, 28949888 -28951026, 28951382, 28956908, 28959493, 28960211, 28965095, 28965787 -28986231, 28986257, 28987439, 28991884, 28993295, 28993590, 29002488 -29006527, 29007321, 29007353, 29009513, 29013832, 29024054, 29026309 -29026582, 29027694, 29032276, 29039510, 29040739, 29044086, 29044954 -29048498, 29048728, 29050886, 29060216, 29061016, 29115857, 29125374 -29154725, 29158680, 29163567, 29170232, 29173817, 29179097, 29182517 -29182901, 29189889, 29198092, 29200700, 29203604, 29213320, 29213351 -29213893, 29224605, 29224710, 29237575, 29247712, 29249289, 29250230 -29250317, 29254623, 29260956, 29278684, 29296257, 29301463, 29307638 -29312889, 29337294, 29338348, 29339155, 29342099, 29343086, 29343156 -29343861, 29347943, 29353821, 29372069, 29372460, 29375355, 29375984 -29376346, 29378913, 29379978, 29383695, 29388020, 29398488, 29399336 -29405462, 29409149, 29409455, 29415774, 29418165, 29420254, 29426241 -29434301, 29436454, 29437712, 29450812, 29452251, 29454978, 29463047 -29464779, 29472618, 29477015, 29483626, 29483672, 29483723, 29483771 -29500257, 29500963, 29501218, 29504682, 29511611, 29524985, 29530515 -29536342, 29538631, 29542449, 29542580, 29548592, 29549071, 29559395 -29564592, 29580394, 29591343, 29608023, 29614575, 29614987, 29621961 -29625065, 29626154, 29629430, 29633753, 29637526, 29637560, 29645349 -29651520, 29656843, 29667994, 29676089, 29678163, 29685137, 29687220 -29688867, 29689697, 29690625, 29703195, 29705793, 29707896, 29717901 -29719146, 29724063, 29726695, 29741319, 29766435, 29767177, 29769901 -29774362, 29782211, 29791152, 29794174, 29794462, 29796916, 29807964 -29813494, 29815341, 29817278, 29822714, 29825525, 29836659, 29841687 -29844131, 29846645, 29853485, 29865188, 29869404, 29869906, 29875459 -29876358, 29881050, 29881575, 29884958, 29893132, 29902299, 29902311 -29914449, 29930457, 29933718, 29941062, 29942554, 29944035, 29944159 -29944660, 29951620, 29951759, 29961353, 29962927, 29962939, 29965888 -29991257, 29997937, 29997959, 30008125, 30018017, 30018903, 30031027 -30039959, 30064268, 30068871, 30076253, 30078934, 30086166, 30088912 -30092280, 30098251, 30099302, 30114477, 30116203, 30117469, 30120608 -30125995, 30128047, 30131286, 30139392, 30147928, 30150731, 30160625 -30163243, 30164714, 30173113, 30177597, 30179644, 30186706, 30189023 -30193736, 30196358, 30200680, 30200758, 30215130, 30218044, 30218317 -30223712, 30225443, 30239480, 30241567, 30244787, 30246179, 30247305 -30252098, 30252156, 30253255, 30265523, 30265615, 30272329, 30281591 -30282501, 30283932, 30293345, 30305880, 30312094, 30312568, 30316897 -30320029, 30325407, 30331356, 30342878, 30345926, 30352623, 30355490 -30357897, 30364613, 30365745, 30368482, 30368668, 30372081, 30374739 -30377692, 30381207, 30384121, 30384152, 30387666, 30391272, 30397100 -30402386, 30403763, 30408515, 30413137, 30416034, 30421204, 30431274 -30441687, 30443393, 30453442, 30458593, 30460922, 30464250, 30464655 -30473634, 30474774, 30475041, 30475115, 30476768, 30485255, 30489582 -30496957, 30497057, 30498824, 30501574, 30503943, 30509277, 30510527 -30517516, 30522998, 30528547, 30528704, 30532811, 30533198, 30534662 -30578221, 30581448, 30582500, 30606345, 30613937, 30623138, 30624864 -30635302, 30652853, 30654409, 30662736, 30668407, 30671813, 30679595 -30679771, 30681462, 30698289, 30741263, 30749644, 30755348, 30758943 -30783551, 30803210, 30809087, 30814266, 30814285, 30815852, 30816938 -30822919, 30826474, 30855101, 30856358, 30866988, 30887501, 30891760 -30904672, 30905638, 30914674, 30919804, 30922870, 30937340, 30964194 -30968208, 30980615, 30985027, 30987088, 30994996, 30998759, 31001455 -31004719, 31013127, 31022858, 31028986, 31061482, 31100172, 31104809 -31106577, 31109506, 31115502, 31156383, 31172207, 31182793, 31192039 -31194264, 31200845, 31201001, 31215438, 31228670, 31233170, 31254535 -31257826, 31258101, 31302499, 31306248, 31306261, 31309867, 31315876 -31326608, 31331354, 31335037, 31335142, 31341859, 31343752, 31347532 -31377487, 31393600, 31408636, 31430722, 31501139, 31508450, 31525783 -31527103, 31544097, 31570161, 31600023, 31628311, 31637680, 31647304 -31658464, 31658943, 31668061, 31668872, 31696577, 31711889, 31718134 -31726483, 31748000, 31749740, 31771858, 31786838, 31816631, 31836113 -31862611, 31867037, 31886745, 31897786, 31905033, 31909295, 31945038 -31986836, 31997805, 32028155, 32081381, 32089820, 32095380, 32105135 -32119339, 32153619, 32162748, 32165759, 32186646, 32190132, 32190190 -32190284, 32191451, 32222473, 32234161, 32245850, 32246090, 32296941 -32312131, 32327201, 32327208, 32335769, 32359044, 32368789, 32368792 -32404638, 32425124, 32426251, 32436757, 32442404, 32478429, 32494298 -32505009, 32509606, 32523206, 32530202, 32583355, 32626756, 32676350 -32704765, 32720458, 32725484, 32755493, 32775512, 32776891, 32786309 -32834168, 32846272, 32851841, 32858446, 32878039, 32889434, 32892883 -32918266, 32939376, 33003817, 33034103, 33131742, 33223248, 33289442 -``` - -## Version 12\.2\.0\.1\.ru\-2021\-07\.rur\-2021\-07\.r1 - -Version 12\.2\.0\.1\.ru\-2021\-07\.rur\-2021\-07\.r1 includes the following: -+ Patch 32916808: DATABASE JUL 2021 RELEASE UPDATE 12\.2\.0\.1\.210720 -+ Patch 32876409: OJVM RELEASE UPDATE 12\.2\.0\.1\.210720 -+ Patch 32327201: RDBMS \- DSTV36 UPDATE \- TZDATA2020E -+ Patch 29213893: DBMS\_STATS FAILING WITH ERROR ORA\-01422 WHEN GATHERING STATS FOR USER$ TABLE -+ Patch 28730253: SUPPORT NEW ERA REIWA FOR JAPANESE IMPERIAL CALENDAR -+ Patch 26352615: SPILLOVER AUDIT FILES CANNOT BE FOUND ORA\-46372 -+ PreUpgrade Jar: preupgrade\_12201\_cbuild\_24\_lf\.zip - -### Combined Patches for Version 12\.2\.0\.1\.ru\-2021\-07\.rur\-2021\-07\.r1, Released July 2021 - -Bugs fixed: - -``` -7391838, 8480838, 8932139, 8975044, 12763598, 13554903, 14221306 -14690846, 15931756, 16002385, 16438495, 16727454, 16942578, 17027695 -17533661, 17947871, 17958365, 18308268, 18521691, 18594510, 18774543 -18878420, 18986501, 19072655, 19211433, 19285025, 19327292, 19526548 -19614243, 19647894, 19649997, 19702201, 19721304, 20003668, 20087519 -20118035, 20120236, 20324049, 20436508, 20532077, 20549013, 20588486 -20591151, 20617383, 20620169, 20736227, 20756305, 20866970, 20917487 -20976443, 21070321, 21089435, 21095391, 21143725, 21147908, 21159907 -21178363, 21186167, 21197098, 21216226, 21320338, 21355390, 21433452 -21479706, 21517767, 21520266, 21547051, 21638600, 21744603, 21788462 -21837606, 21882528, 21935698, 21962287, 21981529, 21985256, 22007324 -22070226, 22070473, 22070853, 22072543, 22087683, 22104866, 22107360 -22174392, 22179537, 22282748, 22310426, 22347493, 22363790, 22364044 -22367053, 22379010, 22446455, 22454940, 22468255, 22495673, 22503283 -22503297, 22504793, 22522515, 22530986, 22564336, 22568728, 22581771 -22594071, 22599050, 22628825, 22645009, 22645496, 22654475, 22700845 -22726044, 22729345, 22820798, 22826067, 22843979, 22845846, 22864303 -22898198, 22921674, 22939829, 22950945, 22970869, 22981722, 23018676 -23019710, 23026585, 23035249, 23055900, 23056058, 23061453, 23065002 -23066146, 23080557, 23104033, 23105538, 23109325, 23110523, 23125560 -23126545, 23127945, 23143074, 23151677, 23168363, 23169712, 23177923 -23179662, 23184263, 23197730, 23234232, 23237091, 23249829, 23271203 -23278750, 23281269, 23282973, 23300142, 23306590, 23308065, 23310101 -23312077, 23328639, 23333567, 23336559, 23342170, 23481673, 23491861 -23499004, 23499160, 23521523, 23527363, 23533647, 23548817, 23567857 -23572982, 23581777, 23588722, 23599216, 23600861, 23602213, 23614158 -23627427, 23645516, 23665623, 23709062, 23715460, 23715518, 23730961 -23733981, 23735292, 23738304, 23741944, 23743596, 23746128, 23749454 -23761724, 23763462, 24006569, 24010030, 24289874, 24289895, 24294174 -24303148, 24307571, 24308349, 24326444, 24326846, 24328857, 24330708 -24332831, 24334708, 24336249, 24337882, 24341675, 24343905, 24345420 -24346821, 24348685, 24350620, 24352981, 24355111, 24357348, 24368004 -24371491, 24373528, 24373756, 24374976, 24376875, 24376878, 24383086 -24385983, 24401351, 24403922, 24409977, 24415926, 24416451, 24421668 -24423416, 24425056, 24425998, 24432875, 24435982, 24437162, 24440612 -24440648, 24443539, 24445571, 24457597, 24460392, 24461826, 24467122 -24468470, 24470606, 24471079, 24471473, 24473736, 24480567, 24484749 -24485034, 24485161, 24485174, 24485619, 24486059, 24486237, 24509056 -24516314, 24530364, 24534401, 24554533, 24555417, 24556862, 24556967 -24560906, 24563422, 24570214, 24570598, 24573817, 24578718, 24578797 -24588377, 24589081, 24589590, 24591506, 24593740, 24595699, 24596874 -24600330, 24609592, 24609996, 24611527, 24616637, 24617969, 24623975 -24624166, 24642495, 24654629, 24655717, 24664211, 24668398, 24669189 -24669730, 24674197, 24674955, 24676172, 24677696, 24680959, 24687075 -24689376, 24692973, 24693010, 24693290, 24697323, 24699619, 24701840 -24710696, 24713381, 24714096, 24717183, 24717859, 24718260, 24719799 -24735430, 24737064, 24737403, 24737581, 24737954, 24739791, 24744383 -24744686, 24752618, 24757934, 24759556, 24760407, 24763196, 24764085 -24766309, 24784414, 24786669, 24791883, 24792678, 24793511, 24796092 -24797119, 24798481, 24800423, 24801152, 24802934, 24808504, 24811725 -24812047, 24817447, 24818566, 24827228, 24827654, 24831514, 24835919 -24841671, 24843188, 24844549, 24844841, 24845157, 24848746, 24848923 -24850622, 24907917, 24908063, 24908321, 24911709, 24912588, 24920582 -24921478, 24922704, 24923080, 24923215, 24923338, 24923790, 24924667 -24926999, 24929210, 24938784, 24940060, 24942749, 24953434, 24957555 -24960044, 24960809, 24965426, 24966594, 24966788, 24967993, 24968162 -24976007, 24978100, 25022574, 25027852, 25028996, 25029022, 25029423 -25031502, 25032818, 25034396, 25036006, 25036474, 25042823, 25044977 -25045228, 25050160, 25051465, 25051628, 25054064, 25057811, 25058080 -25060506, 25062592, 25063971, 25065563, 25072986, 25077278, 25078611 -25086233, 25087436, 25091141, 25092777, 25093872, 25095982, 25098160 -25099339, 25099497, 25099758, 25100063, 25100579, 25103996, 25107662 -25110233, 25114561, 25115178, 25120284, 25120668, 25120742, 25121089 -25123585, 25124363, 25129925, 25130312, 25140197, 25145163, 25145215 -25150925, 25159176, 25162645, 25164293, 25166187, 25171041, 25171084 -25173124, 25175723, 25176408, 25178032, 25178101, 25178179, 25179774 -25182817, 25184453, 25184555, 25186079, 25189723, 25191872, 25192044 -25192528, 25192729, 25195901, 25199585, 25200101, 25201454, 25202355 -25203656, 25205368, 25205954, 25206864, 25207410, 25209912, 25210268 -25210499, 25210690, 25211628, 25219450, 25223839, 25224242, 25225795 -25226665, 25227381, 25230870, 25230945, 25237577, 25240188, 25240590 -25241448, 25241625, 25244807, 25248384, 25250109, 25251648, 25257085 -25259611, 25262869, 25263960, 25265499, 25269133, 25283790, 25287072 -25288078, 25293659, 25296876, 25299227, 25299807, 25300427, 25303284 -25303756, 25305405, 25307368, 25309116, 25313154, 25313411, 25316758 -25317989, 25320555, 25323525, 25328093, 25328518, 25329664, 25335249 -25335360, 25335790, 25337332, 25337640, 25348567, 25348956, 25353983 -25356118, 25357142, 25360661, 25362958, 25367588, 25367721, 25382812 -25383204, 25384462, 25386748, 25388573, 25388896, 25392535, 25393714 -25395696, 25397936, 25398306, 25404117, 25404202, 25405100, 25405687 -25405813, 25410017, 25410180, 25410802, 25410877, 25411036, 25415713 -25416731, 25417050, 25417056, 25417958, 25425005, 25425451, 25425760 -25427662, 25429959, 25430120, 25433696, 25435038, 25437699, 25440818 -25442559, 25444961, 25445168, 25451531, 25452452, 25455795, 25457409 -25459958, 25462714, 25463844, 25472112, 25472885, 25476125, 25476149 -25477657, 25478885, 25479164, 25481087, 25482971, 25486384, 25489342 -25489367, 25489607, 25492379, 25498930, 25498994, 25516250, 25524955 -25528838, 25530080, 25530814, 25535668, 25536819, 25537470, 25539063 -25540738, 25546580, 25546608, 25547901, 25551676, 25553616, 25554787 -25555252, 25557886, 25558986, 25560487, 25560538, 25561296, 25569149 -25569504, 25570929, 25573623, 25575348, 25575369, 25575628, 25576115 -25579458, 25579761, 25591394, 25594901, 25597525, 25598473, 25599425 -25600342, 25600421, 25601999, 25602488, 25603923, 25606091, 25607726 -25612095, 25614866, 25616268, 25616359, 25616417, 25616645, 25631933 -25633101, 25634317, 25634348, 25635149, 25638456, 25639019, 25643818 -25643889, 25643931, 25646373, 25647325, 25648731, 25653109, 25654459 -25654936, 25655390, 25655966, 25659655, 25660847, 25661819, 25662088 -25662101, 25662524, 25663488, 25667973, 25669791, 25670786, 25671354 -25672640, 25674386, 25680221, 25685152, 25686739, 25687460, 25691904 -25694206, 25695903, 25696520, 25699321, 25700654, 25709368, 25710420 -25715167, 25717371, 25722055, 25722608, 25722720, 25723097, 25723158 -25728085, 25729507, 25730014, 25734963, 25736747, 25739065, 25740844 -25741955, 25743479, 25747569, 25749273, 25752755, 25754606, 25756945 -25757697, 25757748, 25760195, 25762221, 25764020, 25766822, 25768681 -25772669, 25774077, 25775213, 25775444, 25780343, 25783447, 25784002 -25785331, 25785441, 25788879, 25789041, 25789277, 25789579, 25790353 -25792911, 25795865, 25797092, 25797124, 25797305, 25800464, 25802510 -25803364, 25803545, 25807997, 25809524, 25810263, 25810704, 25811105 -25811650, 25812390, 25813931, 25818707, 25822410, 25823532, 25823754 -25824372, 25825910, 25826740, 25830492, 25832935, 25834581, 25835365 -25838361, 25838755, 25852885, 25856821, 25858672, 25861398, 25865785 -25866948, 25870579, 25871177, 25871639, 25871753, 25872127, 25872389 -25873336, 25874050, 25874678, 25881255, 25882264, 25883438, 25885148 -25888073, 25888984, 25890002, 25890046, 25890056, 25890673, 25890782 -25894239, 25895224, 25897615, 25898228, 25904273, 25904490, 25905130 -25906117, 25906886, 25908728, 25911724, 25914276, 25919622, 25932524 -25932728, 25933494, 25941836, 25942868, 25943271, 25945130, 25947799 -25951571, 25953857, 25954022, 25954054, 25957038, 25963024, 25964954 -25967544, 25967985, 25970731, 25971286, 25972417, 25973152, 25975723 -25977302, 25980605, 25980770, 25981498, 25982666, 25986062, 25990907 -25995938, 25997810, 26006257, 26007010, 26019148, 26023042, 26024732 -26024784, 26025681, 26029075, 26029777, 26029780, 26032573, 26034119 -26036748, 26037215, 26038086, 26039623, 26040483, 26045732, 26051656 -26078437, 26078493, 26080410, 26083298, 26087754, 26088426, 26088836 -26089669, 26090767, 26090893, 26091640, 26091786, 26095327, 26095405 -26096382, 26108080, 26108337, 26110259, 26110632, 26111842, 26112621 -26115103, 26121990, 26123175, 26124078, 26130486, 26137367, 26137416 -26138085, 26145560, 26149904, 26153372, 26153977, 26168933, 26169341 -26169345, 26170659, 26170715, 26176002, 26187943, 26189861, 26198757 -26198926, 26201113, 26203182, 26223039, 26237338, 26237431, 26237773 -26238195, 26242031, 26242677, 26243698, 26244115, 26245237, 26248143 -26249718, 26256131, 26257953, 26259265, 26261327, 26263328, 26263721 -26268756, 26269790, 26271001, 26274660, 26275023, 26275415, 26277439 -26281476, 26285062, 26285933, 26301540, 26308650, 26309047, 26317991 -26318200, 26318627, 26323308, 26324206, 26324769, 26325856, 26327418 -26327624, 26327775, 26330994, 26331743, 26333141, 26334602, 26336977 -26338953, 26351334, 26351996, 26352615, 26353617, 26354844, 26356098 -26358670, 26359091, 26362155, 26362821, 26366517, 26367012, 26367460 -26371725, 26373967, 26374791, 26375052, 26375250, 26375330, 26380097 -26385189, 26386858, 26388538, 26396790, 26398675, 26399626, 26399691 -26399839, 26405036, 26406387, 26407408, 26410240, 26412540, 26418088 -26420561, 26421667, 26422277, 26423085, 26426526, 26426967, 26430323 -26430737, 26434436, 26434999, 26435073, 26436168, 26438612, 26439748 -26440142, 26440169, 26440749, 26441345, 26442308, 26444601, 26444887 -26446098, 26451793, 26452606, 26474662, 26474703, 26475419, 26476090 -26476244, 26478970, 26479173, 26482376, 26486365, 26492666, 26492866 -26493289, 26498354, 26513067, 26513709, 26521043, 26522439, 26523432 -26526726, 26526799, 26536320, 26537307, 26542135, 26542236, 26542835 -26544823, 26545688, 26546070, 26546664, 26546754, 26548363, 26556014 -26558437, 26569225, 26570134, 26575788, 26580633, 26582460, 26584641 -26588069, 26597140, 26599395, 26608137, 26608238, 26609942, 26615291 -26615690, 26617804, 26623652, 26626879, 26629381, 26633355, 26633558 -26635897, 26637273, 26637824, 26639167, 26641610, 26641852, 26650226 -26650540, 26654363, 26658759, 26659182, 26669550, 26680105, 26712331 -26714486, 26714910, 26716835, 26717528, 26724511, 26725687, 26727397 -26729494, 26729611, 26740700, 26743240, 26744595, 26745002, 26751106 -26751171, 26755171, 26758193, 26764561, 26765212, 26768025, 26775602 -26784509, 26790923, 26794786, 26797591, 26798411, 26798514, 26798516 -26802503, 26816582, 26820076, 26822314, 26822620, 26824833, 26828994 -26829845, 26830694, 26832296, 26833932, 26837569, 26837702, 26840654 -26844406, 26844870, 26849779, 26855406, 26855855, 26871815, 26875822 -26883456, 26895149, 26896659, 26898563, 26907236, 26907327, 26908788 -26909100, 26909504, 26910716, 26911000, 26923777, 26939314, 26943004 -26944190, 26947373, 26958896, 26963310, 26966616, 26966916, 26967713 -26968670, 26969321, 26970175, 26970717, 26981902, 26983259, 26985002 -26986173, 26992964, 26999139, 27000158, 27000702, 27006120, 27006664 -27009164, 27013146, 27015449, 27028251, 27032785, 27033520, 27033652 -27034890, 27036163, 27037839, 27038986, 27039712, 27044169, 27044297 -27045634, 27052607, 27056711, 27058530, 27060167, 27060859, 27061736 -27072923, 27073314, 27079140, 27079651, 27084613, 27087426, 27090765 -27092508, 27093423, 27097854, 27100800, 27101105, 27105900, 27106179 -27110878, 27115422, 27117822, 27119621, 27119861, 27122162, 27124624 -27125872, 27133662, 27134734, 27135647, 27135993, 27138325, 27142120 -27142373, 27142529, 27144928, 27151826, 27153641, 27160922, 27161071 -27162390, 27162405, 27163928, 27165231, 27169796, 27170305, 27181537 -27181897, 27185188, 27195935, 27199245, 27200959, 27202015, 27203055 -27207110, 27207634, 27208795, 27213224, 27216046, 27217412, 27223075 -27229389, 27231051, 27234962, 27236722, 27242226, 27244337, 27244999 -27248917, 27249531, 27250547, 27251690, 27254335, 27255377, 27256000 -27258578, 27259307, 27262945, 27264464, 27266245, 27274456, 27274536 -27275533, 27276231, 27283960, 27284499, 27285244, 27288638, 27292213 -27293599, 27302711, 27302730, 27303287, 27303938, 27304410, 27304906 -27305039, 27308088, 27314206, 27314390, 27314697, 27320576, 27321179 -27329612, 27333106, 27334316, 27338912, 27338946, 27339115, 27345231 -27346709, 27348081, 27349393, 27350267, 27351628, 27359178, 27364854 -27365014, 27367194, 27369515, 27370965, 27375542, 27381498, 27383281 -27386467, 27392968, 27393570, 27394703, 27395416, 27396624, 27396672 -27396813, 27397048, 27400416, 27400598, 27404573, 27404668, 27405645 -27416997, 27423251, 27424405, 27426363, 27432062, 27432826, 27433385 -27433870, 27434193, 27439835, 27441326, 27442041, 27443406, 27445727 -27452046, 27457891, 27459593, 27459948, 27461740, 27466597, 27468303 -27486805, 27487919, 27489107, 27493674, 27494663, 27501373, 27501413 -27502420, 27504770, 27505229, 27508985, 27510959, 27525909, 27529661 -27533780, 27533819, 27534509, 27539876, 27540613, 27544973, 27548131 -27554074, 27555481, 27558861, 27560602, 27562488, 27565906, 27567477 -27576342, 27576354, 27587905, 27588271, 27589260, 27593501, 27595973 -27601118, 27601441, 27607563, 27611612, 27613080, 27613530, 27613554 -27615649, 27617978, 27620808, 27623159, 27629756, 27629928, 27632114 -27634676, 27634991, 27642235, 27645231, 27657712, 27658186, 27666312 -27671633, 27680669, 27686599, 27687880, 27688036, 27688099, 27688692 -27691920, 27691939, 27693416, 27693713, 27695063, 27698953, 27700466 -27704237, 27709046, 27710072, 27717210, 27719000, 27726780, 27729678 -27739006, 27740424, 27745728, 27748954, 27751755, 27757567, 27757888 -27758544, 27758653, 27758972, 27759077, 27769361, 27779886, 27793533 -27799032, 27801337, 27818389, 27819881, 27824540, 27824543, 27825241 -27828794, 27828892, 27829295, 27833672, 27834551, 27834569, 27835925 -27837219, 27839353, 27839616, 27846298, 27846499, 27847259, 27850112 -27855490, 27861226, 27873412, 27882176, 27886087, 27897759, 27898015 -27902561, 27908396, 27909478, 27927431, 27929287, 27929509, 27931299 -27935493, 27940876, 27945870, 27951817, 27952586, 27959048, 27959594 -27964513, 27966472, 27967484, 27983174, 27986817, 27994325, 27995215 -27995248, 27997875, 27998003, 27999073, 27999638, 28000269, 28007516 -28019592, 28022101, 28023081, 28023399, 28023482, 28024793, 28025414 -28026866, 28033429, 28040776, 28043157, 28045903, 28066655, 28067846 -28071549, 28072383, 28072567, 28073470, 28074713, 28079127, 28090453 -28092783, 28098040, 28098160, 28099662, 28104176, 28108003, 28111583 -28120036, 28120951, 28124631, 28125601, 28125947, 28129791, 28140658 -28157786, 28164480, 28165439, 28171079, 28174827, 28180464, 28181021 -28184554, 28188330, 28190796, 28194173, 28199085, 28201419, 28204262 -28209985, 28215510, 28218832, 28220398, 28223871, 28226179, 28229360 -28236305, 28238264, 28242712, 28250929, 28256164, 28271119, 28276054 -28279837, 28281094, 28282606, 28287484, 28290434, 28294563, 28302049 -28305001, 28305362, 28305607, 28309406, 28319114, 28320399, 28330714 -28330971, 28350595, 28354603, 28357401, 28361221, 28365111, 28369092 -28371123, 28373960, 28375383, 28378446, 28384353, 28386259, 28388910 -28389153, 28390273, 28391210, 28394726, 28396445, 28397317, 28401116 -28402823, 28420042, 28420457, 28423598, 28432129, 28434028, 28435902 -28437315, 28439086, 28454215, 28454242, 28468312, 28468493, 28481149 -28483184, 28489150, 28501075, 28502098, 28502343, 28503038, 28507324 -28508053, 28508557, 28512336, 28521330, 28522441, 28528349, 28530171 -28535127, 28535272, 28537715, 28538439, 28542455, 28545134, 28546290 -28547068, 28547478, 28564479, 28566241, 28571483, 28572407, 28572834 -28578164, 28578945, 28585411, 28587723, 28589509, 28600233, 28602253 -28606598, 28608211, 28612674, 28614372, 28617631, 28617959, 28621470 -28622202, 28627255, 28636676, 28639299, 28642899, 28644756, 28678804 -28690694, 28691965, 28692103, 28692275, 28697526, 28697806, 28703812 -28708023, 28709063, 28710469, 28710734, 28714988, 28715655, 28728272 -28730044, 28730253, 28734355, 28740708, 28742555, 28749289, 28749724 -28758090, 28758722, 28774416, 28776431, 28777174, 28791725, 28797711 -28803345, 28808314, 28817449, 28819640, 28820669, 28821847, 28827682 -28830691, 28831971, 28835937, 28836716, 28838066, 28844866, 28847136 -28849751, 28852325, 28852691, 28855922, 28856060, 28856172, 28863263 -28863487, 28867992, 28887305, 28889730, 28891984, 28905390, 28910498 -28915870, 28927452, 28945922, 28948554, 28949888, 28951026, 28951382 -28956908, 28959493, 28960211, 28965095, 28965787, 28986231, 28986257 -28987439, 28991884, 28993295, 28993590, 29002488, 29006527, 29007321 -29007353, 29009513, 29013832, 29024054, 29026309, 29026582, 29027694 -29032276, 29039510, 29040739, 29044086, 29044954, 29048498, 29048728 -29050886, 29060216, 29061016, 29115857, 29125374, 29154725, 29158680 -29163567, 29170232, 29173817, 29179097, 29182517, 29182901, 29189889 -29198092, 29200700, 29203604, 29213320, 29213351, 29213893, 29224605 -29224710, 29237575, 29247712, 29249289, 29250230, 29250317, 29254623 -29260956, 29278684, 29296257, 29301463, 29307638, 29312889, 29337294 -29338348, 29339155, 29342099, 29343086, 29343156, 29343861, 29347943 -29353821, 29372069, 29372460, 29375355, 29375984, 29376346, 29378913 -29379978, 29383695, 29388020, 29398488, 29399336, 29405462, 29409149 -29409455, 29415774, 29418165, 29420254, 29426241, 29434301, 29436454 -29437712, 29450812, 29452251, 29454978, 29463047, 29464779, 29472618 -29477015, 29483626, 29483672, 29483723, 29483771, 29500257, 29500963 -29501218, 29504682, 29511611, 29524985, 29530515, 29536342, 29538631 -29542449, 29542580, 29548592, 29549071, 29559395, 29564592, 29580394 -29591343, 29608023, 29614575, 29614987, 29621961, 29625065, 29626154 -29629430, 29633753, 29637526, 29637560, 29645349, 29651520, 29656843 -29667994, 29676089, 29678163, 29685137, 29687220, 29688867, 29689697 -29690625, 29703195, 29705793, 29707896, 29717901, 29719146, 29724063 -29726695, 29741319, 29766435, 29767177, 29769901, 29774362, 29782211 -29791152, 29794174, 29794462, 29796916, 29807964, 29813494, 29815341 -29817278, 29822714, 29825525, 29836659, 29841687, 29844131, 29846645 -29853485, 29865188, 29869404, 29869906, 29875459, 29876358, 29881050 -29881575, 29884958, 29893132, 29902299, 29902311, 29914449, 29930457 -29933718, 29941062, 29942554, 29944035, 29944159, 29944660, 29951620 -29951759, 29961353, 29962927, 29962939, 29965888, 29991257, 29997937 -29997959, 30008125, 30018017, 30018903, 30031027, 30039959, 30064268 -30068871, 30076253, 30078934, 30086166, 30088912, 30092280, 30098251 -30099302, 30114477, 30116203, 30117469, 30120608, 30125995, 30128047 -30131286, 30139392, 30147928, 30150731, 30160625, 30163243, 30164714 -30173113, 30177597, 30179644, 30186706, 30189023, 30193736, 30196358 -30200680, 30200758, 30215130, 30218044, 30218317, 30223712, 30225443 -30239480, 30241567, 30244787, 30246179, 30247305, 30252098, 30252156 -30253255, 30265523, 30265615, 30272329, 30281591, 30282501, 30283932 -30293345, 30305880, 30312094, 30312568, 30316897, 30320029, 30325407 -30331356, 30342878, 30345926, 30352623, 30355490, 30357897, 30364613 -30365745, 30368482, 30368668, 30372081, 30374739, 30377692, 30381207 -30384121, 30384152, 30387666, 30391272, 30397100, 30402386, 30403763 -30408515, 30413137, 30416034, 30421204, 30431274, 30441687, 30443393 -30453442, 30458593, 30460922, 30464250, 30464655, 30473634, 30474774 -30475115, 30476768, 30485255, 30489582, 30496957, 30497057, 30498824 -30501574, 30503943, 30509277, 30510527, 30517516, 30522998, 30528547 -30528704, 30532811, 30533198, 30534662, 30578221, 30581448, 30582500 -30606345, 30613937, 30623138, 30624864, 30635302, 30652853, 30654409 -30662736, 30668407, 30671813, 30679595, 30679771, 30681462, 30698289 -30741263, 30749644, 30755348, 30758943, 30783551, 30803210, 30809087 -30814266, 30814285, 30815852, 30816938, 30822919, 30826474, 30855101 -30856358, 30866988, 30887501, 30891760, 30904672, 30905638, 30914674 -30919804, 30922870, 30937340, 30964194, 30968208, 30980615, 30985027 -30987088, 30994996, 30998759, 31001455, 31004719, 31013127, 31022858 -31028986, 31061482, 31100172, 31104809, 31106577, 31109506, 31115502 -31156383, 31172207, 31182793, 31192039, 31194264, 31200845, 31201001 -31215438, 31228670, 31233170, 31254535, 31257826, 31258101, 31302499 -31306248, 31306261, 31309867, 31315876, 31326608, 31331354, 31335037 -31335142, 31341859, 31343752, 31347532, 31377487, 31393600, 31408636 -31430722, 31501139, 31508450, 31525783, 31527103, 31544097, 31570161 -31600023, 31628311, 31637680, 31658464, 31658943, 31668061, 31668872 -31696577, 31711889, 31718134, 31726483, 31748000, 31749740, 31771858 -31786838, 31816631, 31836113, 31862611, 31867037, 31886745, 31897786 -31905033, 31909295, 31945038, 31986836, 31997805, 32028155, 32089820 -32095380, 32105135, 32119339, 32153619, 32162748, 32165759, 32186646 -32190132, 32190190, 32190284, 32191451, 32222473, 32234161, 32245850 -32246090, 32296941, 32312131, 32327201, 32327208, 32335769, 32359044 -32368789, 32368792, 32404638, 32425124, 32426251, 32436757, 32442404 -32478429, 32494298, 32505009, 32509606, 32523206, 32676350, 32704765 -32720458, 32725484, 32786309, 32858446, 32889434, 32892883, 33034103 -``` - -## Version 12\.2\.0\.1\.ru\-2021\-04\.rur\-2021\-04\.r1 - -Version 12\.2\.0\.1\.ru\-2021\-04\.rur\-2021\-04\.r1 includes the following: -+ Patch 32507738: DATABASE APR 2021 RELEASE UPDATE 12\.2\.0\.1\.210420 -+ Patch 32473172: OJVM RELEASE UPDATE 12\.2\.0\.1\.210420 -+ Patch 32327201: RDBMS \- DSTV36 UPDATE \- TZDATA2020E -+ Patch 29213893: DBMS\_STATS FAILING WITH ERROR ORA\-01422 WHEN GATHERING STATS FOR USER$ TABLE -+ Patch 28730253: SUPPORT NEW ERA REIWA FOR JAPANESE IMPERIAL CALENDAR -+ Patch 26352615: SPILLOVER AUDIT FILES CANNOT BE FOUND ORA\-46372 -+ PreUpgrade Jar: preupgrade\_12201\_cbuild\_24\_lf\.zip - -### Combined Patches for Version 12\.2\.0\.1\.ru\-2021\-04\.rur\-2021\-04\.r1, Released April 2021 - -Bugs fixed: - -``` -7391838, 8480838, 8932139, 8975044, 12763598, 13554903, 14221306 -14690846, 15931756, 16002385, 16438495, 16727454, 16942578, 17027695 -17533661, 17947871, 17958365, 18308268, 18521691, 18594510, 18774543 -18878420, 18986501, 19072655, 19211433, 19285025, 19327292, 19526548 -19614243, 19647894, 19649997, 19702201, 19721304, 20003668, 20087519 -20118035, 20120236, 20324049, 20436508, 20532077, 20549013, 20588486 -20591151, 20617383, 20620169, 20736227, 20756305, 20866970, 20917487 -20976443, 21070321, 21089435, 21095391, 21143725, 21147908, 21159907 -21178363, 21186167, 21197098, 21216226, 21320338, 21355390, 21433452 -21479706, 21517767, 21520266, 21547051, 21638600, 21744603, 21788462 -21837606, 21882528, 21935698, 21962287, 21981529, 21985256, 22007324 -22070226, 22070473, 22070853, 22072543, 22087683, 22104866, 22107360 -22174392, 22179537, 22282748, 22310426, 22347493, 22363790, 22364044 -22367053, 22379010, 22446455, 22454940, 22468255, 22495673, 22503283 -22503297, 22504793, 22522515, 22530986, 22564336, 22568728, 22581771 -22594071, 22599050, 22628825, 22645009, 22645496, 22654475, 22700845 -22726044, 22729345, 22820798, 22826067, 22843979, 22845846, 22864303 -22898198, 22921674, 22939829, 22950945, 22970869, 22981722, 23018676 -23019710, 23026585, 23035249, 23055900, 23056058, 23061453, 23065002 -23066146, 23080557, 23104033, 23105538, 23109325, 23110523, 23125560 -23126545, 23127945, 23143074, 23151677, 23168363, 23169712, 23177923 -23179662, 23184263, 23197730, 23234232, 23237091, 23249829, 23271203 -23278750, 23281269, 23282973, 23300142, 23306590, 23308065, 23310101 -23312077, 23328639, 23333567, 23336559, 23342170, 23481673, 23491861 -23499004, 23499160, 23521523, 23527363, 23533647, 23548817, 23567857 -23572982, 23581777, 23588722, 23599216, 23600861, 23602213, 23614158 -23627427, 23645516, 23665623, 23709062, 23715460, 23715518, 23730961 -23733981, 23735292, 23738304, 23741944, 23743596, 23746128, 23749454 -23761724, 23763462, 24006569, 24010030, 24289874, 24289895, 24294174 -24303148, 24307571, 24308349, 24326444, 24326846, 24328857, 24330708 -24332831, 24334708, 24336249, 24337882, 24341675, 24343905, 24345420 -24346821, 24348685, 24350620, 24352981, 24355111, 24357348, 24368004 -24371491, 24373528, 24373756, 24374976, 24376875, 24376878, 24383086 -24385983, 24401351, 24403922, 24409977, 24415926, 24416451, 24421668 -24423416, 24425056, 24425998, 24432875, 24435982, 24437162, 24440612 -24440648, 24443539, 24445571, 24457597, 24460392, 24461826, 24467122 -24468470, 24470606, 24471079, 24471473, 24473736, 24480567, 24484749 -24485034, 24485161, 24485174, 24485619, 24486059, 24486237, 24509056 -24516314, 24530364, 24534401, 24554533, 24555417, 24556862, 24556967 -24560906, 24563422, 24570214, 24570598, 24573817, 24578718, 24578797 -24588377, 24589081, 24589590, 24591506, 24593740, 24595699, 24596874 -24600330, 24609592, 24609996, 24611527, 24616637, 24617969, 24623975 -24624166, 24642495, 24654629, 24655717, 24664211, 24668398, 24669189 -24669730, 24674197, 24674955, 24676172, 24677696, 24680959, 24687075 -24689376, 24692973, 24693010, 24693290, 24697323, 24699619, 24701840 -24710696, 24713381, 24714096, 24717183, 24717859, 24718260, 24719799 -24735430, 24737064, 24737403, 24737581, 24737954, 24739791, 24744383 -24744686, 24752618, 24757934, 24759556, 24760407, 24763196, 24764085 -24766309, 24784414, 24786669, 24791883, 24792678, 24793511, 24796092 -24797119, 24798481, 24800423, 24801152, 24802934, 24808504, 24811725 -24812047, 24817447, 24818566, 24827228, 24827654, 24831514, 24835919 -24841671, 24843188, 24844549, 24844841, 24845157, 24848746, 24848923 -24850622, 24907917, 24908063, 24908321, 24911709, 24912588, 24920582 -24921478, 24922704, 24923080, 24923215, 24923338, 24923790, 24924667 -24926999, 24929210, 24938784, 24940060, 24942749, 24953434, 24957555 -24960044, 24960809, 24965426, 24966594, 24966788, 24967993, 24968162 -24976007, 24978100, 25022574, 25027852, 25028996, 25029022, 25029423 -25031502, 25032818, 25034396, 25036006, 25036474, 25042823, 25044977 -25045228, 25050160, 25051465, 25051628, 25054064, 25057811, 25058080 -25060506, 25062592, 25063971, 25065563, 25072986, 25077278, 25078611 -25086233, 25087436, 25091141, 25092777, 25093872, 25095982, 25098160 -25099339, 25099497, 25099758, 25100063, 25100579, 25103996, 25107662 -25110233, 25114561, 25115178, 25120284, 25120668, 25120742, 25121089 -25123585, 25124363, 25129925, 25130312, 25140197, 25145163, 25145215 -25150925, 25159176, 25162645, 25164293, 25166187, 25171041, 25171084 -25173124, 25175723, 25176408, 25178032, 25178101, 25178179, 25179774 -25182817, 25184453, 25184555, 25186079, 25189723, 25191872, 25192044 -25192528, 25192729, 25195901, 25199585, 25200101, 25201454, 25202355 -25203656, 25205368, 25205954, 25206864, 25207410, 25209912, 25210268 -25210499, 25210690, 25211628, 25219450, 25223839, 25224242, 25225795 -25226665, 25227381, 25230870, 25230945, 25237577, 25240188, 25240590 -25241448, 25241625, 25244807, 25248384, 25250109, 25251648, 25257085 -25259611, 25262869, 25263960, 25265499, 25269133, 25283790, 25287072 -25288078, 25293659, 25296876, 25299227, 25299807, 25300427, 25303284 -25303756, 25305405, 25307368, 25309116, 25313154, 25313411, 25316758 -25317989, 25320555, 25323525, 25328093, 25328518, 25329664, 25335249 -25335360, 25335790, 25337332, 25337640, 25348567, 25348956, 25353983 -25356118, 25357142, 25360661, 25362958, 25367588, 25367721, 25382812 -25383204, 25384462, 25386748, 25388573, 25388896, 25392535, 25393714 -25395696, 25397936, 25398306, 25404117, 25404202, 25405100, 25405687 -25405813, 25410017, 25410180, 25410802, 25410877, 25411036, 25415713 -25416731, 25417050, 25417056, 25417958, 25425005, 25425451, 25425760 -25427662, 25429959, 25430120, 25433696, 25435038, 25437699, 25440818 -25442559, 25444961, 25445168, 25451531, 25452452, 25455795, 25457409 -25459958, 25462714, 25463844, 25472112, 25472885, 25476125, 25476149 -25477657, 25478885, 25479164, 25481087, 25482971, 25486384, 25489342 -25489367, 25489607, 25492379, 25498930, 25498994, 25516250, 25524955 -25528838, 25530080, 25530814, 25535668, 25536819, 25537470, 25539063 -25540738, 25546580, 25546608, 25547901, 25551676, 25553616, 25554787 -25555252, 25557886, 25558986, 25560487, 25560538, 25561296, 25569149 -25569504, 25570929, 25573623, 25575348, 25575369, 25575628, 25576115 -25579458, 25579761, 25591394, 25594901, 25597525, 25598473, 25599425 -25600342, 25600421, 25601999, 25602488, 25603923, 25606091, 25607726 -25612095, 25614866, 25616268, 25616359, 25616417, 25616645, 25631933 -25633101, 25634317, 25634348, 25635149, 25638456, 25639019, 25643818 -25643889, 25643931, 25646373, 25647325, 25648731, 25653109, 25654459 -25654936, 25655390, 25655966, 25659655, 25660847, 25661819, 25662088 -25662101, 25662524, 25663488, 25667973, 25669791, 25670786, 25671354 -25672640, 25674386, 25680221, 25685152, 25686739, 25687460, 25691904 -25694206, 25695903, 25696520, 25699321, 25700654, 25709368, 25710420 -25715167, 25717371, 25722055, 25722608, 25722720, 25723097, 25723158 -25728085, 25729507, 25730014, 25734963, 25736747, 25739065, 25740844 -25741955, 25743479, 25747569, 25749273, 25752755, 25754606, 25756945 -25757697, 25757748, 25760195, 25762221, 25764020, 25766822, 25768681 -25772669, 25774077, 25775213, 25775444, 25780343, 25783447, 25784002 -25785331, 25785441, 25788879, 25789041, 25789277, 25789579, 25790353 -25792911, 25795865, 25797092, 25797124, 25797305, 25800464, 25802510 -25803364, 25803545, 25807997, 25809524, 25810263, 25810704, 25811105 -25811650, 25812390, 25813931, 25818707, 25822410, 25823532, 25823754 -25824372, 25825910, 25826740, 25830492, 25832935, 25834581, 25835365 -25838361, 25838755, 25852885, 25856821, 25858672, 25861398, 25865785 -25866948, 25870579, 25871177, 25871639, 25871753, 25872127, 25872389 -25873336, 25874050, 25874678, 25881255, 25882264, 25883438, 25885148 -25888073, 25888984, 25890002, 25890046, 25890056, 25890673, 25890782 -25894239, 25895224, 25897615, 25898228, 25904273, 25904490, 25905130 -25906117, 25906886, 25908728, 25911724, 25914276, 25919622, 25932524 -25932728, 25933494, 25941836, 25942868, 25943271, 25945130, 25947799 -25951571, 25953857, 25954022, 25954054, 25957038, 25963024, 25964954 -25967544, 25967985, 25970731, 25971286, 25972417, 25973152, 25975723 -25977302, 25980605, 25980770, 25981498, 25982666, 25986062, 25990907 -25995938, 25997810, 26006257, 26007010, 26019148, 26023042, 26024732 -26024784, 26025681, 26029075, 26029777, 26029780, 26032573, 26034119 -26036748, 26037215, 26038086, 26039623, 26040483, 26045732, 26051656 -26078437, 26078493, 26080410, 26083298, 26087754, 26088426, 26088836 -26089669, 26090767, 26090893, 26091640, 26091786, 26095327, 26095405 -26096382, 26108080, 26108337, 26110259, 26110632, 26111842, 26112621 -26115103, 26121990, 26124078, 26130486, 26137367, 26137416, 26138085 -26145560, 26149904, 26153372, 26153977, 26168933, 26169341, 26169345 -26170659, 26170715, 26176002, 26187943, 26189861, 26198757, 26198926 -26201113, 26203182, 26223039, 26237338, 26237431, 26237773, 26238195 -26242031, 26242677, 26243698, 26244115, 26245237, 26248143, 26249718 -26256131, 26257953, 26259265, 26261327, 26263328, 26263721, 26268756 -26269790, 26271001, 26274660, 26275023, 26275415, 26277439, 26281476 -26285062, 26285933, 26301540, 26308650, 26309047, 26317991, 26318200 -26318627, 26323308, 26324206, 26324769, 26325856, 26327418, 26327624 -26327775, 26330994, 26331743, 26333141, 26334602, 26336977, 26338953 -26351334, 26351996, 26352615, 26353617, 26354844, 26356098, 26358670 -26359091, 26362155, 26362821, 26366517, 26367012, 26367460, 26371725 -26373967, 26374791, 26375052, 26375250, 26375330, 26380097, 26385189 -26386858, 26388538, 26396790, 26398675, 26399626, 26399691, 26399839 -26405036, 26406387, 26407408, 26410240, 26412540, 26418088, 26420561 -26421667, 26422277, 26423085, 26426526, 26426967, 26430323, 26430737 -26434436, 26434999, 26435073, 26436168, 26438612, 26439748, 26440142 -26440169, 26440749, 26441345, 26442308, 26444601, 26444887, 26446098 -26451793, 26452606, 26474662, 26474703, 26475419, 26476090, 26476244 -26478970, 26479173, 26482376, 26486365, 26492666, 26492866, 26493289 -26498354, 26513067, 26513709, 26521043, 26522439, 26523432, 26526726 -26526799, 26536320, 26537307, 26542135, 26542236, 26542835, 26544823 -26545688, 26546070, 26546664, 26546754, 26548363, 26556014, 26558437 -26569225, 26570134, 26575788, 26580633, 26582460, 26584641, 26588069 -26597140, 26599395, 26608137, 26608238, 26609942, 26615291, 26615690 -26617804, 26623652, 26626879, 26629381, 26633355, 26633558, 26635897 -26637273, 26637824, 26639167, 26641610, 26641852, 26650226, 26650540 -26654363, 26658759, 26659182, 26669550, 26680105, 26712331, 26714486 -26714910, 26716835, 26717528, 26724511, 26725687, 26727397, 26729494 -26729611, 26740700, 26743240, 26744595, 26745002, 26751106, 26751171 -26755171, 26758193, 26764561, 26765212, 26768025, 26775602, 26784509 -26790923, 26794786, 26797591, 26798411, 26798514, 26798516, 26802503 -26816582, 26820076, 26822314, 26822620, 26824833, 26828994, 26829845 -26830694, 26832296, 26833932, 26837569, 26837702, 26840654, 26844406 -26844870, 26849779, 26855855, 26871815, 26875822, 26883456, 26895149 -26896659, 26898563, 26907236, 26907327, 26908788, 26909100, 26909504 -26910716, 26911000, 26923777, 26939314, 26943004, 26944190, 26947373 -26958896, 26963310, 26966616, 26966916, 26967713, 26968670, 26969321 -26970175, 26970717, 26981902, 26983259, 26985002, 26986173, 26992964 -26999139, 27000158, 27000702, 27006120, 27006664, 27009164, 27013146 -27015449, 27028251, 27032785, 27033520, 27033652, 27034890, 27036163 -27037839, 27038986, 27039712, 27044169, 27044297, 27045634, 27052607 -27056711, 27058530, 27060167, 27060859, 27061736, 27072923, 27073314 -27079140, 27079651, 27084613, 27087426, 27090765, 27092508, 27093423 -27097854, 27100800, 27101105, 27105900, 27106179, 27110878, 27115422 -27117822, 27119621, 27119861, 27122162, 27124624, 27125872, 27133662 -27134734, 27135647, 27135993, 27138325, 27142120, 27142373, 27142529 -27144928, 27151826, 27153641, 27160922, 27161071, 27162390, 27162405 -27163928, 27165231, 27169796, 27170305, 27181537, 27181897, 27185188 -27195935, 27199245, 27200959, 27202015, 27203055, 27207110, 27207634 -27208795, 27213224, 27216046, 27217412, 27223075, 27229389, 27231051 -27234962, 27236722, 27242226, 27244337, 27244999, 27248917, 27249531 -27250547, 27251690, 27254335, 27255377, 27256000, 27258578, 27259307 -27262945, 27264464, 27266245, 27274456, 27274536, 27275533, 27276231 -27283960, 27284499, 27285244, 27288638, 27292213, 27293599, 27302711 -27302730, 27303287, 27303938, 27304410, 27304906, 27305039, 27308088 -27314206, 27314390, 27314697, 27320576, 27321179, 27329612, 27333106 -27334316, 27338912, 27338946, 27339115, 27345231, 27346709, 27348081 -27349393, 27350267, 27351628, 27359178, 27364854, 27365014, 27367194 -27369515, 27370965, 27375542, 27381498, 27383281, 27386467, 27392968 -27393570, 27394703, 27395416, 27396624, 27396672, 27396813, 27397048 -27400416, 27400598, 27404573, 27404668, 27405645, 27416997, 27423251 -27424405, 27426363, 27432062, 27432826, 27433385, 27433870, 27434193 -27439835, 27441326, 27442041, 27443406, 27445727, 27452046, 27457891 -27459593, 27459948, 27461740, 27466597, 27468303, 27486805, 27487919 -27489107, 27493674, 27494663, 27501373, 27501413, 27502420, 27504770 -27505229, 27508985, 27510959, 27525909, 27529661, 27533780, 27533819 -27534509, 27539876, 27540613, 27544973, 27548131, 27554074, 27555481 -27558861, 27560602, 27562488, 27565906, 27567477, 27576342, 27576354 -27587905, 27588271, 27589260, 27593501, 27595973, 27601118, 27601441 -27607563, 27611612, 27613080, 27613530, 27613554, 27615649, 27617978 -27620808, 27623159, 27629756, 27629928, 27632114, 27634676, 27634991 -27642235, 27645231, 27657712, 27658186, 27666312, 27671633, 27680669 -27686599, 27687880, 27688036, 27688099, 27688692, 27691920, 27691939 -27693416, 27693713, 27695063, 27698953, 27700466, 27704237, 27709046 -27710072, 27717210, 27719000, 27726780, 27729678, 27739006, 27740424 -27745728, 27748954, 27751755, 27757567, 27757888, 27758544, 27758653 -27758972, 27759077, 27769361, 27779886, 27793533, 27799032, 27801337 -27818389, 27819881, 27824540, 27824543, 27825241, 27828794, 27828892 -27829295, 27833672, 27834551, 27834569, 27835925, 27837219, 27839353 -27839616, 27846298, 27846499, 27847259, 27850112, 27855490, 27861226 -27873412, 27882176, 27886087, 27897759, 27898015, 27902561, 27908396 -27909478, 27927431, 27929287, 27929509, 27931299, 27935493, 27940876 -27945870, 27951817, 27952586, 27959048, 27959594, 27964513, 27966472 -27967484, 27983174, 27986817, 27994325, 27995215, 27995248, 27997875 -27998003, 27999073, 27999638, 28000269, 28007516, 28019592, 28022101 -28023081, 28023399, 28023482, 28024793, 28025414, 28026866, 28033429 -28040776, 28043157, 28045903, 28066655, 28067846, 28071549, 28072383 -28072567, 28073470, 28074713, 28079127, 28090453, 28092783, 28098040 -28098160, 28099662, 28104176, 28108003, 28111583, 28120036, 28120951 -28124631, 28125601, 28125947, 28129791, 28140658, 28157786, 28164480 -28165439, 28171079, 28174827, 28180464, 28181021, 28184554, 28188330 -28190796, 28194173, 28199085, 28201419, 28204262, 28209985, 28215510 -28218832, 28220398, 28223871, 28226179, 28229360, 28236305, 28238264 -28242712, 28250929, 28256164, 28271119, 28276054, 28279837, 28281094 -28282606, 28287484, 28290434, 28294563, 28302049, 28305001, 28305362 -28305607, 28309406, 28319114, 28320399, 28330714, 28330971, 28350595 -28354603, 28357401, 28361221, 28365111, 28369092, 28371123, 28373960 -28375383, 28378446, 28384353, 28386259, 28388910, 28389153, 28390273 -28391210, 28394726, 28396445, 28397317, 28401116, 28402823, 28420042 -28420457, 28423598, 28432129, 28434028, 28435902, 28437315, 28439086 -28454215, 28454242, 28468312, 28468493, 28481149, 28483184, 28489150 -28501075, 28502098, 28502343, 28503038, 28507324, 28508053, 28508557 -28512336, 28521330, 28522441, 28528349, 28530171, 28535127, 28535272 -28537715, 28538439, 28542455, 28545134, 28546290, 28547068, 28547478 -28564479, 28566241, 28571483, 28572407, 28572834, 28578164, 28578945 -28585411, 28587723, 28589509, 28600233, 28602253, 28606598, 28608211 -28612674, 28614372, 28617631, 28617959, 28621470, 28622202, 28627255 -28636676, 28639299, 28642899, 28678804, 28690694, 28691965, 28692103 -28692275, 28697526, 28697806, 28703812, 28708023, 28709063, 28710469 -28710734, 28714988, 28715655, 28728272, 28730044, 28730253, 28734355 -28740708, 28742555, 28749289, 28749724, 28758090, 28758722, 28774416 -28776431, 28777174, 28791725, 28797711, 28803345, 28808314, 28817449 -28819640, 28820669, 28821847, 28827682, 28830691, 28831971, 28835937 -28836716, 28838066, 28844866, 28847136, 28849751, 28852325, 28852691 -28855922, 28856060, 28856172, 28863263, 28863487, 28867992, 28887305 -28889730, 28891984, 28905390, 28910498, 28915870, 28927452, 28945922 -28948554, 28949888, 28951026, 28951382, 28956908, 28959493, 28960211 -28965095, 28965787, 28986231, 28986257, 28987439, 28991884, 28993295 -28993590, 29002488, 29006527, 29007321, 29007353, 29009513, 29013832 -29024054, 29026309, 29026582, 29027694, 29032276, 29039510, 29040739 -29044086, 29044954, 29048498, 29048728, 29050886, 29060216, 29061016 -29115857, 29125374, 29154725, 29158680, 29163567, 29170232, 29173817 -29179097, 29182517, 29182901, 29189889, 29198092, 29200700, 29203604 -29213320, 29213351, 29213893, 29224605, 29224710, 29237575, 29247712 -29249289, 29250230, 29250317, 29254623, 29260956, 29278684, 29296257 -29301463, 29307638, 29312889, 29337294, 29338348, 29339155, 29343086 -29343156, 29343861, 29347943, 29353821, 29372069, 29372460, 29375355 -29375984, 29376346, 29378913, 29379978, 29383695, 29388020, 29398488 -29399336, 29405462, 29409149, 29409455, 29415774, 29418165, 29420254 -29426241, 29434301, 29436454, 29437712, 29450812, 29452251, 29454978 -29463047, 29464779, 29472618, 29477015, 29483626, 29483672, 29483723 -29483771, 29500257, 29500963, 29501218, 29504682, 29511611, 29524985 -29530515, 29536342, 29538631, 29542449, 29542580, 29548592, 29549071 -29559395, 29564592, 29580394, 29591343, 29608023, 29614575, 29614987 -29621961, 29625065, 29626154, 29629430, 29633753, 29637526, 29637560 -29645349, 29651520, 29656843, 29667994, 29676089, 29678163, 29685137 -29687220, 29688867, 29689697, 29690625, 29703195, 29705793, 29707896 -29717901, 29719146, 29724063, 29726695, 29741319, 29766435, 29767177 -29769901, 29774362, 29782211, 29791152, 29794174, 29794462, 29796916 -29807964, 29813494, 29815341, 29817278, 29822714, 29825525, 29836659 -29841687, 29844131, 29846645, 29853485, 29865188, 29869404, 29869906 -29875459, 29876358, 29881050, 29881575, 29884958, 29893132, 29902299 -29902311, 29914449, 29930457, 29933718, 29941062, 29942554, 29944035 -29944159, 29944660, 29951620, 29951759, 29961353, 29962927, 29962939 -29965888, 29991257, 29997937, 30008125, 30018017, 30018903, 30031027 -30039959, 30064268, 30068871, 30076253, 30078934, 30086166, 30088912 -30092280, 30098251, 30099302, 30114477, 30116203, 30120608, 30125995 -30128047, 30131286, 30139392, 30147928, 30150731, 30160625, 30163243 -30164714, 30173113, 30177597, 30179644, 30186706, 30189023, 30193736 -30196358, 30200680, 30200758, 30215130, 30218044, 30218317, 30223712 -30225443, 30239480, 30241567, 30244787, 30246179, 30247305, 30252098 -30252156, 30253255, 30265523, 30265615, 30272329, 30281591, 30282501 -30283932, 30293345, 30305880, 30312094, 30312568, 30316897, 30320029 -30325407, 30331356, 30342878, 30345926, 30352623, 30355490, 30357897 -30364613, 30365745, 30368482, 30368668, 30372081, 30374739, 30377692 -30381207, 30384121, 30384152, 30387666, 30391272, 30397100, 30402386 -30403763, 30408515, 30413137, 30416034, 30421204, 30431274, 30441687 -30443393, 30453442, 30458593, 30460922, 30464250, 30464655, 30473634 -30474774, 30475115, 30476768, 30485255, 30489582, 30496957, 30497057 -30498824, 30501574, 30503943, 30509277, 30510527, 30517516, 30522998 -30528547, 30528704, 30532811, 30533198, 30534662, 30578221, 30581448 -30582500, 30606345, 30613937, 30623138, 30624864, 30635302, 30652853 -30654409, 30662736, 30668407, 30671813, 30679595, 30679771, 30681462 -30698289, 30741263, 30749644, 30755348, 30758943, 30783551, 30803210 -30809087, 30814266, 30814285, 30815852, 30816938, 30822919, 30826474 -30855101, 30856358, 30866988, 30887501, 30904672, 30905638, 30914674 -30919804, 30922870, 30937340, 30964194, 30968208, 30980615, 30985027 -30987088, 30994996, 30998759, 31001455, 31004719, 31013127, 31022858 -31028986, 31061482, 31100172, 31104809, 31106577, 31109506, 31115502 -31156383, 31172207, 31182793, 31192039, 31194264, 31200845, 31201001 -31215438, 31228670, 31233170, 31254535, 31257826, 31258101, 31302499 -31306248, 31306261, 31309867, 31315876, 31326608, 31331354, 31335037 -31335142, 31341859, 31343752, 31347532, 31377487, 31393600, 31408636 -31430722, 31501139, 31508450, 31525783, 31527103, 31544097, 31570161 -31600023, 31628311, 31637680, 31658464, 31658943, 31668061, 31668872 -31696577, 31711889, 31718134, 31726483, 31748000, 31749740, 31771858 -31786838, 31816631, 31836113, 31862611, 31867037, 31886745, 31897786 -31905033, 31909295, 31945038, 31986836, 31997805, 32089820, 32105135 -32162748, 32165759, 32186646, 32222473, 32234161, 32246090, 32296941 -32327201, 32478429, 32505009, 32523206 -``` - -## Version 12\.2\.0\.1\.ru\-2021\-01\.rur\-2021\-01\.r1 - -Version 12\.2\.0\.1\.ru\-2021\-01\.rur\-2021\-01\.r1 includes the following: -+ Patch 32228578: DATABASE JAN 2021 RELEASE UPDATE 12\.2\.0\.1\.210119 -+ Patch 32119931: OJVM RELEASE UPDATE 12\.2\.0\.1\.210119 -+ Patch 31335037: RDBMS \- DSTV35 UPDATE \- TZDATA2020A -+ Patch 31335142: DSTV35 UPDATE \- TZDATA2020A \- NEED OJVM FIX -+ Patch 29213893: DBMS\_STATS FAILING WITH ERROR ORA\-01422 WHEN GATHERING STATS FOR USER$ TABLE -+ PreUpgrade Jar: preupgrade\_12201\_cbuild\_23\_lf\.zip -+ Java Cryptography Extension \(JCE\): Unlimited Strength Jurisdiction Policy Files for JVM version 8 -+ Support for [Managing advisor tasks](Appendix.Oracle.CommonDBATasks.Misc.md#Appendix.Oracle.CommonDBATasks.managing-advisor-tasks) using procedures in the `rdsadmin.rdsadmin_util` package - -### Combined patches for version 12\.2\.0\.1\.ru\-2021\-01\.rur\-2021\-01\.r1, released January 2021 - -Bugs fixed: - -``` -7391838, 8480838, 8932139, 8975044, 12763598, 13554903, 14221306 -14690846, 15931756, 16002385, 16438495, 16727454, 16942578, 17027695 -17533661, 17947871, 17958365, 18308268, 18521691, 18594510, 18774543 -18878420, 18986501, 19072655, 19211433, 19285025, 19327292, 19526548 -19614243, 19647894, 19649997, 19702201, 19721304, 20003668, 20087519 -20118035, 20120236, 20324049, 20436508, 20532077, 20549013, 20588486 -20591151, 20617383, 20620169, 20736227, 20756305, 20866970, 20917487 -20976443, 21070321, 21089435, 21095391, 21143725, 21147908, 21159907 -21178363, 21186167, 21197098, 21216226, 21320338, 21355390, 21433452 -21479706, 21517767, 21520266, 21547051, 21638600, 21744603, 21788462 -21837606, 21882528, 21935698, 21962287, 21981529, 21985256, 22007324 -22070226, 22070473, 22070853, 22072543, 22087683, 22104866, 22107360 -22174392, 22179537, 22282748, 22310426, 22347493, 22363790, 22364044 -22367053, 22379010, 22446455, 22454940, 22468255, 22495673, 22503283 -22503297, 22504793, 22522515, 22530986, 22564336, 22568728, 22581771 -22594071, 22599050, 22628825, 22645009, 22645496, 22654475, 22700845 -22726044, 22729345, 22820798, 22826067, 22843979, 22845846, 22864303 -22898198, 22921674, 22939829, 22950945, 22970869, 22981722, 23018676 -23019710, 23026585, 23035249, 23055900, 23056058, 23061453, 23065002 -23066146, 23080557, 23104033, 23105538, 23109325, 23110523, 23125560 -23126545, 23127945, 23143074, 23151677, 23168363, 23169712, 23177923 -23179662, 23184263, 23197730, 23234232, 23237091, 23249829, 23271203 -23278750, 23281269, 23282973, 23300142, 23306590, 23308065, 23310101 -23312077, 23328639, 23333567, 23336559, 23342170, 23481673, 23491861 -23499004, 23499160, 23521523, 23527363, 23533647, 23548817, 23567857 -23572982, 23581777, 23588722, 23599216, 23600861, 23602213, 23614158 -23645516, 23665623, 23709062, 23715460, 23715518, 23730961, 23733981 -23735292, 23738304, 23741944, 23743596, 23746128, 23749454, 23761724 -23763462, 24006569, 24010030, 24289874, 24289895, 24294174, 24303148 -24307571, 24308349, 24326444, 24326846, 24328857, 24330708, 24332831 -24334708, 24336249, 24337882, 24341675, 24343905, 24345420, 24346821 -24348685, 24350620, 24352981, 24355111, 24357348, 24368004, 24371491 -24373528, 24373756, 24374976, 24376875, 24376878, 24383086, 24385983 -24401351, 24403922, 24409977, 24415926, 24416451, 24421668, 24423416 -24425056, 24425998, 24432875, 24435982, 24437162, 24440612, 24440648 -24443539, 24445571, 24457597, 24460392, 24461826, 24467122, 24468470 -24470606, 24471079, 24471473, 24473736, 24484749, 24485034, 24485161 -24485174, 24485619, 24486059, 24486237, 24509056, 24516314, 24530364 -24534401, 24554533, 24555417, 24556862, 24556967, 24560906, 24563422 -24570214, 24570598, 24573817, 24578718, 24578797, 24588377, 24589081 -24589590, 24591506, 24593740, 24595699, 24596874, 24600330, 24609592 -24609996, 24611527, 24616637, 24617969, 24623975, 24624166, 24642495 -24654629, 24655717, 24664211, 24668398, 24669189, 24669730, 24674197 -24674955, 24676172, 24677696, 24680959, 24687075, 24689376, 24692973 -24693010, 24693290, 24697323, 24699619, 24701840, 24710696, 24713381 -24714096, 24717183, 24717859, 24718260, 24719799, 24735430, 24737064 -24737403, 24737581, 24737954, 24739791, 24744383, 24744686, 24752618 -24757934, 24759556, 24760407, 24763196, 24764085, 24766309, 24784414 -24786669, 24791883, 24792678, 24793511, 24796092, 24797119, 24798481 -24800423, 24801152, 24802934, 24808504, 24811725, 24812047, 24817447 -24818566, 24827228, 24827654, 24831514, 24835919, 24841671, 24843188 -24844549, 24844841, 24845157, 24848746, 24848923, 24850622, 24907917 -24908063, 24908321, 24911709, 24912588, 24920582, 24921478, 24922704 -24923080, 24923215, 24923338, 24923790, 24924667, 24926999, 24929210 -24938784, 24940060, 24942749, 24953434, 24957555, 24960044, 24960809 -24965426, 24966594, 24966788, 24967993, 24968162, 24976007, 24978100 -25022574, 25027852, 25028996, 25029022, 25029423, 25031502, 25032818 -25034396, 25036006, 25036474, 25042823, 25044977, 25045228, 25050160 -25051465, 25051628, 25054064, 25057811, 25058080, 25060506, 25062592 -25063971, 25065563, 25072986, 25077278, 25078611, 25086233, 25087436 -25091141, 25092777, 25093872, 25095982, 25098160, 25099339, 25099497 -25099758, 25100063, 25100579, 25103996, 25107662, 25110233, 25114561 -25115178, 25120284, 25120668, 25120742, 25121089, 25123585, 25124363 -25129925, 25130312, 25140197, 25145163, 25145215, 25150925, 25159176 -25162645, 25164293, 25166187, 25171041, 25171084, 25173124, 25175723 -25176408, 25178032, 25178101, 25178179, 25179774, 25182817, 25184453 -25184555, 25186079, 25189723, 25191872, 25192044, 25192528, 25192729 -25195901, 25199585, 25200101, 25201454, 25202355, 25203656, 25205368 -25205954, 25206864, 25207410, 25209912, 25210268, 25210499, 25210690 -25211628, 25219450, 25223839, 25224242, 25225795, 25226665, 25227381 -25230870, 25230945, 25237577, 25240188, 25240590, 25241448, 25241625 -25244807, 25248384, 25250109, 25251648, 25257085, 25259611, 25262869 -25263960, 25265499, 25269133, 25283790, 25287072, 25293659, 25296876 -25299227, 25299807, 25300427, 25303284, 25303756, 25305405, 25307368 -25309116, 25313154, 25313411, 25316758, 25317989, 25320555, 25323525 -25328093, 25328518, 25329664, 25335249, 25335360, 25335790, 25337332 -25337640, 25348567, 25348956, 25353983, 25356118, 25357142, 25360661 -25362958, 25367588, 25367721, 25382812, 25383204, 25384462, 25386748 -25388573, 25388896, 25392535, 25393714, 25395696, 25397936, 25398306 -25404117, 25404202, 25405100, 25405687, 25405813, 25410017, 25410180 -25410802, 25410877, 25411036, 25415713, 25416731, 25417050, 25417056 -25417958, 25425005, 25425451, 25425760, 25427662, 25429959, 25430120 -25433696, 25435038, 25437699, 25440818, 25442559, 25444961, 25445168 -25451531, 25452452, 25455795, 25457409, 25459958, 25462714, 25463844 -25472112, 25472885, 25476125, 25476149, 25477657, 25478885, 25479164 -25481087, 25482971, 25486384, 25489342, 25489367, 25489607, 25492379 -25498930, 25498994, 25516250, 25524955, 25528838, 25530080, 25530814 -25535668, 25536819, 25537470, 25539063, 25540738, 25546580, 25546608 -25547901, 25551676, 25553616, 25554787, 25555252, 25557886, 25558986 -25560487, 25560538, 25561296, 25569149, 25569504, 25570929, 25573623 -25575348, 25575369, 25575628, 25576115, 25579458, 25579761, 25591394 -25594901, 25597525, 25598473, 25599425, 25600342, 25600421, 25601999 -25602488, 25603923, 25606091, 25607726, 25612095, 25614866, 25616268 -25616359, 25616417, 25616645, 25631933, 25633101, 25634317, 25634348 -25635149, 25638456, 25639019, 25643818, 25643889, 25643931, 25646373 -25647325, 25648731, 25653109, 25654459, 25654936, 25655390, 25655966 -25659655, 25660847, 25661819, 25662088, 25662101, 25662524, 25663488 -25667973, 25669791, 25670786, 25671354, 25672640, 25674386, 25680221 -25685152, 25686739, 25687460, 25691904, 25694206, 25695903, 25696520 -25699321, 25700654, 25709368, 25710420, 25715167, 25717371, 25722055 -25722608, 25722720, 25723097, 25723158, 25728085, 25729507, 25730014 -25734963, 25736747, 25739065, 25740844, 25741955, 25743479, 25747569 -25749273, 25752755, 25754606, 25756945, 25757697, 25757748, 25760195 -25762221, 25764020, 25766822, 25768681, 25772669, 25774077, 25775213 -25775444, 25780343, 25783447, 25784002, 25785331, 25785441, 25788879 -25789041, 25789277, 25789579, 25790353, 25792911, 25795865, 25797092 -25797124, 25797305, 25800464, 25802510, 25803364, 25803545, 25807997 -25809524, 25810263, 25810704, 25811105, 25811650, 25812390, 25813931 -25818707, 25822410, 25823532, 25823754, 25824372, 25825910, 25826740 -25830492, 25832935, 25834581, 25835365, 25838361, 25838755, 25852885 -25856821, 25858672, 25861398, 25865785, 25866948, 25870579, 25871177 -25871639, 25871753, 25872127, 25872389, 25873336, 25874050, 25874678 -25881255, 25882264, 25883438, 25885148, 25888073, 25888984, 25890002 -25890046, 25890056, 25890673, 25890782, 25894239, 25895224, 25897615 -25898228, 25904273, 25904490, 25905130, 25906117, 25906886, 25908728 -25911724, 25914276, 25919622, 25932524, 25932728, 25933494, 25941836 -25942868, 25943271, 25945130, 25947799, 25951571, 25953857, 25954022 -25954054, 25957038, 25963024, 25964954, 25967544, 25967985, 25970731 -25971286, 25972417, 25973152, 25975723, 25977302, 25980605, 25980770 -25981498, 25982666, 25986062, 25990907, 25995938, 25997810, 26006257 -26007010, 26019148, 26023042, 26024732, 26024784, 26025681, 26029075 -26029777, 26029780, 26032573, 26034119, 26036748, 26037215, 26038086 -26039623, 26040483, 26045732, 26051656, 26078437, 26078493, 26080410 -26083298, 26087754, 26088426, 26088836, 26089669, 26090767, 26090893 -26091640, 26091786, 26095327, 26095405, 26096382, 26108080, 26108337 -26110259, 26110632, 26111842, 26112621, 26115103, 26121990, 26124078 -26130486, 26137367, 26137416, 26138085, 26145560, 26149904, 26153372 -26153977, 26168933, 26169341, 26169345, 26170659, 26170715, 26176002 -26187943, 26189861, 26198757, 26198926, 26201113, 26203182, 26223039 -26237338, 26237431, 26237773, 26238195, 26242031, 26242677, 26243698 -26244115, 26245237, 26248143, 26249718, 26256131, 26257953, 26259265 -26261327, 26263328, 26263721, 26268756, 26269790, 26271001, 26274660 -26275023, 26275415, 26277439, 26281476, 26285062, 26285933, 26301540 -26308650, 26309047, 26317991, 26318200, 26318627, 26323308, 26324206 -26324769, 26325856, 26327418, 26327624, 26327775, 26330994, 26331743 -26333141, 26334602, 26336977, 26338953, 26351334, 26351996, 26353617 -26354844, 26356098, 26358670, 26359091, 26362155, 26362821, 26366517 -26367012, 26367460, 26371725, 26373967, 26374791, 26375052, 26375250 -26375330, 26380097, 26385189, 26386858, 26388538, 26396790, 26398675 -26399626, 26399691, 26399839, 26405036, 26406387, 26407408, 26410240 -26412540, 26418088, 26420561, 26421667, 26422277, 26423085, 26426526 -26426967, 26430323, 26430737, 26434436, 26434999, 26435073, 26436168 -26438612, 26439748, 26440142, 26440169, 26440749, 26441345, 26442308 -26444601, 26444887, 26446098, 26451793, 26452606, 26474662, 26474703 -26475419, 26476090, 26476244, 26478970, 26479173, 26482376, 26486365 -26492666, 26492866, 26493289, 26498354, 26513067, 26513709, 26521043 -26522439, 26523432, 26526726, 26526799, 26536320, 26537307, 26542135 -26542236, 26542835, 26544823, 26545688, 26546070, 26546664, 26546754 -26548363, 26556014, 26558437, 26569225, 26570134, 26575788, 26580633 -26582460, 26584641, 26588069, 26597140, 26599395, 26608137, 26608238 -26609942, 26615291, 26615690, 26617804, 26623652, 26626879, 26629381 -26633355, 26633558, 26635897, 26637273, 26637824, 26639167, 26641610 -26641852, 26650226, 26650540, 26654363, 26658759, 26659182, 26669550 -26680105, 26712331, 26714486, 26714910, 26716835, 26717528, 26724511 -26725687, 26727397, 26729494, 26729611, 26740700, 26743240, 26744595 -26745002, 26751106, 26751171, 26755171, 26758193, 26764561, 26765212 -26768025, 26775602, 26784509, 26790923, 26794786, 26797591, 26798411 -26798514, 26798516, 26802503, 26816582, 26820076, 26822314, 26822620 -26824833, 26828994, 26829845, 26830694, 26832296, 26833932, 26837569 -26837702, 26840654, 26844406, 26844870, 26849779, 26855855, 26871815 -26875822, 26883456, 26895149, 26896659, 26898563, 26907236, 26907327 -26908788, 26909100, 26909504, 26910716, 26911000, 26923777, 26939314 -26943004, 26944190, 26947373, 26958896, 26963310, 26966616, 26966916 -26967713, 26968670, 26969321, 26970175, 26970717, 26981902, 26983259 -26985002, 26986173, 26992964, 26999139, 27000158, 27000702, 27006120 -27006664, 27009164, 27013146, 27015449, 27028251, 27032785, 27033520 -27033652, 27034890, 27036163, 27037839, 27038986, 27039712, 27044169 -27044297, 27045634, 27052607, 27056711, 27058530, 27060167, 27060859 -27061736, 27072923, 27073314, 27079140, 27079651, 27084613, 27087426 -27090765, 27092508, 27093423, 27097854, 27100800, 27101105, 27105900 -27106179, 27110878, 27115422, 27117822, 27119621, 27119861, 27122162 -27124624, 27125872, 27133662, 27134734, 27135647, 27135993, 27138325 -27142120, 27142373, 27142529, 27144928, 27151826, 27153641, 27160922 -27161071, 27162390, 27162405, 27163928, 27165231, 27169796, 27170305 -27181537, 27181897, 27185188, 27195935, 27199245, 27200959, 27202015 -27203055, 27207110, 27207634, 27208795, 27213224, 27216046, 27217412 -27223075, 27229389, 27231051, 27234962, 27236722, 27242226, 27244337 -27244999, 27248917, 27249531, 27250547, 27251690, 27254335, 27255377 -27256000, 27258578, 27259307, 27262945, 27264464, 27266245, 27274456 -27274536, 27275533, 27276231, 27283960, 27284499, 27285244, 27288638 -27292213, 27293599, 27302711, 27302730, 27303287, 27303938, 27304410 -27304906, 27305039, 27308088, 27314206, 27314390, 27314697, 27320576 -27321179, 27329612, 27333106, 27334316, 27338912, 27338946, 27339115 -27345231, 27346709, 27348081, 27349393, 27350267, 27351628, 27359178 -27364854, 27365014, 27367194, 27369515, 27370965, 27375542, 27381498 -27383281, 27386467, 27392968, 27393570, 27394703, 27395416, 27396624 -27396672, 27396813, 27397048, 27400416, 27400598, 27404573, 27404668 -27405645, 27416997, 27423251, 27424405, 27426363, 27432062, 27432826 -27433385, 27433870, 27434193, 27439835, 27441326, 27442041, 27445727 -27452046, 27457891, 27459593, 27459948, 27461740, 27466597, 27468303 -27486805, 27487919, 27489107, 27493674, 27494663, 27501373, 27501413 -27502420, 27504770, 27505229, 27508985, 27510959, 27525909, 27529661 -27533780, 27533819, 27534509, 27539876, 27540613, 27544973, 27548131 -27554074, 27555481, 27558861, 27560602, 27562488, 27565906, 27567477 -27576342, 27576354, 27587905, 27588271, 27589260, 27593501, 27595973 -27601118, 27601441, 27607563, 27611612, 27613080, 27613530, 27613554 -27615649, 27617978, 27620808, 27623159, 27629756, 27629928, 27632114 -27634676, 27634991, 27642235, 27645231, 27657712, 27658186, 27666312 -27671633, 27680669, 27686599, 27687880, 27688036, 27688099, 27688692 -27691920, 27691939, 27693416, 27693713, 27695063, 27698953, 27700466 -27704237, 27709046, 27710072, 27717210, 27719000, 27726780, 27729678 -27739006, 27740424, 27745728, 27748954, 27751755, 27757567, 27757888 -27758544, 27758653, 27758972, 27759077, 27769361, 27779886, 27793533 -27799032, 27801337, 27818389, 27819881, 27824540, 27824543, 27825241 -27828794, 27828892, 27829295, 27833672, 27834551, 27834569, 27835925 -27837219, 27839353, 27839616, 27846298, 27846499, 27847259, 27850112 -27855490, 27861226, 27873412, 27882176, 27886087, 27897759, 27898015 -27902561, 27908396, 27909478, 27927431, 27929287, 27929509, 27931299 -27935493, 27940876, 27945870, 27951817, 27952586, 27959048, 27959594 -27964513, 27966472, 27967484, 27983174, 27986817, 27994325, 27995215 -27995248, 27997875, 27998003, 27999073, 27999638, 28000269, 28007516 -28019592, 28022101, 28023081, 28023399, 28023482, 28024793, 28025414 -28026866, 28033429, 28040776, 28043157, 28045903, 28066655, 28067846 -28071549, 28072383, 28072567, 28073470, 28074713, 28079127, 28090453 -28092783, 28098040, 28098160, 28099662, 28104176, 28108003, 28111583 -28120036, 28120951, 28124631, 28125601, 28125947, 28129791, 28140658 -28157786, 28164480, 28165439, 28171079, 28174827, 28180464, 28181021 -28184554, 28188330, 28190796, 28194173, 28199085, 28201419, 28204262 -28209985, 28215510, 28218832, 28220398, 28223871, 28226179, 28229360 -28236305, 28238264, 28242712, 28250929, 28256164, 28271119, 28276054 -28279837, 28281094, 28282606, 28287484, 28290434, 28294563, 28302049 -28305001, 28305362, 28305607, 28309406, 28319114, 28320399, 28330714 -28330971, 28350595, 28354603, 28357401, 28361221, 28365111, 28369092 -28371123, 28373960, 28375383, 28378446, 28384353, 28386259, 28388910 -28389153, 28390273, 28391210, 28394726, 28396445, 28397317, 28401116 -28402823, 28420042, 28420457, 28423598, 28432129, 28434028, 28435902 -28437315, 28439086, 28454215, 28454242, 28468312, 28468493, 28481149 -28483184, 28489150, 28501075, 28502098, 28502343, 28503038, 28507324 -28508053, 28508557, 28512336, 28521330, 28522441, 28528349, 28530171 -28535127, 28535272, 28537715, 28538439, 28542455, 28545134, 28546290 -28547068, 28547478, 28564479, 28566241, 28571483, 28572407, 28572834 -28578164, 28578945, 28585411, 28587723, 28589509, 28600233, 28602253 -28606598, 28608211, 28612674, 28614372, 28617631, 28617959, 28621470 -28622202, 28627255, 28636676, 28639299, 28642899, 28678804, 28690694 -28691965, 28692103, 28692275, 28697526, 28697806, 28703812, 28708023 -28709063, 28710469, 28710734, 28714988, 28715655, 28728272, 28730044 -28734355, 28740708, 28742555, 28749289, 28749724, 28758090, 28758722 -28774416, 28776431, 28777174, 28791725, 28797711, 28803345, 28808314 -28817449, 28819640, 28820669, 28821847, 28827682, 28830691, 28831971 -28835937, 28836716, 28838066, 28844866, 28847136, 28849751, 28852325 -28852691, 28855922, 28856060, 28856172, 28863263, 28863487, 28867992 -28887305, 28889730, 28891984, 28905390, 28910498, 28915870, 28927452 -28945922, 28948554, 28949888, 28951026, 28951382, 28956908, 28959493 -28960211, 28965095, 28965787, 28986231, 28986257, 28987439, 28991884 -28993295, 28993590, 29002488, 29006527, 29007321, 29007353, 29009513 -29013832, 29024054, 29026309, 29026582, 29027694, 29032276, 29039510 -29040739, 29044086, 29044954, 29048498, 29048728, 29050886, 29060216 -29061016, 29115857, 29125374, 29154725, 29158680, 29163567, 29170232 -29173817, 29179097, 29182517, 29182901, 29189889, 29198092, 29200700 -29203604, 29213320, 29213351, 29213893, 29224605, 29224710, 29237575 -29247712, 29249289, 29250230, 29250317, 29254623, 29260956, 29278684 -29296257, 29301463, 29307638, 29312889, 29337294, 29338348, 29339155 -29343086, 29343156, 29343861, 29347943, 29353821, 29372069, 29372460 -29375355, 29375984, 29376346, 29378913, 29379978, 29383695, 29388020 -29398488, 29399336, 29405462, 29409149, 29409455, 29418165, 29420254 -29426241, 29434301, 29436454, 29437712, 29450812, 29452251, 29454978 -29463047, 29464779, 29472618, 29477015, 29483626, 29483672, 29483723 -29483771, 29500257, 29500963, 29501218, 29504682, 29511611, 29524985 -29530515, 29536342, 29538631, 29542449, 29542580, 29548592, 29549071 -29559395, 29564592, 29580394, 29591343, 29608023, 29614575, 29614987 -29621961, 29625065, 29626154, 29629430, 29633753, 29637526, 29637560 -29645349, 29651520, 29656843, 29667994, 29676089, 29678163, 29685137 -29687220, 29688867, 29690625, 29703195, 29705793, 29707896, 29717901 -29719146, 29724063, 29726695, 29741319, 29766435, 29767177, 29769901 -29774362, 29782211, 29791152, 29794174, 29794462, 29796916, 29807964 -29813494, 29815341, 29817278, 29822714, 29825525, 29836659, 29841687 -29844131, 29846645, 29853485, 29865188, 29869404, 29869906, 29875459 -29876358, 29881050, 29881575, 29884958, 29893132, 29902299, 29902311 -29914449, 29930457, 29941062, 29942554, 29944035, 29944159, 29944660 -29951620, 29951759, 29961353, 29962927, 29962939, 29965888, 29991257 -29997937, 30008125, 30018017, 30018903, 30031027, 30039959, 30064268 -30068871, 30076253, 30078934, 30086166, 30088912, 30092280, 30098251 -30099302, 30114477, 30116203, 30120608, 30125995, 30131286, 30139392 -30147928, 30150731, 30160625, 30163243, 30164714, 30173113, 30177597 -30179644, 30186706, 30189023, 30193736, 30196358, 30200680, 30200758 -30215130, 30218044, 30218317, 30223712, 30225443, 30239480, 30241567 -30244787, 30246179, 30247305, 30252098, 30252156, 30253255, 30265523 -30265615, 30272329, 30281591, 30282501, 30283932, 30293345, 30305880 -30312094, 30312568, 30316897, 30320029, 30325407, 30331356, 30342878 -30345926, 30352623, 30355490, 30357897, 30364613, 30365745, 30368482 -30368668, 30372081, 30374739, 30377692, 30381207, 30384121, 30384152 -30387666, 30391272, 30397100, 30402386, 30403763, 30408515, 30413137 -30416034, 30421204, 30431274, 30441687, 30443393, 30453442, 30458593 -30460922, 30464250, 30464655, 30473634, 30474774, 30475115, 30476768 -30485255, 30496957, 30497057, 30498824, 30501574, 30503943, 30509277 -30510527, 30517516, 30522998, 30528547, 30528704, 30532811, 30533198 -30534662, 30578221, 30581448, 30582500, 30606345, 30613937, 30623138 -30624864, 30635302, 30652853, 30654409, 30662736, 30668407, 30671813 -30679595, 30679771, 30681462, 30698289, 30741263, 30749644, 30755348 -30758943, 30783551, 30803210, 30809087, 30814266, 30814285, 30815852 -30816938, 30826474, 30855101, 30856358, 30866988, 30887501, 30904672 -30905638, 30914674, 30919804, 30922870, 30937340, 30964194, 30968208 -30980615, 30985027, 30987088, 30994996, 30998759, 31001455, 31004719 -31013127, 31022858, 31028986, 31061482, 31100172, 31104809, 31106577 -31109506, 31115502, 31156383, 31172207, 31182793, 31192039, 31194264 -31200845, 31201001, 31215438, 31228670, 31254535, 31258101, 31302499 -31306248, 31306261, 31309867, 31315876, 31326608, 31331354, 31335037 -31335142, 31341859, 31343752, 31347532, 31377487, 31393600, 31408636 -31430722, 31501139, 31508450, 31525783, 31544097, 31570161, 31600023 -31637680, 31658464, 31668061, 31668872, 31711889, 31718134, 31749740 -31771858, 31786838, 31816631, 31867037, 31905033, 31986836, 31997805 -32089820, 32165759, 32186646, 32234161, 32296941 -``` - -## Version 12\.2\.0\.1\.ru\-2020\-10\.rur\-2020\-10\.r1 - -Version 12\.2\.0\.1\.ru\-2020\-10\.rur\-2020\-10\.r1 includes the following: -+ Patch 31741641: Database Oct 2020 Release Update : 12\.2\.0\.1\.201020 \(31741641\) -+ Patch 31668898: OJVM RELEASE UPDATE 12\.2\.0\.1\.201020 \(31668898\) -+ Patch 31335037: RDBMS \- DSTV35 UPDATE \- TZDATA2020A -+ Patch 31335142: DSTV35 UPDATE \- TZDATA2020A \- NEED OJVM FIX -+ Patch 29213893: DBMS\_STATS FAILING WITH ERROR ORA\-01422 WHEN GATHERING STATS FOR USER$ TABLE -+ PreUpgrade Jar: preupgrade\_12201\_cbuild\_23\_lf\.zip -+ Support for [Setting and unsetting system diagnostic events](Appendix.Oracle.CommonDBATasks.System.md#Appendix.Oracle.CommonDBATasks.SystemEvents) using procedures in the `rdsadmin.rdsadmin_util` package -+ Support for the procedure `rdsadmin_util.truncate_apply$_cdr_info` described in [Integrated REPLICAT slow due to query on sys\."\_DBA\_APPLY\_CDR\_INFO"](Appendix.OracleGoldenGate.md#Appendix.OracleGoldenGate.IR) - -### Combined patches for version 12\.2\.0\.1\.ru\-2020\-10\.rur\-2020\-10\.r1, released October 2020 - -Bugs fixed: - -``` -7391838, 8480838, 8932139, 8975044, 12763598, 13554903, 14221306 -14690846, 15931756, 16002385, 16438495, 16727454, 16942578, 17027695 -17533661, 17947871, 17958365, 18308268, 18521691, 18594510, 18774543 -18878420, 18986501, 19072655, 19211433, 19285025, 19327292, 19526548 -19614243, 19647894, 19649997, 19702201, 19721304, 20003668, 20087519 -20118035, 20120236, 20324049, 20436508, 20532077, 20549013, 20588486 -20591151, 20617383, 20620169, 20736227, 20756305, 20866970, 20917487 -20976443, 21070321, 21089435, 21095391, 21143725, 21147908, 21159907 -21178363, 21186167, 21197098, 21216226, 21320338, 21355390, 21433452 -21479706, 21517767, 21520266, 21547051, 21638600, 21744603, 21788462 -21837606, 21882528, 21935698, 21962287, 21981529, 21985256, 22007324 -22070226, 22070473, 22070853, 22072543, 22087683, 22104866, 22107360 -22174392, 22179537, 22282748, 22310426, 22347493, 22363790, 22364044 -22367053, 22379010, 22446455, 22454940, 22468255, 22495673, 22503283 -22503297, 22504793, 22522515, 22530986, 22564336, 22568728, 22581771 -22594071, 22599050, 22628825, 22645009, 22645496, 22654475, 22700845 -22726044, 22729345, 22826067, 22843979, 22845846, 22864303, 22898198 -22921674, 22939829, 22950945, 22970869, 22981722, 23018676, 23019710 -23026585, 23035249, 23055900, 23056058, 23061453, 23065002, 23066146 -23080557, 23104033, 23105538, 23109325, 23110523, 23125560, 23126545 -23127945, 23143074, 23151677, 23168363, 23169712, 23177923, 23179662 -23184263, 23197730, 23234232, 23237091, 23249829, 23271203, 23278750 -23281269, 23282973, 23300142, 23306590, 23308065, 23310101, 23312077 -23328639, 23333567, 23336559, 23342170, 23481673, 23491861, 23499004 -23499160, 23521523, 23527363, 23533647, 23548817, 23567857, 23572982 -23581777, 23588722, 23599216, 23600861, 23602213, 23614158, 23645516 -23665623, 23709062, 23715460, 23715518, 23730961, 23733981, 23735292 -23738304, 23741944, 23743596, 23746128, 23749454, 23761724, 23763462 -24006569, 24010030, 24289874, 24289895, 24294174, 24303148, 24307571 -24308349, 24326444, 24326846, 24328857, 24330708, 24332831, 24334708 -24336249, 24337882, 24341675, 24343905, 24345420, 24346821, 24348685 -24350620, 24352981, 24355111, 24357348, 24368004, 24371491, 24373528 -24373756, 24374976, 24376875, 24376878, 24383086, 24385983, 24401351 -24403922, 24409977, 24415926, 24416451, 24421668, 24423416, 24425056 -24425998, 24432875, 24435982, 24437162, 24440612, 24440648, 24443539 -24445571, 24457597, 24460392, 24461826, 24467122, 24468470, 24470606 -24471079, 24471473, 24473736, 24484749, 24485034, 24485161, 24485174 -24485619, 24486059, 24486237, 24509056, 24516314, 24530364, 24534401 -24554533, 24555417, 24556862, 24556967, 24560906, 24563422, 24570214 -24570598, 24573817, 24578718, 24578797, 24588377, 24589081, 24589590 -24591506, 24593740, 24595699, 24596874, 24600330, 24609592, 24609996 -24611527, 24616637, 24617969, 24623975, 24624166, 24642495, 24654629 -24655717, 24664211, 24668398, 24669189, 24669730, 24674197, 24674955 -24676172, 24677696, 24680959, 24687075, 24689376, 24692973, 24693010 -24693290, 24697323, 24699619, 24701840, 24710696, 24713381, 24714096 -24717183, 24717859, 24718260, 24719799, 24735430, 24737064, 24737403 -24737581, 24737954, 24739791, 24744383, 24744686, 24752618, 24757934 -24759556, 24760407, 24763196, 24764085, 24766309, 24784414, 24786669 -24791883, 24792678, 24793511, 24796092, 24797119, 24798481, 24800423 -24801152, 24802934, 24808504, 24811725, 24812047, 24817447, 24818566 -24827228, 24827654, 24831514, 24835919, 24841671, 24843188, 24844549 -24844841, 24845157, 24848746, 24848923, 24850622, 24907917, 24908063 -24908321, 24911709, 24912588, 24920582, 24921478, 24922704, 24923080 -24923215, 24923338, 24923790, 24924667, 24926999, 24929210, 24938784 -24940060, 24942749, 24953434, 24957555, 24960044, 24960809, 24965426 -24966594, 24966788, 24967993, 24968162, 24976007, 24978100, 25022574 -25027852, 25028996, 25029022, 25029423, 25031502, 25032818, 25034396 -25036006, 25036474, 25042823, 25044977, 25045228, 25050160, 25051465 -25051628, 25054064, 25057811, 25058080, 25060506, 25062592, 25063971 -25065563, 25072986, 25077278, 25078611, 25086233, 25087436, 25091141 -25092777, 25093872, 25095982, 25098160, 25099339, 25099497, 25099758 -25100063, 25100579, 25103996, 25107662, 25110233, 25114561, 25115178 -25120284, 25120668, 25120742, 25121089, 25123585, 25124363, 25129925 -25130312, 25140197, 25145163, 25145215, 25150925, 25159176, 25162645 -25164293, 25166187, 25171041, 25171084, 25173124, 25175723, 25176408 -25178032, 25178101, 25178179, 25179774, 25182817, 25184453, 25184555 -25186079, 25189723, 25191872, 25192044, 25192528, 25192729, 25195901 -25199585, 25200101, 25201454, 25202355, 25203656, 25205368, 25205954 -25206864, 25207410, 25209912, 25210268, 25210499, 25210690, 25211628 -25219450, 25223839, 25224242, 25225795, 25226665, 25227381, 25230870 -25230945, 25237577, 25240188, 25240590, 25241448, 25241625, 25244807 -25248384, 25250109, 25251648, 25257085, 25259611, 25262869, 25263960 -25265499, 25269133, 25283790, 25287072, 25293659, 25296876, 25299227 -25299807, 25300427, 25303284, 25303756, 25305405, 25307368, 25309116 -25313154, 25313411, 25316758, 25317989, 25320555, 25323525, 25328093 -25328518, 25329664, 25335249, 25335360, 25335790, 25337332, 25337640 -25348567, 25348956, 25353983, 25356118, 25357142, 25360661, 25362958 -25367588, 25367721, 25382812, 25383204, 25384462, 25386748, 25388573 -25388896, 25392535, 25393714, 25395696, 25397936, 25398306, 25404117 -25404202, 25405100, 25405687, 25405813, 25410017, 25410180, 25410802 -25410877, 25411036, 25415713, 25416731, 25417050, 25417056, 25417958 -25425005, 25425451, 25425760, 25427662, 25429959, 25430120, 25433696 -25435038, 25437699, 25440818, 25442559, 25444961, 25445168, 25451531 -25452452, 25455795, 25457409, 25459958, 25462714, 25463844, 25472112 -25472885, 25476125, 25476149, 25477657, 25478885, 25479164, 25481087 -25482971, 25486384, 25489342, 25489367, 25489607, 25492379, 25498930 -25498994, 25516250, 25524955, 25528838, 25530080, 25530814, 25535668 -25536819, 25537470, 25539063, 25540738, 25546580, 25546608, 25547901 -25551676, 25553616, 25554787, 25555252, 25557886, 25558986, 25560487 -25560538, 25561296, 25569149, 25569504, 25570929, 25573623, 25575348 -25575369, 25575628, 25576115, 25579458, 25579761, 25591394, 25594901 -25597525, 25598473, 25599425, 25600342, 25600421, 25601999, 25602488 -25603923, 25606091, 25607726, 25612095, 25614866, 25616268, 25616359 -25616417, 25616645, 25631933, 25633101, 25634317, 25634348, 25635149 -25638456, 25639019, 25643818, 25643889, 25643931, 25646373, 25647325 -25648731, 25653109, 25654459, 25654936, 25655390, 25655966, 25659655 -25660847, 25661819, 25662088, 25662101, 25662524, 25663488, 25667973 -25669791, 25670786, 25671354, 25672640, 25674386, 25680221, 25685152 -25686739, 25687460, 25691904, 25694206, 25695903, 25696520, 25699321 -25700654, 25709368, 25710420, 25715167, 25717371, 25722055, 25722608 -25722720, 25723097, 25723158, 25728085, 25729507, 25730014, 25734963 -25736747, 25739065, 25740844, 25741955, 25743479, 25747569, 25749273 -25752755, 25754606, 25756945, 25757697, 25757748, 25760195, 25762221 -25764020, 25766822, 25768681, 25772669, 25774077, 25775213, 25775444 -25780343, 25783447, 25784002, 25785331, 25785441, 25788879, 25789041 -25789277, 25789579, 25790353, 25792911, 25795865, 25797092, 25797124 -25797305, 25800464, 25802510, 25803364, 25803545, 25807997, 25809524 -25810263, 25810704, 25811105, 25811650, 25812390, 25813931, 25818707 -25822410, 25823532, 25823754, 25824372, 25825910, 25826740, 25830492 -25832935, 25834581, 25835365, 25838361, 25838755, 25852885, 25856821 -25858672, 25861398, 25865785, 25866948, 25870579, 25871177, 25871639 -25871753, 25872127, 25872389, 25873336, 25874050, 25874678, 25881255 -25882264, 25883438, 25885148, 25888073, 25888984, 25890002, 25890046 -25890056, 25890673, 25890782, 25894239, 25895224, 25897615, 25898228 -25904273, 25904490, 25905130, 25906117, 25906886, 25908728, 25911724 -25914276, 25919622, 25932524, 25932728, 25933494, 25941836, 25942868 -25943271, 25945130, 25947799, 25951571, 25953857, 25954022, 25954054 -25957038, 25963024, 25964954, 25967544, 25967985, 25970731, 25971286 -25972417, 25973152, 25975723, 25977302, 25980605, 25980770, 25981498 -25982666, 25986062, 25990907, 25995938, 25997810, 26006257, 26007010 -26019148, 26023042, 26024732, 26024784, 26025681, 26029075, 26029777 -26029780, 26032573, 26034119, 26036748, 26037215, 26038086, 26039623 -26040483, 26045732, 26051656, 26078437, 26078493, 26080410, 26083298 -26087754, 26088426, 26088836, 26089669, 26090767, 26090893, 26091640 -26091786, 26095327, 26095405, 26096382, 26108080, 26108337, 26110259 -26110632, 26111842, 26112621, 26115103, 26121990, 26124078, 26130486 -26137367, 26137416, 26138085, 26145560, 26149904, 26153372, 26153977 -26168933, 26169341, 26169345, 26170659, 26170715, 26176002, 26187943 -26189861, 26198757, 26198926, 26201113, 26203182, 26223039, 26237338 -26237431, 26237773, 26238195, 26242031, 26242677, 26243698, 26244115 -26245237, 26248143, 26249718, 26256131, 26257953, 26259265, 26261327 -26263328, 26263721, 26268756, 26269790, 26271001, 26274660, 26275023 -26275415, 26277439, 26281476, 26285062, 26285933, 26301540, 26308650 -26309047, 26317991, 26318200, 26318627, 26323308, 26324206, 26324769 -26325856, 26327418, 26327624, 26327775, 26330994, 26331743, 26333141 -26334602, 26336977, 26338953, 26351334, 26351996, 26353617, 26354844 -26356098, 26358670, 26359091, 26362155, 26362821, 26366517, 26367012 -26367460, 26371725, 26373967, 26374791, 26375052, 26375250, 26375330 -26380097, 26385189, 26386858, 26388538, 26396790, 26398675, 26399626 -26399691, 26399839, 26405036, 26406387, 26407408, 26410240, 26412540 -26418088, 26420561, 26421667, 26422277, 26423085, 26426526, 26426967 -26430323, 26430737, 26434436, 26434999, 26435073, 26436168, 26438612 -26439748, 26440142, 26440169, 26440749, 26441345, 26442308, 26444601 -26444887, 26446098, 26452606, 26474662, 26474703, 26475419, 26476090 -26476244, 26478970, 26479173, 26482376, 26486365, 26492666, 26492866 -26493289, 26498354, 26513067, 26513709, 26521043, 26522439, 26523432 -26526726, 26526799, 26536320, 26537307, 26542135, 26542236, 26542835 -26544823, 26545688, 26546070, 26546664, 26546754, 26548363, 26556014 -26558437, 26569225, 26570134, 26575788, 26580633, 26582460, 26584641 -26588069, 26597140, 26599395, 26608137, 26608238, 26609942, 26615291 -26615690, 26617804, 26623652, 26626879, 26629381, 26633355, 26633558 -26635897, 26637273, 26637824, 26639167, 26641610, 26641852, 26650226 -26650540, 26654363, 26658759, 26659182, 26669550, 26680105, 26712331 -26714486, 26714910, 26716835, 26717528, 26724511, 26725687, 26727397 -26729494, 26729611, 26740700, 26743240, 26744595, 26745002, 26751106 -26751171, 26755171, 26758193, 26764561, 26765212, 26768025, 26775602 -26784509, 26790923, 26794786, 26797591, 26798411, 26798514, 26798516 -26802503, 26816582, 26820076, 26822314, 26822620, 26824833, 26828994 -26829845, 26830694, 26832296, 26833932, 26837569, 26837702, 26840654 -26844406, 26844870, 26849779, 26855855, 26871815, 26875822, 26883456 -26895149, 26896659, 26898563, 26907236, 26907327, 26908788, 26909100 -26909504, 26910716, 26911000, 26923777, 26939314, 26943004, 26944190 -26947373, 26958896, 26963310, 26966616, 26966916, 26967713, 26968670 -26969321, 26970175, 26970717, 26981902, 26983259, 26985002, 26986173 -26992964, 26999139, 27000158, 27000702, 27006120, 27006664, 27009164 -27013146, 27015449, 27028251, 27032785, 27033520, 27033652, 27034890 -27036163, 27037839, 27038986, 27039712, 27044169, 27044297, 27045634 -27052607, 27056711, 27058530, 27060167, 27060859, 27061736, 27072923 -27073314, 27079140, 27079651, 27084613, 27087426, 27090765, 27092508 -27093423, 27097854, 27100800, 27101105, 27105900, 27106179, 27110878 -27115422, 27117822, 27119621, 27119861, 27122162, 27124624, 27125872 -27133662, 27134734, 27135647, 27135993, 27138325, 27142120, 27142373 -27142529, 27144928, 27151826, 27153641, 27160922, 27161071, 27162390 -27162405, 27163928, 27165231, 27169796, 27170305, 27181537, 27181897 -27185188, 27195935, 27199245, 27200959, 27202015, 27203055, 27207110 -27207634, 27208795, 27213224, 27216046, 27217412, 27223075, 27229389 -27231051, 27234962, 27236722, 27242226, 27244337, 27244999, 27248917 -27249531, 27250547, 27251690, 27254335, 27255377, 27256000, 27258578 -27259307, 27262945, 27264464, 27266245, 27274456, 27274536, 27275533 -27276231, 27283960, 27284499, 27285244, 27288638, 27292213, 27293599 -27302711, 27302730, 27303287, 27303938, 27304410, 27304906, 27305039 -27308088, 27314206, 27314390, 27314697, 27320576, 27321179, 27329612 -27333106, 27334316, 27338912, 27338946, 27339115, 27345231, 27346709 -27348081, 27349393, 27350267, 27351628, 27359178, 27364854, 27365014 -27367194, 27369515, 27370965, 27375542, 27381498, 27383281, 27386467 -27392968, 27393570, 27394703, 27395416, 27396624, 27396672, 27396813 -27397048, 27400416, 27400598, 27404573, 27404668, 27405645, 27416997 -27423251, 27424405, 27426363, 27432062, 27432826, 27433385, 27433870 -27434193, 27439835, 27441326, 27442041, 27445727, 27452046, 27457891 -27459593, 27459948, 27461740, 27466597, 27468303, 27486805, 27487919 -27489107, 27493674, 27494663, 27501373, 27501413, 27502420, 27504770 -27505229, 27508985, 27510959, 27525909, 27529661, 27533780, 27533819 -27534509, 27539876, 27540613, 27544973, 27548131, 27554074, 27555481 -27558861, 27560602, 27562488, 27565906, 27567477, 27576342, 27576354 -27587905, 27588271, 27589260, 27593501, 27595973, 27601118, 27601441 -27607563, 27611612, 27613080, 27613530, 27613554, 27615649, 27617978 -27620808, 27623159, 27629756, 27629928, 27632114, 27634676, 27634991 -27642235, 27645231, 27657712, 27658186, 27666312, 27671633, 27680669 -27686599, 27687880, 27688036, 27688099, 27688692, 27691920, 27691939 -27693416, 27693713, 27695063, 27698953, 27700466, 27704237, 27709046 -27710072, 27717210, 27719000, 27726780, 27729678, 27739006, 27740424 -27745728, 27748954, 27751755, 27757567, 27757888, 27758544, 27758653 -27758972, 27759077, 27769361, 27779886, 27793533, 27799032, 27801337 -27818389, 27819881, 27824540, 27824543, 27825241, 27828794, 27828892 -27829295, 27833672, 27834551, 27834569, 27835925, 27837219, 27839353 -27839616, 27846298, 27846499, 27847259, 27850112, 27855490, 27861226 -27873412, 27882176, 27886087, 27897759, 27898015, 27902561, 27908396 -27909478, 27927431, 27929287, 27929509, 27931299, 27935493, 27940876 -27945870, 27951817, 27952586, 27959048, 27959594, 27964513, 27966472 -27967484, 27983174, 27986817, 27994325, 27995215, 27995248, 27997875 -27998003, 27999073, 27999638, 28000269, 28019592, 28022101, 28023081 -28023399, 28023482, 28024793, 28025414, 28026866, 28033429, 28040776 -28043157, 28045903, 28066655, 28067846, 28071549, 28072383, 28072567 -28073470, 28074713, 28079127, 28090453, 28092783, 28098040, 28098160 -28099662, 28104176, 28108003, 28111583, 28120036, 28120951, 28124631 -28125601, 28125947, 28129791, 28140658, 28157786, 28164480, 28165439 -28171079, 28174827, 28180464, 28181021, 28184554, 28188330, 28190796 -28194173, 28199085, 28201419, 28204262, 28209985, 28215510, 28218832 -28220398, 28223871, 28226179, 28229360, 28236305, 28238264, 28242712 -28250929, 28256164, 28271119, 28276054, 28279837, 28281094, 28282606 -28287484, 28290434, 28294563, 28302049, 28305001, 28305362, 28305607 -28309406, 28319114, 28320399, 28330714, 28330971, 28350595, 28354603 -28357401, 28361221, 28365111, 28369092, 28371123, 28373960, 28375383 -28378446, 28384353, 28386259, 28388910, 28389153, 28390273, 28391210 -28394726, 28396445, 28397317, 28401116, 28402823, 28420042, 28420457 -28423598, 28432129, 28434028, 28435902, 28437315, 28439086, 28454215 -28454242, 28468312, 28468493, 28481149, 28483184, 28489150, 28501075 -28502098, 28502343, 28503038, 28507324, 28508053, 28508557, 28512336 -28521330, 28522441, 28528349, 28530171, 28535127, 28535272, 28537715 -28538439, 28542455, 28545134, 28546290, 28547068, 28547478, 28564479 -28566241, 28571483, 28572407, 28572834, 28578164, 28578945, 28585411 -28587723, 28589509, 28600233, 28602253, 28606598, 28608211, 28612674 -28614372, 28617631, 28617959, 28621470, 28622202, 28627255, 28636676 -28639299, 28642899, 28678804, 28690694, 28691965, 28692103, 28692275 -28697526, 28697806, 28703812, 28708023, 28709063, 28710469, 28710734 -28714988, 28715655, 28728272, 28730044, 28734355, 28740708, 28742555 -28749289, 28749724, 28758090, 28758722, 28774416, 28776431, 28777174 -28791725, 28797711, 28803345, 28808314, 28817449, 28819640, 28820669 -28821847, 28827682, 28830691, 28831971, 28835937, 28836716, 28838066 -28844866, 28847136, 28849751, 28852325, 28852691, 28855922, 28856060 -28856172, 28863263, 28863487, 28867992, 28887305, 28889730, 28891984 -28905390, 28910498, 28915870, 28927452, 28945922, 28948554, 28949888 -28951026, 28951382, 28956908, 28959493, 28960211, 28965095, 28965787 -28986231, 28986257, 28987439, 28991884, 28993295, 28993590, 29002488 -29006527, 29007321, 29007353, 29009513, 29013832, 29024054, 29026309 -29026582, 29027694, 29032276, 29039510, 29040739, 29044086, 29044954 -29048498, 29048728, 29050886, 29060216, 29061016, 29115857, 29125374 -29154725, 29158680, 29163567, 29170232, 29173817, 29179097, 29182517 -29182901, 29189889, 29198092, 29200700, 29203604, 29213320, 29213351 -29213893, 29224605, 29224710, 29237575, 29247712, 29249289, 29250230 -29250317, 29254623, 29260956, 29278684, 29296257, 29301463, 29307638 -29312889, 29337294, 29338348, 29339155, 29343086, 29343156, 29343861 -29347943, 29353821, 29372069, 29372460, 29375355, 29375984, 29376346 -29378913, 29379978, 29383695, 29388020, 29398488, 29399336, 29405462 -29409149, 29409455, 29418165, 29420254, 29426241, 29434301, 29436454 -29437712, 29450812, 29452251, 29454978, 29463047, 29464779, 29472618 -29477015, 29483626, 29483672, 29483723, 29483771, 29500257, 29500963 -29501218, 29504682, 29511611, 29524985, 29530515, 29536342, 29538631 -29542449, 29542580, 29548592, 29549071, 29559395, 29564592, 29580394 -29591343, 29608023, 29614575, 29614987, 29621961, 29625065, 29626154 -29629430, 29633753, 29637526, 29637560, 29645349, 29651520, 29656843 -29667994, 29676089, 29678163, 29685137, 29687220, 29688867, 29690625 -29703195, 29705793, 29707896, 29717901, 29719146, 29724063, 29726695 -29741319, 29766435, 29767177, 29769901, 29774362, 29782211, 29791152 -29794174, 29794462, 29807964, 29813494, 29815341, 29817278, 29822714 -29825525, 29836659, 29841687, 29844131, 29846645, 29853485, 29865188 -29869404, 29869906, 29875459, 29876358, 29881050, 29881575, 29884958 -29893132, 29902299, 29902311, 29914449, 29930457, 29941062, 29942554 -29944035, 29944159, 29944660, 29951620, 29951759, 29961353, 29962927 -29962939, 29965888, 29991257, 29997937, 30008125, 30018017, 30018903 -30031027, 30039959, 30064268, 30068871, 30076253, 30078934, 30086166 -30088912, 30092280, 30098251, 30099302, 30114477, 30116203, 30120608 -30125995, 30131286, 30139392, 30147928, 30150731, 30160625, 30163243 -30164714, 30173113, 30177597, 30179644, 30186706, 30189023, 30193736 -30196358, 30200680, 30200758, 30215130, 30218044, 30218317, 30223712 -30225443, 30239480, 30241567, 30244787, 30246179, 30247305, 30252098 -30252156, 30253255, 30265523, 30265615, 30272329, 30281591, 30282501 -30283932, 30293345, 30305880, 30312094, 30312568, 30316897, 30320029 -30325407, 30331356, 30342878, 30352623, 30355490, 30357897, 30364613 -30365745, 30368482, 30368668, 30372081, 30374739, 30381207, 30384121 -30384152, 30387666, 30391272, 30397100, 30402386, 30403763, 30408515 -30413137, 30416034, 30421204, 30431274, 30441687, 30443393, 30453442 -30458593, 30460922, 30464250, 30464655, 30473634, 30474774, 30475115 -30476768, 30485255, 30496957, 30497057, 30498824, 30501574, 30503943 -30509277, 30510527, 30517516, 30522998, 30528547, 30528704, 30532811 -30533198, 30534662, 30578221, 30581448, 30582500, 30606345, 30613937 -30623138, 30624864, 30635302, 30652853, 30654409, 30662736, 30668407 -30671813, 30679595, 30679771, 30681462, 30698289, 30741263, 30749644 -30755348, 30758943, 30783551, 30803210, 30814266, 30814285, 30815852 -30816938, 30855101, 30856358, 30866988, 30887501, 30904672, 30905638 -30914674, 30919804, 30922870, 30937340, 30964194, 30968208, 30980615 -30985027, 30987088, 30994996, 30998759, 31001455, 31004719, 31013127 -31022858, 31028986, 31061482, 31100172, 31104809, 31106577, 31109506 -31115502, 31156383, 31172207, 31182793, 31192039, 31194264, 31200845 -31201001, 31215438, 31228670, 31254535, 31258101, 31302499, 31306248 -31306261, 31309867, 31315876, 31326608, 31331354, 31335037, 31335142 -31341859, 31343752, 31347532, 31393600, 31430722, 31508450, 31544097 -31570161, 31600023, 31658464, 31668061, 31668872, 31718134, 31771858 -31867037, 31905033 -``` - -## Version 12\.2\.0\.1\.ru\-2020\-07\.rur\-2020\-07\.r1 - -Version 12\.2\.0\.1\.ru\-2020\-07\.rur\-2020\-07\.r1 includes the following: -+ Patch 31312468: Database Jul 2020 Release Update 12\.2\.0\.1\.200714 -+ Patch 31219919: OJVM RELEASE UPDATE: 12\.2\.0\.1\.200714 -+ Patch 31335037: DSTV35 for RDBMS \(TZDATA2020A\) -+ Patch 31335142: DSTV35 for OJVM \(TZDATA2020A\) -+ Patch 29213893: DBMS\_STATS FAILING WITH ERROR ORA\-01422 WHEN GATHERING STATS FOR USER$ TABLE -+ PreUpgrade Jar: preupgrade\_12201\_cbuild\_23\_lf\.zip - -### Combined patches for version 12\.2\.0\.1\.ru\-2020\-07\.rur\-2020\-07\.r1, released July 2020 - -Bugs fixed: - -``` -7391838, 8480838, 8932139, 8975044, 12763598, 13554903, 14221306 -14690846, 15931756, 16002385, 16438495, 16727454, 16942578, 17027695 -17533661, 17947871, 18308268, 18521691, 18594510, 18774543, 18878420 -18986501, 19072655, 19211433, 19285025, 19327292, 19526548, 19614243 -19647894, 19649997, 19702201, 19721304, 20003668, 20087519, 20118035 -20120236, 20324049, 20436508, 20532077, 20549013, 20588486, 20591151 -20617383, 20620169, 20736227, 20756305, 20866970, 20976443, 21070321 -21089435, 21095391, 21143725, 21147908, 21159907, 21178363, 21186167 -21197098, 21216226, 21320338, 21433452, 21479706, 21517767, 21520266 -21547051, 21638600, 21744603, 21788462, 21837606, 21882528, 21935698 -21981529, 21985256, 22007324, 22070226, 22070473, 22070853, 22072543 -22087683, 22104866, 22107360, 22174392, 22179537, 22282748, 22310426 -22347493, 22363790, 22364044, 22367053, 22379010, 22446455, 22454940 -22495673, 22503283, 22503297, 22504793, 22522515, 22530986, 22564336 -22568728, 22581771, 22594071, 22599050, 22628825, 22645009, 22645496 -22654475, 22700845, 22726044, 22729345, 22826067, 22843979, 22845846 -22864303, 22898198, 22921674, 22939829, 22950945, 22970869, 22981722 -23018676, 23019710, 23026585, 23035249, 23055900, 23056058, 23061453 -23065002, 23066146, 23080557, 23104033, 23105538, 23109325, 23110523 -23125560, 23126545, 23127945, 23143074, 23151677, 23168363, 23169712 -23177923, 23179662, 23184263, 23197730, 23234232, 23237091, 23249829 -23271203, 23278750, 23281269, 23300142, 23306590, 23308065, 23310101 -23312077, 23328639, 23333567, 23336559, 23342170, 23481673, 23491861 -23499004, 23499160, 23521523, 23527363, 23533647, 23548817, 23567857 -23572982, 23581777, 23588722, 23599216, 23600861, 23602213, 23614158 -23645516, 23665623, 23709062, 23715460, 23715518, 23730961, 23733981 -23735292, 23738304, 23741944, 23743596, 23746128, 23749454, 23761724 -24006569, 24010030, 24289874, 24289895, 24294174, 24303148, 24307571 -24308349, 24326444, 24326846, 24328857, 24330708, 24332831, 24334708 -24336249, 24337882, 24341675, 24343905, 24345420, 24346821, 24348685 -24350620, 24352981, 24355111, 24357348, 24368004, 24371491, 24373528 -24373756, 24374976, 24376875, 24376878, 24383086, 24385983, 24401351 -24403922, 24409977, 24415926, 24416451, 24421668, 24423416, 24425056 -24425998, 24435982, 24437162, 24440648, 24443539, 24457597, 24460392 -24461826, 24467122, 24468470, 24470606, 24471079, 24471473, 24473736 -24484749, 24485034, 24485161, 24485174, 24485619, 24486059, 24486237 -24509056, 24516314, 24530364, 24534401, 24554533, 24555417, 24556862 -24556967, 24560906, 24563422, 24570214, 24570598, 24573817, 24578718 -24578797, 24588377, 24589081, 24589590, 24591506, 24593740, 24595699 -24596874, 24600330, 24609592, 24609996, 24611527, 24616637, 24617969 -24623975, 24624166, 24642495, 24654629, 24655717, 24664211, 24668398 -24669189, 24669730, 24674197, 24674955, 24676172, 24677696, 24680959 -24687075, 24689376, 24692973, 24693010, 24693290, 24697323, 24699619 -24701840, 24710696, 24713381, 24714096, 24717183, 24717859, 24718260 -24719799, 24735430, 24737064, 24737403, 24737581, 24737954, 24739791 -24744383, 24744686, 24752618, 24757934, 24759556, 24760407, 24764085 -24766309, 24784414, 24786669, 24791883, 24792678, 24793511, 24796092 -24797119, 24798481, 24800423, 24801152, 24802934, 24808504, 24811725 -24812047, 24818566, 24827228, 24827654, 24831514, 24835919, 24841671 -24843188, 24844549, 24844841, 24845157, 24848746, 24848923, 24850622 -24907917, 24908063, 24908321, 24911709, 24912588, 24920582, 24921478 -24922704, 24923080, 24923215, 24923338, 24923790, 24924667, 24926999 -24929210, 24938784, 24940060, 24942749, 24953434, 24957555, 24960044 -24960809, 24965426, 24966594, 24966788, 24967993, 24968162, 24976007 -24978100, 25022574, 25027852, 25028996, 25029022, 25029423, 25031502 -25032818, 25034396, 25036006, 25036474, 25042823, 25044977, 25045228 -25050160, 25051465, 25051628, 25054064, 25057811, 25058080, 25060506 -25062592, 25063971, 25065563, 25072986, 25077278, 25078611, 25086233 -25087436, 25091141, 25092777, 25093872, 25095982, 25098160, 25099339 -25099497, 25099758, 25100063, 25100579, 25103996, 25107662, 25110233 -25114561, 25120284, 25120668, 25120742, 25121089, 25123585, 25124363 -25129925, 25130312, 25140197, 25145163, 25145215, 25150925, 25159176 -25162645, 25164293, 25166187, 25171041, 25171084, 25173124, 25175723 -25176408, 25178032, 25178101, 25178179, 25179774, 25182817, 25184453 -25184555, 25186079, 25189723, 25191872, 25192044, 25192528, 25192729 -25195901, 25199585, 25200101, 25201454, 25202355, 25203656, 25205954 -25206864, 25207410, 25209912, 25210268, 25210499, 25210690, 25211628 -25219450, 25223839, 25224242, 25225795, 25226665, 25227381, 25230870 -25230945, 25237577, 25240188, 25240590, 25241448, 25241625, 25244807 -25248384, 25250109, 25251648, 25257085, 25259611, 25262869, 25263960 -25265499, 25269133, 25283790, 25287072, 25293659, 25296876, 25299227 -25299807, 25300427, 25303284, 25303756, 25305405, 25307368, 25309116 -25313154, 25313411, 25316758, 25317989, 25320555, 25323525, 25328093 -25328518, 25329664, 25335249, 25335360, 25335790, 25337332, 25337640 -25348956, 25353983, 25356118, 25357142, 25360661, 25362958, 25367588 -25367721, 25382812, 25383204, 25384462, 25386748, 25388573, 25388896 -25392535, 25393714, 25395696, 25397936, 25398306, 25404202, 25405100 -25405687, 25405813, 25410017, 25410180, 25410802, 25410877, 25411036 -25415713, 25416731, 25417050, 25417056, 25417958, 25425005, 25425451 -25425760, 25427662, 25429959, 25430120, 25433696, 25435038, 25437699 -25440818, 25442559, 25444961, 25445168, 25451531, 25452452, 25455795 -25457409, 25459958, 25462714, 25463844, 25472112, 25472885, 25476125 -25476149, 25477657, 25478885, 25479164, 25481087, 25482971, 25486384 -25489342, 25489367, 25489607, 25492379, 25498930, 25498994, 25516250 -25524955, 25528838, 25530080, 25530814, 25535668, 25536819, 25537470 -25539063, 25540738, 25546580, 25546608, 25547901, 25551676, 25553616 -25554787, 25555252, 25557886, 25558986, 25560487, 25560538, 25561296 -25569149, 25570929, 25573623, 25575348, 25575369, 25575628, 25576115 -25579458, 25579761, 25591394, 25594901, 25597525, 25598473, 25599425 -25600342, 25600421, 25601999, 25602488, 25603923, 25606091, 25607726 -25612095, 25614866, 25616268, 25616359, 25616417, 25616645, 25631933 -25633101, 25634317, 25634348, 25635149, 25638456, 25639019, 25643818 -25643889, 25643931, 25646373, 25647325, 25648731, 25653109, 25654459 -25654936, 25655390, 25655966, 25659655, 25660847, 25661819, 25662088 -25662101, 25662524, 25663488, 25667973, 25669791, 25670786, 25671354 -25672640, 25674386, 25680221, 25685152, 25686739, 25687460, 25691904 -25694206, 25695903, 25696520, 25699321, 25700654, 25709368, 25710420 -25715167, 25717371, 25722055, 25722608, 25722720, 25723097, 25723158 -25728085, 25729507, 25730014, 25734963, 25736747, 25739065, 25740844 -25741955, 25743479, 25747569, 25749273, 25752755, 25754606, 25756945 -25757697, 25757748, 25760195, 25762221, 25764020, 25766822, 25768681 -25772669, 25774077, 25775213, 25775444, 25780343, 25783447, 25784002 -25785331, 25785441, 25788879, 25789041, 25789277, 25789579, 25790353 -25792911, 25795865, 25797092, 25797124, 25797305, 25800464, 25802510 -25803364, 25803545, 25807997, 25809524, 25810263, 25810704, 25811105 -25811650, 25812390, 25813931, 25818707, 25822410, 25823532, 25823754 -25824372, 25825910, 25826740, 25830492, 25832935, 25834581, 25835365 -25838361, 25838755, 25852885, 25856821, 25858672, 25861398, 25865785 -25866948, 25870579, 25871177, 25871639, 25871753, 25872127, 25872389 -25873336, 25874050, 25874678, 25881255, 25882264, 25883438, 25885148 -25888073, 25888984, 25890002, 25890046, 25890056, 25890673, 25890782 -25894239, 25895224, 25897615, 25898228, 25904273, 25904490, 25905130 -25906117, 25906886, 25908728, 25911724, 25914276, 25919622, 25932524 -25932728, 25933494, 25941836, 25942868, 25943271, 25945130, 25947799 -25951571, 25953857, 25954022, 25954054, 25957038, 25963024, 25964954 -25967544, 25967985, 25970731, 25971286, 25972417, 25973152, 25975723 -25977302, 25980605, 25980770, 25981498, 25982666, 25986062, 25990907 -25995938, 25997810, 26006257, 26007010, 26019148, 26023042, 26024732 -26024784, 26025681, 26029075, 26029777, 26029780, 26032573, 26034119 -26036748, 26037215, 26038086, 26039623, 26040483, 26045732, 26051656 -26078437, 26078493, 26080410, 26083298, 26087754, 26088426, 26088836 -26089669, 26090767, 26090893, 26091640, 26091786, 26095327, 26095405 -26096382, 26108080, 26108337, 26110259, 26110632, 26111842, 26112621 -26115103, 26121990, 26124078, 26130486, 26137367, 26137416, 26138085 -26145560, 26149904, 26153372, 26153977, 26168933, 26169341, 26169345 -26170659, 26170715, 26176002, 26187943, 26189861, 26198757, 26198926 -26201113, 26203182, 26223039, 26237338, 26237431, 26237773, 26238195 -26242031, 26242677, 26243698, 26244115, 26245237, 26248143, 26249718 -26256131, 26257953, 26259265, 26261327, 26263328, 26263721, 26268756 -26269790, 26271001, 26274660, 26275023, 26275415, 26277439, 26281476 -26285062, 26285933, 26308650, 26309047, 26317991, 26318627, 26323308 -26324206, 26324769, 26325856, 26327418, 26327624, 26327775, 26330994 -26331743, 26333141, 26334602, 26336977, 26338953, 26351334, 26351996 -26353617, 26354844, 26356098, 26358670, 26359091, 26362155, 26362821 -26366517, 26367012, 26367460, 26371725, 26373967, 26374791, 26375052 -26375250, 26375330, 26380097, 26385189, 26386858, 26388538, 26396790 -26398675, 26399626, 26399691, 26405036, 26406387, 26407408, 26410240 -26412540, 26418088, 26420561, 26421667, 26422277, 26423085, 26426526 -26426967, 26430323, 26430737, 26434436, 26434999, 26435073, 26436168 -26438612, 26439748, 26440142, 26440169, 26440749, 26441345, 26442308 -26444601, 26444887, 26446098, 26452606, 26474662, 26474703, 26475419 -26476090, 26476244, 26478970, 26479173, 26482376, 26486365, 26492866 -26493289, 26498354, 26513067, 26513709, 26521043, 26522439, 26523432 -26526726, 26526799, 26536320, 26537307, 26542135, 26542236, 26542835 -26544823, 26545688, 26546070, 26546664, 26546754, 26548363, 26556014 -26558437, 26569225, 26570134, 26575788, 26580633, 26582460, 26584641 -26588069, 26597140, 26599395, 26608137, 26608238, 26609942, 26615291 -26615690, 26617804, 26623652, 26626879, 26629381, 26633355, 26633558 -26635897, 26637273, 26637824, 26639167, 26641610, 26641852, 26650226 -26650540, 26654363, 26658759, 26659182, 26669550, 26680105, 26712331 -26714486, 26714910, 26717528, 26724511, 26725687, 26727397, 26729494 -26729611, 26740700, 26743240, 26744595, 26745002, 26751106, 26751171 -26755171, 26758193, 26764561, 26765212, 26768025, 26775602, 26784509 -26790923, 26794786, 26797591, 26798411, 26798514, 26798516, 26802503 -26816582, 26820076, 26822314, 26822620, 26824833, 26828994, 26829845 -26830694, 26832296, 26833932, 26837569, 26837702, 26840654, 26844406 -26844870, 26849779, 26871815, 26875822, 26883456, 26895149, 26896659 -26898563, 26907236, 26907327, 26908788, 26909100, 26909504, 26910716 -26911000, 26923777, 26939314, 26943004, 26944190, 26947373, 26958896 -26963310, 26966616, 26966916, 26967713, 26968670, 26969321, 26970175 -26970717, 26981902, 26983259, 26985002, 26986173, 26992964, 26999139 -27000158, 27000702, 27006120, 27006664, 27009164, 27013146, 27015449 -27028251, 27032785, 27033520, 27033652, 27034890, 27036163, 27037839 -27038986, 27039712, 27044169, 27044297, 27045634, 27052607, 27056711 -27058530, 27060167, 27060859, 27061736, 27072923, 27073314, 27079140 -27084613, 27087426, 27090765, 27092508, 27093423, 27097854, 27100800 -27101105, 27105900, 27106179, 27110878, 27115422, 27117822, 27119621 -27119861, 27122162, 27124624, 27125872, 27133662, 27134734, 27135647 -27135993, 27138325, 27142120, 27142373, 27142529, 27144928, 27151826 -27153641, 27160922, 27161071, 27162390, 27162405, 27163928, 27165231 -27169796, 27170305, 27181537, 27181897, 27185188, 27195935, 27199245 -27200959, 27202015, 27203055, 27207110, 27207634, 27208795, 27213224 -27216046, 27217412, 27223075, 27229389, 27231051, 27234962, 27236722 -27242226, 27244337, 27244999, 27248917, 27249531, 27250547, 27251690 -27254335, 27255377, 27256000, 27258578, 27259307, 27262945, 27264464 -27266245, 27274456, 27274536, 27275533, 27276231, 27283960, 27284499 -27285244, 27288638, 27292213, 27293599, 27302711, 27302730, 27303287 -27303938, 27304410, 27304906, 27305039, 27308088, 27314206, 27314390 -27314697, 27320576, 27321179, 27329612, 27333106, 27334316, 27338912 -27338946, 27339115, 27345231, 27346709, 27348081, 27349393, 27350267 -27351628, 27359178, 27364854, 27365014, 27367194, 27369515, 27370965 -27375542, 27381498, 27383281, 27386467, 27392968, 27393570, 27394703 -27395416, 27396624, 27396672, 27396813, 27397048, 27400416, 27400598 -27404573, 27404668, 27405645, 27416997, 27423251, 27424405, 27426363 -27432062, 27432826, 27433385, 27433870, 27434193, 27439835, 27441326 -27442041, 27445727, 27457891, 27459593, 27459948, 27461740, 27466597 -27468303, 27486805, 27487919, 27489107, 27493674, 27494663, 27501373 -27501413, 27502420, 27504770, 27505229, 27508985, 27510959, 27525909 -27529661, 27533780, 27533819, 27534509, 27539876, 27540613, 27544973 -27548131, 27554074, 27555481, 27558861, 27560602, 27562488, 27565906 -27567477, 27576342, 27576354, 27587905, 27588271, 27589260, 27593501 -27595973, 27601118, 27601441, 27607563, 27611612, 27613080, 27613530 -27613554, 27615649, 27617978, 27620808, 27623159, 27629756, 27629928 -27632114, 27634676, 27634991, 27642235, 27645231, 27657712, 27658186 -27666312, 27671633, 27680669, 27686599, 27687880, 27688036, 27688099 -27688692, 27691920, 27691939, 27693416, 27693713, 27695063, 27698953 -27700466, 27704237, 27709046, 27710072, 27719000, 27726780, 27729678 -27739006, 27740424, 27748954, 27751755, 27757567, 27757888, 27758544 -27758653, 27758972, 27759077, 27769361, 27779886, 27793533, 27799032 -27801337, 27818389, 27819881, 27824540, 27824543, 27825241, 27828794 -27828892, 27829295, 27833672, 27834551, 27834569, 27835925, 27839353 -27839616, 27846298, 27846499, 27847259, 27850112, 27855490, 27861226 -27873412, 27882176, 27886087, 27897759, 27898015, 27902561, 27908396 -27909478, 27927431, 27929287, 27929509, 27931299, 27935493, 27940876 -27945870, 27951817, 27952586, 27959048, 27959594, 27964513, 27966472 -27967484, 27983174, 27986817, 27994325, 27995215, 27995248, 27997875 -27998003, 27999073, 27999638, 28000269, 28019592, 28022101, 28023081 -28023399, 28023482, 28024793, 28025414, 28026866, 28033429, 28040776 -28043157, 28045903, 28067846, 28071549, 28072383, 28072567, 28073470 -28074713, 28079127, 28090453, 28092783, 28098040, 28098160, 28099662 -28104176, 28108003, 28111583, 28120036, 28120951, 28124631, 28125601 -28125947, 28129791, 28140658, 28157786, 28164480, 28165439, 28171079 -28174827, 28180464, 28181021, 28184554, 28188330, 28190796, 28194173 -28199085, 28201419, 28204262, 28209985, 28215510, 28218832, 28220398 -28223871, 28226179, 28229360, 28236305, 28238264, 28242712, 28250929 -28256164, 28271119, 28276054, 28279837, 28281094, 28282606, 28287484 -28290434, 28294563, 28302049, 28305001, 28305362, 28305607, 28309406 -28319114, 28320399, 28330714, 28330971, 28350595, 28354603, 28357401 -28361221, 28365111, 28369092, 28371123, 28373960, 28375383, 28378446 -28384353, 28386259, 28388910, 28390273, 28391210, 28396445, 28397317 -28401116, 28402823, 28420042, 28420457, 28423598, 28432129, 28434028 -28435902, 28437315, 28439086, 28454215, 28454242, 28468312, 28468493 -28481149, 28483184, 28489150, 28501075, 28502098, 28502343, 28503038 -28507324, 28508053, 28508557, 28512336, 28521330, 28522441, 28528349 -28530171, 28535127, 28535272, 28537715, 28538439, 28542455, 28545134 -28546290, 28547068, 28547478, 28564479, 28566241, 28571483, 28572407 -28572834, 28578164, 28578945, 28585411, 28587723, 28589509, 28600233 -28606598, 28608211, 28612674, 28614372, 28617631, 28617959, 28621470 -28622202, 28627255, 28636676, 28639299, 28642899, 28678804, 28691965 -28692103, 28692275, 28697806, 28703812, 28708023, 28709063, 28710469 -28714988, 28715655, 28728272, 28734355, 28740708, 28742555, 28749289 -28749724, 28758090, 28758722, 28774416, 28776431, 28777174, 28791725 -28797711, 28803345, 28808314, 28817449, 28819640, 28820669, 28821847 -28827682, 28830691, 28831971, 28835937, 28836716, 28838066, 28844866 -28847136, 28849751, 28852325, 28852691, 28855922, 28856060, 28856172 -28863263, 28863487, 28867992, 28887305, 28889730, 28891984, 28905390 -28910498, 28915870, 28927452, 28949888, 28951026, 28951382, 28956908 -28959493, 28960211, 28965095, 28965787, 28986231, 28986257, 28987439 -28991884, 28993295, 28993590, 29002488, 29006527, 29007321, 29007353 -29009513, 29013832, 29024054, 29026582, 29027694, 29032276, 29039510 -29040739, 29044954, 29048498, 29048728, 29050886, 29060216, 29061016 -29115857, 29125374, 29158680, 29163567, 29170232, 29173817, 29179097 -29182517, 29182901, 29189889, 29198092, 29200700, 29203604, 29213320 -29213893, 29224605, 29237575, 29247712, 29249289, 29250230, 29250317 -29254623, 29260956, 29278684, 29296257, 29301463, 29307638, 29312889 -29339155, 29343086, 29343156, 29343861, 29347943, 29353821, 29372069 -29372460, 29375355, 29375984, 29376346, 29378913, 29379978, 29383695 -29388020, 29398488, 29399336, 29405462, 29409149, 29409455, 29420254 -29426241, 29434301, 29436454, 29437712, 29450812, 29452251, 29454978 -29464779, 29483626, 29483672, 29483723, 29483771, 29500257, 29500963 -29501218, 29504682, 29511611, 29524985, 29530515, 29536342, 29538631 -29542449, 29542580, 29548592, 29549071, 29559395, 29564592, 29580394 -29591343, 29608023, 29614575, 29614987, 29621961, 29625065, 29626154 -29629430, 29633753, 29637526, 29637560, 29645349, 29651520, 29656843 -29667994, 29676089, 29678163, 29685137, 29687220, 29688867, 29690625 -29703195, 29705793, 29707896, 29717901, 29719146, 29724063, 29726695 -29766435, 29767177, 29774362, 29782211, 29791152, 29794462, 29807964 -29813494, 29815341, 29817278, 29822714, 29825525, 29836659, 29841687 -29846645, 29853485, 29865188, 29869404, 29869906, 29875459, 29876358 -29881050, 29881575, 29884958, 29893132, 29902299, 29902311, 29914449 -29930457, 29944035, 29944660, 29951620, 29951759, 29961353, 29962927 -29962939, 29965888, 29991257, 29997937, 30008125, 30018017, 30018903 -30031027, 30039959, 30064268, 30068871, 30076253, 30078934, 30086166 -30088912, 30092280, 30098251, 30099302, 30114477, 30116203, 30120608 -30125995, 30131286, 30139392, 30147928, 30150731, 30160625, 30163243 -30164714, 30173113, 30177597, 30179644, 30186706, 30189023, 30193736 -30196358, 30200680, 30200758, 30215130, 30218044, 30218317, 30223712 -30225443, 30239480, 30241567, 30244787, 30246179, 30247305, 30252098 -30252156, 30253255, 30265523, 30272329, 30281591, 30282501, 30283932 -30293345, 30305880, 30312094, 30312568, 30316897, 30325407, 30342878 -30352623, 30355490, 30357897, 30364613, 30365745, 30368482, 30372081 -30374739, 30381207, 30384121, 30384152, 30391272, 30397100, 30402386 -30403763, 30408515, 30413137, 30416034, 30431274, 30441687, 30443393 -30453442, 30458593, 30460922, 30464655, 30474774, 30475115, 30476768 -30485255, 30496957, 30497057, 30501574, 30503943, 30509277, 30510527 -30522998, 30528547, 30528704, 30533198, 30534662, 30581448, 30582500 -30613937, 30623138, 30624864, 30635302, 30652853, 30654409, 30668407 -30671813, 30681462, 30698289, 30741263, 30758943, 30803210, 30814285 -30815852, 30816938, 30855101, 30887501, 30904672, 30922870, 30964194 -30968208, 30980615, 30987088, 30998759, 31001455, 31004719, 31013127 -31022858, 31100172, 31106577, 31156383, 31172207, 31182793, 31200845 -31306261, 31335037, 31335142, 31341859, 31393600 -``` - -## Version 12\.2\.0\.1\.ru\-2020\-04\.rur\-2020\-04\.r1 - -Version 12\.2\.0\.1\.ru\-2020\-04\.rur\-2020\-04\.r1 includes the following: -+ Patch 30886680: Database Apr 2020 Release Update 12\.2\.0\.1\.200414 -+ Patch 30805580: Oracle JVM Release Update 12\.2\.0\.1\.200414 -+ Patch 29997937: DSTv34 for RDBMS \(TZDATA2019G\) -+ Patch 29997959: DSTv34 for OJVM \(TZDATA2019G\) -+ PreUpgrade Jar: preupgrade\_12201\_cbuild\_23\_lf\.zip -+ Patch 28730253: SUPPORT NEW ERA REIWA FOR JAPANESE IMPERIAL CALENDAR is included in DB PATCH 30138470 -+ Support for [Purging the recycle bin](Appendix.Oracle.CommonDBATasks.Database.md#Appendix.Oracle.CommonDBATasks.PurgeRecycleBin) -+ Support for [Generating performance reports with Automatic Workload Repository \(AWR\)](Appendix.Oracle.CommonDBATasks.Database.md#Appendix.Oracle.CommonDBATasks.AWR) using the `rdsadmin.rdsadmin_diagnostic_util` package - -### Combined patches for version 12\.2\.0\.1\.ru\-2020\-04\.rur\-2020\-04\.r1, released April 2020 - -Bugs fixed: - -``` -30533198, 30312568, 30086166, 28951026, 28435902, 8480838, 8932139 -12763598, 13554903, 14221306, 14690846, 15931756, 16002385, 16438495 -16727454, 16942578, 17027695, 17533661, 17947871, 18308268, 18521691 -18594510, 18774543, 18878420, 19072655, 19211433, 19285025, 19327292 -19526548, 19614243, 19647894, 19649997, 19702201, 19721304, 20003668 -20087519, 20118035, 20120236, 20324049, 20436508, 20532077, 20549013 -20588486, 20591151, 20617383, 20620169, 20736227, 20756305, 20866970 -20976443, 21089435, 21095391, 21143725, 21147908, 21159907, 21178363 -21186167, 21197098, 21216226, 21320338, 21433452, 21479706, 21517767 -21520266, 21547051, 21638600, 21744603, 21788462, 21837606, 21882528 -21935698, 21981529, 21985256, 22007324, 22070473, 22070853, 22072543 -22087683, 22104866, 22107360, 22174392, 22179537, 22282748, 22310426 -22347493, 22363790, 22364044, 22367053, 22379010, 22446455, 22454940 -22495673, 22503283, 22503297, 22504793, 22522515, 22530986, 22564336 -22568728, 22581771, 22594071, 22599050, 22628825, 22645009, 22645496 -22654475, 22700845, 22726044, 22729345, 22826067, 22843979, 22845846 -22864303, 22898198, 22921674, 22939829, 22950945, 22970869, 22981722 -23018676, 23019710, 23026585, 23035249, 23055900, 23061453, 23065002 -23066146, 23080557, 23104033, 23105538, 23109325, 23110523, 23125560 -23126545, 23127945, 23143074, 23151677, 23168363, 23169712, 23177923 -23179662, 23184263, 23197730, 23234232, 23237091, 23249829, 23271203 -23278750, 23300142, 23306590, 23308065, 23310101, 23312077, 23328639 -23333567, 23336559, 23342170, 23481673, 23491861, 23499004, 23499160 -23521523, 23527363, 23533647, 23548817, 23567857, 23572982, 23581777 -23588722, 23599216, 23600861, 23602213, 23645516, 23665623, 23709062 -23715460, 23715518, 23730961, 23733981, 23735292, 23738304, 23741944 -23743596, 23746128, 23749454, 23761724, 24006569, 24010030, 24289874 -24289895, 24294174, 24303148, 24307571, 24308349, 24326444, 24326846 -24328857, 24330708, 24332831, 24334708, 24336249, 24337882, 24341675 -24343905, 24345420, 24346821, 24348685, 24350620, 24352981, 24355111 -24357348, 24368004, 24371491, 24373528, 24373756, 24374976, 24376875 -24376878, 24383086, 24385983, 24401351, 24403922, 24409977, 24415926 -24416451, 24421668, 24423416, 24425056, 24425998, 24435982, 24437162 -24440648, 24443539, 24457597, 24460392, 24461826, 24467122, 24468470 -24470606, 24471079, 24471473, 24473736, 24485034, 24485161, 24485174 -24486059, 24486237, 24509056, 24516314, 24530364, 24534401, 24554533 -24555417, 24556862, 24556967, 24560906, 24563422, 24570214, 24570598 -24573817, 24578718, 24578797, 24588377, 24589081, 24589590, 24591506 -24593740, 24595699, 24600330, 24609592, 24609996, 24611527, 24616637 -24617969, 24623975, 24624166, 24642495, 24654629, 24655717, 24664211 -24668398, 24669189, 24674197, 24674955, 24676172, 24677696, 24680959 -24687075, 24689376, 24692973, 24693010, 24693290, 24697323, 24699619 -24710696, 24713381, 24714096, 24717183, 24717859, 24718260, 24719799 -24735430, 24737064, 24737403, 24737581, 24737954, 24739791, 24744383 -24744686, 24752618, 24757934, 24759556, 24760407, 24764085, 24766309 -24784414, 24786669, 24791883, 24792678, 24793511, 24796092, 24797119 -24800423, 24801152, 24802934, 24808504, 24811725, 24812047, 24818566 -24827228, 24827654, 24831514, 24835919, 24841671, 24843188, 24844549 -24844841, 24845157, 24848746, 24848923, 24850622, 24907917, 24908321 -24911709, 24912588, 24920582, 24921478, 24922704, 24923080, 24923215 -24923338, 24923790, 24924667, 24926999, 24929210, 24938784, 24940060 -24942749, 24953434, 24957555, 24960044, 24960809, 24965426, 24966594 -24966788, 24967993, 24968162, 24976007, 24978100, 25022574, 25027852 -25028996, 25029022, 25029423, 25031502, 25032818, 25034396, 25036006 -25036474, 25042823, 25044977, 25045228, 25050160, 25051465, 25051628 -25054064, 25057811, 25058080, 25060506, 25062592, 25063971, 25065563 -25072986, 25077278, 25078611, 25086233, 25087436, 25092777, 25093872 -25095982, 25098160, 25099339, 25099497, 25099758, 25100063, 25100579 -25103996, 25107662, 25110233, 25114561, 25120284, 25120668, 25120742 -25121089, 25123585, 25124363, 25129925, 25130312, 25140197, 25145163 -25145215, 25150925, 25159176, 25162645, 25164293, 25166187, 25171041 -25171084, 25175723, 25176408, 25178032, 25178101, 25178179, 25179774 -25182817, 25184453, 25184555, 25186079, 25191872, 25192044, 25192528 -25192729, 25195901, 25199585, 25201454, 25202355, 25203656, 25205954 -25206864, 25207410, 25209912, 25210268, 25210499, 25210690, 25211628 -25219450, 25223839, 25224242, 25225795, 25226665, 25227381, 25230870 -25230945, 25237577, 25240188, 25240590, 25241448, 25241625, 25244807 -25248384, 25250109, 25251648, 25257085, 25259611, 25262869, 25263960 -25265499, 25269133, 25283790, 25287072, 25293659, 25296876, 25299227 -25299807, 25300427, 25303284, 25303756, 25305405, 25307368, 25309116 -25313154, 25313411, 25316758, 25317989, 25320555, 25323525, 25328093 -25328518, 25329664, 25335249, 25335360, 25335790, 25337332, 25337640 -25348956, 25353983, 25356118, 25357142, 25360661, 25362958, 25367588 -25367721, 25382812, 25383204, 25384462, 25386748, 25388896, 25392535 -25393714, 25395696, 25397936, 25398306, 25404202, 25405100, 25405687 -25405813, 25410017, 25410180, 25410802, 25410877, 25411036, 25415713 -25416731, 25417050, 25417056, 25417958, 25425005, 25425451, 25425760 -25427662, 25429959, 25430120, 25433696, 25435038, 25437699, 25440818 -25442559, 25444961, 25445168, 25451531, 25455795, 25457409, 25459958 -25462714, 25463844, 25472112, 25472885, 25476125, 25476149, 25477657 -25478885, 25479164, 25481087, 25482971, 25486384, 25489342, 25489367 -25489607, 25492379, 25498930, 25498994, 25516250, 25524955, 25528838 -25530080, 25530814, 25535668, 25536819, 25537470, 25539063, 25540738 -25546580, 25546608, 25547901, 25551676, 25553616, 25554787, 25555252 -25557886, 25558986, 25560487, 25561296, 25569149, 25570929, 25573623 -25575348, 25575369, 25575628, 25579458, 25579761, 25591394, 25594901 -25597525, 25598473, 25599425, 25600342, 25600421, 25601999, 25602488 -25603923, 25606091, 25607726, 25612095, 25614866, 25616268, 25616359 -25616417, 25616645, 25631933, 25633101, 25634317, 25634348, 25635149 -25638456, 25639019, 25643818, 25643889, 25643931, 25646373, 25647325 -25648731, 25653109, 25654459, 25654936, 25655390, 25655966, 25659655 -25660847, 25661819, 25662088, 25662101, 25662524, 25663488, 25667973 -25669791, 25670786, 25671354, 25672640, 25674386, 25680221, 25685152 -25686739, 25687460, 25691904, 25694206, 25695903, 25696520, 25699321 -25700654, 25709368, 25710420, 25715167, 25717371, 25722055, 25722608 -25722720, 25723097, 25723158, 25728085, 25729507, 25730014, 25734963 -25736747, 25739065, 25740844, 25741955, 25743479, 25747569, 25749273 -25752755, 25754606, 25756945, 25757697, 25757748, 25760195, 25762221 -25764020, 25766822, 25768681, 25772669, 25774077, 25775213, 25775444 -25780343, 25783447, 25784002, 25785331, 25785441, 25788879, 25789041 -25789277, 25789579, 25790353, 25792911, 25795865, 25797092, 25797124 -25797305, 25800464, 25802510, 25803364, 25803545, 25807997, 25809524 -25810263, 25810704, 25811650, 25812390, 25813931, 25818707, 25822410 -25823532, 25823754, 25825910, 25826740, 25830492, 25832935, 25834581 -25835365, 25838361, 25838755, 25852885, 25856821, 25858672, 25861398 -25865785, 25870579, 25871177, 25871639, 25871753, 25872127, 25872389 -25873336, 25874050, 25874678, 25882264, 25883438, 25885148, 25888073 -25888984, 25890056, 25890673, 25890782, 25894239, 25895224, 25897615 -25898228, 25904273, 25904490, 25905130, 25906117, 25906886, 25908728 -25911724, 25914276, 25919622, 25932524, 25932728, 25933494, 25941836 -25943271, 25945130, 25947799, 25951571, 25953857, 25954022, 25954054 -25957038, 25963024, 25964954, 25967544, 25967985, 25970731, 25971286 -25972417, 25973152, 25975723, 25977302, 25980605, 25980770, 25981498 -25982666, 25986062, 25990907, 25995938, 25997810, 26006257, 26007010 -26019148, 26024732, 26024784, 26025681, 26029075, 26029777, 26029780 -26032573, 26034119, 26036748, 26037215, 26038086, 26039623, 26040483 -26045732, 26051656, 26078437, 26078493, 26080410, 26083298, 26087754 -26088426, 26088836, 26090767, 26090893, 26091640, 26091786, 26095327 -26095405, 26096382, 26108080, 26108337, 26110259, 26110632, 26111842 -26112621, 26115103, 26121990, 26124078, 26130486, 26137367, 26137416 -26138085, 26145560, 26149904, 26153372, 26153977, 26168933, 26169341 -26169345, 26170659, 26170715, 26176002, 26187943, 26189861, 26198757 -26198926, 26201113, 26203182, 26223039, 26237338, 26237431, 26237773 -26238195, 26242031, 26242677, 26243698, 26244115, 26245237, 26248143 -26249718, 26256131, 26257953, 26259265, 26261327, 26263328, 26263721 -26268756, 26269790, 26271001, 26274660, 26275023, 26275415, 26277439 -26281476, 26285062, 26285933, 26308650, 26309047, 26317991, 26318627 -26323308, 26324206, 26324769, 26325856, 26327418, 26327624, 26327775 -26330994, 26331743, 26333141, 26336977, 26338953, 26351334, 26351996 -26353617, 26358670, 26359091, 26362155, 26362821, 26366517, 26367012 -26367460, 26371725, 26373967, 26374791, 26375052, 26375250, 26380097 -26385189, 26388538, 26396790, 26398675, 26399626, 26399691, 26405036 -26406387, 26407408, 26410240, 26412540, 26418088, 26420561, 26421667 -26422277, 26423085, 26426526, 26426967, 26430323, 26430737, 26434436 -26434999, 26435073, 26436168, 26438612, 26439748, 26440169, 26440749 -26442308, 26444601, 26444887, 26446098, 26452606, 26474662, 26474703 -26475419, 26476244, 26478970, 26479173, 26482376, 26486365, 26492866 -26493289, 26498354, 26513067, 26513709, 26521043, 26522439, 26523432 -26526726, 26526799, 26536320, 26537307, 26542135, 26542236, 26542835 -26544823, 26545688, 26546070, 26546664, 26546754, 26548363, 26556014 -26558437, 26569225, 26575788, 26580633, 26582460, 26584641, 26588069 -26597140, 26599395, 26608137, 26608238, 26609942, 26615291, 26615690 -26617804, 26623652, 26626879, 26629381, 26633355, 26633558, 26635897 -26637273, 26637824, 26639167, 26641610, 26650226, 26650540, 26654363 -26658759, 26659182, 26669550, 26680105, 26712331, 26714486, 26714910 -26717528, 26724511, 26725687, 26727397, 26729494, 26729611, 26740700 -26744595, 26745002, 26751106, 26751171, 26755171, 26758193, 26764561 -26765212, 26768025, 26775602, 26784509, 26790923, 26794786, 26797591 -26798411, 26798516, 26802503, 26816582, 26820076, 26822314, 26822620 -26824833, 26828994, 26829845, 26833932, 26837569, 26837702, 26840654 -26844406, 26844870, 26849779, 26871815, 26875822, 26883456, 26895149 -26896659, 26898563, 26907236, 26907327, 26908788, 26909100, 26909504 -26910716, 26911000, 26939314, 26943004, 26944190, 26958896, 26963310 -26966616, 26966916, 26967713, 26968670, 26969321, 26970175, 26970717 -26981902, 26983259, 26985002, 26986173, 26992964, 27000158, 27006120 -27006664, 27009164, 27013146, 27028251, 27032785, 27033520, 27033652 -27034890, 27036163, 27037839, 27038986, 27039712, 27044169, 27044297 -27045634, 27052607, 27056711, 27058530, 27060167, 27060859, 27061736 -27072923, 27073314, 27079140, 27084613, 27087426, 27090765, 27092508 -27093423, 27097854, 27100800, 27101105, 27105900, 27106179, 27110878 -27115422, 27117822, 27119621, 27119861, 27122162, 27124624, 27125872 -27133662, 27134734, 27135647, 27135993, 27138325, 27142120, 27142373 -27142529, 27144928, 27151826, 27153641, 27160922, 27161071, 27162390 -27162405, 27163928, 27165231, 27169796, 27170305, 27181537, 27181897 -27185188, 27195935, 27199245, 27200959, 27202015, 27203055, 27207110 -27208795, 27213224, 27216046, 27217412, 27223075, 27229389, 27231051 -27234962, 27236722, 27242226, 27244337, 27244999, 27248917, 27249531 -27250547, 27251690, 27255377, 27256000, 27258578, 27259307, 27262945 -27264464, 27266245, 27274456, 27274536, 27275533, 27276231, 27283960 -27284499, 27285244, 27288638, 27292213, 27293599, 27302711, 27302730 -27303287, 27303938, 27304410, 27304906, 27305039, 27308088, 27314206 -27314390, 27314697, 27320576, 27321179, 27329612, 27333106, 27334316 -27338912, 27338946, 27339115, 27345231, 27346709, 27348081, 27349393 -27350267, 27351628, 27359178, 27364854, 27367194, 27369515, 27370965 -27375542, 27381498, 27383281, 27386467, 27393570, 27394703, 27395416 -27396624, 27396672, 27396813, 27397048, 27400416, 27400598, 27404573 -27404668, 27405645, 27416997, 27423251, 27424405, 27426363, 27432062 -27432826, 27433385, 27433870, 27434193, 27439835, 27441326, 27442041 -27445727, 27457891, 27459593, 27459948, 27466597, 27468303, 27486805 -27487919, 27489107, 27493674, 27494663, 27501373, 27501413, 27502420 -27504770, 27505229, 27508985, 27510959, 27525909, 27529661, 27533780 -27533819, 27534509, 27540613, 27544973, 27548131, 27554074, 27555481 -27558861, 27560602, 27562488, 27565906, 27567477, 27576342, 27576354 -27587905, 27588271, 27593501, 27595973, 27601118, 27601441, 27607563 -27611612, 27613080, 27613530, 27617978, 27620808, 27623159, 27629756 -27632114, 27634676, 27634991, 27645231, 27657712, 27658186, 27666312 -27671633, 27680669, 27686599, 27687880, 27688036, 27688099, 27688692 -27691920, 27691939, 27693416, 27693713, 27695063, 27698953, 27700466 -27704237, 27709046, 27710072, 27719000, 27726780, 27729678, 27739006 -27740424, 27748954, 27751755, 27757567, 27757888, 27758544, 27758653 -27758972, 27759077, 27769361, 27793533, 27799032, 27801337, 27818389 -27819881, 27824540, 27824543, 27825241, 27828794, 27829295, 27833672 -27834551, 27834569, 27835925, 27839353, 27846298, 27846499, 27847259 -27850112, 27855490, 27861226, 27873412, 27882176, 27886087, 27897759 -27898015, 27902561, 27909478, 27927431, 27929287, 27931299, 27935493 -27940876, 27945870, 27951817, 27959048, 27959594, 27966472, 27967484 -27983174, 27986817, 27994325, 27995215, 27995248, 27997875, 27998003 -27999073, 27999638, 28000269, 28022101, 28023081, 28023399, 28023482 -28024793, 28025414, 28026866, 28033429, 28040776, 28043157, 28045903 -28067846, 28071549, 28072383, 28072567, 28074713, 28079127, 28090453 -28098160, 28099662, 28108003, 28111583, 28120036, 28120951, 28124631 -28125947, 28129791, 28140658, 28157786, 28164480, 28165439, 28171079 -28174827, 28180464, 28181021, 28184554, 28188330, 28190796, 28194173 -28199085, 28201419, 28209985, 28215510, 28218832, 28220398, 28223871 -28226179, 28229360, 28236305, 28238264, 28242712, 28250929, 28256164 -28271119, 28276054, 28279837, 28281094, 28282606, 28290434, 28294563 -28302049, 28305001, 28305362, 28309406, 28319114, 28320399, 28330714 -28330971, 28354603, 28357401, 28361221, 28365111, 28369092, 28371123 -28373960, 28375383, 28378446, 28384353, 28386259, 28388910, 28390273 -28391210, 28396445, 28397317, 28401116, 28402823, 28420042, 28420457 -28423598, 28432129, 28434028, 28437315, 28439086, 28454215, 28454242 -28468312, 28468493, 28481149, 28483184, 28489150, 28501075, 28502343 -28503038, 28507324, 28508053, 28508557, 28512336, 28521330, 28522441 -28528349, 28530171, 28535127, 28535272, 28537715, 28538439, 28542455 -28545134, 28546290, 28547068, 28564479, 28571483, 28572407, 28572834 -28578164, 28578945, 28585411, 28587723, 28589509, 28600233, 28608211 -28612674, 28617631, 28617959, 28621470, 28622202, 28627255, 28636676 -28639299, 28642899, 28678804, 28691965, 28692103, 28692275, 28697806 -28708023, 28709063, 28710469, 28714988, 28728272, 28734355, 28740708 -28742555, 28749289, 28749724, 28758090, 28758722, 28774416, 28777174 -28791725, 28797711, 28803345, 28817449, 28819640, 28820669, 28821847 -28830691, 28831971, 28835937, 28836716, 28838066, 28844866, 28849751 -28852691, 28855922, 28856060, 28856172, 28863263, 28863487, 28867992 -28887305, 28889730, 28891984, 28927452, 28949888, 28951382, 28956908 -28959493, 28960211, 28965095, 28965787, 28986231, 28986257, 28987439 -28991884, 28993295, 28993590, 29002488, 29006527, 29007321, 29007353 -29009513, 29013832, 29024054, 29026582, 29027694, 29032276, 29040739 -29048498, 29050886, 29060216, 29061016, 29115857, 29125374, 29158680 -29163567, 29170232, 29173817, 29179097, 29182517, 29182901, 29189889 -29198092, 29200700, 29203604, 29213320, 29224605, 29237575, 29247712 -29249289, 29250230, 29250317, 29260956, 29278684, 29301463, 29339155 -29343086, 29343861, 29347943, 29353821, 29372069, 29372460, 29375355 -29375984, 29376346, 29378913, 29379978, 29383695, 29388020, 29398488 -29399336, 29405462, 29409149, 29409455, 29426241, 29434301, 29436454 -29437712, 29450812, 29452251, 29454978, 29464779, 29483626, 29483672 -29483723, 29483771, 29500257, 29500963, 29504682, 29511611, 29524985 -29530515, 29536342, 29538631, 29542449, 29542580, 29548592, 29549071 -29580394, 29614575, 29621961, 29625065, 29626154, 29629430, 29633753 -29637526, 29645349, 29651520, 29656843, 29667994, 29676089, 29678163 -29685137, 29687220, 29690625, 29703195, 29707896, 29719146, 29724063 -29726695, 29767177, 29782211, 29791152, 29794462, 29807964, 29813494 -29817278, 29825525, 29836659, 29841687, 29846645, 29853485, 29865188 -29869404, 29875459, 29876358, 29881050, 29884958, 29893132, 29902311 -29914449, 29944035, 29944660, 29951620, 29961353, 29962927, 29962939 -29991257, 30018017, 30031027, 30064268, 30076253, 30078934, 30088912 -30098251, 30099302, 30114477, 30120608, 30125995, 30131286, 30147928 -30150731, 30163243, 30164714, 30173113, 30177597, 30179644, 30189023 -30196358, 30200758, 30215130, 30218044, 30218317, 30223712, 30239480 -30241567, 30244787, 30246179, 30247305, 30252098, 30252156, 30253255 -30265523, 30272329, 30281591, 30282501, 30283932, 30305880, 30312094 -30342878, 30364613, 30365745, 30374739, 30384152, 30402386, 30403763 -30408515, 30413137, 30416034, 30431274, 30441687, 30453442, 30458593 -30460922, 30475115, 30485255, 30496957, 30497057, 30501574, 30503943 -30509277, 30510527, 30582500, 30613937, 30635302, 30654409, 30671813 -30741263, 30803210, 30815852, 30968208, 29997959, 29997937, 28852325 -28125601, 27015449, 25881255, 25173124, 24701840, 23614158, 29213893 -25811105, 25890046, 26023042, 26570134, 27000702, 27461740, 27952586 -27642235, 27539876, 28502098, 28915870, 29254623, 29774362, 30160625 -30534662, 30855101 -``` - -## Version 12\.2\.0\.1\.ru\-2020\-01\.rur\-2020\-01\.r1 - -Version 12\.2\.0\.1\.ru\-2020\-01\.rur\-2020\-01\.r1 includes the following: -+ Patch 30593149: Database Jan 2020 Release Update: 12\.2\.0\.1\.200114 -+ Patch 30502018: OJVM RELEASE UPDATE 12\.2\.0\.1\.200114 -+ Patch 29997937: DSTv34 for RDBMS \(TZDATA2019G\) -+ Patch 29997959: DSTv34 for OJVM \(TZDATA2019G\) -+ PreUpgrade Jar: preupgrade\_12201\_cbuild\_23\_lf\.zip -+ Patch 28730253: SUPPORT NEW ERA REIWA FOR JAPANESE IMPERIAL CALENDAR is included in DB PATCH 30138470 - -### Oracle release update 12\.2\.0\.1\.200114, released January 2020 - -Bugs fixed: - -``` -30125995, 8480838, 8932139, 12763598, 13554903, 14221306, 14690846 -15931756, 16002385, 16438495, 16727454, 16942578, 17027695, 17533661 -17947871, 18308268, 18521691, 18594510, 18774543, 18878420, 19072655 -19211433, 19285025, 19327292, 19526548, 19614243, 19647894, 19649997 -19702201, 19721304, 20003668, 20087519, 20118035, 20120236, 20324049 -20436508, 20532077, 20549013, 20588486, 20591151, 20617383, 20620169 -20736227, 20756305, 20866970, 20976443, 21089435, 21095391, 21143725 -21147908, 21159907, 21178363, 21186167, 21197098, 21216226, 21320338 -21433452, 21479706, 21517767, 21520266, 21547051, 21638600, 21744603 -21788462, 21837606, 21882528, 21935698, 21981529, 21985256, 22007324 -22070473, 22070853, 22072543, 22087683, 22104866, 22107360, 22174392 -22179537, 22282748, 22310426, 22347493, 22363790, 22364044, 22367053 -22379010, 22446455, 22454940, 22495673, 22503283, 22503297, 22504793 -22522515, 22530986, 22564336, 22568728, 22581771, 22594071, 22599050 -22628825, 22645009, 22645496, 22654475, 22700845, 22726044, 22729345 -22826067, 22843979, 22845846, 22864303, 22898198, 22921674, 22939829 -22950945, 22970869, 22981722, 23019710, 23026585, 23035249, 23055900 -23061453, 23065002, 23066146, 23080557, 23104033, 23105538, 23109325 -23110523, 23125560, 23126545, 23127945, 23151677, 23169712, 23177923 -23179662, 23184263, 23197730, 23234232, 23237091, 23249829, 23271203 -23278750, 23300142, 23306590, 23308065, 23310101, 23312077, 23328639 -23333567, 23336559, 23342170, 23481673, 23491861, 23499004, 23499160 -23521523, 23527363, 23533647, 23548817, 23567857, 23572982, 23581777 -23588722, 23599216, 23600861, 23602213, 23645516, 23665623, 23709062 -23715460, 23715518, 23730961, 23733981, 23735292, 23738304, 23741944 -23743596, 23746128, 23749454, 23761724, 24010030, 24289874, 24294174 -24303148, 24307571, 24308349, 24326444, 24326846, 24328857, 24330708 -24332831, 24334708, 24336249, 24337882, 24341675, 24343905, 24345420 -24346821, 24348685, 24350620, 24352981, 24355111, 24357348, 24368004 -24371491, 24373528, 24373756, 24374976, 24376875, 24376878, 24383086 -24385983, 24401351, 24403922, 24409977, 24415926, 24416451, 24421668 -24423416, 24425056, 24425998, 24435982, 24437162, 24440648, 24443539 -24457597, 24460392, 24461826, 24467122, 24468470, 24470606, 24471079 -24471473, 24473736, 24485034, 24485161, 24485174, 24486059, 24486237 -24509056, 24516314, 24534401, 24554533, 24555417, 24556862, 24556967 -24560906, 24563422, 24570214, 24570598, 24573817, 24578718, 24578797 -24588377, 24589081, 24589590, 24591506, 24593740, 24595699, 24600330 -24609592, 24609996, 24611527, 24616637, 24617969, 24623975, 24624166 -24642495, 24654629, 24655717, 24664211, 24668398, 24669189, 24674197 -24674955, 24676172, 24677696, 24680959, 24687075, 24689376, 24692973 -24693010, 24693290, 24697323, 24699619, 24710696, 24713381, 24714096 -24717183, 24717859, 24718260, 24719799, 24735430, 24737064, 24737403 -24737581, 24737954, 24739791, 24744383, 24744686, 24752618, 24757934 -24759556, 24760407, 24764085, 24766309, 24784414, 24786669, 24792678 -24793511, 24796092, 24797119, 24800423, 24801152, 24802934, 24811725 -24812047, 24818566, 24827228, 24827654, 24831514, 24835919, 24841671 -24843188, 24844549, 24844841, 24845157, 24848746, 24848923, 24850622 -24907917, 24908321, 24911709, 24912588, 24921478, 24922704, 24923080 -24923215, 24923338, 24923790, 24924667, 24926999, 24929210, 24938784 -24940060, 24942749, 24953434, 24957555, 24960044, 24960809, 24965426 -24966594, 24966788, 24967993, 24968162, 24976007, 24978100, 25022574 -25027852, 25028996, 25029022, 25029423, 25032818, 25034396, 25036006 -25036474, 25042823, 25044977, 25045228, 25050160, 25051465, 25051628 -25054064, 25057811, 25058080, 25060506, 25062592, 25063971, 25065563 -25072986, 25077278, 25078611, 25086233, 25087436, 25092777, 25093872 -25095982, 25098160, 25099339, 25099497, 25099758, 25100063, 25100579 -25103996, 25107662, 25110233, 25114561, 25120284, 25120668, 25120742 -25121089, 25123585, 25124363, 25129925, 25130312, 25140197, 25145163 -25145215, 25150925, 25159176, 25162645, 25164293, 25166187, 25171041 -25171084, 25175723, 25176408, 25178032, 25178101, 25178179, 25179774 -25182817, 25184453, 25184555, 25186079, 25191872, 25192044, 25192528 -25192729, 25195901, 25199585, 25201454, 25202355, 25203656, 25205954 -25206864, 25207410, 25209912, 25210268, 25210499, 25210690, 25211628 -25219450, 25223839, 25224242, 25225795, 25226665, 25227381, 25230870 -25230945, 25237577, 25240188, 25240590, 25241448, 25241625, 25244807 -25248384, 25250109, 25251648, 25257085, 25259611, 25262869, 25263960 -25265499, 25269133, 25283790, 25287072, 25293659, 25296876, 25299227 -25299807, 25300427, 25303284, 25303756, 25305405, 25307368, 25309116 -25313154, 25313411, 25316758, 25317989, 25320555, 25323525, 25328518 -25329664, 25335249, 25335360, 25335790, 25337332, 25337640, 25348956 -25353983, 25356118, 25357142, 25360661, 25362958, 25367588, 25367721 -25382812, 25383204, 25384462, 25386748, 25388896, 25392535, 25393714 -25395696, 25397936, 25398306, 25404202, 25405100, 25405687, 25405813 -25410017, 25410180, 25410802, 25410877, 25411036, 25415713, 25417050 -25417056, 25417958, 25425451, 25425760, 25427662, 25429959, 25430120 -25433696, 25435038, 25437699, 25440818, 25442559, 25444961, 25445168 -25451531, 25455795, 25457409, 25459958, 25462714, 25463844, 25472112 -25472885, 25476125, 25476149, 25477657, 25478885, 25479164, 25481087 -25482971, 25489342, 25489367, 25489607, 25492379, 25498930, 25498994 -25516250, 25524955, 25528838, 25530080, 25530814, 25535668, 25536819 -25537470, 25539063, 25540738, 25546580, 25546608, 25547901, 25551676 -25553616, 25554787, 25555252, 25557886, 25558986, 25560487, 25561296 -25569149, 25570929, 25573623, 25575348, 25575369, 25575628, 25579458 -25579761, 25591394, 25594901, 25597525, 25598473, 25599425, 25600342 -25600421, 25602488, 25603923, 25606091, 25607726, 25612095, 25614866 -25616268, 25616359, 25616417, 25616645, 25631933, 25633101, 25634317 -25634348, 25635149, 25638456, 25639019, 25643818, 25643889, 25643931 -25646373, 25647325, 25648731, 25653109, 25654459, 25654936, 25655390 -25655966, 25659655, 25660847, 25661819, 25662088, 25662101, 25662524 -25663488, 25669791, 25670786, 25671354, 25672640, 25674386, 25680221 -25685152, 25686739, 25687460, 25691904, 25694206, 25695903, 25696520 -25699321, 25700654, 25709368, 25710420, 25715167, 25717371, 25722055 -25722608, 25722720, 25723158, 25728085, 25729507, 25730014, 25734963 -25736747, 25739065, 25741955, 25743479, 25747569, 25749273, 25752755 -25754606, 25756945, 25757748, 25760195, 25762221, 25764020, 25766822 -25768681, 25772669, 25774077, 25775213, 25775444, 25780343, 25783447 -25784002, 25785331, 25785441, 25788879, 25789041, 25789277, 25789579 -25790353, 25792911, 25795865, 25797092, 25797124, 25797305, 25800464 -25802510, 25803364, 25803545, 25807997, 25810263, 25810704, 25811650 -25812390, 25813931, 25818707, 25822410, 25823754, 25825910, 25826740 -25830492, 25832935, 25834581, 25835365, 25838361, 25838755, 25852885 -25856821, 25858672, 25861398, 25865785, 25870579, 25871177, 25871639 -25871753, 25872127, 25872389, 25873336, 25874050, 25874678, 25882264 -25883438, 25885148, 25888073, 25888984, 25890056, 25890673, 25890782 -25894239, 25895224, 25897615, 25898228, 25904273, 25904490, 25906117 -25906886, 25908728, 25911724, 25914276, 25919622, 25932524, 25932728 -25933494, 25941836, 25943271, 25945130, 25947799, 25951571, 25953857 -25954022, 25954054, 25957038, 25963024, 25964954, 25967544, 25967985 -25970731, 25971286, 25973152, 25975723, 25977302, 25980605, 25980770 -25981498, 25982666, 25986062, 25990907, 25995938, 25997810, 26006257 -26007010, 26019148, 26024732, 26024784, 26025681, 26029075, 26029777 -26029780, 26032573, 26034119, 26036748, 26037215, 26038086, 26039623 -26040483, 26045732, 26051656, 26078437, 26078493, 26080410, 26083298 -26087754, 26088426, 26088836, 26090767, 26090893, 26091640, 26091786 -26095327, 26095405, 26096382, 26108080, 26108337, 26110259, 26110632 -26111842, 26112621, 26115103, 26121990, 26124078, 26130486, 26137367 -26138085, 26145560, 26149904, 26153372, 26153977, 26168933, 26169341 -26169345, 26170659, 26170715, 26176002, 26187943, 26189861, 26198757 -26198926, 26201113, 26203182, 26223039, 26237338, 26237431, 26237773 -26238195, 26242031, 26242677, 26243698, 26244115, 26245237, 26248143 -26249718, 26256131, 26257953, 26259265, 26261327, 26263328, 26263721 -26268756, 26269790, 26271001, 26274660, 26275023, 26275415, 26277439 -26281476, 26285062, 26285933, 26308650, 26309047, 26317991, 26318627 -26323308, 26324206, 26324769, 26325856, 26327418, 26327624, 26327775 -26330994, 26331743, 26333141, 26336977, 26338953, 26351334, 26353617 -26358670, 26359091, 26362155, 26362821, 26366517, 26367012, 26367460 -26371725, 26373967, 26374791, 26375052, 26375250, 26380097, 26385189 -26388538, 26396790, 26399626, 26399691, 26405036, 26406387, 26407408 -26410240, 26412540, 26418088, 26420561, 26421667, 26422277, 26423085 -26426526, 26426967, 26430323, 26430737, 26434436, 26434999, 26435073 -26436168, 26438612, 26439748, 26440169, 26440749, 26442308, 26444601 -26444887, 26446098, 26452606, 26474662, 26474703, 26475419, 26476244 -26478970, 26479173, 26482376, 26486365, 26492866, 26493289, 26498354 -26513067, 26513709, 26521043, 26522439, 26523432, 26526726, 26526799 -26536320, 26537307, 26542135, 26542236, 26542835, 26544823, 26545688 -26546070, 26546664, 26546754, 26548363, 26556014, 26558437, 26569225 -26575788, 26580633, 26582460, 26584641, 26588069, 26597140, 26599395 -26608137, 26608238, 26609942, 26615291, 26615690, 26617804, 26623652 -26626879, 26629381, 26633355, 26633558, 26635897, 26637273, 26637824 -26639167, 26641610, 26650226, 26650540, 26654363, 26658759, 26659182 -26669550, 26680105, 26712331, 26714486, 26714910, 26717528, 26724511 -26725687, 26727397, 26729494, 26729611, 26740700, 26744595, 26745002 -26751106, 26751171, 26755171, 26758193, 26764561, 26765212, 26768025 -26775602, 26784509, 26794786, 26797591, 26798411, 26798516, 26802503 -26816582, 26820076, 26822620, 26824833, 26828994, 26829845, 26833932 -26837702, 26840654, 26844406, 26844870, 26849779, 26871815, 26875822 -26883456, 26895149, 26896659, 26898563, 26907236, 26907327, 26908788 -26909100, 26909504, 26910716, 26911000, 26939314, 26943004, 26944190 -26958896, 26963310, 26966616, 26966916, 26967713, 26968670, 26969321 -26970175, 26970717, 26981902, 26983259, 26985002, 26986173, 26992964 -27000158, 27006120, 27006664, 27009164, 27013146, 27028251, 27032785 -27033520, 27034890, 27036163, 27037839, 27038986, 27039712, 27044169 -27044297, 27045634, 27052607, 27056711, 27058530, 27060167, 27060859 -27061736, 27072923, 27073314, 27079140, 27087426, 27090765, 27092508 -27093423, 27097854, 27101105, 27105900, 27106179, 27110878, 27115422 -27117822, 27119621, 27119861, 27122162, 27124624, 27125872, 27133662 -27134734, 27135647, 27135993, 27138325, 27142373, 27142529, 27144928 -27151826, 27153641, 27160922, 27161071, 27162390, 27162405, 27163928 -27165231, 27169796, 27170305, 27181537, 27181897, 27185188, 27195935 -27199245, 27200959, 27202015, 27203055, 27207110, 27208795, 27213224 -27216046, 27223075, 27229389, 27231051, 27234962, 27236722, 27242226 -27244337, 27244999, 27248917, 27249531, 27250547, 27251690, 27255377 -27256000, 27258578, 27259307, 27262945, 27264464, 27266245, 27274456 -27274536, 27275533, 27276231, 27283960, 27284499, 27285244, 27288638 -27292213, 27293599, 27302711, 27302730, 27303287, 27304410, 27304906 -27305039, 27308088, 27314206, 27314390, 27320576, 27321179, 27329612 -27333106, 27334316, 27338912, 27338946, 27339115, 27345231, 27346709 -27348081, 27349393, 27350267, 27351628, 27359178, 27364854, 27367194 -27369515, 27370965, 27375542, 27381498, 27383281, 27386467, 27393570 -27394703, 27395416, 27396624, 27396672, 27396813, 27397048, 27400416 -27400598, 27404668, 27405645, 27416997, 27423251, 27424405, 27426363 -27432062, 27432826, 27433385, 27433870, 27434193, 27439835, 27441326 -27442041, 27445727, 27457891, 27459948, 27466597, 27468303, 27486805 -27489107, 27493674, 27501373, 27501413, 27502420, 27504770, 27505229 -27508985, 27510959, 27525909, 27529661, 27533780, 27533819, 27534509 -27540613, 27544973, 27548131, 27554074, 27555481, 27558861, 27560602 -27562488, 27565906, 27567477, 27576342, 27576354, 27587905, 27588271 -27593501, 27595973, 27601118, 27601441, 27607563, 27611612, 27613080 -27613530, 27617978, 27620808, 27623159, 27629756, 27632114, 27634676 -27634991, 27657712, 27658186, 27666312, 27671633, 27680669, 27686599 -27687880, 27688036, 27688099, 27688692, 27691920, 27691939, 27693416 -27693713, 27695063, 27698953, 27700466, 27704237, 27709046, 27710072 -27726780, 27729678, 27739006, 27740424, 27748954, 27751755, 27757567 -27757888, 27758544, 27758653, 27758972, 27759077, 27769361, 27793533 -27799032, 27801337, 27818389, 27819881, 27824540, 27824543, 27825241 -27828794, 27829295, 27833672, 27834551, 27834569, 27835925, 27839353 -27846298, 27846499, 27847259, 27850112, 27855490, 27861226, 27873412 -27882176, 27886087, 27897759, 27898015, 27902561, 27909478, 27927431 -27929287, 27931299, 27935493, 27940876, 27945870, 27951817, 27959048 -27959594, 27966472, 27967484, 27983174, 27986817, 27994325, 27995215 -27995248, 27997875, 27998003, 27999073, 27999638, 28000269, 28022101 -28023081, 28023399, 28023482, 28026866, 28033429, 28040776, 28043157 -28045903, 28067846, 28071549, 28072567, 28074713, 28079127, 28090453 -28098160, 28099662, 28108003, 28111583, 28120036, 28120951, 28124631 -28125947, 28129791, 28140658, 28164480, 28165439, 28171079, 28174827 -28180464, 28181021, 28184554, 28188330, 28190796, 28194173, 28199085 -28201419, 28209985, 28215510, 28218832, 28220398, 28223871, 28226179 -28229360, 28236305, 28242712, 28256164, 28271119, 28279837, 28281094 -28282606, 28290434, 28294563, 28302049, 28305001, 28305362, 28309406 -28319114, 28320399, 28330971, 28354603, 28357401, 28361221, 28365111 -28369092, 28371123, 28373960, 28375383, 28378446, 28384353, 28386259 -28388910, 28390273, 28391210, 28396445, 28397317, 28401116, 28402823 -28420042, 28420457, 28423598, 28432129, 28434028, 28435902, 28437315 -28454215, 28454242, 28468312, 28468493, 28481149, 28483184, 28489150 -28501075, 28502343, 28507324, 28508053, 28508557, 28512336, 28521330 -28522441, 28528349, 28530171, 28535272, 28537715, 28538439, 28542455 -28545134, 28546290, 28547068, 28571483, 28572407, 28572834, 28578164 -28578945, 28585411, 28587723, 28589509, 28600233, 28612674, 28617631 -28617959, 28621470, 28627255, 28636676, 28639299, 28642899, 28678804 -28691965, 28692103, 28692275, 28697806, 28708023, 28714988, 28728272 -28734355, 28742555, 28749289, 28749724, 28758090, 28758722, 28774416 -28777174, 28791725, 28797711, 28803345, 28817449, 28819640, 28820669 -28821847, 28830691, 28831971, 28838066, 28844866, 28849751, 28852691 -28855922, 28856060, 28856172, 28863487, 28867992, 28887305, 28889730 -28891984, 28927452, 28949888, 28951026, 28951382, 28956908, 28959493 -28960211, 28965095, 28965787, 28986231, 28986257, 28987439, 28991884 -28993590, 29002488, 29006527, 29007353, 29009513, 29013832, 29024054 -29027694, 29032276, 29040739, 29050886, 29060216, 29061016, 29115857 -29125374, 29158680, 29163567, 29170232, 29173817, 29182901, 29189889 -29198092, 29200700, 29213320, 29224605, 29237575, 29250230, 29250317 -29260956, 29278684, 29301463, 29339155, 29347943, 29353821, 29372069 -29375355, 29375984, 29376346, 29378913, 29379978, 29383695, 29388020 -29398488, 29399336, 29405462, 29409149, 29434301, 29436454, 29437712 -29450812, 29452251, 29454978, 29464779, 29483626, 29483672, 29483723 -29483771, 29500257, 29504682, 29511611, 29530515, 29536342, 29538631 -29542449, 29549071, 29626154, 29629430, 29633753, 29637526, 29645349 -29651520, 29667994, 29676089, 29678163, 29690625, 29703195, 29707896 -29719146, 29724063, 29726695, 29767177, 29782211, 29791152, 29794462 -29813494, 29817278, 29825525, 29836659, 29841687, 29846645, 29853485 -29865188, 29869404, 29875459, 29884958, 29893132, 29902311, 29914449 -29944035, 29944660, 29951620, 29962927, 29962939, 29991257, 30088912 -30098251, 30150731, 30164714, 30189023, 30218044, 30223712, 30244787 -30252098, 30252156, 30253255, 30281591, 30342878, 30365745, 30402386 -30408515, 30453442, 30458593, 30485255 -``` - -## Version 12\.2\.0\.1\.ru\-2019\-10\.rur\-2019\-10\.r1 - -Version 12\.2\.0\.1\.ru\-2019\-10\.rur\-2019\-10\.r1 includes the following: -+ Patch 30138470: DATABASE OCT 2019 RELEASE UPDATE 12\.2\.0\.1\.191015 -+ Patch 30133625: OJVM RELEASE UPDATE 12\.2\.0\.1\.191015 -+ Patch 29997937: DSTv34 for RDBMS \(TZDATA2019G\) -+ Patch 29997959: DSTv34 for OJVM \(TZDATA2019G\) -+ PreUpgrade Jar: preupgrade\_12201\_cbuild\_23\_lf\.zip -+ Patch 28730253: SUPPORT NEW ERA REIWA FOR JAPANESE IMPERIAL CALENDAR is included in DB PATCH 30138470 -+ Support for [Resizing the temporary tablespace in a read replica](Appendix.Oracle.CommonDBATasks.Database.md#Appendix.Oracle.CommonDBATasks.ResizeTempSpaceReadReplica) - -### Oracle release update 12\.2\.0\.1\.191015, released October 2019 - -Bugs fixed: - -``` -29013832, 30244787, 30253255, 8480838, 8932139, 12763598, 13554903 -14221306, 14690846, 15931756, 16002385, 16438495, 16727454, 16942578 -17027695, 17533661, 17947871, 18308268, 18521691, 18594510, 18774543 -18878420, 19072655, 19211433, 19285025, 19327292, 19526548, 19614243 -19647894, 19649997, 19702201, 19721304, 20003668, 20087519, 20118035 -20120236, 20324049, 20436508, 20532077, 20588486, 20591151, 20617383 -20620169, 20736227, 20756305, 20866970, 20976443, 21089435, 21095391 -21143725, 21147908, 21159907, 21178363, 21186167, 21197098, 21216226 -21320338, 21433452, 21479706, 21517767, 21520266, 21547051, 21638600 -21744603, 21882528, 21935698, 21981529, 21985256, 22007324, 22070473 -22070853, 22072543, 22087683, 22104866, 22107360, 22179537, 22310426 -22347493, 22364044, 22367053, 22379010, 22446455, 22495673, 22503283 -22503297, 22504793, 22522515, 22530986, 22564336, 22568728, 22581771 -22594071, 22599050, 22628825, 22645009, 22654475, 22700845, 22726044 -22729345, 22826067, 22843979, 22845846, 22864303, 22898198, 22921674 -22939829, 22950945, 22970869, 22981722, 23019710, 23026585, 23035249 -23055900, 23061453, 23065002, 23066146, 23080557, 23104033, 23105538 -23110523, 23125560, 23126545, 23127945, 23151677, 23169712, 23177923 -23179662, 23184263, 23197730, 23234232, 23237091, 23249829, 23271203 -23278750, 23300142, 23306590, 23310101, 23312077, 23328639, 23336559 -23342170, 23481673, 23491861, 23499004, 23499160, 23521523, 23527363 -23533647, 23548817, 23567857, 23572982, 23581777, 23588722, 23599216 -23600861, 23602213, 23645516, 23665623, 23709062, 23715460, 23715518 -23730961, 23733981, 23735292, 23741944, 23743596, 23746128, 23749454 -23761724, 24010030, 24289874, 24294174, 24303148, 24307571, 24308349 -24326444, 24326846, 24328857, 24332831, 24334708, 24336249, 24337882 -24341675, 24343905, 24345420, 24346821, 24348685, 24350620, 24352981 -24355111, 24357348, 24368004, 24371491, 24373528, 24373756, 24374976 -24376875, 24376878, 24383086, 24385983, 24401351, 24403922, 24409977 -24415926, 24416451, 24421668, 24423416, 24425056, 24425998, 24435982 -24437162, 24440648, 24443539, 24457597, 24460392, 24461826, 24467122 -24468470, 24470606, 24471079, 24471473, 24473736, 24485034, 24485161 -24485174, 24486059, 24486237, 24509056, 24534401, 24554533, 24555417 -24556967, 24560906, 24563422, 24570214, 24570598, 24573817, 24578718 -24578797, 24589081, 24589590, 24591506, 24593740, 24595699, 24600330 -24609592, 24609996, 24611527, 24616637, 24617969, 24623975, 24624166 -24642495, 24654629, 24655717, 24664211, 24668398, 24669189, 24674197 -24674955, 24676172, 24677696, 24680959, 24687075, 24689376, 24692973 -24693290, 24697323, 24699619, 24710696, 24713381, 24714096, 24717183 -24717859, 24718260, 24719799, 24735430, 24737064, 24737403, 24737581 -24737954, 24739791, 24744383, 24744686, 24757934, 24759556, 24760407 -24764085, 24766309, 24786669, 24792678, 24793511, 24796092, 24797119 -24800423, 24801152, 24802934, 24811725, 24812047, 24818566, 24827228 -24827654, 24831514, 24835919, 24841671, 24843188, 24844549, 24844841 -24845157, 24848746, 24848923, 24850622, 24907917, 24908321, 24911709 -24912588, 24922704, 24923080, 24923215, 24923338, 24923790, 24924667 -24926999, 24929210, 24938784, 24940060, 24942749, 24953434, 24957555 -24960044, 24965426, 24966594, 24966788, 24967993, 24968162, 24976007 -24978100, 25022574, 25027852, 25028996, 25029022, 25029423, 25032818 -25034396, 25036006, 25036474, 25042823, 25044977, 25045228, 25050160 -25051465, 25051628, 25057811, 25058080, 25060506, 25062592, 25063971 -25065563, 25072986, 25078611, 25086233, 25087436, 25092777, 25093872 -25095982, 25098160, 25099339, 25099497, 25099758, 25100063, 25100579 -25103996, 25107662, 25110233, 25114561, 25120284, 25120668, 25120742 -25121089, 25123585, 25124363, 25129925, 25130312, 25140197, 25145163 -25145215, 25150925, 25159176, 25162645, 25164293, 25166187, 25171041 -25171084, 25175723, 25176408, 25178032, 25178101, 25178179, 25179774 -25182817, 25184453, 25184555, 25186079, 25191872, 25192044, 25192528 -25192729, 25195901, 25199585, 25201454, 25202355, 25203656, 25206864 -25207410, 25209912, 25210268, 25210499, 25211628, 25223839, 25224242 -25225795, 25226665, 25227381, 25230870, 25230945, 25237577, 25240188 -25240590, 25241448, 25241625, 25244807, 25248384, 25251648, 25257085 -25259611, 25262869, 25263960, 25265499, 25283790, 25287072, 25293659 -25296876, 25299227, 25299807, 25300427, 25303284, 25303756, 25305405 -25307368, 25309116, 25313154, 25313411, 25316758, 25317989, 25320555 -25323525, 25328518, 25329664, 25335249, 25335360, 25335790, 25337332 -25337640, 25348956, 25353983, 25356118, 25357142, 25360661, 25362958 -25367588, 25367721, 25382812, 25383204, 25384462, 25386748, 25388896 -25392535, 25393714, 25395696, 25397936, 25398306, 25404202, 25405100 -25405687, 25405813, 25410017, 25410180, 25410802, 25410877, 25411036 -25415713, 25417050, 25417056, 25417958, 25425451, 25425760, 25427662 -25429959, 25430120, 25433696, 25435038, 25437699, 25440818, 25442559 -25444961, 25445168, 25451531, 25455795, 25457409, 25459958, 25462714 -25463844, 25472112, 25476149, 25477657, 25478885, 25479164, 25482971 -25489342, 25489367, 25489607, 25492379, 25498930, 25498994, 25516250 -25524955, 25528838, 25530080, 25530814, 25535668, 25536819, 25537470 -25539063, 25540738, 25546580, 25546608, 25547901, 25551676, 25553616 -25554787, 25555252, 25557886, 25558986, 25560487, 25561296, 25569149 -25570929, 25575348, 25575369, 25575628, 25579458, 25579761, 25594901 -25597525, 25598473, 25599425, 25600342, 25600421, 25602488, 25603923 -25606091, 25607726, 25612095, 25614866, 25616268, 25616359, 25616417 -25616645, 25631933, 25633101, 25634317, 25634348, 25635149, 25638456 -25639019, 25643818, 25643889, 25643931, 25646373, 25647325, 25648731 -25653109, 25654459, 25654936, 25655390, 25655966, 25659655, 25660847 -25661819, 25662088, 25662101, 25662524, 25663488, 25669791, 25670786 -25671354, 25672640, 25674386, 25680221, 25685152, 25686739, 25687460 -25691904, 25694206, 25695903, 25696520, 25699321, 25700654, 25709368 -25710420, 25715167, 25717371, 25722055, 25722608, 25722720, 25723158 -25728085, 25729507, 25734963, 25736747, 25739065, 25741955, 25743479 -25747569, 25749273, 25752755, 25754606, 25756945, 25757748, 25760195 -25762221, 25764020, 25766822, 25768681, 25772669, 25774077, 25775213 -25780343, 25783447, 25784002, 25785331, 25785441, 25788879, 25789041 -25789277, 25789579, 25790353, 25792911, 25795865, 25797092, 25797124 -25797305, 25800464, 25802510, 25803545, 25807997, 25810263, 25810704 -25811650, 25813931, 25818707, 25822410, 25823754, 25825910, 25826740 -25830492, 25832935, 25834581, 25835365, 25838361, 25838755, 25852885 -25856821, 25858672, 25861398, 25865785, 25870579, 25871177, 25871639 -25871753, 25872127, 25872389, 25873336, 25874050, 25874678, 25882264 -25883438, 25885148, 25888073, 25888984, 25890056, 25890673, 25890782 -25894239, 25895224, 25897615, 25904273, 25904490, 25906117, 25906886 -25908728, 25911724, 25914276, 25919622, 25932524, 25932728, 25933494 -25941836, 25943271, 25945130, 25947799, 25951571, 25953857, 25954022 -25954054, 25957038, 25963024, 25964954, 25967544, 25967985, 25970731 -25971286, 25973152, 25975723, 25977302, 25980605, 25980770, 25981498 -25982666, 25986062, 25990907, 25995938, 25997810, 26006257, 26007010 -26019148, 26024732, 26024784, 26025681, 26029075, 26029777, 26029780 -26032573, 26034119, 26036748, 26037215, 26038086, 26039623, 26040483 -26045732, 26051656, 26078437, 26078493, 26080410, 26083298, 26088426 -26088836, 26090767, 26091640, 26091786, 26095327, 26095405, 26096382 -26108080, 26108337, 26110259, 26110632, 26111842, 26112621, 26115103 -26121990, 26124078, 26130486, 26137367, 26138085, 26149904, 26153372 -26153977, 26168933, 26169341, 26169345, 26170659, 26170715, 26176002 -26187943, 26189861, 26198757, 26198926, 26201113, 26203182, 26223039 -26237338, 26237431, 26237773, 26238195, 26242031, 26242677, 26243698 -26244115, 26245237, 26248143, 26249718, 26256131, 26257953, 26259265 -26261327, 26263328, 26263721, 26268756, 26269790, 26271001, 26275023 -26275415, 26277439, 26281476, 26285062, 26285933, 26308650, 26309047 -26317991, 26318627, 26323308, 26324206, 26324769, 26327624, 26330994 -26331743, 26333141, 26336977, 26338953, 26351334, 26353617, 26358670 -26359091, 26362155, 26362821, 26366517, 26367012, 26367460, 26371725 -26374791, 26375052, 26375250, 26380097, 26385189, 26388538, 26396790 -26399626, 26399691, 26406387, 26407408, 26412540, 26418088, 26420561 -26421667, 26422277, 26423085, 26426526, 26426967, 26430323, 26430737 -26434436, 26434999, 26435073, 26436168, 26438612, 26439748, 26440169 -26440749, 26442308, 26444601, 26444887, 26446098, 26452606, 26474662 -26474703, 26475419, 26476244, 26478970, 26479173, 26482376, 26486365 -26492866, 26493289, 26498354, 26513067, 26513709, 26521043, 26522439 -26523432, 26526726, 26526799, 26536320, 26537307, 26542135, 26542236 -26544823, 26545688, 26546070, 26546664, 26546754, 26548363, 26556014 -26558437, 26569225, 26575788, 26580633, 26582460, 26584641, 26597140 -26599395, 26608137, 26608238, 26609942, 26615291, 26615690, 26617804 -26623652, 26626879, 26629381, 26633355, 26633558, 26635897, 26637273 -26637824, 26639167, 26641610, 26650226, 26654363, 26658759, 26659182 -26680105, 26712331, 26714486, 26714910, 26717528, 26724511, 26725687 -26727397, 26729494, 26729611, 26740700, 26744595, 26745002, 26751106 -26751171, 26755171, 26758193, 26764561, 26765212, 26768025, 26775602 -26784509, 26794786, 26797591, 26798411, 26798516, 26802503, 26816582 -26820076, 26822620, 26828994, 26829845, 26833932, 26837702, 26840654 -26844406, 26844870, 26849779, 26871815, 26875822, 26883456, 26895149 -26896659, 26898563, 26907327, 26908788, 26909100, 26909504, 26910716 -26911000, 26939314, 26943004, 26944190, 26958896, 26963310, 26966616 -26966916, 26967713, 26969321, 26970175, 26970717, 26981902, 26983259 -26985002, 26986173, 26992964, 27000158, 27006120, 27006664, 27009164 -27013146, 27028251, 27032785, 27033520, 27034890, 27037839, 27038986 -27039712, 27044297, 27052607, 27058530, 27060167, 27060859, 27061736 -27072923, 27073314, 27079140, 27087426, 27090765, 27092508, 27093423 -27097854, 27101105, 27105900, 27106179, 27110878, 27115422, 27117822 -27119621, 27122162, 27124624, 27125872, 27133662, 27134734, 27135647 -27135993, 27138325, 27142373, 27142529, 27144928, 27151826, 27153641 -27160922, 27161071, 27162390, 27162405, 27163928, 27165231, 27169796 -27170305, 27181537, 27181897, 27185188, 27199245, 27200959, 27202015 -27207110, 27208795, 27213224, 27216046, 27223075, 27229389, 27231051 -27236722, 27242226, 27244337, 27248917, 27249531, 27250547, 27251690 -27255377, 27256000, 27258578, 27259307, 27262945, 27264464, 27266245 -27274456, 27274536, 27275533, 27276231, 27283960, 27284499, 27285244 -27288638, 27292213, 27293599, 27302711, 27302730, 27303287, 27304410 -27304906, 27305039, 27308088, 27314206, 27314390, 27320576, 27321179 -27329612, 27333106, 27334316, 27338912, 27338946, 27339115, 27345231 -27346709, 27348081, 27349393, 27350267, 27351628, 27359178, 27364854 -27367194, 27369515, 27370965, 27375542, 27381498, 27383281, 27386467 -27393570, 27394703, 27395416, 27396624, 27396672, 27396813, 27397048 -27400416, 27400598, 27404668, 27405645, 27416997, 27423251, 27424405 -27426363, 27432062, 27432826, 27433385, 27433870, 27434193, 27439835 -27441326, 27442041, 27445727, 27457891, 27459948, 27466597, 27468303 -27493674, 27501373, 27501413, 27502420, 27504770, 27505229, 27508985 -27510959, 27525909, 27533780, 27533819, 27534509, 27540613, 27544973 -27548131, 27554074, 27555481, 27558861, 27560602, 27562488, 27565906 -27567477, 27576342, 27576354, 27588271, 27593501, 27595973, 27601118 -27601441, 27607563, 27611612, 27613080, 27613530, 27617978, 27620808 -27623159, 27629756, 27632114, 27634676, 27634991, 27658186, 27666312 -27671633, 27680669, 27686599, 27687880, 27688036, 27688099, 27688692 -27691920, 27691939, 27693416, 27693713, 27695063, 27698953, 27700466 -27704237, 27709046, 27710072, 27726780, 27740424, 27748954, 27751755 -27757567, 27757888, 27758544, 27758653, 27758972, 27759077, 27793533 -27799032, 27801337, 27824540, 27824543, 27825241, 27829295, 27833672 -27834551, 27834569, 27835925, 27839353, 27846298, 27846499, 27847259 -27850112, 27855490, 27861226, 27873412, 27882176, 27886087, 27898015 -27902561, 27931299, 27935493, 27940876, 27945870, 27951817, 27959048 -27959594, 27966472, 27967484, 27983174, 27986817, 27994325, 27995215 -27995248, 27997875, 27998003, 27999073, 27999638, 28000269, 28022101 -28023081, 28023399, 28023482, 28026866, 28033429, 28040776, 28043157 -28045903, 28067846, 28072567, 28074713, 28090453, 28099662, 28108003 -28111583, 28120036, 28120951, 28124631, 28125947, 28129791, 28140658 -28165439, 28171079, 28174827, 28180464, 28181021, 28184554, 28188330 -28194173, 28199085, 28201419, 28215510, 28218832, 28220398, 28223871 -28226179, 28229360, 28236305, 28242712, 28256164, 28271119, 28279837 -28281094, 28282606, 28290434, 28294563, 28302049, 28305001, 28305362 -28319114, 28320399, 28354603, 28357401, 28361221, 28365111, 28369092 -28371123, 28378446, 28384353, 28390273, 28391210, 28396445, 28401116 -28420042, 28420457, 28423598, 28432129, 28434028, 28435902, 28437315 -28454242, 28468312, 28481149, 28483184, 28489150, 28501075, 28502343 -28507324, 28508053, 28508557, 28521330, 28522441, 28528349, 28535272 -28537715, 28542455, 28545134, 28547068, 28571483, 28572834, 28578164 -28585411, 28587723, 28600233, 28612674, 28617631, 28617959, 28621470 -28627255, 28636676, 28678804, 28691965, 28692103, 28692275, 28697806 -28708023, 28714988, 28728272, 28742555, 28749289, 28749724, 28758722 -28774416, 28791725, 28803345, 28817449, 28819640, 28820669, 28831971 -28849751, 28852691, 28855922, 28856060, 28856172, 28867992, 28889730 -28891984, 28951026, 28951382, 28956908, 28960211, 28965787, 28986231 -28987439, 28991884, 28993590, 29002488, 29006527, 29009513, 29024054 -29027694, 29032276, 29125374, 29158680, 29163567, 29189889, 29198092 -29200700, 29213320, 29224605, 29250230, 29250317, 29301463, 29339155 -29347943, 29353821, 29376346, 29378913, 29379978, 29388020, 29405462 -29409149, 29436454, 29437712, 29483672, 29483723, 29500257, 29511611 -29542449, 29633753, 29637526, 29645349, 29676089, 29690625, 29707896 -29724063, 29767177, 29782211, 29813494, 29836659, 29893132, 29902311 -30088912, 30189023 -``` - -## Version 12\.2\.0\.1\.ru\-2019\-07\.rur\-2019\-07\.r1 - -Version 12\.2\.0\.1\.ru\-2019\-07\.rur\-2019\-07\.r1 includes the following: -+ Patch 29757449: DATABASE JUL 2019 RELEASE UPDATE 12\.2\.0\.1\.190716 -+ Patch 29774415: OJVM RELEASE UPDATE 12\.2\.0\.1\.190716 -+ Patch 28125601: DSTv33 for RDBMS \(TZDATA2018G\) -+ Patch 28127287: DSTv33 for OJVM \(TZDATA2018G\) -+ PreUpgrade Jar: preupgrade\_12201\_cbuild\_22\_lf\.zip -+ Patch 29213893: DBMS\_STATS FAILING WITH ERROR ORA\-01422 WHEN GATHERING STATS FOR USER$ TABLE -+ Patch 28730253: SUPPORT NEW ERA REIWA FOR JAPANESE IMPERIAL CALENDAR - -### Oracle release update 12\.2\.0\.1\.190716, released July 2019 - -Bugs fixed: - -``` -8480838, 8932139, 12763598, 13554903, 14221306, 14690846, 15931756 -16002385, 16438495, 16727454, 16942578, 17027695, 17533661, 17947871 -18308268, 18521691, 18594510, 18774543, 18878420, 19072655, 19211433 -19285025, 19327292, 19526548, 19614243, 19647894, 19649997, 19702201 -19721304, 20003668, 20087519, 20118035, 20120236, 20324049, 20436508 -20532077, 20588486, 20591151, 20617383, 20620169, 20736227, 20756305 -20866970, 20976443, 21089435, 21095391, 21143725, 21147908, 21159907 -21178363, 21186167, 21197098, 21216226, 21320338, 21433452, 21479706 -21517767, 21520266, 21547051, 21638600, 21744603, 21882528, 21981529 -21985256, 22007324, 22070473, 22070853, 22072543, 22087683, 22104866 -22179537, 22310426, 22347493, 22364044, 22367053, 22379010, 22446455 -22495673, 22503283, 22503297, 22504793, 22522515, 22530986, 22564336 -22568728, 22581771, 22594071, 22599050, 22628825, 22645009, 22654475 -22700845, 22726044, 22729345, 22826067, 22843979, 22845846, 22864303 -22898198, 22950945, 22970869, 22981722, 23019710, 23026585, 23035249 -23055900, 23061453, 23065002, 23066146, 23080557, 23104033, 23105538 -23110523, 23125560, 23126545, 23127945, 23151677, 23169712, 23177923 -23179662, 23184263, 23197730, 23234232, 23237091, 23249829, 23271203 -23278750, 23300142, 23306590, 23310101, 23312077, 23328639, 23336559 -23481673, 23491861, 23499004, 23499160, 23521523, 23527363, 23533647 -23548817, 23567857, 23572982, 23581777, 23588722, 23599216, 23600861 -23602213, 23645516, 23665623, 23709062, 23715460, 23715518, 23730961 -23733981, 23735292, 23741944, 23746128, 23749454, 23761724, 24010030 -24289874, 24294174, 24303148, 24307571, 24308349, 24326444, 24326846 -24328857, 24332831, 24334708, 24336249, 24337882, 24341675, 24343905 -24345420, 24346821, 24348685, 24350620, 24352981, 24355111, 24357348 -24368004, 24371491, 24373528, 24373756, 24374976, 24376875, 24376878 -24385983, 24401351, 24403922, 24409977, 24415926, 24416451, 24421668 -24423416, 24425056, 24425998, 24435982, 24437162, 24443539, 24457597 -24460392, 24461826, 24467122, 24468470, 24470606, 24471079, 24471473 -24473736, 24485034, 24485161, 24485174, 24486059, 24486237, 24509056 -24534401, 24554533, 24555417, 24556967, 24560906, 24563422, 24570214 -24570598, 24573817, 24578718, 24578797, 24589081, 24589590, 24591506 -24593740, 24595699, 24600330, 24609592, 24609996, 24611527, 24616637 -24617969, 24623975, 24624166, 24642495, 24654629, 24655717, 24664211 -24668398, 24669189, 24674197, 24674955, 24676172, 24677696, 24680959 -24689376, 24692973, 24693290, 24697323, 24699619, 24710696, 24713381 -24714096, 24717183, 24717859, 24718260, 24719799, 24735430, 24737064 -24737403, 24737581, 24744383, 24744686, 24757934, 24759556, 24760407 -24764085, 24766309, 24786669, 24792678, 24793511, 24796092, 24797119 -24800423, 24801152, 24802934, 24811725, 24812047, 24827228, 24827654 -24831514, 24835919, 24841671, 24843188, 24844549, 24844841, 24845157 -24848746, 24848923, 24850622, 24907917, 24908321, 24911709, 24912588 -24922704, 24923080, 24923215, 24923338, 24923790, 24924667, 24926999 -24929210, 24938784, 24940060, 24942749, 24953434, 24957555, 24960044 -24965426, 24966594, 24966788, 24967993, 24968162, 24976007, 24978100 -25022574, 25027852, 25028996, 25029022, 25029423, 25032818, 25034396 -25036474, 25042823, 25044977, 25045228, 25050160, 25051465, 25051628 -25057811, 25058080, 25062592, 25063971, 25065563, 25072986, 25078611 -25086233, 25087436, 25092777, 25093872, 25098160, 25099339, 25099497 -25099758, 25100063, 25100579, 25103996, 25107662, 25110233, 25114561 -25120284, 25120668, 25120742, 25121089, 25123585, 25124363, 25129925 -25140197, 25145163, 25145215, 25150925, 25159176, 25162645, 25164293 -25166187, 25171041, 25171084, 25175723, 25176408, 25178032, 25178101 -25178179, 25179774, 25182817, 25184555, 25186079, 25191872, 25192044 -25192528, 25192729, 25199585, 25201454, 25202355, 25203656, 25206864 -25207410, 25209912, 25210268, 25210499, 25211628, 25223839, 25224242 -25225795, 25226665, 25227381, 25230870, 25230945, 25237577, 25240188 -25240590, 25241448, 25241625, 25244807, 25248384, 25251648, 25257085 -25259611, 25262869, 25263960, 25265499, 25283790, 25287072, 25293659 -25296876, 25299227, 25299807, 25300427, 25303756, 25305405, 25307368 -25309116, 25313154, 25313411, 25316758, 25317989, 25320555, 25323525 -25328518, 25329664, 25335249, 25335360, 25335790, 25337332, 25337640 -25348956, 25353983, 25356118, 25357142, 25360661, 25362958, 25367588 -25367721, 25382812, 25383204, 25384462, 25386748, 25388896, 25392535 -25395696, 25397936, 25398306, 25404202, 25405100, 25405687, 25405813 -25410017, 25410180, 25410802, 25410877, 25411036, 25415713, 25417050 -25417056, 25417958, 25425451, 25425760, 25427662, 25429959, 25430120 -25433696, 25435038, 25437699, 25440818, 25442559, 25444961, 25445168 -25451531, 25455795, 25457409, 25459958, 25462714, 25463844, 25472112 -25476149, 25477657, 25478885, 25479164, 25482971, 25489342, 25489367 -25489607, 25492379, 25498930, 25498994, 25516250, 25524955, 25528838 -25530080, 25530814, 25535668, 25536819, 25537470, 25539063, 25540738 -25546580, 25546608, 25547901, 25551676, 25553616, 25554787, 25555252 -25557886, 25558986, 25560487, 25561296, 25569149, 25570929, 25575348 -25575369, 25575628, 25579458, 25579761, 25594901, 25597525, 25598473 -25599425, 25600342, 25600421, 25602488, 25603923, 25606091, 25607726 -25612095, 25614866, 25616268, 25616359, 25616417, 25616645, 25631933 -25633101, 25634317, 25634348, 25635149, 25638456, 25639019, 25643818 -25643889, 25643931, 25646373, 25647325, 25648731, 25653109, 25654459 -25654936, 25655390, 25655966, 25659655, 25660847, 25661819, 25662088 -25662101, 25662524, 25663488, 25669791, 25670786, 25671354, 25672640 -25674386, 25680221, 25685152, 25686739, 25687460, 25691904, 25694206 -25695903, 25699321, 25700654, 25709368, 25710420, 25715167, 25717371 -25722055, 25722608, 25722720, 25723158, 25728085, 25729507, 25734963 -25736747, 25739065, 25741955, 25743479, 25747569, 25749273, 25752755 -25754606, 25757748, 25760195, 25762221, 25764020, 25766822, 25768681 -25772669, 25774077, 25775213, 25780343, 25783447, 25784002, 25785331 -25785441, 25788879, 25789041, 25789277, 25789579, 25790353, 25792911 -25795865, 25797092, 25797124, 25797305, 25800464, 25802510, 25803545 -25807997, 25810263, 25810704, 25811650, 25813931, 25818707, 25822410 -25823754, 25825910, 25826740, 25830492, 25832935, 25834581, 25835365 -25838361, 25838755, 25852885, 25856821, 25858672, 25861398, 25865785 -25870579, 25871177, 25871639, 25871753, 25872127, 25872389, 25873336 -25874050, 25874678, 25882264, 25883438, 25885148, 25888073, 25888984 -25890056, 25890673, 25894239, 25895224, 25897615, 25904273, 25904490 -25906117, 25906886, 25908728, 25911724, 25914276, 25919622, 25932524 -25932728, 25933494, 25941836, 25943271, 25945130, 25947799, 25951571 -25953857, 25954022, 25954054, 25957038, 25963024, 25964954, 25967544 -25967985, 25970731, 25971286, 25973152, 25975723, 25977302, 25980605 -25980770, 25981498, 25982666, 25986062, 25990907, 25995938, 25997810 -26006257, 26007010, 26019148, 26024732, 26024784, 26025681, 26029075 -26029777, 26029780, 26032573, 26034119, 26036748, 26037215, 26038086 -26039623, 26040483, 26045732, 26051656, 26078437, 26078493, 26080410 -26083298, 26088426, 26088836, 26090767, 26091640, 26091786, 26095327 -26095405, 26096382, 26108080, 26108337, 26110259, 26110632, 26111842 -26112621, 26115103, 26121990, 26124078, 26137367, 26138085, 26149904 -26153977, 26168933, 26169341, 26169345, 26170659, 26170715, 26176002 -26187943, 26189861, 26198757, 26198926, 26201113, 26203182, 26223039 -26237338, 26237431, 26237773, 26238195, 26242031, 26243698, 26244115 -26245237, 26248143, 26249718, 26256131, 26257953, 26259265, 26261327 -26263328, 26263721, 26268756, 26269790, 26271001, 26275023, 26275415 -26277439, 26281476, 26285062, 26285933, 26308650, 26309047, 26317991 -26318627, 26323308, 26324206, 26324769, 26327624, 26330994, 26331743 -26333141, 26336977, 26338953, 26351334, 26353617, 26358670, 26359091 -26362155, 26362821, 26366517, 26367012, 26367460, 26371725, 26374791 -26375052, 26375250, 26380097, 26385189, 26388538, 26396790, 26399626 -26399691, 26406387, 26407408, 26412540, 26418088, 26420561, 26421667 -26422277, 26423085, 26426526, 26426967, 26430323, 26430737, 26434436 -26434999, 26435073, 26436168, 26438612, 26439748, 26440169, 26440749 -26442308, 26444601, 26444887, 26446098, 26452606, 26474662, 26474703 -26475419, 26476244, 26478970, 26479173, 26482376, 26486365, 26492866 -26493289, 26498354, 26513067, 26513709, 26521043, 26522439, 26523432 -26526726, 26526799, 26536320, 26537307, 26542135, 26542236, 26544823 -26545688, 26546070, 26546664, 26546754, 26548363, 26556014, 26569225 -26575788, 26580633, 26582460, 26584641, 26597140, 26599395, 26608137 -26608238, 26609942, 26615291, 26615690, 26617804, 26623652, 26626879 -26629381, 26633355, 26633558, 26635897, 26637273, 26637824, 26639167 -26641610, 26650226, 26654363, 26658759, 26659182, 26680105, 26712331 -26714486, 26714910, 26717528, 26725687, 26727397, 26729494, 26729611 -26740700, 26744595, 26745002, 26751106, 26751171, 26755171, 26758193 -26764561, 26765212, 26775602, 26784509, 26794786, 26797591, 26798516 -26802503, 26816582, 26820076, 26822620, 26828994, 26829845, 26833932 -26837702, 26840654, 26844406, 26844870, 26849779, 26875822, 26883456 -26895149, 26896659, 26898563, 26907327, 26908788, 26909100, 26909504 -26911000, 26939314, 26943004, 26944190, 26958896, 26963310, 26966616 -26966916, 26967713, 26969321, 26970175, 26970717, 26981902, 26983259 -26985002, 26986173, 26992964, 27006120, 27006664, 27009164, 27013146 -27028251, 27032785, 27034890, 27037839, 27038986, 27039712, 27044297 -27052607, 27058530, 27060167, 27060859, 27061736, 27073314, 27079140 -27087426, 27090765, 27092508, 27093423, 27097854, 27101105, 27105900 -27106179, 27110878, 27115422, 27117822, 27119621, 27122162, 27124624 -27125872, 27133662, 27134734, 27135647, 27135993, 27138325, 27142373 -27142529, 27151826, 27153641, 27161071, 27162390, 27162405, 27163928 -27165231, 27169796, 27170305, 27181537, 27181897, 27199245, 27200959 -27207110, 27208795, 27213224, 27216046, 27223075, 27229389, 27231051 -27236722, 27242226, 27244337, 27248917, 27249531, 27250547, 27251690 -27255377, 27256000, 27258578, 27259307, 27262945, 27266245, 27274456 -27274536, 27275533, 27276231, 27283960, 27284499, 27285244, 27288638 -27292213, 27293599, 27302711, 27302730, 27303287, 27304410, 27305039 -27308088, 27314206, 27314390, 27320576, 27321179, 27329612, 27333106 -27334316, 27338912, 27338946, 27339115, 27345231, 27346709, 27348081 -27349393, 27350267, 27351628, 27359178, 27364854, 27367194, 27370965 -27375542, 27381498, 27386467, 27394703, 27395416, 27396624, 27396672 -27396813, 27397048, 27400416, 27400598, 27404668, 27405645, 27416997 -27423251, 27424405, 27426363, 27432062, 27433870, 27434193, 27439835 -27441326, 27442041, 27445727, 27457891, 27466597, 27468303, 27493674 -27501373, 27501413, 27502420, 27504770, 27505229, 27508985, 27510959 -27525909, 27533819, 27534509, 27540613, 27544973, 27548131, 27554074 -27555481, 27558861, 27560602, 27562488, 27565906, 27567477, 27576342 -27593501, 27595973, 27607563, 27611612, 27613080, 27613530, 27617978 -27620808, 27629756, 27634676, 27634991, 27658186, 27666312, 27671633 -27680669, 27686599, 27687880, 27688036, 27688099, 27688692, 27691920 -27691939, 27693416, 27693713, 27695063, 27698953, 27700466, 27704237 -27709046, 27710072, 27726780, 27740424, 27748954, 27751755, 27757567 -27757888, 27758972, 27759077, 27793533, 27799032, 27801337, 27824540 -27824543, 27825241, 27829295, 27833672, 27834551, 27835925, 27846298 -27846499, 27847259, 27855490, 27861226, 27882176, 27898015, 27931299 -27940876, 27945870, 27951817, 27959048, 27959594, 27966472, 27986817 -27994325, 27995215, 27995248, 27997875, 27998003, 27999073, 27999638 -28000269, 28022101, 28023081, 28023399, 28023482, 28026866, 28033429 -28040776, 28045903, 28067846, 28072567, 28074713, 28090453, 28099662 -28108003, 28111583, 28120036, 28120951, 28124631, 28129791, 28140658 -28165439, 28171079, 28174827, 28180464, 28181021, 28184554, 28188330 -28194173, 28199085, 28201419, 28218832, 28220398, 28223871, 28226179 -28229360, 28236305, 28271119, 28279837, 28282606, 28290434, 28302049 -28305001, 28305362, 28320399, 28354603, 28357401, 28361221, 28365111 -28378446, 28390273, 28396445, 28420042, 28420457, 28423598, 28432129 -28434028, 28437315, 28454242, 28468312, 28483184, 28489150, 28501075 -28502343, 28507324, 28508053, 28508557, 28522441, 28528349, 28535272 -28545134, 28547068, 28571483, 28572834, 28578164, 28587723, 28600233 -28612674, 28617631, 28617959, 28621470, 28627255, 28636676, 28691965 -28692275, 28708023, 28728272, 28742555, 28749289, 28758722, 28774416 -28803345, 28819640, 28849751, 28852691, 28856060, 28891984, 28951382 -28956908, 28960211, 28965787, 28986231, 28987439, 28991884, 28993590 -29006527, 29024054, 29027694, 29032276, 29125374, 29158680, 29189889 -29200700, 29224605, 29250230, 29301463, 29339155, 29347943, 29376346 -29378913, 29379978, 29388020, 29405462, 29436454, 29437712, 29511611 -29542449, 29676089, 29690625, 29813494, 29836659 -``` - -## Version 12\.2\.0\.1\.ru\-2019\-04\.rur\-2019\-04\.r1 - -Version 12\.2\.0\.1\.ru\-2019\-04\.rur\-2019\-04\.r1 includes the following: -+ Patch 29314339: Database Apr 2019 Release Update: 12\.2\.0\.1\.190416 -+ Patch 29249637: OJVM RELEASE UPDATE: 12\.2\.0\.1\.190416 -+ Patch 28852325: DSTv33 for RDBMS \(TZDATA2018G\) -+ Patch 28852334: DSTv33 for OJVM \(TZDATA2018G\) -+ PreUpgrade Jar: preupgrade\_12201\_cbuild\_21\_lf\.zip -+ Patch 28423598: GOLDENGATE AUTH CAUSES ACTIVE DG TO BE UNUSABLE UNTIL BOUNCE -+ Patch 28730253: SUPPORT NEW ERA REIWA FOR JAPANESE IMPERIAL CALENDAR -+ Support for the package `rdsadmin_dbms_goldengate_auth`, which provides `GRANT` privileges needed by a GoldenGate administrator account \(see [Grant account privileges on the source DB](Appendix.OracleGoldenGate.md#Appendix.OracleGoldenGate.Source.Privileges)\) - -### Oracle release update 12\.2\.0\.1\.190416, released April 2019 - -Bugs fixed: - -``` -26362155, 28023399, 25741955, 25873336, 26966616, 27097854, 28617631 -28742555, 29006527, 8480838, 8932139, 12763598, 13554903, 14221306 -14690846, 15931756, 16002385, 16438495, 16727454, 16942578, 17027695 -17533661, 17947871, 18308268, 18521691, 18594510, 18774543, 18878420 -19072655, 19211433, 19285025, 19327292, 19526548, 19614243, 19647894 -19649997, 19702201, 19721304, 20003668, 20087519, 20118035, 20120236 -20324049, 20436508, 20532077, 20591151, 20617383, 20620169, 20736227 -20756305, 20866970, 20976443, 21089435, 21095391, 21143725, 21147908 -21159907, 21178363, 21186167, 21197098, 21216226, 21320338, 21433452 -21479706, 21520266, 21547051, 21638600, 21744603, 21882528, 21981529 -21985256, 22007324, 22070853, 22072543, 22087683, 22104866, 22179537 -22347493, 22364044, 22367053, 22379010, 22446455, 22495673, 22503283 -22503297, 22504793, 22530986, 22564336, 22568728, 22581771, 22594071 -22599050, 22628825, 22645009, 22654475, 22700845, 22726044, 22729345 -22826067, 22843979, 22845846, 22864303, 22898198, 22950945, 22970869 -22981722, 23019710, 23026585, 23035249, 23055900, 23061453, 23065002 -23066146, 23080557, 23104033, 23105538, 23110523, 23125560, 23126545 -23127945, 23151677, 23179662, 23184263, 23197730, 23234232, 23237091 -23249829, 23271203, 23278750, 23300142, 23310101, 23312077, 23328639 -23336559, 23481673, 23491861, 23499004, 23499160, 23521523, 23527363 -23533647, 23548817, 23567857, 23572982, 23581777, 23588722, 23599216 -23600861, 23602213, 23645516, 23665623, 23709062, 23715460, 23715518 -23730961, 23733981, 23735292, 23741944, 23746128, 23749454, 23761724 -24010030, 24289874, 24294174, 24303148, 24307571, 24308349, 24326444 -24326846, 24328857, 24332831, 24334708, 24336249, 24337882, 24341675 -24343905, 24345420, 24346821, 24348685, 24350620, 24352981, 24368004 -24371491, 24373756, 24374976, 24376875, 24376878, 24385983, 24401351 -24403922, 24415926, 24421668, 24423416, 24425056, 24425998, 24435982 -24437162, 24443539, 24457597, 24460392, 24461826, 24467122, 24468470 -24470606, 24471473, 24473736, 24485034, 24485161, 24485174, 24486059 -24486237, 24509056, 24534401, 24554533, 24555417, 24556967, 24560906 -24563422, 24570214, 24570598, 24573817, 24578718, 24578797, 24589081 -24589590, 24593740, 24595699, 24600330, 24609592, 24609996, 24611527 -24616637, 24617969, 24623975, 24624166, 24642495, 24654629, 24655717 -24664211, 24668398, 24669189, 24674197, 24674955, 24676172, 24677696 -24680959, 24689376, 24692973, 24693290, 24697323, 24699619, 24710696 -24713381, 24714096, 24717183, 24717859, 24718260, 24719799, 24735430 -24737064, 24737403, 24737581, 24744383, 24744686, 24757934, 24759556 -24760407, 24764085, 24766309, 24786669, 24792678, 24793511, 24796092 -24797119, 24800423, 24801152, 24802934, 24811725, 24812047, 24827228 -24827654, 24831514, 24835919, 24843188, 24844549, 24845157, 24848746 -24848923, 24850622, 24907917, 24908321, 24911709, 24912588, 24922704 -24923080, 24923215, 24923338, 24923790, 24924667, 24926999, 24929210 -24938784, 24940060, 24942749, 24953434, 24957555, 24960044, 24966594 -24966788, 24968162, 24976007, 24978100, 25022574, 25027852, 25028996 -25029022, 25029423, 25032818, 25034396, 25036474, 25042823, 25044977 -25045228, 25050160, 25051628, 25057811, 25058080, 25062592, 25063971 -25065563, 25072986, 25078611, 25086233, 25087436, 25093872, 25098160 -25099339, 25099497, 25099758, 25100063, 25100579, 25103996, 25107662 -25110233, 25114561, 25120284, 25120668, 25120742, 25121089, 25123585 -25124363, 25129925, 25140197, 25145163, 25145215, 25150925, 25159176 -25162645, 25164293, 25166187, 25171084, 25175723, 25176408, 25178032 -25178101, 25178179, 25179774, 25182817, 25184555, 25186079, 25191872 -25192044, 25192729, 25199585, 25201454, 25202355, 25203656, 25206864 -25207410, 25209912, 25210268, 25210499, 25211628, 25223839, 25224242 -25225795, 25226665, 25227381, 25230870, 25230945, 25237577, 25240188 -25240590, 25241448, 25241625, 25244807, 25248384, 25251648, 25257085 -25259611, 25262869, 25263960, 25265499, 25283790, 25287072, 25293659 -25296876, 25299227, 25299807, 25300427, 25303756, 25305405, 25307368 -25309116, 25313154, 25313411, 25316758, 25317989, 25320555, 25323525 -25328518, 25329664, 25335249, 25335360, 25335790, 25337332, 25337640 -25348956, 25353983, 25356118, 25357142, 25362958, 25367588, 25367721 -25382812, 25383204, 25384462, 25386748, 25388896, 25392535, 25395696 -25397936, 25398306, 25404202, 25405100, 25405687, 25405813, 25410017 -25410180, 25410802, 25410877, 25411036, 25417050, 25417056, 25417958 -25425451, 25425760, 25427662, 25429959, 25430120, 25433696, 25435038 -25437699, 25440818, 25442559, 25444961, 25445168, 25451531, 25455795 -25457409, 25459958, 25462714, 25463844, 25472112, 25476149, 25477657 -25478885, 25479164, 25489342, 25489367, 25489607, 25492379, 25498930 -25498994, 25516250, 25524955, 25528838, 25530080, 25530814, 25535668 -25536819, 25537470, 25539063, 25540738, 25546580, 25546608, 25547901 -25551676, 25553616, 25554787, 25555252, 25557886, 25558986, 25560487 -25561296, 25569149, 25570929, 25575348, 25575628, 25579458, 25579761 -25594901, 25597525, 25598473, 25599425, 25600342, 25600421, 25602488 -25603923, 25606091, 25607726, 25612095, 25614866, 25616268, 25616359 -25616417, 25616645, 25631933, 25633101, 25634317, 25634348, 25635149 -25638456, 25639019, 25643818, 25643931, 25646373, 25647325, 25648731 -25653109, 25654459, 25654936, 25655390, 25655966, 25659655, 25660847 -25661819, 25662088, 25662101, 25662524, 25663488, 25669791, 25670786 -25671354, 25672640, 25674386, 25680221, 25685152, 25686739, 25687460 -25691904, 25694206, 25695903, 25700654, 25710420, 25715167, 25717371 -25722055, 25722608, 25722720, 25728085, 25729507, 25734963, 25736747 -25739065, 25743479, 25754606, 25757748, 25760195, 25762221, 25764020 -25766822, 25768681, 25772669, 25774077, 25775213, 25780343, 25783447 -25784002, 25785331, 25785441, 25788879, 25789041, 25789277, 25789579 -25790353, 25795865, 25797092, 25797124, 25797305, 25800464, 25802510 -25803545, 25807997, 25810704, 25813931, 25818707, 25822410, 25823754 -25825910, 25826740, 25830492, 25832935, 25834581, 25838361, 25852885 -25856821, 25858672, 25861398, 25865785, 25870579, 25871177, 25871639 -25871753, 25872127, 25872389, 25874050, 25874678, 25882264, 25883438 -25885148, 25888073, 25890056, 25890673, 25894239, 25895224, 25897615 -25904273, 25904490, 25906117, 25908728, 25911724, 25914276, 25919622 -25932524, 25932728, 25933494, 25941836, 25943271, 25945130, 25947799 -25953857, 25954022, 25954054, 25957038, 25963024, 25964954, 25967544 -25967985, 25970731, 25971286, 25973152, 25975723, 25977302, 25980605 -25980770, 25981498, 25982666, 25986062, 25990907, 25995938, 26006257 -26007010, 26019148, 26024732, 26025681, 26029075, 26029777, 26029780 -26032573, 26034119, 26036748, 26037215, 26038086, 26039623, 26040483 -26045732, 26051656, 26078437, 26078493, 26080410, 26083298, 26088426 -26088836, 26090767, 26091640, 26091786, 26095327, 26095405, 26096382 -26108080, 26108337, 26110259, 26110632, 26111842, 26112621, 26115103 -26121990, 26124078, 26137367, 26138085, 26149904, 26153977, 26169341 -26169345, 26170715, 26176002, 26187943, 26189861, 26198757, 26198926 -26201113, 26203182, 26223039, 26237431, 26237773, 26238195, 26242031 -26243698, 26244115, 26245237, 26248143, 26249718, 26256131, 26259265 -26261327, 26263328, 26263721, 26269790, 26271001, 26277439, 26285062 -26285933, 26308650, 26309047, 26318627, 26323308, 26324206, 26324769 -26327624, 26330994, 26331743, 26333141, 26336977, 26338953, 26351334 -26353617, 26358670, 26359091, 26362821, 26366517, 26367012, 26367460 -26371725, 26374791, 26375250, 26380097, 26385189, 26388538, 26396790 -26399626, 26399691, 26406387, 26407408, 26412540, 26418088, 26420561 -26421667, 26422277, 26423085, 26426526, 26426967, 26430323, 26430737 -26434436, 26434999, 26435073, 26436168, 26438612, 26439748, 26440169 -26440749, 26442308, 26444601, 26444887, 26446098, 26452606, 26474703 -26475419, 26476244, 26478970, 26479173, 26486365, 26492866, 26493289 -26498354, 26513709, 26521043, 26522439, 26523432, 26526726, 26526799 -26536320, 26537307, 26542135, 26544823, 26545688, 26546070, 26546664 -26546754, 26548363, 26556014, 26569225, 26575788, 26580633, 26582460 -26584641, 26597140, 26599395, 26608137, 26608238, 26609942, 26615291 -26615690, 26617804, 26623652, 26626879, 26629381, 26633355, 26633558 -26635897, 26637273, 26637824, 26639167, 26641610, 26650226, 26654363 -26658759, 26659182, 26680105, 26712331, 26714486, 26714910, 26717528 -26725687, 26727397, 26729494, 26729611, 26740700, 26744595, 26745002 -26751106, 26751171, 26755171, 26758193, 26764561, 26765212, 26775602 -26784509, 26794786, 26797591, 26798516, 26802503, 26816582, 26820076 -26822620, 26828994, 26829845, 26833932, 26837702, 26840654, 26844406 -26844870, 26849779, 26875822, 26883456, 26895149, 26896659, 26898563 -26907327, 26908788, 26909100, 26909504, 26911000, 26939314, 26944190 -26958896, 26963310, 26966916, 26967713, 26969321, 26970175, 26970717 -26981902, 26983259, 26986173, 26992964, 27006120, 27006664, 27009164 -27013146, 27028251, 27034890, 27037839, 27038986, 27039712, 27044297 -27052607, 27058530, 27060167, 27060859, 27061736, 27073314, 27079140 -27087426, 27090765, 27093423, 27106179, 27110878, 27115422, 27117822 -27119621, 27122162, 27124624, 27125872, 27133662, 27135647, 27135993 -27138325, 27142373, 27142529, 27151826, 27153641, 27161071, 27162390 -27162405, 27163928, 27165231, 27169796, 27170305, 27181537, 27181897 -27199245, 27200959, 27207110, 27208795, 27213224, 27216046, 27223075 -27229389, 27231051, 27236722, 27242226, 27244337, 27248917, 27250547 -27251690, 27255377, 27256000, 27258578, 27259307, 27262945, 27266245 -27274456, 27274536, 27275533, 27276231, 27283960, 27284499, 27285244 -27288638, 27292213, 27293599, 27302711, 27302730, 27304410, 27305039 -27314206, 27314390, 27320576, 27321179, 27329612, 27333106, 27334316 -27338912, 27338946, 27339115, 27345231, 27346709, 27348081, 27349393 -27350267, 27351628, 27359178, 27364854, 27367194, 27370965, 27375542 -27381498, 27386467, 27394703, 27395416, 27396624, 27396672, 27396813 -27397048, 27400416, 27400598, 27404668, 27405645, 27416997, 27423251 -27424405, 27426363, 27432062, 27433870, 27434193, 27439835, 27441326 -27442041, 27445727, 27457891, 27466597, 27493674, 27501373, 27501413 -27502420, 27504770, 27505229, 27508985, 27510959, 27525909, 27534509 -27540613, 27544973, 27548131, 27554074, 27555481, 27558861, 27560602 -27562488, 27565906, 27567477, 27593501, 27595973, 27607563, 27611612 -27613080, 27613530, 27617978, 27620808, 27634676, 27634991, 27658186 -27666312, 27671633, 27680669, 27686599, 27687880, 27688036, 27688099 -27688692, 27691920, 27691939, 27693713, 27695063, 27698953, 27700466 -27704237, 27709046, 27726780, 27740424, 27748954, 27751755, 27757567 -27757888, 27758972, 27759077, 27793533, 27799032, 27801337, 27824543 -27825241, 27829295, 27833672, 27834551, 27835925, 27847259, 27855490 -27882176, 27898015, 27931299, 27940876, 27945870, 27951817, 27959048 -27966472, 27986817, 27994325, 27995215, 27995248, 27997875, 27998003 -27999638, 28000269, 28022101, 28023081, 28023482, 28033429, 28040776 -28045903, 28067846, 28072567, 28074713, 28090453, 28099662, 28108003 -28111583, 28120036, 28120951, 28140658, 28171079, 28174827, 28180464 -28184554, 28188330, 28194173, 28199085, 28218832, 28220398, 28223871 -28226179, 28229360, 28279837, 28282606, 28290434, 28302049, 28305001 -28305362, 28320399, 28354603, 28361221, 28365111, 28378446, 28390273 -28396445, 28420042, 28420457, 28432129, 28434028, 28437315, 28454242 -28468312, 28483184, 28489150, 28502343, 28507324, 28508053, 28508557 -28522441, 28528349, 28535272, 28545134, 28571483, 28578164, 28587723 -28600233, 28617959, 28621470, 28627255, 28636676, 28691965, 28708023 -28728272, 28749289, 28803345, 28849751, 28852691, 28856060, 28891984 -28951382, 28960211, 28987439, 28991884, 28993590, 29027694, 29189889 -29250230 -``` - -## Version 12\.2\.0\.1\.ru\-2019\-01\.rur\-2019\-01\.r1 - -Version 12\.2\.0\.1\.ru\-2019\-01\.rur\-2019\-01\.r1 includes the following: -+ Patch 28822515: Database Jan 2019 Release Update: 12\.2\.0\.1\.190115 -+ Patch 28790651: OJVM RELEASE UPDATE: 12\.2\.0\.1\.190115 -+ Patch 28125601: DSTv32 for RDBMS \(TZDATA2018E\) -+ Patch 28127287: DSTv32 for OJVM \(TZDATA2018E\) -+ PreUpgrade Jar: preupgrade\_12201\_cbuild\_19\_lf\.zip - -### Oracle release update 12\.2\.0\.1\.190115, released January 2019 - -Bugs fixed: - -``` -26285062, 8480838, 8932139, 13554903, 14221306, 14690846, 15931756 -16002385, 16438495, 16727454, 16942578, 17027695, 17533661, 17947871 -18308268, 18521691, 18594510, 18774543, 19072655, 19211433, 19285025 -19327292, 19526548, 19614243, 19647894, 19649997, 19721304, 20003668 -20087519, 20118035, 20120236, 20324049, 20436508, 20532077, 20591151 -20620169, 20736227, 20756305, 20866970, 20976443, 21095391, 21143725 -21147908, 21159907, 21178363, 21186167, 21197098, 21216226, 21320338 -21433452, 21479706, 21520266, 21547051, 21744603, 21882528, 21981529 -21985256, 22007324, 22070853, 22072543, 22087683, 22104866, 22179537 -22347493, 22364044, 22367053, 22379010, 22446455, 22495673, 22503283 -22503297, 22504793, 22530986, 22564336, 22568728, 22581771, 22594071 -22599050, 22628825, 22645009, 22654475, 22700845, 22729345, 22826067 -22843979, 22845846, 22864303, 22898198, 22950945, 22970869, 22981722 -23019710, 23026585, 23035249, 23055900, 23061453, 23065002, 23066146 -23080557, 23104033, 23105538, 23110523, 23125560, 23126545, 23127945 -23151677, 23179662, 23184263, 23197730, 23234232, 23249829, 23271203 -23300142, 23310101, 23312077, 23481673, 23491861, 23499004, 23499160 -23521523, 23527363, 23533647, 23548817, 23567857, 23572982, 23581777 -23588722, 23599216, 23600861, 23602213, 23645516, 23665623, 23709062 -23715460, 23730961, 23733981, 23735292, 23741944, 23746128, 23749454 -23761724, 24010030, 24289874, 24294174, 24303148, 24307571, 24308349 -24326444, 24326846, 24332831, 24334708, 24336249, 24337882, 24341675 -24343905, 24345420, 24346821, 24348685, 24350620, 24352981, 24368004 -24371491, 24373756, 24374976, 24376875, 24376878, 24385983, 24401351 -24403922, 24415926, 24421668, 24423416, 24425056, 24425998, 24435982 -24437162, 24443539, 24457597, 24460392, 24461826, 24467122, 24468470 -24470606, 24471473, 24473736, 24485034, 24485161, 24485174, 24486059 -24486237, 24509056, 24534401, 24554533, 24555417, 24556967, 24560906 -24563422, 24570214, 24570598, 24573817, 24578718, 24578797, 24589081 -24589590, 24593740, 24595699, 24600330, 24609592, 24609996, 24616637 -24617969, 24623975, 24624166, 24642495, 24654629, 24655717, 24664211 -24668398, 24669189, 24674197, 24674955, 24676172, 24677696, 24680959 -24689376, 24692973, 24693290, 24697323, 24699619, 24710696, 24713381 -24714096, 24717183, 24717859, 24718260, 24719799, 24735430, 24737064 -24737403, 24737581, 24744383, 24744686, 24757934, 24759556, 24760407 -24764085, 24766309, 24786669, 24792678, 24793511, 24796092, 24797119 -24800423, 24801152, 24802934, 24811725, 24812047, 24827228, 24827654 -24831514, 24835919, 24843188, 24844549, 24845157, 24848746, 24848923 -24850622, 24907917, 24908321, 24911709, 24912588, 24922704, 24923080 -24923215, 24923338, 24923790, 24929210, 24938784, 24940060, 24942749 -24953434, 24957555, 24960044, 24966594, 24966788, 24968162, 24976007 -24978100, 25022574, 25027852, 25028996, 25029022, 25029423, 25034396 -25036474, 25044977, 25045228, 25050160, 25051628, 25057811, 25058080 -25062592, 25063971, 25065563, 25072986, 25078611, 25086233, 25087436 -25093872, 25098160, 25099339, 25099497, 25099758, 25100063, 25100579 -25103996, 25107662, 25110233, 25114561, 25120284, 25120668, 25120742 -25121089, 25123585, 25124363, 25129925, 25140197, 25145163, 25145215 -25150925, 25159176, 25162645, 25164293, 25166187, 25171084, 25175723 -25176408, 25178032, 25178101, 25178179, 25179774, 25182817, 25184555 -25186079, 25191872, 25192044, 25192729, 25199585, 25201454, 25202355 -25203656, 25206864, 25207410, 25209912, 25210268, 25210499, 25211628 -25223839, 25224242, 25225795, 25226665, 25227381, 25230870, 25230945 -25237577, 25240188, 25240590, 25241448, 25241625, 25244807, 25248384 -25251648, 25257085, 25259611, 25262869, 25263960, 25265499, 25283790 -25287072, 25296876, 25299227, 25299807, 25300427, 25305405, 25307368 -25309116, 25313154, 25313411, 25316758, 25317989, 25320555, 25323525 -25328518, 25329664, 25335249, 25335360, 25335790, 25337332, 25337640 -25348956, 25353983, 25356118, 25357142, 25362958, 25382812, 25383204 -25384462, 25386748, 25388896, 25392535, 25395696, 25397936, 25405813 -25410017, 25410180, 25410802, 25410877, 25411036, 25417050, 25417056 -25417958, 25425451, 25425760, 25427662, 25429959, 25430120, 25433696 -25435038, 25437699, 25440818, 25444961, 25445168, 25451531, 25455795 -25457409, 25459958, 25462714, 25463844, 25472112, 25476149, 25478885 -25479164, 25489342, 25489367, 25489607, 25492379, 25498930, 25498994 -25516250, 25524955, 25528838, 25530080, 25530814, 25535668, 25536819 -25537470, 25539063, 25540738, 25546580, 25546608, 25547901, 25551676 -25553616, 25554787, 25555252, 25557886, 25558986, 25560487, 25561296 -25569149, 25570929, 25575348, 25575628, 25579458, 25579761, 25594901 -25597525, 25598473, 25599425, 25600342, 25600421, 25602488, 25603923 -25606091, 25607726, 25612095, 25614866, 25616268, 25616359, 25616417 -25616645, 25631933, 25633101, 25634317, 25634348, 25635149, 25638456 -25639019, 25643818, 25643931, 25646373, 25647325, 25648731, 25653109 -25654459, 25654936, 25655390, 25655966, 25659655, 25660847, 25661819 -25662088, 25662101, 25662524, 25669791, 25670786, 25671354, 25672640 -25674386, 25680221, 25685152, 25686739, 25687460, 25691904, 25694206 -25695903, 25700654, 25710420, 25715167, 25717371, 25722055, 25722608 -25722720, 25728085, 25729507, 25734963, 25736747, 25739065, 25754606 -25757748, 25760195, 25762221, 25764020, 25766822, 25768681, 25772669 -25774077, 25775213, 25780343, 25784002, 25785331, 25785441, 25788879 -25789041, 25789277, 25789579, 25790353, 25797092, 25797124, 25797305 -25800464, 25802510, 25803545, 25807997, 25810704, 25813931, 25818707 -25822410, 25823754, 25825910, 25826740, 25830492, 25832935, 25834581 -25838361, 25852885, 25856821, 25858672, 25861398, 25865785, 25870579 -25871177, 25871639, 25871753, 25872127, 25872389, 25874050, 25874678 -25882264, 25885148, 25888073, 25890056, 25890673, 25894239, 25895224 -25897615, 25904273, 25904490, 25906117, 25911724, 25914276, 25919622 -25932524, 25932728, 25933494, 25941836, 25943271, 25945130, 25947799 -25953857, 25954022, 25954054, 25957038, 25963024, 25964954, 25967544 -25967985, 25970731, 25973152, 25975723, 25977302, 25980605, 25980770 -25981498, 25982666, 25990907, 25995938, 26006257, 26007010, 26019148 -26024732, 26025681, 26029780, 26032573, 26034119, 26036748, 26037215 -26038086, 26039623, 26040483, 26045732, 26078437, 26078493, 26080410 -26083298, 26088426, 26088836, 26090767, 26091640, 26091786, 26095327 -26095405, 26096382, 26108080, 26108337, 26110632, 26111842, 26112621 -26115103, 26121990, 26124078, 26137367, 26138085, 26149904, 26153977 -26169341, 26169345, 26170715, 26176002, 26187943, 26189861, 26198757 -26198926, 26201113, 26203182, 26223039, 26237431, 26237773, 26238195 -26242031, 26243698, 26244115, 26245237, 26248143, 26249718, 26256131 -26259265, 26261327, 26263328, 26263721, 26269790, 26271001, 26277439 -26285933, 26308650, 26309047, 26318627, 26323308, 26324769, 26327624 -26330994, 26331743, 26333141, 26336977, 26338953, 26351334, 26353617 -26358670, 26359091, 26362821, 26366517, 26367012, 26371725, 26374791 -26375250, 26380097, 26385189, 26388538, 26396790, 26399626, 26399691 -26406387, 26407408, 26412540, 26418088, 26420561, 26421667, 26422277 -26423085, 26426526, 26426967, 26430737, 26434436, 26434999, 26435073 -26436168, 26438612, 26440749, 26442308, 26444601, 26444887, 26446098 -26452606, 26474703, 26475419, 26476244, 26478970, 26479173, 26486365 -26492866, 26493289, 26498354, 26513709, 26521043, 26522439, 26523432 -26526726, 26536320, 26537307, 26542135, 26544823, 26545688, 26546070 -26546664, 26546754, 26548363, 26556014, 26569225, 26575788, 26580633 -26582460, 26584641, 26597140, 26599395, 26608137, 26609942, 26615291 -26615690, 26623652, 26626879, 26629381, 26633355, 26633558, 26635897 -26637273, 26637824, 26639167, 26641610, 26650226, 26658759, 26659182 -26680105, 26712331, 26714486, 26714910, 26717528, 26725687, 26727397 -26729494, 26729611, 26740700, 26744595, 26745002, 26751106, 26751171 -26755171, 26758193, 26764561, 26765212, 26775602, 26784509, 26794786 -26797591, 26798516, 26802503, 26820076, 26822620, 26828994, 26840654 -26844406, 26844870, 26849779, 26875822, 26883456, 26895149, 26896659 -26898563, 26907327, 26908788, 26909100, 26909504, 26911000, 26939314 -26944190, 26958896, 26963310, 26966916, 26967713, 26969321, 26970717 -26981902, 26983259, 26986173, 26992964, 27006664, 27009164, 27013146 -27028251, 27034890, 27037839, 27038986, 27039712, 27044297, 27052607 -27058530, 27060167, 27060859, 27073314, 27079140, 27087426, 27090765 -27093423, 27110878, 27117822, 27119621, 27122162, 27124624, 27125872 -27133662, 27135647, 27135993, 27138325, 27142373, 27142529, 27151826 -27153641, 27161071, 27162405, 27163928, 27165231, 27169796, 27170305 -27181537, 27181897, 27199245, 27200959, 27207110, 27213224, 27223075 -27229389, 27236722, 27244337, 27248917, 27250547, 27251690, 27255377 -27256000, 27258578, 27259307, 27262945, 27266245, 27274456, 27274536 -27276231, 27283960, 27285244, 27292213, 27293599, 27302711, 27302730 -27304410, 27305039, 27314206, 27314390, 27320576, 27321179, 27329612 -27333106, 27334316, 27338912, 27338946, 27339115, 27345231, 27346709 -27348081, 27349393, 27351628, 27359178, 27367194, 27370965, 27375542 -27381498, 27386467, 27394703, 27395416, 27396624, 27396813, 27397048 -27400416, 27400598, 27404668, 27405645, 27416997, 27433870, 27434193 -27439835, 27441326, 27442041, 27445727, 27466597, 27493674, 27501373 -27501413, 27502420, 27504770, 27505229, 27508985, 27510959, 27525909 -27534509, 27540613, 27544973, 27548131, 27555481, 27558861, 27560602 -27567477, 27593501, 27595973, 27607563, 27611612, 27613080, 27613530 -27617978, 27620808, 27634676, 27658186, 27687880, 27688036, 27688099 -27688692, 27691920, 27691939, 27693713, 27695063, 27698953, 27700466 -27709046, 27726780, 27740424, 27748954, 27757888, 27759077, 27793533 -27799032, 27801337, 27835925, 27847259, 27855490, 27882176, 27898015 -27931299, 27940876, 27945870, 27951817, 27959048, 27994325, 27995248 -27997875, 27998003, 27999638, 28000269, 28022101, 28023081, 28023482 -28033429, 28040776, 28067846, 28072567, 28074713, 28090453, 28099662 -28111583, 28120951, 28140658, 28171079, 28174827, 28180464, 28184554 -28188330, 28194173, 28218832, 28220398, 28226179, 28229360, 28282606 -28290434, 28302049, 28305001, 28305362, 28320399, 28354603, 28361221 -28365111, 28390273, 28396445, 28420042, 28420457, 28434028, 28437315 -28454242, 28483184, 28489150, 28502343, 28508053, 28508557, 28522441 -28528349, 28535272, 28571483, 28617959, 28621470, 28627255, 28636676 -28691965, 28708023, 28728272, 28749289, 28960211, 28993590 -``` - -## Version 12\.2\.0\.1\.ru\-2018\-10\.rur\-2018\-10\.r1 - -Version 12\.2\.0\.1\.ru\-2018\-10\.rur\-2018\-10\.r1 includes the following: -+ October 2018 Release Update: 12\.2\.0\.1\.181016 \(28662603\) - -### Oracle release update 12\.2\.0\.1\.181016, released October 2018 - -Bugs fixed: - -``` -28390273, 28571483, 28483184, 8480838, 13554903, 14221306, 14690846 -15931756, 16002385, 16438495, 16727454, 16942578, 17027695, 17533661 -17947871, 18308268, 18521691, 18594510, 18774543, 19072655, 19211433 -19285025, 19327292, 19526548, 19614243, 19647894, 19649997, 19721304 -20003668, 20087519, 20118035, 20120236, 20324049, 20436508, 20532077 -20591151, 20620169, 20736227, 20756305, 20866970, 20976443, 21143725 -21147908, 21159907, 21178363, 21186167, 21216226, 21320338, 21433452 -21479706, 21520266, 21547051, 21744603, 21882528, 21981529, 21985256 -22007324, 22070853, 22072543, 22087683, 22104866, 22179537, 22347493 -22364044, 22367053, 22379010, 22446455, 22495673, 22503283, 22503297 -22504793, 22530986, 22564336, 22568728, 22581771, 22594071, 22599050 -22628825, 22645009, 22654475, 22700845, 22729345, 22826067, 22843979 -22845846, 22864303, 22898198, 22950945, 22970869, 22981722, 23019710 -23026585, 23035249, 23055900, 23061453, 23065002, 23066146, 23080557 -23105538, 23110523, 23125560, 23126545, 23127945, 23151677, 23179662 -23184263, 23197730, 23234232, 23249829, 23271203, 23300142, 23310101 -23312077, 23481673, 23491861, 23499160, 23521523, 23527363, 23533647 -23548817, 23567857, 23572982, 23581777, 23588722, 23599216, 23600861 -23602213, 23645516, 23665623, 23709062, 23715460, 23730961, 23733981 -23735292, 23741944, 23746128, 23749454, 24010030, 24289874, 24294174 -24303148, 24307571, 24308349, 24326444, 24326846, 24332831, 24334708 -24336249, 24337882, 24341675, 24343905, 24345420, 24346821, 24348685 -24350620, 24368004, 24371491, 24373756, 24374976, 24376875, 24376878 -24385983, 24401351, 24403922, 24415926, 24421668, 24423416, 24425056 -24425998, 24435982, 24437162, 24443539, 24457597, 24461826, 24467122 -24468470, 24470606, 24473736, 24485034, 24485161, 24485174, 24486059 -24486237, 24509056, 24534401, 24554533, 24555417, 24556967, 24560906 -24563422, 24570598, 24573817, 24578718, 24578797, 24589081, 24589590 -24593740, 24595699, 24600330, 24609592, 24609996, 24616637, 24617969 -24623975, 24624166, 24642495, 24654629, 24655717, 24664211, 24668398 -24674197, 24674955, 24676172, 24677696, 24680959, 24689376, 24692973 -24693290, 24699619, 24710696, 24713381, 24714096, 24717183, 24717859 -24718260, 24719799, 24735430, 24737064, 24737403, 24737581, 24744383 -24744686, 24757934, 24759556, 24760407, 24766309, 24786669, 24792678 -24793511, 24796092, 24797119, 24800423, 24801152, 24802934, 24811725 -24812047, 24827228, 24827654, 24831514, 24835919, 24843188, 24844549 -24845157, 24848746, 24848923, 24850622, 24907917, 24908321, 24911709 -24912588, 24922704, 24923080, 24923215, 24923338, 24923790, 24929210 -24938784, 24940060, 24942749, 24953434, 24957555, 24960044, 24966594 -24966788, 24968162, 24976007, 24978100, 25027852, 25029022, 25029423 -25034396, 25036474, 25044977, 25045228, 25050160, 25051628, 25057811 -25058080, 25062592, 25063971, 25065563, 25072986, 25078611, 25086233 -25087436, 25093872, 25098160, 25099339, 25099497, 25099758, 25100063 -25100579, 25103996, 25107662, 25110233, 25120284, 25120742, 25121089 -25123585, 25124363, 25129925, 25140197, 25145163, 25145215, 25150925 -25159176, 25162645, 25164293, 25166187, 25171084, 25175723, 25176408 -25178032, 25178101, 25178179, 25179774, 25182817, 25184555, 25186079 -25191872, 25192044, 25192729, 25199585, 25201454, 25202355, 25203656 -25206864, 25207410, 25209912, 25210268, 25210499, 25211628, 25223839 -25224242, 25225795, 25226665, 25227381, 25230945, 25237577, 25240590 -25241448, 25241625, 25244807, 25248384, 25251648, 25257085, 25259611 -25262869, 25263960, 25265499, 25283790, 25287072, 25296876, 25299227 -25299807, 25300427, 25305405, 25307368, 25309116, 25313154, 25313411 -25316758, 25317989, 25320555, 25323525, 25328518, 25329664, 25335249 -25335360, 25335790, 25337332, 25337640, 25348956, 25353983, 25357142 -25362958, 25382812, 25383204, 25384462, 25386748, 25388896, 25392535 -25395696, 25397936, 25405813, 25410017, 25410180, 25410802, 25410877 -25411036, 25417050, 25417056, 25417958, 25425451, 25425760, 25427662 -25429959, 25430120, 25433696, 25435038, 25437699, 25440818, 25444961 -25451531, 25455795, 25457409, 25459958, 25462714, 25463844, 25472112 -25476149, 25478885, 25479164, 25489342, 25489367, 25489607, 25492379 -25498930, 25498994, 25516250, 25524955, 25528838, 25530080, 25530814 -25535668, 25536819, 25537470, 25539063, 25540738, 25546580, 25546608 -25547901, 25551676, 25553616, 25554787, 25555252, 25557886, 25558986 -25560487, 25561296, 25569149, 25570929, 25575348, 25575628, 25579458 -25579761, 25594901, 25597525, 25598473, 25600342, 25600421, 25602488 -25603923, 25606091, 25607726, 25612095, 25614866, 25616268, 25616359 -25616417, 25616645, 25631933, 25633101, 25634317, 25634348, 25635149 -25638456, 25639019, 25643818, 25643931, 25646373, 25647325, 25648731 -25653109, 25654459, 25654936, 25655390, 25655966, 25659655, 25660847 -25661819, 25662088, 25662101, 25662524, 25669791, 25670786, 25672640 -25674386, 25680221, 25685152, 25686739, 25687460, 25691904, 25694206 -25695903, 25700654, 25710420, 25715167, 25717371, 25722055, 25722608 -25722720, 25728085, 25729507, 25734963, 25736747, 25739065, 25754606 -25757748, 25760195, 25762221, 25764020, 25766822, 25768681, 25772669 -25774077, 25775213, 25780343, 25784002, 25785331, 25785441, 25788879 -25789041, 25789277, 25789579, 25790353, 25797092, 25797124, 25797305 -25800464, 25803545, 25807997, 25810704, 25813931, 25818707, 25822410 -25823754, 25825910, 25826740, 25830492, 25832935, 25834581, 25838361 -25852885, 25856821, 25858672, 25861398, 25865785, 25870579, 25871177 -25871639, 25871753, 25872127, 25872389, 25874050, 25874678, 25882264 -25885148, 25888073, 25890056, 25890673, 25894239, 25895224, 25897615 -25904273, 25904490, 25906117, 25911724, 25914276, 25919622, 25932524 -25932728, 25933494, 25941836, 25943271, 25945130, 25947799, 25953857 -25954022, 25954054, 25957038, 25963024, 25964954, 25967544, 25967985 -25970731, 25973152, 25975723, 25977302, 25980605, 25980770, 25981498 -25982666, 25990907, 25995938, 26006257, 26007010, 26019148, 26024732 -26025681, 26029780, 26032573, 26036748, 26037215, 26038086, 26039623 -26040483, 26045732, 26078437, 26078493, 26080410, 26083298, 26088426 -26088836, 26090767, 26091640, 26091786, 26095327, 26095405, 26096382 -26108080, 26110632, 26111842, 26121990, 26137367, 26138085, 26149904 -26153977, 26169341, 26169345, 26170715, 26176002, 26187943, 26189861 -26198757, 26198926, 26201113, 26223039, 26237431, 26237773, 26242031 -26243698, 26244115, 26245237, 26249718, 26256131, 26259265, 26261327 -26263328, 26263721, 26269790, 26271001, 26277439, 26285933, 26308650 -26309047, 26318627, 26323308, 26324769, 26327624, 26330994, 26331743 -26333141, 26338953, 26351334, 26353617, 26358670, 26362821, 26366517 -26367012, 26374791, 26375250, 26380097, 26385189, 26388538, 26396790 -26399626, 26399691, 26406387, 26412540, 26418088, 26420561, 26421667 -26422277, 26426526, 26430737, 26434999, 26435073, 26436168, 26438612 -26440749, 26442308, 26444601, 26444887, 26446098, 26452606, 26475419 -26476244, 26478970, 26479173, 26486365, 26492866, 26493289, 26498354 -26513709, 26521043, 26522439, 26523432, 26526726, 26536320, 26537307 -26542135, 26544823, 26545688, 26546070, 26546664, 26546754, 26548363 -26556014, 26569225, 26575788, 26582460, 26584641, 26597140, 26599395 -26608137, 26609942, 26615291, 26615690, 26623652, 26626879, 26629381 -26633355, 26633558, 26635897, 26637273, 26637824, 26639167, 26641610 -26650226, 26658759, 26659182, 26680105, 26712331, 26714910, 26717528 -26727397, 26729494, 26729611, 26740700, 26744595, 26751106, 26751171 -26758193, 26764561, 26765212, 26775602, 26784509, 26794786, 26797591 -26802503, 26820076, 26822620, 26828994, 26840654, 26844870, 26849779 -26875822, 26883456, 26896659, 26898563, 26907327, 26908788, 26909100 -26909504, 26911000, 26939314, 26944190, 26963310, 26966916, 26967713 -26969321, 26970717, 26981902, 26983259, 26986173, 26992964, 27006664 -27009164, 27013146, 27028251, 27034890, 27038986, 27039712, 27044297 -27052607, 27060167, 27060859, 27073314, 27079140, 27087426, 27090765 -27093423, 27110878, 27117822, 27119621, 27124624, 27125872, 27133662 -27135647, 27135993, 27138325, 27142373, 27153641, 27161071, 27162405 -27163928, 27165231, 27169796, 27170305, 27181537, 27199245, 27207110 -27213224, 27229389, 27244337, 27248917, 27250547, 27251690, 27255377 -27256000, 27259307, 27262945, 27274536, 27276231, 27285244, 27292213 -27293599, 27302711, 27302730, 27304410, 27305039, 27314206, 27314390 -27321179, 27329612, 27333106, 27334316, 27338912, 27338946, 27339115 -27345231, 27346709, 27348081, 27349393, 27351628, 27359178, 27367194 -27370965, 27375542, 27394703, 27395416, 27396624, 27396813, 27400598 -27405645, 27416997, 27433870, 27434193, 27439835, 27441326, 27442041 -27466597, 27493674, 27501373, 27501413, 27502420, 27504770, 27505229 -27508985, 27510959, 27534509, 27544973, 27548131, 27555481, 27558861 -27560602, 27567477, 27595973, 27607563, 27611612, 27613080, 27620808 -27687880, 27688036, 27688692, 27691920, 27691939, 27698953, 27700466 -27709046, 27726780, 27740424, 27748954, 27757888, 27799032, 27835925 -27847259, 27882176, 27898015, 27940876, 27945870, 27951817, 27959048 -27994325, 27997875, 27998003, 28000269, 28033429, 28040776, 28074713 -28090453, 28099662, 28140658, 28171079, 28174827, 28184554, 28188330 -28218832, 28226179, 28290434, 28305001, 28320399, 28354603, 28437315 -28454242, 28508557, 28522441 -``` \ No newline at end of file diff --git a/doc_source/Appendix.Oracle.RU-RUR.18.0.0.0.md b/doc_source/Appendix.Oracle.RU-RUR.18.0.0.0.md deleted file mode 100644 index aa4419b..0000000 --- a/doc_source/Appendix.Oracle.RU-RUR.18.0.0.0.md +++ /dev/null @@ -1,2018 +0,0 @@ -# Database engine: 18\.0\.0\.0 - -The following versions are available for Oracle database engine 18\.0\.0\.0: -+ [Version 18\.0\.0\.0\.ru\-2021\-04\.rur\-2021\-04\.r1](#Appendix.Oracle.RU-RUR.18.0.0.0.ru-2021-04.rur-2021-04.r1) -+ [Version 18\.0\.0\.0\.ru\-2021\-01\.rur\-2021\-01\.r1](#Appendix.Oracle.RU-RUR.18.0.0.0.ru-2021-01.rur-2021-01.r1) -+ [Version 18\.0\.0\.0\.ru\-2020\-10\.rur\-2020\-10\.r1](#Appendix.Oracle.RU-RUR.18.0.0.0.ru-2020-10.rur-2020-10.r1) -+ [Version 18\.0\.0\.0\.ru\-2020\-07\.rur\-2020\-07\.r1](#Appendix.Oracle.RU-RUR.18.0.0.0.ru-2020-07.rur-2020-07.r1) -+ [Version 18\.0\.0\.0\.ru\-2020\-04\.rur\-2020\-04\.r1](#Appendix.Oracle.RU-RUR.18.0.0.0.ru-2020-04.rur-2020-04.r1) -+ [Version 18\.0\.0\.0\.ru\-2020\-01\.rur\-2020\-01\.r1](#Appendix.Oracle.RU-RUR.18.0.0.0.ru-2020-01.rur-2020-01.r1) -+ [Version 18\.0\.0\.0\.ru\-2019\-10\.rur\-2019\-10\.r1](#Appendix.Oracle.RU-RUR.18.0.0.0.ru-2019-10.rur-2019-10.r1) -+ [Version 18\.0\.0\.0\.ru\-2019\-07\.rur\-2019\-07\.r1](#Appendix.Oracle.RU-RUR.18.0.0.0.ru-2019-07.rur-2019-07.r1) - -**Note** -Oracle Database 18c \(18\.0\.0\) is no longer supported\. This information is only useful if you want to upgrade an Oracle Database 18c snapshot\. - -## Version 18\.0\.0\.0\.ru\-2021\-04\.rur\-2021\-04\.r1 - -Version 18\.0\.0\.0\.ru\-2021\-04\.rur\-2021\-04\.r1 includes the following: -+ Patch 32524155: DATABASE RELEASE UPDATE 18\.14\.0\.0\.0 -+ Patch 32552752: OJVM RELEASE UPDATE 18\.14\.0\.0\.0 -+ Patch 32327201: RDBMS \- DSTV36 UPDATE \- TZDATA2020E -+ Patch 28730253: SUPPORT NEW ERA REIWA FOR JAPANESE IMPERIAL CALENDAR -+ Patch 27539475: ORA\-3816 \- MISSING MESSAGE INFORMATION FOR 3816 ERROR -+ Patch 29213893: DBMS\_STATS FAILING WITH ERROR ORA\-01422 WHEN GATHERING STATS FOR USER TABLE -+ Patch 29374604: Golden Gate Integrated Extract not starting 18c/19c Standard Edition -+ Patch 26352615: SPILLOVER AUDIT FILES CANNOT BE FOUND ORA\-46372 -+ PreUpgrade Jar: preupgrade\_181\_cbuild\_10\_lf\.zip - -### Combined Patches for Version 18\.0\.0\.0\.ru\-2021\-04\.rur\-2021\-04\.r1, Released April 2021 - -Bugs fixed: - -``` -7391838, 8932139, 9062315, 12816839, 13554903, 14221306, 17468475 -17958365, 18701017, 18986501, 20436508, 20549013, 20917487, 21095391 -21223848, 21374587, 21547051, 21744603, 21766220, 21806121, 21935698 -22174392, 22282748, 22363790, 22645496, 22729345, 22734786, 22820798 -23003564, 23061453, 23109325, 23310101, 23698980, 23761724, 23763462 -23840305, 24480567, 24489904, 24596874, 24669730, 24687075, 24689376 -24737581, 24763196, 24798481, 24841671, 24844841, 24903291, 24925863 -24971597, 25031502, 25035594, 25035599, 25060506, 25092651, 25210690 -25287072, 25288078, 25293659, 25303284, 25309116, 25348956, 25404117 -25405687, 25416731, 25487146, 25560538, 25573623, 25576115, 25591292 -25607397, 25634405, 25644811, 25663488, 25686739, 25696520, 25709124 -25724089, 25726981, 25736428, 25740844, 25743479, 25756945, 25809524 -25824236, 25882883, 25890002, 25908728, 25911069, 25929650, 25943740 -25958554, 25986062, 25997810, 26001677, 26083489, 26115103, 26164661 -26226953, 26237338, 26280704, 26281476, 26284722, 26297826, 26299684 -26313403, 26336101, 26352615, 26362155, 26375330, 26399691, 26399839 -26405036, 26410240, 26422277, 26423085, 26427905, 26433972, 26440142 -26440169, 26441345, 26450454, 26476244, 26521043, 26527054, 26536320 -26586174, 26587652, 26595088, 26598422, 26615291, 26617804, 26646549 -26647619, 26654411, 26694735, 26716835, 26724511, 26731697, 26745002 -26785169, 26790514, 26790923, 26792891, 26798411, 26818960, 26822620 -26827699, 26843558, 26843664, 26846077, 26860285, 26871815, 26882126 -26882316, 26883456, 26894737, 26895149, 26898279, 26910716, 26914402 -26927998, 26928317, 26933599, 26943004, 26943660, 26956033, 26960097 -26961415, 26966120, 26966916, 26970175, 26976568, 26985002, 26986173 -26992964, 26996813, 27000158, 27005278, 27006120, 27006664, 27012915 -27013566, 27016033, 27018734, 27026401, 27028251, 27030974, 27032726 -27033520, 27034318, 27034688, 27035653, 27036163, 27036408, 27037839 -27038986, 27040560, 27041253, 27044169, 27044575, 27047831, 27053044 -27054231, 27058530, 27060167, 27060859, 27061736, 27066451, 27066519 -27072923, 27073066, 27075854, 27080748, 27080874, 27086406, 27086821 -27090765, 27092991, 27093423, 27098733, 27100800, 27101105, 27101527 -27101652, 27105900, 27106301, 27106915, 27110878, 27111780, 27112686 -27114112, 27115422, 27119621, 27119861, 27121566, 27122162, 27125872 -27126666, 27128580, 27133637, 27135647, 27142120, 27142529, 27143756 -27143882, 27144533, 27144928, 27147979, 27150500, 27151826, 27152892 -27153641, 27153755, 27155549, 27156355, 27160360, 27160922, 27163928 -27164352, 27165231, 27166354, 27166715, 27169796, 27169888, 27170305 -27174938, 27174948, 27177551, 27177852, 27179264, 27181521, 27181537 -27181897, 27182006, 27182064, 27184253, 27185188, 27187440, 27189611 -27190851, 27193810, 27195935, 27197334, 27199245, 27200959, 27202015 -27203055, 27204476, 27207634, 27208795, 27208953, 27210038, 27210263 -27210872, 27212837, 27213140, 27214085, 27214204, 27215007, 27216046 -27216224, 27217412, 27220610, 27220937, 27221900, 27222121, 27222423 -27222626, 27222938, 27223075, 27224987, 27226913, 27228786, 27229389 -27231051, 27232983, 27233563, 27234962, 27236052, 27236110, 27236722 -27238077, 27238258, 27240246, 27240570, 27241221, 27241247, 27242226 -27242616, 27244337, 27244785, 27244999, 27249215, 27249531, 27249544 -27250547, 27251690, 27252023, 27254335, 27254851, 27255377, 27256000 -27256488, 27256534, 27256584, 27257509, 27258578, 27259307, 27259386 -27259983, 27260704, 27262601, 27262650, 27262798, 27262945, 27262991 -27263276, 27263677, 27263996, 27264464, 27265816, 27266245, 27267992 -27270197, 27271876, 27274143, 27274456, 27274536, 27275136, 27275533 -27275776, 27276231, 27282707, 27283029, 27283960, 27284375, 27284499 -27285244, 27285557, 27288230, 27288638, 27288894, 27292213, 27293599 -27294480, 27299455, 27300007, 27301308, 27301568, 27302415, 27302594 -27302632, 27302681, 27302695, 27302711, 27302714, 27302730, 27302777 -27302800, 27302960, 27303287, 27303785, 27303938, 27304131, 27304410 -27304906, 27304936, 27305318, 27307868, 27308088, 27309182, 27310092 -27313687, 27314206, 27314390, 27314512, 27314697, 27315159, 27318117 -27318869, 27320576, 27320985, 27321179, 27321834, 27326204, 27329812 -27330158, 27330161, 27333536, 27333658, 27333664, 27333693, 27333731 -27334316, 27334353, 27334648, 27335682, 27338838, 27338912, 27338946 -27339115, 27339396, 27339483, 27339495, 27341036, 27343844, 27345190 -27345231, 27345450, 27345498, 27346329, 27346644, 27346709, 27346949 -27346984, 27347126, 27348081, 27348707, 27349393, 27350267, 27351628 -27352600, 27354783, 27356373, 27357773, 27358232, 27358241, 27359178 -27359368, 27360126, 27362190, 27364854, 27364891, 27364916, 27364947 -27365014, 27365139, 27365702, 27365993, 27367194, 27368850, 27369515 -27370933, 27372756, 27375260, 27375542, 27376871, 27377219, 27378103 -27378959, 27379233, 27379846, 27379956, 27381383, 27381417, 27381498 -27381656, 27383281, 27384222, 27386467, 27389352, 27392187, 27392968 -27393421, 27393570, 27394086, 27395404, 27395416, 27395794, 27396357 -27396365, 27396377, 27396624, 27396666, 27396672, 27396720, 27396794 -27396813, 27397048, 27398080, 27398223, 27398660, 27398742, 27399499 -27399762, 27399985, 27400416, 27400598, 27401618, 27401637, 27403244 -27404017, 27404573, 27404599, 27404668, 27405242, 27405645, 27405696 -27406105, 27410279, 27410300, 27410595, 27412805, 27416327, 27416997 -27417186, 27420715, 27421101, 27421733, 27422874, 27423251, 27424405 -27425507, 27425622, 27426277, 27426363, 27427805, 27428790, 27430219 -27430254, 27430802, 27432062, 27432338, 27432355, 27432826, 27433163 -27433385, 27433870, 27434050, 27434193, 27434486, 27434974, 27435537 -27439835, 27441326, 27441980, 27442041, 27443406, 27444727, 27445330 -27445452, 27445462, 27445727, 27447452, 27447687, 27448162, 27449814 -27450355, 27450400, 27450783, 27451049, 27451182, 27451187, 27451531 -27452046, 27452760, 27452897, 27453225, 27454722, 27457666, 27457891 -27458164, 27458829, 27459593, 27459909, 27459948, 27460675, 27461740 -27462994, 27465480, 27466597, 27467543, 27468303, 27469245, 27469329 -27471876, 27472969, 27473800, 27475272, 27479358, 27480784, 27481406 -27481765, 27483974, 27484556, 27486253, 27486805, 27487309, 27487795 -27487919, 27489107, 27489719, 27492916, 27493674, 27494663, 27496224 -27496308, 27496424, 27496806, 27497950, 27498477, 27501327, 27501413 -27501465, 27502420, 27503318, 27503413, 27504190, 27504770, 27505229 -27505603, 27506774, 27507968, 27508936, 27508984, 27508985, 27510959 -27511196, 27512439, 27513114, 27517818, 27518227, 27518310, 27519708 -27520070, 27520900, 27522245, 27523368, 27523800, 27525909, 27526362 -27526744, 27528204, 27529661, 27532009, 27532375, 27533780, 27533819 -27534289, 27534509, 27537472, 27539475, 27539757, 27539876, 27540613 -27541286, 27541468, 27542824, 27544030, 27544973, 27545630, 27547732 -27550341, 27551855, 27554074, 27555481, 27558557, 27558559, 27558861 -27560562, 27560602, 27560702, 27560735, 27562488, 27563629, 27563767 -27565906, 27567477, 27570318, 27573154, 27573408, 27574335, 27576342 -27576354, 27577122, 27577758, 27578007, 27579353, 27579969, 27580996 -27581484, 27585755, 27585800, 27586810, 27586895, 27587672, 27587905 -27588271, 27589260, 27591842, 27592466, 27593389, 27593501, 27593585 -27593587, 27595096, 27595801, 27595973, 27599689, 27599927, 27600706 -27601118, 27601441, 27602091, 27602488, 27603841, 27604293, 27605482 -27607563, 27607805, 27608669, 27609819, 27610269, 27613080, 27613247 -27613530, 27613554, 27615608, 27615649, 27616657, 27617522, 27617978 -27620808, 27623159, 27623844, 27625010, 27625050, 27625274, 27625620 -27627992, 27629756, 27629928, 27631506, 27632114, 27634676, 27634991 -27635508, 27636900, 27642235, 27644757, 27645231, 27645940, 27649707 -27652302, 27654039, 27654521, 27655217, 27657467, 27657712, 27657920 -27658186, 27658205, 27662528, 27663370, 27664702, 27666312, 27668379 -27671633, 27679488, 27679664, 27679793, 27679806, 27679961, 27680162 -27680509, 27680669, 27682151, 27682288, 27686599, 27688036, 27688099 -27688692, 27690513, 27690578, 27691717, 27691809, 27691920, 27691939 -27692215, 27693416, 27693713, 27694261, 27695063, 27697092, 27698953 -27700466, 27701795, 27702244, 27703242, 27704237, 27705761, 27707544 -27708711, 27709046, 27710072, 27714373, 27717210, 27718914, 27719187 -27723002, 27723151, 27725967, 27726269, 27726780, 27729678, 27731346 -27732323, 27733415, 27734470, 27735534, 27739006, 27739957, 27740424 -27740844, 27740854, 27744211, 27745220, 27745728, 27747407, 27747869 -27748321, 27748954, 27751006, 27751755, 27753336, 27756900, 27757567 -27757794, 27757888, 27757979, 27758544, 27758653, 27758972, 27759077 -27759457, 27761402, 27766324, 27766679, 27767081, 27768034, 27769361 -27772093, 27772815, 27773602, 27774320, 27774539, 27778433, 27779886 -27780562, 27780683, 27782339, 27782464, 27783059, 27783289, 27786669 -27786699, 27786772, 27791223, 27793533, 27797290, 27801337, 27801774 -27803665, 27804209, 27807441, 27810967, 27811439, 27812560, 27812593 -27813267, 27815347, 27818389, 27818871, 27819881, 27824540, 27824543 -27825241, 27828794, 27828892, 27829295, 27832643, 27833369, 27833672 -27834551, 27834569, 27834984, 27835925, 27837219, 27839353, 27839616 -27839732, 27840386, 27843646, 27846298, 27846499, 27847259, 27849825 -27850112, 27850736, 27851757, 27856471, 27861226, 27861452, 27861909 -27862636, 27864737, 27865439, 27869075, 27869339, 27873364, 27873412 -27873643, 27876671, 27882176, 27882764, 27886087, 27889841, 27892488 -27896388, 27896443, 27896458, 27897639, 27897759, 27898015, 27900663 -27902561, 27906509, 27908396, 27908644, 27909478, 27912301, 27917669 -27918819, 27918832, 27920184, 27924147, 27926113, 27927431, 27929287 -27929509, 27930478, 27931299, 27931506, 27934468, 27935348, 27935464 -27935493, 27935826, 27936676, 27938736, 27940876, 27941110, 27941514 -27941896, 27945870, 27948050, 27948153, 27950708, 27952586, 27952762 -27957892, 27959594, 27960021, 27961746, 27964051, 27964513, 27965400 -27965830, 27966472, 27967484, 27970265, 27971503, 27971575, 27972265 -27975778, 27977039, 27978668, 27983174, 27984028, 27984314, 27986817 -27989556, 27989849, 27991970, 27993289, 27993298, 27994325, 27994333 -27995215, 27995248, 27997875, 27998003, 27999073, 27999597, 27999638 -28000269, 28004853, 28006704, 28007516, 28018962, 28019283, 28019592 -28021205, 28022101, 28022847, 28023081, 28023399, 28023410, 28023482 -28024347, 28024793, 28025398, 28025414, 28026866, 28032758, 28033429 -28036487, 28039471, 28039953, 28043157, 28045209, 28045903, 28057267 -28058612, 28059199, 28066655, 28067846, 28071549, 28072130, 28072383 -28072464, 28072567, 28073470, 28074713, 28079127, 28085865, 28088762 -28089440, 28090453, 28091981, 28092783, 28098040, 28098160, 28098865 -28099592, 28103600, 28103869, 28104176, 28104361, 28104409, 28106402 -28108003, 28108898, 28109326, 28109698, 28111583, 28120036, 28120951 -28124631, 28125601, 28125947, 28127569, 28129791, 28131767, 28132287 -28135648, 28156781, 28157786, 28164480, 28165439, 28165545, 28169711 -28174827, 28174926, 28174951, 28175445, 28180464, 28181021, 28182503 -28184554, 28184800, 28187706, 28188330, 28189466, 28194173, 28199085 -28201419, 28204262, 28204423, 28204443, 28209341, 28209985, 28210192 -28211734, 28214943, 28215510, 28218832, 28220398, 28223871, 28226179 -28227512, 28229360, 28236305, 28238264, 28240153, 28242712, 28250929 -28256164, 28257335, 28258608, 28264172, 28271107, 28271119, 28271693 -28276054, 28278547, 28278640, 28279837, 28281094, 28282606, 28285766 -28290434, 28294563, 28302049, 28304709, 28305001, 28305362, 28305607 -28309182, 28309406, 28312508, 28315031, 28315995, 28319114, 28319623 -28320117, 28320399, 28321446, 28323201, 28328895, 28329450, 28330714 -28330971, 28333072, 28338399, 28338999, 28344964, 28350595, 28354603 -28355454, 28357401, 28361083, 28361221, 28361787, 28365111, 28369092 -28370061, 28371123, 28373960, 28375383, 28378446, 28379065, 28384353 -28385102, 28386259, 28388910, 28389153, 28390273, 28391210, 28391582 -28392168, 28392251, 28393678, 28394726, 28396445, 28397317, 28401116 -28402823, 28403295, 28413955, 28420042, 28420457, 28423598, 28432129 -28434028, 28435825, 28437849, 28439086, 28445741, 28448314, 28454215 -28455212, 28468312, 28468493, 28475164, 28478676, 28481149, 28481679 -28483184, 28489150, 28492362, 28493478, 28498976, 28501075, 28502098 -28502403, 28502773, 28503038, 28503484, 28504545, 28507324, 28508053 -28508296, 28508557, 28512336, 28512761, 28513333, 28514693, 28521330 -28527416, 28528349, 28530171, 28535127, 28535272, 28537481, 28538439 -28542455, 28544633, 28545134, 28545687, 28546290, 28547068, 28547478 -28553468, 28558645, 28564479, 28565296, 28571483, 28572407, 28572834 -28578164, 28578945, 28580528, 28584193, 28584217, 28584444, 28585411 -28587723, 28589509, 28600233, 28601874, 28602253, 28606598, 28608211 -28611037, 28612674, 28614072, 28617631, 28617959, 28621470, 28622202 -28627255, 28627686, 28632559, 28636676, 28639299, 28642273, 28642899 -28644549, 28646200, 28670445, 28673203, 28678804, 28679454, 28680029 -28685371, 28689483, 28690694, 28692103, 28692275, 28695694, 28697526 -28697806, 28702188, 28703812, 28708023, 28709063, 28710469, 28710734 -28710827, 28713840, 28714058, 28714988, 28715655, 28722229, 28728040 -28728272, 28730044, 28730076, 28730253, 28734355, 28740708, 28742555 -28745367, 28747182, 28749289, 28752599, 28755011, 28757758, 28758090 -28758722, 28761812, 28767240, 28770146, 28774416, 28776431, 28776811 -28777174, 28777214, 28777332, 28781754, 28785022, 28785531, 28791725 -28793062, 28794230, 28797711, 28803345, 28805612, 28805695, 28808314 -28809909, 28817449, 28819640, 28820669, 28821847, 28827682, 28830691 -28831971, 28835937, 28836716, 28838066, 28844866, 28847136, 28849751 -28852325, 28852691, 28854733, 28855922, 28856060, 28856172, 28863263 -28863487, 28865569, 28867992, 28876639, 28878525, 28881723, 28887305 -28887509, 28889389, 28889730, 28891984, 28900506, 28905390, 28905457 -28910498, 28910586, 28915870, 28919145, 28922485, 28925880, 28927452 -28938924, 28940179, 28945922, 28948554, 28949888, 28950868, 28951014 -28951382, 28956908, 28959493, 28960211, 28965084, 28965095, 28973650 -28986231, 28986257, 28987454, 28987746, 28993295, 28993353, 28993590 -28994890, 29000190, 29002488, 29006527, 29007321, 29007353, 29009513 -29013832, 29015118, 29015706, 29024054, 29026309, 29026582, 29027694 -29027940, 29032276, 29033896, 29036278, 29037290, 29039510, 29040739 -29044086, 29044954, 29048498, 29048728, 29050886, 29051702, 29055644 -29056270, 29056767, 29060216, 29061016, 29115857, 29123482, 29125374 -29129691, 29136111, 29139070, 29139591, 29154725, 29158680, 29163567 -29165682, 29170232, 29171683, 29173817, 29177886, 29179097, 29181078 -29182517, 29182901, 29189889, 29190663, 29198092, 29200700, 29202461 -29203604, 29205918, 29212433, 29213320, 29213351, 29213893, 29224605 -29224710, 29225076, 29230252, 29230565, 29233415, 29237575, 29241345 -29242017, 29246337, 29247712, 29247906, 29249289, 29250317, 29254623 -29255273, 29260956, 29261548, 29278684, 29281112, 29285503, 29296257 -29301463, 29302565, 29307638, 29311927, 29312672, 29312889, 29314539 -29331209, 29331493, 29332763, 29337294, 29338348, 29339155, 29342099 -29343086, 29343156, 29343861, 29344541, 29346057, 29347981, 29350868 -29351662, 29351771, 29353821, 29356634, 29356752, 29361472, 29362596 -29364171, 29366406, 29372069, 29372460, 29374604, 29375355, 29375984 -29376346, 29378913, 29379978, 29382784, 29383695, 29386635, 29388020 -29388952, 29391849, 29394749, 29395657, 29396481, 29398488, 29399046 -29399336, 29404483, 29405462, 29407804, 29408853, 29409149, 29409455 -29412269, 29415774, 29417719, 29418165, 29420254, 29426241, 29428230 -29429264, 29430524, 29431424, 29434301, 29436454, 29437712, 29439522 -29442936, 29445548, 29448498, 29450273, 29450812, 29452251, 29454978 -29457978, 29463047, 29464779, 29465177, 29472618, 29477015, 29483626 -29483672, 29483723, 29483771, 29489436, 29493122, 29500257, 29500963 -29501218, 29504682, 29506942, 29511611, 29515766, 29521862, 29524599 -29524985, 29525886, 29530515, 29531541, 29536342, 29538631, 29541742 -29542449, 29542580, 29548413, 29548592, 29549071, 29555239, 29557261 -29558238, 29559395, 29564592, 29579919, 29580394, 29591343, 29604257 -29607136, 29608023, 29614098, 29614987, 29616244, 29625065, 29626154 -29628647, 29629430, 29629745, 29632265, 29633753, 29637526, 29637560 -29643721, 29645167, 29645349, 29651520, 29656843, 29667994, 29668005 -29670713, 29676089, 29685137, 29687220, 29687459, 29688867, 29689697 -29701937, 29703195, 29705793, 29707896, 29715220, 29717901, 29719146 -29720133, 29722167, 29724041, 29726695, 29739576, 29741319, 29744637 -29766435, 29769901, 29773197, 29773459, 29774362, 29780140, 29782211 -29782284, 29785544, 29789911, 29791152, 29794174, 29794462, 29796916 -29807964, 29809792, 29813494, 29814995, 29815341, 29817278, 29822714 -29825525, 29827852, 29841687, 29843238, 29844131, 29846645, 29850930 -29853485, 29865188, 29867728, 29869404, 29869906, 29875459, 29876358 -29881050, 29881575, 29884958, 29891075, 29891916, 29893132, 29894021 -29896510, 29902299, 29903357, 29914449, 29922225, 29924147, 29930457 -29932310, 29933718, 29941062, 29942554, 29944035, 29944159, 29944660 -29951620, 29951759, 29961353, 29962927, 29962939, 29965888, 29991257 -29997326, 29997937, 30008125, 30014200, 30018017, 30018903, 30031027 -30034456, 30039800, 30039959, 30064268, 30068871, 30073422, 30073744 -30074349, 30076253, 30078675, 30078934, 30085980, 30088912, 30092280 -30098251, 30099302, 30114477, 30116203, 30117469, 30120608, 30125944 -30128047, 30131286, 30139392, 30147928, 30149035, 30160625, 30163243 -30164714, 30173113, 30177597, 30179644, 30186706, 30189023, 30193165 -30193505, 30193736, 30194710, 30196358, 30200680, 30200758, 30215130 -30218044, 30218317, 30223712, 30225443, 30232638, 30239480, 30240547 -30241567, 30246179, 30247305, 30252098, 30252156, 30253255, 30259008 -30265523, 30265615, 30272329, 30282501, 30283932, 30292305, 30293345 -30295549, 30305880, 30312094, 30312559, 30316897, 30320029, 30325407 -30331356, 30342878, 30345926, 30350543, 30352623, 30355490, 30357897 -30361635, 30364613, 30364835, 30365745, 30368482, 30368668, 30372081 -30374739, 30376986, 30377692, 30381207, 30384121, 30384152, 30387666 -30391272, 30396120, 30397100, 30402386, 30403763, 30404639, 30408515 -30409339, 30412188, 30413137, 30416034, 30419450, 30421204, 30431274 -30441687, 30443393, 30450787, 30453442, 30458593, 30460922, 30461123 -30464250, 30464655, 30473634, 30474774, 30475115, 30476768, 30480872 -30485255, 30489582, 30496957, 30497057, 30498824, 30501574, 30503943 -30509277, 30510527, 30517516, 30522998, 30528547, 30528704, 30532811 -30533172, 30534662, 30544595, 30559218, 30571306, 30576112, 30578221 -30581448, 30582500, 30595408, 30599407, 30602230, 30606345, 30613937 -30616406, 30619525, 30623138, 30624864, 30635302, 30651570, 30652853 -30654454, 30657365, 30662736, 30664266, 30668407, 30671813, 30679595 -30679771, 30681462, 30691604, 30696566, 30698289, 30735736, 30741263 -30749644, 30751639, 30755348, 30758943, 30764405, 30773164, 30783551 -30786641, 30803210, 30809087, 30814266, 30814285, 30815852, 30816938 -30822919, 30826474, 30829779, 30841241, 30855101, 30856358, 30860803 -30861988, 30866988, 30870439, 30881588, 30887501, 30891760, 30896620 -30901889, 30904672, 30910264, 30914674, 30919804, 30922819, 30930149 -30931311, 30937340, 30939307, 30957739, 30964194, 30968737, 30978554 -30985027, 30987088, 30994996, 30998759, 31001455, 31001490, 31004719 -31013127, 31019767, 31022858, 31028986, 31029936, 31046619, 31058548 -31061482, 31089270, 31100172, 31104809, 31106577, 31109506, 31115502 -31156383, 31172207, 31182793, 31192039, 31194264, 31195430, 31200845 -31201001, 31204878, 31215438, 31228670, 31233170, 31254535, 31257826 -31258101, 31290017, 31290300, 31298871, 31302462, 31306248, 31306261 -31309867, 31313214, 31315876, 31326608, 31331354, 31335037, 31335142 -31343752, 31348018, 31362692, 31377487, 31393600, 31408636, 31430722 -31454972, 31476736, 31479075, 31479106, 31494095, 31501139, 31525783 -31527103, 31544097, 31570161, 31574244, 31600023, 31628311, 31637680 -31658464, 31658943, 31663788, 31668061, 31668872, 31674731, 31696577 -31711889, 31718134, 31726483, 31748000, 31749759, 31758083, 31758344 -31769373, 31783451, 31786838, 31799775, 31816631, 31836113, 31862611 -31867037, 31883124, 31886547, 31886745, 31897786, 31903786, 31905033 -31909295, 31921267, 31927930, 31945038, 31965542, 31986836, 31997805 -32028269, 32032887, 32035536, 32047226, 32079739, 32089820, 32097882 -32105135, 32138782, 32162724, 32165759, 32222473, 32234161, 32246090 -32290399, 32296941, 32305792, 32327201, 32436757, 32442404, 32478406 -32505009, 32523206 -``` - -## Version 18\.0\.0\.0\.ru\-2021\-01\.rur\-2021\-01\.r1 - -Version 18\.0\.0\.0\.ru\-2021\-01\.rur\-2021\-01\.r1 includes the following: -+ Patch 32204699: DATABASE RELEASE UPDATE 18\.13\.0\.0\.210119 -+ Patch 32119939: OJVM RELEASE UPDATE 18\.13\.0\.0\.210119 -+ Patch 31335037: RDBMS \- DSTV35 UPDATE \- TZDATA2020A -+ Patch 31335142: DSTV35 UPDATE \- TZDATA2020A \- NEED OJVM FIX -+ Patch 28730253: SUPPORT NEW ERA REIWA FOR JAPANESE IMPERIAL CALENDAR -+ Patch 27539475: ORA\-3816 \- MISSING MESSAGE INFORMATION FOR 3816 ERROR -+ Patch 29213893: DBMS\_STATS FAILING WITH ERROR ORA\-01422 WHEN GATHERING STATS FOR USER TABLE -+ Patch 29374604: Golden Gate Integrated Extract not starting 18c/19c Standard Edition -+ Patch 29782284: ORA\-06508:"MDSYS\.MDPRVT\_IDX" WHILE UPGRADING DATABASE TO 18\.3 -+ PreUpgrade Jar: preupgrade\_181\_cbuild\_10\_lf\.zip -+ Java Cryptography Extension \(JCE\): Unlimited Strength Jurisdiction Policy Files for JVM version 8 -+ Support for [Setting parameters for advisor tasks](Appendix.Oracle.CommonDBATasks.Misc.md#Appendix.Oracle.CommonDBATasks.setting-task-parameters) using procedures in the `rdsadmin.rdsadmin_util` package - -### Combined patches for version 18\.0\.0\.0\.ru\-2021\-01\.rur\-2021\-01\.r1, released January 2021 - -Bugs fixed: - -``` -7391838, 8932139, 9062315, 12816839, 13554903, 14221306, 17468475 -17958365, 18701017, 18986501, 20436508, 20549013, 20917487, 21095391 -21223848, 21374587, 21547051, 21744603, 21766220, 21806121, 21935698 -22174392, 22282748, 22363790, 22645496, 22729345, 22734786, 22820798 -23003564, 23061453, 23109325, 23310101, 23698980, 23761724, 23763462 -23840305, 24489904, 24596874, 24669730, 24687075, 24689376, 24737581 -24763196, 24798481, 24841671, 24844841, 24903291, 24925863, 24971597 -25031502, 25035594, 25035599, 25060506, 25092651, 25210690, 25287072 -25293659, 25303284, 25309116, 25348956, 25404117, 25405687, 25416731 -25487146, 25560538, 25573623, 25576115, 25591292, 25607397, 25634405 -25644811, 25663488, 25686739, 25696520, 25709124, 25724089, 25726981 -25736428, 25740844, 25743479, 25756945, 25809524, 25824236, 25882883 -25890002, 25908728, 25911069, 25929650, 25943740, 25958554, 25986062 -25997810, 26001677, 26083489, 26115103, 26164661, 26226953, 26237338 -26281476, 26284722, 26297826, 26299684, 26313403, 26336101, 26362155 -26375330, 26399691, 26399839, 26405036, 26410240, 26422277, 26423085 -26427905, 26433972, 26440142, 26440169, 26441345, 26450454, 26476244 -26521043, 26527054, 26536320, 26586174, 26587652, 26595088, 26598422 -26615291, 26617804, 26646549, 26647619, 26654411, 26694735, 26716835 -26724511, 26731697, 26745002, 26785169, 26790514, 26790923, 26792891 -26798411, 26818960, 26822620, 26827699, 26843558, 26843664, 26846077 -26860285, 26871815, 26882126, 26882316, 26883456, 26894737, 26895149 -26898279, 26910716, 26914402, 26927998, 26928317, 26933599, 26943004 -26943660, 26956033, 26960097, 26961415, 26966120, 26966916, 26970175 -26976568, 26985002, 26986173, 26992964, 26996813, 27000158, 27005278 -27006120, 27006664, 27012915, 27013566, 27016033, 27018734, 27026401 -27028251, 27030974, 27032726, 27033520, 27034318, 27034688, 27035653 -27036163, 27036408, 27037839, 27038986, 27040560, 27041253, 27044169 -27044575, 27047831, 27053044, 27054231, 27058530, 27060167, 27060859 -27061736, 27066451, 27066519, 27072923, 27073066, 27075854, 27080748 -27080874, 27086406, 27086821, 27090765, 27092991, 27093423, 27098733 -27100800, 27101105, 27101527, 27101652, 27105900, 27106301, 27106915 -27110878, 27111780, 27112686, 27114112, 27115422, 27119621, 27119861 -27121566, 27122162, 27125872, 27126666, 27128580, 27133637, 27135647 -27142120, 27142529, 27143756, 27143882, 27144533, 27144928, 27147979 -27150500, 27151826, 27152892, 27153641, 27153755, 27155549, 27156355 -27160360, 27160922, 27163928, 27164352, 27165231, 27166354, 27166715 -27169796, 27169888, 27170305, 27174938, 27174948, 27177551, 27177852 -27179264, 27181521, 27181537, 27181897, 27182006, 27182064, 27184253 -27185188, 27187440, 27189611, 27190851, 27193810, 27195935, 27197334 -27199245, 27200959, 27202015, 27203055, 27204476, 27207634, 27208795 -27208953, 27210038, 27210263, 27210872, 27212837, 27213140, 27214085 -27214204, 27215007, 27216046, 27216224, 27217412, 27220610, 27220937 -27221900, 27222121, 27222423, 27222626, 27222938, 27223075, 27224987 -27226913, 27228786, 27229389, 27231051, 27232983, 27233563, 27234962 -27236052, 27236110, 27236722, 27238077, 27238258, 27240246, 27240570 -27241221, 27241247, 27242226, 27242616, 27244337, 27244785, 27244999 -27249215, 27249531, 27249544, 27250547, 27251690, 27252023, 27254335 -27254851, 27255377, 27256000, 27256488, 27256534, 27256584, 27257509 -27258578, 27259307, 27259386, 27259983, 27260704, 27262601, 27262650 -27262798, 27262945, 27262991, 27263276, 27263677, 27263996, 27264464 -27265816, 27266245, 27267992, 27270197, 27271876, 27274143, 27274456 -27274536, 27275136, 27275533, 27275776, 27276231, 27282707, 27283029 -27283960, 27284375, 27284499, 27285244, 27285557, 27288230, 27288638 -27288894, 27292213, 27293599, 27294480, 27299455, 27300007, 27301308 -27301568, 27302415, 27302594, 27302632, 27302681, 27302695, 27302711 -27302714, 27302730, 27302777, 27302800, 27302960, 27303287, 27303785 -27303938, 27304131, 27304410, 27304906, 27304936, 27305318, 27307868 -27308088, 27309182, 27310092, 27313687, 27314206, 27314390, 27314512 -27314697, 27315159, 27318117, 27318869, 27320576, 27320985, 27321179 -27321834, 27326204, 27329812, 27330158, 27330161, 27333658, 27333664 -27333693, 27333731, 27334316, 27334353, 27334648, 27335682, 27338838 -27338912, 27338946, 27339115, 27339396, 27339483, 27339495, 27341036 -27343844, 27345190, 27345231, 27345450, 27345498, 27346329, 27346644 -27346709, 27346949, 27346984, 27347126, 27348081, 27348707, 27349393 -27350267, 27351628, 27352600, 27354783, 27356373, 27357773, 27358232 -27358241, 27359178, 27359368, 27360126, 27362190, 27364854, 27364891 -27364916, 27364947, 27365014, 27365139, 27365702, 27365993, 27367194 -27368850, 27369515, 27370933, 27372756, 27375260, 27375542, 27376871 -27377219, 27378103, 27378959, 27379233, 27379846, 27379956, 27381383 -27381417, 27381498, 27381656, 27383281, 27384222, 27386467, 27389352 -27392187, 27392968, 27393421, 27393570, 27394086, 27395404, 27395416 -27395794, 27396357, 27396365, 27396377, 27396624, 27396666, 27396672 -27396720, 27396794, 27396813, 27397048, 27398080, 27398223, 27398660 -27399499, 27399762, 27399985, 27400416, 27400598, 27401618, 27401637 -27403244, 27404017, 27404573, 27404599, 27404668, 27405242, 27405645 -27405696, 27406105, 27410279, 27410300, 27410595, 27412805, 27416327 -27416997, 27417186, 27420715, 27421101, 27421733, 27422874, 27423251 -27424405, 27425507, 27425622, 27426277, 27426363, 27427805, 27428790 -27430219, 27430254, 27430802, 27432062, 27432338, 27432355, 27432826 -27433163, 27433385, 27433870, 27434050, 27434193, 27434486, 27434974 -27435537, 27439835, 27441326, 27441980, 27442041, 27444727, 27445330 -27445452, 27445462, 27445727, 27447452, 27447687, 27448162, 27449814 -27450355, 27450400, 27450783, 27451049, 27451182, 27451187, 27451531 -27452046, 27452760, 27452897, 27453225, 27454722, 27457666, 27457891 -27458164, 27458829, 27459593, 27459909, 27459948, 27460675, 27461740 -27462994, 27465480, 27466597, 27467543, 27468303, 27469245, 27469329 -27471876, 27472969, 27473800, 27475272, 27479358, 27480784, 27481406 -27481765, 27483974, 27484556, 27486253, 27486805, 27487309, 27487795 -27487919, 27489107, 27489719, 27492916, 27493674, 27494663, 27496224 -27496308, 27496424, 27496806, 27497950, 27498477, 27501327, 27501413 -27501465, 27502420, 27503318, 27503413, 27504190, 27504770, 27505229 -27505603, 27506774, 27507968, 27508936, 27508984, 27508985, 27510959 -27511196, 27512439, 27513114, 27517818, 27518227, 27518310, 27519708 -27520070, 27520900, 27522245, 27523368, 27523800, 27525909, 27526362 -27526744, 27528204, 27529661, 27532009, 27532375, 27533780, 27533819 -27534289, 27534509, 27537472, 27539475, 27539757, 27539876, 27540613 -27541286, 27541468, 27542824, 27544030, 27544973, 27545630, 27547732 -27550341, 27551855, 27554074, 27555481, 27558557, 27558559, 27558861 -27560562, 27560602, 27560702, 27560735, 27562488, 27563629, 27563767 -27565906, 27567477, 27570318, 27573154, 27573408, 27574335, 27576342 -27576354, 27577122, 27577758, 27578007, 27579353, 27579969, 27580996 -27581484, 27585755, 27585800, 27586810, 27586895, 27587672, 27587905 -27588271, 27589260, 27591842, 27592466, 27593389, 27593501, 27593585 -27593587, 27595096, 27595801, 27595973, 27599689, 27599927, 27600706 -27601118, 27601441, 27602091, 27602488, 27603841, 27604293, 27605482 -27607563, 27607805, 27608669, 27609819, 27610269, 27613080, 27613247 -27613530, 27613554, 27615608, 27615649, 27616657, 27617522, 27617978 -27620808, 27623159, 27623844, 27625010, 27625050, 27625274, 27625620 -27627992, 27629756, 27629928, 27631506, 27632114, 27634676, 27634991 -27635508, 27636900, 27642235, 27644757, 27645231, 27645940, 27649707 -27652302, 27654039, 27654521, 27655217, 27657467, 27657712, 27657920 -27658186, 27658205, 27662528, 27663370, 27664702, 27666312, 27668379 -27671633, 27679488, 27679664, 27679793, 27679806, 27679961, 27680162 -27680509, 27680669, 27682151, 27682288, 27686599, 27688036, 27688099 -27688692, 27690513, 27690578, 27691717, 27691809, 27691920, 27691939 -27692215, 27693416, 27693713, 27694261, 27695063, 27697092, 27698953 -27700466, 27701795, 27702244, 27703242, 27704237, 27705761, 27707544 -27708711, 27709046, 27710072, 27714373, 27717210, 27718914, 27719187 -27723002, 27723151, 27725967, 27726269, 27726780, 27729678, 27731346 -27732323, 27733415, 27734470, 27735534, 27739006, 27739957, 27740424 -27740844, 27740854, 27744211, 27745220, 27745728, 27747407, 27747869 -27748321, 27748954, 27751006, 27751755, 27753336, 27756900, 27757567 -27757794, 27757888, 27757979, 27758544, 27758653, 27758972, 27759077 -27759457, 27761402, 27766324, 27766679, 27767081, 27768034, 27769361 -27772093, 27772815, 27773602, 27774320, 27774539, 27778433, 27779886 -27780562, 27780683, 27782339, 27782464, 27783059, 27783289, 27786669 -27786699, 27786772, 27791223, 27793533, 27797290, 27801337, 27801774 -27803665, 27807441, 27810967, 27811439, 27812560, 27812593, 27813267 -27815347, 27818389, 27818871, 27819881, 27824540, 27824543, 27825241 -27828794, 27828892, 27829295, 27832643, 27833369, 27833672, 27834551 -27834569, 27834984, 27835925, 27837219, 27839353, 27839616, 27839732 -27840386, 27843646, 27846298, 27846499, 27847259, 27849825, 27850112 -27850736, 27851757, 27856471, 27861226, 27861452, 27861909, 27862636 -27864737, 27865439, 27869075, 27869339, 27873364, 27873412, 27873643 -27876671, 27882176, 27886087, 27889841, 27892488, 27896388, 27896443 -27896458, 27897639, 27897759, 27898015, 27900663, 27902561, 27906509 -27908396, 27908644, 27909478, 27912301, 27917669, 27918832, 27920184 -27924147, 27926113, 27927431, 27929287, 27929509, 27930478, 27931299 -27931506, 27934468, 27935348, 27935464, 27935493, 27935826, 27936676 -27938736, 27940876, 27941110, 27941514, 27941896, 27945870, 27948050 -27948153, 27950708, 27952586, 27952762, 27957892, 27959594, 27960021 -27961746, 27964051, 27964513, 27965400, 27965830, 27966472, 27967484 -27970265, 27971503, 27971575, 27972265, 27975778, 27977039, 27978668 -27983174, 27984028, 27984314, 27986817, 27989556, 27989849, 27991970 -27993289, 27993298, 27994325, 27994333, 27995215, 27995248, 27997875 -27998003, 27999073, 27999597, 27999638, 28000269, 28004853, 28006704 -28007516, 28018962, 28019283, 28019592, 28021205, 28022101, 28022847 -28023081, 28023399, 28023410, 28023482, 28024347, 28024793, 28025398 -28025414, 28026866, 28032758, 28033429, 28036487, 28039471, 28039953 -28043157, 28045209, 28045903, 28057267, 28058612, 28059199, 28066655 -28067846, 28071549, 28072130, 28072383, 28072464, 28072567, 28073470 -28074713, 28079127, 28085865, 28088762, 28089440, 28090453, 28091981 -28092783, 28098040, 28098160, 28098865, 28099592, 28103600, 28103869 -28104176, 28104361, 28104409, 28106402, 28108003, 28108898, 28109326 -28109698, 28111583, 28120036, 28120951, 28124631, 28125601, 28125947 -28127569, 28129791, 28131767, 28132287, 28135648, 28157786, 28164480 -28165439, 28165545, 28169711, 28174827, 28174926, 28174951, 28175445 -28180464, 28181021, 28182503, 28184554, 28184800, 28187706, 28188330 -28189466, 28194173, 28199085, 28201419, 28204262, 28204423, 28204443 -28209341, 28209985, 28210192, 28211734, 28214943, 28215510, 28218832 -28220398, 28223871, 28226179, 28227512, 28229360, 28236305, 28238264 -28240153, 28242712, 28250929, 28256164, 28257335, 28258608, 28264172 -28271107, 28271119, 28271693, 28276054, 28278547, 28278640, 28279837 -28281094, 28282606, 28285766, 28290434, 28294563, 28302049, 28304709 -28305001, 28305362, 28305607, 28309182, 28309406, 28312508, 28315031 -28315995, 28319114, 28319623, 28320117, 28320399, 28321446, 28323201 -28328895, 28329450, 28330714, 28330971, 28333072, 28338399, 28338999 -28344964, 28350595, 28354603, 28357401, 28361083, 28361221, 28361787 -28365111, 28369092, 28371123, 28373960, 28375383, 28378446, 28379065 -28384353, 28385102, 28386259, 28388910, 28389153, 28390273, 28391210 -28391582, 28392168, 28392251, 28393678, 28394726, 28396445, 28397317 -28401116, 28402823, 28403295, 28413955, 28420042, 28420457, 28423598 -28432129, 28434028, 28435825, 28437849, 28439086, 28445741, 28448314 -28454215, 28455212, 28468312, 28468493, 28475164, 28478676, 28481149 -28481679, 28483184, 28489150, 28492362, 28493478, 28498976, 28501075 -28502098, 28502403, 28502773, 28503038, 28503484, 28504545, 28507324 -28508053, 28508296, 28508557, 28512336, 28512761, 28513333, 28514693 -28521330, 28527416, 28528349, 28530171, 28535127, 28535272, 28538439 -28542455, 28544633, 28545134, 28545687, 28546290, 28547068, 28547478 -28553468, 28558645, 28564479, 28565296, 28571483, 28572407, 28572834 -28578164, 28578945, 28580528, 28584193, 28584217, 28584444, 28585411 -28587723, 28589509, 28600233, 28601874, 28602253, 28606598, 28608211 -28611037, 28612674, 28614072, 28617631, 28617959, 28621470, 28622202 -28627255, 28627686, 28632559, 28636676, 28639299, 28642273, 28642899 -28644549, 28646200, 28670445, 28673203, 28678804, 28679454, 28680029 -28685371, 28689483, 28690694, 28692103, 28692275, 28695694, 28697526 -28697806, 28702188, 28703812, 28708023, 28709063, 28710469, 28710734 -28710827, 28713840, 28714058, 28714988, 28715655, 28728040, 28728272 -28730044, 28730076, 28730253, 28734355, 28740708, 28742555, 28745367 -28747182, 28749289, 28752599, 28755011, 28757758, 28758090, 28758722 -28761812, 28767240, 28770146, 28774416, 28776431, 28776811, 28777174 -28777214, 28777332, 28781754, 28785022, 28785531, 28791725, 28793062 -28794230, 28797711, 28803345, 28805612, 28805695, 28808314, 28809909 -28817449, 28819640, 28820669, 28821847, 28827682, 28830691, 28831971 -28835937, 28836716, 28838066, 28844866, 28847136, 28849751, 28852325 -28852691, 28855922, 28856060, 28856172, 28863263, 28863487, 28865569 -28867992, 28876639, 28878525, 28881723, 28887305, 28887509, 28889389 -28889730, 28891984, 28900506, 28905390, 28905457, 28910498, 28910586 -28915870, 28919145, 28925880, 28927452, 28938924, 28940179, 28945922 -28948554, 28949888, 28950868, 28951014, 28951382, 28956908, 28959493 -28960211, 28965084, 28965095, 28973650, 28986231, 28986257, 28987454 -28993295, 28993353, 28993590, 28994890, 29000190, 29002488, 29006527 -29007321, 29007353, 29009513, 29013832, 29015118, 29015706, 29024054 -29026309, 29026582, 29027694, 29027940, 29032276, 29033896, 29036278 -29037290, 29039510, 29040739, 29044086, 29044954, 29048498, 29048728 -29050886, 29051702, 29055644, 29056270, 29056767, 29060216, 29061016 -29115857, 29123482, 29125374, 29136111, 29139070, 29139591, 29154725 -29158680, 29163567, 29165682, 29170232, 29171683, 29173817, 29177886 -29179097, 29182517, 29182901, 29189889, 29190663, 29198092, 29200700 -29202461, 29203604, 29205918, 29212433, 29213320, 29213351, 29213893 -29224605, 29224710, 29225076, 29230252, 29230565, 29233415, 29237575 -29241345, 29242017, 29247712, 29247906, 29249289, 29250317, 29254623 -29255273, 29260956, 29261548, 29278684, 29281112, 29285503, 29296257 -29301463, 29307638, 29311927, 29312672, 29312889, 29314539, 29331209 -29331493, 29332763, 29337294, 29338348, 29339155, 29342099, 29343086 -29343156, 29343861, 29344541, 29346057, 29347981, 29350868, 29351662 -29351771, 29353821, 29356752, 29361472, 29362596, 29364171, 29366406 -29372069, 29372460, 29374604, 29375355, 29375984, 29376346, 29378913 -29379978, 29382784, 29383695, 29386635, 29388020, 29388952, 29391849 -29394749, 29395657, 29396481, 29398488, 29399046, 29399336, 29404483 -29405462, 29407804, 29408853, 29409149, 29409455, 29412269, 29417719 -29418165, 29420254, 29426241, 29428230, 29429264, 29430524, 29434301 -29436454, 29437712, 29439522, 29442936, 29445548, 29448498, 29450812 -29452251, 29454978, 29457978, 29463047, 29464779, 29465177, 29472618 -29477015, 29483626, 29483672, 29483723, 29483771, 29489436, 29493122 -29500257, 29500963, 29501218, 29504682, 29506942, 29511611, 29515766 -29521862, 29524599, 29524985, 29525886, 29530515, 29531541, 29536342 -29538631, 29541742, 29542449, 29542580, 29548413, 29548592, 29549071 -29557261, 29558238, 29559395, 29564592, 29579919, 29580394, 29591343 -29604257, 29607136, 29608023, 29614098, 29614987, 29616244, 29625065 -29626154, 29629430, 29629745, 29632265, 29633753, 29637526, 29637560 -29643721, 29645167, 29645349, 29651520, 29656843, 29667994, 29668005 -29670713, 29676089, 29685137, 29687220, 29687459, 29688867, 29703195 -29705793, 29707896, 29717901, 29719146, 29720133, 29722167, 29724041 -29726695, 29739576, 29741319, 29766435, 29769901, 29773197, 29774362 -29780140, 29782211, 29782284, 29789911, 29791152, 29794174, 29794462 -29796916, 29807964, 29809792, 29813494, 29814995, 29815341, 29817278 -29822714, 29825525, 29827852, 29841687, 29844131, 29846645, 29850930 -29853485, 29865188, 29869404, 29869906, 29875459, 29876358, 29881050 -29881575, 29884958, 29891916, 29893132, 29896510, 29902299, 29914449 -29922225, 29930457, 29932310, 29941062, 29942554, 29944035, 29944159 -29944660, 29951620, 29951759, 29961353, 29962927, 29962939, 29965888 -29991257, 29997326, 29997937, 30008125, 30014200, 30018017, 30018903 -30031027, 30034456, 30039959, 30064268, 30068871, 30073422, 30073744 -30074349, 30076253, 30078675, 30078934, 30085980, 30088912, 30092280 -30098251, 30099302, 30114477, 30116203, 30117469, 30120608, 30125944 -30128047, 30131286, 30139392, 30147928, 30149035, 30160625, 30163243 -30164714, 30173113, 30177597, 30179644, 30186706, 30189023, 30193165 -30193736, 30194710, 30196358, 30200680, 30200758, 30215130, 30218044 -30218317, 30223712, 30225443, 30232638, 30239480, 30240547, 30241567 -30246179, 30247305, 30252098, 30252156, 30253255, 30259008, 30265523 -30265615, 30272329, 30282501, 30283932, 30293345, 30305880, 30312094 -30312559, 30316897, 30320029, 30325407, 30331356, 30342878, 30345926 -30350543, 30352623, 30355490, 30357897, 30361635, 30364613, 30365745 -30368482, 30368668, 30372081, 30374739, 30376986, 30377692, 30381207 -30384121, 30384152, 30387666, 30391272, 30396120, 30397100, 30402386 -30403763, 30408515, 30409339, 30412188, 30413137, 30416034, 30421204 -30431274, 30441687, 30443393, 30450787, 30453442, 30458593, 30460922 -30464250, 30464655, 30473634, 30474774, 30475115, 30476768, 30485255 -30496957, 30497057, 30498824, 30501574, 30503943, 30509277, 30510527 -30517516, 30522998, 30528547, 30528704, 30532811, 30533172, 30534662 -30544595, 30571306, 30578221, 30581448, 30582500, 30599407, 30602230 -30606345, 30613937, 30619525, 30623138, 30624864, 30635302, 30652853 -30654454, 30657365, 30662736, 30668407, 30671813, 30679595, 30679771 -30681462, 30691604, 30698289, 30741263, 30749644, 30751639, 30755348 -30758943, 30773164, 30783551, 30803210, 30809087, 30814266, 30814285 -30815852, 30816938, 30826474, 30829779, 30841241, 30855101, 30856358 -30860803, 30866988, 30870439, 30881588, 30887501, 30891760, 30896620 -30904672, 30914674, 30919804, 30922819, 30930149, 30931311, 30937340 -30957739, 30964194, 30968737, 30978554, 30985027, 30987088, 30994996 -30998759, 31001455, 31004719, 31013127, 31019767, 31022858, 31028986 -31029936, 31046619, 31058548, 31061482, 31100172, 31104809, 31106577 -31109506, 31115502, 31156383, 31172207, 31182793, 31192039, 31194264 -31200845, 31201001, 31204878, 31215438, 31228670, 31233170, 31254535 -31258101, 31298871, 31302462, 31306248, 31306261, 31309867, 31315876 -31326608, 31331354, 31335037, 31335142, 31343752, 31348018, 31377487 -31393600, 31408636, 31430722, 31454972, 31476736, 31501139, 31525783 -31544097, 31570161, 31574244, 31600023, 31628311, 31637680, 31658464 -31658943, 31663788, 31668061, 31668872, 31674731, 31696577, 31711889 -31718134, 31748000, 31749759, 31758083, 31769373, 31783451, 31786838 -31799775, 31816631, 31867037, 31883124, 31886547, 31905033, 31909295 -31921267, 31927930, 31986836, 31997805, 32032887, 32079739, 32089820 -32097882, 32105135, 32165759, 32234161, 32290399, 32296941 -``` - -## Version 18\.0\.0\.0\.ru\-2020\-10\.rur\-2020\-10\.r1 - -Version 18\.0\.0\.0\.ru\-2020\-10\.rur\-2020\-10\.r1 includes the following: -+ Patch 31730250: Database Release Update: 18\.12\.0\.0\.201020 \(31730250\) -+ Patch 31668892: OJVM RELEASE UPDATE: 18\.12\.0\.0\.201020 \(31668892\) -+ Patch 31335037: RDBMS \- DSTV35 UPDATE \- TZDATA2020A -+ Patch 31335142: DSTV35 UPDATE \- TZDATA2020A \- NEED OJVM FIX -+ Patch 28730253: SUPPORT NEW ERA REIWA FOR JAPANESE IMPERIAL CALENDAR -+ Patch 29213893: DBMS\_STATS FAILING WITH ERROR ORA\-01422 WHEN GATHERING STATS FOR USER$ TABLE -+ Patch 29374604: IE not starting against 18c Oracle RDBMS Standard Edition\. -+ PreUpgrade Jar: preupgrade\_181\_cbuild\_10\_lf\.zip -+ Support for [Setting and unsetting system diagnostic events](Appendix.Oracle.CommonDBATasks.System.md#Appendix.Oracle.CommonDBATasks.SystemEvents) using procedures in the `rdsadmin.rdsadmin_util` package -+ Support for the procedure `rdsadmin_util.truncate_apply$_cdr_info` described in [Integrated REPLICAT slow due to query on sys\."\_DBA\_APPLY\_CDR\_INFO"](Appendix.OracleGoldenGate.md#Appendix.OracleGoldenGate.IR) - -### Combined patches for version 18\.0\.0\.0\.ru\-2020\-10\.rur\-2020\-10\.r1, released October 2020 - -Bugs fixed: - -``` -7391838, 8932139, 9062315, 12816839, 13554903, 14221306, 17468475 -17958365, 18701017, 18986501, 20436508, 20549013, 20917487, 21095391 -21223848, 21374587, 21547051, 21744603, 21766220, 21806121, 21935698 -22174392, 22282748, 22363790, 22645496, 22729345, 22734786, 23003564 -23061453, 23109325, 23310101, 23698980, 23761724, 23763462, 23840305 -24489904, 24596874, 24669730, 24687075, 24689376, 24737581, 24763196 -24798481, 24841671, 24844841, 24903291, 24925863, 24971597, 25031502 -25035594, 25035599, 25060506, 25092651, 25210690, 25287072, 25293659 -25303284, 25309116, 25348956, 25404117, 25405687, 25416731, 25487146 -25560538, 25573623, 25576115, 25591292, 25607397, 25634405, 25644811 -25663488, 25686739, 25696520, 25709124, 25724089, 25726981, 25736428 -25740844, 25743479, 25756945, 25809524, 25824236, 25882883, 25890002 -25908728, 25911069, 25929650, 25943740, 25958554, 25986062, 25997810 -26001677, 26083489, 26115103, 26164661, 26226953, 26237338, 26281476 -26284722, 26297826, 26299684, 26313403, 26336101, 26362155, 26375330 -26399691, 26399839, 26405036, 26410240, 26422277, 26423085, 26427905 -26433972, 26440142, 26440169, 26441345, 26450454, 26476244, 26521043 -26527054, 26536320, 26586174, 26587652, 26595088, 26598422, 26615291 -26617804, 26646549, 26647619, 26654411, 26694735, 26716835, 26724511 -26731697, 26745002, 26785169, 26790514, 26790923, 26792891, 26798411 -26818960, 26822620, 26827699, 26843558, 26843664, 26846077, 26860285 -26871815, 26882126, 26882316, 26883456, 26894737, 26895149, 26898279 -26910716, 26914402, 26927998, 26928317, 26933599, 26943004, 26943660 -26956033, 26960097, 26961415, 26966120, 26966916, 26970175, 26976568 -26985002, 26986173, 26992964, 26996813, 27000158, 27005278, 27006120 -27006664, 27012915, 27013566, 27016033, 27018734, 27026401, 27028251 -27030974, 27032726, 27033520, 27034318, 27034688, 27035653, 27036163 -27036408, 27037839, 27038986, 27040560, 27041253, 27044169, 27044575 -27047831, 27053044, 27054231, 27058530, 27060167, 27060859, 27061736 -27066451, 27066519, 27072923, 27073066, 27075854, 27080748, 27080874 -27086406, 27086821, 27090765, 27092991, 27093423, 27098733, 27100800 -27101105, 27101527, 27101652, 27105900, 27106301, 27106915, 27110878 -27111780, 27112686, 27114112, 27115422, 27119621, 27119861, 27121566 -27122162, 27125872, 27126666, 27128580, 27133637, 27135647, 27142120 -27142529, 27143756, 27143882, 27144533, 27144928, 27147979, 27150500 -27151826, 27152892, 27153641, 27153755, 27155549, 27156355, 27160360 -27160922, 27163928, 27164352, 27165231, 27166354, 27166715, 27169796 -27169888, 27170305, 27174938, 27174948, 27177551, 27177852, 27179264 -27181521, 27181537, 27181897, 27182006, 27182064, 27184253, 27185188 -27187440, 27189611, 27190851, 27193810, 27195935, 27197334, 27199245 -27200959, 27202015, 27203055, 27204476, 27207634, 27208795, 27208953 -27210038, 27210263, 27210872, 27212837, 27213140, 27214085, 27214204 -27215007, 27216046, 27216224, 27217412, 27220610, 27220937, 27221900 -27222121, 27222423, 27222626, 27222938, 27223075, 27224987, 27226913 -27228786, 27229389, 27231051, 27232983, 27233563, 27234962, 27236052 -27236110, 27236722, 27238077, 27238258, 27240246, 27240570, 27241221 -27241247, 27242226, 27242616, 27244337, 27244785, 27244999, 27249215 -27249531, 27249544, 27250547, 27251690, 27252023, 27254335, 27254851 -27255377, 27256000, 27256488, 27256534, 27256584, 27257509, 27258578 -27259307, 27259386, 27259983, 27262601, 27262650, 27262798, 27262945 -27262991, 27263276, 27263677, 27263996, 27264464, 27265816, 27266245 -27267992, 27270197, 27271876, 27274143, 27274456, 27274536, 27275136 -27275533, 27275776, 27276231, 27282707, 27283029, 27283960, 27284375 -27284499, 27285244, 27285557, 27288230, 27288638, 27288894, 27292213 -27293599, 27294480, 27299455, 27300007, 27301308, 27301568, 27302415 -27302594, 27302632, 27302681, 27302695, 27302711, 27302714, 27302730 -27302777, 27302800, 27302960, 27303287, 27303785, 27303938, 27304131 -27304410, 27304906, 27304936, 27305318, 27307868, 27308088, 27309182 -27310092, 27313687, 27314206, 27314390, 27314512, 27314697, 27315159 -27318117, 27318869, 27320576, 27320985, 27321179, 27321834, 27326204 -27329812, 27330158, 27330161, 27333658, 27333664, 27333693, 27333731 -27334316, 27334353, 27334648, 27335682, 27338838, 27338912, 27338946 -27339115, 27339396, 27339483, 27339495, 27341036, 27343844, 27345190 -27345231, 27345450, 27345498, 27346329, 27346644, 27346709, 27346949 -27346984, 27347126, 27348081, 27348707, 27349393, 27350267, 27351628 -27352600, 27354783, 27356373, 27357773, 27358232, 27358241, 27359178 -27359368, 27360126, 27362190, 27364854, 27364891, 27364916, 27364947 -27365014, 27365139, 27365702, 27365993, 27367194, 27368850, 27369515 -27370933, 27372756, 27375260, 27375542, 27376871, 27377219, 27378103 -27378959, 27379233, 27379846, 27379956, 27381383, 27381417, 27381498 -27381656, 27383281, 27384222, 27386467, 27389352, 27392187, 27392968 -27393421, 27393570, 27394086, 27395404, 27395416, 27395794, 27396357 -27396365, 27396377, 27396624, 27396666, 27396672, 27396720, 27396794 -27396813, 27397048, 27398080, 27398223, 27398660, 27399499, 27399762 -27399985, 27400416, 27400598, 27401618, 27401637, 27403244, 27404573 -27404599, 27404668, 27405242, 27405645, 27405696, 27406105, 27410279 -27410300, 27410595, 27412805, 27416327, 27416997, 27417186, 27420715 -27421101, 27421733, 27422874, 27423251, 27424405, 27425507, 27425622 -27426277, 27426363, 27427805, 27428790, 27430219, 27430254, 27430802 -27432062, 27432338, 27432355, 27432826, 27433163, 27433385, 27433870 -27434050, 27434193, 27434486, 27434974, 27435537, 27439835, 27441326 -27441980, 27442041, 27444727, 27445330, 27445462, 27445727, 27447452 -27447687, 27448162, 27449814, 27450355, 27450400, 27450783, 27451049 -27451182, 27451187, 27451531, 27452046, 27452760, 27452897, 27453225 -27454722, 27457666, 27457891, 27458164, 27458829, 27459593, 27459909 -27459948, 27460675, 27461740, 27462994, 27465480, 27466597, 27467543 -27468303, 27469245, 27469329, 27471876, 27472969, 27473800, 27475272 -27479358, 27480784, 27481406, 27481765, 27483974, 27484556, 27486253 -27486805, 27487309, 27487795, 27487919, 27489107, 27489719, 27492916 -27493674, 27494663, 27496224, 27496308, 27496424, 27496806, 27497950 -27498477, 27501327, 27501413, 27501465, 27502420, 27503318, 27503413 -27504190, 27504770, 27505229, 27505603, 27506774, 27507968, 27508936 -27508984, 27508985, 27510959, 27511196, 27512439, 27513114, 27517818 -27518227, 27518310, 27519708, 27520070, 27520900, 27522245, 27523368 -27523800, 27525909, 27526362, 27526744, 27528204, 27529661, 27532009 -27532375, 27533780, 27533819, 27534289, 27534509, 27537472, 27539757 -27539876, 27540613, 27541286, 27541468, 27542824, 27544030, 27544973 -27545630, 27547732, 27550341, 27551855, 27554074, 27555481, 27558557 -27558559, 27558861, 27560562, 27560602, 27560702, 27560735, 27562488 -27563629, 27563767, 27565906, 27567477, 27570318, 27573154, 27573408 -27574335, 27576342, 27576354, 27577122, 27577758, 27578007, 27579353 -27579969, 27580996, 27581484, 27585755, 27585800, 27586810, 27586895 -27587672, 27587905, 27588271, 27589260, 27591842, 27592466, 27593389 -27593501, 27593585, 27593587, 27595096, 27595801, 27595973, 27599689 -27599927, 27600706, 27601118, 27601441, 27602091, 27602488, 27603841 -27604293, 27605482, 27607563, 27607805, 27608669, 27609819, 27610269 -27613080, 27613247, 27613530, 27613554, 27615608, 27615649, 27616657 -27617522, 27617978, 27620808, 27623159, 27623844, 27625010, 27625050 -27625274, 27625620, 27627992, 27629756, 27629928, 27631506, 27632114 -27634676, 27634991, 27635508, 27636900, 27642235, 27644757, 27645231 -27645940, 27649707, 27652302, 27654039, 27654521, 27655217, 27657467 -27657712, 27657920, 27658186, 27658205, 27662528, 27663370, 27664702 -27666312, 27668379, 27671633, 27679488, 27679664, 27679793, 27679806 -27679961, 27680162, 27680509, 27680669, 27682151, 27682288, 27686599 -27688036, 27688099, 27688692, 27690513, 27690578, 27691717, 27691809 -27691920, 27691939, 27692215, 27693416, 27693713, 27694261, 27695063 -27697092, 27698953, 27700466, 27701795, 27702244, 27703242, 27704237 -27705761, 27707544, 27708711, 27709046, 27710072, 27714373, 27717210 -27718914, 27719187, 27723002, 27723151, 27725967, 27726269, 27726780 -27729678, 27731346, 27732323, 27733415, 27734470, 27735534, 27739006 -27739957, 27740424, 27740844, 27740854, 27744211, 27745220, 27745728 -27747407, 27747869, 27748321, 27748954, 27751006, 27751755, 27753336 -27756900, 27757567, 27757794, 27757888, 27757979, 27758544, 27758653 -27758972, 27759077, 27759457, 27761402, 27766324, 27766679, 27767081 -27768034, 27769361, 27772093, 27772815, 27773602, 27774320, 27774539 -27778433, 27779886, 27780562, 27780683, 27782339, 27782464, 27783059 -27783289, 27786669, 27786699, 27786772, 27791223, 27793533, 27797290 -27801337, 27801774, 27803665, 27807441, 27810967, 27811439, 27812560 -27812593, 27813267, 27815347, 27818389, 27818871, 27819881, 27824540 -27824543, 27825241, 27828794, 27828892, 27829295, 27832643, 27833369 -27833672, 27834551, 27834569, 27834984, 27835925, 27837219, 27839353 -27839616, 27839732, 27840386, 27843646, 27846298, 27846499, 27847259 -27849825, 27850112, 27850736, 27851757, 27856471, 27861226, 27861452 -27861909, 27862636, 27864737, 27865439, 27869075, 27869339, 27873412 -27873643, 27876671, 27882176, 27886087, 27889841, 27892488, 27896388 -27896443, 27896458, 27897639, 27897759, 27898015, 27900663, 27902561 -27906509, 27908396, 27908644, 27909478, 27912301, 27917669, 27918832 -27920184, 27924147, 27926113, 27927431, 27929287, 27929509, 27930478 -27931299, 27931506, 27934468, 27935348, 27935464, 27935493, 27935826 -27936676, 27938736, 27940876, 27941110, 27941514, 27941896, 27945870 -27948050, 27948153, 27950708, 27952586, 27952762, 27957892, 27959594 -27960021, 27961746, 27964051, 27964513, 27965400, 27965830, 27966472 -27967484, 27970265, 27971503, 27971575, 27972265, 27975778, 27977039 -27978668, 27983174, 27984028, 27984314, 27986817, 27989556, 27989849 -27991970, 27993289, 27993298, 27994325, 27994333, 27995215, 27995248 -27997875, 27998003, 27999073, 27999597, 27999638, 28000269, 28004853 -28006704, 28018962, 28019283, 28019592, 28021205, 28022101, 28022847 -28023081, 28023399, 28023410, 28023482, 28024347, 28024793, 28025398 -28025414, 28026866, 28032758, 28033429, 28036487, 28039471, 28039953 -28043157, 28045209, 28045903, 28057267, 28058612, 28059199, 28066655 -28067846, 28071549, 28072130, 28072383, 28072464, 28072567, 28073470 -28074713, 28079127, 28085865, 28088762, 28089440, 28090453, 28091981 -28092783, 28098040, 28098160, 28098865, 28099592, 28103600, 28103869 -28104176, 28104361, 28104409, 28106402, 28108003, 28108898, 28109326 -28109698, 28111583, 28120036, 28120951, 28124631, 28125601, 28125947 -28129791, 28131767, 28132287, 28135648, 28157786, 28164480, 28165439 -28165545, 28169711, 28174827, 28174926, 28174951, 28175445, 28180464 -28181021, 28182503, 28184554, 28184800, 28187706, 28188330, 28189466 -28194173, 28199085, 28201419, 28204262, 28204423, 28204443, 28209341 -28209985, 28210192, 28211734, 28214943, 28215510, 28218832, 28220398 -28223871, 28226179, 28227512, 28229360, 28236305, 28238264, 28240153 -28242712, 28250929, 28256164, 28258608, 28264172, 28271107, 28271119 -28271693, 28276054, 28278547, 28278640, 28279837, 28281094, 28282606 -28285766, 28290434, 28294563, 28302049, 28304709, 28305001, 28305362 -28305607, 28309182, 28309406, 28312508, 28315031, 28315995, 28319114 -28319623, 28320117, 28320399, 28321446, 28323201, 28328895, 28329450 -28330714, 28330971, 28333072, 28338399, 28338999, 28344964, 28350595 -28354603, 28357401, 28361083, 28361221, 28361787, 28365111, 28369092 -28371123, 28373960, 28375383, 28378446, 28379065, 28384353, 28385102 -28386259, 28388910, 28389153, 28390273, 28391210, 28391582, 28392168 -28392251, 28393678, 28394726, 28396445, 28397317, 28401116, 28402823 -28403295, 28413955, 28420042, 28420457, 28423598, 28432129, 28434028 -28435825, 28437849, 28439086, 28445741, 28448314, 28454215, 28455212 -28468312, 28468493, 28475164, 28478676, 28481149, 28481679, 28483184 -28489150, 28492362, 28493478, 28498976, 28501075, 28502098, 28502403 -28502773, 28503038, 28503484, 28504545, 28507324, 28508053, 28508296 -28508557, 28512336, 28512761, 28513333, 28514693, 28521330, 28527416 -28528349, 28530171, 28535127, 28535272, 28538439, 28542455, 28544633 -28545134, 28545687, 28546290, 28547068, 28547478, 28553468, 28558645 -28564479, 28565296, 28571483, 28572407, 28572834, 28578164, 28578945 -28580528, 28584193, 28584217, 28584444, 28585411, 28587723, 28589509 -28600233, 28601874, 28602253, 28606598, 28608211, 28611037, 28612674 -28614072, 28617631, 28617959, 28621470, 28622202, 28627255, 28627686 -28632559, 28636676, 28639299, 28642273, 28642899, 28644549, 28646200 -28670445, 28673203, 28678804, 28679454, 28680029, 28685371, 28689483 -28690694, 28692103, 28692275, 28695694, 28697526, 28697806, 28702188 -28703812, 28708023, 28709063, 28710469, 28710734, 28710827, 28713840 -28714058, 28714988, 28715655, 28728040, 28728272, 28730044, 28730076 -28730253, 28734355, 28740708, 28742555, 28745367, 28747182, 28749289 -28752599, 28755011, 28757758, 28758090, 28758722, 28761812, 28767240 -28770146, 28774416, 28776431, 28776811, 28777174, 28777214, 28777332 -28781754, 28785022, 28785531, 28791725, 28793062, 28797711, 28803345 -28805612, 28805695, 28808314, 28809909, 28817449, 28819640, 28820669 -28821847, 28827682, 28830691, 28831971, 28835937, 28836716, 28838066 -28844866, 28847136, 28849751, 28852325, 28852691, 28855922, 28856060 -28856172, 28863263, 28863487, 28865569, 28867992, 28876639, 28878525 -28881723, 28887305, 28887509, 28889730, 28891984, 28900506, 28905390 -28905457, 28910498, 28910586, 28915870, 28919145, 28925880, 28927452 -28938924, 28940179, 28945922, 28948554, 28949888, 28950868, 28951014 -28951382, 28956908, 28959493, 28960211, 28965084, 28965095, 28986231 -28986257, 28987454, 28993295, 28993353, 28993590, 28994890, 29000190 -29002488, 29006527, 29007321, 29007353, 29009513, 29013832, 29015118 -29015706, 29024054, 29026309, 29026582, 29027694, 29027940, 29032276 -29033896, 29036278, 29037290, 29039510, 29040739, 29044086, 29044954 -29048498, 29048728, 29050886, 29051702, 29055644, 29056270, 29056767 -29060216, 29061016, 29115857, 29123482, 29125374, 29136111, 29139070 -29139591, 29154725, 29158680, 29163567, 29165682, 29170232, 29171683 -29173817, 29177886, 29179097, 29182517, 29182901, 29189889, 29190663 -29198092, 29200700, 29202461, 29203604, 29205918, 29212433, 29213320 -29213351, 29213893, 29224605, 29224710, 29225076, 29230252, 29230565 -29233415, 29237575, 29241345, 29242017, 29247712, 29247906, 29249289 -29250317, 29254623, 29255273, 29260956, 29261548, 29278684, 29285503 -29296257, 29301463, 29307638, 29311927, 29312672, 29312889, 29314539 -29331209, 29331493, 29332763, 29337294, 29338348, 29339155, 29343086 -29343156, 29343861, 29344541, 29346057, 29347981, 29350868, 29351662 -29351771, 29353821, 29356752, 29361472, 29362596, 29364171, 29366406 -29372069, 29372460, 29374604, 29375355, 29375984, 29376346, 29378913 -29379978, 29382784, 29383695, 29386635, 29388020, 29388952, 29391849 -29394749, 29395657, 29398488, 29399046, 29399336, 29404483, 29405462 -29407804, 29408853, 29409149, 29409455, 29412269, 29417719, 29418165 -29420254, 29426241, 29428230, 29429264, 29430524, 29434301, 29436454 -29437712, 29439522, 29442936, 29445548, 29448498, 29450812, 29452251 -29454978, 29457978, 29463047, 29464779, 29465177, 29472618, 29477015 -29483626, 29483672, 29483723, 29483771, 29489436, 29493122, 29500257 -29500963, 29501218, 29504682, 29506942, 29511611, 29515766, 29521862 -29524599, 29524985, 29525886, 29530515, 29531541, 29536342, 29538631 -29541742, 29542449, 29542580, 29548413, 29548592, 29549071, 29557261 -29558238, 29559395, 29564592, 29579919, 29580394, 29591343, 29604257 -29607136, 29608023, 29614098, 29614987, 29616244, 29625065, 29626154 -29629430, 29629745, 29632265, 29633753, 29637526, 29637560, 29643721 -29645167, 29645349, 29651520, 29656843, 29667994, 29668005, 29676089 -29685137, 29687220, 29687459, 29688867, 29703195, 29705793, 29707896 -29717901, 29719146, 29720133, 29722167, 29724041, 29726695, 29739576 -29741319, 29766435, 29769901, 29773197, 29774362, 29780140, 29782211 -29789911, 29791152, 29794174, 29794462, 29807964, 29809792, 29813494 -29815341, 29817278, 29822714, 29825525, 29827852, 29841687, 29844131 -29846645, 29850930, 29853485, 29865188, 29869404, 29869906, 29875459 -29876358, 29881050, 29881575, 29884958, 29891916, 29893132, 29896510 -29902299, 29914449, 29922225, 29930457, 29941062, 29942554, 29944035 -29944159, 29944660, 29951620, 29951759, 29961353, 29962927, 29962939 -29965888, 29991257, 29997326, 29997937, 30008125, 30018017, 30018903 -30031027, 30034456, 30039959, 30064268, 30068871, 30073744, 30074349 -30076253, 30078934, 30085980, 30088912, 30092280, 30098251, 30099302 -30114477, 30116203, 30120608, 30125944, 30128047, 30131286, 30139392 -30147928, 30149035, 30160625, 30163243, 30164714, 30173113, 30177597 -30179644, 30186706, 30189023, 30193165, 30193736, 30194710, 30196358 -30200680, 30200758, 30215130, 30218044, 30218317, 30223712, 30225443 -30232638, 30239480, 30240547, 30241567, 30246179, 30247305, 30252098 -30252156, 30253255, 30259008, 30265523, 30265615, 30272329, 30282501 -30283932, 30293345, 30305880, 30312094, 30312559, 30316897, 30320029 -30325407, 30331356, 30342878, 30350543, 30352623, 30355490, 30357897 -30364613, 30365745, 30368482, 30368668, 30372081, 30374739, 30376986 -30381207, 30384121, 30384152, 30387666, 30391272, 30397100, 30402386 -30403763, 30408515, 30409339, 30412188, 30413137, 30416034, 30421204 -30431274, 30441687, 30443393, 30450787, 30453442, 30458593, 30460922 -30464250, 30464655, 30473634, 30474774, 30475115, 30476768, 30485255 -30496957, 30497057, 30498824, 30501574, 30503943, 30509277, 30510527 -30517516, 30522998, 30528547, 30528704, 30532811, 30533172, 30534662 -30544595, 30578221, 30581448, 30582500, 30599407, 30602230, 30606345 -30613937, 30623138, 30624864, 30635302, 30652853, 30654454, 30662736 -30668407, 30671813, 30679595, 30679771, 30681462, 30691604, 30698289 -30741263, 30749644, 30755348, 30758943, 30773164, 30783551, 30803210 -30814266, 30814285, 30815852, 30816938, 30829779, 30855101, 30856358 -30866988, 30870439, 30881588, 30887501, 30904672, 30914674, 30919804 -30922819, 30937340, 30957739, 30964194, 30968737, 30985027, 30987088 -30994996, 30998759, 31001455, 31004719, 31013127, 31019767, 31022858 -31028986, 31029936, 31061482, 31100172, 31104809, 31106577, 31109506 -31115502, 31156383, 31172207, 31182793, 31192039, 31194264, 31200845 -31201001, 31215438, 31228670, 31254535, 31258101, 31302462, 31306248 -31306261, 31309867, 31315876, 31326608, 31331354, 31335037, 31335142 -31343752, 31348018, 31393600, 31430722, 31544097, 31570161, 31600023 -31658464, 31668061, 31668872, 31674731, 31718134, 31799775, 31867037 -31886547, 31905033 -``` - -## Version 18\.0\.0\.0\.ru\-2020\-07\.rur\-2020\-07\.r1 - -Version 18\.0\.0\.0\.ru\-2020\-07\.rur\-2020\-07\.r1 includes the following: -+ Patch 31308624: Database Release Update 18\.11\.0\.0\.200714 -+ Patch 31219909: OJVM RELEASE UPDATE: 18\.11\.0\.0\.200714 -+ Patch 31335037: DSTV35 for RDBMS \(TZDATA2020A\) -+ Patch 31335142: DSTV35 for OJVM \(TZDATA2020A\) -+ Patch 29213893: DBMS\_STATS FAILING WITH ERROR ORA\-01422 WHEN GATHERING STATS FOR USER$ TABLE -+ Patch 28730253: SUPPORT NEW ERA REIWA FOR JAPANESE IMPERIAL CALENDAR -+ Patch 29374604: IE not starting against 18c Oracle RDBMS Standard Edition -+ PreUpgrade Jar: preupgrade\_181\_cbuild\_10\_lf\.zip - -### Combined patches for version 18\.0\.0\.0\.ru\-2020\-07\.rur\-2020\-07\.r1, released July 2020 - -Bugs fixed: - -``` -7391838, 8932139, 9062315, 12816839, 13554903, 14221306, 18701017 -18986501, 20436508, 20549013, 20917487, 21095391, 21223848, 21374587 -21547051, 21744603, 21766220, 21806121, 21935698, 22174392, 22282748 -22363790, 22645496, 22729345, 22734786, 23003564, 23061453, 23109325 -23310101, 23698980, 23761724, 23840305, 24489904, 24596874, 24669730 -24687075, 24689376, 24737581, 24798481, 24841671, 24844841, 24903291 -24925863, 24971597, 25031502, 25035594, 25035599, 25060506, 25092651 -25210690, 25287072, 25293659, 25303284, 25309116, 25348956, 25405687 -25416731, 25487146, 25560538, 25573623, 25576115, 25591292, 25607397 -25634405, 25644811, 25663488, 25686739, 25696520, 25709124, 25724089 -25726981, 25736428, 25740844, 25743479, 25756945, 25809524, 25824236 -25882883, 25890002, 25908728, 25911069, 25929650, 25943740, 25958554 -25986062, 25997810, 26083489, 26115103, 26164661, 26226953, 26237338 -26281476, 26284722, 26297826, 26299684, 26313403, 26336101, 26362155 -26375330, 26399691, 26405036, 26410240, 26422277, 26423085, 26427905 -26433972, 26440142, 26440169, 26441345, 26450454, 26476244, 26521043 -26527054, 26536320, 26586174, 26587652, 26595088, 26598422, 26615291 -26617804, 26646549, 26647619, 26654411, 26694735, 26724511, 26731697 -26745002, 26785169, 26790514, 26790923, 26792891, 26798411, 26818960 -26822620, 26827699, 26843558, 26843664, 26846077, 26860285, 26871815 -26882126, 26882316, 26883456, 26894737, 26895149, 26898279, 26910716 -26914402, 26927998, 26928317, 26933599, 26943004, 26943660, 26956033 -26960097, 26961415, 26966120, 26966916, 26970175, 26976568, 26985002 -26986173, 26992964, 26996813, 27000158, 27005278, 27006120, 27006664 -27012915, 27013566, 27016033, 27018734, 27026401, 27028251, 27030974 -27032726, 27033520, 27034318, 27034688, 27035653, 27036163, 27036408 -27037839, 27038986, 27040560, 27041253, 27044169, 27044575, 27047831 -27053044, 27054231, 27058530, 27060167, 27060859, 27061736, 27066451 -27066519, 27072923, 27073066, 27075854, 27080748, 27080874, 27086406 -27086821, 27090765, 27092991, 27093423, 27098733, 27100800, 27101105 -27101527, 27101652, 27105900, 27106301, 27106915, 27110878, 27111780 -27112686, 27114112, 27115422, 27119621, 27119861, 27121566, 27122162 -27125872, 27126666, 27128580, 27133637, 27135647, 27142120, 27142529 -27143756, 27143882, 27144533, 27144928, 27147979, 27150500, 27151826 -27152892, 27153641, 27153755, 27155549, 27156355, 27160360, 27160922 -27163928, 27164352, 27165231, 27166354, 27166715, 27169796, 27169888 -27170305, 27174938, 27174948, 27177551, 27177852, 27179264, 27181521 -27181537, 27181897, 27182006, 27182064, 27184253, 27185188, 27187440 -27189611, 27190851, 27193810, 27195935, 27197334, 27199245, 27200959 -27202015, 27203055, 27204476, 27207634, 27208795, 27208953, 27210038 -27210263, 27210872, 27212837, 27213140, 27214085, 27214204, 27215007 -27216046, 27216224, 27217412, 27220610, 27220937, 27221900, 27222121 -27222423, 27222626, 27222938, 27223075, 27224987, 27226913, 27228786 -27229389, 27231051, 27232983, 27233563, 27234962, 27236052, 27236110 -27236722, 27238077, 27238258, 27240246, 27240570, 27241221, 27241247 -27242226, 27242616, 27244337, 27244785, 27244999, 27249215, 27249531 -27249544, 27250547, 27251690, 27252023, 27254335, 27254851, 27255377 -27256000, 27256488, 27256534, 27256584, 27257509, 27258578, 27259307 -27259386, 27259983, 27262601, 27262650, 27262798, 27262945, 27262991 -27263276, 27263677, 27263996, 27264464, 27265816, 27266245, 27267992 -27270197, 27271876, 27274143, 27274456, 27274536, 27275136, 27275533 -27275776, 27276231, 27282707, 27283029, 27283960, 27284375, 27284499 -27285244, 27285557, 27288230, 27288638, 27288894, 27292213, 27293599 -27294480, 27299455, 27300007, 27301308, 27301568, 27302415, 27302594 -27302632, 27302681, 27302695, 27302711, 27302714, 27302730, 27302777 -27302800, 27302960, 27303287, 27303785, 27303938, 27304131, 27304410 -27304906, 27304936, 27305318, 27307868, 27308088, 27309182, 27310092 -27313687, 27314206, 27314390, 27314512, 27314697, 27315159, 27318117 -27318869, 27320576, 27320985, 27321179, 27321834, 27326204, 27329812 -27330158, 27330161, 27333658, 27333664, 27333693, 27333731, 27334316 -27334353, 27334648, 27335682, 27338838, 27338912, 27338946, 27339115 -27339396, 27339483, 27339495, 27341036, 27343844, 27345190, 27345231 -27345450, 27345498, 27346329, 27346644, 27346709, 27346949, 27346984 -27347126, 27348081, 27348707, 27349393, 27350267, 27351628, 27352600 -27354783, 27356373, 27357773, 27358232, 27358241, 27359178, 27359368 -27360126, 27362190, 27364854, 27364891, 27364916, 27364947, 27365014 -27365139, 27365702, 27365993, 27367194, 27368850, 27369515, 27370933 -27372756, 27375260, 27375542, 27376871, 27377219, 27378103, 27378959 -27379233, 27379846, 27379956, 27381383, 27381417, 27381498, 27381656 -27383281, 27384222, 27386467, 27389352, 27392187, 27392968, 27393421 -27393570, 27394086, 27395404, 27395416, 27395794, 27396357, 27396365 -27396377, 27396624, 27396666, 27396672, 27396720, 27396794, 27396813 -27397048, 27398080, 27398223, 27398660, 27399499, 27399762, 27399985 -27400416, 27400598, 27401618, 27401637, 27403244, 27404573, 27404599 -27404668, 27405242, 27405645, 27405696, 27406105, 27410279, 27410300 -27410595, 27412805, 27416327, 27416997, 27417186, 27420715, 27421101 -27421733, 27422874, 27423251, 27424405, 27425507, 27425622, 27426277 -27426363, 27427805, 27428790, 27430219, 27430254, 27430802, 27432062 -27432338, 27432355, 27432826, 27433163, 27433385, 27433870, 27434050 -27434193, 27434486, 27434974, 27435537, 27439835, 27441326, 27441980 -27442041, 27444727, 27445330, 27445462, 27445727, 27447452, 27447687 -27448162, 27449814, 27450355, 27450400, 27450783, 27451049, 27451182 -27451187, 27451531, 27452046, 27452760, 27452897, 27453225, 27454722 -27457666, 27457891, 27458164, 27458829, 27459593, 27459909, 27459948 -27460675, 27461740, 27462994, 27465480, 27466597, 27467543, 27468303 -27469245, 27469329, 27471876, 27472969, 27473800, 27475272, 27479358 -27480784, 27481406, 27481765, 27483974, 27484556, 27486253, 27486805 -27487309, 27487795, 27487919, 27489107, 27489719, 27492916, 27493674 -27494663, 27496224, 27496308, 27496424, 27496806, 27497950, 27498477 -27501327, 27501413, 27501465, 27502420, 27503318, 27503413, 27504190 -27504770, 27505229, 27505603, 27506774, 27507968, 27508936, 27508984 -27508985, 27510959, 27511196, 27512439, 27513114, 27517818, 27518227 -27518310, 27519708, 27520070, 27520900, 27522245, 27523368, 27523800 -27525909, 27526362, 27526744, 27528204, 27529661, 27532009, 27532375 -27533780, 27533819, 27534289, 27534509, 27537472, 27539757, 27539876 -27540613, 27541286, 27541468, 27542824, 27544030, 27544973, 27545630 -27547732, 27550341, 27551855, 27554074, 27555481, 27558557, 27558559 -27558861, 27560562, 27560602, 27560702, 27560735, 27562488, 27563629 -27563767, 27565906, 27567477, 27570318, 27573154, 27573408, 27574335 -27576342, 27576354, 27577122, 27577758, 27578007, 27579353, 27579969 -27580996, 27581484, 27585755, 27585800, 27586810, 27586895, 27587672 -27587905, 27588271, 27589260, 27591842, 27592466, 27593389, 27593501 -27593585, 27593587, 27595096, 27595801, 27595973, 27599689, 27599927 -27600706, 27601118, 27601441, 27602091, 27602488, 27603841, 27604293 -27605482, 27607563, 27607805, 27608669, 27609819, 27610269, 27613080 -27613247, 27613530, 27613554, 27615608, 27615649, 27616657, 27617522 -27617978, 27620808, 27623159, 27623844, 27625010, 27625050, 27625274 -27625620, 27627992, 27629756, 27629928, 27631506, 27632114, 27634676 -27634991, 27635508, 27636900, 27642235, 27644757, 27645231, 27645940 -27649707, 27652302, 27654039, 27654521, 27655217, 27657467, 27657712 -27657920, 27658186, 27658205, 27662528, 27663370, 27664702, 27666312 -27668379, 27671633, 27679488, 27679664, 27679793, 27679806, 27679961 -27680162, 27680509, 27680669, 27682151, 27682288, 27686599, 27688036 -27688099, 27688692, 27690513, 27690578, 27691717, 27691809, 27691920 -27691939, 27692215, 27693416, 27693713, 27694261, 27695063, 27697092 -27698953, 27700466, 27701795, 27702244, 27703242, 27704237, 27705761 -27707544, 27708711, 27709046, 27710072, 27714373, 27718914, 27719187 -27723002, 27723151, 27725967, 27726269, 27726780, 27729678, 27731346 -27732323, 27733415, 27734470, 27735534, 27739006, 27739957, 27740424 -27740844, 27740854, 27744211, 27745220, 27747407, 27747869, 27748321 -27748954, 27751006, 27751755, 27753336, 27756900, 27757567, 27757794 -27757888, 27757979, 27758544, 27758653, 27758972, 27759077, 27759457 -27761402, 27766324, 27766679, 27767081, 27768034, 27769361, 27772093 -27772815, 27773602, 27774320, 27774539, 27778433, 27779886, 27780562 -27780683, 27782339, 27782464, 27783059, 27783289, 27786669, 27786699 -27786772, 27791223, 27793533, 27797290, 27801337, 27801774, 27803665 -27807441, 27810967, 27811439, 27812560, 27812593, 27813267, 27815347 -27818389, 27818871, 27819881, 27824540, 27824543, 27825241, 27828794 -27828892, 27829295, 27832643, 27833369, 27833672, 27834551, 27834569 -27834984, 27835925, 27839353, 27839616, 27839732, 27840386, 27843646 -27846298, 27846499, 27847259, 27849825, 27850112, 27850736, 27851757 -27856471, 27861226, 27861452, 27861909, 27862636, 27864737, 27865439 -27869075, 27869339, 27873412, 27873643, 27876671, 27882176, 27886087 -27889841, 27892488, 27896388, 27896443, 27896458, 27897639, 27897759 -27898015, 27900663, 27902561, 27906509, 27908396, 27908644, 27909478 -27912301, 27917669, 27918832, 27920184, 27924147, 27926113, 27927431 -27929287, 27929509, 27930478, 27931299, 27931506, 27934468, 27935348 -27935464, 27935493, 27935826, 27936676, 27938736, 27940876, 27941110 -27941514, 27941896, 27945870, 27948050, 27948153, 27950708, 27952586 -27952762, 27957892, 27959594, 27960021, 27961746, 27964051, 27964513 -27965400, 27965830, 27966472, 27967484, 27970265, 27971503, 27971575 -27972265, 27975778, 27977039, 27978668, 27983174, 27984028, 27984314 -27986817, 27989556, 27989849, 27991970, 27993289, 27993298, 27994325 -27994333, 27995215, 27995248, 27997875, 27998003, 27999073, 27999597 -27999638, 28000269, 28004853, 28006704, 28018962, 28019283, 28019592 -28021205, 28022101, 28022847, 28023081, 28023399, 28023410, 28023482 -28024347, 28024793, 28025398, 28025414, 28026866, 28032758, 28033429 -28036487, 28039471, 28039953, 28043157, 28045209, 28045903, 28057267 -28058612, 28059199, 28067846, 28071549, 28072130, 28072383, 28072464 -28072567, 28073470, 28074713, 28079127, 28085865, 28088762, 28089440 -28090453, 28091981, 28092783, 28098040, 28098160, 28098865, 28099592 -28103600, 28103869, 28104176, 28104361, 28104409, 28106402, 28108003 -28108898, 28109326, 28109698, 28111583, 28120036, 28120951, 28124631 -28125601, 28125947, 28129791, 28131767, 28132287, 28135648, 28157786 -28164480, 28165439, 28165545, 28169711, 28174827, 28174926, 28174951 -28175445, 28180464, 28181021, 28182503, 28184554, 28184800, 28187706 -28188330, 28189466, 28194173, 28199085, 28201419, 28204262, 28204423 -28204443, 28209341, 28209985, 28210192, 28211734, 28214943, 28215510 -28218832, 28220398, 28223871, 28226179, 28227512, 28229360, 28236305 -28238264, 28240153, 28242712, 28250929, 28256164, 28258608, 28264172 -28271107, 28271119, 28271693, 28276054, 28278547, 28278640, 28279837 -28281094, 28282606, 28285766, 28290434, 28294563, 28302049, 28304709 -28305001, 28305362, 28305607, 28309182, 28309406, 28312508, 28315031 -28315995, 28319114, 28319623, 28320117, 28320399, 28321446, 28323201 -28328895, 28329450, 28330714, 28330971, 28333072, 28338399, 28338999 -28344964, 28350595, 28354603, 28357401, 28361083, 28361221, 28361787 -28365111, 28369092, 28371123, 28373960, 28375383, 28378446, 28379065 -28384353, 28385102, 28386259, 28388910, 28390273, 28391210, 28391582 -28392168, 28392251, 28393678, 28396445, 28397317, 28401116, 28402823 -28403295, 28413955, 28420042, 28420457, 28423598, 28432129, 28434028 -28435825, 28437849, 28439086, 28445741, 28448314, 28454215, 28455212 -28468312, 28468493, 28475164, 28478676, 28481149, 28481679, 28483184 -28489150, 28492362, 28493478, 28498976, 28501075, 28502098, 28502403 -28502773, 28503038, 28503484, 28504545, 28507324, 28508053, 28508296 -28508557, 28512336, 28512761, 28513333, 28514693, 28521330, 28527416 -28528349, 28530171, 28535127, 28535272, 28538439, 28542455, 28544633 -28545134, 28545687, 28546290, 28547068, 28547478, 28553468, 28558645 -28564479, 28565296, 28571483, 28572407, 28572834, 28578164, 28578945 -28580528, 28584193, 28584217, 28584444, 28585411, 28587723, 28589509 -28600233, 28601874, 28606598, 28608211, 28611037, 28612674, 28614072 -28617631, 28617959, 28621470, 28622202, 28627255, 28627686, 28632559 -28636676, 28639299, 28642273, 28642899, 28644549, 28646200, 28670445 -28673203, 28678804, 28679454, 28680029, 28685371, 28689483, 28692103 -28692275, 28695694, 28697806, 28702188, 28703812, 28708023, 28709063 -28710469, 28710827, 28713840, 28714058, 28714988, 28715655, 28728040 -28728272, 28730076, 28730253, 28734355, 28740708, 28742555, 28745367 -28747182, 28749289, 28752599, 28755011, 28757758, 28758090, 28758722 -28761812, 28767240, 28770146, 28774416, 28776431, 28776811, 28777174 -28777214, 28777332, 28781754, 28785022, 28785531, 28791725, 28793062 -28797711, 28803345, 28805612, 28805695, 28808314, 28809909, 28817449 -28819640, 28820669, 28821847, 28827682, 28830691, 28831971, 28835937 -28836716, 28838066, 28844866, 28847136, 28849751, 28852325, 28852691 -28855922, 28856060, 28856172, 28863263, 28863487, 28865569, 28867992 -28876639, 28878525, 28881723, 28887305, 28887509, 28889730, 28891984 -28900506, 28905390, 28905457, 28910498, 28915870, 28919145, 28925880 -28927452, 28938924, 28940179, 28949888, 28950868, 28951014, 28951382 -28956908, 28959493, 28960211, 28965084, 28965095, 28986231, 28986257 -28987454, 28993295, 28993353, 28993590, 28994890, 29000190, 29002488 -29006527, 29007321, 29007353, 29009513, 29013832, 29015118, 29015706 -29024054, 29026582, 29027694, 29027940, 29032276, 29033896, 29036278 -29037290, 29039510, 29040739, 29044954, 29048498, 29048728, 29050886 -29051702, 29055644, 29056270, 29056767, 29060216, 29061016, 29115857 -29123482, 29125374, 29136111, 29139070, 29139591, 29158680, 29163567 -29165682, 29170232, 29171683, 29173817, 29177886, 29179097, 29182517 -29182901, 29189889, 29190663, 29198092, 29200700, 29202461, 29203604 -29205918, 29212433, 29213320, 29213351, 29213893, 29224605, 29225076 -29230252, 29230565, 29233415, 29237575, 29241345, 29242017, 29247712 -29247906, 29249289, 29250317, 29254623, 29255273, 29260956, 29261548 -29278684, 29285503, 29296257, 29301463, 29307638, 29311927, 29312672 -29312889, 29314539, 29331209, 29331493, 29332763, 29339155, 29343086 -29343156, 29343861, 29344541, 29346057, 29347981, 29350868, 29351662 -29351771, 29353821, 29356752, 29361472, 29362596, 29364171, 29366406 -29372069, 29372460, 29374604, 29375355, 29375984, 29376346, 29378913 -29379978, 29382784, 29383695, 29386635, 29388020, 29388952, 29391849 -29394749, 29395657, 29398488, 29399046, 29399336, 29404483, 29405462 -29407804, 29408853, 29409149, 29409455, 29412269, 29417719, 29418165 -29420254, 29426241, 29428230, 29429264, 29430524, 29434301, 29436454 -29437712, 29439522, 29442936, 29445548, 29448498, 29450812, 29452251 -29454978, 29457978, 29464779, 29465177, 29483626, 29483672, 29483723 -29483771, 29489436, 29493122, 29500257, 29500963, 29501218, 29504682 -29506942, 29511611, 29515766, 29521862, 29524599, 29524985, 29525886 -29530515, 29531541, 29536342, 29538631, 29541742, 29542449, 29542580 -29548413, 29548592, 29549071, 29557261, 29558238, 29559395, 29564592 -29579919, 29580394, 29591343, 29604257, 29607136, 29608023, 29614098 -29614987, 29616244, 29625065, 29626154, 29629430, 29629745, 29632265 -29633753, 29637526, 29637560, 29643721, 29645167, 29645349, 29651520 -29656843, 29667994, 29668005, 29676089, 29685137, 29687220, 29687459 -29688867, 29703195, 29705793, 29707896, 29717901, 29719146, 29720133 -29722167, 29724041, 29726695, 29739576, 29766435, 29773197, 29774362 -29780140, 29782211, 29789911, 29791152, 29794462, 29807964, 29809792 -29813494, 29815341, 29817278, 29822714, 29825525, 29827852, 29841687 -29846645, 29853485, 29865188, 29869404, 29869906, 29875459, 29876358 -29881050, 29881575, 29884958, 29891916, 29893132, 29896510, 29902299 -29914449, 29922225, 29930457, 29944035, 29944660, 29951620, 29951759 -29961353, 29962927, 29962939, 29965888, 29991257, 29997326, 29997937 -30008125, 30018017, 30018903, 30031027, 30034456, 30039959, 30064268 -30068871, 30073744, 30074349, 30076253, 30078934, 30085980, 30088912 -30092280, 30098251, 30099302, 30114477, 30116203, 30120608, 30125944 -30128047, 30131286, 30139392, 30147928, 30149035, 30160625, 30163243 -30164714, 30173113, 30177597, 30179644, 30186706, 30189023, 30193165 -30193736, 30194710, 30196358, 30200680, 30200758, 30215130, 30218044 -30218317, 30223712, 30225443, 30232638, 30239480, 30240547, 30241567 -30246179, 30247305, 30252098, 30252156, 30253255, 30259008, 30265523 -30272329, 30282501, 30283932, 30293345, 30305880, 30312094, 30312559 -30316897, 30325407, 30342878, 30352623, 30355490, 30357897, 30364613 -30365745, 30368482, 30368668, 30372081, 30374739, 30376986, 30381207 -30384121, 30384152, 30391272, 30397100, 30402386, 30403763, 30408515 -30409339, 30412188, 30413137, 30416034, 30431274, 30441687, 30443393 -30450787, 30453442, 30458593, 30460922, 30464655, 30474774, 30475115 -30476768, 30485255, 30496957, 30497057, 30501574, 30503943, 30509277 -30510527, 30522998, 30528547, 30528704, 30533172, 30534662, 30544595 -30581448, 30582500, 30599407, 30602230, 30613937, 30623138, 30624864 -30635302, 30652853, 30654454, 30668407, 30671813, 30681462, 30691604 -30698289, 30741263, 30758943, 30773164, 30783551, 30803210, 30814285 -30815852, 30816938, 30829779, 30855101, 30881588, 30887501, 30904672 -30922819, 30957739, 30964194, 30968737, 30987088, 30998759, 31001455 -31004719, 31013127, 31019767, 31022858, 31029936, 31100172, 31106577 -31156383, 31172207, 31182793, 31200845, 31306261, 31335037, 31335142 -31393600 -``` - -## Version 18\.0\.0\.0\.ru\-2020\-04\.rur\-2020\-04\.r1 - -Version 18\.0\.0\.0\.ru\-2020\-04\.rur\-2020\-04\.r1 includes the following: -+ Patch 30872794: Database Release Update 18\.10\.0\.0\.200414 -+ Patch 30805598: Oracle JVM Release Update 18\.10\.0\.0\.200414 -+ Patch 29997937: DSTv34 for RDBMS \(TZDATA2019B\) -+ Patch 29997959: DSTv34 for OJVM \(TZDATA2019G\) -+ PreUpgrade Jar: preupgrade\_181\_cbuild\_9\_lf\.zip -+ Patch 28730253: SUPPORT NEW ERA REIWA FOR JAPANESE IMPERIAL CALENDAR is included in DB PATCH 30138470 -+ Patch 29213893: DBMS\_STATS FAILING WITH ERROR ORA\-01422 WHEN GATHERING STATS FOR USER$ TABLE -+ Support for [Purging the recycle bin](Appendix.Oracle.CommonDBATasks.Database.md#Appendix.Oracle.CommonDBATasks.PurgeRecycleBin) -+ Support for [Generating performance reports with Automatic Workload Repository \(AWR\)](Appendix.Oracle.CommonDBATasks.Database.md#Appendix.Oracle.CommonDBATasks.AWR) using the `rdsadmin.rdsadmin_diagnostic_util` package - -### Combined patches for version 18\.0\.0\.0\.ru\-2020\-04\.rur\-2020\-04\.r1, released April 2020 - -Bugs fixed: - -``` -8932139, 9062315, 13554903, 14221306, 20436508, 20549013, 21095391 -21223848, 21374587, 21547051, 21744603, 21766220, 21806121, 21935698 -22174392, 22282748, 22363790, 22645496, 23003564, 23061453, 23109325 -23310101, 23761724, 24489904, 24687075, 24689376, 24737581, 24841671 -24844841, 24903291, 24925863, 24971597, 25031502, 25035594, 25035599 -25060506, 25210690, 25287072, 25293659, 25303284, 25309116, 25348956 -25405687, 25416731, 25487146, 25573623, 25591292, 25607397, 25634405 -25644811, 25663488, 25686739, 25696520, 25726981, 25736428, 25740844 -25743479, 25756945, 25809524, 25824236, 25882883, 25890002, 25908728 -25911069, 25929650, 25943740, 25958554, 25986062, 25997810, 26083489 -26115103, 26164661, 26226953, 26237338, 26281476, 26284722, 26297826 -26336101, 26362155, 26399691, 26405036, 26410240, 26422277, 26423085 -26427905, 26440169, 26450454, 26476244, 26521043, 26536320, 26595088 -26598422, 26615291, 26617804, 26646549, 26654411, 26694735, 26724511 -26731697, 26745002, 26785169, 26790514, 26790923, 26792891, 26798411 -26818960, 26822620, 26843558, 26843664, 26846077, 26871815, 26883456 -26894737, 26895149, 26898279, 26910716, 26927998, 26928317, 26933599 -26943004, 26956033, 26960097, 26961415, 26966120, 26966916, 26970175 -26976568, 26985002, 26986173, 26992964, 27000158, 27005278, 27006120 -27006664, 27013566, 27016033, 27026401, 27028251, 27030974, 27033520 -27034688, 27035653, 27036163, 27036408, 27037839, 27038986, 27041253 -27044169, 27044575, 27047831, 27053044, 27054231, 27058530, 27060167 -27060859, 27061736, 27066451, 27066519, 27072923, 27073066, 27075854 -27080874, 27086821, 27090765, 27093423, 27100800, 27101105, 27101527 -27101652, 27105900, 27106301, 27110878, 27111780, 27112686, 27115422 -27119621, 27119861, 27122162, 27125872, 27126666, 27128580, 27135647 -27142120, 27142529, 27143756, 27143882, 27144928, 27147979, 27150500 -27151826, 27152892, 27153641, 27155549, 27156355, 27160360, 27160922 -27163928, 27164352, 27165231, 27166354, 27169796, 27169888, 27170305 -27179264, 27181521, 27181537, 27181897, 27185188, 27187440, 27189611 -27190851, 27193810, 27195935, 27197334, 27199245, 27200959, 27202015 -27203055, 27208795, 27208953, 27210038, 27210263, 27210872, 27214085 -27214204, 27215007, 27216046, 27216224, 27217412, 27220937, 27221900 -27222121, 27222626, 27223075, 27224987, 27226913, 27228786, 27229389 -27231051, 27232983, 27233563, 27234962, 27236052, 27236110, 27236722 -27240246, 27240570, 27241221, 27241247, 27242226, 27242616, 27244337 -27244785, 27244999, 27249215, 27249531, 27250547, 27251690, 27254851 -27255377, 27256000, 27256488, 27256534, 27256584, 27258578, 27259307 -27259386, 27259983, 27262601, 27262650, 27262798, 27262945, 27262991 -27263276, 27263996, 27264464, 27266245, 27270197, 27274456, 27274536 -27275136, 27275533, 27275776, 27276231, 27282707, 27283029, 27283960 -27284375, 27284499, 27285244, 27288230, 27288638, 27288894, 27292213 -27293599, 27294480, 27301308, 27301568, 27302594, 27302632, 27302681 -27302695, 27302711, 27302714, 27302730, 27302777, 27302800, 27302960 -27303287, 27303785, 27303938, 27304410, 27304906, 27304936, 27305318 -27307868, 27308088, 27310092, 27313687, 27314206, 27314390, 27314697 -27318117, 27318869, 27320576, 27321179, 27321834, 27326204, 27329812 -27330158, 27330161, 27333658, 27333664, 27333693, 27333731, 27334316 -27334648, 27335682, 27338912, 27338946, 27339115, 27339396, 27339483 -27339495, 27341036, 27343844, 27345190, 27345231, 27345450, 27345498 -27346329, 27346644, 27346709, 27346949, 27347126, 27348081, 27348707 -27349393, 27350267, 27351628, 27352600, 27354783, 27356373, 27357773 -27358241, 27359178, 27359368, 27360126, 27364854, 27364891, 27364916 -27364947, 27365139, 27365702, 27365993, 27367194, 27368850, 27369515 -27372756, 27375260, 27375542, 27376871, 27378103, 27379233, 27381383 -27381417, 27381498, 27381656, 27383281, 27384222, 27386467, 27389352 -27392187, 27393570, 27394086, 27395404, 27395416, 27395794, 27396357 -27396365, 27396377, 27396624, 27396666, 27396672, 27396720, 27396794 -27396813, 27397048, 27398080, 27398660, 27400416, 27400598, 27401637 -27404573, 27404668, 27405242, 27405645, 27405696, 27406105, 27410279 -27410300, 27410595, 27412805, 27416327, 27416997, 27417186, 27420715 -27421101, 27421733, 27422874, 27423251, 27424405, 27425507, 27425622 -27426363, 27427805, 27430802, 27432062, 27432338, 27432355, 27432826 -27433385, 27433870, 27434050, 27434193, 27434486, 27434974, 27435537 -27439835, 27441326, 27441980, 27442041, 27444727, 27445330, 27445462 -27445727, 27447452, 27447687, 27448162, 27449814, 27450355, 27450400 -27450783, 27451049, 27451182, 27451187, 27451531, 27452046, 27452760 -27453225, 27454722, 27457666, 27457891, 27458164, 27459593, 27459909 -27459948, 27460675, 27462994, 27466597, 27467543, 27468303, 27469245 -27469329, 27471876, 27472969, 27473800, 27479358, 27480784, 27483974 -27484556, 27486253, 27486805, 27487309, 27487795, 27487919, 27489107 -27489719, 27493674, 27494663, 27496224, 27496308, 27496424, 27497950 -27498477, 27501327, 27501413, 27501465, 27502420, 27504190, 27504770 -27505229, 27505603, 27506774, 27507968, 27508985, 27510959, 27511196 -27512439, 27517818, 27518227, 27518310, 27520070, 27520900, 27522245 -27523368, 27523800, 27525909, 27526744, 27529661, 27532375, 27533780 -27533819, 27534509, 27537472, 27539757, 27540613, 27541286, 27541468 -27542824, 27544030, 27544973, 27545630, 27547732, 27550341, 27551855 -27554074, 27555481, 27558557, 27558559, 27558861, 27560602, 27560702 -27562488, 27563629, 27563767, 27565906, 27567477, 27570318, 27576342 -27576354, 27577758, 27578007, 27579353, 27580996, 27585755, 27585800 -27586810, 27586895, 27587672, 27587905, 27588271, 27591842, 27592466 -27593389, 27593501, 27593585, 27595096, 27595973, 27599689, 27599927 -27601118, 27601441, 27602091, 27602488, 27603841, 27604293, 27607563 -27607805, 27608669, 27610269, 27613080, 27613247, 27613530, 27615608 -27616657, 27617522, 27617978, 27620808, 27623159, 27623844, 27625274 -27625620, 27629756, 27631506, 27632114, 27634676, 27634991, 27635508 -27644757, 27645231, 27645940, 27649707, 27652302, 27654521, 27655217 -27657712, 27658186, 27658205, 27662528, 27663370, 27664702, 27666312 -27671633, 27679488, 27679664, 27679793, 27679806, 27679961, 27680162 -27680509, 27680669, 27682151, 27686599, 27688036, 27688099, 27688692 -27690513, 27690578, 27691809, 27691920, 27691939, 27692215, 27693416 -27693713, 27694261, 27695063, 27697092, 27698953, 27700466, 27701795 -27704237, 27705761, 27707544, 27709046, 27710072, 27718914, 27719187 -27723002, 27723151, 27726269, 27726780, 27729678, 27732323, 27733415 -27739006, 27740424, 27740844, 27744211, 27745220, 27747869, 27748954 -27751006, 27751755, 27753336, 27756900, 27757567, 27757794, 27757888 -27758544, 27758653, 27758972, 27759077, 27759457, 27761402, 27766324 -27767081, 27769361, 27772093, 27772815, 27773602, 27774320, 27774539 -27779886, 27780562, 27780683, 27782339, 27783289, 27786772, 27791223 -27793533, 27797290, 27801337, 27803665, 27807441, 27810967, 27812560 -27812593, 27813267, 27815347, 27818389, 27818871, 27819881, 27824540 -27824543, 27825241, 27828794, 27829295, 27832643, 27833369, 27833672 -27834551, 27834569, 27834984, 27835925, 27839353, 27840386, 27843646 -27846298, 27846499, 27847259, 27849825, 27850112, 27851757, 27856471 -27861226, 27861452, 27861909, 27869075, 27869339, 27873412, 27873643 -27876671, 27882176, 27886087, 27892488, 27896443, 27896458, 27897759 -27898015, 27900663, 27902561, 27908644, 27909478, 27912301, 27917669 -27918832, 27920184, 27924147, 27926113, 27927431, 27929287, 27930478 -27931299, 27934468, 27935348, 27935464, 27935493, 27938736, 27940876 -27941110, 27941896, 27945870, 27948050, 27948153, 27950708, 27952762 -27959594, 27960021, 27961746, 27964051, 27965400, 27965830, 27966472 -27967484, 27970265, 27971503, 27971575, 27972265, 27975778, 27977039 -27983174, 27984028, 27986817, 27989556, 27989849, 27991970, 27993289 -27994325, 27994333, 27995215, 27995248, 27997875, 27998003, 27999073 -27999597, 27999638, 28000269, 28004853, 28006704, 28018962, 28019283 -28021205, 28022101, 28022847, 28023081, 28023399, 28023482, 28024347 -28024793, 28025414, 28026866, 28033429, 28036487, 28043157, 28045903 -28057267, 28058612, 28059199, 28067846, 28071549, 28072130, 28072383 -28072464, 28072567, 28074713, 28079127, 28085865, 28088762, 28089440 -28090453, 28091981, 28098160, 28098865, 28103600, 28103869, 28104361 -28104409, 28106402, 28108003, 28108898, 28109326, 28111583, 28120036 -28120951, 28124631, 28125947, 28129791, 28132287, 28135648, 28157786 -28164480, 28165439, 28165545, 28169711, 28174827, 28174951, 28175445 -28180464, 28181021, 28184554, 28184800, 28187706, 28188330, 28189466 -28194173, 28199085, 28201419, 28204262, 28204443, 28209341, 28209985 -28210192, 28211734, 28214943, 28215510, 28218832, 28220398, 28223871 -28226179, 28227512, 28229360, 28236305, 28238264, 28242712, 28250929 -28256164, 28258608, 28264172, 28271107, 28271119, 28271693, 28276054 -28279837, 28281094, 28282606, 28285766, 28290434, 28294563, 28302049 -28304709, 28305001, 28305362, 28309182, 28309406, 28312508, 28315031 -28315995, 28319114, 28319623, 28320117, 28320399, 28321446, 28323201 -28328895, 28329450, 28330714, 28330971, 28333072, 28338399, 28338999 -28344964, 28350595, 28354603, 28357401, 28361083, 28361221, 28361787 -28365111, 28369092, 28371123, 28373960, 28375383, 28378446, 28379065 -28384353, 28385102, 28386259, 28388910, 28390273, 28391210, 28391582 -28392168, 28392251, 28393678, 28396445, 28397317, 28401116, 28402823 -28403295, 28413955, 28420042, 28420457, 28423598, 28432129, 28434028 -28435825, 28437849, 28439086, 28445741, 28448314, 28454215, 28455212 -28468312, 28468493, 28475164, 28478676, 28481149, 28481679, 28483184 -28489150, 28492362, 28493478, 28498976, 28501075, 28502403, 28502773 -28503038, 28503484, 28504545, 28507324, 28508053, 28508296, 28508557 -28512336, 28512761, 28513333, 28514693, 28521330, 28527416, 28528349 -28530171, 28535127, 28535272, 28538439, 28542455, 28544633, 28545134 -28545687, 28546290, 28547068, 28553468, 28558645, 28564479, 28571483 -28572407, 28572834, 28578164, 28578945, 28580528, 28584193, 28584217 -28584444, 28585411, 28587723, 28589509, 28600233, 28608211, 28611037 -28612674, 28614072, 28617631, 28617959, 28621470, 28622202, 28627255 -28627686, 28632559, 28636676, 28639299, 28644549, 28646200, 28670445 -28673203, 28678804, 28679454, 28680029, 28685371, 28692103, 28692275 -28695694, 28697806, 28702188, 28708023, 28709063, 28710469, 28710827 -28713840, 28714058, 28714988, 28728040, 28728272, 28730076, 28734355 -28740708, 28742555, 28747182, 28749289, 28752599, 28755011, 28758090 -28758722, 28761812, 28767240, 28770146, 28774416, 28776811, 28777174 -28777214, 28777332, 28781754, 28785022, 28785531, 28791725, 28797711 -28803345, 28805612, 28805695, 28809909, 28817449, 28819640, 28820669 -28821847, 28830691, 28831971, 28835937, 28836716, 28838066, 28844866 -28849751, 28852691, 28855922, 28856060, 28856172, 28863263, 28863487 -28865569, 28867992, 28876639, 28878525, 28881723, 28887305, 28887509 -28889730, 28891984, 28905457, 28919145, 28925880, 28927452, 28938924 -28940179, 28949888, 28950868, 28951014, 28951382, 28956908, 28959493 -28960211, 28965084, 28965095, 28986231, 28986257, 28987454, 28993295 -28993353, 28993590, 29000190, 29002488, 29006527, 29007321, 29007353 -29009513, 29013832, 29015118, 29015706, 29024054, 29026582, 29027694 -29027940, 29032276, 29033896, 29037290, 29040739, 29048498, 29050886 -29051702, 29056270, 29056767, 29060216, 29061016, 29115857, 29123482 -29125374, 29136111, 29139591, 29158680, 29163567, 29170232, 29171683 -29173817, 29177886, 29179097, 29182517, 29182901, 29189889, 29190663 -29198092, 29200700, 29202461, 29203604, 29205918, 29212433, 29213320 -29213351, 29224605, 29225076, 29230252, 29230565, 29233415, 29237575 -29241345, 29242017, 29247712, 29247906, 29249289, 29250317, 29255273 -29260956, 29261548, 29278684, 29285503, 29301463, 29312672, 29314539 -29331209, 29331493, 29332763, 29339155, 29343086, 29343861, 29347981 -29351662, 29351771, 29353821, 29356752, 29361472, 29364171, 29372460 -29375355, 29375984, 29376346, 29378913, 29379978, 29382784, 29383695 -29386635, 29388020, 29388952, 29391849, 29394749, 29395657, 29398488 -29399046, 29399336, 29404483, 29405462, 29407804, 29408853, 29409149 -29409455, 29412269, 29417719, 29426241, 29429264, 29430524, 29434301 -29436454, 29437712, 29439522, 29448498, 29450812, 29452251, 29454978 -29457978, 29464779, 29465177, 29483626, 29483672, 29483723, 29483771 -29489436, 29493122, 29500257, 29500963, 29504682, 29511611, 29515766 -29521862, 29524599, 29524985, 29525886, 29530515, 29531541, 29536342 -29538631, 29541742, 29542449, 29542580, 29548413, 29548592, 29549071 -29557261, 29558238, 29580394, 29591343, 29604257, 29607136, 29614098 -29616244, 29625065, 29626154, 29629430, 29629745, 29632265, 29633753 -29637526, 29643721, 29645349, 29651520, 29656843, 29667994, 29668005 -29676089, 29685137, 29687220, 29687459, 29703195, 29707896, 29719146 -29720133, 29724041, 29726695, 29739576, 29773197, 29780140, 29782211 -29791152, 29794462, 29807964, 29813494, 29817278, 29825525, 29827852 -29841687, 29846645, 29853485, 29865188, 29869404, 29875459, 29876358 -29881050, 29884958, 29891916, 29893132, 29896510, 29902299, 29914449 -29944035, 29944660, 29951620, 29961353, 29962927, 29962939, 29991257 -29997326, 30018017, 30031027, 30034456, 30064268, 30073744, 30074349 -30076253, 30078934, 30088912, 30098251, 30099302, 30114477, 30120608 -30125944, 30128047, 30131286, 30147928, 30149035, 30163243, 30164714 -30173113, 30177597, 30179644, 30189023, 30193165, 30194710, 30196358 -30200758, 30215130, 30218044, 30218317, 30223712, 30232638, 30239480 -30241567, 30246179, 30247305, 30252098, 30252156, 30253255, 30259008 -30265523, 30272329, 30282501, 30283932, 30305880, 30312094, 30342878 -30352623, 30355490, 30364613, 30365745, 30374739, 30384152, 30402386 -30403763, 30408515, 30409339, 30412188, 30413137, 30416034, 30431274 -30441687, 30453442, 30458593, 30460922, 30475115, 30485255, 30496957 -30497057, 30501574, 30503943, 30509277, 30510527, 30582500, 30613937 -30635302, 30654454, 30671813, 30741263, 30783551, 30803210, 30815852 -30881588, 30533172, 30312559, 30085980, 29997959, 29997937, 28852325 -28125601, 29213893, 28730253, 27304131, 27539876, 27952586, 27642235 -27636900, 27461740, 28278547, 28278640, 27936676, 28502098, 28915870 -28601874, 29445548, 29254623, 29774362, 30160625, 30534662, 26914402 -30855101, 12816839, 18701017, 22734786, 23698980, 23840305, 25709124 -25724089, 26299684, 26313403, 26433972, 26527054, 26586174, 26587652 -26647619, 26827699, 26860285, 26882126, 26882316, 26943660, 26996813 -27012915, 27018734, 27032726, 27034318, 27040560, 27080748, 27086406 -27092991, 27098733, 27106915, 27114112, 27121566, 27133637, 27144533 -27153755, 27166715, 27174938, 27174948, 27177551, 27177852, 27182006 -27182064, 27184253, 27204476, 27212837, 27213140, 27220610, 27222423 -27222938, 27238077, 27238258, 27249544, 27252023, 27257509, 27263677 -27265816, 27267992, 27271876, 27274143, 27285557, 27299455, 27300007 -27302415, 27309182, 27314512, 27315159, 27320985, 27334353, 27338838 -27346984, 27358232, 27362190, 27370933, 27377219, 27378959, 27379846 -27379956, 27393421, 27398223, 27399499, 27399762, 27399985, 27401618 -27403244, 27404599, 27426277, 27428790, 27430219, 27430254, 27433163 -27452897, 27458829, 27465480, 27475272, 27481406, 27481765, 27492916 -27496806, 27503318, 27503413, 27508936, 27508984, 27513114, 27519708 -27526362, 27528204, 27532009, 27534289, 27560562, 27560735, 27573154 -27573408, 27574335, 27577122, 27579969, 27581484, 27593587, 27595801 -27600706, 27609819, 27625010, 27625050, 27627992, 27654039, 27657467 -27657920, 27668379, 27682288, 27691717, 27702244, 27703242, 27708711 -27714373, 27725967, 27731346, 27734470, 27735534, 27739957, 27740854 -27747407, 27748321, 27757979, 27766679, 27768034, 27778433, 27782464 -27783059, 27786669, 27786699, 27801774, 27811439, 27839732, 27850736 -27862636, 27864737, 27865439, 27889841, 27896388, 27897639, 27906509 -27931506, 27935826, 27941514, 27957892, 27978668, 27984314, 27993298 -28023410, 28025398, 28032758, 28039471, 28039953, 28045209, 28099592 -28109698, 28174926, 28182503, 28204423, 28240153 -``` - -## Version 18\.0\.0\.0\.ru\-2020\-01\.rur\-2020\-01\.r1 - -Version 18\.0\.0\.0\.ru\-2020\-01\.rur\-2020\-01\.r1 includes the following: -+ Patch 30480385: Database Release Update: 18\.9\.0\.0\.200114 -+ Patch 30501926: OJVM RELEASE UPDATE: 18\.9\.0\.0\.200114 -+ Patch 29997937: DSTv34 for RDBMS \(TZDATA2019B\) -+ Patch 29997959: DSTv34 for OJVM \(TZDATA2019G\) -+ PreUpgrade Jar: preupgrade\_181\_cbuild\_9\_lf\.zip -+ Patch 28730253: SUPPORT NEW ERA REIWA FOR JAPANESE IMPERIAL CALENDAR is included in DB PATCH 30138470 -+ Patch 29213893: DBMS\_STATS FAILING WITH ERROR ORA\-01422 WHEN GATHERING STATS FOR USER$ TABLE - -### Oracle release update 18\.9\.0\.0\.200114, released January 2020 - -Bugs fixed: - -``` - -8932139, 9062315, 13554903, 14221306, 20436508, 20549013, 21095391 -21223848, 21374587, 21547051, 21744603, 21766220, 21806121, 21935698 -22174392, 22282748, 22363790, 22645496, 23003564, 23061453, 23109325 -23310101, 23761724, 24489904, 24687075, 24689376, 24737581, 24841671 -24844841, 24903291, 24925863, 24971597, 25035594, 25035599, 25060506 -25210690, 25287072, 25293659, 25303284, 25309116, 25348956, 25405687 -25487146, 25573623, 25591292, 25607397, 25634405, 25644811, 25663488 -25686739, 25696520, 25726981, 25736428, 25743479, 25756945, 25824236 -25882883, 25890002, 25908728, 25911069, 25929650, 25943740, 25958554 -25986062, 25997810, 26083489, 26115103, 26164661, 26226953, 26237338 -26281476, 26284722, 26297826, 26336101, 26362155, 26399691, 26405036 -26410240, 26422277, 26423085, 26427905, 26440169, 26450454, 26476244 -26521043, 26536320, 26595088, 26598422, 26615291, 26617804, 26646549 -26654411, 26694735, 26724511, 26731697, 26745002, 26785169, 26790514 -26792891, 26798411, 26818960, 26822620, 26843558, 26843664, 26846077 -26871815, 26883456, 26894737, 26895149, 26898279, 26910716, 26927998 -26928317, 26933599, 26943004, 26956033, 26960097, 26961415, 26966120 -26966916, 26970175, 26976568, 26985002, 26986173, 26992964, 27000158 -27005278, 27006120, 27006664, 27016033, 27026401, 27028251, 27030974 -27033520, 27034688, 27035653, 27036163, 27036408, 27037839, 27038986 -27041253, 27044169, 27044575, 27047831, 27053044, 27054231, 27058530 -27060167, 27060859, 27061736, 27066451, 27066519, 27072923, 27073066 -27075854, 27080874, 27086821, 27090765, 27093423, 27101105, 27101527 -27101652, 27105900, 27106301, 27110878, 27111780, 27112686, 27115422 -27119621, 27119861, 27122162, 27125872, 27126666, 27128580, 27135647 -27142529, 27143756, 27143882, 27144928, 27147979, 27150500, 27151826 -27152892, 27153641, 27155549, 27156355, 27160360, 27160922, 27163928 -27164352, 27165231, 27166354, 27169796, 27169888, 27170305, 27179264 -27181521, 27181537, 27181897, 27185188, 27187440, 27189611, 27190851 -27193810, 27195935, 27197334, 27199245, 27200959, 27202015, 27203055 -27208795, 27208953, 27210038, 27210263, 27210872, 27214085, 27214204 -27215007, 27216046, 27216224, 27220937, 27221900, 27222121, 27222626 -27223075, 27224987, 27226913, 27228786, 27229389, 27231051, 27232983 -27233563, 27234962, 27236052, 27236110, 27236722, 27240246, 27240570 -27241221, 27241247, 27242226, 27242616, 27244337, 27244785, 27244999 -27249215, 27249531, 27250547, 27251690, 27254851, 27255377, 27256000 -27256488, 27256534, 27256584, 27258578, 27259307, 27259386, 27259983 -27262601, 27262650, 27262798, 27262945, 27262991, 27263276, 27263996 -27264464, 27266245, 27270197, 27274456, 27274536, 27275136, 27275533 -27275776, 27276231, 27282707, 27283029, 27283960, 27284375, 27284499 -27285244, 27288230, 27288638, 27288894, 27292213, 27293599, 27294480 -27301308, 27301568, 27302594, 27302632, 27302681, 27302695, 27302711 -27302714, 27302730, 27302777, 27302800, 27302960, 27303287, 27303785 -27303938, 27304410, 27304906, 27304936, 27305318, 27307868, 27308088 -27310092, 27313687, 27314206, 27314390, 27318117, 27318869, 27320576 -27321179, 27321834, 27326204, 27329812, 27330158, 27330161, 27333658 -27333664, 27333693, 27333731, 27334316, 27334648, 27335682, 27338912 -27338946, 27339115, 27339396, 27339483, 27339495, 27341036, 27345190 -27345231, 27345450, 27345498, 27346329, 27346644, 27346709, 27346949 -27347126, 27348081, 27348707, 27349393, 27350267, 27351628, 27352600 -27354783, 27356373, 27357773, 27358241, 27359178, 27359368, 27360126 -27364854, 27364891, 27364916, 27364947, 27365139, 27365702, 27365993 -27367194, 27368850, 27369515, 27372756, 27375260, 27375542, 27376871 -27378103, 27379233, 27381383, 27381417, 27381498, 27381656, 27383281 -27384222, 27386467, 27389352, 27392187, 27393570, 27394086, 27395404 -27395416, 27395794, 27396357, 27396365, 27396377, 27396624, 27396666 -27396672, 27396720, 27396813, 27397048, 27398080, 27398660, 27400416 -27400598, 27401637, 27404573, 27404668, 27405242, 27405645, 27405696 -27406105, 27410279, 27410300, 27410595, 27412805, 27416327, 27416997 -27417186, 27420715, 27421101, 27421733, 27422874, 27423251, 27424405 -27425507, 27425622, 27426363, 27427805, 27430802, 27432062, 27432338 -27432355, 27432826, 27433385, 27433870, 27434050, 27434193, 27434486 -27434974, 27435537, 27439835, 27441326, 27441980, 27442041, 27444727 -27445330, 27445462, 27445727, 27447452, 27447687, 27448162, 27449814 -27450355, 27450400, 27450783, 27451049, 27451182, 27451187, 27451531 -27452046, 27452760, 27453225, 27454722, 27457666, 27457891, 27458164 -27459909, 27459948, 27460675, 27462994, 27466597, 27467543, 27468303 -27469245, 27469329, 27471876, 27472969, 27473800, 27479358, 27480784 -27483974, 27484556, 27486253, 27486805, 27487309, 27487795, 27487919 -27489107, 27489719, 27493674, 27496224, 27496308, 27496424, 27497950 -27498477, 27501327, 27501413, 27501465, 27502420, 27504190, 27504770 -27505229, 27505603, 27506774, 27507968, 27508985, 27510959, 27511196 -27512439, 27517818, 27518227, 27518310, 27520070, 27520900, 27522245 -27523368, 27523800, 27525909, 27526744, 27529661, 27532375, 27533780 -27533819, 27534509, 27537472, 27539757, 27540613, 27541286, 27541468 -27542824, 27544030, 27544973, 27545630, 27547732, 27550341, 27551855 -27554074, 27555481, 27558557, 27558559, 27558861, 27560602, 27560702 -27562488, 27563629, 27563767, 27565906, 27567477, 27570318, 27576342 -27576354, 27577758, 27578007, 27579353, 27580996, 27585755, 27585800 -27586810, 27586895, 27587672, 27587905, 27588271, 27591842, 27592466 -27593389, 27593501, 27593585, 27595096, 27595973, 27599689, 27599927 -27601118, 27601441, 27602091, 27602488, 27603841, 27604293, 27607563 -27607805, 27608669, 27610269, 27613080, 27613247, 27613530, 27615608 -27616657, 27617522, 27617978, 27620808, 27623159, 27623844, 27625274 -27625620, 27629756, 27631506, 27632114, 27634676, 27634991, 27635508 -27644757, 27645940, 27649707, 27652302, 27654521, 27655217, 27657712 -27658186, 27658205, 27662528, 27663370, 27664702, 27666312, 27671633 -27679488, 27679664, 27679793, 27679806, 27679961, 27680162, 27680509 -27680669, 27682151, 27686599, 27688036, 27688099, 27688692, 27690513 -27690578, 27691809, 27691920, 27691939, 27692215, 27693416, 27693713 -27694261, 27695063, 27697092, 27698953, 27700466, 27701795, 27704237 -27705761, 27707544, 27709046, 27710072, 27718914, 27719187, 27723002 -27723151, 27726269, 27726780, 27729678, 27732323, 27733415, 27739006 -27740424, 27740844, 27744211, 27745220, 27747869, 27748954, 27751006 -27751755, 27753336, 27756900, 27757567, 27757794, 27757888, 27758544 -27758653, 27758972, 27759077, 27759457, 27761402, 27766324, 27767081 -27769361, 27772093, 27772815, 27773602, 27774320, 27774539, 27779886 -27780562, 27780683, 27782339, 27783289, 27786772, 27791223, 27793533 -27797290, 27801337, 27803665, 27807441, 27810967, 27812560, 27812593 -27813267, 27815347, 27818389, 27818871, 27819881, 27824540, 27824543 -27825241, 27828794, 27829295, 27832643, 27833369, 27833672, 27834551 -27834569, 27834984, 27835925, 27839353, 27840386, 27843646, 27846298 -27846499, 27847259, 27849825, 27850112, 27851757, 27856471, 27861226 -27861452, 27861909, 27869075, 27869339, 27873412, 27873643, 27876671 -27882176, 27886087, 27892488, 27896443, 27896458, 27897759, 27898015 -27900663, 27902561, 27908644, 27909478, 27912301, 27917669, 27918832 -27920184, 27924147, 27926113, 27927431, 27929287, 27930478, 27931299 -27934468, 27935348, 27935493, 27938736, 27940876, 27941110, 27941896 -27945870, 27948050, 27948153, 27950708, 27952762, 27959594, 27960021 -27961746, 27964051, 27965400, 27965830, 27966472, 27967484, 27970265 -27971503, 27971575, 27972265, 27975778, 27977039, 27983174, 27984028 -27986817, 27989556, 27989849, 27991970, 27993289, 27994325, 27994333 -27995215, 27995248, 27997875, 27998003, 27999073, 27999597, 27999638 -28000269, 28004853, 28006704, 28018962, 28019283, 28021205, 28022101 -28022847, 28023081, 28023399, 28023482, 28024347, 28026866, 28033429 -28036487, 28043157, 28045903, 28057267, 28058612, 28059199, 28067846 -28071549, 28072130, 28072464, 28072567, 28074713, 28079127, 28085865 -28088762, 28089440, 28090453, 28091981, 28098160, 28098865, 28103600 -28103869, 28104361, 28104409, 28106402, 28108003, 28108898, 28109326 -28111583, 28120036, 28120951, 28124631, 28125947, 28129791, 28132287 -28135648, 28164480, 28165439, 28165545, 28169711, 28174827, 28174951 -28175445, 28180464, 28181021, 28184554, 28184800, 28187706, 28188330 -28189466, 28194173, 28199085, 28201419, 28204262, 28204443, 28209341 -28209985, 28210192, 28211734, 28214943, 28215510, 28218832, 28220398 -28223871, 28226179, 28227512, 28229360, 28236305, 28238264, 28242712 -28256164, 28258608, 28264172, 28271119, 28271693, 28279837, 28281094 -28282606, 28285766, 28290434, 28294563, 28302049, 28304709, 28305001 -28305362, 28309182, 28309406, 28312508, 28315031, 28315995, 28319114 -28319623, 28320117, 28320399, 28321446, 28323201, 28328895, 28329450 -28330714, 28330971, 28333072, 28338399, 28338999, 28344964, 28350595 -28354603, 28357401, 28361083, 28361221, 28361787, 28365111, 28369092 -28371123, 28373960, 28375383, 28378446, 28379065, 28384353, 28385102 -28386259, 28388910, 28390273, 28391210, 28391582, 28392168, 28392251 -28393678, 28396445, 28397317, 28401116, 28402823, 28403295, 28413955 -28420042, 28420457, 28423598, 28432129, 28434028, 28435825, 28437849 -28445741, 28448314, 28454215, 28455212, 28468312, 28468493, 28475164 -28478676, 28481149, 28481679, 28483184, 28489150, 28492362, 28493478 -28498976, 28501075, 28502403, 28502773, 28503484, 28504545, 28507324 -28508053, 28508296, 28508557, 28512336, 28512761, 28513333, 28514693 -28521330, 28527416, 28528349, 28530171, 28535272, 28538439, 28542455 -28544633, 28545134, 28545687, 28546290, 28547068, 28553468, 28558645 -28571483, 28572407, 28572834, 28578164, 28578945, 28580528, 28584193 -28584217, 28584444, 28585411, 28587723, 28589509, 28600233, 28612674 -28614072, 28617631, 28617959, 28621470, 28627255, 28627686, 28632559 -28636676, 28639299, 28644549, 28646200, 28670445, 28673203, 28678804 -28679454, 28680029, 28685371, 28692103, 28692275, 28695694, 28697806 -28702188, 28708023, 28710827, 28713840, 28714058, 28714988, 28728040 -28728272, 28730076, 28734355, 28742555, 28747182, 28749289, 28752599 -28755011, 28758090, 28758722, 28761812, 28767240, 28770146, 28774416 -28776811, 28777174, 28777214, 28777332, 28781754, 28785022, 28785531 -28791725, 28797711, 28803345, 28805612, 28805695, 28809909, 28817449 -28819640, 28820669, 28821847, 28830691, 28831971, 28836716, 28838066 -28844866, 28849751, 28852691, 28855922, 28856060, 28856172, 28863487 -28867992, 28876639, 28878525, 28881723, 28887305, 28887509, 28889730 -28891984, 28905457, 28919145, 28925880, 28927452, 28938924, 28940179 -28949888, 28951014, 28951382, 28956908, 28959493, 28960211, 28965084 -28965095, 28986231, 28986257, 28987454, 28993353, 28993590, 29000190 -29002488, 29006527, 29007321, 29007353, 29009513, 29013832, 29015118 -29015706, 29024054, 29027694, 29027940, 29032276, 29033896, 29037290 -29040739, 29050886, 29051702, 29056270, 29056767, 29060216, 29061016 -29115857, 29123482, 29125374, 29136111, 29139591, 29158680, 29163567 -29170232, 29171683, 29173817, 29177886, 29182901, 29189889, 29190663 -29198092, 29200700, 29202461, 29203604, 29205918, 29212433, 29213320 -29213351, 29224605, 29225076, 29230252, 29230565, 29233415, 29237575 -29241345, 29242017, 29247906, 29250317, 29255273, 29260956, 29261548 -29278684, 29285503, 29301463, 29312672, 29314539, 29331209, 29331493 -29339155, 29347981, 29351662, 29353821, 29356752, 29364171, 29375355 -29375984, 29376346, 29378913, 29379978, 29382784, 29383695, 29386635 -29388020, 29388952, 29391849, 29394749, 29395657, 29398488, 29399336 -29404483, 29405462, 29407804, 29408853, 29409149, 29412269, 29417719 -29429264, 29430524, 29434301, 29436454, 29437712, 29439522, 29448498 -29450812, 29452251, 29454978, 29457978, 29464779, 29465177, 29483626 -29483672, 29483723, 29483771, 29489436, 29493122, 29500257, 29504682 -29511611, 29515766, 29524599, 29525886, 29530515, 29531541, 29536342 -29538631, 29541742, 29542449, 29548413, 29549071, 29557261, 29558238 -29604257, 29607136, 29614098, 29616244, 29626154, 29629430, 29629745 -29632265, 29633753, 29637526, 29643721, 29645349, 29651520, 29667994 -29668005, 29676089, 29687459, 29703195, 29707896, 29719146, 29720133 -29724041, 29726695, 29739576, 29773197, 29782211, 29791152, 29794462 -29813494, 29817278, 29825525, 29841687, 29846645, 29853485, 29865188 -29869404, 29875459, 29884958, 29893132, 29914449, 29944035, 29944660 -29951620, 29962927, 29962939, 29991257, 29997326, 30034456, 30074349 -30088912, 30098251, 30125944, 30164714, 30189023, 30193165, 30218044 -30223712, 30252098, 30252156, 30253255, 30259008, 30342878, 30365745 -30402386, 30408515, 30458593, 30485255 -``` - -## Version 18\.0\.0\.0\.ru\-2019\-10\.rur\-2019\-10\.r1 - -Version 18\.0\.0\.0\.ru\-2019\-10\.rur\-2019\-10\.r1 includes the following: -+ Patch 30112122: DATABASE OCT 2019 RELEASE UPDATE 18\.8\.0\.0\.191015 -+ Patch 30133625: OJVM RELEASE UPDATE 12\.2\.0\.1\.191015 -+ Patch 29997937: DSTv34 for RDBMS \(TZDATA2019G\) -+ Patch 29997959: DSTv34 for OJVM \(TZDATA2019G\) -+ PreUpgrade Jar: preupgrade\_181\_cbuild\_8\_lf\.zip -+ Patch 28730253: SUPPORT NEW ERA REIWA FOR JAPANESE IMPERIAL CALENDAR is included in DB PATCH 30138470 -+ Patch 29213893: DBMS\_STATS FAILING WITH ERROR ORA\-01422 WHEN GATHERING STATS FOR USER$ TABLE -+ Support for [Resizing the temporary tablespace in a read replica](Appendix.Oracle.CommonDBATasks.Database.md#Appendix.Oracle.CommonDBATasks.ResizeTempSpaceReadReplica) - -### Oracle release update 18\.8\.0\.0\.0, released October 2019 - -Bugs fixed: - -``` - -30259008, 30253255, 8932139, 9062315, 13554903, 14221306, 20436508 -21095391, 21223848, 21374587, 21547051, 21744603, 21766220, 21806121 -21935698, 23003564, 23061453, 23310101, 23761724, 24489904, 24687075 -24689376, 24737581, 24841671, 24844841, 24903291, 24925863, 24971597 -25035594, 25035599, 25060506, 25287072, 25293659, 25303284, 25309116 -25348956, 25405687, 25487146, 25591292, 25607397, 25634405, 25644811 -25663488, 25686739, 25696520, 25726981, 25736428, 25743479, 25756945 -25824236, 25882883, 25890002, 25908728, 25911069, 25929650, 25943740 -25958554, 25986062, 25997810, 26083489, 26115103, 26164661, 26226953 -26237338, 26281476, 26284722, 26297826, 26336101, 26362155, 26399691 -26422277, 26423085, 26427905, 26440169, 26450454, 26476244, 26521043 -26536320, 26595088, 26598422, 26615291, 26617804, 26646549, 26654411 -26694735, 26724511, 26731697, 26745002, 26785169, 26790514, 26792891 -26798411, 26818960, 26822620, 26843558, 26843664, 26846077, 26871815 -26883456, 26894737, 26895149, 26898279, 26910716, 26927998, 26928317 -26933599, 26943004, 26956033, 26960097, 26961415, 26966120, 26966916 -26970175, 26976568, 26985002, 26986173, 26992964, 27000158, 27005278 -27006120, 27006664, 27016033, 27026401, 27028251, 27030974, 27033520 -27034688, 27035653, 27036408, 27037839, 27038986, 27041253, 27044575 -27047831, 27053044, 27054231, 27058530, 27060167, 27060859, 27061736 -27066451, 27066519, 27072923, 27073066, 27075854, 27080874, 27086821 -27090765, 27093423, 27101105, 27101527, 27101652, 27105900, 27106301 -27110878, 27111780, 27112686, 27115422, 27119621, 27122162, 27125872 -27126666, 27128580, 27135647, 27142529, 27143756, 27143882, 27144928 -27147979, 27150500, 27151826, 27152892, 27153641, 27155549, 27156355 -27160360, 27160922, 27163928, 27164352, 27165231, 27166354, 27169796 -27169888, 27170305, 27179264, 27181521, 27181537, 27181897, 27185188 -27187440, 27189611, 27190851, 27193810, 27197334, 27199245, 27200959 -27202015, 27208795, 27208953, 27210038, 27210263, 27210872, 27214085 -27214204, 27215007, 27216046, 27216224, 27220937, 27221900, 27222121 -27222626, 27223075, 27224987, 27226913, 27228786, 27229389, 27231051 -27232983, 27233563, 27236052, 27236110, 27236722, 27240246, 27240570 -27241221, 27241247, 27242226, 27242616, 27244337, 27244785, 27249215 -27249531, 27250547, 27251690, 27254851, 27255377, 27256000, 27256488 -27256534, 27256584, 27258578, 27259307, 27259386, 27259983, 27262601 -27262650, 27262798, 27262945, 27262991, 27263276, 27263996, 27264464 -27266245, 27270197, 27274456, 27274536, 27275136, 27275533, 27275776 -27276231, 27282707, 27283029, 27283960, 27284375, 27284499, 27285244 -27288230, 27288638, 27288894, 27292213, 27293599, 27294480, 27301308 -27301568, 27302594, 27302632, 27302681, 27302695, 27302711, 27302714 -27302730, 27302777, 27302800, 27302960, 27303287, 27303785, 27303938 -27304410, 27304906, 27304936, 27305318, 27307868, 27308088, 27310092 -27313687, 27314206, 27314390, 27318117, 27318869, 27320576, 27321179 -27321834, 27326204, 27329812, 27330158, 27330161, 27333658, 27333664 -27333693, 27333731, 27334316, 27334648, 27335682, 27338912, 27338946 -27339115, 27339396, 27339483, 27339495, 27341036, 27345190, 27345231 -27345450, 27345498, 27346329, 27346644, 27346709, 27346949, 27347126 -27348081, 27348707, 27349393, 27350267, 27351628, 27352600, 27354783 -27356373, 27357773, 27358241, 27359178, 27359368, 27360126, 27364854 -27364891, 27364916, 27364947, 27365139, 27365702, 27365993, 27367194 -27368850, 27369515, 27372756, 27375260, 27375542, 27376871, 27378103 -27379233, 27381383, 27381417, 27381498, 27381656, 27383281, 27384222 -27386467, 27389352, 27392187, 27393570, 27394086, 27395404, 27395416 -27395794, 27396357, 27396365, 27396377, 27396624, 27396666, 27396672 -27396813, 27397048, 27398080, 27398660, 27400416, 27400598, 27401637 -27404573, 27404668, 27405242, 27405645, 27405696, 27406105, 27410279 -27410300, 27410595, 27412805, 27416327, 27416997, 27417186, 27420715 -27421101, 27421733, 27422874, 27423251, 27424405, 27425507, 27425622 -27426363, 27427805, 27430802, 27432062, 27432338, 27432355, 27432826 -27433385, 27433870, 27434050, 27434193, 27434486, 27434974, 27435537 -27439835, 27441326, 27441980, 27442041, 27444727, 27445330, 27445462 -27445727, 27447452, 27447687, 27448162, 27449814, 27450355, 27450400 -27450783, 27451049, 27451182, 27451187, 27451531, 27452046, 27452760 -27453225, 27454722, 27457666, 27457891, 27458164, 27459909, 27459948 -27460675, 27462994, 27466597, 27467543, 27468303, 27469245, 27469329 -27471876, 27472969, 27473800, 27479358, 27480784, 27483974, 27484556 -27486253, 27487309, 27487795, 27487919, 27489719, 27493674, 27496224 -27496308, 27496424, 27497950, 27498477, 27501327, 27501413, 27501465 -27502420, 27504190, 27504770, 27505229, 27505603, 27506774, 27507968 -27508985, 27510959, 27511196, 27512439, 27517818, 27518227, 27518310 -27520070, 27520900, 27522245, 27523368, 27523800, 27525909, 27526744 -27532375, 27533780, 27533819, 27534509, 27537472, 27539757, 27540613 -27541286, 27541468, 27542824, 27544030, 27544973, 27545630, 27547732 -27550341, 27551855, 27554074, 27555481, 27558557, 27558559, 27558861 -27560602, 27560702, 27562488, 27563629, 27563767, 27565906, 27567477 -27570318, 27576342, 27576354, 27577758, 27578007, 27579353, 27580996 -27585755, 27585800, 27586810, 27586895, 27587672, 27588271, 27591842 -27592466, 27593389, 27593501, 27593585, 27595973, 27599689, 27599927 -27601118, 27601441, 27602091, 27602488, 27603841, 27604293, 27607563 -27607805, 27608669, 27610269, 27613080, 27613247, 27613530, 27615608 -27616657, 27617522, 27617978, 27620808, 27623159, 27623844, 27625274 -27625620, 27629756, 27631506, 27632114, 27634676, 27634991, 27635508 -27644757, 27645940, 27649707, 27652302, 27654521, 27655217, 27658186 -27658205, 27662528, 27663370, 27664702, 27666312, 27671633, 27679488 -27679664, 27679793, 27679806, 27679961, 27680162, 27680509, 27680669 -27682151, 27686599, 27688036, 27688099, 27688692, 27690513, 27690578 -27691809, 27691920, 27691939, 27692215, 27693416, 27693713, 27694261 -27695063, 27697092, 27698953, 27700466, 27701795, 27704237, 27705761 -27707544, 27709046, 27710072, 27718914, 27719187, 27723002, 27723151 -27726269, 27726780, 27729678, 27732323, 27733415, 27739006, 27740424 -27740844, 27744211, 27745220, 27747869, 27748954, 27751006, 27751755 -27753336, 27756900, 27757567, 27757794, 27757888, 27758544, 27758653 -27758972, 27759077, 27759457, 27761402, 27766324, 27767081, 27772093 -27772815, 27773602, 27774320, 27774539, 27779886, 27780562, 27782339 -27783289, 27786772, 27791223, 27793533, 27797290, 27801337, 27803665 -27807441, 27810967, 27812560, 27812593, 27813267, 27815347, 27818871 -27824540, 27824543, 27825241, 27829295, 27832643, 27833369, 27833672 -27834551, 27834569, 27834984, 27835925, 27839353, 27840386, 27843646 -27846298, 27846499, 27847259, 27849825, 27850112, 27851757, 27856471 -27861226, 27861452, 27861909, 27869075, 27869339, 27873412, 27873643 -27876671, 27882176, 27886087, 27892488, 27896443, 27896458, 27898015 -27900663, 27902561, 27908644, 27912301, 27918832, 27920184, 27924147 -27926113, 27930478, 27931299, 27934468, 27935348, 27935493, 27938736 -27940876, 27941110, 27941896, 27945870, 27948050, 27948153, 27950708 -27952762, 27959594, 27960021, 27961746, 27964051, 27965400, 27965830 -27966472, 27967484, 27970265, 27971503, 27971575, 27972265, 27975778 -27977039, 27983174, 27984028, 27986817, 27989556, 27989849, 27991970 -27993289, 27994325, 27994333, 27995215, 27995248, 27997875, 27998003 -27999073, 27999597, 27999638, 28000269, 28004853, 28006704, 28018962 -28019283, 28021205, 28022101, 28022847, 28023081, 28023399, 28023482 -28024347, 28026866, 28033429, 28036487, 28043157, 28045903, 28057267 -28058612, 28059199, 28067846, 28072130, 28072464, 28072567, 28074713 -28085865, 28088762, 28090453, 28091981, 28098865, 28103600, 28103869 -28104361, 28104409, 28106402, 28108003, 28108898, 28111583, 28120036 -28120951, 28124631, 28125947, 28129791, 28132287, 28135648, 28165439 -28165545, 28169711, 28174827, 28174951, 28175445, 28180464, 28181021 -28184554, 28184800, 28187706, 28188330, 28189466, 28194173, 28199085 -28201419, 28204443, 28209341, 28210192, 28211734, 28214943, 28215510 -28218832, 28220398, 28223871, 28226179, 28227512, 28229360, 28236305 -28238264, 28242712, 28256164, 28258608, 28264172, 28271119, 28271693 -28279837, 28281094, 28282606, 28285766, 28290434, 28294563, 28302049 -28304709, 28305001, 28305362, 28309182, 28312508, 28315031, 28315995 -28319114, 28319623, 28320117, 28320399, 28321446, 28323201, 28328895 -28329450, 28330714, 28333072, 28338399, 28338999, 28344964, 28350595 -28354603, 28357401, 28361083, 28361221, 28361787, 28365111, 28369092 -28371123, 28378446, 28379065, 28384353, 28385102, 28390273, 28391210 -28391582, 28392168, 28392251, 28393678, 28396445, 28401116, 28403295 -28413955, 28420042, 28420457, 28423598, 28432129, 28434028, 28435825 -28445741, 28448314, 28455212, 28468312, 28475164, 28478676, 28481149 -28481679, 28483184, 28489150, 28492362, 28493478, 28498976, 28501075 -28502403, 28502773, 28503484, 28504545, 28507324, 28508053, 28508296 -28508557, 28512761, 28513333, 28514693, 28521330, 28527416, 28528349 -28535272, 28542455, 28544633, 28545134, 28545687, 28547068, 28553468 -28571483, 28572834, 28578164, 28580528, 28584193, 28584217, 28584444 -28585411, 28587723, 28600233, 28612674, 28614072, 28617631, 28617959 -28621470, 28627255, 28627686, 28632559, 28636676, 28644549, 28646200 -28670445, 28673203, 28678804, 28679454, 28680029, 28685371, 28692103 -28692275, 28695694, 28697806, 28702188, 28708023, 28710827, 28713840 -28714058, 28714988, 28728040, 28728272, 28730076, 28742555, 28747182 -28749289, 28752599, 28755011, 28758090, 28758722, 28761812, 28767240 -28770146, 28774416, 28776811, 28777214, 28781754, 28785022, 28785531 -28791725, 28797711, 28803345, 28805612, 28805695, 28809909, 28817449 -28819640, 28820669, 28831971, 28849751, 28852691, 28855922, 28856060 -28856172, 28867992, 28876639, 28878525, 28881723, 28887509, 28889730 -28891984, 28905457, 28919145, 28925880, 28938924, 28940179, 28951014 -28951382, 28956908, 28960211, 28965084, 28986231, 28987454, 28993353 -28993590, 29000190, 29002488, 29006527, 29009513, 29015118, 29015706 -29024054, 29027694, 29027940, 29032276, 29033896, 29037290, 29051702 -29056270, 29056767, 29123482, 29125374, 29136111, 29139591, 29158680 -29163567, 29171683, 29177886, 29189889, 29198092, 29200700, 29203604 -29205918, 29212433, 29213320, 29213351, 29224605, 29225076, 29230252 -29230565, 29233415, 29241345, 29242017, 29247906, 29250317, 29255273 -29285503, 29301463, 29312672, 29314539, 29331209, 29331493, 29339155 -29347981, 29351662, 29353821, 29356752, 29364171, 29376346, 29378913 -29379978, 29382784, 29386635, 29388020, 29388952, 29391849, 29394749 -29395657, 29398488, 29404483, 29405462, 29407804, 29409149, 29412269 -29417719, 29429264, 29430524, 29436454, 29437712, 29439522, 29464779 -29465177, 29483672, 29483723, 29493122, 29500257, 29504682, 29511611 -29515766, 29524599, 29525886, 29530515, 29531541, 29541742, 29542449 -29548413, 29557261, 29607136, 29614098, 29616244, 29632265, 29633753 -29637526, 29645349, 29668005, 29676089, 29687459, 29707896, 29724041 -29782211, 29813494, 29893132, 30034456, 30088912, 30189023 -``` - -## Version 18\.0\.0\.0\.ru\-2019\-07\.rur\-2019\-07\.r1 - -Version 18\.0\.0\.0\.ru\-2019\-07\.rur\-2019\-07\.r1 includes the following: -+ Patch 29757256: Database Release Update: 18\.7\.0\.0\.190716 -+ Patch 29774410: OJVM RELEASE UPDATE: 18\.7\.0\.0\.190716 -+ Patch 27539475: "ORA\-3816 \- MISSING MESSAGE INFORMATION FOR 3816 ERROR\." -+ Patch 29213893: "DBMS\_STATS FAILING WITH ERROR ORA\-01422 WHEN GATHERING STATS FOR USER$ TABLE" -+ Patch 28125601: DSTv32 for RDBMS \(TZDATA2018E\) -+ Patch 28852325: DSTv33 for RDBMS \(TZDATA2018G\) -+ Patch 28852334: DSTv33 for OJVM \(TZDATA2018G\) -+ PreUpgrade Jar: preupgrade\_181\_cbuild\_7\_lf\.zip -+ Patch 28730253: SUPPORT NEW ERA REIWA FOR JAPANESE IMPERIAL CALENDAR - -### Oracle release update 18\.7\.0\.0\.190716, released July 2019 - -Bugs fixed: - -``` - -8932139, 9062315, 13554903, 14221306, 20436508, 21095391, 21223848 -21547051, 21744603, 21766220, 21806121, 23003564, 23061453, 23310101 -23761724, 24489904, 24689376, 24737581, 24841671, 24844841, 24903291 -24925863, 24971597, 25035594, 25035599, 25287072, 25293659, 25303284 -25309116, 25348956, 25405687, 25487146, 25591292, 25607397, 25634405 -25644811, 25663488, 25686739, 25726981, 25736428, 25743479, 25756945 -25824236, 25882883, 25890002, 25908728, 25911069, 25929650, 25943740 -25958554, 25986062, 25997810, 26083489, 26115103, 26164661, 26226953 -26237338, 26281476, 26284722, 26297826, 26336101, 26362155, 26399691 -26422277, 26423085, 26427905, 26440169, 26450454, 26476244, 26521043 -26536320, 26595088, 26598422, 26615291, 26617804, 26646549, 26654411 -26694735, 26731697, 26745002, 26785169, 26790514, 26792891, 26818960 -26822620, 26843558, 26843664, 26846077, 26871815, 26883456, 26894737 -26895149, 26898279, 26927998, 26928317, 26933599, 26943004, 26956033 -26960097, 26961415, 26966120, 26966916, 26970175, 26985002, 26986173 -26992964, 27000158, 27005278, 27006120, 27006664, 27016033, 27026401 -27028251, 27030974, 27034688, 27035653, 27036408, 27037839, 27038986 -27041253, 27044575, 27047831, 27053044, 27054231, 27058530, 27060167 -27060859, 27061736, 27066451, 27066519, 27073066, 27075854, 27080874 -27086821, 27090765, 27093423, 27101105, 27101527, 27101652, 27105900 -27106301, 27110878, 27111780, 27112686, 27115422, 27119621, 27122162 -27125872, 27126666, 27128580, 27135647, 27142529, 27143756, 27143882 -27147979, 27150500, 27151826, 27152892, 27153641, 27155549, 27156355 -27160360, 27160922, 27163928, 27164352, 27165231, 27166354, 27169796 -27169888, 27170305, 27179264, 27181521, 27181537, 27181897, 27185188 -27187440, 27189611, 27190851, 27193810, 27197334, 27199245, 27200959 -27202015, 27208795, 27208953, 27210038, 27210263, 27210872, 27214085 -27215007, 27216046, 27216224, 27220937, 27221900, 27222121, 27222626 -27223075, 27224987, 27226913, 27228786, 27229389, 27231051, 27232983 -27233563, 27236052, 27236110, 27236722, 27240246, 27240570, 27241221 -27241247, 27242226, 27242616, 27244337, 27244785, 27249215, 27249531 -27250547, 27251690, 27254851, 27255377, 27256000, 27256488, 27256534 -27256584, 27258578, 27259307, 27259386, 27259983, 27262601, 27262650 -27262798, 27262945, 27262991, 27263276, 27263996, 27266245, 27270197 -27274456, 27274536, 27275136, 27275533, 27275776, 27276231, 27282707 -27283029, 27283960, 27284375, 27284499, 27285244, 27288230, 27288638 -27288894, 27292213, 27293599, 27294480, 27301308, 27301568, 27302594 -27302632, 27302681, 27302695, 27302711, 27302714, 27302730, 27302777 -27302800, 27302960, 27303287, 27303785, 27303938, 27304410, 27304936 -27305318, 27307868, 27308088, 27310092, 27313687, 27314206, 27314390 -27318117, 27318869, 27320576, 27321179, 27321834, 27326204, 27329812 -27330158, 27330161, 27333658, 27333664, 27333693, 27333731, 27334316 -27334648, 27335682, 27338912, 27338946, 27339115, 27339396, 27339483 -27339495, 27341036, 27345190, 27345231, 27345450, 27345498, 27346329 -27346644, 27346709, 27346949, 27347126, 27348081, 27348707, 27349393 -27350267, 27351628, 27352600, 27354783, 27356373, 27357773, 27358241 -27359178, 27359368, 27360126, 27364854, 27364891, 27364916, 27364947 -27365139, 27365702, 27365993, 27367194, 27368850, 27372756, 27375260 -27375542, 27376871, 27378103, 27379233, 27381383, 27381417, 27381498 -27381656, 27384222, 27386467, 27389352, 27392187, 27394086, 27395404 -27395416, 27395794, 27396357, 27396365, 27396377, 27396624, 27396666 -27396672, 27396813, 27397048, 27398080, 27398660, 27400416, 27400598 -27401637, 27404668, 27405242, 27405645, 27405696, 27410279, 27410300 -27410595, 27412805, 27416327, 27416997, 27417186, 27420715, 27421101 -27421733, 27422874, 27423251, 27424405, 27425507, 27425622, 27426363 -27427805, 27430802, 27432062, 27432338, 27432355, 27432826, 27433870 -27434050, 27434193, 27434486, 27434974, 27435537, 27439835, 27441326 -27441980, 27442041, 27444727, 27445330, 27445462, 27445727, 27447452 -27447687, 27448162, 27449814, 27450355, 27450400, 27450783, 27451049 -27451182, 27451187, 27451531, 27452046, 27452760, 27453225, 27454722 -27457666, 27457891, 27458164, 27459909, 27460675, 27462994, 27466597 -27467543, 27468303, 27469245, 27469329, 27471876, 27472969, 27473800 -27479358, 27480784, 27483974, 27484556, 27486253, 27487309, 27487795 -27487919, 27489719, 27493674, 27496224, 27496308, 27496424, 27497950 -27498477, 27501327, 27501413, 27501465, 27502420, 27504190, 27504770 -27505229, 27505603, 27506774, 27507968, 27508985, 27510959, 27511196 -27512439, 27517818, 27518227, 27518310, 27520070, 27520900, 27522245 -27523368, 27523800, 27525909, 27526744, 27532375, 27533819, 27534509 -27537472, 27539757, 27540613, 27541286, 27541468, 27542824, 27544030 -27544973, 27545630, 27547732, 27550341, 27551855, 27554074, 27555481 -27558557, 27558559, 27558861, 27560602, 27560702, 27562488, 27563629 -27563767, 27565906, 27567477, 27570318, 27576342, 27577758, 27578007 -27579353, 27580996, 27585755, 27585800, 27586810, 27586895, 27587672 -27591842, 27592466, 27593389, 27593501, 27593585, 27595973, 27599689 -27599927, 27601118, 27602091, 27602488, 27603841, 27604293, 27607563 -27607805, 27608669, 27610269, 27613080, 27613247, 27613530, 27615608 -27616657, 27617522, 27617978, 27620808, 27623844, 27625274, 27625620 -27629756, 27631506, 27634676, 27634991, 27635508, 27644757, 27645940 -27649707, 27652302, 27654521, 27655217, 27658186, 27658205, 27662528 -27663370, 27664702, 27666312, 27671633, 27679488, 27679664, 27679793 -27679806, 27679961, 27680162, 27680509, 27680669, 27682151, 27686599 -27688036, 27688099, 27688692, 27690513, 27690578, 27691809, 27691920 -27691939, 27692215, 27693416, 27693713, 27694261, 27695063, 27697092 -27698953, 27700466, 27701795, 27704237, 27705761, 27707544, 27709046 -27710072, 27718914, 27719187, 27723002, 27723151, 27726269, 27726780 -27729678, 27732323, 27733415, 27739006, 27740424, 27740844, 27744211 -27745220, 27747869, 27748954, 27751006, 27751755, 27753336, 27756900 -27757567, 27757794, 27757888, 27758972, 27759077, 27759457, 27761402 -27766324, 27767081, 27772093, 27772815, 27773602, 27774320, 27774539 -27779886, 27780562, 27782339, 27783289, 27786772, 27791223, 27793533 -27797290, 27801337, 27803665, 27807441, 27810967, 27812560, 27812593 -27813267, 27815347, 27818871, 27824540, 27824543, 27825241, 27829295 -27832643, 27833369, 27833672, 27834551, 27834984, 27835925, 27839353 -27840386, 27843646, 27846298, 27846499, 27847259, 27849825, 27851757 -27856471, 27861226, 27861452, 27861909, 27869075, 27869339, 27873643 -27876671, 27882176, 27892488, 27896443, 27896458, 27898015, 27900663 -27908644, 27912301, 27918832, 27920184, 27924147, 27926113, 27930478 -27931299, 27934468, 27935348, 27938736, 27940876, 27941110, 27941896 -27945870, 27948050, 27948153, 27950708, 27952762, 27959594, 27960021 -27961746, 27964051, 27965830, 27966472, 27970265, 27971503, 27971575 -27972265, 27975778, 27977039, 27983174, 27984028, 27986817, 27989556 -27989849, 27991970, 27993289, 27994325, 27994333, 27995215, 27995248 -27997875, 27998003, 27999073, 27999597, 27999638, 28000269, 28004853 -28006704, 28018962, 28019283, 28021205, 28022101, 28022847, 28023081 -28023399, 28023482, 28024347, 28026866, 28033429, 28036487, 28045903 -28057267, 28058612, 28059199, 28067846, 28072130, 28072464, 28072567 -28074713, 28085865, 28088762, 28090453, 28091981, 28098865, 28103600 -28103869, 28104361, 28106402, 28108003, 28108898, 28111583, 28120036 -28120951, 28124631, 28129791, 28132287, 28135648, 28165439, 28165545 -28169711, 28174827, 28174951, 28175445, 28180464, 28181021, 28184554 -28184800, 28187706, 28188330, 28189466, 28194173, 28199085, 28201419 -28204443, 28209341, 28210192, 28211734, 28214943, 28215510, 28218832 -28220398, 28223871, 28226179, 28227512, 28229360, 28236305, 28238264 -28242712, 28258608, 28264172, 28271119, 28271693, 28279837, 28281094 -28282606, 28285766, 28290434, 28302049, 28304709, 28305001, 28305362 -28309182, 28312508, 28315031, 28315995, 28319623, 28320117, 28320399 -28321446, 28323201, 28328895, 28329450, 28330714, 28333072, 28338399 -28338999, 28344964, 28350595, 28354603, 28357401, 28361083, 28361221 -28361787, 28365111, 28369092, 28371123, 28378446, 28379065, 28385102 -28390273, 28391582, 28392168, 28392251, 28393678, 28396445, 28403295 -28413955, 28420042, 28420457, 28423598, 28432129, 28434028, 28435825 -28445741, 28448314, 28455212, 28468312, 28475164, 28478676, 28481149 -28481679, 28483184, 28489150, 28492362, 28493478, 28501075, 28502403 -28502773, 28503484, 28504545, 28507324, 28508053, 28508296, 28508557 -28512761, 28513333, 28514693, 28521330, 28527416, 28528349, 28535272 -28544633, 28545134, 28545687, 28547068, 28553468, 28571483, 28572834 -28578164, 28580528, 28584193, 28584217, 28584444, 28587723, 28600233 -28612674, 28614072, 28617631, 28617959, 28621470, 28627255, 28632559 -28636676, 28644549, 28646200, 28670445, 28673203, 28679454, 28680029 -28685371, 28692275, 28695694, 28702188, 28708023, 28710827, 28713840 -28714058, 28728040, 28728272, 28730076, 28742555, 28747182, 28749289 -28752599, 28755011, 28758090, 28758722, 28761812, 28767240, 28770146 -28774416, 28777214, 28781754, 28785022, 28785531, 28803345, 28805612 -28805695, 28809909, 28819640, 28849751, 28852691, 28856060, 28856172 -28878525, 28881723, 28887509, 28891984, 28919145, 28925880, 28938924 -28940179, 28951014, 28951382, 28956908, 28960211, 28986231, 28987454 -28993353, 28993590, 29000190, 29006527, 29015118, 29015706, 29024054 -29027694, 29032276, 29033896, 29037290, 29051702, 29056270, 29123482 -29125374, 29136111, 29139591, 29158680, 29171683, 29177886, 29189889 -29200700, 29203604, 29205918, 29224605, 29230565, 29242017, 29301463 -29314539, 29331209, 29331493, 29339155, 29347981, 29356752, 29364171 -29376346, 29378913, 29379978, 29382784, 29388020, 29388952, 29394749 -29395657, 29405462, 29409149, 29412269, 29429264, 29430524, 29436454 -29437712, 29439522, 29504682, 29511611, 29531541, 29542449, 29616244 -29676089, 29813494 -``` \ No newline at end of file diff --git a/doc_source/Appendix.Oracle.RU-RUR.19.0.0.0.md b/doc_source/Appendix.Oracle.RU-RUR.19.0.0.0.md deleted file mode 100644 index 233a101..0000000 --- a/doc_source/Appendix.Oracle.RU-RUR.19.0.0.0.md +++ /dev/null @@ -1,5460 +0,0 @@ -# Database engine: 19\.0\.0\.0 - -The following versions are available for Oracle database engine 19\.0\.0\.0: -+ [Version 19\.0\.0\.0\.ru\-2021\-10\.rur\-2021\-10\.r1](#Appendix.Oracle.RU-RUR.19.0.0.0.ru-2021-10.rur-2021-10.r1) -+ [Version 19\.0\.0\.0\.ru\-2021\-07\.rur\-2021\-07\.r1](#Appendix.Oracle.RU-RUR.19.0.0.0.ru-2021-07.rur-2021-07.r1) -+ [Version 19\.0\.0\.0\.ru\-2021\-04\.rur\-2021\-04\.r1](#Appendix.Oracle.RU-RUR.19.0.0.0.ru-2021-04.rur-2021-04.r1) -+ [Version 19\.0\.0\.0\.ru\-2021\-01\.rur\-2021\-01\.r2](#Appendix.Oracle.RU-RUR.19.0.0.0.ru-2021-01.rur-2021-01.r2) -+ [Version 19\.0\.0\.0\.ru\-2021\-01\.rur\-2021\-01\.r1](#Appendix.Oracle.RU-RUR.19.0.0.0.ru-2021-01.rur-2021-01.r1) -+ [Version 19\.0\.0\.0\.ru\-2020\-10\.rur\-2020\-10\.r1](#Appendix.Oracle.RU-RUR.19.0.0.0.ru-2020-10.rur-2020-10.r1) -+ [Version 19\.0\.0\.0\.ru\-2020\-07\.rur\-2020\-07\.r1](#Appendix.Oracle.RU-RUR.19.0.0.0.ru-2020-07.rur-2020-07.r1) -+ [Version 19\.0\.0\.0\.ru\-2020\-04\.rur\-2020\-04\.r1](#Appendix.Oracle.RU-RUR.19.0.0.0.ru-2020-04.rur-2020-04.r1) -+ [Version 19\.0\.0\.0\.ru\-2020\-01\.rur\-2020\-01\.r1](#Appendix.Oracle.RU-RUR.19.0.0.0.ru-2020-01.rur-2020-01.r1) -+ [Version 19\.0\.0\.0\.ru\-2019\-10\.rur\-2019\-10\.r1](#Appendix.Oracle.RU-RUR.19.0.0.0.ru-2019-10.rur-2019-10.r1) -+ [Version 19\.0\.0\.0\.ru\-2019\-07\.rur\-2019\-07\.r1](#Appendix.Oracle.RU-RUR.19.0.0.0.ru-2019-07.rur-2019-07.r1) - -## Version 19\.0\.0\.0\.ru\-2021\-10\.rur\-2021\-10\.r1 - -Version 19\.0\.0\.0\.ru\-2021\-10\.rur\-2021\-10\.r1 includes the following: -+ Patch 33192793: DATABASE RELEASE UPDATE 19\.13\.0\.0\.0 -+ Patch 33192694 : OJVM RELEASE UPDATE 19\.13\.0\.0\.0 -+ Patch 32327201: RDBMS \- DSTV36 UPDATE \- TZDATA2020E -+ Patch 29213893: DBMS\_STATS FAILING WITH ERROR ORA\-01422 WHEN GATHERING STATS FOR USER TABLE -+ Patch 28730253: SUPPORT NEW ERA REIWA FOR JAPANESE IMPERIAL CALENDAR -+ PreUpgrade Jar: preupgrade\_19\_cbuild\_12\_lf\.zip - -### Combined Patches for Version 19\.0\.0\.0\.ru\-2021\-10\.rur\-2021\-10\.r1, Released October 2021 - -Bugs fixed: - -``` -7391838, 8460502, 8476681, 14570574, 14735102, 15931756, 15959416 -16662822, 16664572, 16750494, 17275499, 17395507, 17428816, 17468475 -17777718, 18534283, 18697534, 19080742, 19138896, 19697993, 20007421 -20083476, 20313356, 20319830, 20479545, 20867658, 20922160, 21119541 -21232786, 21245711, 21374587, 21528318, 21629064, 21639146, 21888352 -21965541, 22066547, 22252368, 22325312, 22387320, 22553815, 22580355 -22725871, 22729345, 22748979, 23020668, 23094775, 23125587, 23294761 -23296836, 23311885, 23606241, 23645975, 23734075, 23734111, 23763462 -24336782, 24356932, 24559425, 24561942, 24596874, 24669730, 24687075 -24833686, 24957575, 24971456, 25030027, 25033515, 25092651, 25093917 -25148135, 25404117, 25415139, 25416731, 25541233, 25560538, 25562258 -25607406, 25607716, 25661172, 25756945, 25792962, 25804387, 25804908 -25806201, 25809128, 25883179, 25905368, 25913778, 25979242, 25986062 -25997810, 26001677, 26003708, 26108369, 26127355, 26173091, 26203132 -26256280, 26280704, 26284288, 26352615, 26440142, 26476244, 26497655 -26499997, 26500553, 26577716, 26587659, 26611353, 26621826, 26668264 -26716835, 26739322, 26758837, 26777814, 26785852, 26789742, 26800890 -26819036, 26860844, 26872233, 26897528, 26951566, 26957541, 26963540 -26978857, 27004798, 27004828, 27019512, 27036163, 27044169, 27044246 -27063461, 27086374, 27091809, 27101798, 27126122, 27126938, 27130348 -27131416, 27166935, 27195575, 27195935, 27207214, 27221350, 27222128 -27243840, 27244999, 27254335, 27260704, 27261477, 27277677, 27302372 -27329690, 27359766, 27359770, 27362994, 27369515, 27378053, 27381279 -27392968, 27406105, 27411022, 27423500, 27439716, 27453490, 27458357 -27458493, 27460010, 27489107, 27497101, 27572040, 27582210, 27589260 -27597359, 27604329, 27622946, 27629928, 27636387, 27639208, 27654410 -27658166, 27661222, 27666312, 27684864, 27692173, 27697886, 27700413 -27710072, 27729678, 27742354, 27745728, 27751111, 27760043, 27764052 -27768096, 27782078, 27785931, 27786168, 27801144, 27828892, 27829722 -27841399, 27846298, 27873364, 27877830, 27880025, 27899093, 27907898 -27917890, 27929509, 27933036, 27934711, 27935464, 27941110, 27957203 -27957963, 27962025, 27967484, 27998559, 28001632, 28007516, 28031385 -28052648, 28064977, 28072567, 28078186, 28089605, 28092783, 28104176 -28109326, 28112563, 28125947, 28127569, 28129791, 28133903, 28138566 -28138847, 28144569, 28145995, 28156781, 28167557, 28173612, 28181021 -28185286, 28187837, 28189466, 28198802, 28201045, 28204104, 28204262 -28205555, 28209985, 28210681, 28234255, 28248841, 28263142, 28271258 -28271693, 28276054, 28279176, 28279456, 28294563, 28302580, 28313275 -28319114, 28322973, 28326928, 28338211, 28350595, 28351919, 28362187 -28364580, 28370061, 28371123, 28373960, 28375383, 28379065, 28381939 -28383667, 28386259, 28387185, 28387574, 28390273, 28392179, 28395302 -28397317, 28402823, 28403019, 28406374, 28410431, 28414968, 28431445 -28432345, 28435333, 28436414, 28442896, 28454215, 28461031, 28461789 -28463226, 28470673, 28475242, 28479352, 28482048, 28482049, 28484299 -28489419, 28492006, 28498976, 28499269, 28502773, 28503081, 28504631 -28505321, 28513333, 28521330, 28522750, 28523644, 28526715, 28530171 -28530697, 28534475, 28534493, 28535127, 28537481, 28538439, 28541606 -28542455, 28544270, 28546290, 28547068, 28547926, 28553981, 28558489 -28558645, 28561704, 28564479, 28565296, 28567417, 28567819, 28569897 -28570589, 28572165, 28572407, 28572533, 28572544, 28572667, 28572834 -28578945, 28587723, 28589194, 28589509, 28589644, 28592647, 28593127 -28593682, 28594086, 28597221, 28598022, 28601957, 28602253, 28605066 -28606598, 28607316, 28607632, 28608211, 28612239, 28618343, 28620697 -28621543, 28622202, 28625580, 28625862, 28625873, 28627033, 28628592 -28630381, 28632796, 28636532, 28639299, 28640772, 28642469, 28642551 -28642899, 28643583, 28643654, 28643718, 28644549, 28645570, 28646200 -28646939, 28649388, 28651078, 28655209, 28657026, 28659098, 28661333 -28661362, 28663289, 28663782, 28670402, 28672124, 28672457, 28673945 -28681153, 28682182, 28682796, 28689483, 28690694, 28692103, 28692275 -28692282, 28693954, 28694526, 28694639, 28694872, 28694877, 28696373 -28697526, 28698087, 28699321, 28700945, 28703812, 28704412, 28705231 -28707931, 28708400, 28708585, 28709063, 28710385, 28710469, 28710663 -28710734, 28714461, 28714720, 28715655, 28715727, 28717406, 28718302 -28718469, 28719348, 28720204, 28720418, 28721497, 28722229, 28729900 -28730079, 28730253, 28734355, 28740708, 28740799, 28741374, 28742555 -28745367, 28747846, 28749853, 28751498, 28752923, 28755011, 28755084 -28755309, 28755846, 28757960, 28758722, 28760206, 28763291, 28765983 -28767240, 28769456, 28770865, 28771022, 28771947, 28772390, 28772816 -28774416, 28776431, 28776811, 28777073, 28777214, 28777478, 28778754 -28781599, 28781754, 28785273, 28785321, 28785531, 28788272, 28789531 -28789533, 28791576, 28791852, 28793062, 28794230, 28795551, 28795563 -28795734, 28800508, 28802066, 28802734, 28804517, 28805242, 28806517 -28807247, 28808314, 28808652, 28808656, 28810381, 28811560, 28811592 -28813317, 28813931, 28815123, 28815355, 28815557, 28816871, 28817449 -28818063, 28819640, 28820669, 28821847, 28824482, 28827682, 28831971 -28833912, 28835937, 28836716, 28837979, 28838385, 28839869, 28842408 -28844656, 28844738, 28845346, 28846759, 28847541, 28847572, 28849776 -28850084, 28851458, 28851467, 28852325, 28854004, 28854212, 28854733 -28855520, 28855922, 28857552, 28861861, 28862532, 28863263, 28863432 -28863487, 28865544, 28865569, 28867698, 28867992, 28870496, 28871040 -28872645, 28872829, 28873575, 28874416, 28875089, 28876253, 28876639 -28876926, 28877252, 28878865, 28880218, 28880864, 28881191, 28881848 -28882146, 28882751, 28882784, 28884931, 28887305, 28888083, 28888327 -28889389, 28889730, 28891867, 28891941, 28892794, 28897123, 28897512 -28899663, 28900506, 28901126, 28902135, 28904380, 28905312, 28905390 -28905457, 28905615, 28907196, 28909769, 28909992, 28910498, 28910586 -28911140, 28912691, 28914144, 28915561, 28917080, 28918429, 28919145 -28921844, 28922227, 28922485, 28922532, 28922608, 28922767, 28925250 -28925460, 28925634, 28925880, 28927452, 28928462, 28930944, 28932914 -28933079, 28933158, 28935293, 28935956, 28936114, 28937717, 28938167 -28938422, 28938698, 28940179, 28940281, 28940472, 28941901, 28942455 -28942694, 28945421, 28945994, 28946233, 28946574, 28948554, 28949888 -28950868, 28951332, 28951493, 28951533, 28952168, 28954762, 28955606 -28955883, 28956145, 28956908, 28957260, 28957292, 28957723, 28958088 -28958094, 28958590, 28959493, 28960863, 28962775, 28963036, 28965084 -28965095, 28965231, 28965376, 28966444, 28968211, 28968779, 28970122 -28974083, 28974902, 28974999, 28977322, 28978664, 28979289, 28980448 -28980910, 28981871, 28983095, 28983486, 28984313, 28985114, 28985272 -28985362, 28985478, 28986207, 28986231, 28986257, 28986326, 28986481 -28986696, 28988482, 28988864, 28989306, 28990681, 28993295, 28993353 -28994307, 28994542, 28994783, 28995287, 28996376, 28998369, 28999046 -29000000, 29001305, 29001888, 29002273, 29002488, 29002784, 29002927 -29003207, 29003407, 29003617, 29003738, 29005748, 29006318, 29006621 -29007321, 29007353, 29007775, 29008035, 29008669, 29009513, 29010126 -29010517, 29011936, 29012609, 29013475, 29013832, 29014076, 29014385 -29015118, 29016294, 29017265, 29018655, 29018680, 29019121, 29020423 -29021063, 29021352, 29022986, 29024028, 29024054, 29024448, 29024552 -29024732, 29024795, 29024876, 29026154, 29026582, 29026606, 29027456 -29027694, 29027933, 29027940, 29030184, 29030927, 29031575, 29031600 -29032234, 29032276, 29032457, 29032607, 29033052, 29033145, 29033164 -29033200, 29033280, 29033655, 29034331, 29034587, 29036278, 29037290 -29038528, 29038728, 29038730, 29039089, 29039510, 29040739, 29041739 -29041775, 29043554, 29043651, 29043725, 29044086, 29044763, 29044954 -29046482, 29047127, 29047850, 29048178, 29048289, 29048498, 29048605 -29048728, 29048792, 29048858, 29049014, 29049673, 29050357, 29050560 -29050765, 29050886, 29051263, 29051702, 29051953, 29052726, 29052850 -29053783, 29053902, 29055644, 29056024, 29056270, 29056560, 29056767 -29056894, 29058476, 29059011, 29060216, 29061016, 29061959, 29062692 -29062848, 29062860, 29062868, 29110526, 29110783, 29110790, 29110797 -29110802, 29110805, 29111598, 29111631, 29112455, 29113282, 29113305 -29115794, 29115857, 29116779, 29117337, 29117526, 29117642, 29118543 -29119077, 29119733, 29120223, 29122224, 29122254, 29122367, 29123297 -29123324, 29123432, 29123444, 29123482, 29124104, 29124368, 29125036 -29125374, 29125380, 29125708, 29125786, 29126345, 29127957, 29128693 -29128935, 29129450, 29129476, 29129497, 29129691, 29129712, 29130219 -29131539, 29131772, 29132456, 29132869, 29132938, 29133470, 29134447 -29135383, 29135649, 29136111, 29138641, 29139070, 29139727, 29139761 -29139780, 29139956, 29141316, 29141341, 29141685, 29141886, 29142609 -29142667, 29143516, 29144995, 29145214, 29145730, 29146077, 29146157 -29146810, 29147849, 29148799, 29149170, 29149829, 29150338, 29151520 -29152357, 29152603, 29152752, 29154631, 29154636, 29154725, 29154829 -29155099, 29155208, 29157051, 29157389, 29158680, 29158899, 29158990 -29159216, 29159661, 29159909, 29159936, 29160174, 29160462, 29160824 -29161597, 29161923, 29162095, 29162749, 29163073, 29163156, 29163415 -29163437, 29163524, 29163567, 29164376, 29164446, 29165682, 29167111 -29167342, 29167374, 29167940, 29168137, 29168219, 29168433, 29169073 -29169215, 29169540, 29169739, 29170232, 29170717, 29171683, 29171942 -29172618, 29172826, 29173140, 29173373, 29173618, 29173817, 29174004 -29174753, 29175638, 29175829, 29176318, 29177466, 29177543, 29177886 -29178385, 29179097, 29180313, 29180455, 29180559, 29180721, 29180893 -29181078, 29181153, 29181231, 29181568, 29181620, 29181743, 29181923 -29182019, 29182517, 29182901, 29182920, 29183298, 29183912, 29184297 -29184666, 29185193, 29186091, 29186456, 29186605, 29188255, 29189302 -29189307, 29189889, 29190235, 29190474, 29190663, 29190740, 29191541 -29191827, 29192419, 29192468, 29192685, 29193207, 29194205, 29194367 -29194493, 29194827, 29194981, 29195279, 29195337, 29195758, 29196151 -29196725, 29198092, 29198913, 29199163, 29199635, 29199733, 29200316 -29200700, 29201143, 29201494, 29201539, 29201695, 29201787, 29202104 -29202461, 29202850, 29203041, 29203122, 29203166, 29203227, 29203425 -29203443, 29203604, 29205281, 29205323, 29205419, 29205463, 29205767 -29205918, 29206109, 29206605, 29206631, 29207073, 29208260, 29208732 -29209545, 29210577, 29210610, 29210624, 29210683, 29211457, 29211724 -29212012, 29212433, 29212611, 29213320, 29213351, 29213613, 29213641 -29213775, 29213850, 29213879, 29213893, 29214561, 29214960, 29216312 -29216723, 29216746, 29216984, 29217294, 29217472, 29217828, 29217848 -29217856, 29218570, 29219205, 29219273, 29219627, 29220079, 29221248 -29221745, 29221891, 29221942, 29222031, 29222784, 29222892, 29223833 -29223859, 29223967, 29224065, 29224294, 29224605, 29224710, 29225076 -29225168, 29225758, 29225861, 29227602, 29228869, 29229164, 29229754 -29229839, 29229844, 29229955, 29230252, 29230565, 29231133, 29232117 -29232154, 29232449, 29232533, 29232653, 29233415, 29233810, 29233953 -29234123, 29235934, 29236573, 29237538, 29237575, 29237744, 29240307 -29240668, 29240759, 29241345, 29241651, 29242017, 29242561, 29242884 -29242906, 29243749, 29243958, 29244495, 29244766, 29244968, 29245063 -29245137, 29245160, 29246163, 29246337, 29247183, 29247415, 29247712 -29247906, 29248495, 29248552, 29248723, 29248835, 29248858, 29249289 -29249412, 29249583, 29249991, 29250059, 29250317, 29251259, 29251564 -29252510, 29252790, 29253184, 29253871, 29254031, 29254177, 29254623 -29254930, 29255178, 29255273, 29255431, 29255435, 29255616, 29255705 -29255718, 29255973, 29256279, 29256426, 29259119, 29259320, 29260224 -29260407, 29260452, 29260956, 29261547, 29261548, 29261695, 29261906 -29262143, 29262512, 29262887, 29265446, 29265448, 29265780, 29266248 -29266899, 29267292, 29268412, 29269171, 29269228, 29269825, 29270585 -29271019, 29273168, 29273360, 29273539, 29273570, 29273735, 29273812 -29273847, 29274428, 29274564, 29274623, 29274627, 29275461, 29276272 -29277317, 29278218, 29278684, 29279658, 29279751, 29279854, 29281112 -29281527, 29281691, 29281796, 29282090, 29282233, 29282666, 29282898 -29285197, 29285453, 29285503, 29285621, 29285788, 29285956, 29286037 -29286220, 29286229, 29287130, 29287705, 29290110, 29290235, 29292232 -29292253, 29292378, 29292837, 29293072, 29293574, 29293806, 29294753 -29296257, 29297863, 29297915, 29298220, 29299049, 29299082, 29299830 -29299844, 29301139, 29301463, 29301566, 29302565, 29302614, 29302963 -29303712, 29303918, 29304314, 29304692, 29304781, 29304853, 29305093 -29306226, 29306713, 29306790, 29307090, 29307109, 29307638, 29309698 -29311336, 29311528, 29311588, 29311927, 29312310, 29312672, 29312734 -29312753, 29312889, 29313347, 29313417, 29313525, 29314539, 29314636 -29314867, 29314949, 29317756, 29318410, 29319441, 29319558, 29320900 -29321489, 29321689, 29323946, 29323999, 29324568, 29324735, 29325087 -29325105, 29325257, 29325356, 29325497, 29325765, 29325993, 29326233 -29327044, 29327892, 29328305, 29329042, 29329087, 29329675, 29329807 -29329848, 29330361, 29330791, 29331066, 29331209, 29331380, 29331493 -29332292, 29332395, 29332763, 29332771, 29332966, 29333500, 29336843 -29336899, 29337294, 29337310, 29337742, 29338315, 29338348, 29338453 -29338780, 29338913, 29339101, 29339155, 29339299, 29339452, 29340333 -29341209, 29341782, 29342099, 29343086, 29343156, 29343861, 29344541 -29345382, 29345937, 29346057, 29346138, 29346211, 29346943, 29347620 -29348176, 29348358, 29350052, 29350712, 29350762, 29350868, 29351044 -29351386, 29351662, 29351716, 29351735, 29351749, 29351771, 29351786 -29352298, 29352724, 29352867, 29352947, 29353271, 29353432, 29353718 -29353821, 29353960, 29355654, 29356547, 29356634, 29356704, 29356711 -29356752, 29356782, 29357821, 29358509, 29358828, 29360252, 29360285 -29360467, 29360672, 29360775, 29360911, 29360950, 29361319, 29361472 -29361801, 29362596, 29363090, 29363151, 29364171, 29364177, 29366406 -29366818, 29366940, 29367019, 29367561, 29367971, 29368253, 29368310 -29368725, 29372069, 29372541, 29372562, 29373418, 29373588, 29374179 -29374604, 29374627, 29375355, 29375941, 29375984, 29376346, 29377804 -29377986, 29378029, 29378287, 29378834, 29378913, 29379299, 29379381 -29379552, 29379750, 29379978, 29380527, 29381000, 29382296, 29382641 -29382784, 29382815, 29383695, 29384740, 29384781, 29384854, 29384864 -29384960, 29385339, 29385429, 29385652, 29385774, 29386502, 29386557 -29386635, 29386660, 29386835, 29387073, 29387274, 29387310, 29387329 -29387337, 29388020, 29388072, 29388094, 29388524, 29388830, 29389408 -29389889, 29390011, 29390435, 29390785, 29391030, 29391237, 29391301 -29391438, 29391849, 29391925, 29392554, 29392966, 29393291, 29393649 -29394014, 29394140, 29394749, 29395657, 29396481, 29397841, 29397954 -29397996, 29398488, 29398863, 29399046, 29399100, 29399121, 29399336 -29399938, 29399959, 29402110, 29402131, 29404425, 29404483, 29405012 -29405462, 29405651, 29405996, 29407488, 29407804, 29408853, 29409149 -29409455, 29410311, 29410834, 29411037, 29411427, 29411469, 29411931 -29412066, 29412269, 29413360, 29413382, 29413517, 29413544, 29413634 -29413956, 29415493, 29415774, 29416339, 29416688, 29416700, 29417084 -29417113, 29417173, 29417719, 29417884, 29418165, 29418341, 29420254 -29420834, 29421059, 29423003, 29423016, 29423156, 29423227, 29423491 -29423826, 29424094, 29424999, 29426241, 29426320, 29428230, 29429017 -29429087, 29429264, 29429336, 29429466, 29429566, 29429895, 29430524 -29430866, 29431192, 29431402, 29431485, 29431985, 29432176, 29434301 -29434869, 29435474, 29435652, 29435966, 29436454, 29436514, 29436522 -29436727, 29437029, 29437379, 29437594, 29437712, 29438150, 29438277 -29438736, 29439522, 29440651, 29441196, 29442400, 29442936, 29443187 -29443250, 29443559, 29444072, 29444275, 29444282, 29444602, 29444906 -29445548, 29446319, 29446669, 29447460, 29448498, 29449477, 29449845 -29449852, 29450162, 29450193, 29450273, 29450421, 29450812, 29450936 -29451085, 29451386, 29452251, 29452576, 29452936, 29452953, 29454450 -29454978, 29455424, 29455773, 29456538, 29456714, 29457312, 29457319 -29457370, 29457502, 29457807, 29457978, 29458132, 29460252, 29461420 -29461791, 29461971, 29462594, 29462767, 29462957, 29463047, 29463528 -29463553, 29463798, 29464616, 29464779, 29465047, 29465177, 29466674 -29467622, 29469563, 29469565, 29470059, 29470205, 29470291, 29471633 -29471832, 29471857, 29471860, 29472618, 29473708, 29474348, 29475386 -29476473, 29476702, 29477015, 29481584, 29482021, 29483452, 29483532 -29483626, 29483672, 29483685, 29483712, 29483723, 29483771, 29485099 -29485731, 29485877, 29486181, 29486848, 29487150, 29487189, 29487407 -29488894, 29489436, 29489546, 29490256, 29491784, 29492127, 29492939 -29493122, 29493821, 29494245, 29494788, 29494934, 29495057, 29495171 -29495684, 29497053, 29497311, 29497588, 29497696, 29497778, 29498198 -29500257, 29500826, 29500963, 29501218, 29502561, 29503543, 29503631 -29503827, 29504103, 29504492, 29504682, 29505225, 29505589, 29505668 -29506942, 29507270, 29507616, 29508681, 29508998, 29509777, 29510278 -29511064, 29511611, 29511980, 29512125, 29512773, 29512890, 29514479 -29515134, 29515240, 29515476, 29515766, 29515834, 29516300, 29516727 -29516766, 29517168, 29517443, 29517883, 29518604, 29518767, 29519131 -29521187, 29521688, 29521748, 29521862, 29522358, 29522561, 29522662 -29523055, 29523216, 29523511, 29524599, 29524985, 29525366, 29525467 -29525886, 29526966, 29527595, 29527610, 29528184, 29528368, 29529147 -29529436, 29530440, 29530515, 29530812, 29530909, 29531654, 29531836 -29532112, 29532532, 29536342, 29536445, 29536794, 29537829, 29538631 -29539027, 29539413, 29540327, 29540831, 29540862, 29541517, 29541742 -29541769, 29541973, 29542084, 29542449, 29542474, 29542580, 29542643 -29543034, 29543956, 29544552, 29546817, 29547010, 29547867, 29548413 -29548427, 29548592, 29548687, 29548722, 29549040, 29549071, 29549104 -29549154, 29549730, 29550530, 29552402, 29552773, 29553141, 29554092 -29554351, 29554554, 29555105, 29555239, 29557144, 29557261, 29557336 -29557556, 29558238, 29558452, 29558926, 29558975, 29559187, 29559395 -29559446, 29559908, 29559981, 29564592, 29564593, 29565611, 29579919 -29580394, 29580983, 29581460, 29581771, 29583018, 29584261, 29584693 -29586143, 29587299, 29587488, 29587720, 29587765, 29588580, 29588732 -29589544, 29590666, 29591343, 29591641, 29592011, 29592215, 29592433 -29592595, 29597158, 29597536, 29597716, 29597754, 29598039, 29598040 -29598046, 29598226, 29598233, 29598338, 29599008, 29599243, 29599300 -29599552, 29601461, 29602831, 29603460, 29603884, 29604002, 29604257 -29606261, 29607136, 29607797, 29608000, 29608023, 29609603, 29610506 -29611020, 29611991, 29613733, 29614206, 29614931, 29614987, 29615824 -29616244, 29616414, 29618074, 29618190, 29620042, 29622936, 29623323 -29623592, 29624124, 29625065, 29625804, 29625876, 29626154, 29626732 -29628200, 29628647, 29629430, 29629650, 29629681, 29629745, 29630221 -29631749, 29632095, 29632265, 29632611, 29632751, 29633697, 29633753 -29633936, 29634643, 29635427, 29635717, 29635990, 29637362, 29637526 -29637560, 29638285, 29638928, 29641736, 29642451, 29643721, 29644426 -29644464, 29645167, 29645349, 29647176, 29647770, 29648928, 29649694 -29651183, 29651520, 29652809, 29653132, 29653246, 29655164, 29655416 -29655668, 29656400, 29656819, 29656843, 29657399, 29657422, 29657744 -29657960, 29657973, 29658056, 29661028, 29661065, 29661722, 29663191 -29663368, 29663494, 29663601, 29663813, 29664087, 29664161, 29665168 -29665940, 29666451, 29667527, 29667994, 29668005, 29669241, 29669413 -29670713, 29670782, 29671363, 29672507, 29675446, 29676089, 29676921 -29677051, 29677173, 29677733, 29677927, 29678217, 29679856, 29680700 -29681987, 29683039, 29683189, 29683211, 29684518, 29685137, 29685276 -29687214, 29687220, 29687459, 29687718, 29687727, 29687763, 29688867 -29689145, 29689255, 29690795, 29692115, 29692694, 29693847, 29694869 -29695425, 29695821, 29695841, 29695964, 29695987, 29696242, 29696310 -29697928, 29700125, 29700460, 29700770, 29701720, 29701755, 29701937 -29703932, 29704426, 29705793, 29706141, 29706160, 29707099, 29707493 -29707896, 29708324, 29708353, 29708876, 29708915, 29710188, 29710858 -29713810, 29715220, 29715647, 29715703, 29716029, 29716194, 29716227 -29716491, 29716602, 29716871, 29717659, 29717901, 29718198, 29719146 -29720133, 29720373, 29721418, 29721576, 29722026, 29722092, 29722167 -29722389, 29723113, 29724497, 29724658, 29725421, 29725425, 29725476 -29725781, 29726695, 29737941, 29738374, 29738400, 29739576, 29741319 -29741976, 29742223, 29742926, 29744225, 29744400, 29744637, 29745288 -29745624, 29746962, 29747493, 29747648, 29747653, 29748285, 29748325 -29748336, 29748513, 29749471, 29750673, 29751094, 29753244, 29754196 -29754640, 29754951, 29755821, 29756274, 29756444, 29757099, 29757264 -29757651, 29757687, 29758203, 29758217, 29758661, 29761678, 29761837 -29761911, 29763158, 29764644, 29765035, 29765219, 29765347, 29765393 -29765493, 29766207, 29766435, 29766503, 29766679, 29768487, 29768899 -29769549, 29769695, 29769901, 29770750, 29771032, 29771242, 29772514 -29772761, 29773185, 29773197, 29773205, 29773459, 29773633, 29773842 -29774362, 29775393, 29775473, 29779196, 29779901, 29780140, 29780633 -29782211, 29782284, 29782501, 29782823, 29782866, 29783142, 29784106 -29785169, 29785239, 29785251, 29785311, 29785544, 29785550, 29785831 -29787292, 29787766, 29789911, 29791152, 29791880, 29791916, 29792213 -29792433, 29793141, 29793151, 29793318, 29794174, 29794462, 29795712 -29795957, 29796335, 29796378, 29796916, 29797209, 29797726, 29801164 -29802382, 29802695, 29803948, 29804875, 29805368, 29805772, 29806390 -29806964, 29807964, 29809792, 29809837, 29810012, 29810013, 29811616 -29812084, 29812166, 29812489, 29813503, 29813650, 29813671, 29814455 -29814995, 29815341, 29815713, 29816887, 29817278, 29817547, 29817784 -29818794, 29819753, 29820341, 29821130, 29821582, 29822714, 29825525 -29827647, 29827792, 29827852, 29828644, 29829339, 29831196, 29831404 -29831567, 29833406, 29833984, 29834506, 29836096, 29836424, 29838337 -29838485, 29838740, 29838773, 29839481, 29839715, 29840619, 29841267 -29841687, 29842369, 29843238, 29843277, 29843692, 29843831, 29844131 -29844226, 29844275, 29845449, 29845530, 29845691, 29846126, 29846525 -29846645, 29846688, 29847627, 29848084, 29848849, 29849100, 29849139 -29850552, 29850566, 29850930, 29851020, 29851308, 29851733, 29853485 -29856420, 29856506, 29856859, 29856890, 29858121, 29858376, 29858420 -29859068, 29860022, 29860994, 29861075, 29864203, 29864261, 29865188 -29865590, 29865658, 29867728, 29868639, 29869052, 29869086, 29869149 -29869404, 29869857, 29869877, 29869887, 29869906, 29870065, 29870533 -29871098, 29871312, 29871360, 29872401, 29872937, 29872983, 29873206 -29873665, 29873751, 29874090, 29874761, 29875200, 29875459, 29875565 -29875919, 29876358, 29876989, 29877608, 29878076, 29881050, 29881478 -29881575, 29881643, 29881839, 29882427, 29882454, 29882729, 29884958 -29885182, 29885890, 29886809, 29887045, 29887111, 29888621, 29889184 -29889358, 29890740, 29891075, 29891853, 29891857, 29891916, 29892388 -29892604, 29893132, 29893197, 29893287, 29894021, 29896510, 29897418 -29897720, 29897863, 29900203, 29900824, 29901021, 29901419, 29901961 -29902299, 29902327, 29902330, 29902659, 29903190, 29903299, 29903357 -29903454, 29904002, 29906678, 29907942, 29908389, 29908639, 29908777 -29909658, 29910218, 29910402, 29912135, 29912286, 29913805, 29913934 -29913966, 29914449, 29914544, 29915182, 29915217, 29915848, 29916198 -29916975, 29919782, 29919789, 29920025, 29920376, 29920804, 29921214 -29921318, 29921559, 29922225, 29922435, 29922461, 29923452, 29924147 -29924181, 29924479, 29925177, 29926466, 29927756, 29928040, 29928210 -29928340, 29928427, 29928564, 29930457, 29931956, 29932202, 29932310 -29932430, 29932780, 29932953, 29933718, 29934048, 29934052, 29934158 -29934557, 29935685, 29937565, 29937655, 29937956, 29938063, 29938225 -29939075, 29939400, 29939795, 29940373, 29941062, 29942096, 29942275 -29942554, 29943670, 29943879, 29944035, 29944159, 29944660, 29944963 -29945645, 29946101, 29946388, 29947145, 29947242, 29947428, 29948165 -29950018, 29950220, 29951620, 29951759, 29952700, 29955625, 29956016 -29956222, 29957412, 29957493, 29958925, 29960325, 29960884, 29961353 -29961360, 29961609, 29961847, 29962160, 29962248, 29962834, 29962927 -29962939, 29965052, 29965207, 29965603, 29965888, 29966768, 29967223 -29967386, 29968085, 29968703, 29969557, 29969985, 29970081, 29970261 -29970298, 29970587, 29970861, 29971027, 29971481, 29971888, 29971936 -29971951, 29972134, 29972176, 29973012, 29989783, 29989845, 29990779 -29991257, 29993717, 29997326, 29997553, 29997937, 29997959, 30000518 -30000664, 30001105, 30001331, 30003187, 30004660, 30004856, 30006159 -30006280, 30006411, 30006472, 30006705, 30006985, 30007450, 30007536 -30007797, 30008035, 30008125, 30008198, 30008214, 30008456, 30009528 -30009710, 30012181, 30012737, 30013243, 30013535, 30014200, 30015070 -30017836, 30018017, 30018903, 30019864, 30021830, 30024618, 30025814 -30026016, 30026596, 30027614, 30027649, 30028182, 30028599, 30028649 -30029519, 30029806, 30031027, 30031613, 30032233, 30032376, 30032484 -30033040, 30033547, 30034456, 30035444, 30035598, 30036258, 30038392 -30038576, 30039796, 30039800, 30039959, 30040157, 30040511, 30041501 -30041514, 30042490, 30043398, 30043610, 30043930, 30044108, 30044507 -30045242, 30045273, 30045389, 30045484, 30045983, 30046497, 30047510 -30047531, 30047702, 30047765, 30047931, 30048688, 30049966, 30051176 -30051783, 30051804, 30052740, 30052928, 30053036, 30053501, 30053748 -30054980, 30056058, 30057718, 30057799, 30058149, 30058453, 30059106 -30059109, 30059821, 30060267, 30060330, 30062364, 30062429, 30062736 -30062819, 30064268, 30066352, 30067565, 30068384, 30068792, 30068871 -30070064, 30071446, 30072018, 30072038, 30072905, 30073314, 30073422 -30073744, 30074250, 30074296, 30074349, 30074469, 30074472, 30074820 -30075037, 30076058, 30076197, 30076253, 30076604, 30078675, 30078934 -30079949, 30080111, 30080266, 30080297, 30081055, 30081546, 30081580 -30082145, 30082402, 30083100, 30083216, 30083488, 30083807, 30084458 -30084971, 30085897, 30086596, 30086992, 30087165, 30087509, 30088229 -30088421, 30090568, 30092254, 30092280, 30092859, 30094929, 30094948 -30095499, 30095591, 30095952, 30096138, 30097092, 30097115, 30098251 -30099302, 30099420, 30099454, 30099852, 30100354, 30101090, 30101186 -30101541, 30101847, 30102774, 30103551, 30103553, 30104348, 30104378 -30104555, 30105458, 30106748, 30106901, 30108012, 30109365, 30110224 -30110370, 30110518, 30114477, 30114489, 30114534, 30116085, 30116203 -30116753, 30116854, 30117209, 30117335, 30117469, 30117593, 30118261 -30118279, 30120608, 30122523, 30122583, 30123138, 30125765, 30126145 -30126470, 30127145, 30127522, 30127805, 30127904, 30128047, 30128231 -30130240, 30131286, 30131645, 30132708, 30132989, 30133841, 30134103 -30134746, 30135396, 30135731, 30135942, 30136102, 30136346, 30137792 -30138948, 30139392, 30140425, 30141240, 30142527, 30142812, 30142815 -30142907, 30143470, 30143593, 30145712, 30146593, 30146969, 30147195 -30147307, 30147308, 30147473, 30147928, 30148343, 30148929, 30148999 -30149035, 30149658, 30150606, 30150710, 30153552, 30153885, 30154633 -30155241, 30155320, 30155388, 30155489, 30155814, 30155837, 30155999 -30156569, 30157526, 30158313, 30159329, 30159511, 30159536, 30159690 -30159752, 30159760, 30160025, 30160625, 30161094, 30163243, 30164238 -30164714, 30165493, 30165503, 30165876, 30165892, 30165897, 30166257 -30166352, 30167787, 30169254, 30170104, 30172925, 30173113, 30173370 -30173556, 30174102, 30174394, 30174401, 30175180, 30175291, 30175478 -30175587, 30177597, 30178250, 30178839, 30178990, 30179012, 30179038 -30179644, 30180208, 30180643, 30181756, 30182498, 30183367, 30183696 -30183715, 30183920, 30184102, 30185852, 30186319, 30186476, 30186706 -30187627, 30187866, 30188631, 30189516, 30189535, 30190090, 30191274 -30192691, 30192729, 30192853, 30193165, 30193262, 30193505, 30193506 -30193584, 30193736, 30194612, 30194710, 30194972, 30195667, 30195668 -30195684, 30196195, 30196358, 30196629, 30198239, 30198598, 30198861 -30198905, 30199890, 30200034, 30200132, 30200237, 30200680, 30200758 -30202349, 30202388, 30203929, 30204042, 30204542, 30206220, 30206493 -30206675, 30207473, 30207519, 30208327, 30208690, 30208723, 30209222 -30209736, 30210429, 30210753, 30210884, 30211567, 30213031, 30213540 -30214769, 30214826, 30215130, 30215302, 30215351, 30217206, 30217562 -30217982, 30218044, 30218317, 30219222, 30220932, 30221115, 30221237 -30221298, 30222512, 30222669, 30222975, 30223712, 30223847, 30224544 -30224650, 30224725, 30224868, 30224950, 30225265, 30225439, 30225443 -30225718, 30225837, 30225844, 30226244, 30227400, 30228422, 30228567 -30229030, 30229126, 30229683, 30232638, 30233105, 30233934, 30234132 -30234227, 30235878, 30235919, 30235979, 30236092, 30236399, 30236554 -30236746, 30236964, 30237477, 30237640, 30238211, 30238715, 30239480 -30240010, 30240547, 30240858, 30240930, 30240972, 30241567, 30241807 -30241829, 30241920, 30242120, 30242724, 30243216, 30244340, 30244831 -30246053, 30246179, 30247305, 30248520, 30248531, 30248564, 30249432 -30249738, 30249927, 30251003, 30252005, 30252098, 30252156, 30252458 -30252977, 30253035, 30253090, 30253608, 30253705, 30253835, 30254206 -30254525, 30254576, 30254726, 30255143, 30255528, 30256542, 30257412 -30257908, 30259120, 30259469, 30260523, 30260595, 30263013, 30263377 -30264405, 30265523, 30265608, 30265615, 30265703, 30266791, 30267155 -30269428, 30269748, 30270647, 30270744, 30271114, 30272329, 30274090 -30274188, 30274324, 30274662, 30275548, 30275569, 30275578, 30275784 -30276144, 30276243, 30277120, 30277451, 30277589, 30277648, 30277733 -30277887, 30278402, 30281428, 30281615, 30282501, 30282591, 30282918 -30283296, 30283577, 30283579, 30283581, 30283832, 30283932, 30284219 -30284369, 30284751, 30285026, 30285166, 30285251, 30285341, 30285457 -30285540, 30285843, 30286961, 30288343, 30288491, 30289074, 30289458 -30290700, 30291536, 30292305, 30293345, 30294267, 30294465, 30294671 -30294865, 30295110, 30295137, 30295549, 30295790, 30295808, 30297905 -30299367, 30299817, 30299934, 30300030, 30300342, 30300363, 30300523 -30300538, 30304037, 30305163, 30305264, 30305395, 30305568, 30305603 -30305880, 30306407, 30307814, 30307883, 30308368, 30308578, 30308624 -30308772, 30308947, 30309098, 30309798, 30310195, 30311826, 30312094 -30312546, 30313749, 30313848, 30313989, 30314079, 30314198, 30314837 -30316667, 30316897, 30317005, 30317209, 30317397, 30318638, 30318943 -30319080, 30319099, 30320029, 30321076, 30321398, 30322980, 30323219 -30323658, 30323849, 30324180, 30324466, 30324649, 30325407, 30325786 -30326115, 30326882, 30327149, 30327678, 30327810, 30328168, 30328209 -30328690, 30329209, 30329751, 30330123, 30331356, 30331759, 30332505 -30332893, 30334484, 30334563, 30335127, 30335832, 30335987, 30336032 -30336383, 30336530, 30336742, 30336996, 30337245, 30338434, 30338591 -30339049, 30339103, 30340540, 30341713, 30342371, 30342878, 30343370 -30344614, 30345201, 30345432, 30345809, 30345926, 30345950, 30346330 -30346847, 30346867, 30347410, 30349714, 30350177, 30350543, 30352532 -30352581, 30352623, 30352715, 30355490, 30356060, 30356461, 30357463 -30357698, 30357897, 30358416, 30359614, 30360383, 30360653, 30361070 -30361635, 30362003, 30362850, 30363088, 30363193, 30363311, 30363716 -30364329, 30364481, 30364613, 30364835, 30365745, 30367193, 30368048 -30368482, 30368534, 30368668, 30368917, 30371264, 30371623, 30371909 -30372081, 30373419, 30373541, 30373550, 30374345, 30374570, 30374739 -30375109, 30376986, 30377347, 30377692, 30377729, 30380511, 30380907 -30381207, 30381525, 30381614, 30382646, 30382982, 30383286, 30384121 -30384152, 30387628, 30387666, 30388853, 30389229, 30389414, 30389507 -30389821, 30390279, 30390382, 30390635, 30391272, 30392011, 30392870 -30392987, 30393110, 30393653, 30393944, 30394509, 30394738, 30394974 -30395132, 30396120, 30396946, 30396974, 30397100, 30398099, 30398251 -30398257, 30398422, 30398770, 30399906, 30402386, 30403284, 30403412 -30403763, 30403881, 30403902, 30403989, 30404117, 30404153, 30404357 -30404639, 30406227, 30406709, 30408515, 30408808, 30409207, 30409339 -30409472, 30409590, 30412188, 30412772, 30412863, 30412885, 30412921 -30413137, 30413294, 30414491, 30414679, 30414714, 30416034, 30416603 -30417648, 30417732, 30418926, 30419024, 30419196, 30419450, 30420105 -30420452, 30421009, 30421026, 30421204, 30421439, 30421476, 30421706 -30422487, 30423135, 30423218, 30424347, 30430921, 30431274, 30431504 -30431582, 30431698, 30431703, 30431717, 30431867, 30432470, 30433177 -30434793, 30436326, 30436399, 30437003, 30437149, 30438224, 30439985 -30440651, 30440712, 30441277, 30441687, 30441959, 30442266, 30442749 -30442805, 30442874, 30442884, 30443393, 30446436, 30446583, 30446820 -30447060, 30447498, 30447589, 30447994, 30448182, 30448348, 30448355 -30448917, 30449194, 30449837, 30450787, 30453442, 30454090, 30455427 -30457633, 30457697, 30458080, 30458568, 30458593, 30460095, 30460558 -30460842, 30460922, 30461123, 30461458, 30462439, 30463938, 30464250 -30464655, 30466081, 30466214, 30469777, 30470402, 30470947, 30472891 -30473634, 30474167, 30474386, 30474774, 30475041, 30475115, 30475813 -30476768, 30477588, 30477685, 30477691, 30477767, 30479252, 30479647 -30479715, 30480591, 30480872, 30483065, 30483140, 30483217, 30483521 -30484042, 30484623, 30484801, 30485255, 30486436, 30486896, 30487387 -30487697, 30489582, 30490014, 30490578, 30490671, 30492380, 30493331 -30493518, 30494259, 30494900, 30495035, 30495078, 30495133, 30495483 -30496957, 30497057, 30497120, 30497765, 30498824, 30500224, 30500297 -30500344, 30500582, 30501574, 30502415, 30503943, 30505029, 30505497 -30506794, 30506991, 30507032, 30507313, 30508100, 30509112, 30509277 -30510347, 30510527, 30510718, 30512690, 30513285, 30513353, 30513480 -30513848, 30515886, 30516868, 30517214, 30517516, 30517635, 30518349 -30518447, 30518923, 30519188, 30520662, 30522285, 30522998, 30523137 -30523538, 30523601, 30523750, 30524736, 30527198, 30527275, 30528547 -30528637, 30528687, 30528704, 30528731, 30528935, 30529790, 30529915 -30529940, 30530585, 30532811, 30533132, 30533580, 30534351, 30534549 -30534662, 30534827, 30535905, 30536237, 30537403, 30537405, 30537533 -30537584, 30538141, 30538818, 30539519, 30539866, 30540109, 30540407 -30544247, 30544595, 30544629, 30544752, 30545040, 30545281, 30545556 -30549255, 30549368, 30549637, 30549789, 30549881, 30551000, 30551123 -30554178, 30556326, 30556523, 30556581, 30556807, 30557386, 30557803 -30558561, 30559129, 30559218, 30559252, 30560365, 30560513, 30561404 -30561590, 30561737, 30564139, 30564343, 30564898, 30565004, 30565595 -30565805, 30566054, 30567372, 30568514, 30568896, 30570083, 30571306 -30572816, 30573236, 30573703, 30575243, 30575697, 30576112, 30576393 -30576853, 30577071, 30577591, 30578221, 30579051, 30580813, 30580887 -30581448, 30582221, 30582500, 30584767, 30585407, 30586493, 30587001 -30588738, 30589914, 30591028, 30591475, 30592859, 30593046, 30593104 -30593863, 30594167, 30595114, 30595408, 30595860, 30596024, 30596320 -30596488, 30596694, 30598682, 30598746, 30598919, 30599405, 30599407 -30600173, 30600184, 30602230, 30602828, 30603211, 30605215, 30605676 -30606345, 30606451, 30608583, 30609799, 30610097, 30610406, 30610667 -30611527, 30611603, 30612199, 30613937, 30613971, 30614411, 30616406 -30616738, 30617002, 30617626, 30618230, 30619138, 30619414, 30619525 -30619728, 30619787, 30620805, 30621255, 30621910, 30622528, 30622755 -30623138, 30623142, 30624243, 30624792, 30624864, 30624874, 30625121 -30628834, 30628899, 30629139, 30629643, 30629799, 30630391, 30630829 -30630930, 30631393, 30631523, 30633259, 30633395, 30633938, 30634548 -30634559, 30635183, 30635302, 30635326, 30635360, 30637270, 30637319 -30637841, 30638712, 30640436, 30641541, 30641755, 30641900, 30642124 -30644530, 30644766, 30644889, 30645590, 30645896, 30645938, 30646077 -30647133, 30649310, 30650297, 30650404, 30651231, 30651570, 30651621 -30651674, 30652515, 30652595, 30652813, 30652853, 30654131, 30654558 -30655906, 30656839, 30657196, 30657365, 30657566, 30657624, 30657706 -30657875, 30657906, 30657940, 30658421, 30658533, 30658555, 30658702 -30659940, 30660412, 30661000, 30661939, 30662651, 30662736, 30663591 -30663646, 30664266, 30665036, 30665399, 30665720, 30666902, 30668407 -30668754, 30670328, 30670369, 30670584, 30671606, 30671720, 30671813 -30671958, 30674373, 30674959, 30676209, 30677633, 30679595, 30679771 -30679804, 30681085, 30681462, 30681516, 30681521, 30682289, 30684902 -30685163, 30686017, 30686131, 30686809, 30687047, 30689557, 30689988 -30690686, 30691604, 30691731, 30691857, 30692462, 30692473, 30693791 -30694947, 30695670, 30696566, 30696821, 30698289, 30699770, 30702732 -30703610, 30704826, 30705448, 30708735, 30710506, 30710807, 30711370 -30712670, 30713133, 30714151, 30714715, 30716001, 30716863, 30718841 -30718862, 30719327, 30719419, 30720736, 30720844, 30722105, 30722705 -30723671, 30724679, 30724881, 30726204, 30727701, 30727759, 30728196 -30729278, 30729604, 30729839, 30730026, 30732711, 30733270, 30733563 -30734242, 30734362, 30734707, 30735091, 30735153, 30735736, 30737970 -30739013, 30739876, 30740115, 30740250, 30740669, 30740997, 30741263 -30748411, 30748707, 30749181, 30749644, 30749722, 30750219, 30750991 -30751171, 30751521, 30751527, 30751639, 30751968, 30753432, 30755348 -30758836, 30758854, 30758943, 30759573, 30760739, 30761871, 30761878 -30763272, 30763305, 30763639, 30763754, 30763970, 30764405, 30764663 -30764706, 30764976, 30765486, 30765995, 30767277, 30767654, 30768636 -30769312, 30770717, 30772069, 30773164, 30773696, 30773797, 30776416 -30776676, 30776929, 30777519, 30777759, 30778855, 30779240, 30781032 -30781041, 30781461, 30781970, 30782266, 30782300, 30782414, 30783395 -30783551, 30785101, 30786237, 30786641, 30786655, 30787365, 30788973 -30789904, 30790047, 30790441, 30801050, 30801296, 30801510, 30803210 -30804646, 30806757, 30806984, 30807723, 30807888, 30808109, 30808364 -30808869, 30809087, 30810680, 30810765, 30812574, 30814266, 30814285 -30815269, 30815495, 30815852, 30815994, 30816760, 30816938, 30819340 -30819629, 30820155, 30821297, 30822207, 30822502, 30822919, 30823744 -30825391, 30825419, 30825656, 30826474, 30827849, 30828205, 30828350 -30829779, 30829844, 30830555, 30832775, 30833454, 30834068, 30834110 -30834705, 30835184, 30835219, 30835853, 30836129, 30838605, 30839253 -30839315, 30839451, 30839836, 30840791, 30840793, 30841241, 30842277 -30843271, 30844839, 30845806, 30846063, 30846159, 30846782, 30847442 -30847871, 30848028, 30848097, 30848773, 30851448, 30851951, 30852954 -30855101, 30856358, 30857501, 30857721, 30858810, 30858877, 30858919 -30860741, 30860803, 30861988, 30862285, 30863115, 30864607, 30865805 -30866141, 30866988, 30867685, 30868010, 30868186, 30869131, 30870439 -30870513, 30871716, 30871792, 30873527, 30874084, 30874270, 30874337 -30874660, 30876666, 30879169, 30879708, 30880774, 30880913, 30881161 -30881407, 30883715, 30883785, 30883877, 30886188, 30887501, 30887777 -30887976, 30887989, 30889443, 30889607, 30889723, 30890720, 30890971 -30891760, 30891792, 30893601, 30895426, 30895577, 30896620, 30896685 -30898366, 30898381, 30898748, 30898939, 30901889, 30902655, 30904672 -30905604, 30906274, 30906407, 30909596, 30909918, 30910264, 30910267 -30913399, 30914272, 30914674, 30915781, 30919403, 30919587, 30919691 -30919804, 30921136, 30921259, 30922450, 30922936, 30922996, 30923514 -30923517, 30923597, 30923940, 30925316, 30925419, 30925828, 30927440 -30927821, 30930149, 30930339, 30931068, 30931311, 30931981, 30932674 -30932923, 30936251, 30936831, 30936942, 30937340, 30937391, 30937410 -30938413, 30939307, 30939317, 30939934, 30940259, 30940382, 30940868 -30940869, 30941056, 30944643, 30945005, 30945772, 30946072, 30946141 -30946595, 30946768, 30946843, 30946876, 30946896, 30947294, 30950786 -30952104, 30952191, 30953157, 30953266, 30953836, 30954062, 30955702 -30956571, 30956647, 30957739, 30958493, 30960314, 30960356, 30960736 -30961566, 30964194, 30965111, 30965554, 30965649, 30966205, 30967084 -30968737, 30968781, 30970518, 30972817, 30972841, 30972887, 30972947 -30972951, 30972959, 30972966, 30973085, 30973113, 30973127, 30973137 -30973143, 30973197, 30973698, 30973877, 30974207, 30974813, 30976603 -30977294, 30977411, 30978554, 30978747, 30979701, 30980023, 30980115 -30980317, 30980733, 30981182, 30981240, 30983064, 30985027, 30985906 -30986423, 30987088, 30987105, 30987243, 30987717, 30987724, 30988444 -30989951, 30990034, 30992120, 30992330, 30992597, 30993198, 30993518 -30993604, 30994996, 30996945, 30996991, 30997375, 30997960, 30998035 -30998662, 30998759, 30998847, 31000312, 31001017, 31001455, 31001490 -31001859, 31002223, 31002346, 31002923, 31003137, 31003659, 31003759 -31004077, 31004719, 31004844, 31004871, 31005003, 31006011, 31006259 -31006792, 31006953, 31008240, 31008858, 31008907, 31009032, 31009271 -31009545, 31009590, 31009680, 31010218, 31010554, 31010976, 31011361 -31013127, 31013531, 31014323, 31015330, 31016413, 31019249, 31021068 -31021109, 31021157, 31021324, 31021542, 31021780, 31022858, 31025267 -31025520, 31025531, 31025859, 31026220, 31026591, 31026860, 31027747 -31028883, 31028986, 31029936, 31030898, 31031240, 31031955, 31032463 -31032904, 31032913, 31034794, 31035287, 31035916, 31037421, 31038220 -31038447, 31038817, 31039337, 31039627, 31039928, 31041540, 31042208 -31042337, 31043483, 31043630, 31043695, 31043747, 31044145, 31044460 -31044504, 31044951, 31045929, 31046188, 31046619, 31047022, 31047169 -31047333, 31047697, 31047740, 31048025, 31048741, 31049215, 31049995 -31050557, 31051056, 31051075, 31052735, 31052809, 31053669, 31054177 -31054874, 31055142, 31056909, 31057402, 31058548, 31061482, 31061504 -31062010, 31062645, 31063315, 31063380, 31063769, 31064025, 31065701 -31065838, 31066082, 31066250, 31066265, 31066554, 31067456, 31067483 -31067892, 31069059, 31070528, 31071080, 31073440, 31073586, 31074032 -31075323, 31075960, 31077117, 31077365, 31078391, 31078757, 31079204 -31080474, 31081558, 31082719, 31084778, 31084921, 31086467, 31086869 -31086954, 31087361, 31087679, 31088115, 31088341, 31089270, 31090262 -31091469, 31091868, 31092129, 31092233, 31092581, 31092921, 31094183 -31094228, 31094249, 31094374, 31094688, 31095972, 31096846, 31097760 -31097961, 31098661, 31098870, 31099312, 31099926, 31099981, 31100172 -31101386, 31101840, 31103065, 31103804, 31104809, 31105896, 31106140 -31106577, 31107577, 31108603, 31108644, 31109506, 31109924, 31110021 -31112088, 31112530, 31112972, 31113089, 31113177, 31113249, 31113426 -31113682, 31114116, 31114265, 31114671, 31115201, 31115502, 31117282 -31118486, 31118702, 31118809, 31118844, 31119057, 31119846, 31120361 -31122876, 31124213, 31124363, 31124821, 31124914, 31125773, 31125849 -31125918, 31126053, 31126058, 31127043, 31127457, 31127961, 31127968 -31127969, 31128086, 31129851, 31130156, 31132732, 31134430, 31137765 -31138106, 31139643, 31140940, 31141792, 31142377, 31142749, 31142815 -31143146, 31143415, 31143870, 31145389, 31145403, 31145525, 31145804 -31146338, 31146727, 31151483, 31153120, 31153485, 31155085, 31155305 -31155634, 31156301, 31156383, 31156898, 31158151, 31158341, 31158380 -31159382, 31161861, 31162711, 31162915, 31163379, 31165038, 31165577 -31165722, 31166801, 31168440, 31170082, 31171096, 31171147, 31171631 -31172207, 31172233, 31172642, 31174836, 31175365, 31176451, 31176502 -31177193, 31177204, 31177221, 31178051, 31178058, 31178103, 31180519 -31181375, 31181380, 31182159, 31182451, 31182756, 31182793, 31183413 -31184230, 31185224, 31188038, 31188398, 31190624, 31191224, 31192039 -31193292, 31193511, 31193695, 31193745, 31193936, 31194264, 31195090 -31195430, 31195600, 31195838, 31196272, 31196310, 31196812, 31200057 -31200845, 31201001, 31201366, 31201611, 31202536, 31204412, 31204878 -31205834, 31206070, 31206201, 31207446, 31208287, 31213034, 31214119 -31214928, 31215422, 31215438, 31215548, 31215854, 31216823, 31216995 -31217946, 31218837, 31218904, 31219047, 31219975, 31220188, 31220549 -31220837, 31220881, 31220912, 31221454, 31222780, 31223382, 31224819 -31225538, 31226448, 31226534, 31228670, 31230775, 31233170, 31234765 -31234790, 31234983, 31235797, 31236624, 31240626, 31242319, 31242976 -31244968, 31245856, 31247532, 31247838, 31248496, 31249008, 31249406 -31249689, 31249696, 31250120, 31250152, 31250221, 31251325, 31252659 -31254297, 31254535, 31254929, 31255369, 31255869, 31256383, 31257740 -31257826, 31258101, 31258344, 31258697, 31258995, 31260692, 31261467 -31261641, 31262275, 31262388, 31265651, 31265773, 31268557, 31270711 -31270847, 31271032, 31274074, 31281708, 31282037, 31287296, 31287741 -31287871, 31289115, 31290017, 31290300, 31290427, 31291986, 31292298 -31293484, 31293867, 31298871, 31301460, 31303032, 31304573, 31304945 -31305114, 31305309, 31305624, 31306248, 31306261, 31306867, 31306927 -31307715, 31309379, 31309867, 31310564, 31310624, 31311830, 31312450 -31312976, 31313117, 31313177, 31313214, 31313444, 31313812, 31314323 -31314885, 31315495, 31315876, 31316250, 31317032, 31321092, 31322720 -31323383, 31325584, 31326320, 31326608, 31326977, 31326998, 31327046 -31327259, 31327278, 31327349, 31327391, 31327896, 31331354, 31331372 -31333156, 31334606, 31334961, 31335037, 31335142, 31336298, 31338249 -31338673, 31338686, 31338769, 31339457, 31339643, 31339744, 31341138 -31341746, 31343110, 31344046, 31344097, 31348711, 31348922, 31349426 -31350348, 31353098, 31353610, 31355339, 31356601, 31357581, 31357737 -31358308, 31358511, 31359215, 31359366, 31360146, 31360155, 31360214 -31360282, 31360314, 31360323, 31360469, 31360529, 31362408, 31362692 -31364001, 31364383, 31366716, 31367188, 31367364, 31368027, 31369444 -31372498, 31373825, 31373837, 31373843, 31374283, 31374449, 31374738 -31375865, 31376011, 31376708, 31377129, 31377206, 31377487, 31377808 -31377936, 31380443, 31381701, 31383049, 31383396, 31383464, 31383814 -31386394, 31386696, 31387033, 31387123, 31387426, 31387443, 31388201 -31388288, 31390936, 31390955, 31391991, 31393600, 31393991, 31394341 -31394347, 31394365, 31394544, 31395247, 31396027, 31396609, 31396695 -31396980, 31398505, 31398617, 31398663, 31398761, 31399131, 31399883 -31400754, 31401831, 31402078, 31402598, 31403177, 31403565, 31404014 -31404130, 31404263, 31404487, 31405300, 31405751, 31408636, 31409483 -31409912, 31409964, 31410289, 31411163, 31412209, 31414023, 31414524 -31415324, 31416193, 31416213, 31416250, 31417007, 31417192, 31417242 -31417336, 31417844, 31417990, 31418442, 31419363, 31420295, 31420316 -31420320, 31421316, 31422440, 31422620, 31423645, 31424838, 31425167 -31425761, 31425800, 31429501, 31429590, 31429770, 31429784, 31429844 -31429971, 31430722, 31430735, 31430910, 31431005, 31431326, 31431771 -31431964, 31431969, 31431971, 31431973, 31431975, 31431986, 31433092 -31433579, 31433749, 31434421, 31434805, 31434870, 31435163, 31435308 -31435735, 31437030, 31437448, 31440426, 31440813, 31441916, 31441920 -31442332, 31442714, 31443030, 31444353, 31444516, 31445356, 31446431 -31447733, 31448680, 31449354, 31450392, 31450653, 31450942, 31451019 -31453585, 31454428, 31454972, 31454988, 31455597, 31456857, 31458049 -31459231, 31459242, 31459369, 31462082, 31463613, 31464165, 31465389 -31466433, 31468060, 31468705, 31469001, 31471441, 31471589, 31471856 -31472077, 31473148, 31474315, 31475378, 31475635, 31476093, 31476603 -31476701, 31476736, 31477424, 31477695, 31479072, 31479075, 31479106 -31479272, 31479772, 31481750, 31483949, 31484385, 31484603, 31485340 -31485386, 31485507, 31486061, 31486557, 31487441, 31487491, 31487826 -31487844, 31488085, 31488464, 31489032, 31489137, 31489481, 31489590 -31489936, 31490604, 31491634, 31492171, 31492191, 31492588, 31492655 -31492856, 31493153, 31493840, 31494095, 31494264, 31494794, 31495254 -31495564, 31496174, 31497550, 31498559, 31499370, 31499700, 31500699 -31500719, 31500971, 31501139, 31502301, 31503349, 31503674, 31503934 -31505088, 31506095, 31507107, 31507129, 31508229, 31508712, 31509279 -31510891, 31510910, 31511142, 31511519, 31511940, 31512044, 31512262 -31513011, 31515163, 31515869, 31515879, 31515911, 31515929, 31516164 -31516184, 31516255, 31516265, 31517502, 31518371, 31522708, 31523548 -31523578, 31523585, 31523620, 31523646, 31523736, 31523836, 31525310 -31525609, 31525783, 31526250, 31526903, 31527103, 31527199, 31527381 -31528724, 31528738, 31528962, 31529594, 31529967, 31530985, 31530995 -31532084, 31532176, 31532308, 31532339, 31533050, 31533113, 31533274 -31533817, 31533833, 31535073, 31535870, 31535955, 31536401, 31536731 -31537521, 31537736, 31538274, 31538363, 31538891, 31539566, 31541805 -31541864, 31541905, 31542347, 31542356, 31542851, 31542956, 31543810 -31544097, 31545477, 31546864, 31547220, 31547445, 31547480, 31548675 -31549221, 31549468, 31551142, 31552563, 31552615, 31552738, 31552755 -31553289, 31553674, 31553813, 31553968, 31555126, 31555173, 31555346 -31555539, 31555800, 31556950, 31557518, 31557663, 31558194, 31559079 -31559085, 31559415, 31559563, 31560592, 31561886, 31563138, 31564060 -31564795, 31567124, 31567403, 31567441, 31567719, 31568423, 31569057 -31569867, 31570054, 31570161, 31571415, 31571742, 31572006, 31572046 -31572267, 31573269, 31573457, 31574122, 31574150, 31574244, 31574267 -31575529, 31575649, 31575665, 31576738, 31577569, 31578202, 31578994 -31580079, 31580122, 31580374, 31580437, 31581627, 31584056, 31584555 -31584853, 31585351, 31585491, 31585789, 31586381, 31586862, 31588933 -31590826, 31591384, 31591400, 31591409, 31591421, 31595025, 31595632 -31597104, 31597727, 31598146, 31599363, 31599990, 31600023, 31600291 -31600894, 31601385, 31603199, 31603380, 31603625, 31605119, 31605370 -31605737, 31606474, 31607937, 31608753, 31609974, 31610024, 31612535 -31613838, 31615736, 31616101, 31616104, 31617492, 31619276, 31620252 -31620748, 31620944, 31622250, 31623413, 31623463, 31625579, 31625618 -31625959, 31626438, 31626493, 31626528, 31626572, 31627587, 31628311 -31628753, 31629056, 31630551, 31630794, 31630946, 31631985, 31632273 -31632534, 31632605, 31632663, 31633224, 31634510, 31634805, 31635875 -31635963, 31635980, 31637094, 31637607, 31637680, 31638398, 31638733 -31638943, 31640139, 31640197, 31640240, 31642556, 31642639, 31644775 -31647304, 31648120, 31648157, 31649447, 31649818, 31649819, 31649958 -31649962, 31650046, 31650112, 31650202, 31652641, 31653080, 31653167 -31653634, 31653647, 31653758, 31653913, 31653916, 31653917, 31654116 -31654119, 31654122, 31654125, 31654133, 31655807, 31656263, 31657324 -31657462, 31657483, 31658464, 31658819, 31658943, 31659065, 31660283 -31661865, 31661879, 31662143, 31662504, 31662625, 31662925, 31663189 -31663788, 31664399, 31666449, 31666684, 31667096, 31667180, 31667940 -31668033, 31668061, 31668065, 31668694, 31668872, 31669064, 31670014 -31670263, 31670353, 31671568, 31672605, 31673406, 31674380, 31674801 -31675568, 31675852, 31675860, 31676941, 31677345, 31677460, 31677479 -31677587, 31678629, 31679900, 31680709, 31680713, 31680985, 31682766 -31683044, 31683260, 31683311, 31683373, 31683708, 31684080, 31684494 -31685612, 31685882, 31685989, 31686979, 31688127, 31688978, 31691030 -31691089, 31691480, 31695062, 31695693, 31696043, 31696577, 31696853 -31697741, 31699230, 31700234, 31701239, 31701517, 31701910, 31703614 -31705178, 31705265, 31705704, 31706595, 31706956, 31707190, 31708133 -31708175, 31709647, 31709739, 31709777, 31710272, 31711155, 31711720 -31711889, 31711997, 31712260, 31714645, 31715935, 31716510, 31716873 -31717010, 31718000, 31718134, 31718346, 31718842, 31719167, 31720344 -31720839, 31720942, 31721557, 31721863, 31721880, 31722558, 31722646 -31723226, 31723323, 31723651, 31727229, 31727560, 31728160, 31728440 -31728444, 31728447, 31728477, 31728486, 31728858, 31730485, 31730766 -31731076, 31731407, 31732311, 31734007, 31734012, 31734017, 31734583 -31735662, 31736095, 31737059, 31737603, 31739198, 31739891, 31740252 -31741938, 31743771, 31745130, 31745233, 31745528, 31746054, 31747706 -31747818, 31747935, 31747989, 31748000, 31748182, 31748233, 31748944 -31750577, 31750581, 31752492, 31752502, 31752633, 31753202, 31753425 -31753478, 31753692, 31754240, 31754546, 31754887, 31755245, 31755451 -31756415, 31756465, 31756568, 31756650, 31757357, 31757775, 31757824 -31758083, 31758344, 31758846, 31758939, 31758960, 31759565, 31760278 -31760592, 31760738, 31761510, 31762819, 31763030, 31763707, 31763905 -31764089, 31764239, 31764866, 31764913, 31765068, 31765246, 31765257 -31765296, 31766499, 31766534, 31766675, 31766696, 31767204, 31767237 -31767598, 31767852, 31768490, 31768497, 31768505, 31769373, 31769530 -31770289, 31771302, 31771370, 31771410, 31771468, 31771745, 31771836 -31772002, 31772070, 31773582, 31774019, 31774132, 31775101, 31776121 -31776659, 31776785, 31776994, 31777410, 31777489, 31779833, 31781897 -31783422, 31783451, 31783782, 31783985, 31785445, 31785572, 31786282 -31786838, 31787057, 31787655, 31788104, 31788594, 31788704, 31788761 -31788785, 31789178, 31790500, 31790757, 31792465, 31792615, 31793691 -31793713, 31794336, 31794882, 31795231, 31796208, 31796277, 31796882 -31798001, 31798669, 31798702, 31798742, 31799858, 31800053, 31800059 -31800757, 31804838, 31805812, 31807179, 31807516, 31809510, 31810213 -31812352, 31812824, 31815099, 31815227, 31816158, 31816343, 31816631 -31820632, 31820662, 31820842, 31820859, 31820926, 31821129, 31821835 -31822026, 31822951, 31823051, 31824504, 31824792, 31824934, 31825151 -31825324, 31825410, 31827339, 31827605, 31827912, 31828378, 31828999 -31829366, 31829617, 31829639, 31831950, 31832785, 31832901, 31833172 -31833585, 31833948, 31834191, 31834871, 31835805, 31835854, 31836113 -31836454, 31839038, 31839779, 31839888, 31840180, 31840490, 31840516 -31840992, 31841210, 31841696, 31842545, 31843028, 31843462, 31843476 -31843845, 31844557, 31845092, 31845403, 31845803, 31845955, 31846454 -31847489, 31847541, 31848331, 31848365, 31848391, 31848903, 31849859 -31850132, 31850227, 31851383, 31851449, 31852482, 31852506, 31852574 -31854285, 31854692, 31855307, 31855526, 31855996, 31858580, 31858621 -31858833, 31859067, 31859143, 31860193, 31860406, 31860760, 31862359 -31862593, 31862611, 31863118, 31863890, 31864818, 31864947, 31866141 -31866159, 31867037, 31867331, 31867351, 31869601, 31869944, 31869954 -31869966, 31870010, 31870150, 31870164, 31870190, 31870196, 31871384 -31871692, 31872230, 31873155, 31875140, 31876138, 31876368, 31878256 -31878314, 31880154, 31881527, 31883124, 31883343, 31883739, 31883845 -31886547, 31886695, 31886745, 31886848, 31887130, 31888148, 31888731 -31889222, 31890230, 31890516, 31892029, 31892856, 31895670, 31897178 -31897786, 31897854, 31898193, 31898257, 31900585, 31902517, 31902662 -31903523, 31903786, 31903962, 31904739, 31904933, 31905033, 31907042 -31907137, 31907510, 31907565, 31907792, 31908345, 31908482, 31908571 -31908750, 31909295, 31909807, 31912638, 31913650, 31913839, 31914003 -31914943, 31915444, 31915968, 31916644, 31917378, 31917494, 31917856 -31919563, 31919952, 31921267, 31922161, 31922580, 31923463, 31923622 -31925462, 31926203, 31926811, 31926848, 31927078, 31927510, 31927930 -31932042, 31932196, 31933451, 31933837, 31933842, 31933846, 31933914 -31934254, 31934301, 31935717, 31936588, 31936983, 31938116, 31938288 -31939461, 31939486, 31940176, 31940458, 31941148, 31941948, 31942136 -31942144, 31942258, 31942274, 31942473, 31943497, 31943691, 31945038 -31945407, 31945659, 31945827, 31945928, 31946936, 31947732, 31947861 -31949490, 31950244, 31950577, 31952046, 31952052, 31953394, 31953989 -31956113, 31956435, 31956920, 31957152, 31957564, 31957674, 31957683 -31958038, 31958958, 31959140, 31959253, 31960389, 31961578, 31961940 -31964519, 31965012, 31965391, 31965542, 31968431, 31970188, 31971792 -31972615, 31972671, 31973203, 31974424, 31974597, 31974693, 31976303 -31977024, 31977257, 31980216, 31980296, 31981745, 31981751, 31982879 -31985494, 31985738, 31985961, 31986808, 31986836, 31986905, 31988079 -31988833, 31990386, 31991705, 31992615, 31993051, 31993795, 31994298 -31995577, 31996264, 31997107, 31997457, 31997660, 31998181, 31998189 -31998861, 31999453, 32001851, 32002411, 32003551, 32003908, 32004148 -32004299, 32004977, 32005046, 32005048, 32005053, 32005215, 32006467 -32006703, 32006824, 32007076, 32007698, 32008408, 32008586, 32008819 -32009334, 32009754, 32010593, 32010707, 32011107, 32011888, 32012788 -32012975, 32013403, 32014520, 32015820, 32016884, 32017301, 32017422 -32017671, 32018632, 32018953, 32020701, 32022223, 32022711, 32025328 -32028155, 32028269, 32032653, 32032733, 32032887, 32033795, 32034766 -32035268, 32035536, 32035893, 32035899, 32035902, 32036045, 32037237 -32037962, 32038054, 32038780, 32038844, 32038996, 32040940, 32041799 -32042256, 32042352, 32042706, 32044533, 32044903, 32045377, 32046125 -32046587, 32047226, 32048412, 32048921, 32050048, 32051896, 32052587 -32054806, 32056529, 32057333, 32057565, 32057639, 32058260, 32060164 -32060577, 32061018, 32061146, 32061648, 32062227, 32064682, 32066061 -32067130, 32067356, 32067675, 32068110, 32068187, 32068190, 32069160 -32069508, 32069696, 32069834, 32071457, 32071582, 32072944, 32073027 -32073710, 32074450, 32075009, 32075020, 32075130, 32076561, 32077318 -32079573, 32079739, 32080081, 32080655, 32081381, 32082098, 32087331 -32087597, 32087956, 32088132, 32088478, 32089051, 32089820, 32090518 -32090725, 32093558, 32094825, 32095097, 32095380, 32095610, 32096252 -32097387, 32097589, 32097604, 32097882, 32097962, 32098224, 32098535 -32099153, 32099539, 32101305, 32102542, 32103383, 32103427, 32104324 -32104402, 32104610, 32105135, 32105239, 32105412, 32107505, 32107621 -32108094, 32108115, 32108566, 32108576, 32109384, 32109796, 32112798 -32112822, 32113113, 32113791, 32114541, 32114572, 32114746, 32115642 -32117115, 32117253, 32117490, 32118727, 32119339, 32119565, 32120283 -32120453, 32121014, 32121326, 32121673, 32121885, 32122574, 32123331 -32124176, 32124570, 32124594, 32124607, 32124611, 32125142, 32127227 -32127448, 32129659, 32130083, 32130485, 32130504, 32131010, 32131401 -32132464, 32132504, 32133039, 32138478, 32138782, 32139432, 32139659 -32140800, 32142788, 32143492, 32143562, 32144917, 32147340, 32148419 -32148662, 32150818, 32150854, 32151098, 32152341, 32153396, 32153619 -32153909, 32156194, 32157050, 32157078, 32161260, 32162391, 32164053 -32165367, 32165759, 32165814, 32165887, 32167592, 32167923, 32169151 -32170162, 32170190, 32171622, 32171791, 32172050, 32172773, 32172777 -32173142, 32173543, 32174321, 32174405, 32174492, 32174571, 32175329 -32175780, 32177701, 32177869, 32178217, 32178966, 32179209, 32179306 -32181149, 32182097, 32182783, 32183756, 32184235, 32184855, 32185296 -32186186, 32186983, 32187775, 32189869, 32189952, 32190132, 32190190 -32190284, 32190573, 32191427, 32191451, 32193431, 32195333, 32196492 -32196738, 32197147, 32198292, 32198396, 32199681, 32200524, 32201743 -32201903, 32201936, 32203068, 32203354, 32205825, 32207088, 32207920 -32208144, 32208346, 32208691, 32209784, 32210660, 32212041, 32212635 -32212916, 32213376, 32213696, 32214021, 32214195, 32214654, 32214743 -32214782, 32215240, 32215991, 32216027, 32218369, 32218395, 32218498 -32218552, 32219179, 32219318, 32219835, 32219988, 32220017, 32221141 -32222473, 32223669, 32224583, 32225117, 32225353, 32225742, 32225899 -32227352, 32228188, 32229431, 32229919, 32230213, 32230775, 32230953 -32231049, 32231356, 32234161, 32236601, 32236685, 32236798, 32237489 -32238935, 32239730, 32241889, 32243007, 32243814, 32243882, 32243985 -32244187, 32245711, 32245850, 32246090, 32248131, 32248405, 32248649 -32249207, 32249371, 32249640, 32249674, 32250232, 32250238, 32251364 -32252036, 32252213, 32252294, 32254063, 32254399, 32254686, 32255029 -32255073, 32258021, 32259063, 32259322, 32259535, 32259785, 32260010 -32260290, 32263923, 32264556, 32266406, 32266906, 32267171, 32267610 -32268669, 32274403, 32277643, 32277793, 32279351, 32280901, 32284241 -32284325, 32284485, 32284725, 32285086, 32285717, 32285789, 32287797 -32289552, 32289858, 32290313, 32290399, 32290949, 32291114, 32291139 -32292180, 32292805, 32293615, 32294566, 32294851, 32296259, 32296941 -32297373, 32297469, 32297849, 32298782, 32300098, 32300822, 32300849 -32301856, 32302561, 32303160, 32303657, 32304293, 32304712, 32305792 -32307046, 32307586, 32309046, 32309488, 32309723, 32312131, 32312412 -32312586, 32316070, 32316252, 32316326, 32317012, 32318528, 32318820 -32318914, 32319410, 32321317, 32321319, 32321765, 32322629, 32322738 -32323488, 32323600, 32323816, 32324219, 32325574, 32325611, 32327201 -32327208, 32328231, 32329914, 32330269, 32330540, 32331889, 32332107 -32334745, 32335769, 32338476, 32338736, 32338953, 32339801, 32340392 -32341260, 32342172, 32342345, 32343678, 32344099, 32344168, 32344199 -32345001, 32345178, 32345272, 32345785, 32346649, 32346733, 32353343 -32355765, 32355912, 32356340, 32356545, 32356609, 32356628, 32357412 -32357665, 32359044, 32361175, 32361677, 32362016, 32362066, 32362698 -32363549, 32363711, 32364147, 32366303, 32366461, 32366536, 32367151 -32368480, 32368789, 32368792, 32369041, 32372725, 32374050, 32374431 -32375438, 32375493, 32376774, 32376872, 32376922, 32379140, 32379303 -32379775, 32380591, 32381403, 32382207, 32385068, 32385141, 32385832 -32386482, 32386683, 32386720, 32386877, 32387555, 32387818, 32388247 -32389047, 32389497, 32390629, 32390855, 32391021, 32392724, 32393612 -32394623, 32396326, 32397350, 32398714, 32401086, 32402243, 32403509 -32404638, 32405239, 32406222, 32408640, 32409344, 32409942, 32410175 -32412340, 32413042, 32413512, 32414996, 32415846, 32415989, 32416652 -32416655, 32417227, 32417242, 32417274, 32417438, 32417632, 32419774 -32421958, 32422965, 32423985, 32425097, 32425124, 32425194, 32426213 -32426315, 32427158, 32427173, 32427226, 32427953, 32428097, 32428189 -32430745, 32431251, 32431290, 32431413, 32432078, 32435911, 32436342 -32436460, 32436721, 32436757, 32437538, 32441671, 32442404, 32443087 -32443531, 32443744, 32443935, 32444159, 32446565, 32449622, 32450344 -32453583, 32453611, 32453888, 32455219, 32455650, 32455742, 32455961 -32459153, 32460136, 32462153, 32464021, 32464584, 32465193, 32465209 -32465466, 32465495, 32465853, 32465894, 32466474, 32467812, 32469004 -32469225, 32471100, 32471251, 32471346, 32471642, 32472589, 32473465 -32474686, 32474926, 32474997, 32478452, 32480419, 32480510, 32480528 -32480541, 32481807, 32484945, 32485859, 32486528, 32489206, 32490128 -32490416, 32491443, 32492343, 32492422, 32492452, 32495545, 32495572 -32497756, 32498459, 32499155, 32500117, 32501930, 32503790, 32504340 -32504786, 32505009, 32505439, 32505557, 32505634, 32506309, 32506473 -32507542, 32509271, 32509584, 32509606, 32510116, 32512145, 32512918 -32515850, 32516336, 32517405, 32517797, 32518029, 32518679, 32519995 -32520691, 32520994, 32522300, 32523206, 32523613, 32523750, 32525039 -32529396, 32529483, 32530202, 32531259, 32531627, 32533019, 32533225 -32533461, 32534925, 32535106, 32535159, 32536006, 32538436, 32538824 -32539300, 32539322, 32539914, 32541049, 32542641, 32544464, 32544740 -32544784, 32545415, 32546408, 32548580, 32549351, 32550589, 32550751 -32551177, 32552602, 32553241, 32555120, 32556165, 32556891, 32559543 -32561759, 32561791, 32562587, 32563106, 32563940, 32565870, 32567750 -32567788, 32568163, 32569603, 32569745, 32573703, 32573942, 32576097 -32576508, 32576534, 32577408, 32578113, 32578616, 32578792, 32579075 -32579529, 32580082, 32580852, 32583315, 32583355, 32583375, 32584375 -32586534, 32587472, 32587567, 32587793, 32587994, 32588298, 32588656 -32589147, 32589990, 32593845, 32593886, 32593955, 32594965, 32595551 -32596355, 32596705, 32597099, 32597637, 32598406, 32602194, 32602344 -32602599, 32602735, 32602990, 32603152, 32603564, 32605116, 32606489 -32607991, 32608297, 32609886, 32610271, 32613788, 32614583, 32615310 -32615776, 32616678, 32618819, 32619195, 32619298, 32619327, 32620859 -32620919, 32621140, 32621309, 32622507, 32622612, 32626756, 32627140 -32628131, 32628221, 32629028, 32629772, 32629859, 32631787, 32633251 -32635881, 32635931, 32639950, 32641748, 32642587, 32645139, 32646025 -32647170, 32648248, 32651063, 32651769, 32651773, 32652143, 32652573 -32653669, 32654962, 32655446, 32655691, 32656231, 32656275, 32659574 -32659930, 32662165, 32663019, 32671481, 32672057, 32675095, 32675227 -32676084, 32676350, 32676659, 32677702, 32682430, 32686338, 32686850 -32692372, 32693242, 32697431, 32697781, 32698508, 32698569, 32700455 -32700989, 32701048, 32704013, 32704119, 32704765, 32705800, 32710165 -32710534, 32710750, 32711741, 32712220, 32715945, 32716726, 32718316 -32718721, 32720344, 32720458, 32724654, 32725484, 32728984, 32731498 -32733671, 32733845, 32734171, 32734800, 32737969, 32738356, 32739966 -32740421, 32740503, 32740987, 32743290, 32743511, 32746831, 32749028 -32753472, 32754845, 32755493, 32755517, 32755731, 32756914, 32757219 -32758096, 32760906, 32761294, 32762231, 32764690, 32765738, 32768752 -32769880, 32775512, 32775526, 32776891, 32784393, 32784403, 32786309 -32789228, 32793286, 32794120, 32795016, 32795712, 32797486, 32800137 -32801303, 32801337, 32803807, 32806112, 32807517, 32810125, 32810668 -32811069, 32811131, 32816003, 32817950, 32818019, 32822847, 32823692 -32827206, 32829563, 32831451, 32831855, 32833378, 32834168, 32838028 -32838533, 32841689, 32843754, 32846272, 32847975, 32848816, 32851841 -32855257, 32857370, 32857881, 32858446, 32868369, 32870681, 32872839 -32874995, 32875003, 32875118, 32878039, 32879990, 32880225, 32880390 -32881853, 32883252, 32889434, 32892883, 32893686, 32894842, 32895105 -32898971, 32900208, 32902635, 32903472, 32903625, 32907741, 32907975 -32908241, 32909292, 32913527, 32914508, 32915747, 32915847, 32916025 -32918394, 32922090, 32925421, 32930360, 32930423, 32936005, 32936859 -32936961, 32939376, 32939883, 32940714, 32941509, 32947264, 32953258 -32956092, 32961939, 32965460, 32968221, 32969466, 32973406, 32983750 -32987206, 32987308, 32988028, 32993522, 32996071, 32999086, 32999329 -33003817, 33009224, 33009351, 33010173, 33011198, 33026533, 33027525 -33027539, 33034103, 33035201, 33036321, 33046179, 33048277, 33060161 -33061339, 33100352, 33105656, 33109335, 33111729, 33114640, 33117641 -33120828, 33121880, 33123985, 33127032, 33127141, 33131742, 33144001 -33149578, 33159956, 33172631, 33185773, 33192462, 33211160, 33211334 -33212112, 33215225, 33218194, 33218518, 33221061, 33223248, 33242408 -33252648, 33275880, 33278133, 33289442, 33295267, 33308199, 33308244 -33317279, 33325981, 33332891, 33338891, 33352794, 33367909, 33388473 -33456516, 33459161 -``` - -## Version 19\.0\.0\.0\.ru\-2021\-07\.rur\-2021\-07\.r1 - -Version 19\.0\.0\.0\.ru\-2021\-07\.rur\-2021\-07\.r1 includes the following: -+ Patch 32904851: DATABASE RELEASE UPDATE 19\.12\.0\.0\.0 -+ Patch 32876380: OJVM RELEASE UPDATE 19\.12\.0\.0\.0 -+ Patch 32327201: RDBMS \- DSTV36 UPDATE \- TZDATA2020E -+ Patch 29213893: DBMS\_STATS FAILING WITH ERROR ORA\-01422 WHEN GATHERING STATS FOR USER TABLE -+ Patch 28730253: SUPPORT NEW ERA REIWA FOR JAPANESE IMPERIAL CALENDAR -+ PreUpgrade Jar: preupgrade\_19\_cbuild\_10\_lf\.zip - -### Combined Patches for Version 19\.0\.0\.0\.ru\-2021\-07\.rur\-2021\-07\.r1, Released July 2021 - -Bugs fixed: - -``` -7391838, 8460502, 8476681, 14570574, 14735102, 15931756, 16662822 -16664572, 16750494, 17275499, 17395507, 17428816, 17468475, 17777718 -18534283, 18697534, 19080742, 19138896, 19697993, 20007421, 20083476 -20313356, 20319830, 20479545, 20867658, 20922160, 21119541, 21232786 -21245711, 21374587, 21528318, 21629064, 21639146, 21888352, 21965541 -22066547, 22252368, 22325312, 22387320, 22580355, 22725871, 22729345 -22748979, 23020668, 23094775, 23125587, 23294761, 23296836, 23311885 -23606241, 23645975, 23734075, 23763462, 24336782, 24356932, 24561942 -24596874, 24669730, 24687075, 24833686, 24957575, 24971456, 25030027 -25092651, 25093917, 25148135, 25404117, 25416731, 25560538, 25562258 -25607406, 25607716, 25756945, 25792962, 25804387, 25804908, 25806201 -25809128, 25883179, 25905368, 25913778, 25986062, 25997810, 26001677 -26003708, 26108369, 26127355, 26173091, 26203132, 26256280, 26280704 -26284288, 26352615, 26440142, 26476244, 26497655, 26499997, 26500553 -26577716, 26587659, 26611353, 26668264, 26716835, 26739322, 26758837 -26777814, 26785852, 26789742, 26800890, 26819036, 26860844, 26872233 -26897528, 26951566, 26963540, 26978857, 27004798, 27004828, 27019512 -27036163, 27044169, 27044246, 27063461, 27086374, 27091809, 27101798 -27126122, 27126938, 27130348, 27131416, 27166935, 27195575, 27195935 -27221350, 27222128, 27243840, 27244999, 27254335, 27260704, 27261477 -27277677, 27302372, 27329690, 27359766, 27359770, 27362994, 27369515 -27378053, 27381279, 27392968, 27406105, 27411022, 27423500, 27439716 -27453490, 27458357, 27458493, 27460010, 27489107, 27497101, 27572040 -27582210, 27589260, 27597359, 27604329, 27622946, 27629928, 27636387 -27639208, 27654410, 27658166, 27661222, 27666312, 27684864, 27692173 -27697886, 27700413, 27710072, 27729678, 27742354, 27745728, 27751111 -27760043, 27764052, 27785931, 27786168, 27801144, 27828892, 27829722 -27841399, 27846298, 27873364, 27877830, 27880025, 27907898, 27917890 -27929509, 27933036, 27934711, 27935464, 27941110, 27957203, 27957963 -27967484, 27998559, 28001632, 28007516, 28031385, 28052648, 28064977 -28072567, 28078186, 28089605, 28092783, 28104176, 28109326, 28112563 -28125947, 28127569, 28129791, 28133903, 28138566, 28138847, 28144569 -28145995, 28156781, 28173612, 28181021, 28185286, 28187837, 28189466 -28198802, 28201045, 28204104, 28204262, 28205555, 28209985, 28210681 -28234255, 28248841, 28263142, 28271258, 28271693, 28276054, 28279176 -28279456, 28294563, 28302580, 28313275, 28319114, 28322973, 28326928 -28338211, 28350595, 28351919, 28364580, 28370061, 28371123, 28373960 -28375383, 28379065, 28381939, 28383667, 28386259, 28387185, 28387574 -28390273, 28392179, 28395302, 28397317, 28402823, 28403019, 28406374 -28410431, 28414968, 28431445, 28432345, 28435333, 28436414, 28442896 -28454215, 28461789, 28463226, 28470673, 28475242, 28479352, 28482048 -28484299, 28489419, 28492006, 28498976, 28499269, 28502773, 28503081 -28504631, 28505321, 28513333, 28521330, 28522750, 28523644, 28526715 -28530171, 28530697, 28534475, 28534493, 28535127, 28537481, 28538439 -28541606, 28542455, 28546290, 28547068, 28547926, 28558489, 28558645 -28561704, 28564479, 28565296, 28567417, 28567819, 28569897, 28570589 -28572165, 28572407, 28572533, 28572544, 28572667, 28572834, 28578945 -28587723, 28589194, 28589509, 28589644, 28592647, 28593127, 28593682 -28594086, 28597221, 28598022, 28601957, 28602253, 28605066, 28606598 -28607316, 28607632, 28608211, 28612239, 28618343, 28620697, 28621543 -28622202, 28625580, 28625862, 28625873, 28627033, 28628592, 28630381 -28632796, 28636532, 28639299, 28640772, 28642469, 28642551, 28642899 -28643583, 28643654, 28643718, 28644549, 28645570, 28646200, 28646939 -28649388, 28655209, 28657026, 28659098, 28661333, 28661362, 28663289 -28663782, 28670402, 28672124, 28672457, 28673945, 28681153, 28682182 -28682796, 28689483, 28690694, 28692103, 28692275, 28692282, 28693954 -28694639, 28694872, 28694877, 28696373, 28697526, 28698087, 28699321 -28700945, 28703812, 28704412, 28705231, 28707931, 28708400, 28708585 -28709063, 28710385, 28710469, 28710663, 28710734, 28714461, 28714720 -28715655, 28715727, 28717406, 28718302, 28718469, 28719348, 28720204 -28720418, 28721497, 28722229, 28729900, 28730079, 28730253, 28734355 -28740708, 28740799, 28741374, 28742555, 28745367, 28747846, 28749853 -28751498, 28752923, 28755011, 28755084, 28755309, 28755846, 28757960 -28758722, 28760206, 28763291, 28765983, 28767240, 28769456, 28770865 -28771022, 28771947, 28772390, 28772816, 28774416, 28776431, 28776811 -28777073, 28777214, 28778754, 28781599, 28781754, 28785273, 28785321 -28785531, 28788272, 28789531, 28789533, 28791576, 28791852, 28793062 -28794230, 28795551, 28795734, 28800508, 28802066, 28802734, 28804517 -28805242, 28806517, 28807247, 28808314, 28808652, 28808656, 28810381 -28811560, 28813317, 28813931, 28815123, 28815355, 28815557, 28816871 -28817449, 28818063, 28819640, 28820669, 28821847, 28824482, 28827682 -28831971, 28833912, 28835937, 28836716, 28837979, 28838385, 28839869 -28844656, 28844738, 28845346, 28846759, 28847541, 28847572, 28849776 -28850084, 28851458, 28851467, 28852325, 28854004, 28854733, 28855520 -28855922, 28857552, 28861861, 28862532, 28863263, 28863432, 28863487 -28865544, 28865569, 28867698, 28867992, 28870496, 28871040, 28872645 -28872829, 28873575, 28874416, 28875089, 28876253, 28876639, 28876926 -28877252, 28878865, 28880864, 28881191, 28881848, 28882146, 28882784 -28884931, 28887305, 28888083, 28888327, 28889389, 28889730, 28891941 -28892794, 28897123, 28897512, 28899663, 28900506, 28901126, 28902135 -28904380, 28905312, 28905390, 28905457, 28905615, 28907196, 28909769 -28909992, 28910498, 28910586, 28911140, 28912691, 28914144, 28915561 -28917080, 28918429, 28919145, 28921844, 28922227, 28922485, 28922532 -28922608, 28922767, 28925250, 28925460, 28925634, 28925880, 28927452 -28928462, 28930944, 28932914, 28933079, 28933158, 28935293, 28935956 -28936114, 28937717, 28938167, 28938422, 28938698, 28940179, 28940281 -28940472, 28941901, 28942455, 28942694, 28945421, 28945994, 28946233 -28946574, 28948554, 28949888, 28950868, 28951332, 28951493, 28951533 -28952168, 28954762, 28955606, 28955883, 28956145, 28956908, 28957260 -28957292, 28957723, 28958088, 28958094, 28958590, 28959493, 28960863 -28962775, 28963036, 28965084, 28965095, 28965231, 28965376, 28966444 -28968211, 28968779, 28970122, 28974083, 28974999, 28977322, 28978664 -28980448, 28980910, 28981871, 28983095, 28983486, 28984313, 28985114 -28985272, 28985362, 28985478, 28986207, 28986231, 28986257, 28986326 -28986481, 28986696, 28988482, 28988864, 28989306, 28990681, 28993295 -28993353, 28994307, 28994542, 28994783, 28995287, 28996376, 28998369 -28999046, 29000000, 29001305, 29001888, 29002273, 29002488, 29002784 -29002927, 29003207, 29003407, 29003617, 29003738, 29006318, 29006621 -29007321, 29007353, 29007775, 29008035, 29008669, 29009513, 29010126 -29010517, 29011936, 29012609, 29013475, 29013832, 29014076, 29014385 -29015118, 29016294, 29017265, 29018655, 29018680, 29019121, 29020423 -29021063, 29021352, 29022986, 29024028, 29024054, 29024448, 29024552 -29024732, 29024795, 29024876, 29026154, 29026582, 29026606, 29027456 -29027694, 29027933, 29027940, 29030184, 29030927, 29031575, 29031600 -29032234, 29032276, 29032457, 29032607, 29033052, 29033145, 29033164 -29033200, 29033280, 29033655, 29034587, 29036278, 29037290, 29038528 -29038728, 29038730, 29039089, 29039510, 29040739, 29041739, 29041775 -29043554, 29043651, 29043725, 29044086, 29044763, 29044954, 29046482 -29047127, 29047850, 29048178, 29048289, 29048498, 29048605, 29048728 -29048792, 29048858, 29049673, 29050357, 29050560, 29050765, 29050886 -29051263, 29051702, 29051953, 29052726, 29052850, 29053783, 29053902 -29055644, 29056024, 29056270, 29056560, 29056767, 29056894, 29058476 -29059011, 29060216, 29061016, 29061959, 29062692, 29062848, 29062860 -29062868, 29110526, 29110783, 29110790, 29110797, 29110802, 29110805 -29111598, 29111631, 29112455, 29113282, 29113305, 29115794, 29115857 -29117337, 29117526, 29117642, 29118543, 29119077, 29119733, 29120223 -29122224, 29122254, 29122367, 29123297, 29123324, 29123432, 29123444 -29123482, 29124104, 29124368, 29125036, 29125374, 29125380, 29125708 -29125786, 29126345, 29127957, 29128693, 29128935, 29129450, 29129476 -29129497, 29129691, 29129712, 29130219, 29131539, 29131772, 29132456 -29132869, 29132938, 29133470, 29134447, 29135383, 29135649, 29136111 -29138641, 29139070, 29139727, 29139761, 29139780, 29139956, 29141316 -29141341, 29141685, 29141886, 29142609, 29142667, 29143516, 29144995 -29145214, 29145730, 29146077, 29146157, 29146810, 29147849, 29148799 -29149170, 29149829, 29150338, 29151520, 29152357, 29152603, 29152752 -29154631, 29154636, 29154725, 29154829, 29155099, 29155208, 29157051 -29157389, 29158680, 29158899, 29158990, 29159216, 29159661, 29159909 -29159936, 29160174, 29160462, 29160824, 29161597, 29161923, 29162095 -29162749, 29163073, 29163156, 29163415, 29163437, 29163524, 29163567 -29164376, 29164446, 29165682, 29167111, 29167342, 29167374, 29167940 -29168137, 29168219, 29168433, 29169073, 29169215, 29169540, 29169739 -29170232, 29170717, 29171683, 29171942, 29172618, 29172826, 29173140 -29173373, 29173618, 29173817, 29174004, 29174753, 29175638, 29175829 -29176318, 29177466, 29177543, 29177886, 29178385, 29179097, 29180313 -29180455, 29180559, 29180721, 29180893, 29181078, 29181153, 29181231 -29181568, 29181620, 29181743, 29181923, 29182019, 29182517, 29182901 -29182920, 29183298, 29183912, 29184297, 29184666, 29185193, 29186091 -29186456, 29186605, 29188255, 29189302, 29189307, 29189889, 29190235 -29190474, 29190663, 29190740, 29191541, 29191827, 29192419, 29192468 -29192685, 29193207, 29194205, 29194367, 29194493, 29194827, 29194981 -29195279, 29195337, 29195758, 29196151, 29196725, 29198092, 29198913 -29199163, 29199635, 29199733, 29200316, 29200700, 29201143, 29201494 -29201539, 29201695, 29201787, 29202104, 29202461, 29202850, 29203041 -29203122, 29203166, 29203227, 29203425, 29203443, 29203604, 29205281 -29205323, 29205419, 29205463, 29205767, 29205918, 29206109, 29206605 -29206631, 29207073, 29208260, 29208732, 29209545, 29210577, 29210610 -29210624, 29210683, 29211457, 29211724, 29212012, 29212433, 29212611 -29213320, 29213351, 29213613, 29213641, 29213775, 29213850, 29213879 -29213893, 29214561, 29214960, 29216312, 29216723, 29216746, 29216984 -29217294, 29217472, 29217828, 29217848, 29217856, 29218570, 29219205 -29219273, 29219627, 29220079, 29221248, 29221745, 29221891, 29221942 -29222031, 29222784, 29222892, 29223833, 29223859, 29223967, 29224065 -29224294, 29224605, 29224710, 29225076, 29225168, 29225758, 29225861 -29227602, 29228869, 29229164, 29229754, 29229839, 29229844, 29229955 -29230252, 29230565, 29231133, 29232117, 29232154, 29232449, 29232533 -29232653, 29233415, 29233810, 29233953, 29234123, 29235934, 29236573 -29237538, 29237575, 29237744, 29240307, 29240668, 29240759, 29241345 -29241651, 29242017, 29242561, 29242884, 29242906, 29243749, 29243958 -29244495, 29244766, 29244968, 29245063, 29245137, 29245160, 29246163 -29246337, 29247183, 29247415, 29247712, 29247906, 29248495, 29248552 -29248723, 29248835, 29248858, 29249289, 29249412, 29249583, 29249991 -29250059, 29250317, 29251259, 29251564, 29252510, 29252790, 29253184 -29253871, 29254031, 29254623, 29254930, 29255178, 29255273, 29255431 -29255435, 29255616, 29255705, 29255718, 29255973, 29256426, 29259119 -29259320, 29260224, 29260407, 29260452, 29260956, 29261547, 29261548 -29261695, 29261906, 29262143, 29262512, 29262887, 29265446, 29265448 -29265780, 29266248, 29266899, 29267292, 29268412, 29269171, 29269228 -29269825, 29270585, 29271019, 29273168, 29273360, 29273539, 29273570 -29273735, 29273812, 29273847, 29274428, 29274564, 29274627, 29275461 -29276272, 29277317, 29278218, 29278684, 29279658, 29279751, 29279854 -29281112, 29281527, 29281691, 29281796, 29282090, 29282233, 29282666 -29282898, 29285197, 29285453, 29285503, 29285621, 29285788, 29285956 -29286037, 29286220, 29286229, 29287130, 29287705, 29290110, 29290235 -29292232, 29292253, 29292378, 29292837, 29293072, 29293574, 29293806 -29294753, 29296257, 29297863, 29297915, 29298220, 29299049, 29299082 -29299830, 29299844, 29301463, 29301566, 29302565, 29302614, 29302963 -29303918, 29304314, 29304692, 29304781, 29304853, 29305093, 29306226 -29306713, 29306790, 29307090, 29307109, 29307638, 29309698, 29311336 -29311528, 29311588, 29311927, 29312310, 29312672, 29312734, 29312753 -29312889, 29313347, 29313417, 29313525, 29314539, 29314636, 29314867 -29314949, 29317756, 29318410, 29319441, 29320900, 29321489, 29321689 -29323946, 29323999, 29324568, 29324735, 29325087, 29325105, 29325257 -29325356, 29325497, 29325765, 29325993, 29326233, 29327044, 29327892 -29329042, 29329087, 29329675, 29329807, 29329848, 29330361, 29330791 -29331066, 29331209, 29331380, 29331493, 29332292, 29332395, 29332763 -29332771, 29333500, 29336843, 29336899, 29337294, 29337310, 29337742 -29338315, 29338348, 29338453, 29338780, 29338913, 29339101, 29339155 -29339299, 29339452, 29340333, 29341209, 29341782, 29342099, 29343086 -29343156, 29343861, 29344541, 29345382, 29345937, 29346057, 29346138 -29346211, 29346943, 29347620, 29348176, 29348358, 29350052, 29350712 -29350762, 29350868, 29351044, 29351386, 29351662, 29351716, 29351735 -29351749, 29351771, 29351786, 29352298, 29352724, 29352867, 29352947 -29353271, 29353432, 29353718, 29353821, 29353960, 29355654, 29356547 -29356634, 29356704, 29356711, 29356752, 29356782, 29357821, 29358509 -29358828, 29360252, 29360285, 29360467, 29360672, 29360775, 29360911 -29360950, 29361319, 29361472, 29361801, 29362596, 29363090, 29363151 -29364171, 29364177, 29366406, 29366818, 29366940, 29367019, 29367561 -29367971, 29368253, 29368310, 29368725, 29372069, 29372541, 29372562 -29373418, 29373588, 29374179, 29374604, 29374627, 29375355, 29375941 -29375984, 29376346, 29377804, 29377986, 29378029, 29378287, 29378834 -29378913, 29379299, 29379381, 29379750, 29379978, 29380527, 29381000 -29382296, 29382641, 29382784, 29382815, 29383695, 29384740, 29384781 -29384854, 29384864, 29385339, 29385429, 29385652, 29385774, 29386502 -29386557, 29386635, 29386660, 29386835, 29387073, 29387274, 29387310 -29387329, 29387337, 29388020, 29388072, 29388094, 29388524, 29388830 -29389408, 29389889, 29390011, 29390435, 29390785, 29391030, 29391237 -29391301, 29391438, 29391849, 29391925, 29392554, 29392966, 29393291 -29393649, 29394014, 29394140, 29394749, 29395657, 29396481, 29397841 -29397954, 29397996, 29398488, 29398863, 29399046, 29399100, 29399121 -29399336, 29399938, 29399959, 29402110, 29402131, 29404425, 29404483 -29405012, 29405462, 29405651, 29405996, 29407488, 29407804, 29408853 -29409149, 29409455, 29410311, 29410834, 29411037, 29411427, 29411469 -29411931, 29412066, 29412269, 29413360, 29413382, 29413517, 29413544 -29413634, 29413956, 29415493, 29415774, 29416688, 29416700, 29417084 -29417113, 29417173, 29417719, 29417884, 29418165, 29418341, 29420254 -29420834, 29421059, 29423003, 29423016, 29423156, 29423227, 29423491 -29423826, 29424094, 29424999, 29426241, 29426320, 29428230, 29429017 -29429087, 29429264, 29429336, 29429466, 29429566, 29429895, 29430524 -29430866, 29431192, 29431402, 29431485, 29431985, 29432176, 29434301 -29434869, 29435474, 29435652, 29435966, 29436454, 29436514, 29436522 -29436727, 29437029, 29437379, 29437594, 29437712, 29438150, 29438277 -29438736, 29439522, 29440651, 29441196, 29442400, 29442936, 29443187 -29443250, 29443559, 29444072, 29444275, 29444282, 29444602, 29444906 -29445548, 29446319, 29446669, 29447460, 29448498, 29449477, 29449845 -29449852, 29450162, 29450193, 29450273, 29450421, 29450812, 29450936 -29451085, 29451386, 29452251, 29452576, 29452936, 29452953, 29454450 -29454978, 29455424, 29455773, 29456538, 29456714, 29457312, 29457319 -29457370, 29457502, 29457807, 29457978, 29458132, 29460252, 29461420 -29461791, 29461971, 29462594, 29462767, 29462957, 29463047, 29463528 -29463553, 29463798, 29464616, 29464779, 29465047, 29465177, 29466674 -29467622, 29469563, 29469565, 29470059, 29470205, 29470291, 29471633 -29471832, 29471857, 29471860, 29472618, 29473708, 29475386, 29476473 -29476702, 29477015, 29481584, 29482021, 29483452, 29483532, 29483626 -29483672, 29483685, 29483712, 29483723, 29483771, 29485099, 29485731 -29485877, 29486181, 29486848, 29487150, 29487189, 29487407, 29488894 -29489436, 29489546, 29490256, 29491784, 29492127, 29492939, 29493122 -29493821, 29494245, 29494788, 29494934, 29495057, 29495171, 29495684 -29497053, 29497311, 29497588, 29497696, 29497778, 29498198, 29500257 -29500826, 29500963, 29501218, 29502561, 29503543, 29503631, 29503827 -29504103, 29504492, 29504682, 29505225, 29505589, 29505668, 29506942 -29507270, 29507616, 29508681, 29508998, 29509777, 29510278, 29511064 -29511611, 29511980, 29512125, 29512890, 29514479, 29515134, 29515240 -29515476, 29515766, 29515834, 29516300, 29516727, 29516766, 29517168 -29517443, 29517883, 29518604, 29518767, 29519131, 29521187, 29521688 -29521748, 29521862, 29522358, 29522561, 29522662, 29523055, 29523216 -29523511, 29524599, 29524985, 29525366, 29525467, 29525886, 29526966 -29527595, 29527610, 29528368, 29529147, 29529436, 29530440, 29530515 -29530812, 29530909, 29531654, 29531836, 29532112, 29532532, 29536342 -29536445, 29536794, 29537829, 29538631, 29539027, 29539413, 29540327 -29540831, 29541517, 29541742, 29541769, 29541973, 29542084, 29542449 -29542474, 29542580, 29542643, 29543034, 29543956, 29544552, 29546817 -29547010, 29547867, 29548413, 29548427, 29548592, 29548687, 29548722 -29549040, 29549071, 29549104, 29549154, 29549730, 29550530, 29552402 -29552773, 29553141, 29554092, 29554351, 29554554, 29555105, 29555239 -29557144, 29557261, 29557336, 29557556, 29558238, 29558452, 29558926 -29558975, 29559187, 29559395, 29559446, 29559908, 29559981, 29564592 -29564593, 29565611, 29579919, 29580394, 29580983, 29581771, 29583018 -29584261, 29584693, 29586143, 29587299, 29587720, 29587765, 29588580 -29588732, 29589544, 29590666, 29591343, 29591641, 29592011, 29592215 -29592433, 29592595, 29597536, 29597716, 29597754, 29598039, 29598040 -29598046, 29598226, 29598233, 29599008, 29599243, 29599300, 29599552 -29601461, 29602831, 29603460, 29603884, 29604002, 29604257, 29606261 -29607136, 29607797, 29608000, 29608023, 29609603, 29610506, 29611020 -29611991, 29613733, 29614206, 29614931, 29614987, 29615824, 29616244 -29616414, 29618074, 29618190, 29620042, 29622936, 29623323, 29623592 -29624124, 29625065, 29625804, 29625876, 29626154, 29626732, 29628200 -29628647, 29629430, 29629650, 29629681, 29629745, 29631749, 29632095 -29632265, 29632611, 29633697, 29633753, 29633936, 29634643, 29635427 -29635717, 29635990, 29637362, 29637526, 29637560, 29638285, 29638928 -29641736, 29642451, 29643721, 29644426, 29644464, 29645167, 29645349 -29647176, 29647770, 29648928, 29649694, 29651183, 29651520, 29652809 -29653132, 29653246, 29655164, 29655416, 29655668, 29656400, 29656819 -29656843, 29657399, 29657422, 29657744, 29657960, 29657973, 29658056 -29661028, 29661065, 29661722, 29663191, 29663368, 29663494, 29663601 -29663813, 29664087, 29664161, 29665168, 29665940, 29666451, 29667527 -29667994, 29668005, 29669241, 29669413, 29670713, 29670782, 29671363 -29672507, 29675446, 29676089, 29676921, 29677051, 29677173, 29677733 -29677927, 29678217, 29679856, 29680700, 29681987, 29683039, 29683211 -29684518, 29685137, 29685276, 29687214, 29687220, 29687459, 29687718 -29687727, 29687763, 29688867, 29689145, 29689255, 29690795, 29692115 -29692694, 29693847, 29694869, 29695425, 29695821, 29695841, 29695964 -29695987, 29696242, 29696310, 29697928, 29700125, 29700460, 29700770 -29701720, 29701755, 29701937, 29703932, 29705793, 29706160, 29707099 -29707493, 29707896, 29708324, 29708353, 29708876, 29708915, 29710188 -29710858, 29713810, 29715220, 29715703, 29716029, 29716194, 29716227 -29716491, 29716602, 29716871, 29717659, 29717901, 29718198, 29719146 -29720133, 29720373, 29721418, 29721576, 29722026, 29722092, 29722167 -29722389, 29724497, 29724658, 29725425, 29725476, 29725781, 29726695 -29737941, 29738374, 29738400, 29739576, 29741319, 29741976, 29742223 -29742926, 29744225, 29744400, 29744637, 29745288, 29745624, 29746962 -29747493, 29747648, 29747653, 29748285, 29748325, 29748336, 29748513 -29749471, 29750673, 29751094, 29753244, 29754196, 29754951, 29755821 -29756274, 29756444, 29757099, 29757264, 29757651, 29757687, 29758203 -29758217, 29758661, 29761678, 29761837, 29761911, 29763158, 29764644 -29765035, 29765219, 29765347, 29765393, 29765493, 29766207, 29766435 -29766503, 29766679, 29768487, 29768899, 29769549, 29769695, 29769901 -29770750, 29771032, 29771242, 29772514, 29772761, 29773197, 29773205 -29773459, 29773633, 29773842, 29774362, 29775393, 29775473, 29779196 -29780140, 29780633, 29782211, 29782284, 29782501, 29782823, 29782866 -29783142, 29784106, 29785169, 29785239, 29785251, 29785311, 29785544 -29785550, 29785831, 29787292, 29787766, 29789911, 29791152, 29791880 -29791916, 29792213, 29792433, 29793318, 29794174, 29794462, 29795712 -29795957, 29796335, 29796378, 29796916, 29797209, 29797726, 29801164 -29802382, 29802695, 29803948, 29804875, 29805368, 29805772, 29806390 -29806964, 29807964, 29809792, 29809837, 29810013, 29811616, 29812084 -29812166, 29812489, 29813503, 29813650, 29813671, 29814995, 29815341 -29815713, 29816887, 29817278, 29817547, 29817784, 29818794, 29819753 -29820341, 29821130, 29821582, 29822714, 29825525, 29827647, 29827792 -29827852, 29828644, 29829339, 29831196, 29831404, 29831567, 29833406 -29833984, 29834506, 29836096, 29836424, 29838337, 29838485, 29838740 -29838773, 29839481, 29839715, 29840619, 29841267, 29841687, 29842369 -29843238, 29843277, 29843692, 29843831, 29844131, 29844226, 29844275 -29845449, 29845530, 29845691, 29846126, 29846525, 29846645, 29846688 -29847627, 29848084, 29848849, 29849100, 29849139, 29850566, 29850930 -29851020, 29851308, 29851733, 29853485, 29856420, 29856506, 29856859 -29856890, 29858121, 29858376, 29858420, 29859068, 29860022, 29860994 -29861075, 29864203, 29864261, 29865188, 29865590, 29865658, 29867728 -29868639, 29869052, 29869086, 29869149, 29869404, 29869857, 29869877 -29869887, 29869906, 29870065, 29870533, 29871098, 29871312, 29871360 -29872401, 29872937, 29872983, 29873206, 29873665, 29874090, 29874761 -29875200, 29875459, 29875565, 29875919, 29876358, 29876989, 29877608 -29878076, 29881050, 29881478, 29881575, 29881643, 29881839, 29882427 -29882454, 29882729, 29884958, 29885182, 29885890, 29886809, 29887045 -29887111, 29888621, 29889184, 29889358, 29890740, 29891075, 29891853 -29891857, 29891916, 29892388, 29892604, 29893132, 29893287, 29894021 -29896510, 29897418, 29897863, 29900203, 29900824, 29901419, 29901961 -29902299, 29902327, 29902330, 29902659, 29903190, 29903299, 29903357 -29903454, 29904002, 29906678, 29907942, 29908389, 29908639, 29908777 -29909658, 29910218, 29910402, 29912135, 29912286, 29913805, 29913934 -29913966, 29914449, 29914544, 29915217, 29915848, 29916198, 29916975 -29919782, 29919789, 29920025, 29920376, 29920804, 29921318, 29922225 -29922435, 29922461, 29923452, 29924147, 29924181, 29924479, 29925177 -29926466, 29927756, 29928040, 29928210, 29928340, 29928427, 29928564 -29930457, 29931956, 29932202, 29932310, 29932430, 29932780, 29932953 -29933718, 29934048, 29934052, 29934158, 29935685, 29937565, 29937655 -29937956, 29938225, 29939075, 29939400, 29939795, 29940373, 29941062 -29942096, 29942275, 29942554, 29943670, 29943879, 29944035, 29944159 -29944660, 29944963, 29945645, 29946388, 29947145, 29947242, 29947428 -29948165, 29950018, 29950220, 29951620, 29951759, 29952700, 29956016 -29956222, 29957412, 29957493, 29958925, 29960325, 29960884, 29961353 -29961360, 29961609, 29961847, 29962160, 29962248, 29962834, 29962927 -29962939, 29965052, 29965207, 29965603, 29965888, 29966768, 29967223 -29968085, 29968703, 29969557, 29969985, 29970081, 29970261, 29970298 -29970587, 29970861, 29971027, 29971481, 29971888, 29971936, 29971951 -29972134, 29972176, 29973012, 29989783, 29989845, 29990779, 29991257 -29993717, 29997326, 29997553, 29997937, 29997959, 30000518, 30000664 -30001105, 30001331, 30003187, 30004660, 30004856, 30006159, 30006472 -30006705, 30006985, 30007450, 30007536, 30007797, 30008035, 30008125 -30008198, 30008214, 30008456, 30009528, 30009710, 30012181, 30012737 -30013243, 30013535, 30014200, 30015070, 30017836, 30018017, 30018903 -30019864, 30021830, 30024618, 30025814, 30026016, 30026596, 30027614 -30027649, 30028182, 30028599, 30028649, 30029519, 30029806, 30031027 -30032233, 30032376, 30032484, 30033040, 30033547, 30034456, 30035598 -30036258, 30038392, 30038576, 30039800, 30039959, 30040157, 30040511 -30041501, 30041514, 30042490, 30043398, 30043610, 30043930, 30044108 -30044507, 30045242, 30045273, 30045389, 30045484, 30045983, 30046497 -30047510, 30047531, 30047702, 30047765, 30047931, 30048688, 30049966 -30051176, 30051783, 30051804, 30052740, 30052928, 30053036, 30053501 -30053748, 30054980, 30056058, 30057718, 30057799, 30058149, 30058453 -30059106, 30059109, 30059821, 30060267, 30060330, 30062364, 30062429 -30062736, 30062819, 30064268, 30066352, 30067565, 30068384, 30068792 -30068871, 30070064, 30071446, 30072018, 30072905, 30073314, 30073422 -30073744, 30074250, 30074296, 30074349, 30074469, 30074472, 30074820 -30075037, 30076058, 30076197, 30076253, 30076604, 30078675, 30078934 -30079949, 30080111, 30080266, 30081055, 30081546, 30081580, 30082145 -30083100, 30083216, 30083488, 30083807, 30084458, 30084971, 30085897 -30086596, 30086992, 30087165, 30087509, 30088229, 30088421, 30090568 -30092254, 30092280, 30092859, 30094929, 30094948, 30095591, 30095952 -30096138, 30097092, 30097115, 30098251, 30099302, 30099420, 30099454 -30100354, 30101090, 30101186, 30101541, 30101847, 30102774, 30103551 -30103553, 30104348, 30104378, 30104555, 30105458, 30106748, 30106901 -30108012, 30109365, 30110224, 30110370, 30110518, 30114477, 30114489 -30114534, 30116085, 30116203, 30116753, 30116854, 30117209, 30117335 -30117469, 30117593, 30118261, 30118279, 30120608, 30122523, 30122583 -30123138, 30125765, 30126145, 30126470, 30127145, 30127522, 30127805 -30127904, 30128047, 30128231, 30130240, 30131286, 30131645, 30132708 -30132989, 30133841, 30134746, 30135396, 30135731, 30135942, 30136102 -30136346, 30137792, 30138948, 30139392, 30141240, 30142527, 30142907 -30143470, 30143593, 30146593, 30146969, 30147195, 30147307, 30147308 -30147473, 30147928, 30148343, 30148929, 30148999, 30149035, 30149658 -30150606, 30150710, 30153552, 30153885, 30154633, 30155241, 30155320 -30155489, 30155814, 30155837, 30155999, 30156569, 30157526, 30158313 -30159329, 30159511, 30159536, 30159752, 30159760, 30160025, 30160625 -30161094, 30163243, 30164714, 30165493, 30165503, 30165876, 30165897 -30166352, 30167787, 30169254, 30170104, 30172925, 30173113, 30173370 -30173556, 30174102, 30174394, 30174401, 30175180, 30175291, 30175587 -30177597, 30178250, 30178839, 30178990, 30179012, 30179038, 30179644 -30180208, 30180643, 30181756, 30182498, 30183367, 30183696, 30183715 -30183920, 30184102, 30185852, 30186319, 30186476, 30186706, 30187627 -30187866, 30188631, 30189516, 30189535, 30190090, 30191274, 30192691 -30192729, 30192853, 30193165, 30193262, 30193505, 30193506, 30193584 -30193736, 30194612, 30194710, 30194972, 30195667, 30195668, 30195684 -30196195, 30196358, 30196629, 30198239, 30198598, 30198861, 30198905 -30199890, 30200034, 30200132, 30200237, 30200680, 30200758, 30202349 -30202388, 30203929, 30204042, 30204542, 30206220, 30206493, 30206675 -30207473, 30207519, 30208327, 30208690, 30208723, 30209222, 30209736 -30210429, 30210753, 30210884, 30211567, 30213031, 30213540, 30214769 -30214826, 30215130, 30215302, 30215351, 30217206, 30217562, 30217982 -30218044, 30218317, 30219222, 30220932, 30221115, 30221237, 30221298 -30222512, 30222669, 30222975, 30223712, 30223847, 30224544, 30224650 -30224725, 30224868, 30224950, 30225265, 30225439, 30225443, 30225718 -30225837, 30225844, 30226244, 30227400, 30228422, 30228567, 30229030 -30229683, 30232638, 30233105, 30233934, 30234132, 30234227, 30235878 -30235919, 30235979, 30236092, 30236554, 30236746, 30236964, 30237477 -30237640, 30238211, 30238715, 30239480, 30240010, 30240547, 30240858 -30240930, 30240972, 30241567, 30241807, 30241829, 30241920, 30242120 -30242724, 30243216, 30244340, 30244831, 30246053, 30246179, 30247305 -30248520, 30248531, 30248564, 30249432, 30249738, 30249927, 30251003 -30252005, 30252098, 30252156, 30252458, 30252977, 30253035, 30253090 -30253608, 30253705, 30253835, 30254206, 30254525, 30254576, 30254726 -30255143, 30255528, 30256542, 30257412, 30257908, 30259120, 30259469 -30260523, 30260595, 30263377, 30264405, 30265523, 30265608, 30265615 -30265703, 30266791, 30267155, 30269428, 30269748, 30270647, 30270744 -30271114, 30272329, 30274090, 30274188, 30274324, 30274662, 30275548 -30275569, 30275578, 30275784, 30276144, 30276243, 30277120, 30277451 -30277589, 30277648, 30277733, 30277887, 30278402, 30281428, 30281615 -30282501, 30282591, 30282918, 30283296, 30283577, 30283579, 30283581 -30283832, 30283932, 30284219, 30284369, 30284751, 30285026, 30285166 -30285251, 30285341, 30285457, 30285540, 30285843, 30286961, 30288343 -30288491, 30289074, 30289458, 30290700, 30291536, 30292305, 30293345 -30294267, 30294465, 30294671, 30294865, 30295110, 30295137, 30295549 -30295790, 30295808, 30297905, 30299367, 30299817, 30299934, 30300030 -30300342, 30300363, 30300523, 30300538, 30304037, 30305163, 30305264 -30305395, 30305568, 30305603, 30305880, 30307814, 30307883, 30308368 -30308578, 30308624, 30308772, 30308947, 30309098, 30309798, 30310195 -30311826, 30312094, 30312546, 30313749, 30313848, 30313989, 30314079 -30314198, 30314837, 30316667, 30316897, 30317005, 30317209, 30317397 -30318638, 30318943, 30319080, 30319099, 30320029, 30321076, 30321398 -30322980, 30323219, 30323658, 30323849, 30324180, 30324466, 30324649 -30325407, 30325786, 30326115, 30326882, 30327149, 30327810, 30328168 -30328209, 30328690, 30329209, 30329751, 30330123, 30331356, 30331759 -30332505, 30332893, 30334484, 30334563, 30335127, 30335832, 30335987 -30336032, 30336383, 30336530, 30336742, 30336996, 30337245, 30338434 -30338591, 30339049, 30339103, 30340540, 30341713, 30342371, 30342878 -30343370, 30344614, 30345201, 30345432, 30345809, 30345926, 30346330 -30346847, 30346867, 30347410, 30349714, 30350177, 30350543, 30352532 -30352581, 30352623, 30352715, 30355490, 30356060, 30356461, 30357463 -30357698, 30357897, 30358416, 30359614, 30360383, 30360653, 30361070 -30361635, 30362003, 30362850, 30363088, 30363193, 30363311, 30363716 -30364329, 30364481, 30364613, 30364835, 30365745, 30367193, 30368048 -30368482, 30368534, 30368668, 30368917, 30371264, 30371623, 30371909 -30372081, 30373419, 30373541, 30373550, 30374345, 30374570, 30374739 -30375109, 30376986, 30377347, 30377692, 30380511, 30380907, 30381207 -30381525, 30381614, 30382646, 30382982, 30383286, 30384121, 30384152 -30387628, 30387666, 30388853, 30389229, 30389414, 30389507, 30389821 -30390279, 30390635, 30391272, 30392011, 30392870, 30392987, 30393110 -30393653, 30393944, 30394509, 30394738, 30394974, 30395132, 30396120 -30396946, 30396974, 30397100, 30398099, 30398251, 30398257, 30398422 -30398770, 30399906, 30402386, 30403284, 30403412, 30403763, 30403881 -30403902, 30403989, 30404117, 30404153, 30404357, 30404639, 30406227 -30406709, 30408515, 30408808, 30409207, 30409339, 30409472, 30409590 -30412188, 30412772, 30412863, 30412885, 30412921, 30413137, 30413294 -30414491, 30414679, 30414714, 30416034, 30416603, 30417648, 30417732 -30418926, 30419024, 30419450, 30420105, 30420452, 30421009, 30421026 -30421204, 30421439, 30421476, 30421706, 30422487, 30423135, 30423218 -30424347, 30430921, 30431274, 30431504, 30431582, 30431698, 30431703 -30431717, 30431867, 30433177, 30434793, 30436399, 30437003, 30437149 -30438224, 30439985, 30440651, 30440712, 30441277, 30441687, 30441959 -30442266, 30442749, 30442805, 30442874, 30442884, 30443393, 30446436 -30446583, 30446820, 30447060, 30447498, 30447589, 30447994, 30448182 -30448348, 30448355, 30448917, 30449194, 30449837, 30450787, 30453442 -30454090, 30455427, 30457633, 30457697, 30458568, 30458593, 30460095 -30460558, 30460842, 30460922, 30461123, 30461458, 30463938, 30464250 -30464655, 30466081, 30466214, 30469777, 30470402, 30470947, 30472891 -30473634, 30474167, 30474774, 30475041, 30475115, 30475813, 30476768 -30477588, 30477685, 30477691, 30477767, 30479252, 30479647, 30479715 -30480872, 30483065, 30483140, 30483217, 30483521, 30484042, 30484623 -30484801, 30485255, 30486436, 30486896, 30487387, 30487697, 30489582 -30490014, 30490578, 30490671, 30492380, 30493331, 30493518, 30494259 -30494900, 30495035, 30495078, 30495133, 30495483, 30496957, 30497057 -30497120, 30497765, 30498824, 30500224, 30500297, 30500344, 30500582 -30501574, 30502415, 30503943, 30505029, 30505497, 30506794, 30506991 -30507032, 30507313, 30508100, 30509112, 30509277, 30510347, 30510527 -30510718, 30512690, 30513285, 30513353, 30513480, 30513848, 30515886 -30516868, 30517214, 30517516, 30517635, 30518349, 30518447, 30518923 -30519188, 30522285, 30522998, 30523137, 30523538, 30523601, 30523750 -30524736, 30527198, 30527275, 30528547, 30528637, 30528687, 30528704 -30528731, 30528935, 30529790, 30529915, 30529940, 30530585, 30532811 -30533132, 30533580, 30534351, 30534549, 30534662, 30534827, 30535905 -30536237, 30537403, 30537405, 30537533, 30537584, 30538141, 30538818 -30539519, 30539866, 30540109, 30540407, 30544247, 30544595, 30544629 -30545040, 30545281, 30545556, 30549255, 30549368, 30549637, 30549789 -30549881, 30551000, 30551123, 30554178, 30556326, 30556523, 30556581 -30556807, 30557386, 30557803, 30558561, 30559129, 30559218, 30559252 -30560365, 30560513, 30561404, 30561590, 30561737, 30564139, 30564343 -30564898, 30565004, 30565595, 30565805, 30566054, 30567372, 30568514 -30568896, 30570083, 30571306, 30572816, 30573236, 30573703, 30575243 -30575697, 30576112, 30576393, 30576853, 30577071, 30577591, 30578221 -30579051, 30580813, 30580887, 30581448, 30582221, 30582500, 30586493 -30587001, 30588738, 30589914, 30591028, 30591475, 30592859, 30593046 -30593104, 30593863, 30594167, 30595114, 30595408, 30595860, 30596024 -30596320, 30596488, 30596694, 30598682, 30598746, 30598919, 30599405 -30599407, 30600173, 30600184, 30602230, 30602828, 30603211, 30605215 -30605676, 30606345, 30606451, 30608583, 30609799, 30610406, 30610667 -30611603, 30612199, 30613937, 30613971, 30614411, 30616406, 30616738 -30617002, 30617626, 30618230, 30619138, 30619414, 30619525, 30619728 -30619787, 30620805, 30621255, 30621910, 30622528, 30622755, 30623138 -30623142, 30624243, 30624792, 30624864, 30624874, 30625121, 30628834 -30628899, 30629139, 30629643, 30629799, 30630391, 30630829, 30630930 -30631393, 30631523, 30633259, 30633938, 30634548, 30634559, 30635183 -30635302, 30635326, 30635360, 30637270, 30637319, 30637841, 30638712 -30640436, 30641541, 30641755, 30641900, 30644530, 30644766, 30644889 -30645590, 30645896, 30646077, 30647133, 30649310, 30650297, 30650404 -30651231, 30651570, 30651621, 30651674, 30652515, 30652595, 30652813 -30652853, 30654131, 30654558, 30655906, 30656839, 30657196, 30657365 -30657566, 30657624, 30657706, 30657875, 30657906, 30657940, 30658421 -30658533, 30658555, 30658702, 30659940, 30660412, 30661000, 30661939 -30662651, 30662736, 30663591, 30663646, 30664266, 30665036, 30665399 -30665720, 30668407, 30668754, 30670328, 30670369, 30670584, 30671720 -30671813, 30671958, 30674373, 30674959, 30676209, 30677633, 30679595 -30679771, 30679804, 30681085, 30681462, 30681516, 30681521, 30684902 -30685163, 30686017, 30686131, 30686809, 30687047, 30689557, 30689988 -30690686, 30691604, 30691731, 30691857, 30692462, 30692473, 30693791 -30694947, 30695670, 30696566, 30696821, 30698289, 30699770, 30702732 -30703610, 30704826, 30705448, 30708735, 30710506, 30710807, 30711370 -30712670, 30713133, 30714151, 30714715, 30716001, 30716863, 30718841 -30718862, 30719327, 30719419, 30720736, 30720844, 30722705, 30723671 -30724679, 30724881, 30726204, 30727701, 30727759, 30728196, 30729278 -30729604, 30729839, 30730026, 30732711, 30733270, 30733563, 30734242 -30734362, 30734707, 30735091, 30735153, 30735736, 30737970, 30739013 -30739876, 30740115, 30740250, 30740669, 30740997, 30741263, 30748411 -30748707, 30749181, 30749644, 30749722, 30750219, 30750991, 30751171 -30751521, 30751527, 30751639, 30751968, 30753432, 30755348, 30758836 -30758854, 30758943, 30760739, 30761871, 30761878, 30763272, 30763305 -30763639, 30763754, 30763970, 30764405, 30764663, 30764706, 30765486 -30765995, 30767277, 30768636, 30769312, 30770717, 30772069, 30773164 -30773696, 30773797, 30776416, 30776676, 30776929, 30777519, 30777759 -30778855, 30779240, 30781032, 30781041, 30781461, 30781970, 30782266 -30782300, 30782414, 30783395, 30783551, 30785101, 30786237, 30786641 -30786655, 30787365, 30788973, 30789904, 30790047, 30790441, 30801296 -30801510, 30803210, 30804646, 30806757, 30806984, 30807723, 30807888 -30808109, 30808869, 30809087, 30810680, 30810765, 30812574, 30814266 -30814285, 30815269, 30815495, 30815852, 30815994, 30816760, 30816938 -30819340, 30819629, 30820155, 30821297, 30822207, 30822502, 30822919 -30823744, 30825391, 30825419, 30825656, 30826474, 30827849, 30828205 -30828350, 30829779, 30829844, 30830555, 30832775, 30833454, 30834068 -30834110, 30834705, 30835184, 30835219, 30835853, 30836129, 30838605 -30839253, 30839451, 30839836, 30840793, 30841241, 30842277, 30843271 -30844839, 30845806, 30846063, 30846159, 30846782, 30847442, 30847871 -30848028, 30848097, 30848773, 30851448, 30851951, 30852954, 30855101 -30856358, 30857501, 30857721, 30858877, 30858919, 30860741, 30860803 -30861988, 30862285, 30863115, 30864607, 30865805, 30866141, 30866988 -30867685, 30868010, 30868186, 30869131, 30870439, 30870513, 30871716 -30871792, 30873527, 30874084, 30874270, 30874337, 30874660, 30879169 -30879708, 30880774, 30880913, 30881161, 30881407, 30883715, 30883785 -30883877, 30886188, 30887501, 30887777, 30887976, 30889443, 30889607 -30889723, 30890720, 30890971, 30891760, 30891792, 30893601, 30895426 -30895577, 30896620, 30896685, 30898366, 30898381, 30898748, 30898939 -30901889, 30902655, 30904672, 30905604, 30906274, 30906407, 30909596 -30909918, 30910264, 30910267, 30913399, 30914272, 30914674, 30915781 -30919403, 30919587, 30919691, 30919804, 30921136, 30922936, 30922996 -30923514, 30923517, 30923597, 30923940, 30925316, 30925419, 30925828 -30927440, 30927821, 30930149, 30930339, 30931068, 30931311, 30931981 -30932674, 30932923, 30936251, 30936831, 30936942, 30937340, 30937391 -30937410, 30938413, 30939307, 30939317, 30939934, 30940259, 30940382 -30940868, 30940869, 30941056, 30944643, 30945005, 30945772, 30946072 -30946141, 30946595, 30946768, 30946843, 30946876, 30946896, 30947294 -30950786, 30952104, 30952191, 30953157, 30953266, 30953836, 30954062 -30955702, 30956571, 30956647, 30957739, 30958493, 30960314, 30960356 -30960736, 30961566, 30964194, 30965111, 30965554, 30965649, 30967084 -30968737, 30968781, 30970518, 30972817, 30972841, 30972887, 30972947 -30972951, 30972959, 30972966, 30973085, 30973113, 30973127, 30973137 -30973143, 30973197, 30973698, 30973877, 30974207, 30974813, 30976603 -30977294, 30977411, 30978554, 30979701, 30980023, 30980115, 30980317 -30980733, 30981182, 30981240, 30985027, 30985906, 30986423, 30987088 -30987105, 30987243, 30987724, 30988444, 30989951, 30990034, 30992120 -30992330, 30992597, 30993198, 30993518, 30993604, 30994996, 30996945 -30996991, 30997375, 30997960, 30998035, 30998662, 30998759, 30998847 -31000312, 31001017, 31001455, 31001490, 31001859, 31002223, 31002923 -31003137, 31003659, 31004077, 31004719, 31004844, 31004871, 31005003 -31006011, 31006792, 31006953, 31008240, 31008858, 31008907, 31009032 -31009545, 31009590, 31009680, 31010218, 31010554, 31010976, 31011361 -31013127, 31013531, 31014323, 31015330, 31016413, 31019249, 31021068 -31021109, 31021157, 31021324, 31021542, 31021780, 31022858, 31025267 -31025520, 31025531, 31025859, 31026220, 31026591, 31026860, 31027747 -31028883, 31028986, 31029936, 31030898, 31031240, 31031955, 31032463 -31032904, 31032913, 31034794, 31035287, 31035916, 31037421, 31038220 -31038447, 31038817, 31039337, 31039627, 31039928, 31041540, 31042208 -31042337, 31043483, 31043630, 31043695, 31043747, 31044145, 31044460 -31044504, 31044951, 31045929, 31046188, 31046619, 31047022, 31047169 -31047697, 31047740, 31048025, 31048741, 31049215, 31049995, 31051056 -31051075, 31052735, 31052809, 31053669, 31054177, 31054874, 31055142 -31056909, 31057402, 31058548, 31061482, 31061504, 31062010, 31062645 -31063315, 31063380, 31063769, 31064025, 31065701, 31065838, 31066082 -31066250, 31066265, 31066554, 31067456, 31067483, 31067892, 31069059 -31070528, 31071080, 31073440, 31073586, 31074032, 31075323, 31075960 -31077117, 31077365, 31078391, 31078757, 31079204, 31080474, 31081558 -31082719, 31084778, 31084921, 31086467, 31086869, 31086954, 31087361 -31087679, 31088115, 31088341, 31089270, 31090262, 31091469, 31091868 -31092129, 31092233, 31092581, 31092921, 31094183, 31094228, 31094249 -31094374, 31094688, 31095972, 31096846, 31097760, 31097961, 31098661 -31098870, 31099312, 31099926, 31100172, 31101386, 31101840, 31103065 -31103804, 31104809, 31105896, 31106140, 31106577, 31107577, 31108603 -31108644, 31109506, 31110021, 31112088, 31112530, 31112972, 31113089 -31113177, 31113249, 31113426, 31114116, 31114265, 31114671, 31115201 -31115502, 31117282, 31118486, 31118702, 31118809, 31118844, 31119057 -31119846, 31120361, 31122876, 31124213, 31124363, 31124821, 31124914 -31125773, 31125849, 31125918, 31126053, 31126058, 31127043, 31127457 -31127961, 31127968, 31127969, 31129851, 31130156, 31132732, 31134430 -31137765, 31138106, 31139643, 31140940, 31141792, 31142377, 31142749 -31142815, 31143146, 31143415, 31143870, 31145403, 31145804, 31146338 -31146727, 31151483, 31153120, 31153485, 31155305, 31155634, 31156301 -31156383, 31158151, 31158341, 31158380, 31159382, 31161861, 31162711 -31162915, 31163379, 31165038, 31165577, 31165722, 31168440, 31170082 -31171096, 31171147, 31171631, 31172207, 31172642, 31174836, 31175365 -31176502, 31177193, 31177204, 31177221, 31178051, 31178103, 31180519 -31181375, 31181380, 31182159, 31182451, 31182756, 31182793, 31183413 -31184230, 31185224, 31188038, 31188398, 31190624, 31191224, 31192039 -31193292, 31193511, 31193695, 31193745, 31193936, 31194264, 31195090 -31195430, 31195600, 31195838, 31196272, 31196310, 31200057, 31200845 -31201001, 31201366, 31201611, 31202536, 31204412, 31204878, 31205834 -31206070, 31206201, 31207446, 31208287, 31213034, 31214119, 31214928 -31215422, 31215438, 31215854, 31216823, 31216995, 31217946, 31218837 -31218904, 31219047, 31219975, 31220188, 31220549, 31220837, 31220881 -31220912, 31221454, 31222780, 31223382, 31225538, 31226448, 31228670 -31230775, 31233170, 31234765, 31234790, 31234983, 31235797, 31236624 -31240626, 31242319, 31242976, 31244968, 31247532, 31247838, 31248496 -31249008, 31249406, 31249696, 31250120, 31250152, 31250221, 31252659 -31254297, 31254535, 31254929, 31255369, 31255869, 31256383, 31257740 -31257826, 31258101, 31258344, 31258697, 31258995, 31260692, 31261467 -31261641, 31262275, 31265651, 31265773, 31268557, 31270711, 31270847 -31271032, 31274074, 31281708, 31287741, 31287871, 31289115, 31290017 -31290300, 31292298, 31293484, 31293867, 31298871, 31301460, 31303032 -31304573, 31304945, 31305114, 31305309, 31305624, 31306248, 31306261 -31306867, 31306927, 31307715, 31309379, 31309867, 31310564, 31310624 -31311830, 31312450, 31312976, 31313117, 31313177, 31313214, 31313444 -31313812, 31314323, 31314885, 31315495, 31315876, 31316250, 31317032 -31321092, 31322720, 31323383, 31325584, 31326320, 31326608, 31326977 -31326998, 31327046, 31327259, 31327278, 31327349, 31327391, 31327896 -31331354, 31331372, 31333156, 31334606, 31334961, 31335037, 31335142 -31336298, 31338249, 31338673, 31338686, 31338769, 31339457, 31339643 -31339744, 31341138, 31341746, 31343110, 31344046, 31344097, 31348711 -31348922, 31350348, 31353098, 31353610, 31355339, 31356601, 31357581 -31357737, 31358308, 31358511, 31359215, 31359366, 31360146, 31360155 -31360323, 31360469, 31360529, 31362408, 31362692, 31364001, 31364383 -31366716, 31367188, 31367364, 31368027, 31369444, 31372498, 31373825 -31373837, 31373843, 31374283, 31374449, 31374738, 31375865, 31376011 -31376708, 31377129, 31377206, 31377487, 31377808, 31377936, 31380443 -31381701, 31383049, 31383396, 31383464, 31383814, 31386394, 31386696 -31387033, 31387426, 31387443, 31388201, 31388288, 31390936, 31390955 -31391991, 31393600, 31393991, 31394341, 31394347, 31394365, 31394544 -31395247, 31396027, 31396609, 31396695, 31396980, 31398617, 31398663 -31398761, 31399131, 31399883, 31400754, 31401831, 31402078, 31402598 -31403177, 31403565, 31404014, 31404130, 31404263, 31404487, 31405300 -31408636, 31409483, 31409912, 31409964, 31410289, 31411163, 31412209 -31414023, 31414524, 31415324, 31416250, 31417007, 31417192, 31417336 -31417844, 31417990, 31418442, 31419363, 31420295, 31420316, 31420320 -31421316, 31422440, 31422620, 31423645, 31424838, 31425167, 31425761 -31425800, 31429501, 31429590, 31429770, 31429784, 31429844, 31429971 -31430722, 31430735, 31430910, 31431005, 31431326, 31431771, 31431964 -31431971, 31431973, 31431975, 31431986, 31433092, 31433579, 31433749 -31434421, 31434805, 31434870, 31435163, 31435308, 31435735, 31437030 -31440426, 31440813, 31441916, 31441920, 31442332, 31442714, 31444353 -31444516, 31445356, 31446431, 31447733, 31448680, 31449354, 31450392 -31450653, 31451019, 31453585, 31454428, 31454972, 31454988, 31455597 -31456857, 31458049, 31459231, 31459242, 31459369, 31462082, 31463613 -31464165, 31465389, 31466433, 31468060, 31468705, 31469001, 31471441 -31471856, 31472077, 31474315, 31475378, 31475635, 31476093, 31476603 -31476701, 31476736, 31477424, 31477695, 31479072, 31479075, 31479106 -31479272, 31479772, 31481750, 31483949, 31484385, 31484603, 31485340 -31485386, 31485507, 31486061, 31486557, 31487441, 31487491, 31487826 -31487844, 31488464, 31489032, 31489137, 31489590, 31490604, 31491634 -31492171, 31492191, 31492588, 31492655, 31492856, 31493153, 31493840 -31494095, 31494264, 31494794, 31495254, 31495564, 31496174, 31498559 -31499370, 31499700, 31500699, 31500719, 31500971, 31501139, 31502301 -31503349, 31503674, 31503934, 31505088, 31506095, 31507107, 31508229 -31508712, 31509279, 31510891, 31510910, 31511142, 31511519, 31511940 -31512044, 31512262, 31513011, 31515869, 31515879, 31515911, 31515929 -31516164, 31516184, 31516255, 31516265, 31517502, 31523548, 31523578 -31523585, 31523646, 31523736, 31523836, 31525310, 31525783, 31526903 -31527103, 31527199, 31527381, 31528724, 31528962, 31529594, 31529967 -31530985, 31530995, 31532084, 31532176, 31532339, 31533050, 31533113 -31533274, 31533817, 31533833, 31535073, 31535870, 31535955, 31536401 -31536731, 31537521, 31537736, 31538274, 31538363, 31538891, 31539566 -31541805, 31541864, 31541905, 31542347, 31542851, 31543810, 31544097 -31545477, 31546864, 31547220, 31547445, 31547480, 31548675, 31549221 -31549468, 31551142, 31552563, 31552615, 31552738, 31552755, 31553289 -31553674, 31553813, 31553968, 31555126, 31555173, 31555346, 31555539 -31555800, 31556950, 31557518, 31557663, 31558194, 31559079, 31559085 -31559415, 31559563, 31560592, 31561886, 31563138, 31564060, 31564795 -31567124, 31567403, 31567441, 31567719, 31568423, 31569057, 31569867 -31570054, 31570161, 31571415, 31571742, 31572006, 31572046, 31572267 -31573269, 31573457, 31574122, 31574150, 31574244, 31574267, 31575529 -31575649, 31575665, 31576738, 31577569, 31578202, 31578994, 31580079 -31580122, 31580374, 31580437, 31581627, 31584056, 31584555, 31584853 -31585351, 31585491, 31585789, 31586381, 31586862, 31588933, 31590826 -31591384, 31591400, 31591409, 31591421, 31595025, 31595632, 31597104 -31597727, 31598146, 31599363, 31599990, 31600023, 31600291, 31600894 -31601385, 31603199, 31605119, 31605737, 31606474, 31607937, 31608753 -31609974, 31610024, 31613838, 31616101, 31616104, 31617492, 31619276 -31620252, 31620748, 31620944, 31622250, 31623413, 31623463, 31625579 -31625618, 31625959, 31626438, 31626493, 31626528, 31626572, 31627587 -31628311, 31628753, 31629056, 31630551, 31630794, 31630946, 31631985 -31632273, 31632534, 31632605, 31632663, 31633224, 31634510, 31634805 -31635963, 31635980, 31637094, 31637607, 31637680, 31638398, 31638733 -31638943, 31640240, 31642556, 31642639, 31644775, 31647304, 31648120 -31648157, 31649819, 31649958, 31649962, 31650046, 31650202, 31652641 -31653080, 31653167, 31653634, 31653647, 31653758, 31653913, 31653916 -31653917, 31654116, 31654119, 31654122, 31654125, 31654133, 31655807 -31656263, 31657324, 31657462, 31657483, 31658464, 31658819, 31658943 -31659065, 31661865, 31661879, 31662143, 31662504, 31662625, 31662925 -31663189, 31663788, 31664399, 31666449, 31666684, 31667096, 31667180 -31667940, 31668033, 31668061, 31668065, 31668694, 31668872, 31669064 -31670014, 31670263, 31670353, 31671568, 31672605, 31673406, 31674380 -31675568, 31675852, 31675860, 31676941, 31677460, 31677479, 31678629 -31679900, 31680709, 31680985, 31682766, 31683044, 31683260, 31683311 -31683373, 31683708, 31684080, 31684494, 31685612, 31685882, 31686979 -31688127, 31688978, 31691030, 31691089, 31691480, 31695062, 31695693 -31696043, 31696577, 31696853, 31697741, 31699230, 31700234, 31701239 -31701910, 31703614, 31705704, 31706595, 31706956, 31707190, 31708133 -31708175, 31709647, 31709739, 31709777, 31711889, 31711997, 31712260 -31714645, 31715935, 31716873, 31717010, 31718000, 31718134, 31718346 -31718842, 31719167, 31720839, 31720942, 31721557, 31721863, 31721880 -31722558, 31722646, 31723226, 31723323, 31723651, 31727229, 31727560 -31728160, 31728440, 31728444, 31728447, 31728477, 31728486, 31728858 -31730485, 31730766, 31732311, 31734012, 31734017, 31734583, 31735662 -31736095, 31737059, 31737603, 31739198, 31739891, 31740252, 31741938 -31743771, 31745130, 31745233, 31745528, 31746054, 31747706, 31747818 -31747935, 31747989, 31748000, 31748182, 31748944, 31750577, 31750581 -31752492, 31752502, 31752633, 31753202, 31753425, 31753478, 31753692 -31754546, 31754887, 31755245, 31756415, 31756465, 31756568, 31756650 -31757357, 31757775, 31757824, 31758083, 31758344, 31758846, 31758939 -31758960, 31759565, 31760592, 31760738, 31761510, 31762819, 31763030 -31763707, 31763905, 31764089, 31764239, 31764866, 31764913, 31765068 -31765246, 31765257, 31765296, 31766499, 31766534, 31766675, 31766696 -31767204, 31767237, 31767598, 31767852, 31768490, 31768497, 31768505 -31769373, 31769530, 31770289, 31771302, 31771370, 31771410, 31771468 -31771836, 31772002, 31772070, 31773582, 31775101, 31776121, 31776785 -31776994, 31777410, 31777489, 31779833, 31781897, 31783422, 31783451 -31783782, 31783985, 31785445, 31785572, 31786282, 31786838, 31787057 -31787655, 31788104, 31788594, 31788704, 31788761, 31788785, 31790500 -31790757, 31792465, 31792615, 31793713, 31794336, 31794882, 31795231 -31796208, 31796277, 31796882, 31798001, 31798669, 31798702, 31798742 -31799858, 31800757, 31804838, 31805812, 31807179, 31807516, 31809510 -31810213, 31812824, 31815099, 31816158, 31816343, 31816631, 31820632 -31820662, 31820859, 31820926, 31821129, 31821835, 31822026, 31822951 -31823051, 31824504, 31824934, 31825324, 31825410, 31827339, 31827605 -31827912, 31828378, 31828999, 31829366, 31829617, 31829639, 31831950 -31832785, 31832901, 31833172, 31833585, 31833948, 31834191, 31834871 -31835805, 31835854, 31836113, 31836454, 31839038, 31839779, 31839888 -31840180, 31840490, 31840516, 31840992, 31841696, 31842545, 31843028 -31843462, 31843476, 31845092, 31845403, 31845803, 31845955, 31846454 -31847489, 31847541, 31848331, 31848365, 31848391, 31848903, 31849859 -31850132, 31850227, 31851383, 31851449, 31852482, 31852574, 31854285 -31854692, 31855307, 31855526, 31855996, 31858580, 31858621, 31858833 -31859067, 31859143, 31860193, 31860406, 31862359, 31862593, 31862611 -31863118, 31863890, 31864947, 31866141, 31866159, 31867037, 31867351 -31869601, 31869944, 31869954, 31869966, 31870010, 31870150, 31870164 -31870190, 31870196, 31871384, 31871692, 31872230, 31873155, 31875140 -31876138, 31876368, 31878256, 31878314, 31880154, 31881527, 31883124 -31883343, 31883739, 31883845, 31886547, 31886695, 31886745, 31887130 -31888148, 31888731, 31889222, 31890230, 31890516, 31892029, 31892856 -31895670, 31897786, 31897854, 31898193, 31898257, 31900585, 31902517 -31902662, 31903523, 31903786, 31903962, 31904739, 31904933, 31905033 -31907042, 31907137, 31907510, 31907565, 31907792, 31908345, 31908482 -31908750, 31909295, 31909807, 31913650, 31913839, 31914003, 31914943 -31915444, 31915968, 31916644, 31917378, 31917494, 31917856, 31919563 -31919952, 31921267, 31922161, 31922580, 31923463, 31925462, 31926203 -31926811, 31927510, 31927930, 31932196, 31934254, 31934301, 31935717 -31936588, 31938116, 31938288, 31939461, 31939486, 31940458, 31941148 -31942136, 31942144, 31942258, 31942274, 31942473, 31943497, 31943691 -31945038, 31945407, 31945659, 31945827, 31945928, 31946936, 31947732 -31947861, 31950244, 31950577, 31952046, 31952052, 31953394, 31953989 -31956113, 31956435, 31956920, 31957152, 31957564, 31957674, 31957683 -31958958, 31959253, 31960389, 31961578, 31961940, 31964519, 31965012 -31965542, 31968431, 31970188, 31971792, 31972615, 31972671, 31973203 -31974424, 31974597, 31974693, 31976303, 31977024, 31977257, 31980296 -31981745, 31981751, 31985494, 31985738, 31986808, 31986836, 31986905 -31988079, 31990386, 31991705, 31993795, 31996264, 31997457, 31998181 -31998861, 31999453, 32001851, 32002411, 32003551, 32004148, 32004977 -32005046, 32005048, 32005053, 32005215, 32006467, 32006703, 32006824 -32007076, 32007698, 32008408, 32008586, 32008819, 32009754, 32010593 -32010707, 32011107, 32011888, 32012788, 32012975, 32013403, 32014520 -32015820, 32016884, 32017301, 32017422, 32017671, 32018632, 32022223 -32022711, 32025328, 32028155, 32028269, 32032653, 32032733, 32032887 -32033795, 32034766, 32035268, 32035536, 32035899, 32035902, 32036045 -32037237, 32037962, 32038054, 32038844, 32038996, 32040940, 32042256 -32042352, 32042706, 32044533, 32045377, 32046125, 32046587, 32047226 -32048412, 32048921, 32050048, 32051896, 32052587, 32054806, 32057639 -32058260, 32060164, 32060577, 32061018, 32061146, 32061648, 32062227 -32064682, 32066061, 32067130, 32067356, 32067675, 32068110, 32068187 -32069160, 32069696, 32069834, 32071582, 32072944, 32073710, 32074450 -32075009, 32075020, 32075130, 32076561, 32077318, 32079573, 32079739 -32080081, 32080655, 32082098, 32087331, 32087956, 32088132, 32088478 -32089051, 32089820, 32090518, 32090725, 32093558, 32094825, 32095097 -32095380, 32097387, 32097589, 32097604, 32097882, 32097962, 32099153 -32099539, 32101305, 32103383, 32103427, 32104324, 32104402, 32104610 -32105135, 32105239, 32105412, 32107505, 32107621, 32108094, 32108115 -32108566, 32108576, 32109384, 32109796, 32112798, 32112822, 32113113 -32113791, 32114572, 32115642, 32117115, 32117253, 32117490, 32118727 -32119339, 32120283, 32120453, 32121014, 32121326, 32121673, 32121885 -32122574, 32123331, 32124176, 32124570, 32124594, 32124607, 32125142 -32127227, 32127448, 32129659, 32130083, 32130485, 32130504, 32131010 -32131401, 32133039, 32138478, 32138782, 32139432, 32139659, 32140800 -32142788, 32143492, 32143562, 32144917, 32147340, 32148419, 32150818 -32150854, 32151098, 32152341, 32153396, 32153619, 32153909, 32156194 -32157050, 32157078, 32161260, 32162391, 32164053, 32165367, 32165759 -32165814, 32165887, 32167592, 32167923, 32169151, 32170162, 32170190 -32171622, 32171791, 32172050, 32172773, 32172777, 32173142, 32173543 -32174321, 32174405, 32174571, 32175329, 32175780, 32177701, 32177869 -32179306, 32182097, 32182783, 32184855, 32186983, 32187775, 32189869 -32189952, 32190132, 32190190, 32190284, 32190573, 32191427, 32191451 -32193431, 32195333, 32196492, 32196738, 32197147, 32200524, 32201743 -32201936, 32203068, 32203354, 32207088, 32207920, 32208144, 32208346 -32208691, 32209784, 32210660, 32212041, 32212635, 32212916, 32213376 -32214021, 32214195, 32214743, 32214782, 32215991, 32216027, 32218369 -32218395, 32218498, 32218552, 32219179, 32219318, 32219988, 32220017 -32221141, 32222473, 32223669, 32224583, 32225353, 32225899, 32227352 -32228188, 32229431, 32229919, 32230213, 32230775, 32231049, 32234161 -32236601, 32236798, 32237489, 32238935, 32239730, 32241889, 32243814 -32243882, 32243985, 32244187, 32245711, 32245850, 32246090, 32248131 -32248405, 32248649, 32249207, 32249640, 32249674, 32250232, 32250238 -32251364, 32252036, 32252213, 32252294, 32254399, 32255029, 32255073 -32258021, 32259063, 32259322, 32259535, 32259785, 32260010, 32260290 -32263923, 32266406, 32266906, 32267171, 32267610, 32268669, 32274403 -32277643, 32279351, 32284241, 32284325, 32284485, 32284725, 32285086 -32285717, 32285789, 32287797, 32289552, 32289858, 32290313, 32290399 -32290949, 32291114, 32291139, 32292180, 32293615, 32294566, 32294851 -32296259, 32296941, 32300098, 32301856, 32302561, 32304293, 32304712 -32305792, 32307586, 32309046, 32309723, 32312131, 32312586, 32316070 -32316252, 32317012, 32318528, 32318820, 32318914, 32319410, 32321317 -32321319, 32321765, 32322738, 32323488, 32323600, 32323816, 32325574 -32327201, 32327208, 32329914, 32330269, 32330540, 32331889, 32332107 -32334745, 32335769, 32338476, 32338736, 32339801, 32341260, 32343678 -32344099, 32344168, 32344199, 32345001, 32345178, 32345272, 32345785 -32346733, 32353343, 32355765, 32355912, 32356609, 32356628, 32357412 -32357665, 32359044, 32361175, 32362698, 32363549, 32364147, 32366461 -32366536, 32367151, 32368789, 32368792, 32375493, 32376872, 32379140 -32379775, 32381403, 32385141, 32385832, 32386482, 32386683, 32386877 -32387555, 32387818, 32388247, 32391021, 32398714, 32401086, 32402243 -32404638, 32405239, 32409344, 32409942, 32410175, 32413042, 32413512 -32414996, 32415846, 32415989, 32416652, 32416655, 32417227, 32417242 -32417274, 32417438, 32417632, 32419774, 32421958, 32425097, 32425124 -32425194, 32426315, 32427173, 32431290, 32431413, 32432078, 32435911 -32436342, 32436721, 32436757, 32437538, 32442404, 32443087, 32443531 -32444159, 32446565, 32449622, 32450344, 32453583, 32455219, 32455650 -32459153, 32460136, 32464584, 32465853, 32465894, 32466474, 32467812 -32469004, 32469225, 32471251, 32471346, 32471642, 32472589, 32473465 -32474926, 32474997, 32480419, 32480541, 32484945, 32485859, 32486528 -32489206, 32490128, 32490416, 32492343, 32492422, 32492452, 32495545 -32495572, 32497756, 32498459, 32499155, 32500117, 32501930, 32504340 -32504786, 32505009, 32505634, 32507542, 32509584, 32509606, 32512145 -32512918, 32516336, 32517405, 32518029, 32518679, 32520691, 32520994 -32522300, 32523206, 32523750, 32531627, 32533019, 32533225, 32534925 -32535106, 32538436, 32539300, 32539322, 32541049, 32542641, 32544784 -32549351, 32550589, 32550751, 32551177, 32552602, 32553241, 32555120 -32556891, 32559543, 32563106, 32563940, 32567750, 32567788, 32568163 -32569745, 32573703, 32573942, 32576508, 32578616, 32580082, 32587472 -32589990, 32593845, 32596355, 32596705, 32598406, 32602344, 32602735 -32603152, 32606489, 32609886, 32613788, 32615310, 32615776, 32616678 -32619298, 32619327, 32620919, 32622612, 32627140, 32628131, 32628221 -32631787, 32646025, 32648248, 32652143, 32652573, 32653669, 32654962 -32655446, 32655691, 32656231, 32656275, 32659574, 32671481, 32676350 -32677702, 32686850, 32697781, 32698569, 32700989, 32704765, 32711741 -32712220, 32716726, 32718316, 32720458, 32725484, 32728984, 32738356 -32739966, 32740503, 32754845, 32758096, 32765738, 32784393, 32784403 -32786309, 32795712, 32810668, 32811069, 32811131, 32816003, 32817950 -32818019, 32858446, 32874995, 32881853, 32889434, 32892883, 32895105 -32900208, 32902635, 32936961, 32941509, 32996071, 33034103, 33048277 -33127032 -``` - -## Version 19\.0\.0\.0\.ru\-2021\-04\.rur\-2021\-04\.r1 - -Version 19\.0\.0\.0\.ru\-2021\-04\.rur\-2021\-04\.r1 includes the following: -+ Patch 32545013: DATABASE RELEASE UPDATE 19\.11\.0\.0\.0 -+ Patch 32399816: OJVM RELEASE UPDATE 19\.11\.0\.0\.0 -+ Patch 32327201: RDBMS \- DSTV36 UPDATE \- TZDATA2020E -+ Patch 29213893: DBMS\_STATS FAILING WITH ERROR ORA\-01422 WHEN GATHERING STATS FOR USER TABLE -+ Patch 28730253: SUPPORT NEW ERA REIWA FOR JAPANESE IMPERIAL CALENDAR -+ PreUpgrade Jar: preupgrade\_19\_cbuild\_10\_lf\.zip - -### Combined Patches for Version 19\.0\.0\.0\.ru\-2021\-04\.rur\-2021\-04\.r1, Released April 2021 - -Bugs fixed: - -``` -7391838, 8460502, 8476681, 14735102, 15931756, 16662822, 16664572 -17428816, 17468475, 18534283, 19080742, 19138896, 19697993, 20083476 -20313356, 20319830, 20479545, 20867658, 20922160, 21232786, 21245711 -21374587, 21528318, 21629064, 21639146, 21888352, 21965541, 22066547 -22252368, 22580355, 22729345, 22748979, 23020668, 23094775, 23294761 -23296836, 23606241, 23645975, 23734075, 23763462, 24356932, 24561942 -24596874, 24669730, 24687075, 24833686, 24957575, 24971456, 25030027 -25092651, 25093917, 25148135, 25404117, 25416731, 25560538, 25607406 -25607716, 25756945, 25792962, 25804387, 25804908, 25806201, 25809128 -25883179, 25905368, 25913778, 25986062, 25997810, 26001677, 26003708 -26108369, 26127355, 26173091, 26203132, 26280704, 26284288, 26352615 -26440142, 26476244, 26497655, 26499997, 26500553, 26577716, 26587659 -26611353, 26668264, 26716835, 26739322, 26777814, 26785852, 26789742 -26819036, 26860844, 26872233, 26897528, 26963540, 26978857, 27004798 -27004828, 27036163, 27044169, 27044246, 27063461, 27086374, 27101798 -27126122, 27126938, 27130348, 27166935, 27195575, 27195935, 27221350 -27222128, 27243840, 27244999, 27254335, 27260704, 27261477, 27302372 -27359766, 27359770, 27362994, 27369515, 27378053, 27392968, 27406105 -27411022, 27423500, 27439716, 27453490, 27458357, 27460010, 27489107 -27497101, 27572040, 27582210, 27589260, 27597359, 27604329, 27622946 -27629928, 27639208, 27658166, 27661222, 27666312, 27684864, 27692173 -27697886, 27700413, 27710072, 27729678, 27742354, 27745728, 27751111 -27760043, 27764052, 27786168, 27801144, 27828892, 27829722, 27841399 -27846298, 27873364, 27877830, 27880025, 27907898, 27917890, 27929509 -27934711, 27935464, 27941110, 27957203, 27957963, 27967484, 27998559 -28001632, 28007516, 28031385, 28052648, 28064977, 28072567, 28078186 -28092783, 28104176, 28109326, 28112563, 28125947, 28127569, 28129791 -28133903, 28138566, 28138847, 28144569, 28145995, 28156781, 28181021 -28185286, 28187837, 28189466, 28198802, 28204104, 28204262, 28205555 -28209985, 28210681, 28234255, 28263142, 28271258, 28271693, 28276054 -28279176, 28279456, 28294563, 28302580, 28313275, 28319114, 28322973 -28326928, 28338211, 28350595, 28370061, 28371123, 28373960, 28375383 -28379065, 28381939, 28383667, 28386259, 28387185, 28387574, 28390273 -28392179, 28395302, 28397317, 28402823, 28403019, 28406374, 28410431 -28414968, 28431445, 28432345, 28435333, 28436414, 28442896, 28454215 -28461789, 28463226, 28470673, 28475242, 28479352, 28482048, 28484299 -28489419, 28492006, 28498976, 28499269, 28502773, 28504631, 28505321 -28513333, 28521330, 28522750, 28523644, 28526715, 28530171, 28530697 -28534475, 28534493, 28535127, 28537481, 28538439, 28541606, 28542455 -28546290, 28547068, 28547926, 28558489, 28558645, 28561704, 28564479 -28565296, 28567417, 28567819, 28569897, 28570589, 28572165, 28572407 -28572533, 28572544, 28572667, 28572834, 28578945, 28587723, 28589194 -28589509, 28589644, 28592647, 28593682, 28594086, 28597221, 28598022 -28601957, 28602253, 28605066, 28606598, 28608211, 28612239, 28618343 -28620697, 28621543, 28622202, 28625580, 28625862, 28627033, 28628592 -28630381, 28632796, 28636532, 28639299, 28640772, 28642469, 28642551 -28642899, 28643583, 28643654, 28643718, 28644549, 28645570, 28646200 -28646939, 28649388, 28655209, 28657026, 28661333, 28661362, 28663289 -28663782, 28670402, 28672124, 28672457, 28673945, 28681153, 28682796 -28689483, 28690694, 28692103, 28692275, 28692282, 28693954, 28694639 -28694872, 28694877, 28696373, 28697526, 28698087, 28699321, 28700945 -28703812, 28704412, 28705231, 28707931, 28708400, 28709063, 28710385 -28710469, 28710663, 28710734, 28714461, 28715655, 28715727, 28717406 -28718469, 28719348, 28720204, 28720418, 28721497, 28722229, 28729900 -28730079, 28730253, 28734355, 28740708, 28740799, 28741374, 28742555 -28745367, 28747846, 28749853, 28751498, 28752923, 28755011, 28755084 -28755309, 28755846, 28757960, 28758722, 28760206, 28763291, 28765983 -28767240, 28769456, 28771022, 28771947, 28772390, 28772816, 28774416 -28776431, 28776811, 28777073, 28777214, 28778754, 28781599, 28781754 -28785273, 28785321, 28785531, 28788272, 28789531, 28789533, 28791576 -28791852, 28793062, 28794230, 28795551, 28795734, 28800508, 28802066 -28802734, 28804517, 28805242, 28806517, 28807247, 28808314, 28808652 -28808656, 28810381, 28811560, 28813317, 28813931, 28815123, 28815355 -28815557, 28816871, 28817449, 28818063, 28819640, 28820669, 28821847 -28824482, 28827682, 28831971, 28833912, 28835937, 28836716, 28837979 -28838385, 28844656, 28844738, 28845346, 28846759, 28847541, 28847572 -28849776, 28850084, 28851467, 28852325, 28854004, 28854733, 28855520 -28855922, 28857552, 28861861, 28862532, 28863263, 28863432, 28863487 -28865544, 28865569, 28867698, 28867992, 28870496, 28871040, 28872645 -28872829, 28873575, 28874416, 28875089, 28876253, 28876639, 28876926 -28877252, 28878865, 28881191, 28881848, 28882784, 28884931, 28887305 -28888083, 28888327, 28889389, 28889730, 28891941, 28892794, 28897123 -28897512, 28899663, 28900506, 28901126, 28902135, 28904380, 28905312 -28905390, 28905457, 28905615, 28907196, 28909769, 28909992, 28910498 -28910586, 28911140, 28912691, 28914144, 28915561, 28917080, 28918429 -28919145, 28921844, 28922227, 28922485, 28922532, 28922608, 28922767 -28925250, 28925460, 28925634, 28925880, 28927452, 28928462, 28930944 -28932914, 28933079, 28933158, 28935293, 28935956, 28936114, 28937717 -28938422, 28938698, 28940179, 28940281, 28940472, 28941901, 28942455 -28942694, 28945421, 28945994, 28946233, 28946574, 28948554, 28949888 -28950868, 28951332, 28951493, 28951533, 28952168, 28954762, 28955606 -28955883, 28956908, 28957260, 28957292, 28957723, 28958088, 28958094 -28959493, 28960863, 28962775, 28963036, 28965084, 28965095, 28965231 -28965376, 28966444, 28968211, 28968779, 28970122, 28974083, 28974999 -28977322, 28978664, 28980448, 28980910, 28981871, 28983095, 28983486 -28984313, 28985114, 28985272, 28985362, 28985478, 28986207, 28986231 -28986257, 28986326, 28986481, 28986696, 28988482, 28988864, 28989306 -28990681, 28993295, 28993353, 28994307, 28994542, 28994783, 28995287 -28996376, 28998369, 28999046, 29000000, 29001305, 29001888, 29002488 -29002784, 29002927, 29003207, 29003407, 29003617, 29003738, 29006318 -29006621, 29007321, 29007353, 29007775, 29008035, 29008669, 29009513 -29010126, 29010517, 29011936, 29012609, 29013475, 29013832, 29014076 -29014385, 29015118, 29016294, 29017265, 29018655, 29018680, 29019121 -29020423, 29021063, 29021352, 29022986, 29024028, 29024054, 29024448 -29024552, 29024732, 29024795, 29024876, 29026154, 29026582, 29026606 -29027456, 29027694, 29027933, 29027940, 29030184, 29030927, 29031575 -29031600, 29032234, 29032276, 29032457, 29032607, 29033052, 29033145 -29033164, 29033200, 29033280, 29033655, 29034587, 29036278, 29037290 -29038528, 29038728, 29039089, 29039510, 29040739, 29041739, 29041775 -29043554, 29043651, 29043725, 29044086, 29044763, 29044954, 29046482 -29047127, 29047850, 29048178, 29048289, 29048498, 29048605, 29048728 -29048792, 29048858, 29049673, 29050357, 29050560, 29050765, 29050886 -29051263, 29051702, 29051953, 29052726, 29052850, 29053783, 29053902 -29055644, 29056024, 29056270, 29056560, 29056767, 29056894, 29058476 -29059011, 29060216, 29061016, 29061959, 29062692, 29062848, 29062860 -29062868, 29110526, 29110783, 29110790, 29110797, 29110802, 29110805 -29111598, 29111631, 29112455, 29113282, 29113305, 29115794, 29115857 -29117337, 29117526, 29117642, 29118543, 29119077, 29119733, 29120223 -29122224, 29122254, 29122367, 29123297, 29123432, 29123444, 29123482 -29124104, 29124368, 29125036, 29125374, 29125380, 29125708, 29125786 -29126345, 29127957, 29128693, 29128935, 29129450, 29129476, 29129497 -29129691, 29129712, 29130219, 29131539, 29131772, 29132456, 29132869 -29132938, 29133470, 29134447, 29135383, 29135649, 29136111, 29138641 -29139070, 29139727, 29139761, 29139780, 29139956, 29141316, 29141341 -29141685, 29141886, 29142609, 29142667, 29143516, 29144995, 29145214 -29145730, 29146077, 29146157, 29146810, 29147849, 29148799, 29149170 -29149829, 29150338, 29151520, 29152357, 29152603, 29152752, 29154631 -29154636, 29154725, 29154829, 29155099, 29155208, 29157051, 29157389 -29158680, 29158899, 29158990, 29159216, 29159661, 29159909, 29159936 -29160174, 29160462, 29160824, 29161597, 29161923, 29162095, 29163073 -29163156, 29163415, 29163437, 29163524, 29163567, 29164376, 29164446 -29165682, 29167111, 29167342, 29167374, 29167940, 29168137, 29168219 -29168433, 29169073, 29169215, 29169540, 29169739, 29170232, 29170717 -29171683, 29171942, 29172618, 29172826, 29173140, 29173373, 29173618 -29173817, 29174004, 29174753, 29175638, 29175829, 29176318, 29177466 -29177543, 29177886, 29178385, 29179097, 29180313, 29180455, 29180559 -29180721, 29180893, 29181078, 29181153, 29181231, 29181568, 29181620 -29181743, 29181923, 29182019, 29182517, 29182901, 29182920, 29183298 -29183912, 29184297, 29184666, 29185193, 29186091, 29186456, 29186605 -29188255, 29189302, 29189307, 29189889, 29190235, 29190474, 29190663 -29190740, 29191541, 29191827, 29192419, 29192468, 29192685, 29193207 -29194205, 29194367, 29194493, 29194827, 29194981, 29195279, 29195337 -29195758, 29196151, 29196725, 29198092, 29198913, 29199163, 29199635 -29199733, 29200316, 29200700, 29201143, 29201494, 29201539, 29201695 -29201787, 29202104, 29202461, 29202850, 29203041, 29203122, 29203166 -29203227, 29203425, 29203443, 29203604, 29205281, 29205323, 29205419 -29205463, 29205767, 29205918, 29206109, 29206605, 29206631, 29207073 -29208260, 29208732, 29209545, 29210577, 29210610, 29210624, 29210683 -29211457, 29211724, 29212012, 29212433, 29212611, 29213320, 29213351 -29213613, 29213641, 29213775, 29213850, 29213879, 29213893, 29214561 -29214960, 29216312, 29216723, 29216746, 29216984, 29217294, 29217472 -29217828, 29217848, 29217856, 29218570, 29219205, 29219273, 29219627 -29220079, 29221248, 29221745, 29221891, 29221942, 29222031, 29222784 -29222892, 29223833, 29223859, 29223967, 29224065, 29224294, 29224605 -29224710, 29225076, 29225168, 29225758, 29225861, 29227602, 29228869 -29229164, 29229754, 29229839, 29229844, 29229955, 29230252, 29230565 -29231133, 29232117, 29232154, 29232449, 29232533, 29232653, 29233415 -29233810, 29233953, 29234123, 29235934, 29236573, 29237538, 29237575 -29237744, 29240307, 29240668, 29240759, 29241345, 29241651, 29242017 -29242561, 29242884, 29242906, 29243749, 29243958, 29244495, 29244766 -29244968, 29245063, 29245137, 29245160, 29246163, 29246337, 29247183 -29247415, 29247712, 29247906, 29248495, 29248552, 29248723, 29248835 -29248858, 29249289, 29249412, 29249583, 29249991, 29250059, 29250317 -29251259, 29251564, 29252510, 29253184, 29253871, 29254031, 29254623 -29254930, 29255178, 29255273, 29255431, 29255435, 29255616, 29255705 -29255718, 29255973, 29256426, 29259119, 29259320, 29260224, 29260407 -29260452, 29260956, 29261547, 29261548, 29261695, 29261906, 29262512 -29262887, 29265448, 29266248, 29266899, 29267292, 29268412, 29269171 -29269228, 29269825, 29270585, 29271019, 29273168, 29273360, 29273539 -29273570, 29273735, 29273812, 29273847, 29274428, 29274564, 29274627 -29275461, 29276272, 29277317, 29278218, 29278684, 29279658, 29279751 -29279854, 29281112, 29281527, 29281691, 29281796, 29282090, 29282233 -29282666, 29282898, 29285197, 29285453, 29285503, 29285621, 29285788 -29285956, 29286037, 29286220, 29286229, 29287130, 29287705, 29290110 -29290235, 29292232, 29292253, 29292378, 29292837, 29293072, 29293574 -29293806, 29294753, 29296257, 29297863, 29297915, 29298220, 29299049 -29299082, 29299830, 29299844, 29301463, 29301566, 29302565, 29302614 -29302963, 29303918, 29304314, 29304692, 29304781, 29304853, 29305093 -29306226, 29306713, 29307090, 29307109, 29307638, 29309698, 29311336 -29311528, 29311588, 29311927, 29312310, 29312672, 29312734, 29312753 -29312889, 29313347, 29313417, 29313525, 29314539, 29314636, 29314867 -29317756, 29318410, 29319441, 29320900, 29321489, 29321689, 29323946 -29323999, 29324568, 29324735, 29325087, 29325105, 29325257, 29325356 -29325497, 29325765, 29325993, 29326233, 29327044, 29327892, 29329042 -29329087, 29329675, 29329807, 29329848, 29330361, 29330791, 29331066 -29331209, 29331380, 29331493, 29332292, 29332395, 29332763, 29332771 -29333500, 29336843, 29336899, 29337294, 29337310, 29337742, 29338315 -29338348, 29338453, 29338780, 29338913, 29339101, 29339155, 29339299 -29340333, 29341209, 29341782, 29342099, 29343086, 29343156, 29343861 -29344541, 29345382, 29345937, 29346057, 29346138, 29346211, 29346943 -29347620, 29348176, 29348358, 29350052, 29350712, 29350762, 29350868 -29351044, 29351386, 29351662, 29351716, 29351735, 29351749, 29351771 -29351786, 29352298, 29352724, 29352867, 29352947, 29353271, 29353432 -29353718, 29353821, 29353960, 29355654, 29356547, 29356634, 29356704 -29356711, 29356752, 29356782, 29357821, 29358509, 29358828, 29360252 -29360285, 29360467, 29360672, 29360775, 29360911, 29360950, 29361319 -29361472, 29361801, 29362596, 29363151, 29364171, 29364177, 29366406 -29366818, 29366940, 29367019, 29367561, 29367971, 29368253, 29368310 -29368725, 29372069, 29372541, 29372562, 29373418, 29373588, 29374179 -29374604, 29374627, 29375355, 29375941, 29375984, 29376346, 29377804 -29377986, 29378029, 29378287, 29378834, 29378913, 29379299, 29379381 -29379750, 29379978, 29380527, 29381000, 29382296, 29382641, 29382784 -29382815, 29383695, 29384781, 29384854, 29384864, 29385339, 29385429 -29385652, 29385774, 29386502, 29386557, 29386635, 29386660, 29386835 -29387073, 29387274, 29387310, 29387337, 29388020, 29388072, 29388094 -29388524, 29388830, 29389408, 29389889, 29390011, 29390435, 29390785 -29391030, 29391237, 29391301, 29391438, 29391849, 29391925, 29392554 -29392966, 29393291, 29393649, 29394014, 29394140, 29394749, 29395657 -29396481, 29397841, 29397954, 29397996, 29398488, 29398863, 29399046 -29399100, 29399121, 29399336, 29399938, 29399959, 29402110, 29402131 -29404483, 29405012, 29405462, 29405651, 29405996, 29407488, 29407804 -29408853, 29409149, 29409455, 29410311, 29410834, 29411037, 29411427 -29411469, 29411931, 29412066, 29412269, 29413360, 29413382, 29413517 -29413544, 29413634, 29413956, 29415493, 29415774, 29416688, 29416700 -29417084, 29417113, 29417173, 29417719, 29417884, 29418165, 29418341 -29420254, 29420834, 29421059, 29423003, 29423016, 29423156, 29423227 -29423491, 29423826, 29424094, 29424999, 29426241, 29426320, 29428230 -29429017, 29429087, 29429264, 29429466, 29429566, 29429895, 29430524 -29430866, 29431192, 29431402, 29431485, 29431985, 29432176, 29434301 -29434869, 29435474, 29435652, 29435966, 29436454, 29436514, 29436522 -29436727, 29437029, 29437379, 29437594, 29437712, 29438150, 29438277 -29438736, 29439522, 29440651, 29441196, 29442400, 29442936, 29443187 -29443250, 29443559, 29444072, 29444282, 29444602, 29445548, 29446319 -29446669, 29448498, 29449477, 29449845, 29449852, 29450162, 29450193 -29450273, 29450421, 29450812, 29450936, 29451085, 29451386, 29452251 -29452576, 29452936, 29452953, 29454450, 29454978, 29455424, 29455773 -29456538, 29456714, 29457312, 29457319, 29457370, 29457502, 29457807 -29457978, 29458132, 29460252, 29461420, 29461791, 29461971, 29462594 -29462767, 29462957, 29463047, 29463528, 29463553, 29463798, 29464616 -29464779, 29465047, 29465177, 29466674, 29467622, 29469563, 29469565 -29470059, 29470205, 29470291, 29471633, 29471832, 29471857, 29471860 -29472618, 29473708, 29476473, 29476702, 29477015, 29481584, 29482021 -29483452, 29483532, 29483626, 29483672, 29483685, 29483712, 29483723 -29483771, 29485099, 29485731, 29485877, 29486181, 29486848, 29487150 -29487189, 29487407, 29488894, 29489436, 29489546, 29490256, 29491784 -29492127, 29492939, 29493122, 29493821, 29494245, 29494788, 29495057 -29495171, 29495684, 29497053, 29497311, 29497588, 29497696, 29497778 -29498198, 29500257, 29500826, 29500963, 29501218, 29502561, 29503543 -29503631, 29503827, 29504103, 29504492, 29504682, 29505225, 29505589 -29505668, 29506942, 29507270, 29507616, 29508681, 29509777, 29510278 -29511064, 29511611, 29511980, 29512125, 29512890, 29514479, 29515134 -29515240, 29515476, 29515766, 29515834, 29516300, 29516727, 29516766 -29517168, 29517443, 29517883, 29518604, 29518767, 29519131, 29521187 -29521688, 29521748, 29521862, 29522358, 29522561, 29522662, 29523055 -29523216, 29523511, 29524599, 29524985, 29525366, 29525467, 29525886 -29526966, 29527595, 29527610, 29528368, 29529147, 29529436, 29530440 -29530515, 29530812, 29530909, 29531654, 29531836, 29532112, 29532532 -29536342, 29536445, 29536794, 29537829, 29538631, 29539027, 29539413 -29540327, 29541517, 29541742, 29541769, 29541973, 29542084, 29542449 -29542474, 29542580, 29542643, 29543034, 29543956, 29544552, 29546817 -29547010, 29547867, 29548413, 29548427, 29548592, 29548687, 29548722 -29549040, 29549071, 29549104, 29549154, 29549730, 29550530, 29552402 -29552773, 29553141, 29554092, 29554351, 29555105, 29555239, 29557144 -29557261, 29557336, 29557556, 29558238, 29558452, 29558926, 29558975 -29559187, 29559395, 29559446, 29559908, 29559981, 29564592, 29564593 -29565611, 29579919, 29580394, 29580983, 29581771, 29584261, 29584693 -29586143, 29587299, 29587720, 29587765, 29588580, 29588732, 29589544 -29590666, 29591343, 29591641, 29592011, 29592215, 29592595, 29597536 -29597716, 29597754, 29598039, 29598040, 29598046, 29598226, 29598233 -29599008, 29599243, 29599300, 29599552, 29601461, 29602831, 29603460 -29603884, 29604002, 29604257, 29606261, 29607136, 29607797, 29608000 -29608023, 29609603, 29610506, 29611020, 29611991, 29614206, 29614931 -29614987, 29615824, 29616244, 29616414, 29618074, 29618190, 29620042 -29622936, 29623323, 29623592, 29624124, 29625065, 29625804, 29625876 -29626154, 29626732, 29628200, 29628647, 29629430, 29629650, 29629681 -29629745, 29631749, 29632095, 29632265, 29632611, 29633697, 29633753 -29633936, 29634643, 29635427, 29635717, 29635990, 29637362, 29637526 -29637560, 29638285, 29638928, 29641736, 29642451, 29643721, 29644426 -29644464, 29645167, 29645349, 29647176, 29647770, 29648928, 29649694 -29651183, 29651520, 29652809, 29653132, 29653246, 29655164, 29655668 -29656400, 29656819, 29656843, 29657399, 29657422, 29657744, 29657960 -29657973, 29658056, 29661028, 29661065, 29661722, 29663191, 29663368 -29663494, 29663601, 29663813, 29664087, 29664161, 29665168, 29665940 -29666451, 29667527, 29667994, 29668005, 29669413, 29670713, 29670782 -29671363, 29672507, 29675446, 29676089, 29676921, 29677051, 29677173 -29677733, 29677927, 29678217, 29679856, 29680700, 29681987, 29683039 -29683211, 29684518, 29685137, 29685276, 29687214, 29687220, 29687459 -29687718, 29687727, 29687763, 29688867, 29689145, 29689255, 29690795 -29692115, 29692694, 29693847, 29694869, 29695425, 29695821, 29695841 -29695964, 29695987, 29696242, 29696310, 29697928, 29700125, 29700460 -29700770, 29701720, 29701755, 29701937, 29703932, 29705793, 29706160 -29707099, 29707493, 29707896, 29708324, 29708353, 29708876, 29708915 -29710188, 29710858, 29713810, 29715220, 29715703, 29716029, 29716194 -29716227, 29716491, 29716602, 29716871, 29717659, 29717901, 29718198 -29719146, 29720133, 29720373, 29721418, 29721576, 29722026, 29722092 -29722167, 29722389, 29724497, 29724658, 29725425, 29725476, 29725781 -29726695, 29737941, 29738374, 29738400, 29739576, 29741319, 29741976 -29742223, 29742926, 29744225, 29744400, 29744637, 29745288, 29745624 -29746962, 29747493, 29747648, 29747653, 29748285, 29748325, 29748336 -29748513, 29749471, 29750673, 29751094, 29753244, 29754196, 29754951 -29755821, 29756274, 29756444, 29757099, 29757264, 29757651, 29757687 -29758203, 29758217, 29758661, 29761678, 29761837, 29761911, 29763158 -29764644, 29765035, 29765219, 29765347, 29765393, 29765493, 29766207 -29766435, 29766503, 29766679, 29768487, 29768899, 29769695, 29769901 -29770750, 29771032, 29771242, 29772514, 29772761, 29773197, 29773205 -29773459, 29773842, 29774362, 29775393, 29775473, 29779196, 29780140 -29782211, 29782284, 29782823, 29782866, 29783142, 29784106, 29785239 -29785251, 29785311, 29785544, 29785550, 29785831, 29787292, 29787766 -29789911, 29791152, 29791880, 29791916, 29792213, 29792433, 29793318 -29794174, 29794462, 29795712, 29795957, 29796335, 29796378, 29796916 -29797209, 29797726, 29801164, 29802382, 29802695, 29803948, 29804875 -29805368, 29805772, 29806390, 29806964, 29807964, 29809792, 29809837 -29810013, 29811616, 29812084, 29812489, 29813503, 29813650, 29813671 -29814995, 29815341, 29815713, 29816887, 29817278, 29817547, 29817784 -29818794, 29819753, 29820341, 29821130, 29821582, 29822714, 29825525 -29827647, 29827792, 29827852, 29828644, 29829339, 29831196, 29831404 -29831567, 29833406, 29833984, 29834506, 29836096, 29836424, 29838337 -29838485, 29838740, 29838773, 29839715, 29840619, 29841267, 29841687 -29842369, 29843238, 29843277, 29843692, 29843831, 29844131, 29844226 -29844275, 29845449, 29845530, 29845691, 29846126, 29846525, 29846645 -29846688, 29847627, 29848084, 29848849, 29849100, 29849139, 29850930 -29851020, 29851308, 29851733, 29853485, 29856420, 29856506, 29856859 -29856890, 29858121, 29858376, 29858420, 29859068, 29860022, 29860994 -29861075, 29864203, 29864261, 29865188, 29865590, 29865658, 29867728 -29868639, 29869052, 29869086, 29869149, 29869404, 29869887, 29869906 -29870065, 29870533, 29871098, 29871312, 29871360, 29872401, 29872937 -29872983, 29873206, 29873665, 29874090, 29874761, 29875200, 29875459 -29875565, 29876358, 29876989, 29877608, 29878076, 29881050, 29881478 -29881575, 29881643, 29881839, 29882427, 29882454, 29882729, 29884958 -29885182, 29885890, 29886809, 29887045, 29887111, 29888621, 29889184 -29889358, 29890740, 29891075, 29891853, 29891916, 29892388, 29892604 -29893132, 29893287, 29894021, 29896510, 29897418, 29897863, 29900203 -29900824, 29901419, 29901961, 29902299, 29902327, 29902330, 29902659 -29903190, 29903299, 29903357, 29903454, 29904002, 29906678, 29907942 -29908389, 29908639, 29908777, 29909658, 29910218, 29910402, 29912135 -29912286, 29913805, 29913966, 29914449, 29914544, 29915217, 29915848 -29916198, 29916975, 29919789, 29920025, 29920376, 29920804, 29921318 -29922225, 29922435, 29922461, 29923452, 29924147, 29924181, 29924479 -29926466, 29927756, 29928210, 29928340, 29928427, 29928564, 29930457 -29931956, 29932202, 29932310, 29932430, 29932780, 29932953, 29933718 -29934048, 29934052, 29934158, 29935685, 29937565, 29937655, 29937956 -29938225, 29939400, 29939795, 29940373, 29941062, 29942096, 29942275 -29942554, 29943670, 29943879, 29944035, 29944159, 29944660, 29944963 -29945645, 29946388, 29947145, 29947242, 29947428, 29948165, 29950018 -29950220, 29951620, 29951759, 29952700, 29956016, 29956222, 29957412 -29957493, 29958925, 29960325, 29960884, 29961353, 29961360, 29961609 -29961847, 29962160, 29962248, 29962834, 29962927, 29962939, 29965052 -29965207, 29965603, 29965888, 29966768, 29967223, 29968085, 29968703 -29969557, 29970081, 29970261, 29970298, 29970587, 29970861, 29971027 -29971481, 29971888, 29971936, 29971951, 29972134, 29972176, 29973012 -29989783, 29989845, 29990779, 29991257, 29993717, 29997326, 29997553 -29997937, 30000664, 30001105, 30001331, 30003187, 30004660, 30004856 -30006159, 30006472, 30006705, 30006985, 30007450, 30007536, 30007797 -30008125, 30008198, 30008214, 30008456, 30009710, 30012181, 30013535 -30014200, 30015070, 30017836, 30018017, 30018903, 30019864, 30021830 -30024618, 30025814, 30026016, 30026596, 30027614, 30027649, 30028182 -30028599, 30028649, 30029519, 30029806, 30031027, 30032233, 30032376 -30032484, 30033040, 30033547, 30034456, 30035598, 30036258, 30038392 -30039800, 30039959, 30040157, 30040511, 30041501, 30041514, 30042490 -30043398, 30043610, 30043930, 30044108, 30044507, 30045242, 30045273 -30045389, 30045484, 30045983, 30046497, 30047510, 30047531, 30047702 -30047765, 30047931, 30048688, 30049966, 30051176, 30051783, 30051804 -30052740, 30052928, 30053036, 30053501, 30053748, 30054980, 30056058 -30057718, 30057799, 30058149, 30058453, 30059106, 30059109, 30059821 -30060267, 30060330, 30062364, 30062429, 30062819, 30064268, 30066352 -30067565, 30068384, 30068792, 30068871, 30070064, 30071446, 30072018 -30072905, 30073314, 30073422, 30073744, 30074250, 30074296, 30074349 -30074469, 30074472, 30074820, 30075037, 30076058, 30076197, 30076253 -30076604, 30078675, 30078934, 30079949, 30080111, 30080266, 30081546 -30081580, 30082145, 30083100, 30083216, 30083488, 30083807, 30084971 -30085897, 30086596, 30086992, 30087165, 30087509, 30088229, 30088421 -30090568, 30092254, 30092280, 30092859, 30094929, 30094948, 30095591 -30095952, 30097092, 30097115, 30098251, 30099302, 30099420, 30099454 -30100354, 30101090, 30101186, 30101847, 30102774, 30103551, 30103553 -30104348, 30104378, 30104555, 30105458, 30106748, 30106901, 30108012 -30109365, 30110224, 30110370, 30110518, 30114477, 30114489, 30114534 -30116085, 30116203, 30116753, 30116854, 30117209, 30117335, 30117469 -30117593, 30118261, 30118279, 30120608, 30122523, 30122583, 30123138 -30125765, 30126145, 30126470, 30127145, 30127522, 30127805, 30127904 -30128047, 30128231, 30130240, 30131286, 30131645, 30132708, 30132989 -30133841, 30134746, 30135396, 30135731, 30135942, 30136102, 30136346 -30137792, 30139392, 30141240, 30142907, 30143470, 30143593, 30146593 -30146969, 30147195, 30147307, 30147473, 30147928, 30148929, 30148999 -30149035, 30149658, 30150606, 30150710, 30153552, 30153885, 30154633 -30155241, 30155320, 30155489, 30155814, 30155837, 30155999, 30156569 -30157526, 30158313, 30159329, 30159511, 30159536, 30159752, 30159760 -30160025, 30160625, 30161094, 30163243, 30164714, 30165493, 30165503 -30165876, 30165897, 30166352, 30167787, 30169254, 30170104, 30172925 -30173113, 30173370, 30173556, 30174394, 30174401, 30175180, 30175291 -30175587, 30177597, 30178250, 30178839, 30178990, 30179038, 30179644 -30180208, 30180643, 30181756, 30182498, 30183367, 30183696, 30183715 -30183920, 30184102, 30185852, 30186319, 30186476, 30186706, 30187627 -30187866, 30188631, 30189516, 30189535, 30190090, 30191274, 30192691 -30192729, 30192853, 30193165, 30193262, 30193505, 30193506, 30193584 -30193736, 30194612, 30194710, 30194972, 30195667, 30195668, 30195684 -30196195, 30196358, 30196629, 30198239, 30198598, 30198861, 30198905 -30199890, 30200034, 30200132, 30200237, 30200680, 30200758, 30202349 -30202388, 30203929, 30204042, 30204542, 30206220, 30206493, 30206675 -30207473, 30207519, 30208327, 30208690, 30208723, 30209222, 30209736 -30210429, 30210753, 30210884, 30211567, 30213031, 30213540, 30214769 -30214826, 30215130, 30215302, 30215351, 30217206, 30217562, 30217982 -30218044, 30218317, 30219222, 30220932, 30221237, 30221298, 30222512 -30222669, 30222975, 30223712, 30223847, 30224544, 30224650, 30224725 -30224868, 30224950, 30225265, 30225439, 30225443, 30225718, 30225837 -30225844, 30226244, 30227400, 30228422, 30228567, 30229030, 30229683 -30232638, 30233105, 30233934, 30234132, 30234227, 30235878, 30235919 -30235979, 30236092, 30236554, 30236964, 30237477, 30237640, 30238211 -30238715, 30239480, 30240010, 30240547, 30240858, 30240930, 30240972 -30241567, 30241807, 30241829, 30241920, 30242120, 30242724, 30243216 -30244340, 30244831, 30246053, 30246179, 30247305, 30248520, 30248531 -30248564, 30249432, 30249738, 30249927, 30251003, 30252005, 30252098 -30252156, 30252458, 30252977, 30253035, 30253090, 30253608, 30253705 -30253835, 30254206, 30254525, 30254576, 30254726, 30255143, 30255528 -30256542, 30257412, 30257908, 30259120, 30259469, 30260523, 30260595 -30263377, 30264405, 30265523, 30265608, 30265615, 30265703, 30266791 -30267155, 30269428, 30269748, 30270647, 30270744, 30271114, 30272329 -30274090, 30274188, 30274324, 30274662, 30275548, 30275569, 30275578 -30275784, 30276144, 30276243, 30277120, 30277451, 30277589, 30277648 -30277733, 30277887, 30278402, 30281428, 30281615, 30282501, 30282591 -30282918, 30283296, 30283577, 30283579, 30283581, 30283932, 30284219 -30284369, 30285026, 30285166, 30285251, 30285341, 30285457, 30285540 -30285843, 30286961, 30288343, 30288491, 30289074, 30289458, 30291536 -30292305, 30293345, 30294267, 30294465, 30294671, 30294865, 30295110 -30295137, 30295549, 30295790, 30295808, 30297905, 30299367, 30299817 -30299934, 30300030, 30300342, 30300363, 30300523, 30300538, 30304037 -30305264, 30305395, 30305568, 30305880, 30307814, 30307883, 30308368 -30308624, 30308772, 30308947, 30309098, 30309798, 30311826, 30312094 -30312546, 30313749, 30313848, 30313989, 30314079, 30314198, 30314837 -30316667, 30316897, 30317005, 30317209, 30317397, 30318638, 30318943 -30319080, 30319099, 30320029, 30321076, 30321398, 30322980, 30323658 -30323849, 30324180, 30324466, 30324649, 30325407, 30325786, 30326115 -30326882, 30327149, 30327810, 30328168, 30328209, 30328690, 30329209 -30329751, 30330123, 30331356, 30331759, 30332505, 30332893, 30334484 -30334563, 30335127, 30335832, 30335987, 30336032, 30336383, 30336530 -30336742, 30336996, 30337245, 30338434, 30338591, 30339049, 30339103 -30340540, 30341713, 30342371, 30342878, 30343370, 30344614, 30345201 -30345432, 30345809, 30345926, 30346330, 30346847, 30346867, 30347410 -30349714, 30350177, 30350543, 30352532, 30352581, 30352623, 30352715 -30355490, 30356060, 30356461, 30357463, 30357698, 30357897, 30358416 -30359614, 30360383, 30360653, 30361070, 30361635, 30362003, 30362850 -30363088, 30363193, 30363311, 30363716, 30364329, 30364481, 30364613 -30364835, 30365745, 30367193, 30368048, 30368482, 30368534, 30368668 -30368917, 30371264, 30371623, 30371909, 30372081, 30373419, 30373541 -30373550, 30374345, 30374570, 30374739, 30375109, 30376986, 30377347 -30377692, 30380511, 30380907, 30381207, 30381525, 30381614, 30382646 -30382982, 30383286, 30384121, 30384152, 30387628, 30387666, 30388853 -30389229, 30389414, 30389507, 30389821, 30390279, 30390635, 30391272 -30392011, 30392870, 30392987, 30393110, 30393653, 30393944, 30394509 -30394738, 30394974, 30396120, 30396946, 30396974, 30397100, 30398099 -30398251, 30398257, 30398422, 30399906, 30402386, 30403412, 30403763 -30403881, 30403902, 30403989, 30404117, 30404153, 30404639, 30406709 -30408515, 30408808, 30409207, 30409339, 30409472, 30409590, 30412188 -30412772, 30412863, 30412885, 30412921, 30413137, 30413294, 30414491 -30414679, 30414714, 30416034, 30416603, 30417648, 30417732, 30418926 -30419024, 30419450, 30420105, 30420452, 30421009, 30421026, 30421204 -30421439, 30421476, 30421706, 30422487, 30423135, 30423218, 30424347 -30430921, 30431274, 30431504, 30431582, 30431698, 30431703, 30431717 -30431867, 30433177, 30434793, 30436399, 30437003, 30437149, 30438224 -30439985, 30440651, 30440712, 30441277, 30441687, 30441959, 30442266 -30442749, 30442805, 30442874, 30442884, 30443393, 30446436, 30446583 -30446820, 30447060, 30447498, 30447589, 30447994, 30448182, 30448355 -30448917, 30449194, 30449837, 30450787, 30453442, 30454090, 30455427 -30457633, 30457697, 30458568, 30458593, 30460095, 30460558, 30460842 -30460922, 30461123, 30461458, 30463938, 30464250, 30464655, 30466081 -30469777, 30470947, 30472891, 30473634, 30474167, 30474774, 30475041 -30475115, 30476768, 30477588, 30477685, 30477691, 30477767, 30479252 -30479647, 30479715, 30480872, 30483065, 30483140, 30483217, 30483521 -30484042, 30484801, 30485255, 30486436, 30486896, 30487387, 30489582 -30490014, 30490578, 30492380, 30493518, 30494259, 30494900, 30495035 -30495078, 30495133, 30495483, 30496957, 30497057, 30497120, 30497765 -30498824, 30500224, 30500297, 30500344, 30500582, 30501574, 30502415 -30503943, 30505029, 30505497, 30506794, 30506991, 30507032, 30507313 -30508100, 30509112, 30509277, 30510347, 30510527, 30510718, 30512690 -30513285, 30513353, 30513480, 30513848, 30515886, 30516868, 30517214 -30517516, 30517635, 30518349, 30518923, 30519188, 30522285, 30522998 -30523137, 30523538, 30523601, 30523750, 30524736, 30527198, 30527275 -30528547, 30528687, 30528704, 30528731, 30528935, 30529790, 30529940 -30530585, 30532811, 30533132, 30533580, 30534351, 30534549, 30534662 -30534827, 30535905, 30536237, 30537403, 30537405, 30537533, 30537584 -30538141, 30538818, 30539519, 30540109, 30540407, 30544247, 30544595 -30544629, 30545281, 30545556, 30549255, 30549368, 30549637, 30549789 -30549881, 30551000, 30551123, 30554178, 30556326, 30556581, 30556807 -30557386, 30557803, 30558561, 30559129, 30559218, 30559252, 30560365 -30560513, 30561404, 30561590, 30561737, 30564139, 30564343, 30564898 -30565004, 30565595, 30565805, 30566054, 30567372, 30568514, 30570083 -30571306, 30572816, 30573236, 30573703, 30575243, 30575697, 30576112 -30576393, 30576853, 30577071, 30577591, 30578221, 30579051, 30580813 -30580887, 30581448, 30582221, 30582500, 30586493, 30588738, 30589914 -30591028, 30591475, 30592859, 30593046, 30593104, 30593863, 30594167 -30595114, 30595408, 30595860, 30596024, 30596320, 30596488, 30596694 -30598682, 30598746, 30598919, 30599405, 30599407, 30600173, 30600184 -30602230, 30602828, 30605215, 30605676, 30606345, 30606451, 30608583 -30609799, 30610406, 30610667, 30611603, 30612199, 30613937, 30613971 -30614411, 30616406, 30616738, 30617002, 30617626, 30618230, 30619138 -30619414, 30619525, 30619728, 30619787, 30620805, 30621255, 30622528 -30622755, 30623138, 30623142, 30624243, 30624792, 30624864, 30624874 -30625121, 30628834, 30628899, 30629139, 30629643, 30629799, 30630391 -30630930, 30631393, 30631523, 30633259, 30633938, 30634548, 30634559 -30635183, 30635302, 30635326, 30635360, 30637270, 30637319, 30638712 -30640436, 30641541, 30641755, 30641900, 30644530, 30644766, 30644889 -30645590, 30645896, 30646077, 30647133, 30649310, 30650297, 30650404 -30651231, 30651570, 30651621, 30651674, 30652515, 30652813, 30652853 -30654131, 30654558, 30655906, 30657196, 30657365, 30657566, 30657624 -30657706, 30657875, 30657906, 30657940, 30658421, 30658533, 30658555 -30658702, 30659940, 30660412, 30661000, 30661939, 30662651, 30662736 -30663591, 30663646, 30664266, 30665399, 30665720, 30668407, 30668754 -30670328, 30670369, 30670584, 30671720, 30671813, 30671958, 30674373 -30674959, 30676209, 30677633, 30679595, 30679771, 30679804, 30681085 -30681462, 30681516, 30681521, 30684902, 30685163, 30686017, 30686131 -30687047, 30689557, 30689988, 30690686, 30691604, 30691731, 30691857 -30692462, 30692473, 30693791, 30694947, 30695670, 30696566, 30696821 -30698289, 30699770, 30703610, 30704826, 30705448, 30708735, 30710807 -30711370, 30712670, 30713133, 30714151, 30714715, 30716001, 30716863 -30718841, 30718862, 30719327, 30719419, 30720736, 30720844, 30722705 -30723671, 30724679, 30724881, 30726204, 30727701, 30727759, 30728196 -30729278, 30729604, 30729839, 30730026, 30732711, 30733270, 30733563 -30734242, 30734362, 30734707, 30735091, 30735153, 30735736, 30737970 -30739013, 30739876, 30740115, 30740250, 30740669, 30740997, 30741263 -30748411, 30748707, 30749181, 30749644, 30749722, 30750219, 30750991 -30751171, 30751521, 30751527, 30751639, 30751968, 30753432, 30755348 -30758836, 30758854, 30758943, 30760739, 30761871, 30761878, 30763272 -30763305, 30763639, 30763754, 30763970, 30764405, 30764663, 30765486 -30765995, 30767277, 30768636, 30769312, 30770717, 30772069, 30773164 -30773797, 30776416, 30776676, 30776929, 30777759, 30778855, 30779240 -30781032, 30781041, 30781461, 30782266, 30782300, 30782414, 30783395 -30783551, 30785101, 30786237, 30786641, 30786655, 30788973, 30789904 -30790047, 30790441, 30801296, 30801510, 30803210, 30804646, 30806757 -30806984, 30807723, 30807888, 30808109, 30808869, 30809087, 30810680 -30810765, 30812574, 30814266, 30814285, 30815269, 30815495, 30815852 -30815994, 30816760, 30816938, 30819340, 30819629, 30821297, 30822502 -30822919, 30823744, 30825391, 30825419, 30825656, 30826474, 30828205 -30828350, 30829779, 30830555, 30832775, 30833454, 30834068, 30834110 -30834705, 30835184, 30835219, 30835853, 30836129, 30838605, 30839253 -30839451, 30839836, 30840793, 30841241, 30842277, 30843271, 30844839 -30846063, 30846159, 30846782, 30847442, 30847871, 30848028, 30848097 -30848773, 30851448, 30851951, 30852954, 30855101, 30856358, 30857501 -30857721, 30858877, 30858919, 30860803, 30861988, 30863115, 30864607 -30865805, 30866141, 30866988, 30869131, 30870439, 30870513, 30871716 -30871792, 30873527, 30874270, 30874337, 30874660, 30879169, 30879708 -30880774, 30880913, 30881161, 30881407, 30883715, 30883785, 30883877 -30886188, 30887501, 30887777, 30887976, 30889443, 30889607, 30889723 -30890720, 30890971, 30891760, 30891792, 30895426, 30895577, 30896620 -30896685, 30898381, 30898748, 30898939, 30901889, 30902655, 30904672 -30905604, 30906274, 30906407, 30909596, 30909918, 30910264, 30910267 -30913399, 30914272, 30914674, 30915781, 30919403, 30919587, 30919691 -30919804, 30921136, 30922936, 30922996, 30923514, 30923517, 30923597 -30923940, 30925316, 30925828, 30927440, 30927821, 30930149, 30930339 -30931068, 30931311, 30931981, 30932674, 30932923, 30936251, 30936831 -30936942, 30937340, 30937391, 30937410, 30938413, 30939307, 30939317 -30939934, 30940259, 30940868, 30940869, 30941056, 30944643, 30945005 -30946072, 30946141, 30946595, 30946768, 30946876, 30946896, 30947294 -30950786, 30952104, 30952191, 30953157, 30953266, 30953836, 30955702 -30956571, 30956647, 30957739, 30958493, 30960314, 30960356, 30960736 -30961566, 30964194, 30965554, 30965649, 30967084, 30968737, 30968781 -30970518, 30972817, 30972841, 30972887, 30972947, 30972951, 30972959 -30972966, 30973085, 30973113, 30973127, 30973137, 30973143, 30973197 -30973698, 30973877, 30974207, 30974813, 30977294, 30977411, 30978554 -30979701, 30980023, 30980115, 30980317, 30980733, 30981240, 30985027 -30985906, 30986423, 30987088, 30987105, 30987243, 30987724, 30988444 -30989951, 30990034, 30992120, 30992330, 30992597, 30993198, 30993518 -30993604, 30994996, 30996945, 30996991, 30997375, 30997960, 30998035 -30998662, 30998759, 30998847, 31001017, 31001455, 31001490, 31001859 -31002223, 31002923, 31003137, 31003659, 31004077, 31004719, 31004844 -31004871, 31006011, 31006792, 31006953, 31008240, 31008858, 31008907 -31009032, 31009545, 31009590, 31009680, 31010218, 31010554, 31010976 -31011361, 31013127, 31013531, 31014323, 31015330, 31016413, 31019249 -31021068, 31021109, 31021157, 31021324, 31021542, 31021780, 31022858 -31025267, 31025520, 31025531, 31025859, 31026220, 31026591, 31026860 -31027747, 31028883, 31028986, 31029936, 31030898, 31031240, 31031955 -31032904, 31034794, 31035287, 31035916, 31037421, 31038220, 31038447 -31038817, 31039337, 31039627, 31039928, 31041540, 31042208, 31042337 -31043483, 31043630, 31043747, 31044145, 31044504, 31044951, 31045929 -31046188, 31046619, 31047022, 31047169, 31047697, 31047740, 31048025 -31048741, 31049215, 31049995, 31051056, 31051075, 31052735, 31052809 -31053669, 31054874, 31055142, 31056909, 31057402, 31058548, 31061482 -31061504, 31062010, 31062645, 31063315, 31063380, 31063769, 31064025 -31065838, 31066082, 31066250, 31066265, 31066554, 31067456, 31067483 -31067892, 31069059, 31070528, 31071080, 31073440, 31073586, 31074032 -31075323, 31075960, 31077117, 31077365, 31078391, 31078757, 31079204 -31080474, 31081558, 31084778, 31084921, 31086467, 31086869, 31086954 -31087361, 31087679, 31088115, 31088341, 31089270, 31090262, 31091469 -31091868, 31092129, 31092233, 31092581, 31092921, 31094183, 31094228 -31094688, 31095972, 31096846, 31097760, 31097961, 31098661, 31098870 -31099312, 31100172, 31101386, 31101840, 31103065, 31104809, 31105896 -31106140, 31106577, 31107577, 31108603, 31108644, 31109506, 31112530 -31112972, 31113089, 31113249, 31113426, 31114265, 31114671, 31115201 -31115502, 31117282, 31118486, 31118702, 31118809, 31119057, 31119846 -31120361, 31122876, 31124363, 31124821, 31124914, 31125773, 31125849 -31125918, 31126053, 31126058, 31127043, 31127457, 31127969, 31129851 -31130156, 31132732, 31134430, 31137765, 31138106, 31139643, 31140940 -31141792, 31142377, 31142749, 31142815, 31143870, 31145403, 31145804 -31146338, 31146727, 31151483, 31153120, 31153485, 31155305, 31155634 -31156383, 31158151, 31158341, 31158380, 31159382, 31161861, 31162711 -31162915, 31163379, 31165038, 31165577, 31165722, 31168440, 31170082 -31171096, 31171147, 31171631, 31172207, 31172642, 31175365, 31176502 -31177193, 31177204, 31177221, 31178103, 31180519, 31181380, 31182159 -31182451, 31182756, 31182793, 31183413, 31184230, 31185224, 31188038 -31188398, 31190624, 31191224, 31192039, 31193292, 31193695, 31193745 -31193936, 31194264, 31195090, 31195430, 31195600, 31195838, 31196310 -31200845, 31201001, 31201366, 31201611, 31202536, 31204412, 31204878 -31206070, 31208287, 31213034, 31214119, 31215422, 31215438, 31215854 -31216823, 31216995, 31217946, 31218837, 31218904, 31219047, 31219975 -31220549, 31220837, 31220881, 31220912, 31221454, 31222780, 31223382 -31225538, 31226448, 31228670, 31230775, 31233170, 31234765, 31234790 -31235797, 31236624, 31240626, 31242976, 31244968, 31248496, 31249008 -31249406, 31249696, 31250120, 31250152, 31254297, 31254535, 31254929 -31255369, 31255869, 31256383, 31257740, 31257826, 31258101, 31258697 -31258995, 31260692, 31261467, 31261641, 31265651, 31265773, 31268557 -31270711, 31270847, 31271032, 31274074, 31281708, 31287741, 31287871 -31289115, 31290017, 31290300, 31292298, 31293484, 31298871, 31301460 -31303032, 31304573, 31304945, 31305114, 31305309, 31305624, 31306248 -31306261, 31306867, 31306927, 31307715, 31309379, 31309867, 31310564 -31310624, 31311830, 31312450, 31312976, 31313117, 31313177, 31313214 -31313444, 31313812, 31314885, 31315495, 31315876, 31316250, 31317032 -31321092, 31322720, 31323383, 31325584, 31326320, 31326608, 31326977 -31326998, 31327046, 31327259, 31327278, 31327349, 31327391, 31327896 -31331354, 31331372, 31333156, 31334606, 31334961, 31335037, 31335142 -31336298, 31338249, 31338673, 31338686, 31338769, 31339457, 31339643 -31339744, 31341138, 31341746, 31343110, 31344046, 31348711, 31348922 -31350348, 31353610, 31355339, 31356601, 31357581, 31357737, 31358308 -31359215, 31359366, 31360146, 31360323, 31360469, 31360529, 31362408 -31362692, 31364001, 31366716, 31367188, 31367364, 31368027, 31369444 -31372498, 31373825, 31373837, 31373843, 31374283, 31374449, 31375865 -31376011, 31376708, 31377129, 31377487, 31377808, 31377936, 31380443 -31381701, 31383049, 31383396, 31383464, 31383814, 31386394, 31387426 -31387443, 31388201, 31388288, 31390936, 31391991, 31393600, 31393991 -31394341, 31394347, 31394365, 31394544, 31395247, 31396027, 31396695 -31398663, 31398761, 31399131, 31399883, 31401831, 31402078, 31402598 -31403177, 31403565, 31404014, 31404130, 31404263, 31404487, 31405300 -31408636, 31409483, 31409964, 31410289, 31411163, 31412209, 31414023 -31414524, 31415324, 31416250, 31417007, 31417192, 31418442, 31419363 -31421316, 31422620, 31423645, 31424838, 31425167, 31425761, 31425800 -31429501, 31429590, 31429770, 31429844, 31430722, 31430910, 31431005 -31431771, 31433092, 31433579, 31433749, 31434421, 31434805, 31434870 -31435308, 31437030, 31440426, 31440813, 31441916, 31442332, 31442714 -31444353, 31444516, 31446431, 31447733, 31448680, 31449354, 31450392 -31450653, 31453585, 31454428, 31454972, 31454988, 31455597, 31456857 -31458049, 31459369, 31462082, 31463613, 31465389, 31466433, 31468060 -31468705, 31469001, 31471441, 31471856, 31472077, 31474315, 31475378 -31475635, 31476093, 31476603, 31476701, 31476736, 31477424, 31477695 -31479072, 31479075, 31479106, 31479272, 31479772, 31481750, 31483949 -31484385, 31484603, 31485386, 31485507, 31486061, 31486557, 31487441 -31487491, 31487826, 31487844, 31488464, 31489137, 31490604, 31491634 -31492856, 31493153, 31493840, 31494095, 31494264, 31494794, 31495254 -31495564, 31496174, 31498559, 31499370, 31499700, 31500971, 31501139 -31502301, 31503349, 31506095, 31507107, 31508229, 31508712, 31509279 -31510891, 31510910, 31511142, 31511519, 31511940, 31512044, 31512262 -31513011, 31515911, 31516265, 31517502, 31523548, 31525310, 31525783 -31526903, 31527103, 31527199, 31528962, 31529594, 31529967, 31530985 -31530995, 31532176, 31532339, 31533274, 31533817, 31533833, 31535955 -31536401, 31536731, 31537521, 31537736, 31538891, 31539566, 31541805 -31541864, 31541905, 31542347, 31542851, 31544097, 31545477, 31546864 -31547220, 31547445, 31547480, 31548675, 31549221, 31553289, 31553674 -31553813, 31555126, 31555346, 31555539, 31555800, 31557518, 31557663 -31559085, 31559415, 31559563, 31560592, 31561886, 31563138, 31564795 -31567124, 31567441, 31567719, 31568423, 31569057, 31570054, 31570161 -31571415, 31571742, 31572006, 31572046, 31572267, 31573457, 31574122 -31574150, 31574244, 31574267, 31575529, 31576738, 31577569, 31578994 -31580079, 31580122, 31580374, 31581627, 31584056, 31584555, 31584853 -31585351, 31585491, 31585789, 31586381, 31588933, 31590826, 31591384 -31591400, 31591409, 31591421, 31595025, 31595632, 31597727, 31598146 -31599363, 31599990, 31600023, 31600291, 31600894, 31601385, 31603199 -31605119, 31605737, 31606474, 31607937, 31608753, 31609974, 31613838 -31616101, 31616104, 31619276, 31620252, 31620748, 31620944, 31623413 -31623463, 31625579, 31625618, 31625959, 31626438, 31626493, 31626572 -31627587, 31628311, 31628753, 31630551, 31630794, 31630946, 31631985 -31632273, 31632663, 31633224, 31634510, 31637607, 31637680, 31640240 -31644775, 31648120, 31648157, 31649819, 31650202, 31652641, 31653080 -31653634, 31655807, 31656263, 31658464, 31658819, 31658943, 31659065 -31661865, 31662504, 31663189, 31663788, 31664399, 31666449, 31667096 -31668033, 31668061, 31668694, 31668872, 31669064, 31670014, 31670263 -31670353, 31671568, 31672605, 31674380, 31675568, 31675852, 31675860 -31676941, 31677460, 31677479, 31678629, 31682766, 31683044, 31683260 -31683373, 31683708, 31684080, 31684494, 31686979, 31688978, 31691030 -31691089, 31691480, 31695062, 31695693, 31696577, 31696853, 31697741 -31699230, 31700234, 31701239, 31701910, 31705704, 31706595, 31706956 -31707190, 31708133, 31709647, 31709739, 31709777, 31711889, 31711997 -31712260, 31715935, 31716873, 31718134, 31718346, 31718842, 31719167 -31720839, 31720942, 31721863, 31721880, 31722558, 31722646, 31723226 -31723323, 31723651, 31727560, 31728160, 31730485, 31730766, 31734017 -31734583, 31735662, 31736095, 31737059, 31737603, 31739198, 31739891 -31741938, 31743771, 31745130, 31745233, 31745528, 31746054, 31747706 -31747818, 31747935, 31747989, 31748000, 31748182, 31748944, 31752502 -31753202, 31753425, 31753478, 31753692, 31754546, 31754887, 31755245 -31756415, 31756568, 31756650, 31757357, 31757775, 31757824, 31758083 -31758344, 31758846, 31758939, 31758960, 31759565, 31760592, 31760738 -31761510, 31763707, 31763905, 31764089, 31764866, 31764913, 31765068 -31765246, 31765257, 31765296, 31766534, 31766696, 31767204, 31767237 -31767852, 31769373, 31769530, 31770289, 31771302, 31771370, 31771410 -31771468, 31771836, 31775101, 31776994, 31781897, 31783422, 31783451 -31783782, 31783985, 31785445, 31785572, 31786838, 31787057, 31787655 -31788704, 31788761, 31790500, 31792465, 31792615, 31793713, 31796208 -31796277, 31796882, 31798669, 31798702, 31798742, 31799858, 31800757 -31804838, 31805812, 31807179, 31807516, 31809510, 31810213, 31815099 -31816158, 31816631, 31820632, 31820859, 31820926, 31821129, 31821835 -31822026, 31823051, 31824504, 31825410, 31827339, 31827605, 31827912 -31828378, 31829366, 31829617, 31829639, 31833172, 31833585, 31833948 -31834191, 31834871, 31835854, 31836113, 31836454, 31839038, 31839779 -31839888, 31840490, 31842545, 31843028, 31843462, 31843476, 31845092 -31845403, 31845803, 31845955, 31846454, 31847489, 31847541, 31848331 -31848365, 31848391, 31848903, 31849859, 31850227, 31851383, 31851449 -31852482, 31852574, 31854692, 31855526, 31855996, 31858580, 31858833 -31860193, 31860406, 31862359, 31862593, 31862611, 31863118, 31866141 -31867037, 31867351, 31869601, 31871384, 31871692, 31872230, 31875140 -31876368, 31878256, 31878314, 31880154, 31881527, 31883124, 31883343 -31886547, 31886695, 31886745, 31887130, 31888148, 31888731, 31889222 -31892029, 31895670, 31897786, 31897854, 31898193, 31900585, 31902662 -31903523, 31903786, 31903962, 31904933, 31905033, 31907042, 31907137 -31907510, 31907565, 31907792, 31908345, 31908750, 31909295, 31913650 -31914943, 31915444, 31915968, 31916644, 31917378, 31921267, 31922161 -31923463, 31926203, 31926811, 31927930, 31934254, 31934301, 31935717 -31939461, 31939486, 31940458, 31942136, 31942144, 31943497, 31945038 -31945407, 31945928, 31946936, 31947732, 31947861, 31950577, 31952046 -31952052, 31953989, 31956113, 31957152, 31957564, 31957674, 31957683 -31958958, 31959253, 31961940, 31965012, 31965542, 31970188, 31971792 -31972615, 31974424, 31974597, 31974693, 31976303, 31977024, 31980296 -31981745, 31981751, 31985738, 31986836, 31986905, 31988079, 31990386 -31991705, 31993795, 31996264, 31997457, 31998181, 31998861, 31999453 -32001851, 32002411, 32003551, 32004977, 32005048, 32007076, 32007698 -32008408, 32008586, 32008819, 32010707, 32012788, 32012975, 32013403 -32014520, 32016884, 32017301, 32017422, 32018632, 32022711, 32028269 -32032653, 32032733, 32032887, 32034766, 32035268, 32035536, 32035899 -32035902, 32036045, 32037237, 32038996, 32040940, 32042256, 32045377 -32046125, 32047226, 32048412, 32050048, 32052587, 32054806, 32057639 -32058260, 32060164, 32060577, 32061018, 32061146, 32061648, 32064682 -32067675, 32068187, 32069160, 32069696, 32069834, 32071582, 32072944 -32073710, 32074450, 32075009, 32075020, 32075130, 32076561, 32077318 -32079573, 32079739, 32080081, 32082098, 32087331, 32088132, 32089051 -32089820, 32093558, 32094825, 32095097, 32097387, 32097882, 32099153 -32101305, 32105135, 32105239, 32105412, 32108576, 32109384, 32109796 -32112798, 32112822, 32113113, 32114572, 32118727, 32120283, 32120453 -32121326, 32122574, 32123331, 32124176, 32124570, 32124594, 32124607 -32125142, 32127227, 32129659, 32130083, 32130485, 32130504, 32131401 -32133039, 32138478, 32138782, 32139432, 32142788, 32143492, 32150818 -32150854, 32153396, 32153909, 32157050, 32162391, 32164053, 32165367 -32165759, 32165887, 32167592, 32167923, 32169151, 32170190, 32171622 -32171791, 32172777, 32173543, 32174571, 32177869, 32179306, 32184855 -32187775, 32189869, 32189952, 32191451, 32196738, 32197147, 32203354 -32207088, 32207920, 32208144, 32208346, 32210660, 32212041, 32212635 -32212916, 32214021, 32214782, 32218369, 32218498, 32218552, 32219318 -32220017, 32221141, 32222473, 32225353, 32227352, 32230775, 32234161 -32239730, 32244187, 32245850, 32246090, 32250232, 32250238, 32252213 -32255073, 32259535, 32259785, 32260290, 32266406, 32267171, 32268669 -32277643, 32284241, 32285717, 32285789, 32287797, 32290313, 32290399 -32291114, 32291139, 32292180, 32296941, 32305792, 32307586, 32312586 -32316252, 32319410, 32321319, 32321765, 32323488, 32327201, 32331889 -32341260, 32345001, 32353343, 32355912, 32356609, 32357412, 32361175 -32363549, 32364147, 32379775, 32385832, 32387555, 32387818, 32391021 -32398714, 32401086, 32405239, 32409344, 32409942, 32410175, 32413042 -32413512, 32421958, 32425194, 32426315, 32427173, 32431413, 32435911 -32436721, 32436757, 32442404, 32444159, 32460136, 32465853, 32471251 -32471346, 32490128, 32492343, 32492422, 32495545, 32495572, 32499155 -32505009, 32505634, 32518029, 32523206, 32550589, 32559543, 32563940 -32568163, 32576508, 32620919 -``` - -## Version 19\.0\.0\.0\.ru\-2021\-01\.rur\-2021\-01\.r2 - -**Important** -We recommend that you upgrade your DB instance to this version rather than to 19\.0\.0\.0\.ru\-2021\-01\.rur\-2021\-01\.r1\. The application of the patch for minor engine upgrades to 19\.0\.0\.0\.ru\-2021\-01\.rur\-2021\-01\.r1 encountered an issue\. Release update 19\.10\.0\.0\.210119 \(32218454\) didn't register correctly in the `DBA_REGISTRY_SQLPATCH` table\. - -Version 19\.0\.0\.0\.ru\-2021\-01\.rur\-2021\-01\.r2 includes the following: -+ Patch 32218454: DATABASE RELEASE UPDATE 19\.10\.0\.0\.210119 -+ Patch 32067171: OJVM RELEASE UPDATE 19\.10\.0\.0\.210119 -+ Patch 31335037: RDBMS \- DSTV35 UPDATE \- TZDATA2020A -+ Patch 31335142: DSTV35 UPDATE \- TZDATA2020A \- NEED OJVM FIX -+ Patch 29213893: DBMS\_STATS FAILING WITH ERROR ORA\-01422 WHEN GATHERING STATS FOR USER TABLE -+ Patch 29782284: ORA\-06508:"MDSYS\.MDPRVT\_IDX" WHILE UPGRADING DATABASE TO 18\.3 -+ Patch 28730253: SUPPORT NEW ERA REIWA FOR JAPANESE IMPERIAL CALENDAR -+ Patch 29374604: IE not starting against 18c Oracle RDBMS Standard Edition -+ PreUpgrade Jar: preupgrade\_19\_cbuild\_9\_lf\.zip -+ Support for [Managing advisor tasks](Appendix.Oracle.CommonDBATasks.Misc.md#Appendix.Oracle.CommonDBATasks.managing-advisor-tasks) using procedures in the `rdsadmin.rdsadmin_util` package - -### Combined patches for version 19\.0\.0\.0\.ru\-2021\-01\.rur\-2021\-01\.r2, Released January 2021 - -Bugs fixed: - -``` -7391838, 8460502, 8476681, 14735102, 16664572, 17428816, 17468475 -19080742, 19138896, 19697993, 20313356, 20867658, 21232786, 21374587 -21528318, 21629064, 21639146, 21888352, 21965541, 22580355, 22729345 -22748979, 23294761, 23296836, 23606241, 23645975, 23734075, 23763462 -24596874, 24669730, 24687075, 24833686, 24957575, 24971456, 25030027 -25092651, 25093917, 25404117, 25416731, 25560538, 25607406, 25756945 -25792962, 25804387, 25806201, 25809128, 25883179, 25905368, 25986062 -25997810, 26001677, 26127355, 26173091, 26284288, 26352615, 26440142 -26476244, 26499997, 26611353, 26668264, 26716835, 26739322, 26777814 -26819036, 26872233, 27004828, 27036163, 27044169, 27101798, 27126122 -27126938, 27130348, 27166935, 27195575, 27195935, 27221350, 27222128 -27244999, 27254335, 27260704, 27261477, 27359766, 27362994, 27369515 -27378053, 27392968, 27406105, 27411022, 27423500, 27439716, 27453490 -27458357, 27489107, 27572040, 27582210, 27589260, 27604329, 27622946 -27629928, 27661222, 27666312, 27684864, 27692173, 27700413, 27710072 -27729678, 27742354, 27745728, 27760043, 27801144, 27828892, 27829722 -27846298, 27873364, 27877830, 27880025, 27929509, 27934711, 27935464 -27941110, 27957203, 27967484, 27998559, 28007516, 28064977, 28072567 -28078186, 28092783, 28104176, 28109326, 28125947, 28127569, 28129791 -28133903, 28138847, 28144569, 28145995, 28181021, 28187837, 28189466 -28204262, 28205555, 28209985, 28210681, 28263142, 28271258, 28271693 -28276054, 28279456, 28294563, 28302580, 28313275, 28319114, 28322973 -28326928, 28338211, 28350595, 28370061, 28371123, 28373960, 28375383 -28379065, 28381939, 28386259, 28390273, 28395302, 28397317, 28402823 -28403019, 28406374, 28410431, 28431445, 28435333, 28436414, 28442896 -28454215, 28463226, 28470673, 28475242, 28482048, 28484299, 28489419 -28492006, 28498976, 28502773, 28504631, 28513333, 28521330, 28530171 -28534475, 28535127, 28537481, 28538439, 28541606, 28542455, 28546290 -28547068, 28547926, 28558645, 28561704, 28564479, 28565296, 28567417 -28567819, 28569897, 28572407, 28572533, 28572544, 28572667, 28572834 -28578945, 28587723, 28589509, 28593682, 28594086, 28597221, 28601957 -28602253, 28605066, 28606598, 28608211, 28612239, 28618343, 28620697 -28621543, 28622202, 28625580, 28625862, 28627033, 28628592, 28630381 -28632796, 28636532, 28639299, 28640772, 28642469, 28642899, 28643583 -28643654, 28643718, 28644549, 28645570, 28646200, 28646939, 28649388 -28655209, 28661333, 28663289, 28663782, 28672457, 28673945, 28681153 -28689483, 28690694, 28692103, 28692275, 28694639, 28694872, 28696373 -28697526, 28698087, 28699321, 28700945, 28703812, 28705231, 28707931 -28708400, 28709063, 28710385, 28710469, 28710663, 28710734, 28714461 -28715655, 28715727, 28718469, 28719348, 28720204, 28720418, 28721497 -28722229, 28730079, 28730253, 28734355, 28740708, 28740799, 28742555 -28745367, 28749853, 28751498, 28752923, 28755011, 28755084, 28755846 -28758722, 28760206, 28763291, 28765983, 28767240, 28769456, 28771947 -28772390, 28772816, 28774416, 28776431, 28776811, 28777214, 28778754 -28781599, 28781754, 28785273, 28785321, 28785531, 28789531, 28791852 -28793062, 28794230, 28795551, 28795734, 28800508, 28802734, 28804517 -28805242, 28806517, 28808314, 28808652, 28808656, 28810381, 28811560 -28813931, 28815123, 28815355, 28815557, 28816871, 28817449, 28818063 -28819640, 28820669, 28821847, 28824482, 28827682, 28831971, 28833912 -28835937, 28836716, 28837979, 28838385, 28844738, 28845346, 28846759 -28847541, 28847572, 28849776, 28850084, 28852325, 28854004, 28854733 -28855520, 28855922, 28857552, 28861861, 28862532, 28863263, 28863432 -28863487, 28865569, 28867698, 28867992, 28870496, 28871040, 28872645 -28872829, 28873575, 28874416, 28875089, 28876253, 28876639, 28876926 -28877252, 28878865, 28881191, 28881848, 28882784, 28884931, 28887305 -28888083, 28888327, 28889389, 28889730, 28892794, 28897123, 28897512 -28899663, 28900506, 28901126, 28905390, 28905457, 28905615, 28907196 -28910498, 28910586, 28911140, 28912691, 28915561, 28917080, 28918429 -28919145, 28921844, 28922227, 28922532, 28922608, 28925250, 28925460 -28925634, 28925880, 28927452, 28928462, 28932914, 28933158, 28935293 -28935956, 28936114, 28937717, 28938422, 28938698, 28940179, 28940281 -28940472, 28941901, 28942455, 28942694, 28945421, 28945994, 28946233 -28948554, 28949888, 28950868, 28951332, 28951533, 28952168, 28954762 -28955606, 28955883, 28956908, 28957260, 28957292, 28957723, 28958088 -28959493, 28960863, 28962775, 28963036, 28965084, 28965095, 28965231 -28965376, 28966444, 28968779, 28974083, 28974999, 28977322, 28980448 -28981871, 28983095, 28983486, 28984313, 28985114, 28985272, 28985362 -28985478, 28986207, 28986231, 28986257, 28986326, 28986481, 28986696 -28988482, 28988864, 28989306, 28993295, 28993353, 28994307, 28994542 -28995287, 28996376, 28999046, 29000000, 29001305, 29001888, 29002488 -29002784, 29002927, 29003207, 29003407, 29003617, 29003738, 29006318 -29006621, 29007321, 29007353, 29007775, 29008035, 29008669, 29009513 -29010126, 29010517, 29011936, 29012609, 29013475, 29013832, 29014076 -29015118, 29016294, 29017265, 29018655, 29018680, 29019121, 29020423 -29021063, 29021352, 29022986, 29024028, 29024054, 29024448, 29024552 -29024732, 29024876, 29026154, 29026582, 29026606, 29027456, 29027694 -29027933, 29027940, 29030184, 29030927, 29031575, 29031600, 29032234 -29032276, 29032457, 29032607, 29033052, 29033145, 29033200, 29033280 -29034587, 29036278, 29037290, 29038528, 29038728, 29039089, 29039510 -29040739, 29041739, 29041775, 29043554, 29043651, 29043725, 29044086 -29044763, 29044954, 29046482, 29047127, 29047850, 29048178, 29048289 -29048498, 29048605, 29048728, 29049673, 29050357, 29050560, 29050765 -29050886, 29051263, 29051702, 29051953, 29052726, 29052850, 29053783 -29053902, 29055644, 29056024, 29056270, 29056560, 29056767, 29056894 -29058476, 29059011, 29060216, 29061016, 29061959, 29062692, 29062848 -29062860, 29062868, 29110526, 29110783, 29110790, 29110797, 29110802 -29110805, 29111598, 29111631, 29112455, 29113282, 29113305, 29115857 -29117337, 29117526, 29117642, 29118543, 29119077, 29120223, 29122224 -29122254, 29122367, 29123297, 29123432, 29123444, 29123482, 29124368 -29125036, 29125374, 29125380, 29125708, 29125786, 29126345, 29127957 -29128693, 29128935, 29129450, 29129476, 29129497, 29129691, 29129712 -29130219, 29131539, 29131772, 29132456, 29132869, 29132938, 29133470 -29134447, 29135383, 29135649, 29136111, 29138641, 29139070, 29139727 -29139761, 29139956, 29141316, 29141341, 29141685, 29141886, 29142609 -29142667, 29143516, 29144995, 29145214, 29145730, 29146077, 29146157 -29146810, 29147849, 29148799, 29149170, 29149829, 29150338, 29151520 -29152357, 29152603, 29152752, 29154631, 29154636, 29154725, 29154829 -29155099, 29157051, 29157389, 29158680, 29158899, 29159216, 29159661 -29159909, 29159936, 29160174, 29160462, 29161597, 29161923, 29162095 -29163073, 29163156, 29163415, 29163437, 29163524, 29163567, 29164376 -29165682, 29167111, 29167342, 29167374, 29167940, 29168137, 29168219 -29168433, 29169073, 29169215, 29169540, 29169739, 29170232, 29170717 -29171683, 29171942, 29172618, 29172826, 29173140, 29173373, 29173618 -29173817, 29174004, 29174753, 29175638, 29176318, 29177466, 29177543 -29177886, 29178385, 29179097, 29180313, 29180455, 29180559, 29180721 -29180893, 29181078, 29181153, 29181231, 29181568, 29181620, 29181743 -29181923, 29182019, 29182517, 29182901, 29182920, 29183298, 29183912 -29184297, 29184666, 29185193, 29186091, 29186456, 29186605, 29188255 -29189302, 29189307, 29189889, 29190235, 29190474, 29190663, 29190740 -29191541, 29191827, 29192419, 29192468, 29192685, 29193207, 29194205 -29194367, 29194493, 29194827, 29194981, 29195279, 29195337, 29195758 -29196725, 29198092, 29198913, 29199163, 29199635, 29199733, 29200316 -29200700, 29201143, 29201494, 29201539, 29201695, 29201787, 29202104 -29202461, 29202850, 29203041, 29203122, 29203166, 29203227, 29203425 -29203443, 29203604, 29205281, 29205323, 29205419, 29205463, 29205767 -29205918, 29206109, 29206605, 29207073, 29208260, 29208732, 29209545 -29210577, 29210610, 29210624, 29210683, 29211457, 29211724, 29212012 -29212433, 29212611, 29213320, 29213351, 29213613, 29213641, 29213775 -29213850, 29213879, 29213893, 29214561, 29214960, 29216312, 29216723 -29216746, 29216984, 29217294, 29217472, 29217828, 29217848, 29217856 -29218570, 29219205, 29219273, 29219627, 29220079, 29221248, 29221891 -29221942, 29222031, 29222784, 29223833, 29223859, 29223967, 29224065 -29224294, 29224605, 29224710, 29225076, 29225168, 29225758, 29225861 -29227602, 29228869, 29229164, 29229754, 29229839, 29229844, 29229955 -29230252, 29230565, 29231133, 29232117, 29232154, 29232449, 29232653 -29233415, 29233810, 29233953, 29234123, 29235934, 29236573, 29237538 -29237575, 29237744, 29240307, 29240668, 29240759, 29241345, 29241651 -29242017, 29242884, 29242906, 29243749, 29243958, 29244495, 29244766 -29244968, 29245063, 29245137, 29245160, 29246163, 29247183, 29247415 -29247712, 29247906, 29248495, 29248552, 29248723, 29248835, 29248858 -29249289, 29249412, 29249583, 29249991, 29250059, 29250317, 29251259 -29251564, 29253184, 29253871, 29254031, 29254623, 29254930, 29255178 -29255273, 29255431, 29255435, 29255616, 29255705, 29255718, 29255973 -29256426, 29259119, 29259320, 29260224, 29260452, 29260956, 29261547 -29261548, 29261695, 29261906, 29262512, 29262887, 29265448, 29266248 -29266899, 29267292, 29268412, 29269171, 29269228, 29269825, 29270585 -29271019, 29273168, 29273360, 29273539, 29273570, 29273735, 29273812 -29273847, 29274428, 29274564, 29274627, 29275461, 29276272, 29277317 -29278218, 29278684, 29279658, 29279751, 29279854, 29281112, 29281527 -29281691, 29281796, 29282090, 29282233, 29282666, 29282898, 29285197 -29285453, 29285503, 29285621, 29285788, 29285956, 29286037, 29286220 -29286229, 29287130, 29287705, 29290110, 29290235, 29292232, 29292837 -29293072, 29293574, 29293806, 29294753, 29296257, 29297863, 29297915 -29298220, 29299049, 29299082, 29299830, 29299844, 29301463, 29301566 -29302565, 29302614, 29302963, 29303918, 29304314, 29304692, 29304781 -29304853, 29305093, 29306226, 29306713, 29307090, 29307109, 29307638 -29309698, 29311336, 29311528, 29311588, 29311927, 29312310, 29312672 -29312734, 29312753, 29312889, 29313347, 29313417, 29313525, 29314539 -29314636, 29317756, 29318410, 29319441, 29320900, 29321489, 29321689 -29323946, 29324568, 29324735, 29325087, 29325105, 29325257, 29325765 -29325993, 29326233, 29327044, 29327892, 29329042, 29329087, 29329675 -29329807, 29329848, 29330361, 29330791, 29331066, 29331209, 29331380 -29331493, 29332292, 29332395, 29332763, 29332771, 29333500, 29336843 -29336899, 29337294, 29337310, 29337742, 29338315, 29338348, 29338453 -29338780, 29338913, 29339101, 29339155, 29339299, 29340333, 29341209 -29342099, 29343086, 29343156, 29343861, 29344541, 29345937, 29346057 -29346211, 29346943, 29347620, 29348176, 29348358, 29350052, 29350712 -29350762, 29350868, 29351044, 29351386, 29351662, 29351716, 29351735 -29351749, 29351771, 29352298, 29352724, 29352867, 29352947, 29353271 -29353432, 29353718, 29353821, 29353960, 29355654, 29356547, 29356704 -29356711, 29356752, 29356782, 29357821, 29358509, 29358828, 29360252 -29360285, 29360467, 29360672, 29360775, 29360911, 29360950, 29361319 -29361472, 29361801, 29362596, 29363151, 29364171, 29364177, 29366406 -29366940, 29367019, 29367561, 29367971, 29368253, 29368310, 29368725 -29372069, 29372541, 29372562, 29373418, 29373588, 29374179, 29374604 -29375355, 29375941, 29375984, 29376346, 29377804, 29377986, 29378029 -29378287, 29378834, 29378913, 29379299, 29379381, 29379750, 29379978 -29380527, 29381000, 29382296, 29382641, 29382784, 29382815, 29383695 -29384781, 29384854, 29384864, 29385339, 29385429, 29385652, 29386502 -29386557, 29386635, 29386660, 29386835, 29387073, 29387274, 29387310 -29387337, 29388020, 29388072, 29388094, 29388524, 29388830, 29389408 -29389889, 29390011, 29390435, 29390785, 29391030, 29391237, 29391301 -29391438, 29391849, 29391925, 29392554, 29392966, 29393291, 29393649 -29394014, 29394140, 29394749, 29395657, 29396481, 29397841, 29397954 -29397996, 29398488, 29398863, 29399046, 29399100, 29399121, 29399336 -29399938, 29402110, 29402131, 29404483, 29405012, 29405462, 29405651 -29405996, 29407488, 29407804, 29408853, 29409149, 29409455, 29410311 -29410834, 29411037, 29411469, 29411931, 29412066, 29412269, 29413360 -29413382, 29413517, 29413544, 29413634, 29413956, 29415493, 29416688 -29416700, 29417084, 29417173, 29417719, 29417884, 29418165, 29418341 -29420254, 29420834, 29421059, 29423003, 29423016, 29423156, 29423491 -29423826, 29424999, 29426241, 29426320, 29428230, 29429017, 29429087 -29429264, 29429466, 29429566, 29429895, 29430524, 29430866, 29431192 -29431402, 29431485, 29432176, 29434301, 29434869, 29435474, 29435652 -29436454, 29436514, 29436522, 29436727, 29437029, 29437379, 29437594 -29437712, 29438150, 29438277, 29438736, 29439522, 29440651, 29441196 -29442400, 29442936, 29443187, 29443250, 29443559, 29444072, 29444282 -29444602, 29445548, 29446319, 29446669, 29448498, 29449477, 29449845 -29449852, 29450162, 29450193, 29450273, 29450421, 29450812, 29450936 -29451085, 29451386, 29452251, 29452576, 29452936, 29452953, 29454450 -29454978, 29455424, 29455773, 29456538, 29456714, 29457312, 29457319 -29457370, 29457502, 29457807, 29457978, 29458132, 29460252, 29461420 -29461791, 29461971, 29462594, 29462767, 29462957, 29463047, 29463528 -29463798, 29464616, 29464779, 29465047, 29465177, 29466674, 29467622 -29469563, 29469565, 29470059, 29470291, 29471633, 29471832, 29471857 -29471860, 29472618, 29473708, 29476473, 29477015, 29481584, 29482021 -29483452, 29483532, 29483626, 29483672, 29483685, 29483712, 29483723 -29483771, 29485099, 29485877, 29486181, 29486848, 29487150, 29487189 -29487407, 29488894, 29489436, 29489546, 29490256, 29491784, 29492127 -29492939, 29493122, 29494245, 29495057, 29495171, 29495684, 29497311 -29497588, 29497696, 29498198, 29500257, 29500826, 29500963, 29501218 -29502561, 29503543, 29503631, 29503827, 29504103, 29504492, 29504682 -29505225, 29505589, 29505668, 29506942, 29507270, 29507616, 29508681 -29509777, 29510278, 29511064, 29511611, 29511980, 29512125, 29512890 -29514479, 29515134, 29515240, 29515476, 29515766, 29515834, 29516300 -29516727, 29516766, 29517168, 29517883, 29518604, 29518767, 29519131 -29521187, 29521688, 29521748, 29521862, 29522358, 29522561, 29522662 -29523055, 29523216, 29523511, 29524599, 29524985, 29525366, 29525467 -29525886, 29526966, 29527595, 29527610, 29528368, 29529147, 29530440 -29530515, 29530812, 29530909, 29531654, 29531836, 29532112, 29532532 -29536342, 29536445, 29536794, 29537829, 29538631, 29539413, 29540327 -29541742, 29541769, 29541973, 29542084, 29542449, 29542580, 29542643 -29543034, 29543956, 29544552, 29546817, 29547010, 29547867, 29548413 -29548427, 29548592, 29548687, 29548722, 29549040, 29549071, 29549104 -29549154, 29549730, 29550530, 29552402, 29552773, 29553141, 29554092 -29555105, 29557144, 29557261, 29557336, 29557556, 29558238, 29558452 -29558926, 29558975, 29559187, 29559395, 29559446, 29559908, 29559981 -29564592, 29564593, 29565611, 29579919, 29580394, 29580983, 29581771 -29584261, 29584693, 29586143, 29587299, 29587720, 29587765, 29588732 -29589544, 29591343, 29591641, 29592011, 29592215, 29597536, 29597716 -29597754, 29598039, 29598046, 29598226, 29598233, 29599008, 29599243 -29599300, 29599552, 29601461, 29602831, 29603460, 29603884, 29604002 -29604257, 29606261, 29607136, 29607797, 29608000, 29608023, 29610506 -29611020, 29611991, 29614206, 29614931, 29614987, 29615824, 29616244 -29616414, 29618074, 29618190, 29620042, 29622936, 29623323, 29623592 -29624124, 29625065, 29625804, 29625876, 29626154, 29626732, 29628200 -29628647, 29629430, 29629650, 29629681, 29629745, 29631749, 29632095 -29632265, 29632611, 29633697, 29633753, 29633936, 29634643, 29635427 -29635717, 29635990, 29637362, 29637526, 29637560, 29638285, 29641736 -29642451, 29643721, 29644426, 29644464, 29645167, 29645349, 29647176 -29647770, 29648928, 29649694, 29651183, 29651520, 29652809, 29653132 -29653246, 29655164, 29655668, 29656400, 29656819, 29656843, 29657399 -29657422, 29657744, 29657960, 29658056, 29661028, 29661065, 29661722 -29663191, 29663368, 29663494, 29663601, 29664087, 29664161, 29665168 -29665940, 29666451, 29667527, 29667994, 29668005, 29669413, 29670713 -29670782, 29671363, 29672507, 29675446, 29676089, 29677051, 29677173 -29677733, 29677927, 29679856, 29680700, 29681987, 29683039, 29683211 -29684518, 29685137, 29685276, 29687214, 29687220, 29687459, 29687718 -29687727, 29687763, 29688867, 29689145, 29689255, 29692694, 29694869 -29695425, 29695821, 29695841, 29695964, 29695987, 29696310, 29697928 -29700125, 29700460, 29700770, 29701720, 29703932, 29705793, 29706160 -29707099, 29707493, 29707896, 29708324, 29708353, 29708876, 29708915 -29710188, 29710858, 29713810, 29715220, 29715703, 29716194, 29716227 -29716491, 29716602, 29716871, 29717659, 29717901, 29718198, 29719146 -29720133, 29720373, 29721418, 29721576, 29722167, 29724658, 29725476 -29725781, 29726695, 29737941, 29738374, 29738400, 29739576, 29741319 -29741976, 29742223, 29744225, 29744400, 29744637, 29745288, 29746962 -29747493, 29747648, 29747653, 29748285, 29748325, 29748336, 29748513 -29749471, 29750673, 29751094, 29753244, 29754196, 29754951, 29755821 -29756274, 29756444, 29757099, 29757264, 29757651, 29757687, 29758203 -29758217, 29758661, 29761678, 29761837, 29761911, 29763158, 29764644 -29765035, 29765219, 29765347, 29765393, 29765493, 29766207, 29766435 -29766503, 29766679, 29768487, 29768899, 29769901, 29770750, 29771032 -29771242, 29772514, 29772761, 29773197, 29773205, 29773842, 29774362 -29775393, 29779196, 29780140, 29782211, 29782284, 29782823, 29782866 -29783142, 29784106, 29785239, 29785311, 29785831, 29787292, 29787766 -29789911, 29791152, 29791880, 29792213, 29792433, 29793318, 29794174 -29794462, 29795712, 29795957, 29796335, 29796378, 29796916, 29797209 -29797726, 29801164, 29802382, 29802695, 29804875, 29805368, 29805772 -29806390, 29806964, 29807964, 29809792, 29809837, 29811616, 29812084 -29812489, 29813503, 29813650, 29813671, 29814995, 29815341, 29815713 -29816887, 29817278, 29817547, 29817784, 29820341, 29821130, 29821582 -29822714, 29825525, 29827647, 29827852, 29828644, 29829339, 29831196 -29833984, 29834506, 29836096, 29838337, 29838485, 29838740, 29838773 -29839715, 29840619, 29841267, 29841687, 29842369, 29843277, 29843692 -29843831, 29844131, 29844226, 29844275, 29845530, 29846126, 29846525 -29846645, 29846688, 29848084, 29848849, 29849100, 29850930, 29851733 -29853485, 29856420, 29856859, 29856890, 29858121, 29858376, 29858420 -29859068, 29860022, 29860994, 29861075, 29864203, 29864261, 29865188 -29865590, 29865658, 29869052, 29869086, 29869149, 29869404, 29869887 -29869906, 29870065, 29870533, 29871098, 29871312, 29871360, 29872401 -29872937, 29872983, 29873665, 29874090, 29874761, 29875200, 29875459 -29875565, 29876358, 29876989, 29877608, 29878076, 29881050, 29881478 -29881575, 29881643, 29881839, 29882427, 29882454, 29882729, 29884958 -29885182, 29885890, 29886809, 29887045, 29887111, 29888621, 29889184 -29889358, 29890740, 29891075, 29891853, 29891916, 29892604, 29893132 -29894021, 29896510, 29897418, 29897863, 29900203, 29900824, 29901419 -29901961, 29902299, 29902327, 29902330, 29902659, 29903190, 29903299 -29903357, 29903454, 29904002, 29906678, 29907942, 29908389, 29908777 -29909658, 29910218, 29910402, 29912135, 29912286, 29913805, 29913966 -29914449, 29914544, 29915217, 29915848, 29916975, 29919789, 29920025 -29920376, 29920804, 29921318, 29922225, 29922461, 29923452, 29924181 -29926466, 29927756, 29928210, 29928340, 29928427, 29928564, 29930457 -29931956, 29932202, 29932310, 29932430, 29932780, 29934048, 29934052 -29935685, 29937565, 29937655, 29937956, 29938225, 29939400, 29939795 -29940373, 29941062, 29942096, 29942275, 29942554, 29943670, 29943879 -29944035, 29944159, 29944660, 29944963, 29945645, 29946388, 29947145 -29947428, 29948165, 29950220, 29951620, 29951759, 29952700, 29956016 -29956222, 29957412, 29957493, 29958925, 29960884, 29961353, 29961360 -29961609, 29961847, 29962160, 29962248, 29962834, 29962927, 29962939 -29965052, 29965603, 29965888, 29966768, 29967223, 29968085, 29969557 -29970081, 29970261, 29970298, 29970587, 29971027, 29971481, 29971888 -29971936, 29971951, 29972134, 29972176, 29973012, 29989783, 29989845 -29990779, 29991257, 29993717, 29997326, 29997553, 29997937, 30000664 -30001105, 30001331, 30003187, 30004660, 30004856, 30006159, 30006985 -30007450, 30007536, 30007797, 30008125, 30008198, 30008214, 30009710 -30012181, 30014200, 30015070, 30017836, 30018017, 30018903, 30019864 -30021830, 30024618, 30025814, 30026016, 30026596, 30027614, 30027649 -30028182, 30028599, 30029519, 30029806, 30031027, 30032233, 30032376 -30032484, 30033040, 30033547, 30034456, 30035598, 30036258, 30038392 -30039800, 30039959, 30040157, 30041501, 30041514, 30042490, 30043398 -30043610, 30043930, 30044108, 30044507, 30045273, 30045389, 30045484 -30046497, 30047531, 30047702, 30047765, 30047931, 30048688, 30049966 -30051176, 30051783, 30051804, 30052928, 30053036, 30053501, 30053748 -30054980, 30056058, 30057718, 30057799, 30058149, 30058453, 30059106 -30059109, 30060267, 30060330, 30062364, 30062819, 30064268, 30066352 -30067565, 30068384, 30068792, 30068871, 30071446, 30072018, 30072905 -30073314, 30073422, 30073744, 30074296, 30074349, 30074469, 30074472 -30074820, 30075037, 30076058, 30076197, 30076253, 30076604, 30078675 -30078934, 30079949, 30080111, 30080266, 30081546, 30081580, 30082145 -30083100, 30083216, 30083488, 30083807, 30084971, 30085897, 30086596 -30086992, 30087165, 30087509, 30088229, 30090568, 30092280, 30092859 -30094929, 30095591, 30095952, 30097092, 30097115, 30098251, 30099302 -30099420, 30099454, 30100354, 30101186, 30102774, 30103551, 30103553 -30104348, 30104378, 30104555, 30106748, 30106901, 30108012, 30109365 -30110224, 30110370, 30110518, 30114477, 30114489, 30114534, 30116085 -30116203, 30116854, 30117209, 30117335, 30117469, 30117593, 30118261 -30118279, 30120608, 30122523, 30122583, 30123138, 30125765, 30126145 -30126470, 30127145, 30127522, 30127805, 30127904, 30128047, 30130240 -30131286, 30131645, 30132708, 30133841, 30134746, 30135396, 30135731 -30135942, 30136346, 30137792, 30139392, 30142907, 30143470, 30143593 -30146593, 30146969, 30147195, 30147307, 30147473, 30147928, 30148929 -30148999, 30149035, 30149658, 30150606, 30150710, 30153552, 30153885 -30154633, 30155241, 30155489, 30155814, 30155837, 30155999, 30156569 -30157526, 30158313, 30159329, 30159511, 30159536, 30159752, 30159760 -30160625, 30161094, 30163243, 30164714, 30165493, 30165503, 30165897 -30167787, 30169254, 30170104, 30172925, 30173113, 30173370, 30173556 -30174401, 30175291, 30175587, 30177597, 30178250, 30178839, 30178990 -30179038, 30179644, 30180208, 30180643, 30181756, 30182498, 30183367 -30183696, 30183715, 30183920, 30184102, 30185852, 30186319, 30186476 -30186706, 30187627, 30187866, 30189516, 30189535, 30190090, 30191274 -30192691, 30192729, 30192853, 30193165, 30193262, 30193505, 30193506 -30193584, 30193736, 30194612, 30194710, 30194972, 30195667, 30195668 -30195684, 30196195, 30196358, 30196629, 30198239, 30198861, 30198905 -30199890, 30200034, 30200132, 30200237, 30200680, 30200758, 30202349 -30202388, 30203929, 30204042, 30204542, 30206493, 30206675, 30207473 -30208327, 30208690, 30208723, 30209222, 30209736, 30210429, 30210753 -30210884, 30213031, 30213540, 30214769, 30214826, 30215130, 30215302 -30215351, 30217206, 30217562, 30217982, 30218044, 30218317, 30219222 -30221237, 30221298, 30222512, 30222669, 30222975, 30223712, 30223847 -30224544, 30224650, 30224725, 30224868, 30224950, 30225265, 30225439 -30225443, 30225718, 30225844, 30226244, 30228567, 30229683, 30232638 -30233934, 30234132, 30234227, 30235919, 30235979, 30236554, 30236964 -30237477, 30238211, 30238715, 30239480, 30240010, 30240547, 30240858 -30240930, 30240972, 30241567, 30241807, 30241920, 30242120, 30242724 -30243216, 30244340, 30246053, 30246179, 30247305, 30248531, 30249432 -30251003, 30252005, 30252098, 30252156, 30252458, 30252977, 30253035 -30253090, 30253608, 30253705, 30253835, 30254206, 30254525, 30254576 -30254726, 30255143, 30255528, 30256542, 30257412, 30257908, 30259120 -30259469, 30260595, 30264405, 30265523, 30265608, 30265615, 30265703 -30266791, 30267155, 30269428, 30269748, 30270647, 30270744, 30271114 -30272329, 30274090, 30274188, 30274324, 30274662, 30275548, 30275569 -30275578, 30276144, 30276243, 30277120, 30277451, 30277589, 30277733 -30277887, 30278402, 30281428, 30282501, 30282591, 30282918, 30283296 -30283577, 30283579, 30283581, 30283932, 30284219, 30284369, 30285026 -30285166, 30285251, 30285457, 30285540, 30285843, 30288343, 30288491 -30289074, 30289458, 30292305, 30293345, 30294267, 30294465, 30294671 -30295110, 30295137, 30295549, 30295790, 30295808, 30297905, 30299367 -30299817, 30299934, 30300030, 30300342, 30300363, 30300523, 30300538 -30305264, 30305395, 30305568, 30305880, 30307814, 30307883, 30308368 -30308624, 30308772, 30308947, 30309098, 30309798, 30311826, 30312094 -30312546, 30313749, 30313848, 30313989, 30314079, 30314198, 30314837 -30316667, 30316897, 30317209, 30317397, 30318638, 30318943, 30319080 -30319099, 30320029, 30321076, 30321398, 30322980, 30323658, 30323849 -30324180, 30324466, 30325407, 30326882, 30327149, 30327810, 30328168 -30328690, 30329209, 30329751, 30330123, 30331356, 30331759, 30332505 -30334484, 30334563, 30335127, 30335832, 30335987, 30336032, 30336383 -30336530, 30336742, 30336996, 30337245, 30338591, 30339103, 30341713 -30342371, 30342878, 30344614, 30345201, 30345432, 30345809, 30345926 -30346330, 30346867, 30347410, 30349714, 30350177, 30350543, 30352532 -30352581, 30352623, 30352715, 30355490, 30357463, 30357698, 30357897 -30358416, 30359614, 30360383, 30361635, 30362003, 30362850, 30363088 -30363311, 30363716, 30364329, 30364481, 30364613, 30365745, 30367193 -30368048, 30368482, 30368534, 30368668, 30368917, 30371264, 30371623 -30371909, 30372081, 30373419, 30373550, 30374345, 30374570, 30374739 -30375109, 30376986, 30377347, 30377692, 30380907, 30381207, 30381525 -30382646, 30382982, 30383286, 30384121, 30384152, 30387628, 30387666 -30388853, 30389229, 30389414, 30389507, 30389821, 30390635, 30391272 -30392011, 30392870, 30392987, 30393110, 30393653, 30394738, 30394974 -30396120, 30396946, 30397100, 30398257, 30398422, 30399906, 30402386 -30403412, 30403763, 30403881, 30403902, 30403989, 30404117, 30404153 -30404639, 30406709, 30408515, 30408808, 30409207, 30409339, 30409472 -30409590, 30412188, 30412772, 30412863, 30412885, 30412921, 30413137 -30413294, 30414491, 30414679, 30414714, 30416034, 30416603, 30417648 -30417732, 30419024, 30421026, 30421204, 30421439, 30421476, 30421706 -30422487, 30423135, 30423218, 30424347, 30430921, 30431274, 30431504 -30431698, 30431703, 30431717, 30431867, 30433177, 30436399, 30437003 -30437149, 30439985, 30440651, 30441277, 30441687, 30441959, 30442266 -30442749, 30442884, 30443393, 30446583, 30446820, 30447060, 30447589 -30447994, 30448182, 30448917, 30449194, 30449837, 30450787, 30453442 -30454090, 30457633, 30458568, 30458593, 30460095, 30460922, 30461123 -30461458, 30463938, 30464250, 30464655, 30466081, 30469777, 30472891 -30473634, 30474167, 30474774, 30475115, 30476768, 30477588, 30477685 -30477691, 30477767, 30479252, 30479715, 30480872, 30483065, 30483140 -30483521, 30484042, 30484801, 30485255, 30486436, 30486896, 30487387 -30489582, 30490014, 30490578, 30492380, 30493518, 30494259, 30494900 -30495035, 30495078, 30495133, 30495483, 30496957, 30497057, 30497765 -30498824, 30500224, 30500297, 30500344, 30500582, 30501574, 30502415 -30503943, 30505029, 30505497, 30506794, 30506991, 30507032, 30508100 -30509277, 30510347, 30510527, 30512690, 30513285, 30513480, 30513848 -30515886, 30516868, 30517214, 30517516, 30517635, 30518349, 30519188 -30522285, 30522998, 30523137, 30523538, 30523601, 30523750, 30524736 -30528547, 30528687, 30528704, 30528935, 30529790, 30529940, 30530585 -30532811, 30533132, 30534351, 30534549, 30534662, 30534827, 30536237 -30537405, 30537533, 30537584, 30539519, 30540109, 30540407, 30544247 -30544595, 30544629, 30545281, 30545556, 30549255, 30549368, 30549637 -30549789, 30549881, 30551000, 30551123, 30554178, 30556326, 30556581 -30556807, 30557386, 30558561, 30559252, 30560365, 30560513, 30561404 -30561590, 30561737, 30564139, 30564343, 30564898, 30565004, 30565595 -30565805, 30566054, 30567372, 30571306, 30573236, 30573703, 30576112 -30576393, 30576853, 30577071, 30577591, 30578221, 30579051, 30580813 -30581448, 30582221, 30582500, 30588738, 30591028, 30591475, 30592859 -30593046, 30593104, 30593863, 30594167, 30595114, 30595408, 30595860 -30596488, 30596694, 30598682, 30598746, 30598919, 30599405, 30599407 -30600173, 30600184, 30602230, 30602828, 30605215, 30605676, 30606345 -30606451, 30608583, 30609799, 30610406, 30610667, 30611603, 30612199 -30613937, 30613971, 30614411, 30616406, 30616738, 30619138, 30619525 -30619728, 30619787, 30620805, 30621255, 30622528, 30622755, 30623138 -30623142, 30624243, 30624792, 30624864, 30624874, 30625121, 30628834 -30628899, 30629139, 30629643, 30629799, 30631393, 30631523, 30633259 -30633938, 30634548, 30635183, 30635302, 30635326, 30637270, 30637319 -30641541, 30641755, 30641900, 30644530, 30644766, 30644889, 30645896 -30647133, 30650404, 30651231, 30651570, 30651621, 30651674, 30652515 -30652853, 30654558, 30655906, 30657196, 30657365, 30657566, 30657624 -30657706, 30657875, 30657906, 30657940, 30658533, 30658555, 30658702 -30659940, 30660412, 30661000, 30661939, 30662651, 30662736, 30663646 -30665399, 30668407, 30670328, 30670584, 30671720, 30671813, 30671958 -30674373, 30674959, 30676209, 30677633, 30679595, 30679771, 30681462 -30681516, 30681521, 30684902, 30686017, 30686131, 30687047, 30689557 -30690686, 30691604, 30691731, 30691857, 30692462, 30692473, 30693791 -30694947, 30696566, 30698289, 30703610, 30704826, 30705448, 30708735 -30710807, 30711370, 30712670, 30713133, 30714151, 30714715, 30716863 -30718841, 30718862, 30719327, 30719419, 30720736, 30720844, 30722705 -30723671, 30724679, 30724881, 30727701, 30727759, 30729278, 30729604 -30730026, 30732711, 30734707, 30735153, 30735736, 30739876, 30740669 -30740997, 30741263, 30748707, 30749644, 30749722, 30750219, 30750991 -30751521, 30751527, 30751639, 30751968, 30753432, 30755348, 30758836 -30758854, 30758943, 30761871, 30761878, 30763272, 30763305, 30763639 -30763754, 30764405, 30764663, 30765486, 30765995, 30767277, 30768636 -30769312, 30770717, 30773164, 30773797, 30776416, 30776929, 30777759 -30778855, 30779240, 30781032, 30781041, 30782266, 30782300, 30782414 -30783395, 30783551, 30785101, 30786237, 30786641, 30786655, 30788973 -30789904, 30790441, 30801296, 30801510, 30803210, 30804646, 30806757 -30806984, 30807723, 30807888, 30808869, 30809087, 30810765, 30812574 -30814266, 30814285, 30815495, 30815852, 30816760, 30816938, 30819340 -30819629, 30821297, 30823744, 30825391, 30825419, 30825656, 30826474 -30828350, 30829779, 30830555, 30832775, 30833454, 30834068, 30834110 -30835184, 30835853, 30836129, 30838605, 30839451, 30839836, 30841241 -30842277, 30843271, 30844839, 30846063, 30846782, 30847442, 30847871 -30848028, 30848097, 30848773, 30851448, 30851951, 30852954, 30855101 -30856358, 30857501, 30857721, 30858877, 30858919, 30860803, 30861988 -30863115, 30864607, 30865805, 30866141, 30866988, 30869131, 30870439 -30871716, 30871792, 30873527, 30874270, 30874337, 30874660, 30879169 -30879708, 30880774, 30880913, 30881407, 30883715, 30883785, 30883877 -30886188, 30887501, 30887777, 30889443, 30889607, 30889723, 30890720 -30890971, 30891760, 30891792, 30895426, 30895577, 30896620, 30896685 -30898381, 30898748, 30898939, 30902655, 30904672, 30906274, 30906407 -30909596, 30909918, 30910264, 30913399, 30914272, 30914674, 30915781 -30919587, 30919691, 30919804, 30921136, 30922936, 30922996, 30923514 -30923517, 30923597, 30923940, 30925316, 30927821, 30930149, 30930339 -30931311, 30931981, 30932674, 30936251, 30936831, 30936942, 30937340 -30937391, 30937410, 30938413, 30939307, 30939317, 30939934, 30940259 -30940868, 30940869, 30941056, 30944643, 30945005, 30946072, 30946768 -30946876, 30952104, 30952191, 30953266, 30953836, 30956571, 30956647 -30957739, 30960356, 30960736, 30964194, 30965554, 30965649, 30968737 -30968781, 30970518, 30972817, 30972841, 30972887, 30972947, 30972951 -30972959, 30972966, 30973085, 30973113, 30973127, 30973137, 30973143 -30973197, 30973698, 30973877, 30974813, 30977411, 30978554, 30980115 -30980317, 30980733, 30981240, 30985027, 30985906, 30987088, 30988444 -30990034, 30992330, 30992597, 30993198, 30993518, 30994996, 30996991 -30997375, 30998035, 30998662, 30998759, 30998847, 31001017, 31001455 -31001490, 31001859, 31002223, 31002923, 31003137, 31003659, 31004077 -31004719, 31004844, 31006792, 31008240, 31008907, 31009545, 31009590 -31009680, 31010218, 31010976, 31011361, 31013127, 31014323, 31015330 -31016413, 31019249, 31021068, 31021157, 31021324, 31021542, 31022858 -31025520, 31025531, 31025859, 31026220, 31026591, 31026860, 31027747 -31028986, 31029936, 31030898, 31031955, 31032904, 31034794, 31035287 -31035916, 31037421, 31038220, 31038447, 31039627, 31039928, 31042208 -31043483, 31043630, 31044145, 31044951, 31045929, 31046188, 31046619 -31047022, 31047169, 31048025, 31048741, 31049215, 31051056, 31051075 -31052735, 31052809, 31055142, 31056909, 31058548, 31061482, 31061504 -31062010, 31063380, 31063769, 31064025, 31065838, 31066082, 31066250 -31066265, 31066554, 31067892, 31069059, 31071080, 31073586, 31074032 -31075323, 31075960, 31077117, 31077365, 31078391, 31078757, 31079204 -31080474, 31081558, 31084921, 31086869, 31087361, 31087679, 31088115 -31088341, 31089270, 31090262, 31091868, 31092129, 31092233, 31092581 -31092921, 31094183, 31094228, 31094688, 31096846, 31097760, 31097961 -31100172, 31101386, 31103065, 31104809, 31106140, 31106577, 31107577 -31109506, 31112530, 31112972, 31113089, 31113249, 31114265, 31114671 -31115201, 31115502, 31118809, 31119057, 31119846, 31120361, 31122876 -31124363, 31124914, 31125773, 31126053, 31126058, 31127043, 31127457 -31127969, 31130156, 31132732, 31134430, 31138106, 31139643, 31141792 -31142749, 31145403, 31145804, 31153120, 31153485, 31155634, 31156383 -31158341, 31158380, 31159382, 31162711, 31162915, 31163379, 31165038 -31165577, 31165722, 31168440, 31171096, 31171631, 31172207, 31172642 -31175365, 31177193, 31177204, 31177221, 31178103, 31180519, 31181380 -31182159, 31182756, 31182793, 31185224, 31188038, 31188398, 31190624 -31192039, 31193292, 31193936, 31194264, 31195090, 31195430, 31195838 -31200845, 31201001, 31201366, 31202536, 31204412, 31204878, 31208287 -31213034, 31214119, 31215422, 31215438, 31216995, 31217946, 31218837 -31219047, 31219975, 31220549, 31220881, 31220912, 31221454, 31222780 -31223382, 31226448, 31228670, 31230775, 31233170, 31234765, 31234790 -31235797, 31240626, 31244968, 31249008, 31249406, 31249696, 31254297 -31254535, 31254929, 31255369, 31255869, 31257740, 31258101, 31258995 -31260692, 31261641, 31265651, 31265773, 31268557, 31270711, 31271032 -31287871, 31289115, 31290300, 31292298, 31293484, 31298871, 31301460 -31303032, 31304573, 31305114, 31305624, 31306248, 31306261, 31306867 -31306927, 31309379, 31309867, 31310564, 31310624, 31311830, 31312450 -31312976, 31313117, 31313444, 31314885, 31315495, 31315876, 31316250 -31321092, 31322720, 31325584, 31326608, 31326977, 31326998, 31327259 -31327278, 31327349, 31327391, 31327896, 31331354, 31331372, 31333156 -31334606, 31334961, 31335037, 31335142, 31336298, 31338249, 31338673 -31338769, 31339457, 31339643, 31339744, 31343110, 31344046, 31348711 -31350348, 31353610, 31356601, 31357581, 31357737, 31358308, 31359215 -31359366, 31360146, 31360323, 31360469, 31360529, 31366716, 31367188 -31367364, 31369444, 31372498, 31373825, 31373837, 31373843, 31376708 -31377129, 31377487, 31377808, 31380443, 31381701, 31383396, 31383464 -31383814, 31386394, 31387426, 31387443, 31388288, 31390936, 31391991 -31393600, 31394341, 31394347, 31394365, 31395247, 31396027, 31396695 -31398663, 31399131, 31401831, 31402078, 31403177, 31403565, 31404014 -31404130, 31404263, 31408636, 31409483, 31411163, 31414023, 31414524 -31417192, 31421316, 31422620, 31424838, 31425167, 31425761, 31429501 -31429590, 31429770, 31430722, 31431005, 31433092, 31433579, 31434805 -31434870, 31437030, 31440426, 31440813, 31442332, 31442714, 31444353 -31444516, 31446431, 31447733, 31448680, 31449354, 31450392, 31450653 -31454972, 31455597, 31458049, 31466433, 31468060, 31475635, 31476093 -31476736, 31477424, 31477695, 31479272, 31479772, 31483949, 31484385 -31484603, 31485386, 31485507, 31486557, 31487441, 31487491, 31489137 -31490604, 31491634, 31493840, 31494264, 31496174, 31498559, 31499370 -31499700, 31500971, 31501139, 31503349, 31507107, 31508712, 31509279 -31510891, 31512044, 31513011, 31523548, 31525783, 31526903, 31527103 -31527199, 31528962, 31533274, 31533817, 31533833, 31535955, 31536401 -31536731, 31537521, 31539566, 31541864, 31544097, 31545477, 31546864 -31547220, 31548675, 31549221, 31553674, 31553813, 31555539, 31557663 -31559085, 31560592, 31561886, 31567124, 31567441, 31570054, 31570161 -31572006, 31572267, 31574244, 31574267, 31576738, 31577569, 31578994 -31581627, 31585351, 31585789, 31586381, 31591384, 31591400, 31591409 -31591421, 31595632, 31597727, 31600023, 31600894, 31601385, 31603199 -31605119, 31607937, 31609974, 31616104, 31620748, 31625579, 31625618 -31626572, 31627587, 31628311, 31628753, 31630551, 31633224, 31637607 -31637680, 31640240, 31644775, 31648120, 31649819, 31650202, 31652641 -31653080, 31655807, 31658464, 31658943, 31661865, 31663189, 31663788 -31668061, 31668694, 31668872, 31670014, 31670353, 31672605, 31674380 -31675568, 31676941, 31677460, 31682766, 31683044, 31684494, 31686979 -31688978, 31691030, 31695062, 31696577, 31697741, 31700234, 31701910 -31706595, 31707190, 31708133, 31709647, 31709739, 31709777, 31711889 -31711997, 31715935, 31718134, 31718346, 31721863, 31721880, 31722646 -31723651, 31727560, 31728160, 31734583, 31735662, 31743771, 31747935 -31747989, 31748000, 31748944, 31752502, 31753202, 31753425, 31753692 -31754887, 31755245, 31756415, 31757357, 31757775, 31757824, 31758083 -31758846, 31760592, 31763707, 31764866, 31765257, 31765296, 31766696 -31767237, 31769373, 31770289, 31771370, 31771410, 31771468, 31775101 -31776994, 31781897, 31783451, 31783782, 31785445, 31786838, 31787655 -31788704, 31788761, 31790500, 31792465, 31792615, 31793713, 31796208 -31796277, 31796882, 31798742, 31800757, 31807516, 31815099, 31816158 -31816631, 31820632, 31820859, 31823051, 31827605, 31827912, 31829617 -31829639, 31833172, 31833948, 31835854, 31836454, 31839779, 31842545 -31843462, 31847489, 31849859, 31851383, 31852574, 31854692, 31855526 -31860193, 31862359, 31863118, 31866141, 31867037, 31869601, 31871692 -31872230, 31876368, 31878314, 31880154, 31881527, 31883124, 31886547 -31886695, 31887130, 31888148, 31888731, 31889222, 31895670, 31897786 -31897854, 31900585, 31903523, 31904933, 31905033, 31907137, 31907565 -31909295, 31913650, 31921267, 31927930, 31935717, 31942144, 31943497 -31952052, 31953989, 31958958, 31961940, 31965542, 31974597, 31974693 -31986836, 31988079, 31991705, 31996264, 32002411, 32003551, 32005048 -32007698, 32008586, 32010707, 32017301, 32032733, 32032887, 32048412 -32050048, 32057639, 32061648, 32069696, 32069834, 32079739, 32082098 -32089820, 32097882, 32101305, 32113113, 32118727, 32121326, 32129659 -32130083, 32130504, 32150818, 32165759, 32169151, 32172777, 32174571 -32207088, 32212635, 32221141, 32234161, 32290399, 32296941, 32321765 -``` - -## Version 19\.0\.0\.0\.ru\-2021\-01\.rur\-2021\-01\.r1 - -**Important** -We recommend that you upgrade your DB instance to 19\.0\.0\.0\.ru\-2021\-01\.rur\-2021\-01\.r2 rather than to 19\.0\.0\.0\.ru\-2021\-01\.rur\-2021\-01\.r1\. The application of the patch for minor engine upgrades to 19\.0\.0\.0\.ru\-2021\-01\.rur\-2021\-01\.r1 encountered an issue\. Release update 19\.10\.0\.0\.210119 \(32218454\) didn't register correctly in the `DBA_REGISTRY_SQLPATCH` table\. - -Version 19\.0\.0\.0\.ru\-2021\-01\.rur\-2021\-01\.r1 includes the following: -+ Patch 32218454: DATABASE RELEASE UPDATE 19\.10\.0\.0\.210119 -+ Patch 32067171: OJVM RELEASE UPDATE 19\.10\.0\.0\.210119 -+ Patch 31335037: RDBMS \- DSTV35 UPDATE \- TZDATA2020A -+ Patch 31335142: DSTV35 UPDATE \- TZDATA2020A \- NEED OJVM FIX -+ Patch 29213893: DBMS\_STATS FAILING WITH ERROR ORA\-01422 WHEN GATHERING STATS FOR USER TABLE -+ Patch 29782284: ORA\-06508:"MDSYS\.MDPRVT\_IDX" WHILE UPGRADING DATABASE TO 18\.3 -+ Patch 28730253: SUPPORT NEW ERA REIWA FOR JAPANESE IMPERIAL CALENDAR -+ Patch 29374604: IE not starting against 18c Oracle RDBMS Standard Edition -+ PreUpgrade Jar: preupgrade\_19\_cbuild\_9\_lf\.zip -+ Support for [Managing advisor tasks](Appendix.Oracle.CommonDBATasks.Misc.md#Appendix.Oracle.CommonDBATasks.managing-advisor-tasks) using procedures in the `rdsadmin.rdsadmin_util` package - -### Combined patches for version 19\.0\.0\.0\.ru\-2021\-01\.rur\-2021\-01\.r1, released January 2021 - -Bugs fixed: - -``` -7391838, 8460502, 8476681, 14735102, 16664572, 17428816, 17468475 -19080742, 19138896, 19697993, 20313356, 20867658, 21232786, 21374587 -21528318, 21629064, 21639146, 21888352, 21965541, 22580355, 22729345 -22748979, 23294761, 23296836, 23606241, 23645975, 23734075, 23763462 -24596874, 24669730, 24687075, 24833686, 24957575, 24971456, 25030027 -25092651, 25093917, 25404117, 25416731, 25560538, 25607406, 25756945 -25792962, 25804387, 25806201, 25809128, 25883179, 25905368, 25986062 -25997810, 26001677, 26127355, 26173091, 26284288, 26352615, 26440142 -26476244, 26499997, 26611353, 26668264, 26716835, 26739322, 26777814 -26819036, 26872233, 27004828, 27036163, 27044169, 27101798, 27126122 -27126938, 27130348, 27166935, 27195575, 27195935, 27221350, 27222128 -27244999, 27254335, 27260704, 27261477, 27359766, 27362994, 27369515 -27378053, 27392968, 27406105, 27411022, 27423500, 27439716, 27453490 -27458357, 27489107, 27572040, 27582210, 27589260, 27604329, 27622946 -27629928, 27661222, 27666312, 27684864, 27692173, 27700413, 27710072 -27729678, 27742354, 27745728, 27760043, 27801144, 27828892, 27829722 -27846298, 27873364, 27877830, 27880025, 27929509, 27934711, 27935464 -27941110, 27957203, 27967484, 27998559, 28007516, 28064977, 28072567 -28078186, 28092783, 28104176, 28109326, 28125947, 28127569, 28129791 -28133903, 28138847, 28144569, 28145995, 28181021, 28187837, 28189466 -28204262, 28205555, 28209985, 28210681, 28263142, 28271258, 28271693 -28276054, 28279456, 28294563, 28302580, 28313275, 28319114, 28322973 -28326928, 28338211, 28350595, 28370061, 28371123, 28373960, 28375383 -28379065, 28381939, 28386259, 28390273, 28395302, 28397317, 28402823 -28403019, 28406374, 28410431, 28431445, 28435333, 28436414, 28442896 -28454215, 28463226, 28470673, 28475242, 28482048, 28484299, 28489419 -28492006, 28498976, 28502773, 28504631, 28513333, 28521330, 28530171 -28534475, 28535127, 28537481, 28538439, 28541606, 28542455, 28546290 -28547068, 28547926, 28558645, 28561704, 28564479, 28565296, 28567417 -28567819, 28569897, 28572407, 28572533, 28572544, 28572667, 28572834 -28578945, 28587723, 28589509, 28593682, 28594086, 28597221, 28601957 -28602253, 28605066, 28606598, 28608211, 28612239, 28618343, 28620697 -28621543, 28622202, 28625580, 28625862, 28627033, 28628592, 28630381 -28632796, 28636532, 28639299, 28640772, 28642469, 28642899, 28643583 -28643654, 28643718, 28644549, 28645570, 28646200, 28646939, 28649388 -28655209, 28661333, 28663289, 28663782, 28672457, 28673945, 28681153 -28689483, 28690694, 28692103, 28692275, 28694639, 28694872, 28696373 -28697526, 28698087, 28699321, 28700945, 28703812, 28705231, 28707931 -28708400, 28709063, 28710385, 28710469, 28710663, 28710734, 28714461 -28715655, 28715727, 28718469, 28719348, 28720204, 28720418, 28721497 -28722229, 28730079, 28730253, 28734355, 28740708, 28740799, 28742555 -28745367, 28749853, 28751498, 28752923, 28755011, 28755084, 28755846 -28758722, 28760206, 28763291, 28765983, 28767240, 28769456, 28771947 -28772390, 28772816, 28774416, 28776431, 28776811, 28777214, 28778754 -28781599, 28781754, 28785273, 28785321, 28785531, 28789531, 28791852 -28793062, 28794230, 28795551, 28795734, 28800508, 28802734, 28804517 -28805242, 28806517, 28808314, 28808652, 28808656, 28810381, 28811560 -28813931, 28815123, 28815355, 28815557, 28816871, 28817449, 28818063 -28819640, 28820669, 28821847, 28824482, 28827682, 28831971, 28833912 -28835937, 28836716, 28837979, 28838385, 28844738, 28845346, 28846759 -28847541, 28847572, 28849776, 28850084, 28852325, 28854004, 28854733 -28855520, 28855922, 28857552, 28861861, 28862532, 28863263, 28863432 -28863487, 28865569, 28867698, 28867992, 28870496, 28871040, 28872645 -28872829, 28873575, 28874416, 28875089, 28876253, 28876639, 28876926 -28877252, 28878865, 28881191, 28881848, 28882784, 28884931, 28887305 -28888083, 28888327, 28889389, 28889730, 28892794, 28897123, 28897512 -28899663, 28900506, 28901126, 28905390, 28905457, 28905615, 28907196 -28910498, 28910586, 28911140, 28912691, 28915561, 28917080, 28918429 -28919145, 28921844, 28922227, 28922532, 28922608, 28925250, 28925460 -28925634, 28925880, 28927452, 28928462, 28932914, 28933158, 28935293 -28935956, 28936114, 28937717, 28938422, 28938698, 28940179, 28940281 -28940472, 28941901, 28942455, 28942694, 28945421, 28945994, 28946233 -28948554, 28949888, 28950868, 28951332, 28951533, 28952168, 28954762 -28955606, 28955883, 28956908, 28957260, 28957292, 28957723, 28958088 -28959493, 28960863, 28962775, 28963036, 28965084, 28965095, 28965231 -28965376, 28966444, 28968779, 28974083, 28974999, 28977322, 28980448 -28981871, 28983095, 28983486, 28984313, 28985114, 28985272, 28985362 -28985478, 28986207, 28986231, 28986257, 28986326, 28986481, 28986696 -28988482, 28988864, 28989306, 28993295, 28993353, 28994307, 28994542 -28995287, 28996376, 28999046, 29000000, 29001305, 29001888, 29002488 -29002784, 29002927, 29003207, 29003407, 29003617, 29003738, 29006318 -29006621, 29007321, 29007353, 29007775, 29008035, 29008669, 29009513 -29010126, 29010517, 29011936, 29012609, 29013475, 29013832, 29014076 -29015118, 29016294, 29017265, 29018655, 29018680, 29019121, 29020423 -29021063, 29021352, 29022986, 29024028, 29024054, 29024448, 29024552 -29024732, 29024876, 29026154, 29026582, 29026606, 29027456, 29027694 -29027933, 29027940, 29030184, 29030927, 29031575, 29031600, 29032234 -29032276, 29032457, 29032607, 29033052, 29033145, 29033200, 29033280 -29034587, 29036278, 29037290, 29038528, 29038728, 29039089, 29039510 -29040739, 29041739, 29041775, 29043554, 29043651, 29043725, 29044086 -29044763, 29044954, 29046482, 29047127, 29047850, 29048178, 29048289 -29048498, 29048605, 29048728, 29049673, 29050357, 29050560, 29050765 -29050886, 29051263, 29051702, 29051953, 29052726, 29052850, 29053783 -29053902, 29055644, 29056024, 29056270, 29056560, 29056767, 29056894 -29058476, 29059011, 29060216, 29061016, 29061959, 29062692, 29062848 -29062860, 29062868, 29110526, 29110783, 29110790, 29110797, 29110802 -29110805, 29111598, 29111631, 29112455, 29113282, 29113305, 29115857 -29117337, 29117526, 29117642, 29118543, 29119077, 29120223, 29122224 -29122254, 29122367, 29123297, 29123432, 29123444, 29123482, 29124368 -29125036, 29125374, 29125380, 29125708, 29125786, 29126345, 29127957 -29128693, 29128935, 29129450, 29129476, 29129497, 29129691, 29129712 -29130219, 29131539, 29131772, 29132456, 29132869, 29132938, 29133470 -29134447, 29135383, 29135649, 29136111, 29138641, 29139070, 29139727 -29139761, 29139956, 29141316, 29141341, 29141685, 29141886, 29142609 -29142667, 29143516, 29144995, 29145214, 29145730, 29146077, 29146157 -29146810, 29147849, 29148799, 29149170, 29149829, 29150338, 29151520 -29152357, 29152603, 29152752, 29154631, 29154636, 29154725, 29154829 -29155099, 29157051, 29157389, 29158680, 29158899, 29159216, 29159661 -29159909, 29159936, 29160174, 29160462, 29161597, 29161923, 29162095 -29163073, 29163156, 29163415, 29163437, 29163524, 29163567, 29164376 -29165682, 29167111, 29167342, 29167374, 29167940, 29168137, 29168219 -29168433, 29169073, 29169215, 29169540, 29169739, 29170232, 29170717 -29171683, 29171942, 29172618, 29172826, 29173140, 29173373, 29173618 -29173817, 29174004, 29174753, 29175638, 29176318, 29177466, 29177543 -29177886, 29178385, 29179097, 29180313, 29180455, 29180559, 29180721 -29180893, 29181078, 29181153, 29181231, 29181568, 29181620, 29181743 -29181923, 29182019, 29182517, 29182901, 29182920, 29183298, 29183912 -29184297, 29184666, 29185193, 29186091, 29186456, 29186605, 29188255 -29189302, 29189307, 29189889, 29190235, 29190474, 29190663, 29190740 -29191541, 29191827, 29192419, 29192468, 29192685, 29193207, 29194205 -29194367, 29194493, 29194827, 29194981, 29195279, 29195337, 29195758 -29196725, 29198092, 29198913, 29199163, 29199635, 29199733, 29200316 -29200700, 29201143, 29201494, 29201539, 29201695, 29201787, 29202104 -29202461, 29202850, 29203041, 29203122, 29203166, 29203227, 29203425 -29203443, 29203604, 29205281, 29205323, 29205419, 29205463, 29205767 -29205918, 29206109, 29206605, 29207073, 29208260, 29208732, 29209545 -29210577, 29210610, 29210624, 29210683, 29211457, 29211724, 29212012 -29212433, 29212611, 29213320, 29213351, 29213613, 29213641, 29213775 -29213850, 29213879, 29213893, 29214561, 29214960, 29216312, 29216723 -29216746, 29216984, 29217294, 29217472, 29217828, 29217848, 29217856 -29218570, 29219205, 29219273, 29219627, 29220079, 29221248, 29221891 -29221942, 29222031, 29222784, 29223833, 29223859, 29223967, 29224065 -29224294, 29224605, 29224710, 29225076, 29225168, 29225758, 29225861 -29227602, 29228869, 29229164, 29229754, 29229839, 29229844, 29229955 -29230252, 29230565, 29231133, 29232117, 29232154, 29232449, 29232653 -29233415, 29233810, 29233953, 29234123, 29235934, 29236573, 29237538 -29237575, 29237744, 29240307, 29240668, 29240759, 29241345, 29241651 -29242017, 29242884, 29242906, 29243749, 29243958, 29244495, 29244766 -29244968, 29245063, 29245137, 29245160, 29246163, 29247183, 29247415 -29247712, 29247906, 29248495, 29248552, 29248723, 29248835, 29248858 -29249289, 29249412, 29249583, 29249991, 29250059, 29250317, 29251259 -29251564, 29253184, 29253871, 29254031, 29254623, 29254930, 29255178 -29255273, 29255431, 29255435, 29255616, 29255705, 29255718, 29255973 -29256426, 29259119, 29259320, 29260224, 29260452, 29260956, 29261547 -29261548, 29261695, 29261906, 29262512, 29262887, 29265448, 29266248 -29266899, 29267292, 29268412, 29269171, 29269228, 29269825, 29270585 -29271019, 29273168, 29273360, 29273539, 29273570, 29273735, 29273812 -29273847, 29274428, 29274564, 29274627, 29275461, 29276272, 29277317 -29278218, 29278684, 29279658, 29279751, 29279854, 29281112, 29281527 -29281691, 29281796, 29282090, 29282233, 29282666, 29282898, 29285197 -29285453, 29285503, 29285621, 29285788, 29285956, 29286037, 29286220 -29286229, 29287130, 29287705, 29290110, 29290235, 29292232, 29292837 -29293072, 29293574, 29293806, 29294753, 29296257, 29297863, 29297915 -29298220, 29299049, 29299082, 29299830, 29299844, 29301463, 29301566 -29302565, 29302614, 29302963, 29303918, 29304314, 29304692, 29304781 -29304853, 29305093, 29306226, 29306713, 29307090, 29307109, 29307638 -29309698, 29311336, 29311528, 29311588, 29311927, 29312310, 29312672 -29312734, 29312753, 29312889, 29313347, 29313417, 29313525, 29314539 -29314636, 29317756, 29318410, 29319441, 29320900, 29321489, 29321689 -29323946, 29324568, 29324735, 29325087, 29325105, 29325257, 29325765 -29325993, 29326233, 29327044, 29327892, 29329042, 29329087, 29329675 -29329807, 29329848, 29330361, 29330791, 29331066, 29331209, 29331380 -29331493, 29332292, 29332395, 29332763, 29332771, 29333500, 29336843 -29336899, 29337294, 29337310, 29337742, 29338315, 29338348, 29338453 -29338780, 29338913, 29339101, 29339155, 29339299, 29340333, 29341209 -29342099, 29343086, 29343156, 29343861, 29344541, 29345937, 29346057 -29346211, 29346943, 29347620, 29348176, 29348358, 29350052, 29350712 -29350762, 29350868, 29351044, 29351386, 29351662, 29351716, 29351735 -29351749, 29351771, 29352298, 29352724, 29352867, 29352947, 29353271 -29353432, 29353718, 29353821, 29353960, 29355654, 29356547, 29356704 -29356711, 29356752, 29356782, 29357821, 29358509, 29358828, 29360252 -29360285, 29360467, 29360672, 29360775, 29360911, 29360950, 29361319 -29361472, 29361801, 29362596, 29363151, 29364171, 29364177, 29366406 -29366940, 29367019, 29367561, 29367971, 29368253, 29368310, 29368725 -29372069, 29372541, 29372562, 29373418, 29373588, 29374179, 29374604 -29375355, 29375941, 29375984, 29376346, 29377804, 29377986, 29378029 -29378287, 29378834, 29378913, 29379299, 29379381, 29379750, 29379978 -29380527, 29381000, 29382296, 29382641, 29382784, 29382815, 29383695 -29384781, 29384854, 29384864, 29385339, 29385429, 29385652, 29386502 -29386557, 29386635, 29386660, 29386835, 29387073, 29387274, 29387310 -29387337, 29388020, 29388072, 29388094, 29388524, 29388830, 29389408 -29389889, 29390011, 29390435, 29390785, 29391030, 29391237, 29391301 -29391438, 29391849, 29391925, 29392554, 29392966, 29393291, 29393649 -29394014, 29394140, 29394749, 29395657, 29396481, 29397841, 29397954 -29397996, 29398488, 29398863, 29399046, 29399100, 29399121, 29399336 -29399938, 29402110, 29402131, 29404483, 29405012, 29405462, 29405651 -29405996, 29407488, 29407804, 29408853, 29409149, 29409455, 29410311 -29410834, 29411037, 29411469, 29411931, 29412066, 29412269, 29413360 -29413382, 29413517, 29413544, 29413634, 29413956, 29415493, 29416688 -29416700, 29417084, 29417173, 29417719, 29417884, 29418165, 29418341 -29420254, 29420834, 29421059, 29423003, 29423016, 29423156, 29423491 -29423826, 29424999, 29426241, 29426320, 29428230, 29429017, 29429087 -29429264, 29429466, 29429566, 29429895, 29430524, 29430866, 29431192 -29431402, 29431485, 29432176, 29434301, 29434869, 29435474, 29435652 -29436454, 29436514, 29436522, 29436727, 29437029, 29437379, 29437594 -29437712, 29438150, 29438277, 29438736, 29439522, 29440651, 29441196 -29442400, 29442936, 29443187, 29443250, 29443559, 29444072, 29444282 -29444602, 29445548, 29446319, 29446669, 29448498, 29449477, 29449845 -29449852, 29450162, 29450193, 29450273, 29450421, 29450812, 29450936 -29451085, 29451386, 29452251, 29452576, 29452936, 29452953, 29454450 -29454978, 29455424, 29455773, 29456538, 29456714, 29457312, 29457319 -29457370, 29457502, 29457807, 29457978, 29458132, 29460252, 29461420 -29461791, 29461971, 29462594, 29462767, 29462957, 29463047, 29463528 -29463798, 29464616, 29464779, 29465047, 29465177, 29466674, 29467622 -29469563, 29469565, 29470059, 29470291, 29471633, 29471832, 29471857 -29471860, 29472618, 29473708, 29476473, 29477015, 29481584, 29482021 -29483452, 29483532, 29483626, 29483672, 29483685, 29483712, 29483723 -29483771, 29485099, 29485877, 29486181, 29486848, 29487150, 29487189 -29487407, 29488894, 29489436, 29489546, 29490256, 29491784, 29492127 -29492939, 29493122, 29494245, 29495057, 29495171, 29495684, 29497311 -29497588, 29497696, 29498198, 29500257, 29500826, 29500963, 29501218 -29502561, 29503543, 29503631, 29503827, 29504103, 29504492, 29504682 -29505225, 29505589, 29505668, 29506942, 29507270, 29507616, 29508681 -29509777, 29510278, 29511064, 29511611, 29511980, 29512125, 29512890 -29514479, 29515134, 29515240, 29515476, 29515766, 29515834, 29516300 -29516727, 29516766, 29517168, 29517883, 29518604, 29518767, 29519131 -29521187, 29521688, 29521748, 29521862, 29522358, 29522561, 29522662 -29523055, 29523216, 29523511, 29524599, 29524985, 29525366, 29525467 -29525886, 29526966, 29527595, 29527610, 29528368, 29529147, 29530440 -29530515, 29530812, 29530909, 29531654, 29531836, 29532112, 29532532 -29536342, 29536445, 29536794, 29537829, 29538631, 29539413, 29540327 -29541742, 29541769, 29541973, 29542084, 29542449, 29542580, 29542643 -29543034, 29543956, 29544552, 29546817, 29547010, 29547867, 29548413 -29548427, 29548592, 29548687, 29548722, 29549040, 29549071, 29549104 -29549154, 29549730, 29550530, 29552402, 29552773, 29553141, 29554092 -29555105, 29557144, 29557261, 29557336, 29557556, 29558238, 29558452 -29558926, 29558975, 29559187, 29559395, 29559446, 29559908, 29559981 -29564592, 29564593, 29565611, 29579919, 29580394, 29580983, 29581771 -29584261, 29584693, 29586143, 29587299, 29587720, 29587765, 29588732 -29589544, 29591343, 29591641, 29592011, 29592215, 29597536, 29597716 -29597754, 29598039, 29598046, 29598226, 29598233, 29599008, 29599243 -29599300, 29599552, 29601461, 29602831, 29603460, 29603884, 29604002 -29604257, 29606261, 29607136, 29607797, 29608000, 29608023, 29610506 -29611020, 29611991, 29614206, 29614931, 29614987, 29615824, 29616244 -29616414, 29618074, 29618190, 29620042, 29622936, 29623323, 29623592 -29624124, 29625065, 29625804, 29625876, 29626154, 29626732, 29628200 -29628647, 29629430, 29629650, 29629681, 29629745, 29631749, 29632095 -29632265, 29632611, 29633697, 29633753, 29633936, 29634643, 29635427 -29635717, 29635990, 29637362, 29637526, 29637560, 29638285, 29641736 -29642451, 29643721, 29644426, 29644464, 29645167, 29645349, 29647176 -29647770, 29648928, 29649694, 29651183, 29651520, 29652809, 29653132 -29653246, 29655164, 29655668, 29656400, 29656819, 29656843, 29657399 -29657422, 29657744, 29657960, 29658056, 29661028, 29661065, 29661722 -29663191, 29663368, 29663494, 29663601, 29664087, 29664161, 29665168 -29665940, 29666451, 29667527, 29667994, 29668005, 29669413, 29670713 -29670782, 29671363, 29672507, 29675446, 29676089, 29677051, 29677173 -29677733, 29677927, 29679856, 29680700, 29681987, 29683039, 29683211 -29684518, 29685137, 29685276, 29687214, 29687220, 29687459, 29687718 -29687727, 29687763, 29688867, 29689145, 29689255, 29692694, 29694869 -29695425, 29695821, 29695841, 29695964, 29695987, 29696310, 29697928 -29700125, 29700460, 29700770, 29701720, 29703932, 29705793, 29706160 -29707099, 29707493, 29707896, 29708324, 29708353, 29708876, 29708915 -29710188, 29710858, 29713810, 29715220, 29715703, 29716194, 29716227 -29716491, 29716602, 29716871, 29717659, 29717901, 29718198, 29719146 -29720133, 29720373, 29721418, 29721576, 29722167, 29724658, 29725476 -29725781, 29726695, 29737941, 29738374, 29738400, 29739576, 29741319 -29741976, 29742223, 29744225, 29744400, 29744637, 29745288, 29746962 -29747493, 29747648, 29747653, 29748285, 29748325, 29748336, 29748513 -29749471, 29750673, 29751094, 29753244, 29754196, 29754951, 29755821 -29756274, 29756444, 29757099, 29757264, 29757651, 29757687, 29758203 -29758217, 29758661, 29761678, 29761837, 29761911, 29763158, 29764644 -29765035, 29765219, 29765347, 29765393, 29765493, 29766207, 29766435 -29766503, 29766679, 29768487, 29768899, 29769901, 29770750, 29771032 -29771242, 29772514, 29772761, 29773197, 29773205, 29773842, 29774362 -29775393, 29779196, 29780140, 29782211, 29782284, 29782823, 29782866 -29783142, 29784106, 29785239, 29785311, 29785831, 29787292, 29787766 -29789911, 29791152, 29791880, 29792213, 29792433, 29793318, 29794174 -29794462, 29795712, 29795957, 29796335, 29796378, 29796916, 29797209 -29797726, 29801164, 29802382, 29802695, 29804875, 29805368, 29805772 -29806390, 29806964, 29807964, 29809792, 29809837, 29811616, 29812084 -29812489, 29813503, 29813650, 29813671, 29814995, 29815341, 29815713 -29816887, 29817278, 29817547, 29817784, 29820341, 29821130, 29821582 -29822714, 29825525, 29827647, 29827852, 29828644, 29829339, 29831196 -29833984, 29834506, 29836096, 29838337, 29838485, 29838740, 29838773 -29839715, 29840619, 29841267, 29841687, 29842369, 29843277, 29843692 -29843831, 29844131, 29844226, 29844275, 29845530, 29846126, 29846525 -29846645, 29846688, 29848084, 29848849, 29849100, 29850930, 29851733 -29853485, 29856420, 29856859, 29856890, 29858121, 29858376, 29858420 -29859068, 29860022, 29860994, 29861075, 29864203, 29864261, 29865188 -29865590, 29865658, 29869052, 29869086, 29869149, 29869404, 29869887 -29869906, 29870065, 29870533, 29871098, 29871312, 29871360, 29872401 -29872937, 29872983, 29873665, 29874090, 29874761, 29875200, 29875459 -29875565, 29876358, 29876989, 29877608, 29878076, 29881050, 29881478 -29881575, 29881643, 29881839, 29882427, 29882454, 29882729, 29884958 -29885182, 29885890, 29886809, 29887045, 29887111, 29888621, 29889184 -29889358, 29890740, 29891075, 29891853, 29891916, 29892604, 29893132 -29894021, 29896510, 29897418, 29897863, 29900203, 29900824, 29901419 -29901961, 29902299, 29902327, 29902330, 29902659, 29903190, 29903299 -29903357, 29903454, 29904002, 29906678, 29907942, 29908389, 29908777 -29909658, 29910218, 29910402, 29912135, 29912286, 29913805, 29913966 -29914449, 29914544, 29915217, 29915848, 29916975, 29919789, 29920025 -29920376, 29920804, 29921318, 29922225, 29922461, 29923452, 29924181 -29926466, 29927756, 29928210, 29928340, 29928427, 29928564, 29930457 -29931956, 29932202, 29932310, 29932430, 29932780, 29934048, 29934052 -29935685, 29937565, 29937655, 29937956, 29938225, 29939400, 29939795 -29940373, 29941062, 29942096, 29942275, 29942554, 29943670, 29943879 -29944035, 29944159, 29944660, 29944963, 29945645, 29946388, 29947145 -29947428, 29948165, 29950220, 29951620, 29951759, 29952700, 29956016 -29956222, 29957412, 29957493, 29958925, 29960884, 29961353, 29961360 -29961609, 29961847, 29962160, 29962248, 29962834, 29962927, 29962939 -29965052, 29965603, 29965888, 29966768, 29967223, 29968085, 29969557 -29970081, 29970261, 29970298, 29970587, 29971027, 29971481, 29971888 -29971936, 29971951, 29972134, 29972176, 29973012, 29989783, 29989845 -29990779, 29991257, 29993717, 29997326, 29997553, 29997937, 30000664 -30001105, 30001331, 30003187, 30004660, 30004856, 30006159, 30006985 -30007450, 30007536, 30007797, 30008125, 30008198, 30008214, 30009710 -30012181, 30014200, 30015070, 30017836, 30018017, 30018903, 30019864 -30021830, 30024618, 30025814, 30026016, 30026596, 30027614, 30027649 -30028182, 30028599, 30029519, 30029806, 30031027, 30032233, 30032376 -30032484, 30033040, 30033547, 30034456, 30035598, 30036258, 30038392 -30039800, 30039959, 30040157, 30041501, 30041514, 30042490, 30043398 -30043610, 30043930, 30044108, 30044507, 30045273, 30045389, 30045484 -30046497, 30047531, 30047702, 30047765, 30047931, 30048688, 30049966 -30051176, 30051783, 30051804, 30052928, 30053036, 30053501, 30053748 -30054980, 30056058, 30057718, 30057799, 30058149, 30058453, 30059106 -30059109, 30060267, 30060330, 30062364, 30062819, 30064268, 30066352 -30067565, 30068384, 30068792, 30068871, 30071446, 30072018, 30072905 -30073314, 30073422, 30073744, 30074296, 30074349, 30074469, 30074472 -30074820, 30075037, 30076058, 30076197, 30076253, 30076604, 30078675 -30078934, 30079949, 30080111, 30080266, 30081546, 30081580, 30082145 -30083100, 30083216, 30083488, 30083807, 30084971, 30085897, 30086596 -30086992, 30087165, 30087509, 30088229, 30090568, 30092280, 30092859 -30094929, 30095591, 30095952, 30097092, 30097115, 30098251, 30099302 -30099420, 30099454, 30100354, 30101186, 30102774, 30103551, 30103553 -30104348, 30104378, 30104555, 30106748, 30106901, 30108012, 30109365 -30110224, 30110370, 30110518, 30114477, 30114489, 30114534, 30116085 -30116203, 30116854, 30117209, 30117335, 30117469, 30117593, 30118261 -30118279, 30120608, 30122523, 30122583, 30123138, 30125765, 30126145 -30126470, 30127145, 30127522, 30127805, 30127904, 30128047, 30130240 -30131286, 30131645, 30132708, 30133841, 30134746, 30135396, 30135731 -30135942, 30136346, 30137792, 30139392, 30142907, 30143470, 30143593 -30146593, 30146969, 30147195, 30147307, 30147473, 30147928, 30148929 -30148999, 30149035, 30149658, 30150606, 30150710, 30153552, 30153885 -30154633, 30155241, 30155489, 30155814, 30155837, 30155999, 30156569 -30157526, 30158313, 30159329, 30159511, 30159536, 30159752, 30159760 -30160625, 30161094, 30163243, 30164714, 30165493, 30165503, 30165897 -30167787, 30169254, 30170104, 30172925, 30173113, 30173370, 30173556 -30174401, 30175291, 30175587, 30177597, 30178250, 30178839, 30178990 -30179038, 30179644, 30180208, 30180643, 30181756, 30182498, 30183367 -30183696, 30183715, 30183920, 30184102, 30185852, 30186319, 30186476 -30186706, 30187627, 30187866, 30189516, 30189535, 30190090, 30191274 -30192691, 30192729, 30192853, 30193165, 30193262, 30193505, 30193506 -30193584, 30193736, 30194612, 30194710, 30194972, 30195667, 30195668 -30195684, 30196195, 30196358, 30196629, 30198239, 30198861, 30198905 -30199890, 30200034, 30200132, 30200237, 30200680, 30200758, 30202349 -30202388, 30203929, 30204042, 30204542, 30206493, 30206675, 30207473 -30208327, 30208690, 30208723, 30209222, 30209736, 30210429, 30210753 -30210884, 30213031, 30213540, 30214769, 30214826, 30215130, 30215302 -30215351, 30217206, 30217562, 30217982, 30218044, 30218317, 30219222 -30221237, 30221298, 30222512, 30222669, 30222975, 30223712, 30223847 -30224544, 30224650, 30224725, 30224868, 30224950, 30225265, 30225439 -30225443, 30225718, 30225844, 30226244, 30228567, 30229683, 30232638 -30233934, 30234132, 30234227, 30235919, 30235979, 30236554, 30236964 -30237477, 30238211, 30238715, 30239480, 30240010, 30240547, 30240858 -30240930, 30240972, 30241567, 30241807, 30241920, 30242120, 30242724 -30243216, 30244340, 30246053, 30246179, 30247305, 30248531, 30249432 -30251003, 30252005, 30252098, 30252156, 30252458, 30252977, 30253035 -30253090, 30253608, 30253705, 30253835, 30254206, 30254525, 30254576 -30254726, 30255143, 30255528, 30256542, 30257412, 30257908, 30259120 -30259469, 30260595, 30264405, 30265523, 30265608, 30265615, 30265703 -30266791, 30267155, 30269428, 30269748, 30270647, 30270744, 30271114 -30272329, 30274090, 30274188, 30274324, 30274662, 30275548, 30275569 -30275578, 30276144, 30276243, 30277120, 30277451, 30277589, 30277733 -30277887, 30278402, 30281428, 30282501, 30282591, 30282918, 30283296 -30283577, 30283579, 30283581, 30283932, 30284219, 30284369, 30285026 -30285166, 30285251, 30285457, 30285540, 30285843, 30288343, 30288491 -30289074, 30289458, 30292305, 30293345, 30294267, 30294465, 30294671 -30295110, 30295137, 30295549, 30295790, 30295808, 30297905, 30299367 -30299817, 30299934, 30300030, 30300342, 30300363, 30300523, 30300538 -30305264, 30305395, 30305568, 30305880, 30307814, 30307883, 30308368 -30308624, 30308772, 30308947, 30309098, 30309798, 30311826, 30312094 -30312546, 30313749, 30313848, 30313989, 30314079, 30314198, 30314837 -30316667, 30316897, 30317209, 30317397, 30318638, 30318943, 30319080 -30319099, 30320029, 30321076, 30321398, 30322980, 30323658, 30323849 -30324180, 30324466, 30325407, 30326882, 30327149, 30327810, 30328168 -30328690, 30329209, 30329751, 30330123, 30331356, 30331759, 30332505 -30334484, 30334563, 30335127, 30335832, 30335987, 30336032, 30336383 -30336530, 30336742, 30336996, 30337245, 30338591, 30339103, 30341713 -30342371, 30342878, 30344614, 30345201, 30345432, 30345809, 30345926 -30346330, 30346867, 30347410, 30349714, 30350177, 30350543, 30352532 -30352581, 30352623, 30352715, 30355490, 30357463, 30357698, 30357897 -30358416, 30359614, 30360383, 30361635, 30362003, 30362850, 30363088 -30363311, 30363716, 30364329, 30364481, 30364613, 30365745, 30367193 -30368048, 30368482, 30368534, 30368668, 30368917, 30371264, 30371623 -30371909, 30372081, 30373419, 30373550, 30374345, 30374570, 30374739 -30375109, 30376986, 30377347, 30377692, 30380907, 30381207, 30381525 -30382646, 30382982, 30383286, 30384121, 30384152, 30387628, 30387666 -30388853, 30389229, 30389414, 30389507, 30389821, 30390635, 30391272 -30392011, 30392870, 30392987, 30393110, 30393653, 30394738, 30394974 -30396120, 30396946, 30397100, 30398257, 30398422, 30399906, 30402386 -30403412, 30403763, 30403881, 30403902, 30403989, 30404117, 30404153 -30404639, 30406709, 30408515, 30408808, 30409207, 30409339, 30409472 -30409590, 30412188, 30412772, 30412863, 30412885, 30412921, 30413137 -30413294, 30414491, 30414679, 30414714, 30416034, 30416603, 30417648 -30417732, 30419024, 30421026, 30421204, 30421439, 30421476, 30421706 -30422487, 30423135, 30423218, 30424347, 30430921, 30431274, 30431504 -30431698, 30431703, 30431717, 30431867, 30433177, 30436399, 30437003 -30437149, 30439985, 30440651, 30441277, 30441687, 30441959, 30442266 -30442749, 30442884, 30443393, 30446583, 30446820, 30447060, 30447589 -30447994, 30448182, 30448917, 30449194, 30449837, 30450787, 30453442 -30454090, 30457633, 30458568, 30458593, 30460095, 30460922, 30461123 -30461458, 30463938, 30464250, 30464655, 30466081, 30469777, 30472891 -30473634, 30474167, 30474774, 30475115, 30476768, 30477588, 30477685 -30477691, 30477767, 30479252, 30479715, 30480872, 30483065, 30483140 -30483521, 30484042, 30484801, 30485255, 30486436, 30486896, 30487387 -30489582, 30490014, 30490578, 30492380, 30493518, 30494259, 30494900 -30495035, 30495078, 30495133, 30495483, 30496957, 30497057, 30497765 -30498824, 30500224, 30500297, 30500344, 30500582, 30501574, 30502415 -30503943, 30505029, 30505497, 30506794, 30506991, 30507032, 30508100 -30509277, 30510347, 30510527, 30512690, 30513285, 30513480, 30513848 -30515886, 30516868, 30517214, 30517516, 30517635, 30518349, 30519188 -30522285, 30522998, 30523137, 30523538, 30523601, 30523750, 30524736 -30528547, 30528687, 30528704, 30528935, 30529790, 30529940, 30530585 -30532811, 30533132, 30534351, 30534549, 30534662, 30534827, 30536237 -30537405, 30537533, 30537584, 30539519, 30540109, 30540407, 30544247 -30544595, 30544629, 30545281, 30545556, 30549255, 30549368, 30549637 -30549789, 30549881, 30551000, 30551123, 30554178, 30556326, 30556581 -30556807, 30557386, 30558561, 30559252, 30560365, 30560513, 30561404 -30561590, 30561737, 30564139, 30564343, 30564898, 30565004, 30565595 -30565805, 30566054, 30567372, 30571306, 30573236, 30573703, 30576112 -30576393, 30576853, 30577071, 30577591, 30578221, 30579051, 30580813 -30581448, 30582221, 30582500, 30588738, 30591028, 30591475, 30592859 -30593046, 30593104, 30593863, 30594167, 30595114, 30595408, 30595860 -30596488, 30596694, 30598682, 30598746, 30598919, 30599405, 30599407 -30600173, 30600184, 30602230, 30602828, 30605215, 30605676, 30606345 -30606451, 30608583, 30609799, 30610406, 30610667, 30611603, 30612199 -30613937, 30613971, 30614411, 30616406, 30616738, 30619138, 30619525 -30619728, 30619787, 30620805, 30621255, 30622528, 30622755, 30623138 -30623142, 30624243, 30624792, 30624864, 30624874, 30625121, 30628834 -30628899, 30629139, 30629643, 30629799, 30631393, 30631523, 30633259 -30633938, 30634548, 30635183, 30635302, 30635326, 30637270, 30637319 -30641541, 30641755, 30641900, 30644530, 30644766, 30644889, 30645896 -30647133, 30650404, 30651231, 30651570, 30651621, 30651674, 30652515 -30652853, 30654558, 30655906, 30657196, 30657365, 30657566, 30657624 -30657706, 30657875, 30657906, 30657940, 30658533, 30658555, 30658702 -30659940, 30660412, 30661000, 30661939, 30662651, 30662736, 30663646 -30665399, 30668407, 30670328, 30670584, 30671720, 30671813, 30671958 -30674373, 30674959, 30676209, 30677633, 30679595, 30679771, 30681462 -30681516, 30681521, 30684902, 30686017, 30686131, 30687047, 30689557 -30690686, 30691604, 30691731, 30691857, 30692462, 30692473, 30693791 -30694947, 30696566, 30698289, 30703610, 30704826, 30705448, 30708735 -30710807, 30711370, 30712670, 30713133, 30714151, 30714715, 30716863 -30718841, 30718862, 30719327, 30719419, 30720736, 30720844, 30722705 -30723671, 30724679, 30724881, 30727701, 30727759, 30729278, 30729604 -30730026, 30732711, 30734707, 30735153, 30735736, 30739876, 30740669 -30740997, 30741263, 30748707, 30749644, 30749722, 30750219, 30750991 -30751521, 30751527, 30751639, 30751968, 30753432, 30755348, 30758836 -30758854, 30758943, 30761871, 30761878, 30763272, 30763305, 30763639 -30763754, 30764405, 30764663, 30765486, 30765995, 30767277, 30768636 -30769312, 30770717, 30773164, 30773797, 30776416, 30776929, 30777759 -30778855, 30779240, 30781032, 30781041, 30782266, 30782300, 30782414 -30783395, 30783551, 30785101, 30786237, 30786641, 30786655, 30788973 -30789904, 30790441, 30801296, 30801510, 30803210, 30804646, 30806757 -30806984, 30807723, 30807888, 30808869, 30809087, 30810765, 30812574 -30814266, 30814285, 30815495, 30815852, 30816760, 30816938, 30819340 -30819629, 30821297, 30823744, 30825391, 30825419, 30825656, 30826474 -30828350, 30829779, 30830555, 30832775, 30833454, 30834068, 30834110 -30835184, 30835853, 30836129, 30838605, 30839451, 30839836, 30841241 -30842277, 30843271, 30844839, 30846063, 30846782, 30847442, 30847871 -30848028, 30848097, 30848773, 30851448, 30851951, 30852954, 30855101 -30856358, 30857501, 30857721, 30858877, 30858919, 30860803, 30861988 -30863115, 30864607, 30865805, 30866141, 30866988, 30869131, 30870439 -30871716, 30871792, 30873527, 30874270, 30874337, 30874660, 30879169 -30879708, 30880774, 30880913, 30881407, 30883715, 30883785, 30883877 -30886188, 30887501, 30887777, 30889443, 30889607, 30889723, 30890720 -30890971, 30891760, 30891792, 30895426, 30895577, 30896620, 30896685 -30898381, 30898748, 30898939, 30902655, 30904672, 30906274, 30906407 -30909596, 30909918, 30910264, 30913399, 30914272, 30914674, 30915781 -30919587, 30919691, 30919804, 30921136, 30922936, 30922996, 30923514 -30923517, 30923597, 30923940, 30925316, 30927821, 30930149, 30930339 -30931311, 30931981, 30932674, 30936251, 30936831, 30936942, 30937340 -30937391, 30937410, 30938413, 30939307, 30939317, 30939934, 30940259 -30940868, 30940869, 30941056, 30944643, 30945005, 30946072, 30946768 -30946876, 30952104, 30952191, 30953266, 30953836, 30956571, 30956647 -30957739, 30960356, 30960736, 30964194, 30965554, 30965649, 30968737 -30968781, 30970518, 30972817, 30972841, 30972887, 30972947, 30972951 -30972959, 30972966, 30973085, 30973113, 30973127, 30973137, 30973143 -30973197, 30973698, 30973877, 30974813, 30977411, 30978554, 30980115 -30980317, 30980733, 30981240, 30985027, 30985906, 30987088, 30988444 -30990034, 30992330, 30992597, 30993198, 30993518, 30994996, 30996991 -30997375, 30998035, 30998662, 30998759, 30998847, 31001017, 31001455 -31001490, 31001859, 31002223, 31002923, 31003137, 31003659, 31004077 -31004719, 31004844, 31006792, 31008240, 31008907, 31009545, 31009590 -31009680, 31010218, 31010976, 31011361, 31013127, 31014323, 31015330 -31016413, 31019249, 31021068, 31021157, 31021324, 31021542, 31022858 -31025520, 31025531, 31025859, 31026220, 31026591, 31026860, 31027747 -31028986, 31029936, 31030898, 31031955, 31032904, 31034794, 31035287 -31035916, 31037421, 31038220, 31038447, 31039627, 31039928, 31042208 -31043483, 31043630, 31044145, 31044951, 31045929, 31046188, 31046619 -31047022, 31047169, 31048025, 31048741, 31049215, 31051056, 31051075 -31052735, 31052809, 31055142, 31056909, 31058548, 31061482, 31061504 -31062010, 31063380, 31063769, 31064025, 31065838, 31066082, 31066250 -31066265, 31066554, 31067892, 31069059, 31071080, 31073586, 31074032 -31075323, 31075960, 31077117, 31077365, 31078391, 31078757, 31079204 -31080474, 31081558, 31084921, 31086869, 31087361, 31087679, 31088115 -31088341, 31089270, 31090262, 31091868, 31092129, 31092233, 31092581 -31092921, 31094183, 31094228, 31094688, 31096846, 31097760, 31097961 -31100172, 31101386, 31103065, 31104809, 31106140, 31106577, 31107577 -31109506, 31112530, 31112972, 31113089, 31113249, 31114265, 31114671 -31115201, 31115502, 31118809, 31119057, 31119846, 31120361, 31122876 -31124363, 31124914, 31125773, 31126053, 31126058, 31127043, 31127457 -31127969, 31130156, 31132732, 31134430, 31138106, 31139643, 31141792 -31142749, 31145403, 31145804, 31153120, 31153485, 31155634, 31156383 -31158341, 31158380, 31159382, 31162711, 31162915, 31163379, 31165038 -31165577, 31165722, 31168440, 31171096, 31171631, 31172207, 31172642 -31175365, 31177193, 31177204, 31177221, 31178103, 31180519, 31181380 -31182159, 31182756, 31182793, 31185224, 31188038, 31188398, 31190624 -31192039, 31193292, 31193936, 31194264, 31195090, 31195430, 31195838 -31200845, 31201001, 31201366, 31202536, 31204412, 31204878, 31208287 -31213034, 31214119, 31215422, 31215438, 31216995, 31217946, 31218837 -31219047, 31219975, 31220549, 31220881, 31220912, 31221454, 31222780 -31223382, 31226448, 31228670, 31230775, 31233170, 31234765, 31234790 -31235797, 31240626, 31244968, 31249008, 31249406, 31249696, 31254297 -31254535, 31254929, 31255369, 31255869, 31257740, 31258101, 31258995 -31260692, 31261641, 31265651, 31265773, 31268557, 31270711, 31271032 -31287871, 31289115, 31290300, 31292298, 31293484, 31298871, 31301460 -31303032, 31304573, 31305114, 31305624, 31306248, 31306261, 31306867 -31306927, 31309379, 31309867, 31310564, 31310624, 31311830, 31312450 -31312976, 31313117, 31313444, 31314885, 31315495, 31315876, 31316250 -31321092, 31322720, 31325584, 31326608, 31326977, 31326998, 31327259 -31327278, 31327349, 31327391, 31327896, 31331354, 31331372, 31333156 -31334606, 31334961, 31335037, 31335142, 31336298, 31338249, 31338673 -31338769, 31339457, 31339643, 31339744, 31343110, 31344046, 31348711 -31350348, 31353610, 31356601, 31357581, 31357737, 31358308, 31359215 -31359366, 31360146, 31360323, 31360469, 31360529, 31366716, 31367188 -31367364, 31369444, 31372498, 31373825, 31373837, 31373843, 31376708 -31377129, 31377487, 31377808, 31380443, 31381701, 31383396, 31383464 -31383814, 31386394, 31387426, 31387443, 31388288, 31390936, 31391991 -31393600, 31394341, 31394347, 31394365, 31395247, 31396027, 31396695 -31398663, 31399131, 31401831, 31402078, 31403177, 31403565, 31404014 -31404130, 31404263, 31408636, 31409483, 31411163, 31414023, 31414524 -31417192, 31421316, 31422620, 31424838, 31425167, 31425761, 31429501 -31429590, 31429770, 31430722, 31431005, 31433092, 31433579, 31434805 -31434870, 31437030, 31440426, 31440813, 31442332, 31442714, 31444353 -31444516, 31446431, 31447733, 31448680, 31449354, 31450392, 31450653 -31454972, 31455597, 31458049, 31466433, 31468060, 31475635, 31476093 -31476736, 31477424, 31477695, 31479272, 31479772, 31483949, 31484385 -31484603, 31485386, 31485507, 31486557, 31487441, 31487491, 31489137 -31490604, 31491634, 31493840, 31494264, 31496174, 31498559, 31499370 -31499700, 31500971, 31501139, 31503349, 31507107, 31508712, 31509279 -31510891, 31512044, 31513011, 31523548, 31525783, 31526903, 31527103 -31527199, 31528962, 31533274, 31533817, 31533833, 31535955, 31536401 -31536731, 31537521, 31539566, 31541864, 31544097, 31545477, 31546864 -31547220, 31548675, 31549221, 31553674, 31553813, 31555539, 31557663 -31559085, 31560592, 31561886, 31567124, 31567441, 31570054, 31570161 -31572006, 31572267, 31574244, 31574267, 31576738, 31577569, 31578994 -31581627, 31585351, 31585789, 31586381, 31591384, 31591400, 31591409 -31591421, 31595632, 31597727, 31600023, 31600894, 31601385, 31603199 -31605119, 31607937, 31609974, 31616104, 31620748, 31625579, 31625618 -31626572, 31627587, 31628311, 31628753, 31630551, 31633224, 31637607 -31637680, 31640240, 31644775, 31648120, 31649819, 31650202, 31652641 -31653080, 31655807, 31658464, 31658943, 31661865, 31663189, 31663788 -31668061, 31668694, 31668872, 31670014, 31670353, 31672605, 31674380 -31675568, 31676941, 31677460, 31682766, 31683044, 31684494, 31686979 -31688978, 31691030, 31695062, 31696577, 31697741, 31700234, 31701910 -31706595, 31707190, 31708133, 31709647, 31709739, 31709777, 31711889 -31711997, 31715935, 31718134, 31718346, 31721863, 31721880, 31722646 -31723651, 31727560, 31728160, 31734583, 31735662, 31743771, 31747935 -31747989, 31748000, 31748944, 31752502, 31753202, 31753425, 31753692 -31754887, 31755245, 31756415, 31757357, 31757775, 31757824, 31758083 -31758846, 31760592, 31763707, 31764866, 31765257, 31765296, 31766696 -31767237, 31769373, 31770289, 31771370, 31771410, 31771468, 31775101 -31776994, 31781897, 31783451, 31783782, 31785445, 31786838, 31787655 -31788704, 31788761, 31790500, 31792465, 31792615, 31793713, 31796208 -31796277, 31796882, 31798742, 31800757, 31807516, 31815099, 31816158 -31816631, 31820632, 31820859, 31823051, 31827605, 31827912, 31829617 -31829639, 31833172, 31833948, 31835854, 31836454, 31839779, 31842545 -31843462, 31847489, 31849859, 31851383, 31852574, 31854692, 31855526 -31860193, 31862359, 31863118, 31866141, 31867037, 31869601, 31871692 -31872230, 31876368, 31878314, 31880154, 31881527, 31883124, 31886547 -31886695, 31887130, 31888148, 31888731, 31889222, 31895670, 31897786 -31897854, 31900585, 31903523, 31904933, 31905033, 31907137, 31907565 -31909295, 31913650, 31921267, 31927930, 31935717, 31942144, 31943497 -31952052, 31953989, 31958958, 31961940, 31965542, 31974597, 31974693 -31986836, 31988079, 31991705, 31996264, 32002411, 32003551, 32005048 -32007698, 32008586, 32010707, 32017301, 32032733, 32032887, 32048412 -32050048, 32057639, 32061648, 32069696, 32069834, 32079739, 32082098 -32089820, 32097882, 32101305, 32113113, 32118727, 32121326, 32129659 -32130083, 32130504, 32150818, 32165759, 32169151, 32172777, 32174571 -32207088, 32212635, 32221141, 32234161, 32290399, 32296941, 32321765 -``` - -## Version 19\.0\.0\.0\.ru\-2020\-10\.rur\-2020\-10\.r1 - -Version 19\.0\.0\.0\.ru\-2020\-10\.rur\-2020\-10\.r1 includes the following: -+ Patch 31771877: Database Release Update: 19\.9\.0\.0\.201020 \(31771877\) -+ Patch 31668882: OJVM RELEASE UPDATE: 19\.9\.0\.0\.201020 \(31668882\) -+ Patch 31335037: RDBMS \- DSTV35 UPDATE \- TZDATA2020A -+ Patch 31335142: DSTV35 UPDATE \- TZDATA2020A \- NEED OJVM FIX -+ Patch 28730253: SUPPORT NEW ERA REIWA FOR JAPANESE IMPERIAL CALENDAR -+ Patch 29213893: DBMS\_STATS FAILING WITH ERROR ORA\-01422 WHEN GATHERING STATS FOR USER$ TABLE -+ Patch 29374604: IE not starting against 18c Oracle RDBMS Standard Edition\. -+ PreUpgrade Jar: preupgrade\_19\_cbuild\_8\_lf\.zip -+ Support for [Setting and unsetting system diagnostic events](Appendix.Oracle.CommonDBATasks.System.md#Appendix.Oracle.CommonDBATasks.SystemEvents) using procedures in the `rdsadmin.rdsadmin_util` package -+ Support for the procedure `rdsadmin_util.truncate_apply$_cdr_info` described in [Integrated REPLICAT slow due to query on sys\."\_DBA\_APPLY\_CDR\_INFO"](Appendix.OracleGoldenGate.md#Appendix.OracleGoldenGate.IR) - -### Combined patches for version 19\.0\.0\.0\.ru\-2020\-10\.rur\-2020\-10\.r1, released October 2020 - -Bugs fixed: - -``` -7391838, 8460502, 8476681, 14735102, 17428816, 17468475, 19080742 -19697993, 20313356, 21374587, 21639146, 21888352, 21965541, 22580355 -22729345, 22748979, 23294761, 23296836, 23606241, 23645975, 23734075 -23763462, 24596874, 24669730, 24687075, 24833686, 24971456, 25030027 -25092651, 25093917, 25404117, 25416731, 25560538, 25756945, 25804387 -25806201, 25809128, 25883179, 25905368, 25986062, 25997810, 26001677 -26284288, 26352615, 26440142, 26476244, 26499997, 26611353, 26668264 -26716835, 26739322, 26777814, 26819036, 26872233, 27036163, 27044169 -27101798, 27126122, 27126938, 27166935, 27195935, 27221350, 27222128 -27244999, 27254335, 27260704, 27261477, 27359766, 27369515, 27378053 -27392968, 27406105, 27411022, 27423500, 27439716, 27453490, 27458357 -27489107, 27572040, 27582210, 27589260, 27604329, 27629928, 27666312 -27692173, 27700413, 27710072, 27729678, 27745728, 27760043, 27801144 -27828892, 27846298, 27873364, 27877830, 27880025, 27929509, 27934711 -27935464, 27941110, 27957203, 27967484, 28064977, 28072567, 28078186 -28092783, 28104176, 28109326, 28125947, 28129791, 28138847, 28144569 -28181021, 28189466, 28204262, 28205555, 28209985, 28210681, 28263142 -28271258, 28271693, 28276054, 28279456, 28294563, 28302580, 28313275 -28319114, 28322973, 28326928, 28350595, 28371123, 28373960, 28375383 -28379065, 28381939, 28386259, 28390273, 28395302, 28397317, 28402823 -28406374, 28410431, 28431445, 28435333, 28436414, 28442896, 28454215 -28463226, 28470673, 28475242, 28482048, 28484299, 28489419, 28492006 -28498976, 28502773, 28504631, 28513333, 28521330, 28530171, 28534475 -28535127, 28537481, 28538439, 28541606, 28542455, 28546290, 28547068 -28547926, 28558645, 28561704, 28564479, 28565296, 28567417, 28567819 -28569897, 28572407, 28572533, 28572544, 28572667, 28572834, 28578945 -28587723, 28589509, 28593682, 28594086, 28597221, 28601957, 28602253 -28605066, 28606598, 28608211, 28612239, 28618343, 28620697, 28621543 -28622202, 28625862, 28627033, 28628592, 28632796, 28636532, 28639299 -28642469, 28642899, 28643583, 28643654, 28643718, 28644549, 28645570 -28646200, 28646939, 28649388, 28655209, 28661333, 28663289, 28663782 -28672457, 28673945, 28681153, 28689483, 28690694, 28692103, 28692275 -28694639, 28694872, 28696373, 28697526, 28699321, 28703812, 28705231 -28707931, 28708400, 28709063, 28710385, 28710469, 28710663, 28710734 -28714461, 28715655, 28715727, 28718469, 28719348, 28720204, 28720418 -28721497, 28722229, 28730079, 28730253, 28734355, 28740708, 28740799 -28742555, 28745367, 28749853, 28752923, 28755011, 28755846, 28758722 -28760206, 28765983, 28767240, 28769456, 28771947, 28772390, 28772816 -28774416, 28776431, 28776811, 28777214, 28778754, 28781599, 28781754 -28785321, 28785531, 28789531, 28791852, 28793062, 28794230, 28795551 -28795734, 28800508, 28802734, 28804517, 28805242, 28808314, 28808652 -28808656, 28810381, 28811560, 28813931, 28815123, 28815355, 28815557 -28817449, 28819640, 28820669, 28821847, 28824482, 28827682, 28831971 -28833912, 28835937, 28836716, 28838385, 28844738, 28845346, 28846759 -28847541, 28847572, 28849776, 28850084, 28852325, 28854004, 28854733 -28855520, 28855922, 28857552, 28861861, 28862532, 28863263, 28863432 -28863487, 28865569, 28867698, 28867992, 28870496, 28871040, 28872645 -28873575, 28874416, 28875089, 28876253, 28876639, 28876926, 28877252 -28878865, 28881191, 28881848, 28882784, 28884931, 28887305, 28888083 -28888327, 28889389, 28889730, 28892794, 28897512, 28899663, 28900506 -28901126, 28905390, 28905457, 28905615, 28907196, 28910498, 28910586 -28911140, 28912691, 28915561, 28917080, 28918429, 28919145, 28921844 -28922227, 28922532, 28922608, 28925250, 28925460, 28925634, 28925880 -28927452, 28928462, 28932914, 28933158, 28935293, 28935956, 28936114 -28937717, 28938422, 28938698, 28940179, 28940281, 28940472, 28941901 -28942455, 28942694, 28945421, 28945994, 28946233, 28948554, 28949888 -28950868, 28951332, 28951533, 28952168, 28954762, 28955606, 28955883 -28956908, 28957292, 28957723, 28958088, 28959493, 28960863, 28962775 -28963036, 28965084, 28965095, 28965231, 28965376, 28966444, 28968779 -28974083, 28974999, 28977322, 28980448, 28981871, 28983095, 28983486 -28984313, 28985478, 28986207, 28986231, 28986257, 28986326, 28986481 -28986696, 28988482, 28988864, 28989306, 28993295, 28993353, 28994307 -28994542, 28995287, 28996376, 29000000, 29001305, 29001888, 29002488 -29002784, 29002927, 29003207, 29003407, 29003617, 29003738, 29006318 -29006621, 29007321, 29007353, 29007775, 29008035, 29008669, 29009513 -29010126, 29010517, 29011936, 29012609, 29013475, 29013832, 29014076 -29015118, 29016294, 29017265, 29018655, 29018680, 29019121, 29021063 -29021352, 29022986, 29024054, 29024448, 29024552, 29024732, 29024876 -29026154, 29026582, 29026606, 29027456, 29027694, 29027933, 29027940 -29031575, 29031600, 29032234, 29032276, 29032457, 29032607, 29033052 -29033145, 29033200, 29033280, 29034587, 29036278, 29037290, 29038528 -29038728, 29039089, 29039510, 29040739, 29041739, 29041775, 29043554 -29043651, 29043725, 29044086, 29044763, 29044954, 29046482, 29047127 -29047850, 29048178, 29048289, 29048498, 29048605, 29048728, 29049673 -29050357, 29050560, 29050765, 29050886, 29051263, 29051702, 29051953 -29052726, 29052850, 29053783, 29055644, 29056024, 29056270, 29056560 -29056767, 29056894, 29058476, 29059011, 29060216, 29061016, 29061959 -29062692, 29062848, 29062860, 29062868, 29110526, 29110783, 29110790 -29110797, 29110802, 29110805, 29111598, 29111631, 29112455, 29113282 -29113305, 29115857, 29117337, 29117526, 29117642, 29118543, 29119077 -29120223, 29122224, 29122254, 29122367, 29123297, 29123432, 29123444 -29123482, 29124368, 29125036, 29125374, 29125380, 29125708, 29125786 -29126345, 29127957, 29128693, 29128935, 29129450, 29129476, 29129497 -29129691, 29129712, 29130219, 29131539, 29131772, 29132456, 29132869 -29132938, 29133470, 29134447, 29135383, 29135649, 29136111, 29138641 -29139070, 29139727, 29139761, 29139956, 29141316, 29141341, 29141685 -29141886, 29142609, 29142667, 29143516, 29144995, 29145214, 29145730 -29146157, 29146810, 29147849, 29149170, 29149829, 29150338, 29151520 -29152357, 29152603, 29152752, 29154631, 29154636, 29154725, 29154829 -29155099, 29157051, 29157389, 29158680, 29158899, 29159216, 29159661 -29159909, 29159936, 29160174, 29160462, 29161597, 29161923, 29162095 -29163073, 29163156, 29163415, 29163437, 29163524, 29163567, 29164376 -29165682, 29167111, 29167342, 29167374, 29167940, 29168137, 29168219 -29168433, 29169073, 29169215, 29169540, 29169739, 29170232, 29170717 -29171683, 29171942, 29172618, 29172826, 29173140, 29173373, 29173618 -29173817, 29174004, 29174753, 29175638, 29176318, 29177466, 29177543 -29177886, 29178385, 29179097, 29180313, 29180455, 29180559, 29180721 -29180893, 29181078, 29181153, 29181231, 29181568, 29181620, 29181743 -29181923, 29182019, 29182517, 29182901, 29182920, 29183298, 29183912 -29184297, 29184666, 29185193, 29186091, 29186456, 29186605, 29188255 -29189302, 29189307, 29189889, 29190235, 29190474, 29190663, 29190740 -29191541, 29191827, 29192419, 29192468, 29192685, 29193207, 29194205 -29194367, 29194493, 29194827, 29194981, 29195279, 29195337, 29195758 -29196725, 29198092, 29198913, 29199635, 29199733, 29200316, 29200700 -29201143, 29201494, 29201539, 29201695, 29201787, 29202104, 29202461 -29202850, 29203122, 29203166, 29203227, 29203425, 29203443, 29203604 -29205281, 29205323, 29205419, 29205463, 29205767, 29205918, 29206109 -29206605, 29207073, 29208260, 29208732, 29209545, 29210577, 29210610 -29210624, 29210683, 29211457, 29211724, 29212012, 29212433, 29212611 -29213320, 29213351, 29213613, 29213641, 29213775, 29213850, 29213879 -29213893, 29214561, 29214960, 29216312, 29216723, 29216746, 29216984 -29217294, 29217472, 29217828, 29217848, 29218570, 29219205, 29219273 -29219627, 29220079, 29221248, 29221891, 29221942, 29222031, 29222784 -29223833, 29223859, 29223967, 29224065, 29224294, 29224605, 29224710 -29225076, 29225168, 29225758, 29225861, 29227602, 29228869, 29229164 -29229754, 29229839, 29229844, 29229955, 29230252, 29230565, 29231133 -29232117, 29232154, 29232449, 29232653, 29233415, 29233810, 29233953 -29234123, 29235934, 29236573, 29237538, 29237575, 29237744, 29240307 -29240668, 29240759, 29241345, 29241651, 29242017, 29242884, 29242906 -29243749, 29243958, 29244495, 29244766, 29244968, 29245063, 29245137 -29245160, 29246163, 29247415, 29247712, 29247906, 29248495, 29248552 -29248723, 29248835, 29248858, 29249289, 29249412, 29249583, 29249991 -29250059, 29250317, 29251259, 29251564, 29253184, 29253871, 29254031 -29254623, 29254930, 29255178, 29255273, 29255431, 29255435, 29255616 -29255718, 29255973, 29256426, 29259119, 29259320, 29260224, 29260452 -29260956, 29261547, 29261548, 29261695, 29261906, 29262512, 29262887 -29265448, 29266248, 29266899, 29267292, 29268412, 29269171, 29269228 -29269825, 29270585, 29271019, 29273360, 29273539, 29273570, 29273735 -29273812, 29273847, 29274428, 29274564, 29274627, 29275461, 29276272 -29277317, 29278218, 29278684, 29279658, 29279751, 29279854, 29281527 -29281691, 29281796, 29282090, 29282233, 29282666, 29282898, 29285197 -29285453, 29285503, 29285621, 29285788, 29285956, 29286037, 29286229 -29287130, 29287705, 29290110, 29290235, 29292232, 29292837, 29293072 -29293574, 29293806, 29294753, 29296257, 29297863, 29297915, 29298220 -29299049, 29299082, 29299830, 29299844, 29301463, 29301566, 29302963 -29303918, 29304314, 29304692, 29304781, 29304853, 29306226, 29306713 -29307090, 29307109, 29307638, 29309698, 29311336, 29311528, 29311588 -29311927, 29312310, 29312672, 29312734, 29312753, 29312889, 29313347 -29313417, 29313525, 29314539, 29314636, 29317756, 29318410, 29319441 -29320900, 29321489, 29323946, 29324568, 29324735, 29325087, 29325105 -29325257, 29325765, 29325993, 29327044, 29327892, 29329042, 29329087 -29329675, 29329807, 29330361, 29330791, 29331066, 29331209, 29331380 -29331493, 29332292, 29332395, 29332763, 29332771, 29333500, 29336843 -29336899, 29337294, 29337310, 29337742, 29338315, 29338348, 29338453 -29338780, 29338913, 29339101, 29339155, 29339299, 29341209, 29342099 -29343086, 29343156, 29343861, 29344541, 29345937, 29346057, 29346211 -29346943, 29347620, 29348176, 29348358, 29350052, 29350712, 29350762 -29350868, 29351044, 29351386, 29351662, 29351716, 29351735, 29351749 -29351771, 29352298, 29352724, 29352867, 29352947, 29353271, 29353432 -29353718, 29353821, 29353960, 29355654, 29356547, 29356704, 29356711 -29356752, 29356782, 29357821, 29358509, 29358828, 29360252, 29360285 -29360467, 29360672, 29360775, 29360911, 29360950, 29361319, 29361472 -29361801, 29362596, 29363151, 29364171, 29364177, 29366406, 29366940 -29367019, 29367561, 29367971, 29368253, 29368310, 29368725, 29372069 -29372541, 29372562, 29373418, 29373588, 29374179, 29374604, 29375355 -29375941, 29375984, 29376346, 29377804, 29377986, 29378029, 29378287 -29378834, 29378913, 29379299, 29379381, 29379750, 29379978, 29380527 -29381000, 29382296, 29382641, 29382784, 29382815, 29383695, 29384781 -29384854, 29384864, 29385339, 29385429, 29385652, 29386502, 29386557 -29386635, 29386660, 29386835, 29387073, 29387274, 29387310, 29387337 -29388020, 29388072, 29388094, 29388524, 29388830, 29389408, 29389889 -29390011, 29390435, 29390785, 29391030, 29391237, 29391301, 29391438 -29391849, 29391925, 29392554, 29392966, 29393291, 29393649, 29394014 -29394140, 29394749, 29395657, 29397954, 29397996, 29398488, 29398863 -29399046, 29399100, 29399121, 29399336, 29399938, 29402110, 29402131 -29404483, 29405012, 29405462, 29405651, 29405996, 29407488, 29407804 -29408853, 29409149, 29409455, 29410311, 29410834, 29411037, 29411469 -29411931, 29412066, 29412269, 29413360, 29413382, 29413517, 29413544 -29413634, 29413956, 29416688, 29416700, 29417084, 29417173, 29417719 -29417884, 29418165, 29420254, 29420834, 29421059, 29423003, 29423016 -29423156, 29423491, 29423826, 29424999, 29426241, 29426320, 29428230 -29429017, 29429087, 29429264, 29429466, 29429566, 29429895, 29430524 -29430866, 29431192, 29431485, 29432176, 29434301, 29434869, 29435474 -29435652, 29436454, 29436514, 29436522, 29436727, 29437379, 29437594 -29437712, 29438150, 29438277, 29438736, 29439522, 29440651, 29441196 -29442936, 29443187, 29443250, 29443559, 29444072, 29444282, 29444602 -29445548, 29446319, 29446669, 29448498, 29449477, 29449845, 29449852 -29450162, 29450193, 29450421, 29450812, 29450936, 29451386, 29452251 -29452576, 29452936, 29452953, 29454450, 29454978, 29455424, 29455773 -29456538, 29456714, 29457312, 29457319, 29457370, 29457502, 29457807 -29457978, 29460252, 29461420, 29461791, 29461971, 29462594, 29462767 -29462957, 29463047, 29463528, 29463798, 29464616, 29464779, 29465047 -29465177, 29466674, 29467622, 29469563, 29469565, 29470059, 29470291 -29471633, 29471832, 29471860, 29472618, 29473708, 29476473, 29477015 -29481584, 29482021, 29483452, 29483532, 29483626, 29483672, 29483685 -29483712, 29483723, 29483771, 29485099, 29485877, 29486181, 29486848 -29487150, 29487189, 29488894, 29489436, 29489546, 29490256, 29492127 -29492939, 29493122, 29494245, 29495057, 29495684, 29497311, 29497588 -29497696, 29498198, 29500257, 29500826, 29500963, 29501218, 29502561 -29503543, 29503631, 29503827, 29504103, 29504492, 29504682, 29505668 -29506942, 29507270, 29507616, 29508681, 29509777, 29510278, 29511064 -29511611, 29511980, 29512125, 29512890, 29514479, 29515134, 29515240 -29515476, 29515766, 29515834, 29516300, 29516727, 29516766, 29517168 -29517883, 29519131, 29521187, 29521688, 29521748, 29521862, 29522358 -29522561, 29522662, 29523055, 29523216, 29523511, 29524599, 29524985 -29525366, 29525467, 29525886, 29526966, 29527595, 29527610, 29528368 -29529147, 29530440, 29530515, 29530812, 29530909, 29531654, 29531836 -29532532, 29536342, 29536445, 29537829, 29538631, 29540327, 29541742 -29541769, 29541973, 29542084, 29542449, 29542580, 29542643, 29543034 -29543956, 29544552, 29546817, 29547010, 29547867, 29548413, 29548427 -29548592, 29548687, 29548722, 29549040, 29549071, 29549104, 29549154 -29549730, 29552402, 29552773, 29553141, 29554092, 29555105, 29557144 -29557261, 29557336, 29557556, 29558238, 29558452, 29558975, 29559187 -29559395, 29559446, 29559908, 29559981, 29564592, 29564593, 29565611 -29579919, 29580394, 29580983, 29581771, 29584261, 29584693, 29586143 -29587299, 29587765, 29588732, 29589544, 29591343, 29592011, 29592215 -29597536, 29597754, 29598039, 29598046, 29598226, 29598233, 29599008 -29599300, 29601461, 29602831, 29603460, 29603884, 29604002, 29604257 -29606261, 29607136, 29607797, 29608000, 29608023, 29610506, 29611020 -29611991, 29614206, 29614987, 29615824, 29616244, 29616414, 29618074 -29618190, 29620042, 29622936, 29623323, 29623592, 29624124, 29625065 -29625804, 29625876, 29626154, 29626732, 29628200, 29629430, 29629650 -29629681, 29629745, 29631749, 29632095, 29632265, 29632611, 29633697 -29633753, 29633936, 29634643, 29635427, 29635717, 29635990, 29637362 -29637526, 29637560, 29638285, 29641736, 29643721, 29644426, 29644464 -29645167, 29645349, 29647176, 29647770, 29648928, 29651183, 29651520 -29652809, 29653132, 29653246, 29655164, 29655668, 29656400, 29656819 -29656843, 29657399, 29657422, 29657744, 29657960, 29658056, 29661028 -29661065, 29661722, 29663191, 29663368, 29663494, 29663601, 29664087 -29664161, 29665168, 29665940, 29667527, 29667994, 29668005, 29669413 -29670782, 29671363, 29672507, 29675446, 29676089, 29677051, 29677173 -29677733, 29677927, 29679856, 29681987, 29683039, 29683211, 29684518 -29685137, 29685276, 29687214, 29687220, 29687459, 29687718, 29687727 -29687763, 29688867, 29689145, 29689255, 29692694, 29694869, 29695425 -29695821, 29695841, 29695964, 29696310, 29700125, 29700460, 29700770 -29701720, 29703932, 29705793, 29707099, 29707493, 29707896, 29708353 -29708876, 29708915, 29710188, 29710858, 29713810, 29715220, 29715703 -29716194, 29716227, 29716491, 29716602, 29716871, 29717659, 29717901 -29719146, 29720133, 29721418, 29721576, 29722167, 29724658, 29725476 -29725781, 29726695, 29738374, 29738400, 29739576, 29741319, 29741976 -29742223, 29744225, 29744400, 29745288, 29746962, 29747493, 29747648 -29747653, 29748285, 29748336, 29748513, 29749471, 29750673, 29751094 -29753244, 29754196, 29754951, 29755821, 29756274, 29756444, 29757099 -29757264, 29757651, 29757687, 29758203, 29758217, 29758661, 29761678 -29761837, 29761911, 29763158, 29765035, 29765393, 29766207, 29766435 -29766503, 29766679, 29768487, 29768899, 29769901, 29770750, 29771032 -29771242, 29773197, 29773205, 29773842, 29774362, 29775393, 29779196 -29780140, 29782211, 29782823, 29782866, 29784106, 29785239, 29785311 -29787292, 29787766, 29789911, 29791152, 29791880, 29792213, 29792433 -29793318, 29794174, 29794462, 29795712, 29795957, 29796335, 29796378 -29797209, 29797726, 29802382, 29802695, 29804875, 29805368, 29805772 -29806390, 29807964, 29809792, 29809837, 29812084, 29812489, 29813503 -29813650, 29813671, 29815341, 29815713, 29817278, 29817547, 29817784 -29821130, 29821582, 29822714, 29825525, 29827647, 29827852, 29828644 -29831196, 29833984, 29834506, 29836096, 29838337, 29838485, 29838773 -29839715, 29840619, 29841267, 29841687, 29843277, 29843692, 29843831 -29844131, 29844226, 29844275, 29845530, 29846126, 29846645, 29846688 -29848084, 29848849, 29849100, 29850930, 29851733, 29853485, 29856859 -29858121, 29858376, 29859068, 29860994, 29861075, 29864203, 29864261 -29865188, 29865590, 29865658, 29869086, 29869149, 29869404, 29869887 -29869906, 29870065, 29871098, 29871312, 29871360, 29872401, 29872937 -29872983, 29873665, 29874090, 29874761, 29875459, 29875565, 29876358 -29876989, 29877608, 29878076, 29881050, 29881478, 29881575, 29881643 -29881839, 29882427, 29882454, 29882729, 29884958, 29885182, 29885890 -29886809, 29887045, 29887111, 29888621, 29889184, 29889358, 29890740 -29891075, 29891853, 29891916, 29892604, 29893132, 29896510, 29897418 -29897863, 29900203, 29900824, 29901419, 29902299, 29902327, 29902330 -29902659, 29903190, 29903299, 29903357, 29903454, 29904002, 29906678 -29907942, 29908389, 29908777, 29909658, 29910402, 29912286, 29913805 -29913966, 29914449, 29914544, 29915217, 29915848, 29916975, 29919789 -29920025, 29920376, 29920804, 29921318, 29922225, 29922461, 29923452 -29924181, 29926466, 29927756, 29928210, 29928340, 29928427, 29928564 -29930457, 29932202, 29932430, 29932780, 29934052, 29935685, 29937565 -29937655, 29937956, 29938225, 29939400, 29939795, 29940373, 29941062 -29942096, 29942275, 29942554, 29943670, 29943879, 29944035, 29944159 -29944660, 29944963, 29945645, 29946388, 29947145, 29948165, 29950220 -29951620, 29951759, 29956016, 29956222, 29957412, 29957493, 29958925 -29960884, 29961353, 29961609, 29961847, 29962160, 29962248, 29962834 -29962927, 29962939, 29965052, 29965603, 29965888, 29966768, 29967223 -29968085, 29969557, 29970081, 29970298, 29971027, 29971481, 29971888 -29971936, 29971951, 29972176, 29973012, 29989783, 29989845, 29991257 -29993717, 29997326, 29997553, 29997937, 30000664, 30001331, 30003187 -30006159, 30006985, 30007450, 30007797, 30008125, 30008198, 30008214 -30009710, 30012181, 30015070, 30017836, 30018017, 30018903, 30019864 -30024618, 30025814, 30026016, 30027614, 30028599, 30029519, 30029806 -30031027, 30032376, 30033040, 30033547, 30034456, 30035598, 30036258 -30038392, 30039800, 30039959, 30040157, 30041501, 30041514, 30042490 -30043398, 30043610, 30043930, 30044108, 30044507, 30045389, 30045484 -30046497, 30047531, 30047702, 30047765, 30047931, 30048688, 30049966 -30051176, 30051783, 30051804, 30052928, 30053036, 30053501, 30053748 -30054980, 30056058, 30057718, 30057799, 30058149, 30058453, 30059106 -30059109, 30060267, 30060330, 30062364, 30062819, 30064268, 30066352 -30067565, 30068384, 30068871, 30071446, 30072905, 30073314, 30073744 -30074296, 30074349, 30074469, 30074472, 30074820, 30075037, 30076058 -30076197, 30076253, 30076604, 30078675, 30078934, 30079949, 30080266 -30081546, 30081580, 30082145, 30083100, 30083216, 30083488, 30083807 -30084971, 30085897, 30086596, 30086992, 30090568, 30092280, 30092859 -30095591, 30095952, 30097092, 30097115, 30098251, 30099302, 30099420 -30099454, 30100354, 30101186, 30103551, 30103553, 30104378, 30104555 -30106748, 30109365, 30110224, 30110370, 30110518, 30114477, 30114489 -30114534, 30116085, 30116203, 30116854, 30117209, 30117335, 30117469 -30117593, 30118261, 30118279, 30120608, 30122583, 30125765, 30126145 -30127145, 30127522, 30127805, 30127904, 30128047, 30130240, 30131286 -30131645, 30132708, 30133841, 30134746, 30135396, 30135731, 30135942 -30136346, 30139392, 30142907, 30143470, 30143593, 30146593, 30146969 -30147473, 30147928, 30148999, 30149035, 30149658, 30150606, 30150710 -30153552, 30153885, 30154633, 30155241, 30155814, 30155837, 30159329 -30159511, 30159536, 30159752, 30159760, 30160625, 30161094, 30163243 -30164714, 30165493, 30165503, 30165897, 30167787, 30169254, 30170104 -30172925, 30173113, 30173556, 30174401, 30175291, 30177597, 30178250 -30178839, 30178990, 30179644, 30180208, 30180643, 30181756, 30182498 -30183696, 30183715, 30183920, 30184102, 30185852, 30186319, 30186476 -30186706, 30187866, 30189516, 30190090, 30191274, 30192691, 30193165 -30193505, 30193736, 30194612, 30194710, 30194972, 30195667, 30195668 -30195684, 30196195, 30196358, 30196629, 30198861, 30198905, 30199890 -30200034, 30200132, 30200237, 30200680, 30200758, 30202349, 30202388 -30203929, 30204042, 30204542, 30206493, 30206675, 30207473, 30208327 -30208723, 30209736, 30210884, 30213031, 30213540, 30215130, 30215302 -30215351, 30217206, 30217562, 30217982, 30218044, 30218317, 30219222 -30221237, 30221298, 30222512, 30223712, 30223847, 30224650, 30224868 -30224950, 30225265, 30225439, 30225443, 30225718, 30225844, 30226244 -30228567, 30229683, 30232638, 30235919, 30235979, 30236554, 30237477 -30238211, 30238715, 30239480, 30240010, 30240547, 30240930, 30241567 -30241807, 30241920, 30242120, 30242724, 30243216, 30244340, 30246053 -30246179, 30247305, 30249432, 30251003, 30252005, 30252098, 30252156 -30252458, 30252977, 30253035, 30253090, 30253608, 30253705, 30253835 -30254206, 30254525, 30254576, 30254726, 30255143, 30255528, 30256542 -30257412, 30257908, 30260595, 30264405, 30265523, 30265608, 30265615 -30265703, 30266791, 30267155, 30269428, 30269748, 30270647, 30270744 -30271114, 30272329, 30274090, 30274188, 30274324, 30274662, 30275548 -30275569, 30275578, 30276243, 30277120, 30277451, 30277589, 30277733 -30281428, 30282501, 30282591, 30283296, 30283577, 30283579, 30283581 -30283932, 30284219, 30284369, 30285457, 30285540, 30285843, 30288343 -30288491, 30289074, 30289458, 30293345, 30294267, 30294671, 30295110 -30295137, 30295549, 30295790, 30295808, 30297905, 30299367, 30299817 -30299934, 30300030, 30300342, 30300363, 30300538, 30305264, 30305395 -30305568, 30305880, 30307814, 30307883, 30308368, 30308624, 30308772 -30308947, 30309098, 30309798, 30311826, 30312094, 30312546, 30313848 -30313989, 30314079, 30314198, 30314837, 30316667, 30316897, 30317209 -30318638, 30318943, 30319080, 30319099, 30320029, 30322980, 30323658 -30323849, 30324180, 30325407, 30326882, 30327149, 30328168, 30328690 -30329209, 30330123, 30331356, 30331759, 30332505, 30334484, 30334563 -30335127, 30335832, 30335987, 30336032, 30336742, 30339103, 30341713 -30342371, 30342878, 30344614, 30345201, 30345432, 30345809, 30346330 -30346867, 30347410, 30349714, 30350543, 30352581, 30352623, 30352715 -30355490, 30357463, 30357897, 30360383, 30362003, 30362850, 30363088 -30363716, 30364329, 30364613, 30365745, 30367193, 30368048, 30368482 -30368534, 30368668, 30371264, 30371623, 30371909, 30372081, 30373419 -30373550, 30374345, 30374570, 30374739, 30375109, 30376986, 30377347 -30381207, 30381525, 30382982, 30383286, 30384121, 30384152, 30387666 -30389229, 30389414, 30389507, 30391272, 30392011, 30392987, 30393110 -30393653, 30394738, 30394974, 30396946, 30397100, 30398257, 30398422 -30399906, 30402386, 30403763, 30403881, 30403902, 30403989, 30404117 -30404153, 30406709, 30408515, 30408808, 30409207, 30409339, 30409590 -30412188, 30412863, 30412885, 30412921, 30413137, 30413294, 30414491 -30414679, 30414714, 30416034, 30416603, 30417648, 30417732, 30419024 -30421204, 30421439, 30421476, 30421706, 30422487, 30423135, 30423218 -30424347, 30430921, 30431274, 30431504, 30431698, 30431703, 30431717 -30431867, 30433177, 30437149, 30441687, 30441959, 30442266, 30442749 -30442884, 30443393, 30446583, 30447060, 30447589, 30448182, 30448917 -30449194, 30449837, 30450787, 30453442, 30454090, 30457633, 30458568 -30458593, 30460922, 30461458, 30463938, 30464250, 30464655, 30466081 -30469777, 30472891, 30473634, 30474167, 30474774, 30475115, 30476768 -30477588, 30477685, 30477691, 30477767, 30479252, 30479715, 30480872 -30483065, 30483140, 30483521, 30484042, 30484801, 30485255, 30486436 -30487387, 30490014, 30490578, 30493518, 30495035, 30495078, 30495133 -30495483, 30496957, 30497057, 30497765, 30498824, 30500224, 30500297 -30500344, 30500582, 30501574, 30502415, 30503943, 30505497, 30506794 -30506991, 30507032, 30509277, 30510347, 30510527, 30513285, 30513848 -30515886, 30516868, 30517214, 30517516, 30519188, 30522285, 30522998 -30523137, 30523538, 30523601, 30523750, 30528547, 30528704, 30528935 -30529940, 30532811, 30533132, 30534351, 30534549, 30534662, 30534827 -30537405, 30537533, 30539519, 30540109, 30540407, 30544247, 30544595 -30544629, 30545281, 30545556, 30549255, 30549637, 30549789, 30549881 -30551000, 30551123, 30554178, 30556581, 30556807, 30557386, 30559252 -30560365, 30560513, 30561590, 30561737, 30564139, 30564343, 30565805 -30573236, 30573703, 30576112, 30576393, 30576853, 30577071, 30577591 -30578221, 30579051, 30580813, 30581448, 30582221, 30582500, 30588738 -30591028, 30592859, 30593046, 30595114, 30595860, 30596488, 30598682 -30598746, 30598919, 30599405, 30599407, 30600173, 30600184, 30602230 -30602828, 30605215, 30606345, 30606451, 30609799, 30610667, 30611603 -30612199, 30613937, 30613971, 30614411, 30619525, 30619787, 30620805 -30621255, 30622528, 30623138, 30623142, 30624792, 30624864, 30625121 -30628899, 30629643, 30629799, 30631393, 30631523, 30633259, 30633938 -30635183, 30635302, 30635326, 30637270, 30637319, 30641755, 30641900 -30644889, 30647133, 30650404, 30651231, 30651621, 30651674, 30652515 -30652853, 30654558, 30655906, 30657365, 30657624, 30657706, 30657875 -30658533, 30658555, 30658702, 30660412, 30661939, 30662651, 30662736 -30663646, 30668407, 30670584, 30671720, 30671813, 30674959, 30676209 -30679595, 30679771, 30681462, 30681516, 30686131, 30687047, 30690686 -30691604, 30691731, 30691857, 30692462, 30692473, 30694947, 30696566 -30698289, 30703610, 30704826, 30708735, 30710807, 30711370, 30714151 -30714715, 30716863, 30718841, 30718862, 30719419, 30720736, 30720844 -30722705, 30723671, 30724679, 30724881, 30727701, 30729278, 30729604 -30730026, 30732711, 30734707, 30735153, 30735736, 30740669, 30740997 -30741263, 30749644, 30749722, 30750991, 30751521, 30751968, 30755348 -30758943, 30761878, 30763272, 30763305, 30763639, 30763754, 30764663 -30765486, 30769312, 30770717, 30773164, 30773797, 30776416, 30776929 -30777759, 30778855, 30779240, 30781032, 30781041, 30782414, 30783551 -30785101, 30786655, 30789904, 30790441, 30801296, 30801510, 30803210 -30807723, 30808869, 30812574, 30814266, 30814285, 30815852, 30816760 -30816938, 30821297, 30823744, 30825391, 30825419, 30825656, 30826474 -30828350, 30829779, 30832775, 30833454, 30834110, 30835853, 30838605 -30844839, 30847442, 30848097, 30848773, 30851951, 30855101, 30856358 -30857501, 30857721, 30858919, 30861988, 30865805, 30866141, 30866988 -30869131, 30870439, 30871716, 30871792, 30873527, 30880774, 30880913 -30881407, 30883785, 30883877, 30886188, 30887501, 30887777, 30889723 -30890720, 30890971, 30895577, 30896620, 30904672, 30906274, 30906407 -30909918, 30910264, 30913399, 30914272, 30914674, 30919691, 30919804 -30922936, 30922996, 30923517, 30923597, 30923940, 30927821, 30930339 -30936831, 30937340, 30937410, 30939307, 30939934, 30940259, 30940868 -30941056, 30944643, 30945005, 30946072, 30946876, 30952104, 30952191 -30953266, 30953836, 30957739, 30964194, 30965649, 30968737, 30968781 -30970518, 30972841, 30972887, 30972966, 30973113, 30973137, 30973143 -30973698, 30978554, 30980317, 30980733, 30981240, 30985027, 30987088 -30990034, 30992597, 30993198, 30994996, 30996991, 30997375, 30998759 -30998847, 31001017, 31001455, 31001859, 31003659, 31004077, 31004719 -31004844, 31008240, 31008907, 31009680, 31010976, 31013127, 31015330 -31016413, 31019249, 31021157, 31021324, 31021542, 31022858, 31025859 -31026220, 31028986, 31029936, 31031955, 31032904, 31034794, 31035916 -31038220, 31039627, 31039928, 31042208, 31043483, 31051075, 31056909 -31061482, 31061504, 31062010, 31066250, 31066265, 31066554, 31067892 -31071080, 31077117, 31077365, 31079204, 31080474, 31084921, 31086869 -31092129, 31094688, 31097760, 31100172, 31103065, 31104809, 31106577 -31109506, 31113089, 31113249, 31115502, 31118809, 31119057, 31124914 -31134430, 31141792, 31153120, 31153485, 31155634, 31156383, 31163379 -31172207, 31177193, 31178103, 31180519, 31182159, 31182793, 31188038 -31192039, 31193936, 31194264, 31200845, 31201001, 31202536, 31208287 -31214119, 31215438, 31217946, 31219975, 31220912, 31221454, 31222780 -31223382, 31228670, 31234765, 31249406, 31254297, 31254535, 31258101 -31265773, 31292298, 31301460, 31305624, 31306248, 31306261, 31309867 -31312976, 31315876, 31321092, 31325584, 31326608, 31331354, 31334606 -31335037, 31335142, 31338249, 31338673, 31359215, 31383396, 31386394 -31387443, 31393600, 31394365, 31401831, 31414023, 31414524, 31417192 -31429770, 31430722, 31431005, 31433092, 31455597, 31475635, 31477424 -31486557, 31500971, 31509279, 31513011, 31523548, 31527103, 31536731 -31537521, 31544097, 31570161, 31591384, 31591400, 31591409, 31600023 -31609974, 31628753, 31658464, 31668061, 31668872, 31672605, 31683044 -31718134, 31718346, 31747989, 31758846, 31781897, 31792615, 31796208 -31796277, 31820859, 31833172, 31867037, 31876368, 31886547, 31888148 -31897786, 31905033, 31935717 -``` - -## Version 19\.0\.0\.0\.ru\-2020\-07\.rur\-2020\-07\.r1 - -Version 19\.0\.0\.0\.ru\-2020\-07\.rur\-2020\-07\.r1 includes the following: -+ Patch 31281355: Database Release Update 19\.8\.0\.0\.200714 -+ Patch 31219897: Oracle JVM Release Update 19\.8\.0\.0\.200714 -+ Patch 31335037: DSTV35 for RDBMS \(TZDATA2020A\) -+ Patch 31335142: DSTV35 for OJVM \(TZDATA2020A\) -+ Patch 28730253: SUPPORT NEW ERA REIWA FOR JAPANESE IMPERIAL CALENDAR -+ Patch 29213893: DBMS\_STATS FAILING WITH ERROR ORA\-01422 WHEN GATHERING STATS FOR USER$ TABLE -+ Patch 29374604: IE not starting against 18c Oracle RDBMS Standard Edition -+ PreUpgrade Jar: preupgrade\_19\_cbuild\_7\_lf\.zip -+ Patch 30417732: ORA\-00600 \[KQRHASHTABLEREMOVE: X LOCK\] AND INSTANCE CRASH - -### Combined patches for version 19\.0\.0\.0\.ru\-2020\-07\.rur\-2020\-07\.r1, released July 2020 - -Bugs fixed: - -``` -7391838, 8476681, 14735102, 17428816, 19080742, 19697993, 20313356 -21374587, 21965541, 22580355, 22729345, 23296836, 23606241, 23645975 -23763462, 24596874, 24669730, 24687075, 24971456, 25030027, 25092651 -25416731, 25560538, 25756945, 25804387, 25806201, 25883179, 25986062 -25997810, 26001677, 26284288, 26440142, 26476244, 26611353, 26668264 -26739322, 26777814, 26872233, 27036163, 27044169, 27101798, 27126122 -27126938, 27166935, 27195935, 27221350, 27222128, 27244999, 27254335 -27359766, 27369515, 27378053, 27392968, 27406105, 27411022, 27423500 -27439716, 27453490, 27458357, 27489107, 27572040, 27582210, 27589260 -27604329, 27629928, 27666312, 27692173, 27700413, 27710072, 27729678 -27760043, 27801144, 27828892, 27846298, 27877830, 27880025, 27929509 -27934711, 27935464, 27941110, 27957203, 27967484, 28064977, 28072567 -28078186, 28092783, 28104176, 28109326, 28125947, 28129791, 28138847 -28144569, 28181021, 28189466, 28204262, 28205555, 28209985, 28210681 -28263142, 28271258, 28271693, 28276054, 28279456, 28294563, 28302580 -28313275, 28319114, 28322973, 28326928, 28350595, 28371123, 28373960 -28375383, 28379065, 28381939, 28386259, 28390273, 28395302, 28397317 -28402823, 28410431, 28431445, 28435333, 28442896, 28454215, 28463226 -28470673, 28475242, 28484299, 28489419, 28492006, 28498976, 28502773 -28504631, 28513333, 28521330, 28530171, 28534475, 28535127, 28538439 -28541606, 28542455, 28546290, 28547068, 28547926, 28558645, 28561704 -28564479, 28565296, 28567417, 28567819, 28569897, 28572407, 28572533 -28572544, 28572667, 28572834, 28578945, 28587723, 28589509, 28593682 -28594086, 28597221, 28601957, 28605066, 28606598, 28608211, 28612239 -28618343, 28620697, 28621543, 28622202, 28625862, 28627033, 28628592 -28632796, 28636532, 28639299, 28642469, 28642899, 28643654, 28643718 -28644549, 28645570, 28646200, 28646939, 28649388, 28655209, 28663289 -28663782, 28672457, 28673945, 28681153, 28689483, 28692103, 28692275 -28694639, 28694872, 28696373, 28699321, 28703812, 28705231, 28707931 -28708400, 28709063, 28710385, 28710469, 28710663, 28710734, 28714461 -28715655, 28715727, 28718469, 28719348, 28720204, 28720418, 28721497 -28722229, 28730079, 28730253, 28734355, 28740708, 28742555, 28745367 -28749853, 28752923, 28755011, 28755846, 28758722, 28760206, 28765983 -28767240, 28769456, 28771947, 28772390, 28772816, 28774416, 28776431 -28776811, 28777214, 28778754, 28781599, 28781754, 28785321, 28785531 -28789531, 28791852, 28793062, 28795551, 28795734, 28800508, 28802734 -28804517, 28805242, 28808314, 28808652, 28808656, 28810381, 28811560 -28813931, 28815123, 28815355, 28815557, 28817449, 28819640, 28820669 -28821847, 28824482, 28827682, 28831971, 28833912, 28835937, 28836716 -28838385, 28844738, 28845346, 28846759, 28847541, 28847572, 28849776 -28850084, 28852325, 28854004, 28855520, 28855922, 28857552, 28861861 -28862532, 28863263, 28863432, 28863487, 28865569, 28867992, 28870496 -28871040, 28872645, 28873575, 28874416, 28875089, 28876253, 28876639 -28876926, 28877252, 28878865, 28881191, 28881848, 28882784, 28884931 -28887305, 28888083, 28888327, 28889730, 28892794, 28897512, 28899663 -28900506, 28901126, 28905390, 28905457, 28905615, 28907196, 28910498 -28911140, 28912691, 28915561, 28917080, 28918429, 28919145, 28922227 -28922532, 28922608, 28925250, 28925460, 28925634, 28925880, 28927452 -28932914, 28933158, 28935293, 28935956, 28936114, 28937717, 28938422 -28938698, 28940179, 28940281, 28940472, 28941901, 28942455, 28942694 -28945421, 28945994, 28946233, 28949888, 28950868, 28951332, 28951533 -28952168, 28954762, 28955606, 28955883, 28956908, 28957292, 28957723 -28958088, 28959493, 28960863, 28962775, 28963036, 28965084, 28965095 -28965231, 28965376, 28966444, 28968779, 28974083, 28974999, 28977322 -28980448, 28981871, 28983095, 28983486, 28985478, 28986207, 28986231 -28986257, 28986326, 28986481, 28988482, 28988864, 28989306, 28993295 -28993353, 28994307, 28994542, 28995287, 28996376, 29000000, 29001305 -29001888, 29002488, 29002784, 29002927, 29003207, 29003407, 29003617 -29003738, 29006318, 29006621, 29007321, 29007353, 29007775, 29008035 -29008669, 29009513, 29010126, 29011936, 29012609, 29013475, 29013832 -29014076, 29015118, 29016294, 29017265, 29018655, 29018680, 29019121 -29021063, 29021352, 29022986, 29024054, 29024448, 29024552, 29024732 -29024876, 29026154, 29026582, 29026606, 29027456, 29027694, 29027933 -29027940, 29031575, 29031600, 29032234, 29032276, 29032457, 29032607 -29033052, 29033145, 29033200, 29033280, 29034587, 29036278, 29037290 -29038528, 29038728, 29039089, 29039510, 29040739, 29043554, 29043651 -29043725, 29044763, 29044954, 29046482, 29047127, 29047850, 29048178 -29048289, 29048498, 29048605, 29048728, 29050357, 29050560, 29050765 -29050886, 29051702, 29051953, 29052726, 29052850, 29053783, 29055644 -29056024, 29056270, 29056560, 29056767, 29056894, 29058476, 29059011 -29060216, 29061016, 29061959, 29062692, 29062848, 29062860, 29062868 -29110526, 29110783, 29110790, 29110797, 29110802, 29110805, 29111598 -29111631, 29112455, 29113282, 29113305, 29115857, 29117337, 29117526 -29117642, 29118543, 29119077, 29120223, 29122224, 29122254, 29123297 -29123432, 29123444, 29123482, 29124368, 29125036, 29125374, 29125380 -29125708, 29125786, 29126345, 29127957, 29128693, 29128935, 29129450 -29129476, 29129497, 29129712, 29130219, 29131539, 29131772, 29132456 -29132869, 29132938, 29133470, 29134447, 29135383, 29135649, 29136111 -29138641, 29139070, 29139727, 29139761, 29139956, 29141316, 29141341 -29141685, 29142609, 29142667, 29143516, 29144995, 29145214, 29145730 -29146157, 29146810, 29147849, 29149170, 29149829, 29150338, 29151520 -29152357, 29152603, 29152752, 29154631, 29154636, 29154725, 29154829 -29155099, 29157051, 29157389, 29158680, 29158899, 29159216, 29159661 -29159909, 29159936, 29160174, 29160462, 29161597, 29161923, 29162095 -29163073, 29163156, 29163415, 29163437, 29163524, 29163567, 29164376 -29165682, 29167111, 29167342, 29167374, 29167940, 29168137, 29168219 -29168433, 29169073, 29169215, 29169540, 29169739, 29170232, 29170717 -29171683, 29171942, 29172618, 29172826, 29173140, 29173373, 29173618 -29173817, 29174004, 29174753, 29176318, 29177466, 29177543, 29177886 -29178385, 29179097, 29180313, 29180455, 29180559, 29180893, 29181078 -29181153, 29181231, 29181568, 29181620, 29181743, 29181923, 29182019 -29182517, 29182901, 29182920, 29183298, 29183912, 29184297, 29184666 -29185193, 29186091, 29186456, 29186605, 29188255, 29189302, 29189307 -29189889, 29190235, 29190474, 29190663, 29190740, 29191541, 29191827 -29192419, 29192468, 29192685, 29193207, 29194205, 29194367, 29194493 -29194827, 29194981, 29195279, 29195337, 29195758, 29196725, 29198092 -29198913, 29199635, 29199733, 29200316, 29200700, 29201143, 29201494 -29201539, 29201695, 29201787, 29202104, 29202461, 29202850, 29203122 -29203166, 29203227, 29203425, 29203443, 29203604, 29205281, 29205323 -29205419, 29205463, 29205767, 29205918, 29206109, 29206605, 29207073 -29208260, 29208732, 29209545, 29210577, 29210610, 29210624, 29210683 -29211457, 29211724, 29212012, 29212433, 29212611, 29213320, 29213351 -29213613, 29213641, 29213775, 29213850, 29213879, 29213893, 29214561 -29214960, 29216312, 29216723, 29216746, 29216984, 29217294, 29217472 -29217828, 29217848, 29218570, 29219205, 29219273, 29219627, 29220079 -29221248, 29221891, 29221942, 29222031, 29222784, 29223833, 29223859 -29223967, 29224065, 29224294, 29224605, 29225076, 29225168, 29225758 -29225861, 29227602, 29228869, 29229164, 29229754, 29229839, 29229844 -29229955, 29230252, 29230565, 29231133, 29232117, 29232154, 29232449 -29233415, 29233810, 29233953, 29234123, 29235934, 29236573, 29237538 -29237575, 29237744, 29240307, 29240759, 29241345, 29241651, 29242017 -29242884, 29242906, 29243749, 29243958, 29244495, 29244766, 29244968 -29245063, 29245137, 29245160, 29246163, 29247415, 29247712, 29247906 -29248495, 29248552, 29248723, 29248835, 29248858, 29249289, 29249412 -29249583, 29249991, 29250059, 29250317, 29251259, 29251564, 29253184 -29253871, 29254031, 29254623, 29254930, 29255178, 29255273, 29255431 -29255435, 29255616, 29255718, 29255973, 29256426, 29259119, 29259320 -29260224, 29260452, 29260956, 29261547, 29261548, 29261695, 29261906 -29262512, 29262887, 29265448, 29266248, 29266899, 29267292, 29268412 -29269171, 29269228, 29269825, 29270585, 29271019, 29273360, 29273539 -29273570, 29273735, 29273812, 29273847, 29274428, 29274564, 29274627 -29275461, 29276272, 29277317, 29278218, 29278684, 29279658, 29279751 -29279854, 29281527, 29281691, 29281796, 29282090, 29282233, 29282666 -29282898, 29285197, 29285453, 29285503, 29285621, 29285788, 29285956 -29286037, 29286229, 29287130, 29287705, 29290110, 29290235, 29292232 -29292837, 29293072, 29293574, 29293806, 29294753, 29296257, 29297863 -29297915, 29298220, 29299049, 29299082, 29299830, 29299844, 29301463 -29301566, 29302963, 29303918, 29304314, 29304781, 29306226, 29306713 -29307090, 29307109, 29307638, 29309698, 29311336, 29311528, 29311588 -29311927, 29312310, 29312672, 29312734, 29312753, 29312889, 29313347 -29313417, 29313525, 29314539, 29314636, 29317756, 29318410, 29319441 -29321489, 29323946, 29324568, 29324735, 29325087, 29325105, 29325257 -29325765, 29325993, 29327044, 29327892, 29329042, 29329087, 29329675 -29329807, 29330361, 29330791, 29331066, 29331209, 29331380, 29331493 -29332292, 29332395, 29332763, 29332771, 29333500, 29336843, 29337294 -29337310, 29337742, 29338315, 29338348, 29338453, 29338780, 29338913 -29339101, 29339155, 29339299, 29341209, 29343086, 29343156, 29343861 -29344541, 29345937, 29346057, 29346211, 29346943, 29347620, 29348176 -29350052, 29350762, 29350868, 29351044, 29351386, 29351662, 29351716 -29351735, 29351749, 29351771, 29352298, 29352724, 29352867, 29352947 -29353271, 29353432, 29353718, 29353821, 29353960, 29355654, 29356547 -29356704, 29356711, 29356752, 29356782, 29357821, 29358509, 29358828 -29360252, 29360285, 29360467, 29360672, 29360775, 29360911, 29360950 -29361319, 29361472, 29361801, 29362596, 29363151, 29364171, 29364177 -29366406, 29366940, 29367019, 29367561, 29367971, 29368253, 29368310 -29368725, 29372069, 29372541, 29373418, 29373588, 29374179, 29374604 -29375355, 29375941, 29375984, 29376346, 29377804, 29377986, 29378029 -29378287, 29378834, 29378913, 29379299, 29379381, 29379750, 29379978 -29380527, 29381000, 29382296, 29382641, 29382784, 29382815, 29383695 -29384781, 29384854, 29384864, 29385339, 29385429, 29385652, 29386502 -29386557, 29386635, 29386660, 29387073, 29387274, 29387310, 29387337 -29388020, 29388072, 29388094, 29388524, 29388830, 29389408, 29389889 -29390011, 29390435, 29390785, 29391030, 29391237, 29391301, 29391438 -29391849, 29391925, 29392554, 29392966, 29393291, 29393649, 29394014 -29394140, 29394749, 29395657, 29397954, 29397996, 29398488, 29398863 -29399046, 29399100, 29399121, 29399336, 29399938, 29402110, 29402131 -29404483, 29405012, 29405462, 29405651, 29405996, 29407488, 29407804 -29408853, 29409149, 29409455, 29410311, 29410834, 29411037, 29411469 -29411931, 29412066, 29412269, 29413360, 29413382, 29413517, 29413544 -29413634, 29413956, 29416688, 29416700, 29417084, 29417173, 29417719 -29417884, 29418165, 29420254, 29420834, 29421059, 29423003, 29423016 -29423156, 29423826, 29424999, 29426241, 29426320, 29428230, 29429017 -29429087, 29429264, 29429466, 29429566, 29430524, 29430866, 29431192 -29431485, 29432176, 29434301, 29434869, 29435474, 29435652, 29436454 -29436514, 29436522, 29436727, 29437594, 29437712, 29438150, 29438277 -29438736, 29439522, 29441196, 29442936, 29443187, 29443250, 29444072 -29444282, 29444602, 29445548, 29446669, 29448498, 29449477, 29449845 -29449852, 29450162, 29450193, 29450421, 29450812, 29450936, 29451386 -29452251, 29452576, 29452936, 29452953, 29454978, 29455424, 29455773 -29456538, 29456714, 29457312, 29457319, 29457370, 29457502, 29457807 -29457978, 29460252, 29461420, 29461791, 29461971, 29462594, 29462767 -29462957, 29463047, 29463528, 29463798, 29464616, 29464779, 29465047 -29465177, 29466674, 29467622, 29469565, 29470291, 29471832, 29471860 -29472618, 29473708, 29476473, 29481584, 29483452, 29483532, 29483626 -29483672, 29483685, 29483712, 29483723, 29483771, 29485099, 29486181 -29486848, 29487150, 29487189, 29488894, 29489436, 29489546, 29490256 -29492127, 29492939, 29493122, 29494245, 29495057, 29495684, 29497311 -29497588, 29497696, 29498198, 29500257, 29500826, 29500963, 29501218 -29502561, 29503543, 29503631, 29503827, 29504492, 29504682, 29505668 -29506942, 29507270, 29507616, 29508681, 29509777, 29510278, 29511064 -29511611, 29511980, 29512125, 29512890, 29514479, 29515134, 29515240 -29515476, 29515766, 29515834, 29516300, 29516727, 29516766, 29517168 -29517883, 29519131, 29521187, 29521688, 29521748, 29521862, 29522358 -29522561, 29522662, 29523055, 29523216, 29523511, 29524599, 29524985 -29525366, 29525467, 29525886, 29526966, 29527595, 29527610, 29528368 -29529147, 29530440, 29530515, 29530812, 29530909, 29531654, 29531836 -29532532, 29536342, 29536445, 29537829, 29538631, 29540327, 29541742 -29541769, 29542084, 29542449, 29542580, 29542643, 29543034, 29543956 -29546817, 29547010, 29547867, 29548413, 29548427, 29548592, 29548687 -29548722, 29549040, 29549071, 29549104, 29549154, 29549730, 29552773 -29553141, 29554092, 29557144, 29557261, 29557336, 29557556, 29558238 -29558452, 29558975, 29559187, 29559395, 29559446, 29559908, 29559981 -29564592, 29564593, 29565611, 29579919, 29580394, 29580983, 29581771 -29584261, 29584693, 29586143, 29587299, 29587765, 29589544, 29591343 -29592011, 29592215, 29597536, 29597754, 29598039, 29598046, 29598226 -29598233, 29599008, 29599300, 29601461, 29602831, 29603460, 29603884 -29604002, 29604257, 29606261, 29607136, 29607797, 29608000, 29608023 -29610506, 29611020, 29611991, 29614206, 29614987, 29615824, 29616244 -29616414, 29618074, 29618190, 29620042, 29622936, 29623323, 29625065 -29625804, 29625876, 29626154, 29626732, 29628200, 29629430, 29629650 -29629681, 29629745, 29631749, 29632095, 29632265, 29632611, 29633697 -29633753, 29633936, 29634643, 29635427, 29635717, 29635990, 29637362 -29637526, 29637560, 29638285, 29641736, 29643721, 29644426, 29644464 -29645167, 29645349, 29647176, 29648928, 29651183, 29651520, 29653132 -29653246, 29655164, 29655668, 29656400, 29656819, 29656843, 29657399 -29657422, 29657744, 29657960, 29658056, 29661028, 29661065, 29661722 -29663191, 29663368, 29663494, 29663601, 29664087, 29664161, 29665940 -29667527, 29667994, 29668005, 29669413, 29670782, 29671363, 29672507 -29675446, 29676089, 29677051, 29677173, 29677733, 29677927, 29679856 -29681987, 29683039, 29683211, 29684518, 29685137, 29685276, 29687214 -29687220, 29687459, 29687718, 29687727, 29687763, 29688867, 29689145 -29689255, 29692694, 29694869, 29695425, 29695821, 29695841, 29696310 -29700125, 29700460, 29700770, 29703932, 29705793, 29707099, 29707493 -29707896, 29708876, 29708915, 29710188, 29710858, 29713810, 29715220 -29715703, 29716194, 29716227, 29716491, 29716602, 29716871, 29717659 -29717901, 29719146, 29720133, 29721418, 29721576, 29722167, 29724658 -29725476, 29725781, 29726695, 29738400, 29739576, 29741319, 29741976 -29742223, 29744225, 29746962, 29747493, 29747648, 29747653, 29748285 -29748336, 29748513, 29749471, 29750673, 29751094, 29753244, 29754196 -29754951, 29755821, 29756274, 29756444, 29757099, 29757264, 29757651 -29757687, 29758203, 29758217, 29758661, 29761678, 29761837, 29761911 -29763158, 29765035, 29765393, 29766207, 29766435, 29766503, 29766679 -29768899, 29770750, 29771032, 29771242, 29773197, 29773842, 29774362 -29775393, 29779196, 29780140, 29782211, 29782823, 29782866, 29784106 -29785239, 29785311, 29787292, 29787766, 29789911, 29791152, 29791880 -29792213, 29793318, 29794174, 29794462, 29795712, 29795957, 29796378 -29797726, 29802695, 29804875, 29805772, 29806390, 29807964, 29809792 -29809837, 29812084, 29812489, 29813503, 29813650, 29813671, 29815341 -29815713, 29817278, 29817547, 29817784, 29821582, 29822714, 29825525 -29827647, 29827852, 29831196, 29834506, 29836096, 29838485, 29838773 -29839715, 29840619, 29841267, 29841687, 29843277, 29843692, 29843831 -29844226, 29844275, 29845530, 29846126, 29846645, 29846688, 29848084 -29848849, 29849100, 29850930, 29851733, 29853485, 29856859, 29858121 -29858376, 29859068, 29860994, 29861075, 29864203, 29864261, 29865188 -29865590, 29865658, 29869086, 29869404, 29869887, 29869906, 29870065 -29871098, 29871312, 29872401, 29872937, 29872983, 29873665, 29874090 -29874761, 29875459, 29875565, 29876358, 29876989, 29877608, 29878076 -29881050, 29881478, 29881575, 29881643, 29881839, 29882427, 29882454 -29882729, 29884958, 29885890, 29886809, 29887111, 29888621, 29889184 -29889358, 29890740, 29891075, 29891853, 29891916, 29892604, 29893132 -29896510, 29897418, 29897863, 29900203, 29900824, 29901419, 29902299 -29902327, 29902330, 29902659, 29903190, 29903299, 29903357, 29903454 -29904002, 29906678, 29907942, 29908389, 29908777, 29909658, 29910402 -29912286, 29913805, 29913966, 29914449, 29914544, 29915217, 29915848 -29916975, 29919789, 29920025, 29920376, 29920804, 29921318, 29922225 -29923452, 29924181, 29926466, 29927756, 29928210, 29928427, 29928564 -29930457, 29932202, 29932430, 29932780, 29934052, 29937565, 29937956 -29938225, 29939400, 29939795, 29940373, 29942096, 29942275, 29942554 -29943670, 29943879, 29944035, 29944660, 29944963, 29945645, 29946388 -29947145, 29950220, 29951620, 29951759, 29956016, 29956222, 29957412 -29957493, 29958925, 29960884, 29961353, 29961609, 29961847, 29962160 -29962248, 29962834, 29962927, 29962939, 29965052, 29965603, 29965888 -29966768, 29967223, 29968085, 29969557, 29970081, 29970298, 29971027 -29971481, 29971888, 29971936, 29971951, 29972176, 29973012, 29989783 -29989845, 29991257, 29993717, 29997326, 29997553, 29997937, 30000664 -30001331, 30003187, 30006159, 30006985, 30007450, 30007797, 30008125 -30008198, 30008214, 30009710, 30012181, 30015070, 30017836, 30018017 -30018903, 30019864, 30024618, 30025814, 30026016, 30027614, 30028599 -30029519, 30029806, 30031027, 30032376, 30033040, 30033547, 30034456 -30035598, 30038392, 30039800, 30039959, 30040157, 30041501, 30042490 -30043398, 30043610, 30043930, 30044507, 30045389, 30045484, 30046497 -30047531, 30047702, 30047765, 30047931, 30049966, 30051176, 30051783 -30051804, 30052928, 30053036, 30053501, 30053748, 30054980, 30056058 -30057718, 30057799, 30058149, 30058453, 30059106, 30059109, 30060267 -30060330, 30062364, 30062819, 30064268, 30066352, 30067565, 30068871 -30071446, 30072905, 30073314, 30073744, 30074296, 30074349, 30074469 -30074472, 30074820, 30075037, 30076058, 30076197, 30076253, 30078675 -30078934, 30079949, 30080266, 30081546, 30081580, 30082145, 30083100 -30083216, 30083488, 30083807, 30084971, 30085897, 30086596, 30086992 -30090568, 30092280, 30092859, 30095591, 30095952, 30097092, 30097115 -30098251, 30099302, 30099420, 30099454, 30100354, 30101186, 30103551 -30103553, 30104378, 30104555, 30106748, 30109365, 30110224, 30110370 -30110518, 30114477, 30114489, 30114534, 30116085, 30116203, 30116854 -30117209, 30117335, 30117593, 30118261, 30118279, 30120608, 30122583 -30125765, 30126145, 30127522, 30127805, 30127904, 30128047, 30131286 -30131645, 30132708, 30133841, 30134746, 30135396, 30135731, 30135942 -30136346, 30139392, 30142907, 30143470, 30143593, 30146593, 30146969 -30147473, 30147928, 30149035, 30149658, 30150606, 30153552, 30153885 -30154633, 30155814, 30155837, 30159329, 30159511, 30159536, 30159752 -30159760, 30160625, 30163243, 30164714, 30165493, 30165503, 30165897 -30169254, 30170104, 30172925, 30173113, 30173556, 30174401, 30175291 -30177597, 30178250, 30178839, 30178990, 30179644, 30180208, 30181756 -30183696, 30183715, 30183920, 30184102, 30185852, 30186319, 30186476 -30186706, 30187866, 30189516, 30190090, 30191274, 30193165, 30193505 -30193736, 30194612, 30194710, 30194972, 30195667, 30195668, 30195684 -30196195, 30196358, 30196629, 30198861, 30198905, 30200034, 30200132 -30200237, 30200680, 30200758, 30202349, 30202388, 30203929, 30204042 -30204542, 30206493, 30206675, 30207473, 30208327, 30208723, 30209736 -30210884, 30213031, 30213540, 30215130, 30215302, 30215351, 30217206 -30217982, 30218044, 30218317, 30219222, 30221237, 30221298, 30222512 -30223712, 30223847, 30224650, 30224868, 30224950, 30225265, 30225443 -30225718, 30225844, 30226244, 30228567, 30229683, 30232638, 30235919 -30235979, 30236554, 30238211, 30238715, 30239480, 30240010, 30240547 -30241567, 30241920, 30242120, 30242724, 30243216, 30244340, 30246053 -30246179, 30247305, 30249432, 30251003, 30252005, 30252098, 30252156 -30252458, 30252977, 30253035, 30253090, 30253608, 30253705, 30253835 -30254206, 30254525, 30254726, 30255143, 30255528, 30256542, 30257412 -30264405, 30265523, 30265608, 30265615, 30265703, 30266791, 30267155 -30269428, 30269748, 30270647, 30270744, 30271114, 30272329, 30274090 -30274188, 30274324, 30275548, 30275569, 30275578, 30276243, 30277120 -30277451, 30277733, 30281428, 30282501, 30282591, 30283296, 30283577 -30283579, 30283581, 30283932, 30284219, 30284369, 30285457, 30285843 -30288343, 30288491, 30289458, 30293345, 30294267, 30294671, 30295110 -30295549, 30295808, 30297905, 30299367, 30299817, 30299934, 30300030 -30300538, 30305264, 30305395, 30305568, 30305880, 30307814, 30307883 -30308368, 30308624, 30308772, 30308947, 30309098, 30309798, 30311826 -30312094, 30312546, 30313848, 30314079, 30314198, 30314837, 30316667 -30316897, 30317209, 30318638, 30318943, 30319080, 30319099, 30322980 -30323658, 30323849, 30324180, 30325407, 30326882, 30327149, 30328168 -30328690, 30329209, 30330123, 30331759, 30332505, 30334484, 30334563 -30335127, 30335832, 30335987, 30336032, 30336742, 30339103, 30341713 -30342371, 30342878, 30344614, 30345201, 30345432, 30345809, 30346330 -30346867, 30349714, 30352581, 30352623, 30355490, 30357463, 30357897 -30360383, 30362003, 30362850, 30363716, 30364329, 30364613, 30365745 -30367193, 30368048, 30368482, 30368534, 30368668, 30371264, 30371623 -30371909, 30372081, 30373550, 30374345, 30374570, 30374739, 30375109 -30376986, 30377347, 30381207, 30381525, 30382982, 30383286, 30384121 -30384152, 30389229, 30389414, 30389507, 30391272, 30392011, 30393110 -30393653, 30394738, 30394974, 30396946, 30397100, 30398257, 30398422 -30399906, 30402386, 30403763, 30403881, 30403902, 30403989, 30404117 -30408515, 30408808, 30409207, 30409339, 30409590, 30412188, 30412863 -30412885, 30412921, 30413137, 30414679, 30414714, 30416034, 30417648 -30417732, 30419024, 30421439, 30421476, 30422487, 30423135, 30423218 -30424347, 30430921, 30431274, 30431504, 30431698, 30431703, 30431717 -30433177, 30437149, 30441687, 30441959, 30442749, 30442884, 30443393 -30446583, 30447060, 30447589, 30448182, 30448917, 30449194, 30450787 -30453442, 30454090, 30458568, 30458593, 30460922, 30461458, 30463938 -30464250, 30464655, 30466081, 30469777, 30472891, 30474167, 30474774 -30475115, 30476768, 30477588, 30477685, 30477691, 30477767, 30479715 -30480872, 30483140, 30483521, 30484042, 30484801, 30485255, 30486436 -30487387, 30490014, 30493518, 30495035, 30495133, 30495483, 30496957 -30497057, 30500224, 30500297, 30500344, 30500582, 30501574, 30502415 -30503943, 30505497, 30506794, 30506991, 30507032, 30509277, 30510347 -30510527, 30513285, 30513848, 30515886, 30516868, 30517214, 30519188 -30522285, 30522998, 30523137, 30523538, 30523601, 30523750, 30528547 -30528704, 30529940, 30533132, 30534351, 30534549, 30534662, 30534827 -30537405, 30537533, 30539519, 30540109, 30540407, 30544247, 30544595 -30545281, 30545556, 30549637, 30549789, 30549881, 30551000, 30551123 -30556581, 30556807, 30557386, 30560513, 30561590, 30564139, 30564343 -30573703, 30576393, 30577071, 30579051, 30581448, 30582500, 30588738 -30591028, 30592859, 30595114, 30595860, 30596488, 30598682, 30598746 -30598919, 30599405, 30599407, 30600173, 30600184, 30602230, 30605215 -30609799, 30612199, 30613937, 30613971, 30614411, 30619525, 30619787 -30622528, 30623138, 30623142, 30624792, 30624864, 30625121, 30628899 -30629643, 30629799, 30631393, 30633259, 30633938, 30635183, 30635302 -30635326, 30637270, 30637319, 30641755, 30641900, 30644889, 30651231 -30651621, 30651674, 30652515, 30652853, 30654558, 30657365, 30657624 -30657706, 30657875, 30658702, 30661939, 30662651, 30663646, 30668407 -30671813, 30674959, 30676209, 30681462, 30681516, 30686131, 30690686 -30691604, 30691731, 30691857, 30692473, 30698289, 30703610, 30704826 -30708735, 30710807, 30714151, 30714715, 30718862, 30719419, 30720736 -30720844, 30722705, 30724679, 30724881, 30727701, 30729604, 30730026 -30732711, 30734707, 30735736, 30740997, 30741263, 30749722, 30750991 -30751968, 30758943, 30761878, 30763272, 30763305, 30763639, 30765486 -30769312, 30773164, 30776416, 30776929, 30778855, 30781032, 30781041 -30783551, 30785101, 30789904, 30790441, 30801296, 30801510, 30803210 -30808869, 30812574, 30814285, 30815852, 30816938, 30823744, 30825391 -30825419, 30825656, 30826474, 30828350, 30829779, 30833454, 30834110 -30838605, 30847442, 30848773, 30851951, 30855101, 30857721, 30858919 -30866141, 30866988, 30871716, 30871792, 30880913, 30881407, 30883877 -30886188, 30887501, 30890720, 30890971, 30896620, 30904672, 30906274 -30909918, 30913399, 30914272, 30914674, 30919691, 30922936, 30922996 -30923517, 30923940, 30927821, 30930339, 30936831, 30937410, 30939934 -30940259, 30941056, 30944643, 30945005, 30952104, 30953836, 30957739 -30964194, 30968737, 30970518, 30972841, 30972966, 30973113, 30973137 -30973143, 30980317, 30980733, 30987088, 30990034, 30992597, 30993198 -30996991, 30998759, 30998847, 31001017, 31001455, 31001859, 31004077 -31004719, 31004844, 31008240, 31010976, 31013127, 31016413, 31019249 -31021157, 31022858, 31029936, 31031955, 31032904, 31039627, 31039928 -31051075, 31062010, 31066265, 31077365, 31084921, 31094688, 31100172 -31106577, 31113089, 31118809, 31119057, 31134430, 31153120, 31156383 -31172207, 31177193, 31182793, 31193936, 31200845, 31305624, 31306261 -31335037, 31335142, 31338673, 31359215, 31383396, 31393600, 31414023 -31414524 -``` - -## Version 19\.0\.0\.0\.ru\-2020\-04\.rur\-2020\-04\.r1 - -Version 19\.0\.0\.0\.ru\-2020\-04\.rur\-2020\-04\.r1 includes the following: -+ Patch 30869156: Database Release Update 19\.7\.0\.0\.200414 -+ Patch 30805684: Oracle JVM Release Update 19\.7\.0\.0\.200414 -+ Patch 29997937: DSTv34 UPDATE for RDBMS \(TZDATA2019B\) -+ Patch 29997959: DSTV34 UPDATE for OJVM \(TZDATA2019B\) -+ PreUpgrade Jar: preupgrade\_19\_cbuild\_5\_lf\.zip -+ Patch 28730253: SUPPORT NEW ERA REIWA FOR JAPANESE IMPERIAL CALENDAR -+ Patch 29213893: DBMS\_STATS FAILING WITH ERROR ORA\-01422 WHEN GATHERING STATS FOR USER$ TABLE -+ Patch 30528704: 19C RMAN RECOVER DATABASE USE REDO LOG INSTEAD OF ARCHIVELOG AFTER APPLYING OCT DATABASE RU -+ Support for [Purging the recycle bin](Appendix.Oracle.CommonDBATasks.Database.md#Appendix.Oracle.CommonDBATasks.PurgeRecycleBin) -+ Support for [Generating performance reports with Automatic Workload Repository \(AWR\)](Appendix.Oracle.CommonDBATasks.Database.md#Appendix.Oracle.CommonDBATasks.AWR) using the `rdsadmin.rdsadmin_diagnostic_util` package - -### Combined patches for version 19\.0\.0\.0\.ru\-2020\-04\.rur\-2020\-04\.r1, released April 2020 - -Bugs fixed: - -``` -30533132, 30312546, 29924181, 29549154, 30937410, 29970081, 8476681 -14735102, 17428816, 19080742, 19697993, 20313356, 21374587, 21965541 -23296836, 23606241, 24687075, 24971456, 25756945, 25806201, 25883179 -25986062, 25997810, 26284288, 26476244, 26611353, 26668264, 26739322 -26777814, 26872233, 27036163, 27044169, 27101798, 27126122, 27126938 -27166935, 27195935, 27244999, 27254335, 27359766, 27369515, 27378053 -27406105, 27411022, 27423500, 27439716, 27453490, 27458357, 27489107 -27582210, 27666312, 27710072, 27729678, 27801144, 27846298, 27880025 -27929509, 27934711, 27935464, 27941110, 27957203, 27967484, 28064977 -28072567, 28109326, 28125947, 28129791, 28181021, 28189466, 28204262 -28205555, 28209985, 28210681, 28263142, 28271258, 28271693, 28276054 -28279456, 28294563, 28313275, 28319114, 28326928, 28350595, 28371123 -28373960, 28375383, 28379065, 28381939, 28386259, 28390273, 28395302 -28397317, 28402823, 28410431, 28431445, 28435333, 28454215, 28463226 -28475242, 28484299, 28489419, 28492006, 28498976, 28502773, 28513333 -28521330, 28530171, 28534475, 28535127, 28538439, 28542455, 28546290 -28547068, 28547926, 28558645, 28561704, 28564479, 28565296, 28567417 -28567819, 28569897, 28572407, 28572533, 28572544, 28572667, 28572834 -28578945, 28587723, 28589509, 28593682, 28594086, 28597221, 28601957 -28605066, 28606598, 28608211, 28612239, 28620697, 28622202, 28625862 -28627033, 28628592, 28632796, 28636532, 28639299, 28643654, 28643718 -28644549, 28645570, 28646200, 28646939, 28649388, 28655209, 28663782 -28672457, 28673945, 28681153, 28692103, 28692275, 28694639, 28694872 -28696373, 28705231, 28707931, 28708400, 28709063, 28710385, 28710469 -28710734, 28714461, 28715727, 28718469, 28719348, 28720204, 28720418 -28721497, 28722229, 28730079, 28734355, 28740708, 28742555, 28749853 -28752923, 28755011, 28758722, 28760206, 28765983, 28767240, 28769456 -28771947, 28772390, 28774416, 28776811, 28777214, 28781754, 28785531 -28789531, 28791852, 28795551, 28795734, 28802734, 28804517, 28808656 -28810381, 28811560, 28815123, 28815355, 28817449, 28819640, 28820669 -28821847, 28824482, 28827682, 28831971, 28833912, 28835937, 28836716 -28838385, 28844738, 28845346, 28846759, 28849776, 28854004, 28855520 -28855922, 28857552, 28862532, 28863263, 28863432, 28863487, 28865569 -28867992, 28872645, 28873575, 28875089, 28876253, 28876639, 28876926 -28878865, 28882784, 28884931, 28887305, 28888327, 28889730, 28892794 -28897512, 28899663, 28901126, 28905457, 28905615, 28907196, 28912691 -28915561, 28917080, 28918429, 28919145, 28922227, 28922532, 28922608 -28925634, 28925880, 28927452, 28932914, 28933158, 28935293, 28936114 -28937717, 28938422, 28938698, 28940179, 28940281, 28941901, 28942455 -28945421, 28945994, 28946233, 28949888, 28950868, 28951533, 28952168 -28954762, 28955606, 28955883, 28956908, 28957292, 28957723, 28958088 -28959493, 28960863, 28962775, 28965084, 28965095, 28965231, 28965376 -28966444, 28974083, 28977322, 28981871, 28983095, 28983486, 28985478 -28986207, 28986231, 28986257, 28986326, 28986481, 28988482, 28989306 -28993295, 28993353, 28994307, 28994542, 28996376, 29000000, 29001305 -29001888, 29002488, 29002784, 29002927, 29003407, 29003738, 29006318 -29006621, 29007321, 29007353, 29007775, 29008035, 29008669, 29009513 -29010126, 29011936, 29012609, 29013475, 29013832, 29014076, 29015118 -29017265, 29018655, 29019121, 29021063, 29021352, 29022986, 29024054 -29024552, 29024732, 29026582, 29026606, 29027456, 29027694, 29027940 -29031575, 29031600, 29032234, 29032276, 29032457, 29032607, 29033052 -29033145, 29033200, 29033280, 29034587, 29037290, 29038528, 29038728 -29039089, 29039510, 29040739, 29043554, 29043651, 29043725, 29044763 -29044954, 29046482, 29047850, 29048178, 29048289, 29048498, 29048605 -29050357, 29050560, 29050765, 29050886, 29051702, 29051953, 29052726 -29053783, 29056024, 29056270, 29056560, 29056767, 29056894, 29059011 -29060216, 29061016, 29061959, 29062692, 29062848, 29062860, 29062868 -29110526, 29110783, 29110790, 29110797, 29110802, 29110805, 29111598 -29113282, 29113305, 29115857, 29117526, 29117642, 29118543, 29119077 -29120223, 29122224, 29122254, 29123297, 29123432, 29123482, 29124368 -29125036, 29125374, 29125380, 29126345, 29127957, 29128693, 29128935 -29129450, 29129497, 29129712, 29130219, 29131539, 29132869, 29132938 -29133470, 29134447, 29135383, 29135649, 29136111, 29138641, 29139761 -29139956, 29141316, 29141341, 29141685, 29142609, 29142667, 29143516 -29144995, 29145214, 29145730, 29149829, 29150338, 29151520, 29152357 -29154725, 29155099, 29157051, 29157389, 29158680, 29158899, 29159909 -29159936, 29160174, 29161597, 29162095, 29163073, 29163156, 29163415 -29163437, 29163524, 29163567, 29164376, 29167111, 29167342, 29167374 -29167940, 29168137, 29168219, 29168433, 29169073, 29169215, 29170232 -29171683, 29171942, 29172618, 29172826, 29173140, 29173373, 29173817 -29174004, 29174753, 29176318, 29177466, 29177543, 29177886, 29178385 -29179097, 29180313, 29180455, 29180559, 29180893, 29181153, 29181231 -29181620, 29181743, 29181923, 29182019, 29182517, 29182901, 29183912 -29184297, 29184666, 29185193, 29186456, 29189302, 29189307, 29189889 -29190235, 29190474, 29190663, 29190740, 29191541, 29192419, 29192468 -29192685, 29193207, 29194205, 29194367, 29194493, 29194827, 29194981 -29195279, 29195337, 29195758, 29196725, 29198092, 29198913, 29199635 -29199733, 29200316, 29200700, 29201494, 29201539, 29201787, 29202104 -29202461, 29202850, 29203122, 29203166, 29203227, 29203425, 29203443 -29203604, 29205281, 29205323, 29205419, 29205463, 29205767, 29205918 -29206109, 29206605, 29207073, 29208260, 29208732, 29211457, 29211724 -29212012, 29212433, 29212611, 29213320, 29213351, 29213613, 29213775 -29213850, 29213879, 29214561, 29214960, 29216312, 29216723, 29216746 -29216984, 29217294, 29217472, 29217828, 29217848, 29218570, 29219205 -29219273, 29220079, 29221248, 29221891, 29221942, 29222031, 29222784 -29223833, 29223859, 29223967, 29224065, 29224605, 29225076, 29225168 -29225758, 29227602, 29228869, 29229164, 29229754, 29229844, 29229955 -29230252, 29230565, 29231133, 29232117, 29232154, 29232449, 29233415 -29233810, 29233953, 29234123, 29236573, 29237538, 29237575, 29237744 -29240307, 29240759, 29241345, 29241651, 29242017, 29242884, 29243958 -29245137, 29245160, 29246163, 29247415, 29247712, 29247906, 29248495 -29248552, 29248835, 29248858, 29249289, 29249412, 29249991, 29250059 -29250317, 29251259, 29253184, 29253871, 29254031, 29254930, 29255178 -29255273, 29255431, 29255435, 29255973, 29256426, 29259119, 29259320 -29260452, 29260956, 29261547, 29261548, 29261906, 29262512, 29262887 -29265448, 29266248, 29266899, 29267292, 29268412, 29269171, 29269228 -29269825, 29270585, 29273539, 29273570, 29273735, 29273812, 29273847 -29274428, 29274564, 29274627, 29275461, 29276272, 29277317, 29278218 -29278684, 29279658, 29279751, 29279854, 29281527, 29281691, 29281796 -29282233, 29282898, 29285197, 29285503, 29285788, 29285956, 29286037 -29286229, 29287130, 29287705, 29292837, 29293072, 29293574, 29297863 -29297915, 29298220, 29299049, 29299082, 29299844, 29301463, 29301566 -29302963, 29303918, 29304781, 29306226, 29306713, 29307638, 29311528 -29311588, 29312310, 29312672, 29312734, 29312753, 29312889, 29313347 -29313417, 29313525, 29314539, 29314636, 29317756, 29318410, 29319441 -29321489, 29323946, 29324568, 29324735, 29325087, 29325105, 29325257 -29325765, 29325993, 29327044, 29327892, 29329042, 29329087, 29329807 -29330361, 29331066, 29331209, 29331380, 29331493, 29332292, 29332395 -29332763, 29332771, 29333500, 29336843, 29337310, 29337742, 29338315 -29338348, 29338453, 29338780, 29338913, 29339101, 29339155, 29341209 -29343086, 29343156, 29343861, 29345937, 29346057, 29346211, 29346943 -29347620, 29348176, 29350052, 29350762, 29351044, 29351386, 29351662 -29351716, 29351735, 29351749, 29351771, 29352298, 29352724, 29352867 -29352947, 29353271, 29353432, 29353821, 29353960, 29355654, 29356547 -29356704, 29356711, 29356752, 29356782, 29358509, 29358828, 29360252 -29360285, 29360672, 29360911, 29360950, 29361319, 29361472, 29361801 -29363151, 29364171, 29364177, 29366940, 29367019, 29367561, 29368253 -29368310, 29372541, 29373418, 29373588, 29374179, 29375355, 29375941 -29375984, 29376346, 29377804, 29377986, 29378029, 29378287, 29378834 -29378913, 29379750, 29379978, 29382641, 29382784, 29382815, 29383695 -29384781, 29384854, 29384864, 29385339, 29385429, 29385652, 29386502 -29386635, 29386660, 29387073, 29387274, 29387310, 29388020, 29388072 -29388094, 29388524, 29388830, 29389889, 29390011, 29390435, 29390785 -29391030, 29391237, 29391438, 29391849, 29391925, 29392966, 29393291 -29394014, 29394140, 29394749, 29395657, 29397954, 29397996, 29398488 -29398863, 29399046, 29399100, 29399121, 29399336, 29399938, 29402131 -29404483, 29405012, 29405462, 29405651, 29405996, 29407488, 29407804 -29408853, 29409149, 29409455, 29410311, 29410834, 29411037, 29411469 -29412066, 29412269, 29413382, 29413517, 29413544, 29413634, 29416688 -29416700, 29417084, 29417173, 29417719, 29417884, 29418165, 29420834 -29421059, 29423003, 29423016, 29423156, 29423826, 29424999, 29426241 -29426320, 29429017, 29429087, 29429264, 29429466, 29429566, 29430524 -29430866, 29431192, 29431485, 29432176, 29434301, 29435474, 29435652 -29436454, 29436514, 29436522, 29436727, 29437594, 29437712, 29438150 -29438277, 29438736, 29439522, 29441196, 29443187, 29443250, 29444072 -29444282, 29444602, 29446669, 29448498, 29449477, 29449845, 29449852 -29450162, 29450193, 29450421, 29450812, 29450936, 29451386, 29452251 -29452576, 29452936, 29452953, 29454978, 29455424, 29456538, 29456714 -29457312, 29457370, 29457502, 29457807, 29457978, 29460252, 29461420 -29461791, 29462594, 29462767, 29462957, 29463047, 29463528, 29463798 -29464616, 29464779, 29465177, 29466674, 29467622, 29469565, 29470291 -29471832, 29471860, 29472618, 29473708, 29476473, 29481584, 29483452 -29483532, 29483626, 29483672, 29483685, 29483712, 29483723, 29483771 -29485099, 29486181, 29486848, 29487189, 29488894, 29489436, 29489546 -29490256, 29492127, 29492939, 29493122, 29494245, 29495057, 29495684 -29497311, 29497588, 29497696, 29498198, 29500257, 29500826, 29500963 -29502561, 29503543, 29503631, 29503827, 29504492, 29504682, 29505668 -29507270, 29507616, 29508681, 29509777, 29510278, 29511611, 29511980 -29512890, 29514479, 29515134, 29515240, 29515476, 29515766, 29515834 -29516300, 29516727, 29516766, 29517168, 29517883, 29519131, 29521187 -29521688, 29521748, 29521862, 29522358, 29522561, 29522662, 29523055 -29523216, 29523511, 29524599, 29524985, 29525467, 29525886, 29526966 -29527595, 29527610, 29528368, 29529147, 29530440, 29530515, 29530812 -29530909, 29531654, 29531836, 29532532, 29536342, 29536445, 29538631 -29541742, 29541769, 29542084, 29542449, 29542580, 29542643, 29543034 -29543956, 29546817, 29547010, 29547867, 29548427, 29548592, 29548687 -29548722, 29549040, 29549071, 29549104, 29549730, 29552773, 29553141 -29554092, 29557144, 29557261, 29557336, 29557556, 29558238, 29558452 -29558975, 29559187, 29559446, 29559908, 29559981, 29564592, 29564593 -29565611, 29580394, 29580983, 29581771, 29584261, 29584693, 29586143 -29587765, 29589544, 29591343, 29592215, 29597536, 29597754, 29598039 -29598046, 29598233, 29599008, 29599300, 29601461, 29602831, 29603460 -29603884, 29604002, 29604257, 29607136, 29607797, 29608000, 29610506 -29611020, 29611991, 29615824, 29616244, 29616414, 29618074, 29618190 -29620042, 29622936, 29625065, 29625804, 29625876, 29626154, 29626732 -29628200, 29629430, 29629650, 29629681, 29629745, 29631749, 29632095 -29632265, 29632611, 29633697, 29633753, 29633936, 29634643, 29635427 -29635717, 29635990, 29637362, 29637526, 29638285, 29641736, 29643721 -29644464, 29645349, 29647176, 29648928, 29651183, 29651520, 29653132 -29653246, 29655668, 29656400, 29656819, 29656843, 29657399, 29657422 -29657744, 29657960, 29661028, 29661065, 29661722, 29663191, 29663368 -29663494, 29663601, 29664087, 29664161, 29665940, 29667527, 29667994 -29668005, 29669413, 29670782, 29671363, 29672507, 29675446, 29676089 -29677051, 29677173, 29677733, 29677927, 29679856, 29681987, 29683039 -29683211, 29684518, 29685137, 29685276, 29687214, 29687220, 29687459 -29687718, 29687763, 29689145, 29689255, 29692694, 29694869, 29695425 -29695841, 29696310, 29700125, 29700460, 29700770, 29703932, 29707099 -29707493, 29707896, 29708915, 29710188, 29710858, 29713810, 29715220 -29716194, 29716227, 29716491, 29716871, 29717659, 29719146, 29720133 -29721418, 29721576, 29724658, 29725476, 29725781, 29726695, 29738400 -29739576, 29741976, 29742223, 29744225, 29746962, 29747493, 29747648 -29747653, 29748285, 29748336, 29748513, 29749471, 29750673, 29751094 -29753244, 29754196, 29754951, 29755821, 29756274, 29756444, 29757099 -29757264, 29757651, 29758203, 29758217, 29758661, 29761678, 29761837 -29761911, 29763158, 29765035, 29765393, 29766207, 29766503, 29766679 -29768899, 29770750, 29771032, 29771242, 29773197, 29773842, 29775393 -29779196, 29780140, 29782211, 29782823, 29782866, 29784106, 29785239 -29787292, 29787766, 29791152, 29791880, 29792213, 29793318, 29794174 -29794462, 29795712, 29795957, 29796378, 29797726, 29802695, 29804875 -29805772, 29807964, 29809792, 29809837, 29812489, 29813503, 29813650 -29813671, 29815713, 29817278, 29817784, 29821582, 29825525, 29827647 -29827852, 29831196, 29834506, 29836096, 29838485, 29838773, 29839715 -29840619, 29841267, 29841687, 29843277, 29843692, 29843831, 29844226 -29845530, 29846126, 29846645, 29846688, 29848084, 29848849, 29849100 -29850930, 29851733, 29853485, 29856859, 29858121, 29858376, 29859068 -29860994, 29861075, 29864203, 29864261, 29865188, 29865590, 29865658 -29869086, 29869404, 29869887, 29870065, 29871098, 29872401, 29872937 -29872983, 29873665, 29875459, 29875565, 29876358, 29876989, 29877608 -29878076, 29881050, 29881478, 29881643, 29881839, 29882427, 29882729 -29884958, 29885890, 29887111, 29888621, 29889184, 29890740, 29891075 -29891853, 29891916, 29892604, 29893132, 29896510, 29897418, 29897863 -29900203, 29900824, 29902299, 29902327, 29902330, 29902659, 29903190 -29903299, 29903454, 29904002, 29906678, 29907942, 29908389, 29908777 -29909658, 29910402, 29912286, 29913966, 29914449, 29914544, 29915217 -29915848, 29916975, 29919789, 29920025, 29920376, 29920804, 29921318 -29923452, 29926466, 29927756, 29928210, 29928427, 29928564, 29932202 -29932430, 29932780, 29934052, 29937565, 29938225, 29939400, 29939795 -29940373, 29942096, 29942554, 29943670, 29944035, 29944660, 29944963 -29945645, 29946388, 29947145, 29950220, 29951620, 29956016, 29956222 -29957412, 29957493, 29961353, 29961609, 29962160, 29962248, 29962834 -29962927, 29962939, 29965052, 29965603, 29965888, 29966768, 29967223 -29968085, 29969557, 29970298, 29971027, 29971481, 29971888, 29971951 -29972176, 29973012, 29989783, 29989845, 29991257, 29993717, 29997326 -29997553, 30000664, 30001331, 30003187, 30006159, 30006985, 30007450 -30007797, 30008125, 30008198, 30008214, 30009710, 30012181, 30015070 -30017836, 30018017, 30019864, 30024618, 30025814, 30026016, 30028599 -30029519, 30029806, 30031027, 30032376, 30033547, 30034456, 30035598 -30038392, 30039800, 30039959, 30040157, 30041501, 30042490, 30043398 -30043610, 30043930, 30044507, 30046497, 30047531, 30047702, 30047765 -30047931, 30049966, 30051176, 30051783, 30051804, 30052928, 30053036 -30053501, 30053748, 30054980, 30056058, 30057718, 30057799, 30058149 -30058453, 30059106, 30059109, 30062364, 30064268, 30066352, 30067565 -30071446, 30072905, 30073314, 30073744, 30074296, 30074349, 30074469 -30074472, 30075037, 30076058, 30076197, 30076253, 30078675, 30078934 -30079949, 30080266, 30081546, 30081580, 30082145, 30083100, 30083216 -30083488, 30083807, 30084971, 30085897, 30086596, 30086992, 30090568 -30092859, 30095591, 30095952, 30097092, 30097115, 30098251, 30099302 -30099420, 30099454, 30100354, 30101186, 30103551, 30103553, 30104378 -30104555, 30106748, 30109365, 30110224, 30110370, 30110518, 30114477 -30114489, 30114534, 30116085, 30116854, 30117335, 30117593, 30118261 -30118279, 30120608, 30122583, 30127522, 30127904, 30128047, 30131286 -30131645, 30135396, 30135731, 30135942, 30136346, 30139392, 30142907 -30143470, 30143593, 30147473, 30147928, 30149035, 30149658, 30150606 -30153885, 30154633, 30155814, 30155837, 30159329, 30159511, 30159536 -30159752, 30159760, 30163243, 30164714, 30165493, 30165503, 30165897 -30169254, 30170104, 30172925, 30173113, 30173556, 30174401, 30175291 -30177597, 30178250, 30178839, 30178990, 30179644, 30180208, 30181756 -30183920, 30184102, 30185852, 30186319, 30186476, 30186706, 30187866 -30189516, 30190090, 30191274, 30193165, 30193505, 30194612, 30194710 -30194972, 30195667, 30195668, 30195684, 30196195, 30196358, 30198861 -30198905, 30200034, 30200237, 30200758, 30202349, 30202388, 30204542 -30206493, 30206675, 30207473, 30208327, 30209736, 30210884, 30213031 -30213540, 30215130, 30215302, 30215351, 30217206, 30217982, 30218044 -30218317, 30221237, 30222512, 30223712, 30223847, 30224650, 30224868 -30224950, 30225265, 30225718, 30225844, 30228567, 30229683, 30232638 -30235919, 30235979, 30236554, 30238211, 30239480, 30240010, 30241567 -30242120, 30242724, 30244340, 30246053, 30246179, 30247305, 30249432 -30252005, 30252098, 30252156, 30252458, 30252977, 30253035, 30253090 -30253608, 30253835, 30254525, 30254726, 30255143, 30255528, 30256542 -30257412, 30264405, 30265523, 30265608, 30265703, 30266791, 30267155 -30269428, 30269748, 30270647, 30270744, 30271114, 30272329, 30274090 -30274188, 30274324, 30275578, 30276243, 30277120, 30277451, 30282501 -30282591, 30283296, 30283577, 30283579, 30283581, 30283932, 30284219 -30284369, 30285457, 30285843, 30288343, 30288491, 30289458, 30294267 -30294671, 30295110, 30295549, 30299367, 30299817, 30299934, 30300030 -30300538, 30305264, 30305395, 30305568, 30305880, 30307814, 30307883 -30308368, 30308624, 30308772, 30309098, 30309798, 30312094, 30313848 -30314079, 30314837, 30316667, 30317209, 30318638, 30318943, 30319080 -30322980, 30323658, 30323849, 30324180, 30327149, 30328168, 30330123 -30334484, 30334563, 30335127, 30335832, 30335987, 30336032, 30336742 -30339103, 30341713, 30342371, 30342878, 30345201, 30352581, 30352623 -30355490, 30357463, 30362003, 30362850, 30363716, 30364329, 30364613 -30365745, 30367193, 30368048, 30368534, 30371909, 30374345, 30374570 -30374739, 30375109, 30381525, 30383286, 30384121, 30384152, 30389229 -30389414, 30389507, 30392011, 30394738, 30394974, 30398257, 30398422 -30399906, 30402386, 30403763, 30403902, 30403989, 30404117, 30408515 -30408808, 30409207, 30409339, 30409590, 30412188, 30412921, 30413137 -30414714, 30416034, 30421476, 30422487, 30424347, 30430921, 30431274 -30431504, 30431698, 30431703, 30431717, 30441687, 30441959, 30442749 -30442884, 30447060, 30448917, 30449194, 30453442, 30454090, 30458568 -30458593, 30460922, 30463938, 30464250, 30469777, 30474167, 30474774 -30475115, 30477588, 30477767, 30479715, 30485255, 30490014, 30493518 -30495133, 30495483, 30496957, 30497057, 30500344, 30501574, 30503943 -30505497, 30506794, 30507032, 30509277, 30510347, 30510527, 30513285 -30513848, 30516868, 30517214, 30522285, 30523750, 30534351, 30534549 -30534827, 30537405, 30537533, 30540109, 30544247, 30545281, 30549637 -30549789, 30549881, 30564139, 30573703, 30576393, 30577071, 30579051 -30582500, 30592859, 30598682, 30598746, 30599405, 30600184, 30602230 -30609799, 30612199, 30613937, 30613971, 30619787, 30623142, 30629799 -30633259, 30635302, 30641755, 30654558, 30657875, 30661939, 30662651 -30671813, 30676209, 30708735, 30720736, 30730026, 30732711, 30741263 -30761878, 30776416, 30783551, 30785101, 30790441, 30803210, 30808869 -30815852, 30825391, 30825419, 30881407, 30886188, 30890971, 30919691 -30922996, 30993198, 31016413, 29997959, 29997937, 28852325, 28730253 -29213893, 30528704, 29540327, 29254623, 29445548, 29774362, 30134746 -30160625, 29942275, 30534662, 29512125, 30855101, 27222128, 27572040 -27604329, 27760043, 27877830, 28302580, 28470673, 28621543, 28642469 -28699321, 28710663, 28755846, 28772816, 28785321, 28800508, 28808652 -28815557, 28847541, 28847572, 28870496, 28871040, 28874416, 28877252 -28881191, 28881848, 28888083, 28911140, 28925250, 28925460, 28935956 -28940472, 3, 28942694, 28951332, 28963036, 28968779, 28980448, 28995287 -29003207, 29003617, 29016294, 29018680, 29024876, 29026154, 29027933 -29047127, 29052850, 29058476, 29111631, 29112455, 29117337, 29123444 -29125708, 29125786, 29129476, 29131772, 29132456, 29139727, 29146157 -29147849, 29149170, 29152603, 29152752, 29154631, 29154636, 29154829 -29159216, 29159661, 29160462, 29161923, 29169540, 29169739, 29170717 -29173618, 29181568, 29182920, 29183298, 29186091, 29191827, 29201143 -29201695, 29209545, 29210577, 29210610, 29210624, 29210683, 29213641 -29219627, 29224294, 29225861, 29229839, 29235934, 29242906, 29243749 -29244495, 29244766, 29244968, 29248723, 29249583, 29251564, 29255616 -29260224, 29261695, 29271019, 29273360, 29282090, 29282666, 29285453 -29285621, 29290235, 29292232, 29293806, 29294753, 29299830, 29307090 -29307109, 29311336, 29329675, 29330791, 29339299, 29357821, 29360467 -29360775, 29367971, 29368725, 29379299, 29379381, 29380527, 29381000 -29382296, 29391301, 29393649, 29402110, 29411931, 29413360, 29457319 -29465047 -``` - -## Version 19\.0\.0\.0\.ru\-2020\-01\.rur\-2020\-01\.r1 - -Version 19\.0\.0\.0\.ru\-2020\-01\.rur\-2020\-01\.r1 includes the following: -+ Patch 30557433: Database Release Update: 19\.6\.0\.0\.200114 -+ Patch 30484981: OJVM RELEASE UPDATE: 19\.6\.0\.0\.200114 -+ Patch 29997937: DSTv34 UPDATE for RDBMS \(TZDATA2019B\) -+ Patch 29997959: DSTV34 UPDATE for OJVM \(TZDATA2019B\) -+ PreUpgrade Jar: preupgrade\_19\_cbuild\_5\_lf\.zip -+ Patch 28730253: SUPPORT NEW ERA REIWA FOR JAPANESE IMPERIAL CALENDAR -+ Patch 29213893: DBMS\_STATS FAILING WITH ERROR ORA\-01422 WHEN GATHERING STATS FOR USER$ TABLE -+ Patch 30528704: 19C RMAN RECOVER DATABASE USE REDO LOG INSTEAD OF ARCHIVELOG AFTER APPLYING OCT DATABASE RU - -### Oracle release update 19\.6\.0\.0\.200114, released January 2020 - -Bugs fixed: - -``` - -30545281, 8476681, 14735102, 17428816, 19080742, 19697993, 20313356 -21374587, 21965541, 23296836, 23606241, 24687075, 25756945, 25806201 -25883179, 25986062, 25997810, 26476244, 26611353, 26739322, 26777814 -26872233, 27036163, 27044169, 27101798, 27126938, 27195935, 27244999 -27254335, 27359766, 27369515, 27406105, 27411022, 27423500, 27439716 -27453490, 27458357, 27489107, 27666312, 27710072, 27729678, 27846298 -27880025, 27934711, 27935464, 27941110, 27957203, 27967484, 28064977 -28072567, 28109326, 28125947, 28129791, 28181021, 28189466, 28204262 -28205555, 28209985, 28210681, 28271258, 28271693, 28279456, 28294563 -28313275, 28319114, 28326928, 28350595, 28371123, 28373960, 28375383 -28379065, 28381939, 28386259, 28390273, 28395302, 28397317, 28402823 -28410431, 28431445, 28435333, 28454215, 28463226, 28475242, 28484299 -28489419, 28492006, 28498976, 28502773, 28513333, 28521330, 28530171 -28534475, 28538439, 28542455, 28546290, 28547068, 28547926, 28558645 -28561704, 28567417, 28567819, 28569897, 28572407, 28572533, 28572544 -28572667, 28572834, 28578945, 28587723, 28589509, 28593682, 28594086 -28597221, 28601957, 28605066, 28606598, 28612239, 28620697, 28625862 -28627033, 28636532, 28639299, 28643718, 28644549, 28645570, 28646200 -28646939, 28649388, 28655209, 28663782, 28672457, 28673945, 28692103 -28692275, 28694872, 28696373, 28705231, 28710385, 28710734, 28714461 -28715727, 28718469, 28719348, 28720204, 28720418, 28721497, 28722229 -28730079, 28734355, 28740708, 28742555, 28749853, 28752923, 28755011 -28758722, 28760206, 28765983, 28767240, 28769456, 28772390, 28774416 -28776811, 28777214, 28781754, 28785531, 28789531, 28791852, 28795551 -28795734, 28802734, 28804517, 28810381, 28811560, 28815123, 28815355 -28817449, 28819640, 28820669, 28821847, 28824482, 28827682, 28831971 -28833912, 28835937, 28836716, 28844738, 28849776, 28854004, 28855520 -28855922, 28857552, 28862532, 28863432, 28863487, 28867992, 28873575 -28875089, 28876253, 28876639, 28878865, 28882784, 28884931, 28887305 -28888327, 28889730, 28892794, 28897512, 28899663, 28901126, 28905457 -28905615, 28907196, 28912691, 28915561, 28917080, 28918429, 28919145 -28922227, 28922532, 28922608, 28925634, 28925880, 28927452, 28932914 -28933158, 28935293, 28936114, 28937717, 28938698, 28940179, 28940281 -28941901, 28942455, 28945421, 28945994, 28949888, 28950868, 28951533 -28952168, 28954762, 28955606, 28955883, 28956908, 28957292, 28957723 -28958088, 28959493, 28960863, 28962775, 28965084, 28965095, 28965231 -28965376, 28966444, 28974083, 28977322, 28983095, 28983486, 28985478 -28986207, 28986231, 28986257, 28986326, 28986481, 28988482, 28989306 -28993295, 28993353, 28994307, 28996376, 29000000, 29001305, 29001888 -29002488, 29002784, 29002927, 29003407, 29003738, 29006318, 29006621 -29007321, 29007353, 29007775, 29008035, 29008669, 29009513, 29010126 -29011936, 29012609, 29013475, 29013832, 29014076, 29015118, 29017265 -29018655, 29019121, 29021063, 29021352, 29022986, 29024054, 29024552 -29024732, 29026582, 29026606, 29027456, 29027694, 29027940, 29031575 -29031600, 29032234, 29032276, 29032457, 29032607, 29033052, 29033145 -29033200, 29033280, 29034587, 29037290, 29038528, 29038728, 29039089 -29039510, 29040739, 29043554, 29043651, 29043725, 29044763, 29044954 -29046482, 29047850, 29048178, 29048289, 29048498, 29048605, 29050357 -29050560, 29050765, 29050886, 29051702, 29051953, 29052726, 29053783 -29056024, 29056270, 29056560, 29056767, 29056894, 29059011, 29060216 -29061016, 29061959, 29062692, 29062848, 29062860, 29062868, 29110526 -29110783, 29110790, 29110797, 29110802, 29110805, 29111598, 29113282 -29113305, 29115857, 29117526, 29117642, 29118543, 29119077, 29120223 -29122224, 29122254, 29123297, 29123432, 29123482, 29124368, 29125036 -29125374, 29125380, 29126345, 29127957, 29128693, 29128935, 29129450 -29129497, 29129712, 29130219, 29131539, 29132869, 29132938, 29133470 -29134447, 29135383, 29135649, 29136111, 29138641, 29139956, 29141316 -29141341, 29141685, 29142609, 29142667, 29143516, 29144995, 29145214 -29145730, 29149829, 29150338, 29151520, 29152357, 29155099, 29157051 -29157389, 29158680, 29158899, 29159909, 29159936, 29160174, 29162095 -29163156, 29163415, 29163437, 29163524, 29163567, 29167111, 29167342 -29167374, 29167940, 29168137, 29168219, 29168433, 29169073, 29169215 -29170232, 29171683, 29171942, 29172618, 29172826, 29173140, 29173373 -29173817, 29174004, 29176318, 29177466, 29177543, 29177886, 29178385 -29180313, 29180455, 29180559, 29180893, 29181153, 29181231, 29181620 -29181743, 29181923, 29182019, 29182517, 29182901, 29183912, 29184297 -29184666, 29185193, 29186456, 29189302, 29189307, 29189889, 29190235 -29190474, 29190663, 29190740, 29191541, 29192419, 29192468, 29192685 -29193207, 29194205, 29194367, 29194493, 29194827, 29194981, 29195279 -29195337, 29195758, 29196725, 29198092, 29198913, 29199635, 29199733 -29200316, 29200700, 29201494, 29201539, 29201787, 29202104, 29202461 -29202850, 29203122, 29203166, 29203425, 29203443, 29203604, 29205281 -29205323, 29205419, 29205463, 29205767, 29205918, 29206109, 29206605 -29207073, 29208260, 29208732, 29211457, 29211724, 29212012, 29212433 -29212611, 29213320, 29213351, 29213613, 29213775, 29213850, 29213879 -29214561, 29214960, 29216312, 29216723, 29216746, 29216984, 29217294 -29217472, 29217828, 29217848, 29218570, 29219205, 29219273, 29220079 -29221248, 29221891, 29221942, 29222031, 29222784, 29223833, 29223859 -29223967, 29224065, 29224605, 29225076, 29225168, 29225758, 29227602 -29228869, 29229164, 29229754, 29229844, 29229955, 29230252, 29230565 -29231133, 29232117, 29232154, 29232449, 29233415, 29233810, 29233953 -29234123, 29236573, 29237538, 29237575, 29237744, 29240307, 29240759 -29241345, 29241651, 29242017, 29242884, 29243958, 29245137, 29245160 -29246163, 29247415, 29247712, 29247906, 29248495, 29248552, 29248835 -29248858, 29249412, 29249991, 29250059, 29250317, 29251259, 29253184 -29253871, 29254031, 29254930, 29255178, 29255273, 29255431, 29255435 -29256426, 29259119, 29259320, 29260452, 29260956, 29261547, 29261548 -29261906, 29262512, 29262887, 29265448, 29266248, 29266899, 29267292 -29268412, 29269171, 29269228, 29269825, 29270585, 29273539, 29273570 -29273735, 29273812, 29273847, 29274428, 29274564, 29274627, 29275461 -29276272, 29277317, 29278218, 29278684, 29279658, 29279751, 29279854 -29281527, 29281691, 29281796, 29282233, 29282898, 29285197, 29285503 -29285788, 29285956, 29286037, 29286229, 29287130, 29287705, 29292837 -29293072, 29293574, 29297863, 29297915, 29298220, 29299049, 29299082 -29299844, 29301463, 29301566, 29302963, 29303918, 29304781, 29306226 -29306713, 29307638, 29311528, 29311588, 29312310, 29312672, 29312734 -29312753, 29312889, 29313347, 29313417, 29313525, 29314539, 29314636 -29317756, 29318410, 29319441, 29321489, 29323946, 29324568, 29324735 -29325087, 29325105, 29325257, 29325765, 29325993, 29327044, 29329042 -29329087, 29329807, 29330361, 29331066, 29331209, 29331380, 29331493 -29332292, 29332395, 29332763, 29332771, 29333500, 29336843, 29337310 -29337742, 29338315, 29338348, 29338453, 29338780, 29338913, 29339101 -29339155, 29341209, 29343086, 29343861, 29345937, 29346057, 29346211 -29346943, 29347620, 29348176, 29350052, 29350762, 29351386, 29351662 -29351716, 29351735, 29351749, 29352298, 29352724, 29352867, 29352947 -29353271, 29353432, 29353821, 29353960, 29355654, 29356547, 29356704 -29356711, 29356752, 29358509, 29358828, 29360252, 29360285, 29360672 -29360911, 29360950, 29361319, 29361472, 29361801, 29363151, 29364171 -29364177, 29366940, 29367019, 29367561, 29368253, 29368310, 29372541 -29373418, 29373588, 29374179, 29375355, 29375941, 29375984, 29376346 -29377804, 29377986, 29378029, 29378834, 29378913, 29379978, 29382641 -29382784, 29382815, 29383695, 29384781, 29384854, 29384864, 29385429 -29385652, 29386502, 29386635, 29386660, 29387073, 29387274, 29388020 -29388072, 29388094, 29388524, 29388830, 29389889, 29390011, 29390435 -29390785, 29391030, 29391237, 29391849, 29391925, 29392966, 29393291 -29394014, 29394140, 29394749, 29395657, 29397954, 29397996, 29398488 -29398863, 29399046, 29399100, 29399121, 29399336, 29399938, 29402131 -29404483, 29405012, 29405462, 29405651, 29405996, 29407804, 29408853 -29409149, 29409455, 29410311, 29410834, 29411037, 29411469, 29412066 -29412269, 29416688, 29417173, 29417719, 29417884, 29418165, 29420834 -29421059, 29423003, 29423016, 29423156, 29423826, 29424999, 29426241 -29429017, 29429264, 29429466, 29429566, 29430524, 29430866, 29431192 -29431485, 29432176, 29434301, 29435474, 29435652, 29436454, 29436514 -29436727, 29437594, 29437712, 29438277, 29438736, 29439522, 29441196 -29443187, 29443250, 29444072, 29444282, 29444602, 29446669, 29448498 -29449477, 29449845, 29449852, 29450193, 29450421, 29450812, 29450936 -29451386, 29452251, 29452576, 29452936, 29452953, 29454978, 29455424 -29456714, 29457312, 29457370, 29457502, 29457807, 29457978, 29460252 -29461420, 29461791, 29462594, 29462767, 29462957, 29463047, 29463528 -29464616, 29464779, 29465177, 29467622, 29469565, 29470291, 29471860 -29472618, 29476473, 29481584, 29483452, 29483532, 29483626, 29483672 -29483685, 29483712, 29483723, 29483771, 29485099, 29486181, 29488894 -29489436, 29489546, 29490256, 29492127, 29492939, 29493122, 29494245 -29495057, 29495684, 29497311, 29497588, 29497696, 29498198, 29500257 -29500826, 29502561, 29503543, 29503631, 29503827, 29504492, 29504682 -29505668, 29507270, 29507616, 29508681, 29509777, 29510278, 29511611 -29514479, 29515134, 29515240, 29515476, 29515766, 29515834, 29516300 -29516727, 29516766, 29517168, 29517883, 29521187, 29521688, 29521748 -29521862, 29522358, 29522561, 29522662, 29523055, 29523511, 29524599 -29525467, 29525886, 29526966, 29527595, 29527610, 29528368, 29529147 -29530440, 29530515, 29530812, 29530909, 29531654, 29531836, 29532532 -29536342, 29536445, 29538631, 29541742, 29541769, 29542084, 29542449 -29542643, 29543034, 29543956, 29546817, 29547010, 29547867, 29548427 -29548687, 29548722, 29549071, 29549104, 29549154, 29549730, 29552773 -29553141, 29557144, 29557261, 29557336, 29557556, 29558238, 29558975 -29559187, 29559446, 29559908, 29559981, 29564592, 29564593, 29565611 -29580394, 29580983, 29581771, 29584261, 29584693, 29586143, 29587765 -29597536, 29597754, 29598039, 29598046, 29598233, 29599008, 29599300 -29601461, 29602831, 29603460, 29603884, 29604002, 29604257, 29607136 -29607797, 29608000, 29610506, 29611020, 29611991, 29615824, 29616244 -29616414, 29618074, 29618190, 29620042, 29622936, 29625065, 29625804 -29625876, 29626154, 29626732, 29628200, 29629430, 29629650, 29629681 -29629745, 29631749, 29632095, 29632265, 29632611, 29633697, 29633753 -29633936, 29634643, 29635427, 29635717, 29635990, 29637362, 29637526 -29638285, 29641736, 29643721, 29645349, 29648928, 29651183, 29651520 -29653132, 29653246, 29655668, 29656819, 29657422, 29657960, 29661028 -29661065, 29661722, 29663368, 29664087, 29664161, 29665940, 29667994 -29668005, 29669413, 29670782, 29671363, 29672507, 29676089, 29677051 -29677173, 29677733, 29677927, 29679856, 29681987, 29683039, 29687214 -29687459, 29687718, 29687763, 29689145, 29689255, 29692694, 29694869 -29695425, 29695841, 29696310, 29700125, 29700460, 29700770, 29703932 -29707099, 29707896, 29708915, 29710188, 29710858, 29713810, 29715220 -29716194, 29716491, 29717659, 29719146, 29720133, 29721418, 29725476 -29725781, 29726695, 29739576, 29741976, 29742223, 29746962, 29747493 -29747648, 29747653, 29748285, 29748336, 29748513, 29749471, 29750673 -29751094, 29753244, 29754951, 29755821, 29756274, 29756444, 29757099 -29757264, 29757651, 29758217, 29758661, 29761678, 29761837, 29761911 -29765393, 29766207, 29766503, 29766679, 29768899, 29770750, 29771032 -29771242, 29773197, 29773842, 29775393, 29779196, 29782211, 29782823 -29782866, 29784106, 29785239, 29787292, 29787766, 29791152, 29791880 -29793318, 29794462, 29795712, 29795957, 29796378, 29797726, 29802695 -29804875, 29805772, 29809837, 29812489, 29813503, 29815713, 29817278 -29821582, 29825525, 29827852, 29831196, 29834506, 29836096, 29838485 -29838773, 29839715, 29840619, 29841267, 29841687, 29843277, 29843692 -29844226, 29845530, 29846126, 29846645, 29848084, 29848849, 29849100 -29850930, 29851733, 29853485, 29858121, 29858376, 29865188, 29865658 -29869086, 29869404, 29869887, 29870065, 29871098, 29873665, 29875459 -29875565, 29877608, 29878076, 29881478, 29881839, 29882729, 29884958 -29887111, 29888621, 29890740, 29891916, 29893132, 29897418, 29897863 -29900203, 29902327, 29902330, 29903299, 29903454, 29906678, 29907942 -29909658, 29912286, 29914449, 29915217, 29915848, 29916975, 29920025 -29921318, 29926466, 29927756, 29928210, 29937565, 29938225, 29940373 -29942096, 29942554, 29943670, 29944035, 29944660, 29945645, 29946388 -29951620, 29956016, 29957493, 29961609, 29962248, 29962927, 29962939 -29966768, 29967223, 29968085, 29970298, 29971027, 29971888, 29989783 -29989845, 29991257, 29997326, 30003187, 30006159, 30006985, 30007797 -30008125, 30008214, 30009710, 30015070, 30019864, 30024618, 30029806 -30032376, 30033547, 30034456, 30035598, 30038392, 30040157, 30042490 -30043610, 30044507, 30047702, 30047765, 30051176, 30051783, 30053036 -30058149, 30058453, 30059106, 30059109, 30066352, 30074349, 30074472 -30075037, 30076197, 30078675, 30079949, 30080266, 30081580, 30083488 -30084971, 30085897, 30086992, 30090568, 30092859, 30095591, 30095952 -30097092, 30098251, 30099454, 30101186, 30104555, 30106748, 30110224 -30110370, 30110518, 30114489, 30114534, 30127522, 30127904, 30131645 -30135396, 30142907, 30149658, 30150606, 30154633, 30155837, 30159329 -30164714, 30165493, 30165503, 30170104, 30174401, 30175291, 30177597 -30178250, 30187866, 30189516, 30191274, 30193165, 30206493, 30218044 -30223712, 30223847, 30224950, 30235919, 30246179, 30247305, 30252098 -30252156, 30253608, 30255143, 30264405, 30266791, 30269428, 30274188 -30282591, 30299817, 30312094, 30318638, 30324180, 30342878, 30365745 -30389229, 30402386, 30408515, 30412188, 30453442, 30458593, 30474167 -30474774, 30485255, 30534827, 30641755 -``` - -## Version 19\.0\.0\.0\.ru\-2019\-10\.rur\-2019\-10\.r1 - -Version 19\.0\.0\.0\.ru\-2019\-10\.rur\-2019\-10\.r1 includes the following: -+ Patch 30125133: DATABASE RELEASE UPDATE 19\.5\.0\.0\.0 -+ Patch 30128191: OJVM RELEASE UPDATE 19\.5\.0\.0\.0 -+ Patch 29997937: DSTv34 UPDATE for RDBMS \(TZDATA2019B\) -+ Patch 29997959: DSTV34 UPDATE for OJVM \(TZDATA2019B\) -+ PreUpgrade Jar: preupgrade\_19\_cbuild\_4\_lf\.zip -+ Patch 28730253: SUPPORT NEW ERA REIWA FOR JAPANESE IMPERIAL CALENDAR -+ Patch 29213893: DBMS\_STATS FAILING WITH ERROR ORA\-01422 WHEN GATHERING STATS FOR USER$ TABLE -+ Patch 30528704: 19C RMAN RECOVER DATABASE USE REDO LOG INSTEAD OF ARCHIVELOG AFTER APPLYING OCT DATABASE RU -+ Support for [Resizing the temporary tablespace in a read replica](Appendix.Oracle.CommonDBATasks.Database.md#Appendix.Oracle.CommonDBATasks.ResizeTempSpaceReadReplica) - -### Oracle release update 19\.5\.0\.0\.0, released October 2019 - -Bugs fixed: - -``` - -14735102, 17428816, 19080742, 19697993, 20313356, 21374587, 21965541 23296836, 23606241, 24687075, 25756945, -25806201, 25883179, 25986062 25997810, 26476244, 26611353, 26739322, 26872233, 27126938, 27244999 27359766, -27369515, 27406105, 27411022, 27423500, 27453490, 27458357 27489107, 27666312, 27710072, 27846298, 27880025, -27934711, 27935464 27941110, 27957203, 27967484, 28064977, 28072567, 28125947, 28129791 28181021, 28210681, -28271693, 28279456, 28294563, 28313275, 28319114 28326928, 28350595, 28371123, 28379065, 28381939, 28386259, -28390273 28395302, 28410431, 28431445, 28435333, 28463226, 28475242, 28484299 28489419, 28498976, 28502773, -28513333, 28521330, 28534475, 28542455 28547068, 28558645, 28561704, 28567417, 28567819, 28569897, 28572533, -28572544, 28572667, 28572834, 28587723, 28593682, 28594086, 28597221 28601957, 28605066, 28606598, 28612239, -28625862, 28627033, 28636532 28643718, 28644549, 28645570, 28646200, 28646939, 28649388, 28655209 28663782, -28672457, 28673945, 28692103, 28692275, 28694872, 28696373 28705231, 28710385, 28710734, 28714461, 28715727, -28718469, 28719348 28720418, 28721497, 28722229, 28730079, 28740708, 28742555, 28749853 28752923, 28755011, -28758722, 28760206, 28765983, 28767240, 28769456 28772390, 28774416, 28776811, 28777214, 28781754, 28785531, -28789531 28791852, 28795551, 28802734, 28804517, 28810381, 28811560, 28815123 28815355, 28817449, 28819640, -28820669, 28824482, 28827682, 28831971 28833912, 28835937, 28836716, 28849776, 28854004, 28855922, 28862532 -28863432, 28863487, 28867992, 28873575, 28875089, 28876253, 28876639 28878865, 28884931, 28888327, 28889730, -28892794, 28897512, 28899663 28901126, 28905457, 28907196, 28912691, 28915561, 28917080, 28918429 28919145, -28922227, 28922532, 28922608, 28925634, 28925880, 28933158 28936114, 28937717, 28938698, 28940179, 28940281, -28941901, 28942455 28945421, 28945994, 28950868, 28951533, 28952168, 28954762, 28955606 28956908, 28957292, -28957723, 28958088, 28960863, 28962775, 28965084 28965231, 28966444, 28974083, 28977322, 28983095, 28983486, -28985478 28986207, 28986231, 28986326, 28986481, 28988482, 28989306, 28993295 28993353, 28994307, 28996376, -29000000, 29001305, 29001888, 29002488 29002784, 29002927, 29003738, 29006318, 29006621, 29007321, 29007353, -29007775, 29008035, 29008669, 29009513, 29010126, 29011936, 29012609 29013475, 29014076, 29015118, 29017265, -29018655, 29019121, 29021063 29021352, 29024054, 29024552, 29024732, 29026582, 29026606, 29027456 29027694, -29027940, 29031575, 29031600, 29032234, 29032276, 29032457 29032607, 29033052, 29033145, 29033200, 29033280, -29034587, 29037290 29038528, 29039089, 29039510, 29040739, 29043554, 29043651, 29043725 29044763, 29044954, -29047850, 29048178, 29048289, 29048498, 29048605 29050357, 29050560, 29050765, 29050886, 29051702, 29051953, -29052726 29053783, 29056024, 29056270, 29056560, 29056767, 29059011, 29060216 29061959, 29062692, 29062848, -29062860, 29062868, 29110526, 29110783 29110790, 29110797, 29110802, 29110805, 29111598, 29113282, 29113305 -29117526, 29117642, 29119077, 29120223, 29122224, 29122254, 29123297 29123432, 29123482, 29124368, 29125036, -29125374, 29125380, 29126345 29127957, 29128693, 29128935, 29129450, 29129497, 29129712, 29130219 29131539, -29132869, 29132938, 29134447, 29135383, 29135649, 29136111 29138641, 29139956, 29141316, 29141341, 29141685, -29142609, 29142667 29143516, 29144995, 29145214, 29145730, 29149829, 29150338, 29151520 29152357, 29155099, -29157051, 29157389, 29158680, 29158899, 29159909 29159936, 29160174, 29162095, 29163156, 29163415, 29163437, -29163524 29163567, 29167111, 29167342, 29167374, 29167940, 29168137, 29168219 29168433, 29169073, 29169215, -29170232, 29171683, 29171942, 29172618 29172826, 29173140, 29173373, 29173817, 29174004, 29176318, 29177466, -29177543, 29177886, 29178385, 29180313, 29180455, 29180559, 29180893 29181153, 29181231, 29181620, 29181743, -29181923, 29182019, 29183912 29184297, 29184666, 29185193, 29186456, 29189302, 29189307, 29189889 29190235, -29190474, 29190740, 29191541, 29192419, 29192468, 29192685 29193207, 29194205, 29194367, 29194493, 29194827, -29194981, 29195279 29195337, 29195758, 29196725, 29198092, 29199635, 29199733, 29200316 29200700, 29201494, -29201539, 29202104, 29202850, 29203122, 29203166 29203425, 29203443, 29203604, 29205281, 29205323, 29205419, -29205463 29205767, 29205918, 29206109, 29206605, 29207073, 29208260, 29208732 29211457, 29211724, 29212012, -29212433, 29212611, 29213320, 29213351 29213613, 29213775, 29213850, 29213879, 29214561, 29214960, 29216746, -29216984, 29217294, 29217472, 29217828, 29217848, 29218570, 29219205 29219273, 29220079, 29221248, 29221891, -29222031, 29222784, 29223833 29223859, 29223967, 29224065, 29224605, 29225076, 29225168, 29225758 29227602, -29228869, 29229164, 29229754, 29229844, 29229955, 29230252 29230565, 29231133, 29232117, 29232154, 29232449, -29233415, 29234123 29236573, 29237538, 29237744, 29240307, 29241345, 29241651, 29242017 29242884, 29243958, -29245137, 29245160, 29246163, 29247415, 29247712 29247906, 29248495, 29248552, 29248835, 29248858, 29249991, -29250059 29250317, 29251259, 29253184, 29253871, 29254031, 29254930, 29255178 29255273, 29255431, 29255435, -29256426, 29259119, 29259320, 29260452 29261547, 29261906, 29262512, 29262887, 29265448, 29266248, 29266899, -29267292, 29268412, 29269171, 29269228, 29269825, 29270585, 29273539 29273570, 29273735, 29273812, 29273847, -29274428, 29274564, 29274627 29275461, 29276272, 29277317, 29278218, 29279658, 29279751, 29279854 29281527, -29281691, 29281796, 29282233, 29282898, 29285503, 29285788 29285956, 29286037, 29287130, 29287705, 29292837, -29293072, 29293574 29297863, 29297915, 29298220, 29299049, 29299082, 29299844, 29301463 29301566, 29302963, -29303918, 29304781, 29306226, 29306713, 29311528 29311588, 29312310, 29312672, 29312734, 29312753, 29313347, -29313417 29313525, 29314539, 29317756, 29318410, 29319441, 29321489, 29323946 29324568, 29324735, 29325087, -29325105, 29325257, 29325765, 29325993 29327044, 29329042, 29329087, 29329807, 29330361, 29331066, 29331209 -29331380, 29331493, 29332292, 29332395, 29332771, 29333500, 29336843 29337310, 29337742, 29338315, 29338453, -29338780, 29338913, 29339101 29339155, 29341209, 29343086, 29345937, 29346057, 29346211, 29346943 29347620, -29348176, 29350052, 29350762, 29351386, 29351662, 29351716 29351735, 29351749, 29352298, 29352724, 29352867, -29352947, 29353271 29353432, 29353821, 29353960, 29355654, 29356547, 29356704, 29356711 29356752, 29358509, -29358828, 29360252, 29360285, 29360672, 29360911 29360950, 29361319, 29361472, 29361801, 29363151, 29364171, -29364177 29366940, 29367019, 29367561, 29368253, 29368310, 29372541, 29373418 29373588, 29374179, 29375941, -29376346, 29377986, 29378029, 29378834 29378913, 29379978, 29382784, 29382815, 29384781, 29384854, 29384864, -29385429, 29385652, 29386502, 29386635, 29386660, 29387073, 29387274 29388020, 29388072, 29388094, 29388524, -29388830, 29389889, 29390011 29390435, 29390785, 29391030, 29391237, 29391849, 29393291, 29394014 29394140, -29394749, 29395657, 29397954, 29397996, 29398488, 29398863 29399100, 29399121, 29399336, 29399938, 29402131, -29404483, 29405012 29405462, 29405651, 29405996, 29407804, 29408853, 29409149, 29409455 29410311, 29410834, -29411037, 29411469, 29412066, 29412269, 29417173 29417719, 29417884, 29420834, 29421059, 29423016, 29423156, -29423826 29424999, 29426241, 29429017, 29429264, 29429466, 29429566, 29430524 29430866, 29431192, 29431485, -29434301, 29435474, 29435652, 29436454 29436514, 29436727, 29437594, 29437712, 29438277, 29438736, 29439522, -29441196, 29443187, 29443250, 29444072, 29444282, 29444602, 29446669 29449477, 29449845, 29450193, 29450421, -29450812, 29450936, 29451386 29452576, 29452936, 29452953, 29454978, 29455424, 29457312, 29457370 29457807, -29460252, 29461420, 29461791, 29462594, 29462767, 29462957 29463047, 29463528, 29464616, 29464779, 29465177, -29467622, 29469565 29470291, 29471860, 29476473, 29481584, 29483532, 29483672, 29483685 29483712, 29483723, -29485099, 29486181, 29488894, 29489546, 29490256 29492127, 29492939, 29493122, 29494245, 29495057, 29495684, -29497311 29497696, 29498198, 29500257, 29500826, 29502561, 29503543, 29503631 29503827, 29504492, 29504682, -29505668, 29507270, 29507616, 29510278 29511611, 29514479, 29515134, 29515240, 29515476, 29515766, 29515834, -29516300, 29516766, 29517168, 29517883, 29521187, 29521748, 29521862 29522358, 29522561, 29522662, 29523511, -29524599, 29525467, 29525886 29527595, 29527610, 29529147, 29530440, 29530515, 29530812, 29531654 29532532, -29541742, 29541769, 29542449, 29542643, 29543034, 29543956 29546817, 29547867, 29548427, 29548687, 29548722, -29549071, 29549104 29549154, 29549730, 29552773, 29553141, 29557144, 29557261, 29557336 29558238, 29558975, -29559187, 29559446, 29559908, 29559981, 29565611 29580394, 29580983, 29581771, 29584261, 29584693, 29586143, -29587765 29597536, 29597754, 29598039, 29598046, 29598233, 29599008, 29599300 29601461, 29603460, 29604002, -29604257, 29607136, 29608000, 29611020 29611991, 29616244, 29616414, 29618074, 29618190, 29620042, 29622936, -29625065, 29625804, 29625876, 29626154, 29626732, 29628200, 29629430 29629650, 29629681, 29631749, 29632095, -29632265, 29633697, 29633753 29633936, 29634643, 29635427, 29635717, 29635990, 29637362, 29637526 29638285, -29641736, 29645349, 29651183, 29651520, 29653132, 29653246 29655668, 29656819, 29657422, 29657960, 29661028, -29661065, 29661722 29663368, 29664087, 29664161, 29667994, 29668005, 29669413, 29670782 29671363, 29672507, -29676089, 29677051, 29677733, 29677927, 29679856 29683039, 29687214, 29687459, 29687718, 29687763, 29689145, -29692694 29695425, 29695841, 29696310, 29700125, 29700460, 29703932, 29707099 29707896, 29708915, 29715220, -29720133, 29721418, 29725781, 29741976 29742223, 29747493, 29747648, 29749471, 29750673, 29751094, 29753244, -29754951, 29755821, 29756274, 29756444, 29757264, 29757651, 29758661 29761911, 29766207, 29766503, 29766679, -29771032, 29773842, 29775393 29779196, 29782211, 29782823, 29782866, 29785239, 29787766, 29791880 29795712, -29795957, 29802695, 29809837, 29815713, 29836096, 29838773 29845530, 29848849, 29850930, 29851733, 29858376, -29869086, 29869404 29869887, 29875459, 29875565, 29881478, 29881839, 29887111, 29888621 29893132, 29900203, -29902327, 29903299, 29903454, 29921318, 29926466 29943670, 29997326, 30006159, 30015070, 30019864, 30024618, -30033547 30034456, 30053036, 30075037, 30076197, 30092859, 30095591, 30114534 30142907, 30155837, 30174401 -``` - -## Version 19\.0\.0\.0\.ru\-2019\-07\.rur\-2019\-07\.r1 - -Version 19\.0\.0\.0\.ru\-2019\-07\.rur\-2019\-07\.r1 includes the following: -+ Patch 29834717: Database Release Update: 19\.4\.0\.0\.190716 -+ Patch 29774421: OJVM RELEASE UPDATE: 19\.4\.0\.0\.190716 -+ Patch 28852325: RDBMS \- DSTV33 UPDATE \- TZDATA2018G -+ Patch 28852334: DSTV33 UPDATE \- TZDATA2018G \- NEED OJVM FIX -+ Patch 28730253: SUPPORT NEW ERA REIWA FOR JAPANESE IMPERIAL CALENDAR -+ Patch 29213893: DBMS\_STATS FAILING WITH ERROR ORA\-01422 WHEN GATHERING STATS FOR USER$ TABLE -+ PreUpgrade Jar: preupgrade\_19\_cbuild\_4\_lf\.zip - -### Oracle release update 19\.4\.0\.0\.190716, released July 2019 - -Bugs fixed: - -``` -29850930, 29225758, 29276272, 14735102, 17428816, 19080742, 19697993 -20313356, 21374587, 21965541, 23296836, 23606241, 25756945, 25806201 -25883179, 25986062, 25997810, 26476244, 26611353, 26739322, 26872233 -27126938, 27244999, 27359766, 27369515, 27423500, 27453490, 27666312 -27710072, 27846298, 27957203, 28064977, 28072567, 28125947, 28129791 -28181021, 28210681, 28271693, 28279456, 28313275, 28326928, 28350595 -28371123, 28379065, 28381939, 28390273, 28431445, 28463226, 28475242 -28489419, 28502773, 28513333, 28534475, 28547068, 28561704, 28569897 -28572533, 28572544, 28572667, 28572834, 28587723, 28593682, 28594086 -28597221, 28601957, 28605066, 28606598, 28612239, 28625862, 28627033 -28636532, 28643718, 28644549, 28645570, 28646200, 28646939, 28649388 -28655209, 28663782, 28673945, 28692275, 28694872, 28696373, 28705231 -28710385, 28710734, 28714461, 28715727, 28718469, 28719348, 28720418 -28722229, 28730079, 28740708, 28742555, 28749853, 28755011, 28758722 -28760206, 28767240, 28772390, 28774416, 28777214, 28781754, 28785531 -28789531, 28791852, 28795551, 28802734, 28804517, 28810381, 28811560 -28815123, 28815355, 28819640, 28824482, 28827682, 28833912, 28835937 -28849776, 28854004, 28862532, 28863432, 28867992, 28873575, 28876253 -28876639, 28884931, 28888327, 28889730, 28892794, 28897512, 28899663 -28901126, 28905457, 28907196, 28912691, 28915561, 28917080, 28918429 -28919145, 28922227, 28922532, 28922608, 28925634, 28925880, 28933158 -28936114, 28937717, 28938698, 28940179, 28940281, 28941901, 28942455 -28945421, 28945994, 28950868, 28951533, 28952168, 28954762, 28955606 -28956908, 28957292, 28957723, 28962775, 28965231, 28966444, 28974083 -28977322, 28983095, 28983486, 28986207, 28986231, 28986326, 28986481 -28988482, 28989306, 28993295, 28993353, 28994307, 28996376, 29000000 -29001305, 29001888, 29002784, 29002927, 29003738, 29006318, 29006621 -29007321, 29007775, 29008035, 29008669, 29009513, 29011936, 29012609 -29013475, 29014076, 29015118, 29017265, 29018655, 29019121, 29021063 -29021352, 29024054, 29024552, 29024732, 29026582, 29026606, 29027456 -29027694, 29027940, 29031575, 29031600, 29032234, 29032276, 29032457 -29032607, 29033052, 29033145, 29033200, 29033280, 29034587, 29037290 -29038528, 29039089, 29039510, 29040739, 29043554, 29043651, 29043725 -29044763, 29044954, 29047850, 29048178, 29048289, 29048498, 29048605 -29050357, 29050560, 29050765, 29051702, 29051953, 29052726, 29053783 -29056024, 29056270, 29056560, 29056767, 29059011, 29061959, 29062692 -29062848, 29062860, 29062868, 29110526, 29110783, 29110790, 29110797 -29110802, 29110805, 29111598, 29113282, 29113305, 29117526, 29117642 -29119077, 29120223, 29122224, 29122254, 29123297, 29123432, 29123482 -29124368, 29125036, 29125374, 29125380, 29126345, 29127957, 29128693 -29128935, 29129450, 29129497, 29129712, 29130219, 29131539, 29132938 -29134447, 29135383, 29135649, 29136111, 29138641, 29141316, 29141341 -29141685, 29142609, 29142667, 29144995, 29145214, 29145730, 29149829 -29150338, 29151520, 29152357, 29155099, 29157389, 29158680, 29158899 -29159909, 29159936, 29160174, 29162095, 29163156, 29163415, 29163437 -29163524, 29163567, 29167111, 29167342, 29167374, 29167940, 29168219 -29168433, 29169073, 29169215, 29171683, 29171942, 29172618, 29172826 -29173140, 29173373, 29173817, 29174004, 29176318, 29177466, 29177543 -29177886, 29178385, 29180313, 29180455, 29180559, 29180893, 29181153 -29181231, 29181620, 29181743, 29181923, 29182019, 29183912, 29184297 -29184666, 29185193, 29186456, 29189302, 29189307, 29189889, 29190235 -29190474, 29190740, 29191541, 29192419, 29192468, 29192685, 29193207 -29194205, 29194367, 29194493, 29194827, 29194981, 29195279, 29195337 -29195758, 29196725, 29199635, 29199733, 29200316, 29200700, 29201494 -29201539, 29202104, 29202850, 29203122, 29203166, 29203425, 29203443 -29203604, 29205281, 29205323, 29205419, 29205463, 29205767, 29205918 -29206109, 29206605, 29207073, 29208260, 29208732, 29211457, 29211724 -29212012, 29212433, 29212611, 29213351, 29213775, 29213850, 29213879 -29214561, 29214960, 29216746, 29216984, 29217294, 29217472, 29217828 -29217848, 29218570, 29219205, 29219273, 29220079, 29221248, 29221891 -29222031, 29222784, 29223833, 29223859, 29223967, 29224065, 29224605 -29225076, 29225168, 29227602, 29228869, 29229164, 29229754, 29229844 -29229955, 29230252, 29230565, 29231133, 29232117, 29232154, 29233415 -29234123, 29237538, 29240307, 29241345, 29241651, 29242017, 29242884 -29243958, 29245137, 29245160, 29246163, 29247415, 29247712, 29247906 -29248495, 29248552, 29248835, 29248858, 29249991, 29250059, 29250317 -29251259, 29253184, 29253871, 29254031, 29254930, 29255178, 29255273 -29255431, 29255435, 29256426, 29259119, 29259320, 29260452, 29261547 -29261906, 29262512, 29262887, 29265448, 29266248, 29266899, 29267292 -29268412, 29269171, 29269228, 29270585, 29273539, 29273570, 29273735 -29273812, 29273847, 29274428, 29274564, 29274627, 29275461, 29277317 -29278218, 29279658, 29279751, 29279854, 29281527, 29281691, 29281796 -29282233, 29282898, 29285503, 29285788, 29285956, 29286037, 29287130 -29287705, 29292837, 29293072, 29293574, 29297863, 29297915, 29298220 -29299049, 29299082, 29299844, 29301463, 29301566, 29302963, 29303918 -29304781, 29306226, 29306713, 29311588, 29312310, 29312672, 29312734 -29312753, 29313347, 29313417, 29313525, 29314539, 29317756, 29318410 -29319441, 29321489, 29323946, 29324568, 29324735, 29325087, 29325105 -29325257, 29325765, 29325993, 29327044, 29329042, 29329087, 29329807 -29330361, 29331066, 29331209, 29331380, 29331493, 29332292, 29332395 -29332771, 29333500, 29336843, 29337310, 29338315, 29338453, 29338780 -29338913, 29339101, 29339155, 29341209, 29343086, 29345937, 29346057 -29346211, 29346943, 29347620, 29348176, 29350052, 29351386, 29351716 -29351735, 29351749, 29352298, 29352724, 29352867, 29352947, 29353271 -29353432, 29353960, 29355654, 29356547, 29356704, 29356711, 29356752 -29358509, 29358828, 29360285, 29360672, 29360911, 29360950, 29361472 -29361801, 29363151, 29364171, 29364177, 29366940, 29367019, 29367561 -29368253, 29372541, 29373418, 29373588, 29374179, 29375941, 29376346 -29377986, 29378029, 29378834, 29378913, 29379978, 29382784, 29382815 -29384781, 29384854, 29384864, 29385429, 29385652, 29386502, 29386635 -29386660, 29387073, 29387274, 29388020, 29388072, 29388094, 29388524 -29388830, 29389889, 29390011, 29390435, 29390785, 29391030, 29394014 -29394140, 29394749, 29395657, 29397954, 29397996, 29398488, 29398863 -29399100, 29399121, 29399938, 29402131, 29404483, 29405012, 29405462 -29405651, 29405996, 29407804, 29409149, 29410311, 29410834, 29411037 -29412066, 29412269, 29417719, 29417884, 29420834, 29421059, 29423826 -29424999, 29426241, 29429017, 29429264, 29429566, 29430524, 29431192 -29431485, 29434301, 29435474, 29435652, 29436454, 29436514, 29437594 -29437712, 29438277, 29438736, 29439522, 29441196, 29443187, 29443250 -29444072, 29444282, 29444602, 29446669, 29449477, 29450421, 29451386 -29452576, 29452936, 29452953, 29455424, 29457312, 29457370, 29457807 -29460252, 29461791, 29462594, 29462767, 29462957, 29464779, 29465177 -29467622, 29476473, 29483532, 29483672, 29483685, 29483712, 29486181 -29488894, 29489546, 29490256, 29492127, 29492939, 29494245, 29495057 -29495684, 29497311, 29500826, 29502561, 29503543, 29503631, 29503827 -29504492, 29504682, 29505668, 29507616, 29510278, 29511611, 29514479 -29515134, 29515240, 29515766, 29515834, 29516300, 29517168, 29521187 -29521748, 29522358, 29522561, 29522662, 29523511, 29525467, 29525886 -29527595, 29529147, 29530440, 29530515, 29530812, 29531654, 29541769 -29542449, 29543034, 29546817, 29547867, 29548687, 29548722, 29549154 -29549730, 29557336, 29558975, 29559187, 29559446, 29559908, 29559981 -29565611, 29580983, 29581771, 29584261, 29586143, 29597536, 29597754 -29598039, 29598233, 29599300, 29601461, 29604002, 29608000, 29611020 -29611991, 29616244, 29616414, 29618074, 29618190, 29622936, 29626732 -29628200, 29629650, 29629681, 29631749, 29632095, 29633697, 29635427 -29635717, 29637362, 29638285, 29641736, 29653246, 29656819, 29657422 -29664087, 29664161, 29670782, 29676089, 29677051, 29677733, 29679856 -29687459, 29687763, 29692694, 29695841, 29703932, 29707099, 29742223 -29747648, 29751094, 29753244, 29754951, 29756274, 29757651, 29766207 -29766503, 29766679, 29775393, 29779196, 29795957, 29838773 -``` \ No newline at end of file diff --git a/doc_source/Appendix.Oracle.RU-RUR.21.0.0.0.md b/doc_source/Appendix.Oracle.RU-RUR.21.0.0.0.md deleted file mode 100644 index 1dd7b02..0000000 --- a/doc_source/Appendix.Oracle.RU-RUR.21.0.0.0.md +++ /dev/null @@ -1,102 +0,0 @@ -# Database engine: 21\.0\.0\.0 - -The following versions are available for Oracle database engine 21\.0\.0\.0: -+ [Version 21\.0\.0\.0\.ru\-2022\-01\.rur\-2022\-01\.r1](#Appendix.Oracle.RU-RUR.21.0.0.0.ru-2022-01.rur-2022-01.r1) - -## Version 21\.0\.0\.0\.ru\-2022\-01\.rur\-2022\-01\.r1 - -Version 21\.0\.0\.0\.ru\-2022\-01\.rur\-2022\-01\.r1 includes the following: -+ Patch 33516412: DATABASE RELEASE UPDATE 21\.5\.0\.0\.0 -+ Patch 33792011: DELIVER LIBCRYPTOCME\.SO FOR DB 21\.5 INSTALLS -+ Patch 33613829: RDBMS \- DSTV37 UPDATE \- TZDATA2020E -+ Patch 33613833: DSTV37 UPDATE \- TZDATA2020E \- NEED OJVM FIX - -### Combined Patches for Version 21\.0\.0\.0\.ru\-2022\-01\.rur\-2022\-01\.r1, Released January 2022 - -Bugs fixed: - -``` -24559425, 25562258, 26139817, 26352569, 27162036, 27897090, 28294439 -28632799, 28882751, 28994721, 29027914, 29587488, 29591661, 29617414 -30082402, 30481004, 30610097, 30710917, 30722105, 30808364, 30876666 -30961824, 31006259, 31006953, 31026870, 31044504, 31113682, 31251325 -31287296, 31387123, 31414524, 31488085, 31526250, 31615736, 31656601 -31731407, 31773909, 31780567, 31800059, 31800139, 31824792, 31834214 -31834677, 31841210, 31843716, 31843845, 31844137, 31844357, 31844557 -31872320, 31897178, 31912834, 31923463, 31927078, 31932042, 31933842 -31933846, 31933914, 31938116, 31951628, 31959140, 31982879, 31988833 -31992615, 31993051, 31994298, 31996331, 31997660, 32003908, 32008408 -32008716, 32009197, 32020701, 32056529, 32057565, 32069508, 32071457 -32075130, 32078078, 32081381, 32092797, 32097767, 32102542, 32114541 -32114746, 32119144, 32132504, 32161381, 32178966, 32183102, 32183756 -32184235, 32184577, 32185296, 32190419, 32198292, 32198396, 32199681 -32212062, 32219835, 32225117, 32225742, 32249371, 32254686, 32255753 -32258423, 32277793, 32292805, 32297469, 32297849, 32298173, 32298782 -32300822, 32312412, 32327201, 32335257, 32342345, 32346254, 32346649 -32357412, 32361175, 32361677, 32365085, 32366303, 32368480, 32372725 -32373696, 32380591, 32382021, 32386720, 32390629, 32394623, 32396326 -32408640, 32417301, 32423985, 32426213, 32427158, 32427953, 32428097 -32431251, 32432078, 32432245, 32436460, 32436721, 32439726, 32441128 -32441671, 32442229, 32460145, 32462153, 32465193, 32465209, 32465495 -32468643, 32471100, 32471251, 32478452, 32481807, 32492382, 32498569 -32498752, 32503790, 32506473, 32507542, 32509814, 32515850, 32523613 -32526703, 32529396, 32530202, 32531647, 32533461, 32538824, 32540706 -32544740, 32551246, 32556165, 32561841, 32579075, 32580852, 32583315 -32583355, 32583692, 32584375, 32585832, 32587793, 32587994, 32588656 -32594965, 32597099, 32597637, 32602194, 32602990, 32603092, 32607991 -32608583, 32610271, 32618819, 32619195, 32620859, 32621140, 32621309 -32626756, 32626830, 32628168, 32629028, 32634049, 32635881, 32635931 -32639432, 32639860, 32642587, 32645139, 32651063, 32651773, 32652605 -32653470, 32662165, 32672057, 32675095, 32677000, 32685286, 32690400 -32692372, 32698508, 32700455, 32701048, 32704013, 32710534, 32712916 -32719445, 32720344, 32728984, 32730701, 32733845, 32734021, 32734171 -32734800, 32735915, 32736370, 32737969, 32740515, 32743290, 32747738 -32748806, 32753472, 32755517, 32761294, 32761932, 32763050, 32764690 -32766397, 32766407, 32768752, 32769880, 32771735, 32775512, 32775526 -32776891, 32781826, 32789228, 32790012, 32797486, 32800137, 32800539 -32801192, 32801303, 32801337, 32803807, 32806915, 32809152, 32810125 -32818545, 32822847, 32823692, 32827206, 32829563, 32831451, 32831901 -32834394, 32838028, 32838533, 32843672, 32846876, 32848816, 32852504 -32857881, 32863795, 32866089, 32868369, 32874773, 32875003, 32875118 -32879447, 32880390, 32881057, 32881462, 32883252, 32888458, 32889096 -32891500, 32893951, 32897184, 32897679, 32898672, 32898971, 32903472 -32903625, 32907741, 32908249, 32908946, 32909255, 32910846, 32913527 -32914711, 32915747, 32915760, 32915847, 32916025, 32918585, 32922090 -32930360, 32930665, 32931078, 32931941, 32935932, 32936005, 32936402 -32940955, 32947264, 32952285, 32955962, 32962378, 32965460, 32966389 -32968221, 32969863, 32970478, 32972633, 32973406, 32976022, 32977489 -32978151, 32980826, 32983419, 32983750, 32983871, 32984679, 32985908 -32987004, 32987308, 32988028, 32991527, 32993522, 32995206, 32995242 -32995863, 32998659, 32999086, 33000440, 33000980, 33005831, 33009224 -33009351, 33010444, 33011198, 33013379, 33015716, 33018951, 33020088 -33020510, 33021036, 33021642, 33022140, 33023671, 33026533, 33026796 -33027377, 33027525, 33027553, 33028013, 33028286, 33028462, 33032579 -33035201, 33037531, 33037895, 33038479, 33040335, 33042780, 33043590 -33044062, 33045137, 33047827, 33049012, 33050626, 33056383, 33056579 -33059891, 33060161, 33061339, 33063919, 33064565, 33065437, 33065979 -33069366, 33072392, 33075133, 33075246, 33085296, 33085361, 33089556 -33090110, 33090127, 33090781, 33090848, 33092087, 33096609, 33097433 -33100352, 33101055, 33101058, 33102477, 33105276, 33105656, 33106822 -33107872, 33109335, 33110192, 33110580, 33110992, 33111729, 33113848 -33114640, 33120828, 33121866, 33121880, 33123985, 33126216, 33127141 -33131526, 33131742, 33134819, 33135083, 33136252, 33142123, 33142533 -33142739, 33145153, 33150236, 33152388, 33153797, 33156632, 33163187 -33165183, 33166116, 33166242, 33166560, 33168480, 33169254, 33172549 -33172631, 33172679, 33178223, 33178248, 33182152, 33182656, 33185773 -33188597, 33190454, 33190694, 33191073, 33196009, 33196035, 33196475 -33197565, 33205781, 33207143, 33210231, 33211160, 33212112, 33216667 -33218194, 33219840, 33220282, 33223248, 33225678, 33230882, 33232128 -33233560, 33234302, 33235620, 33242408, 33245940, 33251004, 33252648 -33253504, 33261786, 33271125, 33278133, 33278509, 33282971, 33287418 -33289442, 33292174, 33292896, 33295267, 33300422, 33304435, 33304775 -33304830, 33307945, 33308107, 33317279, 33317996, 33322672, 33325981 -33326105, 33330508, 33331329, 33332891, 33334404, 33335941, 33337385 -33338247, 33338891, 33349744, 33353474, 33355007, 33367909, 33373644 -33381652, 33382620, 33384092, 33384505, 33387767, 33388473, 33392448 -33397495, 33407135, 33408858, 33416405, 33417828, 33417987, 33421305 -33425127, 33428316, 33435313, 33448908, 33457584, 33457842, 33458732 -33471858, 33480963, 33482590, 33489699, 33500486, 33507610, 33507953 -33514179, 33540746, 33558058, 33558391, 33559316, 33563137, 33563167 -33599734, 33613512, 33613829, 33613833, 33651003, 33656104, 33661960 -33674035, 33792011 -``` \ No newline at end of file diff --git a/doc_source/Appendix.OracleCharacterSets.md b/doc_source/Appendix.OracleCharacterSets.md deleted file mode 100644 index 1be40ed..0000000 --- a/doc_source/Appendix.OracleCharacterSets.md +++ /dev/null @@ -1,92 +0,0 @@ -# RDS for Oracle character sets - -RDS for Oracle supports two types of character sets: the DB character set and national character set\. - -## DB character set - -The Oracle database character set is used in the `CHAR`, `VARCHAR2`, and `CLOB` data types\. The database also uses this character set for metadata such as table names, column names, and SQL statements\. The Oracle database character set is typically referred to as the DB character set\. - -You set the character set when you create a DB instance\. You can't change the DB character set after you create the database\. - -### Supported DB character sets - -The following table lists the Oracle DB character sets that are supported in Amazon RDS\. You can use a value from this table with the `--character-set-name` parameter of the AWS CLI [create\-db\-instance](https://docs.aws.amazon.com/cli/latest/reference/rds/create-db-instance.html) command or with the `CharacterSetName` parameter of the Amazon RDS API [CreateDBInstance](https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_CreateDBInstance.html) operation\. - -**Note** -The character set for a CDB is always AL32UTF8\. You can set a different character set for the PDB only\. - - -**** - -| Value | Description | -| --- | --- | -| AL32UTF8 | Unicode 5\.0 UTF\-8 Universal character set \(default\) | -| AR8ISO8859P6 | ISO 8859\-6 Latin/Arabic | -| AR8MSWIN1256 | Microsoft Windows Code Page 1256 8\-bit Latin/Arabic | -| BLT8ISO8859P13 | ISO 8859\-13 Baltic | -| BLT8MSWIN1257 | Microsoft Windows Code Page 1257 8\-bit Baltic | -| CL8ISO8859P5 | ISO 88559\-5 Latin/Cyrillic | -| CL8MSWIN1251 | Microsoft Windows Code Page 1251 8\-bit Latin/Cyrillic | -| EE8ISO8859P2 | ISO 8859\-2 East European | -| EL8ISO8859P7 | ISO 8859\-7 Latin/Greek | -| EE8MSWIN1250 | Microsoft Windows Code Page 1250 8\-bit East European | -| EL8MSWIN1253 | Microsoft Windows Code Page 1253 8\-bit Latin/Greek | -| IW8ISO8859P8 | ISO 8859\-8 Latin/Hebrew | -| IW8MSWIN1255 | Microsoft Windows Code Page 1255 8\-bit Latin/Hebrew | -| JA16EUC | EUC 24\-bit Japanese | -| JA16EUCTILDE | Same as JA16EUC except for mapping of wave dash and tilde to and from Unicode | -| JA16SJIS | Shift\-JIS 16\-bit Japanese | -| JA16SJISTILDE | Same as JA16SJIS except for mapping of wave dash and tilde to and from Unicode | -| KO16MSWIN949 | Microsoft Windows Code Page 949 Korean | -| NE8ISO8859P10 | ISO 8859\-10 North European | -| NEE8ISO8859P4 | ISO 8859\-4 North and Northeast European | -| TH8TISASCII | Thai Industrial Standard 620\-2533\-ASCII 8\-bit | -| TR8MSWIN1254 | Microsoft Windows Code Page 1254 8\-bit Turkish | -| US7ASCII | ASCII 7\-bit American | -| UTF8 | Unicode 3\.0 UTF\-8 Universal character set, CESU\-8 compliant | -| VN8MSWIN1258 | Microsoft Windows Code Page 1258 8\-bit Vietnamese | -| WE8ISO8859P1 | Western European 8\-bit ISO 8859 Part 1 | -| WE8ISO8859P15 | ISO 8859\-15 West European | -| WE8ISO8859P9 | ISO 8859\-9 West European and Turkish | -| WE8MSWIN1252 | Microsoft Windows Code Page 1252 8\-bit West European | -| ZHS16GBK | GBK 16\-bit Simplified Chinese | -| ZHT16HKSCS | Microsoft Windows Code Page 950 with Hong Kong Supplementary Character Set HKSCS\-2001\. Character set conversion is based on Unicode 3\.0\. | -| ZHT16MSWIN950 | Microsoft Windows Code Page 950 Traditional Chinese | -| ZHT32EUC | EUC 32\-bit Traditional Chinese | - -### NLS\_LANG environment variable - -A locale is a set of information addressing linguistic and cultural requirements that corresponds to a given language and country\. Setting the NLS\_LANG environment variable in your client's environment is the simplest way to specify locale behavior for Oracle\. This variable sets the language and territory used by the client application and the database server\. It also indicates the client's character set, which corresponds to the character set for data entered or displayed by a client application\. For more information on NLS\_LANG and character sets, see [What is a character set or code page?](http://www.oracle.com/technetwork/database/database-technologies/globalization/nls-lang-099431.html#_Toc110410570) in the Oracle documentation\. - -### NLS initialization parameters - -You can also set the following National Language Support \(NLS\) initialization parameters at the instance level for an Oracle DB instance in Amazon RDS: -+ NLS\_DATE\_FORMAT -+ NLS\_LENGTH\_SEMANTICS -+ NLS\_NCHAR\_CONV\_EXCP -+ NLS\_TIME\_FORMAT -+ NLS\_TIME\_TZ\_FORMAT -+ NLS\_TIMESTAMP\_FORMAT -+ NLS\_TIMESTAMP\_TZ\_FORMAT - -For information about modifying instance parameters, see [Working with parameter groups](USER_WorkingWithParamGroups.md)\. - -You can set other NLS initialization parameters in your SQL client\. For example, the following statement sets the NLS\_LANGUAGE initialization parameter to GERMAN in a SQL client that is connected to an Oracle DB instance: - -``` -ALTER SESSION SET NLS_LANGUAGE=GERMAN; -``` - -For information about connecting to an Oracle DB instance with a SQL client, see [Connecting to your RDS for Oracle DB instance](USER_ConnectToOracleInstance.md)\. - -## National character set - -The national character set is used in the `NCHAR`, `NVARCHAR2`, and `NCLOB` data types\. The national character set is typically referred to as the NCHAR character set\. Unlike the DB character set, the NCHAR character set doesn't affect database metadata\. - -The NCHAR character set supports the following character sets: -+ AL16UTF16 \(default\) -+ UTF8 - -You can specify either value with the `--nchar-character-set-name` parameter of the [create\-db\-instance](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/rds/create-db-instance.html) command \(AWS CLI version 2 only\)\. If you use the Amazon RDS API, specify the `NcharCharacterSetName` parameter of [CreateDBInstance](https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_CreateDBInstance.html) operation\. You can't change the national character set after you create the database\. - -For more information about Unicode in Oracle databases, see [Supporting multilingual databases with unicode](https://docs.oracle.com/en/database/oracle/oracle-database/19/nlspg/supporting-multilingual-databases-with-unicode.html) in the Oracle documentation\. \ No newline at end of file diff --git a/doc_source/Appendix.OracleGoldenGate.md b/doc_source/Appendix.OracleGoldenGate.md deleted file mode 100644 index 7ca61cc..0000000 --- a/doc_source/Appendix.OracleGoldenGate.md +++ /dev/null @@ -1,557 +0,0 @@ -# Using Oracle GoldenGate with Amazon RDS for Oracle - -Oracle GoldenGate collects, replicates, and manages transactional data between databases\. It is a log\-based change data capture \(CDC\) and replication software package used with databases for online transaction processing \(OLTP\) systems\. Oracle GoldenGate creates trail files that contain the most recent changed data from the source database\. It then pushes these files to the server, where a process converts the trail file into standard SQL to be applied to the target database\. - -Oracle GoldenGate with RDS for Oracle supports the following features: -+ Active\-Active database replication -+ Disaster recovery -+ Data protection -+ In\-Region and cross\-Region replication -+ Zero\-downtime migration and upgrades -+ Data replication between an RDS for Oracle DB instance and a non\-Oracle database -**Note** -For a list of supported databases, see [Oracle Fusion Middleware Supported System Configurations](https://www.oracle.com/middleware/technologies/fusion-certification.html) in the Oracle documentation\. - -You can use Oracle GoldenGate with RDS for Oracle to upgrade to major versions of Oracle Database\. For example, you can use Oracle GoldenGate to upgrade from an Oracle Database 11g on\-premises database to Oracle Database 19c on an Amazon RDS DB instance\. - -**Topics** -+ [Supported versions and licensing options for Oracle GoldenGate](#Appendix.OracleGoldenGate.licensing) -+ [Requirements and limitations for Oracle GoldenGate](#Appendix.OracleGoldenGate.requirements) -+ [Oracle GoldenGate architecture](#Appendix.OracleGoldenGate.Overview) -+ [Setting up Oracle GoldenGate](#Appendix.OracleGoldenGate.setting-up) -+ [Working with the EXTRACT and REPLICAT utilities of Oracle GoldenGate](#Appendix.OracleGoldenGate.ExtractReplicat) -+ [Monitoring Oracle GoldenGate](#Appendix.OracleGoldenGate.Monitoring) -+ [Troubleshooting Oracle GoldenGate](#Appendix.OracleGoldenGate.Troubleshooting) - -## Supported versions and licensing options for Oracle GoldenGate - -You can use Standard Edition Two \(SE2\) or Enterprise Edition \(EE\) of RDS for Oracle with Oracle GoldenGate version 12c and higher\. You can use the following Oracle GoldenGate features: -+ Oracle GoldenGate Remote Capture \(extract\) is supported\. -+ Capture \(extract\) is supported on RDS for Oracle DB instances that use the traditional non\-CDB database architecture\. Oracle GoldenGate Remote PDB capture is supported on Oracle Database 21c container databases \(CDBs\)\. -+ Oracle GoldenGate Remote Delivery \(replicat\) is supported on RDS for Oracle DB instances that use either the non\-CDB or CDB architectures\. Remote Delivery supports Integrated Replicat, Parallel Replicat, Coordinated Replicat, and classic Replicat\. -+ RDS for Oracle supports the Classic and Microservices architectures of Oracle GoldenGate\. -+ Oracle GoldenGate DDL and Sequence value replication is supported when using Integrated capture mode\. - -You are responsible for managing Oracle GoldenGate licensing \(BYOL\) for use with Amazon RDS in all AWS Regions\. For more information, see [RDS for Oracle licensing options](Oracle.Concepts.Licensing.md)\. - -## Requirements and limitations for Oracle GoldenGate - -When you're working with Oracle GoldenGate and RDS for Oracle, consider the following requirements and limitations: -+ You're responsible for setting up and managing Oracle GoldenGate for use with RDS for Oracle\. -+ You're responsible for setting up an Oracle GoldenGate version that is certified with the source and the target databases\. For more information, see [Oracle Fusion Middleware Supported System Configurations](https://www.oracle.com/middleware/technologies/fusion-certification.html) in the Oracle documentation\. -+ You can use Oracle GoldenGate on many different AWS environments for many different use cases\. If you have a support\-related issue relating to Oracle GoldenGate, contact Oracle Support Services\. -+ You can use Oracle GoldenGate on RDS for Oracle DB instances that use Oracle Transparent Data Encryption \(TDE\)\. To maintain the integrity of replicated data, configure encryption on the Oracle GoldenGate hub using Amazon EBS encrypted volumes or trail file encryption\. Also configure encryption for data sent between the Oracle GoldenGate hub and the source and target database instances\. RDS for Oracle DB instances support encryption with [Oracle Secure Sockets Layer](Appendix.Oracle.Options.SSL.md) or [Oracle native network encryption](Appendix.Oracle.Options.NetworkEncryption.md)\. - -## Oracle GoldenGate architecture - -The Oracle GoldenGate architecture for use with Amazon RDS consists of the following decoupled modules: - -Source database -Your source database can be either an on\-premises Oracle database, an Oracle database on an Amazon EC2 instance, or an Oracle database on an Amazon RDS DB instance\. - -Oracle GoldenGate hub -An Oracle GoldenGate hub moves transaction information from the source database to the target database\. Your hub can be either of the following: -+ An Amazon EC2 instance with Oracle Database and Oracle GoldenGate installed -+ An on\-premises Oracle installation -You can have more than one Amazon EC2 hub\. We recommend that you use two hubs if you use Oracle GoldenGate for cross\-Region replication\. - -Target database -Your target database can be on either an Amazon RDS DB instance, an Amazon EC2 instance, or an on\-premises location\. - -The following sections describe common scenarios for Oracle GoldenGate on Amazon RDS\. - -**Topics** -+ [On\-premises source database and Oracle GoldenGate hub](#Appendix.OracleGoldenGate.on-prem-source-gg-hub) -+ [On\-premises source database and Amazon EC2 hub](#Appendix.OracleGoldenGate.on-prem-source-ec2-hub) -+ [Amazon RDS source database and Amazon EC2 hub](#Appendix.OracleGoldenGate.rds-source-ec2-hub) -+ [Amazon EC2 source database and Amazon EC2 hub](#Appendix.OracleGoldenGate.ec2-source-ec2-hub) -+ [Amazon EC2 hubs in different AWS Regions](#Appendix.OracleGoldenGate.cross-region-hubs) - -### On\-premises source database and Oracle GoldenGate hub - -In this scenario, an on\-premises Oracle source database and on\-premises Oracle GoldenGate hub provides data to a target Amazon RDS DB instance\. - -![\[Oracle GoldenGate configuration 0 using Amazon RDS\]](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/images/oracle-gg0.png) - -### On\-premises source database and Amazon EC2 hub - -In this scenario, an on\-premises Oracle database acts as the source database\. It's connected to an Amazon EC2 instance hub\. This hub provides data to a target RDS for Oracle DB instance\. - -![\[Oracle GoldenGate configuration 1 using Amazon RDS\]](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/images/oracle-gg1.png) - -### Amazon RDS source database and Amazon EC2 hub - -In this scenario, an RDS for Oracle DB instance acts as the source database\. It's connected to an Amazon EC2 instance hub\. This hub provides data to a target RDS for Oracle DB instance\. - -![\[Oracle GoldenGate configuration 2 using Amazon RDS\]](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/images/oracle-gg2.png) - -### Amazon EC2 source database and Amazon EC2 hub - -In this scenario, an Oracle database on an Amazon EC2 instance acts as the source database\. It's connected to an Amazon EC2 instance hub\. This hub provides data to a target RDS for Oracle DB instance\. - -![\[Oracle GoldenGate configuration 3 using Amazon RDS\]](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/images/oracle-gg3.png) - -### Amazon EC2 hubs in different AWS Regions - -In this scenario, an Oracle database on an Amazon RDS DB instance is connected to an Amazon EC2 instance hub in the same AWS Region\. The hub is connected to an Amazon EC2 instance hub in a different AWS Region\. This second hub provides data to the target RDS for Oracle DB instance in the same AWS Region as the second Amazon EC2 instance hub\. - -![\[Oracle GoldenGate configuration 4 using Amazon RDS\]](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/images/oracle-gg4.png) - -**Note** -Any issues that affect running Oracle GoldenGate on an on\-premises environment also affect running Oracle GoldenGate on AWS\. We strongly recommend that you monitor the Oracle GoldenGate hub to ensure that `EXTRACT` and `REPLICAT` are resumed if a failover occurs\. Because the Oracle GoldenGate hub is run on an Amazon EC2 instance, Amazon RDS does not manage the Oracle GoldenGate hub and cannot ensure that it is running\. - -## Setting up Oracle GoldenGate - -To set up Oracle GoldenGate using Amazon RDS, configure the hub on an Amazon EC2 instance, and then configure the source and target databases\. The following sections give an example of how to set up Oracle GoldenGate for use with Amazon RDS for Oracle\. - -**Topics** -+ [Setting up an Oracle GoldenGate hub on Amazon EC2](#Appendix.OracleGoldenGate.Hub) -+ [Setting up a source database for use with Oracle GoldenGate on Amazon RDS](#Appendix.OracleGoldenGate.Source) -+ [Setting up a target database for use with Oracle GoldenGate on Amazon RDS](#Appendix.OracleGoldenGate.Target) - -### Setting up an Oracle GoldenGate hub on Amazon EC2 - -To create an Oracle GoldenGate hub on an Amazon EC2 instance, you first create an Amazon EC2 instance with a full client installation of Oracle RDBMS\. The Amazon EC2 instance must also have Oracle GoldenGate software installed\. The Oracle GoldenGate software versions depend on the source and target database versions\. For more information about installing Oracle GoldenGate, see the [Oracle GoldenGate documentation](https://docs.oracle.com/en/middleware/goldengate/core/index.html)\. - -The Amazon EC2 instance that serves as the Oracle GoldenGate hub stores and processes the transaction information from the source database into trail files\. To support this process, make sure that you meet the following requirements: -+ You have allocated enough storage for the trail files\. -+ The Amazon EC2 instance has enough processing power to manage the amount of data\. -+ The EC2 instance has enough memory to store the transaction information before it's written to the trail file\. - -**To set up an Oracle GoldenGate classic architecture hub on an Amazon EC2 instance** - -1. Create subdirectories in the Oracle GoldenGate directory\. - - In the Amazon EC2 command line shell, start `ggsci`, the Oracle GoldenGate command interpreter\. The `CREATE SUBDIRS` command creates subdirectories under the `/gg` directory for parameter, report, and checkpoint files\. - - ``` - prompt$ cd /gg - prompt$ ./ggsci - - GGSCI> CREATE SUBDIRS - ``` - -1. Configure the `mgr.prm` file\. - - The following example adds lines to the `$GGHOME/dirprm/mgr.prm` file\. - - ``` - PORT 8199 - PurgeOldExtracts ./dirdat/*, UseCheckpoints, MINKEEPDAYS 5 - ``` - -1. Start the manager\. - - The following example starts `ggsci` and runs the `start mgr` command\. - - ``` - GGSCI> start mgr - ``` - -The Oracle GoldenGate hub is now ready for use\. - -### Setting up a source database for use with Oracle GoldenGate on Amazon RDS - -When your source database is running Oracle Database 12c or later, complete the following tasks to set up a source database for use with Oracle GoldenGate\. - -**Topics** -+ [Step 1: Turn on supplemental logging on the source database](#Appendix.OracleGoldenGate.Source.Logging) -+ [Step 2: Set the ENABLE\_GOLDENGATE\_REPLICATION initialization parameter to true](#Appendix.OracleGoldenGate.Source.enable-gg-rep) -+ [Step 3: Set the log retention period on the source database](#Appendix.OracleGoldenGate.Source.Retention) -+ [Step 4: Create an Oracle GoldenGate user account on the source database](#Appendix.OracleGoldenGate.Source.Account) -+ [Step 5: Grant user account privileges on the source database](#Appendix.OracleGoldenGate.Source.Privileges) -+ [Step 6: Add a TNS alias for the source database](#Appendix.OracleGoldenGate.Source.TNS) - -#### Step 1: Turn on supplemental logging on the source database - -To turn on the minimum database\-level supplemental logging, run the following PL/SQL procedure: - -``` -EXEC rdsadmin.rdsadmin_util.alter_supplemental_logging(p_action => 'ADD') -``` - -#### Step 2: Set the ENABLE\_GOLDENGATE\_REPLICATION initialization parameter to true - -When you set the `ENABLE_GOLDENGATE_REPLICATION` initialization parameter to `true`, it allows database services to support logical replication\. If your source database is on an Amazon RDS DB instance, make sure that you have a parameter group assigned to the DB instance with the `ENABLE_GOLDENGATE_REPLICATION` initialization parameter set to `true`\. For more information about the `ENABLE_GOLDENGATE_REPLICATION` initialization parameter, see the [Oracle Database documentation](https://docs.oracle.com/en/database/oracle/oracle-database/19/refrn/ENABLE_GOLDENGATE_REPLICATION.html)\. - -#### Step 3: Set the log retention period on the source database - -Make sure that you configure the source database to retain archived redo logs\. Consider the following guidelines: -+ Specify the duration for log retention in hours\. The minimum value is one hour\. -+ Set the duration to exceed any potential downtime of the source DB instance, any potential period of communication, and any potential period of networking issues for the source instance\. Such a duration lets Oracle GoldenGate recover logs from the source instance as needed\. -+ Ensure that you have sufficient storage on your instance for the files\. - -For example, set the retention period for archived redo logs to 24 hours\. - -``` -EXEC rdsadmin.rdsadmin_util.set_configuration('archivelog retention hours',24) -``` - -If you don't have log retention enabled, or if the retention value is too small, you receive an error message similar to the following\. - -``` -2022-03-06 06:17:27 ERROR OGG-00446 error 2 (No such file or directory) -opening redo log /rdsdbdata/db/GGTEST3_A/onlinelog/o1_mf_2_9k4bp1n6_.log for sequence 1306 -Not able to establish initial position for begin time 2022-03-06 06:16:55. -``` - -Because your DB instance retains your archived redo logs, make sure that you have sufficient space for the files\. To see how much space you have used in the last *num\_hours* hours, run the following query, replacing *num\_hours* with the number of hours\. - -``` -SELECT SUM(BLOCKS * BLOCK_SIZE) BYTES FROM V$ARCHIVED_LOG - WHERE NEXT_TIME>=SYSDATE-num_hours/24 AND DEST_ID=1; -``` - -#### Step 4: Create an Oracle GoldenGate user account on the source database - -Oracle GoldenGate runs as a database user and requires the appropriate database privileges to access the redo and archived redo logs for the source database\. To provide these, create a user account on the source database\. For more information about the permissions for an Oracle GoldenGate user account, see the [Oracle documentation](https://docs.oracle.com/en/middleware/goldengate/core/19.1/oracle-db/establishing-oracle-goldengate-credentials.html#GUID-79122058-27B0-4FB6-B3DC-B7D1B67EB053)\. - -The following statements create a user account named `oggadm1`\. - -``` -CREATE TABLESPACE administrator; -CREATE USER oggadm1  IDENTIFIED BY "password" - DEFAULT TABLESPACE ADMINISTRATOR TEMPORARY TABLESPACE TEMP; -ALTER USER oggadm1 QUOTA UNLIMITED ON administrator; -``` - -#### Step 5: Grant user account privileges on the source database - -In this task, you grant necessary account privileges for database users on your source database\. - -**To grant account privileges on the source database** - -1. Grant the necessary privileges to the Oracle GoldenGate user account using the SQL command `grant` and the `rdsadmin.rdsadmin_util` procedure `grant_sys_object`\. The following statements grant privileges to a user named `oggadm1`\. - - ``` - GRANT CREATE SESSION, ALTER SESSION TO oggadm1; - GRANT RESOURCE TO oggadm1; - GRANT SELECT ANY DICTIONARY TO oggadm1; - GRANT FLASHBACK ANY TABLE TO oggadm1; - GRANT SELECT ANY TABLE TO oggadm1; - GRANT SELECT_CATALOG_ROLE TO rds_master_user_name WITH ADMIN OPTION; - EXEC rdsadmin.rdsadmin_util.grant_sys_object ('DBA_CLUSTERS', 'OGGADM1'); - GRANT EXECUTE ON DBMS_FLASHBACK TO oggadm1; - GRANT SELECT ON SYS.V_$DATABASE TO oggadm1; - GRANT ALTER ANY TABLE TO oggadm1; - ``` - -1. Grant the privileges needed by a user account to be an Oracle GoldenGate administrator\. The package that you use to perform the grant, `dbms_goldengate_auth` or `rdsadmin_dbms_goldengate_auth`, depends on the Oracle DB engine version\. - + For Oracle DB versions that are later than or equal to Oracle Database 12c Release 2 \(12\.2\), which requires patch level 12\.2\.0\.1\.ru\-2019\-04\.rur\-2019\-04\.r1 or later, run the following PL/SQL program\. - - ``` - EXEC rdsadmin.rdsadmin_dbms_goldengate_auth.grant_admin_privilege ( - grantee => 'OGGADM1', - privilege_type => 'capture', - grant_select_privileges => true, - do_grants => TRUE); - ``` - + For Oracle database versions that are earlier than Oracle Database 12c Release 2 \(12\.2\), run the following PL/SQL program\. - - ``` - EXEC dbms_goldengate_auth.grant_admin_privilege ( - grantee => 'OGGADM1', - privilege_type => 'capture', - grant_select_privileges => true, - do_grants => TRUE); - ``` - - To revoke privileges, use the procedure `revoke_admin_privilege` in the same package\. - -#### Step 6: Add a TNS alias for the source database - -Add the following entry to `$ORACLE_HOME/network/admin/tnsnames.ora` in the Oracle home to be used by the `EXTRACT` process\. For more information on the `tnsnames.ora` file, see the [Oracle documentation](https://docs.oracle.com/en/database/oracle/oracle-database/19/netrf/local-naming-parameters-in-tns-ora-file.html#GUID-7F967CE5-5498-427C-9390-4A5C6767ADAA)\. - -``` -OGGSOURCE= - (DESCRIPTION= - (ENABLE=BROKEN) - (ADDRESS_LIST= - (ADDRESS=(PROTOCOL=TCP)(HOST=goldengate-source.abcdef12345.us-west-2.rds.amazonaws.com)(PORT=8200))) - (CONNECT_DATA=(SERVICE_NAME=ORCL)) - ) -``` - -### Setting up a target database for use with Oracle GoldenGate on Amazon RDS - -In this task, you set up a target DB instance for use with Oracle GoldenGate\. - -**Topics** -+ [Step 1: Set the ENABLE\_GOLDENGATE\_REPLICATION initialization parameter to true](#Appendix.OracleGoldenGate.Target.enable-gg-rep) -+ [Step 2: Create an Oracle GoldenGate user account on the target database](#Appendix.OracleGoldenGate.Target.User) -+ [Step 3: Grant account privileges on the target database](#Appendix.OracleGoldenGate.Target.Privileges) -+ [Step 4: Add a TNS alias for the target database](#Appendix.OracleGoldenGate.Target.TNS) - -#### Step 1: Set the ENABLE\_GOLDENGATE\_REPLICATION initialization parameter to true - -When you set the `ENABLE_GOLDENGATE_REPLICATION` initialization parameter is to `true`, it allows database services to support logical replication\. If your source database is on an Amazon RDS DB instance, make sure that you have a parameter group assigned to the DB instance with the `ENABLE_GOLDENGATE_REPLICATION` initialization parameter set to `true`\. For more information about the `ENABLE_GOLDENGATE_REPLICATION` initialization parameter, see the [Oracle Database documentation](https://docs.oracle.com/en/database/oracle/oracle-database/19/refrn/ENABLE_GOLDENGATE_REPLICATION.html)\. - -#### Step 2: Create an Oracle GoldenGate user account on the target database - -Oracle GoldenGate runs as a database user and requires the appropriate database privileges\. To make sure it has these privileges, create a user account on the target database\. - -The following statement creates a user named `oggadm1`\. - -``` -CREATE TABLESPSACE administrator; -CREATE USER oggadm1  IDENTIFIED BY "password" - DEFAULT TABLESPACE administrator - TEMPORARY TABLESPACE temp; -ALTER USER oggadm1 QUOTA UNLIMITED ON administrator; -``` - -#### Step 3: Grant account privileges on the target database - -In this task, you grant necessary account privileges for database users on your target database\. - -**To grant account privileges on the target database** - -1. Grant necessary privileges to the Oracle GoldenGate user account on the target database\. In the following example, you grant privileges to `oggadm1`\. - - ``` - GRANT CREATE SESSION        TO oggadm1; - GRANT ALTER SESSION         TO oggadm1; - GRANT CREATE CLUSTER        TO oggadm1; - GRANT CREATE INDEXTYPE      TO oggadm1; - GRANT CREATE OPERATOR       TO oggadm1; - GRANT CREATE PROCEDURE      TO oggadm1; - GRANT CREATE SEQUENCE       TO oggadm1; - GRANT CREATE TABLE          TO oggadm1; - GRANT CREATE TRIGGER        TO oggadm1; - GRANT CREATE TYPE           TO oggadm1; - GRANT SELECT ANY DICTIONARY TO oggadm1; - GRANT CREATE ANY TABLE      TO oggadm1; - GRANT ALTER ANY TABLE       TO oggadm1; - GRANT LOCK ANY TABLE        TO oggadm1; - GRANT SELECT ANY TABLE      TO oggadm1; - GRANT INSERT ANY TABLE      TO oggadm1; - GRANT UPDATE ANY TABLE      TO oggadm1; - GRANT DELETE ANY TABLE      TO oggadm1; - ``` - -1. Grant the privileges needed by a user account to be an Oracle GoldenGate administrator\. The package that you use to perform the grant, `dbms_goldengate_auth` or `rdsadmin_dbms_goldengate_auth`, depends on the Oracle DB engine version\. - + For Oracle database versions that are later than or equal to Oracle Database 12c Release 2 \(12\.2\), which requires patch level 12\.2\.0\.1\.ru\-2019\-04\.rur\-2019\-04\.r1 or later, run the following PL/SQL program\. - - ``` - EXEC rdsadmin.rdsadmin_dbms_goldengate_auth.grant_admin_privilege ( - grantee => 'OGGADM1', - privilege_type => 'apply', - grant_select_privileges => true, - do_grants => TRUE); - ``` - + For Oracle database versions that are lower than Oracle Database 12c Release 2 \(12\.2\), run the following PL/SQL program\. - - ``` - EXEC dbms_goldengate_auth.grant_admin_privilege ( - grantee => 'OGGADM1', - privilege_type => 'apply', - grant_select_privileges => true, - do_grants => TRUE); - ``` - - To revoke privileges, use the procedure `revoke_admin_privilege` in the same package\. - -#### Step 4: Add a TNS alias for the target database - -Add the following entry to `$ORACLE_HOME/network/admin/tnsnames.ora` in the Oracle home to be used by the `REPLICAT` process\. For Oracle Multitenant databases, make sure that the TNS alias points to the service name of the PDB\. For more information on the `tnsnames.ora` file, see the [Oracle documentation](https://docs.oracle.com/en/database/oracle/oracle-database/19/netrf/local-naming-parameters-in-tns-ora-file.html#GUID-7F967CE5-5498-427C-9390-4A5C6767ADAA)\. - -``` -OGGTARGET= - (DESCRIPTION= - (ENABLE=BROKEN) - (ADDRESS_LIST= - (ADDRESS=(PROTOCOL=TCP)(HOST=goldengate-target.abcdef12345.us-west-2.rds.amazonaws.com)(PORT=8200))) - (CONNECT_DATA=(SERVICE_NAME=ORCL)) - ) -``` - -## Working with the EXTRACT and REPLICAT utilities of Oracle GoldenGate - -The Oracle GoldenGate utilities `EXTRACT` and `REPLICAT` work together to keep the source and target databases in sync via incremental transaction replication using trail files\. All changes that occur on the source database are automatically detected by `EXTRACT`, then formatted and transferred to trail files on the Oracle GoldenGate on\-premises or Amazon EC2 instance hub\. After initial load is completed, the data is read from these files and replicated to the target database by the `REPLICAT` utility\. - -### Running the Oracle GoldenGate EXTRACT utility - -The `EXTRACT` utility retrieves, converts, and outputs data from the source database to trail files\. The basic process is as follows: - -1. `EXTRACT` queues transaction details to memory or to temporary disk storage\. - -1. The source database commits the transaction\. - -1. `EXTRACT` writes the transaction details to a trail file\. - -1. The trail file routes these details to the Oracle GoldenGate on\-premises or the Amazon EC2 instance hub and then to the target database\. - -The following steps start the `EXTRACT` utility, capture the data from `EXAMPLE.TABLE` in source database `OGGSOURCE`, and create the trail files\. - -**To run the EXTRACT utility** - -1. Configure the `EXTRACT` parameter file on the Oracle GoldenGate hub \(on\-premises or Amazon EC2 instance\)\. The following listing shows an example `EXTRACT` parameter file named `$GGHOME/dirprm/eabc.prm`\. - - ``` - EXTRACT EABC -   - USERID oggadm1@OGGSOURCE, PASSWORD "my-password" - EXTTRAIL /path/to/goldengate/dirdat/ab -   - IGNOREREPLICATES - GETAPPLOPS - TRANLOGOPTIONS EXCLUDEUSER OGGADM1 -   - TABLE EXAMPLE.TABLE; - ``` - -1. On the Oracle GoldenGate hub, log in to the source database and launch the Oracle GoldenGate command line interface `ggsci`\. The following example shows the format for logging in\. - - ``` - dblogin oggadm1@OGGSOURCE - ``` - -1. Add transaction data to turn on supplemental logging for the database table\. - - ``` - add trandata EXAMPLE.TABLE - ``` - -1. Using the `ggsci` command line, enable the `EXTRACT` utility using the following commands\. - - ``` - add extract EABC tranlog, INTEGRATED tranlog, begin now - add exttrail /path/to/goldengate/dirdat/ab - extract EABC, - MEGABYTES 100 - ``` - -1. Register the `EXTRACT` utility with the database so that the archive logs are not deleted\. This task allows you to recover old, uncommitted transactions if necessary\. To register the `EXTRACT` utility with the database, use the following command\. - - ``` - register EXTRACT EABC, DATABASE - ``` - -1. Start the `EXTRACT` utility with the following command\. - - ``` - start EABC - ``` - -### Running the Oracle GoldenGate REPLICAT utility - -The `REPLICAT` utility "pushes" transaction information in the trail files to the target database\. - -The following steps enable and start the `REPLICAT` utility so that it can replicate the captured data to the table `EXAMPLE.TABLE` in target database `OGGTARGET`\. - -**To run the REPLICATE utility** - -1. Configure the `REPLICAT` parameter file on the Oracle GoldenGate hub \(on\-premises or EC2 instance\)\. The following listing shows an example `REPLICAT` parameter file named `$GGHOME/dirprm/rabc.prm`\. - - ``` - REPLICAT RABC -   - USERID oggadm1@OGGTARGET, password "my-password" -   - ASSUMETARGETDEFS - MAP EXAMPLE.TABLE, TARGET EXAMPLE.TABLE; - ``` - -1. Log in to the target database and launch the Oracle GoldenGate command line interface \(`ggsci`\)\. The following example shows the format for logging in\. - - ``` - dblogin userid oggadm1@OGGTARGET - ``` - -1. Using the `ggsci` command line, add a checkpoint table\. The user indicated should be the Oracle GoldenGate user account, not the target table schema owner\. The following example creates a checkpoint table named `gg_checkpoint`\. - - ``` - add checkpointtable oggadm1.oggchkpt - ``` - -1. To enable the `REPLICAT` utility, use the following command\. - - ``` - add replicat RABC EXTTRAIL /path/to/goldengate/dirdat/ab CHECKPOINTTABLE oggadm1.oggchkpt - ``` - -1. Start the `REPLICAT` utility by using the following command\. - - ``` - start RABC - ``` - -## Monitoring Oracle GoldenGate - -When you use Oracle GoldenGate for replication, make sure that the Oracle GoldenGate process is up and running and the source and target databases are synchronized\. You can use the following monitoring tools: -+ [Amazon CloudWatch](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/WhatIsCloudWatch.html) is a monitoring service that is used in this pattern to monitor GoldenGate error logs\. -+ [Amazon SNS](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/US_SetupSNS.html) is a message notification service that is used in this pattern to send email notifications\. - -For detailed instructions, see [Monitor Oracle GoldenGate logs by using Amazon CloudWatch](https://docs.aws.amazon.com/prescriptive-guidance/latest/patterns/monitor-oracle-goldengate-logs-by-using-amazon-cloudwatch.html)\. - -## Troubleshooting Oracle GoldenGate - -This section explains the most common issues when using Oracle GoldenGate with Amazon RDS for Oracle\. - -**Topics** -+ [Error opening an online redo log](#Appendix.OracleGoldenGate.Troubleshooting.Logs) -+ [Oracle GoldenGate appears to be properly configured but replication is not working](#Appendix.OracleGoldenGate.Troubleshooting.Replication) -+ [Integrated REPLICAT slow due to query on SYS\."\_DBA\_APPLY\_CDR\_INFO"](#Appendix.OracleGoldenGate.IR) - -### Error opening an online redo log - -Make sure that you configure your databases to retain archived redo logs\. Consider the following guidelines: -+ Specify the duration for log retention in hours\. The minimum value is one hour\. -+ Set the duration to exceed any potential downtime of the source DB instance, any potential period of communication, and any potential period of networking issues for the source DB instance\. Such a duration lets Oracle GoldenGate recover logs from the source DB instance as needed\. -+ Ensure that you have sufficient storage on your instance for the files\. - -If you don't have log retention enabled, or if the retention value is too small, you receive an error message similar to the following\. - -``` -2022-03-06 06:17:27 ERROR OGG-00446 error 2 (No such file or directory) -opening redo log /rdsdbdata/db/GGTEST3_A/onlinelog/o1_mf_2_9k4bp1n6_.log for sequence 1306 -Not able to establish initial position for begin time 2022-03-06 06:16:55. -``` - -### Oracle GoldenGate appears to be properly configured but replication is not working - -For pre\-existing tables, you must specify the SCN that Oracle GoldenGate works from\. - -**To fix this issue** - -1. Log in to the source database and launch the Oracle GoldenGate command line interface \(`ggsci`\)\. The following example shows the format for logging in\. - - ``` - dblogin userid oggadm1@OGGSOURCE - ``` - -1. Using the `ggsci` command line, set up the start SCN for the `EXTRACT` process\. The following example sets the SCN to 223274 for the `EXTRACT`\. - - ``` - ALTER EXTRACT EABC SCN 223274 - start EABC - ``` - -1. Log in to the target database\. The following example shows the format for logging in\. - - ``` - dblogin userid oggadm1@OGGTARGET - ``` - -1. Using the `ggsci` command line, set up the start SCN for the `REPLICAT` process\. The following example sets the SCN to 223274 for the `REPLICAT`\. - - ``` - start RABC atcsn 223274 - ``` - -### Integrated REPLICAT slow due to query on SYS\."\_DBA\_APPLY\_CDR\_INFO" - -Oracle GoldenGate Conflict Detection and Resolution \(CDR\) provides basic conflict resolution routines\. For example, CDR can resolve a unique conflict for an `INSERT` statement\. - -When CDR resolves a collision, it can insert records into the exception table `_DBA_APPLY_CDR_INFO` temporarily\. Integrated `REPLICAT` deletes these records later\. In a rare scenario, the integrated `REPLICAT` can process a large number of collisions, but a new integrated `REPLICAT` does not replace it\. Instead of being removed, the existing rows in `_DBA_APPLY_CDR_INFO` are orphaned\. Any new integrated `REPLICAT` processes slow down because they are querying orphaned rows in `_DBA_APPLY_CDR_INFO`\. - -To remove all rows from `_DBA_APPLY_CDR_INFO`, use the Amazon RDS procedure `rdsadmin.rdsadmin_util.truncate_apply$_cdr_info`\. This procedure is released as part of the October 2020 release and patch update\. The procedure is available in the following database versions: -+ [ Version 21\.0\.0\.0\.ru\-2022\-01\.rur\-2022\-01\.r1](https://docs.aws.amazon.com/AmazonRDS/latest/OracleReleaseNotes/oracle-version-21-0.html#oracle-version-RU-RUR.21.0.0.0.ru-2022-01.rur-2022-01.r1) and higher -+ [ Version 19\.0\.0\.0\.ru\-2020\-10\.rur\-2020\-10\.r1](https://docs.aws.amazon.com/AmazonRDS/latest/OracleReleaseNotes/oracle-version-19-0.html#oracle-version-RU-RUR.19.0.0.0.ru-2020-10.rur-2020-10.r1) and higher - -The following example truncates the table `_DBA_APPLY_CDR_INFO`\. - -``` -SET SERVEROUTPUT ON SIZE 2000 -EXEC rdsadmin.rdsadmin_util.truncate_apply$_cdr_info; -``` \ No newline at end of file diff --git a/doc_source/Appendix.PostgreSQL.CommonDBATasks.Autovacuum.md b/doc_source/Appendix.PostgreSQL.CommonDBATasks.Autovacuum.md deleted file mode 100644 index 48e35a9..0000000 --- a/doc_source/Appendix.PostgreSQL.CommonDBATasks.Autovacuum.md +++ /dev/null @@ -1,450 +0,0 @@ -# Working with the PostgreSQL autovacuum on Amazon RDS for PostgreSQL - -We strongly recommend that you use the autovacuum feature to maintain the health of your PostgreSQL DB instance\. Autovacuum automates the start of the VACUUM and the ANALYZE commands\. It checks for tables with a large number of inserted, updated, or deleted tuples\. After this check, it reclaims storage by removing obsolete data or tuples from the PostgreSQL database\. - -By default, autovacuum is turned on for the Amazon RDS for PostgreSQL DB instances that you create using any of the default PostgreSQL DB parameter groups\. These include `default.postgres10`, `default.postgres11`, and so on\. All default PostgreSQL DB parameter groups have an `rds.adaptive_autovacuum` parameter that's set to `1`, thus activating the feature\. Other configuration parameters associated with the autovacuum feature are also set by default\. Because these defaults are somewhat generic, you can benefit from tuning some of the parameters associated with the autovacuum feature for your specific workload\. - -Following, you can find more information about the autovacuum and how to tune some of its parameters on your RDS for PostgreSQL DB instance\. For high\-level information, see [Best practices for working with PostgreSQL](CHAP_BestPractices.md#CHAP_BestPractices.PostgreSQL)\. - -**Topics** -+ [Allocating memory for autovacuum](#Appendix.PostgreSQL.CommonDBATasks.Autovacuum.WorkMemory) -+ [Reducing the likelihood of transaction ID wraparound](#Appendix.PostgreSQL.CommonDBATasks.Autovacuum.AdaptiveAutoVacuuming) -+ [Determining if the tables in your database need vacuuming](#Appendix.PostgreSQL.CommonDBATasks.Autovacuum.NeedVacuuming) -+ [Determining which tables are currently eligible for autovacuum](#Appendix.PostgreSQL.CommonDBATasks.Autovacuum.EligibleTables) -+ [Determining if autovacuum is currently running and for how long](#Appendix.PostgreSQL.CommonDBATasks.Autovacuum.AutovacuumRunning) -+ [Performing a manual vacuum freeze](#Appendix.PostgreSQL.CommonDBATasks.Autovacuum.VacuumFreeze) -+ [Reindexing a table when autovacuum is running](#Appendix.PostgreSQL.CommonDBATasks.Autovacuum.Reindexing) -+ [Managing autovacuum with large indexes](#Appendix.PostgreSQL.CommonDBATasks.Autovacuum.LargeIndexes) -+ [Other parameters that affect autovacuum](#Appendix.PostgreSQL.CommonDBATasks.Autovacuum.OtherParms) -+ [Setting table\-level autovacuum parameters](#Appendix.PostgreSQL.CommonDBATasks.Autovacuum.TableParameters) -+ [Logging autovacuum and vacuum activities](#Appendix.PostgreSQL.CommonDBATasks.Autovacuum.Logging) - -## Allocating memory for autovacuum - -One of the most important parameters influencing autovacuum performance is the [maintenance\_work\_mem](https://www.postgresql.org/docs/current/static/runtime-config-resource.html#GUC-MAINTENANCE-WORK-MEM) parameter\. This parameter determines how much memory that you allocate for autovacuum to use to scan a database table and to hold all the row IDs that are going to be vacuumed\. If you set the value of the `maintenance_work_mem` parameter too low, the vacuum process might have to scan the table multiple times to complete its work\. Such multiple scans can have a negative impact on performance\. - -When doing calculations to determine the `maintenance_work_mem` parameter value, keep in mind two things: -+ The default unit is kilobytes \(KB\) for this parameter\. -+ The `maintenance_work_mem` parameter works in conjunction with the [https://www.postgresql.org/docs/current/static/runtime-config-autovacuum.html#GUC-AUTOVACUUM-MAX-WORKERS](https://www.postgresql.org/docs/current/static/runtime-config-autovacuum.html#GUC-AUTOVACUUM-MAX-WORKERS) parameter\. If you have many small tables, allocate more `autovacuum_max_workers` and less `maintenance_work_mem`\. If you have large tables \(say, larger than 100 GB\), allocate more memory and fewer worker processes\. You need to have enough memory allocated to succeed on your biggest table\. Each `autovacuum_max_workers` can use the memory that you allocate\. Thus, make sure that the combination of worker processes and memory equal the total memory that you want to allocate\. - -In general terms, for large hosts set the `maintenance_work_mem` parameter to a value between one and two gigabytes \(between 1,048,576 and 2,097,152 KB\)\. For extremely large hosts, set the parameter to a value between two and four gigabytes \(between 2,097,152 and 4,194,304 KB\)\. The value that you set for this parameter depends on the workload\. Amazon RDS has updated its default for this parameter to be kilobytes calculated as follows\. - - `GREATEST({DBInstanceClassMemory/63963136*1024},65536)`\. - -## Reducing the likelihood of transaction ID wraparound - -In some cases, parameter group settings related to autovacuum might not be aggressive enough to prevent transaction ID wraparound\. To address this, RDS for PostgreSQL provides a mechanism that adapts the autovacuum parameter values automatically\. *Adaptive autovacuum parameter tuning* is a feature for RDS for PostgreSQL\. A detailed explanation of [TransactionID wraparound](https://www.postgresql.org/docs/current/static/routine-vacuuming.html#VACUUM-FOR-WRAPAROUND) is found in the PostgreSQL documentation\. - -Adaptive autovacuum parameter tuning is turned on by default for RDS for PostgreSQL instances with the dynamic parameter `rds.adaptive_autovacuum` set to ON\. We strongly recommend that you keep this turned on\. However, to turn off adaptive autovacuum parameter tuning, set the `rds.adaptive_autovacuum` parameter to 0 or OFF\. - -Transaction ID wraparound is still possible even when Amazon RDS tunes the autovacuum parameters\. We encourage you to implement an Amazon CloudWatch alarm for transaction ID wraparound\. For more information, see the post [Implement an early warning system for transaction ID wraparound in RDS for PostgreSQL](http://aws.amazon.com/blogs/database/implement-an-early-warning-system-for-transaction-id-wraparound-in-amazon-rds-for-postgresql/) on the AWS Database Blog\. - -With adaptive autovacuum parameter tuning turned on, Amazon RDS begins adjusting autovacuum parameters when the CloudWatch metric `MaximumUsedTransactionIDs` reaches the value of the `autovacuum_freeze_max_age` parameter or 500,000,000, whichever is greater\. - -Amazon RDS continues to adjust parameters for autovacuum if a table continues to trend toward transaction ID wraparound\. Each of these adjustments dedicates more resources to autovacuum to avoid wraparound\. Amazon RDS updates the following autovacuum\-related parameters: -+ [autovacuum\_vacuum\_cost\_delay](https://www.postgresql.org/docs/current/static/runtime-config-autovacuum.html#GUC-AUTOVACUUM-VACUUM-COST-DELAY) -+ [ autovacuum\_vacuum\_cost\_limit](https://www.postgresql.org/docs/current/static/runtime-config-autovacuum.html#GUC-AUTOVACUUM-VACUUM-COST-LIMIT) -+ [autovacuum\_work\_mem](https://www.postgresql.org/docs/current/runtime-config-resource.html#GUC-AUTOVACUUM-WORK-MEM) -+ [autovacuum\_naptime](https://www.postgresql.org/docs/current/runtime-config-autovacuum.html#GUC-AUTOVACUUM-NAPTIME) - -RDS modifies these parameters only if the new value makes autovacuum more aggressive\. The parameters are modified in memory on the DB instance\. The values in the parameter group aren't changed\. To view the current in\-memory settings, use the PostgreSQL [SHOW](https://www.postgresql.org/docs/current/sql-show.html) SQL command\. - -When Amazon RDS modifies any of these autovacuum parameters, it generates an event for the affected DB instance\. This event is visible on the AWS Management Console and through the Amazon RDS API\. After the `MaximumUsedTransactionIDs` CloudWatch metric returns below the threshold, Amazon RDS resets the autovacuum\-related parameters in memory back to the values specified in the parameter group\. It then generates another event corresponding to this change\. - -## Determining if the tables in your database need vacuuming - -You can use the following query to show the number of unvacuumed transactions in a database\. The `datfrozenxid` column of a database's `pg_database` row is a lower bound on the normal transaction IDs appearing in that database\. This column is the minimum of the per\-table `relfrozenxid` values within the database\. - -``` -SELECT datname, age(datfrozenxid) FROM pg_database ORDER BY age(datfrozenxid) desc limit 20; -``` - -For example, the results of running the preceding query might be the following\. - -``` -datname | age -mydb | 1771757888 -template0 | 1721757888 -template1 | 1721757888 -rdsadmin | 1694008527 -postgres | 1693881061 -(5 rows) -``` - -When the age of a database reaches 2 billion transaction IDs, transaction ID \(XID\) wraparound occurs and the database becomes read\-only\. You can use this query to produce a metric and run a few times a day\. By default, autovacuum is set to keep the age of transactions to no more than 200,000,000 \([https://www.postgresql.org/docs/current/static/runtime-config-autovacuum.html#GUC-AUTOVACUUM-FREEZE-MAX-AGE](https://www.postgresql.org/docs/current/static/runtime-config-autovacuum.html#GUC-AUTOVACUUM-FREEZE-MAX-AGE)\)\. - -A sample monitoring strategy might look like this: -+ Set the `autovacuum_freeze_max_age` value to 200 million transactions\. -+ If a table reaches 500 million unvacuumed transactions, that triggers a low\-severity alarm\. This isn't an unreasonable value, but it can indicate that autovacuum isn't keeping up\. -+ If a table ages to 1 billion, this should be treated as an alarm to take action on\. In general, you want to keep ages closer to `autovacuum_freeze_max_age` for performance reasons\. We recommend that you investigate using the recommendations that follow\. -+ If a table reaches 1\.5 billion unvacuumed transactions, that triggers a high\-severity alarm\. Depending on how quickly your database uses transaction IDs, this alarm can indicate that the system is running out of time to run autovacuum\. In this case, we recommend that you resolve this immediately\. - -If a table is constantly breaching these thresholds, modify your autovacuum parameters further\. By default, using VACUUM manually \(which has cost\-based delays disabled\) is more aggressive than using the default autovacuum, but it is also more intrusive to the system as a whole\. - -We recommend the following: -+ Be aware and turn on a monitoring mechanism so that you are aware of the age of your oldest transactions\. - - For information on creating a process that warns you about transaction ID wraparound, see the AWS Database Blog post [Implement an early warning system for transaction ID wraparound in Amazon RDS for PostgreSQL](http://aws.amazon.com/blogs/database/implement-an-early-warning-system-for-transaction-id-wraparound-in-amazon-rds-for-postgresql/)\. -+ For busier tables, perform a manual vacuum freeze regularly during a maintenance window, in addition to relying on autovacuum\. For information on performing a manual vacuum freeze, see [ Performing a manual vacuum freeze](#Appendix.PostgreSQL.CommonDBATasks.Autovacuum.VacuumFreeze)\. - -## Determining which tables are currently eligible for autovacuum - -Often, it is one or two tables in need of vacuuming\. Tables whose `relfrozenxid` value is greater than the number of transactions in `autovacuum_freeze_max_age` are always targeted by autovacuum\. Otherwise, if the number of tuples made obsolete since the last VACUUM exceeds the vacuum threshold, the table is vacuumed\. - -The [autovacuum threshold](https://www.postgresql.org/docs/current/static/routine-vacuuming.html#AUTOVACUUM) is defined as: - -``` -Vacuum-threshold = vacuum-base-threshold + vacuum-scale-factor * number-of-tuples -``` - -While you are connected to your database, run the following query to see a list of tables that autovacuum sees as eligible for vacuuming\. - -``` -WITH vbt AS (SELECT setting AS autovacuum_vacuum_threshold FROM -pg_settings WHERE name = 'autovacuum_vacuum_threshold'), -vsf AS (SELECT setting AS autovacuum_vacuum_scale_factor FROM -pg_settings WHERE name = 'autovacuum_vacuum_scale_factor'), -fma AS (SELECT setting AS autovacuum_freeze_max_age FROM pg_settings WHERE name = 'autovacuum_freeze_max_age'), -sto AS (select opt_oid, split_part(setting, '=', 1) as param, -split_part(setting, '=', 2) as value from (select oid opt_oid, unnest(reloptions) setting from pg_class) opt) -SELECT '"'||ns.nspname||'"."'||c.relname||'"' as relation, -pg_size_pretty(pg_table_size(c.oid)) as table_size, -age(relfrozenxid) as xid_age, -coalesce(cfma.value::float, autovacuum_freeze_max_age::float) autovacuum_freeze_max_age, -(coalesce(cvbt.value::float, autovacuum_vacuum_threshold::float) + -coalesce(cvsf.value::float,autovacuum_vacuum_scale_factor::float) * c.reltuples) -AS autovacuum_vacuum_tuples, n_dead_tup as dead_tuples FROM -pg_class c join pg_namespace ns on ns.oid = c.relnamespace -join pg_stat_all_tables stat on stat.relid = c.oid join vbt on (1=1) join vsf on (1=1) join fma on (1=1) -left join sto cvbt on cvbt.param = 'autovacuum_vacuum_threshold' and c.oid = cvbt.opt_oid -left join sto cvsf on cvsf.param = 'autovacuum_vacuum_scale_factor' and c.oid = cvsf.opt_oid -left join sto cfma on cfma.param = 'autovacuum_freeze_max_age' and c.oid = cfma.opt_oid -WHERE c.relkind = 'r' and nspname <> 'pg_catalog' -AND (age(relfrozenxid) >= coalesce(cfma.value::float, autovacuum_freeze_max_age::float) -OR coalesce(cvbt.value::float, autovacuum_vacuum_threshold::float) + -coalesce(cvsf.value::float,autovacuum_vacuum_scale_factor::float) * -c.reltuples <= n_dead_tup) -ORDER BY age(relfrozenxid) DESC LIMIT 50; -``` - -## Determining if autovacuum is currently running and for how long - -If you need to manually vacuum a table, make sure to determine if autovacuum is currently running\. If it is, you might need to adjust parameters to make it run more efficiently, or turn off autovacuum temporarily so that you can manually run VACUUM\. - -Use the following query to determine if autovacuum is running, how long it has been running, and if it is waiting on another session\. - -``` -SELECT datname, usename, pid, state, wait_event, current_timestamp - xact_start AS xact_runtime, query -FROM pg_stat_activity -WHERE upper(query) LIKE '%VACUUM%' -ORDER BY xact_start; -``` - -After running the query, you should see output similar to the following\. - -``` - datname | usename | pid | state | wait_event | xact_runtime | query - --------+----------+-------+--------+------------+-------------------------+-------------------------------------------------------------------------------------------------------- - mydb | rdsadmin | 16473 | active | | 33 days 16:32:11.600656 | autovacuum: VACUUM ANALYZE public.mytable1 (to prevent wraparound) - mydb | rdsadmin | 22553 | active | | 14 days 09:15:34.073141 | autovacuum: VACUUM ANALYZE public.mytable2 (to prevent wraparound) - mydb | rdsadmin | 41909 | active | | 3 days 02:43:54.203349 | autovacuum: VACUUM ANALYZE public.mytable3 - mydb | rdsadmin | 618 | active | | 00:00:00 | SELECT datname, usename, pid, state, wait_event, current_timestamp - xact_start AS xact_runtime, query+ - | | | | | | FROM pg_stat_activity + - | | | | | | WHERE query like '%VACUUM%' + - | | | | | | ORDER BY xact_start; + -``` - -Several issues can cause a long\-running autovacuum session \(that is, multiple days long\)\. The most common issue is that your [https://www.postgresql.org/docs/current/static/runtime-config-resource.html#GUC-MAINTENANCE-WORK-MEM](https://www.postgresql.org/docs/current/static/runtime-config-resource.html#GUC-MAINTENANCE-WORK-MEM) parameter value is set too low for the size of the table or rate of updates\. - -We recommend that you use the following formula to set the `maintenance_work_mem` parameter value\. - -``` -GREATEST({DBInstanceClassMemory/63963136*1024},65536) -``` - -Short running autovacuum sessions can also indicate problems: -+ It can indicate that there aren't enough `autovacuum_max_workers` for your workload\. In this case, you need to indicate the number of workers\. -+ It can indicate that there is an index corruption \(autovacuum crashes and restarts on the same relation but makes no progress\)\. In this case, run a manual `vacuum freeze verbose table` to see the exact cause\. - -## Performing a manual vacuum freeze - -You might want to perform a manual vacuum on a table that has a vacuum process already running\. This is useful if you have identified a table with an age approaching 2 billion transactions \(or above any threshold you are monitoring\)\. - -The following steps are guidelines, with several variations to the process\. For example, during testing, suppose that you find that the [https://www.postgresql.org/docs/current/static/runtime-config-resource.html#GUC-MAINTENANCE-WORK-MEM](https://www.postgresql.org/docs/current/static/runtime-config-resource.html#GUC-MAINTENANCE-WORK-MEM) parameter value is set too small and that you need to take immediate action on a table\. However, perhaps you don't want to bounce the instance at the moment\. Using the queries in previous sections, you determine which table is the problem and notice a long running autovacuum session\. You know that you need to change the `maintenance_work_mem` parameter setting, but you also need to take immediate action and vacuum the table in question\. The following procedure shows what to do in this situation\. - -**To manually perform a vacuum freeze** - -1. Open two sessions to the database containing the table you want to vacuum\. For the second session, use "screen" or another utility that maintains the session if your connection is dropped\. - -1. In session one, get the process ID \(PID\) of the autovacuum session running on the table\. - - Run the following query to get the PID of the autovacuum session\. - - ``` - SELECT datname, usename, pid, current_timestamp - xact_start - AS xact_runtime, query - FROM pg_stat_activity WHERE upper(query) LIKE '%VACUUM%' ORDER BY - xact_start; - ``` - -1. In session two, calculate the amount of memory that you need for this operation\. In this example, we determine that we can afford to use up to 2 GB of memory for this operation, so we set [https://www.postgresql.org/docs/current/static/runtime-config-resource.html#GUC-MAINTENANCE-WORK-MEM](https://www.postgresql.org/docs/current/static/runtime-config-resource.html#GUC-MAINTENANCE-WORK-MEM) for the current session to 2 GB\. - - ``` - SET maintenance_work_mem='2 GB'; - SET - ``` - -1. In session two, issue a `vacuum freeze verbose` command for the table\. The verbose setting is useful because, although there is no progress report for this in PostgreSQL currently, you can see activity\. - - ``` - \timing on - Timing is on. - vacuum freeze verbose pgbench_branches; - ``` - - ``` - INFO: vacuuming "public.pgbench_branches" - INFO: index "pgbench_branches_pkey" now contains 50 row versions in 2 pages - DETAIL: 0 index row versions were removed. - 0 index pages have been deleted, 0 are currently reusable. - CPU 0.00s/0.00u sec elapsed 0.00 sec. - INFO: index "pgbench_branches_test_index" now contains 50 row versions in 2 pages - DETAIL: 0 index row versions were removed. - 0 index pages have been deleted, 0 are currently reusable. - CPU 0.00s/0.00u sec elapsed 0.00 sec. - INFO: "pgbench_branches": found 0 removable, 50 nonremovable row versions - in 43 out of 43 pages - DETAIL: 0 dead row versions cannot be removed yet. - There were 9347 unused item pointers. - 0 pages are entirely empty. - CPU 0.00s/0.00u sec elapsed 0.00 sec. - VACUUM - Time: 2.765 ms - ``` - -1. In session one, if autovacuum was blocking the vacuum session, you see in `pg_stat_activity` that waiting is "T" for your vacuum session\. In this case, you need to end the autovacuum process as follows\. - - ``` - SELECT pg_terminate_backend('the_pid'); - ``` - - At this point, your session begins\. It's important to note that autovacuum restarts immediately because this table is probably the highest on its list of work\. - -1. Initiate your `vacuum freeze verbose` command in session two, and then end the autovacuum process in session one\. - -## Reindexing a table when autovacuum is running - -If an index has become corrupt, autovacuum continues to process the table and fails\. If you attempt a manual vacuum in this situation, you receive an error message like the following\. - -``` -postgres=> vacuum freeze pgbench_branches; -ERROR: index "pgbench_branches_test_index" contains unexpected - zero page at block 30521 -HINT: Please REINDEX it. -``` - -When the index is corrupted and autovacuum is attempting to run on the table, you contend with an already running autovacuum session\. When you issue a [REINDEX](https://www.postgresql.org/docs/current/static/sql-reindex.html) command, you take out an exclusive lock on the table\. Write operations are blocked, and also read operations that use that specific index\. - -**To reindex a table when autovacuum is running on the table** - -1. Open two sessions to the database containing the table that you want to vacuum\. For the second session, use "screen" or another utility that maintains the session if your connection is dropped\. - -1. In session one, get the PID of the autovacuum session running on the table\. - - Run the following query to get the PID of the autovacuum session\. - - ``` - SELECT datname, usename, pid, current_timestamp - xact_start - AS xact_runtime, query - FROM pg_stat_activity WHERE upper(query) like '%VACUUM%' ORDER BY - xact_start; - ``` - -1. In session two, issue the reindex command\. - - ``` - \timing on - Timing is on. - reindex index pgbench_branches_test_index; - REINDEX - Time: 9.966 ms - ``` - -1. In session one, if autovacuum was blocking the process, you see in `pg_stat_activity` that waiting is "T" for your vacuum session\. In this case, you end the autovacuum process\. - - ``` - SELECT pg_terminate_backend('the_pid'); - ``` - - At this point, your session begins\. It's important to note that autovacuum restarts immediately because this table is probably the highest on its list of work\. - -1. Initiate your command in session two, and then end the autovacuum process in session 1\. - -## Managing autovacuum with large indexes - -As part of its operation, *autovacuum* performs several [ vacuum phases](https://www.postgresql.org/docs/current/progress-reporting.html#VACUUM-PHASES) while running on a table\. Before the table is cleaned up, all of its indexes are first vacuumed\. When removing multiple large indexes, this phase consumes a significant amount of time and resources\. Therefore, as a best practice, be sure to control the number of indexes on a table and eliminate unused indexes\. - -For this process, first check the overall index size\. Then, determine if there are potentially unused indexes that can be removed as shown in the following examples\. - -**To check the size of the table and its indexes** - -``` -postgres=> select pg_size_pretty(pg_relation_size('pgbench_accounts')); -pg_size_pretty -6404 MB -(1 row) -``` - -``` -postgres=> select pg_size_pretty(pg_indexes_size('pgbench_accounts')); -pg_size_pretty -11 GB -(1 row) -``` - -In this example, the size of indexes is larger than the table\. This difference can cause performance issues as the indexes are bloated or unused, which impacts the autovacuum as well as insert operations\. - -**To check for unused indexes** - -Using the [https://www.postgresql.org/docs/current/monitoring-stats.html#MONITORING-PG-STAT-ALL-INDEXES-VIEW](https://www.postgresql.org/docs/current/monitoring-stats.html#MONITORING-PG-STAT-ALL-INDEXES-VIEW) view, you can check how frequently an index is used with the `idx_scan` column\. In the following example, the unused indexes have the `idx_scan` value of `0`\. - -``` -postgres=> select * from pg_stat_user_indexes where relname = 'pgbench_accounts' order by idx_scan desc; - -relid | indexrelid | schemaname | relname | indexrelname | idx_scan | idx_tup_read | idx_tup_fetch --------+------------+------------+------------------+-----------------------+----------+--------------+--------------- -16433 | 16454 | public | pgbench_accounts | index_f | 6 | 6 | 0 -16433 | 16450 | public | pgbench_accounts | index_b | 3 | 199999 | 0 -16433 | 16447 | public | pgbench_accounts | pgbench_accounts_pkey | 0 | 0 | 0 -16433 | 16452 | public | pgbench_accounts | index_d | 0 | 0 | 0 -16433 | 16453 | public | pgbench_accounts | index_e | 0 | 0 | 0 -16433 | 16451 | public | pgbench_accounts | index_c | 0 | 0 | 0 -16433 | 16449 | public | pgbench_accounts | index_a | 0 | 0 | 0 -(7 rows) -``` - -``` -postgres=> select schemaname, relname, indexrelname, idx_scan from pg_stat_user_indexes where relname = 'pgbench_accounts' order by idx_scan desc; - -schemaname | relname | indexrelname | idx_scan -------------+------------------+-----------------------+---------- -public | pgbench_accounts | index_f | 6 -public | pgbench_accounts | index_b | 3 -public | pgbench_accounts | pgbench_accounts_pkey | 0 -public | pgbench_accounts | index_d | 0 -public | pgbench_accounts | index_e | 0 -public | pgbench_accounts | index_c | 0 -public | pgbench_accounts | index_a | 0 -(7 rows) -``` - -**Note** -These statistics are incremental from the time that the statistics are reset\. Suppose you have an index that is only used at the end of a business quarter or just for a specific report\. It's possible that this index hasn't been used since the statistics were reset\. For more information, see [Statistics Functions](https://www.postgresql.org/docs/current/monitoring-stats.html#MONITORING-STATS-FUNCTIONS)\. Indexes that are used to enforce uniqueness won't have scans performed and shouldn't be identified as unused indexes\. To identify the unused indexes, you should have in\-depth knowledge of the application and its queries\. - -To check when the stats were last reset for a database, use [ https://www.postgresql.org/docs/current/monitoring-stats.html#MONITORING-PG-STAT-DATABASE-VIEW]( https://www.postgresql.org/docs/current/monitoring-stats.html#MONITORING-PG-STAT-DATABASE-VIEW) - -``` -postgres=> select datname, stats_reset from pg_stat_database where datname = 'postgres'; - -datname | stats_reset -----------+------------------------------- -postgres | 2022-11-17 08:58:11.427224+00 -(1 row) -``` - -### Vacuuming a table as quickly as possible - -**RDS for PostgreSQL 12 and higher** - -If you have too many indexes in a large table, your DB instance could be nearing transaction ID wraparound \(XID\), which is when the XID counter wraps around to zero\. Left unchecked, this situation could result in data loss\. However, you can quickly vacuum the table without cleaning up the indexes\. In RDS for PostgreSQL 12 and higher, you can use VACUUM with the [https://www.postgresql.org/docs/current/sql-vacuum.html](https://www.postgresql.org/docs/current/sql-vacuum.html) clause\. - -``` -postgres=> VACUUM (INDEX_CLEANUP FALSE, VERBOSE TRUE) pgbench_accounts; - -INFO: vacuuming "public.pgbench_accounts" -INFO: table "pgbench_accounts": found 0 removable, 8 nonremovable row versions in 1 out of 819673 pages -DETAIL: 0 dead row versions cannot be removed yet, oldest xmin: 7517 -Skipped 0 pages due to buffer pins, 0 frozen pages. -CPU: user: 0.01 s, system: 0.00 s, elapsed: 0.01 s. -``` - -If an autovacuum session is already running, you must terminate it to begin the manual VACUUM\. For information on performing a manual vacuum freeze, see [ Performing a manual vacuum freeze](#Appendix.PostgreSQL.CommonDBATasks.Autovacuum.VacuumFreeze) - -**Note** -Skipping index cleanup regularly might cause index bloat, which impacts the overall scan performance\. As a best practice, use the preceding procedure only to prevent transaction ID wraparound\. - -**RDS for PostgreSQL 11 and older** - -However, in RDS for PostgreSQL 11 and lower versions, the only way to allow vacuum to complete faster is to reduce the number of indexes on a table\. Dropping an index can affect query plans\. We recommend that you drop unused indexes first, then drop the indexes when XID wraparound is very near\. After the vacuum process completes, you can recreate these indexes\. - -## Other parameters that affect autovacuum - -The following query shows the values of some of the parameters that directly affect autovacuum and its behavior\. The [autovacuum parameters](https://www.postgresql.org/docs/current/static/runtime-config-autovacuum.html) are described fully in the PostgreSQL documentation\. - -``` -SELECT name, setting, unit, short_desc -FROM pg_settings -WHERE name IN ( -'autovacuum_max_workers', -'autovacuum_analyze_scale_factor', -'autovacuum_naptime', -'autovacuum_analyze_threshold', -'autovacuum_analyze_scale_factor', -'autovacuum_vacuum_threshold', -'autovacuum_vacuum_scale_factor', -'autovacuum_vacuum_threshold', -'autovacuum_vacuum_cost_delay', -'autovacuum_vacuum_cost_limit', -'vacuum_cost_limit', -'autovacuum_freeze_max_age', -'maintenance_work_mem', -'vacuum_freeze_min_age'); -``` - -While these all affect autovacuum, some of the most important ones are: -+ [maintenance\_work\_mem](https://www.postgresql.org/docs/current/static/runtime-config-resource.html#GUC-MAINTENANCE_WORK_MEM) -+ [autovacuum\_freeze\_max\_age](https://www.postgresql.org/docs/current/static/runtime-config-autovacuum.html#GUC-AUTOVACUUM-FREEZE-MAX-AGE) -+ [autovacuum\_max\_workers](https://www.postgresql.org/docs/current/static/runtime-config-autovacuum.html#GUC-AUTOVACUUM-MAX-WORKERS) -+ [autovacuum\_vacuum\_cost\_delay](https://www.postgresql.org/docs/current/static/runtime-config-autovacuum.html#GUC-AUTOVACUUM-VACUUM-COST-DELAY) -+ [ autovacuum\_vacuum\_cost\_limit](https://www.postgresql.org/docs/current/static/runtime-config-autovacuum.html#GUC-AUTOVACUUM-VACUUM-COST-LIMIT) - -## Setting table\-level autovacuum parameters - -You can set autovacuum\-related [storage parameters](https://www.postgresql.org/docs/current/static/sql-createtable.html#SQL-CREATETABLE-STORAGE-PARAMETERS) at a table level, which can be better than altering the behavior of the entire database\. For large tables, you might need to set aggressive settings and you might not want to make autovacuum behave that way for all tables\. - -The following query shows which tables currently have table\-level options in place\. - -``` -SELECT relname, reloptions -FROM pg_class -WHERE reloptions IS NOT null; -``` - -An example where this might be useful is on tables that are much larger than the rest of your tables\. Suppose that you have one 300\-GB table and 30 other tables less than 1 GB\. In this case, you might set some specific parameters for your large table so you don't alter the behavior of your entire system\. - -``` -ALTER TABLE mytable set (autovacuum_vacuum_cost_delay=0); -``` - -Doing this turns off the cost\-based autovacuum delay for this table at the expense of more resource usage on your system\. Normally, autovacuum pauses for `autovacuum_vacuum_cost_delay` each time `autovacuum_cost_limit` is reached\. For more details, see the PostgreSQL documentation about [cost\-based vacuuming](https://www.postgresql.org/docs/current/static/runtime-config-resource.html#RUNTIME-CONFIG-RESOURCE-VACUUM-COST)\. - -## Logging autovacuum and vacuum activities - -Information about autovacuum activities is sent to the `postgresql.log` based on the level specified in the `rds.force_autovacuum_logging_level` parameter\. Following are the values allowed for this parameter and the PostgreSQL versions for which that value is the default setting: -+ `disabled` \(PostgreSQL 10, PostgreSQL 9\.6\) -+ `debug5`, `debug4`, `debug3`, `debug2`, `debug1` -+ `info` \(PostgreSQL 12, PostgreSQL 11\) -+ `notice` -+ `warning` \(PostgreSQL 13 and above\) -+ `error`, log, `fatal`, `panic` - -The `rds.force_autovacuum_logging_level` works with the `log_autovacuum_min_duration` parameter\. The `log_autovacuum_min_duration` parameter's value is the threshold \(in milliseconds\) above which autovacuum actions get logged\. A setting of `-1` logs nothing, while a setting of 0 logs all actions\. As with `rds.force_autovacuum_logging_level`, default values for `log_autovacuum_min_duration` are version dependent, as follows: -+ `10000 ms` – PostgreSQL 14, PostgreSQL 13, PostgreSQL 12, and PostgreSQL 11 -+ `(empty)` – No default value for PostgreSQL 10 and PostgreSQL 9\.6 - -We recommend that you set `rds.force_autovacuum_logging_level` to `WARNING`\. We also recommend that you set `log_autovacuum_min_duration` to a value from 1000 to 5000\. A setting of 5000 logs activity that takes longer than 5,000 milliseconds\. Any setting other than \-1 also logs messages if the autovacuum action is skipped because of a conflicting lock or concurrently dropped relations\. For more information, see [Automatic Vacuuming](https://www.postgresql.org/docs/current/runtime-config-autovacuum.html) in the PostgreSQL documentation\. - -To troubleshoot issues, you can change the `rds.force_autovacuum_logging_level` parameter to one of the debug levels, from `debug1` up to `debug5` for the most verbose information\. We recommend that you use debug settings for short periods of time and for troubleshooting purposes only\. To learn more, see [When to log](https://www.postgresql.org/docs/current/static/runtime-config-logging.html#RUNTIME-CONFIG-LOGGING-WHEN) in the PostgreSQL documentation\. - -**Note** -PostgreSQL allows the `rds_superuser` account to view autovacuum sessions in `pg_stat_activity`\. For example, you can identify and end an autovacuum session that is blocking a command from running, or running slower than a manually issued vacuum command\. \ No newline at end of file diff --git a/doc_source/Appendix.PostgreSQL.CommonDBATasks.CustomDNS.md b/doc_source/Appendix.PostgreSQL.CommonDBATasks.CustomDNS.md deleted file mode 100644 index 30f22af..0000000 --- a/doc_source/Appendix.PostgreSQL.CommonDBATasks.CustomDNS.md +++ /dev/null @@ -1,47 +0,0 @@ -# Using a custom DNS server for outbound network access - -RDS for PostgreSQL supports outbound network access on your DB instances and allows Domain Name Service \(DNS\) resolution from a custom DNS server owned by the customer\. You can resolve only fully qualified domain names from your RDS for PostgreSQL DB instance through your custom DNS server\. - -**Topics** -+ [Turning on custom DNS resolution](#Appendix.PostgreSQL.CommonDBATasks.CustomDNS.Enable) -+ [Turning off custom DNS resolution](#Appendix.PostgreSQL.CommonDBATasks.CustomDNS.Disable) -+ [Setting up a custom DNS server](#Appendix.Oracle.CommonDBATasks.CustomDNS.Setup) - -## Turning on custom DNS resolution - -To turn on DNS resolution in your customer VPC, first associate a custom DB parameter group to your RDS for PostgreSQL instance\. Then turn on the `rds.custom_dns_resolution` parameter by setting it to 1, and then restart the DB instance for the changes to take place\. - -## Turning off custom DNS resolution - -To turn off DNS resolution in your customer VPC, first turn off the `rds.custom_dns_resolution` parameter of your custom DB parameter group by setting it to 0\. Then restart the DB instance for the changes to take place\. - -## Setting up a custom DNS server - -After you set up your custom DNS name server, it takes up to 30 minutes to propagate the changes to your DB instance\. After the changes are propagated to your DB instance, all outbound network traffic requiring a DNS lookup queries your DNS server over port 53\. - -**Note** -If you don't set up a custom DNS server and `rds.custom_dns_resolution` is set to 1, hosts are resolved using an Amazon Route 53 private zone\. For more information, see [Working with private hosted zones](https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/hosted-zones-private.html)\. - -**To set up a custom DNS server for your RDS for PostgreSQL DB instance** - -1. From the Dynamic Host Configuration Protocol \(DHCP\) options set attached to your VPC, set the `domain-name-servers` option to the IP address of your DNS name server\. For more information, see [DHCP options sets](https://docs.aws.amazon.com/vpc/latest/userguide/VPC_DHCP_Options.html)\. -**Note** -The `domain-name-servers` option accepts up to four values, but your Amazon RDS DB instance uses only the first value\. - -1. Ensure that your DNS server can resolve all lookup queries, including public DNS names, Amazon EC2 private DNS names, and customer\-specific DNS names\. If the outbound network traffic contains any DNS lookups that your DNS server can't handle, your DNS server must have appropriate upstream DNS providers configured\. - -1. Configure your DNS server to produce User Datagram Protocol \(UDP\) responses of 512 bytes or less\. - -1. Configure your DNS server to produce Transmission Control Protocol \(TCP\) responses of 1,024 bytes or less\. - -1. Configure your DNS server to allow inbound traffic from your Amazon RDS DB instances over port 53\. If your DNS server is in an Amazon VPC, the VPC must have a security group that contains inbound rules that allow UDP and TCP traffic on port 53\. If your DNS server is not in an Amazon VPC, it must have appropriate firewall settings to allow UDP and TCP inbound traffic on port 53\. - - For more information, see [Security groups for your VPC](https://docs.aws.amazon.com/vpc/latest/userguide/VPC_SecurityGroups.html) and [Adding and removing rules](https://docs.aws.amazon.com/vpc/latest/userguide/VPC_SecurityGroups.html#AddRemoveRules)\. - -1. Configure the VPC of your Amazon RDS DB instance to allow outbound traffic over port 53\. Your VPC must have a security group that contains outbound rules that allow UDP and TCP traffic on port 53\. - - For more information, see [Security groups for your VPC](https://docs.aws.amazon.com/vpc/latest/userguide/VPC_SecurityGroups.html) and [Adding and removing rules](https://docs.aws.amazon.com/vpc/latest/userguide/VPC_SecurityGroups.html#AddRemoveRules) in the *Amazon VPC User Guide*\. - -1. Make sure that the routing path between the Amazon RDS DB instance and the DNS server is configured correctly to allow DNS traffic\. - - Also, if the Amazon RDS DB instance and the DNS server are not in the same VPC, make sure that a peering connection is set up between them\. For more information, see [What is VPC peering?](https://docs.aws.amazon.com/vpc/latest/peering/Welcome.html) in *Amazon VPC Peering Guide*\. \ No newline at end of file diff --git a/doc_source/Appendix.PostgreSQL.CommonDBATasks.Extensions.foreign-data-wrappers.md b/doc_source/Appendix.PostgreSQL.CommonDBATasks.Extensions.foreign-data-wrappers.md deleted file mode 100644 index f69003f..0000000 --- a/doc_source/Appendix.PostgreSQL.CommonDBATasks.Extensions.foreign-data-wrappers.md +++ /dev/null @@ -1,505 +0,0 @@ -# Working with the supported foreign data wrappers for Amazon RDS for PostgreSQL - -A foreign data wrapper \(FDW\) is a specific type of extension that provides access to external data\. For example, the `oracle_fdw` extension allows your RDS for PostgreSQL DB cluster to work with Oracle databases\. As another example, by using the PostgreSQL native `postgres_fdw` extension you can access data stored in PostgreSQL DB instances external to your RDS for PostgreSQL DB instance\. - -Following, you can find information about several supported PostgreSQL foreign data wrappers\. - -**Topics** -+ [Using the log\_fdw extension to access the DB log using SQL](#CHAP_PostgreSQL.Extensions.log_fdw) -+ [Using the postgres\_fdw extension to access external data](#postgresql-commondbatasks-fdw) -+ [Working with MySQL databases by using the mysql\_fdw extension](#postgresql-mysql-fdw) -+ [Working with Oracle databases by using the oracle\_fdw extension](#postgresql-oracle-fdw) -+ [Working with SQL Server databases by using the tds\_fdw extension](#postgresql-tds-fdw) - -## Using the log\_fdw extension to access the DB log using SQL - -RDS for PostgreSQL supports the `log_fdw` extension, which you can use to access your database engine log using a SQL interface\. The `log_fdw` extension provides two functions that make it easy to create foreign tables for database logs: -+ `list_postgres_log_files` – Lists the files in the database log directory and the file size in bytes\. -+ `create_foreign_table_for_log_file(table_name text, server_name text, log_file_name text)` – Builds a foreign table for the specified file in the current database\. - -All functions created by `log_fdw` are owned by `rds_superuser`\. Members of the `rds_superuser` role can grant access to these functions to other database users\. - -By default, the log files are generated by Amazon RDS in `stderr` \(standard error\) format, as specified in `log_destination` parameter\. There are only two options for this parameter, `stderr` and `csvlog` \(comma\-separated values, CSV\)\. If you add the `csvlog` option to the parameter, Amazon RDS generates both `stderr` and `csvlog` logs\. This can affect the storage capacity on your instance, so you need to be aware of the other parameters that affect log handling\. For more information, see [Setting the log destination \(`stderr`, `csvlog`\)](USER_LogAccess.Concepts.PostgreSQL.md#USER_LogAccess.Concepts.PostgreSQL.Log_Format)\. - -One benefit of generating `csvlog` logs is that the `log_fdw` extension lets you build foreign tables with the data neatly split into several columns\. To do this, your instance needs to be associated with a custom DB parameter group so that you can change the setting for `log_destination`\. For more information about how to do so, see [Working with parameters on your RDS for PostgreSQL DB instance](Appendix.PostgreSQL.CommonDBATasks.Parameters.md)\. - -The following example assumes that the `log_destination` parameter includes `cvslog`\. - -**To use the log\_fdw extension** - -1. Get the `log_fdw` extension\. - - ``` - postgres=> CREATE EXTENSION log_fdw; - CREATE EXTENSION - ``` - -1. Create the log server as a foreign data wrapper\. - - ``` - postgres=> CREATE SERVER log_server FOREIGN DATA WRAPPER log_fdw; - CREATE SERVER - ``` - -1. Select all from a list of log files\. - - ``` - postgres=> SELECT * FROM list_postgres_log_files() ORDER BY 1; - ``` - - A sample response is as follows\. - - ``` - file_name | file_size_bytes - ------------------------------+----------------- - postgresql.log.2016-08-09-22.csv | 1111 - postgresql.log.2016-08-09-23.csv | 1172 - postgresql.log.2016-08-10-00.csv | 1744 - postgresql.log.2016-08-10-01.csv | 1102 - (4 rows) - ``` - -1. Create a table with a single 'log\_entry' column for the selected file\. - - ``` - postgres=> SELECT create_foreign_table_for_log_file('my_postgres_error_log', - 'log_server', 'postgresql.log.2016-08-09-22.csv'); - ``` - - The response provides no detail other than that the table now exists\. - - ``` - ----------------------------------- - (1 row) - ``` - -1. Select a sample of the log file\. The following code retrieves the log time and error message description\. - - ``` - postgres=> SELECT log_time, message FROM my_postgres_error_log ORDER BY 1; - ``` - - A sample response is as follows\. - - ``` - log_time | message - ----------------------------------+--------------------------------------------------------------------------- - Tue Aug 09 15:45:18.172 2016 PDT | ending log output to stderr - Tue Aug 09 15:45:18.175 2016 PDT | database system was interrupted; last known up at 2016-08-09 22:43:34 UTC - Tue Aug 09 15:45:18.223 2016 PDT | checkpoint record is at 0/90002E0 - Tue Aug 09 15:45:18.223 2016 PDT | redo record is at 0/90002A8; shutdown FALSE - Tue Aug 09 15:45:18.223 2016 PDT | next transaction ID: 0/1879; next OID: 24578 - Tue Aug 09 15:45:18.223 2016 PDT | next MultiXactId: 1; next MultiXactOffset: 0 - Tue Aug 09 15:45:18.223 2016 PDT | oldest unfrozen transaction ID: 1822, in database 1 - (7 rows) - ``` - -## Using the postgres\_fdw extension to access external data - -You can access data in a table on a remote database server with the [postgres\_fdw](https://www.postgresql.org/docs/current/static/postgres-fdw.html) extension\. If you set up a remote connection from your PostgreSQL DB instance, access is also available to your read replica\. - -**To use postgres\_fdw to access a remote database server** - -1. Install the postgres\_fdw extension\. - - ``` - CREATE EXTENSION postgres_fdw; - ``` - -1. Create a foreign data server using CREATE SERVER\. - - ``` - CREATE SERVER foreign_server - FOREIGN DATA WRAPPER postgres_fdw - OPTIONS (host 'xxx.xx.xxx.xx', port '5432', dbname 'foreign_db'); - ``` - -1. Create a user mapping to identify the role to be used on the remote server\. - - ``` - CREATE USER MAPPING FOR local_user - SERVER foreign_server - OPTIONS (user 'foreign_user', password 'password'); - ``` - -1. Create a table that maps to the table on the remote server\. - - ``` - CREATE FOREIGN TABLE foreign_table ( - id integer NOT NULL, - data text) - SERVER foreign_server - OPTIONS (schema_name 'some_schema', table_name 'some_table'); - ``` - -## Working with MySQL databases by using the mysql\_fdw extension - -To access a MySQL\-compatible database from your RDS for PostgreSQL DB instance, you can install and use the `mysql_fdw` extension\. This foreign data wrapper lets you work with RDS for MySQL, Aurora MySQL, MariaDB, and other MySQL\-compatible databases\. The connection from RDS for PostgreSQL to the MySQL database is encrypted on a best\-effort basis, depending on the client and server configurations\. However, you can enforce encryption if you like\. For more information, see [Using encryption in transit with the extension](#postgresql-mysql-fdw.encryption-in-transit)\. - -The `mysql_fdw` extension is supported on Amazon RDS for PostgreSQL version 14\.2, 13\.6, and higher releases\. It supports selects, inserts, updates, and deletes from an RDS for PostgreSQL DB to tables on a MySQL\-compatible database instance\. - -**Topics** -+ [Setting up your RDS for PostgreSQL DB to use the mysql\_fdw extension](#postgresql-mysql-fdw.setting-up) -+ [Example: Working with an RDS for MySQL database from RDS for PostgreSQL](#postgresql-mysql-fdw.using-mysql_fdw) -+ [Using encryption in transit with the extension](#postgresql-mysql-fdw.encryption-in-transit) - -### Setting up your RDS for PostgreSQL DB to use the mysql\_fdw extension - -Setting up the `mysql_fdw` extension on your RDS for PostgreSQL DB instance involves loading the extension in your DB instance and then creating the connection point to the MySQL DB instance\. For that task, you need to have the following details about the MySQL DB instance: -+ Hostname or endpoint\. For an RDS for MySQL DB instance, you can find the endpoint by using the Console\. Choose the Connectivity & security tab and look in the "Endpoint and port" section\. -+ Port number\. The default port number for MySQL is 3306\. -+ Name of the database\. The DB identifier\. - -You also need to provide access on the security group or the access control list \(ACL\) for the MySQL port, 3306\. Both the RDS for PostgreSQL DB instance and the RDS for MySQL DB instance need access to port 3306\. If access isn't configured correctly, when you try to connect to MySQL\-compatible table you see an error message similar to the following: - -``` -ERROR: failed to connect to MySQL: Can't connect to MySQL server on 'hostname.aws-region.rds.amazonaws.com:3306' (110) -``` - -In the following procedure, you \(as the `rds_superuser` account\) create the foreign server\. You then grant access to the foreign server to specific users\. These users then create their own mappings to the appropriate MySQL user accounts to work with the MySQL DB instance\. - -**To use mysql\_fdw to access a MySQL database server** - -1. Connect to your PostgreSQL DB instance using an account that has the `rds_superuser` role\. If you accepted the defaults when you created your RDS for PostgreSQL DB instance, the user name is `postgres`, and you can connect using the `psql` command line tool as follows: - - ``` - psql --host=your-DB-instance.aws-region.rds.amazonaws.com --port=5432 --username=postgres –-password - ``` - -1. Install the `mysql_fdw` extension as follows: - - ``` - postgres=> CREATE EXTENSION mysql_fdw; - CREATE EXTENSION - ``` - -After the extension is installed on your RDS for PostgreSQL DB instance, you set up the foreign server that provides the connection to a MySQL database\. - -**To create the foreign server** - -Perform these tasks on the RDS for PostgreSQL DB instance\. The steps assume that you're connected as a user with `rds_superuser` privileges, such as `postgres`\. - -1. Create a foreign server in the RDS for PostgreSQL DB instance: - - ``` - postgres=> CREATE SERVER mysql-db FOREIGN DATA WRAPPER mysql_fdw OPTIONS (host 'db-name.111122223333.aws-region.rds.amazonaws.com', port '3306'); - CREATE SERVER - ``` - -1. Grant the appropriate users access to the foreign server\. These should be non\-administrator users, that is, users without the `rds_superuser` role\. - - ``` - postgres=> GRANT USAGE ON FOREIGN SERVER mysql-db to user1; - GRANT - ``` - -PostgreSQL users create and manage their own connections to the MySQL database through the foreign server\. - -### Example: Working with an RDS for MySQL database from RDS for PostgreSQL - -Suppose that you have a simple table on an RDS for MySQL DB instance\. Your RDS for PostgreSQL users want to query \(`SELECT`\), `INSERT`, `UPDATE`, and `DELETE` items on that table\. Assume that the `mysql_fdw` extension was created on your RDS for PostgreSQL DB instance, as detailed in the preceding procedure\. After you connect to the RDS for PostgreSQL DB instance as a user that has `rds_superuser` privileges, you can proceed with the following steps\. - -1. On the RDS for PostgreSQL DB instance, create a foreign server: - - ``` - test=> CREATE SERVER mysqldb FOREIGN DATA WRAPPER mysql_fdw OPTIONS (host 'your-DB.aws-region.rds.amazonaws.com', port '3306'); - CREATE SERVER - ``` - -1. Grant usage to a user who doesn't have `rds_superuser` permissions, for example, `user1`: - - ``` - test=> GRANT USAGE ON FOREIGN SERVER mysqldb TO user1; - GRANT - ``` - -1. Connect as *user1*, and then create a mapping to the MySQL user: - - ``` - test=> CREATE USER MAPPING FOR user1 SERVER mysqldb OPTIONS (username 'myuser', password 'mypassword'); - CREATE USER MAPPING - ``` - -1. Create a foreign table linked to the MySQL table: - - ``` - test=> CREATE FOREIGN TABLE mytab (a int, b text) SERVER mysqldb OPTIONS (dbname 'test', table_name ''); - CREATE FOREIGN TABLE - ``` - -1. Run a simple query against the foreign table: - - ``` - test=> SELECT * FROM mytab; - a | b - ---+------- - 1 | apple - (1 row) - ``` - -1. You can add, change, and remove data from the MySQL table\. For example: - - ``` - test=> INSERT INTO mytab values (2, 'mango'); - INSERT 0 1 - ``` - - Run the `SELECT` query again to see the results: - - ``` - test=> SELECT * FROM mytab ORDER BY 1; - a | b - ---+------- - 1 | apple - 2 | mango - (2 rows) - ``` - -### Using encryption in transit with the extension - -The connection to MySQL from RDS for PostgreSQL uses encryption in transit \(TLS/SSL\) by default\. However, the connection falls back to non\-encrypted when the client and server configuration differ\. You can enforce encryption for all outgoing connections by specifying the `REQUIRE SSL` option on the RDS for MySQL user accounts\. This same approach also works for MariaDB and Aurora MySQL user accounts\. - -For MySQL user accounts configured to `REQUIRE SSL`, the connection attempt fails if a secure connection can't be established\. - -To enforce encryption for existing MySQL database user accounts, you can use the `ALTER USER` command\. The syntax varies, depending on the MySQL version, as shown in the following table\. For more information, see [ALTER USER](https://dev.mysql.com/doc/refman/8.0/en/alter-user.html) in *MySQL Reference Manual*\. - - -| MySQL 5\.7, MySQL 8\.0 | MySQL 5\.6 | -| --- | --- | -| `ALTER USER 'user'@'%' REQUIRE SSL;` | `GRANT USAGE ON *.* to 'user'@'%' REQUIRE SSL;` | - -For more information about the `mysql_fdw` extension, see the [mysql\_fdw](https://github.com/EnterpriseDB/mysql_fdw) documentation\. - -## Working with Oracle databases by using the oracle\_fdw extension - -To access an Oracle database from your RDS for PostgreSQL DB instance you can install and use the `oracle_fdw` extension\. This extension is a foreign data wrapper for Oracle databases\. To learn more about this extension, see the [oracle\_fdw](https://github.com/laurenz/oracle_fdw) documentation\. - -The `oracle_fdw` extension is supported on RDS for PostgreSQL 12\.7, 13\.3, and higher versions\. - -**Topics** -+ [Turning on the oracle\_fdw extension](#postgresql-oracle-fdw.enabling) -+ [Example: Using a foreign server linked to an Amazon RDS for Oracle database](#postgresql-oracle-fdw.example) -+ [Working with encryption in transit](#postgresql-oracle-fdw.encryption) -+ [Understanding the pg\_user\_mappings view and permissions](#postgresql-oracle-fdw.permissions) - -### Turning on the oracle\_fdw extension - -To use the oracle\_fdw extension, perform the following procedure\. - -**To turn on the oracle\_fdw extension** -+ Run the following command using an account that has `rds_superuser` permissions\. - - ``` - CREATE EXTENSION oracle_fdw; - ``` - -### Example: Using a foreign server linked to an Amazon RDS for Oracle database - -The following example shows the use of a foreign server linked to an Amazon RDS for Oracle database\. - -**To create a foreign server linked to an RDS for Oracle database** - -1. Note the following on the RDS for Oracle DB instance: - + Endpoint - + Port - + Database name - -1. Create a foreign server\. - - ``` - test=> CREATE SERVER oradb FOREIGN DATA WRAPPER oracle_fdw OPTIONS (dbserver '//endpoint:port/DB_name'); - CREATE SERVER - ``` - -1. Grant usage to a user who doesn't have `rds_superuser` privileges, for example `user1`\. - - ``` - test=> GRANT USAGE ON FOREIGN SERVER oradb TO user1; - GRANT - ``` - -1. Connect as `user1`, and create a mapping to an Oracle user\. - - ``` - test=> CREATE USER MAPPING FOR user1 SERVER oradb OPTIONS (user 'oracleuser', password 'mypassword'); - CREATE USER MAPPING - ``` - -1. Create a foreign table linked to an Oracle table\. - - ``` - test=> CREATE FOREIGN TABLE mytab (a int) SERVER oradb OPTIONS (table 'MYTABLE'); - CREATE FOREIGN TABLE - ``` - -1. Query the foreign table\. - - ``` - test=> SELECT * FROM mytab; - a - --- - 1 - (1 row) - ``` - -If the query reports the following error, check your security group and access control list \(ACL\) to make sure that both instances can communicate\. - -``` -ERROR: connection for foreign table "mytab" cannot be established -DETAIL: ORA-12170: TNS:Connect timeout occurred -``` - -### Working with encryption in transit - -PostgreSQL\-to\-Oracle encryption in transit is based on a combination of client and server configuration parameters\. For an example using Oracle 21c, see [About the Values for Negotiating Encryption and Integrity](https://docs.oracle.com/en/database/oracle/oracle-database/21/dbseg/configuring-network-data-encryption-and-integrity.html#GUID-3A2AF4AA-AE3E-446B-8F64-31C48F27A2B5) in the Oracle documentation\. The client used for oracle\_fdw on Amazon RDS is configured with `ACCEPTED`, meaning that the encryption depends on the Oracle database server configuration\. - -If your database is on RDS for Oracle, see [Oracle native network encryption](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Appendix.Oracle.Options.NetworkEncryption.html) to configure the encryption\. - -### Understanding the pg\_user\_mappings view and permissions - -The PostgreSQL catalog `pg_user_mapping` stores the mapping from an RDS for PostgreSQL user to the user on a foreign data \(remote\) server\. Access to the catalog is restricted, but you use the `pg_user_mappings` view to see the mappings\. In the following, you can find an example that shows how permissions apply with an example Oracle database, but this information applies more generally to any foreign data wrapper\. - -In the following output, you can find roles and permissions mapped to three different example users\. Users `rdssu1` and `rdssu2` are members of the `rds_superuser` role, and `user1` isn't\. The example uses the `psql` metacommand `\du` to list existing roles\. - -``` -test=> \du - List of roles - Role name | Attributes | Member of ------------------+------------------------------------------------------------+------------------------------------------------------------- - rdssu1 | | {rds_superuser} - rdssu2 | | {rds_superuser} - user1 | | {} -``` - -All users, including users that have `rds_superuser` privileges, are allowed to view their own user mappings \(`umoptions`\) in the `pg_user_mappings` table\. As shown in the following example, when `rdssu1` tries to obtain all user mappings, an error is raised even though `rdssu1``rds_superuser` privileges: - -``` -test=> SELECT * FROM pg_user_mapping; -ERROR: permission denied for table pg_user_mapping -``` - -Following are some examples\. - -``` -test=> SET SESSION AUTHORIZATION rdssu1; -SET -test=> SELECT * FROM pg_user_mappings; - umid | srvid | srvname | umuser | usename | umoptions --------+-------+---------+--------+------------+---------------------------------- - 16414 | 16411 | oradb | 16412 | user1 | - 16423 | 16411 | oradb | 16421 | rdssu1 | {user=oracleuser,password=mypwd} - 16424 | 16411 | oradb | 16422 | rdssu2 | - (3 rows) - -test=> SET SESSION AUTHORIZATION rdssu2; -SET -test=> SELECT * FROM pg_user_mappings; - umid | srvid | srvname | umuser | usename | umoptions --------+-------+---------+--------+------------+---------------------------------- - 16414 | 16411 | oradb | 16412 | user1 | - 16423 | 16411 | oradb | 16421 | rdssu1 | - 16424 | 16411 | oradb | 16422 | rdssu2 | {user=oracleuser,password=mypwd} - (3 rows) - -test=> SET SESSION AUTHORIZATION user1; -SET -test=> SELECT * FROM pg_user_mappings; - umid | srvid | srvname | umuser | usename | umoptions --------+-------+---------+--------+------------+-------------------------------- - 16414 | 16411 | oradb | 16412 | user1 | {user=oracleuser,password=mypwd} - 16423 | 16411 | oradb | 16421 | rdssu1 | - 16424 | 16411 | oradb | 16422 | rdssu2 | - (3 rows) -``` - -Because of implementation differences between `information_schema._pg_user_mappings` and `pg_catalog.pg_user_mappings`, a manually created `rds_superuser` requires additional permissions to view passwords in `pg_catalog.pg_user_mappings`\. - -No additional permissions are required for an `rds_superuser` to view passwords in `information_schema._pg_user_mappings`\. - -Users who don't have the `rds_superuser` role can view passwords in `pg_user_mappings` only under the following conditions: -+ The current user is the user being mapped and owns the server or holds the `USAGE` privilege on it\. -+ The current user is the server owner and the mapping is for `PUBLIC`\. - -## Working with SQL Server databases by using the tds\_fdw extension - -You can use the PostgreSQL `tds_fdw` extension to access databases that support the tabular data stream \(TDS\) protocol, such as Sybase and Microsoft SQL Server databases\. This foreign data wrapper lets you connect from your RDS for PostgreSQL DB instance to databases that use the TDS protocol, including Amazon RDS for Microsoft SQL Server\. For more information, see [tds\-fdw/tds\_fdw](https://github.com/tds-fdw/tds_fdw) documentation on GitHub\. - -The `tds_fdw` extension is supported on Amazon RDS for PostgreSQL version 14\.2, 13\.6, and higher releases\. - -### Setting up your RDS for PostgreSQL DB to use the tds\_fdw extension - -In the following procedures, you can find an example of setting up and using the `tds_fdw` with an RDS for PostgreSQL DB instance\. Before you can connect to a SQL Server database using `tds_fdw`, you need to get the following details for the instance: -+ Hostname or endpoint\. For an RDS for SQL Server DB instance, you can find the endpoint by using the Console\. Choose the Connectivity & security tab and look in the "Endpoint and port" section\. -+ Port number\. The default port number for Microsoft SQL Server is 1433\. -+ Name of the database\. The DB identifier\. - -You also need to provide access on the security group or the access control list \(ACL\) for the SQL Server port, 1433\. Both the RDS for PostgreSQL DB instance and the RDS for SQL Server DB instance need access to port 1433\. If access isn't configured correctly, when you try to query the Microsoft SQL Server you see the following error message: - -``` -ERROR: DB-Library error: DB #: 20009, DB Msg: Unable to connect: -Adaptive Server is unavailable or does not exist (mssql2019.aws-region.rds.amazonaws.com), OS #: 0, OS Msg: Success, Level: 9 -``` - -**To use tds\_fdw to connect to a SQL Server database** - -1. Connect to your PostgreSQL DB instance using an account that has the `rds_superuser` role: - - ``` - psql --host=your-DB-instance.aws-region.rds.amazonaws.com --port=5432 --username=test –-password - ``` - -1. Install the `tds_fdw` extension: - - ``` - test=> CREATE EXTENSION tds_fdw; - CREATE EXTENSION - ``` - -After the extension is installed on your RDS for PostgreSQL DB instance, you set up the foreign server\. - -**To create the foreign server** - -Perform these tasks on the RDS for PostgreSQL DB instance using an account that has `rds_superuser` privileges\. - -1. Create a foreign server in the RDS for PostgreSQL DB instance: - - ``` - test=> CREATE SERVER sqlserverdb FOREIGN DATA WRAPPER tds_fdw OPTIONS (servername 'mssql2019.aws-region.rds.amazonaws.com', port '1433', database 'tds_fdw_testing'); - CREATE SERVER - ``` - -1. Grant permissions to a user who doesn't have `rds_superuser` role privileges, for example, `user1`: - - ``` - test=> GRANT USAGE ON FOREIGN SERVER sqlserverdb TO user1; - ``` - -1. Connect as user1 and create a mapping to a SQL Server user: - - ``` - test=> CREATE USER MAPPING FOR user1 SERVER sqlserverdb OPTIONS (username 'sqlserveruser', password 'password'); - CREATE USER MAPPING - ``` - -1. Create a foreign table linked to a SQL Server table: - - ``` - test=> CREATE FOREIGN TABLE mytab (a int) SERVER sqlserverdb OPTIONS (table 'MYTABLE'); - CREATE FOREIGN TABLE - ``` - -1. Query the foreign table: - - ``` - test=> SELECT * FROM mytab; - a - --- - 1 - (1 row) - ``` - -#### Using encryption in transit for the connection - -The connection from RDS for PostgreSQL to SQL Server uses encryption in transit \(TLS/SSL\) depending on the SQL Server database configuration\. If the SQL Server isn't configured for encryption, the RDS for PostgreSQL client making the request to the SQL Server database falls back to unencrypted\. - -You can enforce encryption for the connection to RDS for SQL Server DB instances by setting the `rds.force_ssl` parameter\. To learn how, see [Forcing connections to your DB instance to use SSL](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/SQLServer.Concepts.General.SSL.Using.html#SQLServer.Concepts.General.SSL.Forcing)\. For more information about SSL/TLS configuration for RDS for SQL Server, see [Using SSL with a Microsoft SQL Server DB instance](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/SQLServer.Concepts.General.SSL.Using.html)\. \ No newline at end of file diff --git a/doc_source/Appendix.PostgreSQL.CommonDBATasks.Extensions.md b/doc_source/Appendix.PostgreSQL.CommonDBATasks.Extensions.md deleted file mode 100644 index 43c4fb3..0000000 --- a/doc_source/Appendix.PostgreSQL.CommonDBATasks.Extensions.md +++ /dev/null @@ -1,1216 +0,0 @@ -# Using PostgreSQL extensions with Amazon RDS for PostgreSQL - -You can extend the functionality of PostgreSQL by installing a variety of extensions and modules\. For example, to work with spatial data you can install and use the PostGIS extension\. For more information, see [Managing spatial data with the PostGIS extension](Appendix.PostgreSQL.CommonDBATasks.PostGIS.md)\. As another example, if you want to improve data entry for very large tables, you can consider partitioning your data by using the `pg_partman` extension\. To learn more, see [Managing PostgreSQL partitions with the pg\_partman extension](PostgreSQL_Partitions.md)\. - -**Note** -As of RDS for PostgreSQL 14\.5, RDS for PostgreSQL supports Trusted Language Extensions for PostgreSQL\. This feature is implemented as the extension `pg_tle`, which you can add to your RDS for PostgreSQL DB instance\. By using this extension, developers can create their own PostgreSQL extensions in a safe environment that simplifies the setup and configuration requirements\. For more information, see [Working with Trusted Language Extensions for PostgreSQL](PostgreSQL_trusted_language_extension.md)\. - -In some cases, rather than installing an extension, you might add a specific module to the list of `shared_preload_libraries` in your RDS for PostgreSQL DB instance's custom DB parameter group\. Typically, the default DB cluster parameter group loads only the `pg_stat_statements`, but several other modules are available to add to the list\. For example, you can add scheduling capability by adding the `pg_cron` module, as detailed in [Scheduling maintenance with the PostgreSQL pg\_cron extension](PostgreSQL_pg_cron.md)\. As another example, you can log query execution plans by loading the `auto_explain` module\. To learn more, see [Logging execution plans of queries](https://aws.amazon.com/premiumsupport/knowledge-center/rds-postgresql-tune-query-performance/#) in the AWS knowledge center\. - -Depending on your version of RDS for PostgreSQL, installing an extension might require `rds_superuser` permissions, as follows: -+ For RDS for PostgreSQL versions 12 and earlier versions, installing extensions requires `rds_superuser` privileges\. -+ For RDS for PostgreSQL version 13 and higher versions, users \(roles\) with create permissions on a given database instance can install and use any *trusted extensions*\. For a list of trusted extensions, see [PostgreSQL trusted extensions](CHAP_PostgreSQL.md#PostgreSQL.Concepts.General.Extensions.Trusted)\. - -You can also specify precisely which extensions can be installed on your RDS for PostgreSQL DB instance, by listing them in the `rds.allowed_extensions` parameter\. By default, this parameter isn't set, so any supported extension can be added if the user has permissions to do so\. By adding a list of extensions to this parameter, you explicitly identify the extensions that your RDS for PostgreSQL DB instance can use\. Any extensions not listed can't be installed\. This capability is available for the following versions: -+ RDS for PostgreSQL 14\.1 and all higher versions -+ RDS for PostgreSQL 13\.3 and higher minor versions -+ RDS for PostgreSQL 12\.7 and higher minor versions - -For more information, see [Restricting installation of PostgreSQL extensions](CHAP_PostgreSQL.md#PostgreSQL.Concepts.General.FeatureSupport.Extensions.Restriction)\. - -To learn more about the `rds_superuser` role, see [Understanding PostgreSQL roles and permissions](Appendix.PostgreSQL.CommonDBATasks.Roles.md)\. - -**Topics** -+ [Using functions from the orafce extension](#Appendix.PostgreSQL.CommonDBATasks.orafce) -+ [Managing PostgreSQL partitions with the pg\_partman extension](PostgreSQL_Partitions.md) -+ [Using pgAudit to log database activity](#Appendix.PostgreSQL.CommonDBATasks.pgaudit) -+ [Scheduling maintenance with the PostgreSQL pg\_cron extension](PostgreSQL_pg_cron.md) -+ [Using pglogical to synchronize data across instances](#Appendix.PostgreSQL.CommonDBATasks.pglogical) -+ [Reducing bloat in tables and indexes with the pg\_repack extension](#Appendix.PostgreSQL.CommonDBATasks.pg_repack) -+ [Upgrading and using the PLV8 extension](#PostgreSQL.Concepts.General.UpgradingPLv8) -+ [Using PL/Rust to write PostgreSQL functions in the Rust language](#PostgreSQL.Concepts.General.Using.PL_Rust) -+ [Managing spatial data with the PostGIS extension](Appendix.PostgreSQL.CommonDBATasks.PostGIS.md) - -## Using functions from the orafce extension - -The orafce extension provides functions and operators that emulate a subset of functions and packages from an Oracle database\. The orafce extension makes it easier for you to port an Oracle application to PostgreSQL\. RDS for PostgreSQL versions 9\.6\.6 and higher support this extension\. For more information about orafce, see [orafce](https://github.com/orafce/orafce) on GitHub\. - -**Note** -RDS for PostgreSQL doesn't support the `utl_file` package that is part of the orafce extension\. This is because the `utl_file` schema functions provide read and write operations on operating\-system text files, which requires superuser access to the underlying host\. As a managed service, RDS for PostgreSQL doesn't provide host access\. - -**To use the orafce extension** - -1. Connect to the DB instance with the primary user name that you used to create the DB instance\. - - If you want to turn on orafce for a different database in the same DB instance, use the `/c dbname` psql command\. Using this command, you change from the primary database after initiating the connection\. - -1. Turn on the orafce extension with the `CREATE EXTENSION` statement\. - - ``` - CREATE EXTENSION orafce; - ``` - -1. Transfer ownership of the oracle schema to the rds\_superuser role with the `ALTER SCHEMA` statement\. - - ``` - ALTER SCHEMA oracle OWNER TO rds_superuser; - ``` - - If you want to see the list of owners for the oracle schema, use the `\dn` psql command\. - -## Using pgAudit to log database activity - -Financial institutions, government agencies, and many industries need to keep *audit logs* to meet regulatory requirements\. By using the PostgreSQL Audit extension \(pgAudit\) with your RDS for PostgreSQL DB instance, you can capture the detailed records that are typically needed by auditors or to meet regulatory requirements\. For example, you can set up the pgAudit extension to track changes made to specific databases and tables, to record the user who made the change, and many other details\. - -The pgAudit extension builds on the functionality of the native PostgreSQL logging infrastructure by extending the log messages with more detail\. In other words, you use the same approach to view your audit log as you do to view any log messages\. For more information about PostgreSQL logging, see [RDS for PostgreSQL database log files](USER_LogAccess.Concepts.PostgreSQL.md)\. - -The pgAudit extension redacts sensitive data such as cleartext passwords from the logs\. If your RDS for PostgreSQL DB instance is configured to log data manipulation language \(DML\) statements as detailed in [Turning on query logging for your RDS for PostgreSQL DB instance](USER_LogAccess.Concepts.PostgreSQL.md#USER_LogAccess.Concepts.PostgreSQL.Query_Logging), you can avoid the cleartext password issue by using the PostgreSQL Audit extension\. - -You can configure auditing on your database instances with a great degree of specificity\. You can audit all databases and all users\. Or, you can choose to audit only certain databases, users, and other objects\. You can also explicitly exclude certain users and databases from being audited\. For more information, see [Excluding users or databases from audit logging](#Appendix.PostgreSQL.CommonDBATasks.pgaudit.exclude-user-db)\. - -Given the amount of detail that can be captured, we recommend that if you do use pgAudit, you monitor your storage consumption\. - -The pgAudit extension is supported on all available RDS for PostgreSQL versions\. For a list of pgAudit versions supported by available RDS for PostgreSQL versions, see [Extension versions for Amazon RDS for PostgreSQL](https://docs.aws.amazon.com/AmazonRDS/latest/PostgreSQLReleaseNotes/postgresql-extensions.html) in the *Amazon RDS for PostgreSQL Release Notes\.* - -**Topics** -+ [Setting up the pgAudit extension](#Appendix.PostgreSQL.CommonDBATasks.pgaudit.basic-setup) -+ [Auditing database objects](#Appendix.PostgreSQL.CommonDBATasks.pgaudit.auditing) -+ [Excluding users or databases from audit logging](#Appendix.PostgreSQL.CommonDBATasks.pgaudit.exclude-user-db) -+ [Reference for the pgAudit extension](#Appendix.PostgreSQL.CommonDBATasks.pgaudit.reference) - -### Setting up the pgAudit extension - -To set up the pgAudit extension on your RDS for PostgreSQL DB instance , you first add pgAudit to the shared libraries on the custom DB parameter group for your RDS for PostgreSQL DB instance\. For information about creating a custom DB parameter group, see [Working with parameter groups](USER_WorkingWithParamGroups.md)\. Next, you install the pgAudit extension\. Finally, you specify the databases and objects that you want to audit\. The procedures in this section show you how\. You can use the AWS Management Console or the AWS CLI\. - -You must have permissions as the `rds_superuser` role to perform all these tasks\. - -The steps following assume that your RDS for PostgreSQL DB instance is associated with a custom DB parameter group\. - -#### Console - -**To set up the pgAudit extension** - -1. Sign in to the AWS Management Console and open the Amazon RDS console at [https://console\.aws\.amazon\.com/rds/](https://console.aws.amazon.com/rds/)\. - -1. In the navigation pane, choose your RDS for PostgreSQL DB instance\. - -1. Open the **Configuration** tab for your RDS for PostgreSQL DB instance\. Among the Instance details, find the **Parameter group** link\. - -1. Choose the link to open the custom parameters associated with your RDS for PostgreSQL DB instance\. - -1. In the **Parameters** search field, type `shared_pre` to find the `shared_preload_libraries` parameter\. - -1. Choose **Edit parameters** to access the property values\. - -1. Add `pgaudit` to the list in the **Values** field\. Use a comma to separate items in the list of values\. -![\[Image of the shared_preload_libaries parameter with pgAudit added.\]](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/images/apg_rpg_shared_preload_pgaudit.png) - -1. Reboot the RDS for PostgreSQL DB instance so that your change to the `shared_preload_libraries` parameter takes effect\. - -1. When the instance is available, verify that pgAudit has been initialized\. Use `psql` to connect to the RDS for PostgreSQL DB instance, and then run the following command\. - - ``` - SHOW shared_preload_libraries; - shared_preload_libraries - -------------------------- - rdsutils,pgaudit - (1 row) - ``` - -1. With pgAudit initialized, you can now create the extension\. You need to create the extension after initializing the library because the `pgaudit` extension installs event triggers for auditing data definition language \(DDL\) statements\. - - ``` - CREATE EXTENSION pgaudit; - ``` - -1. Close the `psql` session\. - - ``` - labdb=> \q - ``` - -1. Sign in to the AWS Management Console and open the Amazon RDS console at [https://console\.aws\.amazon\.com/rds/](https://console.aws.amazon.com/rds/)\. - -1. Find the `pgaudit.log` parameter in the list and set to the appropriate value for your use case\. For example, setting the `pgaudit.log` parameter to `write` as shown in the following image captures inserts, updates, deletes, and some other types changes to the log\. -![\[Image of the pgaudit.log parameter with setting.\]](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/images/rpg_set_pgaudit-log-level.png) - - You can also choose one of the following values for the `pgaudit.log` parameter\. - + none – This is the default\. No database changes are logged\. - + all – Logs everything \(read, write, function, role, ddl, misc\)\. - + ddl – Logs all data definition language \(DDL\) statements that aren't included in the `ROLE` class\. - + function – Logs function calls and `DO` blocks\. - + misc – Logs miscellaneous commands, such as `DISCARD`, `FETCH`, `CHECKPOINT`, `VACUUM`, and `SET`\. - + read – Logs `SELECT` and `COPY` when the source is a relation \(such as a table\) or a query\. - + role – Logs statements related to roles and privileges, such as `GRANT`, `REVOKE`, `CREATE ROLE`, `ALTER ROLE`, and `DROP ROLE`\. - + write – Logs `INSERT`, `UPDATE`, `DELETE`, `TRUNCATE`, and `COPY` when the destination is a relation \(table\)\. - -1. Choose **Save changes**\. - -1. Open the Amazon RDS console at [https://console\.aws\.amazon\.com/rds/](https://console.aws.amazon.com/rds/)\. - -1. Choose your RDS for PostgreSQL DB instance from the Databases list to select it, and then choose **Reboot** from the Actions menu\. - -#### AWS CLI - -**To setup pgAudit** - -To setup pgAudit using the AWS CLI, you call the [modify\-db\-parameter\-group](https://docs.aws.amazon.com/cli/latest/reference/rds/modify-db-parameter-group.html) operation to modify the audit log parameters in your custom parameter group, as shown in the following procedure\. - -1. Use the following AWS CLI command to add `pgaudit` to the `shared_preload_libraries` parameter\. - - ``` - aws rds modify-db-parameter-group \ - --db-parameter-group-name custom-param-group-name \ - --parameters "ParameterName=shared_preload_libraries,ParameterValue=pgaudit,ApplyMethod=pending-reboot" \ - --region aws-region - ``` - -1. Use the following AWS CLI command to reboot the RDS for PostgreSQL DB instance so that the pgaudit library is initialized\. - - ``` - aws rds reboot-db-instance \ - --db-instance-identifier your-instance \ - --region aws-region - ``` - -1. When the instance is available, you can verify that `pgaudit` has been initialized\. Use `psql` to connect to the RDS for PostgreSQL DB instance, and then run the following command\. - - ``` - SHOW shared_preload_libraries; - shared_preload_libraries - -------------------------- - rdsutils,pgaudit - (1 row) - ``` - - With pgAudit initialized, you can now create the extension\. - - ``` - CREATE EXTENSION pgaudit; - ``` - -1. Close the `psql` session so that you can use the AWS CLI\. - - ``` - labdb=> \q - ``` - -1. Use the following AWS CLI command to specify the classes of statement that want logged by session audit logging\. The example sets the `pgaudit.log` parameter to `write`, which captures inserts, updates, and deletes to the log\. - - ``` - aws rds modify-db-parameter-group \ - --db-parameter-group-name custom-param-group-name \ - --parameters "ParameterName=pgaudit.log,ParameterValue=write,ApplyMethod=pending-reboot" \ - --region aws-region - ``` - - You can also choose one of the following values for the `pgaudit.log` parameter\. - + none – This is the default\. No database changes are logged\. - + all – Logs everything \(read, write, function, role, ddl, misc\)\. - + ddl – Logs all data definition language \(DDL\) statements that aren't included in the `ROLE` class\. - + function – Logs function calls and `DO` blocks\. - + misc – Logs miscellaneous commands, such as `DISCARD`, `FETCH`, `CHECKPOINT`, `VACUUM`, and `SET`\. - + read – Logs `SELECT` and `COPY` when the source is a relation \(such as a table\) or a query\. - + role – Logs statements related to roles and privileges, such as `GRANT`, `REVOKE`, `CREATE ROLE`, `ALTER ROLE`, and `DROP ROLE`\. - + write – Logs `INSERT`, `UPDATE`, `DELETE`, `TRUNCATE`, and `COPY` when the destination is a relation \(table\)\. - - Reboot the RDS for PostgreSQL DB instance using the following AWS CLI command\. - - ``` - aws rds reboot-db-instance \ - --db-instance-identifier your-instance \ - --region aws-region - ``` - -### Auditing database objects - -With pgAudit set up on your RDS for PostgreSQL DB instance and configured for your requirements, more detailed information is captured in the PostgreSQL log\. For example, while the default PostgreSQL logging configuration identifies the date and time that a change was made in a database table, with the pgAudit extension the log entry can include the schema, user who made the change, and other details depending on how the extension parameters are configured\. You can set up auditing to track changes in the following ways\. -+ For each session, by user\. For the session level, you can capture the fully qualified command text\. -+ For each object, by user and by database\. - -The object auditing capability is activated when you create the `rds_pgaudit` role on your system and then add this role to the `pgaudit.role` parameter in your custom parameter parameter group\. By default, the `pgaudit.role` parameter is unset and the only allowable value is `rds_pgaudit`\. The following steps assume that `pgaudit` has been initialized and that you have created the `pgaudit` extension by following the procedure in [Setting up the pgAudit extension](#Appendix.PostgreSQL.CommonDBATasks.pgaudit.basic-setup)\. - -![\[Image of the PostgreSQL log file after setting up pgAudit.\]](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/images/pgaudit-log-example.png) - -As shown in this example, the "LOG: AUDIT: SESSION" line provides information about the table and its schema, among other details\. - -**To set up object auditing** - -1. Use `psql` to connect to the RDS for PostgreSQL DB instance\. - - ``` - psql --host=your-instance-name.aws-region.rds.amazonaws.com --port=5432 --username=postgrespostgres --password --dbname=labdb - ``` - -1. Create a database role named `rds_pgaudit` using the following command\. - - ``` - labdb=> CREATE ROLE rds_pgaudit; - CREATE ROLE - labdb=> - ``` - -1. Close the `psql` session\. - - ``` - labdb=> \q - ``` - - In the next few steps, use the AWS CLI to modify the audit log parameters in your custom parameter group\. - -1. Use the following AWS CLI command to set the `pgaudit.role` parameter to `rds_pgaudit`\. By default, this parameter is empty, and `rds_pgaudit` is the only allowable value\. - - ``` - aws rds modify-db-parameter-group \ - --db-parameter-group-name custom-param-group-name \ - --parameters "ParameterName=pgaudit.role,ParameterValue=rds_pgaudit,ApplyMethod=pending-reboot" \ - --region aws-region - ``` - -1. Use the following AWS CLI command to reboot the RDS for PostgreSQL DB instance so that your changes to the parameters take effect\. - - ``` - aws rds reboot-db-instance \ - --db-instance-identifier your-instance \ - --region aws-region - ``` - -1. Run the following command to confirm that the `pgaudit.role` is set to `rds_pgaudit`\. - - ``` - SHOW pgaudit.role; - pgaudit.role - ------------------ - rds_pgaudit - ``` - -To test pgAudit logging, you can run several example commands that you want to audit\. For example, you might run the following commands\. - -``` -CREATE TABLE t1 (id int); -GRANT SELECT ON t1 TO rds_pgaudit; -SELECT * FROM t1; -id ----- -(0 rows) -``` - -The database logs should contain an entry similar to the following\. - -``` -... -2017-06-12 19:09:49 UTC:...:rds_test@postgres:[11701]:LOG: AUDIT: -OBJECT,1,1,READ,SELECT,TABLE,public.t1,select * from t1; -... -``` - -For information on viewing the logs, see [Monitoring Amazon RDS log files](USER_LogAccess.md)\. - -To learn more about the pgAudit extension, see [pgAudit](https://github.com/pgaudit/pgaudit/blob/master/README.md) on GitHub\. - -### Excluding users or databases from audit logging - -As discussed in [RDS for PostgreSQL database log files](USER_LogAccess.Concepts.PostgreSQL.md), PostgreSQL logs consume storage space\. Using the pgAudit extension adds to the volume of data gathered in your logs to varying degrees, depending on the changes that you track\. You might not need to audit every user or database in your RDS for PostgreSQL DB instance\. - -To minimize impacts to your storage and to avoid needlessly capturing audit records, you can exclude users and databases from being audited\. You can also change logging within a given session\. The following examples show you how\. - -**Note** -Parameter settings at the session level take precedence over the settings in the custom DB parameter group for the RDS for PostgreSQL DB instance\. If you don't want database users to bypass your audit logging configuration settings, be sure to change their permissions\. - -Suppose that your RDS for PostgreSQL DB instance is configured to audit the same level of activity for all users and databases\. You then decide that you don't want to audit the user `myuser`\. You can turn off auditing for `myuser` with the following SQL command\. - -``` -ALTER USER myuser SET pgaudit.log TO 'NONE'; -``` - -Then, you can use the following query to check the `user_specific_settings` column for `pgaudit.log` to confirm that the parameter is set to `NONE`\. - -``` -SELECT - usename AS user_name, - useconfig AS user_specific_settings -FROM - pg_user -WHERE - usename = 'myuser'; -``` - -You see output such as the following\. - -``` - user_name | user_specific_settings ------------+------------------------ - myuser | {pgaudit.log=NONE} -(1 row) -``` - -You can turn off logging for a given user in the midst of their session with the database with the following command\. - -``` -ALTER USER myuser IN DATABASE mydatabase SET pgaudit.log TO 'none'; -``` - -Use the following query to check the settings column for pgaudit\.log for a specific user and database combination\. - -``` -SELECT - usename AS "user_name", - datname AS "database_name", - pg_catalog.array_to_string(setconfig, E'\n') AS "settings" -FROM - pg_catalog.pg_db_role_setting s - LEFT JOIN pg_catalog.pg_database d ON d.oid = setdatabase - LEFT JOIN pg_catalog.pg_user r ON r.usesysid = setrole -WHERE - usename = 'myuser' - AND datname = 'mydatabase' -ORDER BY - 1, - 2; -``` - -You see output similar to the following\. - -``` - user_name | database_name | settings ------------+---------------+------------------ - myuser | mydatabase | pgaudit.log=none -(1 row) -``` - -After turning off auditing for `myuser`, you decide that you don't want to track changes to `mydatabase`\. You turn off auditing for that specific database by using the following command\. - -``` -ALTER DATABASE mydatabase SET pgaudit.log to 'NONE'; -``` - -Then, use the following query to check the database\_specific\_settings column to confirm that pgaudit\.log is set to NONE\. - -``` -SELECT -a.datname AS database_name, -b.setconfig AS database_specific_settings -FROM -pg_database a -FULL JOIN pg_db_role_setting b ON a.oid = b.setdatabase -WHERE -a.datname = 'mydatabase'; -``` - -You see output such as the following\. - -``` - database_name | database_specific_settings ----------------+---------------------------- - mydatabase | {pgaudit.log=NONE} -(1 row) -``` - -To return settings to the default setting for myuser, use the following command: - -``` -ALTER USER myuser RESET pgaudit.log; -``` - -To return settings to their default setting for a database, use the following command\. - -``` -ALTER DATABASE mydatabase RESET pgaudit.log; -``` - -To reset user and database to the default setting, use the following command\. - -``` -ALTER USER myuser IN DATABASE mydatabase RESET pgaudit.log; -``` - -You can also capture specific events to the log by setting the `pgaudit.log` to one of the other allowed values for the `pgaudit.log` parameter\. For more information, see [List of allowable settings for the `pgaudit.log` parameter](#Appendix.PostgreSQL.CommonDBATasks.pgaudit.reference.pgaudit-log-settings)\. - -``` -ALTER USER myuser SET pgaudit.log TO 'read'; -ALTER DATABASE mydatabase SET pgaudit.log TO 'function'; -ALTER USER myuser IN DATABASE mydatabase SET pgaudit.log TO 'read,function' -``` - -### Reference for the pgAudit extension - -You can specify the level of detail that you want for your audit log by changing one or more of the parameters listed in this section\. - -#### Controlling pgAudit behavior - -You can control the audit logging by changing one or more of the parameters listed in the following table\. - - -| Parameter | Description | -| --- | --- | -| `pgaudit.log` | Specifies the statement classes that will be logged by session audit logging\. Allowable values include ddl, function, misc, read, role, write, none, all\. For more information, see [List of allowable settings for the `pgaudit.log` parameter](#Appendix.PostgreSQL.CommonDBATasks.pgaudit.reference.pgaudit-log-settings)\. | -| `pgaudit.log_catalog` | When turned on \(set to 1\), adds statements to audit trail if all relations in a statement are in pg\_catalog\. | -| `pgaudit.log_level` | Specifies the log level to use for log entries\. Allowed values: debug5, debug4, debug3, debug2, debug1, info, notice, warning, log | -| `pgaudit.log_parameter` | When turned on \(set to 1\), parameters passed with the statement are captured in the audit log\. | -| `pgaudit.log_relation` | When turned on \(set to 1\), the audit log for the session creates a separate log entry for each relation \(TABLE, VIEW, and so on\) referenced in a SELECT or DML statement\. | -| `pgaudit.log_statement_once` | Specifies whether logging will include the statement text and parameters with the first log entry for a statement/substatement combination or with every entry\. | -| `pgaudit.role` | Specifies the master role to use for object audit logging\. The only allowable entry is `rds_pgaudit`\. | - -#### List of allowable settings for the `pgaudit.log` parameter - - - - -| Value | Description | -| --- | --- | -| none | This is the default\. No database changes are logged\. | -| all | Logs everything \(read, write, function, role, ddl, misc\)\. | -| ddl | Logs all data definition language \(DDL\) statements that aren't included in the `ROLE` class\. | -| function | Logs function calls and `DO` blocks\. | -| misc | Logs miscellaneous commands, such as `DISCARD`, `FETCH`, `CHECKPOINT`, `VACUUM`, and `SET`\. | -| read | Logs `SELECT` and `COPY` when the source is a relation \(such as a table\) or a query\. | -| role | Logs statements related to roles and privileges, such as `GRANT`, `REVOKE`, `CREATE ROLE`, `ALTER ROLE`, and `DROP ROLE`\. | -| write | Logs `INSERT`, `UPDATE`, `DELETE`, `TRUNCATE`, and `COPY` when the destination is a relation \(table\)\. | - -To log multiple event types with session auditing, use a comma\-separated list\. To log all event types, set `pgaudit.log` to `ALL`\. Reboot your DB instance to apply the changes\. - -With object auditing, you can refine audit logging to work with specific relations\. For example, you can specify that you want audit logging for `READ` operations on one or more tables\. - -## Using pglogical to synchronize data across instances - -All currently available RDS for PostgreSQL versions support the `pglogical` extension\. The pglogical extension predates the functionally similar logical replication feature that was introduced by PostgreSQL in version 10\. For more information, see [Performing logical replication for Amazon RDS for PostgreSQL](PostgreSQL.Concepts.General.FeatureSupport.md#PostgreSQL.Concepts.General.FeatureSupport.LogicalReplication)\. - -The `pglogical` extension supports logical replication between two or more RDS for PostgreSQL DB instances\. It also supports replication between different PostgreSQL versions, and between databases running on RDS for PostgreSQL DB instances and Aurora PostgreSQL DB clusters\. The `pglogical` extension uses a publish\-subscribe model to replicate changes to tables and other objects, such as sequences, from a publisher to a subscriber\. It relies on a replication slot to ensure that changes are synchronized from a publisher node to a subscriber node, defined as follows\. -+ The *publisher node* is the RDS for PostgreSQL DB instance that's the source of data to be replicated to other nodes\. The publisher node defines the tables to be replicated in a publication set\. -+ The *subscriber node* is the RDS for PostgreSQL DB instance that receives WAL updates from the publisher\. The subscriber creates a subscription to connect to the publisher and get the decoded WAL data\. When the subscriber creates the subscription, the replication slot is created on the publisher node\. - -Following, you can find information about setting up the `pglogical` extension\. - -**Topics** -+ [Requirements and limitations for the pglogical extension](#Appendix.PostgreSQL.CommonDBATasks.pglogical.requirements-limitations) -+ [Setting up the pglogical extension](#Appendix.PostgreSQL.CommonDBATasks.pglogical.basic-setup) -+ [Setting up logical replication for RDS for PostgreSQL DB instance](#Appendix.PostgreSQL.CommonDBATasks.pglogical.setup-replication) -+ [Reestablishing logical replication after a major upgrade](#Appendix.PostgreSQL.CommonDBATasks.pglogical.recover-replication-after-upgrade) -+ [Managing logical replication slots for RDS for PostgreSQL](#Appendix.PostgreSQL.CommonDBATasks.pglogical.handle-slots) -+ [Parameter reference for the pglogical extension](#Appendix.PostgreSQL.CommonDBATasks.pglogical.reference) - -### Requirements and limitations for the pglogical extension - -All currently available releases of RDS for PostgreSQL support the `pglogical` extension\. - -Both the publisher node and the subscriber node must be set up for logical replication\. - -The tables that you want to replicate from subscriber to publisher must have the same names and the same schema\. These tables must also contain the same columns, and the columns must use the same data types\. Both publisher and subscriber tables must have the same primary keys\. We recommend that you use only the PRIMARY KEY as the unique constraint\. - -The tables on the subscriber node can have more permissive constraints than those on the publisher node for CHECK constraints and NOT NULL constraints\. - -The `pglogical` extension provides features such as two\-way replication that aren't supported by the logical replication feature built into PostgreSQL \(version 10 and higher\)\. For more information, see [PostgreSQL bi\-directional replication using pglogical](https://aws.amazon.com/blogs/database/postgresql-bi-directional-replication-using-pglogical/)\. - -### Setting up the pglogical extension - -To set up the `pglogical` extension on your RDS for PostgreSQL DB instance , you add `pglogical` to the shared libraries on the custom DB parameter group for your RDS for PostgreSQL DB instance\. You also need to set the value of the `rds.logical_replication` parameter to `1`, to turn on logical decoding\. Finally, you create the extension in the database\. You can use the AWS Management Console or the AWS CLI for these tasks\. - -You must have permissions as the `rds_superuser` role to perform these tasks\. - -The steps following assume that your RDS for PostgreSQL DB instance is associated with a custom DB parameter group\. For information about creating a custom DB parameter group, see [Working with parameter groups](USER_WorkingWithParamGroups.md)\. - -#### Console - -**To set up the pglogical extension** - -1. Sign in to the AWS Management Console and open the Amazon RDS console at [https://console\.aws\.amazon\.com/rds/](https://console.aws.amazon.com/rds/)\. - -1. In the navigation pane, choose your RDS for PostgreSQL DB instance\. - -1. Open the **Configuration** tab for your RDS for PostgreSQL DB instance\. Among the Instance details, find the **Parameter group** link\. - -1. Choose the link to open the custom parameters associated with your RDS for PostgreSQL DB instance\. - -1. In the **Parameters** search field, type `shared_pre` to find the `shared_preload_libraries` parameter\. - -1. Choose **Edit parameters** to access the property values\. - -1. Add `pglogical` to the list in the **Values** field\. Use a comma to separate items in the list of values\. -![\[Image of the shared_preload_libraries parameter with pglogical added.\]](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/images/apg_rpg_shared_preload_pglogical.png) - -1. Find the `rds.logical_replication` parameter and set it to `1`, to turn on logical replication\. - -1. Reboot the RDS for PostgreSQL DB instance so that your changes take effect\. - -1. When the instance is available, you can use `psql` \(or pgAdmin\) to connect to the RDS for PostgreSQL DB instance\. - - ``` - psql --host=111122223333.aws-region.rds.amazonaws.com --port=5432 --username=postgres --password --dbname=labdb - ``` - -1. To verify that pglogical is initialized, run the following command\. - - ``` - SHOW shared_preload_libraries; - shared_preload_libraries - -------------------------- - rdsutils,pglogical - (1 row) - ``` - -1. Verify the setting that enables logical decoding, as follows\. - - ``` - SHOW wal_level; - wal_level - ----------- - logical - (1 row) - ``` - -1. Create the extension, as follows\. - - ``` - CREATE EXTENSION pglogical; - EXTENSION CREATED - ``` - -1. Choose **Save changes**\. - -1. Open the Amazon RDS console at [https://console\.aws\.amazon\.com/rds/](https://console.aws.amazon.com/rds/)\. - -1. Choose your RDS for PostgreSQL DB instance from the Databases list to select it, and then choose **Reboot** from the Actions menu\. - -#### AWS CLI - -**To setup the pglogical extension** - -To setup pglogical using the AWS CLI, you call the [modify\-db\-parameter\-group](https://docs.aws.amazon.com/cli/latest/reference/rds/modify-db-parameter-group.html) operation to modify certain parameters in your custom parameter group as shown in the following procedure\. - -1. Use the following AWS CLI command to add `pglogical` to the `shared_preload_libraries` parameter\. - - ``` - aws rds modify-db-parameter-group \ - --db-parameter-group-name custom-param-group-name \ - --parameters "ParameterName=shared_preload_libraries,ParameterValue=pglogical,ApplyMethod=pending-reboot" \ - --region aws-region - ``` - -1. Use the following AWS CLI command to set `rds.logical_replication` to `1` to turn on the logical decoding capability for the RDS for PostgreSQL DB instance\. - - ``` - aws rds modify-db-parameter-group \ - --db-parameter-group-name custom-param-group-name \ - --parameters "ParameterName=rds.logical_replication,ParameterValue=1,ApplyMethod=pending-reboot" \ - --region aws-region - ``` - -1. Use the following AWS CLI command to reboot the RDS for PostgreSQL DB instance so that the pglogical library is initialized\. - - ``` - aws rds reboot-db-instance \ - --db-instance-identifier your-instance \ - --region aws-region - ``` - -1. When the instance is available, use `psql` to connect to the RDS for PostgreSQL DB instance\. - - ``` - psql --host=111122223333.aws-region.rds.amazonaws.com --port=5432 --username=postgres --password --dbname=labdb - ``` - -1. Create the extension, as follows\. - - ``` - CREATE EXTENSION pglogical; - EXTENSION CREATED - ``` - -1. Reboot the RDS for PostgreSQL DB instance using the following AWS CLI command\. - - ``` - aws rds reboot-db-instance \ - --db-instance-identifier your-instance \ - --region aws-region - ``` - -### Setting up logical replication for RDS for PostgreSQL DB instance - -The following procedure shows you how to start logical replication between two RDS for PostgreSQL DB instances\. The steps assume that both the source \(publisher\) and the target \(subscriber\) have the `pglogical` extension set up as detailed in [Setting up the pglogical extension](#Appendix.PostgreSQL.CommonDBATasks.pglogical.basic-setup)\. - -**To create the publisher node and define the tables to replicate** - -These steps assume that your RDS for PostgreSQL DB instance has a database that has one or more tables that you want to replicate to another node\. You need to recreate the table structure from the publisher on the subscriber, so first, get the table structure if necessary\. You can do that by using the `psq1` metacommand `\d tablename` and then creating the same table on the subscriber instance\. The following procedure creates an example table on the publisher \(source\) for demonstration purposes\. - -1. Use `psql` to connect to the instance that has the table you want to use as a source for subscribers\. - - ``` - psql --host=source-instance.aws-region.rds.amazonaws.com --port=5432 --username=postgres --password --dbname=labdb - ``` - - If you don't have an existing table that you want to replicate, you can create a sample table as follows\. - - 1. Create an example table using the following SQL statement\. - - ``` - CREATE TABLE docs_lab_table (a int PRIMARY KEY); - ``` - - 1. Populate the table with generated data by using the following SQL statement\. - - ``` - INSERT INTO docs_lab_table VALUES (generate_series(1,5000)); - INSERT 0 5000 - ``` - - 1. Verify that data exists in the table by using the following SQL statement\. - - ``` - SELECT count(*) FROM docs_lab_table; - ``` - -1. Identify this RDS for PostgreSQL DB instance as the publisher node, as follows\. - - ``` - SELECT pglogical.create_node( - node_name := 'docs_lab_provider', - dsn := 'host=source-instance.aws-region.rds.amazonaws.com port=5432 dbname=labdb'); - create_node - ------------- - 3410995529 - (1 row) - ``` - -1. Add the table that you want to replicate to the default replication set\. For more information about replication sets, see [Replication sets](https://github.com/2ndQuadrant/pglogical/tree/REL2_x_STABLE/docs#replication-sets) in the pglogical documentation\. - - ``` - SELECT pglogical.replication_set_add_table('default', 'docs_lab_table', 'true', NULL, NULL); - replication_set_add_table - --------------------------- - t - (1 row) - ``` - -The publisher node setup is complete\. You can now set up the subscriber node to receive the updates from the publisher\. - -**To set up the subscriber node and create a subscription to receive updates** - -These steps assume that the RDS for PostgreSQL DB instance has been set up with the `pglogical` extension\. For more information, see [Setting up the pglogical extension](#Appendix.PostgreSQL.CommonDBATasks.pglogical.basic-setup)\. - -1. Use `psql` to connect to the instance that you want to receive updates from the publisher\. - - ``` - psql --host=target-instance.aws-region.rds.amazonaws.com --port=5432 --username=postgres --password --dbname=labdb - ``` - -1. On the subscriber RDS for PostgreSQL DB instance,create the same table that exists on the publisher\. For this example, the table is `docs_lab_table`\. You can create the table as follows\. - - ``` - CREATE TABLE docs_lab_table (a int PRIMARY KEY); - ``` - -1. Verify that this table is empty\. - - ``` - SELECT count(*) FROM docs_lab_table; - count - ------- - 0 - (1 row) - ``` - -1. Identify this RDS for PostgreSQL DB instance as the subscriber node, as follows\. - - ``` - SELECT pglogical.create_node( - node_name := 'docs_lab_target', - dsn := 'host=target-instance.aws-region.rds.amazonaws.com port=5432 sslmode=require dbname=labdb user=postgres password=********'); - create_node - ------------- - 2182738256 - (1 row) - ``` - -1. Create the subscription\. - - ``` - SELECT pglogical.create_subscription( - subscription_name := 'docs_lab_subscription', - provider_dsn := 'host=source-instance.aws-region.rds.amazonaws.com port=5432 sslmode=require dbname=labdb user=postgres password=*******', - replication_sets := ARRAY['default'], - synchronize_data := true, - forward_origins := '{}' ); - create_subscription - --------------------- - 1038357190 - (1 row) - ``` - - When you complete this step, the data from the table on the publisher is created in the table on the subscriber\. You can verify that this has occurred by using the following SQL query\. - - ``` - SELECT count(*) FROM docs_lab_table; - count - ------- - 5000 - (1 row) - ``` - -From this point forward, changes made to the table on the publisher are replicated to the table on the subscriber\. - -### Reestablishing logical replication after a major upgrade - -Before you can perform a major version upgrade of an RDS for PostgreSQL DB instance that's set up as a publisher node for logical replication, you must drop all replication slots, even those that aren't active\. We recommend that you temporarily divert database transactions from the publisher node, drop the replication slots, upgrade the RDS for PostgreSQL DB instance, and then re\-establish and restart replication\. - -The replication slots are hosted on the publisher node only\. The RDS for PostgreSQL subscriber node in a logical replication scenario has no slots to drops, but it can't be upgraded to a major version while it's designated as a subscriber node with a subscription to the publisher\. Before upgrading the RDS for PostgreSQL subscriber node, drop the subscription and the node\. For more information, see [Managing logical replication slots for RDS for PostgreSQL](#Appendix.PostgreSQL.CommonDBATasks.pglogical.handle-slots)\. - -#### Determining that logical replication has been disrupted - -You can determine that the replication process has been disrupted by querying either the publisher node or the subscriber node, as follows\. - -**To check the publisher node** -+ Use `psql` to connect to the publisher node, and then query the `pg_replication_slots` function\. Note the value in the active column\. Normally, this will return `t` \(true\), showing that replication is active\. If the query returns `f` \(false\), it's an indication that replication to the subscriber has stopped\. - - ``` - SELECT slot_name,plugin,slot_type,active FROM pg_replication_slots; - slot_name | plugin | slot_type | active - -------------------------------------------+------------------+-----------+-------- - pgl_labdb_docs_labcb4fa94_docs_lab3de412c | pglogical_output | logical | f - (1 row) - ``` - -**To check the subscriber node** - -On the subscriber node, you can check the status of replication in three different ways\. -+ Look through the PostgreSQL logs on the subscriber node to find failure messages\. The log identifies failure with messages that include exit code 1, as shown following\. - - ``` - 2022-07-06 16:17:03 UTC::@:[7361]:LOG: background worker "pglogical apply 16404:2880255011" (PID 14610) exited with exit code 1 - 2022-07-06 16:19:44 UTC::@:[7361]:LOG: background worker "pglogical apply 16404:2880255011" (PID 21783) exited with exit code 1 - ``` -+ Query the `pg_replication_origin` function\. Connect to the database on the subscriber node using `psql` and query the `pg_replication_origin` function, as follows\. - - ``` - SELECT * FROM pg_replication_origin; - roident | roname - ---------+-------- - (0 rows) - ``` - - The empty result set means that replication has been disrupted\. Normally, you see output such as the following\. - - ``` - roident | roname - ---------+---------------------------------------------------- - 1 | pgl_labdb_docs_labcb4fa94_docs_lab3de412c - (1 row) - ``` -+ Query the `pglogical.show_subscription_status` function as shown in the following example\. - - ``` - SELECT subscription_name,status,slot_name FROM pglogical.show_subscription_status(); - subscription_name | status | slot_name - ---====----------------+--------+------------------------------------- - docs_lab_subscription | down | pgl_labdb_docs_labcb4fa94_docs_lab3de412c - (1 row) - ``` - - This output shows that replication has been disrupted\. Its status is `down`\. Normally, the output shows the status as `replicating`\. - -If your logical replication process has been disrupted, you can re\-establish replication by following these steps\. - -**To reestablish logical replication between publisher and subscriber nodes** - -To re\-establish replication, you first disconnect the subscriber from the publisher node and then re\-establish the subscription, as outlined in these steps\. - -1. Connect to the subscriber node using `psql` as follows\. - - ``` - psql --host=222222222222.aws-region.rds.amazonaws.com --port=5432 --username=postgres --password --dbname=labdb - ``` - -1. Deactivate the subscription by using the `pglogical.alter_subscription_disable` function\. - - ``` - SELECT pglogical.alter_subscription_disable('docs_lab_subscription',true); - alter_subscription_disable - ---------------------------- - t - (1 row) - ``` - -1. Get the publisher node's identifier by querying the `pg_replication_origin`, as follows\. - - ``` - SELECT * FROM pg_replication_origin; - roident | roname - ---------+------------------------------------- - 1 | pgl_labdb_docs_labcb4fa94_docs_lab3de412c - (1 row) - ``` - -1. Use the response from the previous step with the `pg_replication_origin_create` command to assign the identifier that can be used by the subscription when re\-established\. - - ``` - SELECT pg_replication_origin_create('pgl_labdb_docs_labcb4fa94_docs_lab3de412c'); - pg_replication_origin_create - ------------------------------ - 1 - (1 row) - ``` - -1. Turn on the subscription by passing its name with a status of `true`, as shown in the following example\. - - ``` - SELECT pglogical.alter_subscription_enable('docs_lab_subscription',true); - alter_subscription_enable - --------------------------- - t - (1 row) - ``` - -Check the status of the node\. Its status should be `replicating` as shown in this example\. - -``` -SELECT subscription_name,status,slot_name - FROM pglogical.show_subscription_status(); - subscription_name | status | slot_name --------------------------------+-------------+------------------------------------- - docs_lab_subscription | replicating | pgl_labdb_docs_lab98f517b_docs_lab3de412c -(1 row) -``` - -Check the status of the subscriber's replication slot on the publisher node\. The slot's `active` column should return `t` \(true\), indicating that replication has been re\-established\. - -``` -SELECT slot_name,plugin,slot_type,active - FROM pg_replication_slots; - slot_name | plugin | slot_type | active --------------------------------------------+------------------+-----------+-------- - pgl_labdb_docs_lab98f517b_docs_lab3de412c | pglogical_output | logical | t -(1 row) -``` - -### Managing logical replication slots for RDS for PostgreSQL - -Before you can perform a major version upgrade on an RDS for PostgreSQL DB instance that's serving as a publisher node in a logical replication scenario, you must drop the replication slots on the instance\. The major version upgrade pre\-check process notifies you that the upgrade can't proceed until the slots are dropped\. - -To drop slots from your RDS for PostgreSQL DB instance, first drop the subscription and then drop the slot\. - -To identify replication slots that were created using the `pglogical` extension, log in to each database and get the name of the nodes\. When you query the subscriber node, you get both the publisher and the subscriber nodes in the output, as shown in this example\. - -``` -SELECT * FROM pglogical.node; -node_id | node_name -------------+------------------- - 2182738256 | docs_lab_target - 3410995529 | docs_lab_provider -(2 rows) -``` - -You can get the details about the subscription with the following query\. - -``` -SELECT sub_name,sub_slot_name,sub_target - FROM pglogical.subscription; - sub_name | sub_slot_name | sub_target -----------+--------------------------------+------------ - docs_lab_subscription | pgl_labdb_docs_labcb4fa94_docs_lab3de412c | 2182738256 -(1 row) -``` - -You can now drop the subscription, as follows\. - -``` -SELECT pglogical.drop_subscription(subscription_name := 'docs_lab_subscription'); - drop_subscription -------------------- - 1 -(1 row) -``` - -After dropping the subscription, you can delete the node\. - -``` -SELECT pglogical.drop_node(node_name := 'docs-lab-subscriber'); - drop_node ------------ - t -(1 row) -``` - -You can verify that the node no longer exists, as follows\. - -``` -SELECT * FROM pglogical.node; - node_id | node_name ----------+----------- -(0 rows) -``` - -### Parameter reference for the pglogical extension - -In the table you can find parameters associated with the `pglogical` extension\. Parameters such as `pglogical.conflict_log_level` and `pglogical.conflict_resolution` are used to handle update conflicts\. Conflicts can emerge when changes are made locally to the same tables that are subscribed to changes from the publisher\. Conflicts can also occur during various scenarios, such as two\-way replication or when multiple subscribers are replicating from the same publisher\. For more information, see [ PostgreSQL bi\-directional replication using pglogical](https://aws.amazon.com/blogs/database/postgresql-bi-directional-replication-using-pglogical/)\. - - -| Parameter | Description | -| --- | --- | -| pglogical\.batch\_inserts | Batch inserts if possible\. Not set by default\. Change to '1' to turn on, '0' to turn off\. | -| pglogical\.conflict\_log\_level | Sets the log level to use for logging resolved conflicts\. Supported string values are debug5, debug4, debug3, debug2, debug1, info, notice, warning, error, log, fatal, panic\. | -| pglogical\.conflict\_resolution | Sets method to use to resolve conflicts when conflicts are resolvable\. Supported string values are error, apply\_remote, keep\_local, last\_update\_wins, first\_update\_wins\. | -| pglogical\.extra\_connection\_options | Connection options to add to all peer node connections\. | -| pglogical\.synchronous\_commit | pglogical specific synchronous commit value | -| pglogical\.use\_spi | Use SPI \(server programming interface\) instead of low\-level API to apply changes\. Set to '1' to turn on, '0' to turn off\. For more information about SPI, see [Server Programming Interface](https://www.postgresql.org/docs/current/spi.html) in the PostgreSQL documentation\. | - -## Reducing bloat in tables and indexes with the pg\_repack extension - -You can use the pg\_repack extension to remove bloat from tables and indexes\. This extension is supported on RDS for PostgreSQL versions 9\.6\.3 and higher\. For more information on the pg\_repack extension, see the [GitHub project documentation](https://reorg.github.io/pg_repack/)\. - -**To use the pg\_repack extension** - -1. Install the pg\_repack extension on your RDS for PostgreSQL DB instance by running the following command\. - - ``` - CREATE EXTENSION pg_repack; - ``` - -1. Run the following commands to grant write access to repack temporary log tables created by pg\_repack\. - - ``` - ALTER DEFAULT PRIVILEGES IN SCHEMA repack GRANT INSERT ON TABLES TO PUBLIC; - ALTER DEFAULT PRIVILEGES IN SCHEMA repack GRANT USAGE, SELECT ON SEQUENCES TO PUBLIC; - ``` - -1. Connect to the database using the pg\_repack client utility\. Use an account that has `rds_superuser` privileges\. As an example, assume that `rds_test` role has `rds_superuser` privileges\. The command syntax is shown following\. - - ``` - pg_repack -h db-instance-name.111122223333.aws-region.rds.amazonaws.com -U rds_test -k postgres - ``` - - Connect using the \-k option\. The \-a option is not supported\. - -1. The response from the pg\_repack client provides information on the tables on the DB instance that are repacked\. - - ``` - INFO: repacking table "pgbench_tellers" - INFO: repacking table "pgbench_accounts" - INFO: repacking table "pgbench_branches" - ``` - -## Upgrading and using the PLV8 extension - -PLV8 is a trusted Javascript language extension for PostgreSQL\. You can use it for stored procedures, triggers, and other procedural code that's callable from SQL\. This language extension is supported by all current releases of PostgreSQL\. - -If you use [PLV8](https://plv8.github.io/) and upgrade PostgreSQL to a new PLV8 version, you immediately take advantage of the new extension\. Take the following steps to synchronize your catalog metadata with the new version of PLV8\. These steps are optional, but we highly recommend that you complete them to avoid metadata mismatch warnings\. - -The upgrade process drops all your existing PLV8 functions\. Thus, we recommend that you create a snapshot of your RDS for PostgreSQL DB instance before upgrading\. For more information, see [Creating a DB snapshot](USER_CreateSnapshot.md)\. - -**To synchronize your catalog metadata with a new version of PLV8** - -1. Verify that you need to update\. To do this, run the following command while connected to your instance\. - - ``` - SELECT * FROM pg_available_extensions WHERE name IN ('plv8','plls','plcoffee'); - ``` - - If your results contain values for an installed version that is a lower number than the default version, continue with this procedure to update your extensions\. For example, the following result set indicates that you should update\. - - ``` - name | default_version | installed_version | comment - --------+-----------------+-------------------+-------------------------------------------------- - plls | 2.1.0 | 1.5.3 | PL/LiveScript (v8) trusted procedural language - plcoffee| 2.1.0 | 1.5.3 | PL/CoffeeScript (v8) trusted procedural language - plv8 | 2.1.0 | 1.5.3 | PL/JavaScript (v8) trusted procedural language - (3 rows) - ``` - -1. Create a snapshot of your RDS for PostgreSQL DB instance if you haven't done so yet\. You can continue with the following steps while the snapshot is being created\. - -1. Get a count of the number of PLV8 functions in your DB instance so you can validate that they are all in place after the upgrade\. For example, the following SQL query returns the number of functions written in plv8, plcoffee, and plls\. - - ``` - SELECT proname, nspname, lanname - FROM pg_proc p, pg_language l, pg_namespace n - WHERE p.prolang = l.oid - AND n.oid = p.pronamespace - AND lanname IN ('plv8','plcoffee','plls'); - ``` - -1. Use pg\_dump to create a schema\-only dump file\. For example, create a file on your client machine in the `/tmp` directory\. - - ``` - ./pg_dump -Fc --schema-only -U master postgres >/tmp/test.dmp - ``` - - This example uses the following options: - + `-Fc` – Custom format - + \-\-schema\-only – Dump only the commands necessary to create schema \(functions in this case\) - + `-U` – The RDS master user name - + `database` – The database name for our DB instance - - For more information on pg\_dump, see [pg\_dump](https://www.postgresql.org/docs/current/static/app-pgdump.html ) in the PostgreSQL documentation\. - -1. Extract the "CREATE FUNCTION" DDL statement that is present in the dump file\. The following example uses the `grep` command to extract the DDL statement that creates the functions and save them to a file\. You use this in subsequent steps to recreate the functions\. - - ``` - ./pg_restore -l /tmp/test.dmp | grep FUNCTION > /tmp/function_list/ - ``` - - For more information on pg\_restore, see [pg\_restore](https://www.postgresql.org/docs/current/static/app-pgrestore.html) in the PostgreSQL documentation\. - -1. Drop the functions and extensions\. The following example drops any PLV8 based objects\. The cascade option ensures that any dependent are dropped\. - - ``` - DROP EXTENSION plv8 CASCADE; - ``` - - If your PostgreSQL instance contains objects based on plcoffee or plls, repeat this step for those extensions\. - -1. Create the extensions\. The following example creates the plv8, plcoffee, and plls extensions\. - - ``` - CREATE EXTENSION plv8; - CREATE EXTENSION plcoffee; - CREATE EXTENSION plls; - ``` - -1. Create the functions using the dump file and "driver" file\. - - The following example recreates the functions that you extracted previously\. - - ``` - ./pg_restore -U master -d postgres -Fc -L /tmp/function_list /tmp/test.dmp - ``` - -1. Verify that all your functions have been recreated by using the following query\. - - ``` - SELECT * FROM pg_available_extensions WHERE name IN ('plv8','plls','plcoffee'); - ``` - - The PLV8 version 2 adds the following extra row to your result set: - - ``` - proname | nspname | lanname - ---------------+------------+---------- - plv8_version | pg_catalog | plv8 - ``` - -## Using PL/Rust to write PostgreSQL functions in the Rust language - -PL/Rust is a trusted Rust language extension for PostgreSQL\. You can use it for stored procedures, functions, and other procedural code that's callable from SQL\. This language extension is supported by PostgreSQL 15\.2\-R2 and higher\. For more information, see [PL/Rust](https://github.com/tcdi/plrust#readme) on GitHub\. - -**Topics** -+ [Setting up PL/Rust](#PL_Rust-setting-up) -+ [Creating functions with PL/Rust](#PL_Rust-create-function) -+ [PL/Rust limitations](#PL_Rust-limitations) - -### Setting up PL/Rust - -To install the plrust extension on your DB instance, add plrust to the `shared_preload_libraries` parameter in the DB parameter group associated with your DB instance\. With the plrust extension installed, you can create functions\. - -To modify the `shared_preload_libraries` parameter, your DB instance must be associated with a custom parameter group\. For information about creating a custom DB parameter group, see [Working with parameter groups](USER_WorkingWithParamGroups.md)\. - -You can install the plrust extension using the AWS Management Console or the AWS CLI\. - -The following steps assume that your DB instance is associated with a custom DB parameter group\. - -#### Console - -**Install the plrust extension in the `shared_preload_libraries` parameter** - -Complete the following steps using an account that is a member of the `rds_superuser` group \(role\)\. - -1. Sign in to the AWS Management Console and open the Amazon RDS console at [https://console\.aws\.amazon\.com/rds/](https://console.aws.amazon.com/rds/)\. - -1. In the navigation pane, choose **Databases**\. - -1. Choose the name of your DB instance to display its details\. - -1. Open the **Configuration** tab for your DB instance and find the DB instance parameter group link\. - -1. Choose the link to open the custom parameters associated with your DB instance\. - -1. In the **Parameters** search field, type `shared_pre` to find the **`shared_preload_libraries`** parameter\. - -1. Choose **Edit parameters** to access the property values\. - -1. Add plrust to the list in the **Values** field\. Use a comma to separate items in the list of values\. - -1. Reboot the DB instance so that your change to the `shared_preload_libraries` parameter takes effect\. The initial reboot may require additional time to complete\. - -1. When the instance is available, verify that plrust has been initialized\. Use `psql` to connect to the DB instance, and then run the following command\. - - ``` - SHOW shared_preload_libraries; - ``` - - Your output should look similar to the following: - - ``` - shared_preload_libraries - -------------------------- - rdsutils,plrust - (1 row) - ``` - -#### AWS CLI - -**Install the plrust extension in the shared\_preload\_libraries parameter** - -Complete the following steps using an account that is a member of the `rds_superuser` group \(role\)\. - -1. Use the [modify\-db\-parameter\-group](https://docs.aws.amazon.com/cli/latest/reference/rds/modify-db-parameter-group.html) AWS CLI command to add plrust to the `shared_preload_libraries` parameter\. - - ``` - aws rds modify-db-parameter-group \ - --db-parameter-group-name custom-param-group-name \ - --parameters "ParameterName=shared_preload_libraries,ParameterValue=plrust,ApplyMethod=pending-reboot" \ - --region aws-region - ``` - -1. Use the [reboot\-db\-instance](https://docs.aws.amazon.com/cli/latest/reference/rds/reboot-db-instance) AWS CLI command to reboot the DB instance and initialize the plrust library\. The initial reboot may require additional time to complete\. - - ``` - aws rds reboot-db-instance \ - --db-instance-identifier your-instance \ - --region aws-region - ``` - -1. When the instance is available, you can verify that plrust has been initialized\. Use `psql` to connect to the DB instance, and then run the following command\. - - ``` - SHOW shared_preload_libraries; - ``` - - Your output should look similar to the following: - - ``` - shared_preload_libraries - -------------------------- - rdsutils,plrust - (1 row) - ``` - -### Creating functions with PL/Rust - -PL/Rust will compile the function as a dynamic library, load it, and execute it\. - -The following Rust function filters multiples out of an array\. - -``` -postgres=> CREATE LANGUAGE plrust; -CREATE EXTENSION -``` - -``` -CREATE OR REPLACE FUNCTION filter_multiples(a BIGINT[], multiple BIGINT) RETURNS BIGINT[] - IMMUTABLE STRICT - LANGUAGE PLRUST AS -$$ - Ok(Some(a.into_iter().filter(|x| x.unwrap() % multiple != 0).collect())) -$$; - -WITH gen_values AS ( -SELECT ARRAY(SELECT * FROM generate_series(1,100)) as arr) -SELECT filter_multiples(arr, 3) -from gen_values; -``` - -### PL/Rust limitations -+ By default, database users can't use PL/Rust\. To provide access to PL/Rust, connect as a user with rds\_superuser privilege, and run the following command: - - ``` - postgres=> GRANT USAGE ON LANGUAGE PLRUST TO user; - ``` -+ The RDS environment doesn't support crates at this time\. Specifying crates results in an error\. \ No newline at end of file diff --git a/doc_source/Appendix.PostgreSQL.CommonDBATasks.Parameters.md b/doc_source/Appendix.PostgreSQL.CommonDBATasks.Parameters.md deleted file mode 100644 index 5cbeb08..0000000 --- a/doc_source/Appendix.PostgreSQL.CommonDBATasks.Parameters.md +++ /dev/null @@ -1,253 +0,0 @@ -# Working with parameters on your RDS for PostgreSQL DB instance - -In some cases, you might create an RDS for PostgreSQL DB instance without specifying a custom parameter group\. If so, your DB instance is created using the default parameter group for the version of PostgreSQL that you choose\. For example, suppose that you create an RDS for PostgreSQL DB instance using PostgreSQL 13\.3\. In this case, the DB instance is created using the values in the parameter group for PostgreSQL 13 releases, `default.postgres13`\. - -You can also create your own custom DB parameter group\. You need to do this if you want to modify any settings for the RDS for PostgreSQL DB instance from their default values\. To learn how, see [Working with parameter groups](USER_WorkingWithParamGroups.md)\. - -You can track the settings on your RDS for PostgreSQL DB instance in several different ways\. You can use the AWS Management Console, the AWS CLI, or the Amazon RDS API\. You can also query the values from the PostgreSQL `pg_settings` table of your instance, as shown following\. - -``` -SELECT name, setting, boot_val, reset_val, unit - FROM pg_settings - ORDER BY name; -``` - -To learn more about the values returned from this query, see [https://www.postgresql.org/docs/current/view-pg-settings.html](https://www.postgresql.org/docs/current/view-pg-settings.html) in the PostgreSQL documentation\. - -Be especially careful when changing the settings for `max_connections` and `shared_buffers` on your RDS for PostgreSQL DB instance\. For example, suppose that you modify settings for `max_connections` or `shared_buffers` and you use values that are too high for your actual workload\. In this case, your RDS for PostgreSQL DB instance won't start\. If this happens, you see an error such as the following in the `postgres.log`\. - -``` -2018-09-18 21:13:15 UTC::@:[8097]:FATAL: could not map anonymous shared memory: Cannot allocate memory -2018-09-18 21:13:15 UTC::@:[8097]:HINT: This error usually means that PostgreSQL's request for a shared memory segment -exceeded available memory or swap space. To reduce the request size (currently 3514134274048 bytes), reduce -PostgreSQL's shared memory usage, perhaps by reducing shared_buffers or max_connections. -``` - -However, you can't change any values of the settings contained in the default RDS for PostgreSQL DB parameter groups\. To change settings for any parameters, first create a custom DB parameter group\. Then change the settings in that custom group, and then apply the custom parameter group to your RDS for PostgreSQL DB instance\. To learn more, see [Working with parameter groups](USER_WorkingWithParamGroups.md)\. - -There are two types of RDS for PostgreSQL DB parameters\. -+ **Static parameters** – Static parameters require that the RDS for PostgreSQL DB instance be rebooted after a change so that the new value can take effect\. -+ **Dynamic parameters** – Dynamic parameters don't require a reboot after changing their settings\. - -**Note** -If your RDS for PostgreSQL DB instance is using your own custom DB parameter group, you can change the values of dynamic parameters on the running DB instance\. You can do this by using the AWS Management Console, the AWS CLI, or the Amazon RDS API\. - -If you have privileges to do so, you can also change parameter values by using the `ALTER DATABASE`, `ALTER ROLE`, and `SET` commands\. - -## RDS for PostgreSQL DB instance parameter list - -The following table lists some \(but not all\) parameters available in an RDS for PostgreSQL DB instance\. To view all available parameters, you use the [describe\-db\-parameters](https://docs.aws.amazon.com/cli/latest/reference/rds/describe-db-parameters.html) AWS CLI command\. For example, to get the list of all parameters available in the default parameter group for RDS for PostgreSQL version 13, run the following\. - -``` -aws rds describe-db-parameters --db-parameter-group-name default.postgres13 -``` - -You can also use the Console\. Choose **Parameter groups** from the Amazon RDS menu, and then choose the parameter group from those available in your AWS Region\. - - -| Parameter name | Apply\_Type | Description | -| --- | --- | --- | -| `application_name` | Dynamic | Sets the application name to be reported in statistics and logs\. | -| `archive_command` | Dynamic | Sets the shell command that will be called to archive a WAL file\. | -| `array_nulls` | Dynamic | Enables input of NULL elements in arrays\. | -| `authentication_timeout` | Dynamic | Sets the maximum allowed time to complete client authentication\. | -| `autovacuum` | Dynamic | Starts the autovacuum subprocess\. | -| `autovacuum_analyze_scale_factor` | Dynamic | Number of tuple inserts, updates, or deletes before analyze as a fraction of reltuples\. | -| `autovacuum_analyze_threshold` | Dynamic | Minimum number of tuple inserts, updates, or deletes before analyze\. | -| `autovacuum_freeze_max_age` | Static | Age at which to autovacuum a table to prevent transaction ID wraparound\. | -| `autovacuum_naptime` | Dynamic | Time to sleep between autovacuum runs\. | -| `autovacuum_max_workers` | Static | Sets the maximum number of simultaneously running autovacuum worker processes\. | -| `autovacuum_vacuum_cost_delay` | Dynamic | Vacuum cost delay, in milliseconds, for autovacuum\. | -| `autovacuum_vacuum_cost_limit` | Dynamic | Vacuum cost amount available before napping, for autovacuum\. | -| `autovacuum_vacuum_scale_factor` | Dynamic | Number of tuple updates or deletes before vacuum as a fraction of reltuples\. | -| `autovacuum_vacuum_threshold` | Dynamic | Minimum number of tuple updates or deletes before vacuum\. | -| `backslash_quote` | Dynamic | Sets whether a backslash \(\\\) is allowed in string literals\. | -| `bgwriter_delay` | Dynamic | Background writer sleep time between rounds\. | -| `bgwriter_lru_maxpages` | Dynamic | Background writer maximum number of LRU pages to flush per round\. | -| `bgwriter_lru_multiplier` | Dynamic | Multiple of the average buffer usage to free per round\. | -| `bytea_output` | Dynamic | Sets the output format for bytes\. | -| `check_function_bodies` | Dynamic | Checks function bodies during CREATE FUNCTION\. | -| `checkpoint_completion_target` | Dynamic | Time spent flushing dirty buffers during checkpoint, as a fraction of the checkpoint interval\. | -| `checkpoint_segments` | Dynamic | Sets the maximum distance in log segments between automatic write\-ahead log \(WAL\) checkpoints\. | -| `checkpoint_timeout` | Dynamic | Sets the maximum time between automatic WAL checkpoints\. | -| `checkpoint_warning` | Dynamic | Enables warnings if checkpoint segments are filled more frequently than this\. | -| `client_encoding` | Dynamic | Sets the client's character set encoding\. | -| `client_min_messages` | Dynamic | Sets the message levels that are sent to the client\. | -| `commit_delay` | Dynamic | Sets the delay in microseconds between transaction commit and flushing WAL to disk\. | -| `commit_siblings` | Dynamic | Sets the minimum concurrent open transactions before performing commit\_delay\. | -| `constraint_exclusion` | Dynamic | Enables the planner to use constraints to optimize queries\. | -| `cpu_index_tuple_cost` | Dynamic | Sets the planner's estimate of the cost of processing each index entry during an index scan\. | -| `cpu_operator_cost` | Dynamic | Sets the planner's estimate of the cost of processing each operator or function call\. | -| `cpu_tuple_cost` | Dynamic | Sets the planner's estimate of the cost of processing each tuple \(row\)\. | -| `cursor_tuple_fraction` | Dynamic | Sets the planner's estimate of the fraction of a cursor's rows that will be retrieved\. | -| `datestyle` | Dynamic | Sets the display format for date and time values\. | -| `deadlock_timeout` | Dynamic | Sets the time to wait on a lock before checking for deadlock\. | -| `debug_pretty_print` | Dynamic | Indents parse and plan tree displays\. | -| `debug_print_parse` | Dynamic | Logs each query's parse tree\. | -| `debug_print_plan` | Dynamic | Logs each query's execution plan\. | -| `debug_print_rewritten` | Dynamic | Logs each query's rewritten parse tree\. | -| `default_statistics_target` | Dynamic | Sets the default statistics target\. | -| `default_tablespace` | Dynamic | Sets the default tablespace to create tables and indexes in\. | -| `default_transaction_deferrable` | Dynamic | Sets the default deferrable status of new transactions\. | -| `default_transaction_isolation` | Dynamic | Sets the transaction isolation level of each new transaction\. | -| `default_transaction_read_only` | Dynamic | Sets the default read\-only status of new transactions\. | -| `default_with_oids` | Dynamic | Creates new tables with object IDs \(OIDs\) by default\. | -| `effective_cache_size` | Dynamic | Sets the planner's assumption about the size of the disk cache\. | -| `effective_io_concurrency` | Dynamic | Number of simultaneous requests that can be handled efficiently by the disk subsystem\. | -| `enable_bitmapscan` | Dynamic | Enables the planner's use of bitmap\-scan plans\. | -| `enable_hashagg` | Dynamic | Enables the planner's use of hashed aggregation plans\. | -| `enable_hashjoin` | Dynamic | Enables the planner's use of hash join plans\. | -| `enable_indexscan` | Dynamic | Enables the planner's use of index\-scan plans\. | -| `enable_material` | Dynamic | Enables the planner's use of materialization\. | -| `enable_mergejoin` | Dynamic | Enables the planner's use of merge join plans\. | -| `enable_nestloop` | Dynamic | Enables the planner's use of nested\-loop join plans\. | -| `enable_seqscan` | Dynamic | Enables the planner's use of sequential\-scan plans\. | -| `enable_sort` | Dynamic | Enables the planner's use of explicit sort steps\. | -| `enable_tidscan` | Dynamic | Enables the planner's use of TID scan plans\. | -| `escape_string_warning` | Dynamic | Warns about backslash \(\\\) escapes in ordinary string literals\. | -| `extra_float_digits` | Dynamic | Sets the number of digits displayed for floating\-point values\. | -| `from_collapse_limit` | Dynamic | Sets the FROM\-list size beyond which subqueries are not collapsed\. | -| `fsync` | Dynamic | Forces synchronization of updates to disk\. | -| `full_page_writes` | Dynamic | Writes full pages to WAL when first modified after a checkpoint\. | -| `geqo` | Dynamic | Enables genetic query optimization\. | -| `geqo_effort` | Dynamic | GEQO: effort is used to set the default for other GEQO parameters\. | -| `geqo_generations` | Dynamic | GEQO: number of iterations of the algorithm\. | -| `geqo_pool_size` | Dynamic | GEQO: number of individuals in the population\. | -| `geqo_seed` | Dynamic | GEQO: seed for random path selection\. | -| `geqo_selection_bias` | Dynamic | GEQO: selective pressure within the population\. | -| `geqo_threshold` | Dynamic | Sets the threshold of FROM items beyond which GEQO is used\. | -| `gin_fuzzy_search_limit` | Dynamic | Sets the maximum allowed result for exact search by GIN\. | -| `hot_standby_feedback` | Dynamic | Determines whether a hot standby sends feedback messages to the primary or upstream standby\. | -| `intervalstyle` | Dynamic | Sets the display format for interval values\. | -| `join_collapse_limit` | Dynamic | Sets the FROM\-list size beyond which JOIN constructs are not flattened\. | -| `lc_messages` | Dynamic | Sets the language in which messages are displayed\. | -| `lc_monetary` | Dynamic | Sets the locale for formatting monetary amounts\. | -| `lc_numeric` | Dynamic | Sets the locale for formatting numbers\. | -| `lc_time` | Dynamic | Sets the locale for formatting date and time values\. | -| `log_autovacuum_min_duration` | Dynamic | Sets the minimum running time above which autovacuum actions will be logged\. | -| `log_checkpoints` | Dynamic | Logs each checkpoint\. | -| `log_connections` | Dynamic | Logs each successful connection\. | -| `log_disconnections` | Dynamic | Logs end of a session, including duration\. | -| `log_duration` | Dynamic | Logs the duration of each completed SQL statement\. | -| `log_error_verbosity` | Dynamic | Sets the verbosity of logged messages\. | -| `log_executor_stats` | Dynamic | Writes executor performance statistics to the server log\. | -| `log_filename` | Dynamic | Sets the file name pattern for log files\. | -| `log_file_mode` | Dynamic | Sets file permissions for log files\. Default value is 0644\. | -| `log_hostname` | Dynamic | Logs the host name in the connection logs\. As of PostgreSQL 12 and later versions, this parameter is 'off' by default\. When turned on, the connection uses DNS reverse\-lookup to get the hostname that gets captured to the connection logs\. If you turn on this parameter, you should monitor the impact that it has on the time it takes to establish connections\. | -| `log_line_prefix ` | Dynamic | Controls information prefixed to each log line\. | -| `log_lock_waits` | Dynamic | Logs long lock waits\. | -| `log_min_duration_statement` | Dynamic | Sets the minimum running time above which statements will be logged\. | -| `log_min_error_statement` | Dynamic | Causes all statements generating an error at or above this level to be logged\. | -| `log_min_messages` | Dynamic | Sets the message levels that are logged\. | -| `log_parser_stats` | Dynamic | Writes parser performance statistics to the server log\. | -| `log_planner_stats` | Dynamic | Writes planner performance statistics to the server log\. | -| `log_rotation_age` | Dynamic | Automatic log file rotation will occur after N minutes\. | -| `log_rotation_size` | Dynamic | Automatic log file rotation will occur after N kilobytes\. | -| `log_statement` | Dynamic | Sets the type of statements logged\. | -| `log_statement_stats` | Dynamic | Writes cumulative performance statistics to the server log\. | -| `log_temp_files` | Dynamic | Logs the use of temporary files larger than this number of kilobytes\. | -| `log_timezone` | Dynamic | Sets the time zone to use in log messages\. | -| `log_truncate_on_rotation` | Dynamic | Truncate existing log files of same name during log rotation\. | -| `logging_collector` | Static | Start a subprocess to capture stderr output and/or csvlogs into log files\. | -| `maintenance_work_mem` | Dynamic | Sets the maximum memory to be used for maintenance operations\. | -| `max_connections` | Static | Sets the maximum number of concurrent connections\. | -| `max_files_per_process` | Static | Sets the maximum number of simultaneously open files for each server process\. | -| `max_locks_per_transaction` | Static | Sets the maximum number of locks per transaction\. | -| `max_pred_locks_per_transaction` | Static | Sets the maximum number of predicate locks per transaction\. | -| `max_prepared_transactions` | Static | Sets the maximum number of simultaneously prepared transactions\. | -| `max_stack_depth` | Dynamic | Sets the maximum stack depth, in kilobytes\. | -| `max_standby_archive_delay` | Dynamic | Sets the maximum delay before canceling queries when a hot standby server is processing archived WAL data\. | -| `max_standby_streaming_delay` | Dynamic | Sets the maximum delay before canceling queries when a hot standby server is processing streamed WAL data\. | -| max\_wal\_size | Dynamic | Sets the WAL size \(MB\) that triggers a checkpoint\. For all versions after RDS for PostgreSQL 10, the default is at least 1 GB \(1024 MB\)\. For example, max\_wal\_size setting for RDS for PostgreSQL 14 is 2 GB \(2048 MB\)\. Use the SHOW max\_wal\_size; command on your RDS for PostgreSQL DB instance to see its current value\. | -| min\_wal\_size | Dynamic | Sets the minimum size to shrink the WAL to\. For PostgreSQL version 9\.6 and earlier, min\_wal\_size is in units of 16 MB\. For PostgreSQL version 10 and later, min\_wal\_size is in units of 1 MB\. | -| `quote_all_identifiers` | Dynamic | Adds quotes \("\) to all identifiers when generating SQL fragments\. | -| `random_page_cost` | Dynamic | Sets the planner's estimate of the cost of a non\-sequentially fetched disk page\. This parameter has no value unless query plan management \(QPM\) is turned on\. When QPM is on, the default value for this parameter 4\. | -| rds\.adaptive\_autovacuum | Dynamic | Automatically tunes the autovacuum parameters whenever the transaction ID thresholds are exceeded\. | -| rds\.force\_ssl | Dynamic | Requires the use of SSL connections\. The default value is set to 1 \(on\) for RDS for PostgreSQL version 15\. All other RDS for PostgreSQL major version 14 and older have the default value set to 0 \(off\)\. | -| `rds.log_retention_period` | Dynamic | Sets log retention such that Amazon RDS deletes PostgreSQL logs that are older than n minutes\. | -| rds\.restrict\_password\_commands | Static | Restricts who can manage passwords to users with the rds\_password role\. Set this parameter to 1 to enable password restriction\. The default is 0\. | -| `search_path` | Dynamic | Sets the schema search order for names that are not schema\-qualified\. | -| `seq_page_cost` | Dynamic | Sets the planner's estimate of the cost of a sequentially fetched disk page\. | -| `session_replication_role` | Dynamic | Sets the sessions behavior for triggers and rewrite rules\. | -| `shared_buffers` | Static | Sets the number of shared memory buffers used by the server\. | -| `shared_preload_libraries ` | Static | Lists the shared libraries to preload into the RDS for PostgreSQL DB instance\. Supported values include auto\_explain, orafce, pgaudit, pglogical, pg\_bigm, pg\_cron, pg\_hint\_plan, pg\_prewarm, pg\_similarity, pg\_stat\_statements, pg\_transport, and plprofiler\. | -| `ssl` | Dynamic | Enables SSL connections\. | -| `sql_inheritance` | Dynamic | Causes subtables to be included by default in various commands\. | -| `ssl_renegotiation_limit` | Dynamic | Sets the amount of traffic to send and receive before renegotiating the encryption keys\. | -| `standard_conforming_strings` | Dynamic | Causes \.\.\. strings to treat backslashes literally\. | -| `statement_timeout` | Dynamic | Sets the maximum allowed duration of any statement\. | -| `synchronize_seqscans` | Dynamic | Enables synchronized sequential scans\. | -| `synchronous_commit` | Dynamic | Sets the current transactions synchronization level\. | -| `tcp_keepalives_count` | Dynamic | Maximum number of TCP keepalive retransmits\. | -| `tcp_keepalives_idle` | Dynamic | Time between issuing TCP keepalives\. | -| `tcp_keepalives_interval` | Dynamic | Time between TCP keepalive retransmits\. | -| `temp_buffers` | Dynamic | Sets the maximum number of temporary buffers used by each session\. | -| temp\_file\_limit | Dynamic | Sets the maximum size in KB to which the temporary files can grow\. | -| `temp_tablespaces` | Dynamic | Sets the tablespaces to use for temporary tables and sort files\. | -| `timezone` | Dynamic | Sets the time zone for displaying and interpreting time stamps\. The Internet Assigned Numbers Authority \(IANA\) publishes new time zones at [ https://www\.iana\.org/time\-zones](https://www.iana.org/time-zones) several times a year\. Every time RDS releases a new minor maintenance release of PostgreSQL, it ships with the latest time zone data at the time of the release\. When you use the latest RDS for PostgreSQL versions, you have recent time zone data from RDS\. To ensure that your DB instance has recent time zone data, we recommend upgrading to a higher DB engine version\. You can't modify the time zone tables in PostgreSQL DB instances manually\. RDS doesn't modify or reset the time zone data of running DB instances\. New time zone data is installed only when you perform a database engine version upgrade\. | -| `track_activities` | Dynamic | Collects information about running commands\. | -| `track_activity_query_size` | Static | Sets the size reserved for pg\_stat\_activity\.current\_query, in bytes\. | -| `track_counts` | Dynamic | Collects statistics on database activity\. | -| `track_functions` | Dynamic | Collects function\-level statistics on database activity\. | -| `track_io_timing` | Dynamic | Collects timing statistics on database I/O activity\. | -| `transaction_deferrable` | Dynamic | Indicates whether to defer a read\-only serializable transaction until it can be started with no possible serialization failures\. | -| `transaction_isolation` | Dynamic | Sets the current transactions isolation level\. | -| `transaction_read_only` | Dynamic | Sets the current transactions read\-only status\. | -| `transform_null_equals` | Dynamic | Treats expr=NULL as expr IS NULL\. | -| `update_process_title` | Dynamic | Updates the process title to show the active SQL command\. | -| `vacuum_cost_delay` | Dynamic | Vacuum cost delay in milliseconds\. | -| `vacuum_cost_limit` | Dynamic | Vacuum cost amount available before napping\. | -| `vacuum_cost_page_dirty` | Dynamic | Vacuum cost for a page dirtied by vacuum\. | -| `vacuum_cost_page_hit` | Dynamic | Vacuum cost for a page found in the buffer cache\. | -| `vacuum_cost_page_miss` | Dynamic | Vacuum cost for a page not found in the buffer cache\. | -| `vacuum_defer_cleanup_age` | Dynamic | Number of transactions by which vacuum and hot cleanup should be deferred, if any\. | -| `vacuum_freeze_min_age` | Dynamic | Minimum age at which vacuum should freeze a table row\. | -| `vacuum_freeze_table_age` | Dynamic | Age at which vacuum should scan a whole table to freeze tuples\. | -| `wal_buffers` | Static | Sets the number of disk\-page buffers in shared memory for WAL\. | -| `wal_writer_delay` | Dynamic | WAL writer sleep time between WAL flushes\. | -| `work_mem` | Dynamic | Sets the maximum memory to be used for query workspaces\. | -| `xmlbinary` | Dynamic | Sets how binary values are to be encoded in XML\. | -| `xmloption` | Dynamic | Sets whether XML data in implicit parsing and serialization operations is to be considered as documents or content fragments\. | - -Amazon RDS uses the default PostgreSQL units for all parameters\. The following table shows the PostgreSQL default unit and value for each parameter\. - - -| Parameter name | Unit | -| --- | --- | -| `archive_timeout` | s | -| `authentication_timeout` | s | -| `autovacuum_naptime` | s | -| `autovacuum_vacuum_cost_delay` | ms | -| `bgwriter_delay` | ms | -| `checkpoint_timeout` | s | -| `checkpoint_warning` | s | -| `deadlock_timeout` | ms | -| `effective_cache_size` | 8 KB | -| `lock_timeout` | ms | -| `log_autovacuum_min_duration` | ms | -| `log_min_duration_statement` | ms | -| `log_rotation_age` | minutes | -| `log_rotation_size` | KB | -| `log_temp_files` | KB | -| `maintenance_work_mem` | KB | -| `max_stack_depth` | KB | -| `max_standby_archive_delay` | ms | -| `max_standby_streaming_delay` | ms | -| `post_auth_delay` | s | -| `pre_auth_delay` | s | -| `segment_size` | 8 KB | -| `shared_buffers` | 8 KB | -| `statement_timeout` | ms | -| `ssl_renegotiation_limit` | KB | -| `tcp_keepalives_idle` | s | -| `tcp_keepalives_interval` | s | -| `temp_file_limit` | KB | -| `work_mem` | KB | -| `temp_buffers` | 8 KB | -| `vacuum_cost_delay` | ms | -| `wal_buffers` | 8 KB | -| `wal_receiver_timeout` | ms | -| `wal_segment_size` | 8 KB | -| `wal_sender_timeout` | ms | -| `wal_writer_delay` | ms | -| `wal_receiver_status_interval` | s | \ No newline at end of file diff --git a/doc_source/Appendix.PostgreSQL.CommonDBATasks.PostGIS.md b/doc_source/Appendix.PostgreSQL.CommonDBATasks.PostGIS.md deleted file mode 100644 index 2e3abc1..0000000 --- a/doc_source/Appendix.PostgreSQL.CommonDBATasks.PostGIS.md +++ /dev/null @@ -1,346 +0,0 @@ -# Managing spatial data with the PostGIS extension - -PostGIS is an extension to PostgreSQL for storing and managing spatial information\. To learn more about PostGIS, see [PostGIS\.net](https://postgis.net/)\. - -Starting with version 10\.5, PostgreSQL supports the libprotobuf 1\.3\.0 library used by PostGIS for working with map box vector tile data\. - -Setting up the PostGIS extension requires `rds_superuser` privileges\. We recommend that you create a user \(role\) to manage the PostGIS extension and your spatial data\. The PostGIS extension and its related components add thousands of functions to PostgreSQL\. Consider creating the PostGIS extension in its own schema if that makes sense for your use case\. The following example shows how to install the extension in its own database, but this isn't required\. - -**Topics** -+ [Step 1: Create a user \(role\) to manage the PostGIS extension](#Appendix.PostgreSQL.CommonDBATasks.PostGIS.Connect) -+ [Step 2: Load the PostGIS extensions](#Appendix.PostgreSQL.CommonDBATasks.PostGIS.LoadExtensions) -+ [Step 3: Transfer ownership of the extensions](#Appendix.PostgreSQL.CommonDBATasks.PostGIS.TransferOwnership) -+ [Step 4: Transfer ownership of the PostGIS objects](#Appendix.PostgreSQL.CommonDBATasks.PostGIS.TransferObjects) -+ [Step 5: Test the extensions](#Appendix.PostgreSQL.CommonDBATasks.PostGIS.Test) -+ [Step 6: Upgrade the PostGIS extension](#Appendix.PostgreSQL.CommonDBATasks.PostGIS.Update) -+ [PostGIS extension versions](#CHAP_PostgreSQL.Extensions.PostGIS) -+ [Upgrading PostGIS 2 to PostGIS 3](#PostgreSQL.Extensions.PostGIS.versions.upgrading.2-to-3) - -## Step 1: Create a user \(role\) to manage the PostGIS extension - -First, connect to your RDS for PostgreSQL DB instance as a user that has `rds_superuser` privileges\. If you kept the default name when you set up your instance, you connect as `postgres`\. - -``` -psql --host=111122223333.aws-region.rds.amazonaws.com --port=5432 --username=postgres --password -``` - -Create a separate role \(user\) to administer the PostGIS extension\. - -``` -postgres=> CREATE ROLE gis_admin LOGIN PASSWORD 'change_me'; -CREATE ROLE -``` - -Grant this role `rds_superuser` privileges, to allow the role to install the extension\. - -``` -postgres=> GRANT rds_superuser TO gis_admin; -GRANT -``` - -Create a database to use for your PostGIS artifacts\. This step is optional\. Or you can create a schema in your user database for the PostGIS extensions, but this also isn't required\. - -``` -postgres=> CREATE DATABASE lab_gis; -CREATE DATABASE -``` - -Give the `gis_admin` all privileges on the `lab_gis` database\. - -``` -postgres=> GRANT ALL PRIVILEGES ON DATABASE lab_gis TO gis_admin; -GRANT -``` - -Exit the session and reconnect to your RDS for PostgreSQL DB instance as `gis_admin`\. - -``` -postgres=> psql --host=111122223333.aws-region.rds.amazonaws.com --port=5432 --username=gis_admin --password --dbname=lab_gis -Password for user gis_admin:... -lab_gis=> -``` - -Continue setting up the extension as detailed in the next steps\. - -## Step 2: Load the PostGIS extensions - -The PostGIS extension includes several related extensions that work together to provide geospatial functionality\. Depending on your use case, you might not need all the extensions created in this step\. - -Use `CREATE EXTENSION` statements to load the PostGIS extensions\. - -``` -CREATE EXTENSION postgis; -CREATE EXTENSION -CREATE EXTENSION postgis_raster; -CREATE EXTENSION -CREATE EXTENSION postgis_tiger_geocoder; -CREATE EXTENSION -CREATE EXTENSION postgis_topology; -CREATE EXTENSION -CREATE EXTENSION fuzzystrmatch; -CREATE EXTENSION -CREATE EXTENSION address_standardizer_data_us; -CREATE EXTENSION -``` - -You can verify the results by running the SQL query shown in the following example, which lists the extensions and their owners\. - -``` -SELECT n.nspname AS "Name", - pg_catalog.pg_get_userbyid(n.nspowner) AS "Owner" - FROM pg_catalog.pg_namespace n - WHERE n.nspname !~ '^pg_' AND n.nspname <> 'information_schema' - ORDER BY 1; -List of schemas - Name | Owner ---------------+----------- - public | postgres - tiger | rdsadmin - tiger_data | rdsadmin - topology | rdsadmin -(4 rows) -``` - -## Step 3: Transfer ownership of the extensions - -Use the ALTER SCHEMA statements to transfer ownership of the schemas to the `gis_admin` role\. - -``` -ALTER SCHEMA tiger OWNER TO gis_admin; -ALTER SCHEMA -ALTER SCHEMA tiger_data OWNER TO gis_admin; -ALTER SCHEMA -ALTER SCHEMA topology OWNER TO gis_admin; -ALTER SCHEMA -``` - -You can confirm the ownership change by running the following SQL query\. Or you can use the `\dn` metacommand from the psql command line\. - -``` -SELECT n.nspname AS "Name", - pg_catalog.pg_get_userbyid(n.nspowner) AS "Owner" - FROM pg_catalog.pg_namespace n - WHERE n.nspname !~ '^pg_' AND n.nspname <> 'information_schema' - ORDER BY 1; - - List of schemas - Name | Owner ---------------+--------------- - public | postgres - tiger | gis_admin - tiger_data | gis_admin - topology | gis_admin -(4 rows) -``` - -## Step 4: Transfer ownership of the PostGIS objects - -Use the following function to transfer ownership of the PostGIS objects to the `gis_admin` role\. Run the following statement from the psql prompt to create the function\. - -``` -CREATE FUNCTION exec(text) returns text language plpgsql volatile AS $f$ BEGIN EXECUTE $1; RETURN $1; END; $f$; -CREATE FUNCTION -``` - -Next, run the following query to run the `exec` function that in turn runs the statements and alters the permissions\. - -``` -SELECT exec('ALTER TABLE ' || quote_ident(s.nspname) || '.' || quote_ident(s.relname) || ' OWNER TO gis_admin;') - FROM ( - SELECT nspname, relname - FROM pg_class c JOIN pg_namespace n ON (c.relnamespace = n.oid) - WHERE nspname in ('tiger','topology') AND - relkind IN ('r','S','v') ORDER BY relkind = 'S') -s; -``` - -## Step 5: Test the extensions - -To avoid needing to specify the schema name, add the `tiger` schema to your search path using the following command\. - -``` -SET search_path=public,tiger; -SET -``` - -Test the `tiger` schema by using the following SELECT statement\. - -``` -SELECT address, streetname, streettypeabbrev, zip - FROM normalize_address('1 Devonshire Place, Boston, MA 02109') AS na; -address | streetname | streettypeabbrev | zip ----------+------------+------------------+------- - 1 | Devonshire | Pl | 02109 -(1 row) -``` - -To learn more about this extension, see [Tiger Geocoder](https://postgis.net/docs/Extras.html#Tiger_Geocoder) in the PostGIS documentation\. - -Test access to the `topology` schema by using the following `SELECT` statement\. This calls the `createtopology` function to register a new topology object \(my\_new\_topo\) with the specified spatial reference identifier \(26986\) and default tolerance \(0\.5\)\. To learn more, see [CreateTopology](https://postgis.net/docs/CreateTopology.html) in the PostGIS documentation\. - -``` -SELECT topology.createtopology('my_new_topo',26986,0.5); - createtopology ----------------- - 1 -(1 row) -``` - -## Step 6: Upgrade the PostGIS extension - -Each new release of PostgreSQL supports one or more versions of the PostGIS extension compatible with that release\. Upgrading the PostgreSQL engine to a new version doesn't automatically upgrade the PostGIS extension\. Before upgrading the PostgreSQL engine, you typically upgrade PostGIS to the newest available version for the current PostgreSQL version\. For details, see [PostGIS extension versions](#CHAP_PostgreSQL.Extensions.PostGIS)\. - -After the PostgreSQL engine upgrade, you then upgrade the PostGIS extension again, to the version supported for the newly upgraded PostgreSQL engine version\. For more information about upgrading the PostgreSQL engine, see [How to perform a major version upgrade](USER_UpgradeDBInstance.PostgreSQL.md#USER_UpgradeDBInstance.PostgreSQL.MajorVersion.Process)\. - -You can check for available PostGIS extension version updates on your RDS for PostgreSQL DB instance at any time\. To do so, run the following command\. This function is available with PostGIS 2\.5\.0 and higher versions\. - -``` -SELECT postGIS_extensions_upgrade(); -``` - -If your application doesn't support the latest PostGIS version, you can install an older version of PostGIS that's available in your major version as follows\. - -``` -CREATE EXTENSION postgis VERSION "2.5.5"; -``` - -If you want to upgrade to a specific PostGIS version from an older version, you can also use the following command\. - -``` -ALTER EXTENSION postgis UPDATE TO "2.5.5"; -``` - -Depending on the version that you're upgrading from, you might need to use this function again\. The result of the first run of the function determines if an additional upgrade function is needed\. For example, this is the case for upgrading from PostGIS 2 to PostGIS 3\. For more information, see [Upgrading PostGIS 2 to PostGIS 3](#PostgreSQL.Extensions.PostGIS.versions.upgrading.2-to-3)\. - -If you upgraded this extension to prepare for a major version upgrade of the PostgreSQL engine, you can continue with other preliminary tasks\. For more information, see [How to perform a major version upgrade](USER_UpgradeDBInstance.PostgreSQL.md#USER_UpgradeDBInstance.PostgreSQL.MajorVersion.Process)\. - -## PostGIS extension versions - -We recommend that you install the versions of all extensions such as PostGIS as listed in [Extension versions for Amazon RDS for PostgreSQL](https://docs.aws.amazon.com/AmazonRDS/latest/PostgreSQLReleaseNotes/postgresql-extensions.html) in the *Amazon RDS for PostgreSQL Release Notes\.* To get a list of versions that are available in your release, use the following command\. - -``` -SELECT * FROM pg_available_extension_versions WHERE name='postgis'; -``` - -You can find version information in the following sections in the *Amazon RDS for PostgreSQL Release Notes*: -+ [ PostgreSQL version 15 extensions supported on Amazon RDS](https://docs.aws.amazon.com/AmazonRDS/latest/PostgreSQLReleaseNotes/postgresql-extensions.html#postgresql-extensions-15x) -+ [ PostgreSQL version 14 extensions supported on Amazon RDS](https://docs.aws.amazon.com/AmazonRDS/latest/PostgreSQLReleaseNotes/postgresql-extensions.html#postgresql-extensions-14x) -+ [ PostgreSQL version 13 extensions supported on Amazon RDS](https://docs.aws.amazon.com/AmazonRDS/latest/PostgreSQLReleaseNotes/postgresql-extensions.html#postgresql-extensions-13x) -+ [ PostgreSQL version 12 extensions supported on Amazon RDS](https://docs.aws.amazon.com/AmazonRDS/latest/PostgreSQLReleaseNotes/postgresql-extensions.html#postgresql-extensions-12x) -+ [ PostgreSQL version 11 extensions supported on Amazon RDS](https://docs.aws.amazon.com/AmazonRDS/latest/PostgreSQLReleaseNotes/postgresql-extensions.html#postgresql-extensions-11x) -+ [ PostgreSQL version 10 extensions supported on Amazon RDS](https://docs.aws.amazon.com/AmazonRDS/latest/PostgreSQLReleaseNotes/postgresql-extensions.html#postgresql-extensions-101x) -+ [ PostgreSQL version 9\.6\.x extensions supported on Amazon RDS](https://docs.aws.amazon.com/AmazonRDS/latest/PostgreSQLReleaseNotes/postgresql-extensions.html#postgresql-extensions-96x) - -## Upgrading PostGIS 2 to PostGIS 3 - -Starting with version 3\.0, the PostGIS raster functionality is now a separate extension, `postgis_raster`\. This extension has its own installation and upgrade path\. This removes dozens of functions, data types, and other artifacts required for raster image processing from the core `postgis` extension\. That means that if your use case doesn't require raster processing, you don't need to install the `postgis_raster` extension\. - -In the following upgrade example, the first upgrade command extracts raster functionality into the `postgis_raster` extension\. A second upgrade command is then required to upgrade `postgres_raster` to the new version\. - -**To upgrade from PostGIS 2 to PostGIS 3** - -1. Identify the default version of PostGIS that's available to the PostgreSQL version on your RDS for PostgreSQL DB instance\. To do so, run the following query\. - - ``` - SELECT * FROM pg_available_extensions - WHERE default_version > installed_version; -   name   | default_version | installed_version |                          comment - ---------+-----------------+-------------------+------------------------------------------------------------ -  postgis | 3.1.4           | 2.3.7             | PostGIS geometry and geography spatial types and functions - (1 row) - ``` - -1. Identify the versions of PostGIS installed in each database on your RDS for PostgreSQL DB instance\. In other words, query each user database as follows\. - - ``` - SELECT -     e.extname AS "Name", -     e.extversion AS "Version", -     n.nspname AS "Schema", -     c.description AS "Description" - FROM -     pg_catalog.pg_extension e -     LEFT JOIN pg_catalog.pg_namespace n ON n.oid = e.extnamespace -     LEFT JOIN pg_catalog.pg_description c ON c.objoid = e.oid -         AND c.classoid = 'pg_catalog.pg_extension'::pg_catalog.regclass - WHERE -     e.extname LIKE '%postgis%' - ORDER BY -     1; -   Name   | Version | Schema |                             Description - ---------+---------+--------+--------------------------------------------------------------------- -  postgis | 2.3.7   | public | PostGIS geometry, geography, and raster spatial types and functions - (1 row) - ``` - - This mismatch between the default version \(PostGIS 3\.1\.4\) and the installed version \(PostGIS 2\.3\.7\) means that you need to upgrade the PostGIS extension\. - - ``` - ALTER EXTENSION postgis UPDATE; - ALTER EXTENSION - WARNING: unpackaging raster - WARNING: PostGIS Raster functionality has been unpackaged - ``` - -1. Run the following query to verify that the raster functionality is now in its own package\. - - ``` - SELECT -     probin, -     count(*) - FROM -     pg_proc - WHERE -     probin LIKE '%postgis%' - GROUP BY -     probin; -           probin          | count - --------------------------+------- -  $libdir/rtpostgis-2.3    | 107 -  $libdir/postgis-3        | 487 - (2 rows) - ``` - - The output shows that there's still a difference between versions\. The PostGIS functions are version 3 \(postgis\-3\), while the raster functions \(rtpostgis\) are version 2 \(rtpostgis\-2\.3\)\. To complete the upgrade, you run the upgrade command again, as follows\. - - ``` - postgres=> SELECT postgis_extensions_upgrade(); - ``` - - You can safely ignore the warning messages\. Run the following query again to verify that the upgrade is complete\. The upgrade is complete when PostGIS and all related extensions aren't marked as needing upgrade\. - - ``` - SELECT postgis_full_version(); - ``` - -1. Use the following query to see the completed upgrade process and the separately packaged extensions, and verify that their versions match\. - - ``` - SELECT -     e.extname AS "Name", -     e.extversion AS "Version", -     n.nspname AS "Schema", -     c.description AS "Description" - FROM -     pg_catalog.pg_extension e -     LEFT JOIN pg_catalog.pg_namespace n ON n.oid = e.extnamespace -     LEFT JOIN pg_catalog.pg_description c ON c.objoid = e.oid -         AND c.classoid = 'pg_catalog.pg_extension'::pg_catalog.regclass - WHERE -     e.extname LIKE '%postgis%' - ORDER BY -     1; -       Name      | Version | Schema |                             Description - ----------------+---------+--------+--------------------------------------------------------------------- -  postgis        | 3.1.5   | public | PostGIS geometry, geography, and raster spatial types and functions -  postgis_raster | 3.1.5   | public | PostGIS raster types and functions - (2 rows) - ``` - - The output shows that the PostGIS 2 extension was upgraded to PostGIS 3, and both `postgis` and the now separate `postgis_raster` extension are version 3\.1\.5\. - -After this upgrade completes, if you don't plan to use the raster functionality, you can drop the extension as follows\. - -``` -DROP EXTENSION postgis_raster; -``` \ No newline at end of file diff --git a/doc_source/Appendix.PostgreSQL.CommonDBATasks.Roles.md b/doc_source/Appendix.PostgreSQL.CommonDBATasks.Roles.md deleted file mode 100644 index 9da1c92..0000000 --- a/doc_source/Appendix.PostgreSQL.CommonDBATasks.Roles.md +++ /dev/null @@ -1,434 +0,0 @@ -# Understanding PostgreSQL roles and permissions - -When you create an RDS for PostgreSQL DB instance using the AWS Management Console, an administrator account is created at the same time\. By default, its name is `postgres`, as shown in the following screenshot: - -![\[The default login identity for Credentials in the Create database page is postgres.\]](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/images/default-login-identity-apg-rpg.png) - -You can choose another name rather than accept the default \(`postgres`\)\. If you do, the name you choose must start with a letter and be between 1 and 16 alphanumeric characters\. For simplicity's sake, we refer to this main user account by its default value \(`postgres`\) throughout this guide\. - -If you use the `create-db-instance` AWS CLI rather than the AWS Management Console, you create the name by passing it with the `master-username` parameter in the command\. For more information, see [Creating an Amazon RDS DB instance](USER_CreateDBInstance.md)\. - -Whether you use the AWS Management Console, the AWS CLI, or the Amazon RDS API, and whether you use the default `postgres` name or choose a different name, this first database user account is a member of the `rds_superuser` group and has `rds_superuser` privileges\. - -**Topics** -+ [Understanding the rds\_superuser role](#Appendix.PostgreSQL.CommonDBATasks.Roles.rds_superuser) -+ [Controlling user access to the PostgreSQL database](#Appendix.PostgreSQL.CommonDBATasks.Access) -+ [Delegating and controlling user password management](#Appendix.PostgreSQL.CommonDBATasks.RestrictPasswordMgmt) -+ [Using SCRAM for PostgreSQL password encryption](#PostgreSQL_Password_Encryption_configuration) - -## Understanding the rds\_superuser role - -In PostgreSQL, a *role* can define a user, a group, or a set of specific permissions granted to a group or user for various objects in the database\. PostgreSQL commands to `CREATE USER` and `CREATE GROUP` have been replaced by the more general, `CREATE ROLE` with specific properties to distinguish database users\. A database user can be thought of as a role with the LOGIN privilege\. - -**Note** -The `CREATE USER` and `CREATE GROUP` commands can still be used\. For more information, see [Database Roles](https://www.postgresql.org/docs/current/user-manag.html) in the PostgreSQL documentation\. - -The `postgres` user is the most highly privileged database user on your RDS for PostgreSQL DB instance\. It has the characteristics defined by the following `CREATE ROLE` statement\. - -``` -CREATE ROLE postgres WITH LOGIN NOSUPERUSER INHERIT CREATEDB CREATEROLE NOREPLICATION VALID UNTIL 'infinity' -``` - -The properties `NOSUPERUSER`, `NOREPLICATION`, `INHERIT`, and `VALID UNTIL 'infinity'` are the default options for CREATE ROLE, unless otherwise specified\. - -By default, `postgres` has privileges granted to the `rds_superuser` role\. The `rds_superuser` role allows the `postgres` user to do the following: -+ Add extensions that are available for use with Amazon RDS\. For more information, see [Working with PostgreSQL features supported by Amazon RDS for PostgreSQL](PostgreSQL.Concepts.General.FeatureSupport.md) -+ Create roles for users and grant privileges to users\. For more information, see [CREATE ROLE](https://www.postgresql.org/docs/current/sql-createrole.html) and [GRANT](https://www.postgresql.org/docs/14/sql-grant.html) in the PostgreSQL documentation\. -+ Create databases\. For more information, see [CREATE DATABASE](https://www.postgresql.org/docs/14/sql-createdatabase.html) in the PostgreSQL documentation\. -+ Grant `rds_superuser` privileges to user roles that don't have these privileges, and revoke privileges as needed\. We recommend that you grant this role only to those users who perform superuser tasks\. In other words, you can grant this role to database administrators \(DBAs\) or system administrators\. -+ Grant \(and revoke\) the `rds_replication` role to database users that don't have the `rds_superuser` role\. -+ Grant \(and revoke\) the `rds_password` role to database users that don't have the `rds_superuser` role\. -+ Obtain status information about all database connections by using the `pg_stat_activity` view\. When needed, `rds_superuser` can stop any connections by using `pg_terminate_backend` or `pg_cancel_backend`\. - -In the `CREATE ROLE postgres...` statement, you can see that the `postgres` user role specifically disallows PostgreSQL `superuser` permissions\. RDS for PostgreSQL is a managed service, so you can't access the host OS, and you can't connect using the PostgreSQL `superuser` account\. Many of the tasks that require `superuser` access on a stand\-alone PostgreSQL are managed automatically by Amazon RDS\. - -For more information about granting privileges, see [GRANT](http://www.postgresql.org/docs/current/sql-grant.html) in the PostgreSQL documentation\. - -The `rds_superuser` role is one of several *predefined* roles in an RDS for PostgreSQL DB instance\. - -**Note** -In PostgreSQL 13 and earlier releases, *predefined* roles are known as *default* roles\. - -In the following list, you find some of the other predefined roles that are created automatically for a new RDS for PostgreSQL DB instance\. Predefined roles and their privileges can't be changed\. You can't drop, rename, or modify privileges for these predefined roles\. Attempting to do so results in an error\. -+ **rds\_password** – A role that can change passwords and set up password constraints for database users\. The `rds_superuser` role is granted this role by default, and can grant the role to database users\. `For more information, see [Controlling user access to the PostgreSQL databaseControlling user access to PostgreSQL](#Appendix.PostgreSQL.CommonDBATasks.Access)\. -+ **rdsadmin** – A role that's created to handle many of the management tasks that the administrator with `superuser` privileges would perform on a standalone PostgreSQL database\. This role is used internally by RDS for PostgreSQL for many management tasks\. -+ **rdstopmgr** – A role that's used internally by Amazon RDS to support Multi\-AZ deployments\. - -To see all predefined roles, you can connect to your RDS for PostgreSQL DB instance and use the `psql \du` metacommand\. The output looks as follows: - -``` -List of roles - Role name | Attributes | Member of ---------------+-----------------------------------+------------------------------------ -postgres | Create role, Create DB +| {rds_superuser} - | Password valid until infinity | -rds_superuser | Cannot login | {pg_monitor,pg_signal_backend, - | +| rds_replication,rds_password} -... -``` - -In the output, you can see that `rds_superuser` isn't a database user role \(it can't login\), but it has the privileges of many other roles\. You can also see that database user `postgres` is a member of the `rds_superuser` role\. As mentioned previously, `postgres` is the default value in the Amazon RDS console's **Create database** page\. If you chose another name, that name is shown in the list of roles instead\. - -## Controlling user access to the PostgreSQL database - -New databases in PostgreSQL are always created with a default set of privileges in the database's `public` schema that allow all database users and roles to create objects\. These privileges allow database users to connect to the database, for example, and create temporary tables while connected\. - -To better control user access to the databases instances that you create on your RDS for PostgreSQL DB instance, we recommend that you revoke these default `public` privileges\. After doing so, you then grant specific privileges for database users on a more granular basis, as shown in the following procedure\. - -**To set up roles and privileges for a new database instance** - -Suppose you're setting up a database on a newly created RDS for PostgreSQL DB instance for use by several researchers, all of whom need read\-write access to the database\. - -1. Use `psql` \(or pgAdmin\) to connect to your RDS for PostgreSQL DB instance: - - ``` - psql --host=your-db-instance.666666666666.aws-region.rds.amazonaws.com --port=5432 --username=postgres --password - ``` - - When prompted, enter your password\. The `psql` client connects and displays the default administrative connection database, `postgres=>`, as the prompt\. - -1. To prevent database users from creating objects in the `public` schema, do the following: - - ``` - postgres=> REVOKE CREATE ON SCHEMA public FROM PUBLIC; - REVOKE - ``` - -1. Next, you create a new database instance: - - ``` - postgres=> CREATE DATABASE lab_db; - CREATE DATABASE - ``` - -1. Revoke all privileges from the `PUBLIC` schema on this new database\. - - ``` - postgres=> REVOKE ALL ON DATABASE lab_db FROM public; - REVOKE - ``` - -1. Create a role for database users\. - - ``` - postgres=> CREATE ROLE lab_tech; - CREATE ROLE - ``` - -1. Give database users that have this role the ability to connect to the database\. - - ``` - postgres=> GRANT CONNECT ON DATABASE lab_db TO lab_tech; - GRANT - ``` - -1. Grant all users with the `lab_tech` role all privileges on this database\. - - ``` - postgres=> GRANT ALL PRIVILEGES ON DATABASE lab_db TO lab_tech; - GRANT - ``` - -1. Create database users, as follows: - - ``` - postgres=> CREATE ROLE lab_user1 LOGIN PASSWORD 'change_me'; - CREATE ROLE - postgres=> CREATE ROLE lab_user2 LOGIN PASSWORD 'change_me'; - CREATE ROLE - ``` - -1. Grant these two users the privileges associated with the lab\_tech role: - - ``` - postgres=> GRANT lab_tech TO lab_user1; - GRANT ROLE - postgres=> GRANT lab_tech TO lab_user2; - GRANT ROLE - ``` - -At this point, `lab_user1` and `lab_user2` can connect to the `lab_db` database\. This example doesn't follow best practices for enterprise usage, which might include creating multiple database instances, different schemas, and granting limited permissions\. For more complete information and additional scenarios, see [Managing PostgreSQL Users and Roles](http://aws.amazon.com/blogs/database/managing-postgresql-users-and-roles/)\. - -For more information about privileges in PostgreSQL databases, see the [GRANT](https://www.postgresql.org/docs/current/static/sql-grant.html) command in the PostgreSQL documentation\. - -## Delegating and controlling user password management - -As a DBA, you might want to delegate the management of user passwords\. Or, you might want to prevent database users from changing their passwords or reconfiguring password constraints, such as password lifetime\. To ensure that only the database users that you choose can change password settings, you can turn on the restricted password management feature\. When you activate this feature, only those database users that have been granted the `rds_password` role can manage passwords\. - -**Note** -To use restricted password management, your RDS for PostgreSQL DB instance must be running PostgreSQL 10\.6 or higher\. - -By default, this feature is `off`, as shown in the following: - -``` -postgres=> SHOW rds.restrict_password_commands; - rds.restrict_password_commands --------------------------------- - off -(1 row) -``` - -To turn on this feature, you use a custom parameter group and change the setting for `rds.restrict_password_commands` to 1\. Be sure to reboot your RDS for PostgreSQL DB instance so that the setting takes effect\. - -With this feature active, `rds_password` privileges are needed for the following SQL commands: - -``` -CREATE ROLE myrole WITH PASSWORD 'mypassword'; -CREATE ROLE myrole WITH PASSWORD 'mypassword' VALID UNTIL '2023-01-01'; -ALTER ROLE myrole WITH PASSWORD 'mypassword' VALID UNTIL '2023-01-01'; -ALTER ROLE myrole WITH PASSWORD 'mypassword'; -ALTER ROLE myrole VALID UNTIL '2023-01-01'; -ALTER ROLE myrole RENAME TO myrole2; -``` - -Renaming a role \(`ALTER ROLE myrole RENAME TO newname`\) is also restricted if the password uses the MD5 hashing algorithm\. - -With this feature active, attempting any of these SQL commands without the `rds_password` role permissions generates the following error: - -``` -ERROR: must be a member of rds_password to alter passwords -``` - -We recommend that you grant the `rds_password` to only a few roles that you use solely for password management\. If you grant `rds_password` privileges to database users that don't have `rds_superuser` privileges, you need to also grant them the `CREATEROLE` attribute\. - -Make sure that you verify password requirements such as expiration and needed complexity on the client side\. If you use your own client\-side utility for password related changes, the utility needs to be a member of `rds_password` and have `CREATE ROLE` privileges\. - -## Using SCRAM for PostgreSQL password encryption - -The *Salted Challenge Response Authentication Mechanism \(SCRAM\)* is an alternative to PostgreSQL's default message digest \(MD5\) algorithm for encrypting passwords\. The SCRAM authentication mechanism is considered more secure than MD5\. To learn more about these two different approaches to securing passwords, see [Password Authentication](https://www.postgresql.org/docs/14/auth-password.html) in the PostgreSQL documentation\. - -We recommend that you use SCRAM rather than MD5 as the password encryption scheme for your RDS for PostgreSQL DB instance\. It's a cryptographic challenge\-response mechanism that uses the scram\-sha\-256 algorithm for password authentication and encryption\. - -You might need to update libraries for your client applications to support SCRAM\. For example, JDBC versions before 42\.2\.0 don't support SCRAM\. For more information, see [PostgreSQL JDBC Driver](https://jdbc.postgresql.org/changelogs/2018-01-17-42.2.0-release/) in the PostgreSQL JDBC Driver documentation\. For a list of other PostgreSQL drivers and SCRAM support, see [List of drivers](https://wiki.postgresql.org/wiki/List_of_drivers) in the PostgreSQL documentation\. - -**Note** -RDS for PostgreSQL version 13\.1 and higher support scram\-sha\-256\. These versions also let you configure your DB instance to require SCRAM, as discussed in the following procedures\. - -### Setting up RDS for PostgreSQL DB instance to require SCRAM - - you can require the RDS for PostgreSQL DB instance to accept only passwords that use the scram\-sha\-256 algorithm\. - -**Important** -For existing RDS Proxies with PostgreSQL databases, if you modify the database authentication to use `SCRAM` only, the proxy becomes unavailable for up to 60 seconds\. To avoid the issue, do one of the following: -Ensure that the database allows both `SCRAM` and `MD5` authentication\. -To use only `SCRAM` authentication, create a new proxy, migrate your application traffic to the new proxy, then delete the proxy previously associated with the database\. - -Before making changes to your system, be sure you understand the complete process, as follows: -+ Get information about all roles and password encryption for all database users\. -+ Double\-check the parameter settings for your RDS for PostgreSQL DB instance for the parameters that control password encryption\. -+ If your RDS for PostgreSQL DB instance uses a default parameter group, you need to create a custom DB parameter group and apply it to your RDS for PostgreSQL DB instance so that you can modify parameters when needed\. If your RDS for PostgreSQL DB instance uses a custom parameter group, you can modify the necessary parameters later in the process, as needed\. -+ Change the `password_encryption` parameter to `scram-sha-256`\. -+ Notify all database users that they need to update their passwords\. Do the same for your `postgres` account\. The new passwords are encrypted and stored using the scram\-sha\-256 algorithm\. -+ Verify that all passwords are encrypted using as the type of encryption\. -+ If all passwords use scram\-sha\-256, you can change the `rds.accepted_password_auth_method` parameter from `md5+scram` to `scram-sha-256`\. - -**Warning** -After you change `rds.accepted_password_auth_method` to scram\-sha\-256 alone, any users \(roles\) with `md5`–encrypted passwords can't connect\. - -#### Getting ready to require SCRAM for your RDS for PostgreSQL DB instance - -Before making any changes to your RDS for PostgreSQL DB instance, check all existing database user accounts\. Also, check the type of encryption used for passwords\. You can do these tasks by using the `rds_tools` extension\. This extension is supported on RDS for PostgreSQL 13\.1 and higher releases\. - -**To get a list of database users \(roles\) and password encryption methods** - -1. Use `psql` to connect to your RDS for PostgreSQL DB instance, as shown in the following\. - - ``` - psql --host=db-name.111122223333.aws-region.rds.amazonaws.com --port=5432 --username=postgres --password - ``` - -1. Install the `rds_tools` extension\. - - ``` - postgres=> CREATE EXTENSION rds_tools; - CREATE EXTENSION - ``` - -1. Get a listing of roles and encryption\. - - ``` - postgres=> SELECT * FROM - rds_tools.role_password_encryption_type(); - ``` - - You see output similar to the following\. - - ``` - rolname | encryption_type - ----------------------+----------------- - pg_monitor | - pg_read_all_settings | - pg_read_all_stats | - pg_stat_scan_tables | - pg_signal_backend | - lab_tester | md5 - user_465 | md5 - postgres | md5 - (8 rows) - ``` - -#### Creating a custom DB parameter group - -**Note** -If your RDS for PostgreSQL DB instance already uses a custom parameter group, you don't need to create a new one\. - -For an overview of parameter groups for Amazon RDS, see [Working with parameters on your RDS for PostgreSQL DB instance](Appendix.PostgreSQL.CommonDBATasks.Parameters.md)\. - -The password encryption type used for passwords is set in one parameter, `password_encryption`\. The encryption that the RDS for PostgreSQL DB instance allows is set in another parameter, `rds.accepted_password_auth_method`\. Changing either of these from the default values requires that you create a custom DB parameter group and apply it to your instance\. - -You can also use the AWS Management Console or the RDS API to create a custom DB parameter group\. For more information, see - -You can now associate the custom parameter group with your DB instance\. - -**To create a custom DB parameter group** - -1. Use the `[create\-db\-parameter\-group](https://docs.aws.amazon.com/cli/latest/reference/rds/create-db-parameter-group.html) ` CLI command to create the custom DB parameter group\. This example uses `postgres13` as the source for this custom parameter group\. - - For Linux, macOS, or Unix: - - ``` - aws rds create-db-parameter-group --db-parameter-group-name 'docs-lab-scram-passwords' \ - --db-parameter-group-family postgres13 --description 'Custom parameter group for SCRAM' - ``` - - For Windows: - - ``` - aws rds create-db-parameter-group --db-parameter-group-name "docs-lab-scram-passwords" ^ - --db-parameter-group-family postgres13 --description "Custom DB parameter group for SCRAM" - ``` - -1. Use the `[modify\-db\-instance](https://docs.aws.amazon.com/cli/latest/reference/rds/modify-db-instance.html)` CLI command to apply this custom parameter group to your RDS for PostgreSQL DB cluster\. - - For Linux, macOS, or Unix: - - ``` - aws rds modify-db-instance --db-instance-identifier 'your-instance-name' \ - --db-parameter-group-name "docs-lab-scram-passwords - ``` - - For Windows: - - ``` - aws rds modify-db-instance --db-instance-identifier "your-instance-name" ^ - --db-parameter-group-name "docs-lab-scram-passwords - ``` - - To resynchronize your RDS for PostgreSQL DB instance with your custom DB parameter group, you need to reboot the primary and all other instances of the cluster\. To minimize impact to your users, schedule this to occur during your regular maintenance window\. - -#### Configuring password encryption to use SCRAM - -The password encryption mechanism used by an RDS for PostgreSQL DB instance is set in the DB parameter group in the `password_encryption` parameter\. Allowed values are unset, `md5`, or `scram-sha-256`\. The default value depends on the RDS for PostgreSQL version, as follows: -+ RDS for PostgreSQL 14 and above – Default is `scram-sha-256` -+ RDS for PostgreSQL 13 – Default is `md5` - -With a custom DB parameter group attached to your RDS for PostgreSQL DB instance, you can modify values for the password encryption parameter\. - -![\[Following, the RDS console shows the default values for the password_encryption parameters for RDS for PostgreSQL.\]](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/images/rpg-pwd-encryption-md5-scram-1.png) - -**To change password encryption setting to scram\-sha\-256** -+ Change the value of password encryption to scram\-sha\-256, as shown following\. The change can be applied immediately because the parameter is dynamic, so a restart isn't required for the change to take effect\. - - For Linux, macOS, or Unix: - - ``` - aws rds modify-db-parameter-group --db-parameter-group-name \ - 'docs-lab-scram-passwords' --parameters 'ParameterName=password_encryption,ParameterValue=scram-sha-256,ApplyMethod=immediate' - ``` - - For Windows: - - ``` - aws rds modify-db-parameter-group --db-parameter-group-name ^ - "docs-lab-scram-passwords" --parameters "ParameterName=password_encryption,ParameterValue=scram-sha-256,ApplyMethod=immediate" - ``` - -#### Migrating passwords for user roles to SCRAM - -You can migrate passwords for user roles to SCRAM as described following\. - -**To migrate database user \(role\) passwords from MD5 to SCRAM** - -1. Log in as the administrator user \(default user name, `postgres`\) as shown following\. - - ``` - psql --host=db-name.111122223333.aws-region.rds.amazonaws.com --port=5432 --username=postgres --password - ``` - -1. Check the setting of the `password_encryption` parameter on your RDS for PostgreSQL DB instance by using the following command\. - - ``` - postgres=> SHOW password_encryption; - password_encryption - --------------------- - md5 - (1 row) - ``` - -1. Change the value of this parameter to scram\-sha\-256\. This is a dynamic parameter, so you don't need to reboot the instance after making this change\. Check the value again to make sure that it's now set to `scram-sha-256`, as follows\. - - ``` - postgres=> SHOW password_encryption; - password_encryption - --------------------- - scram-sha-256 - (1 row) - ``` - -1. Notify all database users to change their passwords\. Be sure to also change your own password for account `postgres` \(the database user with `rds_superuser` privileges\)\. - - ``` - labdb=> ALTER ROLE postgres WITH LOGIN PASSWORD 'change_me'; - ALTER ROLE - ``` - -1. Repeat the process for all databases on your RDS for PostgreSQL DB instance\. - -#### Changing parameter to require SCRAM - -This is the final step in the process\. After you make the change in the following procedure, any user accounts \(roles\) that still use `md5` encryption for passwords can't log in to the RDS for PostgreSQL DB instance\. - -The `rds.accepted_password_auth_method` specifies the encryption method that the RDS for PostgreSQL DB instance accepts for a user password during the login process\. The default value is `md5+scram`, meaning that either method is accepted\. In the following image, you can find the default setting for this parameter\. - -![\[The RDS console showing the default and allowed values for the rds.accepted_password_auth_method parameters.\]](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/images/pwd-encryption-md5-scram-2.png) - -The allowed values for this parameter are `md5+scram` or `scram` alone\. Changing this parameter value to `scram` makes this a requirement\. - -**To change the parameter value to require SCRAM authentication for passwords** - -1. Verify that all database user passwords for all databases on your RDS for PostgreSQL DB instance use `scram-sha-256` for password encryption\. To do so, query `rds_tools` for the role \(user\) and encryption type, as follows\. - - ``` - postgres=> SELECT * FROM rds_tools.role_password_encryption_type(); - rolname | encryption_type - ----------------------+----------------- - pg_monitor | - pg_read_all_settings | - pg_read_all_stats | - pg_stat_scan_tables | - pg_signal_backend | - lab_tester | scram-sha-256 - user_465 | scram-sha-256 - postgres | scram-sha-256 - ( rows) - ``` - -1. Repeat the query across all DB instances in your RDS for PostgreSQL DB instance\. - - If all passwords use scram\-sha\-256, you can proceed\. - -1. Change the value of the accepted password authentication to scram\-sha\-256, as follows\. - - For Linux, macOS, or Unix: - - ``` - aws rds modify-db-parameter-group --db-parameter-group-name 'docs-lab-scram-passwords' \ - --parameters 'ParameterName=rds.accepted_password_auth_method,ParameterValue=scram,ApplyMethod=immediate' - ``` - - For Windows: - - ``` - aws rds modify-db-parameter-group --db-parameter-group-name "docs-lab-scram-passwords" ^ - --parameters "ParameterName=rds.accepted_password_auth_method,ParameterValue=scram,ApplyMethod=immediate" - ``` \ No newline at end of file diff --git a/doc_source/Appendix.PostgreSQL.CommonDBATasks.md b/doc_source/Appendix.PostgreSQL.CommonDBATasks.md deleted file mode 100644 index 859147f..0000000 --- a/doc_source/Appendix.PostgreSQL.CommonDBATasks.md +++ /dev/null @@ -1,46 +0,0 @@ -# Common DBA tasks for Amazon RDS for PostgreSQL - -Database administrators \(DBAs\) perform a variety of tasks when administering an Amazon RDS for PostgreSQL DB instance\. If you're a DBA already familiar with PostgreSQL, you need to be aware of some of the important differences between running PostgreSQL on your hardware and RDS for PostgreSQL\. For example, because it's a managed service, Amazon RDS doesn't allow shell access to your DB instances\. That means that you don't have direct access to `pg_hba.conf` and other configuration files\. For RDS for PostgreSQL, changes that are typically made to the PostgreSQL configuration file of an on\-premises instance are made to a custom DB parameter group associated with the RDS for PostgreSQL DB instance\. For more information, see [Working with parameter groups](USER_WorkingWithParamGroups.md)\. - -You also can't access log files in the same way that you do with an on\-premises PostgreSQL instance\. To learn more about logging, see [RDS for PostgreSQL database log files](USER_LogAccess.Concepts.PostgreSQL.md)\. - -As another example, you don't have access to the PostgreSQL `superuser` account\. On RDS for PostgreSQL, the `rds_superuser` role is the most highly privileged role, and it's granted to `postgres` at set up time\. Whether you're familiar with using PostgreSQL on\-premises or completely new to RDS for PostgreSQL, we recommend that you understand the `rds_superuser` role, and how to work with roles, users, groups, and permissions\. For more information, see [Understanding PostgreSQL roles and permissions](Appendix.PostgreSQL.CommonDBATasks.Roles.md)\. - -Following are some common DBA tasks for RDS for PostgreSQL\. - -**Topics** -+ [Collations supported in RDS for PostgreSQL](PostgreSQL-Collations.md) -+ [Understanding PostgreSQL roles and permissions](Appendix.PostgreSQL.CommonDBATasks.Roles.md) -+ [Working with the PostgreSQL autovacuum on Amazon RDS for PostgreSQL](Appendix.PostgreSQL.CommonDBATasks.Autovacuum.md) -+ [Working with logging mechanisms supported by RDS for PostgreSQL](#Appendix.PostgreSQL.CommonDBATasks.Auditing) -+ [Managing temporary files with PostgreSQL](PostgreSQL.ManagingTempFiles.md) -+ [Using pgBadger for log analysis with PostgreSQL](#Appendix.PostgreSQL.CommonDBATasks.Badger) -+ [Using PGSnapper for monitoring PostgreSQL](#Appendix.PostgreSQL.CommonDBATasks.Snapper) -+ [Working with parameters on your RDS for PostgreSQL DB instance](Appendix.PostgreSQL.CommonDBATasks.Parameters.md) - -## Working with logging mechanisms supported by RDS for PostgreSQL - -There are several parameters, extensions, and other configurable items that you can set to log activities that occur on your PostgreSQL DB instance\. These include the following: -+ The `log_statement` parameter can be used to log user activity in your PostgreSQL database\. To learn more about RDS for PostgreSQL logging and how to monitor the logs, see [RDS for PostgreSQL database log files](USER_LogAccess.Concepts.PostgreSQL.md)\. -+ The `rds.force_admin_logging_level` parameter logs actions by the Amazon RDS internal user \(rdsadmin\) in the databases on the DB instance\. It writes the output to the PostgreSQL error log\. Allowed values are `disabled`, `debug5`, `debug4`, `debug3`, `debug2`, `debug1`, `info`, `notice`, `warning`, `error`, log, `fatal`, and `panic`\. The default value is `disabled`\. -+ The `rds.force_autovacuum_logging_level` parameter can be set to capture various autovacuum operations in the PostgreSQL error log\. For more information, see [Logging autovacuum and vacuum activities](Appendix.PostgreSQL.CommonDBATasks.Autovacuum.md#Appendix.PostgreSQL.CommonDBATasks.Autovacuum.Logging)\. -+ The PostgreSQL Audit \(pgAudit\) extension can be installed and configured to capture activities at the session level or at the object level\. For more information, see [Using pgAudit to log database activity](Appendix.PostgreSQL.CommonDBATasks.Extensions.md#Appendix.PostgreSQL.CommonDBATasks.pgaudit)\. -+ The `log_fdw` extension makes it possible for you to access the database engine log using SQL\. For more information, see [Using the log\_fdw extension to access the DB log using SQL](Appendix.PostgreSQL.CommonDBATasks.Extensions.foreign-data-wrappers.md#CHAP_PostgreSQL.Extensions.log_fdw)\. -+ The `pg_stat_statements` library is specified as the default for the `shared_preload_libraries` parameter in RDS for PostgreSQL version 10 and higher\. It's this library that you can use to analyze running queries\. Be sure that `pg_stat_statements` is set in your DB parameter group\. For more information about monitoring your RDS for PostgreSQL DB instance using the information that this library provides, see [SQL statistics for RDS PostgreSQL](USER_PerfInsights.UsingDashboard.AnalyzeDBLoad.AdditionalMetrics.PostgreSQL.md)\. -+ The `log_hostname` parameter captures to the log the hostname of each client connection\. For RDS for PostgreSQL version 12 and higher versions, this parameter is set to `off` by default\. If you turn it on, be sure to monitor session connection times\. When turned on, the service uses the domain name system \(DNS\) reverse lookup request to get the hostname of the client that's making the connection and add it to the PostgreSQL log\. This has a noticeable impact during session connection\. We recommend that you turn on this parameter for troubleshooting purposes only\. - -In general terms, the point of logging is so that the DBA can monitor, tune performance, and troubleshoot\. Many of the logs are uploaded automatically to Amazon CloudWatch or Performance Insights\. Here, they're sorted and grouped to provide complete metrics for your DB instance\. To learn more about Amazon RDS monitoring and metrics, see [Monitoring metrics in an Amazon RDS instance](CHAP_Monitoring.md)\. - -## Using pgBadger for log analysis with PostgreSQL - -You can use a log analyzer such as [pgBadger](http://dalibo.github.io/pgbadger/) to analyze PostgreSQL logs\. The pgBadger documentation states that the %l pattern \(the log line for the session or process\) should be a part of the prefix\. However, if you provide the current RDS `log_line_prefix` as a parameter to pgBadger it should still produce a report\. - -For example, the following command correctly formats an Amazon RDS for PostgreSQL log file dated 2014\-02\-04 using pgBadger\. - -``` -./pgbadger -f stderr -p '%t:%r:%u@%d:[%p]:' postgresql.log.2014-02-04-00 -``` - -## Using PGSnapper for monitoring PostgreSQL - -You can use PGSnapper to assist with periodic collection of Amazon RDS for PostgreSQL performance\-related statistics and metrics\. For more information, see[ Monitor Amazon RDS for PostgreSQL performance using PGSnapper](https://aws.amazon.com/blogs/database/monitor-amazon-rds-for-postgresql-and-amazon-aurora-postgresql-performance-using-pgsnapper/)\. \ No newline at end of file diff --git a/doc_source/Appendix.SQLServer.CommonDBATasks.Agent.md b/doc_source/Appendix.SQLServer.CommonDBATasks.Agent.md deleted file mode 100644 index bc21a0e..0000000 --- a/doc_source/Appendix.SQLServer.CommonDBATasks.Agent.md +++ /dev/null @@ -1,122 +0,0 @@ -# Using SQL Server Agent - -With Amazon RDS, you can use SQL Server Agent on a DB instance running Microsoft SQL Server Enterprise Edition, Standard Edition, or Web Edition\. SQL Server Agent is a Microsoft Windows service that runs scheduled administrative tasks that are called jobs\. You can use SQL Server Agent to run T\-SQL jobs to rebuild indexes, run corruption checks, and aggregate data in a SQL Server DB instance\. - -When you create a SQL Server DB instance, the master user is enrolled in the `SQLAgentUserRole` role\. - -SQL Server Agent can run a job on a schedule, in response to a specific event, or on demand\. For more information, see [SQL Server Agent](http://msdn.microsoft.com/en-us/library/ms189237) in the Microsoft documentation\. - -**Note** -Avoid scheduling jobs to run during the maintenance and backup windows for your DB instance\. The maintenance and backup processes that are launched by AWS could interrupt a job or cause it to be canceled\. -In Multi\-AZ deployments, SQL Server Agent jobs are replicated from the primary host to the secondary host when the job replication feature is turned on\. For more information, see [Turning on SQL Server Agent job replication](#SQLServerAgent.Replicate)\. -Multi\-AZ deployments have a limit of 100 SQL Server Agent jobs\. If you need a higher limit, request an increase by contacting AWS Support\. Open the [AWS Support Center](https://console.aws.amazon.com/support/home#/) page, sign in if necessary, and choose **Create case**\. Choose **Service limit increase**\. Complete and submit the form\. - -To view the history of an individual SQL Server Agent job in SQL Server Management Studio \(SSMS\), open Object Explorer, right\-click the job, and then choose **View History**\. - -Because SQL Server Agent is running on a managed host in a DB instance, some actions aren't supported: -+ Running replication jobs and running command\-line scripts by using ActiveX, Windows command shell, or Windows PowerShell aren't supported\. -+ You can't manually start, stop, or restart SQL Server Agent\. -+ Email notifications through SQL Server Agent aren't available from a DB instance\. -+ SQL Server Agent alerts and operators aren't supported\. -+ Using SQL Server Agent to create backups isn't supported\. Use Amazon RDS to back up your DB instance\. - -## Turning on SQL Server Agent job replication - -You can turn on SQL Server Agent job replication by using the following stored procedure: - -``` -EXECUTE msdb.dbo.rds_set_system_database_sync_objects @object_types = 'SQLAgentJob'; -``` - -You can run the stored procedure on all SQL Server versions supported by Amazon RDS for SQL Server\. Jobs in the following categories are replicated: -+ \[Uncategorized \(Local\)\] -+ \[Uncategorized \(Multi\-Server\)\] -+ \[Uncategorized\] -+ Data Collector -+ Database Engine Tuning Advisor -+ Database Maintenance -+ Full\-Text - -Only jobs that use T\-SQL job steps are replicated\. Jobs with step types such as SQL Server Integration Services \(SSIS\), SQL Server Reporting Services \(SSRS\), Replication, and PowerShell aren't replicated\. Jobs that use Database Mail and server\-level objects aren't replicated\. - -**Important** -The primary host is the source of truth for replication\. Before turning on job replication, make sure that your SQL Server Agent jobs are on the primary\. If you don't do this, it could lead to the deletion of your SQL Server Agent jobs if you turn on the feature when newer jobs are on the secondary host\. - -You can use the following function to confirm whether replication is turned on\. - -``` -SELECT * from msdb.dbo.rds_fn_get_system_database_sync_objects(); -``` - - The T\-SQL query returns the following if SQL Server Agent jobs are replicating\. If they're not replicating, it returns nothing for `object_class`\. - -![\[SQL Server Agent jobs are replicating\]](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/images/SQLAgentJob.png) - -You can use the following function to find the last time objects were synchronized in UTC time\. - -``` -SELECT * from msdb.dbo.rds_fn_server_object_last_sync_time(); -``` - -For example, suppose that you modify a SQL Server Agent job at 01:00\. You expect the most recent synchronization time to be after 01:00, indicating that synchronization has taken place\. - -After synchronization, the values returned for `date_created` and `date_modified` on the secondary node are expected to match\. - -![\[Last time server objects were synchronized was 01:21:23\]](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/images/SQLAgentJob_last_sync_time.png) - -## Adding a user to the SQLAgentUser role - -To allow an additional login or user to use SQL Server Agent, log in as the master user and do the following: - -1. Create another server\-level login by using the `CREATE LOGIN` command\. - -1. Create a user in `msdb` using `CREATE USER` command, and then link this user to the login that you created in the previous step\. - -1. Add the user to the `SQLAgentUserRole` using the `sp_addrolemember` system stored procedure\. - -For example, suppose that your master user name is **admin** and you want to give access to SQL Server Agent to a user named **theirname** with a password **theirpassword**\. In that case, you can use the following procedure\. - -**To add a user to the SQLAgentUser role** - -1. Log in as the master user\. - -1. Run the following commands: - - ``` - --Initially set context to master database - USE [master]; - GO - --Create a server-level login named theirname with password theirpassword - CREATE LOGIN [theirname] WITH PASSWORD = 'theirpassword'; - GO - --Set context to msdb database - USE [msdb]; - GO - --Create a database user named theirname and link it to server-level login theirname - CREATE USER [theirname] FOR LOGIN [theirname]; - GO - --Added database user theirname in msdb to SQLAgentUserRole in msdb - EXEC sp_addrolemember [SQLAgentUserRole], [theirname]; - ``` - -## Deleting a SQL Server Agent job - -You use the `sp_delete_job` stored procedure to delete SQL Server Agent jobs on Amazon RDS for Microsoft SQL Server\. - -You can't use SSMS to delete SQL Server Agent jobs\. If you try to do so, you get an error message similar to the following: - -``` -The EXECUTE permission was denied on the object 'xp_regread', database 'mssqlsystemresource', schema 'sys'. -``` - -As a managed service, RDS is restricted from running procedures that access the Windows registry\. When you use SSMS, it tries to run a process \(`xp_regread`\) for which RDS isn't authorized\. - -**Note** -On RDS for SQL Server, only members of the sysadmin role are allowed to update or delete jobs owned by a different login\. - -**To delete a SQL Server Agent job** -+ Run the following T\-SQL statement: - - ``` - EXEC msdb..sp_delete_job @job_name = 'job_name'; - ``` \ No newline at end of file diff --git a/doc_source/Appendix.SQLServer.CommonDBATasks.CDC.md b/doc_source/Appendix.SQLServer.CommonDBATasks.CDC.md deleted file mode 100644 index c195bb9..0000000 --- a/doc_source/Appendix.SQLServer.CommonDBATasks.CDC.md +++ /dev/null @@ -1,102 +0,0 @@ -# Using change data capture - -Amazon RDS supports change data capture \(CDC\) for your DB instances running Microsoft SQL Server\. CDC captures changes that are made to the data in your tables\. It stores metadata about each change, which you can access later\. For more information about how CDC works, see [Change data capture](https://docs.microsoft.com/en-us/sql/relational-databases/track-changes/track-data-changes-sql-server#Capture) in the Microsoft documentation\. - -Before you use CDC with your Amazon RDS DB instances, enable it in the database by running `msdb.dbo.rds_cdc_enable_db`\. You must have master user privileges to enable CDC in the Amazon RDS DB instance\. After CDC is enabled, any user who is `db_owner` of that database can enable or disable CDC on tables in that database\. - -**Important** -During restores, CDC will be disabled\. All of the related metadata is automatically removed from the database\. This applies to snapshot restores, point\-in\-time restores, and SQL Server Native restores from S3\. After performing one of these types of restores, you can re\-enable CDC and re\-specify tables to track\. - -To enable CDC for a DB instance, run the `msdb.dbo.rds_cdc_enable_db` stored procedure\. - -``` -1. exec msdb.dbo.rds_cdc_enable_db 'database_name' -``` - -To disable CDC for a DB instance, run the `msdb.dbo.rds_cdc_disable_db` stored procedure\. - -``` -1. exec msdb.dbo.rds_cdc_disable_db 'database_name' -``` - -**Topics** -+ [Tracking tables with change data capture](#Appendix.SQLServer.CommonDBATasks.CDC.tables) -+ [Change data capture jobs](#Appendix.SQLServer.CommonDBATasks.CDC.jobs) -+ [Change data capture for Multi\-AZ instances](#Appendix.SQLServer.CommonDBATasks.CDC.Multi-AZ) - -## Tracking tables with change data capture - -After CDC is enabled on the database, you can start tracking specific tables\. You can choose the tables to track by running [sys\.sp\_cdc\_enable\_table](https://docs.microsoft.com/en-us/sql/relational-databases/system-stored-procedures/sys-sp-cdc-enable-table-transact-sql)\. - -``` - 1. --Begin tracking a table - 2. exec sys.sp_cdc_enable_table - 3. @source_schema = N'source_schema' - 4. , @source_name = N'source_name' - 5. , @role_name = N'role_name' - 6. - 7. --The following parameters are optional: - 8. - 9. --, @capture_instance = 'capture_instance' -10. --, @supports_net_changes = supports_net_changes -11. --, @index_name = 'index_name' -12. --, @captured_column_list = 'captured_column_list' -13. --, @filegroup_name = 'filegroup_name' -14. --, @allow_partition_switch = 'allow_partition_switch' -15. ; -``` - -To view the CDC configuration for your tables, run [sys\.sp\_cdc\_help\_change\_data\_capture](https://docs.microsoft.com/en-us/sql/relational-databases/system-stored-procedures/sys-sp-cdc-help-change-data-capture-transact-sql)\. - -``` -1. --View CDC configuration -2. exec sys.sp_cdc_help_change_data_capture -3. -4. --The following parameters are optional and must be used together. -5. -- 'schema_name', 'table_name' -6. ; -``` - -For more information on CDC tables, functions, and stored procedures in SQL Server documentation, see the following: -+ [Change data capture stored procedures \(Transact\-SQL\)](https://docs.microsoft.com/en-us/sql/relational-databases/system-stored-procedures/change-data-capture-stored-procedures-transact-sql) -+ [Change data capture functions \(Transact\-SQL\)](https://docs.microsoft.com/en-us/sql/relational-databases/system-functions/change-data-capture-functions-transact-sql) -+ [Change data capture tables \(Transact\-SQL\)](https://docs.microsoft.com/en-us/sql/relational-databases/system-tables/change-data-capture-tables-transact-sql) - -## Change data capture jobs - -When you enable CDC, SQL Server creates the CDC jobs\. Database owners \(`db_owner`\) can view, create, modify, and delete the CDC jobs\. However, the RDS system account owns them\. Therefore, the jobs aren't visible from native views, procedures, or in SQL Server Management Studio\. - -To control behavior of CDC in a database, use native SQL Server procedures such as [sp\_cdc\_enable\_table](https://docs.microsoft.com/en-us/sql/relational-databases/system-stored-procedures/sys-sp-cdc-enable-table-transact-sql) and [sp\_cdc\_start\_job](https://docs.microsoft.com/en-us/sql/relational-databases/system-stored-procedures/sys-sp-cdc-start-job-transact-sql)\. To change CDC job parameters, like `maxtrans` and `maxscans`, you can use [sp\_cdc\_change\_job\.](https://docs.microsoft.com/en-us/sql/relational-databases/system-stored-procedures/sys-sp-cdc-change-job-transact-sql)\. - -To get more information regarding the CDC jobs, you can query the following dynamic management views: -+ sys\.dm\_cdc\_errors -+ sys\.dm\_cdc\_log\_scan\_sessions -+ sysjobs -+ sysjobhistory - -## Change data capture for Multi\-AZ instances - -If you use CDC on a Multi\-AZ instance, make sure the mirror's CDC job configuration matches the one on the principal\. CDC jobs are mapped to the `database_id`\. If the database IDs on the secondary are different from the principal, then the jobs won't be associated with the correct database\. To try to prevent errors after failover, RDS drops and recreates the jobs on the new principal\. The recreated jobs use the parameters that the principal recorded before failover\. - -Although this process runs quickly, it's still possible that the CDC jobs might run before RDS can correct them\. Here are three ways to force parameters to be consistent between primary and secondary replicas: -+ Use the same job parameters for all the databases that have CDC enabled\. -+ Before you change the CDC job configuration, convert the Multi\-AZ instance to Single\-AZ\. -+ Manually transfer the parameters whenever you change them on the principal\. - -To view and define the CDC parameters that are used to recreate the CDC jobs after a failover, use `rds_show_configuration` and `rds_set_configuration`\. - -The following example returns the value set for `cdc_capture_maxtrans`\. For any parameter that is set to `RDS_DEFAULT`, RDS automatically configures the value\. - -``` --- Show configuration for each parameter on either primary and secondary replicas. -exec rdsadmin.dbo.rds_show_configuration 'cdc_capture_maxtrans'; -``` - -To set the configuration on the secondary, run `rdsadmin.dbo.rds_set_configuration`\. This procedure sets the parameter values for all of the databases on the secondary server\. These settings are used only after a failover\. The following example sets the `maxtrans` for all CDC capture jobs to *1000*: - -``` ---To set values on secondary. These are used after failover. -exec rdsadmin.dbo.rds_set_configuration 'cdc_capture_maxtrans', 1000; -``` - -To set the CDC job parameters on the principal, use [sys\.sp\_cdc\_change\_job](https://docs.microsoft.com/en-us/sql/relational-databases/system-stored-procedures/sys-sp-cdc-change-job-transact-sql) instead\. \ No newline at end of file diff --git a/doc_source/Appendix.SQLServer.CommonDBATasks.Collation.md b/doc_source/Appendix.SQLServer.CommonDBATasks.Collation.md deleted file mode 100644 index 8c29f3f..0000000 --- a/doc_source/Appendix.SQLServer.CommonDBATasks.Collation.md +++ /dev/null @@ -1,81 +0,0 @@ -# Collations and character sets for Microsoft SQL Server - -SQL Server supports collations at multiple levels\. You set the default server collation when you create the DB instance\. You can override the collation in the database, table, or column level\. - -**Topics** -+ [Server\-level collation for Microsoft SQL Server](#Appendix.SQLServer.CommonDBATasks.Collation.Server) -+ [Database\-level collation for Microsoft SQL Server](#Appendix.SQLServer.CommonDBATasks.Collation.Database-Table-Column) - -## Server\-level collation for Microsoft SQL Server - -When you create a Microsoft SQL Server DB instance, you can set the server collation that you want to use\. If you don't choose a different collation, the server\-level collation defaults to SQL\_Latin1\_General\_CP1\_CI\_AS\. The server collation is applied by default to all databases and database objects\. - -**Note** -You can't change the collation when you restore from a DB snapshot\. - -Currently, Amazon RDS supports the following server collations: - - -| Collation | Description | -| --- | --- | -| Chinese\_PRC\_BIN2 | Chinese\-PRC, binary code point sort order | -| Chinese\_PRC\_CI\_AS | Chinese\-PRC, case\-insensitive, accent\-sensitive, kanatype\-insensitive, width\-insensitive | -| Chinese\_Taiwan\_Stroke\_CI\_AS | Chinese\-Taiwan\-Stroke, case\-insensitive, accent\-sensitive, kanatype\-insensitive, width\-insensitive | -| Danish\_Norwegian\_CI\_AS | Danish\-Norwegian, case\-insensitive, accent\-sensitive, kanatype\-insensitive, width\-insensitive | -| Finnish\_Swedish\_CI\_AS | Finnish, Swedish, and Swedish \(Finland\), case\-insensitive, accent\-sensitive, kanatype\-insensitive, width\-insensitive | -| French\_CI\_AS | French, case\-insensitive, accent\-sensitive, kanatype\-insensitive, width\-insensitive | -| Hebrew\_BIN | Hebrew, binary sort | -| Hebrew\_CI\_AS | Hebrew, case\-insensitive, accent\-sensitive, kanatype\-insensitive, width\-insensitive | -| Japanese\_BIN | Japanese, binary sort | -| Japanese\_CI\_AS | Japanese, case\-insensitive, accent\-sensitive, kanatype\-insensitive, width\-insensitive | -| Japanese\_CS\_AS | Japanese, case\-sensitive, accent\-sensitive, kanatype\-insensitive, width\-insensitive | -| Japanese\_XJIS\_140\_CI\_AS | Japanese\-XJIS\-140, case\-insensitive, accent\-sensitive, kanatype\-insensitive, width\-insensitive, supplementary characters, variation selector insensitive | -| Japanese\_XJIS\_140\_CI\_AS\_KS\_VSS | Japanese\-XJIS\-140, case\-insensitive, accent\-sensitive, kanatype\-sensitive, width\-insensitive, supplementary characters, variation selector sensitive | -| Japanese\_XJIS\_140\_CI\_AS\_VSS | Japanese\-XJIS\-140, case\-insensitive, accent\-sensitive, kanatype\-insensitive, width\-insensitive, supplementary characters, variation selector sensitive | -| Korean\_Wansung\_CI\_AS | Korean\-Wansung, case\-insensitive, accent\-sensitive, kanatype\-insensitive, width\-insensitive | -| Latin1\_General\_100\_BIN | Latin1\-General\-100, binary sort | -| Latin1\_General\_100\_BIN2 | Latin1\-General\-100, binary code point sort order | -| Latin1\_General\_100\_BIN2\_UTF8 | Latin1\-General\-100, binary code point sort order, UTF\-8 encoded | -| Latin1\_General\_100\_CI\_AS | Latin1\-General\-100, case\-insensitive, accent\-sensitive, kanatype\-insensitive, width\-insensitive | -| Latin1\_General\_100\_CI\_AS\_SC\_UTF8 | Latin1\-General\-100, case\-insensitive, accent\-sensitive, supplementary characters, UTF\-8 encoded | -| Latin1\_General\_BIN | Latin1\-General, binary sort | -| Latin1\_General\_BIN2 | Latin1\-General, binary code point sort order | -| Latin1\_General\_CI\_AI | Latin1\-General, case\-insensitive, accent\-insensitive, kanatype\-insensitive, width\-insensitive | -| Latin1\_General\_CI\_AS | Latin1\-General, case\-insensitive, accent\-sensitive, kanatype\-insensitive, width\-insensitive | -| Latin1\_General\_CI\_AS\_KS | Latin1\-General, case\-insensitive, accent\-sensitive, kanatype\-sensitive, width\-insensitive | -| Latin1\_General\_CS\_AS | Latin1\-General, case\-sensitive, accent\-sensitive, kanatype\-insensitive, width\-insensitive | -| Modern\_Spanish\_CI\_AS | Modern\-Spanish, case\-insensitive, accent\-sensitive, kanatype\-insensitive, width\-insensitive | -| SQL\_1xCompat\_CP850\_CI\_AS | Latin1\-General, case\-insensitive, accent\-sensitive, kanatype\-insensitive, width\-insensitive for Unicode Data, SQL Server Sort Order 49 on Code Page 850 for non\-Unicode Data | -| SQL\_Latin1\_General\_CP1\_CI\_AI | Latin1\-General, case\-insensitive, accent\-insensitive, kanatype\-insensitive, width\-insensitive for Unicode Data, SQL Server Sort Order 54 on Code Page 1252 for non\-Unicode Data | -| **SQL\_Latin1\_General\_CP1\_CI\_AS \(default\)** | Latin1\-General, case\-insensitive, accent\-sensitive, kanatype\-insensitive, width\-insensitive for Unicode Data, SQL Server Sort Order 52 on Code Page 1252 for non\-Unicode Data | -| SQL\_Latin1\_General\_CP1\_CS\_AS | Latin1\-General, case\-sensitive, accent\-sensitive, kanatype\-insensitive, width\-insensitive for Unicode Data, SQL Server Sort Order 51 on Code Page 1252 for non\-Unicode Data | -| SQL\_Latin1\_General\_CP437\_CI\_AI | Latin1\-General, case\-insensitive, accent\-insensitive, kanatype\-insensitive, width\-insensitive for Unicode Data, SQL Server Sort Order 34 on Code Page 437 for non\-Unicode Data | -| SQL\_Latin1\_General\_CP850\_BIN2 | Latin1\-General, binary code point sort order for Unicode Data, SQL Server Sort Order 40 on Code Page 850 for non\-Unicode Data | -| SQL\_Latin1\_General\_CP850\_CI\_AS | Latin1\-General, case\-insensitive, accent\-sensitive, kanatype\-insensitive, width\-insensitive for Unicode Data, SQL Server Sort Order 42 on Code Page 850 for non\-Unicode Data | -| SQL\_Latin1\_General\_CP1256\_CI\_AS | Latin1\-General, case\-insensitive, accent\-sensitive, kanatype\-insensitive, width\-insensitive for Unicode Data, SQL Server Sort Order 146 on Code Page 1256 for non\-Unicode Data | -| Thai\_CI\_AS | Thai, case\-insensitive, accent\-sensitive, kanatype\-insensitive, width\-insensitive | - -To choose the collation: -+ If you're using the Amazon RDS console, when creating a new DB instance choose **Additional configuration**, then enter the collation in the **Collation** field\. For more information, see [Creating an Amazon RDS DB instance](USER_CreateDBInstance.md)\. -+ If you're using the AWS CLI, use the `--character-set-name` option with the `create-db-instance` command\. For more information, see [create\-db\-instance](https://docs.aws.amazon.com/cli/latest/reference/rds/create-db-instance.html)\. -+ If you're using the Amazon RDS API, use the `CharacterSetName` parameter with the `CreateDBInstance` operation\. For more information, see [CreateDBInstance](https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_CreateDBInstance.html)\. - -## Database\-level collation for Microsoft SQL Server - -You can change the default collation at the database, table, or column level by overriding the collation when creating a new database or database object\. For example, if your default server collation is SQL\_Latin1\_General\_CP1\_CI\_AS, you can change it to Mohawk\_100\_CI\_AS for Mohawk collation support\. Even arguments in a query can be type\-cast to use a different collation if necessary\. - -For example, the following query would change the default collation for the AccountName column to Mohawk\_100\_CI\_AS - -``` -CREATE TABLE [dbo].[Account] - ( - [AccountID] [nvarchar](10) NOT NULL, - [AccountName] [nvarchar](100) COLLATE Mohawk_100_CI_AS NOT NULL - ) ON [PRIMARY]; -``` - -The Microsoft SQL Server DB engine supports Unicode by the built\-in NCHAR, NVARCHAR, and NTEXT data types\. For example, if you need CJK support, use these Unicode data types for character storage and override the default server collation when creating your databases and tables\. Here are several links from Microsoft covering collation and Unicode support for SQL Server: -+ [Working with collations](http://msdn.microsoft.com/en-us/library/ms187582%28v=sql.105%29.aspx) -+ [Collation and international terminology](http://msdn.microsoft.com/en-us/library/ms143726%28v=sql.105%29) -+ [Using SQL Server collations](http://msdn.microsoft.com/en-us/library/ms144260%28v=sql.105%29.aspx) -+ [International considerations for databases and database engine applications](http://msdn.microsoft.com/en-us/library/ms190245%28v=sql.105%29.aspx) \ No newline at end of file diff --git a/doc_source/Appendix.SQLServer.CommonDBATasks.CreateUser.md b/doc_source/Appendix.SQLServer.CommonDBATasks.CreateUser.md deleted file mode 100644 index 7ce9118..0000000 --- a/doc_source/Appendix.SQLServer.CommonDBATasks.CreateUser.md +++ /dev/null @@ -1,23 +0,0 @@ -# Creating a database user - -You can create a database user for your Amazon RDS for Microsoft SQL Server DB instance by running a T\-SQL script like the following example\. Use an application such as SQL Server Management Suite \(SSMS\)\. You log into the DB instance as the master user that was created when you created the DB instance\. - -``` ---Initially set context to master database -USE [master]; -GO ---Create a server-level login named theirname with password theirpassword -CREATE LOGIN [theirname] WITH PASSWORD = 'theirpassword'; -GO ---Set context to msdb database -USE [msdb]; -GO ---Create a database user named theirname and link it to server-level login theirname -CREATE USER [theirname] FOR LOGIN [theirname]; -GO -``` - -For an example of adding a database user to a role, see [Adding a user to the SQLAgentUser role](Appendix.SQLServer.CommonDBATasks.Agent.md#SQLServerAgent.AddUser)\. - -**Note** -If you get permission errors when adding a user, you can restore privileges by modifying the DB instance master user password\. For more information, see [Resetting the `db_owner` role password](Appendix.SQLServer.CommonDBATasks.ResetPassword.md)\. \ No newline at end of file diff --git a/doc_source/Appendix.SQLServer.CommonDBATasks.DatabaseRecovery.md b/doc_source/Appendix.SQLServer.CommonDBATasks.DatabaseRecovery.md deleted file mode 100644 index cc6a1f8..0000000 --- a/doc_source/Appendix.SQLServer.CommonDBATasks.DatabaseRecovery.md +++ /dev/null @@ -1,14 +0,0 @@ -# Determining a recovery model for your Microsoft SQL Server database - -In Amazon RDS, the recovery model, retention period, and database status are linked\. - -It's important to understand the consequences before making a change to one of these settings\. Each setting can affect the others\. For example: -+ If you change a database's recovery model to SIMPLE or BULK\_LOGGED while backup retention is enabled, Amazon RDS resets the recovery model to FULL within five minutes\. This also results in RDS taking a snapshot of the DB instance\. -+ If you set backup retention to `0` days, RDS sets the recovery mode to SIMPLE\. -+ If you change a database's recovery model from SIMPLE to any other option while backup retention is set to `0` days, RDS resets the recovery model to SIMPLE\. - -**Important** -Never change the recovery model on Multi\-AZ instances, even if it seems you can do so—for example, by using ALTER DATABASE\. Backup retention, and therefore FULL recovery mode, is required for Multi\-AZ\. If you alter the recovery model, RDS immediately changes it back to FULL\. -This automatic reset forces RDS to completely rebuild the mirror\. During this rebuild, the availability of the database is degraded for about 30\-90 minutes until the mirror is ready for failover\. The DB instance also experiences performance degradation in the same way it does during a conversion from Single\-AZ to Multi\-AZ\. How long performance is degraded depends on the database storage size—the bigger the stored database, the longer the degradation\. - -For more information on SQL Server recovery models, see [Recovery models \(SQL Server\)](https://docs.microsoft.com/en-us/sql/relational-databases/backup-restore/recovery-models-sql-server) in the Microsoft documentation\. \ No newline at end of file diff --git a/doc_source/Appendix.SQLServer.CommonDBATasks.DisableFastInserts.md b/doc_source/Appendix.SQLServer.CommonDBATasks.DisableFastInserts.md deleted file mode 100644 index 5b9b1dc..0000000 --- a/doc_source/Appendix.SQLServer.CommonDBATasks.DisableFastInserts.md +++ /dev/null @@ -1,9 +0,0 @@ -# Disabling fast inserts during bulk loading - -Starting with SQL Server 2016, fast inserts are enabled by default\. Fast inserts leverage the minimal logging that occurs while the database is in the simple or bulk logged recovery model to optimize insert performance\. With fast inserts, each bulk load batch acquires new extents, bypassing the allocation lookup for existing extents with available free space to optimize insert performance\. - -However, with fast inserts bulk loads with small batch sizes can lead to increased unused space consumed by objects\. If increasing batch size isn't feasible, enabling trace flag 692 can help reduce unused reserved space, but at the expense of performance\. Enabling this trace flag disables fast inserts while bulk loading data into heap or clustered indexes\. - -You enable trace flag 692 as a startup parameter using DB parameter groups\. For more information, see [Working with parameter groups](USER_WorkingWithParamGroups.md)\. - -Trace flag 692 is supported for Amazon RDS on SQL Server 2016 and later\. For more information on trace flags, see [DBCC TRACEON \- trace flags](https://docs.microsoft.com/en-us/sql/t-sql/database-console-commands/dbcc-traceon-trace-flags-transact-sql) in the Microsoft documentation\. \ No newline at end of file diff --git a/doc_source/Appendix.SQLServer.CommonDBATasks.DropMirrorDB.md b/doc_source/Appendix.SQLServer.CommonDBATasks.DropMirrorDB.md deleted file mode 100644 index 0659924..0000000 --- a/doc_source/Appendix.SQLServer.CommonDBATasks.DropMirrorDB.md +++ /dev/null @@ -1,13 +0,0 @@ -# Dropping a Microsoft SQL Server database - -You can drop a database on an Amazon RDS DB instance running Microsoft SQL Server in a Single\-AZ or Multi\-AZ deployment\. To drop the database, use the following command: - -``` ---replace your-database-name with the name of the database you want to drop -EXECUTE msdb.dbo.rds_drop_database N'your-database-name' -``` - -**Note** -Use straight single quotes in the command\. Smart quotes will cause an error\. - -After you use this procedure to drop the database, Amazon RDS drops all existing connections to the database and removes the database's backup history\. \ No newline at end of file diff --git a/doc_source/Appendix.SQLServer.CommonDBATasks.LastFailover.md b/doc_source/Appendix.SQLServer.CommonDBATasks.LastFailover.md deleted file mode 100644 index ae6ce16..0000000 --- a/doc_source/Appendix.SQLServer.CommonDBATasks.LastFailover.md +++ /dev/null @@ -1,36 +0,0 @@ -# Determining the last failover time - -To determine the last failover time, use the following stored procedure: - -``` -execute msdb.dbo.rds_failover_time; -``` - -This procedure returns the following information\. - - -**** - -| Output parameter | Description | -| --- | --- | -| errorlog\_available\_from | Shows the time from when error logs are available in the log directory\. | -| recent\_failover\_time | Shows the last failover time if it's available from the error logs\. Otherwise it shows `null`\. | - -**Note** -The stored procedure searches all of the available SQL Server error logs in the log directory to retrieve the most recent failover time\. If the failover messages have been overwritten by SQL Server, then the procedure doesn't retrieve the failover time\. - -**Example of no recent failover** -This example shows the output when there is no recent failover in the error logs\. No failover has happened since 2020\-04\-29 23:59:00\.01\. - - -| errorlog\_available\_from | recent\_failover\_time | -| --- | --- | -| 2020\-04\-29 23:59:00\.0100000 | null | - -**Example of recent failover** -This example shows the output when there is a failover in the error logs\. The most recent failover was at 2020\-05\-05 18:57:51\.89\. - - -| errorlog\_available\_from | recent\_failover\_time | -| --- | --- | -| 2020\-04\-29 23:59:00\.0100000 | 2020\-05\-05 18:57:51\.8900000 | \ No newline at end of file diff --git a/doc_source/Appendix.SQLServer.CommonDBATasks.Logs.md b/doc_source/Appendix.SQLServer.CommonDBATasks.Logs.md deleted file mode 100644 index 7fdfa67..0000000 --- a/doc_source/Appendix.SQLServer.CommonDBATasks.Logs.md +++ /dev/null @@ -1,32 +0,0 @@ -# Working with Microsoft SQL Server logs - -You can use the Amazon RDS console to view, watch, and download SQL Server Agent logs, Microsoft SQL Server error logs, and SQL Server Reporting Services \(SSRS\) logs\. - -## Watching log files - -If you view a log in the Amazon RDS console, you can see its contents as they exist at that moment\. Watching a log in the console opens it in a dynamic state so that you can see updates to it in near\-real time\. - -Only the latest log is active for watching\. For example, suppose you have the following logs shown: - -![\[Image NOT FOUND\]](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/images/logs_sqlserver.png) - -Only log/ERROR, as the most recent log, is being actively updated\. You can choose to watch others, but they are static and will not update\. - -## Archiving log files - -The Amazon RDS console shows logs for the past week through the current day\. You can download and archive logs to keep them for reference past that time\. One way to archive logs is to load them into an Amazon S3 bucket\. For instructions on how to set up an Amazon S3 bucket and upload a file, see [Amazon S3 basics](https://docs.aws.amazon.com/AmazonS3/latest/gsg/AmazonS3Basics.html) in the *Amazon Simple Storage Service Getting Started Guide* and click **Get Started**\. - -## Viewing error and agent logs - -To view Microsoft SQL Server error and agent logs, use the Amazon RDS stored procedure `rds_read_error_log` with the following parameters: -+ **`@index`** – the version of the log to retrieve\. The default value is 0, which retrieves the current error log\. Specify 1 to retrieve the previous log, specify 2 to retrieve the one before that, and so on\. -+ **`@type`** – the type of log to retrieve\. Specify 1 to retrieve an error log\. Specify 2 to retrieve an agent log\. - -**Example** -The following example requests the current error log\. - -``` -EXEC rdsadmin.dbo.rds_read_error_log @index = 0, @type = 1; -``` - -For more information on SQL Server errors, see [Database engine errors](https://docs.microsoft.com/en-us/sql/relational-databases/errors-events/database-engine-events-and-errors) in the Microsoft documentation\. \ No newline at end of file diff --git a/doc_source/Appendix.SQLServer.CommonDBATasks.RenamingDB.md b/doc_source/Appendix.SQLServer.CommonDBATasks.RenamingDB.md deleted file mode 100644 index 9837588..0000000 --- a/doc_source/Appendix.SQLServer.CommonDBATasks.RenamingDB.md +++ /dev/null @@ -1,21 +0,0 @@ -# Renaming a Microsoft SQL Server database in a Multi\-AZ deployment - -To rename a Microsoft SQL Server database instance that uses Multi\-AZ, use the following procedure: - -1. First, turn off Multi\-AZ for the DB instance\. - -1. Rename the database by running `rdsadmin.dbo.rds_modify_db_name`\. - -1. Then, turn on Multi\-AZ Mirroring or Always On Availability Groups for the DB instance, to return it to its original state\. - -For more information, see [Adding Multi\-AZ to a Microsoft SQL Server DB instance](USER_SQLServerMultiAZ.md#USER_SQLServerMultiAZ.Adding)\. - -**Note** -If your instance doesn't use Multi\-AZ, you don't need to change any settings before or after running `rdsadmin.dbo.rds_modify_db_name`\. - -**Example: **In the following example, the `rdsadmin.dbo.rds_modify_db_name` stored procedure renames a database from **MOO** to **ZAR**\. This is similar to running the statement `DDL ALTER DATABASE [MOO] MODIFY NAME = [ZAR]`\. - -``` -EXEC rdsadmin.dbo.rds_modify_db_name N'MOO', N'ZAR' -GO -``` \ No newline at end of file diff --git a/doc_source/Appendix.SQLServer.CommonDBATasks.ResetPassword.md b/doc_source/Appendix.SQLServer.CommonDBATasks.ResetPassword.md deleted file mode 100644 index 445c2d9..0000000 --- a/doc_source/Appendix.SQLServer.CommonDBATasks.ResetPassword.md +++ /dev/null @@ -1,3 +0,0 @@ -# Resetting the `db_owner` role password - -If you lock yourself out of the `db_owner` role on your Microsoft SQL Server database, you can reset the `db_owner` role password by modifying the DB instance master password\. By changing the DB instance master password, you can regain access to the DB instance, access databases using the modified password for the `db_owner`, and restore privileges for the `db_owner` role that may have been accidentally revoked\. You can change the DB instance password by using the Amazon RDS console, the AWS CLI command [modify\-db\-instance](https://docs.aws.amazon.com/cli/latest/reference/rds/modify-db-instance.html), or by using the [ModifyDBInstance](https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_ModifyDBInstance.html) operation\. For more information about modifying a DB instance, see [Modifying an Amazon RDS DB instance](Overview.DBInstance.Modifying.md)\. \ No newline at end of file diff --git a/doc_source/Appendix.SQLServer.CommonDBATasks.RestoreLTI.md b/doc_source/Appendix.SQLServer.CommonDBATasks.RestoreLTI.md deleted file mode 100644 index f5ac03b..0000000 --- a/doc_source/Appendix.SQLServer.CommonDBATasks.RestoreLTI.md +++ /dev/null @@ -1,29 +0,0 @@ -# Restoring license\-terminated DB instances - -Microsoft has requested that some Amazon RDS customers who did not report their Microsoft License Mobility information terminate their DB instance\. Amazon RDS takes snapshots of these DB instances, and you can restore from the snapshot to a new DB instance that has the License Included model\. - -You can restore from a snapshot of Standard Edition to either Standard Edition or Enterprise Edition\. - -You can restore from a snapshot of Enterprise Edition to either Standard Edition or Enterprise Edition\. - -**To restore from a SQL Server snapshot after Amazon RDS has created a final snapshot of your instance** - -1. Sign in to the AWS Management Console and open the Amazon RDS console at [https://console\.aws\.amazon\.com/rds/](https://console.aws.amazon.com/rds/)\. - -1. In the navigation pane, choose **Snapshots**\. - -1. Choose the snapshot of your SQL Server DB instance\. Amazon RDS creates a final snapshot of your DB instance\. The name of the terminated instance snapshot is in the format `instance_name-final-snapshot`\. For example, if your DB instance name is **mytest\.cdxgahslksma\.us\-east\-1\.rds\.com**, the final snapshot is called** mytest\-final\-snapshot** and is located in the same AWS Region as the original DB instance\. - -1. For **Actions**, choose **Restore Snapshot**\. - - The **Restore DB Instance** window appears\. - -1. For **License Model**, choose **license\-included**\. - -1. Choose the SQL Server DB engine that you want to use\. - -1. For **DB Instance Identifier**, enter the name for the restored DB instance\. - -1. Choose **Restore DB Instance**\. - -For more information about restoring from a snapshot, see [Restoring from a DB snapshot](USER_RestoreFromSnapshot.md)\. \ No newline at end of file diff --git a/doc_source/Appendix.SQLServer.CommonDBATasks.TraceFiles.md b/doc_source/Appendix.SQLServer.CommonDBATasks.TraceFiles.md deleted file mode 100644 index 5b4dbb1..0000000 --- a/doc_source/Appendix.SQLServer.CommonDBATasks.TraceFiles.md +++ /dev/null @@ -1,51 +0,0 @@ -# Working with trace and dump files - -This section describes working with trace files and dump files for your Amazon RDS DB instances running Microsoft SQL Server\. - -## Generating a trace SQL query - -``` -1. declare @rc int -2. declare @TraceID int -3. declare @maxfilesize bigint -4. -5. set @maxfilesize = 5 -6. -7. exec @rc = sp_trace_create @TraceID output, 0, N'D:\rdsdbdata\log\rdstest', @maxfilesize, NULL -``` - -## Viewing an open trace - -``` -1. select * from ::fn_trace_getinfo(default) -``` - -## Viewing trace contents - -``` -1. select * from ::fn_trace_gettable('D:\rdsdbdata\log\rdstest.trc', default) -``` - -## Setting the retention period for trace and dump files - -Trace and dump files can accumulate and consume disk space\. By default, Amazon RDS purges trace and dump files that are older than seven days\. - -To view the current trace and dump file retention period, use the `rds_show_configuration` procedure, as shown in the following example\. - -``` -1. exec rdsadmin..rds_show_configuration; -``` - -To modify the retention period for trace files, use the `rds_set_configuration` procedure and set the `tracefile retention` in minutes\. The following example sets the trace file retention period to 24 hours\. - -``` -1. exec rdsadmin..rds_set_configuration 'tracefile retention', 1440; -``` - -To modify the retention period for dump files, use the `rds_set_configuration` procedure and set the `dumpfile retention` in minutes\. The following example sets the dump file retention period to 3 days\. - -``` -1. exec rdsadmin..rds_set_configuration 'dumpfile retention', 4320; -``` - -For security reasons, you cannot delete a specific trace or dump file on a SQL Server DB instance\. To delete all unused trace or dump files, set the retention period for the files to 0\. \ No newline at end of file diff --git a/doc_source/Appendix.SQLServer.CommonDBATasks.TransitionOnline.md b/doc_source/Appendix.SQLServer.CommonDBATasks.TransitionOnline.md deleted file mode 100644 index caf1b7d..0000000 --- a/doc_source/Appendix.SQLServer.CommonDBATasks.TransitionOnline.md +++ /dev/null @@ -1,10 +0,0 @@ -# Transitioning a Microsoft SQL Server database from OFFLINE to ONLINE - -You can transition your Microsoft SQL Server database on an Amazon RDS DB instance from `OFFLINE` to `ONLINE`\. - - -**** - -| SQL Server method | Amazon RDS method | -| --- | --- | -| ALTER DATABASE *db\_name* SET ONLINE; | EXEC rdsadmin\.dbo\.rds\_set\_database\_online *db\_name* | \ No newline at end of file diff --git a/doc_source/Appendix.SQLServer.CommonDBATasks.Workload.md b/doc_source/Appendix.SQLServer.CommonDBATasks.Workload.md deleted file mode 100644 index ec94fb3..0000000 --- a/doc_source/Appendix.SQLServer.CommonDBATasks.Workload.md +++ /dev/null @@ -1,100 +0,0 @@ -# Analyzing your database workload on an Amazon RDS for SQL Server DB instance with Database Engine Tuning Advisor - -Database Engine Tuning Advisor is a client application provided by Microsoft that analyzes database workload and recommends an optimal set of indexes for your Microsoft SQL Server databases based on the kinds of queries you run\. Like SQL Server Management Studio, you run Tuning Advisor from a client computer that connects to your Amazon RDS DB instance that is running SQL Server\. The client computer can be a local computer that you run on premises within your own network or it can be an Amazon EC2 Windows instance that is running in the same region as your Amazon RDS DB instance\. - -This section shows how to capture a workload for Tuning Advisor to analyze\. This is the preferred process for capturing a workload because Amazon RDS restricts host access to the SQL Server instance\. For more information, see [Database Engine Tuning Advisor](https://docs.microsoft.com/en-us/sql/relational-databases/performance/database-engine-tuning-advisor) in the Microsoft documentation\. - -To use Tuning Advisor, you must provide what is called a workload to the advisor\. A workload is a set of Transact\-SQL statements that run against a database or databases that you want to tune\. Database Engine Tuning Advisor uses trace files, trace tables, Transact\-SQL scripts, or XML files as workload input when tuning databases\. When working with Amazon RDS, a workload can be a file on a client computer or a database table on an Amazon RDS for SQL Server DB accessible to your client computer\. The file or the table must contain queries against the databases you want to tune in a format suitable for replay\. - -For Tuning Advisor to be most effective, a workload should be as realistic as possible\. You can generate a workload file or table by performing a trace against your DB instance\. While a trace is running, you can either simulate a load on your DB instance or run your applications with a normal load\. - -There are two types of traces: client\-side and server\-side\. A client\-side trace is easier to set up and you can watch trace events being captured in real\-time in SQL Server Profiler\. A server\-side trace is more complex to set up and requires some Transact\-SQL scripting\. In addition, because the trace is written to a file on the Amazon RDS DB instance, storage space is consumed by the trace\. It is important to track of how much storage space a running server\-side trace uses because the DB instance could enter a storage\-full state and would no longer be available if it runs out of storage space\. - -For a client\-side trace, when a sufficient amount of trace data has been captured in the SQL Server Profiler, you can then generate the workload file by saving the trace to either a file on your local computer or in a database table on a DB instance that is available to your client computer\. The main disadvantage of using a client\-side trace is that the trace may not capture all queries when under heavy loads\. This could weaken the effectiveness of the analysis performed by the Database Engine Tuning Advisor\. If you need to run a trace under heavy loads and you want to ensure that it captures every query during a trace session, you should use a server\-side trace\. - -For a server\-side trace, you must get the trace files on the DB instance into a suitable workload file or you can save the trace to a table on the DB instance after the trace completes\. You can use the SQL Server Profiler to save the trace to a file on your local computer or have the Tuning Advisor read from the trace table on the DB instance\. - -## Running a client\-side trace on a SQL Server DB instance - - **To run a client\-side trace on a SQL Server DB instance** - -1. Start SQL Server Profiler\. It is installed in the Performance Tools folder of your SQL Server instance folder\. You must load or define a trace definition template to start a client\-side trace\. - -1. In the SQL Server Profiler File menu, choose **New Trace**\. In the **Connect to Server** dialog box, enter the DB instance endpoint, port, master user name, and password of the database you would like to run a trace on\. - -1. In the **Trace Properties** dialog box, enter a trace name and choose a trace definition template\. A default template, TSQL\_Replay, ships with the application\. You can edit this template to define your trace\. Edit events and event information under the **Events Selection** tab of the **Trace Properties** dialog box\. - - For more information about trace definition templates and using the SQL Server Profiler to specify a client\-side trace, see [Database Engine Tuning Advisor](https://docs.microsoft.com/en-us/sql/relational-databases/performance/database-engine-tuning-advisor) in the Microsoft documentation\. - -1. Start the client\-side trace and watch SQL queries in real\-time as they run against your DB instance\. - -1. Select **Stop Trace** from the **File** menu when you have completed the trace\. Save the results as a file or as a trace table on you DB instance\. - -## Running a server\-side trace on a SQL Server DB instance - -Writing scripts to create a server\-side trace can be complex and is beyond the scope of this document\. This section contains sample scripts that you can use as examples\. As with a client\-side trace, the goal is to create a workload file or trace table that you can open using the Database Engine Tuning Advisor\. - -The following is an abridged example script that starts a server\-side trace and captures details to a workload file\. The trace initially saves to the file RDSTrace\.trc in the D:\\RDSDBDATA\\Log directory and rolls\-over every 100 MB so subsequent trace files are named RDSTrace\_1\.trc, RDSTrace\_2\.trc, etc\. - -``` -DECLARE @file_name NVARCHAR(245) = 'D:\RDSDBDATA\Log\RDSTrace'; -DECLARE @max_file_size BIGINT = 100; -DECLARE @on BIT = 1 -DECLARE @rc INT -DECLARE @traceid INT - -EXEC @rc = sp_trace_create @traceid OUTPUT, 2, @file_name, @max_file_size -IF (@rc = 0) BEGIN - EXEC sp_trace_setevent @traceid, 10, 1, @on - EXEC sp_trace_setevent @traceid, 10, 2, @on - EXEC sp_trace_setevent @traceid, 10, 3, @on - . . . - EXEC sp_trace_setfilter @traceid, 10, 0, 7, N'SQL Profiler' - EXEC sp_trace_setstatus @traceid, 1 - END -``` - -The following example is a script that stops a trace\. Note that a trace created by the previous script continues to run until you explicitly stop the trace or the process runs out of disk space\. - -``` -DECLARE @traceid INT -SELECT @traceid = traceid FROM ::fn_trace_getinfo(default) -WHERE property = 5 AND value = 1 AND traceid <> 1 - -IF @traceid IS NOT NULL BEGIN - EXEC sp_trace_setstatus @traceid, 0 - EXEC sp_trace_setstatus @traceid, 2 -END -``` - -You can save server\-side trace results to a database table and use the database table as the workload for the Tuning Advisor by using the fn\_trace\_gettable function\. The following commands load the results of all files named RDSTrace\.trc in the D:\\rdsdbdata\\Log directory, including all rollover files like RDSTrace\_1\.trc, into a table named RDSTrace in the current database\. - -``` -SELECT * INTO RDSTrace -FROM fn_trace_gettable('D:\rdsdbdata\Log\RDSTrace.trc', default); -``` - -To save a specific rollover file to a table, for example the RDSTrace\_1\.trc file, specify the name of the rollover file and substitute 1 instead of default as the last parameter to fn\_trace\_gettable\. - -``` -SELECT * INTO RDSTrace_1 -FROM fn_trace_gettable('D:\rdsdbdata\Log\RDSTrace_1.trc', 1); -``` - -## Running Tuning Advisor with a trace - -Once you create a trace, either as a local file or as a database table, you can then run Tuning Advisor against your DB instance\. Using Tuning Advisor with Amazon RDS is the same process as when working with a standalone, remote SQL Server instance\. You can either use the Tuning Advisor UI on your client machine or use the dta\.exe utility from the command line\. In both cases, you must connect to the Amazon RDS DB instance using the endpoint for the DB instance and provide your master user name and master user password when using Tuning Advisor\. - -The following code example demonstrates using the dta\.exe command line utility against an Amazon RDS DB instance with an endpoint of **dta\.cnazcmklsdei\.us\-east\-1\.rds\.amazonaws\.com**\. The example includes the master user name **admin** and the master user password **test**, the example database to tune is named machine named **C:\\RDSTrace\.trc**\. The example command line code also specifies a trace session named **RDSTrace1** and specifies output files to the local machine named **RDSTrace\.sql** for the SQL output script, **RDSTrace\.txt** for a result file, and **RDSTrace\.xml** for an XML file of the analysis\. There is also an error table specified on the RDSDTA database named **RDSTraceErrors**\. - -``` -dta -S dta.cnazcmklsdei.us-east-1.rds.amazonaws.com -U admin -P test -D RDSDTA -if C:\RDSTrace.trc -s RDSTrace1 -of C:\ RDSTrace.sql -or C:\ RDSTrace.txt -ox C:\ RDSTrace.xml -e RDSDTA.dbo.RDSTraceErrors -``` - -Here is the same example command line code except the input workload is a table on the remote Amazon RDS instance named **RDSTrace** which is on the **RDSDTA** database\. - -``` -dta -S dta.cnazcmklsdei.us-east-1.rds.amazonaws.com -U admin -P test -D RDSDTA -it RDSDTA.dbo.RDSTrace -s RDSTrace1 -of C:\ RDSTrace.sql -or C:\ RDSTrace.txt -ox C:\ RDSTrace.xml -e RDSDTA.dbo.RDSTraceErrors -``` - -For a full list of dta utility command\-line parameters, see [dta Utility](https://docs.microsoft.com/en-us/sql/tools/dta/dta-utility) in the Microsoft documentation\. \ No newline at end of file diff --git a/doc_source/Appendix.SQLServer.CommonDBATasks.md b/doc_source/Appendix.SQLServer.CommonDBATasks.md deleted file mode 100644 index c7c39e4..0000000 --- a/doc_source/Appendix.SQLServer.CommonDBATasks.md +++ /dev/null @@ -1,24 +0,0 @@ -# Common DBA tasks for Microsoft SQL Server - -This section describes the Amazon RDS\-specific implementations of some common DBA tasks for DB instances that are running the Microsoft SQL Server database engine\. In order to deliver a managed service experience, Amazon RDS does not provide shell access to DB instances, and it restricts access to certain system procedures and tables that require advanced privileges\. - -**Note** -When working with a SQL Server DB instance, you can run scripts to modify a newly created database, but you cannot modify the \[model\] database, the database used as the model for new databases\. - -**Topics** -+ [Accessing the tempdb database on Microsoft SQL Server DB instances on Amazon RDS](SQLServer.TempDB.md) -+ [Analyzing your database workload on an Amazon RDS for SQL Server DB instance with Database Engine Tuning Advisor](Appendix.SQLServer.CommonDBATasks.Workload.md) -+ [Collations and character sets for Microsoft SQL Server](Appendix.SQLServer.CommonDBATasks.Collation.md) -+ [Creating a database user](Appendix.SQLServer.CommonDBATasks.CreateUser.md) -+ [Determining a recovery model for your Microsoft SQL Server database](Appendix.SQLServer.CommonDBATasks.DatabaseRecovery.md) -+ [Determining the last failover time](Appendix.SQLServer.CommonDBATasks.LastFailover.md) -+ [Disabling fast inserts during bulk loading](Appendix.SQLServer.CommonDBATasks.DisableFastInserts.md) -+ [Dropping a Microsoft SQL Server database](Appendix.SQLServer.CommonDBATasks.DropMirrorDB.md) -+ [Renaming a Microsoft SQL Server database in a Multi\-AZ deployment](Appendix.SQLServer.CommonDBATasks.RenamingDB.md) -+ [Resetting the `db_owner` role password](Appendix.SQLServer.CommonDBATasks.ResetPassword.md) -+ [Restoring license\-terminated DB instances](Appendix.SQLServer.CommonDBATasks.RestoreLTI.md) -+ [Transitioning a Microsoft SQL Server database from OFFLINE to ONLINE](Appendix.SQLServer.CommonDBATasks.TransitionOnline.md) -+ [Using change data capture](Appendix.SQLServer.CommonDBATasks.CDC.md) -+ [Using SQL Server Agent](Appendix.SQLServer.CommonDBATasks.Agent.md) -+ [Working with Microsoft SQL Server logs](Appendix.SQLServer.CommonDBATasks.Logs.md) -+ [Working with trace and dump files](Appendix.SQLServer.CommonDBATasks.TraceFiles.md) \ No newline at end of file diff --git a/doc_source/Appendix.SQLServer.Options.Audit.md b/doc_source/Appendix.SQLServer.Options.Audit.md deleted file mode 100644 index 5e6e1f4..0000000 --- a/doc_source/Appendix.SQLServer.Options.Audit.md +++ /dev/null @@ -1,269 +0,0 @@ -# SQL Server Audit - -In Amazon RDS, you can audit Microsoft SQL Server databases by using the built\-in SQL Server auditing mechanism\. You can create audits and audit specifications in the same way that you create them for on\-premises database servers\. - -RDS uploads the completed audit logs to your S3 bucket, using the IAM role that you provide\. If you enable retention, RDS keeps your audit logs on your DB instance for the configured period of time\. - -For more information, see [SQL Server Audit \(database engine\)](https://docs.microsoft.com/sql/relational-databases/security/auditing/sql-server-audit-database-engine) in the Microsoft SQL Server documentation\. - -## SQL Server Audit with Database Activity Streams - -You can use Database Activity Streams for RDS to integrate SQL Server Audit events with database activity monitoring tools from Imperva, McAfee, and IBM\. For more information about auditing with Database Activity Streams for RDS SQL Server, see [Auditing in Microsoft SQL Server](DBActivityStreams.Overview.md#DBActivityStreams.Overview.SQLServer-auditing) - -**Topics** -+ [SQL Server Audit with Database Activity Streams](#Appendix.SQLServer.DAS.Audit) -+ [Support for SQL Server Audit](#Appendix.SQLServer.Options.Audit.Support) -+ [Adding SQL Server Audit to the DB instance options](#Appendix.SQLServer.Options.Audit.Adding) -+ [Using SQL Server Audit](#Appendix.SQLServer.Options.Audit.CreateAuditsAndSpecifications) -+ [Viewing audit logs](#Appendix.SQLServer.Options.Audit.AuditRecords) -+ [Using SQL Server Audit with Multi\-AZ instances](#Appendix.SQLServer.Options.Audit.Multi-AZ) -+ [Configuring an S3 bucket](#Appendix.SQLServer.Options.Audit.S3bucket) -+ [Manually creating an IAM role for SQL Server Audit](#Appendix.SQLServer.Options.Audit.IAM) - -## Support for SQL Server Audit - -In Amazon RDS, starting with SQL Server 2014, all editions of SQL Server support server\-level audits, and the Enterprise edition also supports database\-level audits\. Starting with SQL Server 2016 \(13\.x\) SP1, all editions support both server\-level and database\-level audits\. For more information, see [SQL Server Audit \(database engine\)](https://docs.microsoft.com/sql/relational-databases/security/auditing/sql-server-audit-database-engine) in the SQL Server documentation\. - -RDS supports configuring the following option settings for SQL Server Audit\. - - -| Option setting | Valid values | Description | -| --- | --- | --- | -| IAM\_ROLE\_ARN | A valid Amazon Resource Name \(ARN\) in the format arn:aws:iam::account\-id:role/role\-name\. | The ARN of the IAM role that grants access to the S3 bucket where you want to store your audit logs\. For more information, see [Amazon Resource Names \(ARNs\)](https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html#arn-syntax-iam) in the AWS General Reference\. | -| S3\_BUCKET\_ARN | A valid ARN in the format arn:aws:s3:::bucket\-name or arn:aws:s3:::bucket\-name/key\-prefix | The ARN for the S3 bucket where you want to store your audit logs\. | -| ENABLE\_COMPRESSION | true or false | Controls audit log compression\. By default, compression is enabled \(set to true\)\. | -| RETENTION\_TIME | 0 to 840 | The retention time \(in hours\) that SQL Server audit records are kept on your RDS instance\. By default, retention is disabled\. | - -RDS supports SQL Server Audit in all AWS Regions except Middle East \(Bahrain\)\. - -## Adding SQL Server Audit to the DB instance options - -Enabling SQL Server Audit requires two steps: enabling the option on the DB instance, and enabling the feature inside SQL Server\. The process for adding the SQL Server Audit option to a DB instance is as follows: - -1. Create a new option group, or copy or modify an existing option group\. - -1. Add and configure all required options\. - -1. Associate the option group with the DB instance\. - -After you add the SQL Server Audit option, you don't need to restart your DB instance\. As soon as the option group is active, you can create audits and store audit logs in your S3 bucket\. - -**To add and configure SQL Server Audit on a DB instance's option group** - -1. Choose one of the following: - + Use an existing option group\. - + Create a custom DB option group and use that option group\. For more information, see [Creating an option group](USER_WorkingWithOptionGroups.md#USER_WorkingWithOptionGroups.Create)\. - -1. Add the **SQLSERVER\_AUDIT** option to the option group, and configure the option settings\. For more information about adding options, see [Adding an option to an option group](USER_WorkingWithOptionGroups.md#USER_WorkingWithOptionGroups.AddOption)\. - + For **IAM role**, if you already have an IAM role with the required policies, you can choose that role\. To create a new IAM role, choose **Create a New Role**\. For information about the required policies, see [Manually creating an IAM role for SQL Server Audit](#Appendix.SQLServer.Options.Audit.IAM)\. - + For **Select S3 destination**, if you already have an S3 bucket that you want to use, choose it\. To create an S3 bucket, choose **Create a New S3 Bucket**\. - + For **Enable Compression**, leave this option chosen to compress audit files\. Compression is enabled by default\. To disable compression, clear **Enable Compression**\. - + For **Audit log retention**, to keep audit records on the DB instance, choose this option\. Specify a retention time in hours\. The maximum retention time is 35 days\. - -1. Apply the option group to a new or existing DB instance\. Choose one of the following: - + If you are creating a new DB instance, apply the option group when you launch the instance\. - + On an existing DB instance, apply the option group by modifying the instance and then attaching the new option group\. For more information, see [Modifying an Amazon RDS DB instance](Overview.DBInstance.Modifying.md)\. - -### Modifying the SQL Server Audit option - -After you enable the SQL Server Audit option, you can modify the settings\. For information about how to modify option settings, see [Modifying an option setting](USER_WorkingWithOptionGroups.md#USER_WorkingWithOptionGroups.ModifyOption)\. - -### Removing SQL Server Audit from the DB instance options - -You can turn off the SQL Server Audit feature by disabling audits and then deleting the option\. - -**To remove auditing** - -1. Disable all of the audit settings inside SQL Server\. To learn where audits are running, query the SQL Server security catalog views\. For more information, see [Security catalog views](https://docs.microsoft.com/sql/relational-databases/system-catalog-views/security-catalog-views-transact-sql) in the Microsoft SQL Server documentation\. - -1. Delete the SQL Server Audit option from the DB instance\. Choose one of the following: - + Delete the SQL Server Audit option from the option group that the DB instance uses\. This change affects all DB instances that use the same option group\. For more information, see [Removing an option from an option group](USER_WorkingWithOptionGroups.md#USER_WorkingWithOptionGroups.RemoveOption)\. - + Modify the DB instance, and then choose an option group without the SQL Server Audit option\. This change affects only the DB instance that you modify\. You can specify the default \(empty\) option group, or a different custom option group\. For more information, see [Modifying an Amazon RDS DB instance](Overview.DBInstance.Modifying.md)\. - -1. After you delete the SQL Server Audit option from the DB instance, you don't need to restart the instance\. Remove unneeded audit files from your S3 bucket\. - -## Using SQL Server Audit - -You can control server audits, server audit specifications, and database audit specifications the same way that you control them for on\-premises database servers\. - -### Creating audits - -You create server audits in the same way that you create them for on\-premises database servers\. For information about how to create server audits, see [CREATE SERVER AUDIT](https://docs.microsoft.com/sql/t-sql/statements/create-server-audit-transact-sql) in the Microsoft SQL Server documentation\. - -To avoid errors, adhere to the following limitations: -+ Don't exceed the maximum number of supported server audits per instance of 50\. -+ Instruct SQL Server to write data to a binary file\. -+ Don't use `RDS_` as a prefix in the server audit name\. -+ For `FILEPATH`, specify `D:\rdsdbdata\SQLAudit`\. -+ For `MAXSIZE`, specify a size between 2 MB and 50 MB\. -+ Don't configure `MAX_ROLLOVER_FILES` or `MAX_FILES`\. -+ Don't configure SQL Server to shut down the DB instance if it fails to write the audit record\. - -### Creating audit specifications - -You create server audit specifications and database audit specifications the same way that you create them for on\-premises database servers\. For information about creating audit specifications, see [CREATE SERVER AUDIT SPECIFICATION](https://docs.microsoft.com/sql/t-sql/statements/create-server-audit-specification-transact-sql) and [CREATE DATABASE AUDIT SPECIFICATION](https://docs.microsoft.com/sql/t-sql/statements/create-database-audit-specification-transact-sql) in the Microsoft SQL Server documentation\. - -To avoid errors, don't use `RDS_` as a prefix in the name of the database audit specification or server audit specification\. - -## Viewing audit logs - -Your audit logs are stored in `D:\rdsdbdata\SQLAudit`\. - -After SQL Server finishes writing to an audit log file—when the file reaches its size limit—Amazon RDS uploads the file to your S3 bucket\. If retention is enabled, Amazon RDS moves the file into the retention folder: `D:\rdsdbdata\SQLAudit\transmitted`\. - -For information about configuring retention, see [Adding SQL Server Audit to the DB instance options](#Appendix.SQLServer.Options.Audit.Adding)\. - -Audit records are kept on the DB instance until the audit log file is uploaded\. You can view the audit records by running the following command\. - -``` -SELECT * - FROM msdb.dbo.rds_fn_get_audit_file - ('D:\rdsdbdata\SQLAudit\*.sqlaudit' - , default - , default ) -``` - -You can use the same command to view audit records in your retention folder by changing the filter to `D:\rdsdbdata\SQLAudit\transmitted\*.sqlaudit`\. - -``` -SELECT * - FROM msdb.dbo.rds_fn_get_audit_file - ('D:\rdsdbdata\SQLAudit\transmitted\*.sqlaudit' - , default - , default ) -``` - -## Using SQL Server Audit with Multi\-AZ instances - -For Multi\-AZ instances, the process for sending audit log files to Amazon S3 is similar to the process for Single\-AZ instances\. However, there are some important differences: -+ Database audit specification objects are replicated to all nodes\. -+ Server audits and server audit specifications aren't replicated to secondary nodes\. Instead, you have to create or modify them manually\. - -To capture server audits or a server audit specification from both nodes: - -1. Create a server audit or a server audit specification on the primary node\. - -1. Fail over to the secondary node and create a server audit or a server audit specification with the same name and GUID on the secondary node\. Use the `AUDIT_GUID` parameter to specify the GUID\. - -## Configuring an S3 bucket - -The audit log files are automatically uploaded from the DB instance to your S3 bucket\. The following restrictions apply to the S3 bucket that you use as a target for audit files: -+ It must be in the same AWS Region as the DB instance\. -+ It must not be open to the public\. -+ It can't use [S3 Object Lock](https://docs.aws.amazon.com/AmazonS3/latest/dev/object-lock-overview.html)\. -+ The bucket owner must also be the IAM role owner\. - -The target key that is used to store the data follows this naming schema: `bucket-name/key-prefix/instance-name/audit-name/node_file-name.ext` - -**Note** -You set both the bucket name and the key prefix values with the \(`S3_BUCKET_ARN`\) option setting\. - -The schema is composed of the following elements: -+ **`bucket-name`** – The name of your S3 bucket\. -+ **`key-prefix`** – The custom key prefix you want to use for audit logs\. -+ **`instance-name`** – The name of your Amazon RDS instance\. -+ **`audit-name`** – The name of the audit\. -+ **`node`** – The identifier of the node that is the source of the audit logs \(`node1` or `node2`\)\. There is one node for a Single\-AZ instance and two replication nodes for a Multi\-AZ instance\. These are not primary and secondary nodes, because the roles of primary and secondary change over time\. Instead, the node identifier is a simple label\. - + **`node1`** – The first replication node \(Single\-AZ has one node only\)\. - + **`node2`** – The second replication node \(Multi\-AZ has two nodes\)\. -+ **`file-name`** – The target file name\. The file name is taken as\-is from SQL Server\. -+ **`ext`** – The extension of the file \(`zip` or `sqlaudit`\): - + **`zip`** – If compression is enabled \(default\)\. - + **`sqlaudit`** – If compression is disabled\. - -## Manually creating an IAM role for SQL Server Audit - -Typically, when you create a new option, the AWS Management Console creates the IAM role and the IAM trust policy for you\. However, you can manually create a new IAM role to use with SQL Server Audits, so that you can customize it with any additional requirements you might have\. To do this, you create an IAM role and delegate permissions so that the Amazon RDS service can use your Amazon S3 bucket\. When you create this IAM role, you attach trust and permissions policies\. The trust policy allows Amazon RDS to assume this role\. The permission policy defines the actions that this role can do\. For more information, see [Creating a role to delegate permissions to an AWS service](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_create_for-service.html) in the *AWS Identity and Access Management User Guide*\. - -You can use the examples in this section to create the trust relationships and permissions policies you need\. - -The following example shows a trust relationship for SQL Server Audit\. It uses the *service principal* `rds.amazonaws.com` to allow RDS to write to the S3 bucket\. A *service principal* is an identifier that is used to grant permissions to a service\. Anytime you allow access to `rds.amazonaws.com` in this way, you are allowing RDS to perform an action on your behalf\. For more information about service principals, see [AWS JSON policy elements: Principal](https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies_elements_principal.html)\. - -**Example trust relationship for SQL Server Audit** - -``` -{ - "Version": "2012-10-17", - "Statement": [ - { - "Effect": "Allow", - "Principal": { - "Service": "rds.amazonaws.com" - }, - "Action": "sts:AssumeRole" - } - ] - } -``` - -We recommend using the [https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies_condition-keys.html#condition-keys-sourcearn](https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies_condition-keys.html#condition-keys-sourcearn) and [https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies_condition-keys.html#condition-keys-sourceaccount](https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies_condition-keys.html#condition-keys-sourceaccount) global condition context keys in resource\-based trust relationships to limit the service's permissions to a specific resource\. This is the most effective way to protect against the [confused deputy problem](https://docs.aws.amazon.com/IAM/latest/UserGuide/confused-deputy.html)\. - -You might use both global condition context keys and have the `aws:SourceArn` value contain the account ID\. In this case, the `aws:SourceAccount` value and the account in the `aws:SourceArn` value must use the same account ID when used in the same statement\. -+ Use `aws:SourceArn` if you want cross\-service access for a single resource\. -+ Use `aws:SourceAccount` if you want to allow any resource in that account to be associated with the cross\-service use\. - -In the trust relationship, make sure to use the `aws:SourceArn` global condition context key with the full Amazon Resource Name \(ARN\) of the resources accessing the role\. For SQL Server Audit, make sure to include both the DB option group and the DB instances, as shown in the following example\. - -**Example trust relationship with global condition context key for SQL Server Audit** - -``` -{ - "Version": "2012-10-17", - "Statement": [ - { - "Effect": "Allow", - "Principal": { - "Service": "rds.amazonaws.com" - }, - "Action": "sts:AssumeRole", - "Condition": { - "StringEquals": { - "aws:SourceArn": [ - "arn:aws:rds:Region:my_account_ID:db:db_instance_identifier", - "arn:aws:rds:Region:my_account_ID:og:option_group_name" - ] - } - } - } - ] -} -``` - -In the following example of a permissions policy for SQL Server Audit, we specify an ARN for the Amazon S3 bucket\. You can use ARNs to identify a specific account, user, or role that you want grant access to\. For more information about using ARNs, see [ Amazon resource names \(ARNs\)](https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html)\. - -**Example permissions policy for SQL Server Audit** - -``` -{ - "Version": "2012-10-17", - "Statement": [ - { - "Effect": "Allow", - "Action": "s3:ListAllMyBuckets", - "Resource": "*" - }, - { - "Effect": "Allow", - "Action": [ - "s3:ListBucket", - "s3:GetBucketACL", - "s3:GetBucketLocation" - ], - "Resource": "arn:aws:s3:::bucket_name" - }, - { - "Effect": "Allow", - "Action": [ - "s3:PutObject", - "s3:ListMultipartUploadParts", - "s3:AbortMultipartUpload" - ], - "Resource": "arn:aws:s3:::bucket_name/key_prefix/*" - } - ] - } -``` - -**Note** -The `s3:ListAllMyBuckets` action is required for verifying that the same AWS account owns both the S3 bucket and the SQL Server DB instance\. The action lists the names of the buckets in the account\. -S3 bucket namespaces are global\. If you accidentally delete your bucket, another user can create a bucket with the same name in a different account\. Then the SQL Server Audit data is written to the new bucket\. \ No newline at end of file diff --git a/doc_source/Appendix.SQLServer.Options.BackupRestore.md b/doc_source/Appendix.SQLServer.Options.BackupRestore.md deleted file mode 100644 index ecc2f6f..0000000 --- a/doc_source/Appendix.SQLServer.Options.BackupRestore.md +++ /dev/null @@ -1,129 +0,0 @@ -# Support for native backup and restore in SQL Server - -By using native backup and restore for SQL Server databases, you can create a differential or full backup of your on\-premises database and store the backup files on Amazon S3\. You can then restore to an existing Amazon RDS DB instance running SQL Server\. You can also back up an RDS for SQL Server database, store it on Amazon S3, and restore it in other locations\. In addition, you can restore the backup to an on\-premises server, or a different Amazon RDS DB instance running SQL Server\. For more information, see [Importing and exporting SQL Server databases using native backup and restore](SQLServer.Procedural.Importing.md)\. - -Amazon RDS supports native backup and restore for Microsoft SQL Server databases by using differential and full backup files \(\.bak files\)\. - -## Adding the native backup and restore option - -The general process for adding the native backup and restore option to a DB instance is the following: - -1. Create a new option group, or copy or modify an existing option group\. - -1. Add the `SQLSERVER_BACKUP_RESTORE` option to the option group\. - -1. Associate an AWS Identity and Access Management \(IAM\) role with the option\. The IAM role must have access to an S3 bucket to store the database backups\. - - That is, the option must have as its option setting a valid Amazon Resource Name \(ARN\) in the format `arn:aws:iam::account-id:role/role-name`\. For more information, see [Amazon Resource Names \(ARNs\)](https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html#arn-syntax-iam) in the *AWS General Reference\.* - - The IAM role must also have a trust relationship and a permissions policy attached\. The trust relationship allows RDS to assume the role, and the permissions policy defines the actions that the role can perform\. For more information, see [Manually creating an IAM role for native backup and restore](SQLServer.Procedural.Importing.md#SQLServer.Procedural.Importing.Native.Enabling.IAM)\. - -1. Associate the option group with the DB instance\. - -After you add the native backup and restore option, you don't need to restart your DB instance\. As soon as the option group is active, you can begin backing up and restoring immediately\. - -### Console - -**To add the native backup and restore option** - -1. Sign in to the AWS Management Console and open the Amazon RDS console at [https://console\.aws\.amazon\.com/rds/](https://console.aws.amazon.com/rds/)\. - -1. In the navigation pane, choose **Option groups**\. - -1. Create a new option group or use an existing option group\. For information on how to create a custom DB option group, see [Creating an option group](USER_WorkingWithOptionGroups.md#USER_WorkingWithOptionGroups.Create)\. - - To use an existing option group, skip to the next step\. - -1. Add the **SQLSERVER\_BACKUP\_RESTORE** option to the option group\. For more information about adding options, see [Adding an option to an option group](USER_WorkingWithOptionGroups.md#USER_WorkingWithOptionGroups.AddOption)\. - -1. Do one of the following: - + To use an existing IAM role and Amazon S3 settings, choose an existing IAM role for **IAM Role**\. If you use an existing IAM role, RDS uses the Amazon S3 settings configured for this role\. - + To create a new role and configure Amazon S3 settings, do the following: - - 1. For **IAM role**, choose **Create a new role**\. - - 1. For **S3 bucket**, choose an S3 bucket from the list\. - - 1. For **S3 prefix \(optional\)**, specify a prefix to use for the files stored in your Amazon S3 bucket\. - - This prefix can include a file path but doesn't have to\. If you provide a prefix, RDS attaches that prefix to all backup files\. RDS then uses the prefix during a restore to identify related files and ignore irrelevant files\. For example, you might use the S3 bucket for purposes besides holding backup files\. In this case, you can use the prefix to have RDS perform native backup and restore only on a particular folder and its subfolders\. - - If you leave the prefix blank, then RDS doesn't use a prefix to identify backup files or files to restore\. As a result, during a multiple\-file restore, RDS attempts to restore every file in every folder of the S3 bucket\. - - 1. Choose the **Enable encryption** check box to encrypt the backup file\. Leave the check box cleared \(the default\) to have the backup file unencrypted\. - - If you chose **Enable encryption**, choose an encryption key for **AWS KMS key**\. For more information about encryption keys, see [Getting started](https://docs.aws.amazon.com/kms/latest/developerguide/getting-started.html) in the *AWS Key Management Service Developer Guide\.* - -1. Choose **Add option**\. - -1. Apply the option group to a new or existing DB instance: - + For a new DB instance, apply the option group when you launch the instance\. For more information, see [Creating an Amazon RDS DB instance](USER_CreateDBInstance.md)\. - + For an existing DB instance, apply the option group by modifying the instance and attaching the new option group\. For more information, see [Modifying an Amazon RDS DB instance](Overview.DBInstance.Modifying.md)\. - -### CLI - -This procedure makes the following assumptions: -+ You're adding the SQLSERVER\_BACKUP\_RESTORE option to an option group that already exists\. For more information about adding options, see [Adding an option to an option group](USER_WorkingWithOptionGroups.md#USER_WorkingWithOptionGroups.AddOption)\. -+ You're associating the option with an IAM role that already exists and has access to an S3 bucket to store the backups\. -+ You're applying the option group to a DB instance that already exists\. For more information, see [Modifying an Amazon RDS DB instance](Overview.DBInstance.Modifying.md)\. - -**To add the native backup and restore option** - -1. Add the `SQLSERVER_BACKUP_RESTORE` option to the option group\. -**Example** - - For Linux, macOS, or Unix: - - ``` - aws rds add-option-to-option-group \ - --apply-immediately \ - --option-group-name mybackupgroup \ - --options "OptionName=SQLSERVER_BACKUP_RESTORE, \ - OptionSettings=[{Name=IAM_ROLE_ARN,Value=arn:aws:iam::account-id:role/role-name}]" - ``` - - For Windows: - - ``` - aws rds add-option-to-option-group ^ - --option-group-name mybackupgroup ^ - --options "[{\"OptionName\": \"SQLSERVER_BACKUP_RESTORE\", ^ - \"OptionSettings\": [{\"Name\": \"IAM_ROLE_ARN\", ^ - \"Value\": \"arn:aws:iam::account-id:role/role-name"}]}]" ^ - --apply-immediately - ``` -**Note** -When using the Windows command prompt, you must escape double quotes \("\) in JSON code by prefixing them with a backslash \(\\\)\. - -1. Apply the option group to the DB instance\. -**Example** - - For Linux, macOS, or Unix: - - ``` - aws rds modify-db-instance \ - --db-instance-identifier mydbinstance \ - --option-group-name mybackupgroup \ - --apply-immediately - ``` - - For Windows: - - ``` - aws rds modify-db-instance ^ - --db-instance-identifier mydbinstance ^ - --option-group-name mybackupgroup ^ - --apply-immediately - ``` - -## Modifying native backup and restore option settings - -After you enable the native backup and restore option, you can modify the settings for the option\. For more information about how to modify option settings, see [Modifying an option setting](USER_WorkingWithOptionGroups.md#USER_WorkingWithOptionGroups.ModifyOption)\. - -## Removing the native backup and restore option - -You can turn off native backup and restore by removing the option from your DB instance\. After you remove the native backup and restore option, you don't need to restart your DB instance\. - -To remove the native backup and restore option from a DB instance, do one of the following: -+ Remove the option from the option group it belongs to\. This change affects all DB instances that use the option group\. For more information, see [Removing an option from an option group](USER_WorkingWithOptionGroups.md#USER_WorkingWithOptionGroups.RemoveOption)\. -+ Modify the DB instance and specify a different option group that doesn't include the native backup and restore option\. This change affects a single DB instance\. You can specify the default \(empty\) option group, or a different custom option group\. For more information, see [Modifying an Amazon RDS DB instance](Overview.DBInstance.Modifying.md)\. \ No newline at end of file diff --git a/doc_source/Appendix.SQLServer.Options.LinkedServers_Oracle_OLEDB.md b/doc_source/Appendix.SQLServer.Options.LinkedServers_Oracle_OLEDB.md deleted file mode 100644 index 2c9edb4..0000000 --- a/doc_source/Appendix.SQLServer.Options.LinkedServers_Oracle_OLEDB.md +++ /dev/null @@ -1,353 +0,0 @@ -# Support for Linked Servers with Oracle OLEDB in Amazon RDS for SQL Server - -Linked servers with the Oracle Provider for OLEDB on RDS for SQL Server lets you access external data sources on an Oracle database\. You can read data from remote Oracle data sources and run commands against remote Oracle database servers outside of your RDS for SQL Server DB instance\. Using linked servers with Oracle OLEDB, you can: -+ Directly access data sources other than SQL Server -+ Query against diverse Oracle data sources with the same query without moving the data -+ Issue distributed queries, updates, commands, and transactions on data sources across an enterprise ecosystem -+ Integrate connections to an Oracle database from within the Microsoft Business Intelligence suite \(SSIS, SSRS, SSAS\) -+ Migrate from an Oracle database to RDS for SQL Server - -You can activate one or more linked servers for Oracle on either an existing or new RDS for SQL Server DB instance\. Then you can integrate external Oracle data sources with your DB instance\. - -**Contents** -+ [Supported versions and Regions](#LinkedServers_Oracle_OLEDB.VersionRegionSupport) -+ [Limitations and recommendations](#LinkedServers_Oracle_OLEDB.Limitations) -+ [Activating linked servers with Oracle](#LinkedServers_Oracle_OLEDB.Enabling) - + [Creating the option group for OLEDB\_ORACLE](#LinkedServers_Oracle_OLEDB.OptionGroup) - + [Adding the `OLEDB_ORACLE` option to the option group](#LinkedServers_Oracle_OLEDB.Add) - + [Associating the option group with your DB instance](#LinkedServers_Oracle_OLEDB.Apply) -+ [Modifying OLEDB provider properties](#LinkedServers_Oracle_OLEDB.ModifyProviderProperties) -+ [Modifying OLEDB driver properties](#LinkedServers_Oracle_OLEDB.ModifyDriverProperties) -+ [Deactivating linked servers with Oracle](#LinkedServers_Oracle_OLEDB.Disable) - -## Supported versions and Regions - -RDS for SQL Server supports linked servers with Oracle OLEDB in all Regions for SQL Server Standard and Enterprise Editions on the following versions: -+ SQL Server 2019, all versions -+ SQL Server 2017, all versions - -Linked servers with Oracle OLEDB is supported for the following Oracle Database versions: -+ Oracle Database 21c, all versions -+ Oracle Database 19c, all versions -+ Oracle Database 18c, all versions - -## Limitations and recommendations - -Keep in mind the following limitations and recommendations that apply to linked servers with Oracle OLEDB: -+ Allow network traffic by adding the applicable TCP port in the security group for each RDS for SQL Server DB instance\. For example, if you’re configuring a linked server between an EC2 Oracle DB instance and an RDS for SQL Server DB instance, then you must allow traffic from the IP address of the EC2 Oracle DB instance\. You also must allow traffic on the port that SQL Server is using to listen for database communication\. For more information on security groups, see [Controlling access with security groups](Overview.RDSSecurityGroups.md)\. -+ Perform a reboot of the RDS for SQL Server DB instance after turning on, turning off, or modifying the `OLEDB_ORACLE` option in your option group\. The option group status displays `pending_reboot` for these events and is required\. -+ Only simple authentication is supported with a user name and password for the Oracle data source\. -+ Open Database Connectivity \(ODBC\) drivers are not supported\. Only the latest version of the OLEDB driver is supported\. -+ Distributed transactions \(XA\) are supported\. To activate distributed transactions, turn on the `MSDTC` option in the Option Group for your DB instance and make sure XA transactions are turned on\. For more information, see [Support for Microsoft Distributed Transaction Coordinator in RDS for SQL Server](Appendix.SQLServer.Options.MSDTC.md)\. -+ Creating data source names \(DSNs\) to use as a shortcut for a connection string is not supported\. -+ OLEDB driver tracing is not supported\. You can use SQL Server Extended Events to trace OLEDB events\. For more information, see [Set up Extended Events in RDS for SQL Server](https://aws.amazon.com/blogs/database/set-up-extended-events-in-amazon-rds-for-sql-server/)\. -+ Access to the catalogs folder for an Oracle linked server is not supported using SQL Server Management Studio \(SSMS\)\. - -## Activating linked servers with Oracle - -Activate linked servers with Oracle by adding the `OLEDB_ORACLE` option to your RDS for SQL Server DB instance\. Use the following process: - -1. Create a new option group, or choose an existing option group\. - -1. Add the `OLEDB_ORACLE` option to the option group\. - -1. Choose a version of the OLEDB driver to use\. - -1. Associate the option group with the DB instance\. - -1. Reboot the DB instance\. - -### Creating the option group for OLEDB\_ORACLE - -To work with linked servers with Oracle, create an option group or modify an option group that corresponds to the SQL Server edition and version of the DB instance that you plan to use\. To complete this procedure, use the AWS Management Console or the AWS CLI\. - -#### Console - -The following procedure creates an option group for SQL Server Standard Edition 2019\. - -**To create the option group** - -1. Sign in to the AWS Management Console and open the Amazon RDS console at [https://console\.aws\.amazon\.com/rds/](https://console.aws.amazon.com/rds/)\. - -1. In the navigation pane, choose **Option groups**\. - -1. Choose **Create group**\. - -1. In the **Create option group** window, do the following: - - 1. For **Name**, enter a name for the option group that is unique within your AWS account, such as **oracle\-oledb\-se\-2019**\. The name can contain only letters, digits, and hyphens\. - - 1. For **Description**, enter a brief description of the option group, such as **OLEDB\_ORACLE option group for SQL Server SE 2019**\. The description is used for display purposes\. - - 1. For **Engine**, choose **sqlserver\-se**\. - - 1. For **Major engine version**, choose **15\.00**\. - -1. Choose **Create**\. - -#### CLI - -The following procedure creates an option group for SQL Server Standard Edition 2019\. - -**To create the option group** -+ Run one of the following commands\. -**Example** - - For Linux, macOS, or Unix: - - ``` - aws rds create-option-group \ - --option-group-name oracle-oledb-se-2019 \ - --engine-name sqlserver-se \ - --major-engine-version 15.00 \ - --option-group-description "OLEDB_ORACLE option group for SQL Server SE 2019" - ``` - - For Windows: - - ``` - aws rds create-option-group ^ - --option-group-name oracle-oledb-se-2019 ^ - --engine-name sqlserver-se ^ - --major-engine-version 15.00 ^ - --option-group-description "OLEDB_ORACLE option group for SQL Server SE 2019" - ``` - -### Adding the `OLEDB_ORACLE` option to the option group - -Next, use the AWS Management Console or the AWS CLI to add the `OLEDB_ORACLE` option to your option group\. - -#### Console - -**To add the OLEDB\_ORACLE option** - -1. Sign in to the AWS Management Console and open the Amazon RDS console at [https://console\.aws\.amazon\.com/rds/](https://console.aws.amazon.com/rds/)\. - -1. In the navigation pane, choose **Option groups**\. - -1. Choose the option group that you just created, which is **oracle\-oledb\-se\-2019** in this example\. - -1. Choose **Add option**\. - -1. Under **Option details**, choose **OLEDB\_ORACLE** for **Option name**\. - -1. Under **Scheduling**, choose whether to add the option immediately or at the next maintenance window\. - -1. Choose **Add option**\. - -#### CLI - -**To add the OLEDB\_ORACLE option** -+ Add the `OLEDB_ORACLE` option to the option group\. -**Example** - - For Linux, macOS, or Unix: - - ``` - aws rds add-option-to-option-group \ - --option-group-name oracle-oledb-se-2019 \ - --options OptionName=OLEDB_ORACLE \ - --apply-immediately - ``` - - For Windows: - - ``` - aws rds add-option-to-option-group ^ - --option-group-name oracle-oledb-se-2019 ^ - --options OptionName=OLEDB_ORACLE ^ - --apply-immediately - ``` - -### Associating the option group with your DB instance - -To associate the `OLEDB_ORACLE` option group and parameter group with your DB instance, use the AWS Management Console or the AWS CLI - -#### Console - -To finish activating linked servers for Oracle, associate your `OLEDB_ORACLE` option group with a new or existing DB instance: -+ For a new DB instance, associate them when you launch the instance\. For more information, see [Creating an Amazon RDS DB instance](USER_CreateDBInstance.md)\. -+ For an existing DB instance, associate them by modifying the instance\. For more information, see [Modifying an Amazon RDS DB instance](Overview.DBInstance.Modifying.md)\. - -#### CLI - -You can associate the `OLEDB_ORACLE` option group and parameter group with a new or existing DB instance\. - -**To create an instance with the `OLEDB_ORACLE` option group and parameter group** -+ Specify the same DB engine type and major version that you used when creating the option group\. -**Example** - - For Linux, macOS, or Unix: - - ``` - aws rds create-db-instance \ - --db-instance-identifier mytestsqlserveroracleoledbinstance \ - --db-instance-class db.m5.2xlarge \ - --engine sqlserver-se \ - --engine-version 15.0.4236.7.v1 \ - --allocated-storage 100 \ - --master-user-password secret123 \ - --master-username admin \ - --storage-type gp2 \ - --license-model li \ - --domain-iam-role-name my-directory-iam-role \ - --domain my-domain-id \ - --option-group-name oracle-oledb-se-2019 \ - --db-parameter-group-name my-parameter-group-name - ``` - - For Windows: - - ``` - aws rds create-db-instance ^ - --db-instance-identifier mytestsqlserveroracleoledbinstance ^ - --db-instance-class db.m5.2xlarge ^ - --engine sqlserver-se ^ - --engine-version 15.0.4236.7.v1 ^ - --allocated-storage 100 ^ - --master-user-password secret123 ^ - --master-username admin ^ - --storage-type gp2 ^ - --license-model li ^ - --domain-iam-role-name my-directory-iam-role ^ - --domain my-domain-id ^ - --option-group-name oracle-oledb-se-2019 ^ - --db-parameter-group-name my-parameter-group-name - ``` - -**To modify an instance and associate the `OLEDB_ORACLE` option group** -+ Run one of the following commands\. -**Example** - - For Linux, macOS, or Unix: - - ``` - aws rds modify-db-instance \ - --db-instance-identifier mytestsqlserveroracleoledbinstance \ - --option-group-name oracle-oledb-se-2019 \ - --db-parameter-group-name my-parameter-group-name \ - --apply-immediately - ``` - - For Windows: - - ``` - aws rds modify-db-instance ^ - --db-instance-identifier mytestsqlserveroracleoledbinstance ^ - --option-group-name oracle-oledb-se-2019 ^ - --db-parameter-group-name my-parameter-group-name ^ - --apply-immediately - ``` - -## Modifying OLEDB provider properties - -You can view and change the properties of the OLEDB provider\. Only the `master` user can perform this task\. All linked servers for Oracle that are created on the DB instance use the same properties of that OLEDB provider\. Call the `sp_MSset_oledb_prop` stored procedure to change the properties of the OLEDB provider\. - -To change the OLEDB provider properties - -``` - -USE [master] -GO -EXEC sp_MSset_oledb_prop N'OraOLEDB.Oracle', N'AllowInProcess', 1 -EXEC sp_MSset_oledb_prop N'OraOLEDB.Oracle', N'DynamicParameters', 0 -GO -``` - -The following properties can be modified: - - -**** - -| Property name | Recommended Value \(1 = On, 0 = Off\) | Description | -| --- | --- | --- | -| `Dynamic parameter` | 1 | Allows SQL placeholders \(represented by '?'\) in parameterized queries\. | -| `Nested queries` | 1 | Allows nested `SELECT` statements in the `FROM` clause, such as sub\-queries\. | -| `Level zero only` | 0 | Only base\-level OLEDB interfaces are called against the provider\. | -| `Allow inprocess` | 1 | If turned on, Microsoft SQL Server allows the provider to be instantiated as an in\-process server\. Set this property to 1 to use Oracle linked servers\. | -| `Non transacted updates` | 0 | If non\-zero, SQL Server allows updates\. | -| `Index as access path` | False | If non\-zero, SQL Server attempts to use indexes of the provider to fetch data\. | -| `Disallow adhoc access` | False | If set, SQL Server does not allow running pass\-through queries against the OLEDB provider\. While this option can be checked, it is sometimes appropriate to run pass\-through queries\. | -| `Supports LIKE operator` | 1 | Indicates that the provider supports queries using the LIKE keyword\. | - -## Modifying OLEDB driver properties - -You can view and change the properties of the OLEDB driver when creating a linked server for Oracle\. Only the `master` user can perform this task\. Driver properties define how the OLEDB driver handles data when working with a remote Oracle data source\. Driver properties are specific to each Oracle linked server created on the DB instance\. Call the `master.dbo.sp_addlinkedserver` stored procedure to change the properties of the OLEDB driver\. - -Example: To create a linked server and change the OLEDB driver `FetchSize` property - -``` - -EXEC master.dbo.sp_addlinkedserver -@server = N'Oracle_link2', -@srvproduct=N'Oracle', -@provider=N'OraOLEDB.Oracle', -@datasrc=N'my-oracle-test.cnetsipka.us-west-2.rds.amazonaws.com:1521/ORCL, -@provstr='FetchSize=200' -GO -``` - -``` - -EXEC master.dbo.sp_addlinkedsrvlogin -@rmtsrvname=N'Oracle_link2', -@useself=N'False', -@locallogin=NULL, -@rmtuser=N'master', -@rmtpassword='Test#1234' -GO -``` - -## Deactivating linked servers with Oracle - -To deactivate linked servers with Oracle, remove the `OLEDB_ORACLE` option from its option group\. - -**Important** -Removing the option doesn't delete the existing linked server configurations on the DB instance\. You must manually drop them to remove them from the DB instance\. -You can reactivate the `OLEDB_ORACLE` option after removal to reuse the linked server configurations that were previously configured on the DB instance\. - -### Console - -The following procedure removes the `OLEDB_ORACLE` option\. - -**To remove the OLEDB\_ORACLE option from its option group** - -1. Sign in to the AWS Management Console and open the Amazon RDS console at [https://console\.aws\.amazon\.com/rds/](https://console.aws.amazon.com/rds/)\. - -1. In the navigation pane, choose **Option groups**\. - -1. Choose the option group with the `OLEDB_ORACLE` option \(`oracle-oledb-se-2019` in the previous examples\)\. - -1. Choose **Delete option**\. - -1. Under **Deletion options**, choose **OLEDB\_ORACLE** for **Options to delete**\. - -1. Under **Apply immediately**, choose **Yes** to delete the option immediately, or **No** to delete it during the next maintenance window\. - -1. Choose **Delete**\. - -### CLI - -The following procedure removes the `OLEDB_ORACLE` option\. - -**To remove the OLEDB\_ORACLE option from its option group** -+ Run one of the following commands\. -**Example** - - For Linux, macOS, or Unix: - - ``` - aws rds remove-option-from-option-group \ - --option-group-name oracle-oledb-se-2019 \ - --options OLEDB_ORACLE \ - --apply-immediately - ``` - - For Windows: - - ``` - aws rds remove-option-from-option-group ^ - --option-group-name oracle-oledb-se-2019 ^ - --options OLEDB_ORACLE ^ - --apply-immediately - ``` \ No newline at end of file diff --git a/doc_source/Appendix.SQLServer.Options.MSDTC.md b/doc_source/Appendix.SQLServer.Options.MSDTC.md deleted file mode 100644 index 454e2c3..0000000 --- a/doc_source/Appendix.SQLServer.Options.MSDTC.md +++ /dev/null @@ -1,596 +0,0 @@ -# Support for Microsoft Distributed Transaction Coordinator in RDS for SQL Server - -A *distributed transaction* is a database transaction in which two or more network hosts are involved\. RDS for SQL Server supports distributed transactions among hosts, where a single host can be one of the following: -+ RDS for SQL Server DB instance -+ On\-premises SQL Server host -+ Amazon EC2 host with SQL Server installed -+ Any other EC2 host or RDS DB instance with a database engine that supports distributed transactions - -In RDS, starting with SQL Server 2012 \(version 11\.00\.5058\.0\.v1 and later\), all editions of RDS for SQL Server support distributed transactions\. The support is provided using Microsoft Distributed Transaction Coordinator \(MSDTC\)\. For in\-depth information about MSDTC, see [Distributed Transaction Coordinator](https://docs.microsoft.com/en-us/previous-versions/windows/desktop/ms684146(v=vs.85)) in the Microsoft documentation\. - -**Contents** -+ [Limitations](#Appendix.SQLServer.Options.MSDTC.Limitations) -+ [Enabling MSDTC](#Appendix.SQLServer.Options.MSDTC.Enabling) - + [Creating the option group for MSDTC](#Appendix.SQLServer.Options.MSDTC.OptionGroup) - + [Adding the MSDTC option to the option group](#Appendix.SQLServer.Options.MSDTC.Add) - + [Creating the parameter group for MSDTC](#MSDTC.CreateParamGroup) - + [Modifying the parameter for MSDTC](#ModifyParam.MSDTC) - + [Associating the option group and parameter group with the DB instance](#MSDTC.Apply) -+ [Using distributed transactions](#Appendix.SQLServer.Options.MSDTC.Using) -+ [Using XA transactions](#MSDTC.XA) -+ [Using transaction tracing](#MSDTC.Tracing) -+ [Modifying the MSDTC option](#Appendix.SQLServer.Options.MSDTC.Modify) -+ [Disabling MSDTC](#Appendix.SQLServer.Options.MSDTC.Disable) -+ [Troubleshooting MSDTC for RDS for SQL Server](#Appendix.SQLServer.Options.MSDTC.Troubleshooting) - -## Limitations - -The following limitations apply to using MSDTC on RDS for SQL Server: -+ MSDTC isn't supported on instances using SQL Server Database Mirroring\. For more information, see [Transactions \- availability groups and database mirroring](https://docs.microsoft.com/en-us/sql/database-engine/availability-groups/windows/transactions-always-on-availability-and-database-mirroring?view=sql-server-ver15#non-support-for-distributed-transactions)\. -+ The `in-doubt xact resolution` parameter must be set to 1 or 2\. For more information, see [Modifying the parameter for MSDTC](#ModifyParam.MSDTC)\. -+ MSDTC requires all hosts participating in distributed transactions to be resolvable using their host names\. RDS automatically maintains this functionality for domain\-joined instances\. However, for standalone instances make sure to configure the DNS server manually\. -+ Java Database Connectivity \(JDBC\) XA transactions are supported for SQL Server 2017 version 14\.00\.3223\.3 and higher, and SQL Server 2019\. -+ Distributed transactions that depend on client dynamic link libraries \(DLLs\) on RDS instances aren't supported\. -+ Using custom XA dynamic link libraries isn't supported\. - -## Enabling MSDTC - -Use the following process to enable MSDTC for your DB instance: - -1. Create a new option group, or choose an existing option group\. - -1. Add the `MSDTC` option to the option group\. - -1. Create a new parameter group, or choose an existing parameter group\. - -1. Modify the parameter group to set the `in-doubt xact resolution` parameter to 1 or 2\. - -1. Associate the option group and parameter group with the DB instance\. - -### Creating the option group for MSDTC - -Use the AWS Management Console or the AWS CLI to create an option group that corresponds to the SQL Server engine and version of your DB instance\. - -**Note** -You can also use an existing option group if it's for the correct SQL Server engine and version\. - -#### Console - -The following procedure creates an option group for SQL Server Standard Edition 2016\. - -**To create the option group** - -1. Sign in to the AWS Management Console and open the Amazon RDS console at [https://console\.aws\.amazon\.com/rds/](https://console.aws.amazon.com/rds/)\. - -1. In the navigation pane, choose **Option groups**\. - -1. Choose **Create group**\. - -1. In the **Create option group** pane, do the following: - - 1. For **Name**, enter a name for the option group that is unique within your AWS account, such as **msdtc\-se\-2016**\. The name can contain only letters, digits, and hyphens\. - - 1. For **Description**, enter a brief description of the option group, such as **MSDTC option group for SQL Server SE 2016**\. The description is used for display purposes\. - - 1. For **Engine**, choose **sqlserver\-se**\. - - 1. For **Major engine version**, choose **13\.00**\. - -1. Choose **Create**\. - -#### CLI - -The following example creates an option group for SQL Server Standard Edition 2016\. - -**To create the option group** -+ Use one of the following commands\. -**Example** - - For Linux, macOS, or Unix: - - ``` - aws rds create-option-group \ - --option-group-name msdtc-se-2016 \ - --engine-name sqlserver-se \ - --major-engine-version 13.00 \ - --option-group-description "MSDTC option group for SQL Server SE 2016" - ``` - - For Windows: - - ``` - aws rds create-option-group ^ - --option-group-name msdtc-se-2016 ^ - --engine-name sqlserver-se ^ - --major-engine-version 13.00 ^ - --option-group-description "MSDTC option group for SQL Server SE 2016" - ``` - -### Adding the MSDTC option to the option group - -Next, use the AWS Management Console or the AWS CLI to add the `MSDTC` option to the option group\. - -The following option settings are required: -+ **Port** – The port that you use to access MSDTC\. Allowed values are 1150–49151 except for 1234, 1434, 3260, 3343, 3389, and 47001\. The default value is 5000\. - - Make sure that the port you want to use is enabled in your firewall rules\. Also, make sure as needed that this port is enabled in the inbound and outbound rules for the security group associated with your DB instance\. For more information, see [Can't connect to Amazon RDS DB instance](CHAP_Troubleshooting.md#CHAP_Troubleshooting.Connecting)\. -+ **Security groups** – The VPC security group memberships for your RDS DB instance\. -+ **Authentication type** – The authentication mode between hosts\. The following authentication types are supported: - + Mutual – The RDS instances are mutually authenticated to each other using integrated authentication\. If this option is selected, all instances associated with this option group must be domain\-joined\. - + None – No authentication is performed between hosts\. We don't recommend using this mode in production environments\. -+ **Transaction log size** – The size of the MSDTC transaction log\. Allowed values are 4–1024 MB\. The default size is 4 MB\. - -The following option settings are optional: -+ **Enable inbound connections** – Whether to allow inbound MSDTC connections to instances associated with this option group\. -+ **Enable outbound connections** – Whether to allow outbound MSDTC connections from instances associated with this option group\. -+ **Enable XA** – Whether to allow XA transactions\. For more information on the XA protocol, see [XA specification](https://publications.opengroup.org/c193)\. -+ **Enable SNA LU** – Whether to allow the SNA LU protocol to be used for distributed transactions\. For more information on SNA LU protocol support, see [Managing IBM CICS LU 6\.2 transactions](https://docs.microsoft.com/en-us/previous-versions/windows/desktop/ms685136(v=vs.85)) in the Microsoft documentation\. - -#### Console - -**To add the MSDTC option** - -1. Sign in to the AWS Management Console and open the Amazon RDS console at [https://console\.aws\.amazon\.com/rds/](https://console.aws.amazon.com/rds/)\. - -1. In the navigation pane, choose **Option groups**\. - -1. Choose the option group that you just created\. - -1. Choose **Add option**\. - -1. Under **Option details**, choose **MSDTC** for **Option name**\. - -1. Under **Option settings**: - - 1. For **Port**, enter the port number for accessing MSDTC\. The default is **5000**\. - - 1. For **Security groups**, choose the VPC security group to associate with the option\. - - 1. For **Authentication type**, choose **Mutual** or **None**\. - - 1. For **Transaction log size**, enter a value from 4–1024\. The default is **4**\. - -1. Under **Additional configuration**, do the following: - - 1. For **Connections**, as needed choose **Enable inbound connections** and **Enable outbound connections**\. - - 1. For **Allowed protocols**, as needed choose **Enable XA** and **Enable SNA LU**\. - -1. Under **Scheduling**, choose whether to add the option immediately or at the next maintenance window\. - -1. Choose **Add option**\. - - To add this option, no reboot is required\. - -#### CLI - -**To add the MSDTC option** - -1. Create a JSON file, for example `msdtc-option.json`, with the following required parameters\. - - ``` - { - "OptionGroupName":"msdtc-se-2016", - "OptionsToInclude": [ - { - "OptionName":"MSDTC", - "Port":5000, - "VpcSecurityGroupMemberships":["sg-0abcdef123"], - "OptionSettings":[{"Name":"AUTHENTICATION","Value":"MUTUAL"},{"Name":"TRANSACTION_LOG_SIZE","Value":"4"}] - }], - "ApplyImmediately": true - } - ``` - -1. Add the `MSDTC` option to the option group\. -**Example** - - For Linux, macOS, or Unix: - - ``` - aws rds add-option-to-option-group \ - --cli-input-json file://msdtc-option.json \ - --apply-immediately - ``` - - For Windows: - - ``` - aws rds add-option-to-option-group ^ - --cli-input-json file://msdtc-option.json ^ - --apply-immediately - ``` - - No reboot is required\. - -### Creating the parameter group for MSDTC - -Create or modify a parameter group for the `in-doubt xact resolution` parameter that corresponds to the SQL Server edition and version of your DB instance\. - -#### Console - -The following example creates a parameter group for SQL Server Standard Edition 2016\. - -**To create the parameter group** - -1. Sign in to the AWS Management Console and open the Amazon RDS console at [https://console\.aws\.amazon\.com/rds/](https://console.aws.amazon.com/rds/)\. - -1. In the navigation pane, choose **Parameter groups**\. - -1. Choose **Create parameter group**\. - -1. In the **Create parameter group** pane, do the following: - - 1. For **Parameter group family**, choose **sqlserver\-se\-13\.0**\. - - 1. For **Group name**, enter an identifier for the parameter group, such as **msdtc\-sqlserver\-se\-13**\. - - 1. For **Description**, enter **in\-doubt xact resolution**\. - -1. Choose **Create**\. - -#### CLI - -The following example creates a parameter group for SQL Server Standard Edition 2016\. - -**To create the parameter group** -+ Use one of the following commands\. -**Example** - - For Linux, macOS, or Unix: - - ``` - aws rds create-db-parameter-group \ - --db-parameter-group-name msdtc-sqlserver-se-13 \ - --db-parameter-group-family "sqlserver-se-13.0" \ - --description "in-doubt xact resolution" - ``` - - For Windows: - - ``` - aws rds create-db-parameter-group ^ - --db-parameter-group-name msdtc-sqlserver-se-13 ^ - --db-parameter-group-family "sqlserver-se-13.0" ^ - --description "in-doubt xact resolution" - ``` - -### Modifying the parameter for MSDTC - -Modify the `in-doubt xact resolution` parameter in the parameter group that corresponds to the SQL Server edition and version of your DB instance\. - -For MSDTC, set the `in-doubt xact resolution` parameter to one of the following: -+ `1` – `Presume commit`\. Any MSDTC in\-doubt transactions are presumed to have committed\. -+ `2` – `Presume abort`\. Any MSDTC in\-doubt transactions are presumed to have stopped\. - -For more information, see [in\-doubt xact resolution server configuration option](https://docs.microsoft.com/en-us/sql/database-engine/configure-windows/in-doubt-xact-resolution-server-configuration-option) in the Microsoft documentation\. - -#### Console - -The following example modifies the parameter group that you created for SQL Server Standard Edition 2016\. - -**To modify the parameter group** - -1. Sign in to the AWS Management Console and open the Amazon RDS console at [https://console\.aws\.amazon\.com/rds/](https://console.aws.amazon.com/rds/)\. - -1. In the navigation pane, choose **Parameter groups**\. - -1. Choose the parameter group, such as **msdtc\-sqlserver\-se\-13**\. - -1. Under **Parameters**, filter the parameter list for **xact**\. - -1. Choose **in\-doubt xact resolution**\. - -1. Choose **Edit parameters**\. - -1. Enter **1** or **2**\. - -1. Choose **Save changes**\. - -#### CLI - -The following example modifies the parameter group that you created for SQL Server Standard Edition 2016\. - -**To modify the parameter group** -+ Use one of the following commands\. -**Example** - - For Linux, macOS, or Unix: - - ``` - aws rds modify-db-parameter-group \ - --db-parameter-group-name msdtc-sqlserver-se-13 \ - --parameters "ParameterName='in-doubt xact resolution',ParameterValue=1,ApplyMethod=immediate" - ``` - - For Windows: - - ``` - aws rds modify-db-parameter-group ^ - --db-parameter-group-name msdtc-sqlserver-se-13 ^ - --parameters "ParameterName='in-doubt xact resolution',ParameterValue=1,ApplyMethod=immediate" - ``` - -### Associating the option group and parameter group with the DB instance - -You can use the AWS Management Console or the AWS CLI to associate the MSDTC option group and parameter group with the DB instance\. - -#### Console - -You can associate the MSDTC option group and parameter group with a new or existing DB instance\. -+ For a new DB instance, associate them when you launch the instance\. For more information, see [Creating an Amazon RDS DB instance](USER_CreateDBInstance.md)\. -+ For an existing DB instance, associate them by modifying the instance\. For more information, see [Modifying an Amazon RDS DB instance](Overview.DBInstance.Modifying.md)\. -**Note** -If you use an domain\-joined existing DB instance, it must already have an Active Directory domain and AWS Identity and Access Management \(IAM\) role associated with it\. If you create a new domain\-joined instance, specify an existing Active Directory domain and IAM role\. For more information, see [Using Windows Authentication with an Amazon RDS for SQL Server DB instance](USER_SQLServerWinAuth.md)\. - -#### CLI - -You can associate the MSDTC option group and parameter group with a new or existing DB instance\. - -**Note** -If you use an existing domain\-joined DB instance, it must already have an Active Directory domain and IAM role associated with it\. If you create a new domain\-joined instance, specify an existing Active Directory domain and IAM role\. For more information, see [Using Windows Authentication with an Amazon RDS for SQL Server DB instance](USER_SQLServerWinAuth.md)\. - -**To create a DB instance with the MSDTC option group and parameter group** -+ Specify the same DB engine type and major version as you used when creating the option group\. -**Example** - - For Linux, macOS, or Unix: - - ``` - aws rds create-db-instance \ - --db-instance-identifier mydbinstance \ - --db-instance-class db.m5.2xlarge \ - --engine sqlserver-se \ - --engine-version 13.00.5426.0.v1 \ - --allocated-storage 100 \ - --master-user-password secret123 \ - --master-username admin \ - --storage-type gp2 \ - --license-model li \ - --domain-iam-role-name my-directory-iam-role \ - --domain my-domain-id \ - --option-group-name msdtc-se-2016 \ - --db-parameter-group-name msdtc-sqlserver-se-13 - ``` - - For Windows: - - ``` - aws rds create-db-instance ^ - --db-instance-identifier mydbinstance ^ - --db-instance-class db.m5.2xlarge ^ - --engine sqlserver-se ^ - --engine-version 13.00.5426.0.v1 ^ - --allocated-storage 100 ^ - --master-user-password secret123 ^ - --master-username admin ^ - --storage-type gp2 ^ - --license-model li ^ - --domain-iam-role-name my-directory-iam-role ^ - --domain my-domain-id ^ - --option-group-name msdtc-se-2016 ^ - --db-parameter-group-name msdtc-sqlserver-se-13 - ``` - -**To modify a DB instance and associate the MSDTC option group and parameter group** -+ Use one of the following commands\. -**Example** - - For Linux, macOS, or Unix: - - ``` - aws rds modify-db-instance \ - --db-instance-identifier mydbinstance \ - --option-group-name msdtc-se-2016 \ - --db-parameter-group-name msdtc-sqlserver-se-13 \ - --apply-immediately - ``` - - For Windows: - - ``` - aws rds modify-db-instance ^ - --db-instance-identifier mydbinstance ^ - --option-group-name msdtc-se-2016 ^ - --db-parameter-group-name msdtc-sqlserver-se-13 ^ - --apply-immediately - ``` - -## Using distributed transactions - -In Amazon RDS for SQL Server, you run distributed transactions in the same way as distributed transactions running on\-premises: -+ Using \.NET framework `System.Transactions` promotable transactions, which optimizes distributed transactions by deferring their creation until they're needed\. - - In this case, promotion is automatic and doesn't require you to make any intervention\. If there's only one resource manager within the transaction, no promotion is performed\. For more information about implicit transaction scopes, see [Implementing an implicit transaction using transaction scope](https://docs.microsoft.com/en-us/dotnet/framework/data/transactions/implementing-an-implicit-transaction-using-transaction-scope) in the Microsoft documentation\. - - Promotable transactions are supported with these \.NET implementations: - + Starting with ADO\.NET 2\.0, `System.Data.SqlClient` supports promotable transactions with SQL Server\. For more information, see [System\.Transactions integration with SQL Server](https://docs.microsoft.com/en-us/dotnet/framework/data/adonet/system-transactions-integration-with-sql-server) in the Microsoft documentation\. - + ODP\.NET supports `System.Transactions`\. A local transaction is created for the first connection opened in the `TransactionsScope` scope to Oracle Database 11g release 1 \(version 11\.1\) and later\. When a second connection is opened, this transaction is automatically promoted to a distributed transaction\. For more information about distributed transaction support in ODP\.NET, see [Microsoft Distributed Transaction Coordinator integration](https://docs.oracle.com/en/database/oracle/oracle-data-access-components/18.3/ntmts/using-mts-with-oracledb.html) in the Microsoft documentation\. -+ Using the `BEGIN DISTRIBUTED TRANSACTION` statement\. For more information, see [BEGIN DISTRIBUTED TRANSACTION \(Transact\-SQL\)](https://docs.microsoft.com/en-us/sql/t-sql/language-elements/begin-distributed-transaction-transact-sql) in the Microsoft documentation\. - -## Using XA transactions - -Starting from RDS for SQL Server 2017 version14\.00\.3223\.3, you can control distributed transactions using JDBC\. When you set the `Enable XA` option setting to `true` in the `MSDTC` option, RDS automatically enables JDBC transactions and grants the `SqlJDBCXAUser` role to the `guest` user\. This allows executing distributed transactions through JDBC\. For more information, including a code example, see [Understanding XA transactions](https://docs.microsoft.com/en-us/sql/connect/jdbc/understanding-xa-transactions) in the Microsoft documentation\. - -## Using transaction tracing - -RDS supports controlling MSDTC transaction traces and downloading them from the RDS DB instance for troubleshooting\. You can control transaction tracing sessions by running the following RDS stored procedure\. - -``` -exec msdb.dbo.rds_msdtc_transaction_tracing 'trace_action', -[@traceall='0|1'], -[@traceaborted='0|1'], -[@tracelong='0|1']; -``` - -The following parameter is required: -+ `trace_action` – The tracing action\. It can be `START`, `STOP`, or `STATUS`\. - -The following parameters are optional: -+ `@traceall` – Set to 1 to trace all distributed transactions\. The default is 0\. -+ `@traceaborted` – Set to 1 to trace canceled distributed transactions\. The default is 0\. -+ `@tracelong` – Set to 1 to trace long\-running distributed transactions\. The default is 0\. - -**Example of START tracing action** -To start a new transaction tracing session, run the following example statement\. - -``` -exec msdb.dbo.rds_msdtc_transaction_tracing 'START', -@traceall='0', -@traceaborted='1', -@tracelong='1'; -``` -Only one transaction tracing session can be active at one time\. If a new tracing session `START` command is issued while a tracing session is active, an error is returned and the active tracing session remains unchanged\. - -**Example of STOP tracing action** -To stop a transaction tracing session, run the following statement\. - -``` -exec msdb.dbo.rds_msdtc_transaction_tracing 'STOP' -``` -This statement stops the active transaction tracing session and saves the transaction trace data into the log directory on the RDS DB instance\. The first row of the output contains the overall result, and the following lines indicate details of the operation\. -The following is an example of a successful tracing session stop\. - -``` -OK: Trace session has been successfully stopped. -Setting log file to: D:\rdsdbdata\MSDTC\Trace\dtctrace.log -Examining D:\rdsdbdata\MSDTC\Trace\msdtctr.mof for message formats, 8 found. -Searching for TMF files on path: (null) -Logfile D:\rdsdbdata\MSDTC\Trace\dtctrace.log: - OS version 10.0.14393 (Currently running on 6.2.9200) - Start Time - End Time - Timezone is @tzres.dll,-932 (Bias is 0mins) - BufferSize 16384 B - Maximum File Size 10 MB - Buffers Written Not set (Logger may not have been stopped). - Logger Mode Settings (11000002) ( circular paged - ProcessorCount 1 -Processing completed Buffers: 1, Events: 3, EventsLost: 0 :: Format Errors: 0, Unknowns: 3 -Event traces dumped to d:\rdsdbdata\Log\msdtc_.log -``` -You can use the detailed information to query the name of the generated log file\. For more information about downloading log files from the RDS DB instance, see [Monitoring Amazon RDS log files](USER_LogAccess.md)\. -The trace session logs remain on the instance for 35 days\. Any older trace session logs are automatically deleted\. - -**Example of STATUS tracing action** -To trace the status of a transaction tracing session, run the following statement\. - -``` -exec msdb.dbo.rds_msdtc_transaction_tracing 'STATUS' -``` -This statement outputs the following as separate rows of the result set\. - -``` -OK -SessionStatus: -TraceAll: -TraceAborted: -TraceLongLived: -``` -The first line indicates the overall result of the operation: `OK` or `ERROR` with details, if applicable\. The subsequent lines indicate details about the tracing session status: -+ `SessionStatus` can be one of the following: - + `Started` if a tracing session is running\. - + `Stopped` if no tracing session is running\. -+ The tracing session flags can be `True` or `False` depending on how they were set in the `START` command\. - -## Modifying the MSDTC option - -After you enable the `MSDTC` option, you can modify its settings\. For information about how to modify option settings, see [Modifying an option setting](USER_WorkingWithOptionGroups.md#USER_WorkingWithOptionGroups.ModifyOption)\. - -**Note** -Some changes to MSDTC option settings require the MSDTC service to be restarted\. This requirement can affect running distributed transactions\. - -## Disabling MSDTC - -To disable MSDTC, remove the `MSDTC` option from its option group\. - -### Console - -**To remove the MSDTC option from its option group** - -1. Sign in to the AWS Management Console and open the Amazon RDS console at [https://console\.aws\.amazon\.com/rds/](https://console.aws.amazon.com/rds/)\. - -1. In the navigation pane, choose **Option groups**\. - -1. Choose the option group with the `MSDTC` option \(`msdtc-se-2016` in the previous examples\)\. - -1. Choose **Delete option**\. - -1. Under **Deletion options**, choose **MSDTC** for **Options to delete**\. - -1. Under **Apply immediately**, choose **Yes** to delete the option immediately, or **No** to delete it at the next maintenance window\. - -1. Choose **Delete**\. - -### CLI - -**To remove the MSDTC option from its option group** -+ Use one of the following commands\. -**Example** - - For Linux, macOS, or Unix: - - ``` - aws rds remove-option-from-option-group \ - --option-group-name msdtc-se-2016 \ - --options MSDTC \ - --apply-immediately - ``` - - For Windows: - - ``` - aws rds remove-option-from-option-group ^ - --option-group-name msdtc-se-2016 ^ - --options MSDTC ^ - --apply-immediately - ``` - -## Troubleshooting MSDTC for RDS for SQL Server - -In some cases, you might have trouble establishing a connection between MSDTC running on a client computer and the MSDTC service running on an RDS for SQL Server DB instance\. If so, make sure of the following: -+ The inbound rules for the security group associated with the DB instance are configured correctly\. For more information, see [Can't connect to Amazon RDS DB instance](CHAP_Troubleshooting.md#CHAP_Troubleshooting.Connecting)\. -+ Your client computer is configured correctly\. -+ The MSDTC firewall rules on your client computer are enabled\. - -**To configure the client computer** - -1. Open **Component Services**\. - - Or, in **Server Manager**, choose **Tools**, and then choose **Component Services**\. - -1. Expand **Component Services**, expand **Computers**, expand **My Computer**, and then expand **Distributed Transaction Coordinator**\. - -1. Open the context \(right\-click\) menu for **Local DTC** and choose **Properties**\. - -1. Choose the **Security** tab\. - -1. Choose all of the following: - + **Network DTC Access** - + **Allow Inbound** - + **Allow Outbound** - -1. Make sure that the correct authentication mode is chosen: - + **Mutual Authentication Required** – The client machine is joined to the same domain as other nodes participating in distributed transaction, or there is a trust relationship configured between domains\. - + **No Authentication Required** – All other cases\. - -1. Choose **OK** to save your changes\. - -1. If prompted to restart the service, choose **Yes**\. - -**To enable MSDTC firewall rules** - -1. Open Windows Firewall, then choose **Advanced settings**\. - - Or, in **Server Manager**, choose **Tools**, and then choose **Windows Firewall with Advanced Security**\. -**Note** -Depending on your operating system, Windows Firewall might be called Windows Defender Firewall\. - -1. Choose **Inbound Rules** in the left pane\. - -1. Enable the following firewall rules, if they are not already enabled: - + **Distributed Transaction Coordinator \(RPC\)** - + **Distributed Transaction Coordinator \(RPC\)\-EPMAP** - + **Distributed Transaction Coordinator \(TCP\-In\)** - -1. Close Windows Firewall\. \ No newline at end of file diff --git a/doc_source/Appendix.SQLServer.Options.SSAS.md b/doc_source/Appendix.SQLServer.Options.SSAS.md deleted file mode 100644 index 10c3aaf..0000000 --- a/doc_source/Appendix.SQLServer.Options.SSAS.md +++ /dev/null @@ -1,840 +0,0 @@ -# Support for SQL Server Analysis Services in Amazon RDS for SQL Server - -Microsoft SQL Server Analysis Services \(SSAS\) is part of the Microsoft Business Intelligence \(MSBI\) suite\. SSAS is an online analytical processing \(OLAP\) and data mining tool that is installed within SQL Server\. You use SSAS to analyze data to help make business decisions\. SSAS differs from the SQL Server relational database because SSAS is optimized for queries and calculations common in a business intelligence environment\. - - You can turn on SSAS for existing or new DB instances\. It's installed on the same DB instance as your database engine\. For more information on SSAS, see the Microsoft [Analysis services documentation](https://docs.microsoft.com/en-us/analysis-services)\. - -Amazon RDS supports SSAS for SQL Server Standard and Enterprise Editions on the following versions: -+ Tabular mode: - + SQL Server 2019, version 15\.00\.4043\.16\.v1 and higher - + SQL Server 2017, version 14\.00\.3223\.3\.v1 and higher - + SQL Server 2016, version 13\.00\.5426\.0\.v1 and higher -+ Multidimensional mode: - + SQL Server 2017, version 14\.00\.3381\.3\.v1 and higher - + SQL Server 2016, version 13\.00\.5882\.1\.v1 and higher - -**Contents** -+ [Limitations](#SSAS.Limitations) -+ [Turning on SSAS](#SSAS.Enabling) - + [Creating an option group for SSAS](#SSAS.OptionGroup) - + [Adding the SSAS option to the option group](#SSAS.Add) - + [Associating the option group with your DB instance](#SSAS.Apply) - + [Allowing inbound access to your VPC security group](#SSAS.InboundRule) - + [Enabling Amazon S3 integration](#SSAS.EnableS3) -+ [Deploying SSAS projects on Amazon RDS](#SSAS.Deploy) -+ [Monitoring the status of a deployment task](#SSAS.Monitor) -+ [Using SSAS on Amazon RDS](#SSAS.Use) - + [Setting up a Windows\-authenticated user for SSAS](#SSAS.Use.Auth) - + [Adding a domain user as a database administrator](#SSAS.Admin) - + [Creating an SSAS proxy](#SSAS.Use.Proxy) - + [Scheduling SSAS database processing using SQL Server Agent](#SSAS.Use.Schedule) - + [Revoking SSAS access from the proxy](#SSAS.Use.Revoke) -+ [Backing up an SSAS database](#SSAS.Backup) -+ [Restoring an SSAS database](#SSAS.Restore) - + [Restoring a DB instance to a specified time](#SSAS.PITR) -+ [Changing the SSAS mode](#SSAS.ChangeMode) -+ [Turning off SSAS](#SSAS.Disable) -+ [Troubleshooting SSAS issues](#SSAS.Trouble) - -## Limitations - -The following limitations apply to using SSAS on RDS for SQL Server: -+ RDS for SQL Server supports running SSAS in Tabular or Multidimensional mode\. For more information, see [Comparing tabular and multidimensional solutions](https://docs.microsoft.com/en-us/analysis-services/comparing-tabular-and-multidimensional-solutions-ssas) in the Microsoft documentation\. -+ You can only use one SSAS mode at a time\. Before changing modes, make sure to delete all of the SSAS databases\. - - For more information, see [Changing the SSAS mode](#SSAS.ChangeMode)\. -+ Multidimensional mode isn't supported on SQL Server 2019\. -+ Multi\-AZ instances aren't supported\. -+ Instances must use AWS Directory Service for Microsoft Active Directory for SSAS authentication\. -+ Users aren't given SSAS server administrator access, but they can be granted database\-level administrator access\. -+ The only supported port for accessing SSAS is 2383\. -+ You can't deploy projects directly\. We provide an RDS stored procedure to do this\. For more information, see [Deploying SSAS projects on Amazon RDS](#SSAS.Deploy)\. -+ Processing during deployment isn't supported\. -+ Using \.xmla files for deployment isn't supported\. -+ SSAS project input files and database backup output files can only be in the `D:\S3` folder on the DB instance\. - -## Turning on SSAS - -Use the following process to turn on SSAS for your DB instance: - -1. Create a new option group, or choose an existing option group\. - -1. Add the `SSAS` option to the option group\. - -1. Associate the option group with the DB instance\. - -1. Allow inbound access to the virtual private cloud \(VPC\) security group for the SSAS listener port\. - -1. Turn on Amazon S3 integration\. - -### Creating an option group for SSAS - -Use the AWS Management Console or the AWS CLI to create an option group that corresponds to the SQL Server engine and version of the DB instance that you plan to use\. - -**Note** -You can also use an existing option group if it's for the correct SQL Server engine and version\. - -#### Console - -The following console procedure creates an option group for SQL Server Standard Edition 2017\. - -**To create the option group** - -1. Sign in to the AWS Management Console and open the Amazon RDS console at [https://console\.aws\.amazon\.com/rds/](https://console.aws.amazon.com/rds/)\. - -1. In the navigation pane, choose **Option groups**\. - -1. Choose **Create group**\. - -1. In the **Create option group** pane, do the following: - - 1. For **Name**, enter a name for the option group that is unique within your AWS account, such as **ssas\-se\-2017**\. The name can contain only letters, digits, and hyphens\. - - 1. For **Description**, enter a brief description of the option group, such as **SSAS option group for SQL Server SE 2017**\. The description is used for display purposes\. - - 1. For **Engine**, choose **sqlserver\-se**\. - - 1. For **Major engine version**, choose **14\.00**\. - -1. Choose **Create**\. - -#### CLI - -The following CLI example creates an option group for SQL Server Standard Edition 2017\. - -**To create the option group** -+ Use one of the following commands\. -**Example** - - For Linux, macOS, or Unix: - - ``` - aws rds create-option-group \ - --option-group-name ssas-se-2017 \ - --engine-name sqlserver-se \ - --major-engine-version 14.00 \ - --option-group-description "SSAS option group for SQL Server SE 2017" - ``` - - For Windows: - - ``` - aws rds create-option-group ^ - --option-group-name ssas-se-2017 ^ - --engine-name sqlserver-se ^ - --major-engine-version 14.00 ^ - --option-group-description "SSAS option group for SQL Server SE 2017" - ``` - -### Adding the SSAS option to the option group - -Next, use the AWS Management Console or the AWS CLI to add the `SSAS` option to the option group\. - -#### Console - -**To add the SSAS option** - -1. Sign in to the AWS Management Console and open the Amazon RDS console at [https://console\.aws\.amazon\.com/rds/](https://console.aws.amazon.com/rds/)\. - -1. In the navigation pane, choose **Option groups**\. - -1. Choose the option group that you just created\. - -1. Choose **Add option**\. - -1. Under **Option details**, choose **SSAS** for **Option name**\. - -1. Under **Option settings**, do the following: - - 1. For **Max memory**, enter a value in the range 10–80\. - - **Max memory** specifies the upper threshold above which SSAS begins releasing memory more aggressively to make room for requests that are running, and also new high\-priority requests\. The number is a percentage of the total memory of the DB instance\. The allowed values are 10–80, and the default is 45\. - - 1. For **Mode**, choose the SSAS server mode, **Tabular** or **Multidimensional**\. - - If you don't see the **Mode** option setting, it means that Multidimensional mode isn't supported in your AWS Region\. For more information, see [Limitations](#SSAS.Limitations)\. - - **Tabular** is the default\. - - 1. For **Security groups**, choose the VPC security group to associate with the option\. -**Note** -The port for accessing SSAS, 2383, is prepopulated\. - -1. Under **Scheduling**, choose whether to add the option immediately or at the next maintenance window\. - -1. Choose **Add option**\. - -#### CLI - -**To add the SSAS option** - -1. Create a JSON file, for example `ssas-option.json`, with the following parameters: - + `OptionGroupName` – The name of option group that you created or chose previously \(`ssas-se-2017` in the following example\)\. - + `Port` – The port that you use to access SSAS\. The only supported port is 2383\. - + `VpcSecurityGroupMemberships` – Memberships for VPC security groups for your RDS DB instance\. - + `MAX_MEMORY` – The upper threshold above which SSAS should begin releasing memory more aggressively to make room for requests that are running, and also new high\-priority requests\. The number is a percentage of the total memory of the DB instance\. The allowed values are 10–80, and the default is 45\. - + `MODE` – The SSAS server mode, either `Tabular` or `Multidimensional`\. `Tabular` is the default\. - - If you receive an error that the `MODE` option setting isn't valid, it means that Multidimensional mode isn't supported in your AWS Region\. For more information, see [Limitations](#SSAS.Limitations)\. - - The following is an example of a JSON file with SSAS option settings\. - - ``` - { - "OptionGroupName": "ssas-se-2017", - "OptionsToInclude": [ - { - "OptionName": "SSAS", - "Port": 2383, - "VpcSecurityGroupMemberships": ["sg-0abcdef123"], - "OptionSettings": [{"Name":"MAX_MEMORY","Value":"60"},{"Name":"MODE","Value":"Multidimensional"}] - }], - "ApplyImmediately": true - } - ``` - -1. Add the `SSAS` option to the option group\. -**Example** - - For Linux, macOS, or Unix: - - ``` - aws rds add-option-to-option-group \ - --cli-input-json file://ssas-option.json \ - --apply-immediately - ``` - - For Windows: - - ``` - aws rds add-option-to-option-group ^ - --cli-input-json file://ssas-option.json ^ - --apply-immediately - ``` - -### Associating the option group with your DB instance - -You can use the console or the CLI to associate the option group with your DB instance\. - -#### Console - -Associate your option group with a new or existing DB instance: -+ For a new DB instance, associate the option group with the DB instance when you launch the instance\. For more information, see [Creating an Amazon RDS DB instance](USER_CreateDBInstance.md)\. -+ For an existing DB instance, modify the instance and associate the new option group with it\. For more information, see [Modifying an Amazon RDS DB instance](Overview.DBInstance.Modifying.md)\. -**Note** -If you use an existing instance, it must already have an Active Directory domain and AWS Identity and Access Management \(IAM\) role associated with it\. If you create a new instance, specify an existing Active Directory domain and IAM role\. For more information, see [Using Windows Authentication with an Amazon RDS for SQL Server DB instance](USER_SQLServerWinAuth.md)\. - -#### CLI - -You can associate your option group with a new or existing DB instance\. - -**Note** -If you use an existing instance, it must already have an Active Directory domain and IAM role associated with it\. If you create a new instance, specify an existing Active Directory domain and IAM role\. For more information, see [Using Windows Authentication with an Amazon RDS for SQL Server DB instance](USER_SQLServerWinAuth.md)\. - -**To create a DB instance that uses the option group** -+ Specify the same DB engine type and major version that you used when creating the option group\. -**Example** - - For Linux, macOS, or Unix: - - ``` - aws rds create-db-instance \ - --db-instance-identifier myssasinstance \ - --db-instance-class db.m5.2xlarge \ - --engine sqlserver-se \ - --engine-version 14.00.3223.3.v1 \ - --allocated-storage 100 \ - --master-user-password secret123 \ - --master-username admin \ - --storage-type gp2 \ - --license-model li \ - --domain-iam-role-name my-directory-iam-role \ - --domain my-domain-id \ - --option-group-name ssas-se-2017 - ``` - - For Windows: - - ``` - aws rds create-db-instance ^ - --db-instance-identifier myssasinstance ^ - --db-instance-class db.m5.2xlarge ^ - --engine sqlserver-se ^ - --engine-version 14.00.3223.3.v1 ^ - --allocated-storage 100 ^ - --master-user-password secret123 ^ - --master-username admin ^ - --storage-type gp2 ^ - --license-model li ^ - --domain-iam-role-name my-directory-iam-role ^ - --domain my-domain-id ^ - --option-group-name ssas-se-2017 - ``` - -**To modify a DB instance to associate the option group** -+ Use one of the following commands\. -**Example** - - For Linux, macOS, or Unix: - - ``` - aws rds modify-db-instance \ - --db-instance-identifier myssasinstance \ - --option-group-name ssas-se-2017 \ - --apply-immediately - ``` - - For Windows: - - ``` - aws rds modify-db-instance ^ - --db-instance-identifier myssasinstance ^ - --option-group-name ssas-se-2017 ^ - --apply-immediately - ``` - -### Allowing inbound access to your VPC security group - -Create an inbound rule for the specified SSAS listener port in the VPC security group associated with your DB instance\. For more information about setting up security groups, see [Provide access to your DB instance in your VPC by creating a security group](CHAP_SettingUp.md#CHAP_SettingUp.SecurityGroup)\. - -### Enabling Amazon S3 integration - -To download model configuration files to your host for deployment, use Amazon S3 integration\. For more information, see [Integrating an Amazon RDS for SQL Server DB instance with Amazon S3](User.SQLServer.Options.S3-integration.md)\. - -## Deploying SSAS projects on Amazon RDS - -On RDS, you can't deploy SSAS projects directly by using SQL Server Management Studio \(SSMS\)\. To deploy projects, use an RDS stored procedure\. - -**Note** -Using \.xmla files for deployment isn't supported\. - -Before you deploy projects, make sure of the following: -+ Amazon S3 integration is turned on\. For more information, see [Integrating an Amazon RDS for SQL Server DB instance with Amazon S3](User.SQLServer.Options.S3-integration.md)\. -+ The `Processing Option` configuration setting is set to `Do Not Process`\. This setting means that no processing happens after deployment\. -+ You have both the `myssasproject.asdatabase` and `myssasproject.deploymentoptions` files\. They're automatically generated when you build the SSAS project\. - -**To deploy an SSAS project on RDS** - -1. Download the `.asdatabase` \(SSAS model\) file from your S3 bucket to your DB instance, as shown in the following example\. For more information on the download parameters, see [Downloading files from an Amazon S3 bucket to a SQL Server DB instance](User.SQLServer.Options.S3-integration.md#Appendix.SQLServer.Options.S3-integration.using.download)\. - - ``` - exec msdb.dbo.rds_download_from_s3 - @s3_arn_of_file='arn:aws:s3:::bucket_name/myssasproject.asdatabase', - [@rds_file_path='D:\S3\myssasproject.asdatabase'], - [@overwrite_file=1]; - ``` - -1. Download the `.deploymentoptions` file from your S3 bucket to your DB instance\. - - ``` - exec msdb.dbo.rds_download_from_s3 - @s3_arn_of_file='arn:aws:s3:::bucket_name/myssasproject.deploymentoptions', - [@rds_file_path='D:\S3\myssasproject.deploymentoptions'], - [@overwrite_file=1]; - ``` - -1. Deploy the project\. - - ``` - exec msdb.dbo.rds_msbi_task - @task_type='SSAS_DEPLOY_PROJECT', - @file_path='D:\S3\myssasproject.asdatabase'; - ``` - -## Monitoring the status of a deployment task - -To track the status of your deployment \(or download\) task, call the `rds_fn_task_status` function\. It takes two parameters\. The first parameter should always be `NULL` because it doesn't apply to SSAS\. The second parameter accepts a task ID\. - -To see a list of all tasks, set the first parameter to `NULL` and the second parameter to `0`, as shown in the following example\. - -``` -SELECT * FROM msdb.dbo.rds_fn_task_status(NULL,0); -``` - -To get a specific task, set the first parameter to `NULL` and the second parameter to the task ID, as shown in the following example\. - -``` -SELECT * FROM msdb.dbo.rds_fn_task_status(NULL,42); -``` - -The `rds_fn_task_status` function returns the following information\. - - -| Output parameter | Description | -| --- | --- | -| `task_id` | The ID of the task\. | -| `task_type` | For SSAS, tasks can have the following task types: [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Appendix.SQLServer.Options.SSAS.html) | -| `database_name` | Not applicable to SSAS tasks\. | -| `% complete` | The progress of the task as a percentage\. | -| `duration (mins)` | The amount of time spent on the task, in minutes\. | -| `lifecycle` | The status of the task\. Possible statuses are the following: [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Appendix.SQLServer.Options.SSAS.html) | -| `task_info` | Additional information about the task\. If an error occurs during processing, this column contains information about the error\. For more information, see [Troubleshooting SSAS issues](#SSAS.Trouble)\. | -| `last_updated` | The date and time that the task status was last updated\. | -| `created_at` | The date and time that the task was created\. | -| `S3_object_arn` | Not applicable to SSAS tasks\. | -| `overwrite_S3_backup_file` | Not applicable to SSAS tasks\. | -| `KMS_master_key_arn` | Not applicable to SSAS tasks\. | -| `filepath` | Not applicable to SSAS tasks\. | -| `overwrite_file` | Not applicable to SSAS tasks\. | -| `task_metadata` | Metadata associated with the SSAS task\. | - -## Using SSAS on Amazon RDS - -After deploying the SSAS project, you can directly process the OLAP database on SSMS\. - -**To use SSAS on RDS** - -1. In SSMS, connect to SSAS using the user name and password for the Active Directory domain\. - -1. Expand **Databases**\. The newly deployed SSAS database appears\. - -1. Locate the connection string, and update the user name and password to give access to the source SQL database\. Doing this is required for processing SSAS objects\. - - 1. For Tabular mode, do the following: - - 1. Expand the **Connections** tab\. - - 1. Open the context \(right\-click\) menu for the connection object, and then choose **Properties**\. - - 1. Update the user name and password in the connection string\. - - 1. For Multidimensional mode, do the following: - - 1. Expand the **Data Sources** tab\. - - 1. Open the context \(right\-click\) menu for the data source object, and then choose **Properties**\. - - 1. Update the user name and password in the connection string\. - -1. Open the context \(right\-click\) menu for the SSAS database that you created and choose **Process Database**\. - - Depending on the size of the input data, the processing operation might take several minutes to complete\. - -**Topics** -+ [Setting up a Windows\-authenticated user for SSAS](#SSAS.Use.Auth) -+ [Adding a domain user as a database administrator](#SSAS.Admin) -+ [Creating an SSAS proxy](#SSAS.Use.Proxy) -+ [Scheduling SSAS database processing using SQL Server Agent](#SSAS.Use.Schedule) -+ [Revoking SSAS access from the proxy](#SSAS.Use.Revoke) - -### Setting up a Windows\-authenticated user for SSAS - -The main administrator user \(sometimes called the master user\) can use the following code example to set up a Windows\-authenticated login and grant the required procedure permissions\. Doing this grants permissions to the domain user to run SSAS customer tasks, use S3 file transfer procedures, create credentials, and work with the SQL Server Agent proxy\. For more information, see [Credentials \(database engine\)](https://docs.microsoft.com/en-us/sql/relational-databases/security/authentication-access/credentials-database-engine?view=sql-server-ver15) and [Create a SQL Server Agent proxy](https://docs.microsoft.com/en-us/sql/ssms/agent/create-a-sql-server-agent-proxy?view=sql-server-ver15) in the Microsoft documentation\. - -You can grant some or all of the following permissions as needed to Windows\-authenticated users\. - -**Example** - -``` --- Create a server-level domain user login, if it doesn't already exist -USE [master] -GO -CREATE LOGIN [mydomain\user_name] FROM WINDOWS -GO - --- Create domain user, if it doesn't already exist -USE [msdb] -GO -CREATE USER [mydomain\user_name] FOR LOGIN [mydomain\user_name] -GO - --- Grant necessary privileges to the domain user -USE [master] -GO -GRANT ALTER ANY CREDENTIAL TO [mydomain\user_name] -GO - -USE [msdb] -GO -GRANT EXEC ON msdb.dbo.rds_msbi_task TO [mydomain\user_name] with grant option -GRANT SELECT ON msdb.dbo.rds_fn_task_status TO [mydomain\user_name] with grant option -GRANT EXEC ON msdb.dbo.rds_task_status TO [mydomain\user_name] with grant option -GRANT EXEC ON msdb.dbo.rds_cancel_task TO [mydomain\user_name] with grant option -GRANT EXEC ON msdb.dbo.rds_download_from_s3 TO [mydomain\user_name] with grant option -GRANT EXEC ON msdb.dbo.rds_upload_to_s3 TO [mydomain\user_name] with grant option -GRANT EXEC ON msdb.dbo.rds_delete_from_filesystem TO [mydomain\user_name] with grant option -GRANT EXEC ON msdb.dbo.rds_gather_file_details TO [mydomain\user_name] with grant option -GRANT EXEC ON msdb.dbo.sp_add_proxy TO [mydomain\user_name] with grant option -GRANT EXEC ON msdb.dbo.sp_update_proxy TO [mydomain\user_name] with grant option -GRANT EXEC ON msdb.dbo.sp_grant_login_to_proxy TO [mydomain\user_name] with grant option -GRANT EXEC ON msdb.dbo.sp_revoke_login_from_proxy TO [mydomain\user_name] with grant option -GRANT EXEC ON msdb.dbo.sp_delete_proxy TO [mydomain\user_name] with grant option -GRANT EXEC ON msdb.dbo.sp_enum_login_for_proxy to [mydomain\user_name] with grant option -GRANT EXEC ON msdb.dbo.sp_enum_proxy_for_subsystem TO [mydomain\user_name] with grant option -GRANT EXEC ON msdb.dbo.rds_sqlagent_proxy TO [mydomain\user_name] with grant option -ALTER ROLE [SQLAgentUserRole] ADD MEMBER [mydomain\user_name] -GO -``` - -### Adding a domain user as a database administrator - -You can add a domain user as an SSAS database administrator in the following ways: -+ A database administrator can use SSMS to create a role with `admin` privileges, then add users to that role\. -+ You can use the following stored procedure\. - - ``` - exec msdb.dbo.rds_msbi_task - @task_type='SSAS_ADD_DB_ADMIN_MEMBER', - @database_name='myssasdb', - @ssas_role_name='exampleRole', - @ssas_role_member='domain_name\domain_user_name'; - ``` - - The following parameters are required: - + `@task_type` – The type of the MSBI task, in this case `SSAS_ADD_DB_ADMIN_MEMBER`\. - + `@database_name` – The name of the SSAS database to which you're granting administrator privileges\. - + `@ssas_role_name` – The SSAS database administrator role name\. If the role doesn't already exist, it's created\. - + `@ssas_role_member` – The SSAS database user that you're adding to the administrator role\. - -### Creating an SSAS proxy - -To be able to schedule SSAS database processing using SQL Server Agent, create an SSAS credential and an SSAS proxy\. Run these procedures as a Windows\-authenticated user\. - -**To create the SSAS credential** -+ Create the credential for the proxy\. To do this, you can use SSMS or the following SQL statement\. - - ``` - USE [master] - GO - CREATE CREDENTIAL [SSAS_Credential] WITH IDENTITY = N'mydomain\user_name', SECRET = N'mysecret' - GO - ``` -**Note** -`IDENTITY` must be a domain\-authenticated login\. Replace `mysecret` with the password for the domain\-authenticated login\. - -**To create the SSAS proxy** - -1. Use the following SQL statement to create the proxy\. - - ``` - USE [msdb] - GO - EXEC msdb.dbo.sp_add_proxy @proxy_name=N'SSAS_Proxy',@credential_name=N'SSAS_Credential',@description=N'' - GO - ``` - -1. Use the following SQL statement to grant access to the proxy to other users\. - - ``` - USE [msdb] - GO - EXEC msdb.dbo.sp_grant_login_to_proxy @proxy_name=N'SSAS_Proxy',@login_name=N'mydomain\user_name' - GO - ``` - -1. Use the following SQL statement to give the SSAS subsystem access to the proxy\. - - ``` - USE [msdb] - GO - EXEC msdb.dbo.rds_sqlagent_proxy @task_type='GRANT_SUBSYSTEM_ACCESS',@proxy_name='SSAS_Proxy',@proxy_subsystem='SSAS' - GO - ``` - -**To view the proxy and grants on the proxy** - -1. Use the following SQL statement to view the grantees of the proxy\. - - ``` - USE [msdb] - GO - EXEC sp_help_proxy - GO - ``` - -1. Use the following SQL statement to view the subsystem grants\. - - ``` - USE [msdb] - GO - EXEC msdb.dbo.sp_enum_proxy_for_subsystem - GO - ``` - -### Scheduling SSAS database processing using SQL Server Agent - -After you create the credential and proxy and grant SSAS access to the proxy, you can create a SQL Server Agent job to schedule SSAS database processing\. - -**To schedule SSAS database processing** -+ Use SSMS or T\-SQL for creating the SQL Server Agent job\. The following example uses T\-SQL\. You can further configure its job schedule through SSMS or T\-SQL\. - + The `@command` parameter outlines the XML for Analysis \(XMLA\) command to be run by the SQL Server Agent job\. This example configures SSAS Multidimensional database processing\. - + The `@server` parameter outlines the target SSAS server name of the SQL Server Agent job\. - - To call the SSAS service within the same RDS DB instance where the SQL Server Agent job resides, use `localhost:2383`\. - - To call the SSAS service from outside the RDS DB instance, use the RDS endpoint\. You can also use the Kerberos Active Directory \(AD\) endpoint \(`your-DB-instance-name.your-AD-domain-name`\) if the RDS DB instances are joined by the same domain\. For external DB instances, make sure to properly configure the VPC security group associated with the RDS DB instance for a secure connection\. - - You can further edit the query to support various XMLA operations\. Make edits either by directly modifying the T\-SQL query or by using the SSMS UI following SQL Server Agent job creation\. - - ``` - USE [msdb] - GO - DECLARE @jobId BINARY(16) - EXEC msdb.dbo.sp_add_job @job_name=N'SSAS_Job', - @enabled=1, - @notify_level_eventlog=0, - @notify_level_email=0, - @notify_level_netsend=0, - @notify_level_page=0, - @delete_level=0, - @category_name=N'[Uncategorized (Local)]', - @job_id = @jobId OUTPUT - GO - EXEC msdb.dbo.sp_add_jobserver - @job_name=N'SSAS_Job', - @server_name = N'(local)' - GO - EXEC msdb.dbo.sp_add_jobstep @job_name=N'SSAS_Job', @step_name=N'Process_SSAS_Object', - @step_id=1, - @cmdexec_success_code=0, - @on_success_action=1, - @on_success_step_id=0, - @on_fail_action=2, - @on_fail_step_id=0, - @retry_attempts=0, - @retry_interval=0, - @os_run_priority=0, @subsystem=N'ANALYSISCOMMAND', - @command=N' - - - - Your_SSAS_Database_ID - - ProcessFull - UseExisting - - - ', - @server=N'localhost:2383', - @database_name=N'master', - @flags=0, - @proxy_name=N'SSAS_Proxy' - GO - ``` - -### Revoking SSAS access from the proxy - -You can revoke access to the SSAS subsystem and delete the SSAS proxy using the following stored procedures\. - -**To revoke access and delete the proxy** - -1. Revoke subsystem access\. - - ``` - USE [msdb] - GO - EXEC msdb.dbo.rds_sqlagent_proxy @task_type='REVOKE_SUBSYSTEM_ACCESS',@proxy_name='SSAS_Proxy',@proxy_subsystem='SSAS' - GO - ``` - -1. Revoke the grants on the proxy\. - - ``` - USE [msdb] - GO - EXEC msdb.dbo.sp_revoke_login_from_proxy @proxy_name=N'SSAS_Proxy',@name=N'mydomain\user_name' - GO - ``` - -1. Delete the proxy\. - - ``` - USE [msdb] - GO - EXEC dbo.sp_delete_proxy @proxy_name = N'SSAS_Proxy' - GO - ``` - -## Backing up an SSAS database - -You can create SSAS database backup files only in the `D:\S3` folder on the DB instance\. To move the backup files to your S3 bucket, use Amazon S3\. - -You can back up an SSAS database as follows: -+ A domain user with the `admin` role for a particular database can use SSMS to back up the database to the `D:\S3` folder\. - - For more information, see [Adding a domain user as a database administrator](#SSAS.Admin)\. -+ You can use the following stored procedure\. This stored procedure doesn't support encryption\. - - ``` - exec msdb.dbo.rds_msbi_task - @task_type='SSAS_BACKUP_DB', - @database_name='myssasdb', - @file_path='D:\S3\ssas_db_backup.abf', - [@ssas_apply_compression=1], - [@ssas_overwrite_file=1]; - ``` - - The following parameters are required: - + `@task_type` – The type of the MSBI task, in this case `SSAS_BACKUP_DB`\. - + `@database_name` – The name of the SSAS database that you're backing up\. - + `@file_path` – The path for the SSAS backup file\. The `.abf` extension is required\. - - The following parameters are optional: - + `@ssas_apply_compression` – Whether to apply SSAS backup compression\. Valid values are 1 \(Yes\) and 0 \(No\)\. - + `@ssas_overwrite_file` – Whether to overwrite the SSAS backup file\. Valid values are 1 \(Yes\) and 0 \(No\)\. - -## Restoring an SSAS database - -Use the following stored procedure to restore an SSAS database from a backup\. - -You can't restore a database if there is an existing SSAS database with the same name\. The stored procedure for restoring doesn't support encrypted backup files\. - -``` -exec msdb.dbo.rds_msbi_task -@task_type='SSAS_RESTORE_DB', -@database_name='mynewssasdb', -@file_path='D:\S3\ssas_db_backup.abf'; -``` - -The following parameters are required: -+ `@task_type` – The type of the MSBI task, in this case `SSAS_RESTORE_DB`\. -+ `@database_name` – The name of the new SSAS database that you're restoring to\. -+ `@file_path` – The path to the SSAS backup file\. - -### Restoring a DB instance to a specified time - -Point\-in\-time recovery \(PITR\) doesn't apply to SSAS databases\. If you do PITR, only the SSAS data in the last snapshot before the requested time is available on the restored instance\. - -**To have up\-to\-date SSAS databases on a restored DB instance** - -1. Back up your SSAS databases to the `D:\S3` folder on the source instance\. - -1. Transfer the backup files to the S3 bucket\. - -1. Transfer the backup files from the S3 bucket to the `D:\S3` folder on the restored instance\. - -1. Run the stored procedure to restore the SSAS databases onto the restored instance\. - - You can also reprocess the SSAS project to restore the databases\. - -## Changing the SSAS mode - -You can change the mode in which SSAS runs, either Tabular or Multidimensional\. To change the mode, use the AWS Management Console or the AWS CLI to modify the options settings in the SSAS option\. - -**Important** -You can only use one SSAS mode at a time\. Make sure to delete all of the SSAS databases before changing the mode, or you receive an error\. - -### Console - -The following Amazon RDS console procedure changes the SSAS mode to Tabular and sets the `MAX_MEMORY` parameter to 70 percent\. - -**To modify the SSAS option** - -1. Sign in to the AWS Management Console and open the Amazon RDS console at [https://console\.aws\.amazon\.com/rds/](https://console.aws.amazon.com/rds/)\. - -1. In the navigation pane, choose **Option groups**\. - -1. Choose the option group with the `SSAS` option that you want to modify \(`ssas-se-2017` in the previous examples\)\. - -1. Choose **Modify option**\. - -1. Change the option settings: - - 1. For **Max memory**, enter **70**\. - - 1. For **Mode**, choose **Tabular**\. - -1. Choose **Modify option**\. - -### AWS CLI - -The following AWS CLI example changes the SSAS mode to Tabular and sets the `MAX_MEMORY` parameter to 70 percent\. - -For the CLI command to work, make sure to include all of the required parameters, even if you're not modifying them\. - -**To modify the SSAS option** -+ Use one of the following commands\. -**Example** - - For Linux, macOS, or Unix: - - ``` - aws rds add-option-to-option-group \ - --option-group-name ssas-se-2017 \ - --options "OptionName=SSAS,VpcSecurityGroupMemberships=sg-12345e67,OptionSettings=[{Name=MAX_MEMORY,Value=70},{Name=MODE,Value=Tabular}]" \ - --apply-immediately - ``` - - For Windows: - - ``` - aws rds add-option-to-option-group ^ - --option-group-name ssas-se-2017 ^ - --options OptionName=SSAS,VpcSecurityGroupMemberships=sg-12345e67,OptionSettings=[{Name=MAX_MEMORY,Value=70},{Name=MODE,Value=Tabular}] ^ - --apply-immediately - ``` - -## Turning off SSAS - -To turn off SSAS, remove the `SSAS` option from its option group\. - -**Important** -Before you remove the `SSAS` option, delete your SSAS databases\. -We highly recommend that you back up your SSAS databases before deleting them and removing the `SSAS` option\. - -### Console - -**To remove the SSAS option from its option group** - -1. Sign in to the AWS Management Console and open the Amazon RDS console at [https://console\.aws\.amazon\.com/rds/](https://console.aws.amazon.com/rds/)\. - -1. In the navigation pane, choose **Option groups**\. - -1. Choose the option group with the `SSAS` option that you want to remove \(`ssas-se-2017` in the previous examples\)\. - -1. Choose **Delete option**\. - -1. Under **Deletion options**, choose **SSAS** for **Options to delete**\. - -1. Under **Apply immediately**, choose **Yes** to delete the option immediately, or **No** to delete it at the next maintenance window\. - -1. Choose **Delete**\. - -### AWS CLI - -**To remove the SSAS option from its option group** -+ Use one of the following commands\. -**Example** - - For Linux, macOS, or Unix: - - ``` - aws rds remove-option-from-option-group \ - --option-group-name ssas-se-2017 \ - --options SSAS \ - --apply-immediately - ``` - - For Windows: - - ``` - aws rds remove-option-from-option-group ^ - --option-group-name ssas-se-2017 ^ - --options SSAS ^ - --apply-immediately - ``` - -## Troubleshooting SSAS issues - -You might encounter the following issues when using SSAS\. - - -| Issue | Type | Troubleshooting suggestions | -| --- | --- | --- | -| Unable to configure the SSAS option\. The requested SSAS mode is new\_mode, but the current DB instance has number current\_mode databases\. Delete the existing databases before switching to new\_mode mode\. To regain access to current\_mode mode for database deletion, either update the current DB option group, or attach a new option group with %s as the MODE option setting value for the SSAS option\. | RDS event | You can't change the SSAS mode if you still have SSAS databases that use the current mode\. Delete the SSAS databases, then try again\. | -| Unable to remove the SSAS option because there are number existing mode databases\. The SSAS option can't be removed until all SSAS databases are deleted\. Add the SSAS option again, delete all SSAS databases, and try again\. | RDS event | You can't turn off SSAS if you still have SSAS databases\. Delete the SSAS databases, then try again\. | -| The SSAS option isn't enabled or is in the process of being enabled\. Try again later\. | RDS stored procedure | You can't run SSAS stored procedures when the option is turned off, or when it's being turned on\. | -| The SSAS option is configured incorrectly\. Make sure that the option group membership status is "in\-sync", and review the RDS event logs for relevant SSAS configuration error messages\. Following these investigations, try again\. If errors continue to occur, contact AWS Support\. | RDS stored procedure | You can't run SSAS stored procedures when your option group membership isn't in the `in-sync` status\. This puts the SSAS option in an incorrect configuration state\. If your option group membership status changes to `failed` due to SSAS option modification, there are two possible reasons: [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Appendix.SQLServer.Options.SSAS.html) Reconfigure the SSAS option, because RDS allows only one SSAS mode at a time, and doesn't support SSAS option removal with SSAS databases present\. Check the RDS event logs for configuration errors for your SSAS instance, and resolve the issues accordingly\. | -| Deployment failed\. The change can only be deployed on a server running in deployment\_file\_mode mode\. The current server mode is current\_mode\. | RDS stored procedure | You can't deploy a Tabular database to a Multidimensional server, or a Multidimensional database to a Tabular server\. Make sure that you're using files with the correct mode, and verify that the `MODE` option setting is set to the appropriate value\. | -| The restore failed\. The backup file can only be restored on a server running in restore\_file\_mode mode\. The current server mode is current\_mode\. | RDS stored procedure | You can't restore a Tabular database to a Multidimensional server, or a Multidimensional database to a Tabular server\. Make sure that you're using files with the correct mode, and verify that the `MODE` option setting is set to the appropriate value\. | -| The restore failed\. The backup file and the RDS DB instance versions are incompatible\. | RDS stored procedure | You can't restore an SSAS database with a version incompatible to the SQL Server instance version\. For more information, see [Compatibility levels for tabular models](https://docs.microsoft.com/en-us/analysis-services/tabular-models/compatibility-level-for-tabular-models-in-analysis-services) and [Compatibility level of a multidimensional database](https://docs.microsoft.com/en-us/analysis-services/multidimensional-models/compatibility-level-of-a-multidimensional-database-analysis-services) in the Microsoft documentation\. | -| The restore failed\. The backup file specified in the restore operation is damaged or is not an SSAS backup file\. Make sure that @rds\_file\_path is correctly formatted\. | RDS stored procedure | You can't restore an SSAS database with a damaged file\. Make sure that the file isn't damaged or corrupted\. This error can also be raised when `@rds_file_path` isn't correctly formatted \(for example, it has double backslashes as in `D:\S3\\incorrect_format.abf`\)\. | -| The restore failed\. The restored database name can't contain any reserved words or invalid characters: \. , ; ' ` : / \\\\ \* \| ? \\" & % $ \! \+ = \( \) \[ \] \{ \} < >, or be longer than 100 characters\. | RDS stored procedure | The restored database name can't contain any reserved words or characters that aren't valid, or be longer than 100 characters\. For SSAS object naming conventions, see [Object naming rules](https://docs.microsoft.com/en-us/analysis-services/multidimensional-models/olap-physical/object-naming-rules-analysis-services) in the Microsoft documentation\. | -| An invalid role name was provided\. The role name can't contain any reserved strings\. | RDS stored procedure | The role name can't contain any reserved strings\. For SSAS object naming conventions, see [Object naming rules](https://docs.microsoft.com/en-us/analysis-services/multidimensional-models/olap-physical/object-naming-rules-analysis-services) in the Microsoft documentation\. | -| An invalid role name was provided\. The role name can't contain any of the following reserved characters: \. , ; ' ` : / \\\\ \* \| ? \\" & % $ \! \+ = \( \) \[ \] \{ \} < > | RDS stored procedure | The role name can't contain any reserved characters\. For SSAS object naming conventions, see [Object naming rules](https://docs.microsoft.com/en-us/analysis-services/multidimensional-models/olap-physical/object-naming-rules-analysis-services) in the Microsoft documentation\. | \ No newline at end of file diff --git a/doc_source/Appendix.SQLServer.Options.SSIS.md b/doc_source/Appendix.SQLServer.Options.SSIS.md deleted file mode 100644 index b2be0e3..0000000 --- a/doc_source/Appendix.SQLServer.Options.SSIS.md +++ /dev/null @@ -1,754 +0,0 @@ -# Support for SQL Server Integration Services in Amazon RDS for SQL Server - -Microsoft SQL Server Integration Services \(SSIS\) is a component that you can use to perform a broad range of data migration tasks\. SSIS is a platform for data integration and workflow applications\. It features a data warehousing tool used for data extraction, transformation, and loading \(ETL\)\. You can also use this tool to automate maintenance of SQL Server databases and updates to multidimensional cube data\. - -SSIS projects are organized into packages saved as XML\-based \.dtsx files\. Packages can contain control flows and data flows\. You use data flows to represent ETL operations\. After deployment, packages are stored in SQL Server in the SSISDB database\. SSISDB is an online transaction processing \(OLTP\) database in the full recovery mode\. - -Amazon RDS for SQL Server supports running SSIS directly on an RDS DB instance\. You can enable SSIS on an existing or new DB instance\. SSIS is installed on the same DB instance as your database engine\. - -RDS supports SSIS for SQL Server Standard and Enterprise Editions on the following versions: -+ SQL Server 2019, version 15\.00\.4043\.16\.v1 and higher -+ SQL Server 2017, version 14\.00\.3223\.3\.v1 and higher -+ SQL Server 2016, version 13\.00\.5426\.0\.v1 and higher - -**Contents** -+ [Limitations and recommendations](#SSIS.Limitations) -+ [Enabling SSIS](#SSIS.Enabling) - + [Creating the option group for SSIS](#SSIS.OptionGroup) - + [Adding the SSIS option to the option group](#SSIS.Add) - + [Creating the parameter group for SSIS](#SSIS.CreateParamGroup) - + [Modifying the parameter for SSIS](#SSIS.ModifyParam) - + [Associating the option group and parameter group with your DB instance](#SSIS.Apply) - + [Enabling S3 integration](#SSIS.EnableS3) -+ [Administrative permissions on SSISDB](#SSIS.Permissions) - + [Setting up a Windows\-authenticated user for SSIS](#SSIS.Use.Auth) -+ [Deploying an SSIS project](#SSIS.Deploy) -+ [Monitoring the status of a deployment task](#SSIS.Monitor) -+ [Using SSIS](#SSIS.Use) - + [Setting database connection managers for SSIS projects](#SSIS.Use.ConnMgrs) - + [Creating an SSIS proxy](#SSIS.Use.Proxy) - + [Scheduling an SSIS package using SQL Server Agent](#SSIS.Use.Schedule) - + [Revoking SSIS access from the proxy](#SSIS.Use.Revoke) -+ [Disabling SSIS](#SSIS.Disable) -+ [Dropping the SSISDB database](#SSIS.Drop) - -## Limitations and recommendations - -The following limitations and recommendations apply to running SSIS on RDS for SQL Server: -+ The DB instance must use AWS Managed Microsoft AD for SSIS authentication\. -+ The DB instance must have an associated parameter group with the `clr enabled` parameter set to 1\. For more information, see [Modifying the parameter for SSIS](#SSIS.ModifyParam)\. -**Note** -If you enable the `clr enabled` parameter on SQL Server 2017 or 2019, you can't use the common language runtime \(CLR\) on your DB instance\. For more information, see [Features not supported and features with limited support](CHAP_SQLServer.md#SQLServer.Concepts.General.FeatureNonSupport)\. -+ The following control flow tasks are supported: - + Analysis Services Execute DDL Task - + Analysis Services Processing Task - + Bulk Insert Task - + Check Database Integrity Task - + Data Flow Task - + Data Mining Query Task - + Data Profiling Task - + Execute Package Task - + Execute SQL Server Agent Job Task - + Execute SQL Task - + Execute T\-SQL Statement Task - + Notify Operator Task - + Rebuild Index Task - + Reorganize Index Task - + Shrink Database Task - + Transfer Database Task - + Transfer Jobs Task - + Transfer Logins Task - + Transfer SQL Server Objects Task - + Update Statistics Task -+ Only project deployment is supported\. -+ Running SSIS packages by using SQL Server Agent is supported\. -+ SSIS log records can be inserted only into user\-created databases\. -+ Use only the `D:\S3` folder for working with files\. Files placed in any other directory are deleted\. Be aware of a few other file location details: - + Place SSIS project input and output files in the `D:\S3` folder\. - + For the Data Flow Task, change the location for `BLOBTempStoragePath` and `BufferTempStoragePath` to a file inside the `D:\S3` folder\. The file path must start with `D:\S3\`\. - + Ensure that all parameters, variables, and expressions used for file connections point to the `D:\S3` folder\. - + On Multi\-AZ instances, files created by SSIS in the `D:\S3` folder are deleted after a failover\. For more information, see [Multi\-AZ limitations for S3 integration](User.SQLServer.Options.S3-integration.md#S3-MAZ)\. - + Upload the files created by SSIS in the `D:\S3` folder to your Amazon S3 bucket to make them durable\. -+ Import Column and Export Column transformations and the Script component on the Data Flow Task aren't supported\. -+ You can't enable dump on running SSIS packages, and you can't add data taps on SSIS packages\. -+ The SSIS Scale Out feature isn't supported\. -+ You can't deploy projects directly\. We provide RDS stored procedures to do this\. For more information, see [Deploying an SSIS project](#SSIS.Deploy)\. -+ Build SSIS project \(\.ispac\) files with the `DoNotSavePasswords` protection mode for deploying on RDS\. -+ SSIS isn't supported on Always On instances with read replicas\. -+ You can't back up the SSISDB database that is associated with the `SSIS` option\. -+ Importing and restoring the SSISDB database from other instances of SSIS isn't supported\. -+ You can connect to other SQL Server DB instances or to an Oracle data source\. Connecting to other database engines, such as MySQL or PostgreSQL, isn't supported for SSIS on RDS for SQL Server\. For more information on connecting to an Oracle data source, see [Linked Servers with Oracle OLEDB](Appendix.SQLServer.Options.LinkedServers_Oracle_OLEDB.md)\. - -## Enabling SSIS - -You enable SSIS by adding the SSIS option to your DB instance\. Use the following process: - -1. Create a new option group, or choose an existing option group\. - -1. Add the `SSIS` option to the option group\. - -1. Create a new parameter group, or choose an existing parameter group\. - -1. Modify the parameter group to set the `clr enabled` parameter to 1\. - -1. Associate the option group and parameter group with the DB instance\. - -1. Enable Amazon S3 integration\. - -**Note** -If a database with the name SSISDB or a reserved SSIS login already exists on the DB instance, you can't enable SSIS on the instance\. - -### Creating the option group for SSIS - -To work with SSIS, create an option group or modify an option group that corresponds to the SQL Server edition and version of the DB instance that you plan to use\. To do this, use the AWS Management Console or the AWS CLI\. - -#### Console - -The following procedure creates an option group for SQL Server Standard Edition 2016\. - -**To create the option group** - -1. Sign in to the AWS Management Console and open the Amazon RDS console at [https://console\.aws\.amazon\.com/rds/](https://console.aws.amazon.com/rds/)\. - -1. In the navigation pane, choose **Option groups**\. - -1. Choose **Create group**\. - -1. In the **Create option group** window, do the following: - - 1. For **Name**, enter a name for the option group that is unique within your AWS account, such as **ssis\-se\-2016**\. The name can contain only letters, digits, and hyphens\. - - 1. For **Description**, enter a brief description of the option group, such as **SSIS option group for SQL Server SE 2016**\. The description is used for display purposes\. - - 1. For **Engine**, choose **sqlserver\-se**\. - - 1. For **Major engine version**, choose **13\.00**\. - -1. Choose **Create**\. - -#### CLI - -The following procedure creates an option group for SQL Server Standard Edition 2016\. - -**To create the option group** -+ Run one of the following commands\. -**Example** - - For Linux, macOS, or Unix: - - ``` - aws rds create-option-group \ - --option-group-name ssis-se-2016 \ - --engine-name sqlserver-se \ - --major-engine-version 13.00 \ - --option-group-description "SSIS option group for SQL Server SE 2016" - ``` - - For Windows: - - ``` - aws rds create-option-group ^ - --option-group-name ssis-se-2016 ^ - --engine-name sqlserver-se ^ - --major-engine-version 13.00 ^ - --option-group-description "SSIS option group for SQL Server SE 2016" - ``` - -### Adding the SSIS option to the option group - -Next, use the AWS Management Console or the AWS CLI to add the `SSIS` option to your option group\. - -#### Console - -**To add the SSIS option** - -1. Sign in to the AWS Management Console and open the Amazon RDS console at [https://console\.aws\.amazon\.com/rds/](https://console.aws.amazon.com/rds/)\. - -1. In the navigation pane, choose **Option groups**\. - -1. Choose the option group that you just created, **ssis\-se\-2016** in this example\. - -1. Choose **Add option**\. - -1. Under **Option details**, choose **SSIS** for **Option name**\. - -1. Under **Scheduling**, choose whether to add the option immediately or at the next maintenance window\. - -1. Choose **Add option**\. - -#### CLI - -**To add the SSIS option** -+ Add the `SSIS` option to the option group\. -**Example** - - For Linux, macOS, or Unix: - - ``` - aws rds add-option-to-option-group \ - --option-group-name ssis-se-2016 \ - --options OptionName=SSIS \ - --apply-immediately - ``` - - For Windows: - - ``` - aws rds add-option-to-option-group ^ - --option-group-name ssis-se-2016 ^ - --options OptionName=SSIS ^ - --apply-immediately - ``` - -### Creating the parameter group for SSIS - -Create or modify a parameter group for the `clr enabled` parameter that corresponds to the SQL Server edition and version of the DB instance that you plan to use for SSIS\. - -#### Console - -The following procedure creates a parameter group for SQL Server Standard Edition 2016\. - -**To create the parameter group** - -1. Sign in to the AWS Management Console and open the Amazon RDS console at [https://console\.aws\.amazon\.com/rds/](https://console.aws.amazon.com/rds/)\. - -1. In the navigation pane, choose **Parameter groups**\. - -1. Choose **Create parameter group**\. - -1. In the **Create parameter group** pane, do the following: - - 1. For **Parameter group family**, choose **sqlserver\-se\-13\.0**\. - - 1. For **Group name**, enter an identifier for the parameter group, such as **ssis\-sqlserver\-se\-13**\. - - 1. For **Description**, enter **clr enabled parameter group**\. - -1. Choose **Create**\. - -#### CLI - -The following procedure creates a parameter group for SQL Server Standard Edition 2016\. - -**To create the parameter group** -+ Run one of the following commands\. -**Example** - - For Linux, macOS, or Unix: - - ``` - aws rds create-db-parameter-group \ - --db-parameter-group-name ssis-sqlserver-se-13 \ - --db-parameter-group-family "sqlserver-se-13.0" \ - --description "clr enabled parameter group" - ``` - - For Windows: - - ``` - aws rds create-db-parameter-group ^ - --db-parameter-group-name ssis-sqlserver-se-13 ^ - --db-parameter-group-family "sqlserver-se-13.0" ^ - --description "clr enabled parameter group" - ``` - -### Modifying the parameter for SSIS - -Modify the `clr enabled` parameter in the parameter group that corresponds to the SQL Server edition and version of your DB instance\. For SSIS, set the `clr enabled` parameter to 1\. - -#### Console - -The following procedure modifies the parameter group that you created for SQL Server Standard Edition 2016\. - -**To modify the parameter group** - -1. Sign in to the AWS Management Console and open the Amazon RDS console at [https://console\.aws\.amazon\.com/rds/](https://console.aws.amazon.com/rds/)\. - -1. In the navigation pane, choose **Parameter groups**\. - -1. Choose the parameter group, such as **ssis\-sqlserver\-se\-13**\. - -1. Under **Parameters**, filter the parameter list for **clr**\. - -1. Choose **clr enabled**\. - -1. Choose **Edit parameters**\. - -1. From **Values**, choose **1**\. - -1. Choose **Save changes**\. - -#### CLI - -The following procedure modifies the parameter group that you created for SQL Server Standard Edition 2016\. - -**To modify the parameter group** -+ Run one of the following commands\. -**Example** - - For Linux, macOS, or Unix: - - ``` - aws rds modify-db-parameter-group \ - --db-parameter-group-name ssis-sqlserver-se-13 \ - --parameters "ParameterName='clr enabled',ParameterValue=1,ApplyMethod=immediate" - ``` - - For Windows: - - ``` - aws rds modify-db-parameter-group ^ - --db-parameter-group-name ssis-sqlserver-se-13 ^ - --parameters "ParameterName='clr enabled',ParameterValue=1,ApplyMethod=immediate" - ``` - -### Associating the option group and parameter group with your DB instance - -To associate the SSIS option group and parameter group with your DB instance, use the AWS Management Console or the AWS CLI - -**Note** -If you use an existing instance, it must already have an Active Directory domain and AWS Identity and Access Management \(IAM\) role associated with it\. If you create a new instance, specify an existing Active Directory domain and IAM role\. For more information, see [Using Windows Authentication with an Amazon RDS for SQL Server DB instance](USER_SQLServerWinAuth.md)\. - -#### Console - -To finish enabling SSIS, associate your SSIS option group and parameter group with a new or existing DB instance: -+ For a new DB instance, associate them when you launch the instance\. For more information, see [Creating an Amazon RDS DB instance](USER_CreateDBInstance.md)\. -+ For an existing DB instance, associate them by modifying the instance\. For more information, see [Modifying an Amazon RDS DB instance](Overview.DBInstance.Modifying.md)\. - -#### CLI - -You can associate the SSIS option group and parameter group with a new or existing DB instance\. - -**To create an instance with the SSIS option group and parameter group** -+ Specify the same DB engine type and major version as you used when creating the option group\. -**Example** - - For Linux, macOS, or Unix: - - ``` - aws rds create-db-instance \ - --db-instance-identifier myssisinstance \ - --db-instance-class db.m5.2xlarge \ - --engine sqlserver-se \ - --engine-version 13.00.5426.0.v1 \ - --allocated-storage 100 \ - --master-user-password secret123 \ - --master-username admin \ - --storage-type gp2 \ - --license-model li \ - --domain-iam-role-name my-directory-iam-role \ - --domain my-domain-id \ - --option-group-name ssis-se-2016 \ - --db-parameter-group-name ssis-sqlserver-se-13 - ``` - - For Windows: - - ``` - aws rds create-db-instance ^ - --db-instance-identifier myssisinstance ^ - --db-instance-class db.m5.2xlarge ^ - --engine sqlserver-se ^ - --engine-version 13.00.5426.0.v1 ^ - --allocated-storage 100 ^ - --master-user-password secret123 ^ - --master-username admin ^ - --storage-type gp2 ^ - --license-model li ^ - --domain-iam-role-name my-directory-iam-role ^ - --domain my-domain-id ^ - --option-group-name ssis-se-2016 ^ - --db-parameter-group-name ssis-sqlserver-se-13 - ``` - -**To modify an instance and associate the SSIS option group and parameter group** -+ Run one of the following commands\. -**Example** - - For Linux, macOS, or Unix: - - ``` - aws rds modify-db-instance \ - --db-instance-identifier myssisinstance \ - --option-group-name ssis-se-2016 \ - --db-parameter-group-name ssis-sqlserver-se-13 \ - --apply-immediately - ``` - - For Windows: - - ``` - aws rds modify-db-instance ^ - --db-instance-identifier myssisinstance ^ - --option-group-name ssis-se-2016 ^ - --db-parameter-group-name ssis-sqlserver-se-13 ^ - --apply-immediately - ``` - -### Enabling S3 integration - -To download SSIS project \(\.ispac\) files to your host for deployment, use S3 file integration\. For more information, see [Integrating an Amazon RDS for SQL Server DB instance with Amazon S3](User.SQLServer.Options.S3-integration.md)\. - -## Administrative permissions on SSISDB - -When the instance is created or modified with the SSIS option, the result is an SSISDB database with the ssis\_admin and ssis\_logreader roles granted to the master user\. The master user has the following privileges in SSISDB: -+ alter on ssis\_admin role -+ alter on ssis\_logreader role -+ alter any user - -Because the master user is a SQL\-authenticated user, you can't use the master user for executing SSIS packages\. The master user can use these privileges to create new SSISDB users and add them to the ssis\_admin and ssis\_logreader roles\. Doing this is useful for giving access to your domain users for using SSIS\. - -### Setting up a Windows\-authenticated user for SSIS - -The master user can use the following code example to set up a Windows\-authenticated login in SSISDB and grant the required procedure permissions\. Doing this grants permissions to the domain user to deploy and run SSIS packages, use S3 file transfer procedures, create credentials, and work with the SQL Server Agent proxy\. For more information, see [Credentials \(database engine\)](https://docs.microsoft.com/en-us/sql/relational-databases/security/authentication-access/credentials-database-engine?view=sql-server-ver15) and [Create a SQL Server Agent proxy](https://docs.microsoft.com/en-us/sql/ssms/agent/create-a-sql-server-agent-proxy?view=sql-server-ver15) in the Microsoft documentation\. - -**Note** -You can grant some or all of the following permissions as needed to Windows\-authenticated users\. - -**Example** - -``` --- Create a server-level SQL login for the domain user, if it doesn't already exist -USE [master] -GO -CREATE LOGIN [mydomain\user_name] FROM WINDOWS -GO - --- Create a database-level account for the domain user, if it doesn't already exist -USE [SSISDB] -GO -CREATE USER [mydomain\user_name] FOR LOGIN [mydomain\user_name] - --- Add SSIS role membership to the domain user -ALTER ROLE [ssis_admin] ADD MEMBER [mydomain\user_name] -ALTER ROLE [ssis_logreader] ADD MEMBER [mydomain\user_name] -GO - --- Add MSDB role membership to the domain user -USE [msdb] -GO -CREATE USER [mydomain\user_name] FOR LOGIN [mydomain\user_name] - --- Grant MSDB stored procedure privileges to the domain user -GRANT EXEC ON msdb.dbo.rds_msbi_task TO [mydomain\user_name] with grant option -GRANT SELECT ON msdb.dbo.rds_fn_task_status TO [mydomain\user_name] with grant option -GRANT EXEC ON msdb.dbo.rds_task_status TO [mydomain\user_name] with grant option -GRANT EXEC ON msdb.dbo.rds_cancel_task TO [mydomain\user_name] with grant option -GRANT EXEC ON msdb.dbo.rds_download_from_s3 TO [mydomain\user_name] with grant option -GRANT EXEC ON msdb.dbo.rds_upload_to_s3 TO [mydomain\user_name] with grant option -GRANT EXEC ON msdb.dbo.rds_delete_from_filesystem TO [mydomain\user_name] with grant option -GRANT EXEC ON msdb.dbo.rds_gather_file_details TO [mydomain\user_name] with grant option -GRANT EXEC ON msdb.dbo.sp_add_proxy TO [mydomain\user_name] with grant option -GRANT EXEC ON msdb.dbo.sp_update_proxy TO [mydomain\user_name] with grant option -GRANT EXEC ON msdb.dbo.sp_grant_login_to_proxy TO [mydomain\user_name] with grant option -GRANT EXEC ON msdb.dbo.sp_revoke_login_from_proxy TO [mydomain\user_name] with grant option -GRANT EXEC ON msdb.dbo.sp_delete_proxy TO [mydomain\user_name] with grant option -GRANT EXEC ON msdb.dbo.sp_enum_login_for_proxy to [mydomain\user_name] with grant option -GRANT EXEC ON msdb.dbo.sp_enum_proxy_for_subsystem TO [mydomain\user_name] with grant option -GRANT EXEC ON msdb.dbo.rds_sqlagent_proxy TO [mydomain\user_name] WITH GRANT OPTION - - --- Add the SQLAgentUserRole privilege to the domain user -USE [msdb] -GO -ALTER ROLE [SQLAgentUserRole] ADD MEMBER [mydomain\user_name] -GO - --- Grant the ALTER ANY CREDENTIAL privilege to the domain user -USE [master] -GO -GRANT ALTER ANY CREDENTIAL TO [mydomain\user_name] -GO -``` - -## Deploying an SSIS project - -On RDS, you can't deploy SSIS projects directly by using SQL Server Management Studio \(SSMS\) or SSIS procedures\. To download project files from Amazon S3 and then deploy them, use RDS stored procedures\. - -To run the stored procedures, log in as any user that you granted permissions for running the stored procedures\. For more information, see [Setting up a Windows\-authenticated user for SSIS](#SSIS.Use.Auth)\. - -**To deploy the SSIS project** - -1. Download the project \(\.ispac\) file\. - - ``` - exec msdb.dbo.rds_download_from_s3 - @s3_arn_of_file='arn:aws:s3:::bucket_name/ssisproject.ispac', - [@rds_file_path='D:\S3\ssisproject.ispac'], - [@overwrite_file=1]; - ``` - -1. Submit the deployment task, making sure of the following: - + The folder is present in the SSIS catalog\. - + The project name matches the project name that you used while developing the SSIS project\. - - ``` - exec msdb.dbo.rds_msbi_task - @task_type='SSIS_DEPLOY_PROJECT', - @folder_name='DEMO', - @project_name='ssisproject', - @file_path='D:\S3\ssisproject.ispac'; - ``` - -## Monitoring the status of a deployment task - -To track the status of your deployment task, call the `rds_fn_task_status` function\. It takes two parameters\. The first parameter should always be `NULL` because it doesn't apply to SSIS\. The second parameter accepts a task ID\. - -To see a list of all tasks, set the first parameter to `NULL` and the second parameter to `0`, as shown in the following example\. - -``` -SELECT * FROM msdb.dbo.rds_fn_task_status(NULL,0); -``` - -To get a specific task, set the first parameter to `NULL` and the second parameter to the task ID, as shown in the following example\. - -``` -SELECT * FROM msdb.dbo.rds_fn_task_status(NULL,42); -``` - -The `rds_fn_task_status` function returns the following information\. - - -| Output parameter | Description | -| --- | --- | -| `task_id` | The ID of the task\. | -| `task_type` | `SSIS_DEPLOY_PROJECT` | -| `database_name` | Not applicable to SSIS tasks\. | -| `% complete` | The progress of the task as a percentage\. | -| `duration (mins)` | The amount of time spent on the task, in minutes\. | -| `lifecycle` | The status of the task\. Possible statuses are the following: [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Appendix.SQLServer.Options.SSIS.html) | -| `task_info` | Additional information about the task\. If an error occurs during processing, this column contains information about the error\. | -| `last_updated` | The date and time that the task status was last updated\. | -| `created_at` | The date and time that the task was created\. | -| `S3_object_arn` | Not applicable to SSIS tasks\. | -| `overwrite_S3_backup_file` | Not applicable to SSIS tasks\. | -| `KMS_master_key_arn` | Not applicable to SSIS tasks\. | -| `filepath` | Not applicable to SSIS tasks\. | -| `overwrite_file` | Not applicable to SSIS tasks\. | -| `task_metadata` | Metadata associated with the SSIS task\. | - -## Using SSIS - -After deploying the SSIS project into the SSIS catalog, you can run packages directly from SSMS or schedule them by using SQL Server Agent\. You must use a Windows\-authenticated login for executing SSIS packages\. For more information, see [Setting up a Windows\-authenticated user for SSIS](#SSIS.Use.Auth)\. - -**Topics** -+ [Setting database connection managers for SSIS projects](#SSIS.Use.ConnMgrs) -+ [Creating an SSIS proxy](#SSIS.Use.Proxy) -+ [Scheduling an SSIS package using SQL Server Agent](#SSIS.Use.Schedule) -+ [Revoking SSIS access from the proxy](#SSIS.Use.Revoke) - -### Setting database connection managers for SSIS projects - -When you use a connection manager, you can use these types of authentication: -+ For local database connections, you can use SQL authentication or Windows authentication\. For Windows authentication, use `DB_instance_name.fully_qualified_domain_name` as the server name of the connection string\. - - An example is `myssisinstance.corp-ad.example.com`, where `myssisinstance` is the DB instance name and `corp-ad.example.com` is the fully qualified domain name\. -+ For remote connections, always use SQL authentication\. - -### Creating an SSIS proxy - -To be able to schedule SSIS packages using SQL Server Agent, create an SSIS credential and an SSIS proxy\. Run these procedures as a Windows\-authenticated user\. - -**To create the SSIS credential** -+ Create the credential for the proxy\. To do this, you can use SSMS or the following SQL statement\. - - ``` - USE [master] - GO - CREATE CREDENTIAL [SSIS_Credential] WITH IDENTITY = N'mydomain\user_name', SECRET = N'mysecret' - GO - ``` -**Note** -`IDENTITY` must be a domain\-authenticated login\. Replace `mysecret` with the password for the domain\-authenticated login\. -Whenever the SSISDB primary host is changed, alter the SSIS proxy credentials to allow the new host to access them\. - -**To create the SSIS proxy** - -1. Use the following SQL statement to create the proxy\. - - ``` - USE [msdb] - GO - EXEC msdb.dbo.sp_add_proxy @proxy_name=N'SSIS_Proxy',@credential_name=N'SSIS_Credential',@description=N'' - GO - ``` - -1. Use the following SQL statement to grant access to the proxy to other users\. - - ``` - USE [msdb] - GO - EXEC msdb.dbo.sp_grant_login_to_proxy @proxy_name=N'SSIS_Proxy',@login_name=N'mydomain\user_name' - GO - ``` - -1. Use the following SQL statement to give the SSIS subsystem access to the proxy\. - - ``` - USE [msdb] - GO - EXEC msdb.dbo.rds_sqlagent_proxy @task_type='GRANT_SUBSYSTEM_ACCESS',@proxy_name='SSIS_Proxy',@proxy_subsystem='SSIS' - GO - ``` - -**To view the proxy and grants on the proxy** - -1. Use the following SQL statement to view the grantees of the proxy\. - - ``` - USE [msdb] - GO - EXEC sp_help_proxy - GO - ``` - -1. Use the following SQL statement to view the subsystem grants\. - - ``` - USE [msdb] - GO - EXEC msdb.dbo.sp_enum_proxy_for_subsystem - GO - ``` - -### Scheduling an SSIS package using SQL Server Agent - -After you create the credential and proxy and grant SSIS access to the proxy, you can create a SQL Server Agent job to schedule the SSIS package\. - -**To schedule the SSIS package** -+ You can use SSMS or T\-SQL for creating the SQL Server Agent job\. The following example uses T\-SQL\. - - ``` - USE [msdb] - GO - DECLARE @jobId BINARY(16) - EXEC msdb.dbo.sp_add_job @job_name=N'MYSSISJob', - @enabled=1, - @notify_level_eventlog=0, - @notify_level_email=2, - @notify_level_page=2, - @delete_level=0, - @category_name=N'[Uncategorized (Local)]', - @job_id = @jobId OUTPUT - GO - EXEC msdb.dbo.sp_add_jobserver @job_name=N'MYSSISJob',@server_name=N'(local)' - GO - EXEC msdb.dbo.sp_add_jobstep @job_name=N'MYSSISJob',@step_name=N'ExecuteSSISPackage', - @step_id=1, - @cmdexec_success_code=0, - @on_success_action=1, - @on_fail_action=2, - @retry_attempts=0, - @retry_interval=0, - @os_run_priority=0, - @subsystem=N'SSIS', - @command=N'/ISSERVER "\"\SSISDB\MySSISFolder\MySSISProject\MySSISPackage.dtsx\"" /SERVER "\"my-rds-ssis-instance.corp-ad.company.com/\"" - /Par "\"$ServerOption::LOGGING_LEVEL(Int16)\"";1 /Par "\"$ServerOption::SYNCHRONIZED(Boolean)\"";True /CALLERINFO SQLAGENT /REPORTING E', - @database_name=N'master', - @flags=0, - @proxy_name=N'SSIS_Proxy' - GO - ``` - -### Revoking SSIS access from the proxy - -You can revoke access to the SSIS subsystem and delete the SSIS proxy using the following stored procedures\. - -**To revoke access and delete the proxy** - -1. Revoke subsystem access\. - - ``` - USE [msdb] - GO - EXEC msdb.dbo.rds_sqlagent_proxy @task_type='REVOKE_SUBSYSTEM_ACCESS',@proxy_name='SSIS_Proxy',@proxy_subsystem='SSIS' - GO - ``` - -1. Revoke the grants on the proxy\. - - ``` - USE [msdb] - GO - EXEC msdb.dbo.sp_revoke_login_from_proxy @proxy_name=N'SSIS_Proxy',@name=N'mydomain\user_name' - GO - ``` - -1. Delete the proxy\. - - ``` - USE [msdb] - GO - EXEC dbo.sp_delete_proxy @proxy_name = N'SSIS_Proxy' - GO - ``` - -## Disabling SSIS - -To disable SSIS, remove the `SSIS` option from its option group\. - -**Important** -Removing the option doesn't delete the SSISDB database, so you can safely remove the option without losing the SSIS projects\. -You can re\-enable the `SSIS` option after removal to reuse the SSIS projects that were previously deployed to the SSIS catalog\. - -### Console - -The following procedure removes the `SSIS` option\. - -**To remove the SSIS option from its option group** - -1. Sign in to the AWS Management Console and open the Amazon RDS console at [https://console\.aws\.amazon\.com/rds/](https://console.aws.amazon.com/rds/)\. - -1. In the navigation pane, choose **Option groups**\. - -1. Choose the option group with the `SSIS` option \(`ssis-se-2016` in the previous examples\)\. - -1. Choose **Delete option**\. - -1. Under **Deletion options**, choose **SSIS** for **Options to delete**\. - -1. Under **Apply immediately**, choose **Yes** to delete the option immediately, or **No** to delete it at the next maintenance window\. - -1. Choose **Delete**\. - -### CLI - -The following procedure removes the `SSIS` option\. - -**To remove the SSIS option from its option group** -+ Run one of the following commands\. -**Example** - - For Linux, macOS, or Unix: - - ``` - aws rds remove-option-from-option-group \ - --option-group-name ssis-se-2016 \ - --options SSIS \ - --apply-immediately - ``` - - For Windows: - - ``` - aws rds remove-option-from-option-group ^ - --option-group-name ssis-se-2016 ^ - --options SSIS ^ - --apply-immediately - ``` - -## Dropping the SSISDB database - -After removing the SSIS option, the SSISDB database isn't deleted\. To drop the SSISDB database, use the `rds_drop_ssis_database` stored procedure after removing the SSIS option\. - -**To drop the SSIS database** -+ Use the following stored procedure\. - - ``` - USE [msdb] - GO - EXEC dbo.rds_drop_ssis_database - GO - ``` - -After dropping the SSISDB database, if you re\-enable the SSIS option you get a fresh SSISDB catalog\. \ No newline at end of file diff --git a/doc_source/Appendix.SQLServer.Options.SSRS.md b/doc_source/Appendix.SQLServer.Options.SSRS.md deleted file mode 100644 index c937b75..0000000 --- a/doc_source/Appendix.SQLServer.Options.SSRS.md +++ /dev/null @@ -1,600 +0,0 @@ -# Support for SQL Server Reporting Services in Amazon RDS for SQL Server - -Microsoft SQL Server Reporting Services \(SSRS\) is a server\-based application used for report generation and distribution\. It's part of a suite of SQL Server services that also includes SQL Server Analysis Services \(SSAS\) and SQL Server Integration Services \(SSIS\)\. SSRS is a service built on top of SQL Server\. You can use it to collect data from various data sources and present it in a way that's easily understandable and ready for analysis\. - -Amazon RDS for SQL Server supports running SSRS directly on RDS DB instances\. You can use SSRS with existing or new DB instances\. - -RDS supports SSRS for SQL Server Standard and Enterprise Editions on the following versions: -+ SQL Server 2019, version 15\.00\.4043\.16\.v1 and higher -+ SQL Server 2017, version 14\.00\.3223\.3\.v1 and higher -+ SQL Server 2016, version 13\.00\.5820\.21\.v1 and higher - -**Contents** -+ [Limitations and recommendations](#SSRS.Limitations) -+ [Turning on SSRS](#SSRS.Enabling) - + [Creating an option group for SSRS](#SSRS.OptionGroup) - + [Adding the SSRS option to your option group](#SSRS.Add) - + [Associating your option group with your DB instance](#SSRS.Apply) - + [Allowing inbound access to your VPC security group](#SSRS.Inbound) -+ [Report server databases](#SSRS.DBs) -+ [SSRS log files](#SSRS.Logs) -+ [Accessing the SSRS web portal](#SSRS.Access) - + [Using SSL on RDS](#SSRS.Access.SSL) - + [Granting access to domain users](#SSRS.Access.Grant) - + [Accessing the web portal](#SSRS.Access) -+ [Deploying reports to SSRS](#SSRS.Deploy) -+ [Using SSRS Email to send reports](#SSRS.Email) -+ [Revoking system\-level permissions](#SSRS.Access.Revoke) -+ [Monitoring the status of a task](#SSRS.Monitor) -+ [Turning off SSRS](#SSRS.Disable) -+ [Deleting the SSRS databases](#SSRS.Drop) - -## Limitations and recommendations - -The following limitations and recommendations apply to running SSRS on RDS for SQL Server: -+ You can't use SSRS on DB instances that have read replicas\. -+ Instances must use AWS Managed Microsoft AD for SSRS web portal and web server authentication\. -+ You can't back up the reporting server databases that are created with the SSRS option\. -+ Importing and restoring report server databases from other instances of SSRS isn't supported\. - - Make sure to use the databases that are created when the `SSRS` option is added to the RDS DB instance\. For more information, see [Report server databases](#SSRS.DBs)\. -+ You can't configure SSRS to listen on the default SSL port \(443\)\. The allowed values are 1150–49511, except 1234, 1434, 3260, 3343, 3389, and 47001\. -+ Subscriptions through a Microsoft Windows file share aren't supported\. -+ Using Reporting Services Configuration Manager isn't supported\. -+ Creating and modifying roles isn't supported\. -+ Modifying report server properties isn't supported\. -+ System administrator and system user roles aren't granted\. -+ You can't edit system\-level role assignments through the web portal\. - -## Turning on SSRS - -Use the following process to turn on SSRS for your DB instance: - -1. Create a new option group, or choose an existing option group\. - -1. Add the `SSRS` option to the option group\. - -1. Associate the option group with the DB instance\. - -1. Allow inbound access to the virtual private cloud \(VPC\) security group for the SSRS listener port\. - -### Creating an option group for SSRS - -To work with SSRS, create an option group that corresponds to the SQL Server engine and version of the DB instance that you plan to use\. To do this, use the AWS Management Console or the AWS CLI\. - -**Note** -You can also use an existing option group if it's for the correct SQL Server engine and version\. - -#### Console - -The following procedure creates an option group for SQL Server Standard Edition 2017\. - -**To create the option group** - -1. Sign in to the AWS Management Console and open the Amazon RDS console at [https://console\.aws\.amazon\.com/rds/](https://console.aws.amazon.com/rds/)\. - -1. In the navigation pane, choose **Option groups**\. - -1. Choose **Create group**\. - -1. In the **Create option group** pane, do the following: - - 1. For **Name**, enter a name for the option group that is unique within your AWS account, such as **ssrs\-se\-2017**\. The name can contain only letters, digits, and hyphens\. - - 1. For **Description**, enter a brief description of the option group, such as **SSRS option group for SQL Server SE 2017**\. The description is used for display purposes\. - - 1. For **Engine**, choose **sqlserver\-se**\. - - 1. For **Major engine version**, choose **14\.00**\. - -1. Choose **Create**\. - -#### CLI - -The following procedure creates an option group for SQL Server Standard Edition 2017\. - -**To create the option group** -+ Run one of the following commands\. - -**Example** -For Linux, macOS, or Unix: - -``` -aws rds create-option-group \ - --option-group-name ssrs-se-2017 \ - --engine-name sqlserver-se \ - --major-engine-version 14.00 \ - --option-group-description "SSRS option group for SQL Server SE 2017" -``` -For Windows: - -``` -aws rds create-option-group ^ - --option-group-name ssrs-se-2017 ^ - --engine-name sqlserver-se ^ - --major-engine-version 14.00 ^ - --option-group-description "SSRS option group for SQL Server SE 2017" -``` - -### Adding the SSRS option to your option group - -Next, use the AWS Management Console or the AWS CLI to add the `SSRS` option to your option group\. - -#### Console - -**To add the SSRS option** - -1. Sign in to the AWS Management Console and open the Amazon RDS console at [https://console\.aws\.amazon\.com/rds/](https://console.aws.amazon.com/rds/)\. - -1. In the navigation pane, choose **Option groups**\. - -1. Choose the option group that you just created, then choose **Add option**\. - -1. Under **Option details**, choose **SSRS** for **Option name**\. - -1. Under **Option settings**, do the following: - - 1. Enter the port for the SSRS service to listen on\. The default is 8443\. For a list of allowed values, see [Limitations and recommendations](#SSRS.Limitations)\. - - 1. Enter a value for **Max memory**\. - - **Max memory** specifies the upper threshold above which no new memory allocation requests are granted to report server applications\. The number is a percentage of the total memory of the DB instance\. The allowed values are 10–80\. - - 1. For **Security groups**, choose the VPC security group to associate with the option\. Use the same security group that is associated with your DB instance\. - -1. To use SSRS Email to send reports, choose the **Configure email delivery options** check box under **Email delivery in reporting services**, and then do the following: - - 1. For **Sender email address**, enter the email address to use in the **From** field of messages sent by SSRS Email\. - - Specify a user account that has permission to send mail from the SMTP server\. - - 1. For **SMTP server**, specify the SMTP server or gateway to use\. - - It can be an IP address, the NetBIOS name of a computer on your corporate intranet, or a fully qualified domain name\. - - 1. For **SMTP port**, enter the port to use to connect to the mail server\. The default is 25\. - - 1. To use authentication: - - 1. Select the **Use authentication** check box\. - - 1. For **Secret Amazon Resource Name \(ARN\)** enter the AWS Secrets Manager ARN for the user credentials\. - - Use the following format: - - **arn:aws:secretsmanager:*Region*:*AccountId*:secret:*SecretName*\-*6RandomCharacters*** - - For example: - - **arn:aws:secretsmanager:*us\-west\-2*:*123456789012*:secret:*MySecret\-a1b2c3*** - - For more information on creating the secret, see [Using SSRS Email to send reports](#SSRS.Email)\. - - 1. Select the **Use Secure Sockets Layer \(SSL\)** check box to encrypt email messages using SSL\. - -1. Under **Scheduling**, choose whether to add the option immediately or at the next maintenance window\. - -1. Choose **Add option**\. - -#### CLI - -**To add the SSRS option** - -1. Create a JSON file, for example `ssrs-option.json`\. - - 1. Set the following required parameters: - + `OptionGroupName` – The name of option group that you created or chose previously \(`ssrs-se-2017` in the following example\)\. - + `Port` – The port for the SSRS service to listen on\. The default is 8443\. For a list of allowed values, see [Limitations and recommendations](#SSRS.Limitations)\. - + `VpcSecurityGroupMemberships` – VPC security group memberships for your RDS DB instance\. - + `MAX_MEMORY` – The upper threshold above which no new memory allocation requests are granted to report server applications\. The number is a percentage of the total memory of the DB instance\. The allowed values are 10–80\. - - 1. \(Optional\) Set the following parameters to use SSRS Email: - + `SMTP_ENABLE_EMAIL` – Set to `true` to use SSRS Email\. The default is `false`\. - + `SMTP_SENDER_EMAIL_ADDRESS` – The email address to use in the **From** field of messages sent by SSRS Email\. Specify a user account that has permission to send mail from the SMTP server\. - + `SMTP_SERVER` – The SMTP server or gateway to use\. It can be an IP address, the NetBIOS name of a computer on your corporate intranet, or a fully qualified domain name\. - + `SMTP_PORT` – The port to use to connect to the mail server\. The default is 25\. - + `SMTP_USE_SSL` – Set to `true` to encrypt email messages using SSL\. The default is `true`\. - + `SMTP_EMAIL_CREDENTIALS_SECRET_ARN` – The Secrets Manager ARN that holds the user credentials\. Use the following format: - - **arn:aws:secretsmanager:*Region*:*AccountId*:secret:*SecretName*\-*6RandomCharacters*** - - For more information on creating the secret, see [Using SSRS Email to send reports](#SSRS.Email)\. - + `SMTP_USE_ANONYMOUS_AUTHENTICATION` – Set to `true` and don't include `SMTP_EMAIL_CREDENTIALS_SECRET_ARN` if you don't want to use authentication\. - - The default is `false` when `SMTP_ENABLE_EMAIL` is `true`\. - - The following example includes the SSRS Email parameters, using the secret ARN\. - - ``` - { - "OptionGroupName": "ssrs-se-2017", - "OptionsToInclude": [ - { - "OptionName": "SSRS", - "Port": 8443, - "VpcSecurityGroupMemberships": ["sg-0abcdef123"], - "OptionSettings": [ - {"Name": "MAX_MEMORY","Value": "60"}, - {"Name": "SMTP_ENABLE_EMAIL","Value": "true"} - {"Name": "SMTP_SENDER_EMAIL_ADDRESS","Value": "nobody@example.com"}, - {"Name": "SMTP_SERVER","Value": "email-smtp.us-west-2.amazonaws.com"}, - {"Name": "SMTP_PORT","Value": "25"}, - {"Name": "SMTP_USE_SSL","Value": "true"}, - {"Name": "SMTP_EMAIL_CREDENTIALS_SECRET_ARN","Value": "arn:aws:secretsmanager:us-west-2:123456789012:secret:MySecret-a1b2c3"} - ] - }], - "ApplyImmediately": true - } - ``` - -1. Add the `SSRS` option to the option group\. -**Example** - - For Linux, macOS, or Unix: - - ``` - aws rds add-option-to-option-group \ - --cli-input-json file://ssrs-option.json \ - --apply-immediately - ``` - - For Windows: - - ``` - aws rds add-option-to-option-group ^ - --cli-input-json file://ssrs-option.json ^ - --apply-immediately - ``` - -### Associating your option group with your DB instance - -Use the AWS Management Console or the AWS CLI to associate your option group with your DB instance\. - -If you use an existing DB instance, it must already have an Active Directory domain and AWS Identity and Access Management \(IAM\) role associated with it\. If you create a new instance, specify an existing Active Directory domain and IAM role\. For more information, see [Using Windows Authentication with an Amazon RDS for SQL Server DB instance](USER_SQLServerWinAuth.md)\. - -#### Console - -You can associate your option group with a new or existing DB instance: -+ For a new DB instance, associate the option group when you launch the instance\. For more information, see [Creating an Amazon RDS DB instance](USER_CreateDBInstance.md)\. -+ For an existing DB instance, modify the instance and associate the new option group\. For more information, see [Modifying an Amazon RDS DB instance](Overview.DBInstance.Modifying.md)\. - -#### CLI - -You can associate your option group with a new or existing DB instance\. - -**To create a DB instance that uses your option group** -+ Specify the same DB engine type and major version as you used when creating the option group\. -**Example** - - For Linux, macOS, or Unix: - - ``` - aws rds create-db-instance \ - --db-instance-identifier myssrsinstance \ - --db-instance-class db.m5.2xlarge \ - --engine sqlserver-se \ - --engine-version 14.00.3223.3.v1 \ - --allocated-storage 100 \ - --master-user-password secret123 \ - --master-username admin \ - --storage-type gp2 \ - --license-model li \ - --domain-iam-role-name my-directory-iam-role \ - --domain my-domain-id \ - --option-group-name ssrs-se-2017 - ``` - - For Windows: - - ``` - aws rds create-db-instance ^ - --db-instance-identifier myssrsinstance ^ - --db-instance-class db.m5.2xlarge ^ - --engine sqlserver-se ^ - --engine-version 14.00.3223.3.v1 ^ - --allocated-storage 100 ^ - --master-user-password secret123 ^ - --master-username admin ^ - --storage-type gp2 ^ - --license-model li ^ - --domain-iam-role-name my-directory-iam-role ^ - --domain my-domain-id ^ - --option-group-name ssrs-se-2017 - ``` - -**To modify a DB instance to use your option group** -+ Run one of the following commands\. -**Example** - - For Linux, macOS, or Unix: - - ``` - aws rds modify-db-instance \ - --db-instance-identifier myssrsinstance \ - --option-group-name ssrs-se-2017 \ - --apply-immediately - ``` - - For Windows: - - ``` - aws rds modify-db-instance ^ - --db-instance-identifier myssrsinstance ^ - --option-group-name ssrs-se-2017 ^ - --apply-immediately - ``` - -### Allowing inbound access to your VPC security group - -To allow inbound access to the VPC security group associated with your DB instance, create an inbound rule for the specified SSRS listener port\. For more information about setting up security groups, see [Provide access to your DB instance in your VPC by creating a security group](CHAP_SettingUp.md#CHAP_SettingUp.SecurityGroup)\. - -## Report server databases - -When your DB instance is associated with the SSRS option, two new databases are created on your DB instance: rdsadmin\_ReportServer and rdsadmin\_ReportServerTempDB\. These databases act as the ReportServer and ReportServerTempDB databases\. SSRS stores its data in the ReportServer database and caches its data in the ReportServerTempDB database\. - -RDS owns and manages these databases, so database operations on them such as ALTER and DROP aren't permitted\. However, you can perform read operations on the rdsadmin\_ReportServer database\. - -## SSRS log files - -You can access ReportServerService\_*timestamp*\.log files\. These report server logs can be found in the `D:\rdsdbdata\Log\SSRS` directory\. \(The `D:\rdsdbdata\Log` directory is also the parent directory for error logs and SQL Server Agent logs\.\) - -For existing SSRS instances, restarting the SSRS service might be necessary to access report server logs\. You can restart the service by updating the `SSRS` option\. - -For more information, see [Working with Microsoft SQL Server logs](Appendix.SQLServer.CommonDBATasks.Logs.md)\. - -## Accessing the SSRS web portal - -Use the following process to access the SSRS web portal: - -1. Turn on Secure Sockets Layer \(SSL\)\. - -1. Grant access to domain users\. - -1. Access the web portal using a browser and the domain user credentials\. - -### Using SSL on RDS - -SSRS uses the HTTPS SSL protocol for its connections\. To work with this protocol, import an SSL certificate into the Microsoft Windows operating system on your client computer\. - -For more information on SSL certificates, see [Using SSL/TLS to encrypt a connection to a DB instance](UsingWithRDS.SSL.md)\. For more information about using SSL with SQL Server, see [Using SSL with a Microsoft SQL Server DB instance](SQLServer.Concepts.General.SSL.Using.md)\. - -### Granting access to domain users - -In a new SSRS activation, there are no role assignments in SSRS\. To give a domain user or user group access to the web portal, RDS provides a stored procedure\. - -**To grant access to a domain user on the web portal** -+ Use the following stored procedure\. - - ``` - exec msdb.dbo.rds_msbi_task - @task_type='SSRS_GRANT_PORTAL_PERMISSION', - @ssrs_group_or_username=N'AD_domain\user'; - ``` - -The domain user or user group is granted the `RDS_SSRS_ROLE` system role\. This role has the following system\-level tasks granted to it: -+ Run reports -+ Manage jobs -+ Manage shared schedules -+ View shared schedules - -The item\-level role of `Content Manager` on the root folder is also granted\. - -### Accessing the web portal - -After the `SSRS_GRANT_PORTAL_PERMISSION` task finishes successfully, you have access to the portal using a web browser\. The web portal URL has the following format\. - -``` -https://rds_endpoint:port/Reports -``` - -In this format, the following applies: -+ *`rds_endpoint`* – The endpoint for the RDS DB instance that you're using with SSRS\. - - You can find the endpoint on the **Connectivity & security** tab for your DB instance\. For more information, see [Connecting to a DB instance running the Microsoft SQL Server database engine](USER_ConnectToMicrosoftSQLServerInstance.md)\. -+ `port` – The listener port for SSRS that you set in the `SSRS` option\. - -**To access the web portal** - -1. Enter the web portal URL in your browser\. - - ``` - https://myssrsinstance.cg034itsfake.us-east-1.rds.amazonaws.com:8443/Reports - ``` - -1. Log in with the credentials for a domain user that you granted access with the `SSRS_GRANT_PORTAL_PERMISSION` task\. - -## Deploying reports to SSRS - -After you have access to the web portal, you can deploy reports to it\. You can use the Upload tool in the web portal to upload reports, or deploy directly from [SQL Server data tools \(SSDT\)](https://docs.microsoft.com/en-us/sql/ssdt/download-sql-server-data-tools-ssdt)\. When deploying from SSDT, ensure the following: -+ The user who launched SSDT has access to the SSRS web portal\. -+ The `TargetServerURL` value in the SSRS project properties is set to the HTTPS endpoint of the RDS DB instance suffixed with `ReportServer`, for example: - - ``` - https://myssrsinstance.cg034itsfake.us-east-1.rds.amazonaws.com:8443/ReportServer - ``` - -## Using SSRS Email to send reports - -SSRS includes the SSRS Email extension, which you can use to send reports to users\. - -To configure SSRS Email, use the `SSRS` option settings\. For more information, see [Adding the SSRS option to your option group](#SSRS.Add)\. - -After configuring SSRS Email, you can subscribe to reports on the report server\. For more information, see [Email delivery in Reporting Services](https://docs.microsoft.com/en-us/sql/reporting-services/subscriptions/e-mail-delivery-in-reporting-services) in the Microsoft documentation\. - -Integration with AWS Secrets Manager is required for SSRS Email to function on RDS\. To integrate with Secrets Manager, you create a secret\. - -**Note** -If you change the secret later, you also have to update the `SSRS` option in the option group\. - -**To create a secret for SSRS Email** - -1. Follow the steps in [Create a secret](https://docs.aws.amazon.com/secretsmanager/latest/userguide/create_secret.html) in the *AWS Secrets Manager User Guide*\. - - 1. For **Select secret type**, choose **Other type of secrets**\. - - 1. For **Key/value pairs**, enter the following: - + **SMTP\_USERNAME** – Enter a user with permission to send mail from the SMTP server\. - + **SMTP\_PASSWORD** – Enter a password for the SMTP user\. - - 1. For **Encryption key**, don't use the default AWS KMS key\. Use your own existing key, or create a new one\. - - The KMS key policy must allow the `kms:Decrypt` action, for example: - - ``` - { - "Sid": "Allow use of the key", - "Effect": "Allow", - "Principal": { - "Service": [ - "rds.amazonaws.com" - ] - }, - "Action": [ - "kms:Decrypt" - ], - "Resource": "*" - } - ``` - -1. Follow the steps in [Attach a permissions policy to a secret](https://docs.aws.amazon.com/secretsmanager/latest/userguide/auth-and-access_resource-policies.html) in the *AWS Secrets Manager User Guide*\. The permissions policy gives the `secretsmanager:GetSecretValue` action to the `rds.amazonaws.com` service principal\. - - We recommend that you use the `aws:sourceAccount` and `aws:sourceArn` conditions in the policy to avoid the *confused deputy* problem\. Use your AWS account for `aws:sourceAccount` and the option group ARN for `aws:sourceArn`\. For more information, see [Preventing cross\-service confused deputy problems](cross-service-confused-deputy-prevention.md)\. - - The following example shows a permissions policy\. - - ``` - { - "Version" : "2012-10-17", - "Statement" : [ { - "Effect" : "Allow", - "Principal" : { - "Service" : "rds.amazonaws.com" - }, - "Action" : "secretsmanager:GetSecretValue", - "Resource" : "*", - "Condition" : { - "StringEquals" : { - "aws:sourceAccount" : "123456789012" - }, - "ArnLike" : { - "aws:sourceArn" : "arn:aws:rds:us-west-2:123456789012:og:ssrs-se-2017" - } - } - } ] - } - ``` - - For more examples, see [Permissions policy examples for AWS Secrets Manager](https://docs.aws.amazon.com/secretsmanager/latest/userguide/auth-and-access_examples.html) in the *AWS Secrets Manager User Guide*\. - -## Revoking system\-level permissions - -The `RDS_SSRS_ROLE` system role doesn't have sufficient permissions to delete system\-level role assignments\. To remove a user or user group from `RDS_SSRS_ROLE`, use the same stored procedure that you used to grant the role but use the `SSRS_REVOKE_PORTAL_PERMISSION` task type\. - -**To revoke access from a domain user for the web portal** -+ Use the following stored procedure\. - - ``` - exec msdb.dbo.rds_msbi_task - @task_type='SSRS_REVOKE_PORTAL_PERMISSION', - @ssrs_group_or_username=N'AD_domain\user'; - ``` - -Doing this deletes the user from the `RDS_SSRS_ROLE` system role\. It also deletes the user from the `Content Manager` item\-level role if the user has it\. - -## Monitoring the status of a task - -To track the status of your granting or revoking task, call the `rds_fn_task_status` function\. It takes two parameters\. The first parameter should always be `NULL` because it doesn't apply to SSRS\. The second parameter accepts a task ID\. - -To see a list of all tasks, set the first parameter to `NULL` and the second parameter to `0`, as shown in the following example\. - -``` -SELECT * FROM msdb.dbo.rds_fn_task_status(NULL,0); -``` - -To get a specific task, set the first parameter to `NULL` and the second parameter to the task ID, as shown in the following example\. - -``` -SELECT * FROM msdb.dbo.rds_fn_task_status(NULL,42); -``` - -The `rds_fn_task_status` function returns the following information\. - - -| Output parameter | Description | -| --- | --- | -| `task_id` | The ID of the task\. | -| `task_type` | For SSRS, tasks can have the following task types: [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Appendix.SQLServer.Options.SSRS.html) | -| `database_name` | Not applicable to SSRS tasks\. | -| `% complete` | The progress of the task as a percentage\. | -| `duration (mins)` | The amount of time spent on the task, in minutes\. | -| `lifecycle` | The status of the task\. Possible statuses are the following: [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Appendix.SQLServer.Options.SSRS.html) | -| `task_info` | Additional information about the task\. If an error occurs during processing, this column contains information about the error\. | -| `last_updated` | The date and time that the task status was last updated\. | -| `created_at` | The date and time that the task was created\. | -| `S3_object_arn` | Not applicable to SSRS tasks\. | -| `overwrite_S3_backup_file` | Not applicable to SSRS tasks\. | -| `KMS_master_key_arn` | Not applicable to SSRS tasks\. | -| `filepath` | Not applicable to SSRS tasks\. | -| `overwrite_file` | Not applicable to SSRS tasks\. | -| `task_metadata` | Metadata associated with the SSRS task\. | - -## Turning off SSRS - -To turn off SSRS, remove the `SSRS` option from its option group\. Removing the option doesn't delete the SSRS databases\. For more information, see [Deleting the SSRS databases](#SSRS.Drop)\. - -You can turn SSRS on again by adding back the `SSRS` option\. If you have also deleted the SSRS databases, readding the option on the same DB instance creates new report server databases\. - -### Console - -**To remove the SSRS option from its option group** - -1. Sign in to the AWS Management Console and open the Amazon RDS console at [https://console\.aws\.amazon\.com/rds/](https://console.aws.amazon.com/rds/)\. - -1. In the navigation pane, choose **Option groups**\. - -1. Choose the option group with the `SSRS` option \(`ssrs-se-2017` in the previous examples\)\. - -1. Choose **Delete option**\. - -1. Under **Deletion options**, choose **SSRS** for **Options to delete**\. - -1. Under **Apply immediately**, choose **Yes** to delete the option immediately, or **No** to delete it at the next maintenance window\. - -1. Choose **Delete**\. - -### CLI - -**To remove the SSRS option from its option group** -+ Run one of the following commands\. -**Example** - - For Linux, macOS, or Unix: - - ``` - aws rds remove-option-from-option-group \ - --option-group-name ssrs-se-2017 \ - --options SSRS \ - --apply-immediately - ``` - - For Windows: - - ``` - aws rds remove-option-from-option-group ^ - --option-group-name ssrs-se-2017 ^ - --options SSRS ^ - --apply-immediately - ``` - -## Deleting the SSRS databases - -Removing the `SSRS` option doesn't delete the report server databases\. To delete them, use the following stored procedure\. - -To delete the report server databases, be sure to remove the `SSRS` option first\. - -**To delete the SSRS databases** -+ Use the following stored procedure\. - - ``` - exec msdb.dbo.rds_drop_ssrs_databases - ``` \ No newline at end of file diff --git a/doc_source/Appendix.SQLServer.Options.TDE.Perf.md b/doc_source/Appendix.SQLServer.Options.TDE.Perf.md deleted file mode 100644 index c368b3e..0000000 --- a/doc_source/Appendix.SQLServer.Options.TDE.Perf.md +++ /dev/null @@ -1,7 +0,0 @@ -# SQL Server performance considerations - -The performance of a SQL Server DB instance can be impacted by using Transparent Data Encryption\. - -Performance for unencrypted databases can also be degraded if the databases are on a DB instance that has at least one encrypted database\. As a result, we recommend that you keep encrypted and unencrypted databases on separate DB instances\. - -Because of the nature of encryption, the database size and the size of the transaction log is larger than for an unencrypted database\. You could run over your allocation of free backup space\. The nature of TDE causes an unavoidable performance hit\. If you need high performance and TDE, measure the impact and make sure that it meets your needs\. There is less of an impact on performance if you use Provisioned IOPS and at least an M3\.Large DB instance class\. \ No newline at end of file diff --git a/doc_source/Appendix.SQLServer.Options.TDE.md b/doc_source/Appendix.SQLServer.Options.TDE.md deleted file mode 100644 index 861b303..0000000 --- a/doc_source/Appendix.SQLServer.Options.TDE.md +++ /dev/null @@ -1,371 +0,0 @@ -# Support for Transparent Data Encryption in SQL Server - -Amazon RDS supports using Transparent Data Encryption \(TDE\) to encrypt stored data on your DB instances running Microsoft SQL Server\. TDE automatically encrypts data before it is written to storage, and automatically decrypts data when the data is read from storage\. - -Amazon RDS supports TDE for the following SQL Server versions and editions: -+ SQL Server 2019 Standard and Enterprise Editions -+ SQL Server 2017 Enterprise Edition -+ SQL Server 2016 Enterprise Edition -+ SQL Server 2014 Enterprise Edition - -Transparent Data Encryption for SQL Server provides encryption key management by using a two\-tier key architecture\. A certificate, which is generated from the database master key, is used to protect the data encryption keys\. The database encryption key performs the actual encryption and decryption of data on the user database\. Amazon RDS backs up and manages the database master key and the TDE certificate\. - -Transparent Data Encryption is used in scenarios where you need to encrypt sensitive data\. For example, you might want to provide data files and backups to a third party, or address security\-related regulatory compliance issues\. You can't encrypt the system databases for SQL Server, such as the `model` or `master` databases\. - -A detailed discussion of Transparent Data Encryption is beyond the scope of this guide, but make sure that you understand the security strengths and weaknesses of each encryption algorithm and key\. For information about Transparent Data Encryption for SQL Server, see [Transparent Data Encryption \(TDE\)](http://msdn.microsoft.com/en-us/library/bb934049.aspx) in the Microsoft documentation\. - -**Topics** -+ [Turning on TDE for RDS for SQL Server](#TDE.Enabling) -+ [Encrypting data on RDS for SQL Server](#TDE.Encrypting) -+ [Backing up and restoring TDE certificates on RDS for SQL Server](#TDE.BackupRestoreRDS) -+ [Backing up and restoring TDE certificates for on\-premises databases](#TDE.BackupRestoreOnPrem) -+ [Turning off TDE for RDS for SQL Server](#TDE.Disabling) - -## Turning on TDE for RDS for SQL Server - -To turn on Transparent Data Encryption for an RDS for SQL Server DB instance, specify the TDE option in an RDS option group that's associated with that DB instance: - -1. Determine whether your DB instance is already associated with an option group that has the TDE option\. To view the option group that a DB instance is associated with, use the RDS console, the [describe\-db\-instance](https://docs.aws.amazon.com/cli/latest/reference/rds/describe-db-instances.html) AWS CLI command, or the API operation [DescribeDBInstances](https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_DescribeDBInstances.html)\. - -1. If the DB instance isn't associated with an option group that has TDE turned on, you have two choices\. You can create an option group and add the TDE option, or you can modify the associated option group to add it\. -**Note** -In the RDS console, the option is named `TRANSPARENT_DATA_ENCRYPTION`\. In the AWS CLI and RDS API, it's named `TDE`\. - - For information about creating or modifying an option group, see [Working with option groups](USER_WorkingWithOptionGroups.md)\. For information about adding an option to an option group, see [Adding an option to an option group](USER_WorkingWithOptionGroups.md#USER_WorkingWithOptionGroups.AddOption)\. - -1. Associate the DB instance with the option group that has the TDE option\. For information about associating a DB instance with an option group, see [Modifying an Amazon RDS DB instance](Overview.DBInstance.Modifying.md)\. - -### Option group considerations - -The TDE option is a persistent option\. You can't remove it from an option group unless all DB instances and backups are no longer associated with the option group\. After you add the TDE option to an option group, the option group can be associated only with DB instances that use TDE\. For more information about persistent options in an option group, see [Option groups overview](USER_WorkingWithOptionGroups.md#Overview.OptionGroups)\. - -Because the TDE option is a persistent option, you can have a conflict between the option group and an associated DB instance\. You can have a conflict in the following situations: -+ The current option group has the TDE option, and you replace it with an option group that doesn't have the TDE option\. -+ You restore from a DB snapshot to a new DB instance that doesn't have an option group that contains the TDE option\. For more information about this scenario, see [Option group considerations](USER_CopySnapshot.md#USER_CopySnapshot.Options)\. - -### SQL Server performance considerations - -Using Transparent Data Encryption can affect the performance of a SQL Server DB instance\. - -Performance for unencrypted databases can also be degraded if the databases are on a DB instance that has at least one encrypted database\. As a result, we recommend that you keep encrypted and unencrypted databases on separate DB instances\. - -## Encrypting data on RDS for SQL Server - -When the TDE option is added to an option group, Amazon RDS generates a certificate that's used in the encryption process\. You can then use the certificate to run SQL statements that encrypt data in a database on the DB instance\. - -The following example uses the RDS\-created certificate called `RDSTDECertificateName` to encrypt a database called `myDatabase`\. - -``` - 1. ---------- Turning on TDE ------------- - 2. - 3. -- Find an RDS TDE certificate to use - 4. USE [master] - 5. GO - 6. SELECT name FROM sys.certificates WHERE name LIKE 'RDSTDECertificate%' - 7. GO - 8. - 9. USE [myDatabase] -10. GO -11. -- Create a database encryption key (DEK) using one of the certificates from the previous step -12. CREATE DATABASE ENCRYPTION KEY WITH ALGORITHM = AES_256 -13. ENCRYPTION BY SERVER CERTIFICATE [RDSTDECertificateName] -14. GO -15. -16. -- Turn on encryption for the database -17. ALTER DATABASE [myDatabase] SET ENCRYPTION ON -18. GO -19. -20. -- Verify that the database is encrypted -21. USE [master] -22. GO -23. SELECT name FROM sys.databases WHERE is_encrypted = 1 -24. GO -25. SELECT db_name(database_id) as DatabaseName, * FROM sys.dm_database_encryption_keys -26. GO -``` - -The time that it takes to encrypt a SQL Server database using TDE depends on several factors\. These include the size of the DB instance, whether the instance uses Provisioned IOPS storage, the amount of data, and other factors\. - -## Backing up and restoring TDE certificates on RDS for SQL Server - -RDS for SQL Server provides stored procedures for backing up, restoring, and dropping TDE certificates\. RDS for SQL Server also provides a function for viewing restored user TDE certificates\. - -User TDE certificates are used to restore databases to RDS for SQL Server that are on\-premises and have TDE turned on\. These certificates have the prefix `UserTDECertificate_`\. After restoring databases, and before making them available to use, RDS modifies the databases that have TDE turned on to use RDS\-generated TDE certificates\. These certificates have the prefix `RDSTDECertificate`\. - -User TDE certificates remain on the RDS for SQL Server DB instance, unless you drop them using the `rds_drop_tde_certificate` stored procedure\. For more information, see [Dropping restored TDE certificates](#TDE.BackupRestoreRDS.Drop)\. - -You can use a user TDE certificate to restore other databases from the source DB instance\. The databases to restore must use the same TDE certificate and have TDE turned on\. You don't have to import \(restore\) the same certificate again\. - -**Topics** -+ [Prerequisites](#TDE.BackupRestoreRDS.Prereqs) -+ [Limitations](#TDE.Limitations) -+ [Backing up a TDE certificate](#TDE.BackupRestoreRDS.Backup) -+ [Restoring a TDE certificate](#TDE.BackupRestoreRDS.Restore) -+ [Viewing restored TDE certificates](#TDE.BackupRestoreRDS.Show) -+ [Dropping restored TDE certificates](#TDE.BackupRestoreRDS.Drop) - -### Prerequisites - -Before you can back up or restore TDE certificates on RDS for SQL Server, make sure to perform the following tasks\. The first three are described in [Setting up for native backup and restore](SQLServer.Procedural.Importing.md#SQLServer.Procedural.Importing.Native.Enabling)\. - -1. Create Amazon S3 buckets for storing files to back up and restore\. - - We recommend that you use separate buckets for database backups and for TDE certificate backups\. - -1. Create an IAM role for backing up and restoring files\. - - The IAM role must be both a user and an administrator for the AWS KMS key\. - - In addition to the permissions required for SQL Server native backup and restore, the IAM role also requires the following permissions: - + `s3:GetBucketACL`, `s3:GetBucketLocation`, and `s3:ListBucket` on the S3 bucket resource - + `s3:ListAllMyBuckets` on the `*` resource - -1. Add the `SQLSERVER_BACKUP_RESTORE` option to an option group on your DB instance\. - - This is in addition to the `TRANSPARENT_DATA_ENCRYPTION` \(`TDE`\) option\. - -1. Make sure that you have a symmetric encryption KMS key\. You have the following options: - + If you have an existing KMS key in your account, you can use it\. No further action is necessary\. - + If you don't have an existing symmetric encryption KMS key in your account, create a KMS key by following the instructions in [Creating keys](https://docs.aws.amazon.com/kms/latest/developerguide/create-keys.html#create-symmetric-cmk) in the *AWS Key Management Service Developer Guide*\. - -1. Enable Amazon S3 integration to transfer files between the DB instance and Amazon S3\. - - For more information on enabling Amazon S3 integration, see [Integrating an Amazon RDS for SQL Server DB instance with Amazon S3](User.SQLServer.Options.S3-integration.md)\. - -### Limitations - -Using stored procedures to back up and restore TDE certificates has the following limitations: -+ Both the `SQLSERVER_BACKUP_RESTORE` and `TRANSPARENT_DATA_ENCRYPTION` \(`TDE`\) options must be added to the option group that you associated with your DB instance\. -+ TDE certificate backup and restore aren't supported on Multi\-AZ DB instances\. -+ Canceling TDE certificate backup and restore tasks isn't supported\. -+ You can't use a user TDE certificate for TDE encryption of any other database on your RDS for SQL Server DB instance\. You can use it to restore only other databases from the source DB instance that have TDE turned on and that use the same TDE certificate\. -+ You can drop only user TDE certificates\. -+ The maximum number of user TDE certificates supported on RDS is 10\. If the number exceeds 10, drop unused TDE certificates and try again\. -+ The certificate name can't be empty or null\. -+ When restoring a certificate, the certificate name can't include the keyword `RDSTDECERTIFICATE`, and must start with the `UserTDECertificate_` prefix\. -+ The `@certificate_name` parameter can include only the following characters: a\-z, 0\-9, @, $, \#, and underscore \(\_\)\. -+ The file extension for `@certificate_file_s3_arn` must be \.cer \(case\-insensitive\)\. -+ The file extension for `@private_key_file_s3_arn` must be \.pvk \(case\-insensitive\)\. -+ The S3 metadata for the private key file must include the `x-amz-meta-rds-tde-pwd` tag\. For more information, see [Backing up and restoring TDE certificates for on\-premises databases](#TDE.BackupRestoreOnPrem)\. - -### Backing up a TDE certificate - -To back up TDE certificates, use the `rds_backup_tde_certificate` stored procedure\. It has the following syntax\. - -``` -EXECUTE msdb.dbo.rds_backup_tde_certificate - @certificate_name='UserTDECertificate_certificate_name | RDSTDECertificatetimestamp', - @certificate_file_s3_arn='arn:aws:s3:::bucket_name/certificate_file_name.cer', - @private_key_file_s3_arn='arn:aws:s3:::bucket_name/key_file_name.pvk', - @kms_password_key_arn='arn:aws:kms:region:account-id:key/key-id', - [@overwrite_s3_files=0|1]; -``` - -The following parameters are required: -+ `@certificate_name` – The name of the TDE certificate to back up\. -+ `@certificate_file_s3_arn` – The destination Amazon Resource Name \(ARN\) for the certificate backup file in Amazon S3\. -+ `@private_key_file_s3_arn` – The destination S3 ARN of the private key file that secures the TDE certificate\. -+ `@kms_password_key_arn` – The ARN of the symmetric KMS key used to encrypt the private key password\. - -The following parameter is optional: -+ `@overwrite_s3_files` – Indicates whether to overwrite the existing certificate and private key files in S3: - + `0` – Doesn't overwrite the existing files\. This value is the default\. - - Setting `@overwrite_s3_files` to 0 returns an error if a file already exists\. - + `1` – Overwrites an existing file that has the specified name, even if it isn't a backup file\. - -**Example of backing up a TDE certificate** - -``` -EXECUTE msdb.dbo.rds_backup_tde_certificate - @certificate_name='RDSTDECertificate20211115T185333', - @certificate_file_s3_arn='arn:aws:s3:::TDE_certs/mycertfile.cer', - @private_key_file_s3_arn='arn:aws:s3:::TDE_certs/mykeyfile.pvk', - @kms_password_key_arn='arn:aws:kms:us-west-2:123456789012:key/AKIAIOSFODNN7EXAMPLE', - @overwrite_s3_files=1; -``` - -### Restoring a TDE certificate - -You use the `rds_restore_tde_certificate` stored procedure to restore \(import\) user TDE certificates\. It has the following syntax\. - -``` -EXECUTE msdb.dbo.rds_restore_tde_certificate - @certificate_name='UserTDECertificate_certificate_name', - @certificate_file_s3_arn='arn:aws:s3:::bucket_name/certificate_file_name.cer', - @private_key_file_s3_arn='arn:aws:s3:::bucket_name/key_file_name.pvk', - @kms_password_key_arn='arn:aws:kms:region:account-id:key/key-id'; -``` - -The following parameters are required: -+ `@certificate_name` – The name of the TDE certificate to restore\. The name must start with the `UserTDECertificate_` prefix\. -+ `@certificate_file_s3_arn` – The S3 ARN of the backup file used to restore the TDE certificate\. -+ `@private_key_file_s3_arn` – The S3 ARN of the private key backup file of the TDE certificate to be restored\. -+ `@kms_password_key_arn` – The ARN of the symmetric KMS key used to encrypt the private key password\. - -**Example of restoring a TDE certificate** - -``` -EXECUTE msdb.dbo.rds_restore_tde_certificate - @certificate_name='UserTDECertificate_myTDEcertificate', - @certificate_file_s3_arn='arn:aws:s3:::TDE_certs/mycertfile.cer', - @private_key_file_s3_arn='arn:aws:s3:::TDE_certs/mykeyfile.pvk', - @kms_password_key_arn='arn:aws:kms:us-west-2:123456789012:key/AKIAIOSFODNN7EXAMPLE'; -``` - -### Viewing restored TDE certificates - -You use the `rds_fn_list_user_tde_certificates` function to view restored \(imported\) user TDE certificates\. It has the following syntax\. - -``` -SELECT * FROM msdb.dbo.rds_fn_list_user_tde_certificates(); -``` - -The output resembles the following\. Not all columns are shown here\. - - -| | | | | | | | | | | | -| --- |--- |--- |--- |--- |--- |--- |--- |--- |--- |--- | -| name | certificate\_id | principal\_id | pvt\_key\_encryption\_type\_desc | issuer\_name | cert\_serial\_number | thumbprint | subject | start\_date | expiry\_date | pvt\_key\_last\_backup\_date | -| UserTDECertificate\_tde\_cert | 343 | 1 | ENCRYPTED\_BY\_MASTER\_KEY | AnyCompany Shipping | 79 3e 57 a3 69 fd 1d 9e 47 2c 32 67 1d 9c ca af | 0x6BB218B34110388680B FE1BA2D86C695096485B5 | AnyCompany Shipping | 2022\-04\-05 19:49:45\.0000000 | 2023\-04\-05 19:49:45\.0000000 | NULL | - -### Dropping restored TDE certificates - -To drop restored \(imported\) user TDE certificates that you aren't using, use the `rds_drop_tde_certificate` stored procedure\. It has the following syntax\. - -``` -EXECUTE msdb.dbo.rds_drop_tde_certificate @certificate_name='UserTDECertificate_certificate_name'; -``` - -The following parameter is required: -+ `@certificate_name` – The name of the TDE certificate to drop\. - -You can drop only restored \(imported\) TDE certificates\. You can't drop RDS\-created certificates\. - -**Example of dropping a TDE certificate** - -``` -EXECUTE msdb.dbo.rds_drop_tde_certificate @certificate_name='UserTDECertificate_myTDEcertificate'; -``` - -## Backing up and restoring TDE certificates for on\-premises databases - -You can back up TDE certificates for on\-premises databases, then later restore them to RDS for SQL Server\. You can also restore an RDS for SQL Server TDE certificate to an on\-premises DB instance\. - -The following procedure backs up a TDE certificate and private key\. The private key is encrypted using a data key generated from your symmetric encryption KMS key\. - -**To back up an on\-premises TDE certificate** - -1. Generate the data key using the AWS CLI [generate\-data\-key](https://docs.aws.amazon.com/cli/latest/reference/kms/generate-data-key.html) command\. - - ``` - aws kms generate-data-key \ - --key-id my_KMS_key_ID \ - --key-spec AES_256 - ``` - - The output resembles the following\. - - ``` - { - "CiphertextBlob": "AQIDAHimL2NEoAlOY6Bn7LJfnxi/OZe9kTQo/XQXduug1rmerwGiL7g5ux4av9GfZLxYTDATAAAAfjB8BgkqhkiG9w0B - BwagbzBtAgEAMGgGCSqGSIb3DQEHATAeBglghkgBZQMEAS4wEQQMyCxLMi7GRZgKqD65AgEQgDtjvZLJo2cQ31Vetngzm2ybHDc3d2vI74SRUzZ - 2RezQy3sAS6ZHrCjfnfn0c65bFdhsXxjSMnudIY7AKw==", - "Plaintext": "U/fpGtmzGCYBi8A2+0/9qcRQRK2zmG/aOn939ZnKi/0=", - "KeyId": "arn:aws:kms:us-west-2:123456789012:key/1234abcd-00ee-99ff-88dd-aa11bb22cc33" - } - ``` - - You use the plain text output in the next step as the private key password\. - -1. Back up your TDE certificate as shown in the following example\. - - ``` - BACKUP CERTIFICATE myOnPremTDEcertificate TO FILE = 'D:\tde-cert-backup.cer' - WITH PRIVATE KEY ( - FILE = 'C:\Program Files\Microsoft SQL Server\MSSQL14.MSSQLSERVER\MSSQL\DATA\cert-backup-key.pvk', - ENCRYPTION BY PASSWORD = 'U/fpGtmzGCYBi8A2+0/9qcRQRK2zmG/aOn939ZnKi/0='); - ``` - -1. Save the certificate backup file to your Amazon S3 certificate bucket\. - -1. Save the private key backup file to your S3 certificate bucket, with the following tag in the file's metadata: - + Key – `x-amz-meta-rds-tde-pwd` - + Value – The `CiphertextBlob` value from generating the data key, as in the following example\. - - ``` - AQIDAHimL2NEoAlOY6Bn7LJfnxi/OZe9kTQo/XQXduug1rmerwGiL7g5ux4av9GfZLxYTDATAAAAfjB8BgkqhkiG9w0B - BwagbzBtAgEAMGgGCSqGSIb3DQEHATAeBglghkgBZQMEAS4wEQQMyCxLMi7GRZgKqD65AgEQgDtjvZLJo2cQ31Vetngzm2ybHDc3d2vI74SRUzZ - 2RezQy3sAS6ZHrCjfnfn0c65bFdhsXxjSMnudIY7AKw== - ``` - -The following procedure restores an RDS for SQL Server TDE certificate to an on\-premises DB instance\. You copy and restore the TDE certificate on your destination DB instance using the certificate backup, corresponding private key file, and data key\. The restored certificate is encrypted by the database master key of the new server\. - -**To restore a TDE certificate** - -1. Copy the TDE certificate backup file and private key file from Amazon S3 to the destination instance\. For more information on copying files from Amazon S3, see [Transferring files between RDS for SQL Server and Amazon S3](User.SQLServer.Options.S3-integration.md#Appendix.SQLServer.Options.S3-integration.using)\. - -1. Use your KMS key to decrypt the output cipher text to retrieve the plain text of the data key\. The cipher text is located in the S3 metadata of the private key backup file\. - - ``` - aws kms decrypt \ - --key-id my_KMS_key_ID \ - --ciphertext-blob fileb://exampleCiphertextFile | base64 -d \ - --output text \ - --query Plaintext - ``` - - You use the plain text output in the next step as the private key password\. - -1. Use the following SQL command to restore your TDE certificate\. - - ``` - CREATE CERTIFICATE myOnPremTDEcertificate FROM FILE='D:\tde-cert-backup.cer' - WITH PRIVATE KEY (FILE = N'D:\tde-cert-key.pvk', - DECRYPTION BY PASSWORD = 'plain_text_output'); - ``` - -For more information on KMS decryption, see [decrypt](https://docs.aws.amazon.com/cli/latest/reference/kms/decrypt.html) in the KMS section of the *AWS CLI Command Reference*\. - -After the TDE certificate is restored on the destination DB instance, you can restore encrypted databases with that certificate\. - -**Note** -You can use the same TDE certificate to encrypt multiple SQL Server databases on the source DB instance\. To migrate multiple databases to a destination instance, copy the TDE certificate associated with them to the destination instance only once\. - -## Turning off TDE for RDS for SQL Server - -To turn off TDE for an RDS for SQL Server DB instance, first make sure that there are no encrypted objects left on the DB instance\. To do so, either decrypt the objects or drop them\. If any encrypted objects exist on the DB instance, you can't turn off TDE for the DB instance\. When you use the console to remove the TDE option from an option group, the console indicates that it's processing\. In addition, an error event is created if the option group is associated with an encrypted DB instance or DB snapshot\. - -The following example removes the TDE encryption from a database called `customerDatabase`\. - -``` - 1. ------------- Removing TDE ---------------- - 2. - 3. USE [customerDatabase] - 4. GO - 5. - 6. -- Turn off encryption of the database - 7. ALTER DATABASE [customerDatabase] - 8. SET ENCRYPTION OFF - 9. GO -10. -11. -- Wait until the encryption state of the database becomes 1. The state is 5 (Decryption in progress) for a while -12. SELECT db_name(database_id) as DatabaseName, * FROM sys.dm_database_encryption_keys -13. GO -14. -15. -- Drop the DEK used for encryption -16. DROP DATABASE ENCRYPTION KEY -17. GO -18. -19. -- Alter to SIMPLE Recovery mode so that your encrypted log gets truncated -20. USE [master] -21. GO -22. ALTER DATABASE [customerDatabase] SET RECOVERY SIMPLE -23. GO -``` - -When all objects are decrypted, you have two options: - -1. You can modify the DB instance to be associated with an option group without the TDE option\. - -1. You can remove the TDE option from the option group\. \ No newline at end of file diff --git a/doc_source/Appendix.SQLServer.Options.md b/doc_source/Appendix.SQLServer.Options.md deleted file mode 100644 index 10841e4..0000000 --- a/doc_source/Appendix.SQLServer.Options.md +++ /dev/null @@ -1,82 +0,0 @@ -# Options for the Microsoft SQL Server database engine - -In this section, you can find descriptions for options that are available for Amazon RDS instances running the Microsoft SQL Server DB engine\. To enable these options, you add them to an option group, and then associate the option group with your DB instance\. For more information, see [Working with option groups](USER_WorkingWithOptionGroups.md)\. - -If you're looking for optional features that aren't added through RDS option groups \(such as SSL, Microsoft Windows Authentication, and Amazon S3 integration\), see [Additional features for Microsoft SQL Server on Amazon RDS](User.SQLServer.AdditionalFeatures.md)\. - -Amazon RDS supports the following options for Microsoft SQL Server DB instances\. - - -**** - -| Option | Option ID | Engine editions | -| --- | --- | --- | -| [Linked Servers with Oracle OLEDB](Appendix.SQLServer.Options.LinkedServers_Oracle_OLEDB.md) | `OLEDB_ORACLE` | SQL Server Enterprise Edition SQL Server Standard Edition | -| [Native backup and restore](Appendix.SQLServer.Options.BackupRestore.md) | `SQLSERVER_BACKUP_RESTORE` | SQL Server Enterprise Edition SQL Server Standard Edition SQL Server Web Edition SQL Server Express Edition | -| [Transparent Data Encryption](Appendix.SQLServer.Options.TDE.md) | `TRANSPARENT_DATA_ENCRYPTION` \(RDS console\) `TDE` \(AWS CLI and RDS API\) | SQL Server 2014–2019 Enterprise Edition SQL Server 2019 Standard Edition | -| [SQL Server Audit](Appendix.SQLServer.Options.Audit.md) | `SQLSERVER_AUDIT` | In RDS, starting with SQL Server 2014, all editions of SQL Server support server\-level audits, and Enterprise Edition also supports database\-level audits\. Starting with SQL Server SQL Server 2016 \(13\.x\) SP1, all editions support both server\-level and database\-level audits\. For more information, see [SQL Server Audit \(database engine\)](https://docs.microsoft.com/sql/relational-databases/security/auditing/sql-server-audit-database-engine?view=sql-server-2017) in the SQL Server documentation\. | -| [SQL Server Analysis Services](Appendix.SQLServer.Options.SSAS.md) | `SSAS` | SQL Server Enterprise Edition SQL Server Standard Edition | -| [SQL Server Integration Services](Appendix.SQLServer.Options.SSIS.md) | `SSIS` | SQL Server Enterprise Edition SQL Server Standard Edition | -| [SQL Server Reporting Services](Appendix.SQLServer.Options.SSRS.md) | `SSRS` | SQL Server Enterprise Edition SQL Server Standard Edition | -| [Microsoft Distributed Transaction Coordinator](Appendix.SQLServer.Options.MSDTC.md) | `MSDTC` | In RDS, starting with SQL Server 2014, all editions of SQL Server support distributed transactions\. | - -## Listing the available options for SQL Server versions and editions - -You can use the `describe-option-group-options` AWS CLI command to list the available options for SQL Server versions and editions, and the settings for those options\. - -The following example shows the options and option settings for SQL Server 2019 Enterprise Edition\. The `--engine-name` option is required\. - -``` -aws rds describe-option-group-options --engine-name sqlserver-ee --major-engine-version 15.00 -``` - -The output resembles the following: - -``` -{ - "OptionGroupOptions": [ - { - "Name": "MSDTC", - "Description": "Microsoft Distributed Transaction Coordinator", - "EngineName": "sqlserver-ee", - "MajorEngineVersion": "15.00", - "MinimumRequiredMinorEngineVersion": "4043.16.v1", - "PortRequired": true, - "DefaultPort": 5000, - "OptionsDependedOn": [], - "OptionsConflictsWith": [], - "Persistent": false, - "Permanent": false, - "RequiresAutoMinorEngineVersionUpgrade": false, - "VpcOnly": false, - "OptionGroupOptionSettings": [ - { - "SettingName": "ENABLE_SNA_LU", - "SettingDescription": "Enable support for SNA LU protocol", - "DefaultValue": "true", - "ApplyType": "DYNAMIC", - "AllowedValues": "true,false", - "IsModifiable": true, - "IsRequired": false, - "MinimumEngineVersionPerAllowedValue": [] - }, - ... - - { - "Name": "TDE", - "Description": "SQL Server - Transparent Data Encryption", - "EngineName": "sqlserver-ee", - "MajorEngineVersion": "15.00", - "MinimumRequiredMinorEngineVersion": "4043.16.v1", - "PortRequired": false, - "OptionsDependedOn": [], - "OptionsConflictsWith": [], - "Persistent": true, - "Permanent": false, - "RequiresAutoMinorEngineVersionUpgrade": false, - "VpcOnly": false, - "OptionGroupOptionSettings": [] - } - ] -} -``` \ No newline at end of file diff --git a/doc_source/CHAP_BackupRestore_Instance.md b/doc_source/CHAP_BackupRestore_Instance.md deleted file mode 100644 index 6c50eb0..0000000 --- a/doc_source/CHAP_BackupRestore_Instance.md +++ /dev/null @@ -1,14 +0,0 @@ -# Backing up and restoring a DB instance - -This section shows how to back up and restore a DB instance\. - -**Topics** -+ [Replicating automated backups to another AWS Region](USER_ReplicateBackups.md) -+ [Creating a DB snapshot](USER_CreateSnapshot.md) -+ [Restoring from a DB snapshot](USER_RestoreFromSnapshot.md) -+ [Copying a DB snapshot](USER_CopySnapshot.md) -+ [Sharing a DB snapshot](USER_ShareSnapshot.md) -+ [Exporting DB snapshot data to Amazon S3](USER_ExportSnapshot.md) -+ [Restoring a DB instance to a specified time](USER_PIT.md) -+ [Deleting a DB snapshot](USER_DeleteSnapshot.md) -+ [Tutorial: Restore an Amazon RDS DB instance from a DB snapshot](CHAP_Tutorials.RestoringFromSnapshot.md) \ No newline at end of file diff --git a/doc_source/CHAP_BackupRestore_MAZ.md b/doc_source/CHAP_BackupRestore_MAZ.md deleted file mode 100644 index 3f5e1c0..0000000 --- a/doc_source/CHAP_BackupRestore_MAZ.md +++ /dev/null @@ -1,13 +0,0 @@ -# Backing up and restoring a Multi\-AZ DB cluster - -This section shows how to back up and restore Multi\-AZ DB clusters\. - -**Topics** -+ [Creating a Multi\-AZ DB cluster snapshot](USER_CreateMultiAZDBClusterSnapshot.md) -+ [Restoring from a snapshot to a Multi\-AZ DB cluster](USER_RestoreFromMultiAZDBClusterSnapshot.Restoring.md) -+ [Restoring from a Multi\-AZ DB cluster snapshot to a DB instance](USER_RestoreFromMultiAZDBClusterSnapshot.md) -+ [Restoring a Multi\-AZ DB cluster to a specified time](USER_PIT.MultiAZDBCluster.md) - -In addition, the following topics apply to both DB instances and Multi\-AZ DB clusters: -+ [Sharing a DB snapshot](USER_ShareSnapshot.md) -+ [Deleting a DB snapshot](USER_DeleteSnapshot.md) \ No newline at end of file diff --git a/doc_source/CHAP_BestPractices.Security.md b/doc_source/CHAP_BestPractices.Security.md deleted file mode 100644 index 1a8a939..0000000 --- a/doc_source/CHAP_BestPractices.Security.md +++ /dev/null @@ -1,16 +0,0 @@ -# Security best practices for Amazon RDS - -Use AWS Identity and Access Management \(IAM\) accounts to control access to Amazon RDS API operations, especially operations that create, modify, or delete Amazon RDS resources\. Such resources include DB instances, security groups, and parameter groups\. Also use IAM to control actions that perform common administrative actions such as backing up and restoring DB instances\. -+ Create an individual user for each person who manages Amazon RDS resources, including yourself\. Don't use AWS root credentials to manage Amazon RDS resources\. -+ Grant each user the minimum set of permissions required to perform his or her duties\. -+ Use IAM groups to effectively manage permissions for multiple users\. -+ Rotate your IAM credentials regularly\. -+ Configure AWS Secrets Manager to automatically rotate the secrets for Amazon RDS\. For more information, see [Rotating your AWS Secrets Manager secrets](https://docs.aws.amazon.com/secretsmanager/latest/userguide/rotating-secrets.html) in the *AWS Secrets Manager User Guide*\. You can also retrieve the credential from AWS Secrets Manager programmatically\. For more information, see [Retrieving the secret value](https://docs.aws.amazon.com/secretsmanager/latest/userguide/manage_retrieve-secret.html) in the *AWS Secrets Manager User Guide*\. - -For more information about Amazon RDS security, see [Security in Amazon RDS](UsingWithRDS.md)\. For more information about IAM, see [AWS Identity and Access Management](https://docs.aws.amazon.com/IAM/latest/UserGuide/Welcome.html)\. For information on IAM best practices, see [IAM best practices](https://docs.aws.amazon.com/IAM/latest/UserGuide/IAMBestPractices.html)\. - -AWS Security Hub uses security controls to evaluate resource configurations and security standards to help you comply with various compliance frameworks\. For more information about using Security Hub to evaluate RDS resources, see [Amazon Relational Database Service controls](https://docs.aws.amazon.com/securityhub/latest/userguide/rds-controls.html) in the AWS Security Hub User Guide\. - -You can monitor your usage of RDS as it relates to security best practices by using Security Hub\. For more information, see [What is AWS Security Hub?](https://docs.aws.amazon.com/securityhub/latest/userguide/what-is-securityhub.html)\. - -Use the AWS Management Console, the AWS CLI, or the RDS API to change the password for your master user\. If you use another tool, such as a SQL client, to change the master user password, it might result in privileges being revoked for the user unintentionally\. \ No newline at end of file diff --git a/doc_source/CHAP_BestPractices.md b/doc_source/CHAP_BestPractices.md deleted file mode 100644 index ba70e3e..0000000 --- a/doc_source/CHAP_BestPractices.md +++ /dev/null @@ -1,374 +0,0 @@ -# Best practices for Amazon RDS - -Learn best practices for working with Amazon RDS\. As new best practices are identified, we will keep this section up to date\. - -**Topics** -+ [Amazon RDS basic operational guidelines](#CHAP_BestPractices.DiskPerformance) -+ [DB instance RAM recommendations](#CHAP_BestPractices.Performance.RAM) -+ [Using Enhanced Monitoring to identify operating system issues](#CHAP_BestPractices.EnhancedMonitoring) -+ [Using metrics to identify performance issues](#CHAP_BestPractices.UsingMetrics) -+ [Tuning queries](#CHAP_BestPractices.TuningQueries) -+ [Best practices for working with MySQL](#CHAP_BestPractices.MySQLStorage) -+ [Best practices for working with MariaDB](#CHAP_BestPractices.MariaDB) -+ [Best practices for working with Oracle](#CHAP_BestPractices.Oracle) -+ [Best practices for working with PostgreSQL](#CHAP_BestPractices.PostgreSQL) -+ [Best practices for working with SQL Server](#CHAP_BestPractices.SQLServer) -+ [Working with DB parameter groups](#CHAP_BestPractices.DBParameterGroup) -+ [Best practices for automating DB instance creation](#CHAP_BestPractices.AutoDBCreation) -+ [Amazon RDS new features and best practices presentation video](#CHAP_BestPractices.Presentation) - -**Note** -For common recommendations for Amazon RDS, see [Viewing Amazon RDS recommendations](accessing-monitoring.md#USER_Recommendations)\. - -## Amazon RDS basic operational guidelines - -The following are basic operational guidelines that everyone should follow when working with Amazon RDS\. Note that the Amazon RDS Service Level Agreement requires that you follow these guidelines: -+ Use metrics to monitor your memory, CPU, replica lag, and storage usage\. You can set up Amazon CloudWatch to notify you when usage patterns change or when you approach the capacity of your deployment\. This way, you can maintain system performance and availability\. -+ Scale up your DB instance when you are approaching storage capacity limits\. You should have some buffer in storage and memory to accommodate unforeseen increases in demand from your applications\. -+ Enable automatic backups and set the backup window to occur during the daily low in write IOPS\. That's when a backup is least disruptive to your database usage\. -+ If your database workload requires more I/O than you have provisioned, recovery after a failover or database failure will be slow\. To increase the I/O capacity of a DB instance, do any or all of the following: - + Migrate to a different DB instance class with high I/O capacity\. - + Convert from magnetic storage to either General Purpose or Provisioned IOPS storage, depending on how much of an increase you need\. For information on available storage types, see [Amazon RDS storage types](CHAP_Storage.md#Concepts.Storage)\. - - If you convert to Provisioned IOPS storage, make sure you also use a DB instance class that is optimized for Provisioned IOPS\. For information on Provisioned IOPS, see [Provisioned IOPS SSD storage](CHAP_Storage.md#USER_PIOPS)\. - + If you are already using Provisioned IOPS storage, provision additional throughput capacity\. -+ If your client application is caching the Domain Name Service \(DNS\) data of your DB instances, set a time\-to\-live \(TTL\) value of less than 30 seconds\. The underlying IP address of a DB instance can change after a failover\. Caching the DNS data for an extended time can thus lead to connection failures\. Your application might try to connect to an IP address that's no longer in service\. -+ Test failover for your DB instance to understand how long the process takes for your particular use case\. Also test failover to ensure that the application that accesses your DB instance can automatically connect to the new DB instance after failover occurs\. - -## DB instance RAM recommendations - -An Amazon RDS performance best practice is to allocate enough RAM so that your *working set* resides almost completely in memory\. The working set is the data and indexes that are frequently in use on your instance\. The more you use the DB instance, the more the working set will grow\. - -To tell if your working set is almost all in memory, check the ReadIOPS metric \(using Amazon CloudWatch\) while the DB instance is under load\. The value of ReadIOPS should be small and stable\. In some cases, scaling up the DB instance class to a class with more RAM results in a dramatic drop in ReadIOPS\. In these cases, your working set was not almost completely in memory\. Continue to scale up until ReadIOPS no longer drops dramatically after a scaling operation, or ReadIOPS is reduced to a very small amount\. For information on monitoring a DB instance's metrics, see [Viewing metrics in the Amazon RDS console](USER_Monitoring.md)\. - -## Using Enhanced Monitoring to identify operating system issues - -When Enhanced Monitoring is enabled, Amazon RDS provides metrics in real time for the operating system \(OS\) that your DB instance runs on\. You can view the metrics for your DB instance using the console\. You can also consume the Enhanced Monitoring JSON output from Amazon CloudWatch Logs in a monitoring system of your choice\. For more information about Enhanced Monitoring, see [Monitoring OS metrics with Enhanced Monitoring](USER_Monitoring.OS.md)\. - -## Using metrics to identify performance issues - - To identify performance issues caused by insufficient resources and other common bottlenecks, you can monitor the metrics available for your Amazon RDS DB instance\. - -### Viewing performance metrics - -You should monitor performance metrics on a regular basis to see the average, maximum, and minimum values for a variety of time ranges\. If you do so, you can identify when performance is degraded\. You can also set Amazon CloudWatch alarms for particular metric thresholds so you are alerted if they are reached\. - -To troubleshoot performance issues, it's important to understand the baseline performance of the system\. When you set up a DB instance and run it with a typical workload, capture the average, maximum, and minimum values of all performance metrics\. Do so at a number of different intervals \(for example, one hour, 24 hours, one week, two weeks\)\. This can give you an idea of what is normal\. It helps to get comparisons for both peak and off\-peak hours of operation\. You can then use this information to identify when performance is dropping below standard levels\. - -If you use Multi\-AZ DB clusters, monitor the time difference between the latest transaction on the writer DB instance and the latest applied transaction on a reader DB instance\. This difference is called *replica lag*\. For more information, see [Replica lag and Multi\-AZ DB clusters](multi-az-db-clusters-concepts.md#multi-az-db-clusters-concepts-replica-lag)\. - -You can view the combined Performance Insights and CloudWatch metrics in the Performance Insights dashboard and monitor your DB instance\. To use this monitoring view, Performance Insights must be turned on for your DB instance\. For information about this monitoring view, see [Viewing combined metrics in the Amazon RDS console](Viewing_Unifiedmetrics.md)\. - -**To view performance metrics** - -1. Sign in to the AWS Management Console and open the Amazon RDS console at [https://console\.aws\.amazon\.com/rds/](https://console.aws.amazon.com/rds/)\. - -1. In the navigation pane, choose **Databases**, and then choose a DB instance\. - -1. Choose **Monitoring**\. - - The dashboard provides the performance metrics\. The metrics default to show the information for the last three hours\. - -1. Use the numbered buttons in the upper\-right to page through the additional metrics, or adjust the settings to see more metrics\. - -1. Choose a performance metric to adjust the time range in order to see data for other than the current day\. You can change the **Statistic**, **Time Range**, and **Period** values to adjust the information displayed\. For example, you might want to see the peak values for a metric for each day of the last two weeks\. If so, set **Statistic** to **Maximum**, **Time Range** to **Last 2 Weeks**, and **Period** to **Day**\. - - You can also view performance metrics using the CLI or API\. For more information, see [Viewing metrics in the Amazon RDS console](USER_Monitoring.md)\. - -****To set a CloudWatch alarm**** - -1. Sign in to the AWS Management Console and open the Amazon RDS console at [https://console\.aws\.amazon\.com/rds/](https://console.aws.amazon.com/rds/)\. - -1. In the navigation pane, choose **Databases**, and then choose a DB instance\. - -1. Choose **Logs & events**\. - -1. In the **CloudWatch alarms** section, choose **Create alarm**\. -![\[Create Alarm dialog box\]](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/images/CreateAlarm.png) - -1. For **Send notifications**, choose **Yes**, and for **Send notifications to**, choose **New email or SMS topic**\. - -1. For **Topic name**, enter a name for the notification, and for **With these recipients**, enter a comma\-separated list of email addresses and phone numbers\. - -1. For **Metric**, choose the alarm statistic and metric to set\. - -1. For **Threshold**, specify whether the metric must be greater than, less than, or equal to the threshold, and specify the threshold value\. - -1. For **Evaluation period**, choose the evaluation period for the alarm\. For **consecutive period\(s\) of**, choose the period during which the threshold must have been reached in order to trigger the alarm\. - -1. For **Name of alarm**, enter a name for the alarm\. - -1. Choose **Create Alarm**\. - -The alarm appears in the **CloudWatch alarms** section\. - -### Evaluating performance metrics - - A DB instance has a number of different categories of metrics, and how to determine acceptable values depends on the metric\. - -**CPU** -+ CPU Utilization – Percentage of computer processing capacity used\. - -**Memory** -+ Freeable Memory – How much RAM is available on the DB instance, in megabytes\. The red line in the Monitoring tab metrics is marked at 75% for CPU, Memory and Storage Metrics\. If instance memory consumption frequently crosses that line, then this indicates that you should check your workload or upgrade your instance\. -+ Swap Usage – How much swap space is used by the DB instance, in megabytes\. - -**Disk space** -+ Free Storage Space – How much disk space is not currently being used by the DB instance, in megabytes\. - -**Input/output operations** -+ Read IOPS, Write IOPS – The average number of disk read or write operations per second\. -+ Read Latency, Write Latency – The average time for a read or write operation in milliseconds\. -+ Read Throughput, Write Throughput – The average number of megabytes read from or written to disk per second\. -+ Queue Depth – The number of I/O operations that are waiting to be written to or read from disk\. - -**Network traffic** -+ Network Receive Throughput, Network Transmit Throughput – The rate of network traffic to and from the DB instance in bytes per second\. - -**Database connections** -+ DB Connections – The number of client sessions that are connected to the DB instance\. - - For more detailed individual descriptions of the performance metrics available, see [Monitoring Amazon RDS metrics with Amazon CloudWatch](monitoring-cloudwatch.md)\. - - Generally speaking, acceptable values for performance metrics depend on what your baseline looks like and what your application is doing\. Investigate consistent or trending variances from your baseline\. Advice about specific types of metrics follows: -+ **High CPU or RAM consumption –** High values for CPU or RAM consumption might be appropriate\. For example, they might be so if they are in keeping with your goals for your application \(like throughput or concurrency\) and are expected\. -+ **Disk space consumption – ** Investigate disk space consumption if space used is consistently at or above 85 percent of the total disk space\. See if it is possible to delete data from the instance or archive data to a different system to free up space\. -+ **Network traffic –** For network traffic, talk with your system administrator to understand what expected throughput is for your domain network and internet connection\. Investigate network traffic if throughput is consistently lower than expected\. -+ **Database connections –** Consider constraining database connections if you see high numbers of user connections in conjunction with decreases in instance performance and response time\. The best number of user connections for your DB instance will vary based on your instance class and the complexity of the operations being performed\. To determine the number of database connections, associate your DB instance with a parameter group\. In this group, set the *User Connections* parameter to other than 0 \(unlimited\)\. You can either use an existing parameter group or create a new one\. For more information, see [Working with parameter groups](USER_WorkingWithParamGroups.md)\. -+ **IOPS metrics –** The expected values for IOPS metrics depend on disk specification and server configuration, so use your baseline to know what is typical\. Investigate if values are consistently different than your baseline\. For best IOPS performance, make sure your typical working set will fit into memory to minimize read and write operations\. - - For issues with performance metrics, a first step to improve performance is to tune the most used and most expensive queries\. Tune them to see if doing so lowers the pressure on system resources\. For more information, see [Tuning queries](#CHAP_BestPractices.TuningQueries)\. - - If your queries are tuned and an issue persists, consider upgrading your Amazon RDS [DB instance classes](Concepts.DBInstanceClass.md)\. You might upgrade it to one with more of the resource \(CPU, RAM, disk space, network bandwidth, I/O capacity\) that is related to the issue\. - -## Tuning queries - -One of the best ways to improve DB instance performance is to tune your most commonly used and most resource\-intensive queries\. Here, you tune them to make them less expensive to run\. For information on improving queries, use the following resources: -+ MySQL – See [Optimizing SELECT statements](https://dev.mysql.com/doc/refman/8.0/en/select-optimization.html) in the MySQL documentation\. For additional query tuning resources, see [MySQL performance tuning and optimization resources](http://www.mysql.com/why-mysql/performance/)\. -+ Oracle – See [Database SQL Tuning Guide](https://docs.oracle.com/database/121/TGSQL/toc.htm) in the Oracle Database documentation\. -+ SQL Server – See [Analyzing a query](http://technet.microsoft.com/en-us/library/ms191227.aspx) in the Microsoft documentation\. You can also use the execution\-, index\-, and I/O\-related data management views \(DMVs\) described in [System Dynamic Management Views](https://docs.microsoft.com/en-us/sql/relational-databases/system-dynamic-management-views/system-dynamic-management-views) in the Microsoft documentation to troubleshoot SQL Server query issues\. - - A common aspect of query tuning is creating effective indexes\. For potential index improvements for your DB instance, see [Database Engine Tuning Advisor](https://docs.microsoft.com/en-us/sql/relational-databases/performance/database-engine-tuning-advisor) in the Microsoft documentation\. For information on using Tuning Advisor on RDS for SQL Server, see [Analyzing your database workload on an Amazon RDS for SQL Server DB instance with Database Engine Tuning Advisor](Appendix.SQLServer.CommonDBATasks.Workload.md)\. -+ PostgreSQL – See [Using EXPLAIN](http://www.postgresql.org/docs/current/using-explain.html) in the PostgreSQL documentation to learn how to analyze a query plan\. You can use this information to modify a query or underlying tables in order to improve query performance\. - - For information about how to specify joins in your query for the best performance, see [Controlling the planner with explicit JOIN clauses](http://www.postgresql.org/docs/current/explicit-joins.html)\. -+ MariaDB – See [Query optimizations](https://mariadb.com/kb/en/mariadb/query-optimizations/) in the MariaDB documentation\. - -## Best practices for working with MySQL - -Both table sizes and number of tables in a MySQL database can affect performance\. - -### Table size - -Typically, operating system constraints on file sizes determine the effective maximum table size for MySQL databases\. So, the limits usually aren't determined by internal MySQL constraints\. - -On a MySQL DB instance, avoid tables in your database growing too large\. Although the general storage limit is 64 TiB, provisioned storage limits restrict the maximum size of a MySQL table file to 16 TiB\. Partition your large tables so that file sizes are well under the 16 TiB limit\. This approach can also improve performance and recovery time\. For more information, see [MySQL file size limits in Amazon RDS](MySQL.KnownIssuesAndLimitations.md#MySQL.Concepts.Limits.FileSize)\. - -Very large tables \(greater than 100 GB in size\) can negatively affect performance for both reads and writes \(including DML statements and especially DDL statements\)\. Indexes on larges tables can significantly improve select performance, but they can also degrade the performance of DML statements\. DDL statements, such as `ALTER TABLE`, can be significantly slower for the large tables because those operations might completely rebuild a table in some cases\. These DDL statements might lock the tables for the duration of the operation\. - -The amount of memory required by MySQL for reads and writes depends on the tables involved in the operations\. It is a best practice to have at least enough RAM to the hold the indexes of *actively* used tables\. To find the ten largest tables and indexes in a database, use the following query: - -``` -select table_schema, TABLE_NAME, dat, idx from -(SELECT table_schema, TABLE_NAME, - ( data_length ) / 1024 / 1024 as dat, - ( index_length ) / 1024 / 1024 as idx -FROM information_schema.TABLES -order by 3 desc ) a -order by 3 desc -limit 10; -``` - -### Number of tables - -Your underlying file system might have a limit on the number of files that represent tables\. However, MySQL has no limit on the number of tables\. Despite this, the total number of tables in the MySQL InnoDB storage engine can contribute to the performance degradation, regardless of the size of those tables\. To limit the operating system impact, you can split the tables across multiple databases in the same MySQL DB instance\. Doing so might limit the number of files in a directory but won't solve the overall problem\. - -When there is performance degradation because of a large number of tables \(more than 10 thousand\), it is caused by MySQL working with storage files, including opening and closing them\. To address this issue, you can increase the size of the `table_open_cache` and `table_definition_cache` parameters\. However, increasing the values of those parameters might significantly increase the amount of memory MySQL uses, and might even use all of the available memory\. For more information, see [ How MySQL Opens and Closes Tables](https://dev.mysql.com/doc/refman/8.0/en/table-cache.html) in the MySQL documentation\. - -In addition, too many tables can significantly affect MySQL startup time\. Both a clean shutdown and restart and a crash recovery can be affected, especially in versions prior to MySQL 8\.0\. - -We recommend having fewer than 10,000 tables total across all of the databases in a DB instance\. For a use case with a large number of tables in a MySQL database, see [ One Million Tables in MySQL 8\.0](https://www.percona.com/blog/2017/10/01/one-million-tables-mysql-8-0/)\. - -### Storage engine - -The point\-in\-time restore and snapshot restore features of Amazon RDS for MySQL require a crash\-recoverable storage engine\. These features are supported for the InnoDB storage engine only\. Although MySQL supports multiple storage engines with varying capabilities, not all of them are optimized for crash recovery and data durability\. For example, the MyISAM storage engine doesn't support reliable crash recovery and might prevent a point\-in\-time restore or snapshot restore from working as intended\. This might result in lost or corrupt data when MySQL is restarted after a crash\. - -InnoDB is the recommended and supported storage engine for MySQL DB instances on Amazon RDS\. InnoDB instances can also be migrated to Aurora, while MyISAM instances can't be migrated\. However, MyISAM performs better than InnoDB if you require intense, full\-text search capability\. If you still choose to use MyISAM with Amazon RDS, following the steps outlined in [Automated backups with unsupported MySQL storage engines](USER_WorkingWithAutomatedBackups.md#Overview.BackupDeviceRestrictions) can be helpful in certain scenarios for snapshot restore functionality\. - -If you want to convert existing MyISAM tables to InnoDB tables, you can use the process outlined in the [MySQL documentation](http://dev.mysql.com/doc/refman/5.0/en/converting-tables-to-innodb.html)\. MyISAM and InnoDB have different strengths and weaknesses, so you should fully evaluate the impact of making this switch on your applications before doing so\. - -In addition, Federated Storage Engine is currently not supported by Amazon RDS for MySQL\. - -## Best practices for working with MariaDB - -Both table sizes and number of tables in a MariaDB database can affect performance\. - -### Table size - -Typically, operating system constraints on file sizes determine the effective maximum table size for MariaDB databases\. So, the limits usually aren't determined by internal MariaDB constraints\. - -On a MariaDB DB instance, avoid tables in your database growing too large\. Although the general storage limit is 64 TiB, provisioned storage limits restrict the maximum size of a MariaDB table file to 16 TiB\. Partition your large tables so that file sizes are well under the 16 TiB limit\. This approach can also improve performance and recovery time\. - -Very large tables \(greater than 100 GB in size\) can negatively affect performance for both reads and writes \(including DML statements and especially DDL statements\)\. Indexes on larges tables can significantly improve select performance, but they can also degrade the performance of DML statements\. DDL statements, such as `ALTER TABLE`, can be significantly slower for the large tables because those operations might completely rebuild a table in some cases\. These DDL statements might lock the tables for the duration of the operation\. - -The amount of memory required by MariaDB for reads and writes depends on the tables involved in the operations\. It is a best practice to have at least enough RAM to the hold the indexes of *actively* used tables\. To find the ten largest tables and indexes in a database, use the following query: - -``` -select table_schema, TABLE_NAME, dat, idx from -(SELECT table_schema, TABLE_NAME, - ( data_length ) / 1024 / 1024 as dat, - ( index_length ) / 1024 / 1024 as idx -FROM information_schema.TABLES -order by 3 desc ) a -order by 3 desc -limit 10; -``` - -### Number of tables - -Your underlying file system might have a limit on the number of files that represent tables\. However, MariaDB has no limit on the number of tables\. Despite this, the total number of tables in the MariaDB InnoDB storage engine can contribute to the performance degradation, regardless of the size of those tables\. To limit the operating system impact, you can split the tables across multiple databases in the same MariaDB DB instance\. Doing so might limit the number of files in a directory but doesn’t solve the overall problem\. - -When there is performance degradation because of a large number of tables \(more than 10,000\), it's caused by MariaDB working with storage files\. This work includes MariaDB opening and closing storage files\. To address this issue, you can increase the size of the `table_open_cache` and `table_definition_cache` parameters\. However, increasing the values of those parameters might significantly increase the amount of memory MariaDB uses\. It might even use all of the available memory\. For more information, see [ Optimizing table\_open\_cache](https://mariadb.com/kb/en/optimizing-table_open_cache/) in the MariaDB documentation\. - -In addition, too many tables can significantly affect MariaDB startup time\. Both a clean shutdown and restart and a crash recovery can be affected\. We recommend having fewer than ten thousand tables total across all of the databases in a DB instance\. - -### Storage engine - -The point\-in\-time restore and snapshot restore features of Amazon RDS for MariaDB require a crash\-recoverable storage engine\. Although MariaDB supports multiple storage engines with varying capabilities, not all of them are optimized for crash recovery and data durability\. For example, although Aria is a crash\-safe replacement for MyISAM, it might still prevent a point\-in\-time restore or snapshot restore from working as intended\. This might result in lost or corrupt data when MariaDB is restarted after a crash\. InnoDB is the recommended and supported storage engine for MariaDB DB instances on Amazon RDS\. If you still choose to use Aria with Amazon RDS, following the steps outlined in [Automated backups with unsupported MariaDB storage engines](USER_WorkingWithAutomatedBackups.md#Overview.BackupDeviceRestrictionsMariaDB) can be helpful in certain scenarios for snapshot restore functionality\. - -If you want to convert existing MyISAM tables to InnoDB tables, you can use the process outlined in the [MariaDB documentation](https://mariadb.com/kb/en/converting-tables-from-myisam-to-innodb/)\. MyISAM and InnoDB have different strengths and weaknesses, so you should fully evaluate the impact of making this switch on your applications before doing so\. - -## Best practices for working with Oracle - -For information about best practices for working with Amazon RDS for Oracle, see [ Best practices for running Oracle database on Amazon Web Services](https://docs.aws.amazon.com/aws-technical-content/latest/oracle-database-aws-best-practices/introduction.html)\. - -A 2020 AWS virtual workshop included a presentation on running production Oracle databases on Amazon RDS\. A video of the presentation is available here: - -[![AWS Videos](http://img.youtube.com/vi/https://www.youtube.com/embed/vpSWZx4-M-M/0.jpg)](http://www.youtube.com/watch?v=https://www.youtube.com/embed/vpSWZx4-M-M) - -## Best practices for working with PostgreSQL - -Of two important areas where you can improve performance with RDS for PostgreSQL, one is when loading data into a DB instance\. Another is when using the PostgreSQL autovacuum feature\. The following sections cover some of the practices we recommend for these areas\. - -For information on how Amazon RDS implements other common PostgreSQL DBA tasks, see [Common DBA tasks for Amazon RDS for PostgreSQL](Appendix.PostgreSQL.CommonDBATasks.md)\. - -### Loading data into a PostgreSQL DB instance - -When loading data into an Amazon RDS for PostgreSQL DB instance, modify your DB instance settings and your DB parameter group values\. Set these to allow for the most efficient importing of data into your DB instance\. - -Modify your DB instance settings to the following: -+ Disable DB instance backups \(set backup\_retention to 0\) -+ Disable Multi\-AZ - -Modify your DB parameter group to include the following settings\. Also, test the parameter settings to find the most efficient settings for your DB instance\. -+ Increase the value of the `maintenance_work_mem` parameter\. For more information about PostgreSQL resource consumption parameters, see the [PostgreSQL documentation](http://www.postgresql.org/docs/current/runtime-config-resource.html)\. -+ Increase the value of the `max_wal_size` and `checkpoint_timeout` parameters to reduce the number of writes to the write\-ahead log \(WAL\) log\. -+ Disable the `synchronous_commit` parameter\. -+ Disable the PostgreSQL autovacuum parameter\. -+ Make sure that none of the tables you're importing are unlogged\. Data stored in unlogged tables can be lost during a failover\. For more information, see [CREATE TABLE UNLOGGED](https://www.postgresql.org/docs/current/sql-createtable.html)\. - -Use the `pg_dump -Fc` \(compressed\) or `pg_restore -j` \(parallel\) commands with these settings\. - -After the load operation completes, return your DB instance and DB parameters to their normal settings\. - -### Working with the PostgreSQL autovacuum feature - -The autovacuum feature for PostgreSQL databases is a feature that we strongly recommend you use to maintain the health of your PostgreSQL DB instance\. Autovacuum automates the execution of the VACUUM and ANALYZE command Using autovacuum is required by PostgreSQL, not imposed by Amazon RDS, and its use is critical to good performance\. The feature is enabled by default for all new Amazon RDS for PostgreSQL DB instances, and the related configuration parameters are appropriately set by default\. - -Your database administrator needs to know and understand this maintenance operation\. For the PostgreSQL documentation on autovacuum, see [The Autovacuum Daemon](http://www.postgresql.org/docs/current/routine-vacuuming.html#AUTOVACUUM)\. - -Autovacuum is not a "resource free" operation, but it works in the background and yields to user operations as much as possible\. When enabled, autovacuum checks for tables that have had a large number of updated or deleted tuples\. It also protects against loss of very old data due to transaction ID wraparound\. For more information, see [Preventing transaction ID wraparound failures](https://www.postgresql.org/docs/current/routine-vacuuming.html#VACUUM-FOR-WRAPAROUND)\. - -Autovacuum should not be thought of as a high\-overhead operation that can be reduced to gain better performance\. On the contrary, tables that have a high velocity of updates and deletes will quickly deteriorate over time if autovacuum is not run\. - -**Important** - Not running autovacuum can result in an eventual required outage to perform a much more intrusive vacuum operation\. In some cases, an RDS for PostgreSQL DB instance might become unavailable because of an over\-conservative use of autovacuum\. In these cases, the PostgreSQL database shuts down to protect itself\. At that point, Amazon RDS must perform a single\-user\-mode full vacuum directly on the DB instance\. This full vacuum can result in a multi\-hour outage\.* *Thus, we strongly recommend that you do not turn off autovacuum, which is turned on by default\. - -The autovacuum parameters determine when and how hard autovacuum works\. The`autovacuum_vacuum_threshold` and `autovacuum_vacuum_scale_factor` parameters determine when autovacuum is run\. The `autovacuum_max_workers`, `autovacuum_nap_time`, `autovacuum_cost_limit`, and `autovacuum_cost_delay` parameters determine how hard autovacuum works\. For more information about autovacuum, when it runs, and what parameters are required, see [Routine Vacuuming](https://www.postgresql.org/docs/current/routine-vacuuming.html) in the PostgreSQL documentation\. - - The following query shows the number of "dead" tuples in a table named table1: - -``` -SELECT relname, n_dead_tup, last_vacuum, last_autovacuum FROM -pg_catalog.pg_stat_all_tables -WHERE n_dead_tup > 0 and relname = 'table1'; -``` - -The results of the query will resemble the following: - -``` -relname | n_dead_tup | last_vacuum | last_autovacuum ----------+------------+-------------+----------------- - tasks | 81430522 | | -(1 row) -``` - -### Amazon RDS for PostgreSQL best practices video - -The 2020 AWS re:Invent conference included a presentation on new features and best practices for working with PostgreSQL on Amazon RDS\. A video of the presentation is available here: - -[![AWS Videos](http://img.youtube.com/vi/https://www.youtube.com/embed/3JLPWOoiVB8/0.jpg)](http://www.youtube.com/watch?v=https://www.youtube.com/embed/3JLPWOoiVB8) - -## Best practices for working with SQL Server - -Best practices for a Multi\-AZ deployment with a SQL Server DB instance include the following: -+ Use Amazon RDS DB events to monitor failovers\. For example, you can be notified by text message or email when a DB instance fails over\. For more information about Amazon RDS events, see [Working with Amazon RDS event notification](USER_Events.md)\. -+ If your application caches DNS values, set time to live \(TTL\) to less than 30 seconds\. Setting TTL as so is a good practice in case there is a failover\. In a failover, the IP address might change and the cached value might no longer be in service\. -+ We recommend that you *do not* enable the following modes because they turn off transaction logging, which is required for Multi\-AZ: - + Simple recover mode - + Offline mode - + Read\-only mode -+ Test to determine how long it takes for your DB instance to failover\. Failover time can vary due to the type of database, the instance class, and the storage type you use\. You should also test your application's ability to continue working if a failover occurs\. -+ To shorten failover time, do the following: - + Ensure that you have sufficient Provisioned IOPS allocated for your workload\. Inadequate I/O can lengthen failover times\. Database recovery requires I/O\. - + Use smaller transactions\. Database recovery relies on transactions, so if you can break up large transactions into multiple smaller transactions, your failover time should be shorter\. -+ Take into consideration that during a failover, there will be elevated latencies\. As part of the failover process, Amazon RDS automatically replicates your data to a new standby instance\. This replication means that new data is being committed to two different DB instances\. So there might be some latency until the standby DB instance has caught up to the new primary DB instance\. -+ Deploy your applications in all Availability Zones\. If an Availability Zone does go down, your applications in the other Availability Zones will still be available\. - -When working with a Multi\-AZ deployment of SQL Server, remember that Amazon RDS creates replicas for all SQL Server databases on your instance\. If you don't want specific databases to have secondary replicas, set up a separate DB instance that doesn't use Multi\-AZ for those databases\. - -### Amazon RDS for SQL Server best practices video - -The 2019 AWS re:Invent conference included a presentation on new features and best practices for working with SQL Server on Amazon RDS\. A video of the presentation is available here: - -[![AWS Videos](http://img.youtube.com/vi/https://www.youtube.com/embed/R4Vj88iqu5s/0.jpg)](http://www.youtube.com/watch?v=https://www.youtube.com/embed/R4Vj88iqu5s) - -## Working with DB parameter groups - -We recommend that you try out DB parameter group changes on a test DB instance before applying parameter group changes to your production DB instances\. Improperly setting DB engine parameters in a DB parameter group can have unintended adverse effects, including degraded performance and system instability\. Always exercise caution when modifying DB engine parameters and back up your DB instance before modifying a DB parameter group\. - -For information about backing up your DB instance, see [Backing up and restoring](CHAP_CommonTasks.BackupRestore.md)\. - -## Best practices for automating DB instance creation - -It’s an Amazon RDS best practice to create a DB instance with the preferred minor version of the database engine\. You can use the AWS CLI, Amazon RDS API, or AWS CloudFormation to automate DB instance creation\. When you use these methods, you can specify only the major version and Amazon RDS automatically creates the instance with the preferred minor version\. For example, if PostgreSQL 12\.5 is the preferred minor version, and if you specify version 12 with `create-db-instance`, the DB instance will be version 12\.5\. - -To determine the preferred minor version, you can run the `describe-db-engine-versions` command with the `--default-only` option as shown in the following example\. - -``` -aws rds describe-db-engine-versions --default-only --engine postgres - -{ - "DBEngineVersions": [ - { - "Engine": "postgres", - "EngineVersion": "12.5", - "DBParameterGroupFamily": "postgres12", - "DBEngineDescription": "PostgreSQL", - "DBEngineVersionDescription": "PostgreSQL 12.5-R1", - ...some output truncated... - } - ] -} -``` - -For information on creating DB instances programmatically, see the following resources: -+ Using the AWS CLI – [create\-db\-instance](https://docs.aws.amazon.com/cli/latest/reference/rds/create-db-instance.html) -+ Using the Amazon RDS API – [CreateDBInstance](https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_CreateDBInstance.html) -+ Using AWS CloudFormation – [AWS::RDS::DBInstance](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbinstance.html) - -## Amazon RDS new features and best practices presentation video - -The 2019 AWS re:Invent conference included a presentation on new Amazon RDS features and best practices for monitoring, analyzing, and tuning database performance using RDS\. A video of the presentation is available here: - -[![AWS Videos](http://img.youtube.com/vi/https://www.youtube.com/embed/KhxEQQOiqus/0.jpg)](http://www.youtube.com/watch?v=https://www.youtube.com/embed/KhxEQQOiqus) \ No newline at end of file diff --git a/doc_source/CHAP_CommonTasks.BackupRestore.md b/doc_source/CHAP_CommonTasks.BackupRestore.md deleted file mode 100644 index 2d7711b..0000000 --- a/doc_source/CHAP_CommonTasks.BackupRestore.md +++ /dev/null @@ -1,8 +0,0 @@ -# Backing up and restoring - -This section shows how to back up and restore an Amazon RDS DB instance or Multi\-AZ DB cluster\. - -**Topics** -+ [Working with backups](USER_WorkingWithAutomatedBackups.md) -+ [Backing up and restoring a DB instance](CHAP_BackupRestore_Instance.md) -+ [Backing up and restoring a Multi\-AZ DB cluster](CHAP_BackupRestore_MAZ.md) \ No newline at end of file diff --git a/doc_source/CHAP_CommonTasks.Connect.md b/doc_source/CHAP_CommonTasks.Connect.md deleted file mode 100644 index 52e2b86..0000000 --- a/doc_source/CHAP_CommonTasks.Connect.md +++ /dev/null @@ -1,135 +0,0 @@ -# Connecting to an Amazon RDS DB instance - - Before you can connect to a DB instance, you must create the DB instance\. For information, see [Creating an Amazon RDS DB instance](USER_CreateDBInstance.md)\. After Amazon RDS provisions your DB instance, use any standard client application or utility for your DB engine to connect to the DB instance\. In the connection string, specify the DNS address from the DB instance endpoint as the host parameter\. Also, specify the port number from the DB instance endpoint as the port parameter\. - -**Topics** -+ [Finding the connection information for an Amazon RDS DB instance](#CHAP_CommonTasks.Connect.EndpointAndPort) -+ [Database authentication options](#CHAP_CommonTasks.Connect.DatabaseAuthentication) -+ [Encrypted connections](#CHAP_CommonTasks.Connect.EncryptedConnections) -+ [Scenarios for accessing a DB instance in a VPC](#CHAP_CommonTasks.Connect.ScenariosForAccess) -+ [Connecting to a DB instance that is running a specific DB engine](#CHAP_CommonTasks.Connect.DBEngine) -+ [Managing connections with RDS Proxy](#CHAP_CommonTasks.Connect.RDSProxy) - -## Finding the connection information for an Amazon RDS DB instance - -The connection information for a DB instance includes its endpoint, port, and a valid database user, such as the master user\. For example, for a MySQL DB instance, suppose that the endpoint value is `mydb.123456789012.us-east-1.rds.amazonaws.com`\. In this case, the port value is `3306`, and the database user is `admin`\. Given this information, you specify the following values in a connection string: -+ For host or host name or DNS name, specify `mydb.123456789012.us-east-1.rds.amazonaws.com`\. -+ For port, specify `3306`\. -+ For user, specify `admin`\. - -The endpoint is unique for each DB instance, and the values of the port and user can vary\. The following list shows the most common port for each DB engine: -+ MariaDB – 3306 -+ Microsoft SQL Server – 1433 -+ MySQL – 3306 -+ Oracle – 1521 -+ PostgreSQL – 5432 - -To connect to a DB instance, use any client for a DB engine\. For example, you might use the mysql utility to connect to a MariaDB or MySQL DB instance\. You might use Microsoft SQL Server Management Studio to connect to a SQL Server DB instance\. You might use Oracle SQL Developer to connect to an Oracle DB instance\. Similarly, you might use the psql command line utility to connect to a PostgreSQL DB instance\. - -To find the connection information for a DB instance, use the AWS Management Console\. You can also use the AWS Command Line Interface \(AWS CLI\) [describe\-db\-instances](https://docs.aws.amazon.com/cli/latest/reference/rds/describe-db-instances.html) command or the RDS API [DescribeDBInstances](https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_DescribeDBInstances.html) operation\. - -### Console - -**To find the connection information for a DB instance in the AWS Management Console** - -1. Sign in to the AWS Management Console and open the Amazon RDS console at [https://console\.aws\.amazon\.com/rds/](https://console.aws.amazon.com/rds/)\. - -1. In the navigation pane, choose **Databases** to display a list of your DB instances\. - -1. Choose the name of the DB instance to display its details\. - -1. On the **Connectivity & security** tab, copy the endpoint\. Also, note the port number\. You need both the endpoint and the port number to connect to the DB instance\. -![\[The endpoint and port of a DB instance\]](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/images/endpoint-port.png) - -1. If you need to find the master user name, choose the **Configuration** tab and view the **Master username** value\. - -### AWS CLI - -To find the connection information for a DB instance by using the AWS CLI, call the [describe\-db\-instances](https://docs.aws.amazon.com/cli/latest/reference/rds/describe-db-instances.html) command\. In the call, query for the DB instance ID, endpoint, port, and master user name\. - -For Linux, macOS, or Unix: - -``` -aws rds describe-db-instances \ - --query "*[].[DBInstanceIdentifier,Endpoint.Address,Endpoint.Port,MasterUsername]" -``` - -For Windows: - -``` -aws rds describe-db-instances ^ - --query "*[].[DBInstanceIdentifier,Endpoint.Address,Endpoint.Port,MasterUsername]" -``` - -Your output should be similar to the following\. - -``` -[ - [ - "mydb", - "mydb.123456789012.us-east-1.rds.amazonaws.com", - 3306, - "admin" - ], - [ - "myoracledb", - "myoracledb.123456789012.us-east-1.rds.amazonaws.com", - 1521, - "dbadmin" - ], - [ - "mypostgresqldb", - "mypostgresqldb.123456789012.us-east-1.rds.amazonaws.com", - 5432, - "postgresadmin" - ] -] -``` - -### RDS API - -To find the connection information for a DB instance by using the Amazon RDS API, call the [DescribeDBInstances](https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_DescribeDBInstances.html) operation\. In the output, find the values for the endpoint address, endpoint port, and master user name\. - -## Database authentication options - -Amazon RDS supports the following ways to authenticate database users: -+ **Password authentication** – Your DB instance performs all administration of user accounts\. You create users and specify passwords with SQL statements\. The SQL statements you can use depend on your DB engine\. -+ **AWS Identity and Access Management \(IAM\) database authentication** – You don't need to use a password when you connect to a DB instance\. Instead, you use an authentication token\. -+ **Kerberos authentication** – You use external authentication of database users using Kerberos and Microsoft Active Directory\. Kerberos is a network authentication protocol that uses tickets and symmetric\-key cryptography to eliminate the need to transmit passwords over the network\. Kerberos has been built into Active Directory and is designed to authenticate users to network resources, such as databases\. - -IAM database authentication and Kerberos authentication are available only for specific DB engines and versions\. - -For more information, see [Database authentication with Amazon RDS](database-authentication.md)\. - -## Encrypted connections - -You can use Secure Socket Layer \(SSL\) or Transport Layer Security \(TLS\) from your application to encrypt a connection to a DB instance\. Each DB engine has its own process for implementing SSL/TLS\. For more information, see [Using SSL/TLS to encrypt a connection to a DB instance](UsingWithRDS.SSL.md)\. - -## Scenarios for accessing a DB instance in a VPC - -Using Amazon Virtual Private Cloud \(Amazon VPC\), you can launch AWS resources, such as Amazon RDS DB instances, into a virtual private cloud \(VPC\)\. When you use Amazon VPC, you have control over your virtual networking environment\. You can choose your own IP address range, create subnets, and configure routing and access control lists\. - -A VPC security group controls access to DB instances inside a VPC\. Each VPC security group rule enables a specific source to access a DB instance in a VPC that is associated with that VPC security group\. The source can be a range of addresses \(for example, 203\.0\.113\.0/24\), or another VPC security group\. By specifying a VPC security group as the source, you allow incoming traffic from all instances \(typically application servers\) that use the source VPC security group\. - -Before attempting to connect to your DB instance, configure your VPC for your use case\. The following are common scenarios for accessing a DB instance in a VPC: -+ **A DB instance in a VPC accessed by an Amazon EC2 instance in the same VPC** – A common use of a DB instance in a VPC is to share data with an application server that is running in an EC2 instance in the same VPC\. The EC2 instance might run a web server with an application that interacts with the DB instance\. -+ **A DB instance in a VPC accessed by an EC2 instance in a different VPC** – In some cases, your DB instance is in a different VPC from the EC2 instance that you're using to access it\. If so, you can use VPC peering to access the DB instance\. -+ **A DB instance in a VPC accessed by a client application through the internet** – To access a DB instance in a VPC from a client application through the internet, you configure a VPC with a single public subnet\. You also configure an internet gateway to enable communication over the internet\. - - To connect to a DB instance from outside of its VPC, the DB instance must be publicly accessible\. Also, access must be granted using the inbound rules of the DB instance's security group, and other requirements must be met\. For more information, see [Can't connect to Amazon RDS DB instance](CHAP_Troubleshooting.md#CHAP_Troubleshooting.Connecting)\. -+ **A DB instance in a VPC accessed by a private network** – If your DB instance isn't publicly accessible, you can use an AWS Site\-to\-Site VPN connection or an AWS Direct Connect connection to access it from a private network\. - -For more information, see [Scenarios for accessing a DB instance in a VPC](USER_VPC.Scenarios.md)\. - -## Connecting to a DB instance that is running a specific DB engine - -For information about connecting to a DB instance that is running a specific DB engine, follow the instructions for your DB engine: -+ [Connecting to a DB instance running the MariaDB database engine](USER_ConnectToMariaDBInstance.md) -+ [Connecting to a DB instance running the Microsoft SQL Server database engine](USER_ConnectToMicrosoftSQLServerInstance.md) -+ [Connecting to a DB instance running the MySQL database engine](USER_ConnectToInstance.md) -+ [Connecting to your RDS for Oracle DB instance](USER_ConnectToOracleInstance.md) -+ [Connecting to a DB instance running the PostgreSQL database engine](USER_ConnectToPostgreSQLInstance.md) - -## Managing connections with RDS Proxy - -You can also use Amazon RDS Proxy to manage connections to RDS for MariaDB, RDS for Microsoft SQL Server, RDS for MySQL, and RDS for PostgreSQL DB instances\. RDS Proxy allows applications to pool and share database connections to improve scalability\. For more information, see [Using Amazon RDS Proxy](rds-proxy.md)\. \ No newline at end of file diff --git a/doc_source/CHAP_CommonTasks.Create.md b/doc_source/CHAP_CommonTasks.Create.md deleted file mode 100644 index 6bb5860..0000000 --- a/doc_source/CHAP_CommonTasks.Create.md +++ /dev/null @@ -1,10 +0,0 @@ -# Creating an Amazon RDS DB Instance - -The basic building block of Amazon RDS is the DB instance\. You choose the engine\-specific characteristics of the DB instance when you create it\. You also choose the capacity of storage, CPU, memory, and so on of the AWS instance on which the database server runs\. - -To create an Amazon RDS DB instance, follow the instructions for your specific database engine: -+ [Creating a DB Instance Running the MariaDB Database Engine](USER_CreateMariaDBInstance.md) -+ [Creating a DB Instance Running the Microsoft SQL Server Database Engine](USER_CreateMicrosoftSQLServerInstance.md) -+ [Creating a DB Instance Running the MySQL Database Engine](USER_CreateInstance.md) -+ [Creating a DB Instance Running the Oracle Database Engine](USER_CreateOracleInstance.md) -+ [Creating a DB Instance Running the PostgreSQL Database Engine](USER_CreatePostgreSQLInstance.md) \ No newline at end of file diff --git a/doc_source/CHAP_CommonTasks.md b/doc_source/CHAP_CommonTasks.md deleted file mode 100644 index b01c99e..0000000 --- a/doc_source/CHAP_CommonTasks.md +++ /dev/null @@ -1,15 +0,0 @@ -# Amazon RDS DB Instance Lifecycle - -The lifecycle of an Amazon RDS DB instance includes creating, modifying, maintaining and upgrading, performing backups and restores, rebooting, and deleting the instance\. This section provides information on and links to more about these processes\. - -**Topics** -+ [Creating an Amazon RDS DB Instance](CHAP_CommonTasks.Create.md) -+ [Connecting to an Amazon RDS DB Instance](CHAP_CommonTasks.Connect.md) -+ [Modifying an Amazon RDS DB Instance](Overview.DBInstance.Modifying.md) -+ [Maintaining a DB Instance](USER_UpgradeDBInstance.Maintenance.md) -+ [Upgrading a DB Instance Engine Version](USER_UpgradeDBInstance.Upgrading.md) -+ [Renaming a DB Instance](USER_RenameInstance.md) -+ [Rebooting a DB Instance](USER_RebootInstance.md) -+ [Stopping an Amazon RDS DB Instance Temporarily](USER_StopInstance.md) -+ [Starting an Amazon RDS DB Instance That Was Previously Stopped](USER_StartInstance.md) -+ [Deleting a DB Instance](USER_DeleteInstance.md) \ No newline at end of file diff --git a/doc_source/CHAP_GettingStarted.CreatingConnecting.MariaDB.md b/doc_source/CHAP_GettingStarted.CreatingConnecting.MariaDB.md deleted file mode 100644 index 0424585..0000000 --- a/doc_source/CHAP_GettingStarted.CreatingConnecting.MariaDB.md +++ /dev/null @@ -1,260 +0,0 @@ -# Creating and connecting to a MariaDB DB instance - -This tutorial creates an EC2 instance and an RDS for MariaDB DB instance\. The tutorial shows you how to access the DB instance from the EC2 instance using a standard MySQL client\. As a best practice, this tutorial creates a private DB instance in a virtual private cloud \(VPC\)\. In most cases, other resources in the same VPC, such as EC2 instances, can access the DB instance, but resources outside of the VPC can't access it\. - -After you complete the tutorial, there is a public and private subnet in each Availability Zone in your VPC\. In one Availability Zone, the EC2 instance is in the public subnet, and the DB instance is in the private subnet\. - -**Important** -There's no charge for creating an AWS account\. However, by completing this tutorial, you might incur costs for the AWS resources you use\. You can delete these resources after you complete the tutorial if they are no longer needed\. - -The following diagram shows the configuration when the tutorial is complete\. - -![\[EC2 instance and MariaDB DB instance.\]](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/images/getting-started-mariadb.png) - -This tutorial uses **Easy create** to create a DB instance running MariaDB with the AWS Management Console\. With **Easy create**, you specify only the DB engine type, DB instance size, and DB instance identifier\. **Easy create** uses the default settings for the other configuration options\. The DB instance created by **Easy create** is private\. - -When you use **Standard create** instead of **Easy create**, you can specify more configuration options when you create a DB instance, including ones for availability, security, backups, and maintenance\. To create a public DB instance, you must use **Standard create**\. For information about creating DB instances with **Standard create**, see [Creating an Amazon RDS DB instance](USER_CreateDBInstance.md)\. - -**Topics** -+ [Prerequisites](#CHAP_GettingStarted.Prerequisites.MariaDB) -+ [Step 1: Create an EC2 instance](#CHAP_GettingStarted.Creating.MariaDB.EC2) -+ [Step 2: Create a MariaDB DB instance](#CHAP_GettingStarted.Creating.MariaDB) -+ [Step 3: Connect to a MariaDB DB instance](#CHAP_GettingStarted.Connecting.MariaDB) -+ [Step 4: Delete the EC2 instance and DB instance](#CHAP_GettingStarted.Deleting.MariaDB) - -## Prerequisites - -Before you begin, complete the steps in the following sections: -+ [Sign up for an AWS account](CHAP_SettingUp.md#sign-up-for-aws) -+ [Create an administrative user](CHAP_SettingUp.md#create-an-admin) - -## Step 1: Create an EC2 instance - -Create an Amazon EC2 instance that you will use to connect to your database\. - -**To create an EC2 instance** - -1. Sign in to the AWS Management Console and open the Amazon EC2 console at [https://console\.aws\.amazon\.com/ec2/](https://console.aws.amazon.com/ec2/)\. - -1. In the upper\-right corner of the AWS Management Console, choose the AWS Region in which you want to create the EC2 instance\. - -1. Choose **EC2 Dashboard**, and then choose **Launch instance**, as shown in the following image\. -![\[EC2 Dashboard.\]](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/images/Tutorial_WebServer_11.png) - - The **Launch an instance** page opens\. - -1. Choose the following settings on the **Launch an instance** page\. - - 1. Under **Name and tags**, for **Name**, enter **ec2\-database\-connect**\. - - 1. Under **Application and OS Images \(Amazon Machine Image\)**, choose **Amazon Linux**, and then choose the **Amazon Linux 2023 AMI**\. Keep the default selections for the other choices\. -![\[Choose an Amazon Machine Image.\]](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/images/Tutorial_WebServer_12.png) - - 1. Under **Instance type**, choose **t2\.micro**\. - - 1. Under **Key pair \(login\)**, choose a **Key pair name** to use an existing key pair\. To create a new key pair for the Amazon EC2 instance, choose **Create new key pair** and then use the **Create key pair** window to create it\. - - For more information about creating a new key pair, see [Create a key pair](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/get-set-up-for-amazon-ec2.html#create-a-key-pair) in the *Amazon EC2 User Guide for Linux Instances*\. - - 1. For **Allow SSH traffic** in **Network settings**, choose the source of SSH connections to the EC2 instance\. - - You can choose **My IP** if the displayed IP address is correct for SSH connections\. Otherwise, you can determine the IP address to use to connect to EC2 instances in your VPC using Secure Shell \(SSH\)\. To determine your public IP address, in a different browser window or tab, you can use the service at [https://checkip\.amazonaws\.com](https://checkip.amazonaws.com/)\. An example of an IP address is 192\.0\.2\.1/32\. - - In many cases, you might connect through an internet service provider \(ISP\) or from behind your firewall without a static IP address\. If so, make sure to determine the range of IP addresses used by client computers\. -**Warning** -If you use `0.0.0.0/0` for SSH access, you make it possible for all IP addresses to access your public EC2 instances using SSH\. This approach is acceptable for a short time in a test environment, but it's unsafe for production environments\. In production, authorize only a specific IP address or range of addresses to access your EC2 instances using SSH\. - - The following image shows an example of the **Network settings** section\. -![\[Network settings for an EC2 instance.\]](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/images/EC2_RDS_Connect_NtwkSettings.png) - - 1. Leave the default values for the remaining sections\. - - 1. Review a summary of your EC2 instance configuration in the **Summary** panel, and when you're ready, choose **Launch instance**\. - -1. On the **Launch Status** page, note the identifier for your new EC2 instance, for example: `i-1234567890abcdef0`\. -![\[EC2 instance identifier on Launch Status page.\]](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/images/getting-started-ec2-id.png) - -1. Choose the EC2 instance identifier to open the list of EC2 instances, and then select your EC2 instance\. - -1. In the **Details** tab, note the following values, which you need when you connect using SSH: - - 1. In **Instance summary**, note the value for **Public IPv4 DNS**\. -![\[EC2 public DNS name on Details tab of Instances page.\]](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/images/easy-create-ec2-public-dns.png) - - 1. In **Instance details**, note the value for **Key pair name**\. -![\[EC2 key pair name on Details tab of Instance page.\]](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/images/easy-create-ec2-key-pair.png) - -1. Wait until the **Instance state** for your EC2 instance has a status of **Running** before continuing\. - -## Step 2: Create a MariaDB DB instance - -The basic building block of Amazon RDS is the DB instance\. This environment is where you run your MariaDB databases\. - -In this example, you use **Easy create** to create a DB instance running the MariaDB database engine with a db\.t3\.micro DB instance class\. - -**To create a MariaDB DB instance with Easy create** - -1. Sign in to the AWS Management Console and open the Amazon RDS console at [https://console\.aws\.amazon\.com/rds/](https://console.aws.amazon.com/rds/)\. - -1. In the upper\-right corner of the Amazon RDS console, choose the AWS Region in which you want to create the DB instance\. - -1. In the navigation pane, choose **Databases**\. - -1. Choose **Create database** and make sure that **Easy create** is chosen\. -![\[Easy create option.\]](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/images/easy-create-option.png) - -1. In **Configuration**, choose **MariaDB**\. - -1. For **DB instance size**, choose **Free tier**\. - -1. For **DB instance identifier**, enter **database\-test1**\. - -1. For **Master username**, enter a name for the master user, or keep the default name\. - - The **Create database** page should look similar to the following image\. -![\[Create database page.\]](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/images/easy-create-mariadb.png) - -1. To use an automatically generated master password for the DB instance, select **Auto generate a password**\. - - To enter your master password, make sure **Auto generate a password** is cleared, and then enter the same password in **Master password** and **Confirm password**\. - -1. To set up a connection with the EC2 instance you created previously, open **Set up EC2 connection \- *optional***\. - - Select **Connect to an EC2 compute resource**\. Choose the EC2 instance you created previously\. -![\[Set up EC2 connection option.\]](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/images/EC2_RDS_Setup_Conn-EasyCreate.png) - -1. Open **View default settings for Easy create**\. -![\[Easy create default settings.\]](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/images/easy-create-view-default-maria.png) - - You can examine the default settings used with **Easy create**\. The **Editable after database is created** column shows which options you can change after you create the database\. - + If a setting has **No** in that column, and you want a different setting, you can use **Standard create** to create the DB instance\. - + If a setting has **Yes** in that column, and you want a different setting, you can either use **Standard create** to create the DB instance, or modify the DB instance after you create it to change the setting\. - -1. Choose **Create database**\. - - To view the master username and password for the DB instance, choose **View credential details**\. - - You can use the username and password that appears to connect to the DB instance as the master user\. -**Important** -You can't view the master user password again\. If you don't record it, you might have to change it\. -If you need to change the master user password after the DB instance is available, you can modify the DB instance to do so\. For more information about modifying a DB instance, see [Modifying an Amazon RDS DB instance](Overview.DBInstance.Modifying.md)\. - -1. In the **Databases** list, choose the name of the new MariaDB DB instance to show its details\. - - The DB instance has a status of **Creating** until it is ready to use\. -![\[DB instance details.\]](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/images/MariaDB-Launch06.png) - - When the status changes to **Available**, you can connect to the DB instance\. Depending on the DB instance class and the amount of storage, it can take up to 20 minutes before the new instance is available\. - -## Step 3: Connect to a MariaDB DB instance - -You can use any standard SQL client application to connect to the DB instance\. In this example, you connect to a MariaDB DB instance using the mysql command\-line client\. - -**To connect to a MariaDB DB instance** - -1. Find the endpoint \(DNS name\) and port number for your DB instance\. - - 1. Sign in to the AWS Management Console and open the Amazon RDS console at [https://console\.aws\.amazon\.com/rds/](https://console.aws.amazon.com/rds/)\. - - 1. In the upper\-right corner of the Amazon RDS console, choose the AWS Region for the DB instance\. - - 1. In the navigation pane, choose **Databases**\. - - 1. Choose the MariaDB DB instance name to display its details\. - - 1. On the **Connectivity & security** tab, copy the endpoint\. Also note the port number\. You need both the endpoint and the port number to connect to the DB instance\. -![\[Connect to a MariaDB DB instance.\]](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/images/MariaDBConnect1.png) - -1. Connect to the EC2 instance that you created earlier by following the steps in [Connect to your Linux instance](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/AccessingInstances.html) in the *Amazon EC2 User Guide for Linux Instances*\. - - We recommend that you connect to your EC2 instance using SSH\. If the SSH client utility is installed on Windows, Linux, or Mac, you can connect to the instance using the following command format: - - ``` - ssh -i location_of_pem_file ec2-user@ec2-instance-public-dns-name - ``` - - For example, assume that `ec2-database-connect-key-pair.pem` is stored in `/dir1` on Linux, and the public IPv4 DNS for your EC2 instance is `ec2-12-345-678-90.compute-1.amazonaws.com`\. Your SSH command would look as follows: - - ``` - ssh -i /dir1/ec2-database-connect-key-pair.pem ec2-user@ec2-12-345-678-90.compute-1.amazonaws.com - ``` - -1. Get the latest bug fixes and security updates by updating the software on your EC2 instance\. To do this, use the following command\. -**Note** -The `-y` option installs the updates without asking for confirmation\. To examine updates before installing, omit this option\. - - ``` - sudo dnf update -y - ``` - -1. Install the mysql command\-line client from MariaDB\. - - To install the MariaDB command\-line client on Amazon Linux 2023, run the following command: - - ``` - sudo dnf install mariadb105 - ``` - -1. Connect to the MariaDB DB instance\. For example, enter the following command\. This action lets you connect to the MariaDB DB instance using the MySQL client\. - - Substitute the DB instance endpoint \(DNS name\) for `endpoint`, and substitute the master username that you used for `admin`\. Provide the master password that you used when prompted for a password\. - - ``` - mysql -h endpoint -P 3306 -u admin -p - ``` - - After you enter the password for the user, you should see output similar to the following\. - - ``` - Welcome to the MariaDB monitor. Commands end with ; or \g. - Your MariaDB connection id is 156 - Server version: 10.6.10-MariaDB-log managed by https://aws.amazon.com/rds/ - - Copyright (c) 2000, 2018, Oracle, MariaDB Corporation Ab and others. - - Type 'help;' or '\h' for help. Type '\c' to clear the current input statement. - - MariaDB [(none)]> - ``` - - For more information about connecting to a MariaDB DB instance, see [Connecting to a DB instance running the MariaDB database engine](USER_ConnectToMariaDBInstance.md)\. If you can't connect to your DB instance, see [Can't connect to Amazon RDS DB instance](CHAP_Troubleshooting.md#CHAP_Troubleshooting.Connecting)\. - - For security, it is a best practice to use encrypted connections\. Only use an unencrypted MariaDB connection when the client and server are in the same VPC and the network is trusted\. For information about using encrypted connections, see [Connecting from the MySQL command\-line client with SSL/TLS \(encrypted\)](mariadb-ssl-connections.md#USER_ConnectToMariaDBInstanceSSL.CLI)\. - -1. Run SQL commands\. - - For example, the following SQL command shows the current date and time: - - ``` - SELECT CURRENT_TIMESTAMP; - ``` - -## Step 4: Delete the EC2 instance and DB instance - -After you connect to and explore the sample EC2 instance and DB instance that you created, delete them so you're no longer charged for them\. - -**To delete the EC2 instance** - -1. Sign in to the AWS Management Console and open the Amazon EC2 console at [https://console\.aws\.amazon\.com/ec2/](https://console.aws.amazon.com/ec2/)\. - -1. In the navigation pane, choose **Instances**\. - -1. Select the EC2 instance, and choose **Instance state, Terminate instance**\. - -1. Choose **Terminate** when prompted for confirmation\. - -For more information about deleting an EC2 instance, see [Terminate your instance](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/terminating-instances.html) in the *Amazon EC2 User Guide for Linux Instances*\. - -**To delete the DB instance with no final DB snapshot** - -1. Sign in to the AWS Management Console and open the Amazon RDS console at [https://console\.aws\.amazon\.com/rds/](https://console.aws.amazon.com/rds/)\. - -1. In the navigation pane, choose **Databases**\. - -1. Choose the DB instance you want to delete\. - -1. For **Actions**, choose **Delete**\. - -1. Clear **Create final snapshot?** and **Retain automated backups**\. - -1. Complete the acknowledgement and choose **Delete**\. \ No newline at end of file diff --git a/doc_source/CHAP_GettingStarted.CreatingConnecting.MySQL.md b/doc_source/CHAP_GettingStarted.CreatingConnecting.MySQL.md deleted file mode 100644 index 51b3449..0000000 --- a/doc_source/CHAP_GettingStarted.CreatingConnecting.MySQL.md +++ /dev/null @@ -1,258 +0,0 @@ -# Creating and connecting to a MySQL DB instance - -This tutorial creates an EC2 instance and an RDS for MySQL DB instance\. The tutorial shows you how to access the DB instance from the EC2 instance using a standard MySQL client\. As a best practice, this tutorial creates a private DB instance in a virtual private cloud \(VPC\)\. In most cases, other resources in the same VPC, such as EC2 instances, can access the DB instance, but resources outside of the VPC can't access it\. - -After you complete the tutorial, there is a public and private subnet in each Availability Zone in your VPC\. In one Availability Zone, the EC2 instance is in the public subnet, and the DB instance is in the private subnet\. - -**Important** -There's no charge for creating an AWS account\. However, by completing this tutorial, you might incur costs for the AWS resources you use\. You can delete these resources after you complete the tutorial if they are no longer needed\. - -The following diagram shows the configuration when the tutorial is complete\. - -![\[EC2 instance and MySQL DB instance.\]](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/images/getting-started-mysql.png) - -This tutorial uses **Easy create** to create a DB instance running MySQL with the AWS Management Console\. With **Easy create**, you specify only the DB engine type, DB instance size, and DB instance identifier\. **Easy create** uses the default settings for the other configuration options\. The DB instance created by **Easy create** is private\. - -When you use **Standard create** instead of **Easy create**, you can specify more configuration options when you create a DB instance, including ones for availability, security, backups, and maintenance\. To create a public DB instance, you must use **Standard create**\. For information about creating DB instances with **Standard create**, see [Creating an Amazon RDS DB instance](USER_CreateDBInstance.md)\. - -**Topics** -+ [Prerequisites](#CHAP_GettingStarted.Prerequisites.MySQL) -+ [Step 1: Create an EC2 instance](#CHAP_GettingStarted.Creating.MySQL.EC2) -+ [Step 2: Create a MySQL DB instance](#CHAP_GettingStarted.Creating.MySQL) -+ [Step 3: Connect to a MySQL DB instance](#CHAP_GettingStarted.Connecting.MySQL) -+ [Step 4: Delete the EC2 instance and DB instance](#CHAP_GettingStarted.Deleting.MySQL) - -## Prerequisites - -Before you begin, complete the steps in the following sections: -+ [Sign up for an AWS account](CHAP_SettingUp.md#sign-up-for-aws) -+ [Create an administrative user](CHAP_SettingUp.md#create-an-admin) - -## Step 1: Create an EC2 instance - -Create an Amazon EC2 instance that you will use to connect to your database\. - -**To create an EC2 instance** - -1. Sign in to the AWS Management Console and open the Amazon EC2 console at [https://console\.aws\.amazon\.com/ec2/](https://console.aws.amazon.com/ec2/)\. - -1. In the upper\-right corner of the AWS Management Console, choose the AWS Region in which you want to create the EC2 instance\. - -1. Choose **EC2 Dashboard**, and then choose **Launch instance**, as shown in the following image\. -![\[EC2 Dashboard.\]](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/images/Tutorial_WebServer_11.png) - - The **Launch an instance** page opens\. - -1. Choose the following settings on the **Launch an instance** page\. - - 1. Under **Name and tags**, for **Name**, enter **ec2\-database\-connect**\. - - 1. Under **Application and OS Images \(Amazon Machine Image\)**, choose **Amazon Linux**, and then choose the **Amazon Linux 2023 AMI**\. Keep the default selections for the other choices\. -![\[Choose an Amazon Machine Image.\]](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/images/Tutorial_WebServer_12.png) - - 1. Under **Instance type**, choose **t2\.micro**\. - - 1. Under **Key pair \(login\)**, choose a **Key pair name** to use an existing key pair\. To create a new key pair for the Amazon EC2 instance, choose **Create new key pair** and then use the **Create key pair** window to create it\. - - For more information about creating a new key pair, see [Create a key pair](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/get-set-up-for-amazon-ec2.html#create-a-key-pair) in the *Amazon EC2 User Guide for Linux Instances*\. - - 1. For **Allow SSH traffic** in **Network settings**, choose the source of SSH connections to the EC2 instance\. - - You can choose **My IP** if the displayed IP address is correct for SSH connections\. Otherwise, you can determine the IP address to use to connect to EC2 instances in your VPC using Secure Shell \(SSH\)\. To determine your public IP address, in a different browser window or tab, you can use the service at [https://checkip\.amazonaws\.com](https://checkip.amazonaws.com/)\. An example of an IP address is 192\.0\.2\.1/32\. - - In many cases, you might connect through an internet service provider \(ISP\) or from behind your firewall without a static IP address\. If so, make sure to determine the range of IP addresses used by client computers\. -**Warning** -If you use `0.0.0.0/0` for SSH access, you make it possible for all IP addresses to access your public EC2 instances using SSH\. This approach is acceptable for a short time in a test environment, but it's unsafe for production environments\. In production, authorize only a specific IP address or range of addresses to access your EC2 instances using SSH\. - - The following image shows an example of the **Network settings** section\. -![\[Network settings for an EC2 instance.\]](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/images/EC2_RDS_Connect_NtwkSettings.png) - - 1. Leave the default values for the remaining sections\. - - 1. Review a summary of your EC2 instance configuration in the **Summary** panel, and when you're ready, choose **Launch instance**\. - -1. On the **Launch Status** page, note the identifier for your new EC2 instance, for example: `i-1234567890abcdef0`\. -![\[EC2 instance identifier on Launch Status page.\]](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/images/getting-started-ec2-id.png) - -1. Choose the EC2 instance identifier to open the list of EC2 instances, and then select your EC2 instance\. - -1. In the **Details** tab, note the following values, which you need when you connect using SSH: - - 1. In **Instance summary**, note the value for **Public IPv4 DNS**\. -![\[EC2 public DNS name on Details tab of Instances page.\]](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/images/easy-create-ec2-public-dns.png) - - 1. In **Instance details**, note the value for **Key pair name**\. -![\[EC2 key pair name on Details tab of Instance page.\]](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/images/easy-create-ec2-key-pair.png) - -1. Wait until the **Instance state** for your EC2 instance has a status of **Running** before continuing\. - -## Step 2: Create a MySQL DB instance - -The basic building block of Amazon RDS is the DB instance\. This environment is where you run your MySQL databases\. - -In this example, you use **Easy create** to create a DB instance running the MySQL database engine with a db\.t3\.micro DB instance class\. - -**To create a MySQL DB instance with Easy create** - -1. Sign in to the AWS Management Console and open the Amazon RDS console at [https://console\.aws\.amazon\.com/rds/](https://console.aws.amazon.com/rds/)\. - -1. In the upper\-right corner of the Amazon RDS console, choose the AWS Region you used for the EC2 instance previously\. - -1. In the navigation pane, choose **Databases**\. - -1. Choose **Create database** and make sure that **Easy create** is chosen\. -![\[Easy create option.\]](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/images/easy-create-option.png) - -1. In **Configuration**, choose **MySQL**\. - -1. For **DB instance size**, choose **Free tier**\. - -1. For **DB instance identifier**, enter **database\-test1**\. - -1. For **Master username**, enter a name for the master user, or keep the default name\. - - The **Create database** page should look similar to the following image\. -![\[Create database page.\]](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/images/easy-create-mysql.png) - -1. To use an automatically generated master password for the DB instance, select **Auto generate a password**\. - - To enter your master password, make sure **Auto generate a password** is cleared, and then enter the same password in **Master password** and **Confirm password**\. - -1. To set up a connection with the EC2 instance you created previously, open **Set up EC2 connection \- *optional***\. - - Select **Connect to an EC2 compute resource**\. Choose the EC2 instance you created previously\. -![\[Set up EC2 connection option.\]](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/images/EC2_RDS_Setup_Conn-EasyCreate.png) - -1. \(Optional\) Open **View default settings for Easy create**\. -![\[Easy create default settings.\]](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/images/easy-create-view-default-mysql.png) - - You can examine the default settings used with **Easy create**\. The **Editable after database is created** column shows which options you can change after you create the database\. - + If a setting has **No** in that column, and you want a different setting, you can use **Standard create** to create the DB instance\. - + If a setting has **Yes** in that column, and you want a different setting, you can either use **Standard create** to create the DB instance, or modify the DB instance after you create it to change the setting\. - -1. Choose **Create database**\. - - To view the master username and password for the DB instance, choose **View credential details**\. - - You can use the username and password that appears to connect to the DB instance as the master user\. -**Important** -You can't view the master user password again\. If you don't record it, you might have to change it\. -If you need to change the master user password after the DB instance is available, you can modify the DB instance to do so\. For more information about modifying a DB instance, see [Modifying an Amazon RDS DB instance](Overview.DBInstance.Modifying.md)\. - -1. In the **Databases** list, choose the name of the new MySQL DB instance to show its details\. - - The DB instance has a status of **Creating** until it is ready to use\. -![\[DB instance details.\]](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/images/MySQL-Launch06.png) - - When the status changes to **Available**, you can connect to the DB instance\. Depending on the DB instance class and the amount of storage, it can take up to 20 minutes before the new instance is available\. - -## Step 3: Connect to a MySQL DB instance - -You can use any standard SQL client application to connect to the DB instance\. In this example, you connect to a MySQL DB instance using the mysql command\-line client\. - -**To connect to a MySQL DB instance** - -1. Find the endpoint \(DNS name\) and port number for your DB instance\. - - 1. Sign in to the AWS Management Console and open the Amazon RDS console at [https://console\.aws\.amazon\.com/rds/](https://console.aws.amazon.com/rds/)\. - - 1. In the upper\-right corner of the Amazon RDS console, choose the AWS Region for the DB instance\. - - 1. In the navigation pane, choose **Databases**\. - - 1. Choose the MySQL DB instance name to display its details\. - - 1. On the **Connectivity & security** tab, copy the endpoint\. Also, note the port number\. You need both the endpoint and the port number to connect to the DB instance\. -![\[Connect to a MySQL DB instance.\]](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/images/MySQLConnect1.png) - -1. Connect to the EC2 instance that you created earlier by following the steps in [Connect to your Linux instance](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/AccessingInstances.html) in the *Amazon EC2 User Guide for Linux Instances*\. - - We recommend that you connect to your EC2 instance using SSH\. If the SSH client utility is installed on Windows, Linux, or Mac, you can connect to the instance using the following command format: - - ``` - ssh -i location_of_pem_file ec2-user@ec2-instance-public-dns-name - ``` - - For example, assume that `ec2-database-connect-key-pair.pem` is stored in `/dir1` on Linux, and the public IPv4 DNS for your EC2 instance is `ec2-12-345-678-90.compute-1.amazonaws.com`\. Your SSH command would look as follows: - - ``` - ssh -i /dir1/ec2-database-connect-key-pair.pem ec2-user@ec2-12-345-678-90.compute-1.amazonaws.com - ``` - -1. Get the latest bug fixes and security updates by updating the software on your EC2 instance\. To do this, use the following command\. -**Note** -The `-y` option installs the updates without asking for confirmation\. To examine updates before installing, omit this option\. - - ``` - sudo dnf update -y - ``` - -1. To install the mysql command\-line client from MariaDB on Amazon Linux 2023, run the following command: - - ``` - sudo dnf install mariadb105 - ``` - -1. Connect to the MySQL DB instance\. For example, enter the following command\. This action lets you connect to the MySQL DB instance using the MySQL client\. - - Substitute the DB instance endpoint \(DNS name\) for `endpoint`, and substitute the master username that you used for `admin`\. Provide the master password that you used when prompted for a password\. - - ``` - mysql -h endpoint -P 3306 -u admin -p - ``` - - After you enter the password for the user, you should see output similar to the following\. - - ``` - Welcome to the MariaDB monitor. Commands end with ; or \g. - Your MySQL connection id is 3082 - Server version: 8.0.28 Source distribution - - Copyright (c) 2000, 2018, Oracle, MariaDB Corporation Ab and others. - - Type 'help;' or '\h' for help. Type '\c' to clear the current input statement. - - MySQL [(none)]> - ``` - - For more information about connecting to a MySQL DB instance, see [Connecting to a DB instance running the MySQL database engine](USER_ConnectToInstance.md)\. If you can't connect to your DB instance, see [Can't connect to Amazon RDS DB instance](CHAP_Troubleshooting.md#CHAP_Troubleshooting.Connecting)\. - - For security, it is a best practice to use encrypted connections\. Only use an unencrypted MySQL connection when the client and server are in the same VPC and the network is trusted\. For information about using encrypted connections, see [Connecting from the MySQL command\-line client with SSL/TLS \(encrypted\)](mysql-ssl-connections.md#USER_ConnectToInstanceSSL.CLI)\. - -1. Run SQL commands\. - - For example, the following SQL command shows the current date and time: - - ``` - SELECT CURRENT_TIMESTAMP; - ``` - -## Step 4: Delete the EC2 instance and DB instance - -After you connect to and explore the sample EC2 instance and DB instance that you created, delete them so you're no longer charged for them\. - -**To delete the EC2 instance** - -1. Sign in to the AWS Management Console and open the Amazon EC2 console at [https://console\.aws\.amazon\.com/ec2/](https://console.aws.amazon.com/ec2/)\. - -1. In the navigation pane, choose **Instances**\. - -1. Select the EC2 instance, and choose **Instance state, Terminate instance**\. - -1. Choose **Terminate** when prompted for confirmation\. - -For more information about deleting an EC2 instance, see [Terminate your instance](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/terminating-instances.html) in the *Amazon EC2 User Guide for Linux Instances*\. - -**To delete the DB instance with no final DB snapshot** - -1. Sign in to the AWS Management Console and open the Amazon RDS console at [https://console\.aws\.amazon\.com/rds/](https://console.aws.amazon.com/rds/)\. - -1. In the navigation pane, choose **Databases**\. - -1. Choose the DB instance that you want to delete\. - -1. For **Actions**, choose **Delete**\. - -1. Clear **Create final snapshot?** and **Retain automated backups**\. - -1. Complete the acknowledgement and choose **Delete**\. \ No newline at end of file diff --git a/doc_source/CHAP_GettingStarted.CreatingConnecting.Oracle.md b/doc_source/CHAP_GettingStarted.CreatingConnecting.Oracle.md deleted file mode 100644 index 47274f5..0000000 --- a/doc_source/CHAP_GettingStarted.CreatingConnecting.Oracle.md +++ /dev/null @@ -1,275 +0,0 @@ -# Creating and connecting to an Oracle DB instance - -This tutorial creates an EC2 instance and an RDS for Oracle DB instance\. The tutorial shows you how to access the DB instance from the EC2 instance using a standard Oracle client\. As a best practice, this tutorial creates a private DB instance in a virtual private cloud \(VPC\)\. In most cases, other resources in the same VPC, such as EC2 instances, can access the DB instance, but resources outside of the VPC can't access it\. - -After you complete the tutorial, there is a public and private subnet in each Availability Zone in your VPC\. In one Availability Zone, the EC2 instance is in the public subnet, and the DB instance is in the private subnet\. - -**Important** -There's no charge for creating an AWS account\. However, by completing this tutorial, you might incur costs for the AWS resources you use\. You can delete these resources after you complete the tutorial if they are no longer needed\. - -The following diagram shows the configuration when the tutorial is complete\. - -![\[EC2 instance and Oracle DB instance.\]](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/images/getting-started-oracle.png) - -This tutorial uses **Easy create** to create a DB instance running Oracle with the AWS Management Console\. With **Easy create**, you specify only the DB engine type, DB instance size, and DB instance identifier\. **Easy create** uses the default settings for the other configuration options\. The DB instance created by **Easy create** is private\. - -When you use **Standard create** instead of **Easy create**, you can specify more configuration options when you create a DB instance, including ones for availability, security, backups, and maintenance\. To create a public DB instance, you must use **Standard create**\. For information about creating DB instances with **Standard create**, see [Creating an Amazon RDS DB instance](USER_CreateDBInstance.md)\. - -**Topics** -+ [Prerequisites](#CHAP_GettingStarted.Prerequisites.Oracle) -+ [Step 1: Create an EC2 instance](#CHAP_GettingStarted.Creating.Oracle.EC2) -+ [Step 2: Create an Oracle DB instance](#CHAP_GettingStarted.Creating.Oracle) -+ [Step 3: Connect your SQL client to an Oracle DB instance](#CHAP_GettingStarted.Connecting.Oracle) -+ [Step 4: Delete the EC2 instance and DB instance](#CHAP_GettingStarted.Deleting.Oracle) - -## Prerequisites - -Before you begin, complete the steps in the following sections: -+ [Sign up for an AWS account](CHAP_SettingUp.md#sign-up-for-aws) -+ [Create an administrative user](CHAP_SettingUp.md#create-an-admin) - -## Step 1: Create an EC2 instance - -Create an Amazon EC2 instance that you will use to connect to your database\. - -**To create an EC2 instance** - -1. Sign in to the AWS Management Console and open the Amazon EC2 console at [https://console\.aws\.amazon\.com/ec2/](https://console.aws.amazon.com/ec2/)\. - -1. In the upper\-right corner of the AWS Management Console, choose the AWS Region in which you want to create the EC2 instance\. - -1. Choose **EC2 Dashboard**, and then choose **Launch instance**, as shown in the following image\. -![\[EC2 Dashboard.\]](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/images/Tutorial_WebServer_11.png) - - The **Launch an instance** page opens\. - -1. Choose the following settings on the **Launch an instance** page\. - - 1. Under **Name and tags**, for **Name**, enter **ec2\-database\-connect**\. - - 1. Under **Application and OS Images \(Amazon Machine Image\)**, choose **Amazon Linux**, and then choose the **Amazon Linux 2023 AMI**\. Keep the default selections for the other choices\. -![\[Choose an Amazon Machine Image.\]](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/images/Tutorial_WebServer_12.png) - - 1. Under **Instance type**, choose **t2\.micro**\. - - 1. Under **Key pair \(login\)**, choose a **Key pair name** to use an existing key pair\. To create a new key pair for the Amazon EC2 instance, choose **Create new key pair** and then use the **Create key pair** window to create it\. - - For more information about creating a new key pair, see [Create a key pair](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/get-set-up-for-amazon-ec2.html#create-a-key-pair) in the *Amazon EC2 User Guide for Linux Instances*\. - - 1. For **Allow SSH traffic** in **Network settings**, choose the source of SSH connections to the EC2 instance\. - - You can choose **My IP** if the displayed IP address is correct for SSH connections\. Otherwise, you can determine the IP address to use to connect to EC2 instances in your VPC using Secure Shell \(SSH\)\. To determine your public IP address, in a different browser window or tab, you can use the service at [https://checkip\.amazonaws\.com](https://checkip.amazonaws.com/)\. An example of an IP address is 192\.0\.2\.1/32\. - - In many cases, you might connect through an internet service provider \(ISP\) or from behind your firewall without a static IP address\. If so, make sure to determine the range of IP addresses used by client computers\. -**Warning** -If you use `0.0.0.0/0` for SSH access, you make it possible for all IP addresses to access your public EC2 instances using SSH\. This approach is acceptable for a short time in a test environment, but it's unsafe for production environments\. In production, authorize only a specific IP address or range of addresses to access your EC2 instances using SSH\. - - The following image shows an example of the **Network settings** section\. -![\[Network settings for an EC2 instance.\]](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/images/EC2_RDS_Connect_NtwkSettings.png) - - 1. Leave the default values for the remaining sections\. - - 1. Review a summary of your EC2 instance configuration in the **Summary** panel, and when you're ready, choose **Launch instance**\. - -1. On the **Launch Status** page, note the identifier for your new EC2 instance, for example: `i-1234567890abcdef0`\. -![\[EC2 instance identifier on Launch Status page.\]](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/images/getting-started-ec2-id.png) - -1. Choose the EC2 instance identifier to open the list of EC2 instances, and then select your EC2 instance\. - -1. In the **Details** tab, note the following values, which you need when you connect using SSH: - - 1. In **Instance summary**, note the value for **Public IPv4 DNS**\. -![\[EC2 public DNS name on Details tab of Instances page.\]](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/images/easy-create-ec2-public-dns.png) - - 1. In **Instance details**, note the value for **Key pair name**\. -![\[EC2 key pair name on Details tab of Instance page.\]](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/images/easy-create-ec2-key-pair.png) - -1. Wait until the **Instance state** for your EC2 instance has a status of **Running** before continuing\. - -## Step 2: Create an Oracle DB instance - -The basic building block of Amazon RDS is the DB instance\. This environment is where you run your Oracle databases\. - -In this example, you use **Easy create** to create a DB instance running the Oracle database engine with a db\.m5\.large DB instance class\. - -**To create an Oracle DB instance with Easy create** - -1. Sign in to the AWS Management Console and open the Amazon RDS console at [https://console\.aws\.amazon\.com/rds/](https://console.aws.amazon.com/rds/)\. - -1. In the upper\-right corner of the Amazon RDS console, choose the AWS Region in which you want to create the DB instance\. - -1. In the navigation pane, choose **Databases**\. - -1. Choose **Create database** and make sure that **Easy create** is chosen\. -![\[Easy create option.\]](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/images/easy-create-option.png) - -1. In **Configuration**, choose **Oracle**\. - -1. For **DB instance size**, choose **Dev/Test**\. - -1. For **DB instance identifier**, enter **database\-test1**\. - -1. For **Master username**, enter a name for the master user, or keep the default name\. - - The **Create database** page should look similar to the following image\. -![\[Create database page.\]](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/images/easy-create-oracle2.png) - -1. To use an automatically generated master password for the DB instance, select **Auto generate a password**\. - - To enter your master password, make sure **Auto generate a password** is cleared, and then enter the same password in **Master password** and **Confirm password**\. - -1. To set up a connection with the EC2 instance you created previously, open **Set up EC2 connection \- *optional***\. - - Select **Connect to an EC2 compute resource**\. Choose the EC2 instance you created previously\. -![\[Set up EC2 connection option.\]](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/images/EC2_RDS_Setup_Conn-EasyCreate.png) - -1. Open **View default settings for Easy create**\. -![\[Easy create default settings.\]](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/images/easy-create-view-default-Oracle.png) - - You can examine the default settings used with **Easy create**\. The **Editable after database is created** column shows which options you can change after you create the database\. - + If a setting has **No** in that column, and you want a different setting, you can use **Standard create** to create the DB instance\. - + If a setting has **Yes** in that column, and you want a different setting, you can either use **Standard create** to create the DB instance, or modify the DB instance after you create it to change the setting\. - -1. Choose **Create database**\. - - To view the master username and password for the DB instance, choose **View credential details**\. - - You can use the username and password that appears to connect to the DB instance as the master user\. -**Important** -You can't view the master user password again\. If you don't record it, you might have to change it\. -If you need to change the master user password after the DB instance is available, you can modify the DB instance to do so\. For more information about modifying a DB instance, see [Modifying an Amazon RDS DB instance](Overview.DBInstance.Modifying.md)\. - -1. In the **Databases** list, choose the name of the new Oracle DB instance to show its details\. - - The DB instance has a status of **Creating** until it is ready to use\. -![\[DB instance details.\]](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/images/Oracle-Launch05.png) - - When the status changes to **Available**, you can connect to the DB instance\. Depending on the DB instance class and the amount of storage, it can take up to 20 minutes before the new instance is available\. While the DB instance is being created, you can move on to the next step and create an EC2 instance\. - -## Step 3: Connect your SQL client to an Oracle DB instance - -You can use any standard SQL client application to connect to your DB instance\. In this example, you connect to an Oracle DB instance using the Oracle command\-line client\. - -**To connect to an Oracle DB instance** - -1. Find the endpoint \(DNS name\) and port number for your DB instance\. - - 1. Sign in to the AWS Management Console and open the Amazon RDS console at [https://console\.aws\.amazon\.com/rds/](https://console.aws.amazon.com/rds/)\. - - 1. In the upper\-right corner of the Amazon RDS console, choose the AWS Region for the DB instance\. - - 1. In the navigation pane, choose **Databases**\. - - 1. Choose the Oracle DB instance name to display its details\. - - 1. On the **Connectivity & security** tab, copy the endpoint\. Also, note the port number\. You need both the endpoint and the port number to connect to the DB instance\. -![\[Connect to an Oracle DB instance.\]](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/images/OracleConnect1.png) - -1. Connect to the EC2 instance that you created earlier by following the steps in [Connect to your Linux instance](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/AccessingInstances.html) in the *Amazon EC2 User Guide for Linux Instances*\. - - We recommend that you connect to your EC2 instance using SSH\. If the SSH client utility is installed on Windows, Linux, or Mac, you can connect to the instance using the following command format: - - ``` - ssh -i location_of_pem_file ec2-user@ec2-instance-public-dns-name - ``` - - For example, assume that `ec2-database-connect-key-pair.pem` is stored in `/dir1` on Linux, and the public IPv4 DNS for your EC2 instance is `ec2-12-345-678-90.compute-1.amazonaws.com`\. Your SSH command would look as follows: - - ``` - ssh -i /dir1/ec2-database-connect-key-pair.pem ec2-user@ec2-12-345-678-90.compute-1.amazonaws.com - ``` - -1. Get the latest bug fixes and security updates by updating the software on your EC2 instance\. To do so, use the following command\. -**Note** -The `-y` option installs the updates without asking for confirmation\. To examine updates before installing, omit this option\. - - ``` - sudo dnf update -y - ``` - -1. In a web browser, go to [https://www\.oracle\.com/database/technologies/instant\-client/linux\-x86\-64\-downloads\.html](https://www.oracle.com/database/technologies/instant-client/linux-x86-64-downloads.html)\. - -1. For the latest database version that appears on the web page, copy the \.rpm links \(not the \.zip links\) for the Instant Client Basic Package and SQL\*Plus Package\. For example, the following links are for Oracle Database version 21\.9: - + https://download\.oracle\.com/otn\_software/linux/instantclient/219000/oracle\-instantclient\-basic\-21\.9\.0\.0\.0\-1\.el8\.x86\_64\.rpm - + https://download\.oracle\.com/otn\_software/linux/instantclient/219000/oracle\-instantclient\-sqlplus\-21\.9\.0\.0\.0\-1\.el8\.x86\_64\.rpm - -1. In your SSH session, run the `wget` command to the download the \.rpm files from the links that you obtained in the previous step\. The following example downloads the \.rpm files for Oracle Database version 21\.9: - - ``` - wget https://download.oracle.com/otn_software/linux/instantclient/219000/oracle-instantclient-basic-21.9.0.0.0-1.el8.x86_64.rpm - wget https://download.oracle.com/otn_software/linux/instantclient/219000/oracle-instantclient-sqlplus-21.9.0.0.0-1.el8.x86_64.rpm - ``` - -1. Install the packages by running the `dnf` command as follows: - - ``` - sudo dnf install oracle-instantclient-*.rpm - ``` - -1. Start SQL\*Plus and connect to the Oracle DB instance\. For example, enter the following command\. - - Substitute the DB instance endpoint \(DNS name\) for `oracle-db-instance-endpoint` and substitute the master user name that you used for `admin`\. When you use **Easy create** for Oracle, the database name is `DATABASE`\. Provide the master password that you used when prompted for a password\. - - ``` - sqlplus admin@oracle-db-instance-endpoint:1521/DATABASE - ``` - - After you enter the password for the user, you should see output similar to the following\. - - ``` - SQL*Plus: Release 21.0.0.0.0 - Production on Wed Mar 1 16:41:28 2023 - Version 21.9.0.0.0 - - Copyright (c) 1982, 2022, Oracle. All rights reserved. - - Enter password: - Last Successful login time: Wed Mar 01 2023 16:30:52 +00:00 - - Connected to: - Oracle Database 19c Standard Edition 2 Release 19.0.0.0.0 - Production - Version 19.18.0.0.0 - - SQL> - ``` - - For more information about connecting to an RDS for Oracle DB instance, see [Connecting to your RDS for Oracle DB instance](USER_ConnectToOracleInstance.md)\. If you can't connect to your DB instance, see [Can't connect to Amazon RDS DB instance](CHAP_Troubleshooting.md#CHAP_Troubleshooting.Connecting)\. - - For security, it is a best practice to use encrypted connections\. Only use an unencrypted Oracle connection when the client and server are in the same VPC and the network is trusted\. For information about using encrypted connections, see [Securing Oracle DB instance connections](Oracle.Concepts.RestrictedDBAPrivileges.md)\. - -1. Run SQL commands\. - - For example, the following SQL command shows the current date: - - ``` - SELECT SYSDATE FROM DUAL; - ``` - -## Step 4: Delete the EC2 instance and DB instance - -After you connect to and explore the sample EC2 instance and DB instance that you created, delete them so you're no longer charged for them\. - -**To delete the EC2 instance** - -1. Sign in to the AWS Management Console and open the Amazon EC2 console at [https://console\.aws\.amazon\.com/ec2/](https://console.aws.amazon.com/ec2/)\. - -1. In the navigation pane, choose **Instances**\. - -1. Select the EC2 instance, and choose **Instance state, Terminate instance**\. - -1. Choose **Terminate** when prompted for confirmation\. - -For more information about deleting an EC2 instance, see [Terminate your instance](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/terminating-instances.html) in the *Amazon EC2 User Guide for Linux Instances*\. - -**To delete the DB instance with no final DB snapshot** - -1. Sign in to the AWS Management Console and open the Amazon RDS console at [https://console\.aws\.amazon\.com/rds/](https://console.aws.amazon.com/rds/)\. - -1. In the navigation pane, choose **Databases**\. - -1. Choose the DB instance that you want to delete\. - -1. For **Actions**, choose **Delete**\. - -1. Clear **Create final snapshot?** and **Retain automated backups**\. - -1. Complete the acknowledgement and choose **Delete**\. \ No newline at end of file diff --git a/doc_source/CHAP_GettingStarted.CreatingConnecting.PostgreSQL.md b/doc_source/CHAP_GettingStarted.CreatingConnecting.PostgreSQL.md deleted file mode 100644 index 4b50652..0000000 --- a/doc_source/CHAP_GettingStarted.CreatingConnecting.PostgreSQL.md +++ /dev/null @@ -1,254 +0,0 @@ -# Creating and connecting to a PostgreSQL DB instance - -This tutorial creates an EC2 instance and an RDS for PostgreSQL DB instance\. The tutorial shows you how to access the DB instance from the EC2 instance using a standard PostgreSQL client\. As a best practice, this tutorial creates a private DB instance in a virtual private cloud \(VPC\)\. In most cases, other resources in the same VPC, such as EC2 instances, can access the DB instance, but resources outside of the VPC can't access it\. - -After you complete the tutorial, there is a public and private subnet in each Availability Zone in your VPC\. In one Availability Zone, the EC2 instance is in the public subnet, and the DB instance is in the private subnet\. - -**Important** -There's no charge for creating an AWS account\. However, by completing this tutorial, you might incur costs for the AWS resources you use\. You can delete these resources after you complete the tutorial if they are no longer needed\. - -The following diagram shows the configuration when the tutorial is complete\. - -![\[EC2 instance and PostgreSQL DB instance.\]](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/images/getting-started-postgresql.png) - -This tutorial uses **Easy create** to create a DB instance running PostgreSQL with the AWS Management Console\. With **Easy create**, you specify only the DB engine type, DB instance size, and DB instance identifier\. **Easy create** uses the default settings for the other configuration options\. The DB instance created by **Easy create** is private\. - -When you use **Standard create** instead of **Easy create**, you can specify more configuration options when you create a DB instance, including ones for availability, security, backups, and maintenance\. To create a public DB instance, you must use **Standard create**\. For information about creating DB instances with **Standard create**, see [Creating an Amazon RDS DB instance](USER_CreateDBInstance.md)\. - -**Topics** -+ [Prerequisites](#CHAP_GettingStarted.Prerequisites.RDSPostgreSQL) -+ [Step 1: Create an EC2 instance](#CHAP_GettingStarted.Creating.RDSPostgreSQL.EC2) -+ [Step 2: Create a PostgreSQL DB instance](#CHAP_GettingStarted.Creating.PostgreSQL) -+ [Step 3: Connect to a PostgreSQL DB instance](#CHAP_GettingStarted.Connecting.PostgreSQL) -+ [Step 4: Delete the EC2 instance and DB instance](#CHAP_GettingStarted.Deleting.PostgreSQL) - -## Prerequisites - -Before you begin, complete the steps in the following sections: -+ [Sign up for an AWS account](CHAP_SettingUp.md#sign-up-for-aws) -+ [Create an administrative user](CHAP_SettingUp.md#create-an-admin) - -## Step 1: Create an EC2 instance - -Create an Amazon EC2 instance that you will use to connect to your database\. - -**To create an EC2 instance** - -1. Sign in to the AWS Management Console and open the Amazon EC2 console at [https://console\.aws\.amazon\.com/ec2/](https://console.aws.amazon.com/ec2/)\. - -1. In the upper\-right corner of the AWS Management Console, choose the AWS Region in which you want to create the EC2 instance\. - -1. Choose **EC2 Dashboard**, and then choose **Launch instance**, as shown in the following image\. -![\[EC2 Dashboard.\]](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/images/Tutorial_WebServer_11.png) - - The **Launch an instance** page opens\. - -1. Choose the following settings on the **Launch an instance** page\. - - 1. Under **Name and tags**, for **Name**, enter **ec2\-database\-connect**\. - - 1. Under **Application and OS Images \(Amazon Machine Image\)**, choose **Amazon Linux**, and then choose the **Amazon Linux 2023 AMI**\. Keep the default selections for the other choices\. -![\[Choose an Amazon Machine Image.\]](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/images/Tutorial_WebServer_12.png) - - 1. Under **Instance type**, choose **t2\.micro**\. - - 1. Under **Key pair \(login\)**, choose a **Key pair name** to use an existing key pair\. To create a new key pair for the Amazon EC2 instance, choose **Create new key pair** and then use the **Create key pair** window to create it\. - - For more information about creating a new key pair, see [Create a key pair](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/get-set-up-for-amazon-ec2.html#create-a-key-pair) in the *Amazon EC2 User Guide for Linux Instances*\. - - 1. For **Allow SSH traffic** in **Network settings**, choose the source of SSH connections to the EC2 instance\. - - You can choose **My IP** if the displayed IP address is correct for SSH connections\. Otherwise, you can determine the IP address to use to connect to EC2 instances in your VPC using Secure Shell \(SSH\)\. To determine your public IP address, in a different browser window or tab, you can use the service at [https://checkip\.amazonaws\.com](https://checkip.amazonaws.com/)\. An example of an IP address is 192\.0\.2\.1/32\. - - In many cases, you might connect through an internet service provider \(ISP\) or from behind your firewall without a static IP address\. If so, make sure to determine the range of IP addresses used by client computers\. -**Warning** -If you use `0.0.0.0/0` for SSH access, you make it possible for all IP addresses to access your public EC2 instances using SSH\. This approach is acceptable for a short time in a test environment, but it's unsafe for production environments\. In production, authorize only a specific IP address or range of addresses to access your EC2 instances using SSH\. - - The following image shows an example of the **Network settings** section\. -![\[Network settings for an EC2 instance.\]](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/images/EC2_RDS_Connect_NtwkSettings.png) - - 1. Leave the default values for the remaining sections\. - - 1. Review a summary of your EC2 instance configuration in the **Summary** panel, and when you're ready, choose **Launch instance**\. - -1. On the **Launch Status** page, note the identifier for your new EC2 instance, for example: `i-1234567890abcdef0`\. -![\[EC2 instance identifier on Launch Status page.\]](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/images/getting-started-ec2-id.png) - -1. Choose the EC2 instance identifier to open the list of EC2 instances, and then select your EC2 instance\. - -1. In the **Details** tab, note the following values, which you need when you connect using SSH: - - 1. In **Instance summary**, note the value for **Public IPv4 DNS**\. -![\[EC2 public DNS name on Details tab of Instances page.\]](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/images/easy-create-ec2-public-dns.png) - - 1. In **Instance details**, note the value for **Key pair name**\. -![\[EC2 key pair name on Details tab of Instance page.\]](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/images/easy-create-ec2-key-pair.png) - -1. Wait until the **Instance state** for your EC2 instance has a status of **Running** before continuing\. - -## Step 2: Create a PostgreSQL DB instance - -The basic building block of Amazon RDS is the DB instance\. This environment is where you run your PostgreSQL databases\. - -In this example, you use **Easy create** to create a DB instance running the PostgreSQL database engine with a db\.t3\.micro DB instance class\. - -**To create a PostgreSQL DB instance with Easy create** - -1. Sign in to the AWS Management Console and open the Amazon RDS console at [https://console\.aws\.amazon\.com/rds/](https://console.aws.amazon.com/rds/)\. - -1. In the upper\-right corner of the Amazon RDS console, choose the AWS Region in which you want to create the DB instance\. - -1. In the navigation pane, choose **Databases**\. - -1. Choose **Create database** and make sure that **Easy create** is chosen\. -![\[Easy create option.\]](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/images/easy-create-option.png) - -1. In **Configuration**, choose **PostgreSQL**\. - -1. For **DB instance size**, choose **Free tier**\. - -1. For **DB instance identifier**, enter **database\-test1**\. - -1. For **Master username**, enter a name for the master user, or keep the default name \(**postgres**\)\. - - The **Create database** page should look similar to the following image\. -![\[Create database page.\]](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/images/easy-create-postgresql.png) - -1. To use an automatically generated master password for the DB instance, select **Auto generate a password**\. - - To enter your master password, make sure **Auto generate a password** is cleared, and then enter the same password in **Master password** and **Confirm password**\. - -1. To set up a connection with the EC2 instance you created previously, open **Set up EC2 connection \- *optional***\. - - Select **Connect to an EC2 compute resource**\. Choose the EC2 instance you created previously\. -![\[Set up EC2 connection option.\]](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/images/EC2_RDS_Setup_Conn-EasyCreate.png) - -1. Open **View default settings for Easy create**\. -![\[Easy create default settings for RDS for PostgreSQL.\]](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/images/easy-create-view-default-postgres.png) - - You can examine the default settings used with **Easy create**\. The **Editable after database is created** column shows which options you can change after you create the database\. - + If a setting has **No** in that column, and you want a different setting, you can use **Standard create** to create the DB instance\. - + If a setting has **Yes** in that column, and you want a different setting, you can either use **Standard create** to create the DB instance, or modify the DB instance after you create it to change the setting\. - -1. Choose **Create database**\. - - To view the master username and password for the DB instance, choose **View credential details**\. - - You can use the username and password that appears to connect to the DB instance as the master user\. -**Important** -You can't view the master user password again\. If you don't record it, you might have to change it\. -If you need to change the master user password after the DB instance is available, you can modify the DB instance to do so\. For more information about modifying a DB instance, see [Modifying an Amazon RDS DB instance](Overview.DBInstance.Modifying.md)\. - -1. In the **Databases** list, choose the name of the new PostgreSQL DB instance to show its details\. - - The DB instance has a status of **Creating** until it is ready to use\. -![\[DB instance details.\]](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/images/Postgres-Launch06.png) - - When the status changes to **Available**, you can connect to the DB instance\. Depending on the DB instance class and the amount of storage, it can take up to 20 minutes before the new instance is available\. - -## Step 3: Connect to a PostgreSQL DB instance - -You can connect to the DB instance using pgadmin or psql\. This example explains how to connect to a PostgreSQL DB instance using the psql command\-line client\. - -**To connect to a PostgreSQL DB instance using psql** - -1. Find the endpoint \(DNS name\) and port number for your DB instance\. - - 1. Sign in to the AWS Management Console and open the Amazon RDS console at [https://console\.aws\.amazon\.com/rds/](https://console.aws.amazon.com/rds/)\. - - 1. In the upper\-right corner of the Amazon RDS console, choose the AWS Region for the DB instance\. - - 1. In the navigation pane, choose **Databases**\. - - 1. Choose the PostgreSQL DB instance name to display its details\. - - 1. On the **Connectivity & security** tab, copy the endpoint\. Also note the port number\. You need both the endpoint and the port number to connect to the DB instance\. -![\[Connect to a PostgreSQL DB instance.\]](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/images/PostgreSQL-endpoint.png) - -1. Connect to the EC2 instance that you created earlier by following the steps in [Connect to your Linux instance](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/AccessingInstances.html) in the *Amazon EC2 User Guide for Linux Instances*\. - - We recommend that you connect to your EC2 instance using SSH\. If the SSH client utility is installed on Windows, Linux, or Mac, you can connect to the instance using the following command format: - - ``` - ssh -i location_of_pem_file ec2-user@ec2-instance-public-dns-name - ``` - - For example, assume that `ec2-database-connect-key-pair.pem` is stored in `/dir1` on Linux, and the public IPv4 DNS for your EC2 instance is `ec2-12-345-678-90.compute-1.amazonaws.com`\. Your SSH command would look as follows: - - ``` - ssh -i /dir1/ec2-database-connect-key-pair.pem ec2-user@ec2-12-345-678-90.compute-1.amazonaws.com - ``` - -1. Get the latest bug fixes and security updates by updating the software on your EC2 instance\. To do this, use the following command\. -**Note** -The `-y` option installs the updates without asking for confirmation\. To examine updates before installing, omit this option\. - - ``` - sudo dnf update -y - ``` - -1. To install the psql command\-line client from PostgreSQL on Amazon Linux 2023, run the following command: - - ``` - sudo dnf install postgresql15 - ``` - -1. Connect to the PostgreSQL DB instance\. For example, enter the following command at a command prompt on a client computer\. This action lets you connect to the PostgreSQL DB instance using the psql client\. - - Substitute the DB instance endpoint \(DNS name\) for `endpoint`, and substitute the master username that you used for `postgres`\. Provide the master password that you used when prompted for a password\. - - ``` - psql --host=endpoint --port=5432 --username=postgres - ``` - - After you enter the password for the user, you should see output similar to the following: - - ``` - psql (14.3, server 14.6) - SSL connection (protocol: TLSv1.2, cipher: ECDHE-RSA-AES256-GCM-SHA384, bits: 256, compression: off) - Type "help" for help. - - postgres=> - ``` - - For more information on connecting to a PostgreSQL DB instance, see [Connecting to a DB instance running the PostgreSQL database engine](USER_ConnectToPostgreSQLInstance.md)\. If you can't connect to your DB instance, see [Troubleshooting connections to your RDS for PostgreSQL instance](USER_ConnectToPostgreSQLInstance.md#USER_ConnectToPostgreSQLInstance.Troubleshooting)\. - - For security, it is a best practice to use encrypted connections\. Only use an unencrypted PostgreSQL connection when the client and server are in the same VPC and the network is trusted\. For information about using encrypted connections, see [ Connecting to a PostgreSQL DB instance over SSL](PostgreSQL.Concepts.General.SSL.md#PostgreSQL.Concepts.General.SSL.Connecting)\. - -1. Run SQL commands\. - - For example, the following SQL command shows the current date and time: - - ``` - SELECT CURRENT_TIMESTAMP; - ``` - -## Step 4: Delete the EC2 instance and DB instance - -After you connect to and explore the sample EC2 instance and DB instance that you created, delete them so you're no longer charged for them\. - -**To delete the EC2 instance** - -1. Sign in to the AWS Management Console and open the Amazon EC2 console at [https://console\.aws\.amazon\.com/ec2/](https://console.aws.amazon.com/ec2/)\. - -1. In the navigation pane, choose **Instances**\. - -1. Select the EC2 instance, and choose **Instance state, Terminate instance**\. - -1. Choose **Terminate** when prompted for confirmation\. - -For more information about deleting an EC2 instance, see [Terminate your instance](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/terminating-instances.html) in the *Amazon EC2 User Guide for Linux Instances*\. - -**To delete a DB instance with no final DB snapshot** - -1. Sign in to the AWS Management Console and open the Amazon RDS console at [https://console\.aws\.amazon\.com/rds/](https://console.aws.amazon.com/rds/)\. - -1. In the navigation pane, choose **Databases**\. - -1. Choose the DB instance that you want to delete\. - -1. For **Actions**, choose **Delete**\. - -1. Clear **Create final snapshot?** and **Retain automated backups**\. - -1. Complete the acknowledgement and choose **Delete**\. \ No newline at end of file diff --git a/doc_source/CHAP_GettingStarted.CreatingConnecting.SQLServer.md b/doc_source/CHAP_GettingStarted.CreatingConnecting.SQLServer.md deleted file mode 100644 index 24ee81b..0000000 --- a/doc_source/CHAP_GettingStarted.CreatingConnecting.SQLServer.md +++ /dev/null @@ -1,257 +0,0 @@ -# Creating and connecting to a Microsoft SQL Server DB instance - -This tutorial creates an EC2 instance and an RDS for Microsoft SQL Server DB instance\. The tutorial shows you how to access the DB instance from the EC2 instance using the Microsoft SQL Server Management Studio client\. As a best practice, this tutorial creates a private DB instance in a virtual private cloud \(VPC\)\. In most cases, other resources in the same VPC, such as EC2 instances, can access the DB instance, but resources outside of the VPC can't access it\. - -After you complete the tutorial, there is a public and private subnet in each Availability Zone in your VPC\. In one Availability Zone, the EC2 instance is in the public subnet, and the DB instance is in the private subnet\. - -**Important** -There's no charge for creating an AWS account\. However, by completing this tutorial, you might incur costs for the AWS resources you use\. You can delete these resources after you complete the tutorial if they are no longer needed\. - -The following diagram shows the configuration when the tutorial is complete\. - -![\[EC2 instance and Microsoft SQL Server DB instance.\]](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/images/getting-started-sqlserver.png) - -This tutorial uses **Easy create** to create a DB instance running Microsoft SQL Server with the AWS Management Console\. With **Easy create**, you specify only the DB engine type, DB instance size, and DB instance identifier\. **Easy create** uses the default settings for the other configuration options\. The DB instance created by **Easy create** is private\. - -When you use **Standard create** instead of **Easy create**, you can specify more configuration options when you create a DB instance, including ones for availability, security, backups, and maintenance\. To create a public DB instance, you must use **Standard create**\. For information about creating DB instances with **Standard create**, see [Creating an Amazon RDS DB instance](USER_CreateDBInstance.md)\. - -**Topics** -+ [Prerequisites](#CHAP_GettingStarted.Prerequisites.SQLServer) -+ [Step 1: Create an EC2 instance](#CHAP_GettingStarted.Creating.SQLServer.EC2) -+ [Step 2: Create a SQL Server DB instance](#CHAP_GettingStarted.Creating.SQLServer) -+ [Step 3: Connect to your SQL Server DB instance](#CHAP_GettingStarted.Connecting.SQLServer) -+ [Step 4: Explore your sample SQL Server DB instance](#CHAP_GettingStarted.SQLServer.Exploring) -+ [Step 5: Delete the EC2 instance and DB instance](#CHAP_GettingStarted.Deleting.SQLServer) - -## Prerequisites - -Before you begin, complete the steps in the following sections: -+ [Sign up for an AWS account](CHAP_SettingUp.md#sign-up-for-aws) -+ [Create an administrative user](CHAP_SettingUp.md#create-an-admin) - -## Step 1: Create an EC2 instance - -Create an Amazon EC2 instance that you will use to connect to your database\. - -**To create an EC2 instance** - -1. Sign in to the AWS Management Console and open the Amazon EC2 console at [https://console\.aws\.amazon\.com/ec2/](https://console.aws.amazon.com/ec2/)\. - -1. In the upper\-right corner of the AWS Management Console, choose the AWS Region you used for the database previously\. - -1. Choose **EC2 Dashboard**, and then choose **Launch instance**, as shown in the following image\. -![\[EC2 Dashboard.\]](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/images/Tutorial_WebServer_11.png) - - The **Launch an instance** page opens\. - -1. Choose the following settings on the **Launch an instance** page\. - - 1. Under **Name and tags**, for **Name**, enter **ec2\-database\-connect**\. - - 1. Under **Application and OS Images \(Amazon Machine Image\)**, choose **Windows**, and then choose the **Microsoft Windows Server 2022 Base**\. Keep the default selections for the other choices\. -![\[Choose an Amazon Machine Image.\]](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/images/tutorial_ec2_sqlserver_create1.png) - - 1. Under **Instance type**, choose **t2\.micro**\. - - 1. Under **Key pair \(login\)**, choose a **Key pair name** to use an existing key pair\. To create a new key pair for the Amazon EC2 instance, choose **Create new key pair** and then use the **Create key pair** window to create it\. - - For more information about creating a new key pair, see [Create a key pair](https://docs.aws.amazon.com/AWSEC2/latest/WindowsGuide/ec2-key-pairs.html) in the *Amazon EC2 User Guide for Windows Instances*\. - - 1. For **Firewall \(security groups\)** in **Network settings**, choose **Allow RDP traffic from** to connect to the EC2 instance\. - - You can choose **My IP** if the displayed IP address is correct for RDP connections\. Otherwise, you can determine the IP address to use to connect to EC2 instances in your VPC using RDP\. To determine your public IP address, in a different browser window or tab, you can use the service at [https://checkip\.amazonaws\.com](https://checkip.amazonaws.com/)\. An example of an IP address is 192\.0\.2\.1/32\. - - In many cases, you might connect through an internet service provider \(ISP\) or from behind your firewall without a static IP address\. If so, make sure to determine the range of IP addresses used by client computers\. -**Warning** -If you use `0.0.0.0/0` for RDP access, you make it possible for all IP addresses to access your public EC2 instances using RDP\. This approach is acceptable for a short time in a test environment, but it's unsafe for production environments\. In production, authorize only a specific IP address or range of addresses to access your EC2 instances using RDP\. - - The following image shows an example of the **Network settings** section\. -![\[Network settings for an EC2 instance.\]](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/images/EC2_RDS_Connect_NtwkSettingsRDSMS.png) - - 1. Keep the default values for the remaining sections\. - - 1. Review a summary of your EC2 instance configuration in the **Summary** panel, and when you're ready, choose **Launch instance**\. - -1. On the **Launch Status** page, note the identifier for your new EC2 instance, for example: `i-1234567890abcdef0`\. -![\[EC2 instance identifier on Launch Status page.\]](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/images/getting-started-ec2-id.png) - -1. Choose the EC2 instance identifier to open the list of EC2 instances\. - -1. Wait until the **Instance state** for your EC2 instance has a status of **Running** before continuing\. - -## Step 2: Create a SQL Server DB instance - -The basic building block of Amazon RDS is the DB instance\. This environment is where you run your SQL Server databases\. - -In this example, you use **Easy create** to create a DB instance running the SQL Server database engine with a db\.t2\.micro DB instance class\. - -**To create a Microsoft SQL Server DB instance with Easy create** - -1. Sign in to the AWS Management Console and open the Amazon RDS console at [https://console\.aws\.amazon\.com/rds/](https://console.aws.amazon.com/rds/)\. - -1. In the upper\-right corner of the Amazon RDS console, choose the AWS Region in which you want to create the DB instance\. - -1. In the navigation pane, choose **Databases**\. - -1. Choose **Create database** and make sure that **Easy create** is chosen\. -![\[Easy create option.\]](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/images/easy-create-option.png) - -1. In **Configuration**, choose **Microsoft SQL Server**\. - -1. For **Edition**, choose **SQL Server Express Edition**\. - -1. For **DB instance size**, choose **Free tier**\. - -1. For **DB instance identifier**, enter **database\-test1**\. - - The **Create database** page should look similar to the following image\. -![\[Engine options\]](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/images/easy-create-sqlserver.png) - -1. For **Master username**, enter a name for the master user, or keep the default name\. - -1. To set up a connection with the EC2 instance you created previously, open **Set up EC2 connection \- *optional***\. - - Select **Connect to an EC2 compute resource**\. Choose the EC2 instance you created previously\. -![\[Set up EC2 connection option.\]](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/images/EC2_RDS_Setup_Conn-EasyCreate.png) - -1. To use an automatically generated master password for the DB instance, select the **Auto generate a password** box\. - - To enter your master password, clear the **Auto generate a password** box, and then enter the same password in **Master password** and **Confirm password**\. - -1. Open **View default settings for Easy create**\. -![\[Easy create default settings.\]](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/images/easy-create-sqlserver-confirm.png) - - You can examine the default settings used with **Easy create**\. The **Editable after database is created** column shows which options you can change after you create the database\. - + If a setting has **No** in that column, and you want a different setting, you can use **Standard create** to create the DB instance\. - + If a setting has **Yes** in that column, and you want a different setting, you can either use **Standard create** to create the DB instance, or modify the DB instance after you create it to change the setting\. - -1. Choose **Create database**\. - - To view the master username and password for the DB instance, choose **View credential details**\. - - You can use the username and password that appears to connect to the DB instance as the master user\. -**Important** -You can't view the master user password again\. If you don't record it, you might have to change it\. -If you need to change the master user password after the DB instance is available, you can modify the DB instance to do so\. For more information about modifying a DB instance, see [Modifying an Amazon RDS DB instance](Overview.DBInstance.Modifying.md)\. - -1. In the **Databases** list, choose the name of the new SQL Server DB instance to show its details\. - - The DB instance has a status of **Creating** until it is ready to use\. -![\[Screen capture of the DB instance details.\]](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/images/easy-create-sqlserver-launch.png) - - When the status changes to **Available**, you can connect to the DB instance\. Depending on the DB instance class and the amount of storage, it can take up to 20 minutes before the new instance is available\. - -## Step 3: Connect to your SQL Server DB instance - -In the following procedure, you connect to your DB instance by using Microsoft SQL Server Management Studio \(SSMS\)\. - -**To connect to an RDS for SQL Server DB instance using SSMS** - -1. Find the endpoint \(DNS name\) and port number for your DB instance\. - - 1. Sign in to the AWS Management Console and open the Amazon RDS console at [https://console\.aws\.amazon\.com/rds/](https://console.aws.amazon.com/rds/)\. - - 1. In the upper\-right corner of the Amazon RDS console, choose the AWS Region for the DB instance\. - - 1. In the navigation pane, choose **Databases**\. - - 1. Choose the SQL Server DB instance name to display its details\. - - 1. On the **Connectivity** tab, copy the endpoint\. Also, note the port number\. You need both the endpoint and the port number to connect to the DB instance\. -![\[Connect to a Microsoft SQL Server DB instance.\]](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/images/SQLServerConnect2.png) - -1. Connect to the EC2 instance that you created earlier by following the steps in [Connect to your Microsoft Windows instance](https://docs.aws.amazon.com/AWSEC2/latest/WindowsGuide/EC2_GetStarted.html#ec2-connect-to-instance-windows) in the *Amazon EC2 User Guide for Windows Instances*\. - -1. Install the SQL Server Management Studio \(SSMS\) client from Microsoft\. - - To download a standalone version of SSMS to your EC2 instance, see [Download SQL Server Management Studio \(SSMS\)](https://docs.microsoft.com/en-us/sql/ssms/download-sql-server-management-studio-ssms) in the Microsoft documentation\. - - 1. Use the Start menu to open Internet Explorer\. - - 1. Use Internet Explorer to download and install a standalone version of SSMS\. If you are prompted that the site isn't trusted, add the site to the list of trusted sites\. - -1. Start SQL Server Management Studio \(SSMS\)\. - - The **Connect to Server** dialog box appears\. - -1. Provide the following information for your sample DB instance: - - 1. For **Server type**, choose **Database Engine**\. - - 1. For **Server name**, enter the DNS name, followed by a comma and the port number \(the default port is 1433\)\. For example, your server name should look as follows: - - ``` - database-test1.0123456789012.us-west-2.rds.amazonaws.com,1433 - ``` - - 1. For **Authentication**, choose **SQL Server Authentication**\. - - 1. For **Login**, enter the username that you chose to use for your sample DB instance\. This is also known as the master username\. - - 1. For **Password**, enter the password that you chose earlier for your sample DB instance\. This is also known as the master user password\. - -1. Choose **Connect**\. - - After a few moments, SSMS connects to your DB instance\. For security, it is a best practice to use encrypted connections\. Only use an unencrypted SQL Server connection when the client and server are in the same VPC and the network is trusted\. For information about using encrypted connections, see [Using SSL with a Microsoft SQL Server DB instance](SQLServer.Concepts.General.SSL.Using.md) - -For more information about connecting to a Microsoft SQL Server DB instance, see [Connecting to a DB instance running the Microsoft SQL Server database engine](USER_ConnectToMicrosoftSQLServerInstance.md)\. - -For information about connection issues, see [Can't connect to Amazon RDS DB instance](CHAP_Troubleshooting.md#CHAP_Troubleshooting.Connecting)\. - -## Step 4: Explore your sample SQL Server DB instance - -You can explore your sample DB instance by using Microsoft SQL Server Management Studio \(SSMS\)\. - -**To explore a DB instance using SSMS** - -1. Your SQL Server DB instance comes with SQL Server's standard built\-in system databases \(master, model, msdb, and tempdb\)\. To explore the system databases, do the following: - - 1. In SSMS, on the **View** menu, choose **Object Explorer**\. - - 1. Expand your DB instance, expand **Databases**, and then expand **System Databases** as shown\. -![\[Object Explorer displaying the system databases.\]](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/images/SQL-SSMS-SystemDBs.png) - - Your SQL Server DB instance also comes with a database named `rdsadmin`\. Amazon RDS uses this database to store the objects that it uses to manage your database\. The `rdsadmin` database also includes stored procedures that you can run to perform advanced tasks\. - -1. Start creating your own databases and running queries against your DB instance and databases as usual\. To run a test query against your sample DB instance, do the following: - - 1. In SSMS, on the **File** menu, point to **New** and then choose **Query with Current Connection**\. - - 1. Enter the following SQL query: - - ``` - select @@VERSION - ``` - - 1. Run the query\. SSMS returns the SQL Server version of your Amazon RDS DB instance\. -![\[SQL Query Window.\]](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/images/SQL-Connect-Query.png) - -## Step 5: Delete the EC2 instance and DB instance - -After you connect to and explore the sample EC2 instance and DB instance that you created, delete them so you're no longer charged for them\. - -**To delete the EC2 instance** - -1. Sign in to the AWS Management Console and open the Amazon EC2 console at [https://console\.aws\.amazon\.com/ec2/](https://console.aws.amazon.com/ec2/)\. - -1. In the navigation pane, choose **Instances**\. - -1. Select the EC2 instance, and choose **Instance state, Terminate instance**\. - -1. Choose **Terminate** when prompted for confirmation\. - -For more information about deleting an EC2 instance, see [Terminate your instance](https://docs.aws.amazon.com/AWSEC2/latest/WindowsGuide/terminating-instances.html) in the *User Guide for Windows Instances*\. - -**To delete the DB instance with no final DB snapshot** - -1. Sign in to the AWS Management Console and open the Amazon RDS console at [https://console\.aws\.amazon\.com/rds/](https://console.aws.amazon.com/rds/)\. - -1. In the navigation pane, choose **Databases**\. - -1. Choose the DB instance that you want to delete\. - -1. For **Actions**, choose **Delete**\. - -1. Clear **Create final snapshot?** and **Retain automated backups**\. - -1. Complete the acknowledgement and choose **Delete**\. \ No newline at end of file diff --git a/doc_source/CHAP_GettingStarted.md b/doc_source/CHAP_GettingStarted.md deleted file mode 100644 index 516d4e1..0000000 --- a/doc_source/CHAP_GettingStarted.md +++ /dev/null @@ -1,16 +0,0 @@ -# Getting started with Amazon RDS - -In the following examples, you can find how to create and connect to a DB instance using Amazon Relational Database Service \(Amazon RDS\)\. You can create a DB instance that uses MariaDB, MySQL, Microsoft SQL Server, Oracle, or PostgreSQL\. - -**Important** -Before you can create or connect to a DB instance, make sure to complete the tasks in [Setting up for Amazon RDS](CHAP_SettingUp.md)\. - -Creating a DB instance and connecting to a database on a DB instance is slightly different for each of the DB engines\. Choose one of the following DB engines that you want to use for detailed information on creating and connecting to the DB instance\. After you have created and connected to your DB instance, there are instructions to help you delete the DB instance\. - -**Topics** -+ [Creating and connecting to a MariaDB DB instance](CHAP_GettingStarted.CreatingConnecting.MariaDB.md) -+ [Creating and connecting to a Microsoft SQL Server DB instance](CHAP_GettingStarted.CreatingConnecting.SQLServer.md) -+ [Creating and connecting to a MySQL DB instance](CHAP_GettingStarted.CreatingConnecting.MySQL.md) -+ [Creating and connecting to an Oracle DB instance](CHAP_GettingStarted.CreatingConnecting.Oracle.md) -+ [Creating and connecting to a PostgreSQL DB instance](CHAP_GettingStarted.CreatingConnecting.PostgreSQL.md) -+ [Tutorial: Create a web server and an Amazon RDS DB instance](TUT_WebAppWithRDS.md) \ No newline at end of file diff --git a/doc_source/CHAP_Limits.md b/doc_source/CHAP_Limits.md deleted file mode 100644 index c0e84a2..0000000 --- a/doc_source/CHAP_Limits.md +++ /dev/null @@ -1,82 +0,0 @@ -# Quotas and constraints for Amazon RDS - -Following, you can find a description of the resource quotas and naming constraints for Amazon RDS\. - -**Topics** -+ [Quotas in Amazon RDS](#RDS_Limits.Limits) -+ [Naming constraints in Amazon RDS](#RDS_Limits.Constraints) -+ [Maximum number of database connections](#RDS_Limits.MaxConnections) -+ [File size limits in Amazon RDS](#RDS_Limits.FileSize) - -## Quotas in Amazon RDS - -Each AWS account has quotas, for each AWS Region, on the number of Amazon RDS resources that can be created\. After a quota for a resource has been reached, additional calls to create that resource fail with an exception\. - -The following table lists the resources and their quotas per AWS Region\. - -[\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_Limits.html) - -**Note** -By default, you can have up to a total of 40 DB instances\. RDS DB instances, Aurora DB instances, Amazon Neptune instances, and Amazon DocumentDB instances apply to this quota\. -The following limitations apply to the Amazon RDS DB instances: -10 for each SQL Server edition \(Enterprise, Standard, Web, and Express\) under the "license\-included" model -10 for Oracle under the "license\-included" model -40 for MySQL, MariaDB, or PostgreSQL -40 for Oracle under the "bring\-your\-own\-license" \(BYOL\) licensing model -If your application requires more DB instances, you can request additional DB instances by opening the [Service Quotas console](https://console.aws.amazon.com/servicequotas/home?region=us-east-1#!/dashboard)\. In the navigation pane, choose **AWS services**\. Choose **Amazon Relational Database Service \(Amazon RDS\)**, choose a quota, and follow the directions to request a quota increase\. For more information, see [Requesting a quota increase](https://docs.aws.amazon.com/servicequotas/latest/userguide/request-increase.html) in the *Service Quotas User Guide*\. -For RDS for Oracle and RDS for SQL Server, the read replica limit is 5 per source database for each Region\. -Backups managed by AWS Backup are considered manual DB snapshots, but don't count toward the manual snapshot quota\. For information about AWS Backup, see the [https://docs.aws.amazon.com/aws-backup/latest/devguide](https://docs.aws.amazon.com/aws-backup/latest/devguide)\. - -If you use any RDS API operations and exceed the default quota for the number of calls per second, the Amazon RDS API issues an error like the following one\. - -ClientError: An error occurred \(ThrottlingException\) when calling the *API\_name* operation: Rate exceeded\. - -Here, reduce the number of calls per second\. The quota is meant to cover most use cases\. If higher limits are needed, request a quota increase by contacting AWS Support\. Open the [AWS Support Center](https://console.aws.amazon.com/support/home#/) page, sign in if necessary, and choose **Create case**\. Choose **Service limit increase**\. Complete and submit the form\. - -**Note** -This quota can't be changed in the Amazon RDS Service Quotas console\. - -## Naming constraints in Amazon RDS - -The following table describes naming constraints in Amazon RDS\. - - -**** - -| Resource or item | Constraints | -| --- | --- | -| DB instance identifier | Identifiers have these naming constraints: [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_Limits.html) | -| Database name | Database name constraints differ for each database engine \. For more information, see the available settings when creating each DB instance\. This approach doesn't apply to SQL Server\. For SQL Server, you create your databases after you create your DB instance\. | -| Master user name | Master user name constraints differ for each database engine\. For more information, see the available settings when creating each DB instance\. | -| Master password | The password for the database master user can include any printable ASCII character except `/`, `'`, `"`, `@`, or a space\. The password has the following number of printable ASCII characters depending on the DB engine: [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_Limits.html) | -| DB parameter group name | These names have these constraints: [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_Limits.html) | -| DB subnet group name | These names have these constraints: [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_Limits.html) | - -## Maximum number of database connections - -The maximum number of simultaneous database connections varies by the DB engine type and the memory allocation for the DB instance class\. The maximum number of connections is generally set in the parameter group associated with the DB instance\. The exception is Microsoft SQL Server, where it is set in the server properties for the DB instance in SQL Server Management Studio \(SSMS\)\. - -`DBInstanceClassMemory` is in bytes\. For details about how this value is calculated, see [Specifying DB parameters](USER_ParamValuesRef.md)\. Because of memory reserved for the operating system and RDS management processes, this memory size is smaller than the value in gibibytes \(GiB\) shown in [Hardware specifications for DB instance classes](Concepts.DBInstanceClass.md#Concepts.DBInstanceClass.Summary)\. - -If your applications frequently open and close connections, or keep a large number of long\-lived connections open, we recommend that you use Amazon RDS Proxy\. RDS Proxy is a fully managed, highly available database proxy that uses connection pooling to share database connections securely and efficiently\. To learn more about RDS Proxy, see [Using Amazon RDS Proxy](rds-proxy.md)\. - -**Note** -For Oracle, you set the maximum number of user processes and user and system sessions\. - - -**Maximum database connections** -[\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_Limits.html) - -In some instances, the total RAM is 16 GiB, or 17,179,869,184 bytes\. In these instances, the variable `DBInstanceClassMemory` automatically subtracts the amounts reserved to the operating system and the RDS processes that manage the instance\. The remainder of the subtraction is then divided by 12,582,880\. This results in the maximum connections number being around 1,300, depending on instance type, instance size, and DB engine\. - -Database connections consume memory\. Setting one of these parameters too high can cause a low memory condition that might cause a DB instance to be placed in the **incompatible\-parameters** status\. For more information, see [Diagnosing and resolving incompatible parameters status for a memory limit](CHAP_Troubleshooting.md#CHAP_Troubleshooting.incompatible-parameters-memory)\. - -**Note** -You might see fewer than the maximum number of DB connections\. This is to avoid potential out\-of\-memory issues\. - -## File size limits in Amazon RDS - -File size limits apply to certain Amazon RDS DB instances\. For more information, see the following engine\-specific limits: -+ [MariaDB file size limits in Amazon RDS](CHAP_MariaDB.Limitations.md#RDS_Limits.FileSize.MariaDB) -+ [MySQL file size limits in Amazon RDS](MySQL.KnownIssuesAndLimitations.md#MySQL.Concepts.Limits.FileSize) -+ [Oracle file size limits in Amazon RDS](Oracle.Concepts.limitations.md#Oracle.Concepts.file-size-limits) \ No newline at end of file diff --git a/doc_source/CHAP_MariaDB.Limitations.md b/doc_source/CHAP_MariaDB.Limitations.md deleted file mode 100644 index e3ca731..0000000 --- a/doc_source/CHAP_MariaDB.Limitations.md +++ /dev/null @@ -1,54 +0,0 @@ -# RDS for MariaDB limitations - -Following are important limitations of using RDS for MariaDB\. - -**Note** -This list is not exhaustive\. - -**Topics** -+ [MariaDB file size limits in Amazon RDS](#RDS_Limits.FileSize.MariaDB) -+ [InnoDB reserved word](#MariaDB.Concepts.InnodbDatabaseName) -+ [Custom ports](#MariaDB.Concepts.CustomPorts) - -## MariaDB file size limits in Amazon RDS - -For MariaDB DB instances, the maximum size of a table is 16 TB when using InnoDB file\-per\-table tablespaces\. This limit also constrains the system tablespace to a maximum size of 16 TB\. InnoDB file\-per\-table tablespaces \(with tables each in their own tablespace\) are set by default for MariaDB DB instances\. This limit isn't related to the maximum storage limit for MariaDB DB instances\. For more information about the storage limit, see [Amazon RDS DB instance storage](CHAP_Storage.md)\. - -There are advantages and disadvantages to using InnoDB file\-per\-table tablespaces, depending on your application\. To determine the best approach for your application, see [File\-per\-table tablespaces](https://dev.mysql.com/doc/refman/5.7/en/innodb-file-per-table-tablespaces.html) in the MySQL documentation\. - -We don't recommend allowing tables to grow to the maximum file size\. In general, a better practice is to partition data into smaller tables, which can improve performance and recovery times\. - -One option that you can use for breaking a large table up into smaller tables is partitioning\. *Partitioning* distributes portions of your large table into separate files based on rules that you specify\. For example, if you store transactions by date, you can create partitioning rules that distribute older transactions into separate files using partitioning\. Then periodically, you can archive the historical transaction data that doesn't need to be readily available to your application\. For more information, see [Partitioning](https://dev.mysql.com/doc/refman/5.7/en/partitioning.html) in the MySQL documentation\. - -**To determine the file size of a table** - -Use the following SQL command to determine if any of your tables are too large and are candidates for partitioning\. To update table statistics, issue an `ANALYZE TABLE` command on each table\. For more information, see [ANALYZE TABLE statement](https://dev.mysql.com/doc/refman/5.7/en/analyze-table.html) in the MySQL documentation\. - -``` -1. SELECT TABLE_SCHEMA, TABLE_NAME, -2. round(((DATA_LENGTH + INDEX_LENGTH) / 1024 / 1024), 2) As "Approximate size (MB)", DATA_FREE -3. FROM information_schema.TABLES -4. WHERE TABLE_SCHEMA NOT IN ('mysql', 'information_schema', 'performance_schema'); -``` - -**To enable InnoDB file\-per\-table tablespaces** -+ To enable InnoDB file\-per\-table tablespaces, set the `innodb_file_per_table` parameter to `1` in the parameter group for the DB instance\. - -**To disable InnoDB file\-per\-table tablespaces** -+ To disable InnoDB file\-per\-table tablespaces, set the `innodb_file_per_table` parameter to `0` in the parameter group for the DB instance\. - -For information on updating a parameter group, see [Working with parameter groups](USER_WorkingWithParamGroups.md)\. - -When you have enabled or disabled InnoDB file\-per\-table tablespaces, you can issue an `ALTER TABLE` command\. You can use this command to move a table from the global tablespace to its own tablespace\. Or you can move a table from its own tablespace to the global tablespace\. Following is an example\. - -``` -1. ALTER TABLE table_name ENGINE=InnoDB, ALGORITHM=COPY; -``` - -## InnoDB reserved word - -`InnoDB` is a reserved word for RDS for MariaDB\. You can't use this name for a MariaDB database\. - -## Custom ports - -Amazon RDS blocks connections to custom port 33060 for the MariaDB engine\. Choose a different port for your MariaDB engine\. \ No newline at end of file diff --git a/doc_source/CHAP_MariaDB.md b/doc_source/CHAP_MariaDB.md deleted file mode 100644 index 1e8198c..0000000 --- a/doc_source/CHAP_MariaDB.md +++ /dev/null @@ -1,54 +0,0 @@ -# Amazon RDS for MariaDB - -Amazon RDS supports DB instances that run the following versions of MariaDB: -+ MariaDB 10\.6 -+ MariaDB 10\.5 -+ MariaDB 10\.4 -+ MariaDB 10\.3 \(end of life scheduled for October 23, 2023\) - -For more information about minor version support, see [MariaDB on Amazon RDS versions](MariaDB.Concepts.VersionMgmt.md)\. - -To create a MariaDB DB instance, use the Amazon RDS management tools or interfaces\. You can then use the Amazon RDS tools to perform management actions for the DB instance\. These include actions such as the following: -+ Reconfiguring or resizing the DB instance -+ Authorizing connections to the DB instance -+ Creating and restoring from backups or snapshots -+ Creating Multi\-AZ secondaries -+ Creating read replicas -+ Monitoring the performance of your DB instance - -To store and access the data in your DB instance, use standard MariaDB utilities and applications\. - -MariaDB is available in all of the AWS Regions\. For more information about AWS Regions, see [Regions, Availability Zones, and Local Zones](Concepts.RegionsAndAvailabilityZones.md)\. - -You can use Amazon RDS for MariaDB databases to build HIPAA\-compliant applications\. You can store healthcare\-related information, including protected health information \(PHI\), under a Business Associate Agreement \(BAA\) with AWS\. For more information, see [HIPAA compliance](http://aws.amazon.com/compliance/hipaa-compliance/)\. AWS Services in Scope have been fully assessed by a third\-party auditor and result in a certification, attestation of compliance, or Authority to Operate \(ATO\)\. For more information, see [AWS services in scope by compliance program](http://aws.amazon.com/compliance/services-in-scope/)\. - -Before creating a DB instance, complete the steps in [Setting up for Amazon RDS](CHAP_SettingUp.md)\. When you create a DB instance, the RDS master user gets DBA privileges, with some limitations\. Use this account for administrative tasks such as creating additional database accounts\. - -You can create the following: -+ DB instances -+ DB snapshots -+ Point\-in\-time restores -+ Automated backups -+ Manual backups - -You can use DB instances running MariaDB inside a virtual private cloud \(VPC\) based on Amazon VPC\. You can also add features to your MariaDB DB instance by enabling various options\. Amazon RDS supports Multi\-AZ deployments for MariaDB as a high\-availability, failover solution\. - -**Important** -To deliver a managed service experience, Amazon RDS doesn't provide shell access to DB instances\. It also restricts access to certain system procedures and tables that need advanced privileges\. You can access your database using standard SQL clients such as the mysql client\. However, you can't access the host directly by using Telnet or Secure Shell \(SSH\)\. - -**Topics** -+ [MariaDB feature support on Amazon RDS](MariaDB.Concepts.FeatureSupport.md) -+ [MariaDB on Amazon RDS versions](MariaDB.Concepts.VersionMgmt.md) -+ [Connecting to a DB instance running the MariaDB database engine](USER_ConnectToMariaDBInstance.md) -+ [Securing MariaDB DB instance connections](securing-mariadb-connections.md) -+ [Improving query performance for RDS for MariaDB with Amazon RDS Optimized Reads](rds-optimized-reads-mariadb.md) -+ [Improving write performance with Amazon RDS Optimized Writes for MariaDB](rds-optimized-writes-mariadb.md) -+ [Upgrading the MariaDB DB engine](USER_UpgradeDBInstance.MariaDB.md) -+ [Importing data into a MariaDB DB instance](MariaDB.Procedural.Importing.md) -+ [Working with MariaDB replication in Amazon RDS](USER_MariaDB.Replication.md) -+ [Options for MariaDB database engine](Appendix.MariaDB.Options.md) -+ [Parameters for MariaDB](Appendix.MariaDB.Parameters.md) -+ [Migrating data from a MySQL DB snapshot to a MariaDB DB instance](USER_Migrate_MariaDB.md) -+ [MariaDB on Amazon RDS SQL reference](Appendix.MariaDB.SQLRef.md) -+ [Local time zone for MariaDB DB instances](MariaDB.Concepts.LocalTimeZone.md) -+ [RDS for MariaDB limitations](CHAP_MariaDB.Limitations.md) \ No newline at end of file diff --git a/doc_source/CHAP_Monitor_Logs_Events.md b/doc_source/CHAP_Monitor_Logs_Events.md deleted file mode 100644 index a0aaad6..0000000 --- a/doc_source/CHAP_Monitor_Logs_Events.md +++ /dev/null @@ -1,20 +0,0 @@ -# Monitoring events, logs, and streams in an Amazon RDS DB instance - -When you monitor your Amazon RDS databases and your other AWS solutions, your goal is to maintain the following: -+ Reliability -+ Availability -+ Performance -+ Security - -[Monitoring metrics in an Amazon RDS instance](CHAP_Monitoring.md) explains how to monitor your instance using metrics\. A complete solution must also monitor database events, log files, and activity streams\. AWS provides you with the following monitoring tools: -+ *Amazon EventBridge* is a serverless event bus service that makes it easy to connect your applications with data from a variety of sources\. EventBridge delivers a stream of real\-time data from your own applications, Software\-as\-a\-Service \(SaaS\) applications, and AWS services\. EventBridge routes that data to targets such as AWS Lambda\. This way, you can monitor events that happen in services and build event\-driven architectures\. For more information, see the [Amazon EventBridge User Guide](https://docs.aws.amazon.com/eventbridge/latest/userguide/)\. -+ *Amazon CloudWatch Logs* provides a way to monitor, store, and access your log files from Amazon RDS instances, AWS CloudTrail, and other sources\. Amazon CloudWatch Logs can monitor information in the log files and notify you when certain thresholds are met\. You can also archive your log data in highly durable storage\. For more information, see the [Amazon CloudWatch Logs User Guide](https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/)\. -+ *AWS CloudTrail* captures API calls and related events made by or on behalf of your AWS account\. CloudTrail delivers the log files to an Amazon S3 bucket that you specify\. You can identify which users and accounts called AWS, the source IP address from which the calls were made, and when the calls occurred\. For more information, see the [AWS CloudTrail User Guide](https://docs.aws.amazon.com/awscloudtrail/latest/userguide/)\. -+ *Database Activity Streams* is an Amazon RDS feature that provides a near real\-time stream of the activity in your DB instance\. Amazon RDS pushes activities to an Amazon Kinesis data stream\. The Kinesis stream is created automatically\. From Kinesis, you can configure AWS services such as Amazon Kinesis Data Firehose and AWS Lambda to consume the stream and store the data\. - -**Topics** -+ [Viewing logs, events, and streams in the Amazon RDS console](logs-events-streams-console.md) -+ [Monitoring Amazon RDS events](working-with-events.md) -+ [Monitoring Amazon RDS log files](USER_LogAccess.md) -+ [Monitoring Amazon RDS API calls in AWS CloudTrail](logging-using-cloudtrail.md) -+ [Monitoring Amazon RDS with Database Activity Streams](DBActivityStreams.md) \ No newline at end of file diff --git a/doc_source/CHAP_Monitoring.md b/doc_source/CHAP_Monitoring.md deleted file mode 100644 index 8495d65..0000000 --- a/doc_source/CHAP_Monitoring.md +++ /dev/null @@ -1,14 +0,0 @@ -# Monitoring metrics in an Amazon RDS instance - -In the following sections, you can find an overview of Amazon RDS monitoring and an explanation about how to access metrics\. To learn how to monitor events, logs, and database activity streams, see [Monitoring events, logs, and streams in an Amazon RDS DB instance](CHAP_Monitor_Logs_Events.md)\. - -**Topics** -+ [Overview of monitoring metrics in Amazon RDS](MonitoringOverview.md) -+ [Viewing instance status and recommendations](accessing-monitoring.md) -+ [Viewing metrics in the Amazon RDS console](USER_Monitoring.md) -+ [Viewing combined metrics in the Amazon RDS console](Viewing_Unifiedmetrics.md) -+ [Monitoring Amazon RDS metrics with Amazon CloudWatch](monitoring-cloudwatch.md) -+ [Monitoring DB load with Performance Insights on Amazon RDS](USER_PerfInsights.md) -+ [Analyzing performance anomalies with Amazon DevOps Guru for Amazon RDS](devops-guru-for-rds.md) -+ [Monitoring OS metrics with Enhanced Monitoring](USER_Monitoring.OS.md) -+ [Metrics reference for Amazon RDS](metrics-reference.md) \ No newline at end of file diff --git a/doc_source/CHAP_MySQL.md b/doc_source/CHAP_MySQL.md deleted file mode 100644 index 01b9024..0000000 --- a/doc_source/CHAP_MySQL.md +++ /dev/null @@ -1,53 +0,0 @@ -# Amazon RDS for MySQL - -Amazon RDS supports DB instances that run the following versions of MySQL: -+ MySQL 8\.0 -+ MySQL 5\.7 - -For more information about minor version support, see [MySQL on Amazon RDS versions](MySQL.Concepts.VersionMgmt.md)\. - -To create an Amazon RDS for MySQL DB instance, use the Amazon RDS management tools or interfaces\. You can then do the following: -+ Resize your DB instance -+ Authorize connections to your DB instance -+ Create and restore from backups or snapshots -+ Create Multi\-AZ secondaries -+ Create read replicas -+ Monitor the performance of your DB instance - -To store and access the data in your DB instance, you use standard MySQL utilities and applications\. - -Amazon RDS for MySQL is compliant with many industry standards\. For example, you can use RDS for MySQL databases to build HIPAA\-compliant applications\. You can use RDS for MySQL databases to store healthcare related information, including protected health information \(PHI\) under a Business Associate Agreement \(BAA\) with AWS\. Amazon RDS for MySQL also meets Federal Risk and Authorization Management Program \(FedRAMP\) security requirements\. In addition, Amazon RDS for MySQL has received a FedRAMP Joint Authorization Board \(JAB\) Provisional Authority to Operate \(P\-ATO\) at the FedRAMP HIGH Baseline within the AWS GovCloud \(US\) Regions\. For more information on supported compliance standards, see [AWS cloud compliance](http://aws.amazon.com/compliance/)\. - -For information about the features in each version of MySQL, see [The main features of MySQL](https://dev.mysql.com/doc/refman/8.0/en/features.html) in the MySQL documentation\. - -Before creating a DB instance, complete the steps in [Setting up for Amazon RDS](CHAP_SettingUp.md)\. When you create a DB instance, the RDS master user gets DBA privileges, with some limitations\. Use this account for administrative tasks such as creating additional database accounts\. - -You can create the following: -+ DB instances -+ DB snapshots -+ Point\-in\-time restores -+ Automated backups -+ Manual backups - -You can use DB instances running MySQL inside a virtual private cloud \(VPC\) based on Amazon VPC\. You can also add features to your MySQL DB instance by turning on various options\. Amazon RDS supports Multi\-AZ deployments for MySQL as a high\-availability, failover solution\. - -**Important** -To deliver a managed service experience, Amazon RDS doesn't provide shell access to DB instances\. It also restricts access to certain system procedures and tables that need advanced privileges\. You can access your database using standard SQL clients such as the mysql client\. However, you can't access the host directly by using Telnet or Secure Shell \(SSH\)\. - -**Topics** -+ [MySQL feature support on Amazon RDS](MySQL.Concepts.FeatureSupport.md) -+ [MySQL on Amazon RDS versions](MySQL.Concepts.VersionMgmt.md) -+ [Connecting to a DB instance running the MySQL database engine](USER_ConnectToInstance.md) -+ [Securing MySQL DB instance connections](securing-mysql-connections.md) -+ [Improving query performance for RDS for MySQL with Amazon RDS Optimized Reads](rds-optimized-reads.md) -+ [Improving write performance with Amazon RDS Optimized Writes for MySQL](rds-optimized-writes.md) -+ [Upgrading the MySQL DB engine](USER_UpgradeDBInstance.MySQL.md) -+ [Importing data into a MySQL DB instance](MySQL.Procedural.Importing.Other.md) -+ [Working with MySQL replication in Amazon RDS](USER_MySQL.Replication.md) -+ [Exporting data from a MySQL DB instance by using replication](MySQL.Procedural.Exporting.NonRDSRepl.md) -+ [Options for MySQL DB instances](Appendix.MySQL.Options.md) -+ [Parameters for MySQL](Appendix.MySQL.Parameters.md) -+ [Common DBA tasks for MySQL DB instances](Appendix.MySQL.CommonDBATasks.md) -+ [Local time zone for MySQL DB instances](MySQL.Concepts.LocalTimeZone.md) -+ [Known issues and limitations for Amazon RDS for MySQL](MySQL.KnownIssuesAndLimitations.md) -+ [RDS for MySQL stored procedure reference](Appendix.MySQL.SQLRef.md) \ No newline at end of file diff --git a/doc_source/CHAP_Oracle.advanced-features.instance-store.md b/doc_source/CHAP_Oracle.advanced-features.instance-store.md deleted file mode 100644 index 4bdf216..0000000 --- a/doc_source/CHAP_Oracle.advanced-features.instance-store.md +++ /dev/null @@ -1,209 +0,0 @@ -# Storing temporary data in an RDS for Oracle instance store - -Use an instance store for the temporary tablespaces and the Database Smart Flash Cache \(the flash cache\) on supported RDS for Oracle DB instance classes\. - -**Topics** -+ [Overview of the RDS for Oracle instance store](#CHAP_Oracle.advanced-features.instance-store.overview) -+ [Turning on an RDS for Oracle instance store](#CHAP_Oracle.advanced-features.instance-store.Enable) -+ [Configuring an RDS for Oracle instance store](#CHAP_Oracle.advanced-features.instance-store.configuring) -+ [Considerations when changing the DB instance type](#CHAP_Oracle.advanced-features.instance-store.modifying) -+ [Working with an instance store on an Oracle read replica](#CHAP_Oracle.advanced-features.instance-store.replicas) -+ [Configuring a temporary tablespace group on an instance store and Amazon EBS](#CHAP_Oracle.advanced-features.instance-store.temp-ebs) -+ [Removing an RDS for Oracle instance store](#CHAP_Oracle.advanced-features.instance-store.Disable) - -## Overview of the RDS for Oracle instance store - -An *instance store* provides temporary block\-level storage for an RDS for Oracle DB instance\. You can use an instance store for temporary storage of information that changes frequently\. - -An instance store is based on Non\-Volatile Memory Express \(NVMe\) devices that are physically attached to the host computer\. The storage is optimized for low latency, random I/O performance, and sequential read throughput\. - -The size of the instance store varies by DB instance type\. For more information about the instance store, see [Amazon EC2 instance store](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/InstanceStorage.html) in the *Amazon Elastic Compute Cloud User Guide for Linux Instances*\. - -**Topics** -+ [Types of data in the RDS for Oracle instance store](#CHAP_Oracle.advanced-features.instance-store.overview.uses) -+ [Benefits of the RDS for Oracle instance store](#CHAP_Oracle.advanced-features.instance-store.overview.benefits) -+ [Supported instance classes for the RDS for Oracle instance store](#CHAP_Oracle.advanced-features.instance-store.overview.instance-classes) -+ [Supported engine versions for the RDS for Oracle instance store](#CHAP_Oracle.advanced-features.instance-store.overview.db-versions) -+ [Supported AWS Regions for the RDS for Oracle instance store](#CHAP_Oracle.advanced-features.instance-store.overview.regions) -+ [Cost of the RDS for Oracle instance store](#CHAP_Oracle.advanced-features.instance-store.overview.cost) - -### Types of data in the RDS for Oracle instance store - -You can place the following types of RDS for Oracle temporary data in an instance store: - -A temporary tablespace -Oracle Database uses temporary tablespaces to store intermediate query results that don't fit in memory\. Larger queries can generate large amounts of intermediate data that needs to be cached temporarily, but doesn't need to persist\. In particular, a temporary tablespace is useful for sorts, hash aggregations, and joins\. If your RDS for Oracle DB instance uses the Enterprise Edition or Standard Edition 2, you can place a temporary tablespace in an instance store\. - -The flash cache -The flash cache improves the performance of single\-block random reads in the conventional path\. A best practice is to size the cache to accommodate most of your active data set\. If your RDS for Oracle DB instance uses the Enterprise Edition, you can place the flash cache in an instance store\. - -By default, an instance store is configured for a temporary tablespace but not for the flash cache\. You can't place Oracle data files and database log files in an instance store\. - -### Benefits of the RDS for Oracle instance store - -You might consider using an instance store to store temporary files and caches that you can afford to lose\. If you want to improve DB performance, or if an increasing workload is causing performance problems for your Amazon EBS storage, consider scaling to an instance class that supports an instance store\. - -By placing your temporary tablespace and flash cache on an instance store, you get the following benefits: -+ Lower read latencies -+ Higher throughput -+ Reduced load on your Amazon EBS volumes -+ Lower storage and snapshot costs because of reduced Amazon EBS load -+ Less need to provision high IOPS, possibly lowering your overall cost - - By placing your temporary tablespace on the instance store, you deliver an immediate performance boost to queries that use temporary space\. When you place the flash cache on the instance store, cached block reads typically have much lower latency than Amazon EBS reads\. The flash cache needs to be "warmed up" before it delivers performance benefits\. The cache warms up by itself because the database writes blocks to the flash cache as they age out of the database buffer cache\. - -**Note** -In some cases, the flash cache causes performance overhead because of cache management\. Before you turn on the flash cache in a production environment, we recommend that you analyze your workload and test the cache in a test environment\. - -### Supported instance classes for the RDS for Oracle instance store - -Amazon RDS supports the instance store for the following DB instance classes: -+ db\.m5d -+ db\.r5d -+ db\.x2idn -+ db\.x2iedn - -RDS for Oracle supports the preceding DB instance classes for the BYOL licensing model only\. For more information, see [Supported RDS for Oracle instance classes](Oracle.Concepts.InstanceClasses.md#Oracle.Concepts.InstanceClasses.Supported) and [Bring Your Own License \(BYOL\)](Oracle.Concepts.Licensing.md#Oracle.Concepts.Licensing.BYOL)\. - -To see the total instance storage for the supported DB instance types, run the following command in the AWS CLI\. - -**Example** - -``` -aws ec2 describe-instance-types \ - --filters "Name=instance-type,Values=*5d.*large*" \ - --query "InstanceTypes[?contains(InstanceType,'m5d')||contains(InstanceType,'r5d')][InstanceType, InstanceStorageInfo.TotalSizeInGB]" \ - --output table -``` - -The preceding command returns the raw device size for the instance store\. RDS for Oracle uses a small portion of this space for configuration\. The space in the instance store that is available for temporary tablespaces or the flash cache is slightly smaller\. - -### Supported engine versions for the RDS for Oracle instance store - -The instance store is supported for the following RDS for Oracle engine versions: -+ 21\.0\.0\.0\.ru\-2022\-01\.rur\-2022\-01\.r1 or higher Oracle Database 21c versions -+ 19\.0\.0\.0\.ru\-2021\-10\.rur\-2021\-10\.r1 or higher Oracle Database 19c versions - -### Supported AWS Regions for the RDS for Oracle instance store - -The instance store is available in all AWS Regions where one or more of these instance types are supported\. For more information on the db\.m5d and db\.r5d instance classes, see [DB instance classes](Concepts.DBInstanceClass.md)\. For more information on the instance classes supported by Amazon RDS for Oracle, see [RDS for Oracle instance classes](Oracle.Concepts.InstanceClasses.md)\. - -### Cost of the RDS for Oracle instance store - -The cost of the instance store is built into the cost of the instance\-store turned on instances\. You don't incur additional costs by enabling an instance store on an RDS for Oracle DB instance\. For more information about instance\-store turned on instances, see [Supported instance classes for the RDS for Oracle instance store](#CHAP_Oracle.advanced-features.instance-store.overview.instance-classes)\. - -## Turning on an RDS for Oracle instance store - -To turn on the instance store for RDS for Oracle temporary data, do one of the following: -+ Create an RDS for Oracle DB instance using a supported instance class\. For more information, see [Creating an Amazon RDS DB instance](USER_CreateDBInstance.md)\. -+ Modify an existing RDS for Oracle DB instance to use a supported instance class\. For more information, see [Modifying an Amazon RDS DB instance](Overview.DBInstance.Modifying.md)\. - -## Configuring an RDS for Oracle instance store - -By default, 100% of instance store space is allocated to the temporary tablespace\. To configure the instance store to allocate space to the flash cache and temporary tablespace, set the following parameters in the parameter group for your instance: - -**db\_flash\_cache\_size=\{DBInstanceStore\*\{0,2,4,6,8,10\}/10\}** -This parameter specifies the amount of storage space allocated for the flash cache\. This parameter is valid only for Oracle Database Enterprise Edition\. The default value is `{DBInstanceStore*0/10}`\. If you set a nonzero value for `db_flash_cache_size`, your RDS for Oracle instance enables the flash cache after you restart the instance\. - -**rds\.instance\_store\_temp\_size=\{DBInstanceStore\*\{0,2,4,6,8,10\}/10\}** -This parameter specifies the amount of storage space allocated for the temporary tablespace\. The default value is `{DBInstanceStore*10/10}`\. This parameter is modifiable for Oracle Database Enterprise Edition and read\-only for Standard Edition 2\. If you set a nonzero value for `rds.instance_store_temp_size`, Amazon RDS allocates space in the instance store for the temporary tablespace\. -You can set the `db_flash_cache_size` and `rds.instance_store_temp_size` parameters for DB instances that don't use an instance store\. In this case, both settings evaluate to `0`, which turns off the feature\. In this case, you can use the same parameter group for different instance sizes and for instances that don't use an instance store\. If you modify these parameters, make sure to reboot the associated instances so that the changes can take effect\. -If you allocate space for a temporary tablespace, Amazon RDS doesn't create the temporary tablespace automatically\. To learn how to create the temporary tablespace on the instance store, see [Creating a temporary tablespace on the instance store](Appendix.Oracle.CommonDBATasks.Database.md#Appendix.Oracle.CommonDBATasks.creating-tts-instance-store)\. - -The combined value of the preceding parameters must not exceed 10/10, or 100%\. The following table illustrates valid and invalid parameter settings\. - - -| db\_flash\_cache\_size setting | rds\.instance\_store\_temp\_size setting | Explanation | -| --- | --- | --- | -| db\_flash\_cache\_size=\{DBInstanceStore\*0/10\} | rds\.instance\_store\_temp\_size=\{DBInstanceStore\*10/10\} | This is a valid configuration for all editions of Oracle Database\. Amazon RDS allocates 100% of instance store space to the temporary tablespace\. This is the default\. | -| db\_flash\_cache\_size=\{DBInstanceStore\*10/10\} | rds\.instance\_store\_temp\_size=\{DBInstanceStore\*0/10\} | This is a valid configuration for Oracle Database Enterprise Edition only\. Amazon RDS allocates 100% of instance store space to the flash cache\. | -| db\_flash\_cache\_size=\{DBInstanceStore\*2/10\} | rds\.instance\_store\_temp\_size=\{DBInstanceStore\*8/10\} | This is a valid configuration for Oracle Database Enterprise Edition only\. Amazon RDS allocates 20% of instance store space to the flash cache, and 80% of instance store space to the temporary tablespace\. | -| db\_flash\_cache\_size=\{DBInstanceStore\*6/10\} | rds\.instance\_store\_temp\_size=\{DBInstanceStore\*4/10\} | This is a valid configuration for Oracle Database Enterprise Edition only\. Amazon RDS allocates 60% of instance store space to the flash cache, and 40% of instance store space to the temporary tablespace\. | -| db\_flash\_cache\_size=\{DBInstanceStore\*2/10\} | rds\.instance\_store\_temp\_size=\{DBInstanceStore\*4/10\} | This is a valid configuration for Oracle Database Enterprise Edition only\. Amazon RDS allocates 20% of instance store space to the flash cache, and 40% of instance store space to the temporary tablespace\. | -| db\_flash\_cache\_size=\{DBInstanceStore\*8/10\} | rds\.instance\_store\_temp\_size=\{DBInstanceStore\*8/10\} | This is an invalid configuration because the combined percentage of instance store space exceeds 100%\. In such cases, Amazon RDS fails the attempt\. | - -## Considerations when changing the DB instance type - -If you change your DB instance type, it can affect the configuration of the flash cache or the temporary tablespace on the instance store\. Consider the following modifications and their effects: - -You scale up or scale down the DB instance that supports the instance store\. -The following values increase or decrease proportionally to the new size of the instance store: -+ The new size of the flash cache\. -+ The space allocated to the temporary tablespaces that reside in the instance store\. -For example, the setting `db_flash_cache_size={DBInstanceStore*6/10}` on a db\.m5d\.4xlarge instance provides around 340 GB of flash cache space\. If you scale up the instance type to db\.m5d\.8xlarge, the flash cache space increases to around 680 GB\. - -You modify a DB instance that doesn't use an instance store to an instance that does use an instance store\. -If `db_flash_cache_size` is set to a value larger than `0`, the flash cache is configured\. If `rds.instance_store_temp_size` is set to a value larger than `0`, the instance store space is allocated for use by a temporary tablespace\. RDS for Oracle doesn't move tempfiles to the instance store automatically\. For information about using the allocated space, see [Creating a temporary tablespace on the instance store](Appendix.Oracle.CommonDBATasks.Database.md#Appendix.Oracle.CommonDBATasks.creating-tts-instance-store) or [Adding a tempfile to the instance store on a read replica](Appendix.Oracle.CommonDBATasks.Database.md#Appendix.Oracle.CommonDBATasks.adding-tempfile-replica)\. - -You modify a DB instance that uses an instance store to an instance that doesn't use an instance store\. -In this case, RDS for Oracle removes the flash cache\. RDS re\-creates the tempfile that is currently located on the instance store on an Amazon EBS volume\. The maximum size of the new tempfile is the former size of the `rds.instance_store_temp_size` parameter\. - -## Working with an instance store on an Oracle read replica - -Read replicas support the flash cache and temporary tablespaces on an instance store\. While the flash cache works the same way as on the primary DB instance, note the following differences for temporary tablespaces: -+ You can't create a temporary tablespace on a read replica\. If you create a new temporary tablespace on the primary instance, RDS for Oracle replicates the tablespace information without tempfiles\. To add a new tempfile, use either of the following techniques: - + Use the Amazon RDS procedure `rdsadmin.rdsadmin_util.add_inst_store_tempfile`\. RDS for Oracle creates a tempfile in the instance store on your read replica, and adds it to the specified temporary tablespace\. - + Run the `ALTER TABLESPACE … ADD TEMPFILE` command\. RDS for Oracle places the tempfile on Amazon EBS storage\. -**Note** -The tempfile sizes and storage types can be different on the primary DB instance and the read replica\. -+ You can manage the default temporary tablespace setting only on the primary DB instance\. RDS for Oracle replicates the setting to all read replicas\. -+ You can configure the temporary tablespace groups only on the primary DB instance\. RDS for Oracle replicates the setting to all read replicas\. - -## Configuring a temporary tablespace group on an instance store and Amazon EBS - -You can configure a temporary tablespace group to include temporary tablespaces on both an instance store and Amazon EBS\. This technique is useful when you want more temporary storage than is allowed by the maximum setting of `rds.instance_store_temp_size`\. - -When you configure a temporary tablespace group on both an instance store and Amazon EBS, the two tablespaces have significantly different performance characteristics\. Oracle Database chooses the tablespace to serve queries based on an internal algorithm\. Therefore, similar queries can vary in performance\. - -Typically, you create a temporary tablespace in the instance store as follows: - -1. Create a temporary tablespace in the instance store\. - -1. Set the new tablespace as the database default temporary tablespace\. - -If the tablespace size in the instance store is insufficient, you can create additional temporary storage as follows: - -1. Assign the temporary tablespace in the instance store to a temporary tablespace group\. - -1. Create a new temporary tablespace in Amazon EBS if one doesn't exist\. - -1. Assign the temporary tablespace in Amazon EBS to the same tablespace group that includes the instance store tablespace\. - -1. Set the tablespace group as the default temporary tablespace\. - -The following example assumes that the size of the temporary tablespace in the instance store doesn't meet your application requirements\. The example creates the temporary tablespace `temp_in_inst_store` in the instance store, assigns it to tablespace group `temp_group`, adds the existing Amazon EBS tablespace named `temp_in_ebs` to this group, and sets this group as the default temporary tablespace\. - -``` -SQL> EXEC rdsadmin.rdsadmin_util.create_inst_store_tmp_tblspace('temp_in_inst_store'); - -PL/SQL procedure successfully completed. - -SQL> ALTER TABLESPACE temp_in_inst_store TABLESPACE GROUP temp_group; - -Tablespace altered. - -SQL> ALTER TABLESPACE temp_in_ebs TABLESPACE GROUP temp_group; - -Tablespace altered. - -SQL> EXEC rdsadmin.rdsadmin_util.alter_default_temp_tablespace('temp_group'); - -PL/SQL procedure successfully completed. - -SQL> SELECT * FROM DBA_TABLESPACE_GROUPS; - -GROUP_NAME TABLESPACE_NAME ------------------------------- ------------------------------ -TEMP_GROUP TEMP_IN_EBS -TEMP_GROUP TEMP_IN_INST_STORE - -SQL> SELECT PROPERTY_VALUE FROM DATABASE_PROPERTIES WHERE PROPERTY_NAME='DEFAULT_TEMP_TABLESPACE'; - -PROPERTY_VALUE --------------- -TEMP_GROUP -``` - -## Removing an RDS for Oracle instance store - -To remove the instance store, modify your RDS for Oracle DB instance to use an instance type that doesn't support instance store, such as db\.m5 or db\.r5\. \ No newline at end of file diff --git a/doc_source/CHAP_Oracle.advanced-features.md b/doc_source/CHAP_Oracle.advanced-features.md deleted file mode 100644 index bd086f2..0000000 --- a/doc_source/CHAP_Oracle.advanced-features.md +++ /dev/null @@ -1,8 +0,0 @@ -# Configuring advanced RDS for Oracle features - -RDS for Oracle supports various advanced features, including HugePages, an instance store, and extended data types\. - -**Topics** -+ [Storing temporary data in an RDS for Oracle instance store](CHAP_Oracle.advanced-features.instance-store.md) -+ [Turning on HugePages for an RDS for Oracle instance](Oracle.Concepts.HugePages.md) -+ [Turning on extended data types in RDS for Oracle](Oracle.Concepts.ExtendedDataTypes.md) \ No newline at end of file diff --git a/doc_source/CHAP_Oracle.md b/doc_source/CHAP_Oracle.md deleted file mode 100644 index b711b8d..0000000 --- a/doc_source/CHAP_Oracle.md +++ /dev/null @@ -1,36 +0,0 @@ -# Amazon RDS for Oracle - -Amazon RDS supports DB instances that run the following versions and editions of Oracle Database: -+ Oracle Database 21c \(21\.0\.0\.0\) -+ Oracle Database 19c \(19\.0\.0\.0\) - -**Note** -Oracle Database 11g, Oracle Database 12c, and Oracle Database 18c are legacy versions that are no longer supported in Amazon RDS\. - -Before creating a DB instance, complete the steps in the [Setting up for Amazon RDS](CHAP_SettingUp.md) section of this guide\. When you create a DB instance using your master account, the account gets DBA privileges, with some limitations\. Use this account for administrative tasks such as creating additional database accounts\. You can't use SYS, SYSTEM, or other Oracle\-supplied administrative accounts\. - -You can create the following: -+ DB instances -+ DB snapshots -+ Point\-in\-time restores -+ Automated backups -+ Manual backups - -You can use DB instances running Oracle inside a VPC\. You can also add features to your Oracle DB instance by enabling various options\. Amazon RDS supports Multi\-AZ deployments for Oracle as a high\-availability, failover solution\. - -**Important** -To deliver a managed service experience, Amazon RDS doesn't provide shell access to DB instances\. It also restricts access to certain system procedures and tables that need advanced privileges\. You can access your database using standard SQL clients such as Oracle SQL\*Plus\. However, you can't access the host directly by using Telnet or Secure Shell \(SSH\)\. - -**Topics** -+ [Overview of Oracle on Amazon RDS](Oracle.Concepts.overview.md) -+ [Connecting to your RDS for Oracle DB instance](USER_ConnectToOracleInstance.md) -+ [Securing Oracle DB instance connections](Oracle.Concepts.RestrictedDBAPrivileges.md) -+ [Working with CDBs in RDS for Oracle](oracle-multitenant.md) -+ [Administering your Oracle DB instance](Appendix.Oracle.CommonDBATasks.md) -+ [Configuring advanced RDS for Oracle features](CHAP_Oracle.advanced-features.md) -+ [Importing data into Oracle on Amazon RDS](Oracle.Procedural.Importing.md) -+ [Working with read replicas for Amazon RDS for Oracle](oracle-read-replicas.md) -+ [Adding options to Oracle DB instances](Appendix.Oracle.Options.md) -+ [Upgrading the RDS for Oracle DB engine](USER_UpgradeDBInstance.Oracle.md) -+ [Using third\-party software with your RDS for Oracle DB instance](Oracle.Resources.md) -+ [Oracle Database engine release notes](USER_Oracle_Releases.md) \ No newline at end of file diff --git a/doc_source/CHAP_PostgreSQL.md b/doc_source/CHAP_PostgreSQL.md deleted file mode 100644 index 7542bb9..0000000 --- a/doc_source/CHAP_PostgreSQL.md +++ /dev/null @@ -1,253 +0,0 @@ -# Amazon RDS for PostgreSQL - -Amazon RDS supports DB instances running several versions of PostgreSQL\. For a list of available versions, see [Available PostgreSQL database versions](#PostgreSQL.Concepts.General.DBVersions)\. - -**Note** -Deprecation of PostgreSQL 9\.6 is scheduled for April 26, 2022\. For more information, see [Deprecation of PostgreSQL version 9\.6](#PostgreSQL.Concepts.General.DBVersions.Deprecation96)\. - -You can create DB instances and DB snapshots, point\-in\-time restores and backups\. DB instances running PostgreSQL support Multi\-AZ deployments, read replicas, Provisioned IOPS, and can be created inside a virtual private cloud \(VPC\)\. You can also use Secure Socket Layer \(SSL\) to connect to a DB instance running PostgreSQL\. - -Before creating a DB instance, make sure to complete the steps in [Setting up for Amazon RDS](CHAP_SettingUp.md)\. - -You can use any standard SQL client application to run commands for the instance from your client computer\. Such applications include pgAdmin, a popular Open Source administration and development tool for PostgreSQL, or psql, a command line utility that is part of a PostgreSQL installation\. To deliver a managed service experience, Amazon RDS doesn't provide host access to DB instances\. Also, it restricts access to certain system procedures and tables that require advanced privileges\. Amazon RDS supports access to databases on a DB instance using any standard SQL client application\. Amazon RDS doesn't allow direct host access to a DB instance by using Telnet or Secure Shell \(SSH\)\. - -Amazon RDS for PostgreSQL is compliant with many industry standards\. For example, you can use Amazon RDS for PostgreSQL databases to build HIPAA\-compliant applications and to store healthcare\-related information\. This includes storage for protected health information \(PHI\) under a completed Business Associate Agreement \(BAA\) with AWS\. Amazon RDS for PostgreSQL also meets Federal Risk and Authorization Management Program \(FedRAMP\) security requirements\. Amazon RDS for PostgreSQL has received a FedRAMP Joint Authorization Board \(JAB\) Provisional Authority to Operate \(P\-ATO\) at the FedRAMP HIGH Baseline within the AWS GovCloud \(US\) Regions\. For more information on supported compliance standards, see [AWS cloud compliance](http://aws.amazon.com/compliance/)\. - -To import PostgreSQL data into a DB instance, follow the information in the [Importing data into PostgreSQL on Amazon RDS](PostgreSQL.Procedural.Importing.md) section\. - -**Topics** -+ [Common management tasks for Amazon RDS for PostgreSQL](#CHAP_PostgreSQL.CommonTasks) -+ [Working with the database preview environment](#working-with-the-database-preview-environment) -+ [PostgreSQL version 16 in the database preview environment](#PostgreSQL.Concepts.General.version16) -+ [Available PostgreSQL database versions](#PostgreSQL.Concepts.General.DBVersions) -+ [Supported PostgreSQL extension versions](#PostgreSQL.Concepts.General.FeatureSupport.Extensions) -+ [Working with PostgreSQL features supported by Amazon RDS for PostgreSQL](PostgreSQL.Concepts.General.FeatureSupport.md) -+ [Connecting to a DB instance running the PostgreSQL database engine](USER_ConnectToPostgreSQLInstance.md) -+ [Securing connections to RDS for PostgreSQL with SSL/TLS](PostgreSQL.Concepts.General.Security.md) -+ [Using Kerberos authentication with Amazon RDS for PostgreSQL](postgresql-kerberos.md) -+ [Using a custom DNS server for outbound network access](Appendix.PostgreSQL.CommonDBATasks.CustomDNS.md) -+ [Upgrading the PostgreSQL DB engine for Amazon RDS](USER_UpgradeDBInstance.PostgreSQL.md) -+ [Upgrading a PostgreSQL DB snapshot engine version](USER_UpgradeDBSnapshot.PostgreSQL.md) -+ [Working with read replicas for Amazon RDS for PostgreSQL](USER_PostgreSQL.Replication.ReadReplicas.md) -+ [Improving query performance for RDS for PostgreSQL with Amazon RDS Optimized Reads](USER_PostgreSQL.optimizedreads.md) -+ [Importing data into PostgreSQL on Amazon RDS](PostgreSQL.Procedural.Importing.md) -+ [Exporting data from an RDS for PostgreSQL DB instance to Amazon S3](postgresql-s3-export.md) -+ [Invoking an AWS Lambda function from an RDS for PostgreSQL DB instance](PostgreSQL-Lambda.md) -+ [Common DBA tasks for Amazon RDS for PostgreSQL](Appendix.PostgreSQL.CommonDBATasks.md) -+ [Tuning with wait events for RDS for PostgreSQL](PostgreSQL.Tuning.md) -+ [Tuning RDS for PostgreSQL with Amazon DevOps Guru proactive insights](PostgreSQL.Tuning_proactive_insights.md) -+ [Using PostgreSQL extensions with Amazon RDS for PostgreSQL](Appendix.PostgreSQL.CommonDBATasks.Extensions.md) -+ [Working with the supported foreign data wrappers for Amazon RDS for PostgreSQL](Appendix.PostgreSQL.CommonDBATasks.Extensions.foreign-data-wrappers.md) -+ [Working with Trusted Language Extensions for PostgreSQL](PostgreSQL_trusted_language_extension.md) - -## Common management tasks for Amazon RDS for PostgreSQL - -The following are the common management tasks you perform with an Amazon RDS for PostgreSQL DB instance, with links to relevant documentation for each task\. - - -| Task area | Relevant documentation | -| --- | --- | -| **Setting up Amazon RDS for first\-time use** Before you can create your DB instance, make sure to complete a few prerequisites\. For example, DB instances are created by default with a firewall that prevents access to it\. So you need to create a security group with the correct IP addresses and network configuration to access the DB instance\. | [Setting up for Amazon RDS](CHAP_SettingUp.md) | -| **Understanding Amazon RDS DB instances** If you are creating a DB instance for production purposes, you should understand how instance classes, storage types, and Provisioned IOPS work in Amazon RDS\. | [DB instance classes](Concepts.DBInstanceClass.md) [Amazon RDS storage types](CHAP_Storage.md#Concepts.Storage) [Provisioned IOPS SSD storage](CHAP_Storage.md#USER_PIOPS) | -| **Finding available PostgreSQL versions** Amazon RDS supports several versions of PostgreSQL\. | [Available PostgreSQL database versions](#PostgreSQL.Concepts.General.DBVersions) | -| **Setting up high availability and failover support** A production DB instance should use Multi\-AZ deployments\. Multi\-AZ deployments provide increased availability, data durability, and fault tolerance for DB instances\. | [Configuring and managing a Multi\-AZ deployment](Concepts.MultiAZ.md) | -| **Understanding the Amazon Virtual Private Cloud \(VPC\) network** If your AWS account has a default VPC, then your DB instance is automatically created inside the default VPC\. In some cases, your account might not have a default VPC, and you might want the DB instance in a VPC\. In these cases, create the VPC and subnet groups before you create the DB instance\. | [Working with a DB instance in a VPC](USER_VPC.WorkingWithRDSInstanceinaVPC.md) | -| **Importing data into Amazon RDS PostgreSQL** You can use several different tools to import data into your PostgreSQL DB instance on Amazon RDS\. | [Importing data into PostgreSQL on Amazon RDS](PostgreSQL.Procedural.Importing.md) | -| **Setting up read\-only read replicas \(primary and standbys\)** RDS for PostgreSQL supports read replicas in both the same AWS Region and in a different AWS Region from the primary instance\. | [Working with DB instance read replicas](USER_ReadRepl.md) [Working with read replicas for Amazon RDS for PostgreSQL](USER_PostgreSQL.Replication.ReadReplicas.md) [Creating a read replica in a different AWS Region](USER_ReadRepl.md#USER_ReadRepl.XRgn) | -| **Understanding security groups** By default, DB instances are created with a firewall that prevents access to them\. To provide access through that firewall, you edit the inbound rules for the VPC security group associated with the VPC hosting the DB instance\. | [Controlling access with security groups](Overview.RDSSecurityGroups.md) | -| **Setting up parameter groups and features** To change the default parameters for your DB instance, create a custom DB parameter group and change settings to that\. If you do this before creating your DB instance, you can choose your custom DB parameter group when you create the instance\. | [Working with parameter groups](USER_WorkingWithParamGroups.md) | -| **Connecting to your PostgreSQL DB instance** After creating a security group and associating it to a DB instance, you can connect to the DB instance using any standard SQL client application such as `psql` or `pgAdmin`\. | [Connecting to a DB instance running the PostgreSQL database engine](USER_ConnectToPostgreSQLInstance.md) [Using SSL with a PostgreSQL DB instance](PostgreSQL.Concepts.General.SSL.md) | -| **Backing up and restoring your DB instance** You can configure your DB instance to take automated backups, or take manual snapshots, and then restore instances from the backups or snapshots\. | [Backing up and restoring](CHAP_CommonTasks.BackupRestore.md) | -| **Monitoring the activity and performance of your DB instance** You can monitor a PostgreSQL DB instance by using CloudWatch Amazon RDS metrics, events, and enhanced monitoring\. | [Viewing metrics in the Amazon RDS console](USER_Monitoring.md) [Viewing Amazon RDS events](USER_ListEvents.md) | -| **Upgrading the PostgreSQL database version** You can do both major and minor version upgrades for your PostgreSQL DB instance\. | [Upgrading the PostgreSQL DB engine for Amazon RDS](USER_UpgradeDBInstance.PostgreSQL.md) [ Choosing a major version upgrade for PostgreSQL](USER_UpgradeDBInstance.PostgreSQL.md#USER_UpgradeDBInstance.PostgreSQL.MajorVersion) | -| **Working with log files** You can access the log files for your PostgreSQL DB instance\. | [RDS for PostgreSQL database log files](USER_LogAccess.Concepts.PostgreSQL.md) | -| **Understanding the best practices for PostgreSQL DB instances** Find some of the best practices for working with PostgreSQL on Amazon RDS\. | [Best practices for working with PostgreSQL](CHAP_BestPractices.md#CHAP_BestPractices.PostgreSQL) | - -Following is a list of other sections in this guide that can help you understand and use important features of RDS for PostgreSQL: -+ [Understanding PostgreSQL roles and permissions](Appendix.PostgreSQL.CommonDBATasks.Roles.md) -+ [Controlling user access to the PostgreSQL databaseControlling user access to PostgreSQL](Appendix.PostgreSQL.CommonDBATasks.Roles.md#Appendix.PostgreSQL.CommonDBATasks.Access) -+ [Working with parameters on your RDS for PostgreSQL DB instance](Appendix.PostgreSQL.CommonDBATasks.Parameters.md) -+ [Understanding logging mechanisms supported by RDS for PostgreSQL](Appendix.PostgreSQL.CommonDBATasks.md#Appendix.PostgreSQL.CommonDBATasks.Auditing) -+ [Working with the PostgreSQL autovacuum on Amazon RDS for PostgreSQL](Appendix.PostgreSQL.CommonDBATasks.Autovacuum.md) -+ [Using a custom DNS server for outbound network access](Appendix.PostgreSQL.CommonDBATasks.CustomDNS.md) - -## Working with the database preview environment - - The PostgreSQL community continuously releases new PostgreSQL version and extensions, including beta versions\. This gives PostgreSQL users the opportunity to try out a new PostgreSQL version early\. To learn more about the PostgreSQL community beta release process, see [Beta Information](https://www.postgresql.org/developer/beta/) in the PostgreSQL documentation\. Similarly, Amazon RDS makes certain PostgreSQL beta versions available as Preview releases\. This allows you to create DB instances using the Preview version and test out its features in the Database Preview Environment\. - -RDS for PostgreSQL DB instances in the Database Preview Environment are functionally similar to other RDS for PostgreSQL instances\. However, you can't use a Preview version for production\. - -Keep in mind the following important limitations: -+ All DB instances are deleted 60 days after you create them, along with any backups and snapshots\. -+ You can only create a DB instance in a virtual private cloud \(VPC\) based on the Amazon VPC service\. -+ You can only use General Purpose SSD and Provisioned IOPS SSD storage\. -+ You can't get help from AWS Support with DB instances\. Instead, you can post your questions to the AWS‐managed Q&A community, [AWS re:Post](https://repost.aws/tags/TAsibBK6ZeQYihN9as4S_psg/amazon-relational-database-service)\. -+ You can't copy a snapshot of a DB instance to a production environment\. - -The following options are supported by the Preview\. -+ You can create DB instances using M6i, R6i, M6g, M5, T3, R6g, and R5 instance types only\. For more information about RDS instance classes, see [DB instance classes](Concepts.DBInstanceClass.md)\. -+ You can use both single\-AZ and multi\-AZ deployments\. -+ You can use standard PostgreSQL dump and load functions to export databases from or import databases to the Database Preview Environment\. - -### Features not supported in the preview environment - -The following features aren't available in the preview environment: -+ Cross\-Region snapshot copy -+ Cross\-Region read replicas - -### Creating a new DB instance in the preview environment - -Use the following procedure to create a DB instance in the preview environment\. - -**To create a DB instance in the preview environment** - -1. Sign in to the AWS Management Console and open the Amazon RDS console at [https://console\.aws\.amazon\.com/rds/](https://console.aws.amazon.com/rds/)\. - -1. Choose **Dashboard** from the navigation pane\. - -1. In the Dashboard page, locate the **Database Preview Environment** section on the Dashboard page, as shown in the following image\. -![\[Preview environment section with link displayed in RDS Console, Dashboard\]](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/images/rpg-preview-environment-dashboard.png) - - You can navigate directly to the [Database preview environment](https://us-east-2.console.aws.amazon.com/rds-preview/home?region=us-east-2#)\. Before you can proceed, you must acknowledge and accept the limitations\. -![\[Preview environment limitations dialog\]](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/images/rpg-preview-environment-console.png) - -1. To create the RDS for PostgreSQL DB instance, follow the same process as that for creating any Amazon RDS DB instance\. For more information, see the [Console](USER_CreateDBInstance.md#USER_CreateDBInstance.CON) procedure in [Creating a DB instance](USER_CreateDBInstance.md#USER_CreateDBInstance.Creating)\. - -To create an instance in the Database Preview Environment using the RDS API or the AWS CLI, use the following endpoint\. - -``` -rds-preview.us-east-2.amazonaws.com -``` - -## PostgreSQL version 16 in the database preview environment - -**** -***This is preview documentation for Amazon RDS PostgreSQL version 16\. It is subject to change\.*** - -PostgreSQL version 16 is now available in the Amazon RDS Database Preview Environment\. PostgreSQL version 16 contains several improvements that are described in the following PostgreSQL documentation: -+ [ PostgreSQL 16](https://www.postgresql.org/docs/16/release-16.html) -+ [ PostgreSQL 16 Beta 1 Released\!](https://www.postgresql.org/about/news/postgresql-16-beta-1-released-2643/) - -For information on the Database Preview Environment, see [Working with the database preview environment](#working-with-the-database-preview-environment)\. To access the Preview Environment from the console, select [https://console\.aws\.amazon\.com/rds\-preview/](https://console.aws.amazon.com/rds-preview/)\. - -## Available PostgreSQL database versions - -Amazon RDS supports DB instances running several editions of PostgreSQL\. You can specify any currently available PostgreSQL version when creating a new DB instance\. You can specify the major version \(such as PostgreSQL 14\), and any available minor version for the specified major version\. If no version is specified, Amazon RDS defaults to an available version, typically the most recent version\. If a major version is specified but a minor version is not, Amazon RDS defaults to a recent release of the major version you have specified\. - -To see a list of available versions, as well as defaults for newly created DB instances, use the [https://docs.aws.amazon.com/cli/latest/reference/rds/describe-db-engine-versions.html](https://docs.aws.amazon.com/cli/latest/reference/rds/describe-db-engine-versions.html) AWS CLI command\. For example, to display the default PostgreSQL engine version, use the following command: - -``` -aws rds describe-db-engine-versions --default-only --engine postgres -``` - -For details about the PostgreSQL versions that are supported on Amazon RDS, see the [https://docs.aws.amazon.com/AmazonRDS/latest/PostgreSQLReleaseNotes/Welcome.html](https://docs.aws.amazon.com/AmazonRDS/latest/PostgreSQLReleaseNotes/Welcome.html)\. - -### Deprecation of PostgreSQL version 10 - -On April 17, 2023, Amazon RDS plans to deprecate PostgreSQL 10 using the following schedule\. We recommend that you take action and upgrade your PostgreSQL databases running on major version 10 to a later version, such as PostgreSQL version 14\. To upgrade your RDS for PostgreSQL major version 10 DB instance from a PostgreSQL version older than 10\.19, we recommend that you first upgrade to version 10\.19 and then upgrade to version 14\. For more information, see [Upgrading the PostgreSQL DB engine for Amazon RDS](USER_UpgradeDBInstance.PostgreSQL.md)\. - - -| Action or recommendation | Dates | -| --- | --- | -| The PostgreSQL community plans to deprecate PostgreSQL 10 and won't provide any security patches after this date\. | November 10, 2022 | -| Start upgrading RDS for PostgreSQL 10 DB instances to a later major version, such as PostgreSQL 14\. Although you can continue to restore PostgreSQL 10 snapshots and create read replicas with version 10, be aware of the other critical dates in this deprecation schedule and their impact\. | Now – February 14, 2023 | -| After this date, you can't create new Amazon RDS instances with PostgreSQL major version 10 from either the AWS Management Console or the AWS CLI\. | February 14, 2023 | -| After this date, Amazon RDS automatically upgrades PostgreSQL 10 instances to version 14\. If you restore a PostgreSQL 10 database snapshot, Amazon RDS automatically upgrades the restored database to PostgreSQL 14\. | April 17, 2023 | - -For more information about RDS for PostgreSQL version 10 deprecation, see [\[Announcement\]: RDS for PostgreSQL 10 deprecation](https://repost.aws/questions/QUph1IFLkkRiyc0pCdTH493Q/announcement-amazon-rds-for-postgre-sql-10-deprecation) in AWS re:Post\. - -### Deprecation of PostgreSQL version 9\.6 - -On March 31, 2022, Amazon RDS plans to deprecate PostgreSQL 9\.6 using the following schedule\. This extends the previously announced date of January 18, 2022 to April 26, 2022\. You should upgrade all your PostgreSQL 9\.6 DB instances to PostgreSQL 12 or higher as soon as possible\. We recommend that you first upgrade to minor version 9\.6\.20 or higher and then upgrade directly to PostgreSQL 12 rather than upgrading to an intermediate major version\. For more information, see [Upgrading the PostgreSQL DB engine for Amazon RDS](USER_UpgradeDBInstance.PostgreSQL.md)\. - - -| Action or recommendation | Dates | -| --- | --- | -| The PostgreSQL community discontinued support for PostgreSQL 9\.6, and will no longer provide bug fixes or security patches for this version\. | November 11, 2021 | -| Start upgrading RDS for PostgreSQL 9\.6 DB instances to PostgreSQL 12 or higher as soon as possible\. Although you can continue to restore PostgreSQL 9\.6 snapshots and create read replicas with version 9\.6, be aware of the other critical dates in this deprecation schedule and their impact\. | Now – March 31, 2022 | -| After this date, you can't create new Amazon RDS instances with PostgreSQL major version 9\.6 from either the AWS Management Console or the AWS CLI\. | March 31, 2022 | -| After this date, Amazon RDS automatically upgrades PostgreSQL 9\.6 instances to version 12\. If you restore a PostgreSQL 9\.6 database snapshot, Amazon RDS automatically upgrades the restored database to PostgreSQL 12\. | April 26, 2022 | - -### Deprecated versions for Amazon RDS for PostgreSQL - -RDS for PostgreSQL 9\.5 is deprecated as of March, 2021\. For more information about RDS for PostgreSQL 9\.5 deprecation, see [ Upgrading from Amazon RDS for PostgreSQL version 9\.5](http://aws.amazon.com/blogs/database/upgrading-from-amazon-rds-for-postgresql-version-9-5/)\. - -To learn more about deprecation policy for RDS for PostgreSQL, see [Amazon RDS FAQs](http://aws.amazon.com/rds/faqs/)\. For more information about PostgreSQL versions, see [Versioning Policy](https://www.postgresql.org/support/versioning/) in the PostgreSQL documentation\. - -## Supported PostgreSQL extension versions - -RDS for PostgreSQL supports many PostgreSQL extensions\. The PostgreSQL community sometimes refers to these as modules\. Extensions expand on the functionality provided by the PostgreSQL engine\. You can find a list of extensions supported by Amazon RDS in the default DB parameter group for that PostgreSQL version\. You can also see the current extensions list using `psql` by showing the `rds.extensions` parameter as in the following example\. - -``` -SHOW rds.extensions; -``` - -**Note** -Parameters added in a minor version release might display inaccurately when using the `rds.extensions` parameter in `psql`\. - -As of RDS for PostgreSQL 13, certain extensions can be installed by database users other than the `rds_superuser`\. These are known as *trusted extensions*\. To learn more, see [PostgreSQL trusted extensions](#PostgreSQL.Concepts.General.Extensions.Trusted)\. - -Certain versions of RDS for PostgreSQL support the `rds.allowed_extensions` parameter\. This parameter lets an `rds_superuser` limit the extensions that can be installed in the RDS for PostgreSQL DB instance\. For more information, see [Restricting installation of PostgreSQL extensions](#PostgreSQL.Concepts.General.FeatureSupport.Extensions.Restriction)\. - -For lists of PostgreSQL extensions and versions that are supported by each available RDS for PostgreSQL version, see [PostgreSQL extensions supported on Amazon RDS](https://docs.aws.amazon.com/AmazonRDS/latest/PostgreSQLReleaseNotes/postgresql-extensions.html) in *Amazon RDS for PostgreSQL Release Notes*\. - -### Restricting installation of PostgreSQL extensions - -You can restrict which extensions can be installed on a PostgreSQL DB instance\. To do so, set the `rds.allowed_extensions` parameter to a string of comma\-separated extension names\. Only these extensions can then be installed in the PostgreSQL DB instance\. - -The default string for the `rds.allowed_extensions` parameter is '\*', which means that any extension available for the engine version can be installed\. Changing the `rds.allowed_extensions` parameter does not require a database restart because it's a dynamic parameter\. - -The PostgreSQL DB instance engine must be one of the following versions for you to use the `rds.allowed_extensions` parameter: -+ PostgreSQL 14\.1 or a higher minor version -+ PostgreSQL 13\.2 or a higher minor version -+ PostgreSQL 12\.6 or a higher minor version - - To see which extension installations are allowed, use the following psql command\. - -``` -postgres=> SHOW rds.allowed_extensions; - rds.allowed_extensions ------------------------- - * -``` - -If an extension was installed prior to it being left out of the list in the `rds.allowed_extensions` parameter, the extension can still be used normally, and commands such as `ALTER EXTENSION` and `DROP EXTENSION` will continue to work\. However, after an extension is restricted, `CREATE EXTENSION` commands for the restricted extension will fail\. - -Installation of extension dependencies with `CREATE EXTENSION CASCADE` are also restricted\. The extension and its dependencies must be specified in `rds.allowed_extensions`\. If an extension dependency installation fails, the entire `CREATE EXTENSION CASCADE` statement will fail\. - -If an extension is not included with the `rds.allowed_extensions` parameter, you will see an error such as the following if you try to install it\. - -``` -ERROR: permission denied to create extension "extension-name" -HINT: This extension is not specified in "rds.allowed_extensions". -``` - -### PostgreSQL trusted extensions - -To install most PostgreSQL extensions requires `rds_superuser` privileges\. PostgreSQL 13 introduced trusted extensions, which reduce the need to grant `rds_superuser` privileges to regular users\. With this feature, users can install many extensions if they have the `CREATE` privilege on the current database instead of requiring the `rds_superuser` role\. For more information, see the SQL [CREATE EXTENSION](https://www.postgresql.org/docs/current/sql-createextension.html) command in the PostgreSQL documentation\. - -The following lists the extensions that can be installed by a user who has the `CREATE` privilege on the current database and do not require the `rds_superuser` role: -+ bool\_plperl -+ [btree\_gin](http://www.postgresql.org/docs/current/btree-gin.html) -+ [btree\_gist](http://www.postgresql.org/docs/current/btree-gist.html) -+ [citext ](http://www.postgresql.org/docs/current/citext.html) -+ [cube ](http://www.postgresql.org/docs/current/cube.html) -+ [ dict\_int ](http://www.postgresql.org/docs/current/dict-int.html) -+ [fuzzystrmatch](http://www.postgresql.org/docs/current/fuzzystrmatch.html) -+ [hstore](http://www.postgresql.org/docs/current/hstore.html) -+ [ intarray](http://www.postgresql.org/docs/current/intarray.html) -+ [isn](http://www.postgresql.org/docs/current/isn.html) -+ jsonb\_plperl -+ [ltree ](http://www.postgresql.org/docs/current/ltree.html) -+ [pg\_trgm](http://www.postgresql.org/docs/current/pgtrgm.html) -+ [pgcrypto](http://www.postgresql.org/docs/current/pgcrypto.html) -+ [plperl](https://www.postgresql.org/docs/current/plperl.html) -+ [plpgsql](https://www.postgresql.org/docs/current/plpgsql.html) -+ [pltcl](https://www.postgresql.org/docs/current/pltcl-overview.html) -+ [tablefunc](http://www.postgresql.org/docs/current/tablefunc.html) -+ [tsm\_system\_rows](https://www.postgresql.org/docs/current/tsm-system-rows.html) -+ [tsm\_system\_time](https://www.postgresql.org/docs/current/tsm-system-time.html) -+ [unaccent](http://www.postgresql.org/docs/current/unaccent.html) -+ [uuid\-ossp](http://www.postgresql.org/docs/current/uuid-ossp.html) - -For lists of PostgreSQL extensions and versions that are supported by each available RDS for PostgreSQL version, see [PostgreSQL extensions supported on Amazon RDS](https://docs.aws.amazon.com/AmazonRDS/latest/PostgreSQLReleaseNotes/postgresql-extensions.html) in *Amazon RDS for PostgreSQL Release Notes*\. \ No newline at end of file diff --git a/doc_source/CHAP_RDS_Configuring.md b/doc_source/CHAP_RDS_Configuring.md deleted file mode 100644 index af1647d..0000000 --- a/doc_source/CHAP_RDS_Configuring.md +++ /dev/null @@ -1,17 +0,0 @@ -# Configuring an Amazon RDS DB instance - -This section shows how to set up your Amazon RDS DB instance\. Before creating a DB instance, decide on the DB instance class that will run the DB instance\. Also, decide where the DB instance will run by choosing an AWS Region\. Next, create the DB instance\. - -You can configure a DB instance with an option group and a DB parameter group\. -+ An *option group* specifies features, called options, that are available for a particular Amazon RDS DB instance\. -+ A *DB parameter group* acts as a container for engine configuration values that are applied to one or more DB instances\. - -The options and parameters that are available depend on the DB engine and DB engine version\. You can specify an option group and a DB parameter group when you create a DB instance\. You can also modify a DB instance to specify them\. - -**Topics** -+ [Creating an Amazon RDS DB instance](USER_CreateDBInstance.md) -+ [Creating Amazon RDS resources with AWS CloudFormation](creating-resources-with-cloudformation.md) -+ [Connecting to an Amazon RDS DB instance](CHAP_CommonTasks.Connect.md) -+ [Working with option groups](USER_WorkingWithOptionGroups.md) -+ [Working with parameter groups](USER_WorkingWithParamGroups.md) -+ [Creating an Amazon ElastiCache cluster using Amazon RDS DB instance settings](creating-elasticache-cluster-with-RDS-settings.md) \ No newline at end of file diff --git a/doc_source/CHAP_RDS_Managing.md b/doc_source/CHAP_RDS_Managing.md deleted file mode 100644 index f20c59f..0000000 --- a/doc_source/CHAP_RDS_Managing.md +++ /dev/null @@ -1,18 +0,0 @@ -# Managing an Amazon RDS DB instance - - Following, you can find instructions for managing and maintaining your Amazon RDS DB instance\. - -**Topics** -+ [Stopping an Amazon RDS DB instance temporarily](USER_StopInstance.md) -+ [Starting an Amazon RDS DB instance that was previously stopped](USER_StartInstance.md) -+ [Connecting an EC2 instance and a DB instance automatically](ec2-rds-connect.md) -+ [Modifying an Amazon RDS DB instance](Overview.DBInstance.Modifying.md) -+ [Maintaining a DB instance](USER_UpgradeDBInstance.Maintenance.md) -+ [Upgrading a DB instance engine version](USER_UpgradeDBInstance.Upgrading.md) -+ [Renaming a DB instance](USER_RenameInstance.md) -+ [Rebooting a DB instance](USER_RebootInstance.md) -+ [Working with DB instance read replicas](USER_ReadRepl.md) -+ [Tagging Amazon RDS resources](USER_Tagging.md) -+ [Working with Amazon Resource Names \(ARNs\) in Amazon RDS](USER_Tagging.ARN.md) -+ [Working with storage for Amazon RDS DB instances](USER_PIOPS.StorageTypes.md) -+ [Deleting a DB instance](USER_DeleteInstance.md) \ No newline at end of file diff --git a/doc_source/CHAP_SQLServer.md b/doc_source/CHAP_SQLServer.md deleted file mode 100644 index 8d5b6b1..0000000 --- a/doc_source/CHAP_SQLServer.md +++ /dev/null @@ -1,551 +0,0 @@ -# Amazon RDS for Microsoft SQL Server - -Amazon RDS supports several versions and editions of Microsoft SQL Server\. The most recent supported version of each major version is listed here\. For the full list of supported versions, editions, and RDS engine versions, see [Microsoft SQL Server versions on Amazon RDS](#SQLServer.Concepts.General.VersionSupport)\. - - -+ SQL Server 2019 CU16 15\.0\.4236\.7, released per [KB5014353](https://support.microsoft.com/en-us/topic/kb5014353-description-of-the-security-update-for-sql-server-2019-cu16-june-14-2022-f0afe659-bd19-4c87-a417-a4c67a47e644) on June 14, 2022\. -+ SQL Server 2017 CU30 14\.0\.3451\.2, released per [KB5013756](https://support.microsoft.com/en-us/topic/kb5013756-cumulative-update-30-for-sql-server-2017-274943fa-8dde-4844-90ed-d3b587fa0c7c) on July 13, 2022\. -+ SQL Server 2016 SP3 GDR 13\.0\.6419\.1, released per [KB5014355](https://support.microsoft.com/en-us/topic/kb5014355-description-of-the-security-update-for-sql-server-2016-sp3-gdr-june-14-2022-bb5097a0-f8f1-4d2c-bfe1-af069ca3cc59) on June 14, 2022\. -+ SQL Server 2014 SP3 CU4 12\.0\.6439\.10, released per [KB5014164](https://support.microsoft.com/en-us/topic/kb5014164-description-of-the-security-update-for-sql-server-2014-sp3-cu4-june-14-2022-f3400be9-b2d3-4873-ae58-15e6e0cc686e) on June 14, 2022\. -+ SQL Server 2012: It's no longer possible to provision new instances in any Region\. Amazon RDS is actively migrating existing instances off this version\. -+ SQL Server 2008: It's no longer possible to provision new instances in any Region\. Amazon RDS is actively migrating existing instances off this version\. - -For information about licensing for SQL Server, see [Licensing Microsoft SQL Server on Amazon RDS](SQLServer.Concepts.General.Licensing.md)\. For information about SQL Server builds, see this Microsoft support article about [the latest SQL Server builds](https://support.microsoft.com/en-us/help/957826)\. - -With Amazon RDS, you can create DB instances and DB snapshots, point\-in\-time restores, and automated or manual backups\. DB instances running SQL Server can be used inside a VPC\. You can also use Secure Sockets Layer \(SSL\) to connect to a DB instance running SQL Server, and you can use transparent data encryption \(TDE\) to encrypt data at rest\. Amazon RDS currently supports Multi\-AZ deployments for SQL Server using SQL Server Database Mirroring \(DBM\) or Always On Availability Groups \(AGs\) as a high\-availability, failover solution\. - -To deliver a managed service experience, Amazon RDS does not provide shell access to DB instances, and it restricts access to certain system procedures and tables that require advanced privileges\. Amazon RDS supports access to databases on a DB instance using any standard SQL client application such as Microsoft SQL Server Management Studio\. Amazon RDS does not allow direct host access to a DB instance via Telnet, Secure Shell \(SSH\), or Windows Remote Desktop Connection\. When you create a DB instance, the master user is assigned to the *db\_owner* role for all user databases on that instance, and has all database\-level permissions except for those that are used for backups\. Amazon RDS manages backups for you\. - -Before creating your first DB instance, you should complete the steps in the setting up section of this guide\. For more information, see [Setting up for Amazon RDS](CHAP_SettingUp.md)\. - -**Topics** -+ [Common management tasks for Microsoft SQL Server on Amazon RDS](#SQLServer.Concepts.General) -+ [Limitations for Microsoft SQL Server DB instances](#SQLServer.Concepts.General.FeatureSupport.Limits) -+ [DB instance class support for Microsoft SQL Server](#SQLServer.Concepts.General.InstanceClasses) -+ [Microsoft SQL Server security](#SQLServer.Concepts.General.FeatureSupport.UnsupportedRoles) -+ [Compliance program support for Microsoft SQL Server DB instances](#SQLServer.Concepts.General.Compliance) -+ [SSL support for Microsoft SQL Server DB instances](#SQLServer.Concepts.General.SSL) -+ [Microsoft SQL Server versions on Amazon RDS](#SQLServer.Concepts.General.VersionSupport) -+ [Version management in Amazon RDS](#SQLServer.Concepts.General.Version-Management) -+ [Microsoft SQL Server features on Amazon RDS](#SQLServer.Concepts.General.FeatureSupport) -+ [Change data capture support for Microsoft SQL Server DB instances](#SQLServer.Concepts.General.CDC) -+ [Features not supported and features with limited support](#SQLServer.Concepts.General.FeatureNonSupport) -+ [Multi\-AZ deployments using Microsoft SQL Server Database Mirroring or Always On availability groups](#SQLServer.Concepts.General.Mirroring) -+ [Using Transparent Data Encryption to encrypt data at rest](#SQLServer.Concepts.General.Options) -+ [Functions and stored procedures for Amazon RDS for Microsoft SQL Server](#SQLServer.Concepts.General.StoredProcedures) -+ [Local time zone for Microsoft SQL Server DB instances](#SQLServer.Concepts.General.TimeZone) -+ [Licensing Microsoft SQL Server on Amazon RDS](SQLServer.Concepts.General.Licensing.md) -+ [Connecting to a DB instance running the Microsoft SQL Server database engine](USER_ConnectToMicrosoftSQLServerInstance.md) -+ [Updating applications to connect to Microsoft SQL Server DB instances using new SSL/TLS certificates](ssl-certificate-rotation-sqlserver.md) -+ [Upgrading the Microsoft SQL Server DB engine](USER_UpgradeDBInstance.SQLServer.md) -+ [Importing and exporting SQL Server databases using native backup and restore](SQLServer.Procedural.Importing.md) -+ [Working with read replicas for Microsoft SQL Server in Amazon RDS](SQLServer.ReadReplicas.md) -+ [Multi\-AZ deployments for Amazon RDS for Microsoft SQL Server](USER_SQLServerMultiAZ.md) -+ [Additional features for Microsoft SQL Server on Amazon RDS](User.SQLServer.AdditionalFeatures.md) -+ [Options for the Microsoft SQL Server database engine](Appendix.SQLServer.Options.md) -+ [Common DBA tasks for Microsoft SQL Server](Appendix.SQLServer.CommonDBATasks.md) - -## Common management tasks for Microsoft SQL Server on Amazon RDS - -The following are the common management tasks you perform with an Amazon RDS for SQL Server DB instance, with links to relevant documentation for each task\. - - -**** - -| Task area | Relevant documentation | -| --- | --- | -| **Instance classes, storage, and PIOPS** If you are creating a DB instance for production purposes, you should understand how instance classes, storage types, and Provisioned IOPS work in Amazon RDS\. | [DB instance class support for Microsoft SQL Server](#SQLServer.Concepts.General.InstanceClasses) [Amazon RDS storage types](CHAP_Storage.md#Concepts.Storage) | -| **Multi\-AZ deployments** A production DB instance should use Multi\-AZ deployments\. Multi\-AZ deployments provide increased availability, data durability, and fault tolerance for DB instances\. Multi\-AZ deployments for SQL Server are implemented using SQL Server's native DBM or AGs technology\. | [Configuring and managing a Multi\-AZ deployment](Concepts.MultiAZ.md) [Multi\-AZ deployments using Microsoft SQL Server Database Mirroring or Always On availability groups](#SQLServer.Concepts.General.Mirroring) | -| **Amazon Virtual Private Cloud \(VPC\)** If your AWS account has a default VPC, then your DB instance is automatically created inside the default VPC\. If your account does not have a default VPC, and you want the DB instance in a VPC, you must create the VPC and subnet groups before you create the DB instance\. | [Working with a DB instance in a VPC](USER_VPC.WorkingWithRDSInstanceinaVPC.md) | -| **Security groups** By default, DB instances are created with a firewall that prevents access to them\. You therefore must create a security group with the correct IP addresses and network configuration to access the DB instance\. | [Controlling access with security groups](Overview.RDSSecurityGroups.md) | -| **Parameter groups** If your DB instance is going to require specific database parameters, you should create a parameter group before you create the DB instance\. | [Working with parameter groups](USER_WorkingWithParamGroups.md) | -| **Option groups** If your DB instance is going to require specific database options, you should create an option group before you create the DB instance\. | [Options for the Microsoft SQL Server database engine](Appendix.SQLServer.Options.md) | -| **Connecting to your DB instance** After creating a security group and associating it to a DB instance, you can connect to the DB instance using any standard SQL client application such as Microsoft SQL Server Management Studio\. | [Connecting to a DB instance running the Microsoft SQL Server database engine](USER_ConnectToMicrosoftSQLServerInstance.md) | -| **Backup and restore** When you create your DB instance, you can configure it to take automated backups\. You can also back up and restore your databases manually by using full backup files \(\.bak files\)\. | [Working with backups](USER_WorkingWithAutomatedBackups.md) [Importing and exporting SQL Server databases using native backup and restore](SQLServer.Procedural.Importing.md) | -| **Monitoring** You can monitor your SQL Server DB instance by using CloudWatch Amazon RDS metrics, events, and enhanced monitoring\. | [Viewing metrics in the Amazon RDS console](USER_Monitoring.md) [Viewing Amazon RDS events](USER_ListEvents.md) | -| **Log files** You can access the log files for your SQL Server DB instance\. | [Monitoring Amazon RDS log files](USER_LogAccess.md) [Microsoft SQL Server database log files](USER_LogAccess.Concepts.SQLServer.md) | - -There are also advanced administrative tasks for working with SQL Server DB instances\. For more information, see the following documentation: -+ [Common DBA tasks for Microsoft SQL Server](Appendix.SQLServer.CommonDBATasks.md)\. -+ [Using Windows Authentication with a SQL Server DB instance](USER_SQLServerWinAuth.md) -+ [Accessing the tempdb database](SQLServer.TempDB.md) - -## Limitations for Microsoft SQL Server DB instances - -The Amazon RDS implementation of Microsoft SQL Server on a DB instance has some limitations that you should be aware of: -+ The maximum number of databases supported on a DB instance depends on the instance class type and the availability mode—Single\-AZ, Multi\-AZ Database Mirroring \(DBM\), or Multi\-AZ Availability Groups \(AGs\)\. The Microsoft SQL Server system databases don't count toward this limit\. - - The following table shows the maximum number of supported databases for each instance class type and availability mode\. Use this table to help you decide if you can move from one instance class type to another, or from one availability mode to another\. If your source DB instance has more databases than the target instance class type or availability mode can support, modifying the DB instance fails\. You can see the status of your request in the **Events** pane\. -[\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_SQLServer.html) - - \* Represents the different instance class types\. - - For example, let's say that your DB instance runs on a db\.\*\.16xlarge with Single\-AZ and that it has 76 databases\. You modify the DB instance to upgrade to using Multi\-AZ Always On AGs\. This upgrade fails, because your DB instance contains more databases than your target configuration can support\. If you upgrade your instance class type to db\.\*\.24xlarge instead, the modification succeeds\. - - If the upgrade fails, you see events and messages similar to the following: - + Unable to modify database instance class\. The instance has 76 databases, but after conversion it would only support 75\. - + Unable to convert the DB instance to Multi\-AZ: The instance has 76 databases, but after conversion it would only support 75\. - - If the point\-in\-time restore or snapshot restore fails, you see events and messages similar to the following: - + Database instance put into incompatible\-restore\. The instance has 76 databases, but after conversion it would only support 75\. -+ Some ports are reserved for Amazon RDS, and you can't use them when you create a DB instance\. -+ Client connections from IP addresses within the range 169\.254\.0\.0/16 are not permitted\. This is the Automatic Private IP Addressing Range \(APIPA\), which is used for local\-link addressing\. -+ SQL Server Standard Edition uses only a subset of the available processors if the DB instance has more processors than the software limits \(24 cores, 4 sockets, and 128GB RAM\)\. Examples of this are the db\.m5\.24xlarge and db\.r5\.24xlarge instance classes\. - - For more information, see the table of scale limits under [Editions and supported features of SQL Server 2019 \(15\.x\)](https://docs.microsoft.com/en-us/sql/sql-server/editions-and-components-of-sql-server-version-15) in the Microsoft documentation\. -+ Amazon RDS for SQL Server doesn't support importing data into the msdb database\. -+ You can't rename databases on a DB instance in a SQL Server Multi\-AZ deployment\. -+ Make sure that you use these guidelines when setting the following DB parameters on RDS for SQL Server: - + `max server memory (mb)` >= 256 MB - + `max worker threads` >= \(number of logical CPUs \* 7\) - - For more information on setting DB parameters, see [Working with parameter groups](USER_WorkingWithParamGroups.md)\. -+ The maximum storage size for SQL Server DB instances is the following: - + General Purpose \(SSD\) storage – 16 TiB for all editions - + Provisioned IOPS storage – 16 TiB for all editions - + Magnetic storage – 1 TiB for all editions - - If you have a scenario that requires a larger amount of storage, you can use sharding across multiple DB instances to get around the limit\. This approach requires data\-dependent routing logic in applications that connect to the sharded system\. You can use an existing sharding framework, or you can write custom code to enable sharding\. If you use an existing framework, the framework can't install any components on the same server as the DB instance\. -+ The minimum storage size for SQL Server DB instances is the following: - + General Purpose \(SSD\) storage – 20 GiB for Enterprise, Standard, Web, and Express Editions - + Provisioned IOPS storage – 20 GiB for Enterprise, Standard, Web, and Express Editions - + Magnetic storage – 20 GiB for Enterprise, Standard, Web, and Express Editions -+ Amazon RDS doesn't support running these services on the same server as your RDS DB instance: - + Data Quality Services - + Master Data Services - - To use these features, we recommend that you install SQL Server on an Amazon EC2 instance, or use an on\-premises SQL Server instance\. In these cases, the EC2 or SQL Server instance acts as the Master Data Services server for your SQL Server DB instance on Amazon RDS\. You can install SQL Server on an Amazon EC2 instance with Amazon EBS storage, pursuant to Microsoft licensing policies\. -+ Because of limitations in Microsoft SQL Server, restoring to a point in time before successfully running `DROP DATABASE` might not reflect the state of that database at that point in time\. For example, the dropped database is typically restored to its state up to 5 minutes before the `DROP DATABASE` command was issued\. This type of restore means that you can't restore the transactions made during those few minutes on your dropped database\. To work around this, you can reissue the `DROP DATABASE` command after the restore operation is completed\. Dropping a database removes the transaction logs for that database\. -+ For SQL Server, you create your databases after you create your DB instance\. Database names follow the usual SQL Server naming rules with the following differences: - + Database names can't start with `rdsadmin`\. - + They can't start or end with a space or a tab\. - + They can't contain any of the characters that create a new line\. - + They can't contain a single quote \(`'`\)\. - -## DB instance class support for Microsoft SQL Server - -The computation and memory capacity of a DB instance is determined by its DB instance class\. The DB instance class you need depends on your processing power and memory requirements\. For more information, see [DB instance classes](Concepts.DBInstanceClass.md)\. - -The following list of DB instance classes supported for Microsoft SQL Server is provided here for your convenience\. For the most current list, see the RDS console: [https://console\.aws\.amazon\.com/rds/](https://console.aws.amazon.com/rds/)\. - -Not all DB instance classes are available on all supported SQL Server minor versions\. For example, some newer DB instance classes such as db\.r6i aren't available on older minor versions\. You can use the [describe\-orderable\-db\-instance\-options](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/rds/describe-orderable-db-instance-options.html) AWS CLI command to find out which DB instance classes are available for your SQL Server edition and version\. - - -**** - -| SQL Server edition | 2019 support range | 2017 and 2016 support range | 2014 support range | -| --- | --- | --- | --- | -| Enterprise Edition | `db.t3.xlarge`–`db.t3.2xlarge` `db.r5.xlarge`–`db.r5.24xlarge` `db.r5b.xlarge`–`db.r5b.24xlarge` `db.r5d.xlarge`–`db.r5d.24xlarge` `db.r6i.xlarge`–`db.r6i.32xlarge` `db.m5.xlarge`–`db.m5.24xlarge` `db.m5d.xlarge`–`db.m5d.24xlarge` `db.m6i.xlarge`–`db.m6i.32xlarge` `db.x1.16xlarge`–`db.x1.32xlarge` `db.x1e.xlarge`–`db.x1e.32xlarge` `db.z1d.xlarge`–`db.z1d.12xlarge` | `db.t3.xlarge`–`db.t3.2xlarge` `db.r3.xlarge`–`db.r3.8xlarge` `db.r4.xlarge`–`db.r4.16xlarge` `db.r5.xlarge`–`db.r5.24xlarge` `db.r5b.xlarge`–`db.r5b.24xlarge` `db.r5d.xlarge`–`db.r5d.24xlarge` `db.r6i.xlarge`–`db.r6i.32xlarge` `db.m4.xlarge`–`db.m4.16xlarge` `db.m5.xlarge`–`db.m5.24xlarge` `db.m5d.xlarge`–`db.m5d.24xlarge` `db.m6i.xlarge`–`db.m6i.32xlarge` `db.x1.16xlarge`–`db.x1.32xlarge` `db.x1e.xlarge`–`db.x1e.32xlarge` `db.z1d.xlarge`–`db.z1d.12xlarge` | `db.t3.xlarge`–`db.t3.2xlarge` `db.r3.xlarge`–`db.r3.8xlarge` `db.r4.xlarge`–`db.r4.8xlarge` `db.r5.xlarge`–`db.r5.24xlarge` `db.r5b.xlarge`–`db.r5b.24xlarge` `db.r5d.xlarge`–`db.r5d.24xlarge` `db.r6i.xlarge`–`db.r6i.32xlarge` `db.m4.xlarge`–`db.m4.10xlarge` `db.m5.xlarge`–`db.m5.24xlarge` `db.m5d.xlarge`–`db.m5d.24xlarge` `db.m6i.xlarge`–`db.m6i.32xlarge` `db.x1.16xlarge`–`db.x1.32xlarge` | -| Standard Edition | `db.t3.xlarge`–`db.t3.2xlarge` `db.r5.large`–`db.r5.24xlarge` `db.r5b.large`–`db.r5b.24xlarge` `db.r5d.large`–`db.r5d.24xlarge` `db.r6i.large`–`db.r6i.8xlarge` `db.m5.large`–`db.m5.24xlarge` `db.m5d.large`–`db.m5d.24xlarge` `db.m6i.large`–`db.m6i.8xlarge` `db.x1.16xlarge`–`db.x1.32xlarge` `db.x1e.xlarge`–`db.x1e.32xlarge` `db.z1d.large`–`db.z1d.12xlarge` | `db.t3.xlarge`–`db.t3.2xlarge` `db.r4.large`–`db.r4.16xlarge` `db.r5.large`–`db.r5.24xlarge` `db.r5b.large`–`db.r5b.24xlarge` `db.r5d.large`–`db.r5d.24xlarge` `db.r6i.large`–`db.r6i.8xlarge` `db.m4.large`–`db.m4.16xlarge` `db.m5.large`–`db.m5.24xlarge` `db.m5d.large`–`db.m5d.24xlarge` `db.m6i.large`–`db.m6i.8xlarge` `db.x1.16xlarge`–`db.x1.32xlarge` `db.x1e.xlarge`–`db.x1e.32xlarge` `db.z1d.large`–`db.z1d.12xlarge` | `db.t3.xlarge`–`db.t3.2xlarge` `db.r3.large`–`db.r3.8xlarge` `db.r4.large`–`db.r4.8xlarge` `db.r5.large`–`db.r5.24xlarge` `db.r5b.large`–`db.r5b.24xlarge` `db.r5d.large`–`db.r5d.24xlarge` `db.r6i.large`–`db.r6i.8xlarge` `db.m3.medium`–`db.m3.2xlarge` `db.m4.large`–`db.m4.10xlarge` `db.m5.large`–`db.m5.24xlarge` `db.m5d.large`–`db.m5d.24xlarge` `db.m6i.large`–`db.m6i.8xlarge` `db.x1.16xlarge`–`db.x1.32xlarge` | -| Web Edition | `db.t3.small`–`db.t3.2xlarge` `db.r5.large`–`db.r5.4xlarge` `db.r5b.large`–`db.r5b.4xlarge` `db.r5d.large`–`db.r5d.4xlarge` `db.r6i.large`–`db.r6i.4xlarge` `db.m5.large`–`db.m5.4xlarge` `db.m5d.large`–`db.m5d.4xlarge` `db.m6i.large`–`db.m6i.4xlarge` `db.z1d.large`–`db.z1d.3xlarge` | `db.t2.small`–`db.t2.medium` `db.t3.small`–`db.t3.2xlarge` `db.r4.large`–`db.r4.2xlarge` `db.r5.large`–`db.r5.4xlarge` `db.r5b.large`–`db.r5b.4xlarge` `db.r5d.large`–`db.r5d.4xlarge` `db.r6i.large`–`db.r6i.4xlarge` `db.m4.large`–`db.m4.4xlarge` `db.m5.large`–`db.m5.4xlarge` `db.m5d.large`–`db.m5d.4xlarge` `db.m6i.large`–`db.m6i.4xlarge` `db.z1d.large`–`db.z1d.3xlarge` | `db.t2.small`–`db.t2.medium` `db.t3.small`–`db.t3.2xlarge` `db.r3.large`–`db.r3.2xlarge` `db.r4.large`–`db.r4.2xlarge` `db.r5.large`–`db.r5.4xlarge` `db.r5b.large`–`db.r5b.4xlarge` `db.r5d.large`–`db.r5d.4xlarge` `db.r6i.large`–`db.r6i.4xlarge` `db.m3.medium`–`db.m3.2xlarge` `db.m4.large`–`db.m4.4xlarge` `db.m5.large`–`db.m5.4xlarge` `db.m5d.large`–`db.m5d.4xlarge` `db.m6i.large`–`db.m6i.4xlarge` | -| Express Edition | `db.t3.small`–`db.t3.xlarge` | `db.t2.micro`–`db.t2.medium` `db.t3.small`–`db.t3.xlarge` | `db.t2.micro`–`db.t2.medium` `db.t3.small`–`db.t3.xlarge` | - -## Microsoft SQL Server security - -The Microsoft SQL Server database engine uses role\-based security\. The master user name that you specify when you create a DB instance is a SQL Server Authentication login that is a member of the `processadmin`, `public`, and `setupadmin` fixed server roles\. - -Any user who creates a database is assigned to the db\_owner role for that database and has all database\-level permissions except for those that are used for backups\. Amazon RDS manages backups for you\. - -The following server\-level roles aren't available in Amazon RDS for SQL Server: -+ bulkadmin -+ dbcreator -+ diskadmin -+ securityadmin -+ serveradmin -+ sysadmin - -The following server\-level permissions aren't available on RDS for SQL Server DB instances: -+ ALTER ANY DATABASE -+ ALTER ANY EVENT NOTIFICATION -+ ALTER RESOURCES -+ ALTER SETTINGS \(you can use the DB parameter group API operations to modify parameters; for more information, see [Working with parameter groups](USER_WorkingWithParamGroups.md)\) -+ AUTHENTICATE SERVER -+ CONTROL\_SERVER -+ CREATE DDL EVENT NOTIFICATION -+ CREATE ENDPOINT -+ CREATE SERVER ROLE -+ CREATE TRACE EVENT NOTIFICATION -+ DROP ANY DATABASE -+ EXTERNAL ACCESS ASSEMBLY -+ SHUTDOWN \(You can use the RDS reboot option instead\) -+ UNSAFE ASSEMBLY -+ ALTER ANY AVAILABILITY GROUP -+ CREATE ANY AVAILABILITY GROUP - -## Compliance program support for Microsoft SQL Server DB instances - -AWS Services in scope have been fully assessed by a third\-party auditor and result in a certification, attestation of compliance, or Authority to Operate \(ATO\)\. For more information, see [AWS services in scope by compliance program](http://aws.amazon.com/compliance/services-in-scope/)\. - -### HIPAA support for Microsoft SQL Server DB instances - -You can use Amazon RDS for Microsoft SQL Server databases to build HIPAA\-compliant applications\. You can store healthcare\-related information, including protected health information \(PHI\), under a Business Associate Agreement \(BAA\) with AWS\. For more information, see [HIPAA compliance](http://aws.amazon.com/compliance/hipaa-compliance/)\. - -Amazon RDS for SQL Server supports HIPAA for the following versions and editions: -+ SQL Server 2019 Enterprise, Standard, and Web Editions -+ SQL Server 2017 Enterprise, Standard, and Web Editions -+ SQL Server 2016 Enterprise, Standard, and Web Editions -+ SQL Server 2014 Enterprise, Standard, and Web Editions - -To enable HIPAA support on your DB instance, set up the following three components\. - - -**** - -| Component | Details | -| --- | --- | -| Auditing | To set up auditing, set the parameter `rds.sqlserver_audit` to the value `fedramp_hipaa`\. If your DB instance is not already using a custom DB parameter group, you must create a custom parameter group and attach it to your DB instance before you can modify the `rds.sqlserver_audit` parameter\. For more information, see [Working with parameter groups](USER_WorkingWithParamGroups.md)\. | -| Transport encryption | To set up transport encryption, force all connections to your DB instance to use Secure Sockets Layer \(SSL\)\. For more information, see [Forcing connections to your DB instance to use SSL](SQLServer.Concepts.General.SSL.Using.md#SQLServer.Concepts.General.SSL.Forcing)\. | -| Encryption at rest | To set up encryption at rest, you have two options: [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_SQLServer.html) | - -## SSL support for Microsoft SQL Server DB instances - -You can use SSL to encrypt connections between your applications and your Amazon RDS DB instances running Microsoft SQL Server\. You can also force all connections to your DB instance to use SSL\. If you force connections to use SSL, it happens transparently to the client, and the client doesn't have to do any work to use SSL\. - -SSL is supported in all AWS Regions and for all supported SQL Server editions\. For more information, see [Using SSL with a Microsoft SQL Server DB instance](SQLServer.Concepts.General.SSL.Using.md)\. - -## Microsoft SQL Server versions on Amazon RDS - -You can specify any currently supported Microsoft SQL Server version when creating a new DB instance\. You can specify the Microsoft SQL Server major version \(such as Microsoft SQL Server 14\.00\), and any supported minor version for the specified major version\. If no version is specified, Amazon RDS defaults to a supported version, typically the most recent version\. If a major version is specified but a minor version is not, Amazon RDS defaults to a recent release of the major version you have specified\. - -The following table shows the supported versions for all editions and all AWS Regions, except where noted\. You can also use the [https://docs.aws.amazon.com/cli/latest/reference/rds/describe-db-engine-versions.html](https://docs.aws.amazon.com/cli/latest/reference/rds/describe-db-engine-versions.html) AWS CLI command to see a list of supported versions, as well as defaults for newly created DB instances\. - - -**SQL Server versions supported in RDS** - -| Major version | Minor version | RDS API `EngineVersion` and CLI `engine-version` | -| --- | --- | --- | -| SQL Server 2019 | 15\.00\.4236\.7 \(CU16\) 15\.00\.4198\.2 \(CU15\) 15\.00\.4153\.1 \(CU12\) 15\.00\.4073\.23 \(CU8\) 15\.00\.4043\.16 \(CU5\) | `15.00.4236.7.v1` `15.00.4198.2.v1` `15.00.4153.1.v1` `15.00.4073.23.v1` `15.00.4043.16.v1` | -| SQL Server 2017 | 14\.00\.3451\.2 \(CU30\) 14\.00\.3421\.10 \(CU27\) 14\.00\.3401\.7 \(CU25\) 14\.00\.3381\.3 \(CU23\) 14\.00\.3356\.20 \(CU22\) 14\.00\.3294\.2 \(CU20\) 14\.00\.3281\.6 \(CU19\) | `14.00.3451.2.v1` `14.00.3421.10.v1` `14.00.3401.7.v1` `14.00.3381.3.v1` `14.00.3356.20.v1` `14.00.3294.2.v1` `14.00.3281.6.v1` | -| SQL Server 2016 | 13\.00\.6419\.1 \(SP3 \+ Hotfix\) 13\.00\.6300\.2 \(SP3\) | `13.00.6419.1.v1` `13.00.6300.2.v1` | -| SQL Server 2014 | 12\.00\.6439\.10 \(SP3 CU4 SU\) 12\.00\.6433\.1 \(SP3 CU4 SU\) 12\.00\.6329\.1 \(SP3 CU4\) 12\.00\.6293\.0 \(SP3 CU3\) | `12.00.6439.10.v1` `12.00.6433.1.v1` `12.00.6329.1.v1` `12.00.6293.0.v1` | - -## Version management in Amazon RDS - -Amazon RDS includes flexible version management that enables you to control when and how your DB instance is patched or upgraded\. This enables you to do the following for your DB engine: -+ Maintain compatibility with database engine patch versions\. -+ Test new patch versions to verify that they work with your application before you deploy them in production\. -+ Plan and perform version upgrades to meet your service level agreements and timing requirements\. - -### Microsoft SQL Server engine patching in Amazon RDS - -Amazon RDS periodically aggregates official Microsoft SQL Server database patches into a DB instance engine version that's specific to Amazon RDS\. For more information about the Microsoft SQL Server patches in each engine version, see [Version and feature support on Amazon RDS](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_SQLServer.html#SQLServer.Concepts.General.FeatureSupport)\. - -Currently, you manually perform all engine upgrades on your DB instance\. For more information, see [Upgrading the Microsoft SQL Server DB engine](USER_UpgradeDBInstance.SQLServer.md)\. - -### Deprecation schedule for major engine versions of Microsoft SQL Server on Amazon RDS - -The following table displays the planned schedule of deprecations for major engine versions of Microsoft SQL Server\. - - -| Date | Information | -| --- | --- | -| July 9, 2024 | Microsoft will stop critical patch updates for SQL Server 2014\. For more information, see [Microsoft SQL Server 2014](https://learn.microsoft.com/en-us/lifecycle/products/sql-server-2014) in the Microsoft documentation\. | -| June 1, 2024 | Amazon RDS plans to end support of Microsoft SQL Server 2014 on RDS for SQL Server\. At that time, any remaining instances will be scheduled to migrate to SQL Server 2016 \(latest minor version available\)\. For more information, see [Announcement: Amazon RDS for SQL Server ending support for SQL Server 2014 major versions](https://repost.aws/articles/AR-eyAH1PSSuevuZRUE9FV3A)\. To avoid an automatic upgrade from Microsoft SQL Server 2014, you can upgrade at a time that is convenient to you\. For more information, see [Upgrading a DB instance engine version](USER_UpgradeDBInstance.Upgrading.md)\. | -| July 12, 2022 | Microsoft will stop critical patch updates for SQL Server 2012\. For more information, see [Microsoft SQL Server 2012](https://docs.microsoft.com/en-us/lifecycle/products/microsoft-sql-server-2012) in the Microsoft documentation\. | -| June 1, 2022 | Amazon RDS plans to end support of Microsoft SQL Server 2012 on RDS for SQL Server\. At that time, any remaining instances will be scheduled to migrate to SQL Server 2014 \(latest minor version available\)\. For more information, see [Announcement: Amazon RDS for SQL Server ending support for SQL Server 2012 major versions](https://repost.aws/questions/QUFNiETqrMQ_WT_AXSxOYNOA)\. To avoid an automatic upgrade from Microsoft SQL Server 2012, you can upgrade at a time that is convenient to you\. For more information, see [Upgrading a DB instance engine version](USER_UpgradeDBInstance.Upgrading.md)\. | -| September 1, 2021 | Amazon RDS is starting to disable the creation of new RDS for SQL Server DB instances using Microsoft SQL Server 2012\. For more information, see [Announcement: Amazon RDS for SQL Server ending support for SQL Server 2012 major versions](https://repost.aws/questions/QUFNiETqrMQ_WT_AXSxOYNOA)\. | -| July 12, 2019 | The Amazon RDS team deprecated support for Microsoft SQL Server 2008 R2 in June 2019\. Remaining instances of Microsoft SQL Server 2008 R2 are migrating to SQL Server 2012 \(latest minor version available\)\. To avoid an automatic upgrade from Microsoft SQL Server 2008 R2, you can upgrade at a time that is convenient to you\. For more information, see [Upgrading a DB instance engine version](USER_UpgradeDBInstance.Upgrading.md)\. | -| April 25, 2019 | Before the end of April 2019, you will no longer be able to create new Amazon RDS for SQL Server database instances using Microsoft SQL Server 2008R2\. | - -## Microsoft SQL Server features on Amazon RDS - -The supported SQL Server versions on Amazon RDS include the following features\. In general, a version also includes features from the previous versions, unless otherwise noted in the Microsoft documentation\. - -**Topics** -+ [Microsoft SQL Server 2019 features](#SQLServer.Concepts.General.FeatureSupport.2019) -+ [Microsoft SQL Server 2017 features](#SQLServer.Concepts.General.FeatureSupport.2017) -+ [Microsoft SQL Server 2016 features](#SQLServer.Concepts.General.FeatureSupport.2016) -+ [Microsoft SQL Server 2014 features](#SQLServer.Concepts.General.FeatureSupport.2014) -+ [Microsoft SQL Server 2012 end of support on Amazon RDS](#SQLServer.Concepts.General.FeatureSupport.2012) -+ [Microsoft SQL Server 2008 R2 end of support on Amazon RDS](#SQLServer.Concepts.General.FeatureSupport.2008) - -### Microsoft SQL Server 2019 features - -SQL Server 2019 includes many new features, such as the following: -+ Accelerated database recovery \(ADR\) – Reduces crash recovery time after a restart or a long\-running transaction rollback\. -+ Intelligent Query Processing \(IQP\): - + Row mode memory grant feedback – Corrects excessive grants automatically, that would otherwise result in wasted memory and reduced concurrency\. - + Batch mode on rowstore – Enables batch mode execution for analytic workloads without requiring columnstore indexes\. - + Table variable deferred compilation – Improves plan quality and overall performance for queries that reference table variables\. -+ Intelligent performance: - + `OPTIMIZE_FOR_SEQUENTIAL_KEY` index option – Improves throughput for high\-concurrency inserts into indexes\. - + Improved indirect checkpoint scalability – Helps databases with heavy DML workloads\. - + Concurrent Page Free Space \(PFS\) updates – Enables handling as a shared latch rather than an exclusive latch\. -+ Monitoring improvements: - + `WAIT_ON_SYNC_STATISTICS_REFRESH` wait type – Shows accumulated instance\-level time spent on synchronous statistics refresh operations\. - + Database\-scoped configurations – Include `LIGHTWEIGHT_QUERY_PROFILING` and `LAST_QUERY_PLAN_STATS`\. - + Dynamic management functions \(DMFs\) – Include `sys.dm_exec_query_plan_stats` and `sys.dm_db_page_info`\. -+ Verbose truncation warnings – The data truncation error message defaults to include table and column names and the truncated value\. -+ Resumable online index creation – In SQL Server 2017, only resumable online index rebuild is supported\. - -For the full list of SQL Server 2019 features, see [What's new in SQL Server 2019 \(15\.x\)](https://docs.microsoft.com/en-us/sql/sql-server/what-s-new-in-sql-server-ver15) in the Microsoft documentation\. - -For a list of unsupported features, see [Features not supported and features with limited support](#SQLServer.Concepts.General.FeatureNonSupport)\. - -### Microsoft SQL Server 2017 features - -SQL Server 2017 includes many new features, such as the following: -+ Adaptive query processing -+ Automatic plan correction \(an automatic tuning feature\) -+ GraphDB -+ Resumable index rebuilds - -For the full list of SQL Server 2017 features, see [What's new in SQL Server 2017](https://docs.microsoft.com/en-us/sql/sql-server/what-s-new-in-sql-server-2017) in the Microsoft documentation\. - -For a list of unsupported features, see [Features not supported and features with limited support](#SQLServer.Concepts.General.FeatureNonSupport)\. - -### Microsoft SQL Server 2016 features - -Amazon RDS supports the following features of SQL Server 2016: -+ Always Encrypted -+ JSON Support -+ Operational Analytics -+ Query Store -+ Temporal Tables - -For the full list of SQL Server 2016 features, see [What's new in SQL Server 2016](https://docs.microsoft.com/en-us/sql/sql-server/what-s-new-in-sql-server-2016) in the Microsoft documentation\. - -### Microsoft SQL Server 2014 features - -In addition to supported features of SQL Server 2012, Amazon RDS supports the new query optimizer available in SQL Server 2014, and also the delayed durability feature\. - -For a list of unsupported features, see [Features not supported and features with limited support](#SQLServer.Concepts.General.FeatureNonSupport)\. - -SQL Server 2014 supports all the parameters from SQL Server 2012 and uses the same default values\. SQL Server 2014 includes one new parameter, backup checksum default\. For more information, see [How to enable the CHECKSUM option if backup utilities do not expose the option](https://support.microsoft.com/en-us/kb/2656988) in the Microsoft documentation\. - -### Microsoft SQL Server 2012 end of support on Amazon RDS - -SQL Server 2012 has reached its end of support on Amazon RDS\. - -RDS is upgrading all existing DB instances that are still using SQL Server 2012 to the latest minor version of SQL Server 2014\. For more information, see [Version management in Amazon RDS](#SQLServer.Concepts.General.Version-Management)\. - -### Microsoft SQL Server 2008 R2 end of support on Amazon RDS - -SQL Server 2008 R2 has reached its end of support on Amazon RDS\. - -RDS is upgrading all existing DB instances that are still using SQL Server 2008 R2 to the latest minor version of SQL Server 2012\. For more information, see [Version management in Amazon RDS](#SQLServer.Concepts.General.Version-Management)\. - -## Change data capture support for Microsoft SQL Server DB instances - -Amazon RDS supports change data capture \(CDC\) for your DB instances running Microsoft SQL Server\. CDC captures changes that are made to the data in your tables, and stores metadata about each change that you can access later\. For more information, see [Change data capture](https://docs.microsoft.com/en-us/sql/relational-databases/track-changes/track-data-changes-sql-server#Capture) in the Microsoft documentation\. - -Amazon RDS supports CDC for the following SQL Server editions and versions: -+ Microsoft SQL Server Enterprise Edition \(All versions\) -+ Microsoft SQL Server Standard Edition: - + 2019 - + 2017 - + 2016 version 13\.00\.4422\.0 SP1 CU2 and later - -To use CDC with your Amazon RDS DB instances, first enable or disable CDC at the database level by using RDS\-provided stored procedures\. After that, any user that has the `db_owner` role for that database can use the native Microsoft stored procedures to control CDC on that database\. For more information, see [Using change data capture](Appendix.SQLServer.CommonDBATasks.CDC.md)\. - -You can use CDC and AWS Database Migration Service to enable ongoing replication from SQL Server DB instances\. - -## Features not supported and features with limited support - -The following Microsoft SQL Server features aren't supported on Amazon RDS: -+ Backing up to Microsoft Azure Blob Storage -+ Buffer pool extension -+ Custom password policies -+ Data Quality Services -+ Database Log Shipping -+ Database snapshots \(Amazon RDS supports only DB instance snapshots\) -+ Extended stored procedures, including xp\_cmdshell -+ FILESTREAM support -+ File tables -+ Machine Learning and R Services \(requires OS access to install it\) -+ Maintenance plans -+ Performance Data Collector -+ Policy\-Based Management -+ PolyBase -+ Replication -+ Resource Governor -+ Server\-level triggers -+ Service Broker endpoints -+ Stretch database -+ TRUSTWORTHY database property \(requires sysadmin role\) -+ T\-SQL endpoints \(all operations using CREATE ENDPOINT are unavailable\) -+ WCF Data Services - -The following Microsoft SQL Server features have limited support on Amazon RDS: -+ Distributed queries/linked servers\. For more information, see [Implement linked servers with Amazon RDS for Microsoft SQL Server](http://aws.amazon.com/blogs/database/implement-linked-servers-with-amazon-rds-for-microsoft-sql-server/)\. -+ Common Runtime Language \(CLR\)\. On RDS for SQL Server 2016 and lower versions, CLR is supported in `SAFE` mode and using assembly bits only\. CLR isn't supported on RDS for SQL Server 2017 and higher versions\. For more information, see [Common Runtime Language Integration](https://docs.microsoft.com/en-us/sql/relational-databases/clr-integration/common-language-runtime-integration-overview) in the Microsoft documentation\. - -## Multi\-AZ deployments using Microsoft SQL Server Database Mirroring or Always On availability groups - -Amazon RDS supports Multi\-AZ deployments for DB instances running Microsoft SQL Server by using SQL Server Database Mirroring \(DBM\) or Always On Availability Groups \(AGs\)\. Multi\-AZ deployments provide increased availability, data durability, and fault tolerance for DB instances\. In the event of planned database maintenance or unplanned service disruption, Amazon RDS automatically fails over to the up\-to\-date secondary replica so database operations can resume quickly without manual intervention\. The primary and secondary instances use the same endpoint, whose physical network address transitions to the passive secondary replica as part of the failover process\. You don't have to reconfigure your application when a failover occurs\. - -Amazon RDS manages failover by actively monitoring your Multi\-AZ deployment and initiating a failover when a problem with your primary occurs\. Failover doesn't occur unless the standby and primary are fully in sync\. Amazon RDS actively maintains your Multi\-AZ deployment by automatically repairing unhealthy DB instances and re\-establishing synchronous replication\. You don't have to manage anything\. Amazon RDS handles the primary, the witness, and the standby instance for you\. When you set up SQL Server Multi\-AZ, RDS configures passive secondary instances for all of the databases on the instance\. - -For more information, see [Multi\-AZ deployments for Amazon RDS for Microsoft SQL Server](USER_SQLServerMultiAZ.md)\. - -## Using Transparent Data Encryption to encrypt data at rest - -Amazon RDS supports Microsoft SQL Server Transparent Data Encryption \(TDE\), which transparently encrypts stored data\. Amazon RDS uses option groups to enable and configure these features\. For more information about the TDE option, see [Support for Transparent Data Encryption in SQL Server](Appendix.SQLServer.Options.TDE.md)\. - -## Functions and stored procedures for Amazon RDS for Microsoft SQL Server - -Following, you can find a list of the Amazon RDS functions and stored procedures that help automate SQL Server tasks\. - -[\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_SQLServer.html) - -## Local time zone for Microsoft SQL Server DB instances - -The time zone of an Amazon RDS DB instance running Microsoft SQL Server is set by default\. The current default is Coordinated Universal Time \(UTC\)\. You can set the time zone of your DB instance to a local time zone instead, to match the time zone of your applications\. - -You set the time zone when you first create your DB instance\. You can create your DB instance by using the [AWS Management Console](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_CreateDBInstance.html), the Amazon RDS API [CreateDBInstance](https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_CreateDBInstance.html.html) action, or the AWS CLI [create\-db\-instance](https://docs.aws.amazon.com/cli/latest/reference/rds/create-db-instance.html) command\. - -If your DB instance is part of a Multi\-AZ deployment \(using SQL Server DBM or AGs\), then when you fail over, your time zone remains the local time zone that you set\. For more information, see [Multi\-AZ deployments using Microsoft SQL Server Database Mirroring or Always On availability groups](#SQLServer.Concepts.General.Mirroring)\. - -When you request a point\-in\-time restore, you specify the time to restore to\. The time is shown in your local time zone\. For more information, see [Restoring a DB instance to a specified time](USER_PIT.md)\. - -The following are limitations to setting the local time zone on your DB instance: -+ You can't modify the time zone of an existing SQL Server DB instance\. -+ You can't restore a snapshot from a DB instance in one time zone to a DB instance in a different time zone\. -+ We strongly recommend that you don't restore a backup file from one time zone to a different time zone\. If you restore a backup file from one time zone to a different time zone, you must audit your queries and applications for the effects of the time zone change\. For more information, see [Importing and exporting SQL Server databases using native backup and restore](SQLServer.Procedural.Importing.md)\. - -### Supported time zones - -You can set your local time zone to one of the values listed in the following table\. - - -**Time zones supported for Amazon RDS on SQL Server** - -| Time zone | Standard time offset | Description | Notes | -| --- | --- | --- | --- | -| Afghanistan Standard Time | \(UTC\+04:30\) | Kabul | This time zone doesn't observe daylight saving time\. | -| Alaskan Standard Time | \(UTC–09:00\) | Alaska | | -| Aleutian Standard Time | \(UTC–10:00\) | Aleutian Islands | | -| Altai Standard Time | \(UTC\+07:00\) | Barnaul, Gorno\-Altaysk | | -| Arab Standard Time | \(UTC\+03:00\) | Kuwait, Riyadh | This time zone doesn't observe daylight saving time\. | -| Arabian Standard Time | \(UTC\+04:00\) | Abu Dhabi, Muscat | | -| Arabic Standard Time | \(UTC\+03:00\) | Baghdad | This time zone doesn't observe daylight saving time\. | -| Argentina Standard Time | \(UTC–03:00\) | City of Buenos Aires | This time zone doesn't observe daylight saving time\. | -| Astrakhan Standard Time | \(UTC\+04:00\) | Astrakhan, Ulyanovsk | | -| Atlantic Standard Time | \(UTC–04:00\) | Atlantic Time \(Canada\) | | -| AUS Central Standard Time | \(UTC\+09:30\) | Darwin | This time zone doesn't observe daylight saving time\. | -| Aus Central W\. Standard Time | \(UTC\+08:45\) | Eucla | | -| AUS Eastern Standard Time | \(UTC\+10:00\) | Canberra, Melbourne, Sydney | | -| Azerbaijan Standard Time | \(UTC\+04:00\) | Baku | | -| Azores Standard Time | \(UTC–01:00\) | Azores | | -| Bahia Standard Time | \(UTC–03:00\) | Salvador | | -| Bangladesh Standard Time | \(UTC\+06:00\) | Dhaka | This time zone doesn't observe daylight saving time\. | -| Belarus Standard Time | \(UTC\+03:00\) | Minsk | This time zone doesn't observe daylight saving time\. | -| Bougainville Standard Time | \(UTC\+11:00\) | Bougainville Island | | -| Canada Central Standard Time | \(UTC–06:00\) | Saskatchewan | This time zone doesn't observe daylight saving time\. | -| Cape Verde Standard Time | \(UTC–01:00\) | Cabo Verde Is\. | This time zone doesn't observe daylight saving time\. | -| Caucasus Standard Time | \(UTC\+04:00\) | Yerevan | | -| Cen\. Australia Standard Time | \(UTC\+09:30\) | Adelaide | | -| Central America Standard Time | \(UTC–06:00\) | Central America | This time zone doesn't observe daylight saving time\. | -| Central Asia Standard Time | \(UTC\+06:00\) | Astana | This time zone doesn't observe daylight saving time\. | -| Central Brazilian Standard Time | \(UTC–04:00\) | Cuiaba | | -| Central Europe Standard Time | \(UTC\+01:00\) | Belgrade, Bratislava, Budapest, Ljubljana, Prague | | -| Central European Standard Time | \(UTC\+01:00\) | Sarajevo, Skopje, Warsaw, Zagreb | | -| Central Pacific Standard Time | \(UTC\+11:00\) | Solomon Islands, New Caledonia | This time zone doesn't observe daylight saving time\. | -| Central Standard Time | \(UTC–06:00\) | Central Time \(US and Canada\) | | -| Central Standard Time \(Mexico\) | \(UTC–06:00\) | Guadalajara, Mexico City, Monterrey | | -| Chatham Islands Standard Time | \(UTC\+12:45\) | Chatham Islands | | -| China Standard Time | \(UTC\+08:00\) | Beijing, Chongqing, Hong Kong, Urumqi | This time zone doesn't observe daylight saving time\. | -| Cuba Standard Time | \(UTC–05:00\) | Havana | | -| Dateline Standard Time | \(UTC–12:00\) | International Date Line West | This time zone doesn't observe daylight saving time\. | -| E\. Africa Standard Time | \(UTC\+03:00\) | Nairobi | This time zone doesn't observe daylight saving time\. | -| E\. Australia Standard Time | \(UTC\+10:00\) | Brisbane | This time zone doesn't observe daylight saving time\. | -| E\. Europe Standard Time | \(UTC\+02:00\) | Chisinau | | -| E\. South America Standard Time | \(UTC–03:00\) | Brasilia | | -| Easter Island Standard Time | \(UTC–06:00\) | Easter Island | | -| Eastern Standard Time | \(UTC–05:00\) | Eastern Time \(US and Canada\) | | -| Eastern Standard Time \(Mexico\) | \(UTC–05:00\) | Chetumal | | -| Egypt Standard Time | \(UTC\+02:00\) | Cairo | | -| Ekaterinburg Standard Time | \(UTC\+05:00\) | Ekaterinburg | | -| Fiji Standard Time | \(UTC\+12:00\) | Fiji | | -| FLE Standard Time | \(UTC\+02:00\) | Helsinki, Kyiv, Riga, Sofia, Tallinn, Vilnius | | -| Georgian Standard Time | \(UTC\+04:00\) | Tbilisi | This time zone doesn't observe daylight saving time\. | -| GMT Standard Time | \(UTC\) | Dublin, Edinburgh, Lisbon, London | This time zone isn't the same as Greenwich Mean Time\. This time zone does observe daylight saving time\. | -| Greenland Standard Time | \(UTC–03:00\) | Greenland | | -| Greenwich Standard Time | \(UTC\) | Monrovia, Reykjavik | This time zone doesn't observe daylight saving time\. | -| GTB Standard Time | \(UTC\+02:00\) | Athens, Bucharest | | -| Haiti Standard Time | \(UTC–05:00\) | Haiti | | -| Hawaiian Standard Time | \(UTC–10:00\) | Hawaii | | -| India Standard Time | \(UTC\+05:30\) | Chennai, Kolkata, Mumbai, New Delhi | This time zone doesn't observe daylight saving time\. | -| Iran Standard Time | \(UTC\+03:30\) | Tehran | | -| Israel Standard Time | \(UTC\+02:00\) | Jerusalem | | -| Jordan Standard Time | \(UTC\+02:00\) | Amman | | -| Kaliningrad Standard Time | \(UTC\+02:00\) | Kaliningrad | | -| Kamchatka Standard Time | \(UTC\+12:00\) | Petropavlovsk\-Kamchatsky – Old | | -| Korea Standard Time | \(UTC\+09:00\) | Seoul | This time zone doesn't observe daylight saving time\. | -| Libya Standard Time | \(UTC\+02:00\) | Tripoli | | -| Line Islands Standard Time | \(UTC\+14:00\) | Kiritimati Island | | -| Lord Howe Standard Time | \(UTC\+10:30\) | Lord Howe Island | | -| Magadan Standard Time | \(UTC\+11:00\) | Magadan | This time zone doesn't observe daylight saving time\. | -| Magallanes Standard Time | \(UTC–03:00\) | Punta Arenas | | -| Marquesas Standard Time | \(UTC–09:30\) | Marquesas Islands | | -| Mauritius Standard Time | \(UTC\+04:00\) | Port Louis | This time zone doesn't observe daylight saving time\. | -| Middle East Standard Time | \(UTC\+02:00\) | Beirut | | -| Montevideo Standard Time | \(UTC–03:00\) | Montevideo | | -| Morocco Standard Time | \(UTC\+01:00\) | Casablanca | | -| Mountain Standard Time | \(UTC–07:00\) | Mountain Time \(US and Canada\) | | -| Mountain Standard Time \(Mexico\) | \(UTC–07:00\) | Chihuahua, La Paz, Mazatlan | | -| Myanmar Standard Time | \(UTC\+06:30\) | Yangon \(Rangoon\) | This time zone doesn't observe daylight saving time\. | -| N\. Central Asia Standard Time | \(UTC\+07:00\) | Novosibirsk | | -| Namibia Standard Time | \(UTC\+02:00\) | Windhoek | | -| Nepal Standard Time | \(UTC\+05:45\) | Kathmandu | This time zone doesn't observe daylight saving time\. | -| New Zealand Standard Time | \(UTC\+12:00\) | Auckland, Wellington | | -| Newfoundland Standard Time | \(UTC–03:30\) | Newfoundland | | -| Norfolk Standard Time | \(UTC\+11:00\) | Norfolk Island | | -| North Asia East Standard Time | \(UTC\+08:00\) | Irkutsk | | -| North Asia Standard Time | \(UTC\+07:00\) | Krasnoyarsk | | -| North Korea Standard Time | \(UTC\+09:00\) | Pyongyang | | -| Omsk Standard Time | \(UTC\+06:00\) | Omsk | | -| Pacific SA Standard Time | \(UTC–03:00\) | Santiago | | -| Pacific Standard Time | \(UTC–08:00\) | Pacific Time \(US and Canada\) | | -| Pacific Standard Time \(Mexico\) | \(UTC–08:00\) | Baja California | | -| Pakistan Standard Time | \(UTC\+05:00\) | Islamabad, Karachi | This time zone doesn't observe daylight saving time\. | -| Paraguay Standard Time | \(UTC–04:00\) | Asuncion | | -| Romance Standard Time | \(UTC\+01:00\) | Brussels, Copenhagen, Madrid, Paris | | -| Russia Time Zone 10 | \(UTC\+11:00\) | Chokurdakh | | -| Russia Time Zone 11 | \(UTC\+12:00\) | Anadyr, Petropavlovsk\-Kamchatsky | | -| Russia Time Zone 3 | \(UTC\+04:00\) | Izhevsk, Samara | | -| Russian Standard Time | \(UTC\+03:00\) | Moscow, St\. Petersburg, Volgograd | This time zone doesn't observe daylight saving time\. | -| SA Eastern Standard Time | \(UTC–03:00\) | Cayenne, Fortaleza | This time zone doesn't observe daylight saving time\. | -| SA Pacific Standard Time | \(UTC–05:00\) | Bogota, Lima, Quito, Rio Branco | This time zone doesn't observe daylight saving time\. | -| SA Western Standard Time | \(UTC–04:00\) | Georgetown, La Paz, Manaus, San Juan | This time zone doesn't observe daylight saving time\. | -| Saint Pierre Standard Time | \(UTC–03:00\) | Saint Pierre and Miquelon | | -| Sakhalin Standard Time | \(UTC\+11:00\) | Sakhalin | | -| Samoa Standard Time | \(UTC\+13:00\) | Samoa | | -| Sao Tome Standard Time | \(UTC\+01:00\) | Sao Tome | | -| Saratov Standard Time | \(UTC\+04:00\) | Saratov | | -| SE Asia Standard Time | \(UTC\+07:00\) | Bangkok, Hanoi, Jakarta | This time zone doesn't observe daylight saving time\. | -| Singapore Standard Time | \(UTC\+08:00\) | Kuala Lumpur, Singapore | This time zone doesn't observe daylight saving time\. | -| South Africa Standard Time | \(UTC\+02:00\) | Harare, Pretoria | This time zone doesn't observe daylight saving time\. | -| Sri Lanka Standard Time | \(UTC\+05:30\) | Sri Jayawardenepura | This time zone doesn't observe daylight saving time\. | -| Sudan Standard Time | \(UTC\+02:00\) | Khartoum | | -| Syria Standard Time | \(UTC\+02:00\) | Damascus | | -| Taipei Standard Time | \(UTC\+08:00\) | Taipei | This time zone doesn't observe daylight saving time\. | -| Tasmania Standard Time | \(UTC\+10:00\) | Hobart | | -| Tocantins Standard Time | \(UTC–03:00\) | Araguaina | | -| Tokyo Standard Time | \(UTC\+09:00\) | Osaka, Sapporo, Tokyo | This time zone doesn't observe daylight saving time\. | -| Tomsk Standard Time | \(UTC\+07:00\) | Tomsk | | -| Tonga Standard Time | \(UTC\+13:00\) | Nuku'alofa | This time zone doesn't observe daylight saving time\. | -| Transbaikal Standard Time | \(UTC\+09:00\) | Chita | | -| Turkey Standard Time | \(UTC\+03:00\) | Istanbul | | -| Turks And Caicos Standard Time | \(UTC–05:00\) | Turks and Caicos | | -| Ulaanbaatar Standard Time | \(UTC\+08:00\) | Ulaanbaatar | This time zone doesn't observe daylight saving time\. | -| US Eastern Standard Time | \(UTC–05:00\) | Indiana \(East\) | | -| US Mountain Standard Time | \(UTC–07:00\) | Arizona | This time zone doesn't observe daylight saving time\. | -| UTC | UTC | Coordinated Universal Time | This time zone doesn't observe daylight saving time\. | -| UTC–02 | \(UTC–02:00\) | Coordinated Universal Time–02 | This time zone doesn't observe daylight saving time\. | -| UTC–08 | \(UTC–08:00\) | Coordinated Universal Time–08 | | -| UTC–09 | \(UTC–09:00\) | Coordinated Universal Time–09 | | -| UTC–11 | \(UTC–11:00\) | Coordinated Universal Time–11 | This time zone doesn't observe daylight saving time\. | -| UTC\+12 | \(UTC\+12:00\) | Coordinated Universal Time\+12 | This time zone doesn't observe daylight saving time\. | -| UTC\+13 | \(UTC\+13:00\) | Coordinated Universal Time\+13 | | -| Venezuela Standard Time | \(UTC–04:00\) | Caracas | This time zone doesn't observe daylight saving time\. | -| Vladivostok Standard Time | \(UTC\+10:00\) | Vladivostok | | -| Volgograd Standard Time | \(UTC\+04:00\) | Volgograd | | -| W\. Australia Standard Time | \(UTC\+08:00\) | Perth | This time zone doesn't observe daylight saving time\. | -| W\. Central Africa Standard Time | \(UTC\+01:00\) | West Central Africa | This time zone doesn't observe daylight saving time\. | -| W\. Europe Standard Time | \(UTC\+01:00\) | Amsterdam, Berlin, Bern, Rome, Stockholm, Vienna | | -| W\. Mongolia Standard Time | \(UTC\+07:00\) | Hovd | | -| West Asia Standard Time | \(UTC\+05:00\) | Ashgabat, Tashkent | This time zone doesn't observe daylight saving time\. | -| West Bank Standard Time | \(UTC\+02:00\) | Gaza, Hebron | | -| West Pacific Standard Time | \(UTC\+10:00\) | Guam, Port Moresby | This time zone doesn't observe daylight saving time\. | -| Yakutsk Standard Time | \(UTC\+09:00\) | Yakutsk | | \ No newline at end of file diff --git a/doc_source/CHAP_SettingUp.md b/doc_source/CHAP_SettingUp.md deleted file mode 100644 index 8c71a98..0000000 --- a/doc_source/CHAP_SettingUp.md +++ /dev/null @@ -1,162 +0,0 @@ -# Setting up for Amazon RDS - -Before you use Amazon Relational Database Service for the first time, complete the following tasks\. - -**Topics** -+ [Sign up for an AWS account](#sign-up-for-aws) -+ [Create an administrative user](#create-an-admin) -+ [Grant programmatic access](#getting-started-iam-user-access-keys) -+ [Determine requirements](#CHAP_SettingUp.Requirements) -+ [Provide access to your DB instance in your VPC by creating a security group](#CHAP_SettingUp.SecurityGroup) - -If you already have an AWS account, know your Amazon RDS requirements, and prefer to use the defaults for IAM and VPC security groups, skip ahead to [Getting started with Amazon RDS](CHAP_GettingStarted.md)\. - -## Sign up for an AWS account - -If you do not have an AWS account, complete the following steps to create one\. - -**To sign up for an AWS account** - -1. Open [https://portal\.aws\.amazon\.com/billing/signup](https://portal.aws.amazon.com/billing/signup)\. - -1. Follow the online instructions\. - - Part of the sign\-up procedure involves receiving a phone call and entering a verification code on the phone keypad\. - - When you sign up for an AWS account, an *AWS account root user* is created\. The root user has access to all AWS services and resources in the account\. As a security best practice, [assign administrative access to an administrative user](https://docs.aws.amazon.com/singlesignon/latest/userguide/getting-started.html), and use only the root user to perform [tasks that require root user access](https://docs.aws.amazon.com/accounts/latest/reference/root-user-tasks.html)\. - -AWS sends you a confirmation email after the sign\-up process is complete\. At any time, you can view your current account activity and manage your account by going to [https://aws\.amazon\.com/](https://aws.amazon.com/) and choosing **My Account**\. - -## Create an administrative user - -After you sign up for an AWS account, create an administrative user so that you don't use the root user for everyday tasks\. - -**Secure your AWS account root user** - -1. Sign in to the [AWS Management Console](https://console.aws.amazon.com/) as the account owner by choosing **Root user** and entering your AWS account email address\. On the next page, enter your password\. - - For help signing in by using root user, see [Signing in as the root user](https://docs.aws.amazon.com/signin/latest/userguide/console-sign-in-tutorials.html#introduction-to-root-user-sign-in-tutorial) in the *AWS Sign\-In User Guide*\. - -1. Turn on multi\-factor authentication \(MFA\) for your root user\. - - For instructions, see [Enable a virtual MFA device for your AWS account root user \(console\)](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_mfa_enable_virtual.html#enable-virt-mfa-for-root) in the *IAM User Guide*\. - -**Create an administrative user** -+ For your daily administrative tasks, grant administrative access to an administrative user in AWS IAM Identity Center \(successor to AWS Single Sign\-On\)\. - - For instructions, see [Getting started](https://docs.aws.amazon.com/singlesignon/latest/userguide/getting-started.html) in the *AWS IAM Identity Center \(successor to AWS Single Sign\-On\) User Guide*\. - -**Sign in as the administrative user** -+ To sign in with your IAM Identity Center user, use the sign\-in URL that was sent to your email address when you created the IAM Identity Center user\. - - For help signing in using an IAM Identity Center user, see [Signing in to the AWS access portal](https://docs.aws.amazon.com/signin/latest/userguide/iam-id-center-sign-in-tutorial.html) in the *AWS Sign\-In User Guide*\. - -## Grant programmatic access - -Users need programmatic access if they want to interact with AWS outside of the AWS Management Console\. The way to grant programmatic access depends on the type of user that's accessing AWS\. - -To grant users programmatic access, choose one of the following options\. - - -**** - -| Which user needs programmatic access? | To | By | -| --- | --- | --- | -| Workforce identity \(Users managed in IAM Identity Center\) | Use temporary credentials to sign programmatic requests to the AWS CLI, AWS SDKs, or AWS APIs\. | Following the instructions for the interface that you want to use\. [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_SettingUp.html) | -| IAM | Use temporary credentials to sign programmatic requests to the AWS CLI, AWS SDKs, or AWS APIs\. | Following the instructions in [Using temporary credentials with AWS resources](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp_use-resources.html) in the IAM User Guide\. | -| IAM | \(Not recommended\)Use long\-term credentials to sign programmatic requests to the AWS CLI, AWS SDKs, or AWS APIs\. | Following the instructions for the interface that you want to use\. [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_SettingUp.html) | - -## Determine requirements - -The basic building block of Amazon RDS is the DB instance\. In a DB instance, you create your databases\. A DB instance provides a network address called an *endpoint*\. Your applications use this endpoint to connect to your DB instance\. When you create a DB instance, you specify details like storage, memory, database engine and version, network configuration, security, and maintenance periods\. You control network access to a DB instance through a security group\. - -Before you create a DB instance and a security group, you must know your DB instance and network needs\. Here are some important things to consider: -+ **Resource requirements **– What are the memory and processor requirements for your application or service? You use these settings to help you determine what DB instance class to use\. For specifications about DB instance classes, see [DB instance classes](Concepts.DBInstanceClass.md)\. -+ **VPC, subnet, and security group – **Your DB instance will most likely be in a virtual private cloud \(VPC\)\. To connect to your DB instance, you need to set up security group rules\. These rules are set up differently depending on what kind of VPC you use and how you use it\. For example, you can use: a default VPC or a user\-defined VPC\. - - The following list describes the rules for each VPC option: - + **Default VPC** – If your AWS account has a default VPC in the current AWS Region, that VPC is configured to support DB instances\. If you specify the default VPC when you create the DB instance, do the following: - + Make sure to create a *VPC security group* that authorizes connections from the application or service to the Amazon RDS DB instance\. Use the **Security Group** option on the VPC console or the AWS CLI to create VPC security groups\. For information, see [Step 3: Create a VPC security group](USER_VPC.WorkingWithRDSInstanceinaVPC.md#USER_VPC.CreateVPCSecurityGroup)\. - + Specify the default DB subnet group\. If this is the first DB instance you have created in this AWS Region, Amazon RDS creates the default DB subnet group when it creates the DB instance\. - + **User\-defined VPC – **If you want to specify a user\-defined VPC when you create a DB instance, be aware of the following: - + Make sure to create a *VPC security group* that authorizes connections from the application or service to the Amazon RDS DB instance\. Use the **Security Group** option on the VPC console or the AWS CLI to create VPC security groups\. For information, see [Step 3: Create a VPC security group](USER_VPC.WorkingWithRDSInstanceinaVPC.md#USER_VPC.CreateVPCSecurityGroup)\. - + The VPC must meet certain requirements in order to host DB instances, such as having at least two subnets, each in a separate Availability Zone\. For information, see [Amazon VPC VPCs and Amazon RDS](USER_VPC.md)\. - + Make sure to specify a DB subnet group that defines which subnets in that VPC can be used by the DB instance\. For information, see the DB subnet group section in [Working with a DB instance in a VPC](USER_VPC.WorkingWithRDSInstanceinaVPC.md#Overview.RDSVPC.Create)\. -+ **High availability – **Do you need failover support? On Amazon RDS, a Multi\-AZ deployment creates a primary DB instance and a secondary standby DB instance in another Availability Zone for failover support\. We recommend Multi\-AZ deployments for production workloads to maintain high availability\. For development and test purposes, you can use a deployment that isn't Multi\-AZ\. For more information, see [Configuring and managing a Multi\-AZ deployment](Concepts.MultiAZ.md)\. -+ **IAM policies **– Does your AWS account have policies that grant the permissions needed to perform Amazon RDS operations? If you are connecting to AWS using IAM credentials, your IAM account must have IAM policies that grant the permissions required to perform Amazon RDS operations\. For more information, see [Identity and access management for Amazon RDS](UsingWithRDS.IAM.md)\. -+ **Open ports **– What TCP/IP port does your database listen on? The firewalls at some companies might block connections to the default port for your database engine\. If your company firewall blocks the default port, choose another port for the new DB instance\. When you create a DB instance that listens on a port you specify, you can change the port by modifying the DB instance\. -+ **AWS Region **– What AWS Region do you want your database in? Having your database in close proximity to your application or web service can reduce network latency\. For more information, see [Regions, Availability Zones, and Local Zones](Concepts.RegionsAndAvailabilityZones.md)\. -+ **DB disk subsystem **– What are your storage requirements? Amazon RDS provides three storage types: - + General Purpose \(SSD\) - + Provisioned IOPS \(PIOPS\) - + Magnetic \(also known as standard storage\) - - For more information on Amazon RDS storage, see [Amazon RDS DB instance storage](CHAP_Storage.md)\. - -When you have the information you need to create the security group and the DB instance, continue to the next step\. - -## Provide access to your DB instance in your VPC by creating a security group - -VPC security groups provide access to DB instances in a VPC\. They act as a firewall for the associated DB instance, controlling both inbound and outbound traffic at the DB instance level\. DB instances are created by default with a firewall and a default security group that protect the DB instance\. - -Before you can connect to your DB instance, you must add rules to a security group that enable you to connect\. Use your network and configuration information to create rules to allow access to your DB instance\. - -For example, suppose that you have an application that accesses a database on your DB instance in a VPC\. In this case, you must add a custom TCP rule that specifies the port range and IP addresses that your application uses to access the database\. If you have an application on an Amazon EC2 instance, you can use the security group that you set up for the Amazon EC2 instance\. - -You can configure connectivity between an Amazon EC2 instance a DB instance when you create the DB instance\. For more information, see [Configure automatic network connectivity with an EC2 instance](USER_CreateDBInstance.md#USER_CreateDBInstance.Prerequisites.VPC.Automatic)\. - -**Tip** -You can set up network connectivity between an Amazon EC2 instance and a DB instance automatically when you create the DB instance\. For more information, see [Configure automatic network connectivity with an EC2 instance](USER_CreateDBInstance.md#USER_CreateDBInstance.Prerequisites.VPC.Automatic)\. - -For information about common scenarios for accessing a DB instance, see [Scenarios for accessing a DB instance in a VPC](USER_VPC.Scenarios.md)\. - -**To create a VPC security group** - -1. Sign in to the AWS Management Console and open the Amazon VPC console at [https://console\.aws\.amazon\.com/vpc](https://console.aws.amazon.com/vpc)\. -**Note** -Make sure you are in the VPC console, not the RDS console\. - -1. In the upper\-right corner of the AWS Management Console, choose the AWS Region where you want to create your VPC security group and DB instance\. In the list of Amazon VPC resources for that AWS Region, you should see at least one VPC and several subnets\. If you don't, you don't have a default VPC in that AWS Region\. - -1. In the navigation pane, choose **Security Groups**\. - -1. Choose **Create security group**\. - - The **Create security group** page appears\. - -1. In **Basic details**, enter the **Security group name** and **Description**\. For **VPC**, choose the VPC that you want to create your DB instance in\. - -1. In **Inbound rules**, choose **Add rule**\. - - 1. For **Type**, choose **Custom TCP**\. - - 1. For **Port range**, enter the port value to use for your DB instance\. - - 1. For **Source**, choose a security group name or type the IP address range \(CIDR value\) from where you access the DB instance\. If you choose **My IP**, this allows access to the DB instance from the IP address detected in your browser\. - -1. If you need to add more IP addresses or different port ranges, choose **Add rule** and enter the information for the rule\. - -1. \(Optional\) In **Outbound rules**, add rules for outbound traffic\. By default, all outbound traffic is allowed\. - -1. Choose **Create security group**\. - -You can use the VPC security group that you just created as the security group for your DB instance when you create it\. - -**Note** -If you use a default VPC, a default subnet group spanning all of the VPC's subnets is created for you\. When you create a DB instance, you can select the default VPC and use **default** for **DB Subnet Group**\. - -After you have completed the setup requirements, you can create a DB instance using your requirements and security group\. To do so, follow the instructions in [Creating an Amazon RDS DB instance](USER_CreateDBInstance.md)\. For information about getting started by creating a DB instance that uses a specific DB engine, see the relevant documentation in the following table\. - - -**** - -| Database engine | Documentation | -| --- | --- | -| MariaDB | [Creating and connecting to a MariaDB DB instance](CHAP_GettingStarted.CreatingConnecting.MariaDB.md) | -| Microsoft SQL Server | [Creating and connecting to a Microsoft SQL Server DB instance](CHAP_GettingStarted.CreatingConnecting.SQLServer.md) | -| MySQL | [Creating and connecting to a MySQL DB instance](CHAP_GettingStarted.CreatingConnecting.MySQL.md) | -| Oracle | [Creating and connecting to an Oracle DB instance](CHAP_GettingStarted.CreatingConnecting.Oracle.md) | -| PostgreSQL | [Creating and connecting to a PostgreSQL DB instance](CHAP_GettingStarted.CreatingConnecting.PostgreSQL.md) | - -**Note** -If you can't connect to a DB instance after you create it, see the troubleshooting information in [Can't connect to Amazon RDS DB instance](CHAP_Troubleshooting.md#CHAP_Troubleshooting.Connecting)\. \ No newline at end of file diff --git a/doc_source/CHAP_Storage.md b/doc_source/CHAP_Storage.md deleted file mode 100644 index 359eeef..0000000 --- a/doc_source/CHAP_Storage.md +++ /dev/null @@ -1,254 +0,0 @@ -# Amazon RDS DB instance storage - -DB instances for Amazon RDS for MySQL, MariaDB, PostgreSQL, Oracle, and Microsoft SQL Server use Amazon Elastic Block Store \(Amazon EBS\) volumes for database and log storage\. - -In some cases, your database workload might not be able to achieve 100 percent of the IOPS that you have provisioned\. For more information, see [Factors that affect storage performance](#CHAP_Storage.Other.Factors)\. - -For more information about instance storage pricing, see [Amazon RDS pricing](https://aws.amazon.com/rds/pricing/)\. - -## Amazon RDS storage types - -Amazon RDS provides three storage types: General Purpose SSD \(also known as gp2 and gp3\), Provisioned IOPS SSD \(also known as io1\), and magnetic \(also known as standard\)\. They differ in performance characteristics and price, which means that you can tailor your storage performance and cost to the needs of your database workload\. You can create MySQL, MariaDB, Oracle, and PostgreSQL RDS DB instances with up to 64 tebibytes \(TiB\) of storage\. You can create SQL Server RDS DB instances with up to 16 TiB of storage\. For this amount of storage, use the Provisioned IOPS SSD and General Purpose SSD storage types\. - -The following list briefly describes the three storage types: -+ **General Purpose SSD** – General Purpose SSD volumes offer cost\-effective storage that is ideal for a broad range of workloads running on medium\-sized DB instances\. General Purpose storage is best suited for development and testing environments\. - - For more information about General Purpose SSD storage, including the storage size ranges, see [General Purpose SSD storage](#Concepts.Storage.GeneralSSD)\. -+ **Provisioned IOPS SSD** – Provisioned IOPS storage is designed to meet the needs of I/O\-intensive workloads, particularly database workloads, that require low I/O latency and consistent I/O throughput\. Provisioned IOPS storage is best suited for production environments\. - - For more information about Provisioned IOPS storage, including the storage size ranges, see [Provisioned IOPS SSD storage](#USER_PIOPS)\. -+ **Magnetic** – Amazon RDS also supports magnetic storage for backward compatibility\. We recommend that you use General Purpose SSD or Provisioned IOPS SSD for any new storage needs\. The maximum amount of storage allowed for DB instances on magnetic storage is less than that of the other storage types\. For more information, see [Magnetic storage](#CHAP_Storage.Magnetic)\. - -When you select General Purpose SSD or Provisioned IOPS SSD, depending on the engine selected and the amount of storage requested, Amazon RDS automatically stripes across multiple volumes to enhance performance, as shown in the following table\. - - -| Database engine | Amazon RDS storage size | Amount of volumes provisioned | -| --- | --- | --- | -| MariaDB, MySQL, and PostgreSQL | Less than 400 GiB | 1 | -| MariaDB, MySQL, and PostgreSQL | Between 400 and 64,000 GiB | 4 | -| Oracle | Less than 200 GiB | 1 | -| Oracle | Between 200 and 64,000 GiB | 4 | -| SQL Server | Any | 1 | - -When you modify a General Purpose SSD or Provisioned IOPS SSD volume, it goes through a sequence of states\. While the volume is in the `optimizing` state, your volume performance is in between the source and target configuration specifications\. Transitional volume performance will be no less than the lowest of the two specifications\. For more information on volume modifications, see [Monitor the progress of volume modifications](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/monitoring-volume-modifications.html) in the *Amazon EC2 User Guide*\. - -**Important** -When you modify an instance’s storage so that it goes from one volume to four volumes, or when you modify an instance using magnetic storage, Amazon RDS does not use the Elastic Volumes feature\. Instead, Amazon RDS provisions new volumes and transparently moves the data from the old volume to the new volumes\. This operation consumes a significant amount of IOPS and throughput of both the old and new volumes\. Depending on the size of the volume and the amount of database workload present during the modification, this operation can consume a high amount of IOPS, significantly increase IO latency, and take several hours to complete, while the RDS instance remains in the `Modifying` state\. - -## General Purpose SSD storage - -General Purpose SSD storage offers cost\-effective storage that is acceptable for most database workloads that aren't latency sensitive\. - -**Note** -DB instances that use General Purpose SSD storage can experience much longer latency after read replica creation, Multi\-AZ conversion, and DB snapshot restoration than instances that use Provisioned IOPS storage\. If you need a DB instance with minimum latency after these operations, we recommend using [Provisioned IOPS SSD storage](#USER_PIOPS)\. - -Amazon RDS offers two types of General Purpose SSD storage: [gp2 storage](#gp2-storage) and [gp3 storage](#gp3-storage)\. - -### gp2 storage - -When your applications don't need high storage performance, you can use General Purpose SSD gp2 storage\. Baseline I/O performance for gp2 storage is 3 IOPS for each GiB, with a minimum of 100 IOPS\. This relationship means that larger volumes have better performance\. For example, baseline performance for one 100\-GiB volume is 300 IOPS\. Baseline performance for one 1,000 GiB volume is 3,000 IOPS\. Maximum baseline performance for one gp2 volume \(5334 GiB and greater\) is 16,000 IOPS\. - -Individual gp2 volumes below 1,000 GiB in size also have the ability to burst to 3,000 IOPS for extended periods of time\. Volume I/O credit balance determines burst performance\. For more information about volume I/O credits, see [I/O credits and burst performance](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/general-purpose.html#EBSVolumeTypes_gp2) in the *Amazon EC2 User Guide*\. For a more detailed description of how baseline performance and I/O credit balance affect performance, see the post [Understanding burst vs\. baseline performance with Amazon RDS and gp2](http://aws.amazon.com/blogs/database/understanding-burst-vs-baseline-performance-with-amazon-rds-and-gp2/) on the AWS Database Blog\. - -Many workloads never deplete the burst balance\. However, some workloads can exhaust the 3,000 IOPS burst storage credit balance, so you should plan your storage capacity to meet the needs of your workloads\. - -For gp2 volumes larger than 1,000 GiB, the baseline performance is greater than the burst performance\. For such volumes, burst is irrelevant because the baseline performance is better than the 3,000 IOPS burst performance\. However, for DB instances of certain engines and sizes, storage is *striped* across four volumes providing four times the baseline throughput, and four times the burst IOPS of a single volume\. Storage performance for gp2 volumes on Amazon RDS DB engines, including the threshold, is shown in the following table\. - - -| DB engine | RDS Storage size | Range of Baseline IOPS | Range of Baseline Throughput | Burst IOPS | -| --- | --- | --- | --- | --- | -| MariaDB, MySQL, and PostgreSQL | Between 20 and 399 GiB | 100\-1197 IOPS | 128\-250 MiB/s | 3,000 | -| MariaDB, MySQL, and PostgreSQL | Between 400 and 1,335 GiB | 1,200\-4,005 IOPS | 500\-1,000 MiB/s | 12,000 | -| MariaDB, MySQL, and PostgreSQL | Between 1,336 and 3,999 GiB | 4008\-11,997 IOPS | 1,000 MiB/s | 12,000 | -| MariaDB, MySQL, and PostgreSQL | Between 4,000 and 65,536 GiB | 12,000\-64,000 IOPS | 1,000 MiB/s | N/A\* | -| Oracle | Between 20 and 199 GiB | 100\-597 IOPS | 128\-250 MiB/s | 3,000 | -| Oracle | Between 200 and 1,335 GiB | 600\-4,005 IOPS | 500\-1,000 MiB/s | 12,000 | -| Oracle | Between 1,336 and 3,999 GiB | 4008\-11,997 IOPS | 1,000 MiB/s | 12,000 | -| Oracle | Between 4,000 and 65,536 GiB | 12,000\-64,000 IOPS | 1,000 MiB/s | N/A\* | -| SQL Server | Between 20 and 333 GiB | 100\-999 IOPS | 128\-250 MiB/s | 3,000 | -| SQL Server | Between 334 and 999 GiB | 1,002\-2,997 IOPS | 250 MiB/s | 3,000 | -| SQL Server | Between 1,000 and 16,384 GiB | 3,000\-16,000 IOPS | 250 MiB/s | N/A\* | - -\* The baseline performance of the volume exceeds the maximum burst performance\. - -### gp3 storage - -By using General Purpose SSD gp3 storage volumes, you can customize storage performance independently of storage capacity\. *Storage performance* is the combination of I/O operations per second \(IOPS\) and how fast the storage volume can perform reads and writes \(storage throughput\)\. On gp3 storage volumes, Amazon RDS provides a baseline storage performance of 3000 IOPS and 125 MiB/s\. - -For every RDS DB engine except RDS for SQL Server, when the storage size for gp3 volumes reaches a certain threshold, the baseline storage performance increases to 12,000 IOPS and 500 MiB/s\. This is because of *volume striping*, where the storage uses four volumes instead of one\. RDS for SQL Server doesn't support volume striping, and therefore doesn't have a threshold value\. - -**Note** -General Purpose SSD gp3 storage is supported on Single\-AZ and Multi\-AZ DB instances, but isn't supported on Multi\-AZ DB clusters\. For more information, see [Configuring and managing a Multi\-AZ deployment](Concepts.MultiAZ.md) and [Multi\-AZ DB cluster deployments](multi-az-db-clusters-concepts.md)\. - -Storage performance for gp3 volumes on Amazon RDS DB engines, including the threshold, is shown in the following table\. - - -| DB engine | Storage size | Baseline storage performance | Range of Provisioned IOPS | Range of provisioned storage throughput | -| --- | --- | --- | --- | --- | -| MariaDB, MySQL, and PostgreSQL | Less than 400 GiB | 3,000 IOPS/125 MiB/s | N/A | N/A | -| MariaDB, MySQL, and PostgreSQL | 400 GiB and higher | 12,000 IOPS/500 MiB/s | 12,000–64,000 IOPS | 500–4,000 MiB/s | -| Oracle | Less than 200 GiB | 3,000 IOPS/125 MiB/s | N/A | N/A | -| Oracle | 200 GiB and higher | 12,000 IOPS/500 MiB/s | 12,000–64,000 IOPS | 500–4,000 MiB/s | -| SQL Server | 20 GiB–16 TiB | 3,000 IOPS/125 MiB/s | 3,000–16,000 IOPS | 125–1,000 MiB/s | - -For every DB engine except RDS for SQL Server, you can provision additional IOPS and storage throughput when storage size is at or above the threshold value\. For RDS for SQL Server, you can provision additional IOPS and storage throughput for any available storage size\. For all DB engines, you pay for only the additional provisioned storage performance\. For more information, see [Amazon RDS pricing](http://aws.amazon.com/rds/pricing/)\. - -Although the added Provisioned IOPS and storage throughput aren't dependent on the storage size, they are related to each other\. When you raise the IOPS above 32,000 for MariaDB and MySQL, the storage throughput value automatically increases from 500 MiB/s\. For example, when you set the IOPS to 40,000 on RDS for MySQL, the storage throughput must be at least 625 MiB/s\. The automatic increase doesn't happen for Oracle, PostgreSQL, and SQL Server DB instances\. - -Storage performance values for gp3 volumes on RDS have the following constraints: -+ The maximum ratio of storage throughput to IOPS is 0\.25 for all supported DB engines\. -+ The minimum ratio of IOPS to allocated storage \(in GiB\) is 0\.5 on RDS for SQL Server\. There is no minimum ratio for the other supported DB engines\. -+ The maximum ratio of IOPS to allocated storage is 500 for all supported DB engines\. -+ If you're using storage autoscaling, the same ratios between IOPS and maximum storage threshold \(in GiB\) also apply\. - - For more information on storage autoscaling, see [Managing capacity automatically with Amazon RDS storage autoscaling](USER_PIOPS.StorageTypes.md#USER_PIOPS.Autoscaling)\. - -## Provisioned IOPS SSD storage - -For a production application that requires fast and consistent I/O performance, we recommend Provisioned IOPS storage\. Provisioned IOPS storage is a storage type that delivers predictable performance, and consistently low latency\. Provisioned IOPS storage is optimized for online transaction processing \(OLTP\) workloads that require consistent performance\. Provisioned IOPS helps performance tuning of these workloads\. - -When you create a DB instance, you specify the IOPS rate and the size of the volume\. Amazon RDS provides that IOPS rate for the DB instance until you change it\. - -### io1 storage - -For I/O\-intensive workloads, you can use Provisioned IOPS SSD io1 storage and achieve up to 256,000 I/O operations per second \(IOPS\)\. The throughput of io1 volumes varies based on the amount of IOPS provisioned per volume and on the size of the IO operations being executed\. For more information about throughput of io1 volumes, see [Provisioned IOPS volumes](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/provisioned-iops.html#EBSVolumeTypes_piops) in the *Amazon EC2 User Guide*\. - -The following table shows the range of Provisioned IOPS and and maximum throughput for each database engine and storage size range\. - - -| Database engine | Range of storage size | Range of Provisioned IOPS | Maximum throughput | -| --- | --- | --- | --- | -| MariaDB, MySQL, and PostgreSQL | Between 100 and 399 GiB | 1,000–19,950 IOPS | 500 MiB/s | -| MariaDB, MySQL, and PostgreSQL | Between 400 and 65,536 GiB | 1,000–256,000 IOPS | 4,000 MiB/s | -| Oracle | Between 100 and 199 GiB | 1,000–9,950 IOPS | 500 MiB/s | -| Oracle | Between 200 and 65,536 GiB | 1,000–256,000 IOPS | 4,000 MiB/s | -| SQL Server | Between 20 and 16,384 GiB | 1,000–64,000 IOPS | 1,000 MiB/s | - -**Note** -For SQL Server, the maximum 64,000 IOPS is guaranteed only on [Nitro\-based instances](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-types.html#ec2-nitro-instances) that are on the m5\*, m6i, r5\*, r6i, and z1d instance types\. Other instance types guarantee performance up to 32,000 IOPS\. -For Oracle, you can provision the maximum 256,000 IOPS only on the r5b instance type\. - -The IOPS and storage size ranges have the following constraints: -+ The ratio of IOPS to allocated storage \(in GiB\) must be from 1–50 on RDS for SQL Server, and 0\.5–50 on other RDS DB engines\. -+ If you're using storage autoscaling, the same ratios between IOPS and maximum storage threshold \(in GiB\) also apply\. - - For more information on storage autoscaling, see [Managing capacity automatically with Amazon RDS storage autoscaling](USER_PIOPS.StorageTypes.md#USER_PIOPS.Autoscaling)\. - -### Combining Provisioned IOPS storage with Multi\-AZ deployments or read replicas - -For production OLTP use cases, we recommend that you use Multi\-AZ deployments for enhanced fault tolerance with Provisioned IOPS storage for fast and predictable performance\. - -You can also use Provisioned IOPS SSD storage with read replicas for MySQL, MariaDB or PostgreSQL\. The type of storage for a read replica is independent of that on the primary DB instance\. For example, you might use General Purpose SSD for read replicas with a primary DB instance that uses Provisioned IOPS SSD storage to reduce costs\. However, your read replica's performance in this case might differ from that of a configuration where both the primary DB instance and the read replicas use Provisioned IOPS SSD storage\. - -### Provisioned IOPS storage costs - -With Provisioned IOPS storage, you are charged for the provisioned resources whether or not you use them in a given month\. - -For more information about pricing, see [Amazon RDS pricing](https://aws.amazon.com/rds/pricing/)\. - -### Getting the best performance from Amazon RDS Provisioned IOPS SSD storage - -If your workload is I/O constrained, using Provisioned IOPS SSD storage can increase the number of I/O requests that the system can process concurrently\. Increased concurrency allows for decreased latency because I/O requests spend less time in a queue\. Decreased latency allows for faster database commits, which improves response time and allows for higher database throughput\. - -Provisioned IOPS SSD storage provides a way to reserve I/O capacity by specifying IOPS\. However, as with any other system capacity attribute, its maximum throughput under load is constrained by the resource that is consumed first\. That resource might be network bandwidth, CPU, memory, or database internal resources\. - -For more information about getting the most out of your Provisioned IOPS volumes, see [Amazon EBS volume performance](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/EBSPerformance.html)\. - -## Comparing solid\-state drive \(SSD\) storage types - -The following table shows use cases and performance characteristics for the SSD storage volumes used by Amazon RDS\. - - -| Characteristic | Provisioned IOPS \(io1\) | General Purpose \(gp3\) | General Purpose \(gp2\) | -| --- | --- | --- | --- | -| Description | Consistent storage performance \(IOPS, throughput, latency\) Designed for latency\-sensitive, transactional workloads | Flexibility in provisioning storage, IOPS, and throughput independently Balances price performance for a wide variety of transactional workloads | Provides burstable IOPS Balances price performance for a wide variety of transactional workloads | -| Use cases | Transactional workloads that require sustained IOPS performance up to 256,000 IOPS | Broad range of workloads running on medium\-sized relational databases in development/test environments | Broad range of workloads running on medium\-sized relational databases in development/test environments | -| Latency | Single\-digit millisecond, provided consistently 99\.9% of the time | Single\-digit millisecond, provided consistently 99% of the time | Single\-digit millisecond, provided consistently 99% of the time | -| Volume size | 100 GiB–64 TiB \(16 TiB on RDS for SQL Server\) | 20 GiB–64 TiB \(16 TiB on RDS for SQL Server\) | 20 GiB–64 TiB \(16 TiB on RDS for SQL Server\) | -| Maximum IOPS | 256,000 \(64,000 on RDS for SQL Server\) | 64,000 \(16,000 on RDS for SQL Server\) | 64,000 \(16,000 on RDS for SQL Server\) You can't provision IOPS directly on gp2 storage\. IOPS varies with the allocated storage size\. | -| Maximum throughput | Scales based on Provisioned IOPS up to 4,000 MB/s | Provision additional throughput up to 4,000 MB/s \(1000 MB/s on RDS for SQL Server | 1000 MB/s \(250 MB/s on RDS for SQL Server\) | -| AWS CLI and RDS API name | io1 | gp3 | gp2 | - -## Magnetic storage - -Amazon RDS also supports magnetic storage for backward compatibility\. We recommend that you use General Purpose SSD or Provisioned IOPS SSD for any new storage needs\. The following are some limitations for magnetic storage: -+ Doesn't allow you to scale storage when using the SQL Server database engine\. -+ Doesn't support storage autoscaling\. -+ Doesn't support elastic volumes\. -+ Limited to a maximum size of 3 TiB\. -+ Limited to a maximum of 1,000 IOPS\. - -## Monitoring storage performance - -Amazon RDS provides several metrics that you can use to determine how your DB instance is performing\. You can view the metrics on the summary page for your instance in Amazon RDS Management Console\. You can also use Amazon CloudWatch to monitor these metrics\. For more information, see [Viewing metrics in the Amazon RDS console](USER_Monitoring.md)\. Enhanced Monitoring provides more detailed I/O metrics; for more information, see [Monitoring OS metrics with Enhanced Monitoring](USER_Monitoring.OS.md)\. - -The following metrics are useful for monitoring storage for your DB instance: -+ **IOPS** – The number of I/O operations completed each second\. This metric is reported as the average IOPS for a given time interval\. Amazon RDS reports read and write IOPS separately on 1\-minute intervals\. Total IOPS is the sum of the read and write IOPS\. Typical values for IOPS range from zero to tens of thousands per second\. -+ **Latency** – The elapsed time between the submission of an I/O request and its completion\. This metric is reported as the average latency for a given time interval\. Amazon RDS reports read and write latency separately at 1\-minute intervals\. Typical values for latency are in milliseconds \(ms\)\. -+ **Throughput** – The number of bytes each second that are transferred to or from disk\. This metric is reported as the average throughput for a given time interval\. Amazon RDS reports read and write throughput separately on 1\-minute intervals using units of megabytes per second \(MB/s\)\. Typical values for throughput range from zero to the I/O channel's maximum bandwidth\. -+ **Queue Depth** – The number of I/O requests in the queue waiting to be serviced\. These are I/O requests that have been submitted by the application but have not been sent to the device because the device is busy servicing other I/O requests\. Time spent waiting in the queue is a component of latency and service time \(not available as a metric\)\. This metric is reported as the average queue depth for a given time interval\. Amazon RDS reports queue depth in 1\-minute intervals\. Typical values for queue depth range from zero to several hundred\. - -Measured IOPS values are independent of the size of the individual I/O operation\. This means that when you measure I/O performance, make sure to look at the throughput of the instance, not simply the number of I/O operations\. - -## Factors that affect storage performance - -System activities, database workload, and DB instance class can affect storage performance\. - -### System activities - -The following system\-related activities consume I/O capacity and might reduce DB instance performance while in progress: -+ Multi\-AZ standby creation -+ Read replica creation -+ Changing storage types - -### Database workload - -In some cases, your database or application design results in concurrency issues, locking, or other forms of database contention\. In these cases, you might not be able to use all the provisioned bandwidth directly\. In addition, you might encounter the following workload\-related situations: -+ The throughput limit of the underlying instance type is reached\. -+ Queue depth is consistently less than 1 because your application isn't driving enough I/O operations\. -+ You experience query contention in the database even though some I/O capacity is unused\. - -In some cases, there isn't a system resource that is at or near a limit, and adding threads doesn't increase the database transaction rate\. In such cases, the bottleneck is most likely contention in the database\. The most common forms are row lock and index page lock contention, but there are many other possibilities\. If this is your situation, seek the advice of a database performance tuning expert\. - -### DB instance class - -To get the most performance out of your Amazon RDS DB instance, choose a current generation instance type with enough bandwidth to support your storage type\. For example, you can choose Amazon EBS–optimized instances and instances with 10\-gigabit network connectivity\. - -**Important** -Depending on the instance class you're using, you might see lower IOPS performance than the maximum that you can provision with RDS\. For specific information on IOPS performance for DB instance classes, see [Amazon EBS–optimized instances](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ebs-optimized.html) in the *Amazon EC2 User Guide*\. We recommend that you determine the maximum IOPS for the instance class before setting a Provisioned IOPS value for your DB instance\. - -We encourage you to use the latest generation of instances to get the best performance\. Previous generation DB instances can also have lower maximum storage\. - -Some older 32\-bit file systems might have lower storage capacities\. To determine the storage capacity of your DB instance, you can use the [describe\-valid\-db\-instance\-modifications](https://docs.aws.amazon.com/cli/latest/reference/rds/describe-valid-db-instance-modifications.html) AWS CLI command\. - -The following list shows the maximum storage that most DB instance classes can scale to for each database engine: -+ MariaDB – 64 TiB -+ Microsoft SQL Server – 16 TiB -+ MySQL – 64 TiB -+ Oracle – 64 TiB -+ PostgreSQL – 64 TiB - -The following table shows some exceptions for maximum storage \(in TiB\)\. All RDS for Microsoft SQL Server DB instances have a maximum storage of 16 TiB, so there are no entries for SQL Server\. - - -| Instance class | MariaDB | MySQL | Oracle | PostgreSQL | -| --- | --- | --- | --- | --- | -| db\.m3 – standard instance classes | -| db\.m3\.2xlarge | N/A | 6 | N/A | 6 | -| db\.m3\.xlarge | N/A | 6 | N/A | 6 | -| db\.m3\.large | N/A | 6 | N/A | 6 | -| db\.m3\.medium | N/A | 32 | N/A | 32 | -| db\.t4g – burstable\-performance instance classes | -| db\.t4g\.medium | 16 | 16 | N/A | 32 | -| db\.t4g\.small | 16 | 16 | N/A | 16 | -| db\.t4g\.micro | 6 | 6 | N/A | 6 | -| db\.t3 – burstable\-performance instance classes | -| db\.t3\.medium | 16 | 16 | 32 | 32 | -| db\.t3\.small | 16 | 16 | 32 | 16 | -| db\.t3\.micro | 6 | 6 | 32 | 6 | -| db\.t2 – burstable\-performance instance classes | -| db\.t2\.medium | 32 | 32 | N/A | 32 | -| db\.t2\.small | 16 | 16 | N/A | 16 | -| db\.t2\.micro | 6 | 6 | N/A | 6 | - -For more details about all instance classes supported, see [Previous generation DB instances](http://aws.amazon.com/rds/previous-generation/)\. \ No newline at end of file diff --git a/doc_source/CHAP_Troubleshooting.md b/doc_source/CHAP_Troubleshooting.md deleted file mode 100644 index f47e3b0..0000000 --- a/doc_source/CHAP_Troubleshooting.md +++ /dev/null @@ -1,534 +0,0 @@ -# Troubleshooting for Amazon RDS - -Use the following sections to help troubleshoot problems you have with DB instances in Amazon RDS and Amazon Aurora\. - -**Topics** -+ [Can't connect to Amazon RDS DB instance](#CHAP_Troubleshooting.Connecting) -+ [Amazon RDS security issues](#CHAP_Troubleshooting.Security) -+ [Resetting the DB instance owner password](#CHAP_Troubleshooting.ResetPassword) -+ [Amazon RDS DB instance outage or reboot](#CHAP_Troubleshooting.Reboots) -+ [Amazon RDS DB parameter changes not taking effect](#CHAP_Troubleshooting.Parameters) -+ [Amazon RDS DB instance running out of storage](#CHAP_Troubleshooting.Storage) -+ [Amazon RDS insufficient DB instance capacity](#CHAP_Troubleshooting.Capacity) -+ [Freeable memory issues in Amazon RDS](#Troubleshooting.FreeableMemory) -+ [MySQL and MariaDB issues](#CHAP_Troubleshooting.MySQL) -+ [Can't set backup retention period to 0](#CHAP_Troubleshooting.Backup.Retention) - - For information about debugging problems using the Amazon RDS API, see [Troubleshooting applications on Amazon RDS](APITroubleshooting.md)\. - -## Can't connect to Amazon RDS DB instance - -When you can't connect to a DB instance, the following are common causes: -+ **Inbound rules** – The access rules enforced by your local firewall and the IP addresses authorized to access your DB instance might not match\. The problem is most likely the inbound rules in your security group\. - - By default, DB instances don't allow access\. Access is granted through a security group associated with the VPC that allows traffic into and out of the DB instance\. If necessary, add inbound and outbound rules for your particular situation to the security group\. You can specify an IP address, a range of IP addresses, or another VPC security group\. -**Note** -When adding a new inbound rule, you can choose **My IP** for **Source** to allow access to the DB instance from the IP address detected in your browser\. - - For more information about setting up security groups, see [Provide access to your DB instance in your VPC by creating a security group](CHAP_SettingUp.md#CHAP_SettingUp.SecurityGroup)\. -**Note** -Client connections from IP addresses within the range 169\.254\.0\.0/16 aren't permitted\. This is the Automatic Private IP Addressing Range \(APIPA\), which is used for local\-link addressing\. -+ **Public accessibility** – To connect to your DB instance from outside of the VPC, such as by using a client application, the instance must have a public IP address assigned to it\. - - To make the instance publicly accessible, modify it and choose **Yes** under **Public accessibility**\. For more information, see [Hiding a DB instance in a VPC from the internet](USER_VPC.WorkingWithRDSInstanceinaVPC.md#USER_VPC.Hiding)\. -+ **Port** – The port that you specified when you created the DB instance can't be used to send or receive communications due to your local firewall restrictions\. To determine if your network allows the specified port to be used for inbound and outbound communication, check with your network administrator\. -+ **Availability** – For a newly created DB instance, the DB instance has a status of `creating` until the DB instance is ready to use\. When the state changes to `available`, you can connect to the DB instance\. Depending on the size of your DB instance, it can take up to 20 minutes before an instance is available\. -+ **Internet gateway** – For a DB instance to be publicly accessible, the subnets in its DB subnet group must have an internet gateway\. - -**To configure an internet gateway for a subnet** - - 1. Sign in to the AWS Management Console and open the Amazon RDS console at [https://console\.aws\.amazon\.com/rds/](https://console.aws.amazon.com/rds/)\. - - 1. In the navigation pane, choose **Databases**, and then choose the name of the DB instance\. - - 1. In the **Connectivity & security** tab, write down the values of the VPC ID under **VPC** and the subnet ID under **Subnets**\. - - 1. Open the Amazon VPC console at [https://console\.aws\.amazon\.com/vpc/](https://console.aws.amazon.com/vpc/)\. - - 1. In the navigation pane, choose **Internet Gateways**\. Verify that there is an internet gateway attached to your VPC\. Otherwise, choose **Create Internet Gateway** to create an internet gateway\. Select the internet gateway, and then choose **Attach to VPC** and follow the directions to attach it to your VPC\. - - 1. In the navigation pane, choose **Subnets**, and then select your subnet\. - - 1. On the **Route Table** tab, verify that there is a route with `0.0.0.0/0` as the destination and the internet gateway for your VPC as the target\. - - If you're connecting to your instance using its IPv6 address, verify that there is a route for all IPv6 traffic \(`::/0`\) that points to the internet gateway\. Otherwise, do the following: - - 1. Choose the ID of the route table \(rtb\-*xxxxxxxx*\) to navigate to the route table\. - - 1. On the **Routes** tab, choose **Edit routes**\. Choose **Add route**, use `0.0.0.0/0` as the destination and the internet gateway as the target\. - - For IPv6, choose **Add route**, use `::/0` as the destination and the internet gateway as the target\. - - 1. Choose **Save routes**\. - - Also, if you are trying to connect to IPv6 endpoint, make sure that client IPv6 address range is authorized to connect to the DB instance\. - - For more information, see [Working with a DB instance in a VPC](USER_VPC.WorkingWithRDSInstanceinaVPC.md)\. - -For engine\-specific connection issues, see the following topics: -+ [Troubleshooting connections to your SQL Server DB instance](USER_ConnectToMicrosoftSQLServerInstance.md#USER_ConnectToMicrosoftSQLServerInstance.Troubleshooting) -+ [Troubleshooting connections to your Oracle DB instance](USER_ConnectToOracleInstance.Troubleshooting.md) -+ [Troubleshooting connections to your RDS for PostgreSQL instance](USER_ConnectToPostgreSQLInstance.md#USER_ConnectToPostgreSQLInstance.Troubleshooting) -+ [Maximum MySQL and MariaDB connections](#USER_ConnectToInstance.max_connections) - -### Testing a connection to a DB instance - -You can test your connection to a DB instance using common Linux or Microsoft Windows tools\. - -From a Linux or Unix terminal, you can test the connection by entering the following\. Replace `DB-instance-endpoint` with the endpoint and `port` with the port of your DB instance\. - -``` -nc -zv DB-instance-endpoint port -``` - -For example, the following shows a sample command and the return value\. - -``` -nc -zv postgresql1.c6c8mn7fake0.us-west-2.rds.amazonaws.com 8299 - - Connection to postgresql1.c6c8mn7fake0.us-west-2.rds.amazonaws.com 8299 port [tcp/vvr-data] succeeded! -``` - -Windows users can use Telnet to test the connection to a DB instance\. Telnet actions aren't supported other than for testing the connection\. If a connection is successful, the action returns no message\. If a connection isn't successful, you receive an error message such as the following\. - -``` -C:\>telnet sg-postgresql1.c6c8mntfake0.us-west-2.rds.amazonaws.com 819 - - Connecting To sg-postgresql1.c6c8mntfake0.us-west-2.rds.amazonaws.com...Could not open - connection to the host, on port 819: Connect failed -``` - -If Telnet actions return success, your security group is properly configured\. - -**Note** -Amazon RDS doesn't accept internet control message protocol \(ICMP\) traffic, including ping\. - -### Troubleshooting connection authentication - -In some cases, you can connect to your DB instance but you get authentication errors\. In these cases, you might want to reset the master user password for the DB instance\. You can do this by modifying the RDS instance\. - -For more information about modifying a DB instance, see [Modifying an Amazon RDS DB instance](Overview.DBInstance.Modifying.md)\. - -## Amazon RDS security issues - -To avoid security issues, never use your master AWS user name and password for a user account\. Best practice is to use your master AWS account to create users and assign those to DB user accounts\. You can also use your master account to create other user accounts, if necessary\. - -For information about creating users, see [Creating an IAM user in your AWS account](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_users_create.html)\. For information about creating users in AWS IAM Identity Center \(successor to AWS Single Sign\-On\), see [Manage identities in IAM Identity Center](https://docs.aws.amazon.com/singlesignon/latest/userguide/manage-your-identity-source-sso.html)\. - -### Error message "failed to retrieve account attributes, certain console functions may be impaired\." - -You can get this error for several reasons\. It might be because your account is missing permissions, or your account hasn't been properly set up\. If your account is new, you might not have waited for the account to be ready\. If this is an existing account, you might lack permissions in your access policies to perform certain actions such as creating a DB instance\. To fix the issue, your administrator needs to provide the necessary roles to your account\. For more information, see [the IAM documentation](https://docs.aws.amazon.com/IAM/latest/UserGuide/)\. - -## Resetting the DB instance owner password - -If you get locked out of your DB instance, you can log in as the master user\. Then you can reset the credentials for other administrative users or roles\. If you can't log in as the master user, the AWS account owner can reset the master user password\. For details of which administrative accounts or roles you might need to reset, see [Master user account privileges](UsingWithRDS.MasterAccounts.md)\. - -You can change the DB instance password by using the Amazon RDS console, the AWS CLI command [modify\-db\-instance](https://docs.aws.amazon.com/cli/latest/reference/rds/modify-db-instance.html), or by using the [ModifyDBInstance](https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_ModifyDBInstance.html) API operation\. For more information about modifying a DB instance, see [Modifying an Amazon RDS DB instance](Overview.DBInstance.Modifying.md)\. - -## Amazon RDS DB instance outage or reboot - -A DB instance outage can occur when a DB instance is rebooted\. It can also occur when the DB instance is put into a state that prevents access to it, and when the database is restarted\. A reboot can occur when you manually reboot your DB instance\. A reboot can also occur when you change a DB instance setting that requires a reboot before it can take effect\. - - A DB instance reboot occurs when you change a setting that requires a reboot, or when you manually cause a reboot\. A reboot can occur immediately if you change a setting and request that the change take effect immediately\. Or it can occur during the DB instance's maintenance window\. - - A DB instance reboot occurs immediately when one of the following occurs: -+ You change the backup retention period for a DB instance from 0 to a nonzero value or from a nonzero value to 0\. You then set **Apply Immediately** to `true`\. -+ You change the DB instance class, and **Apply Immediately** is set to `true`\. -+ You change the storage type from **Magnetic \(Standard\)** to **General Purpose \(SSD**\) or **Provisioned IOPS \(SSD\)**, or from **Provisioned IOPS \(SSD\)** or **General Purpose \(SSD\)** to **Magnetic \(Standard\)**\. - -A DB instance reboot occurs during the maintenance window when one of the following occurs: -+ You change the backup retention period for a DB instance from 0 to a nonzero value or from a nonzero value to 0, and **Apply Immediately** is set to `false`\. -+ You change the DB instance class, and **Apply Immediately** is set to `false`\. - -When you change a static parameter in a DB parameter group, the change doesn't take effect until the DB instance associated with the parameter group is rebooted\. The change requires a manual reboot\. The DB instance isn't automatically rebooted during the maintenance window\. - -To see a table that shows DB instance actions and the effect that setting the **Apply Immediately** value has, see [Modifying an Amazon RDS DB instance](Overview.DBInstance.Modifying.md)\. - -## Amazon RDS DB parameter changes not taking effect - -In some cases, you might change a parameter in a DB parameter group but don't see the changes take effect\. If so, you likely need to reboot the DB instance associated with the DB parameter group\. When you change a dynamic parameter, the change takes effect immediately\. When you change a static parameter, the change doesn't take effect until you reboot the DB instance associated with the parameter group\. - -You can reboot a DB instance using the RDS console\. Or you can explicitly call the [https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_RebootDBInstance.html](https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_RebootDBInstance.html) API operation\. You can reboot without failover if the DB instance is in a Multi\-AZ deployment\. The requirement to reboot the associated DB instance after a static parameter change helps mitigate the risk of a parameter misconfiguration affecting an API call\. An example of this is calling `ModifyDBInstance` to change the DB instance class\. For more information, see [Modifying parameters in a DB parameter group](USER_WorkingWithDBInstanceParamGroups.md#USER_WorkingWithParamGroups.Modifying)\. - -## Amazon RDS DB instance running out of storage - -If your DB instance runs out of storage space, it might no longer be available\. We highly recommend that you constantly monitor the `FreeStorageSpace` metric published in CloudWatch to make sure that your DB instance has enough free storage space\. - -If your database instance runs out of storage, its status changes to `storage-full`\. For example, a call to the `DescribeDBInstances` API operation for a DB instance that has used up its storage outputs the following\. - -``` -aws rds describe-db-instances --db-instance-identifier mydbinstance - -DBINSTANCE mydbinstance 2009-12-22T23:06:11.915Z db.m5.large mysql8.0 50 sa -storage-full mydbinstance.clla4j4jgyph.us-east-1.rds.amazonaws.com 3306 -us-east-1b 3 - SECGROUP default active - PARAMGRP default.mysql8.0 in-sync -``` - -To recover from this scenario, add more storage space to your instance using the `ModifyDBInstance` API operation or the following AWS CLI command\. - -For Linux, macOS, or Unix: - -``` -aws rds modify-db-instance \ - --db-instance-identifier mydbinstance \ - --allocated-storage 60 \ - --apply-immediately -``` - -For Windows: - -``` -aws rds modify-db-instance ^ - --db-instance-identifier mydbinstance ^ - --allocated-storage 60 ^ - --apply-immediately -``` - -``` -DBINSTANCE mydbinstance 2009-12-22T23:06:11.915Z db.m5.large mysql8.0 50 sa -storage-full mydbinstance.clla4j4jgyph.us-east-1.rds.amazonaws.com 3306 -us-east-1b 3 60 - SECGROUP default active - PARAMGRP default.mysql8.0 in-sync -``` - -Now, when you describe your DB instance, you see that your DB instance has `modifying` status, which indicates the storage is being scaled\. - -``` -1. aws rds describe-db-instances --db-instance-identifier mydbinstance -``` - -``` -DBINSTANCE mydbinstance 2009-12-22T23:06:11.915Z db.m5.large mysql8.0 50 sa -modifying mydbinstance.clla4j4jgyph.us-east-1.rds.amazonaws.com -3306 us-east-1b 3 60 - SECGROUP default active - PARAMGRP default.mysql8.0 in-sync -``` - -After storage scaling is complete, your DB instance status changes to `available`\. - -``` -aws rds describe-db-instances --db-instance-identifier mydbinstance -``` - -``` -DBINSTANCE mydbinstance 2009-12-22T23:06:11.915Z db.m5.large mysql8.0 60 sa -available mydbinstance.clla4j4jgyph.us-east-1.rds.amazonaws.com 3306 -us-east-1b 3 - SECGROUP default active - PARAMGRP default.mysql8.0 in-sync -``` - -You can receive notifications when your storage space is exhausted using the `DescribeEvents` operation\. For example, in this scenario, if you make a `DescribeEvents` call after these operations you see the following output\. - -``` -aws rds describe-events --source-type db-instance --source-identifier mydbinstance -``` - -``` -2009-12-22T23:44:14.374Z mydbinstance Allocated storage has been exhausted db-instance -2009-12-23T00:14:02.737Z mydbinstance Applying modification to allocated storage db-instance -2009-12-23T00:31:54.764Z mydbinstance Finished applying modification to allocated storage -``` - -## Amazon RDS insufficient DB instance capacity - -The `InsufficientDBInstanceCapacity` error can be returned when you try to create, start, or modify a DB instance\. It can also be returned when you try to restore a DB instance from a DB snapshot\. When this error is returned, a common cause is that the specific DB instance class isn't available in the requested Availability Zone\. You can try one of the following to solve the problem: -+ Retry the request with a different DB instance class\. -+ Retry the request with a different Availability Zone\. -+ Retry the request without specifying an explicit Availability Zone\. - -For information about troubleshooting instance capacity issues for Amazon EC2, see [Insufficient instance capacity](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/troubleshooting-launch.html#troubleshooting-launch-capacity) in the *Amazon EC2 User Guide*\. - -For information about modifying a DB instance, see [Modifying an Amazon RDS DB instance](Overview.DBInstance.Modifying.md)\. - -## Freeable memory issues in Amazon RDS - -*Freeable memory* is the total random access memory \(RAM\) on a DB instance that can be made available to the database engine\. It's the sum of the free operating\-system \(OS\) memory and the available buffer and page cache memory\. The database engine uses most of the memory on the host, but OS processes also use some RAM\. Memory currently allocated to the database engine or used by OS processes isn't included in freeable memory\. When the database engine is running out of memory, the DB instance can use the temporary space that is normally used for buffering and caching\. As previously mentioned, this temporary space is included in freeable memory\. - -You use the `FreeableMemory` metric in Amazon CloudWatch to monitor the freeable memory\. For more information, see [Overview of monitoring metrics in Amazon RDS](MonitoringOverview.md)\. - -If your DB instance consistently runs low on freeable memory or uses swap space, consider scaling up to a larger DB instance class\. For more information, see [DB instance classes](Concepts.DBInstanceClass.md)\. - -You can also change the memory settings\. For example, on RDS for MySQL, you might adjust the size of the `innodb_buffer_pool_size` parameter\. This parameter is set by default to 75 percent of physical memory\. For more MySQL troubleshooting tips, see [How can I troubleshoot low freeable memory in an Amazon RDS for MySQL database?](https://aws.amazon.com/premiumsupport/knowledge-center/low-freeable-memory-rds-mysql-mariadb/) - -## MySQL and MariaDB issues - -You can diagnose and correct issues with MySQL and MariaDB DB instances\. - -**Topics** -+ [Maximum MySQL and MariaDB connections](#USER_ConnectToInstance.max_connections) -+ [Diagnosing and resolving incompatible parameters status for a memory limit](#CHAP_Troubleshooting.incompatible-parameters-memory) -+ [Diagnosing and resolving lag between read replicas](#CHAP_Troubleshooting.MySQL.ReplicaLag) -+ [Diagnosing and resolving a MySQL or MariaDB read replication failure](#CHAP_Troubleshooting.MySQL.RR) -+ [Creating triggers with binary logging enabled requires SUPER privilege](#CHAP_Troubleshooting.MySQL.CreatingTriggers) -+ [Diagnosing and resolving point\-in\-time restore failures](#CHAP_Troubleshooting.MySQL.PITR) -+ [Replication stopped error](#CHAP_Troubleshooting.MySQL.ReplicationStopped) -+ [Read replica create fails or replication breaks with fatal error 1236](#CHAP_Troubleshooting.MySQL.ReadReplicas) - -### Maximum MySQL and MariaDB connections - -The maximum number of connections allowed to an RDS for MySQL or RDS for MariaDB DB instance is based on the amount of memory available for its DB instance class\. A DB instance class with more memory available results in a larger number of connections available\. For more information on DB instance classes, see [DB instance classes](Concepts.DBInstanceClass.md)\. - -The connection limit for a DB instance is set by default to the maximum for the DB instance class\. You can limit the number of concurrent connections to any value up to the maximum number of connections allowed\. Use the `max_connections` parameter in the parameter group for the DB instance\. For more information, see [Maximum number of database connections](CHAP_Limits.md#RDS_Limits.MaxConnections) and [Working with parameter groups](USER_WorkingWithParamGroups.md)\. - -You can retrieve the maximum number of connections allowed for a MySQL or MariaDB DB instance by running the following query\. - -``` -SELECT @@max_connections; -``` - -You can retrieve the number of active connections to a MySQL or MariaDB DB instance by running the following query\. - -``` -SHOW STATUS WHERE `variable_name` = 'Threads_connected'; -``` - -### Diagnosing and resolving incompatible parameters status for a memory limit - -A MariaDB or MySQL DB instance can be placed in **incompatible\-parameters** status for a memory limit when the following conditions are met: -+ The DB instance is restarted at least three times in one hour or at least five times in one day when the DB instance status is **Available**\. -+ An attempt to restart the DB instance fails because a maintenance action or monitoring process couldn't restart the DB instance\. -+ The potential memory usage of the DB instance exceeds 1\.2 times the memory allocated to its DB instance class\. - -When a DB instance is restarted for the third time in one hour or for the fifth time in one day, it performs a check for memory usage\. The check makes a calculation of the potential memory usage of the DB instance\. The value returned by the calculation is the sum of the following values: -+ **Value 1** – The sum of the following parameters: - + `innodb_additional_mem_pool_size` - + `innodb_buffer_pool_size` - + `innodb_log_buffer_size` - + `key_buffer_size` - + `query_cache_size` \(MySQL version 5\.7 only\) - + `tmp_table_size` -+ **Value 2** – The `max_connections` parameter multiplied by the sum of the following parameters: - + `binlog_cache_size` - + `join_buffer_size` - + `read_buffer_size` - + `read_rnd_buffer_size` - + `sort_buffer_size` - + `thread_stack` -+ **Value 3** – If the `performance_schema` parameter is enabled, then multiply the `max_connections` parameter by `257700`\. - - If the `performance_schema` parameter is disabled, then this value is zero\. - -So, the value returned by the calculation is the following: - -`Value 1 + Value 2 + Value 3` - -When this value exceeds 1\.2 times the memory allocated to the DB instance class used by the DB instance, the DB instance is placed in **incompatible\-parameters** status\. For information about the memory allocated to DB instance classes, see [Hardware specifications for DB instance classes](Concepts.DBInstanceClass.md#Concepts.DBInstanceClass.Summary)\. - -The calculation multiplies the value of the `max_connections` parameter by the sum of several parameters\. If the `max_connections` parameter is set to a large value, it might cause the check to return an inordinately high value for the potential memory usage of the DB instance\. In this case, consider lowering the value of the `max_connections` parameter\. - -To resolve the problem, complete the following steps: - -1. Adjust the memory parameters in the DB parameter group associated with the DB instance\. Do so such that the potential memory usage is lower than 1\.2 times the memory allocated to its DB instance class\. - - For information about setting parameters, see [Modifying parameters in a DB parameter group](USER_WorkingWithDBInstanceParamGroups.md#USER_WorkingWithParamGroups.Modifying)\. - -1. Restart the DB instance\. - - For information about setting parameters, see [Starting an Amazon RDS DB instance that was previously stopped](USER_StartInstance.md)\. - -### Diagnosing and resolving lag between read replicas - -After you create a MySQL or MariaDB read replica and the replica is available, Amazon RDS first replicates the changes made to the source DB instance from the time the read replica create operation started\. During this phase, the replication lag time for the read replica is greater than 0\. You can monitor this lag time in Amazon CloudWatch by viewing the Amazon RDS `ReplicaLag` metric\. - -The `ReplicaLag` metric reports the value of the `Seconds_Behind_Master` field of the MariaDB or MySQL `SHOW REPLICA STATUS` command\. For more information, see [SHOW REPLICA STATUS Statement](https://dev.mysql.com/doc/refman/8.0/en/show-replica-status.html) in the MySQL documentation\. - -When the `ReplicaLag` metric reaches 0, the replica has caught up to the source DB instance\. If the `ReplicaLag` metric returns \-1, replication might not be active\. To troubleshoot a replication error, see [Diagnosing and resolving a MySQL or MariaDB read replication failure](#CHAP_Troubleshooting.MySQL.RR)\. A `ReplicaLag` value of \-1 can also mean that the `Seconds_Behind_Master` value can't be determined or is `NULL`\. - -**Note** -Previous versions of MariaDB and MySQL used `SHOW SLAVE STATUS` instead of `SHOW REPLICA STATUS`\. If you are using a MariaDB version before 10\.5 or a MySQL version before 8\.0\.23, then use `SHOW SLAVE STATUS`\. - -The `ReplicaLag` metric returns \-1 during a network outage or when a patch is applied during the maintenance window\. In this case, wait for network connectivity to be restored or for the maintenance window to end before you check the `ReplicaLag` metric again\. - -The MySQL and MariaDB read replication technology is asynchronous\. Thus, you can expect occasional increases for the `BinLogDiskUsage` metric on the source DB instance and for the `ReplicaLag` metric on the read replica\. For example, consider a situation where a high volume of write operations to the source DB instance occur in parallel\. At the same time, write operations to the read replica are serialized using a single I/O thread\. Such a situation can lead to a lag between the source instance and read replica\. - -For more information about read replicas and MySQL, see [Replication implementation details](https://dev.mysql.com/doc/refman/8.0/en/replication-implementation-details.html) in the MySQL documentation\. For more information about read replicas and MariaDB, see [Replication overview](http://mariadb.com/kb/en/mariadb/replication-overview/) in the MariaDB documentation\. - -You can reduce the lag between updates to a source DB instance and the subsequent updates to the read replica by doing the following: -+ Set the DB instance class of the read replica to have a storage size comparable to that of the source DB instance\. -+ Make sure that parameter settings in the DB parameter groups used by the source DB instance and the read replica are compatible\. For more information and an example, see the discussion of the `max_allowed_packet` parameter in the next section\. -+ Disable the query cache\. For tables that are modified often, using the query cache can increase replica lag because the cache is locked and refreshed often\. If this is the case, you might see less replica lag if you disable the query cache\. You can disable the query cache by setting the `query_cache_type parameter` to 0 in the DB parameter group for the DB instance\. For more information on the query cache, see [Query cache configuration](https://dev.mysql.com/doc/refman/5.7/en/query-cache-configuration.html)\. -+ Warm the buffer pool on the read replica for InnoDB for MySQL or MariaDB\. For example, suppose that you have a small set of tables that are being updated often and you're using the InnoDB or XtraDB table schema\. In this case, dump those tables on the read replica\. Doing this causes the database engine to scan through the rows of those tables from the disk and then cache them in the buffer pool\. This approach can reduce replica lag\. The following shows an example\. - - For Linux, macOS, or Unix: - - ``` - PROMPT> mysqldump \ - -h \ - --port= \ - -u= \ - -p \ - database_name table1 table2 > /dev/null - ``` - - For Windows: - - ``` - PROMPT> mysqldump ^ - -h ^ - --port= ^ - -u= ^ - -p ^ - database_name table1 table2 > /dev/null - ``` - -### Diagnosing and resolving a MySQL or MariaDB read replication failure - -Amazon RDS monitors the replication status of your read replicas\. RDS updates the **Replication State** field of the read replica instance to `Error` if replication stops for any reason\. You can review the details of the associated error thrown by the MySQL or MariaDB engines by viewing the **Replication Error** field\. Events that indicate the status of the read replica are also generated, including [RDS-EVENT-0045](USER_Events.Messages.md#RDS-EVENT-0045), [RDS-EVENT-0046](USER_Events.Messages.md#RDS-EVENT-0046), and [RDS-EVENT-0047](USER_Events.Messages.md#RDS-EVENT-0047)\. For more information about events and subscribing to events, see [Working with Amazon RDS event notification](USER_Events.md)\. If a MySQL error message is returned, check the error in the [MySQL error message documentation](https://dev.mysql.com/doc/mysql-errors/8.0/en/server-error-reference.html)\. If a MariaDB error message is returned, check the error in the [MariaDB error message documentation](http://mariadb.com/kb/en/mariadb/mariadb-error-codes/)\. - -Common situations that can cause replication errors include the following: -+ The value for the `max_allowed_packet` parameter for a read replica is less than the `max_allowed_packet` parameter for the source DB instance\. - - The `max_allowed_packet` parameter is a custom parameter that you can set in a DB parameter group\. The `max_allowed_packet` parameter is used to specify the maximum size of data manipulation language \(DML\) that can be run on the database\. In some cases, the `max_allowed_packet` value for the source DB instance might be larger than the `max_allowed_packet` value for the read replica\. If so, the replication process can throw an error and stop replication\. The most common error is `packet bigger than 'max_allowed_packet' bytes`\. You can fix the error by having the source and read replica use DB parameter groups with the same `max_allowed_packet` parameter values\. -+ Writing to tables on a read replica\. If you're creating indexes on a read replica, you need to have the `read_only` parameter set to *0* to create the indexes\. If you're writing to tables on the read replica, it can break replication\. -+ Using a nontransactional storage engine such as MyISAM\. Read replicas require a transactional storage engine\. Replication is only supported for the following storage engines: InnoDB for MySQL or MariaDB\. - - You can convert a MyISAM table to InnoDB with the following command: - - `alter table . engine=innodb;` -+ Using unsafe nondeterministic queries such as `SYSDATE()`\. For more information, see [Determination of safe and unsafe statements in binary logging](https://dev.mysql.com/doc/refman/8.0/en/replication-rbr-safe-unsafe.html) in the MySQL documentation\. - -The following steps can help resolve your replication error: -+ If you encounter a logical error and you can safely skip the error, follow the steps described in [Skipping the current replication error](Appendix.MySQL.CommonDBATasks.md#Appendix.MySQL.CommonDBATasks.SkipError)\. Your MySQL or MariaDB DB instance must be running a version that includes the `mysql_rds_skip_repl_error` procedure\. For more information, see [mysql\.rds\_skip\_repl\_error](mysql-stored-proc-replicating.md#mysql_rds_skip_repl_error)\. -+ If you encounter a binary log \(binlog\) position issue, you can change the replica replay position with the `mysql_rds_next_master_log` command\. Your MySQL or MariaDB DB instance must be running a version that supports the `mysql_rds_next_master_log` command to change the replica replay position\. For version information, see [mysql\.rds\_next\_master\_log](mysql-stored-proc-replicating.md#mysql_rds_next_master_log)\. -+ You might encounter a temporary performance issue due to high DML load\. If so, you can set the `innodb_flush_log_at_trx_commit` parameter to 2 in the DB parameter group on the read replica\. Doing this can help the read replica catch up, though it temporarily reduces atomicity, consistency, isolation, and durability \(ACID\)\. -+ You can delete the read replica and create an instance using the same DB instance identifier\. If you do this, the endpoint remains the same as that of your old read replica\. - -If a replication error is fixed, the **Replication State** changes to **replicating**\. For more information, see [Troubleshooting a MySQL read replica problem](USER_MySQL.Replication.ReadReplicas.md#USER_ReadRepl.Troubleshooting)\. - -### Creating triggers with binary logging enabled requires SUPER privilege - -When trying to create triggers in an RDS for MySQL or RDS for MariaDB DB instance, you might receive the following error\. - -``` -"You do not have the SUPER privilege and binary logging is enabled" -``` - -To use triggers when binary logging is enabled requires the SUPER privilege, which is restricted for RDS for MySQL and RDS for MariaDB DB instances\. You can create triggers when binary logging is enabled without the SUPER privilege by setting the `log_bin_trust_function_creators` parameter to true\. To set the `log_bin_trust_function_creators` to true, create a new DB parameter group or modify an existing DB parameter group\. - -You can create a new DB parameter group so you can create triggers in your RDS for MySQL or RDS for MariaDB DB instance with binary logging enabled\. To do so, use the following CLI commands\. To modify an existing parameter group, start with step 2\. - -**To create a new parameter group to allow triggers with binary logging enabled using the CLI** - -1. Create a new parameter group\. - - For Linux, macOS, or Unix: - - ``` - aws rds create-db-parameter-group \ - --db-parameter-group-name allow-triggers \ - --db-parameter-group-family mysql8.0 \ - --description "parameter group allowing triggers" - ``` - - For Windows: - - ``` - aws rds create-db-parameter-group ^ - --db-parameter-group-name allow-triggers ^ - --db-parameter-group-family mysql8.0 ^ - --description "parameter group allowing triggers" - ``` - -1. Modify the DB parameter group to allow triggers\. - - For Linux, macOS, or Unix: - - ``` - aws rds modify-db-parameter-group \ - --db-parameter-group-name allow-triggers \ - --parameters "ParameterName=log_bin_trust_function_creators, ParameterValue=true, ApplyMethod=pending-reboot" - ``` - - For Windows: - - ``` - aws rds modify-db-parameter-group ^ - --db-parameter-group-name allow-triggers ^ - --parameters "ParameterName=log_bin_trust_function_creators, ParameterValue=true, ApplyMethod=pending-reboot" - ``` - -1. Modify your DB instance to use the new DB parameter group\. - - For Linux, macOS, or Unix: - - ``` - aws rds modify-db-instance \ - --db-instance-identifier mydbinstance \ - --db-parameter-group-name allow-triggers \ - --apply-immediately - ``` - - For Windows: - - ``` - aws rds modify-db-instance ^ - --db-instance-identifier mydbinstance ^ - --db-parameter-group-name allow-triggers ^ - --apply-immediately - ``` - -1. For the changes to take effect, manually reboot the DB instance\. - - ``` - aws rds reboot-db-instance --db-instance-identifier mydbinstance - ``` - -### Diagnosing and resolving point\-in\-time restore failures - -**Restoring a DB Instance That Includes Temporary Tables** - -When attempting a point\-in\-time restore \(PITR\) of your MySQL or MariaDB DB instance, you might encounter the following error\. - -``` -Database instance could not be restored because there has been incompatible database activity for restore -functionality. Common examples of incompatible activity include using temporary tables, in-memory tables, -or using MyISAM tables. In this case, use of Temporary table was detected. -``` - -PITR relies on both backup snapshots and binary logs \(binlogs\) from MySQL or MariaDB to restore your DB instance to a particular time\. Temporary table information can be unreliable in binlogs and can cause a PITR failure\. If you use temporary tables in your MySQL or MariaDB DB instance, you can lower the possibility of a PITR failure\. To do so, perform more frequent backups\. A PITR failure is most probable in the time between a temporary table's creation and the next backup snapshot\. - -**Restoring a DB Instance That Includes In\-Memory Tables** - -You might encounter a problem when restoring a database that has in\-memory tables\. In\-memory tables are purged during a restart\. As a result, your in\-memory tables might be empty after a reboot\. We recommend that when you use in\-memory tables, you architect your solution to handle empty tables in the event of a restart\. If you're using in\-memory tables with replicated DB instances, you might need to recreate the read replicas after a restart\. This might be necessary if a read replica reboots and can't restore data from an empty in\-memory table\. - -For more information about backups and PITR, see [Working with backups](USER_WorkingWithAutomatedBackups.md) and [Restoring a DB instance to a specified time](USER_PIT.md)\. - -### Replication stopped error - -When you call the `mysql.rds_skip_repl_error` command, you might receive an error message stating that replication is down or disabled\. - -This error message appears because replication is stopped and can't be restarted\. - -If you need to skip a large number of errors, the replication lag can increase beyond the default retention period for binary log files\. In this case, you might encounter a fatal error due to binary log files being purged before they have been replayed on the replica\. This purge causes replication to stop, and you can no longer call the `mysql.rds_skip_repl_error` command to skip replication errors\. - -You can mitigate this issue by increasing the number of hours that binary log files are retained on your replication source\. After you have increased the binlog retention time, you can restart replication and call the `mysql.rds_skip_repl_error` command as needed\. - -To set the binlog retention time, use the [mysql\.rds\_set\_configuration](mysql-stored-proc-configuring.md#mysql_rds_set_configuration) procedure\. Specify a configuration parameter of 'binlog retention hours' along with the number of hours to retain binlog files on the DB cluster, up to 720 \(30 days\)\. The following example sets the retention period for binlog files to 48 hours\. - -``` -CALL mysql.rds_set_configuration('binlog retention hours', 48); -``` - -### Read replica create fails or replication breaks with fatal error 1236 - -After changing default parameter values for a MySQL or MariaDB DB instance, you might encounter one of the following problems: -+ You can't create a read replica for the DB instance\. -+ Replication fails with `fatal error 1236`\. - -Some default parameter values for MySQL and MariaDB DB instances help to make sure that the database is ACID compliant and read replicas are crash\-safe\. They do this by making sure that each commit is fully synchronized by writing the transaction to the binary log before it's committed\. Changing these parameters from their default values to improve performance can cause replication to fail when a transaction hasn't been written to the binary log\. - -To resolve this issue, set the following parameter values: -+ `sync_binlog = 1` -+ `innodb_support_xa = 1` -+ `innodb_flush_log_at_trx_commit = 1` - -## Can't set backup retention period to 0 - -There are several reasons why you might need to set the backup retention period to 0\. For example, you can disable automatic backups immediately by setting the retention period to 0\. - -In some cases, you might set the value to 0 and receive a message saying that the retention period must be between 1 and 35\. In these cases, check to make sure that you haven't set up a read replica for the instance\. Read replicas require backups for managing read replica logs, and therefore you can't set a retention period of 0\. \ No newline at end of file diff --git a/doc_source/CHAP_Tutorials.CreateVPCDualStack.md b/doc_source/CHAP_Tutorials.CreateVPCDualStack.md deleted file mode 100644 index 379967a..0000000 --- a/doc_source/CHAP_Tutorials.CreateVPCDualStack.md +++ /dev/null @@ -1,287 +0,0 @@ -# Tutorial: Create a VPC for use with a DB instance \(dual\-stack mode\) - -A common scenario includes a DB instance in a virtual private cloud \(VPC\) based on the Amazon VPC service\. This VPC shares data with a public Amazon EC2 instance that is running in the same VPC\. - -For more information about IP addressing, see [Amazon RDS IP addressing](USER_VPC.WorkingWithRDSInstanceinaVPC.md#USER_VPC.IP_addressing)\. - -Dual\-stack network instances are supported in most regions\. For more information see [Region and version availability](USER_VPC.WorkingWithRDSInstanceinaVPC.md#USER_VPC.IP_addressing.RegionVersionAvailability)\. To see the limitations of dual\-stack mode, see [Limitations for dual\-stack network DB instances](USER_VPC.WorkingWithRDSInstanceinaVPC.md#USER_VPC.IP_addressing.dual-stack-limitations)\. - -In this tutorial, you create the VPC for this scenario that works with a database running in dual\-stack mode\. - -The following diagram shows this scenario\. - - - -![\[VPC scenario for dual-stack mode\]](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/images/con-VPC-sec-grp-dual-stack.png) - -For information about other scenarios, see [Scenarios for accessing a DB instance in a VPC](USER_VPC.Scenarios.md)\. - -Your DB instance needs to be available only to your Amazon EC2 instance, and not to the public internet\. Thus, you create a VPC with both public and private subnets\. The Amazon EC2 instance is hosted in the public subnet, so that it can reach the public internet\. The DB instance is hosted in a private subnet\. The Amazon EC2 instance can connect to the DB instance because it's hosted within the same VPC\. However, the DB instance is not available to the public internet, providing greater security\. - -This tutorial configures an additional public and private subnet in a separate Availability Zone\. These subnets aren't used by the tutorial\. An RDS DB subnet group requires a subnet in at least two Availability Zones\. The additional subnet makes it easy to switch to a Multi\-AZ DB instance deployment in the future\. - -To create a DB instance that uses dual\-stack mode, specify **Dual\-stack mode** for the **Network type** setting\. You can also modify a DB instance with the same setting\. For more information, see [Creating an Amazon RDS DB instance](USER_CreateDBInstance.md) and [Modifying an Amazon RDS DB instance](Overview.DBInstance.Modifying.md)\. - -This tutorial describes configuring a VPC for Amazon RDS DB instances\. For more information about Amazon VPC, see [Amazon VPC Getting Started Guide](https://docs.aws.amazon.com/AmazonVPC/latest/GettingStartedGuide/) and [Amazon VPC User Guide](https://docs.aws.amazon.com/vpc/latest/userguide/)\. - -## Create a VPC with private and public subnets - -Use the following procedure to create a VPC with both public and private subnets\. - -**To create a VPC and subnets** - -1. Open the Amazon VPC console at [https://console\.aws\.amazon\.com/vpc/](https://console.aws.amazon.com/vpc/)\. - -1. In the upper\-right corner of the AWS Management Console, choose the Region to create your VPC in\. This example uses the US East \(Ohio\) Region\. - -1. In the upper\-left corner, choose **VPC dashboard**\. To begin creating a VPC, choose **Create VPC**\. - -1. For **Resources to create** under **VPC settings**, choose **VPC and more**\. - -1. For the remaining **VPC settings**, set these values: - + **Name tag auto\-generation** – **tutorial\-dual\-stack** - + **IPv4 CIDR block** – **10\.0\.0\.0/16** - + **IPv6 CIDR block** – **Amazon\-provided IPv6 CIDR block** - + **Tenancy** – **Default** - + **Number of Availability Zones \(AZs\)** – **2** - + **Customize AZs** – Keep the default values\. - + **Number of public subnet** – **2** - + **Number of private subnets** – **2** - + **Customize subnets CIDR blocks** – Keep the default values\. - + **NAT gateways \($\)** – **None** - + **Egress only internet gateway** – **No** - + **VPC endpoints** – **None** - + **DNS options** – Keep the default values\. -**Note** -Amazon RDS requires at least two subnets in two different Availability Zones to support Multi\-AZ DB instance deployments\. This tutorial creates a Single\-AZ deployment, but the requirement makes it easy to convert to a Multi\-AZ DB instance deployment in the future\. - -1. Choose **Create VPC**\. - -## Create a VPC security group for a public Amazon EC2 instance - -Next, you create a security group for public access\. To connect to public EC2 instances in your VPC, add inbound rules to your VPC security group that allow traffic to connect from the internet\. - -**To create a VPC security group** - -1. Open the Amazon VPC console at [https://console\.aws\.amazon\.com/vpc/](https://console.aws.amazon.com/vpc/)\. - -1. Choose **VPC Dashboard**, choose **Security Groups**, and then choose **Create security group**\. - -1. On the **Create security group** page, set these values: - + **Security group name:** **tutorial\-dual\-stack\-securitygroup** - + **Description:** **Tutorial Dual\-Stack Security Group** - + **VPC:** Choose the VPC that you created earlier, for example: **vpc\-*identifier* \(tutorial\-dual\-stack\-vpc\)** - -1. Add inbound rules to the security group\. - - 1. Determine the IP address to use to connect to EC2 instances in your VPC using Secure Shell \(SSH\)\. - - To determine your public IP address, in a different browser window or tab use the service at [https://checkip\.amazonaws\.com](https://checkip.amazonaws.com)\. An example of an Internet Protocol version 4 \(IPv4\) address is `203.0.113.25/32`\. An example of an Internet Protocol version 6 \(IPv6\) address is `2001:DB8::/32`\. - - In many cases, you might connect through an internet service provider \(ISP\) or from behind your firewall without a static IP address\. If so, find the range of IP addresses used by client computers\. -**Warning** -If you use `0.0.0.0/0` for IPv4 or `::0` for IPv6, you make it possible for all IP addresses to access your public instances using SSH\. This approach is acceptable for a short time in a test environment, but it's unsafe for production environments\. In production, authorize only a specific IP address or range of addresses to access your instances\. - - 1. In the **Inbound rules** section, choose **Add rule**\. - - 1. Set the following values for your new inbound rule to allow Secure Shell \(SSH\) access to your Amazon EC2 instance\. If you do this, you can connect to your EC2 instance to install SQL clients and other applications\. Specify an IP address so you can access your EC2 instance: - + **Type:** **SSH** - + **Source:** The IP address or range from step a\. An example of an IPv4 IP address is **203\.0\.113\.25/32**\. An example of an IPv6 IP address is **2001:DB8::/32**\. - -1. Choose **Create security group** to create the security group\. - - Note the security group ID because you need it later in this tutorial\. - -## Create a VPC security group for a private DB instance - -To keep your DB instance private, create a second security group for private access\. To connect to private DB instances in your VPC, add inbound rules to your VPC security group\. These allow traffic from your Amazon EC2 instance only\. - -**To create a VPC security group** - -1. Open the Amazon VPC console at [https://console\.aws\.amazon\.com/vpc/](https://console.aws.amazon.com/vpc/)\. - -1. Choose **VPC Dashboard**, choose **Security Groups**, and then choose **Create security group**\. - -1. On the **Create security group** page, set these values: - + **Security group name:** **tutorial\-dual\-stack\-db\-securitygroup** - + **Description:** **Tutorial Dual\-Stack DB Instance Security Group** - + **VPC:** Choose the VPC that you created earlier, for example: **vpc\-*identifier* \(tutorial\-dual\-stack\-vpc\)** - -1. Add inbound rules to the security group: - - 1. In the **Inbound rules** section, choose **Add rule**\. - - 1. Set the following values for your new inbound rule to allow MySQL traffic on port 3306 from your Amazon EC2 instance\. If you do, you can connect from your EC2 instance to your DB instance\. Doing this means that you can store and retrieve data from your EC2 instance to your database\. - + **Type:** **MySQL/Aurora** - + **Source:** The identifier of the **tutorial\-dual\-stack\-securitygroup** security group that you created previously in this tutorial, for example **sg\-9edd5cfb**\. - -1. To create the security group, choose **Create security group**\. - -## Create a DB subnet group - -A *DB subnet group* is a collection of subnets that you create in a VPC and that you then designate for your DB instances\. By using a DB subnet group, you can specify a particular VPC when creating DB instances\. To create a DB subnet group that is `DUAL` compatible, all subnets must be `DUAL` compatible\. To be `DUAL` compatible, a subnet must have an IPv6 CIDR associated with it\. - -**To create a DB subnet group** - -1. Identify the private subnets for your database in the VPC\. - - 1. Open the Amazon VPC console at [https://console\.aws\.amazon\.com/vpc/](https://console.aws.amazon.com/vpc/)\. - - 1. Choose **VPC Dashboard**, and then choose **Subnets**\. - - 1. Note the subnet IDs of the subnets named **tutorial\-dual\-stack\-subnet\-private1\-us\-west\-2a** and **tutorial\-dual\-stack\-subnet\-private2\-us\-west\-2b**\. - - You will need the subnet IDs when you create your DB subnet group\. - -1. Open the Amazon RDS console at [https://console\.aws\.amazon\.com/rds/](https://console.aws.amazon.com/rds/)\. - - Make sure that you connect to the Amazon RDS console, not to the Amazon VPC console\. - -1. In the navigation pane, choose **Subnet groups**\. - -1. Choose **Create DB subnet group**\. - -1. On the **Create DB subnet group** page, set these values in **Subnet group details**: - + **Name:** **tutorial\-dual\-stack\-db\-subnet\-group** - + **Description:** **Tutorial Dual\-Stack DB Subnet Group** - + **VPC:** **tutorial\-dual\-stack\-vpc \(vpc\-*identifier*\)** - -1. In the **Add subnets** section, choose values for the **Availability Zones** and **Subnets** options\. - - For this tutorial, choose **us\-east\-2a** and **us\-east\-2b** for the **Availability Zones**\. For **Subnets**, choose the private subnets you identified in the previous step\. - -1. Choose **Create**\. - -Your new DB subnet group appears in the DB subnet groups list on the RDS console\. You can choose the DB subnet group to see its details\. These include the supported addressing protocols and all of the subnets associated with the group and the network type supported by the DB subnet group\. - -## Create an Amazon EC2 instance in dual\-stack mode - -To create an Amazon EC2 instance, follow the instructions in [Launch an instance using the new launch instance wizard](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-launch-instance-wizard.html) in the *Amazon EC2 User Guide for Linux Instances*\. - -On the **Configure Instance Details** page, set these values and keep the other values as their defaults: -+ **Network** – Choose the VPC with both public and private subnets that you chose for the DB instance, such as **vpc\-*identifier* \| tutorial\-dual\-stack\-vpc** created in [Create a VPC with private and public subnets](#CHAP_Tutorials.CreateVPCDualStack.VPCAndSubnets)\. -+ **Subnet** – Choose an existing public subnet, such as **subnet\-*identifier* \| tutorial\-dual\-stack\-subnet\-public1\-us\-east\-2a \| us\-east\-2a** created in [Create a VPC security group for a public Amazon EC2 instance](#CHAP_Tutorials.CreateVPCDualStack.SecurityGroupEC2)\. -+ **Auto\-assign Public IP** – Choose **Enable**\. -+ **Auto\-assign IPv6 IP** – Choose **Enable**\. -+ **Firewall \(security groups\)** – Choose **Select an existing security group**\. -+ **Common security groups** – Choose an existing security group, such as the `tutorial-securitygroup` created in [Create a VPC security group for a public Amazon EC2 instance](#CHAP_Tutorials.CreateVPCDualStack.SecurityGroupEC2)\. Make sure that the security group that you choose includes inbound rules for Secure Shell \(SSH\) and HTTP access\. - -## Create a DB instance in dual\-stack mode - -In this step, you create a DB instance that runs in dual\-stack mode\. - -**To create a DB instance** - -1. Sign in to the AWS Management Console and open the Amazon RDS console at [https://console\.aws\.amazon\.com/rds/](https://console.aws.amazon.com/rds/)\. - -1. In the upper\-right corner of the console, choose the AWS Region where you want to create the DB instance\. This example uses the US East \(Ohio\) Region\. - -1. In the navigation pane, choose **Databases**\. - -1. Choose **Create database**\. - -1. On the **Create database** page, make sure that the **Standard create** option is chosen, and then choose the MySQL DB engine type\. - -1. In the **Connectivity** section, set these values: - + **Network type** – Choose **Dual\-stack mode**\. -![\[Network type section in the console with Dual-stack mode selected\]](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/images/dual-stack-mode.png) - + **Virtual private cloud \(VPC\)** – Choose an existing VPC with both public and private subnets, such as **tutorial\-dual\-stack\-vpc** \(vpc\-*identifier*\) created in [Create a VPC with private and public subnets](#CHAP_Tutorials.CreateVPCDualStack.VPCAndSubnets)\. - - The VPC must have subnets in different Availability Zones\. - + **DB subnet group** – Choose a DB subnet group for the VPC, such as **tutorial\-dual\-stack\-db\-subnet\-group** created in [Create a DB subnet group](#CHAP_Tutorials.CreateVPCDualStack.DBSubnetGroup)\. - + **Public access** – Choose **No**\. - + **VPC security group \(firewall\)** – Select **Choose existing**\. - + **Existing VPC security groups** – Choose an existing VPC security group that is configured for private access, such as **tutorial\-dual\-stack\-db\-securitygroup** created in [ Create a VPC security group for a private DB instance](#CHAP_Tutorials.CreateVPCDualStack.SecurityGroupDB)\. - - Remove other security groups, such as the default security group, by choosing the **X** associated with each\. - + **Availability Zone** – Choose **us\-west\-2a**\. - - To avoid cross\-AZ traffic, make sure the DB instance and the EC2 instance are in the same Availability Zone\. - -1. For the remaining sections, specify your DB instance settings\. For information about each setting, see [Settings for DB instances](USER_CreateDBInstance.md#USER_CreateDBInstance.Settings)\. - -## Connect to your Amazon EC2 instance and DB instance - -After you create your Amazon EC2 instance and DB instance in dual\-stack mode, you can connect to each one using the IPv6 protocol\. To connect to an Amazon EC2 instance using the IPv6 protocol, follow the instructions in [Connect to your Linux instance](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/AccessingInstances.html) in the *Amazon EC2 User Guide for Linux Instances*\. - -To connect to your DB instance, follow the instructions in [Connecting to an Amazon RDS DB instance](CHAP_CommonTasks.Connect.md)\. - -## Deleting the VPC - -After you create the VPC and other resources for this tutorial, you can delete them if they are no longer needed\. - -If you added resources in the VPC that you created for this tutorial, you might need to delete these before you can delete the VPC\. Examples of resources are Amazon EC2 instances or DB instances\. For more information, see [Delete your VPC](https://docs.aws.amazon.com/vpc/latest/userguide/working-with-vpcs.html#VPC_Deleting) in the *Amazon VPC User Guide*\. - -**To delete a VPC and related resources** - -1. Delete the DB subnet group: - - 1. Open the Amazon RDS console at [https://console\.aws\.amazon\.com/rds/](https://console.aws.amazon.com/rds/)\. - - 1. In the navigation pane, choose **Subnet groups**\. - - 1. Select the DB subnet group to delete, such as **tutorial\-db\-subnet\-group**\. - - 1. Choose **Delete**, and then choose **Delete** in the confirmation window\. - -1. Note the VPC ID: - - 1. Open the Amazon VPC console at [https://console\.aws\.amazon\.com/vpc/](https://console.aws.amazon.com/vpc/)\. - - 1. Choose **VPC Dashboard**, and then choose **VPCs**\. - - 1. In the list, identify the VPC you created, such as **tutorial\-dual\-stack\-vpc**\. - - 1. Note the **VPC ID** value of the VPC that you created\. You need this VPC ID in subsequent steps\. - -1. Delete the security groups: - - 1. Open the Amazon VPC console at [https://console\.aws\.amazon\.com/vpc/](https://console.aws.amazon.com/vpc/)\. - - 1. Choose **VPC Dashboard**, and then choose **Security Groups**\. - - 1. Select the security group for the Amazon RDS DB instance, such as **tutorial\-dual\-stack\-db\-securitygroup**\. - - 1. For **Actions**, choose **Delete security groups**, and then choose **Delete** on the confirmation page\. - - 1. On the **Security Groups** page, select the security group for the Amazon EC2 instance, such as **tutorial\-dual\-stack\-securitygroup**\. - - 1. For **Actions**, choose **Delete security groups**, and then choose **Delete** on the confirmation page\. - -1. Delete the NAT gateway: - - 1. Open the Amazon VPC console at [https://console\.aws\.amazon\.com/vpc/](https://console.aws.amazon.com/vpc/)\. - - 1. Choose **VPC Dashboard**, and then choose **NAT Gateways**\. - - 1. Select the NAT gateway of the VPC that you created\. Use the VPC ID to identify the correct NAT gateway\. - - 1. For **Actions**, choose **Delete NAT gateway**\. - - 1. On the confirmation page, enter **delete**, and then choose **Delete**\. - -1. Delete the VPC: - - 1. Open the Amazon VPC console at [https://console\.aws\.amazon\.com/vpc/](https://console.aws.amazon.com/vpc/)\. - - 1. Choose **VPC Dashboard**, and then choose **VPCs**\. - - 1. Select the VPC that you want to delete, such as **tutorial\-dual\-stack\-vpc**\. - - 1. For **Actions**, choose **Delete VPC**\. - - The confirmation page shows other resources that are associated with the VPC that will also be deleted, including the subnets associated with it\. - - 1. On the confirmation page, enter **delete**, and then choose **Delete**\. - -1. Release the Elastic IP addresses: - - 1. Open the Amazon EC2 console at [https://console\.aws\.amazon\.com/ec2/](https://console.aws.amazon.com/ec2/)\. - - 1. Choose **EC2 Dashboard**, and then choose **Elastic IPs**\. - - 1. Select the Elastic IP address that you want to release\. - - 1. For **Actions**, choose **Release Elastic IP addresses**\. - - 1. On the confirmation page, choose **Release**\. \ No newline at end of file diff --git a/doc_source/CHAP_Tutorials.RestoringFromSnapshot.md b/doc_source/CHAP_Tutorials.RestoringFromSnapshot.md deleted file mode 100644 index fe12466..0000000 --- a/doc_source/CHAP_Tutorials.RestoringFromSnapshot.md +++ /dev/null @@ -1,72 +0,0 @@ -# Tutorial: Restore an Amazon RDS DB instance from a DB snapshot - -Often, when working with Amazon RDS you might have a DB instance that you work with occasionally but don't need full time\. For example, suppose that you have a quarterly customer survey that uses an Amazon EC2 instance to host a customer survey website\. You also have a DB instance that is used to store the survey results\. One way to save money on such a scenario is to take a DB snapshot of the DB instance after the survey is completed\. You then delete the DB instance and restore it when you need to conduct the survey again\. - -When you restore the DB instance, you provide the name of the DB snapshot to restore from\. You then provide a name for the new DB instance that's created from the restore operation\. - -For more detailed information on restoring DB instances from snapshots, see [Restoring from a DB snapshot](USER_RestoreFromSnapshot.md)\. - -## Restoring a DB instance from a DB snapshot - -Use the following procedure to restore from a snapshot in the AWS Management Console\. - -**To restore a DB instance from a DB snapshot** - -1. Sign in to the AWS Management Console and open the Amazon RDS console at [https://console\.aws\.amazon\.com/rds/](https://console.aws.amazon.com/rds/)\. - -1. In the navigation pane, choose **Snapshots**\. - -1. Choose the DB snapshot that you want to restore from\. - -1. For **Actions**, choose **Restore snapshot**\. -![\[Restore snapshot option in the Actions menu in the RDS console\]](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/images/tut-restore-instance1.png) - - The **Restore snapshot** page appears\. -![\[Restore snapshot page\]](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/images/tut-restore-instance2.png) - -1. Under **DB instance settings**, use the default settings for **DB engine** and **License model** \(for Oracle or Microsoft SQL Server\)\. - -1. Under **Settings**, for **DB instance identifier** enter the unique name that you want to use for the restored DB instance, for example **mynewdbinstance**\. - - If you're restoring from a DB instance that you deleted after you made the DB snapshot, you can use the name of that DB instance\. - -1. Under **Availability & durability**, choose whether to create a standby instance in another Availability Zone\. - - For this tutorial, don't create a standby instance\. - -1. Under **Connectivity**, use the default settings for the following: - + **Virtual private cloud \(VPC\)** - + **DB subnet group** - + **Public access** - + **VPC security group \(firewall\)** - -1. Choose the **DB instance class**\. - - For this tutorial, choose **Burstable classes \(includes t classes\)**, and then choose **db\.t3\.small**\. - -1. For **Encryption**, use the default settings\. - - If the source DB instance for the snapshot was encrypted, the restored DB instance is also encrypted\. You can't make it unencrypted\. - -1. Expand **Additional configuration** at the bottom of the page\. -![\[Additional configuration\]](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/images/tut-restore-instance3.png) - -1. Do the following under **Database options**: - - 1. Choose the **DB parameter group**\. - - For this tutorial, use the default parameter group\. - - 1. Choose the **Option group**\. - - For this tutorial, use the default option group\. -**Important** -In some cases, you might restore from a DB snapshot of a DB instance that uses a persistent or permanent option\. If so, make sure to choose an option group that uses the same option\. - - 1. For **Deletion protection**, choose the **Enable deletion protection** check box\. - -1. Choose **Restore DB instance**\. - -The **Databases** page displays the restored DB instance, with a status of `Creating`\. - -![\[Restored DB instance on the Databases page\]](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/images/tut-restore-instance4.png) \ No newline at end of file diff --git a/doc_source/CHAP_Tutorials.WebServerDB.CreateDBInstance.md b/doc_source/CHAP_Tutorials.WebServerDB.CreateDBInstance.md deleted file mode 100644 index 0d43280..0000000 --- a/doc_source/CHAP_Tutorials.WebServerDB.CreateDBInstance.md +++ /dev/null @@ -1,61 +0,0 @@ -# Create a DB instance - -Create an Amazon RDS for MySQL DB instance that maintains the data used by a web application\. - -**To create a MySQL DB instance** - -1. Sign in to the AWS Management Console and open the Amazon RDS console at [https://console\.aws\.amazon\.com/rds/](https://console.aws.amazon.com/rds/)\. - -1. In the upper\-right corner of the AWS Management Console, check the AWS Region\. It should be the same as the one where you created your EC2 instance\. - -1. In the navigation pane, choose **Databases**\. - -1. Choose **Create database**\. - -1. On the **Create database** page, choose **Standard create**\. - -1. For **Engine options**, choose **MySQL**\. - -1. For **Templates**, choose **Free tier**\. - - Your DB instance configuration should look similar to the following image\. -![\[Select engine type and template\]](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/images/tutorial-create-mysql.png) - -1. In the **Availability and durability** section, keep the defaults\. - -1. In the **Settings** section, set these values: - + **DB instance identifier** – Type **tutorial\-db\-instance**\. - + **Master username** – Type **tutorial\_user**\. - + **Auto generate a password** – Leave the option turned off\. - + **Master password** – Type a password\. - + **Confirm password** – Retype the password\. -![\[Settings sections\]](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/images/Tutorial_WebServer_Settings.png) - -1. In the **Instance configuration** section, set these values: - + **Burstable classes \(includes t classes\)** - + **db\.t3\.micro** -![\[Instance configuration section\]](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/images/Tutorial_WebServer_DB_instance_micro.png) - -1. In the **Storage** section, keep the defaults\. - -1. In the **Connectivity** section, set these values and keep the other values as their defaults: - + For **Compute resource**, choose **Connect to an EC2 compute resource**\. - + For **EC2 instance**, choose the EC2 instance you created previously, such as **tutorial\-ec2\-instance\-web\-server**\. -![\[Connectivity section\]](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/images/Tutorial_WebServer_Connectivity.png) - -1. In the **Database authentication** section, make sure **Password authentication** is selected\. - -1. Open the **Additional configuration** section, and enter **sample** for **Initial database name**\. Keep the default settings for the other options\. - -1. To create your MySQL DB instance, choose **Create database**\. - - Your new DB instance appears in the **Databases** list with the status **Creating**\. - -1. Wait for the **Status** of your new DB instance to show as **Available**\. Then choose the DB instance name to show its details\. - -1. In the **Connectivity & security** section, view the **Endpoint** and **Port** of the DB instance\. -![\[DB instance details\]](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/images/Tutorial_WebServer_Endpoint_Port.png) - - Note the endpoint and port for your DB instance\. You use this information to connect your web server to your DB instance\. - -1. Complete [Install a web server on your EC2 instance](CHAP_Tutorials.WebServerDB.CreateWebServer.md)\. \ No newline at end of file diff --git a/doc_source/CHAP_Tutorials.WebServerDB.CreateVPC.md b/doc_source/CHAP_Tutorials.WebServerDB.CreateVPC.md deleted file mode 100644 index ec882bb..0000000 --- a/doc_source/CHAP_Tutorials.WebServerDB.CreateVPC.md +++ /dev/null @@ -1,209 +0,0 @@ -# Tutorial: Create a VPC for use with a DB instance \(IPv4 only\) - -A common scenario includes a DB instance in a virtual private cloud \(VPC\) based on the Amazon VPC service\. This VPC shares data with a web server that is running in the same VPC\. In this tutorial, you create the VPC for this scenario\. - -The following diagram shows this scenario\. For information about other scenarios, see [Scenarios for accessing a DB instance in a VPC](USER_VPC.Scenarios.md)\. - -![\[Single VPC scenario\]](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/images/con-VPC-sec-grp.png) - -Your DB instance needs to be available only to your web server, and not to the public internet\. Thus, you create a VPC with both public and private subnets\. The web server is hosted in the public subnet, so that it can reach the public internet\. The DB instance is hosted in a private subnet\. The web server can connect to the DB instance because it is hosted within the same VPC\. But the DB instance isn't available to the public internet, providing greater security\. - -This tutorial configures an additional public and private subnet in a separate Availability Zone\. These subnets aren't used by the tutorial\. An RDS DB subnet group requires a subnet in at least two Availability Zones\. The additional subnet makes it easier to switch to a Multi\-AZ DB instance deployment in the future\. - -This tutorial describes configuring a VPC for Amazon RDS DB instances\. For a tutorial that shows you how to create a web server for this VPC scenario, see [Tutorial: Create a web server and an Amazon RDS DB instance](TUT_WebAppWithRDS.md)\. For more information about Amazon VPC, see [Amazon VPC Getting Started Guide](https://docs.aws.amazon.com/AmazonVPC/latest/GettingStartedGuide/) and [Amazon VPC User Guide](https://docs.aws.amazon.com/vpc/latest/userguide/)\. - -**Tip** -You can set up network connectivity between an Amazon EC2 instance and a DB instance automatically when you create the DB instance\. The network configuration is similar to the one described in this tutorial\. For more information, see [Configure automatic network connectivity with an EC2 instance](USER_CreateDBInstance.md#USER_CreateDBInstance.Prerequisites.VPC.Automatic)\. - -## Create a VPC with private and public subnets - -Use the following procedure to create a VPC with both public and private subnets\. - -**To create a VPC and subnets** - -1. Open the Amazon VPC console at [https://console\.aws\.amazon\.com/vpc/](https://console.aws.amazon.com/vpc/)\. - -1. In the top\-right corner of the AWS Management Console, choose the Region to create your VPC in\. This example uses the US West \(Oregon\) Region\. - -1. In the upper\-left corner, choose **VPC dashboard**\. To begin creating a VPC, choose **Create VPC**\. - -1. For **Resources to create** under **VPC settings**, choose **VPC and more**\. - -1. For the **VPC settings**, set these values: - + **Name tag auto\-generation** – **tutorial** - + **IPv4 CIDR block** – **10\.0\.0\.0/16** - + **IPv6 CIDR block** – **No IPv6 CIDR block** - + **Tenancy** – **Default** - + **Number of Availability Zones \(AZs\)** – **2** - + **Customize AZs** – Keep the default values\. - + **Number of public subnet** – **2** - + **Number of private subnets** – **2** - + **Customize subnets CIDR blocks** – Keep the default values\. - + **NAT gateways \($\)** – **None** - + **VPC endpoints** – **None** - + **DNS options** – Keep the default values\. -**Note** -Amazon RDS requires at least two subnets in two different Availability Zones to support Multi\-AZ DB instance deployments\. This tutorial creates a Single\-AZ deployment, but the requirement makes it easier to convert to a Multi\-AZ DB instance deployment in the future\. - -1. Choose **Create VPC**\. - -## Create a VPC security group for a public web server - -Next, you create a security group for public access\. To connect to public EC2 instances in your VPC, you add inbound rules to your VPC security group\. These allow traffic to connect from the internet\. - -**To create a VPC security group** - -1. Open the Amazon VPC console at [https://console\.aws\.amazon\.com/vpc/](https://console.aws.amazon.com/vpc/)\. - -1. Choose **VPC Dashboard**, choose **Security Groups**, and then choose **Create security group**\. - -1. On the **Create security group** page, set these values: - + **Security group name:** **tutorial\-securitygroup** - + **Description:** **Tutorial Security Group** - + **VPC:** Choose the VPC that you created earlier, for example: **vpc\-*identifier* \(tutorial\-vpc\)** - -1. Add inbound rules to the security group\. - - 1. Determine the IP address to use to connect to EC2 instances in your VPC using Secure Shell \(SSH\)\. To determine your public IP address, in a different browser window or tab, you can use the service at [https://checkip\.amazonaws\.com](https://checkip.amazonaws.com)\. An example of an IP address is `203.0.113.25/32`\. - - In many cases, you might connect through an internet service provider \(ISP\) or from behind your firewall without a static IP address\. If so, find the range of IP addresses used by client computers\. -**Warning** -If you use `0.0.0.0/0` for SSH access, you make it possible for all IP addresses to access your public instances using SSH\. This approach is acceptable for a short time in a test environment, but it's unsafe for production environments\. In production, authorize only a specific IP address or range of addresses to access your instances using SSH\. - - 1. In the **Inbound rules** section, choose **Add rule**\. - - 1. Set the following values for your new inbound rule to allow SSH access to your Amazon EC2 instance\. If you do this, you can connect to your Amazon EC2 instance to install the web server and other utilities\. You also connect to your EC2 instance to upload content for your web server\. - + **Type:** **SSH** - + **Source:** The IP address or range from Step a, for example: **203\.0\.113\.25/32**\. - - 1. Choose **Add rule**\. - - 1. Set the following values for your new inbound rule to allow HTTP access to your web server: - + **Type:** **HTTP** - + **Source:** **0\.0\.0\.0/0** - -1. Choose **Create security group** to create the security group\. - - Note the security group ID because you need it later in this tutorial\. - -## Create a VPC security group for a private DB instance - -To keep your DB instance private, create a second security group for private access\. To connect to private DB instancesin your VPC, you add inbound rules to your VPC security group that allow traffic from your web server only\. - -**To create a VPC security group** - -1. Open the Amazon VPC console at [https://console\.aws\.amazon\.com/vpc/](https://console.aws.amazon.com/vpc/)\. - -1. Choose **VPC Dashboard**, choose **Security Groups**, and then choose **Create security group**\. - -1. On the **Create security group** page, set these values: - + **Security group name:** **tutorial\-db\-securitygroup** - + **Description:** **Tutorial DB Instance Security Group** - + **VPC:** Choose the VPC that you created earlier, for example: **vpc\-*identifier* \(tutorial\-vpc\)** - -1. Add inbound rules to the security group\. - - 1. In the **Inbound rules** section, choose **Add rule**\. - - 1. Set the following values for your new inbound rule to allow MySQL traffic on port 3306 from your Amazon EC2 instance\. If you do this, you can connect from your web server to your DB instance\. By doing so, you can store and retrieve data from your web application to your database\. - + **Type:** **MySQL/Aurora** - + **Source:** The identifier of the **tutorial\-securitygroup** security group that you created previously in this tutorial, for example: **sg\-9edd5cfb**\. - -1. Choose **Create security group** to create the security group\. - -## Create a DB subnet group - -A *DB subnet group* is a collection of subnets that you create in a VPC and that you then designate for your DB instances\. A DB subnet group makes it possible for you to specify a particular VPC when creating DB instances\. - -**To create a DB subnet group** - -1. Identify the private subnets for your database in the VPC\. - - 1. Open the Amazon VPC console at [https://console\.aws\.amazon\.com/vpc/](https://console.aws.amazon.com/vpc/)\. - - 1. Choose **VPC Dashboard**, and then choose **Subnets**\. - - 1. Note the subnet IDs of the subnets named **tutorial\-subnet\-private1\-us\-west\-2a** and **tutorial\-subnet\-private2\-us\-west\-2b**\. - - You need the subnet IDs when you create your DB subnet group\. - -1. Open the Amazon RDS console at [https://console\.aws\.amazon\.com/rds/](https://console.aws.amazon.com/rds/)\. - - Make sure that you connect to the Amazon RDS console, not to the Amazon VPC console\. - -1. In the navigation pane, choose **Subnet groups**\. - -1. Choose **Create DB subnet group**\. - -1. On the **Create DB subnet group** page, set these values in **Subnet group details**: - + **Name:** **tutorial\-db\-subnet\-group** - + **Description:** **Tutorial DB Subnet Group** - + **VPC:** **tutorial\-vpc \(vpc\-*identifier*\)** - -1. In the **Add subnets** section, choose the **Availability Zones** and **Subnets**\. - - For this tutorial, choose **us\-west\-2a** and **us\-west\-2b** for the **Availability Zones**\. For **Subnets**, choose the private subnets you identified in the previous step\. - -1. Choose **Create**\. - - Your new DB subnet group appears in the DB subnet groups list on the RDS console\. You can choose the DB subnet group to see details in the details pane at the bottom of the window\. These details include all of the subnets associated with the group\. - -**Note** -If you created this VPC to complete [Tutorial: Create a web server and an Amazon RDS DB instance](TUT_WebAppWithRDS.md), create the DB instance by following the instructions in [Create a DB instance](CHAP_Tutorials.WebServerDB.CreateDBInstance.md)\. - -## Deleting the VPC - -After you create the VPC and other resources for this tutorial, you can delete them if they are no longer needed\. - -**Note** -If you added resources in the VPC that you created for this tutorial, you might need to delete these before you can delete the VPC\. For example, these resources might include Amazon EC2 instances or Amazon RDS DB instances\. For more information, see [Delete your VPC](https://docs.aws.amazon.com/vpc/latest/userguide/working-with-vpcs.html#VPC_Deleting) in the *Amazon VPC User Guide*\. - -**To delete a VPC and related resources** - -1. Delete the DB subnet group\. - - 1. Open the Amazon RDS console at [https://console\.aws\.amazon\.com/rds/](https://console.aws.amazon.com/rds/)\. - - 1. In the navigation pane, choose **Subnet groups**\. - - 1. Select the DB subnet group you want to delete, such as **tutorial\-db\-subnet\-group**\. - - 1. Choose **Delete**, and then choose **Delete** in the confirmation window\. - -1. Note the VPC ID\. - - 1. Open the Amazon VPC console at [https://console\.aws\.amazon\.com/vpc/](https://console.aws.amazon.com/vpc/)\. - - 1. Choose **VPC Dashboard**, and then choose **VPCs**\. - - 1. In the list, identify the VPC that you created, such as **tutorial\-vpc**\. - - 1. Note the **VPC ID** of the VPC that you created\. You need the VPC ID in later steps\. - -1. Delete the security groups\. - - 1. Open the Amazon VPC console at [https://console\.aws\.amazon\.com/vpc/](https://console.aws.amazon.com/vpc/)\. - - 1. Choose **VPC Dashboard**, and then choose **Security Groups**\. - - 1. Select the security group for the Amazon RDS DB instance, such as **tutorial\-db\-securitygroup**\. - - 1. For **Actions**, choose **Delete security groups**, and then choose **Delete** on the confirmation page\. - - 1. On the **Security Groups** page, select the security group for the Amazon EC2 instance, such as **tutorial\-securitygroup**\. - - 1. For **Actions**, choose **Delete security groups**, and then choose **Delete** on the confirmation page\. - -1. Delete the VPC\. - - 1. Open the Amazon VPC console at [https://console\.aws\.amazon\.com/vpc/](https://console.aws.amazon.com/vpc/)\. - - 1. Choose **VPC Dashboard**, and then choose **VPCs**\. - - 1. Select the VPC you want to delete, such as **tutorial\-vpc**\. - - 1. For **Actions**, choose **Delete VPC**\. - - The confirmation page shows other resources that are associated with the VPC that will also be deleted, including the subnets associated with it\. - - 1. On the confirmation page, enter **delete**, and then choose **Delete**\. \ No newline at end of file diff --git a/doc_source/CHAP_Tutorials.WebServerDB.CreateWebServer.md b/doc_source/CHAP_Tutorials.WebServerDB.CreateWebServer.md deleted file mode 100644 index 21e2e42..0000000 --- a/doc_source/CHAP_Tutorials.WebServerDB.CreateWebServer.md +++ /dev/null @@ -1,306 +0,0 @@ -# Install a web server on your EC2 instance - -Install a web server on the EC2 instance you created in [Launch an EC2 instance](CHAP_Tutorials.WebServerDB.LaunchEC2.md)\. The web server connects to the Amazon RDS DB instance that you created in [Create a DB instance](CHAP_Tutorials.WebServerDB.CreateDBInstance.md)\. - -## Install an Apache web server with PHP and MariaDB - -Connect to your EC2 instance and install the web server\. - -**To connect to your EC2 instance and install the Apache web server with PHP** - -1. Connect to the EC2 instance that you created earlier by following the steps in [Connect to your Linux instance](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/AccessingInstances.html) in the *Amazon EC2 User Guide for Linux Instances*\. - - We recommend that you connect to your EC2 instance using SSH\. If the SSH client utility is installed on Windows, Linux, or Mac, you can connect to the instance using the following command format: - - ``` - ssh -i location_of_pem_file ec2-user@ec2-instance-public-dns-name - ``` - - For example, assume that `ec2-database-connect-key-pair.pem` is stored in `/dir1` on Linux, and the public IPv4 DNS for your EC2 instance is `ec2-12-345-678-90.compute-1.amazonaws.com`\. Your SSH command would look as follows: - - ``` - ssh -i /dir1/ec2-database-connect-key-pair.pem ec2-user@ec2-12-345-678-90.compute-1.amazonaws.com - ``` - -1. Get the latest bug fixes and security updates by updating the software on your EC2 instance\. To do this, use the following command\. -**Note** -The `-y` option installs the updates without asking for confirmation\. To examine updates before installing, omit this option\. - - ``` - sudo dnf update -y - ``` - -1. After the updates complete, install the Apache web server, PHP, and MariaDB software using the following command\. This command installs multiple software packages and related dependencies at the same time\. - - ``` - sudo dnf install -y httpd php php-mysqli mariadb105 - ``` - - If you receive an error, your instance probably wasn't launched with an Amazon Linux 2023 AMI\. You might be using the Amazon Linux 2 AMI instead\. You can view your version of Amazon Linux using the following command\. - - ``` - cat /etc/system-release - ``` - - For more information, see [Updating instance software](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/install-updates.html)\. - -1. Start the web server with the command shown following\. - - ``` - sudo systemctl start httpd - ``` - - You can test that your web server is properly installed and started\. To do this, enter the public Domain Name System \(DNS\) name of your EC2 instance in the address bar of a web browser, for example: `http://ec2-42-8-168-21.us-west-1.compute.amazonaws.com`\. If your web server is running, then you see the Apache test page\. - - If you don't see the Apache test page, check your inbound rules for the VPC security group that you created in [Tutorial: Create a VPC for use with a DB instance \(IPv4 only\)](CHAP_Tutorials.WebServerDB.CreateVPC.md)\. Make sure that your inbound rules include one allowing HTTP \(port 80\) access for the IP address to connect to the web server\. -**Note** -The Apache test page appears only when there is no content in the document root directory, `/var/www/html`\. After you add content to the document root directory, your content appears at the public DNS address of your EC2 instance\. Before this point, it appears on the Apache test page\. - -1. Configure the web server to start with each system boot using the `systemctl` command\. - - ``` - sudo systemctl enable httpd - ``` - -To allow `ec2-user` to manage files in the default root directory for your Apache web server, modify the ownership and permissions of the `/var/www` directory\. There are many ways to accomplish this task\. In this tutorial, you add `ec2-user` to the `apache` group, to give the `apache` group ownership of the `/var/www` directory and assign write permissions to the group\. - -**To set file permissions for the Apache web server** - -1. Add the `ec2-user` user to the `apache` group\. - - ``` - sudo usermod -a -G apache ec2-user - ``` - -1. Log out to refresh your permissions and include the new `apache` group\. - - ``` - exit - ``` - -1. Log back in again and verify that the `apache` group exists with the `groups` command\. - - ``` - groups - ``` - - Your output looks similar to the following: - - ``` - ec2-user adm wheel apache systemd-journal - ``` - -1. Change the group ownership of the `/var/www` directory and its contents to the `apache` group\. - - ``` - sudo chown -R ec2-user:apache /var/www - ``` - -1. Change the directory permissions of `/var/www` and its subdirectories to add group write permissions and set the group ID on subdirectories created in the future\. - - ``` - sudo chmod 2775 /var/www - find /var/www -type d -exec sudo chmod 2775 {} \; - ``` - -1. Recursively change the permissions for files in the `/var/www` directory and its subdirectories to add group write permissions\. - - ``` - find /var/www -type f -exec sudo chmod 0664 {} \; - ``` - -Now, `ec2-user` \(and any future members of the `apache` group\) can add, delete, and edit files in the Apache document root\. This makes it possible for you to add content, such as a static website or a PHP application\. - -**Note** -A web server running the HTTP protocol provides no transport security for the data that it sends or receives\. When you connect to an HTTP server using a web browser, much information is visible to eavesdroppers anywhere along the network pathway\. This information includes the URLs that you visit, the content of web pages that you receive, and the contents \(including passwords\) of any HTML forms\. -The best practice for securing your web server is to install support for HTTPS \(HTTP Secure\)\. This protocol protects your data with SSL/TLS encryption\. For more information, see [ Tutorial: Configure SSL/TLS with the Amazon Linux AMI](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/SSL-on-amazon-linux-ami.html) in the *Amazon EC2 User Guide*\. - -## Connect your Apache web server to your DB instance - -Next, you add content to your Apache web server that connects to your Amazon RDS DB instance\. - -**To add content to the Apache web server that connects to your DB instance** - -1. While still connected to your EC2 instance, change the directory to `/var/www` and create a new subdirectory named `inc`\. - - ``` - cd /var/www - mkdir inc - cd inc - ``` - -1. Create a new file in the `inc` directory named `dbinfo.inc`, and then edit the file by calling nano \(or the editor of your choice\)\. - - ``` - >dbinfo.inc - nano dbinfo.inc - ``` - -1. Add the following contents to the `dbinfo.inc` file\. Here, *db\_instance\_endpoint* is your DB instance endpoint, without the port, and *master password* is the master password for your DB instance\. -**Note** -We recommend placing the user name and password information in a folder that isn't part of the document root for your web server\. Doing this reduces the possibility of your security information being exposed\. - - ``` - - ``` - -1. Save and close the `dbinfo.inc` file\. If you are using nano, save and close the file by using Ctrl\+S and Ctrl\+X\. - -1. Change the directory to `/var/www/html`\. - - ``` - cd /var/www/html - ``` - -1. Create a new file in the `html` directory named `SamplePage.php`, and then edit the file by calling nano \(or the editor of your choice\)\. - - ``` - >SamplePage.php - nano SamplePage.php - ``` - -1. Add the following contents to the `SamplePage.php` file: - - ``` - - - -

Sample page

- - - -
- - - - - - - - - - -
NAMEADDRESS
- - - - - -
-
- - - - - - - - - - "; - echo "", - "", - ""; - echo ""; - } - ?> - -
IDNAMEADDRESS
",$query_data[0], "",$query_data[1], "",$query_data[2], "
- - - - - - - - - Error adding employee data.

"); - } - - /* Check whether the table exists and, if not, create it. */ - function VerifyEmployeesTable($connection, $dbName) { - if(!TableExists("EMPLOYEES", $connection, $dbName)) - { - $query = "CREATE TABLE EMPLOYEES ( - ID int(11) UNSIGNED AUTO_INCREMENT PRIMARY KEY, - NAME VARCHAR(45), - ADDRESS VARCHAR(90) - )"; - - if(!mysqli_query($connection, $query)) echo("

Error creating table.

"); - } - } - - /* Check for the existence of a table. */ - function TableExists($tableName, $connection, $dbName) { - $t = mysqli_real_escape_string($connection, $tableName); - $d = mysqli_real_escape_string($connection, $dbName); - - $checktable = mysqli_query($connection, - "SELECT TABLE_NAME FROM information_schema.TABLES WHERE TABLE_NAME = '$t' AND TABLE_SCHEMA = '$d'"); - - if(mysqli_num_rows($checktable) > 0) return true; - - return false; - } - ?> - ``` - -1. Save and close the `SamplePage.php` file\. - -1. Verify that your web server successfully connects to your DB instance by opening a web browser and browsing to `http://EC2 instance endpoint/SamplePage.php`, for example: `http://ec2-55-122-41-31.us-west-2.compute.amazonaws.com/SamplePage.php`\. - -You can use `SamplePage.php` to add data to your DB instance\. The data that you add is then displayed on the page\. To verify that the data was inserted into the table, install MySQL client on the Amazon EC2 instance\. Then connect to the DB instance and query the table\. - -For information about installing the MySQL client and connecting to a DB instance, see [Connecting to a DB instance running the MySQL database engine](USER_ConnectToInstance.md)\. - -To make sure that your DB instance is as secure as possible, verify that sources outside of the VPC can't connect to your DB instance\. - -After you have finished testing your web server and your database, you should delete your DB instance and your Amazon EC2 instance\. -+ To delete a DB instance, follow the instructions in [Deleting a DB instance](USER_DeleteInstance.md)\. You don't need to create a final snapshot\. -+ To terminate an Amazon EC2 instance, follow the instruction in [Terminate your instance](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/terminating-instances.html) in the *Amazon EC2 User Guide*\. \ No newline at end of file diff --git a/doc_source/CHAP_Tutorials.WebServerDB.LaunchEC2.md b/doc_source/CHAP_Tutorials.WebServerDB.LaunchEC2.md deleted file mode 100644 index 7d67fb9..0000000 --- a/doc_source/CHAP_Tutorials.WebServerDB.LaunchEC2.md +++ /dev/null @@ -1,60 +0,0 @@ -# Launch an EC2 instance - -Create an Amazon EC2 instance in the public subnet of your VPC\. - -**To launch an EC2 instance** - -1. Sign in to the AWS Management Console and open the Amazon EC2 console at [https://console\.aws\.amazon\.com/ec2/](https://console.aws.amazon.com/ec2/)\. - -1. In the upper\-right corner of the AWS Management Console, choose the AWS Region where you want to create the EC2 instance\. - -1. Choose **EC2 Dashboard**, and then choose **Launch instance**, as shown following\. -![\[EC2 Dashboard\]](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/images/Tutorial_WebServer_11.png) - -1. Choose the following settings in the **Launch an instance** page\. - - 1. Under **Name and tags**, for **Name**, enter **tutorial\-ec2\-instance\-web\-server**\. - - 1. Under **Application and OS Images \(Amazon Machine Image\)**, choose **Amazon Linux**, and then choose the **Amazon Linux 2023 AMI**\. Keep the defaults for the other choices\. -![\[Choose an Amazon Machine Image\]](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/images/Tutorial_WebServer_12.png) - - 1. Under **Instance type**, choose **t2\.micro**\. - - 1. Under **Key pair \(login\)**, choose a **Key pair name** to use an existing key pair\. To create a new key pair for the Amazon EC2 instance, choose **Create new key pair** and then use the **Create key pair** window to create it\. - - For more information about creating a new key pair, see [Create a key pair](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/get-set-up-for-amazon-ec2.html#create-a-key-pair) in the *Amazon EC2 User Guide for Linux Instances*\. - - 1. Under **Network settings**, set these values and keep the other values as their defaults: - + For **Allow SSH traffic from**, choose the source of SSH connections to the EC2 instance\. - - You can choose **My IP** if the displayed IP address is correct for SSH connections\. - - Otherwise, you can determine the IP address to use to connect to EC2 instances in your VPC using Secure Shell \(SSH\)\. To determine your public IP address, in a different browser window or tab, you can use the service at [https://checkip\.amazonaws\.com](https://checkip.amazonaws.com)\. An example of an IP address is `203.0.113.25/32`\. - - In many cases, you might connect through an internet service provider \(ISP\) or from behind your firewall without a static IP address\. If so, make sure to determine the range of IP addresses used by client computers\. -**Warning** -If you use `0.0.0.0/0` for SSH access, you make it possible for all IP addresses to access your public instances using SSH\. This approach is acceptable for a short time in a test environment, but it's unsafe for production environments\. In production, authorize only a specific IP address or range of addresses to access your instances using SSH\. - + Turn on **Allow HTTPs traffic from the internet**\. - + Turn on **Allow HTTP traffic from the internet**\. -![\[Configure Instance Details\]](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/images/Tutorial_WebServer_14.png) - - 1. Leave the default values for the remaining sections\. - - 1. Review a summary of your instance configuration in the **Summary** panel, and when you're ready, choose **Launch instance**\. - -1. On the **Launch Status** page, note the identifier for your new EC2 instance, for example: `i-1234567890abcdef0`\. -![\[EC2 instance identifier on Launch Status page.\]](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/images/getting-started-ec2-id.png) - -1. Choose the EC2 instance identifier to open the list of EC2 instances, and then select your EC2 instance\. - -1. In the **Details** tab, note the following values, which you need when you connect using SSH: - - 1. In **Instance summary**, note the value for **Public IPv4 DNS**\. -![\[EC2 public DNS name on Details tab of Instances page.\]](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/images/easy-create-ec2-public-dns.png) - - 1. In **Instance details**, note the value for **Key pair name**\. -![\[EC2 key pair name on Details tab of Instance page.\]](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/images/easy-create-ec2-key-pair.png) - -1. Wait until **Instance state** for your instance is **Running** before continuing\. - -1. Complete [Create a DB instance](CHAP_Tutorials.WebServerDB.CreateDBInstance.md)\. \ No newline at end of file diff --git a/doc_source/CHAP_Tutorials.md b/doc_source/CHAP_Tutorials.md deleted file mode 100644 index 8d1e619..0000000 --- a/doc_source/CHAP_Tutorials.md +++ /dev/null @@ -1,109 +0,0 @@ -# Amazon RDS tutorials and sample code - -The AWS documentation includes several tutorials that guide you through common Amazon RDS use cases\. Many of these tutorials show you how to use Amazon RDS with other AWS services\. In addition, you can access sample code in GitHub\. - -**Note** -You can find more tutorials at the [AWS Database Blog](http://aws.amazon.com/blogs/database/)\. For information about training, see [AWS Training and Certification](https://www.aws.training/)\. - -**Topics** -+ [Tutorials in this guide](#CHAP_Tutorials.ThisGuide) -+ [Tutorials in other AWS guides](#CHAP_Tutorials.OtherGuides) -+ [AWS workshop and lab content portal for Amazon RDS PostgreSQL](#CHAP_Tutorials_postgreslabs) -+ [AWS workshop and lab content portal for Amazon RDS MySQL](#CHAP_Tutorials_sqllabs) -+ [Tutorials and sample code in GitHub](#CHAP_Tutorials.GitHub) -+ [Using this service with an AWS SDK](#sdk-general-information-section) - -## Tutorials in this guide - -The following tutorials in this guide show you how to perform common tasks with Amazon RDS: -+ [Tutorial: Create a VPC for use with a DB instance \(IPv4 only\)](CHAP_Tutorials.WebServerDB.CreateVPC.md) - - Learn how to include a DB instance in a virtual private cloud \(VPC\) based on the Amazon VPC service\. In this case, the VPC shares data with a web server that is running on an Amazon EC2 instance in the same VPC\. -+ [Tutorial: Create a VPC for use with a DB instance \(dual\-stack mode\)](CHAP_Tutorials.CreateVPCDualStack.md) - - Learn how to include a DB instance in a virtual private cloud \(VPC\) based on the Amazon VPC service\. In this case, the VPC shares data with an Amazon EC2 instance in the same VPC\. In this tutorial, you create the VPC for this scenario that works with a database running in dual\-stack mode\. -+ [Tutorial: Create a web server and an Amazon RDS DB instance](TUT_WebAppWithRDS.md) - - Learn how to install an Apache web server with PHP and create a MySQL database\. The web server runs on an Amazon EC2 instance using Amazon Linux, and the MySQL database is a MySQL DB instance\. Both the Amazon EC2 instance and the DB instance run in an Amazon VPC\. -+ [Tutorial: Restore an Amazon RDS DB instance from a DB snapshot](CHAP_Tutorials.RestoringFromSnapshot.md) - - Learn how to restore a DB instance from a DB snapshot\. -+ [Tutorial: Use tags to specify which DB instances to stop](USER_Tagging.md#Tagging.RDS.Autostop) - - Learn how to use tags to specify which DB instances to stop\. -+ [Tutorial: Log DB instance state changes using Amazon EventBridge](rds-cloud-watch-events.md#log-rds-instance-state) - - Learn how to log a DB instance state change using Amazon EventBridge and AWS Lambda\. -+ [Tutorial: Creating an Amazon CloudWatch alarm for Multi\-AZ DB cluster replica lag](multi-az-db-cluster-cloudwatch-alarm.md) - - Learn how to create a CloudWatch alarm that sends an Amazon SNS message when replica lag for a Multi\-AZ DB cluster has exceeded a threshold\. An alarm watches the `ReplicaLag` metric over a time period that you specify\. The action is a notification sent to an Amazon SNS topic or Amazon EC2 Auto Scaling policy\. - -## Tutorials in other AWS guides - -The following tutorials in other AWS guides show you how to perform common tasks with Amazon RDS: -+ [ Tutorial: Rotating a Secret for an AWS Database](https://docs.aws.amazon.com/secretsmanager/latest/userguide/tutorials_db-rotate.html) in the *AWS Secrets Manager User Guide* - - Learn how to create a secret for an AWS database and configure the secret to rotate on a schedule\. You trigger one rotation manually, and then confirm that the new version of the secret continues to provide access\. -+ [ Tutorial: Configuring a Lambda function to access Amazon RDS in an Amazon VPC](https://docs.aws.amazon.com/lambda/latest/dg/services-rds-tutorial.html) in the *AWS Lambda Developer Guide* - - Learn how to create a Lambda function to access a database, create a table, add a few records, and retrieve the records from the table\. You also learn how to invoke the Lambda function and verify the query results\. -+ [ Tutorials and samples](https://docs.aws.amazon.com/elasticbeanstalk/latest/dg/tutorials.html) in the *AWS Elastic Beanstalk Developer Guide* - - Learn how to deploy applications that use Amazon RDS databases with AWS Elastic Beanstalk\. -+ [ Using Data from an Amazon RDS Database to Create an Amazon ML Datasource](https://docs.aws.amazon.com/machine-learning/latest/dg/using-amazon-rds-with-amazon-ml.html) in the *Amazon Machine Learning Developer Guide* - - Learn how to create an Amazon Machine Learning \(Amazon ML\) datasource object from data stored in a MySQL DB instance\. -+ [ Manually Enabling Access to an Amazon RDS Instance in a VPC](https://docs.aws.amazon.com/quicksight/latest/user/rds-vpc-access.html) in the *Amazon QuickSight User Guide* - - Learn how to enable Amazon QuickSight access to an Amazon RDS DB instance in a VPC\. - -## AWS workshop and lab content portal for Amazon RDS PostgreSQL - -The below collection of workshops and other hands\-on content helps you to gain an understanding of the Amazon RDS PostgreSQL features and capabilities: -+ [ Creating a DB instance ](https://catalog.us-east-1.prod.workshops.aws/workshops/2a5fc82d-2b5f-4105-83c2-91a1b4d7abfe/en-US/2-foundation/lab1-create/task1) - - Learn how to create the DB instance\. -+ [ Performance Monitoring with RDS Tools ](https://catalog.us-east-1.prod.workshops.aws/workshops/31babd91-aa9a-4415-8ebf-ce0a6556a216/en-US/) - - Learn how to use AWS and SQL tools\(Cloudwatch, Enhanced Monitoring, Slow Query Logs, Performance Insights, PostgreSQL Catalog Views\) to understand performance issues and identify ways to improve performance of your database\. - -## AWS workshop and lab content portal for Amazon RDS MySQL - -The below collection of workshops and other hands\-on content helps you to gain an understanding of the Amazon RDS MySQL features and capabilities: -+ [ Creating a DB instance ](https://catalog.us-east-1.prod.workshops.aws/workshops/0135d1da-9f07-470c-9845-44ead3c78212/en-US/lab3/task1) - - Learn how to create the DB instance\. -+ [ Using Performance Insights ](https://catalog.us-east-1.prod.workshops.aws/workshops/0135d1da-9f07-470c-9845-44ead3c78212/en-US/lab8) - - Learn how to monitor and tune your DB instance using Performance insights\. - -## Tutorials and sample code in GitHub - -The following tutorials and sample code in GitHub show you how to perform common tasks with Amazon RDS: -+ [ Creating the Amazon Relational Database Service item tracker](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/javav2/usecases/Creating_rds_item_tracker) - - Learn how to create an application that tracks and reports on work items\. This application uses Amazon RDS, Amazon Simple Email Service, Elastic Beanstalk, and SDK for Java 2\.x\. - -## Using this service with an AWS SDK - -AWS software development kits \(SDKs\) are available for many popular programming languages\. Each SDK provides an API, code examples, and documentation that make it easier for developers to build applications in their preferred language\. - - -| SDK documentation | Code examples | -| --- | --- | -| [AWS SDK for C\+\+](https://docs.aws.amazon.com/sdk-for-cpp) | [AWS SDK for C\+\+ code examples](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/cpp) | -| [AWS SDK for Go](https://docs.aws.amazon.com/sdk-for-go) | [AWS SDK for Go code examples](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/gov2) | -| [AWS SDK for Java](https://docs.aws.amazon.com/sdk-for-java) | [AWS SDK for Java code examples](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/javav2) | -| [AWS SDK for JavaScript](https://docs.aws.amazon.com/sdk-for-javascript) | [AWS SDK for JavaScript code examples](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/javascriptv3) | -| [AWS SDK for Kotlin](https://docs.aws.amazon.com/sdk-for-kotlin) | [AWS SDK for Kotlin code examples](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/kotlin) | -| [AWS SDK for \.NET](https://docs.aws.amazon.com/sdk-for-net) | [AWS SDK for \.NET code examples](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/dotnetv3) | -| [AWS SDK for PHP](https://docs.aws.amazon.com/sdk-for-php) | [AWS SDK for PHP code examples](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/php) | -| [AWS SDK for Python \(Boto3\)](https://docs.aws.amazon.com/pythonsdk) | [AWS SDK for Python \(Boto3\) code examples](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/python) | -| [AWS SDK for Ruby](https://docs.aws.amazon.com/sdk-for-ruby) | [AWS SDK for Ruby code examples](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/ruby) | -| [AWS SDK for Rust](https://docs.aws.amazon.com/sdk-for-rust) | [AWS SDK for Rust code examples](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/rust_dev_preview) | -| [AWS SDK for Swift](https://docs.aws.amazon.com/sdk-for-swift) | [AWS SDK for Swift code examples](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/swift) | - -For examples specific to this service, see [Code examples for Amazon RDS using AWS SDKs](service_code_examples.md)\. - -**Example availability** -Can't find what you need? Request a code example by using the **Provide feedback** link at the bottom of this page\. \ No newline at end of file diff --git a/doc_source/Concepts.DBInstanceClass.md b/doc_source/Concepts.DBInstanceClass.md deleted file mode 100644 index 161d58d..0000000 --- a/doc_source/Concepts.DBInstanceClass.md +++ /dev/null @@ -1,1123 +0,0 @@ -# DB instance classes - -The DB instance class determines the computation and memory capacity of an Amazon RDS DB instance\. The DB instance class that you need depends on your processing power and memory requirements\. - -A DB instance class consists of both the DB instance class type and the size\. For example, db\.r6g is a memory\-optimized DB instance class type powered by AWS Graviton2 processors\. Within the db\.r6g instance class type, db\.r6g\.2xlarge is a DB instance class\. The size of this class is 2xlarge\. - -For more information about instance class pricing, see [Amazon RDS pricing](https://aws.amazon.com/rds/pricing/)\. - -**Topics** -+ [DB instance class types](#Concepts.DBInstanceClass.Types) -+ [Supported DB engines for DB instance classes](#Concepts.DBInstanceClass.Support) -+ [Determining DB instance class support in AWS Regions](#Concepts.DBInstanceClass.RegionSupport) -+ [Changing your DB instance class](#Concepts.DBInstanceClass.Changing) -+ [Configuring the processor for a DB instance class](#USER_ConfigureProcessor) -+ [Hardware specifications for DB instance classes](#Concepts.DBInstanceClass.Summary) - -## DB instance class types - -Amazon RDS supports DB instance classes for the following use cases: -+ [General\-purpose](#Concepts.DBInstanceClass.Types.general-purpose) -+ [Memory\-optimized](#Concepts.DBInstanceClass.Types.memory) -+ [Burstable\-performance](#Concepts.DBInstanceClass.Types.burstable) - - For more information about Amazon EC2 instance types, see [Instance types](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-types.html) in the Amazon EC2 documentation\. - -### General\-purpose instance class types - -The following general\-purpose DB instance class types are available: -+ **db\.m7g** – General\-purpose DB instance classes powered by AWS Graviton3 processors\. These instance classes deliver balanced compute, memory, and networking for a broad range of general\-purpose workloads\. - - You can modify a DB instance to use one of the DB instance classes powered by AWS Graviton3 processors\. To do so, complete the same steps as with any other DB instance modification\. -+ **db\.m6g** – General\-purpose DB instance classes powered by AWS Graviton2 processors\. These instance classes deliver balanced compute, memory, and networking for a broad range of general\-purpose workloads\. The db\.m6gd instance class types have local NVMe\-based SSD block\-level storage for applications that need high\-speed, low latency local storage\. - - You can modify a DB instance to use one of the DB instance classes powered by AWS Graviton2 processors\. To do so, complete the same steps as with any other DB instance modification\. -+ **db\.m6i** – General\-purpose DB instance classes that are well suited for a broad range of general\-purpose workloads\. -+ **db\.m5d** – General\-purpose DB instance classes that are optimized for low latency, very high random I/O performance, and high sequential read throughput\. -+ **db\.m5** –General\-purpose DB instance classes that provide a balance of compute, memory, and network resources, and are a good choice for many applications\. The db\.m5 instance classes provide more computing capacity than the previous db\.m4 instance classes\. They are powered by the AWS Nitro System, a combination of dedicated hardware and lightweight hypervisor\. -+ **db\.m4** – General\-purpose DB instance classes that provide more computing capacity than the previous db\.m3 instance classes\. - - For the RDS for Oracle DB engines, Amazon RDS no longer supports db\.m4 DB instance classes\. If you had previously created RDS for Oracle db\.m4 DB instances, Amazon RDS automatically upgrades those DB instances to equivalent db\.m5 DB instance classes\. -+ **db\.m3** – General\-purpose DB instance classes that provide more computing capacity than the previous db\.m1 instance classes\. - - For the RDS for MariaDB, RDS for MySQL, and RDS for PostgreSQL DB engines, Amazon RDS has started the end\-of\-life process for db\.m3 DB instance classes using the following schedule, which includes upgrade recommendations\. For all RDS DB instances that use db\.m3 DB instance classes, we recommend that you upgrade to a db\.m5 DB instance class as soon as possible\. -[\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Concepts.DBInstanceClass.html) - -### Memory\-optimized instance class types - -The memory\-optimized Z family supports the following instance class type: -+ **db\.z1d** – Instance classes optimized for memory\-intensive applications\. These instance classes offer both high compute capacity and a high memory footprint\. High frequency z1d instances deliver a sustained all\-core frequency of up to 4\.0 GHz\. - -The memory\-optimized X family supports the following instance class types: -+ **db\.x2g** – Instance classes optimized for memory\-intensive applications and powered by AWS Graviton2 processors\. These instance classes offer low cost per GiB of memory\. - - You can modify a DB instance to use one of the DB instance classes powered by AWS Graviton2 processors\. To do so, complete the same steps as with any other DB instance modification\. -+ **db\.x2i** – Instance classes optimized for memory\-intensive applications\. The **db\.x2iedn** and **db\.x2idn** classes are powered by third\-generation Intel Xeon Scalable processors \(Ice Lake\)\. They include up to 3\.8 TB of local NVMe SSD storage, up to 100 Gbps of networking bandwidth, and up to 4 TiB \(db\.x2iden\) or 2 TiB \(db\.x2idn\) of memory\. The **db\.x2iezn** class is powered by second\-generation Intel Xeon Scalable processors \(Cascade Lake\) with an all\-core turbo frequency of up to 4\.5 GHz and up to 1\.5 TiB of memory\. -+ **db\.x1** – Instance classes optimized for memory\-intensive applications\. These instance classes offer one of the lowest price per GiB of RAM among the DB instance classes and up to 1,952 GiB of DRAM\-based instance memory\. The **db\.x1e** type offers up to 3,904 GiB of DRAM\-based instance memory\. - -The memory\-optimized R family supports the following instance class types: -+ **db\.r7g** – Instance classes powered by AWS Graviton3 processors\. These instance classes are ideal for running memory\-intensive workloads in open\-source databases such as MySQL and PostgreSQL\. - - You can modify a DB instance to use one of the DB instance classes powered by AWS Graviton3 processors\. To do so, complete the same steps as with any other DB instance modification\. -+ **db\.r6g** – Instance classes powered by AWS Graviton2 processors\. These instance classes are ideal for running memory\-intensive workloads in open\-source databases such as MySQL and PostgreSQL\. The **db\.r6gd** type offers local NVMe\-based SSD block\-level storage for applications that need high\-speed, low latency local storage\. - - You can modify a DB instance to use one of the DB instance classes powered by AWS Graviton2 processors\. To do so, complete the same steps as with any other DB instance modification\. -+ **db\.r6i** – Instance classes that are ideal for running memory\-intensive workloads\. -+ **db\.r5b** – Instance classes that are memory\-optimized for throughput\-intensive applications\. Powered by the AWS Nitro System, db\.r5b instances deliver up to 60 Gbps bandwidth and 260,000 IOPS of EBS performance\. This is the fastest block storage performance on EC2\. -+ **db\.r5d** – Instance classes that are optimized for low latency, very high random I/O performance, and high sequential read throughput\. -+ **db\.r5** – Instance classes optimized for memory\-intensive applications\. These instance classes offer improved networking performance\. They are powered by the AWS Nitro System, a combination of dedicated hardware and lightweight hypervisor\. -+ **db\.r4** – Instance classes that provide improved networking over previous db\.r3 instance classes\. - - For the RDS for Oracle DB engines, Amazon RDS has started the end\-of\-life process for db\.r4 DB instance classes using the following schedule, which includes upgrade recommendations\. For RDS for Oracle DB instances that use db\.r4 instance classes, we recommend that you upgrade to a db\.r5 instance class as soon as possible\. -[\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Concepts.DBInstanceClass.html) -+ **db\.r3** – Instance classes that provide memory optimization\. - - For the RDS for MariaDB, RDS for MySQL, and RDS for PostgreSQL DB engines, Amazon RDS has started the end\-of\-life process for db\.r3 DB instance classes using the following schedule, which includes upgrade recommendations\. For all RDS DB instances that use db\.r3 DB instance classes, we recommend that you upgrade to a db\.r5 DB instance class as soon as possible\. -[\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Concepts.DBInstanceClass.html) - -### Burstable\-performance instance class types - -The following burstable\-performance DB instance class types are available: -+ **db\.t4g** – General\-purpose instance classes powered by Arm\-based AWS Graviton2 processors\. These instance classes deliver better price performance than previous burstable\-performance DB instance classes for a broad set of burstable general\-purpose workloads\. Amazon RDS T4g instances are configured for Unlimited mode\. This means that they can burst beyond the baseline over a 24\-hour window for an additional charge\. - - You can modify a DB instance to use one of the DB instance classes powered by AWS Graviton2 processors\. To do so, complete the same steps as with any other DB instance modification\. -+ **db\.t3** – Instance classes that provide a baseline performance level, with the ability to burst to full CPU usage\. T3 instances are configured for Unlimited mode\. These instance classes provide more computing capacity than the previous db\.t2 instance classes\. They are powered by the AWS Nitro System, a combination of dedicated hardware and lightweight hypervisor\. -+ **db\.t2** – Instance classes that provide a baseline performance level, with the ability to burst to full CPU usage\. We recommend using these instance classes only for development and test servers, or other non\-production servers\. - -**Note** -The DB instance classes that use the AWS Nitro System \(db\.m5, db\.r5, db\.t3\) are throttled on combined read plus write workload\. - -For DB instance class hardware specifications, see [Hardware specifications for DB instance classes](#Concepts.DBInstanceClass.Summary)\. - -## Supported DB engines for DB instance classes - -The following are DB engine–specific considerations for DB instance classes: - -**Microsoft SQL Server** -DB instance class support varies according to the version and edition of SQL Server\. For instance class support by version and edition, see [DB instance class support for Microsoft SQL Server](CHAP_SQLServer.md#SQLServer.Concepts.General.InstanceClasses)\. - -**Oracle** -DB instance class support varies according to the Oracle Database version and edition\. RDS for Oracle supports additional memory\-optimized instance classes\. These classes have names of the form db\.r5\.*instance\_size*\.tpc*threads\_per\_core*\.mem*ratio*\. For the vCPU count and memory allocation for each optimized class, see [Supported RDS for Oracle instance classes](Oracle.Concepts.InstanceClasses.md#Oracle.Concepts.InstanceClasses.Supported)\. - -In the following table, you can find details about supported Amazon RDS DB instance classes for each Amazon RDS DB engine\. Amazon RDS periodically deprecates major and minor versions\. For information about current supported versions, see topics for the individual DB engines: [MariaDB versions](MariaDB.Concepts.VersionMgmt.md#MariaDB.Concepts.VersionMgmt.Supported), [Microsoft SQL Server versions](CHAP_SQLServer.md#SQLServer.Concepts.General.VersionSupport), [MySQL versions](MySQL.Concepts.VersionMgmt.md), [Oracle versions](Oracle.Concepts.database-versions.md), and [PostgreSQL versions](CHAP_PostgreSQL.md#PostgreSQL.Concepts.General.DBVersions)\. - - -**** - -| Instance class | MariaDB | Microsoft SQL Server | MySQL | Oracle | PostgreSQL | -| --- | --- | --- | --- | --- | --- | -| db\.m7g – general\-purpose instance classes powered by AWS Graviton3 processors | -| db\.m7g\.16xlarge | MariaDB 10\.6\.10 and higher 10\.6 versions, MariaDB 10\.5\.17 and higher 10\.5 versions, and MariaDB 10\.4\.26 and higher 10\.4 versions | No | MySQL 8\.0\.28 and higher | No | PostgreSQL 15\.2 and higher 15 versions, PostgreSQL 14\.5 and higher 14 versions, and PostgreSQL 13\.4 and higher 13 versions | -| db\.m7g\.12xlarge | MariaDB 10\.6\.10 and higher 10\.6 versions, MariaDB 10\.5\.17 and higher 10\.5 versions, and MariaDB 10\.4\.26 and higher 10\.4 versions | No | MySQL 8\.0\.28 and higher | No | PostgreSQL 15\.2 and higher 15 versions, PostgreSQL 14\.5 and higher 14 versions, and PostgreSQL 13\.4 and higher 13 versions | -| db\.m7g\.8xlarge | MariaDB 10\.6\.10 and higher 10\.6 versions, MariaDB 10\.5\.17 and higher 10\.5 versions, and MariaDB 10\.4\.26 and higher 10\.4 versions | No | MySQL 8\.0\.28 and higher | No | PostgreSQL 15\.2 and higher 15 versions, PostgreSQL 14\.5 and higher 14 versions, and PostgreSQL 13\.4 and higher 13 versions | -| db\.m7g\.4xlarge | MariaDB 10\.6\.10 and higher 10\.6 versions, MariaDB 10\.5\.17 and higher 10\.5 versions, and MariaDB 10\.4\.26 and higher 10\.4 versions | No | MySQL 8\.0\.28 and higher | No | PostgreSQL 15\.2 and higher 15 versions, PostgreSQL 14\.5 and higher 14 versions, and PostgreSQL 13\.4 and higher 13 versions | -| db\.m7g\.2xlarge | MariaDB 10\.6\.10 and higher 10\.6 versions, MariaDB 10\.5\.17 and higher 10\.5 versions, and MariaDB 10\.4\.26 and higher 10\.4 versions | No | MySQL 8\.0\.28 and higher | No | PostgreSQL 15\.2 and higher 15 versions, PostgreSQL 14\.5 and higher 14 versions, and PostgreSQL 13\.4 and higher 13 versions | -| db\.m7g\.xlarge | MariaDB 10\.6\.10 and higher 10\.6 versions, MariaDB 10\.5\.17 and higher 10\.5 versions, and MariaDB 10\.4\.26 and higher 10\.4 versions | No | MySQL 8\.0\.28 and higher | No | PostgreSQL 15\.2 and higher 15 versions, PostgreSQL 14\.5 and higher 14 versions, and PostgreSQL 13\.4 and higher 13 versions | -| db\.m7g\.large | MariaDB 10\.6\.10 and higher 10\.6 versions, MariaDB 10\.5\.17 and higher 10\.5 versions, and MariaDB 10\.4\.26 and higher 10\.4 versions | No | MySQL 8\.0\.28 and higher | No | PostgreSQL 15\.2 and higher 15 versions, PostgreSQL 14\.5 and higher 14 versions, and PostgreSQL 13\.4 and higher 13 versions | -| db\.m6g – general\-purpose instance classes powered by AWS Graviton2 processors | -| db\.m6g\.16xlarge | All MariaDB 10\.6 versions, all MariaDB 10\.5 versions, and all MariaDB 10\.4 versions | No | MySQL 8\.0\.23 and higher | No | All PostgreSQL 15 versions, all PostgreSQL 14 versions, all PostgreSQL 13 versions, PostgreSQL 12\.7 and higher | -| db\.m6g\.12xlarge | All MariaDB 10\.6 versions, all MariaDB 10\.5 versions, and all MariaDB 10\.4 versions | No | MySQL 8\.0\.23 and higher | No | All PostgreSQL 15 versions, all PostgreSQL 14 versions, all PostgreSQL 13 versions, PostgreSQL 12\.7 and higher | -| db\.m6g\.8xlarge | All MariaDB 10\.6 versions, all MariaDB 10\.5 versions, and all MariaDB 10\.4 versions | No | MySQL 8\.0\.23 and higher | No | All PostgreSQL 15 versions, all PostgreSQL 14 versions, all PostgreSQL 13 versions, PostgreSQL 12\.7 and higher | -| db\.m6g\.4xlarge | All MariaDB 10\.6 versions, all MariaDB 10\.5 versions, and all MariaDB 10\.4 versions | No | MySQL 8\.0\.23 and higher | No | All PostgreSQL 15 versions, all PostgreSQL 14 versions, all PostgreSQL 13 versions, PostgreSQL 12\.7 and higher | -| db\.m6g\.2xlarge | All MariaDB 10\.6 versions, all MariaDB 10\.5 versions, and all MariaDB 10\.4 versions | No | MySQL 8\.0\.23 and higher | No | All PostgreSQL 15 versions, all PostgreSQL 14 versions, all PostgreSQL 13 versions, PostgreSQL 12\.7 and higher | -| db\.m6g\.xlarge | All MariaDB 10\.6 versions, all MariaDB 10\.5 versions, and all MariaDB 10\.4 versions | No | MySQL 8\.0\.23 and higher | No | All PostgreSQL 15 versions, all PostgreSQL 14 versions, all PostgreSQL 13 versions, PostgreSQL 12\.7 and higher | -| db\.m6g\.large | All MariaDB 10\.6 versions, all MariaDB 10\.5 versions, and all MariaDB 10\.4 versions | No | MySQL 8\.0\.23 and higher | No | All PostgreSQL 15 versions, all PostgreSQL 14 versions, all PostgreSQL 13 versions, PostgreSQL 12\.7 and higher | -| db\.m6gd – general\-purpose instance classes powered by AWS Graviton2 processors | -| db\.m6gd\.16xlarge | MariaDB version 10\.6\.7 and higher 10\.6 versions, MariaDB version 10\.5\.16 and higher 10\.5 versions, and MariaDB version 10\.4\.25 and higher 10\.4 versions | No | MySQL 8\.0\.28 and higher | No | All PostgreSQL 15 versions, all PostgreSQL 14 versions, PostgreSQL 13\.4 and PostgreSQL 13\.7 and higher 13 versions | -| db\.m6gd\.12xlarge | MariaDB version 10\.6\.7 and higher 10\.6 versions, MariaDB version 10\.5\.16 and higher 10\.5 versions, and MariaDB version 10\.4\.25 and higher 10\.4 versions | No | MySQL 8\.0\.28 and higher | No | All PostgreSQL 15 versions, all PostgreSQL 14 versions, PostgreSQL 13\.4 and PostgreSQL 13\.7 and higher 13 versions | -| db\.m6gd\.8xlarge | MariaDB version 10\.6\.7 and higher 10\.6 versions, MariaDB version 10\.5\.16 and higher 10\.5 versions, and MariaDB version 10\.4\.25 and higher 10\.4 versions | No | MySQL 8\.0\.28 and higher | No | All PostgreSQL 15 versions, all PostgreSQL 14 versions, PostgreSQL 13\.4 and PostgreSQL 13\.7 and higher 13 versions | -| db\.m6gd\.4xlarge | MariaDB version 10\.6\.7 and higher 10\.6 versions, MariaDB version 10\.5\.16 and higher 10\.5 versions, and MariaDB version 10\.4\.25 and higher 10\.4 versions | No | MySQL 8\.0\.28 and higher | No | All PostgreSQL 15 versions, all PostgreSQL 14 versions, PostgreSQL 13\.4 and PostgreSQL 13\.7 and higher 13 versions | -| db\.m6gd\.2xlarge | MariaDB version 10\.6\.7 and higher 10\.6 versions, MariaDB version 10\.5\.16 and higher 10\.5 versions, and MariaDB version 10\.4\.25 and higher 10\.4 versions | No | MySQL 8\.0\.28 and higher | No | All PostgreSQL 15 versions, all PostgreSQL 14 versions, PostgreSQL 13\.4 and PostgreSQL 13\.7 and higher 13 versions | -| db\.m6gd\.xlarge | MariaDB version 10\.6\.7 and higher 10\.6 versions, MariaDB version 10\.5\.16 and higher 10\.5 versions, and MariaDB version 10\.4\.25 and higher 10\.4 versions | No | MySQL 8\.0\.28 and higher | No | All PostgreSQL 15 versions, all PostgreSQL 14 versions, PostgreSQL 13\.4 and PostgreSQL 13\.7 and higher 13 versions | -| db\.m6gd\.large | MariaDB version 10\.6\.7 and higher 10\.6 versions, MariaDB version 10\.5\.16 and higher 10\.5 versions, and MariaDB version 10\.4\.25 and higher 10\.4 versions | No | MySQL 8\.0\.28 and higher | No | All PostgreSQL 15 versions, all PostgreSQL 14 versions, PostgreSQL 13\.4 and PostgreSQL 13\.7 and higher 13 versions | -| db\.m6i – general\-purpose instance classes | -| db\.m6i\.32xlarge | MariaDB version 10\.6\.7 and higher 10\.6 versions, MariaDB version 10\.5\.15 and higher 10\.5 versions, and MariaDB version 10\.4\.24 and higher 10\.4 versions | Yes | MySQL version 8\.0\.28 and higher | Oracle Database 19c | All PostgreSQL 15 versions, all PostgreSQL 14 versions; PostgreSQL 13\.4, 12\.8, 11\.13 and higher | -| db\.m6i\.24xlarge | MariaDB version 10\.6\.7 and higher 10\.6 versions, MariaDB version 10\.5\.15 and higher 10\.5 versions, and MariaDB version 10\.4\.24 and higher 10\.4 versions | Yes | MySQL version 8\.0\.28 and higher | Oracle Database 19c | All PostgreSQL 15 versions, all PostgreSQL 14 versions; PostgreSQL 13\.4, 12\.8, 11\.13 and higher | -| db\.m6i\.16xlarge | MariaDB version 10\.6\.7 and higher 10\.6 versions, MariaDB version 10\.5\.15 and higher 10\.5 versions, and MariaDB version 10\.4\.24 and higher 10\.4 versions | Yes | MySQL version 8\.0\.28 and higher | Oracle Database 19c | All PostgreSQL 15 versions, all PostgreSQL 14 versions; PostgreSQL 13\.4, 12\.8, 11\.13 and higher | -| db\.m6i\.12xlarge | MariaDB version 10\.6\.7 and higher 10\.6 versions, MariaDB version 10\.5\.15 and higher 10\.5 versions, and MariaDB version 10\.4\.24 and higher 10\.4 versions | Yes | MySQL version 8\.0\.28 and higher | Oracle Database 19c | All PostgreSQL 15 versions, all PostgreSQL 14 versions; PostgreSQL 13\.4, 12\.8, 11\.13 and higher | -| db\.m6i\.8xlarge | MariaDB version 10\.6\.7 and higher 10\.6 versions, MariaDB version 10\.5\.15 and higher 10\.5 versions, and MariaDB version 10\.4\.24 and higher 10\.4 versions | Yes | MySQL version 8\.0\.28 and higher | Oracle Database 19c | All PostgreSQL 15 versions, all PostgreSQL 14 versions; PostgreSQL 13\.4, 12\.8, 11\.13 and higher | -| db\.m6i\.4xlarge | MariaDB version 10\.6\.7 and higher 10\.6 versions, MariaDB version 10\.5\.15 and higher 10\.5 versions, and MariaDB version 10\.4\.24 and higher 10\.4 versions | Yes | MySQL version 8\.0\.28 and higher | Oracle Database 19c | All PostgreSQL 15 versions, all PostgreSQL 14 versions; PostgreSQL 13\.4, 12\.8, 11\.13 and higher | -| db\.m6i\.2xlarge | MariaDB version 10\.6\.7 and higher 10\.6 versions, MariaDB version 10\.5\.15 and higher 10\.5 versions, and MariaDB version 10\.4\.24 and higher 10\.4 versions | Yes | MySQL version 8\.0\.28 and higher | Oracle Database 19c | All PostgreSQL 15 versions, all PostgreSQL 14 versions; PostgreSQL 13\.4, 12\.8, 11\.13 and higher | -| db\.m6i\.xlarge | MariaDB version 10\.6\.7 and higher 10\.6 versions, MariaDB version 10\.5\.15 and higher 10\.5 versions, and MariaDB version 10\.4\.24 and higher 10\.4 versions | Yes | MySQL version 8\.0\.28 and higher | Oracle Database 19c | All PostgreSQL 15 versions, all PostgreSQL 14 versions; PostgreSQL 13\.4, 12\.8, 11\.13 and higher | -| db\.m6i\.large | MariaDB version 10\.6\.7 and higher 10\.6 versions, MariaDB version 10\.5\.15 and higher 10\.5 versions, and MariaDB version 10\.4\.24 and higher 10\.4 versions | Yes | MySQL version 8\.0\.28 and higher | Oracle Database 19c | All PostgreSQL 15 versions, all PostgreSQL 14 versions; PostgreSQL 13\.4, 12\.8, 11\.13 and higher | -| db\.m5d – general\-purpose instance classes | -| db\.m5d\.24xlarge | MariaDB version 10\.6\.7 and higher 10\.6 versions, MariaDB version 10\.5\.16 and higher 10\.5 versions, and MariaDB version 10\.4\.25 and higher 10\.4 versions | Yes | MySQL 8\.0\.28 and higher | Yes | All PostgreSQL 15 versions, PostgreSQL 14\.5 and higher 14 versions, PostgreSQL 13\.4, and PostgreSQL 13\.7 and higher 13 versions | -| db\.m5d\.16xlarge | MariaDB version 10\.6\.7 and higher 10\.6 versions, MariaDB version 10\.5\.16 and higher 10\.5 versions, and MariaDB version 10\.4\.25 and higher 10\.4 versions | Yes | MySQL 8\.0\.28 and higher | Yes | All PostgreSQL 15 versions, PostgreSQL 14\.5 and higher 14 versions, PostgreSQL 13\.4, and PostgreSQL 13\.7 and higher 13 versions | -| db\.m5d\.12xlarge | MariaDB version 10\.6\.7 and higher 10\.6 versions, MariaDB version 10\.5\.16 and higher 10\.5 versions, and MariaDB version 10\.4\.25 and higher 10\.4 versions | Yes | MySQL 8\.0\.28 and higher | Yes | All PostgreSQL 15 versions, PostgreSQL 14\.5 and higher 14 versions, PostgreSQL 13\.4, and PostgreSQL 13\.7 and higher 13 versions | -| db\.m5d\.8xlarge | MariaDB version 10\.6\.7 and higher 10\.6 versions, MariaDB version 10\.5\.16 and higher 10\.5 versions, and MariaDB version 10\.4\.25 and higher 10\.4 versions | Yes | MySQL 8\.0\.28 and higher | Yes | All PostgreSQL 15 versions, PostgreSQL 14\.5 and higher 14 versions, PostgreSQL 13\.4, and PostgreSQL 13\.7 and higher 13 versions | -| db\.m5d\.4xlarge | MariaDB version 10\.6\.7 and higher 10\.6 versions, MariaDB version 10\.5\.16 and higher 10\.5 versions, and MariaDB version 10\.4\.25 and higher 10\.4 versions | Yes | MySQL 8\.0\.28 and higher | Yes | All PostgreSQL 15 versions, PostgreSQL 14\.5 and higher 14 versions, PostgreSQL 13\.4, and PostgreSQL 13\.7 and higher 13 versions | -| db\.m5d\.2xlarge | MariaDB version 10\.6\.7 and higher 10\.6 versions, MariaDB version 10\.5\.16 and higher 10\.5 versions, and MariaDB version 10\.4\.25 and higher 10\.4 versions | Yes | MySQL 8\.0\.28 and higher | Yes | All PostgreSQL 15 versions, PostgreSQL 14\.5 and higher 14 versions, PostgreSQL 13\.4, and PostgreSQL 13\.7 and higher 13 versions | -| db\.m5d\.xlarge | MariaDB version 10\.6\.7 and higher 10\.6 versions, MariaDB version 10\.5\.16 and higher 10\.5 versions, and MariaDB version 10\.4\.25 and higher 10\.4 versions | Yes | MySQL 8\.0\.28 and higher | Yes | All PostgreSQL 15 versions, PostgreSQL 14\.5 and higher 14 versions, PostgreSQL 13\.4, and PostgreSQL 13\.7 and higher 13 versions | -| db\.m5d\.large | MariaDB version 10\.6\.7 and higher 10\.6 versions, MariaDB version 10\.5\.16 and higher 10\.5 versions, and MariaDB version 10\.4\.25 and higher 10\.4 versions | Yes | MySQL 8\.0\.28 and higher | Yes | All PostgreSQL 15 versions, PostgreSQL 14\.5 and higher 14 versions, PostgreSQL 13\.4, and PostgreSQL 13\.7 and higher 13 versions | -| db\.m5 – general\-purpose instance classes | -| db\.m5\.24xlarge | Yes | Yes | Yes | Yes | All PostgreSQL 15, 14, 13, 12, and 11 versions; 10\.17 and higher; 9\.6\.22 and higher | -| db\.m5\.16xlarge | Yes | Yes | Yes | Yes | All PostgreSQL 15, 14, 13, 12, and 11 versions; 10\.17 and higher; 9\.6\.22 and higher | -| db\.m5\.12xlarge | Yes | Yes | Yes | Yes | All PostgreSQL 15, 14, 13, 12, and 11 versions; 10\.17 and higher; 9\.6\.22 and higher | -| db\.m5\.8xlarge | Yes | Yes | Yes | Yes | All PostgreSQL 15, 14, 13, 12, and 11 versions; 10\.17 and higher; 9\.6\.22 and higher | -| db\.m5\.4xlarge | Yes | Yes | Yes | Yes | All PostgreSQL 15, 14, 13, 12, and 11 versions; 10\.17 and higher; 9\.6\.22 and higher | -| db\.m5\.2xlarge | Yes | Yes | Yes | Yes | All PostgreSQL 15, 14, 13, 12, and 11 versions; 10\.17 and higher; 9\.6\.22 and higher | -| db\.m5\.xlarge | Yes | Yes | Yes | Yes | All PostgreSQL 15, 14, 13, 12, and 11 versions; 10\.17 and higher; 9\.6\.22 and higher | -| db\.m5\.large | Yes | Yes | Yes | Yes | All PostgreSQL 15, 14, 13, 12, and 11 versions; 10\.17 and higher; 9\.6\.22 and higher | -| db\.m4 – general\-purpose instance classes | -| db\.m4\.16xlarge | Yes | Yes | MySQL 8\.0, 5\.7 | Deprecated | Lower than PostgreSQL 13 | -| db\.m4\.10xlarge | Yes | Yes | Yes | Deprecated | Lower than PostgreSQL 13 | -| db\.m4\.4xlarge | Yes | Yes | Yes | Deprecated | Lower than PostgreSQL 13 | -| db\.m4\.2xlarge | Yes | Yes | Yes | Deprecated | Lower than PostgreSQL 13 | -| db\.m4\.xlarge | Yes | Yes | Yes | Deprecated | Lower than PostgreSQL 13 | -| db\.m4\.large | Yes | Yes | Yes | Deprecated | Lower than PostgreSQL 13 | -| db\.m3 – general\-purpose instance classes | -| db\.m3\.2xlarge | No | Yes | Yes | Deprecated | Deprecated | -| db\.m3\.xlarge | No | Yes | Yes | Deprecated | Deprecated | -| db\.m3\.large | No | Yes | Yes | Deprecated | Deprecated | -| db\.m3\.medium | No | Yes | Yes | Deprecated | Deprecated | -| db\.x2g – memory\-optimized instance classes powered by AWS Graviton2 processors | -| db\.x2g\.16xlarge | All MariaDB 10\.6 versions, all MariaDB 10\.5 versions, and all MariaDB 10\.4 versions | No | MySQL 8\.0\.25 and higher | No | All PostgreSQL 15 versions, all PostgreSQL 14 versions, all PostgreSQL 13 versions; PostgreSQL 12\.7 and higher | -| db\.x2g\.12xlarge | All MariaDB 10\.6 versions, all MariaDB 10\.5 versions, and all MariaDB 10\.4 versions | No | MySQL 8\.0\.25 and higher | No | All PostgreSQL 15 versions, all PostgreSQL 14 versions, all PostgreSQL 13 versions; PostgreSQL 12\.7 and higher | -| db\.x2g\.8xlarge | All MariaDB 10\.6 versions, all MariaDB 10\.5 versions, and all MariaDB 10\.4 versions | No | MySQL 8\.0\.25 and higher | No | All PostgreSQL 15 versions, all PostgreSQL 14 versions, all PostgreSQL 13 versions; PostgreSQL 12\.7 and higher | -| db\.x2g\.4xlarge | All MariaDB 10\.6 versions, all MariaDB 10\.5 versions, and all MariaDB 10\.4 versions | No | MySQL 8\.0\.25 and higher | No | All PostgreSQL 15 versions, all PostgreSQL 14 versions, all PostgreSQL 13 versions; PostgreSQL 12\.7 and higher | -| db\.x2g\.2xlarge | All MariaDB 10\.6 versions, all MariaDB 10\.5 versions, and all MariaDB 10\.4 versions | No | MySQL 8\.0\.25 and higher | No | All PostgreSQL 15 versions, all PostgreSQL 14 versions, all PostgreSQL 13 versions; PostgreSQL 12\.7 and higher | -| db\.x2g\.xlarge | All MariaDB 10\.6 versions, all MariaDB 10\.5 versions, and all MariaDB 10\.4 versions | No | MySQL 8\.0\.25 and higher | No | All PostgreSQL 15 versions, all PostgreSQL 14 versions, all PostgreSQL 13 versions; PostgreSQL 12\.7 and higher | -| db\.x2g\.large | All MariaDB 10\.6 versions, all MariaDB 10\.5 versions, and all MariaDB 10\.4 versions | No | MySQL 8\.0\.25 and higher | No | All PostgreSQL 15 versions, all PostgreSQL 14 versions, all PostgreSQL 13 versions; PostgreSQL 12\.7 and higher | -| db\.x2idn – memory\-optimized instance classes powered by 3rd generation Intel Xeon Scalable processors | -| db\.x2idn\.32xlarge | MariaDB version 10\.6\.7 and higher 10\.6 versions, MariaDB version 10\.5\.16 and higher 10\.5 versions, and MariaDB version 10\.4\.25 and higher 10\.4 versions | No | MySQL 8\.0\.28 and higher | Enterprise Edition only | All PostgreSQL 15 versions, PostgreSQL 14\.6 and 13\.9 versions\. | -| db\.x2idn\.24xlarge | MariaDB version 10\.6\.7 and higher 10\.6 versions, MariaDB version 10\.5\.16 and higher 10\.5 versions, and MariaDB version 10\.4\.25 and higher 10\.4 versions | No | MySQL 8\.0\.28 and higher | Enterprise Edition only | All PostgreSQL 15 versions, PostgreSQL 14\.6 and 13\.9 versions\. | -| db\.x2idn\.16xlarge | MariaDB version 10\.6\.7 and higher 10\.6 versions, MariaDB version 10\.5\.16 and higher 10\.5 versions, and MariaDB version 10\.4\.25 and higher 10\.4 versions | No | MySQL 8\.0\.28 and higher | Enterprise Edition only | All PostgreSQL 15 versions, PostgreSQL 14\.6 and 13\.9 versions\. | -| db\.x2iedn – memory\-optimized instance classes with local NVMe\-based SSDs, powered by 3rd generation Intel Xeon Scalable processors | -| db\.x2iedn\.32xlarge | MariaDB version 10\.6\.7 and higher 10\.6 versions, MariaDB version 10\.5\.16 and higher 10\.5 versions, and MariaDB version 10\.4\.25 and higher 10\.4 versions | No | MySQL 8\.0\.28 and higher | Enterprise Edition only | All PostgreSQL 15 versions, PostgreSQL 14\.5 and higher 14 versions, PostgreSQL 13\.4, and PostgreSQL 13\.7 and higher 13 versions | -| db\.x2iedn\.24xlarge | MariaDB version 10\.6\.7 and higher 10\.6 versions, MariaDB version 10\.5\.16 and higher 10\.5 versions, and MariaDB version 10\.4\.25 and higher 10\.4 versions | No | MySQL 8\.0\.28 and higher | Enterprise Edition only | All PostgreSQL 15 versions, PostgreSQL 14\.5 and higher 14 versions, PostgreSQL 13\.4, and PostgreSQL 13\.7 and higher 13 versions | -| db\.x2iedn\.16xlarge | MariaDB version 10\.6\.7 and higher 10\.6 versions, MariaDB version 10\.5\.16 and higher 10\.5 versions, and MariaDB version 10\.4\.25 and higher 10\.4 versions | No | MySQL 8\.0\.28 and higher | Enterprise Edition only | All PostgreSQL 15 versions, PostgreSQL 14\.5 and higher 14 versions, PostgreSQL 13\.4, and PostgreSQL 13\.7 and higher 13 versions | -| db\.x2iedn\.8xlarge | MariaDB version 10\.6\.7 and higher 10\.6 versions, MariaDB version 10\.5\.16 and higher 10\.5 versions, and MariaDB version 10\.4\.25 and higher 10\.4 versions | No | MySQL 8\.0\.28 and higher | Enterprise Edition only | All PostgreSQL 15 versions, PostgreSQL 14\.5 and higher 14 versions, PostgreSQL 13\.4, and PostgreSQL 13\.7 and higher 13 versions | -| db\.x2iedn\.4xlarge | MariaDB version 10\.6\.7 and higher 10\.6 versions, MariaDB version 10\.5\.16 and higher 10\.5 versions, and MariaDB version 10\.4\.25 and higher 10\.4 versions | No | MySQL 8\.0\.28 and higher | Enterprise Edition and Standard Edition 2 \(SE2\) | All PostgreSQL 15 versions, PostgreSQL 14\.5 and higher 14 versions, PostgreSQL 13\.4, and PostgreSQL 13\.7 and higher 13 versions | -| db\.x2iedn\.2xlarge | MariaDB version 10\.6\.7 and higher 10\.6 versions, MariaDB version 10\.5\.16 and higher 10\.5 versions, and MariaDB version 10\.4\.25 and higher 10\.4 versions | No | MySQL 8\.0\.28 and higher | Enterprise Edition and Standard Edition 2 \(SE2\) | All PostgreSQL 15 versions, PostgreSQL 14\.5 and higher 14 versions, PostgreSQL 13\.4, and PostgreSQL 13\.7 and higher 13 versions | -| db\.x2iedn\.xlarge | MariaDB version 10\.6\.7 and higher 10\.6 versions, MariaDB version 10\.5\.16 and higher 10\.5 versions, and MariaDB version 10\.4\.25 and higher 10\.4 versions | No | MySQL 8\.0\.28 and higher | Enterprise Edition and Standard Edition 2 \(SE2\) | All PostgreSQL 15 versions, PostgreSQL 14\.5 and higher 14 versions, PostgreSQL 13\.4, and PostgreSQL 13\.7 and higher 13 versions | -| db\.x2iezn – memory\-optimized instance classes powered by 2nd generation Intel Xeon Scalable processors | -| db\.x2iezn\.12xlarge | No | No | No | Enterprise Edition only | No | -| db\.x2iezn\.8xlarge | No | No | No | Enterprise Edition only | No | -| db\.x2iezn\.6xlarge | No | No | No | Enterprise Edition only | No | -| db\.x2iezn\.4xlarge | No | No | No | Enterprise Edition and Standard Edition 2 \(SE2\) | No | -| db\.x2iezn\.2xlarge | No | No | No | Enterprise Edition and Standard Edition 2 \(SE2\) | No | -| db\.z1d – memory\-optimized instance classes | -| db\.z1d\.12xlarge | No | Yes | No | Yes | No | -| db\.z1d\.6xlarge | No | Yes | No | Yes | No | -| db\.z1d\.3xlarge | No | Yes | No | Yes | No | -| db\.z1d\.2xlarge | No | Yes | No | Yes | No | -| db\.z1d\.xlarge | No | Yes | No | Yes | No | -| db\.z1d\.large | No | Yes | No | Yes | No | -| db\.x1e – memory\-optimized instance classes | -| db\.x1e\.32xlarge | No | Yes | No | Yes | No | -| db\.x1e\.16xlarge | No | Yes | No | Yes | No | -| db\.x1e\.8xlarge | No | Yes | No | Yes | No | -| db\.x1e\.4xlarge | No | Yes | No | Yes | No | -| db\.x1e\.2xlarge | No | Yes | No | Yes | No | -| db\.x1e\.xlarge | No | Yes | No | Yes | No | -| db\.x1 – memory\-optimized instance classes | -| db\.x1\.32xlarge | No | Yes | No | Yes | No | -| db\.x1\.16xlarge | No | Yes | No | Yes | No | -| db\.r7g – memory\-optimized instance classes powered by AWS Graviton3 processors | -| db\.r7g\.16xlarge | MariaDB 10\.6\.10 and higher 10\.6 versions, MariaDB 10\.5\.17 and higher 10\.5 versions, and MariaDB 10\.4\.26 and higher 10\.4 versions | No | MySQL 8\.0\.28 and higher | No | PostgreSQL 15\.2 and higher 15 versions, PostgreSQL 14\.5 and higher 14 versions, and PostgreSQL 13\.4 and higher 13 versions | -| db\.r7g\.12xlarge | MariaDB 10\.6\.10 and higher 10\.6 versions, MariaDB 10\.5\.17 and higher 10\.5 versions, and MariaDB 10\.4\.26 and higher 10\.4 versions | No | MySQL 8\.0\.28 and higher | No | PostgreSQL 15\.2 and higher 15 versions, PostgreSQL 14\.5 and higher 14 versions, and PostgreSQL 13\.4 and higher 13 versions | -| db\.r7g\.8xlarge | MariaDB 10\.6\.10 and higher 10\.6 versions, MariaDB 10\.5\.17 and higher 10\.5 versions, and MariaDB 10\.4\.26 and higher 10\.4 versions | No | MySQL 8\.0\.28 and higher | No | PostgreSQL 15\.2 and higher 15 versions, PostgreSQL 14\.5 and higher 14 versions, and PostgreSQL 13\.4 and higher 13 versions | -| db\.r7g\.4xlarge | MariaDB 10\.6\.10 and higher 10\.6 versions, MariaDB 10\.5\.17 and higher 10\.5 versions, and MariaDB 10\.4\.26 and higher 10\.4 versions | No | MySQL 8\.0\.28 and higher | No | PostgreSQL 15\.2 and higher 15 versions, PostgreSQL 14\.5 and higher 14 versions, and PostgreSQL 13\.4 and higher 13 versions | -| db\.r7g\.2xlarge | MariaDB 10\.6\.10 and higher 10\.6 versions, MariaDB 10\.5\.17 and higher 10\.5 versions, and MariaDB 10\.4\.26 and higher 10\.4 versions | No | MySQL 8\.0\.28 and higher | No | PostgreSQL 15\.2 and higher 15 versions, PostgreSQL 14\.5 and higher 14 versions, and PostgreSQL 13\.4 and higher 13 versions | -| db\.r7g\.xlarge | MariaDB 10\.6\.10 and higher 10\.6 versions, MariaDB 10\.5\.17 and higher 10\.5 versions, and MariaDB 10\.4\.26 and higher 10\.4 versions | No | MySQL 8\.0\.28 and higher | No | PostgreSQL 15\.2 and higher 15 versions, PostgreSQL 14\.5 and higher 14 versions, and PostgreSQL 13\.4 and higher 13 versions | -| db\.r7g\.large | MariaDB 10\.6\.10 and higher 10\.6 versions, MariaDB 10\.5\.17 and higher 10\.5 versions, and MariaDB 10\.4\.26 and higher 10\.4 versions | No | MySQL 8\.0\.28 and higher | No | PostgreSQL 15\.2 and higher 15 versions, PostgreSQL 14\.5 and higher 14 versions, and PostgreSQL 13\.4 and higher 13 versions | -| db\.r6g – memory\-optimized instance classes powered by AWS Graviton2 processors | -| db\.r6g\.16xlarge | All MariaDB 10\.6 versions, all MariaDB 10\.5 versions, and all MariaDB 10\.4 versions | No | MySQL 8\.0\.23 and higher | No | All PostgreSQL 15 versions, all PostgreSQL 14 versions, all PostgreSQL 13 versions; PostgreSQL 12\.7 and higher | -| db\.r6g\.12xlarge | All MariaDB 10\.6 versions, all MariaDB 10\.5 versions, and all MariaDB 10\.4 versions | No | MySQL 8\.0\.23 and higher | No | All PostgreSQL 15 versions, all PostgreSQL 14 versions, all PostgreSQL 13 versions; PostgreSQL 12\.7 and higher | -| db\.r6g\.8xlarge | All MariaDB 10\.6 versions, all MariaDB 10\.5 versions, and all MariaDB 10\.4 versions | No | MySQL 8\.0\.23 and higher | No | All PostgreSQL 15 versions, all PostgreSQL 14 versions, all PostgreSQL 13 versions; PostgreSQL 12\.7 and higher | -| db\.r6g\.4xlarge | All MariaDB 10\.6 versions, all MariaDB 10\.5 versions, and all MariaDB 10\.4 versions | No | MySQL 8\.0\.23 and higher | No | All PostgreSQL 15 versions, all PostgreSQL 14 versions, all PostgreSQL 13 versions; PostgreSQL 12\.7 and higher | -| db\.r6g\.2xlarge | All MariaDB 10\.6 versions, all MariaDB 10\.5 versions, and all MariaDB 10\.4 versions | No | MySQL 8\.0\.23 and higher | No | All PostgreSQL 15 versions, all PostgreSQL 14 versions, all PostgreSQL 13 versions; PostgreSQL 12\.7 and higher | -| db\.r6g\.xlarge | All MariaDB 10\.6 versions, all MariaDB 10\.5 versions, and all MariaDB 10\.4 versions | No | MySQL 8\.0\.23 and higher | No | All PostgreSQL 15 versions, all PostgreSQL 14 versions, all PostgreSQL 13 versions; PostgreSQL 12\.7 and higher | -| db\.r6g\.large | All MariaDB 10\.6 versions, all MariaDB 10\.5 versions, and all MariaDB 10\.4 versions | No | MySQL 8\.0\.23 and higher | No | All PostgreSQL 15 versions, all PostgreSQL 14 versions, all PostgreSQL 13 versions; PostgreSQL 12\.7 and higher | -| db\.r6gd – memory\-optimized instance classes powered by AWS Graviton2 processors | -| db\.r6gd\.16xlarge | MariaDB version 10\.6\.7 and higher 10\.6 versions, MariaDB version 10\.5\.16 and higher 10\.5 versions, and MariaDB version 10\.4\.25 and higher 10\.4 versions | No | MySQL 8\.0\.28 and higher | No | All PostgreSQL 15 versions, PostgreSQL 14\.5 and higher 14 versions, PostgreSQL 13\.4 and PostgreSQL 13\.7 and higher 13 versions | -| db\.r6gd\.12xlarge | MariaDB version 10\.6\.7 and higher 10\.6 versions, MariaDB version 10\.5\.16 and higher 10\.5 versions, and MariaDB version 10\.4\.25 and higher 10\.4 versions | No | MySQL 8\.0\.28 and higher | No | All PostgreSQL 15 versions, PostgreSQL 14\.5 and higher 14 versions, PostgreSQL 13\.4 and PostgreSQL 13\.7 and higher 13 versions | -| db\.r6gd\.8xlarge | MariaDB version 10\.6\.7 and higher 10\.6 versions, MariaDB version 10\.5\.16 and higher 10\.5 versions, and MariaDB version 10\.4\.25 and higher 10\.4 versions | No | MySQL 8\.0\.28 and higher | No | All PostgreSQL 15 versions, PostgreSQL 14\.5 and higher 14 versions, PostgreSQL 13\.4 and PostgreSQL 13\.7 and higher 13 versions | -| db\.r6gd\.4xlarge | MariaDB version 10\.6\.7 and higher 10\.6 versions, MariaDB version 10\.5\.16 and higher 10\.5 versions, and MariaDB version 10\.4\.25 and higher 10\.4 versions | No | MySQL 8\.0\.28 and higher | No | All PostgreSQL 15 versions, PostgreSQL 14\.5 and higher 14 versions, PostgreSQL 13\.4 and PostgreSQL 13\.7 and higher 13 versions | -| db\.r6gd\.2xlarge | MariaDB version 10\.6\.7 and higher 10\.6 versions, MariaDB version 10\.5\.16 and higher 10\.5 versions, and MariaDB version 10\.4\.25 and higher 10\.4 versions | No | MySQL 8\.0\.28 and higher | No | All PostgreSQL 15 versions, PostgreSQL 14\.5 and higher 14 versions, PostgreSQL 13\.4 and PostgreSQL 13\.7 and higher 13 versions | -| db\.r6gd\.xlarge | MariaDB version 10\.6\.7 and higher 10\.6 versions, MariaDB version 10\.5\.16 and higher 10\.5 versions, and MariaDB version 10\.4\.25 and higher 10\.4 versions | No | MySQL 8\.0\.28 and higher | No | All PostgreSQL 15 versions, PostgreSQL 14\.5 and higher 14 versions, PostgreSQL 13\.4 and PostgreSQL 13\.7 and higher 13 versions | -| db\.r6gd\.large | MariaDB version 10\.6\.7 and higher 10\.6 versions, MariaDB version 10\.5\.16 and higher 10\.5 versions, and MariaDB version 10\.4\.25 and higher 10\.4 versions | No | MySQL 8\.0\.28 and higher | No | All PostgreSQL 15 versions, PostgreSQL 14\.5 and higher 14 versions, PostgreSQL 13\.4 and PostgreSQL 13\.7 and higher 13 versions | -| db\.r6i – memory\-optimized instance classes | -| db\.r6i\.32xlarge | MariaDB version 10\.6\.7 and higher 10\.6 versions, MariaDB version 10\.5\.15 and higher 10\.5 versions, and MariaDB version 10\.4\.24 and higher 10\.4 versions | Yes | MySQL version 8\.0\.28 and higher | Yes | All PostgreSQL 15 versions, all PostgreSQL 14 versions; PostgreSQL 13\.4 and higher 13 versions, PostgreSQL 12\.8 and higher 12 versions, PostgreSQL 11\.13 and higher 13 versions, and PostgreSQL 10\.21 and higher 10 versions | -| db\.r6i\.24xlarge | MariaDB version 10\.6\.7 and higher 10\.6 versions, MariaDB version 10\.5\.15 and higher 10\.5 versions, and MariaDB version 10\.4\.24 and higher 10\.4 versions | Yes | MySQL version 8\.0\.28 and higher | Yes | All PostgreSQL 15 versions, all PostgreSQL 14 versions; PostgreSQL 13\.4 and higher 13 versions, PostgreSQL 12\.8 and higher 12 versions, PostgreSQL 11\.13 and higher 13 versions, and PostgreSQL 10\.21 and higher 10 versions | -| db\.r6i\.16xlarge | MariaDB version 10\.6\.7 and higher 10\.6 versions, MariaDB version 10\.5\.15 and higher 10\.5 versions, and MariaDB version 10\.4\.24 and higher 10\.4 versions | Yes | MySQL version 8\.0\.28 and higher | Yes | All PostgreSQL 15 versions, all PostgreSQL 14 versions; PostgreSQL 13\.4 and higher 13 versions, PostgreSQL 12\.8 and higher 12 versions, PostgreSQL 11\.13 and higher 13 versions, and PostgreSQL 10\.21 and higher 10 versions | -| db\.r6i\.12xlarge | MariaDB version 10\.6\.7 and higher 10\.6 versions, MariaDB version 10\.5\.15 and higher 10\.5 versions, and MariaDB version 10\.4\.24 and higher 10\.4 versions | Yes | MySQL version 8\.0\.28 and higher | Yes | All PostgreSQL 15 versions, all PostgreSQL 14 versions; PostgreSQL 13\.4 and higher 13 versions, PostgreSQL 12\.8 and higher 12 versions, PostgreSQL 11\.13 and higher 13 versions, and PostgreSQL 10\.21 and higher 10 versions | -| db\.r6i\.8xlarge | MariaDB version 10\.6\.7 and higher 10\.6 versions, MariaDB version 10\.5\.15 and higher 10\.5 versions, and MariaDB version 10\.4\.24 and higher 10\.4 versions | Yes | MySQL version 8\.0\.28 and higher | Yes | All PostgreSQL 15 versions, all PostgreSQL 14 versions; PostgreSQL 13\.4 and higher 13 versions, PostgreSQL 12\.8 and higher 12 versions, PostgreSQL 11\.13 and higher 13 versions, and PostgreSQL 10\.21 and higher 10 versions | -| db\.r6i\.4xlarge | MariaDB version 10\.6\.7 and higher 10\.6 versions, MariaDB version 10\.5\.15 and higher 10\.5 versions, and MariaDB version 10\.4\.24 and higher 10\.4 versions | Yes | MySQL version 8\.0\.28 and higher | Yes | All PostgreSQL 15 versions, all PostgreSQL 14 versions; PostgreSQL 13\.4 and higher 13 versions, PostgreSQL 12\.8 and higher 12 versions, PostgreSQL 11\.13 and higher 13 versions, and PostgreSQL 10\.21 and higher 10 versions | -| db\.r6i\.2xlarge | MariaDB version 10\.6\.7 and higher 10\.6 versions, MariaDB version 10\.5\.15 and higher 10\.5 versions, and MariaDB version 10\.4\.24 and higher 10\.4 versions | Yes | MySQL version 8\.0\.28 and higher | Yes | All PostgreSQL 15 versions, all PostgreSQL 14 versions; PostgreSQL 13\.4 and higher 13 versions, PostgreSQL 12\.8 and higher 12 versions, PostgreSQL 11\.13 and higher 13 versions, and PostgreSQL 10\.21 and higher 10 versions | -| db\.r6i\.xlarge | MariaDB version 10\.6\.7 and higher 10\.6 versions, MariaDB version 10\.5\.15 and higher 10\.5 versions, and MariaDB version 10\.4\.24 and higher 10\.4 versions | Yes | MySQL version 8\.0\.28 and higher | Yes | All PostgreSQL 15 versions, all PostgreSQL 14 versions; PostgreSQL 13\.4 and higher 13 versions, PostgreSQL 12\.8 and higher 12 versions, PostgreSQL 11\.13 and higher 13 versions, and PostgreSQL 10\.21 and higher 10 versions | -| db\.r6i\.large | MariaDB version 10\.6\.7 and higher 10\.6 versions, MariaDB version 10\.5\.15 and higher 10\.5 versions, and MariaDB version 10\.4\.24 and higher 10\.4 versions | Yes | MySQL version 8\.0\.28 and higher | Yes | All PostgreSQL 15 versions, all PostgreSQL 14 versions; PostgreSQL 13\.4 and higher 13 versions, PostgreSQL 12\.8 and higher 12 versions, PostgreSQL 11\.13 and higher 13 versions, and PostgreSQL 10\.21 and higher 10 versions | -| db\.r5d – memory\-optimized instance classes | -| db\.r5d\.24xlarge | MariaDB version 10\.6\.7 and higher 10\.6 versions, MariaDB version 10\.5\.16 and higher 10\.5 versions, and MariaDB version 10\.4\.25 and higher 10\.4 versions | Yes | MySQL 8\.0\.28 and higher | Yes | All PostgreSQL 15 versions, PostgreSQL 14\.5 and higher 14 versions, PostgreSQL 13\.4, and PostgreSQL 13\.7 and higher 13 versions | -| db\.r5d\.16xlarge | MariaDB version 10\.6\.7 and higher 10\.6 versions, MariaDB version 10\.5\.16 and higher 10\.5 versions, and MariaDB version 10\.4\.25 and higher 10\.4 versions | Yes | MySQL 8\.0\.28 and higher | Yes | All PostgreSQL 15 versions, PostgreSQL 14\.5 and higher 14 versions, PostgreSQL 13\.4, and PostgreSQL 13\.7 and higher 13 versions | -| db\.r5d\.12xlarge | MariaDB version 10\.6\.7 and higher 10\.6 versions, MariaDB version 10\.5\.16 and higher 10\.5 versions, and MariaDB version 10\.4\.25 and higher 10\.4 versions | Yes | MySQL 8\.0\.28 and higher | Yes | All PostgreSQL 15 versions, PostgreSQL 14\.5 and higher 14 versions, PostgreSQL 13\.4, and PostgreSQL 13\.7 and higher 13 versions | -| db\.r5d\.8xlarge | MariaDB version 10\.6\.7 and higher 10\.6 versions, MariaDB version 10\.5\.16 and higher 10\.5 versions, and MariaDB version 10\.4\.25 and higher 10\.4 versions | Yes | MySQL 8\.0\.28 and higher | Yes | All PostgreSQL 15 versions, PostgreSQL 14\.5 and higher 14 versions, PostgreSQL 13\.4, and PostgreSQL 13\.7 and higher 13 versions | -| db\.r5d\.4xlarge | MariaDB version 10\.6\.7 and higher 10\.6 versions, MariaDB version 10\.5\.16 and higher 10\.5 versions, and MariaDB version 10\.4\.25 and higher 10\.4 versions | Yes | MySQL 8\.0\.28 and higher | Yes | All PostgreSQL 15 versions, PostgreSQL 14\.5 and higher 14 versions, PostgreSQL 13\.4, and PostgreSQL 13\.7 and higher 13 versions | -| db\.r5d\.2xlarge | MariaDB version 10\.6\.7 and higher 10\.6 versions, MariaDB version 10\.5\.16 and higher 10\.5 versions, and MariaDB version 10\.4\.25 and higher 10\.4 versions | Yes | MySQL 8\.0\.28 and higher | Yes | All PostgreSQL 15 versions, PostgreSQL 14\.5 and higher 14 versions, PostgreSQL 13\.4, and PostgreSQL 13\.7 and higher 13 versions | -| db\.r5d\.xlarge | MariaDB version 10\.6\.7 and higher 10\.6 versions, MariaDB version 10\.5\.16 and higher 10\.5 versions, and MariaDB version 10\.4\.25 and higher 10\.4 versions | Yes | MySQL 8\.0\.28 and higher | Yes | All PostgreSQL 15 versions, PostgreSQL 14\.5 and higher 14 versions, PostgreSQL 13\.4, and PostgreSQL 13\.7 and higher 13 versions | -| db\.r5d\.large | MariaDB version 10\.6\.7 and higher 10\.6 versions, MariaDB version 10\.5\.16 and higher 10\.5 versions, and MariaDB version 10\.4\.25 and higher 10\.4 versions | Yes | MySQL 8\.0\.28 and higher | Yes | All PostgreSQL 15 versions, PostgreSQL 14\.5 and higher 14 versions, PostgreSQL 13\.4, and PostgreSQL 13\.7 and higher 13 versions | -| db\.r5b – memory\-optimized instance classes preconfigured for high memory, storage, and I/O | -| db\.r5b\.8xlarge\.tpc2\.mem3x | No | No | No | Yes | No | -| db\.r5b\.6xlarge\.tpc2\.mem4x | No | No | No | Yes | No | -| db\.r5b\.4xlarge\.tpc2\.mem4x | No | No | No | Yes | No | -| db\.r5b\.4xlarge\.tpc2\.mem3x | No | No | No | Yes | No | -| db\.r5b\.4xlarge\.tpc2\.mem2x | No | No | No | Yes | No | -| db\.r5b\.2xlarge\.tpc2\.mem8x | No | No | No | Yes | No | -| db\.r5b\.2xlarge\.tpc2\.mem4x | No | No | No | Yes | No | -| db\.r5b\.2xlarge\.tpc1\.mem2x | No | No | No | Yes | No | -| db\.r5b\.xlarge\.tpc2\.mem4x | No | No | No | Yes | No | -| db\.r5b\.xlarge\.tpc2\.mem2x | No | No | No | Yes | No | -| db\.r5b\.large\.tpc1\.mem2x | No | No | No | Yes | No | -| db\.r5b – memory\-optimized instance classes | -| db\.r5b\.24xlarge | MariaDB version 10\.6\.5 and higher 10\.6 versions, MariaDB version 10\.5\.12 and higher 10\.5 versions, MariaDB version 10\.4\.24 and higher 10\.4 versions, and MariaDB version 10\.3\.34 and higher 10\.3 versions | Yes | MySQL 8\.0\.25 and higher | Yes | All PostgreSQL 15 versions, all PostgreSQL 14 versions, all PostgreSQL 13 versions; PostgreSQL 12\.7 and higher | -| db\.r5b\.16xlarge | MariaDB version 10\.6\.5 and higher 10\.6 versions, MariaDB version 10\.5\.12 and higher 10\.5 versions, MariaDB version 10\.4\.24 and higher 10\.4 versions, and MariaDB version 10\.3\.34 and higher 10\.3 versions | Yes | MySQL 8\.0\.25 and higher | Yes | All PostgreSQL 15 versions, all PostgreSQL 14 versions, all PostgreSQL 13 versions; PostgreSQL 12\.7 and higher | -| db\.r5b\.12xlarge | MariaDB version 10\.6\.5 and higher 10\.6 versions, MariaDB version 10\.5\.12 and higher 10\.5 versions, MariaDB version 10\.4\.24 and higher 10\.4 versions, and MariaDB version 10\.3\.34 and higher 10\.3 versions | Yes | MySQL 8\.0\.25 and higher | Yes | All PostgreSQL 15 versions, all PostgreSQL 14 versions, all PostgreSQL 13 versions; PostgreSQL 12\.7 and higher | -| db\.r5b\.8xlarge | MariaDB version 10\.6\.5 and higher 10\.6 versions, MariaDB version 10\.5\.12 and higher 10\.5 versions, MariaDB version 10\.4\.24 and higher 10\.4 versions, and MariaDB version 10\.3\.34 and higher 10\.3 versions | Yes | MySQL 8\.0\.25 and higher | >Yes | All PostgreSQL 15 versions, all PostgreSQL 14 versions, all PostgreSQL 13 versions; PostgreSQL 12\.7 and higher | -| db\.r5b\.4xlarge | MariaDB version 10\.6\.5 and higher 10\.6 versions, MariaDB version 10\.5\.12 and higher 10\.5 versions, MariaDB version 10\.4\.24 and higher 10\.4 versions, and MariaDB version 10\.3\.34 and higher 10\.3 versions | Yes | MySQL 8\.0\.25 and higher | Yes | All PostgreSQL 15 versions, all PostgreSQL 14 versions, all PostgreSQL 13 versions; PostgreSQL 12\.7 and higher | -| db\.r5b\.2xlarge | MariaDB version 10\.6\.5 and higher 10\.6 versions, MariaDB version 10\.5\.12 and higher 10\.5 versions, MariaDB version 10\.4\.24 and higher 10\.4 versions, and MariaDB version 10\.3\.34 and higher 10\.3 versions | Yes | MySQL 8\.0\.25 and higher | Yes | All PostgreSQL 15 versions, all PostgreSQL 14 versions, all PostgreSQL 13 versions; PostgreSQL 12\.7 and higher | -| db\.r5b\.xlarge | MariaDB version 10\.6\.5 and higher 10\.6 versions, MariaDB version 10\.5\.12 and higher 10\.5 versions, MariaDB version 10\.4\.24 and higher 10\.4 versions, and MariaDB version 10\.3\.34 and higher 10\.3 versions | Yes | MySQL 8\.0\.25 and higher | Yes | All PostgreSQL 15 versions, all PostgreSQL 14 versions, all PostgreSQL 13 versions; PostgreSQL 12\.7 and higher | -| db\.r5b\.large | MariaDB version 10\.6\.5 and higher 10\.6 versions, MariaDB version 10\.5\.12 and higher 10\.5 versions, MariaDB version 10\.4\.24 and higher 10\.4 versions, and MariaDB version 10\.3\.34 and higher 10\.3 versions | Yes | MySQL 8\.0\.25 and higher | Yes | All PostgreSQL 15 versions, all PostgreSQL 14 versions, all PostgreSQL 13 versions; PostgreSQL 12\.7 and higher | -| db\.r5 – memory\-optimized instance classes preconfigured for high memory, storage, and I/O | -| db\.r5\.12xlarge\.tpc2\.mem2x | No | No | No | Yes | No | -| db\.r5\.8xlarge\.tpc2\.mem3x | No | No | No | Yes | No | -| db\.r5\.6xlarge\.tpc2\.mem4x | No | No | No | Yes | No | -| db\.r5\.4xlarge\.tpc2\.mem4x | No | No | No | Yes | No | -| db\.r5\.4xlarge\.tpc2\.mem3x | No | No | No | Yes | No | -| db\.r5\.4xlarge\.tpc2\.mem2x | No | No | No | Yes | No | -| db\.r5\.2xlarge\.tpc2\.mem8x | No | No | No | Yes | No | -| db\.r5\.2xlarge\.tpc2\.mem4x | No | No | No | Yes | No | -| db\.r5\.2xlarge\.tpc1\.mem2x | No | No | No | Yes | No | -| db\.r5\.xlarge\.tpc2\.mem4x | No | No | No | Yes | No | -| db\.r5\.xlarge\.tpc2\.mem2x | No | No | No | Yes | No | -| db\.r5\.large\.tpc1\.mem2x | No | No | No | Yes | No | -| db\.r5 – memory\-optimized instance classes | -| db\.r5\.24xlarge | Yes | Yes | Yes | Yes | All PostgreSQL 15, 14, 13, 12, and 11 versions; 10\.17 and higher; 9\.6\.22 and higher | -| db\.r5\.16xlarge | Yes | Yes | Yes | Yes | All PostgreSQL 15, 14, 13, 12, and 11 versions; 10\.17 and higher; 9\.6\.22 and higher | -| db\.r5\.12xlarge | Yes | Yes | Yes | Yes | All PostgreSQL 15, 14, 13, 12, and 11 versions; 10\.17 and higher; 9\.6\.22 and higher | -| db\.r5\.8xlarge | Yes | Yes | Yes | Yes | All PostgreSQL 15, 14, 13, 12, and 11 versions; 10\.17 and higher; 9\.6\.22 and higher | -| db\.r5\.4xlarge | Yes | Yes | Yes | Yes | All PostgreSQL 15, 14, 13, 12, and 11 versions; 10\.17 and higher; 9\.6\.22 and higher | -| db\.r5\.2xlarge | Yes | Yes | Yes | Yes | All PostgreSQL 15, 14, 13, 12, and 11 versions; 10\.17 and higher; 9\.6\.22 and higher | -| db\.r5\.xlarge | Yes | Yes | Yes | Yes | All PostgreSQL 15, 14, 13, 12, and 11 versions; 10\.17 and higher; 9\.6\.22 and higher | -| db\.r5\.large | Yes | Yes | Yes | Yes | All PostgreSQL 15, 14, 13, 12, and 11 versions; 10\.17 and higher; 9\.6\.22 and higher | -| db\.r4 – memory\-optimized instance classes | -| db\.r4\.16xlarge | Yes | Yes | All MySQL 8\.0, 5\.7 | Deprecated | Lower than PostgreSQL 13 | -| db\.r4\.8xlarge | Yes | Yes | All MySQL 8\.0, 5\.7 | Deprecated | Lower than PostgreSQL 13 | -| db\.r4\.4xlarge | Yes | Yes | All MySQL 8\.0, 5\.7 | Deprecated | Lower than PostgreSQL 13 | -| db\.r4\.2xlarge | Yes | Yes | All MySQL 8\.0, 5\.7 | Deprecated | Lower than PostgreSQL 13 | -| db\.r4\.xlarge | Yes | Yes | All MySQL 8\.0, 5\.7 | Deprecated | Lower than PostgreSQL 13 | -| db\.r4\.large | Yes | Yes | All MySQL 8\.0, 5\.7 | Deprecated | Lower than PostgreSQL 13 | -| db\.r3 – memory\-optimized instance classes | -| db\.r3\.8xlarge\*\* | Yes | Yes | Yes | Deprecated | Deprecated | -| db\.r3\.4xlarge | Yes | Yes | Yes | Deprecated | Deprecated | -| db\.r3\.2xlarge | Yes | Yes | Yes | Deprecated | Deprecated | -| db\.r3\.xlarge | Yes | Yes | Yes | Deprecated | Deprecated | -| db\.r3\.large | Yes | Yes | Yes | Deprecated | Deprecated | -| db\.t4g – burstable\-performance instance classes powered by AWS Graviton2 processors | -| db\.t4g\.2xlarge | All MariaDB 10\.6 versions, all MariaDB 10\.5 versions, and all MariaDB 10\.4 versions | No | MySQL 8\.0\.25 and higher | No | All PostgreSQL 15 versions, all PostgreSQL 14 versions, all PostgreSQL 13 versions, PostgreSQL 12\.7 and higher | -| db\.t4g\.xlarge | All MariaDB 10\.6 versions, all MariaDB 10\.5 versions, and all MariaDB 10\.4 versions | No | MySQL 8\.0\.25 and higher | No | All PostgreSQL 15 versions, all PostgreSQL 14 versions, all PostgreSQL 13 versions, PostgreSQL 12\.7 and higher | -| db\.t4g\.large | All MariaDB 10\.6 versions, all MariaDB 10\.5 versions, and all MariaDB 10\.4 versions | No | MySQL 8\.0\.25 and higher | No | All PostgreSQL 15 versions, all PostgreSQL 14 versions, all PostgreSQL 13 versions, PostgreSQL 12\.7 and higher | -| db\.t4g\.medium | All MariaDB 10\.6 versions, all MariaDB 10\.5 versions, and all MariaDB 10\.4 versions | No | MySQL 8\.0\.25 and higher | No | All PostgreSQL 15 versions, all PostgreSQL 14 and 13 versions, and PostgreSQL 12\.7 and higher 12 versions | -| db\.t4g\.small | All MariaDB 10\.6 versions, all MariaDB 10\.5 versions, and all MariaDB 10\.4 versions | No | MySQL 8\.0\.25 and higher | No | All PostgreSQL 15 versions, all PostgreSQL 14 versions, all PostgreSQL 13 versions, PostgreSQL 12\.7 and higher | -| db\.t4g\.micro | All MariaDB 10\.6 versions, all MariaDB 10\.5 versions, and all MariaDB 10\.4 versions | No | MySQL 8\.0\.25 and higher | No | All PostgreSQL 15 versions, all PostgreSQL 14 versions, all PostgreSQL 13 versions, PostgreSQL 12\.7 and higher | -| db\.t3 – burstable\-performance instance classes | -| db\.t3\.2xlarge | Yes | Yes | Yes | Yes | All PostgreSQL 15, 14, 13, 12, 11, and 10 versions; PostgreSQL 9\.6\.22 and higher versions | -| db\.t3\.xlarge | Yes | Yes | Yes | Yes | All PostgreSQL 15, 14, 13, 12, 11, and 10 versions; PostgreSQL 9\.6\.22 and higher versions | -| db\.t3\.large | Yes | Yes | Yes | Yes | All PostgreSQL 15, 14, 13, 12, 11, and 10 versions, and PostgreSQL 9\.6\.22 and higher versions | -| db\.t3\.medium | Yes | Yes | Yes | Yes | All PostgreSQL 15, 14, 13, 12, 11, and 10 versions; PostgreSQL 9\.6\.22 and higher versions | -| db\.t3\.small | Yes | Yes | Yes | Yes | All PostgreSQL 15, 14, 13, 12, 11, and 10 versions; PostgreSQL 9\.6\.22 and higher versions | -| db\.t3\.micro | Yes | No | Yes | Only on Oracle Database 12c Release 1 \(12\.1\.0\.2\), which is deprecated | All PostgreSQL 15, 14, 13, 12, 11, and 10 versions; PostgreSQL 9\.6\.22 and higher versions | -| db\.t2 – burstable\-performance instance classes | -| db\.t2\.2xlarge | Yes | No | All MySQL 8\.0, 5\.7 | Deprecated | Lower than PostgreSQL 13 | -| db\.t2\.xlarge | Yes | No | All MySQL 8\.0, 5\.7 | Deprecated | Lower than PostgreSQL 13 | -| db\.t2\.large | Yes | Yes | Yes | Deprecated | Lower than PostgreSQL 13 | -| db\.t2\.medium | Yes | Yes | Yes | Deprecated | Lower than PostgreSQL 13 | -| db\.t2\.small | Yes | Yes | Yes | Deprecated | Lower than PostgreSQL 13 | -| db\.t2\.micro | Yes | Yes | Yes | Deprecated | Lower than PostgreSQL 13 | - -## Determining DB instance class support in AWS Regions - -To determine the DB instance classes supported by each DB engine in a specific AWS Region, you can take one of several approaches\. You can use the AWS Management Console, the [Amazon RDS Pricing](http://aws.amazon.com/rds/pricing/) page, or the [describe\-orderable\-db\-instance\-options](https://docs.aws.amazon.com/cli/latest/reference/rds/describe-orderable-db-instance-options.html) command for the AWS Command Line Interface \(AWS CLI\)\. - -**Note** -When you perform operations with the AWS CLI, it automatically shows the supported DB instance classes for a specific DB engine, DB engine version, and AWS Region\. Examples of the operations that you can perform include creating and modifying a DB instance\. - -**Contents** -+ [Using the Amazon RDS pricing page to determine DB instance class support in AWS Regions](#Concepts.DBInstanceClass.RegionSupport.PricingPage) -+ [Using the AWS CLI to determine DB instance class support in AWS Regions](#Concepts.DBInstanceClass.RegionSupport.CLI) - + [Listing the DB instance classes that are supported by a specific DB engine version in an AWS Region](#Concepts.DBInstanceClass.RegionSupport.CLI.Example1) - + [Listing the DB engine versions that support a specific DB instance class in an AWS Region](#Concepts.DBInstanceClass.RegionSupport.CLI.Example2) - -### Using the Amazon RDS pricing page to determine DB instance class support in AWS Regions - -You can use the [Amazon RDS Pricing](http://aws.amazon.com/rds/pricing/) page to determine the DB instance classes supported by each DB engine in a specific AWS Region\. - -**To use the pricing page to determine the DB instance classes supported by each engine in a Region** - -1. Go to [Amazon RDS Pricing](http://aws.amazon.com/rds/pricing/)\. - -1. Choose a DB engine\. - -1. On the pricing page for the DB engine, choose **On\-Demand DB Instances** or **Reserved DB Instances**\. - -1. To see the DB instance classes available in an AWS Region, choose the AWS Region in **Region**\. - - Other choices might be available for some DB engines, such as **Single\-AZ Deployment** or **Multi\-AZ Deployment**\. - -### Using the AWS CLI to determine DB instance class support in AWS Regions - -You can use the AWS CLI to determine which DB instance classes are supported for specific DB engines and DB engine versions in an AWS Region\. The following table shows the valid DB engine values\. - - -**** - -| Engine names | Engine values in CLI commands | More information about versions | -| --- | --- | --- | -| MariaDB | `mariadb` | [MariaDB on Amazon RDS versions](MariaDB.Concepts.VersionMgmt.md) | -| Microsoft SQL Server | `sqlserver-ee` `sqlserver-se` `sqlserver-ex` `sqlserver-web` | [Microsoft SQL Server versions on Amazon RDS](CHAP_SQLServer.md#SQLServer.Concepts.General.VersionSupport) | -| MySQL | `mysql` | [MySQL on Amazon RDS versions](MySQL.Concepts.VersionMgmt.md) | -| Oracle | `oracle-ee` `oracle-se2` | [https://docs.aws.amazon.com/AmazonRDS/latest/OracleReleaseNotes/Welcome.html](https://docs.aws.amazon.com/AmazonRDS/latest/OracleReleaseNotes/Welcome.html) | -| PostgreSQL | `postgres` | [Available PostgreSQL database versions](CHAP_PostgreSQL.md#PostgreSQL.Concepts.General.DBVersions) | - -For information about AWS Region names, see [AWS RegionsAvailability Zones](Concepts.RegionsAndAvailabilityZones.md#Concepts.RegionsAndAvailabilityZones.Regions)\. - -The following examples demonstrate how to determine DB instance class support in an AWS Region using the [describe\-orderable\-db\-instance\-options](https://docs.aws.amazon.com/cli/latest/reference/rds/describe-orderable-db-instance-options.html) AWS CLI command\. - -**Note** -To limit the output, these examples show results only for the General Purpose SSD \(`gp2`\) storage type\. If necessary, you can change the storage type to General Purpose SSD \(`gp3`\), Provisioned IOPS \(`io1`\), or magnetic \(`standard`\) in the commands\. - -**Topics** -+ [Listing the DB instance classes that are supported by a specific DB engine version in an AWS Region](#Concepts.DBInstanceClass.RegionSupport.CLI.Example1) -+ [Listing the DB engine versions that support a specific DB instance class in an AWS Region](#Concepts.DBInstanceClass.RegionSupport.CLI.Example2) - -#### Listing the DB instance classes that are supported by a specific DB engine version in an AWS Region - -To list the DB instance classes that are supported by a specific DB engine version in an AWS Region, run the following command\. - -For Linux, macOS, or Unix: - -``` -aws rds describe-orderable-db-instance-options --engine engine --engine-version version \ - --query "*[].{DBInstanceClass:DBInstanceClass,StorageType:StorageType}|[?StorageType=='gp2']|[].{DBInstanceClass:DBInstanceClass}" \ - --output text \ - --region region -``` - -For Windows: - -``` -aws rds describe-orderable-db-instance-options --engine engine --engine-version version ^ - --query "*[].{DBInstanceClass:DBInstanceClass,StorageType:StorageType}|[?StorageType=='gp2']|[].{DBInstanceClass:DBInstanceClass}" ^ - --output text ^ - --region region -``` - -For example, the following command lists the supported DB instance classes for version 13\.6 of the RDS for PostgreSQL DB engine in US East \(N\. Virginia\)\. - -For Linux, macOS, or Unix: - -``` -aws rds describe-orderable-db-instance-options --engine postgres --engine-version 13.6 \ - --query "*[].{DBInstanceClass:DBInstanceClass,StorageType:StorageType}|[?StorageType=='gp2']|[].{DBInstanceClass:DBInstanceClass}" \ - --output text \ - --region us-east-1 -``` - -For Windows: - -``` -aws rds describe-orderable-db-instance-options --engine postgres --engine-version 13.6 ^ - --query "*[].{DBInstanceClass:DBInstanceClass,StorageType:StorageType}|[?StorageType=='gp2']|[].{DBInstanceClass:DBInstanceClass}" ^ - --output text ^ - --region us-east-1 -``` - -#### Listing the DB engine versions that support a specific DB instance class in an AWS Region - -To list the DB engine versions that support a specific DB instance class in an AWS Region, run the following command\. - -For Linux, macOS, or Unix: - -``` -aws rds describe-orderable-db-instance-options --engine engine --db-instance-class DB_instance_class \ - --query "*[].{EngineVersion:EngineVersion,StorageType:StorageType}|[?StorageType=='gp2']|[].{EngineVersion:EngineVersion}" \ - --output text \ - --region region -``` - -For Windows: - -``` -aws rds describe-orderable-db-instance-options --engine engine --db-instance-class DB_instance_class ^ - --query "*[].{EngineVersion:EngineVersion,StorageType:StorageType}|[?StorageType=='gp2']|[].{EngineVersion:EngineVersion}" ^ - --output text ^ - --region region -``` - -For example, the following command lists the DB engine versions of the RDS for PostgreSQL DB engine that support the db\.r5\.large DB instance class in US East \(N\. Virginia\)\. - -For Linux, macOS, or Unix: - -``` -aws rds describe-orderable-db-instance-options --engine postgres --db-instance-class db.r5.large \ - --query "*[].{EngineVersion:EngineVersion,StorageType:StorageType}|[?StorageType=='gp2']|[].{EngineVersion:EngineVersion}" \ - --output text \ - --region us-east-1 -``` - -For Windows: - -``` -aws rds describe-orderable-db-instance-options --engine postgres --db-instance-class db.r5.large ^ - --query "*[].{EngineVersion:EngineVersion,StorageType:StorageType}|[?StorageType=='gp2']|[].{EngineVersion:EngineVersion}" ^ - --output text ^ - --region us-east-1 -``` - -## Changing your DB instance class - -You can change the CPU and memory available to a DB instance by changing its DB instance class\. To change the DB instance class, modify your DB instance by following the instructions in [Modifying an Amazon RDS DB instance](Overview.DBInstance.Modifying.md)\. - -## Configuring the processor for a DB instance class - -Amazon RDS DB instance classes support Intel Hyper\-Threading Technology, which enables multiple threads to run concurrently on a single Intel Xeon CPU core\. Each thread is represented as a virtual CPU \(vCPU\) on the DB instance\. A DB instance has a default number of CPU cores, which varies according to DB instance class\. For example, a db\.m4\.xlarge DB instance class has two CPU cores and two threads per core by default—four vCPUs in total\. - -**Note** -Each vCPU is a hyperthread of an Intel Xeon CPU core\. - -**Topics** -+ [Overview of configuring the processor](#USER_ConfigureProcessor.Overview) -+ [DB instance classes that support processor configuration](#USER_ConfigureProcessor.CPUOptionsDBInstanceClass) -+ [Setting the CPU cores and threads per CPU core for a DB instance class](#USER_ConfigureProcessor.SettingCPUOptions) - -### Overview of configuring the processor - -In most cases, you can find a DB instance class that has a combination of memory and number of vCPUs to suit your workloads\. However, you can also specify the following processor features to optimize your DB instance for specific workloads or business needs: -+ **Number of CPU cores** – You can customize the number of CPU cores for the DB instance\. You might do this to potentially optimize the licensing costs of your software with a DB instance that has sufficient amounts of RAM for memory\-intensive workloads but fewer CPU cores\. -+ **Threads per core** – You can disable Intel Hyper\-Threading Technology by specifying a single thread per CPU core\. You might do this for certain workloads, such as high\-performance computing \(HPC\) workloads\. - -You can control the number of CPU cores and threads for each core separately\. You can set one or both in a request\. After a setting is associated with a DB instance, the setting persists until you change it\. - -The processor settings for a DB instance are associated with snapshots of the DB instance\. When a snapshot is restored, its restored DB instance uses the processor feature settings used when the snapshot was taken\. - -If you modify the DB instance class for a DB instance with nondefault processor settings, either specify default processor settings or explicitly specify processor settings at modification\. This requirement ensures that you are aware of the third\-party licensing costs that might be incurred when you modify the DB instance\. - -There is no additional or reduced charge for specifying processor features on an Amazon RDS DB instance\. You're charged the same as for DB instances that are launched with default CPU configurations\. - -### DB instance classes that support processor configuration - -You can configure the number of CPU cores and threads per core only when the following conditions are met: -+ You're configuring an Oracle DB instance\. For information about the DB instance classes supported by different Oracle database editions, see [RDS for Oracle instance classes](Oracle.Concepts.InstanceClasses.md)\. -+ Your instance is using the Bring Your Own License \(BYOL\) licensing option\. For more information about Oracle licensing options, see [RDS for Oracle licensing options](Oracle.Concepts.Licensing.md)\. -+ Your instance doesn't belong to one of the db\.r5 or db\.r5b instance classes that have predefined processor configurations\. These instance classes have names in the form db\.r5\.*instance\_size*\.tpc*threads\_per\_core*\.mem*ratio* or db\.r5b\.*instance\_size*\.tpc*threads\_per\_core*\.mem*ratio*\. For example, db\.r5b\.xlarge\.tpc2\.mem4x is preconfigured with 2 threads per core \(tpc2\) and 4x as much memory as the standard db\.r5b\.xlarge instance class\. You can't configure the processor features of these optimized instance classes\. For more information, see [Supported RDS for Oracle instance classes](Oracle.Concepts.InstanceClasses.md#Oracle.Concepts.InstanceClasses.Supported)\. - -In the following table, you can find the DB instance classes that support setting a number of CPU cores and CPU threads per core\. You can also find the default value and the valid values for the number of CPU cores and CPU threads per core for each DB instance class\. - - -**** - -| DB instance class | Default vCPUs | Default CPU cores | Default threads per core | Valid number of CPU cores | Valid number of threads per core | -| --- | --- | --- | --- | --- | --- | -| db\.m5\.large | 2 | 1 | 2 | 1 | 1, 2 | -| db\.m5\.xlarge | 4 | 2 | 2 | 2 | 1, 2 | -| db\.m5\.2xlarge | 8 | 4 | 2 | 2, 4 | 1, 2 | -| db\.m5\.4xlarge | 16 | 8 | 2 | 2, 4, 6, 8 | 1, 2 | -| db\.m5\.8xlarge | 32 | 16 | 2 | 2, 4, 6, 8, 10, 12, 14, 16 | 1, 2 | -| db\.m5\.12xlarge | 48 | 24 | 2 | 2, 4, 6, 8, 10, 12, 14, 16, 18, 20, 22, 24 | 1, 2 | -| db\.m5\.16xlarge | 64 | 32 | 2 | 2, 4, 6, 8, 10, 12, 14, 16, 18, 20, 22, 24, 26, 28, 30, 32 | 1, 2 | -| db\.m5\.24xlarge | 96 | 48 | 2 | 4, 6, 8, 10, 12, 14, 16, 18, 20, 22, 24, 26, 28, 30, 32, 34, 36, 38, 40, 42, 44, 46, 48 | 1, 2 | -| db\.m5d\.large | 2 | 1 | 2 | 1 | 1, 2 | -| db\.m5d\.xlarge | 4 | 2 | 2 | 2 | 1, 2 | -| db\.m5d\.2xlarge | 8 | 4 | 2 | 2, 4 | 1, 2 | -| db\.m5d\.4xlarge | 16 | 8 | 2 | 2, 4, 6, 8 | 1, 2 | -| db\.m5d\.8xlarge | 32 | 16 | 2 | 2, 4, 6, 8, 10, 12, 14, 16 | 1, 2 | -| db\.m5d\.12xlarge | 48 | 24 | 2 | 2, 4, 6, 8, 10, 12, 14, 16, 18, 20, 22, 24 | 1, 2 | -| db\.m5d\.16xlarge | 64 | 32 | 2 | 2, 4, 6, 8, 10, 12, 14, 16, 18, 20, 22, 24, 26, 28, 30, 32 | 1, 2 | -| db\.m5d\.24xlarge | 96 | 48 | 2 | 4, 6, 8, 10, 12, 14, 16, 18, 20, 22, 24, 26, 28, 30, 32, 34, 36, 38, 40, 42, 44, 46, 48 | 1, 2 | -| db\.m4\.10xlarge | 40 | 20 | 2 | 2, 4, 6, 8, 10, 12, 14, 16, 18, 20 | 1, 2 | -| db\.m4\.16xlarge | 64 | 32 | 2 | 2, 4, 6, 8, 10, 12, 14, 16, 18, 20, 22, 24, 26, 28, 30, 32 | 1, 2 | -| db\.r5\.large | 2 | 1 | 2 | 1 | 1, 2 | -| db\.r5\.xlarge | 4 | 2 | 2 | 2 | 1, 2 | -| db\.r5\.2xlarge | 8 | 4 | 2 | 2, 4 | 1, 2 | -| db\.r5\.4xlarge | 16 | 8 | 2 | 2, 4, 6, 8 | 1, 2 | -| db\.r5\.8xlarge | 32 | 16 | 2 | 2, 4, 6, 8, 10, 12, 14, 16 | 1, 2 | -| db\.r5\.12xlarge | 48 | 24 | 2 | 2, 4, 6, 8, 10, 12, 14, 16, 18, 20, 22, 24 | 1, 2 | -| db\.r5\.16xlarge | 64 | 32 | 2 | 2, 4, 6, 8, 10, 12, 14, 16, 18, 20, 22, 24, 26, 28, 30, 32 | 1, 2 | -| db\.r5\.24xlarge | 96 | 48 | 2 | 4, 6, 8, 10, 12, 14, 16, 18, 20, 22, 24, 26, 28, 30, 32, 34, 36, 38, 40, 42, 44, 46, 48 | 1, 2 | -| db\.r5b\.large | 2 | 1 | 2 | 1 | 1, 2 | -| db\.r5b\.xlarge | 4 | 2 | 2 | 2 | 1, 2 | -| db\.r5b\.2xlarge | 8 | 4 | 2 | 2, 4 | 1, 2 | -| db\.r5b\.4xlarge | 16 | 8 | 2 | 2, 4, 6, 8 | 1, 2 | -| db\.r5b\.8xlarge | 32 | 16 | 2 | 2, 4, 6, 8, 10, 12, 14, 16 | 1, 2 | -| db\.r5b\.12xlarge | 48 | 24 | 2 | 2, 4, 6, 8, 10, 12, 14, 16, 18, 20, 22, 24 | 1, 2 | -| db\.r5b\.16xlarge | 64 | 32 | 2 | 2, 4, 6, 8, 10, 12, 14, 16, 18, 20, 22, 24, 26, 28, 30, 32 | 1, 2 | -| db\.r5b\.24xlarge | 96 | 48 | 2 | 4, 6, 8, 10, 12, 14, 16, 18, 20, 22, 24, 26, 28, 30, 32, 34, 36, 38, 40, 42, 44, 46, 48 | 1, 2 | -| db\.r5d\.large | 2 | 1 | 2 | 1 | 1, 2 | -| db\.r5d\.xlarge | 4 | 2 | 2 | 2 | 1, 2 | -| db\.r5d\.2xlarge | 8 | 4 | 2 | 2, 4 | 1, 2 | -| db\.r5d\.4xlarge | 16 | 8 | 2 | 2, 4, 6, 8 | 1, 2 | -| db\.r5d\.8xlarge | 32 | 16 | 2 | 2, 4, 6, 8, 10, 12, 14, 16 | 1, 2 | -| db\.r5d\.12xlarge | 48 | 24 | 2 | 2, 4, 6, 8, 10, 12, 14, 16, 18, 20, 22, 24 | 1, 2 | -| db\.r5d\.16xlarge | 64 | 32 | 2 | 2, 4, 6, 8, 10, 12, 14, 16, 18, 20, 22, 24, 26, 28, 30, 32 | 1, 2 | -| db\.r5d\.24xlarge | 96 | 48 | 2 | 4, 6, 8, 10, 12, 14, 16, 18, 20, 22, 24, 26, 28, 30, 32, 34, 36, 38, 40, 42, 44, 46, 48 | 1, 2 | -| db\.r4\.large | 2 | 1 | 2 | 1 | 1, 2 | -| db\.r4\.xlarge | 4 | 2 | 2 | 1, 2 | 1, 2 | -| db\.r4\.2xlarge | 8 | 4 | 2 | 1, 2, 3, 4 | 1, 2 | -| db\.r4\.4xlarge | 16 | 8 | 2 | 1, 2, 3, 4, 5, 6, 7, 8 | 1, 2 | -| db\.r4\.8xlarge | 32 | 16 | 2 | 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16 | 1, 2 | -| db\.r4\.16xlarge | 64 | 32 | 2 | 2, 4, 6, 8, 10, 12, 14, 16, 18, 20, 22, 24, 26, 28, 30, 32 | 1, 2 | -| db\.r3\.large | 2 | 1 | 2 | 1 | 1, 2 | -| db\.r3\.xlarge | 4 | 2 | 2 | 1, 2 | 1, 2 | -| db\.r3\.2xlarge | 8 | 4 | 2 | 1, 2, 3, 4 | 1, 2 | -| db\.r3\.4xlarge | 16 | 8 | 2 | 1, 2, 3, 4, 5, 6, 7, 8 | 1, 2 | -| db\.r3\.8xlarge | 32 | 16 | 2 | 2, 4, 6, 8, 10, 12, 14, 16 | 1, 2 | -| db\.x2idn\.16xlarge | 64 | 32 | 2 | 2, 4, 6, 8, 10, 12, 14, 16, 18, 20, 22, 24, 26, 28, 30, 32 | 1, 2 | -| db\.x2idn\.24xlarge | 96 | 48 | 2 | 2, 4, 6, 8, 10, 12, 14, 16, 18, 20, 22, 24, 26, 28, 30, 32, 34, 36, 38, 40, 42, 44, 46, 48 | 1, 2 | -| db\.x2idn\.32xlarge | 128 | 64 | 2 | 2, 4, 6, 8, 10, 12, 14, 16, 18, 20, 22, 24, 26, 28, 30, 32, 34, 36, 38, 40, 42, 44, 46, 48, 50, 52, 54, 56, 58, 60, 62, 64 | 1, 2 | -| db\.x2iedn\.xlarge | 4 | 2 | 2 | 1, 2 | 1, 2 | -| db\.x2iedn\.2xlarge | 8 | 4 | 2 | 2, 4 | 1, 2 | -| db\.x2iedn\.4xlarge | 16 | 8 | 2 | 2, 4, 6, 8 | 1, 2 | -| db\.x2iedn\.8xlarge | 32 | 16 | 2 | 2, 4, 6, 8, 10, 12, 14, 16 | 1, 2 | -| db\.x2iedn\.16xlarge | 64 | 32 | 2 | 2, 4, 6, 8, 10, 12, 14, 16, 18, 20, 22, 24, 26, 28, 30, 32 | 1, 2 | -| db\.x2iedn\.24xlarge | 96 | 48 | 2 | 2, 4, 6, 8, 10, 12, 14, 16, 18, 20, 22, 24, 26, 28, 30, 32, 34, 36, 38, 40, 42, 44, 46, 48 | 1, 2 | -| db\.x2iedn\.32xlarge | 128 | 64 | 2 | 2, 4, 6, 8, 10, 12, 14, 16, 18, 20, 22, 24, 26, 28, 30, 32, 34, 36, 38, 40, 42, 44, 46, 48, 50, 52, 54, 56, 58, 60, 62, 64 | 1, 2 | -| db\.x2iezn\.2xlarge | 8 | 4 | 2 | 2, 4 | 1, 2 | -| db\.x2iezn\.4xlarge | 16 | 8 | 2 | 2, 4, 6, 8 | 1, 2 | -| db\.x2iezn\.6xlarge | 24 | 12 | 2 | 2, 4, 6, 8, 10, 12 | 1, 2 | -| db\.x2iezn\.8xlarge | 32 | 16 | 2 | 2, 4, 6, 8, 10, 12, 14, 16 | 1, 2 | -| db\.x2iezn\.12xlarge | 48 | 24 | 2 | 2, 4, 6, 8, 10, 12, 14, 16, 18, 20, 22, 24 | 1, 2 | -| db\.x1\.16xlarge | 64 | 32 | 2 | 2, 4, 6, 8, 10, 12, 14, 16, 18, 20, 22, 24, 26, 28, 30, 32 | 1, 2 | -| db\.x1\.32xlarge | 128 | 64 | 2 | 4, 8, 12, 16, 20, 24, 28, 32, 36, 40, 44, 48, 52, 56, 60, 64 | 1, 2 | -| db\.x1e\.xlarge | 4 | 2 | 2 | 1, 2 | 1, 2 | -| db\.x1e\.2xlarge | 8 | 4 | 2 | 1, 2, 3, 4 | 1, 2 | -| db\.x1e\.4xlarge | 16 | 8 | 2 | 1, 2, 3, 4, 5, 6, 7, 8 | 1, 2 | -| db\.x1e\.8xlarge | 32 | 16 | 2 | 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16 | 1, 2 | -| db\.x1e\.16xlarge | 64 | 32 | 2 | 2, 4, 6, 8, 10, 12, 14, 16, 18, 20, 22, 24, 26, 28, 30, 32 | 1, 2 | -| db\.x1e\.32xlarge | 128 | 64 | 2 | 4, 8, 12, 16, 20, 24, 28, 32, 36, 40, 44, 48, 52, 56, 60, 64 | 1, 2 | -| db\.z1d\.large | 2 | 1 | 2 | 1 | 1, 2 | -| db\.z1d\.xlarge | 4 | 2 | 2 | 2 | 1, 2 | -| db\.z1d\.2xlarge | 8 | 4 | 2 | 2, 4 | 1, 2 | -| db\.z1d\.3xlarge | 12 | 6 | 2 | 2, 4, 6 | 1, 2 | -| db\.z1d\.6xlarge | 24 | 12 | 2 | 2, 4, 6, 8, 10, 12 | 1, 2 | -| db\.z1d\.12xlarge | 48 | 24 | 2 | 4, 6, 8, 10, 12, 14, 16, 18, 20, 22, 24 | 1, 2 | - -**Note** -You can use AWS CloudTrail to monitor and audit changes to the process configuration of Amazon RDS for Oracle DB instances\. For more information about using CloudTrail, see [Monitoring Amazon RDS API calls in AWS CloudTrail](logging-using-cloudtrail.md)\. - -### Setting the CPU cores and threads per CPU core for a DB instance class - -You can configure the number of CPU cores and threads per core for the DB instance class when you perform the following operations: -+ [Creating an Amazon RDS DB instance](USER_CreateDBInstance.md) -+ [Modifying an Amazon RDS DB instance](Overview.DBInstance.Modifying.md) -+ [Restoring from a DB snapshot](USER_RestoreFromSnapshot.md) -+ [Restoring a DB instance to a specified time](USER_PIT.md) -+ [Restoring a backup into a MySQL DB instance](MySQL.Procedural.Importing.md) - -**Note** -When you modify a DB instance to configure the number of CPU cores or threads per core, there is a brief DB instance outage\. - -You can set the CPU cores and the threads per CPU core for a DB instance class using the AWS Management Console, the AWS CLI, or the RDS API\. - -#### Console - -When you are creating, modifying, or restoring a DB instance, you set the DB instance class in the AWS Management Console\. The **Instance specifications** section shows options for the processor\. The following image shows the processor features options\. - -![\[Configure processor options\]](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/images/vcpu-config.png) - -Set the following options to the appropriate values for your DB instance class under **Processor features**: -+ **Core count – **Set the number of CPU cores using this option\. The value must be equal to or less than the maximum number of CPU cores for the DB instance class\. -+ **Threads per core** – Specify **2** to enable multiple threads per core, or specify **1** to disable multiple threads per core\. - -When you modify or restore a DB instance, you can also set the CPU cores and the threads per CPU core to the defaults for the instance class\. - -When you view the details for a DB instance in the console, you can view the processor information for its DB instance class on the **Configuration** tab\. The following image shows a DB instance class with one CPU core and multiple threads per core enabled\. - -![\[View processor options\]](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/images/vcpu-view.png) - -For Oracle DB instances, the processor information only appears for Bring Your Own License \(BYOL\) DB instances\. - -#### AWS CLI - -You can set the processor features for a DB instance when you run one of the following AWS CLI commands: -+ [create\-db\-instance](https://docs.aws.amazon.com/cli/latest/reference/rds/create-db-instance.html) -+ [modify\-db\-instance](https://docs.aws.amazon.com/cli/latest/reference/rds/modify-db-instance.html) -+ [restore\-db\-instance\-from\-db\-snapshot](https://docs.aws.amazon.com/cli/latest/reference/rds/restore-db-instance-from-db-snapshot.html) -+ [restore\-db\-instance\-from\-s3](https://docs.aws.amazon.com/cli/latest/reference/rds/restore-db-instance-from-s3.html) -+ [restore\-db\-instance\-to\-point\-in\-time](https://docs.aws.amazon.com/cli/latest/reference/rds/restore-db-instance-to-point-in-time.html) - -To configure the processor of a DB instance class for a DB instance by using the AWS CLI, include the `--processor-features` option in the command\. Specify the number of CPU cores with the `coreCount` feature name, and specify whether multiple threads per core are enabled with the `threadsPerCore` feature name\. - -The option has the following syntax\. - -``` ---processor-features "Name=coreCount,Value=" "Name=threadsPerCore,Value=" -``` - -The following are examples that configure the processor: - -**Topics** -+ [Setting the number of CPU cores for a DB instance](#USER_ConfigureProcessor.CLI.Example1) -+ [Setting the number of CPU cores and disabling multiple threads for a DB instance](#USER_ConfigureProcessor.CLI.Example2) -+ [Viewing the valid processor values for a DB instance class](#USER_ConfigureProcessor.CLI.Example3) -+ [Returning to default processor settings for a DB instance](#USER_ConfigureProcessor.CLI.Example4) -+ [Returning to the default number of CPU cores for a DB instance](#USER_ConfigureProcessor.CLI.Example5) -+ [Returning to the default number of threads per core for a DB instance](#USER_ConfigureProcessor.CLI.Example6) - -##### Setting the number of CPU cores for a DB instance - -**Example** -The following example modifies `mydbinstance` by setting the number of CPU cores to 4\. The changes are applied immediately by using `--apply-immediately`\. If you want to apply the changes during the next scheduled maintenance window, omit the `--apply-immediately` option\. -For Linux, macOS, or Unix: - -``` -aws rds modify-db-instance \ - --processor-features "Name=coreCount,Value=4" \ - --apply-immediately -``` -For Windows: - -``` -aws rds modify-db-instance ^ - --processor-features "Name=coreCount,Value=4" ^ - --apply-immediately -``` - -##### Setting the number of CPU cores and disabling multiple threads for a DB instance - -**Example** -The following example modifies `mydbinstance` by setting the number of CPU cores to `4` and disabling multiple threads per core\. The changes are applied immediately by using `--apply-immediately`\. If you want to apply the changes during the next scheduled maintenance window, omit the `--apply-immediately` option\. -For Linux, macOS, or Unix: - -``` -aws rds modify-db-instance \ - --processor-features "Name=coreCount,Value=4" "Name=threadsPerCore,Value=1" \ - --apply-immediately -``` -For Windows: - -``` -aws rds modify-db-instance ^ - --processor-features "Name=coreCount,Value=4" "Name=threadsPerCore,Value=1" ^ - --apply-immediately -``` - -##### Viewing the valid processor values for a DB instance class - -**Example** -You can view the valid processor values for a particular DB instance class by running the [describe\-orderable\-db\-instance\-options](https://docs.aws.amazon.com/cli/latest/reference/rds/describe-orderable-db-instance-options.html) command and specifying the instance class for the `--db-instance-class` option\. For example, the output for the following command shows the processor options for the db\.r3\.large instance class\. - -``` -aws rds describe-orderable-db-instance-options --engine oracle-ee --db-instance-class db.r3.large -``` -Following is sample output for the command in JSON format\. - -``` - { - "SupportsIops": true, - "MaxIopsPerGib": 50.0, - "LicenseModel": "bring-your-own-license", - "DBInstanceClass": "db.r3.large", - "SupportsIAMDatabaseAuthentication": false, - "MinStorageSize": 100, - "AvailabilityZones": [ - { - "Name": "us-west-2a" - }, - { - "Name": "us-west-2b" - }, - { - "Name": "us-west-2c" - } - ], - "EngineVersion": "12.1.0.2.v2", - "MaxStorageSize": 32768, - "MinIopsPerGib": 1.0, - "MaxIopsPerDbInstance": 40000, - "ReadReplicaCapable": false, - "AvailableProcessorFeatures": [ - { - "Name": "coreCount", - "DefaultValue": "1", - "AllowedValues": "1" - }, - { - "Name": "threadsPerCore", - "DefaultValue": "2", - "AllowedValues": "1,2" - } - ], - "SupportsEnhancedMonitoring": true, - "SupportsPerformanceInsights": false, - "MinIopsPerDbInstance": 1000, - "StorageType": "io1", - "Vpc": false, - "SupportsStorageEncryption": true, - "Engine": "oracle-ee", - "MultiAZCapable": true - } -``` -In addition, you can run the following commands for DB instance class processor information: -+ [describe\-db\-instances](https://docs.aws.amazon.com/cli/latest/reference/rds/describe-db-instances.html) – Shows the processor information for the specified DB instance\. -+ [describe\-db\-snapshots](https://docs.aws.amazon.com/cli/latest/reference/rds/describe-db-snapshots.html) – Shows the processor information for the specified DB snapshot\. -+ [describe\-valid\-db\-instance\-modifications](https://docs.aws.amazon.com/cli/latest/reference/rds/describe-valid-db-instance-modifications.html) – Shows the valid modifications to the processor for the specified DB instance\. -In the output of the preceding commands, the values for the processor features are not null only if the following conditions are met: -+ You are using an RDS for Oracle DB instance\. -+ Your RDS for Oracle DB instance supports changing processor values\. -+ The current CPU core and thread settings are set to nondefault values\. -If the preceding conditions aren't met, you can get the instance type using [describe\-db\-instances](https://docs.aws.amazon.com/cli/latest/reference/rds/describe-db-instances.html)\. You can get the processor information for this instance type by running the EC2 operation [describe\-instance\-types](https://docs.aws.amazon.com/cli/latest/reference/ec2/describe-instance-types.html)\. - -##### Returning to default processor settings for a DB instance - -**Example** -The following example modifies `mydbinstance` by returning its DB instance class to the default processor values for it\. The changes are applied immediately by using `--apply-immediately`\. If you want to apply the changes during the next scheduled maintenance window, omit the `--apply-immediately` option\. -For Linux, macOS, or Unix: - -``` -aws rds modify-db-instance \ - --use-default-processor-features \ - --apply-immediately -``` -For Windows: - -``` -aws rds modify-db-instance ^ - --use-default-processor-features ^ - --apply-immediately -``` - -##### Returning to the default number of CPU cores for a DB instance - -**Example** -The following example modifies `mydbinstance` by returning its DB instance class to the default number of CPU cores for it\. The threads per core setting isn't changed\. The changes are applied immediately by using `--apply-immediately`\. If you want to apply the changes during the next scheduled maintenance window, omit the `--apply-immediately` option\. -For Linux, macOS, or Unix: - -``` -aws rds modify-db-instance \ - --processor-features "Name=coreCount,Value=DEFAULT" \ - --apply-immediately -``` -For Windows: - -``` -aws rds modify-db-instance ^ - --processor-features "Name=coreCount,Value=DEFAULT" ^ - --apply-immediately -``` - -##### Returning to the default number of threads per core for a DB instance - -**Example** -The following example modifies `mydbinstance` by returning its DB instance class to the default number of threads per core for it\. The number of CPU cores setting isn't changed\. The changes are applied immediately by using `--apply-immediately`\. If you want to apply the changes during the next scheduled maintenance window, omit the `--apply-immediately` option\. -For Linux, macOS, or Unix: - -``` -aws rds modify-db-instance \ - --processor-features "Name=threadsPerCore,Value=DEFAULT" \ - --apply-immediately -``` -For Windows: - -``` -aws rds modify-db-instance ^ - --processor-features "Name=threadsPerCore,Value=DEFAULT" ^ - --apply-immediately -``` - -#### RDS API - -You can set the processor features for a DB instance when you call one of the following Amazon RDS API operations: -+ [CreateDBInstance](https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_CreateDBInstance.html) -+ [ModifyDBInstance](https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_ModifyDBInstance.html) -+ [RestoreDBInstanceFromDBSnapshot](https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_RestoreDBInstanceFromDBSnapshot.html) -+ [RestoreDBInstanceFromS3](https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_RestoreDBInstanceFromS3.html) -+ [RestoreDBInstanceToPointInTime](https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_RestoreDBInstanceToPointInTime.html) - -To configure the processor features of a DB instance class for a DB instance by using the Amazon RDS API, include the `ProcessFeatures` parameter in the call\. - -The parameter has the following syntax\. - -``` -ProcessFeatures "Name=coreCount,Value=" "Name=threadsPerCore,Value=" -``` - -Specify the number of CPU cores with the `coreCount` feature name, and specify whether multiple threads per core are enabled with the `threadsPerCore` feature name\. - -You can view the valid processor values for a particular DB instance class by running the [DescribeOrderableDBInstanceOptions](https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_DescribeOrderableDBInstanceOptions.html) operation and specifying the instance class for the `DBInstanceClass` parameter\. You can also use the following operations: -+ [DescribeDBInstances](https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_DescribeDBInstances.html) – Shows the processor information for the specified DB instance\. -+ [DescribeDBSnapshots](https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_DescribeDBSnapshots.html) – Shows the processor information for the specified DB snapshot\. -+ [DescribeValidDBInstanceModifications](https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_DescribeValidDBInstanceModifications.html) – Shows the valid modifications to the processor for the specified DB instance\. - -In the output of the preceding operations, the values for the processor features are not null only if the following conditions are met: -+ You are using an RDS for Oracle DB instance\. -+ Your RDS for Oracle DB instance supports changing processor values\. -+ The current CPU core and thread settings are set to nondefault values\. - -If the preceding conditions aren't met, you can get the instance type using [DescribeDBInstances](https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_DescribeDBInstances.html)\. You can get the processor information for this instance type by running the EC2 operation [DescribeInstanceTypes](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribeInstanceTypes.html)\. - -## Hardware specifications for DB instance classes - -The following terminology is used to describe hardware specifications for DB instance classes: - -**vCPU** -The number of virtual central processing units \(CPUs\)\. A *virtual CPU *is a unit of capacity that you can use to compare DB instance classes\. Instead of purchasing or leasing a particular processor to use for several months or years, you are renting capacity by the hour\. Our goal is to make a consistent and specific amount of CPU capacity available, within the limits of the actual underlying hardware\. - -**ECU** -The relative measure of the integer processing power of an Amazon EC2 instance\. To make it easy for developers to compare CPU capacity between different instance classes, we have defined an Amazon EC2 Compute Unit\. The amount of CPU that is allocated to a particular instance is expressed in terms of these EC2 Compute Units\. One ECU currently provides CPU capacity equivalent to a 1\.0–1\.2 GHz 2007 Opteron or 2007 Xeon processor\. - -**Memory \(GiB\)** -The RAM, in gibibytes, allocated to the DB instance\. There is often a consistent ratio between memory and vCPU\. As an example, take the db\.r4 instance class, which has a memory to vCPU ratio similar to the db\.r5 instance class\. However, for most use cases the db\.r5 instance class provides better, more consistent performance than the db\.r4 instance class\. - -**EBS\-optimized** -The DB instance uses an optimized configuration stack and provides additional, dedicated capacity for I/O\. This optimization provides the best performance by minimizing contention between I/O and other traffic from your instance\. For more information about Amazon EBS–optimized instances, see [Amazon EBS–Optimized instances](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/EBSOptimized.html) in the *Amazon EC2 User Guide for Linux Instances\.* -EBS\-optimized instances have a baseline and maximum IOPS rate\. The maximum IOPS rate is enforced at the DB instance level\. A set of EBS volumes that combine to have an IOPS rate that is higher than the maximum can't exceed the instance\-level threshold\. For example, if the maximum IOPS for a particular DB instance class is 40,000, and you attach four 64,000 IOPS EBS volumes, the maximum IOPS is 40,000 rather than 256,000\. For the IOPS maximum specific to each EC2 instance type, see [Supported instance types](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ebs-optimized.html#ebs-optimization-support) in the *Amazon EC2 User Guide for Linux Instances*\. - -**Max\. EBS bandwidth \(Mbps\)** -The maximum EBS bandwidth in megabits per second\. Divide by 8 to get the expected throughput in megabytes per second\. -General Purpose SSD \(gp2\) volumes for Amazon RDS DB instances have a throughput limit of 250 MiB/s in most cases\. However, the throughput limit can vary depending on volume size\. For more information, see [Amazon EBS volume types](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/EBSVolumeTypes.html) in the *Amazon EC2 User Guide for Linux Instances\.* - -**Network bandwidth** -The network speed relative to other DB instance classes\. - -In the following table, you can find hardware details about the Amazon RDS DB instance classes\. - -For information about Amazon RDS DB engine support for each DB instance class, see [Supported DB engines for DB instance classes](#Concepts.DBInstanceClass.Support)\. - - -| Instance class | vCPU | ECU | Memory \(GiB\) | EBS optimized | Max\. EBS bandwidth \(Mbps\) | Network bandwidth \(Gbps\) | -| --- | --- | --- | --- | --- | --- | --- | -| db\.m7g – general\-purpose instance classes powered by AWS Graviton3 processors | -| db\.m7g\.16xlarge | 64 | — | 256 | Yes | 20,000 | 30 | -| db\.m7g\.12xlarge | 48 | — | 192 | Yes | 15,000 | 22\.5 | -| db\.m7g\.8xlarge | 32 | — | 128 | Yes | 10,000 | 15 | -| db\.m7g\.4xlarge | 16 | — | 64 | Yes | Up to 10,000 | Up to 15 | -| db\.m7g\.2xlarge\* | 8 | — | 32 | Yes | Up to 10,000 | Up to 15 | -| db\.m7g\.xlarge\* | 4 | — | 16 | Yes | Up to 10,000 | Up to 12\.5 | -| db\.m7g\.large\* | 2 | — | 8 | Yes | Up to 10,000 | Up to 12\.5 | -| db\.m6g – general\-purpose instance classes powered by AWS Graviton2 processors | -| db\.m6g\.16xlarge | 64 | — | 256 | Yes | 19,000 | 25 | -| db\.m6g\.12xlarge | 48 | — | 192 | Yes | 13,500 | 20 | -| db\.m6g\.8xlarge | 32 | — | 128 | Yes | 9,500 | 12 | -| db\.m6g\.4xlarge | 16 | — | 64 | Yes | 6,800 | Up to 10 | -| db\.m6g\.2xlarge\* | 8 | — | 32 | Yes | Up to 4,750 | Up to 10 | -| db\.m6g\.xlarge\* | 4 | — | 16 | Yes | Up to 4,750 | Up to 10 | -| db\.m6g\.large\* | 2 | — | 8 | Yes | Up to 4,750 | Up to 10 | -| db\.m6gd | -| db\.m6gd\.16xlarge | 64 | — | 256 | Yes | 19,000 | 25 | -| db\.m6gd\.12xlarge | 48 | — | 192 | Yes | 13,500 | 20 | -| db\.m6gd\.8xlarge | 32 | — | 128 | Yes | 9,000 | 12 | -| db\.m6gd\.4xlarge | 16 | — | 64 | Yes | 4,750 | Up to 10 | -| db\.m6gd\.2xlarge | 8 | — | 32 | Yes | Up to 4,750 | Up to 10 | -| db\.m6gd\.xlarge | 4 | — | 16 | Yes | Up to 4,750 | Up to 10 | -| db\.m6gd\.large | 2 | — | 8 | Yes | Up to 4,750 | Up to 10 | -| db\.m6i – general\-purpose instance classes | -| db\.m6i\.32xlarge | 128 | — | 512 | Yes | 50,000 | 40 | -| db\.m6i\.24xlarge | 96 | — | 384 | Yes | 37,500 | 30 | -| db\.m6i\.16xlarge | 64 | — | 256 | Yes | 25,000 | 20 | -| db\.m6i\.12xlarge | 48 | — | 192 | Yes | 18,750 | 15 | -| db\.m6i\.8xlarge | 32 | — | 128 | Yes | 12,500 | 10 | -| db\.m6i\.4xlarge\* | 16 | — | 64 | Yes | Up to 12,500 | Up to 10 | -| db\.m6i\.2xlarge\* | 8 | — | 32 | Yes | Up to 12,500 | Up to 10 | -| db\.m6i\.xlarge\* | 4 | — | 16 | Yes | Up to 12,500 | Up to 10 | -| db\.m6i\.large\* | 2 | — | 8 | Yes | Up to 12,500 | Up to 10 | -| db\.m5d – general\-purpose instance classes | -| db\.m5d\.24xlarge | 96 | 345 | 384 | Yes | 19,000 | 25 | -| db\.m5d\.16xlarge | 64 | 262 | 256 | Yes | 13,600 | 20 | -| db\.m5d\.12xlarge | 48 | 173 | 192 | Yes | 9,500 | 10 | -| db\.m5d\.8xlarge | 32 | 131 | 128 | Yes | 6,800 | 10 | -| db\.m5d\.4xlarge | 16 | 61 | 64 | Yes | 4,750 | Up to 10 | -| db\.m5d\.2xlarge\* | 8 | 31 | 32 | Yes | Up to 4,750 | Up to 10 | -| db\.m5d\.xlarge\* | 4 | 15 | 16 | Yes | Up to 4,750 | Up to 10 | -| db\.m5d\.large\* | 2 | 10 | 8 | Yes | Up to 4,750 | Up to 10 | -| db\.m5 – general\-purpose instance classes | -| db\.m5\.24xlarge | 96 | 345 | 384 | Yes | 19,000 | 25 | -| db\.m5\.16xlarge | 64 | 262 | 256 | Yes | 13,600 | 20 | -| db\.m5\.12xlarge | 48 | 173 | 192 | Yes | 9,500 | 10 | -| db\.m5\.8xlarge | 32 | 131 | 128 | Yes | 6,800 | 10 | -| db\.m5\.4xlarge | 16 | 61 | 64 | Yes | 4,750 | Up to 10 | -| db\.m5\.2xlarge\* | 8 | 31 | 32 | Yes | Up to 4,750 | Up to 10 | -| db\.m5\.xlarge\* | 4 | 15 | 16 | Yes | Up to 4,750 | Up to 10 | -| db\.m5\.large\* | 2 | 10 | 8 | Yes | Up to 4,750 | Up to 10 | -| db\.m4 – general\-purpose instance classes | -| db\.m4\.16xlarge | 64 | 188 | 256 | Yes | 10,000 | 25 | -| db\.m4\.10xlarge | 40 | 124\.5 | 160 | Yes | 4,000 | 10 | -| db\.m4\.4xlarge | 16 | 53\.5 | 64 | Yes | 2,000 | High | -| db\.m4\.2xlarge | 8 | 25\.5 | 32 | Yes | 1,000 | High | -| db\.m4\.xlarge | 4 | 13 | 16 | Yes | 750 | High | -| db\.m4\.large | 2 | 6\.5 | 8 | Yes | 450 | Moderate | -| db\.m3 – general\-purpose instance classes | -| db\.m3\.2xlarge | 8 | 26 | 30 | Yes | 1,000 | High | -| db\.m3\.xlarge | 4 | 13 | 15 | Yes | 500 | High | -| db\.m3\.large | 2 | 6\.5 | 7\.5 | No | — | Moderate | -| db\.m3\.medium | 1 | 3 | 3\.75 | No | — | Moderate | -| db\.m1 – general\-purpose instance classes | -| db\.m1\.xlarge | 4 | 4 | 15 | Yes | 450 | High | -| db\.m1\.large | 2 | 2 | 7\.5 | Yes | 450 | Moderate | -| db\.m1\.medium | 1 | 1 | 3\.75 | No | — | Moderate | -| db\.m1\.small | 1 | 1 | 1\.7 | No | — | Very Low | -| db\.x2iezn – memory\-optimized instance classes | -| db\.x2iezn\.12xlarge | >48 | — | 1,536 | Yes | 19,000 | 100 | -| db\.x2iezn\.8xlarge | 32 | — | 1,024 | Yes | 12,000 | 75 | -| db\.x2iezn\.6xlarge | 24 | — | 768 | Yes | Up to 9,500 | 50 | -| db\.x2iezn\.4xlarge | 16 | — | 512 | Yes | Up to 4,750 | Up to 25 | -| db\.x2iezn\.2xlarge | 8 | — | 256 | Yes | Up to 3,170 | Up to 25 | -| db\.x2iedn – memory\-optimized instance classes | -| db\.x2iedn\.32xlarge | 128 | — | 4,096 | Yes | 80,000 | 100 | -| db\.x2iedn\.24xlarge | 96 | — | 3,072 | Yes | 60,000 | 75 | -| db\.x2iedn\.16xlarge | 64 | — | 2,048 | Yes | 40,000 | 50 | -| db\.x2iedn\.8xlarge | 32 | — | 1,024 | Yes | 20,000 | 25 | -| db\.x2iedn\.4xlarge | 16 | — | 512 | Yes | Up to 20,000 | Up to 25 | -| db\.x2iedn\.2xlarge | 8 | — | 256 | Yes | Up to 20,000 | Up to 25 | -| db\.x2iedn\.xlarge | 4 | — | 128 | Yes | Up to 20,000 | Up to 25 | -| db\.x2idn – memory\-optimized instance classes | -| db\.x2idn\.32xlarge | 128 | — | 2,048 | Yes | 80,000 | 100 | -| db\.x2idn\.24xlarge | 96 | — | 1,536 | Yes | 60,000 | 75 | -| db\.x2idn\.16xlarge | 64 | — | 1,024 | Yes | 40,000 | 50 | -| db\.x2g – memory\-optimized instance classes | -| db\.x2g\.16xlarge | 64 | — | 1024 | Yes | 19,000 | 25 | -| db\.x2g\.12xlarge | 48 | — | 768 | Yes | 14,250 | 20 | -| db\.x2g\.8xlarge | 32 | — | 512 | Yes | 9,500 | 12 | -| db\.x2g\.4xlarge | 16 | — | 256 | Yes | 4,750 | Up to 10 | -| db\.x2g\.2xlarge | 8 | — | 128 | Yes | Up to 4,750 | Up to 10 | -| db\.x2g\.xlarge | 4 | — | 64 | Yes | Up to 4,750 | Up to 10 | -| db\.x2g\.large | 2 | — | 32 | Yes | Up to 4,750 | Up to 10 | -| db\.z1d – memory\-optimized instance classes | -| db\.z1d\.12xlarge | 48 | 271 | 384 | Yes | 14,000 | 25 | -| db\.z1d\.6xlarge | 24 | 134 | 192 | Yes | 7,000 | 10 | -| db\.z1d\.3xlarge | 12 | 75 | 96 | Yes | 3,500 | Up to 10 | -| db\.z1d\.2xlarge | 8 | 53 | 64 | Yes | 2,333 | Up to 10 | -| db\.z1d\.xlarge\* | 4 | 28 | 32 | Yes | Up to 2,333 | Up to 10 | -| db\.z1d\.large\* | 2 | 15 | 16 | Yes | Up to 2,333 | Up to 10 | -| db\.x1e – memory\-optimized instance classes | -| db\.x1e\.32xlarge | 128 | 340 | 3,904 | Yes | 14,000 | 25 | -| db\.x1e\.16xlarge | 64 | 179 | 1,952 | Yes | 7,000 | 10 | -| db\.x1e\.8xlarge | 32 | 91 | 976 | Yes | 3,500 | Up to 10 | -| db\.x1e\.4xlarge | 16 | 47 | 488 | Yes | 1,750 | Up to 10 | -| db\.x1e\.2xlarge | 8 | 23 | 244 | Yes | 1,000 | Up to 10 | -| db\.x1e\.xlarge | 4 | 12 | 122 | Yes | 500 | Up to 10 | -| db\.x1 – memory\-optimized instance classes | -| db\.x1\.32xlarge | 128 | 349 | 1,952 | Yes | 14,000 | 25 | -| db\.x1\.16xlarge | 64 | 174\.5 | 976 | Yes | 7,000 | 10 | -| db\.r7g – memory\-optimized instance classes powered by AWS Graviton3 processors | -| db\.r7g\.16xlarge | 64 | — | 512 | Yes | 20,000 | 30 | -| db\.r7g\.12xlarge | 48 | — | 384 | Yes | 15,000 | 22\.5 | -| db\.r7g\.8xlarge | 32 | — | 256 | Yes | 10,000 | 15 | -| db\.r7g\.4xlarge | 16 | — | 128 | Yes | Up to 10,000 | Up to 15 | -| db\.r7g\.2xlarge\* | 8 | — | 64 | Yes | Up to 10,000 | Up to 15 | -| db\.r7g\.xlarge\* | 4 | — | 32 | Yes | Up to 10,000 | Up to 12\.5 | -| db\.r7g\.large\* | 2 | — | 16 | Yes | Up to 10,000 | Up to 12\.5 | -| db\.r6g – memory\-optimized instance classes powered by AWS Graviton2 processors | -| db\.r6g\.16xlarge | 64 | — | 512 | Yes | 19,000 | 25 | -| db\.r6g\.12xlarge | 48 | — | 384 | Yes | 13,500 | 20 | -| db\.r6g\.8xlarge | 32 | — | 256 | Yes | 9,000 | 12 | -| db\.r6g\.4xlarge | 16 | — | 128 | Yes | 4,750 | Up to 10 | -| db\.r6g\.2xlarge\* | 8 | — | 64 | Yes | Up to 4,750 | Up to 10 | -| db\.r6g\.xlarge\* | 4 | — | 32 | Yes | Up to 4,750 | Up to 10 | -| db\.r6g\.large\* | 2 | — | 16 | Yes | Up to 4,750 | Up to 10 | -| db\.r6gd | -| db\.r6gd\.16xlarge | 64 | — | 512 | Yes | 19,000 | 25 | -| db\.r6gd\.12xlarge | 48 | — | 384 | Yes | 13,500 | 20 | -| db\.r6gd\.8xlarge | 32 | — | 256 | Yes | 9,000 | 12 | -| db\.r6gd\.4xlarge | 16 | — | 128 | Yes | 4,750 | Up to 10 | -| db\.r6gd\.2xlarge | 8 | — | 64 | Yes | Up to 4,750 | Up to 10 | -| db\.r6gd\.xlarge | 4 | — | 32 | Yes | Up to 4,750 | Up to 10 | -| db\.r6gd\.large | 2 | — | 16 | Yes | Up to 4,750 | Up to 10 | -| db\.r6i – memory\-optimized instance classes | -| db\.r6i\.32xlarge | 128 | — | 1,024 | Yes | 40,000 | 50 | -| db\.r6i\.24xlarge | 96 | — | 768 | Yes | 30,000 | 37\.5 | -| db\.r6i\.16xlarge | 64 | — | 512 | Yes | 20,000 | 25 | -| db\.r6i\.12xlarge | 48 | — | 384 | Yes | 15,000 | 18\.75 | -| db\.r6i\.8xlarge | 32 | — | 256 | Yes | 10,000 | 12\.5 | -| db\.r6i\.4xlarge\* | 16 | — | 128 | Yes | Up to 10,000 | Up to 12\.5 | -| db\.r6i\.2xlarge\* | 8 | — | 64 | Yes | Up to 10,000 | Up to 12\.5 | -| db\.r6i\.xlarge\* | 4 | — | 32 | Yes | Up to 10,000 | Up to 12\.5 | -| db\.r6i\.large\* | 2 | — | 16 | Yes | Up to 10,000 | Up to 12\.5 | -| db\.r5d – memory\-optimized instance classes | -| db\.r5d\.24xlarge | 96 | 347 | 768 | Yes | 19,000 | 25 | -| db\.r5d\.16xlarge | 64 | 264 | 512 | Yes | 13,600 | 20 | -| db\.r5d\.12xlarge | 48 | 173 | 384 | Yes | 9,500 | 10 | -| db\.r5d\.8xlarge | 32 | 132 | 256 | Yes | 6,800 | 10 | -| db\.r5d\.4xlarge | 16 | 71 | 128 | Yes | 4,750 | Up to 10 | -| db\.r5d\.2xlarge\* | 8 | 38 | 64 | Yes | Up to 4,750 | Up to 10 | -| db\.r5d\.xlarge\* | 4 | 19 | 32 | Yes | Up to 4,750 | Up to 10 | -| db\.r5d\.large\* | 2 | 10 | 16 | Yes | Up to 4,750 | Up to 10 | -| db\.r5b – memory\-optimized instance classes | -| db\.r5b\.24xlarge | 96 | 347 | 768 | Yes | 60,000 | 25 | -| db\.r5b\.16xlarge | 64 | 264 | 512 | Yes | 40,000 | 20 | -| db\.r5b\.12xlarge | 48 | 173 | 384 | Yes | 30,000 | 10 | -| db\.r5b\.8xlarge | 32 | 132 | 256 | Yes | 20,000 | 10 | -| db\.r5b\.4xlarge | 16 | 71 | 128 | Yes | 10,000 | Up to 10 | -| db\.r5b\.2xlarge\* | 8 | 38 | 64 | Yes | Up to 10,000 | Up to 10 | -| db\.r5b\.xlarge\* | 4 | 19 | 32 | Yes | Up to 10,000 | Up to 10 | -| db\.r5b\.large\* | 2 | 10 | 16 | Yes | Up to 10,000 | Up to 10 | -| db\.r5b – Oracle memory\-optimized instance classes preconfigured for high memory, storage, and I/O | -| db\.r5b\.8xlarge\.tpc2\.mem3x | 32 | — | 768 | Yes | 60,000 | 25 | -| db\.r5b\.6xlarge\.tpc2\.mem4x | 24 | — | 768 | Yes | 60,000 | 25 | -| db\.r5b\.4xlarge\.tpc2\.mem4x | 16 | — | 512 | Yes | 40,000 | 20 | -| db\.r5b\.4xlarge\.tpc2\.mem3x | 16 | — | 384 | Yes | 30,000 | 10 | -| db\.r5b\.4xlarge\.tpc2\.mem2x | 16 | — | 256 | Yes | 20,000 | 10 | -| db\.r5b\.2xlarge\.tpc2\.mem8x | 8 | — | 512 | Yes | 40,000 | 20 | -| db\.r5b\.2xlarge\.tpc2\.mem4x | 8 | — | 256 | Yes | 20,000 | 10 | -| db\.r5b\.2xlarge\.tpc1\.mem2x | 8 | — | 128 | Yes | 10,000 | Up to 10 | -| db\.r5b\.xlarge\.tpc2\.mem4x | 4 | — | 128 | Yes | 10,000 | Up to 10 | -| db\.r5b\.xlarge\.tpc2\.mem2x | 4 | — | 64 | Yes | Up to 10,000 | Up to 10 | -| db\.r5b\.large\.tpc1\.mem2x | 2 | — | 32 | Yes | Up to 10,000 | Up to 10 | -| db\.r5 – memory\-optimized instance classes | -| db\.r5\.24xlarge | 96 | 347 | 768 | Yes | 19,000 | 25 | -| db\.r5\.16xlarge | 64 | 264 | 512 | Yes | 13,600 | 20 | -| db\.r5\.12xlarge | 48 | 173 | 384 | Yes | 9,500 | 10 | -| db\.r5\.8xlarge | 32 | 132 | 256 | Yes | 6,800 | 10 | -| db\.r5\.4xlarge | 16 | 71 | 128 | Yes | 4,750 | Up to 10 | -| db\.r5\.2xlarge\* | 8 | 38 | 64 | Yes | Up to 4,750 | Up to 10 | -| db\.r5\.xlarge\* | 4 | 19 | 32 | Yes | Up to 4,750 | Up to 10 | -| db\.r5\.large\* | 2 | 10 | 16 | Yes | Up to 4,750 | Up to 10 | -| db\.r5 – Oracle memory\-optimized instance classes preconfigured for high memory, storage, and I/O | -| db\.r5\.12xlarge\.tpc2\.mem2x | 48 | — | 768 | Yes | 19,000 | 25 | -| db\.r5\.8xlarge\.tpc2\.mem3x | 32 | — | 768 | Yes | 19,000 | 25 | -| db\.r5\.6xlarge\.tpc2\.mem4x | 24 | — | 768 | Yes | 19,000 | 25 | -| db\.r5\.4xlarge\.tpc2\.mem4x | 16 | — | 512 | Yes | 13,600 | 20 | -| db\.r5\.4xlarge\.tpc2\.mem3x | 16 | — | 384 | Yes | 9,500 | 10 | -| db\.r5\.4xlarge\.tpc2\.mem2x | 16 | — | 256 | Yes | 6,800 | 10 | -| db\.r5\.2xlarge\.tpc2\.mem8x | 8 | — | 512 | Yes | 13,600 | 20 | -| db\.r5\.2xlarge\.tpc2\.mem4x | 8 | — | 256 | Yes | 6,800 | 10 | -| db\.r5\.2xlarge\.tpc1\.mem2x | 8 | — | 128 | Yes | 4,750 | Up to 10 | -| db\.r5\.xlarge\.tpc2\.mem4x | 4 | — | 128 | Yes | 4,750 | Up to 10 | -| db\.r5\.xlarge\.tpc2\.mem2x | 4 | — | 64 | Yes | Up to 4,750 | Up to 10 | -| db\.r5\.large\.tpc1\.mem2x | 2 | — | 32 | Yes | Up to 4,750 | Up to 10 | -| db\.r4 – memory\-optimized instance classes | -| db\.r4\.16xlarge | 64 | 195 | 488 | Yes | 14,000 | 25 | -| db\.r4\.8xlarge | 32 | 99 | 244 | Yes | 7,000 | 10 | -| db\.r4\.4xlarge | 16 | 53 | 122 | Yes | 3,500 | Up to 10 | -| db\.r4\.2xlarge | 8 | 27 | 61 | Yes | 1,700 | Up to 10 | -| db\.r4\.xlarge | 4 | 13\.5 | 30\.5 | Yes | 850 | Up to 10 | -| db\.r4\.large | 2 | 7 | 15\.25 | Yes | 425 | Up to 10 | -| db\.r3 – memory\-optimized instance classes | -| db\.r3\.8xlarge | 32 | 104 | 244 | No | — | 10 | -| db\.r3\.4xlarge | 16 | 52 | 122 | Yes | 2,000 | High | -| db\.r3\.2xlarge | 8 | 26 | 61 | Yes | 1,000 | High | -| db\.r3\.xlarge | 4 | 13 | 30\.5 | Yes | 500 | Moderate | -| db\.r3\.large | 2 | 6\.5 | 15\.25 | No | — | Moderate | -| db\.t4g – burstable\-performance instance classes | -| db\.t4g\.2xlarge\* | 8 | — | 32 | Yes | Up to 2,780 | Up to 5 | -| db\.t4g\.xlarge\* | 4 | — | 16 | Yes | Up to 2,780 | Up to 5 | -| db\.t4g\.large\* | 2 | — | 8 | Yes | Up to 2,780 | Up to 5 | -| db\.t4g\.medium\* | 2 | — | 4 | Yes | Up to 2,085 | Up to 5 | -| db\.t4g\.small\* | 2 | — | 2 | Yes | Up to 2,085 | Up to 5 | -| db\.t4g\.micro\* | 2 | — | 1 | Yes | Up to 2,085 | Up to 5 | -| db\.t3 – burstable\-performance instance classes | -| db\.t3\.2xlarge\* | 8 | Variable | 32 | Yes | Up to 2,048 | Up to 5 | -| db\.t3\.xlarge\* | 4 | Variable | 16 | Yes | Up to 2,048 | Up to 5 | -| db\.t3\.large\* | 2 | Variable | 8 | Yes | Up to 2,048 | Up to 5 | -| db\.t3\.medium\* | 2 | Variable | 4 | Yes | Up to 1,536 | Up to 5 | -| db\.t3\.small\* | 2 | Variable | 2 | Yes | Up to 1,536 | Up to 5 | -| db\.t3\.micro\* | 2 | Variable | 1 | Yes | Up to 1,536 | Up to 5 | -| db\.t2 – burstable\-performance instance classes | -| db\.t2\.2xlarge | 8 | Variable | 32 | No | — | Moderate | -| db\.t2\.xlarge | 4 | Variable | 16 | No | — | Moderate | -| db\.t2\.large | 2 | Variable | 8 | No | — | Moderate | -| db\.t2\.medium | 2 | Variable | 4 | No | — | Moderate | -| db\.t2\.small | 1 | Variable | 2 | No | — | Low | -| db\.t2\.micro | 1 | Variable | 1 | No | — | Low | - -\* These DB instance classes can support maximum performance for 30 minutes at least once every 24 hours\. For more information on baseline performance of the underlying EC2 instance types, see [Amazon EBS\-optimized instances](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/EBSOptimized.html) in the *Amazon EC2 User Guide for Linux Instances\.* - -\*\* The r3\.8xlarge DB instance class doesn't have dedicated EBS bandwidth and therefore doesn't offer EBS optimization\. For this instance class, network traffic and Amazon EBS traffic share the same 10\-gigabit network interface\. \ No newline at end of file diff --git a/doc_source/Concepts.MultiAZ.md b/doc_source/Concepts.MultiAZ.md deleted file mode 100644 index 4a8c084..0000000 --- a/doc_source/Concepts.MultiAZ.md +++ /dev/null @@ -1,25 +0,0 @@ -# Configuring and managing a Multi\-AZ deployment - -Multi\-AZ deployments can have one standby or two standby DB instances\. When the deployment has one standby DB instance, it's called a *Multi\-AZ DB instance deployment*\. A Multi\-AZ DB instance deployment has one standby DB instance that provides failover support, but doesn't serve read traffic\. When the deployment has two standby DB instances, it's called a *Multi\-AZ DB cluster deployment*\. A Multi\-AZ DB cluster deployment has standby DB instances that provide failover support and can also serve read traffic\. - -You can use the AWS Management Console to determine whether a Multi\-AZ deployment is a Multi\-AZ DB instance deployment or a Multi\-AZ DB cluster deployment\. In the navigation pane, choose **Databases**, and then choose a **DB identifier**\. -+ A Multi\-AZ DB instance deployment has the following characteristics: - + There is only one row for the DB instance\. - + The value of **Role** is **Instance** or **Primary**\. - + The value of **Multi\-AZ** is **Yes**\. -+ A Multi\-AZ DB cluster deployment has the following characteristics: - + There is a cluster\-level row with three DB instance rows under it\. - + For the cluster\-level row, the value of **Role** is **Multi\-AZ DB cluster**\. - + For each instance\-level row, the value of **Role** is **Writer instance** or **Reader instance**\. - + For each instance\-level row, the value of **Multi\-AZ** is **3 Zones**\. - -**Topics** -+ [Multi\-AZ DB instance deployments](Concepts.MultiAZSingleStandby.md) -+ [Multi\-AZ DB cluster deployments](multi-az-db-clusters-concepts.md) - -In addition, the following topics apply to both DB instances and Multi\-AZ DB clusters: -+ [Tagging Amazon RDS resources](USER_Tagging.md) -+ [Working with Amazon Resource Names \(ARNs\) in Amazon RDS](USER_Tagging.ARN.md) -+ [Working with storage for Amazon RDS DB instances](USER_PIOPS.StorageTypes.md) -+ [Maintaining a DB instance](USER_UpgradeDBInstance.Maintenance.md) -+ [Upgrading a DB instance engine version](USER_UpgradeDBInstance.Upgrading.md) \ No newline at end of file diff --git a/doc_source/Concepts.MultiAZSingleStandby.md b/doc_source/Concepts.MultiAZSingleStandby.md deleted file mode 100644 index d398b71..0000000 --- a/doc_source/Concepts.MultiAZSingleStandby.md +++ /dev/null @@ -1,122 +0,0 @@ -# Multi\-AZ DB instance deployments - -Amazon RDS provides high availability and failover support for DB instances using Multi\-AZ deployments with a single standby DB instance\. This type of deployment is called a *Multi\-AZ DB instance deployment*\. Amazon RDS uses several different technologies to provide this failover support\. Multi\-AZ deployments for MariaDB, MySQL, Oracle, PostgreSQL, and RDS Custom for SQL Server DB instances use the Amazon failover technology\. Microsoft SQL Server DB instances use SQL Server Database Mirroring \(DBM\) or Always On Availability Groups \(AGs\)\. For information on SQL Server version support for Multi\-AZ, see [Multi\-AZ deployments for Amazon RDS for Microsoft SQL Server](USER_SQLServerMultiAZ.md)\. For information on working with RDS Custom for SQL Server for Multi\-AZ, see [Managing a Multi\-AZ deployment for RDS Custom for SQL Server](custom-sqlserver-multiaz.md)\. - -In a Multi\-AZ DB instance deployment, Amazon RDS automatically provisions and maintains a synchronous standby replica in a different Availability Zone\. The primary DB instance is synchronously replicated across Availability Zones to a standby replica to provide data redundancy and minimize latency spikes during system backups\. Running a DB instance with high availability can enhance availability during planned system maintenance\. It can also help protect your databases against DB instance failure and Availability Zone disruption\. For more information on Availability Zones, see [Regions, Availability Zones, and Local Zones](Concepts.RegionsAndAvailabilityZones.md)\. - -**Note** -The high availability option isn't a scaling solution for read\-only scenarios\. You can't use a standby replica to serve read traffic\. To serve read\-only traffic, use a Multi\-AZ DB cluster or a read replica instead\. For more information about Multi\-AZ DB clusters, see [Multi\-AZ DB cluster deployments](multi-az-db-clusters-concepts.md)\. For more information about read replicas, see [Working with DB instance read replicas](USER_ReadRepl.md)\. - -![\[High availability scenario\]](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/images/con-multi-AZ.png) - -Using the RDS console, you can create a Multi\-AZ DB instance deployment by simply specifying Multi\-AZ when creating a DB instance\. You can use the console to convert existing DB instances to Multi\-AZ DB instance deployments by modifying the DB instance and specifying the Multi\-AZ option\. You can also specify a Multi\-AZ DB instance deployment with the AWS CLI or Amazon RDS API\. Use the [create\-db\-instance](https://docs.aws.amazon.com/cli/latest/reference/rds/create-db-instance.html) or [modify\-db\-instance](https://docs.aws.amazon.com/cli/latest/reference/rds/modify-db-instance.html) CLI command, or the [CreateDBInstance](https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_CreateDBInstance.html) or [ModifyDBInstance](https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_ModifyDBInstance.html) API operation\. - -The RDS console shows the Availability Zone of the standby replica \(called the secondary AZ\)\. You can also use the [describe\-db\-instances](https://docs.aws.amazon.com/cli/latest/reference/rds/describe-db-instances.html) CLI command or the [DescribeDBInstances](https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_DescribeDBInstances.html) API operation to find the secondary AZ\. - -DB instances using Multi\-AZ DB instance deployments can have increased write and commit latency compared to a Single\-AZ deployment\. This can happen because of the synchronous data replication that occurs\. You might have a change in latency if your deployment fails over to the standby replica, although AWS is engineered with low\-latency network connectivity between Availability Zones\. For production workloads, we recommend that you use Provisioned IOPS \(input/output operations per second\) for fast, consistent performance\. For more information about DB instance classes, see [DB instance classes](Concepts.DBInstanceClass.md)\. - -## Modifying a DB instance to be a Multi\-AZ DB instance deployment - -If you have a DB instance in a Single\-AZ deployment and modify it to a Multi\-AZ DB instance deployment \(for engines other than Amazon Aurora\), Amazon RDS performs several actions: - -1. Takes a snapshot of the primary DB instance's Amazon Elastic Block Store \(EBS\) volumes\. - -1. Creates new volumes for the standby replica from the snapshot\. These volumes initialize in the background, and maximum volume performance is achieved after the data is fully initialized\. - -1. Turns on synchronous block\-level replication between the volumes of the primary and standby replicas\. - -**Important** -Using a snapshot to create the standby instance avoids downtime when you convert from Single\-AZ to Multi\-AZ, but you can experience a performance impact during and after converting to Multi\-AZ\. This impact can be significant for workloads that are sensitive to write latency\. -While this capability lets large volumes be restored from snapshots quickly, it can cause a significant increase in the latency of I/O operations because of the synchronous replication\. This latency can impact your database performance\. We highly recommend as a best practice not to perform Multi\-AZ conversion on a production DB instance\. -To avoid the performance impact on the DB instance currently serving the sensitive workload, create a read replica and enable backups on the read replica\. Convert the read replica to Multi\-AZ, and run queries that load the data into the read replica's volumes \(on both AZs\)\. Then promote the read replica to be the primary DB instance\. For more information, see [Working with DB instance read replicas](USER_ReadRepl.md)\. - -There are two ways to modify a DB instance to be a Multi\-AZ DB instance deployment: - -**Topics** -+ [Convert to a Multi\-AZ DB instance deployment with the RDS console](#Concepts.MultiAZ.Migrating.Convert) -+ [Modifying a DB instance to be a Multi\-AZ DB instance deployment](#Concepts.MultiAZ.Migrating.Modify) - -### Convert to a Multi\-AZ DB instance deployment with the RDS console - -You can use the RDS console to convert a DB instance to a Multi\-AZ DB instance deployment\. - -You can only use the console to complete the conversion\. To use the AWS CLI or RDS API, follow the instructions in [Modifying a DB instance to be a Multi\-AZ DB instance deployment](#Concepts.MultiAZ.Migrating.Modify)\. - -**To convert to a Multi\-AZ DB instance deployment with the RDS console** - -1. Sign in to the AWS Management Console and open the Amazon RDS console at [https://console\.aws\.amazon\.com/rds/](https://console.aws.amazon.com/rds/)\. - -1. In the navigation pane, choose **Databases**, and then choose the DB instance that you want to modify\. - -1. From **Actions**, choose **Convert to Multi\-AZ deployment**\. - -1. On the confirmation page, choose **Apply immediately** to apply the changes immediately\. Choosing this option doesn't cause downtime, but there is a possible performance impact\. Alternatively, you can choose to apply the update during the next maintenance window\. For more information, see [Using the Apply Immediately setting](Overview.DBInstance.Modifying.md#USER_ModifyInstance.ApplyImmediately)\. - -1. Choose **Convert to Multi\-AZ**\. - -### Modifying a DB instance to be a Multi\-AZ DB instance deployment - -You can modify a DB instance to be a MultiAZ DB instance deployment in the following ways: -+ Using the RDS console, modify the DB instance, and set **Multi\-AZ deployment** to **Yes**\. -+ Using the AWS CLI, call the [modify\-db\-instance](https://docs.aws.amazon.com/cli/latest/reference/rds/modify-db-instance.html) command, and set the `--multi-az` option\. -+ Using the RDS API, call the [ModifyDBInstance](https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_ModifyDBInstance.html) operation, and set the `MultiAZ` parameter to `true`\. - -For information about modifying a DB instance, see [Modifying an Amazon RDS DB instance](Overview.DBInstance.Modifying.md)\. After the modification is complete, Amazon RDS triggers an event \(RDS\-EVENT\-0025\) that indicates the process is complete\. You can monitor Amazon RDS events\. For more information about events, see [Working with Amazon RDS event notification](USER_Events.md)\. - -## Failover process for Amazon RDS - -If a planned or unplanned outage of your DB instance results from an infrastructure defect, Amazon RDS automatically switches to a standby replica in another Availability Zone if you have turned on Multi\-AZ\. The time that it takes for the failover to complete depends on the database activity and other conditions at the time the primary DB instance became unavailable\. Failover times are typically 60–120 seconds\. However, large transactions or a lengthy recovery process can increase failover time\. When the failover is complete, it can take additional time for the RDS console to reflect the new Availability Zone\. - -**Note** -You can force a failover manually when you reboot a DB instance\. For more information, see [Rebooting a DB instance](USER_RebootInstance.md)\. - -Amazon RDS handles failovers automatically so you can resume database operations as quickly as possible without administrative intervention\. The primary DB instance switches over automatically to the standby replica if any of the conditions described in the following table occurs\. You can view these failover reasons in the event log\. - - -| Failover reason | Description | -| --- | --- | -| The operating system underlying the RDS database instance is being patched in an offline operation\. | A failover was triggered during the maintenance window for an OS patch or a security update\. For more information, see [Maintaining a DB instance](USER_UpgradeDBInstance.Maintenance.md)\. | -| The primary host of the RDS Multi\-AZ instance is unhealthy\. | The Multi\-AZ DB instance deployment detected an impaired primary DB instance and failed over\. | -| The primary host of the RDS Multi\-AZ instance is unreachable due to loss of network connectivity\. | RDS monitoring detected a network reachability failure to the primary DB instance and triggered a failover\. | -| The RDS instance was modified by customer\. | An RDS DB instance modification triggered a failover\. For more information, see [Modifying an Amazon RDS DB instance](Overview.DBInstance.Modifying.md)\. | -| The RDS Multi\-AZ primary instance is busy and unresponsive\. | The primary DB instance is unresponsive\. We recommend that you do the following: [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Concepts.MultiAZSingleStandby.html) For more information on these recommendations, see [Overview of monitoring metrics in Amazon RDS](MonitoringOverview.md) and [Best practices for Amazon RDS](CHAP_BestPractices.md)\. | -| The storage volume underlying the primary host of the RDS Multi\-AZ instance experienced a failure\. | The Multi\-AZ DB instance deployment detected a storage issue on the primary DB instance and failed over\. | -| The user requested a failover of the DB instance\. | You rebooted the DB instance and chose **Reboot with failover**\. For more information, see [Rebooting a DB instance](USER_RebootInstance.md)\. | - -To determine if your Multi\-AZ DB instance has failed over, you can do the following: -+ Set up DB event subscriptions to notify you by email or SMS that a failover has been initiated\. For more information about events, see [Working with Amazon RDS event notification](USER_Events.md)\. -+ View your DB events by using the RDS console or API operations\. -+ View the current state of your Multi\-AZ DB instance deployment by using the RDS console or API operations\. - -For information on how you can respond to failovers, reduce recovery time, and other best practices for Amazon RDS, see [Best practices for Amazon RDS](CHAP_BestPractices.md)\. - -### Setting the JVM TTL for DNS name lookups - -The failover mechanism automatically changes the Domain Name System \(DNS\) record of the DB instance to point to the standby DB instance\. As a result, you need to re\-establish any existing connections to your DB instance\. In a Java virtual machine \(JVM\) environment, due to how the Java DNS caching mechanism works, you might need to reconfigure JVM settings\. - -The JVM caches DNS name lookups\. When the JVM resolves a host name to an IP address, it caches the IP address for a specified period of time, known as the *time\-to\-live* \(TTL\)\. - -Because AWS resources use DNS name entries that occasionally change, we recommend that you configure your JVM with a TTL value of no more than 60 seconds\. Doing this makes sure that when a resource's IP address changes, your application can receive and use the resource's new IP address by requerying the DNS\. - -On some Java configurations, the JVM default TTL is set so that it never refreshes DNS entries until the JVM is restarted\. Thus, if the IP address for an AWS resource changes while your application is still running, it can't use that resource until you manually restart the JVM and the cached IP information is refreshed\. In this case, it's crucial to set the JVM's TTL so that it periodically refreshes its cached IP information\. - -You can get the JVM default TTL by retrieving the [https://docs.oracle.com/javase/7/docs/technotes/guides/net/properties.html](https://docs.oracle.com/javase/7/docs/technotes/guides/net/properties.html) property value: - -``` -String ttl = java.security.Security.getProperty("networkaddress.cache.ttl"); -``` - -**Note** -The default TTL can vary according to the version of your JVM and whether a security manager is installed\. Many JVMs provide a default TTL less than 60 seconds\. If you're using such a JVM and not using a security manager, you can ignore the rest of this topic\. For more information on security managers in Oracle, see [The security manager](https://docs.oracle.com/javase/tutorial/essential/environment/security.html) in the Oracle documentation\. - -To modify the JVM's TTL, set the `networkaddress.cache.ttl` property value\. Use one of the following methods, depending on your needs: -+ To set the property value globally for all applications that use the JVM, set `networkaddress.cache.ttl` in the `$JAVA_HOME/jre/lib/security/java.security` file\. - - ``` - networkaddress.cache.ttl=60 - ``` -+ To set the property locally for your application only, set `networkaddress.cache.ttl` in your application's initialization code before any network connections are established\. - - ``` - java.security.Security.setProperty("networkaddress.cache.ttl" , "60"); - ``` \ No newline at end of file diff --git a/doc_source/Concepts.RDSFeaturesRegionsDBEngines.grids.md b/doc_source/Concepts.RDSFeaturesRegionsDBEngines.grids.md deleted file mode 100644 index e2f7cee..0000000 --- a/doc_source/Concepts.RDSFeaturesRegionsDBEngines.grids.md +++ /dev/null @@ -1,51 +0,0 @@ -# Supported features in Amazon RDS by AWS Region and DB engine - -Support for Amazon RDS features and options varies across AWS Regions and specific versions of each DB engine\. To identify RDS DB engine version support and availability in a given AWS Region, you can use the following sections\. - -Amazon RDS features are different from engine\-native features and options\. For more information on engine\-native features and options, see [Engine\-native features\.](Concepts.RDS_Fea_Regions_DB-eng.Feature.EngineNativeFeatures.md) - -**Topics** -+ [Table conventions](#Concepts.RDS_Fea_Regions_DB-eng.Feature.TableConventions) -+ [Feature quick reference](#Concepts.RDS_Fea_Regions_DB-eng.Feature.QuickReferenceTable) -+ [Blue/Green Deployments](Concepts.RDS_Fea_Regions_DB-eng.Feature.BlueGreenDeployments.md) -+ [Cross\-Region automated backups](Concepts.RDS_Fea_Regions_DB-eng.Feature.CrossRegionAutomatedBackups.md) -+ [Cross\-Region read replicas](Concepts.RDS_Fea_Regions_DB-eng.Feature.CrossRegionReadReplicas.md) -+ [Database activity streams](Concepts.RDS_Fea_Regions_DB-eng.Feature.DBActivityStreams.md) -+ [Dual\-stack mode](Concepts.RDS_Fea_Regions_DB-eng.Feature.DualStackMode.md) -+ [Export snapshots to S3](Concepts.RDS_Fea_Regions_DB-eng.Feature.ExportSnapshotToS3.md) -+ [IAM database authentication](Concepts.RDS_Fea_Regions_DB-eng.Feature.IamDatabaseAuthentication.md) -+ [Kerberos authentication](Concepts.RDS_Fea_Regions_DB-eng.Feature.KerberosAuthentication.md) -+ [Multi\-AZ DB clusters](Concepts.RDS_Fea_Regions_DB-eng.Feature.MultiAZDBClusters.md) -+ [Performance Insights](Concepts.RDS_Fea_Regions_DB-eng.Feature.PerformanceInsights.md) -+ [RDS Custom](Concepts.RDS_Fea_Regions_DB-eng.Feature.RDSCustom.md) -+ [Amazon RDS Proxy](Concepts.RDS_Fea_Regions_DB-eng.Feature.RDSProxy.md) -+ [Secrets Manager integration](Concepts.RDS_Fea_Regions_DB-eng.Feature.SecretsManager.md) -+ [Engine\-native features](Concepts.RDS_Fea_Regions_DB-eng.Feature.EngineNativeFeatures.md) - -## Table conventions - -The tables in the feature sections use these patterns to specify version numbers and level of availability: -+ **Version x\.y** – The specific version alone is available\. -+ **Version x\.y and higher** – The version and all higher minor versions are available\. For example, "version 10\.11 and higher" means that versions 10\.11, 10\.11\.1, and 10\.12 are available\. -+ **—** – The feature isn't currently available for the selected RDS DB engine or in the specified AWS Region\. - -## Feature quick reference - -The following quick reference table lists each feature and available RDS DB engine\. Region and specific version availability appears in the later feature sections\. - - -| Feature | RDS for MariaDB | RDS for MySQL | RDS for Oracle | RDS for PostgreSQL | RDS for SQL Server | -| --- | --- | --- | --- | --- | --- | -| Blue/Green Deployments | [Available](Concepts.RDS_Fea_Regions_DB-eng.Feature.BlueGreenDeployments.md) | [Available](Concepts.RDS_Fea_Regions_DB-eng.Feature.BlueGreenDeployments.md) | – | – | – | -| Cross\-Region automated backups | – | – | [Available](Concepts.RDS_Fea_Regions_DB-eng.Feature.CrossRegionAutomatedBackups.md#Concepts.RDS_Fea_Regions_DB-eng.Feature.CrossRegionAutomatedBackups.ora) | [Available](Concepts.RDS_Fea_Regions_DB-eng.Feature.CrossRegionAutomatedBackups.md#Concepts.RDS_Fea_Regions_DB-eng.Feature.CrossRegionAutomatedBackups.pg) | [Available](Concepts.RDS_Fea_Regions_DB-eng.Feature.CrossRegionAutomatedBackups.md#Concepts.RDS_Fea_Regions_DB-eng.Feature.CrossRegionAutomatedBackups.sq) | -| Cross\-Region read replicas | [Available](Concepts.RDS_Fea_Regions_DB-eng.Feature.CrossRegionReadReplicas.md#Concepts.RDS_Fea_Regions_DB-eng.Feature.CrossRegionReadReplicas.mdb) | [Available](Concepts.RDS_Fea_Regions_DB-eng.Feature.CrossRegionReadReplicas.md#Concepts.RDS_Fea_Regions_DB-eng.Feature.CrossRegionReadReplicas.my) | [Available](Concepts.RDS_Fea_Regions_DB-eng.Feature.CrossRegionReadReplicas.md#Concepts.RDS_Fea_Regions_DB-eng.Feature.CrossRegionReadReplicas.ora) | [Available](Concepts.RDS_Fea_Regions_DB-eng.Feature.CrossRegionReadReplicas.md#Concepts.RDS_Fea_Regions_DB-eng.Feature.CrossRegionReadReplicas.pg) | [Available](Concepts.RDS_Fea_Regions_DB-eng.Feature.CrossRegionReadReplicas.md#Concepts.RDS_Fea_Regions_DB-eng.Feature.CrossRegionReadReplicas.sq) | -| Database activity streams | – | – | [Available](Concepts.RDS_Fea_Regions_DB-eng.Feature.DBActivityStreams.md#Concepts.RDS_Fea_Regions_DB-eng.Feature.DBActivityStreams.ora) | – | [Available](Concepts.RDS_Fea_Regions_DB-eng.Feature.DBActivityStreams.md#Concepts.RDS_Fea_Regions_DB-eng.Feature.DBActivityStreams.SQLServer) | -| Dual\-stack mode | [Available](Concepts.RDS_Fea_Regions_DB-eng.Feature.DualStackMode.md#Concepts.RDS_Fea_Regions_DB-eng.Feature.DualStackMode.mdb) | [Available](Concepts.RDS_Fea_Regions_DB-eng.Feature.DualStackMode.md#Concepts.RDS_Fea_Regions_DB-eng.Feature.DualStackMode.my) | [Available](Concepts.RDS_Fea_Regions_DB-eng.Feature.DualStackMode.md#Concepts.RDS_Fea_Regions_DB-eng.Feature.DualStackMode.ora) | [Available](Concepts.RDS_Fea_Regions_DB-eng.Feature.DualStackMode.md#Concepts.RDS_Fea_Regions_DB-eng.Feature.DualStackMode.pg) | [Available](Concepts.RDS_Fea_Regions_DB-eng.Feature.DualStackMode.md#Concepts.RDS_Fea_Regions_DB-eng.Feature.DualStackMode.sq) | -| Export Snapshot to Amazon S3 | [Available](Concepts.RDS_Fea_Regions_DB-eng.Feature.ExportSnapshotToS3.md#Concepts.RDS_Fea_Regions_DB-eng.Feature.ExportSnapshotToS3.mdb) | [Available](Concepts.RDS_Fea_Regions_DB-eng.Feature.ExportSnapshotToS3.md#Concepts.RDS_Fea_Regions_DB-eng.Feature.ExportSnapshotToS3.my) | – | [Available](Concepts.RDS_Fea_Regions_DB-eng.Feature.ExportSnapshotToS3.md#Concepts.RDS_Fea_Regions_DB-eng.Feature.ExportSnapshotToS3.pg) | – | -| AWS Identity and Access Management \(IAM\) database authentication | [Available](Concepts.RDS_Fea_Regions_DB-eng.Feature.IamDatabaseAuthentication.md#Concepts.RDS_Fea_Regions_DB-eng.Feature.IamDatabaseAuthentication.mdb) | [Available](Concepts.RDS_Fea_Regions_DB-eng.Feature.IamDatabaseAuthentication.md#Concepts.RDS_Fea_Regions_DB-eng.Feature.IamDatabaseAuthentication.my) | – | [Available](Concepts.RDS_Fea_Regions_DB-eng.Feature.IamDatabaseAuthentication.md#Concepts.RDS_Fea_Regions_DB-eng.Feature.IamDatabaseAuthentication.pg) | – | -| Kerberos authentication | – | [Available](Concepts.RDS_Fea_Regions_DB-eng.Feature.KerberosAuthentication.md#Concepts.RDS_Fea_Regions_DB-eng.Feature.KerberosAuthentication.my) | [Available](Concepts.RDS_Fea_Regions_DB-eng.Feature.KerberosAuthentication.md#Concepts.RDS_Fea_Regions_DB-eng.Feature.KerberosAuthentication.ora) | [Available](Concepts.RDS_Fea_Regions_DB-eng.Feature.KerberosAuthentication.md#Concepts.RDS_Fea_Regions_DB-eng.Feature.KerberosAuthentication.pg) | [Available](Concepts.RDS_Fea_Regions_DB-eng.Feature.KerberosAuthentication.md#Concepts.RDS_Fea_Regions_DB-eng.Feature.KerberosAuthentication.sq) | -| Multi\-AZ DB clusters | – | [Available](Concepts.RDS_Fea_Regions_DB-eng.Feature.MultiAZDBClusters.md#Concepts.RDS_Fea_Regions_DB-eng.Feature.MultiAZDBClusters.my) | – | [Available](Concepts.RDS_Fea_Regions_DB-eng.Feature.MultiAZDBClusters.md#Concepts.RDS_Fea_Regions_DB-eng.Feature.MultiAZDBClusters.pg) | – | -| Performance Insights | [Available](Concepts.RDS_Fea_Regions_DB-eng.Feature.PerformanceInsights.md) | [Available](Concepts.RDS_Fea_Regions_DB-eng.Feature.PerformanceInsights.md) | [Available](Concepts.RDS_Fea_Regions_DB-eng.Feature.PerformanceInsights.md) | [Available](Concepts.RDS_Fea_Regions_DB-eng.Feature.PerformanceInsights.md) | [Available](Concepts.RDS_Fea_Regions_DB-eng.Feature.PerformanceInsights.md) | -| RDS Custom | – | – | [Available](Concepts.RDS_Fea_Regions_DB-eng.Feature.RDSCustom.md#Concepts.RDS_Fea_Regions_DB-eng.Feature.RDSCustom.ora) | – | [Available](Concepts.RDS_Fea_Regions_DB-eng.Feature.RDSCustom.md#Concepts.RDS_Fea_Regions_DB-eng.Feature.RDSCustom.sq) | -| RDS Proxy | [Available](Concepts.RDS_Fea_Regions_DB-eng.Feature.RDSProxy.md#Concepts.RDS_Fea_Regions_DB-eng.Feature.RDS_Proxy.mdb) | [Available](Concepts.RDS_Fea_Regions_DB-eng.Feature.RDSProxy.md#Concepts.RDS_Fea_Regions_DB-eng.Feature.RDS_Proxy.my) | – | [Available](Concepts.RDS_Fea_Regions_DB-eng.Feature.RDSProxy.md#Concepts.RDS_Fea_Regions_DB-eng.Feature.RDS_Proxy.pg) | [Available](Concepts.RDS_Fea_Regions_DB-eng.Feature.RDSProxy.md#Concepts.RDS_Fea_Regions_DB-eng.Feature.RDS_Proxy.sq) | -| Secrets Manager integration | [Available](Concepts.RDS_Fea_Regions_DB-eng.Feature.SecretsManager.md) | [Available](Concepts.RDS_Fea_Regions_DB-eng.Feature.SecretsManager.md) | [Available](Concepts.RDS_Fea_Regions_DB-eng.Feature.SecretsManager.md) | [Available](Concepts.RDS_Fea_Regions_DB-eng.Feature.SecretsManager.md) | [Available](Concepts.RDS_Fea_Regions_DB-eng.Feature.SecretsManager.md) | \ No newline at end of file diff --git a/doc_source/Concepts.RDS_Fea_Regions_DB-eng.Feature.BlueGreenDeployments.md b/doc_source/Concepts.RDS_Fea_Regions_DB-eng.Feature.BlueGreenDeployments.md deleted file mode 100644 index 5aa946e..0000000 --- a/doc_source/Concepts.RDS_Fea_Regions_DB-eng.Feature.BlueGreenDeployments.md +++ /dev/null @@ -1,15 +0,0 @@ -# Blue/Green Deployments - -A blue/green deployment copies a production database environment in a separate, synchronized staging environment\. By using Amazon RDS Blue/Green Deployments, you can make changes to the database in the staging environment without affecting the production environment\. For example, you can upgrade the major or minor DB engine version, change database parameters, or make schema changes in the staging environment\. When you are ready, you can promote the staging environment to be the new production database environment\. For more information, see [Using Amazon RDS Blue/Green Deployments for database updates](blue-green-deployments.md)\. - -The Blue/Green Deployments feature is supported for the following engines: -+ RDS for MariaDB version 10\.2 and higher -+ RDS for MySQL version 5\.7 and higher -+ RDS for MySQL version 8\.0\.15 and higher - -The Blue/Green Deployments feature isn't supported with the following engines: -+ RDS for SQL Server -+ RDS for Oracle -+ RDS for PostgreSQL - -The Blue/Green Deployments feature is supported in all AWS Regions\. \ No newline at end of file diff --git a/doc_source/Concepts.RDS_Fea_Regions_DB-eng.Feature.CrossRegionAutomatedBackups.md b/doc_source/Concepts.RDS_Fea_Regions_DB-eng.Feature.CrossRegionAutomatedBackups.md deleted file mode 100644 index 5076ac1..0000000 --- a/doc_source/Concepts.RDS_Fea_Regions_DB-eng.Feature.CrossRegionAutomatedBackups.md +++ /dev/null @@ -1,43 +0,0 @@ -# Cross\-Region automated backups - -By using backup replication in Amazon RDS, you can configure your RDS DB instance to replicate snapshots and transaction logs to a destination Region\. When backup replication is configured for a DB instance, RDS starts a cross\-Region copy of all snapshots and transaction logs when they're ready\. For more information, see [Replicating automated backups to another AWS Region](USER_ReplicateBackups.md)\. - -Backup replication is available in all AWS Regions except the following: -+ Africa \(Cape Town\) -+ Asia Pacific \(Hong Kong\) -+ Asia Pacific \(Hyderabad\) -+ Asia Pacific \(Jakarta\) -+ Europe \(Milan\) -+ Europe \(Spain\) -+ Europe \(Zurich\) -+ Middle East \(Bahrain\) -+ Middle East \(UAE\) - -For more detailed information on limitations for source and destination backup Regions, see [Replicating automated backups to another AWS Region](USER_ReplicateBackups.md)\. - -**Topics** -+ [Backup replication with RDS for MariaDB](#Concepts.RDS_Fea_Regions_DB-eng.Feature.CrossRegionAutomatedBackups.mdb) -+ [Backup replication with RDS for MySQL](#Concepts.RDS_Fea_Regions_DB-eng.Feature.CrossRegionAutomatedBackups.my) -+ [Backup replication with RDS for Oracle](#Concepts.RDS_Fea_Regions_DB-eng.Feature.CrossRegionAutomatedBackups.ora) -+ [Backup replication with RDS for PostgreSQL](#Concepts.RDS_Fea_Regions_DB-eng.Feature.CrossRegionAutomatedBackups.pg) -+ [Backup replication with RDS for SQL Server](#Concepts.RDS_Fea_Regions_DB-eng.Feature.CrossRegionAutomatedBackups.sq) - -## Backup replication with RDS for MariaDB - -Amazon RDS supports backup replication for all currently available versions of RDS for MariaDB\. - -## Backup replication with RDS for MySQL - -Amazon RDS supports backup replication for all currently available versions of RDS for MySQL\. - -## Backup replication with RDS for Oracle - -Amazon RDS supports backup replication for all currently available versions of RDS for Oracle\. - -## Backup replication with RDS for PostgreSQL - -Amazon RDS supports backup replication for all currently available versions of RDS for PostgreSQL\. - -## Backup replication with RDS for SQL Server - -Amazon RDS supports backup replication for all currently available versions of RDS for SQL Server\. \ No newline at end of file diff --git a/doc_source/Concepts.RDS_Fea_Regions_DB-eng.Feature.CrossRegionReadReplicas.md b/doc_source/Concepts.RDS_Fea_Regions_DB-eng.Feature.CrossRegionReadReplicas.md deleted file mode 100644 index 0961b30..0000000 --- a/doc_source/Concepts.RDS_Fea_Regions_DB-eng.Feature.CrossRegionReadReplicas.md +++ /dev/null @@ -1,62 +0,0 @@ -# Cross\-Region read replicas - -By using cross\-Region read replicas in Amazon RDS, you can create a MariaDB, MySQL, Oracle, PostgreSQL, or SQL Server read replica in a different Region from the source DB instance\. For more information about cross\-Region read replicas, including source and destination Region considerations, see [Creating a read replica in a different AWS Region](USER_ReadRepl.md#USER_ReadRepl.XRgn)\. - -**Topics** -+ [Cross\-Region read replicas with RDS for MariaDB](#Concepts.RDS_Fea_Regions_DB-eng.Feature.CrossRegionReadReplicas.mdb) -+ [Cross\-Region read replicas with RDS for MySQL](#Concepts.RDS_Fea_Regions_DB-eng.Feature.CrossRegionReadReplicas.my) -+ [Cross\-Region read replicas with RDS for Oracle](#Concepts.RDS_Fea_Regions_DB-eng.Feature.CrossRegionReadReplicas.ora) -+ [Cross\-Region read replicas with RDS for PostgreSQL](#Concepts.RDS_Fea_Regions_DB-eng.Feature.CrossRegionReadReplicas.pg) -+ [Cross\-Region read replicas with RDS for SQL Server](#Concepts.RDS_Fea_Regions_DB-eng.Feature.CrossRegionReadReplicas.sq) - -## Cross\-Region read replicas with RDS for MariaDB - -Cross\-Region read replicas with RDS for MariaDB are available in all Regions for the following versions: -+ RDS for MariaDB 10\.6 \(All available versions\) -+ RDS for MariaDB 10\.5 \(All available versions\) -+ RDS for MariaDB 10\.4 \(All available versions\) -+ RDS for MariaDB 10\.3 \(All available versions\) - -## Cross\-Region read replicas with RDS for MySQL - -Cross\-Region read replicas with RDS for MySQL are available in all Regions for the following versions: -+ RDS for MySQL 8\.0 \(All available versions\) -+ RDS for MySQL 5\.7 \(All available versions\) - -## Cross\-Region read replicas with RDS for Oracle - -Cross\-Region read replicas for RDS for Oracle are available in all Regions with the following version limitations: -+ For RDS for Oracle 21c, cross\-Region read replicas aren't available\. -+ For RDS for Oracle 19c, cross\-Region read replicas are available for instances of Oracle Database 19c that aren't container database \(CBD\) instances\. -+ For RDS for Oracle 12c, cross\-Region read replicas are available for Oracle Enterprise Edition \(EE\) of Oracle Database 12c Release 1 \(12\.1\) using 12\.1\.0\.2\.v10 and higher 12c releases\. - -For more information on additional requirements for cross\-Region read replicas with RDS for Oracle, see [Requirements and considerations for RDS for Oracle replicas](oracle-read-replicas.limitations.md)\. - -## Cross\-Region read replicas with RDS for PostgreSQL - -Cross\-Region read replicas with RDS for PostgreSQL are available in all Regions for the following versions: -+ RDS for PostgreSQL 15 \(All available versions\) -+ RDS for PostgreSQL 14 \(All available versions\) -+ RDS for PostgreSQL 13 \(All available versions\) -+ RDS for PostgreSQL 12 \(All available versions\) -+ RDS for PostgreSQL 11 \(All available versions\) -+ RDS for PostgreSQL 10 \(All available versions\) - -## Cross\-Region read replicas with RDS for SQL Server - -Cross\-Region read replicas with RDS for SQL Server are available in all Regions except the following: -+ Africa \(Cape Town\) -+ Asia Pacific \(Hong Kong\) -+ Asia Pacific \(Hyderabad\) -+ Asia Pacific \(Jakarta\) -+ Asia Pacific \(Melbourne\) -+ Europe \(Milan\) -+ Europe \(Spain\) -+ Europe \(Zurich\) -+ Middle East \(Bahrain\) -+ Middle East \(UAE\) - -Cross\-Region read replicas with RDS for SQL Server are available for the following versions using Microsoft SQL Server Enterprise Edition: -+ RDS for SQL Server 2019 \(Version 15\.00\.4073\.23 and higher\) -+ RDS for SQL Server 2017 \(Version 14\.00\.3281\.6 and higher\) -+ RDS for SQL Server 2016 \(Version 13\.00\.6300\.2 and higher\) \ No newline at end of file diff --git a/doc_source/Concepts.RDS_Fea_Regions_DB-eng.Feature.DBActivityStreams.md b/doc_source/Concepts.RDS_Fea_Regions_DB-eng.Feature.DBActivityStreams.md deleted file mode 100644 index 89203dc..0000000 --- a/doc_source/Concepts.RDS_Fea_Regions_DB-eng.Feature.DBActivityStreams.md +++ /dev/null @@ -1,94 +0,0 @@ -# Database activity streams - - By using Database Activity Streams in Amazon RDS, you can monitor and set alarms for auditing activity in your Oracle database and SQL Server database\. For more information, see [Overview of Database Activity Streams](DBActivityStreams.Overview.md)\. - -Database activity streams aren't available with the following engines: -+ RDS for MariaDB -+ RDS for MySQL -+ RDS for PostgreSQL - -**Topics** -+ [Database activity streams with RDS for Oracle](#Concepts.RDS_Fea_Regions_DB-eng.Feature.DBActivityStreams.ora) -+ [Database activity streams with RDS for SQL Server](#Concepts.RDS_Fea_Regions_DB-eng.Feature.DBActivityStreams.SQLServer) - -## Database activity streams with RDS for Oracle - -The following Regions and engine versions are available for database activity streams with RDS for Oracle\. - -For more information on additional requirements for database activity streams with RDS for Oracle, see [Overview of Database Activity Streams](DBActivityStreams.Overview.md)\. - - -| Region | RDS for Oracle 21c | RDS for Oracle 19c | -| --- | --- | --- | -| US East \(Ohio\) | – | Oracle Database 19\.0\.0\.0\.ru\-2019\-07\.rur\-2019\-07\.r1 and higher, using either Enterprise Edition \(EE\) or Standard Edition 2 \(SE2\) | -| US East \(N\. Virginia\) | – | Oracle Database 19\.0\.0\.0\.ru\-2019\-07\.rur\-2019\-07\.r1 and higher, using either Enterprise Edition \(EE\) or Standard Edition 2 \(SE2\) | -| US West \(N\. California\) | – | Oracle Database 19\.0\.0\.0\.ru\-2019\-07\.rur\-2019\-07\.r1 and higher, using either Enterprise Edition \(EE\) or Standard Edition 2 \(SE2\) | -| US West \(Oregon\) | – | Oracle Database 19\.0\.0\.0\.ru\-2019\-07\.rur\-2019\-07\.r1 and higher, using either Enterprise Edition \(EE\) or Standard Edition 2 \(SE2\) | -| Africa \(Cape Town\) | – | Oracle Database 19\.0\.0\.0\.ru\-2019\-07\.rur\-2019\-07\.r1 and higher, using either Enterprise Edition \(EE\) or Standard Edition 2 \(SE2\) | -| Asia Pacific \(Hong Kong\) | – | Oracle Database 19\.0\.0\.0\.ru\-2019\-07\.rur\-2019\-07\.r1 and higher, using either Enterprise Edition \(EE\) or Standard Edition 2 \(SE2\) | -| Asia Pacific \(Hyderabad\) | – | Oracle Database 19\.0\.0\.0\.ru\-2019\-07\.rur\-2019\-07\.r1 and higher, using either Enterprise Edition \(EE\) or Standard Edition 2 \(SE2\) | -| Asia Pacific \(Jakarta\) | – | Oracle Database 19\.0\.0\.0\.ru\-2019\-07\.rur\-2019\-07\.r1 and higher, using either Enterprise Edition \(EE\) or Standard Edition 2 \(SE2\) | -| Asia Pacific \(Melbourne\) | – | – | -| Asia Pacific \(Mumbai\) | – | Oracle Database 19\.0\.0\.0\.ru\-2019\-07\.rur\-2019\-07\.r1 and higher, using either Enterprise Edition \(EE\) or Standard Edition 2 \(SE2\) | -| Asia Pacific \(Osaka\) | – | Oracle Database 19\.0\.0\.0\.ru\-2019\-07\.rur\-2019\-07\.r1 and higher, using either Enterprise Edition \(EE\) or Standard Edition 2 \(SE2\) | -| Asia Pacific \(Seoul\) | – | Oracle Database 19\.0\.0\.0\.ru\-2019\-07\.rur\-2019\-07\.r1 and higher, using either Enterprise Edition \(EE\) or Standard Edition 2 \(SE2\) | -| Asia Pacific \(Singapore\) | – | Oracle Database 19\.0\.0\.0\.ru\-2019\-07\.rur\-2019\-07\.r1 and higher, using either Enterprise Edition \(EE\) or Standard Edition 2 \(SE2\) | -| Asia Pacific \(Sydney\) | – | Oracle Database 19\.0\.0\.0\.ru\-2019\-07\.rur\-2019\-07\.r1 and higher, using either Enterprise Edition \(EE\) or Standard Edition 2 \(SE2\) | -| Asia Pacific \(Tokyo\) | – | Oracle Database 19\.0\.0\.0\.ru\-2019\-07\.rur\-2019\-07\.r1 and higher, using either Enterprise Edition \(EE\) or Standard Edition 2 \(SE2\) | -| Canada \(Central\) | – | Oracle Database 19\.0\.0\.0\.ru\-2019\-07\.rur\-2019\-07\.r1 and higher, using either Enterprise Edition \(EE\) or Standard Edition 2 \(SE2\) | -| China \(Beijing\) | – | – | -| China \(Ningxia\) | – | – | -| Europe \(Frankfurt\) | – | Oracle Database 19\.0\.0\.0\.ru\-2019\-07\.rur\-2019\-07\.r1 and higher, using either Enterprise Edition \(EE\) or Standard Edition 2 \(SE2\) | -| Europe \(Ireland\) | – | Oracle Database 19\.0\.0\.0\.ru\-2019\-07\.rur\-2019\-07\.r1 and higher, using either Enterprise Edition \(EE\) or Standard Edition 2 \(SE2\) | -| Europe \(London\) | – | Oracle Database 19\.0\.0\.0\.ru\-2019\-07\.rur\-2019\-07\.r1 and higher, using either Enterprise Edition \(EE\) or Standard Edition 2 \(SE2\) | -| Europe \(Milan\) | – | Oracle Database 19\.0\.0\.0\.ru\-2019\-07\.rur\-2019\-07\.r1 and higher, using either Enterprise Edition \(EE\) or Standard Edition 2 \(SE2\) | -| Europe \(Paris\) | – | Oracle Database 19\.0\.0\.0\.ru\-2019\-07\.rur\-2019\-07\.r1 and higher, using either Enterprise Edition \(EE\) or Standard Edition 2 \(SE2\) | -| Europe \(Spain\) | – | Oracle Database 19\.0\.0\.0\.ru\-2019\-07\.rur\-2019\-07\.r1 and higher, using either Enterprise Edition \(EE\) or Standard Edition 2 \(SE2\) | -| Europe \(Stockholm\) | – | Oracle Database 19\.0\.0\.0\.ru\-2019\-07\.rur\-2019\-07\.r1 and higher, using either Enterprise Edition \(EE\) or Standard Edition 2 \(SE2\) | -| Europe \(Zurich\) | – | – | -| Middle East \(Bahrain\) | – | Oracle Database 19\.0\.0\.0\.ru\-2019\-07\.rur\-2019\-07\.r1 and higher, using either Enterprise Edition \(EE\) or Standard Edition 2 \(SE2\) | -| Middle East \(UAE\) | – | Oracle Database 19\.0\.0\.0\.ru\-2019\-07\.rur\-2019\-07\.r1 and higher, using either Enterprise Edition \(EE\) or Standard Edition 2 \(SE2\) | -| South America \(São Paulo\) | – | Oracle Database 19\.0\.0\.0\.ru\-2019\-07\.rur\-2019\-07\.r1 and higher, using either Enterprise Edition \(EE\) or Standard Edition 2 \(SE2\) | -| AWS GovCloud \(US\-East\) | – | – | -| AWS GovCloud \(US\-West\) | – | – | - -## Database activity streams with RDS for SQL Server - -The following Regions and engine versions are available for database activity streams with RDS for SQL Server\. - -For more information on additional requirements for database activity streams with RDS for SQL Server, see [Overview of Database Activity Streams](DBActivityStreams.Overview.md)\. - - -| Region | RDS for SQL Server 2019 | RDS for SQL Server 2017 | RDS for SQL Server 2016 | RDS for SQL Server 2014 | -| --- | --- | --- | --- | --- | -| US East \(Ohio\) | All available versions | All available versions | All available versions | – | -| US East \(N\. Virginia\) | All available versions | All available versions | All available versions | – | -| US West \(N\. California\) | All available versions | All available versions | All available versions | – | -| US West \(Oregon\) | All available versions | All available versions | All available versions | – | -| Africa \(Cape Town\) | All available versions | All available versions | All available versions | – | -| Asia Pacific \(Hong Kong\) | All available versions | All available versions | All available versions | – | -| Asia Pacific \(Hyderabad\) | All available versions | All available versions | All available versions | – | -| Asia Pacific \(Jakarta\) | All available versions | All available versions | All available versions | – | -| Asia Pacific \(Melbourne\) | – | – | – | – | -| Asia Pacific \(Mumbai\) | All available versions | All available versions | All available versions | – | -| Asia Pacific \(Osaka\) | All available versions | All available versions | All available versions | – | -| Asia Pacific \(Seoul\) | All available versions | All available versions | All available versions | – | -| Asia Pacific \(Singapore\) | All available versions | All available versions | All available versions | – | -| Asia Pacific \(Sydney\) | All available versions | All available versions | All available versions | – | -| Asia Pacific \(Tokyo\) | All available versions | All available versions | All available versions | – | -| Canada \(Central\) | All available versions | All available versions | All available versions | – | -| China \(Beijing\) | – | – | – | – | -| China \(Ningxia\) | – | – | – | – | -| Europe \(Frankfurt\) | All available versions | All available versions | All available versions | – | -| Europe \(Ireland\) | All available versions | All available versions | All available versions | – | -| Europe \(London\) | All available versions | All available versions | All available versions | – | -| Europe \(Milan\) | All available versions | All available versions | All available versions | – | -| Europe \(Paris\) | All available versions | All available versions | All available versions | – | -| Europe \(Spain\) | All available versions | All available versions | All available versions | – | -| Europe \(Stockholm\) | All available versions | All available versions | All available versions | – | -| Europe \(Zurich\) | – | – | – | – | -| Middle East \(Bahrain\) | All available versions | All available versions | All available versions | – | -| Middle East \(UAE\) | All available versions | All available versions | All available versions | – | -| South America \(São Paulo\) | All available versions | All available versions | All available versions | – | -| AWS GovCloud \(US\-East\) | – | – | – | – | -| AWS GovCloud \(US\-West\) | – | – | – | – | \ No newline at end of file diff --git a/doc_source/Concepts.RDS_Fea_Regions_DB-eng.Feature.DualStackMode.md b/doc_source/Concepts.RDS_Fea_Regions_DB-eng.Feature.DualStackMode.md deleted file mode 100644 index a4335e2..0000000 --- a/doc_source/Concepts.RDS_Fea_Regions_DB-eng.Feature.DualStackMode.md +++ /dev/null @@ -1,205 +0,0 @@ -# Dual\-stack mode - -By using dual\-stack mode in RDS, resources can communicate with a DB instance over Internet Protocol version 4 \(IPv4\), Internet Protocol version 6 \(IPv6\), or both\. For more information, see [Dual\-stack mode](USER_VPC.WorkingWithRDSInstanceinaVPC.md#USER_VPC.IP_addressing.dual-stack-mode)\. - -**Topics** -+ [Dual\-stack mode with RDS for MariaDB](#Concepts.RDS_Fea_Regions_DB-eng.Feature.DualStackMode.mdb) -+ [Dual\-stack mode with RDS for MySQL](#Concepts.RDS_Fea_Regions_DB-eng.Feature.DualStackMode.my) -+ [Dual\-stack mode with RDS for Oracle](#Concepts.RDS_Fea_Regions_DB-eng.Feature.DualStackMode.ora) -+ [Dual\-stack mode with RDS for PostgreSQL](#Concepts.RDS_Fea_Regions_DB-eng.Feature.DualStackMode.pg) -+ [Dual\-stack mode with RDS for SQL Server](#Concepts.RDS_Fea_Regions_DB-eng.Feature.DualStackMode.sq) - -## Dual\-stack mode with RDS for MariaDB - -The following Regions and engine versions are available for dual\-stack mode with RDS for MariaDB\. - - -| Region | RDS for MariaDB 10\.6 | RDS for MariaDB 10\.5 | RDS for MariaDB 10\.4 | RDS for MariaDB 10\.3 | -| --- | --- | --- | --- | --- | -| US East \(Ohio\) | All available versions | All available versions | All available versions | All available versions | -| US East \(N\. Virginia\) | All available versions | All available versions | All available versions | All available versions | -| US West \(N\. California\) | All available versions | All available versions | All available versions | All available versions | -| US West \(Oregon\) | All available versions | All available versions | All available versions | All available versions | -| Africa \(Cape Town\) | All available versions | All available versions | All available versions | All available versions | -| Asia Pacific \(Hong Kong\) | All available versions | All available versions | All available versions | All available versions | -| Asia Pacific \(Hyderabad\) | – | – | – | – | -| Asia Pacific \(Jakarta\) | All available versions | All available versions | All available versions | All available versions | -| Asia Pacific \(Melbourne\) | – | – | – | – | -| Asia Pacific \(Mumbai\) | All available versions | All available versions | All available versions | All available versions | -| Asia Pacific \(Osaka\) | All available versions | All available versions | All available versions | All available versions | -| Asia Pacific \(Seoul\) | All available versions | All available versions | All available versions | All available versions | -| Asia Pacific \(Singapore\) | All available versions | All available versions | All available versions | All available versions | -| Asia Pacific \(Sydney\) | All available versions | All available versions | All available versions | All available versions | -| Asia Pacific \(Tokyo\) | All available versions | All available versions | All available versions | All available versions | -| Canada \(Central\) | All available versions | All available versions | All available versions | All available versions | -| China \(Beijing\) | All available versions | All available versions | All available versions | All available versions | -| China \(Ningxia\) | All available versions | All available versions | All available versions | All available versions | -| Europe \(Frankfurt\) | All available versions | All available versions | All available versions | All available versions | -| Europe \(Ireland\) | All available versions | All available versions | All available versions | All available versions | -| Europe \(London\) | All available versions | All available versions | All available versions | All available versions | -| Europe \(Milan\) | All available versions | All available versions | All available versions | All available versions | -| Europe \(Paris\) | All available versions | All available versions | All available versions | All available versions | -| Europe \(Spain\) | – | – | – | – | -| Europe \(Stockholm\) | All available versions | All available versions | All available versions | All available versions | -| Europe \(Zurich\) | – | – | – | – | -| Middle East \(Bahrain\) | All available versions | All available versions | All available versions | All available versions | -| Middle East \(UAE\) | – | – | – | – | -| South America \(São Paulo\) | All available versions | All available versions | All available versions | All available versions | -| AWS GovCloud \(US\-East\) | All available versions | All available versions | All available versions | All available versions | -| AWS GovCloud \(US\-West\) | All available versions | All available versions | All available versions | All available versions | - -## Dual\-stack mode with RDS for MySQL - -The following Regions and engine versions are available for dual\-stack mode with RDS for MySQL\. - - -| Region | RDS for MySQL 8\.0 | RDS for MySQL 5\.7 | RDS for MySQL 5\.6 | -| --- | --- | --- | --- | -| US East \(Ohio\) | All available versions | All available versions | All available versions | -| US East \(N\. Virginia\) | All available versions | All available versions | All available versions | -| US West \(N\. California\) | All available versions | All available versions | All available versions | -| US West \(Oregon\) | All available versions | All available versions | All available versions | -| Africa \(Cape Town\) | All available versions | All available versions | All available versions | -| Asia Pacific \(Hong Kong\) | All available versions | All available versions | All available versions | -| Asia Pacific \(Hyderabad\) | – | – | – | -| Asia Pacific \(Jakarta\) | All available versions | All available versions | All available versions | -| Asia Pacific \(Melbourne\) | – | – | – | -| Asia Pacific \(Mumbai\) | All available versions | All available versions | All available versions | -| Asia Pacific \(Osaka\) | All available versions | All available versions | All available versions | -| Asia Pacific \(Seoul\) | All available versions | All available versions | All available versions | -| Asia Pacific \(Singapore\) | All available versions | All available versions | All available versions | -| Asia Pacific \(Sydney\) | All available versions | All available versions | All available versions | -| Asia Pacific \(Tokyo\) | All available versions | All available versions | All available versions | -| Canada \(Central\) | All available versions | All available versions | All available versions | -| China \(Beijing\) | All available versions | All available versions | All available versions | -| China \(Ningxia\) | All available versions | All available versions | All available versions | -| Europe \(Frankfurt\) | All available versions | All available versions | All available versions | -| Europe \(Ireland\) | All available versions | All available versions | All available versions | -| Europe \(London\) | All available versions | All available versions | All available versions | -| Europe \(Milan\) | All available versions | All available versions | All available versions | -| Europe \(Paris\) | All available versions | All available versions | All available versions | -| Europe \(Spain\) | – | – | – | -| Europe \(Stockholm\) | All available versions | All available versions | All available versions | -| Europe \(Zurich\) | – | – | – | -| Middle East \(Bahrain\) | All available versions | All available versions | All available versions | -| Middle East \(UAE\) | – | – | – | -| South America \(São Paulo\) | All available versions | All available versions | All available versions | -| AWS GovCloud \(US\-East\) | All available versions | All available versions | All available versions | -| AWS GovCloud \(US\-West\) | All available versions | All available versions | All available versions | - -## Dual\-stack mode with RDS for Oracle - -The following Regions and engine versions are available for dual\-stack mode with RDS for Oracle\. - - -| Region | RDS for Oracle 21c | RDS for Oracle 19c | RDS for Oracle 12c | -| --- | --- | --- | --- | -| US East \(Ohio\) | All available versions | All available versions | All available versions | -| US East \(N\. Virginia\) | All available versions | All available versions | All available versions | -| US West \(N\. California\) | All available versions | All available versions | All available versions | -| US West \(Oregon\) | All available versions | All available versions | All available versions | -| Africa \(Cape Town\) | All available versions | All available versions | All available versions | -| Asia Pacific \(Hong Kong\) | All available versions | All available versions | All available versions | -| Asia Pacific \(Hyderabad\) | – | – | – | -| Asia Pacific \(Jakarta\) | All available versions | All available versions | All available versions | -| Asia Pacific \(Melbourne\) | – | – | – | -| Asia Pacific \(Mumbai\) | All available versions | All available versions | All available versions | -| Asia Pacific \(Osaka\) | All available versions | All available versions | All available versions | -| Asia Pacific \(Seoul\) | All available versions | All available versions | All available versions | -| Asia Pacific \(Singapore\) | All available versions | All available versions | All available versions | -| Asia Pacific \(Sydney\) | All available versions | All available versions | All available versions | -| Asia Pacific \(Tokyo\) | All available versions | All available versions | All available versions | -| Canada \(Central\) | All available versions | All available versions | All available versions | -| China \(Beijing\) | All available versions | All available versions | All available versions | -| China \(Ningxia\) | All available versions | All available versions | All available versions | -| Europe \(Frankfurt\) | All available versions | All available versions | All available versions | -| Europe \(Ireland\) | All available versions | All available versions | All available versions | -| Europe \(London\) | All available versions | All available versions | All available versions | -| Europe \(Milan\) | All available versions | All available versions | All available versions | -| Europe \(Paris\) | All available versions | All available versions | All available versions | -| Europe \(Spain\) | – | – | – | -| Europe \(Stockholm\) | All available versions | All available versions | All available versions | -| Europe \(Zurich\) | – | – | – | -| Middle East \(Bahrain\) | All available versions | All available versions | All available versions | -| Middle East \(UAE\) | – | – | – | -| South America \(São Paulo\) | All available versions | All available versions | All available versions | -| AWS GovCloud \(US\-East\) | All available versions | All available versions | All available versions | -| AWS GovCloud \(US\-West\) | All available versions | All available versions | All available versions | - -## Dual\-stack mode with RDS for PostgreSQL - -The following Regions and engine versions are available for dual\-stack mode with RDS for PostgreSQL\. - - -| Region | RDS for PostgreSQL 15 | RDS for PostgreSQL 14 | RDS for PostgreSQL 13 | RDS for PostgreSQL 12 | RDS for PostgreSQL 11 | RDS for PostgreSQL 10 | -| --- | --- | --- | --- | --- | --- | --- | -| US East \(Ohio\) | All available versions | All available versions | All available versions | All available versions | All available versions | All available versions | -| US East \(N\. Virginia\) | All available versions | All available versions | All available versions | All available versions | All available versions | All available versions | -| US West \(N\. California\) | All available versions | All available versions | All available versions | All available versions | All available versions | All available versions | -| US West \(Oregon\) | All available versions | All available versions | All available versions | All available versions | All available versions | All available versions | -| Africa \(Cape Town\) | All available versions | All available versions | All available versions | All available versions | All available versions | All available versions | -| Asia Pacific \(Hong Kong\) | All available versions | All available versions | All available versions | All available versions | All available versions | All available versions | -| Asia Pacific \(Hyderabad\) | All available versions | All available versions | All available versions | All available versions | All available versions | All available versions | -| Asia Pacific \(Melbourne\) | All available versions | All available versions | All available versions | All available versions | All available versions | All available versions | -| Asia Pacific \(Jakarta\) | All available versions | All available versions | All available versions | All available versions | All available versions | All available versions | -| Asia Pacific \(Mumbai\) | All available versions | All available versions | All available versions | All available versions | All available versions | All available versions | -| Asia Pacific \(Osaka\) | All available versions | All available versions | All available versions | All available versions | All available versions | All available versions | -| Asia Pacific \(Seoul\) | All available versions | All available versions | All available versions | All available versions | All available versions | All available versions | -| Asia Pacific \(Singapore\) | All available versions | All available versions | All available versions | All available versions | All available versions | All available versions | -| Asia Pacific \(Sydney\) | All available versions | All available versions | All available versions | All available versions | All available versions | All available versions | -| Asia Pacific \(Tokyo\) | All available versions | All available versions | All available versions | All available versions | All available versions | All available versions | -| Canada \(Central\) | All available versions | All available versions | All available versions | All available versions | All available versions | All available versions | -| China \(Beijing\) | All available versions | All available versions | All available versions | All available versions | All available versions | All available versions | -| China \(Ningxia\) | All available versions | All available versions | All available versions | All available versions | All available versions | All available versions | -| Europe \(Frankfurt\) | All available versions | All available versions | All available versions | All available versions | All available versions | All available versions | -| Europe \(Ireland\) | All available versions | All available versions | All available versions | All available versions | All available versions | All available versions | -| Europe \(London\) | All available versions | All available versions | All available versions | All available versions | All available versions | All available versions | -| Europe \(Milan\) | All available versions | All available versions | All available versions | All available versions | All available versions | All available versions | -| Europe \(Paris\) | All available versions | All available versions | All available versions | All available versions | All available versions | All available versions | -| Europe \(Spain\) | All available versions | All available versions | All available versions | All available versions | All available versions | All available versions | -| Europe \(Stockholm\) | All available versions | All available versions | All available versions | All available versions | All available versions | All available versions | -| Europe \(Zurich\) | All available versions | All available versions | All available versions | All available versions | All available versions | All available versions | -| Middle East \(Bahrain\) | All available versions | All available versions | All available versions | All available versions | All available versions | All available versions | -| Middle East \(UAE\) | All available versions | All available versions | All available versions | All available versions | All available versions | All available versions | -| South America \(São Paulo\) | All available versions | All available versions | All available versions | All available versions | All available versions | All available versions | -| AWS GovCloud \(US\-East\) | All available versions | All available versions | All available versions | All available versions | All available versions | All available versions | -| AWS GovCloud \(US\-West\) | All available versions | All available versions | All available versions | All available versions | All available versions | All available versions | - -## Dual\-stack mode with RDS for SQL Server - -The following Regions and engine versions are available for dual\-stack mode with RDS for SQL Server\. - - -| Region | RDS for SQL Server 2019 | RDS for SQL Server 2017 | RDS for SQL Server 2016 | RDS for SQL Server 2014 | -| --- | --- | --- | --- | --- | -| US East \(Ohio\) | All available versions | All available versions | All available versions | – | -| US East \(N\. Virginia\) | All available versions | All available versions | All available versions | – | -| US West \(N\. California\) | All available versions | All available versions | All available versions | – | -| US West \(Oregon\) | All available versions | All available versions | All available versions | – | -| Africa \(Cape Town\) | All available versions | All available versions | All available versions | – | -| Asia Pacific \(Hong Kong\) | All available versions | All available versions | All available versions | – | -| Asia Pacific \(Hyderabad\) | – | – | – | – | -| Asia Pacific \(Jakarta\) | All available versions | All available versions | All available versions | – | -| Asia Pacific \(Melbourne\) | – | – | – | – | -| Asia Pacific \(Mumbai\) | All available versions | All available versions | All available versions | – | -| Asia Pacific \(Osaka\) | All available versions | All available versions | All available versions | – | -| Asia Pacific \(Seoul\) | All available versions | All available versions | All available versions | – | -| Asia Pacific \(Singapore\) | All available versions | All available versions | All available versions | – | -| Asia Pacific \(Sydney\) | All available versions | All available versions | All available versions | – | -| Asia Pacific \(Tokyo\) | All available versions | All available versions | All available versions | – | -| Canada \(Central\) | All available versions | All available versions | All available versions | – | -| China \(Beijing\) | All available versions | All available versions | All available versions | – | -| China \(Ningxia\) | All available versions | All available versions | All available versions | – | -| Europe \(Frankfurt\) | All available versions | All available versions | All available versions | – | -| Europe \(Ireland\) | All available versions | All available versions | All available versions | – | -| Europe \(London\) | All available versions | All available versions | All available versions | – | -| Europe \(Milan\) | All available versions | All available versions | All available versions | – | -| Europe \(Paris\) | All available versions | All available versions | All available versions | – | -| Europe \(Spain\) | – | – | – | – | -| Europe \(Stockholm\) | All available versions | All available versions | All available versions | – | -| Europe \(Zurich\) | – | – | – | – | -| Middle East \(Bahrain\) | All available versions | All available versions | All available versions | – | -| Middle East \(UAE\) | – | – | – | – | -| South America \(São Paulo\) | All available versions | All available versions | All available versions | – | -| AWS GovCloud \(US\-East\) | All available versions | All available versions | All available versions | – | -| AWS GovCloud \(US\-West\) | All available versions | All available versions | All available versions | – | \ No newline at end of file diff --git a/doc_source/Concepts.RDS_Fea_Regions_DB-eng.Feature.EngineNativeFeatures.md b/doc_source/Concepts.RDS_Fea_Regions_DB-eng.Feature.EngineNativeFeatures.md deleted file mode 100644 index 91dbad7..0000000 --- a/doc_source/Concepts.RDS_Fea_Regions_DB-eng.Feature.EngineNativeFeatures.md +++ /dev/null @@ -1,10 +0,0 @@ -# Engine\-native features - -Amazon RDS database engines also support many of the most common engine\-native features and functionality\. These features are different than the Amazon RDS\-native features listed on this page\. Some engine\-native features might have limited support or restricted privileges\. - -For more information on engine\-native features, see: -+ [MariaDB feature support on Amazon RDS](MariaDB.Concepts.FeatureSupport.md) -+ [MySQL feature support on Amazon RDS](MySQL.Concepts.FeatureSupport.md) -+ [RDS for Oracle features](Oracle.Concepts.FeatureSupport.md) -+ [Working with PostgreSQL features supported by Amazon RDS for PostgreSQL](PostgreSQL.Concepts.General.FeatureSupport.md) -+ [Microsoft SQL Server features on Amazon RDS](CHAP_SQLServer.md#SQLServer.Concepts.General.FeatureSupport) \ No newline at end of file diff --git a/doc_source/Concepts.RDS_Fea_Regions_DB-eng.Feature.ExportSnapshotToS3.md b/doc_source/Concepts.RDS_Fea_Regions_DB-eng.Feature.ExportSnapshotToS3.md deleted file mode 100644 index 8678ad9..0000000 --- a/doc_source/Concepts.RDS_Fea_Regions_DB-eng.Feature.ExportSnapshotToS3.md +++ /dev/null @@ -1,125 +0,0 @@ -# Export snapshots to S3 - -You can export RDS DB snapshot data to an Amazon S3 bucket\. You can export all types of DB snapshots—including manual snapshots, automated system snapshots, and snapshots created by AWS Backup\. After the data is exported, you can analyze the exported data directly through tools like Amazon Athena or Amazon Redshift Spectrum\. For more information, see [Exporting DB snapshot data to Amazon S3](USER_ExportSnapshot.md)\. - -**Topics** -+ [Export snapshots to S3 with RDS for MariaDB](#Concepts.RDS_Fea_Regions_DB-eng.Feature.ExportSnapshotToS3.mdb) -+ [Export snapshots to S3 with RDS for MySQL](#Concepts.RDS_Fea_Regions_DB-eng.Feature.ExportSnapshotToS3.my) -+ [Export snapshots to S3 with RDS for PostgreSQL](#Concepts.RDS_Fea_Regions_DB-eng.Feature.ExportSnapshotToS3.pg) - -## Export snapshots to S3 with RDS for MariaDB - -The following Regions and engine versions are available for exporting snapshots to S3 with RDS for MariaDB\. - - -| Region | RDS for MariaDB 10\.6 | RDS for MariaDB 10\.5 | RDS for MariaDB 10\.4 | RDS for MariaDB 10\.3 | -| --- | --- | --- | --- | --- | -| US East \(Ohio\) | All available versions | All available versions | All available versions | All available versions | -| US East \(N\. Virginia\) | All available versions | All available versions | All available versions | All available versions | -| US West \(N\. California\) | All available versions | All available versions | All available versions | All available versions | -| US West \(Oregon\) | All available versions | All available versions | All available versions | All available versions | -| Africa \(Cape Town\) | All available versions | All available versions | All available versions | All available versions | -| Asia Pacific \(Hong Kong\) | All available versions | All available versions | All available versions | All available versions | -| Asia Pacific \(Hyderabad\) | – | – | – | – | -| Asia Pacific \(Jakarta\) | – | – | – | – | -| Asia Pacific \(Melbourne\) | – | – | – | – | -| Asia Pacific \(Mumbai\) | All available versions | All available versions | All available versions | All available versions | -| Asia Pacific \(Osaka\) | All available versions | All available versions | All available versions | All available versions | -| Asia Pacific \(Seoul\) | All available versions | All available versions | All available versions | All available versions | -| Asia Pacific \(Singapore\) | All available versions | All available versions | All available versions | All available versions | -| Asia Pacific \(Sydney\) | All available versions | All available versions | All available versions | All available versions | -| Asia Pacific \(Tokyo\) | All available versions | All available versions | All available versions | All available versions | -| Canada \(Central\) | All available versions | All available versions | All available versions | All available versions | -| China \(Beijing\) | All available versions | All available versions | All available versions | All available versions | -| China \(Ningxia\) | All available versions | All available versions | All available versions | All available versions | -| Europe \(Frankfurt\) | All available versions | All available versions | All available versions | All available versions | -| Europe \(Ireland\) | All available versions | All available versions | All available versions | All available versions | -| Europe \(London\) | All available versions | All available versions | All available versions | All available versions | -| Europe \(Milan\) | All available versions | All available versions | All available versions | All available versions | -| Europe \(Paris\) | All available versions | All available versions | All available versions | All available versions | -| Europe \(Spain\) | – | – | – | – | -| Europe \(Stockholm\) | All available versions | All available versions | All available versions | All available versions | -| Europe \(Zurich\) | – | – | – | – | -| Middle East \(Bahrain\) | All available versions | All available versions | All available versions | All available versions | -| Middle East \(UAE\) | – | – | – | – | -| South America \(São Paulo\) | All available versions | All available versions | All available versions | All available versions | -| AWS GovCloud \(US\-East\) | – | – | – | – | -| AWS GovCloud \(US\-West\) | – | – | – | – | - -## Export snapshots to S3 with RDS for MySQL - -TThe following Regions and engine versions are available for exporting snapshots to S3 with RDS for MySQL\. - - -| Region | RDS for MySQL 8\.0 | RDS for MySQL 5\.7 | -| --- | --- | --- | -| US East \(Ohio\) | All available versions | All available versions | -| US East \(N\. Virginia\) | All available versions | All available versions | -| US West \(N\. California\) | All available versions | All available versions | -| US West \(Oregon\) | All available versions | All available versions | -| Africa \(Cape Town\) | All available versions | All available versions | -| Asia Pacific \(Hong Kong\) | All available versions | All available versions | -| Asia Pacific \(Hyderabad\) | – | – | -| Asia Pacific \(Jakarta\) | – | – | -| Asia Pacific \(Melbourne\) | – | – | -| Asia Pacific \(Mumbai\) | All available versions | All available versions | -| Asia Pacific \(Osaka\) | All available versions | All available versions | -| Asia Pacific \(Seoul\) | All available versions | All available versions | -| Asia Pacific \(Singapore\) | All available versions | All available versions | -| Asia Pacific \(Sydney\) | All available versions | All available versions | -| Asia Pacific \(Tokyo\) | All available versions | All available versions | -| Canada \(Central\) | All available versions | All available versions | -| China \(Beijing\) | All available versions | All available versions | -| China \(Ningxia\) | All available versions | All available versions | -| Europe \(Frankfurt\) | All available versions | All available versions | -| Europe \(Ireland\) | All available versions | All available versions | -| Europe \(London\) | All available versions | All available versions | -| Europe \(Milan\) | All available versions | All available versions | -| Europe \(Paris\) | All available versions | All available versions | -| Europe \(Spain\) | – | – | -| Europe \(Stockholm\) | All available versions | All available versions | -| Europe \(Zurich\) | – | – | -| Middle East \(Bahrain\) | All available versions | All available versions | -| Middle East \(UAE\) | – | – | -| South America \(São Paulo\) | All available versions | All available versions | -| AWS GovCloud \(US\-East\) | – | – | -| AWS GovCloud \(US\-West\) | – | – | - -## Export snapshots to S3 with RDS for PostgreSQL - -The following Regions and engine versions are available for exporting snapshots to S3 with RDS for PostgreSQL\. - - -| Region | RDS for PostgreSQL 15 | RDS for PostgreSQL 14 | RDS for PostgreSQL 13 | RDS for PostgreSQL 12 | RDS for PostgreSQL 11 | RDS for PostgreSQL 10 | -| --- | --- | --- | --- | --- | --- | --- | -| US East \(Ohio\) | All available versions | All available versions | All available versions | All available versions | All available versions | All available versions | -| US East \(N\. Virginia\) | All available versions | All available versions | All available versions | All available versions | All available versions | All available versions | -| US West \(N\. California\) | All available versions | All available versions | All available versions | All available versions | All available versions | All available versions | -| US West \(Oregon\) | All available versions | All available versions | All available versions | All available versions | All available versions | All available versions | -| Africa \(Cape Town\) | All available versions | All available versions | All available versions | All available versions | All available versions | All available versions | -| Asia Pacific \(Hong Kong\) | All available versions | All available versions | All available versions | All available versions | All available versions | All available versions | -| Asia Pacific \(Hyderabad\) | – | – | – | – | – | – | -| Asia Pacific \(Jakarta\) | – | – | – | – | – | – | -| Asia Pacific \(Melbourne\) | – | – | – | – | – | – | -| Asia Pacific \(Mumbai\) | All available versions | All available versions | All available versions | All available versions | All available versions | All available versions | -| Asia Pacific \(Osaka\) | All available versions | All available versions | All available versions | All available versions | All available versions | All available versions | -| Asia Pacific \(Seoul\) | All available versions | All available versions | All available versions | All available versions | All available versions | All available versions | -| Asia Pacific \(Singapore\) | All available versions | All available versions | All available versions | All available versions | All available versions | All available versions | -| Asia Pacific \(Sydney\) | All available versions | All available versions | All available versions | All available versions | All available versions | All available versions | -| Asia Pacific \(Tokyo\) | All available versions | All available versions | All available versions | All available versions | All available versions | All available versions | -| Canada \(Central\) | All available versions | All available versions | All available versions | All available versions | All available versions | All available versions | -| China \(Beijing\) | All available versions | All available versions | All available versions | All available versions | All available versions | All available versions | -| China \(Ningxia\) | All available versions | All available versions | All available versions | All available versions | All available versions | All available versions | -| Europe \(Frankfurt\) | All available versions | All available versions | All available versions | All available versions | All available versions | All available versions | -| Europe \(Ireland\) | All available versions | All available versions | All available versions | All available versions | All available versions | All available versions | -| Europe \(London\) | All available versions | All available versions | All available versions | All available versions | All available versions | All available versions | -| Europe \(Milan\) | All available versions | All available versions | All available versions | All available versions | All available versions | All available versions | -| Europe \(Paris\) | All available versions | All available versions | All available versions | All available versions | All available versions | All available versions | -| Europe \(Spain\) | – | – | – | – | – | – | -| Europe \(Stockholm\) | All available versions | All available versions | All available versions | All available versions | All available versions | All available versions | -| Europe \(Zurich\) | – | – | – | – | – | – | -| Middle East \(Bahrain\) | All available versions | All available versions | All available versions | All available versions | All available versions | All available versions | -| Middle East \(UAE\) | – | – | – | – | – | – | -| South America \(São Paulo\) | All available versions | All available versions | All available versions | All available versions | All available versions | All available versions | -| AWS GovCloud \(US\-East\) | – | – | – | – | – | – | -| AWS GovCloud \(US\-West\) | – | – | – | – | – | – | \ No newline at end of file diff --git a/doc_source/Concepts.RDS_Fea_Regions_DB-eng.Feature.IamDatabaseAuthentication.md b/doc_source/Concepts.RDS_Fea_Regions_DB-eng.Feature.IamDatabaseAuthentication.md deleted file mode 100644 index f57cae1..0000000 --- a/doc_source/Concepts.RDS_Fea_Regions_DB-eng.Feature.IamDatabaseAuthentication.md +++ /dev/null @@ -1,68 +0,0 @@ -# IAM database authentication - -By using IAM database authentication in Amazon RDS, you can authenticate without a password when you connect to a DB instance\. Instead, you use an authentication token\. For more information, see [IAM database authentication for MariaDB, MySQL, and PostgreSQL](UsingWithRDS.IAMDBAuth.md)\. - -IAM database authentication isn't available with the following engines: -+ RDS for Oracle -+ RDS for SQL Server - -**Topics** -+ [IAM database authentication with RDS for MariaDB](#Concepts.RDS_Fea_Regions_DB-eng.Feature.IamDatabaseAuthentication.mdb) -+ [IAM database authentication with RDS for MySQL](#Concepts.RDS_Fea_Regions_DB-eng.Feature.IamDatabaseAuthentication.my) -+ [IAM database authentication with RDS for PostgreSQL](#Concepts.RDS_Fea_Regions_DB-eng.Feature.IamDatabaseAuthentication.pg) - -## IAM database authentication with RDS for MariaDB - -The following Regions and engine versions are available for IAM database authentication with RDS for MariaDB\. - - -| Region | RDS for MariaDB 10\.6 | RDS for MariaDB 10\.5 | RDS for MariaDB 10\.4 | RDS for MariaDB 10\.3 | -| --- | --- | --- | --- | --- | -| US East \(Ohio\) | Version 10\.6 and higher | – | – | – | -| US East \(N\. Virginia\) | Version 10\.6 and higher | – | – | – | -| US West \(N\. California\) | Version 10\.6 and higher | – | – | – | -| US West \(Oregon\) | Version 10\.6 and higher | – | – | – | -| Africa \(Cape Town\) | Version 10\.6 and higher | – | – | – | -| Asia Pacific \(Hong Kong\) | Version 10\.6 and higher | – | – | – | -| Asia Pacific \(Hyderabad\) | – | – | – | – | -| Asia Pacific \(Jakarta\) | Version 10\.6 and higher | – | – | – | -| Asia Pacific \(Melbourne\) | – | – | – | – | -| Asia Pacific \(Mumbai\) | Version 10\.6 and higher | – | – | – | -| Asia Pacific \(Osaka\) | Version 10\.6 and higher | – | – | – | -| Asia Pacific \(Seoul\) | Version 10\.6 and higher | – | – | – | -| Asia Pacific \(Singapore\) | Version 10\.6 and higher | – | – | – | -| Asia Pacific \(Sydney\) | Version 10\.6 and higher | – | – | – | -| Asia Pacific \(Tokyo\) | Version 10\.6 and higher | – | – | – | -| Canada \(Central\) | Version 10\.6 and higher | – | – | – | -| China \(Beijing\) | Version 10\.6 and higher | – | – | – | -| China \(Ningxia\) | Version 10\.6 and higher | – | – | – | -| Europe \(Frankfurt\) | Version 10\.6 and higher | – | – | – | -| Europe \(Ireland\) | Version 10\.6 and higher | – | – | – | -| Europe \(London\) | Version 10\.6 and higher | – | – | – | -| Europe \(Milan\) | Version 10\.6 and higher | – | – | – | -| Europe \(Paris\) | Version 10\.6 and higher | – | – | – | -| Europe \(Spain\) | – | – | – | – | -| Europe \(Stockholm\) | Version 10\.6 and higher | – | – | – | -| Europe \(Zurich\) | – | – | – | – | -| Europe \(Zurich\) | – | – | – | – | -| Middle East \(Bahrain\) | Version 10\.6 and higher | – | – | – | -| Middle East \(UAE\) | – | – | – | – | -| South America \(São Paulo\) | Version 10\.6 and higher | – | – | – | -| AWS GovCloud \(US\-East\) | Version 10\.6 and higher | – | – | – | -| AWS GovCloud \(US\-West\) | Version 10\.6 and higher | – | – | – | - -## IAM database authentication with RDS for MySQL - -IAM database authentication with RDS for MySQL is available in all Regions for the following versions: -+ RDS for MySQL 8\.0 – All available versions -+ RDS for MySQL 5\.7 – All available versions - -## IAM database authentication with RDS for PostgreSQL - -IAM database authentication with RDS for PostgreSQL is available in all Regions for the following versions: -+ RDS for PostgreSQL 15 – All available versions -+ RDS for PostgreSQL 14 – All available versions -+ RDS for PostgreSQL 13 – All available versions -+ RDS for PostgreSQL 12 – All available versions -+ RDS for PostgreSQL 11 – All available versions -+ RDS for PostgreSQL 10 – All available versions \ No newline at end of file diff --git a/doc_source/Concepts.RDS_Fea_Regions_DB-eng.Feature.KerberosAuthentication.md b/doc_source/Concepts.RDS_Fea_Regions_DB-eng.Feature.KerberosAuthentication.md deleted file mode 100644 index 5e02c25..0000000 --- a/doc_source/Concepts.RDS_Fea_Regions_DB-eng.Feature.KerberosAuthentication.md +++ /dev/null @@ -1,168 +0,0 @@ -# Kerberos authentication - -By using Kerberos authentication in Amazon RDS, you can support external authentication of database users using Kerberos and Microsoft Active Directory\. Using Kerberos and Active Directory provides the benefits of single sign\-on and centralized authentication of database users\. For more information, see [Kerberos authentication](database-authentication.md#kerberos-authentication)\. - -Kerberos authentication isn't available with the following engines: -+ RDS for MariaDB - -**Topics** -+ [Kerberos authentication with RDS for MySQL](#Concepts.RDS_Fea_Regions_DB-eng.Feature.KerberosAuthentication.my) -+ [Kerberos authentication with RDS for Oracle](#Concepts.RDS_Fea_Regions_DB-eng.Feature.KerberosAuthentication.ora) -+ [Kerberos authentication with RDS for PostgreSQL](#Concepts.RDS_Fea_Regions_DB-eng.Feature.KerberosAuthentication.pg) -+ [Kerberos authentication with RDS for SQL Server](#Concepts.RDS_Fea_Regions_DB-eng.Feature.KerberosAuthentication.sq) - -## Kerberos authentication with RDS for MySQL - -The following Regions and engine versions are available for Kerberos authentication with RDS for MySQL\. - - -| Region | RDS for MySQL 8\.0 | RDS for MySQL 5\.7 | RDS for MySQL 5\.6 | -| --- | --- | --- | --- | -| US East \(Ohio\) | All versions | All versions | All versions | -| US East \(N\. Virginia\) | All versions | All versions | All versions | -| US West \(N\. California\) | All versions | All versions | All versions | -| US West \(Oregon\) | All versions | All versions | All versions | -| Africa \(Cape Town\) | – | – | – | -| Asia Pacific \(Hong Kong\) | – | – | – | -| Asia Pacific \(Hyderabad\) | – | – | – | -| Asia Pacific \(Jakarta\) | – | – | – | -| Asia Pacific \(Melbourne\) | – | – | – | -| Asia Pacific \(Mumbai\) | All versions | All versions | All versions | -| Asia Pacific \(Osaka\) | – | – | – | -| Asia Pacific \(Seoul\) | All versions | All versions | All versions | -| Asia Pacific \(Singapore\) | All versions | All versions | All versions | -| Asia Pacific \(Sydney\) | All versions | All versions | All versions | -| Asia Pacific \(Tokyo\) | All versions | All versions | All versions | -| Canada \(Central\) | All versions | All versions | All versions | -| China \(Beijing\) | All versions | All versions | All versions | -| China \(Ningxia\) | All versions | All versions | All versions | -| Europe \(Frankfurt\) | All versions | All versions | All versions | -| Europe \(Ireland\) | All versions | All versions | All versions | -| Europe \(London\) | All versions | All versions | All versions | -| Europe \(Milan\) | – | – | – | -| Europe \(Paris\) | – | – | – | -| Europe \(Spain\) | – | – | – | -| Europe \(Stockholm\) | All versions | All versions | All versions | -| Europe \(Zurich\) | – | – | – | -| Middle East \(Bahrain\) | – | – | – | -| Middle East \(UAE\) | – | – | – | -| South America \(São Paulo\) | All versions | All versions | All versions | -| AWS GovCloud \(US\-East\) | – | – | – | -| AWS GovCloud \(US\-West\) | – | – | – | - -## Kerberos authentication with RDS for Oracle - -The following Regions and engine versions are available for Kerberos authentication with RDS for Oracle\. - - -| Region | RDS for Oracle 21c | RDS for Oracle 19c | RDS for Oracle 12c | -| --- | --- | --- | --- | -| US East \(Ohio\) | All versions | All versions | All versions | -| US East \(N\. Virginia\) | All versions | All versions | All versions | -| US West \(N\. California\) | All versions | All versions | All versions | -| US West \(Oregon\) | All versions | All versions | All versions | -| Africa \(Cape Town\) | – | – | – | -| Asia Pacific \(Hong Kong\) | – | – | – | -| Asia Pacific \(Hyderabad\) | – | – | – | -| Asia Pacific \(Jakarta\) | – | – | – | -| Asia Pacific \(Melbourne\) | – | – | – | -| Asia Pacific \(Mumbai\) | All versions | All versions | All versions | -| Asia Pacific \(Osaka\) | – | – | – | -| Asia Pacific \(Seoul\) | All versions | All versions | All versions | -| Asia Pacific \(Singapore\) | All versions | All versions | All versions | -| Asia Pacific \(Sydney\) | All versions | All versions | All versions | -| Asia Pacific \(Tokyo\) | All versions | All versions | All versions | -| Canada \(Central\) | All versions | All versions | All versions | -| China \(Beijing\) | – | – | – | -| China \(Ningxia\) | – | – | – | -| Europe \(Frankfurt\) | All versions | All versions | All versions | -| Europe \(Ireland\) | All versions | All versions | All versions | -| Europe \(London\) | All versions | All versions | All versions | -| Europe \(Milan\) | – | – | – | -| Europe \(Paris\) | – | – | – | -| Europe \(Spain\) | – | – | – | -| Europe \(Stockholm\) | All versions | All versions | All versions | -| Europe \(Zurich\) | – | – | – | -| Middle East \(Bahrain\) | – | – | – | -| Middle East \(UAE\) | – | – | – | -| South America \(São Paulo\) | All versions | All versions | All versions | -| AWS GovCloud \(US\-East\) | All versions | All versions | All versions | -| AWS GovCloud \(US\-West\) | All versions | All versions | All versions | - -## Kerberos authentication with RDS for PostgreSQL - -The following Regions and engine versions are available for Kerberos authentication with RDS for PostgreSQL\. - - -| Region | RDS for PostgreSQL 15 | RDS for PostgreSQL 14 | RDS for PostgreSQL 13 | RDS for PostgreSQL 12 | RDS for PostgreSQL 11 | RDS for PostgreSQL 10 | -| --- | --- | --- | --- | --- | --- | --- | -| US East \(Ohio\) | All versions | All versions | All versions | All versions | All versions | All versions | -| US East \(N\. Virginia\) | All versions | All versions | All versions | All versions | All versions | All versions | -| US West \(N\. California\) | All versions | All versions | All versions | All versions | All versions | All versions | -| US West \(Oregon\) | All versions | All versions | All versions | All versions | All versions | All versions | -| Africa \(Cape Town\) | – | – | – | – | – | – | -| Asia Pacific \(Hong Kong\) | – | – | – | – | – | – | -| Asia Pacific \(Hyderabad\) | – | – | – | – | – | – | -| Asia Pacific \(Jakarta\) | – | – | – | – | – | – | -| Asia Pacific \(Melbourne\) | – | – | – | – | – | – | -| Asia Pacific \(Mumbai\) | All versions | All versions | All versions | All versions | All versions | All versions | -| Asia Pacific \(Osaka\) | – | – | – | – | – | – | -| Asia Pacific \(Seoul\) | All versions | All versions | All versions | All versions | All versions | All versions | -| Asia Pacific \(Singapore\) | All versions | All versions | All versions | All versions | All versions | All versions | -| Asia Pacific \(Sydney\) | All versions | All versions | All versions | All versions | All versions | All versions | -| Asia Pacific \(Tokyo\) | All versions | All versions | All versions | All versions | All versions | All versions | -| Canada \(Central\) | All versions | All versions | All versions | All versions | All versions | All versions | -| China \(Beijing\) | All versions | All versions | All versions | All versions | All versions | All versions | -| China \(Ningxia\) | All versions | All versions | All versions | All versions | All versions | All versions | -| Europe \(Frankfurt\) | All versions | All versions | All versions | All versions | All versions | All versions | -| Europe \(Ireland\) | All versions | All versions | All versions | All versions | All versions | All versions | -| Europe \(London\) | All versions | All versions | All versions | All versions | All versions | All versions | -| Europe \(Milan\) | – | – | – | – | – | – | -| Europe \(Paris\) | All versions | All versions | All versions | All versions | All versions | All versions | -| Europe \(Spain\) | – | – | – | – | – | – | -| Europe \(Stockholm\) | All versions | All versions | All versions | All versions | All versions | All versions | -| Europe \(Zurich\) | – | – | – | – | – | – | -| Middle East \(Bahrain\) | – | – | – | – | – | – | -| Middle East \(UAE\) | – | – | – | – | – | – | -| South America \(São Paulo\) | All versions | All versions | All versions | All versions | All versions | All versions | -| AWS GovCloud \(US\-East\) | – | – | – | – | – | – | -| AWS GovCloud \(US\-West\) | – | – | – | – | – | – | - -## Kerberos authentication with RDS for SQL Server - -The following Regions and engine versions are available for Kerberos authentication with RDS for SQL Server\. - - -| Region | RDS for SQL Server 2019 | RDS for SQL Server 2017 | RDS for SQL Server 2016 | RDS for SQL Server 2014 | -| --- | --- | --- | --- | --- | -| US East \(Ohio\) | All versions | All versions | All versions | All versions | -| US East \(N\. Virginia\) | All versions | All versions | All versions | All versions | -| US West \(N\. California\) | All versions | All versions | All versions | All versions | -| US West \(Oregon\) | All versions | All versions | All versions | All versions | -| Africa \(Cape Town\) | All versions | All versions | All versions | All versions | -| Asia Pacific \(Hong Kong\) | All versions | All versions | All versions | All versions | -| Asia Pacific \(Hyderabad\) | – | – | – | – | -| Asia Pacific \(Jakarta\) | – | – | – | – | -| Asia Pacific \(Melbourne\) | – | – | – | – | -| Asia Pacific \(Mumbai\) | All versions | All versions | All versions | All versions | -| Asia Pacific \(Osaka\) | All versions | All versions | All versions | All versions | -| Asia Pacific \(Seoul\) | All versions | All versions | All versions | All versions | -| Asia Pacific \(Singapore\) | All versions | All versions | All versions | All versions | -| Asia Pacific \(Sydney\) | All versions | All versions | All versions | All versions | -| Asia Pacific \(Tokyo\) | All versions | All versions | All versions | All versions | -| Canada \(Central\) | All versions | All versions | All versions | All versions | -| China \(Beijing\) | All versions | All versions | All versions | All versions | -| China \(Ningxia\) | All versions | All versions | All versions | All versions | -| Europe \(Frankfurt\) | All versions | All versions | All versions | All versions | -| Europe \(Ireland\) | All versions | All versions | All versions | All versions | -| Europe \(London\) | All versions | All versions | All versions | All versions | -| Europe \(Milan\) | All versions | All versions | All versions | All versions | -| Europe \(Paris\) | All versions | All versions | All versions | All versions | -| Europe \(Spain\) | – | – | – | – | -| Europe \(Stockholm\) | All versions | All versions | All versions | All versions | -| Europe \(Zurich\) | – | – | – | – | -| Middle East \(Bahrain\) | All versions | All versions | All versions | All versions | -| Middle East \(UAE\) | – | – | – | – | -| South America \(São Paulo\) | All versions | All versions | All versions | All versions | -| AWS GovCloud \(US\-East\) | All versions | All versions | All versions | All versions | -| AWS GovCloud \(US\-West\) | All versions | All versions | All versions | All versions | \ No newline at end of file diff --git a/doc_source/Concepts.RDS_Fea_Regions_DB-eng.Feature.MultiAZDBClusters.md b/doc_source/Concepts.RDS_Fea_Regions_DB-eng.Feature.MultiAZDBClusters.md deleted file mode 100644 index eed5906..0000000 --- a/doc_source/Concepts.RDS_Fea_Regions_DB-eng.Feature.MultiAZDBClusters.md +++ /dev/null @@ -1,138 +0,0 @@ -# Multi\-AZ DB clusters - -A Multi\-AZ DB cluster deployment in Amazon RDS provides a high availability deployment mode of Amazon RDS with two readable standby DB instances\. A Multi\-AZ DB cluster has a writer DB instance and two reader DB instances in three separate Availability Zones in the same Region\. Multi\-AZ DB clusters provide high availability, increased capacity for read workloads, and lower write latency when compared to Multi\-AZ DB instance deployments\. For more information, see [Multi\-AZ DB cluster deployments](multi-az-db-clusters-concepts.md)\. - -Multi\-AZ DB clusters aren't available with the following engines: -+ RDS for MariaDB -+ RDS for Oracle -+ RDS for SQL Server - -**Topics** -+ [Multi\-AZ DB clusters with RDS for MySQL](#Concepts.RDS_Fea_Regions_DB-eng.Feature.MultiAZDBClusters.my) -+ [Multi\-AZ DB clusters with RDS for PostgreSQL](#Concepts.RDS_Fea_Regions_DB-eng.Feature.MultiAZDBClusters.pg) - -## Multi\-AZ DB clusters with RDS for MySQL - -The following Regions and engine versions are available for Multi\-AZ DB clusters with RDS for MySQL\. - - -| Region | RDS for MySQL 8\.0 | -| --- | --- | -| US East \(Ohio\) | Version 8\.0\.28 and higher | -| US East \(N\. Virginia\) | Version 8\.0\.28 and higher | -| US West \(N\. California\) | – | -| US West \(Oregon\) | Version 8\.0\.28 and higher | -| Africa \(Cape Town\) | Version 8\.0\.28 and higher | -| Asia Pacific \(Hong Kong\) | Version 8\.0\.28 and higher | -| Asia Pacific \(Hyderabad\) | – | -| Asia Pacific \(Jakarta\) | Version 8\.0\.28 and higher | -| Asia Pacific \(Melbourne\) | – | -| Asia Pacific \(Mumbai\) | Version 8\.0\.28 and higher | -| Asia Pacific \(Osaka\) | Version 8\.0\.28 and higher | -| Asia Pacific \(Seoul\) | Version 8\.0\.28 and higher | -| Asia Pacific \(Singapore\) | Version 8\.0\.28 and higher | -| Asia Pacific \(Sydney\) | Version 8\.0\.28 and higher | -| Asia Pacific \(Tokyo\) | Version 8\.0\.28 and higher | -| Canada \(Central\) | Version 8\.0\.28 and higher | -| China \(Beijing\) | Version 8\.0\.28 and higher | -| China \(Ningxia\) | Version 8\.0\.28 and higher | -| Europe \(Frankfurt\) | Version 8\.0\.28 and higher | -| Europe \(Ireland\) | Version 8\.0\.28 and higher | -| Europe \(London\) | Version 8\.0\.28 and higher | -| Europe \(Milan\) | Version 8\.0\.28 and higher | -| Europe \(Paris\) | Version 8\.0\.28 and higher | -| Europe \(Spain\) | – | -| Europe \(Stockholm\) | Version 8\.0\.28 and higher | -| Europe \(Zurich\) | – | -| Middle East \(Bahrain\) | Version 8\.0\.28 and higher | -| Middle East \(UAE\) | – | -| South America \(São Paulo\) | Version 8\.0\.28 and higher | -| AWS GovCloud \(US\-East\) | – | -| AWS GovCloud \(US\-West\) | – | - -You can also list the available versions in a Region for the db\.r5d\.large DB instance class by running the following AWS CLI command\. - -For Linux, macOS, or Unix: - -``` -aws rds describe-orderable-db-instance-options \ ---engine mysql \ ---db-instance-class db.r5d.large \ ---query '*[]|[?SupportsClusters == `true`].[EngineVersion]' \ ---output text -``` - -For Windows: - -``` -aws rds describe-orderable-db-instance-options ^ ---engine mysql ^ ---db-instance-class db.r5d.large ^ ---query "*[]|[?SupportsClusters == `true`].[EngineVersion]" ^ ---output text -``` - -You can change the DB instance class to show the available engine versions for it\. - -## Multi\-AZ DB clusters with RDS for PostgreSQL - -The following Regions and engine versions are available for Multi\-AZ DB clusters with RDS for PostgreSQL\. - - -| Region | RDS for PostgreSQL 15 | RDS for PostgreSQL 14 | RDS for PostgreSQL 13 | -| --- | --- | --- | --- | -| US East \(Ohio\) | All PostgreSQL 15 versions | Version 14\.5 and higher | Version 13\.4 and version 13\.7 and higher | -| US East \(N\. Virginia\) | All PostgreSQL 15 versions | Version 14\.5 and higher | Version 13\.4 and version 13\.7 and higher | -| US West \(N\. California\) | – | – | – | -| US West \(Oregon\) | All PostgreSQL 15 versions | Version 14\.5 and higher | Version 13\.4 and version 13\.7 and higher | -| Africa \(Cape Town\) | All PostgreSQL 15 versions | Version 14\.5 and higher | Version 13\.4 and version 13\.7 and higher | -| Asia Pacific \(Hong Kong\) | All PostgreSQL 15 versions | Version 14\.5 and higher | Version 13\.4 and version 13\.7 and higher | -| Asia Pacific \(Hyderabad\) | – | – | – | -| Asia Pacific \(Jakarta\) | All PostgreSQL 15 versions | Version 14\.5 and higher | Version 13\.4 and version 13\.7 and higher | -| Asia Pacific \(Melbourne\) | – | – | – | -| Asia Pacific \(Mumbai\) | All PostgreSQL 15 versions | Version 14\.5 and higher | Version 13\.4 and version 13\.7 and higher | -| Asia Pacific \(Osaka\) | All PostgreSQL 15 versions | Version 14\.5 and higher | Version 13\.4 and version 13\.7 and higher | -| Asia Pacific \(Seoul\) | All PostgreSQL 15 versions | Version 14\.5 and higher | Version 13\.4 and version 13\.7 and higher | -| Asia Pacific \(Singapore\) | All PostgreSQL 15 versions | Version 14\.5 and higher | Version 13\.4 and version 13\.7 and higher | -| Asia Pacific \(Sydney\) | All PostgreSQL 15 versions | Version 14\.5 and higher | Version 13\.4 and version 13\.7 and higher | -| Asia Pacific \(Tokyo\) | All PostgreSQL 15 versions | Version 14\.5 and higher | Version 13\.4 and version 13\.7 and higher | -| Canada \(Central\) | All PostgreSQL 15 versions | Version 14\.5 and higher | Version 13\.4 and version 13\.7 and higher | -| China \(Beijing\) | All PostgreSQL 15 versions | Version 14\.5 and higher | Version 13\.4 and version 13\.7 and higher | -| China \(Ningxia\) | All PostgreSQL 15 versions | Version 14\.5 and higher | Version 13\.4 and version 13\.7 and higher | -| Europe \(Frankfurt\) | All PostgreSQL 15 versions | Version 14\.5 and higher | Version 13\.4 and version 13\.7 and higher | -| Europe \(Ireland\) | All PostgreSQL 15 versions | Version 14\.5 and higher | Version 13\.4 and version 13\.7 and higher | -| Europe \(London\) | All PostgreSQL 15 versions | Version 14\.5 and higher | Version 13\.4 and version 13\.7 and higher | -| Europe \(Milan\) | All PostgreSQL 15 versions | Version 14\.5 and higher | Version 13\.4 and version 13\.7 and higher | -| Europe \(Paris\) | All PostgreSQL 15 versions | Version 14\.5 and higher | Version 13\.4 and version 13\.7 and higher | -| Europe \(Spain\) | – | – | – | -| Europe \(Stockholm\) | All PostgreSQL 15 versions | Version 14\.5 and higher | Version 13\.4 and version 13\.7 and higher | -| Europe \(Zurich\) | – | – | – | -| Middle East \(Bahrain\) | All PostgreSQL 15 versions | Version 14\.5 and higher | Version 13\.4 and version 13\.7 and higher | -| Middle East \(UAE\) | – | – | – | -| South America \(São Paulo\) | All PostgreSQL 15 versions | Version 14\.5 and higher | Version 13\.4 and version 13\.7 and higher | -| AWS GovCloud \(US\-East\) | – | – | – | -| AWS GovCloud \(US\-West\) | – | – | – | - -You can also list the available versions in a Region for the db\.r5d\.large DB instance class by running the following AWS CLI command\. - -For Linux, macOS, or Unix: - -``` -aws rds describe-orderable-db-instance-options \ ---engine postgres \ ---db-instance-class db.r5d.large \ ---query '*[]|[?SupportsClusters == `true`].[EngineVersion]' \ ---output text -``` - -For Windows: - -``` -aws rds describe-orderable-db-instance-options ^ ---engine postgres ^ ---db-instance-class db.r5d.large ^ ---query "*[]|[?SupportsClusters == `true`].[EngineVersion]" ^ ---output text -``` - -You can change the DB instance class to show the available engine versions for it\. \ No newline at end of file diff --git a/doc_source/Concepts.RDS_Fea_Regions_DB-eng.Feature.PerformanceInsights.md b/doc_source/Concepts.RDS_Fea_Regions_DB-eng.Feature.PerformanceInsights.md deleted file mode 100644 index 728f1a4..0000000 --- a/doc_source/Concepts.RDS_Fea_Regions_DB-eng.Feature.PerformanceInsights.md +++ /dev/null @@ -1,7 +0,0 @@ -# Performance Insights - -Performance Insights in Amazon RDS expands on existing Amazon RDS monitoring features to illustrate and help you analyze your database performance\. With the Performance Insights dashboard, you can visualize the database load on your Amazon RDS DB instance\. You can also filter the load by waits, SQL statements, hosts, or users\. For more information, see [Monitoring DB load with Performance Insights on Amazon RDS](USER_PerfInsights.md)\. - -Performance Insights is available for all RDS DB engines and all versions\. - -Performance Insights is available in all AWS Regions\. \ No newline at end of file diff --git a/doc_source/Concepts.RDS_Fea_Regions_DB-eng.Feature.RDSCustom.md b/doc_source/Concepts.RDS_Fea_Regions_DB-eng.Feature.RDSCustom.md deleted file mode 100644 index 5ef95ab..0000000 --- a/doc_source/Concepts.RDS_Fea_Regions_DB-eng.Feature.RDSCustom.md +++ /dev/null @@ -1,90 +0,0 @@ -# RDS Custom - -Amazon RDS Custom automates database administration tasks and operations\. By using RDS Custom, as a database administrator you can access and customize your database environment and operating system\. With RDS Custom, you can customize to meet the requirements of legacy, custom, and packaged applications\. For more information, see [Working with Amazon RDS Custom](rds-custom.md)\. - -RDS Custom is supported for the following DB engines only: -+ RDS for Oracle -+ RDS for SQL Server - -**Topics** -+ [RDS Custom for Oracle](#Concepts.RDS_Fea_Regions_DB-eng.Feature.RDSCustom.ora) -+ [RDS Custom for SQL Server](#Concepts.RDS_Fea_Regions_DB-eng.Feature.RDSCustom.sq) - -## RDS Custom for Oracle - -The following Regions and engine versions are available for RDS Custom for Oracle\. - - -| Region | RDS for Oracle 19c | RDS for Oracle 18c | RDS for Oracle 12c | -| --- | --- | --- | --- | -| US East \(Ohio\) | 19c with the January 2021 or higher RU/RUR | 18c with the January 2021 or higher RU/RUR | 12\.1 and 12\.2 with the January 2021 or higher RU/RUR | -| US East \(N\. Virginia\) | 19c with the January 2021 or higher RU/RUR | 18c with the January 2021 or higher RU/RUR | 12\.1 and 12\.2 with the January 2021 or higher RU/RUR | -| US West \(N\. California\) | – | – | – | -| US West \(Oregon\) | 19c with the January 2021 or higher RU/RUR | 18c with the January 2021 or higher RU/RUR | 12\.1 and 12\.2 with the January 2021 or higher RU/RUR | -| Africa \(Cape Town\) | – | – | – | -| Asia Pacific \(Hong Kong\) | – | – | – | -| Asia Pacific \(Jakarta\) | – | – | – | -| Asia Pacific \(Melbourne\) | – | – | – | -| Asia Pacific \(Mumbai\) | 19c with the January 2021 or higher RU/RUR | 18c with the January 2021 or higher RU/RUR | 12\.1 and 12\.2 with the January 2021 or higher RU/RUR | -| Asia Pacific \(Osaka\) | 19c with the January 2021 or higher RU/RUR | 18c with the January 2021 or higher RU/RUR | 12\.1 and 12\.2 with the January 2021 or higher RU/RUR | -| Asia Pacific \(Seoul\) | 19c with the January 2021 or higher RU/RUR | 18c with the January 2021 or higher RU/RUR | 12\.1 and 12\.2 with the January 2021 or higher RU/RUR | -| Asia Pacific \(Singapore\) | 19c with the January 2021 or higher RU/RUR | 18c with the January 2021 or higher RU/RUR | 12\.1 and 12\.2 with the January 2021 or higher RU/RUR | -| Asia Pacific \(Sydney\) | 19c with the January 2021 or higher RU/RUR | 18c with the January 2021 or higher RU/RUR | 12\.1 and 12\.2 with the January 2021 or higher RU/RUR | -| Asia Pacific \(Tokyo\) | 19c with the January 2021 or higher RU/RUR | 18c with the January 2021 or higher RU/RUR | 12\.1 and 12\.2 with the January 2021 or higher RU/RUR | -| Canada \(Central\) | 19c with the January 2021 or higher RU/RUR | 18c with the January 2021 or higher RU/RUR | 12\.1 and 12\.2 with the January 2021 or higher RU/RUR | -| China \(Beijing\) | – | – | – | -| China \(Ningxia\) | – | – | – | -| Europe \(Frankfurt\) | 19c with the January 2021 or higher RU/RUR | 18c with the January 2021 or higher RU/RUR | 12\.1 and 12\.2 with the January 2021 or higher RU/RUR | -| Europe \(Ireland\) | 19c with the January 2021 or higher RU/RUR | 18c with the January 2021 or higher RU/RUR | 12\.1 and 12\.2 with the January 2021 or higher RU/RUR | -| Europe \(London\) | 19c with the January 2021 or higher RU/RUR | 18c with the January 2021 or higher RU/RUR | 12\.1 and 12\.2 with the January 2021 or higher RU/RUR | -| Europe \(Milan\) | – | – | – | -| Europe \(Paris\) | – | – | – | -| Europe \(Stockholm\) | 19c with the January 2021 or higher RU/RUR | 18c with the January 2021 or higher RU/RUR | 12\.1 and 12\.2 with the January 2021 or higher RU/RUR | -| Middle East \(Bahrain\) | – | – | – | -| Middle East \(UAE\) | – | – | – | -| South America \(São Paulo\) | 19c with the January 2021 or higher RU/RUR | 18c with the January 2021 or higher RU/RUR | 12\.1 and 12\.2 with the January 2021 or higher RU/RUR | -| AWS GovCloud \(US\-East\) | – | – | – | -| AWS GovCloud \(US\-West\) | – | – | – | - -## RDS Custom for SQL Server - -You can deploy RDS Custom for SQL Server by using either an RDS provided engine version \(RPEV\) or a custom engine version \(CEV\): -+ If you use an RPEV, it includes the default Amazon Machine Image \(AMI\) and SQL Server installation\. If you customize or modify the operating system \(OS\), your changes might not persist during patching, snapshot restore, or automatic recovery\. -+ If you use a CEV, you choose your own AMI with either pre\-installed Microsoft SQL Server or SQL Server that you install using your own media\. When using an AWS provided CEV, you choose the latest Amazon EC2 image \(AMI\) available by AWS, which has the cumulative update \(CU\) supported by RDS Custom for SQL Server\. With a CEV, you can customize both the OS and SQL Server configuration to meet your enterprise needs\. - -The following AWS Regions and DB engine versions are available for RDS Custom for SQL Server\. The engine version support depends on whether you're using RDS Custom for SQL Server with an RPEV, AWS provided CEV, or customer\-provided CEV\. - - -| Region | RPEV | AWS provided CEV | Customer\-provided CEV | -| --- | --- | --- | --- | -| US East \(Ohio\) | Enterprise, Standard, or Web SQL Server 2019 with CU8, CU17, CU18, CU20 | Enterprise, Standard, or Web SQL Server 2019 with CU17, CU18, CU20 | Enterprise or Standard SQL Server 2019 with CU17, CU18, CU20 | -| US East \(N\. Virginia\) | Enterprise, Standard, or Web SQL Server 2019 with CU8, CU17, CU18, CU20 | Enterprise, Standard, or Web SQL Server 2019 with CU17, CU18, CU20 | Enterprise or Standard SQL Server 2019 with CU17, CU18, CU20 | -| US West \(N\. California\) | – | – | – | -| US West \(Oregon\) | Enterprise, Standard, or Web SQL Server 2019 with CU8, CU17, CU18, CU20 | Enterprise, Standard, or Web SQL Server 2019 with CU17, CU18, CU20 | Enterprise or Standard SQL Server 2019 with CU17, CU18, CU20 | -| Africa \(Cape Town\) | – | – | – | -| Asia Pacific \(Hong Kong\) | – | – | – | -| Asia Pacific \(Hyderabad\) | – | – | – | -| Asia Pacific \(Jakarta\) | – | – | – | -| Asia Pacific \(Melbourne\) | – | – | – | -| Asia Pacific \(Mumbai\) | Enterprise, Standard, or Web SQL Server 2019 with CU8, CU17, CU18, CU20 | Enterprise, Standard, or Web SQL Server 2019 with CU17, CU18, CU20 | Enterprise or Standard SQL Server 2019 with CU17, CU18, CU20 | -| Asia Pacific \(Osaka\) | – | – | – | -| Asia Pacific \(Seoul\) | Enterprise, Standard, or Web SQL Server 2019 with CU8, CU17, CU18, CU20 | Enterprise, Standard, or Web SQL Server 2019 with CU17, CU18, CU20 | Enterprise or Standard SQL Server 2019 with CU17, CU18, CU20 | -| Asia Pacific \(Singapore\) | Enterprise, Standard, or Web SQL Server 2019 with CU8, CU17, CU18, CU20 | Enterprise, Standard, or Web SQL Server 2019 with CU17, CU18, CU20 | Enterprise or Standard SQL Server 2019 with CU17, CU18, CU20 | -| Asia Pacific \(Sydney\) | Enterprise, Standard, or Web SQL Server 2019 with CU8, CU17, CU18, CU20 | Enterprise, Standard, or Web SQL Server 2019 with CU17, CU18, CU20 | Enterprise or Standard SQL Server 2019 with CU17, CU18, CU20 | -| Asia Pacific \(Tokyo\) | Enterprise, Standard, or Web SQL Server 2019 with CU8, CU17, CU18, CU20 | Enterprise, Standard, or Web SQL Server 2019 with CU17, CU18, CU20 | Enterprise or Standard SQL Server 2019 with CU17, CU18, CU20 | -| Canada \(Central\) | Enterprise, Standard, or Web SQL Server 2019 with CU8, CU17, CU18, CU20 | Enterprise, Standard, or Web SQL Server 2019 with CU17, CU18, CU20 | Enterprise or Standard SQL Server 2019 with CU17, CU18, CU20 | -| China \(Beijing\) | – | – | – | -| China \(Ningxia\) | – | – | – | -| Europe \(Frankfurt\) | Enterprise, Standard, or Web SQL Server 2019 with CU8, CU17, CU18, CU20 | Enterprise, Standard, or Web SQL Server 2019 with CU17, CU18, CU20 | Enterprise or Standard SQL Server 2019 with CU17, CU18, CU20 | -| Europe \(Ireland\) | Enterprise, Standard, or Web SQL Server 2019 with CU8, CU17, CU18, CU20 | Enterprise, Standard, or Web SQL Server 2019 with CU17, CU18, CU20 | Enterprise or Standard SQL Server 2019 with CU17, CU18, CU20 | -| Europe \(London\) | Enterprise, Standard, or Web SQL Server 2019 with CU8, CU17, CU18, CU20 | Enterprise, Standard, or Web SQL Server 2019 with CU17, CU18, CU20 | Enterprise or Standard SQL Server 2019 with CU17, CU18, CU20 | -| Europe \(Milan\) | – | – | – | -| Europe \(Paris\) | – | – | – | -| Europe \(Spain\) | – | – | – | -| Europe \(Stockholm\) | Enterprise, Standard, or Web SQL Server 2019 with CU8, CU17, CU18, CU20 | Enterprise, Standard, or Web SQL Server 2019 with CU17, CU18, CU20 | Enterprise or Standard SQL Server 2019 with CU17, CU18, CU20 | -| Europe \(Zurich\) | – | – | – | -| Middle East \(Bahrain\) | – | – | – | -| Middle East \(UAE\) | – | – | – | -| South America \(São Paulo\) | Enterprise, Standard, or Web SQL Server 2019 with CU8, CU17, CU18, CU20 | Enterprise, Standard, or Web SQL Server 2019 with CU17, CU18, CU20 | Enterprise or Standard SQL Server 2019 with CU17, CU18, CU20 | -| AWS GovCloud \(US\-East\) | – | – | – | -| AWS GovCloud \(US\-West\) | – | – | – | \ No newline at end of file diff --git a/doc_source/Concepts.RDS_Fea_Regions_DB-eng.Feature.RDSProxy.md b/doc_source/Concepts.RDS_Fea_Regions_DB-eng.Feature.RDSProxy.md deleted file mode 100644 index 55ca50b..0000000 --- a/doc_source/Concepts.RDS_Fea_Regions_DB-eng.Feature.RDSProxy.md +++ /dev/null @@ -1,167 +0,0 @@ -# Amazon RDS Proxy - -Amazon RDS Proxy is a fully managed, highly available database proxy that makes applications more scalable by pooling and sharing established database connections\. For more information, see [Using Amazon RDS Proxy](rds-proxy.md)\. - -RDS Proxy isn't available with RDS for Oracle\. - -**Topics** -+ [RDS Proxy with RDS for MariaDB](#Concepts.RDS_Fea_Regions_DB-eng.Feature.RDS_Proxy.mdb) -+ [RDS Proxy with RDS for MySQL](#Concepts.RDS_Fea_Regions_DB-eng.Feature.RDS_Proxy.my) -+ [RDS Proxy with RDS for PostgreSQL](#Concepts.RDS_Fea_Regions_DB-eng.Feature.RDS_Proxy.pg) -+ [RDS Proxy with RDS for SQL Server](#Concepts.RDS_Fea_Regions_DB-eng.Feature.RDS_Proxy.sq) - -## RDS Proxy with RDS for MariaDB - -The following Regions and engine versions are available for RDS Proxy with RDS for MariaDB\. - - -| Region | RDS for MariaDB 10\.6 | RDS for MariaDB 10\.5 | RDS for MariaDB 10\.4 | RDS for MariaDB 10\.3 | -| --- | --- | --- | --- | --- | -| US East \(Ohio\) | – | All available versions | All available versions | All available versions | -| US East \(N\. Virginia\) | – | All available versions | All available versions | All available versions | -| US West \(N\. California\) | – | All available versions | All available versions | All available versions | -| US West \(Oregon\) | – | All available versions | All available versions | All available versions | -| Africa \(Cape Town\) | – | All available versions | All available versions | All available versions | -| Asia Pacific \(Hong Kong\) | – | All available versions | All available versions | All available versions | -| Asia Pacific \(Hyderabad\) | – | – | – | – | -| Asia Pacific \(Jakarta\) | – | All available versions | All available versions | All available versions | -| Asia Pacific \(Melbourne\) | – | – | – | – | -| Asia Pacific \(Mumbai\) | – | All available versions | All available versions | All available versions | -| Asia Pacific \(Osaka\) | – | All available versions | All available versions | All available versions | -| Asia Pacific \(Seoul\) | – | All available versions | All available versions | All available versions | -| Asia Pacific \(Singapore\) | – | All available versions | All available versions | All available versions | -| Asia Pacific \(Sydney\) | – | All available versions | All available versions | All available versions | -| Asia Pacific \(Tokyo\) | – | All available versions | All available versions | All available versions | -| Canada \(Central\) | – | All available versions | All available versions | All available versions | -| China \(Beijing\) | – | All available versions | All available versions | All available versions | -| China \(Ningxia\) | – | All available versions | All available versions | All available versions | -| Europe \(Frankfurt\) | – | All available versions | All available versions | All available versions | -| Europe \(Ireland\) | – | All available versions | All available versions | All available versions | -| Europe \(London\) | – | All available versions | All available versions | All available versions | -| Europe \(Milan\) | – | All available versions | All available versions | All available versions | -| Europe \(Paris\) | – | All available versions | All available versions | All available versions | -| Europe \(Spain\) | – | – | – | – | -| Europe \(Stockholm\) | – | All available versions | All available versions | All available versions | -| Europe \(Zurich\) | – | – | – | – | -| Middle East \(Bahrain\) | – | All available versions | All available versions | All available versions | -| Middle East \(UAE\) | – | – | – | – | -| South America \(São Paulo\) | – | All available versions | All available versions | All available versions | -| AWS GovCloud \(US\-East\) | – | – | – | – | -| AWS GovCloud \(US\-West\) | – | – | – | – | - -## RDS Proxy with RDS for MySQL - -The following Regions and engine versions are available for RDS Proxy with RDS for MySQL\. - - -| Region | RDS for MySQL 8\.0 | RDS for MySQL 5\.7 | -| --- | --- | --- | -| US East \(Ohio\) | All available versions | All available versions | -| US East \(N\. Virginia\) | All available versions | All available versions | -| US West \(N\. California\) | All available versions | All available versions | -| US West \(Oregon\) | All available versions | All available versions | -| Africa \(Cape Town\) | All available versions | All available versions | -| Asia Pacific \(Hong Kong\) | All available versions | All available versions | -| Asia Pacific \(Hyderabad\) | – | – | -| Asia Pacific \(Jakarta\) | All available versions | All available versions | -| Asia Pacific \(Melbourne\) | – | – | -| Asia Pacific \(Mumbai\) | All available versions | All available versions | -| Asia Pacific \(Osaka\) | All available versions | All available versions | -| Asia Pacific \(Seoul\) | All available versions | All available versions | -| Asia Pacific \(Singapore\) | All available versions | All available versions | -| Asia Pacific \(Sydney\) | All available versions | All available versions | -| Asia Pacific \(Tokyo\) | All available versions | All available versions | -| Canada \(Central\) | All available versions | All available versions | -| China \(Beijing\) | All available versions | All available versions | -| China \(Ningxia\) | All available versions | All available versions | -| Europe \(Frankfurt\) | All available versions | All available versions | -| Europe \(Ireland\) | All available versions | All available versions | -| Europe \(London\) | All available versions | All available versions | -| Europe \(Milan\) | All available versions | All available versions | -| Europe \(Paris\) | All available versions | All available versions | -| Europe \(Spain\) | – | – | -| Europe \(Stockholm\) | All available versions | All available versions | -| Europe \(Zurich\) | – | – | -| Middle East \(Bahrain\) | All available versions | All available versions | -| Middle East \(UAE\) | – | – | -| South America \(São Paulo\) | All available versions | All available versions | -| AWS GovCloud \(US\-East\) | – | – | -| AWS GovCloud \(US\-West\) | – | – | - -## RDS Proxy with RDS for PostgreSQL - -The following Regions and engine versions are available for RDS Proxy with RDS for PostgreSQL\. - - -| Region | RDS for PostgreSQL 15 | RDS for PostgreSQL 14 | RDS for PostgreSQL 13 | RDS for PostgreSQL 12 | RDS for PostgreSQL 11 | RDS for PostgreSQL 10 | -| --- | --- | --- | --- | --- | --- | --- | -| US East \(Ohio\) | All available versions | All available versions | All available versions | All available versions | All available versions | All available versions | -| US East \(N\. Virginia\) | All available versions | All available versions | All available versions | All available versions | All available versions | All available versions | -| US West \(N\. California\) | All available versions | All available versions | All available versions | All available versions | All available versions | All available versions | -| US West \(Oregon\) | All available versions | All available versions | All available versions | All available versions | All available versions | All available versions | -| Africa \(Cape Town\) | All available versions | All available versions | All available versions | All available versions | All available versions | All available versions | -| Asia Pacific \(Hong Kong\) | All available versions | All available versions | All available versions | All available versions | All available versions | All available versions | -| Asia Pacific \(Hyderabad\) | – | – | – | – | – | – | -| Asia Pacific \(Jakarta\) | All available versions | All available versions | All available versions | All available versions | All available versions | All available versions | -| Asia Pacific \(Melbourne\) | – | – | – | – | – | – | -| Asia Pacific \(Mumbai\) | All available versions | All available versions | All available versions | All available versions | All available versions | All available versions | -| Asia Pacific \(Osaka\) | All available versions | All available versions | All available versions | All available versions | All available versions | All available versions | -| Asia Pacific \(Seoul\) | All available versions | All available versions | All available versions | All available versions | All available versions | All available versions | -| Asia Pacific \(Singapore\) | All available versions | All available versions | All available versions | All available versions | All available versions | All available versions | -| Asia Pacific \(Sydney\) | All available versions | All available versions | All available versions | All available versions | All available versions | All available versions | -| Asia Pacific \(Tokyo\) | All available versions | All available versions | All available versions | All available versions | All available versions | All available versions | -| Canada \(Central\) | All available versions | All available versions | All available versions | All available versions | All available versions | All available versions | -| China \(Beijing\) | All available versions | All available versions | All available versions | All available versions | All available versions | All available versions | -| China \(Ningxia\) | All available versions | All available versions | All available versions | All available versions | All available versions | All available versions | -| Europe \(Frankfurt\) | All available versions | All available versions | All available versions | All available versions | All available versions | All available versions | -| Europe \(Ireland\) | All available versions | All available versions | All available versions | All available versions | All available versions | All available versions | -| Europe \(London\) | All available versions | All available versions | All available versions | All available versions | All available versions | All available versions | -| Europe \(Milan\) | All available versions | All available versions | All available versions | All available versions | All available versions | All available versions | -| Europe \(Paris\) | All available versions | All available versions | All available versions | All available versions | All available versions | All available versions | -| Europe \(Spain\) | – | – | – | – | – | – | -| Europe \(Stockholm\) | All available versions | All available versions | All available versions | All available versions | All available versions | All available versions | -| Europe \(Zurich\) | – | – | – | – | – | – | -| Middle East \(Bahrain\) | All available versions | All available versions | All available versions | All available versions | All available versions | All available versions | -| Middle East \(UAE\) | – | – | – | – | – | – | -| South America \(São Paulo\) | All available versions | All available versions | All available versions | All available versions | All available versions | All available versions | -| AWS GovCloud \(US\-East\) | – | – | – | – | – | – | -| AWS GovCloud \(US\-West\) | – | – | – | – | – | – | - -## RDS Proxy with RDS for SQL Server - -The following Regions and engine versions are available for RDS Proxy with RDS for SQL Server\. - - -| Region | RDS for SQL Server 2019 | RDS for SQL Server 2017 | RDS for SQL Server 2016 | RDS for SQL Server 2014 | -| --- | --- | --- | --- | --- | -| US East \(Ohio\) | All available versions | All available versions | All available versions | All available versions | -| US East \(N\. Virginia\) | All available versions | All available versions | All available versions | All available versions | -| US West \(N\. California\) | All available versions | All available versions | All available versions | All available versions | -| US West \(Oregon\) | All available versions | All available versions | All available versions | All available versions | -| Africa \(Cape Town\) | All available versions | All available versions | All available versions | All available versions | -| Asia Pacific \(Hong Kong\) | All available versions | All available versions | All available versions | All available versions | -| Asia Pacific \(Hyderabad\) | – | – | – | – | -| Asia Pacific \(Jakarta\) | All available versions | All available versions | All available versions | All available versions | -| Asia Pacific \(Melbourne\) | – | – | – | – | -| Asia Pacific \(Mumbai\) | All available versions | All available versions | All available versions | All available versions | -| Asia Pacific \(Osaka\) | All available versions | All available versions | All available versions | All available versions | -| Asia Pacific \(Seoul\) | All available versions | All available versions | All available versions | All available versions | -| Asia Pacific \(Singapore\) | All available versions | All available versions | All available versions | All available versions | -| Asia Pacific \(Sydney\) | All available versions | All available versions | All available versions | All available versions | -| Asia Pacific \(Tokyo\) | All available versions | All available versions | All available versions | All available versions | -| Canada \(Central\) | All available versions | All available versions | All available versions | All available versions | -| China \(Beijing\) | All available versions | All available versions | All available versions | All available versions | -| China \(Ningxia\) | All available versions | All available versions | All available versions | All available versions | -| Europe \(Frankfurt\) | All available versions | All available versions | All available versions | All available versions | -| Europe \(Ireland\) | All available versions | All available versions | All available versions | All available versions | -| Europe \(London\) | All available versions | All available versions | All available versions | All available versions | -| Europe \(Milan\) | All available versions | All available versions | All available versions | All available versions | -| Europe \(Paris\) | All available versions | All available versions | All available versions | All available versions | -| Europe \(Spain\) | – | – | – | – | -| Europe \(Stockholm\) | All available versions | All available versions | All available versions | All available versions | -| Europe \(Zurich\) | – | – | – | – | -| Middle East \(Bahrain\) | All available versions | All available versions | All available versions | All available versions | -| Middle East \(UAE\) | – | – | – | – | -| South America \(São Paulo\) | All available versions | All available versions | All available versions | All available versions | -| AWS GovCloud \(US\-East\) | – | – | – | – | -| AWS GovCloud \(US\-West\) | – | – | – | – | \ No newline at end of file diff --git a/doc_source/Concepts.RDS_Fea_Regions_DB-eng.Feature.SecretsManager.md b/doc_source/Concepts.RDS_Fea_Regions_DB-eng.Feature.SecretsManager.md deleted file mode 100644 index 0b63468..0000000 --- a/doc_source/Concepts.RDS_Fea_Regions_DB-eng.Feature.SecretsManager.md +++ /dev/null @@ -1,11 +0,0 @@ -# Secrets Manager integration - -With AWS Secrets Manager, you can replace hard\-coded credentials in your code, including database passwords, with an API call to Secrets Manager to retrieve the secret programmatically\. For more information about Secrets Manager, see [AWS Secrets Manager User Guide](https://docs.aws.amazon.com/secretsmanager/latest/userguide/)\. - -You can specify that Amazon RDS manages the master user password in Secrets Manager for an Amazon RDS DB instance or Multi\-AZ DB cluster\. RDS generates the password, stores it in Secrets Manager, and rotates it regularly\. For more information, see [Password management with Amazon RDS and AWS Secrets Manager](rds-secrets-manager.md)\. - -Secrets Manager integration is supported for all RDS DB engines and all versions\. - -Secrets Manager integration is supported in all AWS Regions except the following: -+ AWS GovCloud \(US\-East\) -+ AWS GovCloud \(US\-West\) \ No newline at end of file diff --git a/doc_source/Concepts.RegionsAndAvailabilityZones.md b/doc_source/Concepts.RegionsAndAvailabilityZones.md deleted file mode 100644 index 4b24ca8..0000000 --- a/doc_source/Concepts.RegionsAndAvailabilityZones.md +++ /dev/null @@ -1,89 +0,0 @@ -# Regions, Availability Zones, and Local Zones - -Amazon cloud computing resources are hosted in multiple locations world\-wide\. These locations are composed of AWS Regions, Availability Zones, and Local Zones\. Each *AWS Region* is a separate geographic area\. Each AWS Region has multiple, isolated locations known as *Availability Zones*\. - -**Note** -For information about finding the Availability Zones for an AWS Region, see [Describe your Availability Zones](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/using-regions-availability-zones.html#availability-zones-describe) in the Amazon EC2 documentation\. - -By using Local Zones, you can place resources, such as compute and storage, in multiple locations closer to your users\. Amazon RDS enables you to place resources, such as DB instances, and data in multiple locations\. Resources aren't replicated across AWS Regions unless you do so specifically\. - -Amazon operates state\-of\-the\-art, highly\-available data centers\. Although rare, failures can occur that affect the availability of DB instances that are in the same location\. If you host all your DB instances in one location that is affected by such a failure, none of your DB instances will be available\. - -![\[AWS Region\]](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/images/Con-AZ-Local.png) - -It is important to remember that each AWS Region is completely independent\. Any Amazon RDS activity you initiate \(for example, creating database instances or listing available database instances\) runs only in your current default AWS Region\. The default AWS Region can be changed in the console, or by setting the [https://docs.aws.amazon.com/cli/latest/userguide/cli-configure-quickstart.html#cli-configure-quickstart-region](https://docs.aws.amazon.com/cli/latest/userguide/cli-configure-quickstart.html#cli-configure-quickstart-region) environment variable\. Or it can be overridden by using the `--region` parameter with the AWS Command Line Interface \(AWS CLI\)\. For more information, see [Configuring the AWS Command Line Interface](https://docs.aws.amazon.com/cli/latest/userguide/cli-chap-getting-started.html), specifically the sections about environment variables and command line options\. - -Amazon RDS supports special AWS Regions called AWS GovCloud \(US\)\. These are designed to allow US government agencies and customers to move more sensitive workloads into the cloud\. The AWS GovCloud \(US\) Regions address the US government's specific regulatory and compliance requirements\. For more information, see [What is AWS GovCloud \(US\)?](https://docs.aws.amazon.com/govcloud-us/latest/UserGuide/whatis.html) - -To create or work with an Amazon RDS DB instance in a specific AWS Region, use the corresponding regional service endpoint\. - -## AWS Regions - -Each AWS Region is designed to be isolated from the other AWS Regions\. This design achieves the greatest possible fault tolerance and stability\. - -When you view your resources, you see only the resources that are tied to the AWS Region that you specified\. This is because AWS Regions are isolated from each other, and we don't automatically replicate resources across AWS Regions\. - -### Region availability - -The following table shows the AWS Regions where Amazon RDS is currently available and the endpoint for each Region\. - -[\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Concepts.RegionsAndAvailabilityZones.html) - -If you do not explicitly specify an endpoint, the US West \(Oregon\) endpoint is the default\. - -When you work with a DB instance using the AWS CLI or API operations, make sure that you specify its regional endpoint\. - -## Availability Zones - -When you create a DB instance, you can choose an Availability Zone or have Amazon RDS choose one for you randomly\. An Availability Zone is represented by an AWS Region code followed by a letter identifier \(for example, `us-east-1a`\)\. - -Use the [describe\-availability\-zones](https://docs.aws.amazon.com/cli/latest/reference/ec2/describe-availability-zones.html) Amazon EC2 command as follows to describe the Availability Zones within the specified Region that are enabled for your account\. - -``` -aws ec2 describe-availability-zones --region region-name -``` - -For example, to describe the Availability Zones within the US East \(N\. Virginia\) Region \(us\-east\-1\) that are enabled for your account, run the following command: - -``` -aws ec2 describe-availability-zones --region us-east-1 -``` - -You can't choose the Availability Zones for the primary and secondary DB instances in a Multi\-AZ DB deployment\. Amazon RDS chooses them for you randomly\. For more information about Multi\-AZ deployments, see [Configuring and managing a Multi\-AZ deployment](Concepts.MultiAZ.md)\. - -**Note** -Random selection of Availability Zones by RDS doesn't guarantee an even distribution of DB instances among Availability Zones within a single account or DB subnet group\. You can request a specific AZ when you create or modify a Single\-AZ instance, and you can use more\-specific DB subnet groups for Multi\-AZ instances\. For more information, see [Creating an Amazon RDS DB instance](USER_CreateDBInstance.md) and [Modifying an Amazon RDS DB instance](Overview.DBInstance.Modifying.md)\. - -## Local Zones - -A *Local Zone* is an extension of an AWS Region that is geographically close to your users\. You can extend any VPC from the parent AWS Region into Local Zones\. To do so, create a new subnet and assign it to the AWS Local Zone\. When you create a subnet in a Local Zone, your VPC is extended to that Local Zone\. The subnet in the Local Zone operates the same as other subnets in your VPC\. - -When you create a DB instance, you can choose a subnet in a Local Zone\. Local Zones have their own connections to the internet and support AWS Direct Connect\. Thus, resources created in a Local Zone can serve local users with very low\-latency communications\. For more information, see [AWS Local Zones](http://aws.amazon.com/about-aws/global-infrastructure/localzones/)\. - -A Local Zone is represented by an AWS Region code followed by an identifier that indicates the location, for example `us-west-2-lax-1a`\. - -**Note** -A Local Zone can't be included in a Multi\-AZ deployment\. - -**To use a Local Zone** - -1. Enable the Local Zone in the Amazon EC2 console\. - - For more information, see [Enabling Local Zones](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/using-regions-availability-zones.html#enable-zone-group) in the *Amazon EC2 User Guide for Linux Instances\.* - -1. Create a subnet in the Local Zone\. - - For more information, see [Creating a subnet in your VPC](https://docs.aws.amazon.com/vpc/latest/userguide/working-with-vpcs.html#AddaSubnet) in the *Amazon VPC User Guide\.* - -1. Create a DB subnet group in the Local Zone\. - - When you create a DB subnet group, choose the Availability Zone group for the Local Zone\. - - For more information, see [Creating a DB instance in a VPC](USER_VPC.WorkingWithRDSInstanceinaVPC.md#USER_VPC.InstanceInVPC)\. - -1. Create a DB instance that uses the DB subnet group in the Local Zone\. - - For more information, see [Creating an Amazon RDS DB instance](USER_CreateDBInstance.md)\. - -**Important** -Currently, the only AWS Local Zone where Amazon RDS is available is Los Angeles in the US West \(Oregon\) Region\. \ No newline at end of file diff --git a/doc_source/DBActivityStreams.Disabling.md b/doc_source/DBActivityStreams.Disabling.md deleted file mode 100644 index 79bc50e..0000000 --- a/doc_source/DBActivityStreams.Disabling.md +++ /dev/null @@ -1,49 +0,0 @@ -# Stopping a database activity stream - -You can stop an activity stream using the console or AWS CLI\. - -If you delete your Amazon RDS database instance, the activity stream is stopped and the underlying Amazon Kinesis stream is deleted automatically\. - -## Console - -**To turn off an activity stream** - -1. Open the Amazon RDS console at [https://console\.aws\.amazon\.com/rds/](https://console.aws.amazon.com/rds/)\. - -1. In the navigation pane, choose **Databases**\. - -1. Choose a database that you want to stop the database activity stream for\. - -1. For **Actions**, choose **Stop activity stream**\. The **Database Activity Stream** window appears\. - - 1. Choose **Immediately**\. - - When you choose **Immediately**, the RDS instance restarts right away\. If you choose **During the next maintenance window**, the RDS instance doesn't restart right away\. In this case, the database activity stream doesn't stop until the next maintenance window\. - - 1. Choose **Continue**\. - -## AWS CLI - -To stop database activity streams for your database, configure the DB instance using the AWS CLI command [stop\-activity\-stream](https://docs.aws.amazon.com/cli/latest/reference/rds/stop-activity-stream.html)\. Identify the AWS Region for the DB instance using the `--region` parameter\. The `--apply-immediately` parameter is optional\. - -For Linux, macOS, or Unix: - -``` -aws rds --region MY_REGION \ - stop-activity-stream \ - --resource-arn MY_DB_ARN \ - --apply-immediately -``` - -For Windows: - -``` -aws rds --region MY_REGION ^ - stop-activity-stream ^ - --resource-arn MY_DB_ARN ^ - --apply-immediately -``` - -## RDS API - -To stop database activity streams for your database, configure the DB instance using the [StopActivityStream](https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_StopActivityStream.html) operation\. Identify the AWS Region for the DB instance using the `Region` parameter\. The `ApplyImmediately` parameter is optional\. \ No newline at end of file diff --git a/doc_source/DBActivityStreams.Enabling.md b/doc_source/DBActivityStreams.Enabling.md deleted file mode 100644 index 86fe91f..0000000 --- a/doc_source/DBActivityStreams.Enabling.md +++ /dev/null @@ -1,80 +0,0 @@ -# Starting a database activity stream - -When you start an activity stream for the DB instance, each database activity event that you configured in the audit policy generates an activity stream event\. SQL commands such as `CONNECT` and `SELECT` generate access events\. SQL commands such as `CREATE` and `INSERT` generate change events\. - -**Important** -Turning on an activity stream for an Oracle DB instance clears existing audit data\. It also revokes audit trail privileges\. When the stream is enabled, RDS for Oracle can no longer do the following: -Purge unified audit trail records\. -Add, delete, or modify the unified audit policy\. -Update the last archived time stamp\. - -## Console - -**To start a database activity stream** - -1. Open the Amazon RDS console at [https://console\.aws\.amazon\.com/rds/](https://console.aws.amazon.com/rds/)\. - -1. In the navigation pane, choose **Databases**\. - -1. Choose the Amazon RDS database instance on which you want to start an activity stream\. In a Multi\-AZ deployment, start the stream on only the primary instance\. The activity stream audits both the primary and the standby instances\. - -1. For **Actions**, choose **Start activity stream**\. - - The **Start database activity stream: ***name* window appears, where *name* is your RDS instance\. - -1. Enter the following settings: - + For **AWS KMS key**, choose a key from the list of AWS KMS keys\. - - Amazon RDS uses the KMS key to encrypt the key that in turn encrypts database activity\. Choose a KMS key other than the default key\. For more information about encryption keys and AWS KMS, see [What is AWS Key Management Service?](https://docs.aws.amazon.com/kms/latest/developerguide/overview.html) in the *AWS Key Management Service Developer Guide\.* - + For **Database activity events**, choose **Enable engine\-native audit fields** to include the engine specific audit fields\. - + Choose **Immediately**\. - - When you choose **Immediately**, the RDS instance restarts right away\. If you choose **During the next maintenance window**, the RDS instance doesn't restart right away\. In this case, the database activity stream doesn't start until the next maintenance window\. - -1. Choose **Start database activity stream**\. - - The status for the the database shows that the activity stream is starting\. -**Note** -If you get the error `You can't start a database activity stream in this configuration`, check [Supported DB instance classes for database activity streams](DBActivityStreams.Overview.md#DBActivityStreams.Overview.requirements.classes) to see whether your RDS instance is using a supported instance class\. - -## AWS CLI - -To start database activity streams for a DB instance, configure the database using the [start\-activity\-stream](https://docs.aws.amazon.com/cli/latest/reference/rds/start-activity-stream.html) AWS CLI command\. -+ `--resource-arn arn` – Specifies the Amazon Resource Name \(ARN\) of the DB instance\. -+ `--kms-key-id key` – Specifies the KMS key identifier for encrypting messages in the database activity stream\. The AWS KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the AWS KMS key\. -+ `--engine-native-audit-fields-included` – Includes engine\-specific auditing fields in the data stream\. To exclude these fields, specify `--no-engine-native-audit-fields-included` \(default\)\. - -The following example starts a database activity stream for a DB instance in asynchronous mode\. - -For Linux, macOS, or Unix: - -``` -aws rds start-activity-stream \ - --mode async \ - --kms-key-id my-kms-key-arn \ - --resource-arn my-instance-arn \ - --engine-native-audit-fields-included \ - --apply-immediately -``` - -For Windows: - -``` -aws rds start-activity-stream ^ - --mode async ^ - --kms-key-id my-kms-key-arn ^ - --resource-arn my-instance-arn ^ - --engine-native-audit-fields-included ^ - --apply-immediately -``` - -## RDS API - -To start database activity streams for a DB instance, configure the instance using the [StartActivityStream](https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_StartActivityStream.html) operation\. - -Call the action with the parameters below: -+ `Region` -+ `KmsKeyId` -+ `ResourceArn` -+ `Mode` -+ `EngineNativeAuditFieldsIncluded` \ No newline at end of file diff --git a/doc_source/DBActivityStreams.ManagingAccess.md b/doc_source/DBActivityStreams.ManagingAccess.md deleted file mode 100644 index 6fd026b..0000000 --- a/doc_source/DBActivityStreams.ManagingAccess.md +++ /dev/null @@ -1,93 +0,0 @@ -# Managing access to database activity streams - -Any user with appropriate AWS Identity and Access Management \(IAM\) role privileges for database activity streams can create, start, stop, and modify the activity stream settings for a DB instance\. These actions are included in the audit log of the stream\. For best compliance practices, we recommend that you don't provide these privileges to DBAs\. - -You set access to database activity streams using IAM policies\. For more information about Amazon RDS authentication, see [Identity and access management for Amazon RDS](UsingWithRDS.IAM.md)\. For more information about creating IAM policies, see [Creating and using an IAM policy for IAM database access](UsingWithRDS.IAMDBAuth.IAMPolicy.md)\. - -**Example Policy to allow configuring database activity streams** -To give users fine\-grained access to modify activity streams, use the service\-specific operation context keys `rds:StartActivityStream` and `rds:StopActivityStream` in an IAM policy\. The following IAM policy example allows a user or role to configure activity streams\. - -``` -{ - "Version":"2012-10-17", - "Statement":[ - { - "Sid":"ConfigureActivityStreams", - "Effect":"Allow", - "Action": [ - "rds:StartActivityStream", - "rds:StopActivityStream" - ], - "Resource":"*", - } - ] -} -``` - -**Example Policy to allow starting database activity streams** -The following IAM policy example allows a user or role to start activity streams\. - -``` -{ - "Version":"2012-10-17", - "Statement":[ - { - "Sid":"AllowStartActivityStreams", - "Effect":"Allow", - "Action":"rds:StartActivityStream", - "Resource":"*" - } - ] -} -``` - -**Example Policy to allow stopping database activity streams** -The following IAM policy example allows a user or role to stop activity streams\. - -``` -{ - "Version":"2012-10-17", - "Statement":[ - { - "Sid":"AllowStopActivityStreams", - "Effect":"Allow", - "Action":"rds:StopActivityStream", - "Resource":"*" - } - ] -} -``` - -**Example Policy to deny starting database activity streams** -The following IAM policy example prevents a user or role from starting activity streams\. - -``` -{ - "Version":"2012-10-17", - "Statement":[ - { - "Sid":"DenyStartActivityStreams", - "Effect":"Deny", - "Action":"rds:StartActivityStream", - "Resource":"*" - } - ] -} -``` - -**Example Policy to deny stopping database activity streams** -The following IAM policy example prevents a user or role from stopping activity streams\. - -``` -{ - "Version":"2012-10-17", - "Statement":[ - { - "Sid":"DenyStopActivityStreams", - "Effect":"Deny", - "Action":"rds:StopActivityStream", - "Resource":"*" - } - ] -} -``` \ No newline at end of file diff --git a/doc_source/DBActivityStreams.Modifying.md b/doc_source/DBActivityStreams.Modifying.md deleted file mode 100644 index 3420959..0000000 --- a/doc_source/DBActivityStreams.Modifying.md +++ /dev/null @@ -1,108 +0,0 @@ -# Modifying a database activity stream - -You might want to customize your Amazon RDS audit policy when your activity stream is started\. If you don't want to lose time and data by stopping your activity stream, you can change the *audit policy state* to either of the following settings: - -**Locked \(default\)** -The audit policies in your database are read\-only\. - -**Unlocked** -The audit policies in your database are read/write\. - -The basic steps are as follows: - -1. Modify the audit policy state to unlocked\. - -1. Customize your audit policy\. - -1. Modify the audit policy state to locked\. - -## Console - -**To modify the audit policy state of your activity stream** - -1. Open the Amazon RDS console at [https://console\.aws\.amazon\.com/rds/](https://console.aws.amazon.com/rds/)\. - -1. In the navigation pane, choose **Databases**\. - -1. For **Actions**, choose **Modify database activity stream**\. - - The **Modify database activity stream: *name*** window appears, where *name* is your RDS instance\. - -1. Choose either of the following options: -**Locked** -When you lock your audit policy, it becomes read\-only\. You can't edit your audit policy unless you unlock the policy or stop the activity stream\. -**Unlocked** -When you unlock your audit policy, it becomes read/write\. You can edit your audit policy while the activity stream is started\. - -1. Choose **Modify DB activity stream**\. - - The status for the Amazon RDS database shows **Configuring activity stream**\. - -1. \(Optional\) Choose the DB instance link\. Then choose the **Configuration** tab\. - - The **Audit policy status** field shows one of the following values: - + **Locked** - + **Unlocked** - + **Locking policy** - + **Unlocking policy** - -## AWS CLI - -To modify the activity stream state for the database instance, use the [modify\-activity\-stream](https://docs.aws.amazon.com/cli/latest/reference/rds/modify-activity-stream.html) AWS CLI command\. - - -**** - -| Option | Required? | Description | -| --- | --- | --- | -| `--resource-arn my-instance-ARN` | Yes | The Amazon Resource Name \(ARN\) of your RDS database instance\. | -| `--audit-policy-state` | No | The new state of the audit policy for the database activity stream on your instance: `locked` or `unlocked`\. | - -The following example unlocks the audit policy for the activity stream started on *my\-instance\-ARN*\. - -For Linux, macOS, or Unix: - -``` -aws rds modify-activity-stream \ - --resource-arn my-instance-ARN \ - --audit-policy-state unlocked -``` - -For Windows: - -``` -aws rds modify-activity-stream ^ - --resource-arn my-instance-ARN ^ - --audit-policy-state unlocked -``` - -The following example describes the instance *my\-instance*\. The partial sample output shows that the audit policy is unlocked\. - -``` -aws rds describe-db-instances --db-instance-identifier my-instance - -{ - "DBInstances": [ - { - ... - "Engine": "oracle-ee", - ... - "ActivityStreamStatus": "started", - "ActivityStreamKmsKeyId": "ab12345e-1111-2bc3-12a3-ab1cd12345e", - "ActivityStreamKinesisStreamName": "aws-rds-das-db-AB1CDEFG23GHIJK4LMNOPQRST", - "ActivityStreamMode": "async", - "ActivityStreamEngineNativeAuditFieldsIncluded": true, - "ActivityStreamPolicyStatus": "unlocked", - ... - } - ] -} -``` - -## RDS API - -To modify the policy state of your database activity stream, use the [ModifyActivityStream](https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_ModifyActivityStream.html) operation\. - -Call the action with the parameters below: -+ `AuditPolicyState` -+ `ResourceArn` \ No newline at end of file diff --git a/doc_source/DBActivityStreams.Monitoring.md b/doc_source/DBActivityStreams.Monitoring.md deleted file mode 100644 index 253a3c9..0000000 --- a/doc_source/DBActivityStreams.Monitoring.md +++ /dev/null @@ -1,799 +0,0 @@ -# Monitoring database activity streams - -Database activity streams monitor and report activities\. The stream of activity is collected and transmitted to Amazon Kinesis\. From Kinesis, you can monitor the activity stream, or other services and applications can consume the activity stream for further analysis\. You can find the underlying Kinesis stream name by using the AWS CLI command `describe-db-instances` or the RDS API `DescribeDBInstances` operation\. - -Amazon RDS manages the Kinesis stream for you as follows: -+ Amazon RDS creates the Kinesis stream automatically with a 24\-hour retention period\. -+ Amazon RDS scales the Kinesis stream if necessary\. -+ If you stop the database activity stream or delete the DB instance, Amazon RDS deletes the Kinesis stream\. - -The following categories of activity are monitored and put in the activity stream audit log: -+ **SQL commands** – All SQL commands are audited, and also prepared statements, built\-in functions, and functions in PL/SQL\. Calls to stored procedures are audited\. Any SQL statements issued inside stored procedures or functions are also audited\. -+ **Other database information** – Activity monitored includes the full SQL statement, the row count of affected rows from DML commands, accessed objects, and the unique database name\. Database activity streams also monitor the bind variables and stored procedure parameters\. -**Important** -The full SQL text of each statement is visible in the activity stream audit log, including any sensitive data\. However, database user passwords are redacted if Oracle can determine them from the context, such as in the following SQL statement\. - - ``` - ALTER ROLE role-name WITH password - ``` -+ **Connection information** – Activity monitored includes session and network information, the server process ID, and exit codes\. - -If an activity stream has a failure while monitoring your DB instance, you are notified through RDS events\. - -**Topics** -+ [Accessing an activity stream from Kinesis](#DBActivityStreams.KinesisAccess) -+ [Audit log contents and examples](#DBActivityStreams.AuditLog) -+ [databaseActivityEventList JSON array](#DBActivityStreams.AuditLog.databaseActivityEventList) -+ [Processing a database activity stream using the AWS SDK](#DBActivityStreams.CodeExample) - -## Accessing an activity stream from Kinesis - -When you enable an activity stream for a database, a Kinesis stream is created for you\. From Kinesis, you can monitor your database activity in real time\. To further analyze database activity, you can connect your Kinesis stream to consumer applications\. You can also connect the stream to compliance management applications such as IBM's Security Guardium or Imperva's SecureSphere Database Audit and Protection\. - -You can access your Kinesis stream either from the RDS console or the Kinesis console\. - -**To access an activity stream from Kinesis using the RDS console** - -1. Open the Amazon RDS console at [https://console\.aws\.amazon\.com/rds/](https://console.aws.amazon.com/rds/)\. - -1. In the navigation pane, choose **Databases**\. - -1. Choose the Amazon RDS database instance on which you started an activity stream\. - -1. Choose **Configuration**\. - -1. Under **Database activity stream**, choose the link under **Kinesis stream**\. - -1. In the Kinesis console, choose **Monitoring** to begin observing the database activity\. - -**To access an activity stream from Kinesis using the Kinesis console** - -1. Open the Kinesis console at [https://console\.aws\.amazon\.com/kinesis](https://console.aws.amazon.com/kinesis)\. - -1. Choose your activity stream from the list of Kinesis streams\. - - An activity stream's name includes the prefix `aws-rds-das-db-` followed by the resource ID of the database\. The following is an example\. - - ``` - aws-rds-das-db-NHVOV4PCLWHGF52NP - ``` - - To use the Amazon RDS console to find the resource ID for the database, choose your DB instance from the list of databases, and then choose the **Configuration** tab\. - - To use the AWS CLI to find the full Kinesis stream name for an activity stream, use a [describe\-db\-instances](https://docs.aws.amazon.com/cli/latest/reference/rds/describe-db-instances.html) CLI request and note the value of `ActivityStreamKinesisStreamName` in the response\. - -1. Choose **Monitoring** to begin observing the database activity\. - -For more information about using Amazon Kinesis, see [What Is Amazon Kinesis Data Streams?](https://docs.aws.amazon.com/streams/latest/dev/introduction.html)\. - -## Audit log contents and examples - -Monitored events are represented in the database activity stream as JSON strings\. The structure consists of a JSON object containing a `DatabaseActivityMonitoringRecord`, which in turn contains a `databaseActivityEventList` array of activity events\. - -**Topics** -+ [Examples of an audit log for an activity stream](#DBActivityStreams.AuditLog.Examples) -+ [DatabaseActivityMonitoringRecords JSON object](#DBActivityStreams.AuditLog.DatabaseActivityMonitoringRecords) -+ [databaseActivityEvents JSON Object](#DBActivityStreams.AuditLog.databaseActivityEvents) - -### Examples of an audit log for an activity stream - -Following are sample decrypted JSON audit logs of activity event records\. - -**Example Activity event record of a CONNECT SQL statement** -The following activity event record shows a login with the use of a `CONNECT` SQL statement \(`command`\) by a JDBC Thin Client \(`clientApplication`\) for your Oracle DB\. - -``` -{ - "class": "Standard", - "clientApplication": "JDBC Thin Client", - "command": "LOGON", - "commandText": null, - "dbid": "0123456789", - "databaseName": "ORCL", - "dbProtocol": "oracle", - "dbUserName": "TEST", - "endTime": null, - "errorMessage": null, - "exitCode": 0, - "logTime": "2021-01-15 00:15:36.233787", - "netProtocol": "tcp", - "objectName": null, - "objectType": null, - "paramList": [], - "pid": 17904, - "remoteHost": "123.456.789.012", - "remotePort": "25440", - "rowCount": null, - "serverHost": "987.654.321.098", - "serverType": "oracle", - "serverVersion": "19.0.0.0.ru-2020-01.rur-2020-01.r1.EE.3", - "serviceName": "oracle-ee", - "sessionId": 987654321, - "startTime": null, - "statementId": 1, - "substatementId": null, - "transactionId": "0000000000000000", - "engineNativeAuditFields": { - "UNIFIED_AUDIT_POLICIES": "TEST_POL_EVERYTHING", - "FGA_POLICY_NAME": null, - "DV_OBJECT_STATUS": null, - "SYSTEM_PRIVILEGE_USED": "CREATE SESSION", - "OLS_LABEL_COMPONENT_TYPE": null, - "XS_SESSIONID": null, - "ADDITIONAL_INFO": null, - "INSTANCE_ID": 1, - "DBID": 123456789 - "DV_COMMENT": null, - "RMAN_SESSION_STAMP": null, - "NEW_NAME": null, - "DV_ACTION_NAME": null, - "OLS_PROGRAM_UNIT_NAME": null, - "OLS_STRING_LABEL": null, - "RMAN_SESSION_RECID": null, - "OBJECT_PRIVILEGES": null, - "OLS_OLD_VALUE": null, - "XS_TARGET_PRINCIPAL_NAME": null, - "XS_NS_ATTRIBUTE": null, - "XS_NS_NAME": null, - "DBLINK_INFO": null, - "AUTHENTICATION_TYPE": "(TYPE\u003d(DATABASE));(CLIENT ADDRESS\u003d((ADDRESS\u003d(PROTOCOL\u003dtcp)(HOST\u003d205.251.233.183)(PORT\u003d25440))));", - "OBJECT_EDITION": null, - "OLS_PRIVILEGES_GRANTED": null, - "EXCLUDED_USER": null, - "DV_ACTION_OBJECT_NAME": null, - "OLS_LABEL_COMPONENT_NAME": null, - "EXCLUDED_SCHEMA": null, - "DP_TEXT_PARAMETERS1": null, - "XS_USER_NAME": null, - "XS_ENABLED_ROLE": null, - "XS_NS_ATTRIBUTE_NEW_VAL": null, - "DIRECT_PATH_NUM_COLUMNS_LOADED": null, - "AUDIT_OPTION": null, - "DV_EXTENDED_ACTION_CODE": null, - "XS_PACKAGE_NAME": null, - "OLS_NEW_VALUE": null, - "DV_RETURN_CODE": null, - "XS_CALLBACK_EVENT_TYPE": null, - "USERHOST": "a1b2c3d4e5f6.amazon.com", - "GLOBAL_USERID": null, - "CLIENT_IDENTIFIER": null, - "RMAN_OPERATION": null, - "TERMINAL": "unknown", - "OS_USERNAME": "sumepate", - "OLS_MAX_READ_LABEL": null, - "XS_PROXY_USER_NAME": null, - "XS_DATASEC_POLICY_NAME": null, - "DV_FACTOR_CONTEXT": null, - "OLS_MAX_WRITE_LABEL": null, - "OLS_PARENT_GROUP_NAME": null, - "EXCLUDED_OBJECT": null, - "DV_RULE_SET_NAME": null, - "EXTERNAL_USERID": null, - "EXECUTION_ID": null, - "ROLE": null, - "PROXY_SESSIONID": 0, - "DP_BOOLEAN_PARAMETERS1": null, - "OLS_POLICY_NAME": null, - "OLS_GRANTEE": null, - "OLS_MIN_WRITE_LABEL": null, - "APPLICATION_CONTEXTS": null, - "XS_SCHEMA_NAME": null, - "DV_GRANTEE": null, - "XS_COOKIE": null, - "DBPROXY_USERNAME": null, - "DV_ACTION_CODE": null, - "OLS_PRIVILEGES_USED": null, - "RMAN_DEVICE_TYPE": null, - "XS_NS_ATTRIBUTE_OLD_VAL": null, - "TARGET_USER": null, - "XS_ENTITY_TYPE": null, - "ENTRY_ID": 1, - "XS_PROCEDURE_NAME": null, - "XS_INACTIVITY_TIMEOUT": null, - "RMAN_OBJECT_TYPE": null, - "SYSTEM_PRIVILEGE": null, - "NEW_SCHEMA": null, - "SCN": 5124715 - } -} -``` -The following activity event record shows a login failure for your SQL Server DB\. - -``` -{ - "type": "DatabaseActivityMonitoringRecord", - "clusterId": "", - "instanceId": "db-4JCWQLUZVFYP7DIWP6JVQ77O3Q", - "databaseActivityEventList": [ - { - "class": "LOGIN", - "clientApplication": "Microsoft SQL Server Management Studio", - "command": "LOGIN FAILED", - "commandText": "Login failed for user 'test'. Reason: Password did not match that for the login provided. [CLIENT: local-machine]", - "databaseName": "", - "dbProtocol": "SQLSERVER", - "dbUserName": "test", - "endTime": null, - "errorMessage": null, - "exitCode": 0, - "logTime": "2022-10-06 21:34:42.7113072+00", - "netProtocol": null, - "objectName": "", - "objectType": "LOGIN", - "paramList": null, - "pid": null, - "remoteHost": "local machine", - "remotePort": null, - "rowCount": 0, - "serverHost": "172.31.30.159", - "serverType": "SQLSERVER", - "serverVersion": "15.00.4073.23.v1.R1", - "serviceName": "sqlserver-ee", - "sessionId": 0, - "startTime": null, - "statementId": "0x1eb0d1808d34a94b9d3dcf5432750f02", - "substatementId": 1, - "transactionId": "0", - "type": "record", - "engineNativeAuditFields": { - "target_database_principal_id": 0, - "target_server_principal_id": 0, - "target_database_principal_name": "", - "server_principal_id": 0, - "user_defined_information": "", - "response_rows": 0, - "database_principal_name": "", - "target_server_principal_name": "", - "schema_name": "", - "is_column_permission": false, - "object_id": 0, - "server_instance_name": "EC2AMAZ-NFUJJNO", - "target_server_principal_sid": null, - "additional_information": "00x000048188
local machine
B"-->, - "duration_milliseconds": 0, - "permission_bitmask": "0x00000000000000000000000000000000", - "data_sensitivity_information": "", - "session_server_principal_name": "", - "connection_id": "98B4F537-0F82-49E3-AB08-B9D33B5893EF", - "audit_schema_version": 1, - "database_principal_id": 0, - "server_principal_sid": null, - "user_defined_event_id": 0, - "host_name": "EC2AMAZ-NFUJJNO" - } - } - ] -} -``` -If a database activity stream isn't enabled, then the last field in the JSON document is `"engineNativeAuditFields": { }`\. - -**Example Activity event record of a CREATE TABLE statement** -The following example shows a `CREATE TABLE` event for your Oracle database\. - -``` -{ - "class": "Standard", - "clientApplication": "sqlplus@ip-12-34-5-678 (TNS V1-V3)", - "command": "CREATE TABLE", - "commandText": "CREATE TABLE persons(\n person_id NUMBER GENERATED BY DEFAULT AS IDENTITY,\n first_name VARCHAR2(50) NOT NULL,\n last_name VARCHAR2(50) NOT NULL,\n PRIMARY KEY(person_id)\n)", - "dbid": "0123456789", - "databaseName": "ORCL", - "dbProtocol": "oracle", - "dbUserName": "TEST", - "endTime": null, - "errorMessage": null, - "exitCode": 0, - "logTime": "2021-01-15 00:22:49.535239", - "netProtocol": "beq", - "objectName": "PERSONS", - "objectType": "TEST", - "paramList": [], - "pid": 17687, - "remoteHost": "123.456.789.0", - "remotePort": null, - "rowCount": null, - "serverHost": "987.654.321.01", - "serverType": "oracle", - "serverVersion": "19.0.0.0.ru-2020-01.rur-2020-01.r1.EE.3", - "serviceName": "oracle-ee", - "sessionId": 1234567890, - "startTime": null, - "statementId": 43, - "substatementId": null, - "transactionId": "090011007F0D0000", - "engineNativeAuditFields": { - "UNIFIED_AUDIT_POLICIES": "TEST_POL_EVERYTHING", - "FGA_POLICY_NAME": null, - "DV_OBJECT_STATUS": null, - "SYSTEM_PRIVILEGE_USED": "CREATE SEQUENCE, CREATE TABLE", - "OLS_LABEL_COMPONENT_TYPE": null, - "XS_SESSIONID": null, - "ADDITIONAL_INFO": null, - "INSTANCE_ID": 1, - "DV_COMMENT": null, - "RMAN_SESSION_STAMP": null, - "NEW_NAME": null, - "DV_ACTION_NAME": null, - "OLS_PROGRAM_UNIT_NAME": null, - "OLS_STRING_LABEL": null, - "RMAN_SESSION_RECID": null, - "OBJECT_PRIVILEGES": null, - "OLS_OLD_VALUE": null, - "XS_TARGET_PRINCIPAL_NAME": null, - "XS_NS_ATTRIBUTE": null, - "XS_NS_NAME": null, - "DBLINK_INFO": null, - "AUTHENTICATION_TYPE": "(TYPE\u003d(DATABASE));(CLIENT ADDRESS\u003d((PROTOCOL\u003dbeq)(HOST\u003d123.456.789.0)));", - "OBJECT_EDITION": null, - "OLS_PRIVILEGES_GRANTED": null, - "EXCLUDED_USER": null, - "DV_ACTION_OBJECT_NAME": null, - "OLS_LABEL_COMPONENT_NAME": null, - "EXCLUDED_SCHEMA": null, - "DP_TEXT_PARAMETERS1": null, - "XS_USER_NAME": null, - "XS_ENABLED_ROLE": null, - "XS_NS_ATTRIBUTE_NEW_VAL": null, - "DIRECT_PATH_NUM_COLUMNS_LOADED": null, - "AUDIT_OPTION": null, - "DV_EXTENDED_ACTION_CODE": null, - "XS_PACKAGE_NAME": null, - "OLS_NEW_VALUE": null, - "DV_RETURN_CODE": null, - "XS_CALLBACK_EVENT_TYPE": null, - "USERHOST": "ip-10-13-0-122", - "GLOBAL_USERID": null, - "CLIENT_IDENTIFIER": null, - "RMAN_OPERATION": null, - "TERMINAL": "pts/1", - "OS_USERNAME": "rdsdb", - "OLS_MAX_READ_LABEL": null, - "XS_PROXY_USER_NAME": null, - "XS_DATASEC_POLICY_NAME": null, - "DV_FACTOR_CONTEXT": null, - "OLS_MAX_WRITE_LABEL": null, - "OLS_PARENT_GROUP_NAME": null, - "EXCLUDED_OBJECT": null, - "DV_RULE_SET_NAME": null, - "EXTERNAL_USERID": null, - "EXECUTION_ID": null, - "ROLE": null, - "PROXY_SESSIONID": 0, - "DP_BOOLEAN_PARAMETERS1": null, - "OLS_POLICY_NAME": null, - "OLS_GRANTEE": null, - "OLS_MIN_WRITE_LABEL": null, - "APPLICATION_CONTEXTS": null, - "XS_SCHEMA_NAME": null, - "DV_GRANTEE": null, - "XS_COOKIE": null, - "DBPROXY_USERNAME": null, - "DV_ACTION_CODE": null, - "OLS_PRIVILEGES_USED": null, - "RMAN_DEVICE_TYPE": null, - "XS_NS_ATTRIBUTE_OLD_VAL": null, - "TARGET_USER": null, - "XS_ENTITY_TYPE": null, - "ENTRY_ID": 12, - "XS_PROCEDURE_NAME": null, - "XS_INACTIVITY_TIMEOUT": null, - "RMAN_OBJECT_TYPE": null, - "SYSTEM_PRIVILEGE": null, - "NEW_SCHEMA": null, - "SCN": 5133083 - } -} -``` -The following example shows a `CREATE TABLE` event for your SQL Server database\. - -``` -{ - "type": "DatabaseActivityMonitoringRecord", - "clusterId": "", - "instanceId": "db-4JCWQLUZVFYP7DIWP6JVQ77O3Q", - "databaseActivityEventList": [ - { - "class": "SCHEMA", - "clientApplication": "Microsoft SQL Server Management Studio - Query", - "command": "ALTER", - "commandText": "Create table [testDB].[dbo].[TestTable2](\r\ntextA varchar(6000),\r\n textB varchar(6000)\r\n)", - "databaseName": "testDB", - "dbProtocol": "SQLSERVER", - "dbUserName": "test", - "endTime": null, - "errorMessage": null, - "exitCode": 1, - "logTime": "2022-10-06 21:44:38.4120677+00", - "netProtocol": null, - "objectName": "dbo", - "objectType": "SCHEMA", - "paramList": null, - "pid": null, - "remoteHost": "local machine", - "remotePort": null, - "rowCount": 0, - "serverHost": "172.31.30.159", - "serverType": "SQLSERVER", - "serverVersion": "15.00.4073.23.v1.R1", - "serviceName": "sqlserver-ee", - "sessionId": 84, - "startTime": null, - "statementId": "0x5178d33d56e95e419558b9607158a5bd", - "substatementId": 1, - "transactionId": "4561864", - "type": "record", - "engineNativeAuditFields": { - "target_database_principal_id": 0, - "target_server_principal_id": 0, - "target_database_principal_name": "", - "server_principal_id": 2, - "user_defined_information": "", - "response_rows": 0, - "database_principal_name": "dbo", - "target_server_principal_name": "", - "schema_name": "", - "is_column_permission": false, - "object_id": 1, - "server_instance_name": "EC2AMAZ-NFUJJNO", - "target_server_principal_sid": null, - "additional_information": "", - "duration_milliseconds": 0, - "permission_bitmask": "0x00000000000000000000000000000000", - "data_sensitivity_information": "", - "session_server_principal_name": "test", - "connection_id": "EE1FE3FD-EF2C-41FD-AF45-9051E0CD983A", - "audit_schema_version": 1, - "database_principal_id": 1, - "server_principal_sid": "0x010500000000000515000000bdc2795e2d0717901ba6998cf4010000", - "user_defined_event_id": 0, - "host_name": "EC2AMAZ-NFUJJNO" - } - } - ] -} -``` - -**Example Activity event record of a SELECT statement** -The following example shows a `SELECT` event for your Oracle DB\. - -``` -{ - "class": "Standard", - "clientApplication": "sqlplus@ip-12-34-5-678 (TNS V1-V3)", - "command": "SELECT", - "commandText": "select count(*) from persons", - "databaseName": "1234567890", - "dbProtocol": "oracle", - "dbUserName": "TEST", - "endTime": null, - "errorMessage": null, - "exitCode": 0, - "logTime": "2021-01-15 00:25:18.850375", - "netProtocol": "beq", - "objectName": "PERSONS", - "objectType": "TEST", - "paramList": [], - "pid": 17687, - "remoteHost": "123.456.789.0", - "remotePort": null, - "rowCount": null, - "serverHost": "987.654.321.09", - "serverType": "oracle", - "serverVersion": "19.0.0.0.ru-2020-01.rur-2020-01.r1.EE.3", - "serviceName": "oracle-ee", - "sessionId": 1080639707, - "startTime": null, - "statementId": 44, - "substatementId": null, - "transactionId": null, - "engineNativeAuditFields": { - "UNIFIED_AUDIT_POLICIES": "TEST_POL_EVERYTHING", - "FGA_POLICY_NAME": null, - "DV_OBJECT_STATUS": null, - "SYSTEM_PRIVILEGE_USED": null, - "OLS_LABEL_COMPONENT_TYPE": null, - "XS_SESSIONID": null, - "ADDITIONAL_INFO": null, - "INSTANCE_ID": 1, - "DV_COMMENT": null, - "RMAN_SESSION_STAMP": null, - "NEW_NAME": null, - "DV_ACTION_NAME": null, - "OLS_PROGRAM_UNIT_NAME": null, - "OLS_STRING_LABEL": null, - "RMAN_SESSION_RECID": null, - "OBJECT_PRIVILEGES": null, - "OLS_OLD_VALUE": null, - "XS_TARGET_PRINCIPAL_NAME": null, - "XS_NS_ATTRIBUTE": null, - "XS_NS_NAME": null, - "DBLINK_INFO": null, - "AUTHENTICATION_TYPE": "(TYPE\u003d(DATABASE));(CLIENT ADDRESS\u003d((PROTOCOL\u003dbeq)(HOST\u003d123.456.789.0)));", - "OBJECT_EDITION": null, - "OLS_PRIVILEGES_GRANTED": null, - "EXCLUDED_USER": null, - "DV_ACTION_OBJECT_NAME": null, - "OLS_LABEL_COMPONENT_NAME": null, - "EXCLUDED_SCHEMA": null, - "DP_TEXT_PARAMETERS1": null, - "XS_USER_NAME": null, - "XS_ENABLED_ROLE": null, - "XS_NS_ATTRIBUTE_NEW_VAL": null, - "DIRECT_PATH_NUM_COLUMNS_LOADED": null, - "AUDIT_OPTION": null, - "DV_EXTENDED_ACTION_CODE": null, - "XS_PACKAGE_NAME": null, - "OLS_NEW_VALUE": null, - "DV_RETURN_CODE": null, - "XS_CALLBACK_EVENT_TYPE": null, - "USERHOST": "ip-12-34-5-678", - "GLOBAL_USERID": null, - "CLIENT_IDENTIFIER": null, - "RMAN_OPERATION": null, - "TERMINAL": "pts/1", - "OS_USERNAME": "rdsdb", - "OLS_MAX_READ_LABEL": null, - "XS_PROXY_USER_NAME": null, - "XS_DATASEC_POLICY_NAME": null, - "DV_FACTOR_CONTEXT": null, - "OLS_MAX_WRITE_LABEL": null, - "OLS_PARENT_GROUP_NAME": null, - "EXCLUDED_OBJECT": null, - "DV_RULE_SET_NAME": null, - "EXTERNAL_USERID": null, - "EXECUTION_ID": null, - "ROLE": null, - "PROXY_SESSIONID": 0, - "DP_BOOLEAN_PARAMETERS1": null, - "OLS_POLICY_NAME": null, - "OLS_GRANTEE": null, - "OLS_MIN_WRITE_LABEL": null, - "APPLICATION_CONTEXTS": null, - "XS_SCHEMA_NAME": null, - "DV_GRANTEE": null, - "XS_COOKIE": null, - "DBPROXY_USERNAME": null, - "DV_ACTION_CODE": null, - "OLS_PRIVILEGES_USED": null, - "RMAN_DEVICE_TYPE": null, - "XS_NS_ATTRIBUTE_OLD_VAL": null, - "TARGET_USER": null, - "XS_ENTITY_TYPE": null, - "ENTRY_ID": 13, - "XS_PROCEDURE_NAME": null, - "XS_INACTIVITY_TIMEOUT": null, - "RMAN_OBJECT_TYPE": null, - "SYSTEM_PRIVILEGE": null, - "NEW_SCHEMA": null, - "SCN": 5136972 - } -} -``` -The following example shows a `SELECT` event for your SQL Server DB\. - -``` -{ - "type": "DatabaseActivityMonitoringRecord", - "clusterId": "", - "instanceId": "db-4JCWQLUZVFYP7DIWP6JVQ77O3Q", - "databaseActivityEventList": [ - { - "class": "TABLE", - "clientApplication": "Microsoft SQL Server Management Studio - Query", - "command": "SELECT", - "commandText": "select * from [testDB].[dbo].[TestTable]", - "databaseName": "testDB", - "dbProtocol": "SQLSERVER", - "dbUserName": "test", - "endTime": null, - "errorMessage": null, - "exitCode": 1, - "logTime": "2022-10-06 21:24:59.9422268+00", - "netProtocol": null, - "objectName": "TestTable", - "objectType": "TABLE", - "paramList": null, - "pid": null, - "remoteHost": "local machine", - "remotePort": null, - "rowCount": 0, - "serverHost": "172.31.30.159", - "serverType": "SQLSERVER", - "serverVersion": "15.00.4073.23.v1.R1", - "serviceName": "sqlserver-ee", - "sessionId": 62, - "startTime": null, - "statementId": "0x03baed90412f564fad640ebe51f89b99", - "substatementId": 1, - "transactionId": "4532935", - "type": "record", - "engineNativeAuditFields": { - "target_database_principal_id": 0, - "target_server_principal_id": 0, - "target_database_principal_name": "", - "server_principal_id": 2, - "user_defined_information": "", - "response_rows": 0, - "database_principal_name": "dbo", - "target_server_principal_name": "", - "schema_name": "dbo", - "is_column_permission": true, - "object_id": 581577110, - "server_instance_name": "EC2AMAZ-NFUJJNO", - "target_server_principal_sid": null, - "additional_information": "", - "duration_milliseconds": 0, - "permission_bitmask": "0x00000000000000000000000000000001", - "data_sensitivity_information": "", - "session_server_principal_name": "test", - "connection_id": "AD3A5084-FB83-45C1-8334-E923459A8109", - "audit_schema_version": 1, - "database_principal_id": 1, - "server_principal_sid": "0x010500000000000515000000bdc2795e2d0717901ba6998cf4010000", - "user_defined_event_id": 0, - "host_name": "EC2AMAZ-NFUJJNO" - } - } - ] -} -``` - -### DatabaseActivityMonitoringRecords JSON object - -The database activity event records are in a JSON object that contains the following information\. - - -**** - -| JSON Field | Data Type | Description | -| --- | --- | --- | -| `type` | string | The type of JSON record\. The value is `DatabaseActivityMonitoringRecords`\. | -| version | string | The version of the database activity monitoring records\. Oracle DB uses version 1\.3 and SQL Server uses version 1\.4\. These engine versions introduce the engineNativeAuditFields JSON object\. | -| [databaseActivityEvents](#DBActivityStreams.AuditLog.databaseActivityEvents) | string | A JSON object that contains the activity events\. | -| key | string | An encryption key that you use to decrypt the [databaseActivityEventList](#DBActivityStreams.AuditLog.databaseActivityEventList) | - -### databaseActivityEvents JSON Object - -The `databaseActivityEvents` JSON object contains the following information\. - -#### Top\-level fields in JSON record - - Each event in the audit log is wrapped inside a record in JSON format\. This record contains the following fields\. - -**type** - This field always has the value `DatabaseActivityMonitoringRecords`\. - -**version** - This field represents the version of the database activity stream data protocol or contract\. It defines which fields are available\. - -**databaseActivityEvents** - An encrypted string representing one or more activity events\. It's represented as a base64 byte array\. When you decrypt the string, the result is a record in JSON format with fields as shown in the examples in this section\. - -**key** - The encrypted data key used to encrypt the `databaseActivityEvents` string\. This is the same AWS KMS key that you provided when you started the database activity stream\. - - The following example shows the format of this record\. - -``` -{ - "type":"DatabaseActivityMonitoringRecords", - "version":"1.3", - "databaseActivityEvents":"encrypted audit records", - "key":"encrypted key" -} -``` - -``` - "type":"DatabaseActivityMonitoringRecords", - "version":"1.4", - "databaseActivityEvents":"encrypted audit records", - "key":"encrypted key" -``` - -Take the following steps to decrypt the contents of the `databaseActivityEvents` field: - -1. Decrypt the value in the `key` JSON field using the KMS key you provided when starting database activity stream\. Doing so returns the data encryption key in clear text\. - -1. Base64\-decode the value in the `databaseActivityEvents` JSON field to obtain the ciphertext, in binary format, of the audit payload\. - -1. Decrypt the binary ciphertext with the data encryption key that you decoded in the first step\. - -1. Decompress the decrypted payload\. - + The encrypted payload is in the `databaseActivityEvents` field\. - + The `databaseActivityEventList` field contains an array of audit records\. The `type` fields in the array can be `record` or `heartbeat`\. - -The audit log activity event record is a JSON object that contains the following information\. - - -**** - -| JSON Field | Data Type | Description | -| --- | --- | --- | -| `type` | string | The type of JSON record\. The value is `DatabaseActivityMonitoringRecord`\. | -| instanceId | string | The DB instance resource identifier\. It corresponds to the DB instance attribute DbiResourceId\. | -| [databaseActivityEventList](#DBActivityStreams.AuditLog.databaseActivityEventList) | string | An array of activity audit records or heartbeat messages\. | - -## databaseActivityEventList JSON array - -The audit log payload is an encrypted `databaseActivityEventList` JSON array\. The following table lists alphabetically the fields for each activity event in the decrypted `DatabaseActivityEventList` array of an audit log\. - -When unified auditing is enabled in Oracle Database, the audit records are populated in this new audit trail\. The `UNIFIED_AUDIT_TRAIL` view displays audit records in tabular form by retrieving the audit records from the audit trail\. When you start a database activity stream, a column in `UNIFIED_AUDIT_TRAIL` maps to a field in the `databaseActivityEventList` array\. - -**Important** -The event structure is subject to change\. Amazon RDS might add new fields to activity events in the future\. In applications that parse the JSON data, make sure that your code can ignore or take appropriate actions for unknown field names\. - - -**databaseActivityEventList fields for Amazon RDS for Oracle** - -| Field | Data Type | Source | Description | -| --- | --- | --- | --- | -| `class` | string | `AUDIT_TYPE` column in `UNIFIED_AUDIT_TRAIL` | The class of activity event\. This corresponds to the `AUDIT_TYPE` column in the `UNIFIED_AUDIT_TRAIL` view\. Valid values for Amazon RDS for Oracle are the following: [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/DBActivityStreams.Monitoring.html) For more information, see [UNIFIED\_AUDIT\_TRAIL](https://docs.oracle.com/en/database/oracle/oracle-database/19/refrn/UNIFIED_AUDIT_TRAIL.html#GUID-B7CE1C02-2FD4-47D6-80AA-CF74A60CDD1D) in the Oracle documentation\. | -| `clientApplication` | string | `CLIENT_PROGRAM_NAME` in `UNIFIED_AUDIT_TRAIL` | The application the client used to connect as reported by the client\. The client doesn't have to provide this information, so the value can be null\. A sample value is `JDBC Thin Client`\. | -| `command` | string | `ACTION_NAME` column in `UNIFIED_AUDIT_TRAIL` | Name of the action executed by the user\. To understand the complete action, read both the command name and the `AUDIT_TYPE` value\. A sample value is `ALTER DATABASE`\. | -| `commandText` | string | `SQL_TEXT` column in `UNIFIED_AUDIT_TRAIL` | The SQL statement associated with the event\. A sample value is `ALTER DATABASE BEGIN BACKUP`\. | -| `databaseName` | string | `NAME` column in `V$DATABASE` | The name of the database\. | -| `dbid` | number | `DBID` column in `UNIFIED_AUDIT_TRAIL` | Numerical identifier for the database\. A sample value is `1559204751`\. | -| `dbProtocol` | string | N/A | The database protocol\. In this beta, the value is `oracle`\. | -| `dbUserName` | string | `DBUSERNAME` column in `UNIFIED_AUDIT_TRAIL` | Name of the database user whose actions were audited\. A sample value is `RDSADMIN`\. | -| `endTime` | string | N/A | This field isn't used for RDS for Oracle and is always null\. | -| `engineNativeAuditFields` | object | `UNIFIED_AUDIT_TRAIL` | By default, this object is empty\. When you start the activity stream with the `--engine-native-audit-fields-included` option, this object includes the following columns and their values: 
ADDITIONAL_INFO
APPLICATION_CONTEXTS
AUDIT_OPTION
AUTHENTICATION_TYPE
CLIENT_IDENTIFIER
CURRENT_USER
DBLINK_INFO
DBPROXY_USERNAME
DIRECT_PATH_NUM_COLUMNS_LOADED
DP_BOOLEAN_PARAMETERS1
DP_TEXT_PARAMETERS1
DV_ACTION_CODE
DV_ACTION_NAME
DV_ACTION_OBJECT_NAME
DV_COMMENT
DV_EXTENDED_ACTION_CODE
DV_FACTOR_CONTEXT
DV_GRANTEE
DV_OBJECT_STATUS
DV_RETURN_CODE
DV_RULE_SET_NAME
ENTRY_ID
EXCLUDED_OBJECT
EXCLUDED_SCHEMA
EXCLUDED_USER
EXECUTION_ID
EXTERNAL_USERID
FGA_POLICY_NAME
GLOBAL_USERID
INSTANCE_ID
KSACL_SERVICE_NAME
KSACL_SOURCE_LOCATION
KSACL_USER_NAME
NEW_NAME
NEW_SCHEMA
OBJECT_EDITION
OBJECT_PRIVILEGES
OLS_GRANTEE
OLS_LABEL_COMPONENT_NAME
OLS_LABEL_COMPONENT_TYPE
OLS_MAX_READ_LABEL
OLS_MAX_WRITE_LABEL
OLS_MIN_WRITE_LABEL
OLS_NEW_VALUE
OLS_OLD_VALUE
OLS_PARENT_GROUP_NAME
OLS_POLICY_NAME
OLS_PRIVILEGES_GRANTED
OLS_PRIVILEGES_USED
OLS_PROGRAM_UNIT_NAME
OLS_STRING_LABEL
OS_USERNAME
PROTOCOL_ACTION_NAME
PROTOCOL_MESSAGE
PROTOCOL_RETURN_CODE
PROTOCOL_SESSION_ID
PROTOCOL_USERHOST
PROXY_SESSIONID
RLS_INFO
RMAN_DEVICE_TYPE
RMAN_OBJECT_TYPE
RMAN_OPERATION
RMAN_SESSION_RECID
RMAN_SESSION_STAMP
ROLE
SCN
SYSTEM_PRIVILEGE
SYSTEM_PRIVILEGE_USED
TARGET_USER
TERMINAL
UNIFIED_AUDIT_POLICIES
USERHOST
XS_CALLBACK_EVENT_TYPE
XS_COOKIE
XS_DATASEC_POLICY_NAME
XS_ENABLED_ROLE
XS_ENTITY_TYPE
XS_INACTIVITY_TIMEOUT
XS_NS_ATTRIBUTE
XS_NS_ATTRIBUTE_NEW_VAL
XS_NS_ATTRIBUTE_OLD_VAL
XS_NS_NAME
XS_PACKAGE_NAME
XS_PROCEDURE_NAME
XS_PROXY_USER_NAME
XS_SCHEMA_NAME
XS_SESSIONID
XS_TARGET_PRINCIPAL_NAME
XS_USER_NAME
For more information, see [UNIFIED\_AUDIT\_TRAIL](https://docs.oracle.com/database/121/REFRN/GUID-B7CE1C02-2FD4-47D6-80AA-CF74A60CDD1D.htm#REFRN29162) in the Oracle Database documentation\. | -| `errorMessage` | string | N/A | This field isn't used for RDS for Oracle and is always null\. | -| `exitCode` | number | `RETURN_CODE` column in `UNIFIED_AUDIT_TRAIL` | Oracle Database error code generated by the action\. If the action succeeded, the value is `0`\. | -| `logTime` | string | `EVENT_TIMESTAMP_UTC` column in `UNIFIED_AUDIT_TRAIL` | Timestamp of the creation of the audit trail entry\. A sample value is `2020-11-27 06:56:14.981404`\. | -| `netProtocol` | string | `AUTHENTICATION_TYPE` column in `UNIFIED_AUDIT_TRAIL` | The network communication protocol\. A sample value is `TCP`\. | -| `objectName` | string | `OBJECT_NAME` column in `UNIFIED_AUDIT_TRAIL` | The name of the object affected by the action\. A sample value is `employees`\. | -| `objectType` | string | `OBJECT_SCHEMA` column in `UNIFIED_AUDIT_TRAIL` | The schema name of object affected by the action\. A sample value is `hr`\. | -| `paramList` | list | `SQL_BINDS` column in `UNIFIED_AUDIT_TRAIL` | The list of bind variables, if any, associated with `SQL_TEXT`\. A sample value is `parameter_1,parameter_2`\. | -| `pid` | number | `OS_PROCESS` column in `UNIFIED_AUDIT_TRAIL` | Operating system process identifier of the Oracle database process\. A sample value is `22396`\. | -| `remoteHost` | string | `AUTHENTICATION_TYPE` column in `UNIFIED_AUDIT_TRAIL` | Either the client IP address or name of the host from which the session was spawned\. A sample value is `123.456.789.123`\. | -| `remotePort` | string | `AUTHENTICATION_TYPE` column in `UNIFIED_AUDIT_TRAIL` | The client port number\. A typical value in Oracle Database environments is `1521`\. | -| `rowCount` | number | N/A | This field isn't used for RDS for Oracle and is always null\. | -| `serverHost` | string | Database host | The IP address of the database server host\. A sample value is `123.456.789.123`\. | -| `serverType` | string | N/A | The database server type\. The value is always `ORACLE`\. | -| `serverVersion` | string | Database host | The Amazon RDS for Oracle version, Release Update \(RU\), and Release Update Revision \(RUR\)\. A sample value is `19.0.0.0.ru-2020-01.rur-2020-01.r1.EE.3`\. | -| `serviceName` | string | Database host | The name of the service\. A sample value is `oracle-ee`\. | -| `sessionId` | number | `SESSIONID` column in `UNIFIED_AUDIT_TRAIL` | The session identifier of the audit\. An example is `1894327130`\. | -| `startTime` | string | N/A | This field isn't used for RDS for Oracle and is always null\. | -| `statementId` | number | `STATEMENT_ID` column in `UNIFIED_AUDIT_TRAIL` | Numeric ID for each statement run\. A statement can cause many actions\. A sample value is `142197`\. | -| `substatementId` | N/A | N/A | This field isn't used for RDS for Oracle and is always null\. | -| `transactionId` | string | `TRANSACTION_ID` column in `UNIFIED_AUDIT_TRAIL` | The identifier of the transaction in which the object is modified\. A sample value is `02000800D5030000`\. | - - -**databaseActivityEventList fields for Amazon RDS for SQL Server** - -| Field | Data Type | Source | Description | -| --- | --- | --- | --- | -| `class` | string | ` sys.fn_get_audit_file.class_type` mapped to `sys.dm_audit_class_type_map.class_type_desc` | The class of activity event\. For more information, see [SQL Server Audit \(Database Engine\)](https://learn.microsoft.com/en-us/sql/relational-databases/security/auditing/sql-server-audit-database-engine?view=sql-server-ver16) in the Microsoft documentation\. | -| `clientApplication` | string | `sys.fn_get_audit_file.application_name` | The application that the client connects as reported by the client \(SQL Server version 14 and higher\)\. This field is null in SQL Server version 13\. | -| `command` | string | `sys.fn_get_audit_file.action_id` mapped to `sys.dm_audit_actions.name` | The general category of the SQL statement\. The value for this field depends on the value of the class\. | -| `commandText` | string | `sys.fn_get_audit_file.statement` | This field indicates the SQL statement\. | -| `databaseName` | string | `sys.fn_get_audit_file.database_name` | Name of the database\. | -| `dbProtocol` | string | N/A | The database protocol\. This value is `SQLSERVER`\. | -| `dbUserName` | string | `sys.fn_get_audit_file.server_principal_name` | The database user for the client authentication\. | -| `endTime` | string | N/A | This field isn't used by Amazon RDS for SQL Server and the value is null\. | -| `engineNativeAuditFields` | object | Each field in `sys.fn_get_audit_file` that is not listed in this column\. | By default, this object is empty\. When you start the activity stream with the `--engine-native-audit-fields-included` option, this object includes other native engine audit fields, which are not returned by this JSON map\. | -| `errorMessage` | string | N/A | This field isn't used by Amazon RDS for SQL Server and the value is null\. | -| `exitCode` | integer | `sys.fn_get_audit_file.succeeded` | Indicates whether the action that started the event succeeded\. This field can't be null\. For all the events except login events, this field reports whether the permission check succeeded or failed, but not whether the operation succeeded or failed\. Values include: [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/DBActivityStreams.Monitoring.html) | -| `logTime` | string | `sys.fn_get_audit_file.event_time` | The event timestamp that is recorded by the SQL Server\. | -| `netProtocol` | string | N/A | This field isn't used by Amazon RDS for SQL Server and the value is null\. | -| `objectName` | string | `sys.fn_get_audit_file.object_name` | The name of the database object if the SQL statement is operating on an object\. | -| `objectType` | string | `sys.fn_get_audit_file.class_type` mapped to `sys.dm_audit_class_type_map.class_type_desc` | The database object type if the SQL statement is operating on an object type\. | -| `paramList` | string | N/A | This field isn't used by Amazon RDS for SQL Server and the value is null\. | -| `pid` | integer | N/A | This field isn't used by Amazon RDS for SQL Server and the value is null\. | -| `remoteHost` | string | `sys.fn_get_audit_file.client_ip` | The IP address or hostname of the client that issued the SQL statement \(SQL Server version 14 and higher\)\. This field is null in SQL Server version 13\. | -| `remotePort` | integer | N/A | This field isn't used by Amazon RDS for SQL Server and the value is null\. | -| `rowCount` | integer | `sys.fn_get_audit_file.affected_rows` | The number of table rows affected by the SQL statement \(SQL Server version 14 and higher\)\. This field is in SQL Server version 13\. | -| `serverHost` | string | Database Host | The IP address of the host database server\. | -| `serverType` | string | N/A | The database server type\. The value is `SQLSERVER`\. | -| `serverVersion` | string | Database Host | The database server version, for example, 15\.00\.4073\.23\.v1\.R1 for SQL Server 2017\. | -| `serviceName` | string | Database Host | The name of the service\. An example value is `sqlserver-ee`\. | -| `sessionId` | integer | `sys.fn_get_audit_file.session_id` | Unique identifier of the session\. | -| `startTime` | string | N/A | This field isn't used by Amazon RDS for SQL Server and the value is null\. | -| `statementId` | string | `sys.fn_get_audit_file.sequence_group_id` | A unique identifier for the client's SQL statement\. The identifier is different for each event that is generated\. A sample value is `0x38eaf4156267184094bb82071aaab644`\. | -| `substatementId` | integer | `sys.fn_get_audit_file.sequence_number` | An identifier to determine the sequence number for a statement\. This identifier helps when large records are split into multiple records\. | -| `transactionId` | integer | `sys.fn_get_audit_file.transaction_id` | An identifier of a transaction\. If there aren't any active transactions, the value is zero\. | -| `type` | string | Database activity stream generated | The type of event\. The values are `record` or `heartbeat`\. | - -## Processing a database activity stream using the AWS SDK - -You can programmatically process an activity stream by using the AWS SDK\. \ No newline at end of file diff --git a/doc_source/DBActivityStreams.Overview.md b/doc_source/DBActivityStreams.Overview.md deleted file mode 100644 index 57e0f51..0000000 --- a/doc_source/DBActivityStreams.Overview.md +++ /dev/null @@ -1,166 +0,0 @@ -# Overview of Database Activity Streams - -As an Amazon RDS database administrator, you need to safeguard your database and meet compliance and regulatory requirements\. One strategy is to integrate database activity streams with your monitoring tools\. In this way, you monitor and set alarms for auditing activity in your database\. - -Security threats are both external and internal\. To protect against internal threats, you can control administrator access to data streams by configuring the Database Activity Streams feature\. Amazon RDS DBAs don't have access to the collection, transmission, storage, and processing of the streams\. - -**Topics** -+ [How database activity streams work](#DBActivityStreams.Overview.how-they-work) -+ [Auditing in Oracle Database and Microsoft SQL Server Database](#DBActivityStreams.Overview.auditing) -+ [Asynchronous mode for database activity streams](#DBActivityStreams.Overview.sync-mode) -+ [Requirements and limitations for database activity streams](#DBActivityStreams.Overview.requirements) -+ [Region and version availability](#DBActivityStreams.RegionVersionAvailability) -+ [Supported DB instance classes for database activity streams](#DBActivityStreams.Overview.requirements.classes) - -## How database activity streams work - -Amazon RDS pushes activities to an Amazon Kinesis data stream in near real time\. The Kinesis stream is created automatically\. From Kinesis, you can configure AWS services such as Amazon Kinesis Data Firehose and AWS Lambda to consume the stream and store the data\. - -**Important** -Use of the database activity streams feature in Amazon RDS is free, but Amazon Kinesis charges for a data stream\. For more information, see [Amazon Kinesis Data Streams pricing](https://aws.amazon.com/kinesis/data-streams/pricing/)\. - -You can configure applications for compliance management to consume database activity streams\. These applications can use the stream to generate alerts and audit activity on your database\. - - - -Amazon RDS supports database activity streams in Multi\-AZ deployments\. In this case, database activity streams audit both the primary and standby instances\. - -## Auditing in Oracle Database and Microsoft SQL Server Database - -Auditing is the monitoring and recording of configured database actions\. Amazon RDS doesn't capture database activity by default\. You create and manage audit policies in your database yourself\. - -**Topics** -+ [Unified auditing in Oracle Database](#DBActivityStreams.Overview.unified-auditing) -+ [Auditing in Microsoft SQL Server](#DBActivityStreams.Overview.SQLServer-auditing) -+ [Non\-native audit fields for Oracle Database and SQL Server](#DBActivityStreams.Overview.unified-auditing.non-native) -+ [DB parameter group override](#DBActivityStreams.Overview.unified-auditing.parameter-group) - -### Unified auditing in Oracle Database - -In an Oracle database, a *unified audit policy* is a named group of audit settings that you can use to audit an aspect of user behavior\. A policy can be as simple as auditing the activities of a single user\. You can also create complex audit policies that use conditions\. - -An Oracle database writes audit records, including `SYS` audit records, to the *unified audit trail*\. For example, if an error occurs during an `INSERT` statement, standard auditing indicates the error number and the SQL that was run\. The audit trail resides in a read\-only table in the `AUDSYS` schema\. To access these records, query the `UNIFIED_AUDIT_TRAIL` data dictionary view\. - -Typically, you configure database activity streams as follows: - -1. Create an Oracle Database audit policy by using the `CREATE AUDIT POLICY` command\. - - The Oracle Database generates audit records\. - -1. Activate the audit policy by using the `AUDIT POLICY` command\. - -1. Configure database activity streams\. - - Only activities that match the Oracle Database audit policies are captured and sent to the Amazon Kinesis data stream\. When database activity streams are enabled, an Oracle database administrator can't alter the audit policy or remove audit logs\. - -To learn more about unified audit policies, see [About Auditing Activities with Unified Audit Policies and AUDIT](https://docs.oracle.com/en/database/oracle/oracle-database/19/dbseg/configuring-audit-policies.html#GUID-2435D929-10AD-43C7-8A6C-5133170074D0) in the *Oracle Database Security Guide*\. - -### Auditing in Microsoft SQL Server - -Database Activity Stream uses SQLAudit feature to audit the SQL Server database\. - -RDS for SQL Server instance contains the following: -+ Server audit – The SQL server audit collects a single instance of server or database\-level actions, and a group of actions to monitor\. The server\-level audits `RDS_DAS_AUDIT` and `RDS_DAS_AUDIT_CHANGES` are managed by RDS\. -+ Server audit specification – The server audit specification records the server\-level events\. You can modify the `RDS_DAS_SERVER_AUDIT_SPEC` specification\. This specification is linked to the server audit `RDS_DAS_AUDIT`\. The `RDS_DAS_CHANGES_AUDIT_SPEC` specification is managed by RDS\. -+ Database audit specification – The database audit specification records the database\-level events\. You can create a database audit specification `RDS_DAS_DB_` and link it to `RDS_DAS_AUDIT` server audit\. - -You can configure database activity streams by using the console or CLI\. Typically, you configure database activity streams as follows: - -1. \(Optional\) Create a database audit specification with the `CREATE DATABASE AUDIT SPECIFICATION` command and link it to `RDS_DAS_AUDIT` server audit\. - -1. \(Optional\) Modify the server audit specification with the `ALTER SERVER AUDIT SPECIFICATION` command and define the policies\. - -1. Activate the database and server audit policies\. For example: - - `ALTER DATABASE AUDIT SPECIFICATION [] WITH (STATE=ON)` - - `ALTER SERVER AUDIT SPECIFICATION [RDS_DAS_SERVER_AUDIT_SPEC] WITH (STATE=ON)` - -1. Configure database activity streams\. - - Only activities that match the server and database audit policies are captured and sent to the Amazon Kinesis data stream\. When database activity streams are enabled and the policies are locked, a database administrator can't alter the audit policy or remove audit logs\. -**Important** -If the database audit specification for a specific database is enabled and the policy is in a locked state, then the database can't be dropped\. - -For more information about SQL Server auditing, see [SQL Server Audit Components](https://learn.microsoft.com/en-us/sql/relational-databases/security/auditing/sql-server-audit-database-engine?view=sql-server-ver16) in the *Microsoft SQL Server documentation*\. - - - -### Non\-native audit fields for Oracle Database and SQL Server - -When you start a database activity stream, every database event generates a corresponding activity stream event\. For example, a database user might run `SELECT` and `INSERT` statements\. The database audits these events and sends them to an Amazon Kinesis data stream\. - -The events are represented in the stream as JSON objects\. A JSON object contains a `DatabaseActivityMonitoringRecord`, which contains a `databaseActivityEventList` array\. Predefined fields in the array include `class`, `clientApplication`, and `command`\. - -By default, an activity stream doesn't include engine\-native audit fields\. You can configure Amazon RDS for Oracle and SQL Server so that it includes these extra fields in the `engineNativeAuditFields` JSON object\. - -In Oracle Database, most events in the unified audit trail map to fields in the RDS data activity stream\. For example, the `UNIFIED_AUDIT_TRAIL.SQL_TEXT` field in unified auditing maps to the `commandText` field in a database activity stream\. However, Oracle Database audit fields such as `OS_USERNAME` don't map to predefined fields in a database activity stream\. - -In SQL Server, most of the event's fields that are recorded by the SQLAudit map to the fields in RDS database activity stream\. For example, the `code` field from `sys.fn_get_audit_file` in the audit maps to the `commandText` field in a database activity stream\. However, SQL Server database audit fields, such as `permission_bitmask`, don’t map to predefined fields in a database activity stream\. - -For more information about databaseActivityEventList, see [databaseActivityEventList JSON array](DBActivityStreams.Monitoring.md#DBActivityStreams.AuditLog.databaseActivityEventList)\. - -### DB parameter group override - -Typically, you turn on unified auditing in RDS for Oracle by attaching a parameter group\. However, Database Activity Streams require additional configuration\. To improve your customer experience, Amazon RDS performs the following: -+ If you activate an activity stream, RDS for Oracle ignores the auditing parameters in the parameter group\. -+ If you deactivate an activity stream, RDS for Oracle stops ignoring the auditing parameters\. - -The database activity stream for SQL Server is independent of any parameters you set in the SQL Audit option\. - -## Asynchronous mode for database activity streams - -Activity streams in Amazon RDS are always asynchronous\. When a database session generates an activity stream event, the session returns to normal activities immediately\. In the background, Amazon RDS makes the activity stream event into a durable record\. - -If an error occurs in the background task, Amazon RDS generates an event\. This event indicates the beginning and end of any time windows where activity stream event records might have been lost\. Asynchronous mode favors database performance over the accuracy of the activity stream\. - -## Requirements and limitations for database activity streams - -In RDS, database activity streams have the following requirements and limitations: -+ Amazon Kinesis is required for database activity streams\. -+ AWS Key Management Service \(AWS KMS\) is required for database activity streams because they are always encrypted\. -+ Applying additional encryption to your Amazon Kinesis data stream is incompatible with database activity streams, which are already encrypted with your AWS KMS key\. -+ You create and manage audit policies yourself\. Unlike Amazon Aurora, RDS for Oracle doesn't capture database activities by default\. -+ You create and manage audit policies or specifications yourself\. Unlike Amazon Aurora, Amazon RDS doesn't capture database activities by default\. -+ In a Multi\-AZ deployment, start the database activity stream only on the primary DB instance\. The activity stream audits both the primary and standby DB instances automatically\. No additional steps are required during a failover\. -+ Renaming a DB instance doesn't create a new Kinesis stream\. -+ CDBs aren't supported for RDS for Oracle\. -+ Read replicas aren't supported\. - -## Region and version availability - -Feature availability and support varies across specific versions of each database engine, and across AWS Regions\. For more information on version and Region availability with database activity streams, see [Database activity streams](Concepts.RDS_Fea_Regions_DB-eng.Feature.DBActivityStreams.md)\. - -## Supported DB instance classes for database activity streams - -For RDS for Oracle you can use database activity streams with the following DB instance classes: -+ db\.m4\.\*large -+ db\.m5\.\*large -+ db\.m5d\.\*large -+ db\.m6i\.\*large -+ db\.r4\.\*large -+ db\.r5\.\*large -+ db\.r5\.\*large\.tpc\*\.mem\*x -+ db\.r5b\.\*large -+ db\.r5b\.\*large\.tpc\*\.mem\*x -+ db\.r5d\.\*large -+ db\.r6i\.\*large -+ db\.x2idn\.\*large -+ db\.x2iedn\.\*large -+ db\.x2iezn\.\*large -+ db\.z1d\.\*large - -For RDS for SQL Server you can use database activity streams with the following DB instance classes: -+ db\.m4\.\*large -+ db\.m5\.\*large -+ db\.m5d\.\*large -+ db\.m6i\.\*large -+ db\.r4\.\*large -+ db\.r5\.\*large -+ db\.r5b\.\*large -+ db\.r5d\.\*large -+ db\.r6i\.\*large -+ db\.x1e\.\*large -+ db\.z1d\.\*large - -For more information about instance class types, see [DB instance classes](Concepts.DBInstanceClass.md)\. \ No newline at end of file diff --git a/doc_source/DBActivityStreams.Status.md b/doc_source/DBActivityStreams.Status.md deleted file mode 100644 index 242255f..0000000 --- a/doc_source/DBActivityStreams.Status.md +++ /dev/null @@ -1,55 +0,0 @@ -# Getting the status of a database activity stream - -You can get the status of an activity stream for your Amazon RDS database instance using the console or AWS CLI\. - -## Console - -**To get the status of a database activity stream** - -1. Open the Amazon RDS console at [https://console\.aws\.amazon\.com/rds/](https://console.aws.amazon.com/rds/)\. - -1. In the navigation pane, choose **Databases**, and then choose the DB instance link\. - -1. Choose the **Configuration** tab, and check **Database activity stream** for status\. - -## AWS CLI - -You can get the activity stream configuration for a database instance as the response to a [describe\-db\-instances](https://docs.aws.amazon.com/cli/latest/reference/rds/describe-db-instances.html) CLI request\. - -The following example describes *my\-instance*\. - -``` -aws rds --region my-region describe-db-instances --db-instance-identifier my-db -``` - -The following example shows a JSON response\. The following fields are shown: -+ `ActivityStreamKinesisStreamName` -+ `ActivityStreamKmsKeyId` -+ `ActivityStreamStatus` -+ `ActivityStreamMode` -+ `ActivityStreamPolicyStatus` - - - -``` -{ - "DBInstances": [ - { - ... - "Engine": "oracle-ee", - ... - "ActivityStreamStatus": "starting", - "ActivityStreamKmsKeyId": "ab12345e-1111-2bc3-12a3-ab1cd12345e", - "ActivityStreamKinesisStreamName": "aws-rds-das-db-AB1CDEFG23GHIJK4LMNOPQRST", - "ActivityStreamMode": "async", - "ActivityStreamEngineNativeAuditFieldsIncluded": true, - "ActivityStreamPolicyStatus": locked", - ... - } - ] -} -``` - -## RDS API - -You can get the activity stream configuration for a database as the response to a [DescribeDBInstances](https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_DescribeDBInstances.html) operation\. \ No newline at end of file diff --git a/doc_source/DBActivityStreams.configuring-auditing-SQLServer.md b/doc_source/DBActivityStreams.configuring-auditing-SQLServer.md deleted file mode 100644 index bf810b0..0000000 --- a/doc_source/DBActivityStreams.configuring-auditing-SQLServer.md +++ /dev/null @@ -1,38 +0,0 @@ -# Configuring auditing policy for Microsoft SQL Server - -A SQL Server database instance has the server audit `RDS_DAS_AUDIT`, which is managed by Amazon RDS\. You can define the policies to record server events in the server audit specification `RDS_DAS_SERVER_AUDIT_SPEC`\. You can create a database audit specification, such as `RDS_DAS_DB_`, and define the policies to record database events\. For the list of server and database level audit action groups, see [SQL Server Audit Action Groups and Actions](https://learn.microsoft.com/en-us/sql/relational-databases/security/auditing/sql-server-audit-action-groups-and-actions) in the *Microsoft SQL Server documentation*\. - -The default server policy monitors only failed logins and changes to any database or server audit specifications for database activity streams\. - -Limitations for the audit and audit specifications include the following: -+ You can't modify the server or database audit specifications when the database activity stream is in a *locked* state\. -+ You can't modify the server audit `RDS_DAS_AUDIT` specification\. -+ You can't modify the SQL Server audit `RDS_DAS_CHANGES` or its related server audit specification `RDS_DAS_CHANGES_AUDIT_SPEC`\. -+ When creating a database audit specification, you must use the format `RDS_DAS_DB_` for example, `RDS_DAS_DB_databaseActions`\. - -**Important** -For smaller instance classes, we recommend that you don't audit all but only the data that is required\. This helps to reduce the performance impact of Database Activity Streams on these instance classes\. - -The following sample code modifies the server audit specification `RDS_DAS_SERVER_AUDIT_SPEC` and audits any logout and successful login actions: - -``` -ALTER SERVER AUDIT SPECIFICATION [RDS_DAS_SERVER_AUDIT_SPEC] - WITH (STATE=OFF); -ALTER SERVER AUDIT SPECIFICATION [RDS_DAS_SERVER_AUDIT_SPEC] - ADD (LOGOUT_GROUP), - ADD (SUCCESSFUL_LOGIN_GROUP) - WITH (STATE = ON ); -``` - -The following sample code creates a database audit specification `RDS_DAS_DB_database_spec` and attaches it to the server audit `RDS_DAS_AUDIT`: - -``` -USE testDB; -CREATE DATABASE AUDIT SPECIFICATION [RDS_DAS_DB_database_spec] - FOR SERVER AUDIT [RDS_DAS_AUDIT] - ADD ( INSERT, UPDATE, DELETE - ON testTable BY testUser ) - WITH (STATE = ON); -``` - -After the audit specifications are configured, make sure that the specifications `RDS_DAS_SERVER_AUDIT_SPEC` and `RDS_DAS_DB_` are set to a state of `ON`\. Now they can send the audit data to your database activity stream\. \ No newline at end of file diff --git a/doc_source/DBActivityStreams.configuring-auditing.md b/doc_source/DBActivityStreams.configuring-auditing.md deleted file mode 100644 index a841a4c..0000000 --- a/doc_source/DBActivityStreams.configuring-auditing.md +++ /dev/null @@ -1,26 +0,0 @@ -# Configuring unified auditing for Oracle Database - -When you configure unified auditing for use with database activity streams, the following situations are possible: -+ Unified auditing isn't configured for your Oracle database\. - - In this case, create new policies with the `CREATE AUDIT POLICY` command, then activate them with the `AUDIT POLICY` command\. The following example creates and activates a policy to monitor users with specific privileges and roles\. - - ``` - CREATE AUDIT POLICY table_pol - PRIVILEGES CREATE ANY TABLE, DROP ANY TABLE - ROLES emp_admin, sales_admin; - - AUDIT POLICY table_pol; - ``` - - For complete instructions, see [Configuring Audit Policies](https://docs.oracle.com/en/database/oracle/oracle-database/19/dbseg/configuring-audit-policies.html#GUID-22CDB667-5AA2-4051-A262-FBD0236763CB) in the Oracle Database documentation\. -+ Unified auditing is configured for your Oracle database\. - - When you activate a database activity stream, RDS for Oracle automatically clears existing audit data\. It also revokes audit trail privileges\. RDS for Oracle can no longer do the following: - + Purge unified audit trail records\. - + Add, delete, or modify the unified audit policy\. - + Update the last archived timestamp\. -**Important** -We strongly recommend that you back up your audit data before activating a database activity stream\. - - For a description of the `UNIFIED_AUDIT_TRAIL` view, see [UNIFIED\_AUDIT\_TRAIL](https://docs.oracle.com/database/121/REFRN/GUID-B7CE1C02-2FD4-47D6-80AA-CF74A60CDD1D.htm#REFRN29162)\. If you have an account with Oracle Support, see [How To Purge The UNIFIED AUDIT TRAIL](https://support.oracle.com/knowledge/Oracle%20Database%20Products/1582627_1.html)\. \ No newline at end of file diff --git a/doc_source/DBActivityStreams.md b/doc_source/DBActivityStreams.md deleted file mode 100644 index e10a73d..0000000 --- a/doc_source/DBActivityStreams.md +++ /dev/null @@ -1,14 +0,0 @@ -# Monitoring Amazon RDS with Database Activity Streams - -By using Database Activity Streams, you can monitor near real\-time streams of database activity\. - -**Topics** -+ [Overview of Database Activity Streams](DBActivityStreams.Overview.md) -+ [Configuring unified auditing for Oracle Database](DBActivityStreams.configuring-auditing.md) -+ [Configuring auditing policy for Microsoft SQL Server](DBActivityStreams.configuring-auditing-SQLServer.md) -+ [Starting a database activity stream](DBActivityStreams.Enabling.md) -+ [Modifying a database activity stream](DBActivityStreams.Modifying.md) -+ [Getting the status of a database activity stream](DBActivityStreams.Status.md) -+ [Stopping a database activity stream](DBActivityStreams.Disabling.md) -+ [Monitoring database activity streams](DBActivityStreams.Monitoring.md) -+ [Managing access to database activity streams](DBActivityStreams.ManagingAccess.md) \ No newline at end of file diff --git a/doc_source/DataDurability.md b/doc_source/DataDurability.md deleted file mode 100644 index 28575fe..0000000 --- a/doc_source/DataDurability.md +++ /dev/null @@ -1,17 +0,0 @@ -# Data protection in Amazon RDS - -The AWS [shared responsibility model](http://aws.amazon.com/compliance/shared-responsibility-model/) applies to data protection in Amazon Relational Database Service\. As described in this model, AWS is responsible for protecting the global infrastructure that runs all of the AWS Cloud\. You are responsible for maintaining control over your content that is hosted on this infrastructure\. This content includes the security configuration and management tasks for the AWS services that you use\. For more information about data privacy, see the [Data Privacy FAQ](http://aws.amazon.com/compliance/data-privacy-faq)\. For information about data protection in Europe, see the [AWS Shared Responsibility Model and GDPR](http://aws.amazon.com/blogs/security/the-aws-shared-responsibility-model-and-gdpr/) blog post on the *AWS Security Blog*\. - -For data protection purposes, we recommend that you protect AWS account credentials and set up individual users with AWS IAM Identity Center \(successor to AWS Single Sign\-On\) or AWS Identity and Access Management \(IAM\)\. That way, each user is given only the permissions necessary to fulfill their job duties\. We also recommend that you secure your data in the following ways: -+ Use multi\-factor authentication \(MFA\) with each account\. -+ Use SSL/TLS to communicate with AWS resources\. We require TLS 1\.2 and recommend TLS 1\.3\. -+ Set up API and user activity logging with AWS CloudTrail\. -+ Use AWS encryption solutions, along with all default security controls within AWS services\. -+ Use advanced managed security services such as Amazon Macie, which assists in discovering and securing sensitive data that is stored in Amazon S3\. -+ If you require FIPS 140\-2 validated cryptographic modules when accessing AWS through a command line interface or an API, use a FIPS endpoint\. For more information about the available FIPS endpoints, see [Federal Information Processing Standard \(FIPS\) 140\-2](http://aws.amazon.com/compliance/fips/)\. - -We strongly recommend that you never put confidential or sensitive information, such as your customers' email addresses, into tags or free\-form text fields such as a **Name** field\. This includes when you work with Amazon RDS or other AWS services using the console, API, AWS CLI, or AWS SDKs\. Any data that you enter into tags or free\-form text fields used for names may be used for billing or diagnostic logs\. If you provide a URL to an external server, we strongly recommend that you do not include credentials information in the URL to validate your request to that server\. - -**Topics** -+ [Protecting data using encryption](Encryption.md) -+ [Internetwork traffic privacy](inter-network-traffic-privacy.md) \ No newline at end of file diff --git a/doc_source/DownloadCompleteDBLogFile.md b/doc_source/DownloadCompleteDBLogFile.md deleted file mode 100644 index 0517972..0000000 --- a/doc_source/DownloadCompleteDBLogFile.md +++ /dev/null @@ -1,35 +0,0 @@ -# Reading log file contents using REST - -Amazon RDS provides a REST endpoint that allows access to DB instance log files\. This is useful if you need to write an application to stream Amazon RDS log file contents\. - -The syntax is: - -``` -GET /v13/downloadCompleteLogFile/DBInstanceIdentifier/LogFileName HTTP/1.1 -Content-type: application/json -host: rds.region.amazonaws.com -``` - -The following parameters are required: -+ `DBInstanceIdentifier`—the name of the DB instance that contains the log file you want to download\. -+ `LogFileName`—the name of the log file to be downloaded\. - -The response contains the contents of the requested log file, as a stream\. - -The following example downloads the log file named *log/ERROR\.6* for the DB instance named *sample\-sql* in the *us\-west\-2* region\. - -``` -GET /v13/downloadCompleteLogFile/sample-sql/log/ERROR.6 HTTP/1.1 -host: rds.us-west-2.amazonaws.com -X-Amz-Security-Token: AQoDYXdzEIH//////////wEa0AIXLhngC5zp9CyB1R6abwKrXHVR5efnAVN3XvR7IwqKYalFSn6UyJuEFTft9nObglx4QJ+GXV9cpACkETq= -X-Amz-Date: 20140903T233749Z -X-Amz-Algorithm: AWS4-HMAC-SHA256 -X-Amz-Credential: AKIADQKE4SARGYLE/20140903/us-west-2/rds/aws4_request -X-Amz-SignedHeaders: host -X-Amz-Content-SHA256: e3b0c44298fc1c229afbf4c8996fb92427ae41e4649b934de495991b7852b855 -X-Amz-Expires: 86400 -X-Amz-Signature: 353a4f14b3f250142d9afc34f9f9948154d46ce7d4ec091d0cdabbcf8b40c558 -``` - -If you specify a nonexistent DB instance, the response consists of the following error: -+ `DBInstanceNotFound`—`DBInstanceIdentifier` does not refer to an existing DB instance\. \(HTTP status code: 404\) \ No newline at end of file diff --git a/doc_source/Encryption.md b/doc_source/Encryption.md deleted file mode 100644 index 2f7327b..0000000 --- a/doc_source/Encryption.md +++ /dev/null @@ -1,9 +0,0 @@ -# Protecting data using encryption - -You can enable encryption for database resources\. You can also encrypt connections to DB instances\. - -**Topics** -+ [Encrypting Amazon RDS resources](Overview.Encryption.md) -+ [AWS KMS key management](Overview.Encryption.Keys.md) -+ [Using SSL/TLS to encrypt a connection to a DB instance](UsingWithRDS.SSL.md) -+ [Rotating your SSL/TLS certificate](UsingWithRDS.SSL-certificate-rotation.md) \ No newline at end of file diff --git a/doc_source/MariaDB.Concepts.FeatureSupport.md b/doc_source/MariaDB.Concepts.FeatureSupport.md deleted file mode 100644 index 95b2821..0000000 --- a/doc_source/MariaDB.Concepts.FeatureSupport.md +++ /dev/null @@ -1,195 +0,0 @@ -# MariaDB feature support on Amazon RDS - -RDS for MariaDB supports most of the features and capabilities of MariaDB\. Some features might have limited support or restricted privileges\. - -You can filter new Amazon RDS features on the [What's New with Database?](http://aws.amazon.com/about-aws/whats-new/database/) page\. For **Products**, choose **Amazon RDS**\. Then search using keywords such as **MariaDB 2022**\. - -**Note** -The following lists are not exhaustive\. - -**Topics** -+ [MariaDB feature support on Amazon RDS for MariaDB major versions](#MariaDB.Concepts.FeatureSupport.MajorVersions) -+ [Supported storage engines for MariaDB on Amazon RDS](#MariaDB.Concepts.Storage) -+ [Cache warming for MariaDB on Amazon RDS](#MariaDB.Concepts.XtraDBCacheWarming) -+ [MariaDB features not supported by Amazon RDS](#MariaDB.Concepts.FeatureNonSupport) - -## MariaDB feature support on Amazon RDS for MariaDB major versions - -In the following sections, find information about MariaDB feature support on Amazon RDS for MariaDB major versions: - -**Topics** -+ [MariaDB 10\.6 support on Amazon RDS](#MariaDB.Concepts.FeatureSupport.10-6) -+ [MariaDB 10\.5 support on Amazon RDS](#MariaDB.Concepts.FeatureSupport.10-5) -+ [MariaDB 10\.4 support on Amazon RDS](#MariaDB.Concepts.FeatureSupport.10-4) -+ [MariaDB 10\.3 support on Amazon RDS](#MariaDB.Concepts.FeatureSupport.10-3) - -For information about supported minor versions of Amazon RDS for MariaDB, see [MariaDB on Amazon RDS versions](MariaDB.Concepts.VersionMgmt.md)\. - -### MariaDB 10\.6 support on Amazon RDS - -Amazon RDS supports the following new features for your DB instances running MariaDB version 10\.6 or higher: -+ **MyRocks storage engine** – You can use the MyRocks storage engine with RDS for MariaDB to optimize storage consumption of your write\-intensive, high\-performance web applications\. For more information, see [Supported storage engines for MariaDB on Amazon RDS](#MariaDB.Concepts.Storage) and [MyRocks](https://mariadb.com/kb/en/myrocks/)\. -+ **AWS Identity and Access Management \(IAM\) DB authentication** – You can use IAM DB authentication for better security and central management of connections to your MariaDB DB instances\. For more information, see [IAM database authentication for MariaDB, MySQL, and PostgreSQL](UsingWithRDS.IAMDBAuth.md)\. -+ **Upgrade options** – You can now upgrade to RDS for MariaDB version 10\.6 from any prior major release \(10\.3, 10\.4, 10\.5\)\. You can also restore a snapshot of an existing MySQL 5\.6 or 5\.7 DB instance to a MariaDB 10\.6 instance\. For more information, see [Upgrading the MariaDB DB engine](USER_UpgradeDBInstance.MariaDB.md)\. -+ **Delayed replication** – You can now set a configurable time period for which a read replica lags behind the source database\. In a standard MariaDB replication configuration, there is minimal replication delay between the source and the replica\. With delayed replication, you can set an intentional delay as a strategy for disaster recovery\. For more information, see [Configuring delayed replication with MariaDB](USER_MariaDB.Replication.ReadReplicas.md#USER_MariaDB.Replication.ReadReplicas.DelayReplication)\. -+ **Oracle PL/SQL compatibility** – By using RDS for MariaDB version 10\.6, you can more easily migrate your legacy Oracle applications to Amazon RDS\. For more information, see [SQL\_MODE=ORACLE](https://mariadb.com/kb/en/sql_modeoracle/)\. -+ **Atomic DDL** – Your dynamic data language \(DDL\) statements can be relatively crash\-safe with RDS for MariaDB version 10\.6\. `CREATE TABLE`, `ALTER TABLE`, `RENAME TABLE`, `DROP TABLE`, `DROP DATABASE` and related DDL statements are now atomic\. Either the statement succeeds, or it's completely reversed\. For more information, see [Atomic DDL](https://mariadb.com/kb/en/atomic-ddl/)\. -+ **Other enhancements** – These enhancements include a `JSON_TABLE` function for transforming JSON data to relational format within SQL, and faster empty table data load with Innodb\. They also include new `sys_schema` for analysis and troubleshooting, optimizer enhancement for ignoring unused indexes, and performance improvements\. For more information, see [JSON\_TABLE](https://mariadb.com/kb/en/json_table/)\. -+ **New default values for parameters** – The following parameters have new default values for MariaDB version 10\.6 DB instances: - + The default value for the following parameters has changed from `utf8` to `utf8mb3`: - + [character\_set\_client](https://mariadb.com/kb/en/server-system-variables/#character_set_client) - + [character\_set\_connection](https://mariadb.com/kb/en/server-system-variables/#character_set_connection) - + [character\_set\_results](https://mariadb.com/kb/en/server-system-variables/#character_set_results) - + [character\_set\_system](https://mariadb.com/kb/en/server-system-variables/#character_set_system) - - Although the default values have changed for these parameters, there is no functional change\. For more information, see [Supported Character Sets and Collations](https://mariadb.com/kb/en/supported-character-sets-and-collations/) in the MariaDB documentation\. - + The default value of the [ collation\_connection](https://mariadb.com/kb/en/server-system-variables/#collation_connection) parameter has changed from `utf8_general_ci` to `utf8mb3_general_ci`\. Although the default value has changed for this parameter, there is no functional change\. - + The default value of the [ old\_mode](https://mariadb.com/kb/en/server-system-variables/#old_mode) parameter has changed from unset to `UTF8_IS_UTF8MB3`\. Although the default value has changed for this parameter, there is no functional change\. - -For a list of all MariaDB 10\.6 features and their documentation, see [Changes and improvements in MariaDB 10\.6](https://mariadb.com/kb/en/changes-improvements-in-mariadb-106/) and [Release notes \- MariaDB 10\.6 series](https://mariadb.com/kb/en/release-notes-mariadb-106-series/) on the MariaDB website\. - -For a list of unsupported features, see [MariaDB features not supported by Amazon RDS](#MariaDB.Concepts.FeatureNonSupport)\. - -### MariaDB 10\.5 support on Amazon RDS - -Amazon RDS supports the following new features for your DB instances running MariaDB version 10\.5 or later: -+ **InnoDB enhancements** – MariaDB version 10\.5 includes InnoDB enhancements\. For more information, see [ InnoDB: Performance Improvements etc\.](https://mariadb.com/kb/en/changes-improvements-in-mariadb-105/#innodb-performance-improvements-etc) in the MariaDB documentation\. -+ **Performance schema updates** – MariaDB version 10\.5 includes performance schema updates\. For more information, see [ Performance Schema Updates to Match MySQL 5\.7 Instrumentation and Tables](https://mariadb.com/kb/en/changes-improvements-in-mariadb-105/#performance-schema-updates-to-match-mysql-57-instrumentation-and-tables) in the MariaDB documentation\. -+ **One file in the InnoDB redo log** – In versions of MariaDB before version 10\.5, the value of the `innodb_log_files_in_group` parameter was set to `2`\. In MariaDB version 10\.5, the value of this parameter is set to `1`\. - - If you are upgrading from a prior version to MariaDB version 10\.5, and you don't modify the parameters, the `innodb_log_file_size` parameter value is unchanged\. However, it applies to one log file instead of two\. The result is that your upgraded MariaDB version 10\.5 DB instance uses half of the redo log size that it was using before the upgrade\. This change can have a noticeable performance impact\. To address this issue, you can double the value of the `innodb_log_file_size` parameter\. For information about modifying parameters, see [Modifying parameters in a DB parameter group](USER_WorkingWithDBInstanceParamGroups.md#USER_WorkingWithParamGroups.Modifying)\. -+ **SHOW SLAVE STATUS command not supported** – In versions of MariaDB before version 10\.5, the `SHOW SLAVE STATUS` command required the `REPLICATION SLAVE` privilege\. In MariaDB version 10\.5, the equivalent `SHOW REPLICA STATUS` command requires the `REPLICATION REPLICA ADMIN` privilege\. This new privilege isn't granted to the RDS master user\. - - Instead of using the `SHOW REPLICA STATUS` command, run the new `mysql.rds_replica_status` stored procedure to return similar information\. For more information, see [mysql\.rds\_replica\_status](mysql_rds_replica_status.md)\. -+ **SHOW RELAYLOG EVENTS command not supported** – In versions of MariaDB before version 10\.5, the `SHOW RELAYLOG EVENTS` command required the `REPLICATION SLAVE` privilege\. In MariaDB version 10\.5, this command requires the `REPLICATION REPLICA ADMIN` privilege\. This new privilege isn't granted to the RDS master user\. -+ **New default values for parameters** – The following parameters have new default values for MariaDB version 10\.5 DB instances: - + The default value of the [max\_connections](https://mariadb.com/kb/en/server-system-variables/#max_connections) parameter has changed to `LEAST({DBInstanceClassMemory/25165760},12000)`\. For information about the `LEAST` parameter function, see [DB parameter functions](USER_ParamValuesRef.md#USER_ParamFunctions)\. - + The default value of the [ innodb\_adaptive\_hash\_index](https://mariadb.com/kb/en/innodb-system-variables/#innodb_adaptive_hash_index) parameter has changed to `OFF` \(`0`\)\. - + The default value of the [ innodb\_checksum\_algorithm](https://mariadb.com/kb/en/innodb-system-variables/#innodb_checksum_algorithm) parameter has changed to `full_crc32`\. - + The default value of the [innodb\_log\_file\_size](https://mariadb.com/kb/en/innodb-system-variables/#innodb_log_file_size) parameter has changed to 2 GB\. - -For a list of all MariaDB 10\.5 features and their documentation, see [Changes and improvements in MariaDB 10\.5](https://mariadb.com/kb/en/changes-improvements-in-mariadb-105/) and [Release notes \- MariaDB 10\.5 series](https://mariadb.com/kb/en/release-notes-mariadb-105-series/) on the MariaDB website\. - -For a list of unsupported features, see [MariaDB features not supported by Amazon RDS](#MariaDB.Concepts.FeatureNonSupport)\. - -### MariaDB 10\.4 support on Amazon RDS - -Amazon RDS supports the following new features for your DB instances running MariaDB version 10\.4 or later: -+ **User account security enhancements** – [Password expiration](https://mariadb.com/kb/en/user-password-expiry/) and [account locking](https://mariadb.com/kb/en/account-locking/) improvements -+ **Optimizer enhancements** – [Optimizer trace feature](https://mariadb.com/kb/en/optimizer-trace-overview/) -+ **InnoDB enhancements ** – [Instant DROP COLUMN support](https://mariadb.com/kb/en/alter-table/#drop-column) and instant `VARCHAR` extension for `ROW_FORMAT=DYNAMIC` and `ROW_FORMAT=COMPACT` -+ **New parameters** – Including [tcp\_nodedelay](https://mariadb.com/kb/en/server-system-variables/#tcp_nodelay), [tls\_version](https://mariadb.com/kb/en/ssltls-system-variables/#tls_version), and [gtid\_cleanup\_batch\_size](https://mariadb.com/kb/en/gtid/#gtid_cleanup_batch_size) - -For a list of all MariaDB 10\.4 features and their documentation, see [Changes and improvements in MariaDB 10\.4](https://mariadb.com/kb/en/library/changes-improvements-in-mariadb-104/) and [Release notes \- MariaDB 10\.4 series](https://mariadb.com/kb/en/library/release-notes-mariadb-104-series/) on the MariaDB website\. - -For a list of unsupported features, see [MariaDB features not supported by Amazon RDS](#MariaDB.Concepts.FeatureNonSupport)\. - -### MariaDB 10\.3 support on Amazon RDS - -Amazon RDS supports the following new features for your DB instances running MariaDB version 10\.3 or later: -+ **Oracle compatibility** – PL/SQL compatibility parser, sequences, INTERSECT and EXCEPT to complement UNION, new TYPE OF and ROW TYPE OF declarations, and invisible columns -+ **Temporal data processing** – System versioned tables for querying of past and present states of the database -+ **Flexibility** – User\-defined aggregates, storage\-independent column compression, and proxy protocol support to relay the client IP address to the server -+ **Manageability** – Instant ADD COLUMN operations and fast\-fail data definition language \(DDL\) operations - -For a list of all MariaDB 10\.3 features and their documentation, see [Changes & improvements in MariaDB 10\.3](https://mariadb.com/kb/en/library/changes-improvements-in-mariadb-103/) and [Release notes \- MariaDB 10\.3 series](https://mariadb.com/kb/en/library/release-notes-mariadb-103-series/) on the MariaDB website\. - -For a list of unsupported features, see [MariaDB features not supported by Amazon RDS](#MariaDB.Concepts.FeatureNonSupport)\. - -## Supported storage engines for MariaDB on Amazon RDS - -RDS for MariaDB supports the following storage engines\. - -**Topics** -+ [The InnoDB storage engine](#MariaDB.Concepts.Storage.InnoDB) -+ [The MyRocks storage engine](#MariaDB.Concepts.Storage.MyRocks) - -Other storage engines aren't currently supported by RDS for MariaDB\. - -### The InnoDB storage engine - -Although MariaDB supports multiple storage engines with varying capabilities, not all of them are optimized for recovery and data durability\. InnoDB is the recommended storage engine for MariaDB DB instances on Amazon RDS\. Amazon RDS features such as point\-in\-time restore and snapshot restore require a recoverable storage engine and are supported only for the recommended storage engine for the MariaDB version\. - -For more information, see [InnoDB](https://mariadb.com/kb/en/innodb/)\. - -### The MyRocks storage engine - -The MyRocks storage engine is available in RDS for MariaDB version 10\.6 and higher\. Before using the MyRocks storage engine in a production database, we recommend that you perform thorough benchmarking and testing to verify any potential benefits over InnoDB for your use case\. - -The default parameter group for MariaDB version 10\.6 includes MyRocks parameters\. For more information, see [Parameters for MariaDB](Appendix.MariaDB.Parameters.md) and [Working with parameter groups](USER_WorkingWithParamGroups.md)\. - -To create a table that uses the MyRocks storage engine, specify `ENGINE=RocksDB` in the `CREATE TABLE` statement\. The following example creates a table that uses the MyRocks storage engine\. - -``` -CREATE TABLE test (a INT NOT NULL, b CHAR(10)) ENGINE=RocksDB; -``` - -We strongly recommend that you don't run transactions that span both InnoDB and MyRocks tables\. MariaDB doesn't guarantee ACID \(atomicity, consistency, isolation, durability\) for transactions across storage engines\. Although it is possible to have both InnoDB and MyRocks tables in a DB instance, we don't recommend this approach except during a migration from one storage engine to the other\. When both InnoDB and MyRocks tables exist in a DB instance, each storage engine has its own buffer pool, which might cause performance to degrade\. - -MyRocks doesn’t support `SERIALIZABLE` isolation or gap locks\. So, generally you can't use MyRocks with statement\-based replication\. For more information, see [ MyRocks and Replication](https://mariadb.com/kb/en/myrocks-and-replication/)\. - -Currently, you can modify only the following MyRocks parameters: -+ [https://mariadb.com/kb/en/myrocks-system-variables/#rocksdb_block_cache_size](https://mariadb.com/kb/en/myrocks-system-variables/#rocksdb_block_cache_size) -+ [https://mariadb.com/kb/en/myrocks-system-variables/#rocksdb_bulk_load](https://mariadb.com/kb/en/myrocks-system-variables/#rocksdb_bulk_load) -+ [https://mariadb.com/kb/en/myrocks-system-variables/#rocksdb_bulk_load_size](https://mariadb.com/kb/en/myrocks-system-variables/#rocksdb_bulk_load_size) -+ [https://mariadb.com/kb/en/myrocks-system-variables/#rocksdb_deadlock_detect](https://mariadb.com/kb/en/myrocks-system-variables/#rocksdb_deadlock_detect) -+ [https://mariadb.com/kb/en/myrocks-system-variables/#rocksdb_deadlock_detect_depth](https://mariadb.com/kb/en/myrocks-system-variables/#rocksdb_deadlock_detect_depth) -+ [https://mariadb.com/kb/en/myrocks-system-variables/#rocksdb_max_latest_deadlocks](https://mariadb.com/kb/en/myrocks-system-variables/#rocksdb_max_latest_deadlocks) - -The MyRocks storage engine and the InnoDB storage engine can compete for memory based on the settings for the `rocksdb_block_cache_size` and `innodb_buffer_pool_size` parameters\. In some cases, you might only intend to use the MyRocks storage engine on a particular DB instance\. If so, we recommend setting the `innodb_buffer_pool_size minimal` parameter to a minimal value and setting the `rocksdb_block_cache_size` as high as possible\. - -You can access MyRocks log files by using the [https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_DescribeDBLogFiles.html](https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_DescribeDBLogFiles.html) and [https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_DownloadDBLogFilePortion.html](https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_DownloadDBLogFilePortion.html) operations\. - -For more information about MyRocks, see [MyRocks](https://mariadb.com/kb/en/myrocks/) on the MariaDB website\. - -## Cache warming for MariaDB on Amazon RDS - -InnoDB cache warming can provide performance gains for your MariaDB DB instance by saving the current state of the buffer pool when the DB instance is shut down, and then reloading the buffer pool from the saved information when the DB instance starts up\. This approach bypasses the need for the buffer pool to "warm up" from normal database use and instead preloads the buffer pool with the pages for known common queries\. For more information on cache warming, see [ Dumping and restoring the buffer pool](http://mariadb.com/kb/en/mariadb/xtradbinnodb-buffer-pool/#dumping-and-restoring-the-buffer-pool) in the MariaDB documentation\. - -Cache warming is enabled by default on MariaDB 10\.3 and higher DB instances\. To enable it, set the `innodb_buffer_pool_dump_at_shutdown` and `innodb_buffer_pool_load_at_startup` parameters to 1 in the parameter group for your DB instance\. Changing these parameter values in a parameter group affects all MariaDB DB instances that use that parameter group\. To enable cache warming for specific MariaDB DB instances, you might need to create a new parameter group for those DB instances\. For information on parameter groups, see [Working with parameter groups](USER_WorkingWithParamGroups.md)\. - -Cache warming primarily provides a performance benefit for DB instances that use standard storage\. If you use PIOPS storage, you don't commonly see a significant performance benefit\. - -**Important** -If your MariaDB DB instance doesn't shut down normally, such as during a failover, then the buffer pool state isn't saved to disk\. In this case, MariaDB loads whatever buffer pool file is available when the DB instance is restarted\. No harm is done, but the restored buffer pool might not reflect the most recent state of the buffer pool before the restart\. To ensure that you have a recent state of the buffer pool available to warm the cache on startup, we recommend that you periodically dump the buffer pool "on demand\." You can dump or load the buffer pool on demand\. -You can create an event to dump the buffer pool automatically and at a regular interval\. For example, the following statement creates an event named `periodic_buffer_pool_dump` that dumps the buffer pool every hour\. - -``` -1. CREATE EVENT periodic_buffer_pool_dump -2. ON SCHEDULE EVERY 1 HOUR -3. DO CALL mysql.rds_innodb_buffer_pool_dump_now(); -``` -For more information, see [Events](http://mariadb.com/kb/en/mariadb/stored-programs-and-views-events/) in the MariaDB documentation\. - -### Dumping and loading the buffer pool on demand - -You can save and load the cache on demand using the following stored procedures: -+ To dump the current state of the buffer pool to disk, call the [mysql\.rds\_innodb\_buffer\_pool\_dump\_now](mysql-stored-proc-warming.md#mysql_rds_innodb_buffer_pool_dump_now) stored procedure\. -+ To load the saved state of the buffer pool from disk, call the [mysql\.rds\_innodb\_buffer\_pool\_load\_now](mysql-stored-proc-warming.md#mysql_rds_innodb_buffer_pool_load_now) stored procedure\. -+ To cancel a load operation in progress, call the [mysql\.rds\_innodb\_buffer\_pool\_load\_abort](mysql-stored-proc-warming.md#mysql_rds_innodb_buffer_pool_load_abort) stored procedure\. - -## MariaDB features not supported by Amazon RDS - -The following MariaDB features are not supported on Amazon RDS: -+ S3 storage engine -+ Authentication plugin – GSSAPI -+ Authentication plugin – Unix Socket -+ AWS Key Management encryption plugin -+ Delayed replication for MariaDB versions lower than 10\.6 -+ Native MariaDB encryption at rest for InnoDB and Aria\. - - You can enable encryption at rest for a MariaDB DB instance by following the instructions in [Encrypting Amazon RDS resources](Overview.Encryption.md)\. -+ HandlerSocket -+ JSON table type for MariaDB versions lower than 10\.6 -+ MariaDB ColumnStore -+ MariaDB Galera Cluster -+ Multisource replication -+ MyRocks storage engine for MariaDB versions lower than 10\.6 -+ Password validation plugin, `simple_password_check`, and `cracklib_password_check` -+ Spider storage engine -+ Sphinx storage engine -+ TokuDB storage engine -+ Storage engine\-specific object attributes, as described in [ Engine\-defined new Table/Field/Index attributes](http://mariadb.com/kb/en/mariadb/engine-defined-new-tablefieldindex-attributes/) in the MariaDB documentation -+ Table and tablespace encryption - -To deliver a managed service experience, Amazon RDS doesn't provide shell access to DB instances, and it restricts access to certain system procedures and tables that require advanced privileges\. Amazon RDS supports access to databases on a DB instance using any standard SQL client application\. Amazon RDS doesn't allow direct host access to a DB instance by using Telnet, Secure Shell \(SSH\), or Windows Remote Desktop Connection\. \ No newline at end of file diff --git a/doc_source/MariaDB.Concepts.LocalTimeZone.md b/doc_source/MariaDB.Concepts.LocalTimeZone.md deleted file mode 100644 index 647a265..0000000 --- a/doc_source/MariaDB.Concepts.LocalTimeZone.md +++ /dev/null @@ -1,66 +0,0 @@ -# Local time zone for MariaDB DB instances - -By default, the time zone for a MariaDB DB instance is Universal Time Coordinated \(UTC\)\. You can set the time zone for your DB instance to the local time zone for your application instead\. - -To set the local time zone for a DB instance, set the `time_zone` parameter in the parameter group for your DB instance to one of the supported values listed later in this section\. When you set the `time_zone` parameter for a parameter group, all DB instances and read replicas that are using that parameter group change to use the new local time zone\. For information on setting parameters in a parameter group, see [Working with parameter groups](USER_WorkingWithParamGroups.md)\. - -After you set the local time zone, all new connections to the database reflect the change\. If you have any open connections to your database when you change the local time zone, you won't see the local time zone update until after you close the connection and open a new connection\. - -You can set a different local time zone for a DB instance and one or more of its read replicas\. To do this, use a different parameter group for the DB instance and the replica or replicas and set the `time_zone` parameter in each parameter group to a different local time zone\. - -If you are replicating across AWS Regions, then the source DB instance and the read replica use different parameter groups \(parameter groups are unique to an AWS Region\)\. To use the same local time zone for each instance, you must set the `time_zone` parameter in the instance's and read replica's parameter groups\. - -When you restore a DB instance from a DB snapshot, the local time zone is set to UTC\. You can update the time zone to your local time zone after the restore is complete\. If you restore a DB instance to a point in time, then the local time zone for the restored DB instance is the time zone setting from the parameter group of the restored DB instance\. - -The Internet Assigned Numbers Authority \(IANA\) publishes new time zones at [ https://www\.iana\.org/time\-zones](https://www.iana.org/time-zones) several times a year\. Every time RDS releases a new minor maintenance release of MariaDB, it ships with the latest time zone data at the time of the release\. When you use the latest RDS for MariaDB versions, you have recent time zone data from RDS\. To ensure that your DB instance has recent time zone data, we recommend upgrading to a higher DB engine version\. Alternatively, you can modify the time zone tables in MariaDB DB instances manually\. To do so, you can use SQL commands or run the [mysql\_tzinfo\_to\_sql tool](https://mariadb.com/kb/en/mysql_tzinfo_to_sql/) in a SQL client\. After updating the time zone data manually, reboot your DB instance so that the changes take effect\. RDS doesn't modify or reset the time zone data of running DB instances\. New time zone data is installed only when you perform a database engine version upgrade\. - -You can set your local time zone to one of the following values\. - - -**** - -| | | -| --- |--- | -| `Africa/Cairo` | `Asia/Riyadh` | -| `Africa/Casablanca` | `Asia/Seoul` | -| `Africa/Harare` | `Asia/Shanghai` | -| `Africa/Monrovia` | `Asia/Singapore` | -| `Africa/Nairobi` | `Asia/Taipei` | -| `Africa/Tripoli` | `Asia/Tehran` | -| `Africa/Windhoek` | `Asia/Tokyo` | -| `America/Araguaina` | `Asia/Ulaanbaatar` | -| `America/Asuncion` | `Asia/Vladivostok` | -| `America/Bogota` | `Asia/Yakutsk` | -| `America/Buenos_Aires` | `Asia/Yerevan` | -| `America/Caracas` | `Atlantic/Azores` | -| `America/Chihuahua` | `Australia/Adelaide` | -| `America/Cuiaba` | `Australia/Brisbane` | -| `America/Denver` | `Australia/Darwin` | -| `America/Fortaleza` | `Australia/Hobart` | -| `America/Guatemala` | `Australia/Perth` | -| `America/Halifax` | `Australia/Sydney` | -| `America/Manaus` | `Brazil/East` | -| `America/Matamoros` | `Canada/Newfoundland` | -| `America/Monterrey` | `Canada/Saskatchewan` | -| `America/Montevideo` | `Canada/Yukon` | -| `America/Phoenix` | `Europe/Amsterdam` | -| `America/Santiago` | `Europe/Athens` | -| `America/Tijuana` | `Europe/Dublin` | -| `Asia/Amman` | `Europe/Helsinki` | -| `Asia/Ashgabat` | `Europe/Istanbul` | -| `Asia/Baghdad` | `Europe/Kaliningrad` | -| `Asia/Baku` | `Europe/Moscow` | -| `Asia/Bangkok` | `Europe/Paris` | -| `Asia/Beirut` | `Europe/Prague` | -| `Asia/Calcutta` | `Europe/Sarajevo` | -| `Asia/Damascus` | `Pacific/Auckland` | -| `Asia/Dhaka` | `Pacific/Fiji` | -| `Asia/Irkutsk` | `Pacific/Guam` | -| `Asia/Jerusalem` | `Pacific/Honolulu` | -| `Asia/Kabul` | `Pacific/Samoa` | -| `Asia/Karachi` | `US/Alaska` | -| `Asia/Kathmandu` | `US/Central` | -| `Asia/Krasnoyarsk` | `US/Eastern` | -| `Asia/Magadan` | `US/East-Indiana` | -| `Asia/Muscat` | `US/Pacific` | -| `Asia/Novosibirsk` | `UTC` | \ No newline at end of file diff --git a/doc_source/MariaDB.Concepts.UsersAndPrivileges.md b/doc_source/MariaDB.Concepts.UsersAndPrivileges.md deleted file mode 100644 index 03b3cdb..0000000 --- a/doc_source/MariaDB.Concepts.UsersAndPrivileges.md +++ /dev/null @@ -1,44 +0,0 @@ -# MariaDB security on Amazon RDS - -Security for MariaDB DB instances is managed at three levels: -+ AWS Identity and Access Management controls who can perform Amazon RDS management actions on DB instances\. When you connect to AWS using IAM credentials, your IAM account must have IAM policies that grant the permissions required to perform Amazon RDS management operations\. For more information, see [Identity and access management for Amazon RDS](UsingWithRDS.IAM.md)\. -+ When you create a DB instance, you use a VPC security group to control which devices and Amazon EC2 instances can open connections to the endpoint and port of the DB instance\. These connections can be made using Secure Socket Layer \(SSL\) and Transport Layer Security \(TLS\)\. In addition, firewall rules at your company can control whether devices running at your company can open connections to the DB instance\. -+ Once a connection has been opened to a MariaDB DB instance, authentication of the login and permissions are applied the same way as in a stand\-alone instance of MariaDB\. Commands such as `CREATE USER`, `RENAME USER`, `GRANT`, `REVOKE`, and `SET PASSWORD` work just as they do in stand\-alone databases, as does directly modifying database schema tables\. - - When you create an Amazon RDS DB instance, the master user has the following default privileges: -+ `alter` -+ `alter routine` -+ `create` -+ `create routine` -+ `create temporary tables` -+ `create user` -+ `create view` -+ `delete` -+ `drop` -+ `event` -+ `execute` -+ `grant option` -+ `index` -+ `insert` -+ `lock tables` -+ `process` -+ `references` -+ `reload` - - This privilege is limited on MariaDB DB instances\. It doesn't grant access to the FLUSH LOGS or FLUSH TABLES WITH READ LOCK operations\. -+ `replication client` -+ `replication slave` -+ `select` -+ `show databases` -+ `show view` -+ `trigger` -+ `update` - -For more information about these privileges, see [User account management](http://mariadb.com/kb/en/mariadb/grant/) in the MariaDB documentation\. - -**Note** -Although you can delete the master user on a DB instance, we don't recommend doing so\. To recreate the master user, use the `ModifyDBInstance` API or the `modify-db-instance` AWS CLI and specify a new master user password with the appropriate parameter\. If the master user does not exist in the instance, the master user is created with the specified password\. - -To provide management services for each DB instance, the `rdsadmin` user is created when the DB instance is created\. Attempting to drop, rename, change the password for, or change privileges for the `rdsadmin` account results in an error\. - -To allow management of the DB instance, the standard `kill` and `kill_query` commands have been restricted\. The Amazon RDS commands `mysql.rds_kill`, `mysql.rds_kill_query`, and `mysql.rds_kill_query_id` are provided for use in MariaDB and also MySQL so that you can end user sessions or queries on DB instances\. \ No newline at end of file diff --git a/doc_source/MariaDB.Concepts.VersionMgmt.md b/doc_source/MariaDB.Concepts.VersionMgmt.md deleted file mode 100644 index 99e455c..0000000 --- a/doc_source/MariaDB.Concepts.VersionMgmt.md +++ /dev/null @@ -1,117 +0,0 @@ -# MariaDB on Amazon RDS versions - -For MariaDB, version numbers are organized as version X\.Y\.Z\. In Amazon RDS terminology, X\.Y denotes the major version, and Z is the minor version number\. For Amazon RDS implementations, a version change is considered major if the major version number changes, for example going from version 10\.5 to 10\.6\. A version change is considered minor if only the minor version number changes, for example going from version 10\.6\.10 to 10\.6\.12\. - -**Topics** -+ [Supported MariaDB minor versions on Amazon RDS](#MariaDB.Concepts.VersionMgmt.Supported) -+ [Supported MariaDB major versions on Amazon RDS](#MariaDB.Concepts.VersionMgmt.ReleaseCalendar) -+ [MariaDB 10\.3 end of life](#MariaDB.Concepts.VersionMgmt.EndOfLife103) -+ [MariaDB 10\.2 end of life](#MariaDB.Concepts.VersionMgmt.EndOfLife102) -+ [Deprecated versions for Amazon RDS for MariaDB](#MariaDB.Concepts.DeprecatedVersions) - -## Supported MariaDB minor versions on Amazon RDS - -Amazon RDS currently supports the following minor versions of MariaDB\. - -**Note** -Dates with only a month and a year are approximate and are updated with an exact date when it’s known\. - - -**** - -| MariaDB engine version | Community release date | RDS release date | RDS end of standard support date | -| --- | --- | --- | --- | -| 10\.6 | -| 10\.6\.12 | 6 February 2023 | 28 February 2023 | February 2024 | -| 10\.6\.11 | 7 November 2022 | 18 November 2022 | November 2023 | -| 10\.6\.10 | 19 September 2022 | 30 September 2022 | September 2023 | -| 10\.6\.8 | 20 May 2022 | 8 July 2022 | September 2023 | -| 10\.5 | -| 10\.5\.19 | 6 February 2023 | 28 February 2023 | February 2024 | -| 10\.5\.18 | 7 November 2022 | 18 November 2022 | November 2023 | -| 10\.5\.17 | 15 August 2022 | 16 September 2022 | September 2023 | -| 10\.5\.16 | 20 May 2022 | 8 July 2022 | September 2023 | -| 10\.4 | -| 10\.4\.28 | 6 February 2023 | 28 February 2023 | February 2024 | -| 10\.4\.27 | 7 November 2022 | 18 November 2022 | November 2023 | -| 10\.4\.26 | 15 August 2022 | 16 September 2022 | September 2023 | -| 10\.4\.25 | 20 May 2022 | 8 July 2022 | September 2023 | -| 10\.3 | -| 10\.3\.38 | 6 February 2023 | 28 February 2023 | October 2023 | -| 10\.3\.37 | 7 November 2022 | 18 November 2022 | October 2023 | -| 10\.3\.36 | 15 August 2022 | 16 September 2022 | September 2023 | -| 10\.3\.35 | 20 May 2022 | 8 July 2022 | September 2023 | - -You can specify any currently supported MariaDB version when creating a new DB instance\. You can specify the major version \(such as MariaDB 10\.5\), and any supported minor version for the specified major version\. If no version is specified, Amazon RDS defaults to a supported version, typically the most recent version\. If a major version is specified but a minor version is not, Amazon RDS defaults to a recent release of the major version you have specified\. To see a list of supported versions, as well as defaults for newly created DB instances, use the [https://docs.aws.amazon.com/cli/latest/reference/rds/describe-db-engine-versions.html](https://docs.aws.amazon.com/cli/latest/reference/rds/describe-db-engine-versions.html) AWS CLI command\. - -For example, to list the supported engine versions for RDS for MariaDB, run the following CLI command: - -``` -aws rds describe-db-engine-versions --engine mariadb --query "*[].{Engine:Engine,EngineVersion:EngineVersion}" --output text -``` - -The default MariaDB version might vary by AWS Region\. To create a DB instance with a specific minor version, specify the minor version during DB instance creation\. You can determine the default minor version for an AWS Region using the following AWS CLI command: - -``` -aws rds describe-db-engine-versions --default-only --engine mariadb --engine-version major-engine-version --region region --query "*[].{Engine:Engine,EngineVersion:EngineVersion}" --output text -``` - -Replace *major\-engine\-version* with the major engine version, and replace *region* with the AWS Region\. For example, the following AWS CLI command returns the default MariaDB minor engine version for the 10\.5 major version and the US West \(Oregon\) AWS Region \(us\-west\-2\): - -``` -aws rds describe-db-engine-versions --default-only --engine mariadb --engine-version 10.5 --region us-west-2 --query "*[].{Engine:Engine,EngineVersion:EngineVersion}" --output text -``` - -## Supported MariaDB major versions on Amazon RDS - -RDS for MariaDB major versions remain available at least until community end of life for the corresponding community version\. You can use the following dates to plan your testing and upgrade cycles\. If Amazon extends support for an RDS for MariaDB version for longer than originally stated, we plan to update this table to reflect the later date\. - -**Note** -Dates with only a month and a year are approximate and are updated with an exact date when it’s known\. - - -**** - -| MariaDB major version | Community release date | RDS release date | Community end of life date | RDS end of standard support date | -| --- | --- | --- | --- | --- | -| MariaDB 10\.6 Current minor version: 10\.6\.12 | 6 July 2021 | 3 February 2022 | 6 July 2026 | July 2026 | -| MariaDB 10\.5 Current minor version: 10\.5\.19 | 24 June 2020 | 21 January 2021 | 24 June 2025 | June 2025 | -| MariaDB 10\.4 Current minor version: 10\.4\.28 | 18 June 2019 | 6 April 2020 | 18 June 2024 | June 2024 | -| MariaDB 10\.3 Current minor version: 10\.3\.38 | 25 May 2018 | 23 October 2018 | 25 May 2023 | 23 October 2023 | -| MariaDB 10\.2 Last minor version: 10\.2\.44 | 23 May 2017 | 5 Jan 2018 | 23 May 2022 | 15 Oct 2022 | - -## MariaDB 10\.3 end of life - -On October 23, 2023, Amazon RDS is starting the end\-of\-life process for MariaDB version 10\.3 using the following schedule, which includes upgrade recommendations\. The end\-of\-life process ends standard support for this version\. We recommend that you upgrade all MariaDB 10\.3 DB instances to MariaDB 10\.6 as soon as possible\. For more information, see [Upgrading the MariaDB DB engine](USER_UpgradeDBInstance.MariaDB.md)\. - - -| Action or recommendation | Dates | -| --- | --- | -| We recommend that you manually upgrade MariaDB 10\.3 DB instances to the version of your choice\. You can upgrade directly to MariaDB version 10\.6\. | Now–October 23, 2023 | -| We recommend that you manually upgrade MariaDB 10\.3 snapshots to the version of your choice\. | Now–October 23, 2023 | -| You can no longer create new MariaDB 10\.3 DB instances\. You can still create read replicas of existing MariaDB 10\.3 DB instances and change them from Single\-AZ deployments to Multi\-AZ deployments\. | August 23, 2023 | -| Amazon RDS starts automatic upgrades of your MariaDB 10\.3 DB instances to version 10\.6\. | October 23, 2023 | -| Amazon RDS starts automatic upgrades to version 10\.6 for any MariaDB 10\.3 DB instances restored from snapshots\. | October 23, 2023 | -| Amazon RDS automatically upgrades any remaining MariaDB 10\.3 DB instances to version 10\.6 whether or not they are in a scheduled maintenance window\. | January 23, 2024 | - -## MariaDB 10\.2 end of life - -On October 15, 2022, Amazon RDS is starting the end\-of\-life process for MariaDB version 10\.2 using the following schedule, which includes upgrade recommendations\. The end\-of\-life process ends standard support for this version\. We recommend that you upgrade all MariaDB 10\.2 DB instances to MariaDB 10\.3 or higher as soon as possible\. For more information, see [Upgrading the MariaDB DB engine](USER_UpgradeDBInstance.MariaDB.md)\. - - -| Action or recommendation | Dates | -| --- | --- | -| We recommend that you upgrade MariaDB 10\.2 DB instances manually to the version of your choice\. You can upgrade directly to MariaDB version 10\.3 or 10\.6\. | Now–October 15, 2022 | -| We recommend that you upgrade MariaDB 10\.2 snapshots manually to the version of your choice\. | Now–October 15, 2022 | -| You can no longer create new MariaDB 10\.2 DB instances\. You can still create read replicas of existing MariaDB 10\.2 DB instances and change them from Single\-AZ deployments to Multi\-AZ deployments\. | July 15, 2022 | -| Amazon RDS starts automatic upgrades of your MariaDB 10\.2 DB instances to version 10\.3\. | October 15, 2022 | -| Amazon RDS starts automatic upgrades to version 10\.3 for any MariaDB 10\.2 DB instances restored from snapshots\. | October 15, 2022 | -| Amazon RDS automatically upgrades any remaining MariaDB 10\.2 DB instances to version 10\.3 whether or not they are in a scheduled maintenance window\. | January 15, 2023 | - -For more information about Amazon RDS for MariaDB 10\.2 end of life, see [ Announcement: Amazon Relational Database Service \(Amazon RDS\) for MariaDB 10\.2 End\-of\-Life date is October 15, 2022](https://repost.aws/questions/QUPGswEbHrT0m4tNgAVNmssw/announcement-amazon-relational-database-service-amazon-rds-for-maria-db-10-2-end-of-life-date-is-october-15-2022)\. - -## Deprecated versions for Amazon RDS for MariaDB - -Amazon RDS for MariaDB version 10\.0, 10\.1, and 10\.2 are deprecated\. - -For information about the Amazon RDS deprecation policy for MariaDB, see [Amazon RDS FAQs](http://aws.amazon.com/rds/faqs/)\. \ No newline at end of file diff --git a/doc_source/MariaDB.Procedural.Importing.md b/doc_source/MariaDB.Procedural.Importing.md deleted file mode 100644 index 58876f8..0000000 --- a/doc_source/MariaDB.Procedural.Importing.md +++ /dev/null @@ -1,19 +0,0 @@ -# Importing data into a MariaDB DB instance - -You can use several different techniques to import data into an RDS for MariaDB DB instance\. The best approach depends on the source of the data, the amount of data, and whether the import is done one time or is ongoing\. If you are migrating an application along with the data, also consider the amount of downtime that you are willing to experience\. - -Find techniques to import data into an RDS for MariaDB DB instance in the following table\. - - -**** - -| Source | Amount of data | One time or ongoing | Application downtime | Technique | More information | -| --- | --- | --- | --- | --- | --- | -| Existing MariaDB DB instance | Any | One time or ongoing | Minimal | Create a read replica for ongoing replication\. Promote the read replica for one\-time creation of a new DB instance\. | [Working with DB instance read replicas](USER_ReadRepl.md) | -| Existing MariaDB or MySQL database | Small | One time | Some | Copy the data directly to your MySQL DB instance using a command\-line utility\. | [Importing data from a MariaDB or MySQL database to a MariaDB or MySQL DB instance](MySQL.Procedural.Importing.SmallExistingMariaDB.md) | -| Data not stored in an existing database | Medium | One time | Some | Create flat files and import them using the mysqlimport utility\. | [Importing data from any source to a MariaDB or MySQL DB instance](MySQL.Procedural.Importing.AnySourceMariaDB.md) | -| Existing MariaDB or MySQL database on premises or on Amazon EC2 | Any | Ongoing | Minimal | Configure replication with an existing MariaDB or MySQL database as the replication source\. You can configure replication into a MariaDB DB instance using MariaDB global transaction identifiers \(GTIDs\) when the external instance is MariaDB version 10\.0\.24 or higher, or using binary log coordinates for MySQL instances or MariaDB instances on earlier versions than 10\.0\.24\. MariaDB GTIDs are implemented differently than MySQL GTIDs, which aren't supported by Amazon RDS\. | [Configuring binary log file position replication with an external source instance](MySQL.Procedural.Importing.External.ReplMariaDB.md) [Importing data to an Amazon RDS MariaDB or MySQL DB instance with reduced downtime](MySQL.Procedural.Importing.NonRDSReplMariaDB.md) | -| Any existing database | Any | One time or ongoing | Minimal | Use AWS Database Migration Service to migrate the database with minimal downtime and, for many database DB engines, continue ongoing replication\. | [What is AWS Database Migration Service](https://docs.aws.amazon.com/dms/latest/userguide/Welcome.html) and [Using a MySQL\-compatible database as a target for AWS DMS](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Target.MySQL.html) in the AWS Database Migration Service User Guide | - -**Note** -The mysql system database contains authentication and authorization information required to log into your DB instance and access your data\. Dropping, altering, renaming, or truncating tables, data, or other contents of the mysql database in your DB instance can result in errors and might render the DB instance and your data inaccessible\. If this occurs, the DB instance can be restored from a snapshot using the AWS CLI [https://docs.aws.amazon.com/cli/latest/reference/rds/restore-db-instance-from-db-snapshot.html](https://docs.aws.amazon.com/cli/latest/reference/rds/restore-db-instance-from-db-snapshot.html) or recovered using [https://docs.aws.amazon.com/cli/latest/reference/rds/restore-db-instance-to-point-in-time.html](https://docs.aws.amazon.com/cli/latest/reference/rds/restore-db-instance-to-point-in-time.html) commands\. \ No newline at end of file diff --git a/doc_source/MariaDB.Procedural.Replication.GTID.md b/doc_source/MariaDB.Procedural.Replication.GTID.md deleted file mode 100644 index 18c27cc..0000000 --- a/doc_source/MariaDB.Procedural.Replication.GTID.md +++ /dev/null @@ -1,109 +0,0 @@ -# Configuring GTID\-based replication with an external source instance - -You can set up replication based on global transaction identifiers \(GTIDs\) from an external MariaDB instance of version 10\.0\.24 or higher into an RDS for MariaDB DB instance\. Follow these guidelines when you set up an external source instance and a replica on Amazon RDS: -+ Monitor failover events for the RDS for MariaDB DB instance that is your replica\. If a failover occurs, then the DB instance that is your replica might be recreated on a new host with a different network address\. For information on how to monitor failover events, see [Working with Amazon RDS event notification](USER_Events.md)\. -+ Maintain the binary logs \(binlogs\) on your source instance until you have verified that they have been applied to the replica\. This maintenance ensures that you can restore your source instance in the event of a failure\. -+ Turn on automated backups on your MariaDB DB instance on Amazon RDS\. Turning on automated backups ensures that you can restore your replica to a particular point in time if you need to resynchronize your source instance and replica\. For information on backups and Point\-In\-Time Restore, see [Backing up and restoring](CHAP_CommonTasks.BackupRestore.md)\. - -**Note** -The permissions required to start replication on a MariaDB DB instance are restricted and not available to your Amazon RDS master user\. Because of this, you must use the Amazon RDS [mysql\.rds\_set\_external\_master\_gtid](mysql_rds_set_external_master_gtid.md) and [mysql\.rds\_start\_replication](mysql-stored-proc-replicating.md#mysql_rds_start_replication) commands to set up replication between your live database and your RDS for MariaDB database\. - -To start replication between an external source instance and a MariaDB DB instance on Amazon RDS, use the following procedure\. - -**To start replication** - -1. Make the source MariaDB instance read\-only: - - ``` - mysql> FLUSH TABLES WITH READ LOCK; - mysql> SET GLOBAL read_only = ON; - ``` - -1. Get the current GTID of the external MariaDB instance\. You can do this by using `mysql` or the query editor of your choice to run `SELECT @@gtid_current_pos;`\. - - The GTID is formatted as `--`\. A typical GTID looks something like **0\-1234510749\-1728**\. For more information about GTIDs and their component parts, see [Global transaction ID](http://mariadb.com/kb/en/mariadb/global-transaction-id/) in the MariaDB documentation\. - -1. Copy the database from the external MariaDB instance to the MariaDB DB instance using `mysqldump`\. For very large databases, you might want to use the procedure in [Importing data to an Amazon RDS MariaDB or MySQL database with reduced downtime](MySQL.Procedural.Importing.NonRDSRepl.md)\. - - For Linux, macOS, or Unix: - - ``` - mysqldump \ - --databases database_name \ - --single-transaction \ - --compress \ - --order-by-primary \ - -u local_user \ - -plocal_password | mysql \ - --host=hostname \ - --port=3306 \ - -u RDS_user_name \ - -pRDS_password - ``` - - For Windows: - - ``` - mysqldump ^ - --databases database_name ^ - --single-transaction ^ - --compress ^ - --order-by-primary \ - -u local_user \ - -plocal_password | mysql ^ - --host=hostname ^ - --port=3306 ^ - -u RDS_user_name ^ - -pRDS_password - ``` -**Note** -Make sure that there isn't a space between the `-p` option and the entered password\. - - Use the `--host`, `--user (-u)`, `--port` and `-p` options in the `mysql` command to specify the host name, user name, port, and password to connect to your MariaDB DB instance\. The host name is the DNS name from the MariaDB DB instance endpoint, for example `myinstance.123456789012.us-east-1.rds.amazonaws.com`\. You can find the endpoint value in the instance details in the Amazon RDS Management Console\. - -1. Make the source MariaDB instance writeable again\. - - ``` - mysql> SET GLOBAL read_only = OFF; - mysql> UNLOCK TABLES; - ``` - -1. In the Amazon RDS Management Console, add the IP address of the server that hosts the external MariaDB database to the VPC security group for the MariaDB DB instance\. For more information on modifying a VPC security group, go to [Security groups for your VPC](https://docs.aws.amazon.com/vpc/latest/userguide/VPC_SecurityGroups.html) in the *Amazon Virtual Private Cloud User Guide*\. - - The IP address can change when the following conditions are met: - + You are using a public IP address for communication between the external source instance and the DB instance\. - + The external source instance was stopped and restarted\. - - If these conditions are met, verify the IP address before adding it\. - - You might also need to configure your local network to permit connections from the IP address of your MariaDB DB instance, so that it can communicate with your external MariaDB instance\. To find the IP address of the MariaDB DB instance, use the `host` command\. - - ``` - host db_instance_endpoint - ``` - - The host name is the DNS name from the MariaDB DB instance endpoint\. - -1. Using the client of your choice, connect to the external MariaDB instance and create a MariaDB user to be used for replication\. This account is used solely for replication and must be restricted to your domain to improve security\. The following is an example\. - - ``` - CREATE USER 'repl_user'@'mydomain.com' IDENTIFIED BY 'password'; - ``` - -1. For the external MariaDB instance, grant `REPLICATION CLIENT` and `REPLICATION SLAVE` privileges to your replication user\. For example, to grant the `REPLICATION CLIENT` and `REPLICATION SLAVE` privileges on all databases for the '`repl_user`' user for your domain, issue the following command\. - - ``` - GRANT REPLICATION CLIENT, REPLICATION SLAVE ON *.* TO 'repl_user'@'mydomain.com'; - ``` - -1. Make the MariaDB DB instance the replica\. Connect to the MariaDB DB instance as the master user and identify the external MariaDB database as the replication source instance by using the [mysql\.rds\_set\_external\_master\_gtid](mysql_rds_set_external_master_gtid.md) command\. Use the GTID that you determined in Step 2\. The following is an example\. - - ``` - CALL mysql.rds_set_external_master_gtid ('mymasterserver.mydomain.com', 3306, 'repl_user', 'password', 'GTID', 0); - ``` - -1. On the MariaDB DB instance, issue the [mysql\.rds\_start\_replication](mysql-stored-proc-replicating.md#mysql_rds_start_replication) command to start replication\. - - ``` - CALL mysql.rds_start_replication; - ``` \ No newline at end of file diff --git a/doc_source/MonitoringOverview.md b/doc_source/MonitoringOverview.md deleted file mode 100644 index e55abbd..0000000 --- a/doc_source/MonitoringOverview.md +++ /dev/null @@ -1,112 +0,0 @@ -# Overview of monitoring metrics in Amazon RDS - -Monitoring is an important part of maintaining the reliability, availability, and performance of Amazon RDS and your AWS solutions\. To more easily debug multi\-point failures, we recommend that you collect monitoring data from all parts of your AWS solution\. - -**Topics** -+ [Monitoring plan](#MonitoringOverview.plan) -+ [Performance baseline](#MonitoringOverview.baseline) -+ [Performance guidelines](#MonitoringOverview.guidelines) -+ [Monitoring tools](#MonitoringOverview.tools) - -## Monitoring plan - -Before you start monitoring Amazon RDS, create a monitoring plan\. This plan should answer the following questions: -+ What are your monitoring goals? -+ Which resources will you monitor? -+ How often will you monitor these resources? -+ Which monitoring tools will you use? -+ Who will perform the monitoring tasks? -+ Whom should be notified when something goes wrong? - -## Performance baseline - -To achieve your monitoring goals, you need to establish a baseline\. To do this, measure performance under different load conditions at various times in your Amazon RDS environment\. You can monitor metrics such as the following: -+ Network throughput -+ Client connections -+ I/O for read, write, or metadata operations -+ Burst credit balances for your DB instances - -We recommend that you store historical performance data for Amazon RDS\. Using the stored data, you can compare current performance against past trends\. You can also distinguish normal performance patterns from anomalies, and devise techniques to address issues\. - -## Performance guidelines - -In general, acceptable values for performance metrics depend on what your application is doing relative to your baseline\. Investigate consistent or trending variances from your baseline\. The following metrics are often the source of performance issues: -+ **High CPU or RAM consumption** – High values for CPU or RAM consumption might be appropriate, if they're in keeping with your goals for your application \(like throughput or concurrency\) and are expected\. -+ **Disk space consumption** – Investigate disk space consumption if space used is consistently at or above 85 percent of the total disk space\. See if it is possible to delete data from the instance or archive data to a different system to free up space\. -+ **Network traffic** – For network traffic, talk with your system administrator to understand what expected throughput is for your domain network and internet connection\. Investigate network traffic if throughput is consistently lower than expected\. -+ **Database connections** – If you see high numbers of user connections and also decreases in instance performance and response time, consider constraining database connections\. The best number of user connections for your DB instance varies based on your instance class and the complexity of the operations being performed\. To determine the number of database connections, associate your DB instance with a parameter group where the `User Connections` parameter is set to a value other than 0 \(unlimited\)\. You can either use an existing parameter group or create a new one\. For more information, see [Working with parameter groups](USER_WorkingWithParamGroups.md)\. -+ **IOPS metrics** – The expected values for IOPS metrics depend on disk specification and server configuration, so use your baseline to know what is typical\. Investigate if values are consistently different than your baseline\. For best IOPS performance, make sure that your typical working set fits into memory to minimize read and write operations\. - -When performance falls outside your established baseline, you might need to make changes to optimize your database availability for your workload\. For example, you might need to change the instance class of your DB instance\. Or you might need to change the number of DB instances and read replicas that are available for clients\. - -## Monitoring tools - -Monitoring is an important part of maintaining the reliability, availability, and performance of Amazon RDS and your other AWS solutions\. AWS provides various monitoring tools to watch Amazon RDS, report when something is wrong, and take automatic actions when appropriate\. - -**Topics** -+ [Automated monitoring tools](#MonitoringOverview.tools.automated) -+ [Manual monitoring tools](#monitoring_manual_tools) - -### Automated monitoring tools - -We recommend that you automate monitoring tasks as much as possible\. - -**Topics** -+ [Amazon RDS instance status and recommendations](#MonitoringOverview.tools.automated.rds) -+ [Amazon CloudWatch metrics for Amazon RDS](#MonitoringOverview.tools.automated.integrated) -+ [Amazon RDS Performance Insights and operating\-system monitoring](#MonitoringOverview.tools.automated.metrics.rds) -+ [Integrated services](#MonitoringOverview.tools.automated.integrated.events-logs-streams) - -#### Amazon RDS instance status and recommendations - -You can use the following automated tools to watch Amazon RDS and report when something is wrong: -+ **Amazon RDS instance status** — View details about the current status of your instance by using the Amazon RDS console, the AWS CLI, or the RDS API\. -+ **Amazon RDS recommendations** — Respond to automated recommendations for database resources, such as DB instances, read replicas, and DB parameter groups\. For more information, see [Viewing Amazon RDS recommendations](accessing-monitoring.md#USER_Recommendations)\. - -#### Amazon CloudWatch metrics for Amazon RDS - -Amazon RDS integrates with Amazon CloudWatch for additional monitoring capabilities\. -+ **Amazon CloudWatch** – This service monitors your AWS resources and the applications you run on AWS in real time\. You can use the following Amazon CloudWatch features with Amazon RDS: - + **Amazon CloudWatch metrics** – Amazon RDS automatically sends metrics to CloudWatch every minute for each active database\. You don't get additional charges for Amazon RDS metrics in CloudWatch\. For more information, see [Monitoring Amazon RDS metrics with Amazon CloudWatch](monitoring-cloudwatch.md)\. - + **Amazon CloudWatch alarms** – You can watch a single Amazon RDS metric over a specific time period\. You can then perform one or more actions based on the value of the metric relative to a threshold that you set\. For more information, see [Monitoring Amazon RDS metrics with Amazon CloudWatch](monitoring-cloudwatch.md)\. - -#### Amazon RDS Performance Insights and operating\-system monitoring - -You can use the following automated tools to monitor Amazon RDS performance: -+ **Amazon RDS Performance Insights** – Assess the load on your database, and determine when and where to take action\. For more information, see [Monitoring DB load with Performance Insights on Amazon RDS](USER_PerfInsights.md)\. -+ **Amazon RDS Enhanced Monitoring** – Look at metrics in real time for the operating system\. For more information, see [Monitoring OS metrics with Enhanced Monitoring](USER_Monitoring.OS.md)\. - -#### Integrated services - -The following AWS services are integrated with Amazon RDS: -+ *Amazon EventBridge* is a serverless event bus service that makes it easy to connect your applications with data from a variety of sources\. For more information, see [Monitoring Amazon RDS events](working-with-events.md)\. -+ *Amazon CloudWatch Logs* lets you monitor, store, and access your log files from Amazon RDS instances, CloudTrail, and other sources\. For more information, see [Monitoring Amazon RDS log files](USER_LogAccess.md)\. -+ *AWS CloudTrail* captures API calls and related events made by or on behalf of your AWS account and delivers the log files to an Amazon S3 bucket that you specify\. For more information, see [Monitoring Amazon RDS API calls in AWS CloudTrail](logging-using-cloudtrail.md)\. -+ *Database Activity Streams* is an Amazon RDS feature that provides a near\-real\-time stream of the activity in your Oracle DB instance\. For more information, see [Monitoring Amazon RDS with Database Activity Streams](DBActivityStreams.md)\. - -### Manual monitoring tools - -You need to manually monitor those items that the CloudWatch alarms don't cover\. The Amazon RDS, CloudWatch, AWS Trusted Advisor and other AWS console dashboards provide an at\-a\-glance view of the state of your AWS environment\. We recommend that you also check the log files on your DB instance\. -+ From the Amazon RDS console, you can monitor the following items for your resources: - + The number of connections to a DB instance - + The amount of read and write operations to a DB instance - + The amount of storage that a DB instance is currently using - + The amount of memory and CPU being used for a DB instance - + The amount of network traffic to and from a DB instance -+ From the Trusted Advisor dashboard, you can review the following cost optimization, security, fault tolerance, and performance improvement checks: - + Amazon RDS Idle DB Instances - + Amazon RDS Security Group Access Risk - + Amazon RDS Backups - + Amazon RDS Multi\-AZ - - For more information on these checks, see [Trusted Advisor best practices \(checks\)](https://aws.amazon.com/premiumsupport/trustedadvisor/best-practices/)\. -+ CloudWatch home page shows: - + Current alarms and status - + Graphs of alarms and resources - + Service health status - - In addition, you can use CloudWatch to do the following: - + Create [customized dashboards](https://docs.aws.amazon.com/AmazonCloudWatch/latest/DeveloperGuide/CloudWatch_Dashboards.html) to monitor the services that you care about\. - + Graph metric data to troubleshoot issues and discover trends\. - + Search and browse all your AWS resource metrics\. - + Create and edit alarms to be notified of problems\. \ No newline at end of file diff --git a/doc_source/MySQL.Concepts.FeatureSupport.md b/doc_source/MySQL.Concepts.FeatureSupport.md deleted file mode 100644 index 73ca6cf..0000000 --- a/doc_source/MySQL.Concepts.FeatureSupport.md +++ /dev/null @@ -1,78 +0,0 @@ -# MySQL feature support on Amazon RDS - -RDS for MySQL supports most of the features and capabilities of MySQL\. Some features might have limited support or restricted privileges\. - -You can filter new Amazon RDS features on the [What's New with Database?](http://aws.amazon.com/about-aws/whats-new/database/) page\. For **Products**, choose **Amazon RDS**\. Then search using keywords such as **MySQL 2022**\. - -**Note** -The following lists are not exhaustive\. - -**Topics** -+ [Supported storage engines for RDS for MySQL](#MySQL.Concepts.Storage) -+ [Using memcached and other options with MySQL on Amazon RDS](#MySQL.Concepts.General.Options) -+ [InnoDB cache warming for MySQL on Amazon RDS](#MySQL.Concepts.InnoDBCacheWarming) -+ [MySQL features not supported by Amazon RDS](#MySQL.Concepts.Features) - -## Supported storage engines for RDS for MySQL - -While MySQL supports multiple storage engines with varying capabilities, not all of them are optimized for recovery and data durability\. Amazon RDS fully supports the InnoDB storage engine for MySQL DB instances\. Amazon RDS features such as Point\-In\-Time restore and snapshot restore require a recoverable storage engine and are supported for the InnoDB storage engine only\. For more information, see [MySQL memcached support](Appendix.MySQL.Options.memcached.md)\. - -The Federated Storage Engine is currently not supported by Amazon RDS for MySQL\. - -For user\-created schemas, the MyISAM storage engine does not support reliable recovery and can result in lost or corrupt data when MySQL is restarted after a recovery, preventing Point\-In\-Time restore or snapshot restore from working as intended\. However, if you still choose to use MyISAM with Amazon RDS, snapshots can be helpful under some conditions\. - -**Note** -System tables in the `mysql` schema can be in MyISAM storage\. - -If you want to convert existing MyISAM tables to InnoDB tables, you can use the `ALTER TABLE` command \(for example, `alter table TABLE_NAME engine=innodb;`\)\. Bear in mind that MyISAM and InnoDB have different strengths and weaknesses, so you should fully evaluate the impact of making this switch on your applications before doing so\. - -MySQL 5\.1, 5\.5, and 5\.6 are no longer supported in Amazon RDS\. However, you can restore existing MySQL 5\.1, 5\.5, and 5\.6 snapshots\. When you restore a MySQL 5\.1, 5\.5, or 5\.6 snapshot, the DB instance is automatically upgraded to MySQL 5\.7\. - -## Using memcached and other options with MySQL on Amazon RDS - -Most Amazon RDS DB engines support option groups that allow you to select additional features for your DB instance\. RDS for MySQL DB instances support the `memcached` option, a simple, key\-based cache\. For more information about `memcached` and other options, see [Options for MySQL DB instances](Appendix.MySQL.Options.md)\. For more information about working with option groups, see [Working with option groups](USER_WorkingWithOptionGroups.md)\. - -## InnoDB cache warming for MySQL on Amazon RDS - -InnoDB cache warming can provide performance gains for your MySQL DB instance by saving the current state of the buffer pool when the DB instance is shut down, and then reloading the buffer pool from the saved information when the DB instance starts up\. This bypasses the need for the buffer pool to "warm up" from normal database use and instead preloads the buffer pool with the pages for known common queries\. The file that stores the saved buffer pool information only stores metadata for the pages that are in the buffer pool, and not the pages themselves\. As a result, the file does not require much storage space\. The file size is about 0\.2 percent of the cache size\. For example, for a 64 GiB cache, the cache warming file size is 128 MiB\. For more information on InnoDB cache warming, see [Saving and restoring the buffer pool state](https://dev.mysql.com/doc/refman/8.0/en/innodb-preload-buffer-pool.html) in the MySQL documentation\. - -RDS for MySQL DB instances support InnoDB cache warming\. To enable InnoDB cache warming, set the `innodb_buffer_pool_dump_at_shutdown` and `innodb_buffer_pool_load_at_startup` parameters to 1 in the parameter group for your DB instance\. Changing these parameter values in a parameter group will affect all MySQL DB instances that use that parameter group\. To enable InnoDB cache warming for specific MySQL DB instances, you might need to create a new parameter group for those instances\. For information on parameter groups, see [Working with parameter groups](USER_WorkingWithParamGroups.md)\. - -InnoDB cache warming primarily provides a performance benefit for DB instances that use standard storage\. If you use PIOPS storage, you do not commonly see a significant performance benefit\. - -**Important** -If your MySQL DB instance does not shut down normally, such as during a failover, then the buffer pool state will not be saved to disk\. In this case, MySQL loads whatever buffer pool file is available when the DB instance is restarted\. No harm is done, but the restored buffer pool might not reflect the most recent state of the buffer pool prior to the restart\. To ensure that you have a recent state of the buffer pool available to warm the InnoDB cache on startup, we recommend that you periodically dump the buffer pool "on demand\." -You can create an event to dump the buffer pool automatically and on a regular interval\. For example, the following statement creates an event named `periodic_buffer_pool_dump` that dumps the buffer pool every hour\. - -``` -1. CREATE EVENT periodic_buffer_pool_dump -2. ON SCHEDULE EVERY 1 HOUR -3. DO CALL mysql.rds_innodb_buffer_pool_dump_now(); -``` -For more information on MySQL events, see [Event syntax](https://dev.mysql.com/doc/refman/8.0/en/events-syntax.html) in the MySQL documentation\. - -### Dumping and loading the buffer pool on demand - -You can save and load the InnoDB cache "on demand\." -+ To dump the current state of the buffer pool to disk, call the [mysql\.rds\_innodb\_buffer\_pool\_dump\_now](mysql-stored-proc-warming.md#mysql_rds_innodb_buffer_pool_dump_now) stored procedure\. -+ To load the saved state of the buffer pool from disk, call the [mysql\.rds\_innodb\_buffer\_pool\_load\_now](mysql-stored-proc-warming.md#mysql_rds_innodb_buffer_pool_load_now) stored procedure\. -+ To cancel a load operation in progress, call the [mysql\.rds\_innodb\_buffer\_pool\_load\_abort](mysql-stored-proc-warming.md#mysql_rds_innodb_buffer_pool_load_abort) stored procedure\. - -## MySQL features not supported by Amazon RDS - -Amazon RDS doesn't currently support the following MySQL features: -+ Authentication Plugin -+ Error Logging to the System Log -+ Group Replication Plugin -+ InnoDB Tablespace Encryption -+ Password Strength Plugin -+ Persisted system variables -+ Rewriter Query Rewrite Plugin -+ Semisynchronous replication -+ Transportable tablespace -+ X Plugin - -**Note** -Global transaction IDs are supported for all RDS for MySQL 5\.7 versions, and for RDS for MySQL 8\.0\.26 and higher 8\.0 versions\. - -To deliver a managed service experience, Amazon RDS doesn't provide shell access to DB instances\. It also restricts access to certain system procedures and tables that require advanced privileges\. Amazon RDS supports access to databases on a DB instance using any standard SQL client application\. Amazon RDS doesn't allow direct host access to a DB instance by using Telnet, Secure Shell \(SSH\), or Windows Remote Desktop Connection\. When you create a DB instance, you are assigned to the *db\_owner* role for all databases on that instance, and you have all database\-level permissions except for those used for backups\. Amazon RDS manages backups for you\. \ No newline at end of file diff --git a/doc_source/MySQL.Concepts.LocalTimeZone.md b/doc_source/MySQL.Concepts.LocalTimeZone.md deleted file mode 100644 index 42f57fe..0000000 --- a/doc_source/MySQL.Concepts.LocalTimeZone.md +++ /dev/null @@ -1,66 +0,0 @@ -# Local time zone for MySQL DB instances - -By default, the time zone for a MySQL DB instance is Universal Time Coordinated \(UTC\)\. You can set the time zone for your DB instance to the local time zone for your application instead\. - -To set the local time zone for a DB instance, set the `time_zone` parameter in the parameter group for your DB instance to one of the supported values listed later in this section\. When you set the `time_zone` parameter for a parameter group, all DB instances and read replicas that are using that parameter group change to use the new local time zone\. For information on setting parameters in a parameter group, see [Working with parameter groups](USER_WorkingWithParamGroups.md)\. - -After you set the local time zone, all new connections to the database reflect the change\. If you have any open connections to your database when you change the local time zone, you won't see the local time zone update until after you close the connection and open a new connection\. - -You can set a different local time zone for a DB instance and one or more of its read replicas\. To do this, use a different parameter group for the DB instance and the replica or replicas and set the `time_zone` parameter in each parameter group to a different local time zone\. - -If you are replicating across AWS Regions, then the source DB instance and the read replica use different parameter groups \(parameter groups are unique to an AWS Region\)\. To use the same local time zone for each instance, you must set the `time_zone` parameter in the instance's and read replica's parameter groups\. - -When you restore a DB instance from a DB snapshot, the local time zone is set to UTC\. You can update the time zone to your local time zone after the restore is complete\. If you restore a DB instance to a point in time, then the local time zone for the restored DB instance is the time zone setting from the parameter group of the restored DB instance\. - -The Internet Assigned Numbers Authority \(IANA\) publishes new time zones at [ https://www\.iana\.org/time\-zones](https://www.iana.org/time-zones) several times a year\. Every time RDS releases a new minor maintenance release of MySQL, it ships with the latest time zone data at the time of the release\. When you use the latest RDS for MySQL versions, you have recent time zone data from RDS\. To ensure that your DB instance has recent time zone data, we recommend upgrading to a higher DB engine version\. Alternatively, you can modify the time zone tables in MariaDB DB instances manually\. To do so, you can use SQL commands or run the [mysql\_tzinfo\_to\_sql tool](https://dev.mysql.com/doc/refman/8.0/en/mysql-tzinfo-to-sql.html) in a SQL client\. After updating the time zone data manually, reboot your DB instance so that the changes take effect\. RDS doesn't modify or reset the time zone data of running DB instances\. New time zone data is installed only when you perform a database engine version upgrade\. - -You can set your local time zone to one of the following values\. - - -**** - -| | | -| --- |--- | -| `Africa/Cairo` | `Asia/Riyadh` | -| `Africa/Casablanca` | `Asia/Seoul` | -| `Africa/Harare` | `Asia/Shanghai` | -| `Africa/Monrovia` | `Asia/Singapore` | -| `Africa/Nairobi` | `Asia/Taipei` | -| `Africa/Tripoli` | `Asia/Tehran` | -| `Africa/Windhoek` | `Asia/Tokyo` | -| `America/Araguaina` | `Asia/Ulaanbaatar` | -| `America/Asuncion` | `Asia/Vladivostok` | -| `America/Bogota` | `Asia/Yakutsk` | -| `America/Buenos_Aires` | `Asia/Yerevan` | -| `America/Caracas` | `Atlantic/Azores` | -| `America/Chihuahua` | `Australia/Adelaide` | -| `America/Cuiaba` | `Australia/Brisbane` | -| `America/Denver` | `Australia/Darwin` | -| `America/Fortaleza` | `Australia/Hobart` | -| `America/Guatemala` | `Australia/Perth` | -| `America/Halifax` | `Australia/Sydney` | -| `America/Manaus` | `Brazil/East` | -| `America/Matamoros` | `Canada/Newfoundland` | -| `America/Monterrey` | `Canada/Saskatchewan` | -| `America/Montevideo` | `Canada/Yukon` | -| `America/Phoenix` | `Europe/Amsterdam` | -| `America/Santiago` | `Europe/Athens` | -| `America/Tijuana` | `Europe/Dublin` | -| `Asia/Amman` | `Europe/Helsinki` | -| `Asia/Ashgabat` | `Europe/Istanbul` | -| `Asia/Baghdad` | `Europe/Kaliningrad` | -| `Asia/Baku` | `Europe/Moscow` | -| `Asia/Bangkok` | `Europe/Paris` | -| `Asia/Beirut` | `Europe/Prague` | -| `Asia/Calcutta` | `Europe/Sarajevo` | -| `Asia/Damascus` | `Pacific/Auckland` | -| `Asia/Dhaka` | `Pacific/Fiji` | -| `Asia/Irkutsk` | `Pacific/Guam` | -| `Asia/Jerusalem` | `Pacific/Honolulu` | -| `Asia/Kabul` | `Pacific/Samoa` | -| `Asia/Karachi` | `US/Alaska` | -| `Asia/Kathmandu` | `US/Central` | -| `Asia/Krasnoyarsk` | `US/Eastern` | -| `Asia/Magadan` | `US/East-Indiana` | -| `Asia/Muscat` | `US/Pacific` | -| `Asia/Novosibirsk` | `UTC` | \ No newline at end of file diff --git a/doc_source/MySQL.Concepts.PasswordValidationPlugin.md b/doc_source/MySQL.Concepts.PasswordValidationPlugin.md deleted file mode 100644 index 37754b8..0000000 --- a/doc_source/MySQL.Concepts.PasswordValidationPlugin.md +++ /dev/null @@ -1,27 +0,0 @@ -# Using the Password Validation Plugin for RDS for MySQL - -MySQL provides the `validate_password` plugin for improved security\. The plugin enforces password policies using parameters in the DB parameter group for your MySQL DB instance\. The plugin is supported for DB instances running MySQL version 5\.7 and 8\.0\. For more information about the `validate_password` plugin, see [The Password Validation Plugin](https://dev.mysql.com/doc/refman/8.0/en/validate-password.html) in the MySQL documentation\. - -**To enable the validate\_password plugin for a MySQL DB instance** - -1. Connect to your MySQL DB instance and run the following command\. - - ``` - INSTALL PLUGIN validate_password SONAME 'validate_password.so'; - ``` - -1. Configure the parameters for the plugin in the DB parameter group used by the DB instance\. - - For more information about the parameters, see [Password Validation Plugin options and variables](https://dev.mysql.com/doc/refman/8.0/en/validate-password-options-variables.html) in the MySQL documentation\. - - For more information about modifying DB instance parameters, see [Modifying parameters in a DB parameter group](USER_WorkingWithDBInstanceParamGroups.md#USER_WorkingWithParamGroups.Modifying)\. - -After installing and enabling the `password_validate` plugin, reset existing passwords to comply with your new validation policies\. - -Amazon RDS doesn't validate passwords\. The MySQL DB instance performs password validation\. If you set a user password with the AWS Management Console, the `modify-db-instance` AWS CLI command, or the `ModifyDBInstance` RDS API operation, the change can succeed even if the new password doesn't satisfy your password policies\. However, a new password is set in the MySQL DB instance only if it satisfies the password policies\. In this case, Amazon RDS records the following event\. - -``` -"RDS-EVENT-0067" - An attempt to reset the master password for the DB instance has failed. -``` - -For more information about Amazon RDS events, see [Working with Amazon RDS event notification](USER_Events.md)\. \ No newline at end of file diff --git a/doc_source/MySQL.Concepts.VersionMgmt.md b/doc_source/MySQL.Concepts.VersionMgmt.md deleted file mode 100644 index 7295b72..0000000 --- a/doc_source/MySQL.Concepts.VersionMgmt.md +++ /dev/null @@ -1,84 +0,0 @@ -# MySQL on Amazon RDS versions - -For MySQL, version numbers are organized as version = X\.Y\.Z\. In Amazon RDS terminology, X\.Y denotes the major version, and Z is the minor version number\. For Amazon RDS implementations, a version change is considered major if the major version number changes—for example, going from version 5\.7 to 8\.0\. A version change is considered minor if only the minor version number changes—for example, going from version 8\.0\.28 to 8\.0\.32\. - -**Topics** -+ [Supported MySQL minor versions on Amazon RDS](#MySQL.Concepts.VersionMgmt.Supported) -+ [Supported MySQL major versions on Amazon RDS](#MySQL.Concepts.VersionMgmt.ReleaseCalendar) -+ [Deprecated versions for Amazon RDS for MySQL](#MySQL.Concepts.DeprecatedVersions) - -## Supported MySQL minor versions on Amazon RDS - -Amazon RDS currently supports the following minor versions of MySQL\. - -**Note** -Dates with only a month and a year are approximate and are updated with an exact date when it’s known\. - - -**** - -| MySQL engine version | Community release date | RDS release date | RDS end of standard support date | -| --- | --- | --- | --- | -| 8\.0 | -| 8\.0\.32 | 17 January 2023 | 7 February 2023 | March 2024 | -| 8\.0\.31 | 11 October 2022 | 10 November 2022 | March 2024 | -| 8\.0\.30 | 26 July 2022 | 9 September 2022 | September 2023 | -| 8\.0\.28 | 18 January 2022 | 11 March 2022 | March 2024 | -| 5\.7 | -| 5\.7\.41 | 17 January 2023 | 7 February 2023 | October 2023 | -| 5\.7\.40 | 11 October 2022 | 11 November 2022 | October 2023 | -| 5\.7\.39 | 26 July 2022 | 29 September 2022 | September 2023 | -| 5\.7\.38 | 26 April 2022 | 6 June 2022 | September 2023 | -| 5\.7\.37 | 18 January 2022 | 11 March 2022 | September 2023 | - -You can specify any currently supported MySQL version when creating a new DB instance\. You can specify the major version \(such as MySQL 5\.7\), and any supported minor version for the specified major version\. If no version is specified, Amazon RDS defaults to a supported version, typically the most recent version\. If a major version is specified but a minor version is not, Amazon RDS defaults to a recent release of the major version you have specified\. To see a list of supported versions, as well as defaults for newly created DB instances, use the [https://docs.aws.amazon.com/cli/latest/reference/rds/describe-db-engine-versions.html](https://docs.aws.amazon.com/cli/latest/reference/rds/describe-db-engine-versions.html) AWS CLI command\. - -For example, to list the supported engine versions for RDS for MySQL, run the following CLI command: - -``` -aws rds describe-db-engine-versions --engine mysql --query "*[].{Engine:Engine,EngineVersion:EngineVersion}" --output text -``` - -The default MySQL version might vary by AWS Region\. To create a DB instance with a specific minor version, specify the minor version during DB instance creation\. You can determine the default minor version for an AWS Region using the following AWS CLI command: - -``` -aws rds describe-db-engine-versions --default-only --engine mysql --engine-version major-engine-version --region region --query "*[].{Engine:Engine,EngineVersion:EngineVersion}" --output text -``` - -Replace *major\-engine\-version* with the major engine version, and replace *region* with the AWS Region\. For example, the following AWS CLI command returns the default MySQL minor engine version for the 5\.7 major version and the US West \(Oregon\) AWS Region \(us\-west\-2\): - -``` -aws rds describe-db-engine-versions --default-only --engine mysql --engine-version 5.7 --region us-west-2 --query "*[].{Engine:Engine,EngineVersion:EngineVersion}" --output text -``` - -With Amazon RDS, you control when to upgrade your MySQL instance to a new major version supported by Amazon RDS\. You can maintain compatibility with specific MySQL versions, test new versions with your application before deploying in production, and perform major version upgrades at times that best fit your schedule\. - -When automatic minor version upgrade is enabled, your DB instance will be upgraded automatically to new MySQL minor versions as they are supported by Amazon RDS\. This patching occurs during your scheduled maintenance window\. You can modify a DB instance to enable or disable automatic minor version upgrades\. - -If you opt out of automatically scheduled upgrades, you can manually upgrade to a supported minor version release by following the same procedure as you would for a major version update\. For information, see [Upgrading a DB instance engine version](USER_UpgradeDBInstance.Upgrading.md)\. - -Amazon RDS currently supports the major version upgrades from MySQL version 5\.6 to version 5\.7, and from MySQL version 5\.7 to version 8\.0\. Because major version upgrades involve some compatibility risk, they do not occur automatically; you must make a request to modify the DB instance\. You should thoroughly test any upgrade before upgrading your production instances\. For information about upgrading a MySQL DB instance, see [Upgrading the MySQL DB engine](USER_UpgradeDBInstance.MySQL.md)\. - -You can test a DB instance against a new version before upgrading by creating a DB snapshot of your existing DB instance, restoring from the DB snapshot to create a new DB instance, and then initiating a version upgrade for the new DB instance\. You can then experiment safely on the upgraded clone of your DB instance before deciding whether or not to upgrade your original DB instance\. - -## Supported MySQL major versions on Amazon RDS - -RDS for MySQL major versions remain available at least until community end of life for the corresponding community version\. You can use the following dates to plan your testing and upgrade cycles\. If Amazon extends support for an RDS for MySQL version for longer than originally stated, we plan to update this table to reflect the later date\. - -**Note** -Dates with only a month and a year are approximate and are updated with an exact date when it’s known\. - - -**** - -| MySQL major version | Community release date | RDS release date | Community end of life date | RDS end of standard support date | -| --- | --- | --- | --- | --- | -| MySQL 8\.0 Current minor version: 8\.0\.32 | 19 April 2018 | 23 October 2018 | April 2026 | April 2026 | -| MySQL 5\.7 Current minor version: 5\.7\.41 | 21 October 2015 | 22 February 2016 | October 2023 | December 2023 | -| MySQL 5\.6 Current minor version: N/A | 5 February 2013 | 1 July 2013 | 5 February 2021 | 1 March 2022 | - -## Deprecated versions for Amazon RDS for MySQL - -Amazon RDS for MySQL version 5\.1, 5\.5, and 5\.6 are deprecated\. - -For information about the Amazon RDS deprecation policy for MySQL, see [Amazon RDS FAQs](http://aws.amazon.com/rds/faqs/)\. \ No newline at end of file diff --git a/doc_source/MySQL.KnownIssuesAndLimitations.md b/doc_source/MySQL.KnownIssuesAndLimitations.md deleted file mode 100644 index 7ea6633..0000000 --- a/doc_source/MySQL.KnownIssuesAndLimitations.md +++ /dev/null @@ -1,148 +0,0 @@ -# Known issues and limitations for Amazon RDS for MySQL - -Known issues and limitations for working with Amazon RDS for MySQL are as follows\. - -**Topics** -+ [InnoDB reserved word](#MySQL.Concepts.KnownIssuesAndLimitations.InnodbDatabaseName) -+ [Storage\-full behavior for Amazon RDS for MySQL](#MySQL.Concepts.StorageFullBehavior) -+ [Inconsistent InnoDB buffer pool size](#MySQL.Concepts.KnownIssuesAndLimitations.InnodbBufferPoolSize) -+ [Index merge optimization returns incorrect results](#MySQL.Concepts.KnownIssuesAndLimitations.IndexMergeOptimization) -+ [Log file size](#MySQL.Concepts.KnownIssuesAndLimitations.LogFileSize) -+ [MySQL parameter exceptions for Amazon RDS DB instances](#MySQL.Concepts.ParameterNotes) -+ [MySQL file size limits in Amazon RDS](#MySQL.Concepts.Limits.FileSize) -+ [MySQL Keyring Plugin not supported](#MySQL.Concepts.Limits.KeyRing) -+ [Custom ports](#MySQL.Concepts.KnownIssuesAndLimitations.CustomPorts) - -## InnoDB reserved word - -`InnoDB` is a reserved word for RDS for MySQL\. You can't use this name for a MySQL database\. - -## Storage\-full behavior for Amazon RDS for MySQL - -When storage becomes full for a MySQL DB instance, there can be metadata inconsistencies, dictionary mismatches, and orphan tables\. To prevent these issues, Amazon RDS automatically stops a DB instance that reaches the `storage-full` state\. - -A MySQL DB instance reaches the `storage-full` state in the following cases: -+ The DB instance has less than 20,000 MiB of storage, and available storage reaches 200 MiB or less\. -+ The DB instance has more than 102,400 MiB of storage, and available storage reaches 1024 MiB or less\. -+ The DB instance has between 20,000 MiB and 102,400 MiB of storage, and has less than 1% of storage available\. - -After Amazon RDS stops a DB instance automatically because it reached the `storage-full` state, you can still modify it\. To restart the DB instance, complete at least one of the following: -+ Modify the DB instance to enable storage autoscaling\. - - For more information about storage autoscaling, see [Managing capacity automatically with Amazon RDS storage autoscaling](USER_PIOPS.StorageTypes.md#USER_PIOPS.Autoscaling)\. -+ Modify the DB instance to increase its storage capacity\. - - For more information about increasing storage capacity, see [Increasing DB instance storage capacity](USER_PIOPS.StorageTypes.md#USER_PIOPS.ModifyingExisting)\. - -After you make one of these changes, the DB instance is restarted automatically\. For information about modifying a DB instance, see [Modifying an Amazon RDS DB instance](Overview.DBInstance.Modifying.md)\. - -## Inconsistent InnoDB buffer pool size - -For MySQL 5\.7, there is currently a bug in the way that the InnoDB buffer pool size is managed\. MySQL 5\.7 might adjust the value of the `innodb_buffer_pool_size` parameter to a large value that can result in the InnoDB buffer pool growing too large and using up too much memory\. This effect can cause the MySQL database engine to stop running or can prevent the MySQL database engine from starting\. This issue is more common for DB instance classes that have less memory available\. - -To resolve this issue, set the value of the `innodb_buffer_pool_size` parameter to a multiple of the product of the `innodb_buffer_pool_instances` parameter value and the `innodb_buffer_pool_chunk_size` parameter value\. For example, you might set the `innodb_buffer_pool_size` parameter value to a multiple of eight times the product of the `innodb_buffer_pool_instances` and `innodb_buffer_pool_chunk_size` parameter values, as shown in the following example\. - -``` -innodb_buffer_pool_chunk_size = 536870912 -innodb_buffer_pool_instances = 4 -innodb_buffer_pool_size = (536870912 * 4) * 8 = 17179869184 -``` - -For details on this MySQL 5\.7 bug, see [https://bugs\.mysql\.com/bug\.php?id=79379](https://bugs.mysql.com/bug.php?id=79379) in the MySQL documentation\. - -## Index merge optimization returns incorrect results - -Queries that use index merge optimization might return incorrect results due to a bug in the MySQL query optimizer that was introduced in MySQL 5\.5\.37\. When you issue a query against a table with multiple indexes the optimizer scans ranges of rows based on the multiple indexes, but does not merge the results together correctly\. For more information on the query optimizer bug, see [http://bugs\.mysql\.com/bug\.php?id=72745](https://bugs.mysql.com/bug.php?id=72745) and [http://bugs\.mysql\.com/bug\.php?id=68194](https://bugs.mysql.com/bug.php?id=68194) in the MySQL bug database\. - -For example, consider a query on a table with two indexes where the search arguments reference the indexed columns\. - -``` -1. SELECT * FROM table1 -2. WHERE indexed_col1 = 'value1' AND indexed_col2 = 'value2'; -``` - -In this case, the search engine will search both indexes\. However, due to the bug, the merged results are incorrect\. - -To resolve this issue, you can do one of the following: -+ Set the `optimizer_switch` parameter to `index_merge=off` in the DB parameter group for your MySQL DB instance\. For information on setting DB parameter group parameters, see [Working with parameter groups](USER_WorkingWithParamGroups.md)\. -+ Upgrade your MySQL DB instance to MySQL version 5\.7 or 8\.0\. For more information, see [Upgrading the MySQL DB engine](USER_UpgradeDBInstance.MySQL.md)\. -+ If you cannot upgrade your instance or change the `optimizer_switch` parameter, you can work around the bug by explicitly identifying an index for the query, for example: - - ``` - 1. SELECT * FROM table1 - 2. USE INDEX covering_index - 3. WHERE indexed_col1 = 'value1' AND indexed_col2 = 'value2'; - ``` - -For more information, see [Index merge optimization](https://dev.mysql.com/doc/refman/8.0/en/index-merge-optimization.html) in the MySQL documentation\. - -## Log file size - -For MySQL, there is a size limit on BLOBs written to the redo log\. To account for this limit, ensure that the `innodb_log_file_size` parameter for your MySQL DB instance is 10 times larger than the largest BLOB data size found in your tables, plus the length of other variable length fields \(`VARCHAR`, `VARBINARY`, `TEXT`\) in the same tables\. For information on how to set parameter values, see [Working with parameter groups](USER_WorkingWithParamGroups.md)\. For information on the `innodb_log_file_size` parameter, see [ the MySQL documentation](https://dev.mysql.com/doc/refman/8.0/en/innodb-parameters.html#sysvar_innodb_log_file_size)\. - -## MySQL parameter exceptions for Amazon RDS DB instances - -Some MySQL parameters require special considerations when used with an Amazon RDS DB instance\. - -### lower\_case\_table\_names - -Because Amazon RDS uses a case\-sensitive file system, setting the value of the `lower_case_table_names` server parameter to 2 \("names stored as given but compared in lowercase"\) is not supported\. The following are the supported values for Amazon RDS for MySQL DB instances: -+ 0 \("names stored as given and comparisons are case\-sensitive"\) is supported for all Amazon RDS for MySQL versions\. -+ 1 \("names stored in lowercase and comparisons are not case\-sensitive"\) is supported for RDS for MySQL version 5\.7 and version 8\.0\.28 and higher 8\.0 versions\. - -Set the `lower_case_table_names` parameter in a custom DB parameter group before creating a DB instance\. Then, specify the custom DB parameter group when you create the DB instance\. - -When a parameter group is associated with a MySQL DB instance with a version lower than 8\.0, we recommend that you avoid changing the `lower_case_table_names` parameter in the parameter group\. Doing so could cause inconsistencies with point\-in\-time recovery backups and read replica DB instances\. - -When a parameter group is associated with a version 8\.0 MySQL DB instance, you can't modify the `lower_case_table_names` parameter in the parameter group\. - -Read replicas should always use the same `lower_case_table_names` parameter value as the source DB instance\. - -### long\_query\_time - -You can set the `long_query_time` parameter to a floating point value which allows you to log slow queries to the MySQL slow query log with microsecond resolution\. You can set a value such as 0\.1 seconds, which would be 100 milliseconds, to help when debugging slow transactions that take less than one second\. - -## MySQL file size limits in Amazon RDS - -For MySQL DB instances, the maximum provisioned storage limit constrains the size of a table to a maximum size of 16 TB when using InnoDB file\-per\-table tablespaces\. This limit also constrains the system tablespace to a maximum size of 16 TB\. InnoDB file\-per\-table tablespaces \(with tables each in their own tablespace\) is set by default for MySQL DB instances\. - -**Note** -Some existing DB instances have a lower limit\. For example, MySQL DB instances created before April 2014 have a file and table size limit of 2 TB\. This 2 TB file size limit also applies to DB instances or read replicas created from DB snapshots taken before April 2014, regardless of when the DB instance was created\. - -There are advantages and disadvantages to using InnoDB file\-per\-table tablespaces, depending on your application\. To determine the best approach for your application, see [File\-per\-table tablespaces](https://dev.mysql.com/doc/refman/8.0/en/innodb-file-per-table-tablespaces.html) in the MySQL documentation\. - -We don't recommend allowing tables to grow to the maximum file size\. In general, a better practice is to partition data into smaller tables, which can improve performance and recovery times\. - -One option that you can use for breaking a large table up into smaller tables is partitioning\. Partitioning distributes portions of your large table into separate files based on rules that you specify\. For example, if you store transactions by date, you can create partitioning rules that distribute older transactions into separate files using partitioning\. Then periodically, you can archive the historical transaction data that doesn't need to be readily available to your application\. For more information, see [Partitioning](https://dev.mysql.com/doc/refman/8.0/en/partitioning.html) in the MySQL documentation\. - -**To determine the file size of a table** -+ Use the following SQL command to determine if any of your tables are too large and are candidates for partitioning\. - - ``` - 1. SELECT TABLE_SCHEMA, TABLE_NAME, - 2. round(((DATA_LENGTH + INDEX_LENGTH) / 1024 / 1024), 2) As "Approximate size (MB)" - 3. FROM information_schema.TABLES - 4. WHERE TABLE_SCHEMA NOT IN ('mysql', 'information_schema', 'performance_schema'); - ``` - -**To enable InnoDB file\-per\-table tablespaces** -+ To enable InnoDB file\-per\-table tablespaces, set the *innodb\_file\_per\_table* parameter to `1` in the parameter group for the DB instance\. - -**To disable InnoDB file\-per\-table tablespaces** -+ To disable InnoDB file\-per\-table tablespaces, set the *innodb\_file\_per\_table* parameter to `0` in the parameter group for the DB instance\. - -For information on updating a parameter group, see [Working with parameter groups](USER_WorkingWithParamGroups.md)\. - -When you have enabled or disabled InnoDB file\-per\-table tablespaces, you can issue an `ALTER TABLE` command to move a table from the global tablespace to its own tablespace, or from its own tablespace to the global tablespace as shown in the following example: - -``` -ALTER TABLE table_name ENGINE=InnoDB; -``` - -## MySQL Keyring Plugin not supported - -Currently, Amazon RDS for MySQL does not support the MySQL `keyring_aws` Amazon Web Services Keyring Plugin\. - -## Custom ports - -Amazon RDS blocks connections to custom port 33060 for the MySQL engine\. Choose a different port for your MySQL engine\. \ No newline at end of file diff --git a/doc_source/MySQL.Procedural.Exporting.NonRDSRepl.md b/doc_source/MySQL.Procedural.Exporting.NonRDSRepl.md deleted file mode 100644 index a3dada6..0000000 --- a/doc_source/MySQL.Procedural.Exporting.NonRDSRepl.md +++ /dev/null @@ -1,146 +0,0 @@ -# Exporting data from a MySQL DB instance by using replication - -To export data from an RDS for MySQL DB instance to a MySQL instance running external to Amazon RDS, you can use replication\. In this scenario, the MySQL DB instance is the *source MySQL DB instance*, and the MySQL instance running external to Amazon RDS is the *external MySQL database*\. - -The external MySQL database can run either on\-premises in your data center, or on an Amazon EC2 instance\. The external MySQL database must run the same version as the source MySQL DB instance, or a later version\. - -Replication to an external MySQL database is only supported during the time it takes to export a database from the source MySQL DB instance\. The replication should be terminated when the data has been exported and applications can start accessing the external MySQL instance\. - -The following list shows the steps to take\. Each step is discussed in more detail in later sections\. - -1. Prepare an external MySQL DB instance\. - -1. Prepare the source MySQL DB instance for replication\. - -1. Use the mysqldump utility to transfer the database from the source MySQL DB instance to the external MySQL database\. - -1. Start replication to the external MySQL database\. - -1. After the export completes, stop replication\. - -## Prepare an external MySQL database - -Perform the following steps to prepare the external MySQL database\. - -**To prepare the external MySQL database** - -1. Install the external MySQL database\. - -1. Connect to the external MySQL database as the master user\. Then create the users required to support the administrators, applications, and services that access the database\. - -1. Follow the directions in the MySQL documentation to prepare the external MySQL database as a replica\. For more information, see [the MySQL documentation](https://dev.mysql.com/doc/refman/8.0/en/replication-howto-slavebaseconfig.html)\. - -1. Configure an egress rule for the external MySQL database to operate as a read replica during the export\. The egress rule allows the external MySQL database to connect to the source MySQL DB instance during replication\. Specify an egress rule that allows Transmission Control Protocol \(TCP\) connections to the port and IP address of the source MySQL DB instance\. - - Specify the appropriate egress rules for your environment: - + If the external MySQL database is running in an Amazon EC2 instance in a virtual private cloud \(VPC\) based on the Amazon VPC service, specify the egress rules in a VPC security group\. For more information, see [Controlling access with security groups](Overview.RDSSecurityGroups.md)\. - + If the external MySQL database is installed on\-premises, specify the egress rules in a firewall\. - -1. If the external MySQL database is running in a VPC, configure rules for the VPC access control list \(ACL\) rules in addition to the security group egress rule: - + Configure an ACL ingress rule allowing TCP traffic to ports 1024–65535 from the IP address of the source MySQL DB instance\. - + Configure an ACL egress rule allowing outbound TCP traffic to the port and IP address of the source MySQL DB instance\. - - For more information about Amazon VPC network ACLs, see [Network ACLs](https://docs.aws.amazon.com/vpc/latest/userguide/vpc-network-acls.html) in *Amazon VPC User Guide\.* - -1. \(Optional\) Set the `max_allowed_packet` parameter to the maximum size to avoid replication errors\. We recommend this setting\. - -## Prepare the source MySQL DB instance - -Perform the following steps to prepare the source MySQL DB instance as the replication source\. - -**To prepare the source MySQL DB instance** - -1. Ensure that your client computer has enough disk space available to save the binary logs while setting up replication\. - -1. Connect to the source MySQL DB instance, and create a replication account by following the directions in [Creating a user for replication](http://dev.mysql.com/doc/refman/8.0/en/replication-howto-repuser.html) in the MySQL documentation\. - -1. Configure ingress rules on the system running the source MySQL DB instance to allow the external MySQL database to connect during replication\. Specify an ingress rule that allows TCP connections to the port used by the source MySQL DB instance from the IP address of the external MySQL database\. - -1. Specify the egress rules: - + If the source MySQL DB instance is running in a VPC, specify the ingress rules in a VPC security group\. For more information, see [Controlling access with security groups](Overview.RDSSecurityGroups.md)\. - -1. If source MySQL DB instance is running in a VPC, configure VPC ACL rules in addition to the security group ingress rule: - + Configure an ACL ingress rule to allow TCP connections to the port used by the Amazon RDS instance from the IP address of the external MySQL database\. - + Configure an ACL egress rule to allow TCP connections from ports 1024–65535 to the IP address of the external MySQL database\. - - For more information about Amazon VPC network ACLs, see [Network ACLs](https://docs.aws.amazon.com/vpc/latest/userguide/vpc-network-acls.html) in the *Amazon VPC User Guide\.* - -1. Ensure that the backup retention period is set long enough that no binary logs are purged during the export\. If any of the logs are purged before the export has completed, you must restart replication from the beginning\. For more information about setting the backup retention period, see [Working with backups](USER_WorkingWithAutomatedBackups.md)\. - -1. Use the `mysql.rds_set_configuration` stored procedure to set the binary log retention period long enough that the binary logs aren't purged during the export\. For more information, see [Accessing MySQL binary logs](USER_LogAccess.MySQL.Binarylog.md)\. - -1. Create an Amazon RDS read replica from the source MySQL DB instance to further ensure that the binary logs of the source MySQL DB instance are not purged\. For more information, see [Creating a read replica](USER_ReadRepl.md#USER_ReadRepl.Create)\. - -1. After the Amazon RDS read replica has been created, call the `mysql.rds_stop_replication` stored procedure to stop the replication process\. The source MySQL DB instance no longer purges its binary log files, so they are available for the replication process\. - -1. \(Optional\) Set both the `max_allowed_packet` parameter and the `slave_max_allowed_packet` parameter to the maximum size to avoid replication errors\. The maximum size for both parameters is 1 GB\. We recommend this setting for both parameters\. For information about setting parameters, see [Modifying parameters in a DB parameter group](USER_WorkingWithDBInstanceParamGroups.md#USER_WorkingWithParamGroups.Modifying)\. - -## Copy the database - -Perform the following steps to copy the database\. - -**To copy the database** - -1. Connect to the RDS read replica of the source MySQL DB instance, and run the MySQL `SHOW REPLICA STATUS\G` statement\. Note the values for the following: - + `Master_Host` - + `Master_Port` - + `Master_Log_File` - + `Exec_Master_Log_Pos` -**Note** -Previous versions of MySQL used `SHOW SLAVE STATUS` instead of `SHOW REPLICA STATUS`\. If you are using a MySQL version before 8\.0\.23, then use `SHOW SLAVE STATUS`\. - -1. Use the mysqldump utility to create a snapshot, which copies the data from Amazon RDS to your local client computer\. Ensure that your client computer has enough space to hold the `mysqldump` files from the databases to be replicated\. This process can take several hours for very large databases\. Follow the directions in [Creating a data snapshot using mysqldump](https://dev.mysql.com/doc/mysql-replication-excerpt/8.0/en/replication-howto-mysqldump.html) in the MySQL documentation\. - - The following example runs `mysqldump` on a client and writes the dump to a file\. - - For Linux, macOS, or Unix: - - ``` - mysqldump -h source_MySQL_DB_instance_endpoint \ - -u user \ - -ppassword \ - --port=3306 \ - --single-transaction \ - --routines \ - --triggers \ - --databases database database2 > path/rds-dump.sql - ``` - - For Windows: - - ``` - mysqldump -h source_MySQL_DB_instance_endpoint ^ - -u user ^ - -ppassword ^ - --port=3306 ^ - --single-transaction ^ - --routines ^ - --triggers ^ - --databases database database2 > path\rds-dump.sql - ``` - - You can load the backup file into the external MySQL database\. For more information, see [ Reloading SQL\-Format Backups](https://dev.mysql.com/doc/refman/8.0/en/reloading-sql-format-dumps.html) in the MySQL documentation\. You can run another utility to load the data into the external MySQL database\. - -## Complete the export - -Perform the following steps to complete the export\. - -**To complete the export** - -1. Use the MySQL `CHANGE MASTER` statement to configure the external MySQL database\. Specify the ID and password of the user granted `REPLICATION SLAVE` permissions\. Specify the `Master_Host`, `Master_Port`, `Relay_Master_Log_File`, and `Exec_Master_Log_Pos` values that you got from the MySQL `SHOW REPLICA STATUS\G` statement that you ran on the RDS read replica\. For more information, see [the MySQL documentation](https://dev.mysql.com/doc/refman/8.0/en/change-master-to.html)\. -**Note** -Previous versions of MySQL used `SHOW SLAVE STATUS` instead of `SHOW REPLICA STATUS`\. If you are using a MySQL version before 8\.0\.23, then use `SHOW SLAVE STATUS`\. - -1. Use the MySQL `START REPLICA` command to initiate replication from the source MySQL DB instance to the external MySQL database\. - - Doing this starts replication from the source MySQL DB instance and exports all source changes that have occurred after you stopped replication from the Amazon RDS read replica\. -**Note** -Previous versions of MySQL used `START SLAVE` instead of `START REPLICA`\. If you are using a MySQL version before 8\.0\.23, then use `START SLAVE`\. - -1. Run the MySQL `SHOW REPLICA STATUS\G` command on the external MySQL database to verify that it is operating as a read replica\. For more information about interpreting the results, see [the MySQL documentation](https://dev.mysql.com/doc/refman/8.0/en/show-slave-status.html)\. - -1. After replication on the external MySQL database has caught up with the source MySQL DB instance, use the MySQL `STOP REPLICA` command to stop replication from the source MySQL DB instance\. -**Note** -Previous versions of MySQL used `STOP SLAVE` instead of `STOP REPLICA`\. If you are using a MySQL version before 8\.0\.23, then use `STOP SLAVE`\. - -1. On the Amazon RDS read replica, call the `mysql.rds_start_replication` stored procedure\. Doing this allows Amazon RDS to start purging the binary log files from the source MySQL DB instance\. \ No newline at end of file diff --git a/doc_source/MySQL.Procedural.Importing.AnySource.md b/doc_source/MySQL.Procedural.Importing.AnySource.md deleted file mode 100644 index 457edfd..0000000 --- a/doc_source/MySQL.Procedural.Importing.AnySource.md +++ /dev/null @@ -1,218 +0,0 @@ -# Importing data from any source to a MariaDB or MySQL DB instance - -If you have more than 1 GiB of data to load, or if your data is coming from somewhere other than a MariaDB or MySQL database, we recommend creating flat files and loading them with mysqlimport\. The mysqlimport utility is another command line utility bundled with the MySQL and MariaDB client software\. Its purpose is to load flat files into MySQL or MariaDB\. For information about mysqlimport, see [mysqlimport \- a data import program](https://dev.mysql.com/doc/refman/8.0/en/mysqlimport.html) in the MySQL documentation\. - -We also recommend creating DB snapshots of the target Amazon RDS DB instance before and after the data load\. Amazon RDS DB snapshots are complete backups of your DB instance that can be used to restore your DB instance to a known state\. When you initiate a DB snapshot, I/O operations to your DB instance are momentarily suspended while your database is backed up\. - -Creating a DB snapshot immediately before the load makes it possible for you to restore the database to its state before the load, if you need to\. A DB snapshot taken immediately after the load protects you from having to load the data again in case of a mishap and can also be used to seed new database instances\. - -The following list shows the steps to take\. Each step is discussed in more detail following\. - -1. Create flat files containing the data to be loaded\. - -1. Stop any applications accessing the target DB instance\. - -1. Create a DB snapshot\. - -1. Consider turning off Amazon RDS automated backups\. - -1. Load the data using mysqlimport\. - -1. Enable automated backups again\. - -## Step 1: Create flat files containing the data to be loaded - -Use a common format, such as comma\-separated values \(CSV\), to store the data to be loaded\. Each table must have its own file; you can't combine data for multiple tables in the same file\. Give each file the same name as the table it corresponds to\. The file extension can be anything you like\. For example, if the table name is `sales`, the file name might be `sales.csv` or `sales.txt`, but not `sales_01.csv`\. - -Whenever possible, order the data by the primary key of the table being loaded\. Doing this drastically improves load times and minimizes disk storage requirements\. - -The speed and efficiency of this procedure depends on keeping the size of the files small\. If the uncompressed size of any individual file is larger than 1 GiB, split it into multiple files and load each one separately\. - -On Unix\-like systems \(including Linux\), use the `split` command\. For example, the following command splits the `sales.csv` file into multiple files of less than 1 GiB, splitting only at line breaks \(\-C 1024m\)\. The new files are named `sales.part_00`, `sales.part_01`, and so on\. - -``` -split -C 1024m -d sales.csv sales.part_ -``` - -Similar utilities are available for other operating systems\. - -## Step 2: Stop any applications accessing the target DB instance - -Before starting a large load, stop all application activity accessing the target DB instance that you plan to load to\. We recommend this particularly if other sessions will be modifying the tables being loaded or tables that they reference\. Doing this reduces the risk of constraint violations occurring during the load and improves load performance\. It also makes it possible to restore the DB instance to the point just before the load without losing changes made by processes not involved in the load\. - -Of course, this might not be possible or practical\. If you can't stop applications from accessing the DB instance before the load, take steps to ensure the availability and integrity of your data\. The specific steps required vary greatly depending upon specific use cases and site requirements\. - -## Step 3: Create a DB snapshot - -If you plan to load data into a new DB instance that contains no data, you can skip this step\. Otherwise, creating a DB snapshot of your DB instance makes it possible for you to restore the DB instance to the point just before the load, if it becomes necessary\. As previously mentioned, when you initiate a DB snapshot, I/O operations to your DB instance are suspended for a few minutes while the database is backed up\. - -The example following uses the AWS CLI `create-db-snapshot` command to create a DB snapshot of the `AcmeRDS` instance and give the DB snapshot the identifier `"preload"`\. - -For Linux, macOS, or Unix: - -``` -aws rds create-db-snapshot \ - --db-instance-identifier AcmeRDS \ - --db-snapshot-identifier preload -``` - -For Windows: - -``` -aws rds create-db-snapshot ^ - --db-instance-identifier AcmeRDS ^ - --db-snapshot-identifier preload -``` - -You can also use the restore from DB snapshot functionality to create test DB instances for dry runs or to undo changes made during the load\. - -Keep in mind that restoring a database from a DB snapshot creates a new DB instance that, like all DB instances, has a unique identifier and endpoint\. To restore the DB instance without changing the endpoint, first delete the DB instance so that you can reuse the endpoint\. - -For example, to create a DB instance for dry runs or other testing, you give the DB instance its own identifier\. In the example, `AcmeRDS-2`" is the identifier\. The example connects to the DB instance using the endpoint associated with `AcmeRDS-2`\. - -For Linux, macOS, or Unix: - -``` -aws rds restore-db-instance-from-db-snapshot \ - --db-instance-identifier AcmeRDS-2 \ - --db-snapshot-identifier preload -``` - -For Windows: - -``` -aws rds restore-db-instance-from-db-snapshot ^ - --db-instance-identifier AcmeRDS-2 ^ - --db-snapshot-identifier preload -``` - -To reuse the existing endpoint, first delete the DB instance and then give the restored database the same identifier\. - -For Linux, macOS, or Unix: - -``` -aws rds delete-db-instance \ - --db-instance-identifier AcmeRDS \ - --final-db-snapshot-identifier AcmeRDS-Final - -aws rds restore-db-instance-from-db-snapshot \ - --db-instance-identifier AcmeRDS \ - --db-snapshot-identifier preload -``` - -For Windows: - -``` -aws rds delete-db-instance ^ - --db-instance-identifier AcmeRDS ^ - --final-db-snapshot-identifier AcmeRDS-Final - -aws rds restore-db-instance-from-db-snapshot ^ - --db-instance-identifier AcmeRDS ^ - --db-snapshot-identifier preload -``` - -The preceding example takes a final DB snapshot of the DB instance before deleting it\. This is optional but recommended\. - -## Step 4: Consider turning off Amazon RDS automated backups - -**Warning** -Do not turn off automated backups if you need to perform point\-in\-time recovery\. - -Turning off automated backups erases all existing backups, so point\-in\-time recovery isn't possible after automated backups have been turned off\. Disabling automated backups is a performance optimization and isn't required for data loads\. Manual DB snapshots aren't affected by turning off automated backups\. All existing manual DB snapshots are still available for restore\. - -Turning off automated backups reduces load time by about 25 percent and reduces the amount of storage space required during the load\. If you plan to load data into a new DB instance that contains no data, turning off backups is an easy way to speed up the load and avoid using the additional storage needed for backups\. However, in some cases you might plan to load into a DB instance that already contains data\. If so, weigh the benefits of turning off backups against the impact of losing the ability to perform point\-in\-time\-recovery\. - -DB instances have automated backups turned on by default \(with a one day retention period\)\. To turn off automated backups, set the backup retention period to zero\. After the load, you can turn backups back on by setting the backup retention period to a nonzero value\. To turn on or turn off backups, Amazon RDS shuts the DB instance down and restarts it to turn MariaDB or MySQL logging on or off\. - -Use the AWS CLI `modify-db-instance` command to set the backup retention to zero and apply the change immediately\. Setting the retention period to zero requires a DB instance restart, so wait until the restart has completed before proceeding\. - -For Linux, macOS, or Unix: - -``` -aws rds modify-db-instance \ - --db-instance-identifier AcmeRDS \ - --apply-immediately \ - --backup-retention-period 0 -``` - -For Windows: - -``` -aws rds modify-db-instance ^ - --db-instance-identifier AcmeRDS ^ - --apply-immediately ^ - --backup-retention-period 0 -``` - -You can check the status of your DB instance with the AWS CLI `describe-db-instances` command\. The following example displays the DB instance status of the `AcmeRDS` DB instance\. - -``` -aws rds describe-db-instances --db-instance-identifier AcmeRDS --query "*[].{DBInstanceStatus:DBInstanceStatus}" -``` - -When the DB instance status is `available`, you're ready to proceed\. - -## Step 5: Load the data - -Use the mysqlimport utility to load the flat files into Amazon RDS\. The following example tells mysqlimport to load all of the files named "sales" with an extension starting with "part\_"\. This is a convenient way to load all of the files created in the "split" example\. - -Use the \-\-compress option to minimize network traffic\. The \-\-fields\-terminated\-by=',' option is used for CSV files, and the \-\-local option specifies that the incoming data is located on the client\. Without the \-\-local option, the Amazon RDS DB instance looks for the data on the database host, so always specify the \-\-local option\. For the \-\-host option, specify the DB instance endpoint of the RDS for MySQL DB instance\. - -In the following examples, replace `master_user` with the master username for your DB instance\. - -Replace `hostname` with the endpoint for your DB instance\. An example of a DB instance endpoint is `my-db-instance.123456789012.us-west-2.rds.amazonaws.com`\. - -For RDS for MySQL version 8\.0\.15 and higher, run the following statement before using the mysqlimport utility\. - -``` -GRANT SESSION_VARIABLES_ADMIN ON *.* TO master_user; -``` - -For Linux, macOS, or Unix: - -``` -mysqlimport --local \ - --compress \ - --user=master_user \ - --password \ - --host=hostname \ - --fields-terminated-by=',' Acme sales.part_* -``` - -For Windows: - -``` -mysqlimport --local ^ - --compress ^ - --user=master_user ^ - --password ^ - --host=hostname ^ - --fields-terminated-by="," Acme sales.part_* -``` - -For very large data loads, take additional DB snapshots periodically between loading files and note which files have been loaded\. If a problem occurs, you can easily resume from the point of the last DB snapshot, avoiding lengthy reloads\. - -## Step 6: Turn Amazon RDS automated backups back on - -After the load is finished, turn Amazon RDS automated backups on by setting the backup retention period back to its preload value\. As noted earlier, Amazon RDS restarts the DB instance, so be prepared for a brief outage\. - -The following example uses the AWS CLI `modify-db-instance` command to turn on automated backups for the `AcmeRDS` DB instance and set the retention period to one day\. - -For Linux, macOS, or Unix: - -``` -aws rds modify-db-instance \ - --db-instance-identifier AcmeRDS \ - --backup-retention-period 1 \ - --apply-immediately -``` - -For Windows: - -``` -aws rds modify-db-instance ^ - --db-instance-identifier AcmeRDS ^ - --backup-retention-period 1 ^ - --apply-immediately -``` \ No newline at end of file diff --git a/doc_source/MySQL.Procedural.Importing.AnySourceMariaDB.md b/doc_source/MySQL.Procedural.Importing.AnySourceMariaDB.md deleted file mode 100644 index 3225b3e..0000000 --- a/doc_source/MySQL.Procedural.Importing.AnySourceMariaDB.md +++ /dev/null @@ -1,218 +0,0 @@ -# Importing data from any source to a MariaDB or MySQL DB instance - -If you have more than 1 GiB of data to load, or if your data is coming from somewhere other than a MariaDB or MySQL database, we recommend creating flat files and loading them with mysqlimport\. The mysqlimport utility is another command line utility bundled with the MySQL and MariaDB client software\. Its purpose is to load flat files into MySQL or MariaDB\. For information about mysqlimport, see [mysqlimport \- a data import program](https://dev.mysql.com/doc/refman/8.0/en/mysqlimport.html) in the MySQL documentation\. - -We also recommend creating DB snapshots of the target Amazon RDS DB instance before and after the data load\. Amazon RDS DB snapshots are complete backups of your DB instance that can be used to restore your DB instance to a known state\. When you initiate a DB snapshot, I/O operations to your DB instance are momentarily suspended while your database is backed up\. - -Creating a DB snapshot immediately before the load makes it possible for you to restore the database to its state before the load, if you need to\. A DB snapshot taken immediately after the load protects you from having to load the data again in case of a mishap and can also be used to seed new database instances\. - -The following list shows the steps to take\. Each step is discussed in more detail following\. - -1. Create flat files containing the data to be loaded\. - -1. Stop any applications accessing the target DB instance\. - -1. Create a DB snapshot\. - -1. Consider turning off Amazon RDS automated backups\. - -1. Load the data using mysqlimport\. - -1. Enable automated backups again\. - -## Step 1: Create flat files containing the data to be loaded - -Use a common format, such as comma\-separated values \(CSV\), to store the data to be loaded\. Each table must have its own file; you can't combine data for multiple tables in the same file\. Give each file the same name as the table it corresponds to\. The file extension can be anything you like\. For example, if the table name is `sales`, the file name might be `sales.csv` or `sales.txt`, but not `sales_01.csv`\. - -Whenever possible, order the data by the primary key of the table being loaded\. Doing this drastically improves load times and minimizes disk storage requirements\. - -The speed and efficiency of this procedure depends on keeping the size of the files small\. If the uncompressed size of any individual file is larger than 1 GiB, split it into multiple files and load each one separately\. - -On Unix\-like systems \(including Linux\), use the `split` command\. For example, the following command splits the `sales.csv` file into multiple files of less than 1 GiB, splitting only at line breaks \(\-C 1024m\)\. The new files are named `sales.part_00`, `sales.part_01`, and so on\. - -``` -split -C 1024m -d sales.csv sales.part_ -``` - -Similar utilities are available for other operating systems\. - -## Step 2: Stop any applications accessing the target DB instance - -Before starting a large load, stop all application activity accessing the target DB instance that you plan to load to\. We recommend this particularly if other sessions will be modifying the tables being loaded or tables that they reference\. Doing this reduces the risk of constraint violations occurring during the load and improves load performance\. It also makes it possible to restore the DB instance to the point just before the load without losing changes made by processes not involved in the load\. - -Of course, this might not be possible or practical\. If you can't stop applications from accessing the DB instance before the load, take steps to ensure the availability and integrity of your data\. The specific steps required vary greatly depending upon specific use cases and site requirements\. - -## Step 3: Create a DB snapshot - -If you plan to load data into a new DB instance that contains no data, you can skip this step\. Otherwise, creating a DB snapshot of your DB instance makes it possible for you to restore the DB instance to the point just before the load, if it becomes necessary\. As previously mentioned, when you initiate a DB snapshot, I/O operations to your DB instance are suspended for a few minutes while the database is backed up\. - -The example following uses the AWS CLI `create-db-snapshot` command to create a DB snapshot of the `AcmeRDS` instance and give the DB snapshot the identifier `"preload"`\. - -For Linux, macOS, or Unix: - -``` -aws rds create-db-snapshot \ - --db-instance-identifier AcmeRDS \ - --db-snapshot-identifier preload -``` - -For Windows: - -``` -aws rds create-db-snapshot ^ - --db-instance-identifier AcmeRDS ^ - --db-snapshot-identifier preload -``` - -You can also use the restore from DB snapshot functionality to create test DB instances for dry runs or to undo changes made during the load\. - -Keep in mind that restoring a database from a DB snapshot creates a new DB instance that, like all DB instances, has a unique identifier and endpoint\. To restore the DB instance without changing the endpoint, first delete the DB instance so that you can reuse the endpoint\. - -For example, to create a DB instance for dry runs or other testing, you give the DB instance its own identifier\. In the example, `AcmeRDS-2`" is the identifier\. The example connects to the DB instance using the endpoint associated with `AcmeRDS-2`\. - -For Linux, macOS, or Unix: - -``` -aws rds restore-db-instance-from-db-snapshot \ - --db-instance-identifier AcmeRDS-2 \ - --db-snapshot-identifier preload -``` - -For Windows: - -``` -aws rds restore-db-instance-from-db-snapshot ^ - --db-instance-identifier AcmeRDS-2 ^ - --db-snapshot-identifier preload -``` - -To reuse the existing endpoint, first delete the DB instance and then give the restored database the same identifier\. - -For Linux, macOS, or Unix: - -``` -aws rds delete-db-instance \ - --db-instance-identifier AcmeRDS \ - --final-db-snapshot-identifier AcmeRDS-Final - -aws rds restore-db-instance-from-db-snapshot \ - --db-instance-identifier AcmeRDS \ - --db-snapshot-identifier preload -``` - -For Windows: - -``` -aws rds delete-db-instance ^ - --db-instance-identifier AcmeRDS ^ - --final-db-snapshot-identifier AcmeRDS-Final - -aws rds restore-db-instance-from-db-snapshot ^ - --db-instance-identifier AcmeRDS ^ - --db-snapshot-identifier preload -``` - -The preceding example takes a final DB snapshot of the DB instance before deleting it\. This is optional but recommended\. - -## Step 4: Consider turning off Amazon RDS automated backups - -**Warning** -Do not turn off automated backups if you need to perform point\-in\-time recovery\. - -Turning off automated backups erases all existing backups, so point\-in\-time recovery isn't possible after automated backups have been turned off\. Disabling automated backups is a performance optimization and isn't required for data loads\. Manual DB snapshots aren't affected by turning off automated backups\. All existing manual DB snapshots are still available for restore\. - -Turning off automated backups reduces load time by about 25 percent and reduces the amount of storage space required during the load\. If you plan to load data into a new DB instance that contains no data, turning off backups is an easy way to speed up the load and avoid using the additional storage needed for backups\. However, in some cases you might plan to load into a DB instance that already contains data\. If so, weigh the benefits of turning off backups against the impact of losing the ability to perform point\-in\-time\-recovery\. - -DB instances have automated backups turned on by default \(with a one day retention period\)\. To turn off automated backups, set the backup retention period to zero\. After the load, you can turn backups back on by setting the backup retention period to a nonzero value\. To turn on or turn off backups, Amazon RDS shuts the DB instance down and restarts it to turn MariaDB or MySQL logging on or off\. - -Use the AWS CLI `modify-db-instance` command to set the backup retention to zero and apply the change immediately\. Setting the retention period to zero requires a DB instance restart, so wait until the restart has completed before proceeding\. - -For Linux, macOS, or Unix: - -``` -aws rds modify-db-instance \ - --db-instance-identifier AcmeRDS \ - --apply-immediately \ - --backup-retention-period 0 -``` - -For Windows: - -``` -aws rds modify-db-instance ^ - --db-instance-identifier AcmeRDS ^ - --apply-immediately ^ - --backup-retention-period 0 -``` - -You can check the status of your DB instance with the AWS CLI `describe-db-instances` command\. The following example displays the DB instance status of the `AcmeRDS` DB instance\. - -``` -aws rds describe-db-instances --db-instance-identifier AcmeRDS --query "*[].{DBInstanceStatus:DBInstanceStatus}" -``` - -When the DB instance status is `available`, you're ready to proceed\. - -## Step 5: Load the data - -Use the mysqlimport utility to load the flat files into Amazon RDS\. The following example tells mysqlimport to load all of the files named "sales" with an extension starting with "part\_"\. This is a convenient way to load all of the files created in the "split" example\. - -Use the \-\-compress option to minimize network traffic\. The \-\-fields\-terminated\-by=',' option is used for CSV files, and the \-\-local option specifies that the incoming data is located on the client\. Without the \-\-local option, the Amazon RDS DB instance looks for the data on the database host, so always specify the \-\-local option\. For the \-\-host option, specify the DB instance endpoint of the RDS for MySQL DB instance\. - -In the following examples, replace `master_user` with the master username for your DB instance\. - -Replace `hostname` with the endpoint for your DB instance\. An example of a DB instance endpoint is `my-db-instance.123456789012.us-west-2.rds.amazonaws.com`\. - -For RDS for MySQL version 8\.0\.15 and higher, run the following statement before using the mysqlimport utility\. - -``` -GRANT SESSION_VARIABLES_ADMIN ON *.* TO master_user; -``` - -For Linux, macOS, or Unix: - -``` -mysqlimport --local \ - --compress \ - --user=master_user \ - --password \ - --host=hostname \ - --fields-terminated-by=',' Acme sales.part_* -``` - -For Windows: - -``` -mysqlimport --local ^ - --compress ^ - --user=master_user ^ - --password ^ - --host=hostname ^ - --fields-terminated-by="," Acme sales.part_* -``` - -For very large data loads, take additional DB snapshots periodically between loading files and note which files have been loaded\. If a problem occurs, you can easily resume from the point of the last DB snapshot, avoiding lengthy reloads\. - -## Step 6: Turn Amazon RDS automated backups back on - -After the load is finished, turn Amazon RDS automated backups on by setting the backup retention period back to its preload value\. As noted earlier, Amazon RDS restarts the DB instance, so be prepared for a brief outage\. - -The following example uses the AWS CLI `modify-db-instance` command to turn on automated backups for the `AcmeRDS` DB instance and set the retention period to one day\. - -For Linux, macOS, or Unix: - -``` -aws rds modify-db-instance \ - --db-instance-identifier AcmeRDS \ - --backup-retention-period 1 \ - --apply-immediately -``` - -For Windows: - -``` -aws rds modify-db-instance ^ - --db-instance-identifier AcmeRDS ^ - --backup-retention-period 1 ^ - --apply-immediately -``` \ No newline at end of file diff --git a/doc_source/MySQL.Procedural.Importing.External.Repl.GTIDProcedure.md b/doc_source/MySQL.Procedural.Importing.External.Repl.GTIDProcedure.md deleted file mode 100644 index e2b669e..0000000 --- a/doc_source/MySQL.Procedural.Importing.External.Repl.GTIDProcedure.md +++ /dev/null @@ -1,120 +0,0 @@ -# Configuring GTID\-based replication with an external source instance - -You can set up replication based on global transaction identifiers \(GTIDs\) from an external MySQL instance into an RDS for MySQL DB instance\. When you set up an external source instance and a replica on Amazon RDS, monitor failover events for the Amazon RDS DB instance that is your replica\. If a failover occurs, then the DB instance that is your replica might be recreated on a new host with a different network address\. For information on how to monitor failover events, see [Working with Amazon RDS event notification](USER_Events.md)\. - -**Important** -GTID\-based replication is supported only on RDS for MySQL version 5\.7\.23 and higher MySQL 5\.7 versions, and RDS for MySQL 8\.0\.26 and higher 8\.0 versions\. - -**To configure GTID\-based replication with an external source instance** - -1. Prepare for GTID\-based replication: - - 1. Make sure that the external MySQL database has GTID\-based replication enabled\. To do so, make sure that the external database has the following parameters set to the specified values: - - `gtid_mode` – `ON` - - `enforce_gtid_consistency` – `ON` - - For more information, see [ Replication with global transaction identifiers](https://dev.mysql.com/doc/refman/8.0/en/replication-gtids.html) in the MySQL documentation\. - - 1. Make sure that the parameter group associated with the DB instance has the following parameter settings: - + `gtid_mode` – `ON`, `ON_PERMISSIVE`, or `OFF_PERMISSIVE` - + `enforce_gtid_consistency` – `ON` - - For more information about parameter groups, see [Working with parameter groups](USER_WorkingWithParamGroups.md)\. - - 1. If you changed the parameter group of the DB instance, reboot the DB instance\. For more information, see [Rebooting a DB instance](USER_RebootInstance.md)\. - -1. Make the source MySQL instance read\-only\. - - ``` - mysql> FLUSH TABLES WITH READ LOCK; - mysql> SET GLOBAL read_only = ON; - ``` - -1. Copy the database from the external instance to the Amazon RDS DB instance using `mysqldump`\. For very large databases, you might want to use the procedure in [Importing data to an Amazon RDS MariaDB or MySQL database with reduced downtime](MySQL.Procedural.Importing.NonRDSRepl.md)\. - - For Linux, macOS, or Unix: - - ``` - mysqldump --databases database_name \ - --single-transaction \ - --compress \ - --order-by-primary \ - -u local_user \ - -plocal_password | mysql \ - --host=hostname \ - --port=3306 \ - -u RDS_user_name \ - -pRDS_password - ``` - - For Windows: - - ``` - mysqldump --databases database_name ^ - --single-transaction ^ - --compress ^ - --order-by-primary ^ - -u local_user ^ - -plocal_password | mysql ^ - --host=hostname ^ - --port=3306 ^ - -u RDS_user_name ^ - -pRDS_password - ``` -**Note** -Make sure that there isn't a space between the `-p` option and the entered password\. - - To specify the host name, user name, port, and password to connect to your Amazon RDS DB instance, use the `--host`, `--user (-u)`, `--port` and `-p` options in the `mysql` command\. The host name is the Domain Name System \(DNS\) name from the Amazon RDS DB instance endpoint, for example, `myinstance.123456789012.us-east-1.rds.amazonaws.com`\. You can find the endpoint value in the instance details in the AWS Management Console\. - -1. Make the source MySQL instance writeable again\. - - ``` - mysql> SET GLOBAL read_only = OFF; - mysql> UNLOCK TABLES; - ``` - - For more information on making backups for use with replication, see [the MySQL documentation](https://dev.mysql.com/doc/refman/8.0/en/replication-solutions-backups-read-only.html)\. - -1. On the AWS Management Console, add the IP address of the server that hosts the external database to the virtual private cloud \(VPC\) security group for the Amazon RDS DB instance\. For more information on modifying a VPC security group, see [Security groups for your VPC](https://docs.aws.amazon.com/vpc/latest/userguide/VPC_SecurityGroups.html) in the *Amazon VPC User Guide*\. - - The IP address can change when the following conditions are met: - + You are using a public IP address for communication between the external source instance and the DB instance\. - + The external source instance was stopped and restarted\. - - If these conditions are met, verify the IP address before adding it\. - - You might also need to configure your local network to permit connections from the IP address of your Amazon RDS DB instance\. You do this so that your local network can communicate with your external MySQL instance\. To find the IP address of the Amazon RDS DB instance, use the `host` command\. - - ``` - host db_instance_endpoint - ``` - - The host name is the DNS name from the Amazon RDS DB instance endpoint\. - -1. Using the client of your choice, connect to the external instance and create a user to use for replication\. Use this account solely for replication\. and restrict it to your domain to improve security\. The following is an example\. - - ``` - CREATE USER 'repl_user'@'mydomain.com' IDENTIFIED BY 'password'; - ``` - -1. For the external instance, grant `REPLICATION CLIENT` and `REPLICATION SLAVE` privileges to your replication user\. For example, to grant the `REPLICATION CLIENT` and `REPLICATION SLAVE` privileges on all databases for the '`repl_user`' user for your domain, issue the following command\. - - ``` - GRANT REPLICATION CLIENT, REPLICATION SLAVE ON *.* TO 'repl_user'@'mydomain.com' IDENTIFIED BY 'password'; - ``` - -1. Make the Amazon RDS DB instance the replica\. To do so, first connect to the Amazon RDS DB instance as the master user\. Then identify the external MySQL database as the replication primary instance by using the [mysql\.rds\_set\_external\_master\_with\_auto\_position](mysql-stored-proc-replicating.md#mysql_rds_set_external_master_with_auto_position) command\. The following is an example\. - - ``` - CALL mysql.rds_set_external_master_with_auto_position ('mymasterserver.mydomain.com', 3306, 'repl_user', 'password', 0, 0); - ``` -**Note** -On RDS for MySQL, you can choose to use delayed replication by running the [mysql\.rds\_set\_external\_master\_with\_delay](mysql-stored-proc-replicating.md#mysql_rds_set_external_master_with_delay) stored procedure instead\. On RDS for MySQL, one reason to use delayed replication is to enable disaster recovery with the [mysql\.rds\_start\_replication\_until\_gtid](mysql-stored-proc-replicating.md#mysql_rds_start_replication_until_gtid) stored procedure\. - -1. On the Amazon RDS DB instance, issue the [mysql\.rds\_start\_replication](mysql-stored-proc-replicating.md#mysql_rds_start_replication) command to start replication\. - - ``` - CALL mysql.rds_start_replication; - ``` \ No newline at end of file diff --git a/doc_source/MySQL.Procedural.Importing.External.Repl.md b/doc_source/MySQL.Procedural.Importing.External.Repl.md deleted file mode 100644 index 6d554c1..0000000 --- a/doc_source/MySQL.Procedural.Importing.External.Repl.md +++ /dev/null @@ -1,131 +0,0 @@ -# Configuring binary log file position replication with an external source instance - -You can set up replication between an RDS for MySQL or MariaDB DB instance and a MySQL or MariaDB instance that is external to Amazon RDS using binary log file replication\. - -**Topics** -+ [Before you begin](#MySQL.Procedural.Importing.External.Repl.BeforeYouBegin) -+ [Configuring binary log file position replication with an external source instance](#MySQL.Procedural.Importing.External.Repl.Procedure) - -## Before you begin - -You can configure replication using the binary log file position of replicated transactions\. - -The permissions required to start replication on an Amazon RDS DB instance are restricted and not available to your Amazon RDS master user\. Because of this, make sure that you use the Amazon RDS [mysql\.rds\_set\_external\_master](mysql-stored-proc-replicating.md#mysql_rds_set_external_master) and [mysql\.rds\_start\_replication](mysql-stored-proc-replicating.md#mysql_rds_start_replication) commands to set up replication between your live database and your Amazon RDS database\. - -To set the binary logging format for a MySQL or MariaDB database, update the `binlog_format` parameter\. If your DB instance uses the default DB instance parameter group, create a new DB parameter group to modify `binlog_format` settings\. We recommend that you use the default setting for `binlog_format`, which is `MIXED`\. However, you can also set `binlog_format` to `ROW` or `STATEMENT` if you need a specific binary log \(binlog\) format\. Reboot your DB instance for the change to take effect\. - -For information about setting the `binlog_format` parameter, see [Configuring MySQL binary logging](USER_LogAccess.MySQL.BinaryFormat.md)\. For information about the implications of different MySQL replication types, see [Advantages and disadvantages of statement\-based and row\-based replication](https://dev.mysql.com/doc/refman/8.0/en/replication-sbr-rbr.html) in the MySQL documentation\. - -## Configuring binary log file position replication with an external source instance - -Follow these guidelines when you set up an external source instance and a replica on Amazon RDS: -+ Monitor failover events for the Amazon RDS DB instance that is your replica\. If a failover occurs, then the DB instance that is your replica might be recreated on a new host with a different network address\. For information on how to monitor failover events, see [Working with Amazon RDS event notification](USER_Events.md)\. -+ Maintain the binlogs on your source instance until you have verified that they have been applied to the replica\. This maintenance makes sure that you can restore your source instance in the event of a failure\. -+ Turn on automated backups on your Amazon RDS DB instance\. Turning on automated backups makes sure that you can restore your replica to a particular point in time if you need to re\-synchronize your source instance and replica\. For information on backups and point\-in\-time restore, see [Backing up and restoring](CHAP_CommonTasks.BackupRestore.md)\. - -**To configure binary log file replication with an external source instance** - -1. Make the source MySQL or MariaDB instance read\-only\. - - ``` - mysql> FLUSH TABLES WITH READ LOCK; - mysql> SET GLOBAL read_only = ON; - ``` - -1. Run the `SHOW MASTER STATUS` command on the source MySQL or MariaDB instance to determine the binlog location\. - - You receive output similar to the following example\. - - ``` - File Position - ------------------------------------ - mysql-bin-changelog.000031 107 - ------------------------------------ - ``` - -1. Copy the database from the external instance to the Amazon RDS DB instance using `mysqldump`\. For very large databases, you might want to use the procedure in [Importing data to an Amazon RDS MariaDB or MySQL database with reduced downtime](MySQL.Procedural.Importing.NonRDSRepl.md)\. - - For Linux, macOS, or Unix: - - ``` - mysqldump --databases database_name \ - --single-transaction \ - --compress \ - --order-by-primary \ - -u local_user \ - -plocal_password | mysql \ - --host=hostname \ - --port=3306 \ - -u RDS_user_name \ - -pRDS_password - ``` - - For Windows: - - ``` - mysqldump --databases database_name ^ - --single-transaction ^ - --compress ^ - --order-by-primary ^ - -u local_user ^ - -plocal_password | mysql ^ - --host=hostname ^ - --port=3306 ^ - -u RDS_user_name ^ - -pRDS_password - ``` -**Note** -Make sure that there isn't a space between the `-p` option and the entered password\. - - To specify the host name, user name, port, and password to connect to your Amazon RDS DB instance, use the `--host`, `--user (-u)`, `--port` and `-p` options in the `mysql` command\. The host name is the Domain Name Service \(DNS\) name from the Amazon RDS DB instance endpoint, for example `myinstance.123456789012.us-east-1.rds.amazonaws.com`\. You can find the endpoint value in the instance details in the AWS Management Console\. - -1. Make the source MySQL or MariaDB instance writeable again\. - - ``` - mysql> SET GLOBAL read_only = OFF; - mysql> UNLOCK TABLES; - ``` - - For more information on making backups for use with replication, see [the MySQL documentation](https://dev.mysql.com/doc/refman/8.0/en/replication-solutions-backups-read-only.html)\. - -1. In the AWS Management Console, add the IP address of the server that hosts the external database to the virtual private cloud \(VPC\) security group for the Amazon RDS DB instance\. For more information on modifying a VPC security group, see [Security groups for your VPC](https://docs.aws.amazon.com/vpc/latest/userguide/VPC_SecurityGroups.html) in the *Amazon Virtual Private Cloud User Guide*\. - - The IP address can change when the following conditions are met: - + You are using a public IP address for communication between the external source instance and the DB instance\. - + The external source instance was stopped and restarted\. - - If these conditions are met, verify the IP address before adding it\. - - You might also need to configure your local network to permit connections from the IP address of your Amazon RDS DB instance\. You do this so that your local network can communicate with your external MySQL or MariaDB instance\. To find the IP address of the Amazon RDS DB instance, use the `host` command\. - - ``` - host db_instance_endpoint - ``` - - The host name is the DNS name from the Amazon RDS DB instance endpoint\. - -1. Using the client of your choice, connect to the external instance and create a user to use for replication\. Use this account solely for replication and restrict it to your domain to improve security\. The following is an example\. - - ``` - CREATE USER 'repl_user'@'mydomain.com' IDENTIFIED BY 'password'; - ``` - -1. For the external instance, grant `REPLICATION CLIENT` and `REPLICATION SLAVE` privileges to your replication user\. For example, to grant the `REPLICATION CLIENT` and `REPLICATION SLAVE` privileges on all databases for the '`repl_user`' user for your domain, issue the following command\. - - ``` - GRANT REPLICATION CLIENT, REPLICATION SLAVE ON *.* TO 'repl_user'@'mydomain.com'; - ``` - -1. Make the Amazon RDS DB instance the replica\. To do so, first connect to the Amazon RDS DB instance as the master user\. Then identify the external MySQL or MariaDB database as the source instance by using the [mysql\.rds\_set\_external\_master](mysql-stored-proc-replicating.md#mysql_rds_set_external_master) command\. Use the master log file name and master log position that you determined in step 2\. The following is an example\. - - ``` - CALL mysql.rds_set_external_master ('mymasterserver.mydomain.com', 3306, 'repl_user', 'password', 'mysql-bin-changelog.000031', 107, 0); - ``` -**Note** -On RDS for MySQL, you can choose to use delayed replication by running the [mysql\.rds\_set\_external\_master\_with\_delay](mysql-stored-proc-replicating.md#mysql_rds_set_external_master_with_delay) stored procedure instead\. On RDS for MySQL, one reason to use delayed replication is to turn on disaster recovery with the [mysql\.rds\_start\_replication\_until](mysql-stored-proc-replicating.md#mysql_rds_start_replication_until) stored procedure\. Currently, RDS for MariaDB supports delayed replication but doesn't support the `mysql.rds_start_replication_until` procedure\. - -1. On the Amazon RDS DB instance, issue the [mysql\.rds\_start\_replication](mysql-stored-proc-replicating.md#mysql_rds_start_replication) command to start replication\. - - ``` - CALL mysql.rds_start_replication; - ``` \ No newline at end of file diff --git a/doc_source/MySQL.Procedural.Importing.External.ReplMariaDB.md b/doc_source/MySQL.Procedural.Importing.External.ReplMariaDB.md deleted file mode 100644 index 1b9307e..0000000 --- a/doc_source/MySQL.Procedural.Importing.External.ReplMariaDB.md +++ /dev/null @@ -1,131 +0,0 @@ -# Configuring binary log file position replication with an external source instance - -You can set up replication between an RDS for MySQL or MariaDB DB instance and a MySQL or MariaDB instance that is external to Amazon RDS using binary log file replication\. - -**Topics** -+ [Before you begin](#MySQL.Procedural.Importing.External.Repl.BeforeYouBegin) -+ [Configuring binary log file position replication with an external source instance](#MySQL.Procedural.Importing.External.Repl.Procedure) - -## Before you begin - -You can configure replication using the binary log file position of replicated transactions\. - -The permissions required to start replication on an Amazon RDS DB instance are restricted and not available to your Amazon RDS master user\. Because of this, make sure that you use the Amazon RDS [mysql\.rds\_set\_external\_master](mysql-stored-proc-replicating.md#mysql_rds_set_external_master) and [mysql\.rds\_start\_replication](mysql-stored-proc-replicating.md#mysql_rds_start_replication) commands to set up replication between your live database and your Amazon RDS database\. - -To set the binary logging format for a MySQL or MariaDB database, update the `binlog_format` parameter\. If your DB instance uses the default DB instance parameter group, create a new DB parameter group to modify `binlog_format` settings\. We recommend that you use the default setting for `binlog_format`, which is `MIXED`\. However, you can also set `binlog_format` to `ROW` or `STATEMENT` if you need a specific binary log \(binlog\) format\. Reboot your DB instance for the change to take effect\. - -For information about setting the `binlog_format` parameter, see [Configuring MySQL binary logging](USER_LogAccess.MySQL.BinaryFormat.md)\. For information about the implications of different MySQL replication types, see [Advantages and disadvantages of statement\-based and row\-based replication](https://dev.mysql.com/doc/refman/8.0/en/replication-sbr-rbr.html) in the MySQL documentation\. - -## Configuring binary log file position replication with an external source instance - -Follow these guidelines when you set up an external source instance and a replica on Amazon RDS: -+ Monitor failover events for the Amazon RDS DB instance that is your replica\. If a failover occurs, then the DB instance that is your replica might be recreated on a new host with a different network address\. For information on how to monitor failover events, see [Working with Amazon RDS event notification](USER_Events.md)\. -+ Maintain the binlogs on your source instance until you have verified that they have been applied to the replica\. This maintenance makes sure that you can restore your source instance in the event of a failure\. -+ Turn on automated backups on your Amazon RDS DB instance\. Turning on automated backups makes sure that you can restore your replica to a particular point in time if you need to re\-synchronize your source instance and replica\. For information on backups and point\-in\-time restore, see [Backing up and restoring](CHAP_CommonTasks.BackupRestore.md)\. - -**To configure binary log file replication with an external source instance** - -1. Make the source MySQL or MariaDB instance read\-only\. - - ``` - mysql> FLUSH TABLES WITH READ LOCK; - mysql> SET GLOBAL read_only = ON; - ``` - -1. Run the `SHOW MASTER STATUS` command on the source MySQL or MariaDB instance to determine the binlog location\. - - You receive output similar to the following example\. - - ``` - File Position - ------------------------------------ - mysql-bin-changelog.000031 107 - ------------------------------------ - ``` - -1. Copy the database from the external instance to the Amazon RDS DB instance using `mysqldump`\. For very large databases, you might want to use the procedure in [Importing data to an Amazon RDS MariaDB or MySQL database with reduced downtime](MySQL.Procedural.Importing.NonRDSRepl.md)\. - - For Linux, macOS, or Unix: - - ``` - mysqldump --databases database_name \ - --single-transaction \ - --compress \ - --order-by-primary \ - -u local_user \ - -plocal_password | mysql \ - --host=hostname \ - --port=3306 \ - -u RDS_user_name \ - -pRDS_password - ``` - - For Windows: - - ``` - mysqldump --databases database_name ^ - --single-transaction ^ - --compress ^ - --order-by-primary ^ - -u local_user ^ - -plocal_password | mysql ^ - --host=hostname ^ - --port=3306 ^ - -u RDS_user_name ^ - -pRDS_password - ``` -**Note** -Make sure that there isn't a space between the `-p` option and the entered password\. - - To specify the host name, user name, port, and password to connect to your Amazon RDS DB instance, use the `--host`, `--user (-u)`, `--port` and `-p` options in the `mysql` command\. The host name is the Domain Name Service \(DNS\) name from the Amazon RDS DB instance endpoint, for example `myinstance.123456789012.us-east-1.rds.amazonaws.com`\. You can find the endpoint value in the instance details in the AWS Management Console\. - -1. Make the source MySQL or MariaDB instance writeable again\. - - ``` - mysql> SET GLOBAL read_only = OFF; - mysql> UNLOCK TABLES; - ``` - - For more information on making backups for use with replication, see [the MySQL documentation](https://dev.mysql.com/doc/refman/8.0/en/replication-solutions-backups-read-only.html)\. - -1. In the AWS Management Console, add the IP address of the server that hosts the external database to the virtual private cloud \(VPC\) security group for the Amazon RDS DB instance\. For more information on modifying a VPC security group, see [Security groups for your VPC](https://docs.aws.amazon.com/vpc/latest/userguide/VPC_SecurityGroups.html) in the *Amazon Virtual Private Cloud User Guide*\. - - The IP address can change when the following conditions are met: - + You are using a public IP address for communication between the external source instance and the DB instance\. - + The external source instance was stopped and restarted\. - - If these conditions are met, verify the IP address before adding it\. - - You might also need to configure your local network to permit connections from the IP address of your Amazon RDS DB instance\. You do this so that your local network can communicate with your external MySQL or MariaDB instance\. To find the IP address of the Amazon RDS DB instance, use the `host` command\. - - ``` - host db_instance_endpoint - ``` - - The host name is the DNS name from the Amazon RDS DB instance endpoint\. - -1. Using the client of your choice, connect to the external instance and create a user to use for replication\. Use this account solely for replication and restrict it to your domain to improve security\. The following is an example\. - - ``` - CREATE USER 'repl_user'@'mydomain.com' IDENTIFIED BY 'password'; - ``` - -1. For the external instance, grant `REPLICATION CLIENT` and `REPLICATION SLAVE` privileges to your replication user\. For example, to grant the `REPLICATION CLIENT` and `REPLICATION SLAVE` privileges on all databases for the '`repl_user`' user for your domain, issue the following command\. - - ``` - GRANT REPLICATION CLIENT, REPLICATION SLAVE ON *.* TO 'repl_user'@'mydomain.com'; - ``` - -1. Make the Amazon RDS DB instance the replica\. To do so, first connect to the Amazon RDS DB instance as the master user\. Then identify the external MySQL or MariaDB database as the source instance by using the [mysql\.rds\_set\_external\_master](mysql-stored-proc-replicating.md#mysql_rds_set_external_master) command\. Use the master log file name and master log position that you determined in step 2\. The following is an example\. - - ``` - CALL mysql.rds_set_external_master ('mymasterserver.mydomain.com', 3306, 'repl_user', 'password', 'mysql-bin-changelog.000031', 107, 0); - ``` -**Note** -On RDS for MySQL, you can choose to use delayed replication by running the [mysql\.rds\_set\_external\_master\_with\_delay](mysql-stored-proc-replicating.md#mysql_rds_set_external_master_with_delay) stored procedure instead\. On RDS for MySQL, one reason to use delayed replication is to turn on disaster recovery with the [mysql\.rds\_start\_replication\_until](mysql-stored-proc-replicating.md#mysql_rds_start_replication_until) stored procedure\. Currently, RDS for MariaDB supports delayed replication but doesn't support the `mysql.rds_start_replication_until` procedure\. - -1. On the Amazon RDS DB instance, issue the [mysql\.rds\_start\_replication](mysql-stored-proc-replicating.md#mysql_rds_start_replication) command to start replication\. - - ``` - CALL mysql.rds_start_replication; - ``` \ No newline at end of file diff --git a/doc_source/MySQL.Procedural.Importing.NonRDSRepl.md b/doc_source/MySQL.Procedural.Importing.NonRDSRepl.md deleted file mode 100644 index 6aa4187..0000000 --- a/doc_source/MySQL.Procedural.Importing.NonRDSRepl.md +++ /dev/null @@ -1,432 +0,0 @@ -# Importing data to an Amazon RDS MariaDB or MySQL database with reduced downtime - -In some cases, you might need to import data from an external MariaDB or MySQL database that supports a live application to a MariaDB DB instance, a MySQL DB instance, or a MySQL Multi\-AZ DB cluster\. Use the following procedure to minimize the impact on availability of applications\. This procedure can also help if you are working with a very large database\. Using this procedure, you can reduce the cost of the import by reducing the amount of data that is passed across the network to AWS\. - -In this procedure, you transfer a copy of your database data to an Amazon EC2 instance and import the data into a new Amazon RDS database\. You then use replication to bring the Amazon RDS database up\-to\-date with your live external instance, before redirecting your application to the Amazon RDS database\. Configure MariaDB replication based on global transaction identifiers \(GTIDs\) if the external instance is MariaDB 10\.0\.24 or higher and the target instance is RDS for MariaDB\. Otherwise, configure replication based on binary log coordinates\. We recommend GTID\-based replication if your external database supports it because GTID\-based replication is a more reliable method\. For more information, see [Global transaction ID](http://mariadb.com/kb/en/mariadb/global-transaction-id/) in the MariaDB documentation\. - -**Note** -If you want to import data into a MySQL DB instance and your scenario supports it, we recommend moving data in and out of Amazon RDS by using backup files and Amazon S3\. For more information, see [Restoring a backup into a MySQL DB instance](MySQL.Procedural.Importing.md)\. - -![\[Import an external MySQL database to a MySQL database on RDS\]](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/images/MigrateMySQLToRDS_1.png) - -**Note** -We don't recommend that you use this procedure with source MySQL databases from MySQL versions earlier than version 5\.5 because of potential replication issues\. For more information, see [Replication compatibility between MySQL versions](https://dev.mysql.com/doc/refman/8.0/en/replication-compatibility.html) in the MySQL documentation\. - -## Create a copy of your existing database - -The first step in the process of migrating a large amount of data to an RDS for MariaDB or RDS for MySQL database with minimal downtime is to create a copy of the source data\. - -![\[Create a backup of the MySQL database\]](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/images/MigrateMySQLToRDS_2.png) - -You can use the mysqldump utility to create a database backup in either SQL or delimited\-text format\. We recommend that you do a test run with each format in a non\-production environment to see which method minimizes the amount of time that mysqldump runs\. - -We also recommend that you weigh mysqldump performance against the benefit offered by using the delimited\-text format for loading\. A backup using delimited\-text format creates a tab\-separated text file for each table being dumped\. To reduce the amount of time required to import your database, you can load these files in parallel using the `LOAD DATA LOCAL INFILE` command\. For more information about choosing a mysqldump format and then loading the data, see [ Using mysqldump for backups](https://dev.mysql.com/doc/mysql-backup-excerpt/8.0/en/using-mysqldump.html) in the MySQL documentation\. - -Before you start the backup operation, make sure to set the replication options on the MariaDB or MySQL database that you are copying to Amazon RDS\. The replication options include turning on binary logging and setting a unique server ID\. Setting these options causes your server to start logging database transactions and prepares it to be a source replication instance later in this process\. - -**Note** -Use the `--single-transaction` option with mysqldump because it dumps a consistent state of the database\. To ensure a valid dump file, don't run data definition language \(DDL\) statements while mysqldump is running\. You can schedule a maintenance window for these operations\. -Exclude the following schemas from the dump file: `sys`, `performance_schema`, and `information_schema`\. The mysqldump utility excludes these schemas by default\. -To migrate users and privileges, consider using a tool that generates the data control language \(DCL\) for recreating them, such as the [pt\-show\-grants](https://www.percona.com/doc/percona-toolkit/LATEST/pt-show-grants.html) utility\. - -### To set replication options - -1. Edit the `my.cnf` file \(this file is usually under `/etc`\)\. - - ``` - sudo vi /etc/my.cnf - ``` - - Add the `log_bin` and `server_id` options to the `[mysqld]` section\. The `log_bin` option provides a file name identifier for binary log files\. The `server_id` option provides a unique identifier for the server in source\-replica relationships\. - - The following example shows the updated `[mysqld]` section of a `my.cnf` file\. - - ``` - [mysqld] - log-bin=mysql-bin - server-id=1 - ``` - - For more information, see [the MySQL documentation](https://dev.mysql.com/doc/refman/8.0/en/replication-howto-masterbaseconfig.html)\. - -1. For replication with a Multi\-AZ DB cluster, set the `ENFORCE_GTID_CONSISTENCY` and the `GTID_MODE` parameter to `ON`\. - - ``` - mysql> SET @@GLOBAL.ENFORCE_GTID_CONSISTENCY = ON; - ``` - - ``` - mysql> SET @@GLOBAL.GTID_MODE = ON; - ``` - - These settings aren't required for replication with a DB instance\. - -1. Restart the `mysql` service\. - - ``` - sudo service mysqld restart - ``` - -### To create a backup copy of your existing database - -1. Create a backup of your data using the mysqldump utility, specifying either SQL or delimited\-text format\. - - Specify `--master-data=2` to create a backup file that can be used to start replication between servers\. For more information, see the [ mysqldump](https://dev.mysql.com/doc/refman/8.0/en/mysqldump.html#option_mysqldump_master-data) documentation\. - - To improve performance and ensure data integrity, use the `--order-by-primary` and `--single-transaction` options of mysqldump\. - - To avoid including the MySQL system database in the backup, do not use the `--all-databases` option with mysqldump\. For more information, see [ Creating a data snapshot using mysqldump](https://dev.mysql.com/doc/mysql-replication-excerpt/8.0/en/replication-howto-mysqldump.html) in the MySQL documentation\. - - Use `chmod` if necessary to make sure that the directory where the backup file is being created is writeable\. -**Important** -On Windows, run the command window as an administrator\. - + To produce SQL output, use the following command\. - - For Linux, macOS, or Unix: - - ``` - sudo mysqldump \ - --databases database_name \ - --master-data=2 \ - --single-transaction \ - --order-by-primary \ - -r backup.sql \ - -u local_user \ - -p password - ``` - - For Windows: - - ``` - mysqldump ^ - --databases database_name ^ - --master-data=2 ^ - --single-transaction ^ - --order-by-primary ^ - -r backup.sql ^ - -u local_user ^ - -p password - ``` - + To produce delimited\-text output, use the following command\. - - For Linux, macOS, or Unix: - - ``` - sudo mysqldump \ - --tab=target_directory \ - --fields-terminated-by ',' \ - --fields-enclosed-by '"' \ - --lines-terminated-by 0x0d0a \ - database_name \ - --master-data=2 \ - --single-transaction \ - --order-by-primary \ - -p password - ``` - - For Windows: - - ``` - mysqldump ^ - --tab=target_directory ^ - --fields-terminated-by "," ^ - --fields-enclosed-by """ ^ - --lines-terminated-by 0x0d0a ^ - database_name ^ - --master-data=2 ^ - --single-transaction ^ - --order-by-primary ^ - -p password - ``` -**Note** -Make sure to create any stored procedures, triggers, functions, or events manually in your Amazon RDS database\. If you have any of these objects in the database that you are copying, exclude them when you run mysqldump\. To do so, include the following arguments with your mysqldump command: `--routines=0 --triggers=0 --events=0`\. - - When using the delimited\-text format, a `CHANGE MASTER TO` comment is returned when you run mysqldump\. This comment contains the master log file name and position\. If the external instance is other than MariaDB version 10\.0\.24 or higher, note the values for `MASTER_LOG_FILE` and `MASTER_LOG_POS`\. You need these values when setting up replication\. - - ``` - -- Position to start replication or point-in-time recovery from - -- - -- CHANGE MASTER TO MASTER_LOG_FILE='mysql-bin-changelog.000031', MASTER_LOG_POS=107; - ``` - - If you are using SQL format, you can get the master log file name and position in the `CHANGE MASTER TO` comment in the backup file\. If the external instance is MariaDB version 10\.0\.24 or higher, you can get the GTID in the next step\. - -1. If the external instance you are using is MariaDB version 10\.0\.24 or higher, you use GTID\-based replication\. Run `SHOW MASTER STATUS` on the external MariaDB instance to get the binary log file name and position, then convert them to a GTID by running `BINLOG_GTID_POS` on the external MariaDB instance\. - - ``` - SELECT BINLOG_GTID_POS('binary log file name', binary log file position); - ``` - - Note the GTID returned; you need it to configure replication\. - -1. Compress the copied data to reduce the amount of network resources needed to copy your data to the Amazon RDS database\. Note the size of the backup file\. You need this information when determining how large an Amazon EC2 instance to create\. When you are done, compress the backup file using GZIP or your preferred compression utility\. - + To compress SQL output, use the following command\. - - ``` - gzip backup.sql - ``` - + To compress delimited\-text output, use the following command\. - - ``` - tar -zcvf backup.tar.gz target_directory - ``` - -## Create an Amazon EC2 instance and copy the compressed database - -Copying your compressed database backup file to an Amazon EC2 instance takes fewer network resources than doing a direct copy of uncompressed data between database instances\. After your data is in Amazon EC2, you can copy it from there directly to your MariaDB or MySQL database\. For you to save on the cost of network resources, your Amazon EC2 instance must be in the same AWS Region as your Amazon RDS DB instance\. Having the Amazon EC2 instance in the same AWS Region as your Amazon RDS database also reduces network latency during the import\. - -![\[Copy the database backup to an EC2 instance\]](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/images/MigrateMySQLToRDS_3.png) - -### To create an Amazon EC2 instance and copy your data - -1. In the AWS Region where you plan to create the RDS database, create a virtual private cloud \(VPC\), a VPC security group, and a VPC subnet\. Ensure that the inbound rules for your VPC security group allow the IP addresses required for your application to connect to AWS\. You can specify a range of IP addresses \(for example, `203.0.113.0/24`\), or another VPC security group\. You can use the [Amazon VPC Management Console](https://console.aws.amazon.com/vpc) to create and manage VPCs, subnets, and security groups\. For more information, see [Getting started with Amazon VPC](https://docs.aws.amazon.com/AmazonVPC/latest/GettingStartedGuide/GetStarted.html) in the *Amazon Virtual Private Cloud Getting Started Guide*\. - -1. Open the [Amazon EC2 Management Console](https://console.aws.amazon.com/ec2) and choose the AWS Region to contain both your Amazon EC2 instance and your Amazon RDS database\. Launch an Amazon EC2 instance using the VPC, subnet, and security group that you created in Step 1\. Ensure that you select an instance type with enough storage for your database backup file when it is uncompressed\. For details on Amazon EC2 instances, see [Getting started with Amazon EC2 Linux instances](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/EC2_GetStarted.html) in the *Amazon Elastic Compute Cloud User Guide for Linux*\. - -1. To connect to your Amazon RDS database from your Amazon EC2 instance, edit your VPC security group\. Add an inbound rule specifying the private IP address of your EC2 instance\. You can find the private IP address on the **Details** tab of the **Instance** pane in the EC2 console window\. To edit the VPC security group and add an inbound rule, choose **Security Groups** in the EC2 console navigation pane, choose your security group, and then add an inbound rule for MySQL or Aurora specifying the private IP address of your EC2 instance\. To learn how to add an inbound rule to a VPC security group, see [Adding and removing rules](https://docs.aws.amazon.com/vpc/latest/userguide/VPC_SecurityGroups.html#AddRemoveRules) in the *Amazon VPC User Guide*\. - -1. Copy your compressed database backup file from your local system to your Amazon EC2 instance\. Use `chmod` if necessary to make sure that you have write permission for the target directory of the Amazon EC2 instance\. You can use `scp` or a Secure Shell \(SSH\) client to copy the file\. The following is an example\. - - ``` - $ scp -r -i key pair.pem backup.sql.gz ec2-user@EC2 DNS:/target_directory/backup.sql.gz - ``` -**Important** -Be sure to copy sensitive data using a secure network transfer protocol\. - -1. Connect to your Amazon EC2 instance and install the latest updates and the MySQL client tools using the following commands\. - - ``` - sudo yum update -y - sudo yum install mysql -y - ``` - - For more information, see [Connect to your instance](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-connect-to-instance-linux.html) in the *Amazon Elastic Compute Cloud User Guide for Linux*\. -**Important** -This example installs the MySQL client on an Amazon Machine Image \(AMI\) for an Amazon Linux distribution\. To install the MySQL client on a different distribution, such as Ubuntu or Red Hat Enterprise Linux, this example doesn't work\. For information about installing MySQL, see [Installing and Upgrading MySQL](https://dev.mysql.com/doc/refman/8.0/en/installing.html) in the MySQL documentation\. - -1. While connected to your Amazon EC2 instance, decompress your database backup file\. The following are examples\. - + To decompress SQL output, use the following command\. - - ``` - gzip backup.sql.gz -d - ``` - + To decompress delimited\-text output, use the following command\. - - ``` - tar xzvf backup.tar.gz - ``` - -## Create a MySQL or MariaDB database and import data from your Amazon EC2 instance - -By creating a MariaDB DB instance, a MySQL DB instance, or a MySQL Multi\-AZ DB cluster in the same AWS Region as your Amazon EC2 instance, you can import the database backup file from EC2 faster than over the internet\. - -![\[Import the backup from the EC2 instance to the MySQL database\]](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/images/MigrateMySQLToRDS_4.png) - -### To create a MariaDB or MySQL database and import your data - -1. Determine which DB instance class and what amount of storage space is required to support the expected workload for this Amazon RDS database\. As part of this process, decide what is sufficient space and processing capacity for your data load procedures\. Also decide what is required to handle the production workload\. You can estimate this based on the size and resources of the source MariaDB or MySQL database\. For more information, see [DB instance classes](Concepts.DBInstanceClass.md)\. - -1. Create a DB instance or Multi\-AZ DB cluster in the AWS Region that contains your Amazon EC2 instance\. - - To create a MySQL Multi\-AZ DB cluster, follow the instructions in [Creating a Multi\-AZ DB cluster](create-multi-az-db-cluster.md)\. - - To create a MariaDB or MySQL DB instance, follow the instructions in [Creating an Amazon RDS DB instance](USER_CreateDBInstance.md) and use the following guidelines: - + Specify a DB engine version that is compatible with your source DB instance, as follows: - + If your source instance is MySQL 5\.5\.x, the Amazon RDS DB instance must be MySQL\. - + If your source instance is MySQL 5\.6\.x or 5\.7\.x, the Amazon RDS DB instance must be MySQL or MariaDB\. - + If your source instance is MySQL 8\.0\.x, the Amazon RDS DB instance must be MySQL 8\.0\.x\. - + If your source instance is MariaDB 5\.5 or higher, the Amazon RDS DB instance must be MariaDB\. - + Specify the same virtual private cloud \(VPC\) and VPC security group as for your Amazon EC2 instance\. This approach ensures that your Amazon EC2 instance and your Amazon RDS instance are visible to each other over the network\. Make sure your DB instance is publicly accessible\. To set up replication with your source database as described later, your DB instance must be publicly accessible\. - + Don't configure multiple Availability Zones, backup retention, or read replicas until after you have imported the database backup\. When that import is completed, you can configure Multi\-AZ and backup retention for the production instance\. - -1. Review the default configuration options for the Amazon RDS database\. If the default parameter group for the database doesn't have the configuration options that you want, find a different one that does or create a new parameter group\. For more information on creating a parameter group, see [Working with parameter groups](USER_WorkingWithParamGroups.md)\. - -1. Connect to the new Amazon RDS database as the master user\. Create the users required to support the administrators, applications, and services that need to access the instance\. The hostname for the Amazon RDS database is the **Endpoint** value for this instance without including the port number\. An example is `mysampledb.123456789012.us-west-2.rds.amazonaws.com`\. You can find the endpoint value in the database details in the Amazon RDS Management Console\. - -1. Connect to your Amazon EC2 instance\. For more information, see [Connect to your instance](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-connect-to-instance-linux.html) in the *Amazon Elastic Compute Cloud User Guide for Linux*\. - -1. Connect to your Amazon RDS database as a remote host from your Amazon EC2 instance using the `mysql` command\. The following is an example\. - - ``` - mysql -h host_name -P 3306 -u db_master_user -p - ``` - - The hostname is the Amazon RDS database endpoint\. - -1. At the `mysql` prompt, run the `source` command and pass it the name of your database dump file to load the data into the Amazon RDS DB instance: - + For SQL format, use the following command\. - - ``` - mysql> source backup.sql; - ``` - + For delimited\-text format, first create the database, if it isn't the default database you created when setting up the Amazon RDS database\. - - ``` - mysql> create database database_name; - $ mysql> use database_name; - ``` - - Then create the tables\. - - ``` - mysql> source table1.sql - $ mysql> source table2.sql - etc... - ``` - - Then import the data\. - - ``` - mysql> LOAD DATA LOCAL INFILE 'table1.txt' INTO TABLE table1 FIELDS TERMINATED BY ',' ENCLOSED BY '"' LINES TERMINATED BY '0x0d0a'; - $ mysql> LOAD DATA LOCAL INFILE 'table2.txt' INTO TABLE table2 FIELDS TERMINATED BY ',' ENCLOSED BY '"' LINES TERMINATED BY '0x0d0a'; - etc... - ``` - - To improve performance, you can perform these operations in parallel from multiple connections so that all of your tables are created and then loaded at the same time\. -**Note** -If you used any data\-formatting options with mysqldump when you initially dumped the table, make sure to use the same options with `mysqlimport` or LOAD DATA LOCAL INFILE to ensure proper interpretation of the data file contents\. - -1. Run a simple SELECT query against one or two of the tables in the imported database to verify that the import was successful\. - -If you no longer need the Amazon EC2 instance used in this procedure, terminate the EC2 instance to reduce your AWS resource usage\. To terminate an EC2 instance, see [Terminating an instance](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/terminating-instances.html#terminating-instances-console) in the *Amazon EC2 User Guide*\. - -## Replicate between your external database and new Amazon RDS database - -Your source database was likely updated during the time that it took to copy and transfer the data to the MariaDB or MySQL database\. Thus, you can use replication to bring the copied database up\-to\-date with the source database\. - -![\[Replicate data from the external MySQL database to the database on RDS\]](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/images/MigrateMySQLToRDS_5.png) - -The permissions required to start replication on an Amazon RDS database are restricted and not available to your Amazon RDS master user\. Because of this, make sure to use either the Amazon RDS [mysql\.rds\_set\_external\_master](mysql-stored-proc-replicating.md#mysql_rds_set_external_master) command or the [mysql\.rds\_set\_external\_master\_gtid](mysql_rds_set_external_master_gtid.md) command to configure replication, and the [mysql\.rds\_start\_replication](mysql-stored-proc-replicating.md#mysql_rds_start_replication) command to start replication between your live database and your Amazon RDS database\. - -### To start replication - -Earlier, you turned on binary logging and set a unique server ID for your source database\. Now you can set up your Amazon RDS database as a replica with your live database as the source replication instance\. - -1. In the Amazon RDS Management Console, add the IP address of the server that hosts the source database to the VPC security group for the Amazon RDS database\. For more information on modifying a VPC security group, see [Security groups for your VPC](https://docs.aws.amazon.com/vpc/latest/userguide/VPC_SecurityGroups.html) in the *Amazon Virtual Private Cloud User Guide*\. - - You might also need to configure your local network to permit connections from the IP address of your Amazon RDS database, so that it can communicate with your source instance\. To find the IP address of the Amazon RDS database, use the `host` command\. - - ``` - host rds_db_endpoint - ``` - - The hostname is the DNS name from the Amazon RDS database endpoint, for example `myinstance.123456789012.us-east-1.rds.amazonaws.com`\. You can find the endpoint value in the instance details in the Amazon RDS Management Console\. - -1. Using the client of your choice, connect to the source instance and create a user to be used for replication\. This account is used solely for replication and must be restricted to your domain to improve security\. The following is an example\. - - **MySQL 5\.5, 5\.6, and 5\.7** - - ``` - CREATE USER 'repl_user'@'mydomain.com' IDENTIFIED BY 'password'; - ``` - - **MySQL 8\.0** - - ``` - CREATE USER 'repl_user'@'mydomain.com' IDENTIFIED WITH mysql_native_password BY 'password'; - ``` - -1. For the source instance, grant `REPLICATION CLIENT` and `REPLICATION SLAVE` privileges to your replication user\. For example, to grant the `REPLICATION CLIENT` and `REPLICATION SLAVE` privileges on all databases for the '`repl_user`' user for your domain, issue the following command\. - - **MySQL 5\.5, 5\.6, and 5\.7** - - ``` - GRANT REPLICATION CLIENT, REPLICATION SLAVE ON *.* TO 'repl_user'@'mydomain.com' IDENTIFIED BY 'password'; - ``` - - **MySQL 8\.0** - - ``` - GRANT REPLICATION CLIENT, REPLICATION SLAVE ON *.* TO 'repl_user'@'mydomain.com'; - ``` - -1. If you used SQL format to create your backup file and the external instance is not MariaDB 10\.0\.24 or higher, look at the contents of that file\. - - ``` - cat backup.sql - ``` - - The file includes a `CHANGE MASTER TO` comment that contains the master log file name and position\. This comment is included in the backup file when you use the `--master-data` option with mysqldump\. Note the values for `MASTER_LOG_FILE` and `MASTER_LOG_POS`\. - - ``` - -- - -- Position to start replication or point-in-time recovery from - -- - - -- CHANGE MASTER TO MASTER_LOG_FILE='mysql-bin-changelog.000031', MASTER_LOG_POS=107; - ``` - - If you used delimited text format to create your backup file and the external instance isn't MariaDB 10\.0\.24 or higher, you should already have binary log coordinates from step 1 of the procedure at "To create a backup copy of your existing database" in this topic\. - - If the external instance is MariaDB 10\.0\.24 or higher, you should already have the GTID from which to start replication from step 2 of the procedure at "To create a backup copy of your existing database" in this topic\. - -1. Make the Amazon RDS database the replica\. If the external instance isn't MariaDB 10\.0\.24 or higher, connect to the Amazon RDS database as the master user and identify the source database as the source replication instance by using the [mysql\.rds\_set\_external\_master](mysql-stored-proc-replicating.md#mysql_rds_set_external_master) command\. Use the master log file name and master log position that you determined in the previous step if you have a SQL format backup file\. Or use the name and position that you determined when creating the backup files if you used delimited\-text format\. The following is an example\. - - ``` - CALL mysql.rds_set_external_master ('myserver.mydomain.com', 3306, - 'repl_user', 'password', 'mysql-bin-changelog.000031', 107, 0); - ``` - - If the external instance is MariaDB 10\.0\.24 or higher, connect to the Amazon RDS database as the master user and identify the source database as the source replication instance by using the [mysql\.rds\_set\_external\_master\_gtid](mysql_rds_set_external_master_gtid.md) command\. Use the GTID that you determined in step 2 of the procedure at "To create a backup copy of your existing database" in this topic\.\. The following is an example\. - - ``` - CALL mysql.rds_set_external_master_gtid ('source_server_ip_address', 3306, 'ReplicationUser', 'password', 'GTID', 0); - ``` - - The `source_server_ip_address` is the IP address of source replication instance\. An EC2 private DNS address is currently not supported\. - -1. On the Amazon RDS database, issue the [mysql\.rds\_start\_replication](mysql-stored-proc-replicating.md#mysql_rds_start_replication) command to start replication\. - - ``` - CALL mysql.rds_start_replication; - ``` - -1. On the Amazon RDS database, run the [SHOW REPLICA STATUS](https://dev.mysql.com/doc/refman/8.0/en/show-replica-status.html) command to determine when the replica is up\-to\-date with the source replication instance\. The results of the `SHOW REPLICA STATUS` command include the `Seconds_Behind_Master` field\. When the `Seconds_Behind_Master` field returns 0, then the replica is up\-to\-date with the source replication instance\. -**Note** -Previous versions of MySQL used `SHOW SLAVE STATUS` instead of `SHOW REPLICA STATUS`\. If you are using a MySQL version before 8\.0\.23, then use `SHOW SLAVE STATUS`\. - - For a MariaDB 10\.5 or 10\.6 DB instance, run the [mysql\.rds\_replica\_status](mysql_rds_replica_status.md) procedure instead of the MySQL command\. - -1. After the Amazon RDS database is up\-to\-date, turn on automated backups so you can restore that database if needed\. You can turn on or modify automated backups for your Amazon RDS database using the [Amazon RDS Management Console](https://console.aws.amazon.com/rds/)\. For more information, see [Working with backups](USER_WorkingWithAutomatedBackups.md)\. - -## Redirect your live application to your Amazon RDS instance - -After the MariaDB or MySQL database is up\-to\-date with the source replication instance, you can now update your live application to use the Amazon RDS instance\. - -![\[Stop replication and direct the live application to the database on RDS\]](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/images/MigrateMySQLToRDS_6.png) - -### To redirect your live application to your MariaDB or MySQL database and stop replication - -1. To add the VPC security group for the Amazon RDS database, add the IP address of the server that hosts the application\. For more information on modifying a VPC security group, see [Security groups for your VPC](https://docs.aws.amazon.com/vpc/latest/userguide/VPC_SecurityGroups.html) in the *Amazon Virtual Private Cloud User Guide*\. - -1. Verify that the `Seconds_Behind_Master` field in the [SHOW REPLICA STATUS](https://dev.mysql.com/doc/refman/8.0/en/show-replica-status.html) command results is 0, which indicates that the replica is up\-to\-date with the source replication instance\. - - ``` - SHOW REPLICA STATUS; - ``` -**Note** -Previous versions of MySQL used `SHOW SLAVE STATUS` instead of `SHOW REPLICA STATUS`\. If you are using a MySQL version before 8\.0\.23, then use `SHOW SLAVE STATUS`\. - - For a MariaDB 10\.5 or 10\.6 DB instance, run the [mysql\.rds\_replica\_status](mysql_rds_replica_status.md) procedure instead of the MySQL command\. - -1. Close all connections to the source when their transactions complete\. - -1. Update your application to use the Amazon RDS database\. This update typically involves changing the connection settings to identify the hostname and port of the Amazon RDS database, the user account and password to connect with, and the database to use\. - -1. Connect to the DB instance\. - - For a Multi\-AZ DB cluster, connect to the writer DB instance\. - -1. Stop replication for the Amazon RDS instance using the [mysql\.rds\_stop\_replication](mysql-stored-proc-replicating.md#mysql_rds_stop_replication) command\. - - ``` - CALL mysql.rds_stop_replication; - ``` - -1. Run the [mysql\.rds\_reset\_external\_master](mysql-stored-proc-replicating.md#mysql_rds_reset_external_master) command on your Amazon RDS database to reset the replication configuration so this instance is no longer identified as a replica\. - - ``` - CALL mysql.rds_reset_external_master; - ``` - -1. Turn on additional Amazon RDS features such as Multi\-AZ support and read replicas\. For more information, see [Configuring and managing a Multi\-AZ deployment](Concepts.MultiAZ.md) and [Working with DB instance read replicas](USER_ReadRepl.md)\. \ No newline at end of file diff --git a/doc_source/MySQL.Procedural.Importing.NonRDSReplMariaDB.md b/doc_source/MySQL.Procedural.Importing.NonRDSReplMariaDB.md deleted file mode 100644 index bdb0634..0000000 --- a/doc_source/MySQL.Procedural.Importing.NonRDSReplMariaDB.md +++ /dev/null @@ -1,432 +0,0 @@ -# Importing data to an Amazon RDS MariaDB or MySQL DB instance with reduced downtime - -In some cases, you might need to import data from an external MariaDB or MySQL database that supports a live application to a MariaDB DB instance, a MySQL DB instance, or a MySQL Multi\-AZ DB cluster\. Use the following procedure to minimize the impact on availability of applications\. This procedure can also help if you are working with a very large database\. Using this procedure, you can reduce the cost of the import by reducing the amount of data that is passed across the network to AWS\. - -In this procedure, you transfer a copy of your database data to an Amazon EC2 instance and import the data into a new Amazon RDS database\. You then use replication to bring the Amazon RDS database up\-to\-date with your live external instance, before redirecting your application to the Amazon RDS database\. Configure MariaDB replication based on global transaction identifiers \(GTIDs\) if the external instance is MariaDB 10\.0\.24 or higher and the target instance is RDS for MariaDB\. Otherwise, configure replication based on binary log coordinates\. We recommend GTID\-based replication if your external database supports it because GTID\-based replication is a more reliable method\. For more information, see [Global transaction ID](http://mariadb.com/kb/en/mariadb/global-transaction-id/) in the MariaDB documentation\. - -**Note** -If you want to import data into a MySQL DB instance and your scenario supports it, we recommend moving data in and out of Amazon RDS by using backup files and Amazon S3\. For more information, see [Restoring a backup into a MySQL DB instance](MySQL.Procedural.Importing.md)\. - -![\[Import an external MySQL database to a MySQL database on RDS\]](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/images/MigrateMySQLToRDS_1.png) - -**Note** -We don't recommend that you use this procedure with source MySQL databases from MySQL versions earlier than version 5\.5 because of potential replication issues\. For more information, see [Replication compatibility between MySQL versions](https://dev.mysql.com/doc/refman/8.0/en/replication-compatibility.html) in the MySQL documentation\. - -## Create a copy of your existing database - -The first step in the process of migrating a large amount of data to an RDS for MariaDB or RDS for MySQL database with minimal downtime is to create a copy of the source data\. - -![\[Create a backup of the MySQL database\]](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/images/MigrateMySQLToRDS_2.png) - -You can use the mysqldump utility to create a database backup in either SQL or delimited\-text format\. We recommend that you do a test run with each format in a non\-production environment to see which method minimizes the amount of time that mysqldump runs\. - -We also recommend that you weigh mysqldump performance against the benefit offered by using the delimited\-text format for loading\. A backup using delimited\-text format creates a tab\-separated text file for each table being dumped\. To reduce the amount of time required to import your database, you can load these files in parallel using the `LOAD DATA LOCAL INFILE` command\. For more information about choosing a mysqldump format and then loading the data, see [ Using mysqldump for backups](https://dev.mysql.com/doc/mysql-backup-excerpt/8.0/en/using-mysqldump.html) in the MySQL documentation\. - -Before you start the backup operation, make sure to set the replication options on the MariaDB or MySQL database that you are copying to Amazon RDS\. The replication options include turning on binary logging and setting a unique server ID\. Setting these options causes your server to start logging database transactions and prepares it to be a source replication instance later in this process\. - -**Note** -Use the `--single-transaction` option with mysqldump because it dumps a consistent state of the database\. To ensure a valid dump file, don't run data definition language \(DDL\) statements while mysqldump is running\. You can schedule a maintenance window for these operations\. -Exclude the following schemas from the dump file: `sys`, `performance_schema`, and `information_schema`\. The mysqldump utility excludes these schemas by default\. -To migrate users and privileges, consider using a tool that generates the data control language \(DCL\) for recreating them, such as the [pt\-show\-grants](https://www.percona.com/doc/percona-toolkit/LATEST/pt-show-grants.html) utility\. - -### To set replication options - -1. Edit the `my.cnf` file \(this file is usually under `/etc`\)\. - - ``` - sudo vi /etc/my.cnf - ``` - - Add the `log_bin` and `server_id` options to the `[mysqld]` section\. The `log_bin` option provides a file name identifier for binary log files\. The `server_id` option provides a unique identifier for the server in source\-replica relationships\. - - The following example shows the updated `[mysqld]` section of a `my.cnf` file\. - - ``` - [mysqld] - log-bin=mysql-bin - server-id=1 - ``` - - For more information, see [the MySQL documentation](https://dev.mysql.com/doc/refman/8.0/en/replication-howto-masterbaseconfig.html)\. - -1. For replication with a Multi\-AZ DB cluster, set the `ENFORCE_GTID_CONSISTENCY` and the `GTID_MODE` parameter to `ON`\. - - ``` - mysql> SET @@GLOBAL.ENFORCE_GTID_CONSISTENCY = ON; - ``` - - ``` - mysql> SET @@GLOBAL.GTID_MODE = ON; - ``` - - These settings aren't required for replication with a DB instance\. - -1. Restart the `mysql` service\. - - ``` - sudo service mysqld restart - ``` - -### To create a backup copy of your existing database - -1. Create a backup of your data using the mysqldump utility, specifying either SQL or delimited\-text format\. - - Specify `--master-data=2` to create a backup file that can be used to start replication between servers\. For more information, see the [ mysqldump](https://dev.mysql.com/doc/refman/8.0/en/mysqldump.html#option_mysqldump_master-data) documentation\. - - To improve performance and ensure data integrity, use the `--order-by-primary` and `--single-transaction` options of mysqldump\. - - To avoid including the MySQL system database in the backup, do not use the `--all-databases` option with mysqldump\. For more information, see [ Creating a data snapshot using mysqldump](https://dev.mysql.com/doc/mysql-replication-excerpt/8.0/en/replication-howto-mysqldump.html) in the MySQL documentation\. - - Use `chmod` if necessary to make sure that the directory where the backup file is being created is writeable\. -**Important** -On Windows, run the command window as an administrator\. - + To produce SQL output, use the following command\. - - For Linux, macOS, or Unix: - - ``` - sudo mysqldump \ - --databases database_name \ - --master-data=2 \ - --single-transaction \ - --order-by-primary \ - -r backup.sql \ - -u local_user \ - -p password - ``` - - For Windows: - - ``` - mysqldump ^ - --databases database_name ^ - --master-data=2 ^ - --single-transaction ^ - --order-by-primary ^ - -r backup.sql ^ - -u local_user ^ - -p password - ``` - + To produce delimited\-text output, use the following command\. - - For Linux, macOS, or Unix: - - ``` - sudo mysqldump \ - --tab=target_directory \ - --fields-terminated-by ',' \ - --fields-enclosed-by '"' \ - --lines-terminated-by 0x0d0a \ - database_name \ - --master-data=2 \ - --single-transaction \ - --order-by-primary \ - -p password - ``` - - For Windows: - - ``` - mysqldump ^ - --tab=target_directory ^ - --fields-terminated-by "," ^ - --fields-enclosed-by """ ^ - --lines-terminated-by 0x0d0a ^ - database_name ^ - --master-data=2 ^ - --single-transaction ^ - --order-by-primary ^ - -p password - ``` -**Note** -Make sure to create any stored procedures, triggers, functions, or events manually in your Amazon RDS database\. If you have any of these objects in the database that you are copying, exclude them when you run mysqldump\. To do so, include the following arguments with your mysqldump command: `--routines=0 --triggers=0 --events=0`\. - - When using the delimited\-text format, a `CHANGE MASTER TO` comment is returned when you run mysqldump\. This comment contains the master log file name and position\. If the external instance is other than MariaDB version 10\.0\.24 or higher, note the values for `MASTER_LOG_FILE` and `MASTER_LOG_POS`\. You need these values when setting up replication\. - - ``` - -- Position to start replication or point-in-time recovery from - -- - -- CHANGE MASTER TO MASTER_LOG_FILE='mysql-bin-changelog.000031', MASTER_LOG_POS=107; - ``` - - If you are using SQL format, you can get the master log file name and position in the `CHANGE MASTER TO` comment in the backup file\. If the external instance is MariaDB version 10\.0\.24 or higher, you can get the GTID in the next step\. - -1. If the external instance you are using is MariaDB version 10\.0\.24 or higher, you use GTID\-based replication\. Run `SHOW MASTER STATUS` on the external MariaDB instance to get the binary log file name and position, then convert them to a GTID by running `BINLOG_GTID_POS` on the external MariaDB instance\. - - ``` - SELECT BINLOG_GTID_POS('binary log file name', binary log file position); - ``` - - Note the GTID returned; you need it to configure replication\. - -1. Compress the copied data to reduce the amount of network resources needed to copy your data to the Amazon RDS database\. Note the size of the backup file\. You need this information when determining how large an Amazon EC2 instance to create\. When you are done, compress the backup file using GZIP or your preferred compression utility\. - + To compress SQL output, use the following command\. - - ``` - gzip backup.sql - ``` - + To compress delimited\-text output, use the following command\. - - ``` - tar -zcvf backup.tar.gz target_directory - ``` - -## Create an Amazon EC2 instance and copy the compressed database - -Copying your compressed database backup file to an Amazon EC2 instance takes fewer network resources than doing a direct copy of uncompressed data between database instances\. After your data is in Amazon EC2, you can copy it from there directly to your MariaDB or MySQL database\. For you to save on the cost of network resources, your Amazon EC2 instance must be in the same AWS Region as your Amazon RDS DB instance\. Having the Amazon EC2 instance in the same AWS Region as your Amazon RDS database also reduces network latency during the import\. - -![\[Copy the database backup to an EC2 instance\]](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/images/MigrateMySQLToRDS_3.png) - -### To create an Amazon EC2 instance and copy your data - -1. In the AWS Region where you plan to create the RDS database, create a virtual private cloud \(VPC\), a VPC security group, and a VPC subnet\. Ensure that the inbound rules for your VPC security group allow the IP addresses required for your application to connect to AWS\. You can specify a range of IP addresses \(for example, `203.0.113.0/24`\), or another VPC security group\. You can use the [Amazon VPC Management Console](https://console.aws.amazon.com/vpc) to create and manage VPCs, subnets, and security groups\. For more information, see [Getting started with Amazon VPC](https://docs.aws.amazon.com/AmazonVPC/latest/GettingStartedGuide/GetStarted.html) in the *Amazon Virtual Private Cloud Getting Started Guide*\. - -1. Open the [Amazon EC2 Management Console](https://console.aws.amazon.com/ec2) and choose the AWS Region to contain both your Amazon EC2 instance and your Amazon RDS database\. Launch an Amazon EC2 instance using the VPC, subnet, and security group that you created in Step 1\. Ensure that you select an instance type with enough storage for your database backup file when it is uncompressed\. For details on Amazon EC2 instances, see [Getting started with Amazon EC2 Linux instances](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/EC2_GetStarted.html) in the *Amazon Elastic Compute Cloud User Guide for Linux*\. - -1. To connect to your Amazon RDS database from your Amazon EC2 instance, edit your VPC security group\. Add an inbound rule specifying the private IP address of your EC2 instance\. You can find the private IP address on the **Details** tab of the **Instance** pane in the EC2 console window\. To edit the VPC security group and add an inbound rule, choose **Security Groups** in the EC2 console navigation pane, choose your security group, and then add an inbound rule for MySQL or Aurora specifying the private IP address of your EC2 instance\. To learn how to add an inbound rule to a VPC security group, see [Adding and removing rules](https://docs.aws.amazon.com/vpc/latest/userguide/VPC_SecurityGroups.html#AddRemoveRules) in the *Amazon VPC User Guide*\. - -1. Copy your compressed database backup file from your local system to your Amazon EC2 instance\. Use `chmod` if necessary to make sure that you have write permission for the target directory of the Amazon EC2 instance\. You can use `scp` or a Secure Shell \(SSH\) client to copy the file\. The following is an example\. - - ``` - $ scp -r -i key pair.pem backup.sql.gz ec2-user@EC2 DNS:/target_directory/backup.sql.gz - ``` -**Important** -Be sure to copy sensitive data using a secure network transfer protocol\. - -1. Connect to your Amazon EC2 instance and install the latest updates and the MySQL client tools using the following commands\. - - ``` - sudo yum update -y - sudo yum install mysql -y - ``` - - For more information, see [Connect to your instance](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-connect-to-instance-linux.html) in the *Amazon Elastic Compute Cloud User Guide for Linux*\. -**Important** -This example installs the MySQL client on an Amazon Machine Image \(AMI\) for an Amazon Linux distribution\. To install the MySQL client on a different distribution, such as Ubuntu or Red Hat Enterprise Linux, this example doesn't work\. For information about installing MySQL, see [Installing and Upgrading MySQL](https://dev.mysql.com/doc/refman/8.0/en/installing.html) in the MySQL documentation\. - -1. While connected to your Amazon EC2 instance, decompress your database backup file\. The following are examples\. - + To decompress SQL output, use the following command\. - - ``` - gzip backup.sql.gz -d - ``` - + To decompress delimited\-text output, use the following command\. - - ``` - tar xzvf backup.tar.gz - ``` - -## Create a MySQL or MariaDB database and import data from your Amazon EC2 instance - -By creating a MariaDB DB instance, a MySQL DB instance, or a MySQL Multi\-AZ DB cluster in the same AWS Region as your Amazon EC2 instance, you can import the database backup file from EC2 faster than over the internet\. - -![\[Import the backup from the EC2 instance to the MySQL database\]](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/images/MigrateMySQLToRDS_4.png) - -### To create a MariaDB or MySQL database and import your data - -1. Determine which DB instance class and what amount of storage space is required to support the expected workload for this Amazon RDS database\. As part of this process, decide what is sufficient space and processing capacity for your data load procedures\. Also decide what is required to handle the production workload\. You can estimate this based on the size and resources of the source MariaDB or MySQL database\. For more information, see [DB instance classes](Concepts.DBInstanceClass.md)\. - -1. Create a DB instance or Multi\-AZ DB cluster in the AWS Region that contains your Amazon EC2 instance\. - - To create a MySQL Multi\-AZ DB cluster, follow the instructions in [Creating a Multi\-AZ DB cluster](create-multi-az-db-cluster.md)\. - - To create a MariaDB or MySQL DB instance, follow the instructions in [Creating an Amazon RDS DB instance](USER_CreateDBInstance.md) and use the following guidelines: - + Specify a DB engine version that is compatible with your source DB instance, as follows: - + If your source instance is MySQL 5\.5\.x, the Amazon RDS DB instance must be MySQL\. - + If your source instance is MySQL 5\.6\.x or 5\.7\.x, the Amazon RDS DB instance must be MySQL or MariaDB\. - + If your source instance is MySQL 8\.0\.x, the Amazon RDS DB instance must be MySQL 8\.0\.x\. - + If your source instance is MariaDB 5\.5 or higher, the Amazon RDS DB instance must be MariaDB\. - + Specify the same virtual private cloud \(VPC\) and VPC security group as for your Amazon EC2 instance\. This approach ensures that your Amazon EC2 instance and your Amazon RDS instance are visible to each other over the network\. Make sure your DB instance is publicly accessible\. To set up replication with your source database as described later, your DB instance must be publicly accessible\. - + Don't configure multiple Availability Zones, backup retention, or read replicas until after you have imported the database backup\. When that import is completed, you can configure Multi\-AZ and backup retention for the production instance\. - -1. Review the default configuration options for the Amazon RDS database\. If the default parameter group for the database doesn't have the configuration options that you want, find a different one that does or create a new parameter group\. For more information on creating a parameter group, see [Working with parameter groups](USER_WorkingWithParamGroups.md)\. - -1. Connect to the new Amazon RDS database as the master user\. Create the users required to support the administrators, applications, and services that need to access the instance\. The hostname for the Amazon RDS database is the **Endpoint** value for this instance without including the port number\. An example is `mysampledb.123456789012.us-west-2.rds.amazonaws.com`\. You can find the endpoint value in the database details in the Amazon RDS Management Console\. - -1. Connect to your Amazon EC2 instance\. For more information, see [Connect to your instance](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-connect-to-instance-linux.html) in the *Amazon Elastic Compute Cloud User Guide for Linux*\. - -1. Connect to your Amazon RDS database as a remote host from your Amazon EC2 instance using the `mysql` command\. The following is an example\. - - ``` - mysql -h host_name -P 3306 -u db_master_user -p - ``` - - The hostname is the Amazon RDS database endpoint\. - -1. At the `mysql` prompt, run the `source` command and pass it the name of your database dump file to load the data into the Amazon RDS DB instance: - + For SQL format, use the following command\. - - ``` - mysql> source backup.sql; - ``` - + For delimited\-text format, first create the database, if it isn't the default database you created when setting up the Amazon RDS database\. - - ``` - mysql> create database database_name; - $ mysql> use database_name; - ``` - - Then create the tables\. - - ``` - mysql> source table1.sql - $ mysql> source table2.sql - etc... - ``` - - Then import the data\. - - ``` - mysql> LOAD DATA LOCAL INFILE 'table1.txt' INTO TABLE table1 FIELDS TERMINATED BY ',' ENCLOSED BY '"' LINES TERMINATED BY '0x0d0a'; - $ mysql> LOAD DATA LOCAL INFILE 'table2.txt' INTO TABLE table2 FIELDS TERMINATED BY ',' ENCLOSED BY '"' LINES TERMINATED BY '0x0d0a'; - etc... - ``` - - To improve performance, you can perform these operations in parallel from multiple connections so that all of your tables are created and then loaded at the same time\. -**Note** -If you used any data\-formatting options with mysqldump when you initially dumped the table, make sure to use the same options with `mysqlimport` or LOAD DATA LOCAL INFILE to ensure proper interpretation of the data file contents\. - -1. Run a simple SELECT query against one or two of the tables in the imported database to verify that the import was successful\. - -If you no longer need the Amazon EC2 instance used in this procedure, terminate the EC2 instance to reduce your AWS resource usage\. To terminate an EC2 instance, see [Terminating an instance](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/terminating-instances.html#terminating-instances-console) in the *Amazon EC2 User Guide*\. - -## Replicate between your external database and new Amazon RDS database - -Your source database was likely updated during the time that it took to copy and transfer the data to the MariaDB or MySQL database\. Thus, you can use replication to bring the copied database up\-to\-date with the source database\. - -![\[Replicate data from the external MySQL database to the database on RDS\]](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/images/MigrateMySQLToRDS_5.png) - -The permissions required to start replication on an Amazon RDS database are restricted and not available to your Amazon RDS master user\. Because of this, make sure to use either the Amazon RDS [mysql\.rds\_set\_external\_master](mysql-stored-proc-replicating.md#mysql_rds_set_external_master) command or the [mysql\.rds\_set\_external\_master\_gtid](mysql_rds_set_external_master_gtid.md) command to configure replication, and the [mysql\.rds\_start\_replication](mysql-stored-proc-replicating.md#mysql_rds_start_replication) command to start replication between your live database and your Amazon RDS database\. - -### To start replication - -Earlier, you turned on binary logging and set a unique server ID for your source database\. Now you can set up your Amazon RDS database as a replica with your live database as the source replication instance\. - -1. In the Amazon RDS Management Console, add the IP address of the server that hosts the source database to the VPC security group for the Amazon RDS database\. For more information on modifying a VPC security group, see [Security groups for your VPC](https://docs.aws.amazon.com/vpc/latest/userguide/VPC_SecurityGroups.html) in the *Amazon Virtual Private Cloud User Guide*\. - - You might also need to configure your local network to permit connections from the IP address of your Amazon RDS database, so that it can communicate with your source instance\. To find the IP address of the Amazon RDS database, use the `host` command\. - - ``` - host rds_db_endpoint - ``` - - The hostname is the DNS name from the Amazon RDS database endpoint, for example `myinstance.123456789012.us-east-1.rds.amazonaws.com`\. You can find the endpoint value in the instance details in the Amazon RDS Management Console\. - -1. Using the client of your choice, connect to the source instance and create a user to be used for replication\. This account is used solely for replication and must be restricted to your domain to improve security\. The following is an example\. - - **MySQL 5\.5, 5\.6, and 5\.7** - - ``` - CREATE USER 'repl_user'@'mydomain.com' IDENTIFIED BY 'password'; - ``` - - **MySQL 8\.0** - - ``` - CREATE USER 'repl_user'@'mydomain.com' IDENTIFIED WITH mysql_native_password BY 'password'; - ``` - -1. For the source instance, grant `REPLICATION CLIENT` and `REPLICATION SLAVE` privileges to your replication user\. For example, to grant the `REPLICATION CLIENT` and `REPLICATION SLAVE` privileges on all databases for the '`repl_user`' user for your domain, issue the following command\. - - **MySQL 5\.5, 5\.6, and 5\.7** - - ``` - GRANT REPLICATION CLIENT, REPLICATION SLAVE ON *.* TO 'repl_user'@'mydomain.com' IDENTIFIED BY 'password'; - ``` - - **MySQL 8\.0** - - ``` - GRANT REPLICATION CLIENT, REPLICATION SLAVE ON *.* TO 'repl_user'@'mydomain.com'; - ``` - -1. If you used SQL format to create your backup file and the external instance is not MariaDB 10\.0\.24 or higher, look at the contents of that file\. - - ``` - cat backup.sql - ``` - - The file includes a `CHANGE MASTER TO` comment that contains the master log file name and position\. This comment is included in the backup file when you use the `--master-data` option with mysqldump\. Note the values for `MASTER_LOG_FILE` and `MASTER_LOG_POS`\. - - ``` - -- - -- Position to start replication or point-in-time recovery from - -- - - -- CHANGE MASTER TO MASTER_LOG_FILE='mysql-bin-changelog.000031', MASTER_LOG_POS=107; - ``` - - If you used delimited text format to create your backup file and the external instance isn't MariaDB 10\.0\.24 or higher, you should already have binary log coordinates from step 1 of the procedure at "To create a backup copy of your existing database" in this topic\. - - If the external instance is MariaDB 10\.0\.24 or higher, you should already have the GTID from which to start replication from step 2 of the procedure at "To create a backup copy of your existing database" in this topic\. - -1. Make the Amazon RDS database the replica\. If the external instance isn't MariaDB 10\.0\.24 or higher, connect to the Amazon RDS database as the master user and identify the source database as the source replication instance by using the [mysql\.rds\_set\_external\_master](mysql-stored-proc-replicating.md#mysql_rds_set_external_master) command\. Use the master log file name and master log position that you determined in the previous step if you have a SQL format backup file\. Or use the name and position that you determined when creating the backup files if you used delimited\-text format\. The following is an example\. - - ``` - CALL mysql.rds_set_external_master ('myserver.mydomain.com', 3306, - 'repl_user', 'password', 'mysql-bin-changelog.000031', 107, 0); - ``` - - If the external instance is MariaDB 10\.0\.24 or higher, connect to the Amazon RDS database as the master user and identify the source database as the source replication instance by using the [mysql\.rds\_set\_external\_master\_gtid](mysql_rds_set_external_master_gtid.md) command\. Use the GTID that you determined in step 2 of the procedure at "To create a backup copy of your existing database" in this topic\.\. The following is an example\. - - ``` - CALL mysql.rds_set_external_master_gtid ('source_server_ip_address', 3306, 'ReplicationUser', 'password', 'GTID', 0); - ``` - - The `source_server_ip_address` is the IP address of source replication instance\. An EC2 private DNS address is currently not supported\. - -1. On the Amazon RDS database, issue the [mysql\.rds\_start\_replication](mysql-stored-proc-replicating.md#mysql_rds_start_replication) command to start replication\. - - ``` - CALL mysql.rds_start_replication; - ``` - -1. On the Amazon RDS database, run the [SHOW REPLICA STATUS](https://dev.mysql.com/doc/refman/8.0/en/show-replica-status.html) command to determine when the replica is up\-to\-date with the source replication instance\. The results of the `SHOW REPLICA STATUS` command include the `Seconds_Behind_Master` field\. When the `Seconds_Behind_Master` field returns 0, then the replica is up\-to\-date with the source replication instance\. -**Note** -Previous versions of MySQL used `SHOW SLAVE STATUS` instead of `SHOW REPLICA STATUS`\. If you are using a MySQL version before 8\.0\.23, then use `SHOW SLAVE STATUS`\. - - For a MariaDB 10\.5 or 10\.6 DB instance, run the [mysql\.rds\_replica\_status](mysql_rds_replica_status.md) procedure instead of the MySQL command\. - -1. After the Amazon RDS database is up\-to\-date, turn on automated backups so you can restore that database if needed\. You can turn on or modify automated backups for your Amazon RDS database using the [Amazon RDS Management Console](https://console.aws.amazon.com/rds/)\. For more information, see [Working with backups](USER_WorkingWithAutomatedBackups.md)\. - -## Redirect your live application to your Amazon RDS instance - -After the MariaDB or MySQL database is up\-to\-date with the source replication instance, you can now update your live application to use the Amazon RDS instance\. - -![\[Stop replication and direct the live application to the database on RDS\]](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/images/MigrateMySQLToRDS_6.png) - -### To redirect your live application to your MariaDB or MySQL database and stop replication - -1. To add the VPC security group for the Amazon RDS database, add the IP address of the server that hosts the application\. For more information on modifying a VPC security group, see [Security groups for your VPC](https://docs.aws.amazon.com/vpc/latest/userguide/VPC_SecurityGroups.html) in the *Amazon Virtual Private Cloud User Guide*\. - -1. Verify that the `Seconds_Behind_Master` field in the [SHOW REPLICA STATUS](https://dev.mysql.com/doc/refman/8.0/en/show-replica-status.html) command results is 0, which indicates that the replica is up\-to\-date with the source replication instance\. - - ``` - SHOW REPLICA STATUS; - ``` -**Note** -Previous versions of MySQL used `SHOW SLAVE STATUS` instead of `SHOW REPLICA STATUS`\. If you are using a MySQL version before 8\.0\.23, then use `SHOW SLAVE STATUS`\. - - For a MariaDB 10\.5 or 10\.6 DB instance, run the [mysql\.rds\_replica\_status](mysql_rds_replica_status.md) procedure instead of the MySQL command\. - -1. Close all connections to the source when their transactions complete\. - -1. Update your application to use the Amazon RDS database\. This update typically involves changing the connection settings to identify the hostname and port of the Amazon RDS database, the user account and password to connect with, and the database to use\. - -1. Connect to the DB instance\. - - For a Multi\-AZ DB cluster, connect to the writer DB instance\. - -1. Stop replication for the Amazon RDS instance using the [mysql\.rds\_stop\_replication](mysql-stored-proc-replicating.md#mysql_rds_stop_replication) command\. - - ``` - CALL mysql.rds_stop_replication; - ``` - -1. Run the [mysql\.rds\_reset\_external\_master](mysql-stored-proc-replicating.md#mysql_rds_reset_external_master) command on your Amazon RDS database to reset the replication configuration so this instance is no longer identified as a replica\. - - ``` - CALL mysql.rds_reset_external_master; - ``` - -1. Turn on additional Amazon RDS features such as Multi\-AZ support and read replicas\. For more information, see [Configuring and managing a Multi\-AZ deployment](Concepts.MultiAZ.md) and [Working with DB instance read replicas](USER_ReadRepl.md)\. \ No newline at end of file diff --git a/doc_source/MySQL.Procedural.Importing.Other.md b/doc_source/MySQL.Procedural.Importing.Other.md deleted file mode 100644 index aba32d2..0000000 --- a/doc_source/MySQL.Procedural.Importing.Other.md +++ /dev/null @@ -1,124 +0,0 @@ -# Importing data into a MySQL DB instance - -You can use several different techniques to import data into an RDS for MySQL DB instance\. The best approach depends on the source of the data, the amount of data, and whether the import is done one time or is ongoing\. If you are migrating an application along with the data, also consider the amount of downtime that you are willing to experience\. - -## Overview - -Find techniques to import data into an RDS for MySQL DB instance in the following table\. - - -**** - -| Source | Amount of data | One time or ongoing | Application downtime | Technique | More information | -| --- | --- | --- | --- | --- | --- | -| Existing MySQL database on premises or on Amazon EC2 | Any | One time | Some | Create a backup of your on\-premises database, store it on Amazon S3, and then restore the backup file to a new Amazon RDS DB instance running MySQL\. | [Restoring a backup into a MySQL DB instance](MySQL.Procedural.Importing.md) | -| Any existing database | Any | One time or ongoing | Minimal | Use AWS Database Migration Service to migrate the database with minimal downtime and, for many database DB engines, continue ongoing replication\. | [What is AWS Database Migration Service](https://docs.aws.amazon.com/dms/latest/userguide/Welcome.html) and [Using a MySQL\-compatible database as a target for AWS DMS](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Target.MySQL.html) in the AWS Database Migration Service User Guide | -| Existing MySQL DB instance | Any | One time or ongoing | Minimal | Create a read replica for ongoing replication\. Promote the read replica for one\-time creation of a new DB instance\. | [Working with DB instance read replicas](USER_ReadRepl.md) | -| Existing MariaDB or MySQL database | Small | One time | Some | Copy the data directly to your MySQL DB instance using a command\-line utility\. | [Importing data from a MariaDB or MySQL database to a MariaDB or MySQL DB instance](MySQL.Procedural.Importing.SmallExisting.md) | -| Data not stored in an existing database | Medium | One time | Some | Create flat files and import them using the mysqlimport utility\. | [Importing data from any source to a MariaDB or MySQL DB instance](MySQL.Procedural.Importing.AnySource.md) | -| Existing MariaDB or MySQL database on premises or on Amazon EC2 | Any | Ongoing | Minimal | Configure replication with an existing MariaDB or MySQL database as the replication source\. | [Configuring binary log file position replication with an external source instance](MySQL.Procedural.Importing.External.Repl.md) [Importing data to an Amazon RDS MariaDB or MySQL database with reduced downtime](MySQL.Procedural.Importing.NonRDSRepl.md) | - -**Note** -The `'mysql'` system database contains authentication and authorization information required to log in to your DB instance and access your data\. Dropping, altering, renaming, or truncating tables, data, or other contents of the `'mysql'` database in your DB instance can result in error and might render the DB instance and your data inaccessible\. If this occurs, you can restore the DB instance from a snapshot using the AWS CLI `restore-db-instance-from-db-snapshot` command\. You can recover the DB instance using the AWS CLI `restore-db-instance-to-point-in-time` command\. - -## Importing data considerations - -Following, you can find additional technical information related to loading data into MySQL\. This information is intended for advanced users who are familiar with the MySQL server architecture\. All comments related to LOAD DATA LOCAL INFILE also apply to `mysqlimport`\. - -### Binary log - -Data loads incur a performance penalty and require additional free disk space \(up to four times more\) when binary logging is enabled versus loading the same data with binary logging turned off\. The severity of the performance penalty and the amount of free disk space required is directly proportional to the size of the transactions used to load the data\. - -### Transaction size - -Transaction size plays an important role in MySQL data loads\. It has a major influence on resource consumption, disk space utilization, resume process, time to recover, and input format \(flat files or SQL\)\. This section describes how transaction size affects binary logging and makes the case for disabling binary logging during large data loads\. As noted earlier, binary logging is enabled and disabled by setting the Amazon RDS automated backup retention period\. Non\-zero values enable binary logging, and zero disables it\. We also describe the impact of large transactions on InnoDB and why it's important to keep transaction sizes small\. - -#### Small transactions - -For small transactions, binary logging doubles the number of disk writes required to load the data\. This effect can severely degrade performance for other database sessions and increase the time required to load the data\. The degradation experienced depends in part upon the upload rate, other database activity taking place during the load, and the capacity of your Amazon RDS DB instance\. - -The binary logs also consume disk space roughly equal to the amount of data loaded until they are backed up and removed\. Fortunately, Amazon RDS minimizes this by backing up and removing binary logs on a frequent basis\. - -#### Large transactions - -Large transactions incur a 3X penalty for IOPS and disk consumption with binary logging enabled\. This is due to the binary log cache spilling to disk, consuming disk space and incurring additional IO for each write\. The cache cannot be written to the binlog until the transaction commits or rolls back, so it consumes disk space in proportion to the amount of data loaded\. When the transaction commits, the cache must be copied to the binlog, creating a third copy of the data on disk\. - -Because of this, there must be at least three times as much free disk space available to load the data compared to loading with binary logging disabled\. For example, 10 GiB of data loaded as a single transaction consumes at least 30 GiB disk space during the load\. It consumes 10 GiB for the table \+ 10 GiB for the binary log cache \+ 10 GiB for the binary log itself\. The cache file remains on disk until the session that created it terminates or the session fills its binary log cache again during another transaction\. The binary log must remain on disk until backed up, so it might be some time before the extra 20 GiB is freed\. - -If the data was loaded using LOAD DATA LOCAL INFILE, yet another copy of the data is created if the database has to be recovered from a backup made before the load\. During recovery, MySQL extracts the data from the binary log into a flat file\. MySQL then runs LOAD DATA LOCAL INFILE, just as in the original transaction\. However, this time the input file is local to the database server\. Continuing with the example preceding, recovery fails unless there is at least 40 GiB free disk space available\. - -#### Disable binary logging - -Whenever possible, disable binary logging during large data loads to avoid the resource overhead and addition disk space requirements\. In Amazon RDS, disabling binary logging is as simple as setting the backup retention period to zero\. If you do this, we recommend that you take a DB snapshot of the database instance immediately before the load\. By doing this, you can quickly and easily undo changes made during loading if you need to\. - -After the load, set the backup retention period back to an appropriate \(no zero\) value\. - -You can't set the backup retention period to zero if the DB instance is a source DB instance for read replicas\. - -### InnoDB - -The information in this section provides a strong argument for keeping transaction sizes small when using InnoDB\. - -#### Undo - -InnoDB generates undo to support features such as transaction rollback and MVCC\. Undo is stored in the InnoDB system tablespace \(usually ibdata1\) and is retained until removed by the purge thread\. The purge thread cannot advance beyond the undo of the oldest active transaction, so it is effectively blocked until the transaction commits or completes a rollback\. If the database is processing other transactions during the load, their undo also accumulates in the system tablespace and cannot be removed even if they commit and no other transaction needs the undo for MVCC\. In this situation, all transactions \(including read\-only transactions\) that access any of the rows changed by any transaction \(not just the load transaction\) slow down\. The slowdown occurs because transactions scan through undo that could have been purged if not for the long\-running load transaction\. - -Undo is stored in the system tablespace, and the system tablespace never shrinks in size\. Thus, large data load transactions can cause the system tablespace to become quite large, consuming disk space that you can't reclaim without recreating the database from scratch\. - -#### Rollback - -InnoDB is optimized for commits\. Rolling back a large transaction can take a very, very long time\. In some cases, it might be faster to perform a point\-in\-time recovery or restore a DB snapshot\. - -### Input data format - -MySQL can accept incoming data in one of two forms: flat files and SQL\. This section points out some key advantages and disadvantages of each\. - -#### Flat files - -Loading flat files with LOAD DATA LOCAL INFILE can be the fastest and least costly method of loading data as long as transactions are kept relatively small\. Compared to loading the same data with SQL, flat files usually require less network traffic, lowering transmission costs and load much faster due to the reduced overhead in the database\. - -#### One big transaction - -LOAD DATA LOCAL INFILE loads the entire flat file as one transaction\. This isn't necessarily a bad thing\. If the size of the individual files can be kept small, this has a number of advantages: -+ Resume capability – Keeping track of which files have been loaded is easy\. If a problem arises during the load, you can pick up where you left off with little effort\. Some data might have to be retransmitted to Amazon RDS, but with small files, the amount retransmitted is minimal\. -+ Load data in parallel – If you've got IOPS and network bandwidth to spare with a single file load, loading in parallel might save time\. -+ Throttle the load rate – Data load having a negative impact on other processes? Throttle the load by increasing the interval between files\. - -#### Be careful - -The advantages of LOAD DATA LOCAL INFILE diminish rapidly as transaction size increases\. If breaking up a large set of data into smaller ones isn't an option, SQL might be the better choice\. - -#### SQL - -SQL has one main advantage over flat files: it's easy to keep transaction sizes small\. However, SQL can take significantly longer to load than flat files and it can be difficult to determine where to resume the load after a failure\. For example, mysqldump files are not restartable\. If a failure occurs while loading a mysqldump file, the file requires modification or replacement before the load can resume\. The alternative is to restore to the point in time before the load and replay the file after the cause of the failure has been corrected\. - -### Take checkpoints using Amazon RDS snapshots - -If you have a load that's going to take several hours or even days, loading without binary logging isn't a very attractive prospect unless you can take periodic checkpoints\. This is where the Amazon RDS DB snapshot feature comes in very handy\. A DB snapshot creates a point\-in\-time consistent copy of your database instance which can be used restore the database to that point in time after a crash or other mishap\. - -To create a checkpoint, simply take a DB snapshot\. Any previous DB snapshots taken for checkpoints can be removed without affecting durability or restore time\. - -Snapshots are fast too, so frequent checkpointing doesn't add significantly to load time\. - -### Decreasing load time - -Here are some additional tips to reduce load times: -+ Create all secondary indexes before loading\. This is counter\-intuitive for those familiar with other databases\. Adding or modifying a secondary index causes MySQL to create a new table with the index changes, copy the data from the existing table to the new table, and drop the original table\. -+ Load data in PK order\. This is particularly helpful for InnoDB tables, where load times can be reduced by 75–80 percent and data file size cut in half\. -+ Disable foreign key constraints foreign\_key\_checks=0\. For flat files loaded with LOAD DATA LOCAL INFILE, this is required in many cases\. For any load, disabling FK checks provides significant performance gains\. Just be sure to enable the constraints and verify the data after the load\. -+ Load in parallel unless already near a resource limit\. Use partitioned tables when appropriate\. -+ Use multi\-value inserts when loading with SQL to minimize overhead when running statements\. When using mysqldump, this is done automatically\. -+ Reduce InnoDB log IO innodb\_flush\_log\_at\_trx\_commit=0 -+ If you are loading data into a DB instance that does not have read replicas, set the sync\_binlog parameter to 0 while loading data\. When data loading is complete, set the sync\_binlog parameter to back to 1\. -+ Load data before converting the DB instance to a Multi\-AZ deployment\. However, if the DB instance already uses a Multi\-AZ deployment, switching to a Single\-AZ deployment for data loading is not recommended, because doing so only provides marginal improvements\. - -**Note** -Using innodb\_flush\_log\_at\_trx\_commit=0 causes InnoDB to flush its logs every second instead of at each commit\. This provides a significant speed advantage, but can lead to data loss during a crash\. Use with caution\. - -**Topics** -+ [Overview](#MySQL.Procedural.Importing.Overview) -+ [Importing data considerations](#MySQL.Procedural.Importing.Advanced) -+ [Restoring a backup into a MySQL DB instance](MySQL.Procedural.Importing.md) -+ [Importing data from a MariaDB or MySQL database to a MariaDB or MySQL DB instance](MySQL.Procedural.Importing.SmallExisting.md) -+ [Importing data to an Amazon RDS MariaDB or MySQL database with reduced downtime](MySQL.Procedural.Importing.NonRDSRepl.md) -+ [Importing data from any source to a MariaDB or MySQL DB instance](MySQL.Procedural.Importing.AnySource.md) \ No newline at end of file diff --git a/doc_source/MySQL.Procedural.Importing.SmallExisting.md b/doc_source/MySQL.Procedural.Importing.SmallExisting.md deleted file mode 100644 index 97b5afa..0000000 --- a/doc_source/MySQL.Procedural.Importing.SmallExisting.md +++ /dev/null @@ -1,78 +0,0 @@ -# Importing data from a MariaDB or MySQL database to a MariaDB or MySQL DB instance - -You can also import data from an existing MariaDB or MySQL database to a MySQL or MariaDB DB instance\. You do so by copying the database with [mysqldump](https://dev.mysql.com/doc/refman/8.0/en/mysqldump.html) and piping it directly into the MariaDB or MySQL DB instance\. The `mysqldump` command line utility is commonly used to make backups and transfer data from one MariaDB or MySQL server to another\. It's included with MySQL and MariaDB client software\. - -**Note** -If you are using a MySQL DB instance and your scenario supports it, it's easier to move data in and out of Amazon RDS by using backup files and Amazon S3\. For more information, see [Restoring a backup into a MySQL DB instance](MySQL.Procedural.Importing.md)\. - -A typical `mysqldump` command to move data from an external database to an Amazon RDS DB instance looks similar to the following\. - -``` -mysqldump -u local_user \ - --databases database_name \ - --single-transaction \ - --compress \ - --order-by-primary \ - -plocal_password | mysql -u RDS_user \ - --port=port_number \ - --host=host_name \ - -pRDS_password -``` - -**Important** -Make sure not to leave a space between the `-p` option and the entered password\. - -Make sure that you're aware of the following recommendations and considerations: -+ Exclude the following schemas from the dump file: `sys`, `performance_schema`, and `information_schema`\. The `mysqldump` utility excludes these schemas by default\. -+ If you need to migrate users and privileges, consider using a tool that generates the data control language \(DCL\) for recreating them, such as the [pt\-show\-grants](https://www.percona.com/doc/percona-toolkit/LATEST/pt-show-grants.html) utility\. -+ To perform the import, make sure the user doing so has access to the DB instance\. For more information, see [Controlling access with security groups](Overview.RDSSecurityGroups.md)\. - -The parameters used are as follows: -+ `-u local_user` – Use to specify a user name\. In the first usage of this parameter, you specify the name of a user account on the local MariaDB or MySQL database identified by the `--databases` parameter\. -+ `--databases database_name` – Use to specify the name of the database on the local MariaDB or MySQL instance that you want to import into Amazon RDS\. -+ `--single-transaction` – Use to ensure that all of the data loaded from the local database is consistent with a single point in time\. If there are other processes changing the data while `mysqldump` is reading it, using this parameter helps maintain data integrity\. -+ `--compress` – Use to reduce network bandwidth consumption by compressing the data from the local database before sending it to Amazon RDS\. -+ `--order-by-primary` – Use to reduce load time by sorting each table's data by its primary key\. -+ `-plocal_password` – Use to specify a password\. In the first usage of this parameter, you specify the password for the user account identified by the first `-u` parameter\. -+ `-u RDS_user` – Use to specify a user name\. In the second usage of this parameter, you specify the name of a user account on the default database for the MariaDB or MySQL DB instance identified by the `--host` parameter\. -+ `--port port_number` – Use to specify the port for your MariaDB or MySQL DB instance\. By default, this is 3306 unless you changed the value when creating the instance\. -+ `--host host_name` – Use to specify the Domain Name System \(DNS\) name from the Amazon RDS DB instance endpoint, for example, `myinstance.123456789012.us-east-1.rds.amazonaws.com`\. You can find the endpoint value in the instance details in the Amazon RDS Management Console\. -+ `-pRDS_password` – Use to specify a password\. In the second usage of this parameter, you specify the password for the user account identified by the second `-u` parameter\. - -Make sure to create any stored procedures, triggers, functions, or events manually in your Amazon RDS database\. If you have any of these objects in the database that you are copying, then exclude them when you run `mysqldump`\. To do so, include the following parameters with your `mysqldump` command: `--routines=0 --triggers=0 --events=0`\. - -The following example copies the `world` sample database on the local host to a MySQL DB instance\. - -For Linux, macOS, or Unix: - -``` -sudo mysqldump -u localuser \ - --databases world \ - --single-transaction \ - --compress \ - --order-by-primary \ - --routines=0 \ - --triggers=0 \ - --events=0 \ - -plocalpassword | mysql -u rdsuser \ - --port=3306 \ - --host=myinstance.123456789012.us-east-1.rds.amazonaws.com \ - -prdspassword -``` - -For Windows, run the following command in a command prompt that has been opened by right\-clicking **Command Prompt** on the Windows programs menu and choosing **Run as administrator**: - -``` -mysqldump -u localuser ^ - --databases world ^ - --single-transaction ^ - --compress ^ - --order-by-primary ^ - --routines=0 ^ - --triggers=0 ^ - --events=0 ^ - -plocalpassword | mysql -u rdsuser ^ - --port=3306 ^ - --host=myinstance.123456789012.us-east-1.rds.amazonaws.com ^ - -prdspassword -``` \ No newline at end of file diff --git a/doc_source/MySQL.Procedural.Importing.SmallExistingMariaDB.md b/doc_source/MySQL.Procedural.Importing.SmallExistingMariaDB.md deleted file mode 100644 index 9939ba0..0000000 --- a/doc_source/MySQL.Procedural.Importing.SmallExistingMariaDB.md +++ /dev/null @@ -1,78 +0,0 @@ -# Importing data from a MariaDB or MySQL database to a MariaDB or MySQL DB instance - -You can also import data from an existing MariaDB or MySQL database to a MySQL or MariaDB DB instance\. You do so by copying the database with [mysqldump](https://dev.mysql.com/doc/refman/8.0/en/mysqldump.html) and piping it directly into the MariaDB or MySQL DB instance\. The `mysqldump` command line utility is commonly used to make backups and transfer data from one MariaDB or MySQL server to another\. It's included with MySQL and MariaDB client software\. - -**Note** -If you are using a MySQL DB instance and your scenario supports it, it's easier to move data in and out of Amazon RDS by using backup files and Amazon S3\. For more information, see [Restoring a backup into a MySQL DB instance](MySQL.Procedural.Importing.md)\. - -A typical `mysqldump` command to move data from an external database to an Amazon RDS DB instance looks similar to the following\. - -``` -mysqldump -u local_user \ - --databases database_name \ - --single-transaction \ - --compress \ - --order-by-primary \ - -plocal_password | mysql -u RDS_user \ - --port=port_number \ - --host=host_name \ - -pRDS_password -``` - -**Important** -Make sure not to leave a space between the `-p` option and the entered password\. - -Make sure that you're aware of the following recommendations and considerations: -+ Exclude the following schemas from the dump file: `sys`, `performance_schema`, and `information_schema`\. The `mysqldump` utility excludes these schemas by default\. -+ If you need to migrate users and privileges, consider using a tool that generates the data control language \(DCL\) for recreating them, such as the [pt\-show\-grants](https://www.percona.com/doc/percona-toolkit/LATEST/pt-show-grants.html) utility\. -+ To perform the import, make sure the user doing so has access to the DB instance\. For more information, see [Controlling access with security groups](Overview.RDSSecurityGroups.md)\. - -The parameters used are as follows: -+ `-u local_user` – Use to specify a user name\. In the first usage of this parameter, you specify the name of a user account on the local MariaDB or MySQL database identified by the `--databases` parameter\. -+ `--databases database_name` – Use to specify the name of the database on the local MariaDB or MySQL instance that you want to import into Amazon RDS\. -+ `--single-transaction` – Use to ensure that all of the data loaded from the local database is consistent with a single point in time\. If there are other processes changing the data while `mysqldump` is reading it, using this parameter helps maintain data integrity\. -+ `--compress` – Use to reduce network bandwidth consumption by compressing the data from the local database before sending it to Amazon RDS\. -+ `--order-by-primary` – Use to reduce load time by sorting each table's data by its primary key\. -+ `-plocal_password` – Use to specify a password\. In the first usage of this parameter, you specify the password for the user account identified by the first `-u` parameter\. -+ `-u RDS_user` – Use to specify a user name\. In the second usage of this parameter, you specify the name of a user account on the default database for the MariaDB or MySQL DB instance identified by the `--host` parameter\. -+ `--port port_number` – Use to specify the port for your MariaDB or MySQL DB instance\. By default, this is 3306 unless you changed the value when creating the instance\. -+ `--host host_name` – Use to specify the Domain Name System \(DNS\) name from the Amazon RDS DB instance endpoint, for example, `myinstance.123456789012.us-east-1.rds.amazonaws.com`\. You can find the endpoint value in the instance details in the Amazon RDS Management Console\. -+ `-pRDS_password` – Use to specify a password\. In the second usage of this parameter, you specify the password for the user account identified by the second `-u` parameter\. - -Make sure to create any stored procedures, triggers, functions, or events manually in your Amazon RDS database\. If you have any of these objects in the database that you are copying, then exclude them when you run `mysqldump`\. To do so, include the following parameters with your `mysqldump` command: `--routines=0 --triggers=0 --events=0`\. - -The following example copies the `world` sample database on the local host to a MySQL DB instance\. - -For Linux, macOS, or Unix: - -``` -sudo mysqldump -u localuser \ - --databases world \ - --single-transaction \ - --compress \ - --order-by-primary \ - --routines=0 \ - --triggers=0 \ - --events=0 \ - -plocalpassword | mysql -u rdsuser \ - --port=3306 \ - --host=myinstance.123456789012.us-east-1.rds.amazonaws.com \ - -prdspassword -``` - -For Windows, run the following command in a command prompt that has been opened by right\-clicking **Command Prompt** on the Windows programs menu and choosing **Run as administrator**: - -``` -mysqldump -u localuser ^ - --databases world ^ - --single-transaction ^ - --compress ^ - --order-by-primary ^ - --routines=0 ^ - --triggers=0 ^ - --events=0 ^ - -plocalpassword | mysql -u rdsuser ^ - --port=3306 ^ - --host=myinstance.123456789012.us-east-1.rds.amazonaws.com ^ - -prdspassword -``` \ No newline at end of file diff --git a/doc_source/MySQL.Procedural.Importing.md b/doc_source/MySQL.Procedural.Importing.md deleted file mode 100644 index 0ca0d63..0000000 --- a/doc_source/MySQL.Procedural.Importing.md +++ /dev/null @@ -1,311 +0,0 @@ -# Restoring a backup into a MySQL DB instance - -Amazon RDS supports importing MySQL databases by using backup files\. You can create a backup of your database, store it on Amazon S3, and then restore the backup file onto a new Amazon RDS DB instance running MySQL\. - -The scenario described in this section restores a backup of an on\-premises database\. You can use this technique for databases in other locations, such as Amazon EC2 or non\-AWS cloud services, as long as the database is accessible\. - -You can find the supported scenario in the following diagram\. - -![\[MySQL importing backup files from S3 architecture\]](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/images/MySQL-bak-file.png) - -Importing backup files from Amazon S3 is supported for MySQL in all AWS Regions\. - -We recommend that you import your database to Amazon RDS by using backup files if your on\-premises database can be offline while the backup file is created, copied, and restored\. If your database can't be offline, you can use binary log \(binlog\) replication to update your database after you have migrated to Amazon RDS through Amazon S3 as explained in this topic\. For more information, see [Configuring binary log file position replication with an external source instance](MySQL.Procedural.Importing.External.Repl.md)\. You can also use the AWS Database Migration Service to migrate your database to Amazon RDS\. For more information, see [What is AWS Database Migration Service?](https://docs.aws.amazon.com/dms/latest/userguide/Welcome.html) - -## Limitations and recommendations for importing backup files from Amazon S3 to Amazon RDS - -The following are some limitations and recommendations for importing backup files from Amazon S3: -+ You can only import your data to a new DB instance, not an existing DB instance\. -+ You must use Percona XtraBackup to create the backup of your on\-premises database\. -+ You can't import data from a DB snapshot export to Amazon S3\. -+ You can't migrate from a source database that has tables defined outside of the default MySQL data directory\. -+ You must import your data to the default minor version of your MySQL major version in your AWS Region\. For example, if your major version is MySQL 8\.0, and the default minor version for your AWS Region is 8\.0\.28, then you must import your data into a MySQL version 8\.0\.28 DB instance\. You can upgrade your DB instance after importing\. For information about determining the default minor version, see [MySQL on Amazon RDS versions](MySQL.Concepts.VersionMgmt.md)\. -+ Backward migration is not supported for both major versions and minor versions\. For example, you can't migrate from version 8\.0 to version 5\.7, and you can't migrate from version 8\.0\.32 to version 8\.0\.31\. -+ You can't import a MySQL 5\.5 or 5\.6 database\. -+ You can't import an on\-premises MySQL database from one major version to another\. For example, you can't import a MySQL 5\.7 database to an RDS for MySQL 8\.0 database\. You can upgrade your DB instance after you complete the import\. -+ You can't restore from an encrypted source database, but you can restore to an encrypted Amazon RDS DB instance\. -+ You can't restore from an encrypted backup in the Amazon S3 bucket\. -+ You can't restore from an Amazon S3 bucket in a different AWS Region than your Amazon RDS DB instance\. -+ Importing from Amazon S3 is not supported on the db\.t2\.micro DB instance class\. However, you can restore to a different DB instance class, and change the DB instance class later\. For more information about instance classes, see [Hardware specifications for DB instance classes](Concepts.DBInstanceClass.md#Concepts.DBInstanceClass.Summary)\. -+ Amazon S3 limits the size of a file uploaded to an Amazon S3 bucket to 5 TB\. If a backup file exceeds 5 TB, then you must split the backup file into smaller files\. -+ When you restore the database, the backup is copied and then extracted on your DB instance\. Therefore, provision storage space for your DB instance that is equal to or greater than the sum of the backup size, plus the original database's size on disk\. -+ Amazon RDS limits the number of files uploaded to an Amazon S3 bucket to 1 million\. If the backup data for your database, including all full and incremental backups, exceeds 1 million files, use a Gzip \(\.gz\), tar \(\.tar\.gz\), or Percona xbstream \(\.xbstream\) file to store full and incremental backup files in the Amazon S3 bucket\. Percona XtraBackup 8\.0 only supports Percona xbstream for compression\. -+ User accounts are not imported automatically\. Save your user accounts from your source database and add them to your new DB instance later\. -+ Functions are not imported automatically\. Save your functions from your source database and add them to your new DB instance later\. -+ Stored procedures are not imported automatically\. Save your stored procedures from your source database and add them to your new DB instance later\. -+ Time zone information is not imported automatically\. Record the time zone information for your source database, and set the time zone of your new DB instance later\. For more information, see [Local time zone for MySQL DB instances](MySQL.Concepts.LocalTimeZone.md)\. -+ The `innodb_data_file_path` parameter must be configured with only one data file that uses the default data file name `"ibdata1:12M:autoextend"`\. Databases with two data files, or with a data file with a different name, can't be migrated using this method\. - - The following are examples of file names that are not allowed: `"innodb_data_file_path=ibdata1:50M; ibdata2:50M:autoextend"` and `"innodb_data_file_path=ibdata01:50M:autoextend"`\. -+ The maximum size of the restored database is the maximum database size supported minus the size of the backup\. So, if the maximum database size supported is 64 TiB, and the size of the backup is 30 TiB, then the maximum size of the restored database is 34 TiB, as in the following example: - - `64 TiB - 30 TiB = 34 TiB` - - For information about the maximum database size supported by Amazon RDS for MySQL, see [General Purpose SSD storage](CHAP_Storage.md#Concepts.Storage.GeneralSSD) and [Provisioned IOPS SSD storage](CHAP_Storage.md#USER_PIOPS)\. - -## Overview of setting up to import backup files from Amazon S3 to Amazon RDS - -These are the components you need to set up to import backup files from Amazon S3 to Amazon RDS: -+ An Amazon S3 bucket to store your backup files\. -+ A backup of your on\-premises database created by Percona XtraBackup\. -+ An AWS Identity and Access Management \(IAM\) role to allow Amazon RDS to access the bucket\. - -If you already have an Amazon S3 bucket, you can use that\. If you don't have an Amazon S3 bucket, you can create a new one\. If you want to create a new bucket, see [Creating a bucket](https://docs.aws.amazon.com/AmazonS3/latest/user-guide/CreatingaBucket.html)\. - -Use the Percona XtraBackup tool to create your backup\. For more information, see [Creating your database backup](#MySQL.Procedural.Importing.Backup)\. - -If you already have an IAM role, you can use that\. If you don't have an IAM role, you can create a new one manually\. Alternatively, you can choose to have a new IAM role created for you in your account by the wizard when you restore the database by using the AWS Management Console\. If you want to create a new IAM role manually, or attach trust and permissions policies to an existing IAM role, see [Creating an IAM role manually](#MySQL.Procedural.Importing.Enabling.IAM)\. If you want to have a new IAM role created for you, follow the procedure in [Console](#MySQL.Procedural.Importing.Console)\. - -## Creating your database backup - -Use the Percona XtraBackup software to create your backup\. We recommend that you use the latest version of Percona XtraBackup\. You can install Percona XtraBackup from [Download Percona XtraBackup](https://www.percona.com/downloads/Percona-XtraBackup-LATEST/)\. - -**Warning** -When creating a database backup, XtraBackup might save credentials in the xtrabackup\_info file\. Make sure you examine that file so that the `tool_command` setting in it doesn't contain any sensitive information\. - -**Note** -For MySQL 8\.0 migration, you must use Percona XtraBackup 8\.0\. Percona XtraBackup 8\.0\.12 and higher versions support migration of all versions of MySQL\. If you are migrating to RDS for MySQL 8\.0\.20 or higher, you must use Percona XtraBackup 8\.0\.12 or higher\. -For MySQL 5\.7 migrations, you can also use Percona XtraBackup 2\.4\. For migrations of earlier MySQL versions, you can also use Percona XtraBackup 2\.3 or 2\.4\. - -You can create a full backup of your MySQL database files using Percona XtraBackup\. Alternatively, if you already use Percona XtraBackup to back up your MySQL database files, you can upload your existing full and incremental backup directories and files\. - -For more information about backing up your database with Percona XtraBackup, see [Percona XtraBackup \- documentation](https://www.percona.com/doc/percona-xtrabackup/LATEST/index.html) and [ The xtrabackup binary](https://www.percona.com/doc/percona-xtrabackup/LATEST/xtrabackup_bin/xtrabackup_binary.html) on the Percona website\. - -### Creating a full backup with Percona XtraBackup - -To create a full backup of your MySQL database files that can be restored from Amazon S3, use the Percona XtraBackup utility \(`xtrabackup`\) to back up your database\. - -For example, the following command creates a backup of a MySQL database and stores the files in the folder `/on-premises/s3-restore/backup` folder\. - -``` -xtrabackup --backup --user= --password= --target-dir= -``` - -If you want to compress your backup into a single file \(which can be split later, if needed\), you can save your backup in one of the following formats: -+ Gzip \(\.gz\) -+ tar \(\.tar\) -+ Percona xbstream \(\.xbstream\) - -**Note** -Percona XtraBackup 8\.0 only supports Percona xbstream for compression\. - -The following command creates a backup of your MySQL database split into multiple Gzip files\. - -``` -xtrabackup --backup --user= --password= --stream=tar \ - --target-dir= | gzip - | split -d --bytes=500MB \ - - .tar.gz -``` - -The following command creates a backup of your MySQL database split into multiple tar files\. - -``` -xtrabackup --backup --user= --password= --stream=tar \ - --target-dir= | split -d --bytes=500MB \ - - .tar -``` - -The following command creates a backup of your MySQL database split into multiple xbstream files\. - -``` -xtrabackup --backup --user= --password= --stream=xbstream \ - --target-dir= | split -d --bytes=500MB \ - - .xbstream -``` - -### Using incremental backups with Percona XtraBackup - -If you already use Percona XtraBackup to perform full and incremental backups of your MySQL database files, you don't need to create a full backup and upload the backup files to Amazon S3\. Instead, you can save a significant amount of time by copying your existing backup directories and files to your Amazon S3 bucket\. For more information about creating incremental backups using Percona XtraBackup, see [Incremental backup](https://www.percona.com/doc/percona-xtrabackup/LATEST/backup_scenarios/incremental_backup.html)\. - -When copying your existing full and incremental backup files to an Amazon S3 bucket, you must recursively copy the contents of the base directory\. Those contents include the full backup and also all incremental backup directories and files\. This copy must preserve the directory structure in the Amazon S3 bucket\. Amazon RDS iterates through all files and directories\. Amazon RDS uses the `xtrabackup-checkpoints` file that is included with each incremental backup to identify the base directory, and to order incremental backups by log sequence number \(LSN\) range\. - -### Backup considerations for Percona XtraBackup - -Amazon RDS consumes your backup files based on the file name\. Name your backup files with the appropriate file extension based on the file format—for example, `.xbstream` for files stored using the Percona xbstream format\. - -Amazon RDS consumes your backup files in alphabetical order and also in natural number order\. Use the `split` option when you issue the `xtrabackup` command to ensure that your backup files are written and named in the proper order\. - -Amazon RDS doesn't support partial backups created using Percona XtraBackup\. You can't use the following options to create a partial backup when you back up the source files for your database: `--tables`, `--tables-exclude`, `--tables-file`, `--databases`, `--databases-exclude`, or `--databases-file`\. - -Amazon RDS supports incremental backups created using Percona XtraBackup\. For more information about creating incremental backups using Percona XtraBackup, see [Incremental backup](https://www.percona.com/doc/percona-xtrabackup/LATEST/backup_scenarios/incremental_backup.html)\. - -## Creating an IAM role manually - -If you don't have an IAM role, you can create a new one manually\. Alternatively, you can choose to have a new IAM role created for you by the wizard when you restore the database by using the AWS Management Console\. If you want to have a new IAM role created for you, follow the procedure in [Console](#MySQL.Procedural.Importing.Console)\. - -To manually create a new IAM role for importing your database from Amazon S3, create a role to delegate permissions from Amazon RDS to your Amazon S3 bucket\. When you create an IAM role, you attach trust and permissions policies\. To import your backup files from Amazon S3, use trust and permissions policies similar to the examples following\. For more information about creating the role, see [Creating a role to delegate permissions to an AWS service](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_create_for-service.html)\. - -Alternatively, you can choose to have a new IAM role created for you by the wizard when you restore the database by using the AWS Management Console\. If you want to have a new IAM role created for you, follow the procedure in [Console](#MySQL.Procedural.Importing.Console) - -The trust and permissions policies require that you provide an Amazon Resource Name \(ARN\)\. For more information about ARN formatting, see [Amazon Resource Names \(ARNs\) and AWS service namespaces](https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html)\. - -**Example Trust policy for importing from Amazon S3** - -``` -1. { -2. "Version": "2012-10-17", -3. "Statement": -4. [{ -5. "Effect": "Allow", -6. "Principal": {"Service": "rds.amazonaws.com"}, -7. "Action": "sts:AssumeRole" -8. }] -9. } -``` - -**Example Permissions policy for importing from Amazon S3 — IAM user permissions** - -``` - 1. { - 2. "Version":"2012-10-17", - 3. "Statement": - 4. [ - 5. { - 6. "Sid":"AllowS3AccessRole", - 7. "Effect":"Allow", - 8. "Action":"iam:PassRole", - 9. "Resource":"arn:aws:iam::IAM User ID:role/S3Access" -10. } -11. ] -12. } -``` - -**Example Permissions policy for importing from Amazon S3 — role permissions** - -``` - 1. { - 2. "Version": "2012-10-17", - 3. "Statement": - 4. [ - 5. { - 6. "Effect": "Allow", - 7. "Action": - 8. [ - 9. "s3:ListBucket", -10. "s3:GetBucketLocation" -11. ], -12. "Resource": "arn:aws:s3:::bucket_name" -13. }, -14. { -15. "Effect": "Allow", -16. "Action": -17. [ -18. "s3:GetObject" -19. ], -20. "Resource": "arn:aws:s3:::bucket_name/prefix*" -21. } -22. ] -23. } -``` -If you include a file name prefix, include the asterisk \(\*\) after the prefix\. If you don't want to specify a prefix, specify only an asterisk\. - -## Importing data from Amazon S3 to a new MySQL DB instance - -You can import data from Amazon S3 to a new MySQL DB instance using the AWS Management Console, AWS CLI, or RDS API\. - -### Console - -**To import data from Amazon S3 to a new MySQL DB instance** - -1. Sign in to the AWS Management Console and open the Amazon RDS console at [https://console\.aws\.amazon\.com/rds/](https://console.aws.amazon.com/rds/)\. - -1. In the top right corner of the Amazon RDS console, choose the AWS Region in which to create your DB instance\. Choose the same AWS Region as the Amazon S3 bucket that contains your database backup\. - -1. In the navigation pane, choose **Databases**\. - -1. Choose **Restore from S3**\. - - The **Create database by restoring from S3** page appears\. -![\[The page where you specify the details for restoring a DB instance from S3\]](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/images/mys-s3-ingestion.png) - -1. Under **S3 destination**: - - 1. Choose the **S3 bucket** that contains the backup\. - - 1. \(Optional\) For **S3 folder path prefix**, enter a file path prefix for the files stored in your Amazon S3 bucket\. - - If you don't specify a prefix, then RDS creates your DB instance using all of the files and folders in the root folder of the S3 bucket\. If you do specify a prefix, then RDS creates your DB instance using the files and folders in the S3 bucket where the path for the file begins with the specified prefix\. - - For example, suppose that you store your backup files on S3 in a subfolder named backups, and you have multiple sets of backup files, each in its own directory \(gzip\_backup1, gzip\_backup2, and so on\)\. In this case, you specify a prefix of backups/gzip\_backup1 to restore from the files in the gzip\_backup1 folder\. - -1. Under **Engine options**: - - 1. For **Engine type**, choose **MySQL**\. - - 1. For **Source engine version**, choose the MySQL major version of your source database\. - - 1. For **Version**, choose the default minor version of your MySQL major version in your AWS Region\. - - In the AWS Management Console, only the default minor version is available\. You can upgrade your DB instance after importing\. - -1. For **IAM role**, you can choose an existing IAM role\. - -1. \(Optional\) You can also have a new IAM role created for you by choosing **Create a new role** and entering the **IAM role name**\. - -1. Specify your DB instance information\. For information about each setting, see [Settings for DB instances](USER_CreateDBInstance.md#USER_CreateDBInstance.Settings)\. -**Note** -Be sure to allocate enough memory for your new DB instance so that the restore operation can succeed\. -You can also choose **Enable storage autoscaling** to allow for future growth automatically\. - -1. Choose additional settings as needed\. - -1. Choose **Create database**\. - -### AWS CLI - -To import data from Amazon S3 to a new MySQL DB instance by using the AWS CLI, call the [restore\-db\-instance\-from\-s3](https://docs.aws.amazon.com/cli/latest/reference/rds/restore-db-instance-from-s3.html) command with the following parameters\. For information about each setting, see [Settings for DB instances](USER_CreateDBInstance.md#USER_CreateDBInstance.Settings)\. - -**Note** -Be sure to allocate enough memory for your new DB instance so that the restore operation can succeed\. -You can also use the `--max-allocated-storage` parameter to enable storage autoscaling and allow for future growth automatically\. -+ `--allocated-storage` -+ `--db-instance-identifier` -+ `--db-instance-class` -+ `--engine` -+ `--master-username` -+ `--master-user-password` -+ `--s3-bucket-name` -+ `--s3-ingestion-role-arn` -+ `--s3-prefix` -+ `--source-engine` -+ `--source-engine-version` - -**Example** -For Linux, macOS, or Unix: - -``` - 1. aws rds restore-db-instance-from-s3 \ - 2. --allocated-storage 250 \ - 3. --db-instance-identifier myidentifier \ - 4. --db-instance-class db.m5.large \ - 5. --engine mysql \ - 6. --master-username admin \ - 7. --master-user-password mypassword \ - 8. --s3-bucket-name mybucket \ - 9. --s3-ingestion-role-arn arn:aws:iam::account-number:role/rolename \ -10. --s3-prefix bucketprefix \ -11. --source-engine mysql \ -12. --source-engine-version 8.0.32 \ -13. --max-allocated-storage 1000 -``` -For Windows: - -``` - 1. aws rds restore-db-instance-from-s3 ^ - 2. --allocated-storage 250 ^ - 3. --db-instance-identifier myidentifier ^ - 4. --db-instance-class db.m5.large ^ - 5. --engine mysql ^ - 6. --master-username admin ^ - 7. --master-user-password mypassword ^ - 8. --s3-bucket-name mybucket ^ - 9. --s3-ingestion-role-arn arn:aws:iam::account-number:role/rolename ^ -10. --s3-prefix bucketprefix ^ -11. --source-engine mysql ^ -12. --source-engine-version 8.0.32 ^ -13. --max-allocated-storage 1000 -``` - -### RDS API - -To import data from Amazon S3 to a new MySQL DB instance by using the Amazon RDS API, call the [RestoreDBInstanceFromS3](https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_RestoreDBInstanceFromS3.html) operation\. \ No newline at end of file diff --git a/doc_source/MysQL.Concepts.UsersAndPrivileges.md b/doc_source/MysQL.Concepts.UsersAndPrivileges.md deleted file mode 100644 index deb459d..0000000 --- a/doc_source/MysQL.Concepts.UsersAndPrivileges.md +++ /dev/null @@ -1,45 +0,0 @@ -# MySQL security on Amazon RDS - -Security for MySQL DB instances is managed at three levels: -+ AWS Identity and Access Management controls who can perform Amazon RDS management actions on DB instances\. When you connect to AWS using IAM credentials, your IAM account must have IAM policies that grant the permissions required to perform Amazon RDS management operations\. For more information, see [Identity and access management for Amazon RDS](UsingWithRDS.IAM.md)\. -+ When you create a DB instance, you use a VPC security group to control which devices and Amazon EC2 instances can open connections to the endpoint and port of the DB instance\. These connections can be made using Secure Sockets Layer \(SSL\) and Transport Layer Security \(TLS\)\. In addition, firewall rules at your company can control whether devices running at your company can open connections to the DB instance\. -+ To authenticate login and permissions for a MySQL DB instance, you can take either of the following approaches, or a combination of them\. - - You can take the same approach as with a stand\-alone instance of MySQL\. Commands such as `CREATE USER`, `RENAME USER`, `GRANT`, `REVOKE`, and `SET PASSWORD` work just as they do in on\-premises databases, as does directly modifying database schema tables\. For information, see [ Access control and account management](https://dev.mysql.com/doc/refman/8.0/en/access-control.html) in the MySQL documentation\. - - You can also use IAM database authentication\. With IAM database authentication, you authenticate to your DB instance by using an IAM user or IAM role and an authentication token\. An *authentication token* is a unique value that is generated using the Signature Version 4 signing process\. By using IAM database authentication, you can use the same credentials to control access to your AWS resources and your databases\. For more information, see [IAM database authentication for MariaDB, MySQL, and PostgreSQL](UsingWithRDS.IAMDBAuth.md)\. - - Another option is Kerberos authentication for RDS for MySQL\. The DB instance works with AWS Directory Service for Microsoft Active Directory \(AWS Managed Microsoft AD\) to enable Kerberos authentication\. When users authenticate with a MySQL DB instance joined to the trusting domain, authentication requests are forwarded\. Forwarded requests go to the domain directory that you create with AWS Directory Service\. For more information, see [Using Kerberos authentication for MySQL](mysql-kerberos.md)\. - - When you create an Amazon RDS DB instance, the master user has the following default privileges: -+ `alter` -+ `alter routine` -+ `create` -+ `create routine` -+ `create temporary tables` -+ `create user` -+ `create view` -+ `delete` -+ `drop` -+ `event` -+ `execute` -+ `grant option` -+ `index` -+ `insert` -+ `lock tables` -+ `process` -+ `references` -+ `replication client` -+ `replication slave` -+ `select` -+ `show databases` -+ `show view` -+ `trigger` -+ `update` - -**Note** -Although it is possible to delete the master user on the DB instance, it is not recommended\. To recreate the master user, use the [ModifyDBInstance](https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_ModifyDBInstance.html) RDS API operation or the [modify\-db\-instance](https://docs.aws.amazon.com/cli/latest/reference/rds/modify-db-instance.html) AWS CLI command and specify a new master user password with the appropriate parameter\. If the master user does not exist in the instance, the master user is created with the specified password\. - -To provide management services for each DB instance, the `rdsadmin` user is created when the DB instance is created\. Attempting to drop, rename, change the password, or change privileges for the `rdsadmin` account will result in an error\. - -To allow management of the DB instance, the standard `kill` and `kill_query` commands have been restricted\. The Amazon RDS commands `rds_kill` and `rds_kill_query` are provided to allow you to end user sessions or queries on DB instances\. \ No newline at end of file diff --git a/doc_source/Oracle.Concepts.ExtendedDataTypes.md b/doc_source/Oracle.Concepts.ExtendedDataTypes.md deleted file mode 100644 index 7f90f8c..0000000 --- a/doc_source/Oracle.Concepts.ExtendedDataTypes.md +++ /dev/null @@ -1,57 +0,0 @@ -# Turning on extended data types in RDS for Oracle - -Amazon RDS Oracle Database 12c supports extended data types\. With extended data types, the maximum size is 32,767 bytes for the VARCHAR2, NVARCHAR2, and RAW data types\. To use extended data types, set the `MAX_STRING_SIZE` parameter to `EXTENDED`\. For more information, see [Extended data types](https://docs.oracle.com/database/121/SQLRF/sql_elements001.htm#SQLRF55623) in the Oracle documentation\. - -If you don't want to use extended data types, keep the `MAX_STRING_SIZE` parameter set to `STANDARD` \(the default\)\. In this case, the size limits are 4,000 bytes for the `VARCHAR2` and `NVARCHAR2` data types, and 2,000 bytes for the RAW data type\. - -You can turn on extended data types on a new or existing DB instance\. For new DB instances, DB instance creation time is typically longer when you turn on extended data types\. For existing DB instances, the DB instance is unavailable during the conversion process\. - -The following are considerations for a DB instance with extended data types enabled: -+ When you turn on extended data types for a DB instance, you can't change the DB instance back to use the standard size for data types\. After a DB instance is converted to use extended data types, if you set the `MAX_STRING_SIZE` parameter back to `STANDARD` it results in the `incompatible-parameters` status\. -+ When you restore a DB instance that uses extended data types, you must specify a parameter group with the `MAX_STRING_SIZE` parameter set to `EXTENDED`\. During restore, if you specify the default parameter group or any other parameter group with `MAX_STRING_SIZE` set to `STANDARD` it results in the `incompatible-parameters` status\. -+ We recommend that you don't turn on extended data types for Oracle DB instances running on the t2\.micro DB instance class\. - -When the DB instance status is `incompatible-parameters` because of the `MAX_STRING_SIZE` setting, the DB instance remains unavailable until you set the `MAX_STRING_SIZE` parameter to `EXTENDED` and reboot the DB instance\. - -## Turning on extended data types for a new DB instance - -**To turn on extended data types for a new DB instance** - -1. Set the `MAX_STRING_SIZE` parameter to `EXTENDED` in a parameter group\. - - To set the parameter, you can either create a new parameter group or modify an existing parameter group\. - - For more information, see [Working with parameter groups](USER_WorkingWithParamGroups.md)\. - -1. Create a new Amazon RDS Oracle DB instance, and associate the parameter group with `MAX_STRING_SIZE` set to `EXTENDED` with the DB instance\. - - For more information, see [Creating an Amazon RDS DB instance](USER_CreateDBInstance.md)\. - -## Turning on extended data types for an existing DB instance - -When you modify a DB instance to turn on extended data types, the data in the database is converted to use the extended sizes\. The DB instance is unavailable during the conversion\. The amount of time it takes to convert the data depends on the DB instance class used by the DB instance and the size of the database\. - -**Note** -After you turn on extended data types, you can't perform a point\-in\-time restore to a time during the conversion\. You can restore to the time immediately before the conversion or after the conversion\. - -**To turn on extended data types for an existing DB instance** - -1. Take a snapshot of the database\. - - If there are invalid objects in the database, Amazon RDS tries to recompile them\. The conversion to extended data types can fail if Amazon RDS can't recompile an invalid object\. The snapshot enables you to restore the database if there is a problem with the conversion\. Always check for invalid objects before conversion and fix or drop those invalid objects\. For production databases, we recommend testing the conversion process on a copy of your DB instance first\. - - For more information, see [Creating a DB snapshot](USER_CreateSnapshot.md)\. - -1. Set the `MAX_STRING_SIZE` parameter to `EXTENDED` in a parameter group\. - - To set the parameter, you can either create a new parameter group or modify an existing parameter group\. - - For more information, see [Working with parameter groups](USER_WorkingWithParamGroups.md)\. - -1. Modify the DB instance to associate it with the parameter group with `MAX_STRING_SIZE` set to `EXTENDED`\. - - For more information, see [Modifying an Amazon RDS DB instance](Overview.DBInstance.Modifying.md)\. - -1. Reboot the DB instance for the parameter change to take effect\. - - For more information, see [Rebooting a DB instance](USER_RebootInstance.md)\. \ No newline at end of file diff --git a/doc_source/Oracle.Concepts.FeatureSupport.Parameters.md b/doc_source/Oracle.Concepts.FeatureSupport.Parameters.md deleted file mode 100644 index d285833..0000000 --- a/doc_source/Oracle.Concepts.FeatureSupport.Parameters.md +++ /dev/null @@ -1,10 +0,0 @@ -# RDS for Oracle parameters - -In Amazon RDS, you manage parameters using parameter groups\. For more information, see [Working with parameter groups](USER_WorkingWithParamGroups.md)\. To view the supported parameters for a specific Oracle Database edition and version, run the AWS CLI command [https://docs.aws.amazon.com/cli/latest/reference/rds/describe-engine-default-parameters.html](https://docs.aws.amazon.com/cli/latest/reference/rds/describe-engine-default-parameters.html)\. - -For example, to view the supported parameters for the Enterprise Edition of Oracle Database 19c, run the following command\. - -``` -aws rds describe-engine-default-parameters \ - --db-parameter-group-family oracle-ee-19 -``` \ No newline at end of file diff --git a/doc_source/Oracle.Concepts.FeatureSupport.md b/doc_source/Oracle.Concepts.FeatureSupport.md deleted file mode 100644 index eec106b..0000000 --- a/doc_source/Oracle.Concepts.FeatureSupport.md +++ /dev/null @@ -1,131 +0,0 @@ -# RDS for Oracle features - -Amazon RDS for Oracle supports most of the features and capabilities of Oracle Database\. Some features might have limited support or restricted privileges\. Some features are only available in Enterprise Edition, and some require additional licenses\. For more information about Oracle Database features for specific Oracle Database versions, see the *Oracle Database Licensing Information User Manual* for the version you're using\. - -You can filter new Amazon RDS features on the [What's New with Database?](http://aws.amazon.com/about-aws/whats-new/database/) page\. For **Products**, choose **Amazon RDS**\. Then search using keywords such as **Oracle 2022**\. - -**Note** -The following lists are not exhaustive\. - -**Topics** -+ [New features in RDS for Oracle](#Oracle.Concepts.FeatureSupport.new) -+ [Supported features in RDS for Oracle](#Oracle.Concepts.FeatureSupport.supported) -+ [Unsupported features in RDS for Oracle](#Oracle.Concepts.FeatureSupport.unsupported) - -## New features in RDS for Oracle - -To see new RDS for Oracle features, use the following techniques: -+ Search [Document history](WhatsNew.md) for the keyword **Oracle**\. -+ You can filter new Amazon RDS features on the [What's New with Database?](http://aws.amazon.com/about-aws/whats-new/database/) page\. For **Products**, choose **Amazon RDS**\. Then search for **Oracle *YYYY***, where *YYYY* is a year such as **2022**\. - -## Supported features in RDS for Oracle - -Amazon RDS for Oracle supports the following Oracle Database features: -+ Advanced Compression -+ Application Express \(APEX\) - - For more information, see [Oracle Application Express \(APEX\)](Appendix.Oracle.Options.APEX.md)\. -+ Automatic Memory Management -+ Automatic Undo Management -+ Automatic Workload Repository \(AWR\) - - For more information, see [Generating performance reports with Automatic Workload Repository \(AWR\)](Appendix.Oracle.CommonDBATasks.Database.md#Appendix.Oracle.CommonDBATasks.AWR)\. -+ Active Data Guard with Maximum Performance in the same AWS Region or across AWS Regions - - For more information, see [Working with read replicas for Amazon RDS for Oracle](oracle-read-replicas.md)\. -+ Blockchain tables \(Oracle Database 21c and higher\) - - For more information, see [Managing Blockchain Tables ](https://docs.oracle.com/en/database/oracle/oracle-database/21/admin/managing-tables.html#GUID-43470B0C-DE4A-4640-9278-B066901C3926) in the Oracle Database documentation\. -+ Continuous Query Notification \(version 12\.1\.0\.2\.v7 and higher\) - - For more information, see [ Using Continuous Query Notification \(CQN\)](https://docs.oracle.com/en/database/oracle/oracle-database/19/adfns/cqn.html#GUID-373BAF72-3E63-42FE-8BEA-8A2AEFBF1C35) in the Oracle documentation\. -+ Data Redaction -+ Database Change Notification - - For more information, see [ Database Change Notification](https://docs.oracle.com/cd/E11882_01/java.112/e16548/dbchgnf.htm#JJDBC28815) in the Oracle documentation\. -**Note** -This feature changes to Continuous Query Notification in Oracle Database 12c Release 1 \(12\.1\) and higher\. -+ Database In\-Memory \(Oracle Database 12c and higher\) -+ Distributed Queries and Transactions -+ Edition\-Based Redefinition - - For more information, see [Setting the default edition for a DB instance](Appendix.Oracle.CommonDBATasks.Database.md#Appendix.Oracle.CommonDBATasks.DefaultEdition)\. -+ EM Express \(12c and higher\) - - For more information, see [Oracle Enterprise Manager](Oracle.Options.OEM.md)\. -+ Fine\-Grained Auditing -+ Flashback Table, Flashback Query, Flashback Transaction Query -+ Gradual password rollover for applications \(Oracle Database 21c and higher\) - - For more information, see [Managing Gradual Database Password Rollover for Applications ](https://docs.oracle.com/en/database/oracle/oracle-database/19/dbseg/configuring-authentication.html#GUID-ACBA8DAE-C5B4-4811-A31D-53B97C50249B) in the Oracle Database documentation\. -+ HugePages - - For more information, see [Turning on HugePages for an RDS for Oracle instance](Oracle.Concepts.HugePages.md)\. -+ Import/export \(legacy and Data Pump\) and SQL\*Loader - - For more information, see [Importing data into Oracle on Amazon RDS](Oracle.Procedural.Importing.md)\. -+ Java Virtual Machine \(JVM\) - - For more information, see [Oracle Java virtual machine](oracle-options-java.md)\. -+ JavaScript \(Oracle Database 21c and higher\) - - For more information, see [DBMS\_MLE](https://docs.oracle.com/en/database/oracle/oracle-database/21/arpls/dbms_mle.html#GUID-3F5B47A5-2C73-4317-ACD7-E93AE8B8E301) in the Oracle Database documentation\. -+ Label Security \(Oracle Database 12c and higher\) - - For more information, see [Oracle Label Security](Oracle.Options.OLS.md)\. -+ Locator - - For more information, see [Oracle Locator](Oracle.Options.Locator.md)\. -+ Materialized Views -+ Multimedia - - For more information, see [Oracle Multimedia](Oracle.Options.Multimedia.md)\. -+ Multitenant \(single\-tenant configuration only\) - - The multitenant architecture is supported for all Oracle Database 19c and higher releases\. For more information, see [Overview of RDS for Oracle CDBs](oracle-multitenant.md#Oracle.Concepts.single-tenant) and [Limitations of a single\-tenant CDB](Oracle.Concepts.limitations.md#Oracle.Concepts.single-tenant-limitations)\. -+ Network encryption - - For more information, see [Oracle native network encryption](Appendix.Oracle.Options.NetworkEncryption.md) and [Oracle Secure Sockets Layer](Appendix.Oracle.Options.SSL.md)\. -+ Partitioning -+ Application\-level sharding \(but not the Oracle Sharding feature\) -+ Spatial and Graph - - For more information, see [Oracle Spatial](Oracle.Options.Spatial.md)\. -+ Star Query Optimization -+ Streams and Advanced Queuing -+ Summary Management – Materialized View Query Rewrite -+ Text \(File and URL data store types are not supported\) -+ Total Recall -+ Transparent Data Encryption \(TDE\) - - For more information, see [Oracle Transparent Data Encryption](Appendix.Oracle.Options.AdvSecurity.md)\. -+ Unified Auditing, Mixed Mode - - For more information, see [ Mixed mode auditing](https://docs.oracle.com/en/database/oracle/oracle-database/12.2/dbseg/introduction-to-auditing.html#GUID-4A3AEFC3-5422-4320-A048-8219EC96EAC1) in the Oracle documentation\. -+ XML DB \(without the XML DB Protocol Server\) - - For more information, see [Oracle XML DB](Appendix.Oracle.Options.XMLDB.md)\. -+ Virtual Private Database - -## Unsupported features in RDS for Oracle - -Amazon RDS for Oracle doesn't support the following Oracle Database features: -+ Automatic Storage Management \(ASM\) -+ Database Vault -+ Flashback Database -**Note** -For alternative solutions, see the AWS Database Blog entry [Alternatives to the Oracle flashback database feature in Amazon RDS for Oracle](http://aws.amazon.com/blogs/database/alternatives-to-the-oracle-flashback-database-feature-in-amazon-rds-for-oracle/)\. -+ FTP and SFTP -+ Hybrid partitioned tables -+ Messaging Gateway -+ Oracle Enterprise Manager Cloud Control Management Repository -+ Real Application Clusters \(Oracle RAC\) -+ Real Application Testing -+ Unified Auditing, Pure Mode -+ Workspace Manager \(WMSYS\) schema - -**Note** -The preceding list is not exhaustive\. - -**Warning** -In general, Amazon RDS doesn't prevent you from creating schemas for unsupported features\. However, if you create schemas for Oracle features and components that require SYSDBA privileges, you can damage the data dictionary and affect the availability of your DB instance\. Use only supported features and schemas that are available in [Adding options to Oracle DB instances](Appendix.Oracle.Options.md)\. \ No newline at end of file diff --git a/doc_source/Oracle.Concepts.HugePages.md b/doc_source/Oracle.Concepts.HugePages.md deleted file mode 100644 index 09cfc4b..0000000 --- a/doc_source/Oracle.Concepts.HugePages.md +++ /dev/null @@ -1,77 +0,0 @@ -# Turning on HugePages for an RDS for Oracle instance - -Amazon RDS for Oracle supports Linux kernel HugePages for increased database scalability\. HugePages results in smaller page tables and less CPU time spent on memory management, increasing the performance of large database instances\. For more information, see [Overview of HugePages](https://docs.oracle.com/database/121/UNXAR/appi_vlm.htm#UNXAR400) in the Oracle documentation\. - -You can use HugePages with all supported versions and editions of RDS for Oracle\. - - The `use_large_pages` parameter controls whether HugePages are turned on for a DB instance\. The possible settings for this parameter are `ONLY`, `FALSE`, and `{DBInstanceClassHugePagesDefault}`\. The `use_large_pages` parameter is set to `{DBInstanceClassHugePagesDefault}` in the default DB parameter group for Oracle\. - -To control whether HugePages are turned on for a DB instance automatically, you can use the `DBInstanceClassHugePagesDefault` formula variable in parameter groups\. The value is determined as follows: -+ For the DB instance classes mentioned in the table following, `DBInstanceClassHugePagesDefault` always evaluates to `FALSE` by default, and `use_large_pages` evaluates to `FALSE`\. You can turn on HugePages manually for these DB instance classes if the DB instance class has at least 14 GiB of memory\. -+ For DB instance classes not mentioned in the table following, if the DB instance class has less than 14 GiB of memory, `DBInstanceClassHugePagesDefault` always evaluates to `FALSE`\. Also, `use_large_pages` evaluates to `FALSE`\. -+ For DB instance classes not mentioned in the table following, if the instance class has at least 14 GiB of memory and less than 100 GiB of memory, `DBInstanceClassHugePagesDefault` evaluates to `TRUE` by default\. Also, `use_large_pages` evaluates to `ONLY`\. You can turn off HugePages manually by setting `use_large_pages` to `FALSE`\. -+ For DB instance classes not mentioned in the table following, if the instance class has at least 100 GiB of memory, `DBInstanceClassHugePagesDefault` always evaluates to `TRUE`\. Also, `use_large_pages` evaluates to `ONLY` and HugePages can't be disabled\. - -HugePages are not turned on by default for the following DB instance classes\. - - -**** - -| DB instance class family | DB instance classes with HugePages not turned on by default | -| --- | --- | -| db\.m5 | db\.m5\.large | -| db\.m4 | db\.m4\.large, db\.m4\.xlarge, db\.m4\.2xlarge, db\.m4\.4xlarge, db\.m4\.10xlarge | -| db\.t3 | db\.t3\.micro, db\.t3\.small, db\.t3\.medium, db\.t3\.large | - -For more information about DB instance classes, see [Hardware specifications for DB instance classes](Concepts.DBInstanceClass.md#Concepts.DBInstanceClass.Summary)\. - -To turn on HugePages for new or existing DB instances manually, set the `use_large_pages` parameter to `ONLY`\. You can't use HugePages with Oracle Automatic Memory Management \(AMM\)\. If you set the parameter `use_large_pages` to `ONLY`, then you must also set both `memory_target` and `memory_max_target` to `0`\. For more information about setting DB parameters for your DB instance, see [Working with parameter groups](USER_WorkingWithParamGroups.md)\. - -You can also set the `sga_target`, `sga_max_size`, and `pga_aggregate_target` parameters\. When you set system global area \(SGA\) and program global area \(PGA\) memory parameters, add the values together\. Subtract this total from your available instance memory \(`DBInstanceClassMemory`\) to determine the free memory beyond the HugePages allocation\. You must leave free memory of at least 2 GiB, or 10 percent of the total available instance memory, whichever is smaller\. - -After you configure your parameters, you must reboot your DB instance for the changes to take effect\. For more information, see [Rebooting a DB instance](USER_RebootInstance.md)\. - -**Note** -The Oracle DB instance defers changes to SGA\-related initialization parameters until you reboot the instance without failover\. In the Amazon RDS console, choose **Reboot** but *do not* choose **Reboot with failover**\. In the AWS CLI, call the `reboot-db-instance` command with the `--no-force-failover` parameter\. The DB instance does not process the SGA\-related parameters during failover or during other maintenance operations that cause the instance to restart\. - -The following is a sample parameter configuration for HugePages that enables HugePages manually\. You should set the values to meet your needs\. - -``` -1. memory_target = 0 -2. memory_max_target = 0 -3. pga_aggregate_target = {DBInstanceClassMemory*1/8} -4. sga_target = {DBInstanceClassMemory*3/4} -5. sga_max_size = {DBInstanceClassMemory*3/4} -6. use_large_pages = ONLY -``` - -Assume the following parameters values are set in a parameter group\. - -``` -1. memory_target = IF({DBInstanceClassHugePagesDefault}, 0, {DBInstanceClassMemory*3/4}) -2. memory_max_target = IF({DBInstanceClassHugePagesDefault}, 0, {DBInstanceClassMemory*3/4}) -3. pga_aggregate_target = IF({DBInstanceClassHugePagesDefault}, {DBInstanceClassMemory*1/8}, 0) -4. sga_target = IF({DBInstanceClassHugePagesDefault}, {DBInstanceClassMemory*3/4}, 0) -5. sga_max_size = IF({DBInstanceClassHugePagesDefault}, {DBInstanceClassMemory*3/4}, 0) -6. use_large_pages = {DBInstanceClassHugePagesDefault} -``` - -The parameter group is used by a db\.r4 DB instance class with less than 100 GiB of memory\. With these parameter settings and `use_large_pages` set to `{DBInstanceClassHugePagesDefault}`, HugePages are turned on for the db\.r4 instance\. - -Consider another example with following parameters values set in a parameter group\. - -``` -1. memory_target = IF({DBInstanceClassHugePagesDefault}, 0, {DBInstanceClassMemory*3/4}) -2. memory_max_target = IF({DBInstanceClassHugePagesDefault}, 0, {DBInstanceClassMemory*3/4}) -3. pga_aggregate_target = IF({DBInstanceClassHugePagesDefault}, {DBInstanceClassMemory*1/8}, 0) -4. sga_target = IF({DBInstanceClassHugePagesDefault}, {DBInstanceClassMemory*3/4}, 0) -5. sga_max_size = IF({DBInstanceClassHugePagesDefault}, {DBInstanceClassMemory*3/4}, 0) -6. use_large_pages = FALSE -``` - -The parameter group is used by a db\.r4 DB instance class and a db\.r5 DB instance class, both with less than 100 GiB of memory\. With these parameter settings, HugePages are turned off on the db\.r4 and db\.r5 instance\. - -**Note** -If this parameter group is used by a db\.r4 DB instance class or db\.r5 DB instance class with at least 100 GiB of memory, the `FALSE` setting for `use_large_pages` is overridden and set to `ONLY`\. In this case, a customer notification regarding the override is sent\. - -After HugePages are active on your DB instance, you can view HugePages information by enabling enhanced monitoring\. For more information, see [Monitoring OS metrics with Enhanced Monitoring](USER_Monitoring.OS.md)\. \ No newline at end of file diff --git a/doc_source/Oracle.Concepts.InstanceClasses.md b/doc_source/Oracle.Concepts.InstanceClasses.md deleted file mode 100644 index d8db9af..0000000 --- a/doc_source/Oracle.Concepts.InstanceClasses.md +++ /dev/null @@ -1,53 +0,0 @@ -# RDS for Oracle instance classes - -The computation and memory capacity of a DB instance is determined by its instance class\. The DB instance class you need depends on your processing power and memory requirements\. - - - -## Supported RDS for Oracle instance classes - -The supported RDS for Oracle instance classes are a subset of the RDS DB instance classes\. For the complete list of RDS instance classes, see [DB instance classes](Concepts.DBInstanceClass.md)\. - -RDS for Oracle also offers instance classes that are optimized for workloads that require additional memory, storage, and I/O per vCPU\. These instance classes use the following naming convention: - -``` -db.r5b.instance_size.tpcthreads_per_core.memratio -db.r5.instance_size.tpcthreads_per_core.memratio -``` - -The following is an example of a supported instance class: - -``` -db.r5b.4xlarge.tpc2.mem2x -``` - -The components of the preceding instance class name are as follows: -+ `db.r5b.4xlarge` – The name of the instance class\. -+ `tpc2` – The threads per core\. A value of 2 means that multithreading is turned on\. If the value is 1, multithreading is turned off\. -+ `mem2x` – The ratio of additional memory to the standard memory for the instance class\. In this example, the optimization provides twice as much memory as a standard db\.r5\.4xlarge instance\. - -The following table lists all instance classes supported for Oracle Database\. Oracle Database 12c Release 1 \(12\.1\.0\.2\) and Oracle Database 12c Release 2 \(12\.2\.0\.2\) are listed in the table, but support for these releases is deprecated\. For information about the memory attributes of each type, see [ RDS for Oracle instance types](http://aws.amazon.com/rds/oracle/instance-types)\. - - -**** -[\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Oracle.Concepts.InstanceClasses.html) - -**Note** -We encourage all BYOL customers to consult their licensing agreement to assess the impact of Amazon RDS for Oracle deprecations\. For more information on the compute capacity of DB instance classes supported by RDS for Oracle, see [DB instance classes](Concepts.DBInstanceClass.md) and [Configuring the processor for a DB instance class](Concepts.DBInstanceClass.md#USER_ConfigureProcessor)\. - -**Note** -If you have DB snapshots of DB instances that were using deprecated DB instance classes, you can choose a DB instance class that is not deprecated when you restore the DB snapshots\. For more information, see [Restoring from a DB snapshot](USER_RestoreFromSnapshot.md)\. - -## Deprecated Oracle DB instance classes - -The following DB instance classes are deprecated for RDS for Oracle: -+ db\.m1, db\.m2, db\.m3, db\.m4 -+ db\.t3\.micro \(supported only on 12\.1\.0\.2, which is deprecated\) -+ db\.t1, db\.t2 -+ db\.r1, db\.r2, db\.r3, db\.r4 - -The preceding DB instance classes have been replaced by better performing DB instance classes that are generally available at a lower cost\. If you have DB instances that use deprecated DB instance classes, you have the following options: -+ Allow Amazon RDS to modify each DB instance automatically to use a comparable non\-deprecated DB instance class\. For deprecation timelines, see [DB instance class types](Concepts.DBInstanceClass.md#Concepts.DBInstanceClass.Types)\. -+ Change the DB instance class yourself by modifying the DB instance\. For more information, see [Modifying an Amazon RDS DB instance](Overview.DBInstance.Modifying.md)\. - -If you have DB snapshots of DB instances that were using deprecated DB instance classes, you can choose a DB instance class that is not deprecated when you restore the DB snapshots\. For more information, see [Restoring from a DB snapshot](USER_RestoreFromSnapshot.md)\. \ No newline at end of file diff --git a/doc_source/Oracle.Concepts.Licensing.md b/doc_source/Oracle.Concepts.Licensing.md deleted file mode 100644 index e154da1..0000000 --- a/doc_source/Oracle.Concepts.Licensing.md +++ /dev/null @@ -1,100 +0,0 @@ -# RDS for Oracle licensing options - -Amazon RDS for Oracle has two licensing options: License Included \(LI\) and Bring Your Own License \(BYOL\)\. After you create an Oracle DB instance on Amazon RDS, you can change the licensing model by modifying the DB instance\. For more information, see [Modifying an Amazon RDS DB instance](Overview.DBInstance.Modifying.md)\. - -## License Included - -In the License Included model, you don't need to purchase Oracle Database licenses separately\. AWS holds the license for the Oracle database software\. In this model, if you have an AWS Support account with case support, contact AWS Support for both Amazon RDS and Oracle Database service requests\. The License Included model is only supported on Amazon RDS for Oracle Database Standard Edition Two \(SE2\)\. - -## Bring Your Own License \(BYOL\) - -In the BYOL model, you can use your existing Oracle Database licenses to deploy databases on Amazon RDS\. Make sure that you have the appropriate Oracle Database license \(with Software Update License and Support\) for the DB instance class and Oracle Database edition you wish to run\. You must also follow Oracle's policies for licensing Oracle Database software in the cloud computing environment\. For more information on Oracle's licensing policy for Amazon EC2, see [ Licensing Oracle software in the cloud computing environment](http://www.oracle.com/us/corporate/pricing/cloud-licensing-070579.pdf)\. - -In this model, you continue to use your active Oracle support account, and you contact Oracle directly for Oracle Database service requests\. If you have an AWS Support account with case support, you can contact AWS Support for Amazon RDS issues\. Amazon Web Services and Oracle have a multi\-vendor support process for cases that require assistance from both organizations\. - -Amazon RDS supports the BYOL model only for Oracle Database Enterprise Edition \(EE\) and Oracle Database Standard Edition Two \(SE2\)\. - -### Integrating with AWS License Manager - -To make it easier to monitor Oracle license usage in the BYOL model, [AWS License Manager](http://aws.amazon.com/license-manager/) integrates with Amazon RDS for Oracle\. License Manager supports tracking of RDS for Oracle engine editions and licensing packs based on virtual cores \(vCPUs\)\. You can also use License Manager with AWS Organizations to manage all of your organizational accounts centrally\. - -The following table shows the product information filters for RDS for Oracle\. - -[\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Oracle.Concepts.Licensing.html) - -To track license usage of your Oracle DB instances, you can create a license configuration\. In this case, RDS for Oracle resources that match the product information filter are automatically associated with the license configuration\. Discovery of Oracle DB instances can take up to 24 hours\. - -#### Console - -**To create a license configuration to track the license usage of your Oracle DB instances** - -1. Go to [https://console\.aws\.amazon\.com/license\-manager/](https://console.aws.amazon.com/license-manager/)\. - -1. Create a license configuration\. - - For instructions, see [Create a license configuration](https://docs.aws.amazon.com/license-manager/latest/userguide/create-license-configuration.html) in the *AWS License Manager User Guide*\. - - Add a rule for an **RDS Product Information Filter** in the **Product Information** panel\. - - For more information, see [ProductInformation](https://docs.aws.amazon.com/license-manager/latest/APIReference/API_ProductInformation.html) in the *AWS License Manager API Reference*\. - -#### AWS CLI - -To create a license configuration by using the AWS CLI, call the [create\-license\-configuration](https://docs.aws.amazon.com/cli/latest/reference/license-manager/create-license-configuration.html) command\. Use the `--cli-input-json` or `--cli-input-yaml` parameters to pass the parameters to the command\. - -**Example** -The following code creates a license configuration for Oracle Enterprise Edition\. - -``` -aws license-manager create-license-configuration -cli-input-json file://rds-oracle-ee.json -``` -The following is the sample `rds-oracle-ee.json` file used in the example\. - -``` -{ - "Name": "rds-oracle-ee", - "Description": "RDS Oracle Enterprise Edition", - "LicenseCountingType": "vCPU", - "LicenseCountHardLimit": false, - "ProductInformationList": [ - { - "ResourceType": "RDS", - "ProductInformationFilterList": [ - { - "ProductInformationFilterName": "Engine Edition", - "ProductInformationFilterValue": ["oracle-ee"], - "ProductInformationFilterComparator": "EQUALS" - } - ] - } - ] -} -``` - -For more information about product information, see [Automated discovery of resource inventory](https://docs.aws.amazon.com/license-manager/latest/userguide/automated-discovery.html) in the *AWS License Manager User Guide*\. - -For more information about the `--cli-input` parameter, see [Generating AWS CLI skeleton and input parameters from a JSON or YAML input file](https://docs.aws.amazon.com/cli/latest/userguide/cli-usage-skeleton.html) in the *AWS CLI User Guide*\. - -### Migrating between Oracle editions - -If you have an unused BYOL Oracle license appropriate for the edition and class of DB instance that you plan to run, you can migrate from Standard Edition 2 \(SE2\) to Enterprise Edition \(EE\)\. You can't migrate from Enterprise Edition to other editions\. - -**To change the edition and retain your data** - -1. Create a snapshot of the DB instance\. - - For more information, see [Creating a DB snapshot](USER_CreateSnapshot.md)\. - -1. Restore the snapshot to a new DB instance, and select the Oracle database edition you want to use\. - - For more information, see [Restoring from a DB snapshot](USER_RestoreFromSnapshot.md)\. - -1. \(Optional\) Delete the old DB instance, unless you want to keep it running and have the appropriate Oracle Database licenses for it\. - - For more information, see [Deleting a DB instance](USER_DeleteInstance.md)\. - -## Licensing Oracle Multi\-AZ deployments - -Amazon RDS supports Multi\-AZ deployments for Oracle as a high\-availability, failover solution\. We recommend Multi\-AZ for production workloads\. For more information, see [Configuring and managing a Multi\-AZ deployment](Concepts.MultiAZ.md)\. - -If you use the Bring Your Own License model, you must have a license for both the primary DB instance and the standby DB instance in a Multi\-AZ deployment\. \ No newline at end of file diff --git a/doc_source/Oracle.Concepts.NNE.md b/doc_source/Oracle.Concepts.NNE.md deleted file mode 100644 index 71c42ba..0000000 --- a/doc_source/Oracle.Concepts.NNE.md +++ /dev/null @@ -1,18 +0,0 @@ -# Using native network encryption with an RDS for Oracle DB instance - -Oracle Database offers two ways to encrypt data over the network: native network encryption \(NNE\) and Transport Layer Security \(TLS\)\. NNE is a proprietary Oracle security feature, whereas TLS is an industry standard\. RDS for Oracle supports NNE for all editions of Oracle Database\. - -NNE has the following advantages over TLS: -+ You can control NNE on the client and server using settings in the NNE option: - + `SQLNET.ALLOW_WEAK_CRYPTO_CLIENTS` and `SQLNET.ALLOW_WEAK_CRYPTO` - + `SQLNET.CRYPTO_CHECKSUM_CLIENT` and `SQLNET.CRYPTO_CHECKSUM_SERVER` - + `SQLNET.CRYPTO_CHECKSUM_TYPES_CLIENT` and `SQLNET.CRYPTO_CHECKSUM_TYPES_SERVER` - + `SQLNET.ENCRYPTION_CLIENT` and `SQLNET.ENCRYPTION_SERVER` - + `SQLNET.ENCRYPTION_TYPES_CLIENT` and `SQLNET.ENCRYPTION_TYPES_SERVER` -+ In most cases, you don't need to configure your client or server\. In contrast, TSL requires you to configure both client and server\. -+ No certificates are required\. In TLS, the server requires a certificate \(which eventually expires\), and the client requires a trusted root certificate for the certificate authority that issued the server’s certificate\. - -To enable NNE encryption for an Oracle DB instance, add the Oracle NNE option to the option group associated with the DB instance\. For more information, see [Oracle native network encryption](Appendix.Oracle.Options.NetworkEncryption.md)\. - -**Note** -You can't use both NNE and TLS on the same DB instance\. \ No newline at end of file diff --git a/doc_source/Oracle.Concepts.ONA.md b/doc_source/Oracle.Concepts.ONA.md deleted file mode 100644 index 1f0c420..0000000 --- a/doc_source/Oracle.Concepts.ONA.md +++ /dev/null @@ -1,412 +0,0 @@ -# Configuring UTL\_HTTP access using certificates and an Oracle wallet - -Amazon RDS supports outbound network access on your Oracle DB instances\. To connect your DB instance to the network, you can use the following PL/SQL packages: - -`UTL_HTTP` -This package makes HTTP calls from SQL and PL/SQL\. You can use it to access data on the Internet over HTTP\. For more information, see [UTL\_HTTP](https://docs.oracle.com/en/database/oracle/oracle-database/19/arpls/UTL_HTTP.html#GUID-A85D2D1F-90FC-45F1-967F-34368A23C9BB) in the Oracle documentation\. - -`UTL_TCP` -This package provides TCP/IP client\-side access functionality in PL/SQL\. This package is useful to PL/SQL applications that use Internet protocols and email\. For more information, see [UTL\_TCP](https://docs.oracle.com/en/database/oracle/oracle-database/19/arpls/UTL_TCP.html#GUID-348AFFE8-78B2-4217-AE73-384F46A1D292) in the Oracle documentation\. - -`UTL_SMTP` -This package provides interfaces to the SMTP commands that enable a client to dispatch emails to an SMTP server\. For more information, see [UTL\_SMTP](https://docs.oracle.com/en/database/oracle/oracle-database/19/arpls/UTL_SMTP.html#GUID-F0065C52-D618-4F8A-A361-7B742D44C520) in the Oracle documentation\. - -Before configuring your instance for network access, review the following requirements and considerations: -+ To use SMTP with the UTL\_MAIL option, see [Oracle UTL\_MAIL](Oracle.Options.UTLMAIL.md)\. -+ The Domain Name Server \(DNS\) name of the remote host can be any of the following: - + Publicly resolvable\. - + The endpoint of an Amazon RDS DB instance\. - + Resolvable through a custom DNS server\. For more information, see [Setting up a custom DNS server](Appendix.Oracle.CommonDBATasks.System.md#Appendix.Oracle.CommonDBATasks.CustomDNS)\. - + The private DNS name of an Amazon EC2 instance in the same VPC or a peered VPC\. In this case, make sure that the name is resolvable through a custom DNS server\. Alternatively, to use the DNS provided by Amazon, you can enable the `enableDnsSupport` attribute in the VPC settings and enable DNS resolution support for the VPC peering connection\. For more information, see [DNS support in your VPC](https://docs.aws.amazon.com/vpc/latest/userguide/vpc-dns.html#vpc-dns-support) and [Modifying your VPC peering connection](https://docs.aws.amazon.com/vpc/latest/peering/working-with-vpc-peering.html#modify-peering-connections)\. - + To connect securely to remote SSL/TLS resources, we recommend that you create and upload customized Oracle wallets\. By using the Amazon S3 integration with Amazon RDS for Oracle feature, you can download a wallet from Amazon S3 into Oracle DB instances\. For information about Amazon S3 integration for Oracle, see [Amazon S3 integration](oracle-s3-integration.md)\. -+ You can establish database links between Oracle DB instances over an SSL/TLS endpoint if the Oracle SSL option is configured for each instance\. No further configuration is required\. For more information, see [Oracle Secure Sockets Layer](Appendix.Oracle.Options.SSL.md)\. - -By completing the following tasks, you can configure `UTL_HTTP.REQUEST` to work with websites that require client authentication certificates during the SSL handshake\. You can also configure password authentication for `UTL_HTTP` access to websites by modifying the Oracle wallet generation commands and the `DBMS_NETWORK_ACL_ADMIN.APPEND_WALLET_ACE` procedure\. For more information, see [ DBMS\_NETWORK\_ACL\_ADMIN](https://docs.oracle.com/en/database/oracle/oracle-database/21/arpls/DBMS_NETWORK_ACL_ADMIN.html) in the Oracle Database documentation\. - -**Note** -You can adapt the following tasks for `UTL_SMTP`, which enables you to send emails over SSL/TLS \(including [Amazon Simple Email Service](http://aws.amazon.com/ses/)\)\. - -**Topics** -+ [Step 1: Get the root certificate for a website](#website-root-certificate) -+ [Step 2: Create an Oracle wallet](#create-oracle-wallet) -+ [Step 3: Download your Oracle wallet to your RDS for Oracle instance](#upload-wallet-to-instance) -+ [Step 4: Grant user permissions for the Oracle wallet](#config-oracle-wallet-user) -+ [Step 5: Configure access to a website from your DB instance](#config-website-access) -+ [Step 6: Test connections from your DB instance to a website](#test_utl_http) - -## Step 1: Get the root certificate for a website - -For the RDS for Oracle instance to make secure connections to a website, add the root CA certificate\. Amazon RDS uses the root certificate to sign the website certificate to the Oracle wallet\. - -You can get the root certificate in various ways\. For example, you can do the following: - -1. Use a web server to visit the website secured by the certificate\. - -1. Download the root certificate that was used for signing\. - -For AWS services, root certificates typically reside in the [Amazon trust services repository](https://www.amazontrust.com/repository/)\. - -## Step 2: Create an Oracle wallet - -Create an Oracle wallet that contains both the web server certificates and the client authentication certificates\. The RDS Oracle instance uses the web server certificate to establish a secure connection to the website\. The website needs the client certificate to authenticate the Oracle database user\. - -You might want to configure secure connections without using client certificates for authentication\. In this case, you can skip the Java keystore steps in the following procedure\. - -**To create an Oracle wallet** - -1. Place the root and client certificates in a single directory, and then change into this directory\. - -1. Convert the \.p12 client certificate to the Java keystore\. -**Note** -If you're not using client certificates for authentication, you can skip this step\. - - The following example converts the client certificate named *client\_certificate\.p12* to the Java keystore named *client\_keystore\.jks*\. The keystore is then included in the Oracle wallet\. The keystore password is *P12PASSWORD*\. - - ``` - orapki wallet pkcs12_to_jks -wallet ./client_certificate.p12 -jksKeyStoreLoc ./client_keystore.jks -jksKeyStorepwd P12PASSWORD - ``` - -1. Create a directory for your Oracle wallet that is different from the certificate directory\. - - The following example creates the directory `/tmp/wallet`\. - - ``` - mkdir -p /tmp/wallet - ``` - -1. Create an Oracle wallet in your wallet directory\. - - The following example sets the Oracle wallet password to *P12PASSWORD*, which is the same password used by the Java keystore in a previous step\. Using the same password is convenient, but not necessary\. The `-auto_login` parameter turns on the automatic login feature, so that you don’t need to specify a password every time you want to access it\. - - ``` - orapki wallet create -wallet /tmp/wallet -pwd P12PASSWORD -auto_login - ``` - -1. Add the Java keystore to your Oracle wallet\. -**Note** -If you're not using client certificates for authentication, you can skip this step\. - - The following example adds the keystore *client\_keystore\.jks* to the Oracle wallet named */tmp/wallet*\. In this example, you specify the same password for the Java keystore and the Oracle wallet\. - - ``` - orapki wallet jks_to_pkcs12 -wallet /tmp/wallet -pwd P12PASSWORD -keystore ./client_keystore.jks -jkspwd P12PASSWORD - ``` - -1. Add the root certificate for your target website to the Oracle wallet\. - - The following example adds a certificate named *Root\_CA\.cer*\. - - ``` - orapki wallet add -wallet /tmp/wallet -trusted_cert -cert ./Root_CA.cer -pwd P12PASSWORD - ``` - -1. Add any intermediate certificates\. - - The following example adds a certificate named *Intermediate\.cer*\. Repeat this step as many times as need to load all intermediate certificates\. - - ``` - orapki wallet add -wallet /tmp/wallet -trusted_cert -cert ./Intermediate.cer -pwd P12PASSWORD - ``` - -1. Confirm that your newly created Oracle wallet has the required certificates\. - - ``` - orapki wallet display -wallet /tmp/wallet -pwd P12PASSWORD - ``` - -## Step 3: Download your Oracle wallet to your RDS for Oracle instance - -In this step, you upload your Oracle wallet to Amazon S3, and then download the wallet from Amazon S3 to your RDS for Oracle instance\. - -**To download your Oracle wallet to your RDS for Oracle DB instance** - -1. Complete the prerequisites for Amazon S3 integration with Oracle, and add the `S3_INTEGRATION` option to your Oracle DB instance\. Ensure that the IAM role for the option has access to the Amazon S3 bucket you are using\. - - For more information, see [Amazon S3 integration](oracle-s3-integration.md)\. - -1. Log in to your DB instance as the master user, and then create an Oracle directory to hold the Oracle wallet\. - - The following example creates an Oracle directory named *WALLET\_DIR*\. - - ``` - EXEC rdsadmin.rdsadmin_util.create_directory('WALLET_DIR'); - ``` - - For more information, see [Creating and dropping directories in the main data storage space](Appendix.Oracle.CommonDBATasks.Misc.md#Appendix.Oracle.CommonDBATasks.NewDirectories)\. - -1. Upload the Oracle wallet to your Amazon S3 bucket\. - - You can use any supported upload technique\. - -1. If you're re\-uploading an Oracle wallet, delete the existing wallet\. Otherwise, skip to the next step\. - - The following example removes the existing wallet, which is named *cwallet\.sso*\. - - ``` - EXEC UTL_FILE.FREMOVE ('WALLET_DIR','cwallet.sso'); - ``` - -1. Download the Oracle wallet from your Amazon S3 bucket to the Oracle DB instance\. - - The following example downloads the wallet named *cwallet\.sso* from the Amazon S3 bucket named *my\_s3\_bucket* to the DB instance directory named *WALLET\_DIR*\. - - ``` - SELECT rdsadmin.rdsadmin_s3_tasks.download_from_s3( - p_bucket_name => 'my_s3_bucket', - p_s3_prefix => 'cwallet.sso', - p_directory_name => 'WALLET_DIR') - AS TASK_ID FROM DUAL; - ``` - -1. \(Optional\) Download a password\-protected Oracle wallet\. - - Download this wallet only if you want to require a password for every use of the wallet\. The following example downloads password\-protected wallet *ewallet\.p12*\. - - ``` - SELECT rdsadmin.rdsadmin_s3_tasks.download_from_s3( - p_bucket_name => 'my_s3_bucket', - p_s3_prefix => 'ewallet.p12', - p_directory_name => 'WALLET_DIR') - AS TASK_ID FROM DUAL; - ``` - -1. Check the status of your DB task\. - - Substitute the task ID returned from the preceding steps for *dbtask\-1234567890123\-4567\.log* in the following example\. - - ``` - SELECT TEXT FROM TABLE(rdsadmin.rds_file_util.read_text_file('BDUMP','dbtask-1234567890123-4567.log')); - ``` - -1. Check the contents of the directory that you're using to store the Oracle wallet\. - - ``` - SELECT * FROM TABLE(rdsadmin.rds_file_util.listdir(p_directory => 'WALLET_DIR')); - ``` - - For more information, see [Listing files in a DB instance directory](Appendix.Oracle.CommonDBATasks.Misc.md#Appendix.Oracle.CommonDBATasks.ListDirectories)\. - -## Step 4: Grant user permissions for the Oracle wallet - -You can either create a new database user or configure an existing user\. In either case, you must configure the user to access the Oracle wallet for secure connections and client authentication using certificates\. - -**To grant user permissions for the Oracle wallet** - -1. Log in your RDS for Oracle DB instance as the master user\. - -1. If you don't want to configure an existing database user, create a new user\. Otherwise, skip to the next step\. - - The following example creates a database user named *my\-user*\. - - ``` - CREATE USER my-user IDENTIFIED BY my-user-pwd; - GRANT CONNECT TO my-user; - ``` - -1. Grant permission to your database user on the directory containing your Oracle wallet\. - - The following example grants read access to user *my\-user* on directory *WALLET\_DIR*\. - - ``` - GRANT READ ON DIRECTORY WALLET_DIR TO my-user; - ``` - -1. Grant permission to your database user to use the `UTL_HTTP` package\. - - The following PL/SQL program grants `UTL_HTTP` access to user *my\-user*\. - - ``` - BEGIN - rdsadmin.rdsadmin_util.grant_sys_object('UTL_HTTP', UPPER('my-user')); - END; - / - ``` - -1. Grant permission to your database user to use the `UTL_FILE` package\. - - The following PL/SQL program grants `UTL_FILE` access to user *my\-user*\. - - ``` - BEGIN - rdsadmin.rdsadmin_util.grant_sys_object('UTL_FILE', UPPER('my-user')); - END; - / - ``` - -## Step 5: Configure access to a website from your DB instance - -In this step, you configure your Oracle database user so that it can connect to your target website using `UTL_HTTP`, your uploaded Oracle Wallet, and the client certificate\. For more information, see [Configuring Access Control to an Oracle Wallet ](https://docs.oracle.com/en/database/oracle/oracle-database/19/dbseg/managing-fine-grained-access-in-pl-sql-packages-and-types.html#GUID-0BCB5925-A40F-4507-95F9-5DA4A1919EBD) in the Oracle Database documentation\. - -**To configure access to a website from your RDS for Oracle DB instance** - -1. Log in your RDS for Oracle DB instance as the master user\. - -1. Create a Host Access Control Entry \(ACE\) for your user and the target website on a secure port\. - - The following example configures *my\-user* to access *secret\.encrypted\-website\.com* on secure port 443\. - - ``` - BEGIN - DBMS_NETWORK_ACL_ADMIN.APPEND_HOST_ACE( - host => 'secret.encrypted-website.com', - lower_port => 443, - upper_port => 443, - ace => xs$ace_type(privilege_list => xs$name_list('http'), - principal_name => 'my-user', - principal_type => xs_acl.ptype_db)); - END; - / - ``` - - For more information, see [Configuring Access Control for External Network Services ](https://docs.oracle.com/en/database/oracle/oracle-database/19/dbseg/managing-fine-grained-access-in-pl-sql-packages-and-types.html#GUID-3D5B66BC-0277-4887-9CD1-97DB44EB5213) in the Oracle Database documentation\. - -1. \(Optional\) Create an ACE for your user and target website on the standard port\. - - You might need to use the standard port if some web pages are served from the standard web server port \(80\) instead of the secure port \(443\)\. - - ``` - BEGIN - DBMS_NETWORK_ACL_ADMIN.APPEND_HOST_ACE( - host => 'secret.encrypted-website.com', - lower_port => 80, - upper_port => 80, - ace => xs$ace_type(privilege_list => xs$name_list('http'), - principal_name => 'my-user', - principal_type => xs_acl.ptype_db)); - END; - / - ``` - -1. Confirm that the access control entries exist\. - - ``` - SET LINESIZE 150 - COLUMN HOST FORMAT A40 - COLUMN ACL FORMAT A50 - - SELECT HOST, LOWER_PORT, UPPER_PORT, ACL - FROM DBA_NETWORK_ACLS - ORDER BY HOST; - ``` - -1. Grant permission to your database user to use the `UTL_HTTP` package\. - - The following PL/SQL program grants `UTL_HTTP` access to user *my\-user*\. - - ``` - BEGIN - rdsadmin.rdsadmin_util.grant_sys_object('UTL_HTTP', UPPER('my-user')); - END; - / - ``` - -1. Confirm that related access control lists exist\. - - ``` - SET LINESIZE 150 - COLUMN ACL FORMAT A50 - COLUMN PRINCIPAL FORMAT A20 - COLUMN PRIVILEGE FORMAT A10 - - SELECT ACL, PRINCIPAL, PRIVILEGE, IS_GRANT, - TO_CHAR(START_DATE, 'DD-MON-YYYY') AS START_DATE, - TO_CHAR(END_DATE, 'DD-MON-YYYY') AS END_DATE - FROM DBA_NETWORK_ACL_PRIVILEGES - ORDER BY ACL, PRINCIPAL, PRIVILEGE; - ``` - -1. Grant permission to your database user to use certificates for client authentication and your Oracle wallet for connections\. -**Note** -If you're not using client certificates for authentication, you can skip this step\. - - ``` - DECLARE - l_wallet_path all_directories.directory_path%type; - BEGIN - SELECT DIRECTORY_PATH - INTO l_wallet_path - FROM ALL_DIRECTORIES - WHERE UPPER(DIRECTORY_NAME)='WALLET_DIR'; - DBMS_NETWORK_ACL_ADMIN.APPEND_WALLET_ACE( - wallet_path => 'file:/' || l_wallet_path, - ace => xs$ace_type(privilege_list => xs$name_list('use_client_certificates'), - principal_name => 'my-user', - principal_type => xs_acl.ptype_db)); - END; - / - ``` - -## Step 6: Test connections from your DB instance to a website - -In this step, you configure your database user so that it can connect to the website using `UTL_HTTP`, your uploaded Oracle Wallet, and the client certificate\. - -**To configure access to a website from your RDS for Oracle DB instance** - -1. Log in your RDS for Oracle DB instance as a database user with `UTL_HTTP` permissions\. - -1. Confirm that a connection to your target website can resolve the host address\. - - The following example gets the host address from *secret\.encrypted\-website\.com*\. - - ``` - SELECT UTL_INADDR.GET_HOST_ADDRESS(host => 'secret.encrypted-website.com') - FROM DUAL; - ``` - -1. Test a failed connection\. - - The following query fails because `UTL_HTTP` requires the location of the Oracle wallet with the certificates\. - - ``` - SELECT UTL_HTTP.REQUEST('secret.encrypted-website.com') FROM DUAL; - ``` - -1. Test website access by using `UTL_HTTP.SET_WALLET` and selecting from `DUAL`\. - - ``` - DECLARE - l_wallet_path all_directories.directory_path%type; - BEGIN - SELECT DIRECTORY_PATH - INTO l_wallet_path - FROM ALL_DIRECTORIES - WHERE UPPER(DIRECTORY_NAME)='WALLET_DIR'; - UTL_HTTP.SET_WALLET('file:/' || l_wallet_path); - END; - / - - SELECT UTL_HTTP.REQUEST('secret.encrypted-website.com') FROM DUAL; - ``` - -1. \(Optional\) Test website access by storing your query in a variable and using `EXECUTE IMMEDIATE`\. - - ``` - DECLARE - l_wallet_path all_directories.directory_path%type; - v_webpage_sql VARCHAR2(1000); - v_results VARCHAR2(32767); - BEGIN - SELECT DIRECTORY_PATH - INTO l_wallet_path - FROM ALL_DIRECTORIES - WHERE UPPER(DIRECTORY_NAME)='WALLET_DIR'; - v_webpage_sql := 'SELECT UTL_HTTP.REQUEST(''secret.encrypted-website.com'', '''', ''file:/' ||l_wallet_path||''') FROM DUAL'; - DBMS_OUTPUT.PUT_LINE(v_webpage_sql); - EXECUTE IMMEDIATE v_webpage_sql INTO v_results; - DBMS_OUTPUT.PUT_LINE(v_results); - END; - / - ``` - -1. \(Optional\) Find the file system location of your Oracle wallet directory\. - - ``` - SELECT * FROM TABLE(rdsadmin.rds_file_util.listdir(p_directory => 'WALLET_DIR')); - ``` - - Use the output from the previous command to make an HTTP request\. For example, if the directory is *rdsdbdata/userdirs/01*, run the following query\. - - ``` - SELECT UTL_HTTP.REQUEST('https://secret.encrypted-website.com/', '', 'file://rdsdbdata/userdirs/01') - FROM DUAL; - ``` \ No newline at end of file diff --git a/doc_source/Oracle.Concepts.RestrictedDBAPrivileges.md b/doc_source/Oracle.Concepts.RestrictedDBAPrivileges.md deleted file mode 100644 index 2614956..0000000 --- a/doc_source/Oracle.Concepts.RestrictedDBAPrivileges.md +++ /dev/null @@ -1,10 +0,0 @@ -# Securing Oracle DB instance connections - -Amazon RDS for Oracle supports SSL/TLS encrypted connections and also the Oracle Native Network Encryption \(NNE\) option to encrypt connections between your application and your Oracle DB instance\. For more information about the Oracle Native Network Encryption option, see [Oracle native network encryption](Appendix.Oracle.Options.NetworkEncryption.md)\. - -**Topics** -+ [Using SSL with an RDS for Oracle DB instance](Oracle.Concepts.SSL.md) -+ [Updating your applications to use new SSL/TLS certificates](ssl-certificate-rotation-oracle.md) -+ [Using native network encryption with an RDS for Oracle DB instance](Oracle.Concepts.NNE.md) -+ [Configuring Kerberos authentication for Amazon RDS for Oracle](oracle-kerberos.md) -+ [Configuring UTL\_HTTP access using certificates and an Oracle wallet](Oracle.Concepts.ONA.md) \ No newline at end of file diff --git a/doc_source/Oracle.Concepts.SSL.md b/doc_source/Oracle.Concepts.SSL.md deleted file mode 100644 index 7bab2d3..0000000 --- a/doc_source/Oracle.Concepts.SSL.md +++ /dev/null @@ -1,10 +0,0 @@ -# Using SSL with an RDS for Oracle DB instance - -Secure Sockets Layer \(SSL\) is an industry\-standard protocol for securing network connections between client and server\. After SSL version 3\.0, the name was changed to Transport Layer Security \(TLS\), but we still often refer to the protocol as SSL\. Amazon RDS supports SSL encryption for Oracle DB instances\. Using SSL, you can encrypt a connection between your application client and your Oracle DB instance\. SSL support is available in all AWS Regions for Oracle\. - -To enable SSL encryption for an Oracle DB instance, add the Oracle SSL option to the option group associated with the DB instance\. Amazon RDS uses a second port, as required by Oracle, for SSL connections\. Doing this allows both clear text and SSL\-encrypted communication to occur at the same time between a DB instance and an Oracle client\. For example, you can use the port with clear text communication to communicate with other resources inside a VPC while using the port with SSL\-encrypted communication to communicate with resources outside the VPC\. - -For more information, see [Oracle Secure Sockets Layer](Appendix.Oracle.Options.SSL.md)\. - -**Note** -You can't use both SSL and Oracle native network encryption \(NNE\) on the same DB instance\. Before you can use SSL encryption, you must disable any other connection encryption\. \ No newline at end of file diff --git a/doc_source/Oracle.Concepts.database-versions.md b/doc_source/Oracle.Concepts.database-versions.md deleted file mode 100644 index 166ebfe..0000000 --- a/doc_source/Oracle.Concepts.database-versions.md +++ /dev/null @@ -1,142 +0,0 @@ -# RDS for Oracle releases - -Amazon RDS for Oracle supports multiple Oracle Database releases\. - -**Note** -For information about upgrading your releases, see [Upgrading the RDS for Oracle DB engine](USER_UpgradeDBInstance.Oracle.md)\. - -**Topics** -+ [Oracle Database 21c with Amazon RDS](#Oracle.Concepts.FeatureSupport.21c) -+ [Oracle Database 19c with Amazon RDS](#Oracle.Concepts.FeatureSupport.19c) -+ [Oracle Database 12c with Amazon RDS](#Oracle.Concepts.FeatureSupport.12c) - -## Oracle Database 21c with Amazon RDS - -Amazon RDS supports Oracle Database 21c, which includes Oracle Enterprise Edition and Oracle Standard Edition Two\. Oracle Database 21c \(21\.0\.0\.0\) includes many new features and updates from the previous version\. A key change is that Oracle Database 21c supports only the multitenant architecture: you can no longer create a database as a traditional non\-CDB\. To learn more about the differences between CDBs and non\-CDBs, see [Limitations of a single\-tenant CDB](Oracle.Concepts.limitations.md#Oracle.Concepts.single-tenant-limitations)\. - -In this section, you can find the features and changes important to using Oracle Database 21c \(21\.0\.0\.0\) on Amazon RDS\. For a complete list of the changes, see the [Oracle database 21c](https://docs.oracle.com/en/database/oracle/oracle-database/21/index.html) documentation\. For a complete list of features supported by each Oracle Database 21c edition, see [ Permitted features, options, and management packs by Oracle database offering](https://docs.oracle.com/en/database/oracle/oracle-database/21/dblic/Licensing-Information.html) in the Oracle documentation\. - -### Amazon RDS parameter changes for Oracle Database 21c \(21\.0\.0\.0\) - -Oracle Database 21c \(21\.0\.0\.0\) includes several new parameters and parameters with new ranges and new default values\. - -**Topics** -+ [New parameters](#Oracle.Concepts.FeatureSupport.21c.parameters.new) -+ [Changes for the compatible parameter](#Oracle.Concepts.FeatureSupport.21c.parameters.compatible) -+ [Removed parameters](#Oracle.Concepts.FeatureSupport.21c.parameters.removed) - -#### New parameters - -The following table shows the new Amazon RDS parameters for Oracle Database 21c \(21\.0\.0\.0\)\. - - -**** - -| Name | Range of values | Default value | Modifiable | Description | -| --- | --- | --- | --- | --- | -| [blockchain\_table\_max\_no\_drop](https://docs.oracle.com/en/database/oracle/oracle-database/21/refrn/BLOCKCHAIN_TABLE_MAX_NO_DROP.html#GUID-26AF15B2-5621-4602-AA6E-D92842E4285C) | `NONE \| 0` | `NONE` | Y | Lets you control the maximum amount of idle time that can be specified when creating a blockchain table\. | -| [dbnest\_enable](https://docs.oracle.com/en/database/oracle/oracle-database/21/refrn/DBNEST_ENABLE.html#GUID-2F30C9D3-808E-42CD-ADA6-595FAE518A60) | `NONE \| CDB_RESOURCE_PDB_ALL` | `NONE` | N | Allows you to enable or disable dbNest\. DbNest provides operating system resource isolation and management, file system isolation, and secure computing for PDBs\. | -| [dbnest\_pdb\_fs\_conf](https://docs.oracle.com/en/database/oracle/oracle-database/21/refrn/DBNEST_PDB_FS_CONF.html) | `NONE \| pathname` | `NONE` | N | Specifies the dbNest file system configuration file for a PDB\. | -| [diagnostics\_control](https://docs.oracle.com/en/database/oracle/oracle-database/21/refrn/DIAGNOSTICS_CONTROL.html) | `ERROR \| WARNING \| IGNORE` | IGNORE | Y | Allows you to control and monitor the users who perform potentially unsafe database diagnostic operations\. | -| [drcp\_dedicated\_opt](https://docs.oracle.com/en/database/oracle/oracle-database/21/refrn/DRCP_DEDICATED_OPT.html) | `YES \| NO` | YES | Y | Enables or disables the use of dedicated optimization with Database Resident Connection Pooling \(DRCP\)\. | -| [enable\_per\_pdb\_drcp](https://docs.oracle.com/en/database/oracle/oracle-database/21/refrn/ENABLE_PER_PDB_DRCP.html) | `true \| false` | `true` | N | Controls whether Database Resident Connection Pooling \(DRCP\) configures one connection pool for the entire CDB or one isolated connection pool for each PDB\. | -| [inmemory\_deep\_vectorization](https://docs.oracle.com/en/database/oracle/oracle-database/21/refrn/INMEMORY_DEEP_VECTORIZATION.html#GUID-59E87FDC-1DB4-4ACD-A807-D0C1AE44210D) | `true \| false` | `true` | Y | Enables or disables the deep vectorization framework\. | -| [mandatory\_user\_profile](https://docs.oracle.com/en/database/oracle/oracle-database/21/refrn/MANDATORY_USER_PROFILE.html) | *profile\_name* | N/A | N | Specifies the mandatory user profile for a CDB or PDB\. | -| [optimizer\_capture\_sql\_quarantine](https://docs.oracle.com/en/database/oracle/oracle-database/21/refrn/OPTIMIZER_CAPTURE_SQL_QUARANTINE.html) | `true \| false` | `false` | Y | Enables or disables the deep vectorization framework\. | -| [optimizer\_use\_sql\_quarantine](https://docs.oracle.com/en/database/oracle/oracle-database/21/refrn/OPTIMIZER_CAPTURE_SQL_QUARANTINE.html#GUID-9DBBDBD3-2AA3-4627-9D3A-5330F447BEBB) | `true \| false` | `false` | Y | Enables or disables the automatic creation of SQL Quarantine configurations\. | -| [result\_cache\_execution\_threshold](https://docs.oracle.com/en/database/oracle/oracle-database/21/refrn/RESULT_CACHE_EXECUTION_THRESHOLD.html) | `0` to `68719476736` | `2` | Y | Specifies the maximum number of times a PL/SQL function can be executed before its result is stored in the result cache\. | -| [result\_cache\_max\_temp\_result](https://docs.oracle.com/en/database/oracle/oracle-database/21/refrn/RESULT_CACHE_MAX_TEMP_RESULT.html) | `0` to `100` | `5` | Y | Specifies the percentage of `RESULT_CACHE_MAX_TEMP_SIZE` that any single cached query result can consume\. | -| [result\_cache\_max\_temp\_size](https://docs.oracle.com/en/database/oracle/oracle-database/21/refrn/RESULT_CACHE_MAX_TEMP_SIZE.html) | `0` to `2199023255552` | `RESULT_CACHE_SIZE * 10` | Y | Specifies the maximum amount of temporary tablespace \(in bytes\) that can be consumed by the result cache\. | -| [sga\_min\_size](https://docs.oracle.com/en/database/oracle/oracle-database/21/refrn/SGA_MIN_SIZE.html) | `0` to `2199023255552` \(maximum value is 50% of `sga_target`\) | `0` | Y | Indicates a possible minimum value for SGA usage of a pluggable database \(PDB\)\. | -| [tablespace\_encryption\_default\_algorithm](https://docs.oracle.com/en/database/oracle/oracle-database/21/refrn/TABLESPACE_ENCRYPTION_DEFAULT_ALGORITHM.html) | `GOST256 \| SEED128 \| ARIA256 \| ARIA192 \| ARIA128 \| 3DES168 \| AES256 \| AES192 \| AES128` | AES128 | Y | Specifies the default algorithm the database uses when encrypting a tablespace\. | - -#### Changes for the compatible parameter - -The `compatible` parameter has a new maximum value for Oracle Database 21c \(21\.0\.0\.0\) on Amazon RDS\. The following table shows the new default value\. - - -**** - -| Parameter name | Oracle Database 21c \(21\.0\.0\.0\) maximum value | -| --- | --- | -| [ compatible](https://docs.oracle.com/en/database/oracle/oracle-database/19/refrn/COMPATIBLE.html#GUID-6C57EE11-BD06-4BB8-A0F7-D6CDDD086FA9) | 21\.0\.0 | - -#### Removed parameters - -The following parameters were removed in Oracle Database 21c \(21\.0\.0\.0\): -+ `remote_os_authent` -+ `sec_case_sensitive_logon` -+ `unified_audit_sga_queue_size` - -## Oracle Database 19c with Amazon RDS - -Amazon RDS supports Oracle Database 19c, which includes Oracle Enterprise Edition and Oracle Standard Edition Two\. - -Oracle Database 19c \(19\.0\.0\.0\) includes many new features and updates from the previous version\. In this section, you can find the features and changes important to using Oracle Database 19c \(19\.0\.0\.0\) on Amazon RDS\. For a complete list of the changes, see the [Oracle database 19c](https://docs.oracle.com/en/database/oracle/oracle-database/19/index.html) documentation\. For a complete list of features supported by each Oracle Database 19c edition, see [ Permitted features, options, and management packs by Oracle database offering](https://docs.oracle.com/en/database/oracle/oracle-database/19/dblic/Licensing-Information.html#GUID-0F9EB85D-4610-4EDF-89C2-4916A0E7AC87) in the Oracle documentation\. - -### Amazon RDS parameter changes for Oracle Database 19c \(19\.0\.0\.0\) - -Oracle Database 19c \(19\.0\.0\.0\) includes several new parameters and parameters with new ranges and new default values\. - -**Topics** -+ [New parameters](#Oracle.Concepts.FeatureSupport.19c.Parameters.new) -+ [Changes to the compatible parameter](#Oracle.Concepts.FeatureSupport.19c.Parameters.compatible) -+ [Removed parameters](#Oracle.Concepts.FeatureSupport.19c.Parameters.compatible.removed-parameters) - -#### New parameters - -The following table shows the new Amazon RDS parameters for Oracle Database 19c \(19\.0\.0\.0\)\. - - -**** - -| Name | Values | Modifiable | Description | -| --- | --- | --- | --- | -| [ lob\_signature\_enable](https://docs.oracle.com/en/database/oracle/oracle-database/19/refrn/lob_signature_enable.html#GUID-62997AB5-1084-4C9A-8258-8CB695C7A1D6) | TRUE, FALSE \(default\) | Y | Enables or disables the LOB locator signature feature\. | -| [ max\_datapump\_parallel\_per\_job](https://docs.oracle.com/en/database/oracle/oracle-database/19/refrn/MAX_DATAPUMP_PARALLEL_PER_JOB.html#GUID-33B1F962-B8C3-4DCE-BE68-66FC5D34ECA3) | 1 to 1024, or AUTO | Y | Specifies the maximum number of parallel processes allowed for each Oracle Data Pump job\. | - -#### Changes to the compatible parameter - -The `compatible` parameter has a new maximum value for Oracle Database 19c \(19\.0\.0\.0\) on Amazon RDS\. The following table shows the new default value\. - - -**** - -| Parameter name | Oracle Database 19c \(19\.0\.0\.0\) maximum value | -| --- | --- | -| [ compatible](https://docs.oracle.com/en/database/oracle/oracle-database/19/refrn/COMPATIBLE.html#GUID-6C57EE11-BD06-4BB8-A0F7-D6CDDD086FA9) | 19\.0\.0 | - -#### Removed parameters - -The following parameters were removed in Oracle Database 19c \(19\.0\.0\.0\): -+ `exafusion_enabled` -+ `max_connections` -+ `o7_dictionary_access` - -## Oracle Database 12c with Amazon RDS - -Amazon RDS has deprecated support for Oracle Database 12c on both Oracle Enterprise Edition and Oracle Standard Edition 2\. - -**Topics** -+ [Oracle Database 12c Release 2 \(12\.2\.0\.1\) with Amazon RDS](#Oracle.Concepts.FeatureSupport.12cV2Overview) -+ [Oracle Database 12c Release 1 \(12\.1\.0\.2\) with Amazon RDS](#Oracle.Concepts.FeatureSupport.12cV1Overview) - -### Oracle Database 12c Release 2 \(12\.2\.0\.1\) with Amazon RDS - -On March 31, 2022, Oracle Corporation deprecated support for Oracle Database 12c Release 2 \(12\.2\.0\.1\) for BYOL and LI\. On this date, the release moved from Oracle Extended Support to Oracle Sustaining Support, indicating the end of support for this release\. For more information, see the end of support timeline on [AWS re:Post](https://repost.aws/questions/QUESrwZfKMSSuijzLLHCQkYQ/announcement-amazon-rds-for-oracle-end-of-support-timeline-for-12-c-oracle-release-2-12-2-0-1-and-oracle-release-1-12-1-0-2-major-version)\. - - -| Date | Action | -| --- | --- | -| April 1, 2022 | Amazon RDS began automatic upgrades of your Oracle Database 12c Release 2 \(12\.2\.0\.1\) instances to Oracle Database 19c\. | -| April 1, 2022 | Amazon RDS began automatic upgrades to Oracle Database 19c for any Oracle Database 12c Release 2 \(12\.2\.0\.1\) DB instances restored from snapshots\. The automatic upgrade occurs during maintenance windows\. If maintenance windows aren't available when the upgrade needs to occur, Amazon RDS upgrades the engine immediately\. | - -### Oracle Database 12c Release 1 \(12\.1\.0\.2\) with Amazon RDS - -On July 31, 2022, Amazon RDS deprecated support for Oracle Database 12c Release 1 \(12\.1\.0\.2\) for BYOL and LI\. The release moved from Oracle Extended Support to Oracle Sustaining Support, indicating that Oracle Support will no longer release critical patch updates for this release\. For more information, see the end of support timeline on [AWS re:Post](https://repost.aws/questions/QUESrwZfKMSSuijzLLHCQkYQ/announcement-amazon-rds-for-oracle-end-of-support-timeline-for-12-c-oracle-release-2-12-2-0-1-and-oracle-release-1-12-1-0-2-major-version)\. - - -| Date | Action | -| --- | --- | -| August 1, 2022 | Amazon RDS began automatic upgrades of your Oracle Database 12c Release 1 \(12\.1\.0\.2\) instances to the latest Release Update \(RU\) for Oracle Database 19c\. The automatic upgrade occurs during maintenance windows\. If maintenance windows aren't available when the upgrade needs to occur, Amazon RDS upgrades the engine immediately\. | -| August 1, 2022 | Amazon RDS began automatic upgrades to Oracle Database 19c for any Oracle Database 12c Release 1 \(12\.1\.0\.2\) DB instances restored from snapshots\. | \ No newline at end of file diff --git a/doc_source/Oracle.Concepts.limitations.md b/doc_source/Oracle.Concepts.limitations.md deleted file mode 100644 index 0fdf7f5..0000000 --- a/doc_source/Oracle.Concepts.limitations.md +++ /dev/null @@ -1,70 +0,0 @@ -# RDS for Oracle limitations - -Following are important limitations of using RDS for Oracle\. - -**Note** -This list is not exhaustive\. - -**Topics** -+ [Oracle file size limits in Amazon RDS](#Oracle.Concepts.file-size-limits) -+ [Public synonyms for Oracle\-supplied schemas](#Oracle.Concepts.PublicSynonyms) -+ [Schemas for unsupported features](#Oracle.Concepts.unsupported-features) -+ [Limitations for Oracle DBA privileges](#Oracle.Concepts.dba-limitations) -+ [Limitations of a single\-tenant CDB](#Oracle.Concepts.single-tenant-limitations) -+ [Deprecation of TLS 1\.0 and 1\.1 Transport Layer Security](#Oracle.Concepts.tls) - -## Oracle file size limits in Amazon RDS - -The maximum size of a single file on RDS for Oracle DB instances is 16 TiB \(tebibytes\)\. This limit is imposed by the ext4 filesystem used by the instance\. Thus, Oracle bigfile data files are limited to 16 TiB\. If you try to resize a data file in a bigfile tablespace to a value over the limit, you receive an error such as the following\. - -``` -ORA-01237: cannot extend datafile 6 -ORA-01110: data file 6: '/rdsdbdata/db/mydir/datafile/myfile.dbf' -ORA-27059: could not reduce file size -Linux-x86_64 Error: 27: File too large -Additional information: 2 -``` - -## Public synonyms for Oracle\-supplied schemas - -Don't create or modify public synonyms for Oracle\-supplied schemas, including `SYS`, `SYSTEM`, and `RDSADMIN`\. Such actions might result in invalidation of core database components and affect the availability of your DB instance\. - -You can create public synonyms referencing objects in your own schemas\. - -## Schemas for unsupported features - -In general, Amazon RDS doesn't prevent you from creating schemas for unsupported features\. However, if you create schemas for Oracle features and components that require SYS privileges, you can damage the data dictionary and affect your instance availability\. Use only supported features and schemas that are available in [Adding options to Oracle DB instances](Appendix.Oracle.Options.md)\. - -## Limitations for Oracle DBA privileges - -In the database, a role is a collection of privileges that you can grant to or revoke from a user\. An Oracle database uses roles to provide security\. - -The predefined role `DBA` normally allows all administrative privileges on an Oracle database\. When you create a DB instance, your master user account gets DBA privileges \(with some limitations\)\. To deliver a managed experience, an RDS for Oracle database doesn't provide the following privileges for the `DBA` role: -+ `ALTER DATABASE` -+ `ALTER SYSTEM` -+ `CREATE ANY DIRECTORY` -+ `DROP ANY DIRECTORY` -+ `GRANT ANY PRIVILEGE` -+ `GRANT ANY ROLE` - -Use the master user account for administrative tasks such as creating additional user accounts in the database\. You can't use `SYS`, `SYSTEM`, and other Oracle\-supplied administrative accounts\. - -## Limitations of a single\-tenant CDB - -The following options aren't supported for the single\-tenant architecture: -+ Database Activity Streams -+ Oracle Data Guard -+ Oracle Enterprise Manager -+ Oracle Enterprise Manager Agent -+ Oracle Label Security - -The following operations work in a single\-tenant CDB, but no customer\-visible mechanism can detect the current status of the operations: -+ [Enabling and disabling block change tracking](Appendix.Oracle.CommonDBATasks.RMAN.md#Appendix.Oracle.CommonDBATasks.BlockChangeTracking) -+ [Enabling auditing for the SYS\.AUD$ table](Appendix.Oracle.CommonDBATasks.Database.md#Appendix.Oracle.CommonDBATasks.EnablingAuditing) - -**Note** -Auditing information isn't available from within the PDB\. - -## Deprecation of TLS 1\.0 and 1\.1 Transport Layer Security - -Transport Layer Security protocol versions 1\.0 and 1\.1 \(TLS 1\.0 and TLS 1\.1\) are deprecated\. In accordance with security best practices, Oracle has deprecated the use of TLS 1\.0 and TLS 1\.1\. To meet your security requirements, RDS for Oracle strongly recommends that you use TLS 1\.2 instead\. \ No newline at end of file diff --git a/doc_source/Oracle.Concepts.overview.md b/doc_source/Oracle.Concepts.overview.md deleted file mode 100644 index 6fe347c..0000000 --- a/doc_source/Oracle.Concepts.overview.md +++ /dev/null @@ -1,13 +0,0 @@ -# Overview of Oracle on Amazon RDS - -You can read the following sections to get an overview of RDS for Oracle\. - -**Topics** -+ [RDS for Oracle features](Oracle.Concepts.FeatureSupport.md) -+ [RDS for Oracle releases](Oracle.Concepts.database-versions.md) -+ [RDS for Oracle licensing options](Oracle.Concepts.Licensing.md) -+ [RDS for Oracle instance classes](Oracle.Concepts.InstanceClasses.md) -+ [RDS for Oracle database architecture](oracle-multi-architecture.md) -+ [RDS for Oracle parameters](Oracle.Concepts.FeatureSupport.Parameters.md) -+ [RDS for Oracle character sets](Appendix.OracleCharacterSets.md) -+ [RDS for Oracle limitations](Oracle.Concepts.limitations.md) \ No newline at end of file diff --git a/doc_source/Oracle.Concepts.single-tenant.md b/doc_source/Oracle.Concepts.single-tenant.md deleted file mode 100644 index 5682555..0000000 --- a/doc_source/Oracle.Concepts.single-tenant.md +++ /dev/null @@ -1,68 +0,0 @@ -# RDS for Oracle architecture - -The multitenant architecture enables an Oracle database to function as a multitenant container database \(CDB\)\. A CDB can include customer\-created pluggable databases \(PDBs\)\. A non\-CDB is an Oracle database that uses the traditional architecture, which can't contain PDBs\. For more information about the multitenant architecture, see [https://docs.oracle.com/en/database/oracle/oracle-database/19/multi/introduction-to-the-multitenant-architecture.html#GUID-267F7D12-D33F-4AC9-AA45-E9CD671B6F22](https://docs.oracle.com/en/database/oracle/oracle-database/19/multi/introduction-to-the-multitenant-architecture.html#GUID-267F7D12-D33F-4AC9-AA45-E9CD671B6F22)\. - -The architecture is a permanent characteristic that you can't change later\. The architecture requirements are as follows: - -Oracle Database 21c -You must create the instance as a CDB\. - -Oracle Database 19c -You can create the instance as either a CDB or non\-CDB\. - -Oracle Database 12c -You must create the instance as a non\-CDB\. - -For more information, see [Creating an Amazon RDS DB instance](USER_CreateDBInstance.md)\. - -Currently, Amazon RDS supports a subset of multitenant architecture called the single\-tenant architecture\. In this case, your CDB contains only one PDB\. The single\-tenant architecture uses the same RDS APIs as the non\-CDB architecture\. Your experience with a non\-CDB is mostly identical to your experience with a PDB\. You can't access the CDB itself\. - -The following sections explain the principal differences between the non\-multitenant and single\-tenant architectures\. For more information, see [Limitations of a single\-tenant CDB](Oracle.Concepts.limitations.md#Oracle.Concepts.single-tenant-limitations)\. - -**Topics** -+ [Database creation and connections in a single\-tenant architecture](#Oracle.Concepts.single-tenant.creation) -+ [Database upgrades in a single\-tenant architecture](#Oracle.Concepts.single-tenant.upgrades) -+ [User accounts and privileges in a single\-tenant architecture](#Oracle.Concepts.single-tenant.users) -+ [Parameters in a single\-tenant architecture](#Oracle.Concepts.single-tenant.parameters) -+ [Snapshots in a single\-tenant architecture](#Oracle.Concepts.single-tenant.snapshots) -+ [Data migration in a single\-tenant architecture](#Oracle.Concepts.single-tenant.migration) - -## Database creation and connections in a single\-tenant architecture - -When you create a CDB, specify the DB instance identifier just as for a non\-CDB\. The instance identifier forms the first part of your endpoint\. The system identifier \(SID\) is the name of the CDB\. The SID of every CDB is `RDSCDB`\. You can't choose a different value\. - -In the single\-tenant architecture, you always connect to the PDB rather than the CDB\. Specify the endpoint for the PDB just as for a non\-CDB\. The only difference is that you specify *pdb\_name* for the database name, where *pdb\_name* is the name you chose for your PDB\. The following example shows the format for the connection string in SQL\*Plus\. - -``` -sqlplus 'dbuser@(DESCRIPTION=(ADDRESS=(PROTOCOL=TCP)(HOST=endpoint)(PORT=port))(CONNECT_DATA=(SID=pdb_name)))' -``` - -## Database upgrades in a single\-tenant architecture - -You can upgrade a CDB to a different Oracle Database release\. For example, you can upgrade a DB instance from Oracle Database 19c to Oracle Database 21c\. You can't upgrade a non\-CDB to a CDB\. - -## User accounts and privileges in a single\-tenant architecture - -In the Oracle multitenant architecture, all users accounts are either common users or local users\. A CDB common user is a database user whose single identity and password are known in the CDB root and in every existing and future PDB\. In contrast, a local user exists only in a single PDB\. - -The RDS master user is a local user account in the PDB\. If you create new user accounts, these users will also be local users residing in the PDB\. You can't use any user accounts to create new PDBs or modify the state of the existing PDB\. - -The `rdsadmin` user is a common user account\. You can run Oracle for RDS packages that exist in this account, but you can't log in as `rdsadmin`\. For more information, see [About Common Users and Local Users](https://docs.oracle.com/en/database/oracle/oracle-database/19/dbseg/managing-security-for-oracle-database-users.html#GUID-BBBD9904-F2F3-442B-9AFC-8ACDD9A588D8) in the Oracle documentation\. - -## Parameters in a single\-tenant architecture - -CDBs have their own parameter classes and different default parameter values\. The CDB parameter classes are as follows: -+ oracle\-ee\-cdb\-21 -+ oracle\-se2\-cdb\-21 -+ oracle\-ee\-cdb\-19 -+ oracle\-se2\-cdb\-19 - -You specify parameters at the CDB level rather than the PDB level\. The PDB inherits parameter settings from the CDB\. For more information about setting parameters, see [Working with DB parameter groups](CHAP_BestPractices.md#CHAP_BestPractices.DBParameterGroup)\. - -## Snapshots in a single\-tenant architecture - -Snapshots work the same in a single\-tenant and non\-multitenant architecture\. The only difference is that when you restore a snapshot, you can only rename the PDB, not the CDB\. The CDB is always named `RDSCDB`\. For more information, see [Oracle Database considerations](USER_RestoreFromSnapshot.md#USER_RestoreFromSnapshot.Oracle)\. - -## Data migration in a single\-tenant architecture - -RDS for Oracle doesn't support unplugging and plugging in PDBs\. For more information about migrating data, see [Importing data into Oracle on Amazon RDS](Oracle.Procedural.Importing.md)\. \ No newline at end of file diff --git a/doc_source/Oracle.Options.Locator.md b/doc_source/Oracle.Options.Locator.md deleted file mode 100644 index fa87707..0000000 --- a/doc_source/Oracle.Options.Locator.md +++ /dev/null @@ -1,104 +0,0 @@ -# Oracle Locator - -Amazon RDS supports Oracle Locator through the use of the `LOCATOR` option\. Oracle Locator provides capabilities that are typically required to support internet and wireless service\-based applications and partner\-based GIS solutions\. Oracle Locator is a limited subset of Oracle Spatial\. For more information, see [Oracle Locator](https://docs.oracle.com/database/121/SPATL/sdo_locator.htm#SPATL340) in the Oracle documentation\. - -**Important** -If you use Oracle Locator, Amazon RDS automatically updates your DB instance to the latest Oracle PSU if there are security vulnerabilities with a Common Vulnerability Scoring System \(CVSS\) score of 9\+ or other announced security vulnerabilities\. - -Amazon RDS supports Oracle Locator for the following releases of Oracle Database: -+ Oracle Database 19c \(19\.0\.0\.0\) -+ Oracle Database 12c Release 2 \(12\.2\.0\.1\) -+ Oracle Database 12c Release 1 \(12\.1\), version 12\.1\.0\.2\.v13 or later - -Oracle Locator isn't supported for Oracle Database 21c, but its functionality is available in the Oracle Spatial option\. Formerly, the Spatial option required additional licenses\. Oracle Locator represented a subset of Oracle Spatial features and didn't require additional licenses\. In 2019, Oracle announced that all Oracle Spatial features were included in the Enterprise Edition and Standard Edition Two licenses without additional cost\. Consequently, the Oracle Spatial option no longer required additional licensing\. - -Starting with Oracle Database 21c, the Oracle Locator option is no longer supported\. To use the Oracle Locator features in Oracle Database 21c, install the Oracle Spatial option instead\. For more information, see [Machine Learning, Spatial and Graph \- No License Required\!](https://blogs.oracle.com/database/post/machine-learning-spatial-and-graph-no-license-required) in the Oracle Database Insider blog\. - -## Prerequisites for Oracle Locator - -The following are prerequisites for using Oracle Locator: -+ Your DB instance must be of sufficient class\. Oracle Locator is not supported for the db\.t3\.micro or db\.t3\.small DB instance classes\. For more information, see [RDS for Oracle instance classes](Oracle.Concepts.InstanceClasses.md)\. -+ Your DB instance must have **Auto Minor Version Upgrade** enabled\. This option enables your DB instance to receive minor DB engine version upgrades automatically when they become available and is required for any options that install the Oracle Java Virtual Machine \(JVM\)\. Amazon RDS uses this option to update your DB instance to the latest Oracle Patch Set Update \(PSU\) or Release Update \(RU\)\. For more information, see [Modifying an Amazon RDS DB instance](Overview.DBInstance.Modifying.md)\. - -## Best practices for Oracle Locator - -The following are best practices for using Oracle Locator: -+ For maximum security, use the `LOCATOR` option with Secure Sockets Layer \(SSL\)\. For more information, see [Oracle Secure Sockets Layer](Appendix.Oracle.Options.SSL.md)\. -+ Configure your DB instance to restrict access to your DB instance\. For more information, see [Scenarios for accessing a DB instance in a VPC](USER_VPC.Scenarios.md) and [Working with a DB instance in a VPC](USER_VPC.WorkingWithRDSInstanceinaVPC.md)\. - -## Adding the Oracle Locator option - -The following is the general process for adding the `LOCATOR` option to a DB instance: - -1. Create a new option group, or copy or modify an existing option group\. - -1. Add the option to the option group\. - -1. Associate the option group with the DB instance\. - -If Oracle Java Virtual Machine \(JVM\) is *not* installed on the DB instance, there is a brief outage while the `LOCATOR` option is added\. There is no outage if Oracle Java Virtual Machine \(JVM\) is already installed on the DB instance\. After you add the option, you don't need to restart your DB instance\. As soon as the option group is active, Oracle Locator is available\. - -**Note** -During this outage, password verification functions are disabled briefly\. You can also expect to see events related to password verification functions during the outage\. Password verification functions are enabled again before the Oracle DB instance is available\. - -**To add the `LOCATOR` option to a DB instance** - -1. Determine the option group that you want to use\. You can create a new option group or use an existing option group\. If you want to use an existing option group, skip to the next step\. Otherwise, create a custom DB option group with the following settings: - - 1. For **Engine**, choose the oracle edition for your DB instance\. - - 1. For **Major engine version**, choose the version of your DB instance\. - - For more information, see [Creating an option group](USER_WorkingWithOptionGroups.md#USER_WorkingWithOptionGroups.Create)\. - -1. Add the **LOCATOR** option to the option group\. For more information about adding options, see [Adding an option to an option group](USER_WorkingWithOptionGroups.md#USER_WorkingWithOptionGroups.AddOption)\. - -1. Apply the option group to a new or existing DB instance: - + For a new DB instance, you apply the option group when you launch the instance\. For more information, see [Creating an Amazon RDS DB instance](USER_CreateDBInstance.md)\. - + For an existing DB instance, you apply the option group by modifying the instance and attaching the new option group\. For more information, see [Modifying an Amazon RDS DB instance](Overview.DBInstance.Modifying.md)\. - -## Using Oracle Locator - -After you enable the Oracle Locator option, you can begin using it\. You should only use Oracle Locator features\. Don't use any Oracle Spatial features unless you have a license for Oracle Spatial\. - -For a list of features that are supported for Oracle Locator, see [Features Included with Locator](https://docs.oracle.com/database/121/SPATL/sdo_locator.htm#GUID-EC6DEA23-8FD7-4109-A0C1-93C0CE3D6FF2__CFACCEEG) in the Oracle documentation\. - -For a list of features that are not supported for Oracle Locator, see [Features Not Included with Locator](https://docs.oracle.com/database/121/SPATL/sdo_locator.htm#GUID-EC6DEA23-8FD7-4109-A0C1-93C0CE3D6FF2__CFABACEA) in the Oracle documentation\. - -## Removing the Oracle Locator option - -After you drop all objects that use data types provided by the `LOCATOR` option, you can remove the option from a DB instance\. If Oracle Java Virtual Machine \(JVM\) is *not* installed on the DB instance, there is a brief outage while the `LOCATOR` option is removed\. There is no outage if Oracle Java Virtual Machine \(JVM\) is already installed on the DB instance\. After you remove the `LOCATOR` option, you don't need to restart your DB instance\. - -**To drop the `LOCATOR` option** - -1. Back up your data\. -**Warning** -If the instance uses data types that were enabled as part of the option, and if you remove the `LOCATOR` option, you can lose data\. For more information, see [Backing up and restoring](CHAP_CommonTasks.BackupRestore.md)\. - -1. Check whether any existing objects reference data types or features of the `LOCATOR` option\. - - If `LOCATOR` options exist, the instance can get stuck when applying the new option group that doesn't have the `LOCATOR` option\. You can identify the objects by using the following queries: - - ``` - SELECT OWNER, SEGMENT_NAME, TABLESPACE_NAME, BYTES/1024/1024 mbytes - FROM DBA_SEGMENTS - WHERE SEGMENT_TYPE LIKE '%TABLE%' - AND (OWNER, SEGMENT_NAME) IN - (SELECT DISTINCT OWNER, TABLE_NAME - FROM DBA_TAB_COLUMNS - WHERE DATA_TYPE='SDO_GEOMETRY' - AND OWNER <> 'MDSYS') - ORDER BY 1,2,3,4; - - SELECT OWNER, TABLE_NAME, COLUMN_NAME - FROM DBA_TAB_COLUMNS - WHERE DATA_TYPE = 'SDO_GEOMETRY' - AND OWNER <> 'MDSYS' - ORDER BY 1,2,3; - ``` - -1. Drop any objects that reference data types or features of the `LOCATOR` option\. - -1. Do one of the following: - + Remove the `LOCATOR` option from the option group it belongs to\. This change affects all DB instances that use the option group\. For more information, see [Removing an option from an option group](USER_WorkingWithOptionGroups.md#USER_WorkingWithOptionGroups.RemoveOption)\. - + Modify the DB instance and specify a different option group that doesn't include the `LOCATOR` option\. This change affects a single DB instance\. You can specify the default \(empty\) option group, or a different custom option group\. For more information, see [Modifying an Amazon RDS DB instance](Overview.DBInstance.Modifying.md)\. \ No newline at end of file diff --git a/doc_source/Oracle.Options.Multimedia.md b/doc_source/Oracle.Options.Multimedia.md deleted file mode 100644 index 0a99bb2..0000000 --- a/doc_source/Oracle.Options.Multimedia.md +++ /dev/null @@ -1,74 +0,0 @@ -# Oracle Multimedia - -Amazon RDS supports Oracle Multimedia through the use of the `MULTIMEDIA` option\. You can use Oracle Multimedia to store, manage, and retrieve images, audio, video, and other heterogeneous media data\. For more information, see [Oracle Multimedia](https://docs.oracle.com/database/121/IMURG/title.htm) in the Oracle documentation\. - -**Important** -If you use Oracle Multimedia, Amazon RDS automatically updates your DB instance to the latest Oracle PSU if there are security vulnerabilities with a Common Vulnerability Scoring System \(CVSS\) score of 9\+ or other announced security vulnerabilities\. - -Amazon RDS supports Oracle Multimedia for all editions of the following versions: -+ Oracle Database 12c Release 2 \(12\.2\) -+ Oracle Database 12c Release 1 \(12\.1\), version 12\.1\.0\.2\.v13 or higher - -**Note** -Oracle desupported Oracle Multimedia in Oracle Database 19c\. So, Oracle Multimedia isn't supported for Oracle Database 19c DB instances\. For more information, see [Desupport of Oracle Multimedia](https://docs.oracle.com/en/database/oracle/oracle-database/19/upgrd/behavior-changes-deprecated-desupport-oracle-database.html#GUID-BABC1C60-EA07-4EBE-8C67-B69B59E4F742) in the Oracle documentation\. - -## Prerequisites for Oracle Multimedia - -The following are prerequisites for using Oracle Multimedia: -+ Your DB instance must be of sufficient class\. Oracle Multimedia is not supported for the db\.t3\.micro or db\.t3\.small DB instance classes\. For more information, see [RDS for Oracle instance classes](Oracle.Concepts.InstanceClasses.md)\. -+ Your DB instance must have **Auto Minor Version Upgrade** enabled\. This option enables your DB instance to receive minor DB engine version upgrades automatically when they become available and is required for any options that install the Oracle Java Virtual Machine \(JVM\)\. Amazon RDS uses this option to update your DB instance to the latest Oracle Patch Set Update \(PSU\) or Release Update \(RU\)\. For more information, see [Modifying an Amazon RDS DB instance](Overview.DBInstance.Modifying.md)\. - -## Best practices for Oracle Multimedia - -The following are best practices for using Oracle Multimedia: -+ For maximum security, use the `MULTIMEDIA` option with Secure Sockets Layer \(SSL\)\. For more information, see [Oracle Secure Sockets Layer](Appendix.Oracle.Options.SSL.md)\. -+ Configure your DB instance to restrict access to your DB instance\. For more information, see [Scenarios for accessing a DB instance in a VPC](USER_VPC.Scenarios.md) and [Working with a DB instance in a VPC](USER_VPC.WorkingWithRDSInstanceinaVPC.md)\. - -## Adding the Oracle Multimedia option - -The following is the general process for adding the `MULTIMEDIA` option to a DB instance: - -1. Create a new option group, or copy or modify an existing option group\. - -1. Add the option to the option group\. - -1. Associate the option group with the DB instance\. - -If Oracle Java Virtual Machine \(JVM\) is *not* installed on the DB instance, there is a brief outage while the `MULTIMEDIA` option is added\. There is no outage if Oracle Java Virtual Machine \(JVM\) is already installed on the DB instance\. After you add the option, you don't need to restart your DB instance\. As soon as the option group is active, Oracle Multimedia is available\. - -**Note** -During this outage, password verification functions are disabled briefly\. You can also expect to see events related to password verification functions during the outage\. Password verification functions are enabled again before the Oracle DB instance is available\. - -**To add the `MULTIMEDIA` option to a DB instance** - -1. Determine the option group that you want to use\. You can create a new option group or use an existing option group\. If you want to use an existing option group, skip to the next step\. Otherwise, create a custom DB option group with the following settings: - - 1. For **Engine**, choose the edition for your Oracle DB instance\. - - 1. For **Major engine version**, choose the version of your DB instance\. - - For more information, see [Creating an option group](USER_WorkingWithOptionGroups.md#USER_WorkingWithOptionGroups.Create)\. - -1. Add the **MULTIMEDIA** option to the option group\. For more information about adding options, see [Adding an option to an option group](USER_WorkingWithOptionGroups.md#USER_WorkingWithOptionGroups.AddOption)\. - -1. Apply the option group to a new or existing DB instance: - + For a new DB instance, you apply the option group when you launch the instance\. For more information, see [Creating an Amazon RDS DB instance](USER_CreateDBInstance.md)\. - + For an existing DB instance, you apply the option group by modifying the instance and attaching the new option group\. For more information, see [Modifying an Amazon RDS DB instance](Overview.DBInstance.Modifying.md)\. - -## Removing the Oracle Multimedia option - -After you drop all objects that use data types provided by the `MULTIMEDIA` option, you can remove the option from a DB instance\. If Oracle Java Virtual Machine \(JVM\) is *not* installed on the DB instance, there is a brief outage while the `MULTIMEDIA` option is removed\. There is no outage if Oracle Java Virtual Machine \(JVM\) is already installed on the DB instance\. After you remove the `MULTIMEDIA` option, you don't need to restart your DB instance\. - -**To drop the `MULTIMEDIA` option** - -1. Back up your data\. -**Warning** -If the instance uses data types that were enabled as part of the option, and if you remove the `MULTIMEDIA` option, you can lose data\. For more information, see [Backing up and restoring](CHAP_CommonTasks.BackupRestore.md)\. - -1. Check whether any existing objects reference data types or features of the `MULTIMEDIA` option\. - -1. Drop any objects that reference data types or features of the `MULTIMEDIA` option\. - -1. Do one of the following: - + Remove the `MULTIMEDIA` option from the option group it belongs to\. This change affects all DB instances that use the option group\. For more information, see [Removing an option from an option group](USER_WorkingWithOptionGroups.md#USER_WorkingWithOptionGroups.RemoveOption)\. - + Modify the DB instance and specify a different option group that doesn't include the `MULTIMEDIA` option\. This change affects a single DB instance\. You can specify the default \(empty\) option group, or a different custom option group\. For more information, see [Modifying an Amazon RDS DB instance](Overview.DBInstance.Modifying.md)\. \ No newline at end of file diff --git a/doc_source/Oracle.Options.OEM.md b/doc_source/Oracle.Options.OEM.md deleted file mode 100644 index b975dec..0000000 --- a/doc_source/Oracle.Options.OEM.md +++ /dev/null @@ -1,19 +0,0 @@ -# Oracle Enterprise Manager - -Amazon RDS supports Oracle Enterprise Manager \(OEM\)\. OEM is the Oracle product line for integrated management of enterprise information technology\. - -Amazon RDS supports OEM through the following options\. - - -**** - -| Option | Option ID | Supported OEM releases | Supported Oracle Database releases | -| --- | --- | --- | --- | -| [OEM Database Express](Appendix.Oracle.Options.OEM_DBControl.md) | `OEM` | OEM Database Express 12c | Oracle Database 19c \(non\-CDB only\) Oracle Database 12c | -| [OEM Management Agent](Oracle.Options.OEMAgent.md) | `OEM_AGENT` | OEM Cloud Control for 13c OEM Cloud Control for 12c | Oracle Database 19c \(non\-CDB only\) Oracle Database 12c | - -**Note** -You can use OEM Database or OEM Management Agent, but not both\. - -**Note** -These options aren't supported for the Oracle multitenant architecture\. \ No newline at end of file diff --git a/doc_source/Oracle.Options.OEMAgent.md b/doc_source/Oracle.Options.OEMAgent.md deleted file mode 100644 index ad21eb7..0000000 --- a/doc_source/Oracle.Options.OEMAgent.md +++ /dev/null @@ -1,365 +0,0 @@ -# Oracle Management Agent for Enterprise Manager Cloud Control - -Oracle Enterprise Manager \(OEM\) Management Agent is a software component that monitors targets running on hosts and communicates that information to the middle\-tier Oracle Management Service \(OMS\)\. For more information, see [Overview of Oracle Enterprise Manager cloud control 12c](http://docs.oracle.com/cd/E24628_01/doc.121/e25353/overview.htm) and [Overview of Oracle Enterprise Manager cloud control 13c](http://docs.oracle.com/cd/E63000_01/EMCON/overview.htm#EMCON109) in the Oracle documentation\. - -Amazon RDS supports Management Agent through the use of the `OEM_AGENT` option\. Management Agent requires an Amazon RDS DB instance running any of the following releases: -+ Oracle Database 19c \(19\.0\.0\.0\) using the non\-CDB architecture -+ Oracle Database 12c Release 2 \(12\.2\.0\.1\) -+ Oracle Database 12c Release 1 \(12\.1\.0\.2\) - -Amazon RDS supports Management Agent for the following versions of OEM: -+ Oracle Enterprise Manager Cloud Control for 13c -+ Oracle Enterprise Manager Cloud Control for 12c - -**Topics** -+ [Prerequisites for Management Agent](#Oracle.Options.OEMAgent.PreReqs) -+ [Limitations for Management Agent](#Oracle.Options.OEMAgent.limitations) -+ [Option settings for Management Agent](#Oracle.Options.OEMAgent.Options) -+ [Adding the Management Agent option](#Oracle.Options.OEMAgent.Add) -+ [Using the Management Agent](#Oracle.Options.OEMAgent.Using) -+ [Modifying Management Agent settings](#Oracle.Options.OEMAgent.ModifySettings) -+ [Performing database tasks with the Management Agent](#Oracle.Options.OEMAgent.DBTasks) -+ [Removing the Management Agent option](#Oracle.Options.OEMAgent.Remove) - -## Prerequisites for Management Agent - -To use Management Agent, ensure that you meet the following prerequisites\. - -### General prerequisites - -Following are general prerequisites for using Management Agent: -+ You need an Oracle Management Service \(OMS\) that is configured to connect to your Amazon RDS DB instance\. -+ In most cases, you must configure your VPC to allow connections from OMS to your DB instance\. If you aren't familiar with Amazon Virtual Private Cloud \(Amazon VPC\), we recommend that you complete the steps in [Tutorial: Create a VPC for use with a DB instance \(IPv4 only\)](CHAP_Tutorials.WebServerDB.CreateVPC.md) before continuing\. -+ Management Agent version 13\.5\.0\.0\.v1 requires OMS version 13\.5\.0\.0 or later\. -+ Management Agent version 13\.4\.0\.9\.v1 requires OMS version 13\.4\.0\.9 or later and patch 32198287\. -+ Ensure that you have sufficient storage space for your OEM release: - + At least 8\.5 GiB for OEM 13c Release 5 - + At least 8\.5 GiB for OEM 13c Release 4 - + At least 8\.5 GiB for OEM 13c Release 3 - + At least 5\.5 GiB for OEM 13c Release 2 - + At least 4\.5 GiB OEM 13c Release 1 - + At least 2\.5 GiB for OEM 12c -+ If you are using Management Agent versions `OEM_AGENT 13.2.0.0.v3` and `13.3.0.0.v2`, and if you want to use TCPS connectivity, follow the instructions in [Configuring third party CA certificates for communication with target databases](https://docs.oracle.com/cd/E73210_01/EMSEC/GUID-8337AD48-1A32-4CD5-84F3-256FAE93D043.htm#EMSEC15996) in the Oracle documentation\. Also, update the JDK on your OMS by following the instructions in the Oracle document with the Oracle Doc ID 2241358\.1\. This step ensures that OMS supports all the cipher suites that the database supports\. -**Note** -TCPS connectivity between the Management Agent and the DB instance is supported for Management Agent `OEM_AGENT 13.2.0.0.v3`, `13.3.0.0.v2`, `13.4.0.9.v1`, and higher versions\. - -### Oracle Database release prerequisites - -Following are the supported Oracle Database versions for each Management Agent version\. - - -**** - -| Management Agent version | Oracle Database 19c using the non\-CDB architecture | Oracle Database 12c Release 2 \(12\.2\) | Oracle Database 12c Release 1 \(12\.1\) | -| --- | --- | --- | --- | -| 13\.5\.0\.0\.v1 | Supported | Supported | Supported | -| 13\.4\.0\.9\.v1 | Supported | Supported | Supported | -| 13\.3\.0\.0\.v2 | Supported | Supported | Supported | -| 13\.3\.0\.0\.v1 | Supported | Supported | Supported | -| 13\.2\.0\.0\.v3 | Supported | Supported | Supported | -| 13\.2\.0\.0\.v2 | Supported | Supported | Supported | -| 13\.2\.0\.0\.v1 | Supported | Supported | Supported | -| 13\.1\.0\.0\.v1 | Supported | Supported | Supported | -| 12\.1\.0\.5\.v1 | Not supported | Supported | Supported | -| 12\.1\.0\.4\.v1 | Not supported | Supported | Supported | - -Following are prerequisites for different database versions: -+ For an Amazon RDS DB instance running Oracle Database 19c \(19\.0\.0\.0\), the minimum `AGENT_VERSION` is 13\.1\.0\.0\.v1\. -+ For an Amazon RDS DB instance running Oracle Database Release 2 \(12\.2\.0\.1\) or lower, meet the following requirements: - + For OMS 13c Release 2 with Oracle patch 25163555 applied, use OEM Agent 13\.2\.0\.0\.v2 or later\. - - Use OMSPatcher to apply the patch\. - + For unpatched OMS 13c Release 2, use OEM Agent 13\.2\.0\.0\.v1\. - - Use OMSPatcher to apply patches\. - -### OMS host communication prerequisites - -Make sure that your OMS host and your Amazon RDS DB instance can communicate\. Do the following: -+ To connect from the Management Agent to your OMS, if your OMS is behind a firewall, add the IP addresses of your DB instances to your OMS\. - - Make sure the firewall for the OMS allows traffic from both the DB listener port \(default 1521\) and the OEM Agent port \(default 3872\), originating from the IP address of the DB instance\. -+ To connect from your OMS to the Management Agent, if your OMS has a publicly resolvable host name, add the OMS address to a security group\. Your security group must have inbound rules that allow access to the DB listener port and the Management Agent port\. For an example of creating a security and adding inbound rules, see [Tutorial: Create a VPC for use with a DB instance \(IPv4 only\)](CHAP_Tutorials.WebServerDB.CreateVPC.md)\. -+ To connect from your OMS to the Management Agent, if your OMS doesn't have a publicly resolvable host name, use one of the following: - + If your OMS is hosted on an Amazon Elastic Compute Cloud \(Amazon EC2\) instance in a private VPC, you can set up VPC peering to connect from OMS to Management Agent\. For more information, see [A DB instance in a VPC accessed by an EC2 instance in a different VPC](USER_VPC.Scenarios.md#USER_VPC.Scenario3)\. - + If your OMS is hosted on\-premises, you can set up a VPN connection to allow access from OMS to Management Agent\. For more information, see [A DB instance in a VPC accessed by a client application through the internet](USER_VPC.Scenarios.md#USER_VPC.Scenario4) or [VPN connections](https://docs.aws.amazon.com/vpc/latest/userguide/vpn-connections.html)\. - -## Limitations for Management Agent - -Following are some limitations to using Management Agent: -+ Administrative tasks such as job execution and database patching, that require host credentials, aren't supported\. -+ Host metrics and the process list aren't guaranteed to reflect the actual system state\. Thus, you shouldn't use OEM to monitor the root file system or mount point file system\. For more information about monitoring the operating system, see [Monitoring OS metrics with Enhanced Monitoring](USER_Monitoring.OS.md)\. -+ Autodiscovery isn't supported\. You must manually add database targets\. -+ OMS module availability depends on your database edition\. For example, the database performance diagnosis and tuning module is only available for Oracle Database Enterprise Edition\. -+ Management Agent consumes additional memory and computing resources\. If you experience performance problems after enabling the `OEM_AGENT` option, we recommend that you scale up to a larger DB instance class\. For more information, see [DB instance classes](Concepts.DBInstanceClass.md) and [Modifying an Amazon RDS DB instance](Overview.DBInstance.Modifying.md)\. -+ The user running the `OEM_AGENT` on the Amazon RDS host doesn't have operating system access to the alert log\. Thus, you can't collect metrics for `DB Alert Log` and `DB Alert Log Error Status` in OEM\. - -## Option settings for Management Agent - -Amazon RDS supports the following settings for the Management Agent option\. - - -| Option setting | Required | Valid values | Description | -| --- | --- | --- | --- | -| **Version** \(`AGENT_VERSION`\) | Yes | `13.5.0.0.v1` `13.4.0.9.v1` `13.3.0.0.v2` `13.3.0.0.v1` `13.2.0.0.v3` `13.2.0.0.v2` `13.2.0.0.v1` `13.1.0.0.v1` `12.1.0.5.v1` `12.1.0.4.v1` | The version of the Management Agent software\. The AWS CLI option name is `OptionVersion`\. In the AWS GovCloud \(US\) Regions, 12\.1 and 13\.1 versions aren't available\. | -| **Port** \(`AGENT_PORT`\) | Yes | An integer value | The port on the DB instance that listens for the OMS host\. The default is 3872\. Your OMS host must belong to a security group that has access to this port\. The AWS CLI option name is `Port`\. | -| **Security Groups** | Yes | Existing security groups | A security group that has access to **Port**\. Your OMS host must belong to this security group\. The AWS CLI option name is `VpcSecurityGroupMemberships` or `DBSecurityGroupMemberships`\. | -| **OMS\_HOST** | Yes | A string value, for example *my\.example\.oms* | The publicly accessible host name or IP address of the OMS\. The AWS CLI option name is `OMS_HOST`\. | -| **OMS\_PORT** | Yes | An integer value | The HTTPS upload port on the OMS Host that listens for the Management Agent\. To determine the HTTPS upload port, connect to the OMS host, and run the following command \(which requires the `SYSMAN` password\): emctl status oms \-details The AWS CLI option name is `OMS_PORT`\. | -| **AGENT\_REGISTRATION\_PASSWORD** | Yes | A string value | The password that the Management Agent uses to authenticate itself with the OMS\. We recommend that you create a persistent password in your OMS before enabling the `OEM_AGENT` option\. With a persistent password you can share a single Management Agent option group among multiple Amazon RDS databases\. The AWS CLI option name is `AGENT_REGISTRATION_PASSWORD`\. | -| **ALLOW\_TLS\_ONLY** | No | `true`, `false` \(default\) | A value that configures the OEM Agent to support only the `TLSv1` protocol while the agent listens as a server\. This setting is only supported for 12\.1 agent versions\. Later agent versions only support Transport Layer Security \(TLS\) by default\. | -| **MINIMUM\_TLS\_VERSION** | No | `TLSv1` \(default\), `TLSv1.2` | A value that specifies the minimum TLS version supported by the OEM Agent while the agent listens as a server\. This setting is only supported for agent versions 13\.1\.0\.0\.v1 and higher\. Earlier agent versions only support the `TLSv1` setting\. | -| **TLS\_CIPHER\_SUITE** | No | See [TLS settings for the Management Agent option](#oem-tls)\. | A value that specifies the TLS cipher suite used by the OEM Agent while the agent listens as a server\. | - -The following table lists the TLS cipher suites that the Management Agent option supports\. - - -**TLS settings for the Management Agent option** - -| Cipher suite | Agent version supported | FedRAMP compliant | -| --- | --- | --- | -| TLS\_RSA\_WITH\_AES\_128\_CBC\_SHA | All | No | -| TLS\_RSA\_WITH\_AES\_128\_CBC\_SHA256 | 13\.1\.0\.0\.v1 or higher | No | -| TLS\_RSA\_WITH\_AES\_256\_CBC\_SHA | 13\.2\.0\.0\.v3 or higher | No | -| TLS\_RSA\_WITH\_AES\_256\_CBC\_SHA256 | 13\.2\.0\.0\.v3 or higher | No | -| TLS\_ECDHE\_RSA\_WITH\_AES\_128\_CBC\_SHA | 13\.2\.0\.0\.v3 or higher | Yes | -| TLS\_ECDHE\_RSA\_WITH\_AES\_256\_CBC\_SHA | 13\.2\.0\.0\.v3 or higher | Yes | -| TLS\_ECDHE\_RSA\_WITH\_AES\_128\_CBC\_SHA256 | 13\.2\.0\.0\.v3 or higher | Yes | -| TLS\_ECDHE\_RSA\_WITH\_AES\_256\_CBC\_SHA384 | 13\.2\.0\.0\.v3 or higher | Yes | - -## Adding the Management Agent option - -The general process for adding the Management Agent option to a DB instance is the following: - -1. Create a new option group, or copy or modify an existing option group\. - -1. Add the option to the option group\. - -1. Associate the option group with the DB instance\. - -If you encounter errors, check [My Oracle Support](https://support.oracle.com/) documents for information about resolving specific problems\. - -After you add the Management Agent option, you don't need to restart your DB instance\. As soon as the option group is active, the OEM Agent is active\. - -If your OMS host is using an untrusted third\-party certificate, Amazon RDS returns the following error\. - -``` -You successfully installed the OEM_AGENT option. Your OMS host is using an untrusted third party certificate. -Configure your OMS host with the trusted certificates from your third party. -``` - -If this error is returned, the Management Agent option isn't enabled until the problem is corrected\. For information about correcting the problem, see the My Oracle Support document [2202569\.1](https://support.oracle.com/epmos/faces/DocContentDisplay?id=2202569.1)\. - -### Console - -**To add the Management Agent option to a DB instance** - -1. Determine the option group you want to use\. You can create a new option group or use an existing option group\. If you want to use an existing option group, skip to the next step\. Otherwise, create a custom DB option group with the following settings: - - 1. For **Engine** choose the oracle edition for your DB instance\. - - 1. For **Major engine version** choose the version of your DB instance\. - - For more information, see [Creating an option group](USER_WorkingWithOptionGroups.md#USER_WorkingWithOptionGroups.Create)\. - -1. Add the **OEM\_AGENT** option to the option group, and configure the option settings\. For more information about adding options, see [Adding an option to an option group](USER_WorkingWithOptionGroups.md#USER_WorkingWithOptionGroups.AddOption)\. For more information about each setting, see [Option settings for Management Agent](#Oracle.Options.OEMAgent.Options)\. - -1. Apply the option group to a new or existing DB instance: - + For a new DB instance, you apply the option group when you launch the instance\. For more information, see [Creating an Amazon RDS DB instance](USER_CreateDBInstance.md)\. - + For an existing DB instance, you apply the option group by modifying the instance and attaching the new option group\. For more information, see [Modifying an Amazon RDS DB instance](Overview.DBInstance.Modifying.md)\. - -### AWS CLI - -The following example uses the AWS CLI [add\-option\-to\-option\-group](https://docs.aws.amazon.com/cli/latest/reference/rds/add-option-to-option-group.html) command to add the `OEM_AGENT` option to an option group called `myoptiongroup`\. - -For Linux, macOS, or Unix: - -``` -aws rds add-option-to-option-group \ - --option-group-name "myoptiongroup" \ - --options OptionName=OEM_AGENT,OptionVersion=13.1.0.0.v1,Port=3872,VpcSecurityGroupMemberships=sg-1234567890,OptionSettings=[{Name=OMS_HOST,Value=my.example.oms},{Name=OMS_PORT,Value=4903},{Name=AGENT_REGISTRATION_PASSWORD,Value=password}] \ - --apply-immediately -``` - -For Windows: - -``` -aws rds add-option-to-option-group ^ - --option-group-name "myoptiongroup" ^ - --options OptionName=OEM_AGENT,OptionVersion=13.1.0.0.v1,Port=3872,VpcSecurityGroupMemberships=sg-1234567890,OptionSettings=[{Name=OMS_HOST,Value=my.example.oms},{Name=OMS_PORT,Value=4903},{Name=AGENT_REGISTRATION_PASSWORD,Value=password}] ^ - --apply-immediately -``` - -## Using the Management Agent - -After you enable the Management Agent option, take the following steps to begin using it\. - -**To use the Management Agent** - -1. Unlock and reset the DBSNMP account credential\. Do this by running the following code on your target database on your DB instance and using your master user account\. - - ``` - 1. ALTER USER dbsnmp IDENTIFIED BY new_password ACCOUNT UNLOCK; - ``` - -1. Add your targets to the OMS console manually: - - 1. In your OMS console, choose **Setup**, **Add Target**, **Add Targets Manually**\. - - 1. Choose **Add Targets Declaratively by Specifying Target Monitoring Properties**\. - - 1. For **Target Type**, choose **Database Instance**\. - - 1. For **Monitoring Agent**, choose the agent with the identifier that is the same as your RDS DB instance identifier\. - - 1. Choose **Add Manually**\. - - 1. Enter the endpoint for the Amazon RDS DB instance, or choose it from the host name list\. Make sure that the specified host name matches the endpoint of the Amazon RDS DB instance\. - - For information about finding the endpoint for your Amazon RDS DB instance, see [Finding the endpoint of your Oracle DB instance](USER_Endpoint.md)\. - - 1. Specify the following database properties: - + For **Target name**, enter a name\. - + For **Database system name**, enter a name\. - + For **Monitor username**, enter **dbsnmp**\. - + For **Monitor password**, enter the password from step 1\. - + For **Role**, enter **normal**\. - + For **Oracle home path**, enter **/oracle**\. - + For **Listener Machine name**, the agent identifier already appears\. - + For **Port**, enter the database port\. The RDS default port is 1521\. - + For **Database name**, enter the name of your database\. - - 1. Choose **Test Connection**\. - - 1. Choose **Next**\. The target database appears in your list of monitored resources\. - -## Modifying Management Agent settings - -After you enable the Management Agent, you can modify settings for the option\. For more information about how to modify option settings, see [Modifying an option setting](USER_WorkingWithOptionGroups.md#USER_WorkingWithOptionGroups.ModifyOption)\. For more information about each setting, see [Option settings for Management Agent](#Oracle.Options.OEMAgent.Options)\. - -## Performing database tasks with the Management Agent - -You can use Amazon RDS procedures to run certain EMCTL commands on the Management Agent\. By running these procedures, you can do the tasks listed following\. - -**Note** -Tasks are executed asynchronously\. - -**Topics** -+ [Getting the status of the Management Agent](#Oracle.Options.OEMAgent.DBTasks.GetAgentStatus) -+ [Restarting the Management Agent](#Oracle.Options.OEMAgent.DBTasks.RestartAgent) -+ [Listing the targets monitored by the Management Agent](#Oracle.Options.OEMAgent.DBTasks.ListTargets) -+ [Listing the collection threads monitored by the Management Agent](#Oracle.Options.OEMAgent.DBTasks.ListCollectionThreads) -+ [Clearing the Management Agent state](#Oracle.Options.OEMAgent.DBTasks.ClearState) -+ [Making the Management Agent upload its OMS](#Oracle.Options.OEMAgent.DBTasks.ForceUploadOMS) -+ [Pinging the OMS](#Oracle.Options.OEMAgent.DBTasks.PingOMS) -+ [Viewing the status of an ongoing task](#Oracle.Options.OEMAgent.DBTasks.ViewTaskStatus) - -### Getting the status of the Management Agent - -To get the status of the Management Agent, run the Amazon RDS procedure `rdsadmin.rdsadmin_oem_agent_tasks.get_status_oem_agent`\. This procedure is equivalent to the `emctl status agent` command\. - -The following procedure creates a task to get the Management Agent's status and returns the ID of the task\. - -``` -SELECT rdsadmin.rdsadmin_oem_agent_tasks.get_status_oem_agent() as TASK_ID from DUAL; -``` - -To view the result by displaying the task's output file, see [Viewing the status of an ongoing task](#Oracle.Options.OEMAgent.DBTasks.ViewTaskStatus)\. - -### Restarting the Management Agent - -To restart the Management Agent, run the Amazon RDS procedure `rdsadmin.rdsadmin_oem_agent_tasks.restart_oem_agent`\. This procedure is equivalent to running the `emctl stop agent` and `emctl start agent` commands\. - -The following procedure creates a task to restart the Management Agent and returns the ID of the task\. - -``` -SELECT rdsadmin.rdsadmin_oem_agent_tasks.restart_oem_agent as TASK_ID from DUAL; -``` - -To view the result by displaying the task's output file, see [Viewing the status of an ongoing task](#Oracle.Options.OEMAgent.DBTasks.ViewTaskStatus)\. - -### Listing the targets monitored by the Management Agent - -To list the targets monitored by the Management Agent, run the Amazon RDS procedure `rdsadmin.rdsadmin_oem_agent_tasks.list_targets_oem_agent`\. This procedure is equivalent to running the `emctl config agent listtargets` command\. - -The following procedure creates a task to list the targets monitored by the Management Agent and returns the ID of the task\. - -``` -SELECT rdsadmin.rdsadmin_oem_agent_tasks.list_targets_oem_agent as TASK_ID from DUAL; -``` - -To view the result by displaying the task's output file, see [Viewing the status of an ongoing task](#Oracle.Options.OEMAgent.DBTasks.ViewTaskStatus)\. - -### Listing the collection threads monitored by the Management Agent - -To list of all the running, ready, and scheduled collection threads monitored by the Management Agent, run the Amazon RDS procedure `rdsadmin.rdsadmin_oem_agent_tasks.list_clxn_threads_oem_agent`\. This procedure is equivalent to the `emctl status agent scheduler` command\. - -The following procedure creates a task to list the collection threads and returns the ID of the task\. - -``` -SELECT rdsadmin.rdsadmin_oem_agent_tasks.list_clxn_threads_oem_agent() as TASK_ID from DUAL; -``` - -To view the result by displaying the task's output file, see [Viewing the status of an ongoing task](#Oracle.Options.OEMAgent.DBTasks.ViewTaskStatus)\. - -### Clearing the Management Agent state - -To clear the Management Agent's state, run the Amazon RDS procedure `rdsadmin.rdsadmin_oem_agent_tasks.clearstate_oem_agent`\. This procedure is equivalent to running the `emctl clearstate agent` command\. - -The following procedure creates a task that clears the Management Agent's state and returns the ID of the task\. - -``` -SELECT rdsadmin.rdsadmin_oem_agent_tasks.clearstate_oem_agent() as TASK_ID from DUAL; -``` - -To view the result by displaying the task's output file, see [Viewing the status of an ongoing task](#Oracle.Options.OEMAgent.DBTasks.ViewTaskStatus)\. - -### Making the Management Agent upload its OMS - -To make the Management Agent upload the Oracle Management Server \(OMS\) associated with it, run the Amazon RDS procedure `rdsadmin.rdsadmin_oem_agent_tasks.upload_oem_agent`\. This procedure is equivalent to running the `emclt upload agent` command\. - -The following procedure creates a task that makes the Management Agent upload its associated OMS and return the ID of the task\. - -``` -SELECT rdsadmin.rdsadmin_oem_agent_tasks.upload_oem_agent() as TASK_ID from DUAL; -``` - -To view the result by displaying the task's output file, see [Viewing the status of an ongoing task](#Oracle.Options.OEMAgent.DBTasks.ViewTaskStatus)\. - -### Pinging the OMS - -To ping the Management Agent's OMS, run the Amazon RDS procedure `rdsadmin.rdsadmin_oem_agent_tasks.ping_oms_oem_agent`\. This procedure is equivalent to running the `emctl pingOMS` command\. - -The following procedure creates a task that pings the Management Agent's OMS and returns the ID of the task\. - -``` -SELECT rdsadmin.rdsadmin_oem_agent_tasks.ping_oms_oem_agent() as TASK_ID from DUAL; -``` - -To view the result by displaying the task's output file, see [Viewing the status of an ongoing task](#Oracle.Options.OEMAgent.DBTasks.ViewTaskStatus)\. - -### Viewing the status of an ongoing task - -You can view the status of an ongoing task in a bdump file\. The bdump files are located in the `/rdsdbdata/log/trace` directory\. Each bdump file name is in the following format\. - -``` -dbtask-task-id.log -``` - -When you want to monitor a task, replace `task-id` with the ID of the task that you want to monitor\. - -To view the contents of bdump files, run the Amazon RDS procedure `rdsadmin.rds_file_util.read_text_file`\. The following query returns the contents of the `dbtask-1546988886389-2444.log` bdump file\. - -``` -SELECT text FROM table(rdsadmin.rds_file_util.read_text_file('BDUMP','dbtask-1546988886389-2444.log')); -``` - -For more information about the Amazon RDS procedure `rdsadmin.rds_file_util.read_text_file`, see [Reading files in a DB instance directory](Appendix.Oracle.CommonDBATasks.Misc.md#Appendix.Oracle.CommonDBATasks.ReadingFiles)\. - -## Removing the Management Agent option - -You can remove the OEM Agent from a DB instance\. After you remove the OEM Agent, you don't need to restart your DB instance\. - -To remove the OEM Agent from a DB instance, do one of the following: -+ Remove the OEM Agent option from the option group it belongs to\. This change affects all DB instances that use the option group\. For more information, see [Removing an option from an option group](USER_WorkingWithOptionGroups.md#USER_WorkingWithOptionGroups.RemoveOption)\. -+ Modify the DB instance and specify a different option group that doesn't include the OEM Agent option\. This change affects a single DB instance\. You can specify the default \(empty\) option group, or a different custom option group\. For more information, see [Modifying an Amazon RDS DB instance](Overview.DBInstance.Modifying.md)\. \ No newline at end of file diff --git a/doc_source/Oracle.Options.OLAP.md b/doc_source/Oracle.Options.OLAP.md deleted file mode 100644 index 3e23371..0000000 --- a/doc_source/Oracle.Options.OLAP.md +++ /dev/null @@ -1,74 +0,0 @@ -# Oracle OLAP - -Amazon RDS supports Oracle OLAP through the use of the `OLAP` option\. This option provides On\-line Analytical Processing \(OLAP\) for Oracle DB instances\. You can use Oracle OLAP to analyze large amounts of data by creating dimensional objects and cubes in accordance with the OLAP standard\. For more information, see [the Oracle documentation](https://docs.oracle.com/en/database/oracle/oracle-database/19/olaug/index.html)\. - -**Important** -If you use Oracle OLAP, Amazon RDS automatically updates your DB instance to the latest Oracle PSU if there are security vulnerabilities with a Common Vulnerability Scoring System \(CVSS\) score of 9\+ or other announced security vulnerabilities\. - -Amazon RDS supports Oracle OLAP for the following editions and versions of Oracle: -+ Oracle Database 21c Enterprise Edition, all versions -+ Oracle Database 19c Enterprise Edition, all versions -+ Oracle Database 12c Release 2 \(12\.2\.0\.1\) Enterprise Edition, all versions -+ Oracle Database 12c Release 1 \(12\.1\.0\.2\) Enterprise Edition, version 12\.1\.0\.2\.v13 or later - -## Prerequisites for Oracle OLAP - -The following are prerequisites for using Oracle OLAP: -+ You must have an Oracle OLAP license from Oracle\. For more information, see [Licensing Information](https://docs.oracle.com/en/database/oracle/oracle-database/19/dblic/Licensing-Information.html#GUID-B6113390-9586-46D7-9008-DCC9EDA45AB4) in the Oracle documentation\. -+ Your DB instance must be of a sufficient instance class\. Oracle OLAP isn't supported for the db\.t3\.micro or db\.t3\.small DB instance classes\. For more information, see [RDS for Oracle instance classes](Oracle.Concepts.InstanceClasses.md)\. -+ Your DB instance must have **Auto Minor Version Upgrade** enabled\. This option enables your DB instance to receive minor DB engine version upgrades automatically when they become available and is required for any options that install the Oracle Java Virtual Machine \(JVM\)\. Amazon RDS uses this option to update your DB instance to the latest Oracle Patch Set Update \(PSU\) or Release Update \(RU\)\. For more information, see [Modifying an Amazon RDS DB instance](Overview.DBInstance.Modifying.md)\. -+ Your DB instance must not have a user named `OLAPSYS`\. If it does, the OLAP option installation fails\. - -## Best practices for Oracle OLAP - -The following are best practices for using Oracle OLAP: -+ For maximum security, use the `OLAP` option with Secure Sockets Layer \(SSL\)\. For more information, see [Oracle Secure Sockets Layer](Appendix.Oracle.Options.SSL.md)\. -+ Configure your DB instance to restrict access to your DB instance\. For more information, see [Scenarios for accessing a DB instance in a VPC](USER_VPC.Scenarios.md) and [Working with a DB instance in a VPC](USER_VPC.WorkingWithRDSInstanceinaVPC.md)\. - -## Adding the Oracle OLAP option - -The following is the general process for adding the `OLAP` option to a DB instance: - -1. Create a new option group, or copy or modify an existing option group\. - -1. Add the option to the option group\. - -1. Associate the option group with the DB instance\. - -If Oracle Java Virtual Machine \(JVM\) is *not* installed on the DB instance, there is a brief outage while the `OLAP` option is added\. There is no outage if Oracle Java Virtual Machine \(JVM\) is already installed on the DB instance\. After you add the option, you don't need to restart your DB instance\. As soon as the option group is active, Oracle OLAP is available\. - -**To add the OLAP option to a DB instance** - -1. Determine the option group that you want to use\. You can create a new option group or use an existing option group\. If you want to use an existing option group, skip to the next step\. Otherwise, create a custom DB option group with the following settings: - + For **Engine**, choose the Oracle edition for your DB instance\. - + For **Major engine version**, choose the version of your DB instance\. - - For more information, see [Creating an option group](USER_WorkingWithOptionGroups.md#USER_WorkingWithOptionGroups.Create)\. - -1. Add the **OLAP** option to the option group\. For more information about adding options, see [Adding an option to an option group](USER_WorkingWithOptionGroups.md#USER_WorkingWithOptionGroups.AddOption)\. - -1. Apply the option group to a new or existing DB instance: - + For a new DB instance, apply the option group when you launch the instance\. For more information, see [Creating an Amazon RDS DB instance](USER_CreateDBInstance.md)\. - + For an existing DB instance, apply the option group by modifying the instance and attaching the new option group\. For more information, see [Modifying an Amazon RDS DB instance](Overview.DBInstance.Modifying.md)\. - -## Using Oracle OLAP - -After you enable the Oracle OLAP option, you can begin using it\. For a list of features that are supported for Oracle OLAP, see [the Oracle documentation](https://docs.oracle.com/en/database/oracle/oracle-database/19/olaug/overview.html#GUID-E2056FE4-C623-4D29-B7D8-C4762F941966)\. - -## Removing the Oracle OLAP option - -After you drop all objects that use data types provided by the `OLAP` option, you can remove the option from a DB instance\. If Oracle Java Virtual Machine \(JVM\) is *not* installed on the DB instance, there is a brief outage while the `OLAP` option is removed\. There is no outage if Oracle Java Virtual Machine \(JVM\) is already installed on the DB instance\. After you remove the `OLAP` option, you don't need to restart your DB instance\. - -**To drop the `OLAP` option** - -1. Back up your data\. -**Warning** -If the instance uses data types that were enabled as part of the option, and if you remove the `OLAP` option, you can lose data\. For more information, see [Backing up and restoring](CHAP_CommonTasks.BackupRestore.md)\. - -1. Check whether any existing objects reference data types or features of the `OLAP` option\. - -1. Drop any objects that reference data types or features of the `OLAP` option\. - -1. Do one of the following: - + Remove the `OLAP` option from the option group it belongs to\. This change affects all DB instances that use the option group\. For more information, see [Removing an option from an option group](USER_WorkingWithOptionGroups.md#USER_WorkingWithOptionGroups.RemoveOption)\. - + Modify the DB instance and specify a different option group that doesn't include the `OLAP` option\. This change affects a single DB instance\. You can specify the default \(empty\) option group, or a different custom option group\. For more information, see [Modifying an Amazon RDS DB instance](Overview.DBInstance.Modifying.md)\. \ No newline at end of file diff --git a/doc_source/Oracle.Options.OLS.md b/doc_source/Oracle.Options.OLS.md deleted file mode 100644 index a581bf2..0000000 --- a/doc_source/Oracle.Options.OLS.md +++ /dev/null @@ -1,87 +0,0 @@ -# Oracle Label Security - -Amazon RDS supports Oracle Label Security for the Enterprise Edition of Oracle Database through the use of the OLS option\. - -Most database security controls access at the object level\. Oracle Label Security provides fine\-grained control of access to individual table rows\. For example, you can use Label Security to enforce regulatory compliance with a policy\-based administration model\. You can use Label Security policies to control access to sensitive data, and restrict access to only users with the appropriate clearance level\. For more information, see [Introduction to Oracle Label Security](https://docs.oracle.com/database/121/OLSAG/intro.htm#OLSAG001) in the Oracle documentation\. - -**Topics** -+ [Prerequisites for Oracle Label Security](#Oracle.Options.OLS.PreReqs) -+ [Adding the Oracle Label Security option](#Oracle.Options.OLS.Add) -+ [Using Oracle Label Security](#Oracle.Options.OLS.Using) -+ [Removing the Oracle Label Security option \(not supported\)](#Oracle.Options.OLS.Remove) -+ [Troubleshooting](#Oracle.Options.OLS.Troubleshooting) - -## Prerequisites for Oracle Label Security - -Familiarize yourself with the following prerequisites for Oracle Label Security: -+ Your DB instance must use the Bring Your Own License model\. For more information, see [RDS for Oracle licensing options](Oracle.Concepts.Licensing.md)\. -+ You must have a valid license for Oracle Enterprise Edition with Software Update License and Support\. -+ Your Oracle license must include the Label Security option\. -+ You must be using the non\-multitenant \(non\-CDB\) database architecture\. For more information, see [Overview of RDS for Oracle CDBs](oracle-multitenant.md#Oracle.Concepts.single-tenant)\. - -## Adding the Oracle Label Security option - -The general process for adding the Oracle Label Security option to a DB instance is the following: - -1. Create a new option group, or copy or modify an existing option group\. - -1. Add the option to the option group\. -**Important** -Oracle Label Security is a permanent and persistent option\. - -1. Associate the option group with the DB instance\. - -After you add the Label Security option, as soon as the option group is active, Label Security is active\. - -**To add the label security option to a DB instance** - -1. Determine the option group you want to use\. You can create a new option group or use an existing option group\. If you want to use an existing option group, skip to the next step\. Otherwise, create a custom DB option group with the following settings: - - 1. For **Engine**, choose **oracle\-ee**\. - - 1. For **Major engine version**, choose the version of your DB instance\. - - For more information, see [Creating an option group](USER_WorkingWithOptionGroups.md#USER_WorkingWithOptionGroups.Create)\. - -1. Add the **OLS** option to the option group\. For more information about adding options, see [Adding an option to an option group](USER_WorkingWithOptionGroups.md#USER_WorkingWithOptionGroups.AddOption)\. -**Important** -If you add Label Security to an existing option group that is already attached to one or more DB instances, all the DB instances are restarted\. - -1. Apply the option group to a new or existing DB instance: - + For a new DB instance, you apply the option group when you launch the instance\. For more information, see [Creating an Amazon RDS DB instance](USER_CreateDBInstance.md)\. - - - + For an existing DB instance, you apply the option group by modifying the instance and attaching the new option group\. When you add the Label Security option to an existing DB instance, a brief outage occurs while your DB instance is automatically restarted\. For more information, see [Modifying an Amazon RDS DB instance](Overview.DBInstance.Modifying.md)\. - -## Using Oracle Label Security - -To use Oracle Label Security, you create policies that control access to specific rows in your tables\. For more information, see [Creating an Oracle Label Security policy](https://docs.oracle.com/database/121/OLSAG/getstrtd.htm#OLSAG3096) in the Oracle documentation\. - -When you work with Label Security, you perform all actions as the LBAC\_DBA role\. The master user for your DB instance is granted the LBAC\_DBA role\. You can grant the LBAC\_DBA role to other users so that they can administer Label Security policies\. - -For the following releases, make sure to grant access to the `OLS_ENFORCEMENT` package to any new users who require access to Oracle Label Security: -+ Oracle Database 19c using the non\-CDB architecture -+ Oracle Database 12c Release 2 \(12\.2\) - -To grant access to the `OLS_ENFORCEMENT` package, connect to the DB instance as the master user and run the following SQL statement: - -``` -GRANT ALL ON LBACSYS.OLS_ENFORCEMENT TO username; -``` - -You can configure Label Security through the Oracle Enterprise Manager \(OEM\) Cloud Control\. Amazon RDS supports the OEM Cloud Control through the Management Agent option\. For more information, see [Oracle Management Agent for Enterprise Manager Cloud Control](Oracle.Options.OEMAgent.md)\. - -## Removing the Oracle Label Security option \(not supported\) - -Starting with Oracle Database 12c Release 2 \(12\.2\), Oracle Label Security is a permanent and persistent option\. Because the option is permanent, you can't remove it from an option group\. If you add Oracle Label Security to an option group and associate it with your DB instance, you can later associate a different option group with your DB instance, but this group must also contain the Oracle Label Security option\. - -## Troubleshooting - -The following are issues you might encounter when you use Oracle Label Security\. - - -**** - -| Issue | Troubleshooting suggestions | -| --- | --- | -| When you try to create a policy, you see an error message similar to the following: `insufficient authorization for the SYSDBA package`\. | A known issue with Oracle's Label Security feature prevents users with usernames of 16 or 24 characters from running Label Security commands\. You can create a new user with a different number of characters, grant LBAC\_DBA to the new user, log in as the new user, and run the OLS commands as the new user\. For additional information, please contact Oracle support\. | \ No newline at end of file diff --git a/doc_source/Oracle.Options.SQLT.md b/doc_source/Oracle.Options.SQLT.md deleted file mode 100644 index 3f3ca91..0000000 --- a/doc_source/Oracle.Options.SQLT.md +++ /dev/null @@ -1,219 +0,0 @@ -# Oracle SQLT - -Amazon RDS supports Oracle SQLTXPLAIN \(SQLT\) through the use of the SQLT option\. - -The Oracle `EXPLAIN PLAN` statement can determine the execution plan of a SQL statement\. It can verify whether the Oracle optimizer chooses a certain execution plan, such as a nested loops join\. It also helps you understand the optimizer's decisions, such as why it chose a nested loops join over a hash join\. So `EXPLAIN PLAN` helps you understand the statement's performance\. - -SQLT is an Oracle utility that produces a report\. The report includes object statistics, object metadata, optimizer\-related initialization parameters, and other information that a database administrator can use to tune a SQL statement for optimal performance\. SQLT produces an HTML report with hyperlinks to all of the sections in the report\. - -Unlike Automatic Workload Repository or Statspack reports, SQLT works on individual SQL statements\. SQLT is a collection of SQL, PL/SQL, and SQL\*Plus files that collect, store, and display performance data\. - -Following are the supported Oracle versions for each SQLT version\. - - -**** - -| SQLT version | Oracle Database 21c | Oracle Database 19c | Oracle Database 12c Release 2 \(12\.2\) | Oracle Database 12c Release 1 \(12\.1\) | -| --- | --- | --- | --- | --- | -| 2018\-07\-25\.v1 | Supported | Supported | Supported | Supported | -| 2018\-03\-31\.v1 | Not supported | Not supported | Supported | Supported | -| 2016\-04\-29\.v1 | Not supported | Not supported | Supported | Supported | - -To download SQLT and access instructions for using it: -+ Log in to your My Oracle Support account, and open the following documents: -+ To download SQLT: [Document 215187\.1](https://support.oracle.com/epmos/faces/DocumentDisplay?id=215187.1) -+ For SQLT usage instructions: [Document 1614107\.1](https://support.oracle.com/epmos/faces/DocumentDisplay?id=1614107.1) -+ For frequently asked questions about SQLT: [Document 1454160\.1](https://support.oracle.com/epmos/faces/DocumentDisplay?id=1454160.1) -+ For information about reading SQLT output: [Document 1456176\.1](https://support.oracle.com/epmos/main/downloadattachmentprocessor?parent=DOCUMENT&sourceId=1456176.1&attachid=1456176.1:58&clickstream=yes) -+ For interpreting the Main report: [Document 1922234\.1](https://support.oracle.com/epmos/faces/DocumentDisplay?parent=DOCUMENT&sourceId=215187.1&id=1922234.1) - - You can use SQLT with any edition of the following Oracle Database versions: -+ Oracle Database 21c \(21\.0\.0\.0\) -+ Oracle Database 19c \(19\.0\.0\.0\) -+ Oracle Database 12c Release 2 \(12\.2\.0\.1\) -+ Oracle Database 12c Release 1 \(12\.1\.0\.2\) - -Amazon RDS does not support the following SQLT methods: -+ `XPLORE` -+ `XHUME` - -## Prerequisites for SQLT - -The following are prerequisites for using SQLT: -+ You must remove users and roles that are required by SQLT, if they exist\. - - The SQLT option creates the following users and roles on a DB instance: - + `SQLTXPLAIN` user - + `SQLTXADMIN` user - + `SQLT_USER_ROLE` role - - If your DB instance has any of these users or roles, log in to the DB instance using a SQL client, and drop them using the following statements: - - ``` - DROP USER SQLTXPLAIN CASCADE; - DROP USER SQLTXADMIN CASCADE; - DROP ROLE SQLT_USER_ROLE CASCADE; - ``` -+ You must remove tablespaces that are required by SQLT, if they exist\. - - The SQLT option creates the following tablespaces on a DB instance: - + `RDS_SQLT_TS` - + `RDS_TEMP_SQLT_TS` - - If your DB instance has these tablespaces, log in to the DB instance using a SQL client, and drop them\. - -## SQLT option settings - - SQLT can work with licensed features that are provided by the Oracle Tuning Pack and the Oracle Diagnostics Pack\. The Oracle Tuning Pack includes the SQL Tuning Advisor, and the Oracle Diagnostics Pack includes the Automatic Workload Repository\. The SQLT settings enable or disable access to these features from SQLT\. - -Amazon RDS supports the following settings for the SQLT option\. - - -**** - -| Option setting | Valid values | Default value | Description | -| --- | --- | --- | --- | -| `LICENSE_PACK` | `T`, `D`, `N` | `N` | The Oracle Management Packs that you want to access with SQLT\. Enter one of the following values: [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Oracle.Options.SQLT.html) Amazon RDS does not provide licenses for these Oracle Management Packs\. If you indicate that you want to use a pack that is not included in your DB instance, you can use SQLT with the DB instance\. However, SQLT can't access the pack, and the SQLT report doesn't include the data for the pack\. For example, if you specify `T`, but the DB instance doesn't include the Oracle Tuning Pack, SQLT works on the DB instance, but the report it generates doesn't contain data related to the Oracle Tuning Pack\. | -| `VERSION` | `2016-04-29.v1` `2018-03-31.v1` `2018-07-25.v1` | `2016-04-29.v1` | The version of SQLT that you want to install\. For Oracle Database 19c and 21c, the only supported version is `2018-07-25.v1`\. This version is the default for these releases\. | - -## Adding the SQLT option - -The following is the general process for adding the SQLT option to a DB instance: - -1. Create a new option group, or copy or modify an existing option group\. - -1. Add the SQLT option to the option group\. - -1. Associate the option group with the DB instance\. - -After you add the SQLT option, as soon as the option group is active, SQLT is active\. - -**To add the SQLT option to a DB instance** - -1. Determine the option group that you want to use\. You can create a new option group or use an existing option group\. If you want to use an existing option group, skip to the next step\. Otherwise, create a custom DB option group with the following settings: - - 1. For **Engine**, choose the Oracle edition that you want to use\. The SQLT option is supported on all editions\. - - 1. For **Major engine version**, choose the version of your DB instance\. - - For more information, see [Creating an option group](USER_WorkingWithOptionGroups.md#USER_WorkingWithOptionGroups.Create)\. - -1. Add the **SQLT** option to the option group\. For more information about adding options, see [Adding an option to an option group](USER_WorkingWithOptionGroups.md#USER_WorkingWithOptionGroups.AddOption)\. - -1. Apply the option group to a new or existing DB instance: - + For a new DB instance, you apply the option group when you launch the instance\. For more information, see [Creating an Amazon RDS DB instance](USER_CreateDBInstance.md)\. - - - + For an existing DB instance, you apply the option group by modifying the instance and attaching the new option group\. For more information, see [Modifying an Amazon RDS DB instance](Overview.DBInstance.Modifying.md)\. - -1. \(Optional\) Verify the SQLT installation on each DB instance with the SQLT option\. - - 1. Use a SQL client to connect to the DB instance as the master user\. - - For information about connecting to an Oracle DB instance using a SQL client, see [Connecting to your RDS for Oracle DB instance](USER_ConnectToOracleInstance.md)\. - - 1. Run the following query: - - ``` - SELECT sqltxplain.sqlt$a.get_param('tool_version') sqlt_version FROM DUAL; - ``` - - The query returns the current version of the SQLT option on Amazon RDS\. `12.1.160429` is an example of a version of SQLT that is available on Amazon RDS\. - -1. Change the passwords of the users that are created by the SQLT option\. - - 1. Use a SQL client to connect to the DB instance as the master user\. - - 1. Run the following SQL statement to change the password for the `SQLTXADMIN` user: - - ``` - ALTER USER SQLTXADMIN IDENTIFIED BY new_password ACCOUNT UNLOCK; - ``` - - 1. Run the following SQL statement to change the password for the `SQLTXPLAIN` user: - - ``` - ALTER USER SQLTXPLAIN IDENTIFIED BY new_password ACCOUNT UNLOCK; - ``` - -**Note** -Upgrading SQLT requires uninstalling an older version of SQLT and then installing the new version\. So, all SQLT metadata can be lost when you upgrade SQLT\. A major version upgrade of a database also uninstalls and re\-installs SQLT\. An example of a major version upgrade is an upgrade from Oracle Database 12c Release 2 \(12\.2\) to Oracle Database 19c\. - -## Using SQLT - -SQLT works with the Oracle SQL\*Plus utility\. - -**To use SQLT** - -1. Download the SQLT \.zip file from [Document 215187\.1](https://support.oracle.com/epmos/faces/DocumentDisplay?id=215187.1) on the My Oracle Support site\. -**Note** -You can't download SQLT 12\.1\.160429 from the My Oracle Support site\. Oracle has deprecated this older version\. - -1. Unzip the SQLT \.zip file\. - -1. From a command prompt, change to the `sqlt/run` directory on your file system\. - -1. From the command prompt, open SQL\*Plus, and connect to the DB instance as the master user\. - - For information about connecting to a DB instance using SQL\*Plus, see [Connecting to your RDS for Oracle DB instance](USER_ConnectToOracleInstance.md)\. - -1. Get the SQL ID of a SQL statement: - - ``` - SELECT SQL_ID FROM V$SQL WHERE SQL_TEXT='sql_statement'; - ``` - - Your output is similar to the following: - - ``` - SQL_ID - ------------- - chvsmttqjzjkn - ``` - -1. Analyze a SQL statement with SQLT: - - ``` - START sqltxtract.sql sql_id sqltxplain_user_password - ``` - - For example, for the SQL ID `chvsmttqjzjkn`, enter the following: - - ``` - START sqltxtract.sql chvsmttqjzjkn sqltxplain_user_password - ``` - - SQLT generates the HTML report and related resources as a \.zip file in the directory from which the SQLT command was run\. - -1. \(Optional\) To enable application users to diagnose SQL statements with SQLT, grant `SQLT_USER_ROLE` to each application user with the following statement: - - ``` - GRANT SQLT_USER_ROLE TO application_user_name; - ``` -**Note** -Oracle does not recommend running SQLT with the `SYS` user or with users that have the `DBA` role\. It is a best practice to run SQLT diagnostics using the application user's account, by granting `SQLT_USER_ROLE` to the application user\. - -## Upgrading the SQLT option - -With Amazon RDS for Oracle, you can upgrade the SQLT option from your existing version to a higher version\. To upgrade the SQLT option, complete steps 1–3 in [Using SQLT](#Oracle.Options.SQLT.Using) for the new version of SQLT\. Also, if you granted privileges for the previous version of SQLT in step 7 of that section, grant the privileges again for the new SQLT version\. - -Upgrading the SQLT option results in the loss of the older SQLT version's metadata\. The older SQLT version's schema and related objects are dropped, and the newer version of SQLT is installed\. For more information about the changes in the latest SQLT version, see [Document 1614201\.1](https://support.oracle.com/epmos/faces/DocumentDisplay?parent=DOCUMENT&sourceId=215187.1&id=1614201.1) on the My Oracle Support site\. - -**Note** -Version downgrades are not supported\. - -## Modifying SQLT settings - -After you enable SQLT, you can modify the `LICENSE_PACK` and `VERSION` settings for the option\. - -For more information about how to modify option settings, see [Modifying an option setting](USER_WorkingWithOptionGroups.md#USER_WorkingWithOptionGroups.ModifyOption)\. For more information about each setting, see [SQLT option settings](#Oracle.Options.SQLT.Options)\. - -## Removing the SQLT option - -You can remove SQLT from a DB instance\. - -To remove SQLT from a DB instance, do one of the following: -+ To remove SQLT from multiple DB instances, remove the SQLT option from the option group to which the DB instances belong\. This change affects all DB instances that use the option group\. For more information, see [Removing an option from an option group](USER_WorkingWithOptionGroups.md#USER_WorkingWithOptionGroups.RemoveOption)\. - - -+ To remove SQLT from a single DB instance, modify the DB instance and specify a different option group that doesn't include the SQLT option\. You can specify the default \(empty\) option group or a different custom option group\. For more information, see [Modifying an Amazon RDS DB instance](Overview.DBInstance.Modifying.md)\. \ No newline at end of file diff --git a/doc_source/Oracle.Options.Spatial.md b/doc_source/Oracle.Options.Spatial.md deleted file mode 100644 index 1da6b33..0000000 --- a/doc_source/Oracle.Options.Spatial.md +++ /dev/null @@ -1,101 +0,0 @@ -# Oracle Spatial - -Amazon RDS supports Oracle Spatial through the use of the `SPATIAL` option\. Oracle Spatial provides a SQL schema and functions that facilitate the storage, retrieval, update, and query of collections of spatial data in an Oracle database\. For more information, see [Spatial Concepts](http://docs.oracle.com/database/121/SPATL/spatial-concepts.htm#SPATL010) in the Oracle documentation\. - -**Important** -If you use Oracle Spatial, Amazon RDS automatically updates your DB instance to the latest Oracle PSU when any of the following exist: -Security vulnerabilities with a Common Vulnerability Scoring System \(CVSS\) score of 9\+ -Other announced security vulnerabilities - -Amazon RDS supports Oracle Spatial only in Oracle Enterprise Edition \(EE\) and Oracle Standard Edition 2 \(SE2\)\. The following table shows the versions of the DB engine that support EE and SE2\. - - -**** - -| Oracle DB Version | EE | SE2 | -| --- | --- | --- | -| 21\.0\.0\.0, all versions | Yes | Yes | -| 19\.0\.0\.0, all versions | Yes | Yes | -| 12\.2\.0\.1, all versions | Yes | Yes | -| 12\.1\.0\.2\.v13 or later | Yes | No | - -## Prerequisites for Oracle Spatial - -The following are prerequisites for using Oracle Spatial: -+ Make sure that your DB instance is of a sufficient instance class\. Oracle Spatial isn't supported for the db\.t3\.micro or db\.t3\.small DB instance classes\. For more information, see [RDS for Oracle instance classes](Oracle.Concepts.InstanceClasses.md)\. -+ Make sure that your DB instance has **Auto Minor Version Upgrade** enabled\. This option enables your DB instance to receive minor DB engine version upgrades automatically when they become available and is required for any options that install the Oracle Java Virtual Machine \(JVM\)\. Amazon RDS uses this option to update your DB instance to the latest Oracle Patch Set Update \(PSU\) or Release Update \(RU\)\. For more information, see [Modifying an Amazon RDS DB instance](Overview.DBInstance.Modifying.md)\. - -## Best practices for Oracle Spatial - -The following are best practices for using Oracle Spatial: -+ For maximum security, use the `SPATIAL` option with Secure Sockets Layer \(SSL\)\. For more information, see [Oracle Secure Sockets Layer](Appendix.Oracle.Options.SSL.md)\. -+ Configure your DB instance to restrict access to your DB instance\. For more information, see [Scenarios for accessing a DB instance in a VPC](USER_VPC.Scenarios.md) and [Working with a DB instance in a VPC](USER_VPC.WorkingWithRDSInstanceinaVPC.md)\. - -## Adding the Oracle Spatial option - -The following is the general process for adding the `SPATIAL` option to a DB instance: - -1. Create a new option group, or copy or modify an existing option group\. - -1. Add the option to the option group\. - -1. Associate the option group with the DB instance\. - -If Oracle Java Virtual Machine \(JVM\) is *not* installed on the DB instance, there is a brief outage while the `SPATIAL` option is added\. There is no outage if Oracle Java Virtual Machine \(JVM\) is already installed on the DB instance\. After you add the option, you don't need to restart your DB instance\. As soon as the option group is active, Oracle Spatial is available\. - -**Note** -During this outage, password verification functions are disabled briefly\. You can also expect to see events related to password verification functions during the outage\. Password verification functions are enabled again before the Oracle DB instance is available\. - -**To add the `SPATIAL` option to a DB instance** - -1. Determine the option group that you want to use\. You can create a new option group or use an existing option group\. If you want to use an existing option group, skip to the next step\. Otherwise, create a custom DB option group with the following settings: - - 1. For **Engine**, choose the Oracle edition for your DB instance\. - - 1. For **Major engine version**, choose the version of your DB instance\. - - For more information, see [Creating an option group](USER_WorkingWithOptionGroups.md#USER_WorkingWithOptionGroups.Create)\. - -1. Add the **SPATIAL** option to the option group\. For more information about adding options, see [Adding an option to an option group](USER_WorkingWithOptionGroups.md#USER_WorkingWithOptionGroups.AddOption)\. - -1. Apply the option group to a new or existing DB instance: - + For a new DB instance, you apply the option group when you launch the instance\. For more information, see [Creating an Amazon RDS DB instance](USER_CreateDBInstance.md)\. - + For an existing DB instance, you apply the option group by modifying the instance and attaching the new option group\. For more information, see [Modifying an Amazon RDS DB instance](Overview.DBInstance.Modifying.md)\. - -## Removing the Oracle Spatial option - -After you drop all objects that use data types provided by the `SPATIAL` option, you can drop the option from a DB instance\. If Oracle Java Virtual Machine \(JVM\) is *not* installed on the DB instance, there is a brief outage while the `SPATIAL` option is removed\. There is no outage if Oracle Java Virtual Machine \(JVM\) is already installed on the DB instance\. After you remove the `SPATIAL` option, you don't need to restart your DB instance\. - -**To drop the `SPATIAL` option** - -1. Back up your data\. -**Warning** -If the instance uses data types that were enabled as part of the option, and if you remove the `SPATIAL` option, you can lose data\. For more information, see [Backing up and restoring](CHAP_CommonTasks.BackupRestore.md)\. - -1. Check whether any existing objects reference data types or features of the `SPATIAL` option\. - - If `SPATIAL` options exist, the instance can get stuck when applying the new option group that doesn't have the `SPATIAL` option\. You can identify the objects by using the following queries: - - ``` - SELECT OWNER, SEGMENT_NAME, TABLESPACE_NAME, BYTES/1024/1024 mbytes - FROM DBA_SEGMENTS - WHERE SEGMENT_TYPE LIKE '%TABLE%' - AND (OWNER, SEGMENT_NAME) IN - (SELECT DISTINCT OWNER, TABLE_NAME - FROM DBA_TAB_COLUMNS - WHERE DATA_TYPE='SDO_GEOMETRY' - AND OWNER <> 'MDSYS') - ORDER BY 1,2,3,4; - - SELECT OWNER, TABLE_NAME, COLUMN_NAME - FROM DBA_TAB_COLUMNS - WHERE DATA_TYPE = 'SDO_GEOMETRY' - AND OWNER <> 'MDSYS' - ORDER BY 1,2,3; - ``` - -1. Drop any objects that reference data types or features of the `SPATIAL` option\. - -1. Do one of the following: - + Remove the `SPATIAL` option from the option group it belongs to\. This change affects all DB instances that use the option group\. For more information, see [Removing an option from an option group](USER_WorkingWithOptionGroups.md#USER_WorkingWithOptionGroups.RemoveOption)\. - + Modify the DB instance and specify a different option group that doesn't include the `SPATIAL` option\. This change affects a single DB instance\. You can specify the default \(empty\) option group, or a different custom option group\. For more information, see [Modifying an Amazon RDS DB instance](Overview.DBInstance.Modifying.md)\. \ No newline at end of file diff --git a/doc_source/Oracle.Options.UTLMAIL.md b/doc_source/Oracle.Options.UTLMAIL.md deleted file mode 100644 index 6040089..0000000 --- a/doc_source/Oracle.Options.UTLMAIL.md +++ /dev/null @@ -1,87 +0,0 @@ -# Oracle UTL\_MAIL - -Amazon RDS supports Oracle UTL\_MAIL through the use of the UTL\_MAIL option and SMTP servers\. You can send email directly from your database by using the UTL\_MAIL package\. Amazon RDS supports UTL\_MAIL for the following versions of Oracle: -+ Oracle Database 21c \(21\.0\.0\.0\), all versions -+ Oracle Database 19c \(19\.0\.0\.0\), all versions -+ Oracle Database 12c Release 2 \(12\.2\), all versions -+ Oracle Database 12c Release 1 \(12\.1\), version 12\.1\.0\.2\.v5 and later - -The following are some limitations to using UTL\_MAIL: -+ UTL\_MAIL does not support Transport Layer Security \(TLS\) and therefore emails are not encrypted\. - - To connect securely to remote SSL/TLS resources by creating and uploading custom Oracle wallets, follow the instructions in [Configuring UTL\_HTTP access using certificates and an Oracle wallet](Oracle.Concepts.ONA.md)\. - - The specific certificates that are required for your wallet vary by service\. For AWS services, these can typically be found in the [Amazon trust services repository](https://www.amazontrust.com/repository/)\. -+ UTL\_MAIL does not support authentication with SMTP servers\. -+ You can only send a single attachment in an email\. -+ You can't send attachments larger than 32 K\. -+ You can only use ASCII and Extended Binary Coded Decimal Interchange Code \(EBCDIC\) character encodings\. -+ SMTP port \(25\) is throttled based on the elastic network interface owner's policies\. - -When you enable UTL\_MAIL, only the master user for your DB instance is granted the execute privilege\. If necessary, the master user can grant the execute privilege to other users so that they can use UTL\_MAIL\. - -**Important** -We recommend that you enable Oracle's built\-in auditing feature to track the use of UTL\_MAIL procedures\. - -## Prerequisites for Oracle UTL\_MAIL - -The following are prerequisites for using Oracle UTL\_MAIL: -+ One or more SMTP servers, and the corresponding IP addresses or public or private Domain Name Server \(DNS\) names\. For more information about private DNS names resolved through a custom DNS server, see [Setting up a custom DNS server](Appendix.Oracle.CommonDBATasks.System.md#Appendix.Oracle.CommonDBATasks.CustomDNS)\. -+ For Oracle versions prior to 12c, your DB instance must also use the XML DB option\. For more information, see [Oracle XML DB](Appendix.Oracle.Options.XMLDB.md)\. - -## Adding the Oracle UTL\_MAIL option - -The general process for adding the Oracle UTL\_MAIL option to a DB instance is the following: - -1. Create a new option group, or copy or modify an existing option group\. - -1. Add the option to the option group\. - -1. Associate the option group with the DB instance\. - -After you add the UTL\_MAIL option, as soon as the option group is active, UTL\_MAIL is active\. - -**To add the UTL\_MAIL option to a DB instance** - -1. Determine the option group you want to use\. You can create a new option group or use an existing option group\. If you want to use an existing option group, skip to the next step\. Otherwise, create a custom DB option group with the following settings: - - 1. For **Engine**, choose the edition of Oracle you want to use\. - - 1. For **Major engine version**, choose the version of your DB instance\. - - For more information, see [Creating an option group](USER_WorkingWithOptionGroups.md#USER_WorkingWithOptionGroups.Create)\. - -1. Add the **UTL\_MAIL** option to the option group\. For more information about adding options, see [Adding an option to an option group](USER_WorkingWithOptionGroups.md#USER_WorkingWithOptionGroups.AddOption)\. - -1. Apply the option group to a new or existing DB instance: - + For a new DB instance, you apply the option group when you launch the instance\. For more information, see [Creating an Amazon RDS DB instance](USER_CreateDBInstance.md)\. - + For an existing DB instance, you apply the option group by modifying the instance and attaching the new option group\. For more information, see [Modifying an Amazon RDS DB instance](Overview.DBInstance.Modifying.md)\. - -## Using Oracle UTL\_MAIL - -After you enable the UTL\_MAIL option, you must configure the SMTP server before you can begin using it\. - -You configure the SMTP server by setting the SMTP\_OUT\_SERVER parameter to a valid IP address or public DNS name\. For the SMTP\_OUT\_SERVER parameter, you can specify a comma\-separated list of the addresses of multiple servers\. If the first server is unavailable, UTL\_MAIL tries the next server, and so on\. - -You can set the default SMTP\_OUT\_SERVER for a DB instance by using a [DB parameter group](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_WorkingWithParamGroups.html)\. You can set the SMTP\_OUT\_SERVER parameter for a session by running the following code on your database on your DB instance\. - -``` -1. ALTER SESSION SET smtp_out_server = mailserver.domain.com:25; -``` - -After the UTL\_MAIL option is enabled, and your SMTP\_OUT\_SERVER is configured, you can send mail by using the `SEND` procedure\. For more information, see [UTL\_MAIL](http://docs.oracle.com/cd/B19306_01/appdev.102/b14258/u_mail.htm#BABFJJBD) in the Oracle documentation\. - -## Removing the Oracle UTL\_MAIL option - -You can remove Oracle UTL\_MAIL from a DB instance\. - -To remove UTL\_MAIL from a DB instance, do one of the following: -+ To remove UTL\_MAIL from multiple DB instances, remove the UTL\_MAIL option from the option group they belong to\. This change affects all DB instances that use the option group\. For more information, see [Removing an option from an option group](USER_WorkingWithOptionGroups.md#USER_WorkingWithOptionGroups.RemoveOption)\. -+ To remove UTL\_MAIL from a single DB instance, modify the DB instance and specify a different option group that doesn't include the UTL\_MAIL option\. You can specify the default \(empty\) option group, or a different custom option group\. For more information, see [Modifying an Amazon RDS DB instance](Overview.DBInstance.Modifying.md)\. - -## Troubleshooting - -The following are issues you might encounter when you use UTL\_MAIL with Amazon RDS\. -+ Throttling\. SMTP port \(25\) is throttled based on the elastic network interface owner's policies\. If you can successfully send email by using UTL\_MAIL, and you see the error `ORA-29278: SMTP transient error: 421 Service not available`, you are possibly being throttled\. If you experience throttling with email delivery, we recommend that you implement a backoff algorithm\. For more information about backoff algorithms, see [Error retries and exponential backoff in AWS](https://docs.aws.amazon.com/general/latest/gr/api-retries.html) and [How to handle a "throttling – Maximum sending rate exceeded" error](http://aws.amazon.com/blogs/ses/how-to-handle-a-throttling-maximum-sending-rate-exceeded-error/)\. - - You can request that this throttle be removed\. For more information, see [How do I remove the throttle on port 25 from my EC2 instance?](http://aws.amazon.com/premiumsupport/knowledge-center/ec2-port-25-throttle/)\. \ No newline at end of file diff --git a/doc_source/Oracle.Procedural.Importing.DataPump.md b/doc_source/Oracle.Procedural.Importing.DataPump.md deleted file mode 100644 index 4d60205..0000000 --- a/doc_source/Oracle.Procedural.Importing.DataPump.md +++ /dev/null @@ -1,536 +0,0 @@ -# Importing using Oracle Data Pump - -Oracle Data Pump is a utility that allows you to export Oracle data to a dump file and import it into another Oracle database\. It is a long\-term replacement for the Oracle Export/Import utilities\. Oracle Data Pump is the recommended way to move large amounts of data from an Oracle database to an Amazon RDS DB instance\. - -The examples in this section show one way to import data into an Oracle database, but Oracle Data Pump supports other techniques\. For more information, see the [Oracle Database documentation](https://docs.oracle.com/en/database/oracle/oracle-database/19/sutil/oracle-data-pump.html#GUID-501A9908-BCC5-434C-8853-9A6096766B5A)\. - -The examples in this section use the `DBMS_DATAPUMP` package\. You can accomplish the same tasks using the Oracle Data Pump command line utilities `impdp` and `expdp`\. You can install these utilities on a remote host as part of an Oracle Client installation, including Oracle Instant Client\. For more information, see [How do I use Oracle Instant Client to run Data Pump Import or Export for my Amazon RDS for Oracle DB instance?](https://aws.amazon.com/premiumsupport/knowledge-center/rds-oracle-instant-client-datapump/) - -**Topics** -+ [Overview of Oracle Data Pump](#Oracle.Procedural.Importing.DataPump.Overview) -+ [Importing data with Oracle Data Pump and an Amazon S3 bucket](#Oracle.Procedural.Importing.DataPump.S3) -+ [Importing data with Oracle Data Pump and a database link](#Oracle.Procedural.Importing.DataPump.DBLink) - -## Overview of Oracle Data Pump - -Oracle Data Pump is made up of the following components: -+ Command\-line clients `expdp` and `impdp` -+ The `DBMS_DATAPUMP` PL/SQL package -+ The `DBMS_METADATA` PL/SQL package - -You can use Oracle Data Pump for the following scenarios: -+ Import data from an Oracle database, either on\-premises or on an Amazon EC2 instance, to an RDS for Oracle DB instance\. -+ Import data from an RDS for Oracle DB instance to an Oracle database, either on\-premises or on an Amazon EC2 instance\. -+ Import data between RDS for Oracle DB instances, for example, to migrate data from EC2\-Classic to VPC\. - -To download Oracle Data Pump utilities, see [Oracle database software downloads](http://www.oracle.com/technetwork/database/enterprise-edition/downloads/index.html) on the Oracle Technology Network website\. For compatibility considerations when migrating between versions of Oracle Database, see the [ Oracle Database documentation](https://docs.oracle.com/en/database/oracle/oracle-database/19/sutil/oracle-data-pump-overview.html#GUID-BAA3B679-A758-4D55-9820-432D9EB83C68)\. - -### Oracle Data Pump workflow - -Typically, you use Oracle Data Pump in the following stages: - -1. Export your data into a dump file on the source database\. - -1. Upload your dump file to your destination RDS for Oracle DB instance\. You can transfer using an Amazon S3 bucket or by using a database link between the two databases\. - -1. Import the data from your dump file into your RDS for Oracle DB instance\. - -### Oracle Data Pump best practices - -When you use Oracle Data Pump to import data into an RDS for Oracle instance, we recommend the following best practices: -+ Perform imports in `schema` or `table` mode to import specific schemas and objects\. -+ Limit the schemas you import to those required by your application\. -+ Don't import in `full` mode or import schemas for system\-maintained components\. - - Because RDS for Oracle doesn't allow access to `SYS` or `SYSDBA` administrative users, these actions might damage the Oracle data dictionary and affect the stability of your database\. -+ When loading large amounts of data, do the following: - - 1. Transfer the dump file to the target RDS for Oracle DB instance\. - - 1. Take a DB snapshot of your instance\. - - 1. Test the import to verify that it succeeds\. - - If database components are invalidated, you can delete the DB instance and re\-create it from the DB snapshot\. The restored DB instance includes any dump files staged on the DB instance when you took the DB snapshot\. -+ Don't import dump files that were created using the Oracle Data Pump export parameters `TRANSPORT_TABLESPACES`, `TRANSPORTABLE`, or `TRANSPORT_FULL_CHECK`\. RDS for Oracle DB instances don't support importing these dump files\. -+ Don't import dump files that contain Oracle Scheduler objects in `SYS`, `SYSTEM`, `RDSADMIN`, `RDSSEC`, and `RDS_DATAGUARD`, and belong to the following categories: - + Jobs - + Programs - + Schedules - + Chains - + Rules - + Evaluation contexts - + Rule sets - - RDS for Oracle DB instances don't support importing these dump files\. -+ To exclude unsupported Oracle Scheduler objects, use additional directives during the Data Pump export\. If you use `DBMS_DATAPUMP`, you can add an additional `METADATA_FILTER` before the `DBMS_METADATA.START_JOB`: - - ``` - DBMS_DATAPUMP.METADATA_FILTER( - v_hdnl, - 'EXCLUDE_NAME_EXPR', - q'[IN (SELECT NAME FROM SYS.OBJ$ - WHERE TYPE# IN (66,67,74,79,59,62,46) - AND OWNER# IN - (SELECT USER# FROM SYS.USER$ - WHERE NAME IN ('RDSADMIN','SYS','SYSTEM','RDS_DATAGUARD','RDSSEC') - ) - ) - ]', - 'PROCOBJ' - ); - ``` - - If you use `expdp`, create a parameter file that contains the `exclude` directive shown in the following example\. Then use `PARFILE=parameter_file` with your `expdp` command\. - - ``` - exclude=procobj:"IN - (SELECT NAME FROM sys.OBJ$ - WHERE TYPE# IN (66,67,74,79,59,62,46) - AND OWNER# IN - (SELECT USER# FROM SYS.USER$ - WHERE NAME IN ('RDSADMIN','SYS','SYSTEM','RDS_DATAGUARD','RDSSEC') - ) - )" - ``` - -## Importing data with Oracle Data Pump and an Amazon S3 bucket - -The following import process uses Oracle Data Pump and an Amazon S3 bucket\. The steps are as follows: - -1. Export data on the source database using the Oracle [DBMS\_DATAPUMP](https://docs.oracle.com/en/database/oracle/oracle-database/19/arpls/DBMS_DATAPUMP.html) package\. - -1. Place the dump file in an Amazon S3 bucket\. - -1. Download the dump file from the Amazon S3 bucket to the `DATA_PUMP_DIR` directory on the target RDS for Oracle DB instance\. - -1. Import the data from the copied dump file into the RDS for Oracle DB instance using the package `DBMS_DATAPUMP`\. - -**Topics** -+ [Requirements for Importing data with Oracle Data Pump and an Amazon S3 bucket](#Oracle.Procedural.Importing.DataPumpS3.requirements) -+ [Step 1: Grant privileges to the database user on the RDS for Oracle target DB instance](#Oracle.Procedural.Importing.DataPumpS3.Step1) -+ [Step 2: Export data into a dump file using DBMS\_DATAPUMP](#Oracle.Procedural.Importing.DataPumpS3.Step2) -+ [Step 3: Upload the dump file to your Amazon S3 bucket](#Oracle.Procedural.Importing.DataPumpS3.Step3) -+ [Step 4: Download the dump file from your Amazon S3 bucket to your target DB instance](#Oracle.Procedural.Importing.DataPumpS3.Step4) -+ [Step 5: Import your dump file into your target DB instance using DBMS\_DATAPUMP](#Oracle.Procedural.Importing.DataPumpS3.Step5) -+ [Step 6: Clean up](#Oracle.Procedural.Importing.DataPumpS3.Step6) - -### Requirements for Importing data with Oracle Data Pump and an Amazon S3 bucket - -The process has the following requirements: -+ Make sure that an Amazon S3 bucket is available for file transfers, and that the Amazon S3 bucket is in the same AWS Region as the DB instance\. For instructions, see [Create a bucket](https://docs.aws.amazon.com/AmazonS3/latest/gsg/CreatingABucket.html) in the *Amazon Simple Storage Service Getting Started Guide*\. -+ The object that you upload into the Amazon S3 bucket must be 5 TB or less\. For more information about working with objects in Amazon S3, see [Amazon Simple Storage Service User Guide](https://docs.aws.amazon.com/AmazonS3/latest/dev/UsingObjects.html)\. -**Note** -If you dump file exceeds 5 TB, you can run the Oracle Data Pump export with the parallel option\. This operation spreads the data into multiple dump files so that you do not exceed the 5 TB limit for individual files\. -+ You must prepare the Amazon S3 bucket for Amazon RDS integration by following the instructions in [Configuring IAM permissions for RDS for Oracle integration with Amazon S3](oracle-s3-integration.md#oracle-s3-integration.preparing)\. -+ You must ensure that you have enough storage space to store the dump file on the source instance and the target DB instance\. - -**Note** -This process imports a dump file into the `DATA_PUMP_DIR` directory, a preconfigured directory on all Oracle DB instances\. This directory is located on the same storage volume as your data files\. When you import the dump file, the existing Oracle data files use more space\. Thus, you should make sure that your DB instance can accommodate that additional use of space\. The imported dump file is not automatically deleted or purged from the `DATA_PUMP_DIR` directory\. To remove the imported dump file, use [UTL\_FILE\.FREMOVE](https://docs.oracle.com/en/database/oracle/oracle-database/19/arpls/UTL_FILE.html#GUID-09B09C2A-2C21-4F70-BF04-D0EEA7B59CAF), found on the Oracle website\. - -### Step 1: Grant privileges to the database user on the RDS for Oracle target DB instance - -In this step, you create the schemas into which you plan to import data and grant the users necessary privileges\. - -**To create users and grant necessary privileges on the RDS for Oracle target instance** - -1. Use SQL\*Plus or Oracle SQL Developer to log in as the master user to the RDS for Oracle DB instance into which the data will be imported\. For information about connecting to a DB instance, see [Connecting to your RDS for Oracle DB instance](USER_ConnectToOracleInstance.md)\. - -1. Create the required tablespaces before you import the data\. For more information, see [Creating and sizing tablespaces](Appendix.Oracle.CommonDBATasks.Database.md#Appendix.Oracle.CommonDBATasks.CreatingTablespacesAndDatafiles)\. - -1. Create the user account and grant the necessary permissions and roles if the user account into which the data is imported doesn't exist\. If you plan to import data into multiple user schemas, create each user account and grant the necessary privileges and roles to it\. - - For example, the following SQL statements create a new user and grant the necessary permissions and roles to import the data into the schema owned by this user\. Replace `schema_1` with the name of your schema in this step and in the following steps\. - - ``` - CREATE USER schema_1 IDENTIFIED BY my_password; - GRANT CREATE SESSION, RESOURCE TO schema_1; - ALTER USER schema_1 QUOTA 100M ON users; - ``` - - The preceding statements grant the new user the `CREATE SESSION` privilege and the `RESOURCE` role\. You might need additional privileges and roles depending on the database objects that you import\. - -### Step 2: Export data into a dump file using DBMS\_DATAPUMP - -To create a dump file, use the `DBMS_DATAPUMP` package\. - -**To export Oracle data into a dump file** - -1. Use SQL Plus or Oracle SQL Developer to connect to the source RDS for Oracle DB instance with an administrative user\. If the source database is an RDS for Oracle DB instance, connect with the Amazon RDS master user\. - -1. Export the data by calling `DBMS_DATAPUMP` procedures\. - - The following script exports the `SCHEMA_1` schema into a dump file named `sample.dmp` in the `DATA_PUMP_DIR` directory\. Replace `SCHEMA_1` with the name of the schema that you want to export\. - - ``` - DECLARE - v_hdnl NUMBER; - BEGIN - v_hdnl := DBMS_DATAPUMP.OPEN( - operation => 'EXPORT', - job_mode => 'SCHEMA', - job_name => null - ); - DBMS_DATAPUMP.ADD_FILE( - handle => v_hdnl , - filename => 'sample.dmp' , - directory => 'DATA_PUMP_DIR', - filetype => dbms_datapump.ku$_file_type_dump_file - ); - DBMS_DATAPUMP.ADD_FILE( - handle => v_hdnl, - filename => 'sample_exp.log', - directory => 'DATA_PUMP_DIR' , - filetype => dbms_datapump.ku$_file_type_log_file - ); - DBMS_DATAPUMP.METADATA_FILTER(v_hdnl,'SCHEMA_EXPR','IN (''SCHEMA_1'')'); - DBMS_DATAPUMP.METADATA_FILTER( - v_hdnl, - 'EXCLUDE_NAME_EXPR', - q'[IN (SELECT NAME FROM SYS.OBJ$ - WHERE TYPE# IN (66,67,74,79,59,62,46) - AND OWNER# IN - (SELECT USER# FROM SYS.USER$ - WHERE NAME IN ('RDSADMIN','SYS','SYSTEM','RDS_DATAGUARD','RDSSEC') - ) - ) - ]', - 'PROCOBJ' - ); - DBMS_DATAPUMP.START_JOB(v_hdnl); - END; - / - ``` -**Note** -Data Pump starts jobs asynchronously\. For information about monitoring a Data Pump job, see [ Monitoring job status](https://docs.oracle.com/en/database/oracle/oracle-database/19/sutil/oracle-data-pump-overview.html#GUID-E365D74E-12CD-495C-BA23-5A55F679C7E7) in the Oracle documentation\. - -1. \(Optional\) View the contents of the export log by calling the `rdsadmin.rds_file_util.read_text_file` procedure\. For more information, see [Reading files in a DB instance directory](Appendix.Oracle.CommonDBATasks.Misc.md#Appendix.Oracle.CommonDBATasks.ReadingFiles)\. - -### Step 3: Upload the dump file to your Amazon S3 bucket - -Use the Amazon RDS procedure `rdsadmin.rdsadmin_s3_tasks.upload_to_s3` to copy the dump file to the Amazon S3 bucket\. The following example uploads all of the files from the `DATA_PUMP_DIR` directory to an Amazon S3 bucket named `myS3bucket`\. - -``` -SELECT rdsadmin.rdsadmin_s3_tasks.upload_to_s3( - p_bucket_name => 'myS3bucket', - p_directory_name => 'DATA_PUMP_DIR') -AS TASK_ID FROM DUAL; -``` - -The `SELECT` statement returns the ID of the task in a `VARCHAR2` data type\. For more information, see [Uploading files from your RDS for Oracle DB instance to an Amazon S3 bucket](oracle-s3-integration.md#oracle-s3-integration.using.upload)\. - -### Step 4: Download the dump file from your Amazon S3 bucket to your target DB instance - -Perform this step using the Amazon RDS procedure `rdsadmin.rdsadmin_s3_tasks.download_from_s3`\. When you download a file to a directory, the procedure `download_from_s3` skips the download if an identically named file already exists in the directory\. To remove a file from the download directory, use [UTL\_FILE\.FREMOVE](https://docs.oracle.com/en/database/oracle/oracle-database/19/arpls/UTL_FILE.html#GUID-09B09C2A-2C21-4F70-BF04-D0EEA7B59CAF), found on the Oracle website\. - -**To download your dump file** - -1. Start SQL\*Plus or Oracle SQL Developer and log in as the master on your Amazon RDS target Oracle DB instance - -1. Download the dump file using the Amazon RDS procedure `rdsadmin.rdsadmin_s3_tasks.download_from_s3`\. - - The following example downloads all files from an Amazon S3 bucket named `myS3bucket` to the directory `DATA_PUMP_DIR`\. - - ``` - SELECT rdsadmin.rdsadmin_s3_tasks.download_from_s3( - p_bucket_name => 'myS3bucket', - p_directory_name => 'DATA_PUMP_DIR') - AS TASK_ID FROM DUAL; - ``` - - The `SELECT` statement returns the ID of the task in a `VARCHAR2` data type\. For more information, see [Downloading files from an Amazon S3 bucket to an Oracle DB instance](oracle-s3-integration.md#oracle-s3-integration.using.download)\. - -### Step 5: Import your dump file into your target DB instance using DBMS\_DATAPUMP - -Use `DBMS_DATAPUMP` to import the schema into your RDS for Oracle DB instance\. Additional options such as `METADATA_REMAP` might be required\. - -**To import data into your target DB instance** - -1. Start SQL\*Plus or SQL Developer and log in as the master user to your RDS for Oracle DB instance\. - -1. Export the data by calling `DBMS_DATAPUMP` procedures\. - - The following example imports the *SCHEMA\_1* data from `sample_copied.dmp` into your target DB instance\. - - ``` - DECLARE - v_hdnl NUMBER; - BEGIN - v_hdnl := DBMS_DATAPUMP.OPEN( - operation => 'IMPORT', - job_mode => 'SCHEMA', - job_name => null); - DBMS_DATAPUMP.ADD_FILE( - handle => v_hdnl, - filename => 'sample_copied.dmp', - directory => 'DATA_PUMP_DIR', - filetype => dbms_datapump.ku$_file_type_dump_file); - DBMS_DATAPUMP.ADD_FILE( - handle => v_hdnl, - filename => 'sample_imp.log', - directory => 'DATA_PUMP_DIR', - filetype => dbms_datapump.ku$_file_type_log_file); - DBMS_DATAPUMP.METADATA_FILTER(v_hdnl,'SCHEMA_EXPR','IN (''SCHEMA_1'')'); - DBMS_DATAPUMP.START_JOB(v_hdnl); - END; - / - ``` -**Note** -Data Pump jobs are started asynchronously\. For information about monitoring a Data Pump job, see [ Monitoring job status](https://docs.oracle.com/en/database/oracle/oracle-database/19/sutil/oracle-data-pump-overview.html#GUID-E365D74E-12CD-495C-BA23-5A55F679C7E7) in the Oracle documentation\. You can view the contents of the import log by using the `rdsadmin.rds_file_util.read_text_file` procedure\. For more information, see [Reading files in a DB instance directory](Appendix.Oracle.CommonDBATasks.Misc.md#Appendix.Oracle.CommonDBATasks.ReadingFiles)\. - -1. Verify the data import by listing the schema tables on your target DB instance\. - - For example, the following query returns the number of tables for `SCHEMA_1`\. - - ``` - SELECT COUNT(*) FROM DBA_TABLES WHERE OWNER='SCHEMA_1'; - ``` - -### Step 6: Clean up - -After the data has been imported, you can delete the files that you don't want to keep\. - -**To remove unneeded files** - -1. Start SQL\*Plus or SQL Developer and log in as the master user to your RDS for Oracle DB instance\. - -1. List the files in `DATA_PUMP_DIR` using the following command\. - - ``` - SELECT * FROM TABLE(rdsadmin.rds_file_util.listdir('DATA_PUMP_DIR')) ORDER BY MTIME; - ``` - -1. Delete files in `DATA_PUMP_DIR` that you no longer require, use the following command\. - - ``` - EXEC UTL_FILE.FREMOVE('DATA_PUMP_DIR','filename'); - ``` - - For example, the following command deletes the file named `sample_copied.dmp`\. - - ``` - EXEC UTL_FILE.FREMOVE('DATA_PUMP_DIR','sample_copied.dmp'); - ``` - -## Importing data with Oracle Data Pump and a database link - -The following import process uses Oracle Data Pump and the Oracle [DBMS\_FILE\_TRANSFER](https://docs.oracle.com/en/database/oracle/oracle-database/19/arpls/DBMS_FILE_TRANSFER.html) package\. The steps are as follows: - -1. Connect to a source Oracle database, which can be an on\-premises database, Amazon EC2 instance, or an RDS for Oracle DB instance\. - -1. Export data using the [DBMS\_DATAPUMP](https://docs.oracle.com/en/database/oracle/oracle-database/19/arpls/DBMS_DATAPUMP.html) package\. - -1. Use `DBMS_FILE_TRANSFER.PUT_FILE` to copy the dump file from the Oracle database to the `DATA_PUMP_DIR` directory on the target RDS for Oracle DB instance that is connected using a database link\. - -1. Import the data from the copied dump file into the RDS for Oracle DB instance using the ` DBMS_DATAPUMP` package\. - -The import process using Oracle Data Pump and the `DBMS_FILE_TRANSFER` package has the following steps\. - -**Topics** -+ [Requirements for importing data with Oracle Data Pump and a database link](#Oracle.Procedural.Importing.DataPumpDBLink.requirements) -+ [Step 1: Grant privileges to the user on the RDS for Oracle target DB instance](#Oracle.Procedural.Importing.DataPumpDBLink.Step1) -+ [Step 2: Grant privileges to the user on the source database](#Oracle.Procedural.Importing.DataPumpDBLink.Step2) -+ [Step 3: Create a dump file using DBMS\_DATAPUMP](#Oracle.Procedural.Importing.DataPumpDBLink.Step3) -+ [Step 4: Create a database link to the target DB instance](#Oracle.Procedural.Importing.DataPumpDBLink.Step4) -+ [Step 5: Copy the exported dump file to the target DB instance using DBMS\_FILE\_TRANSFER](#Oracle.Procedural.Importing.DataPumpDBLink.Step5) -+ [Step 6: Import the data file to the target DB instance using DBMS\_DATAPUMP](#Oracle.Procedural.Importing.DataPumpDBLink.Step6) -+ [Step 7: Clean up](#Oracle.Procedural.Importing.DataPumpDBLink.Step7) - -### Requirements for importing data with Oracle Data Pump and a database link - -The process has the following requirements: -+ You must have execute privileges on the `DBMS_FILE_TRANSFER` and `DBMS_DATAPUMP` packages\. -+ You must have write privileges to the `DATA_PUMP_DIR` directory on the source DB instance\. -+ You must ensure that you have enough storage space to store the dump file on the source instance and the target DB instance\. - -**Note** -This process imports a dump file into the `DATA_PUMP_DIR` directory, a preconfigured directory on all Oracle DB instances\. This directory is located on the same storage volume as your data files\. When you import the dump file, the existing Oracle data files use more space\. Thus, you should make sure that your DB instance can accommodate that additional use of space\. The imported dump file is not automatically deleted or purged from the `DATA_PUMP_DIR` directory\. To remove the imported dump file, use [UTL\_FILE\.FREMOVE](https://docs.oracle.com/en/database/oracle/oracle-database/19/arpls/UTL_FILE.html#GUID-09B09C2A-2C21-4F70-BF04-D0EEA7B59CAF), found on the Oracle website\. - -### Step 1: Grant privileges to the user on the RDS for Oracle target DB instance - -To grant privileges to the user on the RDS for Oracle target DB instance, take the following steps: - -1. Use SQL Plus or Oracle SQL Developer to connect to the RDS for Oracle DB instance into which you intend to import the data\. Connect as the Amazon RDS master user\. For information about connecting to the DB instance, see [Connecting to your RDS for Oracle DB instance](USER_ConnectToOracleInstance.md)\. - -1. Create the required tablespaces before you import the data\. For more information, see [Creating and sizing tablespaces](Appendix.Oracle.CommonDBATasks.Database.md#Appendix.Oracle.CommonDBATasks.CreatingTablespacesAndDatafiles)\. - -1. If the user account into which the data is imported doesn't exist, create the user account and grant the necessary permissions and roles\. If you plan to import data into multiple user schemas, create each user account and grant the necessary privileges and roles to it\. - - For example, the following commands create a new user named *schema\_1* and grant the necessary permissions and roles to import the data into the schema for this user\. - - ``` - CREATE USER schema_1 IDENTIFIED BY my-password; - GRANT CREATE SESSION, RESOURCE TO schema_1; - ALTER USER schema_1 QUOTA 100M ON users; - ``` - - The preceding example grants the new user the `CREATE SESSION` privilege and the `RESOURCE` role\. Additional privileges and roles might be required depending on the database objects that you import\. -**Note** -Replace `schema_1` with the name of your schema in this step and in the following steps\. - -### Step 2: Grant privileges to the user on the source database - -Use SQL\*Plus or Oracle SQL Developer to connect to the RDS for Oracle DB instance that contains the data to be imported\. If necessary, create a user account and grant the necessary permissions\. - -**Note** -If the source database is an Amazon RDS instance, you can skip this step\. You use your Amazon RDS master user account to perform the export\. - -The following commands create a new user and grant the necessary permissions\. - -``` -CREATE USER export_user IDENTIFIED BY my-password; -GRANT CREATE SESSION, CREATE TABLE, CREATE DATABASE LINK TO export_user; -ALTER USER export_user QUOTA 100M ON users; -GRANT READ, WRITE ON DIRECTORY data_pump_dir TO export_user; -GRANT SELECT_CATALOG_ROLE TO export_user; -GRANT EXECUTE ON DBMS_DATAPUMP TO export_user; -GRANT EXECUTE ON DBMS_FILE_TRANSFER TO export_user; -``` - -### Step 3: Create a dump file using DBMS\_DATAPUMP - -To create a dump file, do the following: - -1. Use SQL\*Plus or Oracle SQL Developer to connect to the source Oracle instance with an administrative user or with the user you created in step 2\. If the source database is an Amazon RDS for Oracle DB instance, connect with the Amazon RDS master user\. - -1. Create a dump file using the Oracle Data Pump utility\. - - The following script creates a dump file named *sample\.dmp* in the `DATA_PUMP_DIR` directory\. - - ``` - DECLARE - v_hdnl NUMBER; - BEGIN - v_hdnl := DBMS_DATAPUMP.OPEN( - operation => 'EXPORT' , - job_mode => 'SCHEMA' , - job_name => null - ); - DBMS_DATAPUMP.ADD_FILE( - handle => v_hdnl, - filename => 'sample.dmp' , - directory => 'DATA_PUMP_DIR' , - filetype => dbms_datapump.ku$_file_type_dump_file - ); - DBMS_DATAPUMP.ADD_FILE( - handle => v_hdnl , - filename => 'sample_exp.log' , - directory => 'DATA_PUMP_DIR' , - filetype => dbms_datapump.ku$_file_type_log_file - ); - DBMS_DATAPUMP.METADATA_FILTER( - v_hdnl , - 'SCHEMA_EXPR' , - 'IN (''SCHEMA_1'')' - ); - DBMS_DATAPUMP.METADATA_FILTER( - v_hdnl, - 'EXCLUDE_NAME_EXPR', - q'[IN (SELECT NAME FROM sys.OBJ$ - WHERE TYPE# IN (66,67,74,79,59,62,46) - AND OWNER# IN - (SELECT USER# FROM SYS.USER$ - WHERE NAME IN ('RDSADMIN','SYS','SYSTEM','RDS_DATAGUARD','RDSSEC') - ) - ) - ]', - 'PROCOBJ' - ); - DBMS_DATAPUMP.START_JOB(v_hdnl); - END; - / - ``` -**Note** -Data Pump jobs are started asynchronously\. For information about monitoring a Data Pump job, see [ Monitoring job status](https://docs.oracle.com/en/database/oracle/oracle-database/19/sutil/oracle-data-pump-overview.html#GUID-E365D74E-12CD-495C-BA23-5A55F679C7E7) in the Oracle documentation\. You can view the contents of the export log by using the `rdsadmin.rds_file_util.read_text_file` procedure\. For more information, see [Reading files in a DB instance directory](Appendix.Oracle.CommonDBATasks.Misc.md#Appendix.Oracle.CommonDBATasks.ReadingFiles)\. - -### Step 4: Create a database link to the target DB instance - -Create a database link between your source DB instance and your target DB instance\. Your local Oracle instance must have network connectivity to the DB instance in order to create a database link and to transfer your export dump file\. - -Perform this step connected with the same user account as the previous step\. - -If you are creating a database link between two DB instances inside the same VPC or peered VPCs, the two DB instances should have a valid route between them\. The security group of each DB instance must allow ingress to and egress from the other DB instance\. The security group inbound and outbound rules can refer to security groups from the same VPC or a peered VPC\. For more information, see [Adjusting database links for use with DB instances in a VPC](Appendix.Oracle.CommonDBATasks.Database.md#Appendix.Oracle.CommonDBATasks.DBLinks)\. - -The following command creates a database link named `to_rds` that connects to the Amazon RDS master user at the target DB instance\. - -``` -CREATE DATABASE LINK to_rds - CONNECT TO IDENTIFIED BY - USING '(DESCRIPTION=(ADDRESS=(PROTOCOL=TCP)(HOST=) - (PORT=))(CONNECT_DATA=(SID=)))'; -``` - -### Step 5: Copy the exported dump file to the target DB instance using DBMS\_FILE\_TRANSFER - -Use `DBMS_FILE_TRANSFER` to copy the dump file from the source database instance to the target DB instance\. The following script copies a dump file named sample\.dmp from the source instance to a target database link named *to\_rds* \(created in the previous step\)\. - -``` -BEGIN - DBMS_FILE_TRANSFER.PUT_FILE( - source_directory_object => 'DATA_PUMP_DIR', - source_file_name => 'sample.dmp', - destination_directory_object => 'DATA_PUMP_DIR', - destination_file_name => 'sample_copied.dmp', - destination_database => 'to_rds' ); -END; -/ -``` - -### Step 6: Import the data file to the target DB instance using DBMS\_DATAPUMP - -Use Oracle Data Pump to import the schema in the DB instance\. Additional options such as METADATA\_REMAP might be required\. - - Connect to the DB instance with the Amazon RDS master user account to perform the import\. - -``` -DECLARE - v_hdnl NUMBER; -BEGIN - v_hdnl := DBMS_DATAPUMP.OPEN( - operation => 'IMPORT', - job_mode => 'SCHEMA', - job_name => null); - DBMS_DATAPUMP.ADD_FILE( - handle => v_hdnl, - filename => 'sample_copied.dmp', - directory => 'DATA_PUMP_DIR', - filetype => dbms_datapump.ku$_file_type_dump_file ); - DBMS_DATAPUMP.ADD_FILE( - handle => v_hdnl, - filename => 'sample_imp.log', - directory => 'DATA_PUMP_DIR', - filetype => dbms_datapump.ku$_file_type_log_file); - DBMS_DATAPUMP.METADATA_FILTER(v_hdnl,'SCHEMA_EXPR','IN (''SCHEMA_1'')'); - DBMS_DATAPUMP.START_JOB(v_hdnl); -END; -/ -``` - -**Note** -Data Pump jobs are started asynchronously\. For information about monitoring a Data Pump job, see [ Monitoring job status](https://docs.oracle.com/en/database/oracle/oracle-database/19/sutil/oracle-data-pump-overview.html#GUID-E365D74E-12CD-495C-BA23-5A55F679C7E7) in the Oracle documentation\. You can view the contents of the import log by using the `rdsadmin.rds_file_util.read_text_file` procedure\. For more information, see [Reading files in a DB instance directory](Appendix.Oracle.CommonDBATasks.Misc.md#Appendix.Oracle.CommonDBATasks.ReadingFiles)\. - -You can verify the data import by viewing the user's tables on the DB instance\. For example, the following query returns the number of tables for `schema_1`\. - -``` -SELECT COUNT(*) FROM DBA_TABLES WHERE OWNER='SCHEMA_1'; -``` - -### Step 7: Clean up - -After the data has been imported, you can delete the files that you don't want to keep\. You can list the files in `DATA_PUMP_DIR` using the following command\. - -``` -SELECT * FROM TABLE(rdsadmin.rds_file_util.listdir('DATA_PUMP_DIR')) ORDER BY MTIME; -``` - -To delete files in `DATA_PUMP_DIR` that you no longer require, use the following command\. - -``` -EXEC UTL_FILE.FREMOVE('DATA_PUMP_DIR',''); -``` - -For example, the following command deletes the file named `"sample_copied.dmp"`\. - -``` -EXEC UTL_FILE.FREMOVE('DATA_PUMP_DIR','sample_copied.dmp'); -``` \ No newline at end of file diff --git a/doc_source/Oracle.Procedural.Importing.ExportImport.md b/doc_source/Oracle.Procedural.Importing.ExportImport.md deleted file mode 100644 index 6030002..0000000 --- a/doc_source/Oracle.Procedural.Importing.ExportImport.md +++ /dev/null @@ -1,32 +0,0 @@ -# Importing using Oracle Export/Import - -You might consider Oracle Export/Import utilities for migrations in the following conditions: -+ Your data size is small\. -+ Data types such as binary float and double aren't required\. - -The import process creates the necessary schema objects\. Thus, you don't need to run a script to create the objects beforehand\. - -The easiest way to install the Oracle the export and import utilities is to install the Oracle Instant Client\. To download the software, go to [https://www\.oracle\.com/database/technologies/instant\-client\.html](https://www.oracle.com/database/technologies/instant-client.html)\. For documentation, see [Instant Client for SQL\*Loader, Export, and Import](https://docs.oracle.com/en/database/oracle/oracle-database/21/sutil/instant-client-sql-loader-export-import.html#GUID-FF1B6F75-09F5-4911-9317-9776FAD15965) in the *Oracle Database Utilities* manual\. - -**To export tables and then import them** - -1. Export the tables from the source database using the `exp` command\. - - The following command exports the tables named `tab1`, `tab2`, and `tab3`\. The dump file is `exp_file.dmp`\. - - ``` - exp cust_dba@ORCL FILE=exp_file.dmp TABLES=(tab1,tab2,tab3) LOG=exp_file.log - ``` - - The export creates a binary dump file that contains both the schema and data for the specified tables\. - -1. Import the schema and data into a target database using the `imp` command\. - - The following command imports the tables `tab1`, `tab2`, and `tab3` from dump file `exp_file.dmp`\. - - ``` - imp cust_dba@targetdb FROMUSER=cust_schema TOUSER=cust_schema \ - TABLES=(tab1,tab2,tab3) FILE=exp_file.dmp LOG=imp_file.log - ``` - -Export and Import have other variations that might be better suited to your requirements\. See the Oracle Database documentation for full details\. \ No newline at end of file diff --git a/doc_source/Oracle.Procedural.Importing.Materialized.md b/doc_source/Oracle.Procedural.Importing.Materialized.md deleted file mode 100644 index 1236be6..0000000 --- a/doc_source/Oracle.Procedural.Importing.Materialized.md +++ /dev/null @@ -1,74 +0,0 @@ -# Migrating with Oracle materialized views - -To migrate large datasets efficiently, you can use Oracle materialized view replication\. With replication, you can keep the target tables synchronized with the source tables\. Thus, you can switch over to Amazon RDS later, if needed\. - -Before you can migrate using materialized views, make sure that you meet the following requirements: -+ Configure access from the target database to the source database\. In the following example, access rules were enabled on the source database to allow the RDS for Oracle target database to connect to the source over SQL\*Net\. -+ Create a database link from the RDS for Oracle DB instance to the source database\. - -**To migrate data using materialized views** - -1. Create a user account on both source and RDS for Oracle target instances that can authenticate with the same password\. The following example creates a user named `dblink_user`\. - - ``` - CREATE USER dblink_user IDENTIFIED BY my-password - DEFAULT TABLESPACE users - TEMPORARY TABLESPACE temp; - - GRANT CREATE SESSION TO dblink_user; - - GRANT SELECT ANY TABLE TO dblink_user; - - GRANT SELECT ANY DICTIONARY TO dblink_user; - ``` - -1. Create a database link from the RDS for Oracle target instance to the source instance using your newly created user\. - - ``` - CREATE DATABASE LINK remote_site - CONNECT TO dblink_user IDENTIFIED BY my-password - USING '(description=(address=(protocol=tcp) (host=my-host) - (port=my-listener-port)) (connect_data=(sid=my-source-db-sid)))'; - ``` - -1. Test the link: - - ``` - SELECT * FROM V$INSTANCE@remote_site; - ``` - -1. Create a sample table with primary key and materialized view log on the source instance\. - - ``` - CREATE TABLE customer_0 TABLESPACE users - AS (SELECT ROWNUM id, o.* - FROM ALL_OBJECTS o, ALL_OBJECTS x - WHERE ROWNUM <= 1000000); - - ALTER TABLE customer_0 ADD CONSTRAINT pk_customer_0 PRIMARY KEY (id) USING INDEX; - - CREATE MATERIALIZED VIEW LOG ON customer_0; - ``` - -1. On the target RDS for Oracle DB instance, create a materialized view\. - - ``` - CREATE MATERIALIZED VIEW customer_0 - BUILD IMMEDIATE REFRESH FAST - AS (SELECT * - FROM cust_dba.customer_0@remote_site); - ``` - -1. On the target RDS for Oracle DB instance, refresh the materialized view\. - - ``` - EXEC DBMS_MV.REFRESH('CUSTOMER_0', 'f'); - ``` - -1. Drop the materialized view and include the `PRESERVE TABLE` clause to retain the materialized view container table and its contents\. - - ``` - DROP MATERIALIZED VIEW customer_0 PRESERVE TABLE; - ``` - - The retained table has the same name as the dropped materialized view\. \ No newline at end of file diff --git a/doc_source/Oracle.Procedural.Importing.SQLDeveloper.md b/doc_source/Oracle.Procedural.Importing.SQLDeveloper.md deleted file mode 100644 index ce2035c..0000000 --- a/doc_source/Oracle.Procedural.Importing.SQLDeveloper.md +++ /dev/null @@ -1,9 +0,0 @@ -# Importing using Oracle SQL Developer - -For small databases, you can use Oracle SQL Developer, a graphical Java tool distributed without cost by Oracle\. You can install this tool on your desktop computer \(Windows, Linux, or Mac\) or on one of your servers\. SQL Developer provides options for migrating data between two Oracle databases, or for migrating data from other databases, such as MySQL, to an Oracle database\. SQL Developer is best suited for migrating small databases\. We recommend that you read the Oracle SQL Developer product documentation before you begin migrating your data\. - -After you install SQL Developer, you can use it to connect to your source and target databases\. Use the **Database Copy** command on the Tools menu to copy your data to your Amazon RDS instance\. - -To download SQL Developer, go to [http://www\.oracle\.com/technetwork/developer\-tools/sql\-developer](http://www.oracle.com/technetwork/developer-tools/sql-developer)\. - -Oracle also has documentation on how to migrate from other databases, including MySQL and SQL Server\. For more information, see [http://www\.oracle\.com/technetwork/database/migration](http://www.oracle.com/technetwork/database/migration) in the Oracle documentation\. \ No newline at end of file diff --git a/doc_source/Oracle.Procedural.Importing.SQLLoader.md b/doc_source/Oracle.Procedural.Importing.SQLLoader.md deleted file mode 100644 index 32d4f82..0000000 --- a/doc_source/Oracle.Procedural.Importing.SQLLoader.md +++ /dev/null @@ -1,66 +0,0 @@ -# Importing using Oracle SQL\*Loader - -You might consider Oracle SQL\*Loader for large databases that contain a limited number of objects\. Because the process of exporting from a source database and loading to a target database is specific to the schema, the following example creates the sample schema objects, exports from a source, and then loads the data into a target database\. - -The easiest way to install Oracle SQL\*Loader is to install the Oracle Instant Client\. To download the software, go to [https://www\.oracle\.com/database/technologies/instant\-client\.html](https://www.oracle.com/database/technologies/instant-client.html)\. For documentation, see [Instant Client for SQL\*Loader, Export, and Import](https://docs.oracle.com/en/database/oracle/oracle-database/21/sutil/instant-client-sql-loader-export-import.html#GUID-FF1B6F75-09F5-4911-9317-9776FAD15965) in the *Oracle Database Utilities* manual\. - -**To import data using Oracle SQL\*Loader** - -1. Create a sample source table using the following SQL statement\. - - ``` - CREATE TABLE customer_0 TABLESPACE users - AS (SELECT ROWNUM id, o.* - FROM ALL_OBJECTS o, ALL_OBJECTS x - WHERE ROWNUM <= 1000000); - ``` - -1. On the target RDS for Oracle DB instance, create a destination table for loading the data\. The clause `WHERE 1=2` ensures that you copy the structure of `ALL_OBJECTS`, but don't copy any rows\. - - ``` - CREATE TABLE customer_1 TABLESPACE users - AS (SELECT 0 AS ID, OWNER, OBJECT_NAME, CREATED - FROM ALL_OBJECTS - WHERE 1=2); - ``` - -1. Export the data from the source database to a text file\. The following example uses SQL\*Plus\. For your data, you will likely need to generate a script that does the export for all the objects in the database\. - - ``` - ALTER SESSION SET NLS_DATE_FORMAT = 'YYYY/MM/DD HH24:MI:SS' - - SET LINESIZE 800 HEADING OFF FEEDBACK OFF ARRAY 5000 PAGESIZE 0 - SPOOL customer_0.out - SET MARKUP HTML PREFORMAT ON - SET COLSEP ',' - - SELECT id, owner, object_name, created - FROM customer_0; - - SPOOL OFF - ``` - -1. Create a control file to describe the data\. You might need to write a script to perform this step\. - - ``` - cat << EOF > sqlldr_1.ctl - load data - infile customer_0.out - into table customer_1 - APPEND - fields terminated by "," optionally enclosed by '"' - ( - id POSITION(01:10) INTEGER EXTERNAL, - owner POSITION(12:41) CHAR, - object_name POSITION(43:72) CHAR, - created POSITION(74:92) date "YYYY/MM/DD HH24:MI:SS" - ) - ``` - - If needed, copy the files generated by the preceding code to a staging area, such as an Amazon EC2 instance\. - -1. Import the data using SQL\*Loader with the appropriate user name and password for the target database\. - - ``` - sqlldr cust_dba@targetdb CONTROL=sqlldr_1.ctl BINDSIZE=10485760 READSIZE=10485760 ROWS=1000 - ``` \ No newline at end of file diff --git a/doc_source/Oracle.Procedural.Importing.md b/doc_source/Oracle.Procedural.Importing.md deleted file mode 100644 index 37efb67..0000000 --- a/doc_source/Oracle.Procedural.Importing.md +++ /dev/null @@ -1,23 +0,0 @@ -# Importing data into Oracle on Amazon RDS - -How you import data into an Amazon RDS for Oracle DB instance depends on the following: -+ The amount of data you have -+ The number of database objects in your database -+ The variety of database objects in your database - -For example, you can use the following tools, depending on your requirements: -+ Oracle SQL Developer – Import a simple, 20 MB database\. -+ Oracle Data Pump – Import complex databases, or databases that are several hundred megabytes or several terabytes in size\. You can use Amazon S3 in this task\. For example, download Data Pump files from Amazon S3 to the DB instance\. For more information, see [Amazon S3 integration](oracle-s3-integration.md)\. -+ AWS Database Migration Service \(AWS DMS\) – Migrate databases without downtime\. For more information about AWS DMS, see [ What is AWS Database Migration Service](https://docs.aws.amazon.com/dms/latest/userguide/Welcome.html) and the blog post [Migrating Oracle databases with near\-zero downtime using AWS DMS](http://aws.amazon.com/blogs/database/migrating-oracle-databases-with-near-zero-downtime-using-aws-dms/)\. - -**Important** -Before you use the preceding migration techniques, we recommend that you back up your database\. After you import the data, you can back up your RDS for Oracle DB instances by creating snapshots\. Later, you can restore the snapshots\. For more information, see [Backing up and restoring](CHAP_CommonTasks.BackupRestore.md)\. - -For many database engines, ongoing replication can continue until you are ready to switch over to the target database\. You can use AWS DMS to migrate to RDS for Oracle from either the same database engine or a different engine\. If you migrate from a different database engine, you can use the AWS Schema Conversion Tool to migrate schema objects that AWS DMS doesn't migrate\. - -**Topics** -+ [Importing using Oracle SQL Developer](Oracle.Procedural.Importing.SQLDeveloper.md) -+ [Importing using Oracle Data Pump](Oracle.Procedural.Importing.DataPump.md) -+ [Importing using Oracle Export/Import](Oracle.Procedural.Importing.ExportImport.md) -+ [Importing using Oracle SQL\*Loader](Oracle.Procedural.Importing.SQLLoader.md) -+ [Migrating with Oracle materialized views](Oracle.Procedural.Importing.Materialized.md) \ No newline at end of file diff --git a/doc_source/Oracle.Resources.RCU.md b/doc_source/Oracle.Resources.RCU.md deleted file mode 100644 index df7a239..0000000 --- a/doc_source/Oracle.Resources.RCU.md +++ /dev/null @@ -1,227 +0,0 @@ -# Using the Oracle Repository Creation Utility on RDS for Oracle - -You can use Amazon RDS to host an RDS for Oracle DB instance that holds the schemas to support your Oracle Fusion Middleware components\. Before you can use Fusion Middleware components, create and populate schemas for them in your database\. You create and populate the schemas by using the Oracle Repository Creation Utility \(RCU\)\. - -## Supported versions and licensing options for RCU - -Amazon RDS supports Oracle Repository Creation Utility \(RCU\) version 12c only\. You can use the RCU in the following configurations: -+ RCU 12c with Oracle Database 21c -+ RCU 12c with Oracle Database 19c -+ RCU 12c with Oracle Database 12c Release 2 \(12\.2\) -+ RCU 12c with Oracle Database 12c Release 1 \(12\.1\) using 12\.1\.0\.2\.v4 or higher - -Before you can use RCU, make sure that you do the following: -+ Obtain a license for Oracle Fusion Middleware\. -+ Follow the Oracle licensing guidelines for the Oracle database that hosts the repository\. For more information, see [ Oracle Fusion Middleware Licensing Information User Manual](https://docs.oracle.com/en/middleware/fusion-middleware/fmwlc/) in the Oracle documentation\. - -Fusion MiddleWare supports repositories on Oracle Database Enterprise Edition and Standard Edition Two\. Oracle recommends Enterprise Edition for production installations that require partitioning and installations that require online index rebuild\. - -Before you create your RDS for Oracle instance, confirm the Oracle database version that you need to support the components that you want to deploy\. To find the requirements for the Fusion Middleware components and versions you want to deploy, use the Certification Matrix\. For more information, see [Oracle Fusion Middleware Supported System Configurations](http://www.oracle.com/technetwork/middleware/ias/downloads/fusion-certification-100350.html) in the Oracle documentation\. - -Amazon RDS supports Oracle database version upgrades as needed\. For more information, see [Upgrading a DB instance engine version](USER_UpgradeDBInstance.Upgrading.md)\. - -## Requirements and limitations for RCU - -To use RCU, you need an Amazon VPC\. Your Amazon RDS DB instance must be available only to your Fusion Middleware components, and not to the public Internet\. Thus, host your Amazon RDS DB instance in a private subnet, which provides greater security\. For information about how to create an Amazon VPC for use with an RDS for Oracle instance, see [Creating a VPC for use with an Oracle database](Oracle.Resources.Shared.md#Oracle.Resources.Shared.VPC)\. - -You also need an RDS for Oracle DB instance\. For information about how to create an RDS for Oracle DB instance for use with Fusion Middleware metadata, see [Creating an Oracle DB instance](Oracle.Resources.Shared.md#Oracle.Resources.Shared.Database.RDS)\. - -You can store the schemas for any Fusion Middleware components in your Amazon RDS DB instance\. The following schemas have been verified to install correctly: -+ Analytics \(ACTIVITIES\) -+ Audit Services \(IAU\) -+ Audit Services Append \(IAU\_APPEND\) -+ Audit Services Viewer \(IAU\_VIEWER\) -+ Discussions \(DISCUSSIONS\) -+ Metadata Services \(MDS\) -+ Oracle Business Intelligence \(BIPLATFORM\) -+ Oracle Platform Security Services \(OPSS\) -+ Portal and Services \(WEBCENTER\) -+ Portlet Producers \(PORTLET\) -+ Service Table \(STB\) -+ SOA Infrastructure \(SOAINFRA\) -+ User Messaging Service \(UCSUMS\) -+ WebLogic Services \(WLS\) - -## Guidelines for using RCU - -The following are some recommendations for working with your DB instance in this scenario: -+ We recommend that you use Multi\-AZ for production workloads\. For more information about working with multiple Availability Zones, see [Regions, Availability Zones, and Local Zones](Concepts.RegionsAndAvailabilityZones.md)\. -+ For additional security, Oracle recommends that you use Transparent Data Encryption \(TDE\) to encrypt your data at rest\. If you have an Enterprise Edition license that includes the Advanced Security Option, you can enable encryption at rest by using the TDE option\. For more information, see [Oracle Transparent Data Encryption](Appendix.Oracle.Options.AdvSecurity.md)\. - - Amazon RDS also provides an encryption at rest option for all database editions\. For more information, see [Encrypting Amazon RDS resources](Overview.Encryption.md)\. -+ Configure your VPC Security Groups to allow communication between your application servers and your Amazon RDS DB instance\. The application servers that host the Fusion Middleware components can be on Amazon EC2 or on\-premises\. - -## Running RCU - -To create and populate the schemas to support your Fusion Middleware components, use the Oracle Repository Creation Utility \(RCU\)\. You can run RCU in different ways\. - -**Topics** -+ [Running RCU using the command line in one step](#Oracle.Resources.RCU.SilentSingle) -+ [Running RCU using the command line in multiple steps](#Oracle.Resources.RCU.SilentMulti) -+ [Running RCU in interactive mode](#Oracle.Resources.RCU.Interactive) - -### Running RCU using the command line in one step - -If you don't need to edit any of your schemas before populating them, you can run RCU in a single step\. Otherwise, see the following section for running RCU in multiple steps\. - -You can run the RCU in silent mode by using the command\-line parameter `-silent`\. When you run RCU in silent mode, you can avoid typing passwords on the command line by creating a text file containing the passwords\. Create a text file with the password for `dbUser` on the first line, and the password for each component on subsequent lines\. You specify the name of the password file as the last parameter to the RCU command\. - -**Example** -The following example creates and populates schemas for the SOA Infrastructure component \(and its dependencies\) in a single step\. -For Linux, macOS, or Unix: - -``` -export ORACLE_HOME=/u01/app/oracle/product/12.2.1.0/fmw -export JAVA_HOME=/usr/java/jdk1.8.0_65 -${ORACLE_HOME}/oracle_common/bin/rcu \ --silent \ --createRepository \ --connectString ${dbhost}:${dbport}:${dbname} \ --dbUser ${dbuser} \ --dbRole Normal \ --honorOMF \ --schemaPrefix ${SCHEMA_PREFIX} \ --component MDS \ --component STB \ --component OPSS \ --component IAU \ --component IAU_APPEND \ --component IAU_VIEWER \ --component UCSUMS \ --component WLS \ --component SOAINFRA \ --f < /tmp/passwordfile.txt -``` - -For more information, see [ Running Repository Creation Utility from the command line](https://docs.oracle.com/middleware/1221/core/RCUUG/GUID-0D3A2959-7CC8-4001-997E-718ADF04C5F2.htm#RCUUG248) in the Oracle documentation\. - -### Running RCU using the command line in multiple steps - -To manually edit your schema scripts, run RCU in multiple steps: - -1. Run RCU in **Prepare Scripts for System Load** mode by using the `-generateScript` command\-line parameter to create the scripts for your schemas\. - -1. Manually edit and run the generated script `script_systemLoad.sql`\. - -1. Run RCU again in **Perform Product Load** mode by using the `-dataLoad` command\-line parameter to populate the schemas\. - -1. Run the generated cleanup script `script_postDataLoad.sql`\. - -To run RCU in silent mode, specify the command\-line parameter `-silent`\. When you run RCU in silent mode, you can avoid typing passwords on the command line by creating a text file containing the passwords\. Create a text file with the password for `dbUser` on the first line, and the password for each component on subsequent lines\. Specify the name of the password file as the last parameter to the RCU command\. - -**Example** -The following example creates schema scripts for the SOA Infrastructure component and its dependencies\. -For Linux, macOS, or Unix: - -``` -export ORACLE_HOME=/u01/app/oracle/product/12.2.1.0/fmw -export JAVA_HOME=/usr/java/jdk1.8.0_65 -${ORACLE_HOME}/oracle_common/bin/rcu \ --silent \ --generateScript \ --connectString ${dbhost}:${dbport}:${dbname} \ --dbUser ${dbuser} \ --dbRole Normal \ --honorOMF \ -[-encryptTablespace true] \ --schemaPrefix ${SCHEMA_PREFIX} \ --component MDS \ --component STB \ --component OPSS \ --component IAU \ --component IAU_APPEND \ --component IAU_VIEWER \ --component UCSUMS \ --component WLS \ --component SOAINFRA \ --scriptLocation /tmp/rcuscripts \ --f < /tmp/passwordfile.txt -``` -Now you can edit the generated script, connect to your Oracle DB instance, and run the script\. The generated script is named `script_systemLoad.sql`\. For information about connecting to your Oracle DB instance, see [Step 3: Connect your SQL client to an Oracle DB instance](CHAP_GettingStarted.CreatingConnecting.Oracle.md#CHAP_GettingStarted.Connecting.Oracle)\. -The following example populates the schemas for the SOA Infrastructure component \(and its dependencies\)\. -For Linux, macOS, or Unix: - -``` -export JAVA_HOME=/usr/java/jdk1.8.0_65 -${ORACLE_HOME}/oracle_common/bin/rcu \ --silent \ --dataLoad \ --connectString ${dbhost}:${dbport}:${dbname} \ --dbUser ${dbuser} \ --dbRole Normal \ --honorOMF \ --schemaPrefix ${SCHEMA_PREFIX} \ --component MDS \ --component STB \ --component OPSS \ --component IAU \ --component IAU_APPEND \ --component IAU_VIEWER \ --component UCSUMS \ --component WLS \ --component SOAINFRA \ --f < /tmp/passwordfile.txt -``` -To finish, you connect to your Oracle DB instance, and run the clean\-up script\. The script is named `script_postDataLoad.sql`\. - -For more information, see [ Running Repository Creation Utility from the command line](https://docs.oracle.com/middleware/1221/core/RCUUG/GUID-0D3A2959-7CC8-4001-997E-718ADF04C5F2.htm#RCUUG248) in the Oracle documentation\. - -### Running RCU in interactive mode - -To use the RCU graphical user interface, run RCU in interactive mode\. Include the `-interactive` parameter and omit the `-silent` parameter\. For more information, see [ Understanding Repository Creation Utility screens](https://docs.oracle.com/middleware/1213/core/RCUUG/rcu_screens.htm#RCUUG143) in the Oracle documentation\. - -**Example** -The following example starts RCU in interactive mode and pre\-populates the connection information\. -For Linux, macOS, or Unix: - -``` -export ORACLE_HOME=/u01/app/oracle/product/12.2.1.0/fmw -export JAVA_HOME=/usr/java/jdk1.8.0_65 -${ORACLE_HOME}/oracle_common/bin/rcu \ --interactive \ --createRepository \ --connectString ${dbhost}:${dbport}:${dbname} \ --dbUser ${dbuser} \ --dbRole Normal -``` - -## Troubleshooting RCU - -Be mindful of the following issues\. - -**Topics** -+ [Oracle Managed Files \(OMF\)](#Oracle.Resources.RCU.KnownIssues.OMF) -+ [Object privileges](#Oracle.Resources.RCU.KnownIssues.object-privs) -+ [Enterprise Scheduler Service](#Oracle.Resources.RCU.KnownIssues.Scheduler) - -### Oracle Managed Files \(OMF\) - -Amazon RDS uses OMF data files to simplify storage management\. You can customize tablespace attributes, such as size and extent management\. However, if you specify a data file name when you run RCU, the tablespace code fails with `ORA-20900`\. You can use RCU with OMF in the following ways: -+ In RCU 12\.2\.1\.0 and later, use the `-honorOMF` command\-line parameter\. -+ In RCU 12\.1\.0\.3 and later, use multiple steps and edit the generated script\. For more information, see [Running RCU using the command line in multiple steps](#Oracle.Resources.RCU.SilentMulti)\. - -### Object privileges - -Because Amazon RDS is a managed service, you don't have full `SYSDBA` access to your RDS for Oracle DB instance\. However, RCU 12c supports users with lower privileges\. In most cases, the master user privilege is sufficient to create repositories\. - -The master account can directly grant privileges that it has already been granted `WITH GRANT OPTION`\. In some cases, when you attempt to grant `SYS` object privileges, the RCU might fail with `ORA-01031`\. You can retry and run the `rdsadmin_util.grant_sys_object` stored procedure, as shown in the following example: - -``` -BEGIN - rdsadmin.rdsadmin_util.grant_sys_object('GV_$SESSION','MY_DBA','SELECT'); -END; -/ -``` - -If you attempt to grant `SYS` privileges on the object `SCHEMA_VERSION_REGISTRY`, the operation might fail with `ORA-20199: Error in rdsadmin_util.grant_sys_object`\. You can qualify the table `SCHEMA_VERSION_REGISTRY$` and the view `SCHEMA_VERSION_REGISTRY` with the schema owner name, which is `SYSTEM`, and retry the operation\. Or, you can create a synonym\. Log in as the master user and run the following statements: - -``` -CREATE OR REPLACE VIEW SYSTEM.SCHEMA_VERSION_REGISTRY - AS SELECT * FROM SYSTEM.SCHEMA_VERSION_REGISTRY$; -CREATE OR REPLACE PUBLIC SYNONYM SCHEMA_VERSION_REGISTRY FOR SYSTEM.SCHEMA_VERSION_REGISTRY; -CREATE OR REPLACE PUBLIC SYNONYM SCHEMA_VERSION_REGISTRY$ FOR SCHEMA_VERSION_REGISTRY; -``` - -### Enterprise Scheduler Service - -When you use the RCU to drop an Enterprise Scheduler Service repository, the RCU might fail with `Error: Component drop check failed`\. \ No newline at end of file diff --git a/doc_source/Oracle.Resources.Shared.md b/doc_source/Oracle.Resources.Shared.md deleted file mode 100644 index e3d14b6..0000000 --- a/doc_source/Oracle.Resources.Shared.md +++ /dev/null @@ -1,123 +0,0 @@ -# Setting up Amazon RDS to host tools and third\-party software for Oracle - -You can use Amazon RDS to host an Oracle DB instance that supports software and components such as the following: -+ Siebel Customer Relationship Management \(CRM\) -+ Oracle Fusion Middleware Metadata — installed by the Repository Creation Utility \(RCU\) - -The following procedures help you create an Oracle DB instance on Amazon RDS that you can use to host additional software and components for Oracle\. - -**Topics** -+ [Creating a VPC for use with an Oracle database](#Oracle.Resources.Shared.VPC) -+ [Creating an Oracle DB instance](#Oracle.Resources.Shared.Database.RDS) -+ [Additional Amazon RDS interfaces](#Oracle.Resources.Shared.CLIAPI) - -## Creating a VPC for use with an Oracle database - -In the following procedure, you create a virtual private cloud \(VPC\) based on the Amazon VPC service, a private subnet, and a security group\. Your Amazon RDS DB instance needs to be available only to your middle\-tier components, and not to the public internet\. Thus, your Amazon RDS DB instance is hosted in a private subnet, providing greater security\. - -**To create a VPC based on Amazon VPC** - -1. Sign in to the AWS Management Console and open the Amazon VPC console at [https://console\.aws\.amazon\.com/vpc/](https://console.aws.amazon.com/vpc/)\. - -1. In the upper\-right corner of the AWS Management Console, choose the AWS Region for your VPC\. This example uses the US West \(Oregon\) region\. - -1. In the upper\-left corner, choose **VPC Dashboard**, and then choose **Start VPC Wizard**\. - -1. On the page **Step 1: Select a VPC Configuration**, choose **VPC with Public and Private Subnets**, and then choose **Select**\. - -1. On the page **Step 2: VPC with Public and Private Subnets**, shown following, set the following values\. -**** -[\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Oracle.Resources.Shared.html) -![\[VPC with Public and Private Subnets Wizard\]](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/images/Siebel-VPC.png) - -1. Choose **Create VPC**\. - -An Amazon RDS DB instance in a VPC requires at least two private subnets or at least two public subnets, to support Multi\-AZ deployment\. For more information about working with multiple Availability Zones, see [Regions, Availability Zones, and Local Zones](Concepts.RegionsAndAvailabilityZones.md)\. Because your database is private, add a second private subnet to your VPC\. - -**To create an additional subnet** - -1. Sign in to the AWS Management Console and open the Amazon VPC console at [https://console\.aws\.amazon\.com/vpc/](https://console.aws.amazon.com/vpc/)\. - -1. In the upper\-right corner of the AWS Management Console, confirm that you are in the correct AWS Region for your VPC\. - -1. In the upper\-left corner, choose **VPC Dashboard**, choose **Subnets**, and then choose **Create Subnet**\. - -1. On the **Create Subnet** page, set the following values\. -**** -[\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Oracle.Resources.Shared.html) - -1. Choose **Yes, Create**\. - -Both private subnets must use the same route table\. In the following procedure, you check to make sure the route tables match, and if not you edit one of them\. - -**To ensure the subnets use the same route table\.** - -1. Sign in to the AWS Management Console and open the Amazon VPC console at [https://console\.aws\.amazon\.com/vpc/](https://console.aws.amazon.com/vpc/)\. - -1. In the upper\-right corner of the AWS Management Console, confirm that you are in the correct AWS Region for your VPC\. - -1. In the upper\-left corner, choose **VPC Dashboard**, choose **Subnets**, and then choose your first private subnet, for example **subnet\-private\-1**\. - -1. At the bottom of the console, choose the **Route Table** tab, shown following\. -![\[Route Table information\]](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/images/Siebel-RouteTable.png) - -1. Make a note of the route table, for example `rtb-0d9fc668`\. - -1. In the list of subnets, choose the second private subnet, for example **subnet\-private\-2**\. - -1. At the bottom of the console, choose the **Route Table** tab\. - -1. If the route table for the second subnet is not the same as the route table for the first subnet, edit it to match: - - 1. Choose **Edit**\. - - 1. For **Change to**, choose the route table that matches your first subnet\. - - 1. Choose **Save**\. - -A security group acts as a virtual firewall for your DB instance to control inbound and outbound traffic\. In the following procedure, you create a security group for your DB instance\. For more information about security groups, see [Security groups for your VPC](https://docs.aws.amazon.com/vpc/latest/userguide/VPC_SecurityGroups.html)\. - -**To create a VPC security group for a private Amazon RDS DB instance** - -1. Sign in to the AWS Management Console and open the Amazon VPC console at [https://console\.aws\.amazon\.com/vpc/](https://console.aws.amazon.com/vpc/)\. - -1. In the upper\-right corner of the AWS Management Console, confirm that you are in the correct AWS Region for your VPC\. - -1. In the upper\-left corner, choose **VPC Dashboard**, choose **Security Groups**, and then choose **Create Security Group**\. - -1. On the page **Create Security Group**, set the following values\. -**** -[\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Oracle.Resources.Shared.html) - -1. Choose **Yes, Create**\. - -In the following procedure, you add rules to your security group to control inbound traffic to your DB instance\. For more information about inbound rules, see [Security group rules](https://docs.aws.amazon.com/vpc/latest/userguide/VPC_SecurityGroups.html#SecurityGroupRules)\. - -**To add inbound rules to the security group** - -1. Sign in to the AWS Management Console and open the Amazon VPC console at [https://console\.aws\.amazon\.com/vpc/](https://console.aws.amazon.com/vpc/)\. - -1. In the upper\-right corner of the AWS Management Console, confirm that you are in the correct AWS Region for your VPC\. - -1. In the upper\-left corner, choose **VPC Dashboard**, choose **Security Groups**, and then choose your security group, for example **sgdb\-1**\. - -1. At the bottom of the console, choose the **Inbound Rules** tab, and then choose **Edit**\. - -1. Set these values, as shown following\. -**** -[\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Oracle.Resources.Shared.html) -![\[Inbound Rules information\]](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/images/Siebel-InboundRules.png) - -1. Choose **Save**\. - -## Creating an Oracle DB instance - -You can use Amazon RDS to host an Oracle DB instance\. When you create the new DB instance, specify the VPC and security group you created previously using the instructions in [Creating a VPC for use with an Oracle database](#Oracle.Resources.Shared.VPC)\. Also, choose **No** for **Publicly accessible**\. - -For information about creating a DB instance, see [Creating an Amazon RDS DB instance](USER_CreateDBInstance.md)\. - -## Additional Amazon RDS interfaces - -In the preceding tasks, you use the AWS Management Console to perform tasks\. Amazon Web Services also provides the AWS Command Line Interface \(AWS CLI\), and an application programming interface \(API\)\. You can use the AWS CLI or the API to automate many of the tasks for managing Amazon RDS, including tasks to manage an Oracle DB instance with Amazon RDS\. - -For more information, see [AWS Command Line Interface reference for Amazon RDS](https://docs.aws.amazon.com/cli/latest/reference/rds/index.html) and [Amazon RDS API Reference](https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/)\. \ No newline at end of file diff --git a/doc_source/Oracle.Resources.Siebel.md b/doc_source/Oracle.Resources.Siebel.md deleted file mode 100644 index 7730ae9..0000000 --- a/doc_source/Oracle.Resources.Siebel.md +++ /dev/null @@ -1,80 +0,0 @@ -# Installing a Siebel database on Oracle on Amazon RDS - -You can use Amazon RDS to host a Siebel Database on an Oracle DB instance\. The Siebel Database is part of the Siebel Customer Relationship Management \(CRM\) application architecture\. For an illustration, see [ Generic architecture of Siebel business application](https://docs.oracle.com/cd/E63029_01/books/PerformTun/performtun_archinfra.htm#i1043361)\. - -Use the following topic to help set up a Siebel Database on an Oracle DB instance on Amazon RDS\. You can also find out how to use Amazon Web Services to support the other components required by the Siebel CRM application architecture\. - -**Note** -To install a Siebel Database on Oracle on Amazon RDS, you need to use the master user account\. You don't need `SYSDBA` privilege; master user privilege is sufficient\. For more information, see [Master user account privileges](UsingWithRDS.MasterAccounts.md)\. - -## Licensing and versions - -To install a Siebel Database on Amazon RDS, you must use your own Oracle Database license, and your own Siebel license\. You must have the appropriate Oracle Database license \(with Software Update License and Support\) for the DB instance class and Oracle Database edition\. For more information, see [RDS for Oracle licensing options](Oracle.Concepts.Licensing.md)\. - -Oracle Database Enterprise Edition is the only edition certified by Siebel for this scenario\. Amazon RDS supports Siebel CRM version 15\.0 or 16\.0\. Use Oracle Database 12c Release 1 \(12\.1\.0\.2\.0\)\. For the procedures following, we use Siebel CRM version 15\.0 and Oracle Database Release 1 \(12\.1\.0\.2\) or Oracle Database Release 2 \(12\.2\.0\.1\)\. For more information, see [Oracle Database 12c with Amazon RDS](Oracle.Concepts.database-versions.md#Oracle.Concepts.FeatureSupport.12c)\. - -Amazon RDS supports database version upgrades\. For more information, see [Upgrading a DB instance engine version](USER_UpgradeDBInstance.Upgrading.md)\. - -## Before you begin - -Before you begin, you need an Amazon VPC\. Because your Amazon RDS DB instance needs to be available only to your Siebel Enterprise Server, and not to the public Internet, your Amazon RDS DB instance is hosted in a private subnet, providing greater security\. For information about how to create an Amazon VPC for use with Siebel CRM, see [Creating a VPC for use with an Oracle database](Oracle.Resources.Shared.md#Oracle.Resources.Shared.VPC)\. - -Before you begin, you also need an Oracle DB instance\. For information about how to create an Oracle DB instance for use with Siebel CRM, see [Creating an Oracle DB instance](Oracle.Resources.Shared.md#Oracle.Resources.Shared.Database.RDS)\. - -## Installing and configuring a Siebel database - -After you create your Oracle DB instance, you can install your Siebel Database\. You install the database by creating table owner and administrator accounts, installing stored procedures and functions, and then running the Siebel Database Configuration Wizard\. For more information, see [ Installing the Siebel database on the RDBMS](https://docs.oracle.com/cd/E63029_01/books/SiebInstWIN/SiebInstCOM_ConfigDB.html)\. - -To run the Siebel Database Configuration Wizard, you need to use the master user account\. You don't need `SYSDBA` privilege; master user privilege is sufficient\. For more information, see [Master user account privileges](UsingWithRDS.MasterAccounts.md)\. - -## Using other Amazon RDS features with a Siebel database - -After you create your Oracle DB instance, you can use additional Amazon RDS features to help you customize your Siebel Database\. - -### Collecting statistics with the Oracle Statspack option - -You can add features to your DB instance through the use of options in DB option groups\. When you created your Oracle DB instance, you used the default DB option group\. If you want to add features to your database, you can create a new option group for your DB instance\. - -If you want to collect performance statistics on your Siebel Database, you can add the Oracle Statspack feature\. For more information, see [Oracle Statspack](Appendix.Oracle.Options.Statspack.md)\. - -Some option changes are applied immediately, and some option changes are applied during the next maintenance window for the DB instance\. For more information, see [Working with option groups](USER_WorkingWithOptionGroups.md)\. After you create a customized option group, modify your DB instance to attach it\. For more information, see [Modifying an Amazon RDS DB instance](Overview.DBInstance.Modifying.md)\. - -### Performance tuning with parameters - -You manage your DB engine configuration through the use of parameters in a DB parameter group\. When you created your Oracle DB instance, you used the default DB parameter group\. If you want to customize your database configuration, you can create a new parameter group for your DB instance\. - -When you change a parameter, depending on the type of the parameter, the changes are applied either immediately or after you manually reboot the DB instance\. For more information, see [Working with parameter groups](USER_WorkingWithParamGroups.md)\. After you create a customized parameter group, modify your DB instance to attach it\. For more information, see [Modifying an Amazon RDS DB instance](Overview.DBInstance.Modifying.md)\. - -To optimize your Oracle DB instance for Siebel CRM, you can customize certain parameters\. The following table shows some recommended parameter settings\. For more information about performance tuning Siebel CRM, see [Siebel CRM Performance Tuning Guide](https://docs.oracle.com/cd/E63029_01/books/PerformTun/toc.htm)\. - - -**** - -| Parameter name | Default value | Guidance for optimal Siebel CRM performance | -| --- | --- | --- | -| \_always\_semi\_join | `CHOOSE` | `OFF` | -| \_b\_tree\_bitmap\_plans | `TRUE` | `FALSE` | -| \_like\_with\_bind\_as\_equality | `FALSE` | `TRUE` | -| \_no\_or\_expansion | `FALSE` | `FALSE` | -| \_optimizer\_join\_sel\_sanity\_check | `TRUE` | `TRUE` | -| \_optimizer\_max\_permutations | 2000 | 100 | -| \_optimizer\_sortmerge\_join\_enabled | `TRUE` | `FALSE` | -| \_partition\_view\_enabled | `TRUE` | `FALSE` | -| open\_cursors | `300` | At least **2000**\. | - -### Creating snapshots - -After you create your Siebel Database, you can copy the database by using the snapshot features of Amazon RDS\. For more information, see [Creating a DB snapshot](USER_CreateSnapshot.md) and [Restoring from a DB snapshot](USER_RestoreFromSnapshot.md)\. - -## Support for other Siebel CRM components - -In addition to your Siebel Database, you can also use Amazon Web Services to support the other components of your Siebel CRM application architecture\. You can find more information about the support provided by Amazon AWS for additional Siebel CRM components in the following table\. - - -**** - -| Siebel CRM component | Amazon AWS Support | -| --- | --- | -| Siebel Enterprise\(with one or more Siebel Servers\) | You can host your Siebel Servers on Amazon Elastic Compute Cloud \(Amazon EC2\) instances\. You can use Amazon EC2 to launch as many or as few virtual servers as you need\. Using Amazon EC2, you can scale up or down easily to handle changes in requirements\. For more information, see [What is Amazon EC2?](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/concepts.html) You can put your servers in the same VPC with your DB instance and use the VPC security group to access the database\. For more information, see [Working with a DB instance in a VPC](USER_VPC.WorkingWithRDSInstanceinaVPC.md)\. | -| Web Servers\(with Siebel Web Server Extensions\) | You can install multiple Web Servers on multiple EC2 instances\. You can then use Elastic Load Balancing to distribute incoming traffic among the instances\. For more information, see [What is Elastic Load Balancing?](https://docs.aws.amazon.com/elasticloadbalancing/latest/userguide/elastic-load-balancing.html) | -| Siebel Gateway Name Server | You can host your Siebel Gateway Name Server on an EC2 instance\. You can then put your server in the same VPC with the DB instance and use the VPC security group to access the database\. For more information, see [Working with a DB instance in a VPC](USER_VPC.WorkingWithRDSInstanceinaVPC.md)\. | \ No newline at end of file diff --git a/doc_source/Oracle.Resources.md b/doc_source/Oracle.Resources.md deleted file mode 100644 index a6ccc84..0000000 --- a/doc_source/Oracle.Resources.md +++ /dev/null @@ -1,10 +0,0 @@ -# Using third\-party software with your RDS for Oracle DB instance - -To use tools and third\-party software with RDS for Oracle DB instances, review the information in the following sections\. - -**Topics** -+ [Setting up Amazon RDS to host tools and third\-party software for Oracle](Oracle.Resources.Shared.md) -+ [Using Oracle GoldenGate with Amazon RDS for Oracle](Appendix.OracleGoldenGate.md) -+ [Using the Oracle Repository Creation Utility on RDS for Oracle](Oracle.Resources.RCU.md) -+ [Configuring Oracle Connection Manager on an Amazon EC2 instance](oracle-cman.md) -+ [Installing a Siebel database on Oracle on Amazon RDS](Oracle.Resources.Siebel.md) \ No newline at end of file diff --git a/doc_source/Overview.DBInstance.Modifying.md b/doc_source/Overview.DBInstance.Modifying.md deleted file mode 100644 index 6ac6b4b..0000000 --- a/doc_source/Overview.DBInstance.Modifying.md +++ /dev/null @@ -1,120 +0,0 @@ -# Modifying an Amazon RDS DB instance - -You can change the settings of a DB instance to accomplish tasks such as adding additional storage or changing the DB instance class\. In this topic, you can find out how to modify an Amazon RDS DB instance and learn about the settings for DB instances\. - -We recommend that you test any changes on a test instance before modifying a production instance\. Doing this helps you to fully understand the impact of each change\. Testing is especially important when upgrading database versions\. - -Most modifications to a DB instance you can either apply immediately or defer until the next maintenance window\. Some modifications, such as parameter group changes, require that you manually reboot your DB instance for the change to take effect\. - -**Important** -Some modifications result in downtime because Amazon RDS must reboot your DB instance for the change to take effect\. Review the impact to your database and applications before modifying your DB instance settings\. - -## Console - -**To modify a DB instance** - -1. Sign in to the AWS Management Console and open the Amazon RDS console at [https://console\.aws\.amazon\.com/rds/](https://console.aws.amazon.com/rds/)\. - -1. In the navigation pane, choose **Databases**, and then choose the DB instance that you want to modify\. - -1. Choose **Modify**\. The **Modify DB instance** page appears\. - -1. Change any of the settings that you want\. For information about each setting, see [Settings for DB instances](#USER_ModifyInstance.Settings)\. - -1. When all the changes are as you want them, choose **Continue** and check the summary of modifications\. - -1. \(Optional\) Choose **Apply immediately** to apply the changes immediately\. Choosing this option can cause downtime in some cases\. For more information, see [Using the Apply Immediately setting](#USER_ModifyInstance.ApplyImmediately)\. - -1. On the confirmation page, review your changes\. If they are correct, choose **Modify DB instance** to save your changes\. - - Or choose **Back** to edit your changes or **Cancel** to cancel your changes\. - -## AWS CLI - -To modify a DB instance by using the AWS CLI, call the [modify\-db\-instance](https://docs.aws.amazon.com/cli/latest/reference/rds/modify-db-instance.html) command\. Specify the DB instance identifier and the values for the options that you want to modify\. For information about each option, see [Settings for DB instances](#USER_ModifyInstance.Settings)\. - -**Example** -The following code modifies `mydbinstance` by setting the backup retention period to 1 week \(7 days\)\. The code enables deletion protection by using `--deletion-protection`\. To disable deletion protection, use `--no-deletion-protection`\. The changes are applied during the next maintenance window by using `--no-apply-immediately`\. Use `--apply-immediately` to apply the changes immediately\. For more information, see [Using the Apply Immediately setting](#USER_ModifyInstance.ApplyImmediately)\. -For Linux, macOS, or Unix: - -``` -aws rds modify-db-instance \ - --db-instance-identifier mydbinstance \ - --backup-retention-period 7 \ - --deletion-protection \ - --no-apply-immediately -``` -For Windows: - -``` -aws rds modify-db-instance ^ - --db-instance-identifier mydbinstance ^ - --backup-retention-period 7 ^ - --deletion-protection ^ - --no-apply-immediately -``` - -## RDS API - -To modify a DB instance by using the Amazon RDS API, call the [ModifyDBInstance](https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_ModifyDBInstance.html) operation\. Specify the DB instance identifier, and the parameters for the settings that you want to modify\. For information about each parameter, see [Settings for DB instances](#USER_ModifyInstance.Settings)\. - -## Using the Apply Immediately setting - -When you modify a DB instance, you can apply the changes immediately\. To apply changes immediately, you choose the **Apply Immediately** option in the AWS Management Console\. Or you use the `--apply-immediately` parameter when calling the AWS CLI or set the `ApplyImmediately` parameter to `true` when using the Amazon RDS API\. - -If you don't choose to apply changes immediately, the changes are put into the pending modifications queue\. During the next maintenance window, any pending changes in the queue are applied\. If you choose to apply changes immediately, your new changes and any changes in the pending modifications queue are applied\. - -**Important** -If any of the pending modifications require the DB instance to be temporarily unavailable \(*downtime*\), choosing the apply immediately option can cause unexpected downtime\. -When you choose to apply a change immediately, any pending modifications are also applied immediately, instead of during the next maintenance window\. -If you don't want a pending change to be applied in the next maintenance window, you can modify the DB instance to revert the change\. You can do this by using the AWS CLI and specifying the `--apply-immediately` option\. - -Changes to some database settings are applied immediately, even if you choose to defer your changes\. To see how the different database settings interact with the apply immediately setting, see [Settings for DB instances](#USER_ModifyInstance.Settings)\. - -## Settings for DB instances - -In the following table, you can find details about which settings you can and can't modify\. You can also find when changes can be applied and whether the changes cause downtime for your DB instance\. By using Amazon RDS features such as Multi\-AZ, you can minimize downtime if you later modify the DB instance\. For more information, see [Configuring and managing a Multi\-AZ deployment](Concepts.MultiAZ.md)\. - -You can modify a DB instance using the console, the [https://docs.aws.amazon.com/cli/latest/reference/rds/modify-db-instance.html](https://docs.aws.amazon.com/cli/latest/reference/rds/modify-db-instance.html) CLI command, or the [https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_ModifyDBInstance.html](https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_ModifyDBInstance.html) RDS API operation\. - - -**** - -| Console setting and description | CLI option and RDS API parameter | When the change occurs | Downtime notes | Supported DB engines | -| --- | --- | --- | --- | --- | -| **Allocated storage** The storage, in gibibytes, that you want to allocate for your DB instance\. You can only increase the allocated storage\. You can't reduce the allocated storage\. You can't modify the storage of some older DB instances, or DB instances restored from older DB snapshots\. The **Allocated storage** setting is disabled in the console if your DB instance isn't eligible\. You can check whether you can allocate more storage by using the CLI command [describe\-valid\-db\-instance\-modifications](https://docs.aws.amazon.com/cli/latest/reference/rds/describe-valid-db-instance-modifications.html)\. This command returns the valid storage options for your DB instance\. You can't modify allocated storage if the DB instance status is **storage\-optimization**\. You also can't modify allocated storage for a DB instance if it's been modified in the last six hours\. The maximum storage allowed depends on your DB engine and the storage type\. For more information, see [Amazon RDS DB instance storage](CHAP_Storage.md)\. | **CLI option:** `--allocated-storage` **RDS API parameter:** `AllocatedStorage` | If you choose to apply the change immediately, it occurs immediately\. If you don't choose to apply the change immediately, it occurs during the next maintenance window\. | Downtime doesn't occur during this change\. Performance might be degraded during the change\. | All DB engines | -| **Architecture settings** The architecture of the database: CDB \(single\-tenant\) or non\-CDB\. Oracle Database 21c uses CDB architecture only\. Oracle Database 19c can use either CDB or non\-CDB architecture\. Releases lower than Oracle Database 19c use non\-CDB only\. If you choose **Multitenant architecture**, RDS for Oracle converts your non\-CDB into a CDB\. This setting is supported only if your database is a non\-CDB running Oracle Database 19c with the April 2021 or higher RU\. After conversion, your CDB contains one pluggable database \(PDB\)\. For more information, see [Overview of RDS for Oracle CDBs](oracle-multitenant.md#Oracle.Concepts.single-tenant)\. | **CLI option:** `--engine oracle-ee-cdb` \(multitenant\) `--engine oracle-se2-cdb` \(multitenant\) **API parameter:** `Engine` | If you choose to apply the change immediately, it occurs immediately\. If you don't choose to apply the change immediately, it occurs during the next maintenance window\. | Downtime occurs during this change\. | Oracle | -| **Auto minor version upgrade** **Yes** to enable your DB instance to receive preferred minor DB engine version upgrades automatically when they become available\. Amazon RDS performs automatic minor version upgrades in the maintenance window\. Otherwise, **No**\. For more information, see [Automatically upgrading the minor engine version](USER_UpgradeDBInstance.Upgrading.md#USER_UpgradeDBInstance.Upgrading.AutoMinorVersionUpgrades)\. | **CLI option:** `--auto-minor-version-upgrade\|--no-auto-minor-version-upgrade` **RDS API parameter:** `AutoMinorVersionUpgrade` | The change occurs immediately\. This setting ignores the apply immediately setting\. | Downtime doesn't occur during this change\. | All DB engines | -| Backup replicationChoose **Enable replication to another AWS Region** to create backups in an additional Region for disaster recovery\.Then choose the **Destination Region** for the additional backups\. | Not available when modifying a DB instance\. For information on enabling cross\-Region backups using the AWS CLI or RDS API, see [Enabling cross\-Region automated backups](USER_ReplicateBackups.md#AutomatedBackups.Replicating.Enable)\. | The change is applied asynchronously, as soon as possible\. | Downtime doesn't occur during this change\. | Oracle, PostgreSQL, SQL Server | -| **Backup retention period** The number of days that automatic backups are retained\. To disable automatic backups, set the backup retention period to 0\. For more information, see [Working with backups](USER_WorkingWithAutomatedBackups.md)\. If you use AWS Backup to manage your backups, this option doesn't apply\. For information about AWS Backup, see the [https://docs.aws.amazon.com/aws-backup/latest/devguide](https://docs.aws.amazon.com/aws-backup/latest/devguide)\. | **CLI option:** `--backup-retention-period` **RDS API parameter:** `BackupRetentionPeriod` | If you choose to apply the change immediately, it occurs immediately\. If you don't choose to apply the change immediately, and you change the setting from a nonzero value to another nonzero value, the change is applied asynchronously, as soon as possible\. Otherwise, the change occurs during the next maintenance window\. | Downtime occurs if you change from 0 to a nonzero value, or from a nonzero value to 0\. This applies to both Single\-AZ and Multi\-AZ DB instances\. | All DB engines | -| **Backup window** The time range during which automated backups of your databases occur\. The backup window is a start time in Universal Coordinated Time \(UTC\), and a duration in hours\. For more information, see [Working with backups](USER_WorkingWithAutomatedBackups.md)\. If you use AWS Backup to manage your backups, this option doesn't appear\. For information about AWS Backup, see the [https://docs.aws.amazon.com/aws-backup/latest/devguide](https://docs.aws.amazon.com/aws-backup/latest/devguide)\. | **CLI option:** `--preferred-backup-window` **RDS API parameter:** `PreferredBackupWindow` | The change is applied asynchronously, as soon as possible\. | Downtime doesn't occur during this change\. | All DB engines | -| **Certificate authority** The certificate authority \(CA\) for the server certificate used by the DB instance\. For more information, see [Using SSL/TLS to encrypt a connection to a DB instance](UsingWithRDS.SSL.md)\. | **CLI option:** `--ca-certificate-identifier` **RDS API parameter:** `CACertificateIdentifier` | If you choose to apply the change immediately, it occurs immediately\. If you don't choose to apply the change immediately, it occurs during the next maintenance window\. | Downtime only occurs if the DB engine doesn't support rotation without restart\. You can use the [ describe\-db\-engine\-versions](https://docs.aws.amazon.com/cli/latest/reference/rds/describe-db-engine-versions.html) AWS CLI command to determine whether the DB engine supports rotation without restart\. | All DB engines | -| **Copy tags to snapshots** If you have any DB instance tags, enable this option to copy them when you create a DB snapshot\. For more information, see [Tagging Amazon RDS resources](USER_Tagging.md)\. | **CLI option:** `--copy-tags-to-snapshot` or `--no-copy-tags-to-snapshot` **RDS API parameter:** `CopyTagsToSnapshot` | The change occurs immediately\. This setting ignores the apply immediately setting\. | Downtime doesn't occur during this change\. | All DB engines | -| **Database port** The port that you want to use to access the DB instance\. The port value must not match any of the port values specified for options in the option group that is associated with the DB instance\. For more information, see [Connecting to an Amazon RDS DB instance](CHAP_CommonTasks.Connect.md)\. | **CLI option:** `--db-port-number` **RDS API parameter:** `DBPortNumber` | The change occurs immediately\. This setting ignores the apply immediately setting\. | The DB instance is rebooted immediately\. | All DB engines | -| **DB engine version** The version of the DB engine that you want to use\. Before you upgrade your production DB instance, we recommend that you test the upgrade process on a test DB instance\. Doing this helps verify its duration and validate your applications\. For more information, see [Upgrading a DB instance engine version](USER_UpgradeDBInstance.Upgrading.md)\. | **CLI option:** `--engine-version` **RDS API parameter:** `EngineVersion` | If you choose to apply the change immediately, it occurs immediately\. If you don't choose to apply the change immediately, it occurs during the next maintenance window\. | Downtime occurs during this change\. | All DB engines | -| **DB instance class** The DB instance class that you want to use\. For more information, see [DB instance classes](Concepts.DBInstanceClass.md)\. | **CLI option:** `--db-instance-class` **RDS API parameter:** `DBInstanceClass` | If you choose to apply the change immediately, it occurs immediately\. If you don't choose to apply the change immediately, it occurs during the next maintenance window\. | Downtime occurs during this change\. | All DB engines | -| **DB instance identifier** The new DB instance identifier\. This value is stored as a lowercase string\. For more information about the effects of renaming a DB instance, see [Renaming a DB instance](USER_RenameInstance.md)\. | **CLI option:** `--new-db-instance-identifier` **RDS API parameter:** `NewDBInstanceIdentifier` | If you choose to apply the change immediately, it occurs immediately\. If you don't choose to apply the change immediately, it occurs during the next maintenance window\. | Downtime occurs during this change\. | All DB engines | -| **DB parameter group** The DB parameter group that you want associated with the DB instance\. For more information, see [Working with parameter groups](USER_WorkingWithParamGroups.md)\. | **CLI option:** `--db-parameter-group-name` **RDS API parameter:** `DBParameterGroupName` | The parameter group change occurs immediately\. | Downtime doesn't occur during this change\. When you associate a new DB parameter group with a DB instance, the modified static and dynamic parameters are applied only after the DB instance is rebooted\. However, if you modify dynamic parameters in the DB parameter group after you associate it with the DB instance, these changes are applied immediately without a reboot\. For more information, see [Working with parameter groups](USER_WorkingWithParamGroups.md) and [Rebooting a DB instance](USER_RebootInstance.md)\. | All DB engines | -| **Deletion protection** **Enable deletion protection** to prevent your DB instance from being deleted\. For more information, see [Deleting a DB instance](USER_DeleteInstance.md)\. | **CLI option:** `--deletion-protection\|--no-deletion-protection` **RDS API parameter:** `DeletionProtection` | The change occurs immediately\. This setting ignores the apply immediately setting\. | Downtime doesn't occur during this change\. | All DB engines | -| **Enhanced Monitoring** **Enable Enhanced Monitoring** to enable gathering metrics in real time for the operating system that your DB instance runs on\. For more information, see [Monitoring OS metrics with Enhanced Monitoring](USER_Monitoring.OS.md)\. | **CLI option:** `--monitoring-interval` and `--monitoring-role-arn` **RDS API parameter:** `MonitoringInterval` and `MonitoringRoleArn` | The change occurs immediately\. This setting ignores the apply immediately setting\. | Downtime doesn't occur during this change\. | All DB engines | -| **IAM DB authentication** **Enable IAM DB authentication** to authenticate database users through users and roles\. For more information, see [IAM database authentication for MariaDB, MySQL, and PostgreSQL](UsingWithRDS.IAMDBAuth.md)\. | **CLI option:** `--enable-iam-database-authentication\|--no-enable-iam-database-authentication` **RDS API parameter:** `EnableIAMDatabaseAuthentication` | If you choose to apply the change immediately, it occurs immediately\. If you don't choose to apply the change immediately, it occurs during the next maintenance window\. | Downtime doesn't occur during this change\. | Only MariaDB, MySQL, and PostgreSQL | -| **Kerberos authentication** Choose the Active Directory to move the DB instance to\. The directory must exist prior to this operation\. If a directory is already selected, you can specify **None** to remove the DB instance from its current directory\. For more information, see [Kerberos authentication](database-authentication.md#kerberos-authentication)\. | **CLI option:** `--domain` and `--domain-iam-role-name` **RDS API parameter:** `Domain` and `DomainIAMRoleName` | If you choose to apply the change immediately, it occurs immediately\. If you don't choose to apply the change immediately, it occurs during the next maintenance window\. | A brief downtime occurs during this change\. | Only Microsoft SQL Server, MySQL, Oracle, and PostgreSQL | -| **License model** Choose **bring\-your\-own\-license** to use your license for Oracle\. Choose **license\-included** to use the general license agreement for Microsoft SQL Server or Oracle\. For more information, see [Licensing Microsoft SQL Server on Amazon RDS](SQLServer.Concepts.General.Licensing.md) and [RDS for Oracle licensing options](Oracle.Concepts.Licensing.md)\. | **CLI option:** `--license-model` **RDS API parameter:** `LicenseModel` | If you choose to apply the change immediately, it occurs immediately\. If you don't choose to apply the change immediately, it occurs during the next maintenance window\. | Downtime occurs during this change\. | Only Microsoft SQL Server and Oracle | -| **Log exports** The types of database log files to publish to Amazon CloudWatch Logs\. For more information, see [Publishing database logs to Amazon CloudWatch Logs](USER_LogAccess.Procedural.UploadtoCloudWatch.md)\. | **CLI option:** `--cloudwatch-logs-export-configuration` **RDS API parameter:** `CloudwatchLogsExportConfiguration` | The change occurs immediately\. This setting ignores the apply immediately setting\. | Downtime doesn't occur during this change\. | All DB engines | -| **Maintenance window** The time range during which system maintenance occurs\. System maintenance includes upgrades, if applicable\. The maintenance window is a start time in Universal Coordinated Time \(UTC\), and a duration in hours\. If you set the window to the current time, there must be at least 30 minutes between the current time and the end of the window\. This timing helps ensure that any pending changes are applied\. For more information, see [The Amazon RDS maintenance window](USER_UpgradeDBInstance.Maintenance.md#Concepts.DBMaintenance)\. | **CLI option:** `--preferred-maintenance-window` **RDS API parameter:** `PreferredMaintenanceWindow` | The change occurs immediately\. This setting ignores the apply immediately setting\. | If there are one or more pending actions that cause downtime, and the maintenance window is changed to include the current time, those pending actions are applied immediately and downtime occurs\. | All DB engines | -| Manage master credentials in AWS Secrets Manager Select **Manage master credentials in AWS Secrets Manager** to manage the master user password in a secret in Secrets Manager\. Optionally, choose a KMS key to use to protect the secret\. Choose from the KMS keys in your account, or enter the key from a different account\. If RDS is already managing the master user password for the DB instance, you can rotate the master user password by choosing **Rotate secret immediately**\. For more information, see [Password management with Amazon RDS and AWS Secrets Manager](rds-secrets-manager.md)\. | **CLI option:** `--manage-master-user-password \| --no-manage-master-user-password` `--master-user-secret-kms-key-id` `--rotate-master-user-password \| --no-rotate-master-user-password` **RDS API parameter:** `ManageMasterUserPassword` `MasterUserSecretKmsKeyId` `RotateMasterUserPassword` | If you are turning on or turning off automatic master user password management, the change occurs immediately\. This change ignores the apply immediately setting\. If you are rotating the master user password, you must specify that the change is applied immediately\. | Downtime doesn't occur during this change\. | All DB engines | -| **Multi\-AZ deployment** **Yes** to deploy your DB instance in multiple Availability Zones\. Otherwise, **No**\. For more information, see [Configuring and managing a Multi\-AZ deployment](Concepts.MultiAZ.md)\. | **CLI option:** `--multi-az\|--no-multi-az` **RDS API parameter:** `MultiAZ` | If you choose to apply the change immediately, it occurs immediately\. If you don't choose to apply the change immediately, it occurs during the next maintenance window\. | Downtime doesn't occur during this change\. However, there is a possible performance impact\. For more information, see [Modifying a DB instance to be a Multi\-AZ DB instance deployment](Concepts.MultiAZSingleStandby.md#Concepts.MultiAZ.Migrating)\. | All DB engines | -| **Network type** The IP addressing protocols supported by the DB instance\. **IPv4** to specify that resources can communicate with the DB instance only over the Internet Protocol version 4 \(IPv4\) addressing protocol\. **Dual\-stack mode** to specify that resources can communicate with the DB instance over IPv4, Internet Protocol version 6 \(IPv6\), or both\. Use dual\-stack mode if you have any resources that must communicate with your DB instance over the IPv6 addressing protocol\. Also, make sure that you associate an IPv6 CIDR block with all subnets in the DB subnet group that you specify\. For more information, see [Amazon RDS IP addressing](USER_VPC.WorkingWithRDSInstanceinaVPC.md#USER_VPC.IP_addressing)\. | **CLI option:** `--network-type` **RDS API parameter:** `NetworkType` | If you choose to apply the change immediately, it occurs immediately\. If you don't choose to apply the change immediately, it occurs during the next maintenance window\. | Downtime is possible during this change\. | All DB engines | -| **New master password** The password for your master user\. The password must contain 8–41 alphanumeric characters\. | **CLI option:** `--master-user-password` **RDS API parameter:** `MasterUserPassword` | The change is applied asynchronously, as soon as possible\. This setting ignores the apply immediately setting\. | Downtime doesn't occur during this change\. | All DB engines | -| **Option group** The option group that you want associated with the DB instance\. For more information, see [Working with option groups](USER_WorkingWithOptionGroups.md)\. | **CLI option:** `--option-group-name` **RDS API parameter:** `OptionGroupName` | If you choose to apply the change immediately, it occurs immediately\. If you don't choose to apply the change immediately, it occurs during the next maintenance window\. | Downtime doesn't occur during this change\. | All DB engines | -| **Performance Insights** **Enable Performance Insights** to monitor your DB instance load so that you can analyze and troubleshoot your database performance\. Performance Insights isn't available for some DB engine versions and DB instance classes\. The **Performance Insights** section doesn't appear in the console if it isn't available for your DB instance\. For more information, see [Monitoring DB load with Performance Insights on Amazon RDS](USER_PerfInsights.md) and [Amazon RDS DB engine, Region, and instance class support for Performance Insights](USER_PerfInsights.Overview.Engines.md)\. | **CLI option:** `--enable-performance-insights\|--no-enable-performance-insights` **RDS API parameter:** `EnablePerformanceInsights` | The change occurs immediately\. This setting ignores the apply immediately setting\. | Downtime doesn't occur during this change\. | All DB engines | -| **Performance Insights AWS KMS key** The AWS KMS key identifier for the AWS KMS key for encryption of Performance Insights data\. The key identifier is the Amazon Resource Name \(ARN\), AWS KMS key identifier, or the key alias for the KMS key\. For more information, see [Turning Performance Insights on and off](USER_PerfInsights.Enabling.md)\. | **CLI option:** `--performance-insights-kms-key-id` **RDS API parameter:** `PerformanceInsightsKMSKeyId` | The change occurs immediately\. This setting ignores the apply immediately setting\. | Downtime doesn't occur during this change\. | All DB engines | -| **Performance Insights Retention period** The amount of time, in days, to retain Performance Insights data\. The retention setting in the free tier is **Default \(7 days\)**\. To retain your performance data for longer, specify 1–24 months\. For more information about retention periods, see [Pricing and data retention for Performance Insights](USER_PerfInsights.Overview.cost.md)\. For more information, see [Turning Performance Insights on and off](USER_PerfInsights.Enabling.md)\. | **CLI option:** `--performance-insights-retention-period` **RDS API parameter:** `PerformanceInsightsRetentionPeriod` | The change occurs immediately\. This setting ignores the apply immediately setting\. | Downtime doesn't occur during this change\. | All DB engines | -| **Processor features** The number of CPU cores and the number of threads per core for the DB instance class of the DB instance\. For more information, see [Configuring the processor for a DB instance class](Concepts.DBInstanceClass.md#USER_ConfigureProcessor)\. | **CLI option:** `--processor-features` and `--use-default-processor-features \| --no-use-default-processor-features` **RDS API parameter:** `ProcessorFeatures` and `UseDefaultProcessorFeatures` | If you choose to apply the change immediately, it occurs immediately\. If you don't choose to apply the change immediately, it occurs during the next maintenance window\. | Downtime occurs during this change\. | Only Oracle | -| **Provisioned IOPS** The Provisioned IOPS \(I/O operations per second\) value for the DB instance\. This setting is available only if you choose one of the following for **Storage type**: [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Overview.DBInstance.Modifying.html) For more information, see [Provisioned IOPS SSD storage](CHAP_Storage.md#USER_PIOPS) and [Amazon RDS DB instance storage](CHAP_Storage.md)\. | **CLI option:** `--iops` **RDS API parameter:** `Iops` | If you choose to apply the change immediately, it occurs immediately\. If you don't choose to apply the change immediately, it occurs during the next maintenance window\. | Downtime doesn't occur during this change\. | All DB engines | -| **Public access** **Publicly accessible** to give the DB instance a public IP address, meaning that it's accessible outside the VPC\. To be publicly accessible, the DB instance also has to be in a public subnet in the VPC\. **Not publicly accessible** to make the DB instance accessible only from inside the VPC\. For more information, see [Hiding a DB instance in a VPC from the internet](USER_VPC.WorkingWithRDSInstanceinaVPC.md#USER_VPC.Hiding)\. To connect to a DB instance from outside its VPC, the DB instance must be publicly accessible\. Also, access must be granted using the inbound rules of the DB instance's security group\. In addition, other requirements must be met\. For more information, see [Can't connect to Amazon RDS DB instance](CHAP_Troubleshooting.md#CHAP_Troubleshooting.Connecting)\. If your DB instance isn't publicly accessible, you can also use an AWS Site\-to\-Site VPN connection or an AWS Direct Connect connection to access it from a private network\. For more information, see [Internetwork traffic privacy](inter-network-traffic-privacy.md)\. | **CLI option:** `--publicly-accessible\|--no-publicly-accessible` **RDS API parameter:** `PubliclyAccessible` | The change occurs immediately\. This setting ignores the apply immediately setting\. | Downtime doesn't occur during this change\. | All DB engines | -| **Security group** The VPC security group that you want associated with the DB instance\. For more information, see [Controlling access with security groups](Overview.RDSSecurityGroups.md)\. | **CLI option:** `--vpc-security-group-ids` **RDS API parameter:** `VpcSecurityGroupIds` | The change is applied asynchronously, as soon as possible\. This setting ignores the apply immediately setting\. | Downtime doesn't occur during this change\. | All DB engines | -| **Storage autoscaling** **Enable storage autoscaling** to enable Amazon RDS to automatically increase storage when needed to avoid having your DB instance run out of storage space\. Use **Maximum storage threshold** to set the upper limit for Amazon RDS to automatically increase storage for your DB instance\. The default is 1,000 GiB\. For more information, see [Managing capacity automatically with Amazon RDS storage autoscaling](USER_PIOPS.StorageTypes.md#USER_PIOPS.Autoscaling)\. | **CLI option:** `--max-allocated-storage` **RDS API parameter:** `MaxAllocatedStorage` | The change occurs immediately\. This setting ignores the apply immediately setting\. | Downtime doesn't occur during this change\. | All DB engines | -| **Storage throughput** The new storage throughput value for the DB instance\. This setting is available only if you choose **General purpose SSD \(gp3\)** for **Storage type**\. For more information, see [Amazon RDS DB instance storage](CHAP_Storage.md)\. | **CLI option:** `--storage-throughput` **RDS API parameter:** `StorageThroughput` | If you choose to apply the change immediately, it occurs immediately\. If you don't choose to apply the change immediately, it occurs during the next maintenance window\. | Downtime doesn't occur during this change\. | All DB engines | -| **Storage type** The storage type that you want to use\. If you choose **General Purpose SSD \(gp3\)**, you can provision additional **Provisioned IOPS** and **Storage throughput** under **Advanced settings**\. If you choose **Provisioned IOPS SSD \(io1\)**, enter the **Provisioned IOPS** value\. After Amazon RDS begins to modify your DB instance to change the storage size or type, you can't submit another request to change the storage size, performance, or type for six hours\. For more information, see [Amazon RDS storage types](CHAP_Storage.md#Concepts.Storage)\. | **CLI option:** `--storage-type` **RDS API parameter:** `StorageType` | If you choose to apply the change immediately, it occurs immediately\. If you don't choose to apply the change immediately, it occurs during the next maintenance window\. | The following changes all result in a brief downtime while the process starts\. After that, you can use your database normally while the change takes place\. [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Overview.DBInstance.Modifying.html) | All DB engines | -| **DB subnet group** The DB subnet group for the DB instance\. You can use this setting to move your DB instance to a different VPC\. For more information, see [Amazon VPC VPCs and Amazon RDS](USER_VPC.md)\. | **CLI option:** `--db-subnet-group-name` **RDS API parameter:** `DBSubnetGroupName` | If you choose to apply the change immediately, it occurs immediately\. If you don't choose to apply the change immediately, it occurs during the next maintenance window\. | Downtime occurs during this change\. | All DB engines | \ No newline at end of file diff --git a/doc_source/Overview.DBInstance.Status.md b/doc_source/Overview.DBInstance.Status.md deleted file mode 100644 index f07147f..0000000 --- a/doc_source/Overview.DBInstance.Status.md +++ /dev/null @@ -1,41 +0,0 @@ -# DB instance status - -The status of a DB instance indicates the health of the DB instance\. You can view the status of a DB instance by using the Amazon RDS console, the AWS CLI command [describe\-db\-instances](https://docs.aws.amazon.com/cli/latest/reference/rds/describe-db-instances.html), or the API operation [DescribeDBInstances](https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_DescribeDBInstances.html)\. - -**Note** -Amazon RDS also uses another status called *maintenance status*, which is shown in the **Maintenance** column of the Amazon RDS console\. This value indicates the status of any maintenance patches that need to be applied to a DB instance\. Maintenance status is independent of DB instance status\. For more information on *maintenance status*, see [Applying updates for a DB instance](USER_UpgradeDBInstance.Maintenance.md#USER_UpgradeDBInstance.OSUpgrades)\. - -Find the possible status values for DB instances in the following table, which also shows how you are billed for each status\. It shows if you will be billed for the DB instance and storage, billed only for storage, or not billed\. For all DB instance statuses, you are always billed for backup usage\. - - -| DB instance status | Billed | Description | -| --- | --- | --- | -| **available** | Billed | The DB instance is healthy and available\. | -| **backing\-up** | Billed | The DB instance is currently being backed up\. | -| backtracking | Billed | The DB instance is currently being backtracked\. This status only applies to Aurora MySQL\. | -| **configuring\-enhanced\-monitoring** | Billed | Enhanced Monitoring is being enabled or disabled for this DB instance\. | -| **configuring\-iam\-database\-auth** | Billed | AWS Identity and Access Management \(IAM\) database authentication is being enabled or disabled for this DB instance\. | -| **configuring\-log\-exports** | Billed | Publishing log files to Amazon CloudWatch Logs is being enabled or disabled for this DB instance\. | -| **converting\-to\-vpc** | Billed | The DB instance is being converted from a DB instance that is not in an Amazon Virtual Private Cloud \(Amazon VPC\) to a DB instance that is in an Amazon VPC\. | -| **creating** | Not billed | The DB instance is being created\. The DB instance is inaccessible while it is being created\. | -| **deleting** | Not billed | The DB instance is being deleted\. | -| **failed** | Not billed | The DB instance has failed and Amazon RDS can't recover it\. Perform a point\-in\-time restore to the latest restorable time of the DB instance to recover the data\. | -| **inaccessible\-encryption\-credentials** | Not billed | The AWS KMS customer master key \(CMK\) used to encrypt or decrypt the DB instance can't be accessed\. | -| **incompatible\-network** | Not billed | Amazon RDS is attempting to perform a recovery action on a DB instance but can't do so because the VPC is in a state that prevents the action from being completed\. This status can occur if, for example, all available IP addresses in a subnet are in use and Amazon RDS can't get an IP address for the DB instance\. | -| **incompatible\-option\-group** | Billed | Amazon RDS attempted to apply an option group change but can't do so, and Amazon RDS can't roll back to the previous option group state\. For more information, check the **Recent Events** list for the DB instance\. This status can occur if, for example, the option group contains an option such as TDE and the DB instance doesn't contain encrypted information\. | -| **incompatible\-parameters** | Billed | Amazon RDS can't start the DB instance because the parameters specified in the DB instance's DB parameter group aren't compatible with the DB instance\. Revert the parameter changes or make them compatible with the DB instance to regain access to your DB instance\. For more information about the incompatible parameters, check the **Recent Events** list for the DB instance\. | -| **incompatible\-restore** | Not billed | Amazon RDS can't do a point\-in\-time restore\. Common causes for this status include using temp tables, using MyISAM tables with MySQL, or using Aria tables with MariaDB\. | -| insufficient\-capacity | | Amazon RDS can’t create your instance because sufficient capacity isn’t currently available\. To create your DB instance in the same AZ with the same instance type, delete your DB instance, wait a few hours, and try to create again\. Alternatively, create a new instance using a different instance class or AZ\. | -| **maintenance** | Billed | Amazon RDS is applying a maintenance update to the DB instance\. This status is used for instance\-level maintenance that RDS schedules well in advance\. | -| **modifying** | Billed | The DB instance is being modified because of a customer request to modify the DB instance\. | -| **moving\-to\-vpc** | Billed | The DB instance is being moved to a new Amazon Virtual Private Cloud \(Amazon VPC\)\. | -| **rebooting** | Billed | The DB instance is being rebooted because of a customer request or an Amazon RDS process that requires the rebooting of the DB instance\. | -| **resetting\-master\-credentials** | Billed | The master credentials for the DB instance are being reset because of a customer request to reset them\. | -| **renaming** | Billed | The DB instance is being renamed because of a customer request to rename it\. | -| **restore\-error** | Billed | The DB instance encountered an error attempting to restore to a point\-in\-time or from a snapshot\. | -| **starting** | Billed for storage | The DB instance is starting\. | -| **stopped** | Billed for storage | The DB instance is stopped\. | -| **stopping** | Billed for storage | The DB instance is being stopped\. | -| **storage\-full** | Billed | The DB instance has reached its storage capacity allocation\. This is a critical status, and we recommend that you fix this issue immediately\. To do so, scale up your storage by modifying the DB instance\. To avoid this situation, set Amazon CloudWatch alarms to warn you when storage space is getting low\. | -| **storage\-optimization** | Billed | Your DB instance is being modified to change the storage size or type\. The DB instance is fully operational\. However, while the status of your DB instance is **storage\-optimization**, you can't request any changes to the storage of your DB instance\. The storage optimization process is usually short, but can sometimes take up to and even beyond 24 hours\. | -| **upgrading** | Billed | The database engine version is being upgraded\. | \ No newline at end of file diff --git a/doc_source/Overview.DBInstance.md b/doc_source/Overview.DBInstance.md deleted file mode 100644 index 4dbd222..0000000 --- a/doc_source/Overview.DBInstance.md +++ /dev/null @@ -1,32 +0,0 @@ -# Amazon RDS DB instances - -A *DB instance* is an isolated database environment running in the cloud\. It is the basic building block of Amazon RDS\. A DB instance can contain multiple user\-created databases, and can be accessed using the same client tools and applications you might use to access a standalone database instance\. DB instances are simple to create and modify with the AWS command line tools, Amazon RDS API operations, or the AWS Management Console\. - -**Note** -Amazon RDS supports access to databases using any standard SQL client application\. Amazon RDS does not allow direct host access\. - -You can have up to 40 Amazon RDS DB instances, with the following limitations: -+ 10 for each SQL Server edition \(Enterprise, Standard, Web, and Express\) under the "license\-included" model -+ 10 for Oracle under the "license\-included" model -+ 40 for MySQL, MariaDB, or PostgreSQL -+ 40 for Oracle under the "bring\-your\-own\-license" \(BYOL\) licensing model - -**Note** -If your application requires more DB instances, you can request additional DB instances by using [this form](https://console.aws.amazon.com/support/home#/case/create?issueType=service-limit-increase&limitType=service-code-rds-instances)\. - -Each DB instance has a DB instance identifier\. This customer\-supplied name uniquely identifies the DB instance when interacting with the Amazon RDS API and AWS CLI commands\. The DB instance identifier must be unique for that customer in an AWS Region\. - -The identifier is used as part of the DNS hostname allocated to your instance by RDS\. For example, if you specify `db1` as the DB instance identifier, then RDS will automatically allocate a DNS endpoint for your instance, such as `db1.123456789012.us-east-1.rds.amazonaws.com`, where `123456789012` is the fixed identifier for a specific region for your account\. - -Each DB instance supports a database engine\. Amazon RDS currently supports MySQL, MariaDB, PostgreSQL, Oracle, Microsoft SQL Server, and Amazon Aurora database engines\. - -When creating a DB instance, some database engines require that a database name be specified\. A DB instance can host multiple databases, or a single Oracle database with multiple schemas\. The database name value depends on the database engine: -+ For the MySQL and MariaDB database engines, the database name is the name of a database hosted in your DB instance\. Databases hosted by the same DB instance must have a unique name within that instance\. -+ For the Oracle database engine, database name is used to set the value of ORACLE\_SID, which must be supplied when connecting to the Oracle RDS instance\. -+ For the Microsoft SQL Server database engine, database name is not a supported parameter\. -+ For the PostgreSQL database engine, the database name is the name of a database hosted in your DB instance\. A database name is not required when creating a DB instance\. Databases hosted by the same DB instance must have a unique name within that instance\. - -Amazon RDS creates a master user account for your DB instance as part of the creation process\. This master user has permissions to create databases and to perform create, delete, select, update, and insert operations on tables the master user creates\. You must set the master user password when you create a DB instance, but you can change it at any time using the AWS CLI, Amazon RDS API operations, or the AWS Management Console\. You can also change the master user password and manage users using standard SQL commands\. - -**Note** -This guide covers non\-Aurora Amazon RDS database engines\. For information about using Amazon Aurora, see the [https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/CHAP_AuroraOverview.html](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/CHAP_AuroraOverview.html)\. \ No newline at end of file diff --git a/doc_source/Overview.Encryption.Keys.md b/doc_source/Overview.Encryption.Keys.md deleted file mode 100644 index a9c3b67..0000000 --- a/doc_source/Overview.Encryption.Keys.md +++ /dev/null @@ -1,49 +0,0 @@ -# AWS KMS key management - -Amazon RDS automatically integrates with [AWS Key Management Service \(AWS KMS\)](https://docs.aws.amazon.com/kms/latest/developerguide/) for key management\. Amazon RDS uses envelope encryption\. For more information about envelope encryption, see [ Envelope encryption](https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#enveloping) in the *AWS Key Management Service Developer Guide*\. - -You can use two types of AWS KMS keys to encrypt your DB instances\. -+ If you want full control over a KMS key, you must create a *customer managed key*\. For more information about customer managed keys, see [Customer managed keys](https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#customer-cmk) in the *AWS Key Management Service Developer Guide*\. - - You can't share a snapshot that has been encrypted using the AWS managed key of the AWS account that shared the snapshot\. -+ *AWS managed keys* are KMS keys in your account that are created, managed, and used on your behalf by an AWS service that is integrated with AWS KMS\. By default, the RDS AWS managed key \(`aws/rds`\) is used for encryption\. You can't manage, rotate, or delete the RDS AWS managed key\. For more information about AWS managed keys, see [AWS managed keys](https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#aws-managed-cmk) in the *AWS Key Management Service Developer Guide*\. - -To manage KMS keys used for Amazon RDS encrypted DB instances, use the [AWS Key Management Service \(AWS KMS\)](https://docs.aws.amazon.com/kms/latest/developerguide/) in the [AWS KMS console](https://console.aws.amazon.com/kms), the AWS CLI, or the AWS KMS API\. To view audit logs of every action taken with an AWS managed or customer managed key, use [AWS CloudTrail](https://docs.aws.amazon.com/awscloudtrail/latest/userguide/)\. For more information about key rotation, see [Rotating AWS KMS keys](https://docs.aws.amazon.com/kms/latest/developerguide/rotate-keys.html)\. - -**Important** -If you turn off or revoke permissions to a KMS key used by an RDS database, RDS puts your database into a terminal state when access to the KMS key is required\. This change could be immediate, or deferred, depending on the use case that required access to the KMS key\. In this state, the DB instance is no longer available, and the current state of the database can't be recovered\. To restore the DB instance, you must re\-enable access to the KMS key for RDS, and then restore the DB instance from the latest available backup\. - -## Authorizing use of a customer managed key - -When RDS uses a customer managed key in cryptographic operations, it acts on behalf of the user who is creating or changing the RDS resource\. - -To create an RDS resource using a customer managed key, a user must have permissions to call the following operations on the customer managed key: -+ kms:CreateGrant -+ kms:DescribeKey - -You can specify these required permissions in a key policy, or in an IAM policy if the key policy allows it\. - -You can make the IAM policy stricter in various ways\. For example, if you want to allow the customer managed key to be used only for requests that originate in RDS, you can use the [ kms:ViaService condition key](https://docs.aws.amazon.com/kms/latest/developerguide/policy-conditions.html#conditions-kms-via-service) with the `rds..amazonaws.com` value\. Also, you can use the keys or values in the [Amazon RDS encryption context](#Overview.Encryption.Keys.encryptioncontext) as a condition for using the customer managed key for encryption\. - -For more information, see [Allowing users in other accounts to use a KMS key](https://docs.aws.amazon.com/kms/latest/developerguide/key-policy-modifying-external-accounts.html) in the *AWS Key Management Service Developer Guide* and [Key policies in AWS KMS](https://docs.aws.amazon.com/kms/latest/developerguide/key-policies)\. - -## Amazon RDS encryption context - -When RDS uses your KMS key, or when Amazon EBS uses the KMS key on behalf of RDS, the service specifies an [encryption context](https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#encrypt_context)\. The encryption context is [additional authenticated data](https://docs.aws.amazon.com/crypto/latest/userguide/cryptography-concepts.html#term-aad) \(AAD\) that AWS KMS uses to ensure data integrity\. When an encryption context is specified for an encryption operation, the service must specify the same encryption context for the decryption operation\. Otherwise, decryption fails\. The encryption context is also written to your [AWS CloudTrail](https://aws.amazon.com/cloudtrail/) logs to help you understand why a given KMS key was used\. Your CloudTrail logs might contain many entries describing the use of a KMS key, but the encryption context in each log entry can help you determine the reason for that particular use\. - -At minimum, Amazon RDS always uses the DB instance ID for the encryption context, as in the following JSON\-formatted example: - -``` -{ "aws:rds:db-id": "db-CQYSMDPBRZ7BPMH7Y3RTDG5QY" } -``` - -This encryption context can help you identify the DB instance for which your KMS key was used\. - -When your KMS key is used for a specific DB instance and a specific Amazon EBS volume, both the DB instance ID and the Amazon EBS volume ID are used for the encryption context, as in the following JSON\-formatted example: - -``` -{ - "aws:rds:db-id": "db-BRG7VYS3SVIFQW7234EJQOM5RQ", - "aws:ebs:id": "vol-ad8c6542" -} -``` \ No newline at end of file diff --git a/doc_source/Overview.Encryption.md b/doc_source/Overview.Encryption.md deleted file mode 100644 index 713d5ad..0000000 --- a/doc_source/Overview.Encryption.md +++ /dev/null @@ -1,112 +0,0 @@ -# Encrypting Amazon RDS resources - -Amazon RDS can encrypt your Amazon RDS DB instances\. Data that is encrypted at rest includes the underlying storage for DB instances, its automated backups, read replicas, and snapshots\. - -Amazon RDS encrypted DB instances use the industry standard AES\-256 encryption algorithm to encrypt your data on the server that hosts your Amazon RDS DB instances\. After your data is encrypted, Amazon RDS handles authentication of access and decryption of your data transparently with a minimal impact on performance\. You don't need to modify your database client applications to use encryption\. - -**Note** -For encrypted and unencrypted DB instances, data that is in transit between the source and the read replicas is encrypted, even when replicating across AWS Regions\. - -**Topics** -+ [Overview of encrypting Amazon RDS resources](#Overview.Encryption.Overview) -+ [Encrypting a DB instance](#Overview.Encryption.Enabling) -+ [Determining whether encryption is turned on for a DB instance](#Overview.Encryption.Determining) -+ [Availability of Amazon RDS encryption](#Overview.Encryption.Availability) -+ [Limitations of Amazon RDS encrypted DB instances](#Overview.Encryption.Limitations) - -## Overview of encrypting Amazon RDS resources - -Amazon RDS encrypted DB instances provide an additional layer of data protection by securing your data from unauthorized access to the underlying storage\. You can use Amazon RDS encryption to increase data protection of your applications deployed in the cloud, and to fulfill compliance requirements for encryption at rest\. - -For an Amazon RDS encrypted DB instance, all logs, backups, and snapshots are encrypted\. Amazon RDS uses an AWS KMS key to encrypt these resources\. For more information about KMS keys, see [AWS KMS keys](https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#kms_keys) in the *AWS Key Management Service Developer Guide* and [AWS KMS key management](Overview.Encryption.Keys.md)\. If you copy an encrypted snapshot, you can use a different KMS key to encrypt the target snapshot than the one that was used to encrypt the source snapshot\. - -A read replica of an Amazon RDS encrypted instance must be encrypted using the same KMS key as the primary DB instance when both are in the same AWS Region\. If the primary DB instance and read replica are in different AWS Regions, you encrypt the read replica using the KMS key for that AWS Region\. - -You can use an AWS managed key, or you can create customer managed keys\. To manage the customer managed keys used for encrypting and decrypting your Amazon RDS resources, you use the [AWS Key Management Service \(AWS KMS\)](https://docs.aws.amazon.com/kms/latest/developerguide/)\. AWS KMS combines secure, highly available hardware and software to provide a key management system scaled for the cloud\. Using AWS KMS, you can create customer managed keys and define the policies that control how these customer managed keys can be used\. AWS KMS supports CloudTrail, so you can audit KMS key usage to verify that customer managed keys are being used appropriately\. You can use your customer managed keys with Amazon Aurora and supported AWS services such as Amazon S3, Amazon EBS, and Amazon Redshift\. For a list of services that are integrated with AWS KMS, see [AWS Service Integration](http://aws.amazon.com/kms/features/#AWS_Service_Integration)\. - -Amazon RDS also supports encrypting an Oracle or SQL Server DB instance with Transparent Data Encryption \(TDE\)\. TDE can be used with RDS encryption at rest, although using TDE and RDS encryption at rest simultaneously might slightly affect the performance of your database\. You must manage different keys for each encryption method\. For more information on TDE, see [Oracle Transparent Data Encryption](Appendix.Oracle.Options.AdvSecurity.md) or [Support for Transparent Data Encryption in SQL Server](Appendix.SQLServer.Options.TDE.md)\. - -## Encrypting a DB instance - -To encrypt a new DB instance, choose **Enable encryption** on the Amazon RDS console\. For information on creating a DB instance, see [Creating an Amazon RDS DB instance](USER_CreateDBInstance.md)\. - -If you use the [create\-db\-instance](https://docs.aws.amazon.com/cli/latest/reference/rds/create-db-instance.html) AWS CLI command to create an encrypted DB instance, set the `--storage-encrypted` parameter\. If you use the [CreateDBInstance](https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_CreateDBInstance.html) API operation, set the `StorageEncrypted` parameter to true\. - -When you create an encrypted DB instance, you can choose a customer managed key or the AWS managed key for Amazon RDS to encrypt your DB instance\. If you don't specify the key identifier for a customer managed key, Amazon RDS uses the AWS managed key for your new DB instance\. Amazon RDS creates an AWS managed key for Amazon RDS for your AWS account\. Your AWS account has a different AWS managed key for Amazon RDS for each AWS Region\. - -For more information about KMS keys, see [AWS KMS keys](https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#kms_keys) in the *AWS Key Management Service Developer Guide*\. - -Once you have created an encrypted DB instance, you can't change the KMS key used by that DB instance\. Therefore, be sure to determine your KMS key requirements before you create your encrypted DB instance\. - -If you use the AWS CLI `create-db-instance` command to create an encrypted DB instance with a customer managed key, set the `--kms-key-id` parameter to any key identifier for the KMS key\. If you use the Amazon RDS API `CreateDBInstance` operation, set the `KmsKeyId` parameter to any key identifier for the KMS key\. To use a customer managed key in a different AWS account, specify the key ARN or alias ARN\. - -**Important** -Amazon RDS can lose access to the KMS key for a DB instance\. For example, RDS loses access when the KMS key isn't enabled, or when RDS access to a KMS key is revoked\. In these cases, the encrypted DB instance goes into `inaccessible-encryption-credentials-recoverable` state\. The DB instance remains in this state for seven days\. When you start the DB instance during that time, it checks if the KMS key is active and recovers the DB instance if it is\. Restart the DB instance using the AWS CLI command [start\-db\-instance](https://docs.aws.amazon.com/cli/latest/reference/rds/start-db-instance.html) or AWS Management Console\. -If the DB instance isn't recovered, then it goes into the terminal `inaccessible-encryption-credentials` state\. In this case, you can only restore the DB instance from a backup\. We strongly recommend that you always turn on backups for encrypted DB instances to guard against the loss of encrypted data in your databases\. - -## Determining whether encryption is turned on for a DB instance - -You can use the AWS Management Console, AWS CLI, or RDS API to determine whether encryption at rest is turned on for a DB instance\. - -### Console - -**To determine whether encryption at rest is turned on for a DB instance** - -1. Sign in to the AWS Management Console and open the Amazon RDS console at [https://console\.aws\.amazon\.com/rds/](https://console.aws.amazon.com/rds/)\. - -1. In the navigation pane, choose **Databases**\. - -1. Choose the name of the DB instance that you want to check to view its details\. - -1. Choose the **Configuration** tab, and check the **Encryption** value under **Storage**\. - - It shows either **Enabled** or **Not enabled**\. -![\[Checking encryption at rest for a DB instance\]](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/images/encryption-check-db-instance.png) - -### AWS CLI - -To determine whether encryption at rest is turned on for a DB instance by using the AWS CLI, call the [describe\-db\-instances](https://docs.aws.amazon.com/cli/latest/reference/rds/describe-db-instances.html) command with the following option: -+ `--db-instance-identifier` – The name of the DB instance\. - -The following example uses a query to return either `TRUE` or `FALSE` regarding encryption at rest for the `mydb` DB instance\. - -**Example** - -``` -1. aws rds describe-db-instances --db-instance-identifier mydb --query "*[].{StorageEncrypted:StorageEncrypted}" --output text -``` - -### RDS API - -To determine whether encryption at rest is turned on for a DB instance by using the Amazon RDS API, call the [DescribeDBInstances](https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_DescribeDBInstances.html) operation with the following parameter: -+ `DBInstanceIdentifier` – The name of the DB instance\. - -## Availability of Amazon RDS encryption - -Amazon RDS encryption is currently available for all database engines and storage types, except for SQL Server Express Edition\. - -Amazon RDS encryption is available for most DB instance classes\. The following table lists DB instance classes that *don't support* Amazon RDS encryption: - - -| Instance type | Instance class | -| --- | --- | -| General purpose \(M1\) | db\.m1\.small db\.m1\.medium db\.m1\.large db\.m1\.xlarge | -| Memory optimized \(M2\) | db\.m2\.xlarge db\.m2\.2xlarge db\.m2\.4xlarge | -| Burstable \(T2\) | db\.t2\.micro | - -## Limitations of Amazon RDS encrypted DB instances - -The following limitations exist for Amazon RDS encrypted DB instances: -+ You can only encrypt an Amazon RDS DB instance when you create it, not after the DB instance is created\. - - However, because you can encrypt a copy of an unencrypted snapshot, you can effectively add encryption to an unencrypted DB instance\. That is, you can create a snapshot of your DB instance, and then create an encrypted copy of that snapshot\. You can then restore a DB instance from the encrypted snapshot, and thus you have an encrypted copy of your original DB instance\. For more information, see [Copying a DB snapshot](USER_CopySnapshot.md)\. -+ You can't turn off encryption on an encrypted DB instance\. -+ You can't create an encrypted snapshot of an unencrypted DB instance\. -+ A snapshot of an encrypted DB instance must be encrypted using the same KMS key as the DB instance\. -+ You can't have an encrypted read replica of an unencrypted DB instance or an unencrypted read replica of an encrypted DB instance\. -+ Encrypted read replicas must be encrypted with the same KMS key as the source DB instance when both are in the same AWS Region\. -+ You can't restore an unencrypted backup or snapshot to an encrypted DB instance\. -+ To copy an encrypted snapshot from one AWS Region to another, you must specify the KMS key in the destination AWS Region\. This is because KMS keys are specific to the AWS Region that they are created in\. - - The source snapshot remains encrypted throughout the copy process\. Amazon RDS uses envelope encryption to protect data during the copy process\. For more information about envelope encryption, see [ Envelope encryption](https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#enveloping) in the *AWS Key Management Service Developer Guide*\. -+ You can't unencrypt an encrypted DB instance\. However, you can export data from an encrypted DB instance and import the data into an unencrypted DB instance\. \ No newline at end of file diff --git a/doc_source/Overview.LoggingAndMonitoring.md b/doc_source/Overview.LoggingAndMonitoring.md deleted file mode 100644 index 2b91073..0000000 --- a/doc_source/Overview.LoggingAndMonitoring.md +++ /dev/null @@ -1,35 +0,0 @@ -# Logging and monitoring in Amazon RDS - -Monitoring is an important part of maintaining the reliability, availability, and performance of Amazon RDS and your AWS solutions\. You should collect monitoring data from all of the parts of your AWS solution so that you can more easily debug a multi\-point failure if one occurs\. AWS provides several tools for monitoring your Amazon RDS resources and responding to potential incidents: - -**Amazon CloudWatch Alarms** -Using Amazon CloudWatch alarms, you watch a single metric over a time period that you specify\. If the metric exceeds a given threshold, a notification is sent to an Amazon SNS topic or AWS Auto Scaling policy\. CloudWatch alarms do not invoke actions because they are in a particular state\. Rather the state must have changed and been maintained for a specified number of periods\. - -**AWS CloudTrail Logs** -CloudTrail provides a record of actions taken by a user, role, or an AWS service in Amazon RDS\. CloudTrail captures all API calls for Amazon RDS as events, including calls from the console and from code calls to Amazon RDS API operations\. Using the information collected by CloudTrail, you can determine the request that was made to Amazon RDS, the IP address from which the request was made, who made the request, when it was made, and additional details\. For more information, see [Monitoring Amazon RDS API calls in AWS CloudTrail](logging-using-cloudtrail.md)\. - -**Enhanced Monitoring** -Amazon RDS provides metrics in real time for the operating system \(OS\) that your DB instance runs on\. You can view the metrics for your DB instance using the console, or consume the Enhanced Monitoring JSON output from Amazon CloudWatch Logs in a monitoring system of your choice\. For more information, see [Monitoring OS metrics with Enhanced Monitoring](USER_Monitoring.OS.md)\. - -**Amazon RDS Performance Insights** -Performance Insights expands on existing Amazon RDS monitoring features to illustrate your database's performance and help you analyze any issues that affect it\. With the Performance Insights dashboard, you can visualize the database load and filter the load by waits, SQL statements, hosts, or users\. For more information, see [Monitoring DB load with Performance Insights on Amazon RDS](USER_PerfInsights.md)\. - -**Database Logs** -You can view, download, and watch database logs using the AWS Management Console, AWS CLI, or RDS API\. For more information, see [Monitoring Amazon RDS log files](USER_LogAccess.md)\. - -**Amazon RDS Recommendations** -Amazon RDS provides automated recommendations for database resources\. These recommendations provide best practice guidance by analyzing DB instance configuration, usage, and performance data\. For more information, see [Viewing Amazon RDS recommendations](accessing-monitoring.md#USER_Recommendations)\. - -**Amazon RDS Event Notification** -Amazon RDS uses the Amazon Simple Notification Service \(Amazon SNS\) to provide notification when an Amazon RDS event occurs\. These notifications can be in any notification form supported by Amazon SNS for an AWS Region, such as an email, a text message, or a call to an HTTP endpoint\. For more information, see [Working with Amazon RDS event notification](USER_Events.md)\. - -**AWS Trusted Advisor** -Trusted Advisor draws upon best practices learned from serving hundreds of thousands of AWS customers\. Trusted Advisor inspects your AWS environment and then makes recommendations when opportunities exist to save money, improve system availability and performance, or help close security gaps\. All AWS customers have access to five Trusted Advisor checks\. Customers with a Business or Enterprise support plan can view all Trusted Advisor checks\. -Trusted Advisor has the following Amazon RDS\-related checks: -+ Amazon RDS Idle DB Instances -+ Amazon RDS Security Group Access Risk -+ Amazon RDS Backups -+ Amazon RDS Multi\-AZ -For more information on these checks, see [Trusted Advisor best practices \(checks\)](https://aws.amazon.com/premiumsupport/trustedadvisor/best-practices/)\. - -For more information about monitoring Amazon RDS, see [Monitoring metrics in an Amazon RDS instance](CHAP_Monitoring.md)\. \ No newline at end of file diff --git a/doc_source/Overview.RDSSecurityGroups.md b/doc_source/Overview.RDSSecurityGroups.md deleted file mode 100644 index 6cefadc..0000000 --- a/doc_source/Overview.RDSSecurityGroups.md +++ /dev/null @@ -1,47 +0,0 @@ -# Controlling access with security groups - -VPC security groups control the access that traffic has in and out of a DB instance\. By default, network access is turned off for a DB instance\. You can specify rules in a security group that allow access from an IP address range, port, or security group\. After ingress rules are configured, the same rules apply to all DB instances that are associated with that security group\. You can specify up to 20 rules in a security group\. - -## Overview of VPC security groups - -Each VPC security group rule makes it possible for a specific source to access a DB instance in a VPC that is associated with that VPC security group\. The source can be a range of addresses \(for example, 203\.0\.113\.0/24\), or another VPC security group\. By specifying a VPC security group as the source, you allow incoming traffic from all instances \(typically application servers\) that use the source VPC security group\. VPC security groups can have rules that govern both inbound and outbound traffic\. However, the outbound traffic rules typically don't apply to DB instances\. Outbound traffic rules apply only if the DB instance acts as a client\. For example, outbound traffic rules apply to an Oracle DB instance with outbound database links\. You must use the [Amazon EC2 API](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Welcome.html) or the **Security Group** option on the VPC console to create VPC security groups\. - -When you create rules for your VPC security group that allow access to the instances in your VPC, you must specify a port for each range of addresses that the rule allows access for\. For example, if you want to turn on Secure Shell \(SSH\) access for instances in the VPC, create a rule allowing access to TCP port 22 for the specified range of addresses\. - -You can configure multiple VPC security groups that allow access to different ports for different instances in your VPC\. For example, you can create a VPC security group that allows access to TCP port 80 for web servers in your VPC\. You can then create another VPC security group that allows access to TCP port 3306 for RDS for MySQL DB instances in your VPC\. - -For more information on VPC security groups, see [Security groups](https://docs.aws.amazon.com/vpc/latest/userguide/VPC_SecurityGroups.html) in the *Amazon Virtual Private Cloud User Guide*\. - -**Note** -If your DB instance is in a VPC but isn't publicly accessible, you can also use an AWS Site\-to\-Site VPN connection or an AWS Direct Connect connection to access it from a private network\. For more information, see [Internetwork traffic privacy](inter-network-traffic-privacy.md)\. - -## Security group scenario - -A common use of a DB instance in a VPC is to share data with an application server running in an Amazon EC2 instance in the same VPC, which is accessed by a client application outside the VPC\. For this scenario, you use the RDS and VPC pages on the AWS Management Console or the RDS and EC2 API operations to create the necessary instances and security groups: - -1. Create a VPC security group \(for example, `sg-0123ec2example`\) and define inbound rules that use the IP addresses of the client application as the source\. This security group allows your client application to connect to EC2 instances in a VPC that uses this security group\. - -1. Create an EC2 instance for the application and add the EC2 instance to the VPC security group \(`sg-0123ec2example`\) that you created in the previous step\. - -1. Create a second VPC security group \(for example, `sg-6789rdsexample`\) and create a new rule by specifying the VPC security group that you created in step 1 \(`sg-0123ec2example`\) as the source\. - -1. Create a new DB instance and add the DB instance to the VPC security group \(`sg-6789rdsexample`\) that you created in the previous step\. When you create the DB instance, use the same port number as the one specified for the VPC security group \(`sg-6789rdsexample`\) rule that you created in step 3\. - -The following diagram shows this scenario\. - -![\[DB instance and EC2 instance in a VPC\]](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/images/con-VPC-sec-grp.png) - -For detailed instructions about configuring a VPC for this scenario, see [Tutorial: Create a VPC for use with a DB instance \(IPv4 only\)](CHAP_Tutorials.WebServerDB.CreateVPC.md)\. For more information about using a VPC, see [Amazon VPC VPCs and Amazon RDS](USER_VPC.md)\. - -## Creating a VPC security group - -You can create a VPC security group for a DB instance by using the VPC console\. For information about creating a security group, see [Provide access to your DB instance in your VPC by creating a security group](CHAP_SettingUp.md#CHAP_SettingUp.SecurityGroup) and [Security groups](https://docs.aws.amazon.com/vpc/latest/userguide/VPC_SecurityGroups.html) in the *Amazon Virtual Private Cloud User Guide*\. - -## Associating a security group with a DB instance - -You can associate a security group with a DB instance by using **Modify** on the RDS console, the `ModifyDBInstance` Amazon RDS API, or the `modify-db-instance` AWS CLI command\. - - For information about modifying a DB instance, see [Modifying an Amazon RDS DB instance](Overview.DBInstance.Modifying.md)\. For security group considerations when you restore a DB instance from a DB snapshot, see [Security group considerations](USER_RestoreFromSnapshot.md#USER_RestoreFromSnapshot.Security)\. - -**Note** -The RDS console displays different security group rule names for your database if the Port value is configured to a non\-default value\. \ No newline at end of file diff --git a/doc_source/PostgreSQL-Collations.md b/doc_source/PostgreSQL-Collations.md deleted file mode 100644 index 5a251ca..0000000 --- a/doc_source/PostgreSQL-Collations.md +++ /dev/null @@ -1,11 +0,0 @@ -# Collations supported in RDS for PostgreSQL - -Collations are set of rules that determine how character strings stored in the database are sorted and compared\. Collations play a fundamental role in the computer system and are included as part of the operating system\. Collations change over time when new characters are added to languages or when ordering rules change\. - -Collation libraries define specific rules and algorithms for a collation\. The most popular collation libraries used within PostgreSQL are GNU C \(glibc\) and Internationalization components for Unicode \(ICU\)\. By default, RDS for PostgreSQL uses the glibc collation that includes unicode character sort orders for multi\-byte character sequences\. - -When you create a new DB instance in RDS for PostgreSQL , it checks the operating system for the available collation\. The PostgreSQL parameters of the `CREATE DATABASE` command `LC_COLLATE` and `LC_CTYPE` are used to specify a collation, which stands as the default collation in that database\. Alternatively, you can also use the `LOCALE` parameter in `CREATE DATABASE` to set these parameters\. This determines the default collation for character strings in the database and the rules for classifying characters as letters, numbers, or symbols\. You can also choose a collation to use on a column, index, or on a query\. - -RDS for PostgreSQL depends on the glibc library in the operating system for collation support\. RDS for PostgreSQL instance is periodically updated with the latest versions of the operating system\. These updates sometimes include a newer version of the glibc library\. Rarely, newer versions of glibc change the sort order or collation of some characters, which can cause the data to sort differently or produce invalid index entries\. If you discover sort order issues for collation during an update, you might need to rebuild the indexes\. - -To reduce the possible impacts of the glibc updates, RDS for PostgreSQL now includes an independent default collation library\. This collation library is available in RDS for PostgreSQL 14\.6, 13\.9, 12\.13, 11\.18, 10\.23 and newer minor version releases\. It is compatible with glibc 2\.26\-59\.amzn2, and provides sort order stability to prevent incorrect query results\. \ No newline at end of file diff --git a/doc_source/PostgreSQL-Lambda-functions.md b/doc_source/PostgreSQL-Lambda-functions.md deleted file mode 100644 index 1a2297e..0000000 --- a/doc_source/PostgreSQL-Lambda-functions.md +++ /dev/null @@ -1,140 +0,0 @@ -# AWS Lambda function reference - -Following is the reference for the functions to use for invoking Lambda functions with RDS for PostgreSQL\. - -**Topics** -+ [aws\_lambda\.invoke](#aws_lambda.invoke) -+ [aws\_commons\.create\_lambda\_function\_arn](#aws_commons.create_lambda_function_arn) - -## aws\_lambda\.invoke - -Runs a Lambda function for an RDS for PostgreSQL DB instance\. - -For more details about invoking Lambda functions, see also [Invoke](https://docs.aws.amazon.com/lambda/latest/dg/API_Invoke.html) in the *AWS Lambda Developer Guide\.* - -**Syntax** - ------- -#### [ JSON ] - -``` -aws_lambda.invoke( -IN function_name TEXT, -IN payload JSON, -IN region TEXT DEFAULT NULL, -IN invocation_type TEXT DEFAULT 'RequestResponse', -IN log_type TEXT DEFAULT 'None', -IN context JSON DEFAULT NULL, -IN qualifier VARCHAR(128) DEFAULT NULL, -OUT status_code INT, -OUT payload JSON, -OUT executed_version TEXT, -OUT log_result TEXT) -``` - -``` -aws_lambda.invoke( -IN function_name aws_commons._lambda_function_arn_1, -IN payload JSON, -IN invocation_type TEXT DEFAULT 'RequestResponse', -IN log_type TEXT DEFAULT 'None', -IN context JSON DEFAULT NULL, -IN qualifier VARCHAR(128) DEFAULT NULL, -OUT status_code INT, -OUT payload JSON, -OUT executed_version TEXT, -OUT log_result TEXT) -``` - ------- -#### [ JSONB ] - -``` -aws_lambda.invoke( -IN function_name TEXT, -IN payload JSONB, -IN region TEXT DEFAULT NULL, -IN invocation_type TEXT DEFAULT 'RequestResponse', -IN log_type TEXT DEFAULT 'None', -IN context JSONB DEFAULT NULL, -IN qualifier VARCHAR(128) DEFAULT NULL, -OUT status_code INT, -OUT payload JSONB, -OUT executed_version TEXT, -OUT log_result TEXT) -``` - -``` -aws_lambda.invoke( -IN function_name aws_commons._lambda_function_arn_1, -IN payload JSONB, -IN invocation_type TEXT DEFAULT 'RequestResponse', -IN log_type TEXT DEFAULT 'None', -IN context JSONB DEFAULT NULL, -IN qualifier VARCHAR(128) DEFAULT NULL, -OUT status_code INT, -OUT payload JSONB, -OUT executed_version TEXT, -OUT log_result TEXT -) -``` - -------Input parameters - -**function\_name** -The identifying name of the Lambda function\. The value can be the function name, an ARN, or a partial ARN\. For a listing of possible formats, see [ Lambda function name formats](https://docs.aws.amazon.com/lambda/latest/dg/API_Invoke.html#API_Invoke_RequestParameters) in the *AWS Lambda Developer Guide\.* - -*payload* -The input for the Lambda function\. The format can be JSON or JSONB\. For more information, see [JSON Types](https://www.postgresql.org/docs/current/datatype-json.html) in the PostgreSQL documentation\. - -*region* -\(Optional\) The Lambda Region for the function\. By default, RDS resolves the AWS Region from the full ARN in the `function_name` or it uses the RDS for PostgreSQL DB instance Region\. If this Region value conflicts with the one provided in the `function_name` ARN, an error is raised\. - -*invocation\_type* -The invocation type of the Lambda function\. The value is case\-sensitive\. Possible values include the following: -+ `RequestResponse` – The default\. This type of invocation for a Lambda function is synchronous and returns a response payload in the result\. Use the `RequestResponse` invocation type when your workflow depends on receiving the Lambda function result immediately\. -+ `Event` – This type of invocation for a Lambda function is asynchronous and returns immediately without a returned payload\. Use the `Event` invocation type when you don't need results of the Lambda function before your workflow moves on\. -+ `DryRun` – This type of invocation tests access without running the Lambda function\. - -*log\_type* -The type of Lambda log to return in the `log_result` output parameter\. The value is case\-sensitive\. Possible values include the following: -+ Tail – The returned `log_result` output parameter will include the last 4 KB of the execution log\. -+ None – No Lambda log information is returned\. - -*context* -Client context in JSON or JSONB format\. Fields to use include than `custom` and `env`\. - -*qualifier* -A qualifier that identifies a Lambda function's version to be invoked\. If this value conflicts with one provided in the `function_name` ARN, an error is raised\.Output parameters - -*status\_code* -An HTTP status response code\. For more information, see [Lambda Invoke response elements](https://docs.aws.amazon.com/lambda/latest/dg/API_Invoke.html#API_Invoke_ResponseElements) in the *AWS Lambda Developer Guide\.* - -*payload* -The information returned from the Lambda function that ran\. The format is in JSON or JSONB\. - -*executed\_version* -The version of the Lambda function that ran\. - -*log\_result* -The execution log information returned if the `log_type` value is `Tail` when the Lambda function was invoked\. The result contains the last 4 KB of the execution log encoded in Base64\. - -## aws\_commons\.create\_lambda\_function\_arn - -Creates an `aws_commons._lambda_function_arn_1` structure to hold Lambda function name information\. You can use the results of the `aws_commons.create_lambda_function_arn` function in the `function_name` parameter of the aws\_lambda\.invoke [aws\_lambda\.invoke](#aws_lambda.invoke) function\. - -**Syntax** - -``` -aws_commons.create_lambda_function_arn( - function_name TEXT, - region TEXT DEFAULT NULL - ) - RETURNS aws_commons._lambda_function_arn_1 -```Input parameters - -*function\_name* -A required text string containing the Lambda function name\. The value can be a function name, a partial ARN, or a full ARN\. - -*region* -An optional text string containing the AWS Region that the Lambda function is in\. For a listing of Region names and associated values, see [Regions, Availability Zones, and Local Zones](Concepts.RegionsAndAvailabilityZones.md)\. \ No newline at end of file diff --git a/doc_source/PostgreSQL-Lambda.md b/doc_source/PostgreSQL-Lambda.md deleted file mode 100644 index c8691d8..0000000 --- a/doc_source/PostgreSQL-Lambda.md +++ /dev/null @@ -1,336 +0,0 @@ -# Invoking an AWS Lambda function from an RDS for PostgreSQL DB instance - -AWS Lambda is an event\-driven compute service that lets you run code without provisioning or managing servers\. It's available for use with many AWS services, including RDS for PostgreSQL\. For example, you can use Lambda functions to process event notifications from a database, or to load data from files whenever a new file is uploaded to Amazon S3\. To learn more about Lambda, see [What is AWS Lambda?](https://docs.aws.amazon.com/lambda/latest/dg/welcome.html) in the *AWS Lambda Developer Guide\.* - -**Note** -Invoking an AWS Lambda function is supported in these RDS for PostgreSQL versions: -All PostgreSQL 15 versions -PostgreSQL 14\.1 and higher minor versions -PostgreSQL 13\.2 and higher minor versions -PostgreSQL 12\.6 and higher minor versions - -Setting up RDS for PostgreSQL to work with Lambda functions is a multi\-step process involving AWS Lambda, IAM, your VPC, and your RDS for PostgreSQL DB instance\. Following, you can find summaries of the necessary steps\. - -For more information about Lambda functions, see [Getting started with Lambda](https://docs.aws.amazon.com/lambda/latest/dg/getting-started.html) and [AWS Lambda foundations](https://docs.aws.amazon.com/lambda/latest/dg/lambda-foundation.html) in the *AWS Lambda Developer Guide*\. - -**Topics** -+ [Step 1: Configure your RDS for PostgreSQL DB instance for outbound connections to AWS Lambda](#PostgreSQL-Lambda-network) -+ [Step 2: Configure IAM for your RDS for PostgreSQL DB instance and AWS Lambda](#PostgreSQL-Lambda-access) -+ [Step 3: Install the `aws_lambda` extension for an RDS for PostgreSQL DB instance](#PostgreSQL-Lambda-install-extension) -+ [Step 4: Use Lambda helper functions with your RDS for PostgreSQL DB instance \(Optional\)](#PostgreSQL-Lambda-specify-function) -+ [Step 5: Invoke a Lambda function from your RDS for PostgreSQL DB instance](#PostgreSQL-Lambda-invoke) -+ [Step 6: Grant other users permission to invoke Lambda functions](#PostgreSQL-Lambda-grant-users-permissions) -+ [Examples: Invoking Lambda functions from your RDS for PostgreSQL DB instance](#PostgreSQL-Lambda-examples) -+ [Lambda function error messages](#PostgreSQL-Lambda-errors) -+ [AWS Lambda function reference](PostgreSQL-Lambda-functions.md) - -## Step 1: Configure your RDS for PostgreSQL DB instance for outbound connections to AWS Lambda - -Lambda functions always run inside an Amazon VPC that's owned by the AWS Lambda service\. Lambda applies network access and security rules to this VPC and it maintains and monitors the VPC automatically\. Your RDS for PostgreSQL DB instance sends network traffic to the Lambda service's VPC\. How you configure this depends on whether your DB instance is public or private\. -+ **Public RDS for PostgreSQL DB instance** – A DB instance is public if it's located in a public subnet on your VPC, and if the instance's "PubliclyAccessible" property is `true`\. To find the value of this property, you can use the [describe\-db\-instances](https://docs.aws.amazon.com/cli/latest/reference/rds/describe-db-instances.html) AWS CLI command\. Or, you can use the AWS Management Console to open the **Connectivity & security** tab and check that **Publicly accessible** is **Yes**\. To verify that the instance is in the public subnet of your VPC, you can use the AWS Management Console or the AWS CLI\. - - To set up access to Lambda, you use the AWS Management Console or the AWS CLI to create an outbound rule on your VPC's security group\. The outbound rule specifies that TCP can use port 443 to send packets to any IPv4 addresses \(0\.0\.0\.0/0\)\. -+ **Private RDS for PostgreSQL DB instance** – In this case, the instance's "PubliclyAccessible" property is `false` or it's in a private subnet\. To allow the instance to work with Lambda, you can use a Network Address Translation\) NAT gateway\. For more information, see [NAT gateways](https://docs.aws.amazon.com/vpc/latest/userguide/vpc-nat-gateway.html)\. Or, you can configure your VPC with a VPC endpoint for Lambda\. For more information, see [VPC endpoints](https://docs.aws.amazon.com/vpc/latest/userguide/vpc-endpoints.html) in the *Amazon VPC User Guide*\. The endpoint responds to calls made by your RDS for PostgreSQL DB instance to your Lambda functions\. The VPC endpoint uses its own private DNS resolution\. RDS for PostgreSQL can't use the Lambda VPC endpoint until you change the value of the `rds.custom_dns_resolution` from its default value of 0 \(not enabled\) to 1\. To do so: - + Create a custom DB parameter group\. - + Change the value of the `rds.custom_dns_resolution` parameter from its default of `0` to `1`\. - + Modify your DB instance to use your custom DB parameter group\. - + Reboot the instance to have the modified parameter take effect\. - -Your VPC can now interact with the AWS Lambda VPC at the network level\. Next, you configure the permissions using IAM\. - -## Step 2: Configure IAM for your RDS for PostgreSQL DB instance and AWS Lambda - -Invoking Lambda functions from your RDS for PostgreSQL DB instance requires certain privileges\. To configure the necessary privileges, we recommend that you create an IAM policy that allows invoking Lambda functions, assign that policy to a role, and then apply the role to your DB instance\. This approach gives the DB instance privileges to invoke the specified Lambda function on your behalf\. The following steps show you how to do this using the AWS CLI\. - -**To configure IAM permissions for using your Amazon RDS instance with Lambda** - -1. Use the [create\-policy](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iam/create-policy.html) AWS CLI command to create an IAM policy that allows your RDS for PostgreSQL DB instance to invoke the specified Lambda function\. \(The statement ID \(Sid\) is an optional description for your policy statement and has no effect on usage\.\) This policy gives your DB instance the minimum permissions needed to invoke the specified Lambda function\. - - ``` - aws iam create-policy --policy-name rds-lambda-policy --policy-document '{ - "Version": "2012-10-17", - "Statement": [ - { - "Sid": "AllowAccessToExampleFunction", - "Effect": "Allow", - "Action": "lambda:InvokeFunction", - "Resource": "arn:aws:lambda:aws-region:444455556666:function:my-function" - } - ] - }' - ``` - - Alternatively, you can use the predefined `AWSLambdaRole` policy that allows you to invoke any of your Lambda functions\. For more information, see [Identity\-based IAM policies for Lambda](https://docs.aws.amazon.com/lambda/latest/dg/access-control-identity-based.html#access-policy-examples-aws-managed) - -1. Use the [create\-role](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iam/create-role.html) AWS CLI command to create an IAM role that the policy can assume at runtime\. - - ``` - aws iam create-role --role-name rds-lambda-role --assume-role-policy-document '{ - "Version": "2012-10-17", - "Statement": [ - { - "Effect": "Allow", - "Principal": { - "Service": "rds.amazonaws.com" - }, - "Action": "sts:AssumeRole" - } - ] - }' - ``` - -1. Apply the policy to the role by using the [attach\-role\-policy](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iam/attach-role-policy.html) AWS CLI command\. - - ``` - aws iam attach-role-policy \ - --policy-arn arn:aws:iam::444455556666:policy/rds-lambda-policy \ - --role-name rds-lambda-role --region aws-region - ``` - -1. Apply the role to your RDS for PostgreSQL DB instance by using the [add\-role\-to\-db\-instance](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/rds/add-role-to-db-instance.html) AWS CLI command\. This last step allows your DB instance's database users to invoke Lambda functions\. - - ``` - aws rds add-role-to-db-instance \ - --db-cluster-identifier my-cluster-name \ - --feature-name Lambda \ - --role-arn arn:aws:iam::444455556666:role/rds-lambda-role \ - --region aws-region - ``` - -With the VPC and the IAM configurations complete, you can now install the `aws_lambda` extension\. \(Note that you can install the extension at any time, but until you set up the correct VPC support and IAM privileges, the `aws_lambda` extension adds nothing to your RDS for PostgreSQL DB instance's capabilities\.\) - -## Step 3: Install the `aws_lambda` extension for an RDS for PostgreSQL DB instance - -To use AWS Lambda with your RDS for PostgreSQL DB instance, the `aws_lambda` PostgreSQL extension to your RDS for PostgreSQL\. This extension provides your RDS for PostgreSQL DB instance with the ability to call Lambda functions from PostgreSQL\. - -**To install the `aws_lambda` extension in your RDS for PostgreSQL DB instance** - -Use the PostgreSQL `psql` command\-line or the pgAdmin tool to connect to your RDS for PostgreSQL DB instance\. - -1. Connect to your RDS for PostgreSQL DB instance as a user with `rds_superuser` privileges\. The default `postgres` user is shown in the example\. - - ``` - psql -h instance.444455556666.aws-region.rds.amazonaws.com -U postgres -p 5432 - ``` - -1. Install the `aws_lambda` extension\. The `aws_commons` extension is also required\. It provides helper functions to `aws_lambda` and many other Aurora extensions for PostgreSQL\. If it's not already on your RDS for PostgreSQLDB instance, it's installed with `aws_lambda` as shown following\. - - ``` - CREATE EXTENSION IF NOT EXISTS aws_lambda CASCADE; - NOTICE: installing required extension "aws_commons" - CREATE EXTENSION - ``` - -The `aws_lambda` extension is installed in your DB instance\. You can now create convenience structures for invoking your Lambda functions\. - -## Step 4: Use Lambda helper functions with your RDS for PostgreSQL DB instance \(Optional\) - -You can use the helper functions in the `aws_commons` extension to prepare entities that you can more easily invoke from PostgreSQL\. To do this, you need to have the following information about your Lambda functions: -+ **Function name** – The name, Amazon Resource Name \(ARN\), version, or alias of the Lambda function\. The IAM policy created in [Step 2: Configure IAM for your instance and Lambda](#PostgreSQL-Lambda-access) requires the ARN, so we recommend that you use your function's ARN\. -+ **AWS Region** – \(Optional\) The AWS Region where the Lambda function is located if it's not in the same Region as your RDS for PostgreSQL DB instance\. - -To hold the Lambda function name information, you use the [aws\_commons\.create\_lambda\_function\_arn](PostgreSQL-Lambda-functions.md#aws_commons.create_lambda_function_arn) function\. This helper function creates an `aws_commons._lambda_function_arn_1` composite structure with the details needed by the invoke function\. Following, you can find three alternative approaches to setting up this composite structure\. - -``` -SELECT aws_commons.create_lambda_function_arn( - 'my-function', - 'aws-region' -) AS aws_lambda_arn_1 \gset -``` - -``` -SELECT aws_commons.create_lambda_function_arn( - '111122223333:function:my-function', - 'aws-region' -) AS lambda_partial_arn_1 \gset -``` - -``` -SELECT aws_commons.create_lambda_function_arn( - 'arn:aws:lambda:aws-region:111122223333:function:my-function' -) AS lambda_arn_1 \gset -``` - -Any of these values can be used in calls to the [aws\_lambda\.invoke](PostgreSQL-Lambda-functions.md#aws_lambda.invoke) function\. For examples, see [Step 5: Invoke a Lambda function from your RDS for PostgreSQL DB instance](#PostgreSQL-Lambda-invoke)\. - -## Step 5: Invoke a Lambda function from your RDS for PostgreSQL DB instance - -The `aws_lambda.invoke` function behaves synchronously or asynchronously, depending on the `invocation_type`\. The two alternatives for this parameter are `RequestResponse` \(the default\) and `Event`, as follows\. -+ **`RequestResponse`** – This invocation type is *synchronous*\. It's the default behavior when the call is made without specifying an invocation type\. The response payload includes the results of the `aws_lambda.invoke` function\. Use this invocation type when your workflow requires receiving results from the Lambda function before proceeding\. -+ **`Event`** – This invocation type is *asynchronous*\. The response doesn't include a payload containing results\. Use this invocation type when your workflow doesn't need a result from the Lambda function to continue processing\. - -As a simple test of your setup, you can connect to your DB instance using `psql` and invoke an example function from the command line\. Suppose that you have one of the basic functions set up on your Lambda service, such as the simple Python function shown in the following screenshot\. - -![\[Example Lambda function shown in the AWS CLI for AWS Lambda\]](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/images/lambda_simple_function.png) - -**To invoke an example function** - -1. Connect to your DB instance using `psql` or pgAdmin\. - - ``` - psql -h instance.444455556666.aws-region.rds.amazonaws.com -U postgres -p 5432 - ``` - -1. Invoke the function using its ARN\. - - ``` - SELECT * from aws_lambda.invoke(aws_commons.create_lambda_function_arn('arn:aws:lambda:aws-region:444455556666:function:simple', 'us-west-1'), '{"body": "Hello from Postgres!"}'::json ); - ``` - - The response looks as follows\. - - ``` - status_code | payload | executed_version | log_result - -------------+-------------------------------------------------------+------------------+------------ - 200 | {"statusCode": 200, "body": "\"Hello from Lambda!\""} | $LATEST | - (1 row) - ``` - -If your invocation attempt doesn't succeed, see [Lambda function error messages ](#PostgreSQL-Lambda-errors)\. - -## Step 6: Grant other users permission to invoke Lambda functions - -At this point in the procedures, only you as `rds_superuser` can invoke your Lambda functions\. To allow other users to invoke any functions that you create, you need to grant them permission\. - -**To grant others permission to invoke Lambda functions** - -1. Connect to your DB instance using `psql` or pgAdmin\. - - ``` - psql -h instance.444455556666.aws-region.rds.amazonaws.com -U postgres -p 5432 - ``` - -1. Run the following SQL commands: - - ``` - postgres=> GRANT USAGE ON SCHEMA aws_lambda TO db_username; - GRANT EXECUTE ON ALL FUNCTIONS IN SCHEMA aws_lambda TO db_username; - ``` - -## Examples: Invoking Lambda functions from your RDS for PostgreSQL DB instance - -Following, you can find several examples of calling the [aws\_lambda\.invoke](PostgreSQL-Lambda-functions.md#aws_lambda.invoke) function\. Most all the examples use the composite structure `aws_lambda_arn_1` that you create in [Step 4: Use Lambda helper functions with your RDS for PostgreSQL DB instance \(Optional\)](#PostgreSQL-Lambda-specify-function) to simplify passing the function details\. For an example of asynchronous invocation, see [Example: Asynchronous \(Event\) invocation of Lambda functions](#PostgreSQL-Lambda-Event)\. All the other examples listed use synchronous invocation\. - -To learn more about Lambda invocation types, see [Invoking Lambda functions](https://docs.aws.amazon.com/lambda/latest/dg/lambda-invocation.html) in the *AWS Lambda Developer Guide*\. For more information about `aws_lambda_arn_1`, see [aws\_commons\.create\_lambda\_function\_arn](PostgreSQL-Lambda-functions.md#aws_commons.create_lambda_function_arn)\. - -**Topics** -+ [Example: Synchronous \(RequestResponse\) invocation of Lambda functions](#PostgreSQL-Lambda-RequestResponse) -+ [Example: Asynchronous \(Event\) invocation of Lambda functions](#PostgreSQL-Lambda-Event) -+ [Example: Capturing the Lambda execution log in a function response](#PostgreSQL-Lambda-log-response) -+ [Example: Including client context in a Lambda function](#PostgreSQL-Lambda-client-context) -+ [Example: Invoking a specific version of a Lambda function](#PostgreSQL-Lambda-function-version) - -### Example: Synchronous \(RequestResponse\) invocation of Lambda functions - -Following are two examples of a synchronous Lambda function invocation\. The results of these `aws_lambda.invoke` function calls are the same\. - -``` -SELECT * FROM aws_lambda.invoke(:'aws_lambda_arn_1', '{"body": "Hello from Postgres!"}'::json); -``` - -``` -SELECT * FROM aws_lambda.invoke(:'aws_lambda_arn_1', '{"body": "Hello from Postgres!"}'::json, 'RequestResponse'); -``` - -The parameters are described as follows: -+ `:'aws_lambda_arn_1'` – This parameter identifies the composite structure created in [Step 4: Use Lambda helper functions with your RDS for PostgreSQL DB instance \(Optional\)](#PostgreSQL-Lambda-specify-function), with the `aws_commons.create_lambda_function_arn` helper function\. You can also create this structure inline within your `aws_lambda.invoke` call as follows\. - - ``` - SELECT * FROM aws_lambda.invoke(aws_commons.create_lambda_function_arn('my-function', 'aws-region'), - '{"body": "Hello from Postgres!"}'::json - ); - ``` -+ `'{"body": "Hello from PostgreSQL!"}'::json` – The JSON payload to pass to the Lambda function\. -+ `'RequestResponse'` – The Lambda invocation type\. - -### Example: Asynchronous \(Event\) invocation of Lambda functions - -Following is an example of an asynchronous Lambda function invocation\. The `Event` invocation type schedules the Lambda function invocation with the specified input payload and returns immediately\. Use the `Event` invocation type in certain workflows that don't depend on the results of the Lambda function\. - -``` -SELECT * FROM aws_lambda.invoke(:'aws_lambda_arn_1', '{"body": "Hello from Postgres!"}'::json, 'Event'); -``` - -### Example: Capturing the Lambda execution log in a function response - -You can include the last 4 KB of the execution log in the function response by using the `log_type` parameter in your `aws_lambda.invoke` function call\. By default, this parameter is set to `None`, but you can specify `Tail` to capture the results of the Lambda execution log in the response, as shown following\. - -``` -SELECT *, select convert_from(decode(log_result, 'base64'), 'utf-8') as log FROM aws_lambda.invoke(:'aws_lambda_arn_1', '{"body": "Hello from Postgres!"}'::json, 'RequestResponse', 'Tail'); -``` - -Set the [aws\_lambda\.invoke](PostgreSQL-Lambda-functions.md#aws_lambda.invoke) function's `log_type` parameter to `Tail` to include the execution log in the response\. The default value for the `log_type` parameter is `None`\. - -The `log_result` that's returned is a `base64` encoded string\. You can decode the contents using a combination of the `decode` and `convert_from` PostgreSQL functions\. - -For more information about `log_type`, see [aws\_lambda\.invoke](PostgreSQL-Lambda-functions.md#aws_lambda.invoke)\. - -### Example: Including client context in a Lambda function - -The `aws_lambda.invoke` function has a `context` parameter that you can use to pass information separate from the payload, as shown following\. - -``` -SELECT *, convert_from(decode(log_result, 'base64'), 'utf-8') as log FROM aws_lambda.invoke(:'aws_lambda_arn_1', '{"body": "Hello from Postgres!"}'::json, 'RequestResponse', 'Tail'); -``` - -To include client context, use a JSON object for the [aws\_lambda\.invoke](PostgreSQL-Lambda-functions.md#aws_lambda.invoke) function's `context` parameter\. - -For more information about the `context` parameter, see the [aws\_lambda\.invoke](PostgreSQL-Lambda-functions.md#aws_lambda.invoke) reference\. - -### Example: Invoking a specific version of a Lambda function - -You can specify a particular version of a Lambda function by including the `qualifier` parameter with the `aws_lambda.invoke` call\. Following, you can find an example that does this using `'custom_version'` as an alias for the version\. - -``` -SELECT * FROM aws_lambda.invoke(:'aws_lambda_arn_1', '{"body": "Hello from Postgres!"}'::json, 'RequestResponse', 'None', NULL, 'custom_version'); -``` - -You can also supply a Lambda function qualifier with the function name details instead, as follows\. - -``` -SELECT * FROM aws_lambda.invoke(aws_commons.create_lambda_function_arn('my-function:custom_version', 'us-west-2'), -'{"body": "Hello from Postgres!"}'::json); -``` - -For more information about `qualifier` and other parameters, see the [aws\_lambda\.invoke](PostgreSQL-Lambda-functions.md#aws_lambda.invoke) reference\. - -## Lambda function error messages - -In the following list you can find information about error messages, with possible causes and solutions\. -+ **VPC configuration issues** - - VPC configuration issues can raise the following error messages when trying to connect: - - ``` - ERROR: invoke API failed - DETAIL: AWS Lambda client returned 'Unable to connect to endpoint'. - CONTEXT: SQL function "invoke" statement 1 - ``` - - A common cause for this error is improperly configured VPC security group\. Make sure you have an outbound rule for TCP open on port 443 of your VPC security group so that your VPC can connect to the Lambda VPC\. - - If your DB instance is private, check the private DNS setup for your VPC\. Make sure that you set the `rds.custom_dns_resolution` parameter to 1 and setup AWS PrivateLink as outlined in [Step 1: Configure your RDS for PostgreSQL DB instance for outbound connections to AWS Lambda](#PostgreSQL-Lambda-network)\. For more information, see [Interface VPC endpoints \(AWS PrivateLink\)](https://docs.aws.amazon.com/vpc/latest/privatelink/vpce-interface.html#vpce-private-dns)\. -+ **Lack of permissions needed to invoke Lambda functions** - - If you see either of the following error messages, the user \(role\) invoking the function doesn't have proper permissions\. - - ``` - ERROR: permission denied for schema aws_lambda - ``` - - ``` - ERROR: permission denied for function invoke - ``` - - A user \(role\) must be given specific grants to invoke Lambda functions\. For more information, see [Step 6: Grant other users permission to invoke Lambda functions](#PostgreSQL-Lambda-grant-users-permissions)\. -+ **Improper handling of errors in your Lambda functions** - - If a Lambda function throws an exception during request processing, `aws_lambda.invoke` fails with a PostgreSQL error such as the following\. - - ``` - SELECT * FROM aws_lambda.invoke(:'aws_lambda_arn_1', '{"body": "Hello from Postgres!"}'::json); - ERROR: lambda invocation failed - DETAIL: "arn:aws:lambda:us-west-2:555555555555:function:my-function" returned error "Unhandled", details: "". - ``` - - Be sure to handle errors in your Lambda functions or in your PostgreSQL application\. \ No newline at end of file diff --git a/doc_source/PostgreSQL.Concepts.General.FeatureSupport.md b/doc_source/PostgreSQL.Concepts.General.FeatureSupport.md deleted file mode 100644 index 858d4e2..0000000 --- a/doc_source/PostgreSQL.Concepts.General.FeatureSupport.md +++ /dev/null @@ -1,297 +0,0 @@ -# Working with PostgreSQL features supported by Amazon RDS for PostgreSQL - -Amazon RDS for PostgreSQL supports many of the most common PostgreSQL features\. For example, PostgreSQL has an autovacuum feature that performs routine maintenance on the database\. The autovacuum feature is active by default\. Although you can turn off this feature, we highly recommend that you keep it on\. Understanding this feature and what you can do to make sure it works as it should is a basic task of any DBA\. For more information about the autovacuum, see [Working with the PostgreSQL autovacuum on Amazon RDS for PostgreSQL](Appendix.PostgreSQL.CommonDBATasks.Autovacuum.md)\. To learn more about other common DBA tasks, [Common DBA tasks for Amazon RDS for PostgreSQL](Appendix.PostgreSQL.CommonDBATasks.md)\. - -RDS for PostgreSQL also supports extensions that add important functionality to the DB instance\. For example, you can use the PostGIS extension to work with spatial data, or use the pg\_cron extension to schedule maintenance from within the instance\. For more information about PostgreSQL extensions, see [Using PostgreSQL extensions with Amazon RDS for PostgreSQL](Appendix.PostgreSQL.CommonDBATasks.Extensions.md)\. - -Foreign data wrappers are a specific type of extension designed to let your RDS for PostgreSQL DB instance work with other commercial databases or data types\. For more information about foreign data wrappers supported by RDS for PostgreSQL, see [Working with the supported foreign data wrappers for Amazon RDS for PostgreSQL](Appendix.PostgreSQL.CommonDBATasks.Extensions.foreign-data-wrappers.md)\. - -Following, you can find information about some other features supported by RDS for PostgreSQL\. - -**Topics** -+ [Custom data types and enumerations with RDS for PostgreSQL](#PostgreSQL.Concepts.General.FeatureSupport.AlterEnum) -+ [Event triggers for RDS for PostgreSQL](#PostgreSQL.Concepts.General.FeatureSupport.EventTriggers) -+ [Huge pages for RDS for PostgreSQL](#PostgreSQL.Concepts.General.FeatureSupport.HugePages) -+ [Performing logical replication for Amazon RDS for PostgreSQL](#PostgreSQL.Concepts.General.FeatureSupport.LogicalReplication) -+ [RAM disk for the stats\_temp\_directory](#PostgreSQL.Concepts.General.FeatureSupport.RamDisk) -+ [Tablespaces for RDS for PostgreSQL](#PostgreSQL.Concepts.General.FeatureSupport.Tablespaces) -+ [RDS for PostgreSQL collations for EBCDIC and other mainframe migrations](#PostgreSQL.Collations.mainframe.migration) - -## Custom data types and enumerations with RDS for PostgreSQL - -PostgreSQL supports creating custom data types and working with enumerations\. For more information about creating and working with enumerations and other data types, see [Enumerated types](https://www.postgresql.org/docs/14/datatype-enum.html) in the PostgreSQL documentation\. - -The following is an example of creating a type as an enumeration and then inserting values into a table\. - -``` -CREATE TYPE rainbow AS ENUM ('red', 'orange', 'yellow', 'green', 'blue', 'purple'); -CREATE TYPE -CREATE TABLE t1 (colors rainbow); -CREATE TABLE -INSERT INTO t1 VALUES ('red'), ( 'orange'); -INSERT 0 2 -SELECT * from t1; -colors --------- -red -orange -(2 rows) -postgres=> ALTER TYPE rainbow RENAME VALUE 'red' TO 'crimson'; -ALTER TYPE -postgres=> SELECT * from t1; -colors ---------- -crimson -orange -(2 rows) -``` - -## Event triggers for RDS for PostgreSQL - -All current PostgreSQL versions support event triggers, and so do all available versions of RDS for PostgreSQL\. You can use the main user account \(default, `postgres`\) to create, modify, rename, and delete event triggers\. Event triggers are at the DB instance level, so they can apply to all databases on an instance\. - -For example, the following code creates an event trigger that prints the current user at the end of every data definition language \(DDL\) command\. - -``` -CREATE OR REPLACE FUNCTION raise_notice_func() - RETURNS event_trigger - LANGUAGE plpgsql AS -$$ -BEGIN - RAISE NOTICE 'In trigger function: %', current_user; -END; -$$; - -CREATE EVENT TRIGGER event_trigger_1 - ON ddl_command_end -EXECUTE PROCEDURE raise_notice_func(); -``` - -For more information about PostgreSQL event triggers, see [Event triggers](https://www.postgresql.org/docs/current/static/event-triggers.html) in the PostgreSQL documentation\. - -There are several limitations to using PostgreSQL event triggers on Amazon RDS\. These include the following: -+ You can't create event triggers on read replicas\. You can, however, create event triggers on a read replica source\. The event triggers are then copied to the read replica\. The event triggers on the read replica don't fire on the read replica when changes are pushed from the source\. However, if the read replica is promoted, the existing event triggers fire when database operations occur\. -+ To perform a major version upgrade to a PostgreSQL DB instance that uses event triggers, make sure to delete the event triggers before you upgrade the instance\. - -## Huge pages for RDS for PostgreSQL - -*Huge pages* are a memory management feature that reduces overhead when a DB instance is working with large contiguous chunks of memory, such as that used by shared buffers\. This PostgreSQL feature is supported by all currently available RDS for PostgreSQL versions\. You allocate huge pages for your application by using calls to `mmap` or `SYSV` shared memory\. RDS for PostgreSQL supports both 4\-KB and 2\-MB page sizes\. - -You can turn huge pages on or off by changing the value of the `huge_pages` parameter\. The feature is turned on by default for all the DB instance classes other than micro, small, and medium DB instance classes\. - -RDS for PostgreSQL uses huge pages based on the available shared memory\. If the DB instance can't use huge pages due to shared memory constraints, Amazon RDS prevents the DB instance from starting\. In this case, Amazon RDS sets the status of the DB instance to an incompatible parameters state\. If this occurs, you can set the `huge_pages` parameter to `off` to allow Amazon RDS to start the DB instance\. - -The `shared_buffers` parameter is key to setting the shared memory pool that is required for using huge pages\. The default value for the `shared_buffers` parameter uses a database parameters macro\. This macro sets a percentage of the total 8 KB pages available for the DB instance's memory\. When you use huge pages, those pages are located with the huge pages\. Amazon RDS puts a DB instance into an incompatible parameters state if the shared memory parameters are set to require more than 90 percent of the DB instance memory\. - -To learn more about PostgreSQL memory management, see [Resource Consumption](https://www.postgresql.org/docs/current/static/runtime-config-resource.html) in the PostgreSQL documentation\. - -## Performing logical replication for Amazon RDS for PostgreSQL - -Starting with version 10\.4, RDS for PostgreSQL supports the publication and subscription SQL syntax that was introduced in PostgreSQL 10\. To learn more, see [Logical replication](https://www.postgresql.org/docs/current/logical-replication.html) in the PostgreSQL documentation\. - -**Note** -In addition to the native PostgreSQL logical replication feature introduced in PostgreSQL 10, RDS for PostgreSQL also supports the `pglogical` extension\. For more information, see [Using pglogical to synchronize data across instances](Appendix.PostgreSQL.CommonDBATasks.Extensions.md#Appendix.PostgreSQL.CommonDBATasks.pglogical)\. - -Following, you can find information about setting up logical replication for an RDS for PostgreSQL DB instance\. - -**Topics** -+ [Understanding logical replication and logical decoding](#PostgreSQL.Concepts.General.FeatureSupport.LogicalDecoding) -+ [Working with logical replication slots](#PostgreSQL.Concepts.General.FeatureSupport.LogicalReplicationSlots) - -### Understanding logical replication and logical decoding - -RDS for PostgreSQL supports the streaming of write\-ahead log \(WAL\) changes using PostgreSQL's logical replication slots\. It also supports using logical decoding\. You can set up logical replication slots on your instance and stream database changes through these slots to a client such as `pg_recvlogical`\. You create logical replication slots at the database level, and they support replication connections to a single database\. - -The most common clients for PostgreSQL logical replication are AWS Database Migration Service or a custom\-managed host on an Amazon EC2 instance\. The logical replication slot has no information about the receiver of the stream\. Also, there's no requirement that the target be a replica database\. If you set up a logical replication slot and don't read from the slot, data can be written and quickly fill up your DB instance's storage\. - -You turn on PostgreSQL logical replication and logical decoding for Amazon RDS with a parameter, a replication connection type, and a security role\. The client for logical decoding can be any client that can establish a replication connection to a database on a PostgreSQL DB instance\. - -**To turn on logical decoding for an RDS for PostgreSQL DB instance** - -1. Make sure that the user account that you're using has these roles: - + The `rds_superuser` role so you can turn on logical replication - + The `rds_replication` role to grant permissions to manage logical slots and to stream data using logical slots - -1. Set the `rds.logical_replication` static parameter to 1\. As part of applying this parameter, also set the parameters `wal_level`, `max_wal_senders`, `max_replication_slots`, and `max_connections`\. These parameter changes can increase WAL generation, so set the `rds.logical_replication` parameter only when you are using logical slots\. - -1. Reboot the DB instance for the static `rds.logical_replication` parameter to take effect\. - -1. Create a logical replication slot as explained in the next section\. This process requires that you specify a decoding plugin\. Currently, RDS for PostgreSQL supports the test\_decoding and wal2json output plugins that ship with PostgreSQL\. - -For more information on PostgreSQL logical decoding, see the [ PostgreSQL documentation](https://www.postgresql.org/docs/current/static/logicaldecoding-explanation.html)\. - -### Working with logical replication slots - -You can use SQL commands to work with logical slots\. For example, the following command creates a logical slot named `test_slot` using the default PostgreSQL output plugin `test_decoding`\. - -``` -SELECT * FROM pg_create_logical_replication_slot('test_slot', 'test_decoding'); -slot_name | xlog_position ------------------+--------------- -regression_slot | 0/16B1970 -(1 row) -``` - -To list logical slots, use the following command\. - -``` -SELECT * FROM pg_replication_slots; -``` - -To drop a logical slot, use the following command\. - -``` -SELECT pg_drop_replication_slot('test_slot'); -pg_drop_replication_slot ------------------------ -(1 row) -``` - -For more examples on working with logical replication slots, see [ Logical decoding examples](https://www.postgresql.org/docs/9.5/static/logicaldecoding-example.html) in the PostgreSQL documentation\. - -After you create the logical replication slot, you can start streaming\. The following example shows how logical decoding is controlled over the streaming replication protocol\. This example uses the program pg\_recvlogical, which is included in the PostgreSQL distribution\. Doing this requires that client authentication is set up to allow replication connections\. - -``` -pg_recvlogical -d postgres --slot test_slot -U postgres - --host -instance-name.111122223333.aws-region.rds.amazonaws.com - -f - --start -``` - -To see the contents of the `pg_replication_origin_status` view, query the `pg_show_replication_origin_status` function\. - -``` -SELECT * FROM pg_show_replication_origin_status(); -local_id | external_id | remote_lsn | local_lsn -----------+-------------+------------+----------- -(0 rows) -``` - -## RAM disk for the stats\_temp\_directory - -You can use the RDS for PostgreSQL parameter `rds.pg_stat_ramdisk_size` to specify the system memory allocated to a RAM disk for storing the PostgreSQL `stats_temp_directory`\. The RAM disk parameter is available for all PostgreSQL versions on Amazon RDS\. - -Under certain workloads, setting this parameter can improve performance and decrease I/O requirements\. For more information about the `stats_temp_directory`, see [ the PostgreSQL documentation\.](https://www.postgresql.org/docs/current/static/runtime-config-statistics.html#GUC-STATS-TEMP-DIRECTORY)\. - -To set up a RAM disk for your `stats_temp_directory`, set the `rds.pg_stat_ramdisk_size` parameter to an integer literal value in the parameter group used by your DB instance\. This parameter denotes MB, so you must use an integer value\. Expressions, formulas, and functions aren't valid for the `rds.pg_stat_ramdisk_size` parameter\. Be sure to reboot the DB instance so that the change takes effect\. For information about setting parameters, see [Working with parameter groups](USER_WorkingWithParamGroups.md)\. - -For example, the following AWS CLI command sets the RAM disk parameter to 256 MB\. - -``` -aws rds modify-db-parameter-group \ - --db-parameter-group-name pg-95-ramdisk-testing \ - --parameters "ParameterName=rds.pg_stat_ramdisk_size, ParameterValue=256, ApplyMethod=pending-reboot" -``` - -After you reboot, run the following command to see the status of the `stats_temp_directory`\. - -``` -postgres=> SHOW stats_temp_directory; -``` - - The command should return the following\. - -``` -stats_temp_directory ---------------------------- -/rdsdbramdisk/pg_stat_tmp -(1 row) -``` - -## Tablespaces for RDS for PostgreSQL - -RDS for PostgreSQL supports tablespaces for compatibility\. Because all storage is on a single logical volume, you can't use tablespaces for I/O splitting or isolation\. Our benchmarks and experience indicate that a single logical volume is the best setup for most use cases\. - -To create and use tablespaces with your RDS for PostgreSQL DB instance requires the `rds_superuser` role\. Your RDS for PostgreSQL DB instance's main user account \(default name, `postgres`\) is a member of this role\. For more information, see [Understanding PostgreSQL roles and permissions](Appendix.PostgreSQL.CommonDBATasks.Roles.md)\. - -If you specify a file name when you create a tablespace, the path prefix is `/rdsdbdata/db/base/tablespace`\. The following example places tablespace files in `/rdsdbdata/db/base/tablespace/data`\. This example assumes that a `dbadmin` user \(role\) exists and that it's been granted the `rds_superuser` role needed to work with tablespaces\. - -``` -postgres=> CREATE TABLESPACE act_data - OWNER dbadmin - LOCATION '/data'; -CREATE TABLESPACE -``` - -To learn more about PostgreSQL tablespaces, see [Tablespaces](https://www.postgresql.org/docs/current/manage-ag-tablespaces.html) in the PostgreSQL documentation\. - -## RDS for PostgreSQL collations for EBCDIC and other mainframe migrations - -RDS for PostgreSQL versions 10 and higher include ICU version 60\.2, which is based on Unicode 10\.0 and includes collations from the Unicode Common Locale Data Repository, CLDR 32\. These software internationalization libraries ensure that character encodings are presented in a consistent way, regardless of operating system or platform\. For more information about Unicode CLDR\-32, see the [CLDR 32 Release Note](https://cldr.unicode.org/index/downloads/cldr-32) on the Unicode CLDR website\. You can learn more about the internationalization components for Unicode \(ICU\) at the [ICU Technical Committee \(ICU\-TC\)](https://icu.unicode.org/home) website\. For information about ICU\-60, see [Download ICU 60](https://icu.unicode.org/download/60)\. - -Starting with version 14\.3, RDS for PostgreSQL also includes collations that help with data integration and conversion from EBCDIC\-based systems\. The extended binary coded decimal interchange code or *EBCDIC* encoding is commonly used by mainframe operating systems\. These Amazon RDS\-provided collations are narrowly defined to sort only those Unicode characters that directly map to EBCDIC code pages\. The characters are sorted in EBCDIC code\-point order to allow for data validation after conversion\. These collations don't include denormalized forms, nor do they include Unicode characters that don't directly map to a character on the source EBCDIC code page\. - -The character mappings between EBCDIC code pages and Unicode code points are based on tables published by IBM\. The complete set is available from IBM as a [compressed file](http://download.boulder.ibm.com/ibmdl/pub/software/dw/java/cdctables.zip) for download\. RDS for PostgreSQL used these mappings with tools provided by the ICU to create the collations listed in the tables in this section\. The collation names include a language and country as required by the ICU\. However, EBCDIC code pages don't specify languages, and some EBCDIC code pages cover multiple countries\. That means that the language and country portion of the collation names in the table are arbitrary, and they don't need to match the current locale\. In other words, the code page number is the most important part of the collation name in this table\. You can use any of the collations listed in the following tables in any RDS for PostgreSQL database\. -+ [Unicode to EBCDIC collations table](#ebcdic-table) – Some mainframe data migration tools internally use LATIN1 or LATIN9 to encode and process data\. Such tools use round\-trip schemes to preserve data integrity and support reverse conversion\.The collations in this table can be used by tools that process data using LATIN1 encoding, which doesn't require special handling\. -+ [Unicode to LATIN9 collations table](#latin9-table) – You can use these collations in any RDS for PostgreSQL database\. - - - -In the following table, you find collations available in RDS for PostgreSQL that map EBCDIC code pages to Unicode code points\. We recommend that you use the collations in this table for application development that requires sorting based on the ordering of IBM code pages\. - - -| PostgreSQL collation name | Description of code\-page mapping and sort order | -| --- | --- | -| da\-DK\-cp277\-x\-icu | Unicode characters that directly map to IBM EBCDIC Code Page 277 \(per conversion tables\) are sorted in IBM CP 277 code point order | -| de\-DE\-cp273\-x\-icu | Unicode characters that directly map to IBM EBCDIC Code Page 273 \(per conversion tables\) are sorted in IBM CP 273 code point order | -| en\-GB\-cp285\-x\-icu | Unicode characters that directly map to IBM EBCDIC Code Page 285 \(per conversion tables\) are sorted in IBM CP 285 code point order | -| en\-US\-cp037\-x\-icu | Unicode characters that directly map to IBM EBCDIC Code Page 037 \(per conversion tables\) are sorted in IBM CP 37 code point order | -| es\-ES\-cp284\-x\-icu | Unicode characters that directly map to IBM EBCDIC Code Page 284 \(per conversion tables\) are sorted in IBM CP 284 code point order | -| fi\-FI\-cp278\-x\-icu | Unicode characters that directly map to IBM EBCDIC Code Page 278 \(per conversion tables\) are sorted in IBM CP 278 code point order | -| fr\-FR\-cp297\-x\-icu | Unicode characters that directly map to IBM EBCDIC Code Page 297 \(per conversion tables\) are sorted in IBM CP 297 code point order | -| it\-IT\-cp280\-x\-icu | Unicode characters that directly map to IBM EBCDIC Code Page 280 \(per conversion tables\) are sorted in IBM CP 280 code point order | -| nl\-BE\-cp500\-x\-icu | Unicode characters that directly map to IBM EBCDIC Code Page 500 \(per conversion tables\) are sorted in IBM CP 500 code point order | - -Amazon RDS provides a set of additional collations that sort Unicode code points that map to LATIN9 characters using the tables published by IBM, in the order of the original code points according to the EBCDIC code page of the source data\. - - -| PostgreSQL collation name | Description of code\-page mapping and sort order | -| --- | --- | -| da\-DK\-cp1142m\-x\-icu | Unicode characters that map to LATIN9 characters originally converted from IBM EBCDIC Code Page 1142 \(per conversion tables\) are sorted in IBM CP 1142 code point order | -| de\-DE\-cp1141m\-x\-icu | Unicode characters that map to LATIN9 characters originally converted from IBM EBCDIC Code Page 1141 \(per conversion tables\) are sorted in IBM CP 1141 code point order | -| en\-GB\-cp1146m\-x\-icu | Unicode characters that map to LATIN9 characters originally converted from IBM EBCDIC Code Page 1146 \(per conversion tables\) are sorted in IBM CP 1146 code point order | -| en\-US\-cp1140m\-x\-icu | Unicode characters that map to LATIN9 characters originally converted from IBM EBCDIC Code Page 1140 \(per conversion tables\) are sorted in IBM CP 1140 code point order | -| es\-ES\-cp1145m\-x\-icu | Unicode characters that map to LATIN9 characters originally converted from IBM EBCDIC Code Page 1145 \(per conversion tables\) are sorted in IBM CP 1145 code point order | -| fi\-FI\-cp1143m\-x\-icu | Unicode characters that map to LATIN9 characters originally converted from IBM EBCDIC Code Page 1143 \(per conversion tables\) are sorted in IBM CP 1143 code point order | -| fr\-FR\-cp1147m\-x\-icu | Unicode characters that map to LATIN9 characters originally converted from IBM EBCDIC Code Page 1147 \(per conversion tables\) are sorted in IBM CP 1147 code point order | -| it\-IT\-cp1144m\-x\-icu | Unicode characters that map to LATIN9 characters originally converted from IBM EBCDIC Code Page 1144 \(per conversion tables\) are sorted in IBM CP 1144 code point order | -| nl\-BE\-cp1148m\-x\-icu | Unicode characters that map to LATIN9 characters originally converted from IBM EBCDIC Code Page 1148 \(per conversion tables\) are sorted in IBM CP 1148 code point order | - -In the following, you can find an example of using an RDS for PostgreSQL collation\. - -``` -db1=> SELECT pg_import_system_collations('pg_catalog'); - pg_import_system_collations ------------------------------ - 36 -db1=> SELECT '¤' < 'a' col1; - col1 ------- - t -db1=> SELECT '¤' < 'a' COLLATE "da-DK-cp277-x-icu" col1; - col1 ------- - f -``` - -We recommend that you use the collations in the [Unicode to EBCDIC collations table](#ebcdic-table) and in the [Unicode to LATIN9 collations table](#latin9-table) for application development that requires sorting based on the ordering of IBM code pages\. The following collations \(suffixed with the letter “b”\) are also visible in `pg_collation`, but are intended for use by mainframe data integration and migration tools at AWS that map code pages with specific code point shifts and require special handling in collation\. In other words, the following collations aren't recommended for use\. -+ da\-DK\-277b\-x\-icu -+ da\-DK\-1142b\-x\-icu -+ de\-DE\-cp273b\-x\-icu -+ de\-DE\-cp1141b\-x\-icu -+ en\-GB\-cp1146b\-x\-icu -+ en\-GB\-cp285b\-x\-icu -+ en\-US\-cp037b\-x\-icu -+ en\-US\-cp1140b\-x\-icu -+ es\-ES\-cp1145b\-x\-icu -+ es\-ES\-cp284b\-x\-icu -+ fi\-FI\-cp1143b\-x\-icu -+ fr\-FR\-cp1147b\-x\-icu -+ fr\-FR\-cp297b\-x\-icu -+ it\-IT\-cp1144b\-x\-icu -+ it\-IT\-cp280b\-x\-icu -+ nl\-BE\-cp1148b\-x\-icu -+ nl\-BE\-cp500b\-x\-icu - -To learn more about migrating applications from mainframe environments to AWS, see [What is AWS Mainframe Modernization?](https://docs.aws.amazon.com/m2/latest/userguide/what-is-m2.html)\. - -For more information about managing collations in PostgreSQL, see [Collation Support](https://www.postgresql.org/docs/current/collation.html) in the PostgreSQL documentation\. \ No newline at end of file diff --git a/doc_source/PostgreSQL.Concepts.General.SSL.md b/doc_source/PostgreSQL.Concepts.General.SSL.md deleted file mode 100644 index 5a3e3a6..0000000 --- a/doc_source/PostgreSQL.Concepts.General.SSL.md +++ /dev/null @@ -1,149 +0,0 @@ -# Using SSL with a PostgreSQL DB instance - -Amazon RDS supports Secure Socket Layer \(SSL\) encryption for PostgreSQL DB instances\. Using SSL, you can encrypt a PostgreSQL connection between your applications and your PostgreSQL DB instances\. By default, RDS for PostgreSQL uses and expects all clients to connect using SSL/TLS, but you can also require it\. RDS for PostgreSQL supports Transport Layer Security \(TLS\) versions 1\.1 and 1\.2\. - -For general information about SSL support and PostgreSQL databases, see [SSL support](https://www.postgresql.org/docs/11/libpq-ssl.html) in the PostgreSQL documentation\. For information about using an SSL connection over JDBC, see [Configuring the client](https://jdbc.postgresql.org/documentation/head/ssl-client.html) in the PostgreSQL documentation\. - -SSL support is available in all AWS Regions for PostgreSQL\. Amazon RDS creates an SSL certificate for your PostgreSQL DB instance when the instance is created\. If you enable SSL certificate verification, then the SSL certificate includes the DB instance endpoint as the Common Name \(CN\) for the SSL certificate to guard against spoofing attacks\. - -**Topics** -+ [Connecting to a PostgreSQL DB instance over SSL](#PostgreSQL.Concepts.General.SSL.Connecting) -+ [Requiring an SSL connection to a PostgreSQL DB instance](#PostgreSQL.Concepts.General.SSL.Requiring) -+ [Determining the SSL connection status](#PostgreSQL.Concepts.General.SSL.Status) -+ [SSL cipher suites in RDS for PostgreSQL](#PostgreSQL.Concepts.General.SSL.Ciphers) - -## Connecting to a PostgreSQL DB instance over SSL - -**To connect to a PostgreSQL DB instance over SSL** - -1. Download the certificate\. - - For information about downloading certificates, see [Using SSL/TLS to encrypt a connection to a DB instance](UsingWithRDS.SSL.md)\. - -1. Import the certificate into your operating system\. - - For sample scripts that import certificates, see [Sample script for importing certificates into your trust store](UsingWithRDS.SSL-certificate-rotation.md#UsingWithRDS.SSL-certificate-rotation-sample-script)\. - -1. Connect to your PostgreSQL DB instance over SSL\. - - When you connect using SSL, your client can choose whether to verify the certificate chain\. If your connection parameters specify `sslmode=verify-ca` or `sslmode=verify-full`, then your client requires the RDS CA certificates to be in their trust store or referenced in the connection URL\. This requirement is to verify the certificate chain that signs your database certificate\. - - When a client, such as psql or JDBC, is configured with SSL support, the client first tries to connect to the database with SSL by default\. If the client can't connect with SSL, it reverts to connecting without SSL\. The default `sslmode` mode used is different between libpq\-based clients \(such as psql\) and JDBC\. The libpq\-based clients default to `prefer`, and JDBC clients default to `verify-full`\. - - Use the `sslrootcert` parameter to reference the certificate, for example `sslrootcert=rds-ssl-ca-cert.pem`\. - -The following is an example of using `psql` to connect to a PostgreSQL DB instance using SSL with certificate verification\. - -``` -$ psql -h db-name.555555555555.ap-southeast-1.rds.amazonaws.com - -p 5432 dbname=testDB user=testuser sslrootcert=rds-ca-2019-root.pem sslmode=verify-full -``` - -## Requiring an SSL connection to a PostgreSQL DB instance - -You can require that connections to your PostgreSQL DB instance use SSL by using the `rds.force_ssl` parameter\. The default `rds.force_ssl` parameter is set to 1 \(on\) for RDS for PostgreSQL version 15\. All other RDS for PostgreSQL major version 14 and older have the default value for `rds.force_ssl` parameter set to 0 \(off\)\. You can set the `rds.force_ssl` parameter to 1 \(on\) to require SSL for connections to your DB instance\. - -To change the value of this parameter, you need to create a custom DB parameter group\. You then change the value for `rds.force_ssl` in your custom DB parameter group to `1` to turn on this feature\. If you prepare the custom DB parameter group before creating your RDS for PostgreSQL DB instance you can choose it \(instead of a default parameter group\) during the creation process\. If you do this after your RDS for PostgreSQL DB instance is already running, you need to reboot the instance so that your instance uses the custom parameter group\. For more information, see [Working with parameter groups](USER_WorkingWithParamGroups.md)\. - -When the `rds.force_ssl` feature is active on your DB instance, connection attempts that aren't using SSL are rejected with the following message: - -``` -$ psql -h db-name.555555555555.ap-southeast-1.rds.amazonaws.com -p 5432 dbname=testDB user=testuser -psql: error: FATAL: no pg_hba.conf entry for host "w.x.y.z", user "testuser", database "testDB", SSL off -``` - -## Determining the SSL connection status - -The encrypted status of your connection is shown in the logon banner when you connect to the DB instance: - -``` -Password for user master: -psql (10.3) -SSL connection (cipher: DHE-RSA-AES256-SHA, bits: 256) -Type "help" for help. -postgres=> -``` - -You can also load the `sslinfo` extension and then call the `ssl_is_used()` function to determine if SSL is being used\. The function returns `t` if the connection is using SSL, otherwise it returns `f`\. - -``` -postgres=> CREATE EXTENSION sslinfo; -CREATE EXTENSION -postgres=> SELECT ssl_is_used(); -ssl_is_used ---------- -t -(1 row) -``` - -For more detailed information, you can use the following query to get information from `pg_settings`: - -``` -SELECT name as "Parameter name", setting as value, short_desc FROM pg_settings WHERE name LIKE '%ssl%'; - Parameter name | value | short_desc -----------------------------------------+-----------------------------------------+------------------------------------------------------- - ssl | on | Enables SSL connections. - ssl_ca_file | /rdsdbdata/rds-metadata/ca-cert.pem | Location of the SSL certificate authority file. - ssl_cert_file | /rdsdbdata/rds-metadata/server-cert.pem | Location of the SSL server certificate file. - ssl_ciphers | HIGH:!aNULL:!3DES | Sets the list of allowed SSL ciphers. - ssl_crl_file | | Location of the SSL certificate revocation list file. - ssl_dh_params_file | | Location of the SSL DH parameters file. - ssl_ecdh_curve | prime256v1 | Sets the curve to use for ECDH. - ssl_key_file | /rdsdbdata/rds-metadata/server-key.pem | Location of the SSL server private key file. - ssl_library | OpenSSL | Name of the SSL library. - ssl_max_protocol_version | | Sets the maximum SSL/TLS protocol version to use. - ssl_min_protocol_version | TLSv1.2 | Sets the minimum SSL/TLS protocol version to use. - ssl_passphrase_command | | Command to obtain passphrases for SSL. - ssl_passphrase_command_supports_reload | off | Also use ssl_passphrase_command during server reload. - ssl_prefer_server_ciphers | on | Give priority to server ciphersuite order. -(14 rows) -``` - -You can also collect all the information about your RDS for PostgreSQL DB instance's SSL usage by process, client, and application by using the following query: - -``` -SELECT datname as "Database name", usename as "User name", ssl, client_addr, application_name, backend_type - FROM pg_stat_ssl - JOIN pg_stat_activity - ON pg_stat_ssl.pid = pg_stat_activity.pid - ORDER BY ssl; - Database name | User name | ssl | client_addr | application_name | backend_type ----------------+-----------+-----+----------------+------------------------+------------------------------ - | | f | | | autovacuum launcher - | rdsadmin | f | | | logical replication launcher - | | f | | | background writer - | | f | | | checkpointer - | | f | | | walwriter - rdsadmin | rdsadmin | t | 127.0.0.1 | | client backend - rdsadmin | rdsadmin | t | 127.0.0.1 | PostgreSQL JDBC Driver | client backend - postgres | postgres | t | 204.246.162.36 | psql | client backend -(8 rows) -``` - -To identify the cipher used for your SSL connection, you can query as follows: - -``` -postgres=> SELECT ssl_cipher(); -ssl_cipher --------------------- -DHE-RSA-AES256-SHA -(1 row) -``` - -To learn more about the `sslmode` option, see [Database connection control functions](https://www.postgresql.org/docs/11/libpq-connect.html#LIBPQ-CONNECT-SSLMODE) in the *PostgreSQL documentation*\. - -## SSL cipher suites in RDS for PostgreSQL - -The PostgreSQL configuration parameter [ssl\_ciphers](https://www.postgresql.org/docs/current/runtime-config-connection.html#RUNTIME-CONFIG-CONNECTION-SSL) specifies the categories of cipher suites that are allowed for SSL connections\. The following table lists the default cipher suites used in RDS for PostgreSQL\. - - -| PostgreSQL engine version | Cipher suites | -| --- | --- | -| 15 | HIGH:\!aNULL:\!3DES | -| 14 | HIGH:\!aNULL:\!3DES | -| 13 | HIGH:\!aNULL:\!3DES | -| 12 | HIGH:\!aNULL:\!3DES | -| 11\.4 and higher minor versions | HIGH:MEDIUM:\+3DES:\!aNULL:\!RC4 | -| 11\.1, 11\.2 | HIGH:MEDIUM:\+3DES:\!aNULL | -| 10\.9 and higher minor versions | HIGH:MEDIUM:\+3DES:\!aNULL:\!RC4 | -| 10\.7 and lower minor versions | HIGH:MEDIUM:\+3DES:\!aNULL | \ No newline at end of file diff --git a/doc_source/PostgreSQL.Concepts.General.Security.md b/doc_source/PostgreSQL.Concepts.General.Security.md deleted file mode 100644 index 6945ff4..0000000 --- a/doc_source/PostgreSQL.Concepts.General.Security.md +++ /dev/null @@ -1,9 +0,0 @@ -# Securing connections to RDS for PostgreSQL with SSL/TLS - -RDS for PostgreSQL supports Secure Socket Layer \(SSL\) encryption for PostgreSQL DB instances\. Using SSL, you can encrypt a PostgreSQL connection between your applications and your PostgreSQL DB instances\. You can also force all connections to your PostgreSQL DB instance to use SSL\. RDS for PostgreSQL also supports Transport Layer Security \(TLS\), the successor protocol to SSL\. - -To learn more about Amazon RDS and data protection, including encrypting connections using SSL/TLS, see [Data protection in Amazon RDS](DataDurability.md)\. - -**Topics** -+ [Using SSL with a PostgreSQL DB instance](PostgreSQL.Concepts.General.SSL.md) -+ [Updating applications to use new SSL/TLS certificates](ssl-certificate-rotation-postgresql.md) \ No newline at end of file diff --git a/doc_source/PostgreSQL.ManagingTempFiles.md b/doc_source/PostgreSQL.ManagingTempFiles.md deleted file mode 100644 index e5d802e..0000000 --- a/doc_source/PostgreSQL.ManagingTempFiles.md +++ /dev/null @@ -1,116 +0,0 @@ -# Managing temporary files with PostgreSQL - -In PostgreSQL, the query performing sort and hash operations use the instance memory to store results up to the value specified in the [https://www.postgresql.org/docs/current/runtime-config-resource.html#GUC-WORK-MEM](https://www.postgresql.org/docs/current/runtime-config-resource.html#GUC-WORK-MEM) parameter\. When the instance memory is not sufficient, temporary files are created to store the results\. These are written to disk to complete the query execution\. Later, these files are automatically removed after the query completes\. In RDS for PostgreSQL, these files are stored in Amazon EBS on the data volume\. For more information, see [Amazon RDS DB instance storage](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_Storage.html)\. - -You can use the following parameters and functions to manage the temporary files in your instance\. -+ **[https://www.postgresql.org/docs/current/runtime-config-resource.html#RUNTIME-CONFIG-RESOURCE-DISK](https://www.postgresql.org/docs/current/runtime-config-resource.html#RUNTIME-CONFIG-RESOURCE-DISK)** – This parameter cancels any query exceeding the size of temp\_files in KB\. This limit prevents any query from running endlessly and consuming disk space with temporary files\. You can estimate the value using the results from the `log_temp_files` parameter\. As a best practice, examine the workload behavior and set the limit according to the estimation\. The following example shows how a query is canceled when it exceeds the limit\. - - ``` - postgres=> select * from pgbench_accounts, pg_class, big_table; - ``` - - ``` - ERROR: temporary file size exceeds temp_file_limit (64kB) - ``` -+ **[https://www.postgresql.org/docs/current/runtime-config-logging.html#GUC-LOG-TEMP-FILES](https://www.postgresql.org/docs/current/runtime-config-logging.html#GUC-LOG-TEMP-FILES)** – This parameter sends messages to the postgresql\.log when the temporary files of a session are removed\. This parameter produces logs after a query successfully completes\. Therefore, it might not help in troubleshooting active, long\-running queries\. - - The following example shows that when the query successfully completes, the entries are logged in the postgresql\.log file while the temporary files are cleaned up\. - - ``` - - 2023-02-06 23:48:35 UTC:205.251.233.182(12456):adminuser@postgres:[31236]:LOG: temporary file: path "base/pgsql_tmp/pgsql_tmp31236.5", size 140353536 - 2023-02-06 23:48:35 UTC:205.251.233.182(12456):adminuser@postgres:[31236]:STATEMENT: select a.aid from pgbench_accounts a, pgbench_accounts b where a.bid=b.bid order by a.bid limit 10; - 2023-02-06 23:48:35 UTC:205.251.233.182(12456):adminuser@postgres:[31236]:LOG: temporary file: path "base/pgsql_tmp/pgsql_tmp31236.4", size 180428800 - 2023-02-06 23:48:35 UTC:205.251.233.182(12456):adminuser@postgres:[31236]:STATEMENT: select a.aid from pgbench_accounts a, pgbench_accounts b where a.bid=b.bid order by a.bid limit 10; - ``` -+ **[https://www.postgresql.org/docs/current/functions-admin.html#FUNCTIONS-ADMIN-GENFILE](https://www.postgresql.org/docs/current/functions-admin.html#FUNCTIONS-ADMIN-GENFILE)** – This function that is available from RDS for PostgreSQL 13 and above provides visibility into the current temporary file usage\. The completed query doesn't appear in the results of the function\. In the following example, you can view the results of this function\. - - ``` - postgres=> select * from pg_ls_tmpdir(); - ``` - - ``` - name | size | modification - -----------------+------------+------------------------ - pgsql_tmp8355.1 | 1072250880 | 2023-02-06 22:54:56+00 - pgsql_tmp8351.0 | 1072250880 | 2023-02-06 22:54:43+00 - pgsql_tmp8327.0 | 1072250880 | 2023-02-06 22:54:56+00 - pgsql_tmp8351.1 | 703168512 | 2023-02-06 22:54:56+00 - pgsql_tmp8355.0 | 1072250880 | 2023-02-06 22:54:00+00 - pgsql_tmp8328.1 | 835031040 | 2023-02-06 22:54:56+00 - pgsql_tmp8328.0 | 1072250880 | 2023-02-06 22:54:40+00 - (7 rows) - ``` - - ``` - postgres=> select query from pg_stat_activity where pid = 8355; - - query - ---------------------------------------------------------------------------------------- - select a.aid from pgbench_accounts a, pgbench_accounts b where a.bid=b.bid order by a.bid - (1 row) - ``` - - The file name includes the processing ID \(PID\) of the session that generated the temporary file\. A more advanced query, such as in the following example, performs a sum of the temporary files for each PID\. - - ``` - postgres=> select replace(left(name, strpos(name, '.')-1),'pgsql_tmp','') as pid, count(*), sum(size) from pg_ls_tmpdir() group by pid; - ``` - - ``` - pid | count | sum - ------+------------------- - 8355 | 2 | 2144501760 - 8351 | 2 | 2090770432 - 8327 | 1 | 1072250880 - 8328 | 2 | 2144501760 - (4 rows) - ``` -+ **`[ pg\_stat\_statements](https://www.postgresql.org/docs/current/pgstatstatements.html)`** – If you activate the pg\_stat\_statements parameter, then you can view the average temporary file usage per call\. You can identify the query\_id of the query and use it to examine the temporary file usage as shown in the following example\. - - ``` - postgres=> select queryid from pg_stat_statements where query like 'select a.aid from pgbench%'; - ``` - - ``` - queryid - ---------------------- - -7170349228837045701 - (1 row) - ``` - - ``` - postgres=> select queryid, substr(query,1,25), calls, temp_blks_read/calls temp_blks_read_per_call, temp_blks_written/calls temp_blks_written_per_call from pg_stat_statements where queryid = -7170349228837045701; - ``` - - ``` - queryid | substr | calls | temp_blks_read_per_call | temp_blks_written_per_call - ----------------------+---------------------------+-------+-------------------------+---------------------------- - -7170349228837045701 | select a.aid from pgbench | 50 | 239226 | 388678 - (1 row) - ``` -+ **`[Performance Insights](https://aws.amazon.com/rds/performance-insights/)`** – In the Performance Insights dashboard, you can view temporary file usage by turning on the metrics **temp\_bytes** and **temp\_files**\. Then, you can see the average of both of these metrics and see how they correspond to the query workload\. The view within Performance Insights doesn't show specifically the queries that are generating the temporary files\. However, when you combine Performance Insights with the query shown for `pg_ls_tmpdir`, you can troubleshoot, analyze, and determine the changes in your query workload\. - - For more information about how to analyze metrics and queries with Performance Insights, see [Analyzing metrics with the Performance Insights dashboard](USER_PerfInsights.UsingDashboard.md) - -**To view the temporary file usage with Performance Insights** - - 1. In the Performance Insights dashboard, choose **Manage Metrics**\. - - 1. Select the **temp\_bytes** and **temp\_files** **database metrics** as shown in the following screenshot\. -![\[Metrics displayed in the graph.\]](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/images/rpg_mantempfiles_metrics.png) - - 1. In the **Top SQL** tab, choose the **Preferences** icon\. - - 1. In the **Preferences** window, turn on the following statistics to appear in the **Top SQL**tab and choose **Continue**\. - + Temp writes/sec - + Temp reads/sec - + Tmp blk write/call - + Tmp blk read/call - - 1. The temporary file is broken out when combined with the query shown for `pg_ls_tmpdir`, as shown in the following example\. -![\[Query that displays the temporary file usage.\]](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/images/rpg_mantempfiles_query.png) - -**Note** -The [https://www.postgresql.org/docs/current/runtime-config-resource.html#GUC-WORK-MEM](https://www.postgresql.org/docs/current/runtime-config-resource.html#GUC-WORK-MEM) parameter controls when the sort operation runs out of memory and results are written into temporary files\. We recommend that you don't change the setting of this parameter higher than the default value because it would permit every database session to consume more memory\. Also, a single session that performs complex joins and sorts can perform parallel operations in which each operation consumes memory\. -As a best practice, when you have a large report with multiple joins and sorts, set this parameter at the session level by using the `SET work_mem` command\. Then the change is only applied to the current session and doesn't change the value globally\. \ No newline at end of file diff --git a/doc_source/PostgreSQL.Procedural.Importing.Copy.md b/doc_source/PostgreSQL.Procedural.Importing.Copy.md deleted file mode 100644 index c7ac701..0000000 --- a/doc_source/PostgreSQL.Procedural.Importing.Copy.md +++ /dev/null @@ -1,53 +0,0 @@ -# Using the \\copy command to import data to a table on a PostgreSQL DB instance - -The PostgreSQL `\copy` command is a meta\-command available from the `psql` interactive client tool\. You can use `\copy` to import data into a table on your RDS for PostgreSQL DB instance\. To use the `\copy` command, you need to first create the table structure on the target DB instance so that `\copy` has a destination for the data being copied\. - -You can use `\copy` to load data from a comma\-separated values \(CSV\) file, such as one that's been exported and saved to your client workstation\. - -To import the CSV data to the target RDS for PostgreSQL DB instance, first connect to the target DB instance using `psql`\. - -``` -psql --host=db-instance.111122223333.aws-region.rds.amazonaws.com --port=5432 --username=postgres --password --dbname=target-db -``` - -You then run `\copy` command with the following parameters to identify the target for the data and its format\. -+ `target_table` – The name of the table that should receive the data being copied from the CSV file\. -+ `column_list` – Column specifications for the table\. -+ `'filename'` – The complete path to the CSV file on your local workstation\. - -``` - \copy target_table from '/path/to/local/filename.csv' WITH DELIMITER ',' CSV; -``` - -If your CSV file has column heading information, you can use this version of the command and parameters\. - -``` -\copy target_table (column-1, column-2, column-3, ...) - from '/path/to/local/filename.csv' WITH DELIMITER ',' CSV HEADER; -``` - - If the `\copy` command fails, PostgreSQL outputs error messages\. - -Creating a new DB instance in the preview environment `psql` command with the `\copy` meta\-command as shown in the following examples\. This example uses *source\-table* as the source table name, *source\-table\.csv* as the \.csv file, and *target\-db* as the target database: - -For Linux, macOS, or Unix: - -``` -$psql target-db \ - -U \ - -p \ - -h \ - -c "\copy source-table from 'source-table.csv' with DELIMITER ','" -``` - -For Windows: - -``` -$psql target-db ^ - -U ^ - -p ^ - -h ^ - -c "\copy source-table from 'source-table.csv' with DELIMITER ','" -``` - -For complete details about the `\copy` command, see the [psql](http://www.postgresql.org/docs/current/static/app-psql.html) page in the PostgreSQL documentation, in the *Meta\-Commands* section\. \ No newline at end of file diff --git a/doc_source/PostgreSQL.Procedural.Importing.EC2.md b/doc_source/PostgreSQL.Procedural.Importing.EC2.md deleted file mode 100644 index 979891b..0000000 --- a/doc_source/PostgreSQL.Procedural.Importing.EC2.md +++ /dev/null @@ -1,69 +0,0 @@ -# Importing a PostgreSQL database from an Amazon EC2 instance - -If you have data in a PostgreSQL server on an Amazon EC2 instance and want to move it to a PostgreSQL DB instance, you can use the following process\. The following list shows the steps to take\. Each step is discussed in more detail in the following sections\. - -1. Create a file using pg\_dump that contains the data to be loaded - -1. Create the target DB instance - -1. Use *psql* to create the database on the DB instance and load the data - -1. Create a DB snapshot of the DB instance - -## Step 1: Create a file using pg\_dump that contains the data to load - -The `pg_dump` utility uses the COPY command to create a schema and data dump of a PostgreSQL database\. The dump script generated by `pg_dump` loads data into a database with the same name and recreates the tables, indexes, and foreign keys\. You can use the `pg_restore` command and the `-d` parameter to restore the data to a database with a different name\. - -Before you create the data dump, you should query the tables to be dumped to get a row count so you can confirm the count on the target DB instance\. - - The following command creates a dump file called mydb2dump\.sql for a database called mydb2\. - -``` -prompt>pg_dump dbname=mydb2 -f mydb2dump.sql -``` - -## Step 2: Create the target DB instance - -Create the target PostgreSQL DB instance using either the Amazon RDS console, AWS CLI, or API\. Create the instance with the backup retention setting set to 0 and disable Multi\-AZ\. Doing so allows faster data import\. You must create a database on the instance before you can dump the data\. The database can have the same name as the database that is contained the dumped data\. Alternatively, you can create a database with a different name\. In this case, you use the `pg_restore` command and the `-d` parameter to restore the data into the newly named database\. - -For example, the following commands can be used to dump, restore, and rename a database\. - -``` -pg_dump -Fc -v -h [endpoint of instance] -U [master username] [database] > [database].dump -createdb [new database name] -pg_restore -v -h [endpoint of instance] -U [master username] -d [new database name] [database].dump -``` - -## Step 3: Use psql to create the database on the DB instance and load data - -You can use the same connection you used to run the pg\_dump command to connect to the target DB instance and recreate the database\. Using *psql*, you can use the master user name and master password to create the database on the DB instance - -The following example uses *psql* and a dump file named mydb2dump\.sql to create a database called mydb2 on a PostgreSQL DB instance called mypginstance: - -For Linux, macOS, or Unix: - -``` -psql \ - -f mydb2dump.sql \ - --host mypginstance.555555555555.aws-region.rds.amazonaws.com \ - --port 8199 \ - --username myawsuser \ - --password password \ - --dbname mydb2 -``` - -For Windows: - -``` -psql ^ - -f mydb2dump.sql ^ - --host mypginstance.555555555555.aws-region.rds.amazonaws.com ^ - --port 8199 ^ - --username myawsuser ^ - --password password ^ - --dbname mydb2 -``` - -## Step 4: Create a DB snapshot of the DB instance - -Once you have verified that the data was loaded into your DB instance, we recommend that you create a DB snapshot of the target PostgreSQL DB instance\. DB snapshots are complete backups of your DB instance that can be used to restore your DB instance to a known state\. A DB snapshot taken immediately after the load protects you from having to load the data again in case of a mishap\. You can also use such a snapshot to seed new DB instances\. For information about creating a DB snapshot, see [Creating a DB snapshot](USER_CreateSnapshot.md)\. \ No newline at end of file diff --git a/doc_source/PostgreSQL.Procedural.Importing.md b/doc_source/PostgreSQL.Procedural.Importing.md deleted file mode 100644 index 25603a4..0000000 --- a/doc_source/PostgreSQL.Procedural.Importing.md +++ /dev/null @@ -1,39 +0,0 @@ -# Importing data into PostgreSQL on Amazon RDS - -Suppose that you have an existing PostgreSQL deployment that you want to move to Amazon RDS\. The complexity of your task depends on the size of your database and the types of database objects that you're transferring\. For example, consider a database that contains datasets on the order of gigabytes, along with stored procedures and triggers\. Such a database is going to be more complicated than a simple database with only a few megabytes of test data and no triggers or stored procedures\. - -We recommend that you use native PostgreSQL database migration tools under the following conditions: -+ You have a homogeneous migration, where you are migrating from a database with the same database engine as the target database\. -+ You are migrating an entire database\. -+ The native tools allow you to migrate your system with minimal downtime\. - -In most other cases, performing a database migration using AWS Database Migration Service \(AWS DMS\) is the best approach\. AWS DMS can migrate databases without downtime and, for many database engines, continue ongoing replication until you are ready to switch over to the target database\. You can migrate to either the same database engine or a different database engine using AWS DMS\. If you are migrating to a different database engine than your source database, you can use the AWS Schema Conversion Tool \(AWS SCT\)\. You use AWS SCT to migrate schema objects that are not migrated by AWS DMS\. For more information about AWS DMS, see [ What is AWS Database Migration Service?](https://docs.aws.amazon.com/dms/latest/userguide/Welcome.html) - -Modify your DB parameter group to include the following settings *for your import only*\. You should test the parameter settings to find the most efficient settings for your DB instance size\. You also need to revert back to production values for these parameters after your import completes\. - -Modify your DB instance settings to the following: -+ Disable DB instance backups \(set backup\_retention to 0\)\. -+ Disable Multi\-AZ\. - -Modify your DB parameter group to include the following settings\. You should only use these settings when importing data\. You should test the parameter settings to find the most efficient settings for your DB instance size\. You also need to revert back to production values for these parameters after your import completes\. - - -| Parameter | Recommended value when importing | Description | -| --- | --- | --- | -| `maintenance_work_mem` | 524288, 1048576, 2097152, or 4194304 \(in KB\)\. These settings are comparable to 512 MB, 1 GB, 2 GB, and 4 GB\. | The value for this setting depends on the size of your host\. This parameter is used during CREATE INDEX statements and each parallel command can use this much memory\. Calculate the best value so that you don't set this value so high that you run out of memory\. | -| `max_wal_size` | 256 \(for version 9\.6\), 4096 \(for versions 10 and higher\) | Maximum size to let the WAL grow during automatic checkpoints\. Increasing this parameter can increase the amount of time needed for crash recovery\. This parameter replaces `checkpoint_segments` for PostgreSQL 9\.6 and later\. For PostgreSQL version 9\.6, this value is in 16 MB units\. For later versions, the value is in 1 MB units\. For example, in version 9\.6, 128 means 128 chunks that are each 16 MB in size\. In version 12\.4, 2048 means 2048 chunks that are each 1 MB in size\. | -| `checkpoint_timeout` | 1800 | The value for this setting allows for less frequent WAL rotation\. | -| `synchronous_commit` | Off | Disable this setting to speed up writes\. Turning this parameter off can increase the risk of data loss in the event of a server crash \(do not turn off FSYNC\)\. | -| `wal_buffers` | 8192 | This is value is in 8 KB units\. This again helps your WAL generation speed | -| `autovacuum` | 0 | Disable the PostgreSQL auto vacuum parameter while you are loading data so that it doesn't use resources | - -Use the `pg_dump -Fc` \(compressed\) or `pg_restore -j` \(parallel\) commands with these settings\. - -**Note** -The PostgreSQL command `pg_dumpall` requires super\_user permissions that are not granted when you create a DB instance, so it cannot be used for importing data\. - -**Topics** -+ [Importing a PostgreSQL database from an Amazon EC2 instance](PostgreSQL.Procedural.Importing.EC2.md) -+ [Using the \\copy command to import data to a table on a PostgreSQL DB instance](PostgreSQL.Procedural.Importing.Copy.md) -+ [Importing data from Amazon S3 into an RDS for PostgreSQL DB instance](USER_PostgreSQL.S3Import.md) -+ [Transporting PostgreSQL databases between DB instances](PostgreSQL.TransportableDB.md) \ No newline at end of file diff --git a/doc_source/PostgreSQL.TransportableDB.md b/doc_source/PostgreSQL.TransportableDB.md deleted file mode 100644 index a4e6886..0000000 --- a/doc_source/PostgreSQL.TransportableDB.md +++ /dev/null @@ -1,234 +0,0 @@ -# Transporting PostgreSQL databases between DB instances - -By using PostgreSQL transportable databases for Amazon RDS, you can move a PostgreSQL database between two DB instances\. This is a very fast way to migrate large databases between different DB instances\. To use this approach, your DB instances must both run the same major version of PostgreSQL\. - -This capability requires that you install the `pg_transport` extension on both the source and the destination DB instance\. The `pg_transport` extension provides a physical transport mechanism that moves the database files with minimal processing\. This mechanism moves data much faster than traditional dump and load processes, with less downtime\. - -**Note** -PostgreSQL transportable databases are available in RDS for PostgreSQL 11\.5 and higher, and RDS for PostgreSQL version 10\.10 and higher\. - -To transport a PostgreSQL DB instance from one RDS for PostgreSQL DB instance to another, you first set up the source and destination instances as detailed in [ Setting up a DB instance for transport](#PostgreSQL.TransportableDB.Setup)\. You can then transport the database by using the function described in [ Transporting a PostgreSQL database](#PostgreSQL.TransportableDB.Transporting)\. - -**Topics** -+ [Limitations for using PostgreSQL transportable databases](#PostgreSQL.TransportableDB.Limits) -+ [Setting up to transport a PostgreSQL database](#PostgreSQL.TransportableDB.Setup) -+ [Transporting a PostgreSQL database to the destination from the source](#PostgreSQL.TransportableDB.Transporting) -+ [What happens during database transport](#PostgreSQL.TransportableDB.DuringTransport) -+ [Transportable databases function reference](#PostgreSQL.TransportableDB.transport.import_from_server) -+ [Transportable databases parameter reference](#PostgreSQL.TransportableDB.Parameters) - -## Limitations for using PostgreSQL transportable databases - -Transportable databases have the following limitations: -+ **Read replicas ** – You can't use transportable databases on read replicas or parent instances of read replicas\. -+ **Unsupported column types** – You can't use the `reg` data types in any database tables that you plan to transport with this method\. These types depend on system catalog object IDs \(OIDs\), which often change during transport\. -+ **Tablespaces** – All source database objects must be in the default `pg_default` tablespace\. -+ **Compatibility** – Both the source and destination DB instances must run the same major version of PostgreSQL\. -+ **Extensions** – The source DB instance can have only the `pg_transport` installed\. -+ **Roles and ACLs** – The source database's access privileges and ownership information aren't carried over to the destination database\. All database objects are created and owned by the local destination user of the transport\. -+ **Concurrent transports** – A single DB instance can support up to 32 concurrent transports, including both imports and exports, if worker processes have been configured properly\. -+ **RDS for PostgreSQL DB instances only** – PostgreSQL transportable databases are supported on RDS for PostgreSQL DB instances only\. You can't use it with on\-premises databases or databases running on Amazon EC2\. - -## Setting up to transport a PostgreSQL database - -Before you begin, make sure that your RDS for PostgreSQL DB instances meet the following requirements: -+ The RDS for PostgreSQL DB instances for source and destination must run the same version of PostgreSQL\. -+ The destination DB can't have a database of the same name as the source DB that you want to transport\. -+ The account you use to run the transport needs `rds_superuser` privileges on both the source DB and the destination DB\. -+ The security group for the source DB instance must allow inbound access from the destination DB instance\. This might already be the case if your source and destination DB instances are located in the VPC\. For more information about security groups, see [Controlling access with security groups](Overview.RDSSecurityGroups.md)\. - -Transporting databases from a source DB instance to a destination DB instance requires several changes to the DB parameter group associated with each instance\. That means that you must create a custom DB parameter group for the source DB instance and create a custom DB parameter group for the destination DB instance\. - -**Note** -If your DB instances are already configured using custom DB parameter groups, you can start with step 2 in the following procedure\. - -**To configure the custom DB group parameters for transporting databases** - -For the following steps, use an account that has `rds_superuser` privileges\. - -1. If the source and destination DB instances use a default DB parameter group, you need to create a custom DB parameter using the appropriate version for your instances\. You do this so you can change values for several parameters\. For more information, see [Working with parameter groups](USER_WorkingWithParamGroups.md)\. - -1. In the custom DB parameter group, change values for the following parameters: - + `shared_preload_libraries` – Add `pg_transport` to the list of libraries\. - + `pg_transport.num_workers` – The default value is 3\. Increase or reduce this value as needed for your database\. For a 200 GB database, we recommend no larger than 8\. Keep in mind that if you increase the default value for this parameter, you should also increase the value of `max_worker_processes`\. - + `pg_transport.work_mem` – The default value is either 128 MB or 256 MB, depending on the PostgreSQL version\. The default setting can typically be left unchanged\. - + `max_worker_processes` – The value of this parameter needs to be set using the following calculation: - - ``` - 3 * pg_transport.num_workers) + 9 - ``` - - This value is required on the destination to handle various background worker processes involved in the transport\. To learn more about `max_worker_processes,` see [Resource Consumption](https://www.postgresql.org/docs/current/runtime-config-resource.html) in the PostgreSQL documentation\. - - For more information about `pg_transport` parameters, see [Transportable databases parameter reference ](#PostgreSQL.TransportableDB.Parameters)\. - -1. Reboot the source RDS for PostgreSQL DB instance and the destination instance so that the settings for the parameters take effect\. - -1. Connect to your RDS for PostgreSQL source DB instance\. - - ``` - psql --host=source-instance.111122223333.aws-region.rds.amazonaws.com --port=5432 --username=postgres --password - ``` - -1. Remove extraneous extensions from the public schema of the DB instance\. Only the `pg_transport` extension is allowed during the actual transport operation\. - -1. Install the `pg_transport` extension as follows: - - ``` - postgres=> CREATE EXTENSION pg_transport; - CREATE EXTENSION - ``` - -1. Connect to your RDS for PostgreSQL destination DB instance\. Remove any extraneous extensions, and then install the `pg_transport` extension\. - - ``` - postgres=> CREATE EXTENSION pg_transport; - CREATE EXTENSION - ``` - -## Transporting a PostgreSQL database to the destination from the source - -After you complete the process described in [Setting up to transport a PostgreSQL database](#PostgreSQL.TransportableDB.Setup), you can start the transport\. To do so, run the `transport.import_from_server` function on the destination DB instance\. In the syntax following you can find the function parameters\. - -``` -SELECT transport.import_from_server( - 'source-db-instance-endpoint', - source-db-instance-port, - 'source-db-instance-user', - 'source-user-password', - 'source-database-name', - 'destination-user-password', - false); -``` - -The `false` value shown in the example tells the function that this is not a dry run\. To test your transport setup, you can specify `true` for the `dry_run` option when you call the function, as shown following: - -``` -postgres=> SELECT transport.import_from_server( - 'docs-lab-source-db.666666666666aws-region.rds.amazonaws.com', 5432, - 'postgres', '********', 'labdb', '******', true); -INFO: Starting dry-run of import of database "labdb". -INFO: Created connections to remote database (took 0.03 seconds). -INFO: Checked remote cluster compatibility (took 0.05 seconds). -INFO: Dry-run complete (took 0.08 seconds total). - import_from_server --------------------- - -(1 row) -``` - -The INFO lines are output because the `pg_transport.timing` parameter is set to its default value, `true`\. Set the `dry_run` to `false` when you run the command and the source database is imported to the destination, as shown following: - -``` -INFO: Starting import of database "labdb". -INFO: Created connections to remote database (took 0.02 seconds). -INFO: Marked remote database as read only (took 0.13 seconds). -INFO: Checked remote cluster compatibility (took 0.03 seconds). -INFO: Signaled creation of PITR blackout window (took 2.01 seconds). -INFO: Applied remote database schema pre-data (took 0.50 seconds). -INFO: Created connections to local cluster (took 0.01 seconds). -INFO: Locked down destination database (took 0.00 seconds). -INFO: Completed transfer of database files (took 0.24 seconds). -INFO: Completed clean up (took 1.02 seconds). -INFO: Physical transport complete (took 3.97 seconds total). -import_from_server --------------------- -(1 row) -``` - -This function requires that you provide database user passwords\. Thus, we recommend that you change the passwords of the user roles you used after transport is complete\. Or, you can use SQL bind variables to create temporary user roles\. Use these temporary roles for the transport and then discard the roles afterwards\. - -If your transport isn't successful, you might see an error message similar to the following: - -``` -pg_transport.num_workers=8 25% of files transported failed to download file data -``` - -The "failed to download file data" error message indicates that the number of worker processes isn't set correctly for the size of the database\. You might need to increase or decrease the value set for `pg_transport.num_workers`\. Each failure reports the percentage of completion, so you can see the impact of your changes\. For example, changing the setting from 8 to 4 in one case resulted in the following: - -``` -pg_transport.num_workers=4 75% of files transported failed to download file data -``` - -Keep in mind that the `max_worker_processes` parameter is also taken into account during the transport process\. In other words, you might need to modify both `pg_transport.num_workers` and `max_worker_processes` to successfully transport the database\. The example shown finally worked when the `pg_transport.num_workers` was set to 2: - -``` -pg_transport.num_workers=2 100% of files transported -``` - -For more information about the `transport.import_from_server` function and its parameters, see [Transportable databases function reference](#PostgreSQL.TransportableDB.transport.import_from_server)\. - -## What happens during database transport - -The PostgreSQL transportable databases feature uses a pull model to import the database from the source DB instance to the destination\. The `transport.import_from_server` function creates the in\-transit database on the destination DB instance\. The in\-transit database is inaccessible on the destination DB instance for the duration of the transport\. - -When transport begins, all current sessions on the source database are ended\. Any databases other than the source database on the source DB instance aren't affected by the transport\. - -The source database is put into a special read\-only mode\. While it's in this mode, you can connect to the source database and run read\-only queries\. However, write\-enabled queries and some other types of commands are blocked\. Only the specific source database that is being transported is affected by these restrictions\. - -During transport, you can't restore the destination DB instance to a point in time\. This is because the transport isn't transactional and doesn't use the PostgreSQL write\-ahead log to record changes\. If the destination DB instance has automatic backups enabled, a backup is automatically taken after transport completes\. Point\-in\-time restores are available for times *after* the backup finishes\. - -If the transport fails, the `pg_transport` extension attempts to undo all changes to the source and destination DB instances\. This includes removing the destination's partially transported database\. Depending on the type of failure, the source database might continue to reject write\-enabled queries\. If this happens, use the following command to allow write\-enabled queries\. - -``` -ALTER DATABASE db-name SET default_transaction_read_only = false; -``` - -## Transportable databases function reference - -The `transport.import_from_server` function transports a PostgreSQL database by importing it from a source DB instance to a destination DB instance\. It does this by using a physical database connection transport mechanism\. - -Before starting the transport, this function verifies that the source and the destination DB instances are the same version and are compatible for the migration\. It also confirms that the destination DB instance has enough space for the source\. - -**Syntax** - -``` -transport.import_from_server( - host text, - port int, - username text, - password text, - database text, - local_password text, - dry_run bool -) -``` - -**Return Value** - -None\. - -**Parameters** - -You can find descriptions of the `transport.import_from_server` function parameters in the following table\. - - -**** - -| Parameter | Description | -| --- | --- | -| host | The endpoint of the source DB instance\. | -| port | An integer representing the port of the source DB instance\. PostgreSQL DB instances often use port 5432\. | -| username | The user of the source DB instance\. This user must be a member of the `rds_superuser` role\. | -| password | The user password of the source DB instance\. | -| database | The name of the database in the source DB instance to transport\. | -| local\_password | The local password of the current user for the destination DB instance\. This user must be a member of the `rds_superuser` role\. | -| dry\_run | An optional Boolean value specifying whether to perform a dry run\. The default is `false`, which means the transport proceeds\.To confirm compatibility between the source and destination DB instances without performing the actual transport, set dry\_run to true\. | - -**Example** - -For an example, see [ Transporting a PostgreSQL database to the destination from the source](#PostgreSQL.TransportableDB.Transporting)\. - -## Transportable databases parameter reference - -Several parameters control the behavior of the `pg_transport` extension\. Following, you can find descriptions of these parameters\. - -**`pg_transport.num_workers`** -The number of workers to use for the transport process\. The default is 3\. Valid values are 1–32\. Even the largest database transports typically require fewer than 8 workers\. The value of this setting on the destination DB instance is used by both destination and source during transport\. - -**`pg_transport.timing` ** -Specifies whether to report timing information during the transport\. The default is `true`, meaning that timing information is reported\. We recommend that you leave this parameter set to `true` so you can monitor progress\. For example output, see [ Transporting a PostgreSQL database to the destination from the source](#PostgreSQL.TransportableDB.Transporting)\. - -**`pg_transport.work_mem`** -The maximum amount of memory to allocate for each worker\. The default is 131072 kilobytes \(KB\) or 262144 KB \(256 MB\), depending on the PostgreSQL version\. The minimum value is 64 megabytes \(65536 KB\)\. Valid values are in kilobytes \(KBs\) as binary base\-2 units, where 1 KB = 1024 bytes\. -The transport might use less memory than is specified in this parameter\. Even large database transports typically require less than 256 MB \(262144 KB\) of memory per worker\. \ No newline at end of file diff --git a/doc_source/PostgreSQL.Tuning.concepts.md b/doc_source/PostgreSQL.Tuning.concepts.md deleted file mode 100644 index 5c28b10..0000000 --- a/doc_source/PostgreSQL.Tuning.concepts.md +++ /dev/null @@ -1,128 +0,0 @@ -# Essential concepts for RDS for PostgreSQL tuning - -Before you tune your RDS for PostgreSQL database, make sure to learn what wait events are and why they occur\. Also review the basic memory and disk architecture of RDS for PostgreSQL\. For a helpful architecture diagram, see the [PostgreSQL](https://en.wikibooks.org/wiki/PostgreSQL/Architecture) wikibook\. - -**Topics** -+ [RDS for PostgreSQL wait events](#PostgreSQL.Tuning.concepts.waits) -+ [RDS for PostgreSQL memory](#PostgreSQL.Tuning.concepts.memory) -+ [RDS for PostgreSQL processes](#PostgreSQL.Tuning.concepts.processes) - -## RDS for PostgreSQL wait events - -A *wait event* is an indication that the session is waiting for a resource\. For example, the wait event `Client:ClientRead` occurs when RDS for PostgreSQL is waiting to receive data from the client\. Sessions typically wait for resources such as the following\. -+ Single\-threaded access to a buffer, for example, when a session is attempting to modify a buffer -+ A row that is currently locked by another session -+ A data file read -+ A log file write - -For example, to satisfy a query, the session might perform a full table scan\. If the data isn't already in memory, the session waits for the disk I/O to complete\. When the buffers are read into memory, the session might need to wait because other sessions are accessing the same buffers\. The database records the waits by using a predefined wait event\. These events are grouped into categories\. - -By itself, a single wait event doesn't indicate a performance problem\. For example, if requested data isn't in memory, reading data from disk is necessary\. If one session locks a row for an update, another session waits for the row to be unlocked so that it can update it\. A commit requires waiting for the write to a log file to complete\. Waits are integral to the normal functioning of a database\. - -On the other hand, large numbers of wait events typically show a performance problem\. In such cases, you can use wait event data to determine where sessions are spending time\. For example, if a report that typically runs in minutes now takes hours to run, you can identify the wait events that contribute the most to total wait time\. If you can determine the causes of the top wait events, you can sometimes make changes that improve performance\. For example, if your session is waiting on a row that has been locked by another session, you can end the locking session\. - -## RDS for PostgreSQL memory - -RDS for PostgreSQL memory is divided into shared and local\. - -**Topics** -+ [Shared memory in RDS for PostgreSQL](#PostgreSQL.Tuning.concepts.shared) -+ [Local memory in RDS for PostgreSQL](#PostgreSQL.Tuning.concepts.local) - -### Shared memory in RDS for PostgreSQL - -RDS for PostgreSQL allocates shared memory when the instance starts\. Shared memory is divided into multiple subareas\. Following, you can find a description of the most important ones\. - -**Topics** -+ [Shared buffers](#PostgreSQL.Tuning.concepts.buffer-pool) -+ [Write ahead log \(WAL\) buffers](#PostgreSQL.Tuning.concepts.WAL) - -#### Shared buffers - -The *shared buffer pool* is an RDS for PostgreSQL memory area that holds all pages that are or were being used by application connections\. A *page* is the memory version of a disk block\. The shared buffer pool caches the data blocks read from disk\. The pool reduces the need to reread data from disk, making the database operate more efficiently\. - -Every table and index is stored as an array of pages of a fixed size\. Each block contains multiple tuples, which correspond to rows\. A tuple can be stored in any page\. - -The shared buffer pool has finite memory\. If a new request requires a page that isn't in memory, and no more memory exists, RDS for PostgreSQL evicts a less frequently used page to accommodate the request\. The eviction policy is implemented by a clock sweep algorithm\. - -The `shared_buffers` parameter determines how much memory the server dedicates to caching data\. - -#### Write ahead log \(WAL\) buffers - -A *write\-ahead log \(WAL\) buffer* holds transaction data that RDS for PostgreSQL later writes to persistent storage\. Using the WAL mechanism, RDS for PostgreSQL can do the following: -+ Recover data after a failure -+ Reduce disk I/O by avoiding frequent writes to disk - -When a client changes data, RDS for PostgreSQL writes the changes to the WAL buffer\. When the client issues a `COMMIT`, the WAL writer process writes transaction data to the WAL file\. - -The `wal_level` parameter determines how much information is written to the WAL\. - -### Local memory in RDS for PostgreSQL - -Every backend process allocates local memory for query processing\. - -**Topics** -+ [Work memory area](#PostgreSQL.Tuning.concepts.local.work_mem) -+ [Maintenance work memory area](#PostgreSQL.Tuning.concepts.local.maintenance_work_mem) -+ [Temporary buffer area](#PostgreSQL.Tuning.concepts.temp) - -#### Work memory area - -The *work memory area* holds temporary data for queries that performs sorts and hashes\. For example, a query with an `ORDER BY` clause performs a sort\. Queries use hash tables in hash joins and aggregations\. - -The `work_mem` parameter the amount of memory to be used by internal sort operations and hash tables before writing to temporary disk files\. The default value is 4 MB\. Multiple sessions can run simultaneously, and each session can run maintenance operations in parallel\. For this reason, the total work memory used can be multiples of the `work_mem` setting\. - -#### Maintenance work memory area - -The *maintenance work memory area* caches data for maintenance operations\. These operations include vacuuming, creating an index, and adding foreign keys\. - -The `maintenance_work_mem` parameter specifies the maximum amount of memory to be used by maintenance operations\. The default value is 64 MB\. A database session can only run one maintenance operation at a time\. - -#### Temporary buffer area - -The *temporary buffer area* caches temporary tables for each database session\. - -Each session allocates temporary buffers as needed up to the limit you specify\. When the session ends, the server clears the buffers\. - -The `temp_buffers` parameter sets the maximum number of temporary buffers used by each session\. Before the first use of temporary tables within a session, you can change the `temp_buffers` value\. - -## RDS for PostgreSQL processes - -RDS for PostgreSQL uses multiple processes\. - -**Topics** -+ [Postmaster process](#PostgreSQL.Tuning.concepts.postmaster) -+ [Backend processes](#PostgreSQL.Tuning.concepts.backend) -+ [Background processes](#PostgreSQL.Tuning.concepts.vacuum) - -### Postmaster process - -The *postmaster process* is the first process started when you start RDS for PostgreSQL\. The postmaster process has the following primary responsibilities: -+ Fork and monitor background processes -+ Receive authentication requests from client processes, and authenticate them before allowing the database to service requests - -### Backend processes - -If the postmaster authenticates a client request, the postmaster forks a new backend process, also called a postgres process\. One client process connects to exactly one backend process\. The client process and the backend process communicate directly without intervention by the postmaster process\. - -### Background processes - -The postmaster process forks several processes that perform different backend tasks\. Some of the more important include the following: -+ WAL writer - - RDS for PostgreSQL writes data in the WAL \(write ahead logging\) buffer to the log files\. The principle of write ahead logging is that the database can't write changes to the data files until after the database writes log records describing those changes to disk\. The WAL mechanism reduces disk I/O, and allows RDS for PostgreSQL to use the logs to recover the database after a failure\. -+ Background writer - - This process periodically write dirty \(modified\) pages from the memory buffers to the data files\. A page becomes dirty when a backend process modifies it in memory\. -+ Autovacuum daemon - - The daemon consists of the following: - + The autovacuum launcher - + The autovacuum worker processes - - When autovacuum is turned on, it checks for tables that have had a large number of inserted, updated, or deleted tuples\. The daemon has the following responsibilities: - + Recover or reuse disk space occupied by updated or deleted rows - + Update statistics used by the planner - + Protect against loss of old data because of transaction ID wraparound - - The autovacuum feature automates the execution of `VACUUM` and `ANALYZE` commands\. `VACUUM` has the following variants: standard and full\. Standard vacuum runs in parallel with other database operations\. `VACUUM FULL` requires an exclusive lock on the table it is working on\. Thus, it can't run in parallel with operations that access the same table\. `VACUUM` creates a substantial amount of I/O traffic, which can cause poor performance for other active sessions\. \ No newline at end of file diff --git a/doc_source/PostgreSQL.Tuning.concepts.summary.md b/doc_source/PostgreSQL.Tuning.concepts.summary.md deleted file mode 100644 index 6381fe5..0000000 --- a/doc_source/PostgreSQL.Tuning.concepts.summary.md +++ /dev/null @@ -1,23 +0,0 @@ -# RDS for PostgreSQL wait events - -The following table lists the wait events for RDS for PostgreSQL that most commonly indicate performance problems, and summarizes the most common causes and corrective actions\.\. - - -| Wait event | Definition | -| --- | --- | -| [Client:ClientRead](wait-event.clientread.md) | This event occurs when RDS for PostgreSQL is waiting to receive data from the client\. | -| [Client:ClientWrite](wait-event.clientwrite.md) | This event occurs when RDS for PostgreSQL is waiting to write data to the client\. | -| [CPU](wait-event.cpu.md) | This event occurs when a thread is active in CPU or is waiting for CPU\. | -| [IO:BufFileRead and IO:BufFileWrite](wait-event.iobuffile.md) | These events occur when RDS for PostgreSQL creates temporary files\. | -| [IO:DataFileRead](wait-event.iodatafileread.md) | This event occurs when a connection waits on a backend process to read a required page from storage because the page isn't available in shared memory\. | -| [IO:WALWrite](wait-event.iowalwrite.md) | This event occurs when RDS for PostgreSQL is waiting for the write\-ahead log \(WAL\) buffers to be written to a WAL file\. | -| [Lock:advisory](wait-event.lockadvisory.md) | This event occurs when a PostgreSQL application uses a lock to coordinate activity across multiple sessions\. | -| [Lock:extend](wait-event.lockextend.md) | This event occurs when a backend process is waiting to lock a relation to extend it while another process has a lock on that relation for the same purpose\. | -| [Lock:Relation](wait-event.lockrelation.md) | This event occurs when a query is waiting to acquire a lock on a table or view that's currently locked by another transaction\. | -| [Lock:transactionid](wait-event.locktransactionid.md) | This event occurs when a transaction is waiting for a row\-level lock\. | -| [Lock:tuple](wait-event.locktuple.md) | This event occurs when a backend process is waiting to acquire a lock on a tuple\. | -| [LWLock:BufferIO](wait-event.lwlockbufferio.md) | This event occurs when RDS for PostgreSQL is waiting for other processes to finish their input/output \(I/O\) operations when concurrently trying to access a page\. | -| [LWLock:buffer\_content \(BufferContent\)](wait-event.lwlockbuffercontent.md) | This event occurs when a session is waiting to read or write a data page in memory while another session has that page locked for writing\. | -| [LWLock:lock\_manager \(LWLock:lockmanager\)](wait-event.lw-lock-manager.md) | This event occurs when the RDS for PostgreSQL engine maintains the shared lock's memory area to allocate, check, and deallocate a lock when a fast path lock isn't possible\. | -| [Timeout:PgSleep](wait-event.timeoutpgsleep.md) | This event occurs when a server process has called the `pg_sleep` function and is waiting for the sleep timeout to expire\. | -| [Timeout:VacuumDelay](wait-event.timeoutvacuumdelay.md) | This event indicates that the vacuum process is sleeping because the estimated cost limit has been reached\. | \ No newline at end of file diff --git a/doc_source/PostgreSQL.Tuning.md b/doc_source/PostgreSQL.Tuning.md deleted file mode 100644 index 382394c..0000000 --- a/doc_source/PostgreSQL.Tuning.md +++ /dev/null @@ -1,25 +0,0 @@ -# Tuning with wait events for RDS for PostgreSQL - -Wait events are an important tuning tool for RDS for PostgreSQL\. When you can find out why sessions are waiting for resources and what they are doing, you're better able to reduce bottlenecks\. You can use the information in this section to find possible causes and corrective actions\. This section also discusses basic PostgreSQL tuning concepts\. - -The wait events in this section are specific to RDS for PostgreSQL\. - -**Topics** -+ [Essential concepts for RDS for PostgreSQL tuning](PostgreSQL.Tuning.concepts.md) -+ [RDS for PostgreSQL wait events](PostgreSQL.Tuning.concepts.summary.md) -+ [Client:ClientRead](wait-event.clientread.md) -+ [Client:ClientWrite](wait-event.clientwrite.md) -+ [CPU](wait-event.cpu.md) -+ [IO:BufFileRead and IO:BufFileWrite](wait-event.iobuffile.md) -+ [IO:DataFileRead](wait-event.iodatafileread.md) -+ [IO:WALWrite](wait-event.iowalwrite.md) -+ [Lock:advisory](wait-event.lockadvisory.md) -+ [Lock:extend](wait-event.lockextend.md) -+ [Lock:Relation](wait-event.lockrelation.md) -+ [Lock:transactionid](wait-event.locktransactionid.md) -+ [Lock:tuple](wait-event.locktuple.md) -+ [LWLock:BufferIO](wait-event.lwlockbufferio.md) -+ [LWLock:buffer\_content \(BufferContent\)](wait-event.lwlockbuffercontent.md) -+ [LWLock:lock\_manager \(LWLock:lockmanager\)](wait-event.lw-lock-manager.md) -+ [Timeout:PgSleep](wait-event.timeoutpgsleep.md) -+ [Timeout:VacuumDelay](wait-event.timeoutvacuumdelay.md) \ No newline at end of file diff --git a/doc_source/PostgreSQL.Tuning_proactive_insights.md b/doc_source/PostgreSQL.Tuning_proactive_insights.md deleted file mode 100644 index e12df8c..0000000 --- a/doc_source/PostgreSQL.Tuning_proactive_insights.md +++ /dev/null @@ -1,11 +0,0 @@ -# Tuning RDS for PostgreSQL with Amazon DevOps Guru proactive insights - -DevOps Guru proactive insights detects conditions on your RDS for PostgreSQL DB instances that can cause problems, and lets you know about them before they occur\. DevOps Guru can do the following: -+ Prevent many common database issues by cross\-checking your database configuration against common recommended settings\. -+ Alert you to critical issues in your fleet that, if left unchecked, can lead to larger problems later\. -+ Alert you to newly discovered problems\. - -Every proactive insight contains an analysis of the cause of the problem and recommendations for corrective actions\. - -**Topics** -+ [Database has long running idle in transaction connection](proactive-insights.idle-txn.md) \ No newline at end of file diff --git a/doc_source/PostgreSQL_Partitions.md b/doc_source/PostgreSQL_Partitions.md deleted file mode 100644 index b18672b..0000000 --- a/doc_source/PostgreSQL_Partitions.md +++ /dev/null @@ -1,173 +0,0 @@ -# Managing PostgreSQL partitions with the pg\_partman extension - -PostgreSQL table partitioning provides a framework for high\-performance handling of data input and reporting\. Use partitioning for databases that require very fast input of large amounts of data\. Partitioning also provides for faster queries of large tables\. Partitioning helps maintain data without impacting the database instance because it requires less I/O resources\. - -By using partitioning, you can split data into custom\-sized chunks for processing\. For example, you can partition time\-series data for ranges such as hourly, daily, weekly, monthly, quarterly, yearly, custom, or any combination of these\. For a time\-series data example, if you partition the table by hour, each partition contains one hour of data\. If you partition the time\-series table by day, the partitions holds one day's worth of data, and so on\. The partition key controls the size of a partition\. - -When you use an `INSERT` or `UPDATE` SQL command on a partitioned table, the database engine routes the data to the appropriate partition\. PostgreSQL table partitions that store the data are child tables of the main table\. - -During database query reads, the PostgreSQL optimizer examines the `WHERE` clause of the query and, if possible, directs the database scan to only the relevant partitions\. - -Starting with version 10, PostgreSQL uses declarative partitioning to implement table partitioning\. This is also known as native PostgreSQL partitioning\. Before PostgreSQL version 10, you used triggers to implement partitions\. - -PostgreSQL table partitioning provides the following features: -+ Creation of new partitions at any time\. -+ Variable partition ranges\. -+ Detachable and reattachable partitions using data definition language \(DDL\) statements\. - - For example, detachable partitions are useful for removing historical data from the main partition but keeping historical data for analysis\. -+ New partitions inherit the parent database table properties, including the following: - + Indexes - + Primary keys, which must include the partition key column - + Foreign keys - + Check constraints - + References -+ Creating indexes for the full table or each specific partition\. - -You can't alter the schema for an individual partition\. However, you can alter the parent table \(such as adding a new column\), which propagates to partitions\. - -**Topics** -+ [Overview of the PostgreSQL pg\_partman extension](#PostgreSQL_Partitions.pg_partman) -+ [Enabling the pg\_partman extension](#PostgreSQL_Partitions.enable) -+ [Configuring partitions using the create\_parent function](#PostgreSQL_Partitions.create_parent) -+ [Configuring partition maintenance using the run\_maintenance\_proc function](#PostgreSQL_Partitions.run_maintenance_proc) - -## Overview of the PostgreSQL pg\_partman extension - -You can use the PostgreSQL `pg_partman` extension to automate the creation and maintenance of table partitions\. For more general information, see [PG Partition Manager](https://github.com/pgpartman/pg_partman) in the `pg_partman` documentation\. - -**Note** -The `pg_partman` extension is supported on RDS for PostgreSQL versions 12\.5 and higher\. - -Instead of having to manually create each partition, you configure `pg_partman` with the following settings: -+ Table to be partitioned -+ Partition type -+ Partition key -+ Partition granularity -+ Partition precreation and management options - -After you create a PostgreSQL partitioned table, you register it with `pg_partman` by calling the `create_parent` function\. Doing this creates the necessary partitions based on the parameters you pass to the function\. - -The `pg_partman` extension also provides the `run_maintenance_proc` function, which you can call on a scheduled basis to automatically manage partitions\. To ensure that the proper partitions are created as needed, schedule this function to run periodically \(such as hourly\)\. You can also ensure that partitions are automatically dropped\. - -## Enabling the pg\_partman extension - -If you have multiple databases inside the same PostgreSQL DB instance for which you want to manage partitions, enable the `pg_partman` extension separately for each database\. To enable the `pg_partman` extension for a specific database, create the partition maintenance schema and then create the `pg_partman` extension as follows\. - -``` -CREATE SCHEMA partman; -CREATE EXTENSION pg_partman WITH SCHEMA partman; -``` - -**Note** -To create the `pg_partman` extension, make sure that you have `rds_superuser` privileges\. - -If you receive an error such as the following, grant the `rds_superuser` privileges to the account or use your superuser account\. - -``` -ERROR: permission denied to create extension "pg_partman" -HINT: Must be superuser to create this extension. -``` - -To grant `rds_superuser` privileges, connect with your superuser account and run the following command\. - -``` -GRANT rds_superuser TO user-or-role; -``` - -For the examples that show using the pg\_partman extension, we use the following sample database table and partition\. This database uses a partitioned table based on a timestamp\. A schema `data_mart` contains a table named `events` with a column named `created_at`\. The following settings are included in the `events` table: -+ Primary keys `event_id` and `created_at`, which must have the column used to guide the partition\. -+ A check constraint `ck_valid_operation` to enforce values for an `operation` table column\. -+ Two foreign keys, where one \(`fk_orga_membership)` points to the external table `organization` and the other \(`fk_parent_event_id`\) is a self\-referenced foreign key\. -+ Two indexes, where one \(`idx_org_id`\) is for the foreign key and the other \(`idx_event_type`\) is for the event type\. - -The follow DDL statements create these objects, which are automatically included on each partition\. - -``` -CREATE SCHEMA data_mart; -CREATE TABLE data_mart.organization ( org_id BIGSERIAL, - org_name TEXT, - CONSTRAINT pk_organization PRIMARY KEY (org_id) - ); - -CREATE TABLE data_mart.events( - event_id BIGSERIAL, - operation CHAR(1), - value FLOAT(24), - parent_event_id BIGINT, - event_type VARCHAR(25), - org_id BIGSERIAL, - created_at timestamp, - CONSTRAINT pk_data_mart_event PRIMARY KEY (event_id, created_at), - CONSTRAINT ck_valid_operation CHECK (operation = 'C' OR operation = 'D'), - CONSTRAINT fk_orga_membership - FOREIGN KEY(org_id) - REFERENCES data_mart.organization (org_id), - CONSTRAINT fk_parent_event_id - FOREIGN KEY(parent_event_id, created_at) - REFERENCES data_mart.events (event_id,created_at) - ) PARTITION BY RANGE (created_at); - -CREATE INDEX idx_org_id ON data_mart.events(org_id); -CREATE INDEX idx_event_type ON data_mart.events(event_type); -``` - - - -## Configuring partitions using the create\_parent function - -After you enable the `pg_partman` extension, use the `create_parent` function to configure partitions inside the partition maintenance schema\. The following example uses the `events` table example created in [Enabling the pg\_partman extensionConfiguring partition maintenance using the run\_maintenance\_proc function](#PostgreSQL_Partitions.enable)\. Call the `create_parent` function as follows\. - -``` -SELECT partman.create_parent( p_parent_table => 'data_mart.events', - p_control => 'created_at', - p_type => 'native', - p_interval=> 'daily', - p_premake => 30); -``` - -The parameters are as follows: -+ `p_parent_table` – The parent partitioned table\. This table must already exist and be fully qualified, including the schema\. -+ `p_control` – The column on which the partitioning is to be based\. The data type must be an integer or time\-based\. -+ `p_type` – The type is either `'native'` or `'partman'`\. You typically use the `native` type for its performance improvements and flexibility\. The `partman` type relies on inheritance\. -+ `p_interval` – The time interval or integer range for each partition\. Example values include `daily`, hourly, and so on\. -+ `p_premake` – The number of partitions to create in advance to support new inserts\. - -For a complete description of the `create_parent` function, see [Creation Functions](https://github.com/pgpartman/pg_partman/blob/master/doc/pg_partman.md#user-content-creation-functions) in the `pg_partman` documentation\. - -## Configuring partition maintenance using the run\_maintenance\_proc function - -You can run partition maintenance operations to automatically create new partitions, detach partitions, or remove old partitions\. Partition maintenance relies on the `run_maintenance_proc` function of the `pg_partman` extension and the `pg_cron` extension, which initiates an internal scheduler\. The `pg_cron` scheduler automatically executes SQL statements, functions, and procedures defined in your databases\. - -The following example uses the `events` table example created in [Enabling the pg\_partman extensionConfiguring partition maintenance using the run\_maintenance\_proc function](#PostgreSQL_Partitions.enable) to set partition maintenance operations to run automatically\. As a prerequisite, add `pg_cron` to the `shared_preload_libraries` parameter in the DB instance's parameter group\. - -``` -CREATE EXTENSION pg_cron; - -UPDATE partman.part_config -SET infinite_time_partitions = true, - retention = '3 months', - retention_keep_table=true -WHERE parent_table = 'data_mart.events'; -SELECT cron.schedule('@hourly', $$CALL partman.run_maintenance_proc()$$); -``` - -Following, you can find a step\-by\-step explanation of the preceding example: - -1. Modify the parameter group associated with your DB instance and add `pg_cron` to the `shared_preload_libraries` parameter value\. This change requires a DB instance restart for it to take effect\. For more information, see [Modifying parameters in a DB parameter group](USER_WorkingWithDBInstanceParamGroups.md#USER_WorkingWithParamGroups.Modifying)\. - -1. Run the command `CREATE EXTENSION pg_cron;` using an account that has the `rds_superuser` permissions\. Doing this enables the `pg_cron` extension\. For more information, see [Scheduling maintenance with the PostgreSQL pg\_cron extension](PostgreSQL_pg_cron.md)\. - -1. Run the command `UPDATE partman.part_config` to adjust the `pg_partman` settings for the `data_mart.events` table\. - -1. Run the command `SET` \. \. \. to configure the `data_mart.events` table, with these clauses: - - 1. `infinite_time_partitions = true,` – Configures the table to be able to automatically create new partitions without any limit\. - - 1. `retention = '3 months',` – Configures the table to have a maximum retention of three months\. - - 1. `retention_keep_table=true `– Configures the table so that when the retention period is due, the table isn't deleted automatically\. Instead, partitions that are older than the retention period are only detached from the parent table\. - -1. Run the command `SELECT cron.schedule` \. \. \. to make a `pg_cron` function call\. This call defines how often the scheduler runs the `pg_partman` maintenance procedure, `partman.run_maintenance_proc`\. For this example, the procedure runs every hour\. - -For a complete description of the `run_maintenance_proc` function, see [Maintenance Functions](https://github.com/pgpartman/pg_partman/blob/master/doc/pg_partman.md#maintenance-functions) in the `pg_partman` documentation\. \ No newline at end of file diff --git a/doc_source/PostgreSQL_pg_cron.md b/doc_source/PostgreSQL_pg_cron.md deleted file mode 100644 index ff89243..0000000 --- a/doc_source/PostgreSQL_pg_cron.md +++ /dev/null @@ -1,271 +0,0 @@ -# Scheduling maintenance with the PostgreSQL pg\_cron extension - -You can use the PostgreSQL `pg_cron` extension to schedule maintenance commands within a PostgreSQL database\. For more information about the extension, see [What is pg\_cron?](https://github.com/citusdata/pg_cron) in the pg\_cron documentation\. - -The `pg_cron` extension is supported on RDS for PostgreSQL engine versions 12\.5 and higher\. - -To learn more about using `pg_cron`, see [Schedule jobs with pg\_cron on your RDS for PostgreSQL or your Aurora PostgreSQL\-Compatible Edition databases](https://aws.amazon.com/blogs/database/schedule-jobs-with-pg_cron-on-your-amazon-rds-for-postgresql-or-amazon-aurora-for-postgresql-databases/)\. - -**Topics** -+ [Setting up the pg\_cron extension](#PostgreSQL_pg_cron.enable) -+ [Granting database users permissions to use pg\_cron](#PostgreSQL_pg_cron.permissions) -+ [Scheduling pg\_cron jobs](#PostgreSQL_pg_cron.examples) -+ [Reference for the pg\_cron extension](#PostgreSQL_pg_cron.reference) - -## Setting up the pg\_cron extension - -Set up the `pg_cron` extension as follows: - -1. Modify the custom parameter group associated with your PostgreSQL DB instance by adding `pg_cron` to the `shared_preload_libraries` parameter value\. - + If your RDS for PostgreSQL DB instance uses the `rds.allowed_extensions` parameter to explicitly list extensions that can be installed, you need to add the `pg_cron` extension to the list\. Only certain versions of RDS for PostgreSQL support the `rds.allowed_extensions` parameter\. By default, all available extensions are allowed\. For more information, see [Restricting installation of PostgreSQL extensions](CHAP_PostgreSQL.md#PostgreSQL.Concepts.General.FeatureSupport.Extensions.Restriction)\. - - Restart the PostgreSQL DB instance to have changes to the parameter group take effect\. To learn more about working with parameter groups, see [Modifying parameters in a DB parameter group](USER_WorkingWithDBInstanceParamGroups.md#USER_WorkingWithParamGroups.Modifying)\. - -1. After the PostgreSQL DB instance has restarted, run the following command using an account that has `rds_superuser` permissions\. For example, if you used the default settings when you created your RDS for PostgreSQL DB instance, connect as user `postgres` and create the extension\. - - ``` - CREATE EXTENSION pg_cron; - ``` - - The `pg_cron` scheduler is set in the default PostgreSQL database named `postgres`\. The `pg_cron` objects are created in this `postgres` database and all scheduling actions run in this database\. - -1. You can use the default settings, or you can schedule jobs to run in other databases within your PostgreSQL DB instance\. To schedule jobs for other databases within your PostgreSQL DB instance, see the example in [Scheduling a cron job for a database other than the default database](#PostgreSQL_pg_cron.otherDB)\. - -## Granting database users permissions to use pg\_cron - -Installing the `pg_cron` extension requires the `rds_superuser` privileges\. However, permissions to use the `pg_cron` can be granted \(by a member of the `rds_superuser` group/role\) to other database users, so that they can schedule their own jobs\. We recommend that you grant permissions to the `cron` schema only as needed if it improves operations in your production environment\. - -To grant a database user permission in the `cron` schema, run the following command: - -``` -postgres=> GRANT USAGE ON SCHEMA cron TO db-user; -``` - -This gives *db\-user* permission to access the `cron` schema to schedule cron jobs for the objects that they have permissions to access\. If the database user doesn't have permissions, the job fails after posting the error message to the `postgresql.log` file, as shown in the following: - -``` -2020-12-08 16:41:00 UTC::@:[30647]:ERROR: permission denied for table table-name -2020-12-08 16:41:00 UTC::@:[27071]:LOG: background worker "pg_cron" (PID 30647) exited with exit code 1 -``` - -IN other words, make sure that database users that are granted permissions on the `cron` schema also have permissions on the objects \(tables, schemas, and so on\) that they plan to schedule\. - -The details of the cron job and it success or failure are also captured in the `cron.job_run_details` table\. For more information, see [Tables for scheduling jobs and capturing status ](#PostgreSQL_pg_cron.tables)\. - -## Scheduling pg\_cron jobs - -The following sections show how you can schedule various management tasks using `pg_cron` jobs\. - -**Note** -When you create `pg_cron` jobs, check that the `max_worker_processes` setting is larger than the number of `cron.max_running_jobs`\. A `pg_cron` job fails if it runs out of background worker processes\. The default number of `pg_cron` jobs is `5`\. For more information, see [Parameters for managing the pg\_cron extension](#PostgreSQL_pg_cron.parameters)\. - -**Topics** -+ [Vacuuming a table](#PostgreSQL_pg_cron.vacuum) -+ [Purging the pg\_cron history table](#PostgreSQL_pg_cron.job_run_details) -+ [Logging errors to the postgresql\.log file only](#PostgreSQL_pg_cron.log_run) -+ [Scheduling a cron job for a database other than the default database](#PostgreSQL_pg_cron.otherDB) - -### Vacuuming a table - -Autovacuum handles vacuum maintenance for most cases\. However, you might want to schedule a vacuum of a specific table at a time of your choosing\. - -See also, [Working with the PostgreSQL autovacuum on Amazon RDS for PostgreSQL](Appendix.PostgreSQL.CommonDBATasks.Autovacuum.md)\. - -Following is an example of using the `cron.schedule` function to set up a job to use `VACUUM FREEZE` on a specific table every day at 22:00 \(GMT\)\. - -``` -SELECT cron.schedule('manual vacuum', '0 22 * * *', 'VACUUM FREEZE pgbench_accounts'); - schedule ----------- -1 -(1 row) -``` - -After the preceding example runs, you can check the history in the `cron.job_run_details` table as follows\. - -``` -postgres=> SELECT * FROM cron.job_run_details; -jobid | runid | job_pid | database | username | command | status | return_message | start_time | end_time --------+-------+---------+----------+----------+--------------------------------+-----------+----------------+-------------------------------+------------------------------- - 1 | 1 | 3395 | postgres | adminuser| vacuum freeze pgbench_accounts | succeeded | VACUUM | 2020-12-04 21:10:00.050386+00 | 2020-12-04 21:10:00.072028+00 -(1 row) -``` - -Following is an querying the `cron.job_run_details` table to see failed jobs\. - -``` -postgres=> SELECT * FROM cron.job_run_details WHERE status = 'failed'; -jobid | runid | job_pid | database | username | command | status | return_message | start_time | end_time -------+-------+---------+----------+----------+-------------------------------+--------+--------------------------------------------------+-------------------------------+------------------------------ - 5 | 4 | 30339 | postgres | adminuser| vacuum freeze pgbench_account | failed | ERROR: relation "pgbench_account" does not exist | 2020-12-04 21:48:00.015145+00 | 2020-12-04 21:48:00.029567+00 -(1 row) -``` - -For more information, see [Tables for scheduling jobs and capturing status ](#PostgreSQL_pg_cron.tables)\. - -### Purging the pg\_cron history table - -The `cron.job_run_details` table contains a history of cron jobs that can become very large over time\. We recommend that you schedule a job that purges this table\. For example, keeping a week's worth of entries might be sufficient for troubleshooting purposes\. - -The following example uses the [cron\.schedule](#PostgreSQL_pg_cron.schedule) function to schedule a job that runs every day at midnight to purge the `cron.job_run_details` table\. The job keeps only the last seven days\. Use your `rds_superuser` account to schedule the job such as the following\. - -``` -SELECT cron.schedule('0 0 * * *', $$DELETE - FROM cron.job_run_details - WHERE end_time < now() - interval '7 days'$$); -``` - -For more information, see [Tables for scheduling jobs and capturing status ](#PostgreSQL_pg_cron.tables)\. - -### Logging errors to the postgresql\.log file only - -To prevent writing to the `cron.job_run_details` table, modify the parameter group associated with the PostgreSQL DB instance and set the `cron.log_run` parameter to off\. The `pg_cron` extension no longer writes to the table and captures errors to the `postgresql.log` file only\. For more information, see [Modifying parameters in a DB parameter group](USER_WorkingWithDBInstanceParamGroups.md#USER_WorkingWithParamGroups.Modifying)\. - -Use the following command to check the value of the `cron.log_run` parameter\. - -``` -postgres=> SHOW cron.log_run; -``` - -For more information, see [Parameters for managing the pg\_cron extension](#PostgreSQL_pg_cron.parameters)\. - -### Scheduling a cron job for a database other than the default database - -The metadata for `pg_cron` is all held in the PostgreSQL default database named `postgres`\. Because background workers are used for running the maintenance cron jobs, you can schedule a job in any of your databases within the PostgreSQL DB instance: - -1. In the cron database, schedule the job as you normally do using the [cron\.schedule](#PostgreSQL_pg_cron.schedule)\. - - ``` - postgres=> SELECT cron.schedule('database1 manual vacuum', '29 03 * * *', 'vacuum freeze test_table'); - ``` - -1. As a user with the `rds_superuser` role, update the database column for the job that you just created so that it runs in another database within your PostgreSQL DB instance\. - - ``` - postgres=> UPDATE cron.job SET database = 'database1' WHERE jobid = 106; - ``` - -1. Verify by querying the `cron.job` table\. - - ``` - postgres=> SELECT * FROM cron.job; - jobid | schedule | command | nodename | nodeport | database | username | active | jobname - ------+-------------+--------------------------------+-----------+----------+----------+-----------+--------+------------------------- - 106 | 29 03 * * * | vacuum freeze test_table | localhost | 8192 | database1| adminuser | t | database1 manual vacuum - 1 | 59 23 * * * | vacuum freeze pgbench_accounts | localhost | 8192 | postgres | adminuser | t | manual vacuum - (2 rows) - ``` - -**Note** -In some situations, you might add a cron job that you intend to run on a different database\. In such cases, the job might try to run in the default database \(`postgres`\) before you update the correct database column\. If the user name has permissions, the job successfully runs in the default database\. - -## Reference for the pg\_cron extension - -You can use the following parameters, functions, and tables with the `pg_cron` extension\. For more information, see [What is pg\_cron?](https://github.com/citusdata/pg_cron) in the pg\_cron documentation\. - -**Topics** -+ [Parameters for managing the pg\_cron extension](#PostgreSQL_pg_cron.parameters) -+ [Function reference: cron\.schedule](#PostgreSQL_pg_cron.schedule) -+ [Function reference: cron\.unschedule](#PostgreSQL_pg_cron.unschedule) -+ [Tables for scheduling jobs and capturing status](#PostgreSQL_pg_cron.tables) - -### Parameters for managing the pg\_cron extension - -Following is a list of parameters that control the `pg_cron` extension behavior\. - - -| Parameter | Description | -| --- | --- | -| `cron.database_name` | The database in which `pg_cron` metadata is kept\. | -| cron\.host | The hostname to connect to PostgreSQL\. You can't modify this value\. | -| cron\.log\_run | Log every job that runs in the `job_run_details` table\. Values are `on` or `off`\. For more information, see [Tables for scheduling jobs and capturing status ](#PostgreSQL_pg_cron.tables)\. | -| cron\.log\_statement | Log all cron statements before running them\. Values are `on` or `off`\. | -| cron\.max\_running\_jobs | The maximum number of jobs that can run concurrently\. | -| cron\.use\_background\_workers | Use background workers instead of client sessions\. You can't modify this value\. | - -Use the following SQL command to display these parameters and their values\. - -``` -postgres=> SELECT name, setting, short_desc FROM pg_settings WHERE name LIKE 'cron.%' ORDER BY name; -``` - -### Function reference: cron\.schedule - -This function schedules a cron job\. The job is initially scheduled in the default `postgres` database\. The function returns a `bigint` value representing the job identifier\. To schedule jobs to run in other databases within your PostgreSQL DB instance, see the example in [Scheduling a cron job for a database other than the default database](#PostgreSQL_pg_cron.otherDB)\. - -The function has two syntax formats\. - -**Syntax** - -``` -cron.schedule (job_name, - schedule, - command -); - -cron.schedule (schedule, - command -); -``` - -**Parameters** -[\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/PostgreSQL_pg_cron.html) - -**Examples** - -``` -postgres=> SELECT cron.schedule ('test','0 10 * * *', 'VACUUM pgbench_history'); - schedule ----------- - 145 -(1 row) - -postgres=> SELECT cron.schedule ('0 15 * * *', 'VACUUM pgbench_accounts'); - schedule ----------- - 146 -(1 row) -``` - -### Function reference: cron\.unschedule - -This function deletes a cron job\. You can specify either the `job_name` or the `job_id`\. A policy makes sure that you are the owner to remove the schedule for the job\. The function returns a Boolean indicating success or failure\. - -The function has the following syntax formats\. - -**Syntax** - -``` -cron.unschedule (job_id); - -cron.unschedule (job_name); -``` - -**Parameters** -[\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/PostgreSQL_pg_cron.html) - -**Examples** - -``` -postgres=> SELECT cron.unschedule(108); - unschedule ------------- - t -(1 row) - -postgres=> SELECT cron.unschedule('test'); - unschedule ------------- - t -(1 row) -``` - -### Tables for scheduling jobs and capturing status - -The following tables are used to schedule the cron jobs and record how the jobs completed\. - - -| Table | Description | -| --- | --- | -| cron\.job | Contains the metadata about each scheduled job\. Most interactions with this table should be done by using the `cron.schedule` and `cron.unschedule` functions\. We recommend that you don't give update or insert privileges directly to this table\. Doing so would allow the user to update the `username` column to run as `rds-superuser`\. | -| cron\.job\_run\_details | Contains historic information about past scheduled jobs that ran\. This is useful to investigate the status, return messages, and start and end time from the job that ran\. To prevent this table from growing indefinitely, purge it on a regular basis\. For an example, see [Purging the pg\_cron history table](#PostgreSQL_pg_cron.job_run_details)\. | \ No newline at end of file diff --git a/doc_source/PostgreSQL_trusted_language_extension-functions-reference.md b/doc_source/PostgreSQL_trusted_language_extension-functions-reference.md deleted file mode 100644 index 47a97df..0000000 --- a/doc_source/PostgreSQL_trusted_language_extension-functions-reference.md +++ /dev/null @@ -1,20 +0,0 @@ -# Functions reference for Trusted Language Extensions for PostgreSQL - -View the following reference documentation about functions available in Trusted Language Extensions for PostgreSQL\. Use these functions to install, register, update, and manage your *TLE extensions*, that is, the PostgreSQL extensions that you develop using the Trusted Language Extensions development kit\. - -**Topics** -+ [pgtle\.available\_extensions](pgtle.available_extensions.md) -+ [pgtle\.available\_extension\_versions](pgtle.available_extension_versions.md) -+ [pgtle\.extension\_update\_paths](pgtle.extension_update_paths.md) -+ [pgtle\.install\_extension](pgtle.install_extension.md) -+ [pgtle\.install\_update\_path](pgtle.install_update_path.md) -+ [pgtle\.register\_feature](pgtle.register_feature.md) -+ [pgtle\.register\_feature\_if\_not\_exists](pgtle.register_feature_if_not_exists.md) -+ [pgtle\.set\_default\_version](pgtle.set_default_version.md) -+ [pgtle\.uninstall\_extension\(name\)](pgtle.uninstall_extension-name.md) -+ [pgtle\.uninstall\_extension\(name, version\)](pgtle.uninstall_extension-name-version.md) -+ [pgtle\.uninstall\_extension\_if\_exists](pgtle.uninstall_extension_if_exists.md) -+ [pgtle\.uninstall\_update\_path](pgtle.uninstall_update_path.md) -+ [pgtle\.uninstall\_update\_path\_if\_exists](pgtle.uninstall_update_path_if_exists.md) -+ [pgtle\.unregister\_feature](pgtle.unregister_feature.md) -+ [pgtle\.unregister\_feature\_if\_exists](pgtle.unregister_feature_if_exists.md) \ No newline at end of file diff --git a/doc_source/PostgreSQL_trusted_language_extension-hooks-reference.md b/doc_source/PostgreSQL_trusted_language_extension-hooks-reference.md deleted file mode 100644 index f8740d2..0000000 --- a/doc_source/PostgreSQL_trusted_language_extension-hooks-reference.md +++ /dev/null @@ -1,8 +0,0 @@ -# Hooks reference for Trusted Language Extensions for PostgreSQL - -Trusted Language Extensions for PostgreSQL supports PostgreSQL hooks\. A *hook* is an internal callback mechanism available to developers for extending PostgreSQL's core functionality\. By using hooks, developers can implement their own functions or procedures for use during various database operations, thereby modifying PostgreSQL's behavior in some way\. For example, you can use a `passcheck` hook to customize how PostgreSQL handles the passwords supplied when creating or changing passwords for users \(roles\)\. - -View the following documentation to learn about the hooks available for your TLE extensions\. - -**Topics** -+ [Password\-check hook \(passcheck\)](passcheck_hook.md) \ No newline at end of file diff --git a/doc_source/PostgreSQL_trusted_language_extension.md b/doc_source/PostgreSQL_trusted_language_extension.md deleted file mode 100644 index 05ac6f3..0000000 --- a/doc_source/PostgreSQL_trusted_language_extension.md +++ /dev/null @@ -1,793 +0,0 @@ -# Working with Trusted Language Extensions for PostgreSQL - -Trusted Language Extensions for PostgreSQL is an open source development kit for building PostgreSQL extensions\. It allows you to build high performance PostgreSQL extensions and safely run them on your RDS for PostgreSQL DB instance\. By using Trusted Language Extensions \(TLE\) for PostgreSQL, you can create PostgreSQL extensions that follow the documented approach for extending PostgreSQL functionality\. For more information, see [Packaging Related Objects into an Extension](https://www.postgresql.org/docs/current/extend-extensions.html) in the PostgreSQL documentation\. - -One key benefit of TLE is that you can use it in environments that don't provide access to the file system underlying the PostgreSQL instance\. Previously, installing a new extension required access to the file system\. TLE removes this constraint\. It provides a development environment for creating new extensions for any PostgreSQL database, including those running on your RDS for PostgreSQL DB instances\. - -TLE is designed to prevent access to unsafe resources for the extensions that you create using TLE\. Its runtime environment limits the impact of any extension defect to a single database connection\. TLE also gives database administrators fine\-grained control over who can install extensions, and it provides a permissions model for running them\. - -TLE is supported on RDS for PostgreSQL version 14\.5 and higher versions\. The Trusted Language Extensions development environment and runtime are packaged as the `pg_tle` PostgreSQL extension, version 1\.0\.1\. It supports creating extensions in JavaScript, Perl, Tcl, PL/pgSQL, and SQL\. You install the `pg_tle` extension in your RDS for PostgreSQL DB instance in the same way that you install other PostgreSQL extensions\. After the `pg_tle` is set up, developers can use it to create new PostgreSQL extensions, known as *TLE extensions*\. - - - -In the following topics, you can find information about how to set up Trusted Language Extensions and how to get started creating your own TLE extensions\. - -**Topics** -+ [Terminology](#PostgreSQL_trusted_language_extension-terminology) -+ [Requirements for using Trusted Language Extensions for PostgreSQL](#PostgreSQL_trusted_language_extension-requirements) -+ [Setting up Trusted Language Extensions in your RDS for PostgreSQL DB instance](#PostgreSQL_trusted_language_extension-setting-up) -+ [Overview of Trusted Language Extensions for PostgreSQL](#PostgreSQL_trusted_language_extension.overview) -+ [Creating TLE extensions for RDS for PostgreSQL](#PostgreSQL_trusted_language_extension-creating-TLE-extensions) -+ [Dropping your TLE extensions from a database](#PostgreSQL_trusted_language_extension-creating-TLE-extensions.dropping-TLEs) -+ [Uninstalling Trusted Language Extensions for PostgreSQL](#PostgreSQL_trusted_language_extension-uninstalling-pg_tle-devkit) -+ [Using PostgreSQL hooks with your TLE extensions](#PostgreSQL_trusted_language_extension.overview.tles-and-hooks) -+ [Functions reference for Trusted Language Extensions for PostgreSQL](PostgreSQL_trusted_language_extension-functions-reference.md) -+ [Hooks reference for Trusted Language Extensions for PostgreSQL](PostgreSQL_trusted_language_extension-hooks-reference.md) - -## Terminology - -To help you better understand Trusted Language Extensions, view the following glossary for terms used in this topic\. - -**Trusted Language Extensions for PostgreSQL** -*Trusted Language Extensions for PostgreSQL* is the official name of the open source development kit that's packaged as the `pg_tle` extension\. It's available for use on any PostgreSQL system\. For more information, see [aws/pg\_tle](https://github.com/aws/pg_tle) on GitHub\. - -**Trusted Language Extensions** -*Trusted Language Extensions* is the short name for Trusted Language Extensions for PostgreSQL\. This shortened name and its abbreviation \(TLE\) are also used in this documentation\. - -**trusted language** -A *trusted language* is a programming or scripting language that has specific security attributes\. For example, trusted languages typically restrict access to the file system, and they limit use of specified networking properties\. The TLE development kit is designed to support trusted languages\. PostgreSQL supports several different languages that are used to create trusted or untrusted extensions\. For an example, see [Trusted and Untrusted PL/Perl](https://www.postgresql.org/docs/current/plperl-trusted.html) in the PostgreSQL documentation\. When you create an extension using Trusted Language Extensions, the extension inherently uses trusted language mechanisms\. - -**TLE extension** -A *TLE extension* is a PostgreSQL extension that's been created by using the Trusted Language Extensions \(TLE\) development kit\. - -## Requirements for using Trusted Language Extensions for PostgreSQL - -Use the following requirements for setting up and using the TLE development kit\. -+ ** RDS for PostgreSQL 14\.5 or higher version** – Trusted Language Extensions is supported on RDS for PostgreSQL version 14\.5 and higher releases only\. - + If you need to upgrade your RDS for PostgreSQL instance, see [Upgrading the PostgreSQL DB engine for Amazon RDS](USER_UpgradeDBInstance.PostgreSQL.md)\. - + If you don't yet have an Amazon RDS DB instance running PostgreSQL, you can create one\. For more information, see RDS for PostgreSQL DB instance, see [Creating and connecting to a PostgreSQL DB instance](CHAP_GettingStarted.CreatingConnecting.PostgreSQL.md)\. -+ **Requires `rds_superuser` privileges** – To set up and configure the `pg_tle` extension, your database user role must have the permission of the `rds_superuser` role\. By default, this role is granted to the `postgres` user that creates the RDS for PostgreSQL DB instance\. -+ **Requires a custom DB parameter group** – Your RDS for PostgreSQL DB instance must be configured with a custom DB parameter group\. - + If your RDS for PostgreSQL DB instance isn't configured with a custom DB parameter group, you should create one and associate it with your RDS for PostgreSQL DB instance\. For a short summary of steps, see [Creating and applying a custom DB parameter group](#PostgreSQL_trusted_language_extension-requirements-create-custom-params)\. - + If your RDS for PostgreSQL DB instance is already configured using a custom DB parameter group, you can set up Trusted Language Extensions\. For details, see [Setting up Trusted Language Extensions in your RDS for PostgreSQL DB instance](#PostgreSQL_trusted_language_extension-setting-up)\. - -### Creating and applying a custom DB parameter group - -Use the following steps to create a custom DB parameter group and configure your RDS for PostgreSQL DB instance to use it\. - -#### Console - -**To create a custom DB parameter group and use it with your RDS for PostgreSQL DB instance** - -1. Sign in to the AWS Management Console and open the Amazon RDS console at [https://console\.aws\.amazon\.com/rds/](https://console.aws.amazon.com/rds/)\. - -1. Choose Parameter groups from the Amazon RDS menu\. - -1. Choose **Create parameter group**\. - -1. In the **Parameter group details** page, enter the following information\. - + For **Parameter group family**, choose postgres14\. - + For **Type**, choose DB Parameter Group\. - + For **Group name**, give your parameter group a meaningful name in the context of your operations\. - + For **Description**, enter a useful description so that others on your team can easily find it\. - -1. Choose **Create**\. Your custom DB parameter group is created in your AWS Region\. You can now modify your RDS for PostgreSQL DB instance to use it by following the next steps\. - -1. Choose **Databases** from the Amazon RDS menu\. - -1. Choose the RDS for PostgreSQL DB instance that you want to use with TLE from among those listed, and then choose **Modify\.** - -1. In the Modify DB instance settings page, find **Database options** in the Additional configuration section and choose your custom DB parameter group from the selector\. - -1. Choose **Continue** to save the change\. - -1. Choose **Apply immediately** so that you can continue setting up the RDS for PostgreSQL DB instance to use TLE\. - -To continue setting up your system for Trusted Language Extensions, see [Setting up Trusted Language Extensions in your RDS for PostgreSQL DB instance](#PostgreSQL_trusted_language_extension-setting-up)\. - -For more information working with DB parameter groups, see [Working with DB parameter groups](USER_WorkingWithDBInstanceParamGroups.md)\. - -#### AWS CLI - -You can avoid specifying the `--region` argument when you use CLI commands by configuring your AWS CLI with your default AWS Region\. For more information, see [Configuration basics](https://docs.aws.amazon.com/cli/latest/userguide/cli-configure-quickstart.html#cli-configure-quickstart-config) in the *AWS Command Line Interface User Guide*\. - -**To create a custom DB parameter group and use it with your RDS for PostgreSQL DB instance** - -1. Use the [create\-db\-parameter\-group](https://docs.aws.amazon.com/cli/latest/reference/rds/create-db-parameter-group.html) AWS CLI command to create a custom DB parameter group based on postgres14 for your AWS Region\. - - For Linux, macOS, or Unix: - - ``` - aws rds create-db-parameter-group \ - --region aws-region \ - --db-parameter-group-name custom-params-for-pg-tle \ - --db-parameter-group-family postgres14 \ - --description "My custom DB parameter group for Trusted Language Extensions" - ``` - - For Windows: - - ``` - aws rds create-db-parameter-group ^ - --region aws-region ^ - --db-parameter-group-name custom-params-for-pg-tle ^ - --db-parameter-group-family postgres14 ^ - --description "My custom DB parameter group for Trusted Language Extensions" - ``` - - Your custom DB parameter group is available in your AWS Region, so you can modify RDS for PostgreSQL DB instance to use it\. - -1. Use the [modify\-db\-instance](https://docs.aws.amazon.com/cli/latest/reference/rds/modify-db-instance.html) AWS CLI command to apply your custom DB parameter group to your RDS for PostgreSQL DB instance\. This command immediately reboots the active instance\. - - For Linux, macOS, or Unix: - - ``` - aws rds modify-db-instance \ - --region aws-region \ - --db-instance-identifier your-instance-name \ - --db-parameter-group-name custom-params-for-pg-tle \ - --apply-immediately - ``` - - For Windows: - - ``` - aws rds modify-db-instance ^ - --region aws-region ^ - --db-instance-identifier your-instance-name ^ - --db-parameter-group-name custom-params-for-pg-tle ^ - --apply-immediately - ``` - -To continue setting up your system for Trusted Language Extensions, see [Setting up Trusted Language Extensions in your RDS for PostgreSQL DB instance](#PostgreSQL_trusted_language_extension-setting-up)\. - -For more information, see [Working with parameter groups](USER_WorkingWithParamGroups.md)\. - -## Setting up Trusted Language Extensions in your RDS for PostgreSQL DB instance - -The following steps assume that your RDS for PostgreSQL DB instance is associated with a custom DB parameter group\. You can use the AWS Management Console or the AWS CLI for these steps\. - -When you set up Trusted Language Extensions in your RDS for PostgreSQL DB instance, you install it in a specific database for use by the database users who have permissions on that database\. - -### Console - -**To set up Trusted Language Extensions** - -Perform the following steps using an account that's a member of the `rds_superuser` group \(role\)\. - -1. Sign in to the AWS Management Console and open the Amazon RDS console at [https://console\.aws\.amazon\.com/rds/](https://console.aws.amazon.com/rds/)\. - -1. In the navigation pane, choose your RDS for PostgreSQL DB instance\. - -1. Open the **Configuration** tab for your RDS for PostgreSQL DB instance\. Among the Instance details, find the **Parameter group** link\. - -1. Choose the link to open the custom parameters associated with your RDS for PostgreSQL DB instance\. - -1. In the **Parameters** search field, type `shared_pre` to find the `shared_preload_libraries` parameter\. - -1. Choose **Edit parameters** to access the property values\. - -1. Add `pg_tle` to the list in the **Values** field\. Use a comma to separate items in the list of values\. -![\[Image of the shared_preload_libraries parameter with pg_tle added.\]](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/images/apg_rpg_shared_preload_pg_tle.png) - -1. Reboot the RDS for PostgreSQL DB instance so that your change to the `shared_preload_libraries` parameter takes effect\. - -1. When the instance is available, verify that `pg_tle` has been initialized\. Use `psql` to connect to the RDS for PostgreSQL DB instance, and then run the following command\. - - ``` - SHOW shared_preload_libraries; - shared_preload_libraries - -------------------------- - rdsutils,pg_tle - (1 row) - ``` - -1. With the `pg_tle` extension initialized, you can now create the extension\. - - ``` - CREATE EXTENSION pg_tle; - ``` - - You can verify that the extension is installed by using the following `psql` metacommand\. - - ``` - labdb=> \dx - List of installed extensions - Name | Version | Schema | Description - ---------+---------+------------+-------------------------------------------- - pg_tle | 1.0.1 | pgtle | Trusted-Language Extensions for PostgreSQL - plpgsql | 1.0 | pg_catalog | PL/pgSQL procedural language - ``` - -1. Grant the `pgtle_admin` role to the primary user name that you created for your RDS for PostgreSQL DB instance when you set it up\. If you accepted the default, it's `postgres`\. - - ``` - labdb=> GRANT pgtle_admin TO postgres; - GRANT ROLE - ``` - - You can verify that the grant has occurred by using the `psql` metacommand as shown in the following example\. Only the `pgtle_admin` and `postgres` roles are shown in the output\. For more information, see [Understanding the rds\_superuser role](Appendix.PostgreSQL.CommonDBATasks.Roles.md#Appendix.PostgreSQL.CommonDBATasks.Roles.rds_superuser)\. - - ``` - labdb=> \du - List of roles - Role name | Attributes | Member of - -----------------+---------------------------------+----------------------------------- - pgtle_admin | Cannot login | {} - postgres | Create role, Create DB +| {rds_superuser,pgtle_admin} - | Password valid until infinity |... - ``` - -1. Close the `psql` session using the `\q` metacommand\. - - ``` - \q - ``` - -To get started creating TLE extensions, see [Example: Creating a trusted language extension using SQL](#PostgreSQL_trusted_language_extension-simple-example)\. - -### AWS CLI - -You can avoid specifying the `--region` argument when you use CLI commands by configuring your AWS CLI with your default AWS Region\. For more information, see [Configuration basics](https://docs.aws.amazon.com/cli/latest/userguide/cli-configure-quickstart.html#cli-configure-quickstart-config) in the *AWS Command Line Interface User Guide*\. - -**To set up Trusted Language Extensions** - -1. Use the [modify\-db\-parameter\-group](https://docs.aws.amazon.com/cli/latest/reference/rds/modify-db-parameter-group.html) AWS CLI command to add `pg_tle` to the `shared_preload_libraries` parameter\. - - ``` - aws rds modify-db-parameter-group \ - --db-parameter-group-name custom-param-group-name \ - --parameters "ParameterName=shared_preload_libraries,ParameterValue=pg_tle,ApplyMethod=pending-reboot" \ - --region aws-region - ``` - -1. Use the [reboot\-db\-instance](https://docs.aws.amazon.com/cli/latest/reference/rds/reboot-db-instance) AWS CLI command to reboot the RDS for PostgreSQL DB instance and initialize the `pg_tle` library\. - - ``` - aws rds reboot-db-instance \ - --db-instance-identifier your-instance \ - --region aws-region - ``` - -1. When the instance is available, you can verify that `pg_tle` has been initialized\. Use `psql` to connect to the RDS for PostgreSQL DB instance, and then run the following command\. - - ``` - SHOW shared_preload_libraries; - shared_preload_libraries - -------------------------- - rdsutils,pg_tle - (1 row) - ``` - - With `pg_tle` initialized, you can now create the extension\. - - ``` - CREATE EXTENSION pg_tle; - ``` - -1. Grant the `pgtle_admin` role to the primary user name that you created for your RDS for PostgreSQL DB instance when you set it up\. If you accepted the default, it's `postgres`\. - - ``` - GRANT pgtle_admin TO postgres; - GRANT ROLE - ``` - -1. Close the `psql` session as follows\. - - ``` - labdb=> \q - ``` - -To get started creating TLE extensions, see [Example: Creating a trusted language extension using SQL](#PostgreSQL_trusted_language_extension-simple-example)\. - -## Overview of Trusted Language Extensions for PostgreSQL - -Trusted Language Extensions for PostgreSQL is a PostgreSQL extension that you install in your RDS for PostgreSQL DB instance in the same way that you set up other PostgreSQL extensions\. In the following image of an example database in the pgAdmin client tool, you can view some of the components that comprise the `pg_tle` extension\. - -![\[Image showing some of the components that make up the TLE development kit.\]](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/images/apg-pg_tle-installed-view-in-pgAdmin.png) - -You can see the following details\. - -1. The Trusted Language Extensions \(TLE\) for PostgreSQL development kit is packaged as the `pg_tle` extension\. As such, `pg_tle` is added to the available extensions for the database in which it's installed\. - -1. TLE has its own schema, `pgtle`\. This schema contains helper functions \(3\) for installing and managing the extensions that you create\. - -1. TLE provides over a dozen helper functions for installing, registering, and managing your extensions\. To learn more about these functions, see [Functions reference for Trusted Language Extensions for PostgreSQL](PostgreSQL_trusted_language_extension-functions-reference.md)\. - -Other components of the `pg_tle` extension include the following: -+ **The `pgtle_admin` role** – The `pgtle_admin` role is created when the `pg_tle` extension is installed\. This role is privileged and should be treated as such\. We strongly recommend that you follow the principle of *least privilege* when granting the `pgtle_admin` role to database users\. In other words, grant the `pgtle_admin` role only to database users that are allowed to create, install, and manage new TLE extensions, such as `postgres`\. -+ **The `pgtle.feature_info` table** – The `pgtle.feature_info` table is a protected table that contains information about your TLEs, hooks, and the custom stored procedures and functions that they use\. If you have `pgtle_admin` privileges, you use the following Trusted Language Extensions functions to add and update that information in the table\. - + [pgtle\.register\_feature](pgtle.register_feature.md) - + [pgtle\.register\_feature\_if\_not\_exists](pgtle.register_feature_if_not_exists.md) - + [pgtle\.unregister\_feature](pgtle.unregister_feature.md) - + [pgtle\.unregister\_feature\_if\_exists](pgtle.unregister_feature_if_exists.md) - -## Creating TLE extensions for RDS for PostgreSQL - -You can install any extensions that you create with TLE in any RDS for PostgreSQL DB instance that has the `pg_tle` extension installed\. The `pg_tle` extension is scoped to the PostgreSQL database in which it's installed\. The extensions that you create using TLE are scoped to the same database\. - -Use the various `pgtle` functions to install the code that makes up your TLE extension\. The following Trusted Language Extensions functions all require the `pgtle_admin` role\. -+ [pgtle\.install\_extension](pgtle.install_extension.md) -+ [pgtle\.install\_update\_path](pgtle.install_update_path.md) -+ [pgtle\.register\_feature](pgtle.register_feature.md) -+ [pgtle\.register\_feature\_if\_not\_exists](pgtle.register_feature_if_not_exists.md) -+ [pgtle\.set\_default\_version](pgtle.set_default_version.md) -+ [pgtle\.uninstall\_extension\(name\)](pgtle.uninstall_extension-name.md) -+ [pgtle\.uninstall\_extension\(name, version\)](pgtle.uninstall_extension-name-version.md) -+ [pgtle\.uninstall\_extension\_if\_exists](pgtle.uninstall_extension_if_exists.md) -+ [pgtle\.uninstall\_update\_path](pgtle.uninstall_update_path.md) -+ [pgtle\.uninstall\_update\_path\_if\_exists](pgtle.uninstall_update_path_if_exists.md) -+ [pgtle\.unregister\_feature](pgtle.unregister_feature.md) -+ [pgtle\.unregister\_feature\_if\_exists](pgtle.unregister_feature_if_exists.md) - -### Example: Creating a trusted language extension using SQL - -The following example shows you how to create a TLE extension named `pg_distance` that contains a few SQL functions for calculating distances using different formulas\. In the listing, you can find the function for calculating the Manhattan distance and the function for calculating the Euclidean distance\. For more information about the difference between these formulas, see [Taxicab geometry](https://en.wikipedia.org/wiki/Taxicab_geometry) and [Euclidean geometry](https://en.wikipedia.org/wiki/Euclidean_geometry) in Wikipedia\. - -You can use this example in your own RDS for PostgreSQL DB instance if you have the `pg_tle` extension set up as detailed in [Setting up Trusted Language Extensions in your RDS for PostgreSQL DB instance](#PostgreSQL_trusted_language_extension-setting-up)\. - -**Note** -You need to have the privileges of the `pgtle_admin` role to follow this procedure\. - -**To create the example TLE extension** - -The following steps use an example database named `labdb`\. This database is owned by the `postgres` primary user\. The `postgres` role also has the permissions of the `pgtle_admin` role\. - -1. Use `psql` to connect to RDS for PostgreSQL DB instance\. - - ``` - psql --host=db-instance-123456789012.aws-region.rds.amazonaws.com - --port=5432 --username=postgres --password --dbname=labdb - ``` - -1. Create a TLE extension named `pg_distance` by copying the following code and pasting it into your `psql` session console\. - - ``` - SELECT pgtle.install_extension - ( - 'pg_distance', - '0.1', - 'Distance functions for two points', - $_pg_tle_$ - CREATE FUNCTION dist(x1 float8, y1 float8, x2 float8, y2 float8, norm int) - RETURNS float8 - AS $$ - SELECT (abs(x2 - x1) ^ norm + abs(y2 - y1) ^ norm) ^ (1::float8 / norm); - $$ LANGUAGE SQL; - - CREATE FUNCTION manhattan_dist(x1 float8, y1 float8, x2 float8, y2 float8) - RETURNS float8 - AS $$ - SELECT dist(x1, y1, x2, y2, 1); - $$ LANGUAGE SQL; - - CREATE FUNCTION euclidean_dist(x1 float8, y1 float8, x2 float8, y2 float8) - RETURNS float8 - AS $$ - SELECT dist(x1, y1, x2, y2, 2); - $$ LANGUAGE SQL; - $_pg_tle_$ - ); - ``` - - You see the output, such as the following\. - - ``` - install_extension - --------------- - t - (1 row) - ``` - - The artifacts that make up the `pg_distance` extension are now installed in your database\. These artifacts include the control file and the code for the extension, which are items that need to be present so that the extension can be created using the `CREATE EXTENSION` command\. In other words, you still need to create the extension to make its functions available to database users\. - -1. To create the extension, use the `CREATE EXTENSION` command as you do for any other extension\. As with other extensions, the database user needs to have the `CREATE` permissions in the database\. - - ``` - CREATE EXTENSION pg_distance; - ``` - -1. To test the `pg_distance` TLE extension, you can use it to calculate the [Manhattan distance](https://en.wikipedia.org/wiki/Taxicab_geometry) between four points\. - - ``` - labdb=> SELECT manhattan_dist(1, 1, 5, 5); - 8 - ``` - - To calculate the [Euclidean distance](https://en.wikipedia.org/wiki/Euclidean_geometry) between the same set of points, you can use the following\. - - ``` - labdb=> SELECT euclidean_dist(1, 1, 5, 5); - 5.656854249492381 - ``` - -The `pg_distance` extension loads the functions in the database and makes them available to any users with permissions on the database\. - -### Modifying your TLE extension - -To improve query performance for the functions packaged in this TLE extension, add the following two PostgreSQL attributes to their specifications\. -+ `IMMUTABLE` – The `IMMUTABLE` attribute ensures that the query optimizer can use optimizations to improve query response times\. For more information, see [Function Volatility Categories](https://www.postgresql.org/docs/current/xfunc-volatility.html) in the PostgreSQL documentation\. -+ `PARALLEL SAFE` – The `PARALLEL SAFE` attribute is another attribute that allows PostgreSQL to run the function in parallel mode\. For more information, see [CREATE FUNCTION](https://www.postgresql.org/docs/current/sql-createfunction.html) in the PostgreSQL documentation\. - -In the following example, you can see how the `pgtle.install_update_path` function is used to add these attributes to each function to create a version `0.2` of the `pg_distance` TLE extension\. For more information about this function, see [pgtle\.install\_update\_path](pgtle.install_update_path.md)\. You need to have the `pgtle_admin` role to perform this task\. - -**To update an existing TLE extension and specify the default version** - -1. Connect to RDS for PostgreSQL DB instance using `psql` or another client tool, such as pgAdmin\. - - ``` - psql --host=db-instance-123456789012.aws-region.rds.amazonaws.com - --port=5432 --username=postgres --password --dbname=labdb - ``` - -1. Modify the existing TLE extension by copying the following code and pasting it into your `psql` session console\. - - ``` - SELECT pgtle.install_update_path - ( - 'pg_distance', - '0.1', - '0.2', - $_pg_tle_$ - CREATE OR REPLACE FUNCTION dist(x1 float8, y1 float8, x2 float8, y2 float8, norm int) - RETURNS float8 - AS $$ - SELECT (abs(x2 - x1) ^ norm + abs(y2 - y1) ^ norm) ^ (1::float8 / norm); - $$ LANGUAGE SQL IMMUTABLE PARALLEL SAFE; - - CREATE OR REPLACE FUNCTION manhattan_dist(x1 float8, y1 float8, x2 float8, y2 float8) - RETURNS float8 - AS $$ - SELECT dist(x1, y1, x2, y2, 1); - $$ LANGUAGE SQL IMMUTABLE PARALLEL SAFE; - - CREATE OR REPLACE FUNCTION euclidean_dist(x1 float8, y1 float8, x2 float8, y2 float8) - RETURNS float8 - AS $$ - SELECT dist(x1, y1, x2, y2, 2); - $$ LANGUAGE SQL IMMUTABLE PARALLEL SAFE; - $_pg_tle_$ - ); - ``` - - You see a response similar to the following\. - - ``` - install_update_path - --------------------- - t - (1 row) - ``` - - You can make this version of the extension the default version, so that database users don't have to specify a version when they create or update the extension in their database\. - -1. To specify that the modified version \(version 0\.2\) of your TLE extension is the default version, use the `pgtle.set_default_version` function as shown in the following example\. - - ``` - SELECT pgtle.set_default_version('pg_distance', '0.2'); - ``` - - For more information about this function, see [pgtle\.set\_default\_version](pgtle.set_default_version.md)\. - -1. With the code in place, you can update the installed TLE extension in the usual way, by using `ALTER EXTENSION ... UPDATE` command, as shown here: - - ``` - ALTER EXTENSION pg_distance UPDATE; - ``` - -## Dropping your TLE extensions from a database - -You can drop your TLE extensions by using the `DROP EXTENSION` command in the same way that you do for other PostgreSQL extensions\. Dropping the extension doesn't remove the installation files that make up the extension, which allows users to re\-create the extension\. To remove the extension and its installation files, do the following two\-step process\. - -**To drop the TLE extension and remove its installation files** - -1. Use `psql` or another client tool to connect to the RDS for PostgreSQL DB instance\. - - ``` - psql --host=.111122223333.aws-region.rds.amazonaws.com --port=5432 --username=postgres --password --dbname=dbname - ``` - -1. Drop the extension as you would any PostgreSQL extension\. - - ``` - DROP EXTENSION your-TLE-extension - ``` - - For example, if you create the `pg_distance` extension as detailed in [Example: Creating a trusted language extension using SQL](#PostgreSQL_trusted_language_extension-simple-example), you can drop the extension as follows\. - - ``` - DROP EXTENSION pg_distance; - ``` - - You see output confirming that the extension has been dropped, as follows\. - - ``` - DROP EXTENSION - ``` - - At this point, the extension is no longer active in the database\. However, its installation files and control file are still available in the database, so database users can create the extension again if they like\. - + If you want to leave the extension files intact so that database users can create your TLE extension, you can stop here\. - + If you want to remove all files that make up the extension, continue to the next step\. - -1. To remove all installation files for your extension, use the `pgtle.uninstall_extension` function\. This function removes all the code and control files for your extension\. - - ``` - SELECT pgtle.uninstall_extension('your-tle-extension-name'); - ``` - - For example, to remove all `pg_distance` installation files, use the following command\. - - ``` - SELECT pgtle.uninstall_extension('pg_distance'); - uninstall_extension - --------------------- - t - (1 row) - ``` - -## Uninstalling Trusted Language Extensions for PostgreSQL - -If you no longer want to create your own TLE extensions using TLE, you can drop the `pg_tle` extension and remove all artifacts\. This action includes dropping any TLE extensions in the database and dropping the `pgtle` schema\. - -**To drop the `pg_tle` extension and its schema from a database** - -1. Use `psql` or another client tool to connect to the RDS for PostgreSQL DB instance\. - - ``` - psql --host=.111122223333.aws-region.rds.amazonaws.com --port=5432 --username=postgres --password --dbname=dbname - ``` - -1. Drop the `pg_tle` extension from the database\. If the database has your own TLE extensions still running in the database, you need to also drop those extensions\. To do so, you can use the `CASCADE` keyword, as shown in the following\. - - ``` - DROP EXTENSION pg_tle CASCADE; - ``` - - If the `pg_tle` extension isn't still active in the database, you don't need to use the `CASCADE` keyword\. - -1. Drop the `pgtle` schema\. This action removes all the management functions from the database\. - - ``` - DROP SCHEMA pgtle CASCADE; - ``` - - The command returns the following when the process completes\. - - ``` - DROP SCHEMA - ``` - - The `pg_tle` extension, its schema and functions, and all artifacts are removed\. To create new extensions using TLE, go through the setup process again\. For more information, see [Setting up Trusted Language Extensions in your RDS for PostgreSQL DB instance](#PostgreSQL_trusted_language_extension-setting-up)\. - -## Using PostgreSQL hooks with your TLE extensions - -A *hook* is a callback mechanism available in PostgreSQL that allows developers to call custom functions or other routines during regular database operations\. The TLE development kit supports PostgreSQL hooks so that you can integrate custom functions with PostgreSQL behavior at runtime\. For example, you can use a hook to associate the authentication process with your own custom code, or to modify the query planning and execution process for your specific needs\. - -Your TLE extensions can use hooks\. If a hook is global in scope, it applies across all databases\. Therefore, if your TLE extension uses a global hook, then you need to create your TLE extension in all databases that your users can access\. - -When you use the `pg_tle` extension to build your own Trusted Language Extensions, you can use the available hooks from a SQL API to build out the functions of your extension\. You should register any hooks with `pg_tle`\. For some hooks, you might also need to set various configuration parameters\. For example, the `passcode` check hook can be set to on, off, or require\. For more information about specific requirements for available `pg_tle` hooks, see [Hooks reference for Trusted Language Extensions for PostgreSQL](PostgreSQL_trusted_language_extension-hooks-reference.md)\. - -### Example: Creating an extension that uses a PostgreSQL hook - -The example discussed in this section uses a PostgreSQL hook to check the password provided during specific SQL operations and prevents database users from setting their passwords to any of those contained in the `password_check.bad_passwords` table\. The table contains the top\-ten most commonly used, but easily breakable choices for passwords\. - -To set up this example in your RDS for PostgreSQL DB instance, you must have already installed Trusted Language Extensions\. For details, see [Setting up Trusted Language Extensions in your RDS for PostgreSQL DB instance](#PostgreSQL_trusted_language_extension-setting-up)\. - -**To set up the password\-check hook example** - -1. Use `psql` to connect to RDS for PostgreSQL DB instance\. - - ``` - psql --host=db-instance-123456789012.aws-region.rds.amazonaws.com - --port=5432 --username=postgres --password --dbname=labdb - ``` - -1. Copy the code from the [Password\-check hook code listing](#PostgreSQL_trusted_language_extension-example-hook_code_listing) and paste it into your database\. - - ``` - SELECT pgtle.install_extension ( - 'my_password_check_rules', - '1.0', - 'Do not let users use the 10 most commonly used passwords', - $_pgtle_$ - CREATE SCHEMA password_check; - REVOKE ALL ON SCHEMA password_check FROM PUBLIC; - GRANT USAGE ON SCHEMA password_check TO PUBLIC; - - CREATE TABLE password_check.bad_passwords (plaintext) AS - VALUES - ('123456'), - ('password'), - ('12345678'), - ('qwerty'), - ('123456789'), - ('12345'), - ('1234'), - ('111111'), - ('1234567'), - ('dragon'); - CREATE UNIQUE INDEX ON password_check.bad_passwords (plaintext); - - CREATE FUNCTION password_check.passcheck_hook(username text, password text, password_type pgtle.password_types, valid_until timestamptz, valid_null boolean) - RETURNS void AS $$ - DECLARE - invalid bool := false; - BEGIN - IF password_type = 'PASSWORD_TYPE_MD5' THEN - SELECT EXISTS( - SELECT 1 - FROM password_check.bad_passwords bp - WHERE ('md5' || md5(bp.plaintext || username)) = password - ) INTO invalid; - IF invalid THEN - RAISE EXCEPTION 'Cannot use passwords from the common password dictionary'; - END IF; - ELSIF password_type = 'PASSWORD_TYPE_PLAINTEXT' THEN - SELECT EXISTS( - SELECT 1 - FROM password_check.bad_passwords bp - WHERE bp.plaintext = password - ) INTO invalid; - IF invalid THEN - RAISE EXCEPTION 'Cannot use passwords from the common common password dictionary'; - END IF; - END IF; - END - $$ LANGUAGE plpgsql SECURITY DEFINER; - - GRANT EXECUTE ON FUNCTION password_check.passcheck_hook TO PUBLIC; - - SELECT pgtle.register_feature('password_check.passcheck_hook', 'passcheck'); - $_pgtle_$ - ); - ``` - - When the extension has been loaded into your database, you see the output such as the following\. - - ``` - install_extension - ------------------- - t - (1 row) - ``` - -1. While still connected to the database, you can now create the extension\. - - ``` - CREATE EXTENSION my_password_check_rules; - ``` - -1. You can confirm that the extension has been created in the database by using the following `psql` metacommand\. - - ``` - \dx - List of installed extensions - Name | Version | Schema | Description - -------------------------+---------+------------+------------------------------------------------------------- - my_password_check_rules | 1.0 | public | Prevent use of any of the top-ten most common bad passwords - pg_tle | 1.0.1 | pgtle | Trusted-Language Extensions for PostgreSQL - plpgsql | 1.0 | pg_catalog | PL/pgSQL procedural language - (3 rows) - ``` - -1. Open another terminal session to work with the AWS CLI\. You need to modify your custom DB parameter group to turn on the password\-check hook\. To do so, use the [modify\-db\-parameter\-group](https://docs.aws.amazon.com/cli/latest/reference/rds/modify-db-parameter-group.html) CLI command as shown in the following example\. - - ``` - aws rds modify-db-parameter-group \ - --region aws-region \ - --db-parameter-group-name your-custom-parameter-group \ - --parameters "ParameterName=pgtle.enable_password_check,ParameterValue=on,ApplyMethod=immediate" - ``` - - When the parameter is successfully turned on, you see the output such as the following\. - - ``` - ( - "DBParameterGroupName": "docs-lab-parameters-for-tle" - } - ``` - - It might take a few minutes for the change to the parameter group setting to take effect\. This parameter is dynamic, however, so you don't need to restart the RDS for PostgreSQL DB instance for the setting to take effect\. - -1. Open the `psql` session and query the database to verify that the password\_check hook has been turned on\. - - ``` - labdb=> SHOW pgtle.enable_password_check; - pgtle.enable_password_check - ----------------------------- - on - (1 row) - ``` - -The password\-check hook is now active\. You can test it by creating a new role and using one of the bad passwords, as shown in the following example\. - -``` -CREATE ROLE test_role PASSWORD 'password'; -ERROR: Cannot use passwords from the common password dictionary -CONTEXT: PL/pgSQL function password_check.passcheck_hook(text,text,pgtle.password_types,timestamp with time zone,boolean) line 21 at RAISE -SQL statement "SELECT password_check.passcheck_hook( - $1::pg_catalog.text, - $2::pg_catalog.text, - $3::pgtle.password_types, - $4::pg_catalog.timestamptz, - $5::pg_catalog.bool)" -``` - -The output has been formatted for readability\. - -The following example shows that `pgsql` interactive metacommand `\password` behavior is also affected by the password\_check hook\. - -``` -postgres=> SET password_encryption TO 'md5'; -SET -postgres=> \password -Enter new password for user "postgres":***** -Enter it again:***** -ERROR: Cannot use passwords from the common password dictionary -CONTEXT: PL/pgSQL function password_check.passcheck_hook(text,text,pgtle.password_types,timestamp with time zone,boolean) line 12 at RAISE -SQL statement "SELECT password_check.passcheck_hook($1::pg_catalog.text, $2::pg_catalog.text, $3::pgtle.password_types, $4::pg_catalog.timestamptz, $5::pg_catalog.bool)" -``` - -You can drop this TLE extension and uninstall its source files if you want\. For more information, see [Dropping your TLE extensions from a databaseDropping your TLE extensions from a database](#PostgreSQL_trusted_language_extension-creating-TLE-extensions.dropping-TLEs)\. - -#### Password\-check hook code listing - -The example code shown here defines the specification for the `my_password_check_rules` TLE extension\. When you copy this code and paste it into your database, the code for the `my_password_check_rules` extension is loaded into the database, and the `password_check` hook is registered for use by the extension\. - -``` -SELECT pgtle.install_extension ( - 'my_password_check_rules', - '1.0', - 'Do not let users use the 10 most commonly used passwords', -$_pgtle_$ - CREATE SCHEMA password_check; - REVOKE ALL ON SCHEMA password_check FROM PUBLIC; - GRANT USAGE ON SCHEMA password_check TO PUBLIC; - - CREATE TABLE password_check.bad_passwords (plaintext) AS - VALUES - ('123456'), - ('password'), - ('12345678'), - ('qwerty'), - ('123456789'), - ('12345'), - ('1234'), - ('111111'), - ('1234567'), - ('dragon'); - CREATE UNIQUE INDEX ON password_check.bad_passwords (plaintext); - - CREATE FUNCTION password_check.passcheck_hook(username text, password text, password_type pgtle.password_types, valid_until timestamptz, valid_null boolean) - RETURNS void AS $$ - DECLARE - invalid bool := false; - BEGIN - IF password_type = 'PASSWORD_TYPE_MD5' THEN - SELECT EXISTS( - SELECT 1 - FROM password_check.bad_passwords bp - WHERE ('md5' || md5(bp.plaintext || username)) = password - ) INTO invalid; - IF invalid THEN - RAISE EXCEPTION 'Cannot use passwords from the common password dictionary'; - END IF; - ELSIF password_type = 'PASSWORD_TYPE_PLAINTEXT' THEN - SELECT EXISTS( - SELECT 1 - FROM password_check.bad_passwords bp - WHERE bp.plaintext = password - ) INTO invalid; - IF invalid THEN - RAISE EXCEPTION 'Cannot use passwords from the common common password dictionary'; - END IF; - END IF; - END - $$ LANGUAGE plpgsql SECURITY DEFINER; - - GRANT EXECUTE ON FUNCTION password_check.passcheck_hook TO PUBLIC; - - SELECT pgtle.register_feature('password_check.passcheck_hook', 'passcheck'); -$_pgtle_$ -); -``` \ No newline at end of file diff --git a/doc_source/ProgrammingGuide.md b/doc_source/ProgrammingGuide.md deleted file mode 100644 index 6057e67..0000000 --- a/doc_source/ProgrammingGuide.md +++ /dev/null @@ -1,13 +0,0 @@ -# Amazon RDS API reference - -In addition to the AWS Management Console and the AWS Command Line Interface \(AWS CLI\), Amazon RDS also provides an API\. You can use the API to automate tasks for managing your DB instances and other objects in Amazon RDS\. -+ For an alphabetical list of API operations, see [Actions](https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_Operations.html)\. -+ For an alphabetical list of data types, see [Data types](https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_Types.html)\. -+ For a list of common query parameters, see [Common parameters](https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/CommonParameters.html)\. -+ For descriptions of the error codes, see [Common errors](https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/CommonErrors.html)\. - -For more information about the AWS CLI, see [AWS Command Line Interface reference for Amazon RDS](https://docs.aws.amazon.com/cli/latest/reference/rds/index.html)\. - -**Topics** -+ [Using the Query API](Using_the_Query_API.md) -+ [Troubleshooting applications on Amazon RDS](APITroubleshooting.md) \ No newline at end of file diff --git a/doc_source/RDS-compliance.md b/doc_source/RDS-compliance.md deleted file mode 100644 index 8d403e5..0000000 --- a/doc_source/RDS-compliance.md +++ /dev/null @@ -1,15 +0,0 @@ -# Compliance validation for Amazon RDS - -Third\-party auditors assess the security and compliance of Amazon RDS as part of multiple AWS compliance programs\. These include SOC, PCI, FedRAMP, HIPAA, and others\. - -For a list of AWS services in scope of specific compliance programs, see [AWS services in scope by compliance program](https://aws.amazon.com/compliance/services-in-scope/)\. For general information, see [AWS compliance programs](https://aws.amazon.com/compliance/programs/)\. - -You can download third\-party audit reports using AWS Artifact\. For more information, see [Downloading reports in AWS Artifact](https://docs.aws.amazon.com/artifact/latest/ug/downloading-documents.html)\. - -Your compliance responsibility when using Amazon RDS is determined by the sensitivity of your data, your organization's compliance objectives, and applicable laws and regulations\. AWS provides the following resources to help with compliance: -+ [Security and compliance quick start guides](https://aws.amazon.com/quickstart/?awsf.quickstart-homepage-filter=categories%23security-identity-compliance) – These deployment guides discuss architectural considerations and provide steps for deploying security\- and compliance\-focused baseline environments on AWS\. -+ [Architecting for HIPAA Security and Compliance on Amazon Web Services ](https://docs.aws.amazon.com/pdfs/whitepapers/latest/architecting-hipaa-security-and-compliance-on-aws/architecting-hipaa-security-and-compliance-on-aws.pdf) – This whitepaper describes how companies can use AWS to create HIPAA\-compliant applications\. -+ [AWS compliance resources](https://aws.amazon.com/compliance/resources/) – This collection of workbooks and guides that might apply to your industry and location\. -+ [AWS Config](https://docs.aws.amazon.com/config/latest/developerguide/evaluate-config.html) – This AWS service assesses how well your resource configurations comply with internal practices, industry guidelines, and regulations\. -+ [AWS Security Hub](https://docs.aws.amazon.com/securityhub/latest/userguide/what-is-securityhub.html) – This AWS service provides a comprehensive view of your security state within AWS\. Security Hub uses security controls to evaluate your AWS resources and to check your compliance against security industry standards and best practices\. For a list of supported services and controls, see [Security Hub controls reference](https://docs.aws.amazon.com/securityhub/latest/userguide/securityhub-controls-reference.html)\. -+ [AWS Security Hub](https://docs.aws.amazon.com/securityhub/latest/userguide/what-is-securityhub.html) – This AWS service provides a comprehensive view of your security state within AWS\. Security Hub uses security controls to evaluate your AWS resources and to check your compliance against security industry standards and best practices\. For a list of supported services and controls, see [Security Hub controls reference](https://docs.aws.amazon.com/securityhub/latest/userguide/securityhub-controls-reference.html)\. \ No newline at end of file diff --git a/doc_source/SQLServer.Ciphers.md b/doc_source/SQLServer.Ciphers.md deleted file mode 100644 index dd74e5a..0000000 --- a/doc_source/SQLServer.Ciphers.md +++ /dev/null @@ -1,211 +0,0 @@ -# Configuring security protocols and ciphers - -You can turn certain security protocols and ciphers on and off using DB parameters\. The security parameters that you can configure \(except for TLS version 1\.2\) are shown in the following table\. - -For parameters other than `rds.fips`, the value of `default` means that the operating system default value is used, whether it is `enabled` or `disabled`\. - -**Note** -You can't disable TLS 1\.2, because Amazon RDS uses it internally\. - - -**** - -| DB parameter | Allowed values \(default in bold\) | Description | -| --- | --- | --- | -| rds\.tls10 | default, enabled, disabled | TLS 1\.0\. | -| rds\.tls11 | default, enabled, disabled | TLS 1\.1\. | -| rds\.tls12 | default | TLS 1\.2\. You can't modify this value\. | -| rds\.fips | 0, 1 | When you set the parameter to 1, RDS forces the use of modules that are compliant with the Federal Information Processing Standard \(FIPS\) 140\-2 standard\. For more information, see [Use SQL Server 2016 in FIPS 140\-2\-compliant mode](https://docs.microsoft.com/en-us/troubleshoot/sql/security/sql-2016-fips-140-2-compliant-mode) in the Microsoft documentation\. You must reboot the DB instance after the modification to make it effective\. | -| rds\.rc4 | default, enabled, disabled | RC4 stream cipher\. | -| rds\.diffie\-hellman | default, enabled, disabled | Diffie\-Hellman key\-exchange encryption\. | -| rds\.diffie\-hellman\-min\-key\-bit\-length | default, 1024, 2048, 4096 | Minimum bit length for Diffie\-Hellman keys\. | -| rds\.curve25519 | default, enabled, disabled | Curve25519 elliptic\-curve encryption cipher\. This parameter isn't supported for all engine versions\. | -| rds\.3des168 | default, enabled, disabled | Triple Data Encryption Standard \(DES\) encryption cipher with a 168\-bit key length\. | - -**Note** -For more information on the default values for SQL Server security protocols and ciphers, see [Protocols in TLS/SSL \(Schannel SSP\)](https://docs.microsoft.com/en-us/windows/win32/secauthn/protocols-in-tls-ssl--schannel-ssp-) and [Cipher Suites in TLS/SSL \(Schannel SSP\)](https://docs.microsoft.com/en-us/windows/win32/secauthn/cipher-suites-in-schannel) in the Microsoft documentation\. -For more information on viewing and setting these values in the Windows Registry, see [Transport Layer Security \(TLS\) best practices with the \.NET Framework](https://docs.microsoft.com/en-us/dotnet/framework/network-programming/tls) in the Microsoft documentation\. - -Use the following process to configure the security protocols and ciphers: - -1. Create a custom DB parameter group\. - -1. Modify the parameters in the parameter group\. - -1. Associate the DB parameter group with your DB instance\. - -For more information on DB parameter groups, see [Working with parameter groups](USER_WorkingWithParamGroups.md)\. - -## Creating the security\-related parameter group - -Create a parameter group for your security\-related parameters that corresponds to the SQL Server edition and version of your DB instance\. - -### Console - -The following procedure creates a parameter group for SQL Server Standard Edition 2016\. - -**To create the parameter group** - -1. Sign in to the AWS Management Console and open the Amazon RDS console at [https://console\.aws\.amazon\.com/rds/](https://console.aws.amazon.com/rds/)\. - -1. In the navigation pane, choose **Parameter groups**\. - -1. Choose **Create parameter group**\. - -1. In the **Create parameter group** pane, do the following: - - 1. For **Parameter group family**, choose **sqlserver\-se\-13\.0**\. - - 1. For **Group name**, enter an identifier for the parameter group, such as **sqlserver\-ciphers\-se\-13**\. - - 1. For **Description**, enter **Parameter group for security protocols and ciphers**\. - -1. Choose **Create**\. - -### CLI - -The following procedure creates a parameter group for SQL Server Standard Edition 2016\. - -**To create the parameter group** -+ Run one of the following commands\. -**Example** - - For Linux, macOS, or Unix: - - ``` - aws rds create-db-parameter-group \ - --db-parameter-group-name sqlserver-ciphers-se-13 \ - --db-parameter-group-family "sqlserver-se-13.0" \ - --description "Parameter group for security protocols and ciphers" - ``` - - For Windows: - - ``` - aws rds create-db-parameter-group ^ - --db-parameter-group-name sqlserver-ciphers-se-13 ^ - --db-parameter-group-family "sqlserver-se-13.0" ^ - --description "Parameter group for security protocols and ciphers" - ``` - -## Modifying security\-related parameters - -Modify the security\-related parameters in the parameter group that corresponds to the SQL Server edition and version of your DB instance\. - -### Console - -The following procedure modifies the parameter group that you created for SQL Server Standard Edition 2016\. This example turns off TLS version 1\.0\. - -**To modify the parameter group** - -1. Sign in to the AWS Management Console and open the Amazon RDS console at [https://console\.aws\.amazon\.com/rds/](https://console.aws.amazon.com/rds/)\. - -1. In the navigation pane, choose **Parameter groups**\. - -1. Choose the parameter group, such as **sqlserver\-ciphers\-se\-13**\. - -1. Under **Parameters**, filter the parameter list for **rds**\. - -1. Choose **Edit parameters**\. - -1. Choose **rds\.tls10**\. - -1. For **Values**, choose **disabled**\. - -1. Choose **Save changes**\. - -### CLI - -The following procedure modifies the parameter group that you created for SQL Server Standard Edition 2016\. This example turns off TLS version 1\.0\. - -**To modify the parameter group** -+ Run one of the following commands\. -**Example** - - For Linux, macOS, or Unix: - - ``` - aws rds modify-db-parameter-group \ - --db-parameter-group-name sqlserver-ciphers-se-13 \ - --parameters "ParameterName='rds.tls10',ParameterValue='disabled',ApplyMethod=pending-reboot" - ``` - - For Windows: - - ``` - aws rds modify-db-parameter-group ^ - --db-parameter-group-name sqlserver-ciphers-se-13 ^ - --parameters "ParameterName='rds.tls10',ParameterValue='disabled',ApplyMethod=pending-reboot" - ``` - -## Associating the security\-related parameter group with your DB instance - -To associate the parameter group with your DB instance, use the AWS Management Console or the AWS CLI\. - -### Console - -You can associate the parameter group with a new or existing DB instance: -+ For a new DB instance, associate it when you launch the instance\. For more information, see [Creating an Amazon RDS DB instance](USER_CreateDBInstance.md)\. -+ For an existing DB instance, associate it by modifying the instance\. For more information, see [Modifying an Amazon RDS DB instance](Overview.DBInstance.Modifying.md)\. - -### CLI - -You can associate the parameter group with a new or existing DB instance\. - -**To create a DB instance with the parameter group** -+ Specify the same DB engine type and major version as you used when creating the parameter group\. -**Example** - - For Linux, macOS, or Unix: - - ``` - aws rds create-db-instance \ - --db-instance-identifier mydbinstance \ - --db-instance-class db.m5.2xlarge \ - --engine sqlserver-se \ - --engine-version 13.00.5426.0.v1 \ - --allocated-storage 100 \ - --master-user-password secret123 \ - --master-username admin \ - --storage-type gp2 \ - --license-model li \ - --db-parameter-group-name sqlserver-ciphers-se-13 - ``` - - For Windows: - - ``` - aws rds create-db-instance ^ - --db-instance-identifier mydbinstance ^ - --db-instance-class db.m5.2xlarge ^ - --engine sqlserver-se ^ - --engine-version 13.00.5426.0.v1 ^ - --allocated-storage 100 ^ - --master-user-password secret123 ^ - --master-username admin ^ - --storage-type gp2 ^ - --license-model li ^ - --db-parameter-group-name sqlserver-ciphers-se-13 - ``` - -**To modify a DB instance and associate the parameter group** -+ Run one of the following commands\. -**Example** - - For Linux, macOS, or Unix: - - ``` - aws rds modify-db-instance \ - --db-instance-identifier mydbinstance \ - --db-parameter-group-name sqlserver-ciphers-se-13 \ - --apply-immediately - ``` - - For Windows: - - ``` - aws rds modify-db-instance ^ - --db-instance-identifier mydbinstance ^ - --db-parameter-group-name sqlserver-ciphers-se-13 ^ - --apply-immediately - ``` \ No newline at end of file diff --git a/doc_source/SQLServer.Concepts.General.Licensing.md b/doc_source/SQLServer.Concepts.General.Licensing.md deleted file mode 100644 index ff982ad..0000000 --- a/doc_source/SQLServer.Concepts.General.Licensing.md +++ /dev/null @@ -1,26 +0,0 @@ -# Licensing Microsoft SQL Server on Amazon RDS - -When you set up an Amazon RDS DB instance for Microsoft SQL Server, the software license is included\. - -This means that you don't need to purchase SQL Server licenses separately\. AWS holds the license for the SQL Server database software\. Amazon RDS pricing includes the software license, underlying hardware resources, and Amazon RDS management capabilities\. - -Amazon RDS supports the following Microsoft SQL Server editions: -+ Enterprise -+ Standard -+ Web -+ Express - -**Note** -Licensing for SQL Server Web Edition supports only public and internet\-accessible webpages, websites, web applications, and web services\. This level of support is required for compliance with Microsoft's usage rights\. For more information, see [AWS service terms](http://aws.amazon.com/serviceterms)\. - -Amazon RDS supports Multi\-AZ deployments for DB instances running Microsoft SQL Server by using SQL Server Database Mirroring \(DBM\) or Always On Availability Groups \(AGs\)\. There are no additional licensing requirements for Multi\-AZ deployments\. For more information, see [Multi\-AZ deployments for Amazon RDS for Microsoft SQL Server](USER_SQLServerMultiAZ.md)\. - -## Restoring license\-terminated DB instances - -Amazon RDS takes snapshots of license\-terminated DB instances\. If your instance is terminated for licensing issues, you can restore it from the snapshot to a new DB instance\. New DB instances have a license included\. - -For more information, see [Restoring license\-terminated DB instances](Appendix.SQLServer.CommonDBATasks.RestoreLTI.md)\. - -## Development and test - -Because of licensing requirements, we can't offer SQL Server Developer Edition on Amazon RDS\. You can use Express Edition for many development, testing, and other nonproduction needs\. However, if you need the full feature capabilities of an enterprise\-level installation of SQL Server for development, you can download and install SQL Server Developer Edition \(and other MSDN products\) on Amazon EC2\. Dedicated infrastructure isn't required for Developer Edition\. By using your own host, you also gain access to other programmability features that are not accessible on Amazon RDS\. For more information on the difference between SQL Server editions, see [Editions and supported features of SQL Server 2017](https://docs.microsoft.com/en-us/sql/sql-server/editions-and-components-of-sql-server-2017) in the Microsoft documentation\. \ No newline at end of file diff --git a/doc_source/SQLServer.Concepts.General.SSL.Using.md b/doc_source/SQLServer.Concepts.General.SSL.Using.md deleted file mode 100644 index 76eb60f..0000000 --- a/doc_source/SQLServer.Concepts.General.SSL.Using.md +++ /dev/null @@ -1,127 +0,0 @@ -# Using SSL with a Microsoft SQL Server DB instance - -You can use Secure Sockets Layer \(SSL\) to encrypt connections between your client applications and your Amazon RDS DB instances running Microsoft SQL Server\. SSL support is available in all AWS regions for all supported SQL Server editions\. - -When you create a SQL Server DB instance, Amazon RDS creates an SSL certificate for it\. The SSL certificate includes the DB instance endpoint as the Common Name \(CN\) for the SSL certificate to guard against spoofing attacks\. - -There are 2 ways to use SSL to connect to your SQL Server DB instance: -+ Force SSL for all connections — this happens transparently to the client, and the client doesn't have to do any work to use SSL\. -+ Encrypt specific connections — this sets up an SSL connection from a specific client computer, and you must do work on the client to encrypt connections\. - -For information about Transport Layer Security \(TLS\) support for SQL Server, see [ TLS 1\.2 support for Microsoft SQL Server](https://support.microsoft.com/en-ca/help/3135244/tls-1-2-support-for-microsoft-sql-server)\. - -## Forcing connections to your DB instance to use SSL - -You can force all connections to your DB instance to use SSL\. If you force connections to use SSL, it happens transparently to the client, and the client doesn't have to do any work to use SSL\. - -If you want to force SSL, use the `rds.force_ssl` parameter\. By default, the `rds.force_ssl` parameter is set to `0 (off)`\. Set the `rds.force_ssl` parameter to `1 (on)` to force connections to use SSL\. The `rds.force_ssl` parameter is static, so after you change the value, you must reboot your DB instance for the change to take effect\. - -**To force all connections to your DB instance to use SSL** - -1. Determine the parameter group that is attached to your DB instance: - - 1. Sign in to the AWS Management Console and open the Amazon RDS console at [https://console\.aws\.amazon\.com/rds/](https://console.aws.amazon.com/rds/)\. - - 1. In the top right corner of the Amazon RDS console, choose the AWS Region of your DB instance\. - - 1. In the navigation pane, choose **Databases**, and then choose the name of your DB instance to show its details\. - - 1. Choose the **Configuration** tab\. Find the **Parameter group** in the section\. - -1. If necessary, create a new parameter group\. If your DB instance uses the default parameter group, you must create a new parameter group\. If your DB instance uses a nondefault parameter group, you can choose to edit the existing parameter group or to create a new parameter group\. If you edit an existing parameter group, the change affects all DB instances that use that parameter group\. - - To create a new parameter group, follow the instructions in [Creating a DB parameter group](USER_WorkingWithDBInstanceParamGroups.md#USER_WorkingWithParamGroups.Creating)\. - -1. Edit your new or existing parameter group to set the `rds.force_ssl` parameter to `true`\. To edit the parameter group, follow the instructions in [Modifying parameters in a DB parameter group](USER_WorkingWithDBInstanceParamGroups.md#USER_WorkingWithParamGroups.Modifying)\. - -1. If you created a new parameter group, modify your DB instance to attach the new parameter group\. Modify the **DB Parameter Group** setting of the DB instance\. For more information, see [Modifying an Amazon RDS DB instance](Overview.DBInstance.Modifying.md)\. - -1. Reboot your DB instance\. For more information, see [Rebooting a DB instance](USER_RebootInstance.md)\. - -## Encrypting specific connections - -You can force all connections to your DB instance to use SSL, or you can encrypting connections from specific client computers only\. To use SSL from a specific client, you must obtain certificates for the client computer, import certificates on the client computer, and then encrypt the connections from the client computer\. - -**Note** -All SQL Server instances created after August 5, 2014, use the DB instance endpoint in the Common Name \(CN\) field of the SSL certificate\. Prior to August 5, 2014, SSL certificate verification was not available for VPC\-based SQL Server instances\. If you have a VPC\-based SQL Server DB instance that was created before August 5, 2014, and you want to use SSL certificate verification and ensure that the instance endpoint is included as the CN for the SSL certificate for that DB instance, then rename the instance\. When you rename a DB instance, a new certificate is deployed and the instance is rebooted to enable the new certificate\. - -### Obtaining certificates for client computers - -To encrypt connections from a client computer to an Amazon RDS DB instance running Microsoft SQL Server, you need a certificate on your client computer\. - -To obtain that certificate, download the certificate to your client computer\. You can download a root certificate that works for all regions\. You can also download a certificate bundle that contains both the old and new root certificate\. In addition, you can download region\-specific intermediate certificates\. For more information about downloading certificates, see [Using SSL/TLS to encrypt a connection to a DB instance](UsingWithRDS.SSL.md)\. - -After you have downloaded the appropriate certificate, import the certificate into your Microsoft Windows operating system by following the procedure in the section following\. - -### Importing certificates on client computers - -You can use the following procedure to import your certificate into the Microsoft Windows operating system on your client computer\. - -**To import the certificate into your Windows operating system:** - -1. On the **Start** menu, type **Run** in the search box and press **Enter**\. - -1. In the **Open** box, type **MMC** and then choose **OK**\. - -1. In the MMC console, on the **File** menu, choose **Add/Remove Snap\-in**\. - -1. In the **Add or Remove Snap\-ins** dialog box, for **Available snap\-ins**, select **Certificates**, and then choose **Add**\. - -1. In the **Certificates snap\-in** dialog box, choose **Computer account**, and then choose **Next**\. - -1. In the **Select computer** dialog box, choose **Finish**\. - -1. In the **Add or Remove Snap\-ins** dialog box, choose **OK**\. - -1. In the MMC console, expand **Certificates**, open the context \(right\-click\) menu for **Trusted Root Certification Authorities**, choose **All Tasks**, and then choose **Import**\. - -1. On the first page of the Certificate Import Wizard, choose **Next**\. - -1. On the second page of the Certificate Import Wizard, choose **Browse**\. In the browse window, change the file type to **All files \(\*\.\*\)** because \.pem is not a standard certificate extension\. Locate the \.pem file that you downloaded previously\. - -1. Choose **Open** to select the certificate file, and then choose **Next**\. - -1. On the third page of the Certificate Import Wizard, choose **Next**\. - -1. On the fourth page of the Certificate Import Wizard, choose **Finish**\. A dialog box appears indicating that the import was successful\. - -1. In the MMC console, expand **Certificates**, expand **Trusted Root Certification Authorities**, and then choose **Certificates**\. Locate the certificate to confirm it exists, as shown here\. -![\[Image NOT FOUND\]](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/images/rds_sql_ssl_cert.png) - -### Encrypting connections to an Amazon RDS DB instance running Microsoft SQL Server - -After you have imported a certificate into your client computer, you can encrypt connections from the client computer to an Amazon RDS DB instance running Microsoft SQL Server\. - -For SQL Server Management Studio, use the following procedure\. For more information about SQL Server Management Studio, see [Use SQL Server management studio](http://msdn.microsoft.com/en-us/library/ms174173.aspx)\. - -**To encrypt connections from SQL Server Management Studio** - -1. Launch SQL Server Management Studio\. - -1. For **Connect to server**, type the server information, login user name, and password\. - -1. Choose **Options**\. - -1. Select **Encrypt connection**\. - -1. Choose **Connect**\. - -1. Confirm that your connection is encrypted by running the following query\. Verify that the query returns `true` for `encrypt_option`\. - - ``` - select ENCRYPT_OPTION from SYS.DM_EXEC_CONNECTIONS where SESSION_ID = @@SPID - ``` - -For any other SQL client, use the following procedure\. - -**To encrypt connections from other SQL clients** - -1. Append `encrypt=true` to your connection string\. This string might be available as an option, or as a property on the connection page in GUI tools\. -**Note** -To enable SSL encryption for clients that connect using JDBC, you might need to add the Amazon RDS SQL certificate to the Java CA certificate \(cacerts\) store\. You can do this by using the [ keytool](http://docs.oracle.com/javase/7/docs/technotes/tools/solaris/keytool.html) utility\. - -1. Confirm that your connection is encrypted by running the following query\. Verify that the query returns `true` for `encrypt_option`\. - - ``` - select ENCRYPT_OPTION from SYS.DM_EXEC_CONNECTIONS where SESSION_ID = @@SPID - ``` \ No newline at end of file diff --git a/doc_source/SQLServer.DBMail.md b/doc_source/SQLServer.DBMail.md deleted file mode 100644 index 7de0d80..0000000 --- a/doc_source/SQLServer.DBMail.md +++ /dev/null @@ -1,537 +0,0 @@ -# Using Database Mail on Amazon RDS for SQL Server - -You can use Database Mail to send email messages to users from your Amazon RDS on SQL Server database instance\. The messages can contain files and query results\. Database Mail includes the following components: -+ **Configuration and security objects** – These objects create profiles and accounts, and are stored in the `msdb` database\. -+ **Messaging objects** – These objects include the [sp\_send\_dbmail](https://docs.microsoft.com/en-us/sql/relational-databases/system-stored-procedures/sp-send-dbmail-transact-sql) stored procedure used to send messages, and data structures that hold information about messages\. They're stored in the `msdb` database\. -+ **Logging and auditing objects** – Database Mail writes logging information to the `msdb` database and the Microsoft Windows application event log\. -+ **Database Mail executable** – `DatabaseMail.exe` reads from a queue in the `msdb` database and sends email messages\. - -RDS supports Database Mail for all SQL Server versions on the Web, Standard, and Enterprise Editions\. - -## Limitations - -The following limitations apply to using Database Mail on your SQL Server DB instance: -+ Database Mail isn't supported for SQL Server Express Edition\. -+ Modifying Database Mail configuration parameters isn't supported\. To see the preset \(default\) values, use the [sysmail\_help\_configure\_sp](https://docs.microsoft.com/en-us/sql/relational-databases/system-stored-procedures/sysmail-help-configure-sp-transact-sql) stored procedure\. -+ File attachments aren't fully supported\. For more information, see [Working with file attachments](#SQLServer.DBMail.Files)\. -+ The maximum file attachment size is 1 MB\. -+ Database Mail requires additional configuration on Multi\-AZ DB instances\. For more information, see [Considerations for Multi\-AZ deployments](#SQLServer.DBMail.MAZ)\. -+ Configuring SQL Server Agent to send email messages to predefined operators isn't supported\. - -## Enabling Database Mail - -Use the following process to enable Database Mail for your DB instance: - -1. Create a new parameter group\. - -1. Modify the parameter group to set the `database mail xps` parameter to 1\. - -1. Associate the parameter group with the DB instance\. - -### Creating the parameter group for Database Mail - -Create a parameter group for the `database mail xps` parameter that corresponds to the SQL Server edition and version of your DB instance\. - -**Note** -You can also modify an existing parameter group\. Follow the procedure in [Modifying the parameter that enables Database Mail](#DBMail.ModifyParamGroup)\. - -#### Console - -The following example creates a parameter group for SQL Server Standard Edition 2016\. - -**To create the parameter group** - -1. Sign in to the AWS Management Console and open the Amazon RDS console at [https://console\.aws\.amazon\.com/rds/](https://console.aws.amazon.com/rds/)\. - -1. In the navigation pane, choose **Parameter groups**\. - -1. Choose **Create parameter group**\. - -1. In the **Create parameter group** pane, do the following: - - 1. For **Parameter group family**, choose **sqlserver\-se\-13\.0**\. - - 1. For **Group name**, enter an identifier for the parameter group, such as **dbmail\-sqlserver\-se\-13**\. - - 1. For **Description**, enter **Database Mail XPs**\. - -1. Choose **Create**\. - -#### CLI - -The following example creates a parameter group for SQL Server Standard Edition 2016\. - -**To create the parameter group** -+ Use one of the following commands\. -**Example** - - For Linux, macOS, or Unix: - - ``` - aws rds create-db-parameter-group \ - --db-parameter-group-name dbmail-sqlserver-se-13 \ - --db-parameter-group-family "sqlserver-se-13.0" \ - --description "Database Mail XPs" - ``` - - For Windows: - - ``` - aws rds create-db-parameter-group ^ - --db-parameter-group-name dbmail-sqlserver-se-13 ^ - --db-parameter-group-family "sqlserver-se-13.0" ^ - --description "Database Mail XPs" - ``` - -### Modifying the parameter that enables Database Mail - -Modify the `database mail xps` parameter in the parameter group that corresponds to the SQL Server edition and version of your DB instance\. - -To enable Database Mail, set the `database mail xps` parameter to 1\. - -#### Console - -The following example modifies the parameter group that you created for SQL Server Standard Edition 2016\. - -**To modify the parameter group** - -1. Sign in to the AWS Management Console and open the Amazon RDS console at [https://console\.aws\.amazon\.com/rds/](https://console.aws.amazon.com/rds/)\. - -1. In the navigation pane, choose **Parameter groups**\. - -1. Choose the parameter group, such as **dbmail\-sqlserver\-se\-13**\. - -1. Under **Parameters**, filter the parameter list for **mail**\. - -1. Choose **database mail xps**\. - -1. Choose **Edit parameters**\. - -1. Enter **1**\. - -1. Choose **Save changes**\. - -#### CLI - -The following example modifies the parameter group that you created for SQL Server Standard Edition 2016\. - -**To modify the parameter group** -+ Use one of the following commands\. -**Example** - - For Linux, macOS, or Unix: - - ``` - aws rds modify-db-parameter-group \ - --db-parameter-group-name dbmail-sqlserver-se-13 \ - --parameters "ParameterName='database mail xps',ParameterValue=1,ApplyMethod=immediate" - ``` - - For Windows: - - ``` - aws rds modify-db-parameter-group ^ - --db-parameter-group-name dbmail-sqlserver-se-13 ^ - --parameters "ParameterName='database mail xps',ParameterValue=1,ApplyMethod=immediate" - ``` - -### Associating the parameter group with the DB instance - -You can use the AWS Management Console or the AWS CLI to associate the Database Mail parameter group with the DB instance\. - -#### Console - -You can associate the Database Mail parameter group with a new or existing DB instance\. -+ For a new DB instance, associate it when you launch the instance\. For more information, see [Creating an Amazon RDS DB instance](USER_CreateDBInstance.md)\. -+ For an existing DB instance, associate it by modifying the instance\. For more information, see [Modifying an Amazon RDS DB instance](Overview.DBInstance.Modifying.md)\. - -#### CLI - -You can associate the Database Mail parameter group with a new or existing DB instance\. - -**To create a DB instance with the Database Mail parameter group** -+ Specify the same DB engine type and major version as you used when creating the parameter group\. -**Example** - - For Linux, macOS, or Unix: - - ``` - aws rds create-db-instance \ - --db-instance-identifier mydbinstance \ - --db-instance-class db.m5.2xlarge \ - --engine sqlserver-se \ - --engine-version 13.00.5426.0.v1 \ - --allocated-storage 100 \ - --master-user-password secret123 \ - --master-username admin \ - --storage-type gp2 \ - --license-model li - --db-parameter-group-name dbmail-sqlserver-se-13 - ``` - - For Windows: - - ``` - aws rds create-db-instance ^ - --db-instance-identifier mydbinstance ^ - --db-instance-class db.m5.2xlarge ^ - --engine sqlserver-se ^ - --engine-version 13.00.5426.0.v1 ^ - --allocated-storage 100 ^ - --master-user-password secret123 ^ - --master-username admin ^ - --storage-type gp2 ^ - --license-model li ^ - --db-parameter-group-name dbmail-sqlserver-se-13 - ``` - -**To modify a DB instance and associate the Database Mail parameter group** -+ Use one of the following commands\. -**Example** - - For Linux, macOS, or Unix: - - ``` - aws rds modify-db-instance \ - --db-instance-identifier mydbinstance \ - --db-parameter-group-name dbmail-sqlserver-se-13 \ - --apply-immediately - ``` - - For Windows: - - ``` - aws rds modify-db-instance ^ - --db-instance-identifier mydbinstance ^ - --db-parameter-group-name dbmail-sqlserver-se-13 ^ - --apply-immediately - ``` - -## Configuring Database Mail - -You perform the following tasks to configure Database Mail: - -1. Create the Database Mail profile\. - -1. Create the Database Mail account\. - -1. Add the Database Mail account to the Database Mail profile\. - -1. Add users to the Database Mail profile\. - -**Note** -To configure Database Mail, make sure that you have `execute` permission on the stored procedures in the `msdb` database\. - -### Creating the Database Mail profile - -To create the Database Mail profile, you use the [sysmail\_add\_profile\_sp](https://docs.microsoft.com/en-us/sql/relational-databases/system-stored-procedures/sysmail-add-profile-sp-transact-sql) stored procedure\. The following example creates a profile named `Notifications`\. - -**To create the profile** -+ Use the following SQL statement\. - - ``` - USE msdb - GO - - EXECUTE msdb.dbo.sysmail_add_profile_sp - @profile_name = 'Notifications', - @description = 'Profile used for sending outgoing notifications using Amazon SES.'; - GO - ``` - -### Creating the Database Mail account - -To create the Database Mail account, you use the [sysmail\_add\_account\_sp](https://docs.microsoft.com/en-us/sql/relational-databases/system-stored-procedures/sysmail-add-account-sp-transact-sql) stored procedure\. The following example creates an account named `SES` on an RDS for SQL Server DB instance in a private VPC, using Amazon Simple Email Service\. - -Using Amazon SES requires the following parameters: -+ `@email_address` – An Amazon SES verified identity\. For more information, see [Verified identities in Amazon SES](https://docs.aws.amazon.com/ses/latest/dg/verify-addresses-and-domains.html)\. -+ `@mailserver_name` – An Amazon SES SMTP endpoint\. For more information, see [Connecting to an Amazon SES SMTP endpoint](https://docs.aws.amazon.com/ses/latest/dg/smtp-connect.html)\. -+ `@username` – An Amazon SES SMTP user name\. For more information, see [Obtaining Amazon SES SMTP credentials](https://docs.aws.amazon.com/ses/latest/dg/smtp-credentials.html)\. - - Don't use an AWS Identity and Access Management user name\. -+ `@password` – An Amazon SES SMTP password\. For more information, see [Obtaining Amazon SES SMTP credentials](https://docs.aws.amazon.com/ses/latest/dg/smtp-credentials.html)\. - -**To create the account** -+ Use the following SQL statement\. - - ``` - USE msdb - GO - - EXECUTE msdb.dbo.sysmail_add_account_sp - @account_name = 'SES', - @description = 'Mail account for sending outgoing notifications.', - @email_address = 'nobody@example.com', - @display_name = 'Automated Mailer', - @mailserver_name = 'vpce-0a1b2c3d4e5f-01234567.email-smtp.us-west-2.vpce.amazonaws.com', - @port = 587, - @enable_ssl = 1, - @username = 'Smtp_Username', - @password = 'Smtp_Password'; - GO - ``` - -### Adding the Database Mail account to the Database Mail profile - -To add the Database Mail account to the Database Mail profile, you use the [sysmail\_add\_profileaccount\_sp](https://docs.microsoft.com/en-us/sql/relational-databases/system-stored-procedures/sysmail-add-profileaccount-sp-transact-sql) stored procedure\. The following example adds the `SES` account to the `Notifications` profile\. - -**To add the account to the profile** -+ Use the following SQL statement\. - - ``` - USE msdb - GO - - EXECUTE msdb.dbo.sysmail_add_profileaccount_sp - @profile_name = 'Notifications', - @account_name = 'SES', - @sequence_number = 1; - GO - ``` - -### Adding users to the Database Mail profile - -To grant permission for an `msdb` database principal to use a Database Mail profile, you use the [sysmail\_add\_principalprofile\_sp](https://docs.microsoft.com/en-us/sql/relational-databases/system-stored-procedures/sysmail-add-principalprofile-sp-transact-sql) stored procedure\. A *principal* is an entity that can request SQL Server resources\. The database principal must map to a SQL Server authentication user, a Windows Authentication user, or a Windows Authentication group\. - -The following example grants public access to the `Notifications` profile\. - -**To add a user to the profile** -+ Use the following SQL statement\. - - ``` - USE msdb - GO - - EXECUTE msdb.dbo.sysmail_add_principalprofile_sp - @profile_name = 'Notifications', - @principal_name = 'public', - @is_default = 1; - GO - ``` - -## Amazon RDS stored procedures and functions for Database Mail - -Microsoft provides [stored procedures](https://docs.microsoft.com/en-us/sql/relational-databases/system-stored-procedures/database-mail-stored-procedures-transact-sql) for using Database Mail, such as creating, listing, updating, and deleting accounts and profiles\. In addition, RDS provides the stored procedures and functions for Database Mail shown in the following table\. - - -| Procedure/Function | Description | -| --- | --- | -| rds\_fn\_sysmail\_allitems | Shows sent messages, including those submitted by other users\. | -| rds\_fn\_sysmail\_event\_log | Shows events, including those for messages submitted by other users\. | -| rds\_fn\_sysmail\_mailattachments | Shows attachments, including those to messages submitted by other users\. | -| rds\_sysmail\_control | Starts and stops the mail queue \(DatabaseMail\.exe process\)\. | -| rds\_sysmail\_delete\_mailitems\_sp | Deletes email messages sent by all users from the Database Mail internal tables\. | - -## Sending email messages using Database Mail - -You use the [sp\_send\_dbmail](https://docs.microsoft.com/en-us/sql/relational-databases/system-stored-procedures/sp-send-dbmail-transact-sql) stored procedure to send email messages using Database Mail\. - -### Usage - -``` -EXEC msdb.dbo.sp_send_dbmail -@profile_name = 'profile_name', -@recipients = 'recipient1@example.com[; recipient2; ... recipientn]', -@subject = 'subject', -@body = 'message_body', -[@body_format = 'HTML'], -[@file_attachments = 'file_path1; file_path2; ... file_pathn'], -[@query = 'SQL_query'], -[@attach_query_result_as_file = 0|1]'; -``` - -The following parameters are required: -+ `@profile_name` – The name of the Database Mail profile from which to send the message\. -+ `@recipients` – The semicolon\-delimited list of email addresses to which to send the message\. -+ `@subject` – The subject of the message\. -+ `@body` – The body of the message\. You can also use a declared variable as the body\. - -The following parameters are optional: -+ `@body_format` – This parameter is used with a declared variable to send email in HTML format\. -+ `@file_attachments` – The semicolon\-delimited list of message attachments\. File paths must be absolute paths\. -+ `@query` – A SQL query to run\. The query results can be attached as a file or included in the body of the message\. -+ `@attach_query_result_as_file` – Whether to attach the query result as a file\. Set to 0 for no, 1 for yes\. The default is 0\. - -### Examples - -The following examples demonstrate how to send email messages\. - -**Example of sending a message to a single recipient** - -``` -USE msdb -GO - -EXEC msdb.dbo.sp_send_dbmail - @profile_name = 'Notifications', - @recipients = 'nobody@example.com', - @subject = 'Automated DBMail message - 1', - @body = 'Database Mail configuration was successful.'; -GO -``` - -**Example of sending a message to multiple recipients** - -``` -USE msdb -GO - -EXEC msdb.dbo.sp_send_dbmail - @profile_name = 'Notifications', - @recipients = 'recipient1@example.com;recipient2@example.com', - @subject = 'Automated DBMail message - 2', - @body = 'This is a message.'; -GO -``` - -**Example of sending a SQL query result as a file attachment** - -``` -USE msdb -GO - -EXEC msdb.dbo.sp_send_dbmail - @profile_name = 'Notifications', - @recipients = 'nobody@example.com', - @subject = 'Test SQL query', - @body = 'This is a SQL query test.', - @query = 'SELECT * FROM abc.dbo.test', - @attach_query_result_as_file = 1; -GO -``` - -**Example of sending a message in HTML format** - -``` -USE msdb -GO - -DECLARE @HTML_Body as NVARCHAR(500) = 'Hi,

Heading


See the report. Regards '; - -EXEC msdb.dbo.sp_send_dbmail - @profile_name = 'Notifications', - @recipients = 'nobody@example.com', - @subject = 'Test HTML message', - @body = @HTML_Body, - @body_format = 'HTML'; -GO -``` - -**Example of sending a message using a trigger when a specific event occurs in the database** - -``` -USE AdventureWorks2017 -GO -IF OBJECT_ID ('Production.iProductNotification', 'TR') IS NOT NULL -DROP TRIGGER Purchasing.iProductNotification -GO - -CREATE TRIGGER iProductNotification ON Production.Product - FOR INSERT - AS - DECLARE @ProductInformation nvarchar(255); - SELECT - @ProductInformation = 'A new product, ' + Name + ', is now available for $' + CAST(StandardCost AS nvarchar(20)) + '!' - FROM INSERTED i; - -EXEC msdb.dbo.sp_send_dbmail - @profile_name = 'Notifications', - @recipients = 'nobody@example.com', - @subject = 'New product information', - @body = @ProductInformation; -GO -``` - -## Viewing messages, logs, and attachments - -You use RDS stored procedures to view messages, event logs, and attachments\. - -**To view all email messages** -+ Use the following SQL query\. - - ``` - SELECT * FROM msdb.dbo.rds_fn_sysmail_allitems(); --WHERE sent_status='sent' or 'failed' or 'unsent' - ``` - -**To view all email event logs** -+ Use the following SQL query\. - - ``` - SELECT * FROM msdb.dbo.rds_fn_sysmail_event_log(); - ``` - -**To view all email attachments** -+ Use the following SQL query\. - - ``` - SELECT * FROM msdb.dbo.rds_fn_sysmail_mailattachments(); - ``` - -## Deleting messages - -You use the `rds_sysmail_delete_mailitems_sp` stored procedure to delete messages\. - -**Note** -RDS automatically deletes mail table items when DBMail history data reaches 1 GB in size, with a retention period of at least 24 hours\. -If you want to keep mail items for a longer period, you can archive them\. For more information, see [Create a SQL Server Agent job to archive Database Mail messages and event logs](https://docs.microsoft.com/en-us/sql/relational-databases/database-mail/create-a-sql-server-agent-job-to-archive-database-mail-messages-and-event-logs) in the Microsoft documentation\. - -**To delete all email messages** -+ Use the following SQL statement\. - - ``` - DECLARE @GETDATE datetime - SET @GETDATE = GETDATE(); - EXECUTE msdb.dbo.rds_sysmail_delete_mailitems_sp @sent_before = @GETDATE; - GO - ``` - -**To delete all email messages with a particular status** -+ Use the following SQL statement to delete all failed messages\. - - ``` - DECLARE @GETDATE datetime - SET @GETDATE = GETDATE(); - EXECUTE msdb.dbo.rds_sysmail_delete_mailitems_sp @sent_status = 'failed'; - GO - ``` - -## Starting the mail queue - -You use the `rds_sysmail_control` stored procedure to start the Database Mail process\. - -**Note** -Enabling Database Mail automatically starts the mail queue\. - -**To start the mail queue** -+ Use the following SQL statement\. - - ``` - EXECUTE msdb.dbo.rds_sysmail_control start; - GO - ``` - -## Stopping the mail queue - -You use the `rds_sysmail_control` stored procedure to stop the Database Mail process\. - -**To stop the mail queue** -+ Use the following SQL statement\. - - ``` - EXECUTE msdb.dbo.rds_sysmail_control stop; - GO - ``` - -## Working with file attachments - -The following file attachment extensions aren't supported in Database Mail messages from RDS on SQL Server: \.ade, \.adp, \.apk, \.appx, \.appxbundle, \.bat, \.bak, \.cab, \.chm, \.cmd, \.com, \.cpl, \.dll, \.dmg, \.exe, \.hta, \.inf1, \.ins, \.isp, \.iso, \.jar, \.job, \.js, \.jse, \.ldf, \.lib, \.lnk, \.mde, \.mdf, \.msc, \.msi, \.msix, \.msixbundle, \.msp, \.mst, \.nsh, \.pif, \.ps, \.ps1, \.psc1, \.reg, \.rgs, \.scr, \.sct, \.shb, \.shs, \.svg, \.sys, \.u3p, \.vb, \.vbe, \.vbs, \.vbscript, \.vxd, \.ws, \.wsc, \.wsf, and \.wsh\. - -Database Mail uses the Microsoft Windows security context of the current user to control access to files\. Users who log in with SQL Server Authentication can't attach files using the `@file_attachments` parameter with the `sp_send_dbmail` stored procedure\. Windows doesn't allow SQL Server to provide credentials from a remote computer to another remote computer\. Therefore, Database Mail can't attach files from a network share when the command is run from a computer other than the computer running SQL Server\. - -However, you can use SQL Server Agent jobs to attach files\. For more information on SQL Server Agent, see [Using SQL Server Agent](Appendix.SQLServer.CommonDBATasks.Agent.md) and [SQL Server Agent](https://docs.microsoft.com/en-us/sql/ssms/agent/sql-server-agent) in the Microsoft documentation\. - -## Considerations for Multi\-AZ deployments - -When you configure Database Mail on a Multi\-AZ DB instance, the configuration isn't automatically propagated to the secondary\. We recommend converting the Multi\-AZ instance to a Single\-AZ instance, configuring Database Mail, and then converting the DB instance back to Multi\-AZ\. Then both the primary and secondary nodes have the Database Mail configuration\. - -If you create a read replica from your Multi\-AZ instance that has Database Mail configured, the replica inherits the configuration, but without the password to the SMTP server\. Update the Database Mail account with the password\. \ No newline at end of file diff --git a/doc_source/SQLServer.ExtendedEvents.md b/doc_source/SQLServer.ExtendedEvents.md deleted file mode 100644 index ea7695c..0000000 --- a/doc_source/SQLServer.ExtendedEvents.md +++ /dev/null @@ -1,94 +0,0 @@ -# Using extended events with Amazon RDS for Microsoft SQL Server - -You can use extended events in Microsoft SQL Server to capture debugging and troubleshooting information for Amazon RDS for SQL Server\. Extended events replace SQL Trace and Server Profiler, which have been deprecated by Microsoft\. Extended events are similar to profiler traces but with more granular control on the events being traced\. Extended events are supported for SQL Server versions 2014 and later on Amazon RDS\. For more information, see [Extended events overview](https://docs.microsoft.com/en-us/sql/relational-databases/extended-events/extended-events) in the Microsoft documentation\. - -Extended events are turned on automatically for users with master user privileges in Amazon RDS for SQL Server\. - -**Topics** -+ [Limitations and recommendations](#SQLServer.ExtendedEvents.Limits) -+ [Configuring extended events on RDS for SQL Server](#SQLServer.ExtendedEvents.Config) -+ [Considerations for Multi\-AZ deployments](#SQLServer.ExtendedEvents.MAZ) -+ [Querying extended event files](#SQLServer.ExtendedEvents.Querying) - -## Limitations and recommendations - -When using extended events on RDS for SQL Server, the following limitations apply: -+ Extended events are supported only for the Enterprise and Standard Editions\. -+ You can't alter default extended event sessions\. -+ Make sure to set the session memory partition mode to `NONE`\. -+ Session event retention mode can be either `ALLOW_SINGLE_EVENT_LOSS` or `ALLOW_MULTIPLE_EVENT_LOSS`\. -+ Event Tracing for Windows \(ETW\) targets aren't supported\. -+ Make sure that file targets are in the `D:\rdsdbdata\log` directory\. -+ For pair matching targets, set the `respond_to_memory_pressure` property to `1`\. -+ Ring buffer target memory can't be greater than 4 MB\. -+ The following actions aren't supported: - + `debug_break` - + `create_dump_all_threads` - + `create_dump_single_threads` -+ The `rpc_completed` event is supported on the following versions and later: 15\.0\.4083\.2, 14\.0\.3370\.1, 13\.0\.5865\.1, 12\.0\.6433\.1, 11\.0\.7507\.2\. - -## Configuring extended events on RDS for SQL Server - -On RDS for SQL Server, you can configure the values of certain parameters of extended event sessions\. The following table describes the configurable parameters\. - - -| Parameter name | Description | RDS default value | Minimum value | Maximum value | -| --- | --- | --- | --- | --- | -| xe\_session\_max\_memory | Specifies the maximum amount of memory to allocate to the session for event buffering\. This value corresponds to the max\_memory setting of the event session\. | 4 MB | 4 MB | 8 MB | -| xe\_session\_max\_event\_size | Specifies the maximum memory size allowed for large events\. This value corresponds to the max\_event\_size setting of the event session\. | 4 MB | 4 MB | 8 MB | -| xe\_session\_max\_dispatch\_latency | Specifies the amount of time that events are buffered in memory before being dispatched to extended event session targets\. This value corresponds to the max\_dispatch\_latency setting of the event session\. | 30 seconds | 1 second | 30 seconds | -| xe\_file\_target\_size | Specifies the maximum size of the file target\. This value corresponds to the max\_file\_size setting of the file target\. | 100 MB | 10 MB | 1 GB | -| xe\_file\_retention | Specifies the retention time in days for files generated by the file targets of event sessions\. | 7 days | 0 days | 7 days | - -**Note** -Setting `xe_file_retention` to zero causes \.xel files to be removed automatically after the lock on these files is released by SQL Server\. The lock is released whenever an \.xel file reaches the size limit set in `xe_file_target_size`\. - -You can use the `rdsadmin.dbo.rds_show_configuration` stored procedure to show the current values of these parameters\. For example, use the following SQL statement to view the current setting of `xe_session_max_memory`\. - -``` -exec rdsadmin..rds_show_configuration 'xe_session_max_memory' -``` - -You can use the `rdsadmin.dbo.rds_set_configuration` stored procedure to modify them\. For example, use the following SQL statement to set `xe_session_max_memory` to 4 MB\. - -``` -exec rdsadmin..rds_set_configuration 'xe_session_max_memory', 4 -``` - -## Considerations for Multi\-AZ deployments - -When you create an extended event session on a primary DB instance, it doesn't propagate to the standby replica\. You can fail over and create the extended event session on the new primary DB instance\. Or you can remove and then re\-add the Multi\-AZ configuration to propagate the extended event session to the standby replica\. RDS stops all nondefault extended event sessions on the standby replica, so that these sessions don't consume resources on the standby\. Because of this, after a standby replica becomes the primary DB instance, make sure to manually start the extended event sessions on the new primary\. - -**Note** -This approach applies to both Always On Availability Groups and Database Mirroring\. - -You can also use a SQL Server Agent job to track the standby replica and start the sessions if the standby becomes the primary\. For example, use the following query in your SQL Server Agent job step to restart event sessions on a primary DB instance\. - -``` -BEGIN - IF (DATABASEPROPERTYEX('rdsadmin','Updateability')='READ_WRITE' - AND DATABASEPROPERTYEX('rdsadmin','status')='ONLINE' - AND (DATABASEPROPERTYEX('rdsadmin','Collation') IS NOT NULL OR DATABASEPROPERTYEX('rdsadmin','IsAutoClose')=1) - ) - BEGIN - IF NOT EXISTS (SELECT 1 FROM sys.dm_xe_sessions WHERE name='xe1') - ALTER EVENT SESSION xe1 ON SERVER STATE=START - IF NOT EXISTS (SELECT 1 FROM sys.dm_xe_sessions WHERE name='xe2') - ALTER EVENT SESSION xe2 ON SERVER STATE=START - END -END -``` - -This query restarts the event sessions `xe1` and `xe2` on a primary DB instance if these sessions are in a stopped state\. You can also add a schedule with a convenient interval to this query\. - -## Querying extended event files - -You can either use SQL Server Management Studio or the `sys.fn_xe_file_target_read_file` function to view data from extended events that use file targets\. For more information on this function, see [sys\.fn\_xe\_file\_target\_read\_file \(Transact\-SQL\)](https://docs.microsoft.com/en-us/sql/relational-databases/system-functions/sys-fn-xe-file-target-read-file-transact-sql) in the Microsoft documentation\. - -Extended event file targets can only write files to the `D:\rdsdbdata\log` directory on RDS for SQL Server\. - -As an example, use the following SQL query to list the contents of all files of extended event sessions whose names start with `xe`\. - -``` -SELECT * FROM sys.fn_xe_file_target_read_file('d:\rdsdbdata\log\xe*', null,null,null); -``` \ No newline at end of file diff --git a/doc_source/SQLServer.InstanceStore.md b/doc_source/SQLServer.InstanceStore.md deleted file mode 100644 index 928cf8a..0000000 --- a/doc_source/SQLServer.InstanceStore.md +++ /dev/null @@ -1,58 +0,0 @@ -# Instance store support for the tempdb database on Amazon RDS for SQL Server - -An *instance store* provides temporary block\-level storage for your DB instance\. This storage is located on disks that are physically attached to the host computer\. These disks have Non\-Volatile Memory Express \(NVMe\) instance storage that is based on solid\-state drives \(SSDs\)\. This storage is optimized for low latency, very high random I/O performance, and high sequential read throughput\. - -By placing `tempdb` data files and `tempdb` log files on the instance store, you can achieve lower read and write latencies compared to standard storage based on Amazon EBS\. - -**Note** -SQL Server database files and database log files aren't placed on the instance store\. - -## Enabling the instance store - -When RDS provisions DB instances with one of the following instance classes, the `tempdb` database is automatically placed onto the instance store: -+ db\.m5d -+ db\.r5d - -To enable the instance store, do one of the following: -+ Create a SQL Server DB instance using one of these instance types\. For more information, see [Creating an Amazon RDS DB instance](USER_CreateDBInstance.md)\. -+ Modify an existing SQL Server DB instance to use one of them\. For more information, see [Modifying an Amazon RDS DB instance](Overview.DBInstance.Modifying.md)\. - -The instance store is available in all AWS Regions where one or more of these instance types are supported\. For more information on the `db.m5d` and `db.r5d` instance classes, see [DB instance classes](Concepts.DBInstanceClass.md)\. For more information on the instance classes supported by Amazon RDS for SQL Server, see [DB instance class support for Microsoft SQL Server](CHAP_SQLServer.md#SQLServer.Concepts.General.InstanceClasses)\. - -## File location and size considerations - -On instances without an instance store, RDS stores the `tempdb` data and log files in the `D:\rdsdbdata\DATA` directory\. Both files start at 8 MB by default\. - -On instances with an instance store, RDS stores the `tempdb` data and log files in the `T:\rdsdbdata\DATA` directory\. - -When `tempdb` has only one data file \(`tempdb.mdf`\) and one log file \(`templog.ldf`\), `templog.ldf` starts at 8 MB by default and `tempdb.mdf` starts at 80% or more of the instance's storage capacity\. Twenty percent of the storage capacity or 200 GB, whichever is less, is kept free to start\. Multiple `tempdb` data files split the 80% disk space evenly, while log files always have an 8\-MB initial size\. - -For example, if you modify your DB instance class from `db.m5.2xlarge` to `db.m5d.2xlarge`, the size of `tempdb` data files increases from 8 MB each to 234 GB in total\. - -**Note** -Besides the `tempdb` data and log files on the instance store \(`T:\rdsdbdata\DATA`\), you can still create extra `tempdb` data and log files on the data volume \(`D:\rdsdbdata\DATA`\)\. Those files always have an 8 MB initial size\. - -## Backup considerations - -You might need to retain backups for long periods, incurring costs over time\. The `tempdb` data and log blocks can change very often depending on the workload\. This can greatly increase the DB snapshot size\. - -When `tempdb` is on the instance store, snapshots don't include temporary files\. This means that snapshot sizes are smaller and consume less of the free backup allocation compared to EBS\-only storage\. - -## Disk full errors - -If you use all of the available space in the instance store, you might receive errors such as the following: -+ The transaction log for database 'tempdb' is full due to 'ACTIVE\_TRANSACTION'\. -+ Could not allocate space for object 'dbo\.SORT temporary run storage: 140738941419520' in database 'tempdb' because the 'PRIMARY' filegroup is full\. Create disk space by deleting unneeded files, dropping objects in the filegroup, adding additional files to the filegroup, or setting autogrowth on for existing files in the filegroup\. - -You can do one or more of the following when the instance store is full: -+ Adjust your workload or the way you use `tempdb`\. -+ Scale up to use a DB instance class with more NVMe storage\. -+ Stop using the instance store, and use an instance class with only EBS storage\. -+ Use a mixed mode by adding secondary data or log files for `tempdb` on the EBS volume\. - -## Removing the instance store - -To remove the instance store, modify your SQL Server DB instance to use an instance type that doesn't support instance store, such as `db.m5` or `db.r5`\. - -**Note** -When you remove the instance store, the temporary files are moved to the `D:\rdsdbdata\DATA` directory and reduced in size to 8 MB\. \ No newline at end of file diff --git a/doc_source/SQLServer.Procedural.Importing.Snapshots.md b/doc_source/SQLServer.Procedural.Importing.Snapshots.md deleted file mode 100644 index 25db635..0000000 --- a/doc_source/SQLServer.Procedural.Importing.Snapshots.md +++ /dev/null @@ -1,385 +0,0 @@ -# Importing and exporting SQL Server data using other methods - -Following, you can find information about using snapshots to import your Microsoft SQL Server data to Amazon RDS\. You can also find information about using snapshots to export your data from an RDS DB instance running SQL Server\. - -If your scenario supports it, it's easier to move data in and out of Amazon RDS by using the native backup and restore functionality\. For more information, see [Importing and exporting SQL Server databases using native backup and restore](SQLServer.Procedural.Importing.md)\. - -**Note** -Amazon RDS for Microsoft SQL Server doesn't support importing data into the `msdb` database\. - -## Importing data into RDS for SQL Server by using a snapshot - -**To import data into a SQL Server DB instance by using a snapshot** - -1. Create a DB instance\. For more information, see [Creating an Amazon RDS DB instance](USER_CreateDBInstance.md)\. - -1. Stop applications from accessing the destination DB instance\. - - If you prevent access to your DB instance while you are importing data, data transfer is faster\. Additionally, you don't need to worry about conflicts while data is being loaded if other applications cannot write to the DB instance at the same time\. If something goes wrong and you have to roll back to an earlier database snapshot, the only changes that you lose are the imported data\. You can import this data again after you resolve the issue\. - - For information about controlling access to your DB instance, see [Controlling access with security groups](Overview.RDSSecurityGroups.md)\. - -1. Create a snapshot of the target database\. - - If the target database is already populated with data, we recommend that you take a snapshot of the database before you import the data\. If something goes wrong with the data import or you want to discard the changes, you can restore the database to its previous state by using the snapshot\. For information about database snapshots, see [Creating a DB snapshot](USER_CreateSnapshot.md)\. -**Note** -When you take a database snapshot, I/O operations to the database are suspended for a moment \(milliseconds\) while the backup is in progress\. - -1. Disable automated backups on the target database\. - - Disabling automated backups on the target DB instance improves performance while you are importing your data because Amazon RDS doesn't log transactions when automatic backups are disabled\. However, there are some things to consider\. Automated backups are required to perform a point\-in\-time recovery\. Thus, you can't restore the database to a specific point in time while you are importing data\. Additionally, any automated backups that were created on the DB instance are erased unless you choose to retain them\. - - Choosing to retain the automated backups can help protect you against accidental deletion of data\. Amazon RDS also saves the database instance properties along with each automated backup to make it easy to recover\. Using this option lets you can restore a deleted database instance to a specified point in time within the backup retention period even after deleting it\. Automated backups are automatically deleted at the end of the specified backup window, just as they are for an active database instance\. - - You can also use previous snapshots to recover the database, and any snapshots that you have taken remain available\. For information about automated backups, see [Working with backups](USER_WorkingWithAutomatedBackups.md)\. - -1. Disable foreign key constraints, if applicable\. - - If you need to disable foreign key constraints, you can do so with the following script\. - - ``` - --Disable foreign keys on all tables - DECLARE @table_name SYSNAME; - DECLARE @cmd NVARCHAR(MAX); - DECLARE table_cursor CURSOR FOR SELECT name FROM sys.tables; - - OPEN table_cursor; - FETCH NEXT FROM table_cursor INTO @table_name; - - WHILE @@FETCH_STATUS = 0 BEGIN - SELECT @cmd = 'ALTER TABLE '+QUOTENAME(@table_name)+' NOCHECK CONSTRAINT ALL'; - EXEC (@cmd); - FETCH NEXT FROM table_cursor INTO @table_name; - END - - CLOSE table_cursor; - DEALLOCATE table_cursor; - - GO - ``` - -1. Drop indexes, if applicable\. - -1. Disable triggers, if applicable\. - - If you need to disable triggers, you can do so with the following script\. - - ``` - --Disable triggers on all tables - DECLARE @enable BIT = 0; - DECLARE @trigger SYSNAME; - DECLARE @table SYSNAME; - DECLARE @cmd NVARCHAR(MAX); - DECLARE trigger_cursor CURSOR FOR SELECT trigger_object.name trigger_name, - table_object.name table_name - FROM sysobjects trigger_object - JOIN sysobjects table_object ON trigger_object.parent_obj = table_object.id - WHERE trigger_object.type = 'TR'; - - OPEN trigger_cursor; - FETCH NEXT FROM trigger_cursor INTO @trigger, @table; - - WHILE @@FETCH_STATUS = 0 BEGIN - IF @enable = 1 - SET @cmd = 'ENABLE '; - ELSE - SET @cmd = 'DISABLE '; - - SET @cmd = @cmd + ' TRIGGER dbo.'+QUOTENAME(@trigger)+' ON dbo.'+QUOTENAME(@table)+' '; - EXEC (@cmd); - FETCH NEXT FROM trigger_cursor INTO @trigger, @table; - END - - CLOSE trigger_cursor; - DEALLOCATE trigger_cursor; - - GO - ``` - -1. Query the source SQL Server instance for any logins that you want to import to the destination DB instance\. - - SQL Server stores logins and passwords in the `master` database\. Because Amazon RDS doesn't grant access to the `master` database, you cannot directly import logins and passwords into your destination DB instance\. Instead, you must query the `master` database on the source SQL Server instance to generate a data definition language \(DDL\) file\. This file should include all logins and passwords that you want to add to the destination DB instance\. This file also should include role memberships and permissions that you want to transfer\. - - For information about querying the `master` database, see [ How to transfer the logins and the passwords between instances of SQL Server 2005 and SQL Server 2008](http://support.microsoft.com/kb/918992) in the Microsoft Knowledge Base\. - - The output of the script is another script that you can run on the destination DB instance\. The script in the Knowledge Base article has the following code: - - ``` - p.type IN - ``` - - Every place `p.type` appears, use the following code instead: - - ``` - p.type = 'S' - ``` - -1. Import the data using the method in [Import the data](#ImportData.SQLServer.Import)\. - -1. Grant applications access to the target DB instance\. - - When your data import is complete, you can grant access to the DB instance to those applications that you blocked during the import\. For information about controlling access to your DB instance, see [Controlling access with security groups](Overview.RDSSecurityGroups.md)\. - -1. Enable automated backups on the target DB instance\. - - For information about automated backups, see [Working with backups](USER_WorkingWithAutomatedBackups.md)\. - -1. Enable foreign key constraints\. - - If you disabled foreign key constraints earlier, you can now enable them with the following script\. - - ``` - --Enable foreign keys on all tables - DECLARE @table_name SYSNAME; - DECLARE @cmd NVARCHAR(MAX); - DECLARE table_cursor CURSOR FOR SELECT name FROM sys.tables; - - OPEN table_cursor; - FETCH NEXT FROM table_cursor INTO @table_name; - - WHILE @@FETCH_STATUS = 0 BEGIN - SELECT @cmd = 'ALTER TABLE '+QUOTENAME(@table_name)+' CHECK CONSTRAINT ALL'; - EXEC (@cmd); - FETCH NEXT FROM table_cursor INTO @table_name; - END - - CLOSE table_cursor; - DEALLOCATE table_cursor; - ``` - -1. Enable indexes, if applicable\. - -1. Enable triggers, if applicable\. - - If you disabled triggers earlier, you can now enable them with the following script\. - - ``` - --Enable triggers on all tables - DECLARE @enable BIT = 1; - DECLARE @trigger SYSNAME; - DECLARE @table SYSNAME; - DECLARE @cmd NVARCHAR(MAX); - DECLARE trigger_cursor CURSOR FOR SELECT trigger_object.name trigger_name, - table_object.name table_name - FROM sysobjects trigger_object - JOIN sysobjects table_object ON trigger_object.parent_obj = table_object.id - WHERE trigger_object.type = 'TR'; - - OPEN trigger_cursor; - FETCH NEXT FROM trigger_cursor INTO @trigger, @table; - - WHILE @@FETCH_STATUS = 0 BEGIN - IF @enable = 1 - SET @cmd = 'ENABLE '; - ELSE - SET @cmd = 'DISABLE '; - - SET @cmd = @cmd + ' TRIGGER dbo.'+QUOTENAME(@trigger)+' ON dbo.'+QUOTENAME(@table)+' '; - EXEC (@cmd); - FETCH NEXT FROM trigger_cursor INTO @trigger, @table; - END - - CLOSE trigger_cursor; - DEALLOCATE trigger_cursor; - ``` - -### Import the data - -Microsoft SQL Server Management Studio is a graphical SQL Server client that is included in all Microsoft SQL Server editions except the Express Edition\. SQL Server Management Studio Express is available from Microsoft as a free download\. To find this download, see [the Microsoft website](http://www.microsoft.com/en-us/download/default.aspx)\. - -**Note** -SQL Server Management Studio is available only as a Windows\-based application\. - -SQL Server Management Studio includes the following tools, which are useful in importing data to a SQL Server DB instance: -+ Generate and Publish Scripts Wizard -+ Import and Export Wizard -+ Bulk copy - -#### Generate and Publish Scripts Wizard - -The Generate and Publish Scripts Wizard creates a script that contains the schema of a database, the data itself, or both\. You can generate a script for a database in your local SQL Server deployment\. You can then run the script to transfer the information that it contains to an Amazon RDS DB instance\. - -**Note** -For databases of 1 GiB or larger, it's more efficient to script only the database schema\. You then use the Import and Export Wizard or the bulk copy feature of SQL Server to transfer the data\. - -For detailed information about the Generate and Publish Scripts Wizard, see the [Microsoft SQL Server documentation](http://msdn.microsoft.com/en-us/library/ms178078%28v=sql.105%29.aspx)\. - -In the wizard, pay particular attention to the advanced options on the **Set Scripting Options** page to ensure that everything you want your script to include is selected\. For example, by default, database triggers are not included in the script\. - -When the script is generated and saved, you can use SQL Server Management Studio to connect to your DB instance and then run the script\. - -#### Import and Export Wizard - -The Import and Export Wizard creates a special Integration Services package, which you can use to copy data from your local SQL Server database to the destination DB instance\. The wizard can filter which tables and even which tuples within a table are copied to the destination DB instance\. - -**Note** -The Import and Export Wizard works well for large datasets, but it might not be the fastest way to remotely export data from your local deployment\. For an even faster way, consider the SQL Server bulk copy feature\. - -For detailed information about the Import and Export Wizard, see the [ Microsoft SQL Server documentation](http://msdn.microsoft.com/en-us/library/ms140052%28v=sql.105%29.aspx)\. - -In the wizard, on the **Choose a Destination** page, do the following: -+ For **Server Name**, type the name of the endpoint for your DB instance\. -+ For the server authentication mode, choose **Use SQL Server Authentication**\. -+ For **User name** and **Password**, type the credentials for the master user that you created for the DB instance\. - -#### Bulk copy - -The SQL Server bulk copy feature is an efficient means of copying data from a source database to your DB instance\. Bulk copy writes the data that you specify to a data file, such as an ASCII file\. You can then run bulk copy again to write the contents of the file to the destination DB instance\. - -This section uses the **bcp** utility, which is included with all editions of SQL Server\. For detailed information about bulk import and export operations, see [the Microsoft SQL Server documentation](http://msdn.microsoft.com/en-us/library/ms187042%28v=sql.105%29.aspx)\. - -**Note** -Before you use bulk copy, you must first import your database schema to the destination DB instance\. The Generate and Publish Scripts Wizard, described earlier in this topic, is an excellent tool for this purpose\. - -The following command connects to the local SQL Server instance\. It generates a tab\-delimited file of a specified table in the C:\\ root directory of your existing SQL Server deployment\. The table is specified by its fully qualified name, and the text file has the same name as the table that is being copied\. - -``` -bcp dbname.schema_name.table_name out C:\table_name.txt -n -S localhost -U username -P password -b 10000 -``` - -The preceding code includes the following options: -+ `-n` specifies that the bulk copy uses the native data types of the data to be copied\. -+ `-S` specifies the SQL Server instance that the *bcp* utility connects to\. -+ `-U` specifies the user name of the account to log in to the SQL Server instance\. -+ `-P` specifies the password for the user specified by `-U`\. -+ `-b` specifies the number of rows per batch of imported data\. - -**Note** -There might be other parameters that are important to your import situation\. For example, you might need the `-E` parameter that pertains to identity values\. For more information; see the full description of the command line syntax for the **bcp** utility in [the Microsoft SQL Server documentation](http://msdn.microsoft.com/en-us/library/ms162802%28v=sql.105%29.aspx)\. - -For example, suppose that a database named `store` that uses the default schema, `dbo`, contains a table named `customers`\. The user account `admin`, with the password `insecure`, copies 10,000 rows of the `customers` table to a file named `customers.txt`\. - -``` -bcp store.dbo.customers out C:\customers.txt -n -S localhost -U admin -P insecure -b 10000 -``` - -After you generate the data file, you can upload the data to your DB instance by using a similar command\. Beforehand, create the database and schema on the target DB instance\. Then use the `in` argument to specify an input file instead of `out` to specify an output file\. Instead of using localhost to specify the local SQL Server instance, specify the endpoint of your DB instance\. If you use a port other than 1433, specify that too\. The user name and password are the master user and password for your DB instance\. The syntax is as follows\. - -``` -bcp dbname.schema_name.table_name in C:\table_name.txt -n -S endpoint,port -U master_user_name -P master_user_password -b 10000 -``` - -To continue the previous example, suppose that the master user name is `admin`, and the password is `insecure`\. The endpoint for the DB instance is `rds.ckz2kqd4qsn1.us-east-1.rds.amazonaws.com`, and you use port 4080\. The command is as follows\. - -``` -bcp store.dbo.customers in C:\customers.txt -n -S rds.ckz2kqd4qsn1.us-east-1.rds.amazonaws.com,4080 -U admin -P insecure -b 10000 -``` - -## Exporting data from RDS for SQL Server - -You can choose one of the following options to export data from an RDS for SQL Server DB instance: -+ **Native database backup using a full backup file \(\.bak\)** – Using \.bak files to backup databases is heavily optimized, and is usually the fastest way to export data\. For more information, see [Importing and exporting SQL Server databases using native backup and restore](SQLServer.Procedural.Importing.md)\. -+ **SQL Server Import and Export Wizard** – For more information, see [SQL Server Import and Export Wizard](#SQLServer.Procedural.Exporting.SSIEW)\. -+ **SQL Server Generate and Publish Scripts Wizard and bcp utility** – For more information, see [SQL Server Generate and Publish Scripts Wizard and bcp utility](#SQLServer.Procedural.Exporting.SSGPSW)\. - -### SQL Server Import and Export Wizard - -You can use the SQL Server Import and Export Wizard to copy one or more tables, views, or queries from your RDS for SQL Server DB instance to another data store\. This choice is best if the target data store is not SQL Server\. For more information, see [ SQL Server Import and Export Wizard](http://msdn.microsoft.com/en-us/library/ms141209%28v=sql.110%29.aspx) in the SQL Server documentation\. - -The SQL Server Import and Export Wizard is available as part of Microsoft SQL Server Management Studio\. This graphical SQL Server client is included in all Microsoft SQL Server editions except the Express Edition\. SQL Server Management Studio is available only as a Windows\-based application\. SQL Server Management Studio Express is available from Microsoft as a free download\. To find this download, see [the Microsoft website](http://www.microsoft.com/en-us/search/Results.aspx?q=sql%20server%20management%20studio)\. - -**To use the SQL Server Import and Export Wizard to export data** - -1. In SQL Server Management Studio, connect to your RDS for SQL Server DB instance\. For details on how to do this, see [Connecting to a DB instance running the Microsoft SQL Server database engine](USER_ConnectToMicrosoftSQLServerInstance.md)\. - -1. In **Object Explorer**, expand **Databases**, open the context \(right\-click\) menu for the source database, choose **Tasks**, and then choose **Export Data**\. The wizard appears\. - -1. On the **Choose a Data Source** page, do the following: - - 1. For **Data source**, choose **SQL Server Native Client 11\.0**\. - - 1. Verify that the **Server name** box shows the endpoint of your RDS for SQL Server DB instance\. - - 1. Select **Use SQL Server Authentication**\. For **User name** and **Password**, type the master user name and password of your DB instance\. - - 1. Verify that the **Database** box shows the database from which you want to export data\. - - 1. Choose **Next**\. - -1. On the **Choose a Destination** page, do the following: - - 1. For **Destination**, choose **SQL Server Native Client 11\.0**\. -**Note** -Other target data sources are available\. These include \.NET Framework data providers, OLE DB providers, SQL Server Native Client providers, ADO\.NET providers, Microsoft Office Excel, Microsoft Office Access, and the Flat File source\. If you choose to target one of these data sources, skip the remainder of step 4\. For details on the connection information to provide next, see [Choose a destination](http://msdn.microsoft.com/en-us/library/ms178430%28v=sql.110%29.aspx) in the SQL Server documentation\. - - 1. For **Server name**, type the server name of the target SQL Server DB instance\. - - 1. Choose the appropriate authentication type\. Type a user name and password if necessary\. - - 1. For **Database**, choose the name of the target database, or choose **New** to create a new database to contain the exported data\. - - If you choose **New**, see [Create database](http://msdn.microsoft.com/en-us/library/ms183323%28v=sql.110%29.aspx) in the SQL Server documentation for details on the database information to provide\. - - 1. Choose **Next**\. - -1. On the **Table Copy or Query** page, choose **Copy data from one or more tables or views** or **Write a query to specify the data to transfer**\. Choose **Next**\. - -1. If you chose **Write a query to specify the data to transfer**, you see the **Provide a Source Query** page\. Type or paste in a SQL query, and then choose **Parse** to verify it\. Once the query validates, choose **Next**\. - -1. On the **Select Source Tables and Views** page, do the following: - - 1. Select the tables and views that you want to export, or verify that the query you provided is selected\. - - 1. Choose **Edit Mappings** and specify database and column mapping information\. For more information, see [Column mappings](http://msdn.microsoft.com/en-us/library/ms189660%28v=sql.110%29.aspx) in the SQL Server documentation\. - - 1. \(Optional\) To see a preview of data to be exported, select the table, view, or query, and then choose **Preview**\. - - 1. Choose **Next**\. - -1. On the **Run Package** page, verify that **Run immediately** is selected\. Choose **Next**\. - -1. On the **Complete the Wizard** page, verify that the data export details are as you expect\. Choose **Finish**\. - -1. On the **The execution was successful** page, choose **Close**\. - -### SQL Server Generate and Publish Scripts Wizard and bcp utility - -You can use the SQL Server Generate and Publish Scripts Wizard to create scripts for an entire database or just selected objects\. You can run these scripts on a target SQL Server DB instance to recreate the scripted objects\. You can then use the bcp utility to bulk export the data for the selected objects to the target DB instance\. This choice is best if you want to move a whole database \(including objects other than tables\) or large quantities of data between two SQL Server DB instances\. For a full description of the bcp command\-line syntax, see [bcp utility](http://msdn.microsoft.com/en-us/library/ms162802%28v=sql.110%29.aspx) in the Microsoft SQL Server documentation\. - -The SQL Server Generate and Publish Scripts Wizard is available as part of Microsoft SQL Server Management Studio\. This graphical SQL Server client is included in all Microsoft SQL Server editions except the Express Edition\. SQL Server Management Studio is available only as a Windows\-based application\. SQL Server Management Studio Express is available from Microsoft as a [free download](http://www.microsoft.com/en-us/search/Results.aspx?q=sql%20server%20management%20studio)\. - -**To use the SQL Server Generate and Publish Scripts Wizard and the bcp utility to export data** - -1. In SQL Server Management Studio, connect to your RDS for SQL Server DB instance\. For details on how to do this, see [Connecting to a DB instance running the Microsoft SQL Server database engine](USER_ConnectToMicrosoftSQLServerInstance.md)\. - -1. In **Object Explorer**, expand the **Databases** node and select the database you want to script\. - -1. Follow the instructions in [Generate and publish scripts Wizard](http://msdn.microsoft.com/en-us/library/bb895179%28v=sql.110%29.aspx) in the SQL Server documentation to create a script file\. - -1. In SQL Server Management Studio, connect to your target SQL Server DB instance\. - -1. With the target SQL Server DB instance selected in **Object Explorer**, choose **Open** on the **File** menu, choose **File**, and then open the script file\. - -1. If you have scripted the entire database, review the CREATE DATABASE statement in the script\. Make sure that the database is being created in the location and with the parameters that you want\. For more information, see [CREATE DATABASE](http://msdn.microsoft.com/en-us/library/ms176061%28v=sql.110%29.aspx) in the SQL Server documentation\. - -1. If you are creating database users in the script, check to see if server logins exist on the target DB instance for those users\. If not, create logins for those users; the scripted commands to create the database users fail otherwise\. For more information, see [Create a login](http://msdn.microsoft.com/en-us/library/aa337562%28v=sql.110%29.aspx) in the SQL Server documentation\. - -1. Choose **\!Execute** on the SQL Editor menu to run the script file and create the database objects\. When the script finishes, verify that all database objects exist as expected\. - -1. Use the bcp utility to export data from the RDS for SQL Server DB instance into files\. Open a command prompt and type the following command\. - - ``` - bcp database_name.schema_name.table_name out data_file -n -S aws_rds_sql_endpoint -U username -P password - ``` - - The preceding code includes the following options: - + *table\_name* is the name of one of the tables that you've recreated in the target database and now want to populate with data\. - + *data\_file* is the full path and name of the data file to be created\. - + `-n` specifies that the bulk copy uses the native data types of the data to be copied\. - + `-S` specifies the SQL Server DB instance to export from\. - + `-U` specifies the user name to use when connecting to the SQL Server DB instance\. - + `-P` specifies the password for the user specified by `-U`\. - - The following shows an example command\. - - ``` - bcp world.dbo.city out C:\Users\JohnDoe\city.dat -n -S sql-jdoe.1234abcd.us-west-2.rds.amazonaws.com,1433 -U JohnDoe -P ClearTextPassword - ``` - - Repeat this step until you have data files for all of the tables you want to export\. - -1. Prepare your target DB instance for bulk import of data by following the instructions at [Basic guidelines for bulk importing data](http://msdn.microsoft.com/en-us/library/ms189989%28v=sql.110%29.aspx) in the SQL Server documentation\. - -1. Decide on a bulk import method to use after considering performance and other concerns discussed in [About bulk import and bulk export operations](http://msdn.microsoft.com/en-us/library/ms187042%28v=sql.105%29.aspx) in the SQL Server documentation\. - -1. Bulk import the data from the data files that you created using the bcp utility\. To do so, follow the instructions at either [Import and export bulk data by using the bcp utility](http://msdn.microsoft.com/en-us/library/aa337544%28v=sql.110%29.aspx) or [Import bulk data by using BULK INSERT or OPENROWSET\(BULK\.\.\.\)](http://msdn.microsoft.com/en-us/library/ms175915%28v=sql.110%29.aspx) in the SQL Server documentation, depending on what you decided in step 11\. \ No newline at end of file diff --git a/doc_source/SQLServer.Procedural.Importing.md b/doc_source/SQLServer.Procedural.Importing.md deleted file mode 100644 index 6c4764e..0000000 --- a/doc_source/SQLServer.Procedural.Importing.md +++ /dev/null @@ -1,751 +0,0 @@ -# Importing and exporting SQL Server databases using native backup and restore - -Amazon RDS supports native backup and restore for Microsoft SQL Server databases using full backup files \(\.bak files\)\. When you use RDS, you access files stored in Amazon S3 rather than using the local file system on the database server\. - -For example, you can create a full backup from your local server, store it on S3, and then restore it onto an existing Amazon RDS DB instance\. You can also make backups from RDS, store them on S3, and then restore them wherever you want\. - -Native backup and restore is available in all AWS Regions for Single\-AZ and Multi\-AZ DB instances, including Multi\-AZ DB instances with read replicas\. Native backup and restore is available for all editions of Microsoft SQL Server supported on Amazon RDS\. - -The following diagram shows the supported scenarios\. - -![\[Native Backup and Restore Architecture\]](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/images/SQL-bak-file.png) - -Using native \.bak files to back up and restore databases is usually the fastest way to back up and restore databases\. There are many additional advantages to using native backup and restore\. For example, you can do the following: -+ Migrate databases to or from Amazon RDS\. -+ Move databases between RDS for SQL Server DB instances\. -+ Migrate data, schemas, stored procedures, triggers, and other database code inside \.bak files\. -+ Backup and restore single databases, instead of entire DB instances\. -+ Create copies of databases for development, testing, training, and demonstrations\. -+ Store and transfer backup files with Amazon S3, for an added layer of protection for disaster recovery\. -+ Create native backups of databases that have Transparent Data Encryption \(TDE\) turned on, and restore those backups to on\-premises databases\. For more information, see [Support for Transparent Data Encryption in SQL Server](Appendix.SQLServer.Options.TDE.md)\. -+ Restore native backups of on\-premises databases that have TDE turned on to RDS for SQL Server DB instances\. For more information, see [Support for Transparent Data Encryption in SQL Server](Appendix.SQLServer.Options.TDE.md)\. - -**Contents** -+ [Limitations and recommendations](#SQLServer.Procedural.Importing.Native.Limitations) -+ [Setting up for native backup and restore](#SQLServer.Procedural.Importing.Native.Enabling) - + [Manually creating an IAM role for native backup and restore](#SQLServer.Procedural.Importing.Native.Enabling.IAM) -+ [Using native backup and restore](#SQLServer.Procedural.Importing.Native.Using) - + [Backing up a database](#SQLServer.Procedural.Importing.Native.Using.Backup) - + [Usage](#SQLServer.Procedural.Importing.Native.Backup.Syntax) - + [Examples](#SQLServer.Procedural.Importing.Native.Backup.Examples) - + [Restoring a database](#SQLServer.Procedural.Importing.Native.Using.Restore) - + [Usage](#SQLServer.Procedural.Importing.Native.Restore.Syntax) - + [Examples](#SQLServer.Procedural.Importing.Native.Restore.Examples) - + [Restoring a log](#SQLServer.Procedural.Importing.Native.Restore.Log) - + [Usage](#SQLServer.Procedural.Importing.Native.Restore.Log.Syntax) - + [Examples](#SQLServer.Procedural.Importing.Native.Restore.Log.Examples) - + [Finishing a database restore](#SQLServer.Procedural.Importing.Native.Finish.Restore) - + [Usage](#SQLServer.Procedural.Importing.Native.Finish.Restore.Syntax) - + [Working with partially restored databases](#SQLServer.Procedural.Importing.Native.Partially.Restored) - + [Dropping a partially restored database](#SQLServer.Procedural.Importing.Native.Drop.Partially.Restored) - + [Snapshot restore and point\-in\-time recovery behavior for partially restored databases](#SQLServer.Procedural.Importing.Native.Snapshot.Restore) - + [Canceling a task](#SQLServer.Procedural.Importing.Native.Using.Cancel) - + [Usage](#SQLServer.Procedural.Importing.Native.Cancel.Syntax) - + [Tracking the status of tasks](#SQLServer.Procedural.Importing.Native.Tracking) - + [Usage](#SQLServer.Procedural.Importing.Native.Tracking.Syntax) - + [Examples](#SQLServer.Procedural.Importing.Native.Tracking.Examples) - + [Response](#SQLServer.Procedural.Importing.Native.Tracking.Response) -+ [Compressing backup files](#SQLServer.Procedural.Importing.Native.Compression) -+ [Troubleshooting](#SQLServer.Procedural.Importing.Native.Troubleshooting) -+ [Importing and exporting SQL Server data using other methods](SQLServer.Procedural.Importing.Snapshots.md) - + [Importing data into RDS for SQL Server by using a snapshot](SQLServer.Procedural.Importing.Snapshots.md#SQLServer.Procedural.Importing.Procedure) - + [Import the data](SQLServer.Procedural.Importing.Snapshots.md#ImportData.SQLServer.Import) - + [Generate and Publish Scripts Wizard](SQLServer.Procedural.Importing.Snapshots.md#ImportData.SQLServer.MgmtStudio.ScriptWizard) - + [Import and Export Wizard](SQLServer.Procedural.Importing.Snapshots.md#ImportData.SQLServer.MgmtStudio.ImportExportWizard) - + [Bulk copy](SQLServer.Procedural.Importing.Snapshots.md#ImportData.SQLServer.MgmtStudio.BulkCopy) - + [Exporting data from RDS for SQL Server](SQLServer.Procedural.Importing.Snapshots.md#SQLServer.Procedural.Exporting) - + [SQL Server Import and Export Wizard](SQLServer.Procedural.Importing.Snapshots.md#SQLServer.Procedural.Exporting.SSIEW) - + [SQL Server Generate and Publish Scripts Wizard and bcp utility](SQLServer.Procedural.Importing.Snapshots.md#SQLServer.Procedural.Exporting.SSGPSW) - -## Limitations and recommendations - -The following are some limitations to using native backup and restore: -+ You can't back up to, or restore from, an Amazon S3 bucket in a different AWS Region from your Amazon RDS DB instance\. -+ You can't restore a database with the same name as an existing database\. Database names are unique\. -+ We strongly recommend that you don't restore backups from one time zone to a different time zone\. If you restore backups from one time zone to a different time zone, you must audit your queries and applications for the effects of the time zone change\. -+ Amazon S3 has a size limit of 5 TB per file\. For native backups of larger databases, you can use multifile backup\. -+ The maximum database size that can be backed up to S3 depends on the available memory, CPU, I/O, and network resources on the DB instance\. The larger the database, the more memory the backup agent consumes\. Our testing shows that you can make a compressed backup of a 16\-TB database on our newest\-generation instance types from `2xlarge` instance sizes and larger, given sufficient system resources\. -+ You can't back up to or restore from more than 10 backup files at the same time\. -+ A differential backup is based on the last full backup\. For differential backups to work, you can't take a snapshot between the last full backup and the differential backup\. If you want a differential backup, but a manual or automated snapshot exists, then do another full backup before proceeding with the differential backup\. -+ Differential and log restores aren't supported for databases with files that have their file\_guid \(unique identifier\) set to `NULL`\. -+ You can run up to two backup or restore tasks at the same time\. -+ You can't perform native log backups from SQL Server on Amazon RDS\. -+ RDS supports native restores of databases up to 16 TB\. Native restores of databases on SQL Server Express Edition are limited to 10 GB\. -+ You can't do a native backup during the maintenance window, or any time Amazon RDS is in the process of taking a snapshot of the database\. If a native backup task overlaps with the RDS daily backup window, the native backup task is canceled\. -+ On Multi\-AZ DB instances, you can only natively restore databases that are backed up in the full recovery model\. -+ Restoring from differential backups on Multi\-AZ instances isn't supported\. -+ Calling the RDS procedures for native backup and restore within a transaction isn't supported\. -+ Use a symmetric encryption AWS KMS key to encrypt your backups\. Amazon RDS doesn't support asymmetric KMS keys\. For more information, see [Creating symmetric encryption KMS keys](https://docs.aws.amazon.com/kms/latest/developerguide/create-keys.html#create-symmetric-cmk) in the *AWS Key Management Service Developer Guide*\. -+ Native backup files are encrypted with the specified KMS key using the "Encryption\-Only" crypto mode\. When you are restoring encrypted backup files, be aware that they were encrypted with the "Encryption\-Only" crypto mode\. -+ You can't restore a database that contains a FILESTREAM file group\. - -If your database can be offline while the backup file is created, copied, and restored, we recommend that you use native backup and restore to migrate it to RDS\. If your on\-premises database can't be offline, we recommend that you use the AWS Database Migration Service to migrate your database to Amazon RDS\. For more information, see [What is AWS Database Migration Service?](https://docs.aws.amazon.com/dms/latest/userguide/Welcome.html) - -Native backup and restore isn't intended to replace the data recovery capabilities of the cross\-region snapshot copy feature\. We recommend that you use snapshot copy to copy your database snapshot to another AWS Region for cross\-region disaster recovery in Amazon RDS\. For more information, see [Copying a DB snapshot](USER_CopySnapshot.md)\. - -## Setting up for native backup and restore - -To set up for native backup and restore, you need three components: - -1. An Amazon S3 bucket to store your backup files\. - - You must have an S3 bucket to use for your backup files and then upload backups you want to migrate to RDS\. If you already have an Amazon S3 bucket, you can use that\. If you don't, you can [create a bucket](https://docs.aws.amazon.com/AmazonS3/latest/user-guide/CreatingaBucket.html)\. Alternatively, you can choose to have a new bucket created for you when you add the `SQLSERVER_BACKUP_RESTORE` option by using the AWS Management Console\. - - For information on using S3, see the [Amazon Simple Storage Service User Guide](https://docs.aws.amazon.com/AmazonS3/latest/gsg/) - -1. An AWS Identity and Access Management \(IAM\) role to access the bucket\. - - If you already have an IAM role, you can use that\. You can choose to have a new IAM role created for you when you add the `SQLSERVER_BACKUP_RESTORE` option by using the AWS Management Console\. Alternatively, you can create a new one manually\. - - If you want to create a new IAM role manually, take the approach discussed in the next section\. Do the same if you want to attach trust relationships and permissions policies to an existing IAM role\. - -1. The `SQLSERVER_BACKUP_RESTORE` option added to an option group on your DB instance\. - - To enable native backup and restore on your DB instance, you add the `SQLSERVER_BACKUP_RESTORE` option to an option group on your DB instance\. For more information and instructions, see [Support for native backup and restore in SQL Server](Appendix.SQLServer.Options.BackupRestore.md)\. - -### Manually creating an IAM role for native backup and restore - -If you want to manually create a new IAM role to use with native backup and restore, you can do so\. In this case, you create a role to delegate permissions from the Amazon RDS service to your Amazon S3 bucket\. When you create an IAM role, you attach a trust relationship and a permissions policy\. The trust relationship allows RDS to assume this role\. The permissions policy defines the actions this role can perform\. For more information about creating the role, see [Creating a role to delegate permissions to an AWS service](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_create_for-service.html)\. - -For the native backup and restore feature, use trust relationships and permissions policies similar to the examples in this section\. In the following example, we use the service principal name `rds.amazonaws.com` as an alias for all service accounts\. In the other examples, we specify an Amazon Resource Name \(ARN\) to identify another account, user, or role that we're granting access to in the trust policy\. - -We recommend using the [https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies_condition-keys.html#condition-keys-sourcearn](https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies_condition-keys.html#condition-keys-sourcearn) and [https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies_condition-keys.html#condition-keys-sourceaccount](https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies_condition-keys.html#condition-keys-sourceaccount) global condition context keys in resource\-based trust relationships to limit the service's permissions to a specific resource\. This is the most effective way to protect against the [confused deputy problem](https://docs.aws.amazon.com/IAM/latest/UserGuide/confused-deputy.html)\. - -You might use both global condition context keys and have the `aws:SourceArn` value contain the account ID\. In this case, the `aws:SourceAccount` value and the account in the `aws:SourceArn` value must use the same account ID when used in the same statement\. -+ Use `aws:SourceArn` if you want cross\-service access for a single resource\. -+ Use `aws:SourceAccount` if you want to allow any resource in that account to be associated with the cross\-service use\. - -In the trust relationship, make sure to use the `aws:SourceArn` global condition context key with the full ARN of the resources accessing the role\. For native backup and restore, make sure to include both the DB option group and the DB instances, as shown in the following example\. - -**Example trust relationship with global condition context key for native backup and restore** - -``` -{ - "Version": "2012-10-17", - "Statement": [ - { - "Effect": "Allow", - "Principal": { - "Service": "rds.amazonaws.com" - }, - "Action": "sts:AssumeRole", - "Condition": { - "StringEquals": { - "aws:SourceArn": [ - "arn:aws:rds:Region:my_account_ID:db:db_instance_identifier", - "arn:aws:rds:Region:my_account_ID:og:option_group_name" - ] - } - } - } - ] -} -``` - -The following example uses an ARN to specify a resource\. For more information on using ARNs, see [ Amazon resource names \(ARNs\)](https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html)\. - -**Example permissions policy for native backup and restore without encryption support** - -``` - 1. { - 2. "Version": "2012-10-17", - 3. "Statement": - 4. [ - 5. { - 6. "Effect": "Allow", - 7. "Action": - 8. [ - 9. "s3:ListBucket", -10. "s3:GetBucketLocation" -11. ], -12. "Resource": "arn:aws:s3:::bucket_name" -13. }, -14. { -15. "Effect": "Allow", -16. "Action": -17. [ -18. "s3:GetObjectAttributes", -19. "s3:GetObject", -20. "s3:PutObject", -21. "s3:ListMultipartUploadParts", -22. "s3:AbortMultipartUpload" -23. ], -24. "Resource": "arn:aws:s3:::bucket_name/*" -25. } -26. ] -27. } -``` - -**Example permissions policy for native backup and restore with encryption support** -If you want to encrypt your backup files, include an encryption key in your permissions policy\. For more information about encryption keys, see [Getting started](https://docs.aws.amazon.com/kms/latest/developerguide/getting-started.html) in the *AWS Key Management Service Developer Guide*\. -You must use a symmetric encryption KMS key to encrypt your backups\. Amazon RDS doesn't support asymmetric KMS keys\. For more information, see [Creating symmetric encryption KMS keys](https://docs.aws.amazon.com/kms/latest/developerguide/create-keys.html#create-symmetric-cmk) in the *AWS Key Management Service Developer Guide*\. -The IAM role must also be a key user and key administrator for the KMS key, that is, it must be specified in the key policy\. For more information, see [Creating symmetric encryption KMS keys](https://docs.aws.amazon.com/kms/latest/developerguide/create-keys.html#create-symmetric-cmk) in the *AWS Key Management Service Developer Guide*\. - -``` - 1. { - 2. "Version": "2012-10-17", - 3. "Statement": - 4. [ - 5. { - 6. "Effect": "Allow", - 7. "Action": - 8. [ - 9. "kms:DescribeKey", -10. "kms:GenerateDataKey", -11. "kms:Encrypt", -12. "kms:Decrypt" -13. ], -14. "Resource": "arn:aws:kms:region:account-id:key/key-id" -15. }, -16. { -17. "Effect": "Allow", -18. "Action": -19. [ -20. "s3:ListBucket", -21. "s3:GetBucketLocation" -22. ], -23. "Resource": "arn:aws:s3:::bucket_name" -24. }, -25. { -26. "Effect": "Allow", -27. "Action": -28. [ -29. "s3:GetObjectAttributes", -30. "s3:GetObject", -31. "s3:PutObject", -32. "s3:ListMultipartUploadParts", -33. "s3:AbortMultipartUpload" -34. ], -35. "Resource": "arn:aws:s3:::bucket_name/*" -36. } -37. ] -38. } -``` - -## Using native backup and restore - -After you have enabled and configured native backup and restore, you can start using it\. First, you connect to your Microsoft SQL Server database, and then you call an Amazon RDS stored procedure to do the work\. For instructions on connecting to your database, see [Connecting to a DB instance running the Microsoft SQL Server database engine](USER_ConnectToMicrosoftSQLServerInstance.md)\. - -Some of the stored procedures require that you provide an Amazon Resource Name \(ARN\) to your Amazon S3 bucket and file\. The format for your ARN is `arn:aws:s3:::bucket_name/file_name.extension`\. Amazon S3 doesn't require an account number or AWS Region in ARNs\. - -If you also provide an optional KMS key, the format for the ARN of the key is `arn:aws:kms:region:account-id:key/key-id`\. For more information, see [ Amazon resource names \(ARNs\) and AWS service namespaces](https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html)\. You must use a symmetric encryption KMS key to encrypt your backups\. Amazon RDS doesn't support asymmetric KMS keys\. For more information, see [Creating symmetric encryption KMS keys](https://docs.aws.amazon.com/kms/latest/developerguide/create-keys.html#create-symmetric-cmk) in the *AWS Key Management Service Developer Guide*\. - -**Note** -Whether or not you use a KMS key, the native backup and restore tasks enable server\-side Advanced Encryption Standard \(AES\) 256\-bit encryption by default for files uploaded to S3\. - -For instructions on how to call each stored procedure, see the following topics: -+ [Backing up a database](#SQLServer.Procedural.Importing.Native.Using.Backup) -+ [Restoring a database](#SQLServer.Procedural.Importing.Native.Using.Restore) -+ [Restoring a log](#SQLServer.Procedural.Importing.Native.Restore.Log) -+ [Finishing a database restore](#SQLServer.Procedural.Importing.Native.Finish.Restore) -+ [Working with partially restored databases](#SQLServer.Procedural.Importing.Native.Partially.Restored) -+ [Canceling a task](#SQLServer.Procedural.Importing.Native.Using.Cancel) -+ [Tracking the status of tasks](#SQLServer.Procedural.Importing.Native.Tracking) - -### Backing up a database - -To back up your database, use the `rds_backup_database` stored procedure\. - -**Note** -You can't back up a database during the maintenance window, or while Amazon RDS is taking a snapshot\. - -#### Usage - -``` -exec msdb.dbo.rds_backup_database - @source_db_name='database_name', - @s3_arn_to_backup_to='arn:aws:s3:::bucket_name/file_name.extension', - [@kms_master_key_arn='arn:aws:kms:region:account-id:key/key-id'], - [@overwrite_s3_backup_file=0|1], - [@type='DIFFERENTIAL|FULL'], - [@number_of_files=n]; -``` - -The following parameters are required: -+ `@source_db_name` – The name of the database to back up\. -+ `@s3_arn_to_backup_to` – The ARN indicating the Amazon S3 bucket to use for the backup, plus the name of the backup file\. - - The file can have any extension, but `.bak` is usually used\. - -The following parameters are optional: -+ `@kms_master_key_arn` – The ARN for the symmetric encryption KMS key to use to encrypt the item\. - + You can't use the default encryption key\. If you use the default key, the database won't be backed up\. - + If you don't specify a KMS key identifier, the backup file won't be encrypted\. For more information, see [Encrypting Amazon RDS resources](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Overview.Encryption.html)\. - + When you specify a KMS key, client\-side encryption is used\. - + Amazon RDS doesn't support asymmetric KMS keys\. For more information, see [Creating symmetric encryption KMS keys](https://docs.aws.amazon.com/kms/latest/developerguide/create-keys.html#create-symmetric-cmk) in the *AWS Key Management Service Developer Guide*\. -+ `@overwrite_s3_backup_file` – A value that indicates whether to overwrite an existing backup file\. - + `0` – Doesn't overwrite an existing file\. This value is the default\. - - Setting `@overwrite_s3_backup_file` to 0 returns an error if the file already exists\. - + `1` – Overwrites an existing file that has the specified name, even if it isn't a backup file\. -+ `@type` – The type of backup\. - + `DIFFERENTIAL` – Makes a differential backup\. - + `FULL` – Makes a full backup\. This value is the default\. - - A differential backup is based on the last full backup\. For differential backups to work, you can't take a snapshot between the last full backup and the differential backup\. If you want a differential backup, but a snapshot exists, then do another full backup before proceeding with the differential backup\. - - You can look for the last full backup or snapshot using the following example SQL query: - - ``` - select top 1 - database_name - , backup_start_date - , backup_finish_date - from msdb.dbo.backupset - where database_name='mydatabase' - and type = 'D' - order by backup_start_date desc; - ``` -+ `@number_of_files` – The number of files into which the backup will be divided \(chunked\)\. The maximum number is 10\. - + Multifile backup is supported for both full and differential backups\. - + If you enter a value of 1 or omit the parameter, a single backup file is created\. - - Provide the prefix that the files have in common, then suffix that with an asterisk \(`*`\)\. The asterisk can be anywhere in the *file\_name* part of the S3 ARN\. The asterisk is replaced by a series of alphanumeric strings in the generated files, starting with `1-of-number_of_files`\. - - For example, if the file names in the S3 ARN are `backup*.bak` and you set `@number_of_files=4`, the backup files generated are `backup1-of-4.bak`, `backup2-of-4.bak`, `backup3-of-4.bak`, and `backup4-of-4.bak`\. - + If any of the file names already exists, and `@overwrite_s3_backup_file` is 0, an error is returned\. - + Multifile backups can only have one asterisk in the *file\_name* part of the S3 ARN\. - + Single\-file backups can have any number of asterisks in the *file\_name* part of the S3 ARN\. Asterisks aren't removed from the generated file name\. - -#### Examples - -**Example of differential backup** - -``` -exec msdb.dbo.rds_backup_database -@source_db_name='mydatabase', -@s3_arn_to_backup_to='arn:aws:s3:::mybucket/backup1.bak', -@overwrite_s3_backup_file=1, -@type='DIFFERENTIAL'; -``` - -**Example of full backup with encryption** - -``` -exec msdb.dbo.rds_backup_database -@source_db_name='mydatabase', -@s3_arn_to_backup_to='arn:aws:s3:::mybucket/backup1.bak', -@kms_master_key_arn='arn:aws:kms:us-east-1:123456789012:key/AKIAIOSFODNN7EXAMPLE', -@overwrite_s3_backup_file=1, -@type='FULL'; -``` - -**Example of multifile backup** - -``` -exec msdb.dbo.rds_backup_database -@source_db_name='mydatabase', -@s3_arn_to_backup_to='arn:aws:s3:::mybucket/backup*.bak', -@number_of_files=4; -``` - -**Example of multifile differential backup** - -``` -exec msdb.dbo.rds_backup_database -@source_db_name='mydatabase', -@s3_arn_to_backup_to='arn:aws:s3:::mybucket/backup*.bak', -@type='DIFFERENTIAL', -@number_of_files=4; -``` - -**Example of multifile backup with encryption** - -``` -exec msdb.dbo.rds_backup_database -@source_db_name='mydatabase', -@s3_arn_to_backup_to='arn:aws:s3:::mybucket/backup*.bak', -@kms_master_key_arn='arn:aws:kms:us-east-1:123456789012:key/AKIAIOSFODNN7EXAMPLE', -@number_of_files=4; -``` - -**Example of multifile backup with S3 overwrite** - -``` -exec msdb.dbo.rds_backup_database -@source_db_name='mydatabase', -@s3_arn_to_backup_to='arn:aws:s3:::mybucket/backup*.bak', -@overwrite_s3_backup_file=1, -@number_of_files=4; -``` - -**Example of single\-file backup with the @number\_of\_files parameter** -This example generates a backup file named `backup*.bak`\. - -``` -exec msdb.dbo.rds_backup_database -@source_db_name='mydatabase', -@s3_arn_to_backup_to='arn:aws:s3:::mybucket/backup*.bak', -@number_of_files=1; -``` - -### Restoring a database - -To restore your database, call the `rds_restore_database` stored procedure\. Amazon RDS creates an initial snapshot of the database after the restore task is complete and the database is open\. - -#### Usage - -``` -exec msdb.dbo.rds_restore_database - @restore_db_name='database_name', - @s3_arn_to_restore_from='arn:aws:s3:::bucket_name/file_name.extension', - @with_norecovery=0|1, - [@kms_master_key_arn='arn:aws:kms:region:account-id:key/key-id'], - [@type='DIFFERENTIAL|FULL']; -``` - -The following parameters are required: -+ `@restore_db_name` – The name of the database to restore\. Database names are unique\. You can't restore a database with the same name as an existing database\. -+ `@s3_arn_to_restore_from` – The ARN indicating the Amazon S3 prefix and names of the backup files used to restore the database\. - + For a single\-file backup, provide the entire file name\. - + For a multifile backup, provide the prefix that the files have in common, then suffix that with an asterisk \(`*`\)\. - + If `@s3_arn_to_restore_from` is empty, the following error message is returned: S3 ARN prefix cannot be empty\. - -The following parameter is required for differential restores, but optional for full restores: -+ `@with_norecovery` – The recovery clause to use for the restore operation\. - + Set it to `0` to restore with RECOVERY\. In this case, the database is online after the restore\. - + Set it to `1` to restore with NORECOVERY\. In this case, the database remains in the RESTORING state after restore task completion\. With this approach, you can do later differential restores\. - + For DIFFERENTIAL restores, specify `0` or `1`\. - + For `FULL` restores, this value defaults to `0`\. - -The following parameters are optional: -+ `@kms_master_key_arn` – If you encrypted the backup file, the KMS key to use to decrypt the file\. - - When you specify a KMS key, client\-side encryption is used\. -+ `@type` – The type of restore\. Valid types are `DIFFERENTIAL` and `FULL`\. The default value is `FULL`\. - -**Note** -For differential restores, either the database must be in the RESTORING state or a task must already exist that restores with NORECOVERY\. -You can't restore later differential backups while the database is online\. -You can't submit a restore task for a database that already has a pending restore task with RECOVERY\. -Full restores with NORECOVERY and differential restores aren't supported on Multi\-AZ instances\. -Restoring a database on a Multi\-AZ instance with read replicas is similar to restoring a database on a Multi\-AZ instance\. You don't have to take any additional actions to restore a database on a replica\. - -#### Examples - -**Example of single\-file restore** - -``` -exec msdb.dbo.rds_restore_database -@restore_db_name='mydatabase', -@s3_arn_to_restore_from='arn:aws:s3:::mybucket/backup1.bak'; -``` - -**Example of multifile restore** -To avoid errors when restoring multiple files, make sure that all the backup files have the same prefix, and that no other files use that prefix\. - -``` -exec msdb.dbo.rds_restore_database -@restore_db_name='mydatabase', -@s3_arn_to_restore_from='arn:aws:s3:::mybucket/backup*'; -``` - -**Example of full database restore with RECOVERY** -The following three examples perform the same task, full restore with RECOVERY\. - -``` -exec msdb.dbo.rds_restore_database -@restore_db_name='mydatabase', -@s3_arn_to_restore_from='arn:aws:s3:::mybucket/backup1.bak'; -``` - -``` -exec msdb.dbo.rds_restore_database -@restore_db_name='mydatabase', -@s3_arn_to_restore_from='arn:aws:s3:::mybucket/backup1.bak', -[@type='DIFFERENTIAL|FULL']; -``` - -``` -exec msdb.dbo.rds_restore_database -@restore_db_name='mydatabase', -@s3_arn_to_restore_from='arn:aws:s3:::mybucket/backup1.bak', -@type='FULL', -@with_norecovery=0; -``` - -**Example of full database restore with encryption** - -``` -exec msdb.dbo.rds_restore_database -@restore_db_name='mydatabase', -@s3_arn_to_restore_from='arn:aws:s3:::mybucket/backup1.bak', -@kms_master_key_arn='arn:aws:kms:us-east-1:123456789012:key/AKIAIOSFODNN7EXAMPLE'; -``` - -**Example of full database restore with NORECOVERY** - -``` -exec msdb.dbo.rds_restore_database -@restore_db_name='mydatabase', -@s3_arn_to_restore_from='arn:aws:s3:::mybucket/backup1.bak', -@type='FULL', -@with_norecovery=1; -``` - -**Example of differential restore with NORECOVERY** - -``` -exec msdb.dbo.rds_restore_database -@restore_db_name='mydatabase', -@s3_arn_to_restore_from='arn:aws:s3:::mybucket/backup1.bak', -@type='DIFFERENTIAL', -@with_norecovery=1; -``` - -**Example of differential restore with RECOVERY** - -``` -exec msdb.dbo.rds_restore_database -@restore_db_name='mydatabase', -@s3_arn_to_restore_from='arn:aws:s3:::mybucket/backup1.bak', -@type='DIFFERENTIAL', -@with_norecovery=0; -``` - -### Restoring a log - -To restore your log, call the `rds_restore_log` stored procedure\. - -#### Usage - -``` -exec msdb.dbo.rds_restore_log - @restore_db_name='database_name', - @s3_arn_to_restore_from='arn:aws:s3:::bucket_name/log_file_name.extension', - [@kms_master_key_arn='arn:aws:kms:region:account-id:key/key-id'], - [@with_norecovery=0|1], - [@stopat='datetime']; -``` - -The following parameters are required: -+ `@restore_db_name` – The name of the database whose log to restore\. -+ `@s3_arn_to_restore_from` – The ARN indicating the Amazon S3 prefix and name of the log file used to restore the log\. The file can have any extension, but `.trn` is usually used\. - - If `@s3_arn_to_restore_from` is empty, the following error message is returned: S3 ARN prefix cannot be empty\. - -The following parameters are optional: -+ `@kms_master_key_arn` – If you encrypted the log, the KMS key to use to decrypt the log\. -+ `@with_norecovery` – The recovery clause to use for the restore operation\. This value defaults to `1`\. - + Set it to `0` to restore with RECOVERY\. In this case, the database is online after the restore\. You can't restore further log backups while the database is online\. - + Set it to `1` to restore with NORECOVERY\. In this case, the database remains in the RESTORING state after restore task completion\. With this approach, you can do later log restores\. -+ `@stopat` – A value that specifies that the database is restored to its state at the date and time specified \(in datetime format\)\. Only transaction log records written before the specified date and time are applied to the database\. - - If this parameter isn't specified \(it is NULL\), the complete log is restored\. - -**Note** -For log restores, either the database must be in a state of restoring or a task must already exist that restores with NORECOVERY\. -You can't restore log backups while the database is online\. -You can't submit a log restore task on a database that already has a pending restore task with RECOVERY\. -Log restores aren't supported on Multi\-AZ instances\. - -#### Examples - -**Example of log restore** - -``` -exec msdb.dbo.rds_restore_log -@restore_db_name='mydatabase', -@s3_arn_to_restore_from='arn:aws:s3:::mybucket/mylog.trn'; -``` - -**Example of log restore with encryption** - -``` -exec msdb.dbo.rds_restore_log -@restore_db_name='mydatabase', -@s3_arn_to_restore_from='arn:aws:s3:::mybucket/mylog.trn', -@kms_master_key_arn='arn:aws:kms:us-east-1:123456789012:key/AKIAIOSFODNN7EXAMPLE'; -``` - -**Example of log restore with NORECOVERY** -The following two examples perform the same task, log restore with NORECOVERY\. - -``` -exec msdb.dbo.rds_restore_log -@restore_db_name='mydatabase', -@s3_arn_to_restore_from='arn:aws:s3:::mybucket/mylog.trn', -@with_norecovery=1; -``` - -``` -exec msdb.dbo.rds_restore_log -@restore_db_name='mydatabase', -@s3_arn_to_restore_from='arn:aws:s3:::mybucket/mylog.trn'; -``` - -**Example of log restore with RECOVERY** - -``` -exec msdb.dbo.rds_restore_log -@restore_db_name='mydatabase', -@s3_arn_to_restore_from='arn:aws:s3:::mybucket/mylog.trn', -@with_norecovery=0; -``` - -**Example of log restore with STOPAT clause** - -``` -exec msdb.dbo.rds_restore_log -@restore_db_name='mydatabase', -@s3_arn_to_restore_from='arn:aws:s3:::mybucket/mylog.trn', -@with_norecovery=0, -@stopat='2019-12-01 03:57:09'; -``` - -### Finishing a database restore - -If the last restore task on the database was performed using `@with_norecovery=1`, the database is now in the RESTORING state\. Open this database for normal operation by using the `rds_finish_restore` stored procedure\. - -#### Usage - -``` -exec msdb.dbo.rds_finish_restore @db_name='database_name'; -``` - -**Note** -To use this approach, the database must be in the RESTORING state without any pending restore tasks\. -The `rds_finish_restore` procedure isn't supported on Multi\-AZ instances\. -To finish restoring the database, use the master login\. Or use the user login that most recently restored the database or log with NORECOVERY\. - -### Working with partially restored databases - -#### Dropping a partially restored database - -To drop a partially restored database \(left in the RESTORING state\), use the `rds_drop_database` stored procedure\. - -``` -exec msdb.dbo.rds_drop_database @db_name='database_name'; -``` - -**Note** -You can't submit a DROP database request for a database that already has a pending restore or finish restore task\. -To drop the database, use the master login\. Or use the user login that most recently restored the database or log with NORECOVERY\. - -#### Snapshot restore and point\-in\-time recovery behavior for partially restored databases - -Partially restored databases in the source instance \(left in the RESTORING state\) are dropped from the target instance during snapshot restore and point\-in\-time recovery\. - -### Canceling a task - -To cancel a backup or restore task, call the `rds_cancel_task` stored procedure\. - -**Note** -You can't cancel a FINISH\_RESTORE task\. - -#### Usage - -``` -exec msdb.dbo.rds_cancel_task @task_id=ID_number; -``` - -The following parameter is required: -+ `@task_id` – The ID of the task to cancel\. You can get the task ID by calling `rds_task_status`\. - -### Tracking the status of tasks - -To track the status of your backup and restore tasks, call the `rds_task_status` stored procedure\. If you don't provide any parameters, the stored procedure returns the status of all tasks\. The status for tasks is updated approximately every two minutes\. Task history is retained for 36 days\. - -#### Usage - -``` -exec msdb.dbo.rds_task_status - [@db_name='database_name'], - [@task_id=ID_number]; -``` - -The following parameters are optional: -+ `@db_name` – The name of the database to show the task status for\. -+ `@task_id` – The ID of the task to show the task status for\. - -#### Examples - -**Example of listing the status for a specific task** - -``` -exec msdb.dbo.rds_task_status @task_id=5; -``` - -**Example of listing the status for a specific database and task** - -``` -exec msdb.dbo.rds_task_status -@db_name='my_database', -@task_id=5; -``` - -**Example of listing all tasks and their statuses on a specific database** - -``` -exec msdb.dbo.rds_task_status @db_name='my_database'; -``` - -**Example of listing all tasks and their statuses on the current instance** - -``` -exec msdb.dbo.rds_task_status; -``` - -#### Response - -The `rds_task_status` stored procedure returns the following columns\. - - -**** - -| Column | Description | -| --- | --- | -| `task_id` | The ID of the task\. | -| `task_type` | Task type depending on the input parameters, as follows: [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/SQLServer.Procedural.Importing.html) Amazon RDS creates an initial snapshot of the database after it is open on completion of the following restore tasks: [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/SQLServer.Procedural.Importing.html) | -| `database_name` | The name of the database that the task is associated with\. | -| `% complete` | The progress of the task as a percent value\. | -| `duration (mins)` | The amount of time spent on the task, in minutes\. | -| `lifecycle` | The status of the task\. The possible statuses are the following: [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/SQLServer.Procedural.Importing.html) | -| `task_info` | Additional information about the task\. If an error occurs while backing up or restoring a database, this column contains information about the error\. For a list of possible errors, and mitigation strategies, see [Troubleshooting](#SQLServer.Procedural.Importing.Native.Troubleshooting)\. | -| `last_updated` | The date and time that the task status was last updated\. The status is updated after every 5 percent of progress\. | -| `created_at` | The date and time that the task was created\. | -| S3\_object\_arn | The ARN indicating the Amazon S3 prefix and the name of the file that is being backed up or restored\. | -| `overwrite_s3_backup_file` | The value of the `@overwrite_s3_backup_file` parameter specified when calling a backup task\. For more information, see [Backing up a database](#SQLServer.Procedural.Importing.Native.Using.Backup)\. | -| KMS\_master\_key\_arn | The ARN for the KMS key used for encryption \(for backup\) and decryption \(for restore\)\. | -| filepath | Not applicable to native backup and restore tasks\. | -| overwrite\_file | Not applicable to native backup and restore tasks\. | - -## Compressing backup files - -To save space in your Amazon S3 bucket, you can compress your backup files\. For more information about compressing backup files, see [Backup compression](https://msdn.microsoft.com/en-us/library/bb964719.aspx) in the Microsoft documentation\. - -Compressing your backup files is supported for the following database editions: -+ Microsoft SQL Server Enterprise Edition -+ Microsoft SQL Server Standard Edition - -To turn on compression for your backup files, run the following code: - -``` -1. exec rdsadmin..rds_set_configuration 'S3 backup compression', 'true'; -``` - -To turn off compression for your backup files, run the following code: - -``` -1. exec rdsadmin..rds_set_configuration 'S3 backup compression', 'false'; -``` - -## Troubleshooting - -The following are issues you might encounter when you use native backup and restore\. - - -**** - -| Issue | Troubleshooting suggestions | -| --- | --- | -| Database backup/restore option is not enabled yet or is in the process of being enabled\. Please try again later\. | Make sure that you have added the `SQLSERVER_BACKUP_RESTORE` option to the DB option group associated with your DB instance\. For more information, see [Adding the native backup and restore option](Appendix.SQLServer.Options.BackupRestore.md#Appendix.SQLServer.Options.BackupRestore.Add)\. | -| Access Denied | The backup or restore process can't access the backup file\. This is usually caused by issues like the following: [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/SQLServer.Procedural.Importing.html) | -| BACKUP DATABASE WITH COMPRESSION isn't supported on Edition | Compressing your backup files is only supported for Microsoft SQL Server Enterprise Edition and Standard Edition\. For more information, see [Compressing backup files](#SQLServer.Procedural.Importing.Native.Compression)\. | -| Key does not exist | You attempted to restore an encrypted backup, but didn't provide a valid encryption key\. Check your encryption key and retry\. For more information, see [Restoring a database](#SQLServer.Procedural.Importing.Native.Using.Restore)\. | -| Please reissue task with correct type and overwrite property | If you attempt to back up your database and provide the name of a file that already exists, but set the overwrite property to false, the save operation fails\. To fix this error, either provide the name of a file that doesn't already exist, or set the overwrite property to true\. For more information, see [Backing up a database](#SQLServer.Procedural.Importing.Native.Using.Backup)\. It's also possible that you intended to restore your database, but called the `rds_backup_database` stored procedure accidentally\. In that case, call the `rds_restore_database` stored procedure instead\. For more information, see [Restoring a database](#SQLServer.Procedural.Importing.Native.Using.Restore)\. If you intended to restore your database and called the `rds_restore_database` stored procedure, make sure that you provided the name of a valid backup file\. For more information, see [Using native backup and restore](#SQLServer.Procedural.Importing.Native.Using)\. | -| Please specify a bucket that is in the same region as RDS instance | You can't back up to, or restore from, an Amazon S3 bucket in a different AWS Region from your Amazon RDS DB instance\. You can use Amazon S3 replication to copy the backup file to the correct AWS Region\. For more information, see [Cross\-Region replication](https://docs.aws.amazon.com/AmazonS3/latest/dev/crr.html) in the Amazon S3 documentation\. | -| The specified bucket does not exist | Verify that you have provided the correct ARN for your bucket and file, in the correct format\. For more information, see [Using native backup and restore](#SQLServer.Procedural.Importing.Native.Using)\. | -| User is not authorized to perform on resource | You requested an encrypted operation, but didn't provide correct AWS KMS permissions\. Verify that you have the correct permissions, or add them\. For more information, see [Setting up for native backup and restore](#SQLServer.Procedural.Importing.Native.Enabling)\. | -| The Restore task is unable to restore from more than 10 backup file\(s\)\. Please reduce the number of files matched and try again\. | Reduce the number of files that you're trying to restore from\. You can make each individual file larger if necessary\. | -| Database '*database\_name*' already exists\. Two databases that differ only by case or accent are not allowed\. Choose a different database name\. | You can't restore a database with the same name as an existing database\. Database names are unique\. | \ No newline at end of file diff --git a/doc_source/SQLServer.ReadReplicas.md b/doc_source/SQLServer.ReadReplicas.md deleted file mode 100644 index 540936a..0000000 --- a/doc_source/SQLServer.ReadReplicas.md +++ /dev/null @@ -1,157 +0,0 @@ -# Working with read replicas for Microsoft SQL Server in Amazon RDS - -You usually use read replicas to configure replication between Amazon RDS DB instances\. For general information about read replicas, see [Working with DB instance read replicas](USER_ReadRepl.md)\. - -In this section, you can find specific information about working with read replicas on Amazon RDS for SQL Server\. - -**Topics** -+ [Configuring read replicas for SQL Server](#SQLServer.ReadReplicas.Configuration) -+ [Read replica limitations with SQL Server](#SQLServer.ReadReplicas.Limitations) -+ [Option considerations for RDS for SQL Server replicas](#SQLServer.ReadReplicas.limitations.options) -+ [Synchronizing database users and objects with a SQL Server read replica](#SQLServer.ReadReplicas.ObjectSynchronization) -+ [Troubleshooting a SQL Server read replica problem](#SQLServer.ReadReplicas.Troubleshooting) - -## Configuring read replicas for SQL Server - -Before a DB instance can serve as a source instance for replication, you must enable automatic backups on the source DB instance\. To do so, you set the backup retention period to a value other than 0\. The source DB instance must be a Multi\-AZ deployment with Always On Availability Groups \(AGs\)\. Setting this type of deployment also enforces that automatic backups are enabled\. - -Creating a SQL Server read replica doesn't require an outage for the primary DB instance\. Amazon RDS sets the necessary parameters and permissions for the source DB instance and the read replica without any service interruption\. A snapshot is taken of the source DB instance, and this snapshot becomes the read replica\. No outage occurs when you delete a read replica\. - -You can create up to 15 read replicas from one source DB instance\. For replication to operate effectively, we recommend that you configure each read replica with the same amount of compute and storage resources as the source DB instance\. If you scale the source DB instance, also scale the read replicas\. - -The SQL Server DB engine version of the source DB instance and all of its read replicas must be the same\. Amazon RDS upgrades the primary immediately after upgrading the read replicas, regardless of the maintenance window\. For more information about upgrading the DB engine version, see [Upgrading the Microsoft SQL Server DB engine](USER_UpgradeDBInstance.SQLServer.md)\. - -For a read replica to receive and apply changes from the source, it should have sufficient compute and storage resources\. If a read replica reaches compute, network, or storage resource capacity, the read replica stops receiving or applying changes from its source\. You can modify the storage and CPU resources of a read replica independently from its source and other read replicas\. - -## Read replica limitations with SQL Server - -The following limitations apply to SQL Server read replicas on Amazon RDS: -+ Read replicas are only available on the SQL Server Enterprise Edition \(EE\) engine\. -+ Read replicas are available for SQL Server versions 2016–2019\. -+ The source DB instance to be replicated must be a Multi\-AZ deployment with Always On AGs\. -+ You can create up to 15 read replicas from one source DB instance\. -+ Read replicas are only available for DB instances running on DB instance classes with four or more vCPUs\. -+ The following aren't supported on Amazon RDS for SQL Server: - + Backup retention of read replicas - + Point\-in\-time recovery from read replicas - + Manual snapshots of read replicas - + Multi\-AZ read replicas - + Creating read replicas of read replicas - + Synchronization of user logins to read replicas -+ Amazon RDS for SQL Server doesn't intervene to mitigate high replica lag between a source DB instance and its read replicas\. Make sure that the source DB instance and its read replicas are sized properly, in terms of computing power and storage, to suit their operational load\. - -## Option considerations for RDS for SQL Server replicas - -Before you create an RDS for SQL Server replica, consider the following requirements, restrictions, and recommendations: -+ If your SQL Server replica is in the same Region as its source DB instance, make sure that it belongs to the same option group as the source DB instance\. Modifications to the source option group or source option group membership propagate to replicas\. These changes are applied to the replicas immediately after they are applied to the source DB instance, regardless of the replica's maintenance window\. - - For more information about option groups, see [Working with option groups](USER_WorkingWithOptionGroups.md)\. -+ When you create a SQL Server cross\-Region replica, Amazon RDS creates a dedicated option group for it\. - - You can't remove an SQL Server cross\-Region replica from its dedicated option group\. No other DB instances can use the dedicated option group for a SQL Server cross\-Region replica\. - - The following options are replicated options\. To add replicated options to a SQL Server cross\-Region replica, add it to the source DB instance's option group\. The option is also installed on all of the source DB instance's replicas\. - + `TDE` - - The following options are non\-replicated options\. You can add or remove non\-replicated options from a dedicated option group\. - + `MSDTC` - + `SQLSERVER_AUDIT` - + To enable the `SQLSERVER_AUDIT` option on cross\-Region read replica, add the `SQLSERVER_AUDIT` option on the dedicated option group on the cross\-region read replica and the source instance’s option group\. By adding the `SQLSERVER_AUDIT` option on the source instance of SQL Server cross\-Region read replica, you can create Server Level Audit Object and Server Level Audit Specifications on each of the cross\-Region read replicas of the source instance\. To allow the cross\-Region read replicas access to upload the completed audit logs to an Amazon S3 bucket, add the `SQLSERVER_AUDIT` option to the dedicated option group and configure the option settings\. The Amazon S3 bucket that you use as a target for audit files must be in the same Region as the cross\-Region read replica\. You can modify the option setting of the `SQLSERVER_AUDIT` option for each cross region read replica independently so each can access an Amazon S3 bucket in their respective Region\. - - The following options are not supported for cross\-Region read replicas\. - + `SSRS` - + `SSAS` - + `SSIS` - - The following options are partially supported for cross\-Region read replicas\. - + `SQLSERVER_BACKUP_RESTORE` - + The source DB instance of a SQL Server cross\-Region replica can have the `SQLSERVER_BACKUP_RESTORE` option, but you can not perform native restores on the source DB instance until you delete all its cross\-Region replicas\. Any existing native restore tasks will be cancelled during the creation of a cross\-Region replica\. You can't add the `SQLSERVER_BACKUP_RESTORE` option to a dedicated option group\. - - For more information on native backup and restore, see [Importing and exporting SQL Server databases using native backup and restore](SQLServer.Procedural.Importing.md) - - When you promote a SQL Server cross\-Region read replica, the promoted replica behaves the same as other SQL Server DB instances, including the management of its options\. For more information about option groups, see [Working with option groups](USER_WorkingWithOptionGroups.md)\. - -## Synchronizing database users and objects with a SQL Server read replica - -Any logins, custom server roles, SQL agent jobs, or other server\-level objects that exist in the primary DB instance at the time of creating a read replica are expected to be present in the newly created read replica\. However, any server\-level objects that are created in the primary DB instance after the creation of the read replica will not be automatically replicated, and you must create them manually in the read replica\. - -The database users are automatically replicated from the primary DB instance to the read replica\. As the read replica database is in read\-only mode, the security identifier \(SID\) of the database user cannot be updated in the database\. Therefore, when creating SQL logins in the read replica, it's essential to ensure that the SID of that login matches the SID of the corresponding SQL login in the primary DB instance\. If you don't synchronize the SIDs of the SQL logins, they won't be able to access the database in the read replica\. Windows Active Directory \(AD\) Authenticated Logins do not experience this issue because the SQL Server obtains the SID from the Active Directory\. - -**To synchronize a SQL login from the primary DB instance to the read replica** - -1. Connect to the primary DB instance\. - -1. Create a new SQL login in the primary DB instance\. - - ``` - USE [master] - GO - CREATE LOGIN TestLogin1 - WITH PASSWORD = 'REPLACE WITH PASSWORD'; - ``` - -1. Create a new database user for the SQL login in the database\. - - ``` - USE [REPLACE WITH YOUR DB NAME] - GO - CREATE USER TestLogin1 FOR LOGIN TestLogin1; - GO - ``` - -1. Check the SID of the newly created SQL login in primary DB instance\. - - ``` - SELECT name, sid FROM sys.server_principals WHERE name = TestLogin1; - ``` - -1. Connect to the read replica\. Create the new SQL login\. - - ``` - CREATE LOGIN TestLogin1 WITH PASSWORD = 'REPLACE WITH PASSWORD', SID=[REPLACE WITH sid FROM STEP #4]; - ``` - -**Alternately, if you have access to the read replica database, you can fix the orphaned user as follows:** - -1. Connect to the read replica\. - -1. Identify the orphaned users in the database\. - - ``` - USE [REPLACE WITH YOUR DB NAME] - GO - EXEC sp_change_users_login 'Report'; - GO - ``` - -1. Create a new SQL login for the orphaned database user\. - - ``` - CREATE LOGIN TestLogin1 WITH PASSWORD = 'REPLACE WITH PASSWORD', SID=[REPLACE WITH sid FROM STEP #2]; - ``` - - Example: - - ``` - CREATE LOGIN TestLogin1 WITH PASSWORD = 'TestPa$$word#1', SID=[0x1A2B3C4D5E6F7G8H9I0J1K2L3M4N5O6P]; - ``` - -## Troubleshooting a SQL Server read replica problem - -You can monitor replication lag in Amazon CloudWatch by viewing the Amazon RDS `ReplicaLag` metric\. For information about replication lag time, see [Monitoring read replication](USER_ReadRepl.md#USER_ReadRepl.Monitoring)\. - -If replication lag is too long, you can use the following query to get information about the lag\. - -``` -SELECT AR.replica_server_name - , DB_NAME (ARS.database_id) 'database_name' - , AR.availability_mode_desc - , ARS.synchronization_health_desc - , ARS.last_hardened_lsn - , ARS.last_redone_lsn - , ARS.secondary_lag_seconds -FROM sys.dm_hadr_database_replica_states ARS -INNER JOIN sys.availability_replicas AR ON ARS.replica_id = AR.replica_id ---WHERE DB_NAME(ARS.database_id) = 'database_name' -ORDER BY AR.replica_server_name; -``` \ No newline at end of file diff --git a/doc_source/SQLServer.TempDB.md b/doc_source/SQLServer.TempDB.md deleted file mode 100644 index 50e079b..0000000 --- a/doc_source/SQLServer.TempDB.md +++ /dev/null @@ -1,90 +0,0 @@ -# Accessing the tempdb database on Microsoft SQL Server DB instances on Amazon RDS - -You can access the `tempdb` database on your Microsoft SQL Server DB instances on Amazon RDS\. You can run code on `tempdb` by using Transact\-SQL through Microsoft SQL Server Management Studio \(SSMS\), or any other standard SQL client application\. For more information about connecting to your DB instance, see [Connecting to a DB instance running the Microsoft SQL Server database engine](USER_ConnectToMicrosoftSQLServerInstance.md)\. - -The master user for your DB instance is granted `CONTROL` access to `tempdb` so that this user can modify the `tempdb` database options\. The master user isn't the database owner of the `tempdb` database\. If necessary, the master user can grant `CONTROL` access to other users so that they can also modify the `tempdb` database options\. - -**Note** -You can't run Database Console Commands \(DBCC\) on the `tempdb` database\. - -## Modifying tempdb database options - -You can modify the database options on the `tempdb` database on your Amazon RDS DB instances\. For more information about which options can be modified, see [tempdb database](https://msdn.microsoft.com/en-us/library/ms190768%28v=sql.120%29.aspx) in the Microsoft documentation\. - -Database options such as the maximum file size options are persistent after you restart your DB instance\. You can modify the database options to optimize performance when importing data, and to prevent running out of storage\. - -### Optimizing performance when importing data - -To optimize performance when importing large amounts of data into your DB instance, set the `SIZE` and `FILEGROWTH` properties of the tempdb database to large numbers\. For more information about how to optimize `tempdb`, see [Optimizing tempdb performance](https://technet.microsoft.com/en-us/library/ms175527%28v=sql.120%29.aspx) in the Microsoft documentation\. - -The following example demonstrates setting the size to 100 GB and file growth to 10 percent\. - -``` -1. alter database[tempdb] modify file (NAME = N'templog', SIZE=100GB, FILEGROWTH = 10%) -``` - -### Preventing storage problems - -To prevent the `tempdb` database from using all available disk space, set the `MAXSIZE` property\. The following example demonstrates setting the property to 2048 MB\. - -``` -1. alter database [tempdb] modify file (NAME = N'templog', MAXSIZE = 2048MB) -``` - -## Shrinking the tempdb database - -There are two ways to shrink the `tempdb` database on your Amazon RDS DB instance\. You can use the `rds_shrink_tempdbfile` procedure, or you can set the `SIZE` property, - -### Using the rds\_shrink\_tempdbfile procedure - -You can use the Amazon RDS procedure `msdb.dbo.rds_shrink_tempdbfile` to shrink the `tempdb` database\. You can only call `rds_shrink_tempdbfile` if you have `CONTROL` access to `tempdb`\. When you call `rds_shrink_tempdbfile`, there is no downtime for your DB instance\. - -The `rds_shrink_tempdbfile` procedure has the following parameters\. - - -**** - -| Parameter name | Data type | Default | Required | Description | -| --- | --- | --- | --- | --- | -| `@temp_filename` | SYSNAME | — | required | The logical name of the file to shrink\. | -| `@target_size` | int | null | optional | The new size for the file, in megabytes\. | - -The following example gets the names of the files for the `tempdb` database\. - -``` -1. use tempdb; -2. GO -3. -4. select name, * from sys.sysfiles; -5. GO -``` - -The following example shrinks a `tempdb` database file named `test_file`, and requests a new size of `10` megabytes: - -``` -1. exec msdb.dbo.rds_shrink_tempdbfile @temp_filename = N'test_file', @target_size = 10; -``` - -### Setting the SIZE property - -You can also shrink the `tempdb` database by setting the `SIZE` property and then restarting your DB instance\. For more information about restarting your DB instance, see [Rebooting a DB instance](USER_RebootInstance.md)\. - -The following example demonstrates setting the `SIZE` property to 1024 MB\. - -``` -1. alter database [tempdb] modify file (NAME = N'templog', SIZE = 1024MB) -``` - -## Considerations for Multi\-AZ deployments - -If your Amazon RDS DB instance is in a Multi\-AZ Deployment for Microsoft SQL Server with Database Mirroring \(DBM\) or Always On Availability Groups \(AGs\), there are some things to consider\. - -The `tempdb` database can't be replicated\. No data that you store on your primary instance is replicated to your secondary instance\. - -If you modify any database options on the `tempdb` database, you can capture those changes on the secondary by using one of the following methods: -+ First modify your DB instance and turn Multi\-AZ off, then modify tempdb, and finally turn Multi\-AZ back on\. This method doesn't involve any downtime\. - - For more information, see [Modifying an Amazon RDS DB instance](Overview.DBInstance.Modifying.md)\. -+ First modify `tempdb` in the original primary instance, then fail over manually, and finally modify `tempdb` in the new primary instance\. This method involves downtime\. - - For more information, see [Rebooting a DB instance](USER_RebootInstance.md)\. \ No newline at end of file diff --git a/doc_source/TUT_WebAppWithRDS.md b/doc_source/TUT_WebAppWithRDS.md deleted file mode 100644 index 0945295..0000000 --- a/doc_source/TUT_WebAppWithRDS.md +++ /dev/null @@ -1,24 +0,0 @@ -# Tutorial: Create a web server and an Amazon RDS DB instance - -This tutorial shows you how to install an Apache web server with PHP and create a MySQL database\. The web server runs on an Amazon EC2 instance using Amazon Linux 2023, and the MySQL database is a MySQL DB instance\. Both the Amazon EC2 instance and the DB instance run in a virtual private cloud \(VPC\) based on the Amazon VPC service\. - -**Important** -There's no charge for creating an AWS account\. However, by completing this tutorial, you might incur costs for the AWS resources you use\. You can delete these resources after you complete the tutorial if they are no longer needed\. - -**Note** -This tutorial works with Amazon Linux 2023 and might not work for other versions of Linux\. - -In the tutorial that follows, you create an EC2 instance that uses the default VPC, subnets, and security group for your AWS account\. This tutorial shows you how to create the DB instance and automatically set up connectivity with the EC2 instance that you created\. The tutorial then shows you how to install the web server on the EC2 instance\. You connect your web server to your DB instance in the VPC using the DB instance endpoint\. - -1. [Launch an EC2 instance](CHAP_Tutorials.WebServerDB.LaunchEC2.md) - -1. [Create a DB instance](CHAP_Tutorials.WebServerDB.CreateDBInstance.md) - -1. [Install a web server on your EC2 instance](CHAP_Tutorials.WebServerDB.CreateWebServer.md) - -The following diagram shows the configuration when the tutorial is complete\. - -![\[Single VPC Scenario\]](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/images/con-VPC-sec-grp.png) - -**Note** -After you complete the tutorial, there is a public and private subnet in each Availability Zone in your VPC\. This tutorial uses the default VPC for your AWS account and automatically sets up connectivity between your EC2 instance and DB instance\. If you would rather configure a new VPC for this scenario instead, complete the tasks in [Tutorial: Create a VPC for use with a DB instance \(IPv4 only\)](CHAP_Tutorials.WebServerDB.CreateVPC.md)\. \ No newline at end of file diff --git a/doc_source/USER.SQLServer.AddlFeat.TransactionLogAccess.md b/doc_source/USER.SQLServer.AddlFeat.TransactionLogAccess.md deleted file mode 100644 index c681e9b..0000000 --- a/doc_source/USER.SQLServer.AddlFeat.TransactionLogAccess.md +++ /dev/null @@ -1,342 +0,0 @@ -# Access to transaction log backups with RDS for SQL Server - -With access to transaction log backups for RDS for SQL Server, you can list the transaction log backup files for a database and copy them to a target Amazon S3 bucket\. By copying transaction log backups in an Amazon S3 bucket, you can use them in combination with full and differential database backups to perform point in time database restores\. You use RDS stored procedures to set up access to transaction log backups, list available transaction log backups, and copy them to your Amazon S3 bucket\. - -Access to transaction log backups provides the following capabilities and benefits: -+ List and view the metadata of available transaction log backups for a database on an RDS for SQL Server DB instance\. -+ Copy available transaction log backups from RDS for SQL Server to a target Amazon S3 bucket\. -+ Perform point\-in\-time restores of databases without the need to restore an entire DB instance\. For more information on restoring a DB instance to a point in time, see [Restoring a DB instance to a specified time](USER_PIT.md)\. - -## Availability and support - -Access to transaction log backups is supported in all AWS Regions\. Access to transaction log backups is available for all editions and versions of Microsoft SQL Server supported on Amazon RDS\. - -## Requirements - -The following requirements must be met before enabling access to transaction log backups: -+ Automated backups must be enabled on the DB instance and the backup retention must be set to a value of one or more days\. For more information on enabling automated backups and configuring a retention policy, see [Enabling automated backups](USER_WorkingWithAutomatedBackups.md#USER_WorkingWithAutomatedBackups.Enabling)\. -+ An Amazon S3 bucket must exist in the same account and Region as the source DB instance\. Before enabling access to transaction log backups, choose an existing Amazon S3 bucket or [create a new bucket](https://docs.aws.amazon.com/AmazonS3/latest/user-guide/CreatingaBucket.html) to use for your transaction log backup files\. -+ An Amazon S3 bucket permissions policy must be configured as follows to allow Amazon RDS to copy transaction log files into it: - - 1. Set the object account ownership property on the bucket to **Bucket Owner Preferred**\. - - 1. Add the following policy\. There will be no policy by default, so use the bucket Access Control Lists \(ACL\) to edit the bucket policy and add it\. - - - - The following example uses an ARN to specify a resource\. We recommend using the `SourceArn` and `SourceAccount` global condition context keys in resource\-based trust relationships to limit the service's permissions to a specific resource\. For more information on working with ARNs, see [ Amazon resource names \(ARNs\)](https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) and [Working with Amazon Resource Names \(ARNs\) in Amazon RDS](USER_Tagging.ARN.md)\. - - -**Example of an Amazon S3 permissions policy for access to transaction log backups** - - ``` - 1. { - 2. "Version": "2012-10-17", - 3. "Statement": [ - 4. { - 5. "Sid": "Only allow writes to my bucket with bucket owner full control", - 6. "Effect": "Allow", - 7. "Principal": { - 8. "Service": "backups.rds.amazonaws.com" - 9. }, - 10. "Action": "s3:PutObject", - 11. "Resource": "arn:aws:s3:::{customer_bucket}/{customer_path}/*", - 12. "Condition": { - 13. "StringEquals": { - 14. "s3:x-amz-acl": "bucket-owner-full-control", - 15. "aws:sourceAccount": "{customer_account}", - 16. "aws:sourceArn": "{db_instance_arn}" - 17. } - 18. } - 19. } - 20. ] - 21. } - ``` -+ An AWS Identity and Access Management \(IAM\) role to access the Amazon S3 bucket\. If you already have an IAM role, you can use that\. You can choose to have a new IAM role created for you when you add the `SQLSERVER_BACKUP_RESTORE` option by using the AWS Management Console\. Alternatively, you can create a new one manually\. For more information on creating and configuring an IAM role with `SQLSERVER_BACKUP_RESTORE`, see [Manually creating an IAM role for native backup and restore](SQLServer.Procedural.Importing.md#SQLServer.Procedural.Importing.Native.Enabling.IAM)\. -+ The `SQLSERVER_BACKUP_RESTORE` option must be added to an option group on your DB instance\. For more information on adding the `SQLSERVER_BACKUP_RESTORE` option, see [Support for native backup and restore in SQL Server](Appendix.SQLServer.Options.BackupRestore.md)\. -**Note** -If your DB instance has storage encryption enabled , the AWS KMS \(KMS\) actions and key must be provided in the IAM role provided in the native backup and restore option group\. - - Optionally, if you intend to use the `rds_restore_log` stored procedure to perform point in time database restores, we recommend using the same Amazon S3 path for the native backup and restore option group and access to transaction log backups\. This method ensures that when Amazon RDS assumes the role from the option group to perform the restore log functions, it has access to retrieve transaction log backups from the same Amazon S3 path\. -+ If the DB instance is encrypted, regardless of encryption type \(AWS managed key or Customer managed key\), you must provide a Customer managed KMS key in the IAM role and in the `rds_tlog_backup_copy_to_S3` stored procedure\. - -## Limitations and recommendations - -Access to transaction log backups has the following limitations and recommendations: -+ You can list and copy up to the last seven days of transaction log backups for any DB instance that has backup retention configured between one to 35 days\. -+ The Amazon S3 bucket used for access to transaction log backups must exist in the same account and Region as the source DB instance\. Cross\-account and cross\-region copy is not supported\. -+ Only one Amazon S3 bucket can be configured as a target to copy transaction log backups into\. You can choose a new target Amazon S3 bucket with the `rds_tlog_copy_setup` stored procedure\. For more information on choosing a new target Amazon S3 bucket, see [Setting up access to transaction log backups](#USER.SQLServer.AddlFeat.TransactionLogAccess.Enabling)\. -+ You cannot specify the KMS key when using the `rds_tlog_backup_copy_to_S3` stored procedure if your RDS instance is not enabled for storage encryption\. -+ Multi\-account copying is not supported\. The IAM role used for copying will only permit write access to Amazon S3 buckets within the owner account of the DB instance\. -+ Only two concurrent tasks of any type may be run on an RDS for SQL Server DB instance\. -+ Only one copy task can run for a single database at a given time\. If you want to copy transaction log backups for multiple databases on the DB instance, use a separate copy task for each database\. -+ If you copy a transaction log backup that already exists with the same name in the Amazon S3 bucket, the existing transaction log backup will be overwritten\. -+ You can only run the stored procedures that are provided with access to transaction log backups on the primary DB instance\. You can’t run these stored procedures on an RDS for SQL Server read replica or on a secondary instance of a Multi\-AZ DB cluster\. -+ If the RDS for SQL Server DB instance is rebooted while the `rds_tlog_backup_copy_to_S3` stored procedure is running, the task will automatically restart from the beginning when the DB instance is back online\. Any transaction log backups that had been copied to the Amazon S3 bucket while the task was running before the reboot will be overwritten\. -+ The Microsoft SQL Server system databases and the `RDSAdmin` database cannot be configured for access to transaction log backups\. -+ Copying to buckets encrypted by SSE\-KMS isn't supported\. - -## Setting up access to transaction log backups - -To set up access to transaction log backups, complete the list of requirements in the [Requirements](#USER.SQLServer.AddlFeat.TransactionLogAccess.Requirements) section, and then run the `rds_tlog_copy_setup` stored procedure\. The procedure will enable the access to transaction log backups feature at the DB instance level\. You don't need to run it for each individual database on the DB instance\. - -**Important** -The database user must be granted the `db_owner` role within SQL Server on each database to configure and use the access to transaction log backups feature\. - -**Example usage:** - -``` -exec msdb.dbo.rds_tlog_copy_setup -@target_s3_arn='arn:aws:s3:::mybucket/myfolder'; -``` - -The following parameter is required: -+ `@target_s3_arn` – The ARN of the target Amazon S3 bucket to copy transaction log backups files to\. - -**Example of setting an Amazon S3 target bucket:** - -``` -exec msdb.dbo.rds_tlog_copy_setup @target_s3_arn='arn:aws:s3:::accesstlogs-testbucket/mytestdb1'; -``` - -To validate the configuration, call the `rds_show_configuration` stored procedure\. - -**Example of validating the configuration:** - -``` -exec rdsadmin.dbo.rds_show_configuration @name='target_s3_arn_for_tlog_copy'; -``` - -To modify access to transaction log backups to point to a different Amazon S3 bucket, you can view the current Amazon S3 bucket value and re\-run the `rds_tlog_copy_setup` stored procedure using a new value for the `@target_s3_arn`\. - -**Example of viewing the existing Amazon S3 bucket configured for access to transaction log backups** - -``` -exec rdsadmin.dbo.rds_show_configuration @name='target_s3_arn_for_tlog_copy'; -``` - -**Example of updating to a new target Amazon S3 bucket** - -``` -exec msdb.dbo.rds_tlog_copy_setup @target_s3_arn='arn:aws:s3:::mynewbucket/mynewfolder'; -``` - -## Listing available transaction log backups - -With RDS for SQL Server, databases configured to use the full recovery model and a DB instance backup retention set to one or more days have transaction log backups automatically enabled\. By enabling access to transaction log backups, up to seven days of those transaction log backups are made available for you to copy into your Amazon S3 bucket\. - -After you have enabled access to transaction log backups, you can start using it to list and copy available transaction log backup files\. - -**Listing transaction log backups** - -To list all transaction log backups available for an individual database, call the `rds_fn_list_tlog_backup_metadata` function\. You can use an `ORDER BY` or a `WHERE` clause when calling the function\. - -**Example of listing and filtering available transaction log backup files** - -``` -SELECT * from msdb.dbo.rds_fn_list_tlog_backup_metadata('mydatabasename'); -SELECT * from msdb.dbo.rds_fn_list_tlog_backup_metadata('mydatabasename') WHERE rds_backup_seq_id = 3507; -SELECT * from msdb.dbo.rds_fn_list_tlog_backup_metadata('mydatabasename') WHERE backup_file_time_utc > '2022-09-15 20:44:01' ORDER BY backup_file_time_utc DESC; -``` - -![\[Output from rds_fn_list_tlog_backup_metadata\]](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/images/sql_accesstransactionlogs_func.png) - -The `rds_fn_list_tlog_backup_metadata` function returns the following output: - - -**** - -| Column name | Data type | Description | -| --- | --- | --- | -| `db_name` | sysname | The database name provided to list the transaction log backups for\. | -| `db_id` | int | The internal database identifier for the input parameter `db_name`\. | -| `family_guid` | uniqueidentifier | The unique ID of the original database at creation\. This value remains the same when the database is restored, even to a different database name\. | -| `rds_backup_seq_id` | int | The ID that RDS uses internally to maintain a sequence number for each transaction log backup file\. | -| `backup_file_epoch` | bigint | The epoch time that a transaction backup file was generated\. | -| `backup_file_time_utc` | datetime | The UTC time\-converted value for the `backup_file_epoch` value\. | -| `starting_lsn` | numeric\(25,0\) | The log sequence number of the first or oldest log record of a transaction log backup file\. | -| `ending_lsn` | numeric\(25,0\) | The log sequence number of the last or next log record of a transaction log backup file\. | -| `is_log_chain_broken` | bit | A boolean value indicating if the log chain is broken between the current transaction log backup file and the previous transaction log backup file\. | -| `file_size_bytes` | bigint | The size of the transactional backup set in bytes\. | -| `Error` | varchar\(4000\) | Error message if the `rds_fn_list_tlog_backup_metadata` function throws an exception\. NULL if no exceptions\. | - -## Copying transaction log backups - -To copy a set of available transaction log backups for an individual database to your Amazon S3 bucket, call the `rds_tlog_backup_copy_to_S3` stored procedure\. The `rds_tlog_backup_copy_to_S3` stored procedure will initiate a new task to copy transaction log backups\. - -**Note** -The `rds_tlog_backup_copy_to_S3` stored procedure will copy the transaction log backups without validating against `is_log_chain_broken` attribute\. For this reason, you should manually confirm an unbroken log chain before running the `rds_tlog_backup_copy_to_S3` stored procedure\. For further explanation, see [Validating the transaction log backup log chain](#USER.SQLServer.AddlFeat.TransactionLogAccess.Copying.LogChain)\. - -**Example usage of the `rds_tlog_backup_copy_to_S3` stored procedure** - -``` -exec msdb.dbo.rds_tlog_backup_copy_to_S3 - @db_name='mydatabasename', - [@kms_key_arn='arn:aws:kms:region:account-id:key/key-id'], - [@backup_file_start_time='2022-09-01 01:00:15'], - [@backup_file_end_time='2022-09-01 21:30:45'], - [@starting_lsn=149000000112100001], - [@ending_lsn=149000000120400001], - [@rds_backup_starting_seq_id=5], - [@rds_backup_ending_seq_id=10]; -``` - -The following input parameters are available: - - -**** - -| Parameter | Description | -| --- | --- | -| `@db_name` | The name of the database to copy transaction log backups for | -| `@kms_key_arn` | The ARN of the KMS key used to encrypt a storage\-encrypted DB instance\. | -| `@backup_file_start_time` | The UTC timestamp as provided from the `[backup_file_time_utc]` column of the `rds_fn_list_tlog_backup_metadata` function\. | -| `@backup_file_end_time` | The UTC timestamp as provided from the `[backup_file_time_utc]` column of the `rds_fn_list_tlog_backup_metadata` function\. | -| `@starting_lsn` | The log sequence number \(LSN\) as provided from the `[starting_lsn]` column of the `rds_fn_list_tlog_backup_metadata` function | -| `@ending_lsn` | The log sequence number \(LSN\) as provided from the `[ending_lsn]` column of the `rds_fn_list_tlog_backup_metadata` function\. | -| `@rds_backup_starting_seq_id` | The sequence ID as provided from the `[rds_backup_seq_id]` column of the `rds_fn_list_tlog_backup_metadata` function\. | -| `@rds_backup_ending_seq_id` | The sequence ID as provided from the `[rds_backup_seq_id]` column of the `rds_fn_list_tlog_backup_metadata` function\. | - -You can specify a set of either the time, LSN, or sequence ID parameters\. Only one set of parameters are required\. - -You can also specify just a single parameter in any of the sets\. For example, by providing a value for only the `backup_file_end_time` parameter, all available transaction log backup files prior to that time within the seven\-day limit will be copied to your Amazon S3 bucket\. - -Following are the valid input parameter combinations for the `rds_tlog_backup_copy_to_S3` stored procedure\. - - -**** - -| Parameters provided | Expected result | -| --- | --- | -| 
exec msdb.dbo.rds_tlog_backup_copy_to_S3  
	@db_name = 'testdb1',
            @backup_file_start_time='2022-08-23 00:00:00',
            @backup_file_end_time='2022-08-30 00:00:00';
| Copies transaction log backups from the last seven days and exist between the provided range of `backup_file_start_time` and `backup_file_end_time`\. In this example, the stored procedure will copy transaction log backups that were generated between '2022\-08\-23 00:00:00' and '2022\-08\-30 00:00:00'\. | -| 
exec msdb.dbo.rds_tlog_backup_copy_to_S3
           @db_name = 'testdb1',
           @backup_file_start_time='2022-08-23 00:00:00';
| Copies transaction log backups from the last seven days and starting from the provided `backup_file_start_time`\. In this example, the stored procedure will copy transaction log backups from '2022\-08\-23 00:00:00' up to the latest transaction log backup\. | -| 
exec msdb.dbo.rds_tlog_backup_copy_to_S3
          @db_name = 'testdb1',
          @backup_file_end_time='2022-08-30 00:00:00';
| Copies transaction log backups from the last seven days up to the provided `backup_file_end_time`\. In this example, the stored procedure will copy transaction log backups from '2022\-08\-23 00:00:00 up to '2022\-08\-30 00:00:00'\. | -| 
exec msdb.dbo.rds_tlog_backup_copy_to_S3
         @db_name='testdb1',
         @starting_lsn =1490000000040007,
         @ending_lsn =  1490000000050009;
| Copies transaction log backups that are available from the last seven days and are between the provided range of the `starting_lsn` and `ending_lsn`\. In this example, the stored procedure will copy transaction log backups from the last seven days with an LSN range between 1490000000040007 and 1490000000050009\. | -| 
exec msdb.dbo.rds_tlog_backup_copy_to_S3
        @db_name='testdb1',
        @starting_lsn =1490000000040007;
| Copies transaction log backups that are available from the last seven days, beginning from the provided `starting_lsn`\. In this example, the stored procedure will copy transaction log backups from LSN 1490000000040007 up to the latest transaction log backup\. | -| 
exec msdb.dbo.rds_tlog_backup_copy_to_S3
        @db_name='testdb1',
        @ending_lsn  =1490000000050009;
| Copies transaction log backups that are available from the last seven days, up to the provided `ending_lsn`\. In this example, the stored procedure will copy transaction log backups beginning from the last seven days up to lsn 1490000000050009\. | -| 
exec msdb.dbo.rds_tlog_backup_copy_to_S3
       @db_name='testdb1',
       @rds_backup_starting_seq_id= 2000,
       @rds_backup_ending_seq_id= 5000;
| Copies transaction log backups that are available from the last seven days, and exist between the provided range of `rds_backup_starting_seq_id` and `rds_backup_ending_seq_id`\. In this example, the stored procedure will copy transaction log backups beginning from the last seven days and within the provided rds backup sequence id range, starting from seq\_id 2000 up to seq\_id 5000\. | -| 
exec msdb.dbo.rds_tlog_backup_copy_to_S3
       @db_name='testdb1',
       @rds_backup_starting_seq_id= 2000;
| Copies transaction log backups that are available from the last seven days, beginning from the provided `rds_backup_starting_seq_id`\. In this example, the stored procedure will copy transaction log backups beginning from seq\_id 2000, up to the latest transaction log backup\. | -| 
exec msdb.dbo.rds_tlog_backup_copy_to_S3
      @db_name='testdb1',
      @rds_backup_ending_seq_id= 5000;
| Copies transaction log backups that are available from the last seven days, up to the provided `rds_backup_ending_seq_id`\. In this example, the stored procedure will copy transaction log backups beginning from the last seven days, up to seq\_id 5000\. | -| 
exec msdb.dbo.rds_tlog_backup_copy_to_S3
      @db_name='testdb1',
      @rds_backup_starting_seq_id= 2000;
      @rds_backup_ending_seq_id= 2000;
| Copies a single transaction log backup with the provided `rds_backup_starting_seq_id`, if available within the last seven days\. In this example, the stored procedure will copy a single transaction log backup that has a seq\_id of 2000, if it exists within the last seven days\. | - -### Validating the transaction log backup log chain - - Databases configured for access to transaction log backups must have automated backup retention enabled\. Automated backup retention sets the databases on the DB instance to the `FULL` recovery model\. To support point in time restore for a database, avoid changing the database recovery model, which can result in a broken log chain\. We recommend keeping the database set to the `FULL` recovery model\. - -To manually validate the log chain before copying transaction log backups, call the `rds_fn_list_tlog_backup_metadata` function and review the values in the `is_log_chain_broken` column\. A value of "1" indicates the log chain was broken between the current log backup and the previous log backup\. - -The following example shows a broken log chain in the output from the `rds_fn_list_tlog_backup_metadata` stored procedure\. - -![\[Output from rds_fn_list_tlog_backup_metadata showing a broken log chain.\]](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/images/sql_accesstransactionlogs_logchain_error.png) - -In a normal log chain, the log sequence number \(LSN\) value for first\_lsn for given rds\_sequence\_id should match the value of last\_lsn in the preceding rds\_sequence\_id\. In the image, the rds\_sequence\_id of 45 has a first\_lsn value 90987, which does not match the last\_lsn value of 90985 for preceeding rds\_sequence\_id 44\. - -For more information about SQL Server transaction log architecture and log sequence numbers, see [Transaction Log Logical Architecture](https://learn.microsoft.com/en-us/sql/relational-databases/sql-server-transaction-log-architecture-and-management-guide?view=sql-server-ver15#Logical_Arch) in the Microsoft SQL Server documentation\. - -## Amazon S3 bucket folder and file structure - -Transaction log backups have the following standard structure and naming convention within an Amazon S3 bucket: -+ A new folder is created under the `target_s3_arn` path for each database with the naming structure as `{db_id}.{family_guid}`\. -+ Within the folder, transaction log backups have a filename structure as `{db_id}.{family_guid}.{rds_backup_seq_id}.{backup_file_epoch}`\. -+ You can view the details of `family_guid,db_id,rds_backup_seq_id and backup_file_epoch` with the `rds_fn_list_tlog_backup_metadata`function\. - -The following example shows the folder and file structure of a set of transaction log backups within an Amazon S3 bucket\. - -![\[Amazon S3 bucket structure with access to transaction logs\]](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/images/sql_accesstransactionlogs_s3.png) - -## Tracking the status of tasks - - To track the status of your copy tasks, call the `rds_task_status` stored procedure\. If you don't provide any parameters, the stored procedure returns the status of all tasks\. - -**Example usage:** - -``` -exec msdb.dbo.rds_task_status - @db_name='database_name', - @task_id=ID_number; -``` - -The following parameters are optional: -+ `@db_name` – The name of the database to show the task status for\. -+ `@task_id` – The ID of the task to show the task status for\. - -**Example of listing the status for a specific task ID:** - -``` -exec msdb.dbo.rds_task_status @task_id=5; -``` - -**Example of listing the status for a specific database and task:** - -``` -exec msdb.dbo.rds_task_status@db_name='my_database',@task_id=5; -``` - -**Example of listing all tasks and their status for a specific database:** - -``` -exec msdb.dbo.rds_task_status @db_name='my_database'; -``` - -**Example of listing all tasks and their status on the current DB instance:** - -``` -exec msdb.dbo.rds_task_status; -``` - -## Canceling a task - -To cancel a running task, call the `rds_cancel_task` stored procedure\. - -**Example usage:** - -``` -exec msdb.dbo.rds_cancel_task @task_id=ID_number; -``` - -The following parameter is required: -+ `@task_id` – The ID of the task to cancel\. You can view the task ID by calling the `rds_task_status` stored procedure\. - -For more information on viewing and canceling running tasks, see [Importing and exporting SQL Server databases using native backup and restore](SQLServer.Procedural.Importing.md)\. - -## Troubleshooting access to transaction log backups - -The following are issues you might encounter when you use the stored procedures for access to transaction log backups\. - - -**** - -| Stored Procedure | Error Message | Issue | Troubleshooting suggestions | -| --- | --- | --- | --- | -| rds\_tlog\_copy\_setup | Backups are disabled on this DB instance\. Enable DB instance backups with a retention of at least "1" and try again\. | Automated backups are not enabled for the DB instance\. | DB instance backup retention must be enabled with a retention of at least one day\. For more information on enabling automated backups and configuring backup retention, see [Backup retention period](USER_WorkingWithAutomatedBackups.md#USER_WorkingWithAutomatedBackups.BackupRetention)\. | -| rds\_tlog\_copy\_setup | Error running the rds\_tlog\_copy\_setup stored procedure\. Reconnect to the RDS endpoint and try again\. | An internal error occurred\. | Reconnect to the RDS endpoint and run the `rds_tlog_copy_setup` stored procedure again\. | -| rds\_tlog\_copy\_setup | Running the rds\_tlog\_backup\_copy\_setup stored procedure inside a transaction is not supported\. Verify that the session has no open transactions and try again\. | The stored procedure was attempted within a transaction using `BEGIN` and `END`\. | Avoid using `BEGIN` and `END` when running the `rds_tlog_copy_setup` stored procedure\. | -| rds\_tlog\_copy\_setup | The S3 bucket name for the input parameter `@target_s3_arn` should contain at least one character other than a space\. | An incorrect value was provided for the input parameter `@target_s3_arn`\. | Ensure the input parameter `@target_s3_arn` specifies the complete Amazon S3 bucket ARN\. | -| rds\_tlog\_copy\_setup | The `SQLSERVER_BACKUP_RESTORE` option isn't enabled or is in the process of being enabled\. Enable the option or try again later\. | The `SQLSERVER_BACKUP_RESTORE` option is not enabled on the DB instance or was just enabled and pending internal activation\. | Enable the `SQLSERVER_BACKUP_RESTORE` option as specified in the Requirements section\. Wait a few minutes and run the `rds_tlog_copy_setup` stored procedure again\. | -| rds\_tlog\_copy\_setup | The target S3 arn for the input parameter `@target_s3_arn` can't be empty or null\. | An `NULL` value was provided for the input parameter `@target_s3_arn`, or the value wasn't provided\. | Ensure the input parameter `@target_s3_arn` specifies the complete Amazon S3 bucket ARN\. | -| rds\_tlog\_copy\_setup | The target S3 arn for the input parameter `@target_s3_arn` must begin with arn:aws\. | The input parameter `@target_s3_arn` was provide without `arn:aws` on the front\. | Ensure the input parameter `@target_s3_arn` specifies the complete Amazon S3 bucket ARN\. | -| rds\_tlog\_copy\_setup | The target S3 ARN is already set to the provided value\. | The `rds_tlog_copy_setup` stored procedure previously ran and was configured with an Amazon S3 bucket ARN\. | To modify the Amazon S3 bucket value for access to transaction log backups, provide a different `target S3 ARN`\. | -| rds\_tlog\_copy\_setup | Unable to generate credentials for enabling Access to Transaction Log Backups\. Confirm the S3 path ARN provided with `rds_tlog_copy_setup`, and try again later\. | There was an unspecified error while generating credentials to enable access to transaction log backups\. | Review your setup configuration and try again\. | -| rds\_tlog\_copy\_setup | You cannot run the rds\_tlog\_copy\_setup stored procedure while there are pending tasks\. Wait for the pending tasks to complete and try again\. | Only two tasks may run at any time\. There are pending tasks awaiting completion\. | View pending tasks and wait for them to complete\. For more information on monitoring task status, see [Tracking the status of tasks](#USER.SQLServer.AddlFeat.TransactionLogAccess.TrackTaskStatus)\. | -| rds\_tlog\_backup\_copy\_to\_S3 | A T\-log backup file copy task has already been issued for database: %s with task Id: %d, please try again later\. | Only one copy task may run at any time for a given database\. There is a pending copy task awaiting completion\. | View pending tasks and wait for them to complete\. For more information on monitoring task status, see [Tracking the status of tasks](#USER.SQLServer.AddlFeat.TransactionLogAccess.TrackTaskStatus)\. | -| rds\_tlog\_backup\_copy\_to\_S3 | At least one of these three parameter sets must be provided\. SET\-1:\(@backup\_file\_start\_time, @backup\_file\_end\_time\) \| SET\-2:\(@starting\_lsn, @ending\_lsn\) \| SET\-3:\(@rds\_backup\_starting\_seq\_id, @rds\_backup\_ending\_seq\_id\) | None of the three parameter sets were provided, or a provided parameter set is missing a required parameter\. | You can specify either the time, lsn, or sequence ID parameters\. One set from these three sets of parameters are required\. For more information on required parameters, see [Copying transaction log backups](#USER.SQLServer.AddlFeat.TransactionLogAccess.Copying)\. | -| rds\_tlog\_backup\_copy\_to\_S3 | Backups are disabled on your instance\. Please enable backups and try again in some time\. | Automated backups are not enabled for the DB instance\. | For more information on enabling automated backups and configuring backup retention, see [Backup retention period](USER_WorkingWithAutomatedBackups.md#USER_WorkingWithAutomatedBackups.BackupRetention)\. | -| rds\_tlog\_backup\_copy\_to\_S3 | Cannot find the given database %s\. | The value provided for input parameter `@db_name` does not match a database name on the DB instance\. | Use the correct database name\. To list all databases by name, run `SELECT * from sys.databases` | -| rds\_tlog\_backup\_copy\_to\_S3 | Cannot run the rds\_tlog\_backup\_copy\_to\_S3 stored procedure for SQL Server system databases or the rdsadmin database\. | The value provided for input parameter `@db_name` matches a SQL Server system database name or the RDSAdmin database\. | The following databases are not allowed to be used with access to transaction log backups: `master, model, msdb, tempdb, RDSAdmin.` | -| rds\_tlog\_backup\_copy\_to\_S3 | Database name for the input parameter @db\_name can't be empty or null\. | The value provided for input parameter `@db_name` was empty or `NULL`\. | Use the correct database name\. To list all databases by name, run `SELECT * from sys.databases` | -| rds\_tlog\_backup\_copy\_to\_S3 | DB instance backup retention period must be set to at least 1 to run the rds\_tlog\_backup\_copy\_setup stored procedure\. | Automated backups are not enabled for the DB instance\. | For more information on enabling automated backups and configuring backup retention, see [Backup retention period](USER_WorkingWithAutomatedBackups.md#USER_WorkingWithAutomatedBackups.BackupRetention)\. | -| rds\_tlog\_backup\_copy\_to\_S3 | Error running the stored procedure rds\_tlog\_backup\_copy\_to\_S3\. Reconnect to the RDS endpoint and try again\. | An internal error occurred\. | Reconnect to the RDS endpoint and run the `rds_tlog_backup_copy_to_S3` stored procedure again\. | -| rds\_tlog\_backup\_copy\_to\_S3 | Only one of these three parameter sets can be provided\. SET\-1:\(@backup\_file\_start\_time, @backup\_file\_end\_time\) \| SET\-2:\(@starting\_lsn, @ending\_lsn\) \| SET\-3:\(@rds\_backup\_starting\_seq\_id, @rds\_backup\_ending\_seq\_id\) | Multiple parameter sets were provided\. | You can specify either the time, lsn, or sequence ID parameters\. One set from these three sets of parameters are required\. For more information on required parameters, see [Copying transaction log backups](#USER.SQLServer.AddlFeat.TransactionLogAccess.Copying)\. | -| rds\_tlog\_backup\_copy\_to\_S3 | Running the rds\_tlog\_backup\_copy\_to\_S3 stored procedure inside a transaction is not supported\. Verify that the session has no open transactions and try again\. | The stored procedure was attempted within a transaction using `BEGIN` and `END`\. | Avoid using `BEGIN` and `END` when running the `rds_tlog_backup_copy_to_S3` stored procedure\. | -| rds\_tlog\_backup\_copy\_to\_S3 | The provided parameters fall outside of the transaction backup log retention period\. To list of available transaction log backup files, run the rds\_fn\_list\_tlog\_backup\_metadata function\. | There are no available transactional log backups for the provided input parameters that fit in the copy retention window\. | Try again with a valid set of parameters\. For more information on required parameters, see [Copying transaction log backups](#USER.SQLServer.AddlFeat.TransactionLogAccess.Copying)\. | -| rds\_tlog\_backup\_copy\_to\_S3 | There was a permissions error in processing the request\. Ensure the bucket is in the same Account and Region as the DB Instance, and confirm the S3 bucket policy permissions against the template in the public documentation\. | There was an issue detected with the provided S3 bucket or its policy permissions\. | Confirm your setup for access to transaction log backups is correct\. For more information on setup requirements for your S3 bucket, see [Requirements](#USER.SQLServer.AddlFeat.TransactionLogAccess.Requirements)\. | -| rds\_tlog\_backup\_copy\_to\_S3 | Running the `rds_tlog_backup_copy_to_S3` stored procedure on an RDS read replica instance isn't permitted\. | The stored procedure was attempted on a RDS read replica instance\. | Connect to the RDS primary DB instance to run the `rds_tlog_backup_copy_to_S3` stored procedure\. | -| rds\_tlog\_backup\_copy\_to\_S3 | The LSN for the input parameter `@starting_lsn` must be less than `@ending_lsn`\. | The value provided for input parameter `@starting_lsn` was greater than the value provided for input parameter `@ending_lsn`\. | Ensure the value provided for input parameter `@starting_lsn` is less than the value provided for input parameter `@ending_lsn`\. | -| rds\_tlog\_backup\_copy\_to\_S3 | The `rds_tlog_backup_copy_to_S3` stored procedure can only be performed by the members of `db_owner` role in the source database\. | The `db_owner` role has not been granted for the account attempting to run the `rds_tlog_backup_copy_to_S3` stored procedure on the provided `db_name`\. | Ensure the account running the stored procedure is permissioned with the `db_owner` role for the provided `db_name`\. | -| rds\_tlog\_backup\_copy\_to\_S3 | The sequence ID for the input parameter `@rds_backup_starting_seq_id` must be less than or equal to `@rds_backup_ending_seq_id`\. | The value provided for input parameter `@rds_backup_starting_seq_id` was greater than the value provided for input parameter `@rds_backup_ending_seq_id`\. | Ensure the value provided for input parameter `@rds_backup_starting_seq_id` is less than the value provided for input parameter `@rds_backup_ending_seq_id`\. | -| rds\_tlog\_backup\_copy\_to\_S3 | The SQLSERVER\_BACKUP\_RESTORE option isn't enabled or is in the process of being enabled\. Enable the option or try again later\. | The `SQLSERVER_BACKUP_RESTORE` option is not enabled on the DB instance or was just enabled and pending internal activation\. | Enable the `SQLSERVER_BACKUP_RESTORE` option as specified in the Requirements section\. Wait a few minutes and run the `rds_tlog_backup_copy_to_S3` stored procedure again\. | -| rds\_tlog\_backup\_copy\_to\_S3 | The start time for the input parameter `@backup_file_start_time` must be less than `@backup_file_end_time`\. | The value provided for input parameter `@backup_file_start_time` was greater than the value provided for input parameter `@backup_file_end_time`\. | Ensure the value provided for input parameter `@backup_file_start_time` is less than the value provided for input parameter `@backup_file_end_time`\. | -| rds\_tlog\_backup\_copy\_to\_S3 | We were unable to process the request due to a lack of access\. Please check your setup and permissions for the feature\. | There may be an issue with the Amazon S3 bucket permissions, or the Amazon S3 bucket provided is in another account or Region\. | Ensure the Amazon S3 bucket policy permissions are permissioned to allow RDS access\. Ensure the Amazon S3 bucket is in the same account and Region as the DB instance\. | -| rds\_tlog\_backup\_copy\_to\_S3 | You cannot provide a KMS Key ARN as input parameter to the stored procedure for instances that are not storage\-encrypted\. | When storage encryption is not enabled on the DB instance, the input parameter `@kms_key_arn` should not be provided\. | Do not provide an input parameter for `@kms_key_arn`\. | -| rds\_tlog\_backup\_copy\_to\_S3 | You must provide a KMS Key ARN as input parameter to the stored procedure for storage encrypted instances\. | When storage encryption is enabled on the DB instance, the input parameter `@kms_key_arn` must be provided\. | Provide an input parameter for `@kms_key_arn` with a value that matches the ARN of the Amazon S3 bucket to use for transaction log backups\. | -| rds\_tlog\_backup\_copy\_to\_S3 | You must run the `rds_tlog_copy_setup` stored procedure and set the `@target_s3_arn`, before running the `rds_tlog_backup_copy_to_S3` stored procedure\. | The access to transaction log backups setup procedure was not completed before attempting to run the `rds_tlog_backup_copy_to_S3` stored procedure\. | Run the `rds_tlog_copy_setup` stored procedure before running the `rds_tlog_backup_copy_to_S3` stored procedure\. For more information on running the setup procedure for access to transaction log backups, see [Setting up access to transaction log backups](#USER.SQLServer.AddlFeat.TransactionLogAccess.Enabling)\. | \ No newline at end of file diff --git a/doc_source/USER_ConnectToInstance.md b/doc_source/USER_ConnectToInstance.md deleted file mode 100644 index fba8994..0000000 --- a/doc_source/USER_ConnectToInstance.md +++ /dev/null @@ -1,200 +0,0 @@ -# Connecting to a DB instance running the MySQL database engine - - Before you can connect to a DB instance running the MySQL database engine, you must create a DB instance\. For information, see [Creating an Amazon RDS DB instance](USER_CreateDBInstance.md)\. After Amazon RDS provisions your DB instance, you can use any standard MySQL client application or utility to connect to the instance\. In the connection string, you specify the DNS address from the DB instance endpoint as the host parameter, and specify the port number from the DB instance endpoint as the port parameter\. - -To authenticate to your RDS DB instance, you can use one of the authentication methods for MySQL and AWS Identity and Access Management \(IAM\) database authentication: -+ To learn how to authenticate to MySQL using one of the authentication methods for MySQL, see [ Authentication method](https://dev.mysql.com/doc/internals/en/authentication-method.html) in the MySQL documentation\. -+ To learn how to authenticate to MySQL using IAM database authentication, see [IAM database authentication for MariaDB, MySQL, and PostgreSQL](UsingWithRDS.IAMDBAuth.md)\. - -You can connect to a MySQL DB instance by using tools like the MySQL command\-line client\. For more information on using the MySQL command\-line client, see [mysql \- the MySQL command\-line client](https://dev.mysql.com/doc/refman/8.0/en/mysql.html) in the MySQL documentation\. One GUI\-based application you can use to connect is MySQL Workbench\. For more information, see the [Download MySQL Workbench](http://dev.mysql.com/downloads/workbench/) page\. For information about installing MySQL \(including the MySQL command\-line client\), see [Installing and upgrading MySQL](https://dev.mysql.com/doc/refman/8.0/en/installing.html)\. - -Most Linux distributions include the MariaDB client instead of the Oracle MySQL client\. To install the MySQL command\-line client on Amazon Linux 2023, run the following command: - -``` -sudo dnf install mariadb105 -``` - -To install the MySQL command\-line client on Amazon Linux 2, run the following command: - -``` -sudo yum install mariadb -``` - -To install the MySQL command\-line client on most DEB\-based Linux distributions, run the following command: - -``` -apt-get install mariadb-client -``` - -To check the version of your MySQL command\-line client, run the following command: - -``` -mysql --version -``` - -To read the MySQL documentation for your current client version, run the following command: - -``` -man mysql -``` - -To connect to a DB instance from outside of its Amazon VPC, the DB instance must be publicly accessible, access must be granted using the inbound rules of the DB instance's security group, and other requirements must be met\. For more information, see [Can't connect to Amazon RDS DB instance](CHAP_Troubleshooting.md#CHAP_Troubleshooting.Connecting)\. - -You can use Secure Sockets Layer \(SSL\) or Transport Layer Security \(TLS\) encryption on connections to a MySQL DB instance\. For information, see [Using SSL/TLS with a MySQL DB instance](mysql-ssl-connections.md#MySQL.Concepts.SSLSupport)\. If you are using AWS Identity and Access Management \(IAM\) database authentication, make sure to use an SSL/TLS connection\. For information, see [IAM database authentication for MariaDB, MySQL, and PostgreSQL](UsingWithRDS.IAMDBAuth.md)\. - -You can also connect to a DB instance from a web server\. For more information, see [Tutorial: Create a web server and an Amazon RDS DB instance](TUT_WebAppWithRDS.md)\. - -**Note** -For information on connecting to a MariaDB DB instance, see [Connecting to a DB instance running the MariaDB database engine](USER_ConnectToMariaDBInstance.md)\. - -**Topics** -+ [Finding the connection information for a MySQL DB instance](#USER_ConnectToInstance.EndpointAndPort) -+ [Connecting from the MySQL command\-line client \(unencrypted\)](#USER_ConnectToInstance.CLI) -+ [Connecting from MySQL Workbench](#USER_ConnectToInstance.MySQLWorkbench) -+ [Connecting with the Amazon Web Services JDBC Driver for MySQL](#USER_ConnectToInstance.JDBCDriverMySQL) -+ [Troubleshooting connections to your MySQL DB instance](#USER_ConnectToInstance.Troubleshooting) - -## Finding the connection information for a MySQL DB instance - -The connection information for a DB instance includes its endpoint, port, and a valid database user, such as the master user\. For example, suppose that an endpoint value is `mydb.123456789012.us-east-1.rds.amazonaws.com`\. In this case, the port value is `3306`, and the database user is `admin`\. Given this information, you specify the following values in a connection string: -+ For host or host name or DNS name, specify `mydb.123456789012.us-east-1.rds.amazonaws.com`\. -+ For port, specify `3306`\. -+ For user, specify `admin`\. - -To connect to a DB instance, use any client for the MySQL DB engine\. For example, you might use the MySQL command\-line client or MySQL Workbench\. - -To find the connection information for a DB instance, you can use the AWS Management Console, the AWS CLI [describe\-db\-instances](https://docs.aws.amazon.com/cli/latest/reference/rds/describe-db-instances.html) command, or the Amazon RDS API [DescribeDBInstances](https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_DescribeDBInstances.html) operation to list its details\. - -### Console - -**To find the connection information for a DB instance in the AWS Management Console** - -1. Sign in to the AWS Management Console and open the Amazon RDS console at [https://console\.aws\.amazon\.com/rds/](https://console.aws.amazon.com/rds/)\. - -1. In the navigation pane, choose **Databases** to display a list of your DB instances\. - -1. Choose the name of the MySQL DB instance to display its details\. - -1. On the **Connectivity & security** tab, copy the endpoint\. Also, note the port number\. You need both the endpoint and the port number to connect to the DB instance\. -![\[The endpoint and port of a DB instance\]](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/images/endpoint-port.png) - -1. If you need to find the master user name, choose the **Configuration** tab and view the **Master username** value\. - -### AWS CLI - -To find the connection information for a MySQL DB instance by using the AWS CLI, call the [describe\-db\-instances](https://docs.aws.amazon.com/cli/latest/reference/rds/describe-db-instances.html) command\. In the call, query for the DB instance ID, endpoint, port, and master user name\. - -For Linux, macOS, or Unix: - -``` -aws rds describe-db-instances \ - --filters "Name=engine,Values=mysql" \ - --query "*[].[DBInstanceIdentifier,Endpoint.Address,Endpoint.Port,MasterUsername]" -``` - -For Windows: - -``` -aws rds describe-db-instances ^ - --filters "Name=engine,Values=mysql" ^ - --query "*[].[DBInstanceIdentifier,Endpoint.Address,Endpoint.Port,MasterUsername]" -``` - -Your output should be similar to the following\. - -``` -[ - [ - "mydb1", - "mydb1.123456789012.us-east-1.rds.amazonaws.com", - 3306, - "admin" - ], - [ - "mydb2", - "mydb2.123456789012.us-east-1.rds.amazonaws.com", - 3306, - "admin" - ] -] -``` - -### RDS API - -To find the connection information for a DB instance by using the Amazon RDS API, call the [DescribeDBInstances](https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_DescribeDBInstances.html) operation\. In the output, find the values for the endpoint address, endpoint port, and master user name\. - -## Connecting from the MySQL command\-line client \(unencrypted\) - -**Important** -Only use an unencrypted MySQL connection when the client and server are in the same VPC and the network is trusted\. For information about using encrypted connections, see [Connecting from the MySQL command\-line client with SSL/TLS \(encrypted\)](mysql-ssl-connections.md#USER_ConnectToInstanceSSL.CLI)\. - -To connect to a DB instance using the MySQL command\-line client, enter the following command at the command prompt\. For the \-h parameter, substitute the DNS name \(endpoint\) for your DB instance\. For the \-P parameter, substitute the port for your DB instance\. For the \-u parameter, substitute the user name of a valid database user, such as the master user\. Enter the master user password when prompted\. - -``` -mysql -h mysql–instance1.123456789012.us-east-1.rds.amazonaws.com -P 3306 -u mymasteruser -p -``` - -After you enter the password for the user, you should see output similar to the following\. - -``` -Welcome to the MySQL monitor. Commands end with ; or \g. -Your MySQL connection id is 9738 -Server version: 8.0.28 Source distribution - -Type 'help;' or '\h' for help. Type '\c' to clear the buffer. - -mysql> -``` - -## Connecting from MySQL Workbench - -**To connect from MySQL Workbench** - -1. Download and install MySQL Workbench at [Download MySQL Workbench](http://dev.mysql.com/downloads/workbench/)\. - -1. Open MySQL Workbench\. -![\[MySQL Workbench\]](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/images/mysql-workbench-main.png) - -1. From **Database**, choose **Manage Connections**\. - -1. In the **Manage Server Connections** window, choose **New**\. - -1. In the **Connect to Database** window, enter the following information: - + **Stored Connection** – Enter a name for the connection, such as **MyDB**\. - + **Hostname** – Enter the DB instance endpoint\. - + **Port** – Enter the port used by the DB instance\. - + **Username** – Enter the user name of a valid database user, such as the master user\. - + **Password** – Optionally, choose **Store in Vault** and then enter and save the password for the user\. - - The window looks similar to the following: -![\[MySQL Workbench Connection window\]](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/images/mysql-workbench-connect.png) - - You can use the features of MySQL Workbench to customize connections\. For example, you can use the **SSL** tab to configure SSL/TLS connections\. For information about using MySQL Workbench, see the [MySQL Workbench documentation](https://dev.mysql.com/doc/workbench/en/)\. Encrypting client connections to MySQL DB instances with SSL/TLS, see [Encrypting client connections to MySQL DB instances with SSL/TLS](mysql-ssl-connections.md)\. - -1. Optionally, choose **Test Connection** to confirm that the connection to the DB instance is successful\. - -1. Choose **Close**\. - -1. From **Database**, choose **Connect to Database**\. - -1. From **Stored Connection**, choose your connection\. - -1. Choose **OK**\. - -## Connecting with the Amazon Web Services JDBC Driver for MySQL - -The AWS JDBC Driver for MySQL is a client driver designed for RDS for MySQL\. By default, the driver has settings that are optimized for use with RDS for MySQL\. For more information about the driver and complete instructions for using it, see [the AWS JDBC Driver for MySQL GitHub repository](https://awslabs.github.io/aws-mysql-jdbc/)\. - -The driver is drop\-in compatible with the MySQL Connector/J driver\. To install or upgrade your connector, replace the MySQL connector \.jar file \(located in the application CLASSPATH\) with the AWS JDBC Driver for MySQL \.jar file, and update the connection URL prefix from `jdbc:mysql://` to `jdbc:mysql:aws://`\. - -The AWS JDBC Driver for MySQL supports IAM database authentication\. For more information, see [AWS IAM Database Authentication](https://github.com/awslabs/aws-mysql-jdbc#aws-iam-database-authentication) in the AWS JDBC Driver for MySQL GitHub repository\. For more information about IAM database authentication, see [IAM database authentication for MariaDB, MySQL, and PostgreSQL](UsingWithRDS.IAMDBAuth.md)\. - -## Troubleshooting connections to your MySQL DB instance - -Two common causes of connection failures to a new DB instance are: -+ The DB instance was created using a security group that doesn't authorize connections from the device or Amazon EC2 instance where the MySQL application or utility is running\. The DB instance must have a VPC security group that authorizes the connections\. For more information, see [Amazon VPC VPCs and Amazon RDS](USER_VPC.md)\. - - You can add or edit an inbound rule in the security group\. For **Source**, choose **My IP**\. This allows access to the DB instance from the IP address detected in your browser\. -+ The DB instance was created using the default port of 3306, and your company has firewall rules blocking connections to that port from devices in your company network\. To fix this failure, recreate the instance with a different port\. - -For more information on connection issues, see [Can't connect to Amazon RDS DB instance](CHAP_Troubleshooting.md#CHAP_Troubleshooting.Connecting)\. \ No newline at end of file diff --git a/doc_source/USER_ConnectToMariaDBInstance.md b/doc_source/USER_ConnectToMariaDBInstance.md deleted file mode 100644 index a414bb2..0000000 --- a/doc_source/USER_ConnectToMariaDBInstance.md +++ /dev/null @@ -1,148 +0,0 @@ -# Connecting to a DB instance running the MariaDB database engine - -After Amazon RDS provisions your DB instance, you can use any standard MariaDB client application or utility to connect to the instance\. In the connection string, you specify the Domain Name System \(DNS\) address from the DB instance endpoint as the host parameter\. You also specify the port number from the DB instance endpoint as the port parameter\. - -You can connect to an Amazon RDS for MariaDB DB instance by using tools like the MySQL command\-line client\. For more information on using the MySQL command\-line client, see [mysql command\-line client](http://mariadb.com/kb/en/mariadb/mysql-command-line-client/) in the MariaDB documentation\. One GUI\-based application that you can use to connect is Heidi\. For more information, see the [Download HeidiSQL](http://www.heidisql.com/download.php) page\. For information about installing MySQL \(including the MySQL command\-line client\), see [Installing and upgrading MySQL](https://dev.mysql.com/doc/refman/8.0/en/installing.html)\. - -Most Linux distributions include the MariaDB client instead of the Oracle MySQL client\. To install the MySQL command\-line client on Amazon Linux 2023, run the following command: - -``` -sudo dnf install mariadb105 -``` - -To install the MySQL command\-line client on Amazon Linux 2, run the following command: - -``` -sudo yum install mariadb -``` - -To install the MySQL command\-line client on most DEB\-based Linux distributions, run the following command\. - -``` -apt-get install mariadb-client -``` - -To check the version of your MySQL command\-line client, run the following command\. - -``` -mysql --version -``` - -To read the MySQL documentation for your current client version, run the following command\. - -``` -man mysql -``` - -To connect to a DB instance from outside of a virtual private cloud \(VPC\) based on Amazon VPC, the DB instance must be publicly accessible\. Also, access must be granted using the inbound rules of the DB instance's security group, and other requirements must be met\. For more information, see [Can't connect to Amazon RDS DB instance](CHAP_Troubleshooting.md#CHAP_Troubleshooting.Connecting)\. - -You can use SSL encryption on connections to a MariaDB DB instance\. For information, see [Using SSL/TLS with a MariaDB DB instance](mariadb-ssl-connections.md#MariaDB.Concepts.SSLSupport)\. - -**Topics** -+ [Finding the connection information for a MariaDB DB instance](#USER_ConnectToMariaDBInstance.EndpointAndPort) -+ [Connecting from the MySQL command\-line client \(unencrypted\)](#USER_ConnectToMariaDBInstance.CLI) -+ [Troubleshooting connections to your MariaDB DB instance](#USER_ConnectToMariaDBInstance.Troubleshooting) - -## Finding the connection information for a MariaDB DB instance - -The connection information for a DB instance includes its endpoint, port, and a valid database user, such as the master user\. For example, suppose that an endpoint value is `mydb.123456789012.us-east-1.rds.amazonaws.com`\. In this case, the port value is `3306`, and the database user is `admin`\. Given this information, you specify the following values in a connection string: -+ For host or host name or DNS name, specify `mydb.123456789012.us-east-1.rds.amazonaws.com`\. -+ For port, specify `3306`\. -+ For user, specify `admin`\. - -To connect to a DB instance, use any client for the MariaDB DB engine\. For example, you might use the MySQL command\-line client or MySQL Workbench\. - -To find the connection information for a DB instance, you can use the AWS Management Console, the AWS Command Line Interface \(AWS CLI\) [describe\-db\-instances](https://docs.aws.amazon.com/cli/latest/reference/rds/describe-db-instances.html) command, or the Amazon RDS API [DescribeDBInstances](https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_DescribeDBInstances.html) operation to list its details\. - -### Console - -**To find the connection information for a DB instance in the AWS Management Console** - -1. Sign in to the AWS Management Console and open the Amazon RDS console at [https://console\.aws\.amazon\.com/rds/](https://console.aws.amazon.com/rds/)\. - -1. In the navigation pane, choose **Databases** to display a list of your DB instances\. - -1. Choose the name of the MariaDB DB instance to display its details\. - -1. On the **Connectivity & security** tab, copy the endpoint\. Also, note the port number\. You need both the endpoint and the port number to connect to the DB instance\. -![\[The endpoint and port of a DB instance\]](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/images/endpoint-port.png) - -1. If you need to find the master user name, choose the **Configuration** tab and view the **Master username** value\. - -### AWS CLI - -To find the connection information for a MariaDB DB instance by using the AWS CLI, call the [describe\-db\-instances](https://docs.aws.amazon.com/cli/latest/reference/rds/describe-db-instances.html) command\. In the call, query for the DB instance ID, endpoint, port, and master user name\. - -For Linux, macOS, or Unix: - -``` -aws rds describe-db-instances \ - --filters "Name=engine,Values=mariadb" \ - --query "*[].[DBInstanceIdentifier,Endpoint.Address,Endpoint.Port,MasterUsername]" -``` - -For Windows: - -``` -aws rds describe-db-instances ^ - --filters "Name=engine,Values=mariadb" ^ - --query "*[].[DBInstanceIdentifier,Endpoint.Address,Endpoint.Port,MasterUsername]" -``` - -Your output should be similar to the following\. - -``` -[ - [ - "mydb1", - "mydb1.123456789012.us-east-1.rds.amazonaws.com", - 3306, - "admin" - ], - [ - "mydb2", - "mydb2.123456789012.us-east-1.rds.amazonaws.com", - 3306, - "admin" - ] -] -``` - -### RDS API - -To find the connection information for a DB instance by using the Amazon RDS API, call the [DescribeDBInstances](https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_DescribeDBInstances.html) operation\. In the output, find the values for the endpoint address, endpoint port, and master user name\. - -## Connecting from the MySQL command\-line client \(unencrypted\) - -**Important** -Only use an unencrypted MySQL connection when the client and server are in the same VPC and the network is trusted\. For information about using encrypted connections, see [Connecting from the MySQL command\-line client with SSL/TLS \(encrypted\)](mariadb-ssl-connections.md#USER_ConnectToMariaDBInstanceSSL.CLI)\. - -To connect to a DB instance using the MySQL command\-line client, enter the following command at a command prompt on a client computer\. Doing this connects you to a database on a MariaDB DB instance\. Substitute the DNS name \(endpoint\) for your DB instance for *``* and the master user name that you used for *``*\. Provide the master password that you used when prompted for a password\. - -``` -mysql -h -P 3306 -u -p -``` - -After you enter the password for the user, you see output similar to the following\. - -``` -Welcome to the MariaDB monitor. Commands end with ; or \g. -Your MariaDB connection id is 31 -Server version: 10.6.10-MariaDB-log Source distribution - -Copyright (c) 2000, 2018, Oracle, MariaDB Corporation Ab and others. - -Type 'help;' or '\h' for help. Type '\c' to clear the current input statement. - -MariaDB [(none)]> -``` - -## Troubleshooting connections to your MariaDB DB instance - -Two common causes of connection failures to a new DB instance are the following: -+ The DB instance was created using a security group that doesn't authorize connections from the device or Amazon EC2 instance where the MariaDB application or utility is running\. The DB instance must have a VPC security group that authorizes the connections\. For more information, see [Amazon VPC VPCs and Amazon RDS](USER_VPC.md)\. - - You can add or edit an inbound rule in the security group\. For **Source**, choose **My IP**\. This allows access to the DB instance from the IP address detected in your browser\. -+ The DB instance was created using the default port of 3306, and your company has firewall rules blocking connections to that port from devices in your company network\. To fix this failure, recreate the instance with a different port\. - -For more information on connection issues, see [Can't connect to Amazon RDS DB instance](CHAP_Troubleshooting.md#CHAP_Troubleshooting.Connecting)\. \ No newline at end of file diff --git a/doc_source/USER_ConnectToMicrosoftSQLServerInstance.md b/doc_source/USER_ConnectToMicrosoftSQLServerInstance.md deleted file mode 100644 index 9275614..0000000 --- a/doc_source/USER_ConnectToMicrosoftSQLServerInstance.md +++ /dev/null @@ -1,159 +0,0 @@ -# Connecting to a DB instance running the Microsoft SQL Server database engine - -After Amazon RDS provisions your DB instance, you can use any standard SQL client application to connect to the DB instance\. In this topic, you connect to your DB instance by using either Microsoft SQL Server Management Studio \(SSMS\) or SQL Workbench/J\. - -For an example that walks you through the process of creating and connecting to a sample DB instance, see [Creating and connecting to a Microsoft SQL Server DB instance](CHAP_GettingStarted.CreatingConnecting.SQLServer.md)\. - -## Before you connect - -Before you can connect to your DB instance, it has to be available and accessible\. - -1. Make sure that its status is `available`\. You can check this on the details page for your instance in the AWS Management Console or by using the [describe\-db\-instances](https://docs.aws.amazon.com/cli/latest/reference/rds/describe-db-instances.html) AWS CLI command\. -![\[Check that the DB instance is available\]](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/images/sqlserver-available.png) - -1. Make sure that it is publicly accessible\. You can check this when you check the availability\. - -1. Make sure that the inbound rules of your VPC security group allow access to your DB instance\. For more information, see [Can't connect to Amazon RDS DB instance](CHAP_Troubleshooting.md#CHAP_Troubleshooting.Connecting)\. - -## Finding the DB instance endpoint and port number - -You need both the endpoint and the port number to connect to the DB instance\. - -**To find the endpoint and port** - -1. Sign in to the AWS Management Console and open the Amazon RDS console at [https://console\.aws\.amazon\.com/rds/](https://console.aws.amazon.com/rds/)\. - -1. In the upper\-right corner of the Amazon RDS console, choose the AWS Region of your DB instance\. - -1. Find the Domain Name System \(DNS\) name \(endpoint\) and port number for your DB instance: - - 1. Open the RDS console and choose **Databases** to display a list of your DB instances\. - - 1. Choose the SQL Server DB instance name to display its details\. - - 1. On the **Connectivity & security** tab, copy the endpoint\. -![\[Locate DB instance endpoint and port\]](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/images/SQL-Connect-Endpoint.png) - - 1. Note the port number\. - -## Connecting to your DB instance with Microsoft SQL Server Management Studio - -In this procedure, you connect to your sample DB instance by using Microsoft SQL Server Management Studio \(SSMS\)\. To download a standalone version of this utility, see [Download SQL Server Management Studio \(SSMS\)](https://docs.microsoft.com/en-us/sql/ssms/download-sql-server-management-studio-ssms) in the Microsoft documentation\. - -**To connect to a DB instance using SSMS** - -1. Start SQL Server Management Studio\. - - The **Connect to Server** dialog box appears\. -![\[Connect to Server dialog\]](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/images/RDSMSFTSQLConnect01.png) - -1. Provide the information for your DB instance: - - 1. For **Server type**, choose **Database Engine**\. - - 1. For **Server name**, enter the DNS name \(endpoint\) and port number of your DB instance, separated by a comma\. -**Important** -Change the colon between the endpoint and port number to a comma\. - - Your server name should look like the following example\. - - ``` - database-2.cg034itsfake.us-east-1.rds.amazonaws.com,1433 - ``` - - 1. For **Authentication**, choose **SQL Server Authentication**\. - - 1. For **Login**, enter the master user name for your DB instance\. - - 1. For **Password**, enter the password for your DB instance\. - -1. Choose **Connect**\. - - After a few moments, SSMS connects to your DB instance\. - - If you can't connect to your DB instance, see [Security group considerations](#USER_ConnectToMicrosoftSQLServerInstance.Security) and [Troubleshooting connections to your SQL Server DB instance](#USER_ConnectToMicrosoftSQLServerInstance.Troubleshooting)\. - -1. Your SQL Server DB instance comes with SQL Server's standard built\-in system databases \(`master`, `model`, `msdb`, and `tempdb`\)\. To explore the system databases, do the following: - - 1. In SSMS, on the **View** menu, choose **Object Explorer**\. - - 1. Expand your DB instance, expand **Databases**, and then expand **System Databases**\. -![\[Object Explorer displaying the system databases\]](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/images/SQL-SSMS-SystemDBs.png) - -1. Your SQL Server DB instance also comes with a database named `rdsadmin`\. Amazon RDS uses this database to store the objects that it uses to manage your database\. The `rdsadmin` database also includes stored procedures that you can run to perform advanced tasks\. For more information, see [Common DBA tasks for Microsoft SQL Server](Appendix.SQLServer.CommonDBATasks.md)\. - -1. You can now start creating your own databases and running queries against your DB instance and databases as usual\. To run a test query against your DB instance, do the following: - - 1. In SSMS, on the **File** menu point to **New** and then choose **Query with Current Connection**\. - - 1. Enter the following SQL query\. - - ``` - select @@VERSION - ``` - - 1. Run the query\. SSMS returns the SQL Server version of your Amazon RDS DB instance\. -![\[SQL Query Window\]](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/images/SQL-Connect-Query.png) - -## Connecting to your DB instance with SQL Workbench/J - -This example shows how to connect to a DB instance running the Microsoft SQL Server database engine by using the SQL Workbench/J database tool\. To download SQL Workbench/J, see [SQL Workbench/J](http://www.sql-workbench.net/)\. - -SQL Workbench/J uses JDBC to connect to your DB instance\. You also need the JDBC driver for SQL Server\. To download this driver, see [Microsoft JDBC drivers 4\.1 \(preview\) and 4\.0 for SQL Server](http://www.microsoft.com/en-us/download/details.aspx?id=11774)\. - -**To connect to a DB instance using SQL Workbench/J** - -1. Open SQL Workbench/J\. The **Select Connection Profile** dialog box appears, as shown following\. -![\[Select Connection Profile dialog\]](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/images/workbench_profile.png) - -1. In the first box at the top of the dialog box, enter a name for the profile\. - -1. For **Driver**, choose **SQL JDBC 4\.0**\. - -1. For **URL**, enter **jdbc:sqlserver://**, then enter the endpoint of your DB instance\. For example, the URL value might be the following\. - - ``` - jdbc:sqlserver://sqlsvr-pdz.abcd12340.us-west-2.rds.amazonaws.com:1433 - ``` - -1. For **Username**, enter the master user name for the DB instance\. - -1. For **Password**, enter the password for the master user\. - -1. Choose the save icon in the dialog toolbar, as shown following\. -![\[Save the profile\]](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/images/save_example.png) - -1. Choose **OK**\. After a few moments, SQL Workbench/J connects to your DB instance\. If you can't connect to your DB instance, see [Security group considerations](#USER_ConnectToMicrosoftSQLServerInstance.Security) and [Troubleshooting connections to your SQL Server DB instance](#USER_ConnectToMicrosoftSQLServerInstance.Troubleshooting)\. - -1. In the query pane, enter the following SQL query\. - - ``` - select @@VERSION - ``` - -1. Choose the `Execute` icon in the toolbar, as shown following\. -![\[Run the query\]](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/images/execute_example.png) - - The query returns the version information for your DB instance, similar to the following\. - - ``` - Microsoft SQL Server 2017 (RTM-CU22) (KB4577467) - 14.0.3356.20 (X64) - ``` - -## Security group considerations - -To connect to your DB instance, your DB instance must be associated with a security group\. This security group contains the IP addresses and network configuration that you use to access the DB instance\. You might have associated your DB instance with an appropriate security group when you created your DB instance\. If you assigned a default, no\-configured security group when you created your DB instance, your DB instance firewall prevents connections\. - -In some cases, you might need to create a new security group to make access possible\. For instructions on creating a new security group, see [Controlling access with security groups](Overview.RDSSecurityGroups.md)\. For a topic that walks you through the process of setting up rules for your VPC security group, see [Tutorial: Create a VPC for use with a DB instance \(IPv4 only\)](CHAP_Tutorials.WebServerDB.CreateVPC.md)\. - -After you have created the new security group, modify your DB instance to associate it with the security group\. For more information, see [Modifying an Amazon RDS DB instance](Overview.DBInstance.Modifying.md)\. - -You can enhance security by using SSL to encrypt connections to your DB instance\. For more information, see [Using SSL with a Microsoft SQL Server DB instance](SQLServer.Concepts.General.SSL.Using.md)\. - -## Troubleshooting connections to your SQL Server DB instance - -The following table shows error messages that you might encounter when you attempt to connect to your SQL Server DB instance\. For more information on connection issues, see [Can't connect to Amazon RDS DB instance](CHAP_Troubleshooting.md#CHAP_Troubleshooting.Connecting)\. - - -**** -[\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_ConnectToMicrosoftSQLServerInstance.html) \ No newline at end of file diff --git a/doc_source/USER_ConnectToOracleInstance.SQLDeveloper.md b/doc_source/USER_ConnectToOracleInstance.SQLDeveloper.md deleted file mode 100644 index 8377c95..0000000 --- a/doc_source/USER_ConnectToOracleInstance.SQLDeveloper.md +++ /dev/null @@ -1,39 +0,0 @@ -# Connecting to your DB instance using Oracle SQL developer - -In this procedure, you connect to your DB instance by using Oracle SQL Developer\. To download a standalone version of this utility, see the [ Oracle SQL developer downloads page](https://www.oracle.com/tools/downloads/sqldev-downloads.html)\. - -To connect to your DB instance, you need its DNS name and port number\. For information about finding the DNS name and port number for a DB instance, see [Finding the endpoint of your Oracle DB instance](USER_Endpoint.md)\. - -**To connect to a DB instance using SQL developer** - -1. Start Oracle SQL Developer\. - -1. On the **Connections** tab, choose the **add \(\+\)** icon\. -![\[Oracle SQL Developer with add icon highlighted\]](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/images/oracle-sqldev-plus.png) - -1. In the **New/Select Database Connection** dialog box, provide the information for your DB instance: - + For **Connection Name**, enter a name that describes the connection, such as `Oracle-RDS`\. - + For **Username**, enter the name of the database administrator for the DB instance\. - + For **Password**, enter the password for the database administrator\. - + For **Hostname**, enter the DNS name of the DB instance\. - + For **Port**, enter the port number\. - + For **SID**, enter the DB name\. You can find the DB name on the **Configuration** tab of your database details page\. - - The completed dialog box should look similar to the following\. -![\[Creating a new connection in Oracle SQL Developer\]](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/images/oracle-sqldev-newcon.png) - -1. Choose **Connect**\. - -1. You can now start creating your own databases and running queries against your DB instance and databases as usual\. To run a test query against your DB instance, do the following: - - 1. In the **Worksheet** tab for your connection, enter the following SQL query\. - - ``` - SELECT NAME FROM V$DATABASE; - ``` - - 1. Choose the **execute** icon to run the query\. -![\[Running a query in Oracle SQL Developer using the execute icon\]](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/images/oracle-sqldev-run.png) - - SQL Developer returns the database name\. -![\[Query results in Oracle SQL Developer\]](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/images/oracle-sqldev-results.png) \ No newline at end of file diff --git a/doc_source/USER_ConnectToOracleInstance.SQLPlus.md b/doc_source/USER_ConnectToOracleInstance.SQLPlus.md deleted file mode 100644 index 0bc0498..0000000 --- a/doc_source/USER_ConnectToOracleInstance.SQLPlus.md +++ /dev/null @@ -1,31 +0,0 @@ -# Connecting to your DB instance using SQL\*Plus - -You can use a utility like SQL\*Plus to connect to an Amazon RDS DB instance running Oracle\. To download Oracle Instant Client, which includes a standalone version of SQL\*Plus, see [ Oracle Instant Client Downloads](https://www.oracle.com/database/technologies/instant-client/downloads.html)\. - -To connect to your DB instance, you need its DNS name and port number\. For information about finding the DNS name and port number for a DB instance, see [Finding the endpoint of your Oracle DB instance](USER_Endpoint.md)\. - -**Example To connect to an Oracle DB instance using SQL\*Plus** -In the following examples, substitute the user name of your DB instance administrator\. Also, substitute the DNS name for your DB instance, and then include the port number and the Oracle SID\. The SID value is the name of the DB instance's database that you specified when you created the DB instance, and not the name of the DB instance\. -For Linux, macOS, or Unix: - -``` -1. sqlplus 'user_name@(DESCRIPTION=(ADDRESS=(PROTOCOL=TCP)(HOST=dns_name)(PORT=port))(CONNECT_DATA=(SID=database_name)))' -``` -For Windows: - -``` -1. sqlplus user_name@(DESCRIPTION=(ADDRESS=(PROTOCOL=TCP)(HOST=dns_name)(PORT=port))(CONNECT_DATA=(SID=database_name))) -``` -You should see output similar to the following\. - -``` -SQL*Plus: Release 12.1.0.2.0 Production on Mon Aug 21 09:42:20 2017 -``` -After you enter the password for the user, the SQL prompt appears\. - -``` -SQL> -``` - -**Note** -The shorter format connection string \(EZ Connect\), such as `sqlplus USER/PASSWORD@longer-than-63-chars-rds-endpoint-here:1521/database-identifier`, might encounter a maximum character limit, so you we recommend that you don't use it to connect\. \ No newline at end of file diff --git a/doc_source/USER_ConnectToOracleInstance.Security.md b/doc_source/USER_ConnectToOracleInstance.Security.md deleted file mode 100644 index ca6ceb1..0000000 --- a/doc_source/USER_ConnectToOracleInstance.Security.md +++ /dev/null @@ -1,7 +0,0 @@ -# Considerations for security groups - -For you to connect to your DB instance, it must be associated with a security group that contains the necessary IP addresses and network configuration\. Your DB instance might use the default security group\. If you assigned a default, nonconfigured security group when you created the DB instance, the firewall prevents connections\. For information about creating a new security group, see [Controlling access with security groups](Overview.RDSSecurityGroups.md)\. - -After you create the new security group, you modify your DB instance to associate it with the security group\. For more information, see [Modifying an Amazon RDS DB instance](Overview.DBInstance.Modifying.md)\. - -You can enhance security by using SSL to encrypt connections to your DB instance\. For more information, see [Oracle Secure Sockets Layer](Appendix.Oracle.Options.SSL.md)\. \ No newline at end of file diff --git a/doc_source/USER_ConnectToOracleInstance.SharedServer.md b/doc_source/USER_ConnectToOracleInstance.SharedServer.md deleted file mode 100644 index 6e7ff0d..0000000 --- a/doc_source/USER_ConnectToOracleInstance.SharedServer.md +++ /dev/null @@ -1,7 +0,0 @@ -# Considerations for process architecture - -Server processes handle user connections to an Oracle DB instance\. By default, the Oracle DB instance uses dedicated server processes\. With dedicated server processes, each server process services only one user process\. You can optionally configure shared server processes\. With shared server processes, each server process can service multiple user processes\. - -You might consider using shared server processes when a high number of user sessions are using too much memory on the server\. You might also consider shared server processes when sessions connect and disconnect very often, resulting in performance issues\. There are also disadvantages to using shared server processes\. For example, they can strain CPU resources, and they are more complicated to configure and administer\. - -For more information about dedicated and shared server processes, see [About dedicated and shared server processes](https://docs.oracle.com/database/121/ADMIN/manproc.htm#ADMIN11166) in the Oracle documentation\. For more information about configuring shared server processes on an RDS for Oracle DB instance, see [How do I configure Amazon RDS for Oracle database to work with shared servers?](http://aws.amazon.com/premiumsupport/knowledge-center/oracle-db-shared/) in the Knowledge Center\. \ No newline at end of file diff --git a/doc_source/USER_ConnectToOracleInstance.Troubleshooting.md b/doc_source/USER_ConnectToOracleInstance.Troubleshooting.md deleted file mode 100644 index 1291e93..0000000 --- a/doc_source/USER_ConnectToOracleInstance.Troubleshooting.md +++ /dev/null @@ -1,17 +0,0 @@ -# Troubleshooting connections to your Oracle DB instance - -The following are issues you might encounter when you try to connect to your Oracle DB instance\. - - -**** - -| Issue | Troubleshooting suggestions | -| --- | --- | -| Unable to connect to your DB instance\. | For a newly created DB instance, the DB instance has a status of **creating** until it is ready to use\. When the state changes to **available**, you can connect to the DB instance\. Depending on the DB instance class and the amount of storage, it can take up to 20 minutes before the new DB instance is available\. | -| Unable to connect to your DB instance\. | If you can't send or receive communications over the port that you specified when you created the DB instance, you can't connect to the DB instance\. Check with your network administrator to verify that the port you specified for your DB instance allows inbound and outbound communication\. | -| Unable to connect to your DB instance\. | The access rules enforced by your local firewall and the IP addresses you authorized to access your DB instance in the security group for the DB instance might not match\. The problem is most likely the inbound or outbound rules on your firewall\. You can add or edit an inbound rule in the security group\. For **Source**, choose **My IP**\. This allows access to the DB instance from the IP address detected in your browser\. For more information, see [Amazon VPC VPCs and Amazon RDS](USER_VPC.md)\. For more information about security groups, see [Controlling access with security groups](Overview.RDSSecurityGroups.md)\. To walk through the process of setting up rules for your security group, see [Tutorial: Create a VPC for use with a DB instance \(IPv4 only\)](CHAP_Tutorials.WebServerDB.CreateVPC.md)\. | -| **Connect failed because target host or object does not exist – Oracle, Error: ORA\-12545 ** | Make sure that you specified the server name and port number correctly\. For **Server name**, enter the DNS name from the console\. For information about finding the DNS name and port number for a DB instance, see [Finding the endpoint of your Oracle DB instance](USER_Endpoint.md)\. | -| **Invalid username/password; logon denied – Oracle, Error: ORA\-01017** | You were able to reach the DB instance, but the connection was refused\. This is usually caused by providing an incorrect user name or password\. Verify the user name and password, and then retry\. | -| **TNS:listener does not currently know of SID given in connect descriptor \- Oracle, ERROR: ORA\-12505** | Ensure the correct SID is entered\. The SID is the same as your DB name\. Find the DB name in the **Configuration** tab of the **Databases** page for your instance\. You can also find the DB name using the AWS CLI: 
aws rds describe-db-instances --query 'DBInstances[*].[DBInstanceIdentifier,DBName]' --output text
| - -For more information on connection issues, see [Can't connect to Amazon RDS DB instance](CHAP_Troubleshooting.md#CHAP_Troubleshooting.Connecting)\. \ No newline at end of file diff --git a/doc_source/USER_ConnectToOracleInstance.md b/doc_source/USER_ConnectToOracleInstance.md deleted file mode 100644 index df43d10..0000000 --- a/doc_source/USER_ConnectToOracleInstance.md +++ /dev/null @@ -1,14 +0,0 @@ -# Connecting to your RDS for Oracle DB instance - -After Amazon RDS provisions your Oracle DB instance, you can use any standard SQL client application to connect to the DB instance\. In this topic, you connect to a DB instance that is running the Oracle database engine by using Oracle SQL Developer or SQL\*Plus\. - -For an example that walks you through the process of creating and connecting to a sample DB instance, see [Creating and connecting to an Oracle DB instance](CHAP_GettingStarted.CreatingConnecting.Oracle.md)\. - -**Topics** -+ [Finding the endpoint of your Oracle DB instance](USER_Endpoint.md) -+ [Connecting to your DB instance using Oracle SQL developer](USER_ConnectToOracleInstance.SQLDeveloper.md) -+ [Connecting to your DB instance using SQL\*Plus](USER_ConnectToOracleInstance.SQLPlus.md) -+ [Considerations for security groups](USER_ConnectToOracleInstance.Security.md) -+ [Considerations for process architecture](USER_ConnectToOracleInstance.SharedServer.md) -+ [Troubleshooting connections to your Oracle DB instance](USER_ConnectToOracleInstance.Troubleshooting.md) -+ [Modifying connection properties using sqlnet\.ora parameters](USER_ModifyInstance.Oracle.sqlnet.md) \ No newline at end of file diff --git a/doc_source/USER_ConnectToPostgreSQLInstance.md b/doc_source/USER_ConnectToPostgreSQLInstance.md deleted file mode 100644 index 15c2e68..0000000 --- a/doc_source/USER_ConnectToPostgreSQLInstance.md +++ /dev/null @@ -1,168 +0,0 @@ -# Connecting to a DB instance running the PostgreSQL database engine - -After Amazon RDS provisions your DB instance, you can use any standard SQL client application to connect to the instance\. Before you can connect, the DB instance must be available and accessible\. Whether you can connect to the instance from outside the VPC depends on how you created the Amazon RDS DB instance: -+ If you created your DB instance as *public*, devices and Amazon EC2 instances outside the VPC can connect to your database\. -+ If you created your DB instance as *private*, only Amazon EC2 instances and devices inside the Amazon VPC can connect to your database\. - -To connect to your DB instance from an EC2 instance, you can install a PostgreSQL client on the EC2 instance\. To install the psql client on Amazon Linux 2023, run the following command: - -``` -sudo dnf install postgresql15 -``` - -To install the psql client on Amazon Linux 2, run the following command: - -``` -sudo amazon-linux-extras install postgresql14 -``` - -To check whether your DB instance is public or private, use the AWS Management Console to view the **Connectivity & security** tab for your instance\. Under **Security**, you can find the "Publicly accessible" value, with No for private, Yes for public\. - -To learn more about different Amazon RDS and Amazon VPC configurations and how they affect accessibility, see [Scenarios for accessing a DB instance in a VPC](USER_VPC.Scenarios.md)\. - -If the DB instance is available and accessible, you can connect by providing the following information to the SQL client application: -+ The DB instance endpoint, which serves as the host name \(DNS name\) for the instance\. -+ The port on which the DB instance is listening\. For PostgreSQL, the default port is 5432\. -+ The user name and password for the DB instance\. The default 'master username' for PostgreSQL is `postgres`\. -+ The name and password of the database \(DB name\)\. - - You can obtain these details by using the AWS Management Console, the AWS CLI [describe\-db\-instances](https://docs.aws.amazon.com/cli/latest/reference/rds/describe-db-instances.html) command, or the Amazon RDS API [DescribeDBInstances](https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_DescribeDBInstances.html) operation\. - -**To find the endpoint, port number, and DB name using the AWS Management Console** - -1. Sign in to the AWS Management Console and open the Amazon RDS console at [https://console\.aws\.amazon\.com/rds/](https://console.aws.amazon.com/rds/)\. - -1. Open the RDS console and then choose **Databases** to display a list of your DB instances\. - -1. Choose the PostgreSQL DB instance name to display its details\. - -1. On the **Connectivity & security** tab, copy the endpoint\. Also, note the port number\. You need both the endpoint and the port number to connect to the DB instance\. -![\[Obtain the endpoint from the RDS Console\]](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/images/PostgreSQL-endpoint.png) - -1. On the **Configuration** tab, note the DB name\. If you created a database when you created the RDS for PostgreSQL instance, you see the name listed under DB name\. If you didn't create a database, the DB name displays a dash \(‐\)\. -![\[Obtain the DB name from the RDS Console\]](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/images/PostgreSQL-db-name.png) - -Following are two ways to connect to a PostgreSQL DB instance\. The first example uses pgAdmin, a popular open\-source administration and development tool for PostgreSQL\. The second example uses psql, a command line utility that is part of a PostgreSQL installation\. - -**Topics** -+ [Using pgAdmin to connect to a RDS for PostgreSQL DB instance](#USER_ConnectToPostgreSQLInstance.pgAdmin) -+ [Using psql to connect to your RDS for PostgreSQL DB instance](#USER_ConnectToPostgreSQLInstance.psql) -+ [Connecting with the AWS JDBC Driver for PostgreSQL](#USER_ConnectToPostgreSQLInstance.JDBCDriverPostgreSQL) -+ [Troubleshooting connections to your RDS for PostgreSQL instance](#USER_ConnectToPostgreSQLInstance.Troubleshooting) - -## Using pgAdmin to connect to a RDS for PostgreSQL DB instance - -You can use the open\-source tool pgAdmin to connect to your RDS for PostgreSQL DB instance\. You can download and install pgAdmin from [http://www\.pgadmin\.org/](http://www.pgadmin.org/) without having a local instance of PostgreSQL on your client computer\. - -**To connect to your RDS for PostgreSQL DB instance using pgAdmin** - -1. Launch the pgAdmin application on your client computer\. - -1. On the **Dashboard** tab, choose **Add New Server**\. - -1. In the **Create \- Server** dialog box, type a name on the **General** tab to identify the server in pgAdmin\. - -1. On the **Connection** tab, type the following information from your DB instance: - + For **Host**, type the endpoint, for example `mypostgresql.c6c8dntfzzhgv0.us-east-2.rds.amazonaws.com`\. - + For **Port**, type the assigned port\. - + For **Username**, type the user name that you entered when you created the DB instance \(if you changed the 'master username' from the default, `postgres`\)\. - + For **Password**, type the password that you entered when you created the DB instance\. -![\[Image NOT FOUND\]](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/images/Postgres-Connect01.png) - -1. Choose **Save**\. - - If you have any problems connecting, see [Troubleshooting connections to your RDS for PostgreSQL instance](#USER_ConnectToPostgreSQLInstance.Troubleshooting)\. - -1. To access a database in the pgAdmin browser, expand **Servers**, the DB instance, and **Databases**\. Choose the DB instance's database name\. -![\[Image NOT FOUND\]](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/images/Postgres-Connect02.png) - -1. To open a panel where you can enter SQL commands, choose **Tools**, **Query Tool**\. - -## Using psql to connect to your RDS for PostgreSQL DB instance - -You can use a local instance of the psql command line utility to connect to a RDS for PostgreSQL DB instance\. You need either PostgreSQL or the psql client installed on your client computer\. - -You can download the PostgreSQL client from the [PostgreSQL](https://www.postgresql.org/download/) website\. Follow the instructions specific to your operating system version to install psql\. - -To connect to your RDS for PostgreSQL DB instance using psql, you need to provide host \(DNS\) information, access credentials, and the name of the database\. - -Use one of the following formats to connect to your RDS for PostgreSQL DB instance\. When you connect, you're prompted for a password\. For batch jobs or scripts, use the `--no-password` option\. This option is set for the entire session\. - -**Note** -A connection attempt with `--no-password` fails when the server requires password authentication and a password is not available from other sources\. For more information, see the [psql documentation](https://www.postgresql.org/docs/13/app-psql.html)\. - -If this is the first time you are connecting to this DB instance, or if you didn't yet create a database for this RDS for PostgreSQL instance, you can connect to the **postgres** database using the 'master username' and password\. - -For Unix, use the following format\. - -``` -psql \ - --host= \ - --port= \ - --username= \ - --password \ - --dbname= -``` - -For Windows, use the following format\. - -``` -psql ^ - --host= ^ - --port= ^ - --username= ^ - --password ^ - --dbname= -``` - -For example, the following command connects to a database called `mypgdb` on a PostgreSQL DB instance called `mypostgresql` using fictitious credentials\. - -``` -psql --host=mypostgresql.c6c8mwvfdgv0.us-west-2.rds.amazonaws.com --port=5432 --username=awsuser --password --dbname=mypgdb -``` - -## Connecting with the AWS JDBC Driver for PostgreSQL - -The AWS JDBC Driver for PostgreSQL is a client wrapper designed for use with RDS for PostgreSQL\. The AWS JDBC Driver for PostgreSQL extends the functionality of the community pgJDBC driver by enabling AWS features such as authentication\. For more information about the AWS JDBC Driver for PostgreSQL and complete instructions for using it, see the [AWS JDBC Driver for PostgreSQL GitHub repository](https://github.com/awslabs/aws-advanced-jdbc-wrapper)\. - -The AWS JDBC Driver for PostgreSQL supports AWS Identity and Access Management \(IAM\) database authentication and AWS Secrets Manager\. For more information on using these authentication mechanisms with the driver, see [AWS IAM Authentication Plugin](https://github.com/awslabs/aws-advanced-jdbc-wrapper/blob/main/docs/using-the-jdbc-driver/using-plugins/UsingTheIamAuthenticationPlugin.md) and [AWS Secrets Manager Plugin](https://github.com/awslabs/aws-advanced-jdbc-wrapper/blob/main/docs/using-the-jdbc-driver/using-plugins/UsingTheAwsSecretsManagerPlugin.md) in the AWS JDBC Driver for PostgreSQL GitHub repository\. - -For more information about IAM database authentication, see [IAM database authentication for MariaDB, MySQL, and PostgreSQL](UsingWithRDS.IAMDBAuth.md)\. For more information about Secrets Manager, see the [AWS Secrets Manager User Guide](https://docs.aws.amazon.com/secretsmanager/latest/userguide/intro.html)\. - -## Troubleshooting connections to your RDS for PostgreSQL instance - -**Topics** -+ [Error – FATAL: database *name* does not exist](#USER_ConnectToPostgreSQLInstance.Troubleshooting-DBname) -+ [Error – Could not connect to server: Connection timed out](#USER_ConnectToPostgreSQLInstance.Troubleshooting-timeout) -+ [Errors with security group access rules](#USER_ConnectToPostgreSQLInstance.Troubleshooting-AccessRules) - -### Error – FATAL: database *name* does not exist - -If when trying to connect you receive an error like `FATAL: database name does not exist`, try using the default database name **postgres** for the `--dbname` option\. - -### Error – Could not connect to server: Connection timed out - -If you can't connect to the DB instance, the most common error is `Could not connect to server: Connection timed out.` If you receive this error, check the following: -+ Check that the host name used is the DB instance endpoint and that the port number used is correct\. -+ Make sure that the DB instance's public accessibility is set to **Yes** to allow external connections\. To modify the **Public access** setting, see [Modifying an Amazon RDS DB instance](Overview.DBInstance.Modifying.md)\. -+ Make sure that the user connecting to the database has CONNECT access to it\. You can use the following query to provide connect access to the database\. - - ``` - GRANT CONNECT ON DATABASE database name TO username; - ``` -+ Check that the security group assigned to the DB instance has rules to allow access through any firewall your connection might go through\. For example, if the DB instance was created using the default port of 5432, your company might have firewall rules blocking connections to that port from external company devices\. - - To fix this, modify the DB instance to use a different port\. Also, make sure that the security group applied to the DB instance allows connections to the new port\. To modify the **Database port** setting, see [Modifying an Amazon RDS DB instance](Overview.DBInstance.Modifying.md)\. -+ See also [ Errors with security group access rules](#USER_ConnectToPostgreSQLInstance.Troubleshooting-AccessRules)\. - -### Errors with security group access rules - -By far the most common connection problem is with the security group's access rules assigned to the DB instance\. If you used the default security group when you created the DB instance, the security group likely didn't have access rules that allow you to access the instance\. - -For the connection to work, the security group you assigned to the DB instance at its creation must allow access to the DB instance\. For example, if the DB instance was created in a VPC, it must have a VPC security group that authorizes connections\. Check if the DB instance was created using a security group that doesn't authorize connections from the device or Amazon EC2 instance where the application is running\. - -You can add or edit an inbound rule in the security group\. For **Source**, choosing **My IP** allows access to the DB instance from the IP address detected in your browser\. For more information, see [Provide access to your DB instance in your VPC by creating a security group](CHAP_SettingUp.md#CHAP_SettingUp.SecurityGroup)\. - -Alternatively, if the DB instance was created outside of a VPC, it must have a database security group that authorizes those connections\. - -For more information about Amazon RDS security groups, see [Controlling access with security groups](Overview.RDSSecurityGroups.md)\. \ No newline at end of file diff --git a/doc_source/USER_CopySnapshot.md b/doc_source/USER_CopySnapshot.md deleted file mode 100644 index c662adf..0000000 --- a/doc_source/USER_CopySnapshot.md +++ /dev/null @@ -1,506 +0,0 @@ -# Copying a DB snapshot - -With Amazon RDS, you can copy automated backups or manual DB snapshots\. After you copy a snapshot, the copy is a manual snapshot\. You can make multiple copies of an automated backup or manual snapshot, but each copy must have a unique identifier\. - -You can copy a snapshot within the same AWS Region, you can copy a snapshot across AWS Regions, and you can copy shared snapshots\. - -## Limitations - -The following are some limitations when you copy snapshots: -+ You can't copy a snapshot to or from the China \(Beijing\) Region or the China \(Ningxia\) Region\. -+ You can copy a snapshot between AWS GovCloud \(US\-East\) and AWS GovCloud \(US\-West\)\. However, you can't copy a snapshot between these GovCloud \(US\) Regions and Regions that aren't GovCloud \(US\) Regions\. -+ If you delete a source snapshot before the target snapshot becomes available, the snapshot copy might fail\. Verify that the target snapshot has a status of `AVAILABLE` before you delete a source snapshot\. -+ You can have up to 20 snapshot copy requests in progress to a single destination Region per account\. -+ When you request multiple snapshot copies for the same source DB instance, they're queued internally\. The copies requested later won't start until the previous snapshot copies are completed\. For more information, see [ Why is my EC2 AMI or EBS snapshot creation slow?](https://aws.amazon.com/premiumsupport/knowledge-center/ebs-snapshot-ec2-ami-creation-slow/) in the AWS Knowledge Center\. -+ Depending on the AWS Regions involved and the amount of data to be copied, a cross\-Region snapshot copy can take hours to complete\. In some cases, there might be a large number of cross\-Region snapshot copy requests from a given source Region\. In such cases, Amazon RDS might put new cross\-Region copy requests from that source Region into a queue until some in\-progress copies complete\. No progress information is displayed about copy requests while they are in the queue\. Progress information is displayed when the copy starts\. - -## Snapshot retention - -Amazon RDS deletes automated backups in several situations: -+ At the end of their retention period\. -+ When you disable automated backups for a DB instance\. -+ When you delete a DB instance\. - -If you want to keep an automated backup for a longer period, copy it to create a manual snapshot, which is retained until you delete it\. Amazon RDS storage costs might apply to manual snapshots if they exceed your default storage space\. - -For more information about backup storage costs, see [Amazon RDS pricing](https://aws.amazon.com/rds/pricing/)\. - -## Copying shared snapshots - -You can copy snapshots shared to you by other AWS accounts\. In some cases, you might copy an encrypted snapshot that has been shared from another AWS account\. In these cases, you must have access to the AWS KMS key that was used to encrypt the snapshot\. - -You can copy a shared DB snapshot across AWS Regions if the snapshot is unencrypted\. However, if the shared DB snapshot is encrypted, you can only copy it in the same Region\. - -**Note** -Copying shared incremental snapshots in the same AWS Region is supported when they're unencrypted, or encrypted using the same KMS key as the initial full snapshot\. If you use a different KMS key to encrypt subsequent snapshots when copying them, those shared snapshots are full snapshots\. For more information, see [Incremental snapshot copying](#USER_CopySnapshot.Incremental)\. - -## Handling encryption - -You can copy a snapshot that has been encrypted using a KMS key\. If you copy an encrypted snapshot, the copy of the snapshot must also be encrypted\. If you copy an encrypted snapshot within the same AWS Region, you can encrypt the copy with the same KMS key as the original snapshot\. Or you can specify a different KMS key\. - -If you copy an encrypted snapshot across Regions, you must specify a KMS key valid in the destination AWS Region\. It can be a Region\-specific KMS key, or a multi\-Region key\. For more information on multi\-Region KMS keys, see [Using multi\-Region keys in AWS KMS](https://docs.aws.amazon.com/kms/latest/developerguide/multi-region-keys-overview.html)\. - -The source snapshot remains encrypted throughout the copy process\. For more information, see [Limitations of Amazon RDS encrypted DB instances](Overview.Encryption.md#Overview.Encryption.Limitations)\. - -You can also encrypt a copy of an unencrypted snapshot\. This way, you can quickly add encryption to a previously unencrypted DB instance\. To do this, you create a snapshot of your DB instance when you are ready to encrypt it\. You then create a copy of that snapshot and specify a KMS key to encrypt that snapshot copy\. You can then restore an encrypted DB instance from the encrypted snapshot\. - -## Incremental snapshot copying - -An *incremental* snapshot contains only the data that has changed after the most recent snapshot of the same DB instance\. Incremental snapshot copying is faster and results in lower storage costs than full snapshot copying\. - -**Note** -When you copy a source snapshot that is a snapshot copy itself, the new copy isn't incremental\. This is because the source snapshot copy doesn't include the required metadata for incremental copies\. - -Whether a snapshot copy is incremental is determined by the most recently completed snapshot copy\. If the most recent snapshot copy was deleted, the next copy is a full copy, not an incremental copy\. - -If a copy is still pending when you start another copy, the second copy doesn't start until the first copy finishes\. - -When you copy a snapshot across AWS accounts, the copy is an incremental copy if the following conditions are met: -+ A different snapshot of the same source DB instance was previously copied to the destination account\. -+ The most recent snapshot copy still exists in the destination account\. -+ All copies of the snapshot in the destination account are either unencrypted, or were encrypted using the same KMS key\. - -The following examples illustrate the difference between full and incremental snapshots\. They apply to both shared and unshared snapshots\. - - -| Snapshot | Encryption key | Full or incremental | -| --- | --- | --- | -| S1 | K1 | Full | -| S2 | K1 | Incremental of S1 | -| S3 | K1 | Incremental of S2 | -| S4 | K1 | Incremental of S3 | -| Copy of S1 \(S1C\) | K2 | Full | -| Copy of S2 \(S2C\) | K3 | Full | -| Copy of S3 \(S3C\) | K3 | Incremental of S2C | -| Copy of S4 \(S4C\) | K3 | Incremental of S3C | -| Copy 2 of S4 \(S4C2\) | K4 | Full | - -**Note** -In these examples, snapshots S2, S3, and S4 are incremental only if the previous snapshot still exists\. -The same applies to copies\. Snapshot copies S3C and S4C are incremental only if the previous copy still exists\. - -For information on copying incremental snapshots across AWS Regions, see [Full and incremental copies](#USER_CopySnapshot.AcrossRegions.Full)\. - -## Cross\-Region snapshot copying - -You can copy DB snapshots across AWS Regions\. However, there are certain constraints and considerations for cross\-Region snapshot copying\. - -### Requesting a cross\-Region DB snapshot copy - -To communicate with the source Region to request a cross\-Region DB snapshot copy, the requester \(IAM role or IAM user\) must have access to the source DB snapshot and the source Region\. - -Certain conditions in the requester's IAM policy can cause the request to fail\. The following examples assume that you're copying the DB snapshot from US East \(Ohio\) to US East \(N\. Virginia\)\. These examples show conditions in the requester's IAM policy that cause the request to fail: -+ The requester's policy has a condition for `aws:RequestedRegion`\. - - ``` - ... - "Effect": "Allow", - "Action": "rds:CopyDBSnapshot", - "Resource": "*", - "Condition": { - "StringEquals": { - "aws:RequestedRegion": "us-east-1" - } - } - ``` - - The request fails because the policy doesn't allow access to the source Region\. For a successful request, specify both the source and destination Regions\. - - ``` - ... - "Effect": "Allow", - "Action": "rds:CopyDBSnapshot", - "Resource": "*", - "Condition": { - "StringEquals": { - "aws:RequestedRegion": [ - "us-east-1", - "us-east-2" - ] - } - } - ``` -+ The requester's policy doesn't allow access to the source DB snapshot\. - - ``` - ... - "Effect": "Allow", - "Action": "rds:CopyDBSnapshot", - "Resource": "arn:aws:rds:us-east-1:123456789012:snapshot:target-snapshot" - ... - ``` - - For a successful request, specify both the source and target snapshots\. - - ``` - ... - "Effect": "Allow", - "Action": "rds:CopyDBSnapshot", - "Resource": [ - "arn:aws:rds:us-east-1:123456789012:snapshot:target-snapshot", - "arn:aws:rds:us-east-2:123456789012:snapshot:source-snapshot" - ] - ... - ``` -+ The requester's policy denies `aws:ViaAWSService`\. - - ``` - ... - "Effect": "Allow", - "Action": "rds:CopyDBSnapshot", - "Resource": "*", - "Condition": { - "Bool": {"aws:ViaAWSService": "false"} - } - ``` - - Communication with the source Region is made by RDS on the requester's behalf\. For a successful request, don't deny calls made by AWS services\. -+ The requester's policy has a condition for `aws:SourceVpc` or `aws:SourceVpce`\. - - These requests might fail because when RDS makes the call to the remote Region, it isn't from the specified VPC or VPC endpoint\. - -If you need to use one of the previous conditions that would cause a request to fail, you can include a second statement with `aws:CalledVia` in your policy to make the request succeed\. For example, you can use `aws:CalledVia` with `aws:SourceVpce` as shown here: - -``` -... -"Effect": "Allow", -"Action": "rds:CopyDBSnapshot", -"Resource": "*", -"Condition": { - "Condition" : { - "ForAnyValue:StringEquals" : { - "aws:SourceVpce": "vpce-1a2b3c4d" - } - } -}, -{ - "Effect": "Allow", - "Action": [ - "rds:CopyDBSnapshot" - ], - "Resource": "*", - "Condition": { - "ForAnyValue:StringEquals": { - "aws:CalledVia": [ - "rds.amazonaws.com" - ] - } - } -} -``` - -For more information, see [Policies and permissions in IAM](https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies.html) in the *IAM User Guide*\. - -### Authorizing the snapshot copy - -After a cross\-Region DB snapshot copy request returns `success`, RDS starts the copy in the background\. An authorization for RDS to access the source snapshot is created\. This authorization links the source DB snapshot to the target DB snapshot, and allows RDS to copy only to the specified target snapshot\. - - The authorization is verified by RDS using the `rds:CrossRegionCommunication` permission in the service\-linked IAM role\. If the copy is authorized, RDS communicates with the source Region and completes the copy\. - - RDS doesn't have access to DB snapshots that weren't authorized previously by a `CopyDBSnapshot` request\. The authorization is revoked when copying completes\. - - RDS uses the service\-linked role to verify the authorization in the source Region\. If you delete the service\-linked role during the copy process, the copy fails\. - -For more information, see [Using service\-linked roles](https://docs.aws.amazon.com/IAM/latest/UserGuide/using-service-linked-roles.html) in the *IAM User Guide*\. - -### Using AWS Security Token Service credentials - -Session tokens from the global AWS Security Token Service \(AWS STS\) endpoint are valid only in AWS Regions that are enabled by default \(commercial Regions\)\. If you use credentials from the `assumeRole` API operation in AWS STS, use the regional endpoint if the source Region is an opt\-in Region\. Otherwise, the request fails\. This happens because your credentials must be valid in both Regions, which is true for opt\-in Regions only when the regional AWS STS endpoint is used\. - -To use the global endpoint, make sure that it's enabled for both Regions in the operations\. Set the global endpoint to `Valid in all AWS Regions` in the AWS STS account settings\. - - The same rule applies to credentials in the presigned URL parameter\. - -For more information, see [Managing AWS STS in an AWS Region](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp_enable-regions.html) in the *IAM User Guide*\. - -### Latency and multiple copy requests - -Depending on the AWS Regions involved and the amount of data to be copied, a cross\-Region snapshot copy can take hours to complete\. - -In some cases, there might be a large number of cross\-Region snapshot copy requests from a given source AWS Region\. In such cases, Amazon RDS might put new cross\-Region copy requests from that source AWS Region into a queue until some in\-progress copies complete\. No progress information is displayed about copy requests while they are in the queue\. Progress information is displayed when the copying starts\. - -### Full and incremental copies - -When you copy a snapshot to a different AWS Region from the source snapshot, the first copy is a full snapshot copy, even if you copy an incremental snapshot\. A full snapshot copy contains all of the data and metadata required to restore the DB instance\. After the first snapshot copy, you can copy incremental snapshots of the same DB instance to the same destination Region within the same AWS account\. For more information on incremental snapshots, see [Incremental snapshot copying](#USER_CopySnapshot.Incremental)\. - -Incremental snapshot copying across AWS Regions is supported for both unencrypted and encrypted snapshots\. - -When you copy a snapshot across AWS Regions, the copy is an incremental copy if the following conditions are met: -+ The snapshot was previously copied to the destination Region\. -+ The most recent snapshot copy still exists in the destination Region\. -+ All copies of the snapshot in the destination Region are either unencrypted, or were encrypted using the same KMS key\. - -## Option group considerations - -DB option groups are specific to the AWS Region that they are created in, and you can't use an option group from one AWS Region in another AWS Region\. - -For Oracle databases, you can use the AWS CLI or RDS API to copy the custom DB option group from a snapshot that has been shared with your AWS account\. You can only copy option groups within the same AWS Region\. The option group isn't copied if it has already been copied to the destination account and no changes have been made to it since being copied\. If the source option group has been copied before, but has changed since being copied, RDS copies the new version to the destination account\. Default option groups aren't copied\. - -When you copy a snapshot across Regions, you can specify a new option group for the snapshot\. We recommend that you prepare the new option group before you copy the snapshot\. In the destination AWS Region, create an option group with the same settings as the original DB instance\. If one already exists in the new AWS Region, you can use that one\. - -In some cases, you might copy a snapshot and not specify a new option group for the snapshot\. In these cases, when you restore the snapshot the DB instance gets the default option group\. To give the new DB instance the same options as the original, do the following: - -1. In the destination AWS Region, create an option group with the same settings as the original DB instance\. If one already exists in the new AWS Region, you can use that one\. - -1. After you restore the snapshot in the destination AWS Region, modify the new DB instance and add the new or existing option group from the previous step\. - -## Parameter group considerations - -When you copy a snapshot across Regions, the copy doesn't include the parameter group used by the original DB instance\. When you restore a snapshot to create a new DB instance, that DB instance gets the default parameter group for the AWS Region it is created in\. To give the new DB instance the same parameters as the original, do the following: - -1. In the destination AWS Region, create a DB parameter group with the same settings as the original DB instance\. If one already exists in the new AWS Region, you can use that one\. - -1. After you restore the snapshot in the destination AWS Region, modify the new DB instance and add the new or existing parameter group from the previous step\. - -## Copying a DB snapshot - -Use the procedures in this topic to copy a DB snapshot\. For an overview of copying a snapshot, see [Copying a DB snapshot](#USER_CopySnapshot) - -For each AWS account, you can copy up to 20 DB snapshots at a time from one AWS Region to another\. If you copy a DB snapshot to another AWS Region, you create a manual DB snapshot that is retained in that AWS Region\. Copying a DB snapshot out of the source AWS Region incurs Amazon RDS data transfer charges\. - -For more information about data transfer pricing, see [Amazon RDS pricing](https://aws.amazon.com/rds/pricing/)\. - -After the DB snapshot copy has been created in the new AWS Region, the DB snapshot copy behaves the same as all other DB snapshots in that AWS Region\. - -You can copy a DB snapshot using the AWS Management Console, the AWS CLI, or the RDS API\. - -### Console - -The following procedure copies an encrypted or unencrypted DB snapshot, in the same AWS Region or across Regions, by using the AWS Management Console\. - -**To copy a DB snapshot** - -1. Sign in to the AWS Management Console and open the Amazon RDS console at [https://console\.aws\.amazon\.com/rds/](https://console.aws.amazon.com/rds/)\. - -1. In the navigation pane, choose **Snapshots**\. - -1. Select the DB snapshot that you want to copy\. - -1. For **Actions**, choose **Copy snapshot**\. - - The **Copy snapshot** page appears\. -![\[Copy a DB snapshot\]](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/images/DBSnapshotCopy1.png) - -1. For **Target option group \(optional\)**, choose a new option group if you want\. - - Specify this option if you are copying a snapshot from one AWS Region to another, and your DB instance uses a nondefault option group\. - - If your source DB instance uses Transparent Data Encryption for Oracle or Microsoft SQL Server, you must specify this option when copying across Regions\. For more information, see [Option group considerations](#USER_CopySnapshot.Options)\. - -1. \(Optional\) To copy the DB snapshot to a different AWS Region, for **Destination Region**, choose the new AWS Region\. -**Note** -The destination AWS Region must have the same database engine version available as the source AWS Region\. - -1. For **New DB snapshot identifier**, type the name of the DB snapshot copy\. - - You can make multiple copies of an automated backup or manual snapshot, but each copy must have a unique identifier\. - -1. \(Optional\) Select **Copy Tags** to copy tags and values from the snapshot to the copy of the snapshot\. - -1. \(Optional\) For **Encryption**, do the following: - - 1. Choose **Enable Encryption** if the DB snapshot isn't encrypted but you want to encrypt the copy\. -**Note** -If the DB snapshot is encrypted, you must encrypt the copy, so the check box is already selected\. - - 1. For **AWS KMS key**, specify the KMS key identifier to use to encrypt the DB snapshot copy\. - -1. Choose **Copy snapshot**\. - -### AWS CLI - -You can copy a DB snapshot by using the AWS CLI command [copy\-db\-snapshot](https://docs.aws.amazon.com/cli/latest/reference/rds/copy-db-snapshot.html)\. If you are copying the snapshot to a new AWS Region, run the command in the new AWS Region\. - -The following options are used to copy a DB snapshot\. Not all options are required for all scenarios\. Use the descriptions and the examples that follow to determine which options to use\. -+ `--source-db-snapshot-identifier` – The identifier for the source DB snapshot\. - + If the source snapshot is in the same AWS Region as the copy, specify a valid DB snapshot identifier\. For example, `rds:mysql-instance1-snapshot-20130805`\. - + If the source snapshot is in the same AWS Region as the copy, and has been shared with your AWS account, specify a valid DB snapshot ARN\. For example, `arn:aws:rds:us-west-2:123456789012:snapshot:mysql-instance1-snapshot-20130805`\. - + If the source snapshot is in a different AWS Region than the copy, specify a valid DB snapshot ARN\. For example, `arn:aws:rds:us-west-2:123456789012:snapshot:mysql-instance1-snapshot-20130805`\. - + If you are copying from a shared manual DB snapshot, this parameter must be the Amazon Resource Name \(ARN\) of the shared DB snapshot\. - + If you are copying an encrypted snapshot this parameter must be in the ARN format for the source AWS Region, and must match the `SourceDBSnapshotIdentifier` in the `PreSignedUrl` parameter\. -+ `--target-db-snapshot-identifier` – The identifier for the new copy of the encrypted DB snapshot\. -+ `--copy-option-group` – Copy the option group from a snapshot that has been shared with your AWS account\. -+ `--copy-tags` – Include the copy tags option to copy tags and values from the snapshot to the copy of the snapshot\. -+ `--option-group-name` – The option group to associate with the copy of the snapshot\. - - Specify this option if you are copying a snapshot from one AWS Region to another, and your DB instance uses a non\-default option group\. - - If your source DB instance uses Transparent Data Encryption for Oracle or Microsoft SQL Server, you must specify this option when copying across Regions\. For more information, see [Option group considerations](#USER_CopySnapshot.Options)\. -+ `--kms-key-id` – The KMS key identifier for an encrypted DB snapshot\. The KMS key identifier is the Amazon Resource Name \(ARN\), key identifier, or key alias for the KMS key\. - + If you copy an encrypted DB snapshot from your AWS account, you can specify a value for this parameter to encrypt the copy with a new KMS key\. If you don't specify a value for this parameter, then the copy of the DB snapshot is encrypted with the same KMS key as the source DB snapshot\. - + If you copy an encrypted DB snapshot that is shared from another AWS account, then you must specify a value for this parameter\. - + If you specify this parameter when you copy an unencrypted snapshot, the copy is encrypted\. - + If you copy an encrypted snapshot to a different AWS Region, then you must specify a KMS key for the destination AWS Region\. KMS keys are specific to the AWS Region that they are created in, and you cannot use encryption keys from one AWS Region in another AWS Region\. - -**Example from unencrypted, to the same Region** -The following code creates a copy of a snapshot, with the new name `mydbsnapshotcopy`, in the same AWS Region as the source snapshot\. When the copy is made, the DB option group and tags on the original snapshot are copied to the snapshot copy\. -For Linux, macOS, or Unix: - -``` -aws rds copy-db-snapshot \ - --source-db-snapshot-identifier arn:aws:rds:us-west-2:123456789012:snapshot:mysql-instance1-snapshot-20130805 \ - --target-db-snapshot-identifier mydbsnapshotcopy \ - --copy-option-group \ - --copy-tags -``` -For Windows: - -``` -aws rds copy-db-snapshot ^ - --source-db-snapshot-identifier arn:aws:rds:us-west-2:123456789012:snapshot:mysql-instance1-snapshot-20130805 ^ - --target-db-snapshot-identifier mydbsnapshotcopy ^ - --copy-option-group ^ - --copy-tags -``` - -**Example from unencrypted, across Regions** -The following code creates a copy of a snapshot, with the new name `mydbsnapshotcopy`, in the AWS Region in which the command is run\. -For Linux, macOS, or Unix: - -``` -aws rds copy-db-snapshot \ - --source-db-snapshot-identifier arn:aws:rds:us-east-1:123456789012:snapshot:mysql-instance1-snapshot-20130805 \ - --target-db-snapshot-identifier mydbsnapshotcopy -``` -For Windows: - -``` -aws rds copy-db-snapshot ^ - --source-db-snapshot-identifier arn:aws:rds:us-east-1:123456789012:snapshot:mysql-instance1-snapshot-20130805 ^ - --target-db-snapshot-identifier mydbsnapshotcopy -``` - -**Example from encrypted, across Regions** -The following code example copies an encrypted DB snapshot from the US West \(Oregon\) Region in the US East \(N\. Virginia\) Region\. Run the command in the destination \(us\-east\-1\) Region\. -For Linux, macOS, or Unix: - -``` -aws rds copy-db-snapshot \ - --source-db-snapshot-identifier arn:aws:rds:us-west-2:123456789012:snapshot:mysql-instance1-snapshot-20161115 \ - --target-db-snapshot-identifier mydbsnapshotcopy \ - --kms-key-id my-us-east-1-key \ - --option-group-name custom-option-group-name -``` -For Windows: - -``` -aws rds copy-db-snapshot ^ - --source-db-snapshot-identifier arn:aws:rds:us-west-2:123456789012:snapshot:mysql-instance1-snapshot-20161115 ^ - --target-db-snapshot-identifier mydbsnapshotcopy ^ - --kms-key-id my-us-east-1-key ^ - --option-group-name custom-option-group-name -``` - -The `--source-region` parameter is required when you're copying an encrypted snapshot between the AWS GovCloud \(US\-East\) and AWS GovCloud \(US\-West\) Regions\. For `--source-region`, specify the AWS Region of the source DB instance\. - -If `--source-region` isn't specified, specify a `--pre-signed-url` value\. A *presigned URL* is a URL that contains a Signature Version 4 signed request for the `copy-db-snapshot` command that's called in the source AWS Region\. To learn more about the `pre-signed-url` option, see [ copy\-db\-snapshot](https://docs.aws.amazon.com/cli/latest/reference/rds/copy-db-snapshot.html) in the *AWS CLI Command Reference*\. - -### RDS API - -You can copy a DB snapshot by using the Amazon RDS API operation [CopyDBSnapshot](https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_CopyDBSnapshot.html)\. If you are copying the snapshot to a new AWS Region, perform the action in the new AWS Region\. - -The following parameters are used to copy a DB snapshot\. Not all parameters are required for all scenarios\. Use the descriptions and the examples that follow to determine which parameters to use\. -+ `SourceDBSnapshotIdentifier` – The identifier for the source DB snapshot\. - + If the source snapshot is in the same AWS Region as the copy, specify a valid DB snapshot identifier\. For example, `rds:mysql-instance1-snapshot-20130805`\. - + If the source snapshot is in the same AWS Region as the copy, and has been shared with your AWS account, specify a valid DB snapshot ARN\. For example, `arn:aws:rds:us-west-2:123456789012:snapshot:mysql-instance1-snapshot-20130805`\. - + If the source snapshot is in a different AWS Region than the copy, specify a valid DB snapshot ARN\. For example, `arn:aws:rds:us-west-2:123456789012:snapshot:mysql-instance1-snapshot-20130805`\. - + If you are copying from a shared manual DB snapshot, this parameter must be the Amazon Resource Name \(ARN\) of the shared DB snapshot\. - + If you are copying an encrypted snapshot this parameter must be in the ARN format for the source AWS Region, and must match the `SourceDBSnapshotIdentifier` in the `PreSignedUrl` parameter\. -+ `TargetDBSnapshotIdentifier` – The identifier for the new copy of the encrypted DB snapshot\. -+ `CopyOptionGroup` – Set this parameter to `true` to copy the option group from a shared snapshot to the copy of the snapshot\. The default is `false`\. -+ `CopyTags` – Set this parameter to `true` to copy tags and values from the snapshot to the copy of the snapshot\. The default is `false`\. -+ `OptionGroupName` – The option group to associate with the copy of the snapshot\. - - Specify this parameter if you are copying a snapshot from one AWS Region to another, and your DB instance uses a non\-default option group\. - - If your source DB instance uses Transparent Data Encryption for Oracle or Microsoft SQL Server, you must specify this parameter when copying across Regions\. For more information, see [Option group considerations](#USER_CopySnapshot.Options)\. -+ `KmsKeyId` – The KMS key identifier for an encrypted DB snapshot\. The KMS key identifier is the Amazon Resource Name \(ARN\), key identifier, or key alias for the KMS key\. - + If you copy an encrypted DB snapshot from your AWS account, you can specify a value for this parameter to encrypt the copy with a new KMS key\. If you don't specify a value for this parameter, then the copy of the DB snapshot is encrypted with the same KMS key as the source DB snapshot\. - + If you copy an encrypted DB snapshot that is shared from another AWS account, then you must specify a value for this parameter\. - + If you specify this parameter when you copy an unencrypted snapshot, the copy is encrypted\. - + If you copy an encrypted snapshot to a different AWS Region, then you must specify a KMS key for the destination AWS Region\. KMS keys are specific to the AWS Region that they are created in, and you cannot use encryption keys from one AWS Region in another AWS Region\. -+ `PreSignedUrl` – The URL that contains a Signature Version 4 signed request for the `CopyDBSnapshot` API operation in the source AWS Region that contains the source DB snapshot to copy\. - - Specify this parameter when you copy an encrypted DB snapshot from another AWS Region by using the Amazon RDS API\. You can specify the source Region option instead of this parameter when you copy an encrypted DB snapshot from another AWS Region by using the AWS CLI\. - - The presigned URL must be a valid request for the `CopyDBSnapshot` API operation that can be run in the source AWS Region containing the encrypted DB snapshot to be copied\. The presigned URL request must contain the following parameter values: - + `DestinationRegion` – The AWS Region that the encrypted DB snapshot will be copied to\. This AWS Region is the same one where the `CopyDBSnapshot` operation is called that contains this presigned URL\. - - For example, suppose that you copy an encrypted DB snapshot from the us\-west\-2 Region to the us\-east\-1 Region\. You then call the `CopyDBSnapshot` operation in the us\-east\-1 Region and provide a presigned URL that contains a call to the `CopyDBSnapshot` operation in the us\-west\-2 Region\. For this example, the `DestinationRegion` in the presigned URL must be set to the us\-east\-1 Region\. - + `KmsKeyId` – The KMS key identifier for the key to use to encrypt the copy of the DB snapshot in the destination AWS Region\. This is the same identifier for both the `CopyDBSnapshot` operation that is called in the destination AWS Region, and the operation contained in the presigned URL\. - + `SourceDBSnapshotIdentifier` – The DB snapshot identifier for the encrypted snapshot to be copied\. This identifier must be in the Amazon Resource Name \(ARN\) format for the source AWS Region\. For example, if you are copying an encrypted DB snapshot from the us\-west\-2 Region, then your `SourceDBSnapshotIdentifier` looks like the following example: `arn:aws:rds:us-west-2:123456789012:snapshot:mysql-instance1-snapshot-20161115`\. - - For more information on Signature Version 4 signed requests, see the following: - + [Authenticating requests: Using query parameters \(AWS signature version 4\)](https://docs.aws.amazon.com/AmazonS3/latest/API/sigv4-query-string-auth.html) in the Amazon Simple Storage Service API Reference - + [Signature version 4 signing process](https://docs.aws.amazon.com/general/latest/gr/signature-version-4.html) in the AWS General Reference - -**Example from unencrypted, to the same Region** -The following code creates a copy of a snapshot, with the new name `mydbsnapshotcopy`, in the same AWS Region as the source snapshot\. When the copy is made, all tags on the original snapshot are copied to the snapshot copy\. - -``` -https://rds.us-west-1.amazonaws.com/ - ?Action=CopyDBSnapshot - &CopyTags=true - &SignatureMethod=HmacSHA256 - &SignatureVersion=4 - &SourceDBSnapshotIdentifier=mysql-instance1-snapshot-20130805 - &TargetDBSnapshotIdentifier=mydbsnapshotcopy - &Version=2013-09-09 - &X-Amz-Algorithm=AWS4-HMAC-SHA256 - &X-Amz-Credential=AKIADQKE4SARGYLE/20140429/us-west-1/rds/aws4_request - &X-Amz-Date=20140429T175351Z - &X-Amz-SignedHeaders=content-type;host;user-agent;x-amz-content-sha256;x-amz-date - &X-Amz-Signature=9164337efa99caf850e874a1cb7ef62f3cea29d0b448b9e0e7c53b288ddffed2 -``` - -**Example from unencrypted, across Regions** -The following code creates a copy of a snapshot, with the new name `mydbsnapshotcopy`, in the US West \(N\. California\) Region\. - -``` -https://rds.us-west-1.amazonaws.com/ - ?Action=CopyDBSnapshot - &SignatureMethod=HmacSHA256 - &SignatureVersion=4 - &SourceDBSnapshotIdentifier=arn%3Aaws%3Ards%3Aus-east-1%3A123456789012%3Asnapshot%3Amysql-instance1-snapshot-20130805 - &TargetDBSnapshotIdentifier=mydbsnapshotcopy - &Version=2013-09-09 - &X-Amz-Algorithm=AWS4-HMAC-SHA256 - &X-Amz-Credential=AKIADQKE4SARGYLE/20140429/us-west-1/rds/aws4_request - &X-Amz-Date=20140429T175351Z - &X-Amz-SignedHeaders=content-type;host;user-agent;x-amz-content-sha256;x-amz-date - &X-Amz-Signature=9164337efa99caf850e874a1cb7ef62f3cea29d0b448b9e0e7c53b288ddffed2 -``` - -**Example from encrypted, across Regions** -The following code creates a copy of a snapshot, with the new name `mydbsnapshotcopy`, in the US East \(N\. Virginia\) Region\. - -``` -https://rds.us-east-1.amazonaws.com/ - ?Action=CopyDBSnapshot - &KmsKeyId=my-us-east-1-key - &OptionGroupName=custom-option-group-name - &PreSignedUrl=https%253A%252F%252Frds.us-west-2.amazonaws.com%252F - %253FAction%253DCopyDBSnapshot - %2526DestinationRegion%253Dus-east-1 - %2526KmsKeyId%253Dmy-us-east-1-key - %2526SourceDBSnapshotIdentifier%253Darn%25253Aaws%25253Ards%25253Aus-west-2%25253A123456789012%25253Asnapshot%25253Amysql-instance1-snapshot-20161115 - %2526SignatureMethod%253DHmacSHA256 - %2526SignatureVersion%253D4 - %2526Version%253D2014-10-31 - %2526X-Amz-Algorithm%253DAWS4-HMAC-SHA256 - %2526X-Amz-Credential%253DAKIADQKE4SARGYLE%252F20161117%252Fus-west-2%252Frds%252Faws4_request - %2526X-Amz-Date%253D20161117T215409Z - %2526X-Amz-Expires%253D3600 - %2526X-Amz-SignedHeaders%253Dcontent-type%253Bhost%253Buser-agent%253Bx-amz-content-sha256%253Bx-amz-date - %2526X-Amz-Signature%253D255a0f17b4e717d3b67fad163c3ec26573b882c03a65523522cf890a67fca613 - &SignatureMethod=HmacSHA256 - &SignatureVersion=4 - &SourceDBSnapshotIdentifier=arn%3Aaws%3Ards%3Aus-west-2%3A123456789012%3Asnapshot%3Amysql-instance1-snapshot-20161115 - &TargetDBSnapshotIdentifier=mydbsnapshotcopy - &Version=2014-10-31 - &X-Amz-Algorithm=AWS4-HMAC-SHA256 - &X-Amz-Credential=AKIADQKE4SARGYLE/20161117/us-east-1/rds/aws4_request - &X-Amz-Date=20161117T221704Z - &X-Amz-SignedHeaders=content-type;host;user-agent;x-amz-content-sha256;x-amz-date - &X-Amz-Signature=da4f2da66739d2e722c85fcfd225dc27bba7e2b8dbea8d8612434378e52adccf -``` \ No newline at end of file diff --git a/doc_source/USER_CreateDBInstance.md b/doc_source/USER_CreateDBInstance.md deleted file mode 100644 index 460c75c..0000000 --- a/doc_source/USER_CreateDBInstance.md +++ /dev/null @@ -1,297 +0,0 @@ -# Creating an Amazon RDS DB instance - -The basic building block of Amazon RDS is the DB instance, where you create your databases\. You choose the engine\-specific characteristics of the DB instance when you create it\. You also choose the storage capacity, CPU, memory, and so on, of the AWS instance on which the database server runs\. - -**Topics** -+ [DB instance prerequisites](#USER_CreateDBInstance.Prerequisites) -+ [Creating a DB instance](#USER_CreateDBInstance.Creating) -+ [Settings for DB instances](#USER_CreateDBInstance.Settings) - -## DB instance prerequisites - -**Important** -Before you can create an Amazon RDS DB instance, you must complete the tasks in [Setting up for Amazon RDS](CHAP_SettingUp.md)\. - -The following are prerequisites to complete before creating a DB instance\. - -**Topics** -+ [Configure the network for the DB instance](#USER_CreateDBInstance.Prerequisites.VPC) -+ [Additional prerequisites](#USER_CreateDBInstance.Prerequisites.Additional) - -### Configure the network for the DB instance - -You can create an Amazon RDS DB instance only in a virtual private cloud \(VPC\) based on the Amazon VPC service\. Also, it must be in an AWS Region that has at least two Availability Zones\. The DB subnet group that you choose for the DB instance must cover at least two Availability Zones\. This configuration ensures that you can configure a Multi\-AZ deployment when you create the DB instance or easily move to one in the future\. - -To set up connectivity between your new DB instance and an Amazon EC2 instance in the same VPC, do so when you create the DB instance\. To connect to your DB instance from resources other than EC2 instances in the same VPC, configure the network connections manually\. - -**Topics** -+ [Configure automatic network connectivity with an EC2 instance](#USER_CreateDBInstance.Prerequisites.VPC.Automatic) -+ [Configure the network manually](#USER_CreateDBInstance.Prerequisites.VPC.Manual) - -#### Configure automatic network connectivity with an EC2 instance - -When you create an RDS DB instance, you can use the AWS Management Console to set up connectivity between an EC2 instance and the new DB instance\. When you do so, RDS configures your VPC and network settings automatically\. The DB instance is created in the same VPC as the EC2 instance so that the EC2 instance can access the DB instance\. - -The following are requirements for connecting an EC2 instance with the DB instance: -+ The EC2 instance must exist in the AWS Region before you create the DB instance\. - - If no EC2 instances exist in the AWS Region, the console provides a link to create one\. -+ The user who is creating the DB instance must have permissions to perform the following operations: - + `ec2:AssociateRouteTable` - + `ec2:AuthorizeSecurityGroupEgress` - + `ec2:AuthorizeSecurityGroupIngress` - + `ec2:CreateRouteTable` - + `ec2:CreateSubnet` - + `ec2:CreateSecurityGroup` - + `ec2:DescribeInstances` - + `ec2:DescribeNetworkInterfaces` - + `ec2:DescribeRouteTables` - + `ec2:DescribeSecurityGroups` - + `ec2:DescribeSubnets` - + `ec2:ModifyNetworkInterfaceAttribute` - + `ec2:RevokeSecurityGroupEgress` - -Using this option creates a private DB instance\. The DB instance uses a DB subnet group with only private subnets to restrict access to resources within the VPC\. - -To connect an EC2 instance to the DB instance, choose **Connect to an EC2 compute resource** in the **Connectivity** section on the **Create database** page\. - -![\[Connect an EC2 instance\]](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/images/ec2-set-up-connection-create.png) - -When you choose **Connect to an EC2 compute resource**, RDS sets the following options automatically\. You can't change these settings unless you choose not to set up connectivity with an EC2 instance by choosing **Don't connect to an EC2 compute resource**\. - - -**** - -| Console option | Automatic setting | -| --- | --- | -| **Network type** | RDS sets network type to **IPv4**\. Currently, dual\-stack mode isn't supported when you set up a connection between an EC2 instance and the DB instance\. | -| **Virtual Private Cloud \(VPC\)** | RDS sets the VPC to the one associated with the EC2 instance\. | -| **DB subnet group** | RDS requires a DB subnet group with a private subnet in the same Availability Zone as the EC2 instance\. If a DB subnet group that meets this requirement exists, then RDS uses the existing DB subnet group\. By default, this option is set to Automatic setup\. When you choose **Automatic setup** and there is no DB subnet group that meets this requirement, the following action happens\. RDS uses three available private subnets in three Availability Zones where one of the Availability Zones is the same as the EC2 instance\. If a private subnet isn’t available in an Availability Zone, RDS creates a private subnet in the Availability Zone\. Then RDS creates the DB subnet group\.When a private subnet is available, RDS uses the route table associated with the subnet and adds any subnets it creates to this route table\. When no private subnet is available, RDS creates a route table without internet gateway access and adds the subnets it creates to the route table\.RDS also allows you to use existing DB subnet groups\. Select **Choose existing** if you want to use an existing DB subnet group of your choice\. | -| **Public access** | RDS chooses **No** so that the DB instance isn't publicly accessible\. For security, it is a best practice to keep the database private and make sure it isn't accessible from the internet\. | -| **VPC security group \(firewall\)** | RDS creates a new security group that is associated with the DB instance\. The security group is named `rds-ec2-n`, where `n` is a number\. This security group includes an inbound rule with the EC2 VPC security group \(firewall\) as the source\. This security group that is associated with the DB instance allows the EC2 instance to access the DB instance\. RDS also creates a new security group that is associated with the EC2 instance\. The security group is named `ec2-rds-n`, where `n` is a number\. This security group includes an outbound rule with the VPC security group of the DB instance as the source\. This security group allows the EC2 instance to send traffic to the DB instance\. You can add another new security group by choosing **Create new** and typing the name of the new security group\. You can add existing security groups by choosing **Choose existing** and selecting security groups to add\. | -| **Availability Zone** | When you choose **Single DB instance** in **Availability & durability** \(Single\-AZ deployment\), RDS chooses the Availability Zone of the EC2 instance\. When you choose **Multi\-AZ DB instance** in **Availability & durability** \(Multi\-AZ DB instance deployment\), RDS chooses the Availability Zone of the EC2 instance for one DB instance in the deployment\. RDS randomly chooses a different Availability Zone for the other DB instance\. Either the primary DB instance or the standby replica is created in the same Availability Zone as the EC2 instance\. When you choose **Multi\-AZ DB instance**, there is the possibility of cross Availability Zone costs if the DB instance and EC2 instance are in different Availability Zones\. | - -For more information about these settings, see [Settings for DB instances](#USER_CreateDBInstance.Settings)\. - -If you change these settings after the DB instance is created, the changes might affect the connection between the EC2 instance and the DB instance\. - -#### Configure the network manually - -To connect to your DB instance from resources other than EC2 instances in the same VPC, configure the network connections manually\. If you use the AWS Management Console to create your DB instance, you can have Amazon RDS automatically create a VPC for you\. Or you can use an existing VPC or create a new VPC for your DB instance\. With any approach, your VPC requires at least one subnet in each of at least two Availability Zones for use with an RDS DB instance\. - -By default, Amazon RDS creates the DB instance an Availability Zone automatically for you\. To choose a specific Availability Zone, you need to change the **Availability & durability** setting to **Single DB instance**\. Doing so exposes an **Availability Zone** setting that lets you choose from among the Availability Zones in your VPC\. However, if you choose a Multi\-AZ deployment, RDS chooses the Availability Zone of the primary or writer DB instance automatically, and the **Availability Zone** setting doesn't appear\. - -In some cases, you might not have a default VPC or haven't created a VPC\. In these cases, you can have Amazon RDS automatically create a VPC for you when you create a DB instance using the console\. Otherwise, do the following: -+ Create a VPC with at least one subnet in each of at least two of the Availability Zones in the AWS Region where you want to deploy your DB instance\. For more information, see [Working with a DB instance in a VPC](USER_VPC.WorkingWithRDSInstanceinaVPC.md#Overview.RDSVPC.Create) and [Tutorial: Create a VPC for use with a DB instance \(IPv4 only\)](CHAP_Tutorials.WebServerDB.CreateVPC.md)\. -+ Specify a VPC security group that authorizes connections to your DB instance\. For more information, see [Provide access to your DB instance in your VPC by creating a security group](CHAP_SettingUp.md#CHAP_SettingUp.SecurityGroup) and [Controlling access with security groups](Overview.RDSSecurityGroups.md)\. -+ Specify an RDS DB subnet group that defines at least two subnets in the VPC that can be used by the DB instance\. For more information, see [Working with DB subnet groups](USER_VPC.WorkingWithRDSInstanceinaVPC.md#USER_VPC.Subnets)\. - -If you want to connect to a resource that isn't in the same VPC as the DB instance, see the appropriate scenarios in [Scenarios for accessing a DB instance in a VPC](USER_VPC.Scenarios.md)\. - -### Additional prerequisites - -Before you create your DB instance, consider the following additional prerequisites: -+ If you are connecting to AWS using AWS Identity and Access Management \(IAM\) credentials, your AWS account must have certain IAM policies\. These grant the permissions required to perform Amazon RDS operations\. For more information, see [Identity and access management for Amazon RDS](UsingWithRDS.IAM.md)\. - - To use IAM to access the RDS console, sign in to the AWS Management Console with your IAM user credentials\. Then go to the Amazon RDS console at [https://console\.aws\.amazon\.com/rds/](https://console.aws.amazon.com/rds/)\. -+ To tailor the configuration parameters for your DB instance, specify a DB parameter group with the required parameter settings\. For information about creating or modifying a DB parameter group, see [Working with parameter groups](USER_WorkingWithParamGroups.md)\. -+ Determine the TCP/IP port number to specify for your DB instance\. The firewalls at some companies block connections to the default ports for RDS DB instances\. If your company firewall blocks the default port, choose another port for your DB instance\. - -## Creating a DB instance - -You can create an Amazon RDS DB instance using the AWS Management Console, the AWS CLI, or the RDS API\. - -### Console - -You can create a DB instance by using the AWS Management Console with **Easy create** enabled or not enabled\. With **Easy create** enabled, you specify only the DB engine type, DB instance size, and DB instance identifier\. **Easy create** uses the default setting for other configuration options\. With **Easy create** not enabled, you specify more configuration options when you create a database, including ones for availability, security, backups, and maintenance\. - -**Note** -In the following procedure, **Standard create** is enabled, and **Easy create** isn't enabled\. This procedure uses Microsoft SQL Server as an example\. -For examples that use **Easy create** to walk you through creating and connecting to sample DB instances for each engine, see [Getting started with Amazon RDS](CHAP_GettingStarted.md)\. - -**To create a DB instance** - -1. Sign in to the AWS Management Console and open the Amazon RDS console at [https://console\.aws\.amazon\.com/rds/](https://console.aws.amazon.com/rds/)\. - -1. In the upper\-right corner of the Amazon RDS console, choose the AWS Region in which you want to create the DB instance\. - -1. In the navigation pane, choose **Databases**\. - -1. Choose **Create database**, then choose **Standard create**\. - -1. For **Engine type**, choose MariaDB, Microsoft SQL Server, MySQL, Oracle, or PostgreSQL\. - - **Microsoft SQL Server** is shown here\. -![\[Engine selection\]](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/images/create-instance-sqlserver.png) - -1. For **Database management type**, if you're using Oracle or SQL Server choose **Amazon RDS** or **Amazon RDS Custom**\. - - **Amazon RDS** is shown here\. For more information on RDS Custom, see [Working with Amazon RDS Custom](rds-custom.md)\. - -1. For **Edition**, if you're using Oracle or SQL Server choose the DB engine edition that you want to use\. - - MySQL has only one option for the edition, and MariaDB and PostgreSQL have none\. - -1. For **Version**, choose the engine version\. - -1. In **Templates**, choose the template that matches your use case\. If you choose **Production**, the following are preselected in a later step: - + **Multi\-AZ** failover option - + **Provisioned IOPS SSD \(io1\)** storage option - + **Enable deletion protection** option - - We recommend these features for any production environment\. -**Note** -Template choices vary by edition\. - -1. To enter your master password, do the following: - - 1. In the **Settings** section, open **Credential Settings**\. - - 1. If you want to specify a password, clear the **Auto generate a password** check box if it is selected\. - - 1. \(Optional\) Change the **Master username** value\. - - 1. Enter the same password in **Master password** and **Confirm password**\. - -1. \(Optional\) Set up a connection to a compute resource for this DB instance\. - - You can configure connectivity between an Amazon EC2 instance and the new DB instance during DB instance creation\. For more information, see [Configure automatic network connectivity with an EC2 instance](#USER_CreateDBInstance.Prerequisites.VPC.Automatic)\. - -1. In the **Connectivity** section under **VPC security group \(firewall\)**, if you select **Create new**, a VPC security group is created is added to the database with an inbound rule that allows your local computer's IP address to access the database\. - -1. For the remaining sections, specify your DB instance settings\. For information about each setting, see [Settings for DB instances](#USER_CreateDBInstance.Settings)\. - -1. Choose **Create database**\. - - If you chose to use an automatically generated password, the **View credential details** button appears on the **Databases** page\. - - To view the master user name and password for the DB instance, choose **View credential details**\. - - To connect to the DB instance as the master user, use the user name and password that appear\. -**Important** -You can't view the master user password again\. If you don't record it, you might have to change it\. If you need to change the master user password after the DB instance is available, modify the DB instance to do so\. For more information about modifying a DB instance, see [Modifying an Amazon RDS DB instance](Overview.DBInstance.Modifying.md)\. - -1. For **Databases**, choose the name of the new DB instance\. - - On the RDS console, the details for the new DB instance appear\. The DB instance has a status of **Creating** until the DB instance is created and ready for use\. When the state changes to **Available**, you can connect to the DB instance\. Depending on the DB instance class and storage allocated, it can take several minutes for the new instance to be available\. -![\[My DB instances details\]](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/images/SQLSvr-Launch05.png) - -### AWS CLI - -To create a DB instance by using the AWS CLI, call the [create\-db\-instance](https://docs.aws.amazon.com/cli/latest/reference/rds/create-db-instance.html) command with the following parameters: -+ `--db-instance-identifier` -+ `--db-instance-class` -+ `--vpc-security-group-ids` -+ `--db-subnet-group` -+ `--engine` -+ `--master-username` -+ `--master-user-password` -+ `--allocated-storage` -+ `--backup-retention-period` - -For information about each setting, see [Settings for DB instances](#USER_CreateDBInstance.Settings)\. - -This example uses Microsoft SQL Server\. - -**Example** -For Linux, macOS, or Unix: - -``` - 1. aws rds create-db-instance \ - 2. --engine sqlserver-se \ - 3. --db-instance-identifier mymsftsqlserver \ - 4. --allocated-storage 250 \ - 5. --db-instance-class db.t3.large \ - 6. --vpc-security-group-ids mysecuritygroup \ - 7. --db-subnet-group mydbsubnetgroup \ - 8. --master-username masterawsuser \ - 9. --master-user-password masteruserpassword \ -10. --backup-retention-period 3 -``` -For Windows: - -``` - 1. aws rds create-db-instance ^ - 2. --engine sqlserver-se ^ - 3. --db-instance-identifier mydbinstance ^ - 4. --allocated-storage 250 ^ - 5. --db-instance-class db.t3.large ^ - 6. --vpc-security-group-ids mysecuritygroup ^ - 7. --db-subnet-group mydbsubnetgroup ^ - 8. --master-username masterawsuser ^ - 9. --master-user-password masteruserpassword ^ -10. --backup-retention-period 3 -``` -This command produces output similar to the following\. - -``` -1. DBINSTANCE mydbinstance db.t3.large sqlserver-se 250 sa creating 3 **** n 10.50.2789 -2. SECGROUP default active -3. PARAMGRP default.sqlserver-se-14 in-sync -``` - -### RDS API - -To create a DB instance by using the Amazon RDS API, call the [CreateDBInstance](https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_CreateDBInstance.html) operation\. - -For information about each setting, see [Settings for DB instances](#USER_CreateDBInstance.Settings)\. - -## Settings for DB instances - -In the following table, you can find details about settings that you choose when you create a DB instance\. The table also shows the DB engines for which each setting is supported\. - -You can create a DB instance using the console, the [ create\-db\-instance](https://docs.aws.amazon.com/cli/latest/reference/rds/create-db-instance.html) CLI command, or the [ CreateDBInstance](https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_CreateDBInstance.html) RDS API operation\. - - -**** - -| Console setting | Setting description | CLI option and RDS API parameter | Supported DB engines | -| --- | --- | --- | --- | -| **Allocated storage** | The amount of storage to allocate for your DB instance \(in gibibytes\)\. In some cases, allocating a higher amount of storage for your DB instance than the size of your database can improve I/O performance\. For more information, see [Amazon RDS DB instance storage](CHAP_Storage.md)\. | **CLI option:** `--allocated-storage` **API parameter:** `AllocatedStorage` | All | -| Architecture settings | The architecture of the database: CDB \(single\-tenant\) or non\-CDB\. Oracle Database 21c uses CDB architecture only\. Oracle Database 19c can use either CDB or non\-CDB architecture\. Releases lower than Oracle Database 19c use non\-CDB only\. If you choose **Use multitenant architecture**, RDS for Oracle creates a container database \(CDB\)\. This CDB contains one pluggable database \(PDB\)\. If you don't choose this option, RDS for Oracle creates a non\-CDB\. A non\-CDB uses the traditional Oracle architecture\. For more information, see [Overview of RDS for Oracle CDBs](oracle-multitenant.md#Oracle.Concepts.single-tenant)\. | **CLI option:** `--engine oracle-ee-cdb` \(multitenant\) `--engine oracle-se2-cdb` \(multitenant\) `--engine oracle-ee` \(traditional\) `--engine oracle-se2` \(traditional\) **API parameter:** `Engine` | Oracle | -| Auto minor version upgrade | **Enable auto minor version upgrade** to enable your DB instance to receive preferred minor DB engine version upgrades automatically when they become available\. Amazon RDS performs automatic minor version upgrades in the maintenance window\. For more information, see [Automatically upgrading the minor engine version](USER_UpgradeDBInstance.Upgrading.md#USER_UpgradeDBInstance.Upgrading.AutoMinorVersionUpgrades)\. | **CLI option:** `--auto-minor-version-upgrade` `--no-auto-minor-version-upgrade` **API parameter:** `AutoMinorVersionUpgrade` | All | -| Availability zone | The Availability Zone for your DB instance\. Use the default value of **No Preference** unless you want to specify an Availability Zone\. For more information, see [Regions, Availability Zones, and Local Zones](Concepts.RegionsAndAvailabilityZones.md)\. | **CLI option:** `--availability-zone` **API parameter:** `AvailabilityZone` | All | -| **AWS KMS key** | Only available if **Encryption** is set to **Enable encryption**\. Choose the AWS KMS key to use for encrypting this DB instance\. For more information, see [Encrypting Amazon RDS resources](Overview.Encryption.md)\. | **CLI option:** `--kms-key-id` **API parameter:** `KmsKeyId` | All | -| Backup replication | Choose **Enable replication in another AWS Region** to create backups in an additional Region for disaster recovery\. Then choose the **Destination Region** for the additional backups\. | Not available when creating a DB instance\. For information on enabling cross\-Region backups using the AWS CLI or RDS API, see [Enabling cross\-Region automated backups](USER_ReplicateBackups.md#AutomatedBackups.Replicating.Enable)\. | Oracle PostgreSQL SQL Server | -| Backup retention period | The number of days that you want automatic backups of your DB instance to be retained\. For any nontrivial DB instance, set this value to **1** or greater\. For more information, see [Working with backups](USER_WorkingWithAutomatedBackups.md)\. | **CLI option:** `--backup-retention-period` **API parameter:** `BackupRetentionPeriod` | All | -| Backup target | Choose **AWS Cloud** to store automated backups and manual snapshots in the parent AWS Region\. Choose **Outposts \(on\-premises\)** to store them locally on your Outpost\. This option setting applies only to RDS on Outposts\. For more information, see [Creating DB instances for Amazon RDS on AWS Outposts](rds-on-outposts.creating.md)\. | **CLI option:** `--backup-target` **API parameter:** `BackupTarget` | MySQL, PostgreSQL, SQL Server | -| Backup window | The time period during which Amazon RDS automatically takes a backup of your DB instance\. Unless you have a specific time that you want to have your database backed up, use the default of **No Preference**\. For more information, see [Working with backups](USER_WorkingWithAutomatedBackups.md)\. | **CLI option:** `--preferred-backup-window` **API parameter:** `PreferredBackupWindow` | All | -| **Certificate authority** | The certificate authority \(CA\) for the server certificate used by the DB instance\. For more information, see [Using SSL/TLS to encrypt a connection to a DB instance](UsingWithRDS.SSL.md)\. | **CLI option:** `--ca-certificate-identifier` **RDS API parameter:** `CACertificateIdentifier` | All | -| Character set | The character set for your DB instance\. The default value of **AL32UTF8** for the DB character set is for the Unicode 5\.0 UTF\-8 Universal character set\. You can't change the DB character set after you create the DB instance\. In a single\-tenant configuration, a non\-default DB character set affects only the PDB, not the CDB\. For more information, see [Overview of RDS for Oracle CDBs](oracle-multitenant.md#Oracle.Concepts.single-tenant)\. The DB character set is different from the national character set, which is called the NCHAR character set\. Unlike the DB character set, the NCHAR character set specifies the encoding for NCHAR data types \(NCHAR, NVARCHAR2, and NCLOB\) columns without affecting database metadata\. For more information, see [RDS for Oracle character sets](Appendix.OracleCharacterSets.md)\. | **CLI option:** `--character-set-name` **API parameter:** `CharacterSetName` | Oracle | -| Collation | A server\-level collation for your DB instance\. For more information, see [Server\-level collation for Microsoft SQL Server](Appendix.SQLServer.CommonDBATasks.Collation.md#Appendix.SQLServer.CommonDBATasks.Collation.Server)\. | **CLI option:** `--character-set-name` **API parameter:** `CharacterSetName` | SQL Server | -| Copy tags to snapshots | This option copies any DB instance tags to a DB snapshot when you create a snapshot\. For more information, see [Tagging Amazon RDS resources](USER_Tagging.md)\. | **CLI option:** `--copy-tags-to-snapshot` `--no-copy-tags-to-snapshot` **RDS API parameter:** `CopyTagsToSnapshot` | All | -| Database authentication | The database authentication option that you want to use\. Choose **Password authentication** to authenticate database users with database passwords only\. Choose **Password and IAM DB authentication** to authenticate database users with database passwords and user credentials through users and roles\. For more information, see [IAM database authentication for MariaDB, MySQL, and PostgreSQL](UsingWithRDS.IAMDBAuth.md)\. This option is only supported for MySQL and PostgreSQL\. Choose **Password and Kerberos authentication** to authenticate database users with database passwords and Kerberos authentication through an AWS Managed Microsoft AD created with AWS Directory Service\. Next, choose the directory or choose **Create a new Directory**\. For more information, see one of the following: [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_CreateDBInstance.html) | ***IAM:*** **CLI option:** `--enable-iam-database-authentication` `--no-enable-iam-database-authentication` **RDS API parameter:** `EnableIAMDatabaseAuthentication` ***Kerberos:*** **CLI option:** `--domain` `--domain-iam-role-name` **RDS API parameter:** `Domain` `DomainIAMRoleName` | Varies by authentication type | -| Database management type | Choose **Amazon RDS** if you don't need to customize your environment\. Choose **Amazon RDS Custom** if you want to customize the database, OS, and infrastructure\. For more information, see [Working with Amazon RDS Custom](rds-custom.md)\. | For the CLI and API, you specify the database engine type\. | Oracle SQL Server | -| Database port | The port that you want to access the DB instance through\. The default port is shown\. The firewalls at some companies block connections to the default MariaDB, MySQL, and PostgreSQL ports\. If your company firewall blocks the default port, enter another port for your DB instance\. | **CLI option:** `--port` **RDS API parameter:** `Port` | All | -| DB engine version | The version of database engine that you want to use\. | **CLI option:** `--engine-version` **RDS API parameter:** `EngineVersion` | All | -| DB instance class | The configuration for your DB instance\. For example, a **db\.t3\.small** DB instance class has 2 GiB memory, 2 vCPUs, 1 virtual core, a variable ECU, and a moderate I/O capacity\. If possible, choose a DB instance class large enough that a typical query working set can be held in memory\. When working sets are held in memory, the system can avoid writing to disk, which improves performance\. For more information, see [DB instance classes](Concepts.DBInstanceClass.md)\. In RDS for Oracle, you can select **Include additional memory configurations**\. These configurations are optimized for a high ratio of memory to vCPU\. For example, **db\.r5\.6xlarge\.tpc2\.mem4x** is a db\.r5\.8x DB instance that has 2 threads per core \(tpc2\) and 4x the memory of a standard db\.r5\.6xlarge DB instance\. For more information, see [RDS for Oracle instance classes](Oracle.Concepts.InstanceClasses.md)\. | **CLI option:** `--db-instance-class` **RDS API parameter:** `DBInstanceClass` | All | -| DB instance identifier | The name for your DB instance\. Name your DB instances in the same way that you name your on\-premises servers\. Your DB instance identifier can contain up to 63 alphanumeric characters, and must be unique for your account in the AWS Region you chose\. | **CLI option:** `--db-instance-identifier` **RDS API parameter:** `DBInstanceIdentifier` | All | -| DB parameter group | A parameter group for your DB instance\. You can choose the default parameter group, or you can create a custom parameter group\. For more information, see [Working with parameter groups](USER_WorkingWithParamGroups.md)\. | **CLI option:** `--db-parameter-group-name` **RDS API parameter:** `DBParameterGroupName` | All | -| DB subnet group | The DB subnet group you want to use for the DB cluster\. Select Choose existing to use an existing DB subnet group\. Then choose the required subnet group from the Existing DB subnet groups dropdown list\.Choose **Automatic setup** to let RDS select a compatible DB subnet group\. If none exist, RDS creates a new subnet group for your cluster\.For more information, see [Working with DB subnet groups](USER_VPC.WorkingWithRDSInstanceinaVPC.md#USER_VPC.Subnets)\. | **CLI option:** `--db-subnet-group-name` **RDS API parameter:** `DBSubnetGroupName` | All | -| Deletion protection | **Enable deletion protection** to prevent your DB instance from being deleted\. If you create a production DB instance with the AWS Management Console, deletion protection is enabled by default\. For more information, see [Deleting a DB instance](USER_DeleteInstance.md)\. | **CLI option:** `--deletion-protection` `--no-deletion-protection` **RDS API parameter:** `DeletionProtection` | All | -| Encryption | **Enable Encryption** to enable encryption at rest for this DB instance\. For more information, see [Encrypting Amazon RDS resources](Overview.Encryption.md)\. | **CLI option:** `--storage-encrypted` `--no-storage-encrypted` **RDS API parameter:** `StorageEncrypted` | All | -| Enhanced Monitoring | **Enable enhanced monitoring** to enable gathering metrics in real time for the operating system that your DB instance runs on\. For more information, see [Monitoring OS metrics with Enhanced Monitoring](USER_Monitoring.OS.md)\. | **CLI options:** `--monitoring-interval` `--monitoring-role-arn` **RDS API parameters:** `MonitoringInterval` `MonitoringRoleArn` | All | -| Engine type | Choose the database engine to be used for this DB instance\. | **CLI option:** `--engine` **RDS API parameter:** `Engine` | All | -| Initial database name | The name for the database on your DB instance\. If you don't provide a name, Amazon RDS doesn't create a database on the DB instance \(except for Oracle and PostgreSQL\)\. The name can't be a word reserved by the database engine, and has other constraints depending on the DB engine\. MariaDB and MySQL: [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_CreateDBInstance.html) Oracle: [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_CreateDBInstance.html) PostgreSQL: [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_CreateDBInstance.html) | **CLI option:** `--db-name` **RDS API parameter:** `DBName` | All except SQL Server | -| License | The license model: [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_CreateDBInstance.html) | **CLI option:** `--license-model` **RDS API parameter:** `LicenseModel` | Oracle SQL Server | -| **Log exports** | The types of database log files to publish to Amazon CloudWatch Logs\. For more information, see [Publishing database logs to Amazon CloudWatch Logs](USER_LogAccess.Procedural.UploadtoCloudWatch.md)\. | **CLI option:** `--enable-cloudwatch-logs-exports` **RDS API parameter:** `EnableCloudwatchLogsExports` | All | -| Maintenance window | The 30\-minute window in which pending modifications to your DB instance are applied\. If the time period doesn't matter, choose **No Preference**\. For more information, see [The Amazon RDS maintenance window](USER_UpgradeDBInstance.Maintenance.md#Concepts.DBMaintenance)\. | **CLI option:** `--preferred-maintenance-window` **RDS API parameter:** `PreferredMaintenanceWindow` | All | -| Manage master credentials in AWS Secrets Manager | Select **Manage master credentials in AWS Secrets Manager** to manage the master user password in a secret in Secrets Manager\. Optionally, choose a KMS key to use to protect the secret\. Choose from the KMS keys in your account, or enter the key from a different account\. For more information, see [Password management with Amazon RDS and AWS Secrets Manager](rds-secrets-manager.md)\. | **CLI option:** `--manage-master-user-password \| --no-manage-master-user-password` `--master-user-secret-kms-key-id` **RDS API parameter:** `ManageMasterUserPassword` `MasterUserSecretKmsKeyId` | All | -| Master password | The password for your master user account\. The password has the following number of printable ASCII characters \(excluding `/`, `"`, a space, and `@`\) depending on the DB engine: [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_CreateDBInstance.html) | **CLI option:** `--master-user-password` **RDS API parameter:** `MasterUserPassword` | All | -| Master username | The name that you use as the master user name to log on to your DB instance with all database privileges\. [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_CreateDBInstance.html) You can't change the master user name after the DB instance is created\. For more information on privileges granted to the master user, see [Master user account privileges](UsingWithRDS.MasterAccounts.md)\. | **CLI option:** `--master-username` **RDS API parameter:** `MasterUsername` | All | -| Microsoft SQL Server Windows Authentication | **Enable Microsoft SQL Server Windows authentication**, then **Browse Directory** to choose the directory where you want to allow authorized domain users to authenticate with this SQL Server instance using Windows Authentication\. | **CLI options:** `--domain` `--domain-iam-role-name` **RDS API parameters:** `Domain` `DomainIAMRoleName` | SQL Server | -| Multi\-AZ deployment | **Create a standby instance** to create a passive secondary replica of your DB instance in another Availability Zone for failover support\. We recommend Multi\-AZ for production workloads to maintain high availability\. For development and testing, you can choose **Do not create a standby instance**\. For more information, see [Configuring and managing a Multi\-AZ deployment](Concepts.MultiAZ.md)\. | **CLI option:** `--multi-az` `--no-multi-az` **RDS API parameter:** `MultiAZ` | All | -| National character set \(NCHAR\) | The national character set for your DB instance, commonly called the NCHAR character set\. You can set the national character set to either AL16UTF16 \(default\) or UTF\-8\. You can't change the national character set after you create the DB instance\. The national character set is different from the DB character set\. Unlike the DB character set, the national character set specifies the encoding only for NCHAR data types \(NCHAR, NVARCHAR2, and NCLOB\) columns without affecting database metadata\. For more information, see [RDS for Oracle character sets](Appendix.OracleCharacterSets.md)\. | **CLI option:** `--nchar-character-set-name` **API parameter:** `NcharCharacterSetName` | Oracle | -| Network type | The IP addressing protocols supported by the DB instance\. **IPv4** \(the default\) to specify that resources can communicate with the DB instance only over the Internet Protocol version 4 \(IPv4\) addressing protocol\. **Dual\-stack mode** to specify that resources can communicate with the DB instance over IPv4, Internet Protocol version 6 \(IPv6\), or both\. Use dual\-stack mode if you have any resources that must communicate with your DB instance over the IPv6 addressing protocol\. Also, make sure that you associate an IPv6 CIDR block with all subnets in the DB subnet group that you specify\. For more information, see [Amazon RDS IP addressing](USER_VPC.WorkingWithRDSInstanceinaVPC.md#USER_VPC.IP_addressing)\. | **CLI option:** `--network-type` **RDS API parameter:** `NetworkType` | All | -| Option group | An option group for your DB instance\. You can choose the default option group or you can create a custom option group\. For more information, see [Working with option groups](USER_WorkingWithOptionGroups.md)\. | **CLI option:** `--option-group-name` **RDS API parameter:** `OptionGroupName` | All | -| Performance Insights | **Enable Performance Insights** to monitor your DB instance load so that you can analyze and troubleshoot your database performance\. Choose a retention period to determine how much Performance Insights data history to keep\. The retention setting in the free tier is **Default \(7 days\)**\. To retain your performance data for longer, specify 1–24 months\. For more information about retention periods, see [Pricing and data retention for Performance Insights](USER_PerfInsights.Overview.cost.md)\. Choose a KMS key to use to protect the key used to encrypt this database volume\. Choose from the KMS keys in your account, or enter the key from a different account\. For more information, see [Monitoring DB load with Performance Insights on Amazon RDS](USER_PerfInsights.md)\. | **CLI options:** `--enable-performance-insights` `--no-enable-performance-insights` `--performance-insights-retention-period` `--performance-insights-kms-key-id` **RDS API parameters:** `EnablePerformanceInsights` `PerformanceInsightsRetentionPeriod` `PerformanceInsightsKMSKeyId` | All | -| **Provisioned IOPS** | The Provisioned IOPS \(I/O operations per second\) value for the DB instance\. This setting is available only if you choose one of the following for **Storage type**: [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_CreateDBInstance.html) For more information, see [Amazon RDS DB instance storage](CHAP_Storage.md)\. | **CLI option:** `--iops` **RDS API parameter:** `Iops` | All | -| Public access | **Yes** to give the DB instance a public IP address, meaning that it's accessible outside the VPC\. To be publicly accessible, the DB instance also has to be in a public subnet in the VPC\. **No** to make the DB instance accessible only from inside the VPC\. For more information, see [Hiding a DB instance in a VPC from the internet](USER_VPC.WorkingWithRDSInstanceinaVPC.md#USER_VPC.Hiding)\. To connect to a DB instance from outside of its VPC, the DB instance must be publicly accessible\. Also, access must be granted using the inbound rules of the DB instance's security group\. In addition, other requirements must be met\. For more information, see [Can't connect to Amazon RDS DB instance](CHAP_Troubleshooting.md#CHAP_Troubleshooting.Connecting)\. If your DB instance isn't publicly accessible, use an AWS Site\-to\-Site VPN connection or an AWS Direct Connect connection to access it from a private network\. For more information, see [Internetwork traffic privacy](inter-network-traffic-privacy.md)\. | **CLI option:** `--publicly-accessible` `--no-publicly-accessible` **RDS API parameter:** `PubliclyAccessible` | All | -| **RDS Proxy** | Choose **Create an RDS Proxy** to create a proxy for your DB instance\. Amazon RDS automatically creates an IAM role and a Secrets Manager secret for the proxy\. For more information, see [Using Amazon RDS Proxy](rds-proxy.md)\. | Not available when creating a DB instance\. | MariaDB MySQL PostgreSQL | -| Storage autoscaling | **Enable storage autoscaling** to enable Amazon RDS to automatically increase storage when needed to avoid having your DB instance run out of storage space\. Use **Maximum storage threshold** to set the upper limit for Amazon RDS to automatically increase storage for your DB instance\. The default is 1,000 GiB\. For more information, see [Managing capacity automatically with Amazon RDS storage autoscaling](USER_PIOPS.StorageTypes.md#USER_PIOPS.Autoscaling)\. | **CLI option:** `--max-allocated-storage` **RDS API parameter:** `MaxAllocatedStorage` | All | -| **Storage throughput** | The storage throughput value for the DB instance\. This setting is available only if you choose **General purpose SSD \(gp3\)** for **Storage type**\. For more information, see [Amazon RDS DB instance storage](CHAP_Storage.md)\. | **CLI option:** `--storage-throughput` **RDS API parameter:** `StorageThroughput` | All | -| Storage type | The storage type for your DB instance\. If you choose **General Purpose SSD \(gp3\)**, you can provision additional provisioned IOPS and storage throughput under **Advanced settings**\. If you choose **Provisioned IOPS SSD \(io1\)**, enter the **Provisioned IOPS** value\. For more information, see [Amazon RDS storage types](CHAP_Storage.md#Concepts.Storage)\. | **CLI option:** `--storage-type` **RDS API parameter:** `StorageType` | All | -| Subnet group | A DB subnet group to associate with this DB instance\. For more information, see [Working with DB subnet groups](USER_VPC.WorkingWithRDSInstanceinaVPC.md#USER_VPC.Subnets)\. | **CLI option:** `--db-subnet-group-name` **RDS API parameter:** `DBSubnetGroupName` | All | -| Time zone | The time zone for your DB instance\. If you don't choose a time zone, your DB instance uses the default time zone\. You can't change the time zone after the DB instance is created\. For more information, see [Local time zone for Microsoft SQL Server DB instances](CHAP_SQLServer.md#SQLServer.Concepts.General.TimeZone)\. | **CLI option:** `--timezone` **RDS API parameter:** `Timezone` | SQL Server | -| Virtual Private Cloud \(VPC\) | A VPC based on the Amazon VPC service to associate with this DB instance\. For more information, see [Amazon VPC VPCs and Amazon RDS](USER_VPC.md)\. | For the CLI and API, you specify the VPC security group IDs\. | All | -| VPC security group \(firewall\) | The security group to associate with the DB instance\. For more information, see [Overview of VPC security groups](Overview.RDSSecurityGroups.md#Overview.RDSSecurityGroups.VPCSec)\. | **CLI option:** `--vpc-security-group-ids` **RDS API parameter:** `VpcSecurityGroupIds` | All | \ No newline at end of file diff --git a/doc_source/USER_CreateInstance.md b/doc_source/USER_CreateInstance.md deleted file mode 100644 index 758bd9c..0000000 --- a/doc_source/USER_CreateInstance.md +++ /dev/null @@ -1,233 +0,0 @@ -# Creating a DB Instance Running the MySQL Database Engine - -The basic building block of Amazon RDS is the DB instance\. The DB instance is where you create your MySQL databases\. - -**Important** -Before you can create or connect to a DB instance, you must complete the tasks in [Setting Up for Amazon RDS](CHAP_SettingUp.md)\. - -For an example that walks you through the process of creating and connecting to a sample DB instance, see [Creating a MySQL DB Instance and Connecting to a Database on a MySQL DB Instance](CHAP_GettingStarted.CreatingConnecting.MySQL.md)\. - -**Note** -If you are using the console, a new console interface is available for database creation\. Choose either the **New Console** or the **Original Console** instructions based on the console that you are using\. The **New Console** instructions are open by default\. - -## New Console - -You can create a DB instance running MySQL with the AWS Management Console with **Easy Create** enabled or not enabled\. With **Easy Create** enabled, you specify only the DB engine type, DB instance size, and DB instance identifier\. **Easy Create** uses the default setting for other configuration options\. With **Easy Create** not enabled, you specify more configuration options when you create a database, including ones for availability, security, backups, and maintenance\. - -**Note** -For this example, **Standard Create** is enabled, and **Easy Create** isn't enabled\. For information about creating a MySQL DB instance with **Easy Create** enabled, see [Creating a MySQL DB Instance and Connecting to a Database on a MySQL DB Instance](CHAP_GettingStarted.CreatingConnecting.MySQL.md)\. - -**To create a MySQL DB instance** - -1. Sign in to the AWS Management Console and open the Amazon RDS console at [https://console\.aws\.amazon\.com/rds/](https://console.aws.amazon.com/rds/)\. - -1. In the upper\-right corner of the AWS Management Console, choose the AWS Region in which you want to create the DB instance\. - -1. In the navigation pane, choose **Databases**\. - -1. Choose **Create database**\. - -1. In **Choose a database creation method**, choose **Standard Create**\. - -1. In **Engine options**, choose **MySQL**\. -![\[Engine options\]](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/images/MySQL-Launch01.png) - -1. In **Templates**, choose the template that matches your use case\. If you choose **Production**, the following are also chosen in a later step: - + **Multi\-AZ** failover option - + **Provisioned IOPS** storage option - + **Enable deletion protection** option - - We recommend these features for any production environment\. - -1. To enter your master password, do the following: - - 1. In the **Settings** section, open **Credential Settings**\. - - 1. Clear the **Auto generate a password** check box\. - - 1. \(Optional\) Change the **Master username** value and enter the same password in **Master password** and **Confirm password**\. - - By default, the new DB instance uses an automatically generated password for the master user\. - -1. For the remaining sections, specify your DB instance settings\. For information about each setting, see [Settings for MySQL DB Instances](#USER_CreateInstance.Settings)\. - -1. Choose **Create database**\. - - If you chose to use an automatically generated password, the **View credential details** button appears on the **Databases** page\. - - To view the master user name and password for the DB instance, choose **View credential details**\. -![\[Master user credentials after automatic password generation.\]](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/images/easy-create-credentials.png) - - To connect to the DB instance as the master user, use the user name and password that appear\. -**Important** -You can't view the master user password again\. If you don't record it, you might have to change it\. If you need to change the master user password after the DB instance is available, you can modify the DB instance to do so\. For more information about modifying a DB instance, see [Modifying an Amazon RDS DB Instance](Overview.DBInstance.Modifying.md)\. - -1. For **Databases**, choose the name of the new MySQL DB instance\. - - On the RDS console, the details for the new DB instance appear\. The DB instance has a status of **creating** until the DB instance is created and ready for use\. When the state changes to **available**, you can connect to the DB instance\. Depending on the DB instance class and storage allocated, it can take several minutes for the new instance to be available\. -![\[My DB instances details\]](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/images/MySQL-Launch06.png) - -## Original Console - -**To launch a MySQL DB instance** - -1. Sign in to the AWS Management Console and open the Amazon RDS console at [https://console\.aws\.amazon\.com/rds/](https://console.aws.amazon.com/rds/)\. - -1. In the top right corner of the AWS Management Console, choose the AWS Region in which you want to create the DB instance\. - -1. In the navigation pane, choose **Databases**\. - - If the navigation pane is closed, choose the menu icon at the top left to open it\. - -1. Choose **Create database** to open the **Select engine** page\. -![\[Select engine\]](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/images/CURRENT-MySQL-Launch01.png) - -1. In the **Select engine** window, choose **MySQL**, and then choose **Next**\. - -1. The **Choose use case** page asks if you are planning to use the DB instance you are creating for production\. If you are, choose **Production \- MySQL**\. If you choose **Production \- MySQL**, the following are also chosen in a later step: - + **Multi\-AZ** failover option - + **Provisioned IOPS** storage option - + **Enable deletion protection** option - - We recommend these features for any production environment\. - -1. Choose **Next** to continue\. The **Specify DB details** page appears\. - - On the **Specify DB details** page, specify your DB instance information\. For information about each setting, see [Settings for MySQL DB Instances](#USER_CreateInstance.Settings)\. -![\[Specify DB details\]](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/images/CURRENT-MySQL-Launch02a.png) - -1. Choose **Next** to continue\. The **Configure advanced settings** page appears\. - - On the **Configure advanced settings** page, provide additional information that Amazon RDS needs to launch the DB instance\. For information about each setting, see [Settings for MySQL DB Instances](#USER_CreateInstance.Settings)\. - -1. Choose **Create database**\. - -1. On the final page, choose **View DB instance details**\. - -On the RDS console, the details for the new DB instance appear\. The DB instance has a status of **creating** until the DB instance is created and ready for use\. When the state changes to **available**, you can connect to the DB instance\. Depending on the DB instance class and storage allocated, it could take several minutes for the new instance to be available\. - -![\[My DB instances list\]](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/images/CURRENT-MySQL-Launch06.png) - -## AWS CLI - -To create a MySQL DB instance by using the AWS CLI, call the [create\-db\-instance](https://docs.aws.amazon.com/cli/latest/reference/rds/create-db-instance.html) command with the parameters below\. For information about each setting, see [Settings for MySQL DB Instances](#USER_CreateInstance.Settings)\. -+ `--db-instance-identifier` -+ `--db-instance-class` -+ `--db-security-groups` -+ `--db-subnet-group` -+ `--engine` -+ `--master-user-name` -+ `--master-user-password` -+ `--allocated-storage` -+ `--backup-retention-period` - -**Example** -The following example creates a MySQL DB instance named mydbinstance\. -For Linux, OS X, or Unix: - -``` -1. aws rds create-db-instance \ -2. --db-instance-identifier mydbinstance \ -3. --db-instance-class db.m1.small \ -4. --engine MySQL \ -5. --allocated-storage 20 \ -6. --master-username masterawsuser \ -7. --master-user-password masteruserpassword \ -8. --backup-retention-period 3 -``` -For Windows: - -``` -1. aws rds create-db-instance ^ -2. --db-instance-identifier mydbinstance ^ -3. --db-instance-class db.m3.medium ^ -4. --engine MySQL ^ -5. --allocated-storage 20 ^ -6. --master-username masterawsuser ^ -7. --master-user-password masteruserpassword ^ -8. --backup-retention-period 3 -``` -This command should produce output similar to the following: - -``` -1. DBINSTANCE mydbinstance db.m3.medium mysql 20 sa creating 3 **** n 5.6.40 -2. SECGROUP default active -3. PARAMGRP default.mysql5.6 in-sync -``` - -## RDS API - -To create a MySQL DB instance by using the Amazon RDS API, call the [CreateDBInstance](https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_CreateDBInstance.html) operation with the parameters below\. For information about each setting, see [Settings for MySQL DB Instances](#USER_CreateInstance.Settings)\. -+ `AllocatedStorage` -+ `BackupRetentionPeriod` -+ `DBInstanceClass` -+ `DBInstanceIdentifier` -+ `DBSecurityGroups` -+ `DBSubnetGroup` -+ `Engine` -+ `MasterUsername` -+ `MasterUserPassword` - -**Example** -The following example creates a MySQL DB instance named mydbinstance\. - -``` - 1. https://rds.us-west-2.amazonaws.com/ - 2. ?Action=CreateDBInstance - 3. &AllocatedStorage=20 - 4. &BackupRetentionPeriod=3 - 5. &DBInstanceClass=db.m3.medium - 6. &DBInstanceIdentifier=mydbinstance - 7. &DBName=mydatabase - 8. &DBSecurityGroups.member.1=mysecuritygroup - 9. &DBSubnetGroup=mydbsubnetgroup -10. &Engine=mysql -11. &MasterUserPassword=masteruserpassword -12. &MasterUsername=masterawsuser -13. &Version=2014-10-31 -14. &X-Amz-Algorithm=AWS4-HMAC-SHA256 -15. &X-Amz-Credential=AKIADQKE4SARGYLE/20140213/us-west-2/rds/aws4_request -16. &X-Amz-Date=20140213T162136Z -17. &X-Amz-SignedHeaders=content-type;host;user-agent;x-amz-content-sha256;x-amz-date -18. &X-Amz-Signature=8052a76dfb18469393c5f0182cdab0ebc224a9c7c5c949155376c1c250fc7ec3 -``` - -## Settings for MySQL DB Instances - -For details about settings that you use when you create a MySQL DB instance, see the following table\. - - -**** - -| Setting | Setting Description | -| --- | --- | -| Allocated storage | The amount of storage to allocate for your DB instance \(in gigabytes\)\. In some cases, allocating a higher amount of storage for your DB instance than the size of your database can improve I/O performance\. For more information, see [Amazon RDS DB Instance Storage](CHAP_Storage.md)\. | -| Auto minor version upgrade | **Enable auto minor version upgrade** to enable your DB instance to receive preferred minor DB engine version upgrades automatically when they become available\. Amazon RDS performs automatic minor version upgrades in the maintenance window\. | -| Availability zone | The Availability Zone for your DB instance\. Use the default value of **No Preference** unless you want to specify an Availability Zone\. For more information, see [Regions and Availability Zones](Concepts.RegionsAndAvailabilityZones.md)\. | -| Backup retention period | The number of days that you want automatic backups of your DB instance to be kept\. For any nontrivial DB instance, set this value to **1** or greater\. For more information, see [Working With Backups](USER_WorkingWithAutomatedBackups.md)\. | -| Backup window | The time period during which Amazon RDS automatically takes a backup of your DB instance\. Unless you have a specific time that you want to have your database backed up, use the default of **No Preference**\. For more information, see [Working With Backups](USER_WorkingWithAutomatedBackups.md)\. | -| Copy tags to snapshots | This option copies any DB instance tags to a DB snapshot when you create a snapshot\. For more information, see [Tagging Amazon RDS Resources](USER_Tagging.md)\. | -| Database authentication | The database authentication option you want to use\. Choose **Password authentication** to authenticate database users with database passwords only\. Choose **Password and IAM DB authentication** to authenticate database users with database passwords and user credentials through IAM users and roles\. For more information, see [IAM Database Authentication for MySQL and PostgreSQL](UsingWithRDS.IAMDBAuth.md)\. | -| Database name | The name for the database on your DB instance\. If you don't provide a name, Amazon RDS doesn't create a database on the DB instance that you are creating\. For this name, these constraints apply: [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_CreateInstance.html) To create additional databases on your DB instance, connect to your DB instance and use the SQL command CREATE DATABASE\. For more information, see [Connecting to a DB Instance Running the MySQL Database Engine](USER_ConnectToInstance.md)\. | -| Database port | The port that you want to access the DB instance through\. MySQL installations default to port 3306\. If you use a DB security group with your DB instance, this port value must be the same one that you provided when creating the DB security group\. The firewalls at some companies block connections to the default MySQL port\. If your company firewall blocks the default port, enter another port for your DB instance\. | -| DB engine version | The version of MySQL that you want to use\. | -| DB instance class | The configuration for your DB instance\. For example, a **db\.m1\.small** instance class has 1\.7 GiB memory, 1 ECU \(1 virtual core with 1 ECU\), 64\-bit platform, and moderate I/O capacity\. If possible, choose an instance class large enough that a typical query working set can be held in memory\. When working sets are held in memory, the system can avoid writing to disk, and this improves performance\. For more information, see [DB Instance Classes](Concepts.DBInstanceClass.md)\. | -| DB instance identifier | The name for your DB instance\. Your DB instance identifier can contain up to 63 alphanumeric characters, and must be unique for your account in the AWS Region you chose\. You can add some intelligence to the name, such as including the AWS Region you chose, for example **mysql\-instance1**\. | -| DB parameter group | A parameter group for your DB instance\. You can choose the default parameter group or you can create a custom parameter group\. For more information, see [Working with DB Parameter Groups](USER_WorkingWithParamGroups.md)\. | -| Deletion protection | **Enable deletion protection** to prevent your DB instance from being deleted\. If you create a production DB instance with the AWS Management Console, deletion protection is enabled by default\. For more information, see [Deleting a DB Instance](USER_DeleteInstance.md)\. | -| Encryption | **Enable Encryption** to enable encryption at rest for this DB instance\. For more information, see [Encrypting Amazon RDS Resources](Overview.Encryption.md)\. | -| Enhanced Monitoring | **Enable enhanced monitoring** to enable gathering metrics in real time for the operating system that your DB instance runs on\. For more information, see [Enhanced Monitoring](USER_Monitoring.OS.md)\. | -| License model | MySQL has only one license model, **general\-public\-license**, the general license agreement for MySQL\. | -| **Log exports** | The types of MySQL database log files to generate\. For more information, see [MySQL Database Log Files](USER_LogAccess.Concepts.MySQL.md)\. | -| Maintenance window | The 30\-minute window in which pending modifications to your DB instance are applied\. If the time period doesn't matter, choose **No Preference**\. For more information, see [The Amazon RDS Maintenance Window](USER_UpgradeDBInstance.Maintenance.md#Concepts.DBMaintenance)\. | -| Master password | The password for your master user account\. The password must contain 8–41 printable ASCII characters \(excluding `/`, `"`, a space, and `@`\)\. | -| Master username | The name that you use as the master user name to log on to your DB instance\. For this name, these constraints apply: [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_CreateInstance.html) For more information, and a list of the default privileges for the master user, see [MySQL Security on Amazon RDS](CHAP_MySQL.md#MySQL.Concepts.UsersAndPrivileges)\. | -| Multi\-AZ deployment | **Create a standby instance** to create a passive secondary replica of your DB instance in another Availability Zone for failover support\. We recommend Multi\-AZ for production workloads to maintain high availability\. For development and testing, you can choose **Do not create a standby instance**\. For more information, see [High Availability \(Multi\-AZ\) for Amazon RDS](Concepts.MultiAZ.md)\. | -| Option group | An option group for your DB instance\. You can choose the default option group or you can create a custom option group\. For more information, see [Working with Option Groups](USER_WorkingWithOptionGroups.md)\. | -| Performance Insights | **Enable Performance Insights** to monitor your DB instance load so that you can analyze and troubleshoot your database performance\. Choose a retention period to determine how much rolling data history to keep\. The default of seven days is in the free tier\. Long\-term retention \(two years\) is priced per vCPU per month\. Choose a master key to use to protect the key used to encrypt this database volume\. Choose from the master keys in your account, or enter the key from a different account\. For more information, see [Using Amazon RDS Performance Insights](USER_PerfInsights.md)\. | -| Public accessibility | **Yes** to give the DB instance a public IP address, meaning that it's accessible outside the VPC\. To be publicly accessible, the DB instance also has to be in a public subnet in the VPC\. **No** to make the DB instance accessible only from inside the VPC\. For more information, see [Hiding a DB Instance in a VPC from the Internet](USER_VPC.WorkingWithRDSInstanceinaVPC.md#USER_VPC.Hiding)\. | -| Storage autoscaling | **Enable storage autoscaling** to enable Amazon RDS to automatically increase storage when needed to avoid having your DB instance run out of storage space\. Use **Maximum storage threshold** to set the upper limit for Amazon RDS to automatically increase storage for your DB instance\. The default is 1,000 GiB\. For more information, see [Managing Capacity Automatically with Amazon RDS Storage Autoscaling](USER_PIOPS.StorageTypes.md#USER_PIOPS.Autoscaling)\. | -| Storage type | The storage type for your DB instance\. For more information, see [Amazon RDS Storage Types](CHAP_Storage.md#Concepts.Storage)\. | -| Subnet group | This setting depends on the platform that you are on\. If you are a new customer to AWS, keep the subnet group set to **default**, which is the default DB subnet group that was created for your account\. If you are creating a DB instance on the earlier E2\-Classic platform, you might want your DB instance in a specific VPC\. In this case, choose the DB subnet group that you created for that VPC\. | -| Virtual Private Cloud \(VPC\) | This setting depends on the platform that you are on\. If you are a new customer to AWS, choose the default VPC shown\. If you are creating a DB instance on the earlier E2\-Classic platform that doesn't use a VPC, choose **Not in VPC**\. For more information, see [Amazon Virtual Private Cloud VPCs and Amazon RDS](USER_VPC.md)\. | -| VPC security groups | If you are a new customer to AWS, **Create new** to create a new VPC security group\. Otherwise, **Choose existing**, then choose from security groups that you previously created\. When you choose **Create new** in the RDS console, a new security group is created\. This new security group has an inbound rule that allows access to the DB instance from the IP address detected in your browser\. For more information, see [Working with DB Security Groups \(EC2\-Classic Platform\)](USER_WorkingWithSecurityGroups.md)\. | \ No newline at end of file diff --git a/doc_source/USER_CreateMariaDBInstance.md b/doc_source/USER_CreateMariaDBInstance.md deleted file mode 100644 index d5a7a93..0000000 --- a/doc_source/USER_CreateMariaDBInstance.md +++ /dev/null @@ -1,235 +0,0 @@ -# Creating a DB Instance Running the MariaDB Database Engine - -The basic building block of Amazon RDS is the DB instance\. The DB instance is where you create your MariaDB databases\. - -**Important** -Before you can create or connect to a DB instance, you must complete the tasks in [Setting Up for Amazon RDS](CHAP_SettingUp.md)\. - -For an example that walks you through the process of creating and connecting to a sample DB instance, see [Creating a MariaDB DB Instance and Connecting to a Database on a MariaDB DB Instance](CHAP_GettingStarted.CreatingConnecting.MariaDB.md)\. - -**Note** -If you are using the console, a new console interface is available for database creation\. Choose either the **New Console** or the **Original Console** instructions based on the console that you are using\. The **New Console** instructions are open by default\. - -## New Console - -You can create a DB instance running MariaDB with the AWS Management Console with **Easy Create** enabled or not enabled\. With **Easy Create** enabled, you specify only the DB engine type, DB instance size, and DB instance identifier\. **Easy Create** uses the default setting for other configuration options\. With **Easy Create** not enabled, you specify more configuration options when you create a database, including ones for availability, security, backups, and maintenance\. - -**Note** -For this example, **Standard Create** is enabled, and **Easy Create** isn't enabled\. For information about creating a MariaDB DB instance with **Easy Create** enabled, see [Creating a MariaDB Instance](CHAP_GettingStarted.CreatingConnecting.MariaDB.md#CHAP_GettingStarted.Creating.MariaDB)\. - -**To create a MariaDB DB instance** - -1. Sign in to the AWS Management Console and open the Amazon RDS console at [https://console\.aws\.amazon\.com/rds/](https://console.aws.amazon.com/rds/)\. - -1. In the upper\-right corner of the AWS Management Console, choose the AWS Region in which you want to create the DB instance\. - -1. In the navigation pane, choose **Databases**\. - -1. Choose **Create database**\. - -1. In **Choose a database creation method**, choose **Standard Create**\. - -1. In **Engine options**, choose **MariaDB**\. -![\[Select engine\]](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/images/MariaDB-Launch01.png) - -1. In **Templates**, choose the template that matches your use case\. If you choose **Production**, the following are also chosen in a later step: - + **Multi\-AZ** failover option - + **Provisioned IOPS** storage option - + **Enable deletion protection** option - - We recommend these features for any production environment\. - -1. To enter your master password, do the following: - - 1. In the **Settings** section, open **Credential Settings**\. - - 1. Clear the **Auto generate a password** check box\. - - 1. \(Optional\) Change the **Master username** value and enter the same password in **Master password** and **Confirm password**\. - - By default, the new DB instance uses an automatically generated password for the master user\. - -1. For the remaining sections, specify your DB instance settings\. For information about each setting, see [Settings for MariaDB DB Instances](#USER_CreateMariaDBInstance.Settings)\. - -1. Choose **Create database**\. - - If you chose to use an automatically generated password, the **View credential details** button appears on the **Databases** page\. - - To view the master username and password for the DB instance, choose **View credential details**\. -![\[Master user credentials after automatic password generation.\]](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/images/easy-create-credentials.png) - - To connect to the DB instance as the master user, use the user name and password that appear\. -**Important** -You can't view the master user password again\. If you don't record it, you might have to change it\. If you need to change the master user password after the DB instance is available, you can modify the DB instance to do so\. For more information about modifying a DB instance, see [Modifying an Amazon RDS DB Instance](Overview.DBInstance.Modifying.md)\. - -1. In the **Databases** list, choose the name of the new MariaDB DB instance\. - - On the RDS console, the details for the new DB instance appear\. The DB instance has a status of **creating** until the DB instance is created and ready for use\. When the state changes to **available**, you can connect to the DB instance\. Depending on the DB instance class and storage allocated, it could take several minutes for the new instance to be available\. -![\[My DB instances details\]](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/images/MariaDB-Launch06.png) - -## Original Console - -**To launch a MariaDB DB instance** - -1. Sign in to the AWS Management Console and open the Amazon RDS console at [https://console\.aws\.amazon\.com/rds/](https://console.aws.amazon.com/rds/)\. - -1. In the top right corner of the AWS Management Console, choose the AWS Region in which you want to create the DB instance\. - -1. In the navigation pane, choose **Databases**\. - - If the navigation pane is closed, choose the menu icon at the top left to open it\. - -1. Choose **Create database** to open the **Select engine** page\. -![\[Select engine\]](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/images/CURRENT-MariaDB-Launch01.png) - -1. Choose **MariaDB**, and then choose **Next**\. - -1. The **Choose use case** page asks if you are planning to use the DB instance you are creating for production\. If you are, choose **Production \- MariaDB**\. If you choose **Production \- MariaDB**, the following are also chosen in a later step: - + **Multi\-AZ** failover option - + **Provisioned IOPS** storage option - + **Enable deletion protection** option - - We recommend these features for any production environment\. - -1. Choose **Next** to continue\. The **Specify DB details** page appears\. - - On the **Specify DB details** page, specify your DB instance information\. For information about each setting, see [Settings for MariaDB DB Instances](#USER_CreateMariaDBInstance.Settings)\. -![\[Specify DB details\]](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/images/CURRENT-MariaDB-Launch02a.png) - -1. Choose **Next** to continue\. - - On the **Configure advanced settings** page, provide additional information that Amazon RDS needs to launch the DB instance\. For information about each setting, see [Settings for MySQL DB Instances](USER_CreateInstance.md#USER_CreateInstance.Settings)\. - -1. Choose **Create database**\. - -1. On the final page, choose **View DB instance details**\. - -On the RDS console, the details for the new DB instance appear\. The DB instance has a status of **creating** until the DB instance is created and ready for use\. When the state changes to **available**, you can connect to the DB instance\. Depending on the DB instance class and storage allocated, it could take several minutes for the new instance to be available\. - -![\[My DB instances details\]](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/images/CURRENT-MariaDB-Launch06.png) - -## AWS CLI - -To create a MariaDB DB instance by using the AWS CLI, call the [create\-db\-instance](https://docs.aws.amazon.com/cli/latest/reference/rds/create-db-instance.html) command with the parameters below\. For information about each setting, see [Settings for MariaDB DB Instances](#USER_CreateMariaDBInstance.Settings)\. -+ `--db-instance-identifier` -+ `--db-instance-class` -+ `--db-security-groups` -+ `--db-subnet-group` -+ `--engine` -+ `--master-user-name` -+ `--master-user-password` -+ `--allocated-storage` -+ `--backup-retention-period` - -**Note** -If you require a specific minor version of MariaDB, include the `--engine-version` parameter\. - -**Example** -The following command creates a MariaDB instance named *mydbinstance*\. -For Linux, OS X, or Unix: - -``` -1. aws rds create-db-instance \ -2. --db-instance-identifier mydbinstance \ -3. --db-instance-class db.m4.xlarge \ -4. --engine mariadb \ -5. --allocated-storage 20 \ -6. --master-username masteruser \ -7. --master-user-password masteruserpassword \ -8. --backup-retention-period 3 -``` -For Windows: - -``` -1. aws rds create-db-instance ^ -2. --db-instance-identifier mydbinstance ^ -3. --db-instance-class db.m4.xlarge ^ -4. --engine mariadb ^ -5. --allocated-storage 20 ^ -6. --master-username masteruser ^ -7. --master-user-password masteruserpassword ^ -8. --backup-retention-period 3 -``` -This command should produce output that begins with information that is similar to the following: - -``` -1. DBINSTANCE 20 True 3 rds-ca-2015 False arn:aws:rds:us-east-1:1234567890:db:mydbinstance db.m4.xlarge mydbinstance creating 0 **** mariadb 10.1.26 -``` - -## RDS API - -To create a MariaDB DB instance by using the Amazon RDS API, call the [CreateDBInstance](https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_CreateDBInstance.html) operation with the parameters below\. For information about each setting, see [Settings for MariaDB DB Instances](#USER_CreateMariaDBInstance.Settings)\. -+ `AllocatedStorage` -+ `BackupRetentionPeriod` -+ `DBInstanceClass` -+ `DBInstanceIdentifier` -+ `DBSecurityGroups` -+ `DBSubnetGroup` -+ `Engine` -+ `MasterUsername` -+ `MasterUserPassword` - -**Note** -If you require a specific minor version of MariaDB, include the `EngineVersion` parameter\. - -**Example** - -``` - 1. https://rds.us-west-2.amazonaws.com/ - 2. ?Action=CreateDBInstance - 3. &AllocatedStorage=20 - 4. &BackupRetentionPeriod=3 - 5. &DBInstanceClass=db.m4.xlarge - 6. &DBInstanceIdentifier=mydbinstance - 7. &DBName=mydatabase - 8. &DBSecurityGroups.member.1=mysecuritygroup - 9. &DBSubnetGroup=mydbsubnetgroup -10. &Engine=mariadb -11. &MasterUserPassword=masteruserpassword -12. &MasterUsername=masterawsuser -13. &Version=2014-10-31 -14. &X-Amz-Algorithm=AWS4-HMAC-SHA256 -15. &X-Amz-Credential=AKIADQKE4SARGYLE/20140213/us-west-2/rds/aws4_request -16. &X-Amz-Date=20140213T162136Z -17. &X-Amz-SignedHeaders=content-type;host;user-agent;x-amz-content-sha256;x-amz-date -18. &X-Amz-Signature=8052a76dfb18469393c5f0182cdab0ebc224a9c7c5c949155376c1c250fc7ec3 -``` - -## Settings for MariaDB DB Instances - -The following table contains details about settings that you choose when you create a Maria DB instance\. - - -**** - -| Setting | Setting Description | -| --- | --- | -| Allocated storage | The amount of storage to allocate for your DB instance \(in gigabytes\)\. In some cases, allocating a higher amount of storage for your DB instance than the size of your database can improve I/O performance\. For more information, see [Amazon RDS DB Instance Storage](CHAP_Storage.md)\. | -| Auto minor version upgrade | **Enable auto minor version upgrade** to enable your DB instance to receive preferred minor DB engine version upgrades automatically when they become available\. Amazon RDS performs automatic minor version upgrades in the maintenance window\. | -| Availability zone | The Availability Zone for your DB instance\. Use the default value of **No Preference** unless you want to specify an Availability Zone\. For more information, see [Regions and Availability Zones](Concepts.RegionsAndAvailabilityZones.md)\. | -| Backup retention period | The number of days that you want automatic backups of your DB instance to be kept\. For any nontrivial DB instance, set this value to **1** or greater\. For more information, see [Working With Backups](USER_WorkingWithAutomatedBackups.md)\. | -| Backup window | The time period during which Amazon RDS automatically takes a backup of your DB instance\. Unless you have a specific time that you want to have your database backed up, use the default of **No Preference**\. For more information, see [Working With Backups](USER_WorkingWithAutomatedBackups.md)\. | -| Copy tags to snapshots | This option copies any DB instance tags to a DB snapshot when you create a snapshot\. For more information, see [Tagging Amazon RDS Resources](USER_Tagging.md)\. | -| Database name | The name for the database on your DB instance\. If you don't provide a name, Amazon RDS doesn't create a database on the DB instance you are creating\. For this name, these constraints apply: [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_CreateMariaDBInstance.html) To create additional databases on your DB instance, connect to your DB instance and use the SQL command CREATE DATABASE\. For more information, see [Connecting to a DB Instance Running the MariaDB Database Engine](USER_ConnectToMariaDBInstance.md)\. | -| Database port | The port that you want to access the DB instance through\. MariaDB installations default to port 3306\. If you use a DB security group with your DB instance, this port value must be the same one that you provided when creating the DB security group\. The firewalls at some companies block connections to the default MariaDB port\. If your company firewall blocks the default port, enter another port for your DB instance\. | -| DB engine version | The version of MariaDB that you want to use\. | -| DB instance class | The configuration for your DB instance\. If possible, choose an instance class large enough that a typical query working set can be held in memory\. When working sets are held in memory, the system can avoid writing to disk, and this improves performance\. For more information, see [DB Instance Classes](Concepts.DBInstanceClass.md)\. | -| DB instance identifier | The name for your DB instance\. Your DB instance identifier can contain up to 63 alphanumeric characters, and must be unique for your account in the AWS Region you chose\. You can add some intelligence to the name, such as including the AWS Region you chose, for example **mariadb\-instance1**\. | -| DB parameter group | A parameter group for your DB instance\. You can choose the default parameter group or you can create a custom parameter group\. For more information, see [Working with DB Parameter Groups](USER_WorkingWithParamGroups.md)\. | -| Deletion protection | **Enable deletion protection** to prevent your DB instance from being deleted\. If you create a production DB instance with the AWS Management Console, deletion protection is enabled by default\. For more information, see [Deleting a DB Instance](USER_DeleteInstance.md)\. | -| Encryption | **Enable Encryption** to enable encryption at rest for this DB instance\. For more information, see [Encrypting Amazon RDS Resources](Overview.Encryption.md)\. | -| Enhanced Monitoring | **Enable enhanced monitoring** to enable gathering metrics in real time for the operating system that your DB instance runs on\. For more information, see [Enhanced Monitoring](USER_Monitoring.OS.md)\. | -| License model | MariaDB has only one license model, **general\-public\-license**, the general license agreement for MariaDB\. | -| **Log exports** | The types of MariaDB database log files to generate\. For more information, see [MariaDB Database Log Files](USER_LogAccess.Concepts.MariaDB.md)\. | -| Maintenance window | The 30\-minute window in which pending modifications to your DB instance are applied\. If the time period doesn't matter, choose **No Preference**\. For more information, see [The Amazon RDS Maintenance Window](USER_UpgradeDBInstance.Maintenance.md#Concepts.DBMaintenance)\. | -| Master password | The password for your master user account\. The password must contain 8–41 printable ASCII characters \(excluding `/`, `"`, a space, and `@`\)\. | -| Master username | The name that you use as the master user name to log on to your DB instance\. For this name, these constraints apply: [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_CreateMariaDBInstance.html) For more information, and a list of the default privileges for the master user, see [MariaDB Security on Amazon RDS](CHAP_MariaDB.md#MariaDB.Concepts.UsersAndPrivileges)\. | -| Multi\-AZ deployment | **Create replica in different zone** to create a standby mirror of your DB instance in another Availability Zone for failover support\. We recommend Multi\-AZ for production workloads to maintain high availability\. For development and testing, you can choose **No**\. For more information, see [High Availability \(Multi\-AZ\) for Amazon RDS](Concepts.MultiAZ.md)\. | -| Option group | An option group for your DB instance\. You can choose the default option group or you can create a custom option group\. For more information, see [Working with Option Groups](USER_WorkingWithOptionGroups.md)\. | -| Performance Insights | **Enable Performance Insights** to monitor your DB instance load so that you can analyze and troubleshoot your database performance\. Choose a retention period to determine how much rolling data history to retain\. The default of seven days is in the free tier\. Long\-term retention \(two years\) is priced per vCPU per month\. Choose a master key to use to protect the key used to encrypt this database volume\. Choose from the master keys in your account, or enter the key from a different account\. For more information, see [Using Amazon RDS Performance Insights](USER_PerfInsights.md)\. | -| Publicly accessible | **Yes** to give the DB instance a public IP address, meaning that it's accessible outside the VPC\. To be publicly accessible, the DB instance also has to be in a public subnet in the VPC\. **No** to make the DB instance accessible only from inside the VPC\. For more information, see [Hiding a DB Instance in a VPC from the Internet](USER_VPC.WorkingWithRDSInstanceinaVPC.md#USER_VPC.Hiding)\. | -| Storage autoscaling | **Enable storage autoscaling** to enable Amazon RDS to automatically increase storage when needed to avoid having your DB instance run out of storage space\. Use **Maximum storage threshold** to set the upper limit for Amazon RDS to automatically increase storage for your DB instance\. The default is 1,000 GiB\. For more information, see [Managing Capacity Automatically with Amazon RDS Storage Autoscaling](USER_PIOPS.StorageTypes.md#USER_PIOPS.Autoscaling)\. | -| Storage type | The storage type for your DB instance\. For more information, see [Amazon RDS Storage Types](CHAP_Storage.md#Concepts.Storage)\. | -| Subnet group | This setting depends on the platform that you are on\. If you are a new customer to AWS, keep the subnet group set to **default**, which is the default DB subnet group that was created for your account\. If you are creating a DB instance on the earlier E2\-Classic platform, you might want your DB instance in a specific VPC\. In this case, choose the DB subnet group that you created for that VPC\. | -| Virtual Private Cloud \(VPC\) | This setting depends on the platform that you are on\. If you are a new customer to AWS, choose the default VPC shown\. If you are creating a DB instance on the earlier E2\-Classic platform that doesn't use a VPC, choose **Not in VPC**\. For more information, see [Amazon Virtual Private Cloud VPCs and Amazon RDS](USER_VPC.md)\. | -| VPC security groups | If you are a new customer to AWS, Create new to create a new VPC security group\. Otherwise, Choose existing, then choose from security groups that you previously created\.When you choose **Create new** in the RDS console, a new security group is created\. This new security group has an inbound rule that allows access to the DB instance from the IP address detected in your browser\.For more information, see [Working with DB Security Groups \(EC2\-Classic Platform\)](USER_WorkingWithSecurityGroups.md)\. | \ No newline at end of file diff --git a/doc_source/USER_CreateMicrosoftSQLServerInstance.md b/doc_source/USER_CreateMicrosoftSQLServerInstance.md deleted file mode 100644 index 38c5ff2..0000000 --- a/doc_source/USER_CreateMicrosoftSQLServerInstance.md +++ /dev/null @@ -1,245 +0,0 @@ -# Creating a DB Instance Running the Microsoft SQL Server Database Engine - -The basic building block of Amazon RDS is the DB instance\. Your Amazon RDS DB instance is similar to your on\-premises Microsoft SQL Server\. After you create your SQL Server DB instance, you can add one or more custom databases to it\. - -**Important** -Before you can create or connect to a DB instance, you must complete the tasks in [Setting Up for Amazon RDS](CHAP_SettingUp.md)\. - -For an example that walks you through the process of creating and connecting to a sample DB instance, see [Creating a Microsoft SQL Server DB Instance and Connecting to a DB Instance](CHAP_GettingStarted.CreatingConnecting.SQLServer.md)\. - -**Note** -If you are using the console, a new console interface is available for database creation\. Choose either the **New Console** or the **Original Console** instructions based on the console that you are using\. The **New Console** instructions are open by default\. - -## New Console - -You can create a DB instance running Microsoft SQL Server with the AWS Management Console with **Easy create** enabled or not enabled\. With **Easy Create** enabled, you specify only the DB engine type, DB instance size, and DB instance identifier\. **Easy Create** uses the default setting for other configuration options\. With **Easy Create** not enabled, you specify more configuration options when you create a database, including ones for availability, security, backups, and maintenance\. - -**Note** -For this example, **Standard Create** is enabled, and **Easy Create** isn't enabled\. For information about creating a Microsoft SQL Server DB instance with **Easy Create** enabled, see [Creating a Microsoft SQL Server DB Instance and Connecting to a DB Instance](CHAP_GettingStarted.CreatingConnecting.SQLServer.md)\. - -**To create a SQL Server DB instance** - -1. Sign in to the AWS Management Console and open the Amazon RDS console at [https://console\.aws\.amazon\.com/rds/](https://console.aws.amazon.com/rds/)\. - -1. In the upper\-right corner of the Amazon RDS console, choose the AWS Region in which you want to create the DB instance\. - -1. In the navigation pane, choose **Databases**\. - -1. Choose **Create database**\. - -1. In **Choose a database creation method**, select **Standard Create**\. - -1. In **Engine options**, choose **Microsoft SQL Server**\. -![\[Engine selection\]](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/images/SQLSvr-Launch01.png) - -1. For **Edition**, choose the SQL Server DB engine edition that you want to use\. The SQL Server editions that are available vary by AWS Region\. - -1. For **Version**, choose the SQL server version\. - -1. In **Templates**, choose the template that matches your use case\. If you choose **Production**, the following are preselected in a later step: - + **Multi\-AZ** failover option - + **Provisioned IOPS** storage option - + **Enable deletion protection** option - - We recommend these features for any production environment\. -**Note** -Template choices vary by edition\. - -1. To enter your master password, do the following: - - 1. In the **Settings** section, open **Credential Settings**\. - - 1. Clear the **Auto generate a password** check box\. - - 1. \(Optional\) Change the **Master username** value and enter the same password in **Master password** and **Confirm password**\. - - By default, the new DB instance uses an automatically generated password for the master user\. - -1. For the remaining sections, specify your DB instance settings\. For information about each setting, see [Settings for Microsoft SQL Server DB Instances](#USER_CreateMicrosoftSQLServerInstance.Settings)\. - -1. Choose **Create database**\. - - If you chose to use an automatically generated password, the **View credential details** button appears on the **Databases** page\. - - To view the master user name and password for the DB instance, choose **View credential details**\. -![\[Master user credentials after automatic password generation.\]](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/images/easy-create-credentials.png) - - To connect to the DB instance as the master user, use the user name and password that appear\. -**Important** -You can't view the master user password again\. If you don't record it, you might have to change it\. If you need to change the master user password after the DB instance is available, you can modify the DB instance to do so\. For more information about modifying a DB instance, see [Modifying an Amazon RDS DB Instance](Overview.DBInstance.Modifying.md)\. - -1. For **Databases**, choose the name of the new SQL Server DB instance\. - - On the RDS console, the details for the new DB instance appear\. The DB instance has a status of **creating** until the DB instance is created and ready for use\. When the state changes to **available**, you can connect to the DB instance\. Depending on the DB instance class and storage allocated, it can take several minutes for the new instance to be available\. -![\[My DB instances details\]](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/images/SQLSvr-Launch05.png) - -## Original Console - -**To launch a SQL Server DB instance** - -1. Sign in to the AWS Management Console and open the Amazon RDS console at [https://console\.aws\.amazon\.com/rds/](https://console.aws.amazon.com/rds/)\. - -1. In the top right corner of the Amazon RDS console, choose the AWS Region in which you want to create the DB instance\. - -1. In the navigation pane, choose **Databases**\. - - If the navigation pane is closed, choose the menu icon at the top left to open it\. - -1. Choose **Create database** to open the **Select engine** page\. - -1. Choose the **Microsoft SQL Server** icon\. -![\[Engine selection\]](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/images/CURRENT-SQLSvr-Launch01.png) - -1. Choose the SQL Server DB engine edition that you want to use\. The SQL Server editions that are available vary by AWS Region\. - -1. For some editions, the **Use Case** step asks if you are planning to use the DB instance you are creating for production\. If you are, choose **Production**\. If you choose **Production**, the following are all preselected in a later step: - + **Multi\-AZ** failover option - + **Provisioned IOPS** storage option - + **Enable deletion protection** option - - We recommend these features for any production environment\. - -1. Choose **Next** to continue\. The **Specify DB Details** page appears\. - - On the **Specify DB Details** page, specify your DB instance information\. For information about each setting, see [Settings for Microsoft SQL Server DB Instances](#USER_CreateMicrosoftSQLServerInstance.Settings)\. -![\[DB instance details\]](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/images/CURRENT-SQLSvr-Launch02.png) - -1. Choose **Next** to continue\. The **Configure Advanced Settings** page appears\. - - On the **Configure Advanced Settings** page, provide additional information that Amazon RDS needs to launch the DB instance\. For information about each setting, see [Settings for Microsoft SQL Server DB Instances](#USER_CreateMicrosoftSQLServerInstance.Settings)\. -![\[Additional Configuration panel\]](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/images/CURRENT-SQLSvr-Launch03.png) - -1. Choose **Launch DB Instance**\. - -1. On the final page of the wizard, choose **Close**\. - -On the RDS console, the new DB instance appears in the list of DB instances\. The DB instance has a status of **creating** until the DB instance is ready to use\. When the state changes to **available**, you can connect to the DB instance\. Depending on the DB instance class and the amount of storage, it can take up to 20 minutes before the new instance is available\. - -![\[My DB instances list\]](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/images/CURRENT-SQLSvr-Launch05.png) - -## AWS CLI - -To create a Microsoft SQL Server DB instance by using the AWS CLI, call the [create\-db\-instance](https://docs.aws.amazon.com/cli/latest/reference/rds/create-db-instance.html) command with the parameters below\. For information about each setting, see [Settings for Microsoft SQL Server DB Instances](#USER_CreateMicrosoftSQLServerInstance.Settings)\. -+ `--db-instance-identifier` -+ `--db-instance-class` -+ `--db-security-groups` -+ `--db-subnet-group` -+ `--engine` -+ `--master-user-name` -+ `--master-user-password` -+ `--allocated-storage` -+ `--backup-retention-period` - -**Example** -For Linux, OS X, or Unix: - -``` - 1. aws rds create-db-instance - 2. --engine sqlserver-se \ - 3. --db-instance-identifier mymsftsqlserver \ - 4. --allocated-storage 250 \ - 5. --db-instance-class db.m1.large \ - 6. --db-security-groups mydbsecuritygroup \ - 7. --db-subnet-group mydbsubnetgroup \ - 8. --master-user-name masterawsuser \ - 9. --master-user-password masteruserpassword \ -10. --backup-retention-period 3 -``` -For Windows: - -``` - 1. aws rds create-db-instance ^ - 2. --engine sqlserver-se ^ - 3. --db-instance-identifier mydbinstance ^ - 4. --allocated-storage 250 ^ - 5. --db-instance-class db.m1.large ^ - 6. --db-security-groups mydbsecuritygroup ^ - 7. --db-subnet-group mydbsubnetgroup ^ - 8. --master-user-name masterawsuser ^ - 9. --master-user-password masteruserpassword ^ -10. --backup-retention-period 3 -``` -This command should produce output similar to the following: - -``` -1. DBINSTANCE mydbinstance db.m1.large sqlserver-se 250 sa creating 3 **** n 10.50.2789 -2. SECGROUP default active -3. PARAMGRP default.sqlserver-se-10.5 in-sync -``` - -## RDS API - -To create a Microsoft SQL Server DB instance by using the Amazon RDS API, call the [CreateDBInstance](https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_CreateDBInstance.html) operation with the parameters below\. For information about each setting, see [Settings for Microsoft SQL Server DB Instances](#USER_CreateMicrosoftSQLServerInstance.Settings)\. -+ `AllocatedStorage` -+ `BackupRetentionPeriod` -+ `DBInstanceClass` -+ `DBInstanceIdentifier` -+ `DBSecurityGroups` -+ `DBSubnetGroup` -+ `Engine` -+ `MasterUsername` -+ `MasterUserPassword` - -**Example** - -``` - 1. https://rds.amazonaws.com/ - 2. ?Action=CreateDBInstance - 3. &AllocatedStorage=250 - 4. &BackupRetentionPeriod=3 - 5. &DBInstanceClass=db.m1.large - 6. &DBInstanceIdentifier=mydbinstance - 7. &DBSecurityGroups.member.1=mysecuritygroup - 8. &DBSubnetGroup=mydbsubnetgroup - 9. &Engine=sqlserver-se -10. &MasterUserPassword=masteruserpassword -11. &MasterUsername=masterawsuser -12. &SignatureMethod=HmacSHA256 -13. &SignatureVersion=4 -14. &Version=2014-10-31 -15. &X-Amz-Algorithm=AWS4-HMAC-SHA256 -16. &X-Amz-Credential=AKIADQKE4SARGYLE/20140305/us-west-1/rds/aws4_request -17. &X-Amz-Date=20140305T185838Z -18. &X-Amz-SignedHeaders=content-type;host;user-agent;x-amz-content-sha256;x-amz-date -19. &X-Amz-Signature=b441901545441d3c7a48f63b5b1522c5b2b37c137500c93c45e209d4b3a064a3 -``` - -## Settings for Microsoft SQL Server DB Instances - -The following table contains details about settings that you choose when you create a SQL Server DB instance\. - - -**** - -| Setting | Setting Description | -| --- | --- | -| Allocated storage | The amount of storage to allocate for your DB instance \(in gigabytes\)\. In some cases, allocating a higher amount of storage for your DB instance than the size of your database can improve I/O performance\. For more information, see [Amazon RDS DB Instance Storage](CHAP_Storage.md)\. | -| Auto minor version upgrade | Not supported on Amazon RDS for SQL Server | -| Availability zone | The Availability Zone for your DB instance\. Use the default value of **No Preference** unless you want to specify an Availability Zone\. For more information, see [Regions and Availability Zones](Concepts.RegionsAndAvailabilityZones.md)\. | -| Backup retention period | The number of days that you want automatic backups of your DB instance to be retained\. For any nontrivial DB instance, set this value to **1** or greater\. For more information, see [Working With Backups](USER_WorkingWithAutomatedBackups.md)\. | -| Backup window | The time period during which Amazon RDS automatically takes a backup of your DB instance\. Unless you have a specific time that you want to have your database backed up, use the default of **No Preference**\. For more information, see [Working With Backups](USER_WorkingWithAutomatedBackups.md)\. | -| Collation | A server\-level collation for your DB instance\. For more information, see [Server\-Level Collation for Microsoft SQL Server](Appendix.SQLServer.CommonDBATasks.Collation.md#Appendix.SQLServer.CommonDBATasks.Collation.Server)\. | -| Copy tags to snapshots | This option copies any DB instance tags to a DB snapshot when you create a snapshot\. For more information, see [Tagging Amazon RDS Resources](USER_Tagging.md)\. | -| Database port | The port that you want to access the DB instance through\. SQL Server installations default to port 1433\. If you use a DB security group with your DB instance, this port value must be the same one that you provided when creating the DB security group\. | -| Database authentication | The database authentication option you want to use\. Choose **Password authentication** to authenticate database users with database passwords only\. Choose **Password and Kerberos authentication** to authenticate database users with database passwords and Kerberos authentication through an AWS Managed Microsoft AD created with AWS Directory Service\. Next, choose the directory or choose **Create a new Directory**\. For more information, see [Using Kerberos Authentication with Amazon RDS for Oracle](oracle-kerberos.md)\. | -| DB engine version | The version of Microsoft SQL Server that you want to use\. | -| DB instance class | The configuration for your DB instance\. For example, a **db\.m1\.small** instance class has 1\.7 GiB memory, 1 ECU \(1 virtual core with 1 ECU\), 64\-bit platform, and moderate I/O capacity\. If possible, choose an instance class large enough that a typical query working set can be held in memory\. When working sets are held in memory the system can avoid writing to disk, and this improves performance\. For more information, see [DB Instance Classes](Concepts.DBInstanceClass.md) and [DB Instance Class Support for Microsoft SQL Server](CHAP_SQLServer.md#SQLServer.Concepts.General.InstanceClasses)\. | -| DB instance identifier | The name for your DB instance\. Name your DB instances in the same way that you name your on\-premises servers\. Your DB instance identifier can contain up to 63 alphanumeric characters, and must be unique for your account in the AWS Region you chose\. You can add some intelligence to the name, such as including the AWS Region and DB engine you chose, for example **sqlsv\-instance1**\. | -| DB parameter group | A parameter group for your DB instance\. You can choose the default parameter group or you can create a custom parameter group\. For more information, see [Working with DB Parameter Groups](USER_WorkingWithParamGroups.md)\. | -| Deletion protection | **Enable deletion protection** to prevent your DB instance from being deleted\. If you create a production DB instance with the AWS Management Console, deletion protection is enabled by default\. For more information, see [Deleting a DB Instance](USER_DeleteInstance.md)\. | -| Encryption | **Enable Encryption** to enable encryption at rest for this DB instance\. For more information, see [Encrypting Amazon RDS Resources](Overview.Encryption.md)\. | -| Enhanced Monitoring | **Enable enhanced monitoring** to enable gathering metrics in real time for the operating system that your DB instance runs on\. For more information, see [Enhanced Monitoring](USER_Monitoring.OS.md)\. | -| License model | The license model that you want to use\. Choose **license\-included** to use the general license agreement for Microsoft SQL Server\. | -| Maintenance window | The 30\-minute window in which pending modifications to your DB instance are applied\. If the time period doesn't matter, choose **No Preference**\. For more information, see [The Amazon RDS Maintenance Window](USER_UpgradeDBInstance.Maintenance.md#Concepts.DBMaintenance)\. | -| Master password | The password for your master user account\. The password must contain 8–128 printable ASCII characters \(excluding `/`,`"`, a space, and `@`\)\. | -| Master username | The name that you use as the master user name to log on to your DB instance with all database privileges\. The master user name is a SQL Server Authentication login that is a member of the `processadmin`, `public`, and `setupadmin` fixed server roles\. For this name, these constraints apply: [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_CreateMicrosoftSQLServerInstance.html) For more information, see [Microsoft SQL Server Security](CHAP_SQLServer.md#SQLServer.Concepts.General.FeatureSupport.UnsupportedRoles)\. | -| Multi\-AZ deployment | **Create a standby instance** to create a passive secondary replica of your DB instance in another Availability Zone for failover support\. We recommend Multi\-AZ for production workloads to maintain high availability\. For development and testing, you can choose **Do not create a standby instance**\. For more information, see [Multi\-AZ Deployments for Microsoft SQL Server](USER_SQLServerMultiAZ.md)\. | -| Option group | An option group for your DB instance\. You can choose the default option group or you can create a custom option group\. For more information, see [Working with Option Groups](USER_WorkingWithOptionGroups.md)\. | -| Performance Insights | **Enable Performance Insights** to monitor your DB instance load so that you can analyze and troubleshoot your database performance\. Choose a retention period to determine how much rolling data history to keep\. The default of seven days is in the free tier\. Long\-term retention \(two years\) is priced per vCPU per month\. Choose a master key to use to protect the key used to encrypt this database volume\. Choose from the master keys in your account, or enter the key from a different account\. For more information, see [Using Amazon RDS Performance Insights](USER_PerfInsights.md)\. | -| Publicly accessible | **Yes** to give the DB instance a public IP address, meaning that it's accessible outside the VPC\. To be publicly accessible, the DB instance also has to be in a public subnet in the VPC\. **No** to make the DB instance accessible only from inside the VPC\. For more information, see [Hiding a DB Instance in a VPC from the Internet](USER_VPC.WorkingWithRDSInstanceinaVPC.md#USER_VPC.Hiding)\. | -| Storage autoscaling | **Enable storage autoscaling** to enable Amazon RDS to automatically increase storage when needed to avoid having your DB instance run out of storage space\. Use **Maximum storage threshold** to set the upper limit for Amazon RDS to automatically increase storage for your DB instance\. The default is 1,000 GiB\. For more information, see [Managing Capacity Automatically with Amazon RDS Storage Autoscaling](USER_PIOPS.StorageTypes.md#USER_PIOPS.Autoscaling)\. | -| Storage type | The storage type for your DB instance\. For more information, see [Amazon RDS Storage Types](CHAP_Storage.md#Concepts.Storage)\. | -| Subnet group | This setting depends on the platform that you are on\. If you are a new customer to AWS, choose **default**, which is the default DB subnet group that was created for your account\. If you are creating a DB instance on the earlier E2\-Classic platform, you might want your DB instance in a specific VPC\. In this case, choose the DB subnet group that you created for that VPC\. | -| Time zone | The time zone for your DB instance\. If you don't choose a time zone, your DB instance uses the default time zone\. For more information, see [Local Time Zone for Microsoft SQL Server DB Instances](CHAP_SQLServer.md#SQLServer.Concepts.General.TimeZone)\. | -| Virtual Private Cloud \(VPC\) | This setting depends on the platform that you are on\. If you are a new customer to AWS, choose the default VPC shown\. If you are creating a DB instance on the earlier E2\-Classic platform that doesn't use a VPC, choose **Not in VPC**\. For more information, see [Amazon Virtual Private Cloud VPCs and Amazon RDS](USER_VPC.md)\. | -| VPC security group | If you are a new customer to AWS, Create new to create a new VPC security group\. Otherwise, Choose existing, then choose from security groups that you previously created\.When you choose **Create new** in the RDS console, a new security group is created\. This new security group has an inbound rule that allows access to the DB instance from the IP address detected in your browser\.For more information, see [Working with DB Security Groups \(EC2\-Classic Platform\)](USER_WorkingWithSecurityGroups.md)\. | \ No newline at end of file diff --git a/doc_source/USER_CreateMultiAZDBClusterSnapshot.md b/doc_source/USER_CreateMultiAZDBClusterSnapshot.md deleted file mode 100644 index 34b58e6..0000000 --- a/doc_source/USER_CreateMultiAZDBClusterSnapshot.md +++ /dev/null @@ -1,59 +0,0 @@ -# Creating a Multi\-AZ DB cluster snapshot - -When you create a Multi\-AZ DB cluster snapshot, make sure to identify which Multi\-AZ DB cluster you are going to back up, and then give your DB cluster snapshot a name so you can restore from it later\. You can also share a Multi\-AZ DB cluster snapshot\. For instructions, see [Sharing a DB snapshot](USER_ShareSnapshot.md)\. - -You can create a Multi\-AZ DB cluster snapshot using the AWS Management Console, the AWS CLI, or the RDS API\. - -## Console - -**To create a DB cluster snapshot** - -1. Sign in to the AWS Management Console and open the Amazon RDS console at [https://console\.aws\.amazon\.com/rds/](https://console.aws.amazon.com/rds/)\. - -1. In the navigation pane, choose **Databases**\. - -1. In the list, choose the Multi\-AZ DB cluster for which you want to take a snapshot\. - -1. For **Actions**, choose **Take snapshot**\. - - The **Take DB snapshot** window appears\. - -1. For **Snapshot name**, enter the name of the snapshot\. - -1. Choose **Take snapshot**\. - -The **Snapshots** page appears, with the new Multi\-AZ DB cluster snapshot's status shown as `Creating`\. After its status is `Available`, you can see its creation time\. - -## AWS CLI - -You can create a Multi\-AZ DB cluster snapshot by using the AWS CLI [ create\-db\-cluster\-snapshot](https://docs.aws.amazon.com/cli/latest/reference/rds/create-db-cluster-snapshot.html) command with the following options: -+ `--db-cluster-identifier` -+ `--db-cluster-snapshot-identifier` - -In this example, you create a Multi\-AZ DB cluster snapshot called *`mymultiazdbclustersnapshot`* for a DB cluster called *`mymultiazdbcluster`*\. - -**Example** -For Linux, macOS, or Unix: - -``` -1. aws rds create-db-cluster-snapshot \ -2. --db-cluster-identifier mymultiazdbcluster \ -3. --db-cluster-snapshot-identifier mymultiazdbclustersnapshot -``` -For Windows: - -``` -1. aws rds create-db-cluster-snapshot ^ -2. --db-cluster-identifier mymultiazdbcluster ^ -3. --db-cluster snapshot-identifier mymultiazdbclustersnapshot -``` - -## RDS API - -You can create a Multi\-AZ DB cluster snapshot by using the Amazon RDS API [CreateDBClusterSnapshot](https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_CreateDBClusterSnapshot.html) operation with the following parameters: -+ `DBClusterIdentifier` -+ `DBClusterSnapshotIdentifier` - -## Deleting a Multi\-AZ DB cluster snapshot - -You can delete Multi\-AZ DB snapshots managed by Amazon RDS when you no longer need them\. For instructions, see [Deleting a DB snapshot](USER_DeleteSnapshot.md)\. \ No newline at end of file diff --git a/doc_source/USER_CreateOracleInstance.md b/doc_source/USER_CreateOracleInstance.md deleted file mode 100644 index cab12f8..0000000 --- a/doc_source/USER_CreateOracleInstance.md +++ /dev/null @@ -1,241 +0,0 @@ -# Creating a DB Instance Running the Oracle Database Engine - - The basic building block of Amazon RDS is the DB instance\. This is the environment in which you run your Oracle databases\. - -**Important** -Before you can create or connect to a DB instance, you must complete the tasks in [Setting Up for Amazon RDS](CHAP_SettingUp.md)\. - -For an example that walks you through the process of creating and connecting to a sample DB instance, see [Creating an Oracle DB Instance and Connecting to a Database on an Oracle DB Instance](CHAP_GettingStarted.CreatingConnecting.Oracle.md)\. - -**Note** -If you are using the console, a new console interface is available for database creation\. Choose either the **New Console** or the **Original Console** instructions based on the console that you are using\. The **New Console** instructions are open by default\. - -## New Console - -You can create a DB instance running Oracle with the AWS Management Console with **Easy Create** enabled or disabled\. With **Easy Create** enabled, you specify only the DB engine type, DB instance size, and DB instance identifier\. **Easy Create** uses the default setting for other configuration options\. With **Easy Create** not enabled, you specify more configuration options when you create a database, including ones for availability, security, backups, and maintenance\. - -**Note** -For this example, **Standard Create** is enabled, and **Easy Create** isn't enabled\. For information about creating an Oracle DB instance with **Easy Create** enabled, see [Creating an Oracle DB Instance and Connecting to a Database on an Oracle DB Instance](CHAP_GettingStarted.CreatingConnecting.Oracle.md)\. - -**To create an Oracle DB instance** - -1. Sign in to the AWS Management Console and open the Amazon RDS console at [https://console\.aws\.amazon\.com/rds/](https://console.aws.amazon.com/rds/)\. - -1. In the upper\-right corner of the AWS Management Console, choose the AWS Region in which you want to create the DB instance\. - -1. In the navigation pane, choose **Databases**\. - -1. Choose **Create database**\. - -1. In **Choose a database creation method**, choose **Standard Create**\. - - The Oracle editions that are available vary by AWS Region\. -![\[Engine options\]](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/images/OracleLaunchEE.png) - -1. In **Engine options**, choose **Oracle**\. - -1. For **Edition**, choose the Oracle DB engine edition that you want to use\. The Oracle editions that are available vary by AWS Region\. - -1. For **Version**, choose the Oracle version\. - -1. The next step asks if you are planning to use the DB instance that you are creating for production\. If you are, choose **Production**\. When you choose **Production**, the following are also chosen in a later step: - + **Multi\-AZ deployment** failover option - + **Provisioned IOPS** storage option - + **Enable deletion protection** option - -1. To enter your master password, do the following: - - 1. In the **Settings** section, open **Credential Settings**\. - - 1. Clear the **Auto generate a password** check box\. - - 1. \(Optional\) Change the **Master username** value and enter the same password in **Master password** and **Confirm password**\. - - By default, the new DB instance uses an automatically generated password for the master user\. - -1. For the remaining sections, specify your DB instance settings\. For information about each setting, see [Settings for Oracle DB Instances](#USER_CreateOracleInstance.Settings)\. - -1. Choose **Create database**\. - - If you chose to use an automatically generated password, the **View credential details** button appears on the **Databases** page\. - - To view the master user name and password for the DB instance, choose **View credential details**\. -![\[Master user credentials after automatic password generation.\]](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/images/easy-create-credentials.png) - - To connect to the DB instance as the master user, use the user name and password that appear\. -**Important** -You can't view the master user password again\. If you don't record it, you might have to change it\. If you need to change the master user password after the DB instance is available, you can modify the DB instance to do so\. For more information about modifying a DB instance, see [Modifying an Amazon RDS DB Instance](Overview.DBInstance.Modifying.md)\. - -1. For **Databases**, choose the name of the new Oracle DB instance\. - - On the RDS console, the details for the new DB instance appear\. The DB instance has a status of **creating** until the DB instance is created and ready for use\. When the state changes to **available**, you can connect to the DB instance\. Depending on the DB instance class and storage allocated, it can take several minutes for the new instance to be available\. -![\[My DB instances list\]](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/images/Oracle-Launch05.png) - -## Original Console - -**To launch an Oracle DB instance** - -1. Sign in to the AWS Management Console and open the Amazon RDS console at [https://console\.aws\.amazon\.com/rds/](https://console.aws.amazon.com/rds/)\. - -1. In the top right corner of the AWS Management Console, choose the AWS Region in which you want to create the DB instance\. - -1. In the navigation pane, choose **Databases**\. - - If the navigation pane is closed, choose the menu icon at the top left to open it\. - -1. Choose **Create database** to open the **Select engine** page\. - - The Oracle editions that are available vary by AWS Region\. -![\[Engine selection\]](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/images/CURRENT-OracleLaunchEE.png) - -1. In the **Select engine** window, choose **Select** for the Oracle DB engine you want to use and then choose **Next**\. - -1. The next step asks if you are planning to use the DB instance you are creating for production\. If you are, choose **Production**\. When you choose **Production**, the following are also chosen in a later step: - + **Multi\-AZ deployment** failover option - + **Provisioned IOPS** storage option - + **Enable deletion protection** option - -1. Choose **Next** to continue\. The **Specify DB details** page appears\. - - On the **Specify DB details** page, specify your DB instance information\. For information about each setting, see [Settings for Oracle DB Instances](#USER_CreateOracleInstance.Settings)\. -![\[DB instance details\]](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/images/CURRENT-Oracle-Launch02.png) - -1. Choose **Next** to continue\. The **Configure advanced settings** page appears\. - - On the **Configure advanced settings** page, provide additional information that RDS needs to launch the DB instance\. For information about each setting, see [Settings for Oracle DB Instances](#USER_CreateOracleInstance.Settings)\. - -1. Choose **Create database**\. - -1. On the final page, choose **View DB instance details**\. - -On the RDS console, the details for the new DB instance appear\. The DB instance has a status of **creating** until the DB instance is created and ready for use\. When the state changes to **available**, you can connect to the DB instance\. Depending on the DB instance class and storage allocated, it could take several minutes for the new instance to be available\. - -![\[My DB instances list\]](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/images/CURRENT-Oracle-Launch05.png) - -## AWS CLI - -To create an Oracle DB instance by using the AWS CLI, call the [create\-db\-instance](https://docs.aws.amazon.com/cli/latest/reference/rds/create-db-instance.html) command with the parameters below\. For information about each setting, see [Settings for Oracle DB Instances](#USER_CreateOracleInstance.Settings)\. -+ `--db-instance-identifier` -+ `--db-instance-class` -+ `--db-security-groups` -+ `--db-subnet-group` -+ `--engine` -+ `--master-user-name` -+ `--master-user-password` -+ `--allocated-storage` -+ `--backup-retention-period` - -**Example** -The following command will launch the example DB instance\. -For Linux, OS X, or Unix: - -``` - 1. aws rds create-db-instance \ - 2. --engine oracle-se1 \ - 3. --db-instance-identifier mydbinstance \ - 4. --allocated-storage 20 \ - 5. --db-instance-class db.m1.small \ - 6. --db-security-groups mydbsecuritygroup \ - 7. --db-subnet-group mydbsubnetgroup \ - 8. --master-username masterawsuser \ - 9. --master-user-password masteruserpassword \ -10. --backup-retention-period 3 -``` -For Windows: - -``` - 1. aws rds create-db-instance ^ - 2. --engine oracle-se1 ^ - 3. --db-instance-identifier mydbinstance ^ - 4. --allocated-storage 20 ^ - 5. --db-instance-class db.m1.small ^ - 6. --db-security-groups mydbsecuritygroup ^ - 7. --db-subnet-group mydbsubnetgroup ^ - 8. --master-username masterawsuser ^ - 9. --master-user-password masteruserpassword ^ -10. --backup-retention-period 3 -``` -This command should produce output similar to the following: - -``` -1. DBINSTANCE mydbinstance db.m1.small oracle-se1 20 sa creating 3 **** n 11.2.0.4.v1 -2. SECGROUP default active -3. PARAMGRP default.oracle-se1-11.2 in-sync -``` - -## RDS API - -To create an Oracle DB instance by using the Amazon RDS API, call the [CreateDBInstance](https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_CreateDBInstance.html) operation with the parameters below\. For information about each setting, see [Settings for Oracle DB Instances](#USER_CreateOracleInstance.Settings)\. -+ `AllocatedStorage` -+ `BackupRetentionPeriod` -+ `DBInstanceClass` -+ `DBInstanceIdentifier` -+ `DBSecurityGroups` -+ `DBSubnetGroup` -+ `Engine` -+ `MasterUsername` -+ `MasterUserPassword` - -**Example** - -``` - 1. https://rds.amazonaws.com/ - 2. ?Action=CreateDBInstance - 3. &AllocatedStorage=250 - 4. &BackupRetentionPeriod=3 - 5. &DBInstanceClass=db.m1.large - 6. &DBInstanceIdentifier=mydbinstance - 7. &DBSecurityGroups.member.1=mysecuritygroup - 8. &DBSubnetGroup=mydbsubnetgroup - 9. &Engine=oracle-se1 -10. &MasterUserPassword=masteruserpassword -11. &MasterUsername=masterawsuser -12. &SignatureMethod=HmacSHA256 -13. &SignatureVersion=4 -14. &Version=2014-10-31 -15. &X-Amz-Algorithm=AWS4-HMAC-SHA256 -16. &X-Amz-Credential=AKIADQKE4SARGYLE/20140305/us-west-1/rds/aws4_request -17. &X-Amz-Date=20140305T185838Z -18. &X-Amz-SignedHeaders=content-type;host;user-agent;x-amz-content-sha256;x-amz-date -19. &X-Amz-Signature=b441901545441d3c7a48f63b5b1522c5b2b37c137500c93c45e209d4b3a064a3 -``` - -## Settings for Oracle DB Instances - -The following table contains details about settings that you choose when you create an Oracle DB instance\. - - -**** - -| Setting | Setting Description | -| --- | --- | -| Allocated storage | The amount of storage to allocate your DB instance \(in gigabytes\)\. In some cases, allocating a higher amount of storage for your DB instance than the size of your database can improve I/O performance\. For more information, see [Amazon RDS DB Instance Storage](CHAP_Storage.md)\. | -| Auto minor version upgrade | **Enable auto minor version upgrade** to enable your DB instance to receive preferred minor DB engine version upgrades automatically when they become available\. Amazon RDS performs automatic minor version upgrades in the maintenance window\. Some options, such as Oracle Locator, Oracle Multimedia, and Oracle Spatial, require that you enable automatic minor version upgrades\. Upgrades for DB instances that use these options are installed during your scheduled maintenance window, and an outage occurs during the upgrade\. You can't disable automatic minor version upgrades at the same time as you modify the option group to remove such an option\. | -| Availability zone | The Availability Zone for your DB instance\. Use the default of **No Preference** unless you need to specify a particular Availability Zone\. For more information, see [Regions and Availability Zones](Concepts.RegionsAndAvailabilityZones.md)\. | -| Backup retention period | The number of days that you want automatic backups of your DB instance to be kept\. For any nontrivial instance, set this value to **1** or greater\. For more information, see [Working With Backups](USER_WorkingWithAutomatedBackups.md)\. | -| Backup window | The time period during which Amazon RDS automatically takes a backup of your DB instance\. Unless you have a specific time that you want to have your database backed up, use the default of **No Preference**\. For more information, see [Working With Backups](USER_WorkingWithAutomatedBackups.md)\. | -| Character set | The character set for your DB instance\. The default value of **AL32UTF8** is for the Unicode 5\.0 UTF\-8 Universal character set\. You can't change the character set after the DB instance is created\. For more information, see [Oracle Character Sets Supported in Amazon RDS](Appendix.OracleCharacterSets.md)\. | -| Copy tags to snapshots | This option copies any DB instance tags to a DB snapshot when you create a snapshot\. For more information, see [Tagging Amazon RDS Resources](USER_Tagging.md)\. | -| Database authentication | The database authentication option you want to use\. Choose **Password authentication** to authenticate database users with database passwords only\. Choose **Password and Kerberos authentication** to authenticate database users with database passwords and Kerberos authentication through an AWS Managed Microsoft AD created with AWS Directory Service\. Next, choose the directory or choose **Create a new Directory**\. For more information, see [Using Kerberos Authentication with Amazon RDS for Oracle](oracle-kerberos.md)\. | -| Database name | The name for the database on your DB instance\. The name must begin with a letter and contain up to eight alphanumeric characters\. You can't specify the string NULL, or any other reserved word, for the database name\. If you don't provide a name, Amazon RDS creates a database named `ORCL`\. | -| Database port | The port that you want to access the DB instance through\. Oracle installations default to port 1521\. | -| DB engine version | The version of Oracle that you want to use\. | -| DB instance class | The DB instance class that you want to use\. For more information, see [DB Instance Classes](Concepts.DBInstanceClass.md) and [DB Instance Class Support for Oracle](CHAP_Oracle.md#Oracle.Concepts.InstanceClasses)\. | -| DB instance identifier | The name for your DB instance\. The name must be unique for your account and AWS Region\. You can add some intelligence to the name, such as including the AWS Region and DB engine you chose, for example **oracle\-instance1**\. | -| DB parameter group | A parameter group for your DB instance\. You can choose the default parameter group or you can create a custom parameter group\. For more information, see [Working with DB Parameter Groups](USER_WorkingWithParamGroups.md) and [Modifying an Amazon RDS DB Instance](Overview.DBInstance.Modifying.md)\. | -| Deletion protection | **Enable deletion protection** to prevent your DB instance from being deleted\. If you create a production DB instance with the AWS Management Console, deletion protection is enabled by default\. For more information, see [Deleting a DB Instance](USER_DeleteInstance.md)\. | -| Encryption | **Enable Encryption** to enable encryption at rest for this DB instance\. For more information, see [Encrypting Amazon RDS Resources](Overview.Encryption.md)\. | -| Enhanced Monitoring | **Enable enhanced monitoring** to enable gathering metrics in real time for the operating system that your DB instance runs on\. For more information, see [Enhanced Monitoring](USER_Monitoring.OS.md)\. | -| License model | The license model that you want to use\. Choose **license\-included** to use the general license agreement for Oracle\. Choose **bring\-your\-own\-license** to use your existing Oracle license\. For more information, see [Oracle Licensing](CHAP_Oracle.md#Oracle.Concepts.Licensing)\. | -| Maintenance window | The 30\-minute window in which pending modifications to your DB instance are applied\. If the time period doesn't matter, choose **No Preference**\. For more information, see [The Amazon RDS Maintenance Window](USER_UpgradeDBInstance.Maintenance.md#Concepts.DBMaintenance)\. | -| Master password | The password for your master user account\. The password must contain 8–30 printable ASCII characters \(excluding `/`, `"`, a space, and `@`\)\. | -| Master username | The name that you use as the master user name to log on to your DB instance with all database privileges\. This user account is used to log in to the DB instance and is granted DBA privileges\. For this name, these constraints apply: [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_CreateOracleInstance.html) For more information, see [Oracle Security](CHAP_Oracle.md#Oracle.Concepts.RestrictedDBAPrivileges)\. | -| Multi\-AZ deployment | **Create a standby instance** to create a passive secondary replica of your DB instance in another Availability Zone for failover support\. We recommend Multi\-AZ for production workloads to maintain high availability\. For development and testing, you can choose **Do not create a standby instance**\. For more information, see [Regions and Availability Zones](Concepts.RegionsAndAvailabilityZones.md)\. | -| Option group | An option group for your DB instance\. You can choose the default option group or you can create a custom option group\. For more information, see [Working with Option Groups](USER_WorkingWithOptionGroups.md)\. | -| Performance Insights | **Enable Performance Insights** to monitor your DB instance load so that you can analyze and troubleshoot your database performance\. Choose a retention period to determine how much rolling data history to retain\. The default of seven days is in the free tier\. Long\-term retention \(two years\) is priced per vCPU per month\. Choose a master key to protect the key used to encrypt this database volume\. Choose from the master keys in your account, or enter the key from a different account\. For more information, see [Using Amazon RDS Performance Insights](USER_PerfInsights.md)\. | -| Publicly accessible | **Yes** to give the DB instance a public IP address, meaning that it's accessible outside the VPC\. To be publicly accessible, the DB instance also has to be in a public subnet in the VPC\. **No** to make the DB instance accessible only from inside the VPC\. For more information, see [Hiding a DB Instance in a VPC from the Internet](USER_VPC.WorkingWithRDSInstanceinaVPC.md#USER_VPC.Hiding)\. | -| Storage autoscaling | **Enable storage autoscaling** to enable Amazon RDS to automatically increase storage when needed to avoid having your DB instance run out of storage space\. Use **Maximum storage threshold** to set the upper limit for Amazon RDS to automatically increase storage for your DB instance\. The default is 1,000 GiB\. For more information, see [Managing Capacity Automatically with Amazon RDS Storage Autoscaling](USER_PIOPS.StorageTypes.md#USER_PIOPS.Autoscaling)\. | -| Storage type | The storage type for your DB instance\. For more information, see [Amazon RDS Storage Types](CHAP_Storage.md#Concepts.Storage)\. | -| Subnet group | This setting depends on the platform that you are on\. If you are a new customer to AWS, keep the subnet group set to **default**, which is the default DB subnet group that was created for your account\. If you are creating a DB instance on the earlier E2\-Classic platform, you might want your DB instance in a specific VPC\. In this case, choose the DB subnet group that you created for that VPC\. | -| Virtual Private Cloud \(VPC\) | This setting depends on the platform that you are on\. If you are a new customer to AWS, choose the default VPC shown\. If you are creating a DB instance on the earlier E2\-Classic platform that doesn't use a VPC, choose **Not in VPC**\. For more information, see [Amazon Virtual Private Cloud VPCs and Amazon RDS](USER_VPC.md)\. | -| VPC security groups | If you are a new customer to AWS, Create new to create a new VPC security group\. Otherwise, Choose existing, then choose from security groups that you previously created\.When you choose **Create new** in the RDS console, a new security group is created\. This new security group has an inbound rule that allows access to the DB instance from the IP address detected in your browser\.For more information, see [Working with DB Security Groups \(EC2\-Classic Platform\)](USER_WorkingWithSecurityGroups.md)\. | \ No newline at end of file diff --git a/doc_source/USER_CreatePostgreSQLInstance.md b/doc_source/USER_CreatePostgreSQLInstance.md deleted file mode 100644 index a4fa5cf..0000000 --- a/doc_source/USER_CreatePostgreSQLInstance.md +++ /dev/null @@ -1,218 +0,0 @@ -# Creating a DB Instance Running the PostgreSQL Database Engine - - The basic building block of Amazon RDS is the DB instance\. This is the environment in which you run your PostgreSQL databases\. - -**Important** -Before you can create or connect to a DB instance, you must complete the tasks in [Setting Up for Amazon RDS](CHAP_SettingUp.md)\. - -If you are using the console, a new console interface is available for database creation\. Choose either the **New Console** or the **Original Console** instructions based on the console that you are using\. The **New Console** instructions are open by default\. - -## New Console - -**To launch a PostgreSQL DB instance** - -You can create a DB instance running PostgreSQL with the AWS Management Console with **Easy Create** enabled or disabled\. With **Easy Create** enabled, you specify only the DB engine type, DB instance size, and DB instance identifier\. **Easy Create** uses the default setting for other configuration options\. With **Easy Create** not enabled, you specify more configuration options when you create a database, including ones for availability, security, backups, and maintenance\. -**Note** -For this example, **Standard Create** is enabled, and **Easy Create** isn't enabled\. For information about creating a PostgreSQL DB instance with **Easy Create** enabled, see [Creating a PostgreSQL DB Instance and Connecting to a Database on a PostgreSQL DB Instance](CHAP_GettingStarted.CreatingConnecting.PostgreSQL.md)\. - -1. Sign in to the AWS Management Console and open the Amazon RDS console at [https://console\.aws\.amazon\.com/rds/](https://console.aws.amazon.com/rds/)\. - -1. In the upper\-right corner of the AWS Management Console, choose the AWS Region where you want to create the DB instance\. - -1. In the navigation pane, choose **Databases**\. - -1. Choose **Create database**\. - -1. In **Choose a database creation method**, choose **Standard Create**\. - -1. In **Engine options**, choose **PostgreSQL**\. -![\[Engine selection\]](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/images/Postgres-Launch01a.png) - -1. In **Templates**, choose the template that matches your use case\. If you choose **Production**, the following are also chosen in a later step: - + **Multi\-AZ** failover option - + **Provisioned IOPS** storage option - + **Enable deletion protection** option - - We recommend these features for any production environment\. - -1. To enter your master password, do the following: - - 1. In the **Settings** section, open **Credential Settings**\. - - 1. Clear the **Auto generate a password** check box\. - - 1. \(Optional\) Change the **Master username** value and enter the same password in **Master password** and **Confirm password**\. - - By default, the new DB instance uses an automatically generated password for the master user\. - -1. For the remaining sections, specify your DB instance settings\. For information about each setting, see [Settings for PostgreSQL DB Instances](#USER_CreatePostgreSQLInstance.Settings)\. - -1. Choose **Create database**\. - - If you chose to use an automatically generated password, the **View credential details** button appears on the **Databases** page\. - - To view the master user name and password for the DB instance, choose **View credential details**\. -![\[Master user credentials after automatic password generation.\]](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/images/easy-create-credentials.png) - - To connect to the DB instance as the master user, use the user name and password that appear\. -**Important** -You can't view the master user password again\. If you don't record it, you might have to change it\. If you need to change the master user password after the DB instance is available, you can modify the DB instance to do so\. For more information about modifying a DB instance, see [Modifying an Amazon RDS DB Instance](Overview.DBInstance.Modifying.md)\. - -1. For **Databases**, choose the name of the new PostgreSQL DB instance\. - - On the RDS console, the details for the new DB instance appear\. The DB instance has a status of **creating** until the DB instance is created and ready for use\. When the state changes to **available**, you can connect to the DB instance\. Depending on the DB instance class and storage allocated, it can take several minutes for the new instance to be available\. -![\[My DB instances list\]](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/images/Postgres-Launch06.png) - -## Original Console - -**To launch a PostgreSQL DB instance** - -1. Sign in to the AWS Management Console and open the Amazon RDS console at [https://console\.aws\.amazon\.com/rds/](https://console.aws.amazon.com/rds/)\. - -1. In the top\-right corner of the AWS Management Console, choose the AWS Region where you want to create the DB instance\. - -1. In the navigation pane, choose **Databases**\. - - If the navigation pane is closed, choose the menu icon at the top left to open it\. - -1. Choose **Create database** to start open on the **Select engine** page\. -![\[Engine selection\]](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/images/Postgres-Launch01a.png) - -1. On the **Select engine** page, choose the PostgreSQL icon, and then choose **Next**\. - -1. Next, the **Use case** page asks if you are planning to use the DB instance you are creating for production\. If you are, choose **Production**\. If you choose this option, the following are also chosen in a later step: - + **Multi\-AZ** failover option - + **Provisioned IOPS** storage option - + **Enable deletion protection** option - - Choose **Next** when you are finished\. - -1. On the **Specify DB Details** page, specify your DB instance information\. Choose **Next** when you are finished\. -**** -[\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_CreatePostgreSQLInstance.html) - -1. On the **Configure Advanced Settings** page, provide additional information that RDS needs to launch the PostgreSQL DB instance\. The table shows settings for an example DB instance\. Specify your DB instance information, then choose **Create database**\. -**** -[\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_CreatePostgreSQLInstance.html) - -1. On the final page, choose **Create database**\. - -1. On the Amazon RDS console, the new DB instance appears in the list of DB instances\. The DB instance will have a status of **creating** until the DB instance is created and ready for use\. When the state changes to **available**, you can connect to the DB instance\. Depending on the DB instance class and store allocated, it could take several minutes for the new instance to be available\. -![\[My DB instances list\]](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/images/Postgres-Launch06.png) - -## AWS CLI - -To create a PostgreSQL DB instance, use the AWS CLI [https://docs.aws.amazon.com/cli/latest/reference/rds/create-db-instance.html](https://docs.aws.amazon.com/cli/latest/reference/rds/create-db-instance.html) command with the following parameters: -+ `--db-instance-identifier` -+ `--allocated-storage` -+ `--db-instance-class` -+ `--engine` -+ `--master-username` -+ `--master-user-password` - -**Example** -For Linux, OS X, or Unix: - -``` -1. aws rds create-db-instance -2. --db-instance-identifier pgdbinstance \ -3. --allocated-storage 20 \ -4. --db-instance-class db.t2.small \ -5. --engine postgres \ -6. --master-username masterawsuser \ -7. --master-user-password masteruserpassword -``` -For Windows: - -``` -1. aws rds create-db-instance -2. --db-instance-identifier pgdbinstance ^ -3. --allocated-storage 20 ^ -4. --db-instance-class db.t2.small ^ -5. --engine postgres ^ -6. --master-username masterawsuser ^ -7. --master-user-password masteruserpassword -``` -This command should produce output similar to the following: - -``` -1. DBINSTANCE pgdbinstance db.t2.small postgres 20 sa creating 3 **** n 9.3 -2. SECGROUP default active -3. PARAMGRP default.PostgreSQL9.3 in-sync -``` - -## RDS API - -To create a PostgreSQL DB instance, use the Amazon RDS API[https://docs.aws.amazon.com/](https://docs.aws.amazon.com/) command with the following parameters: -+ `Engine = postgres` -+ `DBInstanceIdentifier = pgdbinstance` -+ `DBInstanceClass = db.t2.small` -+ `AllocatedStorage = 20` -+ `BackupRetentionPeriod = 3` -+ `MasterUsername = masterawsuser` -+ `MasterUserPassword = masteruserpassword` - -**Example** - -``` - 1. https://rds.amazonaws.com/ - 2. ?Action=CreateDBInstance - 3. &AllocatedStorage=20 - 4. &BackupRetentionPeriod=3 - 5. &DBInstanceClass=db.t2.small - 6. &DBInstanceIdentifier=pgdbinstance - 7. &DBName=mydatabase - 8. &DBSecurityGroups.member.1=mysecuritygroup - 9. &DBSubnetGroup=mydbsubnetgroup -10. &Engine=postgres -11. &MasterUserPassword= -12. &MasterUsername= -13. &SignatureMethod=HmacSHA256 -14. &SignatureVersion=4 -15. &Version=2013-09-09 -16. &X-Amz-Algorithm=AWS4-HMAC-SHA256 -17. &X-Amz-Credential=AKIADQKE4SARGYLE/20140212/us-west-2/rds/aws4_request -18. &X-Amz-Date=20140212T190137Z -19. &X-Amz-SignedHeaders=content-type;host;user-agent;x-amz-content-sha256;x-amz-date -20. &X-Amz-Signature=60d520ca0576c191b9eac8dbfe5617ebb6a6a9f3994d96437a102c0c2c80f88d -``` - -## Settings for PostgreSQL DB Instances - -The following table contains details about settings that you choose when you create a PostgreSQL DB instance\. - - -**** - -| Setting | Setting Description | -| --- | --- | -| Allocated storage | The amount of storage to allocate for your DB instance \(in gigabytes\)\. In some cases, allocating a higher amount of storage for your DB instance than the size of your database can improve I/O performance\. For more information, see [Amazon RDS DB Instance Storage](CHAP_Storage.md)\. | -| Auto minor version upgrade | **Enable auto minor version upgrade** to enable your DB instance to receive preferred minor DB engine version upgrades automatically when they become available\. Amazon RDS performs automatic minor version upgrades in the maintenance window\. | -| Availability zone | The Availability Zone for your DB instance\. Use the default value of **No Preference** unless you want to specify an Availability Zone\. For more information, see [Regions and Availability Zones](Concepts.RegionsAndAvailabilityZones.md)\. | -| Backup retention period | The number of days that you want automatic backups of your DB instance to be retained\. For any nontrivial DB instance, set this value to **1** or greater\. For more information, see [Working With Backups](USER_WorkingWithAutomatedBackups.md)\. | -| Backup window | The time period during which Amazon RDS automatically takes a backup of your DB instance\. Unless you have a specific time that you want to have your database backed up, use the default of **No Preference**\. For more information, see [Working With Backups](USER_WorkingWithAutomatedBackups.md)\. | -| Copy tags To snapshots | This option copies any DB instance tags to a DB snapshot when you create a snapshot\. For more information, see [Tagging Amazon RDS Resources](USER_Tagging.md)\. | -| Database authentication | The database authentication option you want to use\. Choose **Password authentication** to authenticate database users with database passwords only\. Choose **Password and IAM DB authentication** to authenticate database users with database passwords and user credentials through IAM users and roles\. For more information, see [IAM Database Authentication for MySQL and PostgreSQL](UsingWithRDS.IAMDBAuth.md)\. | -| Database name | The name for the database on your DB instance\. If you don't provide a name, Amazon RDS doesn't create a database on the DB instance\. This name has these constraints: [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_CreatePostgreSQLInstance.html) To create additional databases, connect to the DB instance and use the SQL command `CREATE DATABASE`\. For more information about connecting to the DB instance, see [Connecting to a DB Instance Running the PostgreSQL Database Engine](USER_ConnectToPostgreSQLInstance.md)\. | -| Database port | The port that you want to access the DB instance through\. PostgreSQL installations default to port 3306\. If you use a DB security group with your DB instance, this port value must be the same one you provided when creating the DB security group\. The firewalls at some companies block connections to the default PostgreSQL port\. If your company firewall blocks the default port, enter another port for your DB instance\. | -| DB engine version | The version of PostgreSQL that you want to use\. | -| DB instance class | The configuration for your DB instance\. If possible, choose an instance class large enough that a typical query working set can be held in memory\. When working sets are held in memory, the system can avoid writing to disk, and this improves performance\. For more information, see [DB Instance Classes](Concepts.DBInstanceClass.md)\. | -| DB instance identifier | The name for your DB instance\. Your DB instance identifier can contain up to 63 alphanumeric characters, and must be unique for your account in the AWS Region you chose\. You can add some intelligence to the name, such as including the AWS Region you chose, for example **postgresql\-instance1**\. | -| DB parameter group | A parameter group for your DB instance\. You can choose the default parameter group or you can create a custom parameter group\. For more information, see [Working with DB Parameter Groups](USER_WorkingWithParamGroups.md)\. | -| Deletion protection | **Enable deletion protection** to prevent your DB instance from being deleted\. If you create a production DB instance with the AWS Management Console, deletion protection is enabled by default\. For more information, see [Deleting a DB Instance](USER_DeleteInstance.md)\. | -| Encryption | **Enable Encryption** to enable encryption at rest for this DB instance\. For more information, see [Encrypting Amazon RDS Resources](Overview.Encryption.md)\. | -| Enhanced Monitoring | **Enable enhanced monitoring** to enable gathering metrics in real time for the operating system that your DB instance runs on\. For more information, see [Enhanced Monitoring](USER_Monitoring.OS.md)\. | -| License model | PostgreSQL has only one license model, `general-public-license`, the general license agreement for PostgreSQL\. | -| **Log exports** | The types of PostgreSQL database log files to generate\. For more information, see [PostgreSQL Database Log Files](USER_LogAccess.Concepts.PostgreSQL.md)\. | -| Maintenance window | The 30\-minute window in which pending modifications to your DB instance are applied\. If the time period doesn't matter, choose **No Preference**\. For more information, see [The Amazon RDS Maintenance Window](USER_UpgradeDBInstance.Maintenance.md#Concepts.DBMaintenance)\. | -| Master password | The password for your master user account\. The password must contain 8–128 printable ASCII characters \(excluding `/`,`"`, a space, and `@`\)\. | -| Master username | The name that you use as the master user name to log on to your DB instance: [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_CreatePostgreSQLInstance.html) For information on the default privileges granted to the master user name, see [Amazon RDS for PostgreSQL Versions and Extensions](CHAP_PostgreSQL.md#PostgreSQL.Concepts)\. | -| Multi\-AZ deployment | **Create a standby instance** to create a passive secondary replica of your DB instance in another Availability Zone for failover support\. We recommend Multi\-AZ for production workloads to maintain high availability\. For development and testing, you can choose **Do not create a standby instance**\. For more information, see [High Availability \(Multi\-AZ\) for Amazon RDS](Concepts.MultiAZ.md)\. | -| Option group | An option group for your DB instance\. You can choose the default option group or you can create a custom option group\. For more information, see [Working with Option Groups](USER_WorkingWithOptionGroups.md)\. | -| Performance Insights | **Enable Performance Insights** to monitor your DB instance load so that you can analyze and troubleshoot your database performance\. Choose a retention period to determine how much rolling data history to keep\. The default of seven days is in the free tier\. Long\-term retention \(two years\) is priced per vCPU per month\. Choose a master key to use to protect the key used to encrypt this database volume\. Choose from the master keys in your account, or enter the key from a different account\. For more information, see [Using Amazon RDS Performance Insights](USER_PerfInsights.md)\. | -| Publicly accessible | **Yes** to give the DB instance a public IP address, meaning that it's accessible outside the VPC\. To be publicly accessible, the DB instance also has to be in a public subnet in the VPC\. **No** to make the DB instance accessible only from inside the VPC\. For more information, see [Hiding a DB Instance in a VPC from the Internet](USER_VPC.WorkingWithRDSInstanceinaVPC.md#USER_VPC.Hiding)\. | -| Storage autoscaling | **Enable storage autoscaling** to enable Amazon RDS to automatically increase storage when needed to avoid having your DB instance run out of storage space\. Use **Maximum storage threshold** to set the upper limit for Amazon RDS to automatically increase storage for your DB instance\. The default is 1,000 GiB\. For more information, see [Managing Capacity Automatically with Amazon RDS Storage Autoscaling](USER_PIOPS.StorageTypes.md#USER_PIOPS.Autoscaling)\. | -| Storage type | The storage type for your DB instance\. For more information, see [Amazon RDS Storage Types](CHAP_Storage.md#Concepts.Storage)\. | -| Subnet group | This setting depends on the platform that you are on\. If you are a new customer to AWS, keep the subnet group set to **default**, which is the default DB subnet group that was created for your account\. If you are creating a DB instance on the earlier E2\-Classic platform, you might want your DB instance in a specific VPC\. In this case, choose the DB subnet group that you created for that VPC\. | -| Virtual Private Cloud \(VPC\) | This setting depends on the platform that you are on\. If you are a new customer to AWS, choose the default VPC shown\. If you are creating a DB instance on the earlier E2\-Classic platform that doesn't use a VPC, choose **Not in VPC**\. For more information, see [Amazon Virtual Private Cloud VPCs and Amazon RDS](USER_VPC.md)\. | -| VPC security groups | If you are a new customer to AWS, Create new to create a new VPC security group\. Otherwise, Choose existing, then choose from security groups that you previously created\.When you choose **Create new** in the RDS console, a new security group is created\. This new security group has an inbound rule that allows access to the DB instance from the IP address detected in your browser\.For more information, see [Working with DB Security Groups \(EC2\-Classic Platform\)](USER_WorkingWithSecurityGroups.md)\. | \ No newline at end of file diff --git a/doc_source/USER_CreateSnapshot.md b/doc_source/USER_CreateSnapshot.md deleted file mode 100644 index 84784c2..0000000 --- a/doc_source/USER_CreateSnapshot.md +++ /dev/null @@ -1,66 +0,0 @@ -# Creating a DB snapshot - -Amazon RDS creates a storage volume snapshot of your DB instance, backing up the entire DB instance and not just individual databases\. Creating this DB snapshot on a Single\-AZ DB instance results in a brief I/O suspension that can last from a few seconds to a few minutes, depending on the size and class of your DB instance\. For MariaDB, MySQL, Oracle, and PostgreSQL, I/O activity is not suspended on your primary during backup for Multi\-AZ deployments, because the backup is taken from the standby\. For SQL Server, I/O activity is suspended briefly during backup for Multi\-AZ deployments\. - -When you create a DB snapshot, you need to identify which DB instance you are going to back up, and then give your DB snapshot a name so you can restore from it later\. The amount of time it takes to create a snapshot varies with the size of your databases\. Since the snapshot includes the entire storage volume, the size of files, such as temporary files, also affects the amount of time it takes to create the snapshot\. - -**Note** -Your DB instance must be in the `available` state to take a DB snapshot\. -For PostgreSQL DB instances, data in unlogged tables might not be restored from snapshots\. For more information, see [Best practices for working with PostgreSQL](CHAP_BestPractices.md#CHAP_BestPractices.PostgreSQL)\. - -Unlike automated backups, manual snapshots aren't subject to the backup retention period\. Snapshots don't expire\. - -For very long\-term backups of MariaDB, MySQL, and PostgreSQL data, we recommend exporting snapshot data to Amazon S3\. If the major version of your DB engine is no longer supported, you can't restore to that version from a snapshot\. For more information, see [Exporting DB snapshot data to Amazon S3](USER_ExportSnapshot.md)\. - -You can create a DB snapshot using the AWS Management Console, the AWS CLI, or the RDS API\. - -## Console - -**To create a DB snapshot** - -1. Sign in to the AWS Management Console and open the Amazon RDS console at [https://console\.aws\.amazon\.com/rds/](https://console.aws.amazon.com/rds/)\. - -1. In the navigation pane, choose **Databases**\. - -1. In the list of DB instances, choose the DB instance for which you want to take a snapshot\. - -1. For **Actions**, choose **Take snapshot**\. - - The **Take DB snapshot** window appears\. - -1. Enter the name of the snapshot in the **Snapshot name** box\. -![\[Take DB snapshot\]](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/images/DBSnapshot.png) - -1. Choose **Take snapshot**\. - -The **Snapshots** page appears, with the new DB snapshot's status shown as `Creating`\. After its status is `Available`, you can see its creation time\. - -## AWS CLI - -When you create a DB snapshot using the AWS CLI, you need to identify which DB instance you are going to back up, and then give your DB snapshot a name so you can restore from it later\. You can do this by using the AWS CLI [https://docs.aws.amazon.com/cli/latest/reference/rds/create-db-snapshot.html](https://docs.aws.amazon.com/cli/latest/reference/rds/create-db-snapshot.html) command with the following parameters: -+ `--db-instance-identifier` -+ `--db-snapshot-identifier` - -In this example, you create a DB snapshot called *mydbsnapshot* for a DB instance called *mydbinstance*\. - -**Example** -For Linux, macOS, or Unix: - -``` -1. aws rds create-db-snapshot \ -2. --db-instance-identifier mydbinstance \ -3. --db-snapshot-identifier mydbsnapshot -``` -For Windows: - -``` -1. aws rds create-db-snapshot ^ -2. --db-instance-identifier mydbinstance ^ -3. --db-snapshot-identifier mydbsnapshot -``` - -## RDS API - -When you create a DB snapshot using the Amazon RDS API, you need to identify which DB instance you are going to back up, and then give your DB snapshot a name so you can restore from it later\. You can do this by using the Amazon RDS API [https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_CreateDBSnapshot.html](https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_CreateDBSnapshot.html) command with the following parameters: -+ `DBInstanceIdentifier` -+ `DBSnapshotIdentifier` \ No newline at end of file diff --git a/doc_source/USER_DeleteInstance.md b/doc_source/USER_DeleteInstance.md deleted file mode 100644 index bb31033..0000000 --- a/doc_source/USER_DeleteInstance.md +++ /dev/null @@ -1,120 +0,0 @@ -# Deleting a DB instance - -You can delete a DB instance using the AWS Management Console, the AWS CLI, or the RDS API\. If you want to delete a DB instance in an Aurora DB cluster, see [Deleting Aurora DB clusters and DB instances](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_DeleteCluster.html)\. - -**Topics** -+ [Prerequisites for deleting a DB instance](#USER_DeleteInstance.DeletionProtection) -+ [Considerations when deleting a DB instance](#USER_DeleteInstance.Snapshot) -+ [Deleting a DB instance](#USER_DeleteInstance.Deleting) - -## Prerequisites for deleting a DB instance - -Before you try to delete your DB instance, make sure that deletion protection is turned off\. By default, deletion protection is turned on for a DB instance that was created with the console\. - -If your DB instance has deletion protection turned on, you can turn it off by modifying your instance settings\. Choose **Modify** in the database details page or call the [modify\-db\-instance](https://docs.aws.amazon.com/cli/latest/reference/rds/modify-db-instance.html) command\. This operation doesn't cause an outage\. For more information, see [Settings for DB instances](Overview.DBInstance.Modifying.md#USER_ModifyInstance.Settings)\. - -## Considerations when deleting a DB instance - -Deleting a DB instance has an effect on instance recoverability, backup availability, and read replica status\. Consider the following issues: -+ You can choose whether to create a final DB snapshot\. You have the following options: - + If you take a final snapshot, you can use it to restore your deleted DB instance\. RDS retains both the final snapshot and any manual snapshots that you took previously\. You can't create a final DB snapshot of your DB instance if it has the status `creating`, `failed`, `incompatible-restore`, or `incompatible-network`\. For more information, see [Viewing Amazon RDS DB instance status](accessing-monitoring.md#Overview.DBInstance.Status)\. - + If you don't take a final snapshot, deletion is faster\. However, you can't use a final snapshot to restore your DB instance\. If you later decide to restore your deleted DB instance, either retain automated backups or use an earlier manual snapshot to restore your DB instance to the point in time of the snapshot\. -+ You can choose whether to retain automated backups\. You have the following options: - + If you retain automated backups, RDS keeps them for the retention period that is in effect for the DB instance at the time when you delete it\. You can use automated backups to restore your DB instance to a time during but not after your retention period\. The retention period is in effect regardless of whether you create a final DB snapshot\. To delete a retained automated backup, see [Deleting retained automated backups](USER_WorkingWithAutomatedBackups.md#USER_WorkingWithAutomatedBackups-Deleting)\. - + If you don't retain automated backups, RDS deletes the automated backups that reside in the same AWS Region as your DB instance\. You can't recover these backups\. If your automated backups have been replicated to another AWS Region, RDS keeps them even if you don't choose to retain automated backups\. For more information, see [Replicating automated backups to another AWS Region](USER_ReplicateBackups.md)\. -**Note** -Typically, if you create a final DB snapshot, you don't need to retain automated backups\. -+ When you delete your DB instance, RDS doesn't delete manual DB snapshots\. For more information, see [Creating a DB snapshot](USER_CreateSnapshot.md)\. -+ If you want to delete all RDS resources, note that the following resources incur billing charges: - + DB instances - + DB snapshots - + DB clusters - - If you purchased reserved instances, then they are billed according to contract that you agreed to when you purchased the instance\. For more information, see [Reserved DB instances for Amazon RDS](USER_WorkingWithReservedDBInstances.md)\. You can get billing information for all your AWS resources by using the AWS Cost Explorer\. For more information, see [Analyzing your costs with AWS Cost Explorer](https://docs.aws.amazon.com/cost-management/latest/userguide/ce-what-is.html)\. -+ If you delete a DB instance that has read replicas in the same AWS Region, each read replica is automatically promoted to a standalone DB instance\. For more information, see [Promoting a read replica to be a standalone DB instance](USER_ReadRepl.md#USER_ReadRepl.Promote)\. If your DB instance has read replicas in different AWS Regions, see [Cross\-Region replication considerations](USER_ReadRepl.md#USER_ReadRepl.XRgn.Cnsdr) for information related to deleting the source DB instance for a cross\-Region read replica\. -+ When the status for a DB instance is `deleting`, its CA certificate value doesn't appear in the RDS console or in output for AWS CLI commands or RDS API operations\. For more information about CA certificates, see [Using SSL/TLS to encrypt a connection to a DB instance](UsingWithRDS.SSL.md)\. -+ The time required to delete a DB instance varies depending on the backup retention period \(that is, how many backups to delete\), how much data is deleted, and whether a final snapshot is taken\. - -## Deleting a DB instance - -You can delete a DB instance using the AWS Management Console, the AWS CLI, or the RDS API\. You must do the following: -+ Provide the name of the DB instance -+ Enable or disable the option to take a final DB snapshot of the instance -+ Enable or disable the option to retain automated backups - -**Note** -You can't delete a DB instance when deletion protection is turned on\. For more information, see [Prerequisites for deleting a DB instance](#USER_DeleteInstance.DeletionProtection)\. - -### Console - -**To delete a DB instance** - -1. Sign in to the AWS Management Console and open the Amazon RDS console at [https://console\.aws\.amazon\.com/rds/](https://console.aws.amazon.com/rds/)\. - -1. In the navigation pane, choose **Databases**, and then choose the DB instance that you want to delete\. - -1. For **Actions**, choose **Delete**\. - -1. To create a final DB snapshot for the DB instance, choose **Create final snapshot?**\. - -1. If you chose to create a final snapshot, enter the **Final snapshot name**\. - -1. To retain automated backups, choose **Retain automated backups**\. - -1. Enter **delete me** in the box\. - -1. Choose **Delete**\. - -### AWS CLI - -To find the instance IDs of the DB instances in your account, call the [describe\-db\-instances](https://docs.aws.amazon.com/cli/latest/reference/rds/describe-db-instances.html) command: - -``` -aws rds describe-db-instances --query 'DBInstances[*].[DBInstanceIdentifier]' --output text -``` - -To delete a DB instance by using the AWS CLI, call the [delete\-db\-instance](https://docs.aws.amazon.com/cli/latest/reference/rds/delete-db-instance.html) command with the following options: -+ `--db-instance-identifier` -+ `--final-db-snapshot-identifier` or `--skip-final-snapshot` - -**Example With a final snapshot and no retained automated backups** -For Linux, macOS, or Unix: - -``` -aws rds delete-db-instance \ - --db-instance-identifier mydbinstance \ - --final-db-snapshot-identifier mydbinstancefinalsnapshot \ - --delete-automated-backups -``` -For Windows: - -``` -aws rds delete-db-instance ^ - --db-instance-identifier mydbinstance ^ - --final-db-snapshot-identifier mydbinstancefinalsnapshot ^ - --delete-automated-backups -``` - -**Example With retained automated backups and no final snapshot** -For Linux, macOS, or Unix: - -``` -aws rds delete-db-instance \ - --db-instance-identifier mydbinstance \ - --skip-final-snapshot \ - --no-delete-automated-backups -``` -For Windows: - -``` -aws rds delete-db-instance ^ - --db-instance-identifier mydbinstance ^ - --skip-final-snapshot ^ - --no-delete-automated-backups -``` - -### RDS API - -To delete a DB instance by using the Amazon RDS API, call the [https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_DeleteDBInstance.html](https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_DeleteDBInstance.html) operation with the following parameters: -+ `DBInstanceIdentifier` -+ `FinalDBSnapshotIdentifier` or `SkipFinalSnapshot` \ No newline at end of file diff --git a/doc_source/USER_DeleteMultiAZDBCluster.Deleting.md b/doc_source/USER_DeleteMultiAZDBCluster.Deleting.md deleted file mode 100644 index e4beb36..0000000 --- a/doc_source/USER_DeleteMultiAZDBCluster.Deleting.md +++ /dev/null @@ -1,71 +0,0 @@ -# Deleting a Multi\-AZ DB cluster - -You can delete a DB Multi\-AZ DB cluster using the AWS Management Console, the AWS CLI, or the RDS API\. - -The time required to delete a Multi\-AZ DB cluster can vary depending on certain factors\. These are the backup retention period \(that is, how many backups to delete\), how much data is deleted, and whether a final snapshot is taken\. - -You can't delete a Multi\-AZ DB cluster when deletion protection is turned on for it\. For more information, see [Prerequisites for deleting a DB instance](USER_DeleteInstance.md#USER_DeleteInstance.DeletionProtection)\. You can turn off deletion protection by modifying the Multi\-AZ DB cluster\. For more information, see [Modifying a Multi\-AZ DB cluster](modify-multi-az-db-cluster.md)\. - -## Console - -**To delete a Multi\-AZ DB cluster** - -1. Sign in to the AWS Management Console and open the Amazon RDS console at [https://console\.aws\.amazon\.com/rds/](https://console.aws.amazon.com/rds/)\. - -1. In the navigation pane, choose **Databases**, and then choose the Multi\-AZ DB cluster that you want to delete\. - -1. For **Actions**, choose **Delete**\. - -1. Choose **Create final snapshot?** to create a final DB snapshot for the Multi\-AZ DB cluster\. - - If you create a final snapshot, enter a name for **Final snapshot name**\. - -1. Choose **Retain automated backups** to retain automated backups\. - -1. Enter **delete me** in the box\. - -1. Choose **Delete**\. - -## AWS CLI - -To delete a Multi\-AZ DB cluster by using the AWS CLI, call the [delete\-db\-cluster](https://docs.aws.amazon.com/cli/latest/reference/rds/delete-db-cluster.html) command with the following options: -+ `--db-cluster-identifier` -+ `--final-db-snapshot-identifier` or `--skip-final-snapshot` - -**Example With a final snapshot** -For Linux, macOS, or Unix: - -``` -aws rds delete-db-cluster \ - --db-cluster-identifier mymultiazdbcluster \ - --final-db-snapshot-identifier mymultiazdbclusterfinalsnapshot -``` -For Windows: - -``` -aws rds delete-db-cluster ^ - --db-cluster-identifier mymultiazdbcluster ^ - --final-db-snapshot-identifier mymultiazdbclusterfinalsnapshot -``` - -**Example With no final snapshot** -For Linux, macOS, or Unix: - -``` -aws rds delete-db-cluster \ - --db-cluster-identifier mymultiazdbcluster \ - --skip-final-snapshot -``` -For Windows: - -``` -aws rds delete-db-cluster ^ - --db-cluster-identifier mymultiazdbcluster ^ - --skip-final-snapshot -``` - -## RDS API - -To delete a Multi\-AZ DB cluster by using the Amazon RDS API, call the [DeleteDBCluster](https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_DeleteDBCluster.html) operation with the following parameters: -+ `DBClusterIdentifier` -+ `FinalDBSnapshotIdentifier` or `SkipFinalSnapshot` \ No newline at end of file diff --git a/doc_source/USER_DeleteSnapshot.md b/doc_source/USER_DeleteSnapshot.md deleted file mode 100644 index 27c8a29..0000000 --- a/doc_source/USER_DeleteSnapshot.md +++ /dev/null @@ -1,63 +0,0 @@ -# Deleting a DB snapshot - -You can delete DB snapshots managed by Amazon RDS when you no longer need them\. - -**Note** -To delete backups managed by AWS Backup, use the AWS Backup console\. For information about AWS Backup, see the [https://docs.aws.amazon.com/aws-backup/latest/devguide](https://docs.aws.amazon.com/aws-backup/latest/devguide)\. - -## Deleting a DB snapshot - -You can delete a manual, shared, or public DB snapshot using the AWS Management Console, the AWS CLI, or the RDS API\. - -To delete a shared or public snapshot, you must sign in to the AWS account that owns the snapshot\. - -If you have automated DB snapshots that you want to delete without deleting the DB instance, change the backup retention period for the DB instance to 0\. The automated snapshots are deleted when the change is applied\. You can apply the change immediately if you don't want to wait until the next maintenance period\. After the change is complete, you can then re\-enable automatic backups by setting the backup retention period to a number greater than 0\. For information about modifying a DB instance, see [Modifying an Amazon RDS DB instance](Overview.DBInstance.Modifying.md)\. - -If you deleted a DB instance, you can delete its automated DB snapshots by removing the automated backups for the DB instance\. For information about automated backups, see [Working with backups](USER_WorkingWithAutomatedBackups.md)\. - -### Console - -**To delete a DB snapshot** - -1. Sign in to the AWS Management Console and open the Amazon RDS console at [https://console\.aws\.amazon\.com/rds/](https://console.aws.amazon.com/rds/)\. - -1. In the navigation pane, choose **Snapshots**\. - - The **Manual snapshots** list appears\. - -1. Choose the DB snapshot that you want to delete\. - -1. For **Actions**, choose **Delete snapshot**\. -![\[Delete snapshot\]](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/images/delete-snapshot.png) - -1. Choose **Delete** on the confirmation page\. -![\[Confirm snapshot deletion\]](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/images/delete-snapshot-confirm.png) - -### AWS CLI - -You can delete a DB snapshot by using the AWS CLI command [delete\-db\-snapshot](https://docs.aws.amazon.com/cli/latest/reference/rds/delete-db-snapshot.html)\. - -The following options are used to delete a DB snapshot\. -+ `--db-snapshot-identifier` – The identifier for the DB snapshot\. - -**Example** -The following code deletes the `mydbsnapshot` DB snapshot\. -For Linux, macOS, or Unix: - -``` -1. aws rds delete-db-snapshot \ -2. --db-snapshot-identifier mydbsnapshot -``` -For Windows: - -``` -1. aws rds delete-db-snapshot ^ -2. --db-snapshot-identifier mydbsnapshot -``` - -### RDS API - -You can delete a DB snapshot by using the Amazon RDS API operation [DeleteDBSnapshot](https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_DeleteDBSnapshot.html)\. - -The following parameters are used to delete a DB snapshot\. -+ `DBSnapshotIdentifier` – The identifier for the DB snapshot\. \ No newline at end of file diff --git a/doc_source/USER_Endpoint.md b/doc_source/USER_Endpoint.md deleted file mode 100644 index 39bab37..0000000 --- a/doc_source/USER_Endpoint.md +++ /dev/null @@ -1,47 +0,0 @@ -# Finding the endpoint of your Oracle DB instance - -Each Amazon RDS DB instance has an endpoint, and each endpoint has the DNS name and port number for the DB instance\. To connect to your DB instance using a SQL client application, you need the DNS name and port number for your DB instance\. - -You can find the endpoint for a DB instance using the Amazon RDS console or the AWS CLI\. - -**Note** -If you are using Kerberos authentication, see [Connecting to Oracle with Kerberos authentication](oracle-kerberos-connecting.md)\. - -## Console - -**To find the endpoint using the console** - -1. Sign in to the AWS Management Console and open the Amazon RDS console at [https://console\.aws\.amazon\.com/rds/](https://console.aws.amazon.com/rds/)\. - -1. In the upper\-right corner of the console, choose the AWS Region of your DB instance\. - -1. Find the DNS name and port number for your DB Instance\. - - 1. Choose **Databases** to display a list of your DB instances\. - - 1. Choose the Oracle DB instance name to display the instance details\. - - 1. On the **Connectivity & security** tab, copy the endpoint\. Also, note the port number\. You need both the endpoint and the port number to connect to the DB instance\. -![\[Locate DB instance endpoint and port\]](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/images/OracleConnect1.png) - -## AWS CLI - -To find the endpoint of an Oracle DB instance by using the AWS CLI, call the [describe\-db\-instances](https://docs.aws.amazon.com/cli/latest/reference/rds/describe-db-instances.html) command\. - -**Example To find the endpoint using the AWS CLI** - -``` -1. aws rds describe-db-instances -``` -Search for `Endpoint` in the output to find the DNS name and port number for your DB instance\. The `Address` line in the output contains the DNS name\. The following is an example of the JSON endpoint output\. - -``` -"Endpoint": { - "HostedZoneId": "Z1PVIF0B656C1W", - "Port": 3306, - "Address": "myinstance.123456789012.us-west-2.rds.amazonaws.com" -}, -``` - -**Note** -The output might contain information for multiple DB instances\. \ No newline at end of file diff --git a/doc_source/USER_Events.AddingSource.md b/doc_source/USER_Events.AddingSource.md deleted file mode 100644 index b1638b9..0000000 --- a/doc_source/USER_Events.AddingSource.md +++ /dev/null @@ -1,36 +0,0 @@ -# Adding a source identifier to an Amazon RDS event notification subscription - -You can add a source identifier \(the Amazon RDS source generating the event\) to an existing subscription\. - -## Console - -You can easily add or remove source identifiers using the Amazon RDS console by selecting or deselecting them when modifying a subscription\. For more information, see [Modifying an Amazon RDS event notification subscription](USER_Events.Modifying.md)\. - -## AWS CLI - -To add a source identifier to an Amazon RDS event notification subscription, use the AWS CLI [https://docs.aws.amazon.com/](https://docs.aws.amazon.com/) command\. Include the following required parameters: -+ `--subscription-name` -+ `--source-identifier` - -**Example** -The following example adds the source identifier `mysqldb` to the `myrdseventsubscription` subscription\. -For Linux, macOS, or Unix: - -``` -aws rds add-source-identifier-to-subscription \ - --subscription-name myrdseventsubscription \ - --source-identifier mysqldb -``` -For Windows: - -``` -aws rds add-source-identifier-to-subscription ^ - --subscription-name myrdseventsubscription ^ - --source-identifier mysqldb -``` - -## API - -To add a source identifier to an Amazon RDS event notification subscription, call the Amazon RDS API [https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_AddSourceIdentifierToSubscription.html](https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_AddSourceIdentifierToSubscription.html)\. Include the following required parameters: -+ `SubscriptionName` -+ `SourceIdentifier` \ No newline at end of file diff --git a/doc_source/USER_Events.Deleting.md b/doc_source/USER_Events.Deleting.md deleted file mode 100644 index 7c25b7b..0000000 --- a/doc_source/USER_Events.Deleting.md +++ /dev/null @@ -1,37 +0,0 @@ -# Deleting an Amazon RDS event notification subscription - -You can delete a subscription when you no longer need it\. All subscribers to the topic will no longer receive event notifications specified by the subscription\. - -## Console - -**To delete an Amazon RDS event notification subscription** - -1. Sign in to the AWS Management Console and open the Amazon RDS console at [https://console\.aws\.amazon\.com/rds/](https://console.aws.amazon.com/rds/)\. - -1. In the navigation pane, choose **DB Event Subscriptions**\. - -1. In the **My DB Event Subscriptions** pane, choose the subscription that you want to delete\. - -1. Choose **Delete**\. - -1. The Amazon RDS console indicates that the subscription is being deleted\. -![\[Delete an event notification subscription\]](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/images/EventNotification-Delete.png) - - - -## AWS CLI - -To delete an Amazon RDS event notification subscription, use the AWS CLI [https://docs.aws.amazon.com/cli/latest/reference/rds/delete-event-subscription.html](https://docs.aws.amazon.com/cli/latest/reference/rds/delete-event-subscription.html) command\. Include the following required parameter: -+ `--subscription-name` - -**Example** -The following example deletes the subscription `myrdssubscription`\. - -``` -aws rds delete-event-subscription --subscription-name myrdssubscription -``` - -## API - -To delete an Amazon RDS event notification subscription, use the RDS API [https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_DeleteEventSubscription.html](https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_DeleteEventSubscription.html) command\. Include the following required parameter: -+ `SubscriptionName` \ No newline at end of file diff --git a/doc_source/USER_Events.GrantingPermissions.md b/doc_source/USER_Events.GrantingPermissions.md deleted file mode 100644 index 2c55131..0000000 --- a/doc_source/USER_Events.GrantingPermissions.md +++ /dev/null @@ -1,38 +0,0 @@ -# Granting permissions to publish notifications to an Amazon SNS topic - -To grant Amazon RDS permissions to publish notifications to an Amazon Simple Notification Service \(Amazon SNS\) topic, attach an AWS Identity and Access Management \(IAM\) policy to the destination topic\. For more information about permissions, see [ Example cases for Amazon Simple Notification Service access control](https://docs.aws.amazon.com/sns/latest/dg/sns-access-policy-use-cases.html) in the *Amazon Simple Notification Service Developer Guide*\. - -By default, an Amazon SNS topic has a policy allowing all Amazon RDS resources within the same account to publish notifications to it\. You can attach a custom policy to allow cross\-account notifications, or to restrict access to certain resources\. - -The following is an example of an IAM policy that you attach to the destination Amazon SNS topic\. It restricts the topic to DB instances with names that match the specified prefix\. To use this policy, specify the following values: -+ `Resource` – The Amazon Resource Name \(ARN\) for your Amazon SNS topic -+ `SourceARN` – Your RDS resource ARN -+ `SourceAccount` – Your AWS account ID - -To see a list of resource types and their ARNs, see [Resources Defined by Amazon RDS](https://docs.aws.amazon.com/service-authorization/latest/reference/list_amazonrds.html#amazonrds-resources-for-iam-policies) in the *Service Authorization Reference*\. - -``` -{ - "Version": "2008-10-17", - "Statement": [ - { - "Effect": "Allow", - "Principal": { - "Service": "events.rds.amazonaws.com" - }, - "Action": [ - "sns:Publish" - ], - "Resource": "arn:aws:sns:us-east-1:123456789012:topic_name", - "Condition": { - "ArnLike": { - "aws:SourceArn": "arn:aws:rds:us-east-1:123456789012:db:prefix-*" - }, - "StringEquals": { - "aws:SourceAccount": "123456789012" - } - } - } - ] -} -``` \ No newline at end of file diff --git a/doc_source/USER_Events.ListSubscription.md b/doc_source/USER_Events.ListSubscription.md deleted file mode 100644 index 059e115..0000000 --- a/doc_source/USER_Events.ListSubscription.md +++ /dev/null @@ -1,34 +0,0 @@ -# Listing Amazon RDS event notification subscriptions - -You can list your current Amazon RDS event notification subscriptions\. - -## Console - -**To list your current Amazon RDS event notification subscriptions** - -1. Sign in to the AWS Management Console and open the Amazon RDS console at [https://console\.aws\.amazon\.com/rds/](https://console.aws.amazon.com/rds/)\. - -1. In the navigation pane, choose **Event subscriptions**\. The **Event subscriptions** pane shows all your event notification subscriptions\. -![\[List DB event notification subscriptions\]](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/images/EventNotification-ListSubs.png) - - - -## AWS CLI - -To list your current Amazon RDS event notification subscriptions, use the AWS CLI [https://docs.aws.amazon.com/cli/latest/reference/rds/describe-event-subscriptions.html](https://docs.aws.amazon.com/cli/latest/reference/rds/describe-event-subscriptions.html) command\. - -**Example** -The following example describes all event subscriptions\. - -``` -aws rds describe-event-subscriptions -``` -The following example describes the `myfirsteventsubscription`\. - -``` -aws rds describe-event-subscriptions --subscription-name myfirsteventsubscription -``` - -## API - -To list your current Amazon RDS event notification subscriptions, call the Amazon RDS API [https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_DescribeEventSubscriptions.html](https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_DescribeEventSubscriptions.html) action\. \ No newline at end of file diff --git a/doc_source/USER_Events.ListingCategories.md b/doc_source/USER_Events.ListingCategories.md deleted file mode 100644 index ebe5cb9..0000000 --- a/doc_source/USER_Events.ListingCategories.md +++ /dev/null @@ -1,25 +0,0 @@ -# Listing the Amazon RDS event notification categories - -All events for a resource type are grouped into categories\. To view the list of categories available, use the following procedures\. - -## Console - -When you create or modify an event notification subscription, the event categories are displayed in the Amazon RDS console\. For more information, see [Modifying an Amazon RDS event notification subscription](USER_Events.Modifying.md)\. - -![\[List DB event notification categories\]](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/images/EventNotification-Categories.png) - - - -## AWS CLI - -To list the Amazon RDS event notification categories, use the AWS CLI [https://docs.aws.amazon.com/cli/latest/reference/rds/describe-event-categories.html](https://docs.aws.amazon.com/cli/latest/reference/rds/describe-event-categories.html) command\. This command has no required parameters\. - -**Example** - -``` -aws rds describe-event-categories -``` - -## API - -To list the Amazon RDS event notification categories, use the Amazon RDS API [https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_DescribeEventCategories.html](https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_DescribeEventCategories.html) command\. This command has no required parameters\. \ No newline at end of file diff --git a/doc_source/USER_Events.Messages.md b/doc_source/USER_Events.Messages.md deleted file mode 100644 index 40a31d7..0000000 --- a/doc_source/USER_Events.Messages.md +++ /dev/null @@ -1,273 +0,0 @@ -# Amazon RDS event categories and event messages - -Amazon RDS generates a significant number of events in categories that you can subscribe to using the Amazon RDS Console, AWS CLI, or the API\. - -**Topics** -+ [DB cluster events](#USER_Events.Messages.cluster) -+ [DB instance events](#USER_Events.Messages.instance) -+ [DB parameter group events](#USER_Events.Messages.parameter-group) -+ [DB security group events](#USER_Events.Messages.security-group) -+ [DB snapshot events](#USER_Events.Messages.snapshot) -+ [DB cluster snapshot events](#USER_Events.Messages.cluster-snapshot) -+ [RDS Proxy events](#USER_Events.Messages.rds-proxy) -+ [Blue/green deployment events](#USER_Events.Messages.BlueGreenDeployments) -+ [Custom engine version events](#USER_Events.Messages.CEV) - -## DB cluster events - -The following table shows the event category and a list of events when a DB cluster is the source type\. - -For more information about Multi\-AZ DB cluster deployments, see [Multi\-AZ DB cluster deployments](multi-az-db-clusters-concepts.md) - - -| Category | RDS event ID | Message | Notes | -| --- | --- | --- | --- | -| creation | RDS\-EVENT\-0170 | DB cluster created\. | | -| failover | RDS\-EVENT\-0069 | Cluster failover failed, check the health of your cluster instances and try again\. | | -| failover | RDS\-EVENT\-0070 | Promoting previous primary again: *name*\. | | -| failover | RDS\-EVENT\-0071 | Completed failover to DB instance: *name*\. | | -| failover | RDS\-EVENT\-0072 | Started same AZ failover to DB instance: *name*\. | | -| failover | RDS\-EVENT\-0073 | Started cross AZ failover to DB instance: *name*\. | | -| global failover | RDS\-EVENT\-0181 | Global failover to DB cluster *name* in Region *name* started\. | The process can be delayed because other operations are running on the DB cluster\. | -| global failover | RDS\-EVENT\-0182 | Old primary DB cluster *name* in Region *name* successfully shut down\. | The old primary instance in the global database isn't accepting writes\. All volumes are synchronized\. | -| global failover | RDS\-EVENT\-0183 | Waiting for data synchronization across global cluster members\. Current lags behind primary DB cluster: *reason*\. | A replication lag is occurring during the synchronization phase of the global database failover\. | -| global failover | RDS\-EVENT\-0184 | New primary DB cluster *name* in Region *name* was successfully promoted\. | The volume topology of the global database is reestablished with the new primary volume\. | -| global failover | RDS\-EVENT\-0185 | Global failover to DB cluster *name* in Region *name* finished\. | The global database failover is finished on the primary DB cluster\. Replicas might take long to come online after the failover completes\. | -| global failover | RDS\-EVENT\-0186 | Global failover to DB cluster *name* in Region *name* is cancelled\. | | -| global failover | RDS\-EVENT\-0187 | Global failover to DB cluster *name* in Region *name* failed\. | | -| maintenance | RDS\-EVENT\-0176 | Database cluster engine major version has been upgraded\. | | -| maintenance | RDS\-EVENT\-0286 | Database cluster engine version upgrade started\. | | -| maintenance | RDS\-EVENT\-0287 | Operating system upgrade requirement detected\. | | -| maintenance | RDS\-EVENT\-0288 | Cluster operating system upgrade starting\. | | -| maintenance | RDS\-EVENT\-0289 | Cluster operating system upgrade completed\. | | -| maintenance | RDS\-EVENT\-0290 | Database cluster has been patched: source version *version\_number* => *new\_version\_number*\. | | -| notification | RDS\-EVENT\-0172 | Renamed cluster from *name* to *name*\. | | - -## DB instance events - -The following table shows the event category and a list of events when a DB instance is the source type\. - - -| Category | RDS event ID | Message | Notes | -| --- | --- | --- | --- | -| availability | RDS\-EVENT\-0006 | DB instance restarted\. | | -| availability | RDS\-EVENT\-0004 | DB instance shutdown\. | | -| availability | RDS\-EVENT\-0022 | Error restarting mysql: *message*\. | An error has occurred while restarting MySQL\. | -| availability | RDS\-EVENT\-0221 | DB instance has reached the storage\-full threshold, and the database has been shut down\. You can increase the allocated storage to address this issue\. | | -| availability | RDS\-EVENT\-0222 | Free storage capacity for DB instance *name* is low at *percentage* of the allocated storage \[Allocated storage: *amount*, Free storage: *amount*\]\. The database will be shut down to prevent corruption if free storage is lower than *amount*\. You can increase the allocated storage to address this issue\. | | -| backup | RDS\-EVENT\-0001 | Backing up DB instance\. | | -| backup | RDS\-EVENT\-0002 | Finished DB instance backup\. | | -| backup | RDS\-EVENT\-0086 | We are unable to associate the option group *name* with the database instance *name*\. Confirm that option group *name* is supported on your DB instance class and configuration\. If so, verify all option group settings and retry\. | For more information see [Working with option groups](USER_WorkingWithOptionGroups.md)\. | -| configuration change | RDS\-EVENT\-0009 | Added security group *name* to DB instance\. | | -| configuration change | RDS\-EVENT\-0024 | Applying modification to convert to a Multi\-AZ DB instance\. | | -| configuration change | RDS\-EVENT\-0030 | Applying modification to convert to a standard \(Single\-AZ\) DB instance\. | | -| configuration change | RDS\-EVENT\-0012 | Applying modification to database instance class\. | | -| configuration change | RDS\-EVENT\-0018 | Applying modification to allocated storage\. | | -| configuration change | RDS\-EVENT\-0011 | Updated to use DBParameterGroup *name*\. | | -| configuration change | RDS\-EVENT\-0092 | Finished updating DB parameter group\. | | -| configuration change | RDS\-EVENT\-0028 | Disabled automated backups\. | | -| configuration change | RDS\-EVENT\-0032 | Enabled automated backups\. | | -| configuration change | RDS\-EVENT\-0033 | There are *number* users matching the master username; only resetting the one not tied to a specific host\. | | -| configuration change | RDS\-EVENT\-0025 | Finished applying modification to convert to a Multi\-AZ DB instance\. | | -| configuration change | RDS\-EVENT\-0029 | Finished applying modification to convert to a standard \(Single\-AZ\) DB instance\. | | -| configuration change | RDS\-EVENT\-0014 | Finished applying modification to DB instance class\. | | -| configuration change | RDS\-EVENT\-0017 | Finished applying modification to allocated storage\. | | -| configuration change | RDS\-EVENT\-0010 | Removed security group *name* from DB instance\. | | -| configuration change | RDS\-EVENT\-0016 | Reset master credentials\. | | -| configuration change | RDS\-EVENT\-0067 | Unable to reset your password\. Error information: *message*\. | | -| configuration change | RDS\-EVENT\-0078 | Monitoring Interval changed to *number*\. | The Enhanced Monitoring configuration has been changed\. | -| configuration change | RDS\-EVENT\-0217 | Applying autoscaling\-initiated modification to allocated storage\. | | -| configuration change | RDS\-EVENT\-0218 | Finished applying autoscaling\-initiated modification to allocated storage\. | | -| creation | RDS\-EVENT\-0005 | DB instance created\. | | -| deletion | RDS\-EVENT\-0003 | DB instance deleted\. | | -| failover | RDS\-EVENT\-0013 | Multi\-AZ instance failover started\. | A Multi\-AZ failover that resulted in the promotion of a standby DB instance has started\. | -| failover | RDS\-EVENT\-0015 | Multi\-AZ failover to standby complete \- DNS propagation may take a few minutes\. | A Multi\-AZ failover that resulted in the promotion of a standby DB instance is complete\. It may take several minutes for the DNS to transfer to the new primary DB instance\. | -| failover | RDS\-EVENT\-0034 | Abandoning user requested failover since a failover recently occurred on the database instance\. | Amazon RDS isn't attempting a requested failover because a failover recently occurred on the DB instance\. | -| failover | RDS\-EVENT\-0049 | Multi\-AZ instance failover completed\. | | -| failover | RDS\-EVENT\-0050 | Multi\-AZ instance activation started\. | A Multi\-AZ activation has started after a successful DB instance recovery | -| failover | RDS\-EVENT\-0051 | Multi\-AZ instance activation completed\. | A Multi\-AZ activation is complete\. Your database should be accessible now\. | -| failover | RDS\-EVENT\-0065 | Recovered from partial failover\. | | -| failure | RDS\-EVENT\-0031 | DB instance put into *name* state\. RDS recommends that you initiate a point\-in\-time\-restore\. | The DB instance has failed due to an incompatible configuration or an underlying storage issue\. Begin a point\-in\-time\-restore for the DB instance\. | -| failure | RDS\-EVENT\-0035 | Database instance put into *state*\. *message*\. | The DB instance has invalid parameters\. For example, if the DB instance could not start because a memory\-related parameter is set too high for this instance class, your action would be to modify the memory parameter and reboot the DB instance\. | -| failure | RDS\-EVENT\-0036 | Database instance in *state*\. *message*\. | The DB instance is in an incompatible network\. Some of the specified subnet IDs are invalid or do not exist\. | -| failure | RDS\-EVENT\-0058 | The Statspack installation failed\. *message*\. | Error while creating Oracle Statspack user account `PERFSTAT`\. Drop the account before you add the `STATSPACK` option\. | -| failure | RDS\-EVENT\-0079 | Amazon RDS has been unable to create credentials for enhanced monitoring and this feature has been disabled\. This is likely due to the rds\-monitoring\-role not being present and configured correctly in your account\. Please refer to the troubleshooting section in the Amazon RDS documentation for further details\. | Enhanced Monitoring can't be enabled without the Enhanced Monitoring IAM role\. For information about creating the IAM role, see [To create an IAM role for Amazon RDS enhanced monitoring](USER_Monitoring.OS.Enabling.md#USER_Monitoring.OS.IAMRole)\. | -| failure | RDS\-EVENT\-0080 | Amazon RDS has been unable to configure enhanced monitoring on your instance: *name* and this feature has been disabled\. This is likely due to the rds\-monitoring\-role not being present and configured correctly in your account\. Please refer to the troubleshooting section in the Amazon RDS documentation for further details\. | Enhanced Monitoring was disabled because an error occurred during the configuration change\. It is likely that the Enhanced Monitoring IAM role is configured incorrectly\. For information about creating the enhanced monitoring IAM role, see [To create an IAM role for Amazon RDS enhanced monitoring](USER_Monitoring.OS.Enabling.md#USER_Monitoring.OS.IAMRole)\. | -| failure | RDS\-EVENT\-0081 | Amazon RDS has been unable to create credentials for *name* option\. This is due to the *name* IAM role not being configured correctly in your account\. Please refer to the troubleshooting section in the Amazon RDS documentation for further details\. | The IAM role that you use to access your Amazon S3 bucket for SQL Server native backup and restore is configured incorrectly\. For more information, see [Setting up for native backup and restore](SQLServer.Procedural.Importing.md#SQLServer.Procedural.Importing.Native.Enabling)\. | -| failure | RDS\-EVENT\-0165 | The RDS Custom DB instance is outside the support perimeter\. | It's your responsibility to fix configuration issues that put your RDS Custom DB instance into the `unsupported-configuration` state\. If the issue is with the AWS infrastructure, you can use the console or the AWS CLI to fix it\. If the issue is with the operating system or the database configuration, you can log in to the host to fix it\.For more information, see [RDS Custom support perimeter and unsupported configurations](custom-troubleshooting.md#custom-troubleshooting.support-perimeter)\. | -| failure | RDS\-EVENT\-0188 | The DB instance is in a state that can't be upgraded\. *message* | Amazon RDS was unable to upgrade a MySQL DB instance from version 5\.7 to version 8\.0 because of incompatibilities related to the data dictionary\. The DB instance was rolled back to MySQL version 5\.7\. For more information, see [Rollback after failure to upgrade from MySQL 5\.7 to 8\.0](USER_UpgradeDBInstance.MySQL.md#USER_UpgradeDBInstance.MySQL.Major.RollbackAfterFailure)\. | -| failure | RDS\-EVENT\-0219 | DB instance is in an invalid state\. No actions are necessary\. Autoscaling will retry later\. | | -| failure | RDS\-EVENT\-0220 | DB instance is in the cooling\-off period for a previous scale storage operation\. We're optimizing your DB instance\. This takes at least 6 hours\. No actions are necessary\. Autoscaling will retry after the cooling\-off period\. | | -| failure | RDS\-EVENT\-0223 | Storage autoscaling is unable to scale the storage for the reason: *reason*\. | | -| failure | RDS\-EVENT\-0224 | Storage autoscaling has triggered a pending scale storage task that will reach or exceed the maximum storage threshold\. Increase the maximum storage threshold\. | | -| failure | RDS\-EVENT\-0237 | DB instance has a storage type that's currently unavailable in the Availability Zone\. Autoscaling will retry later\. | | -| failure | RDS\-EVENT\-0254 | Underlying storage quota for this customer account has exceeded the limit\. Please increase the allowed storage quota to let the scaling go through on the instance\. | | -| failure | RDS\-EVENT\-0278 | The DB instance creation failed\. *message* | The *message* includes details about the failure\. | -| failure | RDS\-EVENT\-0279 | The promotion of the RDS Custom read replica failed\. *message* | The *message* includes details about the failure\. | -| failure | RDS\-EVENT\-0280 | RDS Custom couldn't upgrade the DB instance because the pre\-check failed\. *message* | The *message* includes details about the failure\. | -| failure | RDS\-EVENT\-0281 | RDS Custom couldn't modify the DB instance because the pre\-check failed\. *message* | The *message* includes details about the failure\. | -| failure | RDS\-EVENT\-0282 | RDS Custom couldn't modify the DB instance because the Elastic IP permissions aren't correct\. Please confirm the Elastic IP address is tagged with `AWSRDSCustom`\. | | -| failure | RDS\-EVENT\-0283 | RDS Custom couldn't modify the DB instance because the Elastic IP limit has been reached in your account\. Release unused Elastic IPs or request a quota increase for your Elastic IP address limit\. | | -| failure | RDS\-EVENT\-0284 | RDS Custom couldn't convert the instance to high availability because the pre\-check failed\. *message* | The *message* includes details about the failure\. | -| failure | RDS\-EVENT\-0285 | RDS Custom couldn't create a final snapshot for the DB instance because *message*\. | The *message* includes details about the failure\. | -| low storage | RDS\-EVENT\-0007 | Allocated storage has been exhausted\. Allocate additional storage to resolve\. | The allocated storage for the DB instance has been consumed\. To resolve this issue, allocate additional storage for the DB instance\. For more information, see the [RDS FAQ](https://aws.amazon.com/rds/faqs)\. You can monitor the storage space for a DB instance using the **Free Storage Space** metric\. | -| low storage | RDS\-EVENT\-0089 | The free storage capacity for DB instance: *name* is low at *percentage* of the provisioned storage \[Provisioned Storage: *size*, Free Storage: *size*\]\. You may want to increase the provisioned storage to address this issue\. | The DB instance has consumed more than 90% of its allocated storage\. You can monitor the storage space for a DB instance using the **Free Storage Space** metric\. | -| low storage | RDS\-EVENT\-0227 | Your Aurora cluster's storage is dangerously low with only *amount* terabytes remaining\. Please take measures to reduce the storage load on your cluster\. | The Aurora storage subsystem is running low on space\. | -| maintenance | RDS\-EVENT\-0026 | Applying off\-line patches to DB instance\. | Offline maintenance of the DB instance is taking place\. The DB instance is currently unavailable\. | -| maintenance | RDS\-EVENT\-0027 | Finished applying off\-line patches to DB instance\. | Offline maintenance of the DB instance is complete\. The DB instance is now available\. | -| maintenance | RDS\-EVENT\-0047 | Database instance patched\. | | -| maintenance | RDS\-EVENT\-0155 | The DB instance has a DB engine minor version upgrade available\. | | -| maintenance | RDS\-EVENT\-0264 | The pre\-check started for the DB engine version upgrade\. | | -| maintenance | RDS\-EVENT\-0265 | The pre\-check finished for the DB engine version upgrade\. | | -| maintenance | RDS\-EVENT\-0266 | The downtime started for the DB instance\. | | -| maintenance | RDS\-EVENT\-0267 | The engine version upgrade started\. | | -| maintenance | RDS\-EVENT\-0268 | The engine version upgrade finished\. | | -| maintenance | RDS\-EVENT\-0269 | The post\-upgrade tasks are in progress\. | | -| maintenance | RDS\-EVENT\-0270 | The DB engine version upgrade failed\. The engine version upgrade rollback succeeded\. | | -| maintenance, notification | RDS\-EVENT\-0191 | A new version of the time zone file is available for update\. | If you update your RDS for Oracle DB engine, Amazon RDS generates this event if you haven't chosen a time zone file upgrade and the database doesn’t use the latest DST time zone file available on the instance\. For more information, see [Oracle time zone file autoupgrade](Appendix.Oracle.Options.Timezone-file-autoupgrade.md)\. | -| maintenance, notification | RDS\-EVENT\-0192 | The update of your time zone file has started\. | The upgrade of your Oracle time zone file has begun\. For more information, see [Oracle time zone file autoupgrade](Appendix.Oracle.Options.Timezone-file-autoupgrade.md)\. | -| maintenance, notification | RDS\-EVENT\-0193 | No update is available for the current time zone file version\. | Your Oracle DB instance is using latest time zone file version, and either of the following statements is true: [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Events.Messages.html) For more information, see [Oracle time zone file autoupgrade](Appendix.Oracle.Options.Timezone-file-autoupgrade.md)\. | -| maintenance, notification | RDS\-EVENT\-0194 | The update of your time zone file has finished\. | The update of your Oracle time zone file has completed\. For more information, see [Oracle time zone file autoupgrade](Appendix.Oracle.Options.Timezone-file-autoupgrade.md)\. | -| maintenance, failure | RDS\-EVENT\-0195 | *message* | The update of the Oracle time zone file failed\. For more information, see [Oracle time zone file autoupgrade](Appendix.Oracle.Options.Timezone-file-autoupgrade.md)\. | -| notification | RDS\-EVENT\-0044 | *message* | This is an operator\-issued notification\. For more information, see the event message\. | -| notification | RDS\-EVENT\-0048 | Delaying database engine upgrade since this instance has read replicas that need to be upgraded first\. | Patching of the DB instance has been delayed\. | -| notification | RDS\-EVENT\-0054 | *message* | The MySQL storage engine you are using is not InnoDB, which is the recommended MySQL storage engine for Amazon RDS\. For information about MySQL storage engines, see [Supported storage engines for RDS for MySQL](MySQL.Concepts.FeatureSupport.md#MySQL.Concepts.Storage)\. | -| notification | RDS\-EVENT\-0055 | *message* | The number of tables you have for your DB instance exceeds the recommended best practices for Amazon RDS\. Reduce the number of tables on your DB instance\. For information about recommended best practices, see [Amazon RDS basic operational guidelines](CHAP_BestPractices.md#CHAP_BestPractices.DiskPerformance)\. | -| notification | RDS\-EVENT\-0056 | *message* | The number of databases you have for your DB instance exceeds the recommended best practices for Amazon RDS\. Reduce the number of databases on your DB instance\. For information about recommended best practices, see [Amazon RDS basic operational guidelines](CHAP_BestPractices.md#CHAP_BestPractices.DiskPerformance)\. | -| notification | RDS\-EVENT\-0064 | The TDE encryption key was rotated successfully\. | For information about recommended best practices, see [Amazon RDS basic operational guidelines](CHAP_BestPractices.md#CHAP_BestPractices.DiskPerformance)\. | -| notification | RDS\-EVENT\-0084 | Unable to convert the DB instance to Multi\-AZ: *message*\. | You attempted to convert a DB instance to Multi\-AZ, but it contains in\-memory file groups that are not supported for Multi\-AZ\. For more information, see [Multi\-AZ deployments for Amazon RDS for Microsoft SQL Server](USER_SQLServerMultiAZ.md)\. | -| notification | RDS\-EVENT\-0087 | DB instance stopped\. | | -| notification | RDS\-EVENT\-0088 | DB instance started\. | | -| notification | RDS\-EVENT\-0154 | DB instance is being started due to it exceeding the maximum allowed time being stopped\. | | -| notification | RDS\-EVENT\-0157 | Unable to modify the DB instance class\. *message*\. | RDS can't modify the DB instance class because the target instance class can't support the number of databases that exist on the source DB instance\. The error message appears as: "The instance has *N* databases, but after conversion it would only support *N*"\. For more information, see [Limitations for Microsoft SQL Server DB instances](CHAP_SQLServer.md#SQLServer.Concepts.General.FeatureSupport.Limits)\. | -| notification | RDS\-EVENT\-0158 | Database instance is in a state that cannot be upgraded: *message*\. | | -| notification | RDS\-EVENT\-0167 | *message* | The RDS Custom support perimeter configuration has changed\. | -| notification | RDS\-EVENT\-0189 | The gp2 burst balance credits for the RDS database instance are low\. To resolve this issue, reduce IOPS usage or modify your storage settings to enable higher performance\. | The gp2 burst balance credits for the RDS database instance are low\. To resolve this issue, reduce IOPS usage or modify your storage settings to enable higher performance\. For more information, see [I/O credits and burst performance](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ebs-volume-types.html#EBSVolumeTypes_gp2) in the *Amazon Elastic Compute Cloud User Guide*\. | -| notification | RDS\-EVENT\-0225 | Storage size *amount* GB is approaching the maximum storage threshold *amount* GB\. Increase the maximum storage threshold\. | This event is invoked when storage reaches 80% of the maximum storage threshold\. To avoid the event, increase the maximum storage threshold\. | -| notification | RDS\-EVENT\-0231 | Your DB instance's storage modification encountered an internal error\. The modification request is pending and will be retried later\. | An error has occurred in the read replication process\. For more information, see the event message\. In addition, see the troubleshooting section for read replicas for your DB engine\. [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Events.Messages.html) | -| notification | RDS\-EVENT\-0253 | The database is using the doublewrite buffer\. *message*\. For more information see the RDS Optimized Writes for *name* documentation\. | RDS Optimized Writes is incompatible with the instance storage configuration\. For more information, see [Improving write performance with Amazon RDS Optimized Writes for MySQL](rds-optimized-writes.md) and [Improving write performance with Amazon RDS Optimized Writes for MariaDB](rds-optimized-writes-mariadb.md)\. | -| read replica | RDS\-EVENT\-0045 | Replication has stopped\. | Replication on your DB instance has been stopped due to insufficient storage\. Scale storage or reduce the maximum size of your redo logs to let replication continue\. To accommodate redo logs of size %d MiB you need at least %d MiB free storage\. | -| read replica | RDS\-EVENT\-0046 | Replication for the Read Replica resumed\. | This message appears when you first create a read replica, or as a monitoring message confirming that replication is functioning properly\. If this message follows an `RDS-EVENT-0045` notification, then replication has resumed following an error or after replication was stopped\. | -| read replica | RDS\-EVENT\-0057 | Replication streaming has been terminated\. | | -| read replica | RDS\-EVENT\-0062 | Replication for the Read Replica has been manually stopped\. | | -| read replica | RDS\-EVENT\-0063 | Replication from Non RDS instance has been reset\. | | -| read replica | RDS\-EVENT\-0202 | Read replica creation failed\. | | -| recovery | RDS\-EVENT\-0020 | Recovery of the DB instance has started\. Recovery time will vary with the amount of data to be recovered\. | | -| recovery | RDS\-EVENT\-0021 | Recovery of the DB instance is complete\. | | -| recovery | RDS\-EVENT\-0023 | Emergent Snapshot Request: *message*\. | A manual backup has been requested but Amazon RDS is currently in the process of creating a DB snapshot\. Submit the request again after Amazon RDS has completed the DB snapshot\. | -| recovery | RDS\-EVENT\-0052 | Multi\-AZ instance recovery started\. | Recovery time will vary with the amount of data to be recovered\. | -| recovery | RDS\-EVENT\-0053 | Multi\-AZ instance recovery completed\. Pending failover or activation\. | | -| recovery | RDS\-EVENT\-0066 | Instance will be degraded while mirroring is reestablished: *message*\. | The SQL Server DB instance is re\-establishing its mirror\. Performance will be degraded until the mirror is reestablished\. A database was found with non\-FULL recovery model\. The recovery model was changed back to FULL and mirroring recovery was started\. \(: \[,\.\.\.\]\)" | -| recovery | RDS\-EVENT\-0166 | *message* | The RDS Custom DB instance is inside the support perimeter\. | -| restoration | RDS\-EVENT\-0019 | Restored from DB instance *name* to *name*\. | The DB instance has been restored from a point\-in\-time backup\. | -| security | RDS\-EVENT\-0068 | Decrypting hsm partition password to update instance\. | RDS is decrypting the AWS CloudHSM partition password to make updates to the DB instance\. For more information see [Oracle Database Transparent Data Encryption \(TDE\) with AWS CloudHSM](https://docs.aws.amazon.com/cloudhsm/latest/userguide/oracle-tde.html) in the *AWS CloudHSM User Guide*\. | -| security patching | RDS\-EVENT\-0230 | A system update is available for your DB instance\. For information about applying updates, see 'Maintaining a DB instance' in the RDS User Guide\. | A new Operating System update is available\. A new, minor version, operating system update is available for your DB instance\. For information about applying updates, see [Working with operating system updates](USER_UpgradeDBInstance.Maintenance.md#OS_Updates)\. | - -## DB parameter group events - -The following table shows the event category and a list of events when a DB parameter group is the source type\. - - -| Category | RDS event ID | Message | Notes | -| --- | --- | --- | --- | -| configuration change | RDS\-EVENT\-0037 | Updated parameter *name* to *value* with apply method *method*\. | | - -## DB security group events - -The following table shows the event category and a list of events when a DB security group is the source type\. - -**Note** -DB security groups are resources for EC2\-Classic\. EC2\-Classic was retired on August 15, 2022\. If you haven't migrated from EC2\-Classic to a VPC, we recommend that you migrate as soon as possible\. For more information, see [Migrate from EC2\-Classic to a VPC](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/vpc-migrate.html) in the *Amazon EC2 User Guide* and the blog [ EC2\-Classic Networking is Retiring – Here’s How to Prepare](http://aws.amazon.com/blogs/aws/ec2-classic-is-retiring-heres-how-to-prepare/)\. - - -| Category | RDS event ID | Message | Notes | -| --- | --- | --- | --- | -| configuration change | RDS\-EVENT\-0038 | Applied change to security group\. | | -| failure | RDS\-EVENT\-0039 | Revoking authorization as *user*\. | The security group owned by *user* doesn't exist\. The authorization for the security group has been revoked because it is invalid\. | - -## DB snapshot events - -The following table shows the event category and a list of events when a DB snapshot is the source type\. - - -| Category | RDS event ID | Message | Notes | -| --- | --- | --- | --- | -| creation | RDS\-EVENT\-0040 | Creating manual snapshot\. | | -| creation | RDS\-EVENT\-0042 | Manual snapshot created\. | | -| creation | RDS\-EVENT\-0090 | Creating automated snapshot\. | | -| creation | RDS\-EVENT\-0091 | Automated snapshot created\. | | -| deletion | RDS\-EVENT\-0041 | Deleted user snapshot\. | | -| notification | RDS\-EVENT\-0059 | Started copy of snapshot*name* from region *name*\. | This is a cross\-Region snapshot copy\. | -| notification | RDS\-EVENT\-0060 | Finished copy of snapshot *name* from region *name* in *number* minutes\. | This is a cross\-Region snapshot copy\. | -| notification | RDS\-EVENT\-0061 | Canceled snapshot copy request of *name* from region *name*\. | This is a cross\-Region snapshot copy\. | -| notification | RDS\-EVENT\-0159 | The snapshot export task failed\. | | -| notification | RDS\-EVENT\-0160 | The snapshot export task was canceled\. | | -| notification | RDS\-EVENT\-0161 | The snapshot export task completed\. | | -| notification | RDS\-EVENT\-0196 | Started copy of snapshot *name* in region *name*\. | This is a local snapshot copy\. | -| notification | RDS\-EVENT\-0197 | Finished copy of snapshot *name* in region *name*\. | This is a local snapshot copy\. | -| notification | RDS\-EVENT\-0190 | Canceled snapshot copy request of *name* in region *name*\. | This is a local snapshot copy\. | -| restoration | RDS\-EVENT\-0043 | Restored from snapshot *name*\. | A DB instance is being restored from a DB snapshot\. | - -## DB cluster snapshot events - -The following table shows the event category and a list of events when a DB cluster snapshot is the source type\. - - -| Category | RDS event ID | Message | Notes | -| --- | --- | --- | --- | -| backup | RDS\-EVENT\-0074 | Creating manual cluster snapshot\. | | -| backup | RDS\-EVENT\-0075 | Manual cluster snapshot created\. | | -| backup | RDS\-EVENT\-0168 | Creating automated cluster snapshot\. | | -| backup | RDS\-EVENT\-0169 | Automated cluster snapshot created\. | | - -## RDS Proxy events - -The following table shows the event category and a list of events when an RDS Proxy is the source type\. - - -| Category | RDS event ID | Message | Notes | -| --- | --- | --- | --- | -| configuration change | RDS\-EVENT\-0204 | RDS modified DB proxy *name*\. | | -| configuration change | RDS\-EVENT\-0207 | RDS modified the end point of the DB proxy *name*\. | | -| configuration change | RDS\-EVENT\-0213 | RDS detected the addition of the DB instance and automatically added it to the target group of the DB proxy *name*\. | | -| configuration change | RDS\-EVENT\-0213 | RDS detected creation of DB instance *name* and automatically added it to target group *name* of DB proxy *name*\. | | -| configuration change | RDS\-EVENT\-0214 | RDS detected deletion of DB instance *name* and automatically removed it from target group *name* of DB proxy *name*\. | | -| configuration change | RDS\-EVENT\-0215 | RDS detected deletion of DB cluster *name* and automatically removed it from target group *name* of DB proxy *name*\. | | -| creation | RDS\-EVENT\-0203 | RDS created DB proxy *name*\. | | -| creation | RDS\-EVENT\-0206 | RDS created endpoint *name* for DB proxy *name*\. | | -| deletion | RDS\-EVENT\-0205 | RDS deleted DB proxy *name*\. | | -| deletion | RDS\-EVENT\-0208 | RDS deleted endpoint *name* for DB proxy *name*\. | | -| failure | RDS\-EVENT\-0243 | RDS failed to provision capacity for proxy *name* because there aren't enough IP addresses available in your subnets: *name*\. To fix the issue, make sure that your subnets have the minimum number of unused IP addresses as recommended in the RDS Proxy documentation\. | To determine the recommended number for your instance class, see [Planning for IP address capacity](rds-proxy-setup.md#rds-proxy-network-prereqs.plan-ip-address)\. | -| failure | RDS\-EVENT\-0275 | RDS throttled some connections to DB proxy \(RDS Proxy\)\. | | - -## Blue/green deployment events - -The following table shows the event category and a list of events when a blue/green deployment is the source type\. - -For more information about blue/green deployments, see [Using Amazon RDS Blue/Green Deployments for database updates](blue-green-deployments.md)\. - - -| Category | Amazon RDS event ID | Message | Notes | -| --- | --- | --- | --- | -| creation | RDS\-EVENT\-0244 | Blue/green deployment tasks completed\. You can make more modifications to the green environment databases or switch over the deployment\. | | -| deletion | RDS\-EVENT\-0246 | Blue/green deployment deleted\. | | -| failure | RDS\-EVENT\-0245 | Creation of blue/green deployment failed because the \(source/target\) DB \(instance/cluster\) wasn't found\. | | -| failure | RDS\-EVENT\-0249 | Switchover canceled on blue/green deployment\. | | -| failure | RDS\-EVENT\-0252 | Switchover from primary source to target canceled due to *reason*\. | | -| failure | RDS\-EVENT\-0261 | Switchover from source to target was canceled\. | | -| notification | RDS\-EVENT\-0247 | Switchover started on blue/green deployment\. | | -| notification | RDS\-EVENT\-0248 | Switchover completed on blue/green deployment\. | | -| notification | RDS\-EVENT\-0250 | Switchover from primary source to target started\. | | -| notification | RDS\-EVENT\-0251 | Switchover from primary source to target completed\. Renamed databases\. | | -| notification | RDS\-EVENT\-0259 | Switchover from source to target started\. | | -| notification | RDS\-EVENT\-0260 | Switchover from source to target completed\. Renamed databases\. | | - -## Custom engine version events - -The following table shows the event category and a list of events when a custom engine version is the source type\. - - -| Category | Amazon RDS event ID | Message | Notes | -| --- | --- | --- | --- | -| failure | RDS\-EVENT\-0198 | Creation failed for custom engine version *name*\. *message* | The *message* includes details about the failure, such as missing files\. | -| failure | RDS\-EVENT\-0277 | Failure during deletion of custom engine version *name*\. *message* | The *message* includes details about the failure\. | \ No newline at end of file diff --git a/doc_source/USER_Events.Modifying.md b/doc_source/USER_Events.Modifying.md deleted file mode 100644 index 96b2325..0000000 --- a/doc_source/USER_Events.Modifying.md +++ /dev/null @@ -1,47 +0,0 @@ -# Modifying an Amazon RDS event notification subscription - -After you have created a subscription, you can change the subscription name, source identifier, categories, or topic ARN\. - -## Console - -**To modify an Amazon RDS event notification subscription** - -1. Sign in to the AWS Management Console and open the Amazon RDS console at [https://console\.aws\.amazon\.com/rds/](https://console.aws.amazon.com/rds/)\. - -1. In the navigation pane, choose **Event subscriptions**\. - -1. In the **Event subscriptions** pane, choose the subscription that you want to modify and choose **Edit**\. - -1. Make your changes to the subscription in either the **Target** or **Source** section\. - -1. Choose **Edit**\. The Amazon RDS console indicates that the subscription is being modified\. -![\[List DB event notification subscriptions\]](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/images/EventNotification-Modify2.png) - - - -## AWS CLI - -To modify an Amazon RDS event notification subscription, use the AWS CLI [https://docs.aws.amazon.com/cli/latest/reference/rds/modify-event-subscription.html](https://docs.aws.amazon.com/cli/latest/reference/rds/modify-event-subscription.html) command\. Include the following required parameter: -+ `--subscription-name` - -**Example** -The following code enables `myeventsubscription`\. -For Linux, macOS, or Unix: - -``` -aws rds modify-event-subscription \ - --subscription-name myeventsubscription \ - --enabled -``` -For Windows: - -``` -aws rds modify-event-subscription ^ - --subscription-name myeventsubscription ^ - --enabled -``` - -## API - -To modify an Amazon RDS event, call the Amazon RDS API operation [https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_ModifyEventSubscription.html](https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_ModifyEventSubscription.html)\. Include the following required parameter: -+ `SubscriptionName` \ No newline at end of file diff --git a/doc_source/USER_Events.RemovingSource.md b/doc_source/USER_Events.RemovingSource.md deleted file mode 100644 index 32c4b81..0000000 --- a/doc_source/USER_Events.RemovingSource.md +++ /dev/null @@ -1,36 +0,0 @@ -# Removing a source identifier from an Amazon RDS event notification subscription - -You can remove a source identifier \(the Amazon RDS source generating the event\) from a subscription if you no longer want to be notified of events for that source\. - -## Console - -You can easily add or remove source identifiers using the Amazon RDS console by selecting or deselecting them when modifying a subscription\. For more information, see [Modifying an Amazon RDS event notification subscription](USER_Events.Modifying.md)\. - -## AWS CLI - -To remove a source identifier from an Amazon RDS event notification subscription, use the AWS CLI [https://docs.aws.amazon.com/cli/latest/reference/rds/remove-source-identifier-from-subscription.html](https://docs.aws.amazon.com/cli/latest/reference/rds/remove-source-identifier-from-subscription.html) command\. Include the following required parameters: -+ `--subscription-name` -+ `--source-identifier` - -**Example** -The following example removes the source identifier `mysqldb` from the `myrdseventsubscription` subscription\. -For Linux, macOS, or Unix: - -``` -aws rds remove-source-identifier-from-subscription \ - --subscription-name myrdseventsubscription \ - --source-identifier mysqldb -``` -For Windows: - -``` -aws rds remove-source-identifier-from-subscription ^ - --subscription-name myrdseventsubscription ^ - --source-identifier mysqldb -``` - -## API - -To remove a source identifier from an Amazon RDS event notification subscription, use the Amazon RDS API [https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_RemoveSourceIdentifierFromSubscription.html](https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_RemoveSourceIdentifierFromSubscription.html) command\. Include the following required parameters: -+ `SubscriptionName` -+ `SourceIdentifier` \ No newline at end of file diff --git a/doc_source/USER_Events.Subscribing.md b/doc_source/USER_Events.Subscribing.md deleted file mode 100644 index e0ce580..0000000 --- a/doc_source/USER_Events.Subscribing.md +++ /dev/null @@ -1,84 +0,0 @@ -# Subscribing to Amazon RDS event notification - -The simplest way to create a subscription is with the RDS console\. If you choose to create event notification subscriptions using the CLI or API, you must create an Amazon Simple Notification Service topic and subscribe to that topic with the Amazon SNS console or Amazon SNS API\. You will also need to retain the Amazon Resource Name \(ARN\) of the topic because it is used when submitting CLI commands or API operations\. For information on creating an SNS topic and subscribing to it, see [Getting started with Amazon SNS](https://docs.aws.amazon.com/sns/latest/dg/GettingStarted.html) in the *Amazon Simple Notification Service Developer Guide*\. - -You can specify the type of source you want to be notified of and the Amazon RDS source that triggers the event: - -**Source type** -The type of source\. For example, **Source type** might be **Instances**\. You must choose a source type\. - -***Resources* to include** -The Amazon RDS resources that are generating the events\. For example, you might choose **Select specific instances** and then **myDBInstance1**\. - -The following table explains the result when you specify or don't specify ***Resources* to include**\. - - -| Resources to include | Description | Example | -| --- | --- | --- | -| Specified | RDS notifies you about all events for the specified resource only\. | If your Source type is Instances and your resource is myDBInstance1, RDS notifies you about all events for myDBInstance1 only\. | -| Not specified | RDS notifies you about the events for the specified source type for all your Amazon RDS resources\. | If your **Source type** is **Instances**, RDS notifies you about all instance\-related events in your account\. | - -An Amazon SNS topic subscriber receives every message published to the topic by default\. To receive only a subset of the messages, the subscriber must assign a filter policy to the topic subscription\. For more information about SNS message filtering, see [Amazon SNS message filtering](https://docs.aws.amazon.com/sns/latest/dg/sns-message-filtering.html) in the *Amazon Simple Notification Service Developer Guide* - -## Console - -**To subscribe to RDS event notification** - -1. Sign in to the AWS Management Console and open the Amazon RDS console at [https://console\.aws\.amazon\.com/rds/](https://console.aws.amazon.com/rds/)\. - -1. In navigation pane, choose **Event subscriptions**\. - -1. In the **Event subscriptions** pane, choose **Create event subscription**\. - -1. Enter your subscription details as follows: - - 1. For **Name**, enter a name for the event notification subscription\. - - 1. For **Send notifications to**, do one of the following: - + Choose **New email topic**\. Enter a name for your email topic and a list of recipients\. We recommend that you configure the events subscriptions to the same email address as your primary account contact\. The recommendations, service events, and personal health messages are sent using different channels\. The subscriptions to the same email address ensures that all the messages are consolidated in one location\. - + Choose **Amazon Resource Name \(ARN\)**\. Then choose existing Amazon SNS ARN for an Amazon SNS topic\. - - If you want to use a topic that has been enabled for server\-side encryption \(SSE\), grant Amazon RDS the necessary permissions to access the AWS KMS key\. For more information, see [ Enable compatibility between event sources from AWS services and encrypted topics](https://docs.aws.amazon.com/sns/latest/dg/sns-key-management.html#compatibility-with-aws-services) in the *Amazon Simple Notification Service Developer Guide*\. - - 1. For **Source type**, choose a source type\. For example, choose **Instances** or **Parameter groups**\. - - 1. Choose the event categories and resources that you want to receive event notifications for\. - - The following example configures event notifications for the DB instance named `testinst`\. -![\[Enter source type\]](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/images/event-source.png) - - 1. Choose **Create**\. - -The Amazon RDS console indicates that the subscription is being created\. - -![\[List DB event notification subscriptions\]](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/images/EventNotification-Create2.png) - -## AWS CLI - -To subscribe to RDS event notification, use the AWS CLI [https://docs.aws.amazon.com/cli/latest/reference/rds/create-event-subscription.html](https://docs.aws.amazon.com/cli/latest/reference/rds/create-event-subscription.html) command\. Include the following required parameters: -+ `--subscription-name` -+ `--sns-topic-arn` - -**Example** -For Linux, macOS, or Unix: - -``` -aws rds create-event-subscription \ - --subscription-name myeventsubscription \ - --sns-topic-arn arn:aws:sns:us-east-1:123456789012:myawsuser-RDS \ - --enabled -``` -For Windows: - -``` -aws rds create-event-subscription ^ - --subscription-name myeventsubscription ^ - --sns-topic-arn arn:aws:sns:us-east-1:123456789012:myawsuser-RDS ^ - --enabled -``` - -## API - -To subscribe to Amazon RDS event notification, call the Amazon RDS API function [https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_CreateEventSubscription.html](https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_CreateEventSubscription.html)\. Include the following required parameters: -+ `SubscriptionName` -+ `SnsTopicArn` \ No newline at end of file diff --git a/doc_source/USER_Events.TagsAttributesForFiltering.md b/doc_source/USER_Events.TagsAttributesForFiltering.md deleted file mode 100644 index 5982cc9..0000000 --- a/doc_source/USER_Events.TagsAttributesForFiltering.md +++ /dev/null @@ -1,24 +0,0 @@ -# Amazon RDS event notification tags and attributes - -When Amazon RDS sends an event notification to Amazon Simple Notification Service \(SNS\) or Amazon EventBridge, the notification contains message attributes and event tags\. RDS sends the message attributes separately along with the message, while the event tags are in the body of the message\. Use the message attributes and the Amazon RDS tags to add metadata to your resources\. You can modify these tags with your own notations about the DB instances\. For more information about tagging Amazon RDS resources, see [Tagging Amazon RDS resources](USER_Tagging.md)\. - -By default, the Amazon SNS and Amazon EventBridge receives every message sent to them\. SNS and EventBridge can filter the message and send the notifications to the preferred communication mode, such as an email, a text message, or a call to an HTTP endpoint\. - -**Note** -The notification sent in an email or a text message will not have event tags\. - -The following table shows the message attributes for RDS events sent to the topic subscriber\. - - -| Amazon RDS event attribute | Description | -| --- | --- | -| EventID | Identifier for the RDS event message, for example, RDS\-EVENT\-0006\. | -| Resource | The ARN identifier for the resource emitting the event, for example, `arn:aws:rds:ap-southeast-2:123456789012:db:database-1`\. | - -The RDS tags provide data about the resource that was affected by the service event\. RDS adds the current state of the tags in the message body when the notification is sent to SNS or EventBridge\. - -For more information about filtering message attributes for SNS, see [Amazon SNS message filtering](https://docs.aws.amazon.com/sns/latest/dg/sns-message-filtering.html) in the *Amazon Simple Notification Service Developer Guide*\. - -For more information about filtering event tags for EventBridge, see [ Content filtering in Amazon EventBridge event patterns](https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-event-patterns-content-based-filtering.html) in the *Amazon EventBridge User Guide*\. - -For more information about filtering payload\-based tags for SNS, see [https://aws.amazon.com/blogs/compute/introducing-payload-based-message-filtering-for-amazon-sns/](https://aws.amazon.com/blogs/compute/introducing-payload-based-message-filtering-for-amazon-sns/) \ No newline at end of file diff --git a/doc_source/USER_Events.md b/doc_source/USER_Events.md deleted file mode 100644 index 0fa8aad..0000000 --- a/doc_source/USER_Events.md +++ /dev/null @@ -1,15 +0,0 @@ -# Working with Amazon RDS event notification - -Amazon RDS uses the Amazon Simple Notification Service \(Amazon SNS\) to provide notification when an Amazon RDS event occurs\. These notifications can be in any notification form supported by Amazon SNS for an AWS Region, such as an email, a text message, or a call to an HTTP endpoint\. - -**Topics** -+ [Overview of Amazon RDS event notification](USER_Events.overview.md) -+ [Granting permissions to publish notifications to an Amazon SNS topic](USER_Events.GrantingPermissions.md) -+ [Subscribing to Amazon RDS event notification](USER_Events.Subscribing.md) -+ [Amazon RDS event notification tags and attributes](USER_Events.TagsAttributesForFiltering.md) -+ [Listing Amazon RDS event notification subscriptions](USER_Events.ListSubscription.md) -+ [Modifying an Amazon RDS event notification subscription](USER_Events.Modifying.md) -+ [Adding a source identifier to an Amazon RDS event notification subscription](USER_Events.AddingSource.md) -+ [Removing a source identifier from an Amazon RDS event notification subscription](USER_Events.RemovingSource.md) -+ [Listing the Amazon RDS event notification categories](USER_Events.ListingCategories.md) -+ [Deleting an Amazon RDS event notification subscription](USER_Events.Deleting.md) \ No newline at end of file diff --git a/doc_source/USER_Events.overview.md b/doc_source/USER_Events.overview.md deleted file mode 100644 index 6f03254..0000000 --- a/doc_source/USER_Events.overview.md +++ /dev/null @@ -1,162 +0,0 @@ -# Overview of Amazon RDS event notification - -Amazon RDS groups events into categories that you can subscribe to so that you can be notified when an event in that category occurs\. - -**Topics** -+ [RDS resources eligible for event subscription](#USER_Events.overview.resources) -+ [Basic process for subscribing to Amazon RDS event notifications](#USER_Events.overview.process) -+ [Delivery of RDS event notifications](#USER_Events.overview.subscriptions) -+ [Billing for Amazon RDS event notifications](#USER_Events.overview.billing) -+ [Examples of Amazon RDS events](#events-examples) - -## RDS resources eligible for event subscription - -You can subscribe to an event category for the following resources: -+ DB instance -+ DB snapshot -+ DB parameter group -+ DB security group -+ RDS Proxy -+ Custom engine version - -For example, if you subscribe to the backup category for a given DB instance, you're notified whenever a backup\-related event occurs that affects the DB instance\. If you subscribe to a configuration change category for a DB instance, you're notified when the DB instance is changed\. You also receive notification when an event notification subscription changes\. - -You might want to create several different subscriptions\. For example, you might create one subscription that receives all event notifications for all DB instances and another subscription that includes only critical events for a subset of the DB instances\. For the second subscription, specify one or more DB instances in the filter\. - -## Basic process for subscribing to Amazon RDS event notifications - -The process for subscribing to Amazon RDS event notification is as follows: - -1. You create an Amazon RDS event notification subscription by using the Amazon RDS console, AWS CLI, or API\. - - Amazon RDS uses the ARN of an Amazon SNS topic to identify each subscription\. The Amazon RDS console creates the ARN for you when you create the subscription\. Create the ARN by using the Amazon SNS console, the AWS CLI, or the Amazon SNS API\. - -1. Amazon RDS sends an approval email or SMS message to the addresses you submitted with your subscription\. - -1. You confirm your subscription by choosing the link in the notification you received\. - -1. The Amazon RDS console updates the **My Event Subscriptions** section with the status of your subscription\. - -1. Amazon RDS begins sending the notifications to the addresses that you provided when you created the subscription\. - -To learn about identity and access management when using Amazon SNS, see [Identity and access management in Amazon SNS](https://docs.aws.amazon.com/sns/latest/dg/sns-authentication-and-access-control.html) in the *Amazon Simple Notification Service Developer Guide*\. - -You can use AWS Lambda to process event notifications from a DB instance\. For more information, see [Using AWS Lambda with Amazon RDS](https://docs.aws.amazon.com/lambda/latest/dg/services-rds.html) in the *AWS Lambda Developer Guide*\. - -## Delivery of RDS event notifications - -Amazon RDS sends notifications to the addresses that you provide when you create the subscription\. The notification can include message attributes which provide structured metadata about the message\. For more information about message attributes, see [Amazon RDS event categories and event messages](USER_Events.Messages.md)\. - -Event notifications might take up to five minutes to be delivered\. - -**Important** -Amazon RDS doesn't guarantee the order of events sent in an event stream\. The event order is subject to change\. - -When Amazon SNS sends a notification to a subscribed HTTP or HTTPS endpoint, the POST message sent to the endpoint has a message body that contains a JSON document\. For more information, see [Amazon SNS message and JSON formats](https://docs.aws.amazon.com/sns/latest/dg/sns-message-and-json-formats.html) in the *Amazon Simple Notification Service Developer Guide*\. - -You can configure SNS to notify you with text messages\. For more information, see [ Mobile text messaging \(SMS\)](https://docs.aws.amazon.com/sns/latest/dg/sns-mobile-phone-number-as-subscriber.html) in the *Amazon Simple Notification Service Developer Guide*\. - -To turn off notifications without deleting a subscription, choose **No** for **Enabled** in the Amazon RDS console\. Or you can set the `Enabled` parameter to `false` using the AWS CLI or Amazon RDS API\. - -## Billing for Amazon RDS event notifications - -Billing for Amazon RDS event notification is through Amazon SNS\. Amazon SNS fees apply when using event notification\. For more information about Amazon SNS billing, see [ Amazon Simple Notification Service pricing](http://aws.amazon.com/sns/#pricing)\. - -## Examples of Amazon RDS events - -The following examples illustrate different types of Amazon RDS events in JSON format\. For a tutorial that shows you how to capture and view events in JSON format, see [Tutorial: Log DB instance state changes using Amazon EventBridge](rds-cloud-watch-events.md#log-rds-instance-state)\. - -**Topics** -+ [Example of a DB instance event](#rds-cloudwatch-events.db-instances) -+ [Example of a DB parameter group event](#rds-cloudwatch-events.db-parameter-groups) -+ [Example of a DB snapshot event](#rds-cloudwatch-events.db-snapshots) - -### Example of a DB instance event - -The following is an example of a DB instance event in JSON format\. The event shows that RDS performed a multi\-AZ failover for the instance named `my-db-instance`\. The event ID is RDS\-EVENT\-0049\. - -``` -{ - "version": "0", - "id": "68f6e973-1a0c-d37b-f2f2-94a7f62ffd4e", - "detail-type": "RDS DB Instance Event", - "source": "aws.rds", - "account": "123456789012", - "time": "2018-09-27T22:36:43Z", - "region": "us-east-1", - "resources": [ - "arn:aws:rds:us-east-1:123456789012:db:my-db-instance" - ], - "detail": { - "EventCategories": [ - "failover" - ], - "SourceType": "DB_INSTANCE", - "SourceArn": "arn:aws:rds:us-east-1:123456789012:db:my-db-instance", - "Date": "2018-09-27T22:36:43.292Z", - "Message": "A Multi-AZ failover has completed.", - "SourceIdentifier": "rds:my-db-instance", - "EventID": "RDS-EVENT-0049" - } -} -``` - -### Example of a DB parameter group event - -The following is an example of a DB parameter group event in JSON format\. The event shows that the parameter `time_zone` was updated in parameter group `my-db-param-group`\. The event ID is RDS\-EVENT\-0037\. - -``` -{ - "version": "0", - "id": "844e2571-85d4-695f-b930-0153b71dcb42", - "detail-type": "RDS DB Parameter Group Event", - "source": "aws.rds", - "account": "123456789012", - "time": "2018-10-06T12:26:13Z", - "region": "us-east-1", - "resources": [ - "arn:aws:rds:us-east-1:123456789012:pg:my-db-param-group" - ], - "detail": { - "EventCategories": [ - "configuration change" - ], - "SourceType": "DB_PARAM", - "SourceArn": "arn:aws:rds:us-east-1:123456789012:pg:my-db-param-group", - "Date": "2018-10-06T12:26:13.882Z", - "Message": "Updated parameter time_zone to UTC with apply method immediate", - "SourceIdentifier": "rds:my-db-param-group", - "EventID": "RDS-EVENT-0037" - } -} -``` - -### Example of a DB snapshot event - -The following is an example of a DB snapshot event in JSON format\. The event shows the deletion of the snapshot named `my-db-snapshot`\. The event ID is RDS\-EVENT\-0041\. - -``` -{ - "version": "0", - "id": "844e2571-85d4-695f-b930-0153b71dcb42", - "detail-type": "RDS DB Snapshot Event", - "source": "aws.rds", - "account": "123456789012", - "time": "2018-10-06T12:26:13Z", - "region": "us-east-1", - "resources": [ - "arn:aws:rds:us-east-1:123456789012:snapshot:rds:my-db-snapshot" - ], - "detail": { - "EventCategories": [ - "deletion" - ], - "SourceType": "SNAPSHOT", - "SourceArn": "arn:aws:rds:us-east-1:123456789012:snapshot:rds:my-db-snapshot", - "Date": "2018-10-06T12:26:13.882Z", - "Message": "Deleted manual snapshot", - "SourceIdentifier": "rds:my-db-snapshot", - "EventID": "RDS-EVENT-0041" - } -} -``` \ No newline at end of file diff --git a/doc_source/USER_ExportSnapshot.md b/doc_source/USER_ExportSnapshot.md deleted file mode 100644 index 50d33d9..0000000 --- a/doc_source/USER_ExportSnapshot.md +++ /dev/null @@ -1,690 +0,0 @@ -# Exporting DB snapshot data to Amazon S3 - -You can export DB snapshot data to an Amazon S3 bucket\. The export process runs in the background and doesn't affect the performance of your active DB instance\. - -When you export a DB snapshot, Amazon RDS extracts data from the snapshot and stores it in an Amazon S3 bucket\. The data is stored in an Apache Parquet format that is compressed and consistent\. - -You can export all types of DB snapshots—including manual snapshots, automated system snapshots, and snapshots created by the AWS Backup service\. By default, all data in the snapshot is exported\. However, you can choose to export specific sets of databases, schemas, or tables\. - -After the data is exported, you can analyze the exported data directly through tools like Amazon Athena or Amazon Redshift Spectrum\. For more information on using Athena to read Parquet data, see [Parquet SerDe](https://docs.aws.amazon.com/athena/latest/ug/parquet-serde.html) in the *Amazon Athena User Guide*\. For more information on using Redshift Spectrum to read Parquet data, see [COPY from columnar data formats](https://docs.aws.amazon.com/redshift/latest/dg/copy-usage_notes-copy-from-columnar.html) in the *Amazon Redshift Database Developer Guide*\. - -**Topics** -+ [Region and version availability](#USER_ExportSnapshot.RegionVersionAvailability) -+ [Limitations](#USER_ExportSnapshot.Limits) -+ [Overview of exporting snapshot data](#USER_ExportSnapshot.Overview) -+ [Setting up access to an Amazon S3 bucket](#USER_ExportSnapshot.Setup) -+ [Exporting a DB snapshot to an Amazon S3 bucket](#USER_ExportSnapshot.Exporting) -+ [Monitoring snapshot exports](#USER_ExportSnapshot.Monitoring) -+ [Canceling a snapshot export task](#USER_ExportSnapshot.Canceling) -+ [Failure messages for Amazon S3 export tasks](#USER_ExportSnapshot.failure-msg) -+ [Troubleshooting PostgreSQL permissions errors](#USER_ExportSnapshot.postgres-permissions) -+ [File naming convention](#USER_ExportSnapshot.FileNames) -+ [Data conversion when exporting to an Amazon S3 bucket](#USER_ExportSnapshot.data-types) - -## Region and version availability - -Feature availability and support varies across specific versions of each database engine and across AWS Regions\. For more information on version and Region availability with exporting snapshots to S3, see [Export snapshots to S3](Concepts.RDS_Fea_Regions_DB-eng.Feature.ExportSnapshotToS3.md)\. - -## Limitations - -Exporting DB snapshot data to Amazon S3 has the following limitations: -+ You can't run multiple export tasks for the same DB snapshot simultaneously\. This applies to both full and partial exports\. -+ Exporting snapshots from DB instances that use magnetic storage isn't supported\. -+ The following characters in the S3 file path are converted to underscores \(\_\) during export: - - ``` - \ ` " (space) - ``` -+ If a database, schema, or table has characters in its name other than the following, partial export isn't supported\. However, you can export the entire DB snapshot\. - + Latin letters \(A–Z\) - + Digits \(0–9\) - + Dollar symbol \($\) - + Underscore \(\_\) -+ Spaces \( \) and certain characters aren't supported in database table column names\. Tables with the following characters in column names are skipped during export: - - ``` - , ; { } ( ) \n \t = (space) - ``` -+ Tables with slashes \(/\) in their names are skipped during export\. -+ RDS for PostgreSQL temporary and unlogged tables are skipped during export\. -+ If the data contains a large object, such as a BLOB or CLOB, that is close to or greater than 500 MB, then the export fails\. -+ If a table contains a large row that is close to or greater than 2 GB, then the table is skipped during export\. -+ We strongly recommend that you use a unique name for each export task\. If you don't use a unique task name, you might receive the following error message: - - ExportTaskAlreadyExistsFault: An error occurred \(ExportTaskAlreadyExists\) when calling the StartExportTask operation: The export task with the ID *xxxxx* already exists\. -+ You can delete a snapshot while you're exporting its data to S3, but you're still charged for the storage costs for that snapshot until the export task has completed\. -+ You can't restore exported snapshot data from S3 to a new DB instance\. - -## Overview of exporting snapshot data - -You use the following process to export DB snapshot data to an Amazon S3 bucket\. For more details, see the following sections\. - -1. Identify the snapshot to export\. - - Use an existing automated or manual snapshot, or create a manual snapshot of a DB instance\. - -1. Set up access to the Amazon S3 bucket\. - - A *bucket* is a container for Amazon S3 objects or files\. To provide the information to access a bucket, take the following steps: - - 1. Identify the S3 bucket where the snapshot is to be exported to\. The S3 bucket must be in the same AWS Region as the snapshot\. For more information, see [Identifying the Amazon S3 bucket for export](#USER_ExportSnapshot.SetupBucket)\. - - 1. Create an AWS Identity and Access Management \(IAM\) role that grants the snapshot export task access to the S3 bucket\. For more information, see [Providing access to an Amazon S3 bucket using an IAM role](#USER_ExportSnapshot.SetupIAMRole)\. - -1. Create a symmetric encryption AWS KMS key for the server\-side encryption\. The KMS key is used by the snapshot export task to set up AWS KMS server\-side encryption when writing the export data to S3\. The KMS key policy must include both the `kms:Encrypt` and `kms:Decrypt` permissions\. For more information on using KMS keys in Amazon RDS, see [AWS KMS key management](Overview.Encryption.Keys.md)\. - - If you have a deny statement in your KMS key policy, make sure to explicitly exclude the AWS service principal `export.rds.amazonaws.com`\. - - You can use a KMS key within your AWS account, or you can use a cross\-account KMS key\. For more information, see [Using a cross\-account AWS KMS key for encrypting Amazon S3 exports](#USER_ExportSnapshot.CMK)\. - -1. Export the snapshot to Amazon S3 using the console or the `start-export-task` CLI command\. For more information, see [Exporting a DB snapshot to an Amazon S3 bucket](#USER_ExportSnapshot.Exporting)\. - -1. To access your exported data in the Amazon S3 bucket, see [Uploading, downloading, and managing objects](https://docs.aws.amazon.com/AmazonS3/latest/user-guide/upload-download-objects.html) in the *Amazon Simple Storage Service User Guide*\. - -## Setting up access to an Amazon S3 bucket - -To export DB snapshot data to an Amazon S3 file, you first give the snapshot permission to access the Amazon S3 bucket\. You then create an IAM role to allow the Amazon RDS service to write to the Amazon S3 bucket\. - -**Topics** -+ [Identifying the Amazon S3 bucket for export](#USER_ExportSnapshot.SetupBucket) -+ [Providing access to an Amazon S3 bucket using an IAM role](#USER_ExportSnapshot.SetupIAMRole) -+ [Using a cross\-account Amazon S3 bucket](#USER_ExportSnapshot.Setup.XAcctBucket) -+ [Using a cross\-account AWS KMS key for encrypting Amazon S3 exports](#USER_ExportSnapshot.CMK) - -### Identifying the Amazon S3 bucket for export - -Identify the Amazon S3 bucket to export the DB snapshot to\. Use an existing S3 bucket or create a new S3 bucket\. - -**Note** -The S3 bucket to export to must be in the same AWS Region as the snapshot\. - -For more information about working with Amazon S3 buckets, see the following in the *Amazon Simple Storage Service User Guide*: -+ [ How do I view the properties for an S3 bucket?](https://docs.aws.amazon.com/AmazonS3/latest/user-guide/view-bucket-properties.html) -+ [ How do I enable default encryption for an Amazon S3 bucket?](https://docs.aws.amazon.com/AmazonS3/latest/user-guide/default-bucket-encryption.html) -+ [ How do I create an S3 bucket?](https://docs.aws.amazon.com/AmazonS3/latest/user-guide/create-bucket.html) - -### Providing access to an Amazon S3 bucket using an IAM role - -Before you export DB snapshot data to Amazon S3, give the snapshot export tasks write\-access permission to the Amazon S3 bucket\. - -To grant this permission, create an IAM policy that provides access to the bucket, then create an IAM role and attach the policy to the role\. You later assign the IAM role to your snapshot export task\. - -**Important** -If you plan to use the AWS Management Console to export your snapshot, you can choose to create the IAM policy and the role automatically when you export the snapshot\. For instructions, see [Exporting a DB snapshot to an Amazon S3 bucket](#USER_ExportSnapshot.Exporting)\. - -**To give DB snapshot tasks access to Amazon S3** - -1. Create an IAM policy\. This policy provides the bucket and object permissions that allow your snapshot export task to access Amazon S3\. - - In the policy, include the following required actions to allow the transfer of files from Amazon RDS to an S3 bucket: - + `s3:PutObject*` - + `s3:GetObject*` - + `s3:ListBucket` - + `s3:DeleteObject*` - + `s3:GetBucketLocation` - - In the policy, include the following resources to identify the S3 bucket and objects in the bucket\. The following list of resources shows the Amazon Resource Name \(ARN\) format for accessing Amazon S3\. - + `arn:aws:s3:::your-s3-bucket` - + `arn:aws:s3:::your-s3-bucket/*` - - For more information on creating an IAM policy for Amazon RDS, see [Creating and using an IAM policy for IAM database access](UsingWithRDS.IAMDBAuth.IAMPolicy.md)\. See also [Tutorial: Create and attach your first customer managed policy](https://docs.aws.amazon.com/IAM/latest/UserGuide/tutorial_managed-policies.html) in the *IAM User Guide*\. - - The following AWS CLI command creates an IAM policy named `ExportPolicy` with these options\. It grants access to a bucket named `your-s3-bucket`\. -**Note** -After you create the policy, note the ARN of the policy\. You need the ARN for a subsequent step when you attach the policy to an IAM role\. - - ``` - aws iam create-policy --policy-name ExportPolicy --policy-document '{ - "Version": "2012-10-17", - "Statement": [ - { - "Sid": "ExportPolicy", - "Effect": "Allow", - "Action": [ - "s3:PutObject*", - "s3:ListBucket", - "s3:GetObject*", - "s3:DeleteObject*", - "s3:GetBucketLocation" - ], - "Resource": [ - "arn:aws:s3:::your-s3-bucket", - "arn:aws:s3:::your-s3-bucket/*" - ] - } - ] - }' - ``` - -1. Create an IAM role, so that Amazon RDS can assume this IAM role on your behalf to access your Amazon S3 buckets\. For more information, see [Creating a role to delegate permissions to an IAM user](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_create_for-user.html) in the *IAM User Guide*\. - - The following example shows using the AWS CLI command to create a role named `rds-s3-export-role`\. - - ``` - aws iam create-role --role-name rds-s3-export-role --assume-role-policy-document '{ - "Version": "2012-10-17", - "Statement": [ - { - "Effect": "Allow", - "Principal": { - "Service": "export.rds.amazonaws.com" - }, - "Action": "sts:AssumeRole" - } - ] - }' - ``` - -1. Attach the IAM policy that you created to the IAM role that you created\. - - The following AWS CLI command attaches the policy created earlier to the role named `rds-s3-export-role`\. Replace `your-policy-arn` with the policy ARN that you noted in an earlier step\. - - ``` - aws iam attach-role-policy --policy-arn your-policy-arn --role-name rds-s3-export-role - ``` - -### Using a cross\-account Amazon S3 bucket - -You can use Amazon S3 buckets across AWS accounts\. To use a cross\-account bucket, add a bucket policy to allow access to the IAM role that you're using for the S3 exports\. For more information, see [Example 2: Bucket owner granting cross\-account bucket permissions](https://docs.aws.amazon.com/AmazonS3/latest/userguide/example-walkthroughs-managing-access-example2.html)\.To add a bucket policy -+ Attach a bucket policy to your bucket, as shown in the following example\. - - ``` - { - "Version": "2012-10-17", - "Statement": [ - { - "Effect": "Allow", - "Principal": { - "AWS": "arn:aws:iam::123456789012:role/Admin" - }, - "Action": [ - "s3:PutObject*", - "s3:ListBucket", - "s3:GetObject*", - "s3:DeleteObject*", - "s3:GetBucketLocation" - ], - "Resource": [ - "arn:aws:s3:::mycrossaccountbucket", - "arn:aws:s3:::mycrossaccountbucket/*" - ] - } - ] - } - ``` - -### Using a cross\-account AWS KMS key for encrypting Amazon S3 exports - -You can use a cross\-account AWS KMS key to encrypt Amazon S3 exports\. First, you add a key policy to the local account, then you add IAM policies in the external account\. For more information, see [Allowing users in other accounts to use a KMS key](https://docs.aws.amazon.com/kms/latest/developerguide/key-policy-modifying-external-accounts.html)\. - -**To use a cross\-account KMS key** - -1. Add a key policy to the local account\. - - The following example gives `ExampleRole` and `ExampleUser` in the external account 444455556666 permissions in the local account 123456789012\. - - ``` - { - "Sid": "Allow an external account to use this KMS key", - "Effect": "Allow", - "Principal": { - "AWS": [ - "arn:aws:iam::444455556666:role/ExampleRole", - "arn:aws:iam::444455556666:user/ExampleUser" - ] - }, - "Action": [ - "kms:Encrypt", - "kms:Decrypt", - "kms:ReEncrypt*", - "kms:GenerateDataKey*", - "kms:CreateGrant", - "kms:DescribeKey", - "kms:RetireGrant" - ], - "Resource": "*" - } - ``` - -1. Add IAM policies to the external account\. - - The following example IAM policy allows the principal to use the KMS key in account 123456789012 for cryptographic operations\. To give this permission to `ExampleRole` and `ExampleUser` in account 444455556666, [attach the policy](https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies_managed-using.html#attach-managed-policy-console) to them in that account\. - - ``` - { - "Sid": "Allow use of KMS key in account 123456789012", - "Effect": "Allow", - "Action": [ - "kms:Encrypt", - "kms:Decrypt", - "kms:ReEncrypt*", - "kms:GenerateDataKey*", - "kms:CreateGrant", - "kms:DescribeKey", - "kms:RetireGrant" - ], - "Resource": "arn:aws:kms:us-west-2:123456789012:key/1234abcd-12ab-34cd-56ef-1234567890ab" - } - ``` - -## Exporting a DB snapshot to an Amazon S3 bucket - -You can have up to five concurrent DB snapshot export tasks in progress per AWS account\. - -**Note** -Exporting RDS snapshots can take a while depending on your database type and size\. The export task first restores and scales the entire database before extracting the data to Amazon S3\. The task's progress during this phase displays as **Starting**\. When the task switches to exporting data to S3, progress displays as **In progress**\. -The time it takes for the export to complete depends on the data stored in the database\. For example, tables with well\-distributed numeric primary key or index columns export the fastest\. Tables that don't contain a column suitable for partitioning and tables with only one index on a string\-based column take longer\. This longer export time occurs because the export uses a slower single\-threaded process\. - -You can export a DB snapshot to Amazon S3 using the AWS Management Console, the AWS CLI, or the RDS API\. - -If you use a Lambda function to export a snapshot, add the `kms:DescribeKey` action to the Lambda function policy\. For more information, see [AWS Lambda permissions](https://docs.aws.amazon.com/lambda/latest/dg/lambda-permissions.html)\. - -### Console - -The **Export to Amazon S3** console option appears only for snapshots that can be exported to Amazon S3\. A snapshot might not be available for export because of the following reasons: -+ The DB engine isn't supported for S3 export\. -+ The DB instance version isn't supported for S3 export\. -+ S3 export isn't supported in the AWS Region where the snapshot was created\. - -**To export a DB snapshot** - -1. Sign in to the AWS Management Console and open the Amazon RDS console at [https://console\.aws\.amazon\.com/rds/](https://console.aws.amazon.com/rds/)\. - -1. In the navigation pane, choose **Snapshots**\. - -1. From the tabs, choose the type of snapshot that you want to export\. - -1. In the list of snapshots, choose the snapshot that you want to export\. - -1. For **Actions**, choose **Export to Amazon S3**\. - - The **Export to Amazon S3** window appears\. - -1. For **Export identifier**, enter a name to identify the export task\. This value is also used for the name of the file created in the S3 bucket\. - -1. Choose the data to be exported: - + Choose **All** to export all data in the snapshot\. - + Choose **Partial** to export specific parts of the snapshot\. To identify which parts of the snapshot to export, enter one or more databases, schemas, or tables for **Identifiers**, separated by spaces\. - - Use the following format: - - ``` - database[.schema][.table] database2[.schema2][.table2] ... databasen[.scheman][.tablen] - ``` - - For example: - - ``` - mydatabase mydatabase2.myschema1 mydatabase2.myschema2.mytable1 mydatabase2.myschema2.mytable2 - ``` - -1. For **S3 bucket**, choose the bucket to export to\. - - To assign the exported data to a folder path in the S3 bucket, enter the optional path for **S3 prefix**\. - -1. For **IAM role**, either choose a role that grants you write access to your chosen S3 bucket, or create a new role\. - + If you created a role by following the steps in [Providing access to an Amazon S3 bucket using an IAM role](#USER_ExportSnapshot.SetupIAMRole), choose that role\. - + If you didn't create a role that grants you write access to your chosen S3 bucket, then choose **Create a new role** to create the role automatically\. Next, enter a name for the role in **IAM role name**\. - -1. For **AWS KMS key**, enter the ARN for the key to use for encrypting the exported data\. - -1. Choose **Export to Amazon S3**\. - -### AWS CLI - -To export a DB snapshot to Amazon S3 using the AWS CLI, use the [start\-export\-task](https://docs.aws.amazon.com/cli/latest/reference/rds/start-export-task.html) command with the following required options: -+ `--export-task-identifier` -+ `--source-arn` -+ `--s3-bucket-name` -+ `--iam-role-arn` -+ `--kms-key-id` - -In the following examples, the snapshot export task is named *my\-snapshot\-export*, which exports a snapshot to an S3 bucket named *my\-export\-bucket*\. - -**Example** -For Linux, macOS, or Unix: - -``` -1. aws rds start-export-task \ -2. --export-task-identifier my-snapshot-export \ -3. --source-arn arn:aws:rds:AWS_Region:123456789012:snapshot:snapshot-name \ -4. --s3-bucket-name my-export-bucket \ -5. --iam-role-arn iam-role \ -6. --kms-key-id my-key -``` -For Windows: - -``` -1. aws rds start-export-task ^ -2. --export-task-identifier my-snapshot-export ^ -3. --source-arn arn:aws:rds:AWS_Region:123456789012:snapshot:snapshot-name ^ -4. --s3-bucket-name my-export-bucket ^ -5. --iam-role-arn iam-role ^ -6. --kms-key-id my-key -``` -Sample output follows\. - -``` -{ - "Status": "STARTING", - "IamRoleArn": "iam-role", - "ExportTime": "2019-08-12T01:23:53.109Z", - "S3Bucket": "my-export-bucket", - "PercentProgress": 0, - "KmsKeyId": "my-key", - "ExportTaskIdentifier": "my-snapshot-export", - "TotalExtractedDataInGB": 0, - "TaskStartTime": "2019-11-13T19:46:00.173Z", - "SourceArn": "arn:aws:rds:AWS_Region:123456789012:snapshot:snapshot-name" -} -``` -To provide a folder path in the S3 bucket for the snapshot export, include the `--s3-prefix` option in the [start\-export\-task](https://docs.aws.amazon.com/cli/latest/reference/rds/start-export-task.html) command\. - -### RDS API - -To export a DB snapshot to Amazon S3 using the Amazon RDS API, use the [StartExportTask](https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_StartExportTask.html) operation with the following required parameters: -+ `ExportTaskIdentifier` -+ `SourceArn` -+ `S3BucketName` -+ `IamRoleArn` -+ `KmsKeyId` - -## Monitoring snapshot exports - -You can monitor DB snapshot exports using the AWS Management Console, the AWS CLI, or the RDS API\. - -### Console - -**To monitor DB snapshot exports** - -1. Sign in to the AWS Management Console and open the Amazon RDS console at [https://console\.aws\.amazon\.com/rds/](https://console.aws.amazon.com/rds/)\. - -1. In the navigation pane, choose **Snapshots**\. - -1. To view the list of snapshot exports, choose the **Exports in Amazon S3** tab\. - -1. To view information about a specific snapshot export, choose the export task\. - -### AWS CLI - -To monitor DB snapshot exports using the AWS CLI, use the [ describe\-export\-tasks](https://docs.aws.amazon.com/cli/latest/reference/rds/describe-export-tasks.html) command\. - -The following example shows how to display current information about all of your snapshot exports\. - -**Example** - -``` - 1. aws rds describe-export-tasks - 2. - 3. { - 4. "ExportTasks": [ - 5. { - 6. "Status": "CANCELED", - 7. "TaskEndTime": "2019-11-01T17:36:46.961Z", - 8. "S3Prefix": "something", - 9. "ExportTime": "2019-10-24T20:23:48.364Z", -10. "S3Bucket": "examplebucket", -11. "PercentProgress": 0, -12. "KmsKeyId": "arn:aws:kms:AWS_Region:123456789012:key/K7MDENG/bPxRfiCYEXAMPLEKEY", -13. "ExportTaskIdentifier": "anewtest", -14. "IamRoleArn": "arn:aws:iam::123456789012:role/export-to-s3", -15. "TotalExtractedDataInGB": 0, -16. "TaskStartTime": "2019-10-25T19:10:58.885Z", -17. "SourceArn": "arn:aws:rds:AWS_Region:123456789012:snapshot:parameter-groups-test" -18. }, -19. { -20. "Status": "COMPLETE", -21. "TaskEndTime": "2019-10-31T21:37:28.312Z", -22. "WarningMessage": "{\"skippedTables\":[],\"skippedObjectives\":[],\"general\":[{\"reason\":\"FAILED_TO_EXTRACT_TABLES_LIST_FOR_DATABASE\"}]}", -23. "S3Prefix": "", -24. "ExportTime": "2019-10-31T06:44:53.452Z", -25. "S3Bucket": "examplebucket1", -26. "PercentProgress": 100, -27. "KmsKeyId": "arn:aws:kms:AWS_Region:123456789012:key/2Zp9Utk/h3yCo8nvbEXAMPLEKEY", -28. "ExportTaskIdentifier": "thursday-events-test", -29. "IamRoleArn": "arn:aws:iam::123456789012:role/export-to-s3", -30. "TotalExtractedDataInGB": 263, -31. "TaskStartTime": "2019-10-31T20:58:06.998Z", -32. "SourceArn": "arn:aws:rds:AWS_Region:123456789012:snapshot:rds:example-1-2019-10-31-06-44" -33. }, -34. { -35. "Status": "FAILED", -36. "TaskEndTime": "2019-10-31T02:12:36.409Z", -37. "FailureCause": "The S3 bucket edgcuc-export isn't located in the current AWS Region. Please, review your S3 bucket name and retry the export.", -38. "S3Prefix": "", -39. "ExportTime": "2019-10-30T06:45:04.526Z", -40. "S3Bucket": "examplebucket2", -41. "PercentProgress": 0, -42. "KmsKeyId": "arn:aws:kms:AWS_Region:123456789012:key/2Zp9Utk/h3yCo8nvbEXAMPLEKEY", -43. "ExportTaskIdentifier": "wednesday-afternoon-test", -44. "IamRoleArn": "arn:aws:iam::123456789012:role/export-to-s3", -45. "TotalExtractedDataInGB": 0, -46. "TaskStartTime": "2019-10-30T22:43:40.034Z", -47. "SourceArn": "arn:aws:rds:AWS_Region:123456789012:snapshot:rds:example-1-2019-10-30-06-45" -48. } -49. ] -50. } -``` -To display information about a specific snapshot export, include the `--export-task-identifier` option with the `describe-export-tasks` command\. To filter the output, include the `--Filters` option\. For more options, see the [ describe\-export\-tasks](https://docs.aws.amazon.com/cli/latest/reference/rds/describe-export-tasks.html) command\. - -### RDS API - -To display information about DB snapshot exports using the Amazon RDS API, use the [DescribeExportTasks](https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_DescribeExportTasks.html) operation\. - -To track completion of the export workflow or to initiate another workflow, you can subscribe to Amazon Simple Notification Service topics\. For more information on Amazon SNS, see [Working with Amazon RDS event notification](USER_Events.md)\. - -## Canceling a snapshot export task - -You can cancel a DB snapshot export task using the AWS Management Console, the AWS CLI, or the RDS API\. - -**Note** -Canceling a snapshot export task doesn't remove any data that was exported to Amazon S3\. For information about how to delete the data using the console, see [ How do I delete objects from an S3 bucket?](https://docs.aws.amazon.com/AmazonS3/latest/user-guide/delete-objects.html) To delete the data using the CLI, use the [delete\-object](https://docs.aws.amazon.com/cli/latest/reference/s3api/delete-object.html) command\. - -### Console - -**To cancel a snapshot export task** - -1. Sign in to the AWS Management Console and open the Amazon RDS console at [https://console\.aws\.amazon\.com/rds/](https://console.aws.amazon.com/rds/)\. - -1. In the navigation pane, choose **Snapshots**\. - -1. Choose the **Exports in Amazon S3** tab\. - -1. Choose the snapshot export task that you want to cancel\. - -1. Choose **Cancel**\. - -1. Choose **Cancel export task** on the confirmation page\. - - - -### AWS CLI - -To cancel a snapshot export task using the AWS CLI, use the [cancel\-export\-task](https://docs.aws.amazon.com/cli/latest/reference/rds/cancel-export-task.html) command\. The command requires the `--export-task-identifier` option\. - -**Example** - -``` - 1. aws rds cancel-export-task --export-task-identifier my_export - 2. { - 3. "Status": "CANCELING", - 4. "S3Prefix": "", - 5. "ExportTime": "2019-08-12T01:23:53.109Z", - 6. "S3Bucket": "examplebucket", - 7. "PercentProgress": 0, - 8. "KmsKeyId": "arn:aws:kms:AWS_Region:123456789012:key/K7MDENG/bPxRfiCYEXAMPLEKEY", - 9. "ExportTaskIdentifier": "my_export", -10. "IamRoleArn": "arn:aws:iam::123456789012:role/export-to-s3", -11. "TotalExtractedDataInGB": 0, -12. "TaskStartTime": "2019-11-13T19:46:00.173Z", -13. "SourceArn": "arn:aws:rds:AWS_Region:123456789012:snapshot:export-example-1" -14. } -``` - -### RDS API - -To cancel a snapshot export task using the Amazon RDS API, use the [CancelExportTask](https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_CancelExportTask.html) operation with the `ExportTaskIdentifier` parameter\. - -## Failure messages for Amazon S3 export tasks - -The following table describes the messages that are returned when Amazon S3 export tasks fail\. - - -| Failure message | Description | -| --- | --- | -| An unknown internal error occurred\. | The task has failed because of an unknown error, exception, or failure\. | -| An unknown internal error occurred writing the export task's metadata to the S3 bucket \[bucket name\]\. | The task has failed because of an unknown error, exception, or failure\. | -| The RDS export failed to write the export task's metadata because it can't assume the IAM role \[role ARN\]\. | The export task assumes your IAM role to validate whether it is allowed to write metadata to your S3 bucket\. If the task can't assume your IAM role, it fails\. | -| The RDS export failed to write the export task's metadata to the S3 bucket \[bucket name\] using the IAM role \[role ARN\] with the KMS key \[key ID\]\. Error code: \[error code\] | One or more permissions are missing, so the export task can't access the S3 bucket\. This failure message is raised when receiving one of the following error codes: [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_ExportSnapshot.html) These error codes indicate settings are misconfigured for the IAM role, S3 bucket, or KMS key\. | -| The IAM role \[role ARN\] isn't authorized to call \[S3 action\] on the S3 bucket \[bucket name\]\. Review your permissions and retry the export\. | The IAM policy is misconfigured\. Permission for the specific S3 action on the S3 bucket is missing, which causes the export task to fail\. | -| KMS key check failed\. Check the credentials on your KMS key and try again\. | The KMS key credential check failed\. | -| S3 credential check failed\. Check the permissions on your S3 bucket and IAM policy\. | The S3 credential check failed\. | -| The S3 bucket \[bucket name\] isn't valid\. Either it isn't located in the current AWS Region or it doesn't exist\. Review your S3 bucket name and retry the export\. | The S3 bucket is invalid\. | -| The S3 bucket \[bucket name\] isn't located in the current AWS Region\. Review your S3 bucket name and retry the export\. | The S3 bucket is in the wrong AWS Region\. | - -## Troubleshooting PostgreSQL permissions errors - -When exporting PostgreSQL databases to Amazon S3, you might see a `PERMISSIONS_DO_NOT_EXIST` error stating that certain tables were skipped\. This error usually occurs when the superuser, which you specified when creating the DB instance, doesn't have permissions to access those tables\. - -To fix this error, run the following command: - -``` -GRANT ALL PRIVILEGES ON ALL TABLES IN SCHEMA schema_name TO superuser_name -``` - -For more information on superuser privileges, see [Master user account privileges](UsingWithRDS.MasterAccounts.md)\. - -## File naming convention - -Exported data for specific tables is stored in the format `base_prefix/files`, where the base prefix is the following: - -``` -export_identifier/database_name/schema_name.table_name/ -``` - -For example: - -``` -export-1234567890123-459/rdststdb/rdststdb.DataInsert_7ADB5D19965123A2/ -``` - -There are two conventions for how files are named\. The current convention is the following: - -``` -partition_index/part-00000-random_uuid.format-based_extension -``` - -For example: - -``` -1/part-00000-c5a881bb-58ff-4ee6-1111-b41ecff340a3-c000.gz.parquet -2/part-00000-d7a881cc-88cc-5ab7-2222-c41ecab340a4-c000.gz.parquet -3/part-00000-f5a991ab-59aa-7fa6-3333-d41eccd340a7-c000.gz.parquet -``` - -The older convention is the following: - -``` -part-partition_index-random_uuid.format-based_extension -``` - -For example: - -``` -part-00000-c5a881bb-58ff-4ee6-1111-b41ecff340a3-c000.gz.parquet -part-00001-d7a881cc-88cc-5ab7-2222-c41ecab340a4-c000.gz.parquet -part-00002-f5a991ab-59aa-7fa6-3333-d41eccd340a7-c000.gz.parquet -``` - -The file naming convention is subject to change\. Therefore, when reading target tables, we recommend that you read everything inside the base prefix for the table\. - -## Data conversion when exporting to an Amazon S3 bucket - -When you export a DB snapshot to an Amazon S3 bucket, Amazon RDS converts data to, exports data in, and stores data in the Parquet format\. For more information about Parquet, see the [Apache Parquet](https://parquet.apache.org/docs/) website\. - -Parquet stores all data as one of the following primitive types: -+ BOOLEAN -+ INT32 -+ INT64 -+ INT96 -+ FLOAT -+ DOUBLE -+ BYTE\_ARRAY – A variable\-length byte array, also known as binary -+ FIXED\_LEN\_BYTE\_ARRAY – A fixed\-length byte array used when the values have a constant size - -The Parquet data types are few to reduce the complexity of reading and writing the format\. Parquet provides logical types for extending primitive types\. A *logical type* is implemented as an annotation with the data in a `LogicalType` metadata field\. The logical type annotation explains how to interpret the primitive type\. - -When the `STRING` logical type annotates a `BYTE_ARRAY` type, it indicates that the byte array should be interpreted as a UTF\-8 encoded character string\. After an export task completes, Amazon RDS notifies you if any string conversion occurred\. The underlying data exported is always the same as the data from the source\. However, due to the encoding difference in UTF\-8, some characters might appear different from the source when read in tools such as Athena\. - -For more information, see [Parquet logical type definitions](https://github.com/apache/parquet-format/blob/master/LogicalTypes.md) in the Parquet documentation\. - -**Topics** -+ [MySQL and MariaDB data type mapping to Parquet](#USER_ExportSnapshot.data-types.MySQL) -+ [PostgreSQL data type mapping to Parquet](#USER_ExportSnapshot.data-types.PostgreSQL) - -### MySQL and MariaDB data type mapping to Parquet - -The following table shows the mapping from MySQL and MariaDB data types to Parquet data types when data is converted and exported to Amazon S3\. - -[\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_ExportSnapshot.html) - -### PostgreSQL data type mapping to Parquet - -The following table shows the mapping from PostgreSQL data types to Parquet data types when data is converted and exported to Amazon S3\. - - -| PostgreSQL data type | Parquet primitive type | Logical type annotation | Mapping notes | -| --- | --- | --- | --- | -| Numeric data types | -| BIGINT | INT64 | | | -| BIGSERIAL | INT64 | | | -| DECIMAL | BYTE\_ARRAY | STRING | A DECIMAL type is converted to a string in a BYTE\_ARRAY type and encoded as UTF8\.This conversion is to avoid complications due to data precision and data values that are not a number \(NaN\)\. | -| DOUBLE PRECISION | DOUBLE | | | -| INTEGER | INT32 | | | -| MONEY | BYTE\_ARRAY | STRING | | -| REAL | FLOAT | | | -| SERIAL | INT32 | | | -| SMALLINT | INT32 | INT\_16 | | -| SMALLSERIAL | INT32 | INT\_16 | | -| String and related data types | -| ARRAY | BYTE\_ARRAY | STRING | An array is converted to a string and encoded as BINARY \(UTF8\)\. This conversion is to avoid complications due to data precision, data values that are not a number \(NaN\), and time data values\. | -| BIT | BYTE\_ARRAY | STRING | | -| BIT VARYING | BYTE\_ARRAY | STRING | | -| BYTEA | BINARY | | | -| CHAR | BYTE\_ARRAY | STRING | | -| CHAR\(N\) | BYTE\_ARRAY | STRING | | -| ENUM | BYTE\_ARRAY | STRING | | -| NAME | BYTE\_ARRAY | STRING | | -| TEXT | BYTE\_ARRAY | STRING | | -| TEXT SEARCH | BYTE\_ARRAY | STRING | | -| VARCHAR\(N\) | BYTE\_ARRAY | STRING | | -| XML | BYTE\_ARRAY | STRING | | -| Date and time data types | -| DATE | BYTE\_ARRAY | STRING | | -| INTERVAL | BYTE\_ARRAY | STRING | | -| TIME | BYTE\_ARRAY | STRING | | -| TIME WITH TIME ZONE | BYTE\_ARRAY | STRING | | -| TIMESTAMP | BYTE\_ARRAY | STRING | | -| TIMESTAMP WITH TIME ZONE | BYTE\_ARRAY | STRING | | -| Geometric data types | -| BOX | BYTE\_ARRAY | STRING | | -| CIRCLE | BYTE\_ARRAY | STRING | | -| LINE | BYTE\_ARRAY | STRING | | -| LINESEGMENT | BYTE\_ARRAY | STRING | | -| PATH | BYTE\_ARRAY | STRING | | -| POINT | BYTE\_ARRAY | STRING | | -| POLYGON | BYTE\_ARRAY | STRING | | -| JSON data types | -| JSON | BYTE\_ARRAY | STRING | | -| JSONB | BYTE\_ARRAY | STRING | | -| Other data types | -| BOOLEAN | BOOLEAN | | | -| CIDR | BYTE\_ARRAY | STRING | Network data type | -| COMPOSITE | BYTE\_ARRAY | STRING | | -| DOMAIN | BYTE\_ARRAY | STRING | | -| INET | BYTE\_ARRAY | STRING | Network data type | -| MACADDR | BYTE\_ARRAY | STRING | | -| OBJECT IDENTIFIER | N/A | | | -| PG\_LSN | BYTE\_ARRAY | STRING | | -| RANGE | BYTE\_ARRAY | STRING | | -| UUID | BYTE\_ARRAY | STRING | | \ No newline at end of file diff --git a/doc_source/USER_ListEvents.md b/doc_source/USER_ListEvents.md deleted file mode 100644 index 243d2d4..0000000 --- a/doc_source/USER_ListEvents.md +++ /dev/null @@ -1,107 +0,0 @@ -# Viewing Amazon RDS events - -You can retrieve the following event information for your Amazon RDS resources: -+ Resource name -+ Resource type -+ Time of the event -+ Message summary of the event - -Access the events through the AWS Management Console, which shows events from the past 24 hours\. You can also retrieve events by using the [describe\-events](https://docs.aws.amazon.com/cli/latest/reference/rds/describe-events.html) AWS CLI command, or the [DescribeEvents](https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_DescribeEvents.html) RDS API operation\. If you use the AWS CLI or the RDS API to view events, you can retrieve events for up to the past 14 days\. - -**Note** -If you need to store events for longer periods of time, you can send Amazon RDS events to CloudWatch Events\. For more information, see [Creating a rule that triggers on an Amazon RDS event](rds-cloud-watch-events.md) - -For descriptions of the Amazon RDS events, see [Amazon RDS event categories and event messages](USER_Events.Messages.md)\. - -To access detailed information about events using AWS CloudTrail, including request parameters, see [CloudTrail events](logging-using-cloudtrail.md#service-name-info-in-cloudtrail.events)\. - -## Console - -**To view all Amazon RDS events for the past 24 hours** - -1. Sign in to the AWS Management Console and open the Amazon RDS console at [https://console\.aws\.amazon\.com/rds/](https://console.aws.amazon.com/rds/)\. - -1. In the navigation pane, choose **Events**\. - - The available events appear in a list\. - -1. \(Optional\) Enter a search term to filter your results\. - - The following example shows a list of events filtered by the characters **stopped**\. -![\[List DB events\]](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/images/ListEvents.png) - -## AWS CLI - -To view all events generated in the last hour, call [describe\-events](https://docs.aws.amazon.com/cli/latest/reference/rds/describe-events.html) with no parameters\. - -``` -aws rds describe-events -``` - -The following sample output shows that a DB instance has been stopped\. - -``` -{ - "Events": [ - { - "EventCategories": [ - "notification" - ], - "SourceType": "db-instance", - "SourceArn": "arn:aws:rds:us-east-1:123456789012:db:testinst", - "Date": "2022-04-22T21:31:00.681Z", - "Message": "DB instance stopped", - "SourceIdentifier": "testinst" - } - ] -} -``` - -To view all Amazon RDS events for the past 10080 minutes \(7 days\), call the [describe\-events](https://docs.aws.amazon.com/cli/latest/reference/rds/describe-events.html) AWS CLI command and set the `--duration` parameter to `10080`\. - -``` -1. aws rds describe-events --duration 10080 -``` - -The following example shows the events in the specified time range for DB instance *test\-instance*\. - -``` -aws rds describe-events \ - --source-identifier test-instance \ - --source-type db-instance \ - --start-time 2022-03-13T22:00Z \ - --end-time 2022-03-13T23:59Z -``` - -The following sample output shows the status of a backup\. - -``` -{ - "Events": [ - { - "SourceType": "db-instance", - "SourceIdentifier": "test-instance", - "EventCategories": [ - "backup" - ], - "Message": "Backing up DB instance", - "Date": "2022-03-13T23:09:23.983Z", - "SourceArn": "arn:aws:rds:us-east-1:123456789012:db:test-instance" - }, - { - "SourceType": "db-instance", - "SourceIdentifier": "test-instance", - "EventCategories": [ - "backup" - ], - "Message": "Finished DB Instance backup", - "Date": "2022-03-13T23:15:13.049Z", - "SourceArn": "arn:aws:rds:us-east-1:123456789012:db:test-instance" - } - ] -} -``` - -## API - -You can view all Amazon RDS instance events for the past 14 days by calling the [DescribeEvents](https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_DescribeEvents.html) RDS API operation and setting the `Duration` parameter to `20160`\. \ No newline at end of file diff --git a/doc_source/USER_LogAccess.Concepts.MariaDB.md b/doc_source/USER_LogAccess.Concepts.MariaDB.md deleted file mode 100644 index 8a6d552..0000000 --- a/doc_source/USER_LogAccess.Concepts.MariaDB.md +++ /dev/null @@ -1,342 +0,0 @@ -# MariaDB database log files - -You can monitor the MariaDB error log, slow query log, and the general log\. The MariaDB error log is generated by default; you can generate the slow query and general logs by setting parameters in your DB parameter group\. Amazon RDS rotates all of the MariaDB log files; the intervals for each type are given following\. - -You can monitor the MariaDB logs directly through the Amazon RDS console, Amazon RDS API, Amazon RDS CLI, or AWS SDKs\. You can also access MariaDB logs by directing the logs to a database table in the main database and querying that table\. You can use the mysqlbinlog utility to download a binary log\. - -For more information about viewing, downloading, and watching file\-based database logs, see [Monitoring Amazon RDS log files](USER_LogAccess.md)\. - -**Topics** -+ [Accessing MariaDB error logs](#USER_LogAccess.MariaDB.Errorlog) -+ [Accessing the MariaDB slow query and general logs](#USER_LogAccess.MariaDB.Generallog) -+ [Publishing MariaDB logs to Amazon CloudWatch Logs](#USER_LogAccess.MariaDB.PublishtoCloudWatchLogs) -+ [Log file size](#USER_LogAccess.MariaDB.LogFileSize) -+ [Managing table\-based MariaDB logs](#Appendix.MariaDB.CommonDBATasks.Logs) -+ [Binary logging format](#USER_LogAccess.MariaDB.BinaryFormat) -+ [Accessing MariaDB binary logs](#USER_LogAccess.MariaDB.Binarylog) -+ [Binary log annotation](#USER_LogAccess.MariaDB.BinarylogAnnotation) - -## Accessing MariaDB error logs - -The MariaDB error log is written to the `.err` file\. You can view this file by using the Amazon RDS console, You can also retrieve the log using the Amazon RDS API, Amazon RDS CLI, or AWS SDKs\. The `.err` file is flushed every 5 minutes, and its contents are appended to `mysql-error-running.log`\. The `mysql-error-running.log` file is then rotated every hour and the hourly files generated during the last 24 hours are retained\. Each log file has the hour it was generated \(in UTC\) appended to its name\. The log files also have a timestamp that helps you determine when the log entries were written\. - -MariaDB writes to the error log only on startup, shutdown, and when it encounters errors\. A DB instance can go hours or days without new entries being written to the error log\. If you see no recent entries, it's because the server did not encounter an error that resulted in a log entry\. - -## Accessing the MariaDB slow query and general logs - -You can write the MariaDB slow query log and general log to a file or database table by setting parameters in your DB parameter group\. For information about creating and modifying a DB parameter group, see [Working with parameter groups](USER_WorkingWithParamGroups.md)\. You must set these parameters before you can view the slow query log or general log in the Amazon RDS console or by using the Amazon RDS API, AWS CLI, or AWS SDKs\. - -You can control MariaDB logging by using the parameters in this list: -+ `slow_query_log`: To create the slow query log, set to 1\. The default is 0\. -+ `general_log`: To create the general log, set to 1\. The default is 0\. -+ `long_query_time`: To prevent fast\-running queries from being logged in the slow query log, specify a value for the shortest query run time to be logged, in seconds\. The default is 10 seconds; the minimum is 0\. If log\_output = FILE, you can specify a floating point value that goes to microsecond resolution\. If log\_output = TABLE, you must specify an integer value with second resolution\. Only queries whose run time exceeds the `long_query_time` value are logged\. For example, setting `long_query_time` to 0\.1 prevents any query that runs for less than 100 milliseconds from being logged\. -+ `log_queries_not_using_indexes`: To log all queries that do not use an index to the slow query log, set this parameter to 1\. The default is 0\. Queries that do not use an index are logged even if their run time is less than the value of the `long_query_time` parameter\. -+ `log_output option`: You can specify one of the following options for the `log_output` parameter: - + **TABLE** \(default\)– Write general queries to the `mysql.general_log` table, and slow queries to the `mysql.slow_log` table\. - + **FILE**– Write both general and slow query logs to the file system\. Log files are rotated hourly\. - + **NONE**– Disable logging\. - -When logging is enabled, Amazon RDS rotates table logs or deletes log files at regular intervals\. This measure is a precaution to reduce the possibility of a large log file either blocking database use or affecting performance\. `FILE` and `TABLE` logging approach rotation and deletion as follows: -+ When `FILE` logging is enabled, log files are examined every hour and log files older than 24 hours are deleted\. In some cases, the remaining combined log file size after the deletion might exceed the threshold of 2 percent of a DB instance's allocated space\. In these cases, the largest log files are deleted until the log file size no longer exceeds the threshold\. -+ When `TABLE` logging is enabled, in some cases log tables are rotated every 24 hours\. This rotation occurs if the space used by the table logs is more than 20 percent of the allocated storage space\. It also occurs if the size of all logs combined is greater than 10 GB\. If the amount of space used for a DB instance is greater than 90 percent of the DB instance's allocated storage space, the thresholds for log rotation are reduced\. Log tables are then rotated if the space used by the table logs is more than 10 percent of the allocated storage space\. They're also rotated if the size of all logs combined is greater than 5 GB\. - - When log tables are rotated, the current log table is copied to a backup log table and the entries in the current log table are removed\. If the backup log table already exists, then it is deleted before the current log table is copied to the backup\. You can query the backup log table if needed\. The backup log table for the `mysql.general_log` table is named `mysql.general_log_backup`\. The backup log table for the `mysql.slow_log` table is named `mysql.slow_log_backup`\. - - You can rotate the `mysql.general_log` table by calling the `mysql.rds_rotate_general_log` procedure\. You can rotate the `mysql.slow_log` table by calling the `mysql.rds_rotate_slow_log` procedure\. - - Table logs are rotated during a database version upgrade\. - -Amazon RDS records both `TABLE` and `FILE` log rotation in an Amazon RDS event and sends you a notification\. - -To work with the logs from the Amazon RDS console, Amazon RDS API, Amazon RDS CLI, or AWS SDKs, set the `log_output` parameter to FILE\. Like the MariaDB error log, these log files are rotated hourly\. The log files that were generated during the previous 24 hours are retained\. - -For more information about the slow query and general logs, go to the following topics in the MariaDB documentation: -+ [Slow query log](http://mariadb.com/kb/en/mariadb/slow-query-log/) -+ [General query log](http://mariadb.com/kb/en/mariadb/general-query-log/) - -## Publishing MariaDB logs to Amazon CloudWatch Logs - -You can configure your MariaDB DB instance to publish log data to a log group in Amazon CloudWatch Logs\. With CloudWatch Logs, you can perform real\-time analysis of the log data, and use CloudWatch to create alarms and view metrics\. You can use CloudWatch Logs to store your log records in highly durable storage\. - -Amazon RDS publishes each MariaDB database log as a separate database stream in the log group\. For example, suppose that you configure the export function to include the slow query log\. Then slow query data is stored in a slow query log stream in the `/aws/rds/instance/my_instance/slowquery` log group\. - -The error log is enabled by default\. The following table summarizes the requirements for the other MariaDB logs\. - - -| Log | Requirement | -| --- | --- | -| Audit log | The DB instance must use a custom option group with the `MARIADB_AUDIT_PLUGIN` option\. | -| General log | The DB instance must use a custom parameter group with the parameter setting `general_log = 1` to enable the general log\. | -| Slow query log | The DB instance must use a custom parameter group with the parameter setting `slow_query_log = 1` to enable the slow query log\. | -| Log output | The DB instance must use a custom parameter group with the parameter setting `log_output = FILE` to write logs to the file system and publish them to CloudWatch Logs\. | - -### Console - -**To publish MariaDB logs to CloudWatch Logs from the console** - -1. Open the Amazon RDS console at [https://console\.aws\.amazon\.com/rds/](https://console.aws.amazon.com/rds/)\. - -1. In the navigation pane, choose **Databases**, and then choose the DB instance that you want to modify\. - -1. Choose **Modify**\. - -1. In the **Log exports** section, choose the logs that you want to start publishing to CloudWatch Logs\. - -1. Choose **Continue**, and then choose **Modify DB Instance** on the summary page\. - -### AWS CLI - -You can publish a MariaDB logs with the AWS CLI\. You can call the [https://docs.aws.amazon.com/cli/latest/reference/rds/modify-db-instance.html](https://docs.aws.amazon.com/cli/latest/reference/rds/modify-db-instance.html) command with the following parameters: -+ `--db-instance-identifier` -+ `--cloudwatch-logs-export-configuration` - -**Note** -A change to the `--cloudwatch-logs-export-configuration` option is always applied to the DB instance immediately\. Therefore, the `--apply-immediately` and `--no-apply-immediately` options have no effect\. - -You can also publish MariaDB logs by calling the following AWS CLI commands: -+ [https://docs.aws.amazon.com/cli/latest/reference/rds/create-db-instance.html](https://docs.aws.amazon.com/cli/latest/reference/rds/create-db-instance.html) -+ [https://docs.aws.amazon.com/cli/latest/reference/rds/restore-db-instance-from-db-snapshot.html](https://docs.aws.amazon.com/cli/latest/reference/rds/restore-db-instance-from-db-snapshot.html) -+ [https://docs.aws.amazon.com/cli/latest/reference/rds/restore-db-instance-from-s3.html](https://docs.aws.amazon.com/cli/latest/reference/rds/restore-db-instance-from-s3.html) -+ [https://docs.aws.amazon.com/cli/latest/reference/rds/restore-db-instance-to-point-in-time.html](https://docs.aws.amazon.com/cli/latest/reference/rds/restore-db-instance-to-point-in-time.html) - -Run one of these AWS CLI commands with the following options: -+ `--db-instance-identifier` -+ `--enable-cloudwatch-logs-exports` -+ `--db-instance-class` -+ `--engine` - -Other options might be required depending on the AWS CLI command you run\. - -**Example** -The following example modifies an existing MariaDB DB instance to publish log files to CloudWatch Logs\. The `--cloudwatch-logs-export-configuration` value is a JSON object\. The key for this object is `EnableLogTypes`, and its value is an array of strings with any combination of `audit`, `error`, `general`, and `slowquery`\. -For Linux, macOS, or Unix: - -``` -1. aws rds modify-db-instance \ -2. --db-instance-identifier mydbinstance \ -3. --cloudwatch-logs-export-configuration '{"EnableLogTypes":["audit","error","general","slowquery"]}' -``` -For Windows: - -``` -1. aws rds modify-db-instance ^ -2. --db-instance-identifier mydbinstance ^ -3. --cloudwatch-logs-export-configuration '{"EnableLogTypes":["audit","error","general","slowquery"]}' -``` - -**Example** -The following command creates a MariaDB DB instance and publishes log files to CloudWatch Logs\. The `--enable-cloudwatch-logs-exports` value is a JSON array of strings\. The strings can be any combination of `audit`, `error`, `general`, and `slowquery`\. -For Linux, macOS, or Unix: - -``` -1. aws rds create-db-instance \ -2. --db-instance-identifier mydbinstance \ -3. --enable-cloudwatch-logs-exports '["audit","error","general","slowquery"]' \ -4. --db-instance-class db.m4.large \ -5. --engine mariadb -``` -For Windows: - -``` -1. aws rds create-db-instance ^ -2. --db-instance-identifier mydbinstance ^ -3. --enable-cloudwatch-logs-exports '["audit","error","general","slowquery"]' ^ -4. --db-instance-class db.m4.large ^ -5. --engine mariadb -``` - -### RDS API - -You can publish MariaDB logs with the RDS API\. You can call the [https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_ModifyDBInstance.html](https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_ModifyDBInstance.html) operation with the following parameters: -+ `DBInstanceIdentifier` -+ `CloudwatchLogsExportConfiguration` - -**Note** -A change to the `CloudwatchLogsExportConfiguration` parameter is always applied to the DB instance immediately\. Therefore, the `ApplyImmediately` parameter has no effect\. - -You can also publish MariaDB logs by calling the following RDS API operations: -+ [https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_CreateDBInstance.html](https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_CreateDBInstance.html) -+ [https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_RestoreDBInstanceFromDBSnapshot.html](https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_RestoreDBInstanceFromDBSnapshot.html) -+ [https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_RestoreDBInstanceFromS3.html](https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_RestoreDBInstanceFromS3.html) -+ [https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_RestoreDBInstanceToPointInTime.html](https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_RestoreDBInstanceToPointInTime.html) - -Run one of these RDS API operations with the following parameters: -+ `DBInstanceIdentifier` -+ `EnableCloudwatchLogsExports` -+ `Engine` -+ `DBInstanceClass` - -Other parameters might be required depending on the AWS CLI command you run\. - -## Log file size - -The MariaDB slow query log, error log, and the general log file sizes are constrained to no more than 2 percent of the allocated storage space for a DB instance\. To maintain this threshold, logs are automatically rotated every hour and log files older than 24 hours are removed\. If the combined log file size exceeds the threshold after removing old log files, then the largest log files are deleted until the log file size no longer exceeds the threshold\. - -## Managing table\-based MariaDB logs - -You can direct the general and slow query logs to tables on the DB instance\. To do so, create a DB parameter group and set the `log_output` server parameter to `TABLE`\. General queries are then logged to the `mysql.general_log` table, and slow queries are logged to the `mysql.slow_log` table\. You can query the tables to access the log information\. Enabling this logging increases the amount of data written to the database, which can degrade performance\. - -Both the general log and the slow query logs are disabled by default\. In order to enable logging to tables, you must also set the `general_log` and `slow_query_log` server parameters to `1`\. - -Log tables keep growing until the respective logging activities are turned off by resetting the appropriate parameter to `0`\. A large amount of data often accumulates over time, which can use up a considerable percentage of your allocated storage space\. Amazon RDS does not allow you to truncate the log tables, but you can move their contents\. Rotating a table saves its contents to a backup table and then creates a new empty log table\. You can manually rotate the log tables with the following command line procedures, where the command prompt is indicated by `PROMPT>`: - -``` -PROMPT> CALL mysql.rds_rotate_slow_log; -PROMPT> CALL mysql.rds_rotate_general_log; -``` - - To completely remove the old data and reclaim the disk space, call the appropriate procedure twice in succession\. - -## Binary logging format - -MariaDB on Amazon RDS supports the *row\-based*, *statement\-based*, and *mixed* binary logging formats\. The default binary logging format is *mixed*\. For details on the different MariaDB binary log formats, see [Binary log formats](http://mariadb.com/kb/en/mariadb/binary-log-formats/) in the MariaDB documentation\. - -If you plan to use replication, the binary logging format is important\. This is because it determines the record of data changes that is recorded in the source and sent to the replication targets\. For information about the advantages and disadvantages of different binary logging formats for replication, see [Advantages and disadvantages of statement\-based and row\-based replication](https://dev.mysql.com/doc/refman/5.7/en/replication-sbr-rbr.html) in the MySQL documentation\. - -**Important** -Setting the binary logging format to row\-based can result in very large binary log files\. Large binary log files reduce the amount of storage available for a DB instance\. They also can increase the amount of time to perform a restore operation of a DB instance\. -Statement\-based replication can cause inconsistencies between the source DB instance and a read replica\. For more information, see [ Unsafe statements for statement\-based replication](https://mariadb.com/kb/en/library/unsafe-statements-for-statement-based-replication/) in the MariaDB documentation\. - -**To set the MariaDB binary logging format** - -1. Sign in to the AWS Management Console and open the Amazon RDS console at [https://console\.aws\.amazon\.com/rds/](https://console.aws.amazon.com/rds/)\. - -1. In the navigation pane, choose **Parameter groups**\. - -1. Choose the parameter group that is used by the DB instance that you want to modify\. - - You can't modify a default parameter group\. If the DB instance is using a default parameter group, create a new parameter group and associate it with the DB instance\. - - For more information on DB parameter groups, see [Working with parameter groups](USER_WorkingWithParamGroups.md)\. - -1. For **Parameter group actions**, choose **Edit**\. - -1. Set the `binlog_format` parameter to the binary logging format of your choice \(**ROW**, **STATEMENT**, or **MIXED**\)\. - -1. Choose **Save changes** to save the updates to the DB parameter group\. - -## Accessing MariaDB binary logs - -You can use the mysqlbinlog utility to download binary logs in text format from MariaDB DB instances\. The binary log is downloaded to your local computer\. For more information about using the mysqlbinlog utility, go to [Using mysqlbinlog](http://mariadb.com/kb/en/mariadb/using-mysqlbinlog/) in the MariaDB documentation\. - - To run the mysqlbinlog utility against an Amazon RDS instance, use the following options: -+ Specify the `--read-from-remote-server` option\. -+ `--host`: Specify the DNS name from the endpoint of the instance\. -+ `--port`: Specify the port used by the instance\. -+ `--user`: Specify a MariaDB user that has been granted the replication slave permission\. -+ `--password`: Specify the password for the user, or omit a password value so the utility prompts you for a password\. -+ `--result-file`: Specify the local file that receives the output\. -+ Specify the names of one or more binary log files\. To get a list of the available logs, use the SQL command SHOW BINARY LOGS\. - -For more information about mysqlbinlog options, go to [mysqlbinlog options](http://mariadb.com/kb/en/mariadb/mysqlbinlog-options/) in the MariaDB documentation\. - - The following is an example: - -For Linux, macOS, or Unix: - -``` -mysqlbinlog \ - --read-from-remote-server \ - --host=mariadbinstance1.1234abcd.region.rds.amazonaws.com \ - --port=3306 \ - --user ReplUser \ - --password \ - --result-file=/tmp/binlog.txt -``` - -For Windows: - -``` -mysqlbinlog ^ - --read-from-remote-server ^ - --host=mariadbinstance1.1234abcd.region.rds.amazonaws.com ^ - --port=3306 ^ - --user ReplUser ^ - --password ^ - --result-file=/tmp/binlog.txt -``` - -Amazon RDS normally purges a binary log as soon as possible\. However, the binary log must still be available on the instance to be accessed by mysqlbinlog\. To specify the number of hours for RDS to retain binary logs, use the `mysql.rds_set_configuration` stored procedure\. Specify a period with enough time for you to download the logs\. After you set the retention period, monitor storage usage for the DB instance to ensure that the retained binary logs don't take up too much storage\. - -The following example sets the retention period to 1 day\. - -``` -call mysql.rds_set_configuration('binlog retention hours', 24); -``` - -To display the current setting, use the `mysql.rds_show_configuration` stored procedure\. - -``` -call mysql.rds_show_configuration; -``` - -## Binary log annotation - -In a MariaDB DB instance, you can use the `Annotate_rows` event to annotate a row event with a copy of the SQL query that caused the row event\. This approach provides similar functionality to enabling the `binlog_rows_query_log_events` parameter on an RDS for MySQL DB instance\. - -You can enable binary log annotations globally by creating a custom parameter group and setting the `binlog_annotate_row_events` parameter to **1**\. You can also enable annotations at the session level, by calling `SET SESSION binlog_annotate_row_events = 1`\. Use the `replicate_annotate_row_events` to replicate binary log annotations to the replica instance if binary logging is enabled on it\. No special privileges are required to use these settings\. - -The following is an example of a row\-based transaction in MariaDB\. The use of row\-based logging is triggered by setting the transaction isolation level to read\-committed\. - -``` -CREATE DATABASE IF NOT EXISTS test; -USE test; -CREATE TABLE square(x INT PRIMARY KEY, y INT NOT NULL) ENGINE = InnoDB; -SET SESSION TRANSACTION ISOLATION LEVEL READ COMMITTED; -BEGIN -INSERT INTO square(x, y) VALUES(5, 5 * 5); -COMMIT; -``` - -Without annotations, the binary log entries for the transaction look like the following: - -``` -BEGIN -/*!*/; -# at 1163 -# at 1209 -#150922 7:55:57 server id 1855786460 end_log_pos 1209 Table_map: `test`.`square` mapped to number 76 -#150922 7:55:57 server id 1855786460 end_log_pos 1247 Write_rows: table id 76 flags: STMT_END_F -### INSERT INTO `test`.`square` -### SET -### @1=5 -### @2=25 -# at 1247 -#150922 7:56:01 server id 1855786460 end_log_pos 1274 Xid = 62 -COMMIT/*!*/; -``` - -The following statement enables session\-level annotations for this same transaction, and disables them after committing the transaction: - -``` -CREATE DATABASE IF NOT EXISTS test; -USE test; -CREATE TABLE square(x INT PRIMARY KEY, y INT NOT NULL) ENGINE = InnoDB; -SET SESSION TRANSACTION ISOLATION LEVEL READ COMMITTED; -SET SESSION binlog_annotate_row_events = 1; -BEGIN; -INSERT INTO square(x, y) VALUES(5, 5 * 5); -COMMIT; -SET SESSION binlog_annotate_row_events = 0; -``` - -With annotations, the binary log entries for the transaction look like the following: - -``` -BEGIN -/*!*/; -# at 423 -# at 483 -# at 529 -#150922 8:04:24 server id 1855786460 end_log_pos 483 Annotate_rows: -#Q> INSERT INTO square(x, y) VALUES(5, 5 * 5) -#150922 8:04:24 server id 1855786460 end_log_pos 529 Table_map: `test`.`square` mapped to number 76 -#150922 8:04:24 server id 1855786460 end_log_pos 567 Write_rows: table id 76 flags: STMT_END_F -### INSERT INTO `test`.`square` -### SET -### @1=5 -### @2=25 -# at 567 -#150922 8:04:26 server id 1855786460 end_log_pos 594 Xid = 88 -COMMIT/*!*/; -``` \ No newline at end of file diff --git a/doc_source/USER_LogAccess.Concepts.MySQL.md b/doc_source/USER_LogAccess.Concepts.MySQL.md deleted file mode 100644 index 6e55c35..0000000 --- a/doc_source/USER_LogAccess.Concepts.MySQL.md +++ /dev/null @@ -1,12 +0,0 @@ -# MySQL database log files - -You can monitor the MySQL logs directly through the Amazon RDS console, Amazon RDS API, AWS CLI, or AWS SDKs\. You can also access MySQL logs by directing the logs to a database table in the main database and querying that table\. You can use the mysqlbinlog utility to download a binary log\. - -For more information about viewing, downloading, and watching file\-based database logs, see [Monitoring Amazon RDS log files](USER_LogAccess.md)\. - -**Topics** -+ [Overview of RDS for MySQL database logs](USER_LogAccess.MySQL.LogFileSize.md) -+ [Publishing MySQL logs to Amazon CloudWatch Logs](USER_LogAccess.MySQLDB.PublishtoCloudWatchLogs.md) -+ [Managing table\-based MySQL logs](Appendix.MySQL.CommonDBATasks.Logs.md) -+ [Configuring MySQL binary logging](USER_LogAccess.MySQL.BinaryFormat.md) -+ [Accessing MySQL binary logs](USER_LogAccess.MySQL.Binarylog.md) \ No newline at end of file diff --git a/doc_source/USER_LogAccess.Concepts.Oracle.md b/doc_source/USER_LogAccess.Concepts.Oracle.md deleted file mode 100644 index 54ba774..0000000 --- a/doc_source/USER_LogAccess.Concepts.Oracle.md +++ /dev/null @@ -1,311 +0,0 @@ -# Oracle database log files - -You can access Oracle alert logs, audit files, and trace files by using the Amazon RDS console or API\. For more information about viewing, downloading, and watching file\-based database logs, see [Monitoring Amazon RDS log files](USER_LogAccess.md)\. - -The Oracle audit files provided are the standard Oracle auditing files\. Amazon RDS supports the Oracle fine\-grained auditing \(FGA\) feature\. However, log access doesn't provide access to FGA events that are stored in the `SYS.FGA_LOG$` table and that are accessible through the `DBA_FGA_AUDIT_TRAIL` view\. - -The [https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_DescribeDBLogFiles.html](https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_DescribeDBLogFiles.html) API operation that lists the Oracle log files that are available for a DB instance ignores the `MaxRecords` parameter and returns up to 1,000 records\. The call returns `LastWritten` as a POSIX date in milliseconds\. - -**Topics** -+ [Retention schedule](#USER_LogAccess.Concepts.Oracle.Retention) -+ [Working with Oracle trace files](#USER_LogAccess.Concepts.Oracle.WorkingWithTracefiles) -+ [Publishing Oracle logs to Amazon CloudWatch Logs](#USER_LogAccess.Oracle.PublishtoCloudWatchLogs) -+ [Previous methods for accessing alert logs and listener logs](#USER_LogAccess.Concepts.Oracle.AlertLogAndListenerLog) - -## Retention schedule - -The Oracle database engine might rotate log files if they get very large\. To retain audit or trace files, download them\. If you store the files locally, you reduce your Amazon RDS storage costs and make more space available for your data\. - -The following table shows the retention schedule for Oracle alert logs, audit files, and trace files on Amazon RDS\. - - -**** - -| Log type | Retention schedule | -| --- | --- | -| Alert logs | The text alert log is rotated daily with 30\-day retention managed by Amazon RDS\. The XML alert log is retained for at least seven days\. You can access this log by using the `ALERTLOG` view\. | -| Audit files | The default retention period for audit files is seven days\. Amazon RDS might delete audit files older than seven days\. | -| Trace files | The default retention period for trace files is seven days\. Amazon RDS might delete trace files older than seven days\. | -| Listener logs | The default retention period for the listener logs is seven days\. Amazon RDS might delete listener logs older than seven days\. | - -**Note** -Audit files and trace files share the same retention configuration\. - -## Working with Oracle trace files - -Following, you can find descriptions of Amazon RDS procedures to create, refresh, access, and delete trace files\. - -**Topics** -+ [Listing files](#USER_LogAccess.Concepts.Oracle.WorkingWithTracefiles.ViewingBackgroundDumpDest) -+ [Generating trace files and tracing a session](#USER_LogAccess.Concepts.Oracle.WorkingWithTracefiles.Generating) -+ [Retrieving trace files](#USER_LogAccess.Concepts.Oracle.WorkingWithTracefiles.Retrieving) -+ [Purging trace files](#USER_LogAccess.Concepts.Oracle.WorkingWithTracefiles.Purging) - -### Listing files - -You can use either of two procedures to allow access to any file in the `background_dump_dest` path\. The first procedure refreshes a view containing a listing of all files currently in `background_dump_dest`\. - -``` -1. EXEC rdsadmin.manage_tracefiles.refresh_tracefile_listing; -``` - -After the view is refreshed, query the following view to access the results\. - -``` -1. SELECT * FROM rdsadmin.tracefile_listing; -``` - -An alternative to the previous process is to use `FROM table` to stream nonrelational data in a table\-like format to list database directory contents\. - -``` -1. SELECT * FROM TABLE(rdsadmin.rds_file_util.listdir('BDUMP')); -``` - -The following query shows the text of a log file\. - -``` -1. SELECT text FROM TABLE(rdsadmin.rds_file_util.read_text_file('BDUMP','alert_dbname.log.date')); -``` - -On a read replica, get the name of the BDUMP directory by querying `V$DATABASE.DB_UNIQUE_NAME`\. If the unique name is `DATABASE_B`, then the BDUMP directory is `BDUMP_B`\. The following example queries the BDUMP name on a replica and then uses this name to query the contents of `alert_DATABASE.log.2020-06-23`\. - -``` -1. SELECT 'BDUMP' || (SELECT regexp_replace(DB_UNIQUE_NAME,'.*(_[A-Z])', '\1') FROM V$DATABASE) AS BDUMP_VARIABLE FROM DUAL; -2. -3. BDUMP_VARIABLE -4. -------------- -5. BDUMP_B -6. -7. SELECT TEXT FROM table(rdsadmin.rds_file_util.read_text_file('BDUMP_B','alert_DATABASE.log.2020-06-23')); -``` - -### Generating trace files and tracing a session - -Because there are no restrictions on `ALTER SESSION`, many standard methods to generate trace files in Oracle remain available to an Amazon RDS DB instance\. The following procedures are provided for trace files that require greater access\. - - -**** - -| Oracle method | Amazon RDS method | -| --- | --- | -| `oradebug hanganalyze 3 ` | `EXEC rdsadmin.manage_tracefiles.hanganalyze; ` | -| `oradebug dump systemstate 266 ` | `EXEC rdsadmin.manage_tracefiles.dump_systemstate;` | - -You can use many standard methods to trace individual sessions connected to an Oracle DB instance in Amazon RDS\. To enable tracing for a session, you can run subprograms in PL/SQL packages supplied by Oracle, such as `DBMS_SESSION` and `DBMS_MONITOR`\. For more information, see [ Enabling tracing for a session](https://docs.oracle.com/database/121/TGSQL/tgsql_trace.htm#GUID-F872D6F9-E015-481F-80F6-8A7036A6AD29) in the Oracle documentation\. - -### Retrieving trace files - -You can retrieve any trace file in `background_dump_dest` using a standard SQL query on an Amazon RDS–managed external table\. To use this method, you must execute the procedure to set the location for this table to the specific trace file\. - -For example, you can use the `rdsadmin.tracefile_listing` view mentioned preceding to list all of the trace files on the system\. You can then set the `tracefile_table` view to point to the intended trace file using the following procedure\. - -``` -1. EXEC rdsadmin.manage_tracefiles.set_tracefile_table_location('CUST01_ora_3260_SYSTEMSTATE.trc'); -``` - -The following example creates an external table in the current schema with the location set to the file provided\. You can retrieve the contents into a local file using a SQL query\. - -``` -1. SPOOL /tmp/tracefile.txt -2. SELECT * FROM tracefile_table; -3. SPOOL OFF; -``` - -### Purging trace files - -Trace files can accumulate and consume disk space\. Amazon RDS purges trace files by default and log files that are older than seven days\. You can view and set the trace file retention period using the `show_configuration` procedure\. You should run the command `SET SERVEROUTPUT ON` so that you can view the configuration results\. - -The following example shows the current trace file retention period, and then sets a new trace file retention period\. - -``` - 1. # Show the current tracefile retention - 2. SQL> EXEC rdsadmin.rdsadmin_util.show_configuration; - 3. NAME:tracefile retention - 4. VALUE:10080 - 5. DESCRIPTION:tracefile expiration specifies the duration in minutes before tracefiles in bdump are automatically deleted. - 6. - 7. # Set the tracefile retention to 24 hours: - 8. SQL> EXEC rdsadmin.rdsadmin_util.set_configuration('tracefile retention',1440); - 9. SQL> commit; -10. -11. #show the new tracefile retention -12. SQL> EXEC rdsadmin.rdsadmin_util.show_configuration; -13. NAME:tracefile retention -14. VALUE:1440 -15. DESCRIPTION:tracefile expiration specifies the duration in minutes before tracefiles in bdump are automatically deleted. -``` - -In addition to the periodic purge process, you can manually remove files from the `background_dump_dest`\. The following example shows how to purge all files older than five minutes\. - -``` -EXEC rdsadmin.manage_tracefiles.purge_tracefiles(5); -``` - -You can also purge all files that match a specific pattern \(if you do, don't include the file extension, such as \.trc\)\. The following example shows how to purge all files that start with `SCHPOC1_ora_5935`\. - -``` -1. EXEC rdsadmin.manage_tracefiles.purge_tracefiles('SCHPOC1_ora_5935'); -``` - -## Publishing Oracle logs to Amazon CloudWatch Logs - -You can configure your Amazon RDS for Oracle DB instance to publish log data to a log group in Amazon CloudWatch Logs\. With CloudWatch Logs, you can analyze the log data, and use CloudWatch to create alarms and view metrics\. You can use CloudWatch Logs to store your log records in highly durable storage\. - -Amazon RDS publishes each Oracle database log as a separate database stream in the log group\. For example, if you configure the export function to include the audit log, audit data is stored in an audit log stream in the `/aws/rds/instance/my_instance/audit` log group\. RDS for Oracle supports the following logs: -+ Alert log -+ Trace log -+ Audit log -+ Listener log -+ Oracle Management Agent log - -This Oracle Management Agent log consists of the log groups shown in the following table\. - - -**** - -| Log name | CloudWatch log group | -| --- | --- | -| emctl\.log | oemagent\-emctl | -| emdctlj\.log | oemagent\-emdctlj | -| gcagent\.log | oemagent\-gcagent | -| gcagent\_errors\.log | oemagent\-gcagent\-errors | -| emagent\.nohup | oemagent\-emagent\-nohup | -| secure\.log | oemagent\-secure | - -For more information, see [Locating Management Agent Log and Trace Files](https://docs.oracle.com/en/enterprise-manager/cloud-control/enterprise-manager-cloud-control/13.4/emadm/locating-management-agent-log-and-trace-files1.html#GUID-9C710D78-6AA4-42E4-83CD-47B5FF4892DF) in the Oracle documentation\. - -### Console - -**To publish Oracle DB logs to CloudWatch Logs from the AWS Management Console** - -1. Open the Amazon RDS console at [https://console\.aws\.amazon\.com/rds/](https://console.aws.amazon.com/rds/)\. - -1. In the navigation pane, choose **Databases**, and then choose the DB instance that you want to modify\. - -1. Choose **Modify**\. - -1. In the **Log exports** section, choose the logs that you want to start publishing to CloudWatch Logs\. - -1. Choose **Continue**, and then choose **Modify DB Instance** on the summary page\. - -### AWS CLI - -To publish Oracle logs, you can use the [https://docs.aws.amazon.com/cli/latest/reference/rds/modify-db-instance.html](https://docs.aws.amazon.com/cli/latest/reference/rds/modify-db-instance.html) command with the following parameters: -+ `--db-instance-identifier` -+ `--cloudwatch-logs-export-configuration` - -**Note** -A change to the `--cloudwatch-logs-export-configuration` option is always applied to the DB instance immediately\. Therefore, the `--apply-immediately` and `--no-apply-immediately` options have no effect\. - -You can also publish Oracle logs using the following commands: -+ [https://docs.aws.amazon.com/cli/latest/reference/rds/create-db-instance.html](https://docs.aws.amazon.com/cli/latest/reference/rds/create-db-instance.html) -+ [https://docs.aws.amazon.com/cli/latest/reference/rds/restore-db-instance-from-db-snapshot.html](https://docs.aws.amazon.com/cli/latest/reference/rds/restore-db-instance-from-db-snapshot.html) -+ [https://docs.aws.amazon.com/cli/latest/reference/rds/restore-db-instance-from-s3.html](https://docs.aws.amazon.com/cli/latest/reference/rds/restore-db-instance-from-s3.html) -+ [https://docs.aws.amazon.com/cli/latest/reference/rds/restore-db-instance-to-point-in-time.html](https://docs.aws.amazon.com/cli/latest/reference/rds/restore-db-instance-to-point-in-time.html) - -**Example** -The following example creates an Oracle DB instance with CloudWatch Logs publishing enabled\. The `--cloudwatch-logs-export-configuration` value is a JSON array of strings\. The strings can be any combination of `alert`, `audit`, `listener`, and `trace`\. -For Linux, macOS, or Unix: - -``` -aws rds create-db-instance \ - --db-instance-identifier mydbinstance \ - --cloudwatch-logs-export-configuration '["trace","audit","alert","listener","oemagent"]' \ - --db-instance-class db.m5.large \ - --allocated-storage 20 \ - --engine oracle-ee \ - --engine-version 12.1.0.2.v18 \ - --license-model bring-your-own-license \ - --master-username myadmin \ - --master-user-password mypassword -``` -For Windows: - -``` -aws rds create-db-instance ^ - --db-instance-identifier mydbinstance ^ - --cloudwatch-logs-export-configuration trace alert audit listener oemagent ^ - --db-instance-class db.m5.large ^ - --allocated-storage 20 ^ - --engine oracle-ee ^ - --engine-version 12.1.0.2.v18 ^ - --license-model bring-your-own-license ^ - --master-username myadmin ^ - --master-user-password mypassword -``` - -**Example** -The following example modifies an existing Oracle DB instance to publish log files to CloudWatch Logs\. The `--cloudwatch-logs-export-configuration` value is a JSON object\. The key for this object is `EnableLogTypes`, and its value is an array of strings with any combination of `alert`, `audit`, `listener`, and `trace`\. -For Linux, macOS, or Unix: - -``` -aws rds modify-db-instance \ - --db-instance-identifier mydbinstance \ - --cloudwatch-logs-export-configuration '{"EnableLogTypes":["trace","alert","audit","listener","oemagent"]}' -``` -For Windows: - -``` -aws rds modify-db-instance ^ - --db-instance-identifier mydbinstance ^ - --cloudwatch-logs-export-configuration EnableLogTypes=\"trace\",\"alert\",\"audit\",\"listener\",\"oemagent\" -``` - -**Example** -The following example modifies an existing Oracle DB instance to disable publishing audit and listener log files to CloudWatch Logs\. The `--cloudwatch-logs-export-configuration` value is a JSON object\. The key for this object is `DisableLogTypes`, and its value is an array of strings with any combination of `alert`, `audit`, `listener`, and `trace`\. -For Linux, macOS, or Unix: - -``` -aws rds modify-db-instance \ - --db-instance-identifier mydbinstance \ - --cloudwatch-logs-export-configuration '{"DisableLogTypes":["audit","listener"]}' -``` -For Windows: - -``` -aws rds modify-db-instance ^ - --db-instance-identifier mydbinstance ^ - --cloudwatch-logs-export-configuration DisableLogTypes=\"audit\",\"listener\" -``` - -### RDS API - -You can publish Oracle DB logs with the RDS API\. You can call the [https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_ModifyDBInstance.html](https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_ModifyDBInstance.html) action with the following parameters: -+ `DBInstanceIdentifier` -+ `CloudwatchLogsExportConfiguration` - -**Note** -A change to the `CloudwatchLogsExportConfiguration` parameter is always applied to the DB instance immediately\. Therefore, the `ApplyImmediately` parameter has no effect\. - -You can also publish Oracle logs by calling the following RDS API operations: -+ [https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_CreateDBInstance.html](https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_CreateDBInstance.html) -+ [https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_RestoreDBInstanceFromDBSnapshot.html](https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_RestoreDBInstanceFromDBSnapshot.html) -+ [https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_RestoreDBInstanceFromS3.html](https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_RestoreDBInstanceFromS3.html) -+ [https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_RestoreDBInstanceToPointInTime.html](https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_RestoreDBInstanceToPointInTime.html) - -Run one of these RDS API operations with the following parameters: -+ `DBInstanceIdentifier` -+ `EnableCloudwatchLogsExports` -+ `Engine` -+ `DBInstanceClass` - -Other parameters might be required depending on the RDS operation that you run\. - -## Previous methods for accessing alert logs and listener logs - -You can view the alert log using the Amazon RDS console\. You can also use the following SQL statement to access the alert log\. - -``` -1. SELECT message_text FROM alertlog; -``` - -The `listenerlog` view contains entries for Oracle Database version 12\.1\.0\.2 and earlier\. To access the listener log for these database versions, use the following query\. - -``` -1. SELECT message_text FROM listenerlog; -``` - -For Oracle Database versions 12\.2\.0\.1 and later, access the listener log using Amazon CloudWatch Logs\. - -**Note** -Oracle rotates the alert and listener logs when they exceed 10 MB, at which point they are unavailable from Amazon RDS views\. \ No newline at end of file diff --git a/doc_source/USER_LogAccess.Concepts.PostgreSQL.md b/doc_source/USER_LogAccess.Concepts.PostgreSQL.md deleted file mode 100644 index a4507c7..0000000 --- a/doc_source/USER_LogAccess.Concepts.PostgreSQL.md +++ /dev/null @@ -1,283 +0,0 @@ -# RDS for PostgreSQL database log files - -RDS for PostgreSQL logs database activities to the default PostgreSQL log file\. For an on\-premises PostgreSQL DB instance, these messages are stored locally in `log/postgresql.log`\. For an RDS for PostgreSQL DB instance, the log file is available on the Amazon RDS instance\. Also, you must use the Amazon RDS Console to view or download its contents\. The default logging level captures login failures, fatal server errors, deadlocks, and query failures\. - -For more information about how you can view, download, and watch file\-based database logs, see [Monitoring Amazon RDS log files](USER_LogAccess.md)\. To learn more about PostgreSQL logs, see [Working with Amazon RDS and Aurora PostgreSQL logs: Part 1](http://aws.amazon.com/blogs/database/working-with-rds-and-aurora-postgresql-logs-part-1/) and [ Working with Amazon RDS and Aurora PostgreSQL logs: Part 2](http://aws.amazon.com/blogs/database/working-with-rds-and-aurora-postgresql-logs-part-2/)\. - -In addition to the standard PostgreSQL logs discussed in this topic, RDS for PostgreSQL also supports the PostgreSQL Audit extension \(`pgAudit`\)\. Most regulated industries and government agencies need to maintain an audit log or audit trail of changes made to data to comply with legal requirements\. For information about installing and using pgAudit, see [Using pgAudit to log database activity](Appendix.PostgreSQL.CommonDBATasks.Extensions.md#Appendix.PostgreSQL.CommonDBATasks.pgaudit)\. - -**Topics** -+ [Parameters that affect logging behavior](#USER_LogAccess.Concepts.PostgreSQL.overview.parameter-groups) -+ [Turning on query logging for your RDS for PostgreSQL DB instance](#USER_LogAccess.Concepts.PostgreSQL.Query_Logging) -+ [Publishing PostgreSQL logs to Amazon CloudWatch Logs](#USER_LogAccess.Concepts.PostgreSQL.PublishtoCloudWatchLogs) - -## Parameters that affect logging behavior - -You can customize the logging behavior for your RDS for PostgreSQL DB instance by modifying various parameters\. In the following table you can find the parameters that affect how long the logs are stored, when to rotate the log, and whether to output the log as a CSV \(comma\-separated value\) format\. You can also find the text output sent to STDERR, among other settings\. To change settings for the parameters that are modifiable, use a custom DB parameter group for your RDS for PostgreSQL instance\. For more information, see [Working with DB parameter groups](USER_WorkingWithDBInstanceParamGroups.md)\. As noted in the table, the `log_line_prefix` can't be changed\. - - -| Parameter | Default | Description | -| --- | --- | --- | -| log\_destination | stderr | Sets the output format for the log\. The default is `stderr` but you can also specify comma\-separated value \(CSV\) by adding `csvlog` to the setting\. For more information, see [Setting the log destination \(`stderr`, `csvlog`\)](#USER_LogAccess.Concepts.PostgreSQL.Log_Format) | -| log\_filename | postgresql\.log\.%Y\-%m\-%d\-%H | Specifies the pattern for the log file name\. In addition to the default, this parameter supports `postgresql.log.%Y-%m-%d` for the filename pattern\. | -| log\_line\_prefix | %t:%r:%u@%d:\[%p\]: | Defines the prefix for each log line that gets written to `stderr`, to note the time \(%t\), remote host \(%r\), user \(%u\), database \(%d\), and process ID \(%p\)\. You can't modify this parameter\. | -| log\_rotation\_age | 60 | Minutes after which log file is automatically rotated\. You can change this value to between 1 and 1440 minutes\. For more information, see [Setting log file rotation](#USER_LogAccess.Concepts.PostgreSQL.log_rotation)\. | -| log\_rotation\_size | – | The size \(kB\) at which the log is automatically rotated\. By default, this parameter isn't used because logs are rotated based on the `log_rotation_age` parameter\. To learn more, see [Setting log file rotation](#USER_LogAccess.Concepts.PostgreSQL.log_rotation)\. | -| rds\.log\_retention\_period | 4320 | PostgreSQL logs that are older than the specified number of minutes are deleted\. The default value of 4320 minutes deletes log files after 3 days\. For more information, see [Setting the log retention period](#USER_LogAccess.Concepts.PostgreSQL.log_retention_period)\. | - -To identify application issues, you can look for query failures, login failures, deadlocks, and fatal server errors in the log\. For example, suppose that you converted a legacy application from Oracle to Amazon RDS PostgreSQL, but not all queries converted correctly\. These incorrectly formatted queries generate error messages that you can find in the logs to help identify problems\. For more information about logging queries, see [Turning on query logging for your RDS for PostgreSQL DB instance](#USER_LogAccess.Concepts.PostgreSQL.Query_Logging)\. - -In the following topics, you can find information about how to set various parameters that control the basic details for your PostgreSQL logs\. - -**Topics** -+ [Setting the log retention period](#USER_LogAccess.Concepts.PostgreSQL.log_retention_period) -+ [Setting log file rotation](#USER_LogAccess.Concepts.PostgreSQL.log_rotation) -+ [Setting the log destination \(`stderr`, `csvlog`\)](#USER_LogAccess.Concepts.PostgreSQL.Log_Format) -+ [Understanding the log\_line\_prefix parameter](#USER_LogAccess.Concepts.PostgreSQL.Log_Format.log-line-prefix) - -### Setting the log retention period - -The `rds.log_retention_period` parameter specifies how long your RDS for PostgreSQL DB instance keeps its log files\. The default setting is 3 days \(4,320 minutes\), but you can set this value to anywhere from 1 day \(1,440 minutes\) to 7 days \(10,080 minutes\)\. Be sure that your RDS for PostgreSQL DB instance has sufficient storage to hold the log files for the period of time\. - -We recommend that you have your logs routinely published to Amazon CloudWatch Logs so that you can view and analyze system data long after the logs have been removed from your RDS for PostgreSQL DB instance\. For more information, see [Publishing PostgreSQL logs to Amazon CloudWatch Logs](#USER_LogAccess.Concepts.PostgreSQL.PublishtoCloudWatchLogs)\. - -### Setting log file rotation - -Amazon RDS creates new log files every hour by default\. The timing is controlled by the `log_rotation_age` parameter\. This parameter has a default value of 60 \(minutes\), but you can set it to anywhere from 1 minute to 24 hours \(1,440 minutes\)\. When it's time for rotation, a new distinct log file is created\. The file is named according to the pattern specified by the `log_filename` parameter\. - -Log files can also be rotated according to their size, as specified in the `log_rotation_size` parameter\. This parameter specifies that the log should be rotated when it reaches the specified size \(in kilobytes\)\. For an RDS for PostgreSQL DB instance, `log_rotation_size` is unset, that is, there is no value specified\. However, you can set the parameter from 0\-2097151 kB \(kilobytes\)\. - -The log file names are based on the file name pattern specified in the `log_filename` parameter\. The available settings for this parameter are as follows: -+ `postgresql.log.%Y-%m-%d` – Default format for the log file name\. Includes the year, month, and date in the name of the log file\. -+ `postgresql.log.%Y-%m-%d-%H` – Includes the hour in the log file name format\. - -For more information, see [https://www.postgresql.org/docs/current/runtime-config-logging.html#GUC-LOG-ROTATION-AGE](https://www.postgresql.org/docs/current/runtime-config-logging.html#GUC-LOG-ROTATION-AGE) and [https://www.postgresql.org/docs/current/runtime-config-logging.html#GUC-LOG-ROTATION-SIZE](https://www.postgresql.org/docs/current/runtime-config-logging.html#GUC-LOG-ROTATION-SIZE) in the PostgreSQL documentation\. - -### Setting the log destination \(`stderr`, `csvlog`\) - -By default, Amazon RDS PostgreSQL generates logs in standard error \(stderr\) format\. This format is the default setting for the `log_destination` parameter\. Each message is prefixed using the pattern specified in the `log_line_prefix` parameter\. For more information, see [Understanding the log\_line\_prefix parameter](#USER_LogAccess.Concepts.PostgreSQL.Log_Format.log-line-prefix)\. - -RDS for PostgreSQL can also generate the logs in `csvlog` format\. The `csvlog` is useful for analyzing the log data as comma\-separated values \(CSV\) data\. For example, suppose that you use the `log_fdw` extension to work with your logs as foreign tables\. The foreign table created on `stderr` log files contains a single column with log event data\. By adding `csvlog` to the `log_destination` parameter, you get the log file in the CSV format with demarcations for the multiple columns of the foreign table\. You can now sort and analyze your logs more easily\. To learn how to use the `log_fdw` with `csvlog`, see [Using the log\_fdw extension to access the DB log using SQL](Appendix.PostgreSQL.CommonDBATasks.Extensions.foreign-data-wrappers.md#CHAP_PostgreSQL.Extensions.log_fdw)\. - -If you specify `csvlog` for this parameter, be aware that both `stderr` and `csvlog` files are generated\. Be sure to monitor the storage consumed by the logs, taking into account the `rds.log_retention_period` and other settings that affect log storage and turnover\. Using `stderr` and `csvlog` more than doubles the storage consumed by the logs\. - -If you add `csvlog` to `log_destination` and you want to revert to the `stderr` alone, you need to reset the parameter\. To do so, open the Amazon RDS Console and then open the custom DB parameter group for your instance\. Choose the `log_destination` parameter, choose **Edit parameter**, and then choose **Reset**\. - -For more information about configuring logging, see [ Working with Amazon RDS and Aurora PostgreSQL logs: Part 1](http://aws.amazon.com/blogs/database/working-with-rds-and-aurora-postgresql-logs-part-1/)\. - -### Understanding the log\_line\_prefix parameter - -The `stderr` log format prefixes each log message with the details specified by the `log_line_prefix` parameter, as follows\. - -``` -%t:%r:%u@%d:[%p]:t -``` - -You can't change this setting\. Each log entry sent to `stderr` includes the following information\. -+ `%t` – Time of log entry -+ `%r` – Remote host address -+ `%u@%d` – User name @ database name -+ `[%p]` – Process ID if available - -## Turning on query logging for your RDS for PostgreSQL DB instance - -You can collect more detailed information about your database activities, including queries, queries waiting for locks, checkpoints, and many other details by setting some of the parameters listed in the following table\. This topic focuses on logging queries\. - - -| Parameter | Default | Description | -| --- | --- | --- | -| log\_connections | – | Logs each successful connection\. | -| log\_disconnections | – | Logs the end of each session and its duration\. | -| log\_checkpoints | 1 | Logs each checkpoint\. | -| log\_lock\_waits | – | Logs long lock waits\. By default, this parameter isn't set\. | -| log\_min\_duration\_sample | – | \(ms\) Sets the minimum execution time above which a sample of statements is logged\. Sample size is set using the log\_statement\_sample\_rate parameter\. | -| log\_min\_duration\_statement | – | Any SQL statement that runs atleast for the specified amount of time or longer gets logged\. By default, this parameter isn't set\. Turning on this parameter can help you find unoptimized queries\. | -| log\_statement | – | Sets the type of statements logged\. By default, this parameter isn't set, but you can change it to `all`, `ddl`, or `mod` to specify the types of SQL statements that you want logged\. If you specify anything other than `none` for this parameter, you should also take additional steps to prevent the exposure of passwords in the log files\. For more information, see [Mitigating risk of password exposure when using query loggingMitigating password exposure risk](#USER_LogAccess.Concepts.PostgreSQL.Query_Logging.mitigate-risk)\. | -| log\_statement\_sample\_rate | – | The percentage of statements exceeding the time specified in `log_min_duration_sample` to be logged, expressed as a floating point value between 0\.0 and 1\.0\. | -| log\_statement\_stats | – | Writes cumulative performance statistics to the server log\. | - -### Using logging to find slow performing queries - -You can log SQL statements and queries to help find slow performing queries\. You turn on this capability by modifying the settings in the `log_statement` and `log_min_duration` parameters as outlined in this section\. Before turning on query logging for your RDS for PostgreSQL DB instance, you should be aware of possible password exposure in the logs and how to mitigate the risks\. For more information, see [Mitigating risk of password exposure when using query loggingMitigating password exposure risk](#USER_LogAccess.Concepts.PostgreSQL.Query_Logging.mitigate-risk)\. - -Following, you can find reference information about the `log_statement` and `log_min_duration` parameters\.log\_statement - -This parameter specifies the type of SQL statements that should get sent to the log\. The default value is `none`\. If you change this parameter to `all`, `ddl`, or `mod`, be sure to apply recommended actions to mitigate the risk of exposing passwords in the logs\. For more information, see [Mitigating risk of password exposure when using query loggingMitigating password exposure risk](#USER_LogAccess.Concepts.PostgreSQL.Query_Logging.mitigate-risk)\. - -**all** -Logs all statements\. This setting is recommended for debugging purposes\. - -**ddl** -Logs all data definition language \(DDL\) statements, such as CREATE, ALTER, DROP, and so on\. - -**mod** -Logs all DDL statements and data manipulation language \(DML\) statements, such as INSERT, UPDATE, and DELETE, which modify the data\. - -**none** -No SQL statements get logged\. We recommend this setting to avoid the risk of exposing passwords in the logs\.log\_min\_duration\_statement - -Any SQL statement that runs atleast for the specified amount of time or longer gets logged\. By default, this parameter isn't set\. Turning on this parameter can help you find unoptimized queries\. - -**–1–2147483647** -The number of milliseconds \(ms\) of runtime over which a statement gets logged\. - -**To set up query logging** - -These steps assume that your RDS for PostgreSQL DB instance uses a custom DB parameter group\. - -1. Set the `log_statement` parameter to `all`\. The following example shows the information that is written to the `postgresql.log` file with this parameter setting\. - - ``` - 2022-10-05 22:05:52 UTC:52.95.4.1(11335):postgres@labdb:[3639]:LOG: statement: SELECT feedback, s.sentiment,s.confidence - FROM support,aws_comprehend.detect_sentiment(feedback, 'en') s - ORDER BY s.confidence DESC; - 2022-10-05 22:05:52 UTC:52.95.4.1(11335):postgres@labdb:[3639]:LOG: QUERY STATISTICS - 2022-10-05 22:05:52 UTC:52.95.4.1(11335):postgres@labdb:[3639]:DETAIL: ! system usage stats: - ! 0.017355 s user, 0.000000 s system, 0.168593 s elapsed - ! [0.025146 s user, 0.000000 s system total] - ! 36644 kB max resident size - ! 0/8 [0/8] filesystem blocks in/out - ! 0/733 [0/1364] page faults/reclaims, 0 [0] swaps - ! 0 [0] signals rcvd, 0/0 [0/0] messages rcvd/sent - ! 19/0 [27/0] voluntary/involuntary context switches - 2022-10-05 22:05:52 UTC:52.95.4.1(11335):postgres@labdb:[3639]:STATEMENT: SELECT feedback, s.sentiment,s.confidence - FROM support,aws_comprehend.detect_sentiment(feedback, 'en') s - ORDER BY s.confidence DESC; - 2022-10-05 22:05:56 UTC:52.95.4.1(11335):postgres@labdb:[3639]:ERROR: syntax error at or near "ORDER" at character 1 - 2022-10-05 22:05:56 UTC:52.95.4.1(11335):postgres@labdb:[3639]:STATEMENT: ORDER BY s.confidence DESC; - ----------------------- END OF LOG ---------------------- - ``` - -1. Set the `log_min_duration_statement` parameter\. The following example shows the information that is written to the `postgresql.log` file when the parameter is set to `1`\. - - Queries that exceed the duration specified in the `log_min_duration_statement` parameter are logged\. The following shows an example\. You can view the log file for your RDS for PostgreSQL DB instance in the Amazon RDS Console\. - - ``` - 2022-10-05 19:05:19 UTC:52.95.4.1(6461):postgres@labdb:[6144]:LOG: statement: DROP table comments; - 2022-10-05 19:05:19 UTC:52.95.4.1(6461):postgres@labdb:[6144]:LOG: duration: 167.754 ms - 2022-10-05 19:08:07 UTC::@:[355]:LOG: checkpoint starting: time - 2022-10-05 19:08:08 UTC::@:[355]:LOG: checkpoint complete: wrote 11 buffers (0.0%); 0 WAL file(s) added, 0 removed, 0 recycled; write=1.013 s, sync=0.006 s, total=1.033 s; sync files=8, longest=0.004 s, average=0.001 s; distance=131028 kB, estimate=131028 kB - ----------------------- END OF LOG ---------------------- - ``` - -#### Mitigating risk of password exposure when using query logging - -We recommend that you keep `log_statement` set to `none` to avoid exposing passwords\. If you set `log_statement` to `all`, `ddl`, or `mod`, we recommend that you take one or more of the following steps\. -+ For the client, encrypt sensitive information\. For more information, see [Encryption Options](https://www.postgresql.org/docs/current/encryption-options.html) in the PostgreSQL documentation\. Use the `ENCRYPTED` \(and `UNENCRYPTED`\) options of the `CREATE` and `ALTER` statements\. For more information, see [CREATE USER](https://www.postgresql.org/docs/current/sql-createuser.html) in the PostgreSQL documentation\. -+ For your RDS for PostgreSQL DB instance, set up and use the PostgreSQL Auditing \(pgAudit\) extension\. This extension redacts sensitive information in CREATE and ALTER statements sent to the log\. For more information, see [Using pgAudit to log database activity](Appendix.PostgreSQL.CommonDBATasks.Extensions.md#Appendix.PostgreSQL.CommonDBATasks.pgaudit)\. -+ Restrict access to the CloudWatch logs\. -+ Use stronger authentication mechanisms such as IAM\. - -## Publishing PostgreSQL logs to Amazon CloudWatch Logs - -To store your PostgreSQL log records in highly durable storage, you can use Amazon CloudWatch Logs\. With CloudWatch Logs, you can also perform real\-time analysis of log data and use CloudWatch to view metrics and create alarms\. For example, if you set `log_statements` to `ddl`, you can set up an alarm to alert you whenever a DDL statement is executed\. You can choose to have your PostgreSQL logs uploaded to CloudWatch Logs during the process of creating your RDS for PostgreSQL DB instance\. If you chose not to upload logs at that time, you can later modify your instance to start uploading logs from that point forward\. In other words, existing logs aren't uploaded\. Only new logs are uploaded as they're created on your modified RDS for PostgreSQL DB instance\. - -All currently available RDS for PostgreSQL versions support publishing log files to CloudWatch Logs\. For more information, see [Amazon RDS for PostgreSQL updates](https://docs.aws.amazon.com/AmazonRDS/latest/PostgreSQLReleaseNotes/postgresql-versions.html) in the *Amazon RDS for PostgreSQL Release Notes\.*\. - -To work with CloudWatch Logs, configure your RDS for PostgreSQL DB instance to publish log data to a log group\. - -You can publish the following log types to CloudWatch Logs for RDS for PostgreSQL: -+ Postgresql log -+ Upgrade log - -After you complete the configuration, Amazon RDS publishes the log events to log streams within a CloudWatch log group\. For example, the PostgreSQL log data is stored within the log group `/aws/rds/instance/my_instance/postgresql`\. To view your logs, open the CloudWatch console at [https://console\.aws\.amazon\.com/cloudwatch/](https://console.aws.amazon.com/cloudwatch/)\. - -### Console - -**To publish PostgreSQL logs to CloudWatch Logs using the console** - -1. Open the Amazon RDS console at [https://console\.aws\.amazon\.com/rds/](https://console.aws.amazon.com/rds/)\. - -1. In the navigation pane, choose **Databases**\. - -1. Choose the DB instance that you want to modify, and then choose **Modify**\. - -1. In the **Log exports** section, choose the logs that you want to start publishing to CloudWatch Logs\. - - The **Log exports** section is available only for PostgreSQL versions that support publishing to CloudWatch Logs\. - -1. Choose **Continue**, and then choose **Modify DB Instance** on the summary page\. - -### AWS CLI - -You can publish PostgreSQL logs with the AWS CLI\. You can call the [https://docs.aws.amazon.com/cli/latest/reference/rds/modify-db-instance.html](https://docs.aws.amazon.com/cli/latest/reference/rds/modify-db-instance.html) command with the following parameters\. -+ `--db-instance-identifier` -+ `--cloudwatch-logs-export-configuration` - -**Note** -A change to the `--cloudwatch-logs-export-configuration` option is always applied to the DB instance immediately\. Therefore, the `--apply-immediately` and `--no-apply-immediately` options have no effect\. - -You can also publish PostgreSQL logs by calling the following CLI commands: -+ [https://docs.aws.amazon.com/cli/latest/reference/rds/create-db-instance.html](https://docs.aws.amazon.com/cli/latest/reference/rds/create-db-instance.html) -+ [https://docs.aws.amazon.com/cli/latest/reference/rds/restore-db-instance-from-db-snapshot.html](https://docs.aws.amazon.com/cli/latest/reference/rds/restore-db-instance-from-db-snapshot.html) -+ [https://docs.aws.amazon.com/cli/latest/reference/rds/restore-db-instance-to-point-in-time.html](https://docs.aws.amazon.com/cli/latest/reference/rds/restore-db-instance-to-point-in-time.html) - -Run one of these CLI commands with the following options: -+ `--db-instance-identifier` -+ `--enable-cloudwatch-logs-exports` -+ `--db-instance-class` -+ `--engine` - -Other options might be required depending on the CLI command you run\. - -**Example Modify an instance to publish logs to CloudWatch Logs** -The following example modifies an existing PostgreSQL DB instance to publish log files to CloudWatch Logs\. The `--cloudwatch-logs-export-configuration` value is a JSON object\. The key for this object is `EnableLogTypes`, and its value is an array of strings with any combination of `postgresql` and `upgrade`\. -For Linux, macOS, or Unix: - -``` -1. aws rds modify-db-instance \ -2. --db-instance-identifier mydbinstance \ -3. --cloudwatch-logs-export-configuration '{"EnableLogTypes":["postgresql", "upgrade"]}' -``` -For Windows: - -``` -1. aws rds modify-db-instance ^ -2. --db-instance-identifier mydbinstance ^ -3. --cloudwatch-logs-export-configuration '{"EnableLogTypes":["postgresql","upgrade"]}' -``` - -**Example Create an instance to publish logs to CloudWatch Logs** -The following example creates a PostgreSQL DB instance and publishes log files to CloudWatch Logs\. The `--enable-cloudwatch-logs-exports` value is a JSON array of strings\. The strings can be any combination of `postgresql` and `upgrade`\. -For Linux, macOS, or Unix: - -``` -1. aws rds create-db-instance \ -2. --db-instance-identifier mydbinstance \ -3. --enable-cloudwatch-logs-exports '["postgresql","upgrade"]' \ -4. --db-instance-class db.m4.large \ -5. --engine postgres -``` -For Windows: - -``` -1. aws rds create-db-instance ^ -2. --db-instance-identifier mydbinstance ^ -3. --enable-cloudwatch-logs-exports '["postgresql","upgrade"]' ^ -4. --db-instance-class db.m4.large ^ -5. --engine postgres -``` - -### RDS API - -You can publish PostgreSQL logs with the RDS API\. You can call the [https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_ModifyDBInstance.html](https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_ModifyDBInstance.html) action with the following parameters: -+ `DBInstanceIdentifier` -+ `CloudwatchLogsExportConfiguration` - -**Note** -A change to the `CloudwatchLogsExportConfiguration` parameter is always applied to the DB instance immediately\. Therefore, the `ApplyImmediately` parameter has no effect\. - -You can also publish PostgreSQL logs by calling the following RDS API operations: -+ [https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_CreateDBInstance.html](https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_CreateDBInstance.html) -+ [https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_RestoreDBInstanceFromDBSnapshot.html](https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_RestoreDBInstanceFromDBSnapshot.html) -+ [https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_RestoreDBInstanceToPointInTime.html](https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_RestoreDBInstanceToPointInTime.html) - -Run one of these RDS API operations with the following parameters: -+ `DBInstanceIdentifier` -+ `EnableCloudwatchLogsExports` -+ `Engine` -+ `DBInstanceClass` - -Other parameters might be required depending on the operation that you run\. - - \ No newline at end of file diff --git a/doc_source/USER_LogAccess.Concepts.SQLServer.md b/doc_source/USER_LogAccess.Concepts.SQLServer.md deleted file mode 100644 index aa436fe..0000000 --- a/doc_source/USER_LogAccess.Concepts.SQLServer.md +++ /dev/null @@ -1,133 +0,0 @@ -# Microsoft SQL Server database log files - -You can access Microsoft SQL Server error logs, agent logs, trace files, and dump files by using the Amazon RDS console, AWS CLI, or RDS API\. For more information about viewing, downloading, and watching file\-based database logs, see [Monitoring Amazon RDS log files](USER_LogAccess.md)\. - -**Topics** -+ [Retention schedule](#USER_LogAccess.Concepts.SQLServer.Retention) -+ [Viewing the SQL Server error log by using the rds\_read\_error\_log procedure](#USER_LogAccess.Concepts.SQLServer.Proc) -+ [Publishing SQL Server logs to Amazon CloudWatch Logs](#USER_LogAccess.SQLServer.PublishtoCloudWatchLogs) - -## Retention schedule - -Log files are rotated each day and whenever your DB instance is restarted\. The following is the retention schedule for Microsoft SQL Server logs on Amazon RDS\. - - -**** - -| Log type | Retention schedule | -| --- | --- | -| Error logs | A maximum of 30 error logs are retained\. Amazon RDS might delete error logs older than 7 days\. | -| Agent logs | A maximum of 10 agent logs are retained\. Amazon RDS might delete agent logs older than 7 days\. | -| Trace files | Trace files are retained according to the trace file retention period of your DB instance\. The default trace file retention period is 7 days\. To modify the trace file retention period for your DB instance, see [Setting the retention period for trace and dump files](Appendix.SQLServer.CommonDBATasks.TraceFiles.md#Appendix.SQLServer.CommonDBATasks.TraceFiles.PurgeTraceFiles)\. | -| Dump files | Dump files are retained according to the dump file retention period of your DB instance\. The default dump file retention period is 7 days\. To modify the dump file retention period for your DB instance, see [Setting the retention period for trace and dump files](Appendix.SQLServer.CommonDBATasks.TraceFiles.md#Appendix.SQLServer.CommonDBATasks.TraceFiles.PurgeTraceFiles)\. | - -## Viewing the SQL Server error log by using the rds\_read\_error\_log procedure - -You can use the Amazon RDS stored procedure `rds_read_error_log` to view error logs and agent logs\. For more information, see [Viewing error and agent logs](Appendix.SQLServer.CommonDBATasks.Logs.md#Appendix.SQLServer.CommonDBATasks.Logs.SP)\. - -## Publishing SQL Server logs to Amazon CloudWatch Logs - -With Amazon RDS for SQL Server, you can publish error and agent log events directly to Amazon CloudWatch Logs\. Analyze the log data with CloudWatch Logs, then use CloudWatch to create alarms and view metrics\. - -With CloudWatch Logs, you can do the following: -+ Store logs in highly durable storage space with a retention period that you define\. -+ Search and filter log data\. -+ Share log data between accounts\. -+ Export logs to Amazon S3\. -+ Stream data to Amazon OpenSearch Service\. -+ Process log data in real time with Amazon Kinesis Data Streams\. For more information, see [Working with Amazon CloudWatch Logs](https://docs.aws.amazon.com/kinesisanalytics/latest/dev/cloudwatch-logs.html) in the *Amazon Kinesis Data Analytics for SQL Applications Developer Guide*\. - - Amazon RDS publishes each SQL Server database log as a separate database stream in the log group\. For example, if you publish error logs, error data is stored in an error log stream in the `/aws/rds/instance/my_instance/error` log group\. - -For Multi\-AZ DB instances, Amazon RDS publishes the database log as two separate streams in the log group\. For example, if you publish the error logs, the error data is stored in the error log streams `/aws/rds/instance/my_instance.node1/error` and `/aws/rds/instance/my_instance.node2/error` respectively\. The log streams don't change during a failover and the error log stream of each node can contain error logs from primary or secondary instance\. - -**Note** -Publishing SQL Server logs to CloudWatch Logs isn't enabled by default\. Publishing trace and dump files isn't supported\. Publishing SQL Server logs to CloudWatch Logs is supported in all regions, except for Asia Pacific \(Hong Kong\)\. - -### Console - -**To publish SQL Server DB logs to CloudWatch Logs from the AWS Management Console** - -1. Open the Amazon RDS console at [https://console\.aws\.amazon\.com/rds/](https://console.aws.amazon.com/rds/)\. - -1. In the navigation pane, choose **Databases**, and then choose the DB instance that you want to modify\. - -1. Choose **Modify**\. - -1. In the **Log exports** section, choose the logs that you want to start publishing to CloudWatch Logs\. - - You can choose **Agent log**, **Error log**, or both\. - -1. Choose **Continue**, and then choose **Modify DB Instance** on the summary page\. - -### AWS CLI - -To publish SQL Server logs, you can use the [https://docs.aws.amazon.com/cli/latest/reference/rds/modify-db-instance.html](https://docs.aws.amazon.com/cli/latest/reference/rds/modify-db-instance.html) command with the following parameters: -+ `--db-instance-identifier` -+ `--cloudwatch-logs-export-configuration` - -**Note** -A change to the `--cloudwatch-logs-export-configuration` option is always applied to the DB instance immediately\. Therefore, the `--apply-immediately` and `--no-apply-immediately` options have no effect\. - -You can also publish SQL Server logs using the following commands: -+ [https://docs.aws.amazon.com/cli/latest/reference/rds/create-db-instance.html](https://docs.aws.amazon.com/cli/latest/reference/rds/create-db-instance.html) -+ [https://docs.aws.amazon.com/cli/latest/reference/rds/restore-db-instance-from-db-snapshot.html](https://docs.aws.amazon.com/cli/latest/reference/rds/restore-db-instance-from-db-snapshot.html) -+ [https://docs.aws.amazon.com/cli/latest/reference/rds/restore-db-instance-to-point-in-time.html](https://docs.aws.amazon.com/cli/latest/reference/rds/restore-db-instance-to-point-in-time.html) - -**Example** -The following example creates an SQL Server DB instance with CloudWatch Logs publishing enabled\. The `--enable-cloudwatch-logs-exports` value is a JSON array of strings that can include `error`, `agent`, or both\. -For Linux, macOS, or Unix: - -``` -aws rds create-db-instance \ - --db-instance-identifier mydbinstance \ - --enable-cloudwatch-logs-exports '["error","agent"]' \ - --db-instance-class db.m4.large \ - --engine sqlserver-se -``` -For Windows: - -``` -aws rds create-db-instance ^ - --db-instance-identifier mydbinstance ^ - --enable-cloudwatch-logs-exports "[\"error\",\"agent\"]" ^ - --db-instance-class db.m4.large ^ - --engine sqlserver-se -``` -When using the Windows command prompt, you must escape double quotes \("\) in JSON code by prefixing them with a backslash \(\\\)\. - -**Example** -The following example modifies an existing SQL Server DB instance to publish log files to CloudWatch Logs\. The `--cloudwatch-logs-export-configuration` value is a JSON object\. The key for this object is `EnableLogTypes`, and its value is an array of strings that can include `error`, `agent`, or both\. -For Linux, macOS, or Unix: - -``` -aws rds modify-db-instance \ - --db-instance-identifier mydbinstance \ - --cloudwatch-logs-export-configuration '{"EnableLogTypes":["error","agent"]}' -``` -For Windows: - -``` -aws rds modify-db-instance ^ - --db-instance-identifier mydbinstance ^ - --cloudwatch-logs-export-configuration "{\"EnableLogTypes\":[\"error\",\"agent\"]}" -``` -When using the Windows command prompt, you must escape double quotes \("\) in JSON code by prefixing them with a backslash \(\\\)\. - -**Example** -The following example modifies an existing SQL Server DB instance to disable publishing agent log files to CloudWatch Logs\. The `--cloudwatch-logs-export-configuration` value is a JSON object\. The key for this object is `DisableLogTypes`, and its value is an array of strings that can include `error`, `agent`, or both\. -For Linux, macOS, or Unix: - -``` -aws rds modify-db-instance \ - --db-instance-identifier mydbinstance \ - --cloudwatch-logs-export-configuration '{"DisableLogTypes":["agent"]}' -``` -For Windows: - -``` -aws rds modify-db-instance ^ - --db-instance-identifier mydbinstance ^ - --cloudwatch-logs-export-configuration "{\"DisableLogTypes\":[\"agent\"]}" -``` -When using the Windows command prompt, you must escape double quotes \("\) in JSON code by prefixing them with a backslash \(\\\)\. \ No newline at end of file diff --git a/doc_source/USER_LogAccess.MySQL.Auditlog.md b/doc_source/USER_LogAccess.MySQL.Auditlog.md deleted file mode 100644 index 9b2fc0f..0000000 --- a/doc_source/USER_LogAccess.MySQL.Auditlog.md +++ /dev/null @@ -1,3 +0,0 @@ -# Accessing the MySQL audit log - -To access the audit log, the DB instance must use a custom option group with the `MARIADB_AUDIT_PLUGIN` option\. For more information, see [MariaDB Audit Plugin support](Appendix.MySQL.Options.AuditPlugin.md)\. \ No newline at end of file diff --git a/doc_source/USER_LogAccess.MySQL.BinaryFormat.md b/doc_source/USER_LogAccess.MySQL.BinaryFormat.md deleted file mode 100644 index fc59c22..0000000 --- a/doc_source/USER_LogAccess.MySQL.BinaryFormat.md +++ /dev/null @@ -1,50 +0,0 @@ -# Configuring MySQL binary logging - -The *binary log* is a set of log files that contain information about data modifications made to an MySQL server instance\. The binary log contains information such as the following: -+ Events that describe database changes such as table creation or row modifications -+ Information about the duration of each statement that updated data -+ Events for statements that could have updated data but didn't - -The binary log records statements that are sent during replication\. It is also required for some recovery operations\. For more information, see [The Binary Log](https://dev.mysql.com/doc/refman/8.0/en/binary-log.html) and [Binary Log Overview](https://dev.mysql.com/doc/internals/en/binary-log-overview.html) in the MySQL documentation\. - -The automated backups feature determines whether binary logging is turned on or off for MySQL\. You have the following options: - -Turn binary logging on -Set the backup retention period to a positive nonzero value\. - -Turn binary logging off -Set the backup retention period to zero\. - -For more information, see [Enabling automated backups](USER_WorkingWithAutomatedBackups.md#USER_WorkingWithAutomatedBackups.Enabling)\. - -MySQL on Amazon RDS supports the *row\-based*, *statement\-based*, and *mixed* binary logging formats\. We recommend mixed unless you need a specific binlog format\. For details on the different MySQL binary log formats, see [Binary logging formats](https://dev.mysql.com/doc/refman/8.0/en/binary-log-formats.html) in the MySQL documentation\. - -If you plan to use replication, the binary logging format is important because it determines the record of data changes that is recorded in the source and sent to the replication targets\. For information about the advantages and disadvantages of different binary logging formats for replication, see [Advantages and disadvantages of statement\-based and row\-based replication](https://dev.mysql.com/doc/refman/8.0/en/replication-sbr-rbr.html) in the MySQL documentation\. - -**Important** -Setting the binary logging format to row\-based can result in very large binary log files\. Large binary log files reduce the amount of storage available for a DB instance and can increase the amount of time to perform a restore operation of a DB instance\. -Statement\-based replication can cause inconsistencies between the source DB instance and a read replica\. For more information, see [ Determination of safe and unsafe statements in binary logging](https://dev.mysql.com/doc/refman/8.0/en/replication-rbr-safe-unsafe.html) in the MySQL documentation\. -Enabling binary logging increases the number of write disk I/O operations to the DB instance\. You can monitor IOPS usage with the `WriteIOPS``` CloudWatch metric\. - -**To set the MySQL binary logging format** - -1. Open the Amazon RDS console at [https://console\.aws\.amazon\.com/rds/](https://console.aws.amazon.com/rds/)\. - -1. In the navigation pane, choose **Parameter groups**\. - -1. Choose the parameter group used by the DB instance you want to modify\. - - You can't modify a default parameter group\. If the DB instance is using a default parameter group, create a new parameter group and associate it with the DB instance\. - - For more information on parameter groups, see [Working with parameter groups](USER_WorkingWithParamGroups.md)\. - -1. From **Parameter group actions**, choose **Edit**\. - -1. Set the `binlog_format` parameter to the binary logging format of your choice \(`ROW`, `STATEMENT`, or `MIXED`\)\. You can also use the value `OFF` to turn off binary logging\. - -1. Choose **Save changes** to save the updates to the DB parameter group\. - - After you perform these steps, you must reboot the DB instance for your changes to apply\. For more information, see [Rebooting a DB instance](USER_RebootInstance.md)\. - -**Important** -Changing a DB parameter group affects all DB instances that use that parameter group\. If you want to specify different binary logging formats for different MySQL DB instances in an AWS Region, the DB instances must use different DB parameter groups\. These parameter groups identify different logging formats\. Assign the appropriate DB parameter group to the each DB instance\. \ No newline at end of file diff --git a/doc_source/USER_LogAccess.MySQL.Binarylog.md b/doc_source/USER_LogAccess.MySQL.Binarylog.md deleted file mode 100644 index 55aff08..0000000 --- a/doc_source/USER_LogAccess.MySQL.Binarylog.md +++ /dev/null @@ -1,63 +0,0 @@ -# Accessing MySQL binary logs - -You can use the mysqlbinlog utility to download or stream binary logs from RDS for MySQL DB instances\. The binary log is downloaded to your local computer, where you can perform actions such as replaying the log using the mysql utility\. For more information about using the mysqlbinlog utility, see [Using mysqlbinlog to back up binary log files](https://dev.mysql.com/doc/refman/8.0/en/mysqlbinlog-backup.html) in the MySQL documentation\. - -To run the mysqlbinlog utility against an Amazon RDS instance, use the following options: -+ `--read-from-remote-server` – Required\. -+ `--host` – The DNS name from the endpoint of the instance\. -+ `--port` – The port used by the instance\. -+ `--user` – A MySQL user that has been granted the `REPLICATION SLAVE` permission\. -+ `--password` – The password for the MySQL user, or omit a password value so that the utility prompts you for a password\. -+ `--raw` – Download the file in binary format\. -+ `--result-file` – The local file to receive the raw output\. -+ `--stop-never` – Stream the binary log files\. -+ `--verbose` – When you use the `ROW` binlog format, include this option to see the row events as pseudo\-SQL statements\. For more information on the `--verbose` option, see [mysqlbinlog row event display](https://dev.mysql.com/doc/refman/8.0/en/mysqlbinlog-row-events.html) in the MySQL documentation\. -+ Specify the names of one or more binary log files\. To get a list of the available logs, use the SQL command `SHOW BINARY LOGS`\. - -For more information about mysqlbinlog options, see [mysqlbinlog — Utility for processing binary log files](https://dev.mysql.com/doc/refman/8.0/en/mysqlbinlog.html) in the MySQL documentation\. - -The following examples show how to use the mysqlbinlog utility\. - -For Linux, macOS, or Unix: - -``` -mysqlbinlog \ - --read-from-remote-server \ - --host=MySQLInstance1.cg034hpkmmjt.region.rds.amazonaws.com \ - --port=3306 \ - --user ReplUser \ - --password \ - --raw \ - --verbose \ - --result-file=/tmp/ \ - binlog.00098 -``` - -For Windows: - -``` -mysqlbinlog ^ - --read-from-remote-server ^ - --host=MySQLInstance1.cg034hpkmmjt.region.rds.amazonaws.com ^ - --port=3306 ^ - --user ReplUser ^ - --password ^ - --raw ^ - --verbose ^ - --result-file=/tmp/ ^ - binlog.00098 -``` - -Amazon RDS normally purges a binary log as soon as possible, but the binary log must still be available on the instance to be accessed by mysqlbinlog\. To specify the number of hours for RDS to retain binary logs, use the [mysql\.rds\_set\_configuration](mysql-stored-proc-configuring.md#mysql_rds_set_configuration) stored procedure and specify a period with enough time for you to download the logs\. After you set the retention period, monitor storage usage for the DB instance to ensure that the retained binary logs don't take up too much storage\. - -The following example sets the retention period to 1 day\. - -``` -call mysql.rds_set_configuration('binlog retention hours', 24); -``` - -To display the current setting, use the [mysql\.rds\_show\_configuration](mysql-stored-proc-configuring.md#mysql_rds_show_configuration) stored procedure\. - -``` -call mysql.rds_show_configuration; -``` \ No newline at end of file diff --git a/doc_source/USER_LogAccess.MySQL.Errorlog.md b/doc_source/USER_LogAccess.MySQL.Errorlog.md deleted file mode 100644 index 50abaac..0000000 --- a/doc_source/USER_LogAccess.MySQL.Errorlog.md +++ /dev/null @@ -1,12 +0,0 @@ -# Accessing MySQL error logs - -MySQL writes errors in the `mysql-error.log` file\. Each log file has the hour it was generated \(in UTC\) appended to its name\. The log files also have a timestamp that helps you determine when the log entries were written\. - -MySQL writes to the error log only on startup, shutdown, and when it encounters errors\. A DB instance can go hours or days without new entries being written to the error log\. If you see no recent entries, it's because the server did not encounter an error that would result in a log entry\. - -MySQL writes `mysql-error.log` to disk every 5 minutes\. MySQL appends the contents of the log to `mysql-error-running.log`\. - -MySQL rotates the `mysql-error-running.log` file every hour\. RDS for MySQL retains the logs generated during the last two weeks\. - -**Note** -The log retention period is different between Amazon RDS and Aurora\. \ No newline at end of file diff --git a/doc_source/USER_LogAccess.MySQL.Generallog.md b/doc_source/USER_LogAccess.MySQL.Generallog.md deleted file mode 100644 index a873034..0000000 --- a/doc_source/USER_LogAccess.MySQL.Generallog.md +++ /dev/null @@ -1,29 +0,0 @@ -# Accessing the MySQL slow query and general logs - -The MySQL slow query log and the general log can be written to a file or a database table by setting parameters in your DB parameter group\. For information about creating and modifying a DB parameter group, see [Working with DB parameter groups](USER_WorkingWithParamGroups.md)\. You must set these parameters before you can view the slow query log or general log in the Amazon RDS console or by using the Amazon RDS API, Amazon RDS CLI, or AWS SDKs\. - -You can control MySQL logging by using the parameters in this list: -+ `slow_query_log`: To create the slow query log, set to 1\. The default is 0\. -+ `general_log`: To create the general log, set to 1\. The default is 0\. -+ `long_query_time`: To prevent fast\-running queries from being logged in the slow query log, specify a value for the shortest query run time to be logged, in seconds\. The default is 10 seconds; the minimum is 0\. If log\_output = FILE, you can specify a floating point value that goes to microsecond resolution\. If log\_output = TABLE, you must specify an integer value with second resolution\. Only queries whose run time exceeds the `long_query_time` value are logged\. For example, setting `long_query_time` to 0\.1 prevents any query that runs for less than 100 milliseconds from being logged\. -+ `log_queries_not_using_indexes`: To log all queries that do not use an index to the slow query log, set to 1\. The default is 0\. Queries that do not use an index are logged even if their run time is less than the value of the `long_query_time` parameter\. -+ `log_output option`: You can specify one of the following options for the `log_output` parameter\. - + **TABLE** \(default\) – Write general queries to the `mysql.general_log` table, and slow queries to the `mysql.slow_log` table\. - + **FILE** – Write both general and slow query logs to the file system\. Log files are rotated hourly\. - + **NONE** – Disable logging\. - -When logging is enabled, Amazon RDS rotates table logs or deletes log files at regular intervals\. This measure is a precaution to reduce the possibility of a large log file either blocking database use or affecting performance\. `FILE` and `TABLE` logging approach rotation and deletion as follows: -+ When `FILE` logging is enabled, log files are examined every hour and log files more than two weeks old are deleted\. In some cases, the remaining combined log file size after the deletion might exceed the threshold of 2 percent of a DB instance's allocated space\. In these cases, the oldest log files are deleted until the log file size no longer exceeds the threshold\. -+ When `TABLE` logging is enabled, in some cases log tables are rotated every 24 hours\. This rotation occurs if the space used by the table logs is more than 20 percent of the allocated storage space or the size of all logs combined is greater than 10 GB\. If the amount of space used for a DB instance is greater than 90 percent of the DB instance's allocated storage space, then the thresholds for log rotation are reduced\. Log tables are then rotated if the space used by the table logs is more than 10 percent of the allocated storage space or the size of all logs combined is greater than 5 GB\. You can subscribe to the `low_free_storage` event to be notified when log tables are rotated to free up space\. For more information, see [Using Amazon RDS event notification](USER_Events.md)\. - - When log tables are rotated, the current log table is copied to a backup log table and the entries in the current log table are removed\. If the backup log table already exists, then it is deleted before the current log table is copied to the backup\. You can query the backup log table if needed\. The backup log table for the `mysql.general_log` table is named `mysql.general_log_backup`\. The backup log table for the `mysql.slow_log` table is named `mysql.slow_log_backup`\. - - You can rotate the `mysql.general_log` table by calling the `mysql.rds_rotate_general_log` procedure\. You can rotate the `mysql.slow_log` table by calling the `mysql.rds_rotate_slow_log` procedure\. - - Table logs are rotated during a database version upgrade\. - -To work with the logs from the Amazon RDS console, Amazon RDS API, Amazon RDS CLI, or AWS SDKs, set the `log_output` parameter to FILE\. Like the MySQL error log, these log files are rotated hourly\. The log files that were generated during the previous two weeks are retained\. Note that the retention period is different between Amazon RDS and Aurora\. - -For more information about the slow query and general logs, go to the following topics in the MySQL documentation: -+ [The slow query log](https://dev.mysql.com/doc/refman/8.0/en/slow-query-log.html) -+ [The general query log](https://dev.mysql.com/doc/refman/8.0/en/query-log.html) \ No newline at end of file diff --git a/doc_source/USER_LogAccess.MySQL.LogFileSize.md b/doc_source/USER_LogAccess.MySQL.LogFileSize.md deleted file mode 100644 index 2173bea..0000000 --- a/doc_source/USER_LogAccess.MySQL.LogFileSize.md +++ /dev/null @@ -1,79 +0,0 @@ -# Overview of RDS for MySQL database logs - -You can monitor the following types of RDS for MySQL log files: -+ Error log -+ Slow query log -+ General log -+ Audit log - -The RDS for MySQL error log is generated by default\. You can generate the slow query and general logs by setting parameters in your DB parameter group\. - -**Topics** -+ [RDS for MySQL error logs](#USER_LogAccess.MySQL.Errorlog) -+ [RDS for MySQL slow query and general logs](#USER_LogAccess.MySQL.Generallog) -+ [MySQL audit log](#USER_LogAccess.MySQL.Auditlog) -+ [Log rotation and retention for RDS for MySQL](#USER_LogAccess.MySQL.LogFileSize.retention) -+ [Size limits on redo logs](#USER_LogAccess.MySQL.LogFileSize.RedoLogs) -+ [Size limits on BLOBs written to the redo log](#USER_LogAccess.MySQL.LogFileSize.BLOBs) - -## RDS for MySQL error logs - -RDS for MySQL writes errors in the `mysql-error.log` file\. Each log file has the hour it was generated \(in UTC\) appended to its name\. The log files also have a timestamp that helps you determine when the log entries were written\. - -RDS for MySQL writes to the error log only on startup, shutdown, and when it encounters errors\. A DB instance can go hours or days without new entries being written to the error log\. If you see no recent entries, it's because the server didn't encounter an error that would result in a log entry\. - -By design, the error logs are filtered so that only unexpected events such as errors are shown\. However, the error logs also contain some additional database information, for example query progress, which isn't shown\. Therefore, even without any actual errors the size of the error logs might increase because of ongoing database activities\. And while you might see a certain size in bytes or kilobytes for the error logs in the AWS Management Console, they might have 0 bytes when you download them\. - -RDS for MySQL writes `mysql-error.log` to disk every 5 minutes\. It appends the contents of the log to `mysql-error-running.log`\. - -RDS for MySQL rotates the `mysql-error-running.log` file every hour\. It retains the logs generated during the last two weeks\. - -**Note** -The log retention period is different between Amazon RDS and Aurora\. - -## RDS for MySQL slow query and general logs - -You can write the RDS for MySQL slow query log and the general log to a file or a database table\. To do so, set parameters in your DB parameter group\. For information about creating and modifying a DB parameter group, see [Working with parameter groups](USER_WorkingWithParamGroups.md)\. You must set these parameters before you can view the slow query log or general log in the Amazon RDS console or by using the Amazon RDS API, Amazon RDS CLI, or AWS SDKs\. - -You can control RDS for MySQL logging by using the parameters in this list: -+ `slow_query_log`: To create the slow query log, set to 1\. The default is 0\. -+ `general_log`: To create the general log, set to 1\. The default is 0\. -+ `long_query_time`: To prevent fast\-running queries from being logged in the slow query log, specify a value for the shortest query runtime to be logged, in seconds\. The default is 10 seconds; the minimum is 0\. If log\_output = FILE, you can specify a floating point value that goes to microsecond resolution\. If log\_output = TABLE, you must specify an integer value with second resolution\. Only queries whose runtime exceeds the `long_query_time` value are logged\. For example, setting `long_query_time` to 0\.1 prevents any query that runs for less than 100 milliseconds from being logged\. -+ `log_queries_not_using_indexes`: To log all queries that do not use an index to the slow query log, set to 1\. Queries that don't use an index are logged even if their runtime is less than the value of the `long_query_time` parameter\. The default is 0\. -+ `log_output option`: You can specify one of the following options for the `log_output` parameter\. - + **TABLE** \(default\) – Write general queries to the `mysql.general_log` table, and slow queries to the `mysql.slow_log` table\. - + **FILE** – Write both general and slow query logs to the file system\. - + **NONE** – Disable logging\. - -For more information about the slow query and general logs, go to the following topics in the MySQL documentation: -+ [The slow query log](https://dev.mysql.com/doc/refman/8.0/en/slow-query-log.html) -+ [The general query log](https://dev.mysql.com/doc/refman/8.0/en/query-log.html) - -## MySQL audit log - -To access the audit log, the DB instance must use a custom option group with the `MARIADB_AUDIT_PLUGIN` option\. For more information, see [MariaDB Audit Plugin support for MySQL](Appendix.MySQL.Options.AuditPlugin.md)\. - -## Log rotation and retention for RDS for MySQL - -When logging is enabled, Amazon RDS rotates table logs or deletes log files at regular intervals\. This measure is a precaution to reduce the possibility of a large log file either blocking database use or affecting performance\. RDS for MySQL handles rotation and deletion as follows: -+ The MySQL slow query log, error log, and the general log file sizes are constrained to no more than 2 percent of the allocated storage space for a DB instance\. To maintain this threshold, logs are automatically rotated every hour\. MySQL removes log files more than two weeks old\. If the combined log file size exceeds the threshold after removing old log files, then the oldest log files are deleted until the log file size no longer exceeds the threshold\. -+ When `FILE` logging is enabled, log files are examined every hour and log files more than two weeks old are deleted\. In some cases, the remaining combined log file size after the deletion might exceed the threshold of 2 percent of a DB instance's allocated space\. In these cases, the oldest log files are deleted until the log file size no longer exceeds the threshold\. -+ When `TABLE` logging is enabled, in some cases log tables are rotated every 24 hours\. This rotation occurs if the space used by the table logs is more than 20 percent of the allocated storage space\. It also occurs if the size of all logs combined is greater than 10 GB\. If the amount of space used for a DB instance is greater than 90 percent of the DB instance's allocated storage space, then the thresholds for log rotation are reduced\. Log tables are then rotated if the space used by the table logs is more than 10 percent of the allocated storage space\. They're also rotated if the size of all logs combined is greater than 5 GB\. You can subscribe to the `low_free_storage` event to be notified when log tables are rotated to free up space\. For more information, see [Working with Amazon RDS event notification](USER_Events.md)\. - - When log tables are rotated, the current log table is first copied to a backup log table\. Then the entries in the current log table are removed\. If the backup log table already exists, then it is deleted before the current log table is copied to the backup\. You can query the backup log table if needed\. The backup log table for the `mysql.general_log` table is named `mysql.general_log_backup`\. The backup log table for the `mysql.slow_log` table is named `mysql.slow_log_backup`\. - - You can rotate the `mysql.general_log` table by calling the `mysql.rds_rotate_general_log` procedure\. You can rotate the `mysql.slow_log` table by calling the `mysql.rds_rotate_slow_log` procedure\. - - Table logs are rotated during a database version upgrade\. - -To work with the logs from the Amazon RDS console, Amazon RDS API, Amazon RDS CLI, or AWS SDKs, set the `log_output` parameter to FILE\. Like the MySQL error log, these log files are rotated hourly\. The log files that were generated during the previous two weeks are retained\. Note that the retention period is different between Amazon RDS and Aurora\. - -## Size limits on redo logs - -For RDS for MySQL version 8\.0\.28 and lower, the `innodb_log_file_size` parameter determines the size of redo logs\. The default value of this parameter is 256 MB\. For information about limitations related to this limit, see [Size limits on BLOBs written to the redo log](#USER_LogAccess.MySQL.LogFileSize.BLOBs)\. For more information on how redo log size is calculated for these versions of MySQL, see [ innodb\_log\_file\_size](https://dev.mysql.com/doc/refman/5.7/en/innodb-parameters.html#sysvar_innodb_log_file_size) in the MySQL documentation\. - -For RDS for MySQL version 8\.0\.30 and higher, the `innodb_redo_log_capacity` parameter is used instead of the `innodb_log_file_size` parameter\. The default value of the `innodb_redo_log_capacity` parameter is 256 MB\. For more information, see [ Changes in MySQL 8\.0\.30](https://dev.mysql.com/doc/relnotes/mysql/8.0/en/news-8-0-30.html) in the MySQL documentation\. - -## Size limits on BLOBs written to the redo log - -For RDS for MySQL version 8\.0\.30 and higher, the `innodb_redo_log_capacity` parameter is used instead of the `innodb_log_file_size` parameter\. The size limit doesn't apply to the `innodb_redo_log_capacity` parameter\. For more information, see [Size limits on redo logs](#USER_LogAccess.MySQL.LogFileSize.RedoLogs)\. \ No newline at end of file diff --git a/doc_source/USER_LogAccess.MySQLDB.PublishtoCloudWatchLogs.md b/doc_source/USER_LogAccess.MySQLDB.PublishtoCloudWatchLogs.md deleted file mode 100644 index 960803b..0000000 --- a/doc_source/USER_LogAccess.MySQLDB.PublishtoCloudWatchLogs.md +++ /dev/null @@ -1,113 +0,0 @@ -# Publishing MySQL logs to Amazon CloudWatch Logs - -You can configure your MySQL DB instance to publish log data to a log group in Amazon CloudWatch Logs\. With CloudWatch Logs, you can perform real\-time analysis of the log data, and use CloudWatch to create alarms and view metrics\. You can use CloudWatch Logs to store your log records in highly durable storage\. - -Amazon RDS publishes each MySQL database log as a separate database stream in the log group\. For example, if you configure the export function to include the slow query log, slow query data is stored in a slow query log stream in the `/aws/rds/instance/my_instance/slowquery` log group\. - -The error log is enabled by default\. The following table summarizes the requirements for the other MySQL logs\. - - -| Log | Requirement | -| --- | --- | -| Audit log | The DB instance must use a custom option group with the `MARIADB_AUDIT_PLUGIN` option\. | -| General log | The DB instance must use a custom parameter group with the parameter setting `general_log = 1` to enable the general log\. | -| Slow query log | The DB instance must use a custom parameter group with the parameter setting `slow_query_log = 1` to enable the slow query log\. | -| Log output | The DB instance must use a custom parameter group with the parameter setting `log_output = FILE` to write logs to the file system and publish them to CloudWatch Logs\. | - -## Console - -**To publish MySQL logs to CloudWatch Logs using the console** - -1. Open the Amazon RDS console at [https://console\.aws\.amazon\.com/rds/](https://console.aws.amazon.com/rds/)\. - -1. In the navigation pane, choose **Databases**, and then choose the DB instance that you want to modify\. - -1. Choose **Modify**\. - -1. In the **Log exports** section, choose the logs that you want to start publishing to CloudWatch Logs\. - -1. Choose **Continue**, and then choose **Modify DB Instance** on the summary page\. - -## AWS CLI - - You can publish MySQL logs with the AWS CLI\. You can call the [https://docs.aws.amazon.com/cli/latest/reference/rds/modify-db-instance.html](https://docs.aws.amazon.com/cli/latest/reference/rds/modify-db-instance.html) command with the following parameters: -+ `--db-instance-identifier` -+ `--cloudwatch-logs-export-configuration` - -**Note** -A change to the `--cloudwatch-logs-export-configuration` option is always applied to the DB instance immediately\. Therefore, the `--apply-immediately` and `--no-apply-immediately` options have no effect\. - -You can also publish MySQL logs by calling the following AWS CLI commands: -+ [https://docs.aws.amazon.com/cli/latest/reference/rds/create-db-instance.html](https://docs.aws.amazon.com/cli/latest/reference/rds/create-db-instance.html) -+ [https://docs.aws.amazon.com/cli/latest/reference/rds/restore-db-instance-from-db-snapshot.html](https://docs.aws.amazon.com/cli/latest/reference/rds/restore-db-instance-from-db-snapshot.html) -+ [https://docs.aws.amazon.com/cli/latest/reference/rds/restore-db-instance-from-s3.html](https://docs.aws.amazon.com/cli/latest/reference/rds/restore-db-instance-from-s3.html) -+ [https://docs.aws.amazon.com/cli/latest/reference/rds/restore-db-instance-to-point-in-time.html](https://docs.aws.amazon.com/cli/latest/reference/rds/restore-db-instance-to-point-in-time.html) - -Run one of these AWS CLI commands with the following options: -+ `--db-instance-identifier` -+ `--enable-cloudwatch-logs-exports` -+ `--db-instance-class` -+ `--engine` - -Other options might be required depending on the AWS CLI command you run\. - -**Example** -The following example modifies an existing MySQL DB instance to publish log files to CloudWatch Logs\. The `--cloudwatch-logs-export-configuration` value is a JSON object\. The key for this object is `EnableLogTypes`, and its value is an array of strings with any combination of `audit`, `error`, `general`, and `slowquery`\. -For Linux, macOS, or Unix: - -``` -1. aws rds modify-db-instance \ -2. --db-instance-identifier mydbinstance \ -3. --cloudwatch-logs-export-configuration '{"EnableLogTypes":["audit","error","general","slowquery"]}' -``` -For Windows: - -``` -1. aws rds modify-db-instance ^ -2. --db-instance-identifier mydbinstance ^ -3. --cloudwatch-logs-export-configuration '{"EnableLogTypes":["audit","error","general","slowquery"]}' -``` - -**Example** -The following example creates a MySQL DB instance and publishes log files to CloudWatch Logs\. The `--enable-cloudwatch-logs-exports` value is a JSON array of strings\. The strings can be any combination of `audit`, `error`, `general`, and `slowquery`\. -For Linux, macOS, or Unix: - -``` -1. aws rds create-db-instance \ -2. --db-instance-identifier mydbinstance \ -3. --enable-cloudwatch-logs-exports '["audit","error","general","slowquery"]' \ -4. --db-instance-class db.m4.large \ -5. --engine MySQL -``` -For Windows: - -``` -1. aws rds create-db-instance ^ -2. --db-instance-identifier mydbinstance ^ -3. --enable-cloudwatch-logs-exports '["audit","error","general","slowquery"]' ^ -4. --db-instance-class db.m4.large ^ -5. --engine MySQL -``` - -## RDS API - -You can publish MySQL logs with the RDS API\. You can call the [https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_ModifyDBInstance.html](https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_ModifyDBInstance.html) action with the following parameters: -+ `DBInstanceIdentifier` -+ `CloudwatchLogsExportConfiguration` - -**Note** -A change to the `CloudwatchLogsExportConfiguration` parameter is always applied to the DB instance immediately\. Therefore, the `ApplyImmediately` parameter has no effect\. - -You can also publish MySQL logs by calling the following RDS API operations: -+ [https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_CreateDBInstance.html](https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_CreateDBInstance.html) -+ [https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_RestoreDBInstanceFromDBSnapshot.html](https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_RestoreDBInstanceFromDBSnapshot.html) -+ [https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_RestoreDBInstanceFromS3.html](https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_RestoreDBInstanceFromS3.html) -+ [https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_RestoreDBInstanceToPointInTime.html](https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_RestoreDBInstanceToPointInTime.html) - -Run one of these RDS API operations with the following parameters: -+ `DBInstanceIdentifier` -+ `EnableCloudwatchLogsExports` -+ `Engine` -+ `DBInstanceClass` - -Other parameters might be required depending on the AWS CLI command you run\. \ No newline at end of file diff --git a/doc_source/USER_LogAccess.Procedural.Downloading.md b/doc_source/USER_LogAccess.Procedural.Downloading.md deleted file mode 100644 index 3b9168b..0000000 --- a/doc_source/USER_LogAccess.Procedural.Downloading.md +++ /dev/null @@ -1,50 +0,0 @@ -# Downloading a database log file - -You can use the AWS Management Console, AWS CLI, or API to download a database log file\. - -## Console - -**To download a database log file** - -1. Open the Amazon RDS console at [https://console\.aws\.amazon\.com/rds/](https://console.aws.amazon.com/rds/)\. - -1. In the navigation pane, choose **Databases**\. - -1. Choose the name of the DB instance that has the log file that you want to view\. - -1. Choose the **Logs & events** tab\. - -1. Scroll down to the **Logs** section\. - -1. In the **Logs** section, choose the button next to the log that you want to download, and then choose **Download**\. - -1. Open the context \(right\-click\) menu for the link provided, and then choose **Save Link As**\. Enter the location where you want the log file to be saved, and then choose **Save**\. -![\[viewing log file\]](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/images/log_download2.png) - -## AWS CLI - -To download a database log file, use the AWS CLI command [https://docs.aws.amazon.com/cli/latest/reference/rds/download-db-log-file-portion.html](https://docs.aws.amazon.com/cli/latest/reference/rds/download-db-log-file-portion.html)\. By default, this command downloads only the latest portion of a log file\. However, you can download an entire file by specifying the parameter `--starting-token 0`\. - -The following example shows how to download the entire contents of a log file called *log/ERROR\.4* and store it in a local file called *errorlog\.txt*\. - -**Example** -For Linux, macOS, or Unix: - -``` -1. aws rds download-db-log-file-portion \ -2. --db-instance-identifier myexampledb \ -3. --starting-token 0 --output text \ -4. --log-file-name log/ERROR.4 > errorlog.txt -``` -For Windows: - -``` -1. aws rds download-db-log-file-portion ^ -2. --db-instance-identifier myexampledb ^ -3. --starting-token 0 --output text ^ -4. --log-file-name log/ERROR.4 > errorlog.txt -``` - -## RDS API - -To download a database log file, use the Amazon RDS API [https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_DownloadDBLogFilePortion.html](https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_DownloadDBLogFilePortion.html) action\. \ No newline at end of file diff --git a/doc_source/USER_LogAccess.Procedural.UploadtoCloudWatch.md b/doc_source/USER_LogAccess.Procedural.UploadtoCloudWatch.md deleted file mode 100644 index bd3d06b..0000000 --- a/doc_source/USER_LogAccess.Procedural.UploadtoCloudWatch.md +++ /dev/null @@ -1,77 +0,0 @@ -# Publishing database logs to Amazon CloudWatch Logs - -In an on\-premises database, the database logs reside on the file system\. Amazon RDS doesn't provide host access to the database logs on the file system of your DB instance\. For this reason, Amazon RDS lets you export database logs to [Amazon CloudWatch Logs](https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/WhatIsCloudWatchLogs.html)\. With CloudWatch Logs, you can perform real\-time analysis of the log data\. You can also store the data in highly durable storage and manage the data with the CloudWatch Logs Agent\. - -**Topics** -+ [Overview of RDS integration with CloudWatch Logs](#rds-integration-cw-logs) -+ [Deciding which logs to publish to CloudWatch Logs](#engine-specific-logs) -+ [Specifying the logs to publish to CloudWatch Logs](#integrating_cloudwatchlogs.configure) -+ [Searching and filtering your logs in CloudWatch Logs](#accessing-logs-in-cloudwatch) - -## Overview of RDS integration with CloudWatch Logs - -In CloudWatch Logs, a *log stream* is a sequence of log events that share the same source\. Each separate source of logs in CloudWatch Logs makes up a separate log stream\. A *log group* is a group of log streams that share the same retention, monitoring, and access control settings\. - -Amazon RDS continuously streams your DB instance log records to a log group\. For example, you have a log group `/aws/rds/instance/instance_name/log_type` for each type of log that you publish\. This log group is in the same AWS Region as the database instance that generates the log\. - -AWS retains log data published to CloudWatch Logs for an indefinite time period unless you specify a retention period\. For more information, see [Change log data retention in CloudWatch Logs](https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/Working-with-log-groups-and-streams.html#SettingLogRetention)\. - -## Deciding which logs to publish to CloudWatch Logs - -Each RDS database engine supports its own set of logs\. To learn about the options for your database engine, review the following topics: -+ [Publishing MariaDB logs to Amazon CloudWatch Logs](USER_LogAccess.Concepts.MariaDB.md#USER_LogAccess.MariaDB.PublishtoCloudWatchLogs) -+ [Publishing MySQL logs to Amazon CloudWatch Logs](USER_LogAccess.MySQLDB.PublishtoCloudWatchLogs.md) -+ [Publishing Oracle logs to Amazon CloudWatch Logs](USER_LogAccess.Concepts.Oracle.md#USER_LogAccess.Oracle.PublishtoCloudWatchLogs) -+ [Publishing PostgreSQL logs to Amazon CloudWatch Logs](USER_LogAccess.Concepts.PostgreSQL.md#USER_LogAccess.Concepts.PostgreSQL.PublishtoCloudWatchLogs) -+ [Publishing SQL Server logs to Amazon CloudWatch Logs](USER_LogAccess.Concepts.SQLServer.md#USER_LogAccess.SQLServer.PublishtoCloudWatchLogs) - -## Specifying the logs to publish to CloudWatch Logs - -You specify which logs to publish in the console\. Make sure that you have a service\-linked role in AWS Identity and Access Management \(IAM\)\. For more information about service\-linked roles, see [Using service\-linked roles for Amazon RDS](UsingWithRDS.IAM.ServiceLinkedRoles.md)\. - -**To specify the logs to publish** - -1. Open the Amazon RDS console at [https://console\.aws\.amazon\.com/rds/](https://console.aws.amazon.com/rds/)\. - -1. In the navigation pane, choose **Databases**\. - -1. Do either of the following: - + Choose **Create database**\. - + Choose a database from the list, and then choose **Modify**\. - -1. In **Logs exports**, choose which logs to publish\. - - The following example specifies the audit log, error logs, general log, and slow query log\. -![\[Choose the logs to publish to CloudWatch Logs\]](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/images/AddCWLogs.png) - -## Searching and filtering your logs in CloudWatch Logs - -You can search for log entries that meet a specified criteria using the CloudWatch Logs console\. You can access the logs either through the RDS console, which leads you to the CloudWatch Logs console, or from the CloudWatch Logs console directly\. - -**To search your RDS logs using the RDS console** - -1. Open the Amazon RDS console at [https://console\.aws\.amazon\.com/rds/](https://console.aws.amazon.com/rds/)\. - -1. In the navigation pane, choose **Databases**\. - -1. Choose a DB instance\. - -1. Choose **Configuration**\. - -1. Under **Published logs**, choose the database log that you want to view\. - -**To search your RDS logs using the CloudWatch Logs console** - -1. Open the CloudWatch console at [https://console\.aws\.amazon\.com/cloudwatch/](https://console.aws.amazon.com/cloudwatch/)\. - -1. In the navigation pane, choose **Log groups**\. - -1. In the filter box, enter **/aws/rds**\. - -1. For **Log Groups**, choose the name of the log group containing the log stream to search\. - -1. For **Log Streams**, choose the name of the log stream to search\. - -1. Under **Log events**, enter the filter syntax to use\. - -For more information, see [Searching and filtering log data](https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/MonitoringLogData.html) in the *Amazon CloudWatch Logs User Guide*\. For a blog tutorial explaining how to monitor RDS logs, see [Build proactive database monitoring for Amazon RDS with Amazon CloudWatch Logs, AWS Lambda, and Amazon SNS](http://aws.amazon.com/blogs/database/build-proactive-database-monitoring-for-amazon-rds-with-amazon-cloudwatch-logs-aws-lambda-and-amazon-sns/)\. \ No newline at end of file diff --git a/doc_source/USER_LogAccess.Procedural.Viewing.md b/doc_source/USER_LogAccess.Procedural.Viewing.md deleted file mode 100644 index f91edd7..0000000 --- a/doc_source/USER_LogAccess.Procedural.Viewing.md +++ /dev/null @@ -1,40 +0,0 @@ -# Viewing and listing database log files - -You can view database log files for your Amazon RDS DB engine by using the AWS Management Console\. You can list what log files are available for download or monitoring by using the AWS CLI or Amazon RDS API\. - -**Note** -If you can't view the list of log files for an existing RDS for Oracle DB instance, reboot the instance to view the list\. - -## Console - -**To view a database log file** - -1. Open the Amazon RDS console at [https://console\.aws\.amazon\.com/rds/](https://console.aws.amazon.com/rds/)\. - -1. In the navigation pane, choose **Databases**\. - -1. Choose the name of the DB instance that has the log file that you want to view\. - -1. Choose the **Logs & events** tab\. - -1. Scroll down to the **Logs** section\. - -1. \(Optional\) Enter a search term to filter your results\. - -1. Choose the log that you want to view, and then choose **View**\. - -## AWS CLI - -To list the available database log files for a DB instance, use the AWS CLI [https://docs.aws.amazon.com/cli/latest/reference/rds/describe-db-log-files.html](https://docs.aws.amazon.com/cli/latest/reference/rds/describe-db-log-files.html) command\. - -The following example returns a list of log files for a DB instance named `my-db-instance`\. - -**Example** - -``` -1. aws rds describe-db-log-files --db-instance-identifier my-db-instance -``` - -## RDS API - -To list the available database log files for a DB instance, use the Amazon RDS API [https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_DescribeDBLogFiles.html](https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_DescribeDBLogFiles.html) action\. \ No newline at end of file diff --git a/doc_source/USER_LogAccess.Procedural.Watching.md b/doc_source/USER_LogAccess.Procedural.Watching.md deleted file mode 100644 index 325b4c7..0000000 --- a/doc_source/USER_LogAccess.Procedural.Watching.md +++ /dev/null @@ -1,22 +0,0 @@ -# Watching a database log file - -Watching a database log file is equivalent to tailing the file on a UNIX or Linux system\. You can watch a log file by using the AWS Management Console\. RDS refreshes the tail of the log every 5 seconds\. - -## - -**To watch a database log file** - -1. Open the Amazon RDS console at [https://console\.aws\.amazon\.com/rds/](https://console.aws.amazon.com/rds/)\. - -1. In the navigation pane, choose **Databases**\. - -1. Choose the name of the DB instance that has the log file that you want to view\. - -1. Choose the **Logs & events** tab\. -![\[Choose the Logs & events tab\]](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/images/Monitoring_logsEvents.png) - -1. In the **Logs** section, choose a log file, and then choose **Watch**\. -![\[Choose a log\]](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/images/Monitoring_LogsEvents_watch.png) - - RDS shows the tail of the log, as in the following MySQL example\. -![\[Tail of a log file\]](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/images/Monitoring_LogsEvents_watch_content.png) \ No newline at end of file diff --git a/doc_source/USER_LogAccess.md b/doc_source/USER_LogAccess.md deleted file mode 100644 index 7bdbcdb..0000000 --- a/doc_source/USER_LogAccess.md +++ /dev/null @@ -1,17 +0,0 @@ -# Monitoring Amazon RDS log files - -Every RDS database engine generates logs that you can access for auditing and troubleshooting\. The type of logs depends on your database engine\. - -You can access database logs using the AWS Management Console, the AWS Command Line Interface \(AWS CLI\), or the Amazon RDS API\. You can't view, watch, or download transaction logs\. - -**Topics** -+ [Viewing and listing database log files](USER_LogAccess.Procedural.Viewing.md) -+ [Downloading a database log file](USER_LogAccess.Procedural.Downloading.md) -+ [Watching a database log file](USER_LogAccess.Procedural.Watching.md) -+ [Publishing database logs to Amazon CloudWatch Logs](USER_LogAccess.Procedural.UploadtoCloudWatch.md) -+ [Reading log file contents using REST](DownloadCompleteDBLogFile.md) -+ [MariaDB database log files](USER_LogAccess.Concepts.MariaDB.md) -+ [Microsoft SQL Server database log files](USER_LogAccess.Concepts.SQLServer.md) -+ [MySQL database log files](USER_LogAccess.Concepts.MySQL.md) -+ [Oracle database log files](USER_LogAccess.Concepts.Oracle.md) -+ [RDS for PostgreSQL database log files](USER_LogAccess.Concepts.PostgreSQL.md) \ No newline at end of file diff --git a/doc_source/USER_MariaDB.Replication.ReadReplicas.md b/doc_source/USER_MariaDB.Replication.ReadReplicas.md deleted file mode 100644 index 1d4ce06..0000000 --- a/doc_source/USER_MariaDB.Replication.ReadReplicas.md +++ /dev/null @@ -1,371 +0,0 @@ -# Working with MariaDB read replicas - -Following, you can find specific information about working with read replicas on Amazon RDS for MariaDB\. For general information about read replicas and instructions for using them, see [Working with DB instance read replicas](USER_ReadRepl.md)\. - -**Topics** -+ [Configuring read replicas with MariaDB](#USER_MariaDB.Replication.ReadReplicas.Configuration) -+ [Configuring replication filters with MariaDB](#USER_MariaDB.Replication.ReadReplicas.ReplicationFilters) -+ [Configuring delayed replication with MariaDB](#USER_MariaDB.Replication.ReadReplicas.DelayReplication) -+ [Updating read replicas with MariaDB](#USER_MariaDB.Replication.ReadReplicas.Updates) -+ [Working with Multi\-AZ read replica deployments with MariaDB](#USER_MariaDB.Replication.ReadReplicas.MultiAZ) -+ [Using cascading read replicas with RDS for MariaDB](#USER_MariaDB.Replication.ReadReplicas.Cascading) -+ [Monitoring MariaDB read replicas](#USER_MariaDB.Replication.ReadReplicas.Monitor) -+ [Starting and stopping replication with MariaDB read replicas](#USER_MariaDB.Replication.ReadReplicas.StartStop) -+ [Troubleshooting a MariaDB read replica problem](#USER_ReadRepl.Troubleshooting.MariaDB) - -## Configuring read replicas with MariaDB - -Before a MariaDB DB instance can serve as a replication source, make sure to turn on automatic backups on the source DB instance by setting the backup retention period to a value other than 0\. This requirement also applies to a read replica that is the source DB instance for another read replica\. - -You can create up to 15 read replicas from one DB instance within the same Region\. For replication to operate effectively, each read replica should have as the same amount of compute and storage resources as the source DB instance\. If you scale the source DB instance, also scale the read replicas\. - -RDS for MariaDB supports cascading read replicas\. To learn how to configure cascading read replicas, see [Using cascading read replicas with RDS for MariaDB](#USER_MariaDB.Replication.ReadReplicas.Cascading)\. - -You can run multiple read replica create and delete actions at the same time that reference the same source DB instance\. When you perform these actions, stay within the limit of 15 read replicas for each source instance\. - -## Configuring replication filters with MariaDB - -You can use replication filters to specify which databases and tables are replicated with a read replica\. Replication filters can include databases and tables in replication or exclude them from replication\. - -The following are some use cases for replication filters: -+ To reduce the size of a read replica\. With replication filtering, you can exclude the databases and tables that aren't needed on the read replica\. -+ To exclude databases and tables from read replicas for security reasons\. -+ To replicate different databases and tables for specific use cases at different read replicas\. For example, you might use specific read replicas for analytics or sharding\. -+ For a DB instance that has read replicas in different AWS Regions, to replicate different databases or tables in different AWS Regions\. - -**Note** -You can also use replication filters to specify which databases and tables are replicated with a primary MariaDB DB instance that is configured as a replica in an inbound replication topology\. For more information about this configuration, see [Configuring binary log file position replication with an external source instance](MySQL.Procedural.Importing.External.Repl.md)\. - -**Topics** -+ [Setting replication filtering parameters for RDS for MariaDB](#USER_MariaDB.Replication.ReadReplicas.ReplicationFilters.Configuring) -+ [Replication filtering limitations for RDS for MariaDB](#USER_MariaDB.Replication.ReadReplicas.ReplicationFilters.Limitations) -+ [Replication filtering examples for RDS for MariaDB](#USER_MariaDB.Replication.ReadReplicas.ReplicationFilters.Examples) -+ [Viewing the replication filters for a read replica](#USER_MariaDB.Replication.ReadReplicas.ReplicationFilters.Viewing) - -### Setting replication filtering parameters for RDS for MariaDB - -To configure replication filters, set the following replication filtering parameters on the read replica: -+ `replicate-do-db` – Replicate changes to the specified databases\. When you set this parameter for a read replica, only the databases specified in the parameter are replicated\. -+ `replicate-ignore-db` – Don't replicate changes to the specified databases\. When the `replicate-do-db` parameter is set for a read replica, this parameter isn't evaluated\. -+ `replicate-do-table` – Replicate changes to the specified tables\. When you set this parameter for a read replica, only the tables specified in the parameter are replicated\. Also, when the `replicate-do-db` or `replicate-ignore-db` parameter is set, the database that includes the specified tables must be included in replication with the read replica\. -+ `replicate-ignore-table` – Don't replicate changes to the specified tables\. When the `replicate-do-table` parameter is set for a read replica, this parameter isn't evaluated\. -+ `replicate-wild-do-table` – Replicate tables based on the specified database and table name patterns\. The `%` and `_` wildcard characters are supported\. When the `replicate-do-db` or `replicate-ignore-db` parameter is set, make sure to include the database that includes the specified tables in replication with the read replica\. -+ `replicate-wild-ignore-table` – Don't replicate tables based on the specified database and table name patterns\. The `%` and `_` wildcard characters are supported\. When the `replicate-do-table` or `replicate-wild-do-table` parameter is set for a read replica, this parameter isn't evaluated\. - -The parameters are evaluated in the order that they are listed\. For more information about how these parameters work, see [the MariaDB documentation](https://mariadb.com/kb/en/replication-filters/#replication-filters-for-replication-slaves)\. - -By default, each of these parameters has an empty value\. On each read replica, you can use these parameters to set, change, and delete replication filters\. When you set one of these parameters, separate each filter from others with a comma\. - -You can use the `%` and `_` wildcard characters in the `replicate-wild-do-table` and `replicate-wild-ignore-table` parameters\. The `%` wildcard matches any number of characters, and the `_` wildcard matches only one character\. - -The binary logging format of the source DB instance is important for replication because it determines the record of data changes\. The setting of the `binlog_format` parameter determines whether the replication is row\-based or statement\-based\. For more information, see [Binary logging format](USER_LogAccess.Concepts.MariaDB.md#USER_LogAccess.MariaDB.BinaryFormat)\. - -**Note** -All data definition language \(DDL\) statements are replicated as statements, regardless of the `binlog_format` setting on the source DB instance\. - -### Replication filtering limitations for RDS for MariaDB - -The following limitations apply to replication filtering for RDS for MariaDB: -+ Each replication filtering parameter has a 2,000\-character limit\. -+ Commas aren't supported in replication filters\. -+ The MariaDB `binlog_do_db` and `binlog_ignore_db` options for binary log filtering aren't supported\. -+ Replication filtering doesn't support XA transactions\. - - For more information, see [ Restrictions on XA Transactions](https://dev.mysql.com/doc/refman/8.0/en/xa-restrictions.html) in the MySQL documentation\. -+ Replication filtering isn't supported for RDS for MariaDB version 10\.2\. - -### Replication filtering examples for RDS for MariaDB - -To configure replication filtering for a read replica, modify the replication filtering parameters in the parameter group associated with the read replica\. - -**Note** -You can't modify a default parameter group\. If the read replica is using a default parameter group, create a new parameter group and associate it with the read replica\. For more information on DB parameter groups, see [Working with parameter groups](USER_WorkingWithParamGroups.md)\. - -You can set parameters in a parameter group using the AWS Management Console, AWS CLI, or RDS API\. For information about setting parameters, see [Modifying parameters in a DB parameter group](USER_WorkingWithDBInstanceParamGroups.md#USER_WorkingWithParamGroups.Modifying)\. When you set parameters in a parameter group, all of the DB instances associated with the parameter group use the parameter settings\. If you set the replication filtering parameters in a parameter group, make sure that the parameter group is associated only with read replicas\. Leave the replication filtering parameters empty for source DB instances\. - -The following examples set the parameters using the AWS CLI\. These examples set `ApplyMethod` to `immediate` so that the parameter changes occur immediately after the CLI command completes\. If you want a pending change to be applied after the read replica is rebooted, set `ApplyMethod` to `pending-reboot`\. - -The following examples set replication filters: -+ [Including databases in replication](#rep-filter-in-dbs-mariadb) -+ [Including tables in replication](#rep-filter-in-tables-mariadb) -+ [Including tables in replication with wildcard characters](#rep-filter-in-tables-wildcards-mariadb) -+ [Escaping wildcard characters in names](#rep-filter-escape-wildcards-mariadb) -+ [Excluding databases from replication](#rep-filter-ex-dbs-mariadb) -+ [Excluding tables from replication](#rep-filter-ex-tables-mariadb) -+ [Excluding tables from replication using wildcard characters](#rep-filter-ex-tables-wildcards-mariadb) - -**Example Including databases in replication** -The following example includes the `mydb1` and `mydb2` databases in replication\. When you set `replicate-do-db` for a read replica, only the databases specified in the parameter are replicated\. -For Linux, macOS, or Unix: - -``` -aws rds modify-db-parameter-group \ - --db-parameter-group-name myparametergroup \ - --parameters "[{"ParameterName": "replicate-do-db", "ParameterValue": "mydb1,mydb2", "ApplyMethod":"immediate"}]" -``` -For Windows: - -``` -aws rds modify-db-parameter-group ^ - --db-parameter-group-name myparametergroup ^ - --parameters "[{"ParameterName": "replicate-do-db", "ParameterValue": "mydb1,mydb2", "ApplyMethod":"immediate"}]" -``` - -**Example Including tables in replication** -The following example includes the `table1` and `table2` tables in database `mydb1` in replication\. -For Linux, macOS, or Unix: - -``` -aws rds modify-db-parameter-group \ - --db-parameter-group-name myparametergroup \ - --parameters "[{"ParameterName": "replicate-do-table", "ParameterValue": "mydb1.table1,mydb1.table2", "ApplyMethod":"immediate"}]" -``` -For Windows: - -``` -aws rds modify-db-parameter-group ^ - --db-parameter-group-name myparametergroup ^ - --parameters "[{"ParameterName": "replicate-do-table", "ParameterValue": "mydb1.table1,mydb1.table2", "ApplyMethod":"immediate"}]" -``` - -**Example Including tables in replication using wildcard characters** -The following example includes tables with names that begin with `orders` and `returns` in database `mydb` in replication\. -For Linux, macOS, or Unix: - -``` -aws rds modify-db-parameter-group \ - --db-parameter-group-name myparametergroup \ - --parameters "[{"ParameterName": "replicate-wild-do-table", "ParameterValue": "mydb.orders%,mydb.returns%", "ApplyMethod":"immediate"}]" -``` -For Windows: - -``` -aws rds modify-db-parameter-group ^ - --db-parameter-group-name myparametergroup ^ - --parameters "[{"ParameterName": "replicate-wild-do-table", "ParameterValue": "mydb.orders%,mydb.returns%", "ApplyMethod":"immediate"}]" -``` - -**Example Escaping wildcard characters in names** -The following example shows you how to use the escape character `\` to escape a wildcard character that is part of a name\. -Assume that you have several table names in database `mydb1` that start with `my_table`, and you want to include these tables in replication\. The table names include an underscore, which is also a wildcard character, so the example escapes the underscore in the table names\. -For Linux, macOS, or Unix: - -``` -aws rds modify-db-parameter-group \ - --db-parameter-group-name myparametergroup \ - --parameters "[{"ParameterName": "replicate-wild-do-table", "ParameterValue": "my\_table%", "ApplyMethod":"immediate"}]" -``` -For Windows: - -``` -aws rds modify-db-parameter-group ^ - --db-parameter-group-name myparametergroup ^ - --parameters "[{"ParameterName": "replicate-wild-do-table", "ParameterValue": "my\_table%", "ApplyMethod":"immediate"}]" -``` - -**Example Excluding databases from replication** -The following example excludes the `mydb1` and `mydb2` databases from replication\. -For Linux, macOS, or Unix: - -``` -aws rds modify-db-parameter-group \ - --db-parameter-group-name myparametergroup \ - --parameters "[{"ParameterName": "replicate-ignore-db", "ParameterValue": "mydb1,mydb2", "ApplyMethod":"immediate"}]" -``` -For Windows: - -``` -aws rds modify-db-parameter-group ^ - --db-parameter-group-name myparametergroup ^ - --parameters "[{"ParameterName": "replicate-ignore-db", "ParameterValue": "mydb1,mydb2", "ApplyMethod":"immediate"}]" -``` - -**Example Excluding tables from replication** -The following example excludes tables `table1` and `table2` in database `mydb1` from replication\. -For Linux, macOS, or Unix: - -``` -aws rds modify-db-parameter-group \ - --db-parameter-group-name myparametergroup \ - --parameters "[{"ParameterName": "replicate-ignore-table", "ParameterValue": "mydb1.table1,mydb1.table2", "ApplyMethod":"immediate"}]" -``` -For Windows: - -``` -aws rds modify-db-parameter-group ^ - --db-parameter-group-name myparametergroup ^ - --parameters "[{"ParameterName": "replicate-ignore-table", "ParameterValue": "mydb1.table1,mydb1.table2", "ApplyMethod":"immediate"}]" -``` - -**Example Excluding tables from replication using wildcard characters** -The following example excludes tables with names that begin with `orders` and `returns` in database `mydb` from replication\. -For Linux, macOS, or Unix: - -``` -aws rds modify-db-parameter-group \ - --db-parameter-group-name myparametergroup \ - --parameters "[{"ParameterName": "replicate-wild-ignore-table", "ParameterValue": "mydb.orders%,mydb.returns%", "ApplyMethod":"immediate"}]" -``` -For Windows: - -``` -aws rds modify-db-parameter-group ^ - --db-parameter-group-name myparametergroup ^ - --parameters "[{"ParameterName": "replicate-wild-ignore-table", "ParameterValue": "mydb.orders%,mydb.returns%", "ApplyMethod":"immediate"}]" -``` - -### Viewing the replication filters for a read replica - -You can view the replication filters for a read replica in the following ways: -+ Check the settings of the replication filtering parameters in the parameter group associated with the read replica\. - - For instructions, see [Viewing parameter values for a DB parameter group](USER_WorkingWithDBInstanceParamGroups.md#USER_WorkingWithParamGroups.Viewing)\. -+ In a MariaDB client, connect to the read replica and run the `SHOW REPLICA STATUS` statement\. - - In the output, the following fields show the replication filters for the read replica: - + `Replicate_Do_DB` - + `Replicate_Ignore_DB` - + `Replicate_Do_Table` - + `Replicate_Ignore_Table` - + `Replicate_Wild_Do_Table` - + `Replicate_Wild_Ignore_Table` - - For more information about these fields, see [Checking Replication Status](https://dev.mysql.com/doc/refman/8.0/en/replication-administration-status.html) in the MySQL documentation\. -**Note** -Previous versions of MariaDB used `SHOW SLAVE STATUS` instead of `SHOW REPLICA STATUS`\. If you are using a MariaDB version before 10\.5, then use `SHOW SLAVE STATUS`\. - -## Configuring delayed replication with MariaDB - -You can use delayed replication as a strategy for disaster recovery\. With delayed replication, you specify the minimum amount of time, in seconds, to delay replication from the source to the read replica\. In the event of a disaster, such as a table deleted unintentionally, you complete the following steps to recover from the disaster quickly: -+ Stop replication to the read replica before the change that caused the disaster is sent to it\. - - To stop replication, use the [mysql\.rds\_stop\_replication](mysql-stored-proc-replicating.md#mysql_rds_stop_replication) stored procedure\. -+ Promote the read replica to be the new source DB instance by using the instructions in [Promoting a read replica to be a standalone DB instance](USER_ReadRepl.md#USER_ReadRepl.Promote)\. - -**Note** -Delayed replication is supported for MariaDB 10\.6 and higher\. -Use stored procedures to configure delayed replication\. You can't configure delayed replication with the AWS Management Console, the AWS CLI, or the Amazon RDS API\. -You can use replication based on global transaction identifiers \(GTIDs\) in a delayed replication configuration\. - -**Topics** -+ [Configuring delayed replication during read replica creation](#USER_MariaDB.Replication.ReadReplicas.DelayReplication.ReplicaCreation) -+ [Modifying delayed replication for an existing read replica](#USER_MariaDB.Replication.ReadReplicas.DelayReplication.ExistingReplica) -+ [Promoting a read replica](#USER_MariaDB.Replication.ReadReplicas.DelayReplication.Promote) - -### Configuring delayed replication during read replica creation - -To configure delayed replication for any future read replica created from a DB instance, run the [mysql\.rds\_set\_configuration](mysql-stored-proc-configuring.md#mysql_rds_set_configuration) stored procedure with the `target delay` parameter\. - -**To configure delayed replication during read replica creation** - -1. Using a MariaDB client, connect to the MariaDB DB instance to be the source for read replicas as the master user\. - -1. Run the [mysql\.rds\_set\_configuration](mysql-stored-proc-configuring.md#mysql_rds_set_configuration) stored procedure with the `target delay` parameter\. - - For example, run the following stored procedure to specify that replication is delayed by at least one hour \(3,600 seconds\) for any read replica created from the current DB instance\. - - ``` - call mysql.rds_set_configuration('target delay', 3600); - ``` -**Note** -After running this stored procedure, any read replica you create using the AWS CLI or Amazon RDS API is configured with replication delayed by the specified number of seconds\. - -### Modifying delayed replication for an existing read replica - -To modify delayed replication for an existing read replica, run the [mysql\.rds\_set\_source\_delay](mysql-stored-proc-replicating.md#mysql_rds_set_source_delay) stored procedure\. - -**To modify delayed replication for an existing read replica** - -1. Using a MariaDB client, connect to the read replica as the master user\. - -1. Use the [mysql\.rds\_stop\_replication](mysql-stored-proc-replicating.md#mysql_rds_stop_replication) stored procedure to stop replication\. - -1. Run the [mysql\.rds\_set\_source\_delay](mysql-stored-proc-replicating.md#mysql_rds_set_source_delay) stored procedure\. - - For example, run the following stored procedure to specify that replication to the read replica is delayed by at least one hour \(3600 seconds\)\. - - ``` - call mysql.rds_set_source_delay(3600); - ``` - -1. Use the [mysql\.rds\_start\_replication](mysql-stored-proc-replicating.md#mysql_rds_start_replication) stored procedure to start replication\. - -### Promoting a read replica - -After replication is stopped, in a disaster recovery scenario, you can promote a read replica to be the new source DB instance\. For information about promoting a read replica, see [Promoting a read replica to be a standalone DB instance](USER_ReadRepl.md#USER_ReadRepl.Promote)\. - -## Updating read replicas with MariaDB - -Read replicas are designed to support read queries, but you might need occasional updates\. For example, you might need to add an index to speed the specific types of queries accessing the replica\. You can enable updates by setting the `read_only` parameter to **0** in the DB parameter group for the read replica\. - -## Working with Multi\-AZ read replica deployments with MariaDB - -You can create a read replica from either single\-AZ or Multi\-AZ DB instance deployments\. You use Multi\-AZ deployments to improve the durability and availability of critical data, but you can't use the Multi\-AZ secondary to serve read\-only queries\. Instead, you can create read replicas from high\-traffic Multi\-AZ DB instances to offload read\-only queries\. If the source instance of a Multi\-AZ deployment fails over to the secondary, any associated read replicas automatically switch to use the secondary \(now primary\) as their replication source\. For more information, see [Configuring and managing a Multi\-AZ deployment](Concepts.MultiAZ.md)\. - -You can create a read replica as a Multi\-AZ DB instance\. Amazon RDS creates a standby of your replica in another Availability Zone for failover support for the replica\. Creating your read replica as a Multi\-AZ DB instance is independent of whether the source database is a Multi\-AZ DB instance\. - -## Using cascading read replicas with RDS for MariaDB - -RDS for MariaDB supports cascading read replicas\. With *cascading read replicas*, you can scale reads without adding overhead to your source RDS for MariaDB DB instance\. - -With cascading read replicas, your RDS for MariaDB DB instance sends data to the first read replica in the chain\. That read replica then sends data to the second replica in the chain, and so on\. The end result is that all read replicas in the chain have the changes from the RDS for MariaDB DB instance, but without the overhead solely on the source DB instance\. - -You can create a series of up to three read replicas in a chain from a source RDS for MariaDB DB instance\. For example, suppose that you have an RDS for MariaDB DB instance, `mariadb-main`\. You can do the following: -+ Starting with `mariadb-main`, create the first read replica in the chain, `read-replica-1`\. -+ Next, from `read-replica-1`, create the next read replica in the chain, `read-replica-2`\. -+ Finally, from `read-replica-2`, create the third read replica in the chain, `read-replica-3`\. - -You can't create another read replica beyond this third cascading read replica in the series for `mariadb-main`\. A complete series of instances from an RDS for MariaDB source DB instance through to the end of a series of cascading read replicas can consist of at most four DB instances\. - -For cascading read replicas to work, each source RDS for MariaDB DB instance must have automated backups turned on\. To turn on automatic backups on a read replica, first create the read replica, and then modify the read replica to turn on automatic backups\. For more information, see [Creating a read replica](USER_ReadRepl.md#USER_ReadRepl.Create)\. - -As with any read replica, you can promote a read replica that's part of a cascade\. Promoting a read replica from within a chain of read replicas removes that replica from the chain\. For example, suppose that you want to move some of the workload from your `mariadb-main` DB instance to a new instance for use by the accounting department only\. Assuming the chain of three read replicas from the example, you decide to promote `read-replica-2`\. The chain is affected as follows: -+ Promoting `read-replica-2` removes it from the replication chain\. - + It is now a full read/write DB instance\. - + It continues replicating to `read-replica-3`, just as it was doing before promotion\. -+ Your `mariadb-main` continues replicating to `read-replica-1`\. - -For more information about promoting read replicas, see [Promoting a read replica to be a standalone DB instance](USER_ReadRepl.md#USER_ReadRepl.Promote)\. - -## Monitoring MariaDB read replicas - -For MariaDB read replicas, you can monitor replication lag in Amazon CloudWatch by viewing the Amazon RDS `ReplicaLag` metric\. The `ReplicaLag` metric reports the value of the `Seconds_Behind_Master` field of the `SHOW REPLICA STATUS` command\. - -**Note** -Previous versions of MariaDB used `SHOW SLAVE STATUS` instead of `SHOW REPLICA STATUS`\. If you are using a MariaDB version before 10\.5, then use `SHOW SLAVE STATUS`\. - -Common causes for replication lag for MariaDB are the following: -+ A network outage\. -+ Writing to tables with indexes on a read replica\. If the `read_only` parameter is not set to 0 on the read replica, it can break replication\. -+ Using a nontransactional storage engine such as MyISAM\. Replication is only supported for the InnoDB storage engine on MariaDB\. - -When the `ReplicaLag` metric reaches 0, the replica has caught up to the source DB instance\. If the `ReplicaLag` metric returns \-1, then replication is currently not active\. `ReplicaLag` = \-1 is equivalent to `Seconds_Behind_Master` = `NULL`\. - -## Starting and stopping replication with MariaDB read replicas - -You can stop and restart the replication process on an Amazon RDS DB instance by calling the system stored procedures [mysql\.rds\_stop\_replication](mysql-stored-proc-replicating.md#mysql_rds_stop_replication) and [mysql\.rds\_start\_replication](mysql-stored-proc-replicating.md#mysql_rds_start_replication)\. You can do this when replicating between two Amazon RDS instances for long\-running operations such as creating large indexes\. You also need to stop and start replication when importing or exporting databases\. For more information, see [Importing data to an Amazon RDS MariaDB or MySQL database with reduced downtime](MySQL.Procedural.Importing.NonRDSRepl.md) and [Exporting data from a MySQL DB instance by using replication](MySQL.Procedural.Exporting.NonRDSRepl.md)\. - -If replication is stopped for more than 30 consecutive days, either manually or due to a replication error, Amazon RDS ends replication between the source DB instance and all read replicas\. It does so to prevent increased storage requirements on the source DB instance and long failover times\. The read replica DB instance is still available\. However, replication can't be resumed because the binary logs required by the read replica are deleted from the source DB instance after replication is ended\. You can create a new read replica for the source DB instance to reestablish replication\. - -## Troubleshooting a MariaDB read replica problem - -The replication technologies for MariaDB are asynchronous\. Because they are asynchronous, occasional `BinLogDiskUsage` increases on the source DB instance and `ReplicaLag` on the read replica are to be expected\. For example, a high volume of write operations to the source DB instance can occur in parallel\. In contrast, write operations to the read replica are serialized using a single I/O thread, which can lead to a lag between the source instance and read replica\. For more information about read\-only replicas in the MariaDB documentation, go to [Replication overview](http://mariadb.com/kb/en/mariadb/replication-overview/)\. - -You can do several things to reduce the lag between updates to a source DB instance and the subsequent updates to the read replica, such as the following: -+ Sizing a read replica to have a storage size and DB instance class comparable to the source DB instance\. -+ Ensuring that parameter settings in the DB parameter groups used by the source DB instance and the read replica are compatible\. For more information and an example, see the discussion of the `max_allowed_packet` parameter later in this section\. - -Amazon RDS monitors the replication status of your read replicas and updates the `Replication State` field of the read replica instance to `Error` if replication stops for any reason\. An example might be if DML queries run on your read replica conflict with the updates made on the source DB instance\. - -You can review the details of the associated error thrown by the MariaDB engine by viewing the `Replication Error` field\. Events that indicate the status of the read replica are also generated, including [RDS-EVENT-0045](USER_Events.Messages.md#RDS-EVENT-0045), [RDS-EVENT-0046](USER_Events.Messages.md#RDS-EVENT-0046), and [RDS-EVENT-0047](USER_Events.Messages.md#RDS-EVENT-0047)\. For more information about events and subscribing to events, see [Working with Amazon RDS event notification](USER_Events.md)\. If a MariaDB error message is returned, review the error in the [MariaDB error message documentation](http://mariadb.com/kb/en/mariadb/mariadb-error-codes/)\. - -One common issue that can cause replication errors is when the value for the `max_allowed_packet` parameter for a read replica is less than the `max_allowed_packet` parameter for the source DB instance\. The `max_allowed_packet` parameter is a custom parameter that you can set in a DB parameter group that is used to specify the maximum size of DML code that can be run on the database\. In some cases, the `max_allowed_packet` parameter value in the DB parameter group associated with a source DB instance is smaller than the `max_allowed_packet` parameter value in the DB parameter group associated with the source's read replica\. In these cases, the replication process can throw an error \(Packet bigger than 'max\_allowed\_packet' bytes\) and stop replication\. You can fix the error by having the source and read replica use DB parameter groups with the same `max_allowed_packet` parameter values\. - -Other common situations that can cause replication errors include the following: -+ Writing to tables on a read replica\. If you are creating indexes on a read replica, you need to have the `read_only` parameter set to **0** to create the indexes\. If you are writing to tables on the read replica, it might break replication\. -+ Using a non\-transactional storage engine such as MyISAM\. read replicas require a transactional storage engine\. Replication is only supported for the InnoDB storage engine on MariaDB\. -+ Using unsafe nondeterministic queries such as `SYSDATE()`\. For more information, see [Determination of safe and unsafe statements in binary logging](https://dev.mysql.com/doc/refman/8.0/en/replication-rbr-safe-unsafe.html)\. - -If you decide that you can safely skip an error, you can follow the steps described in [Skipping the current replication error](Appendix.MySQL.CommonDBATasks.md#Appendix.MySQL.CommonDBATasks.SkipError)\. Otherwise, you can delete the read replica and create an instance using the same DB instance identifier so that the endpoint remains the same as that of your old read replica\. If a replication error is fixed, the `Replication State` changes to *replicating*\. - -For MariaDB DB instances, in some cases read replicas can't be switched to the secondary if some binary log \(binlog\) events aren't flushed during the failure\. In these cases, manually delete and recreate the read replicas\. You can reduce the chance of this happening by setting the following parameter values: `sync_binlog=1` and `innodb_flush_log_at_trx_commit=1`\. These settings might reduce performance, so test their impact before implementing the changes in a production environment\. \ No newline at end of file diff --git a/doc_source/USER_MariaDB.Replication.md b/doc_source/USER_MariaDB.Replication.md deleted file mode 100644 index 524b901..0000000 --- a/doc_source/USER_MariaDB.Replication.md +++ /dev/null @@ -1,16 +0,0 @@ -# Working with MariaDB replication in Amazon RDS - -You usually use read replicas to configure replication between Amazon RDS DB instances\. For general information about read replicas, see [Working with DB instance read replicas](USER_ReadRepl.md)\. For specific information about working with read replicas on Amazon RDS for MariaDB, see [Working with MariaDB read replicas](USER_MariaDB.Replication.ReadReplicas.md)\. - -You can also configure replication based on binary log coordinates for a MariaDB DB instance\. For MariaDB instances, you can also configure replication based on global transaction IDs \(GTIDs\), which provides better crash safety\. For more information, see [Configuring GTID\-based replication with an external source instance](MariaDB.Procedural.Replication.GTID.md)\. - -The following are other replication options available with RDS for MariaDB: -+ You can set up replication between an RDS for MariaDB DB instance and a MySQL or MariaDB instance that is external to Amazon RDS\. For information about configuring replication with an external source, see [Configuring binary log file position replication with an external source instance](MySQL.Procedural.Importing.External.ReplMariaDB.md)\. -+ You can configure replication to import databases from a MySQL or MariaDB instance that is external to Amazon RDS, or to export databases to such instances\. For more information, see [Importing data to an Amazon RDS MariaDB or MySQL DB instance with reduced downtime](MySQL.Procedural.Importing.NonRDSReplMariaDB.md) and [Exporting data from a MySQL DB instance by using replication](MySQL.Procedural.Exporting.NonRDSRepl.md)\. - -For any of these replication options, you can use either row\-based replication, statement\-based, or mixed replication\. Row\-based replication only replicates the changed rows that result from a SQL statement\. Statement\-based replication replicates the entire SQL statement\. Mixed replication uses statement\-based replication when possible, but switches to row\-based replication when SQL statements that are unsafe for statement\-based replication are run\. In most cases, mixed replication is recommended\. The binary log format of the DB instance determines whether replication is row\-based, statement\-based, or mixed\. For information about setting the binary log format, see [Binary logging format](USER_LogAccess.Concepts.MariaDB.md#USER_LogAccess.MariaDB.BinaryFormat)\. - -**Topics** -+ [Working with MariaDB read replicas](USER_MariaDB.Replication.ReadReplicas.md) -+ [Configuring GTID\-based replication with an external source instance](MariaDB.Procedural.Replication.GTID.md) -+ [Configuring binary log file position replication with an external source instance](MySQL.Procedural.Importing.External.ReplMariaDB.md) \ No newline at end of file diff --git a/doc_source/USER_Migrate_MariaDB.md b/doc_source/USER_Migrate_MariaDB.md deleted file mode 100644 index 4f42e52..0000000 --- a/doc_source/USER_Migrate_MariaDB.md +++ /dev/null @@ -1,75 +0,0 @@ -# Migrating data from a MySQL DB snapshot to a MariaDB DB instance - -You can migrate an RDS for MySQL DB snapshot to a new DB instance running MariaDB using the AWS Management Console, the AWS CLI, or Amazon RDS API\. You must use a DB snapshot that was created from an Amazon RDS DB instance running MySQL 5\.6 or 5\.7\. To learn how to create an RDS for MySQL DB snapshot, see [Creating a DB snapshot](USER_CreateSnapshot.md)\. - -Migrating the snapshot doesn't affect the original DB instance from which the snapshot was taken\. You can test and validate the new DB instance before diverting traffic to it as a replacement for the original DB instance\. - -After you migrate from MySQL to MariaDB, the MariaDB DB instance is associated with the default DB parameter group and option group\. After you restore the DB snapshot, you can associate a custom DB parameter group with the new DB instance\. However, a MariaDB parameter group has a different set of configurable system variables\. For information about the differences between MySQL and MariaDB system variables, see [ System Variable Differences between MariaDB and MySQL](https://mariadb.com/kb/en/system-variable-differences-between-mariadb-and-mysql/)\. To learn about DB parameter groups, see [Working with parameter groups](USER_WorkingWithParamGroups.md)\. To learn about option groups, see [Working with option groups](USER_WorkingWithOptionGroups.md)\. - -## Performing the migration - -You can migrate an RDS for MySQL DB snapshot to a new MariaDB DB instance using the AWS Management Console, the AWS CLI, or the RDS API\. - -### Console - -**To migrate a MySQL DB snapshot to a MariaDB DB instance** - -1. Sign in to the AWS Management Console and open the Amazon RDS console at [https://console\.aws\.amazon\.com/rds/](https://console.aws.amazon.com/rds/)\. - -1. In the navigation pane, choose **Snapshots**, and then select the MySQL DB snapshot you want to migrate\. - -1. For **Actions**, choose **Migrate snapshot**\. The **Migrate database** page appears\. - -1. For **Migrate to DB Engine**, choose **mariadb**\. - - Amazon RDS selects the **DB engine version** automatically\. You can't change the DB engine version\. -![\[Migrate to MariaDB from MySQL\]](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/images/MigrateMariaDB.png) - -1. For the remaining sections, specify your DB instance settings\. For information about each setting, see [Settings for DB instances](USER_CreateDBInstance.md#USER_CreateDBInstance.Settings)\. - -1. Choose **Migrate**\. - -### AWS CLI - -To migrate data from a MySQL DB snapshot to a MariaDB DB instance, use the AWS CLI [https://docs.aws.amazon.com/cli/latest/reference/rds/restore-db-instance-from-db-snapshot.html](https://docs.aws.amazon.com/cli/latest/reference/rds/restore-db-instance-from-db-snapshot.html) command with the following parameters: -+ \-\-db\-instance\-identifier – Name of the DB instance to create from the DB snapshot\. -+ \-\-db\-snapshot\-identifier – The identifier for the DB snapshot to restore from\. -+ \-\-engine – The database engine to use for the new instance\. - -**Example** -For Linux, macOS, or Unix: - -``` -1. aws rds restore-db-instance-from-db-snapshot \ -2. --db-instance-identifier newmariadbinstance \ -3. --db-snapshot-identifier mysqlsnapshot \ -4. --engine mariadb -``` -For Windows: - -``` -1. aws rds restore-db-instance-from-db-snapshot ^ -2. --db-instance-identifier newmariadbinstance ^ -3. --db-snapshot-identifier mysqlsnapshot ^ -4. --engine mariadb -``` - -### API - -To migrate data from a MySQL DB snapshot to a MariaDB DB instance, call the Amazon RDS API operation [https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_RestoreDBInstanceFromDBSnapshot.html](https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_RestoreDBInstanceFromDBSnapshot.html)\. - -## Incompatibilities between MariaDB and MySQL - -Incompatibilities between MySQL and MariaDB include the following: -+ You can't migrate a DB snapshot created with MySQL 8\.0 to MariaDB\. -+ If the source MySQL database uses a SHA256 password hash, make sure to reset user passwords that are SHA256 hashed before you connect to the MariaDB database\. The following code shows how to reset a password that is SHA256 hashed\. - - ``` - SET old_passwords = 0; - UPDATE mysql.user SET plugin = 'mysql_native_password', - Password = PASSWORD('new_password') - WHERE (User, Host) = ('master_user_name', %); - FLUSH PRIVILEGES; - ``` -+ If your RDS master user account uses the SHA\-256 password hash, make sure to reset the password using the AWS Management Console, the [https://docs.aws.amazon.com/cli/latest/reference/rds/modify-db-instance.html](https://docs.aws.amazon.com/cli/latest/reference/rds/modify-db-instance.html) AWS CLI command, or the [ModifyDBInstance](https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_ModifyDBInstance.html) RDS API operation\. For information about modifying a DB instance, see [Modifying an Amazon RDS DB instance](Overview.DBInstance.Modifying.md)\. -+ MariaDB doesn't support the Memcached plugin\. However, the data used by the Memcached plugin is stored as InnoDB tables\. After you migrate a MySQL DB snapshot, you can access the data used by the Memcached plugin using SQL\. For more information about the innodb\_memcache database, see [InnoDB memcached Plugin Internals](https://dev.mysql.com/doc/refman/8.0/en/innodb-memcached-internals.html)\. \ No newline at end of file diff --git a/doc_source/USER_ModifyInstance.MariaDB.md b/doc_source/USER_ModifyInstance.MariaDB.md deleted file mode 100644 index be3dd1c..0000000 --- a/doc_source/USER_ModifyInstance.MariaDB.md +++ /dev/null @@ -1,110 +0,0 @@ -# Modifying a DB Instance Running the MariaDB Database Engine - -You can change the settings of a DB instance to accomplish tasks such as adding additional storage or changing the DB instance class\. This topic guides you through modifying an Amazon RDS MariaDB DB instance, and describes the settings for MariaDB instances\. - -We recommend that you test any changes on a test instance before modifying a production instance, so that you fully understand the impact of each change\. This is especially important when upgrading database versions\. - -After you modify your DB instance settings, you can apply the changes immediately, or apply them during the next maintenance window for the DB instance\. Some modifications cause an interruption by restarting the DB instance\. - -## Console - -**To modify a MariaDB DB instance** - -1. Sign in to the AWS Management Console and open the Amazon RDS console at [https://console\.aws\.amazon\.com/rds/](https://console.aws.amazon.com/rds/)\. - -1. In the navigation pane, choose **Databases**, and then choose the DB instance that you want to modify\. - -1. Choose **Modify**\. The **Modify DB instance** page appears\. - -1. Change any of the settings that you want\. For information about each setting, see [Settings for MariaDB DB Instances](#USER_ModifyInstance.MariaDB.Settings)\. - -1. When all the changes are as you want them, choose **Continue** and check the summary of modifications\. - -1. To apply the changes immediately, choose **Apply immediately**\. Choosing this option can cause an outage in some cases\. For more information, see [Using the Apply Immediately Parameter](Overview.DBInstance.Modifying.md#USER_ModifyInstance.ApplyImmediately)\. - -1. On the confirmation page, review your changes\. If they are correct, choose **Modify DB Instance** to save your changes\. - - Alternatively, choose **Back** to edit your changes, or choose **Cancel** to cancel your changes\. - -## AWS CLI - -To modify a MariaDB DB instance by using the AWS CLI, call the [modify\-db\-instance](https://docs.aws.amazon.com/cli/latest/reference/rds/modify-db-instance.html) command\. Specify the DB instance identifier, and the parameters for the settings that you want to modify\. For information about each parameter, see [Settings for MariaDB DB Instances](#USER_ModifyInstance.MariaDB.Settings)\. - -**Example** -The following code modifies `mydbinstance` by setting the backup retention period to 1 week \(7 days\)\. The code enables automatic minor version upgrades by using `--auto-minor-version-upgrade`\. To disable automatic minor version upgrades, use `--no-auto-minor-version-upgrade`\. The changes are applied during the next maintenance window by using `--no-apply-immediately`\. Use `--apply-immediately` to apply the changes immediately\. For more information, see [Using the Apply Immediately Parameter](Overview.DBInstance.Modifying.md#USER_ModifyInstance.ApplyImmediately)\. -For Linux, OS X, or Unix: - -``` -aws rds modify-db-instance \ - --db-instance-identifier mydbinstance \ - --backup-retention-period 7 \ - --auto-minor-version-upgrade \ - --no-apply-immediately -``` -For Windows: - -``` -aws rds modify-db-instance ^ - --db-instance-identifier mydbinstance ^ - --backup-retention-period 7 ^ - --auto-minor-version-upgrade ^ - --no-apply-immediately -``` - -## RDS API - -To modify a MariaDB instance by using the Amazon RDS API, call the [ModifyDBInstance](https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_ModifyDBInstance.html) operation\. Specify the DB instance identifier, and the parameters for the settings that you want to modify\. For information about each parameter, see [Settings for MariaDB DB Instances](#USER_ModifyInstance.MariaDB.Settings)\. - -**Example** -The following code modifies `mydbinstance` by setting the backup retention period to 1 week \(7 days\) and enabling automatic minor version upgrades\. These changes are applied during the next maintenance window\. - -``` - 1. https://rds.amazonaws.com/ - 2. ?Action=ModifyDBInstance - 3. &ApplyImmediately=false - 4. &AutoMinorVersionUpgrade=true - 5. &BackupRetentionPeriod=7 - 6. &DBInstanceIdentifier=mydbinstance - 7. &SignatureMethod=HmacSHA256 - 8. &SignatureVersion=4 - 9. &Version=2014-10-31 -10. &X-Amz-Algorithm=AWS4-HMAC-SHA256 -11. &X-Amz-Credential=AKIADQKE4SARGYLE/20131016/us-west-1/rds/aws4_request -12. &X-Amz-Date=20131016T233051Z -13. &X-Amz-SignedHeaders=content-type;host;user-agent;x-amz-content-sha256;x-amz-date -14. &X-Amz-Signature=087a8eb41cb1ab0fc9ec1575f23e73757ffc6a1e42d7d2b30b9cc0be988cff97 -``` - -## Settings for MariaDB DB Instances - -The following table contains details about which settings you can modify, which settings you can't modify, when the changes can be applied, and whether the changes cause downtime for the DB instance\. - - -**** - -| Setting | Setting Description | When the Change Occurs | Downtime Notes | -| --- | --- | --- | --- | -| Allocated storage | The storage, in gigabytes, that you want to allocate for your DB instance\. You can't modify allocated storage if the DB instance status is **storage\-optimization** or if the allocated storage for the DB instance has been modified in the last six hours\. The maximum storage allowed depends on the storage type\. For more information, see [Amazon RDS DB Instance Storage](CHAP_Storage.md)\. | If **Apply immediately** is set to true, the change occurs immediately\. If **Apply immediately** is set to false, the change occurs during the next maintenance window\. | No downtime\. Performance might be degraded during the change\. | -| Auto minor version upgrade | **Enable auto minor version upgrade** to enable your DB instance to receive preferred minor DB engine version upgrades automatically when they become available\. Amazon RDS performs automatic minor version upgrades in the maintenance window\. | – | – | -| Backup retention period | The number of days that automatic backups are retained\. To disable automatic backups, set the backup retention period to 0\. For more information, see [Working With Backups](USER_WorkingWithAutomatedBackups.md)\. | If **Apply immediately** is set to true, the change occurs immediately\. If **Apply immediately** is set to false and you change the setting from a nonzero value to another nonzero value, the change is applied asynchronously, as soon as possible\. Otherwise, the change occurs during the next maintenance window\. | An outage occurs if you change from 0 to a nonzero value, or from a nonzero value to 0\. | -| Backup window | The time range during which automated backups of your databases occur\. The backup window is a start time in Universal Coordinated Time \(UTC\), and a duration in hours\. For more information, see [Working With Backups](USER_WorkingWithAutomatedBackups.md)\. | The change is applied asynchronously, as soon as possible\. | – | -| Certificate authority | The certificate that you want to use\. | If **Apply Immediately** is set to true, the change occurs immediately\. If **Apply Immediately** is set to false, the change occurs during the next maintenance window\. | An outage occurs during this change\. | -| Copy tags to snapshots | If you have any DB instance tags, this option copies them when you create a DB snapshot\. For more information, see [Tagging Amazon RDS Resources](USER_Tagging.md)\. | The change occurs immediately\. This setting ignores the **Apply immediately** setting\. | – | -| Database port | The port that you want to use to access the database\. The port value must not match any of the port values specified for options in the option group for the DB instance\. | The change occurs immediately\. This setting ignores the **Apply immediately** setting\. | The DB instance is rebooted immediately\. | -| DB engine version | The version of the MariaDB database engine that you want to use\. Before you upgrade your production DB instances, we recommend that you test the upgrade process on a test instance to verify its duration and to validate your applications\. For more information, see [Upgrading the MariaDB DB Engine](USER_UpgradeDBInstance.MariaDB.md)\. | If **Apply immediately** is set to true, the change occurs immediately\. If **Apply immediately** is set to false, the change occurs during the next maintenance window\. | An outage occurs during this change\. | -| DB instance class | The DB instance class that you want to use\. For more information, see [Choosing the DB Instance Class](Concepts.DBInstanceClass.md)\. | If **Apply immediately** is set to true, the change occurs immediately\. If **Apply immediately** is set to false, the change occurs during the next maintenance window\. | An outage occurs during this change\. | -| DB instance identifier | The DB instance identifier\. This value is stored as a lowercase string\. For more information about the effects of renaming a DB instance, see [Renaming a DB Instance](USER_RenameInstance.md)\. | If **Apply immediately** is set to true, the change occurs immediately\. If **Apply immediately** is set to false, the change occurs during the next maintenance window\. | An outage occurs during this change\. The DB instance is rebooted\. | -| DB parameter group | The parameter group that you want associated with the DB instance\. For more information, see [Working with DB Parameter Groups](USER_WorkingWithParamGroups.md)\. | The parameter group change occurs immediately\. | An outage doesn't occur during this change\. When you change the parameter group, changes to some parameters are applied to the DB instance immediately without a reboot\. Changes to other parameters are applied only after the DB instance is rebooted\. For more information, see [Rebooting a DB Instance](USER_RebootInstance.md)\. | -| Deletion protection | **Enable deletion protection** to prevent your DB instance from being deleted\. For more information, see [Deleting a DB Instance](USER_DeleteInstance.md)\. | – | – | -| Enhanced Monitoring | **Enable enhanced monitoring** to enable gathering metrics in real time for the operating system that your DB instance runs on\. For more information, see [Enhanced Monitoring](USER_Monitoring.OS.md)\. | – | – | -| Log exports | The types of MariaDB database log files to publish to Amazon CloudWatch Logs\. For more information, see [MariaDB Database Log Files](USER_LogAccess.Concepts.MariaDB.md)\. | The change occurs immediately\. This setting ignores the **Apply immediately** setting\. | – | -| Maintenance window | The time range during which system maintenance occurs\. System maintenance includes upgrades, if applicable\. The maintenance window is a start time in Universal Coordinated Time \(UTC\), and a duration in hours\. If you set the window to the current time, there must be at least 30 minutes between the current time and end of the window to ensure any pending changes are applied\. For more information, see [The Amazon RDS Maintenance Window](USER_UpgradeDBInstance.Maintenance.md#Concepts.DBMaintenance)\. | The change occurs immediately\. This setting ignores the **Apply immediately** setting\. | If there are one or more pending actions that cause an outage, and the maintenance window is changed to include the current time, then those pending actions are applied immediately, and an outage occurs\. | -| Multi\-AZ deployment | **Yes** to deploy your DB instance in multiple Availability Zones\. Otherwise, **No**\. For more information, see [Regions and Availability Zones](Concepts.RegionsAndAvailabilityZones.md)\. | If **Apply immediately** is set to true, the change occurs immediately\. If **Apply immediately** is set to false, the change occurs during the next maintenance window\. | – | -| New master password | The password for your master user\. The password must contain from 8 to 41 alphanumeric characters\. | The change is applied asynchronously, as soon as possible\. This setting ignores the **Apply immediately** setting\. | – | -| Option group | The option group that you want associated with the DB instance\. For more information, see [Working with Option Groups](USER_WorkingWithOptionGroups.md)\. | If **Apply immediately** is set to true, the change occurs immediately\. If **Apply immediately** is set to false, the change occurs during the next maintenance window\. | – | -| Performance Insights | **Enable Performance Insights** to monitor your DB instance load so that you can analyze and troubleshoot your database performance\. Choose a retention period to determine how much rolling data history to retain\. The default of seven days is in the free tier\. Long\-term retention \(two years\) is priced per vCPU per month\. You can't change the master key after the database is created\. For more information, see [Using Amazon RDS Performance Insights](USER_PerfInsights.md)\. | The change occurs immediately\. This setting ignores the **Apply immediately** setting\. | – | -| Public accessibility | **Yes** to give the DB instance a public IP address, meaning that it's accessible outside the VPC\. To be publicly accessible, the DB instance also has to be in a public subnet in the VPC\. **No** to make the DB instance accessible only from inside the VPC\. For more information, see [Hiding a DB Instance in a VPC from the Internet](USER_VPC.WorkingWithRDSInstanceinaVPC.md#USER_VPC.Hiding)\. | The change occurs immediately\. This setting ignores the **Apply immediately** setting\. | – | -| Security group | The security group that you want associated with the DB instance\. For more information, see [Working with DB Security Groups \(EC2\-Classic Platform\)](USER_WorkingWithSecurityGroups.md)\. | The change is applied asynchronously, as soon as possible\. This setting ignores the **Apply immediately** setting\. | – | -| Storage autoscaling | **Enable storage autoscaling** to enable Amazon RDS to automatically increase storage when needed to avoid having your DB instance run out of storage space\. Use **Maximum storage threshold** to set the upper limit for Amazon RDS to automatically increase storage for your DB instance\. The default is 1,000 GiB\. For more information, see [Managing Capacity Automatically with Amazon RDS Storage Autoscaling](USER_PIOPS.StorageTypes.md#USER_PIOPS.Autoscaling)\. | The change occurs immediately\. This setting ignores the **Apply immediately** setting\. | – | -| Storage type | The storage type that you want to use\. For more information, see [Amazon RDS Storage Types](CHAP_Storage.md#Concepts.Storage)\. | If **Apply immediately** is set to true, the change occurs immediately\. If **Apply immediately** is set to false, the change occurs during the next maintenance window\. | The following changes all result in a brief outage while the process starts\. After that, you can use your database normally while the change takes place\. [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_ModifyInstance.MariaDB.html) | -| Subnet group | The subnet group for the DB instance\. You can use this setting to move your DB instance to a different VPC\. If your DB instance isn't in a VPC, you can use this setting to move your DB instance into a VPC\. For more information, see [Moving a DB Instance Not in a VPC into a VPC](USER_VPC.md#USER_VPC.Non-VPC2VPC)\. | If **Apply Immediately** is set to true, the change occurs immediately\. If **Apply Immediately** is set to false, the change occurs during the next maintenance window\. | An outage occurs during this change\. The DB instance is rebooted\. | \ No newline at end of file diff --git a/doc_source/USER_ModifyInstance.MySQL.md b/doc_source/USER_ModifyInstance.MySQL.md deleted file mode 100644 index 3ff7a0e..0000000 --- a/doc_source/USER_ModifyInstance.MySQL.md +++ /dev/null @@ -1,116 +0,0 @@ -# Modifying a DB Instance Running the MySQL Database Engine - -You can change the settings of a DB instance to accomplish tasks such as adding additional storage or changing the DB instance class\. This topic guides you through modifying an Amazon RDS MySQL DB instance, and describes the settings for MySQL instances\. - -We recommend that you test any changes on a test instance before modifying a production instance, so that you fully understand the impact of each change\. This is especially important when upgrading database versions\. - -After you modify your DB instance settings, you can apply the changes immediately, or apply them during the next maintenance window for the DB instance\. Some modifications cause an interruption by restarting the DB instance\. - -**Note** -When you modify a DB instance, Amazon RDS will reboot the instance if both of the following are true: -You change the DB instance class\. -You specify a custom parameter group\. - -## Console - -**To modify a MySQL DB instance** - -1. Sign in to the AWS Management Console and open the Amazon RDS console at [https://console\.aws\.amazon\.com/rds/](https://console.aws.amazon.com/rds/)\. - -1. In the navigation pane, choose **Databases**, and then choose the DB instance that you want to modify\. - -1. Choose **Modify**\. The **Modify DB Instance** page appears\. - -1. Change any of the settings that you want\. For information about each setting, see [Settings for MySQL DB Instances](#USER_ModifyInstance.MySQL.Settings)\. - -1. When all the changes are as you want them, choose **Continue** and check the summary of modifications\. - -1. To apply the changes immediately, choose **Apply immediately**\. Choosing this option can cause an outage in some cases\. For more information, see [Using the Apply Immediately Parameter](Overview.DBInstance.Modifying.md#USER_ModifyInstance.ApplyImmediately)\. - -1. On the confirmation page, review your changes\. If they are correct, choose **Modify DB Instance** to save your changes\. - - Alternatively, choose **Back** to edit your changes, or choose **Cancel** to cancel your changes\. - -## AWS CLI - -To modify a MySQL DB instance by using the AWS CLI, call the [modify\-db\-instance](https://docs.aws.amazon.com/cli/latest/reference/rds/modify-db-instance.html) command\. Specify the DB instance identifier, and the parameters for the settings that you want to modify\. For information about each parameter, see [Settings for MySQL DB Instances](#USER_ModifyInstance.MySQL.Settings)\. - -**Example** -The following code modifies `mydbinstance` by setting the backup retention period to 1 week \(7 days\)\. The code enables automatic minor version upgrades by using `--auto-minor-version-upgrade`\. To disable automatic minor version upgrades, use `--no-auto-minor-version-upgrade`\. The changes are applied during the next maintenance window by using `--no-apply-immediately`\. Use `--apply-immediately` to apply the changes immediately\. For more information, see [Using the Apply Immediately Parameter](Overview.DBInstance.Modifying.md#USER_ModifyInstance.ApplyImmediately)\. -For Linux, OS X, or Unix: - -``` -aws rds modify-db-instance \ - --db-instance-identifier mydbinstance \ - --backup-retention-period 7 \ - --auto-minor-version-upgrade \ - --no-apply-immediately -``` -For Windows: - -``` -aws rds modify-db-instance ^ - --db-instance-identifier mydbinstance ^ - --backup-retention-period 7 ^ - --auto-minor-version-upgrade ^ - --no-apply-immediately -``` - -## RDS API - -To modify a MySQL instance by using the Amazon RDS API, call the [ModifyDBInstance](https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_ModifyDBInstance.html) operation\. Specify the DB instance identifier, and the parameters for the settings that you want to modify\. For information about each parameter, see [Settings for MySQL DB Instances](#USER_ModifyInstance.MySQL.Settings)\. - -**Example** -The following code modifies `mydbinstance` by setting the backup retention period to 1 week \(7 days\) and enabling automatic minor version upgrades\. These changes are applied during the next maintenance window\. - -``` - 1. https://rds.amazonaws.com/ - 2. ?Action=ModifyDBInstance - 3. &ApplyImmediately=false - 4. &AutoMinorVersionUpgrade=true - 5. &BackupRetentionPeriod=7 - 6. &DBInstanceIdentifier=mydbinstance - 7. &SignatureMethod=HmacSHA256 - 8. &SignatureVersion=4 - 9. &Version=2014-10-31 -10. &X-Amz-Algorithm=AWS4-HMAC-SHA256 -11. &X-Amz-Credential=AKIADQKE4SARGYLE/20131016/us-west-1/rds/aws4_request -12. &X-Amz-Date=20131016T233051Z -13. &X-Amz-SignedHeaders=content-type;host;user-agent;x-amz-content-sha256;x-amz-date -14. &X-Amz-Signature=087a8eb41cb1ab0fc9ec1575f23e73757ffc6a1e42d7d2b30b9cc0be988cff97 -``` - -## Settings for MySQL DB Instances - -The following table contains details about which settings you can modify, which settings you can't modify, when the changes can be applied, and whether the changes cause downtime for the DB instance\. - - -**** - -| Setting | Setting Description | When the Change Occurs | Downtime Notes | -| --- | --- | --- | --- | -| Allocated storage | The storage, in gigabytes, that you want to allocate for your DB instance\. For more information, see [Amazon RDS DB Instance Storage](CHAP_Storage.md)\. | If **Apply immediately** is set to true, the change occurs immediately\. If **Apply immediately** is set to false, the change occurs during the next maintenance window\. | No downtime\. Performance might be degraded during the change\. | -| Auto minor version upgrade | **Enable auto minor version upgrade** to enable your DB instance to receive preferred minor DB engine version upgrades automatically when they become available\. Amazon RDS performs automatic minor version upgrades in the maintenance window\. | – | – | -| Backup retention period | The number of days that automatic backups are retained\. To disable automatic backups, set the backup retention period to 0\. For more information, see [Working With Backups](USER_WorkingWithAutomatedBackups.md)\. | If **Apply immediately** is set to true, the change occurs immediately\. If **Apply immediately** is set to false and you change the setting from a nonzero value to another nonzero value, the change is applied asynchronously, as soon as possible\. Otherwise, the change occurs during the next maintenance window\. | An outage occurs if you change from 0 to a nonzero value, or from a nonzero value to 0\. | -| Backup window | The time range during which automated backups of your databases occur\. The backup window is a start time in Universal Coordinated Time \(UTC\), and a duration in hours\. For more information, see [Working With Backups](USER_WorkingWithAutomatedBackups.md)\. | The change is applied asynchronously, as soon as possible\. | – | -| Certificate authority | The certificate that you want to use\. | If **Apply Immediately** is set to true, the change occurs immediately\. If **Apply Immediately** is set to false, the change occurs during the next maintenance window\. | An outage occurs during this change\. | -| Copy tags to snapshots | If you have any DB instance tags, this option copies them when you create a DB snapshot\. For more information, see [Tagging Amazon RDS Resources](USER_Tagging.md)\. | The change occurs immediately\. This setting ignores the **Apply immediately** setting\. | – | -| Database authentication | The database authentication option you want to use\. Choose **Password authentication** to authenticate database users with database passwords only\. Choose **Password and IAM DB authentication** to authenticate database users with database passwords and user credentials through IAM users and roles\. For more information, see [IAM Database Authentication for MySQL and PostgreSQL](UsingWithRDS.IAMDBAuth.md)\. | If **Apply immediately** is set to true, the change occurs immediately\. If **Apply immediately** is set to false, the change occurs during the next maintenance window\. | – | -| Database port | The port that you want to use to access the database\. The port value must not match any of the port values specified for options in the option group for the DB instance\. | The change occurs immediately\. This setting ignores the **Apply immediately** setting\. | The DB instance is rebooted immediately\. | -| DB engine version | The version of the MySQL database engine that you want to use\. Before you upgrade your production DB instances, we recommend that you test the upgrade process on a test instance to verify its duration and to validate your applications\. For more information, see [Upgrading the MySQL DB Engine](USER_UpgradeDBInstance.MySQL.md)\. | If **Apply immediately** is set to true, the change occurs immediately\. If **Apply immediately** is set to false, the change occurs during the next maintenance window\. | An outage occurs during this change\. | -| DB instance class | The DB instance class that you want to use\. For more information, see [Choosing the DB Instance Class](Concepts.DBInstanceClass.md)\. MySQL DB instances created after April 23, 2014, can change to a different DB instance class by modifying the DB instance just as with any other modification\. MySQL DB instances running MySQL version 5\.5 and created before April 23, 2014, must first upgrade to MySQL version 5\.6\. For more information, see [Upgrading the MySQL DB Engine](USER_UpgradeDBInstance.MySQL.md)\. | If **Apply immediately** is set to true, the change occurs immediately\. If **Apply immediately** is set to false, the change occurs during the next maintenance window\. | An outage occurs during this change\. | -| DB instance identifier | The DB instance identifier\. This value is stored as a lowercase string\. For more information about the effects of renaming a DB instance, see [Renaming a DB Instance](USER_RenameInstance.md)\. | If **Apply immediately** is set to true, the change occurs immediately\. If **Apply immediately** is set to false, the change occurs during the next maintenance window\. | An outage occurs during this change\. The DB instance is rebooted\. | -| DB parameter group | The parameter group that you want associated with the DB instance\. For more information, see [Working with DB Parameter Groups](USER_WorkingWithParamGroups.md)\. | The parameter group change occurs immediately\. | An outage doesn't occur during this change\. When you change the parameter group, changes to some parameters are applied to the DB instance immediately without a reboot\. Changes to other parameters are applied only after the DB instance is rebooted\. For more information, see [Rebooting a DB Instance](USER_RebootInstance.md)\. | -| Deletion protection | **Enable deletion protection** to prevent your DB instance from being deleted\. For more information, see [Deleting a DB Instance](USER_DeleteInstance.md)\. | – | – | -| Enhanced Monitoring | **Enable Enhanced Monitoring** to enable gathering metrics in real time for the operating system that your DB instance runs on\. For more information, see [Enhanced Monitoring](USER_Monitoring.OS.md)\. | – | – | -| Log exports | The types of MySQL database log files to publish to Amazon CloudWatch Logs\. For more information, see [MySQL Database Log Files](USER_LogAccess.Concepts.MySQL.md)\. | The change occurs immediately\. This setting ignores the **Apply immediately** setting\. | – | -| Maintenance window | The time range during which system maintenance occurs\. System maintenance includes upgrades, if applicable\. The maintenance window is a start time in Universal Coordinated Time \(UTC\), and a duration in hours\. If you set the window to the current time, there must be at least 30 minutes between the current time and end of the window to ensure any pending changes are applied\. For more information, see [The Amazon RDS Maintenance Window](USER_UpgradeDBInstance.Maintenance.md#Concepts.DBMaintenance)\. | The change occurs immediately\. This setting ignores the **Apply immediately** setting\. | If there are one or more pending actions that cause an outage, and the maintenance window is changed to include the current time, then those pending actions are applied immediately, and an outage occurs\. | -| Multi\-AZ deployment | **Yes** to deploy your DB instance in multiple Availability Zones\. Otherwise, **No**\. For more information, see [Regions and Availability Zones](Concepts.RegionsAndAvailabilityZones.md)\. | If **Apply immediately** is set to true, the change occurs immediately\. If **Apply immediately** is set to false, the change occurs during the next maintenance window\. | – | -| New master password | The password for your master user\. The password must contain from 8 to 41 alphanumeric characters\. | The change is applied asynchronously, as soon as possible\. This setting ignores the **Apply immediately** setting\. | – | -| Option group | The option group that you want associated with the DB instance\. For more information, see [Working with Option Groups](USER_WorkingWithOptionGroups.md)\. | If **Apply immediately** is set to true, the change occurs immediately\. If **Apply immediately** is set to false, the change occurs during the next maintenance window\. | – | -| Performance Insights | **Enable Performance Insights** to monitor your DB instance load so that you can analyze and troubleshoot your database performance\. Choose a retention period to determine how much rolling data history to keep\. The default of seven days is in the free tier\. Long\-term retention \(two years\) is priced per vCPU per month\. You can't change the master key after the database is created\. For more information, see [Using Amazon RDS Performance Insights](USER_PerfInsights.md)\. | The change occurs immediately\. This setting ignores the **Apply immediately** setting\. | – | -| Public accessibility | **Yes** to give the DB instance a public IP address, meaning that it's accessible outside the VPC\. To be publicly accessible, the DB instance also has to be in a public subnet in the VPC\. **No** to make the DB instance accessible only from inside the VPC\. For more information, see [Hiding a DB Instance in a VPC from the Internet](USER_VPC.WorkingWithRDSInstanceinaVPC.md#USER_VPC.Hiding)\. | The change occurs immediately\. This setting ignores the **Apply immediately** setting\. | – | -| Security group | The security group that you want associated with the DB instance\. For more information, see [Working with DB Security Groups \(EC2\-Classic Platform\)](USER_WorkingWithSecurityGroups.md)\. | The change is applied asynchronously, as soon as possible\. This setting ignores the **Apply immediately** setting\. | – | -| Storage autoscaling | **Enable storage autoscaling** to enable Amazon RDS to automatically increase storage when needed to avoid having your DB instance run out of storage space\. Use **Maximum storage threshold** to set the upper limit for Amazon RDS to automatically increase storage for your DB instance\. The default is 1,000 GiB\. For more information, see [Managing Capacity Automatically with Amazon RDS Storage Autoscaling](USER_PIOPS.StorageTypes.md#USER_PIOPS.Autoscaling)\. | The change occurs immediately\. This setting ignores the **Apply immediately** setting\. | – | -| Storage type | The storage type that you want to use\. For more information, see [Amazon RDS Storage Types](CHAP_Storage.md#Concepts.Storage)\. | If **Apply immediately** is set to true, the change occurs immediately\. If **Apply immediately** is set to false, the change occurs during the next maintenance window\. | The following changes all result in a brief outage while the process starts\. After that, you can use your database normally while the change takes place\. [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_ModifyInstance.MySQL.html) | -| Subnet group | The subnet group for the DB instance\. You can use this setting to move your DB instance to a different VPC\. If your DB instance isn't in a VPC, you can use this setting to move your DB instance into a VPC\. For more information, see [Moving a DB Instance Not in a VPC into a VPC](USER_VPC.md#USER_VPC.Non-VPC2VPC)\. | If **Apply Immediately** is set to true, the change occurs immediately\. If **Apply Immediately** is set to false, the change occurs during the next maintenance window\. | An outage occurs during this change\. The DB instance is rebooted\. | \ No newline at end of file diff --git a/doc_source/USER_ModifyInstance.Oracle.md b/doc_source/USER_ModifyInstance.Oracle.md deleted file mode 100644 index b6b5417..0000000 --- a/doc_source/USER_ModifyInstance.Oracle.md +++ /dev/null @@ -1,197 +0,0 @@ -# Modifying a DB Instance Running the Oracle Database Engine - -You can change the settings of a DB instance to accomplish tasks such as adding additional storage or changing the DB instance class\. In this topic, you learn how to modify an Amazon RDS Oracle DB instance, and about the settings for Oracle instances\. We recommend that you test any changes on a test instance before modifying a production instance, so that you fully understand the impact of each change\. This practice is especially important when upgrading database versions\. - -After you modify your DB instance settings, you can apply the changes immediately, or apply them during the next maintenance window for the DB instance\. Some modifications cause an interruption by restarting the DB instance\. - -In addition to modifying Oracle instances as described directly following, you can also change settings for sqlnet\.ora parameters for an Oracle DB instance as described in [Modifying Oracle sqlnet\.ora Parameters](#USER_ModifyInstance.Oracle.sqlnet), at the end of this topic\. - -## Console - -**To modify an Oracle DB instance** - -1. Sign in to the AWS Management Console and open the Amazon RDS console at [https://console\.aws\.amazon\.com/rds/](https://console.aws.amazon.com/rds/)\. - -1. In the navigation pane, choose **Databases**, and then choose the DB instance that you want to modify\. - -1. Choose **Modify**\. The **Modify DB Instance** page appears\. - -1. Change any of the settings that you want\. For information about each setting, see [Settings for Oracle DB Instances](#USER_ModifyInstance.Oracle.Settings)\. - -1. When all the changes are as you want them, choose **Continue** and check the summary of modifications\. - -1. To apply the changes immediately, choose **Apply immediately**\. Choosing this option can cause an outage in some cases\. For more information, see [Using the Apply Immediately Parameter](Overview.DBInstance.Modifying.md#USER_ModifyInstance.ApplyImmediately)\. - -1. On the confirmation page, review your changes\. If they are correct, choose **Modify DB Instance** to save your changes\. - - Alternatively, choose **Back** to edit your changes, or choose **Cancel** to cancel your changes\. - -## AWS CLI - -To modify an Oracle DB instance by using the AWS CLI, call the [modify\-db\-instance](https://docs.aws.amazon.com/cli/latest/reference/rds/modify-db-instance.html) command\. Specify the DB instance identifier, and the parameters for the settings that you want to modify\. For information about each parameter, see [Settings for Oracle DB Instances](#USER_ModifyInstance.Oracle.Settings)\. - -**Example** -The following code modifies `mydbinstance` by setting the backup retention period to 1 week \(7 days\)\. The code enables automatic minor version upgrades by using `--auto-minor-version-upgrade`\. To disable automatic minor version upgrades, use `--no-auto-minor-version-upgrade`\. The changes are applied during the next maintenance window by using `--no-apply-immediately`\. Use `--apply-immediately` to apply the changes immediately\. For more information, see [Using the Apply Immediately Parameter](Overview.DBInstance.Modifying.md#USER_ModifyInstance.ApplyImmediately)\. -For Linux, OS X, or Unix: - -``` -aws rds modify-db-instance \ - --db-instance-identifier mydbinstance \ - --backup-retention-period 7 \ - --auto-minor-version-upgrade \ - --no-apply-immediately -``` -For Windows: - -``` -aws rds modify-db-instance ^ - --db-instance-identifier mydbinstance ^ - --backup-retention-period 7 ^ - --auto-minor-version-upgrade ^ - --no-apply-immediately -``` - -## RDS API - -To modify an Oracle DB instance by using the Amazon RDS API, call the [ModifyDBInstance](https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_ModifyDBInstance.html) operation\. Specify the DB instance identifier, and the parameters for the settings that you want to modify\. For information about each parameter, see [Settings for Oracle DB Instances](#USER_ModifyInstance.Oracle.Settings)\. - -**Example** -The following code modifies `mydbinstance` by setting the backup retention period to 1 week \(7 days\) and enabling automatic minor version upgrades\. These changes are applied during the next maintenance window\. - -``` - 1. https://rds.amazonaws.com/ - 2. ?Action=ModifyDBInstance - 3. &ApplyImmediately=false - 4. &AutoMinorVersionUpgrade=true - 5. &BackupRetentionPeriod=7 - 6. &DBInstanceIdentifier=mydbinstance - 7. &SignatureMethod=HmacSHA256 - 8. &SignatureVersion=4 - 9. &Version=2014-10-31 -10. &X-Amz-Algorithm=AWS4-HMAC-SHA256 -11. &X-Amz-Credential=AKIADQKE4SARGYLE/20131016/us-west-1/rds/aws4_request -12. &X-Amz-Date=20131016T233051Z -13. &X-Amz-SignedHeaders=content-type;host;user-agent;x-amz-content-sha256;x-amz-date -14. &X-Amz-Signature=087a8eb41cb1ab0fc9ec1575f23e73757ffc6a1e42d7d2b30b9cc0be988cff97 -``` - -## Settings for Oracle DB Instances - -The following table contains details about which settings you can modify, which settings you can't modify, when the changes can be applied, and whether the changes cause downtime for the DB instance\. - - -**** - -| Setting | Setting Description | When the Change Occurs | Downtime Notes | -| --- | --- | --- | --- | -| Allocated storage | The storage, in gigabytes, that you want to allocate for your DB instance\. You can only increase the allocated storage, you can't reduce the allocated storage\. You can't modify allocated storage if the DB instance status is **storage\-optimization** or if the allocated storage for the DB instance has been modified in the last six hours\. The maximum storage allowed depends on the storage type\. For more information, see [Amazon RDS DB Instance Storage](CHAP_Storage.md)\. | If **Apply immediately** is set to true, the change occurs immediately\. If **Apply immediately** is set to false, the change occurs during the next maintenance window\. | No downtime\. Performance might be degraded during the change\. | -| Auto minor version upgrade | **Enable auto minor version upgrade** to enable your DB instance to receive preferred minor DB engine version upgrades automatically when they become available\. Amazon RDS performs automatic minor version upgrades in the maintenance window\. | – | – | -| Backup retention period | The number of days that automatic backups are retained\. To disable automatic backups, set the backup retention period to 0\. For more information, see [Working With Backups](USER_WorkingWithAutomatedBackups.md)\. | If **Apply immediately** is set to true, the change occurs immediately\. If **Apply immediately** is set to false and you change the setting from a nonzero value to another nonzero value, the change is applied asynchronously, as soon as possible\. Otherwise, the change occurs during the next maintenance window\. | An outage occurs if you change from 0 to a nonzero value, or from a nonzero value to 0\. | -| Backup window | The time range during which automated backups of your databases occur\. The backup window is a start time in Universal Coordinated Time \(UTC\), and a duration in hours\. For more information, see [Working With Backups](USER_WorkingWithAutomatedBackups.md)\. | The change is applied asynchronously, as soon as possible\. | – | -| Certificate authority | The certificate that you want to use\. | If **Apply Immediately** is set to true, the change occurs immediately\. If **Apply Immediately** is set to false, the change occurs during the next maintenance window\. | An outage occurs during this change\. | -| Copy tags to snapshots | If you have any DB instance tags, this option copies them when you create a DB snapshot\. For more information, see [Tagging Amazon RDS Resources](USER_Tagging.md)\. | The change occurs immediately\. This setting ignores the **Apply immediately** setting\. | – | -| Database authentication | The database authentication option you want to use\. Choose **Password authentication** to authenticate database users with database passwords only\. Choose **Password and Kerberos authentication** to authenticate database users with database passwords and Kerberos authentication through an AWS Managed Microsoft AD created with AWS Directory Service\. Next, choose the directory or choose **Create a new Directory**\. For more information, see [Using Kerberos Authentication with Amazon RDS for Oracle](oracle-kerberos.md)\. | If **Apply immediately** is set to true, the change occurs immediately\. If **Apply immediately** is set to false, the change occurs during the next maintenance window\. | When you enable **Password and Kerberos authentication**, a brief outage occurs\. | -| Database port | The port that you want to use to access the database\. The port value must not match any of the port values specified for options in the option group for the DB instance\. | The change occurs immediately\. This setting ignores the **Apply immediately** setting\. | The DB instance is rebooted immediately\. | -| DB engine version | The version of the Oracle database engine that you want to use\. Before you upgrade your production DB instances, we recommend that you test the upgrade process on a test instance to verify its duration and to validate your applications\. We do not recommend upgrading micro DB instances because they have limited CPU resources and the upgrade process may take hours to complete\. An alternative to upgrading micro DB instances with small storage \(10\-20 GiB\) is to copy your data using Data Pump, where we also recommend testing before migrating your production instances\. For more information, see [Upgrading the Oracle DB Engine](USER_UpgradeDBInstance.Oracle.md)\. | If **Apply immediately** is set to true, the change occurs immediately\. If **Apply immediately** is set to false, the change occurs during the next maintenance window\. | An outage occurs during this change\. | -| DB instance class | The DB instance class that you want to use\. For more information, see [Choosing the DB Instance Class](Concepts.DBInstanceClass.md) and [DB Instance Class Support for Oracle](CHAP_Oracle.md#Oracle.Concepts.InstanceClasses)\. | If **Apply immediately** is set to true, the change occurs immediately\. If **Apply immediately** is set to false, the change occurs during the next maintenance window\. | An outage occurs during this change\. | -| DB instance identifier | The DB instance identifier\. This value is stored as a lowercase string\. For more information about the effects of renaming a DB instance, see [Renaming a DB Instance](USER_RenameInstance.md)\. | If **Apply immediately** is set to true, the change occurs immediately\. If **Apply immediately** is set to false, the change occurs during the next maintenance window\. | An outage occurs during this change\. The DB instance is rebooted\. | -| DB parameter group | The parameter group that you want associated with the DB instance\. For more information, see [Working with DB Parameter Groups](USER_WorkingWithParamGroups.md) and [Modifying Oracle sqlnet\.ora Parameters](#USER_ModifyInstance.Oracle.sqlnet)\. | The parameter group change occurs immediately\. | An outage doesn't occur during this change\. When you change the parameter group, changes to some parameters are applied to the DB instance immediately without a reboot\. Changes to other parameters are applied only after the DB instance is rebooted\. For more information, see [Rebooting a DB Instance](USER_RebootInstance.md)\. | -| Deletion protection | **Enable deletion protection** to prevent your DB instance from being deleted\. For more information, see [Deleting a DB Instance](USER_DeleteInstance.md)\. | – | – | -| Enhanced Monitoring | **Enable enhanced monitoring** to enable gathering metrics in real time for the operating system that your DB instance runs on\. For more information, see [Enhanced Monitoring](USER_Monitoring.OS.md)\. | – | – | -| License model | **license\-included** to use the general license agreement for Oracle\. **bring\-your\-own\-license** to use your existing Oracle license\. For more information, see [Oracle Licensing](CHAP_Oracle.md#Oracle.Concepts.Licensing)\. | If **Apply immediately** is set to true, the change occurs immediately\. If **Apply immediately** is set to false, the change occurs during the next maintenance window\. | An outage occurs during this change\. | -| Log exports | The types of Oracle database log files to publish to Amazon CloudWatch Logs\. For more information, see [Oracle Database Log Files](USER_LogAccess.Concepts.Oracle.md)\. | The change occurs immediately\. This setting ignores the **Apply immediately** setting\. | – | -| Maintenance Window | The time range during which system maintenance occurs\. System maintenance includes upgrades, if applicable\. The maintenance window is a start time in Universal Coordinated Time \(UTC\), and a duration in hours\. If you set the window to the current time, there must be at least 30 minutes between the current time and end of the window to ensure any pending changes are applied\. For more information, see [The Amazon RDS Maintenance Window](USER_UpgradeDBInstance.Maintenance.md#Concepts.DBMaintenance)\. | The change occurs immediately\. This setting ignores the **Apply immediately** setting\. | If there are one or more pending actions that cause an outage, and the maintenance window is changed to include the current time, then those pending actions are applied immediately, and an outage occurs\. | -| Multi\-AZ deployment | **Yes** to deploy your DB instance in multiple Availability Zones\. Otherwise, **No**\. For more information, see [Regions and Availability Zones](Concepts.RegionsAndAvailabilityZones.md)\. | If **Apply immediately** is set to true, the change occurs immediately\. If **Apply immediately** is set to false, the change occurs during the next maintenance window\. | – | -| New master password | The password for your master user\. The password must contain from 8 to 30 alphanumeric characters\. | The change is applied asynchronously, as soon as possible\. This setting ignores the **Apply immediately** setting\. | – | -| Option group | The option group that you want associated with the DB instance\. For more information, see [Working with Option Groups](USER_WorkingWithOptionGroups.md)\. | If **Apply immediately** is set to true, the change occurs immediately\. If **Apply immediately** is set to false, the change occurs during the next maintenance window\. | When you add the APEX options to an existing DB instance, a brief outage occurs while your DB instance is automatically restarted\. When you add the OEM option to an existing DB instance, the change can cause a brief \(sub\-second\) period during which new connections are rejected\. Existing connections are not interrupted\. | -| Performance Insights | **Enable Performance Insights** to monitor your DB instance load so that you can analyze and troubleshoot your database performance\. Choose a retention period to determine how much rolling data history to keep\. The default of seven days is in the free tier\. Long\-term retention \(two years\) is priced per vCPU per month\. You can't change the master key after the database is created\. For more information, see [Using Amazon RDS Performance Insights](USER_PerfInsights.md)\. | The change occurs immediately\. This setting ignores the **Apply immediately** setting\. | – | -| Public accessibility | **Yes** to give the DB instance a public IP address, meaning that it's accessible outside the VPC\. To be publicly accessible, the DB instance also has to be in a public subnet in the VPC\. **No** to make the DB instance accessible only from inside the VPC\. For more information, see [Hiding a DB Instance in a VPC from the Internet](USER_VPC.WorkingWithRDSInstanceinaVPC.md#USER_VPC.Hiding)\. | The change occurs immediately\. This setting ignores the **Apply immediately** setting\. | – | -| Security group | The security group that you want associated with the DB instance\. For more information, see [Working with DB Security Groups \(EC2\-Classic Platform\)](USER_WorkingWithSecurityGroups.md)\. | The change is applied asynchronously, as soon as possible\. This setting ignores the **Apply immediately** setting\. | – | -| Storage autoscaling | **Enable storage autoscaling** to enable Amazon RDS to automatically increase storage when needed to avoid having your DB instance run out of storage space\. Use **Maximum storage threshold** to set the upper limit for Amazon RDS to automatically increase storage for your DB instance\. The default is 1,000 GiB\. For more information, see [Managing Capacity Automatically with Amazon RDS Storage Autoscaling](USER_PIOPS.StorageTypes.md#USER_PIOPS.Autoscaling)\. | The change occurs immediately\. This setting ignores the **Apply immediately** setting\. | – | -| Storage type | The storage type that you want to use\. For more information, see [Amazon RDS Storage Types](CHAP_Storage.md#Concepts.Storage)\. | If **Apply immediately** is set to true, the change occurs immediately\. If **Apply immediately** is set to false, the change occurs during the next maintenance window\. | The following changes all result in a brief outage while the process starts\. After that, you can use your database normally while the change takes place\. [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_ModifyInstance.Oracle.html) | -| Subnet group | The subnet group for the DB instance\. You can use this setting to move your DB instance to a different VPC\. If your DB instance isn't in a VPC, you can use this setting to move your DB instance into a VPC\. For more information, see [Moving a DB Instance Not in a VPC into a VPC](USER_VPC.md#USER_VPC.Non-VPC2VPC)\. | If **Apply Immediately** is set to true, the change occurs immediately\. If **Apply Immediately** is set to false, the change occurs during the next maintenance window\. | An outage occurs during this change\. The DB instance is rebooted\. | - -## Modifying Oracle sqlnet\.ora Parameters - -The sqlnet\.ora file includes parameters that configure Oracle Net features on Oracle database servers and clients\. Using the parameters in the sqlnet\.ora file, you can modify properties for connections in and out of the database\. - -For more information about why you might set sqlnet\.ora parameters, see [Configuring Profile Parameters](https://docs.oracle.com/database/121/NETAG/profile.htm#NETAG009) in the Oracle documentation\. - -### Setting sqlnet\.ora Parameters - -Amazon RDS Oracle parameter groups include a subset of sqlnet\.ora parameters\. You set them in the same way that you set other Oracle parameters\. The `sqlnetora.` prefix identifies which parameters are sqlnet\.ora parameters\. For example, in an Oracle parameter group in Amazon RDS, the `default_sdu_size` sqlnet\.ora parameter is `sqlnetora.default_sdu_size`\. - -For information about managing parameter groups and setting parameter values, see [Working with DB Parameter Groups](USER_WorkingWithParamGroups.md)\. - -### Supported sqlnet\.ora Parameters - -Amazon RDS supports the following sqlnet\.ora parameters\. Changes to dynamic sqlnet\.ora parameters take effect immediately\. - - -**** - -| Parameter | Valid Values | Static/Dynamic | Description | -| --- | --- | --- | --- | -| `sqlnetora.default_sdu_size` | Oracle 11g – `512` to `65535` Oracle 12c – `512` to `2097152` | Dynamic | The session data unit \(SDU\) size, in bytes\. The SDU is the amount of data that is put in a buffer and sent across the network at one time\. | -| `sqlnetora.diag_adr_enabled` | `ON`, `OFF` | Dynamic | A value that enables or disables Automatic Diagnostic Repository \(ADR\) tracing\. `ON` specifies that ADR file tracing is used\. `OFF` specifies that non\-ADR file tracing is used\. | -| `sqlnetora.recv_buf_size` | `8192` to `268435456` | Dynamic | The buffer space limit for receive operations of sessions, supported by the TCP/IP, TCP/IP with SSL, and SDP protocols\. | -| `sqlnetora.send_buf_size` | `8192` to `268435456` | Dynamic | The buffer space limit for send operations of sessions, supported by the TCP/IP, TCP/IP with SSL, and SDP protocols\. | -| `sqlnetora.sqlnet.allowed_logon_version_client` | `8`, `10`, `11`, `12` | Dynamic | Minimum authentication protocol version allowed for clients, and servers acting as clients, to establish a connection to Oracle DB instances\. | -| `sqlnetora.sqlnet.allowed_logon_version_server` | `8`, `9`, `10`, `11`, `12`, `12a` | Dynamic | Minimum authentication protocol version allowed to establish a connection to Oracle DB instances\. | -| `sqlnetora.sqlnet.expire_time` | `0` to `1440` | Dynamic | Time interval, in minutes, to send a check to verify that client\-server connections are active\. | -| `sqlnetora.sqlnet.inbound_connect_timeout` | `0` or `10` to `7200` | Dynamic | Time, in seconds, for a client to connect with the database server and provide the necessary authentication information\. | -| `sqlnetora.sqlnet.outbound_connect_timeout` | `0` or `10` to `7200` | Dynamic | Time, in seconds, for a client to establish an Oracle Net connection to the DB instance\. | -| `sqlnetora.sqlnet.recv_timeout` | `0` or `10` to `7200` | Dynamic | Time, in seconds, for a database server to wait for client data after establishing a connection\. | -| `sqlnetora.sqlnet.send_timeout` | `0` or `10` to `7200` | Dynamic | Time, in seconds, for a database server to complete a send operation to clients after establishing a connection\. | -| `sqlnetora.tcp.connect_timeout` | `0` or `10` to `7200` | Dynamic | Time, in seconds, for a client to establish a TCP connection to the database server\. | -| `sqlnetora.trace_level_server` | `0`, `4`, `10`, `16`, `OFF`, `USER`, `ADMIN`, `SUPPORT` | Dynamic | For non\-ADR tracing, turns server tracing on at a specified level or turns it off\. | - -The default value for each supported sqlnet\.ora parameter is the Oracle default for the release\. For information about default values for Oracle 12c, see [Parameters for the sqlnet\.ora File](https://docs.oracle.com/database/121/NETRF/sqlnet.htm#NETRF006) in the 12c Oracle documentation\. For information about default values for Oracle 11g, see [Parameters for the sqlnet\.ora File](https://docs.oracle.com/cd/E11882_01/network.112/e10835/sqlnet.htm#NETRF006) in the 11g Oracle documentation\. - -### Viewing sqlnet\.ora Parameters - -You can view sqlnet\.ora parameters and their settings using the AWS Management Console, the AWS CLI, or a SQL client\. - -#### Viewing sqlnet\.ora Parameters Using the Console - -For information about viewing parameters in a parameter group, see [Working with DB Parameter Groups](USER_WorkingWithParamGroups.md)\. - -In Oracle parameter groups, the `sqlnetora.` prefix identifies which parameters are sqlnet\.ora parameters\. - -#### Viewing sqlnet\.ora Parameters Using the AWS CLI - -To view the sqlnet\.ora parameters that were configured in an Oracle parameter group, use the AWS CLI [describe\-db\-parameters](https://docs.aws.amazon.com/cli/latest/reference/rds/describe-db-parameters.html) command\. - -To view the all of the sqlnet\.ora parameters for an Oracle DB instance, call the AWS CLI [download\-db\-log\-file\-portion](https://docs.aws.amazon.com/cli/latest/reference/rds/download-db-log-file-portion.html) command\. Specify the DB instance identifier, the log file name, and the type of output\. - -**Example** -The following code lists all of the sqlnet\.ora parameters for `mydbinstance`\. -For Linux, OS X, or Unix: - -``` -aws rds download-db-log-file-portion \ ---db-instance-identifier mydbinstance \ ---log-file-name trace/sqlnet-parameters \ ---output text -``` -For Windows: - -``` -aws rds download-db-log-file-portion ^ ---db-instance-identifier mydbinstance ^ ---log-file-name trace/sqlnet-parameters ^ ---output text -``` - -#### Viewing sqlnet\.ora Parameters Using a SQL Client - -After you connect to the Oracle DB instance in a SQL client, the following query lists the sqlnet\.ora parameters\. - -``` -1. SELECT * FROM TABLE -2. (rdsadmin.rds_file_util.read_text_file( -3. p_directory => 'BDUMP', -4. p_filename => 'sqlnet-parameters')); -``` - -For information about connecting to an Oracle DB instance in a SQL client, see [Connecting to a DB Instance Running the Oracle Database Engine](USER_ConnectToOracleInstance.md)\. \ No newline at end of file diff --git a/doc_source/USER_ModifyInstance.Oracle.sqlnet.md b/doc_source/USER_ModifyInstance.Oracle.sqlnet.md deleted file mode 100644 index 6c7ca0f..0000000 --- a/doc_source/USER_ModifyInstance.Oracle.sqlnet.md +++ /dev/null @@ -1,84 +0,0 @@ -# Modifying connection properties using sqlnet\.ora parameters - -The sqlnet\.ora file includes parameters that configure Oracle Net features on Oracle database servers and clients\. Using the parameters in the sqlnet\.ora file, you can modify properties for connections in and out of the database\. - -For more information about why you might set sqlnet\.ora parameters, see [Configuring profile parameters](https://docs.oracle.com/database/121/NETAG/profile.htm#NETAG009) in the Oracle documentation\. - -## Setting sqlnet\.ora parameters - -Amazon RDS for Oracle parameter groups include a subset of sqlnet\.ora parameters\. You set them in the same way that you set other Oracle parameters\. The `sqlnetora.` prefix identifies which parameters are sqlnet\.ora parameters\. For example, in an Oracle parameter group in Amazon RDS, the `default_sdu_size` sqlnet\.ora parameter is `sqlnetora.default_sdu_size`\. - -For information about managing parameter groups and setting parameter values, see [Working with parameter groups](USER_WorkingWithParamGroups.md)\. - -## Supported sqlnet\.ora parameters - -Amazon RDS supports the following sqlnet\.ora parameters\. Changes to dynamic sqlnet\.ora parameters take effect immediately\. - - -**** - -| Parameter | Valid values | Static/Dynamic | Description | -| --- | --- | --- | --- | -| `sqlnetora.default_sdu_size` | Oracle 12c – `512` to `2097152` | Dynamic | The session data unit \(SDU\) size, in bytes\. The SDU is the amount of data that is put in a buffer and sent across the network at one time\. | -| `sqlnetora.diag_adr_enabled` | `ON`, `OFF` | Dynamic | A value that enables or disables Automatic Diagnostic Repository \(ADR\) tracing\. `ON` specifies that ADR file tracing is used\. `OFF` specifies that non\-ADR file tracing is used\. | -| `sqlnetora.recv_buf_size` | `8192` to `268435456` | Dynamic | The buffer space limit for receive operations of sessions, supported by the TCP/IP, TCP/IP with SSL, and SDP protocols\. | -| `sqlnetora.send_buf_size` | `8192` to `268435456` | Dynamic | The buffer space limit for send operations of sessions, supported by the TCP/IP, TCP/IP with SSL, and SDP protocols\. | -| `sqlnetora.sqlnet.allowed_logon_version_client` | `8`, `10`, `11`, `12` | Dynamic | Minimum authentication protocol version allowed for clients, and servers acting as clients, to establish a connection to Oracle DB instances\. | -| `sqlnetora.sqlnet.allowed_logon_version_server` | `8`, `9`, `10`, `11`, `12`, `12a` | Dynamic | Minimum authentication protocol version allowed to establish a connection to Oracle DB instances\. | -| `sqlnetora.sqlnet.expire_time` | `0` to `1440` | Dynamic | Time interval, in minutes, to send a check to verify that client\-server connections are active\. | -| `sqlnetora.sqlnet.inbound_connect_timeout` | `0` or `10` to `7200` | Dynamic | Time, in seconds, for a client to connect with the database server and provide the necessary authentication information\. | -| `sqlnetora.sqlnet.outbound_connect_timeout` | `0` or `10` to `7200` | Dynamic | Time, in seconds, for a client to establish an Oracle Net connection to the DB instance\. | -| `sqlnetora.sqlnet.recv_timeout` | `0` or `10` to `7200` | Dynamic | Time, in seconds, for a database server to wait for client data after establishing a connection\. | -| `sqlnetora.sqlnet.send_timeout` | `0` or `10` to `7200` | Dynamic | Time, in seconds, for a database server to complete a send operation to clients after establishing a connection\. | -| `sqlnetora.tcp.connect_timeout` | `0` or `10` to `7200` | Dynamic | Time, in seconds, for a client to establish a TCP connection to the database server\. | -| `sqlnetora.trace_level_server` | `0`, `4`, `10`, `16`, `OFF`, `USER`, `ADMIN`, `SUPPORT` | Dynamic | For non\-ADR tracing, turns server tracing on at a specified level or turns it off\. | - -The default value for each supported sqlnet\.ora parameter is the Oracle default for the release\. For information about default values for Oracle Database 12c, see [Parameters for the sqlnet\.ora file](https://docs.oracle.com/database/121/NETRF/sqlnet.htm#NETRF006) in the Oracle Database 12c documentation\. - -## Viewing sqlnet\.ora parameters - -You can view sqlnet\.ora parameters and their settings using the AWS Management Console, the AWS CLI, or a SQL client\. - -### Viewing sqlnet\.ora parameters using the console - -For information about viewing parameters in a parameter group, see [Working with parameter groups](USER_WorkingWithParamGroups.md)\. - -In Oracle parameter groups, the `sqlnetora.` prefix identifies which parameters are sqlnet\.ora parameters\. - -### Viewing sqlnet\.ora parameters using the AWS CLI - -To view the sqlnet\.ora parameters that were configured in an Oracle parameter group, use the AWS CLI [describe\-db\-parameters](https://docs.aws.amazon.com/cli/latest/reference/rds/describe-db-parameters.html) command\. - -To view the all of the sqlnet\.ora parameters for an Oracle DB instance, call the AWS CLI [download\-db\-log\-file\-portion](https://docs.aws.amazon.com/cli/latest/reference/rds/download-db-log-file-portion.html) command\. Specify the DB instance identifier, the log file name, and the type of output\. - -**Example** -The following code lists all of the sqlnet\.ora parameters for `mydbinstance`\. -For Linux, macOS, or Unix: - -``` -aws rds download-db-log-file-portion \ - --db-instance-identifier mydbinstance \ - --log-file-name trace/sqlnet-parameters \ - --output text -``` -For Windows: - -``` -aws rds download-db-log-file-portion ^ - --db-instance-identifier mydbinstance ^ - --log-file-name trace/sqlnet-parameters ^ - --output text -``` - -### Viewing sqlnet\.ora parameters using a SQL client - -After you connect to the Oracle DB instance in a SQL client, the following query lists the sqlnet\.ora parameters\. - -``` -1. SELECT * FROM TABLE -2. (rdsadmin.rds_file_util.read_text_file( -3. p_directory => 'BDUMP', -4. p_filename => 'sqlnet-parameters')); -``` - -For information about connecting to an Oracle DB instance in a SQL client, see [Connecting to your RDS for Oracle DB instance](USER_ConnectToOracleInstance.md)\. \ No newline at end of file diff --git a/doc_source/USER_ModifyInstance.SQLServer.md b/doc_source/USER_ModifyInstance.SQLServer.md deleted file mode 100644 index 52757dd..0000000 --- a/doc_source/USER_ModifyInstance.SQLServer.md +++ /dev/null @@ -1,119 +0,0 @@ -# Modifying a DB Instance Running the Microsoft SQL Server Database Engine - -You can change the settings of a DB instance to accomplish tasks such as changing the instance class or renaming the instance\. This topic guides you through modifying an Amazon RDS DB instance running Microsoft SQL Server, and describes the settings for SQL Server DB instances\. - -We recommend that you test any changes on a test instance before modifying a production instance, so that you fully understand the impact of each change\. This is especially important when upgrading database versions\. - -After you modify your DB instance settings, you can apply the changes immediately, or apply them during the next maintenance window for the DB instance\. Some modifications cause an interruption by restarting the DB instance\. - -## Console - -**To modify an SQL Server DB instance** - -1. Sign in to the AWS Management Console and open the Amazon RDS console at [https://console\.aws\.amazon\.com/rds/](https://console.aws.amazon.com/rds/)\. - -1. In the navigation pane, choose **Databases**, and then choose the DB instance that you want to modify\. - -1. Choose **Modify**\. The **Modify DB Instance** page appears\. - -1. Change any of the settings that you want\. For information about each setting, see [Settings for Microsoft SQL Server DB Instances](#USER_ModifyInstance.SQLServer.Settings)\. - -1. When all the changes are as you want them, choose **Continue**\. - -1. To apply the changes immediately, choose **Apply Immediately**\. Choosing this option can cause an outage in some cases\. For more information, see [Using the Apply Immediately Parameter](Overview.DBInstance.Modifying.md#USER_ModifyInstance.ApplyImmediately)\. - -1. On the confirmation page, review your changes\. If they are correct, choose **Modify DB Instance** to save your changes\. - - Alternatively, choose **Back** to edit your changes, or choose **Cancel** to cancel your changes\. - -## AWS CLI - -To modify a Microsoft SQL Server DB instance by using the AWS CLI, call the [modify\-db\-instance](https://docs.aws.amazon.com/cli/latest/reference/rds/modify-db-instance.html) command\. Specify the DB instance identifier, and the parameters for the settings that you want to modify\. For information about each parameter, see [Settings for Microsoft SQL Server DB Instances](#USER_ModifyInstance.SQLServer.Settings)\. - -**Example** -The following code modifies `mydbinstance` by setting the backup retention period to 1 week \(7 days\)\. The code enables automatic minor version upgrades by using `--auto-minor-version-upgrade`\. To disable automatic minor version upgrades, use `--no-auto-minor-version-upgrade`\. The changes are applied during the next maintenance window by using `--no-apply-immediately`\. Use `--apply-immediately` to apply the changes immediately\. For more information, see [Using the Apply Immediately Parameter](Overview.DBInstance.Modifying.md#USER_ModifyInstance.ApplyImmediately)\. -For Linux, OS X, or Unix: - -``` -aws rds modify-db-instance \ - --db-instance-identifier mydbinstance \ - --backup-retention-period 7 \ - --auto-minor-version-upgrade \ - --no-apply-immediately -``` -For Windows: - -``` -aws rds modify-db-instance ^ - --db-instance-identifier mydbinstance ^ - --backup-retention-period 7 ^ - --auto-minor-version-upgrade ^ - --no-apply-immediately -``` - -## RDS API - -To modify a Microsoft SQL Server DB instance by using the Amazon RDS API, call the [ModifyDBInstance](https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_ModifyDBInstance.html) operation\. Specify the DB instance identifier, and the parameters for the settings that you want to modify\. For information about each parameter, see [Settings for Microsoft SQL Server DB Instances](#USER_ModifyInstance.SQLServer.Settings)\. - -**Example** -The following code modifies `mydbinstance` by setting the backup retention period to 1 week \(7 days\) and enabling automatic minor version upgrades\. These changes are applied during the next maintenance window\. - -``` - 1. https://rds.amazonaws.com/ - 2. ?Action=ModifyDBInstance - 3. &ApplyImmediately=false - 4. &AutoMinorVersionUpgrade=true - 5. &BackupRetentionPeriod=7 - 6. &DBInstanceIdentifier=mydbinstance - 7. &SignatureMethod=HmacSHA256 - 8. &SignatureVersion=4 - 9. &Version=2014-10-31 -10. &X-Amz-Algorithm=AWS4-HMAC-SHA256 -11. &X-Amz-Credential=AKIADQKE4SARGYLE/20131016/us-west-1/rds/aws4_request -12. &X-Amz-Date=20131016T233051Z -13. &X-Amz-SignedHeaders=content-type;host;user-agent;x-amz-content-sha256;x-amz-date -14. &X-Amz-Signature=087a8eb41cb1ab0fc9ec1575f23e73757ffc6a1e42d7d2b30b9cc0be988cff97 -``` - -## Settings for Microsoft SQL Server DB Instances - -The following table contains details about which settings you can modify, which settings you can't modify, when the changes can be applied, and whether the changes cause downtime for the DB instance\. - - -**** - -| Setting | Setting Description | When the Change Occurs | Downtime Notes | -| --- | --- | --- | --- | -| Allocated storage | The storage, in gibibytes, that you want to allocate for your DB instance\. You can only increase the allocated storage, you can't reduce the allocated storage\. The maximum storage allowed is 16 TiB\. Once Amazon RDS begins to modify your DB instance to increase the storage size or type, you can't submit another request to increase the storage size or type for 6 hours\. You can't modify the storage of some older DB instances, and DB instances restored from older DB snapshots\. The Allocated Storage option is disabled in the console if your DB instance isn’t eligible\. You can also check eligibility by using the AWS CLI command [describe\-valid\-db\-instance\-modifications](https://docs.aws.amazon.com/cli/latest/reference/rds/describe-valid-db-instance-modifications.html) which returns the valid storage options for your DB instance\. For more information, see [Amazon RDS DB Instance Storage](CHAP_Storage.md)\. | If **Apply Immediately** is set to true, the change occurs immediately\. If **Apply Immediately** is set to false, the change occurs during the next maintenance window\. | A short outage of a few minutes may occur\. After that, the DB instance is online but in the **storage\-optimization** state\. Performance might be degraded during storage optimization\. The storage optimization process is usually short, but can sometimes take up to and even beyond 24 hours\. | -| Auto minor version upgrade | Not supported on Amazon RDS for SQL Server | – | – | -| Backup retention period | The number of days that automatic backups are retained\. To disable automatic backups, set the backup retention period to 0\. For more information, see [Working With Backups](USER_WorkingWithAutomatedBackups.md)\. | If **Apply Immediately** is set to true, the change occurs immediately\. If **Apply Immediately** is set to false and you change the setting from a nonzero value to another nonzero value, the change is applied asynchronously, as soon as possible\. Otherwise, the change occurs during the next maintenance window\. | An outage occurs if you change from 0 to a nonzero value, or from a nonzero value to 0\. | -| Backup window | The time range during which automated backups of your databases occur\. The backup window is a start time in Universal Coordinated Time \(UTC\), and a duration in hours\. For more information, see [Working With Backups](USER_WorkingWithAutomatedBackups.md)\. | The change is applied asynchronously, as soon as possible\. | – | -| Certificate authority | The certificate that you want to use\. | If **Apply Immediately** is set to true, the change occurs immediately\. If **Apply Immediately** is set to false, the change occurs during the next maintenance window\. | An outage occurs during this change\. | -| Copy tags to snapshots | If you have any DB instance tags, this option copies them when you create a DB snapshot\. For more information, see [Tagging Amazon RDS Resources](USER_Tagging.md)\. | The change occurs immediately\. This setting ignores the **Apply immediately** setting\. | – | -| Database authentication | The database authentication option you want to use\. Choose **Password authentication** to authenticate database users with database passwords only\. Choose **Password and Kerberos authentication** to authenticate database users with database passwords and Kerberos authentication through an AWS Managed Microsoft AD created with AWS Directory Service\. Next, choose the directory or choose **Create a new Directory**\. For more information, see [Using Kerberos Authentication with Amazon RDS for Oracle](oracle-kerberos.md)\. | If **Apply immediately** is set to true, the change occurs immediately\. If **Apply immediately** is set to false, the change occurs during the next maintenance window\. | When you enable **Password and Kerberos authentication**, a brief outage occurs\. | -| Database port | The port that you want to use to access the database\. The port value must not match any of the port values specified for options in the option group for the DB instance\. | The change occurs immediately\. This setting ignores the **Apply Immediately** setting\. | The DB instance is rebooted immediately\. | -| DB engine version | The version of the SQL Server database engine that you want to use\. Before you upgrade your production DB instances, we recommend that you test the upgrade process on a test instance to verify its duration and to validate your applications\. For more information, see [Upgrading the Microsoft SQL Server DB Engine](USER_UpgradeDBInstance.SQLServer.md)\. | If **Apply Immediately** is set to true, the change occurs immediately\. If **Apply Immediately** is set to false, the change occurs during the next maintenance window\. | An outage occurs during this change\. | -| DB instance class | The DB instance class that you want to use\. For more information, see [Choosing the DB Instance Class](Concepts.DBInstanceClass.md) and [DB Instance Class Support for Microsoft SQL Server](CHAP_SQLServer.md#SQLServer.Concepts.General.InstanceClasses)\. | If **Apply Immediately** is set to true, the change occurs immediately\. If **Apply Immediately** is set to false, the change occurs during the next maintenance window\. | An outage occurs during this change\. | -| DB instance identifier | The DB instance identifier\. For more information about the effects of renaming a DB instance, see [Renaming a DB Instance](USER_RenameInstance.md)\. | If **Apply Immediately** is set to true, the change occurs immediately\. If **Apply Immediately** is set to false, the change occurs during the next maintenance window\. | An outage occurs during this change\. The DB instance is rebooted\. | -| DB parameter group | The parameter group that you want associated with the DB instance\. For more information, see [Working with DB Parameter Groups](USER_WorkingWithParamGroups.md)\. | The parameter group change occurs immediately\. | An outage doesn't occur during this change\. When you change the parameter group, changes to some parameters are applied to the DB instance immediately without a reboot\. Changes to other parameters are applied only after the DB instance is rebooted\. For more information, see [Rebooting a DB Instance](USER_RebootInstance.md)\. | -| Deletion protection | Select Enable deletion protection to prevent your DB instance from being deleted\. For more information, see [Deleting a DB Instance](USER_DeleteInstance.md)\. | – | – | -| Domain | The Active Directory Domain to move the instance to\. Specify none to remove the instance from its current domain\. The domain must exist prior to this operation\. For more information, see [Using Windows Authentication with a Microsoft SQL Server DB Instance](USER_SQLServerWinAuth.md)\. | If **Apply Immediately** is set to true, the change occurs immediately\. If **Apply Immediately** is set to false, the change occurs during the next maintenance window\. | A brief outage occurs during this change\. For single\-AZ DB instances, the outage is approximately 5\-10 minutes\. For multi\-AZ DB instances, the outage is approximately 1 minute\. | -| Domain IAM role name | The name of the IAM role to use when accessing the Active Directory Service\. For more information, see [Using Windows Authentication with a Microsoft SQL Server DB Instance](USER_SQLServerWinAuth.md)\. | If **Apply Immediately** is set to true, the change occurs immediately\. If **Apply Immediately** is set to false, the change occurs during the next maintenance window\. | A brief outage occurs during this change\. | -| Enhanced monitoring | **Enable enhanced monitoring** to enable gathering metrics in real time for the operating system that your DB instance runs on\. For more information, see [Enhanced Monitoring](USER_Monitoring.OS.md)\. | – | – | -| License model | Choose **license\-included** to use the general license agreement for Microsoft SQL Server\. | If **Apply Immediately** is set to true, the change occurs immediately\. If **Apply Immediately** is set to false, the change occurs during the next maintenance window\. | An outage occurs during this change\. | -| Maintenance window | The time range during which system maintenance occurs\. System maintenance includes upgrades, if applicable\. The maintenance window is a start time in Universal Coordinated Time \(UTC\), and a duration in hours\. If you set the window to the current time, there must be at least 30 minutes between the current time and end of the window to ensure any pending changes are applied\. For more information, see [The Amazon RDS Maintenance Window](USER_UpgradeDBInstance.Maintenance.md#Concepts.DBMaintenance)\. | The change occurs immediately\. This setting ignores the **Apply Immediately** setting\. | If there are one or more pending actions that cause an outage, and the maintenance window is changed to include the current time, then those pending actions are applied immediately, and an outage occurs\. | -| Multi\-AZ deployment | **Yes** to deploy your DB instance in multiple Availability Zones\. Otherwise, **No**\. If your DB instance is running Database Mirroring \(DBM\) – not Always On Availability Groups \(AGs\) – with SQL Server 2014, 2016, or 2017 Enterprise Edition, and has in\-memory optimization enabled, disable in\-memory optimization before you add Multi\-AZ\. If it is running AGs, it doesn't require this step\. For more information, see [Multi\-AZ Deployments for Microsoft SQL Server](USER_SQLServerMultiAZ.md)\. | If **Apply Immediately** is set to true, the change occurs immediately\. If **Apply Immediately** is set to false, the change occurs during the next maintenance window\. | – | -| New master password | The password for your master user\. The password must contain from 8 to 128 printable ASCII characters \(excluding /,", a space, and @\)\. By resetting the master password, you also reset permissions for the DB instance\. For more information, see [Resetting the DB Instance Owner Role Password](CHAP_Troubleshooting.md#CHAP_Troubleshooting.ResetPassword)\. | The change is applied asynchronously, as soon as possible\. This setting ignores the **Apply Immediately** setting\. | – | -| Option group | The option group that you want associated with the DB instance\. For more information, see [Working with Option Groups](USER_WorkingWithOptionGroups.md)\. | If **Apply Immediately** is set to true, the change occurs immediately\. If **Apply Immediately** is set to false, the change occurs during the next maintenance window\. | – | -| Performance Insights | Select **Enable Performance Insights** to monitor your DB instance load so that you can analyze and troubleshoot your database performance\. Choose a **Retention period** to determine how much rolling data history to retain\. The default of seven days is in the free tier; long\-term retention \(two years\) is priced per vCPU per month\. You cannot change the **Master key** after the database is created\. For more information, see [Using Amazon RDS Performance Insights](USER_PerfInsights.md)\. | The change occurs immediately\. This setting ignores the **Apply immediately** setting\. | – | -| Public accessibility | **Yes** to give the DB instance a public IP address, meaning that it's accessible outside the VPC\. To be publicly accessible, the DB instance also has to be in a public subnet in the VPC\. **No** to make the DB instance accessible only from inside the VPC\. For more information, see [Hiding a DB Instance in a VPC from the Internet](USER_VPC.WorkingWithRDSInstanceinaVPC.md#USER_VPC.Hiding)\. | The change occurs immediately\. This setting ignores the **Apply immediately** setting\. | – | -| Security group | The security group that you want associated with the DB instance\. For more information, see [Working with DB Security Groups \(EC2\-Classic Platform\)](USER_WorkingWithSecurityGroups.md)\. | The change is applied asynchronously, as soon as possible\. This setting ignores the **Apply Immediately** setting\. | – | -| Storage autoscaling | Select **Enable storage autoscaling** to enable Amazon RDS to automatically increase storage when needed to avoid having your DB instance run out of storage space\. Use **Maximum storage threshold** to set the upper limit for Amazon RDS to automatically increase storage for your DB instance\. The default is 1000 GiB\. For more information, see [Managing Capacity Automatically with Amazon RDS Storage Autoscaling](USER_PIOPS.StorageTypes.md#USER_PIOPS.Autoscaling)\. | The change occurs immediately\. This setting ignores the **Apply immediately** setting\. | – | -| Storage type | The storage type that you want to use\. You can't change from or to magnetic storage\. For more information, see [Amazon RDS Storage Types](CHAP_Storage.md#Concepts.Storage)\. Once Amazon RDS begins to modify your DB instance to change the storage size or type, you can't submit another request to change the storage size or type for 6 hours\. | If **Apply Immediately** is set to true, the change occurs immediately\. If **Apply Immediately** is set to false, the change occurs during the next maintenance window\. | The following changes all result in a brief outage while the process starts\. After that, you can use your database normally while the change takes place\. [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_ModifyInstance.SQLServer.html) | -| Subnet group | The subnet group for the DB instance\. You can use this setting to move your DB instance to a different VPC\. If your DB instance is not in a VPC, you can use this setting to move your DB instance into a VPC\. For more information, see [Moving a DB Instance Not in a VPC into a VPC](USER_VPC.md#USER_VPC.Non-VPC2VPC)\. | If **Apply Immediately** is set to true, the change occurs immediately\. If **Apply Immediately** is set to false, the change occurs during the next maintenance window\. | An outage occurs during this change\. The DB instance is rebooted\. | - -## Related Topics -+ [Rebooting a DB Instance](USER_RebootInstance.md) -+ [Connecting to a DB Instance Running the Microsoft SQL Server Database Engine](USER_ConnectToMicrosoftSQLServerInstance.md) -+ [Upgrading the Microsoft SQL Server DB Engine](USER_UpgradeDBInstance.SQLServer.md) -+ [Deleting a DB Instance](USER_DeleteInstance.md) \ No newline at end of file diff --git a/doc_source/USER_ModifyPostgreSQLInstance.md b/doc_source/USER_ModifyPostgreSQLInstance.md deleted file mode 100644 index e2b7f44..0000000 --- a/doc_source/USER_ModifyPostgreSQLInstance.md +++ /dev/null @@ -1,122 +0,0 @@ -# Modifying a DB Instance Running the PostgreSQL Database Engine - -You can change the settings of a DB instance to accomplish tasks such as adding additional storage or changing the DB instance class\. This topic guides you through modifying an Amazon RDS PostgreSQL DB instance, and describes the settings for PostgreSQL instances\. For information about additional tasks, such as renaming, rebooting, deleting, tagging, or upgrading an Amazon RDS DB instance, see [Amazon RDS DB Instance Lifecycle](CHAP_CommonTasks.md)\. We recommend that you test any changes on a test instance before modifying a production instance so you better understand the impact of a change\. This is especially important when upgrading database versions\. - -You can have the changes apply immediately or have them applied during the DB instance's next maintenance window\. Applying changes immediately can cause an outage in some cases; for more information on the impact of the **Apply Immediately** option when modifying a DB instance, see [Modifying an Amazon RDS DB Instance](Overview.DBInstance.Modifying.md)\. - -## Console - -**To modify a PostgreSQL DB instance** - -1. Sign in to the AWS Management Console and open the Amazon RDS console at [https://console\.aws\.amazon\.com/rds/](https://console.aws.amazon.com/rds/)\. - -1. In the navigation pane, choose **Databases**, and then choose the DB instance that you want to modify\. - -1. Choose **Modify**\. The **Modify DB Instance** page appears\. - -1. Change any of the settings that you want\. For information about each setting, see [Settings for PostgreSQL DB Instances](#USER_ModifyInstance.Postgres.Settings)\. - -1. When all the changes are as you want them, choose **Continue**\. - -1. To apply the changes immediately, choose **Apply Immediately**\. Choosing this option can cause an outage in some cases\. For more information, see [Using the Apply Immediately Parameter](Overview.DBInstance.Modifying.md#USER_ModifyInstance.ApplyImmediately)\. - -1. On the confirmation page, review your changes\. If they are correct, choose **Modify DB Instance** to save your changes\. - - Alternatively, choose **Back** to edit your changes, or choose **Cancel** to cancel your changes\. - -## AWS CLI - -To modify a PostgreSQL DB instance, use the AWS CLI command [https://docs.aws.amazon.com/cli/latest/reference/rds/modify-db-instance.html](https://docs.aws.amazon.com/cli/latest/reference/rds/modify-db-instance.html)\. - -**Example** -The following code modifies `pgdbinstance` by setting the backup retention period to 1 week \(7 days\) and disabling automatic minor version upgrades\. These changes are applied during the next maintenance window\. - -**Parameters** -+ `--db-instance-identifier`—the name of the DB instance -+ `--backup-retention-period`—the number of days to retain automatic backups\. -+ `--auto-minor-version-upgrade`—allow automatic minor version upgrades\. To disallow automatic minor version upgrades, use `--no-auto-minor-version-upgrade`\. -+ `--no-apply-immediately`—apply changes during the next maintenance window\. To apply changes immediately, use `--apply-immediately`\. -For Linux, OS X, or Unix: - -``` -aws rds modify-db-instance \ - --db-instance-identifier pgdbinstance \ - --backup-retention-period 7 \ - --auto-minor-version-upgrade \ - --no-apply-immediately -``` -For Windows: - -``` -aws rds modify-db-instance ^ - --db-instance-identifier pgdbinstance ^ - --backup-retention-period 7 ^ - --auto-minor-version-upgrade ^ - --no-apply-immediately -``` - -## API - -To modify a PostgreSQL DB instance, use the [https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_ModifyDBInstance.html](https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_ModifyDBInstance.html) operation\. - -**Example** -The following code modifies `pgdbinstance` by setting the backup retention period to 1 week \(7 days\) and disabling automatic minor version upgrades\. These changes are applied during the next maintenance window\. - -**Parameters** -+ `DBInstanceIdentifier`—the name of the DB instance -+ `BackupRetentionPeriod`—the number of days to retain automatic backups\. -+ `AutoMinorVersionUpgrade`=`true`—allow automatic minor version upgrades\. To disallow automatic minor version upgrades, set the value to `false`\. -+ `ApplyImmediately`=`false`—apply changes during the next maintenance window\. To apply changes immediately, set the value to `true`\. - -``` - 1. https://rds.us-east-1.amazonaws.com/ - 2. ?Action=ModifyDBInstance - 3. &ApplyImmediately=false - 4. &AutoMinorVersionUpgrade=true - 5. &BackupRetentionPeriod=7 - 6. &DBInstanceIdentifier=mydbinstance - 7. &SignatureMethod=HmacSHA256 - 8. &SignatureVersion=4 - 9. &Version=2013-09-09 -10. &X-Amz-Algorithm=AWS4-HMAC-SHA256 -11. &X-Amz-Credential=AKIADQKE4SARGYLE/20131016/us-east-1/rds/aws4_request -12. &X-Amz-Date=20131016T233051Z -13. &X-Amz-SignedHeaders=content-type;host;user-agent;x-amz-content-sha256;x-amz-date -14. &X-Amz-Signature=087a8eb41cb1ab0fc9ec1575f23e73757ffc6a1e42d7d2b30b9cc0be988cff97 -``` - -## Settings for PostgreSQL DB Instances - -The following table contains details about which settings you can modify, which settings you can't modify, when the changes can be applied, and whether the changes cause downtime for the DB instance\. - - -**** - -| Setting | Setting Description | When the Change Occurs | Downtime Notes | -| --- | --- | --- | --- | -| Allocated storage | The storage, in gigabytes, that you want to allocate for your DB instance\. You can only increase the allocated storage, you can't reduce the allocated storage\. You can't modify allocated storage if the DB instance status is **storage\-optimization** or if the allocated storage for the DB instance has been modified in the last six hours\. The maximum storage allowed depends on the storage type\. For more information, see [Amazon RDS DB Instance Storage](CHAP_Storage.md)\. | If **Apply Immediately** is set to true, the change occurs immediately\. If **Apply Immediately** is set to false, the change occurs during the next maintenance window\. | No downtime\. Performance might be degraded during the change\. | -| Auto minor version upgrade | **Enable auto minor version upgrade** to enable your DB instance to receive preferred minor DB engine version upgrades automatically when they become available\. Amazon RDS performs automatic minor version upgrades in the maintenance window\. | – | – | -| Backup retention period | The number of days that automatic backups are retained\. To disable automatic backups, set the backup retention period to 0\. For more information, see [Working With Backups](USER_WorkingWithAutomatedBackups.md)\. | If **Apply Immediately** is set to true, the change occurs immediately\. If **Apply Immediately** is set to false and you change the setting from a nonzero value to another nonzero value, the change is applied asynchronously, as soon as possible\. Otherwise, the change occurs during the next maintenance window\. | An outage occurs if you change from 0 to a nonzero value, or from a nonzero value to 0\. | -| Backup window | The time range during which automated backups of your databases occur\. The backup window is a start time in Universal Coordinated Time \(UTC\), and a duration in hours\. For more information, see [Working With Backups](USER_WorkingWithAutomatedBackups.md)\. | The change is applied asynchronously, as soon as possible\. | – | -| Certificate authority | The certificate that you want to use\. | If **Apply Immediately** is set to true, the change occurs immediately\. If **Apply Immediately** is set to false, the change occurs during the next maintenance window\. | An outage occurs during this change\. | -| Copy tags to snapshots | If you have any DB instance tags, this option copies them when you create a DB snapshot\. For more information, see [Tagging Amazon RDS Resources](USER_Tagging.md)\. | The change occurs immediately\. This setting ignores the **Apply immediately** setting\. | – | -| Database authentication | The database authentication option you want to use\. Choose **Password authentication** to authenticate database users with database passwords only\. Choose **Password and IAM DB authentication** to authenticate database users with database passwords and user credentials through IAM users and roles\. For more information, see [IAM Database Authentication for MySQL and PostgreSQL](UsingWithRDS.IAMDBAuth.md)\. | If **Apply immediately** is set to true, the change occurs immediately\. If **Apply immediately** is set to false, the change occurs during the next maintenance window\. | – | -| Database port | The port that you want to use to access the database\. The port value must not match any of the port values specified for options in the option group for the DB instance\. | The change occurs immediately\. This setting ignores the **Apply Immediately** setting\. | The DB instance is rebooted immediately\. | -| DB engine version | The version of the PostgreSQL database engine that you want to use\. Before you upgrade your production DB instances, we recommend that you test the upgrade process on a test instance to verify its duration and to validate your applications\. | If **Apply Immediately** is set to true, the change occurs immediately\. If **Apply Immediately** is set to false, the change occurs during the next maintenance window\. | An outage occurs during this change\. | -| DB instance class | The DB instance class that you want to use\. For more information, see [Choosing the DB Instance Class](Concepts.DBInstanceClass.md) | If **Apply Immediately** is set to true, the change occurs immediately\. If **Apply Immediately** is set to false, the change occurs during the next maintenance window\. | An outage occurs during this change\. | -| DB instance identifier | The DB instance identifier\. This value is stored as a lowercase string\. For more information about the effects of renaming a DB instance, see [Renaming a DB Instance](USER_RenameInstance.md)\. | If **Apply Immediately** is set to true, the change occurs immediately\. If **Apply Immediately** is set to false, the change occurs during the next maintenance window\. | An outage occurs during this change\. The DB instance is rebooted\. | -| DB parameter group | The parameter group that you want associated with the DB instance\. For more information, see [Working with DB Parameter Groups](USER_WorkingWithParamGroups.md)\. | The parameter group change occurs immediately\. | An outage doesn't occur during this change\. When you change the parameter group, changes to some parameters are applied to the DB instance immediately without a reboot\. Changes to other parameters are applied only after the DB instance is rebooted\. For more information, see [Rebooting a DB Instance](USER_RebootInstance.md)\. | -| Deletion protection | **Enable deletion protection** to prevent your DB instance from being deleted\. For more information, see [Deleting a DB Instance](USER_DeleteInstance.md)\. | – | – | -| Enhanced monitoring | **Enable enhanced monitoring** to enable gathering metrics in real time for the operating system that your DB instance runs on\. For more information, see [Enhanced Monitoring](USER_Monitoring.OS.md)\. | – | – | -| License model | You can't change the license model because PostgreSQL has only one license model\. | – | – | -| Log exports | The types of PostgreSQL database log files to publish to Amazon CloudWatch Logs\. For more information, see [PostgreSQL Database Log Files](USER_LogAccess.Concepts.PostgreSQL.md)\. | The change occurs immediately\. This setting ignores the **Apply immediately** setting\. | – | -| Maintenance window | The time range during which system maintenance occurs\. System maintenance includes upgrades, if applicable\. The maintenance window is a start time in Universal Coordinated Time \(UTC\), and a duration in hours\. If you set the window to the current time, there must be at least 30 minutes between the current time and end of the window to ensure any pending changes are applied\. For more information, see [The Amazon RDS Maintenance Window](USER_UpgradeDBInstance.Maintenance.md#Concepts.DBMaintenance)\. | The change occurs immediately\. This setting ignores the **Apply Immediately** setting\. | If there are one or more pending actions that cause an outage, and the maintenance window is changed to include the current time, then those pending actions are applied immediately, and an outage occurs\. | -| Multi\-AZ deployment | **Yes** to deploy your DB instance in multiple Availability Zones\. Otherwise, **No**\. For more information, see [Regions and Availability Zones](Concepts.RegionsAndAvailabilityZones.md)\. | If **Apply Immediately** is set to true, the change occurs immediately\. If **Apply Immediately** is set to false, the change occurs during the next maintenance window\. | – | -| New master password | The password for your master user\. The password must contain from 8 to 30 alphanumeric characters\. | The change is applied asynchronously, as soon as possible\. This setting ignores the **Apply Immediately** setting\. | – | -| Option group | No options are available for PostgreSQL DB instances\. For more information, see [Working with Option Groups](USER_WorkingWithOptionGroups.md)\. | – | – | -| Performance Insights | **Enable Performance Insights** to monitor your DB instance load so that you can analyze and troubleshoot your database performance\. Choose a retention period to determine how much rolling data history to retain\. The default of seven days is in the free tier\. Long\-term retention \(two years\) is priced per vCPU per month\. You can't change the master key after the database is created\. For more information, see [Using Amazon RDS Performance Insights](USER_PerfInsights.md)\. | The change occurs immediately\. This setting ignores the **Apply immediately** setting\. | – | -| Public accessibility | **Yes** to give the DB instance a public IP address, meaning that it's accessible outside the VPC\. To be publicly accessible, the DB instance also has to be in a public subnet in the VPC\. **No** to make the DB instance accessible only from inside the VPC\. For more information, see [Hiding a DB Instance in a VPC from the Internet](USER_VPC.WorkingWithRDSInstanceinaVPC.md#USER_VPC.Hiding)\. | The change occurs immediately\. This setting ignores the **Apply immediately** setting\. | – | -| Security group | The security group that you want associated with the DB instance\. For more information, see [Working with DB Security Groups \(EC2\-Classic Platform\)](USER_WorkingWithSecurityGroups.md)\. | The change is applied asynchronously, as soon as possible\. This setting ignores the **Apply Immediately** setting\. | – | -| Storage autoscaling | **Enable storage autoscaling** to enable Amazon RDS to automatically increase storage when needed to avoid having your DB instance run out of storage space\. Use **Maximum storage threshold** to set the upper limit for Amazon RDS to automatically increase storage for your DB instance\. The default is 1,000 GiB\. For more information, see [Managing Capacity Automatically with Amazon RDS Storage Autoscaling](USER_PIOPS.StorageTypes.md#USER_PIOPS.Autoscaling)\. | The change occurs immediately\. This setting ignores the **Apply immediately** setting\. | – | -| Storage type | The storage type that you want to use\. For more information, see [Amazon RDS Storage Types](CHAP_Storage.md#Concepts.Storage)\. | If **Apply Immediately** is set to true, the change occurs immediately\. If **Apply Immediately** is set to false, the change occurs during the next maintenance window\. | The following changes all result in a brief outage while the process starts\. After that, you can use your database normally while the change takes place\. [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_ModifyPostgreSQLInstance.html) | -| Subnet group | The subnet group for the DB instance\. You can use this setting to move your DB instance to a different VPC\. If your DB instance is not in a VPC, you can use this setting to move your DB instance into a VPC\. For more information, see [Moving a DB Instance Not in a VPC into a VPC](USER_VPC.md#USER_VPC.Non-VPC2VPC)\. | If **Apply Immediately** is set to true, the change occurs immediately\. If **Apply Immediately** is set to false, the change occurs during the next maintenance window\. | An outage occurs during this change\. The DB instance is rebooted\. | \ No newline at end of file diff --git a/doc_source/USER_Monitoring-Available-OS-Metrics.md b/doc_source/USER_Monitoring-Available-OS-Metrics.md deleted file mode 100644 index adc72a2..0000000 --- a/doc_source/USER_Monitoring-Available-OS-Metrics.md +++ /dev/null @@ -1,15 +0,0 @@ -# OS metrics in Enhanced Monitoring - -Amazon RDS provides metrics in real time for the operating system \(OS\) that your DB instance runs on\. RDS delivers the metrics from Enhanced Monitoring to your Amazon CloudWatch Logs account\. The following tables list the OS metrics available using Amazon CloudWatch Logs\. - -**Topics** -+ [OS metrics for MariaDB, MySQL, Oracle, and PostgreSQL](#USER_Monitoring-Available-OS-Metrics-RDS) -+ [OS metrics for Microsoft SQL Server](#USER_Monitoring-Available-OS-Metrics-RDS.SQLServer) - -## OS metrics for MariaDB, MySQL, Oracle, and PostgreSQL - -[\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Monitoring-Available-OS-Metrics.html) - -## OS metrics for Microsoft SQL Server - -[\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Monitoring-Available-OS-Metrics.html) \ No newline at end of file diff --git a/doc_source/USER_Monitoring.OS.CloudWatchLogs.md b/doc_source/USER_Monitoring.OS.CloudWatchLogs.md deleted file mode 100644 index add4d76..0000000 --- a/doc_source/USER_Monitoring.OS.CloudWatchLogs.md +++ /dev/null @@ -1,18 +0,0 @@ -# Viewing OS metrics using CloudWatch Logs - -After you have enabled Enhanced Monitoring for your DB instance or Multi\-AZ DB cluster, you can view the metrics for it using CloudWatch Logs, with each log stream representing a single DB instance or DB cluster being monitored\. The log stream identifier is the resource identifier \(`DbiResourceId`\) for the DB instance or DB cluster\. - -**To view Enhanced Monitoring log data** - -1. Open the CloudWatch console at [https://console\.aws\.amazon\.com/cloudwatch/](https://console.aws.amazon.com/cloudwatch/)\. - -1. If necessary, choose the AWS Region that your DB instance or Multi\-AZ DB cluster is in\. For more information, see [Regions and endpoints](https://docs.aws.amazon.com/general/latest/gr/index.html?rande.html) in the *Amazon Web Services General Reference*\. - -1. Choose **Logs** in the navigation pane\. - -1. Choose **RDSOSMetrics** from the list of log groups\. - - In a Multi\-AZ DB instance deployment, log files with `-secondary` appended to the name are for the Multi\-AZ standby replica\. -![\[Multi-AZ standby replica log file\]](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/images/enhanced-monitoring-cloudwatch-secondary.png) - -1. Choose the log stream that you want to view from the list of log streams\. \ No newline at end of file diff --git a/doc_source/USER_Monitoring.OS.Enabling.md b/doc_source/USER_Monitoring.OS.Enabling.md deleted file mode 100644 index 3113607..0000000 --- a/doc_source/USER_Monitoring.OS.Enabling.md +++ /dev/null @@ -1,174 +0,0 @@ -# Setting up and enabling Enhanced Monitoring - -To use Enhanced Monitoring, you must create an IAM role, and then enable Enhanced Monitoring\. - -**Topics** -+ [Creating an IAM role for Enhanced Monitoring](#USER_Monitoring.OS.Enabling.Prerequisites) -+ [Turning Enhanced Monitoring on and off](#USER_Monitoring.OS.Enabling.Procedure) -+ [Protecting against the confused deputy problem](#USER_Monitoring.OS.confused-deputy) - -## Creating an IAM role for Enhanced Monitoring - -Enhanced Monitoring requires permission to act on your behalf to send OS metric information to CloudWatch Logs\. You grant Enhanced Monitoring permissions using an AWS Identity and Access Management \(IAM\) role\. You can either create this role when you enable Enhanced Monitoring or create it beforehand\. - -**Topics** -+ [Creating the IAM role when you enable Enhanced Monitoring](#USER_Monitoring.OS.Enabling.Prerequisites.creating-role-automatically) -+ [Creating the IAM role before you enable Enhanced Monitoring](#USER_Monitoring.OS.Enabling.Prerequisites.creating-role-manually) - -### Creating the IAM role when you enable Enhanced Monitoring - -When you enable Enhanced Monitoring in the RDS console, Amazon RDS can create the required IAM role for you\. The role is named `rds-monitoring-role`\. RDS uses this role for the specified DB instance, read replica, or Multi\-AZ DB cluster\. - -**To create the IAM role when enabling Enhanced Monitoring** - -1. Follow the steps in [Turning Enhanced Monitoring on and off](#USER_Monitoring.OS.Enabling.Procedure)\. - -1. Set **Monitoring Role** to **Default** in the step where you choose a role\. - -### Creating the IAM role before you enable Enhanced Monitoring - -You can create the required role before you enable Enhanced Monitoring\. When you enable Enhanced Monitoring, specify your new role's name\. You must create this required role if you enable Enhanced Monitoring using the AWS CLI or the RDS API\. - -The user that enables Enhanced Monitoring must be granted the `PassRole` permission\. For more information, see Example 2 in [Granting a user permissions to pass a role to an AWS service](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_use_passrole.html) in the *IAM User Guide*\. - -**To create an IAM role for Amazon RDS enhanced monitoring** - -1. Open the [IAM console](https://console.aws.amazon.com/iam/home?#home) at [https://console\.aws\.amazon\.com](https://console.aws.amazon.com/)\. - -1. In the navigation pane, choose **Roles**\. - -1. Choose **Create role**\. - -1. Choose the **AWS service** tab, and then choose **RDS** from the list of services\. - -1. Choose **RDS \- Enhanced Monitoring**, and then choose **Next**\. - -1. Ensure that the **Permissions policies** shows **AmazonRDSEnhancedMonitoringRole**, and then choose **Next**\. - -1. For **Role name**, enter a name for your role\. For example, enter **emaccess**\. - - The trusted entity for your role is the AWS service **monitoring\.rds\.amazonaws\.com**\. - -1. Choose **Create role**\. - -## Turning Enhanced Monitoring on and off - -You can turn Enhanced Monitoring on and off using the AWS Management Console, AWS CLI, or RDS API\. You choose the RDS DB instances on which you want to turn on Enhanced Monitoring\. You can set different granularities for metric collection on each DB instance\. - -### Console - -You can turn on Enhanced Monitoring when you create a DB instance, Multi\-AZ DB cluster, or read replica, or when you modify a DB instance or Multi\-AZ DB cluster\. If you modify a DB instance to turn on Enhanced Monitoring, you don't need to reboot your DB instance for the change to take effect\. - -You can turn on Enhanced Monitoring in the RDS console when you do one of the following actions in the **Databases** page: -+ **Create a DB instance or Multi\-AZ DB cluster** – Choose **Create database**\. -+ **Create a read replica** – Choose **Actions**, then **Create read replica**\. -+ **Modify a DB instance or Multi\-AZ DB cluster** – Choose **Modify**\. - -**To turn Enhanced Monitoring on or off in the RDS console** - -1. Scroll to **Additional configuration**\. - -1. In **Monitoring**, choose **Enable Enhanced Monitoring** for your DB instance or read replica\. To turn Enhanced Monitoring off, choose **Disable Enhanced Monitoring**\. - -1. Set the **Monitoring Role** property to the IAM role that you created to permit Amazon RDS to communicate with Amazon CloudWatch Logs for you, or choose **Default** to have RDS create a role for you named `rds-monitoring-role`\. - -1. Set the **Granularity** property to the interval, in seconds, between points when metrics are collected for your DB instance or read replica\. The **Granularity** property can be set to one of the following values: `1`, `5`, `10`, `15`, `30`, or `60`\. - - The fastest that the RDS console refreshes is every 5 seconds\. If you set the granularity to 1 second in the RDS console, you still see updated metrics only every 5 seconds\. You can retrieve 1\-second metric updates by using CloudWatch Logs\. - -### AWS CLI - -To turn on Enhanced Monitoring using the AWS CLI, in the following commands, set the `--monitoring-interval` option to a value other than `0` and set the `--monitoring-role-arn` option to the role you created in [Creating an IAM role for Enhanced Monitoring](#USER_Monitoring.OS.Enabling.Prerequisites)\. -+ [create\-db\-instance](https://docs.aws.amazon.com/cli/latest/reference/rds/create-db-instance.html) -+ [create\-db\-instance\-read\-replica](https://docs.aws.amazon.com/cli/latest/reference/rds/create-db-instance-read-replica.html) -+ [modify\-db\-instance](https://docs.aws.amazon.com/cli/latest/reference/rds/modify-db-instance.html) -+ [create\-db\-cluster](https://docs.aws.amazon.com/cli/latest/reference/rds/create-db-cluster.html) \(Multi\-AZ DB cluster\) -+ [modify\-db\-cluster](https://docs.aws.amazon.com/cli/latest/reference/rds/modify-db-cluster.html) \(Multi\-AZ DB cluster\) - -The `--monitoring-interval` option specifies the interval, in seconds, between points when Enhanced Monitoring metrics are collected\. Valid values for the option are `0`, `1`, `5`, `10`, `15`, `30`, and `60`\. - -To turn off Enhanced Monitoring using the AWS CLI, set the `--monitoring-interval` option to `0` in these commands\. - -**Example** -The following example turns on Enhanced Monitoring for a DB instance: -For Linux, macOS, or Unix: - -``` -aws rds modify-db-instance \ - --db-instance-identifier mydbinstance \ - --monitoring-interval 30 \ - --monitoring-role-arn arn:aws:iam::123456789012:role/emaccess -``` -For Windows: - -``` -aws rds modify-db-instance ^ - --db-instance-identifier mydbinstance ^ - --monitoring-interval 30 ^ - --monitoring-role-arn arn:aws:iam::123456789012:role/emaccess -``` - -**Example** -The following example turns on Enhanced Monitoring for a Multi\-AZ DB cluster: -For Linux, macOS, or Unix: - -``` -aws rds modify-db-cluster \ - --db-cluster-identifier mydbcluster \ - --monitoring-interval 30 \ - --monitoring-role-arn arn:aws:iam::123456789012:role/emaccess -``` -For Windows: - -``` -aws rds modify-db-cluster ^ - --db-cluster-identifier mydbcluster ^ - --monitoring-interval 30 ^ - --monitoring-role-arn arn:aws:iam::123456789012:role/emaccess -``` - -### RDS API - -To turn on Enhanced Monitoring using the RDS API, set the `MonitoringInterval` parameter to a value other than `0` and set the `MonitoringRoleArn` parameter to the role you created in [Creating an IAM role for Enhanced Monitoring](#USER_Monitoring.OS.Enabling.Prerequisites)\. Set these parameters in the following actions: -+ [CreateDBInstance](https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_CreateDBInstance.html) -+ [CreateDBInstanceReadReplica](https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_CreateDBInstanceReadReplica.html) -+ [ModifyDBInstance](https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_ModifyDBInstance.html) -+ [CreateDBCluster](https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_CreateDBCluster.html) \(Multi\-AZ DB cluster\) -+ [ModifyDBCluster](https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_ModifyDBInstance.html) \(Multi\-AZ DB cluster\) - -The `MonitoringInterval` parameter specifies the interval, in seconds, between points when Enhanced Monitoring metrics are collected\. Valid values are `0`, `1`, `5`, `10`, `15`, `30`, and `60`\. - -To turn off Enhanced Monitoring using the RDS API, set `MonitoringInterval` to `0`\. - -## Protecting against the confused deputy problem - -The confused deputy problem is a security issue where an entity that doesn't have permission to perform an action can coerce a more\-privileged entity to perform the action\. In AWS, cross\-service impersonation can result in the confused deputy problem\. Cross\-service impersonation can occur when one service \(the *calling service*\) calls another service \(the *called service*\)\. The calling service can be manipulated to use its permissions to act on another customer's resources in a way it should not otherwise have permission to access\. To prevent this, AWS provides tools that help you protect your data for all services with service principals that have been given access to resources in your account\. For more information, see [The confused deputy problem](https://docs.aws.amazon.com/IAM/latest/UserGuide/confused-deputy.html)\. - -To limit the permissions to the resource that Amazon RDS can give another service, we recommend using the `aws:SourceArn` and `aws:SourceAccount` global condition context keys in a trust policy for your Enhanced Monitoring role\. If you use both global condition context keys, they must use the same account ID\. - -The most effective way to protect against the confused deputy problem is to use the `aws:SourceArn` global condition context key with the full ARN of the resource\. For Amazon RDS, set `aws:SourceArn` to `arn:aws:rds:Region:my-account-id:db:dbname`\. - -The following example uses the `aws:SourceArn` and `aws:SourceAccount` global condition context keys in a trust policy to prevent the confused deputy problem\. - -``` -{ - "Version": "2012-10-17", - "Statement": [ - { - "Effect": "Allow", - "Principal": { - "Service": "rds.amazonaws.com" - }, - "Action": "sts:AssumeRole", - "Condition": { - "StringLike": { - "aws:SourceArn": "arn:aws:rds:Region:my-account-id:db:dbname" - }, - "StringEquals": { - "aws:SourceAccount": "my-account-id" - } - } - } - ] -} -``` \ No newline at end of file diff --git a/doc_source/USER_Monitoring.OS.Viewing.md b/doc_source/USER_Monitoring.OS.Viewing.md deleted file mode 100644 index 1d64b17..0000000 --- a/doc_source/USER_Monitoring.OS.Viewing.md +++ /dev/null @@ -1,52 +0,0 @@ -# Viewing OS metrics in the RDS console - -You can view OS metrics reported by Enhanced Monitoring in the RDS console by choosing **Enhanced monitoring** for **Monitoring**\. - -The following example shows the Enhanced Monitoring page\. For descriptions of the Enhanced Monitoring metrics, see [OS metrics in Enhanced Monitoring](USER_Monitoring-Available-OS-Metrics.md)\. - -![\[Dashboard view\]](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/images/metrics1.png) - -Some DB instances use more than one disk for the DB instance's data storage volume\. On those DB instances, the **Physical Devices** graphs show metrics for each one of the disks\. For example, the following graph shows metrics for four disks\. - -![\[Graph with multiple disks\]](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/images/enhanced-monitoring-multiple-disks.png) - -**Note** -Currently, **Physical Devices** graphs are not available for Microsoft SQL Server DB instances\. - -When you are viewing aggregated **Disk I/O** and **File system** graphs, the **rdsdev** device relates to the `/rdsdbdata` file system, where all database files and logs are stored\. The **filesystem** device relates to the `/` file system \(also known as root\), where files related to the operating system are stored\. - -![\[Graph showing file system usage\]](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/images/enhanced-monitoring-filesystem.png) - -If the DB instance is a Multi\-AZ deployment, you can view the OS metrics for the primary DB instance and its Multi\-AZ standby replica\. In the **Enhanced monitoring** view, choose **primary** to view the OS metrics for the primary DB instance, or choose **secondary** to view the OS metrics for the standby replica\. - -![\[Primary and secondary choice for Enhanced Monitoring\]](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/images/enhanced-monitoring-primary-secondary.png) - -For more information about Multi\-AZ deployments, see [Configuring and managing a Multi\-AZ deployment](Concepts.MultiAZ.md)\. - -**Note** -Currently, viewing OS metrics for a Multi\-AZ standby replica is not supported for MariaDB or Microsoft SQL Server DB instances\. - -If you want to see details for the processes running on your DB instance, choose **OS process list** for **Monitoring**\. - -The **Process List** view is shown following\. - -![\[Process list view\]](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/images/metrics2.png) - -The Enhanced Monitoring metrics shown in the **Process list** view are organized as follows: -+ **RDS child processes** – Shows a summary of the RDS processes that support the DB instance, for example `mysqld` for MySQL DB instances\. Process threads appear nested beneath the parent process\. Process threads show CPU utilization only as other metrics are the same for all threads for the process\. The console displays a maximum of 100 processes and threads\. The results are a combination of the top CPU consuming and memory consuming processes and threads\. If there are more than 50 processes and more than 50 threads, the console displays the top 50 consumers in each category\. This display helps you identify which processes are having the greatest impact on performance\. -+ **RDS processes** – Shows a summary of the resources used by the RDS management agent, diagnostics monitoring processes, and other AWS processes that are required to support RDS DB instances\. -+ **OS processes** – Shows a summary of the kernel and system processes, which generally have minimal impact on performance\. - -The items listed for each process are: -+ **VIRT** – Displays the virtual size of the process\. -+ **RES** – Displays the actual physical memory being used by the process\. -+ **CPU%** – Displays the percentage of the total CPU bandwidth being used by the process\. -+ **MEM%** – Displays the percentage of the total memory being used by the process\. - -The monitoring data that is shown in the RDS console is retrieved from Amazon CloudWatch Logs\. You can also retrieve the metrics for a DB instance as a log stream from CloudWatch Logs\. For more information, see [Viewing OS metrics using CloudWatch Logs](USER_Monitoring.OS.CloudWatchLogs.md)\. - -Enhanced Monitoring metrics are not returned during the following: -+ A failover of the DB instance\. -+ Changing the instance class of the DB instance \(scale compute\)\. - -Enhanced Monitoring metrics are returned during a reboot of a DB instance because only the database engine is rebooted\. Metrics for the operating system are still reported\. \ No newline at end of file diff --git a/doc_source/USER_Monitoring.OS.md b/doc_source/USER_Monitoring.OS.md deleted file mode 100644 index 81ca8ad..0000000 --- a/doc_source/USER_Monitoring.OS.md +++ /dev/null @@ -1,9 +0,0 @@ -# Monitoring OS metrics with Enhanced Monitoring - -With Enhanced Monitoring, you can monitor the operating system of your DB instance in real time\. When you want to see how different processes or threads use the CPU, Enhanced Monitoring metrics are useful\. - -**Topics** -+ [Overview of Enhanced Monitoring](USER_Monitoring.OS.overview.md) -+ [Setting up and enabling Enhanced Monitoring](USER_Monitoring.OS.Enabling.md) -+ [Viewing OS metrics in the RDS console](USER_Monitoring.OS.Viewing.md) -+ [Viewing OS metrics using CloudWatch Logs](USER_Monitoring.OS.CloudWatchLogs.md) \ No newline at end of file diff --git a/doc_source/USER_Monitoring.OS.overview.md b/doc_source/USER_Monitoring.OS.overview.md deleted file mode 100644 index c9ca091..0000000 --- a/doc_source/USER_Monitoring.OS.overview.md +++ /dev/null @@ -1,46 +0,0 @@ -# Overview of Enhanced Monitoring - -Amazon RDS provides metrics in real time for the operating system \(OS\) that your DB instance runs on\. You can view all the system metrics and process information for your RDS DB instances on the console\. You can manage which metrics you want to monitor for each instance and customize the dashboard according to your requirements\. For descriptions of the Enhanced Monitoring metrics, see [OS metrics in Enhanced Monitoring](USER_Monitoring-Available-OS-Metrics.md)\. - -RDS delivers the metrics from Enhanced Monitoring into your Amazon CloudWatch Logs account\. You can create metrics filters in CloudWatch from CloudWatch Logs and display the graphs on the CloudWatch dashboard\. You can consume the Enhanced Monitoring JSON output from CloudWatch Logs in a monitoring system of your choice\. For more information, see [Enhanced Monitoring](https://aws.amazon.com/rds/faqs/#Enhanced_Monitoring) in the Amazon RDS FAQs\. - -**Topics** -+ [Enhanced Monitoring availability](#USER_Monitoring.OS.Availability) -+ [Differences between CloudWatch and Enhanced Monitoring metrics](#USER_Monitoring.OS.CloudWatchComparison) -+ [Retention of Enhanced Monitoring metrics](#USER_Monitoring.OS.retention) -+ [Cost of Enhanced Monitoring](#USER_Monitoring.OS.cost) - -## Enhanced Monitoring availability - -Enhanced Monitoring is available for the following database engines: -+ MariaDB -+ Microsoft SQL Server -+ MySQL -+ Oracle -+ PostgreSQL - -Enhanced Monitoring is available for all DB instance classes except for the db\.m1\.small instance class\. - -## Differences between CloudWatch and Enhanced Monitoring metrics - -A *hypervisor* creates and runs virtual machines \(VMs\)\. Using a hypervisor, an instance can support multiple guest VMs by virtually sharing memory and CPU\. CloudWatch gathers metrics about CPU utilization from the hypervisor for a DB instance\. In contrast, Enhanced Monitoring gathers its metrics from an agent on the DB instance\. - -You might find differences between the CloudWatch and Enhanced Monitoring measurements, because the hypervisor layer performs a small amount of work\. The differences can be greater if your DB instances use smaller instance classes\. In this scenario, more virtual machines \(VMs\) are probably managed by the hypervisor layer on a single physical instance\. - -For descriptions of the Enhanced Monitoring metrics, see [OS metrics in Enhanced Monitoring](USER_Monitoring-Available-OS-Metrics.md)\. For more information about CloudWatch metrics, see the *[Amazon CloudWatch User Guide](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/working_with_metrics.html)*\. - -## Retention of Enhanced Monitoring metrics - -By default, Enhanced Monitoring metrics are stored for 30 days in the CloudWatch Logs\. This retention period is different from typical CloudWatch metrics\. - -To modify the amount of time the metrics are stored in the CloudWatch Logs, change the retention for the `RDSOSMetrics` log group in the CloudWatch console\. For more information, see [Change log data retention in CloudWatch logs](https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/Working-with-log-groups-and-streams.html#SettingLogRetention) in the *Amazon CloudWatch Logs User Guide*\. - -## Cost of Enhanced Monitoring - -Enhanced Monitoring metrics are stored in the CloudWatch Logs instead of in CloudWatch metrics\. The cost of Enhanced Monitoring depends on the following factors: -+ You are charged for Enhanced Monitoring only if you exceed the free tier provided by Amazon CloudWatch Logs\. Charges are based on CloudWatch Logs data transfer and storage rates\. -+ The amount of information transferred for an RDS instance is directly proportional to the defined granularity for the Enhanced Monitoring feature\. A smaller monitoring interval results in more frequent reporting of OS metrics and increases your monitoring cost\. To manage costs, set different granularities for different instances in your accounts\. -+ Usage costs for Enhanced Monitoring are applied for each DB instance that Enhanced Monitoring is enabled for\. Monitoring a large number of DB instances is more expensive than monitoring only a few\. -+ DB instances that support a more compute\-intensive workload have more OS process activity to report and higher costs for Enhanced Monitoring\. - -For more information about pricing, see [Amazon CloudWatch pricing](https://aws.amazon.com/cloudwatch/pricing/)\. \ No newline at end of file diff --git a/doc_source/USER_Monitoring.md b/doc_source/USER_Monitoring.md deleted file mode 100644 index 25b38b9..0000000 --- a/doc_source/USER_Monitoring.md +++ /dev/null @@ -1,43 +0,0 @@ -# Viewing metrics in the Amazon RDS console - -Amazon RDS integrates with Amazon CloudWatch to display a variety of RDS DB instance metrics in the RDS console\. For descriptions of these metrics, see [Metrics reference for Amazon RDS](metrics-reference.md)\. - -For your DB instance, the following categories of metrics are monitored: -+ **CloudWatch** – Shows the Amazon CloudWatch metrics for RDS that you can access in the RDS console\. You can also access these metrics in the CloudWatch console\. Each metric includes a graph that shows the metric monitored over a specific time span\. For a list of CloudWatch metrics, see [Amazon CloudWatch metrics for Amazon RDS](rds-metrics.md)\. -+ **Enhanced monitoring** – Shows a summary of operating\-system metrics when your RDS DB instance has turned on Enhanced Monitoring\. RDS delivers the metrics from Enhanced Monitoring to your Amazon CloudWatch Logs account\. Each OS metric includes a graph showing the metric monitored over a specific time span\. For an overview, see [Monitoring OS metrics with Enhanced Monitoring](USER_Monitoring.OS.md)\. For a list of Enhanced Monitoring metrics, see [OS metrics in Enhanced Monitoring](USER_Monitoring-Available-OS-Metrics.md)\. -+ **OS Process list** – Shows details for each process running in your DB instance\. -+ **Performance Insights** – Opens the Amazon RDS Performance Insights dashboard for a DB instance\. For an overview of Performance Insights, see [Monitoring DB load with Performance Insights on Amazon RDS](USER_PerfInsights.md)\. For a list of Performance Insights metrics, see [Amazon CloudWatch metrics for Performance Insights](USER_PerfInsights.Cloudwatch.md)\. - -Amazon RDS now provides a consolidated view of Performance Insights and CloudWatch metrics in the Performance Insights dashboard\. Performance Insights must be turned on for your DB instance to use this view\. You can choose the new monitoring view in the **Monitoring** tab or **Performance Insights** in the navigation pane\. To view the instructions for choosing this view, see [Viewing combined metrics in the Amazon RDS console](Viewing_Unifiedmetrics.md)\. - -If you want to continue with the legacy monitoring view, continue with this procedure\. - -**Note** -The legacy monitoring view will be discontinued on December 15, 2023\. - -**To view metrics for your DB instance in the legacy monitoring view:** - -1. Sign in to the AWS Management Console and open the Amazon RDS console at [https://console\.aws\.amazon\.com/rds/](https://console.aws.amazon.com/rds/)\. - -1. In the navigation pane, choose **Databases**\. - -1. Choose the name of the DB instance that you want to monitor\. - - The database page appears\. The following example shows an Oracle database named `orclb`\. -![\[Database page with monitoring tab shown\]](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/images/oracle-with-monitoring-tab.png) - -1. Scroll down and choose **Monitoring**\. - - The monitoring section appears\. By default, CloudWatch metrics are shown\. For descriptions of these metrics, see [Amazon CloudWatch metrics for Amazon RDS](rds-metrics.md)\. -![\[Database page with monitoring tab shown\]](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/images/oracle-monitoring-subpage.png) - -1. Choose **Monitoring** to see the metric categories\. -![\[Monitoring options\]](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/images/monitoring-options.png) - -1. Choose the category of metrics that you want to see\. - - The following example shows Enhanced Monitoring metrics\. For descriptions of these metrics, see [OS metrics in Enhanced Monitoring](USER_Monitoring-Available-OS-Metrics.md)\. -![\[Enhanced Monitoring\]](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/images/oracle-em-metrics.png) -**Tip** -To choose the time range of the metrics represented by the graphs, you can use the time range list\. -To bring up a more detailed view, you can choose any graph\. You can also apply metric\-specific filters to the data\. \ No newline at end of file diff --git a/doc_source/USER_MultiAZDBCluster_ReadRepl.md b/doc_source/USER_MultiAZDBCluster_ReadRepl.md deleted file mode 100644 index 771cfd4..0000000 --- a/doc_source/USER_MultiAZDBCluster_ReadRepl.md +++ /dev/null @@ -1,265 +0,0 @@ -# Working with Multi\-AZ DB cluster read replicas - -A DB cluster read replica is a special type of cluster that you create from a source DB instance\. After you create a read replica, any updates made to the primary DB instance are asynchronously copied to the Multi\-AZ DB cluster read replica\. You can reduce the load on your primary DB instance by routing read queries from your applications to the read replica\. Using read replicas, you can elastically scale out beyond the capacity constraints of a single DB instance for read\-heavy database workloads\. - -You can also create one or more DB instance read replicas from a Multi\-AZ DB cluster\. DB instance read replicas let you scale beyond the compute or I/O capacity of the source Multi\-AZ DB cluster by directing excess read traffic to the read replicas\. Currently, you can't create a Multi\-AZ DB cluster read replica from an existing Multi\-AZ DB cluster\. - -**Topics** -+ [Migrating to a Multi\-AZ DB cluster using a read replica](#multi-az-db-clusters-migrating-to-with-read-replica) -+ [Creating a DB instance read replica from a Multi\-AZ DB cluster](#multi-az-db-clusters-create-instance-read-replica) - -## Migrating to a Multi\-AZ DB cluster using a read replica - -To migrate a Single\-AZ deployment or Multi\-AZ DB instance deployment to a Multi\-AZ DB cluster deployment with reduced downtime, you can create a Multi\-AZ DB cluster read replica\. For the source, you specify the DB instance in the Single\-AZ deployment or the primary DB instance in the Multi\-AZ DB instance deployment\. The DB instance can process write transactions during the migration to a Multi\-AZ DB cluster\. - -Consider the following before you create a Multi\-AZ DB cluster read replica: -+ The source DB instance must be on a version that supports Multi\-AZ DB clusters\. For more information, see [Multi\-AZ DB clusters](Concepts.RDS_Fea_Regions_DB-eng.Feature.MultiAZDBClusters.md)\. -+ The Multi\-AZ DB cluster read replica must be on the same major version as its source, and the same or higher minor version\. -+ You must turn on automatic backups on the source DB instance by setting the backup retention period to a value other than 0\. -+ The allocated storage of the source DB instance must be 100 GiB or higher\. -+ For RDS for MySQL, both the `gtid-mode` and `enforce_gtid_consistency` parameters must be set to `ON` for the source DB instance\. -+ An active, long\-running transaction can slow the process of creating the read replica\. We recommend that you wait for long\-running transactions to complete before creating a read replica\. -+ We strongly recommend that you create all read replicas in the same virtual private cloud \(VPC\) based on Amazon VPC of the source DB instance\. - - If you create a read replica in a different VPC from the source DB instance, classless inter\-domain routing \(CIDR\) ranges can overlap between the replica and the RDS system\. CIDR overlap makes the replica unstable, which can negatively impact applications connecting to it\. If you receive an error when creating the read replica, choose a different destination DB subnet group\. For more information, see [Working with a DB instance in a VPC](USER_VPC.WorkingWithRDSInstanceinaVPC.md)\. -+ If you delete the source DB instance for a Multi\-AZ DB cluster read replica, the read replica is promoted to a standalone Multi\-AZ DB cluster\. - -### Creating and promoting the Multi\-AZ DB cluster read replica - -You can create and promote a Multi\-AZ DB cluster read replica using the AWS Management Console, AWS CLI, or RDS API\. - -**Note** -For RDS for MySQL, make sure that both the `gtid-mode` and `enforce_gtid_consistency` parameters are set to `ON` for the parameter group associated with the source DB instance\. You must use a custom parameter group, not the default parameter group\. For more information, see [Working with DB parameter groups](USER_WorkingWithDBInstanceParamGroups.md)\. - -#### Console - -To migrate a Single\-AZ deployment or Multi\-AZ DB instance deployment to a Multi\-AZ DB cluster using a read replica, complete the following steps using the AWS Management Console\. - -1. Sign in to the AWS Management Console and open the Amazon RDS console at [https://console\.aws\.amazon\.com/rds/](https://console.aws.amazon.com/rds/)\. - -1. Create the Multi\-AZ DB cluster read replica\. - - 1. In the navigation pane, choose **Databases**\. - - 1. Choose the DB instance that you want to use as the source for a read replica\. - - 1. For **Actions**, choose **Create read replica**\. - - 1. For **Availability and durability**, choose **Multi\-AZ DB cluster**\. - - 1. For **DB instance identifier**, enter a name for the read replica\. - - 1. For the remaining sections, specify your DB cluster settings\. For information about a setting, see [Settings for creating Multi\-AZ DB clusters](create-multi-az-db-cluster.md#create-multi-az-db-cluster-settings)\. - - 1. Choose **Create read replica**\. - -1. When you are ready, promote the read replica to be a standalone Multi\-AZ DB cluster: - - 1. Stop any transactions from being written to the source DB instance, and then wait for all updates to be made to the read replica\. - - Database updates occur on the read replica after they have occurred on the primary DB instance\. This replication lag can vary significantly\. Use the `ReplicaLag` metric to determine when all updates have been made to the read replica\. For more information about replica lag, see [Monitoring read replication](USER_ReadRepl.md#USER_ReadRepl.Monitoring)\. - - 1. Sign in to the AWS Management Console and open the Amazon RDS console at [https://console\.aws\.amazon\.com/rds/](https://console.aws.amazon.com/rds/)\. - - 1. In the Amazon RDS console, choose **Databases**\. - - The **Databases** pane appears\. Each read replica shows **Replica** in the **Role** column\. - - 1. Choose the Multi\-AZ DB cluster read replica that you want to promote\. - - 1. For **Actions**, choose **Promote**\. - - 1. On the **Promote read replica** page, enter the backup retention period and the backup window for the newly promoted Multi\-AZ DB cluster\. - - 1. When the settings are as you want them, choose **Promote read replica**\. - - 1. Wait for the status of the promoted Multi\-AZ DB cluster to be `Available`\. - - 1. Direct your applications to use the promoted Multi\-AZ DB cluster\. - - Optionally, delete the Single\-AZ deployment or Multi\-AZ DB instance deployment if it is no longer needed\. For instructions, see [Deleting a DB instance](USER_DeleteInstance.md)\. - -#### AWS CLI - -To migrate a Single\-AZ deployment or Multi\-AZ DB instance deployment to a Multi\-AZ DB cluster using a read replica, complete the following steps using the AWS CLI\. - -1. Create the Multi\-AZ DB cluster read replica\. - - To create a read replica from the source DB instance, use the AWS CLI command [https://docs.aws.amazon.com/cli/latest/reference/rds/create-db-cluster.html](https://docs.aws.amazon.com/cli/latest/reference/rds/create-db-cluster.html)\. For `--replication-source-identifier`, specify the Amazon Resource Name \(ARN\) of the source DB instance\. - - For Linux, macOS, or Unix: - - ``` - aws rds create-db-cluster \ - --db-cluster-identifier mymultiazdbcluster \ - --replication-source-identifier arn:aws:rds:us-east-2:123456789012:db:mydbinstance - ``` - - For Windows: - - ``` - aws rds create-db-cluster ^ - --db-cluster-identifier mymultiazdbcluster ^ - --replication-source-identifier arn:aws:rds:us-east-2:123456789012:db:mydbinstance - ``` - -1. Stop any transactions from being written to the source DB instance, and then wait for all updates to be made to the read replica\. - - Database updates occur on the read replica after they have occurred on the primary DB instance\. This replication lag can vary significantly\. Use the `Replica Lag` metric to determine when all updates have been made to the read replica\. For more information about replica lag, see [Monitoring read replication](USER_ReadRepl.md#USER_ReadRepl.Monitoring)\. - -1. When you are ready, promote the read replica to be a standalone Multi\-AZ DB cluster\. - - To promote a Multi\-AZ DB cluster read replica, use the AWS CLI command [https://docs.aws.amazon.com/cli/latest/reference/rds/promote-read-replica-db-cluster.html](https://docs.aws.amazon.com/cli/latest/reference/rds/promote-read-replica-db-cluster.html)\. For `--db-cluster-identifier`, specify the identifier of the Multi\-AZ DB cluster read replica\. - - ``` - aws rds promote-read-replica-db-cluster --db-cluster-identifier mymultiazdbcluster - ``` - -1. Wait for the status of the promoted Multi\-AZ DB cluster to be `Available`\. - -1. Direct your applications to use the promoted Multi\-AZ DB cluster\. - -Optionally, delete the Single\-AZ deployment or Multi\-AZ DB instance deployment if it is no longer needed\. For instructions, see [Deleting a DB instance](USER_DeleteInstance.md)\. - -#### RDS API - -To migrate a Single\-AZ deployment or Multi\-AZ DB instance deployment to a Multi\-AZ DB cluster using a read replica, complete the following steps using the RDS API\. - -1. Create the Multi\-AZ DB cluster read replica\. - - To create a Multi\-AZ DB cluster read replica, use the [https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_CreateDBCluster.html](https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_CreateDBCluster.html) operation with the required parameter `DBClusterIdentifier`\. For `ReplicationSourceIdentifier`, specify the Amazon Resource Name \(ARN\) of the source DB instance\. - -1. Stop any transactions from being written to the source DB instance, and then wait for all updates to be made to the read replica\. - - Database updates occur on the read replica after they have occurred on the primary DB instance\. This replication lag can vary significantly\. Use the `Replica Lag` metric to determine when all updates have been made to the read replica\. For more information about replica lag, see [Monitoring read replication](USER_ReadRepl.md#USER_ReadRepl.Monitoring)\. - -1. When you are ready, promote read replica to be a standalone Multi\-AZ DB cluster\. - - To promote a Multi\-AZ DB cluster read replica, use the [https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_PromoteReadReplicaDBCluster.html](https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_PromoteReadReplicaDBCluster.html) operation with the required parameter `DBClusterIdentifier`\. Specify the identifier of the Multi\-AZ DB cluster read replica\. - -1. Wait for the status of the promoted Multi\-AZ DB cluster to be `Available`\. - -1. Direct your applications to use the promoted Multi\-AZ DB cluster\. - -Optionally, delete the Single\-AZ deployment or Multi\-AZ DB instance deployment if it is no longer needed\. For instructions, see [Deleting a DB instance](USER_DeleteInstance.md)\. - -### Limitations for creating a Multi\-AZ DB cluster read replica - -The following limitations apply to creating a Multi\-AZ DB cluster read replica from a Single\-AZ deployment or Multi\-AZ DB instance deployment\. -+ You can't create a Multi\-AZ DB cluster read replica in an AWS account that is different from the AWS account that owns the source DB instance\. -+ You can't create a Multi\-AZ DB cluster read replica in a different AWS Region from the source DB instance\. -+ You can't recover a Multi\-AZ DB cluster read replica to a point in time\. -+ Storage encryption must have the same settings on the source DB instance and Multi\-AZ DB cluster\. -+ If the source DB instance is encrypted, the Multi\-AZ DB cluster read replica must be encrypted using the same KMS key\. -+ To perform a minor version upgrade on the source DB instance, you must first perform the minor version upgrade on the Multi\-AZ DB cluster read replica\. -+ You can't perform a major version upgrade on a Multi\-AZ DB cluster\. -+ You can perform a major version upgrade on the source DB instance of a Multi\-AZ DB cluster read replica, but replication to the read replica stops and can't be restarted\. -+ The Multi\-AZ DB cluster read replica doesn't support cascading read replicas\. -+ For RDS for PostgreSQL, Multi\-AZ DB cluster read replicas can't fail over\. - -## Creating a DB instance read replica from a Multi\-AZ DB cluster - -You can create a DB instance read replica from a Multi\-AZ DB cluster in order to scale beyond the compute or I/O capacity of the cluster for read\-heavy database workloads\. You can direct this excess read traffic to one or more DB instance read replicas\. You can also use read replicas to migrate from a Multi\-AZ DB cluster to a DB instance\. - -To create a read replica, specify a Multi\-AZ DB cluster as the replication source\. One of the reader instances of the Multi\-AZ DB cluster is always the source of replication, not the writer instance\. This condition ensures that the replica is always in sync with the source cluster, even in cases of failover\. - -**Topics** -+ [Comparing reader DB instances and DB instance read replicas](#multi-az-db-clusters-readerdb-vs-dbrr) -+ [Considerations](#multi-az-db-clusters-instance-read-replica-considerations) -+ [Creating a DB instance read replica](#multi-az-db-clusters-instance-read-replica-create) -+ [Promoting the DB instance read replica](#multi-az-db-clusters-promote-instance-read-replica) -+ [Limitations for creating a DB instance read replica from a Multi\-AZ DB cluster](#multi-az-db-clusters-create-instance-read-replica-limitations) - -### Comparing reader DB instances and DB instance read replicas - -A *DB instance read replica* of a Multi\-AZ DB cluster is different than the *reader DB instances* of the Multi\-AZ DB cluster in the following ways: -+ The reader DB instances act as automatic failover targets, while DB instance read replicas do not\. -+ Reader DB instances must acknowledge a change from the writer DB instance before the change can be committed\. For DB instance read replicas, however, updates are asynchronously copied to the read replica without requiring acknowledgement\. -+ Reader DB instances always share the same instance class, storage type, and engine version as the writer DB instance of the Multi\-AZ DB cluster\. DB instance read replicas, however, don’t necessarily have to share the same configurations as the source cluster\. -+ You can promote a DB instance read replica to a standalone DB instance\. You can’t promote a reader DB instance of a Multi\-AZ DB cluster to a standalone instance\. -+ The reader endpoint only routes requests to the reader DB instances of the Multi\-AZ DB cluster\. It never routes requests to a DB instance read replica\. - -For more information about reader and writer DB instances, see [Overview of Multi\-AZ DB clusters](multi-az-db-clusters-concepts.md#multi-az-db-clusters-concepts-overview)\. - -### Considerations - -Consider the following before you create a DB instance read replica from a Multi\-AZ DB cluster: -+ When you create the DB instance read replica, it must be on the same major version as its source cluster, and the same or higher minor version\. After you create it, you can optionally upgrade the read replica to a higher minor version than the source cluster\. -+ When you create the DB instance read replica, the allocated storage must be the same as the allocated storage of the source Multi\-AZ DB cluster\. You can change the allocated storage after the read replica is created\. -+ For RDS for MySQL, the `gtid-mode` parameter must be set to `ON` for the source Multi\-AZ DB cluster\. For more information, see [Working with DB cluster parameter groups for Multi\-AZ DB clusters](USER_WorkingWithDBClusterParamGroups.md)\. -+ An active, long\-running transaction can slow the process of creating the read replica\. We recommend that you wait for long\-running transactions to complete before creating a read replica\. -+ We strongly recommend that you create all read replicas in the same virtual private cloud \(VPC\) based on Amazon VPC of the source Multi\-AZ DB cluster\. - - If you create a read replica in a different VPC from the source Multi\-AZ DB cluster, Classless Inter\-Domain Routing \(CIDR\) ranges can overlap between the replica and the RDS system\. CIDR overlap makes the replica unstable, which can negatively impact applications connecting to it\. If you receive an error when creating the read replica, choose a different destination DB subnet group\. For more information, see [Working with a DB instance in a VPC](USER_VPC.WorkingWithRDSInstanceinaVPC.md)\. -+ If you delete the source Multi\-AZ DB cluster for a DB instance read replica, any read replicas that it's writing to are promoted to standalone DB instances\. - -### Creating a DB instance read replica - -You can create a DB instance read replica from a Multi\-AZ DB cluster using the AWS Management Console, AWS CLI, or RDS API\. - -#### Console - -To create a DB instance read replica from a Multi\-AZ DB cluster, complete the following steps using the AWS Management Console\. - -1. Sign in to the AWS Management Console and open the Amazon RDS console at [https://console\.aws\.amazon\.com/rds/](https://console.aws.amazon.com/rds/)\. - -1. In the navigation pane, choose **Databases**\. - -1. Choose the Multi\-AZ DB cluster that you want to use as the source for a read replica\. - -1. For **Actions**, choose **Create read replica**\. - -1. For **Replica source**, make sure that the correct Multi\-AZ DB cluster is selected\. - -1. For **DB identifier**, enter a name for the read replica\. - -1. For the remaining sections, specify your DB instance settings\. For information about a setting, see [Settings for DB instances](USER_CreateDBInstance.md#USER_CreateDBInstance.Settings)\. -**Note** -The allocated storage for the DB instance read replica must be the same as the allocated storage for the source Multi\-AZ DB cluster\. - -1. Choose **Create read replica**\. - -#### AWS CLI - -To create a DB instance read replica from a Multi\-AZ DB cluster, use the AWS CLI command [https://docs.aws.amazon.com/cli/latest/reference/rds/create-db-instance-read-replica.html](https://docs.aws.amazon.com/cli/latest/reference/rds/create-db-instance-read-replica.html)\. For `--source-db-cluster-identifier`, specify the identifier of the Multi\-AZ DB cluster\. - -For Linux, macOS, or Unix: - -``` -aws rds create-db-instance-read-replica \ ---db-instance-identifier myreadreplica \ ---source-db-cluster-identifier mymultiazdbcluster -``` - -For Windows: - -``` -aws rds create-db-instance-read-replica ^ ---db-instance-identifier myreadreplica ^ ---source-db-cluster-identifier mymultiazdbcluster -``` - -#### RDS API - -To create a DB instance read replica from a Multi\-AZ DB cluster, use the [https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_CreateDBInstanceReadReplica.html](https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_CreateDBInstanceReadReplica.html) operation\. - -### Promoting the DB instance read replica - -If you no longer need the DB instance read replica, you can promote it into a standalone DB instance\. When you promote a read replica, the DB instance is rebooted before it becomes available\. For instructions, see [Promoting a read replica to be a standalone DB instance](USER_ReadRepl.md#USER_ReadRepl.Promote)\. - -If you're using the read replica to migrate a Multi\-AZ DB cluster deployment to a Single\-AZ or Multi\-AZ DB instance deployment, make sure to stop any transactions that are being written to the source DB cluster\. Then, wait for all updates to be made to the read replica\. Database updates occur on the read replica after they occur on one of the reader DB instances of the Multi\-AZ DB cluster\. This replication lag can vary significantly\. Use the `ReplicaLag` metric to determine when all updates have been made to the read replica\. For more information about replica lag, see [Monitoring read replication](USER_ReadRepl.md#USER_ReadRepl.Monitoring)\. - -After you promote the read replica, wait for the status of the promoted DB instance to be `Available` before you direct your applications to use the promoted DB instance\. Optionally, delete the Multi\-AZ DB cluster deployment if you no longer need it\. For instructions, see [Deleting a Multi\-AZ DB cluster](USER_DeleteMultiAZDBCluster.Deleting.md)\. - -### Limitations for creating a DB instance read replica from a Multi\-AZ DB cluster - -The following limitations apply to creating a DB instance read replica from a Multi\-AZ DB cluster deployment\. -+ You can't create a DB instance read replica in an AWS account that's different from the AWS account that owns the source Multi\-AZ DB cluster\. -+ You can't create a DB instance read replica in a different AWS Region from the source Multi\-AZ DB cluster\. -+ You can't recover a DB instance read replica to a point in time\. -+ Storage encryption must have the same settings on the source Multi\-AZ DB cluster and DB instance read replica\. -+ If the source Multi\-AZ DB cluster is encrypted, the DB instance read replica must be encrypted using the same KMS key\. -+ To perform a minor version upgrade on the source Multi\-AZ DB cluster, you must first perform the minor version upgrade on the DB instance read replica\. -+ The DB instance read replica doesn't support cascading read replicas\. -+ For RDS for PostgreSQL, the source Multi\-AZ DB cluster must be running version 15\.2\-R2 or higher in order to create a DB instance read replica\. -+ You can perform a major version upgrade on the source Multi\-AZ DB cluster of a DB instance read replica, but replication to the read replica stops and can't be restarted\. \ No newline at end of file diff --git a/doc_source/USER_MySQL.Replication.ReadReplicas.md b/doc_source/USER_MySQL.Replication.ReadReplicas.md deleted file mode 100644 index cc05c1b..0000000 --- a/doc_source/USER_MySQL.Replication.ReadReplicas.md +++ /dev/null @@ -1,398 +0,0 @@ -# Working with MySQL read replicas - -Following, you can find specific information about working with read replicas on RDS for MySQL\. For general information about read replicas and instructions for using them, see [Working with DB instance read replicas](USER_ReadRepl.md)\. - -**Topics** -+ [Configuring read replicas with MySQL](#USER_MySQL.Replication.ReadReplicas.Configuration) -+ [Configuring replication filters with MySQL](#USER_MySQL.Replication.ReadReplicas.ReplicationFilters) -+ [Configuring delayed replication with MySQL](#USER_MySQL.Replication.ReadReplicas.DelayReplication) -+ [Updating read replicas with MySQL](#USER_MySQL.Replication.ReadReplicas.Updates) -+ [Working with Multi\-AZ read replica deployments with MySQL](#USER_MySQL.Replication.ReadReplicas.MultiAZ) -+ [Using cascading read replicas with RDS for MySQL](#USER_MySQL.Replication.ReadReplicas.Cascading) -+ [Monitoring MySQL read replicas](#USER_MySQL.Replication.ReadReplicas.Monitor) -+ [Starting and stopping replication with MySQL read replicas](#USER_MySQL.Replication.ReadReplicas.StartStop) -+ [Troubleshooting a MySQL read replica problem](#USER_ReadRepl.Troubleshooting) - -## Configuring read replicas with MySQL - -Before a MySQL DB instance can serve as a replication source, make sure to enable automatic backups on the source DB instance\. To do this, set the backup retention period to a value other than 0\. This requirement also applies to a read replica that is the source DB instance for another read replica\. Automatic backups are supported for read replicas running any version of MySQL\. You can configure replication based on binary log coordinates for a MySQL DB instance\. - -On RDS for MySQL version 5\.7\.37 and higher MySQL 5\.7 versions and RDS for MySQL 8\.0\.28 and higher 8\.0 versions, you can configure replication using global transaction identifiers \(GTIDs\)\. For more information, see [Using GTID\-based replication for Amazon RDS for MySQL](mysql-replication-gtid.md)\. - -You can create up to 15 read replicas from one DB instance within the same Region\. For replication to operate effectively, each read replica should have the same amount of compute and storage resources as the source DB instance\. If you scale the source DB instance, also scale the read replicas\. - -RDS for MySQL supports cascading read replicas\. To learn how to configure cascading read replicas, see [Using cascading read replicas with RDS for MySQL](#USER_MySQL.Replication.ReadReplicas.Cascading)\. - -You can run multiple read replica create and delete actions at the same time that reference the same source DB instance\. When you perform these actions, stay within the limit of 15 read replicas for each source instance\. - -A read replica of a MySQL DB instance can't use a lower DB engine version than its source DB instance\. - -### Preparing MySQL DB instances that use MyISAM - -If your MySQL DB instance uses a nontransactional engine such as MyISAM, you need to perform the following steps to successfully set up your read replica\. These steps are required to make sure that the read replica has a consistent copy of your data\. These steps are not required if all of your tables use a transactional engine such as InnoDB\. - -1. Stop all data manipulation language \(DML\) and data definition language \(DDL\) operations on non\-transactional tables in the source DB instance and wait for them to complete\. SELECT statements can continue running\. - -1. Flush and lock the tables in the source DB instance\. - -1. Create the read replica using one of the methods in the following sections\. - -1. Check the progress of the read replica creation using, for example, the `DescribeDBInstances` API operation\. Once the read replica is available, unlock the tables of the source DB instance and resume normal database operations\. - -## Configuring replication filters with MySQL - -You can use replication filters to specify which databases and tables are replicated with a read replica\. Replication filters can include databases and tables in replication or exclude them from replication\. - -The following are some use cases for replication filters: -+ To reduce the size of a read replica\. With replication filtering, you can exclude the databases and tables that aren't needed on the read replica\. -+ To exclude databases and tables from read replicas for security reasons\. -+ To replicate different databases and tables for specific use cases at different read replicas\. For example, you might use specific read replicas for analytics or sharding\. -+ For a DB instance that has read replicas in different AWS Regions, to replicate different databases or tables in different AWS Regions\. - -**Note** -You can also use replication filters to specify which databases and tables are replicated with a primary MySQL DB instance that is configured as a replica in an inbound replication topology\. For more information about this configuration, see [Configuring binary log file position replication with an external source instance](MySQL.Procedural.Importing.External.Repl.md)\. - -**Topics** -+ [Setting replication filtering parameters for RDS for MySQL](#USER_MySQL.Replication.ReadReplicas.ReplicationFilters.Configuring) -+ [Replication filtering limitations for RDS for MySQL](#USER_MySQL.Replication.ReadReplicas.ReplicationFilters.Limitations) -+ [Replication filtering examples for RDS for MySQL](#USER_MySQL.Replication.ReadReplicas.ReplicationFilters.Examples) -+ [Viewing the replication filters for a read replica](#USER_MySQL.Replication.ReadReplicas.ReplicationFilters.Viewing) - -### Setting replication filtering parameters for RDS for MySQL - -To configure replication filters, set the following replication filtering parameters on the read replica: -+ `replicate-do-db` – Replicate changes to the specified databases\. When you set this parameter for a read replica, only the databases specified in the parameter are replicated\. -+ `replicate-ignore-db` – Don't replicate changes to the specified databases\. When the `replicate-do-db` parameter is set for a read replica, this parameter isn't evaluated\. -+ `replicate-do-table` – Replicate changes to the specified tables\. When you set this parameter for a read replica, only the tables specified in the parameter are replicated\. Also, when the `replicate-do-db` or `replicate-ignore-db` parameter is set, make sure to include the database that includes the specified tables in replication with the read replica\. -+ `replicate-ignore-table` – Don't replicate changes to the specified tables\. When the `replicate-do-table` parameter is set for a read replica, this parameter isn't evaluated\. -+ `replicate-wild-do-table` – Replicate tables based on the specified database and table name patterns\. The `%` and `_` wildcard characters are supported\. When the `replicate-do-db` or `replicate-ignore-db` parameter is set, make sure to include the database that includes the specified tables in replication with the read replica\. -+ `replicate-wild-ignore-table` – Don't replicate tables based on the specified database and table name patterns\. The `%` and `_` wildcard characters are supported\. When the `replicate-do-table` or `replicate-wild-do-table` parameter is set for a read replica, this parameter isn't evaluated\. - -The parameters are evaluated in the order that they are listed\. For more information about how these parameters work, see the MySQL documentation: -+ For general information, see [ Replica Server Options and Variables](https://dev.mysql.com/doc/refman/8.0/en/replication-options-replica.html)\. -+ For information about how database replication filtering parameters are evaluated, see [ Evaluation of Database\-Level Replication and Binary Logging Options](https://dev.mysql.com/doc/refman/8.0/en/replication-rules-db-options.html)\. -+ For information about how table replication filtering parameters are evaluated, see [ Evaluation of Table\-Level Replication Options](https://dev.mysql.com/doc/refman/8.0/en/replication-rules-table-options.html)\. - -By default, each of these parameters has an empty value\. On each read replica, you can use these parameters to set, change, and delete replication filters\. When you set one of these parameters, separate each filter from others with a comma\. - -You can use the `%` and `_` wildcard characters in the `replicate-wild-do-table` and `replicate-wild-ignore-table` parameters\. The `%` wildcard matches any number of characters, and the `_` wildcard matches only one character\. - -The binary logging format of the source DB instance is important for replication because it determines the record of data changes\. The setting of the `binlog_format` parameter determines whether the replication is row\-based or statement\-based\. For more information, see [Configuring MySQL binary logging](USER_LogAccess.MySQL.BinaryFormat.md)\. - -**Note** -All data definition language \(DDL\) statements are replicated as statements, regardless of the `binlog_format` setting on the source DB instance\. - -### Replication filtering limitations for RDS for MySQL - -The following limitations apply to replication filtering for RDS for MySQL: -+ Each replication filtering parameter has a 2,000\-character limit\. -+ Commas aren't supported in replication filters\. -+ The MySQL `--binlog-do-db` and `--binlog-ignore-db` options for binary log filtering aren't supported\. -+ Replication filtering doesn't support XA transactions\. - - For more information, see [ Restrictions on XA Transactions](https://dev.mysql.com/doc/refman/8.0/en/xa-restrictions.html) in the MySQL documentation\. - -### Replication filtering examples for RDS for MySQL - -To configure replication filtering for a read replica, modify the replication filtering parameters in the parameter group associated with the read replica\. - -**Note** -You can't modify a default parameter group\. If the read replica is using a default parameter group, create a new parameter group and associate it with the read replica\. For more information on DB parameter groups, see [Working with parameter groups](USER_WorkingWithParamGroups.md)\. - -You can set parameters in a parameter group using the AWS Management Console, AWS CLI, or RDS API\. For information about setting parameters, see [Modifying parameters in a DB parameter group](USER_WorkingWithDBInstanceParamGroups.md#USER_WorkingWithParamGroups.Modifying)\. When you set parameters in a parameter group, all of the DB instances associated with the parameter group use the parameter settings\. If you set the replication filtering parameters in a parameter group, make sure that the parameter group is associated only with read replicas\. Leave the replication filtering parameters empty for source DB instances\. - -The following examples set the parameters using the AWS CLI\. These examples set `ApplyMethod` to `immediate` so that the parameter changes occur immediately after the CLI command completes\. If you want a pending change to be applied after the read replica is rebooted, set `ApplyMethod` to `pending-reboot`\. - -The following examples set replication filters: -+ [Including databases in replication](#rep-filter-in-dbs-mysql) -+ [Including tables in replication](#rep-filter-in-tables-mysql) -+ [Including tables in replication with wildcard characters](#rep-filter-in-tables-wildcards-mysql) -+ [Excluding databases from replication](#rep-filter-ex-dbs-mysql) -+ [Excluding tables from replication](#rep-filter-ex-tables-mysql) -+ [Excluding tables from replication using wildcard characters](#rep-filter-ex-tables-wildcards-mysql) - -**Example Including databases in replication** -The following example includes the `mydb1` and `mydb2` databases in replication\. -For Linux, macOS, or Unix: - -``` -aws rds modify-db-parameter-group \ - --db-parameter-group-name myparametergroup \ - --parameters "ParameterName=replicate-do-db,ParameterValue='mydb1,mydb2',ApplyMethod=immediate" -``` -For Windows: - -``` -aws rds modify-db-parameter-group ^ - --db-parameter-group-name myparametergroup ^ - --parameters "ParameterName=replicate-do-db,ParameterValue='mydb1,mydb2',ApplyMethod=immediate" -``` - -**Example Including tables in replication** -The following example includes the `table1` and `table2` tables in database `mydb1` in replication\. -For Linux, macOS, or Unix: - -``` -aws rds modify-db-parameter-group \ - --db-parameter-group-name myparametergroup \ - --parameters "ParameterName=replicate-do-table,ParameterValue='mydb1.table1,mydb1.table2',ApplyMethod=immediate" -``` -For Windows: - -``` -aws rds modify-db-parameter-group ^ - --db-parameter-group-name myparametergroup ^ - --parameters "ParameterName=replicate-do-table,ParameterValue='mydb1.table1,mydb1.table2',ApplyMethod=immediate" -``` - -**Example Including tables in replication using wildcard characters** -The following example includes tables with names that begin with `order` and `return` in database `mydb` in replication\. -For Linux, macOS, or Unix: - -``` -aws rds modify-db-parameter-group \ - --db-parameter-group-name myparametergroup \ - --parameters "ParameterName=replicate-wild-do-table,ParameterValue='mydb.order%,mydb.return%',ApplyMethod=immediate" -``` -For Windows: - -``` -aws rds modify-db-parameter-group ^ - --db-parameter-group-name myparametergroup ^ - --parameters "ParameterName=replicate-wild-do-table,ParameterValue='mydb.order%,mydb.return%',ApplyMethod=immediate" -``` - -**Example Excluding databases from replication** -The following example excludes the `mydb5` and `mydb6` databases from replication\. -For Linux, macOS, or Unix: - -``` -aws rds modify-db-parameter-group \ - --db-parameter-group-name myparametergroup \ - --parameters "ParameterName=replicate-ignore-db,ParameterValue='mydb5,mydb6',ApplyMethod=immediate" -``` -For Windows: - -``` -aws rds modify-db-parameter-group ^ - --db-parameter-group-name myparametergroup ^ - --parameters "ParameterName=replicate-ignore-db,ParameterValue='mydb5,mydb6',ApplyMethod=immediate" -``` - -**Example Excluding tables from replication** -The following example excludes tables `table1` in database `mydb5` and `table2` in database `mydb6` from replication\. -For Linux, macOS, or Unix: - -``` -aws rds modify-db-parameter-group \ - --db-parameter-group-name myparametergroup \ - --parameters "ParameterName=replicate-ignore-table,ParameterValue='mydb5.table1,mydb6.table2',ApplyMethod=immediate" -``` -For Windows: - -``` -aws rds modify-db-parameter-group ^ - --db-parameter-group-name myparametergroup ^ - --parameters "ParameterName=replicate-ignore-table,ParameterValue='mydb5.table1,mydb6.table2',ApplyMethod=immediate" -``` - -**Example Excluding tables from replication using wildcard characters** -The following example excludes tables with names that begin with `order` and `return` in database `mydb7` from replication\. -For Linux, macOS, or Unix: - -``` -aws rds modify-db-parameter-group \ - --db-parameter-group-name myparametergroup \ - --parameters "ParameterName=replicate-wild-ignore-table,ParameterValue='mydb7.order%,mydb7.return%',ApplyMethod=immediate" -``` -For Windows: - -``` -aws rds modify-db-parameter-group ^ - --db-parameter-group-name myparametergroup ^ - --parameters "ParameterName=replicate-wild-ignore-table,ParameterValue='mydb7.order%,mydb7.return%',ApplyMethod=immediate" -``` - -### Viewing the replication filters for a read replica - -You can view the replication filters for a read replica in the following ways: -+ Check the settings of the replication filtering parameters in the parameter group associated with the read replica\. - - For instructions, see [Viewing parameter values for a DB parameter group](USER_WorkingWithDBInstanceParamGroups.md#USER_WorkingWithParamGroups.Viewing)\. -+ In a MySQL client, connect to the read replica and run the `SHOW REPLICA STATUS` statement\. - - In the output, the following fields show the replication filters for the read replica: - + `Replicate_Do_DB` - + `Replicate_Ignore_DB` - + `Replicate_Do_Table` - + `Replicate_Ignore_Table` - + `Replicate_Wild_Do_Table` - + `Replicate_Wild_Ignore_Table` - - For more information about these fields, see [Checking Replication Status](https://dev.mysql.com/doc/refman/8.0/en/replication-administration-status.html) in the MySQL documentation\. -**Note** -Previous versions of MySQL used `SHOW SLAVE STATUS` instead of `SHOW REPLICA STATUS`\. If you are using a MySQL version before 8\.0\.23, then use `SHOW SLAVE STATUS`\. - -## Configuring delayed replication with MySQL - -You can use delayed replication as a strategy for disaster recovery\. With delayed replication, you specify the minimum amount of time, in seconds, to delay replication from the source to the read replica\. In the event of a disaster, such as a table deleted unintentionally, you complete the following steps to recover from the disaster quickly: -+ Stop replication to the read replica before the change that caused the disaster is sent to it\. - - Use the [mysql\.rds\_stop\_replication](mysql-stored-proc-replicating.md#mysql_rds_stop_replication) stored procedure to stop replication\. -+ Start replication and specify that replication stops automatically at a log file location\. - - You specify a location just before the disaster using the [mysql\.rds\_start\_replication\_until](mysql-stored-proc-replicating.md#mysql_rds_start_replication_until) stored procedure\. -+ Promote the read replica to be the new source DB instance by using the instructions in [Promoting a read replica to be a standalone DB instance](USER_ReadRepl.md#USER_ReadRepl.Promote)\. - -**Note** -On RDS for MySQL 8\.0, delayed replication is supported for MySQL 8\.0\.28 and higher\. On RDS for MySQL 5\.7, delayed replication is supported for MySQL 5\.7\.37 and higher\. -Use stored procedures to configure delayed replication\. You can't configure delayed replication with the AWS Management Console, the AWS CLI, or the Amazon RDS API\. -On RDS for MySQL 5\.7\.37 and higher MySQL 5\.7 versions and RDS for MySQL 8\.0\.28 and higher 8\.0 versions, you can use replication based on global transaction identifiers \(GTIDs\) in a delayed replication configuration\. If you use GTID\-based replication, use the [mysql\.rds\_start\_replication\_until\_gtid](mysql-stored-proc-replicating.md#mysql_rds_start_replication_until_gtid) stored procedure instead of the [mysql\.rds\_start\_replication\_until](mysql-stored-proc-replicating.md#mysql_rds_start_replication_until) stored procedure\. For more information about GTID\-based replication, see [Using GTID\-based replication for Amazon RDS for MySQL](mysql-replication-gtid.md)\. - -**Topics** -+ [Configuring delayed replication during read replica creation](#USER_MySQL.Replication.ReadReplicas.DelayReplication.ReplicaCreation) -+ [Modifying delayed replication for an existing read replica](#USER_MySQL.Replication.ReadReplicas.DelayReplication.ExistingReplica) -+ [Setting a location to stop replication to a read replica](#USER_MySQL.Replication.ReadReplicas.DelayReplication.StartUntil) -+ [Promoting a read replica](#USER_MySQL.Replication.ReadReplicas.DelayReplication.Promote) - -### Configuring delayed replication during read replica creation - -To configure delayed replication for any future read replica created from a DB instance, run the [mysql\.rds\_set\_configuration](mysql-stored-proc-configuring.md#mysql_rds_set_configuration) stored procedure with the `target delay` parameter\. - -**To configure delayed replication during read replica creation** - -1. Using a MySQL client, connect to the MySQL DB instance to be the source for read replicas as the master user\. - -1. Run the [mysql\.rds\_set\_configuration](mysql-stored-proc-configuring.md#mysql_rds_set_configuration) stored procedure with the `target delay` parameter\. - - For example, run the following stored procedure to specify that replication is delayed by at least one hour \(3,600 seconds\) for any read replica created from the current DB instance\. - - ``` - call mysql.rds_set_configuration('target delay', 3600); - ``` -**Note** -After running this stored procedure, any read replica you create using the AWS CLI or Amazon RDS API is configured with replication delayed by the specified number of seconds\. - -### Modifying delayed replication for an existing read replica - -To modify delayed replication for an existing read replica, run the [mysql\.rds\_set\_source\_delay](mysql-stored-proc-replicating.md#mysql_rds_set_source_delay) stored procedure\. - -**To modify delayed replication for an existing read replica** - -1. Using a MySQL client, connect to the read replica as the master user\. - -1. Use the [mysql\.rds\_stop\_replication](mysql-stored-proc-replicating.md#mysql_rds_stop_replication) stored procedure to stop replication\. - -1. Run the [mysql\.rds\_set\_source\_delay](mysql-stored-proc-replicating.md#mysql_rds_set_source_delay) stored procedure\. - - For example, run the following stored procedure to specify that replication to the read replica is delayed by at least one hour \(3600 seconds\)\. - - ``` - call mysql.rds_set_source_delay(3600); - ``` - -1. Use the [mysql\.rds\_start\_replication](mysql-stored-proc-replicating.md#mysql_rds_start_replication) stored procedure to start replication\. - -### Setting a location to stop replication to a read replica - -After stopping replication to the read replica, you can start replication and then stop it at a specified binary log file location using the [mysql\.rds\_start\_replication\_until](mysql-stored-proc-replicating.md#mysql_rds_start_replication_until) stored procedure\. - -**To start replication to a read replica and stop replication at a specific location** - -1. Using a MySQL client, connect to the source MySQL DB instance as the master user\. - -1. Run the [mysql\.rds\_start\_replication\_until](mysql-stored-proc-replicating.md#mysql_rds_start_replication_until) stored procedure\. - - The following example initiates replication and replicates changes until it reaches location `120` in the `mysql-bin-changelog.000777` binary log file\. In a disaster recovery scenario, assume that location `120` is just before the disaster\. - - ``` - call mysql.rds_start_replication_until( - 'mysql-bin-changelog.000777', - 120); - ``` - -Replication stops automatically when the stop point is reached\. The following RDS event is generated: `Replication has been stopped since the replica reached the stop point specified by the rds_start_replication_until stored procedure`\. - -### Promoting a read replica - -After replication is stopped, in a disaster recovery scenario, you can promote a read replica to be the new source DB instance\. For information about promoting a read replica, see [Promoting a read replica to be a standalone DB instance](USER_ReadRepl.md#USER_ReadRepl.Promote)\. - -## Updating read replicas with MySQL - -Read replicas are designed to support read queries, but you might need occasional updates\. For example, you might need to add an index to optimize the specific types of queries accessing the replica\. You can enable updates by setting the `read_only` parameter to `0` in the DB parameter group for the read replica\. Be careful when disabling read\-only on a read replica because it can cause problems if the read replica becomes incompatible with the source DB instance\. Change the value of the `read_only` parameter back to `1` as soon as possible\. - -## Working with Multi\-AZ read replica deployments with MySQL - -You can create a read replica from either single\-AZ or Multi\-AZ DB instance deployments\. You use Multi\-AZ deployments to improve the durability and availability of critical data, but you can't use the Multi\-AZ secondary to serve read\-only queries\. Instead, you can create read replicas from high\-traffic Multi\-AZ DB instances to offload read\-only queries\. If the source instance of a Multi\-AZ deployment fails over to the secondary, any associated read replicas automatically switch to use the secondary \(now primary\) as their replication source\. For more information, see [Configuring and managing a Multi\-AZ deployment](Concepts.MultiAZ.md)\. - -You can create a read replica as a Multi\-AZ DB instance\. Amazon RDS creates a standby of your replica in another Availability Zone for failover support for the replica\. Creating your read replica as a Multi\-AZ DB instance is independent of whether the source database is a Multi\-AZ DB instance\. - -## Using cascading read replicas with RDS for MySQL - -RDS for MySQL supports cascading read replicas\. With *cascading read replicas*, you can scale reads without adding overhead to your source RDS for MySQL DB instance\. - -With cascading read replicas, your RDS for MySQL DB instance sends data to the first read replica in the chain\. That read replica then sends data to the second replica in the chain, and so on\. The end result is that all read replicas in the chain have the changes from the RDS for MySQL DB instance, but without the overhead solely on the source DB instance\. - -You can create a series of up to three read replicas in a chain from a source RDS for MySQL DB instance\. For example, suppose that you have an RDS for MySQL DB instance, `mysql-main`\. You can do the following: -+ Starting with `mysql-main`, create the first read replica in the chain, `read-replica-1`\. -+ Next, from `read-replica-1`, create the next read replica in the chain, `read-replica-2`\. -+ Finally, from `read-replica-2`, create the third read replica in the chain, `read-replica-3`\. - -You can't create another read replica beyond this third cascading read replica in the series for `mysql-main`\. A complete series of instances from an RDS for MySQL source DB instance through to the end of a series of cascading read replicas can consist of at most four DB instances\. - -For cascading read replicas to work, each source RDS for MySQL DB instance must have automated backups turned on\. To turn on automatic backups on a read replica, first create the read replica, and then modify the read replica to turn on automatic backups\. For more information, see [Creating a read replica](USER_ReadRepl.md#USER_ReadRepl.Create)\. - -As with any read replica, you can promote a read replica that's part of a cascade\. Promoting a read replica from within a chain of read replicas removes that replica from the chain\. For example, suppose that you want to move some of the workload from your `mysql-main` DB instance to a new instance for use by the accounting department only\. Assuming the chain of three read replicas from the example, you decide to promote `read-replica-2`\. The chain is affected as follows: -+ Promoting `read-replica-2` removes it from the replication chain\. - + It is now a full read/write DB instance\. - + It continues replicating to `read-replica-3`, just as it was doing before promotion\. -+ Your `mysql-main` continues replicating to `read-replica-1`\. - -For more information about promoting read replicas, see [Promoting a read replica to be a standalone DB instance](USER_ReadRepl.md#USER_ReadRepl.Promote)\. - -## Monitoring MySQL read replicas - -For MySQL read replicas, you can monitor replication lag in Amazon CloudWatch by viewing the Amazon RDS `ReplicaLag` metric\. The `ReplicaLag` metric reports the value of the `Seconds_Behind_Master` field of the `SHOW REPLICA STATUS` command\. - -**Note** -Previous versions of MySQL used `SHOW SLAVE STATUS` instead of `SHOW REPLICA STATUS`\. If you are using a MySQL version before 8\.0\.23, then use `SHOW SLAVE STATUS`\. - -Common causes for replication lag for MySQL are the following: -+ A network outage\. -+ Writing to tables that have different indexes on a read replica\. If the `read_only` parameter is set to `0` on the read replica, replication can break if the read replica becomes incompatible with the source DB instance\. After you've performed maintenance tasks on the read replica, we recommend that you set the `read_only` parameter back to `1`\. -+ Using a nontransactional storage engine such as MyISAM\. Replication is only supported for the InnoDB storage engine on MySQL\. - -When the `ReplicaLag` metric reaches 0, the replica has caught up to the source DB instance\. If the `ReplicaLag` metric returns \-1, then replication is currently not active\. `ReplicaLag` = \-1 is equivalent to `Seconds_Behind_Master` = `NULL`\. - -## Starting and stopping replication with MySQL read replicas - -You can stop and restart the replication process on an Amazon RDS DB instance by calling the system stored procedures [mysql\.rds\_stop\_replication](mysql-stored-proc-replicating.md#mysql_rds_stop_replication) and [mysql\.rds\_start\_replication](mysql-stored-proc-replicating.md#mysql_rds_start_replication)\. You can do this when replicating between two Amazon RDS instances for long\-running operations such as creating large indexes\. You also need to stop and start replication when importing or exporting databases\. For more information, see [Importing data to an Amazon RDS MariaDB or MySQL database with reduced downtime](MySQL.Procedural.Importing.NonRDSRepl.md) and [Exporting data from a MySQL DB instance by using replication](MySQL.Procedural.Exporting.NonRDSRepl.md)\. - -If replication is stopped for more than 30 consecutive days, either manually or due to a replication error, Amazon RDS terminates replication between the source DB instance and all read replicas\. It does so to prevent increased storage requirements on the source DB instance and long failover times\. The read replica DB instance is still available\. However, replication can't be resumed because the binary logs required by the read replica are deleted from the source DB instance after replication is terminated\. You can create a new read replica for the source DB instance to reestablish replication\. - -## Troubleshooting a MySQL read replica problem - -For MySQL DB instances, in some cases read replicas present replication errors or data inconsistencies \(or both\) between the read replica and its source DB instance\. This problem occurs when some binary log \(binlog\) events or InnoDB redo logs aren't flushed during a failure of the read replica or the source DB instance\. In these cases, manually delete and recreate the read replicas\. You can reduce the chance of this happening by setting the following parameter values: `sync_binlog=1` and `innodb_flush_log_at_trx_commit=1`\. These settings might reduce performance, so test their impact before implementing the changes in a production environment\. - -**Warning** -In the parameter group associated with the source DB instance, we recommend keeping these parameter values: `sync_binlog=1` and `innodb_flush_log_at_trx_commit=1`\. These parameters are dynamic\. If you don't want to use these settings, we recommend temporarily setting those values before executing any operation on the source DB instance that might cause it to restart\. These operations include, but are not limited to, rebooting, rebooting with failover, upgrading the database version, and changing the DB instance class or its storage\. The same recommendation applies to creating new read replicas for the source DB instance\. -Failure to follow this guidance increases the risk of read replicas presenting replication errors or data inconsistencies \(or both\) between the read replica and its source DB instance\. - -The replication technologies for MySQL are asynchronous\. Because they are asynchronous, occasional `BinLogDiskUsage` increases on the source DB instance and `ReplicaLag` on the read replica are to be expected\. For example, a high volume of write operations to the source DB instance can occur in parallel\. In contrast, write operations to the read replica are serialized using a single I/O thread, which can lead to a lag between the source instance and read replica\. For more information about read\-only replicas in the MySQL documentation, see [Replication implementation details](https://dev.mysql.com/doc/refman/8.0/en/replication-implementation-details.html)\. - -You can do several things to reduce the lag between updates to a source DB instance and the subsequent updates to the read replica, such as the following: -+ Sizing a read replica to have a storage size and DB instance class comparable to the source DB instance\. -+ Ensuring that parameter settings in the DB parameter groups used by the source DB instance and the read replica are compatible\. For more information and an example, see the discussion of the `max_allowed_packet` parameter later in this section\. - -Amazon RDS monitors the replication status of your read replicas and updates the `Replication State` field of the read replica instance to `Error` if replication stops for any reason\. An example might be if DML queries run on your read replica conflict with the updates made on the source DB instance\. - -You can review the details of the associated error thrown by the MySQL engine by viewing the `Replication Error` field\. Events that indicate the status of the read replica are also generated, including [RDS-EVENT-0045](USER_Events.Messages.md#RDS-EVENT-0045), [RDS-EVENT-0046](USER_Events.Messages.md#RDS-EVENT-0046), and [RDS-EVENT-0047](USER_Events.Messages.md#RDS-EVENT-0047)\. For more information about events and subscribing to events, see [Working with Amazon RDS event notification](USER_Events.md)\. If a MySQL error message is returned, review the error number in the [MySQL error message documentation](https://dev.mysql.com/doc/mysql-errors/8.0/en/server-error-reference.html)\. - -One common issue that can cause replication errors is when the value for the `max_allowed_packet` parameter for a read replica is less than the `max_allowed_packet` parameter for the source DB instance\. The `max_allowed_packet` parameter is a custom parameter that you can set in a DB parameter group\. You use `max_allowed_packet` to specify the maximum size of DML code that can be run on the database\. In some cases, the `max_allowed_packet` value in the DB parameter group associated with a read replica is smaller than the `max_allowed_packet` value in the DB parameter group associated with the source DB instance\. In these cases, the replication process can throw the error `Packet bigger than 'max_allowed_packet' bytes` and stop replication\. To fix the error, have the source DB instance and read replica use DB parameter groups with the same `max_allowed_packet` parameter values\. - -Other common situations that can cause replication errors include the following: -+ Writing to tables on a read replica\. In some cases, you might create indexes on a read replica that are different from the indexes on the source DB instance\. If you do, set the `read_only` parameter to `0` to create the indexes\. If you write to tables on the read replica, it might break replication if the read replica becomes incompatible with the source DB instance\. After you perform maintenance tasks on the read replica, we recommend that you set the `read_only` parameter back to `1`\. -+ Using a non\-transactional storage engine such as MyISAM\. Read replicas require a transactional storage engine\. Replication is only supported for the InnoDB storage engine on MySQL\. -+ Using unsafe nondeterministic queries such as `SYSDATE()`\. For more information, see [ Determination of safe and unsafe statements in binary logging](https://dev.mysql.com/doc/refman/8.0/en/replication-rbr-safe-unsafe.html)\. - -If you decide that you can safely skip an error, you can follow the steps described in the section [Skipping the current replication error](Appendix.MySQL.CommonDBATasks.md#Appendix.MySQL.CommonDBATasks.SkipError)\. Otherwise, you can first delete the read replica\. Then you create an instance using the same DB instance identifier so that the endpoint remains the same as that of your old read replica\. If a replication error is fixed, the `Replication State` changes to *replicating*\. \ No newline at end of file diff --git a/doc_source/USER_MySQL.Replication.md b/doc_source/USER_MySQL.Replication.md deleted file mode 100644 index d5a8bad..0000000 --- a/doc_source/USER_MySQL.Replication.md +++ /dev/null @@ -1,18 +0,0 @@ -# Working with MySQL replication in Amazon RDS - -You usually use read replicas to configure replication between Amazon RDS DB instances\. For general information about read replicas, see [Working with DB instance read replicas](USER_ReadRepl.md)\. For specific information about working with read replicas on Amazon RDS for MySQL, see [Working with MySQL read replicas](USER_MySQL.Replication.ReadReplicas.md)\. - -You can use global transaction identifiers \(GTIDs\) for replication with RDS for MySQL\. For more information, see [Using GTID\-based replication for Amazon RDS for MySQL](mysql-replication-gtid.md)\. - -You can also set up replication between an RDS for MySQL DB instance and a MariaDB or MySQL instance that is external to Amazon RDS\. For information about configuring replication with an external source, see [Configuring binary log file position replication with an external source instance](MySQL.Procedural.Importing.External.Repl.md)\. - -For any of these replication options, you can use either row\-based replication, statement\-based, or mixed replication\. Row\-based replication only replicates the changed rows that result from a SQL statement\. Statement\-based replication replicates the entire SQL statement\. Mixed replication uses statement\-based replication when possible, but switches to row\-based replication when SQL statements that are unsafe for statement\-based replication are run\. In most cases, mixed replication is recommended\. The binary log format of the DB instance determines whether replication is row\-based, statement\-based, or mixed\. For information about setting the binary log format, see [Configuring MySQL binary logging](USER_LogAccess.MySQL.BinaryFormat.md)\. - -**Note** -You can configure replication to import databases from a MariaDB or MySQL instance that is external to Amazon RDS, or to export databases to such instances\. For more information, see [Importing data to an Amazon RDS MariaDB or MySQL database with reduced downtime](MySQL.Procedural.Importing.NonRDSRepl.md) and [Exporting data from a MySQL DB instance by using replication](MySQL.Procedural.Exporting.NonRDSRepl.md)\. - -**Topics** -+ [Working with MySQL read replicas](USER_MySQL.Replication.ReadReplicas.md) -+ [Using GTID\-based replication for Amazon RDS for MySQL](mysql-replication-gtid.md) -+ [Configuring GTID\-based replication with an external source instance](MySQL.Procedural.Importing.External.Repl.GTIDProcedure.md) -+ [Configuring binary log file position replication with an external source instance](MySQL.Procedural.Importing.External.Repl.md) \ No newline at end of file diff --git a/doc_source/USER_OnDemandDBInstances.md b/doc_source/USER_OnDemandDBInstances.md deleted file mode 100644 index dcb4f23..0000000 --- a/doc_source/USER_OnDemandDBInstances.md +++ /dev/null @@ -1,15 +0,0 @@ -# On\-Demand DB instances for Amazon RDS - -Amazon RDS on\-demand DB instances are billed based on the class of the DB instance \(for example, db\.t3\.small or db\.m5\.large\)\. For Amazon RDS pricing information, see the [Amazon RDS product page](https://aws.amazon.com/rds/pricing)\. - -Billing starts for a DB instance as soon as the DB instance is available\. Pricing is listed on a per\-hour basis, but bills are calculated down to the second and show times in decimal form\. Amazon RDS usage is billed in one\-second increments, with a minimum of 10 minutes\. In the case of billable configuration change, such as scaling compute or storage capacity, you're charged a 10\-minute minimum\. Billing continues until the DB instance terminates, which occurs when you delete the DB instance or if the DB instance fails\. - -If you no longer want to be charged for your DB instance, you must stop or delete it to avoid being billed for additional DB instance hours\. For more information about the DB instance states for which you are billed, see [Viewing Amazon RDS DB instance status](accessing-monitoring.md#Overview.DBInstance.Status)\. - -## Stopped DB instances - -While your DB instance is stopped, you're charged for provisioned storage, including Provisioned IOPS\. You are also charged for backup storage, including storage for manual snapshots and automated backups within your specified retention window\. You aren't charged for DB instance hours\. - -## Multi\-AZ DB instances - -If you specify that your DB instance should be a Multi\-AZ deployment, you're billed according to the Multi\-AZ pricing posted on the Amazon RDS pricing page\. \ No newline at end of file diff --git a/doc_source/USER_Oracle_Releases.md b/doc_source/USER_Oracle_Releases.md deleted file mode 100644 index a9c02e1..0000000 --- a/doc_source/USER_Oracle_Releases.md +++ /dev/null @@ -1,7 +0,0 @@ -# Oracle Database engine release notes - -Updates to your Amazon RDS for Oracle DB instances keep them current\. If you apply updates, you can be confident that your DB instance is running a version of the database software that has been tested by both Oracle and Amazon\. We don't support applying one\-off patches to individual RDS for Oracle DB instances\. - -You can specify any currently supported Oracle Database version when you create a new DB instance\. You can specify the major version, such as Oracle Database 19c, and any supported minor version for the specified major version\. If no version is specified, Amazon RDS defaults to a supported version, typically the most recent version\. If a major version is specified but a minor version is not, Amazon RDS defaults to a recent release of the major version that you have specified\. To see a list of supported versions and defaults for newly created DB instances, use the [https://docs.aws.amazon.com/cli/latest/reference/rds/describe-db-engine-versions.html](https://docs.aws.amazon.com/cli/latest/reference/rds/describe-db-engine-versions.html) AWS CLI command\. - -For details about the Oracle Database versions that Amazon RDS supports, see the [https://docs.aws.amazon.com/AmazonRDS/latest/OracleReleaseNotes/Welcome.html](https://docs.aws.amazon.com/AmazonRDS/latest/OracleReleaseNotes/Welcome.html)\. \ No newline at end of file diff --git a/doc_source/USER_PIOPS.StorageTypes.md b/doc_source/USER_PIOPS.StorageTypes.md deleted file mode 100644 index eec604e..0000000 --- a/doc_source/USER_PIOPS.StorageTypes.md +++ /dev/null @@ -1,375 +0,0 @@ -# Working with storage for Amazon RDS DB instances - -To specify how you want your data stored in Amazon RDS, choose a storage type and provide a storage size when you create or modify a DB instance\. Later, you can increase the amount or change the type of storage by modifying the DB instance\. For more information about which storage type to use for your workload, see [Amazon RDS storage types](CHAP_Storage.md#Concepts.Storage)\. - -**Topics** -+ [Increasing DB instance storage capacity](#USER_PIOPS.ModifyingExisting) -+ [Managing capacity automatically with Amazon RDS storage autoscaling](#USER_PIOPS.Autoscaling) -+ [Modifying settings for Provisioned IOPS SSD storage](#User_PIOPS.Increase) -+ [I/O\-intensive storage modifications](#USER_PIOPS.IOIntensive) -+ [Modifying settings for General Purpose SSD \(gp3\) storage](#USER_PIOPS.gp3) - -## Increasing DB instance storage capacity - -If you need space for additional data, you can scale up the storage of an existing DB instance\. To do so, you can use the Amazon RDS Management Console, the Amazon RDS API, or the AWS Command Line Interface \(AWS CLI\)\. For information about storage limits, see [Amazon RDS DB instance storage](CHAP_Storage.md)\. - -**Note** -Scaling storage for Amazon RDS for Microsoft SQL Server DB instances is supported only for General Purpose SSD or Provisioned IOPS SSD storage types\. - -To monitor the amount of free storage for your DB instance so you can respond when necessary, we recommend that you create an Amazon CloudWatch alarm\. For more information on setting CloudWatch alarms, see [Using CloudWatch alarms](https://docs.aws.amazon.com/AmazonCloudWatch/latest/DeveloperGuide/AlarmThatSendsEmail.html)\. - -Scaling storage usually doesn't cause any outage or performance degradation of the DB instance\. After you modify the storage size for a DB instance, the status of the DB instance is **storage\-optimization**\. - -**Note** -Storage optimization can take several hours\. You can't make further storage modifications for either six \(6\) hours or until storage optimization has completed on the instance, whichever is longer\. - -However, a special case is if you have a SQL Server DB instance and haven't modified the storage configuration since November 2017\. In this case, you might experience a short outage of a few minutes when you modify your DB instance to increase the allocated storage\. After the outage, the DB instance is online but in the `storage-optimization` state\. Performance might be degraded during storage optimization\. - -**Note** -You can't reduce the amount of storage for a DB instance after storage has been allocated\. When you increase the allocated storage, it must be by at least 10 percent\. If you try to increase the value by less than 10 percent, you get an error\. - -### Console - -**To increase storage for a DB instance** - -1. Sign in to the AWS Management Console and open the Amazon RDS console at [https://console\.aws\.amazon\.com/rds/](https://console.aws.amazon.com/rds/)\. - -1. In the navigation pane, choose **Databases**\. - -1. Choose the DB instance that you want to modify\. - -1. Choose **Modify**\. - -1. Enter a new value for **Allocated storage**\. It must be greater than the current value\. -![\[Modify the amount of storage for a DB instance\]](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/images/scale-gs2.png) - -1. Choose **Continue** to move to the next screen\. - -1. Choose **Apply immediately** in the **Scheduling of modifications** section to apply the storage changes to the DB instance immediately\. - - Or choose **Apply during the next scheduled maintenance window** to apply the changes during the next maintenance window\. - -1. When the settings are as you want them, choose **Modify DB instance**\. - -### AWS CLI - -To increase the storage for a DB instance, use the AWS CLI command [https://docs.aws.amazon.com/cli/latest/reference/rds/modify-db-instance.html](https://docs.aws.amazon.com/cli/latest/reference/rds/modify-db-instance.html)\. Set the following parameters: -+ `--allocated-storage` – Amount of storage to be allocated for the DB instance, in gibibytes\. -+ `--apply-immediately` – Use `--apply-immediately` to apply the storage changes immediately\. - - Or use `--no-apply-immediately` \(the default\) to apply the changes during the next maintenance window\. An immediate outage occurs when the changes are applied\. - -For more information about storage, see [Amazon RDS DB instance storage](CHAP_Storage.md)\. - -### RDS API - -To increase storage for a DB instance, use the Amazon RDS API operation [https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_ModifyDBInstance.html](https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_ModifyDBInstance.html)\. Set the following parameters: -+ `AllocatedStorage` – Amount of storage to be allocated for the DB instance, in gibibytes\. -+ `ApplyImmediately` – Set this option to `True` to apply the storage changes immediately\. Set this option to `False` \(the default\) to apply the changes during the next maintenance window\. An immediate outage occurs when the changes are applied\. - -For more information about storage, see [Amazon RDS DB instance storage](CHAP_Storage.md)\. - -## Managing capacity automatically with Amazon RDS storage autoscaling - -If your workload is unpredictable, you can enable storage autoscaling for an Amazon RDS DB instance\. To do so, you can use the Amazon RDS console, the Amazon RDS API, or the AWS CLI\. - -For example, you might use this feature for a new mobile gaming application that users are adopting rapidly\. In this case, a rapidly increasing workload might exceed the available database storage\. To avoid having to manually scale up database storage, you can use Amazon RDS storage autoscaling\. - -With storage autoscaling enabled, when Amazon RDS detects that you are running out of free database space it automatically scales up your storage\. Amazon RDS starts a storage modification for an autoscaling\-enabled DB instance when these factors apply: -+ Free available space is less than 10 percent of the allocated storage\. -+ The low\-storage condition lasts at least five minutes\. -+ At least six hours have passed since the last storage modification, or storage optimization has completed on the instance, whichever is longer\. - -The additional storage is in increments of whichever of the following is greater: -+ 5 GiB -+ 10 percent of currently allocated storage -+ Storage growth prediction for 7 hours based on the `FreeStorageSpace` metrics change in the past hour\. For more information on metrics, see [Monitoring with Amazon CloudWatch](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/MonitoringOverview.html#monitoring-cloudwatch)\. - -The maximum storage threshold is the limit that you set for autoscaling the DB instance\. It has the following constraints: -+ You must set the maximum storage threshold to at least 10% more than the current allocated storage\. We recommend setting it to at least 26% more to avoid receiving an [event notification](USER_Events.Messages.md#RDS-EVENT-0225) that the storage size is approaching the maximum storage threshold\. - - For example, if you have DB instance with 1000 GiB of allocated storage, then set the maximum storage threshold to at least 1100 GiB\. If you don't, you get an error such as Invalid max storage size for *engine\_name*\. However, we recommend that you set the maximum storage threshold to at least 1260 GiB to avoid the event notification\. -+ For a DB instance that uses Provisioned IOPS storage, the ratio of IOPS to maximum storage threshold \(in GiB\) must be from 1–50 on RDS for SQL Server, and 0\.5–50 on other RDS DB engines\. -+ You can't set the maximum storage threshold for autoscaling\-enabled instances to a value greater than the maximum allocated storage for the database engine and DB instance class\. - - For example, SQL Server Standard Edition on db\.m5\.xlarge has a default allocated storage for the instance of 20 GiB \(the minimum\) and a maximum allocated storage of 16,384 GiB\. The default maximum storage threshold for autoscaling is 1,000 GiB\. If you use this default, the instance doesn't autoscale above 1,000 GiB\. This is true even though the maximum allocated storage for the instance is 16,384 GiB\. - -**Note** -We recommend that you carefully choose the maximum storage threshold based on usage patterns and customer needs\. If there are any aberrations in the usage patterns, the maximum storage threshold can prevent scaling storage to an unexpectedly high value when autoscaling predicts a very high threshold\. After a DB instance has been autoscaled, its allocated storage can't be reduced\. - -**Topics** -+ [Limitations](#autoscaling-limitations) -+ [Enabling storage autoscaling for a new DB instance](#USER_PIOPS.EnablingAutoscaling) -+ [Changing the storage autoscaling settings for a DB instance](#USER_PIOPS.ModifyingAutoscaling) -+ [Turning off storage autoscaling for a DB instance](#USER_PIOPS.DisablingAutoscaling) - -### Limitations - -The following limitations apply to storage autoscaling: -+ Autoscaling doesn't occur if the maximum storage threshold would be equaled or exceeded by the storage increment\. -+ When autoscaling, RDS predicts the storage size for subsequent autoscaling operations\. If a subsequent operation is predicted to exceed the maximum storage threshold, then RDS autoscales to the maximum storage threshold\. -+ Autoscaling can't completely prevent storage\-full situations for large data loads\. This is because further storage modifications can't be made for either six \(6\) hours or until storage optimization has completed on the instance, whichever is longer\. - - If you perform a large data load, and autoscaling doesn't provide enough space, the database might remain in the storage\-full state for several hours\. This can harm the database\. -+ If you start a storage scaling operation at the same time that Amazon RDS starts an autoscaling operation, your storage modification takes precedence\. The autoscaling operation is canceled\. -+ Autoscaling can't be used with magnetic storage\. -+ Autoscaling can't be used with the following previous\-generation instance classes that have less than 6 TiB of orderable storage: db\.m3\.large, db\.m3\.xlarge, and db\.m3\.2xlarge\. -+ Autoscaling operations aren't logged by AWS CloudTrail\. For more information on CloudTrail, see [Monitoring Amazon RDS API calls in AWS CloudTrail](logging-using-cloudtrail.md)\. - -Although automatic scaling helps you to increase storage on your Amazon RDS DB instance dynamically, you should still configure the initial storage for your DB instance to an appropriate size for your typical workload\. - -### Enabling storage autoscaling for a new DB instance - -When you create a new Amazon RDS DB instance, you can choose whether to enable storage autoscaling\. You can also set an upper limit on the storage that Amazon RDS can allocate for the DB instance\. - -**Note** -When you clone an Amazon RDS DB instance that has storage autoscaling enabled, that setting isn't automatically inherited by the cloned instance\. The new DB instance has the same amount of allocated storage as the original instance\. You can turn storage autoscaling on again for the new instance if the cloned instance continues to increase its storage requirements\. - -#### Console - -**To enable storage autoscaling for a new DB instance** - -1. Sign in to the AWS Management Console and open the Amazon RDS console at [https://console\.aws\.amazon\.com/rds/](https://console.aws.amazon.com/rds/)\. - -1. In the upper\-right corner of the Amazon RDS console, choose the AWS Region where you want to create the DB instance\. - -1. In the navigation pane, choose **Databases**\. - -1. Choose **Create database**\. On the **Select engine** page, choose your database engine and specify your DB instance information as described in [Getting started with Amazon RDS](CHAP_GettingStarted.md)\. - -1. In the **Storage autoscaling** section, set the **Maximum storage threshold** value for the DB instance\. - -1. Specify the rest of your DB instance information as described in [Getting started with Amazon RDS](CHAP_GettingStarted.md)\. - -#### AWS CLI - -To enable storage autoscaling for a new DB instance, use the AWS CLI command [https://docs.aws.amazon.com/cli/latest/reference/rds/create-db-instance.html](https://docs.aws.amazon.com/cli/latest/reference/rds/create-db-instance.html)\. Set the following parameter: -+ `--max-allocated-storage` – Turns on storage autoscaling and sets the upper limit on storage size, in gibibytes\. - - To verify that Amazon RDS storage autoscaling is available for your DB instance, use the AWS CLI [https://docs.aws.amazon.com/cli/latest/reference/rds/describe-valid-db-instance-modifications.html](https://docs.aws.amazon.com/cli/latest/reference/rds/describe-valid-db-instance-modifications.html) command\. To check based on the instance class before creating an instance, use the [https://docs.aws.amazon.com/cli/latest/reference/rds/describe-orderable-db-instance-options.html](https://docs.aws.amazon.com/cli/latest/reference/rds/describe-orderable-db-instance-options.html) command\. Check the following field in the return value: -+ `SupportsStorageAutoscaling` – Indicates whether the DB instance or instance class supports storage autoscaling\. - -For more information about storage, see [Amazon RDS DB instance storage](CHAP_Storage.md)\. - -#### RDS API - -To enable storage autoscaling for a new DB instance, use the Amazon RDS API operation [https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_CreateDBInstance.html](https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_CreateDBInstance.html)\. Set the following parameter: -+ `MaxAllocatedStorage` – Turns on Amazon RDS storage autoscaling and sets the upper limit on storage size, in gibibytes\. - - To verify that Amazon RDS storage autoscaling is available for your DB instance, use the Amazon RDS API [https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_DescribeValidDbInstanceModifications.html](https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_DescribeValidDbInstanceModifications.html) operation for an existing instance, or the [https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_DescribeOrderableDBInstanceOptions.html](https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_DescribeOrderableDBInstanceOptions.html) operation before creating an instance\. Check the following field in the return value: -+ `SupportsStorageAutoscaling` – Indicates whether the DB instance supports storage autoscaling\. - -For more information about storage, see [Amazon RDS DB instance storage](CHAP_Storage.md)\. - -### Changing the storage autoscaling settings for a DB instance - -You can turn storage autoscaling on for an existing Amazon RDS DB instance\. You can also change the upper limit on the storage that Amazon RDS can allocate for the DB instance\. - -#### Console - -**To change the storage autoscaling settings for a DB instance** - -1. Sign in to the AWS Management Console and open the Amazon RDS console at [https://console\.aws\.amazon\.com/rds/](https://console.aws.amazon.com/rds/)\. - -1. In the navigation pane, choose **Databases**\. - -1. Choose the DB instance that you want to modify, and choose **Modify**\. The **Modify DB instance** page appears\. - -1. Change the storage limit in the **Autoscaling** section\. For more information, see [Modifying an Amazon RDS DB instance](Overview.DBInstance.Modifying.md)\. - -1. When all the changes are as you want them, choose **Continue** and check your modifications\. - -1. On the confirmation page, review your changes\. If they're correct, choose **Modify DB Instance** to save your changes\. If they aren't correct, choose **Back** to edit your changes or **Cancel** to cancel your changes\. - - Changing the storage autoscaling limit occurs immediately\. This setting ignores the **Apply immediately** setting\. - -#### AWS CLI - -To change the storage autoscaling settings for a DB instance, use the AWS CLI command [https://docs.aws.amazon.com/cli/latest/reference/rds/modify-db-instance.html](https://docs.aws.amazon.com/cli/latest/reference/rds/modify-db-instance.html)\. Set the following parameter: -+ `--max-allocated-storage` – Sets the upper limit on storage size, in gibibytes\. If the value is greater than the `--allocated-storage` parameter, storage autoscaling is turned on\. If the value is the same as the `--allocated-storage` parameter, storage autoscaling is turned off\. - - To verify that Amazon RDS storage autoscaling is available for your DB instance, use the AWS CLI [https://docs.aws.amazon.com/cli/latest/reference/rds/describe-valid-db-instance-modifications.html](https://docs.aws.amazon.com/cli/latest/reference/rds/describe-valid-db-instance-modifications.html) command\. To check based on the instance class before creating an instance, use the [https://docs.aws.amazon.com/cli/latest/reference/rds/describe-orderable-db-instance-options.html](https://docs.aws.amazon.com/cli/latest/reference/rds/describe-orderable-db-instance-options.html) command\. Check the following field in the return value: -+ `SupportsStorageAutoscaling` – Indicates whether the DB instance supports storage autoscaling\. - -For more information about storage, see [Amazon RDS DB instance storage](CHAP_Storage.md)\. - -#### RDS API - - To change the storage autoscaling settings for a DB instance, use the Amazon RDS API operation [https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_ModifyDBInstance.html](https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_ModifyDBInstance.html)\. Set the following parameter: -+ `MaxAllocatedStorage` – Sets the upper limit on storage size, in gibibytes\. - - To verify that Amazon RDS storage autoscaling is available for your DB instance, use the Amazon RDS API [https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_DescribeValidDbInstanceModifications.html](https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_DescribeValidDbInstanceModifications.html) operation for an existing instance, or the [https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_DescribeOrderableDBInstanceOptions.html](https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_DescribeOrderableDBInstanceOptions.html) operation before creating an instance\. Check the following field in the return value: -+ `SupportsStorageAutoscaling` – Indicates whether the DB instance supports storage autoscaling\. - -For more information about storage, see [Amazon RDS DB instance storage](CHAP_Storage.md)\. - -### Turning off storage autoscaling for a DB instance - - If you no longer need Amazon RDS to automatically increase the storage for an Amazon RDS DB instance, you can turn off storage autoscaling\. After you do, you can still manually increase the amount of storage for your DB instance\. - -#### Console - -**To turn off storage autoscaling for a DB instance** - -1. Sign in to the AWS Management Console and open the Amazon RDS console at [https://console\.aws\.amazon\.com/rds/](https://console.aws.amazon.com/rds/)\. - -1. In the navigation pane, choose **Databases**\. - -1. Choose the DB instance that you want to modify and choose **Modify**\. The **Modify DB instance** page appears\. - -1. Clear the **Enable storage autoscaling** check box in the **Storage autoscaling** section\. For more information, see [Modifying an Amazon RDS DB instance](Overview.DBInstance.Modifying.md)\. - -1. When all the changes are as you want them, choose **Continue** and check the modifications\. - -1. On the confirmation page, review your changes\. If they're correct, choose **Modify DB Instance** to save your changes\. If they aren't correct, choose **Back** to edit your changes or **Cancel** to cancel your changes\. - -Changing the storage autoscaling limit occurs immediately\. This setting ignores the **Apply immediately** setting\. - -#### AWS CLI - - To turn off storage autoscaling for a DB instance, use the AWS CLI command [https://docs.aws.amazon.com/cli/latest/reference/rds/modify-db-instance.html](https://docs.aws.amazon.com/cli/latest/reference/rds/modify-db-instance.html) and the following parameter: -+ `--max-allocated-storage` – Specify a value equal to the `--allocated-storage` setting to prevent further Amazon RDS storage autoscaling for the specified DB instance\. - -For more information about storage, see [Amazon RDS DB instance storage](CHAP_Storage.md)\. - -#### RDS API - - To turn off storage autoscaling for a DB instance, use the Amazon RDS API operation [https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_ModifyDBInstance.html](https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_ModifyDBInstance.html)\. Set the following parameter: -+ `MaxAllocatedStorage` – Specify a value equal to the `AllocatedStorage` setting to prevent further Amazon RDS storage autoscaling for the specified DB instance\. - -For more information about storage, see [Amazon RDS DB instance storage](CHAP_Storage.md)\. - -## Modifying settings for Provisioned IOPS SSD storage - -You can modify the settings for a DB instance that uses Provisioned IOPS SSD storage by using the Amazon RDS console, AWS CLI, or Amazon RDS API\. Specify the storage type, allocated storage, and the amount of Provisioned IOPS that you require\. The range depends on your database engine and instance type\. - -Although you can reduce the amount of IOPS provisioned for your instance, you can't reduce the storage size\. - -In most cases, scaling storage doesn't require any outage and doesn't degrade performance of the server\. After you modify the storage IOPS for a DB instance, the status of the DB instance is **storage\-optimization**\. - -**Note** -Storage optimization can take several hours\. You can't make further storage modifications for either six \(6\) hours or until storage optimization has completed on the instance, whichever is longer\. - -For information on the ranges of allocated storage and Provisioned IOPS available for each database engine, see [Provisioned IOPS SSD storage](CHAP_Storage.md#USER_PIOPS)\. - -### Console - -**To change the Provisioned IOPS settings for a DB instance** - -1. Sign in to the AWS Management Console and open the Amazon RDS console at [https://console\.aws\.amazon\.com/rds/](https://console.aws.amazon.com/rds/)\. - -1. In the navigation pane, choose **Databases**\. - - To filter the list of DB instances, for **Filter databases** enter a text string for Amazon RDS to use to filter the results\. Only DB instances whose names contain the string appear\. - -1. Choose the DB instance with Provisioned IOPS that you want to modify\. - -1. Choose **Modify**\. - -1. On the **Modify DB instance** page, choose **Provisioned IOPS SSD \(io1\)** for **Storage type**\. - -1. For **Provisioned IOPS**, enter a value\. - - If the value that you specify for either **Allocated storage** or **Provisioned IOPS** is outside the limits supported by the other parameter, a warning message is displayed\. This message gives the range of values required for the other parameter\. - -1. Choose **Continue**\. - -1. Choose **Apply immediately** in the **Scheduling of modifications** section to apply the changes to the DB instance immediately\. Or choose **Apply during the next scheduled maintenance window** to apply the changes during the next maintenance window\. - -1. Review the parameters to be changed, and choose **Modify DB instance** to complete the modification\. - - The new value for allocated storage or for Provisioned IOPS appears in the **Status** column\. - -### AWS CLI - -To change the Provisioned IOPS setting for a DB instance, use the AWS CLI command [https://docs.aws.amazon.com/cli/latest/reference/rds/modify-db-instance.html](https://docs.aws.amazon.com/cli/latest/reference/rds/modify-db-instance.html)\. Set the following parameters: -+ `--storage-type` – Set to `io1` for Provisioned IOPS\. -+ `--allocated-storage` – Amount of storage to be allocated for the DB instance, in gibibytes\. -+ `--iops` – The new amount of Provisioned IOPS for the DB instance, expressed in I/O operations per second\. -+ `--apply-immediately` – Use `--apply-immediately` to apply changes immediately\. Use `--no-apply-immediately` \(the default\) to apply changes during the next maintenance window\. - -### RDS API - -To change the Provisioned IOPS settings for a DB instance, use the Amazon RDS API operation [https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_ModifyDBInstance.html](https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_ModifyDBInstance.html)\. Set the following parameters: -+ `StorageType` – Set to `io1` for Provisioned IOPS\. -+ `AllocatedStorage` – Amount of storage to be allocated for the DB instance, in gibibytes\. -+ `Iops` – The new IOPS rate for the DB instance, expressed in I/O operations per second\. -+ `ApplyImmediately` – Set this option to `True` to apply changes immediately\. Set this option to `False` \(the default\) to apply changes during the next maintenance window\. - -## I/O\-intensive storage modifications - -Amazon RDS DB instances use Amazon Elastic Block Store \(EBS\) volumes for database and log storage\. Depending on the amount of storage requested, RDS \(except for RDS for SQL Server\) automatically *stripes* across multiple Amazon EBS volumes to enhance performance\. RDS DB instances with SSD storage types are backed by either one or four striped Amazon EBS volumes in a RAID 0 configuration\. By design, storage modification operations for an RDS DB instance have minimal impact on ongoing database operations\. - -In most cases, storage scaling modifications are completely offloaded to the Amazon EBS layer and are transparent to the database\. This process is typically completed within a few minutes\. However, some older RDS storage volumes require a different process for modifying the size, Provisioned IOPS, or storage type\. This involves making a full copy of the data using a potentially I/O\-intensive operation\. - -Storage modification uses an I/O\-intensive operation if any of the following factors apply: -+ The source storage type is magnetic\. Magnetic storage doesn't support elastic volume modification\. -+ The RDS DB instance isn't on a one\- or four\-volume Amazon EBS layout\. You can view the number of Amazon EBS volumes in use on your RDS DB instances by using Enhanced Monitoring metrics\. For more information, see [Viewing OS metrics in the RDS console](USER_Monitoring.OS.Viewing.md)\. -+ The target size of the modification request increases the allocated storage above 400 GiB for RDS for MariaDB, MySQL, and PostgreSQL instances, and 200 GiB for RDS for Oracle\. Storage autoscaling operations have the same effect when they increase the allocated storage size of your DB instance above these thresholds\. - -If your storage modification involves an I/O\-intensive operation, it consumes I/O resources and increases the load on your DB instance\. Storage modifications with I/O\-intensive operations involving General Purpose SSD \(gp2\) storage can deplete your I/O credit balance, resulting in longer conversion times\. - -We recommend as a best practice to schedule these storage modification requests outside of peak hours to help reduce the time required to complete the storage modification operation\. Alternatively, you can create a read replica of the DB instance and perform the storage modification on the read replica\. Then promote the read replica to be the primary DB instance\. For more information, see [Working with DB instance read replicas](USER_ReadRepl.md)\. - -For more information, see [Why is an Amazon RDS DB instance stuck in the modifying state when I try to increase the allocated storage?](https://aws.amazon.com/premiumsupport/knowledge-center/rds-stuck-modifying/) - -## Modifying settings for General Purpose SSD \(gp3\) storage - -You can modify the settings for a DB instance that uses General Purpose SSD \(gp3\) storage by using the Amazon RDS console, AWS CLI, or Amazon RDS API\. Specify the storage type, allocated storage, amount of Provisioned IOPS, and storage throughput that you require\. Although you can reduce the amount of IOPS provisioned for your instance, you can't reduce the storage size\. - -In most cases, scaling storage doesn't require any outage\. After you modify the storage IOPS for a DB instance, the status of the DB instance is **storage\-optimization**\. You can expect elevated latencies, but still within the single\-digit millisecond range, during storage optimization\. The DB instance is fully operational after a storage modification\. - -**Note** -You can't make further storage modifications until six \(6\) hours after storage optimization has completed on the instance\. - -For information on the ranges of allocated storage, Provisioned IOPS, and storage throughput available for each database engine, see [gp3 storage](CHAP_Storage.md#gp3-storage)\. - -### Console - -**To change the storage performance settings for a DB instance** - -1. Sign in to the AWS Management Console and open the Amazon RDS console at [https://console\.aws\.amazon\.com/rds/](https://console.aws.amazon.com/rds/)\. - -1. In the navigation pane, choose **Databases**\. - - To filter the list of DB instances, for **Filter databases** enter a text string for Amazon RDS to use to filter the results\. Only DB instances whose names contain the string appear\. - -1. Choose the DB instance with gp3 storage that you want to modify\. - -1. Choose **Modify**\. - -1. On the **Modify DB Instance page**, choose **General Purpose SSD \(gp3\)** for **Storage type**, then do the following: - - 1. For **Provisioned IOPS**, choose a value\. - - If the value that you specify for either **Allocated storage** or **Provisioned IOPS** is outside the limits supported by the other parameter, a warning message appears\. This message gives the range of values required for the other parameter\. - - 1. For **Storage throughput**, choose a value\. - - If the value that you specify for either **Provisioned IOPS** or **Storage throughput** is outside the limits supported by the other parameter, a warning message appears\. This message gives the range of values required for the other parameter\. - -1. Choose **Continue**\. - -1. Choose **Apply immediately** in the **Scheduling of modifications** section to apply the changes to the DB instance immediately\. Or choose **Apply during the next scheduled maintenance window** to apply the changes during the next maintenance window\. - -1. Review the parameters to be changed, and choose **Modify DB instance** to complete the modification\. - - The new value for Provisioned IOPS appears in the **Status** column\. - -### AWS CLI - -To change the storage performance settings for a DB instance, use the AWS CLI command [https://docs.aws.amazon.com/cli/latest/reference/rds/modify-db-instance.html](https://docs.aws.amazon.com/cli/latest/reference/rds/modify-db-instance.html)\. Set the following parameters: -+ `--storage-type` – Set to `gp3` for General Purpose SSD \(gp3\)\. -+ `--allocated-storage` – Amount of storage to be allocated for the DB instance, in gibibytes\. -+ `--iops` – The new amount of Provisioned IOPS for the DB instance, expressed in I/O operations per second\. -+ `--storage-throughput` – The new storage throughput for the DB instance, expressed in MiBps\. -+ `--apply-immediately` – Use `--apply-immediately` to apply changes immediately\. Use `--no-apply-immediately` \(the default\) to apply changes during the next maintenance window\. - -### RDS API - -To change the storage performance settings for a DB instance, use the Amazon RDS API operation [https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_ModifyDBInstance.html](https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_ModifyDBInstance.html)\. Set the following parameters: -+ `StorageType` – Set to `gp3` for General Purpose SSD \(gp3\)\. -+ `AllocatedStorage` – Amount of storage to be allocated for the DB instance, in gibibytes\. -+ `Iops` – The new IOPS rate for the DB instance, expressed in I/O operations per second\. -+ `StorageThroughput` – The new storage throughput for the DB instance, expressed in MiBps\. -+ `ApplyImmediately` – Set this option to `True` to apply changes immediately\. Set this option to `False` \(the default\) to apply changes during the next maintenance window\. \ No newline at end of file diff --git a/doc_source/USER_PIT.MultiAZDBCluster.md b/doc_source/USER_PIT.MultiAZDBCluster.md deleted file mode 100644 index 4c8ab3a..0000000 --- a/doc_source/USER_PIT.MultiAZDBCluster.md +++ /dev/null @@ -1,82 +0,0 @@ -# Restoring a Multi\-AZ DB cluster to a specified time - -You can restore a Multi\-AZ DB cluster to a specific point in time, creating a new Multi\-AZ DB cluster\. - -RDS uploads transaction logs for Multi\-AZ DB clusters to Amazon S3 continuously\. You can restore to any point in time within your backup retention period\. To see the earliest restorable time for a Multi\-AZ DB cluster, use the AWS CLI [describe\-db\-clusters](https://docs.aws.amazon.com/cli/latest/reference/rds/describe-db-clusters.html) command\. Look at the value returned in the `EarliestRestorableTime` field for the DB cluster\. To see the latest restorable time for a Multi\-AZ DB cluster, look at the value returned in the `LatestRestorableTime` field for the DB cluster\. - -When you restore a Multi\-AZ DB cluster to a point in time, you can choose the default VPC security group for your Multi\-AZ DB cluster\. Or you can apply a custom VPC security group to your Multi\-AZ DB cluster\. - -Restored Multi\-AZ DB clusters are automatically associated with the default DB cluster parameter group\. However, you can apply a customer DB cluster parameter group by specifying it during a restore\. - -If the source DB instance has resource tags, RDS adds the latest tags to the restored DB instance\. - -**Note** -We recommend that you restore to the same or similar Multi\-AZ DB cluster size as the source DB cluster\. We also recommend that you restore with the same or similar IOPS value if you're using Provisioned IOPS storage\. You might get an error if, for example, you choose a DB cluster size with an incompatible IOPS value\. - -You can restore a Multi\-AZ DB cluster to a point in time using the AWS Management Console, the AWS CLI, or the RDS API\. - -## Console - -**To restore a Multi\-AZ DB cluster to a specified time** - -1. Sign in to the AWS Management Console and open the Amazon RDS console at [https://console\.aws\.amazon\.com/rds/](https://console.aws.amazon.com/rds/)\. - -1. In the navigation pane, choose **Databases**\. - -1. Choose the Multi\-AZ DB cluster that you want to restore\. - -1. For **Actions**, choose **Restore to point in time**\. - - The **Restore to point in time** window appears\. - -1. Choose **Latest restorable time** to restore to the latest possible time, or choose **Custom** to choose a time\. - - If you chose **Custom**, enter the date and time to which you want to restore the Multi\-AZ DB cluster\. -**Note** -Times are shown in your local time zone, which is indicated by an offset from Coordinated Universal Time \(UTC\)\. For example, UTC\-5 is Eastern Standard Time/Central Daylight Time\. - -1. For **DB cluster identifier**, enter the name for your restored Multi\-AZ DB cluster\. - -1. In **Availability and durability**, choose **Multi\-AZ DB cluster**\. -![\[Multi-AZ DB cluster choice\]](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/images/multi-az-db-cluster-create.png) - -1. In **DB instance class**, choose a DB instance class\. - - Currently, Multi\-AZ DB clusters only support db\.m6gd and db\.r6gd DB instance classes\. For more information about DB instance classes, see [DB instance classes](Concepts.DBInstanceClass.md)\. - -1. For the remaining sections, specify your DB cluster settings\. For information about each setting, see [Settings for creating Multi\-AZ DB clusters](create-multi-az-db-cluster.md#create-multi-az-db-cluster-settings)\. - -1. Choose **Restore to point in time**\. - -## AWS CLI - -To restore a Multi\-AZ DB cluster to a specified time, use the AWS CLI command [ restore\-db\-cluster\-to\-point\-in\-time](https://docs.aws.amazon.com/cli/latest/reference/rds/restore-db-cluster-to-point-in-time.html) to create a new Multi\-AZ DB cluster\. - -Currently, Multi\-AZ DB clusters only support db\.m6gd and db\.r6gd DB instance classes\. For more information about DB instance classes, see [DB instance classes](Concepts.DBInstanceClass.md)\. - -**Example** -For Linux, macOS, or Unix: - -``` -1. aws rds restore-db-cluster-to-point-in-time \ -2. --source-db-cluster-identifier mysourcemultiazdbcluster \ -3. --db-cluster-identifier mytargetmultiazdbcluster \ -4. --restore-to-time 2021-08-14T23:45:00.000Z \ -5. --db-cluster-instance-class db.r6gd.xlarge -``` -For Windows: - -``` -1. aws rds restore-db-cluster-to-point-in-time ^ -2. --source-db-cluster-identifier mysourcemultiazdbcluster ^ -3. --db-cluster-identifier mytargetmultiazdbcluster ^ -4. --restore-to-time 2021-08-14T23:45:00.000Z ^ -5. --db-cluster-instance-class db.r6gd.xlarge -``` - -## RDS API - -To restore a DB cluster to a specified time, call the Amazon RDS API [RestoreDBClusterToPointInTime](https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_RestoreDBClusterToPointInTime.html) operation with the following parameters: -+ `SourceDBClusterIdentifier` -+ `DBClusterIdentifier` -+ `RestoreToTime` \ No newline at end of file diff --git a/doc_source/USER_PIT.md b/doc_source/USER_PIT.md deleted file mode 100644 index 53a8281..0000000 --- a/doc_source/USER_PIT.md +++ /dev/null @@ -1,101 +0,0 @@ -# Restoring a DB instance to a specified time - -You can restore a DB instance to a specific point in time, creating a new DB instance\. - -When you restore a DB instance to a point in time, you can choose the default virtual private cloud \(VPC\) security group\. Or you can apply a custom VPC security group to your DB instance\. - -Restored DB instances are automatically associated with the default DB parameter and option groups\. However, you can apply a custom parameter group and option group by specifying them during a restore\. - -If the source DB instance has resource tags, RDS adds the latest tags to the restored DB instance\. - -RDS uploads transaction logs for DB instances to Amazon S3 every five minutes\. To see the latest restorable time for a DB instance, use the AWS CLI [describe\-db\-instances](https://docs.aws.amazon.com/cli/latest/reference/rds/describe-db-instances.html) command and look at the value returned in the `LatestRestorableTime` field for the DB instance\. To see the latest restorable time for each DB instance in the Amazon RDS console, choose **Automated backups**\. - -You can restore to any point in time within your backup retention period\. To see the earliest restorable time for each DB instance, choose **Automated backups** in the Amazon RDS console\. - -![\[Automated backups\]](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/images/automated-backups.png) - -**Note** -We recommend that you restore to the same or similar DB instance size—and IOPS if using Provisioned IOPS storage—as the source DB instance\. You might get an error if, for example, you choose a DB instance size with an incompatible IOPS value\. - -Some of the database engines used by Amazon RDS have special considerations when restoring from a point in time: -+ When you restore an Oracle DB instance to a point in time, you can specify a different Oracle DB engine, license model, and DBName \(SID\) to be used by the new DB instance\. -+ When you restore a Microsoft SQL Server DB instance to a point in time, each database within that instance is restored to a point in time within 1 second of each other database within the instance\. Transactions that span multiple databases within the instance might be restored inconsistently\. -+ For a SQL Server DB instance, the `OFFLINE`, `EMERGENCY`, and `SINGLE_USER` modes aren't supported\. Setting any database into one of these modes causes the latest restorable time to stop moving ahead for the whole instance\. -+ Some actions, such as changing the recovery model of a SQL Server database, can break the sequence of logs that are used for point\-in\-time recovery\. In some cases, Amazon RDS can detect this issue and the latest restorable time is prevented from moving forward\. In other cases, such as when a SQL Server database uses the `BULK_LOGGED` recovery model, the break in log sequence isn't detected\. It might not be possible to restore a SQL Server DB instance to a point in time if there is a break in the log sequence\. For these reasons, Amazon RDS doesn't support changing the recovery model of SQL Server databases\. - -You can also use AWS Backup to manage backups of Amazon RDS DB instances\. If your DB instance is associated with a backup plan in AWS Backup, that backup plan is used for point\-in\-time recovery\. Backups that were created with AWS Backup have names ending in `awsbackup:AWS-Backup-job-number`\. For information about AWS Backup, see the [https://docs.aws.amazon.com/aws-backup/latest/devguide](https://docs.aws.amazon.com/aws-backup/latest/devguide)\. - -**Note** -Information in this topic applies to Amazon RDS\. For information on restoring an Amazon Aurora DB cluster, see [Restoring a DB cluster to a specified time](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/aurora-pitr.html)\. - -You can restore a DB instance to a point in time using the AWS Management Console, the AWS CLI, or the RDS API\. - -**Note** -You can't reduce the amount of storage when you restore a DB instance\. When you increase the allocated storage, it must be by at least 10 percent\. If you try to increase the value by less than 10 percent, you get an error\. You can't increase the allocated storage when restoring RDS for SQL Server DB instances\. - -## Console - -**To restore a DB instance to a specified time** - -1. Sign in to the AWS Management Console and open the Amazon RDS console at [https://console\.aws\.amazon\.com/rds/](https://console.aws.amazon.com/rds/)\. - -1. In the navigation pane, choose **Automated backups**\. - - The automated backups are displayed on the **Current Region** tab\. - -1. Choose the DB instance that you want to restore\. - -1. For **Actions**, choose **Restore to point in time**\. - - The **Restore to point in time** window appears\. - -1. Choose **Latest restorable time** to restore to the latest possible time, or choose **Custom** to choose a time\. - - If you chose **Custom**, enter the date and time to which you want to restore the instance\. -**Note** -Times are shown in your local time zone, which is indicated by an offset from Coordinated Universal Time \(UTC\)\. For example, UTC\-5 is Eastern Standard Time/Central Daylight Time\. - -1. For **DB instance identifier**, enter the name of the target restored DB instance\. The name must be unique\. - -1. Choose other options as needed, such as DB instance class, storage, and whether you want to use storage autoscaling\. - - For information about each setting, see [Settings for DB instances](USER_CreateDBInstance.md#USER_CreateDBInstance.Settings)\. - -1. Choose **Restore to point in time**\. - -## AWS CLI - -To restore a DB instance to a specified time, use the AWS CLI command [restore\-db\-instance\-to\-point\-in\-time](https://docs.aws.amazon.com/cli/latest/reference/rds/restore-db-instance-to-point-in-time.html) to create a new DB instance\. This example also sets the allocated storage size and enables storage autoscaling\. - -Resource tagging is supported for this operation\. When you use the `--tags` option, the source DB instance tags are ignored and the provided ones are used\. Otherwise, the latest tags from the source instance are used\. - -You can specify other settings\. For information about each setting, see [Settings for DB instances](USER_CreateDBInstance.md#USER_CreateDBInstance.Settings)\. - -**Example** -For Linux, macOS, or Unix: - -``` -1. aws rds restore-db-instance-to-point-in-time \ -2. --source-db-instance-identifier mysourcedbinstance \ -3. --target-db-instance-identifier mytargetdbinstance \ -4. --restore-time 2017-10-14T23:45:00.000Z \ -5. --allocated-storage 100 \ -6. --max-allocated-storage 1000 -``` -For Windows: - -``` -1. aws rds restore-db-instance-to-point-in-time ^ -2. --source-db-instance-identifier mysourcedbinstance ^ -3. --target-db-instance-identifier mytargetdbinstance ^ -4. --restore-time 2017-10-14T23:45:00.000Z ^ -5. --allocated-storage 100 ^ -6. --max-allocated-storage 1000 -``` - -## RDS API - -To restore a DB instance to a specified time, call the Amazon RDS API [https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_RestoreDBInstanceToPointInTime.html](https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_RestoreDBInstanceToPointInTime.html) operation with the following parameters: -+ `SourceDBInstanceIdentifier` -+ `TargetDBInstanceIdentifier` -+ `RestoreTime` \ No newline at end of file diff --git a/doc_source/USER_ParamValuesRef.md b/doc_source/USER_ParamValuesRef.md deleted file mode 100644 index 8402b12..0000000 --- a/doc_source/USER_ParamValuesRef.md +++ /dev/null @@ -1,217 +0,0 @@ -# Specifying DB parameters - -DB parameter types include the following: -+ Integer -+ Boolean -+ String -+ Long -+ Double -+ Timestamp -+ Object of other defined data types -+ Array of values of type integer, Boolean, string, long, double, timestamp, or object - -You can also specify integer and Boolean parameters using expressions, formulas, and functions\. - -For the Oracle engine, you can use the `DBInstanceClassHugePagesDefault` formula variable to specify a Boolean DB parameter\. See [DB parameter formula variables](#USER_FormulaVariables)\. - -For the PostgreSQL engine, you can use an expression to specify a Boolean DB parameter\. See [Boolean DB parameter expressions](#USER_ParamBooleanExpressions)\. - -**Contents** -+ [DB parameter formulas](#USER_ParamFormulas) - + [DB parameter formula variables](#USER_FormulaVariables) - + [DB parameter formula operators](#USER_FormulaOperators) -+ [DB parameter functions](#USER_ParamFunctions) -+ [Boolean DB parameter expressions](#USER_ParamBooleanExpressions) -+ [DB parameter log expressions](#USER_ParamLogExpressions) -+ [DB parameter value examples](#USER_ParamValueExamples) - -## DB parameter formulas - -A DB parameter formula is an expression that resolves to an integer value or a Boolean value\. You enclose the expression in braces: \{\}\. You can use a formula for either a DB parameter value or as an argument to a DB parameter function\. - -**Syntax** - -``` -{FormulaVariable} -{FormulaVariable*Integer} -{FormulaVariable*Integer/Integer} -{FormulaVariable/Integer} -``` - -### DB parameter formula variables - -Each formula variable returns an integer or a Boolean value\. The names of the variables are case\-sensitive\. - -*AllocatedStorage* -Returns an integer representing the size, in bytes, of the data volume\. - -*DBInstanceClassHugePagesDefault* -Returns a Boolean value\. Currently, it's only supported for Oracle engines\. -For more information, see [Turning on HugePages for an RDS for Oracle instance](Oracle.Concepts.HugePages.md)\. - -*DBInstanceClassMemory* - Returns an integer for the number of bytes of memory available to the database process\. This number is internally calculated by starting with the total amount of memory for the DB instance class\. From this, the calculation subtracts memory reserved for the operating system and the RDS processes that manage the instance\. Therefore, the number is always somewhat lower than the memory figures shown in the instance class tables in [DB instance classes](Concepts.DBInstanceClass.md)\. The exact value depends on a combination of factors\. These include instance class, DB engine, and whether it applies to an RDS instance or an instance that's part of an Aurora cluster\. - -*DBInstanceVCPU* -Returns an integer representing the number of virtual central processing units \(vCPUs\) used by Amazon RDS to manage the instance\. Currently, it's only supported for the PostgreSQL engine\. - -*EndPointPort* -Returns an integer representing the port used when connecting to the DB instance\. - -### DB parameter formula operators - -DB parameter formulas support two operators: division and multiplication\. - -*Division operator: /* -Divides the dividend by the divisor, returning an integer quotient\. Decimals in the quotient are truncated, not rounded\. -Syntax - -``` -dividend / divisor -``` -The dividend and divisor arguments must be integer expressions\. - -*Multiplication operator: \** -Multiplies the expressions, returning the product of the expressions\. Decimals in the expressions are truncated, not rounded\. -Syntax - -``` -expression * expression -``` -Both expressions must be integers\. - -## DB parameter functions - -You specify the arguments of DB parameter functions as either integers or formulas\. Each function must have at least one argument\. Specify multiple arguments as a comma\-separated list\. The list can't have any empty members, such as *argument1*,,*argument3*\. Function names are case\-insensitive\. - -*IF* -Returns an argument\. -Currently, it's only supported for Oracle engines, and the only supported first argument is `{DBInstanceClassHugePagesDefault}`\. For more information, see [Turning on HugePages for an RDS for Oracle instance](Oracle.Concepts.HugePages.md)\. -Syntax - -``` -IF(argument1, argument2, argument3) -``` -Returns the second argument if the first argument evaluates to true\. Returns the third argument otherwise\. - -*GREATEST* -Returns the largest value from a list of integers or parameter formulas\. -Syntax - -``` -GREATEST(argument1, argument2,...argumentn) -``` -Returns an integer\. - -*LEAST* -Returns the smallest value from a list of integers or parameter formulas\. -Syntax - -``` -LEAST(argument1, argument2,...argumentn) -``` -Returns an integer\. - -*SUM* -Adds the values of the specified integers or parameter formulas\. -Syntax - -``` -SUM(argument1, argument2,...argumentn) -``` -Returns an integer\. - -## Boolean DB parameter expressions - -A Boolean DB parameter expression resolves to a Boolean value of 1 or 0\. The expression is enclosed in quotation marks\. - -**Note** -Boolean DB parameter expressions are only supported for the PostgreSQL engine\. - -**Syntax** - -``` -"expression operator expression" -``` -Both expressions must resolve to integers\. An expression can be the following: -+ integer constant -+ DB parameter formula -+ DB parameter function -+ DB parameter variable - -Boolean DB parameter expressions support the following inequality operators: - -*The greater than operator: >* -Syntax - -``` -"expression > expression" -``` - -*The less than operator: <* -Syntax - -``` -"expression < expression" -``` - -* The greater than or equal to operators: >=, =>* -Syntax - -``` -"expression >= expression" -"expression => expression" -``` - -*The less than or equal to operators: <=, =<* -Syntax - -``` -"expression <= expression" -"expression =< expression" -``` - -**Example using a Boolean DB parameter expression** -The following Boolean DB parameter expression example compares the result of a parameter formula with an integer\. It does so to modify the Boolean DB parameter `wal_compression` for a PostgreSQL DB instance\. The parameter expression compares the number of vCPUs with the value 2\. If the number of vCPUs is greater than 2, then the `wal_compression` DB parameter is set to true\. - -``` -aws rds modify-db-parameter-group --db-parameter-group-name group-name \ ---parameters "ParameterName=wal_compression,ParameterValue=\"{DBInstanceVCPU} > 2\" " -``` - -## DB parameter log expressions - -You can set an integer DB parameter value to a log expression\. You enclose the expression in braces: \{\}\. For example: - -``` -{log(DBInstanceClassMemory/8187281418)*1000} -``` - -The `log` function represents log base 2\. This example also uses the `DBInstanceClassMemory` formula variable\. See [DB parameter formula variables](#USER_FormulaVariables)\. - -**Note** -Currently, you can't specify the MySQL `innodb_log_file_size` parameter with any value other than an integer\. - -## DB parameter value examples - -These examples show using formulas, functions, and expressions for the values of DB parameters\. - -**Note** -DB Parameter functions are currently supported only in the console and aren't supported in the AWS CLI\. - -**Warning** -Improperly setting parameters in a DB parameter group can have unintended adverse effects\. These might include degraded performance and system instability\. Use caution when modifying database parameters and back up your data before modifying your DB parameter group\. Try out parameter group changes on a test DB instance, created using point\-in\-time\-restores, before applying those parameter group changes to your production DB instances\. - -**Example using the DB parameter function GREATEST** -You can specify the `GREATEST` function in an Oracle processes parameter\. Use it to set the number of user processes to the larger of either 80 or `DBInstanceClassMemory` divided by 9,868,951\. - -``` -GREATEST({DBInstanceClassMemory/9868951},80) -``` - -**Example using the DB parameter function LEAST** -You can specify the `LEAST` function in a MySQL `max_binlog_cache_size` parameter value\. Use it to set the maximum cache size a transaction can use in a MySQL instance to the lesser of 1 MB or `DBInstanceClass`/256\. - -``` -LEAST({DBInstanceClassMemory/256},10485760) -``` \ No newline at end of file diff --git a/doc_source/USER_PerfInsights.API.md b/doc_source/USER_PerfInsights.API.md deleted file mode 100644 index 3d1f1bd..0000000 --- a/doc_source/USER_PerfInsights.API.md +++ /dev/null @@ -1,655 +0,0 @@ -# Retrieving metrics with the Performance Insights API - -When Performance Insights is enabled, the API provides visibility into instance performance\. Amazon CloudWatch Logs provides the authoritative source for vended monitoring metrics for AWS services\. - -Performance Insights offers a domain\-specific view of database load measured as average active sessions \(AAS\)\. This metric appears to API consumers as a two\-dimensional time\-series dataset\. The time dimension of the data provides DB load data for each time point in the queried time range\. Each time point decomposes overall load in relation to the requested dimensions, such as `SQL`, `Wait-event`, `User`, or `Host`, measured at that time point\. - -Amazon RDS Performance Insights monitors your Amazon RDS DB instance so that you can analyze and troubleshoot database performance\. One way to view Performance Insights data is in the AWS Management Console\. Performance Insights also provides a public API so that you can query your own data\. You can use the API to do the following: -+ Offload data into a database -+ Add Performance Insights data to existing monitoring dashboards -+ Build monitoring tools - -To use the Performance Insights API, enable Performance Insights on one of your Amazon RDS DB instances\. For information about enabling Performance Insights, see [Turning Performance Insights on and off](USER_PerfInsights.Enabling.md)\. For more information about the Performance Insights API, see the [Amazon RDS Performance Insights API Reference](https://docs.aws.amazon.com/performance-insights/latest/APIReference/Welcome.html)\. - -The Performance Insights API provides the following operations\. - - -**** - -| Performance Insights action | AWS CLI command | Description | -| --- | --- | --- | -| [https://docs.aws.amazon.com/performance-insights/latest/APIReference/API_DescribeDimensionKeys.html](https://docs.aws.amazon.com/performance-insights/latest/APIReference/API_DescribeDimensionKeys.html) | [https://docs.aws.amazon.com/cli/latest/reference/pi/describe-dimension-keys.html](https://docs.aws.amazon.com/cli/latest/reference/pi/describe-dimension-keys.html) | Retrieves the top N dimension keys for a metric for a specific time period\. | -| [https://docs.aws.amazon.com/performance-insights/latest/APIReference/API_GetDimensionKeyDetails.html](https://docs.aws.amazon.com/performance-insights/latest/APIReference/API_GetDimensionKeyDetails.html) | [https://docs.aws.amazon.com/cli/latest/reference/pi/get-dimension-key-details.html](https://docs.aws.amazon.com/cli/latest/reference/pi/get-dimension-key-details.html) | Retrieves the attributes of the specified dimension group for a DB instance or data source\. For example, if you specify a SQL ID, and if the dimension details are available, `GetDimensionKeyDetails` retrieves the full text of the dimension `db.sql.statement` associated with this ID\. This operation is useful because `GetResourceMetrics` and `DescribeDimensionKeys` don't support retrieval of large SQL statement text\. | -| [GetResourceMetadata](https://docs.aws.amazon.com/performance-insights/latest/APIReference/API_GetResourceMetadata.html) | [https://docs.aws.amazon.com/cli/latest/reference/pi/get-resource-metadata.html](https://docs.aws.amazon.com/cli/latest/reference/pi/get-resource-metadata.html) | Retrieve the metadata for different features\. For example, the metadata might indicate that a feature is turned on or off on a specific DB instance\. | -| [https://docs.aws.amazon.com/performance-insights/latest/APIReference/API_GetResourceMetrics.html](https://docs.aws.amazon.com/performance-insights/latest/APIReference/API_GetResourceMetrics.html) | [https://docs.aws.amazon.com/cli/latest/reference/pi/get-resource-metrics.html](https://docs.aws.amazon.com/cli/latest/reference/pi/get-resource-metrics.html) | Retrieves Performance Insights metrics for a set of data sources over a time period\. You can provide specific dimension groups and dimensions, and provide aggregation and filtering criteria for each group\. | -| [ListAvailableResourceDimensions](https://docs.aws.amazon.com/performance-insights/latest/APIReference/API_ListAvailableResourceDimensions.html) | [https://docs.aws.amazon.com/cli/latest/reference/pi/list-available-resource-dimensions.html](https://docs.aws.amazon.com/cli/latest/reference/pi/list-available-resource-dimensions.html) | Retrieve the dimensions that can be queried for each specified metric type on a specified instance\. | -| [ListAvailableResourceMetrics](https://docs.aws.amazon.com/performance-insights/latest/APIReference/API_ListAvailableResourceMetrics.html) | [https://docs.aws.amazon.com/cli/latest/reference/pi/list-available-resource-metrics.html](https://docs.aws.amazon.com/cli/latest/reference/pi/list-available-resource-metrics.html) | Retrieve all available metrics of the specified metric types that can be queried for a specified DB instance\. | - -**Topics** -+ [AWS CLI for Performance Insights](#USER_PerfInsights.API.CLI) -+ [Retrieving time\-series metrics](#USER_PerfInsights.API.TimeSeries) -+ [AWS CLI examples for Performance Insights](#USER_PerfInsights.API.Examples) - -## AWS CLI for Performance Insights - -You can view Performance Insights data using the AWS CLI\. You can view help for the AWS CLI commands for Performance Insights by entering the following on the command line\. - -``` -aws pi help -``` - -If you don't have the AWS CLI installed, see [Installing the AWS Command Line Interface](https://docs.aws.amazon.com/cli/latest/userguide/installing.html) in the *AWS CLI User Guide *for information about installing it\. - -## Retrieving time\-series metrics - -The `GetResourceMetrics` operation retrieves one or more time\-series metrics from the Performance Insights data\. `GetResourceMetrics` requires a metric and time period, and returns a response with a list of data points\. - -For example, the AWS Management Console uses `GetResourceMetrics` to populate the **Counter Metrics** chart and the **Database Load** chart, as seen in the following image\. - -![\[Counter Metrics and Database Load charts\]](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/./images/perf-insights-api-charts.png) - -All metrics returned by `GetResourceMetrics` are standard time\-series metrics, with the exception of `db.load`\. This metric is displayed in the **Database Load** chart\. The `db.load` metric is different from the other time\-series metrics because you can break it into subcomponents called *dimensions*\. In the previous image, `db.load` is broken down and grouped by the waits states that make up the `db.load`\. - -**Note** -`GetResourceMetrics` can also return the `db.sampleload` metric, but the `db.load` metric is appropriate in most cases\. - -For information about the counter metrics returned by `GetResourceMetrics`, see [Performance Insights counter metrics](USER_PerfInsights_Counters.md)\. - -The following calculations are supported for the metrics: -+ Average – The average value for the metric over a period of time\. Append `.avg` to the metric name\. -+ Minimum – The minimum value for the metric over a period of time\. Append `.min` to the metric name\. -+ Maximum – The maximum value for the metric over a period of time\. Append `.max` to the metric name\. -+ Sum – The sum of the metric values over a period of time\. Append `.sum` to the metric name\. -+ Sample count – The number of times the metric was collected over a period of time\. Append `.sample_count` to the metric name\. - -For example, assume that a metric is collected for 300 seconds \(5 minutes\), and that the metric is collected one time each minute\. The values for each minute are 1, 2, 3, 4, and 5\. In this case, the following calculations are returned: -+ Average – 3 -+ Minimum – 1 -+ Maximum – 5 -+ Sum – 15 -+ Sample count – 5 - -For information about using the `get-resource-metrics` AWS CLI command, see [https://docs.aws.amazon.com/cli/latest/reference/pi/get-resource-metrics.html](https://docs.aws.amazon.com/cli/latest/reference/pi/get-resource-metrics.html)\. - -For the `--metric-queries` option, specify one or more queries that you want to get results for\. Each query consists of a mandatory `Metric` and optional `GroupBy` and `Filter` parameters\. The following is an example of a `--metric-queries` option specification\. - -``` -{ - "Metric": "string", - "GroupBy": { - "Group": "string", - "Dimensions": ["string", ...], - "Limit": integer - }, - "Filter": {"string": "string" - ...} -``` - -## AWS CLI examples for Performance Insights - -The following examples show how to use the AWS CLI for Performance Insights\. - -**Topics** -+ [Retrieving counter metrics](#USER_PerfInsights.API.Examples.CounterMetrics) -+ [Retrieving the DB load average for top wait events](#USER_PerfInsights.API.Examples.DBLoadAverage) -+ [Retrieving the DB load average for top SQL](#USER_PerfInsights.API.Examples.DBLoadAverageTop10SQL) -+ [Retrieving the DB load average filtered by SQL](#USER_PerfInsights.API.Examples.DBLoadAverageFilterBySQL) -+ [Retrieving the full text of a SQL statement](#USER_PerfInsights.API.Examples.GetDimensionKeyDetails) - -### Retrieving counter metrics - -The following screenshot shows two counter metrics charts in the AWS Management Console\. - -![\[Counter Metrics charts.\]](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/./images/perf-insights-api-counters-charts.png) - -The following example shows how to gather the same data that the AWS Management Console uses to generate the two counter metric charts\. - -For Linux, macOS, or Unix: - -``` -aws pi get-resource-metrics \ - --service-type RDS \ - --identifier db-ID \ - --start-time 2018-10-30T00:00:00Z \ - --end-time 2018-10-30T01:00:00Z \ - --period-in-seconds 60 \ - --metric-queries '[{"Metric": "os.cpuUtilization.user.avg" }, - {"Metric": "os.cpuUtilization.idle.avg"}]' -``` - -For Windows: - -``` -aws pi get-resource-metrics ^ - --service-type RDS ^ - --identifier db-ID ^ - --start-time 2018-10-30T00:00:00Z ^ - --end-time 2018-10-30T01:00:00Z ^ - --period-in-seconds 60 ^ - --metric-queries '[{"Metric": "os.cpuUtilization.user.avg" }, - {"Metric": "os.cpuUtilization.idle.avg"}]' -``` - -You can also make a command easier to read by specifying a file for the `--metrics-query` option\. The following example uses a file called query\.json for the option\. The file has the following contents\. - -``` -[ - { - "Metric": "os.cpuUtilization.user.avg" - }, - { - "Metric": "os.cpuUtilization.idle.avg" - } -] -``` - -Run the following command to use the file\. - -For Linux, macOS, or Unix: - -``` -aws pi get-resource-metrics \ - --service-type RDS \ - --identifier db-ID \ - --start-time 2018-10-30T00:00:00Z \ - --end-time 2018-10-30T01:00:00Z \ - --period-in-seconds 60 \ - --metric-queries file://query.json -``` - -For Windows: - -``` -aws pi get-resource-metrics ^ - --service-type RDS ^ - --identifier db-ID ^ - --start-time 2018-10-30T00:00:00Z ^ - --end-time 2018-10-30T01:00:00Z ^ - --period-in-seconds 60 ^ - --metric-queries file://query.json -``` - -The preceding example specifies the following values for the options: -+ `--service-type` – `RDS` for Amazon RDS -+ `--identifier` – The resource ID for the DB instance -+ `--start-time` and `--end-time` – The ISO 8601 `DateTime` values for the period to query, with multiple supported formats - -It queries for a one\-hour time range: -+ `--period-in-seconds` – `60` for a per\-minute query -+ `--metric-queries` – An array of two queries, each just for one metric\. - - The metric name uses dots to classify the metric in a useful category, with the final element being a function\. In the example, the function is `avg` for each query\. As with Amazon CloudWatch, the supported functions are `min`, `max`, `total`, and `avg`\. - -The response looks similar to the following\. - -``` -{ - "Identifier": "db-XXX", - "AlignedStartTime": 1540857600.0, - "AlignedEndTime": 1540861200.0, - "MetricList": [ - { //A list of key/datapoints - "Key": { - "Metric": "os.cpuUtilization.user.avg" //Metric1 - }, - "DataPoints": [ - //Each list of datapoints has the same timestamps and same number of items - { - "Timestamp": 1540857660.0, //Minute1 - "Value": 4.0 - }, - { - "Timestamp": 1540857720.0, //Minute2 - "Value": 4.0 - }, - { - "Timestamp": 1540857780.0, //Minute 3 - "Value": 10.0 - } - //... 60 datapoints for the os.cpuUtilization.user.avg metric - ] - }, - { - "Key": { - "Metric": "os.cpuUtilization.idle.avg" //Metric2 - }, - "DataPoints": [ - { - "Timestamp": 1540857660.0, //Minute1 - "Value": 12.0 - }, - { - "Timestamp": 1540857720.0, //Minute2 - "Value": 13.5 - }, - //... 60 datapoints for the os.cpuUtilization.idle.avg metric - ] - } - ] //end of MetricList -} //end of response -``` - -The response has an `Identifier`, `AlignedStartTime`, and `AlignedEndTime`\. B the `--period-in-seconds` value was `60`, the start and end times have been aligned to the minute\. If the `--period-in-seconds` was `3600`, the start and end times would have been aligned to the hour\. - -The `MetricList` in the response has a number of entries, each with a `Key` and a `DataPoints` entry\. Each `DataPoint` has a `Timestamp` and a `Value`\. Each `Datapoints` list has 60 data points because the queries are for per\-minute data over an hour, with `Timestamp1/Minute1`, `Timestamp2/Minute2`, and so on, up to `Timestamp60/Minute60`\. - -Because the query is for two different counter metrics, there are two elements in the response `MetricList`\. - -### Retrieving the DB load average for top wait events - -The following example is the same query that the AWS Management Console uses to generate a stacked area line graph\. This example retrieves the `db.load.avg` for the last hour with load divided according to the top seven wait events\. The command is the same as the command in [Retrieving counter metrics](#USER_PerfInsights.API.Examples.CounterMetrics)\. However, the query\.json file has the following contents\. - -``` -[ - { - "Metric": "db.load.avg", - "GroupBy": { "Group": "db.wait_event", "Limit": 7 } - } -] -``` - -Run the following command\. - -For Linux, macOS, or Unix: - -``` -aws pi get-resource-metrics \ - --service-type RDS \ - --identifier db-ID \ - --start-time 2018-10-30T00:00:00Z \ - --end-time 2018-10-30T01:00:00Z \ - --period-in-seconds 60 \ - --metric-queries file://query.json -``` - -For Windows: - -``` -aws pi get-resource-metrics ^ - --service-type RDS ^ - --identifier db-ID ^ - --start-time 2018-10-30T00:00:00Z ^ - --end-time 2018-10-30T01:00:00Z ^ - --period-in-seconds 60 ^ - --metric-queries file://query.json -``` - -The example specifies the metric of `db.load.avg` and a `GroupBy` of the top seven wait events\. For details about valid values for this example, see [DimensionGroup](https://docs.aws.amazon.com/performance-insights/latest/APIReference/API_DimensionGroup.html) in the *Performance Insights API Reference\.* - -The response looks similar to the following\. - -``` -{ - "Identifier": "db-XXX", - "AlignedStartTime": 1540857600.0, - "AlignedEndTime": 1540861200.0, - "MetricList": [ - { //A list of key/datapoints - "Key": { - //A Metric with no dimensions. This is the total db.load.avg - "Metric": "db.load.avg" - }, - "DataPoints": [ - //Each list of datapoints has the same timestamps and same number of items - { - "Timestamp": 1540857660.0, //Minute1 - "Value": 0.5166666666666667 - }, - { - "Timestamp": 1540857720.0, //Minute2 - "Value": 0.38333333333333336 - }, - { - "Timestamp": 1540857780.0, //Minute 3 - "Value": 0.26666666666666666 - } - //... 60 datapoints for the total db.load.avg key - ] - }, - { - "Key": { - //Another key. This is db.load.avg broken down by CPU - "Metric": "db.load.avg", - "Dimensions": { - "db.wait_event.name": "CPU", - "db.wait_event.type": "CPU" - } - }, - "DataPoints": [ - { - "Timestamp": 1540857660.0, //Minute1 - "Value": 0.35 - }, - { - "Timestamp": 1540857720.0, //Minute2 - "Value": 0.15 - }, - //... 60 datapoints for the CPU key - ] - }, - //... In total we have 8 key/datapoints entries, 1) total, 2-8) Top Wait Events - ] //end of MetricList -} //end of response -``` - -In this response, there are eight entries in the `MetricList`\. There is one entry for the total `db.load.avg`, and seven entries each for the `db.load.avg` divided according to one of the top seven wait events\. Unlike in the first example, because there was a grouping dimension, there must be one key for each grouping of the metric\. There can't be only one key for each metric, as in the basic counter metric use case\. - -### Retrieving the DB load average for top SQL - -The following example groups `db.wait_events` by the top 10 SQL statements\. There are two different groups for SQL statements: -+ `db.sql` – The full SQL statement, such as `select * from customers where customer_id = 123` -+ `db.sql_tokenized` – The tokenized SQL statement, such as `select * from customers where customer_id = ?` - -When analyzing database performance, it can be useful to consider SQL statements that only differ by their parameters as one logic item\. So, you can use `db.sql_tokenized` when querying\. However, especially when you're interested in explain plans, sometimes it's more useful to examine full SQL statements with parameters, and query grouping by `db.sql`\. There is a parent\-child relationship between tokenized and full SQL, with multiple full SQL \(children\) grouped under the same tokenized SQL \(parent\)\. - -The command in this example is the similar to the command in [Retrieving the DB load average for top wait events](#USER_PerfInsights.API.Examples.DBLoadAverage)\. However, the query\.json file has the following contents\. - -``` -[ - { - "Metric": "db.load.avg", - "GroupBy": { "Group": "db.sql_tokenized", "Limit": 10 } - } -] -``` - -The following example uses `db.sql_tokenized`\. - -For Linux, macOS, or Unix: - -``` -aws pi get-resource-metrics \ - --service-type RDS \ - --identifier db-ID \ - --start-time 2018-10-29T00:00:00Z \ - --end-time 2018-10-30T00:00:00Z \ - --period-in-seconds 3600 \ - --metric-queries file://query.json -``` - -For Windows: - -``` -aws pi get-resource-metrics ^ - --service-type RDS ^ - --identifier db-ID ^ - --start-time 2018-10-29T00:00:00Z ^ - --end-time 2018-10-30T00:00:00Z ^ - --period-in-seconds 3600 ^ - --metric-queries file://query.json -``` - -This example queries over 24 hours, with a one hour period\-in\-seconds\. - -The example specifies the metric of `db.load.avg` and a `GroupBy` of the top seven wait events\. For details about valid values for this example, see [DimensionGroup](https://docs.aws.amazon.com/performance-insights/latest/APIReference/API_DimensionGroup.html) in the *Performance Insights API Reference\.* - -The response looks similar to the following\. - -``` -{ - "AlignedStartTime": 1540771200.0, - "AlignedEndTime": 1540857600.0, - "Identifier": "db-XXX", - - "MetricList": [ //11 entries in the MetricList - { - "Key": { //First key is total - "Metric": "db.load.avg" - } - "DataPoints": [ //Each DataPoints list has 24 per-hour Timestamps and a value - { - "Value": 1.6964980544747081, - "Timestamp": 1540774800.0 - }, - //... 24 datapoints - ] - }, - { - "Key": { //Next key is the top tokenized SQL - "Dimensions": { - "db.sql_tokenized.statement": "INSERT INTO authors (id,name,email) VALUES\n( nextval(?) ,?,?)", - "db.sql_tokenized.db_id": "pi-2372568224", - "db.sql_tokenized.id": "AKIAIOSFODNN7EXAMPLE" - }, - "Metric": "db.load.avg" - }, - "DataPoints": [ //... 24 datapoints - ] - }, - // In total 11 entries, 10 Keys of top tokenized SQL, 1 total key - ] //End of MetricList -} //End of response -``` - -This response has 11 entries in the `MetricList` \(1 total, 10 top tokenized SQL\), with each entry having 24 per\-hour `DataPoints`\. - -For tokenized SQL, there are three entries in each dimensions list: -+ `db.sql_tokenized.statement` – The tokenized SQL statement\. -+ `db.sql_tokenized.db_id ` – Either the native database ID used to refer to the SQL, or a synthetic ID that Performance Insights generates for you if the native database ID isn't available\. This example returns the `pi-2372568224` synthetic ID\. -+ `db.sql_tokenized.id` – The ID of the query inside Performance Insights\. - - In the AWS Management Console, this ID is called the Support ID\. It's named this because the ID is data that AWS Support can examine to help you troubleshoot an issue with your database\. AWS takes the security and privacy of your data extremely seriously, and almost all data is stored encrypted with your AWS KMS customer master key \(CMK\)\. Therefore, nobody inside AWS can look at this data\. In the example preceding, both the `tokenized.statement` and the `tokenized.db_id` are stored encrypted\. If you have an issue with your database, AWS Support can help you by referencing the Support ID\. - -When querying, it might be convenient to specify a `Group` in `GroupBy`\. However, for finer\-grained control over the data that's returned, specify the list of dimensions\. For example, if all that is needed is the `db.sql_tokenized.statement`, then a `Dimensions` attribute can be added to the query\.json file\. - -``` -[ - { - "Metric": "db.load.avg", - "GroupBy": { - "Group": "db.sql_tokenized", - "Dimensions":["db.sql_tokenized.statement"], - "Limit": 10 - } - } -] -``` - -### Retrieving the DB load average filtered by SQL - -![\[Filter by SQL chart.\]](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/./images/perf-insights-api-filter-chart.png) - -The preceding image shows that a particular query is selected, and the top average active sessions stacked area line graph is scoped to that query\. Although the query is still for the top seven overall wait events, the value of the response is filtered\. The filter causes it to take into account only sessions that are a match for the particular filter\. - -The corresponding API query in this example is similar to the command in [Retrieving the DB load average for top SQL](#USER_PerfInsights.API.Examples.DBLoadAverageTop10SQL)\. However, the query\.json file has the following contents\. - -``` -[ - { - "Metric": "db.load.avg", - "GroupBy": { "Group": "db.wait_event", "Limit": 5 }, - "Filter": { "db.sql_tokenized.id": "AKIAIOSFODNN7EXAMPLE" } - } -] -``` - -For Linux, macOS, or Unix: - -``` -aws pi get-resource-metrics \ - --service-type RDS \ - --identifier db-ID \ - --start-time 2018-10-30T00:00:00Z \ - --end-time 2018-10-30T01:00:00Z \ - --period-in-seconds 60 \ - --metric-queries file://query.json -``` - -For Windows: - -``` -aws pi get-resource-metrics ^ - --service-type RDS ^ - --identifier db-ID ^ - --start-time 2018-10-30T00:00:00Z ^ - --end-time 2018-10-30T01:00:00Z ^ - --period-in-seconds 60 ^ - --metric-queries file://query.json -``` - -The response looks similar to the following\. - -``` -{ - "Identifier": "db-XXX", - "AlignedStartTime": 1556215200.0, - "MetricList": [ - { - "Key": { - "Metric": "db.load.avg" - }, - "DataPoints": [ - { - "Timestamp": 1556218800.0, - "Value": 1.4878117913832196 - }, - { - "Timestamp": 1556222400.0, - "Value": 1.192823803967328 - } - ] - }, - { - "Key": { - "Metric": "db.load.avg", - "Dimensions": { - "db.wait_event.type": "io", - "db.wait_event.name": "wait/io/aurora_redo_log_flush" - } - }, - "DataPoints": [ - { - "Timestamp": 1556218800.0, - "Value": 1.1360544217687074 - }, - { - "Timestamp": 1556222400.0, - "Value": 1.058051341890315 - } - ] - }, - { - "Key": { - "Metric": "db.load.avg", - "Dimensions": { - "db.wait_event.type": "io", - "db.wait_event.name": "wait/io/table/sql/handler" - } - }, - "DataPoints": [ - { - "Timestamp": 1556218800.0, - "Value": 0.16241496598639457 - }, - { - "Timestamp": 1556222400.0, - "Value": 0.05163360560093349 - } - ] - }, - { - "Key": { - "Metric": "db.load.avg", - "Dimensions": { - "db.wait_event.type": "synch", - "db.wait_event.name": "wait/synch/mutex/innodb/aurora_lock_thread_slot_futex" - } - }, - "DataPoints": [ - { - "Timestamp": 1556218800.0, - "Value": 0.11479591836734694 - }, - { - "Timestamp": 1556222400.0, - "Value": 0.013127187864644107 - } - ] - }, - { - "Key": { - "Metric": "db.load.avg", - "Dimensions": { - "db.wait_event.type": "CPU", - "db.wait_event.name": "CPU" - } - }, - "DataPoints": [ - { - "Timestamp": 1556218800.0, - "Value": 0.05215419501133787 - }, - { - "Timestamp": 1556222400.0, - "Value": 0.05805134189031505 - } - ] - }, - { - "Key": { - "Metric": "db.load.avg", - "Dimensions": { - "db.wait_event.type": "synch", - "db.wait_event.name": "wait/synch/mutex/innodb/lock_wait_mutex" - } - }, - "DataPoints": [ - { - "Timestamp": 1556218800.0, - "Value": 0.017573696145124718 - }, - { - "Timestamp": 1556222400.0, - "Value": 0.002333722287047841 - } - ] - } - ], - "AlignedEndTime": 1556222400.0 -} //end of response -``` - -In this response, all values are filtered according to the contribution of tokenized SQL AKIAIOSFODNN7EXAMPLE specified in the query\.json file\. The keys also might follow a different order than a query without a filter, because it's the top five wait events that affected the filtered SQL\. - -### Retrieving the full text of a SQL statement - -The following example retrieves the full text of a SQL statement for DB instance `db-10BCD2EFGHIJ3KL4M5NO6PQRS5`\. The `--group` is `db.sql`, and the `--group-identifier` is `db.sql.id`\. In this example, *my\-sql\-id* represents a SQL ID retrieved by invoking `pi get-resource-metrics` or `pi describe-dimension-keys`\. - -Run the following command\. - -For Linux, macOS, or Unix: - -``` -aws pi get-dimension-key-details \ - --service-type RDS \ - --identifier db-10BCD2EFGHIJ3KL4M5NO6PQRS5 \ - --group db.sql \ - --group-identifier my-sql-id \ - --requested-dimensions statement -``` - -For Windows: - -``` -aws pi get-dimension-key-details ^ - --service-type RDS ^ - --identifier db-10BCD2EFGHIJ3KL4M5NO6PQRS5 ^ - --group db.sql ^ - --group-identifier my-sql-id ^ - --requested-dimensions statement -``` - -In this example, the dimensions details are available\. Thus, Performance Insights retrieves the full text of the SQL statement, without truncating it\. - -``` -{ - "Dimensions":[ - { - "Value": "SELECT e.last_name, d.department_name FROM employees e, departments d WHERE e.department_id=d.department_id", - "Dimension": "db.sql.statement", - "Status": "AVAILABLE" - }, - ... - ] -} -``` \ No newline at end of file diff --git a/doc_source/USER_PerfInsights.CloudTrail.md b/doc_source/USER_PerfInsights.CloudTrail.md deleted file mode 100644 index a48c1f6..0000000 --- a/doc_source/USER_PerfInsights.CloudTrail.md +++ /dev/null @@ -1,72 +0,0 @@ -# Logging Performance Insights calls using AWS CloudTrail - -Performance Insights runs with AWS CloudTrail, a service that provides a record of actions taken by a user, role, or an AWS service in Performance Insights\. CloudTrail captures all API calls for Performance Insights as events\. This capture includes calls from the Amazon RDS console and from code calls to the Performance Insights API operations\. - -If you create a trail, you can enable continuous delivery of CloudTrail events to an Amazon S3 bucket, including events for Performance Insights\. If you don't configure a trail, you can still view the most recent events in the CloudTrail console in **Event history**\. Using the data collected by CloudTrail, you can determine certain information\. This information includes the request that was made to Performance Insights, the IP address the request was made from, who made the request, and when it was made\. It also includes additional details\. - -To learn more about CloudTrail, see the [AWS CloudTrail User Guide](https://docs.aws.amazon.com/awscloudtrail/latest/userguide/)\. - -## Working with Performance Insights information in CloudTrail - -CloudTrail is enabled on your AWS account when you create the account\. When activity occurs in Performance Insights, that activity is recorded in a CloudTrail event along with other AWS service events in the CloudTrail console in **Event history**\. You can view, search, and download recent events in your AWS account\. For more information, see [Viewing Events with CloudTrail Event History](https://docs.aws.amazon.com/awscloudtrail/latest/userguide/view-cloudtrail-events.html) in *AWS CloudTrail User Guide\.* - -For an ongoing record of events in your AWS account, including events for Performance Insights, create a trail\. A *trail* enables CloudTrail to deliver log files to an Amazon S3 bucket\. By default, when you create a trail in the console, the trail applies to all AWS Regions\. The trail logs events from all AWS Regions in the AWS partition and delivers the log files to the Amazon S3 bucket that you specify\. Additionally, you can configure other AWS services to further analyze and act upon the event data collected in CloudTrail logs\. For more information, see the following topics in *AWS CloudTrail User Guide:* -+ [Overview for Creating a Trail](https://docs.aws.amazon.com/awscloudtrail/latest/userguide/cloudtrail-create-and-update-a-trail.html) -+ [CloudTrail Supported Services and Integrations](https://docs.aws.amazon.com/awscloudtrail/latest/userguide/cloudtrail-aws-service-specific-topics.html#cloudtrail-aws-service-specific-topics-integrations) -+ [Configuring Amazon SNS Notifications for CloudTrail](https://docs.aws.amazon.com/awscloudtrail/latest/userguide/getting_notifications_top_level.html) -+ [Receiving CloudTrail Log Files from Multiple Regions](https://docs.aws.amazon.com/awscloudtrail/latest/userguide/receive-cloudtrail-log-files-from-multiple-regions.html) and [Receiving CloudTrail Log Files from Multiple Accounts](https://docs.aws.amazon.com/awscloudtrail/latest/userguide/cloudtrail-receive-logs-from-multiple-accounts.html) - -All Performance Insights operations are logged by CloudTrail and are documented in the [Performance Insights API Reference](https://docs.aws.amazon.com/performance-insights/latest/APIReference/Welcome.html)\. For example, calls to the `DescribeDimensionKeys` and `GetResourceMetrics` operations generate entries in the CloudTrail log files\. - -Every event or log entry contains information about who generated the request\. The identity information helps you determine the following: -+ Whether the request was made with root or IAM user credentials\. -+ Whether the request was made with temporary security credentials for a role or federated user\. -+ Whether the request was made by another AWS service\. - -For more information, see the [CloudTrail userIdentity Element](https://docs.aws.amazon.com/awscloudtrail/latest/userguide/cloudtrail-event-reference-user-identity.html)\. - -## Performance Insights log file entries - -A *trail* is a configuration that enables delivery of events as log files to an Amazon S3 bucket that you specify\. CloudTrail log files contain one or more log entries\. An *event* represents a single request from any source\. Each event includes information about the requested operation, the date and time of the operation, request parameters, and so on\. CloudTrail log files aren't an ordered stack trace of the public API calls, so they don't appear in any specific order\. - -The following example shows a CloudTrail log entry that demonstrates the `GetResourceMetrics` operation\. - -``` -{ - "eventVersion": "1.05", - "userIdentity": { - "type": "IAMUser", - "principalId": "AKIAIOSFODNN7EXAMPLE", - "arn": "arn:aws:iam::123456789012:user/johndoe", - "accountId": "123456789012", - "accessKeyId": "AKIAI44QH8DHBEXAMPLE", - "userName": "johndoe" - }, - "eventTime": "2019-12-18T19:28:46Z", - "eventSource": "pi.amazonaws.com", - "eventName": "GetResourceMetrics", - "awsRegion": "us-east-1", - "sourceIPAddress": "72.21.198.67", - "userAgent": "aws-cli/1.16.240 Python/3.7.4 Darwin/18.7.0 botocore/1.12.230", - "requestParameters": { - "identifier": "db-YTDU5J5V66X7CXSCVDFD2V3SZM", - "metricQueries": [ - { - "metric": "os.cpuUtilization.user.avg" - }, - { - "metric": "os.cpuUtilization.idle.avg" - } - ], - "startTime": "Dec 18, 2019 5:28:46 PM", - "periodInSeconds": 60, - "endTime": "Dec 18, 2019 7:28:46 PM", - "serviceType": "RDS" - }, - "responseElements": null, - "requestID": "9ffbe15c-96b5-4fe6-bed9-9fccff1a0525", - "eventID": "08908de0-2431-4e2e-ba7b-f5424f908433", - "eventType": "AwsApiCall", - "recipientAccountId": "123456789012" -} -``` \ No newline at end of file diff --git a/doc_source/USER_PerfInsights.Cloudwatch.md b/doc_source/USER_PerfInsights.Cloudwatch.md deleted file mode 100644 index fd2c4e7..0000000 --- a/doc_source/USER_PerfInsights.Cloudwatch.md +++ /dev/null @@ -1,76 +0,0 @@ -# Amazon CloudWatch metrics for Performance Insights - -Performance Insights automatically publishes metrics to Amazon CloudWatch\. The same data can be queried from Performance Insights, but having the metrics in CloudWatch makes it easy to add CloudWatch alarms\. It also makes it easy to add the metrics to existing CloudWatch Dashboards\. - - -| Metric | Description | -| --- | --- | -| DBLoad | The number of active sessions for the DB engine\. Typically, you want the data for the average number of active sessions\. In Performance Insights, this data is queried as `db.load.avg`\. | -| DBLoadCPU | The number of active sessions where the wait event type is CPU\. In Performance Insights, this data is queried as `db.load.avg`, filtered by the wait event type `CPU`\. | -| DBLoadNonCPU | The number of active sessions where the wait event type is not CPU\. | - -**Note** -These metrics are published to CloudWatch only if there is load on the DB instance\. - -You can examine these metrics using the CloudWatch console, the AWS CLI, or the CloudWatch API\. - -For example, you can get the statistics for the `DBLoad` metric by running the [get\-metric\-statistics](https://docs.aws.amazon.com/cli/latest/reference/cloudwatch/get-metric-statistics.html) command\. - -``` -aws cloudwatch get-metric-statistics \ - --region us-west-2 \ - --namespace AWS/RDS \ - --metric-name DBLoad \ - --period 60 \ - --statistics Average \ - --start-time 1532035185 \ - --end-time 1532036185 \ - --dimensions Name=DBInstanceIdentifier,Value=db-loadtest-0 -``` - -This example generates output similar to the following\. - -``` -{ - "Datapoints": [ - { - "Timestamp": "2021-07-19T21:30:00Z", - "Unit": "None", - "Average": 2.1 - }, - { - "Timestamp": "2021-07-19T21:34:00Z", - "Unit": "None", - "Average": 1.7 - }, - { - "Timestamp": "2021-07-19T21:35:00Z", - "Unit": "None", - "Average": 2.8 - }, - { - "Timestamp": "2021-07-19T21:31:00Z", - "Unit": "None", - "Average": 1.5 - }, - { - "Timestamp": "2021-07-19T21:32:00Z", - "Unit": "None", - "Average": 1.8 - }, - { - "Timestamp": "2021-07-19T21:29:00Z", - "Unit": "None", - "Average": 3.0 - }, - { - "Timestamp": "2021-07-19T21:33:00Z", - "Unit": "None", - "Average": 2.4 - } - ], - "Label": "DBLoad" - } -``` - -For more information about CloudWatch, see [What is Amazon CloudWatch?](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/WhatIsCloudWatch.html) in the *Amazon CloudWatch User Guide*\. \ No newline at end of file diff --git a/doc_source/USER_PerfInsights.EnableMySQL.md b/doc_source/USER_PerfInsights.EnableMySQL.md deleted file mode 100644 index 875aaca..0000000 --- a/doc_source/USER_PerfInsights.EnableMySQL.md +++ /dev/null @@ -1,113 +0,0 @@ -# Turning on the Performance Schema for Performance Insights on Amazon RDS for MariaDB or MySQL - -The Performance Schema is an optional feature for monitoring Amazon RDS for MariaDB or MySQL runtime performance at a low level of detail\. The Performance Schema is designed to have minimal impact on database performance\. Performance Insights is a separate feature that you can use with or without the Performance Schema\. - -**Topics** -+ [Overview of the Performance Schema](#USER_PerfInsights.EnableMySQL.overview) -+ [Performance Insights and the Performance Schema](#USER_PerfInsights.effect-of-pfs) -+ [Automatic management of the Performance Schema by Performance Insights](#USER_PerfInsights.EnableMySQL.options) -+ [Effect of a reboot on the Performance Schema](#USER_PerfInsights.EnableMySQL.reboot) -+ [Determining whether Performance Insights is managing the Performance Schema](#USER_PerfInsights.EnableMySQL.determining-status) -+ [Configuring the Performance Schema for automatic management](#USER_PerfInsights.EnableMySQL.RDS) - -## Overview of the Performance Schema - -The Performance Schema monitors events in MariaDB and MySQL databases\. An *event* is a database server action that consumes time and has been instrumented so that timing information can be collected\. Examples of events include the following: -+ Function calls -+ Waits for the operating system -+ Stages of SQL execution -+ Groups of SQL statements - -The `PERFORMANCE_SCHEMA` storage engine is a mechanism for implementing the Performance Schema feature\. This engine collects event data using instrumentation in the database source code\. The engine stores events in memory\-only tables in the `performance_schema` database\. You can query `performance_schema` just as you can query any other tables\. For more information, see [MySQL Performance Schema](https://dev.mysql.com/doc/refman/8.0/en/performance-schema.html) in the *MySQL Reference Manual*\. - -## Performance Insights and the Performance Schema - -Performance Insights and the Performance Schema are separate features, but they are connected\. The behavior of Performance Insights for Amazon RDS for MariaDB or MySQL depends on whether the Performance Schema is turned on, and if so, whether Performance Insights manages the Performance Schema automatically\. The following table describes the behavior\. - - -| Performance Schema turned on | Performance Insights management mode | Performance Insights behavior | -| --- | --- | --- | -| Yes | Automatic | [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_PerfInsights.EnableMySQL.html) | -| Yes | Manual | [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_PerfInsights.EnableMySQL.html) | -| No | N/A | [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_PerfInsights.EnableMySQL.html) | - -## Automatic management of the Performance Schema by Performance Insights - -When you create an Amazon RDS for MariaDB or MySQL DB instance with Performance Insights turned on, the Performance Schema is also turned on\. In this case, Performance Insights automatically manages your Performance Schema parameters\. This is the recommended configuration\. - -**Note** -Automatic management of the Performance Schema isn't supported for the t4g\.medium instance class\. - -For automatic management of the Performance Schema, the following conditions must be true: -+ The `performance_schema` parameter is set to `0`\. -+ The **Source** is set to `system`, which is the default\. - -If you change the `performance_schema` parameter value manually, and then later want to change to automatic management, see [Configuring the Performance Schema for automatic management](#USER_PerfInsights.EnableMySQL.RDS)\. - -**Important** -When Performance Insights turns on the Performance Schema, it doesn't change the parameter group values\. However, the values are changed on the DB instances that are running\. The only way to see the changed values is to run the `SHOW GLOBAL VARIABLES` command\. - -## Effect of a reboot on the Performance Schema - -Performance Insights and the Performance Schema differ in their requirements for DB instance reboots: - -Performance Schema -To turn this feature on or off, you must reboot the DB instance\. - -Performance Insights -To turn this feature on or off, you don't need to reboot the DB instance\. - -If the Performance Schema isn't currently turned on, and you turn on Performance Insights without rebooting the DB instance, the Performance Schema won't be turned on\. - -## Determining whether Performance Insights is managing the Performance Schema - -To find out whether Performance Insights is currently managing the Performance Schema for major engine versions 5\.6, 5\.7, and 8\.0, review the following table\. - - -| Setting of performance\_schema parameter | Setting of the Source column | Performance Insights is managing the Performance Schema? | -| --- | --- | --- | -| 0 | system | Yes | -| 0 or 1 | user | No | - -**To determine whether Performance Insights is managing the Performance Schema automatically** - -1. Sign in to the AWS Management Console and open the Amazon RDS console at [https://console\.aws\.amazon\.com/rds/](https://console.aws.amazon.com/rds/)\. - -1. Choose **Parameter groups**\. - -1. Select the name of the parameter group for your DB instance\. - -1. Enter **performance\_schema** in the search bar\. - -1. Check whether **Source** is the system default and **Values** is **0**\. If so, Performance Insights is managing the Performance Schema automatically\. If not, Performance Insights isn't managing the Performance Schema automatically\. -![\[Shows the settings for the performance_schema parameter\]](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/images/perf_schema_user.png) - -## Configuring the Performance Schema for automatic management - -Assume that Performance Insights is turned on for your DB instance or Multi\-AZ DB cluster but isn't currently managing the Performance Schema\. If you want to allow Performance Insights to manage the Performance Schema automatically, complete the following steps\. - -**To configure the Performance Schema for automatic management** - -1. Sign in to the AWS Management Console and open the Amazon RDS console at [https://console\.aws\.amazon\.com/rds/](https://console.aws.amazon.com/rds/)\. - -1. Choose **Parameter groups**\. - -1. Select the name of the parameter group for your DB instance or Multi\-AZ DB cluster\. - -1. Enter **performance\_schema** in the search bar\. - -1. Select the `performance_schema` parameter\. - -1. Choose **Edit parameters**\. - -1. Select the `performance_schema` parameter\. - -1. In **Values**, choose **0**\. - -1. Choose **Reset** and then **Reset parameters**\. - -1. Reboot the DB instance or Multi\-AZ DB cluster\. -**Important** -Whenever you turn the Performance Schema on or off, make sure to reboot the DB instance or Multi\-AZ DB cluster\. - -For more information about modifying instance parameters, see [Modifying parameters in a DB parameter group](USER_WorkingWithDBInstanceParamGroups.md#USER_WorkingWithParamGroups.Modifying)\. For more information about the dashboard, see [Analyzing metrics with the Performance Insights dashboard](USER_PerfInsights.UsingDashboard.md)\. For more information about the MySQL performance schema, see [MySQL 8\.0 Reference Manual](https://dev.mysql.com/doc/refman/8.0/en/performance-schema.html)\. \ No newline at end of file diff --git a/doc_source/USER_PerfInsights.Enabling.md b/doc_source/USER_PerfInsights.Enabling.md deleted file mode 100644 index efdffff..0000000 --- a/doc_source/USER_PerfInsights.Enabling.md +++ /dev/null @@ -1,129 +0,0 @@ -# Turning Performance Insights on and off - -You can turn on Performance Insights for your DB instance or Multi\-AZ DB cluster when you create it\. If needed, you can turn it off later\. Turning Performance Insights on and off doesn't cause downtime, a reboot, or a failover\. - -**Note** -Performance Schema is an optional performance tool used by Amazon RDS for MariaDB or MySQL\. If you turn Performance Schema on or off, you need to reboot\. If you turn Performance Insights on or off, however, you don't need to reboot\. For more information, see [Turning on the Performance Schema for Performance Insights on Amazon RDS for MariaDB or MySQL](USER_PerfInsights.EnableMySQL.md)\. - -The Performance Insights agent consumes limited CPU and memory on the DB host\. When the DB load is high, the agent limits the performance impact by collecting data less frequently\. - -## Console - -In the console, you can turn Performance Insights on or off when you create or modify a DB instance or Multi\-AZ DB cluster\. - -### Turning Performance Insights on or off when creating a DB instance or Multi\-AZ DB cluster - -When you create a new DB instance or Multi\-AZ DB cluster, turn on Performance Insights by choosing **Enable Performance Insights** in the **Performance Insights** section\. Or choose **Disable Performance Insights**\. For more information, see the following topics: -+ To create a DB instance, follow the instructions for your DB engine in [Creating an Amazon RDS DB instance](USER_CreateDBInstance.md)\. -+ To create a Multi\-AZ DB cluster, follow the instructions for your DB engine in [Creating a Multi\-AZ DB cluster](create-multi-az-db-cluster.md)\. - -The following screenshot shows the **Performance Insights** section\. - -![\[Turn on Performance Insights during DB instance or Multi-AZ DB cluster creation with console\]](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/./images/perf_insights_enabling.png) - -If you choose **Enable Performance Insights**, you have the following options: -+ **Retention** – The amount of time to retain Performance Insights data\. The retention setting in the free tier is **Default \(7 days\)**\. To retain your performance data for longer, specify 1–24 months\. For more information about retention periods, see [Pricing and data retention for Performance Insights](USER_PerfInsights.Overview.cost.md)\. -+ **AWS KMS key** – Specify your AWS KMS key\. Performance Insights encrypts all potentially sensitive data using your KMS key\. Data is encrypted in flight and at rest\. For more information, see [Configuring an AWS KMS policy for Performance Insights](USER_PerfInsights.access-control.md#USER_PerfInsights.access-control.cmk-policy)\. - -### Turning Performance Insights on or off when modifying a DB instance or Multi\-AZ DB cluster - -In the console, you can modify a DB instance or Multi\-AZ DB cluster to turn Performance Insights on or off\. - -**To turn Performance Insights on or off for a DB instance or Multi\-AZ DB cluster using the console** - -1. Sign in to the AWS Management Console and open the Amazon RDS console at [https://console\.aws\.amazon\.com/rds/](https://console.aws.amazon.com/rds/)\. - -1. Choose **Databases**\. - -1. Choose a DB instance or Multi\-AZ DB cluster, and choose **Modify**\. - -1. In the **Performance Insights** section, choose either **Enable Performance Insights** or **Disable Performance Insights**\. - - If you choose **Enable Performance Insights**, you have the following options: - + **Retention** – The amount of time to retain Performance Insights data\. The retention setting in the free tier is **Default \(7 days\)**\. To retain your performance data for longer, specify 1–24 months\. For more information about retention periods, see [Pricing and data retention for Performance Insights](USER_PerfInsights.Overview.cost.md)\. - + **AWS KMS key** – Specify your KMS key\. Performance Insights encrypts all potentially sensitive data using your KMS key\. Data is encrypted in flight and at rest\. For more information, see [Encrypting Amazon RDS resources](Overview.Encryption.md)\. - -1. Choose **Continue**\. - -1. For **Scheduling of Modifications**, choose Apply immediately\. If you choose Apply during the next scheduled maintenance window, your instance ignores this setting and turns on Performance Insights immediately\. - -1. Choose **Modify instance**\. - -## AWS CLI - -When you use the [create\-db\-instance](https://docs.aws.amazon.com/cli/latest/reference/rds/create-db-instance.html) AWS CLI command, turn on Performance Insights by specifying `--enable-performance-insights`\. Or turn off Performance Insights by specifying `--no-enable-performance-insights`\. - -You can also specify these values using the following AWS CLI commands: -+ [create\-db\-instance\-read\-replica](https://docs.aws.amazon.com/cli/latest/reference/rds/create-db-instance-read-replica.html) -+ [modify\-db\-instance](https://docs.aws.amazon.com/cli/latest/reference/rds/modify-db-instance.html) -+ [restore\-db\-instance\-from\-s3](https://docs.aws.amazon.com/cli/latest/reference/rds/restore-db-instance-from-s3.html) -+ [create\-db\-cluster](https://docs.aws.amazon.com/cli/latest/reference/rds/create-db-cluster.html) \(Multi\-AZ DB cluster\) -+ [modify\-db\-cluster](https://docs.aws.amazon.com/cli/latest/reference/rds/modify-db-cluster.html) \(Multi\-AZ DB cluster\) - -The following procedure describes how to turn Performance Insights on or off for an existing DB instance using the AWS CLI\. - -**To turn Performance Insights on or off for a DB instance using the AWS CLI** -+ Call the [modify\-db\-instance](https://docs.aws.amazon.com/cli/latest/reference/rds/modify-db-instance.html) AWS CLI command and supply the following values: - + `--db-instance-identifier` – The name of the DB instance\. - + `--enable-performance-insights` to turn on or `--no-enable-performance-insights` to turn off - - The following example turns on Performance Insights for `sample-db-instance`\. - - For Linux, macOS, or Unix: - - ``` - aws rds modify-db-instance \ - --db-instance-identifier sample-db-instance \ - --enable-performance-insights - ``` - - For Windows: - - ``` - aws rds modify-db-instance ^ - --db-instance-identifier sample-db-instance ^ - --enable-performance-insights - ``` - -When you turn on Performance Insights in the CLI, you can optionally specify the number of days to retain Performance Insights data with the `--performance-insights-retention-period` option\. You can specify `7`, *month* \* 31 \(where *month* is a number from 1–23\), or `731`\. For example, if you want to retain your performance data for 3 months, specify `93`, which is 3 \* 31\. The default is `7` days\. For more information about retention periods, see [Pricing and data retention for Performance Insights](USER_PerfInsights.Overview.cost.md)\. - -The following example turns on Performance Insights for `sample-db-instance` and specifies that Performance Insights data is retained for 93 days \(3 months\)\. - -For Linux, macOS, or Unix: - -``` -aws rds modify-db-instance \ - --db-instance-identifier sample-db-instance \ - --enable-performance-insights \ - --performance-insights-retention-period 93 -``` - -For Windows: - -``` -aws rds modify-db-instance ^ - --db-instance-identifier sample-db-instance ^ - --enable-performance-insights ^ - --performance-insights-retention-period 93 -``` - -If you specify a retention period such as 94 days, which isn't a valid value, RDS issues an error\. - -``` -An error occurred (InvalidParameterValue) when calling the CreateDBInstance operation: -Invalid Performance Insights retention period. Valid values are: [7, 31, 62, 93, 124, 155, 186, 217, -248, 279, 310, 341, 372, 403, 434, 465, 496, 527, 558, 589, 620, 651, 682, 713, 731] -``` - -## RDS API - -When you create a new DB instance using the [CreateDBInstance](https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_CreateDBInstance.html) operation Amazon RDS API operation, turn on Performance Insights by setting `EnablePerformanceInsights` to `True`\. To turn off Performance Insights, set `EnablePerformanceInsights` to `False`\. - -You can also specify the `EnablePerformanceInsights` value using the following API operations: -+ [ModifyDBInstance](https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_ModifyDBInstance.html) -+ [CreateDBInstanceReadReplica](https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_CreateDBInstanceReadReplica.html) -+ [RestoreDBInstanceFromS3](https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_RestoreDBInstanceFromS3.html) -+ [CreateDBCluster](https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_CreateDBCluster.html) \(Multi\-AZ DB cluster\) -+ [ModifyDBCluster](https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_ModifyDBCluster.html) \(Multi\-AZ DB cluster\) - -When you turn on Performance Insights, you can optionally specify the amount of time, in days, to retain Performance Insights data with the `PerformanceInsightsRetentionPeriod` parameter\. You can specify `7`, *month* \* 31 \(where *month* is a number from 1–23\), or `731`\. For example, if you want to retain your performance data for 3 months, specify `93`, which is 3 \* 31\. The default is `7` days\. For more information about retention periods, see [Pricing and data retention for Performance Insights](USER_PerfInsights.Overview.cost.md)\. \ No newline at end of file diff --git a/doc_source/USER_PerfInsights.Overview.ActiveSessions.md b/doc_source/USER_PerfInsights.Overview.ActiveSessions.md deleted file mode 100644 index fcca2d7..0000000 --- a/doc_source/USER_PerfInsights.Overview.ActiveSessions.md +++ /dev/null @@ -1,103 +0,0 @@ -# Database load - -*Database load \(DB load\)* measures the level of session activity in your database\. The key metric in Performance Insights is `DBLoad`, which is collected every second\. - -**Topics** -+ [Active sessions](#USER_PerfInsights.Overview.ActiveSessions.active-sessions) -+ [Average active sessions](#USER_PerfInsights.Overview.ActiveSessions.AAS) -+ [Average active executions](#USER_PerfInsights.Overview.ActiveSessions.AAE) -+ [Dimensions](#USER_PerfInsights.Overview.ActiveSessions.dimensions) - -## Active sessions - -A *database session* represents an application's dialogue with a relational database\. An active session is a connection that has submitted work to the DB engine and is waiting for a response\. - -A session is active when it's either running on CPU or waiting for a resource to become available so that it can proceed\. For example, an active session might wait for a page \(or block\) to be read into memory, and then consume CPU while it reads data from the page\. - -## Average active sessions - -The *average active sessions \(AAS\)* is the unit for the `DBLoad` metric in Performance Insights\. It measures how many sessions are concurrently active on the database\. - -Every second, Performance Insights samples the number of sessions concurrently running a query\. For each active session, Performance Insights collects the following data: -+ SQL statement -+ Session state \(running on CPU or waiting\) -+ Host -+ User running the SQL - -Performance Insights calculates the AAS by dividing the total number of sessions by the number of samples for a specific time period\. For example, the following table shows 5 consecutive samples of a running query taken at 1\-second intervals\. - -[\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_PerfInsights.Overview.ActiveSessions.html) - -In the preceding example, the DB load for the time interval was 2 AAS\. This measurement means that, on average, 2 sessions were active at any given time during the interval when the 5 samples were taken\. - -An analogy for DB load is worker activity in a warehouse\. Suppose that the warehouse employs 100 workers\. If 1 order comes in, 1 worker fulfills the order while 99 workers are idle\. If 100 orders come in, all 100 workers fulfill orders simultaneously\. If every 15 minutes a manager writes down how many workers are simultaneously active, adds these numbers at the end of the day, and then divides the total by the number of samples, the manager calculates the average number of workers active at any given time\. If the average was 50 workers yesterday and 75 workers today, then the average activity level in the warehouse increased\. Similarly, DB load increases as database session activity increases\. - -## Average active executions - -The average active executions \(AAE\) per second is related to AAS\. To calculate the AAE, Performance Insights divides the total execution time of a query by the time interval\. The following table shows the AAE calculation for the same query in the preceding table\. - -[\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_PerfInsights.Overview.ActiveSessions.html) - -In most cases, the AAS and AAE for a query are approximately the same\. However, because the inputs to the calculations are different data sources, the calculations often vary slightly\. - -## Dimensions - -The `db.load` metric is different from the other time\-series metrics because you can break it into subcomponents called dimensions\. You can think of dimensions as "slice by" categories for the different characteristics of the `DBLoad` metric\. - -When you are diagnosing performance issues, the following dimensions are often the most useful: - -**Topics** -+ [Wait events](#USER_PerfInsights.Overview.ActiveSessions.waits) -+ [Top SQL](#USER_PerfInsights.Overview.ActiveSessions.top-sql) -+ [Plans](#USER_PerfInsights.Overview.ActiveSessions.plans) - -For a complete list of dimensions for the Amazon RDS engines, see [DB load sliced by dimensions](USER_PerfInsights.UsingDashboard.Components.md#USER_PerfInsights.UsingDashboard.Components.AvgActiveSessions.dims)\. - -### Wait events - -A *wait event* causes a SQL statement to wait for a specific event to happen before it can continue running\. Wait events are an important dimension, or category, for DB load because they indicate where work is impeded\. - -Every active session is either running on the CPU or waiting\. For example, sessions consume CPU when they search memory for a buffer, perform a calculation, or run procedural code\. When sessions aren't consuming CPU, they might be waiting for a memory buffer to become free, a data file to be read, or a log to be written to\. The more time that a session waits for resources, the less time it runs on the CPU\. - -When you tune a database, you often try to find out the resources that sessions are waiting for\. For example, two or three wait events might account for 90 percent of DB load\. This measure means that, on average, active sessions are spending most of their time waiting for a small number of resources\. If you can find out the cause of these waits, you can attempt a solution\. - -Consider the analogy of a warehouse worker\. An order comes in for a book\. The worker might be delayed in fulfilling the order\. For example, a different worker might be currently restocking the shelves, a trolley might not be available\. Or the system used to enter the order status might be slow\. The longer the worker waits, the longer it takes to fulfill the order\. Waiting is a natural part of the warehouse workflow, but if wait time becomes excessive, productivity decreases\. In the same way, repeated or lengthy session waits can degrade database performance\. For more information, see [Tuning with wait events for Aurora PostgreSQL](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/AuroraPostgreSQL.Tuning.html) and [Tuning with wait events for Aurora MySQL](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/AuroraMySQL.Managing.Tuning.wait-events.html) in the *Amazon Aurora User Guide*\. - -Wait events vary by DB engine: -+ For information about all MariaDB and MySQL wait events, see [Wait Event Summary Tables](https://dev.mysql.com/doc/refman/8.0/en/performance-schema-wait-summary-tables.html) in the MySQL documentation\. -+ For information about all PostgreSQL wait events, see [The Statistics Collector > Wait Event tables](https://www.postgresql.org/docs/current/monitoring-stats.html#WAIT-EVENT-TABLE) in the PostgreSQL documentation\. -+ For information about all Oracle wait events, see [ Descriptions of Wait Events](https://docs.oracle.com/database/121/REFRN/GUID-2FDDFAA4-24D0-4B80-A157-A907AF5C68E2.htm#REFRN-GUID-2FDDFAA4-24D0-4B80-A157-A907AF5C68E2) in the Oracle documentation\. -+ For information about all SQL Server wait events, see [ Types of Waits](https://docs.microsoft.com/en-us/sql/relational-databases/system-dynamic-management-views/sys-dm-os-wait-stats-transact-sql?view=sql-server-2017#WaitTypes) in the SQL Server documentation\. - -**Note** -For Oracle, background processes sometimes do work without an associated SQL statement\. In these cases, Performance Insights reports the type of background process concatenated with a colon and the wait class associated with that background process\. Types of background process include `LGWR`, `ARC0`, `PMON`, and so on\. -For example, when the archiver is performing I/O, the Performance Insights report for it is similar to `ARC1:System I/O`\. Occasionally, the background process type is also missing, and Performance Insights only reports the wait class, for example `:System I/O`\. - -### Top SQL - -Where wait events show bottlenecks, top SQL shows which queries are contributing the most to DB load\. For example, many queries might be currently running on the database, but a single query might consume 99 percent of the DB load\. In this case, the high load might indicate a problem with the query\. - -By default, the Performance Insights console displays top SQL queries that are contributing to the database load\. The console also shows relevant statistics for each statement\. To diagnose performance problems for a specific statement, you can examine its execution plan\. - -### Plans - -An *execution plan*, also called simply a *plan*, is a sequence of steps that access data\. For example, a plan for joining tables `t1` and `t2` might loop through all rows in `t1` and compare each row to a row in `t2`\. In a relational database, an *optimizer* is built\-in code that determines the most efficient plan for a SQL query\. - -For Oracle DB instances, Performance Insights collects execution plans automatically\. To diagnose SQL performance problems, examine the captured plans for high\-resource Oracle SQL queries\. The plans show how Oracle Database has parsed and run queries\. - -To learn how to analyze DB load using plans, see [Analyzing Oracle execution plans using the Performance Insights dashboard](USER_PerfInsights.UsingDashboard.AccessPlans.md)\. - -#### Plan capture - -Every five minutes, Performance Insights identifies the most resource\-intensive Oracle queries and captures their plans\. Thus, you don't need to manually collect and manage a huge number of plans\. Instead, you can use the **Top SQL** tab to focus on the plans for the most problematic queries\. - -**Note** -Performance Insights doesn't capture plans for queries whose text exceeds the maximum collectable query text limit\. For more information, see [Accessing more SQL text in the Performance Insights dashboard](USER_PerfInsights.UsingDashboard.SQLTextSize.md)\. - -The retention period for execution plans is the same as for your Performance Insights data\. The retention setting in the free tier is **Default \(7 days\)**\. To retain your performance data for longer, specify 1–24 months\. For more information about retention periods, see [Pricing and data retention for Performance Insights](USER_PerfInsights.Overview.cost.md)\. - -#### Digest queries - -The **Top SQL** tab shows digest queries by default\. A digest query doesn't itself have a plan, but all queries that use literal values have plans\. For example, a digest query might include the text `WHERE `email`=?`\. The digest might contain two queries, one with the text `WHERE email=user1@example.com` and another with `WHERE email=user2@example.com`\. Each of these literal queries might include multiple plans\. - -If you select a digest query, the console shows all plans for child statements of the selected digest\. Thus, you don't need to look through all the child statements to find the plan\. You might see plans that aren’t in the displayed list of top 10 child statements\. The console shows plans for all child queries for which plans have been collected, regardless of whether the queries are in the top 10\. \ No newline at end of file diff --git a/doc_source/USER_PerfInsights.Overview.Engines.md b/doc_source/USER_PerfInsights.Overview.Engines.md deleted file mode 100644 index 275db02..0000000 --- a/doc_source/USER_PerfInsights.Overview.Engines.md +++ /dev/null @@ -1,15 +0,0 @@ -# Amazon RDS DB engine, Region, and instance class support for Performance Insights - -Following, you can find the Amazon RDS DB engines that support Performance Insights\. - -**Note** -For Amazon Aurora, see [Amazon Aurora DB engine support for Performance Insights](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_PerfInsights.Overview.Engines.html) in *Amazon Aurora User Guide*\. - - -| Amazon RDS DB engine | Supported engine versions and Regions | Instance class restrictions | -| --- | --- | --- | -| Amazon RDS for MariaDB | For more information on version and Region availability of Performance Insights with RDS for MariaDB, see [Performance Insights](Concepts.RDS_Fea_Regions_DB-eng.Feature.PerformanceInsights.md)\. | Performance Insights isn't supported for the following instance classes: [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_PerfInsights.Overview.Engines.html) | -| RDS for MySQL | For more information on version and Region availability of Performance Insights with RDS for MySQL, see [Performance Insights](Concepts.RDS_Fea_Regions_DB-eng.Feature.PerformanceInsights.md)\. | Performance Insights isn't supported for the following instance classes: [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_PerfInsights.Overview.Engines.html) | -| Amazon RDS for Microsoft SQL Server | For more information on version and Region availability of Performance Insights with RDS for SQL Server, see [Performance Insights](Concepts.RDS_Fea_Regions_DB-eng.Feature.PerformanceInsights.md)\. | N/A | -| Amazon RDS for PostgreSQL | For more information on version and Region availability of Performance Insights with RDS for PostgreSQL, see [Performance Insights](Concepts.RDS_Fea_Regions_DB-eng.Feature.PerformanceInsights.md)\. | N/A | -| Amazon RDS for Oracle | For more information on version and Region availability of Performance Insights with RDS for Oracle, see [Performance Insights](Concepts.RDS_Fea_Regions_DB-eng.Feature.PerformanceInsights.md)\. | N/A | \ No newline at end of file diff --git a/doc_source/USER_PerfInsights.Overview.MaxCPU.md b/doc_source/USER_PerfInsights.Overview.MaxCPU.md deleted file mode 100644 index 29cc4c6..0000000 --- a/doc_source/USER_PerfInsights.Overview.MaxCPU.md +++ /dev/null @@ -1,5 +0,0 @@ -# Maximum CPU - -In the dashboard, the **Database load** chart collects, aggregates, and displays session information\. To see whether active sessions are exceeding the maximum CPU, look at their relationship to the **Max vCPU** line\. The **Max vCPU** value is determined by the number of vCPU \(virtual CPU\) cores for your DB instance\. - -One process can run on a vCPU at a time\. If the number of processes exceed the number of vCPUs, the processes start queuing\. When the queuing increase, the performance is impacted\. If the DB load is often above the **Max vCPU** line, and the primary wait state is CPU, the CPU is overloaded\. In this case, you might want to throttle connections to the instance, tune any SQL queries with a high CPU load, or consider a larger instance class\. High and consistent instances of any wait state indicate that there might be bottlenecks or resource contention issues to resolve\. This can be true even if the DB load doesn't cross the **Max vCPU** line\. \ No newline at end of file diff --git a/doc_source/USER_PerfInsights.Overview.Regions.md b/doc_source/USER_PerfInsights.Overview.Regions.md deleted file mode 100644 index 78c33fa..0000000 --- a/doc_source/USER_PerfInsights.Overview.Regions.md +++ /dev/null @@ -1,5 +0,0 @@ -# AWS Region support for Performance Insights - -Performance Insights for Amazon RDS is supported for all AWS Regions except the following: -+ AWS GovCloud \(US\-East\) -+ AWS GovCloud \(US\-West\) \ No newline at end of file diff --git a/doc_source/USER_PerfInsights.Overview.cost.md b/doc_source/USER_PerfInsights.Overview.cost.md deleted file mode 100644 index 73f0b92..0000000 --- a/doc_source/USER_PerfInsights.Overview.cost.md +++ /dev/null @@ -1,11 +0,0 @@ -# Pricing and data retention for Performance Insights - -By default, Performance Insights offers a free tier that includes 7 days of performance data history and 1 million API requests per month\. You can also purchase longer retention periods\. For complete pricing information, see [Performance Insights Pricing](http://aws.amazon.com/rds/performance-insights/pricing/)\. - -In the RDS console, you can choose any of the following retention periods for your Performance Insights data: -+ **Default \(7 days\)** -+ ***n* months**, where ***n*** is a number from 1–24 - -![\[Choose a retention period for your Performance Insights data.\]](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/images/pi-retention-periods.png) - -To learn how to set a retention period using the AWS CLI, see [AWS CLI](USER_PerfInsights.Enabling.md#USER_PerfInsights.Enabling.CLI)\. \ No newline at end of file diff --git a/doc_source/USER_PerfInsights.Overview.md b/doc_source/USER_PerfInsights.Overview.md deleted file mode 100644 index 33038fd..0000000 --- a/doc_source/USER_PerfInsights.Overview.md +++ /dev/null @@ -1,16 +0,0 @@ -# Overview of Performance Insights on Amazon RDS - -By default, Performance Insights is turned on in the console create wizard for all Amazon RDS engines\. If you have more than one database on a DB instance, Performance Insights aggregates performance data\. - -You can find an overview of Performance Insights for Amazon RDS in the following video\. - -[![AWS Videos](http://img.youtube.com/vi/yOeWcPBT458/0.jpg)](http://www.youtube.com/watch?v=yOeWcPBT458) - -**Important** -The following topics describe using Amazon RDS Performance Insights with non\-Aurora DB engines\. For information about using Amazon RDS Performance Insights with Amazon Aurora, see [Using Amazon RDS Performance Insights](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_PerfInsights.html) in the *Amazon Aurora User Guide*\. - -**Topics** -+ [Database load](USER_PerfInsights.Overview.ActiveSessions.md) -+ [Maximum CPU](USER_PerfInsights.Overview.MaxCPU.md) -+ [Amazon RDS DB engine, Region, and instance class support for Performance Insights](USER_PerfInsights.Overview.Engines.md) -+ [Pricing and data retention for Performance Insights](USER_PerfInsights.Overview.cost.md) \ No newline at end of file diff --git a/doc_source/USER_PerfInsights.UIcontrols.md b/doc_source/USER_PerfInsights.UIcontrols.md deleted file mode 100644 index fc98ecb..0000000 --- a/doc_source/USER_PerfInsights.UIcontrols.md +++ /dev/null @@ -1,12 +0,0 @@ -# Zooming In on the DB Load chart - -You can use other features of the Performance Insights user interface to help analyze performance data\. - -**Click\-and\-Drag Zoom In** -In the Performance Insights interface, you can choose a small portion of the load chart and zoom in on the detail\. - -![\[Zoom in\]](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/./images/perf_insights_zoom_in.png) - -To zoom in on a portion of the load chart, choose the start time and drag to the end of the time period you want\. When you do this, the selected area is highlighted\. When you release the mouse, the load chart zooms in on the selected AWS Region, and the **Top *items*** table is recalculated\. - -![\[Zoom in\]](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/./images/perf_insights_zoom_in_b.png) \ No newline at end of file diff --git a/doc_source/USER_PerfInsights.UsingDashboard.AccessPlans.md b/doc_source/USER_PerfInsights.UsingDashboard.AccessPlans.md deleted file mode 100644 index c54ca1b..0000000 --- a/doc_source/USER_PerfInsights.UsingDashboard.AccessPlans.md +++ /dev/null @@ -1,63 +0,0 @@ -# Analyzing Oracle execution plans using the Performance Insights dashboard - -When analyzing DB load on an Oracle Database, you might want to know which plans are contributing the most to DB load\. For example, the top SQL statements at a given time might be using the plans shown in the following table\. - - -**** - -| Top SQL | Plan | -| --- | --- | -| SELECT SUM\(amount\_sold\) FROM sales WHERE prod\_id = 10 | Plan A | -| SELECT SUM\(amount\_sold\) FROM sales WHERE prod\_id = 521 | Plan B | -| SELECT SUM\(s\_total\) FROM sales WHERE region = 10 | Plan A | -| SELECT \* FROM emp WHERE emp\_id = 1000 | Plan C | -| SELECT SUM\(amount\_sold\) FROM sales WHERE prod\_id = 72 | Plan A | - -With the plan feature of Performance Insights, you can do the following: -+ Find out which plans are used by the top SQL queries\. - - For example, you might find out that most of the DB load is generated by queries using plan A and plan B, with only a small percentage using plan C\. -+ Compare different plans for the same query\. - - In the preceding example, three queries are identical except for the product ID\. Two queries use plan A, but one query uses plan B\. To see the difference in the two plans, you can use Performance Insights\. -+ Find out when a query switched to a new plan\. - - You might see that a query used plan A and then switched to plan B at a certain time\. Was there a change in the database at this point? For example, if a table is empty, the optimizer might choose a full table scan\. If the table is loaded with a million rows, the optimizer might switch to an index range scan\. -+ Drill down to the specific steps of a plan with the highest cost\. - - For example, the for a long\-running query might show a missing a join condition in an equijoin\. This missing condition forces a Cartesian join, which joins all rows of two tables\. - -You can perform the preceding tasks by using the plan capture feature of Performance Insights\. Just as you can slice Oracle queries by wait events and top SQL, you can slice them by the plan dimension\. - -**To analyze Oracle execution plans using the console** - -1. Open the Amazon RDS console at [https://console\.aws\.amazon\.com/rds/](https://console.aws.amazon.com/rds/)\. - -1. In the navigation pane, choose **Performance Insights**\. - -1. Choose an Oracle DB instance\. The Performance Insights dashboard is displayed for that DB instance\. - -1. In the **Database load \(DB load\)** section, choose **Plans** next to **Slice by**\. - - The Average active sessions chart shows the plans used by your top SQL statements\. The plan hash values appear to the right of the color\-coded squares\. Each hash value uniquely identifies a plan\. -![\[Slice by plans\]](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/./images/pi-slice-by-plans.png) - -1. Scroll down to the **Top SQL** tab\. - - In the following example, the top SQL digest has two plans\. You can tell that it's a digest by the question mark in the statement\. -![\[Choose a digest plan\]](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/./images/top-sql-plans-unselected.png) - -1. Choose the digest to expand it into its component statements\. - - In the following example, the `SELECT` statement is a digest query\. The component queries in the digest use two different plans\. The colors of the plans correspond to the database load chart\. The total number of plans in the digest is shown in the second column\. -![\[Choose a digest plan\]](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/./images/pi-digest-plan.png) - -1. Scroll down and choose two **Plans** to compare from **Plans for digest query** list\. - - You can view either one or two plans for a query at a time\. The following screenshot compares the two plans in the digest, with hash 2032253151 and hash 1117438016\. In the following example, 62% of the average active sessions running this digest query are using the plan on the left, whereas 38% are using the plan on the right\. -![\[Compare the plans side by side\]](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/./images/pi-compare-plan.png) - - In this example, the plans differ in an important way\. Step 2 in plan 2032253151 uses an index scan, whereas plan 1117438016 uses a full table scan\. For a table with a large number of rows, a query of a single row is almost always faster with an index scan\. -![\[Compare the plans side by side\]](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/./images/pi-table-access.png) - -1. \(Optional\) Choose **Copy** to copy the plan to the clipboard, or **Download** to save the plan to your hard drive\. \ No newline at end of file diff --git a/doc_source/USER_PerfInsights.UsingDashboard.AnalyzeDBLoad.AdditionalMetrics.AnalyzingSQLLevel.md b/doc_source/USER_PerfInsights.UsingDashboard.AnalyzeDBLoad.AdditionalMetrics.AnalyzingSQLLevel.md deleted file mode 100644 index 4d44b9b..0000000 --- a/doc_source/USER_PerfInsights.UsingDashboard.AnalyzeDBLoad.AdditionalMetrics.AnalyzingSQLLevel.md +++ /dev/null @@ -1,31 +0,0 @@ -# Viewing SQL statistics in the Performance Insights dashboard - -In the Performance Insights dashboard, SQL statistics are available in the **Top SQL** tab of the **Database load** chart\. - -**To view SQL statistics** - -1. Open the Amazon RDS console at [https://console\.aws\.amazon\.com/rds/](https://console.aws.amazon.com/rds/)\. - -1. In the left navigation pane, choose **Performance Insights**\. - -1. At the top of the page, choose the database whose SQL statistics you want to see\. - -1. Scroll to the bottom of the page and choose the **Top SQL** tab\. - -1. Choose an individual statement or digest query\. -![\[Viewing metrics for running queries\]](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/./images/perf_insights_per_sql_sql.png) - -1. Choose which statistics to display by choosing the gear icon in the upper\-right corner of the chart\. For descriptions of the SQL statistics for the Amazon RDS engines, see [SQL statistics for Performance Insights](sql-statistics.md)\. - - The following example shows the statistics preferences for Oracle DB instances\. -![\[Preferences for metrics for running queries for Oracle DB instances\]](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/./images/perf_insights_per_sql_pref_oracle.png) - - The following example shows the preferences for MariaDB and MySQL DB instances\. -![\[Preferences for metrics for running queries for MariaDB and MySQL DB instances.\]](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/./images/perf_insights_per_sql_pref_ams.png) - -1. Choose Save to save your preferences\. - - The **Top SQL** table refreshes\. - - The following example shows statistics for an Oracle SQL query\. -![\[Statistics for a SQL query\]](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/./images/perf_insights_per_sql_stats_oracle.png) \ No newline at end of file diff --git a/doc_source/USER_PerfInsights.UsingDashboard.AnalyzeDBLoad.AdditionalMetrics.MySQL.md b/doc_source/USER_PerfInsights.UsingDashboard.AnalyzeDBLoad.AdditionalMetrics.MySQL.md deleted file mode 100644 index 9228f9e..0000000 --- a/doc_source/USER_PerfInsights.UsingDashboard.AnalyzeDBLoad.AdditionalMetrics.MySQL.md +++ /dev/null @@ -1,72 +0,0 @@ -# SQL statistics for MariaDB and MySQL - -MariaDB and MySQL collect SQL statistics only at the digest level\. No statistics are shown at the statement level\. - -**Topics** -+ [Digest statistics for MariaDB and MySQL](#USER_PerfInsights.UsingDashboard.AnalyzeDBLoad.AdditionalMetrics.MySQL.truncation) -+ [Per\-second statistics for MariaDB and MySQL](#USER_PerfInsights.UsingDashboard.AnalyzeDBLoad.AdditionalMetrics.MySQL.per-second) -+ [Per\-call statistics for MariaDB and MySQL](#USER_PerfInsights.UsingDashboard.AnalyzeDBLoad.AdditionalMetrics.MySQL.truncation.per-call) - -## Digest statistics for MariaDB and MySQL - -Performance Insights collects SQL digest statistics from the `events_statements_summary_by_digest` table\. The `events_statements_summary_by_digest` table is managed by your database\. - -The digest table doesn't have an eviction policy\. When the table is full, the AWS Management Console shows the following message: - -``` -Performance Insights is unable to collect SQL Digest statistics on new queries because the table events_statements_summary_by_digest is full. -Please truncate events_statements_summary_by_digest table to clear the issue. Check the User Guide for more details. -``` - -In this situation, MariaDB and MySQL don't track SQL queries\. To address this issue, Performance Insights automatically truncates the digest table when both of the following conditions are met: -+ The table is full\. -+ Performance Insights manages the Performance Schema automatically\. - - For automatic management, the `performance_schema` parameter must be set to `0` and the **Source** must not be set to `user`\. If Performance Insights isn't managing the Performance Schema automatically, see [Turning on the Performance Schema for Performance Insights on Amazon RDS for MariaDB or MySQL](USER_PerfInsights.EnableMySQL.md)\. - -In the AWS CLI, check the source of a parameter value by running the [describe\-db\-parameters](https://docs.aws.amazon.com/cli/latest/reference/rds/describe-db-parameters.html) command\. - -## Per\-second statistics for MariaDB and MySQL - -The following SQL statistics are available for MariaDB and MySQL DB instances\. - - -| Metric | Unit | -| --- | --- | -| db\.sql\_tokenized\.stats\.count\_star\_per\_sec | Calls per second | -| db\.sql\_tokenized\.stats\.sum\_timer\_wait\_per\_sec | Average active executions per second \(AAE\) | -| db\.sql\_tokenized\.stats\.sum\_select\_full\_join\_per\_sec | Select full join per second | -| db\.sql\_tokenized\.stats\.sum\_select\_range\_check\_per\_sec | Select range check per second | -| db\.sql\_tokenized\.stats\.sum\_select\_scan\_per\_sec | Select scan per second | -| db\.sql\_tokenized\.stats\.sum\_sort\_merge\_passes\_per\_sec | Sort merge passes per second | -| db\.sql\_tokenized\.stats\.sum\_sort\_scan\_per\_sec | Sort scans per second | -| db\.sql\_tokenized\.stats\.sum\_sort\_range\_per\_sec | Sort ranges per second | -| db\.sql\_tokenized\.stats\.sum\_sort\_rows\_per\_sec | Sort rows per second | -| db\.sql\_tokenized\.stats\.sum\_rows\_affected\_per\_sec | Rows affected per second | -| db\.sql\_tokenized\.stats\.sum\_rows\_examined\_per\_sec | Rows examined per second | -| db\.sql\_tokenized\.stats\.sum\_rows\_sent\_per\_sec | Rows sent per second | -| db\.sql\_tokenized\.stats\.sum\_created\_tmp\_disk\_tables\_per\_sec | Created temporary disk tables per second | -| db\.sql\_tokenized\.stats\.sum\_created\_tmp\_tables\_per\_sec | Created temporary tables per second | -| db\.sql\_tokenized\.stats\.sum\_lock\_time\_per\_sec | Lock time per second \(in ms\) | - -## Per\-call statistics for MariaDB and MySQL - -The following metrics provide per call statistics for a SQL statement\. - - -| Metric | Unit | -| --- | --- | -| db\.sql\_tokenized\.stats\.sum\_timer\_wait\_per\_call | Average latency per call \(in ms\) | -| db\.sql\_tokenized\.stats\.sum\_select\_full\_join\_per\_call | Select full joins per call | -| db\.sql\_tokenized\.stats\.sum\_select\_range\_check\_per\_call | Select range check per call | -| db\.sql\_tokenized\.stats\.sum\_select\_scan\_per\_call | Select scans per call | -| db\.sql\_tokenized\.stats\.sum\_sort\_merge\_passes\_per\_call | Sort merge passes per call | -| db\.sql\_tokenized\.stats\.sum\_sort\_scan\_per\_call | Sort scans per call | -| db\.sql\_tokenized\.stats\.sum\_sort\_range\_per\_call | Sort ranges per call | -| db\.sql\_tokenized\.stats\.sum\_sort\_rows\_per\_call | Sort rows per call | -| db\.sql\_tokenized\.stats\.sum\_rows\_affected\_per\_call | Rows affected per call | -| db\.sql\_tokenized\.stats\.sum\_rows\_examined\_per\_call | Rows examined per call | -| db\.sql\_tokenized\.stats\.sum\_rows\_sent\_per\_call | Rows sent per call | -| db\.sql\_tokenized\.stats\.sum\_created\_tmp\_disk\_tables\_per\_call | Created temporary disk tables per call | -| db\.sql\_tokenized\.stats\.sum\_created\_tmp\_tables\_per\_call | Created temporary tables per call | -| db\.sql\_tokenized\.stats\.sum\_lock\_time\_per\_call | Lock time per call \(in ms\) | \ No newline at end of file diff --git a/doc_source/USER_PerfInsights.UsingDashboard.AnalyzeDBLoad.AdditionalMetrics.Oracle.md b/doc_source/USER_PerfInsights.UsingDashboard.AnalyzeDBLoad.AdditionalMetrics.Oracle.md deleted file mode 100644 index fa82e91..0000000 --- a/doc_source/USER_PerfInsights.UsingDashboard.AnalyzeDBLoad.AdditionalMetrics.Oracle.md +++ /dev/null @@ -1,67 +0,0 @@ -# SQL statistics for Oracle - -Amazon RDS for Oracle collects SQL statistics both at the statement and digest level\. At the statement level, the ID column represents the value of `V$SQL.SQL_ID`\. At the digest level, the ID column shows the value of `V$SQL.FORCE_MATCHING_SIGNATURE`\. - -If the ID is `0` at the digest level, Oracle Database has determined that this statement is not suitable for reuse\. In this case, the child SQL statements could belong to different digests\. However, the statements are grouped together under the `digest_text` for the first SQL statement collected\. - -**Topics** -+ [Per\-second statistics for Oracle](#USER_PerfInsights.UsingDashboard.AnalyzeDBLoad.AdditionalMetrics.Oracle.per-second) -+ [Per\-call statistics for Oracle](#USER_PerfInsights.UsingDashboard.AnalyzeDBLoad.AdditionalMetrics.Oracle.per-call) - -## Per\-second statistics for Oracle - -The following metrics provide per\-second statistics for an Oracle SQL query\. - - -| Metric | Unit | -| --- | --- | -| db\.sql\.stats\.executions\_per\_sec | Number of executions per second | -| db\.sql\.stats\.elapsed\_time\_per\_sec | Average active executions \(AAE\) | -| db\.sql\.stats\.rows\_processed\_per\_sec | Rows processed per second | -| db\.sql\.stats\.buffer\_gets\_per\_sec | Buffer gets per second | -| db\.sql\.stats\.physical\_read\_requests\_per\_sec | Physical reads per second | -| db\.sql\.stats\.physical\_write\_requests\_per\_sec | Physical writes per second | -| db\.sql\.stats\.total\_sharable\_mem\_per\_sec | Total shareable memory per second \(in bytes\) | -| db\.sql\.stats\.cpu\_time\_per\_sec | CPU time per second \(in ms\) | - -The following metrics provide per\-call statistics for an Oracle SQL digest query\. - - -| Metric | Unit | -| --- | --- | -| db\.sql\_tokenized\.stats\.executions\_per\_sec | Number of executions per second | -| db\.sql\_tokenized\.stats\.elapsed\_time\_per\_sec | Average active executions \(AAE\) | -| db\.sql\_tokenized\.stats\.rows\_processed\_per\_sec | Rows processed per second | -| db\.sql\_tokenized\.stats\.buffer\_gets\_per\_sec | Buffer gets per second | -| db\.sql\_tokenized\.stats\.physical\_read\_requests\_per\_sec | Physical reads per second | -| db\.sql\_tokenized\.stats\.physical\_write\_requests\_per\_sec | Physical writes per second | -| db\.sql\_tokenized\.stats\.total\_sharable\_mem\_per\_sec | Total shareable memory per second \(in bytes\) | -| db\.sql\_tokenized\.stats\.cpu\_time\_per\_sec | CPU time per second \(in ms\) | - -## Per\-call statistics for Oracle - -The following metrics provide per\-call statistics for an Oracle SQL statement\. - - -| Metric | Unit | -| --- | --- | -| db\.sql\.stats\.elapsed\_time\_per\_exec | Elapsed time per executions \(in ms\) | -| db\.sql\.stats\.rows\_processed\_per\_exec | Rows processed per execution | -| db\.sql\.stats\.buffer\_gets\_per\_exec | Buffer gets per execution | -| db\.sql\.stats\.physical\_read\_requests\_per\_exec | Physical reads per execution | -| db\.sql\.stats\.physical\_write\_requests\_per\_exec | Physical writes per execution | -| db\.sql\.stats\.total\_sharable\_mem\_per\_exec | Total shareable memory per execution \(in bytes\) | -| db\.sql\.stats\.cpu\_time\_per\_exec | CPU time per execution \(in ms\) | - -The following metrics provide per\-call statistics for an Oracle SQL digest query\. - - -| Metric | Unit | -| --- | --- | -| db\.sql\_tokenized\.stats\.elapsed\_time\_per\_exec | Elapsed time per executions \(in ms\) | -| db\.sql\_tokenized\.stats\.rows\_processed\_per\_exec | Rows processed per execution | -| db\.sql\_tokenized\.stats\.buffer\_gets\_per\_exec | Buffer gets per execution | -| db\.sql\_tokenized\.stats\.physical\_read\_requests\_per\_exec | Physical reads per execution | -| db\.sql\_tokenized\.stats\.physical\_write\_requests\_per\_exec | Physical writes per execution | -| db\.sql\_tokenized\.stats\.total\_sharable\_mem\_per\_exec | Total shareable memory per execution \(in bytes\) | -| db\.sql\_tokenized\.stats\.cpu\_time\_per\_exec | CPU time per execution \(in ms\) | \ No newline at end of file diff --git a/doc_source/USER_PerfInsights.UsingDashboard.AnalyzeDBLoad.AdditionalMetrics.PostgreSQL.md b/doc_source/USER_PerfInsights.UsingDashboard.AnalyzeDBLoad.AdditionalMetrics.PostgreSQL.md deleted file mode 100644 index 644f5d5..0000000 --- a/doc_source/USER_PerfInsights.UsingDashboard.AnalyzeDBLoad.AdditionalMetrics.PostgreSQL.md +++ /dev/null @@ -1,64 +0,0 @@ -# SQL statistics for RDS PostgreSQL - -For each SQL call and for each second that a query runs, Performance Insights collects SQL statistics\. RDS for PostgreSQL collect SQL statistics only at the digest–level\. No statistics are shown at the statement\-level\. - -Following, you can find information about digest\-level statistics for RDS for PostgreSQL\. - -**Topics** -+ [Digest statistics for RDS PostgreSQL](#USER_PerfInsights.UsingDashboard.AnalyzeDBLoad.AdditionalMetrics.PostgreSQL.digest) -+ [Per\-second digest statistics for RDS PostgreSQL](#USER_PerfInsights.UsingDashboard.AnalyzeDBLoad.AdditionalMetrics.PostgreSQL.per-second) -+ [Per\-call digest statistics for RDS PostgreSQL](#USER_PerfInsights.UsingDashboard.AnalyzeDBLoad.AdditionalMetrics.PostgreSQL.per-call) - -## Digest statistics for RDS PostgreSQL - -To view SQL digest statistics, RDS PostgreSQL must load the `pg_stat_statements` library\. For PostgreSQL DB instances that are compatible with PostgreSQL 11 or later, the database loads this library by default\. For PostgreSQL DB instances that are compatible with PostgreSQL 10 or earlier, enable this library manually\. To enable it manually, add `pg_stat_statements` to `shared_preload_libraries` in the DB parameter group associated with the DB instance\. Then reboot your DB instance\. For more information, see [Working with parameter groups](USER_WorkingWithParamGroups.md)\. - -**Note** -Performance Insights can only collect statistics for queries in `pg_stat_activity` that aren't truncated\. By default, PostgreSQL databases truncate queries longer than 1,024 bytes\. To increase the query size, change the `track_activity_query_size` parameter in the DB parameter group associated with your DB instance\. When you change this parameter, a DB instance reboot is required\. - -## Per\-second digest statistics for RDS PostgreSQL - -The following SQL digest statistics are available for PostgreSQL DB instances\. - - -| Metric | Unit | -| --- | --- | -| db\.sql\_tokenized\.stats\.calls\_per\_sec | Calls per second | -| db\.sql\_tokenized\.stats\.rows\_per\_sec | Rows per second | -| db\.sql\_tokenized\.stats\.total\_time\_per\_sec | Average active executions per second \(AAE\) | -| db\.sql\_tokenized\.stats\.shared\_blks\_hit\_per\_sec | Block hits per second | -| db\.sql\_tokenized\.stats\.shared\_blks\_read\_per\_sec | Block reads per second | -| db\.sql\_tokenized\.stats\.shared\_blks\_dirtied\_per\_sec | Blocks dirtied per second | -| db\.sql\_tokenized\.stats\.shared\_blks\_written\_per\_sec | Block writes per second | -| db\.sql\_tokenized\.stats\.local\_blks\_hit\_per\_sec | Local block hits per second | -| db\.sql\_tokenized\.stats\.local\_blks\_read\_per\_sec | Local block reads per second | -| db\.sql\_tokenized\.stats\.local\_blks\_dirtied\_per\_sec | Local block dirty per second | -| db\.sql\_tokenized\.stats\.local\_blks\_written\_per\_sec | Local block writes per second | -| db\.sql\_tokenized\.stats\.temp\_blks\_written\_per\_sec | Temporary writes per second | -| db\.sql\_tokenized\.stats\.temp\_blks\_read\_per\_sec | Temporary reads per second | -| db\.sql\_tokenized\.stats\.blk\_read\_time\_per\_sec | Average concurrent reads per second | -| db\.sql\_tokenized\.stats\.blk\_write\_time\_per\_sec | Average concurrent writes per second | - -## Per\-call digest statistics for RDS PostgreSQL - -The following metrics provide per call statistics for a SQL statement\. - - -| Metric | Unit | -| --- | --- | -| db\.sql\_tokenized\.stats\.rows\_per\_call | Rows per call | -| db\.sql\_tokenized\.stats\.avg\_latency\_per\_call | Average latency per call \(in ms\) | -| db\.sql\_tokenized\.stats\.shared\_blks\_hit\_per\_call | Block hits per call | -| db\.sql\_tokenized\.stats\.shared\_blks\_read\_per\_call | Block reads per call | -| db\.sql\_tokenized\.stats\.shared\_blks\_written\_per\_call | Block writes per call | -| db\.sql\_tokenized\.stats\.shared\_blks\_dirtied\_per\_call | Blocks dirtied per call | -| db\.sql\_tokenized\.stats\.local\_blks\_hit\_per\_call | Local block hits per call | -| db\.sql\_tokenized\.stats\.local\_blks\_read\_per\_call | Local block reads per call | -| db\.sql\_tokenized\.stats\.local\_blks\_dirtied\_per\_call | Local block dirty per call | -| db\.sql\_tokenized\.stats\.local\_blks\_written\_per\_call | Local block writes per call | -| db\.sql\_tokenized\.stats\.temp\_blks\_written\_per\_call | Temporary block writes per call | -| db\.sql\_tokenized\.stats\.temp\_blks\_read\_per\_call | Temporary block reads per call | -| db\.sql\_tokenized\.stats\.blk\_read\_time\_per\_call | Read time per call \(in ms\) | -| db\.sql\_tokenized\.stats\.blk\_write\_time\_per\_call | Write time per call \(in ms\) | - -For more information about these metrics, see [pg\_stat\_statements](https://www.postgresql.org/docs/current/pgstatstatements.html) in the PostgreSQL documentation\. \ No newline at end of file diff --git a/doc_source/USER_PerfInsights.UsingDashboard.AnalyzeDBLoad.AdditionalMetrics.md b/doc_source/USER_PerfInsights.UsingDashboard.AnalyzeDBLoad.AdditionalMetrics.md deleted file mode 100644 index bc6f03a..0000000 --- a/doc_source/USER_PerfInsights.UsingDashboard.AnalyzeDBLoad.AdditionalMetrics.md +++ /dev/null @@ -1,11 +0,0 @@ -# Analyzing queries in the Performance Insights dashboard - -In the Amazon RDS Performance Insights dashboard, you can find information about running and recent queries in the **Top SQL** tab in the **Top dimensions** table\. You can use this information to tune your queries\. - -**Note** -RDS for SQL Server doesn't show SQL\-level statistics\. - -**Topics** -+ [Overview of the Top SQL tab](USER_PerfInsights.UsingDashboard.Components.AvgActiveSessions.TopLoadItemsTable.TopSQL.md) -+ [Accessing more SQL text in the Performance Insights dashboard](USER_PerfInsights.UsingDashboard.SQLTextSize.md) -+ [Viewing SQL statistics in the Performance Insights dashboard](USER_PerfInsights.UsingDashboard.AnalyzeDBLoad.AdditionalMetrics.AnalyzingSQLLevel.md) \ No newline at end of file diff --git a/doc_source/USER_PerfInsights.UsingDashboard.AnalyzeDBLoad.md b/doc_source/USER_PerfInsights.UsingDashboard.AnalyzeDBLoad.md deleted file mode 100644 index 2e999b9..0000000 --- a/doc_source/USER_PerfInsights.UsingDashboard.AnalyzeDBLoad.md +++ /dev/null @@ -1,19 +0,0 @@ -# Analyzing DB load by wait events - -If the **Database load** chart shows a bottleneck, you can find out where the load is coming from\. To do so, look at the top load items table below the **Database load** chart\. Choose a particular item, like a SQL query or a user, to drill down into that item and see details about it\. - -DB load grouped by waits and top SQL queries is the default Performance Insights dashboard view\. This combination typically provides the most insight into performance issues\. DB load grouped by waits shows if there are any resource or concurrency bottlenecks in the database\. In this case, the **SQL** tab of the top load items table shows which queries are driving that load\. - -Your typical workflow for diagnosing performance issues is as follows: - -1. Review the **Database load** chart and see if there are any incidents of database load exceeding the **Max CPU** line\. - -1. If there is, look at the **Database load** chart and identify which wait state or states are primarily responsible\. - -1. Identify the digest queries causing the load by seeing which of the queries the **SQL** tab on the top load items table are contributing most to those wait states\. You can identify these by the **DB Load by Wait** column\. - -1. Choose one of these digest queries in the **SQL** tab to expand it and see the child queries that it is composed of\. - -For example, in the dashboard following, **log file sync** waits account for most of the DB load\. The **LGWR all worker groups** wait is also high\. The **Top SQL** chart shows what is causing the **log file sync** waits: frequent `COMMIT` statements\. In this case, committing less frequently will reduce DB load\. - -![\[log file sync errors\]](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/./images/perf_insights_7.png) \ No newline at end of file diff --git a/doc_source/USER_PerfInsights.UsingDashboard.Components.AvgActiveSessions.TopLoadItemsTable.TopSQL.md b/doc_source/USER_PerfInsights.UsingDashboard.Components.AvgActiveSessions.TopLoadItemsTable.TopSQL.md deleted file mode 100644 index 9c9b332..0000000 --- a/doc_source/USER_PerfInsights.UsingDashboard.Components.AvgActiveSessions.TopLoadItemsTable.TopSQL.md +++ /dev/null @@ -1,84 +0,0 @@ -# Overview of the Top SQL tab - -By default, the **Top SQL** tab shows the 25 queries that are contributing the most to DB load\. To help tune your queries, you can analyze information such as the query text and SQL statistics\. You can also choose the statistics that you want to appear in the **Top SQL** tab\. - -**Topics** -+ [SQL text](#USER_PerfInsights.UsingDashboard.Components.AvgActiveSessions.TopLoadItemsTable.TopSQL.text) -+ [SQL statistics](#USER_PerfInsights.UsingDashboard.Components.AvgActiveSessions.TopLoadItemsTable.TopSQL.statistics) -+ [Load by waits \(AAS\)](#USER_PerfInsights.UsingDashboard.Components.AvgActiveSessions.TopLoadItemsTable.TopSQL.Load-by-waits) -+ [SQL information](#USER_PerfInsights.UsingDashboard.Components.AvgActiveSessions.TopLoadItemsTable.TopSQL.SQL-information) -+ [Preferences](#USER_PerfInsights.UsingDashboard.Components.AvgActiveSessions.TopLoadItemsTable.TopSQL.Preferences) - -## SQL text - -By default, each row in the **Top SQL** table shows 500 bytes of text for each statement\. - -![\[SQL text\]](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/./images/sql-text-oracle.png) - -To learn how to see more than the default 500 bytes of SQL text, see [Accessing more SQL text in the Performance Insights dashboard](USER_PerfInsights.UsingDashboard.SQLTextSize.md)\. - -A *SQL digest* is a composite of multiple actual queries that are structurally similar but might have different literal values\. The digest replaces hardcoded values with a question mark\. For example, a digest might be `SELECT * FROM emp WHERE lname= ?`\. This digest might include the following child queries: - -``` -SELECT * FROM emp WHERE lname = 'Sanchez' -SELECT * FROM emp WHERE lname = 'Olagappan' -SELECT * FROM emp WHERE lname = 'Wu' -``` - -To see the literal SQL statements in a digest, select the query, and then choose the plus symbol \(\+\)\. In the following example, the selected query is a digest\. - -![\[Selected SQL digest\]](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/./images/perf_insights_4b.png) - -**Note** -A SQL digest groups similar SQL statements, but doesn't redact sensitive information\. - -Performance Insights can show Oracle SQL text as **Unknown**\. The text has this status in the following situations: -+ An Oracle database user other than `SYS` is active but not currently executing SQL\. For example, when a parallel query completes, the query coordinator waits for helper processes to send their session statistics\. For the duration of the wait, the query text shows **Unknown**\. -+ For an RDS for Oracle instance on Standard Edition 2, Oracle Resource Manager limits the number of parallel threads\. The background process doing this work causes the query text to show as **Unknown**\. - -## SQL statistics - -*SQL statistics* are performance\-related metrics about SQL queries\. For example, Performance Insights might show executions per second or rows processed per second\. Performance Insights collects statistics for only the most common queries\. Typically, these match the top queries by load shown in the Performance Insights dashboard\. - -Every line in the **Top SQL** table shows relevant statistics for the SQL statement or digest, as shown in the following example\. - -![\[Top SQL\]](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/./images/perf_insights_4.png) - -Performance Insights can report `0.00` and `-` \(unknown\) for SQL statistics\. This situation occurs under the following conditions: -+ Only one sample exists\. For example, Performance Insights calculates rates of change for RDS PostgreSQL queries based on multiple samples from the `pg_stats_statements` view\. When a workload runs for a short time, Performance Insights might collect only one sample, which means that it can't calculate a rate of change\. The unknown value is represented with a dash \(`-`\)\. -+ Two samples have the same values\. Performance Insights can't calculate a rate of change because no change has occurred, so it reports the rate as `0.00`\. -+ An RDS PostgreSQL statement lacks a valid identifier\. PostgreSQL creates a identifier for a statement only after parsing and analysis\. Thus, a statement can exist in the PostgreSQL internal in\-memory structures with no identifier\. Because Performance Insights samples internal in\-memory structures once per second, low\-latency queries might appear for only a single sample\. If the query identifier isn't available for this sample, Performance Insights can't associate this statement with its statistics\. The unknown value is represented with a dash \(`-`\)\. - -For a description of the SQL statistics for the Amazon RDS engines, see [SQL statistics for Performance Insights](sql-statistics.md)\. - -## Load by waits \(AAS\) - -In **Top SQL**, the **Load by waits \(AAS\)** column illustrates the percentage of the database load associated with each top load item\. This column reflects the load for that item by whatever grouping is currently selected in the **DB Load Chart**\. For more information about Average active sessions \(AAS\), see [Average active sessions](USER_PerfInsights.Overview.ActiveSessions.md#USER_PerfInsights.Overview.ActiveSessions.AAS)\. - -For example, you might group the **DB load** chart by wait states\. You examine SQL queries in the top load items table\. In this case, the **DB Load by Waits** bar is sized, segmented, and color\-coded to show how much of a given wait state that query is contributing to\. It also shows which wait states are affecting the selected query\. - -![\[DB load by waits\]](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/./images/perf_insights_6.png) - -## SQL information - -In the **Top SQL** table, you can open a statement to view its information\. The information appears in the bottom pane\. - -![\[Top SQL table with literal query selected\]](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/./images/perf-insights-sql-ids-open.png) - -The following types of identifiers \(IDs\) that are associated with SQL statements: -+ **Support SQL ID** – A hash value of the SQL ID\. This value is only for referencing a SQL ID when you are working with AWS Support\. AWS Support doesn't have access to your actual SQL IDs and SQL text\. -+ **Support Digest ID** – A hash value of the digest ID\. This value is only for referencing a digest ID when you are working with AWS Support\. AWS Support doesn't have access to your actual digest IDs and SQL text\. - -## Preferences - -You can control the statistics displayed in the **Top SQL** tab by choosing the **Preferences** icon\. - -![\[Statistics preferences\]](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/./images/perf-insights-sql-ids-preferences-icon.png) - -When you choose the **Preferences** icon, the **Preferences** window opens\. The following screenshot is an example of the **Preferences** window\. - -![\[Preferences window\]](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/./images/perf-insights-sql-ids-preferences.png) - -To enable the statistics that you want to appear in the **Top SQL** tab, use your mouse to scroll to the bottom of the window, and then choose **Continue**\. - -For more information about per\-second or per\-call statistics for the Amazon RDS engines, see the engine specific SQL statistics section in [SQL statistics for Performance Insights](sql-statistics.md) \ No newline at end of file diff --git a/doc_source/USER_PerfInsights.UsingDashboard.Components.md b/doc_source/USER_PerfInsights.UsingDashboard.Components.md deleted file mode 100644 index 6228040..0000000 --- a/doc_source/USER_PerfInsights.UsingDashboard.Components.md +++ /dev/null @@ -1,96 +0,0 @@ -# Overview of the Performance Insights dashboard - -The dashboard is the easiest way to interact with Performance Insights\. The following example shows the dashboard for a MySQL DB instance\. - -![\[Filter metrics\]](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/./images/perf_insights_0b.png) - -**Topics** -+ [Time range filter](#USER_PerfInsights.UsingDashboard.Components.time-range) -+ [Counter metrics chart](#USER_PerfInsights.UsingDashboard.Components.Countermetrics) -+ [Database load chart](#USER_PerfInsights.UsingDashboard.Components.AvgActiveSessions) -+ [Top dimensions table](#USER_PerfInsights.UsingDashboard.Components.AvgActiveSessions.TopLoadItemsTable) - -## Time range filter - -By default, the Performance Insights dashboard shows DB load for the last hour\. You can adjust this range to be as short as 5 minutes or as long as 2 years\. You can also select a custom relative range\. - -![\[Performance Insights relative time\]](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/./images/perf-insights-relative-time.png) - -You can select an absolute range with a beginning and ending date and time\. The following example shows the time range beginning at midnight on 4/11/22 and ending at 11:59 PM on 4/14/22\. - -![\[Performance Insights absolute time\]](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/./images/perf-insights-absolute-time.png) - -## Counter metrics chart - -With counter metrics, you can customize the Performance Insights dashboard to include up to 10 additional graphs\. These graphs show a selection of dozens of operating system and database performance metrics\. You can correlate this information with DB load to help identify and analyze performance problems\. - - The **Counter metrics** chart displays data for performance counters\. The default metrics depend on the DB engine: -+ MySQL and MariaDB – `db.SQL.Innodb_rows_read.avg` -+ Oracle – `db.User.user calls.avg` -+ Microsoft SQL Server – `db.Databases.Active Transactions(_Total).avg` -+ PostgreSQL – `db.Transactions.xact_commit.avg` - -![\[Counter metrics\]](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/./images/oracle_perf_insights_counters.png) - -To change the performance counters, choose **Manage Metrics**\. You can select multiple **OS metrics** or **Database metrics**, as shown in the following screenshot\. To see details for any metric, hover over the metric name\. - -![\[Filter metrics\]](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/./images/perf_insights_select_metrics.png) - -For descriptions of the counter metrics that you can add for each DB engine, see [Performance Insights counter metrics](USER_PerfInsights_Counters.md)\. - -## Database load chart - -The **Database load** chart shows how the database activity compares to DB instance capacity as represented by the **Max vCPU** line\. By default, the stacked line chart represents DB load as average active sessions per unit of time\. The DB load is sliced \(grouped\) by wait states\. - -![\[Database load\]](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/./images/perf_insights_2.png) - -### DB load sliced by dimensions - -You can choose to display load as active sessions grouped by any supported dimensions\. The following table shows which dimensions are supported for the different engines\. - - -| Dimension | Oracle | SQL Server | PostgreSQL | MySQL | -| --- | --- | --- | --- | --- | -| Host | Yes | Yes | Yes | Yes | -| SQL | Yes | Yes | Yes | Yes | -| User | Yes | Yes | Yes | Yes | -| Waits | Yes | Yes | Yes | Yes | -| Plans | Yes | No | No | No | -| Application | No | No | Yes | No | -| Database | No | No | Yes | Yes | -| Session type | No | No | Yes | No | - -The following image shows the dimensions for a PostgreSQL DB instance\. - -![\[Filter metrics\]](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/./images/perf_insights_2b.png) - -### DB load details for a dimension item - -To see details about a DB load item within a dimension, hover over the item name\. The following image shows details for a SQL statement\. - -![\[Database load item details\]](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/./images/perf_insights_2c.png) - -To see details for any item for the selected time period in the legend, hover over that item\. - -![\[Time period details for DB load\]](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/./images/perf_insights_3.png) - -## Top dimensions table - -The Top dimensions table slices DB load by different dimensions\. A dimension is a category or "slice by" for different characteristics of DB load\. If the dimension is SQL, **Top SQL** shows the SQL statements that contribute the most to DB load\. - -![\[Top N dimensions\]](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/./images/perf_insights_4c.png) - -Choose any of the following dimension tabs\. - - -| Tab | Description | Supported engines | -| --- | --- | --- | -| Top SQL | The SQL statements that are currently running | All | -| Top waits | The event for which the database backend is waiting | All | -| Top hosts | The host name of the connected client | All | -| Top users | The user logged in to the database | All | -| Top databases | The name of the database to which the client is connected | PostgreSQL, MySQL, and MariaDB only | -| Top applications | The name of the application that is connected to the database | PostgreSQL only | -| Top session types | The type of the current session | PostgreSQL only | - -To learn how to analyze queries by using the **Top SQL** tab, see [Overview of the Top SQL tab](USER_PerfInsights.UsingDashboard.Components.AvgActiveSessions.TopLoadItemsTable.TopSQL.md)\. \ No newline at end of file diff --git a/doc_source/USER_PerfInsights.UsingDashboard.Opening.md b/doc_source/USER_PerfInsights.UsingDashboard.Opening.md deleted file mode 100644 index 347b18a..0000000 --- a/doc_source/USER_PerfInsights.UsingDashboard.Opening.md +++ /dev/null @@ -1,50 +0,0 @@ -# Accessing the Performance Insights dashboard - -Amazon RDS provides a consolidated view of Performance Insights and CloudWatch metrics in the Performance Insights dashboard\. - -To access the Performance Insights dashboard, use the following procedure\. - -**To view the Performance Insights dashboard in the AWS Management Console** - -1. Open the Amazon RDS console at [https://console\.aws\.amazon\.com/rds/](https://console.aws.amazon.com/rds/)\. - -1. In the left navigation pane, choose **Performance Insights**\. - -1. Choose a DB instance\. - -1. Choose the default monitoring view in the displayed window\. - + Select the **Performance Insights and CloudWatch metrics view \(New\)** option and choose **Continue** to view Performance Insights and CloudWatch metrics\. - + Select the **Performance Insights view** option and choose **Continue** for the legacy monitoring view\. Then, continue with this procedure\. -**Note** -This view will be discontinued on December 15, 2023\. - - The Performance Insights dashboard appears for the DB instance\. - - For DB instances with Performance Insights turned on, you can also access the dashboard by choosing the **Sessions** item in the list of DB instances\. Under **Current activity**, the **Sessions** item shows the database load in average active sessions over the last five minutes\. The bar graphically shows the load\. When the bar is empty, the DB instance is idle\. As the load increases, the bar fills with blue\. When the load passes the number of virtual CPUs \(vCPUs\) on the DB instance class, the bar turns red, indicating a potential bottleneck\. -![\[Filter metrics\]](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/./images/perf_insights_0a.png) - -1. \(Optional\) Choose the date or time range in the upper right and specify a different relative or absolute time interval\. - - In the following example, the DB load is shown for the last 5 hours\. -![\[Filter metrics by time interval\]](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/./images/perf_insights_0c.png) - - In the following screenshot, the DB load interval is 5 hours\. -![\[Set time interval to 5 hours\]](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/./images/perf_insights_1.png) - -1. \(Optional\) To zoom in on a portion of the DB load chart, choose the start time and drag to the end of the time period you want\. - - The selected area is highlighted in the DB load chart\. -![\[DB load for a specified time interval\]](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/./images/perf_insights_zoom_in.png) - - When you release the mouse, the DB load chart zooms in on the selected AWS Region, and the **Top *dimensions*** table is recalculated\. -![\[Zoom in on the selected DB load\]](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/./images/perf_insights_zoom_in_b.png) - -1. \(Optional\) To refresh your data automatically, select **Auto refresh**\. -![\[Set automatic refresh\]](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/./images/perf_insights_1b.png) - - The Performance Insights dashboard automatically refreshes with new data\. The refresh rate depends on the amount of data displayed: - + 5 minutes refreshes every 5 seconds\. - + 1 hour refreshes every minute\. - + 5 hours refreshes every minute\. - + 24 hours refreshes every 5 minutes\. - + 1 week refreshes every hour\. \ No newline at end of file diff --git a/doc_source/USER_PerfInsights.UsingDashboard.SQLTextSize.md b/doc_source/USER_PerfInsights.UsingDashboard.SQLTextSize.md deleted file mode 100644 index 9ed0a5f..0000000 --- a/doc_source/USER_PerfInsights.UsingDashboard.SQLTextSize.md +++ /dev/null @@ -1,80 +0,0 @@ -# Accessing more SQL text in the Performance Insights dashboard - -By default, each row in the **Top SQL** table shows 500 bytes of SQL text for each SQL statement\. - -![\[500 bytes of SQL\]](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/./images/perf-insights-top-sql-bytes.png) - -When a SQL statement exceeds 500 bytes, you can view more text in the **SQL text** section below the **Top SQL** table\. In this case, the maximum length for the text displayed in **SQL text** is 4 KB\. This limit is introduced by the console and is subject to the limits set by the database engine\. To save the text shown in **SQL text**, choose **Download**\. - -**Topics** -+ [Text size limits for Amazon RDS engines](#sql-text-engine-limits) -+ [Setting the SQL text limit for Amazon RDS for PostgreSQL DB instances](#USER_PerfInsights.UsingDashboard.SQLTextLimit) -+ [Viewing and downloading SQL text in the Performance Insights dashboard](#view-download-text) - -## Text size limits for Amazon RDS engines - -When you download SQL text, the database engine determines its maximum length\. You can download SQL text up to the following per\-engine limits\. - - -| DB engine | Maximum length of downloaded text | -| --- | --- | -| Amazon RDS for MySQL and MariaDB | 1,024 bytes | -| Amazon RDS for Microsoft SQL Server | 4,096 characters | -| Amazon RDS for Oracle | 1,000 bytes | - -The **SQL text** section of the Performance Insights console displays up to the maximum that the engine returns\. For example, if MySQL returns at most 1 KB to Performance Insights, it can only collect and show 1 KB, even if the original query is larger\. Thus, when you view the query in **SQL text** or download it, Performance Insights returns the same number of bytes\. - -If you use the AWS CLI or API, Performance Insights doesn't have the 4 KB limit enforced by the console\. `DescribeDimensionKeys` and `GetResourceMetrics` return at most 500 bytes\. `GetDimensionKeyDetails` returns the full query, but the size is subject to the engine limit\. - -## Setting the SQL text limit for Amazon RDS for PostgreSQL DB instances - -Amazon RDS for PostgreSQL handles text differently\. You can set the text size limit with the DB instance parameter `track_activity_query_size`\. This parameter has the following characteristics: - -Default text size -On Amazon RDS for PostgreSQL version 9\.6, the default setting for the `track_activity_query_size` parameter is 1,024 bytes\. On Amazon RDS for PostgreSQL version 10 or higher, the default is 4,096 bytes\. - -Maximum text size -The limit for `track_activity_query_size` is 102,400 bytes for Amazon RDS for PostgreSQL version 12 and lower\. The maximum is 1 MB for version 13 and higher\. -If the engine returns 1 MB to Performance Insights, the console displays only the first 4 KB\. If you download the query, you get the full 1 MB\. In this case, viewing and downloading return different numbers of bytes\. For more information about the `track_activity_query_size` DB instance parameter, see [Run\-time Statistics](https://www.postgresql.org/docs/current/runtime-config-statistics.html) in the PostgreSQL documentation\. - -To increase the SQL text size, increase the `track_activity_query_size` limit\. To modify the parameter, change the parameter setting in the parameter group that is associated with the Amazon RDS for PostgreSQL DB instance\. - -**To change the setting when the instance uses the default parameter group** - -1. Create a new DB instance parameter group for the appropriate DB engine and DB engine version\. - -1. Set the parameter in the new parameter group\. - -1. Associate the new parameter group with the DB instance\. - -For information about setting a DB instance parameter, see [Modifying parameters in a DB parameter group](USER_WorkingWithDBInstanceParamGroups.md#USER_WorkingWithParamGroups.Modifying)\. - -## Viewing and downloading SQL text in the Performance Insights dashboard - -In the Performance Insights dashboard, you can view or download SQL text\. - -**To view more SQL text in the Performance Insights dashboard** - -1. Open the Amazon RDS console at [https://console\.aws\.amazon\.com/rds/](https://console.aws.amazon.com/rds/)\. - -1. In the navigation pane, choose **Performance Insights**\. - -1. Choose a DB instance\. - - The Performance Insights dashboard is displayed for your DB instance\. - -1. Scroll down to the **Top SQL** tab\. - -1. Choose a SQL statement\. - - SQL statements with text larger than 500 bytes look similar to the following image\. -![\[SQL statements with large text\]](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/./images/perf-insights-large-text-1.png) - -1. Scroll down to the **SQL text** tab\. -![\[SQL information section shows more of the SQL text\]](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/./images/perf-insights-large-text-2.png) - - The Performance Insights dashboard can display up to 4,096 bytes for each SQL statement\. - -1. \(Optional\) Choose **Copy** to copy the displayed SQL statement, or choose **Download** to download the SQL statement to view the SQL text up to the DB engine limit\. -**Note** -To copy or download the SQL statement, disable pop\-up blockers\. \ No newline at end of file diff --git a/doc_source/USER_PerfInsights.UsingDashboard.md b/doc_source/USER_PerfInsights.UsingDashboard.md deleted file mode 100644 index 86054a5..0000000 --- a/doc_source/USER_PerfInsights.UsingDashboard.md +++ /dev/null @@ -1,10 +0,0 @@ -# Analyzing metrics with the Performance Insights dashboard - -The Performance Insights dashboard contains database performance information to help you analyze and troubleshoot performance issues\. On the main dashboard page, you can view information about the database load\. You can "slice" DB load by dimensions such as wait events or SQL\. - -**Topics** -+ [Overview of the Performance Insights dashboard](USER_PerfInsights.UsingDashboard.Components.md) -+ [Accessing the Performance Insights dashboard](USER_PerfInsights.UsingDashboard.Opening.md) -+ [Analyzing DB load by wait events](USER_PerfInsights.UsingDashboard.AnalyzeDBLoad.md) -+ [Analyzing queries in the Performance Insights dashboard](USER_PerfInsights.UsingDashboard.AnalyzeDBLoad.AdditionalMetrics.md) -+ [Analyzing Oracle execution plans using the Performance Insights dashboard](USER_PerfInsights.UsingDashboard.AccessPlans.md) \ No newline at end of file diff --git a/doc_source/USER_PerfInsights.access-control.md b/doc_source/USER_PerfInsights.access-control.md deleted file mode 100644 index 2224a25..0000000 --- a/doc_source/USER_PerfInsights.access-control.md +++ /dev/null @@ -1,161 +0,0 @@ -# Configuring access policies for Performance Insights - -To access Performance Insights, a principal must have the appropriate permissions from AWS Identity and Access Management \(IAM\)\. You can grant access in the following ways: -+ Attach the `AmazonRDSPerformanceInsightsReadOnly` managed policy to a permission set or role\. -+ Create a custom IAM policy and attach it to a permission set or role\. - -If you specified a customer managed key when you turned on Performance Insights, make sure that users in your account have the `kms:Decrypt` and `kms:GenerateDataKey` permissions on the KMS key\. - - - -## Attaching the AmazonRDSPerformanceInsightsReadOnly policy to an IAM principal - -`AmazonRDSPerformanceInsightsReadOnly` is an AWS\-managed policy that grants access to all read\-only operations of the Amazon RDS Performance Insights API\. Currently, all operations in this API are read\-only\. - -If you attach `AmazonRDSPerformanceInsightsReadOnly` to a permission set or role, the recipient can use Performance Insights with other console features\. - -## Creating a custom IAM policy for Performance Insights - -For users who don't have the `AmazonRDSPerformanceInsightsReadOnly` policy, you can grant access to Performance Insights by creating or modifying a user\-managed IAM policy\. When you attach the policy to an IAM permission set or role, the recipient can use Performance Insights\. - -**To create a custom policy** - -1. Open the IAM console at [https://console\.aws\.amazon\.com/iam/](https://console.aws.amazon.com/iam/)\. - -1. In the navigation pane, choose **Policies**\. - -1. Choose **Create policy**\. - -1. On the **Create Policy** page, choose the JSON tab\. - -1. Copy and paste the following text, replacing *us\-east\-1* with the name of your AWS Region and *111122223333* with your customer account number\. - - ``` - { - "Version": "2012-10-17", - "Statement": [ - { - "Effect": "Allow", - "Action": "rds:DescribeDBInstances", - "Resource": "*" - }, - { - "Effect": "Allow", - "Action": "rds:DescribeDBClusters", - "Resource": "*" - }, - { - "Effect": "Allow", - "Action": "pi:DescribeDimensionKeys", - "Resource": "arn:aws:pi:us-east-1:111122223333:metrics/rds/*" - }, - { - "Effect": "Allow", - "Action": "pi:GetDimensionKeyDetails", - "Resource": "arn:aws:pi:us-east-1:111122223333:metrics/rds/*" - }, - { - "Effect": "Allow", - "Action": "pi:GetResourceMetadata", - "Resource": "arn:aws:pi:us-east-1:111122223333:metrics/rds/*" - }, - { - "Effect": "Allow", - "Action": "pi:GetResourceMetrics", - "Resource": "arn:aws:pi:us-east-1:111122223333:metrics/rds/*" - }, - { - "Effect": "Allow", - "Action": "pi:ListAvailableResourceDimensions", - "Resource": "arn:aws:pi:us-east-1:111122223333:metrics/rds/*" - }, - { - "Effect": "Allow", - "Action": "pi:ListAvailableResourceMetrics", - "Resource": "arn:aws:pi:us-east-1:111122223333:metrics/rds/*" - } - ] - } - ``` - -1. Choose **Review policy**\. - -1. Provide a name for the policy and optionally a description, and then choose **Create policy**\. - -You can now attach the policy to a permission set or role\. The following procedure assumes that you already have a user available for this purpose\. - -**To attach the policy to a user** - -1. Open the IAM console at [https://console\.aws\.amazon\.com/iam/](https://console.aws.amazon.com/iam/)\. - -1. In the navigation pane, choose **Users**\. - -1. Choose an existing user from the list\. -**Important** -To use Performance Insights, make sure that you have access to Amazon RDS in addition to the custom policy\. For example, the `AmazonRDSPerformanceInsightsReadOnly` predefined policy provides read\-only access to Amazon RDS\. For more information, see [Managing access using policies](UsingWithRDS.IAM.md#security_iam_access-manage)\. - -1. On the **Summary** page, choose **Add permissions**\. - -1. Choose **Attach existing policies directly**\. For **Search**, type the first few characters of your policy name, as shown following\. -![\[Choose a Policy\]](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/./images/perf_insights_attach_iam_policy.png) - -1. Choose your policy, and then choose **Next: Review**\. - -1. Choose **Add permissions**\. - -## Configuring an AWS KMS policy for Performance Insights - -Performance Insights uses an AWS KMS key to encrypt sensitive data\. When you enable Performance Insights through the API or the console, you can do either of the following: -+ Choose the default AWS managed key\. - - Amazon RDS uses the AWS managed key for your new DB instance\. Amazon RDS creates an AWS managed key for your AWS account\. Your AWS account has a different AWS managed key for Amazon RDS for each AWS Region\. -+ Choose a customer managed key\. - - If you specify a customer managed key, users in your account that call the Performance Insights API need the `kms:Decrypt` and `kms:GenerateDataKey` permissions on the KMS key\. You can configure these permissions through IAM policies\. However, we recommend that you manage these permissions through your KMS key policy\. For more information, see [ Using key policies in AWS KMS](https://docs.aws.amazon.com/kms/latest/developerguide/key-policies.html)\. - -**Example** -The following example shows how to add statements to your KMS key policy\. These statements allow access to Performance Insights\. Depending on how you use the KMS key, you might want to change some restrictions\. Before adding statements to your policy, remove all comments\. - -``` -{ - "Version" : "2012-10-17", - "Id" : "your-policy", - "Statement" : [ { - //This represents a statement that currently exists in your policy. - } - ...., - //Starting here, add new statement to your policy for Performance Insights. - //We recommend that you add one new statement for every RDS instance -{ - "Sid" : "Allow viewing RDS Performance Insights", - "Effect": "Allow", - "Principal": { - "AWS": [ - //One or more principals allowed to access Performance Insights - "arn:aws:iam::444455556666:role/Role1" - ] - }, - "Action": [ - "kms:Decrypt", - "kms:GenerateDataKey" - ], - "Resource": "*", - "Condition" : { - "StringEquals" : { - //Restrict access to only RDS APIs (including Performance Insights). - //Replace region with your AWS Region. - //For example, specify us-west-2. - "kms:ViaService" : "rds.region.amazonaws.com" - }, - "ForAnyValue:StringEquals": { - //Restrict access to only data encrypted by Performance Insights. - "kms:EncryptionContext:aws:pi:service": "rds", - "kms:EncryptionContext:service": "pi", - - //Restrict access to a specific RDS instance. - //The value is a DbiResourceId. - "kms:EncryptionContext:aws:rds:db-id": "db-AAAAABBBBBCCCCDDDDDEEEEE" - } - } -} -``` \ No newline at end of file diff --git a/doc_source/USER_PerfInsights.md b/doc_source/USER_PerfInsights.md deleted file mode 100644 index fcae0fb..0000000 --- a/doc_source/USER_PerfInsights.md +++ /dev/null @@ -1,12 +0,0 @@ -# Monitoring DB load with Performance Insights on Amazon RDS - -Performance Insights expands on existing Amazon RDS monitoring features to illustrate and help you analyze your database performance\. With the Performance Insights dashboard, you can visualize the database load on your Amazon RDS DB instance load and filter the load by waits, SQL statements, hosts, or users\. For information about using Performance Insights with Amazon DocumentDB, see *[Amazon DocumentDB Developer Guide](https://docs.aws.amazon.com/documentdb/latest/developerguide/performance-insights.html)*\. - -**Topics** -+ [Overview of Performance Insights on Amazon RDS](USER_PerfInsights.Overview.md) -+ [Turning Performance Insights on and off](USER_PerfInsights.Enabling.md) -+ [Turning on the Performance Schema for Performance Insights on Amazon RDS for MariaDB or MySQL](USER_PerfInsights.EnableMySQL.md) -+ [Configuring access policies for Performance Insights](USER_PerfInsights.access-control.md) -+ [Analyzing metrics with the Performance Insights dashboard](USER_PerfInsights.UsingDashboard.md) -+ [Retrieving metrics with the Performance Insights API](USER_PerfInsights.API.md) -+ [Logging Performance Insights calls using AWS CloudTrail](USER_PerfInsights.CloudTrail.md) \ No newline at end of file diff --git a/doc_source/USER_PerfInsights_Counters.md b/doc_source/USER_PerfInsights_Counters.md deleted file mode 100644 index 76080b5..0000000 --- a/doc_source/USER_PerfInsights_Counters.md +++ /dev/null @@ -1,211 +0,0 @@ -# Performance Insights counter metrics - -Counter metrics are operating system and database performance metrics in the Performance Insights dashboard\. To help identify and analyze performance problems, you can correlate counter metrics with DB load\. - -The counter metrics are collected one time each minute\. The OS metrics collection depends on whether Enhanced Monitoring is turned on or off\. If Enhanced Monitoring is turned off, the OS metrics are collected one time each minute\. If Enhanced Monitoring is turned on, the OS metrics are collected for the selected time period\. For more information about turning Enhanced Monitoring on or off, see [Turning Enhanced Monitoring on and off](USER_Monitoring.OS.Enabling.md#USER_Monitoring.OS.Enabling.Procedure)\. - -**Topics** -+ [Performance Insights counters for Amazon RDS for MariaDB and MySQL](#USER_PerfInsights_Counters.MySQL) -+ [Performance Insights counters for Amazon RDS for Microsoft SQL Server](#USER_PerfInsights_Counters.SQLServer) -+ [Performance Insights counters for Amazon RDS for Oracle](#USER_PerfInsights_Counters.Oracle) -+ [Performance Insights counters for Amazon RDS for PostgreSQL](#USER_PerfInsights_Counters.PostgreSQL) - -## Performance Insights counters for Amazon RDS for MariaDB and MySQL - -The following database counters are available with Performance Insights for Amazon RDS for MariaDB and MySQL\. - -**Topics** -+ [Native counters for RDS for MariaDB and RDS for MySQL](#USER_PerfInsights_Counters.MySQL.Native) -+ [Non\-native counters for Amazon RDS for MariaDB and MySQL](#USER_PerfInsights_Counters.MySQL.NonNative) - -### Native counters for RDS for MariaDB and RDS for MySQL - -Native metrics are defined by the database engine and not by Amazon RDS\. For definitions of these native metrics, see [Server status variables](https://dev.mysql.com/doc/refman/8.0/en/server-status-variables.html) in the MySQL documentation\. - - -| Counter | Type | Unit | Metric | -| --- | --- | --- | --- | -| Com\_analyze | SQL | Queries per second | db\.SQL\.Com\_analyze | -| Com\_optimize | SQL | Queries per second | db\.SQL\.Com\_optimize | -| Com\_select | SQL | Queries per second | db\.SQL\.Com\_select | -| Connections | SQL | The number of connection attempts per minute \(successful or not\) to the MySQL server | db\.Users\.Connections | -| Innodb\_rows\_deleted | SQL | Rows per second | db\.SQL\.Innodb\_rows\_deleted | -| Innodb\_rows\_inserted | SQL | Rows per second | db\.SQL\.Innodb\_rows\_inserted | -| Innodb\_rows\_read | SQL | Rows per second | db\.SQL\.Innodb\_rows\_read | -| Innodb\_rows\_updated | SQL | Rows per second | db\.SQL\.Innodb\_rows\_updated | -| Select\_full\_join | SQL | Queries per second | db\.SQL\.Select\_full\_join | -| Select\_full\_range\_join | SQL | Queries per second | db\.SQL\.Select\_full\_range\_join | -| Select\_range | SQL | Queries per second | db\.SQL\.Select\_range | -| Select\_range\_check | SQL | Queries per second | db\.SQL\.Select\_range\_check | -| Select\_scan | SQL | Queries per second | db\.SQL\.Select\_scan | -| Slow\_queries | SQL | Queries per second | db\.SQL\.Slow\_queries | -| Sort\_merge\_passes | SQL | Queries per second | db\.SQL\.Sort\_merge\_passes | -| Sort\_range | SQL | Queries per second | db\.SQL\.Sort\_range | -| Sort\_rows | SQL | Queries per second | db\.SQL\.Sort\_rows | -| Sort\_scan | SQL | Queries per second | db\.SQL\.Sort\_scan | -| Questions | SQL | Queries per second | db\.SQL\.Questions | -| Innodb\_row\_lock\_time | Locks | Milliseconds \(average\) | db\.Locks\.Innodb\_row\_lock\_time | -| Table\_locks\_immediate | Locks | Requests per second | db\.Locks\.Table\_locks\_immediate | -| Table\_locks\_waited | Locks | Requests per second | db\.Locks\.Table\_locks\_waited | -| Aborted\_clients | Users | Connections | db\.Users\.Aborted\_clients | -| Aborted\_connects | Users | Connections | db\.Users\.Aborted\_connects | -| Threads\_created | Users | Connections | db\.Users\.Threads\_created | -| Threads\_running | Users | Connections | db\.Users\.Threads\_running | -| Innodb\_data\_writes | I/O | Operations per second | db\.IO\.Innodb\_data\_writes | -| Innodb\_dblwr\_writes | I/O | Operations per second | db\.IO\.Innodb\_dblwr\_writes | -| Innodb\_log\_write\_requests | I/O | Operations per second | db\.IO\.Innodb\_log\_write\_requests | -| Innodb\_log\_writes | I/O | Operations per second | db\.IO\.Innodb\_log\_writes | -| Innodb\_pages\_written | I/O | Pages per second | db\.IO\.Innodb\_pages\_written | -| Created\_tmp\_disk\_tables | Temp | Tables per second | db\.Temp\.Created\_tmp\_disk\_tables | -| Created\_tmp\_tables | Temp | Tables per second | db\.Temp\.Created\_tmp\_tables | -| Innodb\_buffer\_pool\_pages\_data | Cache | Pages | db\.Cache\.Innodb\_buffer\_pool\_pages\_data | -| Innodb\_buffer\_pool\_pages\_total | Cache | Pages | db\.Cache\.Innodb\_buffer\_pool\_pages\_total | -| Innodb\_buffer\_pool\_read\_requests | Cache | Pages per second | db\.Cache\.Innodb\_buffer\_pool\_read\_requests | -| Innodb\_buffer\_pool\_reads | Cache | Pages per second | db\.Cache\.Innodb\_buffer\_pool\_reads | -| Opened\_tables | Cache | Tables | db\.Cache\.Opened\_tables | -| Opened\_table\_definitions | Cache | Tables | db\.Cache\.Opened\_table\_definitions | -| Qcache\_hits | Cache | Queries | db\.Cache\.Qcache\_hits | - -### Non\-native counters for Amazon RDS for MariaDB and MySQL - -Non\-native counter metrics are counters defined by Amazon RDS\. A non\-native metric can be a metric that you get with a specific query\. A non\-native metric also can be a derived metric, where two or more native counters are used in calculations for ratios, hit rates, or latencies\. - - -| Counter | Type | Metric | Description | Definition | -| --- | --- | --- | --- | --- | -| innodb\_buffer\_pool\_hits | Cache | db\.Cache\.innoDB\_buffer\_pool\_hits | The number of reads that InnoDB could satisfy from the buffer pool\. | innodb\_buffer\_pool\_read\_requests \- innodb\_buffer\_pool\_reads | -| innodb\_buffer\_pool\_hit\_rate | Cache | db\.Cache\.innoDB\_buffer\_pool\_hit\_rate | The percentage of reads that InnoDB could satisfy from the buffer pool\. | 100 \* innodb\_buffer\_pool\_read\_requests / \(innodb\_buffer\_pool\_read\_requests \+ innodb\_buffer\_pool\_reads\) | -| innodb\_buffer\_pool\_usage | Cache | db\.Cache\.innoDB\_buffer\_pool\_usage | The percentage of the InnoDB buffer pool that contains data \(pages\)\. When using compressed tables, this value can vary\. For more information, see the information about `Innodb_buffer_pool_pages_data` and `Innodb_buffer_pool_pages_total` in [Server status variables](https://dev.mysql.com/doc/refman/8.0/en/server-status-variables.html) in the MySQL documentation\. | Innodb\_buffer\_pool\_pages\_data / Innodb\_buffer\_pool\_pages\_total \* 100\.0 | -| query\_cache\_hit\_rate | Cache | db\.Cache\.query\_cache\_hit\_rate | MySQL result set cache \(query cache\) hit ratio\. | Qcache\_hits / \(QCache\_hits \+ Com\_select\) \* 100 | -| innodb\_datafile\_writes\_to\_disk | I/O | db\.IO\.innoDB\_datafile\_writes\_to\_disk | The number of InnoDB data file writes to disk, excluding double write and redo logging write operations\. | Innodb\_data\_writes \- Innodb\_log\_writes \- Innodb\_dblwr\_writes | -| innodb\_rows\_changed | SQL | db\.SQL\.innodb\_rows\_changed | The total InnoDB row operations\. | db\.SQL\.Innodb\_rows\_inserted \+ db\.SQL\.Innodb\_rows\_deleted \+ db\.SQL\.Innodb\_rows\_updated | -| active\_transactions | Transactions | db\.Transactions\.active\_transactions | The total active transactions\. | SELECT COUNT\(1\) AS active\_transactions FROM INFORMATION\_SCHEMA\.INNODB\_TRX | -| trx\_rseg\_history\_len | Transactions | db\.Transactions\.trx\_rseg\_history\_len | A list of the undo log pages for committed transactions that is maintained by the InnoDB transaction system to implement multi\-version concurrency control\. For more information about undo log records details, see [https://dev.mysql.com/doc/refman/8.0/en/innodb-multi-versioning.html](https://dev.mysql.com/doc/refman/8.0/en/innodb-multi-versioning.html) in the MySQL documentation\. | SELECT COUNT AS trx\_rseg\_history\_len FROM INFORMATION\_SCHEMA\.INNODB\_METRICS WHERE NAME='trx\_rseg\_history\_len' | -| innodb\_deadlocks | Locks | db\.Locks\.innodb\_deadlocks | The total number of deadlocks\. | SELECT COUNT AS innodb\_deadlocks FROM INFORMATION\_SCHEMA\.INNODB\_METRICS WHERE NAME='lock\_deadlocks' | -| innodb\_lock\_timeouts | Locks | db\.Locks\.innodb\_lock\_timeouts | The total number of locks that timed out\. | SELECT COUNT AS innodb\_lock\_timeouts FROM INFORMATION\_SCHEMA\.INNODB\_METRICS WHERE NAME='lock\_timeouts' | -| innodb\_row\_lock\_waits | Locks | db\.Locks\.innodb\_row\_lock\_waits | The total number of row locks that resulted in a wait\. | SELECT COUNT AS innodb\_row\_lock\_waits FROM INFORMATION\_SCHEMA\.INNODB\_METRICS WHERE NAME='lock\_row\_lock\_waits' | - -## Performance Insights counters for Amazon RDS for Microsoft SQL Server - -The following database counters are available with Performance Insights for RDS for Microsoft SQL Server\. - -### Native counters for RDS for Microsoft SQL Server - -Native metrics are defined by the database engine and not by Amazon RDS\. You can find definitions for these native metrics in [Use SQL Server Objects](https://docs.microsoft.com/en-us/sql/relational-databases/performance-monitor/use-sql-server-objects?view=sql-server-2017) in the Microsoft SQL Server documentation\. - - -| Counter | Type | Unit | Metric | -| --- | --- | --- | --- | -| Forwarded Records | [Access Methods](https://docs.microsoft.com/en-us/sql/relational-databases/performance-monitor/sql-server-access-methods-object?view=sql-server-2017) | Records per second | db\.Access Methods\.Forwarded Records | -| Page Splits | [Access Methods](https://docs.microsoft.com/en-us/sql/relational-databases/performance-monitor/sql-server-access-methods-object?view=sql-server-2017) | Splits per second | db\.Access Methods\.Page Splits | -| Buffer cache hit ratio | [Buffer Manager](https://docs.microsoft.com/en-us/sql/relational-databases/performance-monitor/sql-server-buffer-manager-object?view=sql-server-2017) | Ratio | db\.Buffer Manager\.Buffer cache hit ratio | -| Page life expectancy | [Buffer Manager](https://docs.microsoft.com/en-us/sql/relational-databases/performance-monitor/sql-server-buffer-manager-object?view=sql-server-2017) | Expectancy in seconds | db\.Buffer Manager\.Page life expectancy | -| Page lookups | [Buffer Manager](https://docs.microsoft.com/en-us/sql/relational-databases/performance-monitor/sql-server-buffer-manager-object?view=sql-server-2017) | Lookups per second | db\.Buffer Manager\.Page lookups | -| Page reads | [Buffer Manager](https://docs.microsoft.com/en-us/sql/relational-databases/performance-monitor/sql-server-buffer-manager-object?view=sql-server-2017) | Reads per second | db\.Buffer Manager\.Page reads | -| Page writes | [Buffer Manager](https://docs.microsoft.com/en-us/sql/relational-databases/performance-monitor/sql-server-buffer-manager-object?view=sql-server-2017) | Writes per second | db\.Buffer Manager\.Page writes | -| Active Transactions | [Databases](https://docs.microsoft.com/en-us/sql/relational-databases/performance-monitor/sql-server-databases-object?view=sql-server-2017) | Transactions | db\.Databases\.Active Transactions \(\_Total\) | -| Log Bytes Flushed | [Databases](https://docs.microsoft.com/en-us/sql/relational-databases/performance-monitor/sql-server-databases-object?view=sql-server-2017) | Bytes flushed per second | db\.Databases\.Log Bytes Flushed \(\_Total\) | -| Log Flush Waits | [Databases](https://docs.microsoft.com/en-us/sql/relational-databases/performance-monitor/sql-server-databases-object?view=sql-server-2017) | Waits per second | db\.Databases\.Log Flush Waits \(\_Total\) | -| Log Flushes | [Databases](https://docs.microsoft.com/en-us/sql/relational-databases/performance-monitor/sql-server-databases-object?view=sql-server-2017) | Flushes per second | db\.Databases\.Log Flushes \(\_Total\) | -| Write Transactions | [Databases](https://docs.microsoft.com/en-us/sql/relational-databases/performance-monitor/sql-server-databases-object?view=sql-server-2017) | Transactions per second | db\.Databases\.Write Transactions \(\_Total\) | -| Processes blocked | [General Statistics](https://docs.microsoft.com/en-us/sql/relational-databases/performance-monitor/sql-server-general-statistics-object?view=sql-server-2017) | Processes blocked | db\.General Statistics\.Processes blocked | -| User Connections | [General Statistics](https://docs.microsoft.com/en-us/sql/relational-databases/performance-monitor/sql-server-general-statistics-object?view=sql-server-2017) | Connections | db\.General Statistics\.User Connections | -| Latch Waits | [Latches](https://docs.microsoft.com/en-us/sql/relational-databases/performance-monitor/sql-server-latches-object?view=sql-server-2017) | Waits per second | db\.Latches\.Latch Waits | -| Number of Deadlocks | [Locks](https://docs.microsoft.com/en-us/sql/relational-databases/performance-monitor/sql-server-locks-object?view=sql-server-2017) | Deadlocks per second | db\.Locks\.Number of Deadlocks \(\_Total\) | -| Memory Grants Pending | [Memory Manager](https://docs.microsoft.com/en-us/sql/relational-databases/performance-monitor/sql-server-memory-manager-object?view=sql-server-2017) | Memory grants | db\.Memory Manager\.Memory Grants Pending | -| Batch Requests | [SQL Statistics](https://docs.microsoft.com/en-us/sql/relational-databases/performance-monitor/sql-server-sql-statistics-object?view=sql-server-2017) | Requests per second | db\.SQL Statistics\.Batch Requests | -| SQL Compilations | [SQL Statistics](https://docs.microsoft.com/en-us/sql/relational-databases/performance-monitor/sql-server-sql-statistics-object?view=sql-server-2017) | Compilations per second | db\.SQL Statistics\.SQL Compilations | -| SQL Re\-Compilations | [SQL Statistics](https://docs.microsoft.com/en-us/sql/relational-databases/performance-monitor/sql-server-sql-statistics-object?view=sql-server-2017) | Re\-compilations per second | db\.SQL Statistics\.SQL Re\-Compilations | - -## Performance Insights counters for Amazon RDS for Oracle - -The following database counters are available with Performance Insights for RDS for Oracle\. - -### Native counters for RDS for Oracle - -Native metrics are defined by the database engine and not by Amazon RDS\. You can find definitions for these native metrics in [Statistics Descriptions](https://docs.oracle.com/en/database/oracle/oracle-database/12.2/refrn/statistics-descriptions-2.html#GUID-2FBC1B7E-9123-41DD-8178-96176260A639) in the Oracle documentation\. - -**Note** -For the `CPU used by this session` counter metric, the unit has been transformed from the native centiseconds to active sessions to make the value easier to use\. For example, CPU send in the DB Load chart represents the demand for CPU\. The counter metric `CPU used by this session` represents the amount of CPU used by Oracle sessions\. You can compare CPU send to the `CPU used by this session` counter metric\. When demand for CPU is higher than CPU used, sessions are waiting for CPU time\. - - -| Counter | Type | Unit | Metric | -| --- | --- | --- | --- | -| CPU used by this session | User | Active sessions | db\.User\.CPU used by this session | -| SQL\*Net roundtrips to/from client | User | Roundtrips per second | db\.User\.SQL\*Net roundtrips to/from client | -| Bytes received via SQL\*Net from client | User | Bytes per second | db\.User\.bytes received via SQL\*Net from client | -| User commits | User | Commits per second | db\.User\.user commits | -| Logons cumulative | User | Logons per second | db\.User\.logons cumulative | -| User calls | User | Calls per second | db\.User\.user calls | -| Bytes sent via SQL\*Net to client | User | Bytes per second | db\.User\.bytes sent via SQL\*Net to client | -| User rollbacks | User | Rollbacks per second | db\.User\.user rollbacks | -| Redo size | Redo | Bytes per second | db\.Redo\.redo size | -| Parse count \(total\) | SQL | Parses per second | db\.SQL\.parse count \(total\) | -| Parse count \(hard\) | SQL | Parses per second | db\.SQL\.parse count \(hard\) | -| Table scan rows gotten | SQL | Rows per second | db\.SQL\.table scan rows gotten | -| Sorts \(memory\) | SQL | Sorts per second | db\.SQL\.sorts \(memory\) | -| Sorts \(disk\) | SQL | Sorts per second | db\.SQL\.sorts \(disk\) | -| Sorts \(rows\) | SQL | Sorts per second | db\.SQL\.sorts \(rows\) | -| Physical read bytes | Cache | Bytes per second | db\.Cache\.physical read bytes | -| DB block gets | Cache | Blocks per second | db\.Cache\.db block gets | -| DBWR checkpoints | Cache | Checkpoints per minute | db\.Cache\.DBWR checkpoints | -| Physical reads | Cache | Reads per second | db\.Cache\.physical reads | -| Consistent gets from cache | Cache | Gets per second | db\.Cache\.consistent gets from cache | -| DB block gets from cache | Cache | Gets per second | db\.Cache\.db block gets from cache | -| Consistent gets | Cache | Gets per second | db\.Cache\.consistent gets | - -## Performance Insights counters for Amazon RDS for PostgreSQL - -The following database counters are available with Performance Insights for Amazon RDS for PostgreSQL\. - -**Topics** -+ [Native counters for Amazon RDS for PostgreSQL](#USER_PerfInsights_Counters.PostgreSQL.Native) -+ [Non\-native counters for Amazon RDS for PostgreSQL](#USER_PerfInsights_Counters.PostgreSQL.NonNative) - -### Native counters for Amazon RDS for PostgreSQL - -Native metrics are defined by the database engine and not by Amazon RDS\. You can find definitions for these native metrics in [Viewing Statistics](https://www.postgresql.org/docs/10/monitoring-stats.html#MONITORING-STATS-VIEWS) in the PostgreSQL documentation\. - - -| Counter | Type | Unit | Metric | -| --- | --- | --- | --- | -| blks\_hit | Cache | Blocks per second | db\.Cache\.blks\_hit | -| buffers\_alloc | Cache | Blocks per second | db\.Cache\.buffers\_alloc | -| buffers\_checkpoint | Checkpoint | Blocks per second | db\.Checkpoint\.buffers\_checkpoint | -| checkpoint\_sync\_time | Checkpoint | Milliseconds per checkpoint | db\.Checkpoint\.checkpoint\_sync\_time | -| checkpoint\_write\_time | Checkpoint | Milliseconds per checkpoint | db\.Checkpoint\.checkpoint\_write\_time | -| checkpoints\_req | Checkpoint | Checkpoints per minute | db\.Checkpoint\.checkpoints\_req | -| checkpoints\_timed | Checkpoint | Checkpoints per minute | db\.Checkpoint\.checkpoints\_timed | -| maxwritten\_clean | Checkpoint | Bgwriter clean stops per minute | db\.Checkpoint\.maxwritten\_clean | -| deadlocks | Concurrency | Deadlocks per minute | db\.Concurrency\.deadlocks | -| blk\_read\_time | I/O | Milliseconds | db\.IO\.blk\_read\_time | -| blks\_read | I/O | Blocks per second | db\.IO\.blks\_read | -| buffers\_backend | I/O | Blocks per second | db\.IO\.buffers\_backend | -| buffers\_backend\_fsync | I/O | Blocks per second | db\.IO\.buffers\_backend\_fsync | -| buffers\_clean | I/O | Blocks per second | db\.IO\.buffers\_clean | -| tup\_deleted | SQL | Tuples per second | db\.SQL\.tup\_deleted | -| tup\_fetched | SQL | Tuples per second | db\.SQL\.tup\_fetched | -| tup\_inserted | SQL | Tuples per second | db\.SQL\.tup\_inserted | -| tup\_returned | SQL | Tuples per second | db\.SQL\.tup\_returned | -| tup\_updated | SQL | Tuples per second | db\.SQL\.tup\_updated | -| temp\_bytes | Temp | Bytes per second | db\.Temp\.temp\_bytes | -| temp\_files | Temp | Files per minute | db\.Temp\.temp\_files | -| active\_transactions | Transactions | Transactions | db\.Transactions\.active\_transactions | -| blocked\_transactions | Transactions | Transactions | db\.Transactions\.blocked\_transactions | -| max\_used\_xact\_ids | Transactions | Transactions | db\.Transactions\.max\_used\_xact\_ids | -| xact\_commit | Transactions | Commits per second | db\.Transactions\.xact\_commit | -| xact\_rollback | Transactions | Rollbacks per second | db\.Transactions\.xact\_rollback | -| numbackends | User | Connections | db\.User\.numbackends | -| archived\_count | Write\-ahead log \(WAL\) | Files per minute | db\.WAL\.archived\_count | -| archive\_failed\_count | WAL | Files per minute | db\.WAL\.archive\_failed\_count | - -### Non\-native counters for Amazon RDS for PostgreSQL - -Non\-native counter metrics are counters defined by Amazon RDS\. A non\-native metric can be a metric that you get with a specific query\. A non\-native metric also can be a derived metric, where two or more native counters are used in calculations for ratios, hit rates, or latencies\. - - -| Counter | Type | Metric | Description | Definition | -| --- | --- | --- | --- | --- | -| checkpoint\_sync\_latency | Checkpoint | db\.Checkpoint\.checkpoint\_sync\_latency | The total amount of time that has been spent in the portion of checkpoint processing where files are synchronized to disk\. | checkpoint\_sync\_time / \(checkpoints\_timed \+ checkpoints\_req\) | -| checkpoint\_write\_latency | Checkpoint | db\.Checkpoint\.checkpoint\_write\_latency | The total amount of time that has been spent in the portion of checkpoint processing where files are written to disk\. | checkpoint\_write\_time / \(checkpoints\_timed \+ checkpoints\_req\) | -| read\_latency | I/O | db\.IO\.read\_latency | The time spent reading data file blocks by backends in this instance\. | blk\_read\_time / blks\_read | \ No newline at end of file diff --git a/doc_source/USER_PostgreSQL.Replication.ReadReplicas.md b/doc_source/USER_PostgreSQL.Replication.ReadReplicas.md deleted file mode 100644 index 5446080..0000000 --- a/doc_source/USER_PostgreSQL.Replication.ReadReplicas.md +++ /dev/null @@ -1,198 +0,0 @@ -# Working with read replicas for Amazon RDS for PostgreSQL - -You can scale reads for your Amazon RDS for PostgreSQL DB instance by adding read replicas to the instance\. As with other Amazon RDS database engines, RDS for PostgreSQL uses the native replication mechanisms of PostgreSQL to keep read replicas up to date with changes on the source DB\. For general information about read replicas and Amazon RDS, see [Working with DB instance read replicas](USER_ReadRepl.md)\. - -Following, you can find information specific to working with read replicas with RDS for PostgreSQL\. - -**Contents** -+ [Read replica limitations with PostgreSQL](#USER_PostgreSQL.Replication.ReadReplicas.Limitations) -+ [Read replica configuration with PostgreSQL](#USER_PostgreSQL.Replication.ReadReplicas.Configuration) - + [Using RDS for PostgreSQL read replicas with Multi\-AZ configurations](#USER_PostgreSQL.Replication.ReadReplicas.Configuration.multi-az) - + [Using cascading read replicas with RDS for PostgreSQL](#USER_PostgreSQL.Replication.ReadReplicas.Configuration.cascading) -+ [How streaming replication works for different RDS for PostgreSQL versions](#USER_PostgreSQL.Replication.ReadReplicas.Configuration.mechanisms-versions) - + [Understanding the parameters that control PostgreSQL replication](#USER_PostgreSQL.Replication.ReadReplicas.Parameters) - + [Example: How a read replica recovers from replication interruptions](#USER_PostgreSQL.Replication.example-how-it-works) -+ [Monitoring and tuning the replication process](#USER_PostgreSQL.Replication.ReadReplicas.Monitor) - + [Monitoring replication slots for your RDS for PostgreSQL DB instance](#USER_PostgreSQL.Replication.ReadReplicas.Monitor-monitor-replication-slots) - -## Read replica limitations with PostgreSQL - -The following are limitations for PostgreSQL read replicas: -+ PostgreSQL read replicas are read\-only\. Although a read replica isn't a writeable DB instance, you can promote it to become a standalone RDS for PostgreSQL DB instance\. However, the process isn't reversible\. -+ You can't create a read replica from another read replica if your RDS for PostgreSQL DB instance is running a PostgreSQL version earlier than 14\.1\. RDS for PostgreSQL supports cascading read replicas on RDS for PostgreSQL version 14\.1 and higher releases only\. For more information, see [Using cascading read replicas with RDS for PostgreSQL](#USER_PostgreSQL.Replication.ReadReplicas.Configuration.cascading)\. -+ If you promote a PostgreSQL read replica, it becomes a writable DB instance\. It stops receiving write\-ahead log \(WAL\) files from a source DB instance, and it's no longer a read\-only instance\. You can create new read replicas from the promoted DB instance as you do for any RDS for PostgreSQL DB instance\. For more information, see [Promoting a read replica to be a standalone DB instance](USER_ReadRepl.md#USER_ReadRepl.Promote)\. -+ If you promote a PostgreSQL read replica from within a replication chain \(a series of cascading read replicas\), any existing downstream read replicas continue receiving WAL files from the promoted instance, automatically\. For more information, see [Using cascading read replicas with RDS for PostgreSQL](#USER_PostgreSQL.Replication.ReadReplicas.Configuration.cascading)\. -+ If no user transactions are running on the source DB instance, the associated PostgreSQL read replica reports a replication lag of up to five minutes\. The replica lag is calculated as `currentTime - lastCommitedTransactionTimestamp`, which means that when no transactions are being processed, the value of replica lag increases for a period of time until the write\-ahead log \(WAL\) segment switches\. By default RDS for PostgreSQL switches the WAL segment every 5 minutes, which results in a transaction record and a decrease in the reported lag\. -+ You can't turn on automated backups for PostgreSQL read replicas for RDS for PostgreSQL versions earlier than 14\.1\. Automated backups for read replicas are supported for RDS for PostgreSQL 14\.1 and higher versions only\. For RDS for PostgreSQL 13 and earlier versions, create a snapshot from a read replica if you want a backup of it\. -+ Point\-in\-time recovery \(PITR\) isn't supported for read replicas\. You can use PITR with a primary \(writer\) instance only, not a read replica\. To learn more, see [Restoring a DB instance to a specified time](USER_PIT.md)\. - -## Read replica configuration with PostgreSQL - -RDS for PostgreSQL uses PostgreSQL native streaming replication to create a read\-only copy of a source DB instance\. This read replica DB instance is an asynchronously created physical replica of the source DB instance\. It's created by a special connection that transmits write ahead log \(WAL\) data from the source DB instance to the read replica\. For more information, see [Streaming Replication](https://www.postgresql.org/docs/14/warm-standby.html#STREAMING-REPLICATION) in the PostgreSQL documentation\. - -PostgreSQL asynchronously streams database changes to this secure connection as they're made on the source DB instance\. You can encrypt communications from your client applications to the source DB instance or any read replicas by setting the `ssl` parameter to `1`\. For more information, see [Using SSL with a PostgreSQL DB instance](PostgreSQL.Concepts.General.SSL.md) \. - -PostgreSQL uses a *replication* role to perform streaming replication\. The role is privileged, but you can't use it to modify any data\. PostgreSQL uses a single process for handling replication\. - -You can create a PostgreSQL read replica without affecting operations or users of the source DB instance\. Amazon RDS sets the necessary parameters and permissions for you, on the source DB instance and the read replica, without affecting the service\. A snapshot is taken of the source DB instance, and this snapshot is used to create the read replica\. If you delete the read replica at some point in the future, no outage occurs\. - -You can create up to 15 read replicas from one source DB instance within the same Region\. As of RDS for PostgreSQL 14\.1, you can also create up to three levels of read replica in a chain \(cascade\) from a source DB instance\. For more information, see [Using cascading read replicas with RDS for PostgreSQL](#USER_PostgreSQL.Replication.ReadReplicas.Configuration.cascading)\. In all cases, the source DB instance needs to have automated backups configured\. You do this by setting the backup retention period on your DB instance to any value other than 0\. For more information, see [Creating a read replica](USER_ReadRepl.md#USER_ReadRepl.Create)\. - -You can create read replicas for your RDS for PostgreSQL DB instance in the same AWS Region as your source DB instance\. This is known as *in\-Region* replication\. You can also create read replicas in different AWS Regions than the source DB instance\. This is known as *cross\-Region* replication\. For more information about setting up cross\-Region read replicas, see [Creating a read replica in a different AWS Region](USER_ReadRepl.md#USER_ReadRepl.XRgn)\. The various mechanisms supporting the replication process for in\-Region and cross\-Region differ slightly depending on the RDS for PostgreSQL version as explained in [How streaming replication works for different RDS for PostgreSQL versions](#USER_PostgreSQL.Replication.ReadReplicas.Configuration.mechanisms-versions)\. - -For replication to operate effectively, each read replica should have the same amount of compute and storage resources as the source DB instance\. If you scale the source DB instance, be sure to also scale the read replicas\. - -Amazon RDS overrides any incompatible parameters on a read replica if they prevent the read replica from starting\. For example, suppose that the `max_connections` parameter value is higher on the source DB instance than on the read replica\. In that case, Amazon RDS updates the parameter on the read replica to be the same value as that on the source DB instance\. - -RDS for PostgreSQL read replicas have access to external databases that are available through foreign data wrappers \(FDWs\) on the source DB instance\. For example, suppose that your RDS for PostgreSQL DB instance is using the `mysql_fdw` wrapper to access data from RDS for MySQL\. If so, your read replicas can also access that data\. Other supported FDWs include `oracle_fdw`, `postgres_fdw`, and `tds_fdw`\. For more information, see [Working with the supported foreign data wrappers for Amazon RDS for PostgreSQL](Appendix.PostgreSQL.CommonDBATasks.Extensions.foreign-data-wrappers.md)\. - -### Using RDS for PostgreSQL read replicas with Multi\-AZ configurations - -You can create a read replica from a single\-AZ or Multi\-AZ DB instance\. You can use Multi\-AZ deployments to improve the durability and availability of critical data, with a standby replica\. A *standby replica* is a dedicated read replica that can assume the workload if the source DB fails over\. You can't use your standby replica to serve read traffic\. However, you can create read replicas from high\-traffic Multi\-AZ DB instances to offload read\-only queries\. To learn more about Multi\-AZ deployments, see [Multi\-AZ DB instance deployments](Concepts.MultiAZSingleStandby.md)\. - -If the source DB instance of a Multi\-AZ deployment fails over to a standby, the associated read replicas switch to using the standby \(now primary\) as their replication source\. The read replicas might need to restart, depending on the RDS for PostgreSQL version, as follows: -+ **PostgreSQL 13 and higher versions** – Restarting isn't required\. The read replicas are automatically synchronized with the new primary\. However, in some cases your client application might cache Domain Name Service \(DNS\) details for your read replicas\. If so, set the time\-to\-live \(TTL\) value to less than 30 seconds\. Doing this prevents the read replica from holding on to a stale IP address \(and thus, prevents it from synchronizing with the new primary\)\. To learn more about this and other best practices, see [Amazon RDS basic operational guidelines](CHAP_BestPractices.md#CHAP_BestPractices.DiskPerformance)\. -+ **PostgreSQL 12 and all earlier versions** – The read replicas restart automatically after a fail over to the standby replica because the standby \(now primary\) has a different IP address and a different instance name\. Restarting synchronizes the read replica with the new primary\. - -To learn more about failover, see [Failover process for Amazon RDS](Concepts.MultiAZSingleStandby.md#Concepts.MultiAZ.Failover)\. To learn more about how read replicas work in a Multi\-AZ deployment, see [Working with DB instance read replicas](USER_ReadRepl.md)\. - -To provide failover support for a read replica, you can create the read replica as a Multi\-AZ DB instance so that Amazon RDS creates a standby of your replica in another Availability Zone \(AZ\)\. Creating your read replica as a Multi\-AZ DB instance is independent of whether the source database is a Multi\-AZ DB instance\. - -### Using cascading read replicas with RDS for PostgreSQL - -As of version 14\.1, RDS for PostgreSQL supports cascading read replicas\. With *cascading read replicas*, you can scale reads without adding overhead to your source RDS for PostgreSQL DB instance\. Updates to the WAL log aren't sent by the source DB instance to each read replica\. Instead, each read replica in a cascading series sends WAL log updates to the next read replica in the series\. This reduces the burden on the source DB instance\. - -With cascading read replicas, your RDS for PostgreSQL DB instance sends WAL data to the first read replica in the chain\. That read replica then sends WAL data to the second replica in the chain, and so on\. The end result is that all read replicas in the chain have the changes from the RDS for PostgreSQL DB instance, but without the overhead solely on the source DB instance\. - -You can create a series of up to three read replicas in a chain from a source RDS for PostgreSQL DB instance\. For example, suppose that you have an RDS for PostgreSQL 14\.1 DB instance, `rpg-db-main`\. You can do the following: -+ Starting with `rpg-db-main`, create the first read replica in the chain, `read-replica-1`\. -+ Next, from `read-replica-1`, create the next read replica in the chain, `read-replica-2`\. -+ Finally, from `read-replica-2`, create the third read replica in the chain, `read-replica-3`\. - -You can't create another read replica beyond this third cascading read replica in the series for `rpg-db-main`\. A complete series of instances from an RDS for PostgreSQL source DB instance through to the end of a series of cascading read replicas can consist of at most four DB instances\. - -For cascading read replicas to work, turn on automatic backups on your RDS for PostgreSQL\. Create the read replica first and then turn on automatic backups on the RDS for PostgreSQL DB instance\. The process is the same as for other Amazon RDS DB engines\. For more information, see [Creating a read replica](USER_ReadRepl.md#USER_ReadRepl.Create)\. - -As with any read replica, you can promote a read replica that's part of a cascade\. Promoting a read replica from within a chain of read replicas removes that replica from the chain\. For example, suppose that you want to move some of the workload off of your `rpg-db-main` DB instance to a new instance for use by the accounting department only\. Assuming the chain of three read replicas from the example, you decide to promote `read-replica-2`\. The chain is affected as follows: -+ Promoting `read-replica-2` removes it from the replication chain\. - + It is now a full read/write DB instance\. - + It continues replicating to `read-replica-3`, just as it was doing before promotion\. -+ Your `rpg-db-main` continues replicating to `read-replica-1`\. - -For more information about promoting read replicas, see [Promoting a read replica to be a standalone DB instance](USER_ReadRepl.md#USER_ReadRepl.Promote)\. - -**Note** -For cascading read replicas, RDS for PostgreSQL supports 15 read replicas for each source DB instance at first level of replication, and 5 read replicas for each source DB instance at the second and third level of replication\. - -## How streaming replication works for different RDS for PostgreSQL versions - -As discussed in [Read replica configuration with PostgreSQL](#USER_PostgreSQL.Replication.ReadReplicas.Configuration), RDS for PostgreSQL uses PostgreSQL's native streaming replication protocol to send WAL data from the source DB instance\. It sends source WAL data to read replicas for both in\-Region and cross\-Region read replicas\. With version 9\.4, PostgreSQL introduced physical replication slots as a supporting mechanism for the replication process\. - -A *physical replication slot* prevents a source DB instance from removing WAL data before it's consumed by all read replicas\. Each read replica has its own physical slot on the source DB instance\. The slot keeps track of the oldest WAL \(by logical sequence number, LSN\) that might be needed by the replica\. After all slots and DB connections have progressed beyond a given WAL \(LSN\), that LSN becomes a candidate for removal at the next checkpoint\. - -Amazon RDS uses Amazon S3 to archive WAL data\. For in\-Region read replicas, you can use this archived data to recover the read replica when necessary\. An example of when you might do so is if the connection between source DB and read replica is interrupted for any reason\. - -In the following table, you can find a summary of differences between PostgreSQL versions and the supporting mechanisms for in\-Region and cross\-Region used by RDS for PostgreSQL\. - - -| In\-Region | Cross\-Region | -| --- |--- | -| PostgreSQL 14\.1 and higher versions | -| --- | -| Replication slots Amazon S3 archive | Replication slots | -| PostgreSQL 13 and lower versions | -| --- | -| Amazon S3 archive | Replication slots | - -For more information, see [Monitoring and tuning the replication process](#USER_PostgreSQL.Replication.ReadReplicas.Monitor)\. - -### Understanding the parameters that control PostgreSQL replication - -The following parameters affect the replication process and determine how well read replicas stay up to date with the source DB instance: - -**max\_wal\_senders** -The `max_wal_senders` parameter specifies the maximum number of connections that the source DB instance can support at the same time over the streaming replication protocol\. The default for RDS for PostgreSQL 13 and higher releases is 20\. This parameter should be set to slightly higher than the actual number of read replicas\. If this parameter is set too low for the number of read replicas, replication stops\. -For more information, see [max\_wal\_senders](https://www.postgresql.org/docs/devel/runtime-config-replication.html#GUC-MAX-WAL-SENDERS) in the PostgreSQL documentation\. - -**wal\_keep\_segments** -The `wal_keep_segments` parameter specifies the number of write\-ahead log \(WAL\) files that the source DB instance keeps in the `pg_wal` directory\. The default setting is 32\. -If `wal_keep_segments` isn't set to a large enough value for your deployment, a read replica can fall so far behind that streaming replication stops\. If that happens, Amazon RDS generates a replication error and begins recovery on the read replica\. It does so by replaying the source DB instance's archived WAL data from Amazon S3\. This recovery process continues until the read replica has caught up enough to continue streaming replication\. You can see this process in action as captured by the PostgreSQL log in [Example: How a read replica recovers from replication interruptionsExample: Read replica recovery from replication interruptions](#USER_PostgreSQL.Replication.example-how-it-works)\. -In PostgreSQL version 13, the `wal_keep_segments` parameter is named `wal_keep_size`\. It serves the same purpose as `wal_keep_segments`, but its default value is in megabytes \(MB\) \(2048 MB\) rather than the number of files\. For more information, see [wal\_keep\_segments](https://www.postgresql.org/docs/12/runtime-config-replication.html#GUC-WAL-KEEP-SEGMENTS) and [wal\_keep\_size](https://www.postgresql.org/docs/current/runtime-config-replication.html#GUC-WAL-KEEP-SIZE) in the PostgreSQL documentation\. - -**max\_slot\_wal\_keep\_size** -The `max_slot_wal_keep_size` parameter controls the quantity of WAL data that the RDS for PostgreSQL DB instance retains in the `pg_wal` directory to serve slots\. This parameter is used for configurations that use replication slots\. The default value for this parameter is `-1`, meaning that there's no limit to how much WAL data is kept on the source DB instance\. For information about monitoring your replication slots, see [Monitoring replication slots for your RDS for PostgreSQL DB instance](#USER_PostgreSQL.Replication.ReadReplicas.Monitor-monitor-replication-slots)\. -For more information about this parameter, see [max\_slot\_wal\_keep\_size](https://www.postgresql.org/docs/devel/runtime-config-replication.html#GUC-MAX-SLOT-WAL-KEEP-SIZE) in the PostgreSQL documentation\. - -Whenever the stream that provides WAL data to a read replica is interrupted, PostgreSQL switches into recovery mode\. It restores the read replica by using archived WAL data from Amazon S3 or by using the using WAL data associated with the replication slot\. When this process is complete, PostgreSQL re\-establishes streaming replication\. - -#### Example: How a read replica recovers from replication interruptions - -In the following example, you find the log details that demonstrate the recovery process for a read replica\. The example is from an RDS for PostgreSQL DB instance running PostgreSQL version 12\.9 in the same AWS Region as the source DB, so replication slots aren't used\. The recovery process is the same for other RDS for PostgreSQL DB instances running PostgreSQL earlier than version 14\.1 with in\-Region read replicas\. - -When the read replica lost contact with the source DB instance, Amazon RDS records the issue in the log as `FATAL: could not receive data from WAL stream` message, along with the `ERROR: requested WAL segment ... has already been removed`\. As shown in the bold line, Amazon RDS recovers the replica by replaying an archived WAL file\. - -``` -2014-11-07 19:01:10 UTC::@:[23180]:DEBUG:  switched WAL source from archive to stream after failure -2014-11-07 19:01:10 UTC::@:[11575]:LOG: started streaming WAL from primary at 1A/D3000000 on timeline 1 -2014-11-07 19:01:10 UTC::@:[11575]:FATAL: could not receive data from WAL stream: -ERROR:  requested WAL segment 000000010000001A000000D3 has already been removed -2014-11-07 19:01:10 UTC::@:[23180]:DEBUG: could not restore file "00000002.history" from archive: return code 0 -2014-11-07 19:01:15 UTC::@:[23180]:DEBUG: switched WAL source from stream to archive after failure recovering 000000010000001A000000D3 -2014-11-07 19:01:16 UTC::@:[23180]:LOG:  restored log file "000000010000001A000000D3" from archive -``` - -When Amazon RDS replays enough archived WAL data on the replica to catch up, streaming to the read replica begins again\. When streaming resumes, Amazon RDS writes an entry to the log file similar to the following\. - -``` -2014-11-07 19:41:36 UTC::@:[24714]:LOG:started streaming WAL from primary at 1B/B6000000 on timeline 1 -``` - -## Monitoring and tuning the replication process - -We strongly recommend that you routinely monitor your RDS for PostgreSQL DB instance and read replicas\. You need to ensure that your read replicas are keeping up with changes on the source DB instance\. Amazon RDS transparently recovers your read replicas when interruptions to the replication process occur\. However, it's best to avoid needing to recover at all\. Recovering using replication slots is faster than using the Amazon S3 archive, but any recovery process can affect read performance\. - -To determine how well your read replicas are keeping up with the source DB instance, you can do the following: -+ **Check the amount of `ReplicaLag` between source DB instance and replicas\.** *Replica lag* is the amount of time, in milliseconds, that a read replica lags behind its source DB instance\. This metric reports the result of the following query\. - - ``` - SELECT extract(epoch from now() - pg_last_xact_replay_timestamp()) AS replica_lag - ``` - - Replica lag is an indication of how well a read replica is keeping up with the source DB instance\. It's the amount of latency between the source DB instance and a specific read instance\. A high value for replica lag can indicate a mismatch between the DB instance classes or storage types \(or both\) used by the source DB instance and its read replicas\. The DB instance class and storage types for DB source instance and all read replicas should be the same\. - - Replica lag can also be the result of intermittent connection issues\. You can monitor replication lag in Amazon CloudWatch by viewing the Amazon RDS `ReplicaLag` metric\. To learn more about `ReplicaLag` and other metrics for Amazon RDS, see [Amazon CloudWatch metrics for Amazon RDS](rds-metrics.md)\. -+ **Check the PostgreSQL log for information you can use to adjust your settings\.** At every checkpoint, the PostgreSQL log captures the number of recycled transaction log files, as shown in the following example\. - - ``` - 2014-11-07 19:59:35 UTC::@:[26820]:LOG:  checkpoint complete: wrote 376 buffers (0.2%); - 0 transaction log file(s) added, 0 removed, 1 recycled; write=35.681 s, sync=0.013 s, total=35.703 s; - sync files=10, longest=0.013 s, average=0.001 s - ``` - - You can use this information to figure out how many transaction files are being recycled in a given time period\. You can then change the setting for `wal_keep_segments` if necessary\. For example, suppose that the PostgreSQL log at `checkpoint complete` shows `35 recycled` for a 5\-minute interval\. In this case, the `wal_keep_segments` default value of 32 isn't sufficient to keep pace with the streaming activity, so you should increase the value of this parameter\. -+ **Use Amazon CloudWatch to monitor metrics that can predict replication issues\.** Rather than analyzing the PostgreSQL log directly, you can use Amazon CloudWatch to check metrics that have been collected\. For example, you can check the value of the `TransactionLogsGeneration` metric to see how much WAL data is being generated by the source DB instance\. In some cases, the workload on your DB instance might generate a large amount of WAL data\. If so, you might need to change the DB instance class for your source DB instance and read replicas\. Using an instance class with high \(10 Gbps\) network performance can reduce replica lag\. - -### Monitoring replication slots for your RDS for PostgreSQL DB instance - -All versions of RDS for PostgreSQL use replication slots for cross\-Region read replicas\. RDS for PostgreSQL 14\.1 and higher versions use replication slots for in\-Region read replicas\. In\-region read replicas also use Amazon S3 to archive WAL data\. In other words, if your DB instance and read replicas are running PostgreSQL 14\.1 or higher, replication slots and Amazon S3 archives are both available for recovering the read replica\. Recovering a read replica using its replication slot is faster than recovering from Amazon S3 archive\. So, we recommend that you monitor the replication slots and related metrics\. - -You can view the replication slots on your RDS for PostgreSQL DB instances by querying the `pg_replication_slots` view, as follows\. - -``` -postgres=> SELECT * FROM pg_replication_slots; -slot_name | plugin | slot_type | datoid | database | temporary | active | active_pid | xmin | catalog_xmin | restart_lsn | confirmed_flush_lsn | wal_status | safe_wal_size | two_phase ----------------------------+--------+-----------+--------+----------+-----------+--------+------------+------+--------------+-------------+---------------------+------------+---------------+----------- -rds_us_west_1_db_555555555 | | physical | | | f | t | 13194 | | | 23/D8000060 | | reserved | | f -(1 row) -``` - -The `wal_status` of `reserved` value means that the amount of WAL data held by the slot is within the bounds of the `max_wal_size` parameter\. In other words, the replication slot is properly sized\. Other possible status values are as follows: -+ `extended` – The slot exceeds the `max_wal_size` setting, but the WAL data is retained\. -+ `unreserved` – The slot no longer has the all required WAL data\. Some of it will be removed at the next checkpoint\. -+ `lost` – Some required WAL data has been removed\. The slot is no longer usable\. - -The `pg_replication_slots` view shows you the current state of your replication slots\. To assess the performance of your replication slots, you can use Amazon CloudWatch and monitor the following metrics: -+ **`OldestReplicationSlotLag`** – Lists the slot that has the most lag, that is the one that's furthest behind the primary\. This lag can be associated with the read replica but also the connection\. -+ **`TransactionLogsDiskUsage`** – Shows how much storage is being used for WAL data\. When a read replica lags significantly, the value of this metric can increase substantially\. - -To learn more about using Amazon CloudWatch and its metrics for RDS for PostgreSQL, see [Monitoring Amazon RDS metrics with Amazon CloudWatch](monitoring-cloudwatch.md)\. For more information about monitoring streaming replication on your RDS for PostgreSQL DB instances, see [Best practices for Amazon RDS PostgreSQL replication](http://aws.amazon.com/blogs/database/best-practices-for-amazon-rds-postgresql-replication/) on the *AWS Database Blog*\. \ No newline at end of file diff --git a/doc_source/USER_PostgreSQL.S3Import.md b/doc_source/USER_PostgreSQL.S3Import.md deleted file mode 100644 index 6bbdb08..0000000 --- a/doc_source/USER_PostgreSQL.S3Import.md +++ /dev/null @@ -1,637 +0,0 @@ -# Importing data from Amazon S3 into an RDS for PostgreSQL DB instance - -You can import data that's been stored using Amazon Simple Storage Service into a table on an RDS for PostgreSQL DB instance\. To do this, you first install the RDS for PostgreSQL `aws_s3` extension\. This extension provides the functions that you use to import data from an Amazon S3 bucket\. A *bucket* is an Amazon S3 container for objects and files\. The data can be in a comma\-separate value \(CSV\) file, a text file, or a compressed \(gzip\) file\. Following, you can learn how to install the extension and how to import data from Amazon S3 into a table\. - -Your database must be running PostgreSQL version 10\.7 or higher to import from Amazon S3 into RDS for PostgreSQL\. - -If you don't have data stored on Amazon S3, you need to first create a bucket and store the data\. For more information, see the following topics in the *Amazon Simple Storage Service User Guide*\. -+ [Create a bucket](https://docs.aws.amazon.com/AmazonS3/latest/gsg/CreatingABucket.html) -+ [Add an object to a bucket](https://docs.aws.amazon.com/AmazonS3/latest/gsg/PuttingAnObjectInABucket.html) - -Cross\-account import from Amazon S3 is supported\. For more information, see [ Granting cross\-account permissions](https://docs.aws.amazon.com/AmazonS3/latest/gsg/example-walkthroughs-managing-access-example2.html) in the *Amazon Simple Storage Service User Guide*\. - -You can use the customer managed key for encryption while importing data from S3\. For more information, see [ KMS keys stored in AWS KMS](https://docs.aws.amazon.com/AmazonS3/latest/gsg/UsingKMSEncryption.html) in the *Amazon Simple Storage Service User Guide*\. - -**Note** -Importing data from Amazon S3 isn't supported for Aurora Serverless v1\. It is supported for Aurora Serverless v2\. - -**Topics** -+ [Installing the aws\_s3 extension](#USER_PostgreSQL.S3Import.InstallExtension) -+ [Overview of importing data from Amazon S3 data](#USER_PostgreSQL.S3Import.Overview) -+ [Setting up access to an Amazon S3 bucket](#USER_PostgreSQL.S3Import.AccessPermission) -+ [Importing data from Amazon S3 to your RDS for PostgreSQL DB instance](#USER_PostgreSQL.S3Import.FileFormats) -+ [Function reference](#USER_PostgreSQL.S3Import.Reference) - -## Installing the aws\_s3 extension - -Before you can use Amazon S3 with your RDS for PostgreSQL DB instance, you need to install the `aws_s3` extension\. This extension provides functions for importing data from an Amazon S3\. It also provides functions for exporting data from an RDS for PostgreSQL DB instance to an Amazon S3 bucket\. For more information, see [Exporting data from an RDS for PostgreSQL DB instance to Amazon S3](postgresql-s3-export.md)\. The `aws_s3` extension depends on some of the helper functions in the `aws_commons` extension, which is installed automatically when needed\. - -**To install the `aws_s3` extension** - -1. Use psql \(or pgAdmin\) to connect to the RDS for PostgreSQL DB instance as a user that has `rds_superuser` privileges\. If you kept the default name during the setup process, you connect as `postgres`\. - - ``` - psql --host=111122223333.aws-region.rds.amazonaws.com --port=5432 --username=postgres --password - ``` - -1. To install the extension, run the following command\. - - ``` - postgres=> CREATE EXTENSION aws_s3 CASCADE; - NOTICE: installing required extension "aws_commons" - CREATE EXTENSION - ``` - -1. To verify that the extension is installed, you can use the psql `\dx` metacommand\. - - ``` - postgres=> \dx - List of installed extensions - Name | Version | Schema | Description - -------------+---------+------------+--------------------------------------------- - aws_commons | 1.2 | public | Common data types across AWS services - aws_s3 | 1.1 | public | AWS S3 extension for importing data from S3 - plpgsql | 1.0 | pg_catalog | PL/pgSQL procedural language - (3 rows) - ``` - -The functions for importing data from Amazon S3 and exporting data to Amazon S3 are now available to use\. - -## Overview of importing data from Amazon S3 data - -**To import S3 data into Amazon RDS** - -First, gather the details that you need to supply to the function\. These include the name of the table on your RDS for PostgreSQL DB instance, and the bucket name, file path, file type, and AWS Region where the Amazon S3 data is stored\. For more information, see [View an object](https://docs.aws.amazon.com/AmazonS3/latest/gsg/OpeningAnObject.html) in the *Amazon Simple Storage Service User Guide*\. -**Note** -Multi part data import from Amazon S3 isn't currently supported\. - -1. Get the name of the table into which the `aws_s3.table_import_from_s3` function is to import the data\. As an example, the following command creates a table `t1` that can be used in later steps\. - - ``` - postgres=> CREATE TABLE t1 - (col1 varchar(80), - col2 varchar(80), - col3 varchar(80)); - ``` - -1. Get the details about the Amazon S3 bucket and the data to import\. To do this, open the Amazon S3 console at [https://console\.aws\.amazon\.com/s3/](https://console.aws.amazon.com/s3/), and choose **Buckets**\. Find the bucket containing your data in the list\. Choose the bucket, open its Object overview page, and then choose Properties\. - - Make a note of the bucket name, path, the AWS Region, and file type\. You need the Amazon Resource Name \(ARN\) later, to set up access to Amazon S3 through an IAM role\. For more more information, see [Setting up access to an Amazon S3 bucket](#USER_PostgreSQL.S3Import.AccessPermission)\. The image following shows an example\. -![\[Image of a file object in an Amazon S3 bucket.\]](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/images/aws_s3_import-export_s3_bucket-info.png) - -1. You can verify the path to the data on the Amazon S3 bucket by using the AWS CLI command `aws s3 cp`\. If the information is correct, this command downloads a copy of the Amazon S3 file\. - - ``` - aws s3 cp s3://sample_s3_bucket/sample_file_path ./ - ``` - -1. Set up permissions on your RDS for PostgreSQL DB instance to allow access to the file on the Amazon S3 bucket\. To do so, you use either an AWS Identity and Access Management \(IAM\) role or security credentials\. For more information, see [Setting up access to an Amazon S3 bucket](#USER_PostgreSQL.S3Import.AccessPermission)\. - -1. Supply the path and other Amazon S3 object details gathered \(see step 2\) to the `create_s3_uri` function to construct an Amazon S3 URI object\. To learn more about this function, see [aws\_commons\.create\_s3\_uri](#USER_PostgreSQL.S3Import.create_s3_uri)\. The following is an example of constructing this object during a psql session\. - - ``` - postgres=> SELECT aws_commons.create_s3_uri( - 'docs-lab-store-for-rpg', - 'versions_and_jdks_listing.csv', - 'us-west-1' - ) AS s3_uri \gset - ``` - - In the next step, you pass this object \(`aws_commons._s3_uri_1`\) to the `aws_s3.table_import_from_s3` function to import the data to the table\. - -1. Invoke the `aws_s3.table_import_from_s3` function to import the data from Amazon S3 into your table\. For reference information, see [aws\_s3\.table\_import\_from\_s3](#aws_s3.table_import_from_s3)\. For examples, see [Importing data from Amazon S3 to your RDS for PostgreSQL DB instance](#USER_PostgreSQL.S3Import.FileFormats)\. - -## Setting up access to an Amazon S3 bucket - -To import data from an Amazon S3 file, give the RDS for PostgreSQL DB instance permission to access the Amazon S3 bucket containing the file\. You provide access to an Amazon S3 bucket in one of two ways, as described in the following topics\. - -**Topics** -+ [Using an IAM role to access an Amazon S3 bucket](#USER_PostgreSQL.S3Import.ARNRole) -+ [Using security credentials to access an Amazon S3 bucket](#USER_PostgreSQL.S3Import.Credentials) -+ [Troubleshooting access to Amazon S3](#USER_PostgreSQL.S3Import.troubleshooting) - -### Using an IAM role to access an Amazon S3 bucket - -Before you load data from an Amazon S3 file, give your RDS for PostgreSQL DB instance permission to access the Amazon S3 bucket the file is in\. This way, you don't have to manage additional credential information or provide it in the [aws\_s3\.table\_import\_from\_s3](#aws_s3.table_import_from_s3) function call\. - -To do this, create an IAM policy that provides access to the Amazon S3 bucket\. Create an IAM role and attach the policy to the role\. Then assign the IAM role to your DB instance\. - -**Note** -You can't associate an IAM role with an Aurora Serverless v1 DB cluster, so the following steps don't apply\. - -**To give an RDS for PostgreSQL DB instance access to Amazon S3 through an IAM role** - -1. Create an IAM policy\. - - This policy provides the bucket and object permissions that allow your RDS for PostgreSQL DB instance to access Amazon S3\. - - Include in the policy the following required actions to allow the transfer of files from an Amazon S3 bucket to Amazon RDS: - + `s3:GetObject` - + `s3:ListBucket` - - Include in the policy the following resources to identify the Amazon S3 bucket and objects in the bucket\. This shows the Amazon Resource Name \(ARN\) format for accessing Amazon S3\. - + arn:aws:s3:::*your\-s3\-bucket* - + arn:aws:s3:::*your\-s3\-bucket*/\* - - For more information on creating an IAM policy for RDS for PostgreSQL, see [Creating and using an IAM policy for IAM database access](UsingWithRDS.IAMDBAuth.IAMPolicy.md)\. See also [Tutorial: Create and attach your first customer managed policy](https://docs.aws.amazon.com/IAM/latest/UserGuide/tutorial_managed-policies.html) in the *IAM User Guide*\. - - The following AWS CLI command creates an IAM policy named `rds-s3-import-policy` with these options\. It grants access to a bucket named `your-s3-bucket`\. -**Note** -Make a note of the Amazon Resource Name \(ARN\) of the policy returned by this command\. You need the ARN in a subsequent step when you attach the policy to an IAM role\. -**Example** - - For Linux, macOS, or Unix: - - ``` - aws iam create-policy \ - --policy-name rds-s3-import-policy \ - --policy-document '{ - "Version": "2012-10-17", - "Statement": [ - { - "Sid": "s3import", - "Action": [ - "s3:GetObject", - "s3:ListBucket" - ], - "Effect": "Allow", - "Resource": [ - "arn:aws:s3:::your-s3-bucket", - "arn:aws:s3:::your-s3-bucket/*" - ] - } - ] - }' - ``` - - For Windows: - - ``` - aws iam create-policy ^ - --policy-name rds-s3-import-policy ^ - --policy-document '{ - "Version": "2012-10-17", - "Statement": [ - { - "Sid": "s3import", - "Action": [ - "s3:GetObject", - "s3:ListBucket" - ], - "Effect": "Allow", - "Resource": [ - "arn:aws:s3:::your-s3-bucket", - "arn:aws:s3:::your-s3-bucket/*" - ] - } - ] - }' - ``` - -1. Create an IAM role\. - - You do this so Amazon RDS can assume this IAM role to access your Amazon S3 buckets\. For more information, see [Creating a role to delegate permissions to an IAM user](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_create_for-user.html) in the *IAM User Guide*\. - - We recommend using the `[aws:SourceArn](https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies_condition-keys.html#condition-keys-sourcearn)` and `[aws:SourceAccount](https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies_condition-keys.html#condition-keys-sourceaccount)` global condition context keys in resource\-based policies to limit the service's permissions to a specific resource\. This is the most effective way to protect against the [confused deputy problem](https://docs.aws.amazon.com/IAM/latest/UserGuide/confused-deputy.html)\. - - If you use both global condition context keys and the `aws:SourceArn` value contains the account ID, the `aws:SourceAccount` value and the account in the `aws:SourceArn` value must use the same account ID when used in the same policy statement\. - + Use `aws:SourceArn` if you want cross\-service access for a single resource\. - + Use `aws:SourceAccount` if you want to allow any resource in that account to be associated with the cross\-service use\. - - In the policy, be sure to use the `aws:SourceArn` global condition context key with the full ARN of the resource\. The following example shows how to do so using the AWS CLI command to create a role named `rds-s3-import-role`\. -**Example** - - For Linux, macOS, or Unix: - - ``` - aws iam create-role \ - --role-name rds-s3-import-role \ - --assume-role-policy-document '{ - "Version": "2012-10-17", - "Statement": [ - { - "Effect": "Allow", - "Principal": { - "Service": "rds.amazonaws.com" - }, - "Action": "sts:AssumeRole", - "Condition": { - "StringEquals": { - "aws:SourceAccount": "111122223333", - "aws:SourceArn": "arn:aws:rds:us-east-1:111122223333:db:dbname" - } - } - } - ] - }' - ``` - - For Windows: - - ``` - aws iam create-role ^ - --role-name rds-s3-import-role ^ - --assume-role-policy-document '{ - "Version": "2012-10-17", - "Statement": [ - { - "Effect": "Allow", - "Principal": { - "Service": "rds.amazonaws.com" - }, - "Action": "sts:AssumeRole", - "Condition": { - "StringEquals": { - "aws:SourceAccount": "111122223333", - "aws:SourceArn": "arn:aws:rds:us-east-1:111122223333:db:dbname" - } - } - } - ] - }' - ``` - -1. Attach the IAM policy that you created to the IAM role that you created\. - - The following AWS CLI command attaches the policy created in the previous step to the role named `rds-s3-import-role` Replace `your-policy-arn` with the policy ARN that you noted in an earlier step\. -**Example** - - For Linux, macOS, or Unix: - - ``` - aws iam attach-role-policy \ - --policy-arn your-policy-arn \ - --role-name rds-s3-import-role - ``` - - For Windows: - - ``` - aws iam attach-role-policy ^ - --policy-arn your-policy-arn ^ - --role-name rds-s3-import-role - ``` - -1. Add the IAM role to the DB instance\. - - You do so by using the AWS Management Console or AWS CLI, as described following\. - -#### Console - -**To add an IAM role for a PostgreSQL DB instance using the console** - -1. Sign in to the AWS Management Console and open the Amazon RDS console at [https://console\.aws\.amazon\.com/rds/](https://console.aws.amazon.com/rds/)\. - -1. Choose the PostgreSQL DB instance name to display its details\. - -1. On the **Connectivity & security** tab, in the **Manage IAM roles **section, choose the role to add under **Add IAM roles to this instance **\. - -1. Under **Feature**, choose **s3Import**\. - -1. Choose **Add role**\. - -#### AWS CLI - -**To add an IAM role for a PostgreSQL DB instance using the CLI** -+ Use the following command to add the role to the PostgreSQL DB instance named `my-db-instance`\. Replace *`your-role-arn`* with the role ARN that you noted in a previous step\. Use `s3Import` for the value of the `--feature-name` option\. -**Example** - - For Linux, macOS, or Unix: - - ``` - aws rds add-role-to-db-instance \ - --db-instance-identifier my-db-instance \ - --feature-name s3Import \ - --role-arn your-role-arn \ - --region your-region - ``` - - For Windows: - - ``` - aws rds add-role-to-db-instance ^ - --db-instance-identifier my-db-instance ^ - --feature-name s3Import ^ - --role-arn your-role-arn ^ - --region your-region - ``` - -#### RDS API - -To add an IAM role for a PostgreSQL DB instance using the Amazon RDS API, call the [ AddRoleToDBInstance](https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_AddRoleToDBInstance.html) operation\. - -### Using security credentials to access an Amazon S3 bucket - -If you prefer, you can use security credentials to provide access to an Amazon S3 bucket instead of providing access with an IAM role\. You do so by specifying the `credentials` parameter in the [aws\_s3\.table\_import\_from\_s3](#aws_s3.table_import_from_s3) function call\. - -The `credentials` parameter is a structure of type `aws_commons._aws_credentials_1`, which contains AWS credentials\. Use the [aws\_commons\.create\_aws\_credentials](#USER_PostgreSQL.S3Import.create_aws_credentials) function to set the access key and secret key in an `aws_commons._aws_credentials_1` structure, as shown following\. - -``` -postgres=> SELECT aws_commons.create_aws_credentials( - 'sample_access_key', 'sample_secret_key', '') -AS creds \gset -``` - -After creating the `aws_commons._aws_credentials_1 `structure, use the [aws\_s3\.table\_import\_from\_s3](#aws_s3.table_import_from_s3) function with the `credentials` parameter to import the data, as shown following\. - -``` -postgres=> SELECT aws_s3.table_import_from_s3( - 't', '', '(format csv)', - :'s3_uri', - :'creds' -); -``` - -Or you can include the [aws\_commons\.create\_aws\_credentials](#USER_PostgreSQL.S3Import.create_aws_credentials) function call inline within the `aws_s3.table_import_from_s3` function call\. - -``` -postgres=> SELECT aws_s3.table_import_from_s3( - 't', '', '(format csv)', - :'s3_uri', - aws_commons.create_aws_credentials('sample_access_key', 'sample_secret_key', '') -); -``` - -### Troubleshooting access to Amazon S3 - -If you encounter connection problems when attempting to import data from Amazon S3, see the following for recommendations: -+ [Troubleshooting Amazon RDS identity and access](security_iam_troubleshoot.md) -+ [Troubleshooting Amazon S3](https://docs.aws.amazon.com/AmazonS3/latest/dev/troubleshooting.html) in the *Amazon Simple Storage Service User Guide* -+ [Troubleshooting Amazon S3 and IAM](https://docs.aws.amazon.com/IAM/latest/UserGuide/troubleshoot_iam-s3.html) in the *IAM User Guide* - -## Importing data from Amazon S3 to your RDS for PostgreSQL DB instance - -You import data from your Amazon S3 bucket by using the `table_import_from_s3` function of the aws\_s3 extension\. For reference information, see [aws\_s3\.table\_import\_from\_s3](#aws_s3.table_import_from_s3)\. - -**Note** -The following examples use the IAM role method to allow access to the Amazon S3 bucket\. Thus, the `aws_s3.table_import_from_s3` function calls don't include credential parameters\. - -The following shows a typical example\. - -``` -postgres=> SELECT aws_s3.table_import_from_s3( - 't1', - '', - '(format csv)', - :'s3_uri' -); -``` - -The parameters are the following: -+ `t1` – The name for the table in the PostgreSQL DB instance to copy the data into\. -+ `''` – An optional list of columns in the database table\. You can use this parameter to indicate which columns of the S3 data go in which table columns\. If no columns are specified, all the columns are copied to the table\. For an example of using a column list, see [Importing an Amazon S3 file that uses a custom delimiter](#USER_PostgreSQL.S3Import.FileFormats.CustomDelimiter)\. -+ `(format csv)` – PostgreSQL COPY arguments\. The copy process uses the arguments and format of the [PostgreSQL COPY](https://www.postgresql.org/docs/current/sql-copy.html) command to import the data\. Choices for format include comma\-separated value \(CSV\) as shown in this example, text, and binary\. The default is text\. -+ `s3_uri` – A structure that contains the information identifying the Amazon S3 file\. For an example of using the [aws\_commons\.create\_s3\_uri](#USER_PostgreSQL.S3Import.create_s3_uri) function to create an `s3_uri` structure, see [Overview of importing data from Amazon S3 data](#USER_PostgreSQL.S3Import.Overview)\. - -For more information about this function, see [aws\_s3\.table\_import\_from\_s3](#aws_s3.table_import_from_s3)\. - -The `aws_s3.table_import_from_s3` function returns text\. To specify other kinds of files for import from an Amazon S3 bucket, see one of the following examples\. - -**Note** -Importing 0 bytes file will cause an error\. - -**Topics** -+ [Importing an Amazon S3 file that uses a custom delimiter](#USER_PostgreSQL.S3Import.FileFormats.CustomDelimiter) -+ [Importing an Amazon S3 compressed \(gzip\) file](#USER_PostgreSQL.S3Import.FileFormats.gzip) -+ [Importing an encoded Amazon S3 file](#USER_PostgreSQL.S3Import.FileFormats.Encoded) - -### Importing an Amazon S3 file that uses a custom delimiter - -The following example shows how to import a file that uses a custom delimiter\. It also shows how to control where to put the data in the database table using the `column_list` parameter of the [aws\_s3\.table\_import\_from\_s3](#aws_s3.table_import_from_s3) function\. - -For this example, assume that the following information is organized into pipe\-delimited columns in the Amazon S3 file\. - -``` -1|foo1|bar1|elephant1 -2|foo2|bar2|elephant2 -3|foo3|bar3|elephant3 -4|foo4|bar4|elephant4 -... -``` - -**To import a file that uses a custom delimiter** - -1. Create a table in the database for the imported data\. - - ``` - postgres=> CREATE TABLE test (a text, b text, c text, d text, e text); - ``` - -1. Use the following form of the [aws\_s3\.table\_import\_from\_s3](#aws_s3.table_import_from_s3) function to import data from the Amazon S3 file\. - - You can include the [aws\_commons\.create\_s3\_uri](#USER_PostgreSQL.S3Import.create_s3_uri) function call inline within the `aws_s3.table_import_from_s3` function call to specify the file\. - - ``` - postgres=> SELECT aws_s3.table_import_from_s3( - 'test', - 'a,b,d,e', - 'DELIMITER ''|''', - aws_commons.create_s3_uri('sampleBucket', 'pipeDelimitedSampleFile', 'us-east-2') - ); - ``` - -The data is now in the table in the following columns\. - -``` -postgres=> SELECT * FROM test; -a | b | c | d | e ----+------+---+---+------+----------- -1 | foo1 | | bar1 | elephant1 -2 | foo2 | | bar2 | elephant2 -3 | foo3 | | bar3 | elephant3 -4 | foo4 | | bar4 | elephant4 -``` - -### Importing an Amazon S3 compressed \(gzip\) file - -The following example shows how to import a file from Amazon S3 that is compressed with gzip\. The file that you import needs to have the following Amazon S3 metadata: -+ Key: `Content-Encoding` -+ Value: `gzip` - -If you upload the file using the AWS Management Console, the metadata is typically applied by the system\. For information about uploading files to Amazon S3 using the AWS Management Console, the AWS CLI, or the API, see [Uploading objects](https://docs.aws.amazon.com/AmazonS3/latest/userguide/upload-objects.html) in the *Amazon Simple Storage Service User Guide*\. - -For more information about Amazon S3 metadata and details about system\-provided metadata, see [Editing object metadata in the Amazon S3 console](https://docs.aws.amazon.com/AmazonS3/latest/user-guide/add-object-metadata.html) in the *Amazon Simple Storage Service User Guide*\. - -Import the gzip file into your RDS for PostgreSQL DB instance as shown following\. - -``` -postgres=> CREATE TABLE test_gzip(id int, a text, b text, c text, d text); -postgres=> SELECT aws_s3.table_import_from_s3( - 'test_gzip', '', '(format csv)', - 'myS3Bucket', 'test-data.gz', 'us-east-2' -); -``` - -### Importing an encoded Amazon S3 file - -The following example shows how to import a file from Amazon S3 that has Windows\-1252 encoding\. - -``` -postgres=> SELECT aws_s3.table_import_from_s3( - 'test_table', '', 'encoding ''WIN1252''', - aws_commons.create_s3_uri('sampleBucket', 'SampleFile', 'us-east-2') -); -``` - -## Function reference - -**Topics** -+ [aws\_s3\.table\_import\_from\_s3](#aws_s3.table_import_from_s3) -+ [aws\_commons\.create\_s3\_uri](#USER_PostgreSQL.S3Import.create_s3_uri) -+ [aws\_commons\.create\_aws\_credentials](#USER_PostgreSQL.S3Import.create_aws_credentials) - -### aws\_s3\.table\_import\_from\_s3 - -Imports Amazon S3 data into an Amazon RDS table\. The `aws_s3` extension provides the `aws_s3.table_import_from_s3` function\. The return value is text\. - -#### Syntax - -The required parameters are `table_name`, `column_list` and `options`\. These identify the database table and specify how the data is copied into the table\. - -You can also use the following parameters: -+ The `s3_info` parameter specifies the Amazon S3 file to import\. When you use this parameter, access to Amazon S3 is provided by an IAM role for the PostgreSQL DB instance\. - - ``` - aws_s3.table_import_from_s3 ( - table_name text, - column_list text, - options text, - s3_info aws_commons._s3_uri_1 - ) - ``` -+ The `credentials` parameter specifies the credentials to access Amazon S3\. When you use this parameter, you don't use an IAM role\. - - ``` - aws_s3.table_import_from_s3 ( - table_name text, - column_list text, - options text, - s3_info aws_commons._s3_uri_1, - credentials aws_commons._aws_credentials_1 - ) - ``` - -#### Parameters - - *table\_name* -A required text string containing the name of the PostgreSQL database table to import the data into\. - - *column\_list* -A required text string containing an optional list of the PostgreSQL database table columns in which to copy the data\. If the string is empty, all columns of the table are used\. For an example, see [Importing an Amazon S3 file that uses a custom delimiter](#USER_PostgreSQL.S3Import.FileFormats.CustomDelimiter)\. - - *options* -A required text string containing arguments for the PostgreSQL `COPY` command\. These arguments specify how the data is to be copied into the PostgreSQL table\. For more details, see the [PostgreSQL COPY documentation](https://www.postgresql.org/docs/current/sql-copy.html)\. - - *s3\_info* -An `aws_commons._s3_uri_1` composite type containing the following information about the S3 object: -+ `bucket` – The name of the Amazon S3 bucket containing the file\. -+ `file_path` – The Amazon S3 file name including the path of the file\. -+ `region` – The AWS Region that the file is in\. For a listing of AWS Region names and associated values, see [Regions, Availability Zones, and Local Zones](Concepts.RegionsAndAvailabilityZones.md)\. - - *credentials* -An `aws_commons._aws_credentials_1` composite type containing the following credentials to use for the import operation: -+ Access key -+ Secret key -+ Session token -For information about creating an `aws_commons._aws_credentials_1` composite structure, see [aws\_commons\.create\_aws\_credentials](#USER_PostgreSQL.S3Import.create_aws_credentials)\. - -#### Alternate syntax - -To help with testing, you can use an expanded set of parameters instead of the `s3_info` and `credentials` parameters\. Following are additional syntax variations for the `aws_s3.table_import_from_s3` function: -+ Instead of using the `s3_info` parameter to identify an Amazon S3 file, use the combination of the `bucket`, `file_path`, and `region` parameters\. With this form of the function, access to Amazon S3 is provided by an IAM role on the PostgreSQL DB instance\. - - ``` - aws_s3.table_import_from_s3 ( - table_name text, - column_list text, - options text, - bucket text, - file_path text, - region text - ) - ``` -+ Instead of using the `credentials` parameter to specify Amazon S3 access, use the combination of the `access_key`, `session_key`, and `session_token` parameters\. - - ``` - aws_s3.table_import_from_s3 ( - table_name text, - column_list text, - options text, - bucket text, - file_path text, - region text, - access_key text, - secret_key text, - session_token text - ) - ``` - -#### Alternate parameters - -*bucket* -A text string containing the name of the Amazon S3 bucket that contains the file\. - -*file\_path* -A text string containing the Amazon S3 file name including the path of the file\. - -*region* -A text string identifying the AWS Region location of the file\. For a listing of AWS Region names and associated values, see [Regions, Availability Zones, and Local Zones](Concepts.RegionsAndAvailabilityZones.md)\. - -*access\_key* -A text string containing the access key to use for the import operation\. The default is NULL\. - -*secret\_key* -A text string containing the secret key to use for the import operation\. The default is NULL\. - -*session\_token* -\(Optional\) A text string containing the session key to use for the import operation\. The default is NULL\. - -### aws\_commons\.create\_s3\_uri - -Creates an `aws_commons._s3_uri_1` structure to hold Amazon S3 file information\. Use the results of the `aws_commons.create_s3_uri` function in the `s3_info` parameter of the [aws\_s3\.table\_import\_from\_s3](#aws_s3.table_import_from_s3) function\. - -#### Syntax - -``` -aws_commons.create_s3_uri( - bucket text, - file_path text, - region text -) -``` - -#### Parameters - -*bucket* -A required text string containing the Amazon S3 bucket name for the file\. - -*file\_path* -A required text string containing the Amazon S3 file name including the path of the file\. - -*region* -A required text string containing the AWS Region that the file is in\. For a listing of AWS Region names and associated values, see [Regions, Availability Zones, and Local Zones](Concepts.RegionsAndAvailabilityZones.md)\. - -### aws\_commons\.create\_aws\_credentials - -Sets an access key and secret key in an `aws_commons._aws_credentials_1` structure\. Use the results of the `aws_commons.create_aws_credentials` function in the `credentials` parameter of the [aws\_s3\.table\_import\_from\_s3](#aws_s3.table_import_from_s3) function\. - -#### Syntax - -``` -aws_commons.create_aws_credentials( - access_key text, - secret_key text, - session_token text -) -``` - -#### Parameters - -*access\_key* -A required text string containing the access key to use for importing an Amazon S3 file\. The default is NULL\. - -*secret\_key* -A required text string containing the secret key to use for importing an Amazon S3 file\. The default is NULL\. - -*session\_token* -An optional text string containing the session token to use for importing an Amazon S3 file\. The default is NULL\. If you provide an optional `session_token`, you can use temporary credentials\. \ No newline at end of file diff --git a/doc_source/USER_PostgreSQL.optimizedreads.md b/doc_source/USER_PostgreSQL.optimizedreads.md deleted file mode 100644 index 37d3e8d..0000000 --- a/doc_source/USER_PostgreSQL.optimizedreads.md +++ /dev/null @@ -1,113 +0,0 @@ -# Improving query performance for RDS for PostgreSQL with Amazon RDS Optimized Reads - -You can achieve faster query processing for RDS for PostgreSQL with Amazon RDS Optimized Reads\. An RDS for PostgreSQL DB instance or Multi\-AZ DB cluster that uses RDS Optimized Reads can achieve up to 50% faster query processing compared to one that doesn't use it\. - -**Topics** -+ [Overview of RDS Optimized Reads in PostgreSQL](#USER_PostgreSQL.optimizedreads-overview) -+ [Use cases for RDS Optimized Reads](#USER_PostgreSQL.optimizedreads-use-cases) -+ [Best practices for RDS Optimized Reads](#USER_PostgreSQL.optimizedreads-best-practices) -+ [Using RDS Optimized Reads](#USER_PostgreSQL.optimizedreads-using) -+ [Monitoring DB instances that use RDS Optimized Reads](#USER_PostgreSQL.optimizedreads-monitoring) -+ [Limitations for RDS Optimized Reads in PostgreSQL](#USER_PostgreSQL.optimizedreads-limitations) - -## Overview of RDS Optimized Reads in PostgreSQL - -Optimized Reads is available by default on RDS for PostgreSQL versions 15\.2 and higher, 14\.7 and higher, and 13\.10 and higher\. - -When you use an RDS for PostgreSQL DB instance or Multi\-AZ DB cluster that has RDS Optimized Reads turned on, it achieves up to 50% faster query performance using the local Non\-Volatile Memory Express \(NVMe\) based solid state drive \(SSD\) block\-level storage\. You can achieve faster query processing by placing the temporary tables that are generated by PostgreSQL on the local storage, which reduces the traffic to Elastic Block Storage \(EBS\) over the network\. - -In PostgreSQL, temporary objects are assigned to a temporary namespace that drops automatically at the end of the session\. The temporary namespace while dropping removes any objects that are session\-dependent, including schema\-qualified objects, such as tables, functions, operators, or even extensions\. - -In RDS for PostgreSQL, the `temp_tablespaces` parameter is configured for this temporary work area where the temporary objects are stored\. - -The following queries return the name of the tablespace and its location\. - -``` -postgres=> show temp_tablespaces; -temp_tablespaces ---------------------- -rds_temp_tablespace -(1 row) -``` - -The `rds_temp_tablespace` is a tablespace configured by RDS that points to the NVMe local storage\. You can always switch back to Amazon EBS storage by modifying this parameter in the `Parameter group` using the AWS Management Console to point to any tablespace other than `rds_temp_tablespace`\. For more information, see [ Modifying parameters in a DB parameter group](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_WorkingWithDBInstanceParamGroups.html#USER_WorkingWithParamGroups.Modifying)\. You can also use the SET command to modify the value of the `temp_tablespaces` parameter to `pg_default` at the session level using SET command\. Modifying the parameter redirects the temporary work area to Amazon EBS\. Switching back to Amazon EBS helps when the local storage for your RDS instance or cluster isn't sufficient to perform a specific SQL operation\. - -``` -postgres=> SET temp_tablespaces TO 'pg_default'; -SET -``` - -``` -postgres=> show temp_tablespaces; - - temp_tablespaces ------------------- - pg_default -``` - -## Use cases for RDS Optimized Reads - -The following are some use cases that can benefit from Optimized Reads: -+ Analytical queries that include Common Table Expressions \(CTEs\), derived tables, and grouping operations\. -+ Read replicas that handle the unoptimized queries for an application\. -+ On\-demand or dynamic reporting queries with complex operations such as GROUP BY and ORDER BY that can't always use appropriate indexes\. -+ Other workloads that use internal temporary tables\. - -## Best practices for RDS Optimized Reads - -Use the following best practices for RDS Optimized Reads: -+ Add retry logic for read\-only queries in case they fail because the instance store is full during the execution\. -+ Monitor the storage space available on the instance store with the CloudWatch metric `FreeLocalStorage`\. If the instance store is reaching its limit because of the workload on the DB instance or Multi\-AZ DB cluster, modify it to use a larger DB instance class\. - -## Using RDS Optimized Reads - -When you provision an RDS for PostgreSQL DB instance with one of the following DB instance classes in a Single\-AZ DB instance deployment, Multi\-AZ DB instance deployment, or Multi\-AZ DB cluster deployment, the DB instance automatically uses RDS Optimized Reads: -+ db\.m6gd -+ db\.r6gd -+ db\.m5d -+ db\.r5d - -For more information about Multi\-AZ deployment, see [ Configuring and managing a Multi\-AZ deployment](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Concepts.MultiAZ.html)\. - -To turn on RDS Optimized Reads, do one of the following: -+ Create an RDS for PostgreSQL DB instance or Multi\-AZ DB cluster using one of these DB instance classes\. For more information, see [Creating an Amazon RDS DB instance](USER_CreateDBInstance.md)\. -+ Modify an existing RDS for PostgreSQL DB instance or Multi\-AZ DB cluster to use one of these DB instance classes\. For more information, see [Modifying an Amazon RDS DB instance](Overview.DBInstance.Modifying.md)\. - -RDS Optimized Reads is available in all AWS Regions where one or more of these DB instance classes are supported\. For more information, see [DB instance classes](Concepts.DBInstanceClass.md)\. - -To switch back to a non\-optimized reads RDS instance, modify the DB instance class of your RDS instance or cluster to the similar instance class that only supports EBS storage for your database workloads\. For example, if the current DB instance class is db\.r6gd\.4xlarge, choose db\.r6g\.4xlarge to switch back\. For more information, see [Modifying an Amazon RDS DB instance](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Overview.DBInstance.Modifying.html)\. - -## Monitoring DB instances that use RDS Optimized Reads - -You can monitor DB instances that use RDS Optimized Reads using the following CloudWatch metrics: -+ `FreeLocalStorage` -+ `ReadIOPSLocalStorage` -+ `ReadLatencyLocalStorage` -+ `ReadThroughputLocalStorage` -+ `WriteIOPSLocalStorage` -+ `WriteLatencyLocalStorage` -+ `WriteThroughputLocalStorage` - -These metrics provide data about available instance store storage, IOPS, and throughput\. For more information about these metrics, see [Amazon CloudWatch instance\-level metrics for Amazon RDS](rds-metrics.md#rds-cw-metrics-instance)\. - -To monitor current usage of your local storage, log in to your database using the following query: - -``` -SELECT - spcname AS "Name", - pg_catalog.pg_size_pretty(pg_catalog.pg_tablespace_size(oid)) AS "size" -FROM - pg_catalog.pg_tablespace -WHERE - spcname IN ('rds_temp_tablespace'); -``` - -For more information about the temporary files and their usage, see [Managing temporary files with PostgreSQL](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/PostgreSQL.ManagingTempFiles.html)\. - -## Limitations for RDS Optimized Reads in PostgreSQL - -The following limitations apply to RDS Optimized Reads in PostgreSQL: -+ Transactions can fail when the instance store is full\. -+ If a source instance doesn't have local storage, then read replica with local storage is unsupported\. -+ Point\-in\-time restore from a local storage instance to non\-local storage instance is unsupported\. -+ RDS Optimized Reads in PostgreSQL is available in all AWS Regions\. \ No newline at end of file diff --git a/doc_source/USER_ReadRepl.XRgn.md b/doc_source/USER_ReadRepl.XRgn.md deleted file mode 100644 index 37319e4..0000000 --- a/doc_source/USER_ReadRepl.XRgn.md +++ /dev/null @@ -1,349 +0,0 @@ -# Creating a read replica in a different AWS Region - -With Amazon RDS, you can create a MariaDB, MySQL, Oracle, or PostgreSQL read replica in a different AWS Region from the source DB instance\. Creating a cross\-Region read replica isn't supported for SQL Server on Amazon RDS\. - -![\[Cross-Region read replica configuration\]](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/images/read-replica-cross-region.png) - -You create a read replica in a different AWS Region to do the following: -+ Improve your disaster recovery capabilities\. -+ Scale read operations into an AWS Region closer to your users\. -+ Make it easier to migrate from a data center in one AWS Region to a data center in another AWS Region\. - -Creating a read replica in a different AWS Region from the source instance is similar to creating a replica in the same AWS Region\. You can use the AWS Management Console, run the [https://docs.aws.amazon.com/cli/latest/reference/rds/create-db-instance-read-replica.html](https://docs.aws.amazon.com/cli/latest/reference/rds/create-db-instance-read-replica.html) command, or call the [https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_CreateDBInstanceReadReplica.html](https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_CreateDBInstanceReadReplica.html) API operation\. - -**Note** -To create an encrypted read replica in a different AWS Region from the source DB instance, the source DB instance must be encrypted\. - -## Creating a cross\-Region read replica - -The following procedures show how to create a read replica from a source MariaDB, MySQL, Oracle, or PostgreSQL DB instance in a different AWS Region\. - -### Console - -You can create a read replica across AWS Regions using the AWS Management Console\. - -**To create a read replica across AWS Regions with the console** - -1. Sign in to the AWS Management Console and open the Amazon RDS console at [https://console\.aws\.amazon\.com/rds/](https://console.aws.amazon.com/rds/)\. - -1. In the navigation pane, choose **Databases**\. - -1. Choose the MariaDB, MySQL, Oracle, or PostgreSQL DB instance that you want to use as the source for a read replica\. - -1. For **Actions**, choose **Create read replica**\. - -1. For **DB instance identifier**, enter a name for the read replica\. - -1. Choose the **Destination Region\.** - -1. Choose the instance specifications you want to use\. We recommend that you use the same DB instance class and storage type for the read replica\. - -1. To create an encrypted read replica in another AWS Region: - - 1. Choose **Enable encryption**\. - - 1. For **AWS KMS key**, choose the AWS KMS key identifier of the KMS key in the destination AWS Region\. -**Note** - To create an encrypted read replica, the source DB instance must be encrypted\. To learn more about encrypting the source DB instance, see [Encrypting Amazon RDS resources](Overview.Encryption.md)\. - -1. Choose other options, such as storage autoscaling\. - -1. Choose **Create read replica**\. - -### AWS CLI - - To create a read replica from a source MySQL, MariaDB, Oracle, or PostgreSQL DB instance in a different AWS Region, you can use the [https://docs.aws.amazon.com/cli/latest/reference/rds/create-db-instance-read-replica.html](https://docs.aws.amazon.com/cli/latest/reference/rds/create-db-instance-read-replica.html) command\. In this case, you use [https://docs.aws.amazon.com/cli/latest/reference/rds/create-db-instance-read-replica.html](https://docs.aws.amazon.com/cli/latest/reference/rds/create-db-instance-read-replica.html) from the AWS Region where you want the read replica \(destination Region\) and specify the Amazon Resource Name \(ARN\) for the source DB instance\. An ARN uniquely identifies a resource created in Amazon Web Services\. - -For example, if your source DB instance is in the US East \(N\. Virginia\) Region, the ARN looks similar to this example: - -``` -arn:aws:rds:us-east-1:123456789012:db:mydbinstance -``` - -For information about ARNs, see [Working with Amazon Resource Names \(ARNs\) in Amazon RDS](USER_Tagging.ARN.md)\. - - To create a read replica in a different AWS Region from the source DB instance, you can use the AWS CLI [https://docs.aws.amazon.com/cli/latest/reference/rds/create-db-instance-read-replica.html](https://docs.aws.amazon.com/cli/latest/reference/rds/create-db-instance-read-replica.html) command from the destination AWS Region\. The following parameters are required for creating a read replica in another AWS Region: -+ `--region` – The destination AWS Region where the read replica is created\. -+ `--source-db-instance-identifier` – The DB instance identifier for the source DB instance\. This identifier must be in the ARN format for the source AWS Region\. -+ `--db-instance-identifier` – The identifier for the read replica in the destination AWS Region\. - -**Example of a cross\-Region read replica** -The following code creates a read replica in the US West \(Oregon\) Region from a source DB instance in the US East \(N\. Virginia\) Region\. -For Linux, macOS, or Unix: - -``` -aws rds create-db-instance-read-replica \ - --db-instance-identifier myreadreplica \ - --region us-west-2 \ - --source-db-instance-identifier arn:aws:rds:us-east-1:123456789012:db:mydbinstance -``` -For Windows: - -``` -aws rds create-db-instance-read-replica ^ - --db-instance-identifier myreadreplica ^ - --region us-west-2 ^ - --source-db-instance-identifier arn:aws:rds:us-east-1:123456789012:db:mydbinstance -``` - -The following parameter is also required for creating an encrypted read replica in another AWS Region: -+ `--kms-key-id` – The AWS KMS key identifier of the KMS key to use to encrypt the read replica in the destination AWS Region\. - -**Example of an encrypted cross\-Region read replica** -The following code creates an encrypted read replica in the US West \(Oregon\) Region from a source DB instance in the US East \(N\. Virginia\) Region\. -For Linux, macOS, or Unix: - -``` -aws rds create-db-instance-read-replica \ - --db-instance-identifier myreadreplica \ - --region us-west-2 \ - --source-db-instance-identifier arn:aws:rds:us-east-1:123456789012:db:mydbinstance \ - --kms-key-id my-us-west-2-key -``` -For Windows: - -``` -aws rds create-db-instance-read-replica ^ - --db-instance-identifier myreadreplica ^ - --region us-west-2 ^ - --source-db-instance-identifier arn:aws:rds:us-east-1:123456789012:db:mydbinstance ^ - --kms-key-id my-us-west-2-key -``` - -The `--source-region` option is required when you're creating an encrypted read replica between the AWS GovCloud \(US\-East\) and AWS GovCloud \(US\-West\) Regions\. For `--source-region`, specify the AWS Region of the source DB instance\. - -If `--source-region` isn't specified, specify a `--pre-signed-url` value\. A *presigned URL* is a URL that contains a Signature Version 4 signed request for the `create-db-instance-read-replica` command that's called in the source AWS Region\. To learn more about the `pre-signed-url` option, see [create\-db\-instance\-read\-replica](https://docs.aws.amazon.com/cli/latest/reference/rds/create-db-instance-read-replica.html) in the *AWS CLI Command Reference*\. - -### RDS API - -To create a read replica from a source MySQL, MariaDB, Oracle, or PostgreSQL DB instance in a different AWS Region, you can call the Amazon RDS API operation [CreateDBInstanceReadReplica](https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_CreateDBInstanceReadReplica.html)\. In this case, you call [CreateDBInstanceReadReplica](https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_CreateDBInstanceReadReplica.html) from the AWS Region where you want the read replica \(destination Region\) and specify the Amazon Resource Name \(ARN\) for the source DB instance\. An ARN uniquely identifies a resource created in Amazon Web Services\. - -To create an encrypted read replica in a different AWS Region from the source DB instance, you can use the Amazon RDS API [https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_CreateDBInstanceReadReplica.html](https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_CreateDBInstanceReadReplica.html) operation from the destination AWS Region\. To create an encrypted read replica in another AWS Region, you must specify a value for `PreSignedURL`\. `PreSignedURL` should contain a request for the [https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_CreateDBInstanceReadReplica.html](https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_CreateDBInstanceReadReplica.html) operation to call in the source AWS Region where the read replica is created in\. To learn more about `PreSignedUrl`, see [https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_CreateDBInstanceReadReplica.html](https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_CreateDBInstanceReadReplica.html)\. - -For example, if your source DB instance is in the US East \(N\. Virginia\) Region, the ARN looks similar to the following\. - -``` -arn:aws:rds:us-east-1:123456789012:db:mydbinstance -``` - -For information about ARNs, see [Working with Amazon Resource Names \(ARNs\) in Amazon RDS](USER_Tagging.ARN.md)\. - -**Example** - -``` -https://us-west-2.rds.amazonaws.com/ - ?Action=CreateDBInstanceReadReplica - &KmsKeyId=my-us-east-1-key - &PreSignedUrl=https%253A%252F%252Frds.us-west-2.amazonaws.com%252F - %253FAction%253DCreateDBInstanceReadReplica - %2526DestinationRegion%253Dus-east-1 - %2526KmsKeyId%253Dmy-us-east-1-key - %2526SourceDBInstanceIdentifier%253Darn%25253Aaws%25253Ards%25253Aus-west-2%123456789012%25253Adb%25253Amydbinstance - %2526SignatureMethod%253DHmacSHA256 - %2526SignatureVersion%253D4%2526SourceDBInstanceIdentifier%253Darn%25253Aaws%25253Ards%25253Aus-west-2%25253A123456789012%25253Ainstance%25253Amydbinstance - %2526Version%253D2014-10-31 - %2526X-Amz-Algorithm%253DAWS4-HMAC-SHA256 - %2526X-Amz-Credential%253DAKIADQKE4SARGYLE%252F20161117%252Fus-west-2%252Frds%252Faws4_request - %2526X-Amz-Date%253D20161117T215409Z - %2526X-Amz-Expires%253D3600 - %2526X-Amz-SignedHeaders%253Dcontent-type%253Bhost%253Buser-agent%253Bx-amz-content-sha256%253Bx-amz-date - %2526X-Amz-Signature%253D255a0f17b4e717d3b67fad163c3ec26573b882c03a65523522cf890a67fca613 - &DBInstanceIdentifier=myreadreplica - &SourceDBInstanceIdentifier=®ion-arn;rds:us-east-1:123456789012:db:mydbinstance - &Version=2012-01-15 - &SignatureVersion=2 - &SignatureMethod=HmacSHA256 - &Timestamp=2012-01-20T22%3A06%3A23.624Z - &AWSAccessKeyId=<&AWS; Access Key ID> - &Signature= -``` - -## How Amazon RDS does cross\-Region replication - -Amazon RDS uses the following process to create a cross\-Region read replica\. Depending on the AWS Regions involved and the amount of data in the databases, this process can take hours to complete\. You can use this information to determine how far the process has proceeded when you create a cross\-Region read replica: - -1. Amazon RDS begins configuring the source DB instance as a replication source and sets the status to *modifying*\. - -1. Amazon RDS begins setting up the specified read replica in the destination AWS Region and sets the status to *creating*\. - -1. Amazon RDS creates an automated DB snapshot of the source DB instance in the source AWS Region\. The format of the DB snapshot name is `rds:-`, where `` is the identifier of the source instance, and `` is the date and time the copy started\. For example, `rds:mysourceinstance-2013-11-14-09-24` was created from the instance `mysourceinstance` at `2013-11-14-09-24`\. During the creation of an automated DB snapshot, the source DB instance status remains *modifying*, the read replica status remains *creating*, and the DB snapshot status is *creating*\. The progress column of the DB snapshot page in the console reports how far the DB snapshot creation has progressed\. When the DB snapshot is complete, the status of both the DB snapshot and source DB instance are set to *available*\. - -1. Amazon RDS begins a cross\-Region snapshot copy for the initial data transfer\. The snapshot copy is listed as an automated snapshot in the destination AWS Region with a status of *creating*\. It has the same name as the source DB snapshot\. The progress column of the DB snapshot display indicates how far the copy has progressed\. When the copy is complete, the status of the DB snapshot copy is set to *available*\. - -1. Amazon RDS then uses the copied DB snapshot for the initial data load on the read replica\. During this phase, the read replica is in the list of DB instances in the destination, with a status of *creating*\. When the load is complete, the read replica status is set to *available*, and the DB snapshot copy is deleted\. - -1. When the read replica reaches the available status, Amazon RDS starts by replicating the changes made to the source instance since the start of the create read replica operation\. During this phase, the replication lag time for the read replica is greater than 0\. - - For information about replication lag time, see [Monitoring read replication](USER_ReadRepl.md#USER_ReadRepl.Monitoring)\. - -## Cross\-Region replication considerations - -All of the considerations for performing replication within an AWS Region apply to cross\-Region replication\. The following extra considerations apply when replicating between AWS Regions: -+ You can only replicate between AWS Regions when using the following Amazon RDS DB instances: - + MariaDB \(all versions\) - + MySQL \(all versions\) - + Oracle Enterprise Edition \(EE\) of Oracle Database 12c Release 1 \(12\.1\) using 12\.1\.0\.2\.v10 and higher, Oracle Database 12c Release 2 \(12\.2\), and Oracle Database 19c using the non\-CDB architecture -**Note** -Oracle DB instances that you create using the CDB architecture aren't supported\. - - An Active Data Guard license is required\. For information about limitations for Oracle cross\-Region read replicas, see [Replica requirements for Oracle](oracle-read-replicas.limitations.md)\. - + PostgreSQL \(all versions\) -+ A source DB instance can have cross\-Region read replicas in multiple AWS Regions\. -+ You can only create a cross\-Region Amazon RDS read replica from a source Amazon RDS DB instance that is not a read replica of another Amazon RDS DB instance\. -+ You can replicate between the AWS GovCloud \(US\-East\) and AWS GovCloud \(US\-West\) Regions, but not into or out of AWS GovCloud \(US\)\. -+ You can expect to see a higher level of lag time for any read replica that is in a different AWS Region than the source instance\. This lag time comes from the longer network channels between regional data centers\. -+ For cross\-Region read replicas, any of the create read replica commands that specify the `--db-subnet-group-name` parameter must specify a DB subnet group from the same VPC\. -+ Due to the limit on the number of access control list \(ACL\) entries for a VPC, we can't guarantee more than five cross\-Region read replica instances\. -+ In most cases, the read replica uses the default DB parameter group and DB option group for the specified DB engine\. - - For the MySQL and Oracle DB engines, you can specify a custom parameter group for the read replica in the `--db-parameter-group-name` option of the AWS CLI command [https://docs.aws.amazon.com/cli/latest/reference/rds/create-db-instance-read-replica.html](https://docs.aws.amazon.com/cli/latest/reference/rds/create-db-instance-read-replica.html)\. You can't specify a custom parameter group when you use the AWS Management Console\. -+ The read replica uses the default security group\. -+ For MariaDB, MySQL, and Oracle DB instances, when the source DB instance for a cross\-Region read replica is deleted, the read replica is promoted\. -+ For PostgreSQL DB instances, when the source DB instance for a cross\-Region read replica is deleted, the replication status of the read replica is set to `terminated`\. The read replica isn't promoted\. - - You have to promote the read replica manually or delete it\. - -### Requesting a cross\-Region read replica - -To communicate with the source Region to request the creation of a cross\-Region read replica, the requester \(IAM role or IAM user\) must have access to the source DB instance and the source Region\. - -Certain conditions in the requester's IAM policy can cause the request to fail\. The following examples assume that the source DB instance is in US East \(Ohio\) and the read replica is created in US East \(N\. Virginia\)\. These examples show conditions in the requester's IAM policy that cause the request to fail: -+ The requester's policy has a condition for `aws:RequestedRegion`\. - - ``` - ... - "Effect": "Allow", - "Action": "rds:CreateDBInstanceReadReplica", - "Resource": "*", - "Condition": { - "StringEquals": { - "aws:RequestedRegion": "us-east-1" - } - } - ``` - - The request fails because the policy doesn't allow access to the source Region\. For a successful request, specify both the source and destination Regions\. - - ``` - ... - "Effect": "Allow", - "Action": "rds:CreateDBInstanceReadReplica", - "Resource": "*", - "Condition": { - "StringEquals": { - "aws:RequestedRegion": [ - "us-east-1", - "us-east-2" - ] - } - } - ``` -+ The requester's policy doesn't allow access to the source DB instance\. - - ``` - ... - "Effect": "Allow", - "Action": "rds:CreateDBInstanceReadReplica", - "Resource": "arn:aws:rds:us-east-1:123456789012:db:myreadreplica" - ... - ``` - - For a successful request, specify both the source instance and the replica\. - - ``` - ... - "Effect": "Allow", - "Action": "rds:CreateDBInstanceReadReplica", - "Resource": [ - "arn:aws:rds:us-east-1:123456789012:db:myreadreplica", - "arn:aws:rds:us-east-2:123456789012:db:mydbinstance" - ] - ... - ``` -+ The requester's policy denies `aws:ViaAWSService`\. - - ``` - ... - "Effect": "Allow", - "Action": "rds:CreateDBInstanceReadReplica", - "Resource": "*", - "Condition": { - "Bool": {"aws:ViaAWSService": "false"} - } - ``` - - Communication with the source Region is made by RDS on the requester's behalf\. For a successful request, don't deny calls made by AWS services\. -+ The requester's policy has a condition for `aws:SourceVpc` or `aws:SourceVpce`\. - - These requests might fail because when RDS makes the call to the remote Region, it isn't from the specified VPC or VPC endpoint\. - -If you need to use one of the previous conditions that would cause a request to fail, you can include a second statement with `aws:CalledVia` in your policy to make the request succeed\. For example, you can use `aws:CalledVia` with `aws:SourceVpce` as shown here: - -``` -... -"Effect": "Allow", -"Action": "rds:CreateDBInstanceReadReplica", -"Resource": "*", -"Condition": { - "Condition" : { - "ForAnyValue:StringEquals" : { - "aws:SourceVpce": "vpce-1a2b3c4d" - } - } -}, -{ - "Effect": "Allow", - "Action": [ - "rds:CreateDBInstanceReadReplica" - ], - "Resource": "*", - "Condition": { - "ForAnyValue:StringEquals": { - "aws:CalledVia": [ - "rds.amazonaws.com" - ] - } - } -} -``` - -For more information, see [Policies and permissions in IAM](https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies.html) in the *IAM User Guide*\. - -### Authorizing the read replica - -After a cross\-Region DB read replica creation request returns `success`, RDS starts the replica creation in the background\. An authorization for RDS to access the source DB instance is created\. This authorization links the source DB instance to the read replica, and allows RDS to copy only to the specified read replica\. - - The authorization is verified by RDS using the `rds:CrossRegionCommunication` permission in the service\-linked IAM role\. If the replica is authorized, RDS communicates with the source Region and completes the replica creation\. - - RDS doesn't have access to DB instances that weren't authorized previously by a `CreateDBInstanceReadReplica` request\. The authorization is revoked when read replica creation completes\. - - RDS uses the service\-linked role to verify the authorization in the source Region\. If you delete the service\-linked role during the replication creation process, the creation fails\. - -For more information, see [Using service\-linked roles](https://docs.aws.amazon.com/IAM/latest/UserGuide/using-service-linked-roles.html) in the *IAM User Guide*\. - -### Using AWS Security Token Service credentials - -Session tokens from the global AWS Security Token Service \(AWS STS\) endpoint are valid only in AWS Regions that are enabled by default \(commercial Regions\)\. If you use credentials from the `assumeRole` API operation in AWS STS, use the regional endpoint if the source Region is an opt\-in Region\. Otherwise, the request fails\. This happens because your credentials must be valid in both Regions, which is true for opt\-in Regions only when the regional AWS STS endpoint is used\. - -To use the global endpoint, make sure that it's enabled for both Regions in the operations\. Set the global endpoint to `Valid in all AWS Regions` in the AWS STS account settings\. - - The same rule applies to credentials in the presigned URL parameter\. - -For more information, see [Managing AWS STS in an AWS Region](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp_enable-regions.html) in the *IAM User Guide*\. - -## Cross\-Region replication costs - -The data transferred for cross\-Region replication incurs Amazon RDS data transfer charges\. These cross\-Region replication actions generate charges for the data transferred out of the source AWS Region: -+ When you create a read replica, Amazon RDS takes a snapshot of the source instance and transfers the snapshot to the read replica AWS Region\. -+ For each data modification made in the source databases, Amazon RDS transfers data from the source AWS Region to the read replica AWS Region\. - -For more information about data transfer pricing, see [Amazon RDS pricing](https://aws.amazon.com/rds/pricing/)\. - -For MySQL and MariaDB instances, you can reduce your data transfer costs by reducing the number of cross\-Region read replicas that you create\. For example, suppose that you have a source DB instance in one AWS Region and want to have three read replicas in another AWS Region\. In this case, you create only one of the read replicas from the source DB instance\. You create the other two replicas from the first read replica instead of the source DB instance\. - -For example, if you have `source-instance-1` in one AWS Region, you can do the following: -+ Create `read-replica-1` in the new AWS Region, specifying `source-instance-1` as the source\. -+ Create `read-replica-2` from `read-replica-1`\. -+ Create `read-replica-3` from `read-replica-1`\. - -In this example, you are only charged for the data transferred from `source-instance-1` to `read-replica-1`\. You aren't charged for the data transferred from `read-replica-1` to the other two replicas because they are all in the same AWS Region\. If you create all three replicas directly from `source-instance-1`, you are charged for the data transfers to all three replicas\. \ No newline at end of file diff --git a/doc_source/USER_ReadRepl.md b/doc_source/USER_ReadRepl.md deleted file mode 100644 index a4555f3..0000000 --- a/doc_source/USER_ReadRepl.md +++ /dev/null @@ -1,672 +0,0 @@ -# Working with DB instance read replicas - -A read replica is a read\-only copy of a DB instance\. You can reduce the load on your primary DB instance by routing queries from your applications to the read replica\. In this way, you can elastically scale out beyond the capacity constraints of a single DB instance for read\-heavy database workloads\. - -To create a read replica from a source DB instance, Amazon RDS uses the built\-in replication features of the DB engine\. For information about using read replicas with a specific engine, see the following sections: -+ [Working with MariaDB read replicas](USER_MariaDB.Replication.ReadReplicas.md) -+ [Working with read replicas for Microsoft SQL Server in Amazon RDS](SQLServer.ReadReplicas.md) -+ [Working with MySQL read replicas](USER_MySQL.Replication.ReadReplicas.md) -+ [Working with read replicas for Amazon RDS for Oracle](oracle-read-replicas.md) -+ [Working with read replicas for Amazon RDS for PostgreSQL](USER_PostgreSQL.Replication.ReadReplicas.md) - -After you create a read replica from a source DB instance, the source becomes the primary DB instance\. When you make updates to the primary DB instance, Amazon RDS copies them asynchronously to the read replica\. The following diagram shows a source DB instance replicating to a read replica in a different Availability Zone \(AZ\)\. Client have read/write access to the primary DB instance and read\-only access to the replica\. - -![\[Read replica configuration\]](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/images/read-replica.png) - -**Topics** -+ [Overview of Amazon RDS read replicas](#USER_ReadRepl.Overview) -+ [Creating a read replica](#USER_ReadRepl.Create) -+ [Promoting a read replica to be a standalone DB instance](#USER_ReadRepl.Promote) -+ [Monitoring read replication](#USER_ReadRepl.Monitoring) -+ [Creating a read replica in a different AWS Region](#USER_ReadRepl.XRgn) - -## Overview of Amazon RDS read replicas - -The following sections discuss DB *instance* read replicas\. For information about Multi\-AZ DB *cluster* read replicas, see [Working with Multi\-AZ DB cluster read replicas](USER_MultiAZDBCluster_ReadRepl.md)\. - -**Topics** -+ [Use cases for read replicas](#USER_ReadRepl.Overview.use-cases) -+ [How read replicas work](#USER_ReadRepl.Overview.how-it-works) -+ [Read replicas in a Multi\-AZ deployment](#USER_ReadRepl.Overview.maz-replicas) -+ [Cross\-Region read replicas](#USER_ReadRepl.Overview.xregion-replicas) -+ [Differences among read replicas for DB engines](#USER_ReadRepl.Overview.Differences) -+ [Read replica storage types](#USER_ReadRepl.Overview.replica-storage) -+ [Restrictions for creating a replica from a replica](#USER_ReadRepl.Overview.circular-replication) -+ [Considerations when deleting replicas](#USER_ReadRepl.Overview.deletion-considerations) - -### Use cases for read replicas - -Deploying one or more read replicas for a given source DB instance might make sense in a variety of scenarios, including the following: -+ Scaling beyond the compute or I/O capacity of a single DB instance for read\-heavy database workloads\. You can direct this excess read traffic to one or more read replicas\. -+ Serving read traffic while the source DB instance is unavailable\. In some cases, your source DB instance might not be able to take I/O requests, for example due to I/O suspension for backups or scheduled maintenance\. In these cases, you can direct read traffic to your read replicas\. For this use case, keep in mind that the data on the read replica might be "stale" because the source DB instance is unavailable\. -+ Business reporting or data warehousing scenarios where you might want business reporting queries to run against a read replica, rather than your production DB instance\. -+ Implementing disaster recovery\. You can promote a read replica to a standalone instance as a disaster recovery solution if the primary DB instance fails\. - -### How read replicas work - -When you create a read replica, you first specify an existing DB instance as the source\. Then Amazon RDS takes a snapshot of the source instance and creates a read\-only instance from the snapshot\. Amazon RDS then uses the asynchronous replication method for the DB engine to update the read replica whenever there is a change to the primary DB instance\. - -The read replica operates as a DB instance that allows only read\-only connections\. An exception is the RDS for Oracle DB engine, which supports replica databases in mounted mode\. A mounted replica doesn't accept user connections and so can't serve a read\-only workload\. The primary use for mounted replicas is cross\-Region disaster recovery\. For more information, see [Working with read replicas for Amazon RDS for Oracle](oracle-read-replicas.md)\. - -Applications connect to a read replica just as they do to any DB instance\. Amazon RDS replicates all databases from the source DB instance\. - -### Read replicas in a Multi\-AZ deployment - -You can configure a read replica for a DB instance that also has a standby replica configured for high availability in a Multi\-AZ deployment\. Replication with the standby replica is synchronous\. Unlike a read replica, a standby replica can't serve read traffic\. - -In the following scenario, clients have read/write access to a primary DB instance in one AZ\. The primary instance copies updates asynchronously to a read replica in a second AZ and also copies them synchronously to a standby replica in a third AZ\. Clients have read access only to the read replica\. - -![\[Read replica and standby replica configuration\]](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/images/read-and-standby-replica.png) - -For more information about high availability and standby replicas, see [Configuring and managing a Multi\-AZ deployment](Concepts.MultiAZ.md)\. - -### Cross\-Region read replicas - -In some cases, a read replica resides in a different AWS Region from its primary DB instance\. In these cases, Amazon RDS sets up a secure communications channel between the primary DB instance and the read replica\. Amazon RDS establishes any AWS security configurations needed to enable the secure channel, such as adding security group entries\. For more information about cross\-Region read replicas, see [Creating a read replica in a different AWS Region](#USER_ReadRepl.XRgn)\. - -The information in this chapter applies to creating Amazon RDS read replicas either in the same AWS Region as the source DB instance, or in a separate AWS Region\. The following information doesn't apply to setting up replication with an instance that is running on an Amazon EC2 instance or that is on\-premises\. - -### Differences among read replicas for DB engines - -Because Amazon RDS DB engines implement replication differently, there are several significant differences you should know about, as shown in the following table\. - - -| Feature or behavior | MySQL and MariaDB | Oracle | PostgreSQL | SQL Server | -| --- | --- | --- | --- | --- | -| What is the replication method? | Logical replication\. | Physical replication\. | Physical replication\. | Physical replication\. | -| How are transaction logs purged? | RDS for MySQL and RDS for MariaDB keep any binary logs that haven't been applied\. | If a primary DB instance has no cross\-Region read replicas, Amazon RDS for Oracle keeps a minimum of two hours of transaction logs on the source DB instance\. Logs are purged from the source DB instance after two hours or after the archive log retention hours setting has passed, whichever is longer\. Logs are purged from the read replica after the archive log retention hours setting has passed only if they have been successfully applied to the database\. In some cases, a primary DB instance might have one or more cross\-Region read replicas\. If so, Amazon RDS for Oracle keeps the transaction logs on the source DB instance until they have been transmitted and applied to all cross\-Region read replicas\. For information about setting archive log retention hours, see [Retaining archived redo logs](Appendix.Oracle.CommonDBATasks.Log.md#Appendix.Oracle.CommonDBATasks.RetainRedoLogs)\. | PostgreSQL has the parameter `wal_keep_segments` that dictates how many write ahead log \(WAL\) files are kept to provide data to the read replicas\. The parameter value specifies the number of logs to keep\. | The Virtual Log File \(VLF\) of the transaction log file on the primary replica can be truncated after it is no longer required for the secondary replicas\. The VLF can only be marked as inactive when the log records have been hardened in the replicas\. Regardless of how fast the disk subsystems are in the primary replica, the transaction log will keep the VLFs until the slowest replica has hardened it\. | -| Can a replica be made writable? | Yes\. You can enable the MySQL or MariaDB read replica to be writable\. | No\. An Oracle read replica is a physical copy, and Oracle doesn't allow for writes in a read replica\. You can promote the read replica to make it writable\. The promoted read replica has the replicated data to the point when the request was made to promote it\. | No\. A PostgreSQL read replica is a physical copy, and PostgreSQL doesn't allow for a read replica to be made writable\. | No\. A SQL Server read replica is a physical copy and also doesn't allow for writes\. You can promote the read replica to make it writable\. The promoted read replica has the replicated data up to the point when the request was made to promote it\. | -| Can backups be performed on the replica? | Yes\. Automatic backups and manual snapshots are supported on RDS for MySQL or RDS for MariaDB read replicas\. | Yes\. Automatic backups and manual snapshots are supported on RDS for Oracle read replicas\. | Yes, you can create a manual snapshot of RDS for PostgreSQL read replicas\. Automated backups for read replicas are supported for RDS for PostgreSQL 14\.1 and higher versions only\. You can't turn on automated backups for PostgreSQL read replicas for RDS for PostgreSQL versions earlier than 14\.1\. For RDS for PostgreSQL 13 and earlier versions, create a snapshot from a read replica if you want a backup of it\. | No\. Automatic backups and manual snapshots aren't supported on RDS for SQL Server read replicas\. | -| Can you use parallel replication? | Yes\. All supported MariaDB and MySQL versions allow for parallel replication threads\. | Yes\. Redo log data is always transmitted in parallel from the primary database to all of its read replicas\. | No\. PostgreSQL has a single process handling replication\. | Yes\. Redo log data is always transmitted in parallel from the primary database to all of its read replicas\. | -| Can you maintain a replica in a mounted rather than a read\-only state? | No\. | Yes\. The primary use for mounted replicas is cross\-Region disaster recovery\. An Active Data Guard license isn't required for mounted replicas\. For more information, see [Working with read replicas for Amazon RDS for Oracle](oracle-read-replicas.md)\. | No\. | No\. | - -### Read replica storage types - -By default, a read replica is created with the same storage type as the source DB instance\. However, you can create a read replica that has a different storage type from the source DB instance based on the options listed in the following table\. - -[\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_ReadRepl.html) - -**Note** -When you increase the allocated storage of a read replica, it must be by at least 10 percent\. If you try to increase the value by less than 10 percent, you get an error\. - -### Restrictions for creating a replica from a replica - -Amazon RDS doesn't support circular replication\. You can't configure a DB instance to serve as a replication source for an existing DB instance\. You can only create a new read replica from an existing DB instance\. For example, if **MySourceDBInstance** replicates to **ReadReplica1**, you can't configure **ReadReplica1** to replicate back to **MySourceDBInstance**\. - -For RDS for MariaDB and RDS for MySQL, and for certain versions of RDS for PostgreSQL, you can create a read replica from an existing read replica\. For example, you can create new read replica **ReadReplica2** from exiting replica **ReadReplica1**\. For RDS for Oracle and RDS for SQL Server, you can't create a read replica from an existing read replica\. - -### Considerations when deleting replicas - -If you no longer need read replicas, you can explicitly delete them using the same mechanisms for deleting a DB instance\. If you delete a source DB instance without deleting its read replicas in the same AWS Region, each read replica is promoted to a standalone DB instance\. For information about deleting a DB instance, see [Deleting a DB instance](USER_DeleteInstance.md)\. For information about read replica promotion, see [Promoting a read replica to be a standalone DB instance](#USER_ReadRepl.Promote)\. - -If you have cross\-Region read replicas, see [Cross\-Region replication considerations](#USER_ReadRepl.XRgn.Cnsdr) for information related to deleting the source DB instance for a cross\-Region read replica\. - -## Creating a read replica - -You can create a read replica from an existing DB instance using the AWS Management Console, AWS CLI, or RDS API\. You create a read replica by specifying `SourceDBInstanceIdentifier`, which is the DB instance identifier of the source DB instance that you want to replicate from\. - -When you create a read replica, Amazon RDS takes a DB snapshot of your source DB instance and begins replication\. As a result, you experience a brief I/O suspension on your source DB instance while the DB snapshot occurs\. - -**Note** -The I/O suspension typically lasts about one minute\. You can avoid the I/O suspension if the source DB instance is a Multi\-AZ deployment, because in that case the snapshot is taken from the secondary DB instance\. - -An active, long\-running transaction can slow the process of creating the read replica\. We recommend that you wait for long\-running transactions to complete before creating a read replica\. If you create multiple read replicas in parallel from the same source DB instance, Amazon RDS takes only one snapshot at the start of the first create action\. - -When creating a read replica, there are a few things to consider\. First, you must enable automatic backups on the source DB instance by setting the backup retention period to a value other than 0\. This requirement also applies to a read replica that is the source DB instance for another read replica\. To enable automatic backups on an RDS for MySQL read replica, first create the read replica, then modify the read replica to enable automatic backups\. - -**Note** -Within an AWS Region, we strongly recommend that you create all read replicas in the same virtual private cloud \(VPC\) based on Amazon VPC as the source DB instance\. If you create a read replica in a different VPC from the source DB instance, classless inter\-domain routing \(CIDR\) ranges can overlap between the replica and the RDS system\. CIDR overlap makes the replica unstable, which can negatively impact applications connecting to it\. If you receive an error when creating the read replica, choose a different destination DB subnet group\. For more information, see [Working with a DB instance in a VPC](USER_VPC.WorkingWithRDSInstanceinaVPC.md)\. -There is no direct way to create a read replica in another AWS account using the console or AWS CLI\. - -### Console - -**To create a read replica from a source DB instance** - -1. Sign in to the AWS Management Console and open the Amazon RDS console at [https://console\.aws\.amazon\.com/rds/](https://console.aws.amazon.com/rds/)\. - -1. In the navigation pane, choose **Databases**\. - -1. Choose the DB instance that you want to use as the source for a read replica\. - -1. For **Actions**, choose **Create read replica**\. - -1. For **DB instance identifier**, enter a name for the read replica\. - -1. Choose your instance specifications\. We recommend that you use the same or larger DB instance class and storage type as the source DB instance for the read replica\. - -1. For **Multi\-AZ deployment**, choose **Yes** to create a standby of your replica in another Availability Zone for failover support for the replica\. -**Note** -Creating your read replica as a Multi\-AZ DB instance is independent of whether the source database is a Multi\-AZ DB instance\. - -1. To create an encrypted read replica: - - 1. Choose **Enable encryption**\. - - 1. For **AWS KMS key**, choose the AWS KMS key identifier of the KMS key\. -**Note** - The source DB instance must be encrypted\. To learn more about encrypting the source DB instance, see [Encrypting Amazon RDS resources](Overview.Encryption.md)\. - -1. Specify other settings, such as allocated storage size and whether you want to use storage autoscaling\. - - For information about each setting, see [Settings for DB instances](USER_CreateDBInstance.md#USER_CreateDBInstance.Settings)\. - -1. Choose **Create read replica**\. - -After the read replica is created, you can see it on the **Databases** page in the RDS console\. It shows **Replica** in the **Role** column\. - -### AWS CLI - -To create a read replica from a source DB instance, use the AWS CLI command [create\-db\-instance\-read\-replica](https://docs.aws.amazon.com/cli/latest/reference/rds/create-db-instance-read-replica.html)\. This example also sets the allocated storage size and enables storage autoscaling\. - -You can specify other settings\. For information about each setting, see [Settings for DB instances](USER_CreateDBInstance.md#USER_CreateDBInstance.Settings)\. - -**Example** -For Linux, macOS, or Unix: - -``` -aws rds create-db-instance-read-replica \ - --db-instance-identifier myreadreplica \ - --source-db-instance-identifier mydbinstance \ - --allocated-storage 100 \ - --max-allocated-storage 1000 -``` -For Windows: - -``` -aws rds create-db-instance-read-replica ^ - --db-instance-identifier myreadreplica ^ - --source-db-instance-identifier mydbinstance ^ - --allocated-storage 100 ^ - --max-allocated-storage 1000 -``` - -### RDS API - -To create a read replica from a source MySQL, MariaDB, Oracle, PostgreSQL, or SQL Server DB instance, call the Amazon RDS API [https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_CreateDBInstanceReadReplica.html](https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_CreateDBInstanceReadReplica.html) operation with the following required parameters: -+ `DBInstanceIdentifier` -+ `SourceDBInstanceIdentifier` - -## Promoting a read replica to be a standalone DB instance - -You can promote a read replica into a standalone DB instance\. When you promote a read replica, the DB instance is rebooted before it becomes available\. - -![\[Promoting a read replica\]](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/images/read-replica-promote.png) - -There are several reasons you might want to promote a read replica to a standalone DB instance: -+ **Performing DDL operations \(MySQL and MariaDB only\)** – DDL operations, such as creating or rebuilding indexes, can take time and impose a significant performance penalty on your DB instance\. You can perform these operations on a MySQL or MariaDB read replica once the read replica is in sync with its primary DB instance\. Then you can promote the read replica and direct your applications to use the promoted instance\. -+ **Sharding** – Sharding embodies the "share\-nothing" architecture and essentially involves breaking a large database into several smaller databases\. One common way to split a database is splitting tables that are not joined in the same query onto different hosts\. Another method is duplicating a table across multiple hosts and then using a hashing algorithm to determine which host receives a given update\. You can create read replicas corresponding to each of your shards \(smaller databases\) and promote them when you decide to convert them into standalone shards\. You can then carve out the key space \(if you are splitting rows\) or distribution of tables for each of the shards depending on your requirements\. -+ **Implementing failure recovery** – You can use read replica promotion as a data recovery scheme if the primary DB instance fails\. This approach complements synchronous replication, automatic failure detection, and failover\. - - If you are aware of the ramifications and limitations of asynchronous replication and you still want to use read replica promotion for data recovery, you can\. To do this, first create a read replica and then monitor the primary DB instance for failures\. In the event of a failure, do the following: - - 1. Promote the read replica\. - - 1. Direct database traffic to the promoted DB instance\. - - 1. Create a replacement read replica with the promoted DB instance as its source\. - -When you promote a read replica, the new DB instance that is created retains the option group and the parameter group of the former read replica\. The promotion process can take several minutes or longer to complete, depending on the size of the read replica\. After you promote the read replica to a new DB instance, it's just like any other DB instance\. For example, you can create read replicas from the new DB instance and perform point\-in\-time restore operations\. Because the promoted DB instance is no longer a read replica, you can't use it as a replication target\. If a source DB instance has several read replicas, promoting one of the read replicas to a DB instance has no effect on the other replicas\. - -Backup duration is a function of the number of changes to the database since the previous backup\. If you plan to promote a read replica to a standalone instance, we recommend that you enable backups and complete at least one backup prior to promotion\. In addition, you can't promote a read replica to a standalone instance when it has the `backing-up` status\. If you have enabled backups on your read replica, configure the automated backup window so that daily backups don't interfere with read replica promotion\. - -The following steps show the general process for promoting a read replica to a DB instance: - -1. Stop any transactions from being written to the primary DB instance, and then wait for all updates to be made to the read replica\. Database updates occur on the read replica after they have occurred on the primary DB instance, and this replication lag can vary significantly\. Use the [http://aws.amazon.com/rds/faqs/#105](http://aws.amazon.com/rds/faqs/#105) metric to determine when all updates have been made to the read replica\. - -1. For MySQL and MariaDB only: If you need to make changes to the MySQL or MariaDB read replica, you must set the `read_only` parameter to `0` in the DB parameter group for the read replica\. You can then perform all needed DDL operations, such as creating indexes, on the read replica\. Actions taken on the read replica don't affect the performance of the primary DB instance\. - -1. Promote the read replica by using the **Promote** option on the Amazon RDS console, the AWS CLI command [https://docs.aws.amazon.com/cli/latest/reference/rds/promote-read-replica.html](https://docs.aws.amazon.com/cli/latest/reference/rds/promote-read-replica.html), or the [https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_PromoteReadReplica.html](https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_PromoteReadReplica.html) Amazon RDS API operation\. -**Note** -The promotion process takes a few minutes to complete\. When you promote a read replica, replication is stopped and the read replica is rebooted\. When the reboot is complete, the read replica is available as a new DB instance\. - -1. \(Optional\) Modify the new DB instance to be a Multi\-AZ deployment\. For more information, see [Modifying an Amazon RDS DB instance](Overview.DBInstance.Modifying.md) and [Configuring and managing a Multi\-AZ deployment](Concepts.MultiAZ.md)\. - -### Console - -**To promote a read replica to a standalone DB instance** - -1. Sign in to the AWS Management Console and open the Amazon RDS console at [https://console\.aws\.amazon\.com/rds/](https://console.aws.amazon.com/rds/)\. - -1. In the Amazon RDS console, choose **Databases**\. - - The **Databases** pane appears\. Each read replica shows **Replica** in the **Role** column\. - -1. Choose the read replica that you want to promote\. - -1. For **Actions**, choose **Promote**\. - -1. On the **Promote Read Replica** page, enter the backup retention period and the backup window for the newly promoted DB instance\. - -1. When the settings are as you want them, choose **Continue**\. - -1. On the acknowledgment page, choose **Promote Read Replica**\. - -### AWS CLI - -To promote a read replica to a standalone DB instance, use the AWS CLI [https://docs.aws.amazon.com/cli/latest/reference/rds/promote-read-replica.html](https://docs.aws.amazon.com/cli/latest/reference/rds/promote-read-replica.html) command\. - -**Example** -For Linux, macOS, or Unix: - -``` -aws rds promote-read-replica \ - --db-instance-identifier myreadreplica -``` -For Windows: - -``` -aws rds promote-read-replica ^ - --db-instance-identifier myreadreplica -``` - -### RDS API - -To promote a read replica to a standalone DB instance, call the Amazon RDS API [https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_PromoteReadReplica.html](https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_PromoteReadReplica.html) operation with the required parameter `DBInstanceIdentifier`\. - -## Monitoring read replication - -You can monitor the status of a read replica in several ways\. The Amazon RDS console shows the status of a read replica in the **Replication** section of the **Connectivity & security** tab in the read replica details\. To view the details for a read replica, choose the name of the read replica in the list of DB instances in the Amazon RDS console\. - -![\[Read replica status\]](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/images/ReadReplicaStatus.png) - -You can also see the status of a read replica using the AWS CLI `describe-db-instances` command or the Amazon RDS API `DescribeDBInstances` operation\. - -The status of a read replica can be one of the following: -+ ****replicating**** – The read replica is replicating successfully\. -+ ****replication degraded** \(SQL Server only\) – **Replicas are receiving data from the primary instance, but one or more databases might be not getting updates\. This can occur, for example, when a replica is in the process of setting up newly created databases\. - - The status doesn't transition from `replication degraded` to `error`, unless an error occurs during the degraded state\. -+ ****error**** – An error has occurred with the replication\. Check the **Replication Error** field in the Amazon RDS console or the event log to determine the exact error\. For more information about troubleshooting a replication error, see [Troubleshooting a MySQL read replica problem](USER_MySQL.Replication.ReadReplicas.md#USER_ReadRepl.Troubleshooting)\. -+ ****terminated** \(MariaDB, MySQL, or PostgreSQL only\)** – Replication is terminated\. This occurs if replication is stopped for more than 30 consecutive days, either manually or due to a replication error\. In this case, Amazon RDS terminates replication between the primary DB instance and all read replicas\. Amazon RDS does this to prevent increased storage requirements on the source DB instance and long failover times\. - - Broken replication can affect storage because the logs can grow in size and number due to the high volume of errors messages being written to the log\. Broken replication can also affect failure recovery due to the time Amazon RDS requires to maintain and process the large number of logs during recovery\. -+ ****terminated** \(Oracle only\)** – Replication is terminated\. This occurs if replication is stopped for more than 8 hours because there isn't enough storage remaining on the read replica\. In this case, Amazon RDS terminates replication between the primary DB instance and the affected read replica\. This status is a terminal state, and the read replica must be re\-created\. -+ ****stopped** \(MariaDB or MySQL only\)** – Replication has stopped because of a customer\-initiated request\. -+ ****replication stop point set** \(MySQL only\)** – A customer\-initiated stop point was set using the [mysql\.rds\_start\_replication\_until](mysql-stored-proc-replicating.md#mysql_rds_start_replication_until) stored procedure and the replication is in progress\. -+ ****replication stop point reached** \(MySQL only\)** – A customer\-initiated stop point was set using the [mysql\.rds\_start\_replication\_until](mysql-stored-proc-replicating.md#mysql_rds_start_replication_until) stored procedure and replication is stopped because the stop point was reached\. - -You can see where a DB instance is being replicated and if so, check its replication status\. On the **Databases** page in the RDS console, it shows **Primary** in the **Role** column\. Choose its DB instance name\. On its detail page, on the **Connectivity & security** tab, its replication status is under **Replication**\. - -### Monitoring replication lag - -You can monitor replication lag in Amazon CloudWatch by viewing the Amazon RDS `ReplicaLag` metric\. - -For MariaDB and MySQL, the `ReplicaLag` metric reports the value of the `Seconds_Behind_Master` field of the `SHOW REPLICA STATUS` command\. Common causes for replication lag for MySQL and MariaDB are the following: -+ A network outage\. -+ Writing to tables with indexes on a read replica\. If the `read_only` parameter is not set to 0 on the read replica, it can break replication\. -+ Using a nontransactional storage engine such as MyISAM\. Replication is only supported for the InnoDB storage engine on MySQL and the XtraDB storage engine on MariaDB\. - -**Note** -Previous versions of MariaDB and MySQL used `SHOW SLAVE STATUS` instead of `SHOW REPLICA STATUS`\. If you are using a MariaDB version before 10\.5 or a MySQL version before 8\.0\.23, then use `SHOW SLAVE STATUS`\. - -When the `ReplicaLag` metric reaches 0, the replica has caught up to the primary DB instance\. If the `ReplicaLag` metric returns `-1`, then replication is currently not active\. `ReplicaLag = -1` is equivalent to `Seconds_Behind_Master = NULL`\. - -For Oracle, the `ReplicaLag` metric is the sum of the `Apply Lag` value and the difference between the current time and the apply lag's `DATUM_TIME` value\. The `DATUM_TIME` value is the last time the read replica received data from its source DB instance\. For more information, see [ V$DATAGUARD\_STATS](https://docs.oracle.com/database/121/REFRN/GUID-B346DD88-3F5E-4F16-9DEE-2FDE62B1ABF7.htm#REFRN30413) in the Oracle documentation\. - -For SQL Server, the `ReplicaLag` metric is the maximum lag of databases that have fallen behind, in seconds\. For example, if you have two databases that lag 5 seconds and 10 seconds, respectively, then `ReplicaLag` is 10 seconds\. The `ReplicaLag` metric returns the value of the following query\. - -``` -SELECT MAX(secondary_lag_seconds) max_lag FROM sys.dm_hadr_database_replica_states; -``` - -For more information, see [secondary\_lag\_seconds](https://docs.microsoft.com/en-us/sql/relational-databases/system-dynamic-management-views/sys-dm-hadr-database-replica-states-transact-sql) in the Microsoft documentation\. - -`ReplicaLag` returns `-1` if RDS can't determine the lag, such as during replica setup, or when the read replica is in the `error` state\. - -**Note** -New databases aren't included in the lag calculation until they are accessible on the read replica\. - -For PostgreSQL, the `ReplicaLag` metric returns the value of the following query\. - -``` -SELECT extract(epoch from now() - pg_last_xact_replay_timestamp()) AS reader_lag -``` - -PostgreSQL versions 9\.5\.2 and later use physical replication slots to manage write ahead log \(WAL\) retention on the source instance\. For each cross\-Region read replica instance, Amazon RDS creates a physical replication slot and associates it with the instance\. Two Amazon CloudWatch metrics, `Oldest Replication Slot Lag` and `Transaction Logs Disk Usage`, show how far behind the most lagging replica is in terms of WAL data received and how much storage is being used for WAL data\. The `Transaction Logs Disk Usage` value can substantially increase when a cross\-Region read replica is lagging significantly\. - -For more information about monitoring a DB instance with CloudWatch, see [Monitoring Amazon RDS metrics with Amazon CloudWatch](monitoring-cloudwatch.md)\. - -## Creating a read replica in a different AWS Region - -With Amazon RDS, you can create a read replica in a different AWS Region from the source DB instance\. - -![\[Cross-Region read replica configuration\]](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/images/read-replica-cross-region.png) - -You create a read replica in a different AWS Region to do the following: -+ Improve your disaster recovery capabilities\. -+ Scale read operations into an AWS Region closer to your users\. -+ Make it easier to migrate from a data center in one AWS Region to a data center in another AWS Region\. - -Creating a read replica in a different AWS Region from the source instance is similar to creating a replica in the same AWS Region\. You can use the AWS Management Console, run the [https://docs.aws.amazon.com/cli/latest/reference/rds/create-db-instance-read-replica.html](https://docs.aws.amazon.com/cli/latest/reference/rds/create-db-instance-read-replica.html) command, or call the [https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_CreateDBInstanceReadReplica.html](https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_CreateDBInstanceReadReplica.html) API operation\. - -**Note** -To create an encrypted read replica in a different AWS Region from the source DB instance, the source DB instance must be encrypted\. - -### Region and version availability - -Feature availability and support varies across specific versions of each database engine, and across AWS Regions\. For more information on version and Region availability with cross\-Region replication, see [Cross\-Region read replicas](Concepts.RDS_Fea_Regions_DB-eng.Feature.CrossRegionReadReplicas.md)\. - -### Creating a cross\-Region read replica - -The following procedures show how to create a read replica from a source MariaDB, Microsoft SQL Server, MySQL, Oracle, or PostgreSQL DB instance in a different AWS Region\. - -#### Console - -You can create a read replica across AWS Regions using the AWS Management Console\. - -**To create a read replica across AWS Regions with the console** - -1. Sign in to the AWS Management Console and open the Amazon RDS console at [https://console\.aws\.amazon\.com/rds/](https://console.aws.amazon.com/rds/)\. - -1. In the navigation pane, choose **Databases**\. - -1. Choose the MariaDB, Microsoft SQL Server, MySQL, Oracle, or PostgreSQL DB instance that you want to use as the source for a read replica\. - -1. For **Actions**, choose **Create read replica**\. - -1. For **DB instance identifier**, enter a name for the read replica\. - -1. Choose the **Destination Region\.** - -1. Choose the instance specifications that you want to use\. We recommend that you use the same or larger DB instance class and storage type for the read replica\. - -1. To create an encrypted read replica in another AWS Region: - - 1. Choose **Enable encryption**\. - - 1. For **AWS KMS key**, choose the AWS KMS key identifier of the KMS key in the destination AWS Region\. -**Note** - To create an encrypted read replica, the source DB instance must be encrypted\. To learn more about encrypting the source DB instance, see [Encrypting Amazon RDS resources](Overview.Encryption.md)\. - -1. Choose other options, such as storage autoscaling\. - -1. Choose **Create read replica**\. - -#### AWS CLI - - To create a read replica from a source MySQL, Microsoft SQL Server, MariaDB, Oracle, or PostgreSQL DB instance in a different AWS Region, you can use the [https://docs.aws.amazon.com/cli/latest/reference/rds/create-db-instance-read-replica.html](https://docs.aws.amazon.com/cli/latest/reference/rds/create-db-instance-read-replica.html) command\. In this case, you use [https://docs.aws.amazon.com/cli/latest/reference/rds/create-db-instance-read-replica.html](https://docs.aws.amazon.com/cli/latest/reference/rds/create-db-instance-read-replica.html) from the AWS Region where you want the read replica \(destination Region\) and specify the Amazon Resource Name \(ARN\) for the source DB instance\. An ARN uniquely identifies a resource created in Amazon Web Services\. - -For example, if your source DB instance is in the US East \(N\. Virginia\) Region, the ARN looks similar to this example: - -``` -arn:aws:rds:us-east-1:123456789012:db:mydbinstance -``` - -For information about ARNs, see [Working with Amazon Resource Names \(ARNs\) in Amazon RDS](USER_Tagging.ARN.md)\. - - To create a read replica in a different AWS Region from the source DB instance, you can use the AWS CLI [https://docs.aws.amazon.com/cli/latest/reference/rds/create-db-instance-read-replica.html](https://docs.aws.amazon.com/cli/latest/reference/rds/create-db-instance-read-replica.html) command from the destination AWS Region\. The following parameters are required for creating a read replica in another AWS Region: -+ `--region` – The destination AWS Region where the read replica is created\. -+ `--source-db-instance-identifier` – The DB instance identifier for the source DB instance\. This identifier must be in the ARN format for the source AWS Region\. -+ `--db-instance-identifier` – The identifier for the read replica in the destination AWS Region\. - -**Example of a cross\-Region read replica** -The following code creates a read replica in the US West \(Oregon\) Region from a source DB instance in the US East \(N\. Virginia\) Region\. -For Linux, macOS, or Unix: - -``` -aws rds create-db-instance-read-replica \ - --db-instance-identifier myreadreplica \ - --region us-west-2 \ - --source-db-instance-identifier arn:aws:rds:us-east-1:123456789012:db:mydbinstance -``` -For Windows: - -``` -aws rds create-db-instance-read-replica ^ - --db-instance-identifier myreadreplica ^ - --region us-west-2 ^ - --source-db-instance-identifier arn:aws:rds:us-east-1:123456789012:db:mydbinstance -``` - -The following parameter is also required for creating an encrypted read replica in another AWS Region: -+ `--kms-key-id` – The AWS KMS key identifier of the KMS key to use to encrypt the read replica in the destination AWS Region\. - -**Example of an encrypted cross\-Region read replica** -The following code creates an encrypted read replica in the US West \(Oregon\) Region from a source DB instance in the US East \(N\. Virginia\) Region\. -For Linux, macOS, or Unix: - -``` -aws rds create-db-instance-read-replica \ - --db-instance-identifier myreadreplica \ - --region us-west-2 \ - --source-db-instance-identifier arn:aws:rds:us-east-1:123456789012:db:mydbinstance \ - --kms-key-id my-us-west-2-key -``` -For Windows: - -``` -aws rds create-db-instance-read-replica ^ - --db-instance-identifier myreadreplica ^ - --region us-west-2 ^ - --source-db-instance-identifier arn:aws:rds:us-east-1:123456789012:db:mydbinstance ^ - --kms-key-id my-us-west-2-key -``` - -The `--source-region` option is required when you're creating an encrypted read replica between the AWS GovCloud \(US\-East\) and AWS GovCloud \(US\-West\) Regions\. For `--source-region`, specify the AWS Region of the source DB instance\. - -If `--source-region` isn't specified, specify a `--pre-signed-url` value\. A *presigned URL* is a URL that contains a Signature Version 4 signed request for the `create-db-instance-read-replica` command that's called in the source AWS Region\. To learn more about the `pre-signed-url` option, see [create\-db\-instance\-read\-replica](https://docs.aws.amazon.com/cli/latest/reference/rds/create-db-instance-read-replica.html) in the *AWS CLI Command Reference*\. - -#### RDS API - -To create a read replica from a source MySQL, Microsoft SQL Server, MariaDB, Oracle, or PostgreSQL DB instance in a different AWS Region, you can call the Amazon RDS API operation [CreateDBInstanceReadReplica](https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_CreateDBInstanceReadReplica.html)\. In this case, you call [CreateDBInstanceReadReplica](https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_CreateDBInstanceReadReplica.html) from the AWS Region where you want the read replica \(destination Region\) and specify the Amazon Resource Name \(ARN\) for the source DB instance\. An ARN uniquely identifies a resource created in Amazon Web Services\. - -To create an encrypted read replica in a different AWS Region from the source DB instance, you can use the Amazon RDS API [https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_CreateDBInstanceReadReplica.html](https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_CreateDBInstanceReadReplica.html) operation from the destination AWS Region\. To create an encrypted read replica in another AWS Region, you must specify a value for `PreSignedURL`\. `PreSignedURL` should contain a request for the [https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_CreateDBInstanceReadReplica.html](https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_CreateDBInstanceReadReplica.html) operation to call in the source AWS Region where the read replica is created in\. To learn more about `PreSignedUrl`, see [https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_CreateDBInstanceReadReplica.html](https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_CreateDBInstanceReadReplica.html)\. - -For example, if your source DB instance is in the US East \(N\. Virginia\) Region, the ARN looks similar to the following\. - -``` -arn:aws:rds:us-east-1:123456789012:db:mydbinstance -``` - -For information about ARNs, see [Working with Amazon Resource Names \(ARNs\) in Amazon RDS](USER_Tagging.ARN.md)\. - -**Example** - -``` -https://us-west-2.rds.amazonaws.com/ - ?Action=CreateDBInstanceReadReplica - &KmsKeyId=my-us-east-1-key - &PreSignedUrl=https%253A%252F%252Frds.us-west-2.amazonaws.com%252F - %253FAction%253DCreateDBInstanceReadReplica - %2526DestinationRegion%253Dus-east-1 - %2526KmsKeyId%253Dmy-us-east-1-key - %2526SourceDBInstanceIdentifier%253Darn%25253Aaws%25253Ards%25253Aus-west-2%123456789012%25253Adb%25253Amydbinstance - %2526SignatureMethod%253DHmacSHA256 - %2526SignatureVersion%253D4%2526SourceDBInstanceIdentifier%253Darn%25253Aaws%25253Ards%25253Aus-west-2%25253A123456789012%25253Ainstance%25253Amydbinstance - %2526Version%253D2014-10-31 - %2526X-Amz-Algorithm%253DAWS4-HMAC-SHA256 - %2526X-Amz-Credential%253DAKIADQKE4SARGYLE%252F20161117%252Fus-west-2%252Frds%252Faws4_request - %2526X-Amz-Date%253D20161117T215409Z - %2526X-Amz-Expires%253D3600 - %2526X-Amz-SignedHeaders%253Dcontent-type%253Bhost%253Buser-agent%253Bx-amz-content-sha256%253Bx-amz-date - %2526X-Amz-Signature%253D255a0f17b4e717d3b67fad163c3ec26573b882c03a65523522cf890a67fca613 - &DBInstanceIdentifier=myreadreplica - &SourceDBInstanceIdentifier=®ion-arn;rds:us-east-1:123456789012:db:mydbinstance - &Version=2012-01-15 - &SignatureVersion=2 - &SignatureMethod=HmacSHA256 - &Timestamp=2012-01-20T22%3A06%3A23.624Z - &AWSAccessKeyId=<&AWS; Access Key ID> - &Signature= -``` - -### How Amazon RDS does cross\-Region replication - -Amazon RDS uses the following process to create a cross\-Region read replica\. Depending on the AWS Regions involved and the amount of data in the databases, this process can take hours to complete\. You can use this information to determine how far the process has proceeded when you create a cross\-Region read replica: - -1. Amazon RDS begins configuring the source DB instance as a replication source and sets the status to *modifying*\. - -1. Amazon RDS begins setting up the specified read replica in the destination AWS Region and sets the status to *creating*\. - -1. Amazon RDS creates an automated DB snapshot of the source DB instance in the source AWS Region\. The format of the DB snapshot name is `rds:-`, where `` is the identifier of the source instance, and `` is the date and time the copy started\. For example, `rds:mysourceinstance-2013-11-14-09-24` was created from the instance `mysourceinstance` at `2013-11-14-09-24`\. During the creation of an automated DB snapshot, the source DB instance status remains *modifying*, the read replica status remains *creating*, and the DB snapshot status is *creating*\. The progress column of the DB snapshot page in the console reports how far the DB snapshot creation has progressed\. When the DB snapshot is complete, the status of both the DB snapshot and source DB instance are set to *available*\. - -1. Amazon RDS begins a cross\-Region snapshot copy for the initial data transfer\. The snapshot copy is listed as an automated snapshot in the destination AWS Region with a status of *creating*\. It has the same name as the source DB snapshot\. The progress column of the DB snapshot display indicates how far the copy has progressed\. When the copy is complete, the status of the DB snapshot copy is set to *available*\. - -1. Amazon RDS then uses the copied DB snapshot for the initial data load on the read replica\. During this phase, the read replica is in the list of DB instances in the destination, with a status of *creating*\. When the load is complete, the read replica status is set to *available*, and the DB snapshot copy is deleted\. - -1. When the read replica reaches the available status, Amazon RDS starts by replicating the changes made to the source instance since the start of the create read replica operation\. During this phase, the replication lag time for the read replica is greater than 0\. - - For information about replication lag time, see [Monitoring read replication](#USER_ReadRepl.Monitoring)\. - -### Cross\-Region replication considerations - -All of the considerations for performing replication within an AWS Region apply to cross\-Region replication\. The following extra considerations apply when replicating between AWS Regions: -+ A source DB instance can have cross\-Region read replicas in multiple AWS Regions\. -+ You can replicate between the GovCloud \(US\-East\) and GovCloud \(US\-West\) Regions, but not into or out of GovCloud \(US\)\. -+ For Microsoft SQL Server, Oracle, and PostgreSQL DB instances, you can only create a cross\-Region Amazon RDS read replica from a source Amazon RDS DB instance that is not a read replica of another Amazon RDS DB instance\. This limitation doesn't apply to MariaDB and MySQL DB instances\. -+ You can expect to see a higher level of lag time for any read replica that is in a different AWS Region than the source instance\. This lag time comes from the longer network channels between regional data centers\. -+ For cross\-Region read replicas, any of the create read replica commands that specify the `--db-subnet-group-name` parameter must specify a DB subnet group from the same VPC\. -+ Due to the limit on the number of access control list \(ACL\) entries for a VPC, we can't guarantee more than five cross\-Region read replica instances\. -+ In most cases, the read replica uses the default DB parameter group and DB option group for the specified DB engine\. - - For the MySQL and Oracle DB engines, you can specify a custom parameter group for the read replica in the `--db-parameter-group-name` option of the AWS CLI command [https://docs.aws.amazon.com/cli/latest/reference/rds/create-db-instance-read-replica.html](https://docs.aws.amazon.com/cli/latest/reference/rds/create-db-instance-read-replica.html)\. You can't specify a custom parameter group when you use the AWS Management Console\. -+ The read replica uses the default security group\. -+ For MariaDB, Microsoft SQL Server, MySQL, and Oracle DB instances, when the source DB instance for a cross\-Region read replica is deleted, the read replica is promoted\. -+ For PostgreSQL DB instances, when the source DB instance for a cross\-Region read replica is deleted, the replication status of the read replica is set to `terminated`\. The read replica isn't promoted\. - - You have to promote the read replica manually or delete it\. - -#### Requesting a cross\-Region read replica - -To communicate with the source Region to request the creation of a cross\-Region read replica, the requester \(IAM role or IAM user\) must have access to the source DB instance and the source Region\. - -Certain conditions in the requester's IAM policy can cause the request to fail\. The following examples assume that the source DB instance is in US East \(Ohio\) and the read replica is created in US East \(N\. Virginia\)\. These examples show conditions in the requester's IAM policy that cause the request to fail: -+ The requester's policy has a condition for `aws:RequestedRegion`\. - - ``` - ... - "Effect": "Allow", - "Action": "rds:CreateDBInstanceReadReplica", - "Resource": "*", - "Condition": { - "StringEquals": { - "aws:RequestedRegion": "us-east-1" - } - } - ``` - - The request fails because the policy doesn't allow access to the source Region\. For a successful request, specify both the source and destination Regions\. - - ``` - ... - "Effect": "Allow", - "Action": "rds:CreateDBInstanceReadReplica", - "Resource": "*", - "Condition": { - "StringEquals": { - "aws:RequestedRegion": [ - "us-east-1", - "us-east-2" - ] - } - } - ``` -+ The requester's policy doesn't allow access to the source DB instance\. - - ``` - ... - "Effect": "Allow", - "Action": "rds:CreateDBInstanceReadReplica", - "Resource": "arn:aws:rds:us-east-1:123456789012:db:myreadreplica" - ... - ``` - - For a successful request, specify both the source instance and the replica\. - - ``` - ... - "Effect": "Allow", - "Action": "rds:CreateDBInstanceReadReplica", - "Resource": [ - "arn:aws:rds:us-east-1:123456789012:db:myreadreplica", - "arn:aws:rds:us-east-2:123456789012:db:mydbinstance" - ] - ... - ``` -+ The requester's policy denies `aws:ViaAWSService`\. - - ``` - ... - "Effect": "Allow", - "Action": "rds:CreateDBInstanceReadReplica", - "Resource": "*", - "Condition": { - "Bool": {"aws:ViaAWSService": "false"} - } - ``` - - Communication with the source Region is made by RDS on the requester's behalf\. For a successful request, don't deny calls made by AWS services\. -+ The requester's policy has a condition for `aws:SourceVpc` or `aws:SourceVpce`\. - - These requests might fail because when RDS makes the call to the remote Region, it isn't from the specified VPC or VPC endpoint\. - -If you need to use one of the previous conditions that would cause a request to fail, you can include a second statement with `aws:CalledVia` in your policy to make the request succeed\. For example, you can use `aws:CalledVia` with `aws:SourceVpce` as shown here: - -``` -... -"Effect": "Allow", -"Action": "rds:CreateDBInstanceReadReplica", -"Resource": "*", -"Condition": { - "Condition" : { - "ForAnyValue:StringEquals" : { - "aws:SourceVpce": "vpce-1a2b3c4d" - } - } -}, -{ - "Effect": "Allow", - "Action": [ - "rds:CreateDBInstanceReadReplica" - ], - "Resource": "*", - "Condition": { - "ForAnyValue:StringEquals": { - "aws:CalledVia": [ - "rds.amazonaws.com" - ] - } - } -} -``` - -For more information, see [Policies and permissions in IAM](https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies.html) in the *IAM User Guide*\. - -#### Authorizing the read replica - -After a cross\-Region DB read replica creation request returns `success`, RDS starts the replica creation in the background\. An authorization for RDS to access the source DB instance is created\. This authorization links the source DB instance to the read replica, and allows RDS to copy only to the specified read replica\. - - The authorization is verified by RDS using the `rds:CrossRegionCommunication` permission in the service\-linked IAM role\. If the replica is authorized, RDS communicates with the source Region and completes the replica creation\. - - RDS doesn't have access to DB instances that weren't authorized previously by a `CreateDBInstanceReadReplica` request\. The authorization is revoked when read replica creation completes\. - - RDS uses the service\-linked role to verify the authorization in the source Region\. If you delete the service\-linked role during the replication creation process, the creation fails\. - -For more information, see [Using service\-linked roles](https://docs.aws.amazon.com/IAM/latest/UserGuide/using-service-linked-roles.html) in the *IAM User Guide*\. - -#### Using AWS Security Token Service credentials - -Session tokens from the global AWS Security Token Service \(AWS STS\) endpoint are valid only in AWS Regions that are enabled by default \(commercial Regions\)\. If you use credentials from the `assumeRole` API operation in AWS STS, use the regional endpoint if the source Region is an opt\-in Region\. Otherwise, the request fails\. This happens because your credentials must be valid in both Regions, which is true for opt\-in Regions only when the regional AWS STS endpoint is used\. - -To use the global endpoint, make sure that it's enabled for both Regions in the operations\. Set the global endpoint to `Valid in all AWS Regions` in the AWS STS account settings\. - - The same rule applies to credentials in the presigned URL parameter\. - -For more information, see [Managing AWS STS in an AWS Region](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp_enable-regions.html) in the *IAM User Guide*\. - -### Cross\-Region replication costs - -The data transferred for cross\-Region replication incurs Amazon RDS data transfer charges\. These cross\-Region replication actions generate charges for the data transferred out of the source AWS Region: -+ When you create a read replica, Amazon RDS takes a snapshot of the source instance and transfers the snapshot to the read replica AWS Region\. -+ For each data modification made in the source databases, Amazon RDS transfers data from the source AWS Region to the read replica AWS Region\. - -For more information about data transfer pricing, see [Amazon RDS pricing](https://aws.amazon.com/rds/pricing/)\. - -For MySQL and MariaDB instances, you can reduce your data transfer costs by reducing the number of cross\-Region read replicas that you create\. For example, suppose that you have a source DB instance in one AWS Region and want to have three read replicas in another AWS Region\. In this case, you create only one of the read replicas from the source DB instance\. You create the other two replicas from the first read replica instead of the source DB instance\. - -For example, if you have `source-instance-1` in one AWS Region, you can do the following: -+ Create `read-replica-1` in the new AWS Region, specifying `source-instance-1` as the source\. -+ Create `read-replica-2` from `read-replica-1`\. -+ Create `read-replica-3` from `read-replica-1`\. - -In this example, you are only charged for the data transferred from `source-instance-1` to `read-replica-1`\. You aren't charged for the data transferred from `read-replica-1` to the other two replicas because they are all in the same AWS Region\. If you create all three replicas directly from `source-instance-1`, you are charged for the data transfers to all three replicas\. \ No newline at end of file diff --git a/doc_source/USER_RebootInstance.md b/doc_source/USER_RebootInstance.md deleted file mode 100644 index 2845f1f..0000000 --- a/doc_source/USER_RebootInstance.md +++ /dev/null @@ -1,81 +0,0 @@ -# Rebooting a DB instance - -You might need to reboot your DB instance, usually for maintenance reasons\. For example, if you make certain modifications, or if you change the DB parameter group associated with the DB instance, you must reboot the instance for the changes to take effect\. - -**Note** -If a DB instance isn't using the latest changes to its associated DB parameter group, the AWS Management Console shows the DB parameter group with a status of **pending\-reboot**\. The **pending\-reboot** parameter groups status doesn't result in an automatic reboot during the next maintenance window\. To apply the latest parameter changes to that DB instance, manually reboot the DB instance\. For more information about parameter groups, see [Working with parameter groups](USER_WorkingWithParamGroups.md)\. - -If the Amazon RDS DB instance is configured for Multi\-AZ, you can perform the reboot with a failover\. An Amazon RDS event is created when the reboot is completed\. If your DB instance is a Multi\-AZ deployment, you can force a failover from one Availability Zone \(AZ\) to another when you reboot\. When you force a failover of your DB instance, Amazon RDS automatically switches to a standby replica in another Availability Zone, and updates the DNS record for the DB instance to point to the standby DB instance\. As a result, you need to clean up and re\-establish any existing connections to your DB instance\. Rebooting with failover is beneficial when you want to simulate a failure of a DB instance for testing, or restore operations to the original AZ after a failover occurs\. For more information, see [Configuring and managing a Multi\-AZ deployment](Concepts.MultiAZ.md)\. - -**Warning** -When you force a failover of your DB instance, the database is abruptly interrupted\. The DB instance and its client sessions might not have time to shut down gracefully\. To avoid the possibility of data loss, we recommend stopping transactions on your DB instance before rebooting with a failover\. - -On RDS for Microsoft SQL Server, reboot with failover reboots only the primary DB instance\. After the failover, the primary DB instance becomes the new secondary DB instance\. Parameters might not be updated for Multi\-AZ instances\. For reboot without failover, both the primary and secondary DB instances reboot, and parameters are updated after the reboot\. If the DB instance is unresponsive, we recommend reboot without failover\. - -**Note** -When you force a failover from one Availability Zone to another when you reboot, the Availability Zone change might not be reflected in the AWS Management Console, and in calls to the AWS CLI and RDS API, for several minutes\. - -Rebooting a DB instance restarts the database engine service\. Rebooting a DB instance results in a momentary outage, during which the DB instance status is set to *rebooting*\. An outage occurs for both a Single\-AZ deployment and a Multi\-AZ DB instance deployment, even when you reboot with a failover\. - -You can't reboot your DB instance if it isn't in the `available` state\. Your database can be unavailable for several reasons, such as an in\-progress backup, a previously requested modification, or a maintenance\-window action\. - -The time required to reboot your DB instance depends on the crash recovery process, database activity at the time of reboot, and the behavior of your specific DB engine\. To improve the reboot time, we recommend that you reduce database activity as much as possible during the reboot process\. Reducing database activity reduces rollback activity for in\-transit transactions\. - -For a DB instance with read replicas, you can reboot the source DB instance and its read replicas independently\. After a reboot completes, replication resumes automatically\. - -## Console - -**To reboot a DB instance** - -1. Sign in to the AWS Management Console and open the Amazon RDS console at [https://console\.aws\.amazon\.com/rds/](https://console.aws.amazon.com/rds/)\. - -1. In the navigation pane, choose **Databases**, and then choose the DB instance that you want to reboot\. - -1. For **Actions**, choose **Reboot**\. - - The **Reboot DB Instance** page appears\. - -1. \(Optional\) Choose **Reboot with failover?** to force a failover from one AZ to another\. - -1. Choose **Reboot** to reboot your DB instance\. - - Alternatively, choose **Cancel**\. - -## AWS CLI - -To reboot a DB instance by using the AWS CLI, call the [https://docs.aws.amazon.com/cli/latest/reference/rds/reboot-db-instance.html](https://docs.aws.amazon.com/cli/latest/reference/rds/reboot-db-instance.html) command\. - -**Example Simple reboot** -For Linux, macOS, or Unix: - -``` -aws rds reboot-db-instance \ - --db-instance-identifier mydbinstance -``` -For Windows: - -``` -aws rds reboot-db-instance ^ - --db-instance-identifier mydbinstance -``` - -**Example Reboot with failover** -To force a failover from one AZ to the other, use the `--force-failover` parameter\. -For Linux, macOS, or Unix: - -``` -aws rds reboot-db-instance \ - --db-instance-identifier mydbinstance \ - --force-failover -``` -For Windows: - -``` -aws rds reboot-db-instance ^ - --db-instance-identifier mydbinstance ^ - --force-failover -``` - -## RDS API - -To reboot a DB instance by using the Amazon RDS API, call the [https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_RebootDBInstance.html](https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_RebootDBInstance.html) operation\. \ No newline at end of file diff --git a/doc_source/USER_Recommendations.md b/doc_source/USER_Recommendations.md deleted file mode 100644 index 71f897a..0000000 --- a/doc_source/USER_Recommendations.md +++ /dev/null @@ -1,66 +0,0 @@ -# Using Amazon RDS recommendations - -Amazon RDS provides automated recommendations for database resources, such as DB instances, read replicas, and DB parameter groups\. These recommendations provide best practice guidance by analyzing DB instance configuration, usage, and performance data\. - -You can find examples of these recommendations in the following table\. - - -| Type | Description | Recommendation | Additional information | -| --- | --- | --- | --- | -| Engine version outdated | Your DB instance is not running the latest minor engine version\. | We recommend that you upgrade to the latest version because it contains the latest security fixes and other improvements\. | [Upgrading a DB instance engine version](USER_UpgradeDBInstance.Upgrading.md) | -| Pending maintenance available | You have pending maintenance available on your DB instance\. | We recommend that you perform the pending maintenance available on your DB instance\. Updates to the operating system most often occur for security issues and should be done as soon as possible\. | [Maintaining a DB instance](USER_UpgradeDBInstance.Maintenance.md) | -| Automated backups disabled | Your DB instance has automated backups disabled\. | We recommend that you enable automated backups on your DB instance\. Automated backups enable point\-in\-time recovery of your DB instance\. You receive backup storage up to the storage size of your DB instance at no additional charge\. | [Working with backups](USER_WorkingWithAutomatedBackups.md) | -| Magnetic volumes in use | Your DB instance is using magnetic storage\. | Magnetic storage is not recommended for most DB instances\. We recommend switching to General Purpose \(SSD\) storage or provisioned IOPS storage\. | [Amazon RDS DB instance storage](CHAP_Storage.md) | -| EC2\-Classic platform in use | Your DB instance is using the legacy EC2\-Classic platform\. | We recommend moving your DB instance to the EC2\-VPC platform for better network access control\. Amazon VPC provides a virtual network that is logically isolated from other virtual networks in the AWS Cloud\. | [Determining whether you are using the EC2\-VPC or EC2\-Classic platform](USER_VPC.FindDefaultVPC.md) | -| Enhanced Monitoring disabled | Your DB instance doesn't have Enhanced Monitoring enabled\. | We recommend enabling Enhanced Monitoring\. Enhanced Monitoring provides real\-time operating system metrics for monitoring and troubleshooting\. | [Using Enhanced Monitoring](USER_Monitoring.OS.md) | -| Encryption disabled | Your DB instance doesn't have encryption enabled\. | We recommend enabling encryption\. You can encrypt your existing Amazon RDS DB instances by restoring from an encrypted snapshot\. | [Encrypting Amazon RDS resources](Overview.Encryption.md) | -| Previous generation DB instance class in use | Your DB instance is running on a previous\-generation DB instance class\. | Previous\-generation DB instance classes have been replaced by DB instance classes with better price, better performance, or both\. We recommend running your DB instance on a later generation DB instance class\. | [DB instance classes](Concepts.DBInstanceClass.md) | -| Huge pages not used for an Oracle DB instance | The `use_large_pages` parameter is not set to `ONLY` in the DB parameter group used by your DB instance\. | For increased database scalability, we recommend setting `use_large_pages` to `ONLY` in the DB parameter group used by your DB instance\. | [Enabling HugePages for an Oracle DB instance](Appendix.Oracle.CommonDBATasks.Misc.md#Oracle.Concepts.HugePages) | -| Nondefault custom memory parameters | Your DB parameter group sets memory parameters that diverge too much from the default values\. | Settings that diverge too much from the default values can cause poor performance and errors\. We recommend setting custom memory parameters to their default values in the DB parameter group used by the DB instance\. | [Working with DB parameter groups](USER_WorkingWithParamGroups.md) | -| Change buffering enabled for a MySQL DB instance | Your DB parameter group has change buffering enabled\. | Change buffering allows a MySQL DB instance to defer some writes necessary to maintain secondary indexes\. This configuration can improve performance slightly, but it can create a large delay in crash recovery\. During crash recovery, the secondary index must be brought up to date\. So, the benefits of change buffering are outweighed by the potentially very long crash recovery events\. We recommend disabling change buffering\. | [ Best practices for configuring parameters for Amazon RDS for MySQL, part 1: Parameters related to performance](https://aws.amazon.com/blogs/database/best-practices-for-configuring-parameters-for-amazon-rds-for-mysql-part-1-parameters-related-to-performance/) on the AWS Database Blog | -| Query cache enabled for a MySQL DB instance | Your DB parameter group has query cache parameter enabled\. | The query cache can cause the DB instance to appear to stall when changes require the cache to be purged\. Most workloads don't benefit from a query cache\. The query cache was removed from MySQL version 8\.0\. We recommend that you disable the query cache parameter\. | [ Best practices for configuring parameters for Amazon RDS for MySQL, part 1: Parameters related to performance](https://aws.amazon.com/blogs/database/best-practices-for-configuring-parameters-for-amazon-rds-for-mysql-part-1-parameters-related-to-performance/) on the AWS Database Blog | -| Logging to table | Your DB parameter group sets logging output to `TABLE`\. | Setting logging output to `TABLE` uses more storage than setting this parameter to `FILE`\. To avoid reaching the storage limit, we recommend setting the logging output parameter to `FILE`\. | [MySQL database log files](USER_LogAccess.Concepts.MySQL.md) | - -Amazon RDS generates recommendations for a resource when the resource is created or modified\. Amazon RDS also periodically scans your resources and generates recommendations\. - -## Responding to Amazon RDS recommendations - -You can find recommendations in the AWS Management Console\. You can perform the recommended action immediately, schedule it for the next maintenance window, or dismiss it\. - -**To respond to Amazon RDS recommendations** - -1. Sign in to the AWS Management Console and open the Amazon RDS console at [https://console\.aws\.amazon\.com/rds/](https://console.aws.amazon.com/rds/)\. - -1. In the navigation pane, choose **Recommendations**\. -![\[Select Recommendations in the console\]](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/images/recommendations-select.png) - - The Recommendations page appears\. -![\[Main Recommendations page in the console\]](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/images/recommendations-main.png) - -1. On the **Recommendations** page, choose one of the following: - + **Active** – Shows the current recommendations that you can apply, dismiss, or schedule\. - + **Dismissed** – Shows the recommendations that have been dismissed\. When you choose **Dismissed**, you can apply these dismissed recommendations\. - + **Scheduled** – Shows the recommendations that are scheduled but not yet applied\. These recommendations will be applied in the next scheduled maintenance window\. - + **Applied** – Shows the recommendations that are currently applied\. - - From any list of recommendations, you can open a section to view the recommendations in that section\. -![\[Take action on recommendations in the console\]](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/images/recommendations-active.png) - - To configure preferences for displaying recommendations in each section, choose the **Preferences** icon\. -![\[Preferences icon for Recommendations in the console\]](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/images/recommendations-preferences.png) - - From the **Preferences** window that appears, you can set display options\. These options include the visible columns and the number of recommendations to display on the page\. - -1. Manage your active recommendations: - - 1. Choose **Active** and open one or more sections to view the recommendations in them\. - - 1. Choose one or more recommendations and choose **Apply now** \(to apply them immediately\), **Schedule** \(to apply them in next maintenance window\), or **Dismiss**\. - - If the **Apply now** button appears for a recommendation but is unavailable \(grayed out\), the DB instance is not available\. You can apply recommendations immediately only if the DB instance status is **available**\. For example, you can't apply recommendations immediately to the DB instance if its status is **modifying**\. In this case, wait for the DB instance to be available and then apply the recommendation\. - - If the **Apply now** button doesn't appear for a recommendation, you can't apply the recommendation using the **Recommendations** page\. You can modify the DB instance to apply the recommendation manually\. - - For more information about modifying a DB instance, see [Modifying an Amazon RDS DB instance](Overview.DBInstance.Modifying.md)\. -**Note** -When you choose **Apply now**, a brief DB instance outage might result\. \ No newline at end of file diff --git a/doc_source/USER_RenameInstance.md b/doc_source/USER_RenameInstance.md deleted file mode 100644 index 5058c2f..0000000 --- a/doc_source/USER_RenameInstance.md +++ /dev/null @@ -1,80 +0,0 @@ -# Renaming a DB instance - - You can rename a DB instance by using the AWS Management Console, the AWS CLI `modify-db-instance` command, or the Amazon RDS API `ModifyDBInstance` action\. Renaming a DB instance can have far\-reaching effects\. The following is a list of considerations before you rename a DB instance\. -+ When you rename a DB instance, the endpoint for the DB instance changes, because the URL includes the name you assigned to the DB instance\. You should always redirect traffic from the old URL to the new one\. -+ When you rename a DB instance, the old DNS name that was used by the DB instance is immediately deleted, although it could remain cached for a few minutes\. The new DNS name for the renamed DB instance becomes effective in about 10 minutes\. The renamed DB instance is not available until the new name becomes effective\. -+ You cannot use an existing DB instance name when renaming an instance\. -+ All read replicas associated with a DB instance remain associated with that instance after it is renamed\. For example, suppose you have a DB instance that serves your production database and the instance has several associated read replicas\. If you rename the DB instance and then replace it in the production environment with a DB snapshot, the DB instance that you renamed will still have the read replicas associated with it\. -+ Metrics and events associated with the name of a DB instance are maintained if you reuse a DB instance name\. For example, if you promote a read replica and rename it to be the name of the previous primary DB instance, the events and metrics associated with the primary DB instance are associated with the renamed instance\. -+ DB instance tags remain with the DB instance, regardless of renaming\. -+ DB snapshots are retained for a renamed DB instance\. - -**Note** -A DB instance is an isolated database environment running in the cloud\. A DB instance can host multiple databases, or a single Oracle database with multiple schemas\. For information about changing a database name, see the documentation for your DB engine\. - -## Renaming to replace an existing DB instance - -The most common reasons for renaming a DB instance are that you are promoting a read replica or you are restoring data from a DB snapshot or point\-in\-time recovery \(PITR\)\. By renaming the database, you can replace the DB instance without having to change any application code that references the DB instance\. In these cases, you would do the following: - -1. Stop all traffic going to the primary DB instance\. This can involve redirecting traffic from accessing the databases on the DB instance or some other way you want to use to prevent traffic from accessing your databases on the DB instance\. - -1. Rename the primary DB instance to a name that indicates it is no longer the primary DB instance as described later in this topic\. - -1. Create a new primary DB instance by restoring from a DB snapshot or by promoting a read replica, and then give the new instance the name of the previous primary DB instance\. - -1. Associate any read replicas with the new primary DB instance\. - -If you delete the old primary DB instance, you are responsible for deleting any unwanted DB snapshots of the old primary DB instance\. - -For information about promoting a read replica, see [Promoting a read replica to be a standalone DB instance](USER_ReadRepl.md#USER_ReadRepl.Promote)\. - -**Important** -The DB instance is rebooted when it is renamed\. - -## Console - -**To rename a DB instance** - -1. Sign in to the AWS Management Console and open the Amazon RDS console at [https://console\.aws\.amazon\.com/rds/](https://console.aws.amazon.com/rds/)\. - -1. In the navigation pane, choose **Databases**\. - -1. Choose the DB instance that you want to rename\. - -1. Choose **Modify**\. - -1. In **Settings**, enter a new name for **DB instance identifier**\. - -1. Choose **Continue**\. - -1. To apply the changes immediately, choose **Apply immediately**\. Choosing this option can cause an outage in some cases\. For more information, see [Modifying an Amazon RDS DB instance](Overview.DBInstance.Modifying.md)\. - -1. On the confirmation page, review your changes\. If they are correct, choose **Modify DB Instance** to save your changes\. - - Alternatively, choose **Back** to edit your changes, or choose **Cancel** to cancel your changes\. - -## AWS CLI - -To rename a DB instance, use the AWS CLI command [https://docs.aws.amazon.com/cli/latest/reference/rds/modify-db-instance.html](https://docs.aws.amazon.com/cli/latest/reference/rds/modify-db-instance.html)\. Provide the current `--db-instance-identifier` value and `--new-db-instance-identifier` parameter with the new name of the DB instance\. - -**Example** -For Linux, macOS, or Unix: - -``` -1. aws rds modify-db-instance \ -2. --db-instance-identifier DBInstanceIdentifier \ -3. --new-db-instance-identifier NewDBInstanceIdentifier -``` -For Windows: - -``` -1. aws rds modify-db-instance ^ -2. --db-instance-identifier DBInstanceIdentifier ^ -3. --new-db-instance-identifier NewDBInstanceIdentifier -``` - -## RDS API - -To rename a DB instance, call Amazon RDS API operation [https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_ModifyDBInstance.html](https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_ModifyDBInstance.html) with the following parameters: -+ `DBInstanceIdentifier` — existing name for the instance -+ `NewDBInstanceIdentifier` — new name for the instance \ No newline at end of file diff --git a/doc_source/USER_ReplicateBackups.md b/doc_source/USER_ReplicateBackups.md deleted file mode 100644 index c6810dd..0000000 --- a/doc_source/USER_ReplicateBackups.md +++ /dev/null @@ -1,475 +0,0 @@ -# Replicating automated backups to another AWS Region - -For added disaster recovery capability, you can configure your Amazon RDS database instance to replicate snapshots and transaction logs to a destination AWS Region of your choice\. When backup replication is configured for a DB instance, RDS initiates a cross\-Region copy of all snapshots and transaction logs as soon as they are ready on the DB instance\. - -DB snapshot copy charges apply to the data transfer\. After the DB snapshot is copied, standard charges apply to storage in the destination Region\. For more details, see [RDS Pricing](http://aws.amazon.com/rds/oracle/pricing/)\. - -For an example of using backup replication, see the AWS online tech talk [Managed Disaster Recovery with Amazon RDS for Oracle Cross\-Region Automated Backups](https://pages.awscloud.com/Managed-Disaster-Recovery-with-Amazon-RDS-for-Oracle-Cross-Region-Automated-Backups_2021_0908-DAT_OD.html)\. - -**Topics** -+ [Region and version availability](#USER_ReplicateBackups.RegionVersionAvailability) -+ [Source and destination AWS Region support](#USER_ReplicateBackups.Regions) -+ [Enabling cross\-Region automated backups](#AutomatedBackups.Replicating.Enable) -+ [Finding information about replicated backups](#AutomatedBackups.Replicating.Describe) -+ [Restoring to a specified time from a replicated backup](#AutomatedBackups.PiTR) -+ [Stopping automated backup replication](#AutomatedBackups.StopReplicating) -+ [Deleting replicated backups](#AutomatedBackups.Delete) - -## Region and version availability - -Feature availability and support varies across specific versions of each database engine, and across AWS Regions\. For more information on version and Region availability with cross\-Region automated backups, see [Cross\-Region automated backups](Concepts.RDS_Fea_Regions_DB-eng.Feature.CrossRegionAutomatedBackups.md)\. - -## Source and destination AWS Region support - -Backup replication is supported between the following AWS Regions\. - - -**** - -| Source Region | Destination Regions available | -| --- | --- | -| Asia Pacific \(Mumbai\) | Asia Pacific \(Singapore\) US East \(N\. Virginia\), US East \(Ohio\), US West \(Oregon\) | -| Asia Pacific \(Osaka\) | Asia Pacific \(Tokyo\) | -| Asia Pacific \(Seoul\) | Asia Pacific \(Singapore\), Asia Pacific \(Tokyo\) US East \(N\. Virginia\), US East \(Ohio\), US West \(Oregon\) | -| Asia Pacific \(Singapore\) | Asia Pacific \(Mumbai\), Asia Pacific \(Seoul\), Asia Pacific \(Sydney\), Asia Pacific \(Tokyo\) US East \(N\. Virginia\), US East \(Ohio\), US West \(Oregon\) | -| Asia Pacific \(Sydney\) | Asia Pacific \(Singapore\) US East \(N\. Virginia\), US West \(N\. California\), US West \(Oregon\) | -| Asia Pacific \(Tokyo\) | Asia Pacific \(Osaka\), Asia Pacific \(Seoul\), Asia Pacific \(Singapore\) US East \(N\. Virginia\), US East \(Ohio\), US West \(Oregon\) | -| Canada \(Central\) | Europe \(Ireland\) US East \(N\. Virginia\), US East \(Ohio\), US West \(N\. California\), US West \(Oregon\) | -| China \(Beijing\) | China \(Ningxia\) | -| China \(Ningxia\) | China \(Beijing\) | -| Europe \(Frankfurt\) | Europe \(Ireland\), Europe \(London\), Europe \(Paris\), Europe \(Stockholm\) US East \(N\. Virginia\), US East \(Ohio\), US West \(Oregon\) | -| Europe \(Ireland\) | Canada \(Central\) Europe \(Frankfurt\), Europe \(London\), Europe \(Paris\), Europe \(Stockholm\) US East \(N\. Virginia\), US East \(Ohio\), US West \(N\. California\), US West \(Oregon\) | -| Europe \(London\) | Europe \(Frankfurt\), Europe \(Ireland\), Europe \(Paris\), Europe \(Stockholm\) US East \(N\. Virginia\) | -| Europe \(Paris\) | Europe \(Frankfurt\), Europe \(Ireland\), Europe \(London\), Europe \(Stockholm\) US East \(N\. Virginia\) | -| Europe \(Stockholm\) | Europe \(Frankfurt\), Europe \(Ireland\), Europe \(London\), Europe \(Paris\) US East \(N\. Virginia\) | -| South America \(São Paulo\) | US East \(N\. Virginia\), US East \(Ohio\) | -| AWS GovCloud \(US\-East\) | AWS GovCloud \(US\-West\) | -| AWS GovCloud \(US\-West\) | AWS GovCloud \(US\-East\) | -| US East \(N\. Virginia\) | Asia Pacific \(Mumbai\), Asia Pacific \(Seoul\), Asia Pacific \(Singapore\), Asia Pacific \(Sydney\), Asia Pacific \(Tokyo\) Canada \(Central\) Europe \(Frankfurt\), Europe \(Ireland\), Europe \(London\), Europe \(Paris\), Europe \(Stockholm\) South America \(São Paulo\) US East \(Ohio\), US West \(N\. California\), US West \(Oregon\) | -| US East \(Ohio\) | Asia Pacific \(Mumbai\), Asia Pacific \(Seoul\), Asia Pacific \(Singapore\), Asia Pacific \(Tokyo\) Canada \(Central\) Europe \(Frankfurt\), Europe \(Ireland\) South America \(São Paulo\) US East \(N\. Virginia\), US West \(N\. California\), US West \(Oregon\) | -| US West \(N\. California\) | Asia Pacific \(Sydney\) Canada \(Central\) Europe \(Ireland\) US East \(N\. Virginia\), US East \(Ohio\), US West \(Oregon\) | -| US West \(Oregon\) | Asia Pacific \(Mumbai\), Asia Pacific \(Seoul\), Asia Pacific \(Singapore\), Asia Pacific \(Sydney\), Asia Pacific \(Tokyo\) Canada \(Central\) Europe \(Frankfurt\), Europe \(Ireland\) US East \(N\. Virginia\), US East \(Ohio\), US West \(N\. California\) | - -You can also use the `describe-source-regions` AWS CLI command to find out which AWS Regions can replicate to each other\. For more information, see [Finding information about replicated backups](#AutomatedBackups.Replicating.Describe)\. - -## Enabling cross\-Region automated backups - -You can enable backup replication on new or existing DB instances using the Amazon RDS console\. You can also use the `start-db-instance-automated-backups-replication` AWS CLI command or the `StartDBInstanceAutomatedBackupsReplication` RDS API operation\. You can replicate up to 20 backups to each destination AWS Region for each AWS account\. - -**Note** -To be able to replicate automated backups, make sure to enable them\. For more information, see [Enabling automated backups](USER_WorkingWithAutomatedBackups.md#USER_WorkingWithAutomatedBackups.Enabling)\. - -### Console - -You can enable backup replication for a new or existing DB instance: -+ For a new DB instance, enable it when you launch the instance\. For more information, see [Settings for DB instances](USER_CreateDBInstance.md#USER_CreateDBInstance.Settings)\. -+ For an existing DB instance, use the following procedure\. - -**To enable backup replication for an existing DB instance** - -1. Sign in to the AWS Management Console and open the Amazon RDS console at [https://console\.aws\.amazon\.com/rds/](https://console.aws.amazon.com/rds/)\. - -1. In the navigation pane, choose **Automated backups**\. - -1. On the **Current Region** tab, choose the DB instance for which you want to enable backup replication\. - -1. For **Actions**, choose **Manage cross\-Region replication**\. - -1. Under **Backup replication**, choose **Enable replication to another AWS Region**\. - -1. Choose the **Destination Region**\. - -1. Choose the **Replicated backup retention period**\. - -1. If you've enabled encryption on the source DB instance, choose the **AWS KMS key** for encrypting the backups\. - -1. Choose **Save**\. - -In the source Region, replicated backups are listed on the **Current Region** tab of the **Automated backups** page\. In the destination Region, replicated backups are listed on the **Replicated backups** tab of the **Automated backups** page\. - -### AWS CLI - -Enable backup replication by using the [https://docs.aws.amazon.com/cli/latest/reference/rds/start-db-instance-automated-backups-replication.html](https://docs.aws.amazon.com/cli/latest/reference/rds/start-db-instance-automated-backups-replication.html) AWS CLI command\. - -The following CLI example replicates automated backups from a DB instance in the US West \(Oregon\) Region to the US East \(N\. Virginia\) Region\. It also encrypts the replicated backups, using an AWS KMS key in the destination Region\. - -**To enable backup replication** -+ Run one of the following commands\. - - For Linux, macOS, or Unix: - - ``` - aws rds start-db-instance-automated-backups-replication \ - --region us-east-1 \ - --source-db-instance-arn "arn:aws:rds:us-west-2:123456789012:db:mydatabase" \ - --kms-key-id "arn:aws:kms:us-east-1:123456789012:key/AKIAIOSFODNN7EXAMPLE" \ - --backup-retention-period 7 - ``` - - For Windows: - - ``` - aws rds start-db-instance-automated-backups-replication ^ - --region us-east-1 ^ - --source-db-instance-arn "arn:aws:rds:us-west-2:123456789012:db:mydatabase" ^ - --kms-key-id "arn:aws:kms:us-east-1:123456789012:key/AKIAIOSFODNN7EXAMPLE" ^ - --backup-retention-period 7 - ``` - - The `--source-region` option is required when you encrypt backups between the AWS GovCloud \(US\-East\) and AWS GovCloud \(US\-West\) Regions\. For `--source-region`, specify the AWS Region of the source DB instance\. - - If `--source-region` isn't specified, make sure to specify a `--pre-signed-url` value\. A *presigned URL* is a URL that contains a Signature Version 4 signed request for the `start-db-instance-automated-backups-replication` command that is called in the source AWS Region\. To learn more about the `pre-signed-url` option, see [ start\-db\-instance\-automated\-backups\-replication](https://docs.aws.amazon.com/cli/latest/reference/rds/start-db-instance-automated-backups-replication.html) in the *AWS CLI Command Reference*\. - -### RDS API - -Enable backup replication by using the [https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_StartDBInstanceAutomatedBackupsReplication.html](https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_StartDBInstanceAutomatedBackupsReplication.html) RDS API operation with the following parameters: -+ `Region` -+ `SourceDBInstanceArn` -+ `BackupRetentionPeriod` -+ `KmsKeyId` \(optional\) -+ `PreSignedUrl` \(required if you use `KmsKeyId`\) - -**Note** -If you encrypt the backups, you must also include a presigned URL\. For more information on presigned URLs, see [Authenticating Requests: Using Query Parameters \(AWS Signature Version 4\)](https://docs.aws.amazon.com/AmazonS3/latest/API/sigv4-query-string-auth.html) in the *Amazon Simple Storage Service API Reference* and [Signature Version 4 signing process](https://docs.aws.amazon.com/general/latest/gr/signature-version-4.html) in the *AWS General Reference*\. - -## Finding information about replicated backups - -You can use the following CLI commands to find information about replicated backups: -+ [https://docs.aws.amazon.com/cli/latest/reference/rds/describe-source-regions.html](https://docs.aws.amazon.com/cli/latest/reference/rds/describe-source-regions.html) -+ [https://docs.aws.amazon.com/cli/latest/reference/rds/describe-db-instances.html](https://docs.aws.amazon.com/cli/latest/reference/rds/describe-db-instances.html) -+ [https://docs.aws.amazon.com/cli/latest/reference/rds/describe-db-instance-automated-backups.html](https://docs.aws.amazon.com/cli/latest/reference/rds/describe-db-instance-automated-backups.html) - -The following `describe-source-regions` example lists the source AWS Regions from which automated backups can be replicated to the US West \(Oregon\) destination Region\. - -**To show information about source Regions** -+ Run the following command\. - - ``` - aws rds describe-source-regions --region us-west-2 - ``` - -The output shows that backups can be replicated from US East \(N\. Virginia\), but not from US East \(Ohio\) or US West \(N\. California\), into US West \(Oregon\)\. - -``` -{ - "SourceRegions": [ - ... - { - "RegionName": "us-east-1", - "Endpoint": "https://rds.us-east-1.amazonaws.com", - "Status": "available", - "SupportsDBInstanceAutomatedBackupsReplication": true - }, - { - "RegionName": "us-east-2", - "Endpoint": "https://rds.us-east-2.amazonaws.com", - "Status": "available", - "SupportsDBInstanceAutomatedBackupsReplication": false - }, - "RegionName": "us-west-1", - "Endpoint": "https://rds.us-west-1.amazonaws.com", - "Status": "available", - "SupportsDBInstanceAutomatedBackupsReplication": false - } - ] -} -``` - -The following `describe-db-instances` example shows the automated backups for a DB instance\. - -**To show the replicated backups for a DB instance** -+ Run one of the following commands\. - - For Linux, macOS, or Unix: - - ``` - aws rds describe-db-instances \ - --db-instance-identifier mydatabase - ``` - - For Windows: - - ``` - aws rds describe-db-instances ^ - --db-instance-identifier mydatabase - ``` - -The output includes the replicated backups\. - -``` -{ - "DBInstances": [ - { - "StorageEncrypted": false, - "Endpoint": { - "HostedZoneId": "Z1PVIF0B656C1W", - "Port": 1521, - ... - - "BackupRetentionPeriod": 7, - "DBInstanceAutomatedBackupsReplications": [{"DBInstanceAutomatedBackupsArn": "arn:aws:rds:us-east-1:123456789012:auto-backup:ab-L2IJCEXJP7XQ7HOJ4SIEXAMPLE"}] - } - ] -} -``` - -The following `describe-db-instance-automated-backups` example shows the automated backups for a DB instance\. - -**To show automated backups for a DB instance** -+ Run one of the following commands\. - - For Linux, macOS, or Unix: - - ``` - aws rds describe-db-instance-automated-backups \ - --db-instance-identifier mydatabase - ``` - - For Windows: - - ``` - aws rds describe-db-instance-automated-backups ^ - --db-instance-identifier mydatabase - ``` - -The output shows the source DB instance and automated backups in US West \(Oregon\), with backups replicated to US East \(N\. Virginia\)\. - -``` -{ - "DBInstanceAutomatedBackups": [ - { - "DBInstanceArn": "arn:aws:rds:us-west-2:868710585169:db:mydatabase", - "DbiResourceId": "db-L2IJCEXJP7XQ7HOJ4SIEXAMPLE", - "DBInstanceAutomatedBackupsArn": "arn:aws:rds:us-west-2:123456789012:auto-backup:ab-L2IJCEXJP7XQ7HOJ4SIEXAMPLE", - "BackupRetentionPeriod": 7, - "DBInstanceAutomatedBackupsReplications": [{"DBInstanceAutomatedBackupsArn": "arn:aws:rds:us-east-1:123456789012:auto-backup:ab-L2IJCEXJP7XQ7HOJ4SIEXAMPLE"}] - "Region": "us-west-2", - "DBInstanceIdentifier": "mydatabase", - "RestoreWindow": { - "EarliestTime": "2020-10-26T01:09:07Z", - "LatestTime": "2020-10-31T19:09:53Z", - } - ... - } - ] -} -``` - -The following `describe-db-instance-automated-backups` example uses the `--db-instance-automated-backups-arn` option to show the replicated backups in the destination Region\. - -**To show replicated backups** -+ Run one of the following commands\. - - For Linux, macOS, or Unix: - - ``` - aws rds describe-db-instance-automated-backups \ - --db-instance-automated-backups-arn "arn:aws:rds:us-east-1:123456789012:auto-backup:ab-L2IJCEXJP7XQ7HOJ4SIEXAMPLE" - ``` - - For Windows: - - ``` - aws rds describe-db-instance-automated-backups ^ - --db-instance-automated-backups-arn "arn:aws:rds:us-east-1:123456789012:auto-backup:ab-L2IJCEXJP7XQ7HOJ4SIEXAMPLE" - ``` - -The output shows the source DB instance in US West \(Oregon\), with replicated backups in US East \(N\. Virginia\)\. - -``` -{ - "DBInstanceAutomatedBackups": [ - { - "DBInstanceArn": "arn:aws:rds:us-west-2:868710585169:db:mydatabase", - "DbiResourceId": "db-L2IJCEXJP7XQ7HOJ4SIEXAMPLE", - "DBInstanceAutomatedBackupsArn": "arn:aws:rds:us-east-1:123456789012:auto-backup:ab-L2IJCEXJP7XQ7HOJ4SIEXAMPLE", - "Region": "us-west-2", - "DBInstanceIdentifier": "mydatabase", - "RestoreWindow": { - "EarliestTime": "2020-10-26T01:09:07Z", - "LatestTime": "2020-10-31T19:01:23Z" - }, - "AllocatedStorage": 50, - "BackupRetentionPeriod": 7, - "Status": "replicating", - "Port": 1521, - ... - } - ] -} -``` - -## Restoring to a specified time from a replicated backup - -You can restore a DB instance to a specific point in time from a replicated backup using the Amazon RDS console\. You can also use the `restore-db-instance-to-point-in-time` AWS CLI command or the `RestoreDBInstanceToPointInTime` RDS API operation\. - -For general information on point\-in\-time recovery \(PITR\), see [Restoring a DB instance to a specified time](USER_PIT.md)\. - -**Note** -On RDS for SQL Server, option groups aren't copied across AWS Regions when automated backups are replicated\. If you've associated a custom option group with your RDS for SQL Server DB instance, you can re\-create that option group in the destination Region\. Then restore the DB instance in the destination Region and associate the custom option group with it\. For more information, see [Working with option groups](USER_WorkingWithOptionGroups.md)\. - -### Console - -**To restore a DB instance to a specified time from a replicated backup** - -1. Sign in to the AWS Management Console and open the Amazon RDS console at [https://console\.aws\.amazon\.com/rds/](https://console.aws.amazon.com/rds/)\. - -1. Choose the destination Region \(where backups are replicated to\) from the Region selector\. - -1. In the navigation pane, choose **Automated backups**\. - -1. On the **Replicated backups** tab, choose the DB instance that you want to restore\. - -1. For **Actions**, choose **Restore to point in time**\. - -1. Choose **Latest restorable time** to restore to the latest possible time, or choose **Custom** to choose a time\. - - If you chose **Custom**, enter the date and time that you want to restore the instance to\. -**Note** -Times are shown in your local time zone, which is indicated by an offset from Coordinated Universal Time \(UTC\)\. For example, UTC\-5 is Eastern Standard Time/Central Daylight Time\. - -1. For **DB instance identifier**, enter the name of the target restored DB instance\. - -1. \(Optional\) Choose other options as needed, such as enabling autoscaling\. - -1. Choose **Restore to point in time**\. - -### AWS CLI - -Use the [https://docs.aws.amazon.com/cli/latest/reference/rds/restore-db-instance-to-point-in-time.html](https://docs.aws.amazon.com/cli/latest/reference/rds/restore-db-instance-to-point-in-time.html) AWS CLI command to create a new DB instance\. - -**To restore a DB instance to a specified time from a replicated backup** -+ Run one of the following commands\. - - For Linux, macOS, or Unix: - - ``` - 1. aws rds restore-db-instance-to-point-in-time \ - 2. --source-db-instance-automated-backups-arn "arn:aws:rds:us-east-1:123456789012:auto-backup:ab-L2IJCEXJP7XQ7HOJ4SIEXAMPLE" \ - 3. --target-db-instance-identifier mytargetdbinstance \ - 4. --restore-time 2020-10-14T23:45:00.000Z - ``` - - For Windows: - - ``` - 1. aws rds restore-db-instance-to-point-in-time ^ - 2. --source-db-instance-automated-backups-arn "arn:aws:rds:us-east-1:123456789012:auto-backup:ab-L2IJCEXJP7XQ7HOJ4SIEXAMPLE" ^ - 3. --target-db-instance-identifier mytargetdbinstance ^ - 4. --restore-time 2020-10-14T23:45:00.000Z - ``` - -### RDS API - -To restore a DB instance to a specified time, call the [https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_RestoreDBInstanceToPointInTime.html](https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_RestoreDBInstanceToPointInTime.html) Amazon RDS API operation with the following parameters: -+ `SourceDBInstanceAutomatedBackupsArn` -+ `TargetDBInstanceIdentifier` -+ `RestoreTime` - -## Stopping automated backup replication - -You can stop backup replication for DB instances using the Amazon RDS console\. You can also use the `stop-db-instance-automated-backups-replication` AWS CLI command or the `StopDBInstanceAutomatedBackupsReplication` RDS API operation\. - -Replicated backups are retained, subject to the backup retention period set when they were created\. - -### Console - -Stop backup replication from the **Automated backups** page in the source Region\. - -**To stop backup replication to an AWS Region** - -1. Sign in to the AWS Management Console and open the Amazon RDS console at [https://console\.aws\.amazon\.com/rds/](https://console.aws.amazon.com/rds/)\. - -1. Choose the source Region from the **Region selector**\. - -1. In the navigation pane, choose **Automated backups**\. - -1. On the **Current Region** tab, choose the DB instance for which you want to stop backup replication\. - -1. For **Actions**, choose **Manage cross\-Region replication**\. - -1. Under **Backup replication**, clear the **Enable replication to another AWS Region** check box\. - -1. Choose **Save**\. - -Replicated backups are listed on the **Retained** tab of the **Automated backups** page in the destination Region\. - -### AWS CLI - -Stop backup replication by using the [https://docs.aws.amazon.com/cli/latest/reference/rds/stop-db-instance-automated-backups-replication.html](https://docs.aws.amazon.com/cli/latest/reference/rds/stop-db-instance-automated-backups-replication.html) AWS CLI command\. - -The following CLI example stops automated backups of a DB instance from replicating in the US West \(Oregon\) Region\. - -**To stop backup replication** -+ Run one of the following commands\. - - For Linux, macOS, or Unix: - - ``` - aws rds stop-db-instance-automated-backups-replication \ - --region us-east-1 \ - --source-db-instance-arn "arn:aws:rds:us-west-2:123456789012:db:mydatabase" - ``` - - For Windows: - - ``` - aws rds stop-db-instance-automated-backups-replication ^ - --region us-east-1 ^ - --source-db-instance-arn "arn:aws:rds:us-west-2:123456789012:db:mydatabase" - ``` - -### RDS API - -Stop backup replication by using the [https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_StopDBInstanceAutomatedBackupsReplication.html](https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_StopDBInstanceAutomatedBackupsReplication.html) RDS API operation with the following parameters: -+ `Region` -+ `SourceDBInstanceArn` - -## Deleting replicated backups - -You can delete replicated backups for DB instances using the Amazon RDS console\. You can also use the `delete-db-instance-automated-backups` AWS CLI command or the `DeleteDBInstanceAutomatedBackup` RDS API operation\. - -### Console - -Delete replicated backups in the destination Region from the **Automated backups** page\. - -**To delete replicated backups** - -1. Sign in to the AWS Management Console and open the Amazon RDS console at [https://console\.aws\.amazon\.com/rds/](https://console.aws.amazon.com/rds/)\. - -1. Choose the destination Region from the **Region selector**\. - -1. In the navigation pane, choose **Automated backups**\. - -1. On the **Replicated backups** tab, choose the DB instance for which you want to delete the replicated backups\. - -1. For **Actions**, choose **Delete**\. - -1. On the confirmation page, enter **delete me** and choose **Delete**\. - -### AWS CLI - -Delete replicated backups by using the [https://docs.aws.amazon.com/cli/latest/reference/rds/delete-db-instance-automated-backup.html](https://docs.aws.amazon.com/cli/latest/reference/rds/delete-db-instance-automated-backup.html) AWS CLI command\. - -You can use the [https://docs.aws.amazon.com/cli/latest/reference/rds/describe-db-instances.html](https://docs.aws.amazon.com/cli/latest/reference/rds/describe-db-instances.html) CLI command to find the Amazon Resource Names \(ARNs\) of the replicated backups\. For more information, see [Finding information about replicated backups](#AutomatedBackups.Replicating.Describe)\. - -**To delete replicated backups** -+ Run one of the following commands\. - - For Linux, macOS, or Unix: - - ``` - aws rds delete-db-instance-automated-backup \ - --db-instance-automated-backups-arn "arn:aws:rds:us-east-1:123456789012:auto-backup:ab-L2IJCEXJP7XQ7HOJ4SIEXAMPLE" - ``` - - For Windows: - - ``` - aws rds delete-db-instance-automated-backup ^ - --db-instance-automated-backups-arn "arn:aws:rds:us-east-1:123456789012:auto-backup:ab-L2IJCEXJP7XQ7HOJ4SIEXAMPLE" - ``` - -### RDS API - -Delete replicated backups by using the [https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_DeleteDBInstanceAutomatedBackup.html](https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_DeleteDBInstanceAutomatedBackup.html) RDS API operation with the `DBInstanceAutomatedBackupsArn` parameter\. \ No newline at end of file diff --git a/doc_source/USER_RestoreFromMultiAZDBClusterSnapshot.Restoring.md b/doc_source/USER_RestoreFromMultiAZDBClusterSnapshot.Restoring.md deleted file mode 100644 index d65bfaa..0000000 --- a/doc_source/USER_RestoreFromMultiAZDBClusterSnapshot.Restoring.md +++ /dev/null @@ -1,77 +0,0 @@ -# Restoring from a snapshot to a Multi\-AZ DB cluster - -You can restore a snapshot to a Multi\-AZ DB cluster using the AWS Management Console, the AWS CLI, or the RDS API\. You can restore each of these types of snapshots to a Multi\-AZ DB cluster: -+ A snapshot of a Single\-AZ deployment -+ A snapshot of a Multi\-AZ DB instance deployment with a single DB instance -+ A snapshot of a Multi\-AZ DB cluster - -For information about Multi\-AZ deployments, see [Configuring and managing a Multi\-AZ deployment](Concepts.MultiAZ.md)\. - -**Tip** -You can migrate a Single\-AZ deployment or a Multi\-AZ DB instance deployment to a Multi\-AZ DB cluster deployment by restoring a snapshot\. - -## Console - -**To restore a snapshot to a Multi\-AZ DB cluster** - -1. Sign in to the AWS Management Console and open the Amazon RDS console at [https://console\.aws\.amazon\.com/rds/](https://console.aws.amazon.com/rds/)\. - -1. In the navigation pane, choose **Snapshots**\. - -1. Choose the snapshot that you want to restore from\. - -1. For **Actions**, choose **Restore snapshot**\. - -1. On the **Restore snapshot** page, in **Availability and durability**, choose **Multi\-AZ DB cluster**\. -![\[Multi-AZ DB cluster choice\]](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/images/multi-az-db-cluster-create.png) - -1. For **DB cluster identifier**, enter the name for your restored Multi\-AZ DB cluster\. - -1. For the remaining sections, specify your DB cluster settings\. For information about each setting, see [Settings for creating Multi\-AZ DB clusters](create-multi-az-db-cluster.md#create-multi-az-db-cluster-settings)\. - -1. Choose **Restore DB instance**\. - -## AWS CLI - -To restore a snapshot to a Multi\-AZ DB cluster, use the AWS CLI command [restore\-db\-cluster\-from\-snapshot](https://docs.aws.amazon.com/cli/latest/reference/rds/restore-db-cluster-from-snapshot.html)\. - -In the following example, you restore from a previously created snapshot named `mysnapshot`\. You restore to a new Multi\-AZ DB cluster named `mynewmultiazdbcluster`\. You also specify the DB instance class used by the DB instances in the Multi\-AZ DB cluster\. Specify either `mysql` or `postgres` for the DB engine\. - -For the `--snapshot-identifier` option, you can use either the name or the Amazon Resource Name \(ARN\) to specify a DB cluster snapshot\. However, you can use only the ARN to specify a DB snapshot\. - -For the `--db-cluster-instance-class` option, specify the DB instance class for the new Multi\-AZ DB cluster\. Multi\-AZ DB clusters only support specific DB instance classes, such as the db\.m6gd and db\.r6gd DB instance classes\. For more information about DB instance classes, see [DB instance classes](Concepts.DBInstanceClass.md)\. - -You can also specify other options\. - -**Example** -For Linux, macOS, or Unix: - -``` -1. aws rds restore-db-cluster-from-snapshot \ -2. --db-cluster-identifier mynewmultiazdbcluster \ -3. --snapshot-identifier mysnapshot \ -4. --engine mysql|postgres \ -5. --db-cluster-instance-class db.r6gd.xlarge -``` -For Windows: - -``` -1. aws rds restore-db-cluster-from-snapshot ^ -2. --db-cluster-identifier mynewmultiazdbcluster ^ -3. --snapshot-identifier mysnapshot ^ -4. --engine mysql|postgres ^ -5. --db-cluster-instance-class db.r6gd.xlarge -``` - -After you restore the DB cluster, you can add the Multi\-AZ DB cluster to the security group associated with the DB cluster or DB instance that you used to create the snapshot, if applicable\. Completing this action provides the same functions of the previous DB cluster or DB instance\. - -## RDS API - -To restore a snapshot to a Multi\-AZ DB cluster, call the RDS API operation [RestoreDBClusterFromSnapshot](https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_RestoreDBClusterFromSnapshot.html) with the following parameters: -+ `DBClusterIdentifier` -+ `SnapshotIdentifier` -+ `Engine` - -You can also specify other optional parameters\. - -After you restore the DB cluster, you can add the Multi\-AZ DB cluster to the security group associated with the DB cluster or DB instance that you used to create the snapshot, if applicable\. Completing this action provides the same functions of the previous DB cluster or DB instance\. \ No newline at end of file diff --git a/doc_source/USER_RestoreFromMultiAZDBClusterSnapshot.md b/doc_source/USER_RestoreFromMultiAZDBClusterSnapshot.md deleted file mode 100644 index 87f4396..0000000 --- a/doc_source/USER_RestoreFromMultiAZDBClusterSnapshot.md +++ /dev/null @@ -1,75 +0,0 @@ -# Restoring from a Multi\-AZ DB cluster snapshot to a DB instance - -A *Multi\-AZ DB cluster snapshot* is a storage volume snapshot of your DB cluster, backing up the entire DB cluster and not just individual databases\. You can restore a Multi\-AZ DB cluster snapshot to a Single\-AZ deployment or Multi\-AZ DB instance deployment\. For information about Multi\-AZ deployments, see [Configuring and managing a Multi\-AZ deployment](Concepts.MultiAZ.md)\. - -**Note** -You can also restore a Multi\-AZ DB cluster snapshot to a new Multi\-AZ DB cluster\. For instructions, see [Restoring from a snapshot to a Multi\-AZ DB cluster](USER_RestoreFromMultiAZDBClusterSnapshot.Restoring.md)\. - -Use the AWS Management Console, the AWS CLI, or the RDS API to restore a Multi\-AZ DB cluster snapshot to a Single\-AZ deployment or Multi\-AZ DB instance deployment\. - -## Console - -**To restore a Multi\-AZ DB cluster snapshot to a Single\-AZ deployment or Multi\-AZ DB instance deployment** - -1. Sign in to the AWS Management Console and open the Amazon RDS console at [https://console\.aws\.amazon\.com/rds/](https://console.aws.amazon.com/rds/)\. - -1. In the navigation pane, choose **Snapshots**\. - -1. Choose the Multi\-AZ DB cluster snapshot that you want to restore from\. - -1. For **Actions**, choose **Restore snapshot**\. - -1. On the **Restore snapshot** page, in **Availability and durability**, choose one of the following: - + **Single DB instance** – Restores the snapshot to one DB instance with no standby DB instance\. - + **Multi\-AZ DB instance** – Restores the snapshot to a Multi\-AZ DB instance deployment with one primary DB instance and one standby DB instance\. - -1. For **DB instance identifier**, enter the name for your restored DB instance\. - -1. For the remaining sections, specify your DB instance settings\. For information about each setting, see [Settings for DB instances](USER_CreateDBInstance.md#USER_CreateDBInstance.Settings)\. - -1. Choose **Restore DB instance**\. - -## AWS CLI - -To restore a Multi\-AZ DB cluster snapshot to a DB instance deployment, use the AWS CLI command [restore\-db\-instance\-from\-db\-snapshot](https://docs.aws.amazon.com/cli/latest/reference/rds/restore-db-instance-from-db-snapshot.html)\. - -In the following example, you restore from a previously created Multi\-AZ DB cluster snapshot named `myclustersnapshot`\. You restore to a new Multi\-AZ DB instance deployment with a primary DB instance named `mynewdbinstance`\. For the `--db-cluster-snapshot-identifier` option, specify the name of the Multi\-AZ DB cluster snapshot\. - -For the `--db-instance-class` option, specify the DB instance class for the new DB instance deployment\. For more information about DB instance classes, see [DB instance classes](Concepts.DBInstanceClass.md)\. - -You can also specify other options\. - -**Example** -For Linux, macOS, or Unix: - -``` -1. aws rds restore-db-instance-from-db-snapshot \ -2. --db-instance-identifier mynewdbinstance \ -3. --db-cluster-snapshot-identifier myclustersnapshot \ -4. --engine mysql \ -5. --multi-az \ -6. --db-instance-class db.r6g.xlarge -``` -For Windows: - -``` -1. aws rds restore-db-instance-from-db-snapshot ^ -2. --db-instance-identifier mynewdbinstance ^ -3. --db-cluster-snapshot-identifier myclustersnapshot ^ -4. --engine mysql ^ -5. --multi-az ^ -6. --db-instance-class db.r6g.xlarge -``` - -After you restore the DB instance, you can add it to the security group associated with the Multi\-AZ DB cluster that you used to create the snapshot, if applicable\. Completing this action provides the same functions of the previous Multi\-AZ DB cluster\. - -## RDS API - -To restore a Multi\-AZ DB cluster snapshot to a DB instance deployment, call the RDS API operation [RestoreDBInstanceFromDBSnapshot](https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_RestoreDBInstanceFromDBSnapshot.html) with the following parameters: -+ `DBInstanceIdentifier` -+ `DBClusterSnapshotIdentifier` -+ `Engine` - -You can also specify other optional parameters\. - -After you restore the DB instance, you can add it to the security group associated with the Multi\-AZ DB cluster that you used to create the snapshot, if applicable\. Completing this action provides the same functions of the previous Multi\-AZ DB cluster\. \ No newline at end of file diff --git a/doc_source/USER_RestoreFromSnapshot.md b/doc_source/USER_RestoreFromSnapshot.md deleted file mode 100644 index fad1b38..0000000 --- a/doc_source/USER_RestoreFromSnapshot.md +++ /dev/null @@ -1,139 +0,0 @@ -# Restoring from a DB snapshot - -Amazon RDS creates a storage volume snapshot of your DB instance, backing up the entire DB instance and not just individual databases\. You can create a new DB instance by restoring from a DB snapshot\. You provide the name of the DB snapshot to restore from, and then provide a name for the new DB instance that is created from the restore\. You can't restore from a DB snapshot to an existing DB instance; a new DB instance is created when you restore\. - -You can use the restored DB instance as soon as its status is `available`\. The DB instance continues to load data in the background\. This is known as *lazy loading*\. - -If you access data that hasn't been loaded yet, the DB instance immediately downloads the requested data from Amazon S3, and then continues loading the rest of the data in the background\. For more information, see [Amazon EBS snapshots](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/EBSSnapshots.html)\. - -To help mitigate the effects of lazy loading on tables to which you require quick access, you can perform operations that involve full\-table scans, such as `SELECT *`\. This allows Amazon RDS to download all of the backed\-up table data from S3\. - -You can restore a DB instance and use a different storage type than the source DB snapshot\. In this case, the restoration process is slower because of the additional work required to migrate the data to the new storage type\. If you restore to or from magnetic storage, the migration process is the slowest\. That's because magnetic storage doesn't have the IOPS capability of Provisioned IOPS or General Purpose \(SSD\) storage\. - -You can use AWS CloudFormation to restore a DB instance from a DB instance snapshot\. For more information, see [AWS::RDS::DBInstance](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbinstance.html) in the *AWS CloudFormation User Guide*\. - -**Note** -You can't restore a DB instance from a DB snapshot that is both shared and encrypted\. Instead, you can make a copy of the DB snapshot and restore the DB instance from the copy\. For more information, see [Copying a DB snapshot](USER_CopySnapshot.md)\. - -## Parameter group considerations - -We recommend that you retain the DB parameter group for any DB snapshots you create, so that you can associate your restored DB instance with the correct parameter group\. - -The default DB parameter group is associated with the restored instance, unless you choose a different one\. No custom parameter settings are available in the default parameter group\. - -You can specify the parameter group when you restore the DB instance\. - -For more information about DB parameter groups, see [Working with parameter groups](USER_WorkingWithParamGroups.md)\. - -## Security group considerations - -When you restore a DB instance, the default virtual private cloud \(VPC\), DB subnet group, and VPC security group are associated with the restored instance, unless you choose different ones\. -+ If you're using the Amazon RDS console, you can specify a custom VPC security group to associate with the instance or create a new VPC security group\. -+ If you're using the AWS CLI, you can specify a custom VPC security group to associate with the instance by including the `--vpc-security-group-ids` option in the `restore-db-instance-from-db-snapshot` command\. -+ If you're using the Amazon RDS API, you can include the `VpcSecurityGroupIds.VpcSecurityGroupId.N` parameter in the `RestoreDBInstanceFromDBSnapshot` action\. - -As soon as the restore is complete and your new DB instance is available, you can also change the VPC settings by modifying the DB instance\. For more information, see [Modifying an Amazon RDS DB instance](Overview.DBInstance.Modifying.md)\. - -## Option group considerations - -When you restore a DB instance, the default DB option group is associated with the restored DB instance in most cases\. - -The exception is when the source DB instance is associated with an option group that contains a persistent or permanent option\. For example, if the source DB instance uses Oracle Transparent Data Encryption \(TDE\), the restored DB instance must use an option group that has the TDE option\. - -If you restore a DB instance into a different VPC, you must do one of the following to assign a DB option group: -+ Assign the default option group for that VPC group to the instance\. -+ Assign another option group that is linked to that VPC\. -+ Create a new option group and assign it to the DB instance\. With persistent or permanent options, such as Oracle TDE, you must create a new option group that includes the persistent or permanent option\. - -For more information about DB option groups, see [Working with option groups](USER_WorkingWithOptionGroups.md)\. - -## Resource tagging considerations - -When you restore a DB instance from a DB snapshot, RDS checks whether you specify new tags\. If yes, the new tags are added to the restored DB instance\. If there are no new tags, RDS adds the tags from the source DB instance at the time of snapshot creation to the restored DB instance\. - -For more information, see [Copying tags to DB instance snapshots](USER_Tagging.md#USER_Tagging.CopyTags)\. - -## Microsoft SQL Server considerations - -When you restore an RDS for Microsoft SQL Server DB snapshot to a new instance, you can always restore to the same edition as your snapshot\. In some cases, you can also change the edition of the DB instance\. The following limitations apply when you change editions: -+ The DB snapshot must have enough storage allocated for the new edition\. -+ Only the following edition changes are supported: - + From Standard Edition to Enterprise Edition - + From Web Edition to Standard Edition or Enterprise Edition - + From Express Edition to Web Edition, Standard Edition, or Enterprise Edition - -If you want to change from one edition to a new edition that isn't supported by restoring a snapshot, you can try using the native backup and restore feature\. SQL Server verifies whether your database is compatible with the new edition based on what SQL Server features you have enabled on the database\. For more information, see [Importing and exporting SQL Server databases using native backup and restore](SQLServer.Procedural.Importing.md)\. - -## Oracle Database considerations - -If you use Oracle GoldenGate, always retain the parameter group with the `compatible` parameter\. When you restore a DB instance from a DB snapshot, specify a parameter group that has a matching or greater `compatible` value\. - -If you restore a snapshot of a CDB instance, you can change the PDB name\. You can't change the CDB name, which is always `RDSCDB`\. This CDB name is the same for all RDS instances that use a single\-tenant architecture\. For more information, see [Backing up and restoring a CDB](oracle-multitenant.md#Oracle.Concepts.single-tenant.snapshots)\. - -Before you restore a DB snapshot, you can upgrade it to a later release\. For more information, see [Upgrading an Oracle DB snapshot](USER_UpgradeDBSnapshot.Oracle.md)\. - -## Restoring from a snapshot - -You can restore a DB instance from a DB snapshot using the AWS Management Console, the AWS CLI, or the RDS API\. - -**Note** -You can't reduce the amount of storage when you restore a DB instance\. When you increase the allocated storage, it must be by at least 10 percent\. If you try to increase the value by less than 10 percent, you get an error\. You can't increase the allocated storage when restoring RDS for SQL Server DB instances\. - -### Console - -**To restore a DB instance from a DB snapshot** - -1. Sign in to the AWS Management Console and open the Amazon RDS console at [https://console\.aws\.amazon\.com/rds/](https://console.aws.amazon.com/rds/)\. - -1. In the navigation pane, choose **Snapshots**\. - -1. Choose the DB snapshot that you want to restore from\. - -1. For **Actions**, choose **Restore snapshot**\. - -1. On the **Restore snapshot** page, for **DB instance identifier**, enter the name for your restored DB instance\. - -1. Specify other settings, such as allocated storage size\. - - For information about each setting, see [Settings for DB instances](USER_CreateDBInstance.md#USER_CreateDBInstance.Settings)\. - -1. Choose **Restore DB instance**\. - -### AWS CLI - -To restore a DB instance from a DB snapshot, use the AWS CLI command [restore\-db\-instance\-from\-db\-snapshot](https://docs.aws.amazon.com/cli/latest/reference/rds/restore-db-instance-from-db-snapshot.html)\. - -In this example, you restore from a previously created DB snapshot named `mydbsnapshot`\. You restore to a new DB instance named `mynewdbinstance`\. This example also sets the allocated storage size\. - -You can specify other settings\. For information about each setting, see [Settings for DB instances](USER_CreateDBInstance.md#USER_CreateDBInstance.Settings)\. - -**Example** -For Linux, macOS, or Unix: - - -``` -1. aws rds restore-db-instance-from-db-snapshot \ -2. --db-instance-identifier mynewdbinstance \ -3. --db-snapshot-identifier mydbsnapshot \ -4. --allocated-storage 100 -``` -For Windows: - - -``` -1. aws rds restore-db-instance-from-db-snapshot ^ -2. --db-instance-identifier mynewdbinstance ^ -3. --db-snapshot-identifier mydbsnapshot ^ -4. --allocated-storage 100 -``` -This command returns output similar to the following: - -``` -1. DBINSTANCE mynewdbinstance db.t3.small MySQL 50 sa creating 3 n 8.0.28 general-public-license -``` - -### RDS API - -To restore a DB instance from a DB snapshot, call the Amazon RDS API function [RestoreDBInstanceFromDBSnapshot](https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_RestoreDBInstanceFromDBSnapshot.html) with the following parameters: -+ `DBInstanceIdentifier` -+ `DBSnapshotIdentifier` \ No newline at end of file diff --git a/doc_source/USER_SQLServerMultiAZ.md b/doc_source/USER_SQLServerMultiAZ.md deleted file mode 100644 index 955cd0a..0000000 --- a/doc_source/USER_SQLServerMultiAZ.md +++ /dev/null @@ -1,163 +0,0 @@ -# Multi\-AZ deployments for Amazon RDS for Microsoft SQL Server - -Multi\-AZ deployments provide increased availability, data durability, and fault tolerance for DB instances\. In the event of planned database maintenance or unplanned service disruption, Amazon RDS automatically fails over to the up\-to\-date secondary DB instance\. This functionality lets database operations resume quickly without manual intervention\. The primary and standby instances use the same endpoint, whose physical network address transitions to the secondary replica as part of the failover process\. You don't have to reconfigure your application when a failover occurs\. - -Amazon RDS supports Multi\-AZ deployments for Microsoft SQL Server by using either SQL Server Database Mirroring \(DBM\) or Always On Availability Groups \(AGs\)\. Amazon RDS monitors and maintains the health of your Multi\-AZ deployment\. If problems occur, RDS automatically repairs unhealthy DB instances, reestablishes synchronization, and initiates failovers\. Failover only occurs if the standby and primary are fully in sync\. You don't have to manage anything\. - -When you set up SQL Server Multi\-AZ, RDS automatically configures all databases on the instance to use DBM or AGs\. Amazon RDS handles the primary, the witness, and the secondary DB instance for you\. Because configuration is automatic, RDS selects DBM or Always On AGs based on the version of SQL Server that you deploy\. - -Amazon RDS supports Multi\-AZ with Always On AGs for the following SQL Server versions and editions: -+ SQL Server 2019: - + Standard Edition 15\.00\.4073\.23 and higher - + Enterprise Edition -+ SQL Server 2017: - + Standard Edition 14\.00\.3401\.7 and higher - + Enterprise Edition 14\.00\.3049\.1 and higher -+ SQL Server 2016: Enterprise Edition 13\.00\.5216\.0 and higher - -Amazon RDS supports Multi\-AZ with DBM for the following SQL Server versions and editions, except for the versions noted previously: -+ SQL Server 2019: Standard Edition 15\.00\.4043\.16 -+ SQL Server 2017: Standard and Enterprise Editions -+ SQL Server 2016: Standard and Enterprise Editions -+ SQL Server 2014: Standard and Enterprise Editions - -You can use the following SQL query to determine whether your SQL Server DB instance is Single\-AZ, Multi\-AZ with DBM, or Multi\-AZ with Always On AGs\. - -``` -SELECT CASE WHEN dm.mirroring_state_desc IS NOT NULL THEN 'Multi-AZ (Mirroring)' - WHEN dhdrs.group_database_id IS NOT NULL THEN 'Multi-AZ (AlwaysOn)' - ELSE 'Single-AZ' - END 'high_availability' -FROM sys.databases sd -LEFT JOIN sys.database_mirroring dm ON sd.database_id = dm.database_id -LEFT JOIN sys.dm_hadr_database_replica_states dhdrs ON sd.database_id = dhdrs.database_id AND dhdrs.is_local = 1 -WHERE DB_NAME(sd.database_id) = 'rdsadmin'; -``` - -The output resembles the following: - -``` -high_availability -Multi-AZ (AlwaysOn) -``` - -## Adding Multi\-AZ to a Microsoft SQL Server DB instance - -When you create a new SQL Server DB instance using the AWS Management Console, you can add Multi\-AZ with Database Mirroring \(DBM\) or Always On AGs\. You do so by choosing **Yes \(Mirroring / Always On\)** from **Multi\-AZ deployment**\. For more information, see [Creating an Amazon RDS DB instance](USER_CreateDBInstance.md)\. - -When you modify an existing SQL Server DB instance using the console, you can add Multi\-AZ with DBM or AGs by choosing **Yes \(Mirroring / Always On\)** from **Multi\-AZ deployment** on the **Modify DB instance** page\. For more information, see [Modifying an Amazon RDS DB instance](Overview.DBInstance.Modifying.md)\. - -**Note** -If your DB instance is running Database Mirroring \(DBM\)—not Always On Availability Groups \(AGs\)—you might need to disable in\-memory optimization before you add Multi\-AZ\. Disable in\-memory optimization with DBM before you add Multi\-AZ if your DB instance runs SQL Server 2014, 2016, or 2017 Enterprise Edition and has in\-memory optimization enabled\. -If your DB instance is running AGs, it doesn't require this step\. - -## Removing Multi\-AZ from a Microsoft SQL Server DB instance - -When you modify an existing SQL Server DB instance using the AWS Management Console, you can remove Multi\-AZ with DBM or AGs\. You can do this by choosing **No \(Mirroring / Always On\)** from **Multi\-AZ deployment** on the **Modify DB instance** page\. For more information, see [Modifying an Amazon RDS DB instance](Overview.DBInstance.Modifying.md)\. - -## Microsoft SQL Server Multi\-AZ deployment limitations, notes, and recommendations - -The following are some limitations when working with Multi\-AZ deployments on RDS for SQL Server DB instances: -+ Cross\-Region Multi\-AZ isn't supported\. -+ You can't configure the secondary DB instance to accept database read activity\. -+ Multi\-AZ with Always On Availability Groups \(AGs\) supports in\-memory optimization\. -+ Multi\-AZ with Always On Availability Groups \(AGs\) doesn't support Kerberos authentication for the availability group listener\. This is because the listener has no Service Principal Name \(SPN\)\. -+ You can't rename a database on a SQL Server DB instance that is in a SQL Server Multi\-AZ deployment\. If you need to rename a database on such an instance, first turn off Multi\-AZ for the DB instance, then rename the database\. Finally, turn Multi\-AZ back on for the DB instance\. -+ You can only restore Multi\-AZ DB instances that are backed up using the full recovery model\. -+ Multi\-AZ deployments have a limit of 100 SQL Server Agent jobs\. - - If you need a higher limit, request an increase by contacting AWS Support\. Open the [AWS Support Center](https://console.aws.amazon.com/support/home#/) page, sign in if necessary, and choose **Create case**\. Choose **Service limit increase**\. Complete and submit the form\. - -The following are some notes about working with Multi\-AZ deployments on RDS for SQL Server DB instances: -+ Amazon RDS exposes the Always On AGs [availability group listener endpoint](https://docs.microsoft.com/en-us/sql/database-engine/availability-groups/windows/listeners-client-connectivity-application-failover)\. The endpoint is visible in the console, and is returned by the `DescribeDBInstances` API operation as an entry in the endpoints field\. -+ Amazon RDS supports [availability group multisubnet failovers](https://docs.microsoft.com/en-us/sql/database-engine/availability-groups/windows/listeners-client-connectivity-application-failover)\. -+ To use SQL Server Multi\-AZ with a SQL Server DB instance in a virtual private cloud \(VPC\), first create a DB subnet group that has subnets in at least two distinct Availability Zones\. Then assign the DB subnet group to the primary replica of the SQL Server DB instance\. -+ When a DB instance is modified to be a Multi\-AZ deployment, during the modification it has a status of **modifying**\. Amazon RDS creates the standby, and makes a backup of the primary DB instance\. After the process is complete, the status of the primary DB instance becomes **available**\. -+ Multi\-AZ deployments maintain all databases on the same node\. If a database on the primary host fails over, all your SQL Server databases fail over as one atomic unit to your standby host\. Amazon RDS provisions a new healthy host, and replaces the unhealthy host\. -+ Multi\-AZ with DBM or AGs supports a single standby replica\. -+ Users, logins, and permissions are automatically replicated for you on the secondary\. You don't need to recreate them\. User\-defined server roles are only replicated in DB instances that use Always On AGs for Multi\-AZ deployments\. -+ In Multi\-AZ deployments, SQL Server Agent jobs are replicated from the primary host to the secondary host when the job replication feature is turned on\. For more information, see [Turning on SQL Server Agent job replication](Appendix.SQLServer.CommonDBATasks.Agent.md#SQLServerAgent.Replicate)\. -+ You might observe elevated latencies compared to a standard DB instance deployment \(in a single Availability Zone\) because of the synchronous data replication\. -+ Failover times are affected by the time it takes to complete the recovery process\. Large transactions increase the failover time\. -+ In SQL Server Multi\-AZ deployments, reboot with failover reboots only the primary DB instance\. After the failover, the primary DB instance becomes the new secondary DB instance\. Parameters might not be updated for Multi\-AZ instances\. For reboot without failover, both the primary and secondary DB instances reboot, and parameters are updated after the reboot\. If the DB instance is unresponsive, we recommend reboot without failover\. - -The following are some recommendations for working with Multi\-AZ deployments on RDS for Microsoft SQL Server DB instances: -+ For databases used in production or preproduction, we recommend the following options: - + Multi\-AZ deployments for high availability - + "Provisioned IOPS" for fast, consistent performance - + "Memory optimized" rather than "General purpose" -+ You can't select the Availability Zone \(AZ\) for the secondary instance, so when you deploy application hosts, take this into account\. Your database might fail over to another AZ, and the application hosts might not be in the same AZ as the database\. For this reason, we recommend that you balance your application hosts across all AZs in the given AWS Region\. -+ For best performance, don't enable Database Mirroring or Always On AGs during a large data load operation\. If you want your data load to be as fast as possible, finish loading data before you convert your DB instance to a Multi\-AZ deployment\. -+ Applications that access the SQL Server databases should have exception handling that catches connection errors\. The following code sample shows a try/catch block that catches a communication error\. In this example, the `break` statement exits the `while` loop if the connection is successful, but retries up to 10 times if an exception is thrown\. - - ``` - int RetryMaxAttempts = 10; - int RetryIntervalPeriodInSeconds = 1; - int iRetryCount = 0; - while (iRetryCount < RetryMaxAttempts) - { - using (SqlConnection connection = new SqlConnection(DatabaseConnString)) - { - using (SqlCommand command = connection.CreateCommand()) - { - command.CommandText = "INSERT INTO SOME_TABLE VALUES ('SomeValue');"; - try - { - connection.Open(); - command.ExecuteNonQuery(); - break; - } - catch (Exception ex) - { - Logger(ex.Message); - iRetryCount++; - } - finally { - connection.Close(); - } - } - } - Thread.Sleep(RetryIntervalPeriodInSeconds * 1000); - } - ``` -+ Don't use the `Set Partner Off` command when working with Multi\-AZ instances\. For example, don't do the following\. - - ``` - --Don't do this - ALTER DATABASE db1 SET PARTNER off - ``` -+ Don't set the recovery mode to `simple`\. For example, don't do the following\. - - ``` - --Don't do this - ALTER DATABASE db1 SET RECOVERY simple - ``` -+ Don't use the `DEFAULT_DATABASE` parameter when creating new logins on Multi\-AZ DB instances, because these settings can't be applied to the standby mirror\. For example, don't do the following\. - - ``` - --Don't do this - CREATE LOGIN [test_dba] WITH PASSWORD=foo, DEFAULT_DATABASE=[db2] - ``` - - Also, don't do the following\. - - ``` - --Don't do this - ALTER LOGIN [test_dba] SET DEFAULT_DATABASE=[db3] - ``` - -## Determining the location of the secondary - -You can determine the location of the secondary replica by using the AWS Management Console\. You need to know the location of the secondary if you are setting up your primary DB instance in a VPC\. - -![\[Secondary AZ\]](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/images/SQLSvr-MultiAZ.png) - -You can also view the Availability Zone of the secondary using the AWS CLI command `describe-db-instances` or RDS API operation `DescribeDBInstances`\. The output shows the secondary AZ where the standby mirror is located\. - -## Migrating from Database Mirroring to Always On Availability Groups - -In version 14\.00\.3049\.1 of Microsoft SQL Server Enterprise Edition, Always On Availability Groups \(AGs\) are enabled by default\. - -To migrate from Database Mirroring \(DBM\) to AGs, first check your version\. If you are using a DB instance with a version prior to Enterprise Edition 13\.00\.5216\.0, modify the instance to patch it to 13\.00\.5216\.0 or later\. If you are using a DB instance with a version prior to Enterprise Edition 14\.00\.3049\.1, modify the instance to patch it to 14\.00\.3049\.1 or later\. - -If you want to upgrade a mirrored DB instance to use AGs, run the upgrade first, modify the instance to remove Multi\-AZ, and then modify it again to add Multi\-AZ\. This converts your instance to use Always On AGs\. \ No newline at end of file diff --git a/doc_source/USER_SQLServerWinAuth.md b/doc_source/USER_SQLServerWinAuth.md deleted file mode 100644 index 02f2b9a..0000000 --- a/doc_source/USER_SQLServerWinAuth.md +++ /dev/null @@ -1,331 +0,0 @@ -# Using Windows Authentication with an Amazon RDS for SQL Server DB instance - -You can use Microsoft Windows Authentication to authenticate users when they connect to your Amazon RDS for Microsoft SQL Server DB instance\. The DB instance works with AWS Directory Service for Microsoft Active Directory, also called AWS Managed Microsoft AD, to enable Windows Authentication\. When users authenticate with a SQL Server DB instance joined to the trusting domain, authentication requests are forwarded to the domain directory that you create with AWS Directory Service\. - -## Region and version availability - -Amazon RDS supports Windows Authentication for SQL Server in all AWS Regions\. RDS supports using only AWS Managed Microsoft AD for Windows Authentication\. RDS doesn't support using AD Connector\. For more information, see the following: -+ [Application compatibility policy for AWS Managed Microsoft AD](https://docs.aws.amazon.com/directoryservice/latest/admin-guide/ms_ad_app_compatibility.html) -+ [Application compatibility policy for AD Connector](https://docs.aws.amazon.com/directoryservice/latest/admin-guide/ad_connector_app_compatibility.html) - -For more information on version and Region availability of RDS for SQL Server with Kerberos authentication, see [Kerberos authentication](Concepts.RDS_Fea_Regions_DB-eng.Feature.KerberosAuthentication.md)\. - -## Overview of setting up Windows authentication - -Amazon RDS uses mixed mode for Windows Authentication\. This approach means that the *master user* \(the name and password used to create your SQL Server DB instance\) uses SQL Authentication\. Because the master user account is a privileged credential, you should restrict access to this account\. - -To get Windows Authentication using an on\-premises or self\-hosted Microsoft Active Directory, create a forest trust\. The trust can be one\-way or two\-way\. For more information on setting up forest trusts using AWS Directory Service, see [When to create a trust relationship](https://docs.aws.amazon.com/directoryservice/latest/admin-guide/ms_ad_setup_trust.html) in the *AWS Directory Service Administration Guide*\. - -To set up Windows authentication for a SQL Server DB instance, do the following steps, explained in greater detail in [Setting up Windows Authentication for SQL Server DB instances](#USER_SQLServerWinAuth.SettingUp): - -1. Use AWS Managed Microsoft AD, either from the AWS Management Console or AWS Directory Service API, to create an AWS Managed Microsoft AD directory\. - -1. If you use the AWS CLI or Amazon RDS API to create your SQL Server DB instance, create an AWS Identity and Access Management \(IAM\) role\. This role uses the managed IAM policy `AmazonRDSDirectoryServiceAccess` and allows Amazon RDS to make calls to your directory\. If you use the console to create your SQL Server DB instance, AWS creates the IAM role for you\. - - For the role to allow access, the AWS Security Token Service \(AWS STS\) endpoint must be activated in the AWS Region for your AWS account\. AWS STS endpoints are active by default in all AWS Regions, and you can use them without any further actions\. For more information, see [Managing AWS STS in an AWS Region](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp_enable-regions.html) in the *IAM User Guide*\. - -1. Create and configure users and groups in the AWS Managed Microsoft AD directory using the Microsoft Active Directory tools\. For more information about creating users and groups in your Active Directory, see [Manage users and groups in AWS Managed Microsoft AD](https://docs.aws.amazon.com/directoryservice/latest/admin-guide/ms_ad_manage_users_groups.html) in the *AWS Directory Service Administration Guide*\. - -1. If you plan to locate the directory and the DB instance in different VPCs, enable cross\-VPC traffic\. - -1. Use Amazon RDS to create a new SQL Server DB instance either from the console, AWS CLI, or Amazon RDS API\. In the create request, you provide the domain identifier \("`d-*`" identifier\) that was generated when you created your directory and the name of the role you created\. You can also modify an existing SQL Server DB instance to use Windows Authentication by setting the domain and IAM role parameters for the DB instance\. - -1. Use the Amazon RDS master user credentials to connect to the SQL Server DB instance as you do any other DB instance\. Because the DB instance is joined to the AWS Managed Microsoft AD domain, you can provision SQL Server logins and users from the Active Directory users and groups in their domain\. \(These are known as SQL Server "Windows" logins\.\) Database permissions are managed through standard SQL Server permissions granted and revoked to these Windows logins\. - -## Creating the endpoint for Kerberos authentication - -Kerberos\-based authentication requires that the endpoint be the customer\-specified host name, a period, and then the fully qualified domain name \(FQDN\)\. For example, the following is an example of an endpoint you might use with Kerberos\-based authentication\. In this example, the SQL Server DB instance host name is `ad-test` and the domain name is `corp-ad.company.com`\. - -``` -ad-test.corp-ad.company.com -``` - -If you want to make sure your connection is using Kerberos, run the following query: - -``` -1. SELECT net_transport, auth_scheme -2. FROM sys.dm_exec_connections -3. WHERE session_id = @@SPID; -``` - -## Setting up Windows Authentication for SQL Server DB instances - -You use AWS Directory Service for Microsoft Active Directory, also called AWS Managed Microsoft AD, to set up Windows Authentication for a SQL Server DB instance\. To set up Windows Authentication, take the following steps\. - -### Step 1: Create a directory using the AWS Directory Service for Microsoft Active Directory - -AWS Directory Service creates a fully managed, Microsoft Active Directory in the AWS Cloud\. When you create an AWS Managed Microsoft AD directory, AWS Directory Service creates two domain controllers and Domain Name Service \(DNS\) servers on your behalf\. The directory servers are created in two subnets in two different Availability Zones within a VPC\. This redundancy helps ensure that your directory remains accessible even if a failure occurs\. - - When you create an AWS Managed Microsoft AD directory, AWS Directory Service performs the following tasks on your behalf: -+ Sets up a Microsoft Active Directory within the VPC\. -+ Creates a directory administrator account with the user name Admin and the specified password\. You use this account to manage your directory\. -**Note** -Be sure to save this password\. AWS Directory Service doesn't store this password, and you can't retrieve or reset it\. -+ Creates a security group for the directory controllers\. - -When you launch an AWS Directory Service for Microsoft Active Directory, AWS creates an Organizational Unit \(OU\) that contains all your directory's objects\. This OU, which has the NetBIOS name that you typed when you created your directory, is located in the domain root\. The domain root is owned and managed by AWS\. - - The *admin* account that was created with your AWS Managed Microsoft AD directory has permissions for the most common administrative activities for your OU: -+ Create, update, or delete users, groups, and computers\. -+ Add resources to your domain such as file or print servers, and then assign permissions for those resources to users and groups in your OU\. -+ Create additional OUs and containers\. -+ Delegate authority\. -+ Create and link group policies\. -+ Restore deleted objects from the Active Directory Recycle Bin\. -+ Run AD and DNS Windows PowerShell modules on the Active Directory Web Service\. - -The admin account also has rights to perform the following domain\-wide activities: -+ Manage DNS configurations \(add, remove, or update records, zones, and forwarders\)\. -+ View DNS event logs\. -+ View security event logs\. - -**To create a directory with AWS Managed Microsoft AD** - -1. In the [AWS Directory Service console](https://console.aws.amazon.com/directoryservicev2/) navigation pane, choose **Directories** and choose **Set up directory**\. - -1. Choose **AWS Managed Microsoft AD**\. This is the only option currently supported for use with Amazon RDS\. - -1. Choose **Next**\. - -1. On the **Enter directory information** page, provide the following information: -**Edition** - Choose the edition that meets your requirements\. -**Directory DNS name** -The fully qualified name for the directory, such as `corp.example.com`\. Names longer than 47 characters aren't supported by SQL Server\. -**Directory NetBIOS name** -An optional short name for the directory, such as `CORP`\. -**Directory description** -An optional description for the directory\. -**Admin password** -The password for the directory administrator\. The directory creation process creates an administrator account with the user name Admin and this password\. -The directory administrator password can't include the word `admin`\. The password is case\-sensitive and must be 8–64 characters in length\. It must also contain at least one character from three of the following four categories: - + Lowercase letters \(a\-z\) - + Uppercase letters \(A\-Z\) - + Numbers \(0\-9\) - + Non\-alphanumeric characters \(\~\!@\#$%^&\*\_\-\+=`\|\\\(\)\{\}\[\]:;"'<>,\.?/\) -**Confirm password** -Retype the administrator password\. - -1. Choose **Next**\. - -1. On the **Choose VPC and subnets** page, provide the following information: -**VPC** -Choose the VPC for the directory\. -You can locate the directory and the DB instance in different VPCs, but if you do so, make sure to enable cross\-VPC traffic\. For more information, see [Step 4: Enable cross\-VPC traffic between the directory and the DB instance](#USER_SQLServerWinAuth.SettingUp.VPC-Peering)\. -**Subnets** -Choose the subnets for the directory servers\. The two subnets must be in different Availability Zones\. - -1. Choose **Next**\. - -1. Review the directory information\. If changes are needed, choose **Previous**\. When the information is correct, choose **Create directory**\. -![\[Review and create page\]](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/images/WinAuth2.png) - -It takes several minutes for the directory to be created\. When it has been successfully created, the **Status** value changes to **Active**\. - -To see information about your directory, choose the directory ID in the directory listing\. Make a note of the **Directory ID**\. You need this value when you create or modify your SQL Server DB instance\. - -![\[Directory details page\]](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/images/WinAuth3.png) - -### Step 2: Create the IAM role for use by Amazon RDS - -If you use the console to create your SQL Server DB instance, you can skip this step\. If you use the CLI or RDS API to create your SQL Server DB instance, you must create an IAM role that uses the `AmazonRDSDirectoryServiceAccess` managed IAM policy\. This role allows Amazon RDS to make calls to the AWS Directory Service for you\. - -If you are using a custom policy for joining a domain, rather than using the AWS\-managed `AmazonRDSDirectoryServiceAccess` policy, make sure that you allow the `ds:GetAuthorizedApplicationDetails` action\. This requirement is effective starting July 2019, due to a change in the AWS Directory Service API\. - -The following IAM policy, `AmazonRDSDirectoryServiceAccess`, provides access to AWS Directory Service\. - -**Example IAM policy for providing access to AWS Directory Service** - -``` -{ - "Version": "2012-10-17", - "Statement": [ - { - "Action": [ - "ds:DescribeDirectories", - "ds:AuthorizeApplication", - "ds:UnauthorizeApplication", - "ds:GetAuthorizedApplicationDetails" - ], - "Effect": "Allow", - "Resource": "*" - } - ] -} -``` - -We recommend using the [https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies_condition-keys.html#condition-keys-sourcearn](https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies_condition-keys.html#condition-keys-sourcearn) and [https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies_condition-keys.html#condition-keys-sourceaccount](https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies_condition-keys.html#condition-keys-sourceaccount) global condition context keys in resource\-based trust relationships to limit the service's permissions to a specific resource\. This is the most effective way to protect against the [confused deputy problem](https://docs.aws.amazon.com/IAM/latest/UserGuide/confused-deputy.html)\. - -You might use both global condition context keys and have the `aws:SourceArn` value contain the account ID\. In this case, the `aws:SourceAccount` value and the account in the `aws:SourceArn` value must use the same account ID when used in the same statement\. -+ Use `aws:SourceArn` if you want cross\-service access for a single resource\. -+ Use `aws:SourceAccount` if you want to allow any resource in that account to be associated with the cross\-service use\. - -In the trust relationship, make sure to use the `aws:SourceArn` global condition context key with the full Amazon Resource Name \(ARN\) of the resources accessing the role\. For Windows Authentication, make sure to include the DB instances, as shown in the following example\. - -**Example trust relationship with global condition context key for Windows Authentication** - -``` -{ - "Version": "2012-10-17", - "Statement": [ - { - "Effect": "Allow", - "Principal": { - "Service": "rds.amazonaws.com" - }, - "Action": "sts:AssumeRole", - "Condition": { - "StringEquals": { - "aws:SourceArn": [ - "arn:aws:rds:Region:my_account_ID:db:db_instance_identifier" - ] - } - } - } - ] -} -``` - -Create an IAM role using this IAM policy and trust relationship\. For more information about creating IAM roles, see [Creating customer managed policies](https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies_managed-using.html#create-managed-policy-console) in the *IAM User Guide*\. - -### Step 3: Create and configure users and groups - -You can create users and groups with the Active Directory Users and Computers tool\. This tool is one of the Active Directory Domain Services and Active Directory Lightweight Directory Services tools\. Users represent individual people or entities that have access to your directory\. Groups are very useful for giving or denying privileges to groups of users, rather than having to apply those privileges to each individual user\. - -To create users and groups in an AWS Directory Service directory, you must be connected to a Windows EC2 instance that is a member of the AWS Directory Service directory\. You must also be logged in as a user that has privileges to create users and groups\. For more information, see [Add users and groups \(Simple AD and AWS Managed Microsoft AD\)](https://docs.aws.amazon.com/directoryservice/latest/admin-guide/creating_ad_users_and_groups.html) in the *AWS Directory Service Administration Guide*\. - -### Step 4: Enable cross\-VPC traffic between the directory and the DB instance - -If you plan to locate the directory and the DB instance in the same VPC, skip this step and move on to [Step 5: Create or modify a SQL Server DB instance](#USER_SQLServerWinAuth.SettingUp.CreateModify)\. - -If you plan to locate the directory and the DB instance in different VPCs, configure cross\-VPC traffic using VPC peering or [AWS Transit Gateway](https://docs.aws.amazon.com/vpc/latest/tgw/what-is-transit-gateway.html)\. - -The following procedure enables traffic between VPCs using VPC peering\. Follow the instructions in [What is VPC peering?](https://docs.aws.amazon.com/vpc/latest/peering/Welcome.html) in the *Amazon Virtual Private Cloud Peering Guide*\. - -**To enable cross\-VPC traffic using VPC peering** - -1. Set up appropriate VPC routing rules to ensure that network traffic can flow both ways\. - -1. Ensure that the DB instance's security group can receive inbound traffic from the directory's security group\. - -1. Ensure that there is no network access control list \(ACL\) rule to block traffic\. - -If a different AWS account owns the directory, you must share the directory\. - -**To share the directory between AWS accounts** - -1. Start sharing the directory with the AWS account that the DB instance will be created in by following the instructions in [Tutorial: Sharing your AWS Managed Microsoft AD directory for seamless EC2 domain\-join](https://docs.aws.amazon.com/directoryservice/latest/admin-guide/ms_ad_tutorial_directory_sharing.html) in the *AWS Directory Service Administration Guide*\. - -1. Sign in to the AWS Directory Service console using the account for the DB instance, and ensure that the domain has the `SHARED` status before proceeding\. - -1. While signed into the AWS Directory Service console using the account for the DB instance, note the **Directory ID** value\. You use this directory ID to join the DB instance to the domain\. - -### Step 5: Create or modify a SQL Server DB instance - -Create or modify a SQL Server DB instance for use with your directory\. You can use the console, CLI, or RDS API to associate a DB instance with a directory\. You can do this in one of the following ways: -+ Create a new SQL Server DB instance using the console, the [create\-db\-instance](https://docs.aws.amazon.com/cli/latest/reference/rds/create-db-instance.html) CLI command, or the [CreateDBInstance](https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_CreateDBInstance.html) RDS API operation\. - - For instructions, see [Creating an Amazon RDS DB instance](USER_CreateDBInstance.md)\. -+ Modify an existing SQL Server DB instance using the console, the [modify\-db\-instance](https://docs.aws.amazon.com/cli/latest/reference/rds/modify-db-instance.html) CLI command, or the [ModifyDBInstance](https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_ModifyDBInstance.html) RDS API operation\. - - For instructions, see [Modifying an Amazon RDS DB instance](Overview.DBInstance.Modifying.md)\. -+ Restore a SQL Server DB instance from a DB snapshot using the console, the [restore\-db\-instance\-from\-db\-snapshot](https://docs.aws.amazon.com/cli/latest/reference/rds/restore-db-instance-from-db-snapshot.html) CLI command, or the [RestoreDBInstanceFromDBSnapshot](https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_RestoreDBInstanceFromDBSnapshot.html) RDS API operation\. - - For instructions, see [Restoring from a DB snapshot](USER_RestoreFromSnapshot.md)\. -+ Restore a SQL Server DB instance to a point\-in\-time using the console, the [restore\-db\-instance\-to\-point\-in\-time](https://docs.aws.amazon.com/cli/latest/reference/rds/restore-db-instance-to-point-in-time.html) CLI command, or the [RestoreDBInstanceToPointInTime](https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_RestoreDBInstanceToPointInTime.html) RDS API operation\. - - For instructions, see [Restoring a DB instance to a specified time](USER_PIT.md)\. - - Windows Authentication is only supported for SQL Server DB instances in a VPC\. - - For the DB instance to be able to use the domain directory that you created, the following is required: -+ For **Directory**, you must choose the domain identifier \(`d-ID`\) generated when you created the directory\. -+ Make sure that the VPC security group has an outbound rule that lets the DB instance communicate with the directory\. - -![\[Microsoft SQL Server Windows Authentication directory\]](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/images/WinAuth1.png) - -When you use the AWS CLI, the following parameters are required for the DB instance to be able to use the directory that you created: -+ For the `--domain` parameter, use the domain identifier \(`d-ID`\) generated when you created the directory\. -+ For the `--domain-iam-role-name` parameter, use the role that you created that uses the managed IAM policy `AmazonRDSDirectoryServiceAccess`\. - -For example, the following CLI command modifies a DB instance to use a directory\. - -For Linux, macOS, or Unix: - -``` -aws rds modify-db-instance \ - --db-instance-identifier mydbinstance \ - --domain d-ID \ - --domain-iam-role-name role-name -``` - -For Windows: - -``` -aws rds modify-db-instance ^ - --db-instance-identifier mydbinstance ^ - --domain d-ID ^ - --domain-iam-role-name role-name -``` - -**Important** -If you modify a DB instance to enable Kerberos authentication, reboot the DB instance after making the change\. - -### Step 6: Create Windows Authentication SQL Server logins - -Use the Amazon RDS master user credentials to connect to the SQL Server DB instance as you do any other DB instance\. Because the DB instance is joined to the AWS Managed Microsoft AD domain, you can provision SQL Server logins and users\. You do this from the Active Directory users and groups in your domain\. Database permissions are managed through standard SQL Server permissions granted and revoked to these Windows logins\. - -For an Active Directory user to authenticate with SQL Server, a SQL Server Windows login must exist for the user or a group that the user is a member of\. Fine\-grained access control is handled through granting and revoking permissions on these SQL Server logins\. A user that doesn't have a SQL Server login or belong to a group with such a login can't access the SQL Server DB instance\. - -The ALTER ANY LOGIN permission is required to create an Active Directory SQL Server login\. If you haven't created any logins with this permission, connect as the DB instance's master user using SQL Server Authentication\. - -Run a data definition language \(DDL\) command such as the following example to create a SQL Server login for an Active Directory user or group\. - -**Note** -Specify users and groups using the pre\-Windows 2000 login name in the format `domainName\login_name`\. You can't use a user principal name \(UPN\) in the format *`login_name`*`@`*`DomainName`*\. - -``` -USE [master] -GO -CREATE LOGIN [mydomain\myuser] FROM WINDOWS WITH DEFAULT_DATABASE = [master], DEFAULT_LANGUAGE = [us_english]; -GO -``` - -For more information, see [CREATE LOGIN \(Transact\-SQL\)](https://msdn.microsoft.com/en-us/library/ms189751.aspx) in the Microsoft Developer Network documentation\. - -Users \(both humans and applications\) from your domain can now connect to the RDS for SQL Server instance from a domain\-joined client machine using Windows authentication\. - -## Managing a DB instance in a Domain - - You can use the console, AWS CLI, or the Amazon RDS API to manage your DB instance and its relationship with your domain\. For example, you can move the DB instance into, out of, or between domains\. - - For example, using the Amazon RDS API, you can do the following: -+ To reattempt a domain join for a failed membership, use the [ModifyDBInstance](https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_ModifyDBInstance.html) API operation and specify the current membership's directory ID\. -+ To update the IAM role name for membership, use the `ModifyDBInstance` API operation and specify the current membership's directory ID and the new IAM role\. -+ To remove a DB instance from a domain, use the `ModifyDBInstance` API operation and specify `none` as the domain parameter\. -+ To move a DB instance from one domain to another, use the `ModifyDBInstance` API operation and specify the domain identifier of the new domain as the domain parameter\. -+ To list membership for each DB instance, use the [DescribeDBInstances](https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/DescribeDBInstances.html) API operation\. - -### Understanding Domain membership - - After you create or modify your DB instance, the instance becomes a member of the domain\. The AWS console indicates the status of the domain membership for the DB instance\. The status of the DB instance can be one of the following: -+ **joined** – The instance is a member of the domain\. -+ **joining** – The instance is in the process of becoming a member of the domain\. -+ **pending\-join** – The instance membership is pending\. -+ **pending\-maintenance\-join** – AWS will attempt to make the instance a member of the domain during the next scheduled maintenance window\. -+ **pending\-removal** – The removal of the instance from the domain is pending\. -+ **pending\-maintenance\-removal** – AWS will attempt to remove the instance from the domain during the next scheduled maintenance window\. -+ **failed** – A configuration problem has prevented the instance from joining the domain\. Check and fix your configuration before reissuing the instance modify command\. -+ **removing** – The instance is being removed from the domain\. - -A request to become a member of a domain can fail because of a network connectivity issue or an incorrect IAM role\. For example, you might create a DB instance or modify an existing instance and have the attempt fail for the DB instance to become a member of a domain\. In this case, either reissue the command to create or modify the DB instance or modify the newly created instance to join the domain\. - -## Connecting to SQL Server with Windows authentication - -To connect to SQL Server with Windows Authentication, you must be logged into a domain\-joined computer as a domain user\. After launching SQL Server Management Studio, choose **Windows Authentication** as the authentication type, as shown following\. - -![\[Connect to SQL Server using Windows Authentication\]](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/images/WinAuth4.png) - -## Restoring a SQL Server DB instance and then adding it to a domain - -You can restore a DB snapshot or do point\-in\-time recovery \(PITR\) for a SQL Server DB instance and then add it to a domain\. Once the DB instance is restored, modify the instance using the process explained in [Step 5: Create or modify a SQL Server DB instance](#USER_SQLServerWinAuth.SettingUp.CreateModify) to add the DB instance to a domain\. \ No newline at end of file diff --git a/doc_source/USER_ShareSnapshot.md b/doc_source/USER_ShareSnapshot.md deleted file mode 100644 index 5df6cc7..0000000 --- a/doc_source/USER_ShareSnapshot.md +++ /dev/null @@ -1,304 +0,0 @@ -# Sharing a DB snapshot - -Using Amazon RDS, you can share a manual DB snapshot in the following ways: -+ Sharing a manual DB snapshot, whether encrypted or unencrypted, enables authorized AWS accounts to copy the snapshot\. -+ Sharing an unencrypted manual DB snapshot enables authorized AWS accounts to directly restore a DB instance from the snapshot instead of taking a copy of it and restoring from that\. However, you can't restore a DB instance from a DB snapshot that is both shared and encrypted\. Instead, you can make a copy of the DB snapshot and restore the DB instance from the copy\. - -**Note** -To share an automated DB snapshot, create a manual DB snapshot by copying the automated snapshot, and then share that copy\. This process also applies to AWS Backup–generated resources\. - -For more information on copying a snapshot, see [Copying a DB snapshot](USER_CopySnapshot.md)\. For more information on restoring a DB instance from a DB snapshot, see [Restoring from a DB snapshot](USER_RestoreFromSnapshot.md)\. - -You can share a manual snapshot with up to 20 other AWS accounts\. - -The following limitations apply when sharing manual snapshots with other AWS accounts: -+ When you restore a DB instance from a shared snapshot using the AWS Command Line Interface \(AWS CLI\) or Amazon RDS API, you must specify the Amazon Resource Name \(ARN\) of the shared snapshot as the snapshot identifier\. -+ You can't share a DB snapshot that uses an option group with permanent or persistent options, except for Oracle DB instances that have the `Timezone` or `OLS` option \(or both\)\. - - A *permanent option* can't be removed from an option group\. Option groups with persistent options can't be removed from a DB instance once the option group has been assigned to the DB instance\. - - The following table lists permanent and persistent options and their related DB engines\. -[\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_ShareSnapshot.html) - - For Oracle DB instances, you can copy shared DB snapshots that have the `Timezone` or `OLS` option \(or both\)\. To do so, specify a target option group that includes these options when you copy the DB snapshot\. The OLS option is permanent and persistent only for Oracle DB instances running Oracle version 12\.2 or higher\. For more information about these options, see [Oracle time zone](Appendix.Oracle.Options.Timezone.md) and [Oracle Label Security](Oracle.Options.OLS.md)\. - - - -## Sharing public snapshots - -You can also share an unencrypted manual snapshot as public, which makes the snapshot available to all AWS accounts\. Make sure when sharing a snapshot as public that none of your private information is included in the public snapshot\. - -When a snapshot is shared publicly, it gives all AWS accounts permission both to copy the snapshot and to create DB instances from it\. - -You aren't billed for the backup storage of public snapshots owned by other accounts\. You're billed only for snapshots that you own\. - -If you copy a public snapshot, you own the copy\. You're billed for the backup storage of your snapshot copy\. If you create a DB instance from a public snapshot, you're billed for that DB instance\. For Amazon RDS pricing information, see the [Amazon RDS product page](https://aws.amazon.com/rds/pricing)\. - -You can delete only the public snapshots that you own\. To delete a shared or public snapshot, make sure to log into the AWS account that owns the snapshot\. - -### Viewing public snapshots owned by other AWS accounts - -You can view public snapshots owned by other accounts in a particular AWS Region on the **Public** tab of the **Snapshots** page in the Amazon RDS console\. Your snapshots \(those owned by your account\) don't appear on this tab\. - -**To view public snapshots** - -1. Open the Amazon RDS console at [https://console\.aws\.amazon\.com/rds/](https://console.aws.amazon.com/rds/)\. - -1. In the navigation pane, choose **Snapshots**\. - -1. Choose the **Public** tab\. - - The public snapshots appear\. You can see which account owns a public snapshot in the **Owner** column\. -**Note** -You might have to modify the page preferences, by selecting the gear icon at the upper right of the **Public snapshots** list, to see this column\. - -### Viewing your own public snapshots - -You can use the following AWS CLI command \(Unix only\) to view the public snapshots owned by your AWS account in a particular AWS Region\. - -``` -aws rds describe-db-snapshots --snapshot-type public --include-public | grep account_number -``` - -The output returned is similar to the following example if you have public snapshots\. - -``` -"DBSnapshotArn": "arn:aws:rds:us-east-1:123456789012:snapshot:mysnapshot1", -"DBSnapshotArn": "arn:aws:rds:us-east-1:123456789012:snapshot:mysnapshot2", -``` - -**Note** -You might see duplicate entries for `DBSnapshotIdentifier` or `SourceDBSnapshotIdentifier`\. - -## Sharing encrypted snapshots - -You can share DB snapshots that have been encrypted "at rest" using the AES\-256 encryption algorithm, as described in [Encrypting Amazon RDS resources](Overview.Encryption.md)\. To do this, take the following steps: - -1. Share the AWS KMS key that was used to encrypt the snapshot with any accounts that you want to be able to access the snapshot\. - - You can share KMS keys with another AWS account by adding the other account to the KMS key policy\. For details on updating a key policy, see [Key policies](https://docs.aws.amazon.com/kms/latest/developerguide/key-policies.html) in the *AWS KMS Developer Guide*\. For an example of creating a key policy, see [Allowing access to an AWS KMS key](#USER_ShareSnapshot.Encrypted.KeyPolicy) later in this topic\. - -1. Use the AWS Management Console, AWS CLI, or Amazon RDS API to share the encrypted snapshot with the other accounts\. - -These restrictions apply to sharing encrypted snapshots: -+ You can't share encrypted snapshots as public\. -+ You can't share Oracle or Microsoft SQL Server snapshots that are encrypted using Transparent Data Encryption \(TDE\)\. -+ You can't share a snapshot that has been encrypted using the default KMS key of the AWS account that shared the snapshot\. - -### Allowing access to an AWS KMS key - -For another AWS account to copy an encrypted DB snapshot shared from your account, the account that you share your snapshot with must have access to the AWS KMS key that encrypted the snapshot\. - -To allow another AWS account access to a KMS key, update the key policy for the KMS key\. You update it with the Amazon Resource Name \(ARN\) of the AWS account that you are sharing to as `Principal` in the KMS key policy\. Then you allow the `kms:CreateGrant` action\. - -After you have given an AWS account access to your KMS key, to copy your encrypted snapshot that AWS account must create an AWS Identity and Access Management \(IAM\) role or user if it doesn't already have one\. In addition, that AWS account must also attach an IAM policy to that IAM permission set or roles that allows the permission set or roles to copy an encrypted DB snapshot using your KMS key\. The account must be an IAM user and can't be a root AWS account identity due to AWS KMS security restrictions\. - -In the following key policy example, user `111122223333` is the owner of the KMS key, and user `444455556666` is the account that the key is being shared with\. This updated key policy gives the AWS account access to the KMS key by including the ARN for the root AWS account identity for user `444455556666` as a `Principal` for the policy, and by allowing the `kms:CreateGrant` action\. - -``` -{ - "Id": "key-policy-1", - "Version": "2012-10-17", - "Statement": [ - { - "Sid": "Allow use of the key", - "Effect": "Allow", - "Principal": {"AWS": [ - "arn:aws:iam::111122223333:user/KeyUser", - "arn:aws:iam::444455556666:root" - ]}, - "Action": [ - "kms:CreateGrant", - "kms:Encrypt", - "kms:Decrypt", - "kms:ReEncrypt*", - "kms:GenerateDataKey*", - "kms:DescribeKey" - ], - "Resource": "*" - }, - { - "Sid": "Allow attachment of persistent resources", - "Effect": "Allow", - "Principal": {"AWS": [ - "arn:aws:iam::111122223333:user/KeyUser", - "arn:aws:iam::444455556666:root" - ]}, - "Action": [ - "kms:CreateGrant", - "kms:ListGrants", - "kms:RevokeGrant" - ], - "Resource": "*", - "Condition": {"Bool": {"kms:GrantIsForAWSResource": true}} - } - ] -} -``` - -#### Creating an IAM policy to enable copying of the encrypted snapshot - -Once the external AWS account has access to your KMS key, the owner of that AWS account can create a policy that allows an IAM user created for that account to copy an encrypted snapshot encrypted with that KMS key\. - -The following example shows a policy that can be attached to an IAM user for AWS account `444455556666` that enables the IAM user to copy a shared snapshot from AWS account `111122223333` that has been encrypted with the KMS key `c989c1dd-a3f2-4a5d-8d96-e793d082ab26` in the `us-west-2` region\. - -``` -{ - "Version": "2012-10-17", - "Statement": [ - { - "Sid": "AllowUseOfTheKey", - "Effect": "Allow", - "Action": [ - "kms:Encrypt", - "kms:Decrypt", - "kms:ReEncrypt*", - "kms:GenerateDataKey*", - "kms:DescribeKey", - "kms:CreateGrant", - "kms:RetireGrant" - ], - "Resource": ["arn:aws:kms:us-west-2:111122223333:key/c989c1dd-a3f2-4a5d-8d96-e793d082ab26"] - }, - { - "Sid": "AllowAttachmentOfPersistentResources", - "Effect": "Allow", - "Action": [ - "kms:CreateGrant", - "kms:ListGrants", - "kms:RevokeGrant" - ], - "Resource": ["arn:aws:kms:us-west-2:111122223333:key/c989c1dd-a3f2-4a5d-8d96-e793d082ab26"], - "Condition": { - "Bool": { - "kms:GrantIsForAWSResource": true - } - } - } - ] -} -``` - -For details on updating a key policy, see [Key policies](https://docs.aws.amazon.com/kms/latest/developerguide/key-policies.html) in the *AWS KMS Developer Guide*\. - -## Sharing a snapshot - -You can share a DB snapshot using the AWS Management Console, the AWS CLI, or the RDS API\. - -### Console - -Using the Amazon RDS console, you can share a manual DB snapshot with up to 20 AWS accounts\. You can also use the console to stop sharing a manual snapshot with one or more accounts\. - -**To share a manual DB snapshot by using the Amazon RDS console** - -1. Sign in to the AWS Management Console and open the Amazon RDS console at [https://console\.aws\.amazon\.com/rds/](https://console.aws.amazon.com/rds/)\. - -1. In the navigation pane, choose **Snapshots**\. - -1. Select the manual snapshot that you want to share\. - -1. For **Actions**, choose **Share snapshot**\. - -1. Choose one of the following options for **DB snapshot visibility**\. - + If the source is unencrypted, choose **Public** to permit all AWS accounts to restore a DB instance from your manual DB snapshot, or choose **Private** to permit only AWS accounts that you specify to restore a DB instance from your manual DB snapshot\. -**Warning** -If you set **DB snapshot visibility** to **Public**, all AWS accounts can restore a DB instance from your manual DB snapshot and have access to your data\. Do not share any manual DB snapshots that contain private information as **Public**\. - + If the source is encrypted, **DB snapshot visibility** is set as **Private** because encrypted snapshots can't be shared as public\. - -1. For **AWS Account ID**, type the AWS account identifier for an account that you want to permit to restore a DB instance from your manual snapshot, and then choose **Add**\. Repeat to include additional AWS account identifiers, up to 20 AWS accounts\. - - If you make an error when adding an AWS account identifier to the list of permitted accounts, you can delete it from the list by choosing **Delete** at the right of the incorrect AWS account identifier\. -![\[Permit AWS accounts to restore a manual DB snapshot\]](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/images/ShareSnapshot_add.png) - -1. After you have added identifiers for all of the AWS accounts that you want to permit to restore the manual snapshot, choose **Save** to save your changes\. - -**To stop sharing a manual DB snapshot with an AWS account** - -1. Sign in to the AWS Management Console and open the Amazon RDS console at [https://console\.aws\.amazon\.com/rds/](https://console.aws.amazon.com/rds/)\. - -1. In the navigation pane, choose **Snapshots**\. - -1. Select the manual snapshot that you want to stop sharing\. - -1. Choose **Actions**, and then choose **Share snapshot**\. - -1. To remove permission for an AWS account, choose **Delete** for the AWS account identifier for that account from the list of authorized accounts\. -![\[Permit AWS accounts to restore a manual DB snapshot\]](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/images/ShareSnapshot_delete.png) - -1. Choose **Save** to save your changes\. - -### AWS CLI - -To share a DB snapshot, use the `aws rds modify-db-snapshot-attribute` command\. Use the `--values-to-add` parameter to add a list of the IDs for the AWS accounts that are authorized to restore the manual snapshot\. - -**Example of sharing a snapshot with a single account** -The following example enables AWS account identifier `123456789012` to restore the DB snapshot named `db7-snapshot`\. -For Linux, macOS, or Unix: - -``` -aws rds modify-db-snapshot-attribute \ ---db-snapshot-identifier db7-snapshot \ ---attribute-name restore \ ---values-to-add 123456789012 -``` -For Windows: - -``` -aws rds modify-db-snapshot-attribute ^ ---db-snapshot-identifier db7-snapshot ^ ---attribute-name restore ^ ---values-to-add 123456789012 -``` - -**Example of sharing a snapshot with multiple accounts** -The following example enables two AWS account identifiers, `111122223333` and `444455556666`, to restore the DB snapshot named `manual-snapshot1`\. -For Linux, macOS, or Unix: - -``` -aws rds modify-db-snapshot-attribute \ ---db-snapshot-identifier manual-snapshot1 \ ---attribute-name restore \ ---values-to-add {"111122223333","444455556666"} -``` -For Windows: - -``` -aws rds modify-db-snapshot-attribute ^ ---db-snapshot-identifier manual-snapshot1 ^ ---attribute-name restore ^ ---values-to-add "[\"111122223333\",\"444455556666\"]" -``` -When using the Windows command prompt, you must escape double quotes \("\) in JSON code by prefixing them with a backslash \(\\\)\. - -To remove an AWS account identifier from the list, use the `--values-to-remove` parameter\. - -**Example of stopping snapshot sharing** -The following example prevents AWS account ID 444455556666 from restoring the snapshot\. -For Linux, macOS, or Unix: - -``` -aws rds modify-db-snapshot-attribute \ ---db-snapshot-identifier manual-snapshot1 \ ---attribute-name restore \ ---values-to-remove 444455556666 -``` -For Windows: - -``` -aws rds modify-db-snapshot-attribute ^ ---db-snapshot-identifier manual-snapshot1 ^ ---attribute-name restore ^ ---values-to-remove 444455556666 -``` - -To list the AWS accounts enabled to restore a snapshot, use the [https://docs.aws.amazon.com/cli/latest/reference/rds/describe-db-snapshot-attributes.html](https://docs.aws.amazon.com/cli/latest/reference/rds/describe-db-snapshot-attributes.html) AWS CLI command\. - -### RDS API - -You can also share a manual DB snapshot with other AWS accounts by using the Amazon RDS API\. To do so, call the [https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_ModifyDBSnapshotAttribute.html](https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_ModifyDBSnapshotAttribute.html) operation\. Specify `restore` for `AttributeName`, and use the `ValuesToAdd` parameter to add a list of the IDs for the AWS accounts that are authorized to restore the manual snapshot\. - -To make a manual snapshot public and restorable by all AWS accounts, use the value `all`\. However, take care not to add the `all` value for any manual snapshots that contain private information that you don't want to be available to all AWS accounts\. Also, don't specify `all` for encrypted snapshots, because making such snapshots public isn't supported\. - -To remove sharing permission for an AWS account, use the [https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_ModifyDBSnapshotAttribute.html](https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_ModifyDBSnapshotAttribute.html) operation with `AttributeName` set to `restore` and the `ValuesToRemove` parameter\. To mark a manual snapshot as private, remove the value `all` from the values list for the `restore` attribute\. - -To list all of the AWS accounts permitted to restore a snapshot, use the [https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_DescribeDBSnapshotAttributes.html](https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_DescribeDBSnapshotAttributes.html) API operation\. \ No newline at end of file diff --git a/doc_source/USER_StartInstance.md b/doc_source/USER_StartInstance.md deleted file mode 100644 index 8b12eb3..0000000 --- a/doc_source/USER_StartInstance.md +++ /dev/null @@ -1,31 +0,0 @@ -# Starting an Amazon RDS DB instance that was previously stopped - -You can stop your Amazon RDS DB instance temporarily to save money\. After you stop your DB instance, you can restart it to begin using it again\. For more details about stopping and starting DB instances, see [Stopping an Amazon RDS DB instance temporarily](USER_StopInstance.md)\. - -When you start a DB instance that you previously stopped, the DB instance retains certain information\. This information is the ID, Domain Name Server \(DNS\) endpoint, parameter group, security group, and option group\. When you start a stopped instance, you are charged a full instance hour\. - -## Console - -**To start a DB instance** - -1. Sign in to the AWS Management Console and open the Amazon RDS console at [https://console\.aws\.amazon\.com/rds/](https://console.aws.amazon.com/rds/)\. - -1. In the navigation pane, choose **Databases**, and then choose the DB instance that you want to start\. - -1. For **Actions**, choose **Start**\. - -## AWS CLI - -To start a DB instance by using the AWS CLI, call the [start\-db\-instance](https://docs.aws.amazon.com/cli/latest/reference/rds/start-db-instance.html) command with the following option: -+ `--db-instance-identifier` – The name of the DB instance\. - -**Example** - -``` -1. aws rds start-db-instance --db-instance-identifier mydbinstance -``` - -## RDS API - -To start a DB instance by using the Amazon RDS API, call the [StartDBInstance](https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_StartDBInstance.html) operation with the following parameter: -+ `DBInstanceIdentifier` – The name of the DB instance\. \ No newline at end of file diff --git a/doc_source/USER_StopInstance.md b/doc_source/USER_StopInstance.md deleted file mode 100644 index 08b0527..0000000 --- a/doc_source/USER_StopInstance.md +++ /dev/null @@ -1,96 +0,0 @@ -# Stopping an Amazon RDS DB instance temporarily - -Suppose that you use a DB instance intermittently, for temporary testing, or for a daily development activity\. If so, you can stop your Amazon RDS DB instance temporarily to save money\. While your DB instance is stopped, you are charged for provisioned storage \(including Provisioned IOPS\)\. You're also charged for backup storage, including manual snapshots and automated backups within your specified retention window\. However, you're not charged for DB instance hours\. For more information, see [Billing FAQs](http://aws.amazon.com/rds/faqs/#billing)\. - -**Note** -In some cases, a large amount of time is required to stop a DB instance\. If you want to stop your DB instance and restart it immediately, you can reboot the DB instance\. For information about rebooting a DB instance, see [Rebooting a DB instance](USER_RebootInstance.md)\. - -You can stop and start DB instances that are running the following engines: -+ MariaDB -+ Microsoft SQL Server -+ MySQL -+ Oracle -+ PostgreSQL - -Stopping and starting a DB instance is supported for all DB instance classes, and in all AWS Regions\. - -You can stop and start a DB instance whether it is configured for a single Availability Zone\. Or you can do so or for Multi\-AZ, for database engines that support Multi\-AZ deployments\. You can't stop an Amazon RDS for SQL Server DB instance in a Multi\-AZ configuration\. - -**Note** -For a Multi\-AZ deployment, a large amount of time might be required to stop a DB instance\. If you have at least one backup after a previous failover, then you can speed up the stop DB instance operation\. To do so, perform a reboot with failover operation before stopping the DB instance\. - -When you stop a DB instance, the DB instance performs a normal shutdown and stops running\. The status of the DB instance changes to `stopping` and then `stopped`\. Occasionally, an RDS for PostgreSQL DB instance doesn't shut down cleanly\. If this happens, you see that the instance goes through a recovery process when you restart it later\. This is expected behavior of the database engine, intended to protect database integrity\. Some memory\-based statistics and counters don't retain history and are re\-initialized after restart, to capture the operational workload moving forward\. - -At the end of the normal shutdown process, any storage volumes remain attached to the DB instance, and their data is kept\. Any data stored in the RAM of the DB instance is deleted\. - -Stopping a DB instance removes pending actions, except for pending actions for the DB instance's option group or DB parameter group\. - -Automated backups aren't created while a DB instance is stopped\. Backups can be retained longer than the backup retention period if a DB instance has been stopped\. RDS doesn't include time spent in the `stopped` state when the backup retention window is calculated\. - -**Important** -You can stop a DB instance for up to seven days\. If you don't manually start your DB instance after seven days, your DB instance is automatically started\. This way, it doesn't fall behind any required maintenance updates\. - -## Benefits - -Stopping and starting a DB instance is faster than creating a DB snapshot, and then restoring the snapshot\. - -When you stop a DB instance it retains its ID, Domain Name Server \(DNS\) endpoint, parameter group, security group, and option group\. When you start a DB instance, it has the same configuration as when you stopped it\. In addition, if you stop a DB instance, Amazon RDS keeps the Amazon S3 transaction logs\. This means that you can do a point\-in\-time restore if necessary\. - -## Limitations - -The following are some limitations to stopping and starting a DB instance: -+ You can't stop a DB instance that has a read replica, or that is a read replica\. -+ You can't stop an Amazon RDS for SQL Server DB instance in a Multi\-AZ configuration\. -+ You can't modify a stopped DB instance\. -+ You can't delete an option group that is associated with a stopped DB instance\. -+ You can't delete a DB parameter group that is associated with a stopped DB instance\. -+ In a Multi\-AZ configuration, the primary and secondary Availability Zones might be switched after you start the DB instance\. - -## Option and parameter group considerations - -You can't remove persistent options \(including permanent options\) from an option group if there are DB instances associated with that option group\. This functionality is also true of any DB instance with a state of `stopping`, `stopped`, or `starting`\. - -You can change the option group or DB parameter group that is associated with a stopped DB instance\. However, the change doesn't occur until the next time you start the DB instance\. If you chose to apply changes immediately, the change occurs when you start the DB instance\. Otherwise the change occurs during the next maintenance window after you start the DB instance\. - -## Public IP address - -When you stop a DB instance, it retains its DNS endpoint\. If you stop a DB instance that has a public IP address, Amazon RDS releases its public IP address\. When the DB instance is restarted, it has a different public IP address\. - -**Note** -You should always connect to a DB instance using the DNS endpoint, not the IP address\. - -## Stopping a DB instance temporarily - -You can stop a DB using the AWS Management Console, the AWS CLI, or the RDS API\. - -### Console - -**To stop a DB instance** - -1. Sign in to the AWS Management Console and open the Amazon RDS console at [https://console\.aws\.amazon\.com/rds/](https://console.aws.amazon.com/rds/)\. - -1. In the navigation pane, choose **Databases**, and then choose the DB instance that you want to stop\. - -1. For **Actions**, choose **Stop temporarily**\. - -1. In the **Stop DB instance temporarily** window, select the acknowledgement that the DB instance will restart automatically after 7 days\. - -1. \(Optional\) Select **Save the DB instance in a snapshot** and enter the snapshot name for **Snapshot name**\. Choose this option if you want to create a snapshot of the DB instance before stopping it\. - -1. Choose **Stop temporarily** to stop the DB instance, or choose **Cancel** to cancel the operation\. - -### AWS CLI - -To stop a DB instance by using the AWS CLI, call the [stop\-db\-instance](https://docs.aws.amazon.com/cli/latest/reference/rds/stop-db-instance.html) command with the following option: -+ `--db-instance-identifier` – the name of the DB instance\. - -**Example** - -``` -1. aws rds stop-db-instance --db-instance-identifier mydbinstance -``` - -### RDS API - -To stop a DB instance by using the Amazon RDS API, call the [StopDBInstance](https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_StopDBInstance.html) operation with the following parameter: -+ `DBInstanceIdentifier` – the name of the DB instance\. \ No newline at end of file diff --git a/doc_source/USER_Tagging.ARN.md b/doc_source/USER_Tagging.ARN.md deleted file mode 100644 index dc0a6e6..0000000 --- a/doc_source/USER_Tagging.ARN.md +++ /dev/null @@ -1,88 +0,0 @@ -# Working with Amazon Resource Names \(ARNs\) in Amazon RDS - -Resources created in Amazon Web Services are each uniquely identified with an Amazon Resource Name \(ARN\)\. For certain Amazon RDS operations, you must uniquely identify an Amazon RDS resource by specifying its ARN\. For example, when you create an RDS DB instance read replica, you must supply the ARN for the source DB instance\. - -## Constructing an ARN for Amazon RDS - -Resources created in Amazon Web Services are each uniquely identified with an Amazon Resource Name \(ARN\)\. You can construct an ARN for an Amazon RDS resource using the following syntax\. - - `arn:aws:rds::::` - -[\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.ARN.html) - -The following table shows the format that you should use when constructing an ARN for a particular Amazon RDS resource type\. - - -**** - -| Resource type | ARN format | -| --- | --- | -| DB instance | arn:aws:rds:**:**:db:** For example: 
arn:aws:rds:us-east-2:123456789012:db:my-mysql-instance-1
| -| DB cluster | arn:aws:rds:**:**:cluster:** For example: 
arn:aws:rds:us-east-2:123456789012:cluster:my-aurora-cluster-1
| -| Event subscription | arn:aws:rds:**:**:es:** For example: 
arn:aws:rds:us-east-2:123456789012:es:my-subscription
| -| DB option group | arn:aws:rds:**:**:og:** For example: 
arn:aws:rds:us-east-2:123456789012:og:my-og
| -| DB parameter group | arn:aws:rds:**:**:pg:** For example: 
arn:aws:rds:us-east-2:123456789012:pg:my-param-enable-logs
| -| DB cluster parameter group | arn:aws:rds:**:**:cluster\-pg:** For example: 
arn:aws:rds:us-east-2:123456789012:cluster-pg:my-cluster-param-timezone
| -| Reserved DB instance | arn:aws:rds:**:**:ri:** For example: 
arn:aws:rds:us-east-2:123456789012:ri:my-reserved-postgresql
| -| DB security group | arn:aws:rds:**:**:secgrp:** For example: 
arn:aws:rds:us-east-2:123456789012:secgrp:my-public
| -| Automated DB snapshot | arn:aws:rds:**:**:snapshot:rds:** For example: 
arn:aws:rds:us-east-2:123456789012:snapshot:rds:my-mysql-db-2019-07-22-07-23
| -| Automated DB cluster snapshot | arn:aws:rds:**:**:cluster\-snapshot:rds:** For example: 
arn:aws:rds:us-east-2:123456789012:cluster-snapshot:rds:my-aurora-cluster-2019-07-22-16-16
| -| Manual DB snapshot | arn:aws:rds:**:**:snapshot:** For example: 
arn:aws:rds:us-east-2:123456789012:snapshot:my-mysql-db-snap
| -| Manual DB cluster snapshot | arn:aws:rds:**:**:cluster\-snapshot:** For example: 
arn:aws:rds:us-east-2:123456789012:cluster-snapshot:my-aurora-cluster-snap
| -| DB subnet group | arn:aws:rds:**:**:subgrp:** For example: 
arn:aws:rds:us-east-2:123456789012:subgrp:my-subnet-10
| - -## Getting an existing ARN - -You can get the ARN of an RDS resource by using the AWS Management Console, AWS Command Line Interface \(AWS CLI\), or RDS API\. - -### Console - -To get an ARN from the AWS Management Console, navigate to the resource you want an ARN for, and view the details for that resource\. For example, you can get the ARN for a DB instance from the **Configuration** tab of the DB instance details, as shown following\. - -![\[DB instance ARN\]](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/images/DB-instance-arn.png) - -### AWS CLI - -To get an ARN from the AWS CLI for a particular RDS resource, you use the `describe` command for that resource\. The following table shows each AWS CLI command, and the ARN property used with the command to get an ARN\. - - -**** -[\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.ARN.html) - -For example, the following AWS CLI command gets the ARN for a DB instance\. - -**Example** -For Linux, macOS, or Unix: - -``` -aws rds describe-db-instances \ ---db-instance-identifier DBInstanceIdentifier \ ---region us-west-2 \ ---query "*[].{DBInstanceIdentifier:DBInstanceIdentifier,DBInstanceArn:DBInstanceArn}" -``` -For Windows: - -``` -aws rds describe-db-instances ^ ---db-instance-identifier DBInstanceIdentifier ^ ---region us-west-2 ^ ---query "*[].{DBInstanceIdentifier:DBInstanceIdentifier,DBInstanceArn:DBInstanceArn}" -``` -The output of that command is like the following: - -``` -[ - { - "DBInstanceArn": "arn:aws:rds:us-west-2:account_id:db:instance_id", - "DBInstanceIdentifier": "instance_id" - } -] -``` - -### RDS API - -To get an ARN for a particular RDS resource, you can call the following RDS API operations and use the ARN properties shown following\. - - -**** -[\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.ARN.html) \ No newline at end of file diff --git a/doc_source/USER_Tagging.md b/doc_source/USER_Tagging.md deleted file mode 100644 index b809304..0000000 --- a/doc_source/USER_Tagging.md +++ /dev/null @@ -1,361 +0,0 @@ -# Tagging Amazon RDS resources - -You can use Amazon RDS tags to add metadata to your Amazon RDS resources\. You can use the tags to add your own notations about database instances, snapshots, Aurora clusters, and so on\. Doing so can help you to document your Amazon RDS resources\. You can also use the tags with automated maintenance procedures\. - - In particular, you can use these tags with IAM policies\. You can use them to manage access to RDS resources and to control what actions can be applied to the RDS resources\. You can also use these tags to track costs by grouping expenses for similarly tagged resources\. - -You can tag the following Amazon RDS resources: -+ DB instances -+ DB clusters -+ Read replicas -+ DB snapshots -+ DB cluster snapshots -+ Reserved DB instances -+ Event subscriptions -+ DB option groups -+ DB parameter groups -+ DB cluster parameter groups -+ DB subnet groups -+ RDS Proxies -+ RDS Proxy endpoints -+ Blue/green deployments - -**Note** -Currently, you can't tag RDS Proxies and RDS Proxy endpoints by using the AWS Management Console\. - -**Topics** -+ [Overview of Amazon RDS resource tags](#Overview.Tagging) -+ [Using tags for access control with IAM](#Tagging.IAM) -+ [Using tags to produce detailed billing reports](#Tagging.Billing) -+ [Adding, listing, and removing tags](#Tagging.HowTo) -+ [Using the AWS Tag Editor](#Tagging.TagEditor) -+ [Copying tags to DB instance snapshots](#USER_Tagging.CopyTags) -+ [Tutorial: Use tags to specify which DB instances to stop](#Tagging.RDS.Autostop) -+ [Using tags to enable backups in AWS Backup](#Tagging.RDS.AWSBackup) - -## Overview of Amazon RDS resource tags - -An Amazon RDS tag is a name\-value pair that you define and associate with an Amazon RDS resource\. The name is referred to as the key\. Supplying a value for the key is optional\. You can use tags to assign arbitrary information to an Amazon RDS resource\. You can use a tag key, for example, to define a category, and the tag value might be an item in that category\. For example, you might define a tag key of "project" and a tag value of "Salix"\. In this case, these indicate that the Amazon RDS resource is assigned to the Salix project\. You can also use tags to designate Amazon RDS resources as being used for test or production by using a key such as `environment=test` or `environment=production`\. We recommend that you use a consistent set of tag keys to make it easier to track metadata associated with Amazon RDS resources\. - -In addition, you can use conditions in your IAM policies to control access to AWS resources based on the tags on that resource\. You can do this by using the global `aws:ResourceTag/tag-key` condition key\. For more information, see [Controlling access to AWS resources](https://docs.aws.amazon.com/IAM/latest/UserGuide/access_tags.html#access_tags_control-resources) in the *AWS Identity and Access Management User Guide*\. - -Each Amazon RDS resource has a tag set, which contains all the tags that are assigned to that Amazon RDS resource\. A tag set can contain as many as 50 tags, or it can be empty\. If you add a tag to an RDS resource with the same key as an existing resource tag, the new value overwrites the old\. - -AWS doesn't apply any semantic meaning to your tags; tags are interpreted strictly as character strings\. RDS can set tags on a DB instance or other RDS resources\. Tag setting depends on the options that you use when you create the resource\. For example, Amazon RDS might add a tag indicating that a DB instance is for production or for testing\. -+ The tag key is the required name of the tag\. The string value can be from 1 to 128 Unicode characters in length and cannot be prefixed with `aws:` or `rds:`\. The string can contain only the set of Unicode letters, digits, white space, '\_', '\.', ':', '/', '=', '\+', '\-', '@' \(Java regex: "^\(\[\\\\p\{L\}\\\\p\{Z\}\\\\p\{N\}\_\.:/=\+\\\\\-@\]\*\)$"\)\. -+ The tag value is an optional string value of the tag\. The string value can be from 1 to 256 Unicode characters in length\. The string can contain only the set of Unicode letters, digits, white space, '\_', '\.', ':', '/', '=', '\+', '\-', '@' \(Java regex: "^\(\[\\\\p\{L\}\\\\p\{Z\}\\\\p\{N\}\_\.:/=\+\\\\\-@\]\*\)$"\)\. - - Values do not have to be unique in a tag set and can be null\. For example, you can have a key\-value pair in a tag set of `project=Trinity` and `cost-center=Trinity`\. - -You can use the AWS Management Console, the AWS CLI, or the Amazon RDS API to add, list, and delete tags on Amazon RDS resources\. When using the CLI or API, make sure to provide the Amazon Resource Name \(ARN\) for the RDS resource to work with\. For more information about constructing an ARN, see [Constructing an ARN for Amazon RDS](USER_Tagging.ARN.md#USER_Tagging.ARN.Constructing)\. - -Tags are cached for authorization purposes\. Because of this, additions and updates to tags on Amazon RDS resources can take several minutes before they are available\. - -## Using tags for access control with IAM - - You can use tags with IAM policies to manage access to Amazon RDS resources\. You can also use tags to control what actions can be applied to the Amazon RDS resources\. - -For information on managing access to tagged resources with IAM policies, see [Identity and access management for Amazon RDS](UsingWithRDS.IAM.md)\. - -## Using tags to produce detailed billing reports - - You can also use tags to track costs by grouping expenses for similarly tagged resources\. - -Use tags to organize your AWS bill to reflect your own cost structure\. To do this, sign up to get your AWS account bill with tag key values included\. Then, to see the cost of combined resources, organize your billing information according to resources with the same tag key values\. For example, you can tag several resources with a specific application name, and then organize your billing information to see the total cost of that application across several services\. For more information, see [Using Cost Allocation Tags](https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/cost-alloc-tags.html) in the *AWS Billing User Guide*\. - -**Note** -You can add a tag to a snapshot, however, your bill will not reflect this grouping\. - -## Adding, listing, and removing tags - - The following procedures show how to perform typical tagging operations on resources related to DB instances\. - -### Console - -The process to tag an Amazon RDS resource is similar for all resources\. The following procedure shows how to tag an Amazon RDS DB instance\. - -**To add a tag to a DB instance** - -1. Sign in to the AWS Management Console and open the Amazon RDS console at [https://console\.aws\.amazon\.com/rds/](https://console.aws.amazon.com/rds/)\. - -1. In the navigation pane, choose **Databases**\. -**Note** -To filter the list of DB instances in the **Databases** pane, enter a text string for **Filter databases**\. Only DB instances that contain the string appear\. - -1. Choose the name of the DB instance that you want to tag to show its details\. - -1. In the details section, scroll down to the **Tags** section\. - -1. Choose **Add**\. The **Add tags** window appears\. -![\[Add tags window\]](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/images/RDSConsoleTagging5.png) - -1. Enter a value for **Tag key** and **Value**\. - -1. To add another tag, you can choose **Add another Tag** and enter a value for its **Tag key** and **Value**\. - - Repeat this step as many times as necessary\. - -1. Choose **Add**\. - -**To delete a tag from a DB instance** - -1. Sign in to the AWS Management Console and open the Amazon RDS console at [https://console\.aws\.amazon\.com/rds/](https://console.aws.amazon.com/rds/)\. - -1. In the navigation pane, choose **Databases**\. -**Note** -To filter the list of DB instances in the **Databases** pane, enter a text string in the **Filter databases** box\. Only DB instances that contain the string appear\. - -1. Choose the name of the DB instance to show its details\. - -1. In the details section, scroll down to the **Tags** section\. - -1. Choose the tag you want to delete\. -![\[Tags section\]](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/images/RDSConsoleTagging6.png) - -1. Choose **Delete**, and then choose **Delete** in the **Delete tags** window\. - -### AWS CLI - -You can add, list, or remove tags for a DB instance using the AWS CLI\. -+ To add one or more tags to an Amazon RDS resource, use the AWS CLI command [https://docs.aws.amazon.com/cli/latest/reference/rds/add-tags-to-resource.html](https://docs.aws.amazon.com/cli/latest/reference/rds/add-tags-to-resource.html)\. -+ To list the tags on an Amazon RDS resource, use the AWS CLI command [https://docs.aws.amazon.com/cli/latest/reference/rds/list-tags-for-resource.html](https://docs.aws.amazon.com/cli/latest/reference/rds/list-tags-for-resource.html)\. -+ To remove one or more tags from an Amazon RDS resource, use the AWS CLI command [https://docs.aws.amazon.com/cli/latest/reference/rds/remove-tags-from-resource.html](https://docs.aws.amazon.com/cli/latest/reference/rds/remove-tags-from-resource.html)\. - -To learn more about how to construct the required ARN, see [Constructing an ARN for Amazon RDS](USER_Tagging.ARN.md#USER_Tagging.ARN.Constructing)\. - -### RDS API - -You can add, list, or remove tags for a DB instance using the Amazon RDS API\. -+ To add a tag to an Amazon RDS resource, use the [https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_AddTagsToResource.html](https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_AddTagsToResource.html) operation\. -+ To list tags that are assigned to an Amazon RDS resource, use the [https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_ListTagsForResource.html](https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_ListTagsForResource.html)\. -+ To remove tags from an Amazon RDS resource, use the [https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_RemoveTagsFromResource.html](https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_RemoveTagsFromResource.html) operation\. - -To learn more about how to construct the required ARN, see [Constructing an ARN for Amazon RDS](USER_Tagging.ARN.md#USER_Tagging.ARN.Constructing)\. - -When working with XML using the Amazon RDS API, tags use the following schema: - -``` - 1. - 2. - 3. - 4. Project - 5. Trinity - 6. - 7. - 8. User - 9. Jones -10. -11. -12. -``` - -The following table provides a list of the allowed XML tags and their characteristics\. Values for Key and Value are case\-dependent\. For example, project=Trinity and PROJECT=Trinity are two distinct tags\. - - -**** -[\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.html) - -## Using the AWS Tag Editor - - You can browse and edit the tags on your RDS resources in the AWS Management Console by using the AWS Tag editor\. For more information, see [Tag Editor](https://docs.aws.amazon.com/ARG/latest/userguide/tag-editor.html) in the *AWS Resource Groups User Guide*\. - -## Copying tags to DB instance snapshots - -When you create or restore a DB instance, you can specify that the tags from the DB instance are copied to snapshots of the DB instance\. Copying tags ensures that the metadata for the DB snapshots matches that of the source DB instance\. It also ensures that any access policies for the DB snapshots also match those of the source DB instance\. - -You can specify that tags are copied to DB snapshots for the following actions: -+ Creating a DB instance\. -+ Restoring a DB instance\. -+ Creating a read replica\. -+ Copying a DB snapshot\. - -In most cases, tags aren't copied by default\. However, when you restore a DB instance from a DB snapshot, RDS checks whether you specify new tags\. If yes, the new tags are added to the restored DB instance\. If there are no new tags, RDS adds the tags from the source DB instance at the time of snapshot creation to the restored DB instance\. - -To prevent tags from source DB instances from being added to restored DB instances, we recommend that you specify new tags when restoring a DB instance\. - -**Note** -In some cases, you might include a value for the `--tag-key` parameter of the [create\-db\-snapshot](https://docs.aws.amazon.com/cli/latest/reference/rds/create-db-snapshot.html) AWS CLI command\. Or you might supply at least one tag to the [CreateDBSnapshot](https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_CreateDBSnapshot.html) API operation\. In these cases, RDS doesn't copy tags from the source DB instance to the new DB snapshot\. This functionality applies even if the source DB instance has the `--copy-tags-to-snapshot` \(`CopyTagsToSnapshot`\) option turned on\. -If you take this approach, you can create a copy of a DB instance from a DB snapshot\. This approach avoids adding tags that don't apply to the new DB instance\. You create your DB snapshot using the AWS CLI `create-db-snapshot` command \(or the `CreateDBSnapshot` RDS API operation\)\. After you create your DB snapshot, you can add tags as described later in this topic\. - -## Tutorial: Use tags to specify which DB instances to stop - - Suppose that you're creating a number of DB instances in a development or test environment\. You need to keep all of these DB instances for several days\. Some of the DB instances run tests overnight\. Other DB instances can be stopped overnight and started again the next day\. The following example shows how to assign a tag to those DB instances that are suitable to stop overnight\. Then the example shows how a script can detect which DB instances have that tag and then stop those DB instances\. In this example, the value portion of the key\-value pair doesn't matter\. The presence of the `stoppable` tag signifies that the DB instance has this user\-defined property\. - -**To specify which DB instances to stop** - -1. Determine the ARN of a DB instance that you want to designate as stoppable\. - - The commands and APIs for tagging work with ARNs\. That way, they can work seamlessly across AWS Regions, AWS accounts, and different types of resources that might have identical short names\. You can specify the ARN instead of the DB instance ID in CLI commands that operate on DB instances\. Substitute the name of your own DB instances for *dev\-test\-db\-instance*\. In subsequent commands that use ARN parameters, substitute the ARN of your own DB instance\. The ARN includes your own AWS account ID and the name of the AWS Region where your DB instance is located\. - - ``` - $ aws rds describe-db-instances --db-instance-identifier dev-test-db-instance \ - --query "*[].{DBInstance:DBInstanceArn}" --output text - arn:aws:rds:us-east-1:123456789102:db:dev-test-db-instance - ``` - -1. Add the tag `stoppable` to this DB instance\. - - You choose the name for this tag\. This approach means that you can avoid devising a naming convention that encodes all relevant information in names\. In such a convention, you might encode information in the DB instance name or names of other resources\. Because this example treats the tag as an attribute that is either present or absent, it omits the `Value=` part of the `--tags` parameter\. - - ``` - $ aws rds add-tags-to-resource \ - --resource-name arn:aws:rds:us-east-1:123456789102:db:dev-test-db-instance \ - --tags Key=stoppable - ``` - -1. Confirm that the tag is present in the DB instance\. - - These commands retrieve the tag information for the DB instance in JSON format and in plain tab\-separated text\. - - ``` - $ aws rds list-tags-for-resource \ - --resource-name arn:aws:rds:us-east-1:123456789102:db:dev-test-db-instance - { - "TagList": [ - { - "Key": "stoppable", - "Value": "" - - } - ] - } - aws rds list-tags-for-resource \ - --resource-name arn:aws:rds:us-east-1:123456789102:db:dev-test-db-instance --output text - TAGLIST stoppable - ``` - -1. To stop all the DB instances that are designated as `stoppable`, prepare a list of all your DB instances\. Loop through the list and check if each DB instance is tagged with the relevant attribute\. - - This Linux example uses shell scripting\. This scripting saves the list of DB instance ARNs to a temporary file and then performs CLI commands for each DB instance\. - - ``` - $ aws rds describe-db-instances --query "*[].[DBInstanceArn]" --output text >/tmp/db_instance_arns.lst - $ for arn in $(cat /tmp/db_instance_arns.lst) - do - match="$(aws rds list-tags-for-resource --resource-name $arn --output text | grep stoppable)" - if [[ ! -z "$match" ]] - then - echo "DB instance $arn is tagged as stoppable. Stopping it now." - # Note that you need to get the DB instance identifier from the ARN. - dbid=$(echo $arn | sed -e 's/.*://') - aws rds stop-db-instance --db-instance-identifier $dbid - fi - done - - DB instance arn:arn:aws:rds:us-east-1:123456789102:db:dev-test-db-instance is tagged as stoppable. Stopping it now. - { - "DBInstance": { - "DBInstanceIdentifier": "dev-test-db-instance", - "DBInstanceClass": "db.t3.medium", - ... - ``` - - You can run a script like this at the end of each day to make sure that nonessential DB instances are stopped\. You might also schedule a job using a utility such as `cron` to perform such a check each night\. For example, you might do this in case some DB instances were left running by mistake\. Here, you might fine\-tune the command that prepares the list of DB instances to check\. - -The following command produces a list of your DB instances, but only the ones in `available` state\. The script can ignore DB instances that are already stopped, because they will have different status values such as `stopped` or `stopping`\. - -``` -$ aws rds describe-db-instances \ - --query '*[].{DBInstanceArn:DBInstanceArn,DBInstanceStatus:DBInstanceStatus}|[?DBInstanceStatus == `available`]|[].{DBInstanceArn:DBInstanceArn}' \ - --output text -arn:aws:rds:us-east-1:123456789102:db:db-instance-2447 -arn:aws:rds:us-east-1:123456789102:db:db-instance-3395 -arn:aws:rds:us-east-1:123456789102:db:dev-test-db-instance -arn:aws:rds:us-east-1:123456789102:db:pg2-db-instance -``` - -**Tip** -You can use assigning tags and finding DB instances with those tags to reduce costs in other ways\. For example, take this scenario with DB instances used for development and testing\. In this case, you might designate some DB instances to be deleted at the end of each day\. Or you might designate them to have their DB instances changed to small DB instance classes during times of expected low usage\. - -## Using tags to enable backups in AWS Backup - -AWS Backup is a fully managed backup service that makes it easy to centralize and automate the backup of data across AWS services in the cloud and on premises\. You can manage backups of your Amazon RDS DB instances in AWS Backup\. - -To enable backups in AWS Backup, you use resource tagging to associate your DB instance with a backup plan\. - -This example assumes that you have already created a backup plan in AWS Backup\. You use exactly the same tag for your DB instance that is in your backup plan, as shown in the following figure\. - -![\[Image NOT FOUND\]](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/images/backup-plan-tag.png) - -For more information about AWS Backup, see the [https://docs.aws.amazon.com/aws-backup/latest/devguide](https://docs.aws.amazon.com/aws-backup/latest/devguide)\. - -You can assign a tag to a DB instance using the AWS Management Console, the AWS CLI, or the RDS API\. The following examples are for the console and CLI\. - -### Console - -**To assign a tag to a DB instance** - -1. Sign in to the AWS Management Console and open the Amazon RDS console at [https://console\.aws\.amazon\.com/rds/](https://console.aws.amazon.com/rds/)\. - -1. In the navigation pane, choose **Databases**\. - -1. Choose the link for the DB instance to which you want to assign a tag\. - -1. On the database details page, choose the **Tags** tab\. - -1. Under **Tags**, choose **Add tags**\. - -1. Under **Add tags**: - - 1. For **Tag key**, enter **BackupPlan**\. - - 1. For **Value**, enter **Test**\. - - 1. Choose **Add**\. - -The result is shown under **Tags**\. - -![\[Image NOT FOUND\]](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/images/tagged-instance.png) - -### CLI - -**To assign a tag to a DB instance** -+ Use the following CLI command: - - For Linux, macOS, or Unix: - - ``` - aws rds add-tags-to-resource \ - --resource-name arn:aws:rds:us-east-1:123456789012:db:new-orcl-db \ - --tags Key=BackupPlan,Value=Test - ``` - - For Windows: - - ``` - aws rds add-tags-to-resource ^ - --resource-name arn:aws:rds:us-east-1:123456789012:db:new-orcl-db ^ - --tags Key=BackupPlan,Value=Test - ``` - -The `add-tags-to-resource` CLI command returns no output\. - -**To confirm that the DB instance is tagged** -+ Use the following CLI command: - - For Linux, macOS, or Unix: - - ``` - aws rds list-tags-for-resource \ - --resource-name arn:aws:rds:us-east-1:123456789012:db:new-orcl-db - ``` - - For Windows: - - ``` - aws rds list-tags-for-resource ^ - --resource-name arn:aws:rds:us-east-1:123456789012:db:new-orcl-db - ``` - -The `list-tags-for-resource` CLI command returns the following output: - -``` -{ - "TagList": [ - { - "Key": "BackupPlan", - "Value": "Test" - } - ] -} -``` \ No newline at end of file diff --git a/doc_source/USER_UpgradeDBInstance.Maintenance.md b/doc_source/USER_UpgradeDBInstance.Maintenance.md deleted file mode 100644 index 3194d4b..0000000 --- a/doc_source/USER_UpgradeDBInstance.Maintenance.md +++ /dev/null @@ -1,322 +0,0 @@ -# Maintaining a DB instance - -Periodically, Amazon RDS performs maintenance on Amazon RDS resources\. Maintenance most often involves updates to the DB instance's underlying hardware, underlying operating system \(OS\), or database engine version\. Updates to the operating system most often occur for security issues and should be done as soon as possible\. - -Some maintenance items require that Amazon RDS take your DB instance offline for a short time\. Maintenance items that require a resource to be offline include required operating system or database patching\. Required patching is automatically scheduled only for patches that are related to security and instance reliability\. Such patching occurs infrequently \(typically once every few months\) and seldom requires more than a fraction of your maintenance window\. - -Deferred DB instance modifications that you have chosen not to apply immediately are also applied during the maintenance window\. For example, you might choose to change the DB instance class or parameter group during the maintenance window\. Such modifications that you specify using the **pending reboot** setting don't show up in the **Pending maintenance** list\. For information about modifying a DB instance, see [Modifying an Amazon RDS DB instance](Overview.DBInstance.Modifying.md)\. - -**Topics** -+ [Viewing pending maintenance](#USER_UpgradeDBInstance.Maintenance.Viewing) -+ [Applying updates for a DB instance](#USER_UpgradeDBInstance.OSUpgrades) -+ [Maintenance for Multi\-AZ deployments](#USER_UpgradeDBInstance.Maintenance.Multi-AZ) -+ [The Amazon RDS maintenance window](#Concepts.DBMaintenance) -+ [Adjusting the preferred DB instance maintenance window](#AdjustingTheMaintenanceWindow) -+ [Working with operating system updates](#OS_Updates) - -## Viewing pending maintenance - -View whether a maintenance update is available for your DB instance by using the RDS console, the AWS CLI, or the RDS API\. If an update is available, it is indicated in the **Maintenance** column for the DB instance on the Amazon RDS console, as shown following\. - -![\[Offline patch available\]](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/images/offlinepatchavailable.png) - -If no maintenance update is available for a DB instance, the column value is **none** for it\. - -If a maintenance update is available for a DB instance, the following column values are possible: -+ **required** – The maintenance action will be applied to the resource and can't be deferred indefinitely\. -+ **available** – The maintenance action is available, but it will not be applied to the resource automatically\. You can apply it manually\. -+ **next window** – The maintenance action will be applied to the resource during the next maintenance window\. -+ **In progress** – The maintenance action is in the process of being applied to the resource\. - -If an update is available, you can take one of the actions: -+ If the maintenance value is **next window**, defer the maintenance items by choosing **Defer upgrade** from **Actions**\. You can't defer a maintenance action if it has already started\. -+ Apply the maintenance items immediately\. -+ Schedule the maintenance items to start during your next maintenance window\. -+ Take no action\. - -To take an action, choose the DB instance to show its details, then choose **Maintenance & backups**\. The pending maintenance items appear\. - -![\[Pending maintenance items\]](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/images/offlinepatchavailabledetails.png) - -The maintenance window determines when pending operations start, but doesn't limit the total run time of these operations\. Maintenance operations aren't guaranteed to finish before the maintenance window ends, and can continue beyond the specified end time\. For more information, see [The Amazon RDS maintenance window](#Concepts.DBMaintenance)\. - -You can also view whether a maintenance update is available for your DB instance by running the [https://docs.aws.amazon.com/cli/latest/reference/rds/describe-pending-maintenance-actions.html](https://docs.aws.amazon.com/cli/latest/reference/rds/describe-pending-maintenance-actions.html) AWS CLI command\. - -## Applying updates for a DB instance - -With Amazon RDS, you can choose when to apply maintenance operations\. You can decide when Amazon RDS applies updates by using the RDS console, AWS Command Line Interface \(AWS CLI\), or RDS API\. - -### Console - -**To manage an update for a DB instance** - -1. Sign in to the AWS Management Console and open the Amazon RDS console at [https://console\.aws\.amazon\.com/rds/](https://console.aws.amazon.com/rds/)\. - -1. In the navigation pane, choose **Databases**\. - -1. Choose the DB instance that has a required update\. - -1. For **Actions**, choose one of the following: - + **Upgrade now** - + **Upgrade at next window** -**Note** -If you choose **Upgrade at next window** and later want to delay the update, you can choose **Defer upgrade**\. You can't defer a maintenance action if it has already started\. -To cancel a maintenance action, modify the DB instance and disable **Auto minor version upgrade**\. - -### AWS CLI - -To apply a pending update to a DB instance, use the [apply\-pending\-maintenance\-action](https://docs.aws.amazon.com/cli/latest/reference/rds/apply-pending-maintenance-action.html) AWS CLI command\. - -**Example** -For Linux, macOS, or Unix: - -``` -aws rds apply-pending-maintenance-action \ - --resource-identifier arn:aws:rds:us-west-2:001234567890:db:mysql-db \ - --apply-action system-update \ - --opt-in-type immediate -``` -For Windows: - -``` -aws rds apply-pending-maintenance-action ^ - --resource-identifier arn:aws:rds:us-west-2:001234567890:db:mysql-db ^ - --apply-action system-update ^ - --opt-in-type immediate -``` - -**Note** -To defer a maintenance action, specify `undo-opt-in` for `--opt-in-type`\. You can't specify `undo-opt-in` for `--opt-in-type` if the maintenance action has already started\. -To cancel a maintenance action, run the [modify\-db\-instance](https://docs.aws.amazon.com/cli/latest/reference/rds/modify-db-instance.html) AWS CLI command and specify `--no-auto-minor-version-upgrade`\. - -To return a list of resources that have at least one pending update, use the [describe\-pending\-maintenance\-actions](https://docs.aws.amazon.com/cli/latest/reference/rds/describe-pending-maintenance-actions.html) AWS CLI command\. - -**Example** -For Linux, macOS, or Unix: - -``` -aws rds describe-pending-maintenance-actions \ - --resource-identifier arn:aws:rds:us-west-2:001234567890:db:mysql-db -``` -For Windows: - -``` -aws rds describe-pending-maintenance-actions ^ - --resource-identifier arn:aws:rds:us-west-2:001234567890:db:mysql-db -``` - -You can also return a list of resources for a DB instance by specifying the `--filters` parameter of the `describe-pending-maintenance-actions` AWS CLI command\. The format for the `--filters` command is `Name=filter-name,Value=resource-id,...`\. - -The following are the accepted values for the `Name` parameter of a filter: -+ `db-instance-id` – Accepts a list of DB instance identifiers or Amazon Resource Names \(ARNs\)\. The returned list only includes pending maintenance actions for the DB instances identified by these identifiers or ARNs\. -+ `db-cluster-id` – Accepts a list of DB cluster identifiers or ARNs for Amazon Aurora\. The returned list only includes pending maintenance actions for the DB clusters identified by these identifiers or ARNs\. - -For example, the following example returns the pending maintenance actions for the `sample-instance1` and `sample-instance2` DB instances\. - -**Example** -For Linux, macOS, or Unix: - -``` -aws rds describe-pending-maintenance-actions \ - --filters Name=db-instance-id,Values=sample-instance1,sample-instance2 -``` -For Windows: - -``` -aws rds describe-pending-maintenance-actions ^ - --filters Name=db-instance-id,Values=sample-instance1,sample-instance2 -``` - -### RDS API - -To apply an update to a DB instance, call the Amazon RDS API [https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_ApplyPendingMaintenanceAction.html](https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_ApplyPendingMaintenanceAction.html) operation\. - -To return a list of resources that have at least one pending update, call the Amazon RDS API [https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_DescribePendingMaintenanceActions.html](https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_DescribePendingMaintenanceActions.html) operation\. - -## Maintenance for Multi\-AZ deployments - -Running a DB instance as a Multi\-AZ deployment can further reduce the impact of a maintenance event\. This result is because Amazon RDS applies operating system updates by following these steps: - -1. Perform maintenance on the standby\. - -1. Promote the standby to primary\. - -1. Perform maintenance on the old primary, which becomes the new standby\. - -If you upgrade the database engine for your DB instance in a Multi\-AZ deployment, Amazon RDS modifies both primary and secondary DB instances at the same time\. In this case, both the primary and secondary DB instances in the Multi\-AZ deployment are unavailable during the upgrade\. This operation causes downtime until the upgrade is complete\. The duration of the downtime varies based on the size of your DB instance\. - -If your DB instance runs RDS for MySQL or RDS for MariaDB, you can minimize the downtime required for an upgrade by using a blue/green deployment\. For more information, see [Using Amazon RDS Blue/Green Deployments for database updates](blue-green-deployments.md)\. If you upgrade an RDS for SQL Server DB instance in a Multi\-AZ deployment, then Amazon RDS performs rolling upgrades, so you have an outage only for the duration of a failover\. For more information, see [Multi\-AZ and in\-memory optimization considerations](USER_UpgradeDBInstance.SQLServer.md#USER_UpgradeDBInstance.SQLServer.MAZ)\. - -For more information about Multi\-AZ deployments, see [Configuring and managing a Multi\-AZ deployment](Concepts.MultiAZ.md)\. - -## The Amazon RDS maintenance window - -Every DB instance has a weekly maintenance window during which any system changes are applied\. Think of the maintenance window as an opportunity to control when modifications and software patching occur\. If a maintenance event is scheduled for a given week, it's initiated during the 30\-minute maintenance window you identify\. Most maintenance events also complete during the 30\-minute maintenance window, although larger maintenance events may take more than 30 minutes to complete\. - -The 30\-minute maintenance window is selected at random from an 8\-hour block of time per region\. If you don't specify a maintenance window when you create the DB instance, RDS assigns a 30\-minute maintenance window on a randomly selected day of the week\. - -RDS consumes some of the resources on your DB instance while maintenance is being applied\. You might observe a minimal effect on performance\. For a DB instance, on rare occasions, a Multi\-AZ failover might be required for a maintenance update to complete\. - -Following, you can find the time blocks for each region from which default maintenance windows are assigned\. - - -**** -[\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_UpgradeDBInstance.Maintenance.html) - -## Adjusting the preferred DB instance maintenance window - -The maintenance window should fall at the time of lowest usage and thus might need modification from time to time\. Your DB instance is unavailable during this time only if the system changes, such as a change in DB instance class, are being applied and require an outage\. Your DB instance is unavailable only for the minimum amount of time required to make the necessary changes\. - -In the following example, you adjust the preferred maintenance window for a DB instance\. - -For this example, we assume that a DB instance named *mydbinstance* exists and has a preferred maintenance window of "Sun:05:00\-Sun:06:00" UTC\. - -### Console - -**To adjust the preferred maintenance window** - -1. Sign in to the AWS Management Console and open the Amazon RDS console at [https://console\.aws\.amazon\.com/rds/](https://console.aws.amazon.com/rds/)\. - -1. In the navigation pane, choose **Databases**, and then select the DB instance that you want to modify\. - -1. Choose **Modify**\. The **Modify DB instance** page appears\. - -1. In the **Maintenance** section, update the maintenance window\. -**Note** -The maintenance window and the backup window for the DB instance cannot overlap\. If you enter a value for the maintenance window that overlaps the backup window, an error message appears\. - -1. Choose **Continue**\. - - On the confirmation page, review your changes\. - -1. To apply the changes to the maintenance window immediately, select **Apply immediately**\. - -1. Choose **Modify DB instance** to save your changes\. - - Alternatively, choose **Back** to edit your changes, or choose **Cancel** to cancel your changes\. - -### AWS CLI - -To adjust the preferred maintenance window, use the AWS CLI [https://docs.aws.amazon.com/cli/latest/reference/rds/modify-db-instance.html](https://docs.aws.amazon.com/cli/latest/reference/rds/modify-db-instance.html) command with the following parameters: -+ `--db-instance-identifier` -+ `--preferred-maintenance-window` - -**Example** -The following code example sets the maintenance window to Tuesdays from 4:00\-4:30AM UTC\. -For Linux, macOS, or Unix: - -``` -aws rds modify-db-instance \ ---db-instance-identifier mydbinstance \ ---preferred-maintenance-window Tue:04:00-Tue:04:30 -``` -For Windows: - -``` -aws rds modify-db-instance ^ ---db-instance-identifier mydbinstance ^ ---preferred-maintenance-window Tue:04:00-Tue:04:30 -``` - -### RDS API - -To adjust the preferred maintenance window, use the Amazon RDS API [https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_ModifyDBInstance.html](https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_ModifyDBInstance.html) operation with the following parameters: -+ `DBInstanceIdentifier` -+ `PreferredMaintenanceWindow` - -## Working with operating system updates - -RDS for MariaDB, RDS for MySQL, RDS for PostgreSQL, and RDS for Oracle DB instances occasionally require operating system updates\. Amazon RDS upgrades the operating system to a newer version to improve database performance and customers’ overall security posture\. Typically, the updates take about 10 minutes\. Operating system updates don't change the DB engine version or DB instance class of a DB instance\. - -Operating system updates can be either optional or mandatory: -+ An **optional update** can be applied at any time\. While these updates are optional, we recommend that you apply them periodically to keep your RDS fleet up to date\. RDS *does not* apply these updates automatically\. - - To be notified when a new, optional operating system patch becomes available, you can subscribe to [RDS\-EVENT\-0230](USER_Events.Messages.md#RDS-EVENT-0230) in the security patching event category\. For information about subscribing to RDS events, see [Subscribing to Amazon RDS event notification](USER_Events.Subscribing.md)\. -**Note** -`RDS-EVENT-0230` doesn't apply to operating system distribution upgrades\. -+ A **mandatory update** is required and has an apply date\. Plan to schedule your update before this apply date\. After the specified apply date, Amazon RDS automatically upgrades the operating system for your DB instance to the latest version during one of your assigned maintenance windows\. - -**Note** -Staying current on all optional and mandatory updates might be required to meet various compliance obligations\. We recommend that you apply all updates made available by RDS routinely during your maintenance windows\. - -You can use the AWS Management Console or the AWS CLI to get information about the type of operating system upgrade\. - -### Console - -**To determine whether an update is optional or mandatory using the AWS Management Console** - -1. Sign in to the AWS Management Console and open the Amazon RDS console at [https://console\.aws\.amazon\.com/rds/](https://console.aws.amazon.com/rds/)\. - -1. In the navigation pane, choose **Databases**, and then select the DB instance\. - -1. Choose **Maintenance & backups**\. - -1. In the **Pending maintenance** section, find the operating system update, and check the **Status** value\. - -In the AWS Management Console, an optional update has its maintenance **Status** set to **available** and doesn't have an **Apply date**, as shown in the following image\. - -![\[Optional operating system update.\]](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/images/os-update-optional.png) - -A mandatory update has its maintenance **Status** set to **required** and has an **Apply date**, as shown in the following image\. - -![\[Required operating system update.\]](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/images/os-update-required.png) - -### AWS CLI - -To get update information from the AWS CLI, use the [describe\-pending\-maintenance\-actions](https://docs.aws.amazon.com/cli/latest/reference/rds/describe-pending-maintenance-actions.html) command\. - -``` -aws rds describe-pending-maintenance-actions -``` - -A mandatory operating system update includes an `AutoAppliedAfterDate` value and a `CurrentApplyDate` value\. An optional operating system update doesn't include these values\. - -The following output shows a mandatory operating system update\. - -``` -{ - "ResourceIdentifier": "arn:aws:rds:us-east-1:123456789012:db:mydb1", - "PendingMaintenanceActionDetails": [ - { - "Action": "system-update", - "AutoAppliedAfterDate": "2022-08-31T00:00:00+00:00", - "CurrentApplyDate": "2022-08-31T00:00:00+00:00", - "Description": "New Operating System update is available" - } - ] -} -``` - -The following output shows an optional operating system update\. - -``` -{ - "ResourceIdentifier": "arn:aws:rds:us-east-1:123456789012:db:mydb2", - "PendingMaintenanceActionDetails": [ - { - "Action": "system-update", - "Description": "New Operating System update is available" - } - ] -} -``` - -### Availability of operating system updates - -Operating system updates are specific to DB engine version and DB instance class\. Therefore, DB instances receive or require updates at different times\. When an operating system update is available for your DB instance based on its engine version and instance class, the update appears in the console\. It can also be viewed by running AWS CLI [describe\-pending\-maintenance\-actions](https://docs.aws.amazon.com/cli/latest/reference/rds/describe-pending-maintenance-actions.html) command or by calling the RDS [DescribePendingMaintenanceActions](https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_DescribePendingMaintenanceActions.html) API operation\. If an update is available for your instance, you can update your operating system by following the instructions in [Applying updates for a DB instance](#USER_UpgradeDBInstance.OSUpgrades)\. - -### Mandatory operating system updates schedule - -We plan to use the following schedule for mandatory operating system updates\. The **Apply date** refers to when Amazon RDS *starts* to apply mandatory updates\. For each date in the table, the start time is 00:00 Universal Coordinated Time \(UTC\)\. - - -| DB engine | Apply date | -| --- | --- | -| RDS for MySQL | January 30, 2023 | -| RDS for MariaDB | January 30, 2023 | -| RDS for PostgreSQL | March 31, 2023 | - -**Note** -The dates in the table apply to customers who didn't experience mandatory operating system updates in 2022\. To confirm whether the mandatory operating system updates in 2023 impact you, check the **Pending maintenance** section in the console for operating system updates\. For more information, see the Console section under [Working with operating system updates](#OS_Updates)\. - -After the apply date, Amazon RDS automatically upgrades the operating system for your DB instances to the latest version in a subsequent maintenance window\. To avoid an automatic upgrade, we recommend that you schedule your update before the apply date\. \ No newline at end of file diff --git a/doc_source/USER_UpgradeDBInstance.MariaDB.md b/doc_source/USER_UpgradeDBInstance.MariaDB.md deleted file mode 100644 index 3d6b203..0000000 --- a/doc_source/USER_UpgradeDBInstance.MariaDB.md +++ /dev/null @@ -1,294 +0,0 @@ -# Upgrading the MariaDB DB engine - -When Amazon RDS supports a new version of a database engine, you can upgrade your DB instances to the new version\. There are two kinds of upgrades for MariaDB DB instances: major version upgrades and minor version upgrades\. - -*Major version upgrades* can contain database changes that are not backward\-compatible with existing applications\. As a result, you must manually perform major version upgrades of your DB instances\. You can initiate a major version upgrade by modifying your DB instance\. However, before you perform a major version upgrade, we recommend that you follow the instructions in [Major version upgrades for MariaDB](#USER_UpgradeDBInstance.MariaDB.Major)\. - -In contrast, *minor version upgrades* include only changes that are backward\-compatible with existing applications\. You can initiate a minor version upgrade manually by modifying your DB instance\. Or you can enable the **Auto minor version upgrade** option when creating or modifying a DB instance\. Doing so means that your DB instance is automatically upgraded after Amazon RDS tests and approves the new version\. For information about performing an upgrade, see [Upgrading a DB instance engine version](USER_UpgradeDBInstance.Upgrading.md)\. - -If your MariaDB DB instance is using read replicas, you must upgrade all of the read replicas before upgrading the source instance\. If your DB instance is in a Multi\-AZ deployment, both the writer and standby replicas are upgraded\. Your DB instance might not be available until the upgrade is complete\. - -For more information about MariaDB supported versions and version management, see [MariaDB on Amazon RDS versions](MariaDB.Concepts.VersionMgmt.md)\. - -Database engine upgrades require downtime\. The duration of the downtime varies based on the size of your DB instance\. - -**Tip** -You can minimize the downtime required for DB instance upgrade by using a blue/green deployment\. For more information, see [Using Amazon RDS Blue/Green Deployments for database updates](blue-green-deployments.md)\. - -**Topics** -+ [Overview of upgrading](#USER_UpgradeDBInstance.MariaDB.Overview) -+ [Major version upgrades for MariaDB](#USER_UpgradeDBInstance.MariaDB.Major) -+ [Upgrading a MariaDB DB instance](#USER_UpgradeDBInstance.MariaDB.Upgrading) -+ [Automatic minor version upgrades for MariaDB](#USER_UpgradeDBInstance.MariaDB.Minor) -+ [Using a read replica to reduce downtime when upgrading a MariaDB database](#USER_UpgradeDBInstance.MariaDB.ReducedDowntime) - -## Overview of upgrading - -When you use the AWS Management Console to upgrade a DB instance, it shows the valid upgrade targets for the DB instance\. You can also use the following AWS CLI command to identify the valid upgrade targets for a DB instance: - -For Linux, macOS, or Unix: - -``` -aws rds describe-db-engine-versions \ - --engine mariadb \ - --engine-version version-number \ - --query "DBEngineVersions[*].ValidUpgradeTarget[*].{EngineVersion:EngineVersion}" --output text -``` - -For Windows: - -``` -aws rds describe-db-engine-versions ^ - --engine mariadb ^ - --engine-version version-number ^ - --query "DBEngineVersions[*].ValidUpgradeTarget[*].{EngineVersion:EngineVersion}" --output text -``` - -For example, to identify the valid upgrade targets for a MariaDB version 10\.5\.17 DB instance, run the following AWS CLI command: - -For Linux, macOS, or Unix: - -``` -aws rds describe-db-engine-versions \ - --engine mariadb \ - --engine-version 10.5.17 \ - --query "DBEngineVersions[*].ValidUpgradeTarget[*].{EngineVersion:EngineVersion}" --output text -``` - -For Windows: - -``` -aws rds describe-db-engine-versions ^ - --engine mariadb ^ - --engine-version 10.5.17 ^ - --query "DBEngineVersions[*].ValidUpgradeTarget[*].{EngineVersion:EngineVersion}" --output text -``` - -Amazon RDS takes two DB snapshots during the upgrade process\. The first DB snapshot is of the DB instance before any upgrade changes have been made\. If the upgrade doesn't work for your databases, you can restore this snapshot to create a DB instance running the old version\. The second DB snapshot is taken when the upgrade completes\. RDS takes these snapshots regardless of whether AWS Backup manages the backups for the DB instance\. - -**Note** -Amazon RDS only takes DB snapshots if you have set the backup retention period for your DB instance to a number greater than 0\. To change your backup retention period, see [Modifying an Amazon RDS DB instance](Overview.DBInstance.Modifying.md)\. - -After the upgrade is complete, you can't revert to the previous version of the database engine\. If you want to return to the previous version, restore the first DB snapshot taken to create a new DB instance\. - -You control when to upgrade your DB instance to a new version supported by Amazon RDS\. This level of control helps you maintain compatibility with specific database versions and test new versions with your application before deploying in production\. When you are ready, you can perform version upgrades at the times that best fit your schedule\. - -If your DB instance is using read replication, you must upgrade all of the Read Replicas before upgrading the source instance\. - -If your DB instance is in a Multi\-AZ deployment, both the primary and standby DB instances are upgraded\. The primary and standby DB instances are upgraded at the same time and you will experience an outage until the upgrade is complete\. The time for the outage varies based on your database engine, engine version, and the size of your DB instance\. - -## Major version upgrades for MariaDB - -Major version upgrades can contain database changes that are not backward\-compatible with existing applications\. As a result, Amazon RDS doesn't apply major version upgrades automatically\. You must manually modify your DB instance\. We recommend that you thoroughly test any upgrade before applying it to your production instances\. - -Amazon RDS supports the following in\-place upgrades for major versions of the MariaDB database engine: -+ Any MariaDB version to MariaDB 10\.6 -+ MariaDB 10\.4 to MariaDB 10\.5 -+ MariaDB 10\.3 to MariaDB 10\.4 - -To perform a major version upgrade to MariaDB version 10\.6, you can upgrade directly from any MariaDB version to version 10\.6\. - -To perform a major version upgrade to a MariaDB version lower than 10\.6, upgrade to each major version in order\. For example, to upgrade from version 10\.3 to version 10\.5, upgrade in the following order: 10\.3 to 10\.4 and then 10\.4 to 10\.5\. - -If you are using a custom parameter group, and you perform a major version upgrade, you must specify either a default parameter group for the new DB engine version or create your own custom parameter group for the new DB engine version\. Associating the new parameter group with the DB instance requires a customer\-initiated database reboot after the upgrade completes\. The instance's parameter group status will show `pending-reboot` if the instance needs to be rebooted to apply the parameter group changes\. An instance's parameter group status can be viewed in the AWS Management Console or by using a "describe" call such as `describe-db-instances`\. - -## Upgrading a MariaDB DB instance - -For information about manually or automatically upgrading a MariaDB DB instance, see [Upgrading a DB instance engine version](USER_UpgradeDBInstance.Upgrading.md)\. - -## Automatic minor version upgrades for MariaDB - -If you specify the following settings when creating or modifying a DB instance, you can have your DB instance automatically upgraded\. -+ The **Auto minor version upgrade** setting is enabled\. -+ The **Backup retention period** setting is greater than 0\. - -In the AWS Management Console, these settings are under **Additional configuration**\. The following image shows the **Auto minor version upgrade** setting\. - -![\[Auto minor version upgrade setting\]](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/images/amvu.png) - -For more information about these settings, see [Settings for DB instances](Overview.DBInstance.Modifying.md#USER_ModifyInstance.Settings)\. - -For some RDS for MariaDB major versions in some AWS Regions, one minor version is designated by RDS as the automatic upgrade version\. After a minor version has been tested and approved by Amazon RDS, the minor version upgrade occurs automatically during your maintenance window\. RDS doesn't automatically set newer released minor versions as the automatic upgrade version\. Before RDS designates a newer automatic upgrade version, several criteria are considered, such as the following: -+ Known security issues -+ Bugs in the MariaDB community version -+ Overall fleet stability since the minor version was released - -You can use the following AWS CLI command to determine the current automatic minor upgrade target version for a specified MariaDB minor version in a specific AWS Region\. - -For Linux, macOS, or Unix: - -``` -aws rds describe-db-engine-versions \ ---engine mariadb \ ---engine-version minor-version \ ---region region \ ---query "DBEngineVersions[*].ValidUpgradeTarget[*].{AutoUpgrade:AutoUpgrade,EngineVersion:EngineVersion}" \ ---output text -``` - -For Windows: - -``` -aws rds describe-db-engine-versions ^ ---engine mariadb ^ ---engine-version minor-version ^ ---region region ^ ---query "DBEngineVersions[*].ValidUpgradeTarget[*].{AutoUpgrade:AutoUpgrade,EngineVersion:EngineVersion}" ^ ---output text -``` - -For example, the following AWS CLI command determines the automatic minor upgrade target for MariaDB minor version 10\.5\.16 in the US East \(Ohio\) AWS Region \(us\-east\-2\)\. - -For Linux, macOS, or Unix: - -``` -aws rds describe-db-engine-versions \ ---engine mariadb \ ---engine-version 10.5.16 \ ---region us-east-2 \ ---query "DBEngineVersions[*].ValidUpgradeTarget[*].{AutoUpgrade:AutoUpgrade,EngineVersion:EngineVersion}" \ ---output table -``` - -For Windows: - -``` -aws rds describe-db-engine-versions ^ ---engine mariadb ^ ---engine-version 10.5.16 ^ ---region us-east-2 ^ ---query "DBEngineVersions[*].ValidUpgradeTarget[*].{AutoUpgrade:AutoUpgrade,EngineVersion:EngineVersion}" ^ ---output table -``` - -Your output is similar to the following\. - -``` ----------------------------------- -| DescribeDBEngineVersions | -+--------------+-----------------+ -| AutoUpgrade | EngineVersion | -+--------------+-----------------+ -| True | 10.5.17 | -| False | 10.5.18 | -| False | 10.5.19 | -| False | 10.6.5 | -| False | 10.6.7 | -| False | 10.6.8 | -| False | 10.6.10 | -| False | 10.6.11 | -| False | 10.6.12 | -+--------------+-----------------+ -``` - -In this example, the `AutoUpgrade` value is `True` for MariaDB version 10\.5\.17\. So, the automatic minor upgrade target is MariaDB version 10\.5\.17, which is highlighted in the output\. - -A MariaDB DB instance is automatically upgraded during your maintenance window if the following criteria are met: -+ The **Auto minor version upgrade** setting is enabled\. -+ The **Backup retention period** setting is greater than 0\. -+ The DB instance is running a minor DB engine version that is less than the current automatic upgrade minor version\. - -For more information, see [Automatically upgrading the minor engine version](USER_UpgradeDBInstance.Upgrading.md#USER_UpgradeDBInstance.Upgrading.AutoMinorVersionUpgrades)\. - -## Using a read replica to reduce downtime when upgrading a MariaDB database - -In most cases, a blue/green deployment is the best option to reduce downtime when upgrading a MariaDB DB instance\. For more information, see [Using Amazon RDS Blue/Green Deployments for database updates](blue-green-deployments.md)\. - -If you can't use a blue/green deployment and your MariaDB DB instance is currently in use with a production application, you can use the following procedure to upgrade the database version for your DB instance\. This procedure can reduce the amount of downtime for your application\. - -By using a read replica, you can perform most of the maintenance steps ahead of time and minimize the necessary changes during the actual outage\. With this technique, you can test and prepare the new DB instance without making any changes to your existing DB instance\. - -The following procedure shows an example of upgrading from MariaDB version 10\.5 to MariaDB version 10\.6\. You can use the same general steps for upgrades to other major versions\. - -**To upgrade a MariaDB database while a DB instance is in use** - -1. Sign in to the AWS Management Console and open the Amazon RDS console at [https://console\.aws\.amazon\.com/rds/](https://console.aws.amazon.com/rds/)\. - -1. Create a read replica of your MariaDB 10\.5 DB instance\. This process creates an upgradable copy of your database\. Other read replicas of the DB instance might also exist\. - - 1. In the console, choose **Databases**, and then choose the DB instance that you want to upgrade\. - - 1. For **Actions**, choose **Create read replica**\. - - 1. Provide a value for **DB instance identifier** for your read replica and ensure that the **DB instance class** and other settings match your MariaDB 10\.5 DB instance\. - - 1. Choose **Create read replica**\. - -1. \(Optional\) When the read replica has been created and **Status** shows **Available**, convert the read replica into a Multi\-AZ deployment and enable backups\. - - By default, a read replica is created as a Single\-AZ deployment with backups disabled\. Because the read replica ultimately becomes the production DB instance, it is a best practice to configure a Multi\-AZ deployment and enable backups now\. - - 1. In the console, choose **Databases**, and then choose the read replica that you just created\. - - 1. Choose **Modify**\. - - 1. For **Multi\-AZ deployment**, choose **Create a standby instance**\. - - 1. For **Backup Retention Period**, choose a positive nonzero value, such as 3 days, and then choose **Continue**\. - - 1. For **Scheduling of modifications**, choose **Apply immediately**\. - - 1. Choose **Modify DB instance**\. - -1. When the read replica **Status** shows **Available**, upgrade the read replica to MariaDB 10\.6\. - - 1. In the console, choose **Databases**, and then choose the read replica that you just created\. - - 1. Choose **Modify**\. - - 1. For **DB engine version**, choose the MariaDB 10\.6 version to upgrade to, and then choose **Continue**\. - - 1. For **Scheduling of modifications**, choose **Apply immediately**\. - - 1. Choose **Modify DB instance** to start the upgrade\. - -1. When the upgrade is complete and **Status** shows **Available**, verify that the upgraded read replica is up\-to\-date with the source MariaDB 10\.5 DB instance\. To verify, connect to the read replica and run the `SHOW REPLICA STATUS` command\. If the `Seconds_Behind_Master` field is `0`, then replication is up\-to\-date\. -**Note** -Previous versions of MariaDB used `SHOW SLAVE STATUS` instead of `SHOW REPLICA STATUS`\. If you are using a MariaDB version before 10\.6, then use `SHOW SLAVE STATUS`\. - -1. \(Optional\) Create a read replica of your read replica\. - - If you want the DB instance to have a read replica after it is promoted to a standalone DB instance, you can create the read replica now\. - - 1. In the console, choose **Databases**, and then choose the read replica that you just upgraded\. - - 1. For **Actions**, choose **Create read replica**\. - - 1. Provide a value for **DB instance identifier** for your read replica and ensure that the **DB instance class** and other settings match your MariaDB 10\.5 DB instance\. - - 1. Choose **Create read replica**\. - -1. \(Optional\) Configure a custom DB parameter group for the read replica\. - - If you want the DB instance to use a custom parameter group after it is promoted to a standalone DB instance, you can create the DB parameter group now and associate it with the read replica\. - - 1. Create a custom DB parameter group for MariaDB 10\.6\. For instructions, see [Creating a DB parameter group](USER_WorkingWithDBInstanceParamGroups.md#USER_WorkingWithParamGroups.Creating)\. - - 1. Modify the parameters that you want to change in the DB parameter group you just created\. For instructions, see [Modifying parameters in a DB parameter group](USER_WorkingWithDBInstanceParamGroups.md#USER_WorkingWithParamGroups.Modifying)\. - - 1. In the console, choose **Databases**, and then choose the read replica\. - - 1. Choose **Modify**\. - - 1. For **DB parameter group**, choose the MariaDB 10\.6 DB parameter group you just created, and then choose **Continue**\. - - 1. For **Scheduling of modifications**, choose **Apply immediately**\. - - 1. Choose **Modify DB instance** to start the upgrade\. - -1. Make your MariaDB 10\.6 read replica a standalone DB instance\. -**Important** -When you promote your MariaDB 10\.6 read replica to a standalone DB instance, it is no longer a replica of your MariaDB 10\.5 DB instance\. We recommend that you promote your MariaDB 10\.6 read replica during a maintenance window when your source MariaDB 10\.5 DB instance is in read\-only mode and all write operations are suspended\. When the promotion is completed, you can direct your write operations to the upgraded MariaDB 10\.6 DB instance to ensure that no write operations are lost\. -In addition, we recommend that, before promoting your MariaDB 10\.6 read replica, you perform all necessary data definition language \(DDL\) operations on your MariaDB 10\.6 read replica\. An example is creating indexes\. This approach avoids negative effects on the performance of the MariaDB 10\.6 read replica after it has been promoted\. To promote a read replica, use the following procedure\. - - 1. In the console, choose **Databases**, and then choose the read replica that you just upgraded\. - - 1. For **Actions**, choose **Promote**\. - - 1. Choose **Yes** to enable automated backups for the read replica instance\. For more information, see [Working with backups](USER_WorkingWithAutomatedBackups.md)\. - - 1. Choose **Continue**\. - - 1. Choose **Promote Read Replica**\. - -1. You now have an upgraded version of your MariaDB database\. At this point, you can direct your applications to the new MariaDB 10\.6 DB instance\. \ No newline at end of file diff --git a/doc_source/USER_UpgradeDBInstance.MySQL.md b/doc_source/USER_UpgradeDBInstance.MySQL.md deleted file mode 100644 index 5d6463a..0000000 --- a/doc_source/USER_UpgradeDBInstance.MySQL.md +++ /dev/null @@ -1,404 +0,0 @@ -# Upgrading the MySQL DB engine - -When Amazon RDS supports a new version of a database engine, you can upgrade your DB instances to the new version\. There are two kinds of upgrades for MySQL DB instances: major version upgrades and minor version upgrades\. - -*Major version upgrades* can contain database changes that are not backward\-compatible with existing applications\. As a result, you must manually perform major version upgrades of your DB instances\. You can initiate a major version upgrade by modifying your DB instance\. However, before you perform a major version upgrade, we recommend that you follow the instructions in [Major version upgrades for MySQL](#USER_UpgradeDBInstance.MySQL.Major)\. - -In contrast, *minor version upgrades* include only changes that are backward\-compatible with existing applications\. You can initiate a minor version upgrade manually by modifying your DB instance\. Or you can enable the **Auto minor version upgrade** option when creating or modifying a DB instance\. Doing so means that your DB instance is automatically upgraded after Amazon RDS tests and approves the new version\. For information about performing an upgrade, see [Upgrading a DB instance engine version](USER_UpgradeDBInstance.Upgrading.md)\. - -If your MySQL DB instance is using read replicas, you must upgrade all of the read replicas before upgrading the source instance\. If your DB instance is in a Multi\-AZ deployment, both the primary and standby replicas are upgraded\. Your DB instance will not be available until the upgrade is complete\. - -Database engine upgrades require downtime\. The duration of the downtime varies based on the size of your DB instance\. - -**Tip** -You can minimize the downtime required for DB instance upgrade by using a blue/green deployment\. For more information, see [Using Amazon RDS Blue/Green Deployments for database updates](blue-green-deployments.md)\. - -**Topics** -+ [Overview of upgrading](#USER_UpgradeDBInstance.MySQL.Overview) -+ [Major version upgrades for MySQL](#USER_UpgradeDBInstance.MySQL.Major) -+ [Testing an upgrade](#USER_UpgradeDBInstance.MySQL.UpgradeTesting) -+ [Upgrading a MySQL DB instance](#USER_UpgradeDBInstance.MySQL.Upgrading) -+ [Automatic minor version upgrades for MySQL](#USER_UpgradeDBInstance.MySQL.Minor) -+ [Using a read replica to reduce downtime when upgrading a MySQL database](#USER_UpgradeDBInstance.MySQL.ReducedDowntime) - -## Overview of upgrading - -When you use the AWS Management Console to upgrade a DB instance, it shows the valid upgrade targets for the DB instance\. You can also use the following AWS CLI command to identify the valid upgrade targets for a DB instance: - -For Linux, macOS, or Unix: - -``` -aws rds describe-db-engine-versions \ - --engine mysql \ - --engine-version version-number \ - --query "DBEngineVersions[*].ValidUpgradeTarget[*].{EngineVersion:EngineVersion}" --output text -``` - -For Windows: - -``` -aws rds describe-db-engine-versions ^ - --engine mysql ^ - --engine-version version-number ^ - --query "DBEngineVersions[*].ValidUpgradeTarget[*].{EngineVersion:EngineVersion}" --output text -``` - -For example, to identify the valid upgrade targets for a MySQL version 8\.0\.28 DB instance, run the following AWS CLI command: - -For Linux, macOS, or Unix: - -``` -aws rds describe-db-engine-versions \ - --engine mysql \ - --engine-version 8.0.28 \ - --query "DBEngineVersions[*].ValidUpgradeTarget[*].{EngineVersion:EngineVersion}" --output text -``` - -For Windows: - -``` -aws rds describe-db-engine-versions ^ - --engine mysql ^ - --engine-version 8.0.28 ^ - --query "DBEngineVersions[*].ValidUpgradeTarget[*].{EngineVersion:EngineVersion}" --output text -``` - -Amazon RDS takes two DB snapshots during the upgrade process\. The first DB snapshot is of the DB instance before any upgrade changes have been made\. If the upgrade doesn't work for your databases, you can restore this snapshot to create a DB instance running the old version\. The second DB snapshot is taken when the upgrade completes\. RDS takes these snapshots regardless of whether AWS Backup manages the backups for the DB instance\. - -**Note** -Amazon RDS only takes DB snapshots if you have set the backup retention period for your DB instance to a number greater than 0\. To change your backup retention period, see [Modifying an Amazon RDS DB instance](Overview.DBInstance.Modifying.md)\. - -After the upgrade is complete, you can't revert to the previous version of the database engine\. If you want to return to the previous version, restore the first DB snapshot taken to create a new DB instance\. - -You control when to upgrade your DB instance to a new version supported by Amazon RDS\. This level of control helps you maintain compatibility with specific database versions and test new versions with your application before deploying in production\. When you are ready, you can perform version upgrades at the times that best fit your schedule\. - -If your DB instance is using read replication, you must upgrade all of the Read Replicas before upgrading the source instance\. - -If your DB instance is in a Multi\-AZ deployment, both the primary and standby DB instances are upgraded\. The primary and standby DB instances are upgraded at the same time and you will experience an outage until the upgrade is complete\. The time for the outage varies based on your database engine, engine version, and the size of your DB instance\. - -## Major version upgrades for MySQL - -Amazon RDS supports the following in\-place upgrades for major versions of the MySQL database engine: -+ MySQL 5\.6 to MySQL 5\.7 -+ MySQL 5\.7 to MySQL 8\.0 - -**Note** -You can only create MySQL version 5\.7 and 8\.0 DB instances with latest\-generation and current\-generation DB instance classes, in addition to the db\.m3 previous\-generation DB instance class\. -In some cases, you want to upgrade a MySQL version 5\.6 DB instance running on a previous\-generation DB instance class \(other than db\.m3\) to a MySQL version 5\.7 DB instance\. In these cases, first modify the DB instance to use a latest\-generation or current\-generation DB instance class\. After you do this, you can then modify the DB instance to use the MySQL version 5\.7 database engine\. For information on Amazon RDS DB instance classes, see [DB instance classes](Concepts.DBInstanceClass.md)\. - -**Topics** -+ [Overview of MySQL major version upgrades](#USER_UpgradeDBInstance.MySQL.Major.Overview) -+ [Upgrades to MySQL version 5\.7 might be slow](#USER_UpgradeDBInstance.MySQL.DateTime57) -+ [Prechecks for upgrades from MySQL 5\.7 to 8\.0](#USER_UpgradeDBInstance.MySQL.57to80Prechecks) -+ [Rollback after failure to upgrade from MySQL 5\.7 to 8\.0](#USER_UpgradeDBInstance.MySQL.Major.RollbackAfterFailure) - -### Overview of MySQL major version upgrades - -Major version upgrades can contain database changes that are not backward\-compatible with existing applications\. As a result, Amazon RDS doesn't apply major version upgrades automatically; you must manually modify your DB instance\. We recommend that you thoroughly test any upgrade before applying it to your production instances\. - -To perform a major version upgrade for a MySQL version 5\.6 DB instance on Amazon RDS to MySQL version 5\.7 or later, first perform any available OS updates\. After OS updates are complete, upgrade to each major version: 5\.6 to 5\.7 and then 5\.7 to 8\.0\. MySQL DB instances created before April 24, 2014, show an available OS update until the update has been applied\. For more information on OS updates, see [Applying updates for a DB instance](USER_UpgradeDBInstance.Maintenance.md#USER_UpgradeDBInstance.OSUpgrades)\. - -During a major version upgrade of MySQL, Amazon RDS runs the MySQL binary `mysql_upgrade` to upgrade tables, if necessary\. Also, Amazon RDS empties the `slow_log` and `general_log` tables during a major version upgrade\. To preserve log information, save the log contents before the major version upgrade\. - -MySQL major version upgrades typically complete in about 10 minutes\. Some upgrades might take longer because of the DB instance class size or because the instance doesn't follow certain operational guidelines in [Best practices for Amazon RDS](CHAP_BestPractices.md)\. If you upgrade a DB instance from the Amazon RDS console, the status of the DB instance indicates when the upgrade is complete\. If you upgrade using the AWS Command Line Interface \(AWS CLI\), use the [describe\-db\-instances](https://docs.aws.amazon.com/cli/latest/reference/rds/describe-db-instances.html) command and check the `Status` value\. - -### Upgrades to MySQL version 5\.7 might be slow - -MySQL version 5\.6\.4 introduced a new date and time format for the `datetime`, `time`, and `timestamp` columns that allows fractional components in date and time values\. When upgrading a DB instance to MySQL version 5\.7, MySQL forces the conversion of all date and time column types to the new format\. - -Because this conversion rebuilds your tables, it might take a considerable amount of time to complete the DB instance upgrade\. The forced conversion occurs for any DB instances that are running a version before MySQL version 5\.6\.4\. It also occurs for any DB instances that were upgraded from a version before MySQL version 5\.6\.4 to a version other than 5\.7\. - -If your DB instance runs a version before MySQL version 5\.6\.4, or was upgraded from a version before 5\.6\.4, we recommend an extra step\. In these cases, we recommend that you convert the `datetime`, `time`, and `timestamp` columns in your database before upgrading your DB instance to MySQL version 5\.7\. This conversion can significantly reduce the amount of time required to upgrade the DB instance to MySQL version 5\.7\. To upgrade your date and time columns to the new format, issue the `ALTER TABLE FORCE;` command for each table that contains date or time columns\. Because altering a table locks the table as read\-only, we recommend that you perform this update during a maintenance window\. - -To find all tables in your database that have `datetime`, `time`, or `timestamp` columns and create an `ALTER TABLE FORCE;` command for each table, use the following query\. - -``` -SET show_old_temporals = ON; - SELECT table_schema, table_name,column_name, column_type - FROM information_schema.columns - WHERE column_type LIKE '%/* 5.5 binary format */'; - SET show_old_temporals = OFF; -``` - -### Prechecks for upgrades from MySQL 5\.7 to 8\.0 - -MySQL 8\.0 includes a number of incompatibilities with MySQL 5\.7\. These incompatibilities can cause problems during an upgrade from MySQL 5\.7 to MySQL 8\.0\. So, some preparation might be required on your database for the upgrade to be successful\. The following is a general list of these incompatibilities: -+ There must be no tables that use obsolete data types or functions\. -+ There must be no orphan \*\.frm files\. -+ Triggers must not have a missing or empty definer or an invalid creation context\. -+ There must be no partitioned table that uses a storage engine that does not have native partitioning support\. -+ There must be no keyword or reserved word violations\. Some keywords might be reserved in MySQL 8\.0 that were not reserved previously\. - - For more information, see [Keywords and reserved words](https://dev.mysql.com/doc/refman/8.0/en/keywords.html) in the MySQL documentation\. -+ There must be no tables in the MySQL 5\.7 `mysql` system database that have the same name as a table used by the MySQL 8\.0 data dictionary\. -+ There must be no obsolete SQL modes defined in your `sql_mode` system variable setting\. -+ There must be no tables or stored procedures with individual `ENUM` or `SET` column elements that exceed 255 characters or 1020 bytes in length\. -+ Before upgrading to MySQL 8\.0\.13 or higher, there must be no table partitions that reside in shared InnoDB tablespaces\. -+ There must be no queries and stored program definitions from MySQL 8\.0\.12 or lower that use `ASC` or `DESC` qualifiers for `GROUP BY` clauses\. -+ Your MySQL 5\.7 installation must not use features that are not supported in MySQL 8\.0\. - - For more information, see [ Features removed in MySQL 8\.0](https://dev.mysql.com/doc/refman/8.0/en/mysql-nutshell.html#mysql-nutshell-removals) in the MySQL documentation\. -+ There must be no foreign key constraint names longer than 64 characters\. -+ For improved Unicode support, consider converting objects that use the `utf8mb3` charset to use the `utf8mb4` charset\. The `utf8mb3` character set is deprecated\. Also, consider using `utf8mb4` for character set references instead of `utf8`, because currently `utf8` is an alias for the `utf8mb3` charset\. - - For more information, see [ The utf8mb3 character set \(3\-byte UTF\-8 unicode encoding\)](https://dev.mysql.com/doc/refman/8.0/en/charset-unicode-utf8mb3.html) in the MySQL documentation\. - -When you start an upgrade from MySQL 5\.7 to 8\.0, Amazon RDS runs prechecks automatically to detect these incompatibilities\. For information about upgrading to MySQL 8\.0, see [Upgrading MySQL](https://dev.mysql.com/doc/refman/8.0/en/upgrading.html) in the MySQL documentation\. - -These prechecks are mandatory\. You can't choose to skip them\. The prechecks provide the following benefits: -+ They enable you to avoid unplanned downtime during the upgrade\. -+ If there are incompatibilities, Amazon RDS prevents the upgrade and provides a log for you to learn about them\. You can then use the log to prepare your database for the upgrade to MySQL 8\.0 by reducing the incompatibilities\. For detailed information about removing incompatibilities, see [ Preparing your installation for upgrade](https://dev.mysql.com/doc/refman/8.0/en/upgrade-prerequisites.html) in the MySQL documentation and [ Upgrading to MySQL 8\.0? here is what you need to know\.\.\.](https://mysqlserverteam.com/upgrading-to-mysql-8-0-here-is-what-you-need-to-know/) on the MySQL Server Blog\. - -The prechecks include some that are included with MySQL and some that were created specifically by the Amazon RDS team\. For information about the prechecks provided by MySQL, see [Upgrade checker utility](https://dev.mysql.com/doc/mysql-shell/8.0/en/mysql-shell-utilities-upgrade.html)\. - -The prechecks run before the DB instance is stopped for the upgrade, meaning that they don't cause any downtime when they run\. If the prechecks find an incompatibility, Amazon RDS automatically cancels the upgrade before the DB instance is stopped\. Amazon RDS also generates an event for the incompatibility\. For more information about Amazon RDS events, see [Working with Amazon RDS event notification](USER_Events.md)\. - -Amazon RDS records detailed information about each incompatibility in the log file `PrePatchCompatibility.log`\. In most cases, the log entry includes a link to the MySQL documentation for correcting the incompatibility\. For more information about viewing log files, see [Viewing and listing database log files](USER_LogAccess.Procedural.Viewing.md)\. - -Due to the nature of the prechecks, they analyze the objects in your database\. This analysis results in resource consumption and increases the time for the upgrade to complete\. - -**Note** -Amazon RDS runs all of these prechecks only for an upgrade from MySQL 5\.7 to MySQL 8\.0\. For an upgrade from MySQL 5\.6 to MySQL 5\.7, prechecks are limited to confirming that there are no orphan tables and that there is enough storage space to rebuild tables\. Prechecks aren't run for upgrades to releases lower than MySQL 5\.7\. - -### Rollback after failure to upgrade from MySQL 5\.7 to 8\.0 - -When you upgrade a DB instance from MySQL version 5\.7 to MySQL version 8\.0, the upgrade can fail\. In particular, it can fail if the data dictionary contains incompatibilities that weren't captured by the prechecks\. In this case, the database fails to start up successfully in the new MySQL 8\.0 version\. At this point, Amazon RDS rolls back the changes performed for the upgrade\. After the rollback, the MySQL DB instance is running MySQL version 5\.7\. When an upgrade fails and is rolled back, Amazon RDS generates an event with the event ID RDS\-EVENT\-0188\. - -Typically, an upgrade fails because there are incompatibilities in the metadata between the databases in your DB instance and the target MySQL version\. When an upgrade fails, you can view the details about these incompatibilities in the `upgradeFailure.log` file\. Resolve the incompatibilities before attempting to upgrade again\. - -During an unsuccessful upgrade attempt and rollback, your DB instance is restarted\. Any pending parameter changes are applied during the restart and persist after the rollback\. - -For more information about upgrading to MySQL 8\.0, see the following topics in the MySQL documentation: -+ [ Preparing Your Installation for Upgrade](https://dev.mysql.com/doc/refman/8.0/en/upgrade-prerequisites.html) -+ [ Upgrading to MySQL 8\.0? Here is what you need to know…](https://mysqlserverteam.com/upgrading-to-mysql-8-0-here-is-what-you-need-to-know/) - -**Note** -Currently, automatic rollback after upgrade failure is supported only for MySQL 5\.7 to 8\.0 major version upgrades\. - -## Testing an upgrade - -Before you perform a major version upgrade on your DB instance, thoroughly test your database for compatibility with the new version\. In addition, thoroughly test all applications that access the database for compatibility with the new version\. We recommend that you use the following procedure\. - -**To test a major version upgrade** - -1. Review the upgrade documentation for the new version of the database engine to see if there are compatibility issues that might affect your database or applications: - + [Changes in MySQL 5\.6](http://dev.mysql.com/doc/refman/5.6/en/upgrading-from-previous-series.html) - + [Changes in MySQL 5\.7](http://dev.mysql.com/doc/refman/5.7/en/upgrading-from-previous-series.html) - + [Changes in MySQL 8\.0](http://dev.mysql.com/doc/refman/8.0/en/upgrading-from-previous-series.html) - -1. If your DB instance is a member of a custom DB parameter group, create a new DB parameter group with your existing settings that is compatible with the new major version\. Specify the new DB parameter group when you upgrade your test instance, so your upgrade testing ensures that it works correctly\. For more information about creating a DB parameter group, see [Working with parameter groups](USER_WorkingWithParamGroups.md)\. - -1. Create a DB snapshot of the DB instance to be upgraded\. For more information, see [Creating a DB snapshot](USER_CreateSnapshot.md)\. - -1. Restore the DB snapshot to create a new test DB instance\. For more information, see [Restoring from a DB snapshot](USER_RestoreFromSnapshot.md)\. - -1. Modify this new test DB instance to upgrade it to the new version, using one of the methods detailed following\. If you created a new parameter group in step 2, specify that parameter group\. - -1. Evaluate the storage used by the upgraded instance to determine if the upgrade requires additional storage\. - -1. Run as many of your quality assurance tests against the upgraded DB instance as needed to ensure that your database and application work correctly with the new version\. Implement any new tests needed to evaluate the impact of any compatibility issues that you identified in step 1\. Test all stored procedures and functions\. Direct test versions of your applications to the upgraded DB instance\. - -1. If all tests pass, then perform the upgrade on your production DB instance\. We recommend that you don't allow write operations to the DB instance until you confirm that everything is working correctly\. - -## Upgrading a MySQL DB instance - -For information about manually or automatically upgrading a MySQL DB instance, see [Upgrading a DB instance engine version](USER_UpgradeDBInstance.Upgrading.md)\. - -## Automatic minor version upgrades for MySQL - -If you specify the following settings when creating or modifying a DB instance, you can have your DB instance automatically upgraded\. -+ The **Auto minor version upgrade** setting is enabled\. -+ The **Backup retention period** setting is greater than 0\. - -In the AWS Management Console, these settings are under **Additional configuration**\. The following image shows the **Auto minor version upgrade** setting\. - -![\[Auto minor version upgrade setting\]](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/images/amvu.png) - -For more information about these settings, see [Settings for DB instances](Overview.DBInstance.Modifying.md#USER_ModifyInstance.Settings)\. - -For some RDS for MySQL major versions in some AWS Regions, one minor version is designated by RDS as the automatic upgrade version\. After a minor version has been tested and approved by Amazon RDS, the minor version upgrade occurs automatically during your maintenance window\. RDS doesn't automatically set newer released minor versions as the automatic upgrade version\. Before RDS designates a newer automatic upgrade version, several criteria are considered, such as the following: -+ Known security issues -+ Bugs in the MySQL community version -+ Overall fleet stability since the minor version was released - -You can use the following AWS CLI command to determine the current automatic minor upgrade target version for a specified MySQL minor version in a specific AWS Region\. - -For Linux, macOS, or Unix: - -``` -aws rds describe-db-engine-versions \ ---engine mysql \ ---engine-version minor-version \ ---region region \ ---query "DBEngineVersions[*].ValidUpgradeTarget[*].{AutoUpgrade:AutoUpgrade,EngineVersion:EngineVersion}" \ ---output text -``` - -For Windows: - -``` -aws rds describe-db-engine-versions ^ ---engine mysql ^ ---engine-version minor-version ^ ---region region ^ ---query "DBEngineVersions[*].ValidUpgradeTarget[*].{AutoUpgrade:AutoUpgrade,EngineVersion:EngineVersion}" ^ ---output text -``` - -For example, the following AWS CLI command determines the automatic minor upgrade target for MySQL minor version 8\.0\.11 in the US East \(Ohio\) AWS Region \(us\-east\-2\)\. - -For Linux, macOS, or Unix: - -``` -aws rds describe-db-engine-versions \ ---engine mysql \ ---engine-version 8.0.11 \ ---region us-east-2 \ ---query "DBEngineVersions[*].ValidUpgradeTarget[*].{AutoUpgrade:AutoUpgrade,EngineVersion:EngineVersion}" \ ---output table -``` - -For Windows: - -``` -aws rds describe-db-engine-versions ^ ---engine mysql ^ ---engine-version 8.0.11 ^ ---region us-east-2 ^ ---query "DBEngineVersions[*].ValidUpgradeTarget[*].{AutoUpgrade:AutoUpgrade,EngineVersion:EngineVersion}" ^ ---output table -``` - -Your output is similar to the following\. - -``` ----------------------------------- -| DescribeDBEngineVersions | -+--------------+-----------------+ -| AutoUpgrade | EngineVersion | -+--------------+-----------------+ -| False | 8.0.15 | -| False | 8.0.16 | -| False | 8.0.17 | -| False | 8.0.19 | -| False | 8.0.20 | -| False | 8.0.21 | -| True | 8.0.23 | -| False | 8.0.25 | -+--------------+-----------------+ -``` - -In this example, the `AutoUpgrade` value is `True` for MySQL version 8\.0\.23\. So, the automatic minor upgrade target is MySQL version 8\.0\.23, which is highlighted in the output\. - -A MySQL DB instance is automatically upgraded during your maintenance window if the following criteria are met: -+ The **Auto minor version upgrade** setting is enabled\. -+ The **Backup retention period** setting is greater than 0\. -+ The DB instance is running a minor DB engine version that is less than the current automatic upgrade minor version\. - -For more information, see [Automatically upgrading the minor engine version](USER_UpgradeDBInstance.Upgrading.md#USER_UpgradeDBInstance.Upgrading.AutoMinorVersionUpgrades)\. - -## Using a read replica to reduce downtime when upgrading a MySQL database - -In most cases, a blue/green deployment is the best option to reduce downtime when upgrading a MySQL DB instance\. For more information, see [Using Amazon RDS Blue/Green Deployments for database updates](blue-green-deployments.md)\. - -If you can't use a blue/green deployment and your MySQL DB instance is currently in use with a production application, you can use the following procedure to upgrade the database version for your DB instance\. This procedure can reduce the amount of downtime for your application\. - -By using a read replica, you can perform most of the maintenance steps ahead of time and minimize the necessary changes during the actual outage\. With this technique, you can test and prepare the new DB instance without making any changes to your existing DB instance\. - -The following procedure shows an example of upgrading from MySQL version 5\.7 to MySQL version 8\.0\. You can use the same general steps for upgrades to other major versions\. - -**Note** -When you are upgrading from MySQL version 5\.7 to MySQL version 8\.0, complete the prechecks before performing the upgrade\. For more information, see [Prechecks for upgrades from MySQL 5\.7 to 8\.0](#USER_UpgradeDBInstance.MySQL.57to80Prechecks)\. - -**To upgrade a MySQL database while a DB instance is in use** - -1. Sign in to the AWS Management Console and open the Amazon RDS console at [https://console\.aws\.amazon\.com/rds/](https://console.aws.amazon.com/rds/)\. - -1. Create a read replica of your MySQL 5\.7 DB instance\. This process creates an upgradable copy of your database\. Other read replicas of the DB instance might also exist\. - - 1. In the console, choose **Databases**, and then choose the DB instance that you want to upgrade\. - - 1. For **Actions**, choose **Create read replica**\. - - 1. Provide a value for **DB instance identifier** for your read replica and ensure that the **DB instance class** and other settings match your MySQL 5\.7 DB instance\. - - 1. Choose **Create read replica**\. - -1. \(Optional\) When the read replica has been created and **Status** shows **Available**, convert the read replica into a Multi\-AZ deployment and enable backups\. - - By default, a read replica is created as a Single\-AZ deployment with backups disabled\. Because the read replica ultimately becomes the production DB instance, it is a best practice to configure a Multi\-AZ deployment and enable backups now\. - - 1. In the console, choose **Databases**, and then choose the read replica that you just created\. - - 1. Choose **Modify**\. - - 1. For **Multi\-AZ deployment**, choose **Create a standby instance**\. - - 1. For **Backup Retention Period**, choose a positive nonzero value, such as 3 days, and then choose **Continue**\. - - 1. For **Scheduling of modifications**, choose **Apply immediately**\. - - 1. Choose **Modify DB instance**\. - -1. When the read replica **Status** shows **Available**, upgrade the read replica to MySQL 8\.0: - - 1. In the console, choose **Databases**, and then choose the read replica that you just created\. - - 1. Choose **Modify**\. - - 1. For **DB engine version**, choose the MySQL 8\.0 version to upgrade to, and then choose **Continue**\. - - 1. For **Scheduling of modifications**, choose **Apply immediately**\. - - 1. Choose **Modify DB instance** to start the upgrade\. - -1. When the upgrade is complete and **Status** shows **Available**, verify that the upgraded read replica is up\-to\-date with the source MySQL 5\.7 DB instance\. To verify, connect to the read replica and run the `SHOW REPLICA STATUS` command\. If the `Seconds_Behind_Master` field is `0`, then replication is up\-to\-date\. -**Note** -Previous versions of MySQL used `SHOW SLAVE STATUS` instead of `SHOW REPLICA STATUS`\. If you are using a MySQL version before 8\.0\.23, then use `SHOW SLAVE STATUS`\. - -1. \(Optional\) Create a read replica of your read replica\. - - If you want the DB instance to have a read replica after it is promoted to a standalone DB instance, you can create the read replica now\. - - 1. In the console, choose **Databases**, and then choose the read replica that you just upgraded\. - - 1. For **Actions**, choose **Create read replica**\. - - 1. Provide a value for **DB instance identifier** for your read replica and ensure that the **DB instance class** and other settings match your MySQL 5\.7 DB instance\. - - 1. Choose **Create read replica**\. - -1. \(Optional\) Configure a custom DB parameter group for the read replica\. - - If you want the DB instance to use a custom parameter group after it is promoted to a standalone DB instance, you can create the DB parameter group now and associate it with the read replica\. - - 1. Create a custom DB parameter group for MySQL 8\.0\. For instructions, see [Creating a DB parameter group](USER_WorkingWithDBInstanceParamGroups.md#USER_WorkingWithParamGroups.Creating)\. - - 1. Modify the parameters that you want to change in the DB parameter group you just created\. For instructions, see [Modifying parameters in a DB parameter group](USER_WorkingWithDBInstanceParamGroups.md#USER_WorkingWithParamGroups.Modifying)\. - - 1. In the console, choose **Databases**, and then choose the read replica\. - - 1. Choose **Modify**\. - - 1. For **DB parameter group**, choose the MySQL 8\.0 DB parameter group you just created, and then choose **Continue**\. - - 1. For **Scheduling of modifications**, choose **Apply immediately**\. - - 1. Choose **Modify DB instance** to start the upgrade\. - -1. Make your MySQL 8\.0 read replica a standalone DB instance\. -**Important** -When you promote your MySQL 8\.0 read replica to a standalone DB instance, it is no longer a replica of your MySQL 5\.7 DB instance\. We recommend that you promote your MySQL 8\.0 read replica during a maintenance window when your source MySQL 5\.7 DB instance is in read\-only mode and all write operations are suspended\. When the promotion is completed, you can direct your write operations to the upgraded MySQL 8\.0 DB instance to ensure that no write operations are lost\. -In addition, we recommend that, before promoting your MySQL 8\.0 read replica, you perform all necessary data definition language \(DDL\) operations on your MySQL 8\.0 read replica\. An example is creating indexes\. This approach avoids negative effects on the performance of the MySQL 8\.0 read replica after it has been promoted\. To promote a read replica, use the following procedure\. - - 1. In the console, choose **Databases**, and then choose the read replica that you just upgraded\. - - 1. For **Actions**, choose **Promote**\. - - 1. Choose **Yes** to enable automated backups for the read replica instance\. For more information, see [Working with backups](USER_WorkingWithAutomatedBackups.md)\. - - 1. Choose **Continue**\. - - 1. Choose **Promote Read Replica**\. - -1. You now have an upgraded version of your MySQL database\. At this point, you can direct your applications to the new MySQL 8\.0 DB instance\. \ No newline at end of file diff --git a/doc_source/USER_UpgradeDBInstance.Oracle.Major.md b/doc_source/USER_UpgradeDBInstance.Oracle.Major.md deleted file mode 100644 index 0247ff3..0000000 --- a/doc_source/USER_UpgradeDBInstance.Oracle.Major.md +++ /dev/null @@ -1,40 +0,0 @@ -# Oracle major version upgrades - -To perform a major version upgrade, modify the DB instance manually\. Major version upgrades don't occur automatically\. - -## Supported versions for major upgrades - -Amazon RDS supports the following major version upgrades\. - - -**** - -| Current version | Upgrade supported | -| --- | --- | -| 19\.0\.0\.0 using the CDB architecture | 21\.0\.0\.0 | - -A major version upgrade of Oracle Database must upgrade to a Release Update \(RU\) that was released in the same month or later\. Major version downgrades aren't supported for any Oracle Database versions\. - -## Supported instance classes for major upgrades - -Your current Oracle DB instance might run on a DB instance class that isn't supported for the version to which you are upgrading\. In this case, before you upgrade, migrate the DB instance to a supported DB instance class\. For more information about the supported DB instance classes for each version and edition of Amazon RDS for Oracle, see [DB instance classes](Concepts.DBInstanceClass.md)\. - -## Gathering statistics before major upgrades - -Before you perform a major version upgrade, Oracle recommends that you gather optimizer statistics on the DB instance that you are upgrading\. This action can reduce DB instance downtime during the upgrade\. - -To gather optimizer statistics, connect to the DB instance as the master user, and run the `DBMS_STATS.GATHER_DICTIONARY_STATS` procedure, as in the following example\. - -``` -EXEC DBMS_STATS.GATHER_DICTIONARY_STATS; -``` - -For more information, see [ Gathering optimizer statistics to decrease Oracle database downtime](https://docs.oracle.com/en/database/oracle/oracle-database/12.2/upgrd/database-preparation-tasks-to-complete-before-upgrades.html#GUID-6719608D-F145-403C-8CCE-CF23120BCC2A) in the Oracle documentation\. - -## Allowing major upgrades - -A major engine version upgrade might be incompatible with your application\. The upgrade is irreversible\. If you specify a major version for the EngineVersion parameter that is different from the current major version, you must allow major version upgrades\. - -If you upgrade a major version using the CLI command [modify\-db\-instance](https://docs.aws.amazon.com/cli/latest/reference/rds/modify-db-instance.html), specify `--allow-major-version-upgrade`\. This setting isn't persistent, so you must specify `--allow-major-version-upgrade` whenever you perform a major upgrade\. This parameter has no impact on upgrades of minor engine versions\. For more information, see [Upgrading a DB instance engine version](USER_UpgradeDBInstance.Upgrading.md)\. - -If you upgrade a major version using the console, you don't need to choose an option to allow the upgrade\. Instead, the console displays a warning that major upgrades are irreversible\. \ No newline at end of file diff --git a/doc_source/USER_UpgradeDBInstance.Oracle.Minor.md b/doc_source/USER_UpgradeDBInstance.Oracle.Minor.md deleted file mode 100644 index f8b7112..0000000 --- a/doc_source/USER_UpgradeDBInstance.Oracle.Minor.md +++ /dev/null @@ -1,87 +0,0 @@ -# Oracle minor version upgrades - -A minor version upgrade applies an Oracle Database Patch Set Update \(PSU\) or Release Update \(RU\) to a major engine version\. For example, if your DB instance runs major version Oracle Database 21c and minor version 21\.0\.0\.0\.ru\-2022\-07\.rur\-2022\-07\.r1, you can upgrade your upgrade to minor version 21\.0\.0\.0\.ru\-2022\-10\.rur\-2022\-10\.r1\. Typically, a new minor version is available every quarter\. - -**Note** -RDS for Oracle doesn't support minor version downgrades\. - -You can upgrade your DB engine to a minor version manually or automatically\. To learn how to upgrade manually, see [Manually upgrading the engine version](USER_UpgradeDBInstance.Upgrading.md#USER_UpgradeDBInstance.Upgrading.Manual)\. To learn how to configure automatic upgrades, see [Automatically upgrading the minor engine version](USER_UpgradeDBInstance.Upgrading.md#USER_UpgradeDBInstance.Upgrading.AutoMinorVersionUpgrades)\. - -Whether you upgrade manually or automatically, a minor version upgrade entails downtime\. Keep this in mind when planning your upgrades\. - -## Turning on automatic minor version upgrades for Oracle - -In an automatic minor version upgrade, RDS applies the latest available minor version to your Oracle database without manual intervention\. An Amazon RDS for Oracle DB instance schedules your upgrade during the next maintenance window in the following circumstances: -+ Your DB instance has the **Auto minor version upgrade** option turned on\. -+ Your DB instance isn't already running the latest minor DB engine version\. -+ Your DB instance doesn't already have a pending upgrade scheduled\. - -To learn how to turn on automatic upgrades, see [Automatically upgrading the minor engine version](USER_UpgradeDBInstance.Upgrading.md#USER_UpgradeDBInstance.Upgrading.AutoMinorVersionUpgrades)\. - -## Before an automatic minor version upgrade for Oracle is scheduled - -RDS publishes an advance notice before it begins scheduling automatic upgrades\. You can find the notification in the **Maintenance & backups** tab of the database details page\. The message has the following format: - -``` -An automatic minor version upgrade to engine version will become available on availability-date and should be applied during a subsequent maintenance window. -``` - -The *availability\-date* in the preceding message is the date when RDS starts scheduling upgrades for DB instances in your AWS Region\. It is not the date on which the upgrade of your DB instance is scheduled to occur\. - -You can also get the upgrade availability date by using the `describe-pending-maintenance-actions` command in the AWS CLI, as shown in the following example: - -``` -aws rds describe-pending-maintenance-actions - -{ - "PendingMaintenanceActions": [ - { - "ResourceIdentifier": "arn:aws:rds:us-east-1:123456789012:db:orclinst1", - "PendingMaintenanceActionDetails": [ - { - "Action": "db-upgrade", - "Description": "Automatic minor version upgrade to 21.0.0.0.ru-2022-10.rur-2022-10.r1", - "CurrentApplyDate": "2022-12-02T08:10:00Z", - "OptInStatus": "next-maintenance" - } - ] - }, ... -``` - -For more information about [describe\-pending\-maintenance\-actions](https://docs.aws.amazon.com/cli/latest/reference/rds/describe-pending-maintenance-actions.html), see the *AWS CLI Command Reference*\. - -## When RDS schedules automatic minor version upgrades for Oracle - -When the availability date for automatic upgrades arrives, RDS begins scheduling upgrades\. For most AWS Regions, RDS schedules your upgrade to the latest quarterly RU approximately four to six weeks after the availability date\. The scheduled date varies depending on the AWS Region and other factors\. For more information about RUs and RURs, see [https://docs.aws.amazon.com/AmazonRDS/latest/OracleReleaseNotes/Welcome.html](https://docs.aws.amazon.com/AmazonRDS/latest/OracleReleaseNotes/Welcome.html)\. - -When RDS schedules the upgrade, the following notification appears in the **Maintenance & backups** tab of the database details page: - -``` -Automatic minor version upgrade to engine-version -``` - -The preceding message indicates that RDS has scheduled your DB engine to be upgraded in the next maintenance window\. - -## Managing an automatic minor version upgrade for Oracle - -When a new minor version becomes available, you can upgrade your DB instance to this version manually\. The following example upgrades the DB instance named `orclinst1` immediately: - -``` -aws rds apply-pending-maintenance-action \ - --resource-identifier arn:aws:rds:us-east-1:123456789012:db:orclinst1 \ - --apply-action db-upgrade \ - --opt-in-type immediate -``` - -To opt out of an automatic minor version upgrade that hasn't been scheduled yet, set `opt-in-type` to `undo-opt-in`, as in the following example: - -``` -aws rds apply-pending-maintenance-action \ - --resource-identifier arn:aws:rds:us-east-1:123456789012:db:orclinst1 \ - --apply-action db-upgrade \ - --opt-in-type undo-opt-in -``` - -If RDS has already scheduled an upgrade for your DB instance, you can't use `apply-pending-maintenance-action` to cancel it\. But you can modify your DB instance and turn off the automatic minor upgrade feature, which then unschedules the upgrade\. - -To learn how to turn off automatic minor version upgrades, see [Automatically upgrading the minor engine version](USER_UpgradeDBInstance.Upgrading.md#USER_UpgradeDBInstance.Upgrading.AutoMinorVersionUpgrades)\. For more information about [apply\-pending\-maintenance\-action](https://docs.aws.amazon.com/cli/latest/reference/rds/apply-pending-maintenance-action.html), see the *AWS CLI Command Reference*\. \ No newline at end of file diff --git a/doc_source/USER_UpgradeDBInstance.Oracle.OGPG.md b/doc_source/USER_UpgradeDBInstance.Oracle.OGPG.md deleted file mode 100644 index ace4472..0000000 --- a/doc_source/USER_UpgradeDBInstance.Oracle.OGPG.md +++ /dev/null @@ -1,70 +0,0 @@ -# Considerations for Oracle DB upgrades - -Before you upgrade your Oracle instance, review the following information\. - -**Topics** -+ [Oracle Multitenant considerations](#USER_UpgradeDBInstance.Oracle.multi) -+ [Option group considerations](#USER_UpgradeDBInstance.Oracle.OGPG.OG) -+ [Parameter group considerations](#USER_UpgradeDBInstance.Oracle.OGPG.PG) -+ [Time zone considerations](#USER_UpgradeDBInstance.Oracle.OGPG.DST) - -## Oracle Multitenant considerations - -The following table describes the architectures supported in different releases\. - - -| Oracle Database release | RDS support status | Architecture | -| --- | --- | --- | -| Oracle Database 21c | Supported | CDB only | -| Oracle Database 19c | Supported | CDB or non\-CDB | -| Oracle Database 12c Release 2 \(12\.2\) | Desupported | Non\-CDB only | -| Oracle Database 12c Release 1 \(12\.1\) | Desupported | Non\-CDB only | - -The following table describes supported and unsupported upgrade paths\. - - -| Upgrade path | Supported? | -| --- | --- | -| Non\-CDB to non\-CDB | Yes | -| CDB to CDB | Yes | -| Non\-CDB to CDB | No | -| CDB to non\-CDB | No | - -For more information about Oracle Multitenant in RDS for Oracle, see [Overview of RDS for Oracle CDBs](oracle-multitenant.md#Oracle.Concepts.single-tenant)\. - -## Option group considerations - -If your DB instance uses a custom option group, sometimes Amazon RDS can't automatically assign a new option group\. For example, this situation occurs when you upgrade to a new major version\. In such cases, specify a new option group when you upgrade\. We recommend that you create a new option group, and add the same options to it as in your existing custom option group\. - -For more information, see [Creating an option group](USER_WorkingWithOptionGroups.md#USER_WorkingWithOptionGroups.Create) or [Copying an option group](USER_WorkingWithOptionGroups.md#USER_WorkingWithOptionGroups.Copy)\. - -If your DB instance uses a custom option group that contains the APEX option, you can sometimes reduce the upgrade time\. To do this, upgrade your version of APEX at the same time as your DB instance\. For more information, see [Upgrading the APEX version](Appendix.Oracle.Options.APEX.md#Appendix.Oracle.Options.APEX.Upgrade)\. - -## Parameter group considerations - -If your DB instance uses a custom parameter group, sometimes Amazon RDS can't automatically assign your DB instance a new parameter group\. For example, this situation occurs when you upgrade to a new major version\. In such cases, make sure to specify a new parameter group when you upgrade\. We recommend that you create a new parameter group, and configure the parameters as in your existing custom parameter group\. - -For more information, see [Creating a DB parameter group](USER_WorkingWithDBInstanceParamGroups.md#USER_WorkingWithParamGroups.Creating) or [Copying a DB parameter group](USER_WorkingWithDBInstanceParamGroups.md#USER_WorkingWithParamGroups.Copying)\. - -## Time zone considerations - -You can use the time zone option to change the *system time zone* used by your Oracle DB instance\. For example, you might change the time zone of a DB instance to be compatible with an on\-premises environment, or a legacy application\. The time zone option changes the time zone at the host level\. Amazon RDS for Oracle updates the system time zone automatically throughout the year\. For more information about the system time zone, see [Oracle time zone](Appendix.Oracle.Options.Timezone.md)\. - -When you create an Oracle DB instance, the database automatically sets the *database time zone*\. The database time zone is also known as the Daylight Saving Time \(DST\) time zone\. The database time zone is distinct from the system time zone\. - -Between Oracle Database releases, patch sets or individual patches may include new DST versions\. These patches reflect the changes in transition rules for various time zone regions\. For example, a government might change when DST takes effect\. Changes to DST rules may affect existing data of the `TIMESTAMP WITH TIME ZONE` data type\. - -If you upgrade an RDS for Oracle DB instance, Amazon RDS doesn't upgrade the database time zone file automatically\. To upgrade the time zone file automatically, you can include the `TIMEZONE_FILE_AUTOUPGRADE` option in the option group associated with your DB instance during or after the engine version upgrade\. For more information, see [Oracle time zone file autoupgrade](Appendix.Oracle.Options.Timezone-file-autoupgrade.md)\. - -Alternatively, to upgrade the database time zone file manually, create a new Oracle DB instance that has the desired DST patch\. However, we recommend that you upgrade the database time zone file using the `TIMEZONE_FILE_AUTOUPGRADE` option\. - -After upgrading the time zone file, migrate the data from your current instance to the new instance\. You can migrate data using several techniques, including the following: -+ AWS Database Migration Service -+ Oracle GoldenGate -+ Oracle Data Pump -+ Original Export/Import \(desupported for general use\) - -**Note** -When you migrate data using Oracle Data Pump, the utility raises the error ORA\-39405 when the target time zone version is lower than the source time zone version\. - -For more information, see [TIMESTAMP WITH TIMEZONE restrictions](https://docs.oracle.com/en/database/oracle/oracle-database/19/sutil/oracle-data-pump-overview.html#GUID-9B6C92EE-860E-43DD-9728-735B17B9DA89) in the Oracle documentation\. \ No newline at end of file diff --git a/doc_source/USER_UpgradeDBInstance.Oracle.Overview.md b/doc_source/USER_UpgradeDBInstance.Oracle.Overview.md deleted file mode 100644 index 47fffeb..0000000 --- a/doc_source/USER_UpgradeDBInstance.Oracle.Overview.md +++ /dev/null @@ -1,98 +0,0 @@ -# Overview of RDS for Oracle engine upgrades - -Before upgrading your RDS for Oracle DB instance, familiarize yourself with the following concepts\. - -**Topics** -+ [Major and minor version upgrades](#USER_UpgradeDBInstance.Oracle.Overview.versions) -+ [Expected support dates for RDS for Oracle major releases](#Aurora.VersionPolicy.MajorVersionLifetime) -+ [Oracle engine version management](#Oracle.Concepts.Patching) -+ [Automatic snapshots during engine upgrades](#USER_UpgradeDBInstance.Oracle.Overview.snapshots) -+ [Oracle upgrades in a Multi\-AZ deployment](#USER_UpgradeDBInstance.Oracle.Overview.multi-az) -+ [Oracle upgrades of read replicas](#USER_UpgradeDBInstance.Oracle.Overview.read-replicas) -+ [Oracle upgrades of micro DB instances](#USER_UpgradeDBInstance.Oracle.Overview.micro-db) - -## Major and minor version upgrades - -Major versions are major releases of Oracle Database that occur every 1\-2 years\. Examples of major releases are Oracle Database 19c and Oracle Database 21c\. - -Minor versions, which are also called Release Updates \(RUs\), are typically released by Oracle every quarter\. Minor versions contain small feature enhancements and bug fixes\. Examples of minor versions are 21\.0\.0\.0\.ru\-2022\-10\.rur\-2022\-10\.r1 and 19\.0\.0\.0\.ru\-2022\-10\.rur\-2022\-10\.r1\. For more information, see [Release notes for Amazon Relational Database Service \(Amazon RDS\) for Oracle](https://docs.aws.amazon.com/AmazonRDS/latest/OracleReleaseNotes)\. - -RDS for Oracle supports the following upgrades to a DB instance\. - - -| Upgrade type | Application compatibility | Upgrade methods | Sample upgrade path | -| --- | --- | --- | --- | -| Major version | A major version upgrade can introduce changes that aren't compatible with existing applications\. | Manual only | From Oracle Database 19c to Oracle Database 21c | -| Minor version | A minor version upgrade includes only changes that are backward\-compatible with existing applications\. | Automatic or manual | From 21\.0\.0\.0\.ru\-2022\-07\.rur\-2022\-07\.r1 to 21\.0\.0\.0\.ru\-2022\-10\.rur\-2022\-10\.r1 | - -**Important** -When you upgrade the DB engine, an outage occurs\. The duration of the outage depends on your engine version and DB instance size\. - -## Expected support dates for RDS for Oracle major releases - -RDS for Oracle major versions remain available at least until the end of support date for the corresponding Oracle Database release version\. You can use the following dates to plan your testing and upgrade cycles\. These dates represent the earliest date that an upgrade to a newer version might be required\. If Amazon extends support for an RDS for Oracle version for longer than originally stated, we plan to update this table to reflect the later date\. - - -| Oracle Database major release version | Expected date for upgrading to a newer version | -| --- | --- | -| Oracle Database 19c | April 30, 2024 without Extended Support or an Unlimited License Agreement April 30, 2027 with Extended Support or an Unlimited License Agreement | -| Oracle Database 21c | April 30, 2024 | - -Before we ask you to upgrade to a newer major version, we remind you at least 12 months in advance\. We detail the upgrade process, including the timing of important milestones, the impact on your DB instances, and recommended actions\. You should thoroughly test your applications with new RDS for Oracle versions before you upgrade to a major version\. - -After this advance notification period, an automatic upgrade to the subsequent major version might be applied to any RDS for Oracle DB instance still running the older version\. If so, the upgrade is started during scheduled maintenance windows\. - -## Oracle engine version management - -With DB engine version management, you control when and how the database engine is patched and upgraded\. You get the flexibility to maintain compatibility with database engine patch versions\. You can also test new patch versions of RDS for Oracle to ensure they work with your application before deploying them in production\. In addition, you upgrade the versions on your own terms and timelines\. - -**Note** -Amazon RDS periodically aggregates official Oracle database patches using an Amazon RDS\-specific DB engine version\. To see a list of which Oracle patches are contained in an Amazon RDS Oracle\-specific engine version, go to [https://docs.aws.amazon.com/AmazonRDS/latest/OracleReleaseNotes/Welcome.html](https://docs.aws.amazon.com/AmazonRDS/latest/OracleReleaseNotes/Welcome.html)\. - -## Automatic snapshots during engine upgrades - -During upgrades of an Oracle DB instance, snapshots offer protection against upgrade issues\. If the backup retention period for your DB instance is greater than 0, Amazon RDS takes the following DB snapshots during the upgrade: - -1. A snapshot of the DB instance before any upgrade changes have been made\. If the upgrade fails, you can restore this snapshot to create a DB instance running the old version\. - -1. A snapshot of the DB instance after the upgrade completes\. - -**Note** -To change your backup retention period, see [Modifying an Amazon RDS DB instance](Overview.DBInstance.Modifying.md)\. - -After an upgrade, you can't revert to the previous engine version\. However, you can create a new Oracle DB instance by restoring the pre\-upgrade snapshot\. - -## Oracle upgrades in a Multi\-AZ deployment - -If your DB instance is in a Multi\-AZ deployment, Amazon RDS upgrades both the primary and standby replicas\. If no operating system updates are required, the primary and standby upgrades occur simultaneously\. The instances are not available until the upgrade completes\. - -If operating system updates are required in a Multi\-AZ deployment, Amazon RDS applies the updates when you request the DB upgrade\. Amazon RDS performs the following steps: - -1. Updates the operating system on the standby DB instance\. - -1. Upgrades the standby DB instance\. - -1. Fails over the primary instance to the standby DB instance\. - -1. Upgrades the operating system on the new standby DB instance, which was formerly the primary instance\. - -1. Upgrades the new standby DB instance\. - -## Oracle upgrades of read replicas - -The Oracle DB engine version of the source DB instance and all of its read replicas must be the same\. Amazon RDS performs the upgrade in the following stages: - -1. Upgrades the source DB instance\. The read replicas are available during this stage\. - -1. Upgrades the read replicas in parallel, regardless of the replica maintenance windows\. The source DB is available during this stage\. - -For major version upgrades of cross\-Region read replicas, Amazon RDS performs additional actions: -+ Generates an option group for the target version automatically -+ Copies all options and option settings from the original option group to the new option group -+ Associates the upgraded cross\-Region read replica with the new option group - -## Oracle upgrades of micro DB instances - -We don't recommend upgrading databases running on micro DB instances\. Because these instances have limited CPU, the upgrade can take hours to complete\. - -You can upgrade micro DB instances with small amounts of storage \(10–20 GiB\) by copying your data using Data Pump\. Before you migrate your production DB instances, we recommend that you test by copying data using Data Pump\. \ No newline at end of file diff --git a/doc_source/USER_UpgradeDBInstance.Oracle.SE2.md b/doc_source/USER_UpgradeDBInstance.Oracle.SE2.md deleted file mode 100644 index 0d98c64..0000000 --- a/doc_source/USER_UpgradeDBInstance.Oracle.SE2.md +++ /dev/null @@ -1,13 +0,0 @@ -# Oracle SE2 upgrade paths - -The following table shows supported upgrade paths to Standard Edition Two \(SE2\)\. For more information about the License Included and Bring Your Own License \(BYOL\) models, see [Oracle licensing options](Oracle.Concepts.Licensing.md)\. - - -**** - -| Your existing configuration | Supported SE2 configuration | -| --- | --- | -| 12\.2\.0\.1 SE2, BYOL | 12\.2\.0\.1 SE2, BYOL or License Included | -| 12\.1\.0\.2 SE2, BYOL | 12\.2\.0\.1 SE2, BYOL or License Included 12\.1\.0\.2 SE2, BYOL or License Included | - -To upgrade from your existing configuration to a supported SE2 configuration, use a supported upgrade path\. For more information, see [Major version upgrades](USER_UpgradeDBInstance.Oracle.Major.md)\. \ No newline at end of file diff --git a/doc_source/USER_UpgradeDBInstance.Oracle.UpgradeTesting.md b/doc_source/USER_UpgradeDBInstance.Oracle.UpgradeTesting.md deleted file mode 100644 index bcf630c..0000000 --- a/doc_source/USER_UpgradeDBInstance.Oracle.UpgradeTesting.md +++ /dev/null @@ -1,29 +0,0 @@ -# Testing an Oracle DB upgrade - -Before you upgrade your DB instance to a major version, thoroughly test your database and all applications that access the database for compatibility with the new version\. We recommend that you use the following procedure\. - -**To test a major version upgrade** - -1. Review the Oracle upgrade documentation for the new version of the database engine to see if there are compatibility issues that might affect your database or applications\. For more information, see [Database Upgrade Guide](https://docs.oracle.com/database/121/UPGRD/toc.htm) in the Oracle documentation\. - -1. If your DB instance uses a custom option group, create a new option group compatible with the new version you are upgrading to\. For more information, see [Option group considerations](USER_UpgradeDBInstance.Oracle.OGPG.md#USER_UpgradeDBInstance.Oracle.OGPG.OG)\. - -1. If your DB instance uses a custom parameter group, create a new parameter group compatible with the new version you are upgrading to\. For more information, see [Parameter group considerations](USER_UpgradeDBInstance.Oracle.OGPG.md#USER_UpgradeDBInstance.Oracle.OGPG.PG)\. - -1. Create a DB snapshot of the DB instance to be upgraded\. For more information, see [Creating a DB snapshot](USER_CreateSnapshot.md)\. - -1. Restore the DB snapshot to create a new test DB instance\. For more information, see [Restoring from a DB snapshot](USER_RestoreFromSnapshot.md)\. - -1. Modify this new test DB instance to upgrade it to the new version, by using one of the following methods: - + [Console](USER_UpgradeDBInstance.Upgrading.md#USER_UpgradeDBInstance.Upgrading.Manual.Console) - + [AWS CLI](USER_UpgradeDBInstance.Upgrading.md#USER_UpgradeDBInstance.Upgrading.Manual.CLI) - + [RDS API](USER_UpgradeDBInstance.Upgrading.md#USER_UpgradeDBInstance.Upgrading.Manual.API) - -1. Perform testing: - + Run as many of your quality assurance tests against the upgraded DB instance as needed to ensure that your database and application work correctly with the new version\. - + Implement any new tests needed to evaluate the impact of any compatibility issues that you identified in step 1\. - + Test all stored procedures, functions, and triggers\. - + Direct test versions of your applications to the upgraded DB instance\. Verify that the applications work correctly with the new version\. - + Evaluate the storage used by the upgraded instance to determine if the upgrade requires additional storage\. You might need to choose a larger instance class to support the new version in production\. For more information, see [DB instance classes](Concepts.DBInstanceClass.md)\. - -1. If all tests pass, upgrade your production DB instance\. We recommend that you confirm that the DB instance working correctly before allowing write operations to the DB instance\. \ No newline at end of file diff --git a/doc_source/USER_UpgradeDBInstance.Oracle.Upgrading.md b/doc_source/USER_UpgradeDBInstance.Oracle.Upgrading.md deleted file mode 100644 index 65c6ba0..0000000 --- a/doc_source/USER_UpgradeDBInstance.Oracle.Upgrading.md +++ /dev/null @@ -1,3 +0,0 @@ -# Upgrading an Oracle DB instance - -To learn how to upgrade an Oracle DB instance, see [Upgrading a DB instance engine version](USER_UpgradeDBInstance.Upgrading.md)\. \ No newline at end of file diff --git a/doc_source/USER_UpgradeDBInstance.Oracle.md b/doc_source/USER_UpgradeDBInstance.Oracle.md deleted file mode 100644 index fb4c300..0000000 --- a/doc_source/USER_UpgradeDBInstance.Oracle.md +++ /dev/null @@ -1,15 +0,0 @@ -# Upgrading the RDS for Oracle DB engine - -When Amazon RDS supports a new version of Oracle Database, you can upgrade your DB instances to the new version\. For information about which Oracle versions are available on Amazon RDS, see [https://docs.aws.amazon.com/AmazonRDS/latest/OracleReleaseNotes/Welcome.html](https://docs.aws.amazon.com/AmazonRDS/latest/OracleReleaseNotes/Welcome.html)\. - -**Important** -RDS for Oracle Database 11g is desupported\. If you maintain Oracle Database 11g snapshots, you can upgrade them to a later release\. For more information, see [Upgrading an Oracle DB snapshot](USER_UpgradeDBSnapshot.Oracle.md)\. - -**Topics** -+ [Overview of RDS for Oracle engine upgrades](USER_UpgradeDBInstance.Oracle.Overview.md) -+ [Oracle major version upgrades](USER_UpgradeDBInstance.Oracle.Major.md) -+ [Oracle minor version upgrades](USER_UpgradeDBInstance.Oracle.Minor.md) -+ [Considerations for Oracle DB upgrades](USER_UpgradeDBInstance.Oracle.OGPG.md) -+ [Testing an Oracle DB upgrade](USER_UpgradeDBInstance.Oracle.UpgradeTesting.md) -+ [Upgrading an Oracle DB instance](USER_UpgradeDBInstance.Oracle.Upgrading.md) -+ [Upgrading an Oracle DB snapshot](USER_UpgradeDBSnapshot.Oracle.md) \ No newline at end of file diff --git a/doc_source/USER_UpgradeDBInstance.PostgreSQL.md b/doc_source/USER_UpgradeDBInstance.PostgreSQL.md deleted file mode 100644 index 6cf9d37..0000000 --- a/doc_source/USER_UpgradeDBInstance.PostgreSQL.md +++ /dev/null @@ -1,456 +0,0 @@ -# Upgrading the PostgreSQL DB engine for Amazon RDS - -There are two types of upgrades you can manage for your PostgreSQL DB instance: -+ Operating system updates – Occasionally, Amazon RDS might need to update the underlying operating system of your DB instance to apply security fixes or OS changes\. You can decide when Amazon RDS applies OS updates by using the RDS console, AWS Command Line Interface \(AWS CLI\), or RDS API\. For more information about OS updates, see [Applying updates for a DB instance](USER_UpgradeDBInstance.Maintenance.md#USER_UpgradeDBInstance.OSUpgrades)\. -+ Database engine upgrades – When Amazon RDS supports a new version of a database engine, you can upgrade your DB instances to the new version\. - -When Amazon RDS supports a new version of a database engine, you can upgrade your DB instances to the new version\. There are two kinds of upgrades for PostgreSQL DB instances: major version upgrades and minor version upgrades\. - -**Major version upgrades** -*Major version upgrades* can contain database changes that are not backward\-compatible with existing applications\. As a result, you must manually perform major version upgrades of your DB instances\. You can initiate a major version upgrade by modifying your DB instance\. However, before you perform a major version upgrade, we recommend that you follow the steps described in [ Choosing a major version upgrade for PostgreSQL](#USER_UpgradeDBInstance.PostgreSQL.MajorVersion)\. During a major version upgrade, Amazon RDS also upgrades all of your in\-Region read replicas along with the primary DB instance\. - -**Minor version upgrades** -In contrast, *minor version upgrades* include only changes that are backward\-compatible with existing applications\. You can initiate a minor version upgrade manually by modifying your DB instance\. Or you can enable the **Auto minor version upgrade** option when creating or modifying a DB instance\. Doing so means that your DB instance is automatically upgraded after Amazon RDS tests and approves the new version\. If your PostgreSQL DB instance is using read replicas, you must first upgrade all of the read replicas before upgrading the primary instance\. If your DB instance is in a Multi\-AZ deployment, then the writer and any standby replicas are upgraded simultaneously\. Therefore, your DB instance might not be available until the upgrade is complete\. For more details, see [Automatic minor version upgrades for PostgreSQL](#USER_UpgradeDBInstance.PostgreSQL.Minor)\. For information about manually performing a minor version upgrade, see [Manually upgrading the engine version](USER_UpgradeDBInstance.Upgrading.md#USER_UpgradeDBInstance.Upgrading.Manual)\. - -For more information about database engine versions, and the policy for deprecating database engine versions, see [Database Engine Versions in the Amazon RDS FAQs](http://aws.amazon.com/rds/faqs/#Database_Engine_Versions)\. - -**Topics** -+ [Overview of upgrading PostgreSQL](#USER_UpgradeDBInstance.PostgreSQL.Overview) -+ [PostgreSQL version numbers](#USER_UpgradeDBInstance.PostgreSQL.VersionID) -+ [RDS version number](#USER_UpgradeDBInstance.PostgreSQL.rds.version) -+ [Choosing a major version upgrade for PostgreSQL](#USER_UpgradeDBInstance.PostgreSQL.MajorVersion) -+ [How to perform a major version upgrade](#USER_UpgradeDBInstance.PostgreSQL.MajorVersion.Process) -+ [Automatic minor version upgrades for PostgreSQL](#USER_UpgradeDBInstance.PostgreSQL.Minor) -+ [Upgrading PostgreSQL extensions](#USER_UpgradeDBInstance.PostgreSQL.ExtensionUpgrades) - -## Overview of upgrading PostgreSQL - -To safely upgrade your DB instances, Amazon RDS uses the `pg_upgrade` utility described in the [PostgreSQL documentation](https://www.postgresql.org/docs/current/pgupgrade.html)\. - -When you use the AWS Management Console to upgrade a DB instance, it shows the valid upgrade targets for the DB instance\. You can also use the following AWS CLI command to identify the valid upgrade targets for a DB instance: - -For Linux, macOS, or Unix: - -``` -aws rds describe-db-engine-versions \ - --engine postgres \ - --engine-version version-number \ - --query "DBEngineVersions[*].ValidUpgradeTarget[*].{EngineVersion:EngineVersion}" --output text -``` - -For Windows: - -``` -aws rds describe-db-engine-versions ^ - --engine postgres ^ - --engine-version version-number ^ - --query "DBEngineVersions[*].ValidUpgradeTarget[*].{EngineVersion:EngineVersion}" --output text -``` - -For example, to identify the valid upgrade targets for a PostgreSQL version 10\.11 DB instance, run the following AWS CLI command: - -For Linux, macOS, or Unix: - -``` -aws rds describe-db-engine-versions \ - --engine postgres \ - --engine-version 10.11 \ - --query "DBEngineVersions[*].ValidUpgradeTarget[*].{EngineVersion:EngineVersion}" --output text -``` - -For Windows: - -``` -aws rds describe-db-engine-versions ^ - --engine postgres ^ - --engine-version 10.11 ^ - --query "DBEngineVersions[*].ValidUpgradeTarget[*].{EngineVersion:EngineVersion}" --output text -``` - -If your backup retention period is greater than 0, Amazon RDS takes two DB snapshots during the upgrade process\. The first DB snapshot is of the DB instance before any upgrade changes have been made\. If the upgrade doesn't work for your databases, you can restore this snapshot to create a DB instance running the old version\. The second DB snapshot is taken after the upgrade completes\. - -**Note** -Amazon RDS takes DB snapshots during the upgrade process only if you have set the backup retention period for your DB instance to a number greater than 0\. To change your backup retention period, see [Modifying an Amazon RDS DB instance](Overview.DBInstance.Modifying.md)\. - -When you perform a major version upgrade of the primary DB instance, all the in\-Region read replicas are also automatically upgraded\. After the upgrade workflow starts, the read replicas wait for the `pg_upgrade` to complete successfully on the primary DB instance\. Then the primary DB instance upgrade waits for the read replica upgrades to complete\. You experience an outage until the upgrade is complete\. - -If your DB instance is in a Multi\-AZ deployment, both the primary writer DB instance and standby DB instances are upgraded\. The writer and standby DB instances are upgraded at the same time\. - -After an upgrade is complete, you can't revert to the previous version of the database engine\. If you want to return to the previous version, restore the DB snapshot that was taken before the upgrade to create a new DB instance\. - -## PostgreSQL version numbers - -The version numbering sequence for the PostgreSQL database engine is as follows: -+ For PostgreSQL versions 10 and later, the engine version number is in the form *major\.minor*\. The major version number is the integer part of the version number\. The minor version number is the fractional part of the version number\. - - A major version upgrade increases the integer part of the version number, such as upgrading from 10\.*minor* to 11\.*minor*\. -+ For PostgreSQL versions earlier than 10, the engine version number is in the form *major\.major\.minor*\. The major engine version number is both the integer and the first fractional part of the version number\. For example, 9\.6 is a major version\. The minor version number is the third part of the version number\. For example, for version 9\.6\.12, the 12 is the minor version number\. - - A major version upgrade increases the major part of the version number\. For example, an upgrade from *9\.6*\.12 to *10*\.11 is a major version upgrade, where *9\.6* and *10* are the major version numbers\. - -## RDS version number - -RDS version numbers use the `major.minor.patch` naming scheme\. A RDS patch version includes important bug fixes added to a minor version after its release\. To identify the Amazon RDS version number of your DB instance, you must first create the `rds_tools` extension by using the following command: - -``` -CREATE EXTENSION rds_tools; -``` - -Starting with the release of PostgreSQL version 15\.2\-R2, you can find out the RDS version number of your RDS for PostgreSQL DB instance with the following SQL query: - -``` -postgres=> SELECT rds_tools.rds_version(); -``` - -For example, querying an RDS PostgreSQL 15\.2 DB instance returns the following: - -``` -rds_version ----------------- - 15.2.R2 -(1 row) -``` - -## Choosing a major version upgrade for PostgreSQL - -Major version upgrades can contain changes that are not backward\-compatible with previous versions of the database\. New functionality can cause your existing applications to stop working correctly\. For this reason, Amazon RDS doesn't apply major version upgrades automatically\. To perform a major version upgrade, you modify your DB instance manually\. Make sure that you thoroughly test any upgrade to verify that your applications work correctly before applying the upgrade to your production DB instances\. When you do a PostgreSQL major version upgrade, we recommend that you follow the steps described in [How to perform a major version upgrade](#USER_UpgradeDBInstance.PostgreSQL.MajorVersion.Process)\. - -When you upgrade a PostgreSQL DB instance to its next major version, any read replicas associated with the DB instance are also upgraded to that next major version\. In some cases, you can skip to a higher major version when upgrading\. If your upgrade skips a major version, the read replicas are also upgraded to that target major version\. Upgrades to version 11 that skip other major versions have certain limitations\. You can find the details in the steps described in [How to perform a major version upgrade](#USER_UpgradeDBInstance.PostgreSQL.MajorVersion.Process)\. - -Most PostgreSQL extensions aren't upgraded during a PostgreSQL engine upgrade\. These must be upgraded separately\. For more information, see [Upgrading PostgreSQL extensions](#USER_UpgradeDBInstance.PostgreSQL.ExtensionUpgrades)\. - -You can find out which major versions are available for your RDS for PostgreSQL DB instance by running the following AWS CLI query: - -``` -aws rds describe-db-engine-versions --engine postgres --engine-version your-version --query "DBEngineVersions[*].ValidUpgradeTarget[*].{EngineVersion:EngineVersion}" --output text -``` - -The following table summarizes the results of this query for all available versions\. An asterisk \(\*\) on the version number means that version is deprecated\. If your current version is deprecated, we recommend that you upgrade to the newest minor version upgrade target or to one of the other available upgrade targets for that version\. For more information about the RDS for PostgreSQL version 9\.6 deprecation, see [Deprecation of PostgreSQL version 9\.6](CHAP_PostgreSQL.md#PostgreSQL.Concepts.General.DBVersions.Deprecation96)\. For more information about the RDS for PostgreSQL version 10 deprecation, see [Deprecation of PostgreSQL version 10](CHAP_PostgreSQL.md#PostgreSQL.Concepts.General.DBVersions.Deprecation10)\. - - -| Current source version \(\*deprecated\) | Newest minor version upgrade target | Newest major version upgrade target | Other available upgrade targets | -| --- | --- | --- | --- | -| 14\.8 | | [15\.3](https://docs.aws.amazon.com/AmazonRDS/latest/PostgreSQLReleaseNotes/postgresql-versions.html#postgresql-versions-version153) | | | | | | | | | | | | | | | | | | -| 14\.7 | | [15\.3](https://docs.aws.amazon.com/AmazonRDS/latest/PostgreSQLReleaseNotes/postgresql-versions.html#postgresql-versions-version153) | [15\.2](https://docs.aws.amazon.com/AmazonRDS/latest/PostgreSQLReleaseNotes/postgresql-versions.html#postgresql-versions-version152) | [14\.8](https://docs.aws.amazon.com/AmazonRDS/latest/PostgreSQLReleaseNotes/postgresql-versions.html#postgresql-versions-version147) | | | | | | | | | | | | | | | | -| 14\.6 | | [15\.3](https://docs.aws.amazon.com/AmazonRDS/latest/PostgreSQLReleaseNotes/postgresql-versions.html#postgresql-versions-version153) | [15\.2](https://docs.aws.amazon.com/AmazonRDS/latest/PostgreSQLReleaseNotes/postgresql-versions.html#postgresql-versions-version152) | [14\.8](https://docs.aws.amazon.com/AmazonRDS/latest/PostgreSQLReleaseNotes/postgresql-versions.html#postgresql-versions-version148) | [14\.7](https://docs.aws.amazon.com/AmazonRDS/latest/PostgreSQLReleaseNotes/postgresql-versions.html#postgresql-versions-version147) | | | | | | | | | | | | | | | -| 14\.5 | | [15\.3](https://docs.aws.amazon.com/AmazonRDS/latest/PostgreSQLReleaseNotes/postgresql-versions.html#postgresql-versions-version153) | [15\.2](https://docs.aws.amazon.com/AmazonRDS/latest/PostgreSQLReleaseNotes/postgresql-versions.html#postgresql-versions-version152) | [14\.8](https://docs.aws.amazon.com/AmazonRDS/latest/PostgreSQLReleaseNotes/postgresql-versions.html#postgresql-versions-version148) | [14\.7](https://docs.aws.amazon.com/AmazonRDS/latest/PostgreSQLReleaseNotes/postgresql-versions.html#postgresql-versions-version147) | [14\.6](https://docs.aws.amazon.com/AmazonRDS/latest/PostgreSQLReleaseNotes/postgresql-versions.html#postgresql-versions-version146) | | | | | | | | | | | | | | -| 14\.4 | | [15\.3](https://docs.aws.amazon.com/AmazonRDS/latest/PostgreSQLReleaseNotes/postgresql-versions.html#postgresql-versions-version153) | [15\.2](https://docs.aws.amazon.com/AmazonRDS/latest/PostgreSQLReleaseNotes/postgresql-versions.html#postgresql-versions-version152) | [14\.8](https://docs.aws.amazon.com/AmazonRDS/latest/PostgreSQLReleaseNotes/postgresql-versions.html#postgresql-versions-version148) | [14\.7](https://docs.aws.amazon.com/AmazonRDS/latest/PostgreSQLReleaseNotes/postgresql-versions.html#postgresql-versions-version147) | [14\.6](https://docs.aws.amazon.com/AmazonRDS/latest/PostgreSQLReleaseNotes/postgresql-versions.html#postgresql-versions-version146) | [14\.5](https://docs.aws.amazon.com/AmazonRDS/latest/PostgreSQLReleaseNotes/postgresql-versions.html#postgresql-versions-version145) | | | | | | | | | | | | | -| 14\.3 | | [15\.3](https://docs.aws.amazon.com/AmazonRDS/latest/PostgreSQLReleaseNotes/postgresql-versions.html#postgresql-versions-version153) | [15\.2](https://docs.aws.amazon.com/AmazonRDS/latest/PostgreSQLReleaseNotes/postgresql-versions.html#postgresql-versions-version152) | [14\.8](https://docs.aws.amazon.com/AmazonRDS/latest/PostgreSQLReleaseNotes/postgresql-versions.html#postgresql-versions-version148) | [14\.7](https://docs.aws.amazon.com/AmazonRDS/latest/PostgreSQLReleaseNotes/postgresql-versions.html#postgresql-versions-version147) | [14\.6](https://docs.aws.amazon.com/AmazonRDS/latest/PostgreSQLReleaseNotes/postgresql-versions.html#postgresql-versions-version146) | [14\.5](https://docs.aws.amazon.com/AmazonRDS/latest/PostgreSQLReleaseNotes/postgresql-versions.html#postgresql-versions-version145) | [14\.4](https://docs.aws.amazon.com/AmazonRDS/latest/PostgreSQLReleaseNotes/postgresql-versions.html#postgresql-versions-version144) | | | | | | | | | | | | -| 14\.2 | | [15\.3](https://docs.aws.amazon.com/AmazonRDS/latest/PostgreSQLReleaseNotes/postgresql-versions.html#postgresql-versions-version153) | [15\.2](https://docs.aws.amazon.com/AmazonRDS/latest/PostgreSQLReleaseNotes/postgresql-versions.html#postgresql-versions-version152) | [14\.8](https://docs.aws.amazon.com/AmazonRDS/latest/PostgreSQLReleaseNotes/postgresql-versions.html#postgresql-versions-version148) | [14\.7](https://docs.aws.amazon.com/AmazonRDS/latest/PostgreSQLReleaseNotes/postgresql-versions.html#postgresql-versions-version147) | [14\.6](https://docs.aws.amazon.com/AmazonRDS/latest/PostgreSQLReleaseNotes/postgresql-versions.html#postgresql-versions-version146) | [14\.5](https://docs.aws.amazon.com/AmazonRDS/latest/PostgreSQLReleaseNotes/postgresql-versions.html#postgresql-versions-version145) | [14\.4](https://docs.aws.amazon.com/AmazonRDS/latest/PostgreSQLReleaseNotes/postgresql-versions.html#postgresql-versions-version144) | [14\.3](https://docs.aws.amazon.com/AmazonRDS/latest/PostgreSQLReleaseNotes/postgresql-versions.html#postgresql-versions-version143) | | | | | | | | | | | -| 14\.1 | | [15\.3](https://docs.aws.amazon.com/AmazonRDS/latest/PostgreSQLReleaseNotes/postgresql-versions.html#postgresql-versions-version153) | [15\.2](https://docs.aws.amazon.com/AmazonRDS/latest/PostgreSQLReleaseNotes/postgresql-versions.html#postgresql-versions-version152) | [14\.8](https://docs.aws.amazon.com/AmazonRDS/latest/PostgreSQLReleaseNotes/postgresql-versions.html#postgresql-versions-version148) | [14\.7](https://docs.aws.amazon.com/AmazonRDS/latest/PostgreSQLReleaseNotes/postgresql-versions.html#postgresql-versions-version147) | [14\.6](https://docs.aws.amazon.com/AmazonRDS/latest/PostgreSQLReleaseNotes/postgresql-versions.html#postgresql-versions-version146) | [14\.5](https://docs.aws.amazon.com/AmazonRDS/latest/PostgreSQLReleaseNotes/postgresql-versions.html#postgresql-versions-version145) | [14\.4](https://docs.aws.amazon.com/AmazonRDS/latest/PostgreSQLReleaseNotes/postgresql-versions.html#postgresql-versions-version144) | [14\.3](https://docs.aws.amazon.com/AmazonRDS/latest/PostgreSQLReleaseNotes/postgresql-versions.html#postgresql-versions-version143) | [14\.2](https://docs.aws.amazon.com/AmazonRDS/latest/PostgreSQLReleaseNotes/postgresql-versions.html#postgresql-versions-version142) | | | | | | | | | | -| 13\.11 | | [15\.3](https://docs.aws.amazon.com/AmazonRDS/latest/PostgreSQLReleaseNotes/postgresql-versions.html#postgresql-versions-version153) | [14\.8](https://docs.aws.amazon.com/AmazonRDS/latest/PostgreSQLReleaseNotes/postgresql-versions.html#postgresql-versions-version148) | | | | | | | | | | | | | | | | | -| 13\.10 | | [15\.2](https://docs.aws.amazon.com/AmazonRDS/latest/PostgreSQLReleaseNotes/postgresql-versions.html#postgresql-versions-version152) | [14\.8](https://docs.aws.amazon.com/AmazonRDS/latest/PostgreSQLReleaseNotes/postgresql-versions.html#postgresql-versions-version148) | [14\.7](https://docs.aws.amazon.com/AmazonRDS/latest/PostgreSQLReleaseNotes/postgresql-versions.html#postgresql-versions-version147) | [13\.11](https://docs.aws.amazon.com/AmazonRDS/latest/PostgreSQLReleaseNotes/postgresql-versions.html#postgresql-versions-version1311) | | | | | | | | | | | | | | | -| 13\.9 | | [14\.8](https://docs.aws.amazon.com/AmazonRDS/latest/PostgreSQLReleaseNotes/postgresql-versions.html#postgresql-versions-version148) | [14\.7](https://docs.aws.amazon.com/AmazonRDS/latest/PostgreSQLReleaseNotes/postgresql-versions.html#postgresql-versions-version147) | [14\.6](https://docs.aws.amazon.com/AmazonRDS/latest/PostgreSQLReleaseNotes/postgresql-versions.html#postgresql-versions-version146) | [13\.11](https://docs.aws.amazon.com/AmazonRDS/latest/PostgreSQLReleaseNotes/postgresql-versions.html#postgresql-versions-version1311) | [13\.10](https://docs.aws.amazon.com/AmazonRDS/latest/PostgreSQLReleaseNotes/postgresql-versions.html#postgresql-versions-version1310) | | | | | | | | | | | | | | -| 13\.8 | | [14\.8](https://docs.aws.amazon.com/AmazonRDS/latest/PostgreSQLReleaseNotes/postgresql-versions.html#postgresql-versions-version148) | [14\.7](https://docs.aws.amazon.com/AmazonRDS/latest/PostgreSQLReleaseNotes/postgresql-versions.html#postgresql-versions-version147) | [14\.6](https://docs.aws.amazon.com/AmazonRDS/latest/PostgreSQLReleaseNotes/postgresql-versions.html#postgresql-versions-version146) | [14\.5](https://docs.aws.amazon.com/AmazonRDS/latest/PostgreSQLReleaseNotes/postgresql-versions.html#postgresql-versions-version145) | [13\.11](https://docs.aws.amazon.com/AmazonRDS/latest/PostgreSQLReleaseNotes/postgresql-versions.html#postgresql-versions-version1311) | [13\.10](https://docs.aws.amazon.com/AmazonRDS/latest/PostgreSQLReleaseNotes/postgresql-versions.html#postgresql-versions-version1310) | [13\.9](https://docs.aws.amazon.com/AmazonRDS/latest/PostgreSQLReleaseNotes/postgresql-versions.html#postgresql-versions-version139) | | | | | | | | | | | | -| 13\.7 | | [14\.8](https://docs.aws.amazon.com/AmazonRDS/latest/PostgreSQLReleaseNotes/postgresql-versions.html#postgresql-versions-version148) | [14\.7](https://docs.aws.amazon.com/AmazonRDS/latest/PostgreSQLReleaseNotes/postgresql-versions.html#postgresql-versions-version147) | [14\.6](https://docs.aws.amazon.com/AmazonRDS/latest/PostgreSQLReleaseNotes/postgresql-versions.html#postgresql-versions-version146) | [14\.5](https://docs.aws.amazon.com/AmazonRDS/latest/PostgreSQLReleaseNotes/postgresql-versions.html#postgresql-versions-version145) | [14\.4](https://docs.aws.amazon.com/AmazonRDS/latest/PostgreSQLReleaseNotes/postgresql-versions.html#postgresql-versions-version144) | [14\.3](https://docs.aws.amazon.com/AmazonRDS/latest/PostgreSQLReleaseNotes/postgresql-versions.html#postgresql-versions-version143) | [13\.11](https://docs.aws.amazon.com/AmazonRDS/latest/PostgreSQLReleaseNotes/postgresql-versions.html#postgresql-versions-version1311) | [13\.10](https://docs.aws.amazon.com/AmazonRDS/latest/PostgreSQLReleaseNotes/postgresql-versions.html#postgresql-versions-version1310) | [13\.9](https://docs.aws.amazon.com/AmazonRDS/latest/PostgreSQLReleaseNotes/postgresql-versions.html#postgresql-versions-version139) | [13\.8](https://docs.aws.amazon.com/AmazonRDS/latest/PostgreSQLReleaseNotes/postgresql-versions.html#postgresql-versions-version138) | | | | | | | | | -| 13\.6 | | [14\.8](https://docs.aws.amazon.com/AmazonRDS/latest/PostgreSQLReleaseNotes/postgresql-versions.html#postgresql-versions-version148) | [14\.7](https://docs.aws.amazon.com/AmazonRDS/latest/PostgreSQLReleaseNotes/postgresql-versions.html#postgresql-versions-version147) | [14\.6](https://docs.aws.amazon.com/AmazonRDS/latest/PostgreSQLReleaseNotes/postgresql-versions.html#postgresql-versions-version146) | [14\.5](https://docs.aws.amazon.com/AmazonRDS/latest/PostgreSQLReleaseNotes/postgresql-versions.html#postgresql-versions-version145) | [14\.4](https://docs.aws.amazon.com/AmazonRDS/latest/PostgreSQLReleaseNotes/postgresql-versions.html#postgresql-versions-version144) | [14\.3](https://docs.aws.amazon.com/AmazonRDS/latest/PostgreSQLReleaseNotes/postgresql-versions.html#postgresql-versions-version143) | [14\.2](https://docs.aws.amazon.com/AmazonRDS/latest/PostgreSQLReleaseNotes/postgresql-versions.html#postgresql-versions-version142) | [13\.11](https://docs.aws.amazon.com/AmazonRDS/latest/PostgreSQLReleaseNotes/postgresql-versions.html#postgresql-versions-version1311) | [13\.10](https://docs.aws.amazon.com/AmazonRDS/latest/PostgreSQLReleaseNotes/postgresql-versions.html#postgresql-versions-version1310) | [13\.9](https://docs.aws.amazon.com/AmazonRDS/latest/PostgreSQLReleaseNotes/postgresql-versions.html#postgresql-versions-version139) | [13\.8](https://docs.aws.amazon.com/AmazonRDS/latest/PostgreSQLReleaseNotes/postgresql-versions.html#postgresql-versions-version138) | [13\.7](https://docs.aws.amazon.com/AmazonRDS/latest/PostgreSQLReleaseNotes/postgresql-versions.html#postgresql-versions-version137) | | | | | | | -| 13\.5 | | [14\.8](https://docs.aws.amazon.com/AmazonRDS/latest/PostgreSQLReleaseNotes/postgresql-versions.html#postgresql-versions-version148) | [14\.7](https://docs.aws.amazon.com/AmazonRDS/latest/PostgreSQLReleaseNotes/postgresql-versions.html#postgresql-versions-version147) | [14\.6](https://docs.aws.amazon.com/AmazonRDS/latest/PostgreSQLReleaseNotes/postgresql-versions.html#postgresql-versions-version146) | [14\.5](https://docs.aws.amazon.com/AmazonRDS/latest/PostgreSQLReleaseNotes/postgresql-versions.html#postgresql-versions-version145) | [14\.4](https://docs.aws.amazon.com/AmazonRDS/latest/PostgreSQLReleaseNotes/postgresql-versions.html#postgresql-versions-version144) | [14\.3](https://docs.aws.amazon.com/AmazonRDS/latest/PostgreSQLReleaseNotes/postgresql-versions.html#postgresql-versions-version143) | [14\.2](https://docs.aws.amazon.com/AmazonRDS/latest/PostgreSQLReleaseNotes/postgresql-versions.html#postgresql-versions-version142) | [14\.1](https://docs.aws.amazon.com/AmazonRDS/latest/PostgreSQLReleaseNotes/postgresql-versions.html#postgresql-versions-version141) | [13\.11](https://docs.aws.amazon.com/AmazonRDS/latest/PostgreSQLReleaseNotes/postgresql-versions.html#postgresql-versions-version1311) | [13\.10](https://docs.aws.amazon.com/AmazonRDS/latest/PostgreSQLReleaseNotes/postgresql-versions.html#postgresql-versions-version1310) | [13\.9](https://docs.aws.amazon.com/AmazonRDS/latest/PostgreSQLReleaseNotes/postgresql-versions.html#postgresql-versions-version139) | [13\.8](https://docs.aws.amazon.com/AmazonRDS/latest/PostgreSQLReleaseNotes/postgresql-versions.html#postgresql-versions-version138) | [13\.7](https://docs.aws.amazon.com/AmazonRDS/latest/PostgreSQLReleaseNotes/postgresql-versions.html#postgresql-versions-version137) | [13\.6](https://docs.aws.amazon.com/AmazonRDS/latest/PostgreSQLReleaseNotes/postgresql-versions.html#postgresql-versions-version136) | | | | | -| 13\.4 | | [14\.8](https://docs.aws.amazon.com/AmazonRDS/latest/PostgreSQLReleaseNotes/postgresql-versions.html#postgresql-versions-version148) | [14\.7](https://docs.aws.amazon.com/AmazonRDS/latest/PostgreSQLReleaseNotes/postgresql-versions.html#postgresql-versions-version147) | [14\.6](https://docs.aws.amazon.com/AmazonRDS/latest/PostgreSQLReleaseNotes/postgresql-versions.html#postgresql-versions-version146) | [14\.5](https://docs.aws.amazon.com/AmazonRDS/latest/PostgreSQLReleaseNotes/postgresql-versions.html#postgresql-versions-version145) | [14\.4](https://docs.aws.amazon.com/AmazonRDS/latest/PostgreSQLReleaseNotes/postgresql-versions.html#postgresql-versions-version144) | [14\.3](https://docs.aws.amazon.com/AmazonRDS/latest/PostgreSQLReleaseNotes/postgresql-versions.html#postgresql-versions-version143) | [14\.2](https://docs.aws.amazon.com/AmazonRDS/latest/PostgreSQLReleaseNotes/postgresql-versions.html#postgresql-versions-version142) | [14\.1](https://docs.aws.amazon.com/AmazonRDS/latest/PostgreSQLReleaseNotes/postgresql-versions.html#postgresql-versions-version141) | [13\.11](https://docs.aws.amazon.com/AmazonRDS/latest/PostgreSQLReleaseNotes/postgresql-versions.html#postgresql-versions-version1311) | [13\.10](https://docs.aws.amazon.com/AmazonRDS/latest/PostgreSQLReleaseNotes/postgresql-versions.html#postgresql-versions-version1310) | [13\.9](https://docs.aws.amazon.com/AmazonRDS/latest/PostgreSQLReleaseNotes/postgresql-versions.html#postgresql-versions-version139) | [13\.8](https://docs.aws.amazon.com/AmazonRDS/latest/PostgreSQLReleaseNotes/postgresql-versions.html#postgresql-versions-version138) | [13\.7](https://docs.aws.amazon.com/AmazonRDS/latest/PostgreSQLReleaseNotes/postgresql-versions.html#postgresql-versions-version137) | [13\.6](https://docs.aws.amazon.com/AmazonRDS/latest/PostgreSQLReleaseNotes/postgresql-versions.html#postgresql-versions-version136) | [13\.5](https://docs.aws.amazon.com/AmazonRDS/latest/PostgreSQLReleaseNotes/postgresql-versions.html#postgresql-versions-version135) | | | | -| 13\.3 | | [14\.8](https://docs.aws.amazon.com/AmazonRDS/latest/PostgreSQLReleaseNotes/postgresql-versions.html#postgresql-versions-version148) | [14\.7](https://docs.aws.amazon.com/AmazonRDS/latest/PostgreSQLReleaseNotes/postgresql-versions.html#postgresql-versions-version147) | [14\.6](https://docs.aws.amazon.com/AmazonRDS/latest/PostgreSQLReleaseNotes/postgresql-versions.html#postgresql-versions-version146) | [14\.5](https://docs.aws.amazon.com/AmazonRDS/latest/PostgreSQLReleaseNotes/postgresql-versions.html#postgresql-versions-version145) | [14\.4](https://docs.aws.amazon.com/AmazonRDS/latest/PostgreSQLReleaseNotes/postgresql-versions.html#postgresql-versions-version144) | [14\.3](https://docs.aws.amazon.com/AmazonRDS/latest/PostgreSQLReleaseNotes/postgresql-versions.html#postgresql-versions-version143) | [14\.2](https://docs.aws.amazon.com/AmazonRDS/latest/PostgreSQLReleaseNotes/postgresql-versions.html#postgresql-versions-version142) | [14\.1](https://docs.aws.amazon.com/AmazonRDS/latest/PostgreSQLReleaseNotes/postgresql-versions.html#postgresql-versions-version141) | [13\.11](https://docs.aws.amazon.com/AmazonRDS/latest/PostgreSQLReleaseNotes/postgresql-versions.html#postgresql-versions-version1311) | [13\.10](https://docs.aws.amazon.com/AmazonRDS/latest/PostgreSQLReleaseNotes/postgresql-versions.html#postgresql-versions-version1310) | [13\.9](https://docs.aws.amazon.com/AmazonRDS/latest/PostgreSQLReleaseNotes/postgresql-versions.html#postgresql-versions-version139) | [13\.8](https://docs.aws.amazon.com/AmazonRDS/latest/PostgreSQLReleaseNotes/postgresql-versions.html#postgresql-versions-version138) | [13\.7](https://docs.aws.amazon.com/AmazonRDS/latest/PostgreSQLReleaseNotes/postgresql-versions.html#postgresql-versions-version137) | [13\.6](https://docs.aws.amazon.com/AmazonRDS/latest/PostgreSQLReleaseNotes/postgresql-versions.html#postgresql-versions-version136) | [13\.5](https://docs.aws.amazon.com/AmazonRDS/latest/PostgreSQLReleaseNotes/postgresql-versions.html#postgresql-versions-version135) | [13\.4](https://docs.aws.amazon.com/AmazonRDS/latest/PostgreSQLReleaseNotes/postgresql-versions.html#postgresql-versions-version134) | | | -| 13\.2\*, 13\.1\* | [13\.10](https://docs.aws.amazon.com/AmazonRDS/latest/PostgreSQLReleaseNotes/postgresql-versions.html#postgresql-versions-version1310) | [14\.8](https://docs.aws.amazon.com/AmazonRDS/latest/PostgreSQLReleaseNotes/postgresql-versions.html#postgresql-versions-version148) | [14\.7](https://docs.aws.amazon.com/AmazonRDS/latest/PostgreSQLReleaseNotes/postgresql-versions.html#postgresql-versions-version147) | [14\.6](https://docs.aws.amazon.com/AmazonRDS/latest/PostgreSQLReleaseNotes/postgresql-versions.html#postgresql-versions-version146) | [14\.5](https://docs.aws.amazon.com/AmazonRDS/latest/PostgreSQLReleaseNotes/postgresql-versions.html#postgresql-versions-version145) | [14\.4](https://docs.aws.amazon.com/AmazonRDS/latest/PostgreSQLReleaseNotes/postgresql-versions.html#postgresql-versions-version144) | [14\.3](https://docs.aws.amazon.com/AmazonRDS/latest/PostgreSQLReleaseNotes/postgresql-versions.html#postgresql-versions-version143) | [14\.2](https://docs.aws.amazon.com/AmazonRDS/latest/PostgreSQLReleaseNotes/postgresql-versions.html#postgresql-versions-version142) | [14\.1](https://docs.aws.amazon.com/AmazonRDS/latest/PostgreSQLReleaseNotes/postgresql-versions.html#postgresql-versions-version141) | [13\.11](https://docs.aws.amazon.com/AmazonRDS/latest/PostgreSQLReleaseNotes/postgresql-versions.html#postgresql-versions-version1311) | [13\.10](https://docs.aws.amazon.com/AmazonRDS/latest/PostgreSQLReleaseNotes/postgresql-versions.html#postgresql-versions-version1310) | [13\.9](https://docs.aws.amazon.com/AmazonRDS/latest/PostgreSQLReleaseNotes/postgresql-versions.html#postgresql-versions-version139) | [13\.8](https://docs.aws.amazon.com/AmazonRDS/latest/PostgreSQLReleaseNotes/postgresql-versions.html#postgresql-versions-version138) | [13\.7](https://docs.aws.amazon.com/AmazonRDS/latest/PostgreSQLReleaseNotes/postgresql-versions.html#postgresql-versions-version137) | [13\.6](https://docs.aws.amazon.com/AmazonRDS/latest/PostgreSQLReleaseNotes/postgresql-versions.html#postgresql-versions-version136) | [13\.5](https://docs.aws.amazon.com/AmazonRDS/latest/PostgreSQLReleaseNotes/postgresql-versions.html#postgresql-versions-version135) | [13\.4](https://docs.aws.amazon.com/AmazonRDS/latest/PostgreSQLReleaseNotes/postgresql-versions.html#postgresql-versions-version134) | | | -| 12\.15 | | [15\.3](https://docs.aws.amazon.com/AmazonRDS/latest/PostgreSQLReleaseNotes/postgresql-versions.html#postgresql-versions-version153) | [14\.8](https://docs.aws.amazon.com/AmazonRDS/latest/PostgreSQLReleaseNotes/postgresql-versions.html#postgresql-versions-version148) | [13\.11](https://docs.aws.amazon.com/AmazonRDS/latest/PostgreSQLReleaseNotes/postgresql-versions.html#postgresql-versions-version1311) | | | | | | | | | | | | | | | | -| 12\.14 | | [15\.2](https://docs.aws.amazon.com/AmazonRDS/latest/PostgreSQLReleaseNotes/postgresql-versions.html#postgresql-versions-version152) | [14\.7](https://docs.aws.amazon.com/AmazonRDS/latest/PostgreSQLReleaseNotes/postgresql-versions.html#postgresql-versions-version147) | [13\.11](https://docs.aws.amazon.com/AmazonRDS/latest/PostgreSQLReleaseNotes/postgresql-versions.html#postgresql-versions-version1311) | [13\.10](https://docs.aws.amazon.com/AmazonRDS/latest/PostgreSQLReleaseNotes/postgresql-versions.html#postgresql-versions-version1310) | [12\.15](https://docs.aws.amazon.com/AmazonRDS/latest/PostgreSQLReleaseNotes/postgresql-versions.html#postgresql-versions-version1215) | | | | | | | | | | | | | | -| 12\.13 | | [14\.6](https://docs.aws.amazon.com/AmazonRDS/latest/PostgreSQLReleaseNotes/postgresql-versions.html#postgresql-versions-version145) | [13\.11](https://docs.aws.amazon.com/AmazonRDS/latest/PostgreSQLReleaseNotes/postgresql-versions.html#postgresql-versions-version1311) | [13\.10](https://docs.aws.amazon.com/AmazonRDS/latest/PostgreSQLReleaseNotes/postgresql-versions.html#postgresql-versions-version1310) | [13\.9](https://docs.aws.amazon.com/AmazonRDS/latest/PostgreSQLReleaseNotes/postgresql-versions.html#postgresql-versions-version137) | [12\.15](https://docs.aws.amazon.com/AmazonRDS/latest/PostgreSQLReleaseNotes/postgresql-versions.html#postgresql-versions-version1215) | [12\.14](https://docs.aws.amazon.com/AmazonRDS/latest/PostgreSQLReleaseNotes/postgresql-versions.html#postgresql-versions-version1214) | | | | | | | | | | | | | -| 12\.12 | | [14\.5](https://docs.aws.amazon.com/AmazonRDS/latest/PostgreSQLReleaseNotes/postgresql-versions.html#postgresql-versions-version145) | [13\.11](https://docs.aws.amazon.com/AmazonRDS/latest/PostgreSQLReleaseNotes/postgresql-versions.html#postgresql-versions-version1311) | [13\.10](https://docs.aws.amazon.com/AmazonRDS/latest/PostgreSQLReleaseNotes/postgresql-versions.html#postgresql-versions-version1310) | [13\.9](https://docs.aws.amazon.com/AmazonRDS/latest/PostgreSQLReleaseNotes/postgresql-versions.html#postgresql-versions-version139) | [13\.8](https://docs.aws.amazon.com/AmazonRDS/latest/PostgreSQLReleaseNotes/postgresql-versions.html#postgresql-versions-version138) | [12\.15](https://docs.aws.amazon.com/AmazonRDS/latest/PostgreSQLReleaseNotes/postgresql-versions.html#postgresql-versions-version1215) | [12\.14](https://docs.aws.amazon.com/AmazonRDS/latest/PostgreSQLReleaseNotes/postgresql-versions.html#postgresql-versions-version1214) | [12\.13](https://docs.aws.amazon.com/AmazonRDS/latest/PostgreSQLReleaseNotes/postgresql-versions.html#postgresql-versions-version1213) | | | | | | | | | | | -| 12\.11 | | [14\.4](https://docs.aws.amazon.com/AmazonRDS/latest/PostgreSQLReleaseNotes/postgresql-versions.html#postgresql-versions-version144) | [14\.3](https://docs.aws.amazon.com/AmazonRDS/latest/PostgreSQLReleaseNotes/postgresql-versions.html#postgresql-versions-version143) | [13\.11](https://docs.aws.amazon.com/AmazonRDS/latest/PostgreSQLReleaseNotes/postgresql-versions.html#postgresql-versions-version1311) | [13\.10](https://docs.aws.amazon.com/AmazonRDS/latest/PostgreSQLReleaseNotes/postgresql-versions.html#postgresql-versions-version1310) | [13\.9](https://docs.aws.amazon.com/AmazonRDS/latest/PostgreSQLReleaseNotes/postgresql-versions.html#postgresql-versions-version139) | [13\.8](https://docs.aws.amazon.com/AmazonRDS/latest/PostgreSQLReleaseNotes/postgresql-versions.html#postgresql-versions-version138) | [13\.7](https://docs.aws.amazon.com/AmazonRDS/latest/PostgreSQLReleaseNotes/postgresql-versions.html#postgresql-versions-version137) | [12\.15](https://docs.aws.amazon.com/AmazonRDS/latest/PostgreSQLReleaseNotes/postgresql-versions.html#postgresql-versions-version1215) | [12\.14](https://docs.aws.amazon.com/AmazonRDS/latest/PostgreSQLReleaseNotes/postgresql-versions.html#postgresql-versions-version1214) | [12\.13](https://docs.aws.amazon.com/AmazonRDS/latest/PostgreSQLReleaseNotes/postgresql-versions.html#postgresql-versions-version1213) | [12\.12](https://docs.aws.amazon.com/AmazonRDS/latest/PostgreSQLReleaseNotes/postgresql-versions.html#postgresql-versions-version1212) | | | | | | | | -| 12\.10 | | [14\.2](https://docs.aws.amazon.com/AmazonRDS/latest/PostgreSQLReleaseNotes/postgresql-versions.html#postgresql-versions-version142) | [13\.11](https://docs.aws.amazon.com/AmazonRDS/latest/PostgreSQLReleaseNotes/postgresql-versions.html#postgresql-versions-version1311) | [13\.10](https://docs.aws.amazon.com/AmazonRDS/latest/PostgreSQLReleaseNotes/postgresql-versions.html#postgresql-versions-version1310) | [13\.9](https://docs.aws.amazon.com/AmazonRDS/latest/PostgreSQLReleaseNotes/postgresql-versions.html#postgresql-versions-version139) | [13\.8](https://docs.aws.amazon.com/AmazonRDS/latest/PostgreSQLReleaseNotes/postgresql-versions.html#postgresql-versions-version138) | [13\.7](https://docs.aws.amazon.com/AmazonRDS/latest/PostgreSQLReleaseNotes/postgresql-versions.html#postgresql-versions-version137) | [13\.6](https://docs.aws.amazon.com/AmazonRDS/latest/PostgreSQLReleaseNotes/postgresql-versions.html#postgresql-versions-version136) | [12\.15](https://docs.aws.amazon.com/AmazonRDS/latest/PostgreSQLReleaseNotes/postgresql-versions.html#postgresql-versions-version1215) | [12\.14](https://docs.aws.amazon.com/AmazonRDS/latest/PostgreSQLReleaseNotes/postgresql-versions.html#postgresql-versions-version1214) | [12\.13](https://docs.aws.amazon.com/AmazonRDS/latest/PostgreSQLReleaseNotes/postgresql-versions.html#postgresql-versions-version1213) | [12\.12](https://docs.aws.amazon.com/AmazonRDS/latest/PostgreSQLReleaseNotes/postgresql-versions.html#postgresql-versions-version1212) | [12\.11](https://docs.aws.amazon.com/AmazonRDS/latest/PostgreSQLReleaseNotes/postgresql-versions.html#postgresql-versions-version1211) | | | | | | | -| 12\.9 | | [14\.1](https://docs.aws.amazon.com/AmazonRDS/latest/PostgreSQLReleaseNotes/postgresql-versions.html#postgresql-versions-version141) | [13\.11](https://docs.aws.amazon.com/AmazonRDS/latest/PostgreSQLReleaseNotes/postgresql-versions.html#postgresql-versions-version1311) | [13\.10](https://docs.aws.amazon.com/AmazonRDS/latest/PostgreSQLReleaseNotes/postgresql-versions.html#postgresql-versions-version1310) | [13\.9](https://docs.aws.amazon.com/AmazonRDS/latest/PostgreSQLReleaseNotes/postgresql-versions.html#postgresql-versions-version139) | [13\.8](https://docs.aws.amazon.com/AmazonRDS/latest/PostgreSQLReleaseNotes/postgresql-versions.html#postgresql-versions-version138) | [13\.7](https://docs.aws.amazon.com/AmazonRDS/latest/PostgreSQLReleaseNotes/postgresql-versions.html#postgresql-versions-version137) | [13\.6](https://docs.aws.amazon.com/AmazonRDS/latest/PostgreSQLReleaseNotes/postgresql-versions.html#postgresql-versions-version136) | [13\.5](https://docs.aws.amazon.com/AmazonRDS/latest/PostgreSQLReleaseNotes/postgresql-versions.html#postgresql-versions-version135) | [12\.15](https://docs.aws.amazon.com/AmazonRDS/latest/PostgreSQLReleaseNotes/postgresql-versions.html#postgresql-versions-version1215) | [12\.14](https://docs.aws.amazon.com/AmazonRDS/latest/PostgreSQLReleaseNotes/postgresql-versions.html#postgresql-versions-version1214) | [12\.13](https://docs.aws.amazon.com/AmazonRDS/latest/PostgreSQLReleaseNotes/postgresql-versions.html#postgresql-versions-version1213) | [12\.12](https://docs.aws.amazon.com/AmazonRDS/latest/PostgreSQLReleaseNotes/postgresql-versions.html#postgresql-versions-version1212) | [12\.11](https://docs.aws.amazon.com/AmazonRDS/latest/PostgreSQLReleaseNotes/postgresql-versions.html#postgresql-versions-version1211) | [12\.10](https://docs.aws.amazon.com/AmazonRDS/latest/PostgreSQLReleaseNotes/postgresql-versions.html#postgresql-versions-version1210) | | | | | -| 12\.8 | | [13\.11](https://docs.aws.amazon.com/AmazonRDS/latest/PostgreSQLReleaseNotes/postgresql-versions.html#postgresql-versions-version1311) | [13\.10](https://docs.aws.amazon.com/AmazonRDS/latest/PostgreSQLReleaseNotes/postgresql-versions.html#postgresql-versions-version1310) | [13\.9](https://docs.aws.amazon.com/AmazonRDS/latest/PostgreSQLReleaseNotes/postgresql-versions.html#postgresql-versions-version139) | [13\.8](https://docs.aws.amazon.com/AmazonRDS/latest/PostgreSQLReleaseNotes/postgresql-versions.html#postgresql-versions-version138) | [13\.7](https://docs.aws.amazon.com/AmazonRDS/latest/PostgreSQLReleaseNotes/postgresql-versions.html#postgresql-versions-version137) | [13\.6](https://docs.aws.amazon.com/AmazonRDS/latest/PostgreSQLReleaseNotes/postgresql-versions.html#postgresql-versions-version136) | [13\.5](https://docs.aws.amazon.com/AmazonRDS/latest/PostgreSQLReleaseNotes/postgresql-versions.html#postgresql-versions-version135) | [13\.4](https://docs.aws.amazon.com/AmazonRDS/latest/PostgreSQLReleaseNotes/postgresql-versions.html#postgresql-versions-version134) | [12\.15](https://docs.aws.amazon.com/AmazonRDS/latest/PostgreSQLReleaseNotes/postgresql-versions.html#postgresql-versions-version1215) | [12\.14](https://docs.aws.amazon.com/AmazonRDS/latest/PostgreSQLReleaseNotes/postgresql-versions.html#postgresql-versions-version1214) | [12\.13](https://docs.aws.amazon.com/AmazonRDS/latest/PostgreSQLReleaseNotes/postgresql-versions.html#postgresql-versions-version1213) | [12\.12](https://docs.aws.amazon.com/AmazonRDS/latest/PostgreSQLReleaseNotes/postgresql-versions.html#postgresql-versions-version1212) | [12\.11](https://docs.aws.amazon.com/AmazonRDS/latest/PostgreSQLReleaseNotes/postgresql-versions.html#postgresql-versions-version1211) | [12\.10](https://docs.aws.amazon.com/AmazonRDS/latest/PostgreSQLReleaseNotes/postgresql-versions.html#postgresql-versions-version1210) | [12\.9](https://docs.aws.amazon.com/AmazonRDS/latest/PostgreSQLReleaseNotes/postgresql-versions.html#postgresql-versions-version129) | | | | -| 12\.7 | | [13\.11](https://docs.aws.amazon.com/AmazonRDS/latest/PostgreSQLReleaseNotes/postgresql-versions.html#postgresql-versions-version1311) | [13\.10](https://docs.aws.amazon.com/AmazonRDS/latest/PostgreSQLReleaseNotes/postgresql-versions.html#postgresql-versions-version1310) | [13\.9](https://docs.aws.amazon.com/AmazonRDS/latest/PostgreSQLReleaseNotes/postgresql-versions.html#postgresql-versions-version139) | [13\.8](https://docs.aws.amazon.com/AmazonRDS/latest/PostgreSQLReleaseNotes/postgresql-versions.html#postgresql-versions-version138) | [13\.7](https://docs.aws.amazon.com/AmazonRDS/latest/PostgreSQLReleaseNotes/postgresql-versions.html#postgresql-versions-version137) | [13\.6](https://docs.aws.amazon.com/AmazonRDS/latest/PostgreSQLReleaseNotes/postgresql-versions.html#postgresql-versions-version136) | [13\.5](https://docs.aws.amazon.com/AmazonRDS/latest/PostgreSQLReleaseNotes/postgresql-versions.html#postgresql-versions-version135) | [13\.4](https://docs.aws.amazon.com/AmazonRDS/latest/PostgreSQLReleaseNotes/postgresql-versions.html#postgresql-versions-version134) | [13\.3](https://docs.aws.amazon.com/AmazonRDS/latest/PostgreSQLReleaseNotes/postgresql-versions.html#postgresql-versions-version133) | [12\.15](https://docs.aws.amazon.com/AmazonRDS/latest/PostgreSQLReleaseNotes/postgresql-versions.html#postgresql-versions-version1215) | [12\.14](https://docs.aws.amazon.com/AmazonRDS/latest/PostgreSQLReleaseNotes/postgresql-versions.html#postgresql-versions-version1214) | [12\.13](https://docs.aws.amazon.com/AmazonRDS/latest/PostgreSQLReleaseNotes/postgresql-versions.html#postgresql-versions-version1213) | [12\.12](https://docs.aws.amazon.com/AmazonRDS/latest/PostgreSQLReleaseNotes/postgresql-versions.html#postgresql-versions-version1212) | [12\.11](https://docs.aws.amazon.com/AmazonRDS/latest/PostgreSQLReleaseNotes/postgresql-versions.html#postgresql-versions-version1211) | [12\.10](https://docs.aws.amazon.com/AmazonRDS/latest/PostgreSQLReleaseNotes/postgresql-versions.html#postgresql-versions-version1210) | [12\.9](https://docs.aws.amazon.com/AmazonRDS/latest/PostgreSQLReleaseNotes/postgresql-versions.html#postgresql-versions-version129) | [12\.8](https://docs.aws.amazon.com/AmazonRDS/latest/PostgreSQLReleaseNotes/postgresql-versions.html#postgresql-versions-version128) | | -| 12\.6\*, 12\.5\*, 12\.4\*, 12\.3\*, 12\.2\*, 12\.1\* | | [13\.11](https://docs.aws.amazon.com/AmazonRDS/latest/PostgreSQLReleaseNotes/postgresql-versions.html#postgresql-versions-version1311) | [13\.7](https://docs.aws.amazon.com/AmazonRDS/latest/PostgreSQLReleaseNotes/postgresql-versions.html#postgresql-versions-version137) | [13\.6](https://docs.aws.amazon.com/AmazonRDS/latest/PostgreSQLReleaseNotes/postgresql-versions.html#postgresql-versions-version136) | [12\.15](https://docs.aws.amazon.com/AmazonRDS/latest/PostgreSQLReleaseNotes/postgresql-versions.html#postgresql-versions-version1215) | [12\.14](https://docs.aws.amazon.com/AmazonRDS/latest/PostgreSQLReleaseNotes/postgresql-versions.html#postgresql-versions-version1214) | [12\.13](https://docs.aws.amazon.com/AmazonRDS/latest/PostgreSQLReleaseNotes/postgresql-versions.html#postgresql-versions-version1213) | [12\.12](https://docs.aws.amazon.com/AmazonRDS/latest/PostgreSQLReleaseNotes/postgresql-versions.html#postgresql-versions-version1212) | [12\.11](https://docs.aws.amazon.com/AmazonRDS/latest/PostgreSQLReleaseNotes/postgresql-versions.html#postgresql-versions-version1211) | [12\.10](https://docs.aws.amazon.com/AmazonRDS/latest/PostgreSQLReleaseNotes/postgresql-versions.html#postgresql-versions-version1210) | [12\.9](https://docs.aws.amazon.com/AmazonRDS/latest/PostgreSQLReleaseNotes/postgresql-versions.html#postgresql-versions-version129) | [12\.8](https://docs.aws.amazon.com/AmazonRDS/latest/PostgreSQLReleaseNotes/postgresql-versions.html#postgresql-versions-version128) | [12\.7](https://docs.aws.amazon.com/AmazonRDS/latest/PostgreSQLReleaseNotes/postgresql-versions.html#postgresql-versions-version127) | | | | | | | -| 11\.20 | | [15\.3](https://docs.aws.amazon.com/AmazonRDS/latest/PostgreSQLReleaseNotes/postgresql-versions.html#postgresql-versions-version153) | [14\.8](https://docs.aws.amazon.com/AmazonRDS/latest/PostgreSQLReleaseNotes/postgresql-versions.html#postgresql-versions-version148) | [13\.11](https://docs.aws.amazon.com/AmazonRDS/latest/PostgreSQLReleaseNotes/postgresql-versions.html#postgresql-versions-version1311) | [12\.15](https://docs.aws.amazon.com/AmazonRDS/latest/PostgreSQLReleaseNotes/postgresql-versions.html#postgresql-versions-version1215) | | | | | | | | | | | | | | | -| 11\.19 | | [15\.2](https://docs.aws.amazon.com/AmazonRDS/latest/PostgreSQLReleaseNotes/postgresql-versions.html#postgresql-versions-version152) | [14\.7](https://docs.aws.amazon.com/AmazonRDS/latest/PostgreSQLReleaseNotes/postgresql-versions.html#postgresql-versions-version147) | [13\.10](https://docs.aws.amazon.com/AmazonRDS/latest/PostgreSQLReleaseNotes/postgresql-versions.html#postgresql-versions-version1310) | [12\.15](https://docs.aws.amazon.com/AmazonRDS/latest/PostgreSQLReleaseNotes/postgresql-versions.html#postgresql-versions-version1215) | [12\.14](https://docs.aws.amazon.com/AmazonRDS/latest/PostgreSQLReleaseNotes/postgresql-versions.html#postgresql-versions-version1214) | [11\.20](https://docs.aws.amazon.com/AmazonRDS/latest/PostgreSQLReleaseNotes/postgresql-versions.html#postgresql-versions-version1120) | | | | | | | | | | | | | -| 11\.18 | | [14\.6](https://docs.aws.amazon.com/AmazonRDS/latest/PostgreSQLReleaseNotes/postgresql-versions.html#postgresql-versions-version146) | [13\.9](https://docs.aws.amazon.com/AmazonRDS/latest/PostgreSQLReleaseNotes/postgresql-versions.html#postgresql-versions-version139) | [12\.15](https://docs.aws.amazon.com/AmazonRDS/latest/PostgreSQLReleaseNotes/postgresql-versions.html#postgresql-versions-version1215) | [12\.14](https://docs.aws.amazon.com/AmazonRDS/latest/PostgreSQLReleaseNotes/postgresql-versions.html#postgresql-versions-version1214) | [12\.13](https://docs.aws.amazon.com/AmazonRDS/latest/PostgreSQLReleaseNotes/postgresql-versions.html#postgresql-versions-version1213) | [11\.20](https://docs.aws.amazon.com/AmazonRDS/latest/PostgreSQLReleaseNotes/postgresql-versions.html#postgresql-versions-version1120) | [11\.19](https://docs.aws.amazon.com/AmazonRDS/latest/PostgreSQLReleaseNotes/postgresql-versions.html#postgresql-versions-version1119) | | | | | | | | | | | | -| 11\.17 | | [14\.5](https://docs.aws.amazon.com/AmazonRDS/latest/PostgreSQLReleaseNotes/postgresql-versions.html#postgresql-versions-version145) | [13\.8](https://docs.aws.amazon.com/AmazonRDS/latest/PostgreSQLReleaseNotes/postgresql-versions.html#postgresql-versions-version138) | [12\.15](https://docs.aws.amazon.com/AmazonRDS/latest/PostgreSQLReleaseNotes/postgresql-versions.html#postgresql-versions-version1215) | [12\.14](https://docs.aws.amazon.com/AmazonRDS/latest/PostgreSQLReleaseNotes/postgresql-versions.html#postgresql-versions-version1214) | [12\.13](https://docs.aws.amazon.com/AmazonRDS/latest/PostgreSQLReleaseNotes/postgresql-versions.html#postgresql-versions-version1213) | [12\.12](https://docs.aws.amazon.com/AmazonRDS/latest/PostgreSQLReleaseNotes/postgresql-versions.html#postgresql-versions-version1212) | [11\.20](https://docs.aws.amazon.com/AmazonRDS/latest/PostgreSQLReleaseNotes/postgresql-versions.html#postgresql-versions-version1120) | [11\.19](https://docs.aws.amazon.com/AmazonRDS/latest/PostgreSQLReleaseNotes/postgresql-versions.html#postgresql-versions-version1119) | [11\.18](https://docs.aws.amazon.com/AmazonRDS/latest/PostgreSQLReleaseNotes/postgresql-versions.html#postgresql-versions-version1118) | | | | | | | | | | -| 11\.16 | | [14\.4](https://docs.aws.amazon.com/AmazonRDS/latest/PostgreSQLReleaseNotes/postgresql-versions.html#postgresql-versions-version144) | [14\.3](https://docs.aws.amazon.com/AmazonRDS/latest/PostgreSQLReleaseNotes/postgresql-versions.html#postgresql-versions-version143) | [13\.7](https://docs.aws.amazon.com/AmazonRDS/latest/PostgreSQLReleaseNotes/postgresql-versions.html#postgresql-versions-version137) | [12\.15](https://docs.aws.amazon.com/AmazonRDS/latest/PostgreSQLReleaseNotes/postgresql-versions.html#postgresql-versions-version1215) | [12\.14](https://docs.aws.amazon.com/AmazonRDS/latest/PostgreSQLReleaseNotes/postgresql-versions.html#postgresql-versions-version1214) | [12\.13](https://docs.aws.amazon.com/AmazonRDS/latest/PostgreSQLReleaseNotes/postgresql-versions.html#postgresql-versions-version1213) | [12\.12](https://docs.aws.amazon.com/AmazonRDS/latest/PostgreSQLReleaseNotes/postgresql-versions.html#postgresql-versions-version1212) | [12\.11](https://docs.aws.amazon.com/AmazonRDS/latest/PostgreSQLReleaseNotes/postgresql-versions.html#postgresql-versions-version1211) | [11\.20](https://docs.aws.amazon.com/AmazonRDS/latest/PostgreSQLReleaseNotes/postgresql-versions.html#postgresql-versions-version1120) | [11\.19](https://docs.aws.amazon.com/AmazonRDS/latest/PostgreSQLReleaseNotes/postgresql-versions.html#postgresql-versions-version1119) | [11\.18](https://docs.aws.amazon.com/AmazonRDS/latest/PostgreSQLReleaseNotes/postgresql-versions.html#postgresql-versions-version1118) | [11\.17](https://docs.aws.amazon.com/AmazonRDS/latest/PostgreSQLReleaseNotes/postgresql-versions.html#postgresql-versions-version1117) | | | | | | | -| 11\.15 | | [14\.2](https://docs.aws.amazon.com/AmazonRDS/latest/PostgreSQLReleaseNotes/postgresql-versions.html#postgresql-versions-version142) | [13\.6](https://docs.aws.amazon.com/AmazonRDS/latest/PostgreSQLReleaseNotes/postgresql-versions.html#postgresql-versions-version136) | [12\.15](https://docs.aws.amazon.com/AmazonRDS/latest/PostgreSQLReleaseNotes/postgresql-versions.html#postgresql-versions-version1215) | [12\.14](https://docs.aws.amazon.com/AmazonRDS/latest/PostgreSQLReleaseNotes/postgresql-versions.html#postgresql-versions-version1214) | [12\.13](https://docs.aws.amazon.com/AmazonRDS/latest/PostgreSQLReleaseNotes/postgresql-versions.html#postgresql-versions-version1213) | [12\.12](https://docs.aws.amazon.com/AmazonRDS/latest/PostgreSQLReleaseNotes/postgresql-versions.html#postgresql-versions-version1212) | [12\.11](https://docs.aws.amazon.com/AmazonRDS/latest/PostgreSQLReleaseNotes/postgresql-versions.html#postgresql-versions-version1211) | [12\.10](https://docs.aws.amazon.com/AmazonRDS/latest/PostgreSQLReleaseNotes/postgresql-versions.html#postgresql-versions-version1210) | [11\.20](https://docs.aws.amazon.com/AmazonRDS/latest/PostgreSQLReleaseNotes/postgresql-versions.html#postgresql-versions-version1120) | [11\.19](https://docs.aws.amazon.com/AmazonRDS/latest/PostgreSQLReleaseNotes/postgresql-versions.html#postgresql-versions-version1119) | [11\.18](https://docs.aws.amazon.com/AmazonRDS/latest/PostgreSQLReleaseNotes/postgresql-versions.html#postgresql-versions-version1118) | [11\.17](https://docs.aws.amazon.com/AmazonRDS/latest/PostgreSQLReleaseNotes/postgresql-versions.html#postgresql-versions-version1117) | [11\.16](https://docs.aws.amazon.com/AmazonRDS/latest/PostgreSQLReleaseNotes/postgresql-versions.html#postgresql-versions-version1116) | | | | | | -| 11\.14 | | [14\.1](https://docs.aws.amazon.com/AmazonRDS/latest/PostgreSQLReleaseNotes/postgresql-versions.html#postgresql-versions-version141) | [13\.5](https://docs.aws.amazon.com/AmazonRDS/latest/PostgreSQLReleaseNotes/postgresql-versions.html#postgresql-versions-version135) | [12\.15](https://docs.aws.amazon.com/AmazonRDS/latest/PostgreSQLReleaseNotes/postgresql-versions.html#postgresql-versions-version1215) | [12\.14](https://docs.aws.amazon.com/AmazonRDS/latest/PostgreSQLReleaseNotes/postgresql-versions.html#postgresql-versions-version1214) | [12\.13](https://docs.aws.amazon.com/AmazonRDS/latest/PostgreSQLReleaseNotes/postgresql-versions.html#postgresql-versions-version1213) | [12\.12](https://docs.aws.amazon.com/AmazonRDS/latest/PostgreSQLReleaseNotes/postgresql-versions.html#postgresql-versions-version1212) | [12\.11](https://docs.aws.amazon.com/AmazonRDS/latest/PostgreSQLReleaseNotes/postgresql-versions.html#postgresql-versions-version1211) | [12\.10](https://docs.aws.amazon.com/AmazonRDS/latest/PostgreSQLReleaseNotes/postgresql-versions.html#postgresql-versions-version1210) | [12\.9](https://docs.aws.amazon.com/AmazonRDS/latest/PostgreSQLReleaseNotes/postgresql-versions.html#postgresql-versions-version129) | [11\.20](https://docs.aws.amazon.com/AmazonRDS/latest/PostgreSQLReleaseNotes/postgresql-versions.html#postgresql-versions-version1120) | [11\.19](https://docs.aws.amazon.com/AmazonRDS/latest/PostgreSQLReleaseNotes/postgresql-versions.html#postgresql-versions-version1119) | [11\.18](https://docs.aws.amazon.com/AmazonRDS/latest/PostgreSQLReleaseNotes/postgresql-versions.html#postgresql-versions-version1118) | [11\.17](https://docs.aws.amazon.com/AmazonRDS/latest/PostgreSQLReleaseNotes/postgresql-versions.html#postgresql-versions-version1117) | [11\.16](https://docs.aws.amazon.com/AmazonRDS/latest/PostgreSQLReleaseNotes/postgresql-versions.html#postgresql-versions-version1116) | [11\.15](https://docs.aws.amazon.com/AmazonRDS/latest/PostgreSQLReleaseNotes/postgresql-versions.html#postgresql-versions-version1115) | | | | -| 11\.13 | | [13\.4](https://docs.aws.amazon.com/AmazonRDS/latest/PostgreSQLReleaseNotes/postgresql-versions.html#postgresql-versions-version134) | [12\.15](https://docs.aws.amazon.com/AmazonRDS/latest/PostgreSQLReleaseNotes/postgresql-versions.html#postgresql-versions-version1215) | [12\.14](https://docs.aws.amazon.com/AmazonRDS/latest/PostgreSQLReleaseNotes/postgresql-versions.html#postgresql-versions-version1214) | [12\.13](https://docs.aws.amazon.com/AmazonRDS/latest/PostgreSQLReleaseNotes/postgresql-versions.html#postgresql-versions-version1213) | [12\.12](https://docs.aws.amazon.com/AmazonRDS/latest/PostgreSQLReleaseNotes/postgresql-versions.html#postgresql-versions-version1212) | [12\.11](https://docs.aws.amazon.com/AmazonRDS/latest/PostgreSQLReleaseNotes/postgresql-versions.html#postgresql-versions-version1211) | [12\.10](https://docs.aws.amazon.com/AmazonRDS/latest/PostgreSQLReleaseNotes/postgresql-versions.html#postgresql-versions-version1210) | [12\.9](https://docs.aws.amazon.com/AmazonRDS/latest/PostgreSQLReleaseNotes/postgresql-versions.html#postgresql-versions-version129) | [12\.8](https://docs.aws.amazon.com/AmazonRDS/latest/PostgreSQLReleaseNotes/postgresql-versions.html#postgresql-versions-version128) | [11\.20](https://docs.aws.amazon.com/AmazonRDS/latest/PostgreSQLReleaseNotes/postgresql-versions.html#postgresql-versions-version1120) | [11\.19](https://docs.aws.amazon.com/AmazonRDS/latest/PostgreSQLReleaseNotes/postgresql-versions.html#postgresql-versions-version1119) | [11\.18](https://docs.aws.amazon.com/AmazonRDS/latest/PostgreSQLReleaseNotes/postgresql-versions.html#postgresql-versions-version1118) | [11\.17](https://docs.aws.amazon.com/AmazonRDS/latest/PostgreSQLReleaseNotes/postgresql-versions.html#postgresql-versions-version1117) | [11\.16](https://docs.aws.amazon.com/AmazonRDS/latest/PostgreSQLReleaseNotes/postgresql-versions.html#postgresql-versions-version1116) | [11\.15](https://docs.aws.amazon.com/AmazonRDS/latest/PostgreSQLReleaseNotes/postgresql-versions.html#postgresql-versions-version1115) | [11\.14](https://docs.aws.amazon.com/AmazonRDS/latest/PostgreSQLReleaseNotes/postgresql-versions.html#postgresql-versions-version1114) | | | -| 11\.12 | | [13\.3](https://docs.aws.amazon.com/AmazonRDS/latest/PostgreSQLReleaseNotes/postgresql-versions.html#postgresql-versions-version133) | [12\.15](https://docs.aws.amazon.com/AmazonRDS/latest/PostgreSQLReleaseNotes/postgresql-versions.html#postgresql-versions-version1215) | [12\.14](https://docs.aws.amazon.com/AmazonRDS/latest/PostgreSQLReleaseNotes/postgresql-versions.html#postgresql-versions-version1214) | [12\.13](https://docs.aws.amazon.com/AmazonRDS/latest/PostgreSQLReleaseNotes/postgresql-versions.html#postgresql-versions-version1213) | [12\.12](https://docs.aws.amazon.com/AmazonRDS/latest/PostgreSQLReleaseNotes/postgresql-versions.html#postgresql-versions-version1212) | [12\.11](https://docs.aws.amazon.com/AmazonRDS/latest/PostgreSQLReleaseNotes/postgresql-versions.html#postgresql-versions-version1211) | [12\.10](https://docs.aws.amazon.com/AmazonRDS/latest/PostgreSQLReleaseNotes/postgresql-versions.html#postgresql-versions-version1210) | [12\.9](https://docs.aws.amazon.com/AmazonRDS/latest/PostgreSQLReleaseNotes/postgresql-versions.html#postgresql-versions-version129) | [12\.8](https://docs.aws.amazon.com/AmazonRDS/latest/PostgreSQLReleaseNotes/postgresql-versions.html#postgresql-versions-version128) | [12\.7](https://docs.aws.amazon.com/AmazonRDS/latest/PostgreSQLReleaseNotes/postgresql-versions.html#postgresql-versions-version127) | [11\.20](https://docs.aws.amazon.com/AmazonRDS/latest/PostgreSQLReleaseNotes/postgresql-versions.html#postgresql-versions-version1120) | [11\.19](https://docs.aws.amazon.com/AmazonRDS/latest/PostgreSQLReleaseNotes/postgresql-versions.html#postgresql-versions-version1119) | [11\.18](https://docs.aws.amazon.com/AmazonRDS/latest/PostgreSQLReleaseNotes/postgresql-versions.html#postgresql-versions-version1118) | [11\.17](https://docs.aws.amazon.com/AmazonRDS/latest/PostgreSQLReleaseNotes/postgresql-versions.html#postgresql-versions-version1117) | [11\.16](https://docs.aws.amazon.com/AmazonRDS/latest/PostgreSQLReleaseNotes/postgresql-versions.html#postgresql-versions-version1116) | [11\.15](https://docs.aws.amazon.com/AmazonRDS/latest/PostgreSQLReleaseNotes/postgresql-versions.html#postgresql-versions-version1115) | [11\.14](https://docs.aws.amazon.com/AmazonRDS/latest/PostgreSQLReleaseNotes/postgresql-versions.html#postgresql-versions-version1114) | [11\.13](https://docs.aws.amazon.com/AmazonRDS/latest/PostgreSQLReleaseNotes/postgresql-versions.html#postgresql-versions-version1113) | -| 10\.23 | | [14\.6](https://docs.aws.amazon.com/AmazonRDS/latest/PostgreSQLReleaseNotes/postgresql-versions.html#postgresql-versions-version146) | [13\.9](https://docs.aws.amazon.com/AmazonRDS/latest/PostgreSQLReleaseNotes/postgresql-versions.html#postgresql-versions-version139) | [12\.13](https://docs.aws.amazon.com/AmazonRDS/latest/PostgreSQLReleaseNotes/postgresql-versions.html#postgresql-versions-version1213) | [11\.20](https://docs.aws.amazon.com/AmazonRDS/latest/PostgreSQLReleaseNotes/postgresql-versions.html#postgresql-versions-version1120) | [11\.19](https://docs.aws.amazon.com/AmazonRDS/latest/PostgreSQLReleaseNotes/postgresql-versions.html#postgresql-versions-version1119) | [11\.18](https://docs.aws.amazon.com/AmazonRDS/latest/PostgreSQLReleaseNotes/postgresql-versions.html#postgresql-versions-version1118) | | | | | | | | | | | | | -| 10\.22 | | [14\.5](https://docs.aws.amazon.com/AmazonRDS/latest/PostgreSQLReleaseNotes/postgresql-versions.html#postgresql-versions-version145) | [13\.8](https://docs.aws.amazon.com/AmazonRDS/latest/PostgreSQLReleaseNotes/postgresql-versions.html#postgresql-versions-version138) | [12\.12](https://docs.aws.amazon.com/AmazonRDS/latest/PostgreSQLReleaseNotes/postgresql-versions.html#postgresql-versions-version1212) | [11\.20](https://docs.aws.amazon.com/AmazonRDS/latest/PostgreSQLReleaseNotes/postgresql-versions.html#postgresql-versions-version1120) | [11\.19](https://docs.aws.amazon.com/AmazonRDS/latest/PostgreSQLReleaseNotes/postgresql-versions.html#postgresql-versions-version1119) | [11\.18](https://docs.aws.amazon.com/AmazonRDS/latest/PostgreSQLReleaseNotes/postgresql-versions.html#postgresql-versions-version1118) | [11\.17](https://docs.aws.amazon.com/AmazonRDS/latest/PostgreSQLReleaseNotes/postgresql-versions.html#postgresql-versions-version1117) | [10\.23](https://docs.aws.amazon.com/AmazonRDS/latest/PostgreSQLReleaseNotes/postgresql-versions.html#postgresql-versions-version1023) | | | | | | | | | | | -| 10\.21 | | [14\.4](https://docs.aws.amazon.com/AmazonRDS/latest/PostgreSQLReleaseNotes/postgresql-versions.html#postgresql-versions-version144) | [14\.3](https://docs.aws.amazon.com/AmazonRDS/latest/PostgreSQLReleaseNotes/postgresql-versions.html#postgresql-versions-version143) | [13\.7](https://docs.aws.amazon.com/AmazonRDS/latest/PostgreSQLReleaseNotes/postgresql-versions.html#postgresql-versions-version137) | [12\.11](https://docs.aws.amazon.com/AmazonRDS/latest/PostgreSQLReleaseNotes/postgresql-versions.html#postgresql-versions-version1211) | [11\.20](https://docs.aws.amazon.com/AmazonRDS/latest/PostgreSQLReleaseNotes/postgresql-versions.html#postgresql-versions-version1120) | [11\.19](https://docs.aws.amazon.com/AmazonRDS/latest/PostgreSQLReleaseNotes/postgresql-versions.html#postgresql-versions-version1119) | [11\.18](https://docs.aws.amazon.com/AmazonRDS/latest/PostgreSQLReleaseNotes/postgresql-versions.html#postgresql-versions-version1118) | [11\.17](https://docs.aws.amazon.com/AmazonRDS/latest/PostgreSQLReleaseNotes/postgresql-versions.html#postgresql-versions-version1117) | [11\.16](https://docs.aws.amazon.com/AmazonRDS/latest/PostgreSQLReleaseNotes/postgresql-versions.html#postgresql-versions-version1116) | [10\.23](https://docs.aws.amazon.com/AmazonRDS/latest/PostgreSQLReleaseNotes/postgresql-versions.html#postgresql-versions-version1023) | [10\.22](https://docs.aws.amazon.com/AmazonRDS/latest/PostgreSQLReleaseNotes/postgresql-versions.html#postgresql-versions-version1022) | | | | | | | | -| 10\.20 | | [14\.2](https://docs.aws.amazon.com/AmazonRDS/latest/PostgreSQLReleaseNotes/postgresql-versions.html#postgresql-versions-version142) | [13\.6](https://docs.aws.amazon.com/AmazonRDS/latest/PostgreSQLReleaseNotes/postgresql-versions.html#postgresql-versions-version136) | [12\.10](https://docs.aws.amazon.com/AmazonRDS/latest/PostgreSQLReleaseNotes/postgresql-versions.html#postgresql-versions-version1210) | [11\.20](https://docs.aws.amazon.com/AmazonRDS/latest/PostgreSQLReleaseNotes/postgresql-versions.html#postgresql-versions-version1120) | [11\.19](https://docs.aws.amazon.com/AmazonRDS/latest/PostgreSQLReleaseNotes/postgresql-versions.html#postgresql-versions-version1119) | [11\.18](https://docs.aws.amazon.com/AmazonRDS/latest/PostgreSQLReleaseNotes/postgresql-versions.html#postgresql-versions-version1118) | [11\.17](https://docs.aws.amazon.com/AmazonRDS/latest/PostgreSQLReleaseNotes/postgresql-versions.html#postgresql-versions-version1117) | [11\.16](https://docs.aws.amazon.com/AmazonRDS/latest/PostgreSQLReleaseNotes/postgresql-versions.html#postgresql-versions-version1116) | [11\.15](https://docs.aws.amazon.com/AmazonRDS/latest/PostgreSQLReleaseNotes/postgresql-versions.html#postgresql-versions-version1115) | [10\.23](https://docs.aws.amazon.com/AmazonRDS/latest/PostgreSQLReleaseNotes/postgresql-versions.html#postgresql-versions-version1023) | [10\.22](https://docs.aws.amazon.com/AmazonRDS/latest/PostgreSQLReleaseNotes/postgresql-versions.html#postgresql-versions-version1022) | [10\.21](https://docs.aws.amazon.com/AmazonRDS/latest/PostgreSQLReleaseNotes/postgresql-versions.html#postgresql-versions-version1021) | | | | | | | -| 10\.19 | | [14\.1](https://docs.aws.amazon.com/AmazonRDS/latest/PostgreSQLReleaseNotes/postgresql-versions.html#postgresql-versions-version141) | [13\.5](https://docs.aws.amazon.com/AmazonRDS/latest/PostgreSQLReleaseNotes/postgresql-versions.html#postgresql-versions-version135) | [12\.9](https://docs.aws.amazon.com/AmazonRDS/latest/PostgreSQLReleaseNotes/postgresql-versions.html#postgresql-versions-version129) | [11\.20](https://docs.aws.amazon.com/AmazonRDS/latest/PostgreSQLReleaseNotes/postgresql-versions.html#postgresql-versions-version1120) | [11\.19](https://docs.aws.amazon.com/AmazonRDS/latest/PostgreSQLReleaseNotes/postgresql-versions.html#postgresql-versions-version1119) | [11\.18](https://docs.aws.amazon.com/AmazonRDS/latest/PostgreSQLReleaseNotes/postgresql-versions.html#postgresql-versions-version1118) | [11\.17](https://docs.aws.amazon.com/AmazonRDS/latest/PostgreSQLReleaseNotes/postgresql-versions.html#postgresql-versions-version1117) | [11\.16](https://docs.aws.amazon.com/AmazonRDS/latest/PostgreSQLReleaseNotes/postgresql-versions.html#postgresql-versions-version1116) | [11\.15](https://docs.aws.amazon.com/AmazonRDS/latest/PostgreSQLReleaseNotes/postgresql-versions.html#postgresql-versions-version1115) | [11\.14](https://docs.aws.amazon.com/AmazonRDS/latest/PostgreSQLReleaseNotes/postgresql-versions.html#postgresql-versions-version1114) | [10\.23](https://docs.aws.amazon.com/AmazonRDS/latest/PostgreSQLReleaseNotes/postgresql-versions.html#postgresql-versions-version1023) | [10\.22](https://docs.aws.amazon.com/AmazonRDS/latest/PostgreSQLReleaseNotes/postgresql-versions.html#postgresql-versions-version1022) | [10\.21](https://docs.aws.amazon.com/AmazonRDS/latest/PostgreSQLReleaseNotes/postgresql-versions.html#postgresql-versions-version1021) | [10\.20](https://docs.aws.amazon.com/AmazonRDS/latest/PostgreSQLReleaseNotes/postgresql-versions.html#postgresql-versions-version1020) | | | | | -| 10\.18 | | [13\.4](https://docs.aws.amazon.com/AmazonRDS/latest/PostgreSQLReleaseNotes/postgresql-versions.html#postgresql-versions-version134) | [12\.8](https://docs.aws.amazon.com/AmazonRDS/latest/PostgreSQLReleaseNotes/postgresql-versions.html#postgresql-versions-version1215) | [11\.20](https://docs.aws.amazon.com/AmazonRDS/latest/PostgreSQLReleaseNotes/postgresql-versions.html#postgresql-versions-version1120) | [11\.19](https://docs.aws.amazon.com/AmazonRDS/latest/PostgreSQLReleaseNotes/postgresql-versions.html#postgresql-versions-version1119) | [11\.18](https://docs.aws.amazon.com/AmazonRDS/latest/PostgreSQLReleaseNotes/postgresql-versions.html#postgresql-versions-version1118) | [11\.17](https://docs.aws.amazon.com/AmazonRDS/latest/PostgreSQLReleaseNotes/postgresql-versions.html#postgresql-versions-version1117) | [11\.16](https://docs.aws.amazon.com/AmazonRDS/latest/PostgreSQLReleaseNotes/postgresql-versions.html#postgresql-versions-version1116) | [11\.15](https://docs.aws.amazon.com/AmazonRDS/latest/PostgreSQLReleaseNotes/postgresql-versions.html#postgresql-versions-version1115) | [11\.14](https://docs.aws.amazon.com/AmazonRDS/latest/PostgreSQLReleaseNotes/postgresql-versions.html#postgresql-versions-version1114) | [11\.13](https://docs.aws.amazon.com/AmazonRDS/latest/PostgreSQLReleaseNotes/postgresql-versions.html#postgresql-versions-version1113) | [10\.23](https://docs.aws.amazon.com/AmazonRDS/latest/PostgreSQLReleaseNotes/postgresql-versions.html#postgresql-versions-version1023) | [10\.22](https://docs.aws.amazon.com/AmazonRDS/latest/PostgreSQLReleaseNotes/postgresql-versions.html#postgresql-versions-version1022) | [10\.21](https://docs.aws.amazon.com/AmazonRDS/latest/PostgreSQLReleaseNotes/postgresql-versions.html#postgresql-versions-version1021) | [10\.20](https://docs.aws.amazon.com/AmazonRDS/latest/PostgreSQLReleaseNotes/postgresql-versions.html#postgresql-versions-version1020) | [10\.19](https://docs.aws.amazon.com/AmazonRDS/latest/PostgreSQLReleaseNotes/postgresql-versions.html#postgresql-versions-version1019) | | | | -| 10\.17 | | [13\.3](https://docs.aws.amazon.com/AmazonRDS/latest/PostgreSQLReleaseNotes/postgresql-versions.html#postgresql-versions-version133) | [12\.7](https://docs.aws.amazon.com/AmazonRDS/latest/PostgreSQLReleaseNotes/postgresql-versions.html#postgresql-versions-version1215) | [11\.20](https://docs.aws.amazon.com/AmazonRDS/latest/PostgreSQLReleaseNotes/postgresql-versions.html#postgresql-versions-version1120) | [11\.19](https://docs.aws.amazon.com/AmazonRDS/latest/PostgreSQLReleaseNotes/postgresql-versions.html#postgresql-versions-version1119) | [11\.18](https://docs.aws.amazon.com/AmazonRDS/latest/PostgreSQLReleaseNotes/postgresql-versions.html#postgresql-versions-version1118) | [11\.17](https://docs.aws.amazon.com/AmazonRDS/latest/PostgreSQLReleaseNotes/postgresql-versions.html#postgresql-versions-version1117) | [11\.16](https://docs.aws.amazon.com/AmazonRDS/latest/PostgreSQLReleaseNotes/postgresql-versions.html#postgresql-versions-version1116) | [11\.15](https://docs.aws.amazon.com/AmazonRDS/latest/PostgreSQLReleaseNotes/postgresql-versions.html#postgresql-versions-version1115) | [11\.14](https://docs.aws.amazon.com/AmazonRDS/latest/PostgreSQLReleaseNotes/postgresql-versions.html#postgresql-versions-version1114) | [11\.13](https://docs.aws.amazon.com/AmazonRDS/latest/PostgreSQLReleaseNotes/postgresql-versions.html#postgresql-versions-version1113) | [11\.12](https://docs.aws.amazon.com/AmazonRDS/latest/PostgreSQLReleaseNotes/postgresql-versions.html#postgresql-versions-version1112) | [10\.23](https://docs.aws.amazon.com/AmazonRDS/latest/PostgreSQLReleaseNotes/postgresql-versions.html#postgresql-versions-version1023) | [10\.22](https://docs.aws.amazon.com/AmazonRDS/latest/PostgreSQLReleaseNotes/postgresql-versions.html#postgresql-versions-version1022) | [10\.21](https://docs.aws.amazon.com/AmazonRDS/latest/PostgreSQLReleaseNotes/postgresql-versions.html#postgresql-versions-version1021) | [10\.20](https://docs.aws.amazon.com/AmazonRDS/latest/PostgreSQLReleaseNotes/postgresql-versions.html#postgresql-versions-version1020) | [10\.19](https://docs.aws.amazon.com/AmazonRDS/latest/PostgreSQLReleaseNotes/postgresql-versions.html#postgresql-versions-version1019) | [10\.18](https://docs.aws.amazon.com/AmazonRDS/latest/PostgreSQLReleaseNotes/postgresql-versions.html#postgresql-versions-version1018) | | -| 9\.6\.24 | | [14\.1](https://docs.aws.amazon.com/AmazonRDS/latest/PostgreSQLReleaseNotes/postgresql-versions.html#postgresql-versions-version141) | [13\.5](https://docs.aws.amazon.com/AmazonRDS/latest/PostgreSQLReleaseNotes/postgresql-versions.html#postgresql-versions-version135) | [12\.9](https://docs.aws.amazon.com/AmazonRDS/latest/PostgreSQLReleaseNotes/postgresql-versions.html#postgresql-versions-version129) | [11\.14](https://docs.aws.amazon.com/AmazonRDS/latest/PostgreSQLReleaseNotes/postgresql-versions.html#postgresql-versions-version1114) | [10\.20](https://docs.aws.amazon.com/AmazonRDS/latest/PostgreSQLReleaseNotes/postgresql-versions.html#postgresql-versions-version1019) | [10\.19](https://docs.aws.amazon.com/AmazonRDS/latest/PostgreSQLReleaseNotes/postgresql-versions.html#postgresql-versions-version1019) | | | | | | | | | | | | | -| 9\.6\.23 | | [13\.4](https://docs.aws.amazon.com/AmazonRDS/latest/PostgreSQLReleaseNotes/postgresql-versions.html#postgresql-versions-version134) | [12\.8](https://docs.aws.amazon.com/AmazonRDS/latest/PostgreSQLReleaseNotes/postgresql-versions.html#postgresql-versions-version128) | [11\.13](https://docs.aws.amazon.com/AmazonRDS/latest/PostgreSQLReleaseNotes/postgresql-versions.html#postgresql-versions-version1113) | [10\.20](https://docs.aws.amazon.com/AmazonRDS/latest/PostgreSQLReleaseNotes/postgresql-versions.html#postgresql-versions-version1020) | [10\.19](https://docs.aws.amazon.com/AmazonRDS/latest/PostgreSQLReleaseNotes/postgresql-versions.html#postgresql-versions-version1019) | [10\.18](https://docs.aws.amazon.com/AmazonRDS/latest/PostgreSQLReleaseNotes/postgresql-versions.html#postgresql-versions-version1018) | [9\.6\.24](https://docs.aws.amazon.com/AmazonRDS/latest/PostgreSQLReleaseNotes/postgresql-versions.html#postgresql-versions-version9624) | | | | | | | | | | | | -| 9\.6\.22 | | [13\.3](https://docs.aws.amazon.com/AmazonRDS/latest/PostgreSQLReleaseNotes/postgresql-versions.html#postgresql-versions-version133) | [12\.7](https://docs.aws.amazon.com/AmazonRDS/latest/PostgreSQLReleaseNotes/postgresql-versions.html#postgresql-versions-version127) | [11\.12](https://docs.aws.amazon.com/AmazonRDS/latest/PostgreSQLReleaseNotes/postgresql-versions.html#postgresql-versions-version1112) | [10\.20](https://docs.aws.amazon.com/AmazonRDS/latest/PostgreSQLReleaseNotes/postgresql-versions.html#postgresql-versions-version1020) | [10\.19](https://docs.aws.amazon.com/AmazonRDS/latest/PostgreSQLReleaseNotes/postgresql-versions.html#postgresql-versions-version1019) | [10\.18](https://docs.aws.amazon.com/AmazonRDS/latest/PostgreSQLReleaseNotes/postgresql-versions.html#postgresql-versions-version1018) | [10\.17](https://docs.aws.amazon.com/AmazonRDS/latest/PostgreSQLReleaseNotes/postgresql-versions.html#postgresql-versions-version1017) | [9\.6\.24](https://docs.aws.amazon.com/AmazonRDS/latest/PostgreSQLReleaseNotes/postgresql-versions.html#postgresql-versions-version9624) | [9\.6\.23](https://docs.aws.amazon.com/AmazonRDS/latest/PostgreSQLReleaseNotes/postgresql-versions.html#postgresql-versions-version9623) | | | | | | | | | | -| 9\.6\.19\*, 9\.6\.18\*, 9\.6\.17\*, 9\.6\.16\*, 9\.6\.15\*, 9\.6\.14\*, 9\.6\.12\*, 9\.6\.11\*9\.6\.10\*, 9\.6\.9\*, 9\.6\.8\*, 9\.6\.6\*, 9\.6\.5\*, 9\.6\.3\*, 9\.6\.2\*, 9\.6\.1\* | [9\.6\.24](https://docs.aws.amazon.com/AmazonRDS/latest/PostgreSQLReleaseNotes/postgresql-versions.html#postgresql-versions-version9624) | [14\.1](https://docs.aws.amazon.com/AmazonRDS/latest/PostgreSQLReleaseNotes/postgresql-versions.html#postgresql-versions-version141) | [13\.5](https://docs.aws.amazon.com/AmazonRDS/latest/PostgreSQLReleaseNotes/postgresql-versions.html#postgresql-versions-version135) | [12\.9](https://docs.aws.amazon.com/AmazonRDS/latest/PostgreSQLReleaseNotes/postgresql-versions.html#postgresql-versions-version129) | [11\.14](https://docs.aws.amazon.com/AmazonRDS/latest/PostgreSQLReleaseNotes/postgresql-versions.html#postgresql-versions-version1114) | [10\.20](https://docs.aws.amazon.com/AmazonRDS/latest/PostgreSQLReleaseNotes/postgresql-versions.html#postgresql-versions-version1019) | [10\.19](https://docs.aws.amazon.com/AmazonRDS/latest/PostgreSQLReleaseNotes/postgresql-versions.html#postgresql-versions-version1019) | [9\.6\.23](https://docs.aws.amazon.com/AmazonRDS/latest/PostgreSQLReleaseNotes/postgresql-versions.html#postgresql-versions-version9623) | [9\.6\.22](https://docs.aws.amazon.com/AmazonRDS/latest/PostgreSQLReleaseNotes/postgresql-versions.html#postgresql-versions-version9622) | | | | | | | | | | | - -## How to perform a major version upgrade - -We recommend the following process when upgrading an Amazon RDS PostgreSQL DB instance: - -1. **Have a version\-compatible parameter group ready** – If you are using a custom parameter group, you have two options\. You can specify a default parameter group for the new DB engine version\. Or you can create your own custom parameter group for the new DB engine version\. For more information, see [Working with parameter groups](USER_WorkingWithParamGroups.md) - -1. **Check for unsupported DB instance classes** – Check that your database's instance class is compatible with the PostgreSQL version you are upgrading to\. For more information, see [Supported DB engines for DB instance classes](Concepts.DBInstanceClass.md#Concepts.DBInstanceClass.Support)\. - -1. **Check for unsupported usage:** - + **Prepared transactions** – Commit or roll back all open prepared transactions before attempting an upgrade\. - - You can use the following query to verify that there are no open prepared transactions on your instance\. - - ``` - SELECT count(*) FROM pg_catalog.pg_prepared_xacts; - ``` - + **Reg\* data types** – Remove all uses of the *reg\** data types before attempting an upgrade\. Except for `regtype` and `regclass`, you can't upgrade the *reg\** data types\. The pg\_upgrade utility can't persist this data type, which is used by Amazon RDS to do the upgrade\. - - To verify that there are no uses of unsupported *reg\** data types, use the following query for each database\. - - ``` - SELECT count(*) FROM pg_catalog.pg_class c, pg_catalog.pg_namespace n, pg_catalog.pg_attribute a - WHERE c.oid = a.attrelid - AND NOT a.attisdropped - AND a.atttypid IN ('pg_catalog.regproc'::pg_catalog.regtype, - 'pg_catalog.regprocedure'::pg_catalog.regtype, - 'pg_catalog.regoper'::pg_catalog.regtype, - 'pg_catalog.regoperator'::pg_catalog.regtype, - 'pg_catalog.regconfig'::pg_catalog.regtype, - 'pg_catalog.regdictionary'::pg_catalog.regtype) - AND c.relnamespace = n.oid - AND n.nspname NOT IN ('pg_catalog', 'information_schema'); - ``` - - - -1. **Handle logical replication slots** – An upgrade can't occur if the instance has any logical replication slots\. Logical replication slots are typically used for AWS DMS migration and for replicating tables from the database to data lakes, BI tools, and other targets\. Before upgrading, make sure that you know the purpose of any logical replication slots that are in use, and confirm that it's okay to delete them\. If the logical replication slots are still being used, you shouldn't delete them, and you can't proceed with the upgrade\. - - If the logical replication slots aren't needed, you can delete them using the following SQL: - - ``` - SELECT * FROM pg_replication_slots; - SELECT pg_drop_replication_slot(slot_name); - ``` - - Logical replication setups that use the `pglogical` extension also need to have slots dropped for a successful major version upgrade\. For information about how to identify and drop slots created using the `pglogical` extension, see [Managing logical replication slots for RDS for PostgreSQL](Appendix.PostgreSQL.CommonDBATasks.Extensions.md#Appendix.PostgreSQL.CommonDBATasks.pglogical.handle-slots)\. - -1. **Handle read replicas** – An upgrade also upgrades the in\-Region read replicas along with the primary DB instance\. - - You can't upgrade read replicas separately\. If you could, it could lead to situations where the primary and replica DB instances have different PostgreSQL major versions\. However, read replica upgrades might increase downtime on the primary DB instance\. To prevent a read replica upgrade, promote the replica to a standalone instance or delete it before starting the upgrade process\. - - The upgrade process recreates the read replica's parameter group based on the read replica's current parameter group\. You can apply a custom parameter group to a read replica only after the upgrade completes by modifying the read replica\. For more information about read replicas, see [Working with read replicas for Amazon RDS for PostgreSQL](USER_PostgreSQL.Replication.ReadReplicas.md)\. - -1. **Perform a backup** – We recommend that you perform a backup before performing the major version upgrade so that you have a known restore point for your database\. If your backup retention period is greater than 0, the upgrade process creates DB snapshots of your DB instance before and after upgrading\. To change your backup retention period, see [Modifying an Amazon RDS DB instance](Overview.DBInstance.Modifying.md)\. To perform a backup manually, see [Creating a DB snapshot](USER_CreateSnapshot.md)\. - -1. **Upgrade certain extensions before a major version upgrade** – If you plan to skip a major version with the upgrade, you need to update certain extensions *before* performing the major version upgrade\. For example, upgrading from versions 9\.5\.x or 9\.6\.x to version 11\.x skips a major version\. The extensions to update include PostGIS and related extensions for processing spatial data\. - + `address_standardizer` - + `address_standardizer_data_us` - + `postgis_raster` - + `postgis_tiger_geocoder` - + `postgis_topology` - - Run the following command for each extension that you're using: - - ``` - ALTER EXTENSION PostgreSQL-extension UPDATE TO 'new-version'; - ``` - - For more information, see [Upgrading PostgreSQL extensions](#USER_UpgradeDBInstance.PostgreSQL.ExtensionUpgrades)\. To learn more about upgrading PostGIS, see [Step 6: Upgrade the PostGIS extension](Appendix.PostgreSQL.CommonDBATasks.PostGIS.md#Appendix.PostgreSQL.CommonDBATasks.PostGIS.Update)\. - -1. **Drop certain extensions before the major version upgrade** – An upgrade that skips a major version to version 11\.x doesn't support updating the `pgRouting` extension\. Upgrading from versions 9\.4\.x, 9\.5\.x, or 9\.6\.x to versions 11\.x skips a major version\. It's safe to drop the `pgRouting` extension and then reinstall it to a compatible version after the upgrade\. For the extension versions you can update to, see [Supported PostgreSQL extension versions](CHAP_PostgreSQL.md#PostgreSQL.Concepts.General.FeatureSupport.Extensions)\. - - The `tsearch2` and `chkpass` extensions are no longer supported for PostgreSQL versions 11 or later\. If you are upgrading to version 11\.x, drop the `tsearch2`, and `chkpass` extensions before the upgrade\. - -1. **Drop unknown data types** – Drop `unknown` data types depending on the target version\. - - PostgreSQL version 10 stopped supporting the `unknown` data type\. If a version 9\.6 database uses the `unknown` data type, an upgrade to a version 10 shows an error message such as the following: - - ``` - Database instance is in a state that cannot be upgraded: PreUpgrade checks failed: - The instance could not be upgraded because the 'unknown' data type is used in user tables. - Please remove all usages of the 'unknown' data type and try again." - ``` - - To find the `unknown` data type in your database so you can remove the offending column or change it to a supported data type, use the following SQL: - - ``` - SELECT DISTINCT data_type FROM information_schema.columns WHERE data_type ILIKE 'unknown'; - ``` - -1. **Perform an upgrade dry run** – We highly recommend testing a major version upgrade on a duplicate of your production database before attempting the upgrade on your production database\. You can monitor the execution plans on the duplicate test instance for any possible execution plan regressions and to evaluate its performance\. To create a duplicate test instance, you can either restore your database from a recent snapshot or do a point\-in\-time restore of your database to its latest restorable time\. For more information, see [Restoring from a snapshot](USER_RestoreFromSnapshot.md#USER_RestoreFromSnapshot.Restoring) or [Restoring a DB instance to a specified time](USER_PIT.md)\. For details on performing the upgrade, see [Manually upgrading the engine version](USER_UpgradeDBInstance.Upgrading.md#USER_UpgradeDBInstance.Upgrading.Manual)\. - - In upgrading a version 9\.6 DB instance to version 10, be aware that PostgreSQL 10 enables parallel queries by default\. You can test the impact of parallelism *before* the upgrade by changing the `max_parallel_workers_per_gather` parameter on your test DB instance to 2\. -**Note** - The default value for `max_parallel_workers_per_gather` parameter in the `default.postgresql10` DB parameter group is 2\. - - For more information, see [Parallel Query](https://www.postgresql.org/docs/10/parallel-query.html) in the PostgreSQL documentation\. To disable parallelism on version 10, set the `max_parallel_workers_per_gather` parameter to 0\. - - During the major version upgrade, the `public` and `template1` databases and the `public` schema in every database on the instance are temporarily renamed\. These objects appear in the logs with their original name and a random string appended\. The string is appended so that custom settings such as `locale` and `owner` are preserved during the major version upgrade\. After the upgrade completes, the objects are renamed back to their original names\. -**Note** -During the major version upgrade process, you can't do a point\-in\-time restore of your instance\. After Amazon RDS performs the upgrade, it takes an automatic backup of the instance\. You can perform a point\-in\-time restore to times before the upgrade began and after the automatic backup of your instance has completed\. - -1. **If an upgrade fails with precheck procedure errors, resolve the issues** – During the major version upgrade process, Amazon RDS for PostgreSQL first runs a precheck procedure to identify any issues that might cause the upgrade to fail\. The precheck procedure checks all potential incompatible conditions across all databases in the instance\. - - If the precheck encounters an issue, it creates a log event indicating the upgrade precheck failed\. The precheck process details are in an upgrade log named `pg_upgrade_precheck.log` for all the databases of a DB instance\. Amazon RDS appends a timestamp to the file name\. For more information about viewing logs, see [Monitoring Amazon RDS log files](USER_LogAccess.md)\. - - If a read replica upgrade fails at precheck, replication on the failed read replica is broken and the read replica is put in the terminated state\. Delete the read replica and recreate a new read replica based on the upgraded primary DB instance\. - - Resolve all of the issues identified in the precheck log and then retry the major version upgrade\. The following is an example of a precheck log\. - - ``` - ------------------------------------------------------------------------ - Upgrade could not be run on Wed Apr 4 18:30:52 2018 - ------------------------------------------------------------------------- - The instance could not be upgraded from 9.6.11 to 10.6 for the following reasons. - Please take appropriate action on databases that have usage incompatible with the requested major engine version upgrade and try the upgrade again. - - * There are uncommitted prepared transactions. Please commit or rollback all prepared transactions.* One or more role names start with 'pg_'. Rename all role names that start with 'pg_'. - - * The following issues in the database 'my"million$"db' need to be corrected before upgrading:** The ["line","reg*"] data types are used in user tables. Remove all usage of these data types. - ** The database name contains characters that are not supported by RDS for PostgreSQL. Rename the database. - ** The database has extensions installed that are not supported on the target database version. Drop the following extensions from your database: ["tsearch2"]. - - * The following issues in the database 'mydb' need to be corrected before upgrading:** The database has views or materialized views that depend on 'pg_stat_activity'. Drop the views. - ``` - -1. **If a read replica upgrade fails while upgrading the database, resolve the issue** – A failed read replica is placed in the `incompatible-restore` state and replication is terminated on the DB instance\. Delete the read replica and recreate a new read replica based on the upgraded primary DB instance\. - - A read replica upgrade might fail for the following reasons: - + It was unable to catch up with the primary DB instance even after a wait time\. - + It was in a terminal or incompatible lifecycle state such as storage\-full, incompatible\-restore, and so on\. - + When the primary DB instance upgrade started, there was a separate minor version upgrade running on the read replica\. - + The read replica used incompatible parameters\. - + The read replica was unable to communicate with the primary DB instance to synchronize the data folder\. - -1. **Upgrade your production instance** – When the dry\-run major version upgrade is successful, you should be able to upgrade your production database with confidence\. For more information, see [Manually upgrading the engine version](USER_UpgradeDBInstance.Upgrading.md#USER_UpgradeDBInstance.Upgrading.Manual)\. - -1. Run the `ANALYZE` operation to refresh the `pg_statistic` table\. You should do this for every database on all your PostgreSQL DB instances\. Optimizer statistics aren't transferred during a major version upgrade, so you need to regenerate all statistics to avoid performance issues\. Run the command without any parameters to generate statistics for all regular tables in the current database, as follows: - - ``` - ANALYZE VERBOSE; - ``` - - The `VERBOSE` flag is optional, but using it shows you the progress\. For more information, see [ANALYZE](https://www.postgresql.org/docs/10/sql-analyze.html) in the PostgreSQL documentation\. -**Note** -Run ANALYZE on your system after the upgrade to avoid performance issues\. - -After the major version upgrade is complete, we recommend the following: -+ A PostgreSQL upgrade doesn't upgrade any PostgreSQL extensions\. To upgrade extensions, see [Upgrading PostgreSQL extensions](#USER_UpgradeDBInstance.PostgreSQL.ExtensionUpgrades)\. -+ Optionally, use Amazon RDS to view two logs that the pg\_upgrade utility produces\. These are `pg_upgrade_internal.log` and `pg_upgrade_server.log`\. Amazon RDS appends a timestamp to the file name for these logs\. You can view these logs as you can any other log\. For more information, see [Monitoring Amazon RDS log files](USER_LogAccess.md)\. - - You can also upload the upgrade logs to Amazon CloudWatch Logs\. For more information, see [Publishing PostgreSQL logs to Amazon CloudWatch Logs](USER_LogAccess.Concepts.PostgreSQL.md#USER_LogAccess.Concepts.PostgreSQL.PublishtoCloudWatchLogs)\. -+ To verify that everything works as expected, test your application on the upgraded database with a similar workload\. After the upgrade is verified, you can delete this test instance\. - -## Automatic minor version upgrades for PostgreSQL - -If you enable the **Auto minor version upgrade** option when creating or modifying a DB instance, you can have your DB instance automatically upgraded\. - -For each RDS for PostgreSQL major version, one minor version is designated by RDS as the automatic upgrade version\. After a minor version has been tested and approved by Amazon RDS, the minor version upgrade occurs automatically during your maintenance window\. RDS doesn't automatically set newer released minor versions as the automatic upgrade version\. Before RDS designates a newer automatic upgrade version, several criteria are considered, such as the following: -+ Known security issues -+ Bugs in the PostgreSQL community version -+ Overall fleet stability since the minor version was released - -You can use the following AWS CLI command to determine the current automatic minor upgrade target version for a specified PostgreSQL minor version in a specific AWS Region\. - -For Linux, macOS, or Unix: - -``` -aws rds describe-db-engine-versions \ ---engine postgres \ ---engine-version minor-version \ ---region region \ ---query "DBEngineVersions[*].ValidUpgradeTarget[*].{AutoUpgrade:AutoUpgrade,EngineVersion:EngineVersion}" \ ---output text -``` - -For Windows: - -``` -aws rds describe-db-engine-versions ^ ---engine postgres ^ ---engine-version minor-version ^ ---region region ^ ---query "DBEngineVersions[*].ValidUpgradeTarget[*].{AutoUpgrade:AutoUpgrade,EngineVersion:EngineVersion}" ^ ---output text -``` - -For example, the following AWS CLI command determines the automatic minor upgrade target for PostgreSQL minor version 10\.11 in the US East \(Ohio\) AWS Region \(us\-east\-2\)\. - -For Linux, macOS, or Unix: - -``` -aws rds describe-db-engine-versions \ ---engine postgres \ ---engine-version 10.11 \ ---region us-east-2 \ ---query "DBEngineVersions[*].ValidUpgradeTarget[*].{AutoUpgrade:AutoUpgrade,EngineVersion:EngineVersion}" \ ---output table -``` - -For Windows: - -``` -aws rds describe-db-engine-versions ^ ---engine postgres ^ ---engine-version 10.11 ^ ---region us-east-2 ^ ---query "DBEngineVersions[*].ValidUpgradeTarget[*].{AutoUpgrade:AutoUpgrade,EngineVersion:EngineVersion}" ^ ---output table -``` - -Your output is similar to the following\. - -``` ----------------------------------- -| DescribeDBEngineVersions | -+--------------+-----------------+ -| AutoUpgrade | EngineVersion | -+--------------+-----------------+ -| False | 10.12 | -| False | 10.13 | -| False | 10.14 | -| False | 10.15 | -| False | 10.16 | -| True | 10.17 | -| False | 10.18 | -| False | 11.6 | -| False | 11.7 | -| False | 11.8 | -| False | 11.9 | -| False | 11.10 | -| False | 11.11 | -| False | 11.12 | -| False | 11.13 | -+--------------+-----------------+ -``` - -In this example, the `AutoUpgrade` value is `True` for PostgreSQL version 10\.17\. So, the automatic minor upgrade target is PostgreSQL version 10\.17, which is highlighted in the output\. - -A PostgreSQL DB instance is automatically upgraded during your maintenance window if the following criteria are met: -+ The DB instance has the **Auto minor version upgrade** option enabled\. -+ The DB instance is running a minor DB engine version that is less than the current automatic upgrade minor version\. - -For more information, see [Automatically upgrading the minor engine version](USER_UpgradeDBInstance.Upgrading.md#USER_UpgradeDBInstance.Upgrading.AutoMinorVersionUpgrades)\. - -**Note** -A PostgreSQL upgrade doesn't upgrade PostgreSQL extensions\. To upgrade extensions, see [Upgrading PostgreSQL extensions](#USER_UpgradeDBInstance.PostgreSQL.ExtensionUpgrades)\. - -## Upgrading PostgreSQL extensions - -A PostgreSQL engine upgrade doesn't upgrade most PostgreSQL extensions\. To update an extension after a version upgrade, use the `ALTER EXTENSION UPDATE` command\. - -**Note** -For information about updating the PostGIS extension, see [Managing spatial data with the PostGIS extension](Appendix.PostgreSQL.CommonDBATasks.PostGIS.md) \([Step 6: Upgrade the PostGIS extension](Appendix.PostgreSQL.CommonDBATasks.PostGIS.md#Appendix.PostgreSQL.CommonDBATasks.PostGIS.Update)\)\. -To update the `pg_repack` extension, drop the extension and then create the new version in the upgraded DB instance\. For more information, see [pg\_repack installation](https://reorg.github.io/pg_repack/) in the `pg_repack` documentation\. - -To upgrade an extension, use the following command\. - -``` -ALTER EXTENSION extension_name UPDATE TO 'new_version'; -``` - -For the list of supported versions of PostgreSQL extensions, see [Supported PostgreSQL extension versions](CHAP_PostgreSQL.md#PostgreSQL.Concepts.General.FeatureSupport.Extensions)\. - -To list your currently installed extensions, use the PostgreSQL [pg\_extension](https://www.postgresql.org/docs/current/catalog-pg-extension.html) catalog in the following command\. - -``` -SELECT * FROM pg_extension; -``` - -To view a list of the specific extension versions that are available for your installation, use the PostgreSQL [ pg\_available\_extension\_versions](https://www.postgresql.org/docs/current/view-pg-available-extension-versions.html) view in the following command\. - -``` -SELECT * FROM pg_available_extension_versions; -``` \ No newline at end of file diff --git a/doc_source/USER_UpgradeDBInstance.SQLServer.md b/doc_source/USER_UpgradeDBInstance.SQLServer.md deleted file mode 100644 index d96cf78..0000000 --- a/doc_source/USER_UpgradeDBInstance.SQLServer.md +++ /dev/null @@ -1,198 +0,0 @@ -# Upgrading the Microsoft SQL Server DB engine - -When Amazon RDS supports a new version of a database engine, you can upgrade your DB instances to the new version\. There are two kinds of upgrades for SQL Server DB instances: major version upgrades and minor version upgrades\. - -*Major version upgrades* can contain database changes that are not backward\-compatible with existing applications\. As a result, you must manually perform major version upgrades of your DB instances\. You can initiate a major version upgrade by modifying your DB instance\. However, before you perform a major version upgrade, we recommend that you test the upgrade by following the steps described in [Testing an upgrade](#USER_UpgradeDBInstance.SQLServer.UpgradeTesting)\. - -In contrast, *minor version upgrades* include only changes that are backward\-compatible with existing applications\. You can initiate a minor version upgrade manually by modifying your DB instance\. - -Alternatively, you can enable the **Auto minor version upgrade** option when creating or modifying a DB instance\. Doing so means that your DB instance is automatically upgraded after Amazon RDS tests and approves the new version\. You can confirm whether the minor version upgrade will be automatic by using the `describe-db-engine-versions` AWS CLI command\. For example: - -``` -aws rds describe-db-engine-versions --engine sqlserver-se --engine-version 14.00.3281.6.v1 -``` - -In the following example, the CLI command returns a response showing `AutoUpgrade` is **true**, indicating that upgrades are automatic\. - -``` -... - -"ValidUpgradeTarget": [ - { - "Engine": "sqlserver-se", - "EngineVersion": "14.00.3281.6.v1", - "Description": "SQL Server 2017 14.00.3281.6.v1", - "AutoUpgrade": true, - "IsMajorVersionUpgrade": false - } - -... -``` - -For more information about performing upgrades, see [Upgrading a SQL Server DB instance](#USER_UpgradeDBInstance.SQLServer.Upgrading)\. For information about what SQL Server versions are available on Amazon RDS, see [Amazon RDS for Microsoft SQL Server](CHAP_SQLServer.md)\. - -**Topics** -+ [Overview of upgrading](#USER_UpgradeDBInstance.SQLServer.Overview) -+ [Major version upgrades](#USER_UpgradeDBInstance.SQLServer.Major) -+ [Multi\-AZ and in\-memory optimization considerations](#USER_UpgradeDBInstance.SQLServer.MAZ) -+ [Read replica considerations](#USER_UpgradeDBInstance.SQLServer.readreplica) -+ [Option group considerations](#USER_UpgradeDBInstance.SQLServer.OGPG.OG) -+ [Parameter group considerations](#USER_UpgradeDBInstance.SQLServer.OGPG.PG) -+ [Testing an upgrade](#USER_UpgradeDBInstance.SQLServer.UpgradeTesting) -+ [Upgrading a SQL Server DB instance](#USER_UpgradeDBInstance.SQLServer.Upgrading) -+ [Upgrading deprecated DB instances before support ends](#USER_UpgradeDBInstance.SQLServer.DeprecatedVersions) - -## Overview of upgrading - -Amazon RDS takes two DB snapshots during the upgrade process\. The first DB snapshot is of the DB instance before any upgrade changes have been made\. The second DB snapshot is taken after the upgrade finishes\. - -**Note** -Amazon RDS only takes DB snapshots if you have set the backup retention period for your DB instance to a number greater than 0\. To change your backup retention period, see [Modifying an Amazon RDS DB instance](Overview.DBInstance.Modifying.md)\. - -After an upgrade is completed, you can't revert to the previous version of the database engine\. If you want to return to the previous version, restore from the DB snapshot that was taken before the upgrade to create a new DB instance\. - -During a minor or major version upgrade of SQL Server, the **Free Storage Space** and **Disk Queue Depth** metrics will display `-1`\. After the upgrade is completed, both metrics will return to normal\. - -## Major version upgrades - -Amazon RDS currently supports the following major version upgrades to a Microsoft SQL Server DB instance\. - -You can upgrade your existing DB instance to SQL Server 2017 or 2019 from any version except SQL Server 2008\. To upgrade from SQL Server 2008, first upgrade to one of the other versions\. - - -**** - -| Current version | Supported upgrade versions | -| --- | --- | -| SQL Server 2017 | SQL Server 2019 | -| SQL Server 2016 | SQL Server 2019 SQL Server 2017 | -| SQL Server 2014 | SQL Server 2019 SQL Server 2017 SQL Server 2016 | -| SQL Server 2012 \(end of support\) | SQL Server 2019 SQL Server 2017 SQL Server 2016 SQL Server 2014 | -| SQL Server 2008 R2 \(end of support\) | SQL Server 2016 SQL Server 2014 SQL Server 2012 | - -You can use an AWS CLI query, such as the following example, to find the available upgrades for a particular database engine version\. - -**Example** -For Linux, macOS, or Unix: - -``` -aws rds describe-db-engine-versions \ - --engine sqlserver-se \ - --engine-version 14.00.3281.6.v1 \ - --query "DBEngineVersions[*].ValidUpgradeTarget[*].{EngineVersion:EngineVersion}" \ - --output table -``` -For Windows: - -``` -aws rds describe-db-engine-versions ^ - --engine sqlserver-se ^ - --engine-version 14.00.3281.6.v1 ^ - --query "DBEngineVersions[*].ValidUpgradeTarget[*].{EngineVersion:EngineVersion}" ^ - --output table -``` -The output shows that you can upgrade version 14\.00\.3281\.6 to the latest available SQL Server 2017 or 2019 versions\. - -``` --------------------------- -|DescribeDBEngineVersions| -+------------------------+ -| EngineVersion | -+------------------------+ -| 14.00.3294.2.v1 | -| 14.00.3356.20.v1 | -| 14.00.3381.3.v1 | -| 14.00.3401.7.v1 | -| 14.00.3421.10.v1 | -| 14.00.3451.2.v1 | -| 15.00.4043.16.v1 | -| 15.00.4073.23.v1 | -| 15.00.4153.1.v1 | -| 15.00.4198.2.v1 | -| 15.00.4236.7.v1 | -+------------------------+ -``` - -### Database compatibility level - -You can use Microsoft SQL Server database compatibility levels to adjust some database behaviors to mimic previous versions of SQL Server\. For more information, see [Compatibility level](https://msdn.microsoft.com/en-us/library/bb510680.aspx) in the Microsoft documentation\. - -When you upgrade your DB instance, all existing databases remain at their original compatibility level\. For example, if you upgrade from SQL Server 2014 to SQL Server 2016, all existing databases have a compatibility level of 120\. Any new database created after the upgrade have compatibility level 130\. - -You can change the compatibility level of a database by using the ALTER DATABASE command\. For example, to change a database named `customeracct` to be compatible with SQL Server 2014, issue the following command: - -``` -1. ALTER DATABASE customeracct SET COMPATIBILITY_LEVEL = 120 -``` - -## Multi\-AZ and in\-memory optimization considerations - -Amazon RDS supports Multi\-AZ deployments for DB instances running Microsoft SQL Server by using SQL Server Database Mirroring \(DBM\) or Always On Availability Groups \(AGs\)\. For more information, see [Multi\-AZ deployments for Amazon RDS for Microsoft SQL Server](USER_SQLServerMultiAZ.md)\. - -If your DB instance is in a Multi\-AZ deployment, both the primary and standby instances are upgraded\. Amazon RDS does rolling upgrades\. You have an outage only for the duration of a failover\. - -SQL Server 2014 through 2019 Enterprise Edition support in\-memory optimization\. - -## Read replica considerations - -During a database version upgrade, Amazon RDS upgrades all of your read replicas along with the primary DB instance\. Amazon RDS does not support database version upgrades on the read replicas separately\. For more information on read replicas, see [Working with read replicas for Microsoft SQL Server in Amazon RDS](SQLServer.ReadReplicas.md)\. - -When you perform a database version upgrade of the primary DB instance, all its read\-replicas are also automatically upgraded\. Amazon RDS will upgrade all of the read replicas simultaneously before upgrading the primary DB instance\. Read replicas may not be available until the database version upgrade on the primary DB instance is complete\. - -## Option group considerations - -If your DB instance uses a custom DB option group, in some cases Amazon RDS can't automatically assign your DB instance a new option group\. For example, when you upgrade to a new major version, you must specify a new option group\. We recommend that you create a new option group, and add the same options to it as your existing custom option group\. - -For more information, see [Creating an option group](USER_WorkingWithOptionGroups.md#USER_WorkingWithOptionGroups.Create) or [Copying an option group](USER_WorkingWithOptionGroups.md#USER_WorkingWithOptionGroups.Copy)\. - -## Parameter group considerations - -If your DB instance uses a custom DB parameter group: -+ Amazon RDS automatically reboots the DB instance after an upgrade\. -+ In some cases, RDS can't automatically assign a new parameter group to your DB instance\. - - For example, when you upgrade to a new major version, you must specify a new parameter group\. We recommend that you create a new parameter group, and configure the parameters as in your existing custom parameter group\. - -For more information, see [Creating a DB parameter group](USER_WorkingWithDBInstanceParamGroups.md#USER_WorkingWithParamGroups.Creating) or [Copying a DB parameter group](USER_WorkingWithDBInstanceParamGroups.md#USER_WorkingWithParamGroups.Copying)\. - -## Testing an upgrade - -Before you perform a major version upgrade on your DB instance, you should thoroughly test your database, and all applications that access the database, for compatibility with the new version\. We recommend that you use the following procedure\. - -**To test a major version upgrade** - -1. Review [Upgrade SQL Server](https://docs.microsoft.com/en-us/sql/database-engine/install-windows/upgrade-sql-server) in the Microsoft documentation for the new version of the database engine to see if there are compatibility issues that might affect your database or applications\. - -1. If your DB instance uses a custom option group, create a new option group compatible with the new version you are upgrading to\. For more information, see [Option group considerations](#USER_UpgradeDBInstance.SQLServer.OGPG.OG)\. - -1. If your DB instance uses a custom parameter group, create a new parameter group compatible with the new version you are upgrading to\. For more information, see [Parameter group considerations](#USER_UpgradeDBInstance.SQLServer.OGPG.PG)\. - -1. Create a DB snapshot of the DB instance to be upgraded\. For more information, see [Creating a DB snapshot](USER_CreateSnapshot.md)\. - -1. Restore the DB snapshot to create a new test DB instance\. For more information, see [Restoring from a DB snapshot](USER_RestoreFromSnapshot.md)\. - -1. Modify this new test DB instance to upgrade it to the new version, by using one of the following methods: - + [Console](USER_UpgradeDBInstance.Upgrading.md#USER_UpgradeDBInstance.Upgrading.Manual.Console) - + [AWS CLI](USER_UpgradeDBInstance.Upgrading.md#USER_UpgradeDBInstance.Upgrading.Manual.CLI) - + [RDS API](USER_UpgradeDBInstance.Upgrading.md#USER_UpgradeDBInstance.Upgrading.Manual.API) - -1. Evaluate the storage used by the upgraded instance to determine if the upgrade requires additional storage\. - -1. Run as many of your quality assurance tests against the upgraded DB instance as needed to ensure that your database and application work correctly with the new version\. Implement any new tests needed to evaluate the impact of any compatibility issues you identified in step 1\. Test all stored procedures and functions\. Direct test versions of your applications to the upgraded DB instance\. - -1. If all tests pass, then perform the upgrade on your production DB instance\. We recommend that you do not allow write operations to the DB instance until you confirm that everything is working correctly\. - -## Upgrading a SQL Server DB instance - -For information about manually or automatically upgrading a SQL Server DB instance, see the following: -+ [Upgrading a DB instance engine version](USER_UpgradeDBInstance.Upgrading.md) -+ [Best practices for upgrading SQL Server 2008 R2 to SQL Server 2016 on Amazon RDS for SQL Server](http://aws.amazon.com/blogs/database/best-practices-for-upgrading-sql-server-2008-r2-to-sql-server-2016-on-amazon-rds-for-sql-server/) - -**Important** -If you have any snapshots that are encrypted using AWS KMS, we recommend that you initiate an upgrade before support ends\. - -## Upgrading deprecated DB instances before support ends - -After a major version is deprecated, you can't install it on new DB instances\. RDS will try to automatically upgrade all existing DB instances\. - -If you need to restore a deprecated DB instance, you can do point\-in\-time recovery \(PITR\) or restore a snapshot\. Doing this gives you temporary access a DB instance that uses the version that is being deprecated\. However, after a major version is fully deprecated, these DB instances will also be automatically upgraded to a supported version\. \ No newline at end of file diff --git a/doc_source/USER_UpgradeDBInstance.Upgrading.md b/doc_source/USER_UpgradeDBInstance.Upgrading.md deleted file mode 100644 index 49fecec..0000000 --- a/doc_source/USER_UpgradeDBInstance.Upgrading.md +++ /dev/null @@ -1,211 +0,0 @@ -# Upgrading a DB instance engine version - -Amazon RDS provides newer versions of each supported database engine so you can keep your DB instance up\-to\-date\. Newer versions can include bug fixes, security enhancements, and other improvements for the database engine\. When Amazon RDS supports a new version of a database engine, you can choose how and when to upgrade your database DB instances\. - -There are two kinds of upgrades: major version upgrades and minor version upgrades\. In general, a *major engine version upgrade* can introduce changes that are not compatible with existing applications\. In contrast, a *minor version upgrade* includes only changes that are backward\-compatible with existing applications\. - -The version numbering sequence is specific to each database engine\. For example, RDS for MySQL 5\.7 and 8\.0 are major engine versions and upgrading from any 5\.7 version to any 8\.0 version is a major version upgrade\. RDS for MySQL version 5\.7\.22 and 5\.7\.23 are minor versions and upgrading from 5\.7\.22 to 5\.7\.23 is a minor version upgrade\. - -**Important** -You can't modify a DB instance when it is being upgraded\. During an upgrade, the DB instance status is `upgrading`\. - -For more information about major and minor version upgrades for a specific DB engine, see the following documentation for your DB engine: -+ [Upgrading the MariaDB DB engine](USER_UpgradeDBInstance.MariaDB.md) -+ [Upgrading the Microsoft SQL Server DB engine](USER_UpgradeDBInstance.SQLServer.md) -+ [Upgrading the MySQL DB engine](USER_UpgradeDBInstance.MySQL.md) -+ [Upgrading the RDS for Oracle DB engine](USER_UpgradeDBInstance.Oracle.md) -+ [Upgrading the PostgreSQL DB engine for Amazon RDS](USER_UpgradeDBInstance.PostgreSQL.md) - -For major version upgrades, you must manually modify the DB engine version through the AWS Management Console, AWS CLI, or RDS API\. For minor version upgrades, you can manually modify the engine version, or you can choose to enable auto minor version upgrades\. - -**Note** -Database engine upgrades require downtime\. You can minimize the downtime required for DB instance upgrade by using a blue/green deployment\. For more information, see [Using Amazon RDS Blue/Green Deployments for database updates](blue-green-deployments.md)\. - -**Topics** -+ [Manually upgrading the engine version](#USER_UpgradeDBInstance.Upgrading.Manual) -+ [Automatically upgrading the minor engine version](#USER_UpgradeDBInstance.Upgrading.AutoMinorVersionUpgrades) - -## Manually upgrading the engine version - -To manually upgrade the engine version of a DB instance, you can use the AWS Management Console, the AWS CLI, or the RDS API\. - -### Console - -**To upgrade the engine version of a DB instance by using the console** - -1. Sign in to the AWS Management Console and open the Amazon RDS console at [https://console\.aws\.amazon\.com/rds/](https://console.aws.amazon.com/rds/)\. - -1. In the navigation pane, choose **Databases**, and then choose the DB instance that you want to upgrade\. - -1. Choose **Modify**\. The **Modify DB instance** page appears\. - -1. For **DB engine version**, choose the new version\. - -1. Choose **Continue** and check the summary of modifications\. - -1. To apply the changes immediately, choose **Apply immediately**\. Choosing this option can cause an outage in some cases\. For more information, see [Using the Apply Immediately setting](Overview.DBInstance.Modifying.md#USER_ModifyInstance.ApplyImmediately)\. - -1. On the confirmation page, review your changes\. If they are correct, choose **Modify DB instance** to save your changes\. - - Alternatively, choose **Back** to edit your changes, or choose **Cancel** to cancel your changes\. - -### AWS CLI - -To upgrade the engine version of a DB instance, use the CLI [modify\-db\-instance](https://docs.aws.amazon.com/cli/latest/reference/rds/modify-db-instance.html) command\. Specify the following parameters: -+ `--db-instance-identifier` – the name of the DB instance\. -+ `--engine-version` – the version number of the database engine to upgrade to\. - - For information about valid engine versions, use the AWS CLI [ describe\-db\-engine\-versions](https://docs.aws.amazon.com/cli/latest/reference/rds/describe-db-engine-versions.html) command\. -+ `--allow-major-version-upgrade` – to upgrade the major version\. -+ `--no-apply-immediately` – to apply changes during the next maintenance window\. To apply changes immediately, use `--apply-immediately`\. - -**Example** -For Linux, macOS, or Unix: - -``` -1. aws rds modify-db-instance \ -2. --db-instance-identifier mydbinstance \ -3. --engine-version new_version \ -4. --allow-major-version-upgrade \ -5. --no-apply-immediately -``` -For Windows: - -``` -1. aws rds modify-db-instance ^ -2. --db-instance-identifier mydbinstance ^ -3. --engine-version new_version ^ -4. --allow-major-version-upgrade ^ -5. --no-apply-immediately -``` - -### RDS API - -To upgrade the engine version of a DB instance, use the [ ModifyDBInstance](https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_ModifyDBInstance.html) action\. Specify the following parameters: -+ `DBInstanceIdentifier` – the name of the DB instance, for example *`mydbinstance`*\. -+ `EngineVersion` – the version number of the database engine to upgrade to\. For information about valid engine versions, use the [ DescribeDBEngineVersions](https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_DescribeDBEngineVersions.html) operation\. -+ `AllowMajorVersionUpgrade` – whether to allow a major version upgrade\. To do so, set the value to `true`\. -+ `ApplyImmediately` – whether to apply changes immediately or during the next maintenance window\. To apply changes immediately, set the value to `true`\. To apply changes during the next maintenance window, set the value to `false`\. - -## Automatically upgrading the minor engine version - -A *minor engine version* is an update to a DB engine version within a major engine version\. For example, a major engine version might be 9\.6 with the minor engine versions 9\.6\.11 and 9\.6\.12 within it\. - -If you want Amazon RDS to upgrade the DB engine version of a database automatically, you can enable auto minor version upgrades for the database\. - -**Topics** -+ [How automatic minor version upgrades work](#USER_UpgradeDBInstance.Upgrading.scheduled) -+ [Turning on automatic minor version upgrades](#USER_UpgradeDBInstance.Upgrading.turning-on-automatic) -+ [Determining the availability of maintenance updates](#USER_UpgradeDBInstance.Upgrading.availability) -+ [Finding automatic minor version upgrade targets](#USER_UpgradeDBInstance.Upgrading.targets) - -### How automatic minor version upgrades work - -Amazon RDS designates a minor engine version as the preferred minor engine version when the following conditions are met: -+ The database is running a minor version of the DB engine that is lower than the preferred minor engine version\. -+ The database has auto minor version upgrade enabled\. - -RDS schedules the upgrades to run automatically in the maintenance window\. During the upgrade, RDS performs the following basic steps: - -1. Runs a precheck to make sure the database is healthy and ready to be upgraded - -1. Upgrades the DB engine - -1. Runs post\-upgrade checks - -1. Marks the database upgrade as complete - -Automatic upgrades incur downtime\. The length of the downtime depends on various factors, including the DB engine type and the size of the database\. - -### Turning on automatic minor version upgrades - -You can control whether auto minor version upgrade is enabled for a DB instance when you perform the following tasks: -+ [Creating a DB instance](USER_CreateDBInstance.md) -+ [Modifying a DB instance](Overview.DBInstance.Modifying.md) -+ [Creating a read replica](USER_ReadRepl.md#USER_ReadRepl.Create) -+ [Restoring a DB instance from a snapshot](USER_RestoreFromSnapshot.md) -+ [Restoring a DB instance to a specific time](USER_PIT.md) -+ [Importing a DB instance from Amazon S3](MySQL.Procedural.Importing.md) \(for a MySQL backup on Amazon S3\) - -When you perform these tasks, you can control whether auto minor version upgrade is enabled for the DB instance in the following ways: -+ Using the console, set the **Auto minor version upgrade** option\. -+ Using the AWS CLI, set the `--auto-minor-version-upgrade|--no-auto-minor-version-upgrade` option\. -+ Using the RDS API, set the `AutoMinorVersionUpgrade` parameter\. - -### Determining the availability of maintenance updates - -To determine whether a maintenance update, such as a DB engine version upgrade, is available for your DB instance, you can use the console, AWS CLI, or RDS API\. You can also upgrade the DB engine version manually and adjust the maintenance window\. For more information, see [Maintaining a DB instance](USER_UpgradeDBInstance.Maintenance.md)\. - -### Finding automatic minor version upgrade targets - -You can use the following AWS CLI command to determine the current automatic minor upgrade target version for a specified minor DB engine version in a specific AWS Region\. You can find the possible `--engine` values for this command in the description for the `Engine` parameter in [CreateDBInstance](https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_CreateDBInstance.html)\. - -For Linux, macOS, or Unix: - -``` -aws rds describe-db-engine-versions \ ---engine engine \ ---engine-version minor-version \ ---region region \ ---query "DBEngineVersions[*].ValidUpgradeTarget[*].{AutoUpgrade:AutoUpgrade,EngineVersion:EngineVersion}" \ ---output text -``` - -For Windows: - -``` -aws rds describe-db-engine-versions ^ ---engine engine ^ ---engine-version minor-version ^ ---region region ^ ---query "DBEngineVersions[*].ValidUpgradeTarget[*].{AutoUpgrade:AutoUpgrade,EngineVersion:EngineVersion}" ^ ---output text -``` - -For example, the following AWS CLI command determines the automatic minor upgrade target for MySQL minor version 8\.0\.11 in the US East \(Ohio\) AWS Region \(us\-east\-2\)\. - -For Linux, macOS, or Unix: - -``` -aws rds describe-db-engine-versions \ ---engine mysql \ ---engine-version 8.0.11 \ ---region us-east-2 \ ---query "DBEngineVersions[*].ValidUpgradeTarget[*].{AutoUpgrade:AutoUpgrade,EngineVersion:EngineVersion}" \ ---output table -``` - -For Windows: - -``` -aws rds describe-db-engine-versions ^ ---engine mysql ^ ---engine-version 8.0.11 ^ ---region us-east-2 ^ ---query "DBEngineVersions[*].ValidUpgradeTarget[*].{AutoUpgrade:AutoUpgrade,EngineVersion:EngineVersion}" ^ ---output table -``` - -Your output is similar to the following\. - -``` ----------------------------------- -| DescribeDBEngineVersions | -+--------------+-----------------+ -| AutoUpgrade | EngineVersion | -+--------------+-----------------+ -| False | 8.0.15 | -| False | 8.0.16 | -| False | 8.0.17 | -| False | 8.0.19 | -| False | 8.0.20 | -| False | 8.0.21 | -| True | 8.0.23 | -| False | 8.0.25 | -+--------------+-----------------+ -``` - -In this example, the `AutoUpgrade` value is `True` for MySQL version 8\.0\.23\. So, the automatic minor upgrade target is MySQL version 8\.0\.23, which is highlighted in the output\. - -**Important** -If you plan to migrate an RDS for PostgreSQL DB instance to an Aurora PostgreSQL DB cluster soon, we strongly recommend that you turn off auto minor version upgrades for the DB instance early during planning\. Migration to Aurora PostgreSQL might be delayed if the RDS for PostgreSQL version isn't yet supported by Aurora PostgreSQL\. For information about Aurora PostgreSQL versions, see [ Engine versions for Amazon Aurora PostgreSQL](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/AuroraPostgreSQL.Updates.20180305.html)\. \ No newline at end of file diff --git a/doc_source/USER_UpgradeDBSnapshot.MySQL.md b/doc_source/USER_UpgradeDBSnapshot.MySQL.md deleted file mode 100644 index 11b699b..0000000 --- a/doc_source/USER_UpgradeDBSnapshot.MySQL.md +++ /dev/null @@ -1,55 +0,0 @@ -# Upgrading a MySQL DB snapshot - -With Amazon RDS, you can create a storage volume DB snapshot of your MySQL DB instance\. When you create a DB snapshot, the snapshot is based on the engine version used by your Amazon RDS instance\. In addition to upgrading the DB engine version of your DB instance, you can also upgrade the engine version for your DB snapshots\. For example, you can upgrade DB snapshots created from the MySQL 5\.1 engine to DB snapshots for the MySQL 5\.5 engine\. After restoring a DB snapshot upgraded to a new engine version, you should test that the upgrade was successful\. To learn how to test a major version upgrade, see [Testing an upgrade](USER_UpgradeDBInstance.MySQL.md#USER_UpgradeDBInstance.MySQL.UpgradeTesting)\. To learn how to restore a DB snapshot, see [Restoring from a DB snapshot](USER_RestoreFromSnapshot.md)\. - -Amazon RDS supports upgrading a MySQL DB snapshot from MySQL 5\.1 to MySQL 5\.5\. - -You can upgrade manual DB snapshots, which can be encrypted or not encrypted, from MySQL 5\.1 to MySQL 5\.5 within the same AWS Region\. You can't upgrade automated DB snapshots that are created during the automated backup process\. - -## Console - -**To upgrade a DB snapshot** - -1. Sign in to the AWS Management Console and open the Amazon RDS console at [https://console\.aws\.amazon\.com/rds/](https://console.aws.amazon.com/rds/)\. - -1. In the navigation pane, choose **Snapshots**\. - -1. For **Actions**, choose **Upgrade snapshot**\. The **Upgrade snapshot** page appears\. - -1. Choose the **New engine version** to upgrade to\. - -1. Choose **Save changes** to upgrade the snapshot\. - - During the upgrade process, all snapshot actions are disabled for this DB snapshot\. Also, the DB snapshot status changes from **available** to **upgrading**, and then changes to **active** upon completion\. If the DB snapshot can't be upgraded because of snapshot corruption issues, the status changes to **unavailable**\. You can't recover the snapshot from this state\. -**Note** -If the DB snapshot upgrade fails, the snapshot is rolled back to the original state with the original version\. - -## AWS CLI - -To upgrade a DB snapshot to a new database engine version, use the AWS CLI [modify\-db\-snapshot](https://docs.aws.amazon.com/cli/latest/reference/rds/modify-db-snapshot.html) command\. - -**Parameters** -+ `--db-snapshot-identifier` – The identifier of the DB snapshot to upgrade\. The identifier must be a unique Amazon Resource Name \(ARN\)\. For more information, see [Working with Amazon Resource Names \(ARNs\) in Amazon RDS](USER_Tagging.ARN.md)\. -+ `--engine-version` – The engine version to upgrade the DB snapshot to\. - -**Example** -For Linux, macOS, or Unix: - -``` -1. aws rds modify-db-snapshot \ -2. --db-snapshot-identifier \ -3. --engine-version -``` -For Windows: - -``` -1. aws rds modify-db-snapshot ^ -2. --db-snapshot-identifier ^ -3. --engine-version -``` - -## RDS API - -To upgrade a DB snapshot to a new database engine version, call the Amazon RDS API [ ModifyDBSnapshot](https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_ModifyDBSnapshot.html) operation\. -+ `DBSnapshotIdentifier` – The identifier of the DB snapshot to upgrade\. The identifier must be a unique Amazon Resource Name \(ARN\)\. For more information, see [Working with Amazon Resource Names \(ARNs\) in Amazon RDS](USER_Tagging.ARN.md)\. -+ `EngineVersion` – The engine version to upgrade the DB snapshot to\. \ No newline at end of file diff --git a/doc_source/USER_UpgradeDBSnapshot.Oracle.md b/doc_source/USER_UpgradeDBSnapshot.Oracle.md deleted file mode 100644 index 1cc7c03..0000000 --- a/doc_source/USER_UpgradeDBSnapshot.Oracle.md +++ /dev/null @@ -1,63 +0,0 @@ -# Upgrading an Oracle DB snapshot - -If you have existing manual DB snapshots, you can upgrade them to a later version of the Oracle database engine\. - -When Oracle stops providing patches for a version, and Amazon RDS deprecates the version, you can upgrade your snapshots that correspond to the deprecated version\. For more information, see [Oracle engine version management](USER_UpgradeDBInstance.Oracle.Overview.md#Oracle.Concepts.Patching)\. - -Amazon RDS supports upgrading snapshots in all AWS Regions\. - -## Console - -**To upgrade an Oracle DB snapshot** - -1. Sign in to the AWS Management Console and open the Amazon RDS console at [https://console\.aws\.amazon\.com/rds/](https://console.aws.amazon.com/rds/)\. - -1. In the navigation pane, choose **Snapshots**, and then select the DB snapshot that you want to upgrade\. - -1. For **Actions**, choose **Upgrade snapshot**\. The **Upgrade snapshot** page appears\. - -1. Choose the **New engine version** to upgrade the snapshot to\. - -1. \(Optional\) For **Option group**, choose the option group for the upgraded DB snapshot\. The same option group considerations apply when upgrading a DB snapshot as when upgrading a DB instance\. For more information, see [Option group considerations](USER_UpgradeDBInstance.Oracle.OGPG.md#USER_UpgradeDBInstance.Oracle.OGPG.OG)\. - -1. Choose **Save changes** to save your changes\. - - During the upgrade process, all snapshot actions are disabled for this DB snapshot\. Also, the DB snapshot status changes from **available** to **upgrading**, and then changes to **active** upon completion\. If the DB snapshot can't be upgraded because of snapshot corruption issues, the status changes to **unavailable**\. You can't recover the snapshot from this state\. -**Note** -If the DB snapshot upgrade fails, the snapshot is rolled back to the original state with the original version\. - -## AWS CLI - -To upgrade an Oracle DB snapshot by using the AWS CLI, call the [modify\-db\-snapshot](https://docs.aws.amazon.com/cli/latest/reference/rds/modify-db-snapshot.html) command with the following parameters: -+ `--db-snapshot-identifier` – The name of the DB snapshot\. -+ `--engine-version` – The version to upgrade the snapshot to\. - -You might also need to include the following parameter\. The same option group considerations apply when upgrading a DB snapshot as when upgrading a DB instance\. For more information, see [Option group considerations](USER_UpgradeDBInstance.Oracle.OGPG.md#USER_UpgradeDBInstance.Oracle.OGPG.OG)\. -+ `--option-group-name` – The option group for the upgraded DB snapshot\. - -**Example** -The following example upgrades a DB snapshot\. -For Linux, macOS, or Unix: - -``` -aws rds modify-db-snapshot \ - --db-snapshot-identifier mydbsnapshot \ - --engine-version 19.0.0.0.ru-2020-10.rur-2020-10.r1 \ - --option-group-name default:oracle-se2-19 -``` -For Windows: - -``` -aws rds modify-db-snapshot ^ - --db-snapshot-identifier mydbsnapshot ^ - --engine-version 19.0.0.0.ru-2020-10.rur-2020-10.r1 ^ - --option-group-name default:oracle-se2-19 -``` - -## RDS API - -To upgrade an Oracle DB snapshot by using the Amazon RDS API, call the [ModifyDBSnapshot](https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_ModifyDBSnapshot.html) operation with the following parameters: -+ `DBSnapshotIdentifier` – The name of the DB snapshot\. -+ `EngineVersion` – The version to upgrade the snapshot to\. - -You might also need to include the `OptionGroupName` parameter\. The same option group considerations apply when upgrading a DB snapshot as when upgrading a DB instance\. For more information, see [Option group considerations](USER_UpgradeDBInstance.Oracle.OGPG.md#USER_UpgradeDBInstance.Oracle.OGPG.OG)\. \ No newline at end of file diff --git a/doc_source/USER_UpgradeDBSnapshot.PostgreSQL.md b/doc_source/USER_UpgradeDBSnapshot.PostgreSQL.md deleted file mode 100644 index 02bf85f..0000000 --- a/doc_source/USER_UpgradeDBSnapshot.PostgreSQL.md +++ /dev/null @@ -1,62 +0,0 @@ -# Upgrading a PostgreSQL DB snapshot engine version - -With Amazon RDS, you can create a storage volume DB snapshot of your PostgreSQL DB instance\. When you create a DB snapshot, the snapshot is based on the engine version used by your Amazon RDS instance\. In addition to upgrading the DB engine version of your DB instance, you can also upgrade the engine version for your DB snapshots\. - -After restoring a DB snapshot upgraded to a new engine version, make sure to test that the upgrade was successful\. For more information about a major version upgrade, see [Upgrading the PostgreSQL DB engine for Amazon RDS](USER_UpgradeDBInstance.PostgreSQL.md)\. To learn how to restore a DB snapshot, see [Restoring from a DB snapshot](USER_RestoreFromSnapshot.md)\. - -You can upgrade manual DB snapshots that are either encrypted or not encrypted\. - -For the list of engine versions that are available for upgrading a DB snapshot, see [ Upgrading the PostgreSQL DB engine for Amazon RDS](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_UpgradeDBInstance.PostgreSQL.html#USER_UpgradeDBInstance.PostgreSQL.MajorVersion)\. - -**Note** -You can't upgrade automated DB snapshots that are created during the automated backup process\. - -## Console - -**To upgrade a DB snapshot** - -1. Sign in to the AWS Management Console and open the Amazon RDS console at [https://console\.aws\.amazon\.com/rds/](https://console.aws.amazon.com/rds/)\. - -1. In the navigation pane, choose **Snapshots**\. - -1. Choose the snapshot that you want to upgrade\. - -1. For **Actions**, choose **Upgrade snapshot**\. The **Upgrade snapshot** page appears\. - -1. Choose the **New engine version** to upgrade to\. - -1. Choose **Save changes** to upgrade the snapshot\. - - During the upgrade process, all snapshot actions are disabled for this DB snapshot\. Also, the DB snapshot status changes from **available** to **upgrading**, and then changes to **active** upon completion\. If the DB snapshot can't be upgraded because of snapshot corruption issues, the status changes to **unavailable**\. You can't recover the snapshot from this state\. -**Note** -If the DB snapshot upgrade fails, the snapshot is rolled back to the original state with the original version\. - -## AWS CLI - -To upgrade a DB snapshot to a new database engine version, use the AWS CLI [modify\-db\-snapshot](https://docs.aws.amazon.com/cli/latest/reference/rds/modify-db-snapshot.html) command\. - -**Parameters** -+ `--db-snapshot-identifier` – The identifier of the DB snapshot to upgrade\. The identifier must be a unique Amazon Resource Name \(ARN\)\. For more information, see [Working with Amazon Resource Names \(ARNs\) in Amazon RDS](USER_Tagging.ARN.md)\. -+ `--engine-version` – The engine version to upgrade the DB snapshot to\. - -**Example** -For Linux, macOS, or Unix: - -``` -1. aws rds modify-db-snapshot \ -2. --db-snapshot-identifier my_db_snapshot \ -3. --engine-version new_version -``` -For Windows: - -``` -1. aws rds modify-db-snapshot ^ -2. --db-snapshot-identifier my_db_snapshot ^ -3. --engine-version new_version -``` - -## RDS API - -To upgrade a DB snapshot to a new database engine version, call the Amazon RDS API [ ModifyDBSnapshot](https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_ModifyDBSnapshot.html) operation\. -+ `DBSnapshotIdentifier` – The identifier of the DB snapshot to upgrade\. The identifier must be a unique Amazon Resource Name \(ARN\)\. For more information, see [Working with Amazon Resource Names \(ARNs\) in Amazon RDS](USER_Tagging.ARN.md)\. -+ `EngineVersion` – The engine version to upgrade the DB snapshot to\. \ No newline at end of file diff --git a/doc_source/USER_VPC.FindDefaultVPC.md b/doc_source/USER_VPC.FindDefaultVPC.md deleted file mode 100644 index d8089c1..0000000 --- a/doc_source/USER_VPC.FindDefaultVPC.md +++ /dev/null @@ -1,30 +0,0 @@ -# Determining whether you are using the EC2\-VPC or EC2\-Classic platform - -Your AWS account and the AWS Region you choose determines which of the two RDS platforms your DB instance is created on: *EC2\-VPC* or *EC2\-Classic*\. The type of platform determines if you have a default VPC, and which type of security group you use to provide access to your DB instance\. - -The legacy *EC2\-Classic* platform is the original platform used by Amazon RDS\. If you are on this platform and want to use a VPC, you must create the VPC using the Amazon VPC console or Amazon VPC API\. Accounts that only support the *EC2\-VPC* platform have a default VPC where all DB instances are created, and you must use either an EC2 or VPC security group to provide access to the DB instance\. - -**Important** -If you are a new Amazon RDS customer, if you have never created a DB instance before, or if you are creating a DB instance in an AWS Region you have not used before, in almost all cases you are on the *EC2\-VPC* platform and have a default VPC\. Also, if your DB instance was created after 2013, it is probably in a VPC\. For information about working with DB instances in a VPC, see [Working with a DB instance in a VPC](USER_VPC.WorkingWithRDSInstanceinaVPC.md)\. - -You can tell which platform your AWS account in a given AWS Region is using by looking at the dashboard on the [RDS console](https://console.aws.amazon.com/rds/) or [EC2 console](https://console.aws.amazon.com/ec2/)\. If you are a new Amazon RDS customer, if you have never created a DB instance before, or if you are creating a DB instance in an AWS Region you have not used before, you might be redirected to the first\-run console page and not see the home page following\. - -## EC2\-VPC platform in the console - -If **Supported platforms** indicates *only* `VPC`, as shown following in the RDS console, your AWS account in the current AWS Region uses the *EC2\-VPC* platform, and uses a default VPC\. - -![\[EC2-VPC platform\]](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/images/RDS-GSG-VPC.png) - -Similarly, if **Supported platforms** indicates *only* `VPC`, as shown following in the EC2 console, your AWS account in the current AWS Region uses the *EC2\-VPC* platform, and uses a default VPC\. - -![\[EC2-VPC platform\]](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/images/EC2-GSG-VPC.png) - -In both the RDS and EC2 console, the name of the default VPC is shown below the supported platform\. To provide access to a DB instance created on the *EC2\-VPC* platform, you must create a VPC security group\. For information about creating a VPC security group, see [Tutorial: Create an Amazon VPC for use with a DB instance \(IPv4 only\)](CHAP_Tutorials.WebServerDB.CreateVPC.md)\. - -## EC2\-Classic platform in the console - -In both the RDS and EC2 console, if **Supported platforms** indicates *both* `EC2` and `VPC`, your AWS account in the current AWS Region uses the *EC2\-Classic* platform, and you do not have a default VPC\. To provide access to a DB instance created on the* EC2\-Classic* platform, you must create a DB security group\. For information about creating a DB security group, see [Creating a DB security group](USER_WorkingWithSecurityGroups.md#USER_WorkingWithSecurityGroups.Creating)\. - -**Note** -You can create a VPC on the *EC2\-Classic* platform, but one is not created for you by default as it is on accounts that support the *EC2\-VPC* platform\. -If you want to move an existing DB instance into a VPC, you can use the AWS Management Console to do it easily\. For more information\. see [Moving a DB instance not in a VPC into a VPC](USER_VPC.Non-VPC2VPC.md)\. \ No newline at end of file diff --git a/doc_source/USER_VPC.Non-VPC2VPC.md b/doc_source/USER_VPC.Non-VPC2VPC.md deleted file mode 100644 index 1e38f8a..0000000 --- a/doc_source/USER_VPC.Non-VPC2VPC.md +++ /dev/null @@ -1,33 +0,0 @@ -# Moving a DB instance not in a VPC into a VPC - -Some legacy DB instances on the EC2\-Classic platform are not in a VPC\. If your DB instance is not in a VPC, you can use the AWS Management Console to easily move your DB instance into a VPC\. Before you can move a DB instance not in a VPC, into a VPC, you must create the VPC\. - - -| | -| --- | -| EC2\-Classic was retired on August 15, 2022\. If you haven't migrated from EC2\-Classic to a VPC, we recommend that you migrate as soon as possible\. For more information, see [ Migrate from EC2\-Classic to a VPC](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/vpc-migrate.html) in the Amazon EC2 User Guide and the blog [EC2\-Classic Networking is Retiring – Here’s How to Prepare](http://aws.amazon.com/blogs/aws/ec2-classic-is-retiring-heres-how-to-prepare/)\. | - -**Important** -If you are a new Amazon RDS customer, if you have never created a DB instance before, or if you are creating a DB instance in an AWS Region you have not used before, in almost all cases you are on the *EC2\-VPC* platform and have a default VPC\. For information about working with DB instances in a VPC, see [Working with a DB instance in a VPC](USER_VPC.WorkingWithRDSInstanceinaVPC.md)\. - -Follow these steps to create a VPC for your DB instance\. -+ [Step 1: Create a VPC](USER_VPC.WorkingWithRDSInstanceinaVPC.md#USER_VPC.CreatingVPC) -+ [Step 2: Create a DB subnet group](USER_VPC.WorkingWithRDSInstanceinaVPC.md#USER_VPC.CreateDBSubnetGroup) -+ [Step 3: Create a VPC security group](USER_VPC.WorkingWithRDSInstanceinaVPC.md#USER_VPC.CreateVPCSecurityGroup) - -After you create the VPC, follow these steps to move your DB instance into the VPC\. -+ [Updating the VPC for a DB instance](USER_VPC.VPC2VPC.md) - -We highly recommend that you create a backup of your DB instance immediately before the migration\. Doing so ensures that you can restore the data if the migration fails\. For more information, see [Backing up and restoring](CHAP_CommonTasks.BackupRestore.md)\. - -The following are some limitations to moving your DB instance into the VPC\. -+ **Previous generation DB instance classes** – Previous generation DB instance classes might not be supported on the VPC platform\. When moving a DB instance to a VPC, choose a db\.m3 or db\.r3 DB instance class\. After you move the DB instance to a VPC, you can scale the DB instance to use a later DB instance class\. For a full list of VPC supported instance classes, see [Amazon RDS instance types](http://aws.amazon.com/rds/instance-types/)\. -+ **Multi\-AZ** – Moving a Multi\-AZ DB instance not in a VPC into a VPC is not currently supported\. To move your DB instance to a VPC, first modify the DB instance so that it is a single\-AZ deployment\. Change the **Multi\-AZ deployment** setting to **No**\. After you move the DB instance to a VPC, modify it again to make it a Multi\-AZ deployment\. For more information, see [Modifying an Amazon RDS DB instance](Overview.DBInstance.Modifying.md)\. -+ **Read replicas** – Moving a DB instance with read replicas not in a VPC into a VPC is not currently supported\. To move your DB instance to a VPC, first delete all of its read replicas\. After you move the DB instance to a VPC, recreate the read replicas\. For more information, see [Working with DB instance read replicas](USER_ReadRepl.md)\. -+ **Option groups** – If you move your DB instance to a VPC, and the DB instance is using a custom option group, change the option group that is associated with your DB instance\. Option groups are platform\-specific, and moving to a VPC is a change in platform\. To use a custom option group in this case, assign the default VPC option group to the DB instance, assign an option group that is used by other DB instances in the VPC you are moving to, or create a new option group and assign it to the DB instance\. For more information, see [Working with option groups](USER_WorkingWithOptionGroups.md)\. - -## Alternatives for moving a DB instance not in a VPC into a VPC with minimal downtime - -Using the following alternatives, you can move a DB instance not in a VPC into a VPC with minimal downtime\. These alternatives cause minimum disruption to the source DB instance and allow it to serve user traffic during the migration\. However, the time required to migrate to a VPC will vary based on the database size and the live workload characteristics\. -+ **AWS Database Migration Service \(AWS DMS\)** – AWS DMS enables the live migration of data while keeping the source DB instance fully operational, but it replicates only a limited set of DDL statements\. AWS DMS doesn't propagate items such as indexes, users, privileges, stored procedures, and other database changes not directly related to table data\. In addition, AWS DMS doesn't automatically use RDS snapshots for the initial DB instance creation, which can increase migration time\. For more information, see [AWS Database Migration Service](http://aws.amazon.com/dms/)\. -+ **DB snapshot restore or point\-in\-time recovery** – You can move a DB instance to a VPC by restoring a snapshot of the DB instance or by restoring a DB instance to a point in time\. For more information, see [Restoring from a DB snapshot](USER_RestoreFromSnapshot.md) and [Restoring a DB instance to a specified time](USER_PIT.md)\. \ No newline at end of file diff --git a/doc_source/USER_VPC.Scenarios.NotInVPC.md b/doc_source/USER_VPC.Scenarios.NotInVPC.md deleted file mode 100644 index fda6199..0000000 --- a/doc_source/USER_VPC.Scenarios.NotInVPC.md +++ /dev/null @@ -1,78 +0,0 @@ -# Scenarios for accessing a DB instance not in a VPC - -Amazon RDS supports the following scenarios for accessing a DB instance that is not in a VPC: -+ [An EC2 instance in a VPC](USER_VPC.Scenarios.md#USER_VPC.Scenario1) -+ [A client application through the internet](#USER_VPC.Scenario6) -+ [An EC2 instance not in a VPC](#USER_VPC.Scenario7) - -**Important** -If your DB instance was created after 2013, it is probably in a VPC\. For information about accessing a DB instance in a VPC, see [Scenarios for accessing a DB instance in a VPC](USER_VPC.Scenarios.md)\. - -## A DB instance not in a VPC accessed by an EC2 instance in a VPC - -In the case where you have an EC2 instance in a VPC and an RDS DB instance not in a VPC, you can connect them over the public internet\. - -The following diagram shows this scenario\. - -![\[A DB Instance not in a VPC Accessed by an EC2 Instance in a VPC\]](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/images/legacyRDS2EC2VPC.png) - -**Note** -*ClassicLink*, as described in [A DB instance in a VPC accessed by an EC2 instance not in a VPC](USER_VPC.Scenarios.md#USER_VPC.ClassicLink), is not available for this scenario\. - -To connect your DB instance and your EC2 instance over the public internet, do the following: -+ Ensure that the EC2 instance is in a public subnet in the VPC\. -+ Ensure that the RDS DB instance was marked as publicly accessible\. -+ A note about network ACLs here\. A network ACL is like a firewall for your entire subnet\. Therefore, all instances in that subnet are subject to network ACL rules\. By default, network ACLs allow all traffic and you generally don't need to worry about them, unless you particularly want to add rules as an extra layer of security\. A security group, on the other hand, is associated with individual instances, and you do need to worry about security group rules\. -+ Add the necessary ingress rules to the DB security group for the RDS DB instance\. - - An ingress rule specifies a network port and a CIDR/IP range\. For example, you can add an ingress rule that allows port 3306 to connect to a MySQL RDS DB instance, and a CIDR/IP range of `203.0.113.25/32`\. For more information, see [Authorizing network access to a DB security group from an IP range](USER_WorkingWithSecurityGroups.md#USER_WorkingWithSecurityGroups.Authorizing)\. - -**Note** -If you are interested in moving an existing DB instance into a VPC, you can use the AWS Management Console to do it easily\. For more information\. see [Moving a DB instance not in a VPC into a VPC](USER_VPC.Non-VPC2VPC.md)\. - -## A DB instance not in a VPC accessed by a client application through the internet - -New Amazon RDS customers can only create a DB instance in a VPC\. However, you might need to connect to an existing Amazon RDS DB instance that is not in a VPC from a client application through the internet\. - -The following diagram shows this scenario\. - -![\[A DB Instance not in a VPC Accessed by a Client Application via the Internet\]](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/images/legacyRDS2client.png) - -In this scenario, you must ensure that the DB security group for the RDS DB instance includes the necessary ingress rules for your client application to connect\. An ingress rule specifies a network port and a CIDR/IP range\. For example, you can add an ingress rule that allows port 3306 to connect to a MySQL RDS DB instance, and a CIDR/IP range of `203.0.113.25/32`\. For more information, see [Authorizing network access to a DB security group from an IP range](USER_WorkingWithSecurityGroups.md#USER_WorkingWithSecurityGroups.Authorizing)\. - -**Warning** -If you intend to access a DB instance behind a firewall, talk with your network administrator to determine the IP addresses you should use\. - -**Note** -If you are interested in moving an existing DB instance into a VPC, you can use the AWS Management Console to do it easily\. For more information\. see [Moving a DB instance not in a VPC into a VPC](USER_VPC.Non-VPC2VPC.md)\. - -## A DB instance not in a VPC accessed by an EC2 instance not in a VPC - -When neither your DB instance nor an application on an EC2 instance are in a VPC, you can access the DB instance by using its endpoint and port\. - -The following diagram shows this scenario\. - -![\[A DB Instance Not in a VPC Accessed by an EC2 Instance Not in a VPC\]](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/images/legacyRDS2legacyec2.png) - -You must create a security group for the DB instance that permits access from the port you specified when creating the DB instance\. For example, you could use a connection string similar to this connection string used with *sqlplus* to access an Oracle DB instance: - -``` -PROMPT>sqlplus 'mydbusr@(DESCRIPTION=(ADDRESS=(PROTOCOL=TCP)(HOST=) - (PORT=))(CONNECT_DATA=(SID=)))' -``` - -For more information, see the following documentation\. - - -**** - -| Database engine | Relevant documentation | -| --- | --- | -| MariaDB | [Connecting to a DB instance running the MariaDB database engine](USER_ConnectToMariaDBInstance.md) | -| Microsoft SQL Server | [Connecting to a DB instance running the Microsoft SQL Server database engine](USER_ConnectToMicrosoftSQLServerInstance.md) | -| MySQL | [Connecting to a DB instance running the MySQL database engine](USER_ConnectToInstance.md) | -| Oracle | [Connecting to your Oracle DB instance](USER_ConnectToOracleInstance.md) | -| PostgreSQL | [Connecting to a DB instance running the PostgreSQL database engine](USER_ConnectToPostgreSQLInstance.md) | - -**Note** -If you are interested in moving an existing DB instance into a VPC, you can use the AWS Management Console to do it easily\. For more information\. see [Moving a DB instance not in a VPC into a VPC](USER_VPC.Non-VPC2VPC.md)\. \ No newline at end of file diff --git a/doc_source/USER_VPC.Scenarios.md b/doc_source/USER_VPC.Scenarios.md deleted file mode 100644 index 3a2154e..0000000 --- a/doc_source/USER_VPC.Scenarios.md +++ /dev/null @@ -1,92 +0,0 @@ -# Scenarios for accessing a DB instance in a VPC - -Amazon RDS supports the following scenarios for accessing a DB instance in a VPC: -+ [An EC2 instance in the same VPC](#USER_VPC.Scenario1) -+ [An EC2 instance in a different VPC](#USER_VPC.Scenario3) -+ [A client application through the internet](#USER_VPC.Scenario4) -+ [A private network](#USER_VPC.NotPublic) - -## A DB instance in a VPC accessed by an EC2 instance in the same VPC - -A common use of a DB instance in a VPC is to share data with an application server that is running in an EC2 instance in the same VPC\. - -The following diagram shows this scenario\. - -![\[VPC scenario with a public web server and a private database\]](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/images/con-VPC-sec-grp.png) - -The simplest way to manage access between EC2 instances and DB instances in the same VPC is to do the following: -+ Create a VPC security group for your DB instances to be in\. This security group can be used to restrict access to the DB instances\. For example, you can create a custom rule for this security group\. This might allow TCP access using the port that you assigned to the DB instance when you created it and an IP address you use to access the DB instance for development or other purposes\. -+ Create a VPC security group for your EC2 instances \(web servers and clients\) to be in\. This security group can, if needed, allow access to the EC2 instance from the internet by using the VPC's routing table\. For example, you can set rules on this security group to allow TCP access to the EC2 instance over port 22\. -+ Create custom rules in the security group for your DB instances that allow connections from the security group you created for your EC2 instances\. These rules might allow any member of the security group to access the DB instances\. - -There is an additional public and private subnet in a separate Availability Zone\. An RDS DB subnet group requires a subnet in at least two Availability Zones\. The additional subnet makes it easy to switch to a Multi\-AZ DB instance deployment in the future\. - -For a tutorial that shows you how to create a VPC with both public and private subnets for this scenario, see [Tutorial: Create a VPC for use with a DB instance \(IPv4 only\)](CHAP_Tutorials.WebServerDB.CreateVPC.md)\. - -**Tip** -You can set up network connectivity between an Amazon EC2 instance and a DB instance automatically when you create the DB instance\. For more information, see \. - -**To create a rule in a VPC security group that allows connections from another security group, do the following:** - -1. Sign in to the AWS Management Console and open the Amazon VPC console at [https://console\.aws\.amazon\.com/vpc](https://console.aws.amazon.com/vpc)\. - -1. In the navigation pane, choose **Security groups**\. - -1. Choose or create a security group for which you want to allow access to members of another security group\. In the preceding scenario, this is the security group that you use for your DB instances\. Choose the **Inbound rules** tab, and then choose **Edit inbound rules**\. - -1. On the **Edit inbound rules** page, choose **Add rule**\. - -1. For **Type**, choose the entry that corresponds to the port you used when you created your DB instance, such as **MYSQL/Aurora**\. - -1. In the **Source** box, start typing the ID of the security group, which lists the matching security groups\. Choose the security group with members that you want to have access to the resources protected by this security group\. In the scenario preceding, this is the security group that you use for your EC2 instance\. - -1. If required, repeat the steps for the TCP protocol by creating a rule with **All TCP** as the **Type** and your security group in the **Source** box\. If you intend to use the UDP protocol, create a rule with **All UDP** as the **Type** and your security group in **Source**\. - -1. Choose **Save rules**\. - -The following screen shows an inbound rule with a security group for its source\. - -![\[Adding a security group to another security group's rules\]](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/images/con-vpc-add-sg-rule.png) - -For more information about connecting to the DB instance from your EC2 instance, see [Connecting to an Amazon RDS DB instance](CHAP_CommonTasks.Connect.md) \. - -## A DB instance in a VPC accessed by an EC2 instance in a different VPC - -When your DB instances is in a different VPC from the EC2 instance you are using to access it, you can use VPC peering to access the DB instance\. - -The following diagram shows this scenario\. - -![\[A DB Instance in a VPC Accessed by an EC2 Instance in a Different VPC\]](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/images/RDSVPC2EC2VPC.png) - -A VPC peering connection is a networking connection between two VPCs that enables you to route traffic between them using private IP addresses\. Resources in either VPC can communicate with each other as if they are within the same network\. You can create a VPC peering connection between your own VPCs, with a VPC in another AWS account, or with a VPC in a different AWS Region\. To learn more about VPC peering, see [VPC peering](https://docs.aws.amazon.com/vpc/latest/userguide/vpc-peering.html) in the *Amazon Virtual Private Cloud User Guide*\. - -## A DB instance in a VPC accessed by a client application through the internet - -To access a DB instances in a VPC from a client application through the internet, you configure a VPC with a single public subnet, and an internet gateway to enable communication over the internet\. - -The following diagram shows this scenario\. - -![\[A DB instance in a VPC Accessed by a client application through the internet\]](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/images/GS-VPC-network.png) - -We recommend the following configuration: - - -+ A VPC of size /16 \(for example CIDR: 10\.0\.0\.0/16\)\. This size provides 65,536 private IP addresses\. -+ A subnet of size /24 \(for example CIDR: 10\.0\.0\.0/24\)\. This size provides 256 private IP addresses\. -+ An Amazon RDS DB instance that is associated with the VPC and the subnet\. Amazon RDS assigns an IP address within the subnet to your DB instance\. -+ An internet gateway which connects the VPC to the internet and to other AWS products\. -+ A security group associated with the DB instance\. The security group's inbound rules allow your client application to access to your DB instance\. - -For information about creating a DB instances in a VPC, see [Creating a DB instance in a VPC](USER_VPC.WorkingWithRDSInstanceinaVPC.md#USER_VPC.InstanceInVPC)\. - -## A DB instance in a VPC accessed by a private network - -If your DB instance isn't publicly accessible, you have the following options for accessing it from a private network: -+ An AWS Site\-to\-Site VPN connection\. For more information, see [What is AWS Site\-to\-Site VPN?](https://docs.aws.amazon.com/vpn/latest/s2svpn/VPC_VPN.html) -+ An AWS Direct Connect connection\. For more information, see [What is AWS Direct Connect?](https://docs.aws.amazon.com/directconnect/latest/UserGuide/Welcome.html) - -The following diagram shows a scenario with an AWS Site\-to\-Site VPN connection\. - -![\[A DB instances in a VPC accessed by a private network.\]](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/images/site-to-site-vpn-connection.png) - -For more information, see [Internetwork traffic privacy](inter-network-traffic-privacy.md)\. \ No newline at end of file diff --git a/doc_source/USER_VPC.VPC2VPC.md b/doc_source/USER_VPC.VPC2VPC.md deleted file mode 100644 index 6af2bc4..0000000 --- a/doc_source/USER_VPC.VPC2VPC.md +++ /dev/null @@ -1,13 +0,0 @@ -# Updating the VPC for a DB instance - -You can use the AWS Management Console to move your DB instance to a different VPC\. - -For information about modifying a DB instance, see [Modifying an Amazon RDS DB instance](Overview.DBInstance.Modifying.md)\. In the **Connectivity** section of the modify page, shown following, enter the new DB subnet group for **DB subnet group**\. The new subnet group must be a subnet group in a new VPC\. - -![\[Modify DB Instance panel Subnet group section\]](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/images/EC2-VPC.png) - -You can't change the VPC for a DB instance if the following conditions apply: -+ The DB instance is in multiple Availability Zones\. You can convert the DB instance to a single Availability Zone, move it to a new VPC, and then convert it back to a Multi\-AZ DB instance\. For more information, see [Configuring and managing a Multi\-AZ deployment](Concepts.MultiAZ.md)\. -+ The DB instance has one or more read replicas\. You can remove the read replicas, move the DB instance to a new VPC, and then add the read replicas again\. For more information, see [Working with DB instance read replicas](USER_ReadRepl.md)\. -+ The DB instance is a read replica\. You can promote the read replica, and then move the standalone DB instance to a new VPC\. For more information, see [Promoting a read replica to be a standalone DB instance](USER_ReadRepl.md#USER_ReadRepl.Promote)\. -+ The subnet group in the target VPC doesn't have subnets in the DB instance's the Availability Zone\. You can add subnets in the DB instance's Availability Zone to the DB subnet group, and then move the DB instance to the new VPC\. For more information, see [Working with DB subnet groups](USER_VPC.WorkingWithRDSInstanceinaVPC.md#USER_VPC.Subnets)\. \ No newline at end of file diff --git a/doc_source/USER_VPC.WorkingWithRDSInstanceNotinaVPC.md b/doc_source/USER_VPC.WorkingWithRDSInstanceNotinaVPC.md deleted file mode 100644 index 17e50bf..0000000 --- a/doc_source/USER_VPC.WorkingWithRDSInstanceNotinaVPC.md +++ /dev/null @@ -1,11 +0,0 @@ -# Working with a DB instance that is not in a VPC - -The legacy *EC2\-Classic* platform is the original platform used by Amazon RDS\. If you are on the *EC2\-Classic* platform, your DB instances are not in a virtual private cloud \(VPC\)\. - -**Important** -If you are a new Amazon RDS customer, if you have never created a DB instance before, or if you are creating a DB instance in an AWS Region you have not used before, in almost all cases you are on the *EC2\-VPC* platform and have a default VPC\. Also, if your DB instance was created after 2013, it is probably in a VPC\. For information about working with DB instances in a VPC, see [Working with a DB instance in a VPC](USER_VPC.WorkingWithRDSInstanceinaVPC.md)\. - -**Topics** -+ [Determining whether you are using the EC2\-VPC or EC2\-Classic platform](USER_VPC.FindDefaultVPC.md) -+ [Scenarios for accessing a DB instance not in a VPC](USER_VPC.Scenarios.NotInVPC.md) -+ [Moving a DB instance not in a VPC into a VPC](USER_VPC.Non-VPC2VPC.md) \ No newline at end of file diff --git a/doc_source/USER_VPC.WorkingWithRDSInstanceinaVPC.md b/doc_source/USER_VPC.WorkingWithRDSInstanceinaVPC.md deleted file mode 100644 index 7fae512..0000000 --- a/doc_source/USER_VPC.WorkingWithRDSInstanceinaVPC.md +++ /dev/null @@ -1,313 +0,0 @@ -# Working with a DB instance in a VPC - -Your DB instance is in a virtual private cloud \(VPC\)\. A VPC is a virtual network that is logically isolated from other virtual networks in the AWS Cloud\. Amazon VPC makes it possible for you to launch AWS resources, such as an Amazon RDS DB instance or Amazon EC2 instance, into a VPC\. The VPC can either be a default VPC that comes with your account or one that you create\. All VPCs are associated with your AWS account\. - -Your default VPC has three subnets that you can use to isolate resources inside the VPC\. The default VPC also has an internet gateway that can be used to provide access to resources inside the VPC from outside the VPC\. - -For a list of scenarios involving Amazon RDS DB instances in a VPC and outside of a VPC, see [Scenarios for accessing a DB instance in a VPC](USER_VPC.Scenarios.md)\. - -**Topics** -+ [Working with a DB instance in a VPC](#Overview.RDSVPC.Create) -+ [Working with DB subnet groups](#USER_VPC.Subnets) -+ [Amazon RDS IP addressing](#USER_VPC.IP_addressing) -+ [Hiding a DB instance in a VPC from the internet](#USER_VPC.Hiding) -+ [Creating a DB instance in a VPC](#USER_VPC.InstanceInVPC) - -In the following tutorials, you can learn to create a VPC that you can use for a common Amazon RDS scenario: -+ [Tutorial: Create a VPC for use with a DB instance \(IPv4 only\)](CHAP_Tutorials.WebServerDB.CreateVPC.md) -+ [Tutorial: Create a VPC for use with a DB instance \(dual\-stack mode\)](CHAP_Tutorials.CreateVPCDualStack.md) - -## Working with a DB instance in a VPC - -Here are some tips on working with a DB instance in a VPC: -+ Your VPC must have at least two subnets\. These subnets must be in two different Availability Zones in the AWS Region where you want to deploy your DB instance\. A *subnet* is a segment of a VPC's IP address range that you can specify and that you can use to group DB instances based on your security and operational needs\. - - For Multi\-AZ deployments, defining a subnet for two or more Availability Zones in an AWS Region allows Amazon RDS to create a new standby in another Availability Zone as needed\. Make sure to do this even for Single\-AZ deployments, just in case you want to convert them to Multi\-AZ deployments at some point\. -**Note** -The DB subnet group for a Local Zone can have only one subnet\. -+ If you want your DB instance in the VPC to be publicly accessible, make sure to turn on the VPC attributes *DNS hostnames* and *DNS resolution*\. -+ Your VPC must have a DB subnet group that you create\. You create a DB subnet group by specifying the subnets you created\. Amazon RDS chooses a subnet and an IP address within that subnet group to associate with your DB instance\. The DB instance uses the Availability Zone that contains the subnet\. -+ Your VPC must have a VPC security group that allows access to the DB instance\. - - For more information, see [Scenarios for accessing a DB instance in a VPC](USER_VPC.Scenarios.md)\. -+ The CIDR blocks in each of your subnets must be large enough to accommodate spare IP addresses for Amazon RDS to use during maintenance activities, including failover and compute scaling\. For example, a range such as 10\.0\.0\.0/24 and 10\.0\.1\.0/24 is typically large enough\. -+ A VPC can have an *instance tenancy* attribute of either *default* or *dedicated*\. All default VPCs have the instance tenancy attribute set to default, and a default VPC can support any DB instance class\. - - If you choose to have your DB instance in a dedicated VPC where the instance tenancy attribute is set to dedicated, the DB instance class of your DB instance must be one of the approved Amazon EC2 dedicated instance types\. For example, the r5\.large EC2 dedicated instance corresponds to the db\.r5\.large DB instance class\. For information about instance tenancy in a VPC, see [Dedicated instances](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/dedicated-instance.html) in the *Amazon Elastic Compute Cloud User Guide*\. - - For more information about the instance types that can be in a dedicated instance, see [Amazon EC2 dedicated instances](https://aws.amazon.com/ec2/purchasing-options/dedicated-instances/) on the EC2 pricing page\. -**Note** -When you set the instance tenancy attribute to dedicated for a DB instance, it doesn't guarantee that the DB instance will run on a dedicated host\. -+ When an option group is assigned to a DB instance, it's associated with the DB instance's VPC\. This linkage means that you can't use the option group assigned to a DB instance if you attempt to restore the DB instance into a different VPC\. -+ If you restore a DB instance into a different VPC, make sure to either assign the default option group to the DB instance, assign an option group that is linked to that VPC, or create a new option group and assign it to the DB instance\. With persistent or permanent options, such as Oracle TDE, you must create a new option group that includes the persistent or permanent option when restoring a DB instance into a different VPC\. - -## Working with DB subnet groups - -*Subnets* are segments of a VPC's IP address range that you designate to group your resources based on security and operational needs\. A *DB subnet group* is a collection of subnets \(typically private\) that you create in a VPC and that you then designate for your DB instances\. By using a DB subnet group, you can specify a particular VPC when creating DB instances using the AWS CLI or RDS API\. If you use the console, you can choose the VPC and subnet groups you want to use\. - -Each DB subnet group should have subnets in at least two Availability Zones in a given AWS Region\. When creating a DB instance in a VPC, you choose a DB subnet group for it\. From the DB subnet group, Amazon RDS chooses a subnet and an IP address within that subnet to associate with the DB instance\. The DB uses the Availability Zone that contains the subnet\. - -If the primary DB instance of a Multi\-AZ deployment fails, Amazon RDS can promote the corresponding standby and later create a new standby using an IP address of the subnet in one of the other Availability Zones\. - -The subnets in a DB subnet group are either public or private\. The subnets are public or private, depending on the configuration that you set for their network access control lists \(network ACLs\) and routing tables\. For a DB instance to be publicly accessible, all of the subnets in its DB subnet group must be public\. If a subnet that's associated with a publicly accessible DB instance changes from public to private, it can affect DB instance availability\. - -To create a DB subnet group that supports dual\-stack mode, make sure that each subnet that you add to the DB subnet group has an Internet Protocol version 6 \(IPv6\) CIDR block associated with it\. For more information, see [Amazon RDS IP addressing](#USER_VPC.IP_addressing) and [Migrating to IPv6](https://docs.aws.amazon.com/vpc/latest/userguide/vpc-migrate-ipv6.html) in the *Amazon VPC User Guide\.* - -**Note** -The DB subnet group for a Local Zone can have only one subnet\. - -When Amazon RDS creates a DB instance in a VPC, it assigns a network interface to your DB instance by using an IP address from your DB subnet group\. However, we strongly recommend that you use the Domain Name System \(DNS\) name to connect to your DB instance\. We recommend this because the underlying IP address changes during failover\. - -**Note** -For each DB instance that you run in a VPC, make sure to reserve at least one address in each subnet in the DB subnet group for use by Amazon RDS for recovery actions\. - -## Amazon RDS IP addressing - -IP addresses enable resources in your VPC to communicate with each other, and with resources over the internet\. Amazon RDS support both the Internet Protocol version 4 \(IPv4\) and IPv6 addressing protocols\. By default, Amazon RDS and Amazon VPC use the IPv4 addressing protocol\. You can't turn off this behavior\. When you create a VPC, make sure to specify an IPv4 CIDR block \(a range of private IPv4 addresses\)\. You can optionally assign an IPv6 CIDR block to your VPC and subnets, and assign IPv6 addresses from that block to DB instances in your subnet\. - -Support for the IPv6 protocol expands the number of supported IP addresses\. By using the IPv6 protocol, you ensure that you have sufficient available addresses for the future growth of the internet\. New and existing RDS resources can use IPv4 and IPv6 addresses within your Amazon VPC\. Configuring, securing, and translating network traffic between the two protocols used in different parts of an application can cause operational overhead\. You can standardize on the IPv6 protocol for Amazon RDS resources to simplify your network configuration\. - -**Topics** -+ [IPv4 addresses](#USER_VPC.IP_addressing.IPv4) -+ [IPv6 addresses](#USER_VPC.IP_addressing.IPv6) -+ [Dual\-stack mode](#USER_VPC.IP_addressing.dual-stack-mode) - -### IPv4 addresses - -When you create a VPC, you must specify a range of IPv4 addresses for the VPC in the form of a CIDR block, such as `10.0.0.0/16`\. A *DB subnet group* defines the range of IP addresses in this CIDR block that a DB instance can use\. These IP addresses can be private or public\. - -A private IPv4 address is an IP address that's not reachable over the internet\. You can use private IPv4 addresses for communication between your DB instance and other resources, such as Amazon EC2 instances, in the same VPC\. Each DB instance has a private IP address for communication in the VPC\. - -A public IP address is an IPv4 address that's reachable from the internet\. You can use public addresses for communication between your DB instance and resources on the internet, such as a SQL client\. You control whether your DB instance receives a public IP address\. - -For a tutorial that shows you how to create a VPC with only private IPv4 addresses that you can use for a common Amazon RDS scenario, see [Tutorial: Create a VPC for use with a DB instance \(IPv4 only\)](CHAP_Tutorials.WebServerDB.CreateVPC.md)\. - -### IPv6 addresses - -You can optionally associate an IPv6 CIDR block with your VPC and subnets, and assign IPv6 addresses from that block to the resources in your VPC\. Each IPv6 addresses is globally unique\. - -The IPv6 CIDR block for your VPC is automatically assigned from Amazon's pool of IPv6 addresses\. You can't choose the range yourself\. - -When connecting to an IPv6 address, make sure that the following conditions are met: -+ The client is configured so that client to database traffic over IPv6 is allowed\. -+ RDS security groups used by the DB instance are configured correctly so that client to database traffic over IPv6 is allowed\. -+ The client operating system stack allows traffic on the IPv6 address, and operating system drivers and libraries are configured to choose the correct default DB instance endpoint \(either IPv4 or IPv6\)\. - -For more information about IPv6, see [ IP Addressing](https://docs.aws.amazon.com/vpc/latest/userguide/how-it-works.html#vpc-ip-addressing) in the *Amazon VPC User Guide*\. - -### Dual\-stack mode - -When a DB instance can communicate over both the IPv4 and IPv6 addressing protocols, it's running in dual\-stack mode\. So, resources can communicate with the DB instance over IPv4, IPv6, or both\. RDS disables Internet Gateway access for IPv6 endpoints of private dual\-stack mode DB instances\. RDS does this to ensure that your IPv6 endpoints are private and can only be accessed from within your VPC\. - -**Topics** -+ [Dual\-stack mode and DB subnet groups](#USER_VPC.IP_addressing.dual-stack-db-subnet-groups) -+ [Working with dual\-stack mode DB instances](#USER_VPC.IP_addressing.dual-stack-working-with) -+ [Modifying IPv4\-only DB instances to use dual\-stack mode](#USER_VPC.IP_addressing.dual-stack-modifying-ipv4) -+ [Region and version availability](#USER_VPC.IP_addressing.RegionVersionAvailability) -+ [Limitations for dual\-stack network DB instances](#USER_VPC.IP_addressing.dual-stack-limitations) - -For a tutorial that shows you how to create a VPC with both IPv4 and IPv6 addresses that you can use for a common Amazon RDS scenario, see [Tutorial: Create a VPC for use with a DB instance \(dual\-stack mode\)](CHAP_Tutorials.CreateVPCDualStack.md)\. - -#### Dual\-stack mode and DB subnet groups - -To use dual\-stack mode, make sure that each subnet in the DB subnet group that you associate with the DB instance has an IPv6 CIDR block associated with it\. You can create a new DB subnet group or modify an existing DB subnet group to meet this requirement\. After a DB instance is in dual\-stack mode, clients can connect to it normally\. Make sure that client security firewalls and RDS DB instance security groups are accurately configured to allow traffic over IPv6\. To connect, clients use the DB instance's endpoint \. Client applications can specify which protocol is preferred when connecting to a database\. In dual\-stack mode, the DB instance detects the client's preferred network protocol, either IPv4 or IPv6, and uses that protocol for the connection\. - -If a DB subnet group stops supporting dual\-stack mode because of subnet deletion or CIDR disassociation, there's a risk of an incompatible network state for DB instances that are associated with the DB subnet group\. Also, you can't use the DB subnet group when you create new dual\-stack mode DB instance\. - -To determine whether a DB subnet group supports dual\-stack mode by using the AWS Management Console, view the **Network type** on the details page of the DB subnet group\. To determine whether a DB subnet group supports dual\-stack mode by using the AWS CLI, call the [describe\-db\-subnet\-groups](https://docs.aws.amazon.com/cli/latest/reference/rds/describe-db-subnet-groups.html) command and view `SupportedNetworkTypes` in the output\. - -Read replicas are treated as independent DB instances and can have a network type that's different from the primary DB instance\. If you change the network type of a read replica's primary DB instance, the read replica isn't affected\. When you are restoring a DB instance, you can restore it to any network type that's supported\. - -#### Working with dual\-stack mode DB instances - -When you create or modify a DB instance, you can specify *dual\-stack mode* to allow your resources to communicate with your DB instance over IPv4, IPv6, or both\. - -When you use the AWS Management Console to create or modify a DB instance, you can specify dual\-stack mode in the **Network type** section\. The following image shows the **Network type** section in the console\. - -![\[Network type section in the console with Dual-stack mode selected\]](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/images/dual-stack-mode.png) - -When you use the AWS CLI to create or modify a DB instance, set the `--network-type` option to `DUAL` to use dual\-stack mode\. When you use the RDS API to create or modify a DB instance, set the `NetworkType` parameter to `DUAL` to use dual\-stack mode\. When you are modifying the network type of a DB instance, downtime is possible\. If dual\-stack mode isn't supported by the specified DB engine version or DB subnet group, the `NetworkTypeNotSupported` error is returned\. - -For more information about creating a DB instance, see [Creating an Amazon RDS DB instance](USER_CreateDBInstance.md)\. For more information about modifying a DB instance, see [Modifying an Amazon RDS DB instance](Overview.DBInstance.Modifying.md)\. - -To determine whether a DB instance is in dual\-stack mode by using the console, view the **Network type** on the **Connectivity & security** tab for the DB instance\. - -#### Modifying IPv4\-only DB instances to use dual\-stack mode - -You can modify an IPv4\-only DB instance to use dual\-stack mode\. To do so, change the network type of the DB instance\. The modification might result in downtime\. - -It is recommended that you change the network type of your Amazon RDS instances during a maintenance window\. Setting the network type of new instances to dual stack by default is currently unsuspported\. Set network type manually by using the modify\-db\-instance command\. - -Before modifying a DB instance to use dual\-stack mode, make sure that its DB subnet group supports dual\-stack mode\. If the DB subnet group associated with the DB instance doesn't support dual\-stack mode, specify a different DB subnet group that supports it when you modify the DB instance\. Modifying the DB subnet group of a DB instance can cause downtime\. - -If you modify the DB subnet group of a DB instance before you change the DB instance to use dual\-stack mode, make sure that the DB subnet group is valid for the DB instance before and after the change\. - -For exmaple: - -For RDS for PostgreSQL, RDS for MySQL, RDS for Oracle, and RDS for MariaDB Single\-AZ instances, we recommend that you call the [modify\-db\-instance](https://docs.aws.amazon.com/cli/latest/reference/rds/modify-db-instance.html) command with just the `--network-type` parameter with value `DUAL` to change the network to dual stack\. Adding other parameters along with the `--network-type` parameter in the same API call could result in downtime\. If you wish to modify multiple parameters, please ensure that the network type modification API action is successfully completed before sending another `modify-db-instance` request with other parameters\. - -Network type modifications for RDS for PostgreSQL, RDS for MySQL, RDS for Oracle, and RDS for MariaDB Multi\-AZ instances cause a brief downtime and trigger a failover if you only use the `--network-type` parameter or if you combine parameters in a modify\-db\-instance command\. - -Network type modifications on RDS for SQL Server Single\-AZ or Multi\-AZ instances cause downtime if you only use the `--network-type` parameter or if you combine parameters in a modify\-db\-instance command\. Network type modifications cause failover in an SQL Server Multi\-AZ instance\. - -``` -aws rds modify-db-instance --db-instance-identifier my-instance --network-type "DUAL" -``` - -If you can't connect to the DB instance after the change, make sure that the client and database security firewalls and route tables are accurately configured to allow cross traffic to the database on the selected network \(either IPv4 or IPv6\)\. You might also need to modify operating system parameter, libraries, or drivers to connect using an IPv6 address\. - -The following limitations apply to modifying a DB instance to use dual\-stack mode: -+ Dual\-stack mode DB instances can't be publicly accessible\. -+ DB instances can't have an IPv6\-only endpoint\. -+ There can't be a pending change from a Single\-AZ deployment to a Multi\-AZ deployment, or from a Multi\-AZ deployment to a Single\-AZ deployment\. - -**To modify an IPv4\-only DB instance to use dual\-stack mode** - -1. Modify a DB subnet group to support dual\-stack mode, or create a DB subnet group that supports dual\-stack mode: - - 1. Associate an IPv6 CIDR block with your VPC\. - - For instructions, see [ Associate an IPv6 CIDR block with your VPC](https://docs.aws.amazon.com/vpc/latest/userguide/working-with-vpcs.html#vpc-associate-ipv6-cidr) in the *Amazon VPC User Guide*\. - - 1. Attach the IPv6 CIDR block to all of the subnets in your the DB subnet group\. - - For instructions, see [ Associate an IPv6 CIDR block with your subnet](https://docs.aws.amazon.com/vpc/latest/userguide/working-with-subnets.html#subnet-associate-ipv6-cidr) in the *Amazon VPC User Guide*\. - - 1. Confirm that the DB subnet group supports dual\-stack mode\. - - If you are using the AWS Management Console, select the DB subnet group, and make sure that the **Supported network types** value is **Dual, IPv4**\. - - If you are using the AWS CLI, call the [describe\-db\-subnet\-groups](https://docs.aws.amazon.com/cli/latest/reference/rds/describe-db-subnet-groups.html) command, and make sure that the `SupportedNetworkType` value for the DB instance is `Dual, IPv4`\. - -1. Modify the security group associated with the DB instance to allow IPv6 connections to the database, or create a new security group that allows IPv6 connections\. - - For instructions, see [ Security group rules](https://docs.aws.amazon.com/vpc/latest/userguide/VPC_SecurityGroups.html#SecurityGroupRules) in the *Amazon VPC User Guide*\. - -1. Modify the DB instance to support dual\-stack mode\. To do so, set the **Network type** to **Dual\-stack mode**\. - - If you are using the console, make sure that the following settings are correct: - + **Network type** – **Dual\-stack mode** -![\[Network type section in the console with Dual-stack mode selected\]](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/images/dual-stack-mode.png) - + **DB subnet group** – The DB subnet group that you configured in a previous step - + **Security group** – The security that you configured in a previous step - - If you are using the AWS CLI, make sure that the following settings are correct: - + `--network-type` – `dual` - + `--db-subnet-group-name` – The DB subnet group that you configured in a previous step - + `--vpc-security-group-ids` – The VPC security group that you configured in a previous step - -1. Confirm that the DB instance supports dual\-stack mode\. - - If you are using the console, choose the **Connectivity & security** tab for the DB instance\. On that tab, make sure that the **Network type** value is **Dual\-stack mode**\. - - If you are using the AWS CLI, call the [ describe\-db\-instances](https://docs.aws.amazon.com/cli/latest/reference/rds/describe-db-instances.html) command, and make sure that the `NetworkType` value for the DB instance is `dual`\. - - Run the `dig` command on the DB instance endpoint to identify the IPv6 address associated with it\. - - ``` - dig db-instance-endpoint AAAA - ``` - - Use the DB instance endpoint, not the IPv6 address, to connect to the DB instance\. - -#### Region and version availability - -Feature availability and support varies across specific versions of each database engine, and across AWS Regions\. For more information on version and Region availability with dual stack mode, see [Dual\-stack mode](Concepts.RDS_Fea_Regions_DB-eng.Feature.DualStackMode.md)\. - -#### Limitations for dual\-stack network DB instances - -The following limitations apply to dual\-stack network DB instances: -+ DB instances can't use the IPv6 protocol exclusively\. They can use IPv4 exclusively, or they can use the IPv4 and IPv6 protocol \(dual\-stack mode\)\. -+ Amazon RDS doesn't support native IPv6 subnets\. -+ DB instances that use dual\-stack mode must be private\. They can't be publicly accessible\. -+ Dual\-stack mode doesn't support the db\.m3 and db\.r3 DB instance classes\. -+ For RDS for SQL Server, dual\-stack mode DB instances that use Always On AGs availability group listener endpoints only present IPv4 addresses\. -+ You can't use RDS Proxy with dual\-stack mode DB instances\. -+ You can't use dual\-stack mode with RDS on AWS Outposts DB instances\. -+ You can't use dual\-stack mode with DB instances in a Local Zone\. - -## Hiding a DB instance in a VPC from the internet - -One common Amazon RDS scenario is to have a VPC in which you have an EC2 instance with a public\-facing web application and a DB instance with a database that isn't publicly accessible\. For example, you can create a VPC that has a public subnet and a private subnet\. Amazon EC2 instances that function as web servers can be deployed in the public subnet\. The DB instances are deployed in the private subnet\. In such a deployment, only the web servers have access to the DB instances\. For an illustration of this scenario, see [A DB instance in a VPC accessed by an EC2 instance in the same VPC](USER_VPC.Scenarios.md#USER_VPC.Scenario1)\. - -When you launch a DB instance inside a VPC, the DB instance has a private IP address for traffic inside the VPC\. This private IP address isn't publicly accessible\. You can use the **Public access** option to designate whether the DB instance also has a public IP address in addition to the private IP address\. If the DB instance is designated as publicly accessible, its DNS endpoint resolves to the private IP address from within the VPC\. It resolves to the public IP address from outside of the VPC\. Access to the DB instance is ultimately controlled by the security group it uses\. That public access is not permitted if the security group assigned to the DB instance doesn't include inbound rules that permit it\. In addition, for a DB instance to be publicly accessible, the subnets in its DB subnet group must have an internet gateway\. For more information, see [Can't connect to Amazon RDS DB instance](CHAP_Troubleshooting.md#CHAP_Troubleshooting.Connecting) - -You can modify a DB instance to turn on or off public accessibility by modifying the **Public access** option\. The following illustration shows the **Public access** option in the **Additional connectivity configuration** section\. To set the option, open the **Additional connectivity configuration** section in the **Connectivity** section\. - -![\[Image NOT FOUND\]](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/images/VPC-example4.png) - -For information about modifying a DB instance to set the **Public access** option, see [Modifying an Amazon RDS DB instance](Overview.DBInstance.Modifying.md)\. - -## Creating a DB instance in a VPC - -The following procedures help you create a DB instance in a VPC\. To use the default VPC, you can begin with step 2, and use the VPC and DB subnet group have already been created for you\. If you want to create an additional VPC, you can create a new VPC\. - -**Note** -If you want your DB instance in the VPC to be publicly accessible, you must update the DNS information for the VPC by enabling the VPC attributes *DNS hostnames* and *DNS resolution*\. For information about updating the DNS information for a VPC instance, see [Updating DNS support for your VPC](https://docs.aws.amazon.com/vpc/latest/userguide/vpc-dns.html)\. - -Follow these steps to create a DB instance in a VPC: -+ [Step 1: Create a VPC](#USER_VPC.CreatingVPC) -+ [Step 2: Create a DB subnet group](#USER_VPC.CreateDBSubnetGroup) -+ [Step 3: Create a VPC security group](#USER_VPC.CreateVPCSecurityGroup) -+ [Step 4: Create a DB instance in the VPC](#USER_VPC.CreateDBInstanceInVPC) - -### Step 1: Create a VPC - -Create a VPC with subnets in at least two Availability Zones\. You use these subnets when you create a DB subnet group\. If you have a default VPC, a subnet is automatically created for you in each Availability Zone in the AWS Region\. - -For more information, see [Create a VPC with private and public subnets](CHAP_Tutorials.WebServerDB.CreateVPC.md#CHAP_Tutorials.WebServerDB.CreateVPC.VPCAndSubnets), or see [Create a VPC](https://docs.aws.amazon.com/vpc/latest/userguide/working-with-vpcs.html#Create-VPC) in the *Amazon VPC User Guide*\. - -### Step 2: Create a DB subnet group - -A DB subnet group is a collection of subnets \(typically private\) that you create for a VPC and that you then designate for your DB instances\. A DB subnet group allows you to specify a particular VPC when you create DB instances using the AWS CLI or RDS API\. If you use the console, you can just choose the VPC and subnets you want to use\. Each DB subnet group must have at least one subnet in at least two Availability Zones in the AWS Region\. As a best practice, each DB subnet group should have at least one subnet for every Availability Zone in the AWS Region\. - -For Multi\-AZ deployments, defining a subnet for all Availability Zones in an AWS Region enables Amazon RDS to create a new standby replica in another Availability Zone if necessary\. You can follow this best practice even for Single\-AZ deployments, because you might convert them to Multi\-AZ deployments in the future\. - -For a DB instance to be publicly accessible, the subnets in the DB subnet group must have an internet gateway\. For more information about internet gateways for subnets, see [Connect to the internet using an internet gateway](https://docs.aws.amazon.com/vpc/latest/userguide/VPC_Internet_Gateway.html) in the *Amazon VPC User Guide*\. - -**Note** -The DB subnet group for a Local Zone can have only one subnet\. - -When you create a DB instance in a VPC, you can choose a DB subnet group\. Amazon RDS chooses a subnet and an IP address within that subnet to associate with your DB instance\. If no DB subnet groups exist, Amazon RDS creates a default subnet group when you create a DB instance\. Amazon RDS creates and associates an Elastic Network Interface to your DB instance with that IP address\. The DB instance uses the Availability Zone that contains the subnet\. - -For Multi\-AZ deployments, defining a subnet for two or more Availability Zones in an AWS Region allows Amazon RDS to create a new standby in another Availability Zone should the need arise\. You need to do this even For Single\-AZ deployments, just in case you want to convert them to Multi\-AZ deployments at some point\. - -In this step, you create a DB subnet group and add the subnets that you created for your VPC\. - -**To create a DB subnet group** - -1. Open the Amazon RDS console at [https://console\.aws\.amazon\.com/rds/](https://console.aws.amazon.com/rds/)\. - -1. In the navigation pane, choose **Subnet groups**\. - -1. Choose **Create DB Subnet Group**\. - -1. For **Name**, type the name of your DB subnet group\. - -1. For **Description**, type a description for your DB subnet group\. - -1. For **VPC**, choose the default VPC or the VPC that you created\. - -1. In the **Add subnets** section, choose the Availability Zones that include the subnets from **Availability Zones**, and then choose the subnets from **Subnets**\. -![\[Create DB Subnet Group button\]](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/images/RDSVPC101.png) -**Note** -If you have enabled a Local Zone, you can choose an Availability Zone group on the **Create DB subnet group** page\. In this case, choose the **Availability Zone group**, **Availability Zones**, and **Subnets**\. - -1. Choose **Create**\. - - Your new DB subnet group appears in the DB subnet groups list on the RDS console\. You can choose the DB subnet group to see details, including all of the subnets associated with the group, in the details pane at the bottom of the window\. - -### Step 3: Create a VPC security group - -Before you create your DB instance, you can create a VPC security group to associate with your DB instance\. If you don't create a VPC security group, you can use the default security group when you create a DB instance\. For instructions on how to create a security group for your DB instance, see [Create a VPC security group for a private DB instance](CHAP_Tutorials.WebServerDB.CreateVPC.md#CHAP_Tutorials.WebServerDB.CreateVPC.SecurityGroupDB), or see [Control traffic to resources using security groups](https://docs.aws.amazon.com/vpc/latest/userguide/VPC_SecurityGroups.html) in the *Amazon VPC User Guide*\. - -### Step 4: Create a DB instance in the VPC - -In this step, you create a DB instance and use the VPC name, the DB subnet group, and the VPC security group you created in the previous steps\. - -**Note** -If you want your DB instance in the VPC to be publicly accessible, you must enable the VPC attributes *DNS hostnames* and *DNS resolution*\. For more information, see [DNS attributes for your VPC](https://docs.aws.amazon.com/vpc/latest/userguide/vpc-dns.html) in the *Amazon VPC User Guide*\. - -For details on how to create a DB instance, see [Creating an Amazon RDS DB instance](USER_CreateDBInstance.md)\. - -When prompted in the **Connectivity** section, enter the VPC name, the DB subnet group, and the VPC security group\. \ No newline at end of file diff --git a/doc_source/USER_VPC.md b/doc_source/USER_VPC.md deleted file mode 100644 index a5cdbb9..0000000 --- a/doc_source/USER_VPC.md +++ /dev/null @@ -1,17 +0,0 @@ -# Amazon VPC VPCs and Amazon RDS - -Amazon Virtual Private Cloud \(Amazon VPC\) makes it possible for you to launch AWS resources, such as Amazon RDS DB instances, into a virtual private cloud \(VPC\)\. - -When you use a VPC, you have control over your virtual networking environment\. You can choose your own IP address range, create subnets, and configure routing and access control lists\. There is no additional cost to run your DB instance in a VPC\. - -Accounts have a default VPC\. All new DB instances are created in the default VPC unless you specify otherwise\. - -**Topics** -+ [Working with a DB instance in a VPC](USER_VPC.WorkingWithRDSInstanceinaVPC.md) -+ [Updating the VPC for a DB instance](USER_VPC.VPC2VPC.md) -+ [Scenarios for accessing a DB instance in a VPC](USER_VPC.Scenarios.md) -+ [Tutorial: Create a VPC for use with a DB instance \(IPv4 only\)](CHAP_Tutorials.WebServerDB.CreateVPC.md) -+ [Tutorial: Create a VPC for use with a DB instance \(dual\-stack mode\)](CHAP_Tutorials.CreateVPCDualStack.md) -+ [Moving a DB instance not in a VPC into a VPC](USER_VPC.Non-VPC2VPC.md) - -Following, you can find a discussion about VPC functionality relevant to Amazon RDS DB instances\. For more information about Amazon VPC, see [Amazon VPC Getting Started Guide](https://docs.aws.amazon.com/AmazonVPC/latest/GettingStartedGuide/) and [Amazon VPC User Guide](https://docs.aws.amazon.com/vpc/latest/userguide/)\. \ No newline at end of file diff --git a/doc_source/USER_WorkingWithAutomatedBackups.md b/doc_source/USER_WorkingWithAutomatedBackups.md deleted file mode 100644 index 960f649..0000000 --- a/doc_source/USER_WorkingWithAutomatedBackups.md +++ /dev/null @@ -1,364 +0,0 @@ -# Working with backups - -Amazon RDS creates and saves automated backups of your DB instance or Multi\-AZ DB cluster during the backup window of your database\. RDS creates a storage volume snapshot of your database, backing up the entire database and not just individual databases\. RDS saves the automated backups of your database according to the backup retention period that you specify\. If necessary, you can recover your database to any point in time during the backup retention period\. - -Automated backups follow these rules: -+ Your database must be in the `available` state for automated backups to occur\. Automated backups don't occur while your database is in a state other than `available`, for example, `storage_full`\. -+ Automated backups don't occur while a DB snapshot copy is running in the same AWS Region for the same database\. - -You can also back up your database manually by creating a DB snapshot\. For more information about manually creating a DB snapshot, see [Creating a DB snapshot](USER_CreateSnapshot.md)\. - -The first snapshot of a database contains the data for the full database\. Subsequent snapshots of the same database are incremental, which means that only the data that has changed after your most recent snapshot is saved\. - -You can copy both automatic and manual DB snapshots, and share manual DB snapshots\. For more information about copying a DB snapshot, see [Copying a DB snapshot](USER_CopySnapshot.md)\. For more information about sharing a DB snapshot, see [Sharing a DB snapshot](USER_ShareSnapshot.md)\. - -## Backup storage - -Your Amazon RDS backup storage for each AWS Region is composed of the automated backups and manual DB snapshots for that Region\. Total backup storage space equals the sum of the storage for all backups in that Region\. Moving a DB snapshot to another Region increases the backup storage in the destination Region\. Backups are stored in Amazon S3\. - -For more information about backup storage costs, see [Amazon RDS pricing](https://aws.amazon.com/rds/pricing/)\. - -If you choose to retain automated backups when you delete a database, the automated backups are saved for the full retention period\. If you don't choose **Retain automated backups** when you delete a database, all automated backups are deleted with the database\. After they are deleted, the automated backups can't be recovered\. If you choose to have Amazon RDS create a final DB snapshot before it deletes your database, you can use that to recover your database\. Optionally, you can use a previously created manual snapshot\. Manual snapshots are not deleted\. You can have up to 100 manual snapshots per Region\. - -## Backup window - -Automated backups occur daily during the preferred backup window\. If the backup requires more time than allotted to the backup window, the backup continues after the window ends until it finishes\. The backup window can't overlap with the weekly maintenance window for the DB instance or Multi\-AZ DB cluster\. - -During the automatic backup window, storage I/O might be suspended briefly while the backup process initializes \(typically under a few seconds\)\. You might experience elevated latencies for a few minutes during backups for Multi\-AZ deployments\. For MariaDB, MySQL, Oracle, and PostgreSQL, I/O activity isn't suspended on your primary during backup for Multi\-AZ deployments because the backup is taken from the standby\. For SQL Server, I/O activity is suspended briefly during backup for both Single\-AZ and Multi\-AZ deployments because the backup is taken from the primary\. - -Automated backups might occasionally be skipped if the DB instance or cluster has a heavy workload at the time a backup is supposed to start\. If a backup is skipped, you can still do a point\-in\-time\-recovery \(PITR\), and a backup is still attempted during the next backup window\. For more information on PITR, see [Restoring a DB instance to a specified time](USER_PIT.md)\. - -If you don't specify a preferred backup window when you create the DB instance or Multi\-AZ DB cluster, Amazon RDS assigns a default 30\-minute backup window\. This window is selected at random from an 8\-hour block of time for each AWS Region\. The following table lists the time blocks for each AWS Region from which the default backup windows are assigned\. - - -**** -[\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_WorkingWithAutomatedBackups.html) - -## Backup retention period - -You can set the backup retention period when you create a DB instance or Multi\-AZ DB cluster\. If you don't set the backup retention period, the default backup retention period is one day if you create the database using the Amazon RDS API or the AWS CLI\. The default backup retention period is seven days if you create the database using the console\. - -After you create a DB instance or cluster, you can modify the backup retention period\. You can set the backup retention period of a DB instance to between 0 and 35 days\. Setting the backup retention period to 0 disables automated backups\. You can set the backup retention period of a multi\-AZ DB cluster to between 1 and 35 days\. Manual snapshot limits \(100 per Region\) don't apply to automated backups\. - -Automated backups aren't created while a DB instance or cluster is stopped\. Backups can be retained longer than the backup retention period if a database has been stopped\. RDS doesn't include time spent in the `stopped` state when the backup retention window is calculated\. - -**Important** -An outage occurs if you change the backup retention period from 0 to a nonzero value or from a nonzero value to 0\. This applies to both Single\-AZ and Multi\-AZ DB instances\. - -## Enabling automated backups - -If your database doesn't have automated backups enabled, you can enable them at any time\. You enable automated backups by setting the backup retention period to a positive nonzero value\. When automated backups are turned on, your RDS instance and database is taken offline and a backup is immediately created\. - -**Note** -If you manage your backups in AWS Backup, you can't enable automated backups\. For more information, see [Using AWS Backup to manage automated backups](#AutomatedBackups.AWSBackup)\. - -### Console - -**To enable automated backups immediately** - -1. Sign in to the AWS Management Console and open the Amazon RDS console at [https://console\.aws\.amazon\.com/rds/](https://console.aws.amazon.com/rds/)\. - -1. In the navigation pane, choose **Databases**, and then choose the DB instance or Multi\-AZ DB cluster that you want to modify\. - -1. Choose **Modify**\. - -1. For **Backup retention period**, choose a positive nonzero value, for example 3 days\. - -1. Choose **Continue**\. - -1. Choose **Apply immediately**\. - -1. Choose **Modify DB instance** or **Modify cluster** to save your changes and enable automated backups\. - -### AWS CLI - -To enable automated backups, use the AWS CLI [https://docs.aws.amazon.com/cli/latest/reference/rds/modify-db-instance.html](https://docs.aws.amazon.com/cli/latest/reference/rds/modify-db-instance.html) or [https://docs.aws.amazon.com/cli/latest/reference/rds/modify-db-cluster.html](https://docs.aws.amazon.com/cli/latest/reference/rds/modify-db-cluster.html) command\. - -Include the following parameters: -+ `--db-instance-identifier` \(or `--db-cluster-identifier` for a Multi\-AZ DB cluster\) -+ `--backup-retention-period` -+ `--apply-immediately` or `--no-apply-immediately` - -In the following example, we enable automated backups by setting the backup retention period to three days\. The changes are applied immediately\. - -**Example** -For Linux, macOS, or Unix: - -``` -aws rds modify-db-instance \ - --db-instance-identifier mydbinstance \ - --backup-retention-period 3 \ - --apply-immediately -``` -For Windows: - -``` -aws rds modify-db-instance ^ - --db-instance-identifier mydbinstance ^ - --backup-retention-period 3 ^ - --apply-immediately -``` - -### RDS API - -To enable automated backups, use the RDS API [https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_ModifyDBInstance.html](https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_ModifyDBInstance.html) or [https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_ModifyDBCluster.html](https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_ModifyDBCluster.html) operation with the following required parameters: -+ `DBInstanceIdentifier` or `DBClusterIdentifier` -+ `BackupRetentionPeriod` - -### Viewing automated backups - -To view your automated backups, choose **Automated backups** in the navigation pane\. To view individual snapshots associated with an automated backup, choose **Snapshots** in the navigation pane\. Alternatively, you can describe individual snapshots associated with an automated backup\. From there, you can restore a DB instance directly from one of those snapshots\. - -To describe the automated backups for your existing DB instances using the AWS CLI, use one of the following commands: - -``` -aws rds describe-db-instance-automated-backups --db-instance-identifier DBInstanceIdentifier -``` - -or - -``` -aws rds describe-db-instance-automated-backups --dbi-resource-id DbiResourceId -``` - -To describe the retained automated backups for your existing DB instances using the RDS API, call the [https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_DescribeDBInstanceAutomatedBackups.html](https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_DescribeDBInstanceAutomatedBackups.html) action with one of the following parameters: -+ `DBInstanceIdentifier` -+ `DbiResourceId` - -## Retaining automated backups - -**Note** -You can only retain automated backups of DB instances, not Multi\-AZ DB clusters\. - -When you delete a DB instance, you can choose to retain automated backups\. Automated backups can be retained for a number of days equal to the backup retention period configured for the DB instance at the time when you delete it\. - -Retained automated backups contain system snapshots and transaction logs from a DB instance\. They also include your DB instance properties like allocated storage and DB instance class, which are required to restore it to an active instance\. - -You can retain automated backups for RDS instances running the MySQL, MariaDB, PostgreSQL, Oracle, and Microsoft SQL Server engines\. - -You can restore or remove retained automated backups using the AWS Management Console, RDS API, and AWS CLI\. - -**Topics** -+ [Retention period](#USER_WorkingWithAutomatedBackups.RetentionPeriods) -+ [Viewing retained backups](#USER_WorkingWithAutomatedBackups.viewing-retained) -+ [Restoration](#USER_WorkingWithAutomatedBackups.Restoration) -+ [Retention costs](#USER_WorkingWithAutomatedBackups.RetentionCosts) -+ [Limitations and recommendations](#USER_WorkingWithAutomatedBackups.Limits) - -### Retention period - -The system snapshots and transaction logs in a retained automated backup expire the same way that they expire for the source DB instance\. Because there are no new snapshots or logs created for this instance, the retained automated backups eventually expire completely\. Effectively, they live as long their last system snapshot would have done, based on the settings for retention period the source instance had when you deleted it\. Retained automated backups are removed by the system after their last system snapshot expires\. - -You can remove a retained automated backup in the same way that you can delete a DB instance\. You can remove retained automated backups using the console or the RDS API operation `DeleteDBInstanceAutomatedBackup`\. - -Final snapshots are independent of retained automated backups\. We strongly suggest that you take a final snapshot even if you retain automated backups because the retained automated backups eventually expire\. The final snapshot doesn't expire\. - -### Viewing retained backups - -To view your retained automated backups, choose **Automated backups** in the navigation pane, then choose **Retained**\. To view individual snapshots associated with a retained automated backup, choose **Snapshots** in the navigation pane\. Alternatively, you can describe individual snapshots associated with a retained automated backup\. From there, you can restore a DB instance directly from one of those snapshots\. - -To describe your retained automated backups using the AWS CLI, use the following command: - -``` -aws rds describe-db-instance-automated-backups --dbi-resource-id DbiResourceId -``` - -To describe your retained automated backups using the RDS API, call the [https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_DescribeDBInstanceAutomatedBackups.html](https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_DescribeDBInstanceAutomatedBackups.html) action with the `DbiResourceId` parameter\. - -### Restoration - -For information on restoring DB instances from automated backups, see [Restoring a DB instance to a specified time](USER_PIT.md)\. - -### Retention costs - -The cost of a retained automated backup is the cost of total storage of the system snapshots that are associated with it\. There is no additional charge for transaction logs or instance metadata\. All other pricing rules for backups apply to restorable instances\. - -For example, suppose that your total allocated storage of running instances is 100 GB\. Suppose also that you have 50 GB of manual snapshots plus 75 GB of system snapshots associated with a retained automated backup\. In this case, you are charged only for the additional 25 GB of backup storage, like this: \(50 GB \+ 75 GB\) – 100 GB = 25 GB\. - -### Limitations and recommendations - -The following limitations apply to retained automated backups: -+ The maximum number of retained automated backups in one AWS Region is 40\. It's not included in the DB instances limit\. You can have 40 running DB instances and an additional 40 retained automated backups at the same time\. -+ Retained automated backups don't contain information about parameters or option groups\. -+ You can restore a deleted instance to a point in time that is within the retention period at the time of delete\. -+ You can't modify a retained automated backup\. That's because it consists of system backups, transaction logs, and the DB instance properties that existed at the time that you deleted the source instance\. - -## Deleting retained automated backups - -You can delete retained automated backups when they are no longer needed\. - -### Console - -**To delete a retained automated backup** - -1. Sign in to the AWS Management Console and open the Amazon RDS console at [https://console\.aws\.amazon\.com/rds/](https://console.aws.amazon.com/rds/)\. - -1. In the navigation pane, choose **Automated backups**\. - -1. On the **Retained** tab, choose the retained automated backup that you want to delete\. - -1. For **Actions**, choose **Delete**\. - -1. On the confirmation page, enter **delete me** and choose **Delete**\. - -### AWS CLI - -You can delete a retained automated backup by using the AWS CLI command [delete\-db\-instance\-automated\-backup](https://docs.aws.amazon.com/cli/latest/reference/rds/delete-db-instance-automated-backup.html) with the following option: -+ `--dbi-resource-id` – The resource identifier for the source DB instance\. - - You can find the resource identifier for the source DB instance of a retained automated backup by running the AWS CLI command [describe\-db\-instance\-automated\-backups](https://docs.aws.amazon.com/cli/latest/reference/rds/describe-db-instance-automated-backups.html)\. - -**Example** -The following example deletes the retained automated backup with source DB instance resource identifier `db-123ABCEXAMPLE`\. -For Linux, macOS, or Unix: - -``` -1. aws rds delete-db-instance-automated-backup \ -2. --dbi-resource-id db-123ABCEXAMPLE -``` -For Windows: - -``` -1. aws rds delete-db-instance-automated-backup ^ -2. --dbi-resource-id db-123ABCEXAMPLE -``` - -### RDS API - -You can delete a retained automated backup by using the Amazon RDS API operation [DeleteDBInstanceAutomatedBackup](https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_DeleteDBInstanceAutomatedBackup.html) with the following parameter: -+ `DbiResourceId` – The resource identifier for the source DB instance\. - - You can find the resource identifier for the source DB instance of a retained automated backup using the Amazon RDS API operation [DescribeDBInstanceAutomatedBackups](https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_DescribeDBInstanceAutomatedBackups.html)\. - -## Disabling automated backups - -You might want to temporarily disable automated backups in certain situations, for example while loading large amounts of data\. - -**Important** -We highly discourage disabling automated backups because it disables point\-in\-time recovery\. Disabling automatic backups for a DB instance or Multi\-AZ DB cluster deletes all existing automated backups for the database\. If you disable and then re\-enable automated backups, you can restore starting only from the time you re\-enabled automated backups\. - -### Console - -**To disable automated backups immediately** - -1. Sign in to the AWS Management Console and open the Amazon RDS console at [https://console\.aws\.amazon\.com/rds/](https://console.aws.amazon.com/rds/)\. - -1. In the navigation pane, choose **Databases**, and then choose the DB instance or Multi\-AZ DB cluster that you want to modify\. - -1. Choose **Modify**\. - -1. For **Backup retention period**, choose **0 days**\. - -1. Choose **Continue**\. - -1. Choose **Apply immediately**\. - -1. Choose **Modify DB instance** or **Modify cluster** to save your changes and disable automated backups\. - -### AWS CLI - -To disable automated backups immediately, use the [modify\-db\-instance](https://docs.aws.amazon.com/cli/latest/reference/rds/modify-db-instance.html) or [modify\-db\-cluster](https://docs.aws.amazon.com/cli/latest/reference/rds/modify-db-cluster.html) command and set the backup retention period to 0 with `--apply-immediately`\. - -**Example** -The following example immediately disables automatic backups on a Multi\-AZ DB cluster\. -For Linux, macOS, or Unix: - -``` -aws rds modify-db-cluster \ - --db-cluster-identifier mydbcluster \ - --backup-retention-period 0 \ - --apply-immediately -``` -For Windows: - -``` -aws rds modify-db-cluster ^ - --db-cluster-identifier mydbcluster ^ - --backup-retention-period 0 ^ - --apply-immediately -``` - -To know when the modification is in effect, call `describe-db-instances` for the DB instance \(or `describe-db-clusters` for a Multi\-AZ DB cluster\) until the value for backup retention period is 0 and `mydbcluster` status is available\. - -``` -aws rds describe-db-clusters --db-cluster-identifier mydcluster -``` - -### RDS API - -To disable automated backups immediately, call the [ModifyDBInstance](https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_ModifyDBInstance.html) or [ModifyDBCluster](https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_ModifyDBCluster.html) operation with the following parameters: -+ `DBInstanceIdentifier = mydbinstance` \(or `DBClusterIdentifier = mydbcluster`\) -+ `BackupRetentionPeriod = 0` - -**Example** - -``` -https://rds.amazonaws.com/ - ?Action=ModifyDBInstance - &DBInstanceIdentifier=mydbinstance - &BackupRetentionPeriod=0 - &SignatureVersion=2 - &SignatureMethod=HmacSHA256 - &Timestamp=2009-10-14T17%3A48%3A21.746Z - &AWSAccessKeyId=<&AWS; Access Key ID> - &Signature= -``` - -## Using AWS Backup to manage automated backups - -AWS Backup is a fully managed backup service that makes it easy to centralize and automate the backup of data across AWS services in the cloud and on premises\. You can manage backups of your Amazon RDS databases in AWS Backup\. - -To enable backups in AWS Backup, use resource tagging to associate your database with a backup plan\. For more information, see [Using tags to enable backups in AWS Backup](USER_Tagging.md#Tagging.RDS.AWSBackup)\. - -**Note** -Backups managed by AWS Backup are considered manual DB snapshots, but don't count toward the DB snapshot quota for RDS\. Backups that were created with AWS Backup have names ending in `awsbackup:backup-job-number`\. - -For more information about AWS Backup, see the [https://docs.aws.amazon.com/aws-backup/latest/devguide](https://docs.aws.amazon.com/aws-backup/latest/devguide)\. - -**To view backups managed by AWS Backup** - -1. Sign in to the AWS Management Console and open the Amazon RDS console at [https://console\.aws\.amazon\.com/rds/](https://console.aws.amazon.com/rds/)\. - -1. In the navigation pane, choose **Snapshots**\. - -1. Choose the **Backup service** tab\. - - Your AWS Backup backups are listed under **Backup service snapshots**\. - -## Automated backups with unsupported MySQL storage engines - -For the MySQL DB engine, automated backups are only supported for the InnoDB storage engine\. Using these features with other MySQL storage engines, including MyISAM, can lead to unreliable behavior when you're restoring from backups\. Specifically, since storage engines like MyISAM don't support reliable crash recovery, your tables can be corrupted in the event of a crash\. For this reason, we encourage you to use the InnoDB storage engine\. -+ To convert existing MyISAM tables to InnoDB tables, you can use the `ALTER TABLE` command, for example: `ALTER TABLE table_name ENGINE=innodb, ALGORITHM=COPY;` -+ If you choose to use MyISAM, you can attempt to manually repair tables that become damaged after a crash by using the `REPAIR` command\. For more information, see [REPAIR TABLE statement](https://dev.mysql.com/doc/refman/8.0/en/repair-table.html) in the MySQL documentation\. However, as noted in the MySQL documentation, there is a good chance that you might not be able to recover all your data\. -+ If you want to take a snapshot of your MyISAM tables before restoring, follow these steps: - - 1. Stop all activity to your MyISAM tables \(that is, close all sessions\)\. - - You can close all sessions by calling the [mysql\.rds\_kill](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Appendix.MySQL.CommonDBATasks.html) command for each process that is returned from the `SHOW FULL PROCESSLIST` command\. - - 1. Lock and flush each of your MyISAM tables\. For example, the following commands lock and flush two tables named `myisam_table1` and `myisam_table2`: - - ``` - mysql> FLUSH TABLES myisam_table, myisam_table2 WITH READ LOCK; - ``` - - 1. Create a snapshot of your DB instance or Multi\-AZ DB cluster\. When the snapshot has completed, release the locks and resume activity on the MyISAM tables\. You can release the locks on your tables using the following command: - - ``` - mysql> UNLOCK TABLES; - ``` - - These steps force MyISAM to flush data stored in memory to disk, which ensures a clean start when you restore from a DB snapshot\. For more information on creating a DB snapshot, see [Creating a DB snapshot](USER_CreateSnapshot.md)\. - -## Automated backups with unsupported MariaDB storage engines - -For the MariaDB DB engine, automated backups are only supported with the InnoDB storage engine\. Using these features with other MariaDB storage engines, including Aria, can lead to unreliable behavior when you're restoring from backups\. Even though Aria is a crash\-resistant alternative to MyISAM, your tables can still be corrupted in the event of a crash\. For this reason, we encourage you to use the InnoDB storage engine\. -+ To convert existing Aria tables to InnoDB tables, you can use the `ALTER TABLE` command\. For example: `ALTER TABLE table_name ENGINE=innodb, ALGORITHM=COPY;` -+ If you choose to use Aria, you can attempt to manually repair tables that become damaged after a crash by using the `REPAIR TABLE` command\. For more information, see [http://mariadb\.com/kb/en/mariadb/repair\-table/](http://mariadb.com/kb/en/mariadb/repair-table/)\. -+ If you want to take a snapshot of your Aria tables before restoring, follow these steps: - - 1. Stop all activity to your Aria tables \(that is, close all sessions\)\. - - 1. Lock and flush each of your Aria tables\. - - 1. Create a snapshot of your DB instance or Multi\-AZ DB cluster\. When the snapshot has completed, release the locks and resume activity on the Aria tables\. These steps force Aria to flush data stored in memory to disk, thereby ensuring a clean start when you restore from a DB snapshot\. \ No newline at end of file diff --git a/doc_source/USER_WorkingWithDBClusterParamGroups.md b/doc_source/USER_WorkingWithDBClusterParamGroups.md deleted file mode 100644 index 5c3fac1..0000000 --- a/doc_source/USER_WorkingWithDBClusterParamGroups.md +++ /dev/null @@ -1,435 +0,0 @@ -# Working with DB cluster parameter groups for Multi\-AZ DB clusters - -Multi\-AZ DB clusters use DB cluster parameter groups\. The following sections describe configuring and managing DB cluster parameter groups\. - -**Topics** -+ [Creating a DB cluster parameter group](#USER_WorkingWithParamGroups.CreatingCluster) -+ [Modifying parameters in a DB cluster parameter group](#USER_WorkingWithParamGroups.ModifyingCluster) -+ [Resetting parameters in a DB cluster parameter group](#USER_WorkingWithParamGroups.ResettingCluster) -+ [Copying a DB cluster parameter group](#USER_WorkingWithParamGroups.CopyingCluster) -+ [Listing DB cluster parameter groups](#USER_WorkingWithParamGroups.ListingCluster) -+ [Viewing parameter values for a DB cluster parameter group](#USER_WorkingWithParamGroups.ViewingCluster) - -## Creating a DB cluster parameter group - -You can create a new DB cluster parameter group using the AWS Management Console, the AWS CLI, or the RDS API\. - -After you create a DB cluster parameter group, wait at least 5 minutes before creating a DB cluster that uses that DB cluster parameter group\. Doing this allows Amazon RDS to fully create the parameter group before it is used by the new DB cluster\. You can use the **Parameter groups** page in the [Amazon RDS console](https://console.aws.amazon.com/rds/) or the [describe\-db\-cluster\-parameters](https://docs.aws.amazon.com/cli/latest/reference/rds/describe-db-cluster-parameters.html) command to verify that your DB cluster parameter group is created\. - -The following limitations apply to the DB cluster parameter group name: -+ The name must be 1 to 255 letters, numbers, or hyphens\. - - Default parameter group names can include a period, such as `default.aurora-mysql5.7`\. However, custom parameter group names can't include a period\. -+ The first character must be a letter\. -+ The name can't end with a hyphen or contain two consecutive hyphens\. - -### Console - -**To create a DB cluster parameter group** - -1. Sign in to the AWS Management Console and open the Amazon RDS console at [https://console\.aws\.amazon\.com/rds/](https://console.aws.amazon.com/rds/)\. - -1. In the navigation pane, choose **Parameter groups**\. - -1. Choose **Create parameter group**\. - - The **Create parameter group** window appears\. - -1. In the **Parameter group family** list, select a DB parameter group family - -1. In the **Type** list, select **DB Cluster Parameter Group**\. - -1. In the **Group name** box, enter the name of the new DB cluster parameter group\. - -1. In the **Description** box, enter a description for the new DB cluster parameter group\. - -1. Choose **Create**\. - -### AWS CLI - -To create a DB cluster parameter group, use the AWS CLI [https://docs.aws.amazon.com/cli/latest/reference/rds/create-db-cluster-parameter-group.html](https://docs.aws.amazon.com/cli/latest/reference/rds/create-db-cluster-parameter-group.html) command\. - -The following example creates a DB cluster parameter group named *mydbclusterparametergroup* for RDS for MySQL version 8\.0 with a description of "*My new cluster parameter group*\." - -Include the following required parameters: -+ `--db-cluster-parameter-group-name` -+ `--db-parameter-group-family` -+ `--description` - -To list all of the available parameter group families, use the following command: - -``` -aws rds describe-db-engine-versions --query "DBEngineVersions[].DBParameterGroupFamily" -``` - -**Note** -The output contains duplicates\. - -**Example** -For Linux, macOS, or Unix: - -``` -aws rds create-db-cluster-parameter-group \ - --db-cluster-parameter-group-name mydbclusterparametergroup \ - --db-parameter-group-family mysql8.0 \ - --description "My new cluster parameter group" -``` -For Windows: - -``` -aws rds create-db-cluster-parameter-group ^ - --db-cluster-parameter-group-name mydbclusterparametergroup ^ - --db-parameter-group-family mysql8.0 ^ - --description "My new cluster parameter group" -``` -This command produces output similar to the following: - -``` -{ - "DBClusterParameterGroup": { - "DBClusterParameterGroupName": "mydbclusterparametergroup", - "DBParameterGroupFamily": "mysql8.0", - "Description": "My new cluster parameter group", - "DBClusterParameterGroupArn": "arn:aws:rds:us-east-1:123456789012:cluster-pg:mydbclusterparametergroup2" - } -} -``` - -### RDS API - -To create a DB cluster parameter group, use the RDS API [https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_CreateDBClusterParameterGroup.html](https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_CreateDBClusterParameterGroup.html) action\. - -Include the following required parameters: -+ `DBClusterParameterGroupName` -+ `DBParameterGroupFamily` -+ `Description` - -## Modifying parameters in a DB cluster parameter group - -You can modify parameter values in a customer\-created DB cluster parameter group\. You can't change the parameter values in a default DB cluster parameter group\. Changes to parameters in a customer\-created DB cluster parameter group are applied to all DB clusters that are associated with the DB cluster parameter group\. - -### Console - -**To modify a DB cluster parameter group** - -1. Sign in to the AWS Management Console and open the Amazon RDS console at [https://console\.aws\.amazon\.com/rds/](https://console.aws.amazon.com/rds/)\. - -1. In the navigation pane, choose **Parameter groups**\. - -1. In the list, choose the parameter group that you want to modify\. - -1. For **Parameter group actions**, choose **Edit**\. - -1. Change the values of the parameters you want to modify\. You can scroll through the parameters using the arrow keys at the top right of the dialog box\. - - You can't change values in a default parameter group\. - -1. Choose **Save changes**\. - -1. Reboot the primary DB instance in the cluster to apply the changes to all of the DB instances in the cluster\. - -### AWS CLI - -To modify a DB cluster parameter group, use the AWS CLI [https://docs.aws.amazon.com/cli/latest/reference/rds/modify-db-cluster-parameter-group.html](https://docs.aws.amazon.com/cli/latest/reference/rds/modify-db-cluster-parameter-group.html) command with the following required parameters: -+ `--db-cluster-parameter-group-name` -+ `--parameters` - -The following example modifies the `server_audit_logging` and `server_audit_logs_upload` values in the DB cluster parameter group named *mydbclusterparametergroup*\. - -**Example** -For Linux, macOS, or Unix: - -``` -aws rds modify-db-cluster-parameter-group \ - --db-cluster-parameter-group-name mydbclusterparametergroup \ - --parameters "ParameterName=server_audit_logging,ParameterValue=1,ApplyMethod=immediate" \ - "ParameterName=server_audit_logs_upload,ParameterValue=1,ApplyMethod=immediate" -``` -For Windows: - -``` -aws rds modify-db-cluster-parameter-group ^ - --db-cluster-parameter-group-name mydbclusterparametergroup ^ - --parameters "ParameterName=server_audit_logging,ParameterValue=1,ApplyMethod=immediate" ^ - "ParameterName=server_audit_logs_upload,ParameterValue=1,ApplyMethod=immediate" -``` -The command produces output like the following: - -``` -DBCLUSTERPARAMETERGROUP mydbclusterparametergroup -``` - -### RDS API - -To modify a DB cluster parameter group, use the RDS API [https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_ModifyDBClusterParameterGroup.html](https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_ModifyDBClusterParameterGroup.html) command with the following required parameters: -+ `DBClusterParameterGroupName` -+ `Parameters` - -## Resetting parameters in a DB cluster parameter group - -You can reset parameters to their default values in a customer\-created DB cluster parameter group\. Changes to parameters in a customer\-created DB cluster parameter group are applied to all DB clusters that are associated with the DB cluster parameter group\. - -**Note** -In a default DB cluster parameter group, parameters are always set to their default values\. - -### Console - -**To reset parameters in a DB cluster parameter group to their default values** - -1. Sign in to the AWS Management Console and open the Amazon RDS console at [https://console\.aws\.amazon\.com/rds/](https://console.aws.amazon.com/rds/)\. - -1. In the navigation pane, choose **Parameter groups**\. - -1. In the list, choose the parameter group\. - -1. For **Parameter group actions**, choose **Edit**\. - -1. Choose the parameters that you want to reset to their default values\. You can scroll through the parameters using the arrow keys at the top right of the dialog box\. - - You can't reset values in a default parameter group\. - -1. Choose **Reset** and then confirm by choosing **Reset parameters**\. - -1. Reboot the primary DB instance in the DB cluster to apply the changes to all of the DB instances in the DB cluster\. - -### AWS CLI - -To reset parameters in a DB cluster parameter group to their default values, use the AWS CLI [https://docs.aws.amazon.com/cli/latest/reference/rds/reset-db-cluster-parameter-group.html](https://docs.aws.amazon.com/cli/latest/reference/rds/reset-db-cluster-parameter-group.html) command with the following required option: `--db-cluster-parameter-group-name`\. - -To reset all of the parameters in the DB cluster parameter group, specify the `--reset-all-parameters` option\. To reset specific parameters, specify the `--parameters` option\. - -The following example resets all of the parameters in the DB parameter group named *mydbparametergroup* to their default values\. - -**Example** -For Linux, macOS, or Unix: - -``` -aws rds reset-db-cluster-parameter-group \ - --db-cluster-parameter-group-name mydbparametergroup \ - --reset-all-parameters -``` -For Windows: - -``` -aws rds reset-db-cluster-parameter-group ^ - --db-cluster-parameter-group-name mydbparametergroup ^ - --reset-all-parameters -``` - -The following example resets the `server_audit_logging` and `server_audit_logs_upload` to their default values in the DB cluster parameter group named *mydbclusterparametergroup*\. - -**Example** -For Linux, macOS, or Unix: - -``` -aws rds reset-db-cluster-parameter-group \ - --db-cluster-parameter-group-name mydbclusterparametergroup \ - --parameters "ParameterName=server_audit_logging,ApplyMethod=immediate" \ - "ParameterName=server_audit_logs_upload,ApplyMethod=immediate" -``` -For Windows: - -``` -aws rds reset-db-cluster-parameter-group ^ - --db-cluster-parameter-group-name mydbclusterparametergroup ^ - --parameters "ParameterName=server_audit_logging,ParameterValue=1,ApplyMethod=immediate" ^ - "ParameterName=server_audit_logs_upload,ParameterValue=1,ApplyMethod=immediate" -``` -The command produces output like the following: - -``` -DBClusterParameterGroupName mydbclusterparametergroup -``` - -### RDS API - -To reset parameters in a DB cluster parameter group to their default values, use the RDS API [https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_ResetDBClusterParameterGroup.html](https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_ResetDBClusterParameterGroup.html) command with the following required parameter: `DBClusterParameterGroupName`\. - -To reset all of the parameters in the DB cluster parameter group, set the `ResetAllParameters` parameter to `true`\. To reset specific parameters, specify the `Parameters` parameter\. - -## Copying a DB cluster parameter group - -You can copy custom DB cluster parameter groups that you create\. Copying a parameter group is a convenient solution when you have already created a DB cluster parameter group and you want to include most of the custom parameters and values from that group in a new DB cluster parameter group\. You can copy a DB cluster parameter group by using the AWS CLI [copy\-db\-cluster\-parameter\-group](https://docs.aws.amazon.com/cli/latest/reference/rds/copy-db-cluster-parameter-group.html) command or the RDS API [CopyDBClusterParameterGroup](https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_CopyDBParameterGroup.html) operation\. - -After you copy a DB cluster parameter group, wait at least 5 minutes before creating a DB cluster that uses that DB cluster parameter group\. Doing this allows Amazon RDS to fully copy the parameter group before it is used by the new DB cluster\. You can use the **Parameter groups** page in the [Amazon RDS console](https://console.aws.amazon.com/rds/) or the [describe\-db\-cluster\-parameters](https://docs.aws.amazon.com/cli/latest/reference/rds/describe-db-cluster-parameters.html) command to verify that your DB cluster parameter group is created\. - -**Note** -You can't copy a default parameter group\. However, you can create a new parameter group that is based on a default parameter group\. - -### Console - -**To copy a DB cluster parameter group** - -1. Sign in to the AWS Management Console and open the Amazon RDS console at [https://console\.aws\.amazon\.com/rds/](https://console.aws.amazon.com/rds/)\. - -1. In the navigation pane, choose **Parameter groups**\. - -1. In the list, choose the custom parameter group that you want to copy\. - -1. For **Parameter group actions**, choose **Copy**\. - -1. In **New DB parameter group identifier**, enter a name for the new parameter group\. - -1. In **Description**, enter a description for the new parameter group\. - -1. Choose **Copy**\. - -### AWS CLI - -To copy a DB cluster parameter group, use the AWS CLI [https://docs.aws.amazon.com/cli/latest/reference/rds/copy-db-cluster-parameter-group.html](https://docs.aws.amazon.com/cli/latest/reference/rds/copy-db-cluster-parameter-group.html) command with the following required parameters: -+ `--source-db-cluster-parameter-group-identifier` -+ `--target-db-cluster-parameter-group-identifier` -+ `--target-db-cluster-parameter-group-description` - -The following example creates a new DB cluster parameter group named `mygroup2` that is a copy of the DB cluster parameter group `mygroup1`\. - -**Example** -For Linux, macOS, or Unix: - -``` -aws rds copy-db-cluster-parameter-group \ - --source-db-cluster-parameter-group-identifier mygroup1 \ - --target-db-cluster-parameter-group-identifier mygroup2 \ - --target-db-cluster-parameter-group-description "DB parameter group 2" -``` -For Windows: - -``` -aws rds copy-db-cluster-parameter-group ^ - --source-db-cluster-parameter-group-identifier mygroup1 ^ - --target-db-cluster-parameter-group-identifier mygroup2 ^ - --target-db-cluster-parameter-group-description "DB parameter group 2" -``` - -### RDS API - -To copy a DB cluster parameter group, use the RDS API [https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_CopyDBClusterParameterGroup.html](https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_CopyDBClusterParameterGroup.html) operation with the following required parameters: -+ `SourceDBClusterParameterGroupIdentifier` -+ `TargetDBClusterParameterGroupIdentifier` -+ `TargetDBClusterParameterGroupDescription` - -## Listing DB cluster parameter groups - -You can list the DB cluster parameter groups you've created for your AWS account\. - -**Note** -Default parameter groups are automatically created from a default parameter template when you create a DB cluster for a particular DB engine and version\. These default parameter groups contain preferred parameter settings and can't be modified\. When you create a custom parameter group, you can modify parameter settings\. - -### Console - -**To list all DB cluster parameter groups for an AWS account** - -1. Sign in to the AWS Management Console and open the Amazon RDS console at [https://console\.aws\.amazon\.com/rds/](https://console.aws.amazon.com/rds/)\. - -1. In the navigation pane, choose **Parameter groups**\. - - The DB cluster parameter groups appear in the list with **DB cluster parameter group** for **Type**\. - -### AWS CLI - -To list all DB cluster parameter groups for an AWS account, use the AWS CLI [https://docs.aws.amazon.com/cli/latest/reference/rds/describe-db-clusterparameter-groups.html](https://docs.aws.amazon.com/cli/latest/reference/rds/describe-db-clusterparameter-groups.html) command\. - -**Example** -The following example lists all available DB cluster parameter groups for an AWS account\. - -``` -aws rds describe-db-cluster-parameter-groups -``` -The following example describes the *mydbclusterparametergroup* parameter group\. -For Linux, macOS, or Unix: - -``` -aws rds describe-db-cluster-parameter-groups \ - --db-cluster-parameter-group-name mydbclusterparametergroup -``` -For Windows: - -``` -aws rds describe-db-cluster-parameter-groups ^ - --db-cluster-parameter-group-name mydbclusterparametergroup -``` -The command returns a response like the following: - -``` -{ - "DBClusterParameterGroups": [ - { - "DBClusterParameterGroupName": "mydbclusterparametergroup2", - "DBParameterGroupFamily": "mysql8.0", - "Description": "My new cluster parameter group", - "DBClusterParameterGroupArn": "arn:aws:rds:us-east-1:123456789012:cluster-pg:mydbclusterparametergroup" - } - ] -} -``` - -### RDS API - -To list all DB cluster parameter groups for an AWS account, use the RDS API [https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_DescribeDBClusterParameterGroups.html](https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_DescribeDBClusterParameterGroups.html) action\. - -## Viewing parameter values for a DB cluster parameter group - -You can get a list of all parameters in a DB cluster parameter group and their values\. - -### Console - -**To view the parameter values for a DB cluster parameter group** - -1. Sign in to the AWS Management Console and open the Amazon RDS console at [https://console\.aws\.amazon\.com/rds/](https://console.aws.amazon.com/rds/)\. - -1. In the navigation pane, choose **Parameter groups**\. - - The DB cluster parameter groups appear in the list with **DB cluster parameter group** for **Type**\. - -1. Choose the name of the DB cluster parameter group to see its list of parameters\. - -### AWS CLI - -To view the parameter values for a DB cluster parameter group, use the AWS CLI [https://docs.aws.amazon.com/cli/latest/reference/rds/describe-db-cluster-parameters.html](https://docs.aws.amazon.com/cli/latest/reference/rds/describe-db-cluster-parameters.html) command with the following required parameter\. -+ `--db-cluster-parameter-group-name` - -**Example** -The following example lists the parameters and parameter values for a DB cluster parameter group named *mydbclusterparametergroup*, in JSON format\. -The command returns a response like the following: - -``` -aws rds describe-db-cluster-parameters --db-cluster-parameter-group-name mydbclusterparametergroup -``` - -``` -{ - "Parameters": [ - { - "ParameterName": "activate_all_roles_on_login", - "ParameterValue": "0", - "Description": "Automatically set all granted roles as active after the user has authenticated successfully.", - "Source": "engine-default", - "ApplyType": "dynamic", - "DataType": "boolean", - "AllowedValues": "0,1", - "IsModifiable": true, - "ApplyMethod": "pending-reboot", - "SupportedEngineModes": [ - "provisioned" - ] - }, - { - "ParameterName": "allow-suspicious-udfs", - "Description": "Controls whether user-defined functions that have only an xxx symbol for the main function can be loaded", - "Source": "engine-default", - "ApplyType": "static", - "DataType": "boolean", - "AllowedValues": "0,1", - "IsModifiable": false, - "ApplyMethod": "pending-reboot", - "SupportedEngineModes": [ - "provisioned" - ] - }, -... -``` - -### RDS API - -To view the parameter values for a DB cluster parameter group, use the RDS API [https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_DescribeDBParameters.html](https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_DescribeDBParameters.html) command with the following required parameter\. -+ `DBClusterParameterGroupName` \ No newline at end of file diff --git a/doc_source/USER_WorkingWithDBInstanceParamGroups.md b/doc_source/USER_WorkingWithDBInstanceParamGroups.md deleted file mode 100644 index ce4e607..0000000 --- a/doc_source/USER_WorkingWithDBInstanceParamGroups.md +++ /dev/null @@ -1,466 +0,0 @@ -# Working with DB parameter groups - -DB instances use DB parameter groups\. The following sections describe configuring and managing DB instance parameter groups\. - -**Topics** -+ [Creating a DB parameter group](#USER_WorkingWithParamGroups.Creating) -+ [Associating a DB parameter group with a DB instance](#USER_WorkingWithParamGroups.Associating) -+ [Modifying parameters in a DB parameter group](#USER_WorkingWithParamGroups.Modifying) -+ [Resetting parameters in a DB parameter group to their default values](#USER_WorkingWithParamGroups.Resetting) -+ [Copying a DB parameter group](#USER_WorkingWithParamGroups.Copying) -+ [Listing DB parameter groups](#USER_WorkingWithParamGroups.Listing) -+ [Viewing parameter values for a DB parameter group](#USER_WorkingWithParamGroups.Viewing) - -## Creating a DB parameter group - -You can create a new DB parameter group using the AWS Management Console, the AWS CLI, or the RDS API\. - -The following limitations apply to the DB parameter group name: -+ The name must be 1 to 255 letters, numbers, or hyphens\. - - Default parameter group names can include a period, such as `default.mysql8.0`\. However, custom parameter group names can't include a period\. -+ The first character must be a letter\. -+ The name can't end with a hyphen or contain two consecutive hyphens\. - -### Console - -**To create a DB parameter group** - -1. Sign in to the AWS Management Console and open the Amazon RDS console at [https://console\.aws\.amazon\.com/rds/](https://console.aws.amazon.com/rds/)\. - -1. In the navigation pane, choose **Parameter groups**\. - -1. Choose **Create parameter group**\. - - The **Create parameter group** window appears\. - -1. In the **Parameter group family** list, select a DB parameter group family\. - -1. In the **Type** list, select **DB Parameter Group**\. - -1. In the **Group name** box, enter the name of the new DB parameter group\. - -1. In the **Description** box, enter a description for the new DB parameter group\. - -1. Choose **Create**\. - -### AWS CLI - -To create a DB parameter group, use the AWS CLI [https://docs.aws.amazon.com/cli/latest/reference/rds/create-db-parameter-group.html](https://docs.aws.amazon.com/cli/latest/reference/rds/create-db-parameter-group.html) command\. The following example creates a DB parameter group named *mydbparametergroup* for MySQL version 8\.0 with a description of "*My new parameter group*\." - -Include the following required parameters: -+ `--db-parameter-group-name` -+ `--db-parameter-group-family` -+ `--description` - -To list all of the available parameter group families, use the following command: - -``` -aws rds describe-db-engine-versions --query "DBEngineVersions[].DBParameterGroupFamily" -``` - -**Note** -The output contains duplicates\. - -**Example** -For Linux, macOS, or Unix: - -``` -aws rds create-db-parameter-group \ - --db-parameter-group-name mydbparametergroup \ - --db-parameter-group-family MySQL8.0 \ - --description "My new parameter group" -``` -For Windows: - -``` -aws rds create-db-parameter-group ^ - --db-parameter-group-name mydbparametergroup ^ - --db-parameter-group-family MySQL8.0 ^ - --description "My new parameter group" -``` -This command produces output similar to the following: - -``` -DBPARAMETERGROUP mydbparametergroup mysql8.0 My new parameter group -``` - -### RDS API - -To create a DB parameter group, use the RDS API [https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_CreateDBParameterGroup.html](https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_CreateDBParameterGroup.html) operation\. - -Include the following required parameters: -+ `DBParameterGroupName` -+ `DBParameterGroupFamily` -+ `Description` - -## Associating a DB parameter group with a DB instance - -You can create your own DB parameter groups with customized settings\. You can associate a DB parameter group with a DB instance using the AWS Management Console, the AWS CLI, or the RDS API\. You can do so when you create or modify a DB instance\. - -For information about creating a DB parameter group, see [Creating a DB parameter group](#USER_WorkingWithParamGroups.Creating)\. For information about creating a DB instance, see [Creating an Amazon RDS DB instance](USER_CreateDBInstance.md)\. For information about modifying a DB instance, see [Modifying an Amazon RDS DB instance](Overview.DBInstance.Modifying.md)\. - -**Note** -When you associate a new DB parameter group with a DB instance, the modified static and dynamic parameters are applied only after the DB instance is rebooted\. However, if you modify dynamic parameters in the DB parameter group after you associate it with the DB instance, these changes are applied immediately without a reboot\. - -### Console - -**To associate a DB parameter group with a DB instance** - -1. Sign in to the AWS Management Console and open the Amazon RDS console at [https://console\.aws\.amazon\.com/rds/](https://console.aws.amazon.com/rds/)\. - -1. In the navigation pane, choose **Databases**, and then choose the DB instance that you want to modify\. - -1. Choose **Modify**\. The **Modify DB Instance** page appears\. - -1. Change the **DB parameter group** setting\. - -1. Choose **Continue** and check the summary of modifications\. - -1. \(Optional\) Choose **Apply immediately** to apply the changes immediately\. Choosing this option can cause an outage in some cases\. For more information, see [Using the Apply Immediately setting](Overview.DBInstance.Modifying.md#USER_ModifyInstance.ApplyImmediately)\. - -1. On the confirmation page, review your changes\. If they are correct, choose **Modify DB instance** to save your changes\. - - Or choose **Back** to edit your changes or **Cancel** to cancel your changes\. - -### AWS CLI - -To associate a DB parameter group with a DB instance, use the AWS CLI [https://docs.aws.amazon.com/cli/latest/reference/rds/modify-db-instance.html](https://docs.aws.amazon.com/cli/latest/reference/rds/modify-db-instance.html) command with the following options: -+ `--db-instance-identifier` -+ `--db-parameter-group-name` - -The following example associates the `mydbpg` DB parameter group with the `database-1` DB instance\. The changes are applied immediately by using `--apply-immediately`\. Use `--no-apply-immediately` to apply the changes during the next maintenance window\. For more information, see [Using the Apply Immediately setting](Overview.DBInstance.Modifying.md#USER_ModifyInstance.ApplyImmediately)\. - -**Example** -For Linux, macOS, or Unix: - -``` -aws rds modify-db-instance \ - --db-instance-identifier database-1 \ - --db-parameter-group-name mydbpg \ - --apply-immediately -``` -For Windows: - -``` -aws rds modify-db-instance ^ - --db-instance-identifier database-1 ^ - --db-parameter-group-name mydbpg ^ - --apply-immediately -``` - -### RDS API - -To associate a DB parameter group with a DB instance, use the RDS API [https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_ModifyDBInstance.html](https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_ModifyDBInstance.html) operation with the following parameters: -+ `DBInstanceName` -+ `DBParameterGroupName` - -## Modifying parameters in a DB parameter group - -You can modify parameter values in a customer\-created DB parameter group; you can't change the parameter values in a default DB parameter group\. Changes to parameters in a customer\-created DB parameter group are applied to all DB instances that are associated with the DB parameter group\. - -Changes to some parameters are applied to the DB instance immediately without a reboot\. Changes to other parameters are applied only after the DB instance is rebooted\. The RDS console shows the status of the DB parameter group associated with a DB instance on the **Configuration** tab\. For example, suppose that the DB instance isn't using the latest changes to its associated DB parameter group\. If so, the RDS console shows the DB parameter group with a status of **pending\-reboot**\. To apply the latest parameter changes to that DB instance, manually reboot the DB instance\. - -![\[Parameter change pending reboot scenario\]](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/images/param-reboot.png) - -### Console - -**To modify a DB parameter group** - -1. Sign in to the AWS Management Console and open the Amazon RDS console at [https://console\.aws\.amazon\.com/rds/](https://console.aws.amazon.com/rds/)\. - -1. In the navigation pane, choose **Parameter groups**\. - -1. In the list, choose the parameter group that you want to modify\. - -1. For **Parameter group actions**, choose **Edit**\. - -1. Change the values of the parameters that you want to modify\. You can scroll through the parameters using the arrow keys at the top right of the dialog box\. - - You can't change values in a default parameter group\. - -1. Choose **Save changes**\. - -### AWS CLI - -To modify a DB parameter group, use the AWS CLI [https://docs.aws.amazon.com/cli/latest/reference/rds/modify-db-parameter-group.html](https://docs.aws.amazon.com/cli/latest/reference/rds/modify-db-parameter-group.html) command with the following required options: -+ `--db-parameter-group-name` -+ `--parameters` - -The following example modifies the` max_connections` and `max_allowed_packet` values in the DB parameter group named *mydbparametergroup*\. - -**Example** -For Linux, macOS, or Unix: - -``` -aws rds modify-db-parameter-group \ - --db-parameter-group-name mydbparametergroup \ - --parameters "ParameterName=max_connections,ParameterValue=250,ApplyMethod=immediate" \ - "ParameterName=max_allowed_packet,ParameterValue=1024,ApplyMethod=immediate" -``` -For Windows: - -``` -aws rds modify-db-parameter-group ^ - --db-parameter-group-name mydbparametergroup ^ - --parameters "ParameterName=max_connections,ParameterValue=250,ApplyMethod=immediate" ^ - "ParameterName=max_allowed_packet,ParameterValue=1024,ApplyMethod=immediate" -``` -The command produces output like the following: - -``` -DBPARAMETERGROUP mydbparametergroup -``` - -### RDS API - -To modify a DB parameter group, use the RDS API [https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_ModifyDBParameterGroup.html](https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_ModifyDBParameterGroup.html) operation with the following required parameters: -+ `DBParameterGroupName` -+ `Parameters` - -## Resetting parameters in a DB parameter group to their default values - -You can reset parameter values in a customer\-created DB parameter group to their default values\. Changes to parameters in a customer\-created DB parameter group are applied to all DB instances that are associated with the DB parameter group\. - -When you use the console, you can reset specific parameters to their default values\. However, you can't easily reset all of the parameters in the DB parameter group at once\. When you use the AWS CLI or RDS API, you can reset specific parameters to their default values\. You can also reset all of the parameters in the DB parameter group at once\. - -Changes to some parameters are applied to the DB instance immediately without a reboot\. Changes to other parameters are applied only after the DB instance is rebooted\. The RDS console shows the status of the DB parameter group associated with a DB instance on the **Configuration** tab\. For example, suppose that the DB instance isn't using the latest changes to its associated DB parameter group\. If so, the RDS console shows the DB parameter group with a status of **pending\-reboot**\. To apply the latest parameter changes to that DB instance, manually reboot the DB instance\. - -![\[Parameter change pending reboot scenario\]](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/images/param-reboot.png) - -**Note** -In a default DB parameter group, parameters are always set to their default values\. - -### Console - -**To reset parameters in a DB parameter group to their default values** - -1. Sign in to the AWS Management Console and open the Amazon RDS console at [https://console\.aws\.amazon\.com/rds/](https://console.aws.amazon.com/rds/)\. - -1. In the navigation pane, choose **Parameter groups**\. - -1. In the list, choose the parameter group\. - -1. For **Parameter group actions**, choose **Edit**\. - -1. Choose the parameters that you want to reset to their default values\. You can scroll through the parameters using the arrow keys at the top right of the dialog box\. - - You can't reset values in a default parameter group\. - -1. Choose **Reset** and then confirm by choosing **Reset parameters**\. - -### AWS CLI - -To reset some or all of the parameters in a DB parameter group, use the AWS CLI [https://docs.aws.amazon.com/cli/latest/reference/rds/reset-db-parameter-group.html](https://docs.aws.amazon.com/cli/latest/reference/rds/reset-db-parameter-group.html) command with the following required option: `--db-parameter-group-name`\. - -To reset all of the parameters in the DB parameter group, specify the `--reset-all-parameters` option\. To reset specific parameters, specify the `--parameters` option\. - -The following example resets all of the parameters in the DB parameter group named *mydbparametergroup* to their default values\. - -**Example** -For Linux, macOS, or Unix: - -``` -aws rds reset-db-parameter-group \ - --db-parameter-group-name mydbparametergroup \ - --reset-all-parameters -``` -For Windows: - -``` -aws rds reset-db-parameter-group ^ - --db-parameter-group-name mydbparametergroup ^ - --reset-all-parameters -``` - -The following example resets the `max_connections` and `max_allowed_packet` options to their default values in the DB parameter group named *mydbparametergroup*\. - -**Example** -For Linux, macOS, or Unix: - -``` -aws rds reset-db-parameter-group \ - --db-parameter-group-name mydbparametergroup \ - --parameters "ParameterName=max_connections,ApplyMethod=immediate" \ - "ParameterName=max_allowed_packet,ApplyMethod=immediate" -``` -For Windows: - -``` -aws rds reset-db-parameter-group ^ - --db-parameter-group-name mydbparametergroup ^ - --parameters "ParameterName=max_connections,ApplyMethod=immediate" ^ - "ParameterName=max_allowed_packet,ApplyMethod=immediate" -``` -The command produces output like the following: - -``` -DBParameterGroupName mydbparametergroup -``` - -### RDS API - -To reset parameters in a DB parameter group to their default values, use the RDS API [https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_ResetDBParameterGroup.html](https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_ResetDBParameterGroup.html) command with the following required parameter: `DBParameterGroupName`\. - -To reset all of the parameters in the DB parameter group, set the `ResetAllParameters` parameter to `true`\. To reset specific parameters, specify the `Parameters` parameter\. - -## Copying a DB parameter group - -You can copy custom DB parameter groups that you create\. Copying a parameter group can be convenient solution\. An example is when you have created a DB parameter group and want to include most of its custom parameters and values in a new DB parameter group\. You can copy a DB parameter group by using the AWS Management Console\. You can also use the AWS CLI [copy\-db\-parameter\-group](https://docs.aws.amazon.com/cli/latest/reference/rds/copy-db-parameter-group.html) command or the RDS API [CopyDBParameterGroup](https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_CopyDBParameterGroup.html) operation\. - -After you copy a DB parameter group, wait at least 5 minutes before creating your first DB instance that uses that DB parameter group as the default parameter group\. Doing this allows Amazon RDS to fully complete the copy action before the parameter group is used\. This is especially important for parameters that are critical when creating the default database for a DB instance\. An example is the character set for the default database defined by the `character_set_database` parameter\. Use the **Parameter Groups** option of the [Amazon RDS console](https://console.aws.amazon.com/rds/) or the [describe\-db\-parameters](https://docs.aws.amazon.com/cli/latest/reference/rds/describe-db-parameters.html) command to verify that your DB parameter group is created\. - -**Note** -You can't copy a default parameter group\. However, you can create a new parameter group that is based on a default parameter group\. -Currently, you can't copy a parameter group to a different AWS Region\. - -### Console - -**To copy a DB parameter group** - -1. Sign in to the AWS Management Console and open the Amazon RDS console at [https://console\.aws\.amazon\.com/rds/](https://console.aws.amazon.com/rds/)\. - -1. In the navigation pane, choose **Parameter groups**\. - -1. In the list, choose the custom parameter group that you want to copy\. - -1. For **Parameter group actions**, choose **Copy**\. - -1. In **New DB parameter group identifier**, enter a name for the new parameter group\. - -1. In **Description**, enter a description for the new parameter group\. - -1. Choose **Copy**\. - -### AWS CLI - -To copy a DB parameter group, use the AWS CLI [https://docs.aws.amazon.com/cli/latest/reference/rds/copy-db-parameter-group.html](https://docs.aws.amazon.com/cli/latest/reference/rds/copy-db-parameter-group.html) command with the following required options: -+ `--source-db-parameter-group-identifier` -+ `--target-db-parameter-group-identifier` -+ `--target-db-parameter-group-description` - -The following example creates a new DB parameter group named `mygroup2` that is a copy of the DB parameter group `mygroup1`\. - -**Example** -For Linux, macOS, or Unix: - -``` -aws rds copy-db-parameter-group \ - --source-db-parameter-group-identifier mygroup1 \ - --target-db-parameter-group-identifier mygroup2 \ - --target-db-parameter-group-description "DB parameter group 2" -``` -For Windows: - -``` -aws rds copy-db-parameter-group ^ - --source-db-parameter-group-identifier mygroup1 ^ - --target-db-parameter-group-identifier mygroup2 ^ - --target-db-parameter-group-description "DB parameter group 2" -``` - -### RDS API - -To copy a DB parameter group, use the RDS API [https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_CopyDBParameterGroup.html](https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_CopyDBParameterGroup.html) operation with the following required parameters: -+ `SourceDBParameterGroupIdentifier` -+ `TargetDBParameterGroupIdentifier` -+ `TargetDBParameterGroupDescription` - -## Listing DB parameter groups - -You can list the DB parameter groups you've created for your AWS account\. - -**Note** -Default parameter groups are automatically created from a default parameter template when you create a DB instance for a particular DB engine and version\. These default parameter groups contain preferred parameter settings and can't be modified\. When you create a custom parameter group, you can modify parameter settings\. - -### Console - -**To list all DB parameter groups for an AWS account** - -1. Sign in to the AWS Management Console and open the Amazon RDS console at [https://console\.aws\.amazon\.com/rds/](https://console.aws.amazon.com/rds/)\. - -1. In the navigation pane, choose **Parameter groups**\. - - The DB parameter groups appear in a list\. - -### AWS CLI - -To list all DB parameter groups for an AWS account, use the AWS CLI [https://docs.aws.amazon.com/cli/latest/reference/rds/describe-db-parameter-groups.html](https://docs.aws.amazon.com/cli/latest/reference/rds/describe-db-parameter-groups.html) command\. - -**Example** -The following example lists all available DB parameter groups for an AWS account\. - -``` -aws rds describe-db-parameter-groups -``` -The command returns a response like the following: - -``` -DBPARAMETERGROUP default.mysql8.0 mysql8.0 Default parameter group for MySQL8.0 -DBPARAMETERGROUP mydbparametergroup mysql8.0 My new parameter group -``` -The following example describes the *mydbparamgroup1* parameter group\. -For Linux, macOS, or Unix: - -``` -aws rds describe-db-parameter-groups \ - --db-parameter-group-name mydbparamgroup1 -``` -For Windows: - -``` -aws rds describe-db-parameter-groups ^ - --db-parameter-group-name mydbparamgroup1 -``` -The command returns a response like the following: - -``` -DBPARAMETERGROUP mydbparametergroup1 mysql8.0 My new parameter group -``` - -### RDS API - -To list all DB parameter groups for an AWS account, use the RDS API [https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_DescribeDBParameterGroups.html](https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_DescribeDBParameterGroups.html) operation\. - -## Viewing parameter values for a DB parameter group - -You can get a list of all parameters in a DB parameter group and their values\. - -### Console - -**To view the parameter values for a DB parameter group** - -1. Sign in to the AWS Management Console and open the Amazon RDS console at [https://console\.aws\.amazon\.com/rds/](https://console.aws.amazon.com/rds/)\. - -1. In the navigation pane, choose **Parameter groups**\. - - The DB parameter groups appear in a list\. - -1. Choose the name of the parameter group to see its list of parameters\. - -### AWS CLI - -To view the parameter values for a DB parameter group, use the AWS CLI [https://docs.aws.amazon.com/cli/latest/reference/rds/describe-db-parameters.html](https://docs.aws.amazon.com/cli/latest/reference/rds/describe-db-parameters.html) command with the following required parameter\. -+ `--db-parameter-group-name` - -**Example** -The following example lists the parameters and parameter values for a DB parameter group named *mydbparametergroup\.* - -``` -aws rds describe-db-parameters --db-parameter-group-name mydbparametergroup -``` -The command returns a response like the following: - -``` -DBPARAMETER Parameter Name Parameter Value Source Data Type Apply Type Is Modifiable -DBPARAMETER allow-suspicious-udfs engine-default boolean static false -DBPARAMETER auto_increment_increment engine-default integer dynamic true -DBPARAMETER auto_increment_offset engine-default integer dynamic true -DBPARAMETER binlog_cache_size 32768 system integer dynamic true -DBPARAMETER socket /tmp/mysql.sock system string static false -``` - -### RDS API - -To view the parameter values for a DB parameter group, use the RDS API [https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_DescribeDBParameters.html](https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_DescribeDBParameters.html) command with the following required parameter\. -+ `DBParameterGroupName` \ No newline at end of file diff --git a/doc_source/USER_WorkingWithOptionGroups.md b/doc_source/USER_WorkingWithOptionGroups.md deleted file mode 100644 index 293d5ea..0000000 --- a/doc_source/USER_WorkingWithOptionGroups.md +++ /dev/null @@ -1,561 +0,0 @@ -# Working with option groups - -Some DB engines offer additional features that make it easier to manage data and databases, and to provide additional security for your database\. Amazon RDS uses option groups to enable and configure these features\. An *option group* can specify features, called options, that are available for a particular Amazon RDS DB instance\. Options can have settings that specify how the option works\. When you associate a DB instance with an option group, the specified options and option settings are enabled for that DB instance\. - - Amazon RDS supports options for the following database engines: - - -**** - -| Database engine | Relevant documentation | -| --- | --- | -| `MariaDB` | [Options for MariaDB database engine](Appendix.MariaDB.Options.md) | -| `Microsoft SQL Server` | [Options for the Microsoft SQL Server database engine](Appendix.SQLServer.Options.md) | -| `MySQL` | [Options for MySQL DB instances](Appendix.MySQL.Options.md) | -| `Oracle` | [Adding options to Oracle DB instances](Appendix.Oracle.Options.md) | -| `PostgreSQL` | PostgreSQL does not use options and option groups\. PostgreSQL uses extensions and modules to provide additional features\. For more information, see [Supported PostgreSQL extension versions](CHAP_PostgreSQL.md#PostgreSQL.Concepts.General.FeatureSupport.Extensions)\. | - -## Option groups overview - -Amazon RDS provides an empty default option group for each new DB instance\. You can't modify or delete this default option group, but any new option group that you create derives its settings from the default option group\. To apply an option to a DB instance, you must do the following: - -1. Create a new option group, or copy or modify an existing option group\. - -1. Add one or more options to the option group\. - -1. Associate the option group with the DB instance\. - - To associate an option group with a DB instance, modify the DB instance\. For more information, see [Modifying an Amazon RDS DB instance](Overview.DBInstance.Modifying.md)\. - -Both DB instances and DB snapshots can be associated with an option group\. In some cases, you might restore from a DB snapshot or perform a point\-in\-time restore for a DB instance\. In these cases, the option group associated with the DB snapshot or DB instance is, by default, associated with the restored DB instance\. You can associate a different option group with a restored DB instance\. However, the new option group must contain any persistent or permanent options that were included in the original option group\. Persistent and permanent options are described following\. - -Options require additional memory to run on a DB instance\. Thus, you might need to launch a larger instance to use them, depending on your current use of your DB instance\. For example, Oracle Enterprise Manager Database Control uses about 300 MB of RAM\. If you enable this option for a small DB instance, you might encounter performance problems or out\-of\-memory errors\. - -### Persistent and permanent options - -Two types of options, persistent and permanent, require special consideration when you add them to an option group\. - -Persistent options can't be removed from an option group while DB instances are associated with the option group\. An example of a persistent option is the TDE option for Microsoft SQL Server transparent data encryption \(TDE\)\. You must disassociate all DB instances from the option group before a persistent option can be removed from the option group\. In some cases, you might restore or perform a point\-in\-time restore from a DB snapshot\. In these cases, if the option group associated with that DB snapshot contains a persistent option, you can only associate the restored DB instance with that option group\. - -Permanent options, such as the TDE option for Oracle Advanced Security TDE, can never be removed from an option group\. You can change the option group of a DB instance that is using the permanent option\. However, the option group associated with the DB instance must include the same permanent option\. In some cases, you might restore or perform a point\-in\-time restore from a DB snapshot\. In these cases, if the option group associated with that DB snapshot contains a permanent option, you can only associate the restored DB instance with an option group with that permanent option\. - -For Oracle DB instances, you can copy shared DB snapshots that have the options `Timezone` or `OLS` \(or both\)\. To do so, specify a target option group that includes these options when you copy the DB snapshot\. The OLS option is permanent and persistent only for Oracle DB instances running Oracle version 12\.2 or higher\. For more information about these options, see [Oracle time zone](Appendix.Oracle.Options.Timezone.md) and [Oracle Label Security](Oracle.Options.OLS.md)\. - -### VPC considerations - -The option group associated with the DB instance is linked to the DB instance's VPC\. This means that you can't use the option group assigned to a DB instance if you try to restore the instance to a different VPC\. If you restore a DB instance to a different VPC, you can do one of the following: -+ Assign the default option group to the DB instance\. -+ Assign an option group that is linked to that VPC\. -+ Create a new option group and assign it to the DB instance\. - -With persistent or permanent options, such as Oracle TDE, you must create a new option group\. This option group must include the persistent or permanent option when restoring a DB instance into a different VPC\. - -Option settings control the behavior of an option\. For example, the Oracle Advanced Security option `NATIVE_NETWORK_ENCRYPTION` has a setting that you can use to specify the encryption algorithm for network traffic to and from the DB instance\. Some options settings are optimized for use with Amazon RDS and cannot be changed\. - -### Mutually exclusive options - -Some options are mutually exclusive\. You can use one or the other, but not both at the same time\. The following options are mutually exclusive: -+ [Oracle Enterprise Manager Database Express](Appendix.Oracle.Options.OEM_DBControl.md) and [Oracle Management Agent for Enterprise Manager Cloud Control](Oracle.Options.OEMAgent.md)\. -+ [Oracle native network encryption](Appendix.Oracle.Options.NetworkEncryption.md) and [Oracle Secure Sockets Layer](Appendix.Oracle.Options.SSL.md)\. - -## Creating an option group - -You can create a new option group that derives its settings from the default option group\. You then add one or more options to the new option group\. Or, if you already have an existing option group, you can copy that option group with all of its options to a new option group\. For more information, see [Copying an option group](#USER_WorkingWithOptionGroups.Copy)\. - -After you create a new option group, it has no options\. To learn how to add options to the option group, see [Adding an option to an option group](#USER_WorkingWithOptionGroups.AddOption)\. After you have added the options you want, you can then associate the option group with a DB instance\. This way, the options become available on the DB instance\. For information about associating an option group with a DB instance, see the documentation for your engine in [Working with option groups](#USER_WorkingWithOptionGroups)\. - -### Console - - One way of creating an option group is by using the AWS Management Console\. - -**To create a new option group by using the console** - -1. Sign in to the AWS Management Console and open the Amazon RDS console at [https://console\.aws\.amazon\.com/rds/](https://console.aws.amazon.com/rds/)\. - -1. In the navigation pane, choose **Option groups**\. - -1. Choose **Create group**\. - -1. In the **Create option group** window, do the following: - - 1. For **Name**, type a name for the option group that is unique within your AWS account\. The name can contain only letters, digits, and hyphens\. - - 1. For **Description**, type a brief description of the option group\. The description is used for display purposes\. - - 1. For **Engine**, choose the DB engine that you want\. - - 1. For **Major engine version**, choose the major version of the DB engine that you want\. - -1. To continue, choose **Create**\. To cancel the operation instead, choose **Cancel**\. - -### AWS CLI - -To create an option group, use the AWS CLI [https://docs.aws.amazon.com/cli/latest/reference/rds/create-option-group.html](https://docs.aws.amazon.com/cli/latest/reference/rds/create-option-group.html) command with the following required parameters\. -+ `--option-group-name` -+ `--engine-name` -+ `--major-engine-version` -+ `--option-group-description` - -**Example** -The following example creates an option group named `testoptiongroup`, which is associated with the Oracle Enterprise Edition DB engine\. The description is enclosed in quotation marks\. -For Linux, macOS, or Unix: - -``` - -aws rds create-option-group \ - --option-group-name testoptiongroup \ - --engine-name oracle-ee \ - --major-engine-version 12.1 \ - --option-group-description "Test option group" -``` -For Windows: - -``` -aws rds create-option-group ^ - --option-group-name testoptiongroup ^ - --engine-name oracle-ee ^ - --major-engine-version 12.1 ^ - --option-group-description "Test option group" -``` - -### RDS API - -To create an option group, call the Amazon RDS API [https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_CreateOptionGroup.html](https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_CreateOptionGroup.html) operation\. Include the following parameters: -+ `OptionGroupName` -+ `EngineName` -+ `MajorEngineVersion` -+ `OptionGroupDescription` - -## Copying an option group - -You can use the AWS CLI or the Amazon RDS API copy an option group\. Copying an option group can be convenient\. An example is when you have an existing option group and want to include most of its custom parameters and values in a new option group\. You can also make a copy of an option group that you use in production and then modify the copy to test other option settings\. - -**Note** -Currently, you can't copy an option group to a different AWS Region\. - -### AWS CLI - -To copy an option group, use the AWS CLI [copy\-option\-group](https://docs.aws.amazon.com/cli/latest/reference/rds/copy-option-group.html) command\. Include the following required options: -+ `--source-option-group-identifier` -+ `--target-option-group-identifier` -+ `--target-option-group-description` - -**Example** -The following example creates an option group named `new-option-group`, which is a local copy of the option group `my-option-group`\. -For Linux, macOS, or Unix: - -``` -aws rds copy-option-group \ - --source-option-group-identifier my-option-group \ - --target-option-group-identifier new-option-group \ - --target-option-group-description "My new option group" -``` -For Windows: - -``` -aws rds copy-option-group ^ - --source-option-group-identifier my-option-group ^ - --target-option-group-identifier new-option-group ^ - --target-option-group-description "My new option group" -``` - -### RDS API - -To copy an option group, call the Amazon RDS API [CopyOptionGroup](https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_CopyOptionGroup.html) operation\. Include the following required parameters\. -+ `SourceOptionGroupIdentifier` -+ `TargetOptionGroupIdentifier` -+ `TargetOptionGroupDescription` - -## Adding an option to an option group - -You can add an option to an existing option group\. After you have added the options you want, you can then associate the option group with a DB instance so that the options become available on the DB instance\. For information about associating an option group with a DB instance, see the documentation for your specific DB engine listed at [Working with option groups](#USER_WorkingWithOptionGroups)\. - -Option group changes must be applied immediately in two cases: -+ When you add an option that adds or updates a port value, such as the `OEM` option\. -+ When you add or remove an option group with an option that includes a port value\. - -In these cases, choose the **Apply Immediately** option in the console\. Or you can include the `--apply-immediately` option when using the AWS CLI or set the `ApplyImmediately` parameter to `true` when using the Amazon RDS API\. Options that don't include port values can be applied immediately, or can be applied during the next maintenance window for the DB instance\. - -**Note** -If you specify a security group as a value for an option in an option group, manage the security group by modifying the option group\. You can't change or remove this security group by modifying a DB instance\. Also, the security group doesn't appear in the DB instance details in the AWS Management Console or in the output for the AWS CLI command `describe-db-instances`\. - -### Console - -You can use the AWS Management Console to add an option to an option group\. - -**To add an option to an option group by using the console** - -1. Sign in to the AWS Management Console and open the Amazon RDS console at [https://console\.aws\.amazon\.com/rds/](https://console.aws.amazon.com/rds/)\. - -1. In the navigation pane, choose **Option groups**\. - -1. Choose the option group that you want to modify, and then choose **Add option**\. -![\[Console option group\]](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/images/optiongroup-addoption1.png) - -1. In the **Add option** window, do the following: - - 1. Choose the option that you want to add\. You might need to provide additional values, depending on the option that you select\. For example, when you choose the `OEM` option, you must also type a port value and specify a security group\. - - 1. To enable the option on all associated DB instances as soon as you add it, for **Apply Immediately**, choose **Yes**\. If you choose **No** \(the default\), the option is enabled for each associated DB instance during its next maintenance window\. -![\[Console option group\]](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/images/optiongroup-addoption2.png) - -1. When the settings are as you want them, choose **Add option**\. - -### AWS CLI - -To add an option to an option group, run the AWS CLI [add\-option\-to\-option\-group](https://docs.aws.amazon.com/cli/latest/reference/rds/add-option-to-option-group.html) command with the option that you want to add\. To enable the new option immediately on all associated DB instances, include the `--apply-immediately` parameter\. By default, the option is enabled for each associated DB instance during its next maintenance window\. Include the following required parameter: -+ `--option-group-name` - -**Example** -The following example adds the Oracle Enterprise Manager Database Control \(OEM\) option to an option group named `testoptiongroup` and immediately enables it\. Even if you use the default security group, you must specify that security group\. -For Linux, macOS, or Unix: - -``` -aws rds add-option-to-option-group \ - --option-group-name testoptiongroup \ - --options OptionName=OEM,Port=5500,DBSecurityGroupMemberships=default \ - --apply-immediately -``` -For Windows: - -``` -aws rds add-option-to-option-group ^ - --option-group-name testoptiongroup ^ - --options OptionName=OEM,Port=5500,DBSecurityGroupMemberships=default ^ - --apply-immediately -``` -Command output is similar to the following: - -``` -OPTIONGROUP False oracle-ee 12.1 arn:aws:rds:us-east-1:1234567890:og:testoptiongroup Test Option Group testoptiongroup default -OPTIONS Oracle 12c EM Express OEM False False 5500 -DBSECURITYGROUPMEMBERSHIPS default authorized -``` - -**Example** -The following example adds the Oracle OEM option to an option group\. It also specifies a custom port and a pair of Amazon EC2 VPC security groups to use for that port\. -For Linux, macOS, or Unix: - -``` -aws rds add-option-to-option-group \ - --option-group-name testoptiongroup \ - --options OptionName=OEM,Port=5500,VpcSecurityGroupMemberships="sg-test1,sg-test2" \ - --apply-immediately -``` -For Windows: - -``` -aws rds add-option-to-option-group ^ - --option-group-name testoptiongroup ^ - --options OptionName=OEM,Port=5500,VpcSecurityGroupMemberships="sg-test1,sg-test2" ^ - --apply-immediately -``` -Command output is similar to the following: - -``` -OPTIONGROUP False oracle-ee 12.1 arn:aws:rds:us-east-1:1234567890:og:testoptiongroup Test Option Group testoptiongroup vpc-test -OPTIONS Oracle 12c EM Express OEM False False 5500 -VPCSECURITYGROUPMEMBERSHIPS active sg-test1 -VPCSECURITYGROUPMEMBERSHIPS active sg-test2 -``` - -**Example** -The following example adds the Oracle option NATIVE\_NETWORK\_ENCRYPTION to an option group and specifies the option settings\. If no option settings are specified, default values are used\. -For Linux, macOS, or Unix: - -``` -aws rds add-option-to-option-group \ - --option-group-name testoptiongroup \ - --options '[{"OptionSettings":[{"Name":"SQLNET.ENCRYPTION_SERVER","Value":"REQUIRED"},{"Name":"SQLNET.ENCRYPTION_TYPES_SERVER","Value":"AES256,AES192,DES"}],"OptionName":"NATIVE_NETWORK_ENCRYPTION"}]' \ - --apply-immediately -``` -For Windows: - -``` - -aws rds add-option-to-option-group ^ ---option-group-name testoptiongroup ^ ---options "OptionSettings"=[{"Name"="SQLNET.ENCRYPTION_SERVER","Value"="REQUIRED"},{"Name"="SQLNET.ENCRYPTION_TYPES_SERVER","Value"="AES256\,AES192\,DES"}],"OptionName"="NATIVE_NETWORK_ENCRYPTION" ^ ---apply-immediately -``` -Command output is similar to the following: - -``` -OPTIONGROUP False oracle-ee 12.1 arn:aws:rds:us-east-1:1234567890:og:testoptiongroup Test Option Group testoptiongroup -OPTIONS Oracle Advanced Security - Native Network Encryption NATIVE_NETWORK_ENCRYPTION False False -OPTIONSETTINGS RC4_256,AES256,AES192,3DES168,RC4_128,AES128,3DES112,RC4_56,DES,RC4_40,DES40 - STATIC STRING RC4_256,AES256,AES192,3DES168,RC4_128,AES128,3DES112,RC4_56,DES,RC4_40,DES40 Specifies list of encryption algorithms in order of intended use - True True SQLNET.ENCRYPTION_TYPES_SERVER AES256,AES192,DES -OPTIONSETTINGS ACCEPTED,REJECTED,REQUESTED,REQUIRED STATIC STRING REQUESTED Specifies the desired encryption behavior False True SQLNET.ENCRYPTION_SERVER REQUIRED -OPTIONSETTINGS SHA1,MD5 STATIC STRING SHA1,MD5 Specifies list of checksumming algorithms in order of intended use True True SQLNET.CRYPTO_CHECKSUM_TYPES_SERVER SHA1,MD5 -``` - -### RDS API - -To add an option to an option group using the Amazon RDS API, call the [ModifyOptionGroup](https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_ModifyOptionGroup.html) operation with the option that you want to add\. To enable the new option immediately on all associated DB instances, include the `ApplyImmediately` parameter and set it to `true`\. By default, the option is enabled for each associated DB instance during its next maintenance window\. Include the following required parameter: -+ `OptionGroupName` - -## Listing the options and option settings for an option group - - You can list all the options and option settings for an option group\. - -### Console - -You can use the AWS Management Console to list all of the options and option settings for an option group\. - -**To list the options and option settings for an option group** - -1. Sign in to the AWS Management Console and open the Amazon RDS console at [https://console\.aws\.amazon\.com/rds/](https://console.aws.amazon.com/rds/)\. - -1. In the navigation pane, choose **Option groups**\. - -1. Choose the name of the option group to display its details\. The options and option settings in the option group are listed\. - -### AWS CLI - -To list the options and option settings for an option group, use the AWS CLI [https://docs.aws.amazon.com/cli/latest/reference/rds/describe-option-groups.html](https://docs.aws.amazon.com/cli/latest/reference/rds/describe-option-groups.html) command\. Specify the name of the option group whose options and settings you want to view\. If you don't specify an option group name, all option groups are described\. - -**Example** -The following example lists the options and option settings for all option groups\. - -``` -aws rds describe-option-groups -``` - -**Example** -The following example lists the options and option settings for an option group named `testoptiongroup`\. - -``` -aws rds describe-option-groups --option-group-name testoptiongroup -``` - -### RDS API - -To list the options and option settings for an option group, use the Amazon RDS API [https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_DescribeOptionGroups.html](https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_DescribeOptionGroups.html) operation\. Specify the name of the option group whose options and settings you want to view\. If you don't specify an option group name, all option groups are described\. - -## Modifying an option setting - -After you have added an option that has modifiable option settings, you can modify the settings at any time\. If you change options or option settings in an option group, those changes are applied to all DB instances that are associated with that option group\. For more information on what settings are available for the various options, see the documentation for your engine in [Working with option groups](#USER_WorkingWithOptionGroups)\. - -Option group changes must be applied immediately in two cases: -+ When you add an option that adds or updates a port value, such as the `OEM` option\. -+ When you add or remove an option group with an option that includes a port value\. - -In these cases, choose the **Apply Immediately** option in the console\. Or you can include the `--apply-immediately` option when using the AWS CLI or set the `ApplyImmediately` parameter to `true` when using the RDS API\. Options that don't include port values can be applied immediately, or can be applied during the next maintenance window for the DB instance\. - -**Note** -If you specify a security group as a value for an option in an option group, you manage the security group by modifying the option group\. You can't change or remove this security group by modifying a DB instance\. Also, the security group doesn't appear in the DB instance details in the AWS Management Console or in the output for the AWS CLI command `describe-db-instances`\. - -### Console - -You can use the AWS Management Console to modify an option setting\. - -**To modify an option setting by using the console** - -1. Sign in to the AWS Management Console and open the Amazon RDS console at [https://console\.aws\.amazon\.com/rds/](https://console.aws.amazon.com/rds/)\. - -1. In the navigation pane, choose **Option groups**\. - -1. Select the option group whose option that you want to modify, and then choose **Modify option**\. - -1. In the **Modify option** window, from **Installed Options**, choose the option whose setting you want to modify\. Make the changes that you want\. - -1. To enable the option as soon as you add it, for **Apply Immediately**, choose **Yes**\. If you choose **No** \(the default\), the option is enabled for each associated DB instance during its next maintenance window\. - -1. When the settings are as you want them, choose **Modify Option**\. - -### AWS CLI - -To modify an option setting, use the AWS CLI [https://docs.aws.amazon.com/cli/latest/reference/rds/add-option-to-option-group.html](https://docs.aws.amazon.com/cli/latest/reference/rds/add-option-to-option-group.html) command with the option group and option that you want to modify\. By default, the option is enabled for each associated DB instance during its next maintenance window\. To apply the change immediately to all associated DB instances, include the `--apply-immediately` parameter\. To modify an option setting, use the `--settings` argument\. - -**Example** -The following example modifies the port that the Oracle Enterprise Manager Database Control \(OEM\) uses in an option group named `testoptiongroup` and immediately applies the change\. -For Linux, macOS, or Unix: - -``` -aws rds add-option-to-option-group \ - --option-group-name testoptiongroup \ - --options OptionName=OEM,Port=5432,DBSecurityGroupMemberships=default \ - --apply-immediately -``` -For Windows: - -``` -aws rds add-option-to-option-group ^ - --option-group-name testoptiongroup ^ - --options OptionName=OEM,Port=5432,DBSecurityGroupMemberships=default ^ - --apply-immediately -``` -Command output is similar to the following: - -``` -OPTIONGROUP False oracle-ee 12.1 arn:aws:rds:us-east-1:1234567890:og:testoptiongroup Test Option Group testoptiongroup -OPTIONS Oracle 12c EM Express OEM False False 5432 -DBSECURITYGROUPMEMBERSHIPS default authorized -``` - -**Example** -The following example modifies the Oracle option NATIVE\_NETWORK\_ENCRYPTION and changes the option settings\. -For Linux, macOS, or Unix: - -``` -aws rds add-option-to-option-group \ ---option-group-name testoptiongroup \ ---options '[{"OptionSettings":[{"Name":"SQLNET.ENCRYPTION_SERVER","Value":"REQUIRED"},{"Name":"SQLNET.ENCRYPTION_TYPES_SERVER","Value":"AES256,AES192,DES,RC4_256"}],"OptionName":"NATIVE_NETWORK_ENCRYPTION"}]' \ ---apply-immediately -``` -For Windows: - -``` -aws rds add-option-to-option-group ^ ---option-group-name testoptiongroup ^ ---options "OptionSettings"=[{"Name"="SQLNET.ENCRYPTION_SERVER","Value"="REQUIRED"},{"Name"="SQLNET.ENCRYPTION_TYPES_SERVER","Value"="AES256\,AES192\,DES\,RC4_256"}],"OptionName"="NATIVE_NETWORK_ENCRYPTION" ^ ---apply-immediately -``` -Command output is similar to the following: - -``` -OPTIONGROUP False oracle-ee 12.1 arn:aws:rds:us-east-1:1234567890:og:testoptiongroup Test Option Group testoptiongroup -OPTIONS Oracle Advanced Security - Native Network Encryption NATIVE_NETWORK_ENCRYPTION False False -OPTIONSETTINGS RC4_256,AES256,AES192,3DES168,RC4_128,AES128,3DES112,RC4_56,DES,RC4_40,DES40 STATIC STRING - RC4_256,AES256,AES192,3DES168,RC4_128,AES128,3DES112,RC4_56,DES,RC4_40,DES40 Specifies list of encryption algorithms in order of intended use - True True SQLNET.ENCRYPTION_TYPES_SERVER AES256,AES192,DES,RC4_256 -OPTIONSETTINGS ACCEPTED,REJECTED,REQUESTED,REQUIRED STATIC STRING REQUESTED Specifies the desired encryption behavior False True SQLNET.ENCRYPTION_SERVER REQUIRED -OPTIONSETTINGS SHA1,MD5 STATIC STRING SHA1,MD5 Specifies list of checksumming algorithms in order of intended use True True SQLNET.CRYPTO_CHECKSUM_TYPES_SERVER SHA1,MD5 -OPTIONSETTINGS ACCEPTED,REJECTED,REQUESTED,REQUIRED STATIC STRING REQUESTED Specifies the desired data integrity behavior False True SQLNET.CRYPTO_CHECKSUM_SERVER REQUESTED -``` - -### RDS API - -To modify an option setting, use the Amazon RDS API [https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_ModifyOptionGroup.html](https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_ModifyOptionGroup.html) command with the option group and option that you want to modify\. By default, the option is enabled for each associated DB instance during its next maintenance window\. To apply the change immediately to all associated DB instances, include the `ApplyImmediately` parameter and set it to `true`\. - -## Removing an option from an option group - -Some options can be removed from an option group, and some cannot\. A persistent option cannot be removed from an option group until all DB instances associated with that option group are disassociated\. A permanent option can never be removed from an option group\. For more information about what options are removable, see the documentation for your specific engine listed at [Working with option groups](#USER_WorkingWithOptionGroups)\. - -If you remove all options from an option group, Amazon RDS doesn't delete the option group\. DB instances that are associated with the empty option group continue to be associated with it; they just won't have any active options\. Alternatively, to remove all options from a DB instance, you can associate the DB instance with the default \(empty\) option group\. - -### Console - -You can use the AWS Management Console to remove an option from an option group\. - -**To remove an option from an option group by using the console** - -1. Sign in to the AWS Management Console and open the Amazon RDS console at [https://console\.aws\.amazon\.com/rds/](https://console.aws.amazon.com/rds/)\. - -1. In the navigation pane, choose **Option groups**\. - -1. Select the option group whose option you want to remove, and then choose **Delete option**\. - -1. In the **Delete option** window, do the following: - + Select the check box for the option that you want to delete\. - + For the deletion to take effect as soon as you make it, for **Apply immediately**, choose **Yes**\. If you choose **No** \(the default\), the option is deleted for each associated DB instance during its next maintenance window\. -![\[Delete option group\]](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/images/optiongroup-removeoption2.png) - -1. When the settings are as you want them, choose **Yes, Delete**\. - -### AWS CLI - -To remove an option from an option group, use the AWS CLI [https://docs.aws.amazon.com/cli/latest/reference/rds/remove-option-from-option-group.html](https://docs.aws.amazon.com/cli/latest/reference/rds/remove-option-from-option-group.html) command with the option that you want to delete\. By default, the option is removed from each associated DB instance during its next maintenance window\. To apply the change immediately, include the `--apply-immediately` parameter\. - -**Example** -The following example removes the Oracle Enterprise Manager Database Control \(OEM\) option from an option group named `testoptiongroup` and immediately applies the change\. -For Linux, macOS, or Unix: - -``` - -aws rds remove-option-from-option-group \ - --option-group-name testoptiongroup \ - --options OEM \ - --apply-immediately -``` -For Windows: - -``` -aws rds remove-option-from-option-group ^ - --option-group-name testoptiongroup ^ - --options OEM ^ - --apply-immediately -``` -Command output is similar to the following: - -``` -OPTIONGROUP testoptiongroup oracle-ee 12.1 Test option group -``` - -### RDS API - -To remove an option from an option group, use the Amazon RDS API [https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_ModifyOptionGroup.html](https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_ModifyOptionGroup.html) action\. By default, the option is removed from each associated DB instance during its next maintenance window\. To apply the change immediately, include the `ApplyImmediately` parameter and set it to `true`\. - -Include the following parameters: -+ `OptionGroupName` -+ `OptionsToRemove.OptionName` - -## Deleting an option group - -You can delete an option group that is not associated with any Amazon RDS resource\. An option group can be associated with a DB instance, a manual DB snapshot, or an automated DB snapshot\. - -You can't delete a default option group\. If you try to delete an option group that is associated with an RDS resource, an error like the following is returned\. - -``` -An error occurred (InvalidOptionGroupStateFault) when calling the DeleteOptionGroup operation: The option group 'optionGroupName' cannot be deleted because it is in use. -``` - -**To find the Amazon RDS resources associated with an option group** - -1. Sign in to the AWS Management Console and open the Amazon RDS console at [https://console\.aws\.amazon\.com/rds/](https://console.aws.amazon.com/rds/)\. - -1. In the navigation pane, choose **Option groups**\. - -1. Choose the name of the option group to show its details\. - -1. Check the **Associated Instances and Snapshots** section for the associated Amazon RDS resources\. - -If a DB instance is associated with the option group, modify the DB instance to use a different option group\. For more information, see [Modifying an Amazon RDS DB instance](Overview.DBInstance.Modifying.md)\. - -If a manual DB snapshot is associated with the option group, modify the DB snapshot to use a different option group\. You can do so using the AWS CLI [https://docs.aws.amazon.com/cli/latest/reference/rds/modify-db-snapshot.html](https://docs.aws.amazon.com/cli/latest/reference/rds/modify-db-snapshot.html) command\. - -**Note** -You can't modify the option group of an automated DB snapshot\. - -### Console - - One way of deleting an option group is by using the AWS Management Console\. - -**To delete an option group by using the console** - -1. Sign in to the AWS Management Console and open the Amazon RDS console at [https://console\.aws\.amazon\.com/rds/](https://console.aws.amazon.com/rds/)\. - -1. In the navigation pane, choose **Option groups**\. - -1. Choose the option group\. - -1. Choose **Delete group**\. - -1. On the confirmation page, choose **Delete** to finish deleting the option group, or choose **Cancel** to cancel the deletion\. - -### AWS CLI - -To delete an option group, use the AWS CLI [https://docs.aws.amazon.com/cli/latest/reference/rds/delete-option-group.html](https://docs.aws.amazon.com/cli/latest/reference/rds/delete-option-group.html) command with the following required parameter\. -+ `--option-group-name` - -**Example** -The following example deletes an option group named `testoptiongroup`\. -For Linux, macOS, or Unix: - -``` - -aws rds delete-option-group \ - --option-group-name testoptiongroup -``` -For Windows: - -``` -aws rds delete-option-group ^ - --option-group-name testoptiongroup -``` - -### RDS API - -To delete an option group, call the Amazon RDS API [https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_DeleteOptionGroup.html](https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_DeleteOptionGroup.html) operation\. Include the following parameter: -+ `OptionGroupName` \ No newline at end of file diff --git a/doc_source/USER_WorkingWithParamGroups.Comparing.md b/doc_source/USER_WorkingWithParamGroups.Comparing.md deleted file mode 100644 index 2a285bf..0000000 --- a/doc_source/USER_WorkingWithParamGroups.Comparing.md +++ /dev/null @@ -1,16 +0,0 @@ -# Comparing parameter groups - -You can use the AWS Management Console to view the differences between two parameter groups\. - -**To compare two parameter groups** - -1. Sign in to the AWS Management Console and open the Amazon RDS console at [https://console\.aws\.amazon\.com/rds/](https://console.aws.amazon.com/rds/)\. - -1. In the navigation pane, choose **Parameter groups**\. - -1. In the list, choose the two parameter groups that you want to compare\. - -1. For **Parameter group actions**, choose **Compare**\. -**Note** -The specified parameter groups must both be DB parameter groups, or they both must be DB cluster parameter groups\. This is true even when the DB engine and version are the same\. For example, you can't compare an Aurora MySQL 8\.0 DB parameter group and an Aurora MySQL 8\.0 DB cluster parameter group\. -You can compare Aurora MySQL and RDS for MySQL DB parameter groups, even for different versions, but you can't compare Aurora PostgreSQL and RDS for PostgreSQL DB parameter groups\. \ No newline at end of file diff --git a/doc_source/USER_WorkingWithParamGroups.md b/doc_source/USER_WorkingWithParamGroups.md deleted file mode 100644 index 24c4231..0000000 --- a/doc_source/USER_WorkingWithParamGroups.md +++ /dev/null @@ -1,15 +0,0 @@ -# Working with parameter groups - -*Database parameters* specify how the database is configured\. For example, database parameters can specify the amount of resources, such as memory, to allocate to a database\. - -You manage your database configuration by associating your DB instances and Multi\-AZ DB clusters with parameter groups\. Amazon RDS defines parameter groups with default settings\. You can also define your own parameter groups with customized settings\. - -**Note** -Some DB engines offer additional features that you can add to your database as options in an option group\. For information about option groups, see [Working with option groups](USER_WorkingWithOptionGroups.md)\. - -**Topics** -+ [Overview of parameter groups](parameter-groups-overview.md) -+ [Working with DB parameter groups](USER_WorkingWithDBInstanceParamGroups.md) -+ [Working with DB cluster parameter groups for Multi\-AZ DB clusters](USER_WorkingWithDBClusterParamGroups.md) -+ [Comparing parameter groups](USER_WorkingWithParamGroups.Comparing.md) -+ [Specifying DB parameters](USER_ParamValuesRef.md) \ No newline at end of file diff --git a/doc_source/USER_WorkingWithReservedDBInstances.md b/doc_source/USER_WorkingWithReservedDBInstances.md deleted file mode 100644 index 26ead0f..0000000 --- a/doc_source/USER_WorkingWithReservedDBInstances.md +++ /dev/null @@ -1,312 +0,0 @@ -# Reserved DB instances for Amazon RDS - -Using reserved DB instances, you can reserve a DB instance for a one\- or three\-year term\. Reserved DB instances provide you with a significant discount compared to on\-demand DB instance pricing\. Reserved DB instances are not physical instances, but rather a billing discount applied to the use of certain on\-demand DB instances in your account\. Discounts for reserved DB instances are tied to instance type and AWS Region\. - -The general process for working with reserved DB instances is: First get information about available reserved DB instance offerings, then purchase a reserved DB instance offering, and finally get information about your existing reserved DB instances\. - -## Overview of reserved DB instances - -When you purchase a reserved DB instance in Amazon RDS, you purchase a commitment to getting a discounted rate, on a specific DB instance type, for the duration of the reserved DB instance\. To use an Amazon RDS reserved DB instance, you create a new DB instance just like you do for an on\-demand instance\. - -The new DB instance that you create must have the same specifications as the reserved DB instance for the following: -+ AWS Region -+ DB engine -+ DB instance type -+ Edition \(for RDS for Oracle and RDS for SQL Server\) -+ License type \(license\-included or bring\-your\-own\-license\) - -If the specifications of the new DB instance match an existing reserved DB instance for your account, you are billed at the discounted rate offered for the reserved DB instance\. Otherwise, the DB instance is billed at an on\-demand rate\. - -You can modify a DB instance that you're using as a reserved DB instance\. If the modification is within the specifications of the reserved DB instance, part or all of the discount still applies to the modified DB instance\. If the modification is outside the specifications, such as changing the instance class, the discount no longer applies\. For more information, see [Size\-flexible reserved DB instances](#USER_WorkingWithReservedDBInstances.SizeFlexible)\. - -**Topics** -+ [Offering types](#USER_WorkingWithReservedDBInstances.OfferingTypes) -+ [Size\-flexible reserved DB instances](#USER_WorkingWithReservedDBInstances.SizeFlexible) -+ [Reserved DB instance billing example](#USER_WorkingWithReservedDBInstances.BillingExample) -+ [Reserved DB instances for a Multi\-AZ DB cluster](#USER_WorkingWithReservedDBInstances.MultiAZDBClusters) -+ [Deleting a reserved DB instance](#USER_WorkingWithReservedDBInstances.Cancelling) - -For more information about reserved DB instances, including pricing, see [Amazon RDS reserved instances](http://aws.amazon.com/rds/reserved-instances/#2)\. - -### Offering types - -Reserved DB instances are available in three varieties—No Upfront, Partial Upfront, and All Upfront—that let you optimize your Amazon RDS costs based on your expected usage\. - -**No Upfront** -This option provides access to a reserved DB instance without requiring an upfront payment\. Your No Upfront reserved DB instance bills a discounted hourly rate for every hour within the term, regardless of usage, and no upfront payment is required\. This option is only available as a one\-year reservation\. - -**Partial Upfront** -This option requires a part of the reserved DB instance to be paid upfront\. The remaining hours in the term are billed at a discounted hourly rate, regardless of usage\. This option is the replacement for the previous Heavy Utilization option\. - -**All Upfront** -Full payment is made at the start of the term, with no other costs incurred for the remainder of the term regardless of the number of hours used\. - -If you are using consolidated billing, all the accounts in the organization are treated as one account\. This means that all accounts in the organization can receive the hourly cost benefit of reserved DB instances that are purchased by any other account\. For more information about consolidated billing, see [Amazon RDS reserved DB instances](https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/consolidatedbilling-other.html#consolidatedbilling-rds) in the *AWS Billing and Cost Management User Guide*\. - -### Size\-flexible reserved DB instances - -When you purchase a reserved DB instance, one thing that you specify is the instance class, for example db\.r5\.large\. For more information about DB instance classes, see [DB instance classes](Concepts.DBInstanceClass.md)\. - -If you have a DB instance, and you need to scale it to larger capacity, your reserved DB instance is automatically applied to your scaled DB instance\. That is, your reserved DB instances are automatically applied across all DB instance class sizes\. Size\-flexible reserved DB instances are available for DB instances with the same AWS Region and database engine\. Size\-flexible reserved DB instances can only scale in their instance class type\. For example, a reserved DB instance for a db\.r5\.large can apply to a db\.r5\.xlarge, but not to a db\.r6g\.large, because db\.r5 and db\.r6g are different instance class types\. - -Reserved DB instance benefits also apply for both Multi\-AZ and Single\-AZ configurations\. Flexibility means that you can move freely between configurations within the same DB instance class type\. For example, you can move from a Single\-AZ deployment running on one large DB instance \(four normalized units per hour\) to a Multi\-AZ deployment running on two small DB instances \(2\*2 = 4 normalized units per hour\)\. - -Size\-flexible reserved DB instances are available for the following Amazon RDS database engines: -+ MariaDB -+ MySQL -+ Oracle, Bring Your Own License -+ PostgreSQL - -For details about using size\-flexible reserved instances with Aurora, see [Reserved DB instances for Aurora](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_WorkingWithReservedDBInstances.html)\. - -You can compare usage for different reserved DB instance sizes by using normalized units per hour\. For example, one unit of usage on two db\.r3\.large DB instances is equivalent to eight normalized units per hour of usage on one db\.r3\.small\. The following table shows the number of normalized units per hour for each DB instance size\. - - -| Instance size | Single\-AZ normalized units per hour \(deployment with one DB instance\) | Multi\-AZ DB instance normalized units per hour \(deployment with one DB instance and one standby\) | Multi\-AZ DB cluster normalized units per hour \(deployment with one DB instance and two standbys\) | -| --- | --- | --- | --- | -| micro | 0\.5 | 1 | 1\.5 | -| small | 1 | 2 | 3 | -| medium | 2 | 4 | 6 | -| large | 4 | 8 | 12 | -| xlarge | 8 | 16 | 24 | -| 2xlarge | 16 | 32 | 48 | -| 4xlarge | 32 | 64 | 96 | -| 6xlarge | 48 | 96 | 144 | -| 8xlarge | 64 | 128 | 192 | -| 10xlarge | 80 | 160 | 240 | -| 12xlarge | 96 | 192 | 288 | -| 16xlarge | 128 | 256 | 384 | -| 24xlarge | 192 | 384 | 576 | -| 32xlarge | 256 | 512 | 768 | - -For example, suppose that you purchase a `db.t2.medium` reserved DB instance, and you have two running `db.t2.small` DB instances in your account in the same AWS Region\. In this case, the billing benefit is applied in full to both instances\. - -![\[Applying a reserved DB instance in full to smaller DB instances\]](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/images/ri-db-instance-flex-full.png) - -Alternatively, if you have one `db.t2.large` instance running in your account in the same AWS Region, the billing benefit is applied to 50 percent of the usage of the DB instance\. - -![\[Applying a reserved DB instance in part to a larger DB instance\]](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/images/ri-db-instance-flex-partial.png) - -### Reserved DB instance billing example - -The price for a reserved DB instance doesn't provide a discount for the costs associated with storage, backups, and I/O\. It provides a discount only on the hourly, on\-demand instance usage\. The following example illustrates the total cost per month for a reserved DB instance: -+ An RDS for MySQL reserved Single\-AZ db\.r5\.large DB instance class in US East \(N\. Virginia\) with the No Upfront option at a cost of $0\.12 for the instance, or $90 per month -+ 400 GiB of General Purpose SSD \(gp2\) storage at a cost of 0\.115 per GiB per month, or $45\.60 per month -+ 600 GiB of backup storage at $0\.095, or $19 per month \(400 GiB free\) - -Add all of these charges \($90 \+ $45\.60 \+ $19\) with the reserved DB instance, and the total cost per month is $154\.60\. - -If you choose to use an on\-demand DB instance instead of a reserved DB instance, an RDS for MySQL Single\-AZ db\.r5\.large DB instance class in US East \(N\. Virginia\) costs $0\.1386 per hour, or $101\.18 per month\. So, for an on\-demand DB instance, add all of these options \($101\.18 \+ $45\.60 \+ $19\), and the total cost per month is $165\.78\. You save a little over $11 per month by using the reserved DB instance\. - -**Note** -The prices in this example are sample prices and might not match actual prices\. For Amazon RDS pricing information, see [Amazon RDS pricing](https://aws.amazon.com/rds/pricing)\. - -### Reserved DB instances for a Multi\-AZ DB cluster - -To purchase the equivalent reserved DB instances for a Multi\-AZ DB cluster, you can do one of the following: -+ Reserve three Single\-AZ DB instances that are the same size as the instances in the cluster\. -+ Reserve one Multi\-AZ DB instance and one Single\-AZ DB instance that are the same size as the DB instances in the cluster\. - -For example, suppose that you have one cluster consisting of three db\.m6gd\.large DB instances\. In this case, you can either purchase three db\.m6gd\.large Single\-AZ reserved DB instances, or one db\.m6gd\.large Multi\-AZ reserved DB instance and one db\.m6gd\.large Single\-AZ reserved DB instance\. Either of these options reserves the maximum reserved instance discount for the Multi\-AZ DB cluster\. - -Alternately, you can use size\-flexible DB instances and purchase a larger DB instance to cover smaller DB instances in one or more clusters\. For example, if you have two clusters with six total db\.m6gd\.large DB instances, you can purchase three db\.m6gd\.xl Single\-AZ reserved DB instances\. Doing so reserves all six DB instances in the two clusters\. For more information, see [Size\-flexible reserved DB instances](#USER_WorkingWithReservedDBInstances.SizeFlexible)\. - -You might reserve DB instances that are the same size as the DB instances in the cluster, but reserve fewer DB instances than the total number of DB instances in the cluster\. However, if you do so, the cluster is only partially reserved\. For example, suppose that you have one cluster with three db\.m6gd\.large DB instances, and you purchase one db\.m6gd\.large Multi\-AZ reserved DB instance\. In this case, the cluster is only partially reserved, because only two of the three instances in the cluster are covered by reserved DB instances\. The remaining DB instance is charged at the on\-demand db\.m6gd\.large hourly rate\. - -For more information about Multi\-AZ DB clusters, see [Multi\-AZ DB cluster deployments](multi-az-db-clusters-concepts.md)\. - -### Deleting a reserved DB instance - -The terms for a reserved DB instance involve a one\-year or three\-year commitment\. You can't cancel a reserved DB instance\. However, you can delete a DB instance that is covered by a reserved DB instance discount\. The process for deleting a DB instance that is covered by a reserved DB instance discount is the same as for any other DB instance\. - -You're billed for the upfront costs regardless of whether you use the resources\. - -If you delete a DB instance that is covered by a reserved DB instance discount, you can launch another DB instance with compatible specifications\. In this case, you continue to get the discounted rate during the reservation term \(one or three years\)\. - -## Working with reserved DB instances - -You can use the AWS Management Console, the AWS CLI, and the RDS API to work with reserved DB instances\. - -### Console - -You can use the AWS Management Console to work with reserved DB instances as shown in the following procedures\. - -**To get pricing and information about available reserved DB instance offerings** - -1. Sign in to the AWS Management Console and open the Amazon RDS console at [https://console\.aws\.amazon\.com/rds/](https://console.aws.amazon.com/rds/)\. - -1. In the navigation pane, choose **Reserved instances**\. - -1. Choose **Purchase Reserved DB Instance**\. - -1. For **Product description**, choose the DB engine and licensing type\. - -1. For **DB instance class**, choose the DB instance class\. - -1. For **Deployment Option**, choose whether you want a Single\-AZ or Multi\-AZ DB instance deployment\. -**Note** -To purchase the equivalent reserved DB instances for a Multi\-AZ DB cluster deployment, either purchase three Single\-AZ reserved DB instances, or one Multi\-AZ and one Single\-AZ reserved DB instance\. For more information, see [Reserved DB instances for a Multi\-AZ DB cluster](#USER_WorkingWithReservedDBInstances.MultiAZDBClusters)\. - -1. For **Term**, choose the length of time to reserve the the DB instance\. - -1. For **Offering type**, choose the offering type\. - - After you select the offering type, you can see the pricing information\. -**Important** -Choose **Cancel** to avoid purchasing the reserved DB instance and incurring any charges\. - -After you have information about the available reserved DB instance offerings, you can use the information to purchase an offering as shown in the following procedure\. - -**To purchase a reserved DB instance** - -1. Sign in to the AWS Management Console and open the Amazon RDS console at [https://console\.aws\.amazon\.com/rds/](https://console.aws.amazon.com/rds/)\. - -1. In the navigation pane, choose **Reserved instances**\. - -1. Choose **Purchase reserved DB instance**\. - -1. For **Product description**, choose the DB engine and licensing type\. - -1. For **DB instance class**, choose the DB instance class\. - -1. For **Multi\-AZ deployment**, choose whether you want a Single\-AZ or Multi\-AZ DB instance deployment\. -**Note** -To purchase the equivalent reserved DB instances for a Multi\-AZ DB cluster deployment, either purchase three Single\-AZ reserved DB instances, or one Multi\-AZ and one Single\-AZ reserved DB instance\. For more information, see [Reserved DB instances for a Multi\-AZ DB cluster](#USER_WorkingWithReservedDBInstances.MultiAZDBClusters)\. - -1. For **Term**, choose the length of time you want the DB instance reserved\. - -1. For **Offering type**, choose the offering type\. - - After you choose the offering type, you can see the pricing information\. -![\[Purchase reserved DB instance console\]](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/images/reservedinstance.png) - -1. \(Optional\) You can assign your own identifier to the reserved DB instances that you purchase to help you track them\. For **Reserved Id**, type an identifier for your reserved DB instance\. - -1. Choose **Submit**\. - - Your reserved DB instance is purchased, then displayed in the **Reserved instances** list\. - -After you have purchased reserved DB instances, you can get information about your reserved DB instances as shown in the following procedure\. - -**To get information about reserved DB instances for your AWS account** - -1. Sign in to the AWS Management Console and open the Amazon RDS console at [https://console\.aws\.amazon\.com/rds/](https://console.aws.amazon.com/rds/)\. - -1. In the **Navigation** pane, choose **Reserved instances**\. - - The reserved DB instances for your account appear\. To see detailed information about a particular reserved DB instance, choose that instance in the list\. You can then see detailed information about that instance in the detail pane at the bottom of the console\. - -### AWS CLI - -You can use the AWS CLI to work with reserved DB instances as shown in the following examples\. - -**Example of getting available reserved DB instance offerings** -To get information about available reserved DB instance offerings, call the AWS CLI command [https://docs.aws.amazon.com/cli/latest/reference/rds/describe-reserved-db-instances-offerings.html](https://docs.aws.amazon.com/cli/latest/reference/rds/describe-reserved-db-instances-offerings.html)\. - -``` -aws rds describe-reserved-db-instances-offerings -``` -This call returns output similar to the following: - -``` - 1. OFFERING OfferingId Class Multi-AZ Duration Fixed Price Usage Price Description Offering Type - 2. OFFERING 438012d3-4052-4cc7-b2e3-8d3372e0e706 db.r3.large y 1y 1820.00 USD 0.368 USD mysql Partial Upfront - 3. OFFERING 649fd0c8-cf6d-47a0-bfa6-060f8e75e95f db.r3.small n 1y 227.50 USD 0.046 USD mysql Partial Upfront - 4. OFFERING 123456cd-ab1c-47a0-bfa6-12345667232f db.r3.small n 1y 162.00 USD 0.00 USD mysql All Upfront - 5. Recurring Charges: Amount Currency Frequency - 6. Recurring Charges: 0.123 USD Hourly - 7. OFFERING 123456cd-ab1c-37a0-bfa6-12345667232d db.r3.large y 1y 700.00 USD 0.00 USD mysql All Upfront - 8. Recurring Charges: Amount Currency Frequency - 9. Recurring Charges: 1.25 USD Hourly -10. OFFERING 123456cd-ab1c-17d0-bfa6-12345667234e db.r3.xlarge n 1y 4242.00 USD 2.42 USD mysql No Upfront -``` - -After you have information about the available reserved DB instance offerings, you can use the information to purchase an offering\. - -To purchase a reserved DB instance, use the AWS CLI command [https://docs.aws.amazon.com/cli/latest/reference/rds/purchase-reserved-db-instances-offering.html](https://docs.aws.amazon.com/cli/latest/reference/rds/purchase-reserved-db-instances-offering.html) with the following parameters: -+ `--reserved-db-instances-offering-id` – The ID of the offering that you want to purchase\. See the preceding example to get the offering ID\. -+ `--reserved-db-instance-id` – You can assign your own identifier to the reserved DB instances that you purchase to help track them\. - -**Example of purchasing a reserved DB instance** -The following example purchases the reserved DB instance offering with ID *649fd0c8\-cf6d\-47a0\-bfa6\-060f8e75e95f*, and assigns the identifier of *MyReservation*\. -For Linux, macOS, or Unix: - -``` -aws rds purchase-reserved-db-instances-offering \ - --reserved-db-instances-offering-id 649fd0c8-cf6d-47a0-bfa6-060f8e75e95f \ - --reserved-db-instance-id MyReservation -``` -For Windows: - -``` -aws rds purchase-reserved-db-instances-offering ^ - --reserved-db-instances-offering-id 649fd0c8-cf6d-47a0-bfa6-060f8e75e95f ^ - --reserved-db-instance-id MyReservation -``` -The command returns output similar to the following: - -``` -1. RESERVATION ReservationId Class Multi-AZ Start Time Duration Fixed Price Usage Price Count State Description Offering Type -2. RESERVATION MyReservation db.r3.small y 2011-12-19T00:30:23.247Z 1y 455.00 USD 0.092 USD 1 payment-pending mysql Partial Upfront -``` - -After you have purchased reserved DB instances, you can get information about your reserved DB instances\. - -To get information about reserved DB instances for your AWS account, call the AWS CLI command [https://docs.aws.amazon.com/cli/latest/reference/rds/describe-reserved-db-instances.html](https://docs.aws.amazon.com/cli/latest/reference/rds/describe-reserved-db-instances.html), as shown in the following example\. - -**Example of getting your reserved DB instances** - -``` -aws rds describe-reserved-db-instances -``` -The command returns output similar to the following: - -``` -1. RESERVATION ReservationId Class Multi-AZ Start Time Duration Fixed Price Usage Price Count State Description Offering Type -2. RESERVATION MyReservation db.r3.small y 2011-12-09T23:37:44.720Z 1y 455.00 USD 0.092 USD 1 retired mysql Partial Upfront -``` - -### RDS API - -You can use the RDS API to work with reserved DB instances: -+ To get information about available reserved DB instance offerings, call the Amazon RDS API operation [https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_DescribeReservedDBInstancesOfferings.html](https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_DescribeReservedDBInstancesOfferings.html)\. -+ After you have information about the available reserved DB instance offerings, you can use the information to purchase an offering\. Call the [https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_PurchaseReservedDBInstancesOffering.html](https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_PurchaseReservedDBInstancesOffering.html) RDS API operation with the following parameters: - + `--reserved-db-instances-offering-id` – The ID of the offering that you want to purchase\. - + `--reserved-db-instance-id` – You can assign your own identifier to the reserved DB instances that you purchase to help track them\. -+ After you have purchased reserved DB instances, you can get information about your reserved DB instances\. Call the [https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_DescribeReservedDBInstances.html](https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_DescribeReservedDBInstances.html) RDS API operation\. - -## Viewing the billing for your reserved DB instances - -You can view the billing for your reserved DB instances in the Billing Dashboard in the AWS Management Console\. - -**To view reserved DB instance billing** - -1. Sign in to the AWS Management Console\. - -1. From the **account menu** at the upper right, choose **Billing Dashboard**\. - -1. Choose **Bill Details** at the upper right of the dashboard\. - -1. Under **AWS Service Charges**, expand **Relational Database Service**\. - -1. Expand the AWS Region where your reserved DB instances are, for example **US West \(Oregon\)**\. - - Your reserved DB instances and their hourly charges for the current month are shown under **Amazon Relational Database Service for *Database Engine* Reserved Instances**\. -![\[View monthly costs for a reserved DB instance\]](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/images/ri-db-billing1.png) - - The reserved DB instance in this example was purchased All Upfront, so there are no hourly charges\. - -1. Choose the **Cost Explorer** \(bar graph\) icon next to the **Reserved Instances** heading\. - - The Cost Explorer displays the **Monthly EC2 running hours costs and usage** graph\. - -1. Clear the **Usage Type Group** filter to the right of the graph\. - -1. Choose the time period and time unit for which you want to examine usage costs\. - - The following example shows usage costs for on\-demand and reserved DB instances for the year to date by month\. -![\[View usage costs for on-demand and reserved DB instances\]](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/images/ri-db-billing2.png) - - The reserved DB instance costs from January through June 2021 are monthly charges for a Partial Upfront instance, while the cost in August 2021 is a one\-time charge for an All Upfront instance\. - - The reserved instance discount for the Partial Upfront instance expired in June 2021, but the DB instance wasn't deleted\. After the expiration date, it was simply charged at the on\-demand rate\. \ No newline at end of file diff --git a/doc_source/USER_WorkingWithSecurityGroups.md b/doc_source/USER_WorkingWithSecurityGroups.md deleted file mode 100644 index caa80d7..0000000 --- a/doc_source/USER_WorkingWithSecurityGroups.md +++ /dev/null @@ -1,417 +0,0 @@ -# Working with DB security groups \(EC2\-Classic platform\) - -By default, network access is turned off to a DB instance\. You can specify rules in a *security group* that allows access from an IP address range, port, or security group\. Once ingress rules are configured, the same rules apply to all DB instances that are associated with that security group\. You can specify up to 20 rules in a security group\. - -Amazon RDS supports two different kinds of security groups\. The one you use depends on which Amazon RDS platform you are on: -+ **VPC security groups** – for the EC2\-VPC platform\. -+ **DB security groups** – for the EC2\-Classic platform\. - -You are most likely on the EC2\-VPC platform \(and must use VPC security groups\) if any of the following are true: -+ If you are a new Amazon RDS customer\. -+ If you have never created a DB instance before\. -+ If you are creating a DB instance in an AWS Region you have not used before\. - -Otherwise, if you are on the EC2\-Classic platform, you use DB security groups to manage access to your Amazon RDS DB instances\. For more information about the differences between DB security groups and VPC security groups, see [Controlling access with security groups](Overview.RDSSecurityGroups.md)\. - -**Note** -To determine which platform you are on, see [Determining whether you are using the EC2\-VPC or EC2\-Classic platform](USER_VPC.FindDefaultVPC.md)\. -If you are on the EC2\-VPC platform, you must use VPC security groups instead of DB security groups\. For more information about using a VPC, see [Amazon Virtual Private Cloud VPCs and Amazon RDS](USER_VPC.md)\. - -**Topics** -+ [Creating a DB security group](#USER_WorkingWithSecurityGroups.Creating) -+ [Listing available DB security groups](#USER_WorkingWithSecurityGroups.Listing) -+ [Viewing a DB security group](#USER_WorkingWithSecurityGroups.Viewing) -+ [Associating a DB security group with a DB instance](#USER_WorkingWithSecurityGroups.Associate) -+ [Authorizing network access to a DB security group from an IP range](#USER_WorkingWithSecurityGroups.Authorizing) -+ [Authorizing network access to a DB instance from an Amazon EC2 instance](#USER_WorkingWithSecurityGroups.AuthorizingEC2) -+ [Revoking network access to a DB instance from an IP range](#USER_WorkingWithSecurityGroups.Revoking) - -## Creating a DB security group - -To create a DB security group, you need to provide a name and a description\. - -### Console - -**To create a DB security group** - -1. Open the Amazon RDS console at [https://console\.aws\.amazon\.com/rds/](https://console.aws.amazon.com/rds/)\. - -1. From the navigation pane, choose **Security Groups**\. -**Note** -If you are on the EC2\-VPC platform, the **Security Groups** option does not appear in the navigation pane\. In this case, you must use VPC security groups instead of DB security groups\. For more information about using a VPC, see [Amazon Virtual Private Cloud VPCs and Amazon RDS](USER_VPC.md)\. - -1. Choose **Create DB Security Group**\. - -1. Type the name and description of the new DB security group in the **Name** and **Description** text boxes\. The security group name can't contain spaces and can't start with a number\. - -1. Choose **Yes, Create**\. - - The DB security group is created\. - - A newly created DB security group doesn't provide access to a DB instance by default\. You must specify a range of IP addresses or an EC2\-Classic security group that can have access to the DB instance\. To specify IP addresses or an EC2\-Classic security group for a DB security group, see [Authorizing network access to a DB security group from an IP range](#USER_WorkingWithSecurityGroups.Authorizing)\. - -### AWS CLI - -To create a DB security group, use the AWS CLI command [https://docs.aws.amazon.com/cli/latest/reference/rds/create-db-security-group.html](https://docs.aws.amazon.com/cli/latest/reference/rds/create-db-security-group.html)\. - -**Example** -For Linux, macOS, or Unix: - -``` -aws rds create-db-security-group \ - --db-security-group-name mydbsecuritygroup \ - --db-security-group-description "My new security group" -``` -For Windows: - -``` -aws rds create-db-security-group ^ - --db-security-group-name mydbsecuritygroup ^ - --db-security-group-description "My new security group" -``` - -A newly created DB security group doesn't provide access to a DB instance by default\. You must specify a range of IP addresses or an EC2\-Classic security group that can have access to the DB instance\. To specify IP addresses or an EC2\-Classic security group for a DB security group, see [Authorizing network access to a DB security group from an IP range](#USER_WorkingWithSecurityGroups.Authorizing)\. - -### API - -To create a DB security group, call the Amazon RDS function [https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_CreateDBSecurityGroup.html](https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_CreateDBSecurityGroup.html) with the following parameters: -+ `DBSecurityGroupName = mydbsecuritygroup` -+ `Description = "My new security group"` - -**Example** - -``` -https://rds.amazonaws.com/ - ?Action=CreateDBSecurityGroup - &DBSecurityGroupName=mydbsecuritygroup - &Description=My%20new%20db%20security%20group - &Version=2012-01-15 - &SignatureVersion=2 - &SignatureMethod=HmacSHA256 - &Timestamp=2012-01-20T22%3A06%3A23.624Z - &AWSAccessKeyId= - &Signature= -``` - -A newly created DB security group doesn't provide access to a DB instance by default\. You must specify a range of IP addresses or an EC2\-Classic security group that can have access to the DB instance\. To specify IP addresses or an EC2\-Classic security group for a DB security group, see [Authorizing network access to a DB security group from an IP range](#USER_WorkingWithSecurityGroups.Authorizing)\. - -## Listing available DB security groups - -You can list which DB security groups have been created for your AWS account\. - -### Console - -**To list all available DB security groups for an AWS account** - -1. Open the Amazon RDS console at [https://console\.aws\.amazon\.com/rds/](https://console.aws.amazon.com/rds/)\. - -1. From the navigation pane, choose **Security Groups**\. - - The available DB security groups appear in the **DB Security Groups** list\. -**Note** -If you are on the EC2\-VPC platform, the **Security Groups** option does not appear in the navigation pane\. In this case, you must use VPC security groups instead of DB security groups\. For more information about using a VPC, see [Amazon Virtual Private Cloud VPCs and Amazon RDS](USER_VPC.md)\. - -### AWS CLI - -To list all available DB security groups for an AWS account, Use the AWS CLI command [https://docs.aws.amazon.com/cli/latest/reference/rds/describe-db-security-groups.html](https://docs.aws.amazon.com/cli/latest/reference/rds/describe-db-security-groups.html) with no parameters\. - -**Example** - -``` -aws rds describe-db-security-groups -``` - -### API - -To list all available DB security groups for an AWS account, call [https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_DescribeDBSecurityGroups.html](https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_DescribeDBSecurityGroups.html) with no parameters\. - -**Example** - -``` -https://rds.amazonaws.com/ - ?Action=DescribeDBSecurityGroups - &MaxRecords=100 - &Version=2009-10-16 - &SignatureVersion=2 - &SignatureMethod=HmacSHA256 - &AWSAccessKeyId= - &Signature= -``` - -## Viewing a DB security group - -You can view detailed information about your DB security group to see what IP ranges have been authorized\. - -### Console - -**To view properties of a specific DB security group** - -1. Open the Amazon RDS console at [https://console\.aws\.amazon\.com/rds/](https://console.aws.amazon.com/rds/)\. - -1. From the navigation pane, choose **Security Groups**\. -**Note** -If you are on the EC2\-VPC platform, the **Security Groups** option does not appear in the navigation pane\. In this case, you must use VPC security groups instead of DB security groups\. For more information about using a VPC, see [Amazon Virtual Private Cloud VPCs and Amazon RDS](USER_VPC.md)\. - -1. Select the details icon for the DB security group you want to view\. The detailed information for the DB security group is displayed\. - -### AWS CLI - -To view the properties of a specific DB security group use the AWS CLI [https://docs.aws.amazon.com/cli/latest/reference/rds/describe-db-security-groups.html](https://docs.aws.amazon.com/cli/latest/reference/rds/describe-db-security-groups.html)\. Specify the DB security group you want to view\. - -**Example** -For Linux, macOS, or Unix: - -``` -aws rds describe-db-security-groups \ - --db-security-group-name mydbsecuritygroup -``` -For Windows: - -``` -aws rds describe-db-security-groups ^ - --db-security-group-name mydbsecuritygroup -``` - -### API - -To view properties of a specific DB security group, call [https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_DescribeDBSecurityGroups.html](https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_DescribeDBSecurityGroups.html) with the following parameters: -+ `DBSecurityGroupName`=*mydbsecuritygroup* - -**Example** - -``` -https://rds.amazonaws.com/ - ?Action=DescribeDBSecurityGroups - &DBSecurityGroupName=mydbsecuritygroup - &Version=2009-10-16 - &SignatureVersion=2 - &SignatureMethod=HmacSHA256 - &Timestamp=2009-10-16T22%3A23%3A07.107Z - &AWSAccessKeyId= - &Signature= -``` - -## Associating a DB security group with a DB instance - -You can associate a DB security group with a DB instance using the RDS console's **Modify** option, the `ModifyDBInstance` Amazon RDS API, or the AWS CLI `modify-db-instance` command\. - - For information about modifying a DB instance, see [Modifying an Amazon RDS DB instance](Overview.DBInstance.Modifying.md)\. - -## Authorizing network access to a DB security group from an IP range - - By default, network access is turned off to a DB instance\. If you want to access a DB instance that is not in a VPC, you must set access rules for a DB security group to allow access from specific EC2\-Classic security groups or CIDR IP ranges\. You then must associate that DB instance with that DB security group\. This process is called ingress\. Once ingress is configured for a DB security group, the same ingress rules apply to all DB instances associated with that DB security group\. - -**Warning** -Talk with your network administrator if you are intending to access a DB instance behind a firewall to determine the IP addresses you should use\. - -In following example, you configure a DB security group with an ingress rule for a CIDR IP range\. - -### Console - -**To configure a DB security group with an ingress rule for a CIDR IP range** - -1. Open the Amazon RDS console at [https://console\.aws\.amazon\.com/rds/](https://console.aws.amazon.com/rds/)\. - -1. From the navigation pane, choose **Security Groups**\. -**Note** -If you are on the EC2\-VPC platform, the **Security Groups** option does not appear in the navigation pane\. In this case, you must use VPC security groups instead of DB security groups\. For more information about using a VPC, see [Amazon Virtual Private Cloud VPCs and Amazon RDS](USER_VPC.md)\. - -1. Select the details icon for the DB security group you want to authorize\. - -1. In the details page for your security group, select *CIDR/IP* from the **Connection Type** drop\-down list, type the CIDR range for the ingress rule you want to add to this DB security group into the **CIDR** text box, and choose **Authorize**\. -**Tip** -The AWS Management Console displays a CIDR IP based on your connection below the CIDR text field\. If you are not accessing the DB instance from behind a firewall, you can use this CIDR IP\. - -1. The status of the ingress rule is **authorizing** until the new ingress rule has been applied to all DB instances that are associated with the DB security group that you modified\. After the ingress rule has been successfully applied, the status changes to **authorized**\. - -### AWS CLI - -To configure a DB security group with an ingress rule for a CIDR IP range, use the AWS CLI command [https://docs.aws.amazon.com/cli/latest/reference/rds/authorize-db-security-group-ingress.html](https://docs.aws.amazon.com/cli/latest/reference/rds/authorize-db-security-group-ingress.html)\. - -**Example** -For Linux, macOS, or Unix: - -``` -aws rds authorize-db-security-group-ingress \ - --db-security-group-name mydbsecuritygroup \ - --cidrip 192.168.1.10/27 -``` -For Windows: - -``` -aws rds authorize-db-security-group-ingress ^ - --db-security-group-name mydbsecuritygroup ^ - --cidrip 192.168.1.10/27 -``` -The command should produce output similar to the following\. - -``` -SECGROUP mydbsecuritygroup My new DBSecurityGroup -IP-RANGE 192.168.1.10/27 authorizing -``` - -### API - -To configure a DB security group with an ingress rule for a CIDR IP range, call the Amazon RDS API [https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_AuthorizeDBSecurityGroupIngress.html](https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_AuthorizeDBSecurityGroupIngress.html) with the following parameters: -+ `DBSecurityGroupName = mydbsecuritygroup` -+ `CIDRIP = 192.168.1.10/27` - -**Example** - -``` -https://rds.amazonaws.com/ - ?Action=AuthorizeDBSecurityGroupIngress - &CIDRIP=192.168.1.10%2F27 - &DBSecurityGroupName=mydbsecuritygroup - &Version=2009-10-16 - &Action=AuthorizeDBSecurityGroupIngress - &SignatureVersion=2 - &SignatureMethod=HmacSHA256 - &Timestamp=2009-10-22T17%3A10%3A50.274Z - &AWSAccessKeyId= - &Signature= -``` - -## Authorizing network access to a DB instance from an Amazon EC2 instance - -If you want to access your DB instance from an Amazon EC2 instance, you must first determine if your EC2 instance and DB instance are in a VPC\. If you are using a default VPC, you can assign the same EC2 or VPC security group that you used for your EC2 instance when you create or modify the DB instance that the EC2 instance accesses\. - -If your DB instance and EC2 instance are not in a VPC, you must configure the DB instance's security group with an ingress rule that allows traffic from the Amazon EC2 instance\. You do this by adding the EC2\-Classic security group for the EC2 instance to the DB security group for the DB instance\. In this example, you add an ingress rule to a DB security group for an EC2\-Classic security group\. - -**Important** -Adding an ingress rule to a DB security group for an EC2\-Classic security group only grants access to your DB instances from Amazon EC2 instances associated with that EC2\-Classic security group\. -You can't authorize an EC2\-Classic security group that is in a different AWS Region than your DB instance\. You can authorize an IP range, or specify an EC2\-Classic security group in the same AWS Region that refers to IP address in another AWS Region\. If you specify an IP range, we recommend that you use the private IP address of your Amazon EC2 instance, which provides a more direct network route from your Amazon EC2 instance to your Amazon RDS DB instance, and doesn't incur network charges for data sent outside of the Amazon network\. - -### Console - -**To add an EC2\-Classic security group to a DB security group** - -1. Open the Amazon RDS console at [https://console\.aws\.amazon\.com/rds/](https://console.aws.amazon.com/rds/)\. - -1. From the navigation pane, choose **Security Groups**\. -**Note** -If you are on the EC2\-VPC platform, the **Security Groups** option does not appear in the navigation pane\. In this case, you must use VPC security groups instead of DB security groups\. For more information about using a VPC, see [Amazon Virtual Private Cloud VPCs and Amazon RDS](USER_VPC.md)\. - -1. Select the details icon for the DB security group you want to grant access\. - -1. In the details page for your security group, choose **EC2 Security Group** for **Connection Type**, and then select the EC2\-Classic security group you want to use\. Then choose **Authorize**\. - -1. The status of the ingress rule is **authorizing** until the new ingress rule has been applied to all DB instances that are associated with the DB security group that you modified\. After the ingress rule has been successfully applied, the status changes to **authorized**\. - -### AWS CLI - -To grant access to an EC2\-Classic security group, use the AWS CLI command [https://docs.aws.amazon.com/cli/latest/reference/rds/authorize-db-security-group-ingress.html](https://docs.aws.amazon.com/cli/latest/reference/rds/authorize-db-security-group-ingress.html)\. - -**Example** -For Linux, macOS, or Unix: - -``` -aws rds authorize-db-security-group-ingress \ - --db-security-group-name default \ - --ec2-security-group-name myec2group \ - --ec2-security-group-owner-id 987654321021 -``` -For Windows: - -``` -aws rds authorize-db-security-group-ingress ^ - --db-security-group-name default ^ - --ec2-security-group-name myec2group ^ - --ec2-security-group-owner-id 987654321021 -``` -The command should produce output similar to the following: - -``` -SECGROUP Name Description -SECGROUP default default - EC2-SECGROUP myec2group 987654321021 authorizing -``` - -### API - -To authorize network access to an EC2\-Classic security group, call that Amazon RDS API function, [https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_AuthorizeDBSecurityGroupIngress.html](https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_AuthorizeDBSecurityGroupIngress.html)`AuthorizeDBSecurityGroupIngress` with the following parameters: -+ `EC2Security­GroupName = myec2group` -+ `EC2SecurityGroupOwnerId = 987654321021` - -**Example** - -``` -https://rds.amazonaws.com/ - ?Action=AuthorizeDBSecurityGroupIngress - &EC2SecurityGroupOwnerId=987654321021 - &EC2Security­GroupName=myec2group - &Version=2009-10-16 - &SignatureVersion=2 - &SignatureMethod=HmacSHA256 - &Timestamp=2009-10-22T17%3A10%3A50.274Z - &AWSAccessKeyId= - &Signature= -``` - -## Revoking network access to a DB instance from an IP range - -You can easily revoke network access from a CIDR IP range to DB instances belonging to a DB security group by revoking the associated CIDR IP ingress rule\. - -In this example, you revoke an ingress rule for a CIDR IP range on a DB security group\. - -### Console - -**To revoke an ingress rule for a CIDR IP range on a DB security group** - -1. Open the Amazon RDS console at [https://console\.aws\.amazon\.com/rds/](https://console.aws.amazon.com/rds/)\. - -1. From the navigation pane, choose **Security Groups**\. -**Note** -If you are on the EC2\-VPC platform, the **Security Groups** option does not appear in the navigation pane\. In this case, you must use VPC security groups instead of DB security groups\. For more information about using a VPC, see [Amazon Virtual Private Cloud VPCs and Amazon RDS](USER_VPC.md)\. - -1. Select the details icon for the DB security group that has the ingress rule you want to revoke\. - -1. In the details page for your security group, choose **Remove** next to the ingress rule you want to revoke\. - -1. The status of the ingress rule is **revoking** until the ingress rule has been removed from all DB instances that are associated with the DB security group that you modified\. After the ingress rule has been successfully removed, the ingress rule is removed from the DB security group\. - -### AWS CLI - -To revoke an ingress rule for a CIDR IP range on a DB security group, use the AWS CLI command [https://docs.aws.amazon.com/cli/latest/reference/rds/revoke-db-security-group-ingress.html](https://docs.aws.amazon.com/cli/latest/reference/rds/revoke-db-security-group-ingress.html)\. - -**Example** -For Linux, macOS, or Unix: - -``` -aws rds revoke-db-security-group-ingress \ - --db-security-group-name mydbsecuritygroup \ - --cidrip 192.168.1.1/27 -``` -For Windows: - -``` -aws rds revoke-db-security-group-ingress ^ - --db-security-group-name mydbsecuritygroup ^ - --cidrip 192.168.1.1/27 -``` -The command should produce output similar to the following\. - -``` -SECGROUP mydbsecuritygroup My new DBSecurityGroup - IP-RANGE 192.168.1.1/27 revoking -``` - -### API - -To revoke an ingress rule for a CIDR IP range on a DB security group, call the Amazon RDS API operation [https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_RevokeDBSecurityGroupIngress.html](https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_RevokeDBSecurityGroupIngress.html)`RevokeDBSecurityGroupIngress` with the following parameters: -+ `DBSecurityGroupName = mydbsecuritygroup` -+ `CIDRIP = 192.168.1.10/27` - -**Example** - -``` -https://rds.amazonaws.com/ - ?Action=RevokeDBSecurityGroupIngress - &DBSecurityGroupName=mydbsecuritygroup - &CIDRIP=192.168.1.10%2F27 - &Version=2009-10-16 - &SignatureVersion=2&SignatureMethod=HmacSHA256 - &Timestamp=2009-10-22T22%3A32%3A12.515Z - &AWSAccessKeyId= - &Signature= -``` \ No newline at end of file diff --git a/doc_source/User.SQLServer.AdditionalFeatures.md b/doc_source/User.SQLServer.AdditionalFeatures.md deleted file mode 100644 index 0929b32..0000000 --- a/doc_source/User.SQLServer.AdditionalFeatures.md +++ /dev/null @@ -1,13 +0,0 @@ -# Additional features for Microsoft SQL Server on Amazon RDS - -In the following sections, you can find information about augmenting Amazon RDS instances running the Microsoft SQL Server DB engine\. - -**Topics** -+ [Using SSL with a Microsoft SQL Server DB instance](SQLServer.Concepts.General.SSL.Using.md) -+ [Configuring security protocols and ciphers](SQLServer.Ciphers.md) -+ [Using Windows Authentication with an Amazon RDS for SQL Server DB instance](USER_SQLServerWinAuth.md) -+ [Integrating an Amazon RDS for SQL Server DB instance with Amazon S3](User.SQLServer.Options.S3-integration.md) -+ [Using Database Mail on Amazon RDS for SQL Server](SQLServer.DBMail.md) -+ [Instance store support for the tempdb database on Amazon RDS for SQL Server](SQLServer.InstanceStore.md) -+ [Using extended events with Amazon RDS for Microsoft SQL Server](SQLServer.ExtendedEvents.md) -+ [Access to transaction log backups with RDS for SQL Server](USER.SQLServer.AddlFeat.TransactionLogAccess.md) \ No newline at end of file diff --git a/doc_source/User.SQLServer.Options.S3-integration.md b/doc_source/User.SQLServer.Options.S3-integration.md deleted file mode 100644 index 6293b16..0000000 --- a/doc_source/User.SQLServer.Options.S3-integration.md +++ /dev/null @@ -1,605 +0,0 @@ -# Integrating an Amazon RDS for SQL Server DB instance with Amazon S3 - -You can transfer files between a DB instance running Amazon RDS for SQL Server and an Amazon S3 bucket\. By doing this, you can use Amazon S3 with SQL Server features such as BULK INSERT\. For example, you can download \.csv, \.xml, \.txt, and other files from Amazon S3 to the DB instance host and import the data from `D:\S3\` into the database\. All files are stored in `D:\S3\` on the DB instance\. - -The following limitations apply: -+ Files in the `D:\S3` folder are deleted on the standby replica after a failover on Multi\-AZ instances\. For more information, see [Multi\-AZ limitations for S3 integration](#S3-MAZ)\. -+ The DB instance and the S3 bucket must be in the same AWS Region\. -+ If you run more than one S3 integration task at a time, the tasks run sequentially, not in parallel\. -**Note** -S3 integration tasks share the same queue as native backup and restore tasks\. At maximum, you can have only two tasks in progress at any time in this queue\. Therefore, two running native backup and restore tasks will block any S3 integration tasks\. -+ You must re\-enable the S3 integration feature on restored instances\. S3 integration isn't propagated from the source instance to the restored instance\. Files in `D:\S3` are deleted on a restored instance\. -+ Downloading to the DB instance is limited to 100 files\. In other words, there can't be more than 100 files in `D:\S3\`\. -+ Only files without file extensions or with the following file extensions are supported for download: \.abf, \.asdatabase, \.bcp, \.configsettings, \.csv, \.dat, \.deploymentoptions, \.deploymenttargets, \.fmt, \.info, \.ispac, \.lst, \.tbl, \.txt, \.xml, and \.xmla\. -+ The S3 bucket must have the same owner as the related AWS Identity and Access Management \(IAM\) role\. Therefore, cross\-account S3 integration isn't supported\. -+ The S3 bucket can't be open to the public\. -+ The file size for uploads from RDS to S3 is limited to 50 GB per file\. -+ The file size for downloads from S3 to RDS is limited to the maximum supported by S3\. - -**Topics** -+ [Prerequisites for integrating RDS for SQL Server with S3](#Appendix.SQLServer.Options.S3-integration.preparing) -+ [Enabling RDS for SQL Server integration with S3](#Appendix.SQLServer.Options.S3-integration.enabling) -+ [Transferring files between RDS for SQL Server and Amazon S3](#Appendix.SQLServer.Options.S3-integration.using) -+ [Listing files on the RDS DB instance](#Appendix.SQLServer.Options.S3-integration.using.listing-files) -+ [Deleting files on the RDS DB instance](#Appendix.SQLServer.Options.S3-integration.using.deleting-files) -+ [Monitoring the status of a file transfer task](#Appendix.SQLServer.Options.S3-integration.using.monitortasks) -+ [Canceling a task](#Appendix.SQLServer.Options.S3-integration.canceltasks) -+ [Multi\-AZ limitations for S3 integration](#S3-MAZ) -+ [Disabling RDS for SQL Server integration with S3](#Appendix.SQLServer.Options.S3-integration.disabling) - -For more information on working with files in Amazon S3, see [Getting started with Amazon Simple Storage Service](https://docs.aws.amazon.com/AmazonS3/latest/userguide/GetStartedWithS3)\. - -## Prerequisites for integrating RDS for SQL Server with S3 - -Before you begin, find or create the S3 bucket that you want to use\. Also, add permissions so that the RDS DB instance can access the S3 bucket\. To configure this access, you create both an IAM policy and an IAM role\. - -### Console - -**To create an IAM policy for access to Amazon S3** - -1. In the [IAM Management Console](https://console.aws.amazon.com/iam/home?#home), choose **Policies** in the navigation pane\. - -1. Create a new policy, and use the **Visual editor** tab for the following steps\. - -1. For **Service**, enter **S3** and then choose the **S3** service\. - -1. For **Actions**, choose the following to grant the access that your DB instance requires: - + `ListAllMyBuckets` – required - + `ListBucket` – required - + `GetBucketACL` – required - + `GetBucketLocation` – required - + `GetObject` – required for downloading files from S3 to `D:\S3\` - + `PutObject` – required for uploading files from `D:\S3\` to S3 - + `ListMultipartUploadParts` – required for uploading files from `D:\S3\` to S3 - + `AbortMultipartUpload` – required for uploading files from `D:\S3\` to S3 - -1. For **Resources**, the options that display depend on which actions you choose in the previous step\. You might see options for **bucket**, **object**, or both\. For each of these, add the appropriate Amazon Resource Name \(ARN\)\. - - For **bucket**, add the ARN for the bucket that you want to use\. For example, if your bucket is named `example-bucket`, set the ARN to `arn:aws:s3:::example-bucket`\. - - For **object**, enter the ARN for the bucket and then choose one of the following: - + To grant access to all files in the specified bucket, choose **Any** for both **Bucket name** and **Object name**\. - + To grant access to specific files or folders in the bucket, provide ARNs for the specific buckets and objects that you want SQL Server to access\. - -1. Follow the instructions in the console until you finish creating the policy\. - - The preceding is an abbreviated guide to setting up a policy\. For more detailed instructions on creating IAM policies, see [Creating IAM policies](https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies_create.html) in the *IAM User Guide\.* - -**To create an IAM role that uses the IAM policy from the previous procedure** - -1. In the [IAM Management Console](https://console.aws.amazon.com/iam/home?#home), choose **Roles** in the navigation pane\. - -1. Create a new IAM role, and choose the following options as they appear in the console: - + **AWS service** - + **RDS** - + **RDS – Add Role to Database** - - Then choose **Next:Permissions** at the bottom\. - -1. For **Attach permissions policies**, enter the name of the IAM policy that you previously created\. Then choose the policy from the list\. - -1. Follow the instructions in the console until you finish creating the role\. - - The preceding is an abbreviated guide to setting up a role\. If you want more detailed instructions on creating roles, see [IAM roles](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles.html) in the *IAM User Guide\.* - -### AWS CLI - -To grant Amazon RDS access to an Amazon S3 bucket, use the following process: - -1. Create an IAM policy that grants Amazon RDS access to an S3 bucket\. - -1. Create an IAM role that Amazon RDS can assume on your behalf to access your S3 buckets\. - - For more information, see [Creating a role to delegate permissions to an IAM user](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_create_for-user.html) in the *IAM User Guide*\. - -1. Attach the IAM policy that you created to the IAM role that you created\. - -**To create the IAM policy** - -Include the appropriate actions to grant the access your DB instance requires: -+ `ListAllMyBuckets` – required -+ `ListBucket` – required -+ `GetBucketACL` – required -+ `GetBucketLocation` – required -+ `GetObject` – required for downloading files from S3 to `D:\S3\` -+ `PutObject` – required for uploading files from `D:\S3\` to S3 -+ `ListMultipartUploadParts` – required for uploading files from `D:\S3\` to S3 -+ `AbortMultipartUpload` – required for uploading files from `D:\S3\` to S3 - -1. The following AWS CLI command creates an IAM policy named `rds-s3-integration-policy` with these options\. It grants access to a bucket named `bucket_name`\. -**Example** - - For Linux, macOS, or Unix: - - ``` - aws iam create-policy \ - --policy-name rds-s3-integration-policy \ - --policy-document '{ - "Version": "2012-10-17", - "Statement": [ - { - "Effect": "Allow", - "Action": "s3:ListAllMyBuckets", - "Resource": "*" - }, - { - "Effect": "Allow", - "Action": [ - "s3:ListBucket", - "s3:GetBucketACL", - "s3:GetBucketLocation" - ], - "Resource": "arn:aws:s3:::bucket_name" - }, - { - "Effect": "Allow", - "Action": [ - "s3:GetObject", - "s3:PutObject", - "s3:ListMultipartUploadParts", - "s3:AbortMultipartUpload" - ], - "Resource": "arn:aws:s3:::bucket_name/key_prefix/*" - } - ] - }' - ``` - - For Windows: - - Make sure to change the line endings to the ones supported by your interface \(`^` instead of `\`\)\. Also, in Windows, you must escape all double quotes with a `\`\. To avoid the need to escape the quotes in the JSON, you can save it to a file instead and pass that in as a parameter\. - - First, create the `policy.json` file with the following permission policy: - - ``` - { - "Version": "2012-10-17", - "Statement": [ - { - "Effect": "Allow", - "Action": "s3:ListAllMyBuckets", - "Resource": "*" - }, - { - "Effect": "Allow", - "Action": [ - "s3:ListBucket", - "s3:GetBucketACL", - "s3:GetBucketLocation" - ], - "Resource": "arn:aws:s3:::bucket_name" - }, - { - "Effect": "Allow", - "Action": [ - "s3:GetObject", - "s3:PutObject", - "s3:ListMultipartUploadParts", - "s3:AbortMultipartUpload" - ], - "Resource": "arn:aws:s3:::bucket_name/key_prefix/*" - } - ] - } - ``` - - Then use the following command to create the policy: - - ``` - aws iam create-policy ^ - --policy-name rds-s3-integration-policy ^ - --policy-document file://file_path/assume_role_policy.json - ``` - -1. After the policy is created, note the Amazon Resource Name \(ARN\) of the policy\. You need the ARN for a later step\. - -**To create the IAM role** -+ The following AWS CLI command creates the `rds-s3-integration-role` IAM role for this purpose\. -**Example** - - For Linux, macOS, or Unix: - - ``` - aws iam create-role \ - --role-name rds-s3-integration-role \ - --assume-role-policy-document '{ - "Version": "2012-10-17", - "Statement": [ - { - "Effect": "Allow", - "Principal": { - "Service": "rds.amazonaws.com" - }, - "Action": "sts:AssumeRole" - } - ] - }' - ``` - - For Windows: - - Make sure to change the line endings to the ones supported by your interface \(`^` instead of `\`\)\. Also, in Windows, you must escape all double quotes with a `\`\. To avoid the need to escape the quotes in the JSON, you can save it to a file instead and pass that in as a parameter\. - - First, create the `assume_role_policy.json` file with the following policy: - - ``` - { - "Version": "2012-10-17", - "Statement": [ - { - "Effect": "Allow", - "Principal": { - "Service": [ - "rds.amazonaws.com" - ] - }, - "Action": "sts:AssumeRole" - } - ] - } - ``` - - Then use the following command to create the IAM role: - - ``` - aws iam create-role ^ - --role-name rds-s3-integration-role ^ - --assume-role-policy-document file://file_path/assume_role_policy.json - ``` -**Example of using the global condition context key to create the IAM role** - - We recommend using the [https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies_condition-keys.html#condition-keys-sourcearn](https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies_condition-keys.html#condition-keys-sourcearn) and [https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies_condition-keys.html#condition-keys-sourceaccount](https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies_condition-keys.html#condition-keys-sourceaccount) global condition context keys in resource\-based policies to limit the service's permissions to a specific resource\. This is the most effective way to protect against the [confused deputy problem](https://docs.aws.amazon.com/IAM/latest/UserGuide/confused-deputy.html)\. - - You might use both global condition context keys and have the `aws:SourceArn` value contain the account ID\. In this case, the `aws:SourceAccount` value and the account in the `aws:SourceArn` value must use the same account ID when used in the same policy statement\. - + Use `aws:SourceArn` if you want cross\-service access for a single resource\. - + Use `aws:SourceAccount` if you want to allow any resource in that account to be associated with the cross\-service use\. - - In the policy, make sure to use the `aws:SourceArn` global condition context key with the full Amazon Resource Name \(ARN\) of the resources accessing the role\. For S3 integration, make sure to include the DB instance ARNs, as shown in the following example\. - - For Linux, macOS, or Unix: - - ``` - aws iam create-role \ - --role-name rds-s3-integration-role \ - --assume-role-policy-document '{ - "Version": "2012-10-17", - "Statement": [ - { - "Effect": "Allow", - "Principal": { - "Service": "rds.amazonaws.com" - }, - "Action": "sts:AssumeRole", - "Condition": { - "StringEquals": { - "aws:SourceArn":"arn:aws:rds:Region:my_account_ID:db:db_instance_identifier" - } - } - } - ] - }' - ``` - - For Windows: - - Add the global condition context key to `assume_role_policy.json`\. - - ``` - { - "Version": "2012-10-17", - "Statement": [ - { - "Effect": "Allow", - "Principal": { - "Service": [ - "rds.amazonaws.com" - ] - }, - "Action": "sts:AssumeRole", - "Condition": { - "StringEquals": { - "aws:SourceArn":"arn:aws:rds:Region:my_account_ID:db:db_instance_identifier" - } - } - } - ] - } - ``` - -**To attach the IAM policy to the IAM role** -+ The following AWS CLI command attaches the policy to the role named `rds-s3-integration-role`\. Replace `your-policy-arn` with the policy ARN that you noted in a previous step\. -**Example** - - For Linux, macOS, or Unix: - - ``` - aws iam attach-role-policy \ - --policy-arn your-policy-arn \ - --role-name rds-s3-integration-role - ``` - - For Windows: - - ``` - aws iam attach-role-policy ^ - --policy-arn your-policy-arn ^ - --role-name rds-s3-integration-role - ``` - -## Enabling RDS for SQL Server integration with S3 - -In the following section, you can find how to enable Amazon S3 integration with Amazon RDS for SQL Server\. To work with S3 integration, your DB instance must be associated with the IAM role that you previously created before you use the `S3_INTEGRATION` feature\-name parameter\. - -**Note** -To add an IAM role to a DB instance, the status of the DB instance must be **available**\. - -### Console - -**To associate your IAM role with your DB instance** - -1. Sign in to the AWS Management Console and open the Amazon RDS console at [https://console\.aws\.amazon\.com/rds/](https://console.aws.amazon.com/rds/)\. - -1. Choose the RDS for SQL Server DB instance name to display its details\. - -1. On the **Connectivity & security** tab, in the **Manage IAM roles** section, choose the IAM role to add for **Add IAM roles to this instance**\. - -1. For **Feature**, choose **S3\_INTEGRATION**\. -![\[Add the S3_INTEGRATION role\]](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/images/ora-s3-integration-role.png) - -1. Choose **Add role**\. - -### AWS CLI - -**To add the IAM role to the RDS for SQL Server DB instance** -+ The following AWS CLI command adds your IAM role to an RDS for SQL Server DB instance named `mydbinstance`\. -**Example** - - For Linux, macOS, or Unix: - - ``` - aws rds add-role-to-db-instance \ - --db-instance-identifier mydbinstance \ - --feature-name S3_INTEGRATION \ - --role-arn your-role-arn - ``` - - For Windows: - - ``` - aws rds add-role-to-db-instance ^ - --db-instance-identifier mydbinstance ^ - --feature-name S3_INTEGRATION ^ - --role-arn your-role-arn - ``` - - Replace `your-role-arn` with the role ARN that you noted in a previous step\. `S3_INTEGRATION` must be specified for the `--feature-name` option\. - -## Transferring files between RDS for SQL Server and Amazon S3 - -You can use Amazon RDS stored procedures to download and upload files between Amazon S3 and your RDS DB instance\. You can also use Amazon RDS stored procedures to list and delete files on the RDS instance\. - -The files that you download from and upload to S3 are stored in the `D:\S3` folder\. This is the only folder that you can use to access your files\. You can organize your files into subfolders, which are created for you when you include the destination folder during download\. - -Some of the stored procedures require that you provide an Amazon Resource Name \(ARN\) to your S3 bucket and file\. The format for your ARN is `arn:aws:s3:::bucket_name/file_name`\. Amazon S3 doesn't require an account number or AWS Region in ARNs\. - -S3 integration tasks run sequentially and share the same queue as native backup and restore tasks\. At maximum, you can have only two tasks in progress at any time in this queue\. It can take up to five minutes for the task to begin processing\. - -### Downloading files from an Amazon S3 bucket to a SQL Server DB instance - -To download files from an S3 bucket to an RDS for SQL Server DB instance, use the Amazon RDS stored procedure `msdb.dbo.rds_download_from_s3` with the following parameters\. - - -| Parameter name | Data type | Default | Required | Description | -| --- | --- | --- | --- | --- | -| `@s3_arn_of_file` | NVARCHAR | – | Required | The S3 ARN of the file to download, for example: `arn:aws:s3:::bucket_name/mydata.csv` | -| `@rds_file_path` | NVARCHAR | – | Optional | The file path for the RDS instance\. If not specified, the file path is `D:\S3\`\. RDS supports absolute paths and relative paths\. If you want to create a subfolder, include it in the file path\. | -| `@overwrite_file` | INT | 0 | Optional | Overwrite the existing file: 0 = Don't overwrite 1 = Overwrite | - -You can download files without a file extension and files with the following file extensions: \.bcp, \.csv, \.dat, \.fmt, \.info, \.lst, \.tbl, \.txt, and \.xml\. - -**Note** -Files with the \.ispac file extension are supported for download when SQL Server Integration Services is enabled\. For more information on enabling SSIS, see [SQL Server Integration Services](Appendix.SQLServer.Options.SSIS.md)\. -Files with the following file extensions are supported for download when SQL Server Analysis Services is enabled: \.abf, \.asdatabase, \.configsettings, \.deploymentoptions, \.deploymenttargets, and \.xmla\. For more information on enabling SSAS, see [SQL Server Analysis Services](Appendix.SQLServer.Options.SSAS.md)\. - -The following example shows the stored procedure to download files from S3\. - -``` -exec msdb.dbo.rds_download_from_s3 - @s3_arn_of_file='arn:aws:s3:::bucket_name/bulk_data.csv', - @rds_file_path='D:\S3\seed_data\data.csv', - @overwrite_file=1; -``` - -The example `rds_download_from_s3` operation creates a folder named `seed_data` in `D:\S3\`, if the folder doesn't exist yet\. Then the example downloads the source file `bulk_data.csv` from S3 to a new file named `data.csv` on the DB instance\. If the file previously existed, it's overwritten because the `@overwrite_file` parameter is set to `1`\. - -### Uploading files from a SQL Server DB instance to an Amazon S3 bucket - -To upload files from an RDS for SQL Server DB instance to an S3 bucket, use the Amazon RDS stored procedure `msdb.dbo.rds_upload_to_s3` with the following parameters\. - - -| Parameter name | Data type | Default | Required | Description | -| --- | --- | --- | --- | --- | -| `@s3_arn_of_file` | NVARCHAR | – | Required | The S3 ARN of the file to be created in S3, for example: `arn:aws:s3:::bucket_name/mydata.csv` | -| `@rds_file_path` | NVARCHAR | – | Required | The file path of the file to upload to S3\. Absolute and relative paths are supported\. | -| `@overwrite_file` | INT | – | Optional | Overwrite the existing file: 0 = Don't overwrite 1 = Overwrite | - -The following example uploads the file named `data.csv` from the specified location in `D:\S3\seed_data\` to a file `new_data.csv` in the S3 bucket specified by the ARN\. - -``` -exec msdb.dbo.rds_upload_to_s3 - @rds_file_path='D:\S3\seed_data\data.csv', - @s3_arn_of_file='arn:aws:s3:::bucket_name/new_data.csv', - @overwrite_file=1; -``` - -If the file previously existed in S3, it's overwritten because the @overwrite\_file parameter is set to `1`\. - -## Listing files on the RDS DB instance - -To list the files available on the DB instance, use both a stored procedure and a function\. First, run the following stored procedure to gather file details from the files in `D:\S3\`\. - -``` -exec msdb.dbo.rds_gather_file_details; -``` - -The stored procedure returns the ID of the task\. Like other tasks, this stored procedure runs asynchronously\. As soon as the status of the task is `SUCCESS`, you can use the task ID in the `rds_fn_list_file_details` function to list the existing files and directories in D:\\S3\\, as shown following\. - -``` -SELECT * FROM msdb.dbo.rds_fn_list_file_details(TASK_ID); -``` - -The `rds_fn_list_file_details` function returns a table with the following columns\. - - -| Output parameter | Description | -| --- | --- | -| filepath | Absolute path of the file \(for example, D:\\S3\\mydata\.csv\) | -| size\_in\_bytes | File size \(in bytes\) | -| last\_modified\_utc | Last modification date and time in UTC format | -| is\_directory | Option that indicates whether the item is a directory \(true/false\) | - -## Deleting files on the RDS DB instance - -To delete the files available on the DB instance, use the Amazon RDS stored procedure `msdb.dbo.rds_delete_from_filesystem` with the following parameters\. - - -| Parameter name | Data type | Default | Required | Description | -| --- | --- | --- | --- | --- | -| `@rds_file_path` | NVARCHAR | – | Required | The file path of the file to delete\. Absolute and relative paths are supported\. | -| `@force_delete` | INT | 0 | Optional | To delete a directory, this flag must be included and set to `1`\. `1` = delete a directory This parameter is ignored if you are deleting a file\. | - -To delete a directory, the `@rds_file_path` must end with a backslash \(`\`\) and `@force_delete` must be set to `1`\. - -The following example deletes the file `D:\S3\delete_me.txt`\. - -``` -exec msdb.dbo.rds_delete_from_filesystem - @rds_file_path='D:\S3\delete_me.txt'; -``` - -The following example deletes the directory `D:\S3\example_folder\`\. - -``` -exec msdb.dbo.rds_delete_from_filesystem - @rds_file_path='D:\S3\example_folder\', - @force_delete=1; -``` - -## Monitoring the status of a file transfer task - -To track the status of your S3 integration task, call the `rds_fn_task_status` function\. It takes two parameters\. The first parameter should always be `NULL` because it doesn't apply to S3 integration\. The second parameter accepts a task ID\. - -To see a list of all tasks, set the first parameter to `NULL` and the second parameter to `0`, as shown in the following example\. - -``` -SELECT * FROM msdb.dbo.rds_fn_task_status(NULL,0); -``` - -To get a specific task, set the first parameter to `NULL` and the second parameter to the task ID, as shown in the following example\. - -``` -SELECT * FROM msdb.dbo.rds_fn_task_status(NULL,42); -``` - -The `rds_fn_task_status` function returns the following information\. - - -| Output parameter | Description | -| --- | --- | -| `task_id` | The ID of the task\. | -| `task_type` | For S3 integration, tasks can have the following task types: [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/User.SQLServer.Options.S3-integration.html) | -| `database_name` | Not applicable to S3 integration tasks\. | -| `% complete` | The progress of the task as a percentage\. | -| `duration(mins)` | The amount of time spent on the task, in minutes\. | -| `lifecycle` | The status of the task\. Possible statuses are the following: [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/User.SQLServer.Options.S3-integration.html) | -| `task_info` | Additional information about the task\. If an error occurs during processing, this column contains information about the error\. | -| `last_updated` | The date and time that the task status was last updated\. | -| `created_at` | The date and time that the task was created\. | -| `S3_object_arn` | The ARN of the S3 object downloaded from or uploaded to\. | -| `overwrite_S3_backup_file` | Not applicable to S3 integration tasks\. | -| `KMS_master_key_arn` | Not applicable to S3 integration tasks\. | -| `filepath` | The file path on the RDS DB instance\. | -| `overwrite_file` | An option that indicates if an existing file is overwritten\. | -| `task_metadata` | Not applicable to S3 integration tasks\. | - -## Canceling a task - -To cancel S3 integration tasks, use the `msdb.dbo.rds_cancel_task` stored procedure with the `task_id` parameter\. Delete and list tasks that are in progress can't be cancelled\. The following example shows a request to cancel a task\. - -``` -exec msdb.dbo.rds_cancel_task @task_id = 1234; -``` - -To get an overview of all tasks and their task IDs, use the `rds_fn_task_status` function as described in [Monitoring the status of a file transfer task](#Appendix.SQLServer.Options.S3-integration.using.monitortasks)\. - -## Multi\-AZ limitations for S3 integration - -On Multi\-AZ instances, files in the `D:\S3` folder are deleted on the standby replica after a failover\. A failover can be planned, for example, during DB instance modifications such as changing the instance class or upgrading the engine version\. Or a failover can be unplanned, during an outage of the primary\. - -**Note** -We don't recommend using the `D:\S3` folder for file storage\. The best practice is to upload created files to Amazon S3 to make them durable, and download files when you need to import data\. - -To determine the last failover time, you can use the `msdb.dbo.rds_failover_time` stored procedure\. For more information, see [Determining the last failover time](Appendix.SQLServer.CommonDBATasks.LastFailover.md)\. - -**Example of no recent failover** -This example shows the output when there is no recent failover in the error logs\. No failover has happened since 2020\-04\-29 23:59:00\.01\. -Therefore, all files downloaded after that time that haven't been deleted using the `rds_delete_from_filesystem` stored procedure are still accessible on the current host\. Files downloaded before that time might also be available\. - - -| errorlog\_available\_from | recent\_failover\_time | -| --- | --- | -| 2020\-04\-29 23:59:00\.0100000 | null | - -**Example of recent failover** -This example shows the output when there is a failover in the error logs\. The most recent failover was at 2020\-05\-05 18:57:51\.89\. -All files downloaded after that time that haven't been deleted using the `rds_delete_from_filesystem` stored procedure are still accessible on the current host\. - - -| errorlog\_available\_from | recent\_failover\_time | -| --- | --- | -| 2020\-04\-29 23:59:00\.0100000 | 2020\-05\-05 18:57:51\.8900000 | - -## Disabling RDS for SQL Server integration with S3 - -Following, you can find how to disable Amazon S3 integration with Amazon RDS for SQL Server\. Files in `D:\S3\` aren't deleted when disabling S3 integration\. - -**Note** -To remove an IAM role from a DB instance, the status of the DB instance must be `available`\. - -### Console - -**To disassociate your IAM role from your DB instance** - -1. Sign in to the AWS Management Console and open the Amazon RDS console at [https://console\.aws\.amazon\.com/rds/](https://console.aws.amazon.com/rds/)\. - -1. Choose the RDS for SQL Server DB instance name to display its details\. - -1. On the **Connectivity & security** tab, in the **Manage IAM roles** section, choose the IAM role to remove\. - -1. Choose **Delete**\. - -### AWS CLI - -**To remove the IAM role from the RDS for SQL Server DB instance** -+ The following AWS CLI command removes the IAM role from a RDS for SQL Server DB instance named `mydbinstance`\. -**Example** - - For Linux, macOS, or Unix: - - ``` - aws rds remove-role-from-db-instance \ - --db-instance-identifier mydbinstance \ - --feature-name S3_INTEGRATION \ - --role-arn your-role-arn - ``` - - For Windows: - - ``` - aws rds remove-role-from-db-instance ^ - --db-instance-identifier mydbinstance ^ - --feature-name S3_INTEGRATION ^ - --role-arn your-role-arn - ``` - - Replace `your-role-arn` with the appropriate IAM role ARN for the `--feature-name` option\. \ No newline at end of file diff --git a/doc_source/User_DBInstanceBilling.md b/doc_source/User_DBInstanceBilling.md deleted file mode 100644 index f20a0aa..0000000 --- a/doc_source/User_DBInstanceBilling.md +++ /dev/null @@ -1,21 +0,0 @@ -# DB instance billing for Amazon RDS - -Amazon RDS instances are billed based on the following components: -+ DB instance hours \(per hour\) – Based on the DB instance class of the DB instance \(for example, db\.t2\.small or db\.m4\.large\)\. Pricing is listed on a per\-hour basis, but bills are calculated down to the second and show times in decimal form\. RDS usage is billed in 1\-second increments, with a minimum of 10 minutes\. For more information, see [DB instance classes](Concepts.DBInstanceClass.md)\. -+ Storage \(per GiB per month\) – Storage capacity that you have provisioned to your DB instance\. If you scale your provisioned storage capacity within the month, your bill is prorated\. For more information, see [Amazon RDS DB instance storage](CHAP_Storage.md)\. -+ Input/output \(I/O\) requests \(per 1 million requests\) – Total number of storage I/O requests that you have made in a billing cycle, for Amazon RDS magnetic storage only\. -+ Provisioned IOPS \(per IOPS per month\) – Provisioned IOPS rate, regardless of IOPS consumed, for Amazon RDS Provisioned IOPS \(SSD\) and General Purpose \(SSD\) gp3 storage\. Provisioned storage for EBS volumes are billed in 1\-second increments, with a minimum of 10 minutes\. -+ Backup storage \(per GiB per month\) – *Backup storage *is the storage that is associated with automated database backups and any active database snapshots that you have taken\. Increasing your backup retention period or taking additional database snapshots increases the backup storage consumed by your database\. Per second billing doesn't apply to backup storage \(metered in GB\-month\)\. - - For more information, see [Backing up and restoring](CHAP_CommonTasks.BackupRestore.md)\. -+ Data transfer \(per GB\) – Data transfer in and out of your DB instance from or to the internet and other AWS Regions\. - -Amazon RDS provides the following purchasing options to enable you to optimize your costs based on your needs: -+ **On\-Demand instances** – Pay by the hour for the DB instance hours that you use\. Pricing is listed on a per\-hour basis, but bills are calculated down to the second and show times in decimal form\. RDS usage is now billed in 1\-second increments, with a minimum of 10 minutes\. -+ **Reserved instances** – Reserve a DB instance for a one\-year or three\-year term and get a significant discount compared to the on\-demand DB instance pricing\. With Reserved Instance usage, you can launch, delete, start, or stop multiple instances within an hour and get the Reserved Instance benefit for all of the instances\. - -For Amazon RDS pricing information, see the [Amazon RDS pricing page](https://aws.amazon.com/rds/pricing)\. - -**Topics** -+ [On\-Demand DB instances for Amazon RDS](USER_OnDemandDBInstances.md) -+ [Reserved DB instances for Amazon RDS](USER_WorkingWithReservedDBInstances.md) \ No newline at end of file diff --git a/doc_source/UsingWithRDS.IAM.ServiceLinkedRoles.md b/doc_source/UsingWithRDS.IAM.ServiceLinkedRoles.md deleted file mode 100644 index 13b311f..0000000 --- a/doc_source/UsingWithRDS.IAM.ServiceLinkedRoles.md +++ /dev/null @@ -1,134 +0,0 @@ -# Using service\-linked roles for Amazon RDS - -Amazon RDS uses AWS Identity and Access Management \(IAM\)[ service\-linked roles](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_terms-and-concepts.html#iam-term-service-linked-role)\. A service\-linked role is a unique type of IAM role that is linked directly to Amazon RDS\. Service\-linked roles are predefined by Amazon RDS and include all the permissions that the service requires to call other AWS services on your behalf\. - -A service\-linked role makes using Amazon RDS easier because you don't have to manually add the necessary permissions\. Amazon RDS defines the permissions of its service\-linked roles, and unless defined otherwise, only Amazon RDS can assume its roles\. The defined permissions include the trust policy and the permissions policy, and that permissions policy cannot be attached to any other IAM entity\. - -You can delete the roles only after first deleting their related resources\. This protects your Amazon RDS resources because you can't inadvertently remove permission to access the resources\. - -For information about other services that support service\-linked roles, see [AWS services that work with IAM](https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_aws-services-that-work-with-iam.html) and look for the services that have **Yes **in the **Service\-Linked Role** column\. Choose a **Yes** with a link to view the service\-linked role documentation for that service\. - -## Service\-linked role permissions for Amazon RDS - -Amazon RDS uses the service\-linked role named AWSServiceRoleForRDS to allow Amazon RDS to call AWS services on behalf of your DB instances\. - -The AWSServiceRoleForRDS service\-linked role trusts the following services to assume the role: -+ `rds.amazonaws.com` - -This service\-linked role has a permissions policy attached to it called `AmazonRDSServiceRolePolicy` that grants it permissions to operate in your account\. The role permissions policy allows Amazon RDS to complete the following actions on the specified resources: - -For more information about this policy, including the JSON policy document, see [AmazonRDSServiceRolePolicy](https://docs.aws.amazon.com/aws-managed-policy/latest/reference/AmazonRDSServiceRolePolicy.html) in the *AWS Managed Policy Reference Guide*\. - -**Note** -You must configure permissions to allow an IAM entity \(such as a user, group, or role\) to create, edit, or delete a service\-linked role\. If you encounter the following error message: -**Unable to create the resource\. Verify that you have permission to create service linked role\. Otherwise wait and try again later\.** - Make sure you have the following permissions enabled: - -``` -{ - "Action": "iam:CreateServiceLinkedRole", - "Effect": "Allow", - "Resource": "arn:aws:iam::*:role/aws-service-role/rds.amazonaws.com/AWSServiceRoleForRDS", - "Condition": { - "StringLike": { - "iam:AWSServiceName":"rds.amazonaws.com" - } - } -} -``` - For more information, see [Service\-linked role permissions](https://docs.aws.amazon.com/IAM/latest/UserGuide/using-service-linked-roles.html#service-linked-role-permissions) in the *IAM User Guide*\. - -### Creating a service\-linked role for Amazon RDS - -You don't need to manually create a service\-linked role\. When you create a DB instance, Amazon RDS creates the service\-linked role for you\. - -**Important** -If you were using the Amazon RDS service before December 1, 2017, when it began supporting service\-linked roles, then Amazon RDS created the AWSServiceRoleForRDS role in your account\. To learn more, see [A new role appeared in my AWS account](https://docs.aws.amazon.com/IAM/latest/UserGuide/troubleshoot_roles.html#troubleshoot_roles_new-role-appeared)\. - -If you delete this service\-linked role, and then need to create it again, you can use the same process to recreate the role in your account\. When you create a DB instance, Amazon RDS creates the service\-linked role for you again\. - -### Editing a service\-linked role for Amazon RDS - -Amazon RDS does not allow you to edit the AWSServiceRoleForRDS service\-linked role\. After you create a service\-linked role, you cannot change the name of the role because various entities might reference the role\. However, you can edit the description of the role using IAM\. For more information, see [Editing a service\-linked role](https://docs.aws.amazon.com/IAM/latest/UserGuide/using-service-linked-roles.html#edit-service-linked-role) in the *IAM User Guide*\. - -### Deleting a service\-linked role for Amazon RDS - -If you no longer need to use a feature or service that requires a service\-linked role, we recommend that you delete that role\. That way you don't have an unused entity that is not actively monitored or maintained\. However, you must delete all of your DB instances before you can delete the service\-linked role\. - -#### Cleaning up a service\-linked role - -Before you can use IAM to delete a service\-linked role, you must first confirm that the role has no active sessions and remove any resources used by the role\. - -**To check whether the service\-linked role has an active session in the IAM console** - -1. Sign in to the AWS Management Console and open the IAM console at [https://console\.aws\.amazon\.com/iam/](https://console.aws.amazon.com/iam/)\. - -1. In the navigation pane of the IAM console, choose **Roles**\. Then choose the name \(not the check box\) of the AWSServiceRoleForRDS role\. - -1. On the **Summary** page for the chosen role, choose the **Access Advisor** tab\. - -1. On the **Access Advisor** tab, review recent activity for the service\-linked role\. -**Note** -If you are unsure whether Amazon RDS is using the AWSServiceRoleForRDS role, you can try to delete the role\. If the service is using the role, then the deletion fails and you can view the AWS Regions where the role is being used\. If the role is being used, then you must wait for the session to end before you can delete the role\. You cannot revoke the session for a service\-linked role\. - -If you want to remove the AWSServiceRoleForRDS role, you must first delete *all* of your DB instances \. - -##### Deleting all of your instances - -Use one of these procedures to delete each of your instances\. - -**To delete an instance \(console\)** - -1. Open the Amazon RDS console at [https://console\.aws\.amazon\.com/rds/](https://console.aws.amazon.com/rds/)\. - -1. In the navigation pane, choose **Databases**\. - -1. Choose the instance that you want to delete\. - -1. For **Actions**, choose **Delete**\. - -1. If you are prompted for **Create final Snapshot?**, choose **Yes** or **No**\. - -1. If you chose **Yes** in the previous step, for **Final snapshot name** enter the name of your final snapshot\. - -1. Choose **Delete**\. - -**To delete an instance \(CLI\)** -See `[delete\-db\-instance](https://docs.aws.amazon.com/cli/latest/reference/rds/delete-db-instance.html)` in the *AWS CLI Command Reference*\. - -**To delete an instance \(API\)** -See `[DeleteDBInstance](https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_DeleteDBInstance.html)` in the *Amazon RDS API Reference*\. - -You can use the IAM console, the IAM CLI, or the IAM API to delete the AWSServiceRoleForRDS service\-linked role\. For more information, see [Deleting a service\-linked role](https://docs.aws.amazon.com/IAM/latest/UserGuide/using-service-linked-roles.html#delete-service-linked-role) in the *IAM User Guide*\. - -## Service\-linked role permissions for Amazon RDS Custom - -Amazon RDS Custom uses the service\-linked role named `AWSServiceRoleForRDSCustom` to allow RDS Custom to call AWS services on behalf of your DB instances and DB clusters\. - -The AWSServiceRoleForRDSCustom service\-linked role trusts the following services to assume the role: -+ `custom.rds.amazonaws.com` - -This service\-linked role has a permissions policy attached to it called `AmazonRDSCustomServiceRolePolicy` that grants it permissions to operate in your account\. The role permissions policy allows RDS Custom to complete the following actions on the specified resources: - -For more information about this policy, including the JSON policy document, see [AmazonRDSCustomServiceRolePolicy](https://docs.aws.amazon.com/aws-managed-policy/latest/reference/AmazonRDSCustomServiceRolePolicy.html) in the *AWS Managed Policy Reference Guide*\. - -Creating, editing, or deleting the service\-linked role for RDS Custom works the same as for Amazon RDS\. For more information, see [Service\-linked role permissions for Amazon RDS](#service-linked-role-permissions)\. - -**Note** -You must configure permissions to allow an IAM entity \(such as a user, group, or role\) to create, edit, or delete a service\-linked role\. If you encounter the following error message: -**Unable to create the resource\. Verify that you have permission to create service linked role\. Otherwise wait and try again later\.** - Make sure you have the following permissions enabled: - -``` -{ - "Action": "iam:CreateServiceLinkedRole", - "Effect": "Allow", - "Resource": "arn:aws:iam::*:role/aws-service-role/custom.rds.amazonaws.com/AmazonRDSCustomServiceRolePolicy", - "Condition": { - "StringLike": { - "iam:AWSServiceName":"custom.rds.amazonaws.com" - } - } -} -``` - For more information, see [Service\-linked role permissions](https://docs.aws.amazon.com/IAM/latest/UserGuide/using-service-linked-roles.html#service-linked-role-permissions) in the *IAM User Guide*\. \ No newline at end of file diff --git a/doc_source/UsingWithRDS.IAM.md b/doc_source/UsingWithRDS.IAM.md deleted file mode 100644 index 3b9a841..0000000 --- a/doc_source/UsingWithRDS.IAM.md +++ /dev/null @@ -1,113 +0,0 @@ -# Identity and access management for Amazon RDS - - - - - -AWS Identity and Access Management \(IAM\) is an AWS service that helps an administrator securely control access to AWS resources\. IAM administrators control who can be *authenticated* \(signed in\) and *authorized* \(have permissions\) to use Amazon RDS resources\. IAM is an AWS service that you can use with no additional charge\. - -**Topics** -+ [Audience](#security_iam_audience) -+ [Authenticating with identities](#security_iam_authentication) -+ [Managing access using policies](#security_iam_access-manage) -+ [How Amazon RDS works with IAM](security_iam_service-with-iam.md) -+ [Identity\-based policy examples for Amazon RDS](security_iam_id-based-policy-examples.md) -+ [AWS managed policies for Amazon RDS](rds-security-iam-awsmanpol.md) -+ [Amazon RDS updates to AWS managed policies](rds-manpol-updates.md) -+ [Preventing cross\-service confused deputy problems](cross-service-confused-deputy-prevention.md) -+ [IAM database authentication for MariaDB, MySQL, and PostgreSQL](UsingWithRDS.IAMDBAuth.md) -+ [Troubleshooting Amazon RDS identity and access](security_iam_troubleshoot.md) - -## Audience - -How you use AWS Identity and Access Management \(IAM\) differs, depending on the work you do in Amazon RDS\. - -**Service user** – If you use the Amazon RDS service to do your job, then your administrator provides you with the credentials and permissions that you need\. As you use more Amazon RDS features to do your work, you might need additional permissions\. Understanding how access is managed can help you request the right permissions from your administrator\. If you cannot access a feature in Amazon RDS, see [Troubleshooting Amazon RDS identity and access](security_iam_troubleshoot.md)\. - -**Service administrator** – If you're in charge of Amazon RDS resources at your company, you probably have full access to Amazon RDS\. It's your job to determine which Amazon RDS features and resources your employees should access\. You must then submit requests to your administrator to change the permissions of your service users\. Review the information on this page to understand the basic concepts of IAM\. To learn more about how your company can use IAM with Amazon RDS, see [How Amazon RDS works with IAM](security_iam_service-with-iam.md)\. - -**Administrator** – If you're an administrator, you might want to learn details about how you can write policies to manage access to Amazon RDS\. To view example Amazon RDS identity\-based policies that you can use in IAM, see [Identity\-based policy examples for Amazon RDS](security_iam_id-based-policy-examples.md)\. - -## Authenticating with identities - -Authentication is how you sign in to AWS using your identity credentials\. You must be *authenticated* \(signed in to AWS\) as the AWS account root user, as an IAM user, or by assuming an IAM role\. - -You can sign in to AWS as a federated identity by using credentials provided through an identity source\. AWS IAM Identity Center \(successor to AWS Single Sign\-On\) \(IAM Identity Center\) users, your company's single sign\-on authentication, and your Google or Facebook credentials are examples of federated identities\. When you sign in as a federated identity, your administrator previously set up identity federation using IAM roles\. When you access AWS by using federation, you are indirectly assuming a role\. - -Depending on the type of user you are, you can sign in to the AWS Management Console or the AWS access portal\. For more information about signing in to AWS, see [How to sign in to your AWS account](https://docs.aws.amazon.com/signin/latest/userguide/how-to-sign-in.html) in the *AWS Sign\-In User Guide*\. - -If you access AWS programmatically, AWS provides a software development kit \(SDK\) and a command line interface \(CLI\) to cryptographically sign your requests using your credentials\. If you don't use AWS tools, you must sign requests yourself\. For more information about using the recommended method to sign requests yourself, see [Signature Version 4 signing process](https://docs.aws.amazon.com/general/latest/gr/signature-version-4.html) in the *AWS General Reference*\. - -Regardless of the authentication method that you use, you might be required to provide additional security information\. For example, AWS recommends that you use multi\-factor authentication \(MFA\) to increase the security of your account\. To learn more, see [Multi\-factor authentication](https://docs.aws.amazon.com/singlesignon/latest/userguide/enable-mfa.html) in the *AWS IAM Identity Center \(successor to AWS Single Sign\-On\) User Guide* and [Using multi\-factor authentication \(MFA\) in AWS](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_mfa.html) in the *IAM User Guide*\. - -### AWS account root user - - When you create an AWS account, you begin with one sign\-in identity that has complete access to all AWS services and resources in the account\. This identity is called the AWS account *root user* and is accessed by signing in with the email address and password that you used to create the account\. We strongly recommend that you don't use the root user for your everyday tasks\. Safeguard your root user credentials and use them to perform the tasks that only the root user can perform\. For the complete list of tasks that require you to sign in as the root user, see [Tasks that require root user credentials](https://docs.aws.amazon.com/accounts/latest/reference/root-user-tasks.html) in the *AWS Account Management Reference Guide*\. - -### Federated identity - -As a best practice, require human users, including users that require administrator access, to use federation with an identity provider to access AWS services by using temporary credentials\. - -A *federated identity* is a user from your enterprise user directory, a web identity provider, the AWS Directory Service, the Identity Center directory, or any user that accesses AWS services by using credentials provided through an identity source\. When federated identities access AWS accounts, they assume roles, and the roles provide temporary credentials\. - -For centralized access management, we recommend that you use AWS IAM Identity Center \(successor to AWS Single Sign\-On\)\. You can create users and groups in IAM Identity Center, or you can connect and synchronize to a set of users and groups in your own identity source for use across all your AWS accounts and applications\. For information about IAM Identity Center, see [What is IAM Identity Center?](https://docs.aws.amazon.com/singlesignon/latest/userguide/what-is.html) in the *AWS IAM Identity Center \(successor to AWS Single Sign\-On\) User Guide*\. - -### IAM users and groups - -An *[IAM user](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_users.html)* is an identity within your AWS account that has specific permissions for a single person or application\. Where possible, we recommend relying on temporary credentials instead of creating IAM users who have long\-term credentials such as passwords and access keys\. However, if you have specific use cases that require long\-term credentials with IAM users, we recommend that you rotate access keys\. For more information, see [Rotate access keys regularly for use cases that require long\-term credentials](https://docs.aws.amazon.com/IAM/latest/UserGuide/best-practices.html#rotate-credentials) in the *IAM User Guide*\. - -An [https://docs.aws.amazon.com/IAM/latest/UserGuide/id_groups.html](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_groups.html) is an identity that specifies a collection of IAM users\. You can't sign in as a group\. You can use groups to specify permissions for multiple users at a time\. Groups make permissions easier to manage for large sets of users\. For example, you could have a group named *IAMAdmins* and give that group permissions to administer IAM resources\. - -Users are different from roles\. A user is uniquely associated with one person or application, but a role is intended to be assumable by anyone who needs it\. Users have permanent long\-term credentials, but roles provide temporary credentials\. To learn more, see [When to create an IAM user \(instead of a role\)](https://docs.aws.amazon.com/IAM/latest/UserGuide/id.html#id_which-to-choose) in the *IAM User Guide*\. - -You can authenticate to your DB instance using IAM database authentication\. - -IAM database authentication works with the following DB engines: -+ RDS for MariaDB -+ RDS for MySQL -+ RDS for PostgreSQL - -For more information about authenticating to your DB instance using IAM, see [IAM database authentication for MariaDB, MySQL, and PostgreSQL](UsingWithRDS.IAMDBAuth.md)\. - -### IAM roles - -An *[IAM role](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles.html)* is an identity within your AWS account that has specific permissions\. It is similar to a user, but is not associated with a specific person\. You can temporarily assume an IAM role in the AWS Management Console by [switching roles](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_use_switch-role-console.html)\. You can assume a role by calling an AWS CLI or AWS API operation or by using a custom URL\. For more information about methods for using roles, see [Using IAM roles](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_use.html) in the *IAM User Guide*\. - -IAM roles with temporary credentials are useful in the following situations: -+ **Temporary user permissions** – A user can assume an IAM role to temporarily take on different permissions for a specific task\. -+ **Federated user access** – To assign permissions to a federated identity, you create a role and define permissions for the role\. When a federated identity authenticates, the identity is associated with the role and is granted the permissions that are defined by the role\. For information about roles for federation, see [ Creating a role for a third\-party Identity Provider](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_create_for-idp.html) in the *IAM User Guide*\. If you use IAM Identity Center, you configure a permission set\. To control what your identities can access after they authenticate, IAM Identity Center correlates the permission set to a role in IAM\. For information about permissions sets, see [ Permission sets](https://docs.aws.amazon.com/singlesignon/latest/userguide/permissionsetsconcept.html) in the *AWS IAM Identity Center \(successor to AWS Single Sign\-On\) User Guide*\. -+ **Cross\-account access** – You can use an IAM role to allow someone \(a trusted principal\) in a different account to access resources in your account\. Roles are the primary way to grant cross\-account access\. However, with some AWS services, you can attach a policy directly to a resource \(instead of using a role as a proxy\)\. To learn the difference between roles and resource\-based policies for cross\-account access, see [How IAM roles differ from resource\-based policies](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_compare-resource-policies.html) in the *IAM User Guide*\. -+ **Cross\-service access** – Some AWS services use features in other AWS services\. For example, when you make a call in a service, it's common for that service to run applications in Amazon EC2 or store objects in Amazon S3\. A service might do this using the calling principal's permissions, using a service role, or using a service\-linked role\. - + **Principal permissions** – When you use an IAM user or role to perform actions in AWS, you are considered a principal\. Policies grant permissions to a principal\. When you use some services, you might perform an action that then triggers another action in a different service\. In this case, you must have permissions to perform both actions\. To see whether an action requires additional dependent actions in a policy, see [Actions, Resources, and Condition Keys for Amazon RDS](https://docs.aws.amazon.com/service-authorization/latest/reference/list_amazonrds.html.html) in the *Service Authorization Reference*\. - + **Service role** – A service role is an [IAM role](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles.html) that a service assumes to perform actions on your behalf\. An IAM administrator can create, modify, and delete a service role from within IAM\. For more information, see [Creating a role to delegate permissions to an AWS service](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_create_for-service.html) in the *IAM User Guide*\. - + **Service\-linked role** – A service\-linked role is a type of service role that is linked to an AWS service\. The service can assume the role to perform an action on your behalf\. Service\-linked roles appear in your AWS account and are owned by the service\. An IAM administrator can view, but not edit the permissions for service\-linked roles\. -+ **Applications running on Amazon EC2** – You can use an IAM role to manage temporary credentials for applications that are running on an EC2 instance and making AWS CLI or AWS API requests\. This is preferable to storing access keys within the EC2 instance\. To assign an AWS role to an EC2 instance and make it available to all of its applications, you create an instance profile that is attached to the instance\. An instance profile contains the role and enables programs that are running on the EC2 instance to get temporary credentials\. For more information, see [Using an IAM role to grant permissions to applications running on Amazon EC2 instances](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_use_switch-role-ec2.html) in the *IAM User Guide*\. - -To learn whether to use IAM roles, see [When to create an IAM role \(instead of a user\)](https://docs.aws.amazon.com/IAM/latest/UserGuide/id.html#id_which-to-choose_role) in the *IAM User Guide*\. - -## Managing access using policies - -You control access in AWS by creating policies and attaching them to IAM identities or AWS resources\. A policy is an object in AWS that, when associated with an identity or resource, defines their permissions\. AWS evaluates these policies when an entity \(root user, user, or IAM role\) makes a request\. Permissions in the policies determine whether the request is allowed or denied\. Most policies are stored in AWS as JSON documents\. For more information about the structure and contents of JSON policy documents, see [Overview of JSON policies](https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies.html#access_policies-json) in the *IAM User Guide*\. - -An administrator can use policies to specify who has access to AWS resources, and what actions they can perform on those resources\. Every IAM entity \(permission set or role\) starts with no permissions\. In other words, by default, users can do nothing, not even change their own password\. To give a user permission to do something, an administrator must attach a permissions policy to a user\. Or the administrator can add the user to a group that has the intended permissions\. When an administrator gives permissions to a group, all users in that group are granted those permissions\. - -IAM policies define permissions for an action regardless of the method that you use to perform the operation\. For example, suppose that you have a policy that allows the `iam:GetRole` action\. A user with that policy can get role information from the AWS Management Console, the AWS CLI, or the AWS API\. - -### Identity\-based policies - -Identity\-based policies are JSON permissions policy documents that you can attach to an identity, such as a permission set or role\. These policies control what actions that identity can perform, on which resources, and under what conditions\. To learn how to create an identity\-based policy, see [Creating IAM policies](https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies_create.html) in the *IAM User Guide*\. - -Identity\-based policies can be further categorized as *inline policies* or *managed policies*\. Inline policies are embedded directly into a single permission set or role\. Managed policies are standalone policies that you can attach to multiple permission sets and roles in your AWS account\. Managed policies include AWS managed policies and customer managed policies\. To learn how to choose between a managed policy or an inline policy, see [Choosing between managed policies and inline policies](https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies_managed-vs-inline.html#choosing-managed-or-inline) in the *IAM User Guide*\. - -For information about AWS managed policies that are specific to Amazon RDS, see [AWS managed policies for Amazon RDS](rds-security-iam-awsmanpol.md)\. - -### Other policy types - -AWS supports additional, less\-common policy types\. These policy types can set the maximum permissions granted to you by the more common policy types\. -+ **Permissions boundaries** – A permissions boundary is an advanced feature in which you set the maximum permissions that an identity\-based policy can grant to an IAM entity \(permission set or role\)\. You can set a permissions boundary for an entity\. The resulting permissions are the intersection of entity's identity\-based policies and its permissions boundaries\. Resource\-based policies that specify the permission set or role in the `Principal` field are not limited by the permissions boundary\. An explicit deny in any of these policies overrides the allow\. For more information about permissions boundaries, see [Permissions boundaries for IAM entities](https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies_boundaries.html) in the *IAM User Guide*\. -+ **Service control policies \(SCPs\)** – SCPs are JSON policies that specify the maximum permissions for an organization or organizational unit \(OU\) in AWS Organizations\. AWS Organizations is a service for grouping and centrally managing multiple AWS accounts that your business owns\. If you enable all features in an organization, then you can apply service control policies \(SCPs\) to any or all of your accounts\. The SCP limits permissions for entities in member accounts, including each AWS account root user\. For more information about Organizations and SCPs, see [How SCPs work](https://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_policies_about-scps.html) in the *AWS Organizations User Guide*\. -+ **Session policies** – Session policies are advanced policies that you pass as a parameter when you programmatically create a temporary session for a role or federated user\. The resulting session's permissions are the intersection of the permission sets or role's identity\-based policies and the session policies\. Permissions can also come from a resource\-based policy\. An explicit deny in any of these policies overrides the allow\. For more information, see [Session policies](https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies.html#policies_session) in the *IAM User Guide*\. - -### Multiple policy types - -When multiple types of policies apply to a request, the resulting permissions are more complicated to understand\. To learn how AWS determines whether to allow a request when multiple policy types are involved, see [Policy evaluation logic](https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies_evaluation-logic.html) in the *IAM User Guide*\. \ No newline at end of file diff --git a/doc_source/UsingWithRDS.IAMDBAuth.Connecting.AWSCLI.PostgreSQL.md b/doc_source/UsingWithRDS.IAMDBAuth.Connecting.AWSCLI.PostgreSQL.md deleted file mode 100644 index 966c3f8..0000000 --- a/doc_source/UsingWithRDS.IAMDBAuth.Connecting.AWSCLI.PostgreSQL.md +++ /dev/null @@ -1,77 +0,0 @@ -# Connecting to your DB instance using IAM authentication from the command line: AWS CLI and psql client - -You can connect from the command line to an Amazon RDS for PostgreSQL DB instance with the AWS CLI and psql command line tool as described following\. - -**Prerequisites** -The following are prerequisites for connecting to your DB instance using IAM authentication: -+ [Enabling and disabling IAM database authentication](UsingWithRDS.IAMDBAuth.Enabling.md) -+ [Creating and using an IAM policy for IAM database access](UsingWithRDS.IAMDBAuth.IAMPolicy.md) -+ [Creating a database account using IAM authentication](UsingWithRDS.IAMDBAuth.DBAccounts.md) - -**Note** -For information about connecting to your database using pgAdmin with IAM authentication, see the blog post [Using IAM authentication to connect with pgAdmin Amazon Aurora PostgreSQL or Amazon RDS for PostgreSQL](http://aws.amazon.com/blogs/database/using-iam-authentication-to-connect-with-pgadmin-amazon-aurora-postgresql-or-amazon-rds-for-postgresql/)\. - -**Topics** -+ [Generating an IAM authentication token](#UsingWithRDS.IAMDBAuth.Connecting.AWSCLI.AuthToken.PostgreSQL) -+ [Connecting to an Amazon RDS PostgreSQL instance](#UsingWithRDS.IAMDBAuth.Connecting.AWSCLI.Connect.PostgreSQL) - -## Generating an IAM authentication token - -The authentication token consists of several hundred characters so it can be unwieldy on the command line\. One way to work around this is to save the token to an environment variable, and then use that variable when you connect\. The following example shows how to use the AWS CLI to get a signed authentication token using the `generate-db-auth-token` command, and store it in a `PGPASSWORD` environment variable\. - -``` -export RDSHOST="rdspostgres.123456789012.us-west-2.rds.amazonaws.com" -export PGPASSWORD="$(aws rds generate-db-auth-token --hostname $RDSHOST --port 5432 --region us-west-2 --username jane_doe )" -``` - -In the example, the parameters to the `generate-db-auth-token` command are as follows: -+ `--hostname` – The host name of the DB instance that you want to access -+ `--port` – The port number used for connecting to your DB instance -+ `--region` – The AWS Region where the DB instance is running -+ `--username` – The database account that you want to access - -The first several characters of the generated token look like the following\. - -``` -rdspostgres.123456789012.us-west-2.rds.amazonaws.com:5432/?Action=connect&DBUser=jane_doe&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Expires=900... -``` - -**Note** -You cannot use a custom Route 53 DNS record instead of the DB instance endpoint to generate the authentication token\. - -## Connecting to an Amazon RDS PostgreSQL instance - -The general format for using psql to connect is shown following\. - -``` -psql "host=hostName port=portNumber sslmode=verify-full sslrootcert=full_path_to_ssl_certificate dbname=DBName user=userName password=authToken" -``` - -The parameters are as follows: -+ `host` – The host name of the DB instance that you want to access -+ `port` – The port number used for connecting to your DB instance -+ `sslmode` – The SSL mode to use - - When you use `sslmode=verify-full`, the SSL connection verifies the DB instance endpoint against the endpoint in the SSL certificate\. -+ `sslrootcert` – The full path to the SSL certificate file that contains the public key - - For more information, see [Using SSL with a PostgreSQL DB instance](PostgreSQL.Concepts.General.SSL.md)\. - - To download an SSL certificate, see [Using SSL/TLS to encrypt a connection to a DB instance](UsingWithRDS.SSL.md)\. -+ `dbname` – The database that you want to access -+ `user` – The database account that you want to access -+ `password` – A signed IAM authentication token - -**Note** -You cannot use a custom Route 53 DNS record instead of the DB instance endpoint to generate the authentication token\. - -The following example shows using psql to connect\. In the example, psql uses the environment variable `RDSHOST` for the host and the environment variable `PGPASSWORD` for the generated token\. Also, */sample\_dir/* is the full path to the SSL certificate file that contains the public key\. - -``` -export RDSHOST="rdspostgres.123456789012.us-west-2.rds.amazonaws.com" -export PGPASSWORD="$(aws rds generate-db-auth-token --hostname $RDSHOST --port 5432 --region us-west-2 --username jane_doe )" - -psql "host=$RDSHOST port=5432 sslmode=verify-full sslrootcert=/sample_dir/global-bundle.pem dbname=DBName user=jane_doe password=$PGPASSWORD" -``` - -If you want to connect to a DB instance through a proxy, see [Connecting to a proxy using IAM authentication](rds-proxy-setup.md#rds-proxy-connecting-iam)\. \ No newline at end of file diff --git a/doc_source/UsingWithRDS.IAMDBAuth.Connecting.AWSCLI.md b/doc_source/UsingWithRDS.IAMDBAuth.Connecting.AWSCLI.md deleted file mode 100644 index 856e0f8..0000000 --- a/doc_source/UsingWithRDS.IAMDBAuth.Connecting.AWSCLI.md +++ /dev/null @@ -1,98 +0,0 @@ -# Connecting to your DB instance using IAM authentication from the command line: AWS CLI and mysql client - -You can connect from the command line to an Amazon RDS DB instance with the AWS CLI and `mysql` command line tool as described following\. - -**Prerequisites** -The following are prerequisites for connecting to your DB instance using IAM authentication: -+ [Enabling and disabling IAM database authentication](UsingWithRDS.IAMDBAuth.Enabling.md) -+ [Creating and using an IAM policy for IAM database access](UsingWithRDS.IAMDBAuth.IAMPolicy.md) -+ [Creating a database account using IAM authentication](UsingWithRDS.IAMDBAuth.DBAccounts.md) - -**Note** -For information about connecting to your database using SQL Workbench/J with IAM authentication, see the blog post [Use IAM authentication to connect with SQL Workbench/J to Aurora MySQL or Amazon RDS for MySQL](http://aws.amazon.com/blogs/database/use-iam-authentication-to-connect-with-sql-workbenchj-to-amazon-aurora-mysql-or-amazon-rds-for-mysql/)\. - -**Topics** -+ [Generating an IAM authentication token](#UsingWithRDS.IAMDBAuth.Connecting.AWSCLI.AuthToken) -+ [Connecting to a DB instance](#UsingWithRDS.IAMDBAuth.Connecting.AWSCLI.Connect) - -## Generating an IAM authentication token - -The following example shows how to get a signed authentication token using the AWS CLI\. - -``` -aws rds generate-db-auth-token \ - --hostname rdsmysql.123456789012.us-west-2.rds.amazonaws.com \ - --port 3306 \ - --region us-west-2 \ - --username jane_doe -``` - -In the example, the parameters are as follows: -+ `--hostname` – The host name of the DB instance that you want to access -+ `--port` – The port number used for connecting to your DB instance -+ `--region` – The AWS Region where the DB instance is running -+ `--username` – The database account that you want to access - -The first several characters of the token look like the following\. - -``` -rdsmysql.123456789012.us-west-2.rds.amazonaws.com:3306/?Action=connect&DBUser=jane_doe&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Expires=900... -``` - -**Note** -You cannot use a custom Route 53 DNS record instead of the DB instance endpoint to generate the authentication token\. - -## Connecting to a DB instance - -The general format for connecting is shown following\. - -``` -mysql --host=hostName --port=portNumber --ssl-ca=full_path_to_ssl_certificate --enable-cleartext-plugin --user=userName --password=authToken -``` - -The parameters are as follows: -+ `--host` – The host name of the DB instance that you want to access -+ `--port` – The port number used for connecting to your DB instance -+ `--ssl-ca` – The full path to the SSL certificate file that contains the public key - - For more information about SSL/TLS support for MariaDB, see [Using SSL/TLS with a MariaDB DB instance](mariadb-ssl-connections.md#MariaDB.Concepts.SSLSupport)\. - - For more information about SSL/TLS support for MySQL, see [Using SSL/TLS with a MySQL DB instance](mysql-ssl-connections.md#MySQL.Concepts.SSLSupport)\. - - To download an SSL certificate, see [Using SSL/TLS to encrypt a connection to a DB instance](UsingWithRDS.SSL.md)\. -+ `--enable-cleartext-plugin` – A value that specifies that `AWSAuthenticationPlugin` must be used for this connection - - If you are using a MariaDB client, the `--enable-cleartext-plugin` option isn't required\. -+ `--user` – The database account that you want to access -+ `--password` – A signed IAM authentication token - -The authentication token consists of several hundred characters\. It can be unwieldy on the command line\. One way to work around this is to save the token to an environment variable, and then use that variable when you connect\. The following example shows one way to perform this workaround\. In the example, */sample\_dir/* is the full path to the SSL certificate file that contains the public key\. - -``` -RDSHOST="mysqldb.123456789012.us-east-1.rds.amazonaws.com" -TOKEN="$(aws rds generate-db-auth-token --hostname $RDSHOST --port 3306 --region us-west-2 --username jane_doe )" - -mysql --host=$RDSHOST --port=3306 --ssl-ca=/sample_dir/global-bundle.pem --enable-cleartext-plugin --user=jane_doe --password=$TOKEN -``` - -When you connect using `AWSAuthenticationPlugin`, the connection is secured using SSL\. To verify this, type the following at the `mysql>` command prompt\. - -``` -show status like 'Ssl%'; -``` - -The following lines in the output show more details\. - -``` -+---------------+-------------+ -| Variable_name | Value | -+---------------+-------------+ -| ... | ... -| Ssl_cipher | AES256-SHA | -| ... | ... -| Ssl_version | TLSv1.1 | -| ... | ... -+-----------------------------+ -``` - -If you want to connect to a DB instance through a proxy, see [Connecting to a proxy using IAM authentication](rds-proxy-setup.md#rds-proxy-connecting-iam)\. \ No newline at end of file diff --git a/doc_source/UsingWithRDS.IAMDBAuth.Connecting.Go.md b/doc_source/UsingWithRDS.IAMDBAuth.Connecting.Go.md deleted file mode 100644 index b2fd455..0000000 --- a/doc_source/UsingWithRDS.IAMDBAuth.Connecting.Go.md +++ /dev/null @@ -1,243 +0,0 @@ -# Connecting to your DB instance using IAM authentication and the AWS SDK for Go - -You can connect to an RDS for MariaDB, MySQL, or PostgreSQL DB instance with the AWS SDK for Go as described following\. - -**Prerequisites** -The following are prerequisites for connecting to your DB instance using IAM authentication: -+ [Enabling and disabling IAM database authentication](UsingWithRDS.IAMDBAuth.Enabling.md) -+ [Creating and using an IAM policy for IAM database access](UsingWithRDS.IAMDBAuth.IAMPolicy.md) -+ [Creating a database account using IAM authentication](UsingWithRDS.IAMDBAuth.DBAccounts.md) - -**Examples** -To run these code examples, you need the [AWS SDK for Go](http://aws.amazon.com/sdk-for-go/), found on the AWS site\. - -Modify the values of the following variables as needed: -+ `dbName` – The database that you want to access -+ `dbUser` – The database account that you want to access -+ `dbHost` – The endpoint of the DB instance that you want to access -**Note** -You cannot use a custom Route 53 DNS record instead of the DB instance endpoint to generate the authentication token\. -+ `dbPort` – The port number used for connecting to your DB instance -+ `region` – The AWS Region where the DB instance is running - -In addition, make sure the imported libraries in the sample code exist on your system\. - -**Important** -The examples in this section use the following code to provide credentials that access a database from a local environment: -`creds := credentials.NewEnvCredentials()` -If you are accessing a database from an AWS service, such as Amazon EC2 or Amazon ECS, you can replace the code with the following code: -`sess := session.Must(session.NewSession())` -`creds := sess.Config.Credentials` -If you make this change, make sure you add the following import: -`"github.com/aws/aws-sdk-go/aws/session"` - -**Topics** -+ [Connecting using IAM authentication and the AWS SDK for Go V2](#UsingWithRDS.IAMDBAuth.Connecting.GoV2) -+ [Connecting using IAM authentication and the AWS SDK for Go V1\.](#UsingWithRDS.IAMDBAuth.Connecting.GoV1) - -## Connecting using IAM authentication and the AWS SDK for Go V2 - -You can connect to a DB instance using IAM authentication and the AWS SDK for Go V2\. - -The following code examples show how to generate an authentication token, and then use it to connect to a DB instance\. - -This code connects to a MariaDB or MySQL DB instance\. - -``` -package main - -import ( - "context" - "database/sql" - "fmt" - - "github.com/aws/aws-sdk-go-v2/config" - "github.com/aws/aws-sdk-go-v2/feature/rds/auth" - _ "github.com/go-sql-driver/mysql" -) - -func main() { - - var dbName string = "DatabaseName" - var dbUser string = "DatabaseUser" - var dbHost string = "mysqldb.123456789012.us-east-1.rds.amazonaws.com" - var dbPort int = 3306 - var dbEndpoint string = fmt.Sprintf("%s:%d", dbHost, dbPort) - var region string = "us-east-1" - - cfg, err := config.LoadDefaultConfig(context.TODO()) - if err != nil { - panic("configuration error: " + err.Error()) - } - - authenticationToken, err := auth.BuildAuthToken( - context.TODO(), dbEndpoint, region, dbUser, cfg.Credentials) - if err != nil { - panic("failed to create authentication token: " + err.Error()) - } - - dsn := fmt.Sprintf("%s:%s@tcp(%s)/%s?tls=true&allowCleartextPasswords=true", - dbUser, authenticationToken, dbEndpoint, dbName, - ) - - db, err := sql.Open("mysql", dsn) - if err != nil { - panic(err) - } - - err = db.Ping() - if err != nil { - panic(err) - } -} -``` - -This code connects to a PostgreSQL DB instance\. - -``` -package main - -import ( - "context" - "database/sql" - "fmt" - - "github.com/aws/aws-sdk-go-v2/config" - "github.com/aws/aws-sdk-go-v2/feature/rds/auth" - _ "github.com/lib/pq" -) - -func main() { - - var dbName string = "DatabaseName" - var dbUser string = "DatabaseUser" - var dbHost string = "postgresmydb.123456789012.us-east-1.rds.amazonaws.com" - var dbPort int = 5432 - var dbEndpoint string = fmt.Sprintf("%s:%d", dbHost, dbPort) - var region string = "us-east-1" - - cfg, err := config.LoadDefaultConfig(context.TODO()) - if err != nil { - panic("configuration error: " + err.Error()) - } - - authenticationToken, err := auth.BuildAuthToken( - context.TODO(), dbEndpoint, region, dbUser, cfg.Credentials) - if err != nil { - panic("failed to create authentication token: " + err.Error()) - } - - dsn := fmt.Sprintf("host=%s port=%d user=%s password=%s dbname=%s", - dbHost, dbPort, dbUser, authenticationToken, dbName, - ) - - db, err := sql.Open("postgres", dsn) - if err != nil { - panic(err) - } - - err = db.Ping() - if err != nil { - panic(err) - } -} -``` - -If you want to connect to a DB instance through a proxy, see [Connecting to a proxy using IAM authentication](rds-proxy-setup.md#rds-proxy-connecting-iam)\. - -## Connecting using IAM authentication and the AWS SDK for Go V1\. - -You can connect to a DB instance using IAM authentication and the AWS SDK for Go V1 - -The following code examples show how to generate an authentication token, and then use it to connect to a DB instance\. - -This code connects to a MariaDB or MySQL DB instance\. - -``` -package main - -import ( - "database/sql" - "fmt" - "log" - - "github.com/aws/aws-sdk-go/aws/credentials" - "github.com/aws/aws-sdk-go/service/rds/rdsutils" - _ "github.com/go-sql-driver/mysql" -) - -func main() { - dbName := "app" - dbUser := "jane_doe" - dbHost := "mysqldb.123456789012.us-east-1.rds.amazonaws.com" - dbPort := 3306 - dbEndpoint := fmt.Sprintf("%s:%d", dbHost, dbPort) - region := "us-east-1" - - creds := credentials.NewEnvCredentials() - authToken, err := rdsutils.BuildAuthToken(dbEndpoint, region, dbUser, creds) - if err != nil { - panic(err) - } - - dsn := fmt.Sprintf("%s:%s@tcp(%s)/%s?tls=true&allowCleartextPasswords=true", - dbUser, authToken, dbEndpoint, dbName, - ) - - db, err := sql.Open("mysql", dsn) - if err != nil { - panic(err) - } - - err = db.Ping() - if err != nil { - panic(err) - } -} -``` - -This code connects to a PostgreSQL DB instance\. - -``` -package main - -import ( - "database/sql" - "fmt" - - "github.com/aws/aws-sdk-go/aws/credentials" - "github.com/aws/aws-sdk-go/service/rds/rdsutils" - _ "github.com/lib/pq" -) - -func main() { - dbName := "app" - dbUser := "jane_doe" - dbHost := "postgresmydb.123456789012.us-east-1.rds.amazonaws.com" - dbPort := 5432 - dbEndpoint := fmt.Sprintf("%s:%d", dbHost, dbPort) - region := "us-east-1" - - creds := credentials.NewEnvCredentials() - authToken, err := rdsutils.BuildAuthToken(dbEndpoint, region, dbUser, creds) - if err != nil { - panic(err) - } - - dsn := fmt.Sprintf("host=%s port=%d user=%s password=%s dbname=%s", - dbHost, dbPort, dbUser, authToken, dbName, - ) - - db, err := sql.Open("postgres", dsn) - if err != nil { - panic(err) - } - - err = db.Ping() - if err != nil { - panic(err) - } -} -``` - -If you want to connect to a DB instance through a proxy, see [Connecting to a proxy using IAM authentication](rds-proxy-setup.md#rds-proxy-connecting-iam)\. \ No newline at end of file diff --git a/doc_source/UsingWithRDS.IAMDBAuth.Connecting.Java.md b/doc_source/UsingWithRDS.IAMDBAuth.Connecting.Java.md deleted file mode 100644 index b2b079d..0000000 --- a/doc_source/UsingWithRDS.IAMDBAuth.Connecting.Java.md +++ /dev/null @@ -1,427 +0,0 @@ -# Connecting to your DB instance using IAM authentication and the AWS SDK for Java - -You can connect to an RDS for MariaDB, MySQL, or PostgreSQL DB instance with the AWS SDK for Java as described following\. - -**Prerequisites** -The following are prerequisites for connecting to your DB instance using IAM authentication: -+ [Enabling and disabling IAM database authentication](UsingWithRDS.IAMDBAuth.Enabling.md) -+ [Creating and using an IAM policy for IAM database access](UsingWithRDS.IAMDBAuth.IAMPolicy.md) -+ [Creating a database account using IAM authentication](UsingWithRDS.IAMDBAuth.DBAccounts.md) -+ [Set up the AWS SDK for Java](https://docs.aws.amazon.com/sdk-for-java/v1/developer-guide/setup-install.html) - -**Topics** -+ [Generating an IAM authentication token](#UsingWithRDS.IAMDBAuth.Connecting.Java.AuthToken) -+ [Manually constructing an IAM authentication token](#UsingWithRDS.IAMDBAuth.Connecting.Java.AuthToken2) -+ [Connecting to a DB instance](#UsingWithRDS.IAMDBAuth.Connecting.Java.AuthToken.Connect) - -## Generating an IAM authentication token - -If you are writing programs using the AWS SDK for Java, you can get a signed authentication token using the `RdsIamAuthTokenGenerator` class\. Using this class requires that you provide AWS credentials\. To do this, you create an instance of the `DefaultAWSCredentialsProviderChain` class\. `DefaultAWSCredentialsProviderChain` uses the first AWS access key and secret key that it finds in the [default credential provider chain](https://docs.aws.amazon.com/sdk-for-java/v1/developer-guide/credentials.html#credentials-default)\. For more information about AWS access keys, see [Managing access keys for users](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_access-keys.html)\. - -**Note** -You cannot use a custom Route 53 DNS record instead of the DB instance endpoint to generate the authentication token\. - -After you create an instance of `RdsIamAuthTokenGenerator`, you can call the `getAuthToken` method to obtain a signed token\. Provide the AWS Region, host name, port number, and user name\. The following code example illustrates how to do this\. - -``` -package com.amazonaws.codesamples; - -import com.amazonaws.auth.DefaultAWSCredentialsProviderChain; -import com.amazonaws.services.rds.auth.GetIamAuthTokenRequest; -import com.amazonaws.services.rds.auth.RdsIamAuthTokenGenerator; - -public class GenerateRDSAuthToken { - - public static void main(String[] args) { - - String region = "us-west-2"; - String hostname = "rdsmysql.123456789012.us-west-2.rds.amazonaws.com"; - String port = "3306"; - String username = "jane_doe"; - - System.out.println(generateAuthToken(region, hostname, port, username)); - } - - static String generateAuthToken(String region, String hostName, String port, String username) { - - RdsIamAuthTokenGenerator generator = RdsIamAuthTokenGenerator.builder() - .credentials(new DefaultAWSCredentialsProviderChain()) - .region(region) - .build(); - - String authToken = generator.getAuthToken( - GetIamAuthTokenRequest.builder() - .hostname(hostName) - .port(Integer.parseInt(port)) - .userName(username) - .build()); - - return authToken; - } - -} -``` - -## Manually constructing an IAM authentication token - -In Java, the easiest way to generate an authentication token is to use `RdsIamAuthTokenGenerator`\. This class creates an authentication token for you, and then signs it using AWS signature version 4\. For more information, see [Signature version 4 signing process](https://docs.aws.amazon.com/general/latest/gr/signature-version-4.html) in the *AWS General Reference\.* - -However, you can also construct and sign an authentication token manually, as shown in the following code example\. - -``` -package com.amazonaws.codesamples; - -import com.amazonaws.SdkClientException; -import com.amazonaws.auth.DefaultAWSCredentialsProviderChain; -import com.amazonaws.auth.SigningAlgorithm; -import com.amazonaws.util.BinaryUtils; -import org.apache.commons.lang3.StringUtils; - -import javax.crypto.Mac; -import javax.crypto.spec.SecretKeySpec; -import java.nio.charset.Charset; -import java.security.MessageDigest; -import java.text.SimpleDateFormat; -import java.util.Date; -import java.util.SortedMap; -import java.util.TreeMap; - -import static com.amazonaws.auth.internal.SignerConstants.AWS4_TERMINATOR; -import static com.amazonaws.util.StringUtils.UTF8; - -public class CreateRDSAuthTokenManually { - public static String httpMethod = "GET"; - public static String action = "connect"; - public static String canonicalURIParameter = "/"; - public static SortedMap canonicalQueryParameters = new TreeMap(); - public static String payload = StringUtils.EMPTY; - public static String signedHeader = "host"; - public static String algorithm = "AWS4-HMAC-SHA256"; - public static String serviceName = "rds-db"; - public static String requestWithoutSignature; - - public static void main(String[] args) throws Exception { - - String region = "us-west-2"; - String instanceName = "rdsmysql.123456789012.us-west-2.rds.amazonaws.com"; - String port = "3306"; - String username = "jane_doe"; - - Date now = new Date(); - String date = new SimpleDateFormat("yyyyMMdd").format(now); - String dateTimeStamp = new SimpleDateFormat("yyyyMMdd'T'HHmmss'Z'").format(now); - DefaultAWSCredentialsProviderChain creds = new DefaultAWSCredentialsProviderChain(); - String awsAccessKey = creds.getCredentials().getAWSAccessKeyId(); - String awsSecretKey = creds.getCredentials().getAWSSecretKey(); - String expiryMinutes = "900"; - - System.out.println("Step 1: Create a canonical request:"); - String canonicalString = createCanonicalString(username, awsAccessKey, date, dateTimeStamp, region, expiryMinutes, instanceName, port); - System.out.println(canonicalString); - System.out.println(); - - System.out.println("Step 2: Create a string to sign:"); - String stringToSign = createStringToSign(dateTimeStamp, canonicalString, awsAccessKey, date, region); - System.out.println(stringToSign); - System.out.println(); - - System.out.println("Step 3: Calculate the signature:"); - String signature = BinaryUtils.toHex(calculateSignature(stringToSign, newSigningKey(awsSecretKey, date, region, serviceName))); - System.out.println(signature); - System.out.println(); - - System.out.println("Step 4: Add the signing info to the request"); - System.out.println(appendSignature(signature)); - System.out.println(); - - } - - //Step 1: Create a canonical request date should be in format YYYYMMDD and dateTime should be in format YYYYMMDDTHHMMSSZ - public static String createCanonicalString(String user, String accessKey, String date, String dateTime, String region, String expiryPeriod, String hostName, String port) throws Exception { - canonicalQueryParameters.put("Action", action); - canonicalQueryParameters.put("DBUser", user); - canonicalQueryParameters.put("X-Amz-Algorithm", "AWS4-HMAC-SHA256"); - canonicalQueryParameters.put("X-Amz-Credential", accessKey + "%2F" + date + "%2F" + region + "%2F" + serviceName + "%2Faws4_request"); - canonicalQueryParameters.put("X-Amz-Date", dateTime); - canonicalQueryParameters.put("X-Amz-Expires", expiryPeriod); - canonicalQueryParameters.put("X-Amz-SignedHeaders", signedHeader); - String canonicalQueryString = ""; - while(!canonicalQueryParameters.isEmpty()) { - String currentQueryParameter = canonicalQueryParameters.firstKey(); - String currentQueryParameterValue = canonicalQueryParameters.remove(currentQueryParameter); - canonicalQueryString = canonicalQueryString + currentQueryParameter + "=" + currentQueryParameterValue; - if (!currentQueryParameter.equals("X-Amz-SignedHeaders")) { - canonicalQueryString += "&"; - } - } - String canonicalHeaders = "host:" + hostName + ":" + port + '\n'; - requestWithoutSignature = hostName + ":" + port + "/?" + canonicalQueryString; - - String hashedPayload = BinaryUtils.toHex(hash(payload)); - return httpMethod + '\n' + canonicalURIParameter + '\n' + canonicalQueryString + '\n' + canonicalHeaders + '\n' + signedHeader + '\n' + hashedPayload; - - } - - //Step 2: Create a string to sign using sig v4 - public static String createStringToSign(String dateTime, String canonicalRequest, String accessKey, String date, String region) throws Exception { - String credentialScope = date + "/" + region + "/" + serviceName + "/aws4_request"; - return algorithm + '\n' + dateTime + '\n' + credentialScope + '\n' + BinaryUtils.toHex(hash(canonicalRequest)); - - } - - //Step 3: Calculate signature - /** - * Step 3 of the &AWS; Signature version 4 calculation. It involves deriving - * the signing key and computing the signature. Refer to - * http://docs.aws.amazon - * .com/general/latest/gr/sigv4-calculate-signature.html - */ - public static byte[] calculateSignature(String stringToSign, - byte[] signingKey) { - return sign(stringToSign.getBytes(Charset.forName("UTF-8")), signingKey, - SigningAlgorithm.HmacSHA256); - } - - public static byte[] sign(byte[] data, byte[] key, - SigningAlgorithm algorithm) throws SdkClientException { - try { - Mac mac = algorithm.getMac(); - mac.init(new SecretKeySpec(key, algorithm.toString())); - return mac.doFinal(data); - } catch (Exception e) { - throw new SdkClientException( - "Unable to calculate a request signature: " - + e.getMessage(), e); - } - } - - public static byte[] newSigningKey(String secretKey, - String dateStamp, String regionName, String serviceName) { - byte[] kSecret = ("AWS4" + secretKey).getBytes(Charset.forName("UTF-8")); - byte[] kDate = sign(dateStamp, kSecret, SigningAlgorithm.HmacSHA256); - byte[] kRegion = sign(regionName, kDate, SigningAlgorithm.HmacSHA256); - byte[] kService = sign(serviceName, kRegion, - SigningAlgorithm.HmacSHA256); - return sign(AWS4_TERMINATOR, kService, SigningAlgorithm.HmacSHA256); - } - - public static byte[] sign(String stringData, byte[] key, - SigningAlgorithm algorithm) throws SdkClientException { - try { - byte[] data = stringData.getBytes(UTF8); - return sign(data, key, algorithm); - } catch (Exception e) { - throw new SdkClientException( - "Unable to calculate a request signature: " - + e.getMessage(), e); - } - } - - //Step 4: append the signature - public static String appendSignature(String signature) { - return requestWithoutSignature + "&X-Amz-Signature=" + signature; - } - - public static byte[] hash(String s) throws Exception { - try { - MessageDigest md = MessageDigest.getInstance("SHA-256"); - md.update(s.getBytes(UTF8)); - return md.digest(); - } catch (Exception e) { - throw new SdkClientException( - "Unable to compute hash while signing request: " - + e.getMessage(), e); - } - } -} -``` - -## Connecting to a DB instance - -The following code example shows how to generate an authentication token, and then use it to connect to an instance running MariaDB or MySQL\. - -To run this code example, you need the [AWS SDK for Java](http://aws.amazon.com/sdk-for-java/), found on the AWS site\. In addition, you need the following: -+ MySQL Connector/J\. This code example was tested with `mysql-connector-java-5.1.33-bin.jar`\. -+ An intermediate certificate for Amazon RDS that is specific to an AWS Region\. \(For more information, see [Using SSL/TLS to encrypt a connection to a DB instance](UsingWithRDS.SSL.md)\.\) At runtime, the class loader looks for the certificate in the same directory as this Java code example, so that the class loader can find it\. -+ Modify the values of the following variables as needed: - + `RDS_INSTANCE_HOSTNAME` – The host name of the DB instance that you want to access\. - + `RDS_INSTANCE_PORT` – The port number used for connecting to your PostgreSQL DB instance\. - + `REGION_NAME` – The AWS Region where the DB instance is running\. - + `DB_USER` – The database account that you want to access\. - + `SSL_CERTIFICATE` – An SSL certificate for Amazon RDS that is specific to an AWS Region\. - - To download a certificate for your AWS Region, see [Using SSL/TLS to encrypt a connection to a DB instance](UsingWithRDS.SSL.md)\. Place the SSL certificate in the same directory as this Java program file, so that the class loader can find the certificate at runtime\. - -This code example obtains AWS credentials from the [default credential provider chain](https://docs.aws.amazon.com/sdk-for-java/v1/developer-guide/credentials.html#credentials-default)\. - -``` -package com.amazonaws.samples; - -import com.amazonaws.services.rds.auth.RdsIamAuthTokenGenerator; -import com.amazonaws.services.rds.auth.GetIamAuthTokenRequest; -import com.amazonaws.auth.BasicAWSCredentials; -import com.amazonaws.auth.DefaultAWSCredentialsProviderChain; -import com.amazonaws.auth.AWSStaticCredentialsProvider; - -import java.io.File; -import java.io.FileOutputStream; -import java.io.InputStream; -import java.security.KeyStore; -import java.security.cert.CertificateFactory; -import java.security.cert.X509Certificate; - -import java.sql.Connection; -import java.sql.DriverManager; -import java.sql.ResultSet; -import java.sql.Statement; -import java.util.Properties; - -import java.net.URL; - -public class IAMDatabaseAuthenticationTester { - //&AWS; Credentials of the IAM user with policy enabling IAM Database Authenticated access to the db by the db user. - private static final DefaultAWSCredentialsProviderChain creds = new DefaultAWSCredentialsProviderChain(); - private static final String AWS_ACCESS_KEY = creds.getCredentials().getAWSAccessKeyId(); - private static final String AWS_SECRET_KEY = creds.getCredentials().getAWSSecretKey(); - - //Configuration parameters for the generation of the IAM Database Authentication token - private static final String RDS_INSTANCE_HOSTNAME = "rdsmysql.123456789012.us-west-2.rds.amazonaws.com"; - private static final int RDS_INSTANCE_PORT = 3306; - private static final String REGION_NAME = "us-west-2"; - private static final String DB_USER = "jane_doe"; - private static final String JDBC_URL = "jdbc:mysql://" + RDS_INSTANCE_HOSTNAME + ":" + RDS_INSTANCE_PORT; - - private static final String SSL_CERTIFICATE = "rds-ca-2019-us-west-2.pem"; - - private static final String KEY_STORE_TYPE = "JKS"; - private static final String KEY_STORE_PROVIDER = "SUN"; - private static final String KEY_STORE_FILE_PREFIX = "sys-connect-via-ssl-test-cacerts"; - private static final String KEY_STORE_FILE_SUFFIX = ".jks"; - private static final String DEFAULT_KEY_STORE_PASSWORD = "changeit"; - - public static void main(String[] args) throws Exception { - //get the connection - Connection connection = getDBConnectionUsingIam(); - - //verify the connection is successful - Statement stmt= connection.createStatement(); - ResultSet rs=stmt.executeQuery("SELECT 'Success!' FROM DUAL;"); - while (rs.next()) { - String id = rs.getString(1); - System.out.println(id); //Should print "Success!" - } - - //close the connection - stmt.close(); - connection.close(); - - clearSslProperties(); - - } - - /** - * This method returns a connection to the db instance authenticated using IAM Database Authentication - * @return - * @throws Exception - */ - private static Connection getDBConnectionUsingIam() throws Exception { - setSslProperties(); - return DriverManager.getConnection(JDBC_URL, setMySqlConnectionProperties()); - } - - /** - * This method sets the mysql connection properties which includes the IAM Database Authentication token - * as the password. It also specifies that SSL verification is required. - * @return - */ - private static Properties setMySqlConnectionProperties() { - Properties mysqlConnectionProperties = new Properties(); - mysqlConnectionProperties.setProperty("verifyServerCertificate","true"); - mysqlConnectionProperties.setProperty("useSSL", "true"); - mysqlConnectionProperties.setProperty("user",DB_USER); - mysqlConnectionProperties.setProperty("password",generateAuthToken()); - return mysqlConnectionProperties; - } - - /** - * This method generates the IAM Auth Token. - * An example IAM Auth Token would look like follows: - * btusi123.cmz7kenwo2ye.rds.cn-north-1.amazonaws.com.cn:3306/?Action=connect&DBUser=iamtestuser&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Date=20171003T010726Z&X-Amz-SignedHeaders=host&X-Amz-Expires=899&X-Amz-Credential=AKIAPFXHGVDI5RNFO4AQ%2F20171003%2Fcn-north-1%2Frds-db%2Faws4_request&X-Amz-Signature=f9f45ef96c1f770cdad11a53e33ffa4c3730bc03fdee820cfdf1322eed15483b - * @return - */ - private static String generateAuthToken() { - BasicAWSCredentials awsCredentials = new BasicAWSCredentials(AWS_ACCESS_KEY, AWS_SECRET_KEY); - - RdsIamAuthTokenGenerator generator = RdsIamAuthTokenGenerator.builder() - .credentials(new AWSStaticCredentialsProvider(awsCredentials)).region(REGION_NAME).build(); - return generator.getAuthToken(GetIamAuthTokenRequest.builder() - .hostname(RDS_INSTANCE_HOSTNAME).port(RDS_INSTANCE_PORT).userName(DB_USER).build()); - } - - /** - * This method sets the SSL properties which specify the key store file, its type and password: - * @throws Exception - */ - private static void setSslProperties() throws Exception { - System.setProperty("javax.net.ssl.trustStore", createKeyStoreFile()); - System.setProperty("javax.net.ssl.trustStoreType", KEY_STORE_TYPE); - System.setProperty("javax.net.ssl.trustStorePassword", DEFAULT_KEY_STORE_PASSWORD); - } - - /** - * This method returns the path of the Key Store File needed for the SSL verification during the IAM Database Authentication to - * the db instance. - * @return - * @throws Exception - */ - private static String createKeyStoreFile() throws Exception { - return createKeyStoreFile(createCertificate()).getPath(); - } - - /** - * This method generates the SSL certificate - * @return - * @throws Exception - */ - private static X509Certificate createCertificate() throws Exception { - CertificateFactory certFactory = CertificateFactory.getInstance("X.509"); - URL url = new File(SSL_CERTIFICATE).toURI().toURL(); - if (url == null) { - throw new Exception(); - } - try (InputStream certInputStream = url.openStream()) { - return (X509Certificate) certFactory.generateCertificate(certInputStream); - } - } - - /** - * This method creates the Key Store File - * @param rootX509Certificate - the SSL certificate to be stored in the KeyStore - * @return - * @throws Exception - */ - private static File createKeyStoreFile(X509Certificate rootX509Certificate) throws Exception { - File keyStoreFile = File.createTempFile(KEY_STORE_FILE_PREFIX, KEY_STORE_FILE_SUFFIX); - try (FileOutputStream fos = new FileOutputStream(keyStoreFile.getPath())) { - KeyStore ks = KeyStore.getInstance(KEY_STORE_TYPE, KEY_STORE_PROVIDER); - ks.load(null); - ks.setCertificateEntry("rootCaCertificate", rootX509Certificate); - ks.store(fos, DEFAULT_KEY_STORE_PASSWORD.toCharArray()); - } - return keyStoreFile; - } - - /** - * This method clears the SSL properties. - * @throws Exception - */ - private static void clearSslProperties() throws Exception { - System.clearProperty("javax.net.ssl.trustStore"); - System.clearProperty("javax.net.ssl.trustStoreType"); - System.clearProperty("javax.net.ssl.trustStorePassword"); - } - -} -``` - -If you want to connect to a DB instance through a proxy, see [Connecting to a proxy using IAM authentication](rds-proxy-setup.md#rds-proxy-connecting-iam)\. \ No newline at end of file diff --git a/doc_source/UsingWithRDS.IAMDBAuth.Connecting.NET.md b/doc_source/UsingWithRDS.IAMDBAuth.Connecting.NET.md deleted file mode 100644 index 4353d74..0000000 --- a/doc_source/UsingWithRDS.IAMDBAuth.Connecting.NET.md +++ /dev/null @@ -1,119 +0,0 @@ -# Connecting to your DB instance using IAM authentication and the AWS SDK for \.NET - -You can connect to an RDS for MariaDB, MySQL, or PostgreSQL DB instance with the AWS SDK for \.NET as described following\. - -**Prerequisites** -The following are prerequisites for connecting to your DB instance using IAM authentication: -+ [Enabling and disabling IAM database authentication](UsingWithRDS.IAMDBAuth.Enabling.md) -+ [Creating and using an IAM policy for IAM database access](UsingWithRDS.IAMDBAuth.IAMPolicy.md) -+ [Creating a database account using IAM authentication](UsingWithRDS.IAMDBAuth.DBAccounts.md) - -**Examples** -The following code examples show how to generate an authentication token, and then use it to connect to a DB instance\. - -To run this code example, you need the [AWS SDK for \.NET](http://aws.amazon.com/sdk-for-net/), found on the AWS site\. The `AWSSDK.CORE` and the `AWSSDK.RDS` packages are required\. To connect to a DB instance, use the \.NET database connector for the DB engine, such as MySqlConnector for MariaDB or MySQL, or Npgsql for PostgreSQL\. - -This code connects to a MariaDB or MySQL DB instance\. Modify the values of the following variables as needed: -+ `server` – The endpoint of the DB instance that you want to access -+ `user` – The database account that you want to access -+ `database` – The database that you want to access -+ `port` – The port number used for connecting to your DB instance -+ `SslMode` – The SSL mode to use - - When you use `SslMode=Required`, the SSL connection verifies the DB instance endpoint against the endpoint in the SSL certificate\. -+ `SslCa` – The full path to the SSL certificate for Amazon RDS - - To download a certificate, see [Using SSL/TLS to encrypt a connection to a DB instance](UsingWithRDS.SSL.md)\. - -**Note** -You cannot use a custom Route 53 DNS record instead of the DB instance endpoint to generate the authentication token\. - -``` -using System; -using System.Data; -using MySql.Data; -using MySql.Data.MySqlClient; -using Amazon; - -namespace ubuntu -{ - class Program - { - static void Main(string[] args) - { - var pwd = Amazon.RDS.Util.RDSAuthTokenGenerator.GenerateAuthToken(RegionEndpoint.USEast1, "mysqldb.123456789012.us-east-1.rds.amazonaws.com", 3306, "jane_doe"); - // for debug only Console.Write("{0}\n", pwd); //this verifies the token is generated - - MySqlConnection conn = new MySqlConnection($"server=mysqldb.123456789012.us-east-1.rds.amazonaws.com;user=jane_doe;database=mydB;port=3306;password={pwd};SslMode=Required;SslCa=full_path_to_ssl_certificate"); - conn.Open(); - - // Define a query - MySqlCommand sampleCommand = new MySqlCommand("SHOW DATABASES;", conn); - - // Execute a query - MySqlDataReader mysqlDataRdr = sampleCommand.ExecuteReader(); - - // Read all rows and output the first column in each row - while (mysqlDataRdr.Read()) - Console.WriteLine(mysqlDataRdr[0]); - - mysqlDataRdr.Close(); - // Close connection - conn.Close(); - } - } -} -``` - -This code connects to a PostgreSQL DB instance\. - -Modify the values of the following variables as needed: -+ `Server` – The endpoint of the DB instance that you want to access -+ `User ID` – The database account that you want to access -+ `Database` – The database that you want to access -+ `Port` – The port number used for connecting to your DB instance -+ `SSL Mode` – The SSL mode to use - - When you use `SSL Mode=Required`, the SSL connection verifies the DB instance endpoint against the endpoint in the SSL certificate\. -+ `Root Certificate` – The full path to the SSL certificate for Amazon RDS - - To download a certificate, see [Using SSL/TLS to encrypt a connection to a DB instance](UsingWithRDS.SSL.md)\. - -**Note** -You cannot use a custom Route 53 DNS record instead of the DB instance endpoint to generate the authentication token\. - -``` -using System; -using Npgsql; -using Amazon.RDS.Util; - -namespace ConsoleApp1 -{ - class Program - { - static void Main(string[] args) - { - var pwd = RDSAuthTokenGenerator.GenerateAuthToken("postgresmydb.123456789012.us-east-1.rds.amazonaws.com", 5432, "jane_doe"); -// for debug only Console.Write("{0}\n", pwd); //this verifies the token is generated - - NpgsqlConnection conn = new NpgsqlConnection($"Server=postgresmydb.123456789012.us-east-1.rds.amazonaws.com;User Id=jane_doe;Password={pwd};Database=mydb;SSL Mode=Require;Root Certificate=full_path_to_ssl_certificate"); - conn.Open(); - - // Define a query - NpgsqlCommand cmd = new NpgsqlCommand("select count(*) FROM pg_user", conn); - - // Execute a query - NpgsqlDataReader dr = cmd.ExecuteReader(); - - // Read all rows and output the first column in each row - while (dr.Read()) - Console.Write("{0}\n", dr[0]); - - // Close connection - conn.Close(); - } - } -} -``` - -If you want to connect to a DB instance through a proxy, see [Connecting to a proxy using IAM authentication](rds-proxy-setup.md#rds-proxy-connecting-iam)\. \ No newline at end of file diff --git a/doc_source/UsingWithRDS.IAMDBAuth.Connecting.Python.md b/doc_source/UsingWithRDS.IAMDBAuth.Connecting.Python.md deleted file mode 100644 index 3d25b10..0000000 --- a/doc_source/UsingWithRDS.IAMDBAuth.Connecting.Python.md +++ /dev/null @@ -1,98 +0,0 @@ -# Connecting to your DB instance using IAM authentication and the AWS SDK for Python \(Boto3\) - -You can connect to an RDS for MariaDB, MySQL, or PostgreSQL DB instance with the AWS SDK for Python \(Boto3\) as described following\. - -**Prerequisites** -The following are prerequisites for connecting to your DB instance using IAM authentication: -+ [Enabling and disabling IAM database authentication](UsingWithRDS.IAMDBAuth.Enabling.md) -+ [Creating and using an IAM policy for IAM database access](UsingWithRDS.IAMDBAuth.IAMPolicy.md) -+ [Creating a database account using IAM authentication](UsingWithRDS.IAMDBAuth.DBAccounts.md) - -In addition, make sure the imported libraries in the sample code exist on your system\. - -**Examples** -The code examples use profiles for shared credentials\. For information about the specifying credentials, see [Credentials](https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html) in the AWS SDK for Python \(Boto3\) documentation\. - -The following code examples show how to generate an authentication token, and then use it to connect to a DB instance\. - -To run this code example, you need the [AWS SDK for Python \(Boto3\)](http://aws.amazon.com/sdk-for-python/), found on the AWS site\. - -Modify the values of the following variables as needed: -+ `ENDPOINT` – The endpoint of the DB instance that you want to access -+ `PORT` – The port number used for connecting to your DB instance -+ `USER` – The database account that you want to access -+ `REGION` – The AWS Region where the DB instance is running -+ `DBNAME` – The database that you want to access -+ `SSLCERTIFICATE` – The full path to the SSL certificate for Amazon RDS - - For `ssl_ca`, specify an SSL certificate\. To download an SSL certificate, see [Using SSL/TLS to encrypt a connection to a DB instance](UsingWithRDS.SSL.md)\. - -**Note** -You cannot use a custom Route 53 DNS record instead of the DB instance endpoint to generate the authentication token\. - -This code connects to a MariaDB or MySQL DB instance\. - -Before running this code, install the PyMySQL driver by following the instructions in the [ Python Package Index](https://pypi.org/project/PyMySQL/)\. - -``` -import pymysql -import sys -import boto3 -import os - -ENDPOINT="mysqldb.123456789012.us-east-1.rds.amazonaws.com" -PORT="3306" -USER="jane_doe" -REGION="us-east-1" -DBNAME="mydb" -os.environ['LIBMYSQL_ENABLE_CLEARTEXT_PLUGIN'] = '1' - -#gets the credentials from .aws/credentials -session = boto3.Session(profile_name='default') -client = session.client('rds') - -token = client.generate_db_auth_token(DBHostname=ENDPOINT, Port=PORT, DBUsername=USER, Region=REGION) - -try: - conn = pymysql.connect(host=ENDPOINT, user=USER, passwd=token, port=PORT, database=DBNAME, ssl_ca='SSLCERTIFICATE') - cur = conn.cursor() - cur.execute("""SELECT now()""") - query_results = cur.fetchall() - print(query_results) -except Exception as e: - print("Database connection failed due to {}".format(e)) -``` - -This code connects to a PostgreSQL DB instance\. - -Before running this code, install `psycopg2` by following the instructions in [Psycopg documentation](https://pypi.org/project/psycopg2/)\. - -``` -import psycopg2 -import sys -import boto3 -import os - -ENDPOINT="postgresmydb.123456789012.us-east-1.rds.amazonaws.com" -PORT="5432" -USER="jane_doe" -REGION="us-east-1" -DBNAME="mydb" - -#gets the credentials from .aws/credentials -session = boto3.Session(profile_name='RDSCreds') -client = session.client('rds') - -token = client.generate_db_auth_token(DBHostname=ENDPOINT, Port=PORT, DBUsername=USER, Region=REGION) - -try: - conn = psycopg2.connect(host=ENDPOINT, port=PORT, database=DBNAME, user=USER, password=token, sslrootcert="SSLCERTIFICATE") - cur = conn.cursor() - cur.execute("""SELECT now()""") - query_results = cur.fetchall() - print(query_results) -except Exception as e: - print("Database connection failed due to {}".format(e)) -``` - -If you want to connect to a DB instance through a proxy, see [Connecting to a proxy using IAM authentication](rds-proxy-setup.md#rds-proxy-connecting-iam)\. \ No newline at end of file diff --git a/doc_source/UsingWithRDS.IAMDBAuth.Connecting.md b/doc_source/UsingWithRDS.IAMDBAuth.Connecting.md deleted file mode 100644 index bd62d25..0000000 --- a/doc_source/UsingWithRDS.IAMDBAuth.Connecting.md +++ /dev/null @@ -1,27 +0,0 @@ -# Connecting to your DB instance using IAM authentication - -With IAM database authentication, you use an authentication token when you connect to your DB instance\. An *authentication token* is a string of characters that you use instead of a password\. After you generate an authentication token, it's valid for 15 minutes before it expires\. If you try to connect using an expired token, the connection request is denied\. - -Every authentication token must be accompanied by a valid signature, using AWS signature version 4\. \(For more information, see [Signature Version 4 signing process](https://docs.aws.amazon.com/general/latest/gr/signature-version-4.html) in the* AWS General Reference\.*\) The AWS CLI and an AWS SDK, such as the AWS SDK for Java or AWS SDK for Python \(Boto3\), can automatically sign each token you create\. - -You can use an authentication token when you connect to Amazon RDS from another AWS service, such as AWS Lambda\. By using a token, you can avoid placing a password in your code\. Alternatively, you can use an AWS SDK to programmatically create and programmatically sign an authentication token\. - -After you have a signed IAM authentication token, you can connect to an Amazon RDS DB instance\. Following, you can find out how to do this using either a command line tool or an AWS SDK, such as the AWS SDK for Java or AWS SDK for Python \(Boto3\)\. - -For more information, see the following blog posts: -+ [Use IAM authentication to connect with SQL Workbench/J to Aurora MySQL or Amazon RDS for MySQL](http://aws.amazon.com/blogs/database/use-iam-authentication-to-connect-with-sql-workbenchj-to-amazon-aurora-mysql-or-amazon-rds-for-mysql/) -+ [Using IAM authentication to connect with pgAdmin Amazon Aurora PostgreSQL or Amazon RDS for PostgreSQL](http://aws.amazon.com/blogs/database/using-iam-authentication-to-connect-with-pgadmin-amazon-aurora-postgresql-or-amazon-rds-for-postgresql/) - -**Prerequisites** -The following are prerequisites for connecting to your DB instance using IAM authentication: -+ [Enabling and disabling IAM database authentication](UsingWithRDS.IAMDBAuth.Enabling.md) -+ [Creating and using an IAM policy for IAM database access](UsingWithRDS.IAMDBAuth.IAMPolicy.md) -+ [Creating a database account using IAM authentication](UsingWithRDS.IAMDBAuth.DBAccounts.md) - -**Topics** -+ [Connecting to your DB instance using IAM authentication from the command line: AWS CLI and mysql client](UsingWithRDS.IAMDBAuth.Connecting.AWSCLI.md) -+ [Connecting to your DB instance using IAM authentication from the command line: AWS CLI and psql client](UsingWithRDS.IAMDBAuth.Connecting.AWSCLI.PostgreSQL.md) -+ [Connecting to your DB instance using IAM authentication and the AWS SDK for \.NET](UsingWithRDS.IAMDBAuth.Connecting.NET.md) -+ [Connecting to your DB instance using IAM authentication and the AWS SDK for Go](UsingWithRDS.IAMDBAuth.Connecting.Go.md) -+ [Connecting to your DB instance using IAM authentication and the AWS SDK for Java](UsingWithRDS.IAMDBAuth.Connecting.Java.md) -+ [Connecting to your DB instance using IAM authentication and the AWS SDK for Python \(Boto3\)](UsingWithRDS.IAMDBAuth.Connecting.Python.md) \ No newline at end of file diff --git a/doc_source/UsingWithRDS.IAMDBAuth.DBAccounts.md b/doc_source/UsingWithRDS.IAMDBAuth.DBAccounts.md deleted file mode 100644 index c411311..0000000 --- a/doc_source/UsingWithRDS.IAMDBAuth.DBAccounts.md +++ /dev/null @@ -1,38 +0,0 @@ -# Creating a database account using IAM authentication - -With IAM database authentication, you don't need to assign database passwords to the user accounts you create\. If you remove a user that is mapped to a database account, you should also remove the database account with the `DROP USER` statement\. - -**Note** -The user name used for IAM authentication must match the case of the user name in the database\. - -**Topics** -+ [Using IAM authentication with MariaDB and MySQL](#UsingWithRDS.IAMDBAuth.DBAccounts.MySQL) -+ [Using IAM authentication with PostgreSQL](#UsingWithRDS.IAMDBAuth.DBAccounts.PostgreSQL) - -## Using IAM authentication with MariaDB and MySQL - -With MariaDB and MySQL, authentication is handled by `AWSAuthenticationPlugin`—an AWS\-provided plugin that works seamlessly with IAM to authenticate your users\. Connect to the DB instance as the master user or a different user who can create users and grant privileges\. After connecting, issue the `CREATE USER` statement, as shown in the following example\. - -``` -CREATE USER jane_doe IDENTIFIED WITH AWSAuthenticationPlugin AS 'RDS'; -``` - -The `IDENTIFIED WITH` clause allows MariaDB and MySQL to use the `AWSAuthenticationPlugin` to authenticate the database account \(`jane_doe`\)\. The `AS 'RDS'` clause refers to the authentication method\. Make sure the specified database user name is the same as a resource in the IAM policy for IAM database access\. For more information, see [Creating and using an IAM policy for IAM database access](UsingWithRDS.IAMDBAuth.IAMPolicy.md)\. - -**Note** -If you see the following message, it means that the AWS\-provided plugin is not available for the current DB instance\. -`ERROR 1524 (HY000): Plugin 'AWSAuthenticationPlugin' is not loaded` -To troubleshoot this error, verify that you are using a supported configuration and that you have enabled IAM database authentication on your DB instance\. For more information, see [Region and version availability](UsingWithRDS.IAMDBAuth.md#UsingWithRDS.IAMDBAuth.Availability) and [Enabling and disabling IAM database authentication](UsingWithRDS.IAMDBAuth.Enabling.md)\. - -After you create an account using `AWSAuthenticationPlugin`, you manage it in the same way as other database accounts\. For example, you can modify account privileges with `GRANT` and `REVOKE` statements, or modify various account attributes with the `ALTER USER` statement\. - -## Using IAM authentication with PostgreSQL - -To use IAM authentication with PostgreSQL, connect to the DB instance as the master user or a different user who can create users and grant privileges\. After connecting, create database users and then grant them the `rds_iam` role as shown in the following example\. - -``` -CREATE USER db_userx; -GRANT rds_iam TO db_userx; -``` - -Make sure the specified database user name is the same as a resource in the IAM policy for IAM database access\. For more information, see [Creating and using an IAM policy for IAM database access](UsingWithRDS.IAMDBAuth.IAMPolicy.md)\. \ No newline at end of file diff --git a/doc_source/UsingWithRDS.IAMDBAuth.Enabling.md b/doc_source/UsingWithRDS.IAMDBAuth.Enabling.md deleted file mode 100644 index 08ad72d..0000000 --- a/doc_source/UsingWithRDS.IAMDBAuth.Enabling.md +++ /dev/null @@ -1,87 +0,0 @@ -# Enabling and disabling IAM database authentication - -By default, IAM database authentication is disabled on DB instances\. You can enable or disable IAM database authentication using the AWS Management Console, AWS CLI, or the API\. - -You can enable IAM database authentication when you perform one of the following actions: -+ To create a new DB instance with IAM database authentication enabled, see [Creating an Amazon RDS DB instance](USER_CreateDBInstance.md)\. -+ To modify a DB instance to enable IAM database authentication, see [Modifying an Amazon RDS DB instance](Overview.DBInstance.Modifying.md)\. -+ To restore a DB instance from a snapshot with IAM database authentication enabled, see [Restoring from a DB snapshot](USER_RestoreFromSnapshot.md)\. -+ To restore a DB instance to a point in time with IAM database authentication enabled, see [Restoring a DB instance to a specified time](USER_PIT.md)\. - -IAM authentication for PostgreSQL DB instances requires that the SSL value be 1\. You can't enable IAM authentication for a PostgreSQL DB instance if the SSL value is 0\. You can't change the SSL value to 0 if IAM authentication is enabled for a PostgreSQL DB instance\. - -## Console - -Each creation or modification workflow has a **Database authentication** section, where you can enable or disable IAM database authentication\. In that section, choose **Password and IAM database authentication** to enable IAM database authentication\. - -**To enable or disable IAM database authentication for an existing DB instance** - -1. Open the Amazon RDS console at [https://console\.aws\.amazon\.com/rds/](https://console.aws.amazon.com/rds/)\. - -1. In the navigation pane, choose **Databases**\. - -1. Choose the DB instance that you want to modify\. -**Note** - Make sure that the DB instance is compatible with IAM authentication\. Check the compatibility requirements in [Region and version availability](UsingWithRDS.IAMDBAuth.md#UsingWithRDS.IAMDBAuth.Availability)\. - -1. Choose **Modify**\. - -1. In the **Database authentication** section, choose **Password and IAM database authentication** to enable IAM database authentication\. - -1. Choose **Continue**\. - -1. To apply the changes immediately, choose **Immediately** in the **Scheduling of modifications** section\. - -1. Choose **Modify DB instance** \. - -## AWS CLI - -To create a new DB instance with IAM authentication by using the AWS CLI, use the [https://docs.aws.amazon.com/cli/latest/reference/rds/create-db-instance.html](https://docs.aws.amazon.com/cli/latest/reference/rds/create-db-instance.html) command\. Specify the `--enable-iam-database-authentication` option, as shown in the following example\. - -``` -aws rds create-db-instance \ - --db-instance-identifier mydbinstance \ - --db-instance-class db.m3.medium \ - --engine MySQL \ - --allocated-storage 20 \ - --master-username masterawsuser \ - --master-user-password masteruserpassword \ - --enable-iam-database-authentication -``` - -To update an existing DB instance to have or not have IAM authentication, use the AWS CLI command [https://docs.aws.amazon.com/cli/latest/reference/rds/modify-db-instance.html](https://docs.aws.amazon.com/cli/latest/reference/rds/modify-db-instance.html)\. Specify either the `--enable-iam-database-authentication` or `--no-enable-iam-database-authentication` option, as appropriate\. - -**Note** - Make sure that the DB instance is compatible with IAM authentication\. Check the compatibility requirements in [Region and version availability](UsingWithRDS.IAMDBAuth.md#UsingWithRDS.IAMDBAuth.Availability)\. - -By default, Amazon RDS performs the modification during the next maintenance window\. If you want to override this and enable IAM DB authentication as soon as possible, use the `--apply-immediately` parameter\. - -The following example shows how to immediately enable IAM authentication for an existing DB instance\. - -``` -aws rds modify-db-instance \ - --db-instance-identifier mydbinstance \ - --apply-immediately \ - --enable-iam-database-authentication -``` - -If you are restoring a DB instance, use one of the following AWS CLI commands: -+ `[restore\-db\-instance\-to\-point\-in\-time](https://docs.aws.amazon.com/cli/latest/reference/rds/restore-db-instance-to-point-in-time.html)` -+ `[restore\-db\-instance\-from\-db\-snapshot](https://docs.aws.amazon.com/cli/latest/reference/rds/restore-db-instance-from-db-snapshot.html)` - -The IAM database authentication setting defaults to that of the source snapshot\. To change this setting, set the `--enable-iam-database-authentication` or `--no-enable-iam-database-authentication` option, as appropriate\. - -## RDS API - -To create a new DB instance with IAM authentication by using the API, use the API operation [https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_CreateDBInstance.html](https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_CreateDBInstance.html)\. Set the `EnableIAMDatabaseAuthentication` parameter to `true`\. - -To update an existing DB instance to have IAM authentication, use the API operation [https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_ModifyDBInstance.html](https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_ModifyDBInstance.html)\. Set the `EnableIAMDatabaseAuthentication` parameter to `true` to enable IAM authentication, or `false` to disable it\. - -**Note** - Make sure that the DB instance is compatible with IAM authentication\. Check the compatibility requirements in [Region and version availability](UsingWithRDS.IAMDBAuth.md#UsingWithRDS.IAMDBAuth.Availability)\. - -If you are restoring a DB instance, use one of the following API operations: -+ [https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_RestoreDBInstanceFromDBSnapshot.html](https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_RestoreDBInstanceFromDBSnapshot.html) -+ [https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_RestoreDBInstanceToPointInTime.html](https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_RestoreDBInstanceToPointInTime.html) - -The IAM database authentication setting defaults to that of the source snapshot\. To change this setting, set the `EnableIAMDatabaseAuthentication` parameter to `true` to enable IAM authentication, or `false` to disable it\. \ No newline at end of file diff --git a/doc_source/UsingWithRDS.IAMDBAuth.IAMPolicy.md b/doc_source/UsingWithRDS.IAMDBAuth.IAMPolicy.md deleted file mode 100644 index 28aa26e..0000000 --- a/doc_source/UsingWithRDS.IAMDBAuth.IAMPolicy.md +++ /dev/null @@ -1,136 +0,0 @@ -# Creating and using an IAM policy for IAM database access - -To allow a user or role to connect to your DB instance, you must create an IAM policy\. After that, you attach the policy to a permissions set or role\. - -**Note** -To learn more about IAM policies, see [Identity and access management for Amazon RDS](UsingWithRDS.IAM.md)\. - -The following example policy allows a user to connect to a DB instance using IAM database authentication\. - -``` - 1. { - 2. "Version": "2012-10-17", - 3. "Statement": [ - 4. { - 5. "Effect": "Allow", - 6. "Action": [ - 7. "rds-db:connect" - 8. ], - 9. "Resource": [ -10. "arn:aws:rds-db:us-east-2:1234567890:dbuser:db-ABCDEFGHIJKL01234/db_user" -11. ] -12. } -13. ] -14. } -``` - -**Important** -A user with administrator permissions can access DB instances without explicit permissions in an IAM policy\. If you want to restrict administrator access to DB instances, you can create an IAM role with the appropriate, lesser privileged permissions and assign it to the administrator\. - -**Note** -Don't confuse the `rds-db:` prefix with other RDS API operation prefixes that begin with `rds:`\. You use the `rds-db:` prefix and the `rds-db:connect` action only for IAM database authentication\. They aren't valid in any other context\. - -The example policy includes a single statement with the following elements: -+ `Effect` – Specify `Allow` to grant access to the DB instance\. If you don't explicitly allow access, then access is denied by default\. -+ `Action` – Specify `rds-db:connect` to allow connections to the DB instance\. -+ `Resource` – Specify an Amazon Resource Name \(ARN\) that describes one database account in one DB instance\. The ARN format is as follows\. - - ``` - arn:aws:rds-db:region:account-id:dbuser:DbiResourceId/db-user-name - ``` - - In this format, replace the following: - + `region` is the AWS Region for the DB instance\. In the example policy, the AWS Region is `us-east-2`\. - + `account-id` is the AWS account number for the DB instance\. In the example policy, the account number is `1234567890`\. The user must be in the same account as the account for the DB instance\. - - To perform cross\-account access, create an IAM role with the policy shown above in the account for the DB instance and allow your other account to assume the role\. - + `DbiResourceId` is the identifier for the DB instance\. This identifier is unique to an AWS Region and never changes\. In the example policy, the identifier is `db-ABCDEFGHIJKL01234`\. - - To find a DB instance resource ID in the AWS Management Console for Amazon RDS, choose the DB instance to see its details\. Then choose the **Configuration** tab\. The **Resource ID** is shown in the **Configuration** section\. - - Alternatively, you can use the AWS CLI command to list the identifiers and resource IDs for all of your DB instance in the current AWS Region, as shown following\. - - ``` - aws rds describe-db-instances --query "DBInstances[*].[DBInstanceIdentifier,DbiResourceId]" - ``` - - If you are using Amazon Aurora, specify a `DbClusterResourceId` instead of a `DbiResourceId`\. For more information, see [ Creating and using an IAM policy for IAM database access](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/UsingWithRDS.IAMDBAuth.IAMPolicy.html) in the *Amazon Aurora User Guide*\. -**Note** -If you are connecting to a database through RDS Proxy, specify the proxy resource ID, such as `prx-ABCDEFGHIJKL01234`\. For information about using IAM database authentication with RDS Proxy, see [Connecting to a proxy using IAM authentication](rds-proxy-setup.md#rds-proxy-connecting-iam)\. - + `db-user-name` is the name of the database account to associate with IAM authentication\. In the example policy, the database account is `db_user`\. - -You can construct other ARNs to support various access patterns\. The following policy allows access to two different database accounts in a DB instance\. - -``` - 1. { - 2. "Version": "2012-10-17", - 3. "Statement": [ - 4. { - 5. "Effect": "Allow", - 6. "Action": [ - 7. "rds-db:connect" - 8. ], - 9. "Resource": [ -10. "arn:aws:rds-db:us-east-2:123456789012:dbuser:db-ABCDEFGHIJKL01234/jane_doe", -11. "arn:aws:rds-db:us-east-2:123456789012:dbuser:db-ABCDEFGHIJKL01234/mary_roe" -12. ] -13. } -14. ] -15. } -``` - -The following policy uses the "\*" character to match all DB instances and database accounts for a particular AWS account and AWS Region\. - -``` - 1. { - 2. "Version": "2012-10-17", - 3. "Statement": [ - 4. { - 5. "Effect": "Allow", - 6. "Action": [ - 7. "rds-db:connect" - 8. ], - 9. "Resource": [ -10. "arn:aws:rds-db:us-east-2:1234567890:dbuser:*/*" -11. ] -12. } -13. ] -14. } -``` - -The following policy matches all of the DB instances for a particular AWS account and AWS Region\. However, the policy only grants access to DB instances that have a `jane_doe` database account\. - -``` - 1. { - 2. "Version": "2012-10-17", - 3. "Statement": [ - 4. { - 5. "Effect": "Allow", - 6. "Action": [ - 7. "rds-db:connect" - 8. ], - 9. "Resource": [ -10. "arn:aws:rds-db:us-east-2:123456789012:dbuser:*/jane_doe" -11. ] -12. } -13. ] -14. } -``` - -The user or role has access to only those databases that the database user does\. For example, suppose that your DB instance has a database named *dev*, and another database named *test*\. If the database user `jane_doe` has access only to *dev*, any users or roles that access that DB instance with the `jane_doe` user also have access only to *dev*\. This access restriction is also true for other database objects, such as tables, views, and so on\. - -An administrator must create IAM policies that grant entities permission to perform specific API operations on the specified resources they need\. The administrator must then attach those policies to the permission sets or roles that require those permissions\. For examples of policies, see [Identity\-based policy examples for Amazon RDS](security_iam_id-based-policy-examples.md)\. - -## Attaching an IAM policy to a permission set or role - -After you create an IAM policy to allow database authentication, you need to attach the policy to a permission set or role\. For a tutorial on this topic, see [ Create and attach your first customer managed policy](https://docs.aws.amazon.com/IAM/latest/UserGuide/tutorial_managed-policies.html) in the *IAM User Guide*\. - -As you work through the tutorial, you can use one of the policy examples shown in this section as a starting point and tailor it to your needs\. At the end of the tutorial, you have a permission set with an attached policy that can make use of the `rds-db:connect` action\. - -**Note** -You can map multiple permission sets or roles to the same database user account\. For example, suppose that your IAM policy specified the following resource ARN\. - -``` -arn:aws:rds-db:us-east-2:123456789012:dbuser:db-12ABC34DEFG5HIJ6KLMNOP78QR/jane_doe -``` -If you attach the policy to *Jane*, *Bob*, and *Diego*, then each of those users can connect to the specified DB instance using the `jane_doe` database account\. \ No newline at end of file diff --git a/doc_source/UsingWithRDS.IAMDBAuth.md b/doc_source/UsingWithRDS.IAMDBAuth.md deleted file mode 100644 index f6e020f..0000000 --- a/doc_source/UsingWithRDS.IAMDBAuth.md +++ /dev/null @@ -1,75 +0,0 @@ -# IAM database authentication for MariaDB, MySQL, and PostgreSQL - -You can authenticate to your DB instance using AWS Identity and Access Management \(IAM\) database authentication\. IAM database authentication works with MariaDB, MySQL, and PostgreSQL\. With this authentication method, you don't need to use a password when you connect to a DB instance\. Instead, you use an authentication token\. - -An *authentication token* is a unique string of characters that Amazon RDS generates on request\. Authentication tokens are generated using AWS Signature Version 4\. Each token has a lifetime of 15 minutes\. You don't need to store user credentials in the database, because authentication is managed externally using IAM\. You can also still use standard database authentication\. The token is only used for authentication and doesn't affect the session after it is established\. - -IAM database authentication provides the following benefits: -+ Network traffic to and from the database is encrypted using Secure Socket Layer \(SSL\) or Transport Layer Security \(TLS\)\. For more information about using SSL/TLS with Amazon RDS, see [Using SSL/TLS to encrypt a connection to a DB instance](UsingWithRDS.SSL.md)\. -+ You can use IAM to centrally manage access to your database resources, instead of managing access individually on each DB instance\. -+ For applications running on Amazon EC2, you can use profile credentials specific to your EC2 instance to access your database instead of a password, for greater security\. - -In general, consider using IAM database authentication when your applications create fewer than 200 connections per second, and you don't want to manage usernames and passwords directly in your application code\. - -The AWS JDBC Driver for MySQL supports IAM database authentication\. For more information, see [AWS IAM Database Authentication](https://github.com/awslabs/aws-mysql-jdbc#aws-iam-database-authentication) in the AWS JDBC Driver for MySQL GitHub repository\. - -**Topics** -+ [Region and version availability](#UsingWithRDS.IAMDBAuth.Availability) -+ [CLI and SDK support](#UsingWithRDS.IAMDBAuth.cli-sdk) -+ [Limitations for IAM database authentication](#UsingWithRDS.IAMDBAuth.Limitations) -+ [Recommendations for IAM database authentication](#UsingWithRDS.IAMDBAuth.ConnectionsPerSecond) -+ [Unsupported AWS global condition context keys](#UsingWithRDS.IAMDBAuth.GlobalContextKeys) -+ [Enabling and disabling IAM database authentication](UsingWithRDS.IAMDBAuth.Enabling.md) -+ [Creating and using an IAM policy for IAM database access](UsingWithRDS.IAMDBAuth.IAMPolicy.md) -+ [Creating a database account using IAM authentication](UsingWithRDS.IAMDBAuth.DBAccounts.md) -+ [Connecting to your DB instance using IAM authentication](UsingWithRDS.IAMDBAuth.Connecting.md) - -## Region and version availability - -Feature availability and support varies across specific versions of each database engine, and across AWS Regions\. For more information on version and Region availability with Amazon RDS and IAM database authentication, see [IAM database authentication](Concepts.RDS_Fea_Regions_DB-eng.Feature.IamDatabaseAuthentication.md)\. - -## CLI and SDK support - -IAM database authentication is available for the [AWS CLI](https://docs.aws.amazon.com/cli/latest/reference/rds/generate-db-auth-token.html) and for the following language\-specific AWS SDKs: -+ [AWS SDK for \.NET](https://docs.aws.amazon.com/sdkfornet/v3/apidocs/items/RDS/TRDSAuthTokenGenerator.html) -+ [AWS SDK for C\+\+](https://sdk.amazonaws.com/cpp/api/LATEST/class_aws_1_1_r_d_s_1_1_r_d_s_client.html#ae134ffffed5d7672f6156d324e7bd392) -+ [AWS SDK for Go](https://docs.aws.amazon.com/sdk-for-go/api/service/rds/#pkg-overview) -+ [AWS SDK for Java](https://docs.aws.amazon.com/sdk-for-java/latest/reference/software/amazon/awssdk/services/rds/RdsUtilities.html) -+ [AWS SDK for JavaScript](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/modules/_aws_sdk_rds_signer.html) -+ [AWS SDK for PHP](https://docs.aws.amazon.com/aws-sdk-php/v3/api/class-Aws.Rds.AuthTokenGenerator.html) -+ [AWS SDK for Python \(Boto3\)](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/rds.html#RDS.Client.generate_db_auth_token) -+ [AWS SDK for Ruby](https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/RDS/AuthTokenGenerator.html) - -## Limitations for IAM database authentication - -When using IAM database authentication, the following limitations apply: -+ The maximum number of connections per second for your DB instance might be limited depending on its DB instance class and your workload\. -+ Currently, IAM database authentication doesn't support all global condition context keys\. - - For more information about global condition context keys, see [AWS global condition context keys](https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies_condition-keys.html) in the *IAM User Guide*\. -+ For PostgreSQL, if the IAM role \(`rds_iam`\) is added to a user \(including the RDS master user\), IAM authentication takes precedence over password authentication, so the user must log in as an IAM user\. -+ For PostgreSQL, Amazon RDS does not support enabling both IAM and Kerberos authentication methods at the same time\. -+ For PostgreSQL, you cannot use IAM authentication to establish a replication connection\. - -## Recommendations for IAM database authentication - -We recommend the following when using IAM database authentication: -+ Use IAM database authentication when your application requires fewer than 200 new IAM database authentication connections per second\. - - The database engines that work with Amazon RDS don't impose any limits on authentication attempts per second\. However, when you use IAM database authentication, your application must generate an authentication token\. Your application then uses that token to connect to the DB instance\. If you exceed the limit of maximum new connections per second, then the extra overhead of IAM database authentication can cause connection throttling\. - - Consider using connection pooling in your applications to mitigate constant connection creation\. This can reduce the overhead from IAM DB authentication and allow your applications to reuse existing connections\. Alternatively, consider using RDS Proxy for these use cases\. RDS Proxy has additional costs\. See [RDS Proxy pricing](http://aws.amazon.com/rds/proxy/pricing/)\. -+ The size of an IAM database authentication token depends on many things including the number of IAM tags, IAM service policies, ARN lengths, as well as other IAM and database properties\. The minimum size of this token is generally about 1 KB but can be larger\. Since this token is used as the password in the connection string to the database using IAM authentication, you should ensure that your database driver \(e\.g\., ODBC\) and/or any tools do not limit or otherwise truncate this token due to its size\. A truncated token will cause the authentication validation done by the database and IAM to fail\. -+ If you are using temporary credentials when creating an IAM database authentication token, the temporary credentials must still be valid when using the IAM database authentication token to make a connection request\. - -## Unsupported AWS global condition context keys - - IAM database authentication does not support the following subset of AWS global condition context keys\. -+ `aws:Referer` -+ `aws:SourceIp` -+ `aws:SourceVpc` -+ `aws:SourceVpce` -+ `aws:UserAgent` -+ `aws:VpcSourceIp` - -For more information, see [AWS global condition context keys](https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies_condition-keys.html) in the *IAM User Guide*\. \ No newline at end of file diff --git a/doc_source/UsingWithRDS.MasterAccounts.md b/doc_source/UsingWithRDS.MasterAccounts.md deleted file mode 100644 index 26c6980..0000000 --- a/doc_source/UsingWithRDS.MasterAccounts.md +++ /dev/null @@ -1,19 +0,0 @@ -# Master user account privileges - -When you create a new DB instance, the default master user that you use gets certain privileges for that DB instance\. You can't change the master user name after the DB instance is created\. - -**Important** -We strongly recommend that you do not use the master user directly in your applications\. Instead, adhere to the best practice of using a database user created with the minimal privileges required for your application\. - -**Note** -If you accidentally delete the permissions for the master user, you can restore them by modifying the DB instance and setting a new master user password\. For more information about modifying a DB instance, see [Modifying an Amazon RDS DB instance](Overview.DBInstance.Modifying.md)\. - -The following table shows the privileges and database roles the master user gets for each of the database engines\. - - -| Database engine | System privilege | Database role | -| --- | --- | --- | -| MySQL and MariaDB | `SELECT`, `INSERT`, `UPDATE`, `DELETE`, `CREATE`, `DROP`, `RELOAD`, `PROCESS`, `REFERENCES`, `INDEX`, `ALTER`, `SHOW DATABASES`, `CREATE TEMPORARY TABLES`, `LOCK TABLES`, `EXECUTE`, `REPLICATION CLIENT`, `CREATE VIEW`, `SHOW VIEW`, `CREATE ROUTINE`, `ALTER ROUTINE`, `CREATE USER`, `EVENT`, `TRIGGER ON *.* WITH GRANT OPTION`, `REPLICATION SLAVE` | — | -| PostgreSQL | `CREATE ROLE`, `CREATE DB`, `PASSWORD VALID UNTIL INFINITY`, `CREATE EXTENSION`, `ALTER EXTENSION`, `DROP EXTENSION`, `CREATE TABLESPACE`, `ALTER OWNER`, `CHECKPOINT`, `PG_CANCEL_BACKEND()`, `PG_TERMINATE_BACKEND()`, `SELECT PG_STAT_REPLICATION`, `EXECUTE PG_STAT_STATEMENTS_RESET()`, `OWN POSTGRES_FDW_HANDLER()`, `OWN POSTGRES_FDW_VALIDATOR()`, `OWN POSTGRES_FDW`, `EXECUTE PG_BUFFERCACHE_PAGES()`, `SELECT PG_BUFFERCACHE` | `RDS_SUPERUSER` For more information about RDS\_SUPERUSER, see [Understanding PostgreSQL roles and permissions](Appendix.PostgreSQL.CommonDBATasks.Roles.md)\. | -| Oracle | `ALTER DATABASE LINK`, `ALTER PUBLIC DATABASE LINK`, `DROP ANY DIRECTORY`, `EXEMPT ACCESS POLICY`, `EXEMPT IDENTITY POLICY`, `GRANT ANY OBJECT PRIVILEGE`, `RESTRICTED SESSION`, `EXEMPT REDACTION POLICY` | `AQ_ADMINISTRATOR_ROLE`, `AQ_USER_ROLE`, `CONNECT`, `CTXAPP`, `DBA`, `EXECUTE_CATALOG_ROLE`, `RECOVERY_CATALOG_OWNER`, `RESOURCE`, `SELECT_CATALOG_ROLE` | -| Microsoft SQL Server | `ADMINISTER BULK OPERATIONS`, `ALTER ANY CONNECTION`, `ALTER ANY CREDENTIAL`, `ALTER ANY EVENT SESSION`, `ALTER ANY LINKED SERVER`, `ALTER ANY LOGIN`, `ALTER ANY SERVER AUDIT`, `ALTER ANY SERVER ROLE`, `ALTER SERVER STATE`, `ALTER TRACE`, `CONNECT SQL`, `CREATE ANY DATABASE`, `VIEW ANY DATABASE`, `VIEW ANY DEFINITION`, `VIEW SERVER STATE`, `ALTER ON ROLE SQLAgentOperatorRole` | `DB_OWNER` \(database\-level role\), `PROCESSADMIN` \(server\-level role\), `SETUPADMIN` \(server\-level role\), `SQLAgentUserRole` \(database\-level role\) | \ No newline at end of file diff --git a/doc_source/UsingWithRDS.SSL-certificate-rotation.md b/doc_source/UsingWithRDS.SSL-certificate-rotation.md deleted file mode 100644 index efadd0a..0000000 --- a/doc_source/UsingWithRDS.SSL-certificate-rotation.md +++ /dev/null @@ -1,252 +0,0 @@ -# Rotating your SSL/TLS certificate - -As of March 5, 2020, Amazon RDS CA\-2015 certificates have expired\. If you use or plan to use Secure Sockets Layer \(SSL\) or Transport Layer Security \(TLS\) with certificate verification to connect to your RDS DB instances, you require Amazon RDS CA\-2019 certificates, which are enabled by default for new DB instances\. If you currently do not use SSL/TLS with certificate verification, you might still have expired CA\-2015 certificates and must update them to CA\-2019 certificates if you plan to use SSL/TLS with certificate verification to connect to your RDS databases\. - -Follow these instructions to complete your updates\. Before you update your DB instances to use the new CA certificate, make sure that you update your clients or applications connecting to your RDS databases\. - -Amazon RDS provides new CA certificates as an AWS security best practice\. For information about the new certificates and the supported AWS Regions, see [Using SSL/TLS to encrypt a connection to a DB instance](UsingWithRDS.SSL.md)\. - -**Note** -Amazon RDS Proxy uses certificates from the AWS Certificate Manager \(ACM\)\. If you are using RDS Proxy, when you rotate your SSL/TLS certificate, you don't need to update applications that use RDS Proxy connections\. For more information about using TLS/SSL with RDS Proxy, see [Using TLS/SSL with RDS Proxy](rds-proxy.howitworks.md#rds-proxy-security.tls)\. - -**Note** -If you are using a Go version 1\.15 application with a DB instance that was created or updated to the `rds-ca-2019` certificate prior to July 28, 2020, you must update the certificate again\. Update the certificate to rds\-ca\-rsa2048\-g1, rds\-ca\-rsa4096\-g1, or rds\-ca\-ecc384\-g1 depending on your engine\. Run the `modify-db-instance` command shown in the AWS CLI section using the new CA certificate identifier\. You can find the CAs that are available for a specific DB engine and DB engine version using the `describe-db-engine-versions` command\. -If you created your DB instance or updated its certificate after July 28, 2020, no action is required\. For more information, see [Go GitHub issue \#39568](https://github.com/golang/go/issues/39568)\. - -**Topics** -+ [Updating your CA certificate by modifying your DB instance](#UsingWithRDS.SSL-certificate-rotation-updating) -+ [Updating your CA certificate by applying DB instance maintenance](#UsingWithRDS.SSL-certificate-rotation-maintenance) -+ [Sample script for importing certificates into your trust store](#UsingWithRDS.SSL-certificate-rotation-sample-script) - -## Updating your CA certificate by modifying your DB instance - -Complete the following steps to update your CA certificate\. - -**To update your CA certificate by modifying your DB instance** - -1. Download the new SSL/TLS certificate as described in [Using SSL/TLS to encrypt a connection to a DB instance](UsingWithRDS.SSL.md)\. - -1. Update your applications to use the new SSL/TLS certificate\. - - The methods for updating applications for new SSL/TLS certificates depend on your specific applications\. Work with your application developers to update the SSL/TLS certificates for your applications\. - - For information about checking for SSL/TLS connections and updating applications for each DB engine, see the following topics: - + [Using new SSL/TLS certificates for MariaDB DB instances](ssl-certificate-rotation-mariadb.md) - + [Updating applications to connect to Microsoft SQL Server DB instances using new SSL/TLS certificates](ssl-certificate-rotation-sqlserver.md) - + [Using new SSL/TLS certificates for MySQL DB instances](ssl-certificate-rotation-mysql.md) - + [Updating your applications to use new SSL/TLS certificates](ssl-certificate-rotation-oracle.md) - + [Updating applications to use new SSL/TLS certificates](ssl-certificate-rotation-postgresql.md) - - For a sample script that updates a trust store for a Linux operating system, see [Sample script for importing certificates into your trust store](#UsingWithRDS.SSL-certificate-rotation-sample-script)\. -**Note** -The certificate bundle contains certificates for both the old and new CA, so you can upgrade your application safely and maintain connectivity during the transition period\. If you are using the AWS Database Migration Service to migrate a database to a DB instance, we recommend using the certificate bundle to ensure connectivity during the migration\. - -1. Modify the DB instance to change the CA from **rds\-ca\-2015** to **rds\-ca\-2019**\. -**Important** -By default, this operation restarts your DB instance\. If you don't want to restart your DB instance during this operation, you can use the `modify-db-instance` CLI command and specify the `--no-certificate-rotation-restart` option\. -This option will not rotate the certificate until the next time the database restarts, either for planned or unplanned maintenance\. This option is only recommended if you don't use SSL/TLS\. -If you are experiencing connectivity issues after certificate expiry, use the apply immediately option by specifying **Apply immediately** in the console or by specifying the `--apply-immediately` option using the AWS CLI\. By default, this operation is scheduled to run during your next maintenance window\. - -You can use the AWS Management Console or the AWS CLI to change the CA certificate from **rds\-ca\-2015** to **rds\-ca\-2019** for a DB instance\. - -### Console - -**To change the CA from **rds\-ca\-2015** to **rds\-ca\-2019** for a DB instance** - -1. Sign in to the AWS Management Console and open the Amazon RDS console at [https://console\.aws\.amazon\.com/rds/](https://console.aws.amazon.com/rds/)\. - -1. In the navigation pane, choose **Databases**, and then choose the DB instance that you want to modify\. - -1. Choose **Modify**\. -![\[Modify DB instance\]](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/images/ssl-rotate-cert-modify.png) - - The **Modify DB Instance** page appears\. - -1. In the **Connectivity** section, choose **rds\-ca\-2019**\. -![\[Choose CA certificate\]](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/images/ssl-rotate-cert-ca-2019.png) - -1. Choose **Continue** and check the summary of modifications\. - -1. To apply the changes immediately, choose **Apply immediately**\. -**Important** -Choosing this option restarts your database immediately\. - -1. On the confirmation page, review your changes\. If they are correct, choose **Modify DB Instance** to save your changes\. -**Important** -When you schedule this operation, make sure that you have updated your client\-side trust store beforehand\. - - Or choose **Back** to edit your changes or **Cancel** to cancel your changes\. - -### AWS CLI - -To use the AWS CLI to change the CA from **rds\-ca\-2015** to **rds\-ca\-2019** for a DB instance, call the [modify\-db\-instance](https://docs.aws.amazon.com/cli/latest/reference/rds/modify-db-instance.html) command\. Specify the DB instance identifier and the `--ca-certificate-identifier` option\. - -**Important** -When you schedule this operation, make sure that you have updated your client\-side trust store beforehand\. - -**Example** -The following code modifies `mydbinstance` by setting the CA certificate to `rds-ca-2019`\. The changes are applied during the next maintenance window by using `--no-apply-immediately`\. Use `--apply-immediately` to apply the changes immediately\. -By default, this operation reboots your DB instance\. If you don't want to reboot your DB instance during this operation, you can use the `modify-db-instance` CLI command and specify the `--no-certificate-rotation-restart` option\. -This option will not rotate the certificate until the next time the database restarts, either for planned or unplanned maintenance\. This option is only recommended if you do not use SSL/TLS\. -Use `--apply-immediately` to apply the update immediately\. By default, this operation is scheduled to run during your next maintenance window\. -For Linux, macOS, or Unix: - -``` -aws rds modify-db-instance \ - --db-instance-identifier mydbinstance \ - --ca-certificate-identifier rds-ca-2019 \ - --no-apply-immediately -``` -For Windows: - -``` -aws rds modify-db-instance ^ - --db-instance-identifier mydbinstance ^ - --ca-certificate-identifier rds-ca-2019 ^ - --no-apply-immediately -``` - -## Updating your CA certificate by applying DB instance maintenance - -Complete the following steps to update your CA certificate by applying DB instance maintenance\. - -**To update your CA certificate by applying DB instance maintenance** - -1. Download the new SSL/TLS certificate as described in [Using SSL/TLS to encrypt a connection to a DB instance](UsingWithRDS.SSL.md)\. - -1. Update your database applications to use the new SSL/TLS certificate\. - - The methods for updating applications for new SSL/TLS certificates depend on your specific applications\. Work with your application developers to update the SSL/TLS certificates for your applications\. - - For information about checking for SSL/TLS connections and updating applications for each DB engine, see the following topics: - + [Using new SSL/TLS certificates for MariaDB DB instances](ssl-certificate-rotation-mariadb.md) - + [Updating applications to connect to Microsoft SQL Server DB instances using new SSL/TLS certificates](ssl-certificate-rotation-sqlserver.md) - + [Using new SSL/TLS certificates for MySQL DB instances](ssl-certificate-rotation-mysql.md) - + [Updating your applications to use new SSL/TLS certificates](ssl-certificate-rotation-oracle.md) - + [Updating applications to use new SSL/TLS certificates](ssl-certificate-rotation-postgresql.md) - - For a sample script that updates a trust store for a Linux operating system, see [Sample script for importing certificates into your trust store](#UsingWithRDS.SSL-certificate-rotation-sample-script)\. -**Note** -The certificate bundle contains certificates for both the old and new CA, so you can upgrade your application safely and maintain connectivity during the transition period\. - -1. Apply DB instance maintenance to change the CA from **rds\-ca\-2015** to **rds\-ca\-2019**\. -**Important** -You can choose to apply the change immediately\. By default, this operation is scheduled to run during your next maintenance window\. - -You can use the AWS Management Console to apply DB instance maintenance to change the CA certificate from **rds\-ca\-2015** to **rds\-ca\-2019** for multiple DB instances\. - -### Updating your CA certificate by applying maintenance to multiple DB instances - -Use the AWS Management Console to change the CA certificate for multiple DB instances\. - -**To change the CA from **rds\-ca\-2015** to **rds\-ca\-2019** for multiple DB instances** - -1. Sign in to the AWS Management Console and open the Amazon RDS console at [https://console\.aws\.amazon\.com/rds/](https://console.aws.amazon.com/rds/)\. - -1. In the navigation pane, choose **Databases**\. - - In the navigation pane, there is a **Certificate update** option that shows the total number of affected DB instances\. -![\[Certificate rotation navigation pane option\]](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/images/ssl-rotate-cert-certupdate.png) - - Choose **Certificate update** in the navigation pane\. - - The **Update your Amazon RDS SSL/TLS certificates** page appears\. -![\[Update CA certificate for multiple DB instances\]](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/images/ssl-rotate-cert-update-multiple.png) -**Note** -This page only shows the DB instances for the current AWS Region\. If you have DB instances in more than one AWS Region, check this page in each AWS Region to see all DB instances with old SSL/TLS certificates\. - -1. Choose the DB instance you want to update\. - - You can schedule the certificate rotation for your next maintenance window by choosing **Update at the next maintenance window**\. Apply the rotation immediately by choosing **Update now**\. -**Important** -When your CA certificate is rotated, the operation restarts your DB instance\. -If you experience connectivity issues after certificate expiry, use the **Update now** option\. - -1. If you choose **Update at the next maintenance window** or **Update now**, you are prompted to confirm the CA certificate rotation\. -**Important** -Before scheduling the CA certificate rotation on your database, update any client applications that use SSL/TLS and the server certificate to connect\. These updates are specific to your DB engine\. To determine whether your applications use SSL/TLS and the server certificate to connect, see [Step 2: Update Your Database Applications to Use the New SSL/TLS Certificate](#UpdateAppsForSSL)\. After you have updated these client applications, you can confirm the CA certificate rotation\. -![\[Confirm certificate rotation\]](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/images/ssl-rotate-cert-confirm.png) - - To continue, choose the check box, and then choose **Confirm**\. - -1. Repeat steps 3 and 4 for each DB instance that you want to update\. - -## Sample script for importing certificates into your trust store - -The following are sample shell scripts that import the certificate bundle into a trust store\. - -Each sample shell script uses keytool, which is part of the Java Development Kit \(JDK\)\. For information about installing the JDK, see [ JDK Installation Guide](https://docs.oracle.com/en/java/javase/17/install/overview-jdk-installation.html)\. - -**Topics** -+ [Sample script for importing certificates on Linux](#UsingWithRDS.SSL-certificate-rotation-sample-script.linux) -+ [Sample script for importing certificates on macOS](#UsingWithRDS.SSL-certificate-rotation-sample-script.macos) - -### Sample script for importing certificates on Linux - -The following is a sample shell script that imports the certificate bundle into a trust store on a Linux operating system\. - -``` -mydir=tmp/certs -if [ ! -e "${mydir}" ] -then -mkdir -p "${mydir}" -fi - -truststore=${mydir}/rds-truststore.jks -storepassword=changeit - -curl -sS "https://truststore.pki.rds.amazonaws.com/global/global-bundle.pem" > ${mydir}/global-bundle.pem -awk 'split_after == 1 {n++;split_after=0} /-----END CERTIFICATE-----/ {split_after=1}{print > "rds-ca-" n ".pem"}' < ${mydir}/global-bundle.pem - -for CERT in rds-ca-*; do - alias=$(openssl x509 -noout -text -in $CERT | perl -ne 'next unless /Subject:/; s/.*(CN=|CN = )//; print') - echo "Importing $alias" - keytool -import -file ${CERT} -alias "${alias}" -storepass ${storepassword} -keystore ${truststore} -noprompt - rm $CERT -done - -rm ${mydir}/global-bundle.pem - -echo "Trust store content is: " - -keytool -list -v -keystore "$truststore" -storepass ${storepassword} | grep Alias | cut -d " " -f3- | while read alias -do - expiry=`keytool -list -v -keystore "$truststore" -storepass ${storepassword} -alias "${alias}" | grep Valid | perl -ne 'if(/until: (.*?)\n/) { print "$1\n"; }'` - echo " Certificate ${alias} expires in '$expiry'" -done -``` - -### Sample script for importing certificates on macOS - -The following is a sample shell script that imports the certificate bundle into a trust store on macOS\. - -``` -mydir=tmp/certs -if [ ! -e "${mydir}" ] -then -mkdir -p "${mydir}" -fi - -truststore=${mydir}/rds-truststore.jks -storepassword=changeit - -curl -sS "https://truststore.pki.rds.amazonaws.com/global/global-bundle.pem" > ${mydir}/global-bundle.pem -split -p "-----BEGIN CERTIFICATE-----" ${mydir}/global-bundle.pem rds-ca- - -for CERT in rds-ca-*; do - alias=$(openssl x509 -noout -text -in $CERT | perl -ne 'next unless /Subject:/; s/.*(CN=|CN = )//; print') - echo "Importing $alias" - keytool -import -file ${CERT} -alias "${alias}" -storepass ${storepassword} -keystore ${truststore} -noprompt - rm $CERT -done - -rm ${mydir}/global-bundle.pem - -echo "Trust store content is: " - -keytool -list -v -keystore "$truststore" -storepass ${storepassword} | grep Alias | cut -d " " -f3- | while read alias -do - expiry=`keytool -list -v -keystore "$truststore" -storepass ${storepassword} -alias "${alias}" | grep Valid | perl -ne 'if(/until: (.*?)\n/) { print "$1\n"; }'` - echo " Certificate ${alias} expires in '$expiry'" -done -``` \ No newline at end of file diff --git a/doc_source/UsingWithRDS.SSL.md b/doc_source/UsingWithRDS.SSL.md deleted file mode 100644 index cb725fd..0000000 --- a/doc_source/UsingWithRDS.SSL.md +++ /dev/null @@ -1,154 +0,0 @@ -# Using SSL/TLS to encrypt a connection to a DB instance - -You can use Secure Socket Layer \(SSL\) or Transport Layer Security \(TLS\) from your application to encrypt a connection to a DB instance running MariaDB, Microsoft SQL Server, MySQL, Oracle, or PostgreSQL\. - -SSL/TLS connections provide one layer of security by encrypting data that moves between your client and a DB instance\. Using a server certificate provides an extra layer of security by validating that the connection is being made to an Amazon RDS DB instance\. It does so by checking the server certificate that is automatically installed on all DB instances that you provision\. - -Each DB engine has its own process for implementing SSL/TLS\. To learn how to implement SSL/TLS for your DB instance, use the link following that corresponds to your DB engine: -+ [Using SSL/TLS with a MariaDB DB instance](mariadb-ssl-connections.md#MariaDB.Concepts.SSLSupport) -+ [Using SSL with a Microsoft SQL Server DB instance](SQLServer.Concepts.General.SSL.Using.md) -+ [Using SSL/TLS with a MySQL DB instance](mysql-ssl-connections.md#MySQL.Concepts.SSLSupport) -+ [Using SSL with an RDS for Oracle DB instance](Oracle.Concepts.SSL.md) -+ [Using SSL with a PostgreSQL DB instance](PostgreSQL.Concepts.General.SSL.md) - -**Note** -All certificates are only available for download using SSL/TLS connections\. - -## Certificate authorities - -The certificate authority \(CA\) is the certificate that identifies the root CA at the top of the certificate chain\. The CA signs the DB instance certificate, which is the server certificate that is installed on each DB instance\. The server certificate identifies the DB instance as a trusted server\. - -Amazon RDS provides the following CAs to sign the server certificate for a DB instance\. - - -**** - -| Certificate authority \(CA\) | Description | -| --- | --- | -| rds\-ca\-2019 | Uses a certificate authority with RSA 2048 private key algorithm and SHA256 signing algorithm for your DB instance server certificate\. This CA expires in 2024 and doesn't support automatic server certificate rotation\. If you are using this CA and want to keep the same standard, we recommend that you switch to the rds\-ca\-rsa2048\-g1 CA\. | -| rds\-ca\-rsa2048\-g1 | Uses a certificate authority with RSA 2048 private key algorithm and SHA256 signing algorithm for your DB instance server certificate in most AWS Regions\. In the AWS GovCloud \(US\) Regions, this CA uses a certificate authority with RSA 2048 private key algorithm and SHA384 signing algorithm for your DB instance server certificate\. This CA remains valid for longer than the rds\-ca\-2019 CA\. This CA supports automatic server certificate rotation\. | -| rds\-ca\-rsa4096\-g1 | Uses a certificate authority with RSA 4096 private key algorithm and SHA384 signing algorithm for your DB instance server certificate\. This CA supports automatic server certificate rotation\. | -| rds\-ca\-ecc384\-g1 | Uses a certificate authority with ECC 384 private key algorithm and SHA384 signing algorithm for your DB instance server certificate\. This CA supports automatic server certificate rotation\. | - -**Note** -If you are using the AWS CLI, you can see the validities of the certificate authorities listed above by using [describe\-certificates](https://docs.aws.amazon.com/cli/latest/reference/rds/describe-certificates.html)\. - -When you use the rds\-ca\-rsa2048\-g1, rds\-ca\-rsa4096\-g1, or rds\-ca\-ecc384\-g1 CA with a DB instance, RDS manages the server certificate on the DB instance\. RDS rotates it automatically before it expires\. These CA certificates are included in the regional and global certificate bundle\. - -You can set the CA for a DB instance when you perform the following tasks: -+ Create a DB instance – You can set the CA when you create a DB instance\. For instructions, see [Creating an Amazon RDS DB instance](USER_CreateDBInstance.md)\. -+ Modify a DB instance – You can set the CA for a DB instance by modifying it\. For instructions, see [Modifying an Amazon RDS DB instance](Overview.DBInstance.Modifying.md)\. - -You can set the default CA for your AWS account by using the [modify\-certificates](https://docs.aws.amazon.com/cli/latest/reference/rds/modify-certificates.html) command\. - -The available CAs depend on the DB engine and DB engine version\. When you use the AWS Management Console, you can choose the CA using the **Certificate authority** setting, as shown in the following image\. - -![\[Certificate authority option\]](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/images/certificate-authority.png) - -The console only shows the CAs that are available for the DB engine and DB engine version\. If you are using the AWS CLI, you can set the CA for a DB instance using the [create\-db\-instance](https://docs.aws.amazon.com/cli/latest/reference/rds/create-db-instance.html) or [modify\-db\-instance](https://docs.aws.amazon.com/cli/latest/reference/rds/modify-db-instance.html) command\. - -If you are using the AWS CLI, you can see the available CAs for your account by using the [describe\-certificates](https://docs.aws.amazon.com/cli/latest/reference/rds/describe-certificates.html) command\. This command also shows the expiration date for each CA in `ValidTill` in the output\. You can find the CAs that are available for a specific DB engine and DB engine version using the [describe\-db\-engine\-versions](https://docs.aws.amazon.com/cli/latest/reference/rds/describe-db-engine-versions.html) command\. - -The following example shows the CAs available for the default RDS for PostgreSQL DB engine version\. - -``` -aws rds describe-db-engine-versions --default-only --engine postgres -``` - -Your output is similar to the following\. The available CAs are listed in `SupportedCACertificateIdentifiers`\. The output also shows whether the DB engine version supports rotating the certificate without restart in `SupportsCertificateRotationWithoutRestart`\. - -``` -{ - "DBEngineVersions": [ - { - "Engine": "postgres", - "MajorEngineVersion": "13", - "EngineVersion": "13.4", - "DBParameterGroupFamily": "postgres13", - "DBEngineDescription": "PostgreSQL", - "DBEngineVersionDescription": "PostgreSQL 13.4-R1", - "ValidUpgradeTarget": [], - "SupportsLogExportsToCloudwatchLogs": false, - "SupportsReadReplica": true, - "SupportedFeatureNames": [ - "Lambda" - ], - "Status": "available", - "SupportsParallelQuery": false, - "SupportsGlobalDatabases": false, - "SupportsBabelfish": false, - "SupportsCertificateRotationWithoutRestart": true, - "SupportedCACertificateIdentifiers": [ - "rds-ca-2019", - "rds-ca-rsa2048-g1", - "rds-ca-ecc384-g1", - "rds-ca-rsa4096-g1" - ] - } - ] -} -``` - -You can view the details about the CA for a DB instance by viewing the **Connectivity & security** tab in the console, as in the following image\. - -![\[Certificate authority details\]](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/images/certificate-authority-details.png) - -If you are using the AWS CLI, you can view the details about the CA for a DB instance by using the [describe\-db\-instances](https://docs.aws.amazon.com/cli/latest/reference/rds/describe-db-instances.html) command\. - -## Certificate bundles for all AWS Regions - -To get a certificate bundle that contains both the intermediate and root certificates for all AWS Regions, download it from [ https://truststore\.pki\.rds\.amazonaws\.com/global/global\-bundle\.pem](https://truststore.pki.rds.amazonaws.com/global/global-bundle.pem)\. - -If your application is on Microsoft Windows and requires a PKCS7 file, you can download the PKCS7 certificate bundle\. This bundle contains both the intermediate and root certificates at [ https://truststore\.pki\.rds\.amazonaws\.com/global/global\-bundle\.p7b](https://truststore.pki.rds.amazonaws.com/global/global-bundle.p7b)\. - -**Note** -Amazon RDS Proxy uses certificates from the AWS Certificate Manager \(ACM\)\. If you are using RDS Proxy, you don't need to download Amazon RDS certificates or update applications that use RDS Proxy connections\. For more information about using TLS/SSL with RDS Proxy, see [Using TLS/SSL with RDS Proxy](rds-proxy.howitworks.md#rds-proxy-security.tls)\. - -## Certificate bundles for specific AWS Regions - -To get a certificate bundle that contains both the intermediate and root certificates for an AWS Region, download it from the link for the AWS Region in the following table\. - - -| **AWS Region** | **Certificate bundle \(PEM\)** | **Certificate bundle \(PKCS7\)** | -| --- | --- | --- | -| US East \(N\. Virginia\) | [us\-east\-1\-bundle\.pem](https://truststore.pki.rds.amazonaws.com/us-east-1/us-east-1-bundle.pem) | [us\-east\-1\-bundle\.p7b](https://truststore.pki.rds.amazonaws.com/us-east-1/us-east-1-bundle.p7b) | -| US East \(Ohio\) | [us\-east\-2\-bundle\.pem](https://truststore.pki.rds.amazonaws.com/us-east-2/us-east-2-bundle.pem) | [us\-east\-2\-bundle\.p7b](https://truststore.pki.rds.amazonaws.com/us-east-2/us-east-2-bundle.p7b) | -| US West \(N\. California\) | [us\-west\-1\-bundle\.pem](https://truststore.pki.rds.amazonaws.com/us-west-1/us-west-1-bundle.pem) | [us\-west\-1\-bundle\.p7b](https://truststore.pki.rds.amazonaws.com/us-west-1/us-west-1-bundle.p7b) | -| US West \(Oregon\) | [us\-west\-2\-bundle\.pem](https://truststore.pki.rds.amazonaws.com/us-west-2/us-west-2-bundle.pem) | [us\-west\-2\-bundle\.p7b](https://truststore.pki.rds.amazonaws.com/us-west-2/us-west-2-bundle.p7b) | -| Africa \(Cape Town\) | [af\-south\-1\-bundle\.pem](https://truststore.pki.rds.amazonaws.com/af-south-1/af-south-1-bundle.pem) | [af\-south\-1\-bundle\.p7b](https://truststore.pki.rds.amazonaws.com/af-south-1/af-south-1-bundle.p7b) | -| Asia Pacific \(Hong Kong\) | [ap\-east\-1\-bundle\.pem](https://truststore.pki.rds.amazonaws.com/ap-east-1/ap-east-1-bundle.pem) | [ap\-east\-1\-bundle\.p7b](https://truststore.pki.rds.amazonaws.com/ap-east-1/ap-east-1-bundle.p7b) | -| Asia Pacific \(Hyderabad\) | [ap\-south\-2\-bundle\.pem](https://truststore.pki.rds.amazonaws.com/ap-south-2/ap-south-2-bundle.pem) | [ap\-south\-2\-bundle\.p7b](https://truststore.pki.rds.amazonaws.com/ap-south-2/ap-south-2-bundle.p7b) | -| Asia Pacific \(Jakarta\) | [ap\-southeast\-3\-bundle\.pem](https://truststore.pki.rds.amazonaws.com/ap-southeast-3/ap-southeast-3-bundle.pem) | [ap\-southeast\-3\-bundle\.p7b](https://truststore.pki.rds.amazonaws.com/ap-southeast-3/ap-southeast-3-bundle.p7b) | -| Asia Pacific \(Melbourne\) | [ap\-southeast\-4\-bundle\.pem](https://truststore.pki.rds.amazonaws.com/ap-southeast-4/ap-southeast-4-bundle.pem) | [ap\-southeast\-4\-bundle\.p7b](https://truststore.pki.rds.amazonaws.com/ap-southeast-4/ap-southeast-4-bundle.p7b) | -| Asia Pacific \(Mumbai\) | [ap\-south\-1\-bundle\.pem](https://truststore.pki.rds.amazonaws.com/ap-south-1/ap-south-1-bundle.pem) | [ap\-south\-1\-bundle\.p7b](https://truststore.pki.rds.amazonaws.com/ap-south-1/ap-south-1-bundle.p7b) | -| Asia Pacific \(Osaka\) | [ap\-northeast\-3\-bundle\.pem](https://truststore.pki.rds.amazonaws.com/ap-northeast-3/ap-northeast-3-bundle.pem) | [ap\-northeast\-3\-bundle\.p7b](https://truststore.pki.rds.amazonaws.com/ap-northeast-3/ap-northeast-3-bundle.p7b) | -| Asia Pacific \(Tokyo\) | [ap\-northeast\-1\-bundle\.pem](https://truststore.pki.rds.amazonaws.com/ap-northeast-1/ap-northeast-1-bundle.pem) | [ap\-northeast\-1\-bundle\.p7b](https://truststore.pki.rds.amazonaws.com/ap-northeast-1/ap-northeast-1-bundle.p7b) | -| Asia Pacific \(Seoul\) | [ap\-northeast\-2\-bundle\.pem](https://truststore.pki.rds.amazonaws.com/ap-northeast-2/ap-northeast-2-bundle.pem) | [ap\-northeast\-2\-bundle\.p7b](https://truststore.pki.rds.amazonaws.com/ap-northeast-2/ap-northeast-2-bundle.p7b) | -| Asia Pacific \(Singapore\) | [ap\-southeast\-1\-bundle\.pem](https://truststore.pki.rds.amazonaws.com/ap-southeast-1/ap-southeast-1-bundle.pem) | [ap\-southeast\-1\-bundle\.p7b](https://truststore.pki.rds.amazonaws.com/ap-southeast-1/ap-southeast-1-bundle.p7b) | -| Asia Pacific \(Sydney\) | [ap\-southeast\-2\-bundle\.pem](https://truststore.pki.rds.amazonaws.com/ap-southeast-2/ap-southeast-2-bundle.pem) | [ap\-southeast\-2\-bundle\.p7b](https://truststore.pki.rds.amazonaws.com/ap-southeast-2/ap-southeast-2-bundle.p7b) | -| Canada \(Central\) | [ca\-central\-1\-bundle\.pem](https://truststore.pki.rds.amazonaws.com/ca-central-1/ca-central-1-bundle.pem) | [ca\-central\-1\-bundle\.p7b](https://truststore.pki.rds.amazonaws.com/ca-central-1/ca-central-1-bundle.p7b) | -| Europe \(Frankfurt\) | [eu\-central\-1\-bundle\.pem](https://truststore.pki.rds.amazonaws.com/eu-central-1/eu-central-1-bundle.pem) | [eu\-central\-1\-bundle\.p7b](https://truststore.pki.rds.amazonaws.com/eu-central-1/eu-central-1-bundle.p7b) | -| Europe \(Ireland\) | [eu\-west\-1\-bundle\.pem](https://truststore.pki.rds.amazonaws.com/eu-west-1/eu-west-1-bundle.pem) | [eu\-west\-1\-bundle\.p7b](https://truststore.pki.rds.amazonaws.com/eu-west-1/eu-west-1-bundle.p7b) | -| Europe \(London\) | [eu\-west\-2\-bundle\.pem](https://truststore.pki.rds.amazonaws.com/eu-west-2/eu-west-2-bundle.pem) | [eu\-west\-2\-bundle\.p7b](https://truststore.pki.rds.amazonaws.com/eu-west-2/eu-west-2-bundle.p7b) | -| Europe \(Milan\) | [eu\-south\-1\-bundle\.pem](https://truststore.pki.rds.amazonaws.com/eu-south-1/eu-south-1-bundle.pem) | [eu\-south\-1\-bundle\.p7b](https://truststore.pki.rds.amazonaws.com/eu-south-1/eu-south-1-bundle.p7b) | -| Europe \(Paris\) | [eu\-west\-3\-bundle\.pem](https://truststore.pki.rds.amazonaws.com/eu-west-3/eu-west-3-bundle.pem) | [eu\-west\-3\-bundle\.p7b](https://truststore.pki.rds.amazonaws.com/eu-west-3/eu-west-3-bundle.p7b) | -| Europe \(Spain\) | [eu\-south\-2\-bundle\.pem](https://truststore.pki.rds.amazonaws.com/eu-south-2/eu-south-2-bundle.pem) | [eu\-south\-2\-bundle\.p7b](https://truststore.pki.rds.amazonaws.com/eu-south-2/eu-south-2-bundle.p7b) | -| Europe \(Stockholm\) | [eu\-north\-1\-bundle\.pem](https://truststore.pki.rds.amazonaws.com/eu-north-1/eu-north-1-bundle.pem) | [eu\-north\-1\-bundle\.p7b](https://truststore.pki.rds.amazonaws.com/eu-north-1/eu-north-1-bundle.p7b) | -| Europe \(Zurich\) | [eu\-central\-2\-bundle\.pem](https://truststore.pki.rds.amazonaws.com/eu-central-2/eu-central-2-bundle.pem) | [eu\-central\-2\-bundle\.p7b](https://truststore.pki.rds.amazonaws.com/eu-central-2/eu-central-2-bundle.p7b) | -| Middle East \(Bahrain\) | [me\-south\-1\-bundle\.pem](https://truststore.pki.rds.amazonaws.com/me-south-1/me-south-1-bundle.pem) | [me\-south\-1\-bundle\.p7b](https://truststore.pki.rds.amazonaws.com/me-south-1/me-south-1-bundle.p7b) | -| Middle East \(UAE\) | [me\-central\-1\-bundle\.pem](https://truststore.pki.rds.amazonaws.com/me-central-1/me-central-1-bundle.pem) | [me\-central\-1\-bundle\.p7b](https://truststore.pki.rds.amazonaws.com/me-central-1/me-central-1-bundle.p7b) | -| South America \(São Paulo\) | [sa\-east\-1\-bundle\.pem](https://truststore.pki.rds.amazonaws.com/sa-east-1/sa-east-1-bundle.pem) | [sa\-east\-1\-bundle\.p7b](https://truststore.pki.rds.amazonaws.com/sa-east-1/sa-east-1-bundle.p7b) | - -## AWS GovCloud \(US\) certificates - -To get a certificate bundle that contains both the intermediate and root certificates for the AWS GovCloud \(US\) Regions, download from [ https://truststore\.pki\.us\-gov\-west\-1\.rds\.amazonaws\.com/global/global\-bundle\.pem](https://truststore.pki.us-gov-west-1.rds.amazonaws.com/global/global-bundle.pem)\. - -If your application is on Microsoft Windows and requires a PKCS7 file, you can download the PKCS7 certificate bundle\. This bundle contains both the intermediate and root certificates at [ https://truststore\.pki\.us\-gov\-west\-1\.rds\.amazonaws\.com/global/global\-bundle\.p7b](https://truststore.pki.us-gov-west-1.rds.amazonaws.com/global/global-bundle.p7b)\. - -To get a certificate bundle that contains both the intermediate and root certificates for an AWS GovCloud \(US\) Region, download from the link for the AWS GovCloud \(US\) Region in the following table\. - - -| **AWS GovCloud \(US\) Region** | **Certificate bundle \(PEM\)** | **Certificate bundle \(PKCS7\)** | -| --- | --- | --- | -| AWS GovCloud \(US\-East\) | [us\-gov\-east\-1\-bundle\.pem](https://truststore.pki.us-gov-west-1.rds.amazonaws.com/us-gov-east-1/us-gov-east-1-bundle.pem) | [us\-gov\-east\-1\-bundle\.p7b](https://truststore.pki.us-gov-west-1.rds.amazonaws.com/us-gov-east-1/us-gov-east-1-bundle.p7b) | -| AWS GovCloud \(US\-West\) | [us\-gov\-west\-1\-bundle\.pem](https://truststore.pki.us-gov-west-1.rds.amazonaws.com/us-gov-west-1/us-gov-west-1-bundle.pem) | [us\-gov\-west\-1\-bundle\.p7b](https://truststore.pki.us-gov-west-1.rds.amazonaws.com/us-gov-west-1/us-gov-west-1-bundle.p7b) | \ No newline at end of file diff --git a/doc_source/UsingWithRDS.md b/doc_source/UsingWithRDS.md deleted file mode 100644 index bac97fe..0000000 --- a/doc_source/UsingWithRDS.md +++ /dev/null @@ -1,39 +0,0 @@ -# Security in Amazon RDS - -Cloud security at AWS is the highest priority\. As an AWS customer, you benefit from a data center and network architecture that are built to meet the requirements of the most security\-sensitive organizations\. - -Security is a shared responsibility between AWS and you\. The [shared responsibility model](https://aws.amazon.com/compliance/shared-responsibility-model/) describes this as security *of* the cloud and security *in* the cloud: -+ **Security of the cloud** – AWS is responsible for protecting the infrastructure that runs AWS services in the AWS Cloud\. AWS also provides you with services that you can use securely\. Third\-party auditors regularly test and verify the effectiveness of our security as part of the [AWS compliance programs](https://aws.amazon.com/compliance/programs/)\. To learn about the compliance programs that apply to Amazon RDS, see [AWS services in scope by compliance program](https://aws.amazon.com/compliance/services-in-scope/)\. -+ **Security in the cloud** – Your responsibility is determined by the AWS service that you use\. You are also responsible for other factors including the sensitivity of your data, your organization's requirements, and applicable laws and regulations\. - -This documentation helps you understand how to apply the shared responsibility model when using Amazon RDS\. The following topics show you how to configure Amazon RDS to meet your security and compliance objectives\. You also learn how to use other AWS services that help you monitor and secure your Amazon RDS resources\. - -You can manage access to your Amazon RDS resources and your databases on a DB instance\. The method you use to manage access depends on what type of task the user needs to perform with Amazon RDS: -+ Run your DB instance in a virtual private cloud \(VPC\) based on the Amazon VPC service for the greatest possible network access control\. For more information about creating a DB instance in a VPC, see [Amazon VPC VPCs and Amazon RDS](USER_VPC.md)\. -+ Use AWS Identity and Access Management \(IAM\) policies to assign permissions that determine who is allowed to manage Amazon RDS resources\. For example, you can use IAM to determine who is allowed to create, describe, modify, and delete DB instances, tag resources, or modify security groups\. -+ Use security groups to control what IP addresses or Amazon EC2 instances can connect to your databases on a DB instance\. When you first create a DB instance, its firewall prevents any database access except through rules specified by an associated security group\. -+ Use Secure Socket Layer \(SSL\) or Transport Layer Security \(TLS\) connections with DB instances running the MySQL, MariaDB, PostgreSQL, Oracle, or Microsoft SQL Server database engines\. For more information on using SSL/TLS with a DB instance, see [Using SSL/TLS to encrypt a connection to a DB instance](UsingWithRDS.SSL.md)\. -+ Use Amazon RDS encryption to secure your DB instances and snapshots at rest\. Amazon RDS encryption uses the industry standard AES\-256 encryption algorithm to encrypt your data on the server that hosts your DB instance\. For more information, see [Encrypting Amazon RDS resources](Overview.Encryption.md)\. -+ Use network encryption and transparent data encryption with Oracle DB instances; for more information, see [Oracle native network encryption](Appendix.Oracle.Options.NetworkEncryption.md) and [Oracle Transparent Data Encryption](Appendix.Oracle.Options.AdvSecurity.md) -+ Use the security features of your DB engine to control who can log in to the databases on a DB instance\. These features work just as if the database was on your local network\. - -**Note** -You have to configure security only for your use cases\. You don't have to configure security access for processes that Amazon RDS manages\. These include creating backups, replicating data between a primary DB instance and a read replica, and other processes\. - -For more information on managing access to Amazon RDS resources and your databases on a DB instance, see the following topics\. - -**Topics** -+ [Database authentication with Amazon RDS](database-authentication.md) -+ [Password management with Amazon RDS and AWS Secrets Manager](rds-secrets-manager.md) -+ [Data protection in Amazon RDS](DataDurability.md) -+ [Identity and access management for Amazon RDS](UsingWithRDS.IAM.md) -+ [Logging and monitoring in Amazon RDS](Overview.LoggingAndMonitoring.md) -+ [Compliance validation for Amazon RDS](RDS-compliance.md) -+ [Resilience in Amazon RDS](disaster-recovery-resiliency.md) -+ [Infrastructure security in Amazon RDS](infrastructure-security.md) -+ [Amazon RDS API and interface VPC endpoints \(AWS PrivateLink\)](vpc-interface-endpoints.md) -+ [Security best practices for Amazon RDS](CHAP_BestPractices.Security.md) -+ [Controlling access with security groups](Overview.RDSSecurityGroups.md) -+ [Master user account privileges](UsingWithRDS.MasterAccounts.md) -+ [Using service\-linked roles for Amazon RDS](UsingWithRDS.IAM.ServiceLinkedRoles.md) -+ [Amazon VPC VPCs and Amazon RDS](USER_VPC.md) \ No newline at end of file diff --git a/doc_source/Using_the_Query_API.md b/doc_source/Using_the_Query_API.md deleted file mode 100644 index 549180c..0000000 --- a/doc_source/Using_the_Query_API.md +++ /dev/null @@ -1,19 +0,0 @@ -# Using the Query API - -The following sections briefly discuss the parameters and request authentication used with the Query API\. - -For general information about how the Query API works, see [Query requests](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Query-Requests.html) in the *Amazon EC2 API Reference\.* - -## Query parameters - -HTTP Query\-based requests are HTTP requests that use the HTTP verb GET or POST and a Query parameter named `Action`\. - -Each Query request must include some common parameters to handle authentication and selection of an action\. - -Some operations take lists of parameters\. These lists are specified using the `param.n` notation\. Values of *n* are integers starting from 1\. - -For information about Amazon RDS Regions and endpoints, go to [Amazon Relational Database Service \(RDS\)](https://docs.aws.amazon.com/general/latest/gr/rande.html#rds_region) in the Regions and Endpoints section of the *Amazon Web Services General Reference*\. - -## Query request authentication - -You can only send Query requests over HTTPS, and you must include a signature in every Query request\. You must use either AWS signature version 4 or signature version 2\. For more information, see [ Signature Version 4 signing process](https://docs.aws.amazon.com/general/latest/gr/signature-version-4.html) and [ Signature version 2 signing process](https://docs.aws.amazon.com/general/latest/gr/signature-version-2.html)\. \ No newline at end of file diff --git a/doc_source/Viewing_Unifiedmetrics.md b/doc_source/Viewing_Unifiedmetrics.md deleted file mode 100644 index faffcc8..0000000 --- a/doc_source/Viewing_Unifiedmetrics.md +++ /dev/null @@ -1,145 +0,0 @@ -# Viewing combined metrics in the Amazon RDS console - -Amazon RDS now provides a consolidated view of Performance Insights and CloudWatch metrics for your DB instance in the Performance Insights dashboard\. You can use the preconfigured dashboard or create a custom dashboard\. The preconfigured dashboard provides the most commonly used metrics to help diagnose performance issues for a database engine\. Alternatively, you can create a custom dashboard with the metrics for a database engine that meet your analysis requirements\. Then, use this dashboard for all the DB instances of that database engine type in your AWS account\. - -You can choose the new monitoring view in the **Monitoring** tab or **Performance Insights** in the navigation pane\. When you navigate to the Performance Insights page, you see the options to choose between the new monitoring view and legacy view\. The option you choose is saved as the default view\. - -Performance Insights must be turned on for your DB instance to view the combined metrics in the Performance Insights dashboard\. For more information about turning on Performance Insights, see [Turning Performance Insights on and off](USER_PerfInsights.Enabling.md)\. - -Currently, the consolidated view of Performance Insights and CloudWatch metrics isn't available in the following AWS Regions: China \(Beijing\), China \(Ningxia\), AWS GovCloud \(US\-East\), and AWS GovCloud \(US\-West\)\. - -**Note** -We recommend that you choose the new monitoring view\. You can continue to use the legacy monitoring view until it is discontinued on December 15, 2023\. - -## Choosing the new monitoring view in the **Monitoring** tab - -**To choose the new monitoring view in the **Monitoring** tab:** - -1. Sign in to the AWS Management Console and open the Amazon RDS console at [https://console\.aws\.amazon\.com/rds/](https://console.aws.amazon.com/rds/)\. - -1. In the left navigation pane, choose **Databases**\. - -1. Choose the DB instance that you want to monitor\. - - The database page appears\. - -1. Scroll down and choose the **Monitoring** tab\. - - A banner appears with the option to choose the new monitoring view\. The following example shows the banner to choose the new monitoring view\. -![\[Banner with navigation to new monitoring view.\]](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/images/NewMonitoringViewOption.png) - -1. Choose **Go to new monitoring view** to open the Performance Insights dashboard with Performance Insights and CloudWatch metrics for your DB instance\. - -1. \(Optional\) If Performance Insights is turned off for your DB instance, a banner appears with the option to modify your DB cluster and turn on Performance Insights\. - - The following example shows the banner to modify the DB cluster in the **Monitoring** tab \. -![\[Modify DB instance to turn on Performance Insights.\]](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/images/Monitoring_modifyInstnc_banner.png) - - Choose **Modify** to modify your DB cluster and turn on Performance Insights\. For more information about turning on Performance Insights, see [Turning Performance Insights on and off](USER_PerfInsights.Enabling.md) - -## Choosing the new monitoring view with **Performance Insights** in the navigation pane - -**To choose the new monitoring view with **Performance Insights** in the navigation pane:** - -1. Sign in to the AWS Management Console and open the Amazon RDS console at [https://console\.aws\.amazon\.com/rds/](https://console.aws.amazon.com/rds/)\. - -1. In the left navigation pane, choose **Performance Insights**\. - -1. Choose a DB instance to open a window that has the monitoring view options\. - - The following example shows the window with the monitoring view options\. -![\[Window with the monitoring view options.\]](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/images/Monitoring_NewView.png) - -1. Choose the **Performance Insights and CloudWatch metrics view \(New\)** option, and then choose **Continue**\. - - You can now view the Performance Insights dashboard that shows both Performance Insights and CloudWatch metrics for your DB instance\. The following example shows the Performance Insights and CloudWatch metrics in the dashboard\. -![\[Consolidated Performance Insights and CloudWatch metrics dashboard.\]](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/images/Monitoring_UnifiedDashboard.png) - -## Choosing the legacy view with **Performance Insights** in the navigation pane - -You can choose the legacy monitoring view to view only the Performance Insights metrics for your DB instance\. - -**Note** -This view will be discontinued on December 15, 2023\. - -**To choose the legacy monitoring view with **Performance Insights** in the navigation pane:** - -1. Sign in to the AWS Management Console and open the Amazon RDS console at [https://console\.aws\.amazon\.com/rds/](https://console.aws.amazon.com/rds/)\. - -1. In the left navigation pane, choose **Performance Insights**\. - -1. Choose a DB instance\. - -1. Choose the settings icon on the Performance Insights dashboard\. - - You can now see the **Settings** window that shows the option to choose the legacy Performance Insights view\. - - The following example shows the window with the option for the legacy monitoring view\. -![\[Window with the option for the legacy Performance Insights view.\]](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/images/Monitoring_ModifyViewSettings.png) - -1. Select the **Performance Insights view** option and choose **Continue**\. - - A warning message appears\. Any dashboard configurations that you saved won't be available in this view\. - -1. Choose **Confirm** to continue to the legacy Performance Insights view\. - - You can now view the Performance Insights dashboard that shows only Performance Insights metrics for the DB instance\. - -## Creating a custom dashboard with **Performance Insights** in the navigation pane - -In the new monitoring view, you can create a custom dashboard with the metrics you need to meet your analysis requirements\. - -You can create a custom dashboard by selecting Performance Insights and CloudWatch metrics for your DB instance\. You can use this custom dashboard for other DB instances of the same database engine type in your AWS account\. - -**Note** -The customized dashboard supports up to 50 metrics\. - -Use the widget settings menu to edit or delete the dashboard, and move or resize the widget window\. - -**To create a custom dashboard with Performance Insights in the navigation pane:** - -1. Sign in to the AWS Management Console and open the Amazon RDS console at [https://console\.aws\.amazon\.com/rds/](https://console.aws.amazon.com/rds/)\. - -1. In the left navigation pane, choose **Performance Insights**\. - -1. Choose a DB instance\. - -1. Scroll down to the **Metrics tab** in the window\. - -1. Select the custom dashboard from the drop down list\. The following example shows the custom dashboard creation\. -![\[Custom metrics dashboard with no widgets yet.\]](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/images/Monitoring_custmDashbrd_addWidget.png) - -1. Choose **Add widget** to open the **Add widget** window\. You can open and view the available operating system \(OS\) metrics, database metrics, and CloudWatch metrics in the window\. - - The following example shows the **Add widget** window with the metrics\. -![\[The metrics options in the Add Widget window.\]](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/images/Monitoring_AddWidget.png) - -1. Select the metrics that you want to view in the dashboard and choose **Add widget**\. You can use the search field to find a specific metric\. - - The selected metrics appear on your dashboard\. - -1. \(Optional\) If you want to modify or delete your dashboard, choose the settings icon on the upper right of the widget, and then select one of the following actions in the menu\. - + **Edit** – Modify the metrics list in the window\. Choose **Update widget** after you select the metrics for your dashboard\. - + **Delete** – Deletes the widget\. Choose **Delete** in the confirmation window\. - -## Choosing the preconfigured dashboard with **Performance Insights** in the navigation pane - -You can view the most commonly used metrics with the preconfigured dashboard\. This dashboard helps diagnose performance issues with a database engine and reduce the average recovery time from hours to minutes\. - -**Note** -This dashboard can't be edited\. - -**To choose the preconfigured dashboard with Performance Insights in the navigation pane:** - -1. Sign in to the AWS Management Console and open the Amazon RDS console at [https://console\.aws\.amazon\.com/rds/](https://console.aws.amazon.com/rds/)\. - -1. In the left navigation pane, choose **Performance Insights**\. - -1. Choose a DB instance\. - -1. Scroll down to the **Metrics tab** in the window - -1. Select a preconfigured dashboard from the drop down list\. - - You can view the metrics for the DB instance in the dashboard\. The following example shows a preconfigured metrics dashboard\. -![\[Preconfigured metrics dashboard.\]](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/images/Monitoring_preconfigDashboard.png) \ No newline at end of file diff --git a/doc_source/Welcome.md b/doc_source/Welcome.md deleted file mode 100644 index 38e9739..0000000 --- a/doc_source/Welcome.md +++ /dev/null @@ -1,201 +0,0 @@ -# What is Amazon Relational Database Service \(Amazon RDS\)? - -Amazon Relational Database Service \(Amazon RDS\) is a web service that makes it easier to set up, operate, and scale a relational database in the AWS Cloud\. It provides cost\-efficient, resizable capacity for an industry\-standard relational database and manages common database administration tasks\. - -**Note** -This guide covers Amazon RDS database engines other than Amazon Aurora\. For information about using Amazon Aurora, see the [https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/CHAP_AuroraOverview.html](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/CHAP_AuroraOverview.html)\. - -If you are new to AWS products and services, begin learning more with the following resources: -+ For an overview of all AWS products, see [What is cloud computing?](http://aws.amazon.com/what-is-aws/) -+ Amazon Web Services provides a number of database services\. To learn more about the variety of database options available on AWS, see [Choosing an AWS database service](http://aws.amazon.com/getting-started/decision-guides/databases-on-aws-how-to-choose) and [Running databases on AWS](http://aws.amazon.com/running_databases/)\. - -## Overview of Amazon RDS - -Why do you want to run a relational database in the AWS Cloud? Because AWS takes over many of the difficult and tedious management tasks of a relational database\. - -**Topics** -+ [Amazon EC2 and on\-premises databases](#Welcome.Concepts.on-prem) -+ [Amazon RDS and Amazon EC2](#Welcome.Concepts.RDS) -+ [Amazon RDS Custom for Oracle and Microsoft SQL Server](#Welcome.Concepts.Custom) -+ [Amazon RDS on AWS Outposts](#Welcome.Concepts.Outposts) - -### Amazon EC2 and on\-premises databases - -Amazon Elastic Compute Cloud \(Amazon EC2\) provides scalable computing capacity in the AWS Cloud\. Amazon EC2 eliminates your need to invest in hardware up front, so you can develop and deploy applications faster\. - -When you buy an on\-premises server, you get CPU, memory, storage, and IOPS, all bundled together\. With Amazon EC2, these are split apart so that you can scale them independently\. If you need more CPU, less IOPS, or more storage, you can easily allocate them\. - -For a relational database in an on\-premises server, you assume full responsibility for the server, operating system, and software\. For a database on an Amazon EC2 instance, AWS manages the layers below the operating system\. In this way, Amazon EC2 eliminates some of the burden of managing an on\-premises database server\. - -In the following table, you can find a comparison of the management models for on\-premises databases and Amazon EC2\. - - -| Feature | On\-premises management | Amazon EC2 management | -| --- | --- | --- | -| Application optimization | Customer | Customer | -| Scaling | Customer | Customer | -| High availability | Customer | Customer | -| Database backups | Customer | Customer | -| Database software patching | Customer | Customer | -| Database software install | Customer | Customer | -| Operating system \(OS\) patching | Customer | Customer | -| OS installation | Customer | Customer | -| Server maintenance | Customer | AWS | -| Hardware lifecycle | Customer | AWS | -| Power, network, and cooling | Customer | AWS | - -Amazon EC2 isn't a fully managed service\. Thus, when you run a database on Amazon EC2, you're more prone to user errors\. For example, when you update the operating system or database software manually, you might accidentally cause application downtime\. You might spend hours checking every change to identify and fix an issue\. - -### Amazon RDS and Amazon EC2 - -Amazon RDS is a managed database service\. It's responsible for most management tasks\. By eliminating tedious manual tasks, Amazon RDS frees you to focus on your application and your users\. We recommend Amazon RDS over Amazon EC2 as your default choice for most database deployments\. - -In the following table, you can find a comparison of the management models in Amazon EC2 and Amazon RDS\. - - -| Feature | Amazon EC2 management | Amazon RDS management | -| --- | --- | --- | -| Application optimization | Customer | Customer | -| Scaling | Customer | AWS | -| High availability | Customer | AWS | -| Database backups | Customer | AWS | -| Database software patching | Customer | AWS | -| Database software install | Customer | AWS | -| OS patching | Customer | AWS | -| OS installation | Customer | AWS | -| Server maintenance | AWS | AWS | -| Hardware lifecycle | AWS | AWS | -| Power, network, and cooling | AWS | AWS | - -Amazon RDS provides the following specific advantages over database deployments that aren't fully managed: -+ You can use the database products you are already familiar with: MariaDB, Microsoft SQL Server, MySQL, Oracle, and PostgreSQL\. -+ Amazon RDS manages backups, software patching, automatic failure detection, and recovery\. -+ You can turn on automated backups, or manually create your own backup snapshots\. You can use these backups to restore a database\. The Amazon RDS restore process works reliably and efficiently\. -+ You can get high availability with a primary instance and a synchronous secondary instance that you can fail over to when problems occur\. You can also use read replicas to increase read scaling\. -+ In addition to the security in your database package, you can help control who can access your RDS databases\. To do so, you can use AWS Identity and Access Management \(IAM\) to define users and permissions\. You can also help protect your databases by putting them in a virtual private cloud \(VPC\)\. - -### Amazon RDS Custom for Oracle and Microsoft SQL Server - -Amazon RDS Custom is an RDS management type that gives you full access to your database and operating system\. - -You can use the control capabilities of RDS Custom to access and customize the database environment and operating system for legacy and packaged business applications\. Meanwhile, Amazon RDS automates database administration tasks and operations\. - -In this deployment model, you can install applications and change configuration settings to suit your applications\. At the same time, you can offload database administration tasks such as provisioning, scaling, upgrading, and backup to AWS\. You can take advantage of the database management benefits of Amazon RDS, with more control and flexibility\. - -For Oracle Database and Microsoft SQL Server, RDS Custom combines the automation of Amazon RDS with the flexibility of Amazon EC2\. For more information on RDS Custom, see [Working with Amazon RDS Custom](rds-custom.md)\. - -With the shared responsibility model of RDS Custom, you get more control than in Amazon RDS, but also more responsibility\. For more information, see [Shared responsibility model](rds-custom.md#custom-intro.solution.shared)\. - -### Amazon RDS on AWS Outposts - -Amazon RDS on AWS Outposts extends RDS for SQL Server, RDS for MySQL, and RDS for PostgreSQL databases to AWS Outposts environments\. AWS Outposts uses the same hardware as in public AWS Regions to bring AWS services, infrastructure, and operation models on\-premises\. With RDS on Outposts, you can provision managed DB instances close to the business applications that must run on\-premises\. For more information, see [Working with Amazon RDS on AWS Outposts](rds-on-outposts.md)\. - -## DB instances - -A *DB instance* is an isolated database environment in the AWS Cloud\. The basic building block of Amazon RDS is the DB instance\. - -Your DB instance can contain one or more user\-created databases\. You can access your DB instance by using the same tools and applications that you use with a standalone database instance\. You can create and modify a DB instance by using the AWS Command Line Interface \(AWS CLI\), the Amazon RDS API, or the AWS Management Console\. - -### DB engines - -A *DB engine* is the specific relational database software that runs on your DB instance\. Amazon RDS currently supports the following engines: -+ MariaDB -+ Microsoft SQL Server -+ MySQL -+ Oracle -+ PostgreSQL - -Each DB engine has its own supported features, and each version of a DB engine can include specific features\. Support for Amazon RDS features varies across AWS Regions and specific versions of each DB engine\. To check feature support in different engine versions and Regions, see [Supported features in Amazon RDS by AWS Region and DB engine](Concepts.RDSFeaturesRegionsDBEngines.grids.md)\. - -Additionally, each DB engine has a set of parameters in a DB parameter group that control the behavior of the databases that it manages\. - -### DB instance classes - -A *DB instance class* determines the computation and memory capacity of a DB instance\. A DB instance class consists of both the DB instance type and the size\. Each instance type offers different compute, memory, and storage capabilities\. For example, db\.m6g is a general\-purpose DB instance type powered by AWS Graviton2 processors\. Within the db\.m6g instance type, db\.m6g\.2xlarge is a DB instance class\. - -You can select the DB instance that best meets your needs\. If your needs change over time, you can change DB instances\. For information, see [DB instance classes](Concepts.DBInstanceClass.md)\. - -**Note** -For pricing information on DB instance classes, see the Pricing section of the [Amazon RDS](http://aws.amazon.com/rds/) product page\. - -### DB instance storage - -Amazon EBS provides durable, block\-level storage volumes that you can attach to a running instance\. DB instance storage comes in the following types: -+ General Purpose \(SSD\) -+ Provisioned IOPS \(PIOPS\) -+ Magnetic - -The storage types differ in performance characteristics and price\. You can tailor your storage performance and cost to the needs of your database\. - -Each DB instance has minimum and maximum storage requirements depending on the storage type and the database engine it supports\. It's important to have sufficient storage so that your databases have room to grow\. Also, sufficient storage makes sure that features for the DB engine have room to write content or log entries\. For more information, see [Amazon RDS DB instance storage](CHAP_Storage.md)\. - -### Amazon Virtual Private Cloud \(Amazon VPC\) - -You can run a DB instance on a virtual private cloud \(VPC\) using the Amazon Virtual Private Cloud \(Amazon VPC\) service\. When you use a VPC, you have control over your virtual networking environment\. You can choose your own IP address range, create subnets, and configure routing and access control lists\. The basic functionality of Amazon RDS is the same whether it's running in a VPC or not\. Amazon RDS manages backups, software patching, automatic failure detection, and recovery\. There's no additional cost to run your DB instance in a VPC\. For more information on using Amazon VPC with RDS, see [Amazon VPC VPCs and Amazon RDS](USER_VPC.md)\. - -Amazon RDS uses Network Time Protocol \(NTP\) to synchronize the time on DB instances\. - -## AWS Regions and Availability Zones - -Amazon cloud computing resources are housed in highly available data center facilities in different areas of the world \(for example, North America, Europe, or Asia\)\. Each data center location is called an AWS Region\. - -Each AWS Region contains multiple distinct locations called Availability Zones, or AZs\. Each Availability Zone is engineered to be isolated from failures in other Availability Zones\. Each is engineered to provide inexpensive, low\-latency network connectivity to other Availability Zones in the same AWS Region\. By launching instances in separate Availability Zones, you can protect your applications from the failure of a single location\. For more information, see [Regions, Availability Zones, and Local Zones](Concepts.RegionsAndAvailabilityZones.md)\. - -You can run your DB instance in several Availability Zones, an option called a Multi\-AZ deployment\. When you choose this option, Amazon automatically provisions and maintains one or more secondary standby DB instances in a different Availability Zone\. Your primary DB instance is replicated across Availability Zones to each secondary DB instance\. This approach helps provide data redundancy and failover support, eliminate I/O freezes, and minimize latency spikes during system backups\. In a Multi\-AZ DB clusters deployment, the secondary DB instances can also serve read traffic\. For more information, see [Configuring and managing a Multi\-AZ deployment](Concepts.MultiAZ.md)\. - -## Security - -A *security group *controls the access to a DB instance\. It does so by allowing access to IP address ranges or Amazon EC2 instances that you specify\. - -For more information about security groups, see [Security in Amazon RDS](UsingWithRDS.md)\. - -## Amazon RDS monitoring - -There are several ways that you can track the performance and health of a DB instance\. You can use the Amazon CloudWatch service to monitor the performance and health of a DB instance\. CloudWatch performance charts are shown in the Amazon RDS console\. You can also subscribe to Amazon RDS events to be notified about changes to a DB instance, DB snapshot, or DB parameter group\. For more information, see [Monitoring metrics in an Amazon RDS instance](CHAP_Monitoring.md)\. - -## How to work with Amazon RDS - -There are several ways that you can interact with Amazon RDS\. - -### AWS Management Console - -The AWS Management Console is a simple web\-based user interface\. You can manage your DB instances from the console with no programming required\. To access the Amazon RDS console, sign in to the AWS Management Console and open the Amazon RDS console at [https://console\.aws\.amazon\.com/rds/](https://console.aws.amazon.com/rds/)\. - -### Command line interface - -You can use the AWS Command Line Interface \(AWS CLI\) to access the Amazon RDS API interactively\. To install the AWS CLI, see [Installing the AWS Command Line Interface](https://docs.aws.amazon.com/cli/latest/userguide/installing.html)\. To begin using the AWS CLI for RDS, see [AWS Command Line Interface reference for Amazon RDS](https://docs.aws.amazon.com/cli/latest/reference/rds/index.html)\. - -### Amazon RDS APIs - -If you are a developer, you can access the Amazon RDS programmatically using APIs\. For more information, see [Amazon RDS API reference](ProgrammingGuide.md)\. - -For application development, we recommend that you use one of the AWS Software Development Kits \(SDKs\)\. The AWS SDKs handle low\-level details such as authentication, retry logic, and error handling, so that you can focus on your application logic\. AWS SDKs are available for a wide variety of languages\. For more information, see [Tools for Amazon web services ](https://aws.amazon.com/tools/)\. - -AWS also provides libraries, sample code, tutorials, and other resources to help you get started more easily\. For more information, see [Sample code & libraries](https://aws.amazon.com/code)\. - -## How you are charged for Amazon RDS - -When you use Amazon RDS, you can choose to use on\-demand DB instances or reserved DB instances\. For more information, see [DB instance billing for Amazon RDS](User_DBInstanceBilling.md)\. - -For Amazon RDS pricing information, see the [Amazon RDS product page](https://aws.amazon.com/rds/pricing)\. - -## What's next? - -The preceding section introduced you to the basic infrastructure components that RDS offers\. What should you do next? - -### Getting started - -Create a DB instance using instructions in [Getting started with Amazon RDS](CHAP_GettingStarted.md)\. - -### Topics specific to database engines - -You can review information specific to a particular DB engine in the following sections: -+ [Amazon RDS for MariaDB](CHAP_MariaDB.md) -+ [Amazon RDS for Microsoft SQL Server](CHAP_SQLServer.md) -+ [Amazon RDS for MySQL](CHAP_MySQL.md) -+ [Amazon RDS for Oracle](CHAP_Oracle.md) -+ [Amazon RDS for PostgreSQL](CHAP_PostgreSQL.md) - -## Amazon RDS shared responsibility model - -Amazon RDS is responsible for hosting the software components and infrastructure of DB instances and DB cluster\. You are responsible for query tuning, which is the process of adjusting SQL queries to improve performance\. Query performance is highly dependent on database design, data size, data distribution, application workload, and query patterns, which can vary greatly\. Monitoring and tuning are highly individualized processes that you own for your RDS databases\. You can use Amazon RDS Performance Insights and other tools to identify problematic queries\. \ No newline at end of file diff --git a/doc_source/WhatsNew.md b/doc_source/WhatsNew.md deleted file mode 100644 index 60cae7e..0000000 --- a/doc_source/WhatsNew.md +++ /dev/null @@ -1,636 +0,0 @@ -# Document history - -**Current API version: **2014\-10\-31 - -The following table describes important changes in each release of the *Amazon RDS User Guide* after May 2018\. For notification about updates to this documentation, you can subscribe to an RSS feed\. - -**Note** -You can filter new Amazon RDS features on the [What's New with Database?](http://aws.amazon.com/about-aws/whats-new/database/) page\. For **Products**, choose **Amazon RDS**\. Then search using keywords such as **RDS Proxy** or **Oracle 2023**\. - -| Change | Description | Date | -| --- |--- |--- | -| [RDS Custom for SQL Server supports Bring Your Own Media \(BYOM\)](#WhatsNew) | You can now create a Custom Engine Version \(CEV\) using your own SQL Server media\. For more information, see [Bring Your Own Media with RDS Custom for SQL Server](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/custom-sqlserver.byom.html)\. | June 8, 2023 | -| [RDS for Oracle can convert an Oracle Database 19c non\-CDB to a CDB](#WhatsNew) | If your DB instance runs Oracle Database 19c with the April 2021 or higher RU, you can convert a non\-CDB to a CDB \(container database\)\. After you convert the architecture, you can upgrade your 19c CDB to a 21c CDB\. This step is necessary because you can't upgrade your database and convert the architecture using a single command\. For more information, see [ Converting an RDS for Oracle non\-CDB into a CDB](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/oracle-multitenant.html#oracle-cdb-converting)\. | May 31, 2023 | -| [Update to AWS managed policy permissions](#WhatsNew) | The `AmazonRDSCustomServiceRolePolicy` of the `AWSServiceRoleForRDSCustom` service\-linked role has new permissions that allow RDS Custom to create network interfaces\. For more information, see [ Amazon RDS updates to AWS managed policies](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/rds-manpol-updates.html)\. | May 30, 2023 | -| [Multi\-AZ DB clusters available in the China Regions](#WhatsNew) | Multi\-AZ DB clusters are now available in the AWS Regions China \(Beijing\) and China \(Ningxia\)\. For more information, see [Multi\-AZ DB clusters](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Concepts.RDS_Fea_Regions_DB-eng.Feature.MultiAZDBClusters.html)\. | May 30, 2023 | -| [Amazon RDS Optimized Reads support for Multi\-AZ DB clusters](#WhatsNew) | Amazon RDS Optimized Reads now supports Multi\-AZ DB clusters\. For more information, see [Improving query performance for RDS for MySQL with Amazon RDS Optimized Reads](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/rds-optimized-reads.html) and [Improving query performance for RDS for PostgreSQL with Amazon RDS Optimized Reads](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_PostgreSQL.optimizedreads.html)\. | May 30, 2023 | -| [Create a DB instance read replica with a source RDS for PostgreSQL Multi\-AZ DB cluster](#WhatsNew) | You can now create a DB instance read replica with an RDS for PostgreSQL Multi\-AZ DB cluster as the source\. Previously, only RDS for MySQL was supported\. For more information, see [Creating a DB instance read replica from a Multi\-AZ DB cluster](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_MultiAZDBCluster_ReadRepl.html#multi-az-db-clusters-create-instance-read-replica)\. | May 24, 2023 | -| [Amazon RDS provides combined Performance Insights and CloudWatch metrics in the Performance Insights dashboard](#WhatsNew) | Amazon RDS now provides a consolidated view of Performance Insights and CloudWatch metrics in the Performance Insights dashboard\. For more information, see [ Viewing combined metrics in the Amazon RDS console](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Viewing_Unifiedmetrics.html)\. | May 24, 2023 | -| [Amazon RDS Optimized Reads available in the China Regions](#WhatsNew) | Amazon RDS Optimized Reads is now available in the AWS Regions China \(Beijing\) and China \(Ningxia\)\. For more information, see [Improving query performance for RDS for MariaDB with Amazon RDS Optimized Reads](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/rds-optimized-reads-mariadb.html) and [ Improving query performance for RDS for MySQL with Amazon RDS Optimized Reads](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/rds-optimized-reads.html)\. | April 24, 2023 | -| [Amazon RDS support for AWS Secrets Manager in the China Regions](#WhatsNew) | Amazon RDS supports Secrets Manager in the China \(Beijing\) and China \(Ningxia\) Regions\. For more information, see [Password management with Amazon RDS and AWS Secrets Manager](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/rds-secrets-manager.html)\. | April 20, 2023 | -| [RDS Custom for Oracle supports reuse of AMI IDs for new CEVs](#WhatsNew) | When you create a custom engine version \(CEV\), RDS Custom for Oracle defaults to the most recent Amazon Machine Image \(AMI\) available\. Now you can specify an AMI ID that was used in a previous CEV\. For more information, see [Creating a CEV](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/custom-cev.create.html)\. | April 19, 2023 | -| [Amazon RDS supports publishing events with tags to topic subscribers](#WhatsNew) | Amazon RDS event notifications sent to Amazon Simple Notification Service \(Amazon SNS\) or Amazon EventBridge now contain event tags in the message body\. These tags provide the resource data that was affected by the service event\. For more information, see [ Amazon RDS event notification tags and attributes](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Events.TagsAttributesForFiltering.html)\. | April 17, 2023 | -| [Purchase reserved instances for a Multi\-AZ DB cluster](#WhatsNew) | You can now purchase reserved DB instances for a Multi\-AZ DB cluster\. For more information, see [Reserved DB instances for a Multi\-AZ DB cluster](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_WorkingWithReservedDBInstances.html#USER_WorkingWithReservedDBInstances.MultiAZDBClusters)\. | April 12, 2023 | -| [Amazon RDS supports the db\.m7g and db\.r7g instance classes](#WhatsNew) | You can now use the db\.m7g and db\.r7g instance classes for RDS for MySQL, RDS for MariaDB, and RDS for PostgreSQL DB instances\. For more information, see [Supported DB engines for DB instance classes](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Concepts.DBInstanceClass.html#Concepts.DBInstanceClass.Support)\. | April 12, 2023 | -| [Update to Amazon RDS Custom service\-linked role permissions](#WhatsNew) | The `AmazonRDSCustomServiceRolePolicy` now grants additional permissions to allow RDS Custom for SQL Server to use Amazon SQS and create snapshots\. For more information, see [ Updates to AWS managed policies](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/rds-manpol-updates.html)\. | April 6, 2023 | -| [Migrate to an RDS for MySQL Multi\-AZ DB cluster using a read replica](#WhatsNew) | You can now use a read replica to migrate an RDS for MySQL Single\-AZ deployment or Multi\-AZ DB instance deployment to an RDS for MySQL Multi\-AZ DB cluster deployment with reduced downtime\. For more information, see [Migrating to a Multi\-AZ DB cluster using a read replica](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_MultiAZDBCluster_ReadRepl.html#multi-az-db-clusters-migrating-to-with-read-replica)\. | April 6, 2023 | -| [Create a DB instance read replica from a Multi\-AZ DB cluster](#WhatsNew) | You can now create a DB instance read replica from a Multi\-AZ DB cluster in order to scale beyond the compute capacity of the source cluster\. For more information, see [Creating a DB instance read replica from a Multi\-AZ DB cluster](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_MultiAZDBCluster_ReadRepl.html#multi-az-db-clusters-create-instance-read-replica)\. | April 6, 2023 | -| [Amazon RDS Custom for SQL Server supports Multi\-AZ](#WhatsNew) | You can create a Multi\-AZ deployment with RDS Custom for SQL Server\. For more information, see [ Managing a Multi\-AZ deployment for RDS Custom for SQL Server](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/custom-sqlserver-multiaz.html)\. | April 6, 2023 | -| [Update to AWS managed policy permissions](#WhatsNew) | The `AmazonRDSFullAccess` and `AmazonRDSReadOnlyAccess` policies now grants additional permissions to allow the display of Amazon DevOps Guru findings in the RDS console\. For more information, see [ Amazon RDS updates to AWS managed policies](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/rds-manpol-updates.html)\. | March 30, 2023 | -| [Amazon RDS supports Oracle APEX version 22\.2\.v1](#WhatsNew) | You can use APEX 22\.2\.v1 with all supported versions of Oracle Database\. For more information, see [Oracle Application Express](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Appendix.Oracle.Options.APEX.html)\. | March 30, 2023 | -| [Amazon DevOps Guru available for RDS for PostgreSQL](#WhatsNew) | RDS for PostgreSQL alerts you to recent anomalies detected by Amazon DevOps Guru\. The database details page of the console alerts you to current and anomalies that occurred in the past 24 hours\. DevOps Guru publishes proactive insights with recommendations to help address issues in your RDS for PostgreSQL databases before they are predicted to happen\. For more information, see [How DevOps Guru for RDS works](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/devops-guru-for-rds.html#devops-guru-for-rds.how-it-works)\. | March 30, 2023 | -| [RDS Custom supports the Amazon EBS gp3 storage volume](#WhatsNew) | RDS Custom for Oracle and RDS Custom for SQL Server both support the io1, gp2, and gp3 SSD\-based EBS volumes\. For more information, see [General requirements for RDS Custom for Oracle](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/custom-reqs-limits.html#custom-reqs-limits.reqs) and [General requirements for RDS Custom for SQL Server](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/custom-reqs-limits-MS.html#custom-reqs-limits.reqsMS)\. | March 29, 2023 | -| [Update to AWS managed policy permissions](#WhatsNew) | The `AmazonRDSFullAccess` and `AmazonRDSReadOnlyAccess` policies now grants additional permissions to Amazon CloudWatch\. For more information, see [ Amazon RDS updates to AWS managed policies](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/rds-manpol-updates.html)\. | March 16, 2023 | -| [RDS Proxy is available in the China Regions](#WhatsNew) | RDS Proxy is now available in the China \(Beijing\) and China \(Ningxia\) regions\. For more information about RDS Proxy, see [Using Amazon RDS Proxy](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/rds-proxy.html)\. | March 15, 2023 | -| [RDS Proxy is available in the Asia Pacific \(Jakarta\) Region](#WhatsNew) | RDS Proxy is now available in the Asia Pacific \(Jakarta\) Region\. For more information about RDS Proxy, see [Using Amazon RDS Proxy](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/rds-proxy.html)\. | March 8, 2023 | -| [Amazon RDS Optimized Writes improves the performance of write transactions for RDS for MariaDB](#WhatsNew) | You can improve the performance of write transactions for RDS for MariaDB DB instances with Amazon RDS Optimized Writes\. For more information, see [Improving write performance with Amazon RDS Optimized Writes for MariaDB](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/rds-optimized-writes-mariadb.html)\. | March 7, 2023 | -| [Amazon RDS for PostgreSQL versions 15\.2](#WhatsNew) | New features in Amazon RDS for PostgreSQL 15\.2 include the SQL standard "MERGE" command for conditional SQL queries, performance improvements for both in\-memory and disk\-based sorting, and support for two\-phase commit and row/column filtering for logical replication\. | February 27, 2023 | -| [RDS Custom for Oracle is available in the Canada \(Central\) Region and South America \(São Paulo\) Regions](#WhatsNew) | For a table that shows all supported AWS Regions, see [ RDS Custom for Oracle](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Concepts.RDS_Fea_Regions_DB-eng.Feature.RDSCustom.html#Concepts.RDS_Fea_Regions_DB-eng.Feature.RDSCustom.ora)\. | February 22, 2023 | -| [Amazon RDS supports cross\-Region automated backups for RDS for MariaDB and RDS for MySQL](#WhatsNew) | You can now replicate DB snapshots and transaction logs between AWS Regions for RDS for MariaDB and RDS for MySQL DB instances\. For more information, see [Replicating automated backups to another AWS Region](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_ReplicateBackups.html)\. | February 22, 2023 | -| [Amazon RDS for Oracle supports advance notice of automatic minor version upgrades](#WhatsNew) | RDS notifies you in advance of the date when a new minor version of the RDS for Oracle engine will become available\. RDS begins scheduling automatic minor version upgrades of your RDS for Oracle DB instances on the availability date\. For more information, see [Before an automatic minor version upgrade is scheduled](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_UpgradeDBInstance.Oracle.Minor.html#oracle-minor-version-upgrade-advance)\. | February 21, 2023 | -| [Amazon RDS for SQL Server supports Database Activity Streams](#WhatsNew) | You can now monitor a SQL Server DB instance using Database Activity Streams\. A SQL Server database instance has the server audit which is managed by Amazon RDS\. You can define the policies to record server events in the server audit specification\. You can create a database audit specification and define the policies to record database events\. The stream of activity is collected and transmitted to Amazon Kinesis\. From Kinesis, you can monitor the activity stream for further analysis\. For more information, see [Monitoring Amazon RDS with Database Activity Streams](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/DBActivityStreams.html)\. | February 15, 2023 | -| [RDS supports MySQL 8\.0\.32 and 5\.7\.41](#WhatsNew) | You can now create Amazon RDS DB instances running MySQL version 8\.0\.32 and 5\.7\.41\. For more information, see [ MySQL on Amazon RDS versions](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/MySQL.Concepts.VersionMgmt.html)\. | February 7, 2023 | -| [Amazon RDS for Oracle supports new cipher suites for SSL](#WhatsNew) | If you run Oracle Database 19c or 21c, you can specify six new cipher suites in the `SSL` option for RDS for Oracle\. These suites support FIPS and are FedRAMP\-complaint\. For more information, see [ Oracle Secure Sockets Layer](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Appendix.Oracle.Options.SSL.html)\. | February 3, 2023 | -| [Amazon RDS for Oracle supports new cipher suites for Oracle Enterprise Manager](#WhatsNew) | You can use four new FedRAMP\-compliant cipher suites for the `OEM` option\. For more information, see [Oracle Management Agent for Enterprise Manager Cloud Control](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Oracle.Options.OEMAgent.html)\. | February 3, 2023 | -| [RDS for Oracle supports Database Activity Streams in the Asia Pacific \(Hyderabad\), Europe \(Spain\), and Middle East \(UAE\) Regions](#WhatsNew) | For more information, see [Database Activity Streams](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Concepts.RDS_Fea_Regions_DB-eng.Feature.DBActivityStreams.html)\. | January 27, 2023 | -| [Migrate to an RDS for PostgreSQL Multi\-AZ DB cluster using a read replica](#WhatsNew) | By using a read replica, you can migrate an RDS for PostgreSQL Single\-AZ deployment or Multi\-AZ DB instance deployment to an RDS for PostgreSQL Multi\-AZ DB cluster deployment with reduced downtime\. For more information, see [ Migrating to a Multi\-AZ DB cluster using a read replica](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/multi-az-db-clusters-concepts.html#multi-az-db-clusters-migrating-to-with-read-replica)\. | January 23, 2023 | -| [Amazon RDS is available in the Asia Pacific \(Melbourne\) Region](#WhatsNew) | Amazon RDS is now available in the Asia Pacific \(Melbourne\) Region\. For more information, see [Regions and Availability Zones](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Concepts.RegionsAndAvailabilityZones.html)\. | January 23, 2023 | -| [RDS for MariaDB supports enforcing SSL/TLS connections](#WhatsNew) | RDS for MariaDB now supports enforcing SSL/TLS connections by setting the `require_secure_transport` parameter to `ON`\. For more information, see [ Requiring SSL/TLS for all connections to a MariaDB DB instance](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/mariadb-ssl-connections.html#mariadb-ssl-connections.require-ssl)\. | January 19, 2023 | -| [Amazon RDS Optimized Reads improves query performance for RDS for MariaDB](#WhatsNew) | You can achieve faster query processing for RDS for MariaDB DB instances with Amazon RDS Optimized Reads\. For more information, see [ Improving query performance for RDS for MariaDB with Amazon RDS Optimized Reads](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/rds-optimized-reads-mariadb.html)\. | January 11, 2023 | -| [Restore a Multi\-AZ DB cluster snapshot to a DB instance](#WhatsNew) | You can now restore a Multi\-AZ DB cluster snapshot to a Single\-AZ deployment or Multi\-AZ DB instance deployment\. For more information, see [ Restoring from a Multi\-AZ DB cluster snapshot to a DB instance](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_RestoreFromMultiAZDBClusterSnapshot.html)\. | January 10, 2023 | -| [Specify certificate authority \(CA\) during DB instance creation](#WhatsNew) | You can now specify which CA to use for a DB instance's server certificate during DB instance creation\. For more information, see [ Certificate authorities](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/UsingWithRDS.SSL.html#UsingWithRDS.SSL.RegionCertificateAuthorities)\. | January 5, 2023 | -| [RDS Custom for SQL Server supports custom engine versions](#WhatsNew) | A custom engine version \(CEV\) for RDS Custom for SQL Server is an Amazon Machine Image \(AMI\) with Microsoft SQL Server pre\-installed\. You choose an Amazon EC2 Windows AMI to use as a base image and can install other software on the operating system \(OS\)\. You can customize the configuration of the OS and SQL Server to meet your enterprise needs\. For more information, see [ Working with custom engine versions for RDS Custom for SQL Server](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/custom-cev-sqlserver.html)\. | December 28, 2022 | -| [Use Amazon RDS Blue/Green Deployments available in additional AWS Regions](#WhatsNew) | The Blue/Green Deployments feature is now available in the China \(Beijing\) and China \(Ningxia\) Regions\. For more information, see [ Using Amazon RDS Blue/Green Deployments for database updates](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/blue-green-deployments.html)\. | December 22, 2022 | -| [Update to IAM service\-linked role permissions](#WhatsNew) | The AmazonRDSServiceRolePolicy policy now grants additional permissions to AWS Secrets Manager\. For more information, see [ Amazon RDS updates to AWS managed policies](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/rds-manpol-updates.html)\. | December 22, 2022 | -| [Amazon RDS supports renaming a Multi\-AZ DB cluster](#WhatsNew) | You can now rename a Multi\-AZ DB cluster\. For more information, see [Renaming a Multi\-AZ DB cluster](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/multi-az-db-cluster-rename.html)\. | December 22, 2022 | -| [Amazon RDS integrates with AWS Secrets Manager for password management](#WhatsNew) | Amazon RDS can manage the master user password for a DB instance or Multi\-AZ DB cluster in Secrets Manager\. For more information, see [ Password management with Amazon RDS and AWS Secrets Manager](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/rds-secrets-manager.html)\. | December 22, 2022 | -| [Amazon RDS Optimized Writes supports the db\.r6g and db\.r6gd DB instance classes](#WhatsNew) | Amazon RDS Optimized Writes now supports the db\.r6g and db\.r6gd DB instance classes\. For more information, see [ Improving write performance with Amazon RDS Optimized Writes](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/rds-optimized-writes.html)\. | December 22, 2022 | -| [Amazon RDS Custom for Oracle supports new AWS Regions](#WhatsNew) | You can create RDS Custom for Oracle DB instances in the Asia Pacific \(Seoul\) and Asia Pacific \(Osaka\) Regions\. For more information, see [RDS Custom for Oracle for Oracle](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Concepts.RDS_Fea_Regions_DB-eng.Feature.RDSCustom.html#Concepts.RDS_Fea_Regions_DB-eng.Feature.RDSCustom.ora)\. | December 21, 2022 | -| [Amazon RDS on AWS Outposts supports read replicas](#WhatsNew) | You can now create a read replica from an RDS on Outposts MySQL or PostgreSQL DB instance\. For more information, see [ Creating read replicas for Amazon RDS on AWS Outposts](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/rds-on-outposts.rr.html)\. | December 19, 2022 | -| [RDS Custom for Oracle supports modifying the DB instance class](#WhatsNew) | You can now change the instance class of your RDS Custom for Oracle DB instance\. For more information, see [ Modifying your RDS Custom for Oracle DB instance](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/custom-managing.html#custom-managing.modifying)\. | December 16, 2022 | -| [RDS for MySQL and RDS for PostgreSQL support db\.x2iedn DB instance classes](#WhatsNew) | You can now use the db\.x2iedn DB instance classes for RDS for MySQL and RDS for PostgreSQL DB instances\. For more information, see [Supported DB engines for DB instance classes](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Concepts.DBInstanceClass.html#Concepts.DBInstanceClass.Support)\. | December 14, 2022 | -| [Amazon RDS Optimized Writes supports db\.x2iedn DB instance classes](#WhatsNew) | Amazon RDS Optimized Writes now supports db\.x2iedn DB instance classes\. For more information, see [ Improving write performance with Amazon RDS Optimized Writes](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/rds-optimized-writes.html)\. | December 14, 2022 | -| [Amazon RDS supports copying DB option groups when copying DB snapshots](#WhatsNew) | You can now copy an option group across AWS accounts as part of a snapshot copy request on RDS for Oracle databases\. For more information, see [Option group considerations](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_CopySnapshot.html#USER_CopySnapshot.Options)\. | December 13, 2022 | -| [Amazon RDS supports RDS Proxy with RDS for PostgreSQL version 14](#WhatsNew) | You can now create an RDS Proxy with an RDS for PostgreSQL version 14 database\. For more information about RDS Proxy, see [Using Amazon RDS Proxy](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/rds-proxy.html)\. | December 13, 2022 | -| [Amazon RDS for Oracle supports db\.x2idn, db\.x2iedn, and db\.x2iezn instance classes](#WhatsNew) | You can now use the db\.x2idn, db\.x2iedn, and db\.x2iezn instance classes for Amazon RDS for Oracle DB instances\. For more information, see [Supported DB engines for DB instance classes](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Concepts.DBInstanceClass.html#Concepts.DBInstanceClass.Support) and [Supported RDS for Oracle instance classes](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Oracle.Concepts.InstanceClasses.html#Oracle.Concepts.InstanceClasses.Supported)\. | December 12, 2022 | -| [RDS for PostgreSQL DB instances support Trusted Language Extensions for PostgreSQL](#WhatsNew) | Trusted Language Extensions for PostgreSQL is an open source development kit that allows you to build high performance PostgreSQL extensions and safely run them on your RDS for PostgreSQL DB instance\. For more information, see [Working with Trusted Language Extensions for PostgreSQL](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/PostgreSQL_trusted_language_extension.html)\. | November 30, 2022 | -| [Use Amazon RDS Blue/Green Deployments for database updates](#WhatsNew) | You can make changes to a DB instance in a staging environment and test the changes without affecting your production DB instance\. When you are ready, you can promote the staging environment to be the new production environment, with minimal downtime\. For more information, see [ Using Amazon RDS Blue/Green Deployments for database updates](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/blue-green-deployments.html)\. | November 27, 2022 | -| [Amazon RDS Optimized Writes improves the performance of write transactions for RDS for MySQL](#WhatsNew) | You can improve the performance of write transactions for RDS for MySQL DB instances with Amazon RDS Optimized Writes\. For more information, see [Improving write performance with Amazon RDS Optimized Writes for MySQL](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/rds-optimized-writes.html)\. | November 27, 2022 | -| [Amazon RDS Optimized Reads improves query performance for RDS for MySQL](#WhatsNew) | You can achieve faster query processing for RDS for MySQL DB instances with Amazon RDS Optimized Reads\. For more information, see [Improving query performance with Amazon RDS Optimized Reads](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/rds-optimized-reads.html)\. | November 27, 2022 | -| [Amazon RDS is available in the Asia Pacific \(Hyderabad\) Region](#WhatsNew) | Amazon RDS is now available in the Asia Pacific \(Hyderabad\) Region\. For more information, see [Regions and Availability Zones](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Concepts.RegionsAndAvailabilityZones.html)\. | November 22, 2022 | -| [RDS supports MariaDB 10\.6\.11, 10\.5\.18, 10\.4\.27, and 10\.3\.37](#WhatsNew) | You can now create Amazon RDS DB instances running MariaDB versions 10\.6\.11, 10\.5\.18, 10\.4\.27, and 10\.3\.37\. For more information, see [ MariaDB on Amazon RDS versions](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/MariaDB.Concepts.VersionMgmt.html)\. | November 18, 2022 | -| [RDS Custom for Oracle supports setting nondefault installation parameters in a custom engine version \(CEV\)](#WhatsNew) | When you create a CEV, you can set nondefault values for the Oracle base, Oracle home, UNIX user name and ID, and UNIX group name and ID\. In this way, you gain more control over the database installation on your RDS Custom for Oracle DB instance\. For more information, see [Preparing the CEV manifest](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/custom-cev.preparing.html#custom-cev.preparing.manifest)\. | November 18, 2022 | -| [Amazon RDS supports Oracle APEX version 22\.1\.v1](#WhatsNew) | You can use APEX 22\.1\.v1 with all supported versions of Oracle Database\. For more information, see [Oracle Application Express](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Appendix.Oracle.Options.APEX.html)\. | November 18, 2022 | -| [RDS for SQL Server supports cross\-Region read replicas](#WhatsNew) | You can now create a cross\-Region read replica to enhance disaster recovery capability, reduce application read latency, and offload read workloads from the primary DB Instance\. For more information, see [Creating a read replica in a different AWS Region](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_ReadRepl.html#USER_ReadRepl.XRgn)\. | November 16, 2022 | -| [Amazon RDS is available in the Europe \(Spain\) Region](#WhatsNew) | Amazon RDS is now available in the Europe \(Spain\) Region\. For more information, see [Regions and Availability Zones](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Concepts.RegionsAndAvailabilityZones.html)\. | November 16, 2022 | -| [RDS for SQL Server supports linked servers for Oracle database](#WhatsNew) | You can now create a linked server to access external Oracle databases to read data and execute SQL commands\. For more information, see [Linked Servers with Oracle OLEDB with RDS for SQL Server](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Appendix.SQLServer.Options.LinkedServers_Oracle_OLEDB.html)\. | November 15, 2022 | -| [RDS Custom for Oracle supports Oracle Multitenant](#WhatsNew) | You can create an RDS Custom for Oracle DB instance as a container database \(CDB\)\. After creation, the CDB contains the CDB root, PDB seed, and one PDB\. You can add more PDBs manually using Oracle SQL\. For more information, see [ Overview of Amazon RDS Custom for Oracle architecture](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/custom-creating.html#custom-creating.overview)\. | November 15, 2022 | -| [Amazon RDS for Oracle supports Amazon EFS integration](#WhatsNew) | If you add the `EFS_INTEGRATION` option to your option group, you can transfer files between your RDS for Oracle DB instance and an Amazon EFS file system\. For more information, see [Amazon EFS](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/oracle-efs-integration.html)\. | November 15, 2022 | -| [RDS supports MySQL 8\.0\.31 and 5\.7\.40](#WhatsNew) | You can now create Amazon RDS DB instances running MySQL version 8\.0\.31 and 5\.7\.40\. For more information, see [ MySQL on Amazon RDS versions](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/MySQL.Concepts.VersionMgmt.html)\. | November 10, 2022 | -| [Amazon RDS is available in the Europe \(Zurich\) Region](#WhatsNew) | Amazon RDS is now available in the Europe \(Zurich\) Region\. For more information, see [Regions and Availability Zones](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Concepts.RegionsAndAvailabilityZones.html)\. | November 9, 2022 | -| [Access to transaction log backups is now available for RDS for SQL Server](#WhatsNew) | You can now view and copy database transaction log backups to an Amazon S3 bucket\. For more information, see [ Access to transaction log backups](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER.SQLServer.AddlFeat.TransactionLogAccess.html)\. | November 7, 2022 | -| [Multi\-AZ DB clusters supported in additional AWS Regions](#WhatsNew) | Multi\-AZ DB clusters are now available in additional AWS Regions\. For more information, see [ Multi\-AZ DB clusters](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Concepts.RDS_Fea_Regions_DB-eng.Feature.MultiAZDBClusters.html)\. | November 4, 2022 | -| [Amazon RDS supports gp3 storage](#WhatsNew) | You can now create Amazon RDS DB instances that use Amazon EBS General Purpose SSD \(gp3\) storage volumes, which let you customize storage performance independently of storage capacity\. For more information, see [General Purpose SSD storage](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_Storage.html#Concepts.Storage.GeneralSSD)\. | November 4, 2022 | -| [Amazon RDS supports a new event for operating system updates](#WhatsNew) | Amazon RDS now supports a new DB instance event, RDS\-EVENT\-0230, under the event category of security patching\. This new event alerts you when an operating system update is available for your DB instance\. For more information, see [ Monitoring Amazon RDS events](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/working-with-events.html) and [ Working with operating system updates](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_UpgradeDBInstance.Maintenance.html#OS_Updates)\. | October 28, 2022 | -| [Amazon RDS for Oracle supports preconfigured r5b memory optimized instance classes](#WhatsNew) | The db\.r5b Oracle DB instance classes are optimized for workloads that require additional memory, storage, and I/O per vCPU\. For example, db\.r5b\.4xlarge\.tpc2\.mem2x has multithreading turned on and provides twice as much memory as db\.r5b\.4xlarge\. For more information, see [RDS for Oracle instance classes](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Oracle.Concepts.InstanceClasses.html#Oracle.Concepts.InstanceClasses.Supported)\. | October 27, 2022 | -| [Amazon RDS supports 15 read replicas for RDS for MariaDB, MySQL, and PostgreSQL DB instances](#WhatsNew) | You can now create up to 15 read replicas for RDS for MariaDB, MySQL, and PostgreSQL DB instances\. For more information about read replicas, see [ Working with read replicas](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_ReadRepl.html)\. | October 20, 2022 | -| [Amazon RDS for PostgreSQL now supports PostgreSQL version 15 RC 3 in the database preview environment](#WhatsNew) | PostgreSQL version 15 Beta 3 is now available in the database preview environment in the US East \(Ohio\) AWS Region\. For more information, see [Working with the database preview environment](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_PostgreSQL.html#working-with-the-database-preview-environment)\. | October 18, 2022 | -| [Amazon RDS supports automatically setting up connectivity between an RDS database and an EC2 instance](#WhatsNew) | You can use the AWS Management Console to set up connectivity between an existing RDS DB instance or Multi\-AZ DB cluster and an EC2 instance\. For more information, see [ Connecting an EC2 instance and an RDS database automatically](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/ec2-rds-connect.html)\. | October 14, 2022 | -| [AWS JDBC Driver for PostgreSQL generally available](#WhatsNew) | The AWS JDBC Driver for PostgreSQL is a client driver designed for RDS for PostgreSQL\. The AWS JDBC Driver for PostgreSQL is now generally available\. For more information, see [Connecting with the AWS JDBC Driver for PostgreSQL](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_ConnectToPostgreSQLInstance.html#USER_ConnectToPostgreSQLInstance.JDBCDriverPostgreSQL)\. | October 6, 2022 | -| [Amazon RDS for Oracle supports Oracle APEX version 21\.2\.v1](#WhatsNew) | APEX 21\.2 includes patch 33420059\. For more information, see [APEX version requirements](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Appendix.Oracle.Options.APEX.html#Appendix.Oracle.Options.APEX.versions)\. | October 3, 2022 | -| [RDS supports MySQL 5\.7\.39](#WhatsNew) | You can now create Amazon RDS DB instances running MySQL versions 5\.7\.39\. For more information, see [ MySQL on Amazon RDS versions](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/MySQL.Concepts.VersionMgmt.html)\. | September 29, 2022 | -| [RDS supports MariaDB 10\.6\.10](#WhatsNew) | You can now create Amazon RDS DB instances running MariaDB versions 10\.6\.10\. For more information, see [ MariaDB on Amazon RDS versions](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/MariaDB.Concepts.VersionMgmt.html)\. | September 29, 2022 | -| [RDS Proxy supports RDS for SQL Server](#WhatsNew) | You can now create an RDS Proxy for an RDS DB instance that runs Microsoft SQL Server version 2014 or higher\. For more information about RDS Proxy, see [Using Amazon RDS Proxy](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/rds-proxy.html)\. | September 19, 2022 | -| [RDS supports MariaDB 10\.5\.17, 10\.4\.26, and 10\.3\.36](#WhatsNew) | You can now create Amazon RDS DB instances running MariaDB versions 10\.5\.17, 10\.4\.26, and 10\.3\.36\. For more information, see [ MariaDB on Amazon RDS versions](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/MariaDB.Concepts.VersionMgmt.html)\. | September 15, 2022 | -| [Amazon RDS for Oracle supports local instance storage for temporary data](#WhatsNew) | You can now launch Amazon RDS for Oracle on Amazon EC2 db\.r5d and db\.m5d instance types with the temporary tablespace and Database Smart Flash Cache \(the flash cache\) configured to use an instance store\. By storing temporary data locally, you can achieve lower read and write latencies when compared to standard storage based on Amazon EBS\. For more information, see [Storing temporary Oracle data in the instance store](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_Oracle.advanced-features.instance-store.html)\. | September 14, 2022 | -| [Performance Insights shows the top 25 SQL queries](#WhatsNew) | In the Performance Insights dashboard, the **Top SQL** tab shows the 25 SQL queries that are contributing the most to DB load\. For more information, see [ Overview of the Top SQL tab](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_PerfInsights.UsingDashboard.Components.AvgActiveSessions.TopLoadItemsTable.TopSQL.html)\. | September 13, 2022 | -| [RDS supports MySQL 8\.0\.30](#WhatsNew) | You can now create Amazon RDS DB instances running MySQL version 8\.0\.30\. For more information, see [ MySQL on Amazon RDS versions](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/MySQL.Concepts.VersionMgmt.html)\. | September 9, 2022 | -| [Amazon RDS is available in the Middle East \(UAE\) Region](#WhatsNew) | Amazon RDS is now available in the Middle East \(UAE\) Region\. For more information, see [Regions and Availability Zones](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Concepts.RegionsAndAvailabilityZones.html)\. | August 30, 2022 | -| [Amazon RDS for SQL Server supports SSRS Email subscriptions](#WhatsNew) | You can now use the SQL Server Reporting Services \(SSRS\) Email extension to send reports to users and subscribe to reports on the report server\. For more information, see [Support for SQL Server Reporting Services in RDS for SQL Server](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Appendix.SQLServer.Options.SSRS.html)\. | August 26, 2022 | -| [RDS for Oracle supports read replica backups](#WhatsNew) | You can turn on automatic backups and create manual snapshots of RDS for Oracle replicas\. For more information, see [Working with RDS for Oracle replica backups](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/oracle-read-replicas.backups.html)\. | August 23, 2022 | -| [RDS for Oracle supports Oracle Data Guard switchover](#WhatsNew) | A switchover is a role reversal between a primary database and a mounted or open Oracle replica\. During a switchover, the original primary database transitions to a standby role, while the original standby database transitions to the primary role\. For more information, see [Performing an Oracle Data Guard switchover](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/oracle-replication-switchover.html)\. | August 23, 2022 | -| [Amazon RDS supports automatically setting up connectivity with an EC2 instance](#WhatsNew) | When you create a DB instance or Multi\-AZ DB cluster, you can use the AWS Management Console to set up connectivity between an Amazon Elastic Compute Cloud instance and the new DB instance or DB cluster\. For more information, see [ Configure automatic network connectivity with an EC2 instance](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_CreateDBInstance.html#USER_CreateDBInstance.Prerequisites.VPC.Automatic) for a new DB instance and [ Configure automatic network connectivity with an EC2 instance](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/create-multi-az-db-cluster.html#create-multi-az-db-cluster-prerequisites-VPC-automatic) for a new DB cluster\. | August 22, 2022 | -| [RDS Custom for Oracle supports promotion of Oracle replicas](#WhatsNew) | If you use RDS Custom for Oracle, you can promote your managed Oracle replicas by using the `promote-read-replica` CLI command\. Also, you can delete your primary DB instance, which causes RDS Custom for Oracle to promote your managed Oracle replicas to standalone instances\. For more information, see [Working with Oracle replicas for RDS Custom for Oracle](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/custom-rr.html)\. | August 5, 2022 | -| [RDS for MySQL supports enforcing SSL/TLS connections](#WhatsNew) | RDS for MySQL now supports enforcing SSL/TLS connections by setting the `require_secure_transport` parameter to `ON`\. For more information, see [Requiring an SSL/TLS connection to a MySQL DB instance](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/mysql-ssl-connections.html#mysql-ssl-connections.require-ssl)\. | August 1, 2022 | -| [Amazon RDS has deprecated support for Oracle Database 12c Release 1 \(12\.1\.0\.2\)](#WhatsNew) | Support for version 12\.1\.0\.2 is deprecated for both the BYOL and LI licensing models\. On August 1, 2022, RDS for Oracle begins automatic upgrades of 12c Release 1 \(12\.1\.0\.2\) DB instances and restored 12\.1\.0\.2 snapshots to Oracle Database 19c\. For more information, see [Oracle Database 12c with Amazon RDS](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Oracle.Concepts.database-versions.html#Oracle.Concepts.FeatureSupport.12c) and the end of support timeline on [AWS re:Post](https://repost.aws/questions/QUESrwZfKMSSuijzLLHCQkYQ/announcement-amazon-rds-for-oracle-end-of-support-timeline-for-12-c-oracle-release-2-12-2-0-1-and-oracle-release-1-12-1-0-2-major-version)\. | August 1, 2022 | -| [RDS Proxy supports RDS for MariaDB](#WhatsNew) | You can now create an RDS Proxy for an RDS DB instance that runs MariaDB version 10\.2, 10\.3, 10\.4, or 10\.5\. The MariaDB support is included under the MySQL engine family\. For more information about RDS Proxy, see [Using Amazon RDS Proxy](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/rds-proxy.html)\. | July 26, 2022 | -| [RDS for MariaDB supports the db\.r5b DB instance classes](#WhatsNew) | You can now create RDS for MariaDB DB instances that use the db\.r5b DB instance classes\. For more information, [Supported DB engines for DB instance classes](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Concepts.DBInstanceClass.html#Concepts.DBInstanceClass.Support)\. | July 25, 2022 | -| [RDS for Oracle supports modifying database activity streams](#WhatsNew) | If you use RDS for Oracle, you can change the audit policy state of a database activity stream to either locked \(default\) or unlocked\. Instead of stopping an activity stream, you can unlock its policy state, customize your audit policy, and then relock the policy state\. For more information, see [Modifying a database activity stream](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/DBActivityStreams.Modifying.html)\. | July 22, 2022 | -| [Performance Insights supports the Asia Pacific \(Jakarta\) Region](#WhatsNew) | Formerly, you couldn't use Performance Insights in the Asia Pacific \(Jakarta\) Region\. This restriction has been removed\. For more information, see [AWS Region support for Performance Insights](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Concepts.RDS_Fea_Regions_DB-eng.Feature.PerformanceInsights.html)\. | July 21, 2022 | -| [Microsoft SQL Server 2012 has reached its end of support on Amazon RDS](#WhatsNew) | Microsoft SQL Server 2012 has reached its end of support, coinciding with the Microsoft plan to end extended support for this version on July 12, 2022\. Any existing Microsoft SQL Server 2012 instances are to be automatically upgraded to the latest minor version of Microsoft SQL Server 2014 starting on June 1, 2022\. For more information, see [Microsoft SQL Server 2012 support on Amazon RDS](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_SQLServer.html#SQLServer.Concepts.General.FeatureSupport.2012)\. | July 12, 2022 | -| [RDS supports MariaDB 10\.6\.8, 10\.5\.16, 10\.4\.25, 10\.3\.35, and 10\.2\.44](#WhatsNew) | You can now create Amazon RDS DB instances running MariaDB versions 10\.6\.8, 10\.5\.16, 10\.4\.25, 10\.3\.35, and 10\.2\.44\. For more information, see [ Supported MariaDB versions on Amazon RDS](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/MariaDB.Concepts.VersionMgmt.html#MariaDB.Concepts.VersionMgmt.Supported)\. | July 8, 2022 | -| [RDS Performance Insights supports additional retention periods](#WhatsNew) | Previously, Performance Insights offered only two retention periods: 7 days \(default\) or 2 years \(731 days\)\. Now, if you need to retain your performance data for longer than 7 days, you can specify from 1–24 months\. For more information, see [Pricing and data retention for Performance Insights](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_PerfInsights.Overview.cost.html)\. | July 1, 2022 | -| [RDS Custom supports the Asia Pacific \(Mumbai\) and Europe \(London\) Regions](#WhatsNew) | You can create RDS Custom for Oracle and RDS Custom for SQL Server DB instances in two new AWS Regions: Asia Pacific \(Mumbai\) and Europe \(London\)\. For more information, see [AWS Region support for RDS Custom for Oracle](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/custom-reqs-limits.html#custom-reqs-limits.regions) and [AWS Region support for RDS Custom for SQL Server](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/custom-reqs-limits-MS.html#custom-reqs-limits.regionsMS)\. | June 21, 2022 | -| [RDS Custom for Oracle supports Oracle Database 18c and 12c Release 2 \(12\.2\)](#WhatsNew) | You can now create a CEV for RDS Custom for Oracle using installation files for Oracle Database 18c and 12c Release 2 \(12\.2\)\. You can use this these CEVs to create an RDS Custom for Oracle DB instance\. For more information, see [Working with custom engine versions for Amazon RDS Custom for Oracle](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/custom-cev.html)\. | June 21, 2022 | -| [Multi\-AZ DB clusters support the db\.m5d and db\.r5d DB instance classes](#WhatsNew) | You can now create Multi\-AZ DB clusters that use the db\.m5d and db\.r5d DB instance classes\. For more information, see [Multi\-AZ DB cluster deployments](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/multi-az-db-clusters-concepts.html) and [DB instance class types](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Concepts.DBInstanceClass.html#Concepts.DBInstanceClass.Types)\. | June 21, 2022 | -| [Multi\-AZ DB clusters available in additional AWS Regions](#WhatsNew) | You can now create Multi\-AZ DB clusters in the following Regions: Europe \(Frankfurt\) and Europe \(Stockholm\)\. For more information, see [Multi\-AZ DB cluster deployments](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/multi-az-db-clusters-concepts.html)\. | June 21, 2022 | -| [RDS for Microsoft SQL Server supports migration of databases that use Transparent Data Encryption \(TDE\)](#WhatsNew) | RDS for SQL Server now supports migrating Microsoft SQL Server databases with TDE turned on, using native backup and restore\. For more information, see [Support for Transparent Data Encryption in SQL Server](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Appendix.SQLServer.Options.TDE.html)\. | June 14, 2022 | -| [Amazon RDS supports publishing events to encrypted Amazon SNS topics](#WhatsNew) | Amazon RDS can now publish events to Amazon Simple Notification Service \(Amazon SNS\) topics that have server\-side encryption \(SSE\) enabled, for additional protection of events that carry sensitive data\. For more information, see [ Subscribing to Amazon RDS event notification](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Events.Subscribing.html)\. | June 1, 2022 | -| [RDS supports MySQL 5\.7\.38](#WhatsNew) | You can now create Amazon RDS DB instances running MySQL version 5\.7\.38\. For more information, see [MySQL on Amazon RDS versions](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_MySQL.html#MySQL.Concepts.VersionMgmt)\. | May 31, 2022 | -| [RDS for PostgreSQL supports cascading read replicas](#WhatsNew) | You can now use cascading read replicas with RDS for PostgreSQL version 14\.1 and higher releases\. For more information, see [Working with PostgreSQL read replicas in Amazon RDS](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_PostgreSQL.Replication.ReadReplicas.html)\. | May 4, 2022 | -| [Amazon RDS on AWS Outposts supports scale storage and autoscaling operations](#WhatsNew) | You can now change the storage sizes of DB instances on your Outpost and use storage autoscaling\. For more information, see [Amazon RDS on AWS Outposts support for Amazon RDS features](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/rds-on-outposts.features.html)\. | May 2, 2022 | -| [Multi\-AZ DB clusters available in additional AWS Regions](#WhatsNew) | You can now create Multi\-AZ DB clusters in the following Regions: Asia Pacific \(Singapore\) and Asia Pacific \(Sydney\)\. For more information, see [Multi\-AZ DB cluster deployments](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/multi-az-db-clusters-concepts.html)\. | April 29, 2022 | -| [Amazon RDS supports dual\-stack mode](#WhatsNew) | DB instances can now run in dual\-stack mode\. In dual\-stack mode, resources can communicate with the DB instance over IPv4, IPv6, or both\. For more information, see [ Amazon RDS IP addressing](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_VPC.WorkingWithRDSInstanceinaVPC.html#USER_VPC.IP_addressing)\. | April 29, 2022 | -| [Amazon RDS publishes usage metrics to Amazon CloudWatch](#WhatsNew) | The `AWS/Usage` namespace in Amazon CloudWatch includes account\-level usage metrics for your Amazon RDS service quotas\. For more information, see [ Amazon CloudWatch usage metrics for Amazon RDS](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/rds-metrics.html#rds-metrics-usage)\. | April 28, 2022 | -| [Amazon RDS for MySQL supports the db\.m6i and db\.r6i DB instance classes](#WhatsNew) | You can now use the db\.m6i and db\.r6i DB instance classes for Amazon RDS DB instances running MySQL\. For more information, see [Supported DB engines for DB instance classes](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Concepts.DBInstanceClass.html#Concepts.DBInstanceClass.Support)\. | April 28, 2022 | -| [Amazon RDS for PostgreSQL supports the db\.m6i and db\.r6i DB instance classes](#WhatsNew) | You can now use the db\.m6i and db\.r6i DB instance classes for Amazon RDS DB instances running PostgreSQL\. For more information, see [Supported DB engines for DB instance classes](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Concepts.DBInstanceClass.html#Concepts.DBInstanceClass.Support)\. | April 27, 2022 | -| [Amazon RDS for MariaDB supports the db\.m6i and db\.r6i DB instance classes](#WhatsNew) | You can now use the db\.m6i and db\.r6i DB instance classes for Amazon RDS DB instances running MariaDB\. For more information, see [Supported DB engines for DB instance classes](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Concepts.DBInstanceClass.html#Concepts.DBInstanceClass.Support)\. | April 26, 2022 | -| [Amazon RDS on AWS Outposts supports Multi\-AZ deployments](#WhatsNew) | You can now create a standby DB instance on a different Outpost\. For more information, see [Amazon RDS on AWS Outposts support for Amazon RDS features](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/rds-on-outposts.features.html)\. | April 19, 2022 | -| [Amazon RDS for Oracle supports the db\.m6i and db\.r6i instance classes](#WhatsNew) | If you run Oracle Database 19c, you can use the db\.m6i and db\.r6i instance classes\. The db\.m6i classes are general\-purpose instance classes that are well suited for a broad range of workloads\. For more information, see [RDS for Oracle instance classes](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Oracle.Concepts.InstanceClasses.html)\. | April 8, 2022 | -| [Amazon RDS for SQL Server supports SQL Server Agent job replication](#WhatsNew) | When you turn on this feature, SQL Server Agent jobs created, modified, or deleted on the primary host are automatically synchronized to the secondary host in a Multi\-AZ configuration\. For more information, see [Using SQL Server Agent](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Appendix.SQLServer.CommonDBATasks.Agent.html)\. | April 7, 2022 | -| [Amazon RDS supports RDS Proxy with RDS for PostgreSQL version 13](#WhatsNew) | You can now create an RDS Proxy with an RDS for PostgreSQL version 13 database\. For more information about RDS Proxy, see [Using Amazon RDS Proxy](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/rds-proxy.html)\. | April 4, 2022 | -| [Amazon RDS plans to deprecate Oracle Database 12c](#WhatsNew) | Oracle Database 12c is on a deprecation path\. Oracle Corporation will no longer provide patches for Oracle Database 12c releases after the end\-of\-support dates\. Amazon RDS plans to begin automatically upgrading Oracle Database 12c DB instances to Oracle Database 19c\. For more information, see [ Oracle Database 12c with Amazon RDS](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Oracle.Concepts.database-versions.html#Oracle.Concepts.FeatureSupport.12c) and [Preparing for the automatic upgrade of Oracle Database 12c](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_UpgradeDBInstance.Oracle.html#USER_UpgradeDBInstance.Oracle.auto-upgrade)\. | March 22, 2022 | -| [*Amazon RDS for PostgreSQL Release Notes*](#WhatsNew) | There is now a separate guide for the Amazon RDS for PostgreSQL release notes\. For more information, see [https://docs.aws.amazon.com/AmazonRDS/latest/PostgreSQLReleaseNotes/Welcome.html](https://docs.aws.amazon.com/AmazonRDS/latest/PostgreSQLReleaseNotes/Welcome.html)\. | March 22, 2022 | -| [*Amazon RDS for Oracle Release Notes*](#WhatsNew) | There is now a separate guide for the Amazon RDS for Oracle release notes\. For more information, see [https://docs.aws.amazon.com/AmazonRDS/latest/OracleReleaseNotes/Welcome.html](https://docs.aws.amazon.com/AmazonRDS/latest/OracleReleaseNotes/Welcome.html)\. | March 22, 2022 | -| [Multi\-AZ DB clusters available in additional AWS Regions](#WhatsNew) | You can now create Multi\-AZ DB clusters in the following Regions: US East \(Ohio\) and Asia Pacific \(Tokyo\)\. For more information, see [Multi\-AZ DB cluster deployments](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/multi-az-db-clusters-concepts.html)\. | March 15, 2022 | -| [Amazon RDS for PostgreSQL versions 14\.2, 13\.6, 12\.10, 11\.15, and 10\.20](#WhatsNew) | RDS for PostgreSQL now supports versions 14\.2, 13\.6, 12\.10, 11\.15, and 10\.20\. Version 14\.2 and 13\.6 add support for two new foreign data wrappers\. The `mysql_fdw` extension lets PostgreSQL work with data stored in MySQL, MariaDB, and Aurora MySQL databases\. The `tds_fdw` extension lets PostgreSQL work with data stored in SQL Server databases\. For more information, see [Supported PostgreSQL database versions](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_PostgreSQL.html#PostgreSQL.Concepts.General.DBVersions)\. | March 12, 2022 | -| [RDS supports MySQL 5\.7\.37](#WhatsNew) | You can now create Amazon RDS DB instances running MySQL version 5\.7\.37\. For more information, see [MySQL on Amazon RDS versions](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_MySQL.html#MySQL.Concepts.VersionMgmt)\. | March 11, 2022 | -| [Amazon RDS for SQL Server supports new DB instance classes](#WhatsNew) | You can now create Amazon RDS DB instances running Microsoft SQL Server that use the db\.m6i and db\.r6i DB instance classes\. For more information, see [DB instance class support for Microsoft SQL Server](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_SQLServer.html#SQLServer.Concepts.General.InstanceClasses)\. | March 9, 2022 | -| [Amazon RDS for Oracle supports Oracle Database 21c](#WhatsNew) | You can now create Amazon RDS DB instances running Oracle Database 21c \(21\.0\.0\.0\)\. This is the first Oracle Database release that supports only the multitenant \(CDB\) architecture\. For more information, see [ Oracle Database 21c with Amazon RDS](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_Oracle.html#Oracle.Concepts.FeatureSupport.21c)\. | March 7, 2022 | -| [RDS supports MariaDB 10\.6\.7, 10\.5\.15, 10\.4\.24, 10\.3\.34, and 10\.2\.43](#WhatsNew) | You can now create Amazon RDS DB instances running MariaDB versions 10\.6\.7, 10\.5\.15, 10\.4\.24, 10\.3\.34, and 10\.2\.43\. For more information, see [MariaDB on Amazon RDS versions](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_MariaDB.html#MariaDB.Concepts.VersionMgmt)\. | March 3, 2022 | -| [AWS JDBC Driver for MySQL generally available](#WhatsNew) | The AWS JDBC Driver for MySQL is a client driver designed for RDS for MySQL\. The AWS JDBC Driver for MySQL is now generally available\. For more information, see [ Connecting with the Amazon Web Services JDBC Driver for MySQL](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_ConnectToInstance.html#USER_ConnectToInstance.JDBCDriverMySQL)\. | March 2, 2022 | -| [Multi\-AZ DB clusters generally available](#WhatsNew) | A Multi\-AZ DB cluster deployment is a high availability deployment mode of Amazon RDS with two readable standby DB instances\. Multi\-AZ DB clusters are now generally available\. For more information, see [Multi\-AZ DB cluster deployments](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/multi-az-db-clusters-concepts.html)\. | March 1, 2022 | -| [RDS supports MySQL 8\.0\.28](#WhatsNew) | You can now create Amazon RDS DB instances running MySQL version 8\.0\.28\. For more information, see [MySQL on Amazon RDS versions](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_MySQL.html#MySQL.Concepts.VersionMgmt)\. | February 28, 2022 | -| [Amazon RDS for Oracle supports new settings for native network encryption \(NNE\)](#WhatsNew) | To control whether clients can connect with non\-secure encryption and checksumming methods, set `SQLNET.ALLOW_WEAK_CRYPTO_CLIENTS` and `SQLNET.ALLOW_WEAK_CRYPTO` in the NNE option\. Examples of insecure methods include DES, 3DES, RC4, and MD5\. For more information, see [NNE option settings](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Appendix.Oracle.Options.NetworkEncryption.html#Oracle.Options.NNE.Options)\. | February 25, 2022 | -| [Amazon RDS for SQL Server supports Always On Availability Groups for Microsoft SQL Server 2017 Standard Edition](#WhatsNew) | When you create a DB instance using the Multi\-AZ configuration on SQL Server 2017 Standard Edition 14\.00\.3401\.7 and higher versions, RDS automatically uses Availability Groups\. For more information, see [Multi\-AZ deployments for Microsoft SQL Server](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_SQLServerMultiAZ.html)\. | February 18, 2022 | -| [RDS for Oracle supports Database Activity Streams in the Asia Pacific \(Jakarta\) Region](#WhatsNew) | For more information, see [Support for AWS Regions for database activity streams](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/DBActivityStreams.Overview.html#DBActivityStreams.Overview.requirements)\. | February 16, 2022 | -| [Amazon RDS Custom for Oracle support for Oracle Database 12\.1](#WhatsNew) | You can now create custom engine versions for RDS Custom for Oracle that use Oracle Database 12\.1 Enterprise Edition\. For more information, see [Working with custom engine versions for Amazon RDS Custom for Oracle](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/custom-cev.html)\. | February 4, 2022 | -| [Amazon RDS for MariaDB supports a new major version](#WhatsNew) | You can now create Amazon RDS DB instances running MariaDB version 10\.6\. For more information, see [MariaDB 10\.6 support on Amazon RDS](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_MariaDB.html#MariaDB.Concepts.FeatureSupport.10-6)\. | February 3, 2022 | -| [Performance Insights supports plan capture for Oracle queries](#WhatsNew) | The Performance Insights console supports a new plan dimension for top SQL\. When you slice by plan, you can see which plans your top Oracle queries are using\. If a query uses multiple plans, you can compare the plans side by side in the console and determine which plan is most efficient\. You can also drill down to see which steps in a plan have the highest cost\. For more information, see [Analyzing Oracle execution plans using the Performance Insights dashboard](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_PerfInsights.UsingDashboard.AccessPlans.html)\. | January 27, 2022 | -| [Performance Insights supports new APIs](#WhatsNew) | Performance Insights supports the following APIs: `GetResourceMetadata`, `ListAvailableResourceDimensions`, and `ListAvailableResourceMetrics`\. For more information, see [Retrieving metrics with the Performance Insights API](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_PerfInsights.API.html) in this manual and the [https://docs.aws.amazon.com/performance-insights/latest/APIReference/API_GetResourceMetadata.html](https://docs.aws.amazon.com/performance-insights/latest/APIReference/API_GetResourceMetadata.html)\. | January 12, 2022 | -| [RDS Proxy supports events](#WhatsNew) | RDS Proxy now generates events that you can subscribe to and view in CloudWatch Events or configure to send to Amazon EventBridge\. For more information, see [Working with RDS Proxy events](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/rds-proxy.events.html)\. | January 11, 2022 | -| [Amazon RDS for SQL Server supports SSAS Multidimensional mode](#WhatsNew) | RDS for SQL Server supports running SQL Server Analysis Services \(SSAS\) in Tabular or Multidimensional mode\. For more information, see [Support for SQL Server Analysis Services in RDS for SQL Server](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Appendix.SQLServer.Options.SSAS.html)\. | January 7, 2022 | -| [RDS Proxy available in additional AWS Regions](#WhatsNew) | RDS Proxy is now available in the following Regions: Africa \(Cape Town\), Asia Pacific \(Hong Kong\), Asia Pacific \(Osaka\), Europe \(Milan\), Europe \(Paris\), Europe \(Stockholm\), Middle East \(Bahrain\), and South America \(São Paulo\)\. For more information about RDS Proxy, see [Using Amazon RDS Proxy](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/rds-proxy.html)\. | January 5, 2022 | -| [RDS supports MySQL 8\.0\.27](#WhatsNew) | You can now create Amazon RDS DB instances running MySQL version 8\.0\.27\. For more information, see [MySQL on Amazon RDS versions](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_MySQL.html#MySQL.Concepts.VersionMgmt)\. | December 21, 2021 | -| [Amazon RDS is available in the Asia Pacific \(Jakarta\) Region](#WhatsNew) | Amazon RDS is now available in the Asia Pacific \(Jakarta\) Region\. For more information, see [Regions and Availability Zones](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Concepts.RegionsAndAvailabilityZones.html)\. | December 13, 2021 | -| [Amazon RDS supports MariaDB 10\.5\.13, 10\.4\.22, 10\.3\.32, and 10\.2\.41](#WhatsNew) | You can now create Amazon RDS DB instances running MariaDB versions 10\.5\.13, 10\.4\.22, 10\.3\.32, and 10\.2\.41\. For more information, see [MariaDB on Amazon RDS versions](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_MariaDB.html#MariaDB.Concepts.VersionMgmt)\. | December 8, 2021 | -| [Amazon RDS Custom for SQL Server](#WhatsNew) | Amazon RDS Custom is a managed database service for legacy, custom, and packaged applications that require access to the underlying operating system and database environment\. With Amazon RDS Custom, you get the automation of Amazon RDS and the flexibility of Amazon EC2\. For more information, see [Working with Amazon RDS Custom](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/rds-custom.html)\. | December 1, 2021 | -| [Multi\-AZ DB clusters \(preview\)](#WhatsNew) | You can now create Multi\-AZ DB clusters for RDS for MySQL and RDS for PostgreSQL\. A Multi\-AZ DB cluster deployment is a high availability deployment mode of Amazon RDS with two readable standby DB instances\. Multi\-AZ DB clusters are in preview\. For more information, see [Multi\-AZ DB cluster deployments \(preview\)](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/multi-az-db-clusters-concepts.html)\. | November 23, 2021 | -| [Amazon RDS supports RDS Proxy with RDS for PostgreSQL version 12](#WhatsNew) | You can now create an RDS Proxy with an RDS for PostgreSQL version 12 database\. For more information about RDS Proxy, see [Using Amazon RDS Proxy](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/rds-proxy.html)\. | November 22, 2021 | -| [Amazon RDS on AWS Outposts supports local backups](#WhatsNew) | You can store automated backups and manual snapshots in your AWS Region or locally on your Outpost\. For more information, see [Amazon RDS on AWS Outposts support for Amazon RDS features](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/rds-on-outposts.html#rds-on-outposts.rds-feature-support)\. | November 22, 2021 | -| [Amazon RDS support for cross\-account AWS KMS keys](#WhatsNew) | You can use a KMS key from a different AWS account for encryption when exporting DB snapshots to Amazon S3\. For more information, see [Exporting DB snapshot data to Amazon S3](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_ExportSnapshot.html)\. | November 3, 2021 | -| [Amazon RDS on AWS Outposts supports publishing database engine logs to CloudWatch Logs](#WhatsNew) | RDS on Outposts now supports publishing database engine logs to CloudWatch Logs\. For more information, see [Amazon RDS on AWS Outposts support for Amazon RDS features](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/rds-on-outposts.html#rds-on-outposts.rds-feature-support)\. | November 2, 2021 | -| [Amazon RDS Custom for Oracle](#WhatsNew) | Amazon RDS Custom is a managed database service for legacy, custom, and packaged applications that require access to the underlying operating system and database environment\. With Amazon RDS Custom, you get the automation of Amazon RDS and the flexibility of Amazon EC2\. For more information, see [Working with Amazon RDS Custom](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/rds-custom.html)\. | October 26, 2021 | -| [Support for delayed replication for RDS for MySQL version 8\.0](#WhatsNew) | Starting with RDS for MySQL version 8\.0\.26, you can configure delayed replication for RDS for MySQL version 8\.0 DB instances\. For more information, see [ Configuring delayed replication with MySQL](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_MySQL.Replication.ReadReplicas.html#USER_MySQL.Replication.ReadReplicas.DelayReplication)\. | October 25, 2021 | -| [Support for MySQL 8\.0\.26](#WhatsNew) | You can now create Amazon RDS DB instances running MySQL version 8\.0\.26\. For more information, see [MySQL on Amazon RDS versions](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_MySQL.html#MySQL.Concepts.VersionMgmt)\. | October 25, 2021 | -| [Support for GTID\-based replication for RDS for MySQL version 8\.0](#WhatsNew) | Starting with RDS for MySQL version 8\.0\.26, you can configure GTID\-based replication for RDS for MySQL version 8\.0 DB instances\. For more information, see [Using GTID\-based replication for RDS for MySQL](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/mysql-replication-gtid.html)\. | October 25, 2021 | -| [Amazon RDS supports RDS Proxy with RDS for MySQL 8\.0](#WhatsNew) | You can now create an RDS Proxy for an RDS for MySQL 8\.0 database instance\. For more information, see [Using Amazon RDS Proxy](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/rds-proxy.html)\. | October 21, 2021 | -| [Amazon RDS on AWS Outposts supports additional RDS for MySQL versions](#WhatsNew) | RDS on Outposts now supports RDS for MySQL versions 8\.0\.23 and 8\.0\.25\. For more information, see [Amazon RDS on AWS Outposts support for Amazon RDS features](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/rds-on-outposts.html#rds-on-outposts.rds-feature-support)\. | October 20, 2021 | -| [Amazon RDS for PostgreSQL now supports PostgreSQL version 14 RC 1 in the database preview environment](#WhatsNew) | PostgreSQL version 14 RC 1 is now available in the database preview environment in the US East \(Ohio\) AWS Region\. For more information, see [Working with the database preview environment](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_PostgreSQL.html#working-with-the-database-preview-environment)\. | October 19, 2021 | -| [Amazon RDS supports Performance Insights in additional AWS Regions](#WhatsNew) | Performance Insights is available in the Middle East \(Bahrain\), Africa \(Cape Town\), Europe \(Milan\), and Asia Pacific \(Osaka\) Regions\. For more information, see [AWS Region support for Performance Insights](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Concepts.RDS_Fea_Regions_DB-eng.Feature.PerformanceInsights.html)\. | October 5, 2021 | -| [Performance Insights supports digest\-level statistics for Oracle](#WhatsNew) | When you use Performance Insights, you can view SQL statistics both at the statement and digest level for Amazon RDS for Oracle\. For more information, see [Analyzing running queries in Oracle](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_PerfInsights.UsingDashboard.AnalyzeDBLoad.AdditionalMetrics.Oracle)\. | October 4, 2021 | -| [Amazon RDS on AWS Outposts supports additional RDS for PostgreSQL versions](#WhatsNew) | RDS on Outposts now supports RDS for PostgreSQL versions 12\.8 and 13\.4\. For more information, see [Amazon RDS on AWS Outposts support for Amazon RDS features](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/rds-on-outposts.html#rds-on-outposts.rds-feature-support)\. | October 1, 2021 | -| [Amazon RDS supports Oracle APEX version 21\.1\.v1](#WhatsNew) | You can use APEX 21\.1\.v1 with all supported versions of Oracle Database\. For more information, see [Oracle Application Express](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Appendix.Oracle.Options.APEX.html)\. | September 24, 2021 | -| [Amazon RDS for Oracle supports client\-side encryption for NNE](#WhatsNew) | When you configure NNE, you might want to avoid forcing encryption on the server side\. For example, you might not want to force all client communications to use encryption because the server requires it\. In this case, you can force encryption on the client side using the `SQLNET.*CLIENT` options\. For more information, see [Oracle native network encryption](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Appendix.Oracle.Options.NetworkEncryption.html#Oracle.Options.NNE.Using)\. | September 24, 2021 | -| [Amazon RDS for MySQL and RDS for PostgreSQL support new DB instance classes](#WhatsNew) | You can now use the db\.r5b, db\.t4g, and db\.x2g instance classes to create Amazon RDS DB instances running MySQL or PostgreSQL\. For more information, see [ Supported DB engines for DB instance classes](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Concepts.DBInstanceClass.html#Concepts.DBInstanceClass.Support)\. | September 15, 2021 | -| [Amazon RDS for Microsoft SQL Server supports Java Database Connectivity \(JDBC\) with Microsoft Distributed Transaction Coordinator \(MSDTC\)](#WhatsNew) | JDBC XA transactions are now supported with MSDTC for SQL Server 2017 version 14\.00\.3223\.3 and higher, and SQL Server 2019\. For more information, see [Support for Microsoft Distributed Transaction Coordinator in RDS for SQL Server](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Appendix.SQLServer.Options.MSDTC.html)\. | September 7, 2021 | -| [Amazon RDS supports MariaDB 10\.5\.12, 10\.4\.21, 10\.3\.31, and 10\.2\.40](#WhatsNew) | You can now create Amazon RDS DB instances running MariaDB versions 10\.5\.12, 10\.4\.21, 10\.3\.31, and 10\.2\.40\. For more information, see [MariaDB on Amazon RDS versions](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_MariaDB.html#MariaDB.Concepts.VersionMgmt)\. | September 2, 2021 | -| [Amazon RDS has ended support for Oracle Database 18c](#WhatsNew) | You can create DB instances only for Oracle Database 12c and Oracle Database 19c\. If you have Oracle Database 18c snapshots, upgrade them to a later release\. For more information, see [Upgrading an Oracle DB snapshot](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_UpgradeDBSnapshot.Oracle.html)\. | August 17, 2021 | -| [Amazon RDS for SQL Server supports automatic minor version upgrades](#WhatsNew) | You can now have your RDS for SQL Server DB instances automatically upgraded to the latest minor version\. For more information, see [Upgrading the Microsoft SQL Server DB engine](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_UpgradeDBInstance.SQLServer.html)\. | August 13, 2021 | -| [Amazon RDS for PostgreSQL now supports PostgreSQL version 14 beta 2 in the database preview environment](#WhatsNew) | For more about PostgreSQL version 14 beta 1, see [PostgreSQL 14 beta 1 release notes](https://www.postgresql.org/docs/14/release-14.html)\. For more about PostgreSQL version 14 beta 2, see [PostgreSQL 14 beta 2 release notes](https://www.postgresql.org/about/news/postgresql-14-beta-2-released-2249/)\. For information on the Database Preview Environment, see [Working with the database preview environment](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_PostgreSQL.html#working-with-the-database-preview-environment)\. | August 9, 2021 | -| [Amazon RDS supports RDS Proxy in a shared VPC](#WhatsNew) | You can now create an RDS Proxy in a shared VPC\. For more information about RDS Proxy, see "Managing Connections with Amazon RDS Proxy" in the [Amazon RDS User Guide](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/rds-proxy.html) or the [Aurora User Guide](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/rds-proxy.html)\. | August 6, 2021 | -| [Amazon RDS supports MariaDB 10\.2\.39](#WhatsNew) | You can now create Amazon RDS DB instances running MariaDB versions 10\.2\.39\. For more information, see [MariaDB on Amazon RDS versions](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_MariaDB.html#MariaDB.Concepts.VersionMgmt)\. | August 4, 2021 | -| [Amazon RDS for Oracle adds the `TIMEZONE_FILE_AUTOUPGRADE` option](#WhatsNew) | With this option, you can upgrade the current time zone file to the latest version on your Oracle DB instance\. For more information, see [Oracle time zone file autoupgrade](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Appendix.Oracle.Options.Timezone-file-autoupgrade.html)\. | July 30, 2021 | -| [Amazon RDS extends support for cross\-Region automated backups](#WhatsNew) | You can now replicate DB snapshots and transaction logs between more AWS Regions\. For more information, see [Replicating automated backups to another AWS Region](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_ReplicateBackups.html)\. | July 19, 2021 | -| [Support for MySQL 5\.7\.34](#WhatsNew) | You can now create Amazon RDS DB instances running MySQL version 5\.7\.34\. For more information, see [MySQL on Amazon RDS versions](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_MySQL.html#MySQL.Concepts.VersionMgmt)\. | July 8, 2021 | -| [Amazon RDS on AWS Outposts supports additional RDS for PostgreSQL versions](#WhatsNew) | RDS on Outposts now supports RDS for PostgreSQL versions 12\.7 and 13\.3\. For more information, see [Amazon RDS on AWS Outposts support for Amazon RDS features](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/rds-on-outposts.html#rds-on-outposts.rds-feature-support)\. | July 8, 2021 | -| [Amazon RDS for PostgreSQL supports oracle\_fdw](#WhatsNew) | You can now use the oracle\_fdw extension to provide a foreign data wrapper for access to Oracle databases\. For more information, see [ Accessing external data with the oracle\_fdw extension](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Appendix.PostgreSQL.CommonDBATasks.html#postgresql-oracle-fdw)\. | July 8, 2021 | -| [Amazon RDS supports Oracle Management Agent \(OMA\) version 13\.5](#WhatsNew) | You can use Oracle Management Agent \(OMA\) version 13\.5 with Oracle Enterprise Manager \(OEM\) Cloud Control 13c Release 5 and higher\. Amazon RDS for Oracle installs OMA, which then communicates with your Oracle Management Service \(OMS\) to provide monitoring information\. If you run OMS 13\.5, you can manage databases by installing OMA 13\.5\. For more information, see [Oracle Management Agent for Enterprise Manager Cloud Control](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Oracle.Options.OEMAgent.html)\. | July 7, 2021 | -| [Amazon RDS for Oracle supports downloading logs from Amazon S3](#WhatsNew) | If archived redo logs aren't on your instance but are protected by your backup retention period, you can use `rdsadmin.rdsadmin_archive_log_download` to download them from Amazon S3\. RDS for Oracle saves the logs to the `/rdsdbdata/log/arch` directory on your DB instance\. For more information, see [Downloading archived redo logs from Amazon S3](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Appendix.Oracle.CommonDBATasks.Log.html#Appendix.Oracle.CommonDBATasks.download-redo-logs)\. | July 2, 2021 | -| [Amazon RDS supports MariaDB 10\.4\.18 and 10\.5\.9](#WhatsNew) | You can now create Amazon RDS DB instances running MariaDB versions 10\.4\.18 and 10\.5\.9\. For more information, see [MariaDB on Amazon RDS versions](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_MariaDB.html#MariaDB.Concepts.VersionMgmt)\. | June 30, 2021 | -| [Amazon RDS for Oracle supports Database Activity Streams](#WhatsNew) | You can now monitor an Oracle DB instance using Database Activity Streams\. An Oracle database writes audit records to the unified audit trail\. When you start a database activity stream on an Oracle DB instance, Amazon Kinesis streams all activities that match the Oracle Database audit policies\. For more information, see [Monitoring Amazon RDS with Database Activity Streams](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/DBActivityStreams.html)\. | June 23, 2021 | -| [Amazon RDS for Oracle introduces memory optimized instance classes](#WhatsNew) | New Oracle DB instance classes are optimized for workloads that require additional memory, storage, and I/O per vCPU\. For more information, see [RDS for Oracle instance classes](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_Oracle.html#Oracle.Concepts.InstanceClasses)\. | June 23, 2021 | -| [Support for MySQL 8\.0\.25](#WhatsNew) | You can now create Amazon RDS DB instances running MySQL version 8\.0\.25\. For more information, see [MySQL on Amazon RDS versions](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_MySQL.html#MySQL.Concepts.VersionMgmt)\. | June 18, 2021 | -| [Amazon RDS on AWS Outposts supports additional RDS for PostgreSQL versions](#WhatsNew) | RDS on Outposts now supports RDS for PostgreSQL versions 12\.5, 12\.6, 13\.1, and 13\.2\. For more information, see [Amazon RDS on AWS Outposts support for Amazon RDS features](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/rds-on-outposts.html#rds-on-outposts.rds-feature-support)\. | May 28, 2021 | -| [Amazon RDS supports MariaDB 10\.2\.37 and 10\.3\.28](#WhatsNew) | You can now create Amazon RDS DB instances running MariaDB versions 10\.2\.37 and 10\.3\.28\. For more information, see [MariaDB on Amazon RDS versions](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_MariaDB.html#MariaDB.Concepts.VersionMgmt)\. | May 27, 2021 | -| [Amazon RDS for Oracle supports multitenant container database \(CDB\)](#WhatsNew) | A multitenant architecture enables an Oracle database to be a CDB\. In Oracle Database 19c, your CDB can include a single PDB\. The user experience with a PDB is mostly identical to the user experience with a non\-CDB\. For more information, see [RDS for Oracle architecture](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_Oracle.html#Oracle.Concepts.single-tenant)\. | May 25, 2021 | -| [Amazon RDS on AWS Outposts supports Amazon RDS for SQL Server](#WhatsNew) | RDS on Outposts now supports Amazon RDS for SQL Server\. For more information, see [Amazon RDS on AWS Outposts support for Amazon RDS features](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/rds-on-outposts.html#rds-on-outposts.rds-feature-support)\. | May 11, 2021 | -| [Amazon RDS extends support for cross\-Region automated backups](#WhatsNew) | You can now configure Amazon RDS database instances running Microsoft SQL Server to replicate DB snapshots and transaction logs to a different AWS Region\. For more information, see [Replicating automated backups to another AWS Region](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_ReplicateBackups.html)\. | May 7, 2021 | -| [Amazon RDS supports cross\-Region automated backups for encrypted DB instances](#WhatsNew) | You can now replicate DB snapshots and transaction logs to a different AWS Region for encrypted Amazon RDS database instances running Oracle or PostgreSQL\. For more information, see [Replicating automated backups to another AWS Region](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_ReplicateBackups.html)\. | May 3, 2021 | -| [Amazon RDS on AWS Outposts supports Amazon CloudWatch monitoring](#WhatsNew) | RDS on Outposts now supports Amazon CloudWatch monitoring\. For more information, see [Amazon RDS on AWS Outposts support for Amazon RDS features](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/rds-on-outposts.html#rds-on-outposts.rds-feature-support)\. | April 21, 2021 | -| [RDS for PostgreSQL supports AWS Lambda functions](#WhatsNew) | You can now invoke AWS Lambda functions for your RDS for PostgreSQL DB instances\. For more information, see [ Invoking an AWS Lambda function from an RDS for PostgreSQL DB instance](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/PostgreSQL-Lambda.html)\. | April 13, 2021 | -| [RDS for SQL Server supports extended events](#WhatsNew) | You can use SQL Server extended events to capture debugging and troubleshooting information\. For more information, see [Using extended events with Amazon RDS for Microsoft SQL Server](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/SQLServer.ExtendedEvents.html)\. | April 8, 2021 | -| [Support for MySQL 8\.0\.23, 5\.7\.33, and 5\.6\.51](#WhatsNew) | You can now create Amazon RDS DB instances running MySQL version 8\.0\.23, 5\.7\.33, and 5\.6\.51\. For more information, see [MySQL on Amazon RDS versions](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_MySQL.html#MySQL.Concepts.VersionMgmt)\. | March 31, 2021 | -| [Automatic rollback on failed Amazon RDS for MySQL upgrade](#WhatsNew) | If a DB instance upgrade from MySQL version 5\.7 to MySQL version 8\.0 fails, Amazon RDS rolls back the changes performed for the upgrade automatically\. After the rollback, the MySQL DB instance is running MySQL version 5\.7\. For more information, see [ Rollback after failure to upgrade from MySQL 5\.7 to 8\.0](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_UpgradeDBInstance.MySQL.html#USER_UpgradeDBInstance.MySQL.Major.RollbackAfterFailure)\. | March 18, 2021 | -| [Amazon RDS supports cross\-Region read replicas in opt\-in Regions](#WhatsNew) | You can now replicate DB instances to opt\-in Regions\. For more information, see [Creating a read replica in a different AWS Region](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_ReadRepl.XRgn.html)\. | March 18, 2021 | -| [Amazon RDS plans to deprecate Oracle Database 18c](#WhatsNew) | Oracle Database 18c \(18\.0\.0\.0\) is on a deprecation path\. Oracle Corporation will no longer provide patches for Oracle Database 18c after the end\-of\-support date\. On July 1, 2021, Amazon RDS plans to begin automatically upgrading Oracle Database 18c instances to Oracle Database 19c\. Before the automatic upgrades begin, we highly recommend that you manually upgrade your existing Oracle Database 18c instances to Oracle Database 19c\. For more information, see [Preparing for the automatic upgrade of Oracle Database 18c](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_UpgradeDBInstance.Oracle.html#USER_UpgradeDBInstance.Oracle.auto-upgrade-of-18c)\. | March 11, 2021 | -| [Amazon RDS has ended support for Oracle Database 11g](#WhatsNew) | You can only create DB instances for Oracle Database 12c Release 1 \(12\.1\.0\.2\) and later\. If you have Oracle Database 11g snapshots, upgrade them to a later release\. For more information, see [Upgrading an Oracle DB snapshot](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_UpgradeDBSnapshot.Oracle.html)\. | March 11, 2021 | -| [Amazon RDS supports continuous backups of DB instances in AWS Backup](#WhatsNew) | You can now create automated backups in AWS Backup and restore DB instances from these backups to a specified time\. For more information, see [Using AWS Backup to manage automated backups](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_WorkingWithAutomatedBackups.html#AutomatedBackups.AWSBackup)\. | March 10, 2021 | -| [Amazon RDS supports Oracle Management Agent \(OMA\) version 13\.4](#WhatsNew) | You can use Oracle Management Agent \(OMA\) version 13\.4 with Oracle Enterprise Manager \(OEM\) Cloud Control 13c Release 4 Update 9\. Amazon RDS for Oracle installs OMA, which then communicates with your Oracle Management Service \(OMS\) to provide monitoring information\. If you run OMS 13\.4, you can manage databases by installing OMA 13\.4\. For more information, see [Oracle Management Agent for Enterprise Manager Cloud Control](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Oracle.Options.OEMAgent.html)\. | March 10, 2021 | -| [RDS Proxy endpoint enhancements](#WhatsNew) | You can create additional endpoints associated with each RDS proxy\. Creating an endpoint in a different VPC enables cross\-VPC access for the proxy\. Proxies for Aurora MySQL clusters can also have read\-only endpoints\. These reader endpoints connect to reader DB instances in the clusters and can improve read scalability and availability for query\-intensive applications\. For more information about RDS Proxy, see "Managing Connections with Amazon RDS Proxy" in the [Amazon RDS User Guide](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/rds-proxy.html) or the [Aurora user guide](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/rds-proxy.html)\. | March 8, 2021 | -| [Amazon RDS extends supports for cross\-Region automated backups](#WhatsNew) | You can now configure Amazon RDS database instances running PostgreSQL to replicate DB snapshots and transaction logs to a different AWS Region\. For more information, see [Replicating automated backups to another AWS Region](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_ReplicateBackups.html)\. | March 8, 2021 | -| [Replication filters for Amazon RDS for MariaDB and MySQL supported in the China \(Beijing\) Region and China \(Ningxia\) Region](#WhatsNew) | Replication filtering is now supported in the China \(Beijing\) Region and China \(Ningxia\) Region\. For more information, see [ Configuring replication filters with MariaDB](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_MariaDB.Replication.ReadReplicas.html#USER_MariaDB.Replication.ReadReplicas.ReplicationFilters) and [ Configuring replication filters with MySQL](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_MySQL.Replication.ReadReplicas.html#USER_MySQL.Replication.ReadReplicas.ReplicationFilters)\. | March 5, 2021 | -| [Amazon RDS supports cross\-Region DB snapshot copy in opt\-in Regions](#WhatsNew) | You can now copy DB snapshots to and from opt\-in AWS Regions\. For more information, see [Copying snapshots across AWS Regions](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_CopySnapshot.html#USER_CopySnapshot.AcrossRegions)\. | March 4, 2021 | -| [Amazon RDS for SQL Server supports Always On Availability Groups for Standard Edition](#WhatsNew) | When you create a DB instance using the Multi\-AZ configuration on SQL Server 2019 for the Standard Edition database engine, RDS automatically uses Availability Groups\. For more information, see [Multi\-AZ deployments for Microsoft SQL Server](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_SQLServerMultiAZ.html)\. | February 23, 2021 | -| [Amazon RDS for Oracle introduces advisor\-related procedures](#WhatsNew) | The `rdsadmin_util` package includes the procedures `advisor_task_set_parameter`, `advisor_task_drop`, and `dbms_stats_init`\. You can use these procedures to modify, stop, and re\-enable advisor tasks such as `AUTO_STATS_ADVISOR_TASK`\. For more information, see [Setting parameters for advisor tasks](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Appendix.Oracle.CommonDBATasks.Misc.html#Appendix.Oracle.CommonDBATasks.setting-task-parameters)\. | February 23, 2021 | -| [Amazon RDS provides failover reasons for Multi\-AZ DB instances](#WhatsNew) | You can now see more detailed explanations when a Multi\-AZ DB instance fails over to a standby replica\. For more information, see [Failover process for Amazon RDS](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Concepts.MultiAZ.html#Concepts.MultiAZ.Failover)\. | February 18, 2021 | -| [Amazon RDS extends support for exporting snapshots to Amazon S3](#WhatsNew) | You can now export DB snapshot data to Amazon S3 in China\. For more information, see [Exporting DB snapshot data to Amazon S3](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_ExportSnapshot.html)\. | February 17, 2021 | -| [Replication filters for Amazon RDS for MariaDB and MySQL](#WhatsNew) | You can configure replication filters for MySQL and MariaDB instances\. Replication filters specify which databases and tables are replicated in a read replica\. You can create lists of databases and tables to include or exclude for each read replica\. For more information, see [ Configuring replication filters with MariaDB](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_MariaDB.Replication.ReadReplicas.html#USER_MariaDB.Replication.ReadReplicas.ReplicationFilters) and [ Configuring replication filters with MySQL](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_MySQL.Replication.ReadReplicas.html#USER_MySQL.Replication.ReadReplicas.ReplicationFilters)\. | February 12, 2021 | -| [RDS for Oracle supports APEX 20\.2v1](#WhatsNew) | You can use APEX 20\.2\.v1 with all supported versions of Oracle Database\. For more information, see [Oracle Application Express](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Appendix.Oracle.Options.APEX.html)\. | February 2, 2021 | -| [Amazon RDS for SQL Server supports local instance storage for the tempdb database](#WhatsNew) | You can now launch Amazon RDS for SQL Server on Amazon EC2 db\.r5d and db\.m5d instance types with the tempdb database configured to use an instance store\. By placing tempdb data files and log files locally, you can achieve lower read and write latencies when compared to standard storage based on Amazon EBS\. For more information, see [Instance store support for the tempdb database on Amazon RDS for SQL Server](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/SQLServer.InstanceStore.html)\. | January 27, 2021 | -| [Amazon RDS for PostgreSQL supports pg\_partman and pg\_cron](#WhatsNew) | Amazon RDS for PostgreSQL now supports the pg\_partman and pg\_cron extensions\. For more information on the pg\_partman extension, see [Managing PostgreSQL partitions with the pg\_partman extension](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/PostgreSQL_Partitions.html)\. For more information on the pg\_cron extension, see [Scheduling maintenance with the PostgreSQL pg\_cron extension](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/PostgreSQL_pg_cron.html)\. | January 12, 2021 | -| [Amazon RDS supports publishing the Oracle Management Agent log to Amazon CloudWatch Logs](#WhatsNew) | The Oracle Management Agent log consists of emctl\.log, emdctlj\.log, gcagent\.log, gcagent\_errors\.log, emagent\.nohup, and secure\.log\. Amazon RDS publishes each of these logs as a separate CloudWatch log stream\. For more information, see [ Publishing Oracle logs to Amazon CloudWatch Logs](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_LogAccess.Concepts.Oracle.html#USER_LogAccess.Oracle.PublishtoCloudWatchLogs)\. | December 28, 2020 | -| [Amazon RDS on AWS Outposts supports additional database versions](#WhatsNew) | RDS on Outposts now supports additional MySQL and PostgreSQL versions\. For more information, see [ Amazon RDS on AWS Outposts support for Amazon RDS features](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/rds-on-outposts.html#rds-on-outposts.rds-feature-support)\. | December 23, 2020 | -| [Amazon RDS on AWS Outposts supports CoIPs](#WhatsNew) | RDS on Outposts now supports customer\-owned IP addresses \(CoIPs\)\. CoIPs provide local or external connectivity to resources in your Outpost subnets through your on\-premises network\. For more information, see [ Customer\-owned IP addresses for RDS on Outposts](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/rds-on-outposts.html#rds-on-outposts.coip)\. | December 22, 2020 | -| [Amazon RDS for Oracle plans upgrade of 11g BYOL instances to 19c](#WhatsNew) | On January 4, 2021, we plan to begin automatically upgrading all editions of Oracle Database 11g instances on the Bring Your Own License \(BYOL\) model to Oracle Database 19c\. All Oracle Database 11g instances, including reserved instances, will move to the latest available Release Update \(RU\)\. For more information, see [ Preparing for the automatic upgrade of Oracle Database 11g BYOL](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_UpgradeDBInstance.Oracle.html#USER_UpgradeDBInstance.Oracle.auto-upgrade-byol)\. | December 11, 2020 | -| [Amazon RDS supports replicating automated backups to another AWS Region](#WhatsNew) | You can now configure your Amazon RDS database instances to replicate snapshots and transaction logs to a destination AWS Region of your choice\. For more information, see [Replicating automated backups to another AWS Region](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_ReplicateBackups.html)\. | December 4, 2020 | -| [Amazon RDS for Oracle and Microsoft SQL Server support a new DB instance class](#WhatsNew) | You can now use the db\.r5b instance class to create Amazon RDS DB instances running Oracle or SQL Server\. For more information, see [ Supported DB engines for DB instance classes](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Concepts.DBInstanceClass.html#Concepts.DBInstanceClass.Support)\. | December 4, 2020 | -| [Support for MariaDB 10\.2\.32](#WhatsNew) | You can now create Amazon RDS DB instances running MariaDB version 10\.2\.32\. For more information, see [MariaDB on Amazon RDS versions](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_MariaDB.html#MariaDB.Concepts.VersionMgmt)\. | November 25, 2020 | -| [Amazon RDS for SQL Server supports the Microsoft Business Intelligence Suite on SQL Server 2019](#WhatsNew) | You can now run SQL Server Analysis Services, SQL Server Integration Services, and SQL Server Reporting Services on DB instances using the latest major version\. For more information, see [Options for the Microsoft SQL Server database engine](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Appendix.SQLServer.Options.html)\. | November 24, 2020 | -| [Amazon RDS for PostgreSQL version 13 in the database preview environment](#WhatsNew) | Amazon RDS for PostgreSQL now supports PostgreSQL version 13 in the database preview environment\. For more information, see [ PostgreSQL 13 versions](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_PostgreSQL.html#PostgreSQL.Concepts.General.version13)\. | November 24, 2020 | -| [Amazon RDS Performance Insights introduces new dimensions](#WhatsNew) | You can group database load according to the dimension groups for database \(PostgreSQL, MySQL, and MariaDB\), application \(PostgreSQL\), and session type \(PostgreSQL\)\. Amazon RDS also supports the dimensions db\.name \(PostgreSQL, MySQL, and MariaDB\), db\.application\.name \(PostgreSQL\), and db\.session\_type\.name \(PostgreSQL\)\. For more information, see [Top load table](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_PerfInsights.UsingDashboard.html#USER_PerfInsights.UsingDashboard.Components.AvgActiveSessions.TopLoadItemsTable)\. | November 24, 2020 | -| [Amazon RDS for MariaDB supports a new major version](#WhatsNew) | You can now create Amazon RDS DB instances running MariaDB version 10\.5\. For more information, see [MariaDB on Amazon RDS versions](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_MariaDB.html#MariaDB.Concepts.VersionMgmt)\. | November 23, 2020 | -| [Support for MySQL 5\.6\.49](#WhatsNew) | You can now create Amazon RDS DB instances running MySQL version 5\.6\.49\. For more information, see [MySQL on Amazon RDS versions](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_MySQL.html#MySQL.Concepts.VersionMgmt)\. | November 20, 2020 | -| [Support for MySQL 5\.5\.62](#WhatsNew) | You can now create Amazon RDS DB instances running MySQL version 5\.5\.62\. For more information, see [MySQL on Amazon RDS versions](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_MySQL.html#MySQL.Concepts.VersionMgmt)\. | November 20, 2020 | -| [Performance Insights supports analyzing statistics for running PostgreSQL queries](#WhatsNew) | You can now analyze statistics for running queries with Performance Insights for PostgreSQL DB instances\. For more information, see [ Statistics for PostgreSQL](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_PerfInsights.UsingDashboard.html#USER_PerfInsights.UsingDashboard.AnalyzeDBLoad.AdditionalMetrics.PostgreSQL)\. | November 18, 2020 | -| [Amazon RDS extends support for storage autoscaling](#WhatsNew) | You can now enable storage autoscaling when creating a read replica, restoring a DB instance to a specified time, or restoring a MySQL DB instance from an Amazon S3 backup\. For more information, see [Managing capacity automatically with Amazon RDS storage autoscaling](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_PIOPS.StorageTypes.html#USER_PIOPS.Autoscaling)\. | November 18, 2020 | -| [Amazon RDS for SQL Server supports Database Mail](#WhatsNew) | With Database Mail you can send email messages from your Amazon RDS for SQL Server database instance\. After specifying the email recipients, you can add files or query results to the message you send\. For more information, see [Using Database Mail on Amazon RDS for SQL Server](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/SQLServer.DBMail.html)\. | November 4, 2020 | -| [Support for MySQL 8\.0\.21](#WhatsNew) | You can now create Amazon RDS DB instances running MySQL version 8\.0\.21\. For more information, see [MySQL on Amazon RDS versions](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_MySQL.html#MySQL.Concepts.VersionMgmt)\. | October 22, 2020 | -| [Amazon RDS extends support for exporting snapshots to Amazon S3](#WhatsNew) | You can now export DB snapshot data to Amazon S3 in all commercial AWS Regions\. For more information, see [Exporting DB snapshot data to Amazon S3](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_ExportSnapshot.html)\. | October 22, 2020 | -| [Amazon RDS for PostgreSQL supports read replica upgrades](#WhatsNew) | With Amazon RDS for PostgreSQL, when you do a major version upgrade of the primary DB instance, read replicas are also automatically upgraded\. For more information, see [ Upgrading the PostgreSQL DB engine](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_UpgradeDBInstance.PostgreSQL.html)\. | October 15, 2020 | -| [Amazon RDS for MariaDB, MySQL and PostgreSQL support the Graviton2 DB instance classes](#WhatsNew) | You can now use the Graviton2 DB instance classes db\.m6g\.x and db\.r6g\.x to create Amazon RDS DB instances running MariaDB, MySQL or PostgreSQL\. For more information, see [ Supported DB Engines for All Available DB Instance Classes](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Concepts.DBInstanceClass.html#Concepts.DBInstanceClass.Support)\. | October 15, 2020 | -| [Amazon RDS for SQL Server supports upgrades to SQL Server 2019](#WhatsNew) | You can upgrade your SQL Server DB instances to SQL Server 2019\. For more information, see [Upgrading the Microsoft SQL Server DB Engine](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_UpgradeDBInstance.SQLServer.html)\. | October 6, 2020 | -| [Amazon RDS for Oracle supports specifying the national character set](#WhatsNew) | The national character set, also called the NCHAR character set, is used in the `NCHAR`, `NVARCHAR2`, and `NCLOB` data types\. When you create a database, you can specify either AL16UTF16 \(default\) or UTF8 as the NCHAR character set\. For more information, see [Oracle character sets supported in Amazon RDS](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Appendix.OracleCharacterSets.html)\. | October 2, 2020 | -| [Support for MySQL 5\.7\.31](#WhatsNew) | You can now create Amazon RDS DB instances running MySQL version 5\.7\.31\. For more information, see [MySQL on Amazon RDS versions](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_MySQL.html#MySQL.Concepts.VersionMgmt)\. | October 1, 2020 | -| [Amazon RDS for PostgreSQL supports exporting data to Amazon S3](#WhatsNew) | You can query data from a PostgreSQL DB instance and export it directly into files stored in an Amazon S3bucket\. For more information, see [ Exporting data from an RDS for PostgreSQL DB instance to Amazon S3](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/postgresql-s3-export.html)\. | September 24, 2020 | -| [Amazon RDS for MySQL 8\.0 supports Percona XtraBackup](#WhatsNew) | You can now use Percona XtraBackup to restore a backup into an Amazon RDS for MySQL 8\.0 DB instance\. For more information, see [Restoring a backup into a MySQL DB instance](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/MySQL.Procedural.Importing.html)\. | September 17, 2020 | -| [Amazon RDS for SQL Server supports native backup and restore on DB instances with read replicas](#WhatsNew) | You can restore a SQL Server native backup onto a DB instance that has read replicas configured\. For more information, see [Importing and exporting SQL Server databases](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/SQLServer.Procedural.Importing.html)\. | September 16, 2020 | -| [Amazon RDS for SQL Server supports additional time zones](#WhatsNew) | You can match your DB instance time zone with your chosen time zone\. For more information, see [Local time zone for Microsoft SQL Server DB instances](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_SQLServer#SQLServer.Concepts.General.TimeZone)\. | September 11, 2020 | -| [Amazon RDS for PostgreSQL version 13 beta 3 in the database preview environment](#WhatsNew) | Amazon RDS for PostgreSQL now supports PostgreSQL Version 13 Beta 3 in the Database Preview Environment\. For more information, see [ PostgreSQL 13 versions](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_PostgreSQL.html#PostgreSQL.Concepts.General.version13)\. | September 9, 2020 | -| [Amazon RDS for SQL Server supports trace flag 692](#WhatsNew) | You can now use trace flag 692 as a startup parameter using DB parameter groups\. Enabling this trace flag disables fast inserts while bulk loading data into heap or clustered indexes\. For more information, see [Disabling fast inserts during bulk loading](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Appendix.SQLServer.CommonDBATasks.DisableFastInserts.html)\. | August 27, 2020 | -| [Amazon RDS for SQL Server supports Microsoft SQL Server 2019](#WhatsNew) | You can now create RDS DB instances that use SQL Server 2019\. For more information, see [Microsoft SQL Server versions on Amazon RDS](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_SQLServer#SQLServer.Concepts.General.VersionSupport)\. | August 26, 2020 | -| [RDS for Oracle supports mounted replica database](#WhatsNew) | When creating or modifying an Oracle replica, you can place it in mounted mode\. Because the replica database doesn't accept user connections, it can't serve a read\-only workload\. The mounted replica deletes archived redo log files after it applies them\. The primary use for mounted replicas is cross\-Region disaster recovery\. For more information, see [Overview of Oracle replicas](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/oracle-read-replicas.html#oracle-read-replicas.overview)\. | August 13, 2020 | -| [RDS for Oracle plans upgrade of 11g SE1 LI instances](#WhatsNew) | On November 1, 2020, we plan to begin automatically upgrading Oracle Database 11g SE1 License Included \(LI\) instances to Oracle Database 19c for Amazon RDS for Oracle\. All 11g instances, including reserved instances, will move to the latest available Oracle Release Update \(RU\)\. For more information, see [Preparing for the automatic upgrade of Oracle Database 11g SE1](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_UpgradeDBInstance.Oracle.html#USER_UpgradeDBInstance.Oracle.auto-upgrade-of-11g)\. | July 31, 2020 | -| [Amazon RDS supports new Graviton2 DB instance classes in preview release for PostgreSQL and MySQL](#WhatsNew) | You can now create Amazon RDS DB instances running PostgreSQL or MySQL that use the db\.m6g\.x and db\.r6g\.x DB instance classes\. For more information, see [ Supported DB engines for all available DB instance classes](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Concepts.DBInstanceClass.html#Concepts.DBInstanceClass.Support)\. | July 30, 2020 | -| [RDS for Oracle supports APEX 20\.1v1](#WhatsNew) | You can use APEX 20\.1v1 with all supported versions of Oracle Database\. For more information, see [Oracle application Express](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Appendix.Oracle.Options.APEX.html)\. | July 28, 2020 | -| [Support for MySQL 8\.0\.20](#WhatsNew) | You can now create Amazon RDS DB instances running MySQL version 8\.0\.20\. For more information, see [MySQL on Amazon RDS versions](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_MySQL.html#MySQL.Concepts.VersionMgmt)\. | July 23, 2020 | -| [Amazon RDS for MariaDB and MySQL support new DB instance classes](#WhatsNew) | You can now create Amazon RDS DB instances running MariaDB and MySQL that use the db\.m5\.16xlarge, db\.m5\.8xlarge, db\.r5\.16xlarge, and db\.r5\.8xlarge DB instance classes\. For more information, see [ Supported DB engines for all available DB instance classes](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Concepts.DBInstanceClass.html#Concepts.DBInstanceClass.Support)\. | July 23, 2020 | -| [RDS for SQL Server supports disabling old versions of TLS and ciphers](#WhatsNew) | You can turn certain security protocols and ciphers on and off\. For more information, see [Configuring security protocols and ciphers](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/SQLServer.Ciphers.html)\. | July 21, 2020 | -| [RDS supports Oracle Spatial on SE2](#WhatsNew) | You can use Oracle Spatial in Standard Edition 2 \(SE2\) for all versions of 12\.2, 18c, and 19c\. For more information, see [Oracle Spatial](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Oracle.Options.Spatial.html)\. | July 9, 2020 | -| [Amazon RDS supports AWS PrivateLink](#WhatsNew) | Amazon RDS now supports creating Amazon VPC endpoints for Amazon RDS API calls to keep traffic between applications and Amazon RDS in the AWS network\. For more information, see [ Amazon RDS and interface VPC endpoints \(AWS PrivateLink\)](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/vpc-interface-endpoints.html)\. | July 9, 2020 | -| [Amazon RDS for PostgreSQL versions 9\.4\.x has reached its end of support\.](#WhatsNew) | Amazon RDS for PostgreSQL no longer supports versions 9\.4\.x\. For supported versions, see [ Supported PostgreSQL database versions](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_PostgreSQL.html#PostgreSQL.Concepts.General.DBVersions)\. | July 8, 2020 | -| [Support for MariaDB 10\.3\.23 and 10\.4\.13](#WhatsNew) | You can now create Amazon RDS DB instances running MariaDB version 10\.3\.23 and 10\.4\.13\. For more information, see [MariaDB on Amazon RDS versions](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_MariaDB.html#MariaDB.Concepts.VersionMgmt)\. | July 6, 2020 | -| [Amazon RDS on AWS Outposts](#WhatsNew) | You can create Amazon RDS DB instances on AWS Outposts\. For more information, see [Working with Amazon RDS on AWS Outposts](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/rds-on-outposts.html)\. | July 6, 2020 | -| [Amazon RDS for Oracle creates inventory files automatically](#WhatsNew) | To open service requests for BYOL customers, Oracle Support requests inventory files generated by Opatch\. Amazon RDS for Oracle automatically creates inventory files every hour in the BDUMP directory\. For more information, see [Accessing Opatch files](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Appendix.Oracle.CommonDBATasks.Misc.html#Appendix.Oracle.CommonDBATasks.accessing-opatch-files)\. | July 6, 2020 | -| [Support for MySQL 5\.7\.30 and 5\.6\.48](#WhatsNew) | You can now create Amazon RDS DB instances running MySQL version 5\.7\.30 and 5\.6\.48\. For more information, see [MySQL on Amazon RDS versions](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_MySQL.html#MySQL.Concepts.VersionMgmt)\. | June 25, 2020 | -| [Amazon RDS for Oracle supports ADRCI](#WhatsNew) | The Automatic Diagnostic Repository Command Interpreter \(ADRCI\) utility is an Oracle command\-line tool that you use to manage diagnostic data\. By using the functions in the Amazon RDS package `rdsadmin_adrci_util`, you can list and package problems and incidents, and also show trace files\. For more information, see [Common DBA diagnostic tasks for Oracle DB instances](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Appendix.Oracle.CommonDBATasks.Diagnostics.html)\. | June 17, 2020 | -| [Support for MySQL 8\.0\.19](#WhatsNew) | You can now create Amazon RDS DB instances running MySQL version 8\.0\.19\. For more information, see [MySQL on Amazon RDS versions](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_MySQL.html#MySQL.Concepts.VersionMgmt)\. | June 2, 2020 | -| [MySQL 8\.0 supports lower case table names](#WhatsNew) | You can now set the `lower_case_table_names` parameter to `1` for Amazon RDS DB instances running MySQL version 8\.0\.19 and higher 8\.0 versions\. For more information, see [MySQL parameter exceptions for Amazon RDS DB instances](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/MySQL.KnownIssuesAndLimitations.html#MySQL.Concepts.ParameterNotes)\. | June 2, 2020 | -| [Amazon RDS for Microsoft SQL Server supports SQL Server Integration Services \(SSIS\)](#WhatsNew) | SSIS is a platform for data integration and workflow applications\. You can enable SSIS on existing or new DB instances\. It's installed on the same DB instance as your database engine\. For more information, see [Support for SQL Server Integration Services in SQL Server](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Appendix.SQLServer.Options.SSIS.html)\. | May 19, 2020 | -| [Amazon RDS for Microsoft SQL Server supports SQL Server Reporting Services \(SSRS\)](#WhatsNew) | SSRS is a server\-based application used for report generation and distribution\. You can enable SSRS on existing or new DB instances\. It's installed on the same DB instance as your database engine\. For more information, see [Support for SQL Server Reporting Services in SQL Server](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Appendix.SQLServer.Options.SSRS.html)\. | May 15, 2020 | -| [Amazon RDS for Microsoft SQL Server supports S3 integration on Multi\-AZ instances](#WhatsNew) | You can now use Amazon S3 with SQL Server features such as bulk insert on Multi\-AZ DB instances\. For more information, see [Integrating an Amazon RDS for SQL Server DB instance with Amazon S3](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/User.SQLServer.Options.S3-integration.html)\. | May 15, 2020 | -| [Amazon RDS for Oracle supports purging the recycle bin](#WhatsNew) | The `rdsadmin.rdsadmin_util.purge_dba_recyclebin` procedure purges the recycle bin\. For more information, see [Purging the recycle bin](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Appendix.Oracle.CommonDBATasks.Database.html#Appendix.Oracle.CommonDBATasks.PurgeRecycleBin)\. | May 13, 2020 | -| [Amazon RDS for Oracle improves manageability of Automatic Workload Repository \(AWR\)](#WhatsNew) | The `rdsadmin.rdsadmin_diagnostic_util` procedures generate AWR reports and extract AWR data into dump files\. For more information, see [Generating performance reports with Automatic Workload Repository \(AWR\)](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Appendix.Oracle.CommonDBATasks.Database.html#Appendix.Oracle.CommonDBATasks.AWR)\. | May 13, 2020 | -| [Amazon RDS for Microsoft SQL Server supports Microsoft Distributed Transaction Coordinator \(MSDTC\)](#WhatsNew) | Amazon RDS for SQL Server supports distributed transactions between hosts\. For more information, see [Support for Microsoft Distributed Transaction Coordinator in SQL Server](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Appendix.SQLServer.Options.MSDTC.html)\. | May 4, 2020 | -| [Amazon RDS for Microsoft SQL Server supports new versions](#WhatsNew) | You can now create Amazon RDS DB instances running SQL Server versions 2017 CU19 14\.00\.3281\.6, 2016 SP2 CU11 13\.00\.5598\.27, 2014 SP3 CU4 12\.00\.6329\.1, and 2012 SP4 GDR 11\.0\.7493\.4 for all editions\. For more information, see [Microsoft SQL Server versions on Amazon RDS](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_SQLServer.html#SQLServer.Concepts.General.VersionSupport)\. | April 28, 2020 | -| [Amazon RDS available in the Europe \(Milan\) Region](#WhatsNew) | Amazon RDS is now available in the Europe \(Milan\) Region\. For more information, see [Regions and Availability Zones](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Concepts.RegionsAndAvailabilityZones.html)\. | April 28, 2020 | -| [Amazon RDS support for Local Zones](#WhatsNew) | You can now launch DB instances into a Local Zone subnet\. For more information, see [ Regions, Availability Zones, and Local Zones](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Concepts.RegionsAndAvailabilityZones.html)\. | April 23, 2020 | -| [Amazon RDS available in the Africa \(Cape Town\) Region](#WhatsNew) | Amazon RDS is now available in the Africa \(Cape Town\) Region\. For more information, see [Regions and Availability Zones](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Concepts.RegionsAndAvailabilityZones.html)\. | April 22, 2020 | -| [Amazon RDS for Microsoft SQL Server supports SQL Server Analysis Services \(SSAS\)](#WhatsNew) | SSAS is an online analytical processing \(OLAP\) and data mining tool that is installed within SQL Server\. You can enable SSAS on existing or new DB instances\. It's installed on the same DB instance as your database engine\. For more information, see [Support for SQL Server Analysis Services in SQL Server](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Appendix.SQLServer.Options.SSAS.html)\. | April 17, 2020 | -| [Amazon RDS proxy for PostgreSQL](#WhatsNew) | Amazon RDS Proxy is now available for PostgreSQL\. You can use RDS Proxy to reduce the overhead of connection management on your DB instance and also the chance of "too many connections" errors\. The RDS Proxy is currently in public preview for PostgreSQL\. For more information, see [Managing connections with Amazon RDS proxy \(preview\)](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/rds-proxy.html)\. | April 8, 2020 | -| [Amazon RDS for Oracle supports Oracle APEX version 19\.2\.v1](#WhatsNew) | Amazon RDS for Oracle now supports Oracle Application Express \(APEX\) version 19\.2\.v1\. For more information, see [Oracle application Express](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Appendix.Oracle.Options.APEX.html)\. | April 8, 2020 | -| [Amazon RDS for MariaDB supports a new major version](#WhatsNew) | You can now create Amazon RDS DB instances running MariaDB version 10\.4\. For more information, see [MariaDB on Amazon RDS versions](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_MariaDB.html#MariaDB.Concepts.VersionMgmt)\. | April 6, 2020 | -| [Amazon RDS Performance Insights is available for Amazon RDS for MariaDB 10\.4](#WhatsNew) | Amazon RDS Performance Insights is now available for Amazon RDS for MariaDB version 10\.4\. For more information, see [Using Amazon RDS performance insights](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_PerfInsights.html)\. | April 6, 2020 | -| [Amazon RDS for PostgreSQL versions 9\.3\.x has reached its end of support](#WhatsNew) | Amazon RDS for PostgreSQL no longer supports versions 9\.3\.x\. For supported versions, see [ Supported PostgreSQL database versions](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_PostgreSQL.html#PostgreSQL.Concepts.General.DBVersions)\. | April 3, 2020 | -| [Amazon RDS for Microsoft SQL Server supports read replicas](#WhatsNew) | You can now create read replicas for SQL Server DB instances\. For more information, see [Working with read replicas](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_ReadRepl.html)\. | April 3, 2020 | -| [Amazon RDS for Microsoft SQL Server supports multifile backups](#WhatsNew) | You can now back up databases to multiple files using SQL Server native backup and restore\. For more information, see [Backing up a database](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/SQLServer.Procedural.Importing.html#SQLServer.Procedural.Importing.Native.Using.Backup)\. | April 2, 2020 | -| [Amazon RDS for Oracle integration with AWS License Manager](#WhatsNew) | Amazon RDS for Oracle is now integrated with AWS License Manager\. If you use the Bring Your Own License model, AWS License Manager integration makes it easier to monitor your Oracle license usage within your organization\. For more information, see [Integrating with AWS License Manager](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_Oracle.html#Oracle.Concepts.Licensing)\. | March 23, 2020 | -| [Support for 64 TiB on db\.r5 instances in Amazon RDS for MariaDB and MySQL](#WhatsNew) | You can now create Amazon RDS DB instances for MariaDB and MySQL that use the db\.r5 DB instance class with up to 64 TiB of storage\. For more information, see [Factors that affect storage performance](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_Storage.html#CHAP_Storage.Other.Factors)\. | March 18, 2020 | -| [Support for MySQL 8\.0\.17](#WhatsNew) | You can now create Amazon RDS DB instances running MySQL version 8\.0\.17\. For more information, see [MySQL on Amazon RDS versions](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_MySQL.html#MySQL.Concepts.VersionMgmt)\. | March 10, 2020 | -| [Amazon RDS Performance Insights is available for Amazon RDS for MySQL 8\.0](#WhatsNew) | Amazon RDS Performance Insights is now available for Amazon RDS for MySQL version 8\.0\.17 and higher 8\.0 versions\. For more information, see [Using Amazon RDS performance insights](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_PerfInsights.html)\. | March 10, 2020 | -| [Support for MySQL 5\.6\.46](#WhatsNew) | You can now create Amazon RDS DB instances running MySQL version 5\.6\.46\. For more information, see [MySQL on Amazon RDS versions](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_MySQL.html#MySQL.Concepts.VersionMgmt)\. | February 28, 2020 | -| [Amazon RDS Performance Insights is available for Amazon RDS for MariaDB 10\.3](#WhatsNew) | Amazon RDS Performance Insights is now available for Amazon RDS for MariaDB version 10\.3\.13 and higher 10\.3 versions\. For more information, see [Using Amazon RDS performance insights](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_PerfInsights.html)\. | February 26, 2020 | -| [Support for MySQL 5\.7\.28](#WhatsNew) | You can now create Amazon RDS DB instances running MySQL version 5\.7\.28\. For more information, see [MySQL on Amazon RDS versions](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_MySQL.html#MySQL.Concepts.VersionMgmt)\. | February 20, 2020 | -| [Support for MariaDB 10\.3\.20](#WhatsNew) | You can now create Amazon RDS DB instances running MariaDB version 10\.3\.20\. For more information, see [MariaDB on Amazon RDS versions](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_MariaDB.html#MariaDB.Concepts.VersionMgmt)\. | February 20, 2020 | -| [Amazon RDS for Microsoft SQL Server supports a new DB instance class](#WhatsNew) | You can now create Amazon RDS DB instances running SQL Server that use the db\.z1d DB instance class\. For more information, see [ DB instance class support for Microsoft SQL Server](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_SQLServer.html#SQLServer.Concepts.General.InstanceClasses)\. | February 19, 2020 | -| [Support for cross\-account, cross\-VPC Active Directory domains in Amazon RDS for SQL Server](#WhatsNew) | Amazon RDS for Microsoft SQL Server now supports associating DB instances with Active Directory domains owned by different accounts and VPCs\. For more information, see [Using Windows authentication with a Microsoft SQL Server DB instance](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_SQLServerWinAuth.html)\. | February 13, 2020 | -| [Oracle OLAP option](#WhatsNew) | Amazon RDS for Oracle now supports the On\-line Analytical Processing \(OLAP\) option for Oracle DB instances\. You can use Oracle OLAP to analyze large amounts of data by creating dimensional objects and cubes in accordance with the OLAP standard\. For more information, see [Oracle OLAP](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Oracle.Options.OLAP.html)\. | February 13, 2020 | -| [FIPS 140\-2 support for Oracle](#WhatsNew) | Amazon RDS for Oracle supports the Federal Information Processing Standard Publication 140\-2 \(FIPS 140\-2\) for SSL/TLS connections\. For more information, see [ FIPS support](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Appendix.Oracle.Options.SSL.html#Appendix.Oracle.Options.SSL.FIPS)\. | February 11, 2020 | -| [Amazon RDS for PostgreSQL supports new DB instance classes](#WhatsNew) | You can now create Amazon RDS DB instances running PostgreSQL that use the db\.m5\.16xlarge, db\.m5\.8xlarge, db\.r5\.16xlarge, and db\.r5\.8xlarge DB instance classes\. For more information, see [ Supported DB engines for all available DB instance classes](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Concepts.DBInstanceClass.html#Concepts.DBInstanceClass.Support)\. | February 11, 2020 | -| [Performance Insights supports analyzing statistics of running MariaDB and MySQL queries](#WhatsNew) | You can now analyze statistics of running queries with Performance Insights for MariaDB and MySQL DB instances\. For more information, see [ Analyzing statistics of running queries](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_PerfInsights.UsingDashboard.html#USER_PerfInsights.UsingDashboard.AnalyzeDBLoad.AdditionalMetrics)\. | February 4, 2020 | -| [Support for exporting DB snapshot data to Amazon S3 for MariaDB, MySQL, and PostgreSQL](#WhatsNew) | Amazon RDS supports exporting DB snapshot data to Amazon S3 for MariaDB, MySQL, and PostgreSQL\. For more information, see [Exporting DB snapshot data to Amazon S3](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_ExportSnapshot.html)\. | January 23, 2020 | -| [Amazon RDS for MySQL supports Kerberos authentication](#WhatsNew) | You can now use Kerberos authentication to authenticate users when they connect to your Amazon RDS for MySQL DB instances\. For more information, see [Using Kerberos authentication for MySQL](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/mysql-kerberos.html)\. | January 21, 2020 | -| [Amazon RDS Performance Insights supports viewing more SQL text for Amazon RDS for Microsoft SQL Server](#WhatsNew) | Amazon RDS Performance Insights now supports viewing more SQL text in the Performance Insights dashboard for Amazon RDS for Microsoft SQL Server DB instances\. For more information, see [Viewing more SQL text in the Performance Insights dashboard\.](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_PerfInsights.UsingDashboard.html#USER_PerfInsights.UsingDashboard.SQLTextSize) | December 17, 2019 | -| [Amazon RDS proxy](#WhatsNew) | You can reduce the overhead of connection management on your cluster, and reduce the chance of "too many connections" errors, by using the Amazon RDS Proxy\. You associate each proxy with an RDS DB instance or Aurora DB cluster\. Then you use the proxy endpoint in the connection string for your application\. The Amazon RDS Proxy is currently in a public preview state\. It supports the RDS for MySQL database engine\. For more information, see [Managing connections with Amazon RDS proxy \(preview\)](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/rds-proxy.html)\. | December 3, 2019 | -| [Amazon RDS on AWS Outposts \(preview\)](#WhatsNew) | With Amazon RDS on AWS Outposts, you can create AWS\-managed relational databases in your on\-premises data centers\. RDS on Outposts enables you to run RDS databases on AWS Outposts\. For more information, see [Amazon RDS on AWS Outposts \(preview\)](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/rds-on-outposts.html)\. | December 3, 2019 | -| [Amazon RDS for Oracle supports cross\-region read replicas](#WhatsNew) | Amazon RDS for Oracle now supports cross\-region read replicas with Active Data Guard\. For more information, see [Working with read replicas](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_ReadRepl.html) and [ Working with Oracle read replicas](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/oracle-read-replicas.html)\. | November 26, 2019 | -| [Performance Insights supports analyzing statistics of running Oracle queries](#WhatsNew) | You can now analyze statistics of running queries with Performance Insights for Oracle DB instances\. For more information, see [ Analyzing statistics of running queries](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_PerfInsights.UsingDashboard.html#USER_PerfInsights.UsingDashboard.AnalyzeDBLoad.AdditionalMetrics)\. | November 25, 2019 | -| [Amazon RDS for Microsoft SQL Server supports publishing logs to CloudWatch Logs](#WhatsNew) | You can configure your Amazon RDS for SQL Server DB instance to publish log events directly to Amazon CloudWatch Logs\. For more information, see [Publishing SQL Server logs to Amazon CloudWatch Logs](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_LogAccess.Concepts.SQLServer.html#USER_LogAccess.SQLServer.PublishtoCloudWatchLogs)\. | November 25, 2019 | -| [Amazon RDS for Microsoft SQL Server supports new DB instance classes](#WhatsNew) | You can now create Amazon RDS DB instances running SQL Server that use the db\.x1e and db\.x1 DB instance classes\. For more information, see [ DB instance class support for Microsoft SQL Server](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_SQLServer.html#SQLServer.Concepts.General.InstanceClasses)\. | November 25, 2019 | -| [Amazon RDS for Microsoft SQL Server supports differential and log restores](#WhatsNew) | You can restore differential backups and logs using SQL Server native backup and restore\. For more information, see [ Using native backup and restore](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/SQLServer.Procedural.Importing.html#SQLServer.Procedural.Importing.Native.Using)\. | November 25, 2019 | -| [Multi\-AZ supported on Amazon RDS for Microsoft SQL Server in new regions](#WhatsNew) | Multi\-AZ on SQL Server is now available in China, Middle East \(Bahrain\), and Europe \(Stockholm\)\. For more information, see [Multi\-AZ deployments for Microsoft SQL Server](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_SQLServerMultiAZ)\. | November 22, 2019 | -| [Amazon RDS for Microsoft SQL Server now supports bulk insert and S3 integration](#WhatsNew) | You can transfer files between a SQL Server DB instance and an Amazon S3 bucket\. Then you can use Amazon S3 with SQL Server features such as bulk insert\. For more information, see [Integrating an Amazon RDS for SQL Server DB instance with Amazon S3](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/User.SQLServer.Options.S3-integration.html)\. | November 21, 2019 | -| [Performance Insights counters for Amazon RDS for Microsoft SQL Server](#WhatsNew) | You can now add performance counters to your Performance Insights charts for Microsoft SQL Server DB instances\. For more information, see [ Performance Insights counters for Amazon RDS for Microsoft SQL Server](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_PerfInsights_Counters.html#USER_PerfInsights_Counters.SQLServer)\. | November 12, 2019 | -| [Amazon RDS for Microsoft SQL Server supports new DB instance class sizes](#WhatsNew) | You can now create Amazon RDS DB instances running SQL Server that use the 8xlarge and 16xlarge instance sizes for the db\.m5 and db\.r5 DB instance classes\. Instance sizes ranging from small to 2xlarge are now available for the db\.t3 instance class\. For more information, see [ DB instance class support for Microsoft SQL Server](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_SQLServer.html#SQLServer.Concepts.General.InstanceClasses)\. | November 11, 2019 | -| [Support for PostgreSQL snapshot upgrades](#WhatsNew) | If you have existing manual DB snapshots of your Amazon RDS PostgreSQL DB instances, you can now upgrade them to a later version of the PostgreSQL database engine\. For more information, see [ Upgrading a PostgreSQL DB snapshot](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_UpgradeDBSnapshot.PostgreSQL.html)\. | November 7, 2019 | -| [Amazon RDS for Oracle supports a new major version](#WhatsNew) | You can now create Amazon RDS DB instances running Oracle Database 19c \(19\.0\)\. For more information, see [ Oracle Database 19c with Amazon RDS](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_Oracle.html#Oracle.Concepts.FeatureSupport.19c)\. | November 7, 2019 | -| [Amazon RDS for PostgreSQL version 12\.0 in the database preview environment](#WhatsNew) | Amazon RDS for PostgreSQL now supports PostgreSQL Version 12\.0 in the Database Preview Environment\. For more information, see [ PostgreSQL version 12\.0 in the database preview environment](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_PostgreSQL.html#PostgreSQL.Concepts.General.version120)\. | November 1, 2019 | -| [Amazon RDS for PostgreSQL supports Kerberos authentication](#WhatsNew) | You can now use Kerberos authentication to authenticate users when they connect to your Amazon RDS DB instance running PostgreSQL\. For more information, see [Using Kerberos authentication with Amazon RDS for PostgreSQL](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/postgresql-kerberos.html)\. | October 28, 2019 | -| [OEM Management Agent database tasks for Oracle DB instances](#WhatsNew) | Amazon RDS for Oracle DB instances now support procedures to invoke certain EMCTL commands on the Management Agent\. For more information, see [OEM agent database tasks](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Oracle.Options.OEMAgent.html#Oracle.Options.OEMAgent.DBTasks)\. | October 24, 2019 | -| [Amazon RDS for PostgreSQL supports PostgreSQL transportable databases](#WhatsNew) | PostgreSQL Transportable Databases provide an extremely fast method of migrating an RDS PostgreSQL database between two DB instances\. For more information, see [Transporting PostgreSQL databases between DB instances](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/PostgreSQL.Procedural.Importing.html#PostgreSQL.TransportableDB)\. | October 8, 2019 | -| [Amazon RDS for Oracle supports Kerberos authentication](#WhatsNew) | You can now use Kerberos authentication to authenticate users when they connect to your Amazon RDS DB instance running Oracle\. For more information, see [ Using Kerberos authentication with Amazon RDS for Oracle](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/oracle-kerberos.html)\. | September 30, 2019 | -| [Amazon RDS for PostgreSQL version 12 beta 3 in the database preview environment](#WhatsNew) | Amazon RDS for PostgreSQL now supports PostgreSQL Version 12 Beta 3 in the Database Preview Environment\. For more information, see [PostgreSQL version 12 beta 3 on Amazon RDS in the database preview environment](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_PostgreSQL.html#PostgreSQL.Concepts.General.version12beta3)\. | August 28, 2019 | -| [Support for MySQL 8\.0\.16](#WhatsNew) | You can now create Amazon RDS DB instances running MySQL version 8\.0\.16\. For more information, see [MySQL on Amazon RDS versions](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_MySQL.html#MySQL.Concepts.VersionMgmt)\. | August 19, 2019 | -| [Amazon RDS for Oracle supports a new major version](#WhatsNew) | You can now create Amazon RDS DB instances running Oracle Database 18c \(18\.0\)\. For more information, see [ Oracle Database 18c with Amazon RDS](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_Oracle.html#Oracle.Concepts.FeatureSupport.18c)\. | August 15, 2019 | -| [Management Agent for OEM 13c release 3](#WhatsNew) | Amazon RDS for Oracle DB instances now support the Management Agent for Oracle Enterprise Manager \(OEM\) Cloud Control 13c Release 3\. For more information, see [Oracle Management Agent for Enterprise Manager cloud control](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Oracle.Options.OEMAgent.html)\. | August 7, 2019 | -| [Amazon RDS for PostgreSQL version 12 beta 2 in the database preview environment](#WhatsNew) | Amazon RDS for PostgreSQL now supports PostgreSQL Version 12 Beta 2 in the Database Preview Environment\. For more information, see [PostgreSQL version 12 beta 2 on Amazon RDS in the database preview environment](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_PostgreSQL.html#PostgreSQL.Concepts.General.version12)\. | August 6, 2019 | -| [Amazon RDS supports server collations for SQL Server](#WhatsNew) | Amazon RDS for SQL Server supports a selection of collations for new DB instances\. For more information, see [ Collations and character sets for Microsoft SQL Server](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Appendix.SQLServer.CommonDBATasks.Collation.html)\. | July 29, 2019 | -| [Amazon RDS for Oracle supports Oracle APEX version 19\.1\.v1](#WhatsNew) | Amazon RDS for Oracle now supports Oracle Application Express \(APEX\) version 19\.1\.v1\. For more information, see [Oracle application Express](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Appendix.Oracle.Options.APEX.html)\. | June 28, 2019 | -| [Amazon RDS for PostgreSQL version 13 beta 1 in the database preview environment](#WhatsNew) | Amazon RDS for PostgreSQL now supports PostgreSQL Version 13 Beta 1 in the Database Preview Environment\. For more information, see [ PostgreSQL 13 versions](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_PostgreSQL.html#PostgreSQL.Concepts.General.version13)\. | June 22, 2019 | -| [Amazon RDS storage autoscaling](#WhatsNew) | Storage autoscaling for Amazon RDS DB instances enables Amazon RDS to automatically expand the storage associated with a DB instance to reduce the chance of out\-of\-space conditions\. For information about storage autoscaling, see [Working with storage for Amazon RDS DB instances](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_PIOPS.StorageTypes.html)\. | June 20, 2019 | -| [Amazon RDS for Oracle supports db\.z1d DB instance classes](#WhatsNew) | You can now create Amazon RDS DB instances running Oracle that use the db\.z1d DB instance classes\. For more information, see [DB instance class](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Concepts.DBInstanceClass.html)\. | June 13, 2019 | -| [Amazon RDS Performance Insights supports viewing more SQL text for Amazon RDS for Oracle](#WhatsNew) | Amazon RDS Performance Insights now supports viewing more SQL text in the Performance Insights dashboard for Amazon RDS for Oracle DB instances\. For more information, see [Viewing more SQL text in the Performance Insights dashboard\.](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_PerfInsights.UsingDashboard.html#USER_PerfInsights.UsingDashboard.SQLTextSize) | June 10, 2019 | -| [Amazon RDS adds support native restores of SQL Server databases up to 16 TB](#WhatsNew) | You can now do native restores of up to 16 TB from SQL Server to Amazon RDS\. For more information, see [Amazon RDS for SQL Server: Limitations and recommendations](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/SQLServer.Procedural.Importing.html#SQLServer.Procedural.Importing.Native.Limitations)\. | June 4, 2019 | -| [Amazon RDS adds support for Microsoft SQL Server audit](#WhatsNew) | Using Amazon RDS for Microsoft SQL Server, you can audit server and database level events using SQL Server Audit, and view the results on your DB instance or send the audit log files directly to Amazon S3\. For more information, see [SQL Server Audit](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Appendix.SQLServer.Options.Audit.html)\. | May 23, 2019 | -| [Improvements to Amazon RDS recommendations](#WhatsNew) | Amazon RDS has improved its automated recommendations for database resources\. For example, Amazon RDS now provides recommendations for database parameters\. For more information, see [Using Amazon RDS recommendations](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Recommendations.html)\. | May 22, 2019 | -| [Support for more databases per DB instance for Amazon RDS for SQL Server](#WhatsNew) | You can create up to 30 databases on each of your DB instances running Microsoft SQL Server\. For more information, see [Limits for Microsoft SQL Server DB instances](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_SQLServer.html#SQLServer.Concepts.General.FeatureSupport.Limits)\. | May 21, 2019 | -| [Support for 64 TiB and 80k IOPS of storage for Amazon RDS for MariaDB, MySQL and PostgreSQL](#WhatsNew) | You can now create Amazon RDS DB instances for MariaDB, MySQL and PostgreSQL with up to 64 TiB of storage and up to 80,000 provisioned IOPS\. For more information, see [DB instance storage](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_Storage.html)\. | May 20, 2019 | -| [Amazon RDS for MySQL supports upgrade prechecks](#WhatsNew) | When you upgrade a DB instance from MySQL 5\.7 to MySQL 8\.0, Amazon RDS performs prechecks for incompatibilities\. For more information, see [ Prechecks for upgrades from MySQL 5\.7 to 8\.0](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_UpgradeDBInstance.MySQL.html#USER_UpgradeDBInstance.MySQL.57to80Prechecks)\. | May 17, 2019 | -| [Support for the MySQL password validation plugin](#WhatsNew) | You can now use the MySQL `validate_password` plugin for improved security of Amazon RDS for MySQL DB instances\. For more information, see [ Using the Password Validation Plugin](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_MySQL.html#MySQL.Concepts.PasswordValidationPlugin)\. | May 16, 2019 | -| [Performance Insights counters for Amazon RDS for Oracle](#WhatsNew) | You can now add performance counters to your Performance Insights charts for Oracle DB instances\. For more information, see [ Performance Insights counters for Amazon RDS for Oracle](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_PerfInsights_Counters.html#USER_PerfInsights_Counters.Oracle)\. | May 8, 2019 | -| [Support for per\-second billing](#WhatsNew) | Amazon RDS is now billed in 1\-second increments in all AWS Regions except AWS GovCloud \(US\) for on\-demand instances\. For more information, see [DB instance billing for Amazon RDS](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/User_DBInstanceBilling.html)\. | April 25, 2019 | -| [Support for importing data from Amazon S3 for Amazon RDS for PostgreSQL](#WhatsNew) | You can now import data from Amazon S3 file into a table in an RDS PostgreSQL DB instance\. For more information, see [Importing Amazon S3 data into an RDS PostgreSQL DB instance](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_PostgreSQL.S3Import.html)\. | April 24, 2019 | -| [Support for restoring 5\.7 backups from Amazon S3](#WhatsNew) | You can now create a backup of your MySQL version 5\.7 database, store it on Amazon S3, and then restore the backup file onto a new Amazon RDS DB instance running MySQL\. For more information, see [ Restoring a backup into a MySQL DB instance](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/MySQL.Procedural.Importing.html)\. | April 17, 2019 | -| [Support for multiple major version upgrades for Amazon RDS for PostgreSQL](#WhatsNew) | With Amazon RDS for PostgreSQL, you can now choose from multiple major versions when you upgrade the DB engine\. This feature enables you to skip ahead to a newer major version when you upgrade select PostgreSQL engine versions\. For more information, see [Upgrading the PostgreSQL DB engine](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_UpgradeDBInstance.PostgreSQL.html)\. | April 16, 2019 | -| [Support for 64 TiB of storage for Amazon RDS for Oracle ](#WhatsNew) | You can now create Amazon RDS DB instances for Oracle with up to 64 TiB of storage and up to 80,000 provisioned IOPS\. For more information, see [DB instance storage](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_Storage.html)\. | April 4, 2019 | -| [Support for MySQL 8\.0\.15](#WhatsNew) | You can now create Amazon RDS DB instances running MySQL version 8\.0\.15\. For more information, see [MySQL on Amazon RDS versions](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_MySQL.html#MySQL.Concepts.VersionMgmt)\. | April 3, 2019 | -| [Support for MariaDB 10\.3\.13](#WhatsNew) | You can now create Amazon RDS DB instances running MariaDB version 10\.3\.13\. For more information, see [MariaDB on Amazon RDS versions](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_MariaDB.html#MariaDB.Concepts.VersionMgmt)\. | April 3, 2019 | -| [Microsoft SQL Server 2008 R2 has reached its end of support on Amazon RDS](#WhatsNew) | Microsoft SQL Server 2008 R2 has reached its end of support, coinciding with the Microsoft plan to end extended support for this version on July 9, 2019\. Any existing Microsoft SQL Server 2008 R2 snapshots are to be automatically upgraded to the latest minor version of Microsoft SQL Server 2012 starting on June 1, 2019\. For more information, see [Microsoft SQL Server 2008 R2 support on Amazon RDS ](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_SQLServer.html#SQLServer.Concepts.General.FeatureSupport.2008)\. | April 2, 2019 | -| [Always On availability groups supported in Microsoft SQL Server 2017](#WhatsNew) | You can now use Always On Availability Groups in SQL Server 2017 Enterprise Edition 14\.00\.3049\.1 or later\. For more information, see [Multi\-AZ deployments for Microsoft SQL Server](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_SQLServerMultiAZ)\. | March 29, 2019 | -| [View volume metrics](#WhatsNew) | You can now view metrics for the Amazon Elastic Block Store \(Amazon EBS\) volumes, which are the physical devices used for database and log storage\. For more information, see [ Viewing Enhanced Monitoring](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Monitoring.OS.html#USER_Monitoring.OS.Viewing)\. | March 20, 2019 | -| [Support for MySQL 5\.7\.25](#WhatsNew) | You can now create Amazon RDS DB instances running MySQL version 5\.7\.25\. For more information, see [MySQL on Amazon RDS versions](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_MySQL.html#MySQL.Concepts.VersionMgmt)\. | March 19, 2019 | -| [Amazon RDS for Oracle supports RMAN DBA tasks](#WhatsNew) | Amazon RDS for Oracle now supports Oracle Recovery Manager \(RMAN\) DBA tasks, including RMAN backups\. For more information, see [ Common DBA Recovery Manager \(RMAN\) tasks for Oracle DB instances](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Appendix.Oracle.CommonDBATasks.RMAN.html)\. | March 14, 2019 | -| [Amazon RDS for PostgreSQL supports version 11\.1](#WhatsNew) | You can now create Amazon RDS DB instances running PostgreSQL version 11\.1\. For more information, see [ PostgreSQL version 11\.1 on Amazon RDS](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_PostgreSQL.html#PostgreSQL.Concepts.General.version111)\. | March 12, 2019 | -| [Multiple\-file restore is available in Amazon RDS for SQL Server](#WhatsNew) | You can now restore from multiple files with Amazon RDS for SQL Server\. For more information, see [Restoring a database](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/SQLServer.Procedural.Importing.html#SQLServer.Procedural.Importing.Native.Using.Restore)\. | March 11, 2019 | -| [MariaDB 10\.2\.21](#WhatsNew) | You can now create Amazon RDS DB instances running MariaDB version 10\.2\.21\. For more information, see [MariaDB on Amazon RDS versions](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_MariaDB.html#MariaDB.Concepts.VersionMgmt)\. | March 11, 2019 | -| [Amazon RDS for Oracle supports read replicas](#WhatsNew) | Amazon RDS for Oracle now supports read replicas with Active Data Guard\. For more information, see [Working with read replicas](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_ReadRepl.html) and [ Working with Oracle read replicas](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/oracle-read-replicas.html)\. | March 11, 2019 | -| [Amazon RDS Performance Insights is available for Amazon RDS for MariaDB](#WhatsNew) | Amazon RDS Performance Insights is now available for Amazon RDS for MariaDB\. For more information, see [Using Amazon RDS Performance Insights](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_PerfInsights.html)\. | March 11, 2019 | -| [MySQL 8\.0\.13 and 5\.7\.24](#WhatsNew) | You can now create Amazon RDS DB instances running MySQL versions 8\.0\.13 and 5\.7\.24\. For more information, see [ MySQL on Amazon RDS versions](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_MySQL.html#MySQL.Concepts.VersionMgmt)\. | March 8, 2019 | -| [Amazon RDS Performance Insights is available for Amazon RDS for SQL Server](#WhatsNew) | Amazon RDS Performance Insights is now available for Amazon RDS for SQL Server\. For more information, see [Using Amazon RDS Performance Insights](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_PerfInsights.html)\. | March 4, 2019 | -| [Amazon RDS for Oracle supports Amazon S3 integration](#WhatsNew) | You can now transfer files between an Amazon RDS for Oracle DB instance and an Amazon S3 bucket\. For more information, see [Integrating Amazon RDS for Oracle and Amazon S3](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/oracle-s3-integration.html)\. | February 26, 2019 | -| [Amazon RDS for MySQL and Amazon RDS for MariaDB support db\.t3 DB instance classes](#WhatsNew) | You can now create Amazon RDS DB instances running MySQL or MariaDB that use the db\.t3 DB instance classes\. For more information, see [DB instance class](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Concepts.DBInstanceClass.html)\. | February 20, 2019 | -| [Amazon RDS for MySQL and Amazon RDS for MariaDB support db\.r5 DB instance classes](#WhatsNew) | You can now create Amazon RDS DB instances running MySQL or MariaDB that use the db\.r5 DB instance classes\. For more information, see [DB instance class](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Concepts.DBInstanceClass.html)\. | February 20, 2019 | -| [Performance Insights counters for RDS for MySQL and PostgreSQL](#WhatsNew) | You can now add performance counters to your Performance Insights charts for MySQL and PostgreSQL DB instances\. For more information, see [ Performance Insights dashboard components](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_PerfInsights.UsingDashboard.html#USER_PerfInsights.UsingDashboard.Components)\. | February 19, 2019 | -| [Amazon RDS for PostgreSQL now supports adaptive autovacuum parameter tuning](#WhatsNew) | Adaptive autovacuum parameter tuning with Amazon RDS for PostgreSQL helps prevent transaction ID wraparound by adjusting autovacuum parameter values automatically\. For more information, see [Reducing the likelihood of transaction ID wraparound](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Appendix.PostgreSQL.CommonDBATasks.html#Appendix.PostgreSQL.CommonDBATasks.Autovacuum.AdaptiveAutoVacuuming)\. | February 12, 2019 | -| [Amazon RDS for Oracle supports Oracle APEX versions 18\.1\.v1 and 18\.2\.v1](#WhatsNew) | Amazon RDS for Oracle now supports Oracle Application Express \(APEX\) versions 18\.1\.v1 and 18\.2\.v1\. For more information, see [Oracle application Express](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Appendix.Oracle.Options.APEX.html)\. | February 11, 2019 | -| [Amazon RDS Performance Insights supports viewing more SQL text for RDS for MySQL](#WhatsNew) | Amazon RDS Performance Insights now supports viewing more SQL text in the Performance Insights dashboard for MySQL DB instances\. For more information, see [Viewing more SQL text in the Performance Insights dashboard\.](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_PerfInsights.UsingDashboard.html#USER_PerfInsights.UsingDashboard.SQLTextSize) | February 6, 2019 | -| [Amazon RDS for PostgreSQL supports db\.t3 DB instance classes](#WhatsNew) | You can now create Amazon RDS DB instances running PostgreSQL that use the db\.t3 DB instance classes\. For more information, see [DB instance class](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Concepts.DBInstanceClass.html)\. | January 25, 2019 | -| [Amazon RDS for Oracle supports db\.t3 DB instance classes](#WhatsNew) | You can now create Amazon RDS DB instances running Oracle that use the db\.t3 DB instance classes\. For more information, see [DB instance class](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Concepts.DBInstanceClass.html)\. | January 25, 2019 | -| [Amazon RDS Performance Insights supports viewing more SQL text for Amazon RDS PostgreSQL](#WhatsNew) | Amazon RDS Performance Insights now supports viewing more SQL text in the Performance Insights dashboard for Amazon RDS PostgreSQL DB instances\. For more information, see [Viewing more SQL text in the Performance Insights dashboard\.](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_PerfInsights.UsingDashboard.html#USER_PerfInsights.UsingDashboard.SQLTextSize) | January 24, 2019 | -| [Amazon RDS for Oracle supports a new version of SQLT](#WhatsNew) | Amazon RDS for Oracle now supports SQLT version 12\.2\.180725\. For more information, see [Oracle SQLT](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Oracle.Options.SQLT.html)\. | January 22, 2019 | -| [Amazon RDS for PostgreSQL supports db\.r5 DB instance classes](#WhatsNew) | You can now create Amazon RDS DB instances running PostgreSQL that use the db\.r5 DB instance classes\. For more information, see [DB instance class](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Concepts.DBInstanceClass.html)\. | December 19, 2018 | -| [Amazon RDS for PostgreSQL now supports restricted password management](#WhatsNew) | Amazon RDS for PostgreSQL enables you to restrict who can manage user passwords and password expiration changes by using the parameter `rds.restrict_password_commands` and the role `rds_password`\. For more information, see [Restricting password management](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Appendix.PostgreSQL.CommonDBATasks.html#Appendix.PostgreSQL.CommonDBATasks.RestrictPasswordMgmt)\. | December 19, 2018 | -| [Amazon RDS for PostgreSQL supports uploading database logs to Amazon CloudWatch Logs](#WhatsNew) | Amazon RDS for PostgreSQL supports uploading database logs to CloudWatch Logs\. For more information, see [Publishing PostgreSQL logs to CloudWatch Logs](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_LogAccess.Concepts.PostgreSQL.html#USER_LogAccess.Concepts.PostgreSQL.PublishtoCloudWatchLogs)\. | December 10, 2018 | -| [Amazon RDS for Oracle supports db\.r5 DB instance classes](#WhatsNew) | You can now create Amazon RDS DB instances running Oracle that use the db\.r5 DB instance classes\. For more information, see [DB instance class](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Concepts.DBInstanceClass.html)\. | November 20, 2018 | -| [Retain backups when deleting a DB instance](#WhatsNew) | Amazon RDS supports retaining automated backups when you delete a DB instance\. For more information, see [Working with backups](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_WorkingWithAutomatedBackups.html)\. | November 15, 2018 | -| [Amazon RDS for PostgreSQL supports db\.m5 DB instance classes](#WhatsNew) | You can now create Amazon RDS DB instances running PostgreSQL that use the db\.m5 DB instance classes\. For more information, see [DB instance class](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Concepts.DBInstanceClass.html)\. | November 15, 2018 | -| [Amazon RDS for Oracle supports a new major version](#WhatsNew) | You can now create Amazon RDS DB instances running Oracle version 12\.2\. For more information, see [ Oracle Database 12c Release 2 \(12\.2\.0\.1\) with Amazon RDS](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_Oracle.html#Oracle.Concepts.FeatureSupport.12cV2Overview)\. | November 13, 2018 | -| [Amazon RDS for SQL Server supports Always On](#WhatsNew) | Amazon RDS for SQL Server supports Always On Availability Groups\. For more information, see [Multi\-AZ deployments for Microsoft SQL Server](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_SQLServerMultiAZ.html)\. | November 8, 2018 | -| [Amazon RDS for PostgreSQL supports outbound network access using custom DNS servers](#WhatsNew) | Amazon RDS for PostgreSQL supports outbound network access using custom DNS servers\. For more information, see [Using a custom DNS server for outbound network access](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Appendix.PostgreSQL.CommonDBATasks.html#Appendix.PostgreSQL.CommonDBATasks.CustomDNS)\. | November 8, 2018 | -| [Amazon RDS for MariaDB, MySQL, and PostgreSQL supports 32 TiB of storage](#WhatsNew) | You can now create Amazon RDS DB instances with up to 32 TiB of storage for MySQL, MariaDB, and PostgreSQL\. For more information, see [DB instance storage](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_Storage.html)\. | November 7, 2018 | -| [Amazon RDS for Oracle supports extended data types](#WhatsNew) | You can now enable extended data types on Amazon RDS DB instances running Oracle\. With extended data types, the maximum size is 32,767 bytes for the VARCHAR2, NVARCHAR2, and RAW data types\. For more information, see [ Using extended data types](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_Oracle.html#Oracle.Concepts.ExtendedDataTypes)\. | November 6, 2018 | -| [Amazon RDS for Oracle supports db\.m5 DB instance classes](#WhatsNew) | You can now create Amazon RDS DB instances running Oracle that use the db\.m5 DB instance classes\. For more information, see [DB instance class](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Concepts.DBInstanceClass.html)\. | November 2, 2018 | -| [Amazon RDS for Oracle migration from SE, SE1, or SE2 to EE](#WhatsNew) | You can now migrate from any Oracle Database Standard Edition \(SE, SE1, or SE2\) to Oracle Database Enterprise Edition \(EE\)\. For more information, see [ Migrating between Oracle editions](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_Oracle.html#Oracle.Concepts.EditionsMigrating)\. | October 31, 2018 | -| [Amazon RDS can now stop Multi\-AZ instances](#WhatsNew) | Amazon RDS can now stop a DB instance that is part of a Multi\-AZ deployment\. Formerly, the stop instance feature had a limitation for multi\-AZ instances\. For more information, see [Stopping an Amazon RDS DB instance temporarily](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_StopInstance.html)\. | October 29, 2018 | -| [Amazon RDS Performance Insights is available for Amazon RDS for Oracle](#WhatsNew) | Amazon RDS Performance Insights is now available for Amazon RDS for Oracle\. For more information, see [Using Amazon RDS Performance Insights](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_PerfInsights.html)\. | October 29, 2018 | -| [Amazon RDS for PostgreSQL supports PostgreSQL version 11 in the database preview environment](#WhatsNew) | Amazon RDS for PostgreSQL now supports PostgreSQL version 11 in the Database Preview Environment\. For more information, see [ PostgreSQL version 11 on Amazon RDS in the database preview environment](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_PostgreSQL.html#PostgreSQL.Concepts.General.version11)\. | October 25, 2018 | -| [MySQL supports a new major version](#WhatsNew) | You can now create Amazon RDS DB instances running MySQL version 8\.0\. For more information, see [ MySQL on Amazon RDS versions](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_MySQL.html#MySQL.Concepts.VersionMgmt)\. | October 23, 2018 | -| [MariaDB supports a new major version](#WhatsNew) | You can now create Amazon RDS DB instances running MariaDB version 10\.3\. For more information, see [ MariaDB on Amazon RDS versions](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_MariaDB.html#MariaDB.Concepts.VersionMgmt)\. | October 23, 2018 | -| [Amazon RDS for Oracle supports Oracle JVM](#WhatsNew) | Amazon RDS for Oracle now supports the Oracle Java Virtual Machine \(JVM\) option\. For more information, see [ Oracle Java virtual machine](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/oracle-options-java.html)\. | October 16, 2018 | -| [Custom parameter group for restore and point in time recovery](#WhatsNew) | You can now specify a custom parameter group when you restore a snapshot or perform a point in time recovery operation\. For more information, see [ Restoring from a DB snapshot](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_RestoreFromSnapshot.html) and [ Restoring a DB instance to a specified time](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_PIT.html)\. | October 15, 2018 | -| [Amazon RDS for Oracle supports 32 TiB storage](#WhatsNew) | You can now create Oracle RDS DB instances with up to 32 TiB of storage\. For more information, see [ DB instance storage](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_Storage.html)\. | October 15, 2018 | -| [Amazon RDS for MySQL supports GTIDs](#WhatsNew) | Amazon RDS for MySQL now supports global transaction identifiers \(GTIDs\), which are unique across all DB instances and in a replication configuration\. For more information, see [ Using GTID\-based replication for RDS for MySQL](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/mysql-replication-gtid.html)\. | October 10, 2018 | -| [MySQL 5\.7\.23, 5\.6\.41, and 5\.5\.61](#WhatsNew) | You can now create Amazon RDS DB instances running MySQL versions 5\.7\.23, 5\.6\.41, and 5\.5\.61\. For more information, see [ MySQL on Amazon RDS versions](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_MySQL.html#MySQL.Concepts.VersionMgmt)\. | October 8, 2018 | -| [Amazon RDS for Oracle supports a new version of SQLT](#WhatsNew) | Amazon RDS for Oracle now supports SQLT version 12\.2\.180331\. For more information, see [Oracle SQLT](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Oracle.Options.SQLT.html)\. | October 4, 2018 | -| [Amazon RDS for PostgreSQL now supports IAM authentication](#WhatsNew) | Amazon RDS for PostgreSQL now supports IAM authentication\. For more information see [IAM database authentication for MySQL and PostgreSQL](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/UsingWithRDS.IAMDBAuth.html)\. | September 27, 2018 | -| [You can enable deletion protection for your Amazon RDS DB instances](#WhatsNew) | When you enable deletion protection for a DB instance, the database cannot be deleted by any user\. For more information, see [Deleting a DB instance](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_DeleteInstance.html)\. | September 26, 2018 | -| [Amazon RDS for MySQL and Amazon RDS for MariaDB support db\.m5 DB instance classes](#WhatsNew) | You can now create Amazon RDS DB instances running MySQL or MariaDB that use the db\.m5 DB instance classes\. For more information, see [DB instance class](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Concepts.DBInstanceClass.html)\. | September 18, 2018 | -| [Amazon RDS now supports upgrades to SQL Server 2017](#WhatsNew) | You can upgrade your existing DB instance to SQL Server 2017 from any version except SQL Server 2008\. To upgrade from SQL Server 2008, first upgrade to one of the other versions first\. For information, see  [Upgrading the Microsoft SQL Server DB engine](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_UpgradeDBInstance.SQLServer.html)\. | September 11, 2018 | -| [Amazon RDS for PostgreSQL now supports PostgreSQL version 11 beta 3 in the database preview environment](#WhatsNew) | In this release, the Write\-Ahead Log \(WAL\) segment size \(wal\_segment\_size\) is now set to 64MB\. For more about PostgreSQL version 11 Beta 3, see  [PostgreSQL 11 beta 3 released](https://www.postgresql.org/about/news/1878/)\. For information on the Database Preview Environment, see [Working with the database preview environment](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_PostgreSQL.html#working-with-the-database-preview-environment)\. | September 7, 2018 | -| [*Amazon Aurora User Guide*](#WhatsNew) | The [https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/CHAP_AuroraOverview.html](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/CHAP_AuroraOverview.html) describes all Amazon Aurora concepts and provides instructions on using the various features with both the console and the command line interface\. The *Amazon RDS User Guide* now covers non\-Aurora database engines\. | August 31, 2018 | -| [Amazon RDS Performance Insights is available for RDS for MySQL](#WhatsNew) | Amazon RDS Performance Insights is now available for RDS for MySQL\. For more information, see [Using Amazon RDS Performance Insights](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_PerfInsights.html)\. | August 28, 2018 | -| [Aurora PostgreSQL\-Compatible Edition now supports Aurora Auto Scaling](#WhatsNew) | Auto Scaling of Aurora replicas is now available for Aurora PostgreSQL\-Compatible Edition\. For more information, see [ Using Amazon Aurora auto scaling with Aurora replicas](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/Aurora.Integrating.AutoScaling.html)\. | August 16, 2018 | -| [Aurora Serverless for Aurora MySQL](#WhatsNew) | Aurora Serverless is an on\-demand, autoscaling configuration for Amazon Aurora\. For more information, see [ Using Amazon Aurora Serverless](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/aurora-serverless.html)\. | August 9, 2018 | -| [MySQL 5\.7\.22 and 5\.6\.40](#WhatsNew) | You can now create Amazon RDS DB instances running MySQL versions 5\.7\.22 and 5\.6\.40\. For more information, see [ MySQL on Amazon RDS versions](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_MySQL.html#MySQL.Concepts.VersionMgmt)\. | August 6, 2018 | -| [Aurora is now available in the China \(Ningxia\) region](#WhatsNew) | Aurora MySQL and Aurora PostgreSQL are now available in the China \(Ningxia\) region\. For more information, see [Availability for Amazon Aurora MySQL](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/Concepts.RegionsAndAvailabilityZones.html#Aurora.AuroraMySQL.Availability) and [Availability for Amazon Aurora PostgreSQL](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/Concepts.RegionsAndAvailabilityZones.html#Aurora.AuroraPostgreSQL.Availability)\. | August 6, 2018 | -| [Amazon RDS for MySQL supports delayed replication](#WhatsNew) | Amazon RDS for MySQL now supports delayed replication as a strategy for disaster recovery\. For more information, see [ Configuring delayed replication with MySQL](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_MySQL.Replication.ReadReplicas.html#USER_MySQL.Replication.ReadReplicas.DelayReplication)\. | August 6, 2018 | -| [Amazon RDS Performance Insights is available for Aurora MySQL](#WhatsNew) | Amazon RDS Performance Insights is now available for Aurora MySQL\. For more information, see [Using Amazon RDS Performance Insights](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_PerfInsights.html)\. | August 6, 2018 | -| [Amazon RDS Performance Insights integration with Amazon CloudWatch](#WhatsNew) | Amazon RDS Performance Insights automatically publishes metrics to Amazon CloudWatch\. For more information, see [Performance Insights metrics published to CloudWatch](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_PerfInsights.Cloudwatch.html)\. | August 6, 2018 | -| [Amazon RDS recommendations](#WhatsNew) | Amazon RDS now provides automated recommendations for database resources\. For more information, see [Using Amazon RDS recommendations](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Recommendations.html)\. | July 25, 2018 | -| [Incremental snapshot copies across AWS Regions](#WhatsNew) | Amazon RDS supports incremental snapshot copies across AWS Regions for both unencrypted and encrypted instances\. For more information, see [ Copying snapshots across AWS Regions](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_CopySnapshot.html#USER_CopySnapshot.AcrossRegions)\. | July 24, 2018 | -| [Amazon RDS Performance Insights is available for Amazon RDS for PostgreSQL](#WhatsNew) | Amazon RDS Performance Insights is now available for Amazon RDS for PostgreSQL\. For more information, see [Using Amazon RDS Performance Insights](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_PerfInsights.html)\. | July 18, 2018 | -| [Amazon RDS for Oracle supports Oracle APEX version 5\.1\.4\.v1](#WhatsNew) | Amazon RDS for Oracle now supports Oracle Application Express \(APEX\) version 5\.1\.4\.v1\. For more information, see [Oracle application Express](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Appendix.Oracle.Options.APEX.html)\. | July 10, 2018 | -| [Amazon RDS for Oracle supports publishing logs to Amazon CloudWatch Logs](#WhatsNew) | Amazon RDS for Oracle now supports publishing alert, audit, trace, and listener log data to a log group in CloudWatch Logs\. For more information, see [Publishing Oracle logs to Amazon CloudWatch Logs](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_LogAccess.Concepts.Oracle.html#USER_LogAccess.Oracle.PublishtoCloudWatchLogs)\. | July 9, 2018 | -| [MariaDB 10\.2\.15, 10\.1\.34, and 10\.0\.35](#WhatsNew) | You can now create Amazon RDS DB instances running MariaDB versions 10\.2\.15, 10\.1\.34, and 10\.0\.35\. For more information, see [MariaDB on Amazon RDS versions](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_MariaDB.html#MariaDB.Concepts.VersionMgmt)\. | July 5, 2018 | -| [Aurora PostgreSQL 1\.2 is available and compatible with PostgreSQL 9\.6\.8](#WhatsNew) | Aurora PostgreSQL 1\.2 is now available and is compatible with PostgreSQL 9\.6\.8\. For more information, see [Version 1\.2](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/AuroraPostgreSQL.Updates.20180305.html#AuroraPostgreSQL.Updates.20180305.12)\. | June 27, 2018 | -| [Read replicas for Amazon RDS PostgreSQL support Multi\-AZ deployments](#WhatsNew) | RDS read replicas in Amazon RDS PostgreSQL now support multiple Availability Zones\. For more information, see [Working with PostgreSQL read replicas](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_PostgreSQL.Replication.ReadReplicas.html)\. | June 25, 2018 | -| [Performance Insights available for Aurora PostgreSQL](#WhatsNew) | Performance Insights is generally available for Aurora PostgreSQL, with support for extended retention of performance data\. For more information, see [Using Amazon RDS performance insights](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_PerfInsights.html)\. | June 21, 2018 | -| [Aurora PostgreSQL available in western US \(northern California\) region](#WhatsNew) | Aurora PostgreSQL is now available in the western United States \(Northern California\) region\. For more information, see [Availability for Amazon Aurora PostgreSQL](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/Concepts.RegionsAndAvailabilityZones.html#Aurora.AuroraPostgreSQL.Availability)\. | June 11, 2018 | -| [Amazon RDS for Oracle now supports CPU configuration](#WhatsNew) | Amazon RDS for Oracle supports configuring the number of CPU cores and the number of threads for each core for the processor of a DB instance class\. For more information, see [Configuring the processor of the DB instance class](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Concepts.DBInstanceClass.html#USER_ConfigureProcessor)\. | June 5, 2018 | - -## Earlier updates - -The following table describes the important changes in each release of the *Amazon RDS User Guide* before June 2018\. - - -**** - -| Change | Description | Date changed | -| --- | --- | --- | -| Amazon RDS for PostgreSQL now supports PostgreSQL Version 11 Beta 1 in the Database Preview Environment | PostgreSQL version 11 Beta 1 contains several improvements that are described in [PostgreSQL 11 beta 1 released\!](https://www.postgresql.org/about/news/1855/) For information on the Database Preview Environment, see [Working with the database preview environment](CHAP_PostgreSQL.md#working-with-the-database-preview-environment)\. | May 31, 2018 | -| Amazon RDS for Oracle now supports TLS versions 1\.0 and 1\.2 | Amazon RDS for Oracle supports Transport Layer Security \(TLS\) versions 1\.0 and 1\.2\. For more information, see [TLS versions for the Oracle SSL option](Appendix.Oracle.Options.SSL.md#Appendix.Oracle.Options.SSL.TLS)\. | May 30, 2018 | -| Aurora MySQL supports publishing logs to Amazon CloudWatch Logs | Aurora MySQL now supports publishing general, slow, audit, and error log data to a log group in CloudWatch Logs\. For more information, see [ Publishing Aurora MySQL to CloudWatch Logs](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/AuroraMySQL.Integrating.CloudWatch.html)\. | May 23, 2018 | -| Database Preview Environment for Amazon RDS PostgreSQL | You can now launch a new instance of Amazon RDS PostgreSQL in a preview mode\. For more information about the Database Preview Environment see, [Working with the database preview environment](CHAP_PostgreSQL.md#working-with-the-database-preview-environment)\. | May 22, 2018 | -| Amazon RDS for Oracle DB instances support new DB instance classes | Oracle DB instances now support the db\.x1e and db\.x1 DB instance classes\. For more information, see [DB instance classes](Concepts.DBInstanceClass.md) and [RDS for Oracle instance classes](Oracle.Concepts.InstanceClasses.md)\. | May 22, 2018 | -| Amazon RDS PostgreSQL now supports postgres\_fdw on a read replica\. | You can now use postgres\_fdw to connect to a remote server from a read replica\. For more information see, [Using the postgres\_fdw extension to access external data](Appendix.PostgreSQL.CommonDBATasks.Extensions.foreign-data-wrappers.md#postgresql-commondbatasks-fdw)\. | May 17, 2018 | -| Amazon RDS for Oracle now supports setting sqlnet\.ora parameters | You can now set sqlnet\.ora parameters with Amazon RDS for Oracle\. For more information, see [Modifying connection properties using sqlnet\.ora parameters](USER_ModifyInstance.Oracle.sqlnet.md)\. | May 10, 2018 | -| Aurora PostgreSQL available in Asia Pacific \(Seoul\) region\. | Aurora PostgreSQL is now available in the Asia Pacific \(Seoul\) region\. For more information, see [ Availability for Amazon Aurora PostgreSQL](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/Concepts.RegionsAndAvailabilityZones.html#Aurora.AuroraPostgreSQL.Availability)\. | May 9, 2018 | -| Aurora MySQL supports backtracking | Aurora MySQL now supports "rewinding" a DB cluster to a specific time, without restoring data from a backup\. For more information, see [ Backtracking an Aurora DB cluster](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/AuroraMySQL.Managing.Backtrack.html)\. | May 9, 2018 | -| Aurora MySQL supports encrypted migration and replication from external MySQL | Aurora MySQL now supports encrypted migration and replication from an external MySQL database\. For more information, see [ Migrating data from an external MySQL database to an Amazon Aurora MySQL DB cluster ](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/AuroraMySQL.Migrating.ExtMySQL.html) and [ Replication between Aurora and MySQL or between Aurora and another Aurora DB cluster](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/AuroraMySQL.Replication.MySQL.html)\. | April 25, 2018 | -| Aurora PostgreSQL\-Compatible Edition support for the Copy\-on\-Write protocol\. | You can now clone databases in an Aurora PostgreSQL database cluster\. For more information see, [ Cloning databases in an Aurora DB cluster](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/Aurora.Managing.Clone.html)\. | April 10, 2018 | -| MariaDB 10\.2\.12, 10\.1\.31, and 10\.0\.34 | You can now create Amazon RDS DB instances running MariaDB versions 10\.2\.12, 10\.1\.31, and 10\.0\.34\. For more information, see [MariaDB on Amazon RDS versions](MariaDB.Concepts.VersionMgmt.md)\. | March 21, 2018 | -| Aurora PostgreSQL Support for new regions | Aurora PostgreSQL is now available in the EU \(London\) and Asia Pacific \(Singapore\) regions\. For more information, see [ Availability for Amazon Aurora PostgreSQL](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/Concepts.RegionsAndAvailabilityZones.html#Aurora.AuroraPostgreSQL.Availability)\. | March 13, 2018 | -| MySQL 5\.7\.21, 5\.6\.39, and 5\.5\.59 | You can now create Amazon RDS DB instances running MySQL versions 5\.7\.21, 5\.6\.39, and 5\.5\.59\. For more information, see [MySQL on Amazon RDS versions](MySQL.Concepts.VersionMgmt.md)\. | March 9, 2018 | -| Amazon RDS for Oracle now supports Oracle REST Data Services | Amazon RDS for Oracle supports Oracle REST Data Services as part of the APEX option\. For more information, see [Oracle Application Express \(APEX\)](Appendix.Oracle.Options.APEX.md)\. | March 9, 2018 | -| Amazon Aurora MySQL\-Compatible Edition available in new AWS Region | Aurora MySQL is now available in the Asia Pacific \(Singapore\) region\. For the complete list of AWS Regions for Aurora MySQL, see [ Availability for Amazon Aurora MySQL](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/Concepts.RegionsAndAvailabilityZones.html#Aurora.AuroraMySQL.Availability)\. | March 6, 2018 | -| Amazon RDS DB instances running Microsoft SQL Server support change data capture \(CDC\) | DB instances running Amazon RDS for Microsoft SQL Server now support change data capture \(CDC\)\. For more information, see [Change data capture support for Microsoft SQL Server DB instances](CHAP_SQLServer.md#SQLServer.Concepts.General.CDC)\. | February 6, 2018 | -| Aurora MySQL supports a new major version | You can now create Aurora MySQL DB clusters running MySQL version 5\.7\. For more information, see [ Amazon Aurora MySQL database engine updates 2018\-02\-06](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/AuroraMySQL.Updates.20180206.html)\. | February 6, 2018 | -| Publish MySQL and MariaDB logs to Amazon CloudWatch Logs | You can now publish MySQL and MariaDB log data to CloudWatch Logs\. For more information, see [Publishing MySQL logs to Amazon CloudWatch Logs](USER_LogAccess.MySQLDB.PublishtoCloudWatchLogs.md) and [Publishing MariaDB logs to Amazon CloudWatch Logs](USER_LogAccess.Concepts.MariaDB.md#USER_LogAccess.MariaDB.PublishtoCloudWatchLogs)\. | January 17, 2018 | -| Multi\-AZ support for read replicas | You can now create a read replica as a Multi\-AZ DB instance\. Amazon RDS creates a standby of your replica in another Availability Zone for failover support for the replica\. Creating your read replica as a Multi\-AZ DB instance is independent of whether the source database is a Multi\-AZ DB instance\. For more information, see [Working with DB instance read replicas](USER_ReadRepl.md)\. | January 11, 2018 | -| Amazon RDS for MariaDB supports a new major version | You can now create Amazon RDS DB instances running MariaDB version 10\.2\. For more information, see MariaDB 10\.2 support on Amazon RDS\. | January 3, 2018 | -| Amazon Aurora PostgreSQL\-Compatible Edition available in new AWS Region | Aurora PostgreSQL is now available in the EU \(Paris\) region\. For the complete list of AWS Regions for Aurora PostgreSQL, see [ Availability for Amazon Aurora PostgreSQL](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/Concepts.RegionsAndAvailabilityZones.html#Aurora.AuroraPostgreSQL.Availability)\. | December 22, 2017 | -| Aurora PostgreSQL supports new instance types | Aurora PostgreSQL now supports new instance types\. For the complete list of instance types, see [ Choosing the DB instance class](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/Concepts.DBInstanceClass.html)\. | December 20, 2017 | -| Amazon Aurora MySQL\-Compatible Edition available in new AWS Region | Aurora MySQL is now available in the EU \(Paris\) region\. For the complete list of AWS Regions for Aurora MySQL, see [ Availability for Amazon Aurora MySQL](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/Concepts.RegionsAndAvailabilityZones.html#Aurora.AuroraMySQL.Availability)\. | December 18, 2017 | -| Aurora MySQL supports hash joins | This feature can improve query performance when you need to join a large amount of data by using an equijoin\. For more information, see [ Working with hash joins in Aurora MySQL](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/AuroraMySQL.BestPractices.html#Aurora.BestPractices.HashJoin)\. | December 11, 2017 | -| Aurora MySQL supports native functions to invoke AWS Lambda functions | You can call the native functions `lambda_sync` and `lambda_async` when you use Aurora MySQL\. For more information, see [ Invoking a Lambda function from an Amazon Aurora MySQL DB cluster](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/AuroraMySQL.Integrating.Lambda.html)\. | December 11, 2017 | -| Added Aurora PostgreSQL HIPAA eligibility | Aurora PostgreSQL now supports building HIPAA compliant applications\. For more information, see [ Working with Amazon Aurora PostgreSQL](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/Aurora.AuroraPostgreSQL.html)\. | December 6, 2017 | -| Additional AWS Regions available for Amazon Aurora with PostgreSQL compatibility | Amazon Aurora with PostgreSQL compatibility is now available in four new AWS Regions\. For more information, see [ Availability for Amazon Aurora PostgreSQL](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/Concepts.RegionsAndAvailabilityZones.html#Aurora.AuroraPostgreSQL.Availability)\. | November 22, 2017 | -| Modify storage for Amazon RDS DB instances running Microsoft SQL Server | You can now modify the storage of your Amazon RDS DB instances running SQL Server\. For more information, see [Modifying an Amazon RDS DB instance](Overview.DBInstance.Modifying.md)\. | November 21, 2017 | -| Amazon RDS supports 16 TiB storage for Linux\-based engines | You can now create MySQL, MariaDB, PostgreSQL, and Oracle RDS DB instances with up to 16 TiB of storage\. For more information, see [Amazon RDS DB instance storage](CHAP_Storage.md)\. | November 21, 2017 | -| Amazon RDS supports fast scale up of storage | You can now add storage to MySQL, MariaDB, PostgreSQL, and Oracle RDS DB instances in a few minutes\. For more information, see [Amazon RDS DB instance storage](CHAP_Storage.md)\. | November 21, 2017 | -| Amazon RDS supports MariaDB versions 10\.1\.26 and 10\.0\.32 | You can now create Amazon RDS DB instances running MariaDB versions 10\.1\.26 and 10\.0\.32\. For more information, see [MariaDB on Amazon RDS versions](MariaDB.Concepts.VersionMgmt.md)\. | November 20, 2017 | -| Amazon RDS for Microsoft SQL Server now supports new DB instance classes | You can now create Amazon RDS DB instances running SQL Server that use the db\.r4 and db\.m4\.16xlarge DB instance classes\. For more information, see [DB instance class support for Microsoft SQL Server](CHAP_SQLServer.md#SQLServer.Concepts.General.InstanceClasses)\. | November 20, 2017 | -| Amazon RDS for MySQL and MariaDB now supports new DB instance classes | You can now create Amazon RDS DB instances running MySQL and MariaDB that use the db\.r4, db\.m4\.16xlarge, db\.t2\.xlarge, and db\.t2\.2xlarge DB instance classes\. For more information, see [DB instance classes](Concepts.DBInstanceClass.md)\. | November 20, 2017 | -| SQL Server 2017 | You can now create Amazon RDS DB instances running Microsoft SQL Server 2017\. You can also create DB instances running SQL Server 2016 SP1 CU5\. For more information, see [Amazon RDS for Microsoft SQL Server](CHAP_SQLServer.md)\. | November 17, 2017 | -| Restore MySQL backups from Amazon S3 | You can now create a backup of your on\-premises database, store it on Amazon S3, and then restore the backup file onto a new Amazon RDS DB instance running MySQL\. For more information, see [Restoring a backup into a MySQL DB instance](MySQL.Procedural.Importing.md)\. | November 17, 2017 | -| Auto Scaling with Aurora Replicas | Amazon Aurora MySQL now supports Aurora Auto Scaling\. Aurora Auto Scaling dynamically adjusts the number of Aurora Replicas based on increases or decreases in connectivity or workload\. For more information, see [ Using Amazon Aurora Auto Scaling with Aurora replicas](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/Aurora.Integrating.AutoScaling.html)\. | November 17, 2017 | -| Oracle default edition support | Amazon RDS for Oracle DB instances now supports setting the default edition for the DB instance\. For more information, see [Setting the default edition for a DB instance](Appendix.Oracle.CommonDBATasks.Database.md#Appendix.Oracle.CommonDBATasks.DefaultEdition)\. | November 3, 2017 | -| Oracle DB instance file validation | Amazon RDS for Oracle DB instances now supports validating DB instance files with the Oracle Recovery Manager \(RMAN\) logical validation utility\. For more information, see [Validating DB instance files](Appendix.Oracle.CommonDBATasks.RMAN.md#Appendix.Oracle.CommonDBATasks.ValidateDBFiles)\. | November 3, 2017 | -| Management Agent for OEM 13c | Amazon RDS for Oracle DB instances now support the Management Agent for Oracle Enterprise Manager \(OEM\) Cloud Control 13c\. For more information, see [Oracle Management Agent for Enterprise Manager Cloud Control](Oracle.Options.OEMAgent.md)\. | November 1, 2017 | -| Storage reconfiguration for Microsoft SQL Server snapshots | You can now reconfigure the storage when you restore a snapshot to an Amazon RDS DB instance running Microsoft SQL Server\. For more information, see [Restoring from a DB snapshot](USER_RestoreFromSnapshot.md)\. | October 26, 2017 | -| Asynchronous key prefetch for Aurora MySQL\-Compatible Edition | Asynchronous key prefetch \(AKP\) improves the performance of noncached index joins, by prefetching keys in memory ahead of when they are needed\. For more information, see [ Working with asynchronous key prefetch in Amazon Aurora](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/AuroraMySQL.BestPractices.html#Aurora.BestPractices.AKP)\. | October 26, 2017 | -| MySQL 5\.7\.19, 5\.6\.37, and 5\.5\.57 | You can now create Amazon RDS DB instances running MySQL versions 5\.7\.19, 5\.6\.37, and 5\.5\.57\. For more information, see [MySQL on Amazon RDS versions](MySQL.Concepts.VersionMgmt.md)\. | October 25, 2017 | -| General availability of Amazon Aurora with PostgreSQL compatibility | Amazon Aurora with PostgreSQL compatibility makes it simple and cost\-effective to set up, operate, and scale your new and existing PostgreSQL deployments, thus freeing you to focus on your business and applications\. For more information, see [ Working with Amazon Aurora PostgreSQL](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/Aurora.AuroraPostgreSQL.html)\. | October 24, 2017 | -| Amazon RDS for Oracle DB instances support new DB instance classes | Amazon RDS for Oracle DB instances now support memory optimized next generation \(db\.r4\) instance classes\. Amazon RDS for Oracle DB instances also now support the following new current generation instance classes: db\.m4\.16xlarge, db\.t2\.xlarge, and db\.t2\.2xlarge\. For more information, see [DB instance classes](Concepts.DBInstanceClass.md) and [RDS for Oracle instance classes](Oracle.Concepts.InstanceClasses.md)\. | October 23, 2017 | -| New feature | Your new and existing Reserved Instances can now cover multiple sizes in the same DB instance class\. Size\-flexible reserved instances are available for DB instances with the same AWS Region, database engine, and instance family, and across AZ configuration\. Size\-flexible reserved instances are available for the following database engines: Amazon Aurora, MariaDB, MySQL, Oracle \(Bring Your Own License\), PostgreSQL\. For more information, see [Size\-flexible reserved DB instances](USER_WorkingWithReservedDBInstances.md#USER_WorkingWithReservedDBInstances.SizeFlexible)\. | October 11, 2017 | -| New feature | You can now use the Oracle SQLT option to tune a SQL statement for optimal performance\. For more information, see [Oracle SQLT](Oracle.Options.SQLT.md)\. | September 22, 2017 | -| New feature | If you have existing manual DB snapshots of your Amazon RDS for Oracle DB instances, you can now upgrade them to a later version of the Oracle database engine\. For more information, see [Upgrading an Oracle DB snapshot](USER_UpgradeDBSnapshot.Oracle.md)\. | September 20, 2017 | -| New feature | You can now use Oracle Spatial to store, retrieve, update, and query spatial data in your Amazon RDS DB instances running Oracle\. For more information, see [Oracle Spatial](Oracle.Options.Spatial.md)\. | September 15, 2017 | -| New feature | You can now use Oracle Locator to support internet and wireless service\-based applications and partner\-based GIS solutions with your Amazon RDS DB instances running Oracle\. For more information, see [Oracle Locator](Oracle.Options.Locator.md)\. | September 15, 2017 | -| New feature | You can now use Oracle Multimedia to store, manage, and retrieve images, audio, video, and other heterogeneous media data in your Amazon RDS DB instances running Oracle\. For more information, see [Oracle Multimedia](Oracle.Options.Multimedia.md)\. | September 15, 2017 | -| New feature | You can now export audit logs from your Amazon Aurora MySQL DB clusters to Amazon CloudWatch Logs\. For more information, see [ Publishing Aurora MySQL logs to Amazon CloudWatch Logs](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/AuroraMySQL.Integrating.CloudWatch.html)\. | September 14, 2017 | -| New feature | Amazon RDS now supports multiple versions of Oracle Application Express \(APEX\) for your DB instances running Oracle\. For more information, see [Oracle Application Express \(APEX\)](Appendix.Oracle.Options.APEX.md)\. | September 13, 2017 | -| New feature | You can now use Amazon Aurora to migrate an unencrypted or encrypted DB snapshot or MySQL DB instance to an encrypted Aurora MySQL DB cluster\. For more information, see [ Migrating an RDS for MySQL snapshot to Aurora](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/AuroraMySQL.Migrating.RDSMySQL.Import.html) and [ Migrating data from a MySQL DB instance to an Amazon Aurora MySQL DB cluster by using an Aurora read replica](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/AuroraMySQL.Migrating.RDSMySQL.Replica.html)\. | September 5, 2017 | -| New feature | You can use Amazon RDS for Microsoft SQL Server databases to build HIPAA\-compliant applications\. For more information, see [Compliance program support for Microsoft SQL Server DB instances](CHAP_SQLServer.md#SQLServer.Concepts.General.Compliance)\. | August 31, 2017 | -| New feature | You can now use Amazon RDS for MariaDB databases to build HIPAA\-compliant applications\. For more information, see [Amazon RDS for MariaDB](CHAP_MariaDB.md)\. | August 31, 2017 | -| New feature | You can now create Amazon RDS DB instances running Microsoft SQL Server with allocated storage up to 16 TiB, and Provisioned IOPS to storage ranges of 1:1–50:1\. For more information, see [Amazon RDS DB instance storage](CHAP_Storage.md)\. | August 22, 2017 | -| New feature | You can now use Multi\-AZ deployments for DB instances running Microsoft SQL Server in the EU \(Frankfurt\) region\. For more information, see [Multi\-AZ deployments for Amazon RDS for Microsoft SQL Server](USER_SQLServerMultiAZ.md)\. | August 3, 2017 | -| New feature | You can now create Amazon RDS DB instances running MariaDB versions 10\.1\.23 and 10\.0\.31\. For more information, see [MariaDB on Amazon RDS versions](MariaDB.Concepts.VersionMgmt.md)\. | July 17, 2017 | -| New feature | Amazon RDS now supports Microsoft SQL Server Enterprise Edition with the License Included model in all AWS Regions\. For more information, see [Licensing Microsoft SQL Server on Amazon RDS](SQLServer.Concepts.General.Licensing.md)\. | July 13, 2017 | -| New feature | Amazon RDS for Oracle now supports Linux kernel huge pages for increased database scalability\. The use of huge pages results in smaller page tables and less CPU time spent on memory management, increasing the performance of large database instances\. You can use huge pages with your Amazon RDS DB instances running all editions of Oracle versions 12\.1\.0\.2 and 11\.2\.0\.4\. For more information, see [Turning on HugePages for an RDS for Oracle instance](Oracle.Concepts.HugePages.md)\. | July 7, 2017 | -| New feature | Updated to support encryption at rest \(EAR\) for db\.t2\.small and db\.t2\.medium DB instance classes for all non\-Aurora DB engines\. For more information, see [Availability of Amazon RDS encryption](Overview.Encryption.md#Overview.Encryption.Availability)\. | June 27, 2017 | -| New feature | Updated to support Amazon Aurora in the Europe \(Frankfurt\) region\. For more information, see [ Availability for Amazon Aurora MySQL](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/Concepts.RegionsAndAvailabilityZones.html#Aurora.AuroraMySQL.Availability)\. | June 16, 2017 | -| New feature | You can now specify an option group when you copy a DB snapshot across AWS regions\. For more information, see [Option group considerations](USER_CopySnapshot.md#USER_CopySnapshot.Options)\. | June 12, 2017 | -| New feature | You can now copy DB snapshots created from specialized DB instances across AWS regions\. You can copy snapshots from DB instances that use Oracle TDE, Microsoft SQL Server TDE, and Microsoft SQL Server Multi\-AZ with Mirroring\. For more information, see [Copying a DB snapshot](USER_CopySnapshot.md#USER_CopyDBSnapshot)\. | June 12, 2017 | -| New feature | Amazon Aurora now allows you to quickly and cost\-effectively copy all of your databases in an Amazon Aurora DB cluster\. For more information, see [ Cloning databases in an Aurora DB cluster](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/Aurora.Managing.Clone.html)\. | June 12, 2017 | -| New feature | Amazon RDS now supports Microsoft SQL Server 2016 SP1 CU2\. For more information, see [Amazon RDS for Microsoft SQL Server](CHAP_SQLServer.md)\. | June 7, 2017 | -| Preview | Public preview of Amazon Aurora with PostgreSQL Compatibility\. For more information, see [ Working with Amazon Aurora PostgreSQL](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/Aurora.AuroraPostgreSQL.html)\. | April 19, 2017 | -| New feature | Amazon Aurora now allows you to run an ALTER TABLE *tbl\_name* ADD COLUMN *col\_name* *column\_definition* operation nearly instantaneously\. The operation completes without requiring the table to be copied and without materially impacting other DML statements\. For more information, see [ Altering tables in Amazon Aurora using fast DDL](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/AuroraMySQL.Managing.FastDDL.html)\. | April 5, 2017 | -| New feature | We have added a new monitoring command, SHOW VOLUME STATUS, to display the number of nodes and disks in a volume\. For more information, see [ Displaying volume status for an Aurora DB cluster](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/AuroraMySQL.Managing.VolumeStatus.html)\. | April 5, 2017 | -| New feature | You can now use your own custom logic in your custom password verification functions for Oracle on Amazon RDS\. For more information, see [Creating custom functions to verify passwords](Appendix.Oracle.CommonDBATasks.System.md#Appendix.Oracle.CommonDBATasks.CustomPassword)\. | March 21, 2017 | -| New feature | You can now access your online and archived redo log files on your Oracle DB instances on Amazon RDS\. For more information, see [Accessing online and archived redo logs](Appendix.Oracle.CommonDBATasks.Log.md#Appendix.Oracle.CommonDBATasks.Log.Download)\. | March 21, 2017 | -| New feature | You can now copy both encrypted and unencrypted DB cluster snapshots between accounts in the same region\. For more information, see [ Copying a DB cluster snapshot across accounts](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_CopySnapshot.html#USER_CopyDBClusterSnapshot.CrossAccount)\. | March 7, 2017 | -| New feature | You can now share encrypted DB cluster snapshots between accounts in the same region\. For more information, see [Sharing a DB cluster snapshot](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_ShareSnapshot.html)\. | March 7, 2017 | -| New feature | You can now replicate encrypted Amazon Aurora MySQL DB clusters to create cross\-region Aurora Replicas\. For more information, see [ Replicating Aurora MySQL DB clusters across AWS Regions](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/AuroraMySQL.Replication.CrossRegion.html)\. | March 7, 2017 | -| New feature | You can now require that all connections to your DB instance running Microsoft SQL Server use Secure Sockets Layer \(SSL\)\. For more information, see [Using SSL with a Microsoft SQL Server DB instance](SQLServer.Concepts.General.SSL.Using.md)\. | February 27, 2017 | -| New feature | You can now set your local time zone to one of 15 additional time zones\. For more information, see [Supported time zones](CHAP_SQLServer.md#SQLServer.Concepts.General.TimeZone.Zones)\. | February 27, 2017 | -| New feature | You can now use the Amazon RDS procedure `msdb.dbo.rds_shrink_tempdbfile` to shrink the tempdb database on your DB instances running Microsoft SQL Server\. For more information, see [Shrinking the tempdb database](SQLServer.TempDB.md#SQLServer.TempDB.Shrinking)\. | February 17, 2017 | -| New feature | You can now compress your backup file when you export your Enterprise and Standard Edition Microsoft SQL Server database from an Amazon RDS DB instance to Amazon S3\. For more information, see [Compressing backup files](SQLServer.Procedural.Importing.md#SQLServer.Procedural.Importing.Native.Compression)\. | February 17, 2017 | -| New feature | Amazon RDS now supports custom DNS servers to resolve DNS names used in outbound network access on your DB instances running Oracle\. For more information, see [Setting up a custom DNS server](Appendix.Oracle.CommonDBATasks.System.md#Appendix.Oracle.CommonDBATasks.CustomDNS)\. | January 26, 2017 | -| New feature | Amazon RDS now supports creating an encrypted read replica in another region\. For more information, see [Creating a read replica in a different AWS Region](USER_ReadRepl.md#USER_ReadRepl.XRgn) and [CreateDBInstanceReadReplica](https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_CreateDBInstanceReadReplica.html)\. | January 23, 2017 | -| New feature | Amazon RDS now supports upgrading a MySQL DB snapshot from MySQL 5\.1 to MySQL 5\.5\. | January 20, 2017 | -| New feature | Amazon RDS now supports copying an encrypted DB snapshot to another region for the MariaDB, MySQL, Oracle, PostgreSQL, and Microsoft SQL Server database engines\. For more information, see [Copying a DB snapshot](USER_CopySnapshot.md#USER_CopyDBSnapshot) and [CopyDBSnapshot](https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_CopyDBSnapshot.html)\. | December 20, 2016 | -| New feature | Amazon Aurora MySQL now supports spatial indexing\. Spatial indexing improves query performance on large datasets for queries that use spatial data\. For more information, see [ Amazon Aurora MySQL and spatial data](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/Aurora.AuroraMySQL.Overview.html#Aurora.AuroraMySQL.Spatial)\. | December 14, 2016 | -| New feature | Amazon RDS now supports outbound network access on your DB instances running Oracle\. You can use utl\_http, utl\_tcp, and utl\_smtp to connect from your DB instance to the network\. For more information, see [Configuring UTL\_HTTP access using certificates and an Oracle wallet](Oracle.Concepts.ONA.md)\. | December 5, 2016 | -| New feature | Amazon RDS has retired support for MySQL version 5\.1\. However, you can restore existing MySQL 5\.1 snapshots to a MySQL 5\.5 instance\. For more information, see [Supported storage engines for RDS for MySQL](MySQL.Concepts.FeatureSupport.md#MySQL.Concepts.Storage)\. | November 15, 2016 | -| New feature | Amazon RDS now supports Microsoft SQL Server 2016 RTM CU2\. For more information, see [Amazon RDS for Microsoft SQL Server](CHAP_SQLServer.md)\. | November 4, 2016 | -| New feature | Amazon RDS now supports major version upgrades for DB instances running Oracle\. You can now upgrade your Oracle DB instances from 11g to 12c\. For more information, see [Upgrading the RDS for Oracle DB engine](USER_UpgradeDBInstance.Oracle.md)\. | November 2, 2016 | -| New feature | You can now create DB instances running Microsoft SQL Server 2014 Enterprise Edition\. Amazon RDS now supports SQL Server 2014 SP2 for all editions and all regions\. For more information, see [Amazon RDS for Microsoft SQL Server](CHAP_SQLServer.md)\. | October 25, 2016 | -| New feature | Amazon Aurora MySQL now integrates with other AWS services: You can load text or XML data into a table from an Amazon S3 bucket, or invoke an AWS Lambda function from database code\. For more information, see [ Integrating Aurora MySQL with other AWS services](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/AuroraMySQL.Integrating.html)\. | October 18, 2016 | -| New feature | You can now access the tempdb database on your Amazon RDS DB instances running Microsoft SQL Server\. You can access the tempdb database by using Transact\-SQL through Microsoft SQL Server Management Studio \(SSMS\), or any other standard SQL client application\. For more information, see [Accessing the tempdb database on Microsoft SQL Server DB instances on Amazon RDS](SQLServer.TempDB.md)\. | September 29, 2016 | -| New feature | You can now use the UTL\_MAIL package with your Amazon RDS DB instances running Oracle\. For more information, see [Oracle UTL\_MAIL](Oracle.Options.UTLMAIL.md)\. | September 20, 2016 | -| New features | You can now set the time zone of your new Microsoft SQL Server DB instances to a local time zone, to match the time zone of your applications\. For more information, see [Local time zone for Microsoft SQL Server DB instances](CHAP_SQLServer.md#SQLServer.Concepts.General.TimeZone)\. | September 19, 2016 | -| New feature | You can now use the Oracle Label Security option to control access to individual table rows in your Amazon RDS DB instances running Oracle Database 12c\. With Oracle Label Security, you can enforce regulatory compliance with a policy\-based administration model, and ensure that an access to sensitive data is restricted to only users with the appropriate clearance level\. For more information, see [Oracle Label Security](Oracle.Options.OLS.md)\. | September 8, 2016 | -| New feature | You can now connect to an Amazon Aurora DB cluster using the reader endpoint, which load\-balances connections across the Aurora Replicas that are available in the DB cluster\. As clients request new connections to the reader endpoint, Aurora distributes the connection requests among the Aurora Replicas in the DB cluster\. This functionality can help balance your read workload across multiple Aurora Replicas in your DB cluster\. For more information, see [Amazon Aurora endpoints](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/Aurora.Overview.Endpoints.html)\. | September 8, 2016 | -| New feature | You can now support the Oracle Enterprise Manager Cloud Control on your Amazon RDS DB instances running Oracle\. You can enable the Management Agent on your DB instances, and share data with your Oracle Management Service \(OMS\)\. For more information, see [Oracle Management Agent for Enterprise Manager Cloud Control](Oracle.Options.OEMAgent.md)\. | September 1, 2016 | -| New feature | This release adds support to get an ARN for a resource\. For more information, see [Getting an existing ARN](USER_Tagging.ARN.md#USER_Tagging.ARN.Getting)\. | August 23, 2016 | -| New feature | You can now assign up to 50 tags for each Amazon RDS resource, for managing your resources and tracking costs\. For more information, see [Tagging Amazon RDS resources](USER_Tagging.md)\. | August 19, 2016 | -| New feature | Amazon RDS now supports the License Included model for Oracle Standard Edition Two\. For more information, see [Creating an Amazon RDS DB instance](USER_CreateDBInstance.md)\. You can now change the license model of your Amazon RDS DB instances running Microsoft SQL Server and Oracle\. For more information, see [Licensing Microsoft SQL Server on Amazon RDS](SQLServer.Concepts.General.Licensing.md) and [RDS for Oracle licensing options](Oracle.Concepts.Licensing.md)\. | August 5, 2016 | -| New feature | Amazon RDS now supports native backup and restore for Microsoft SQL Server databases using full backup files \(\.bak files\)\. You can now easily migrate SQL Server databases to Amazon RDS, and import and export databases in a single, easily\-portable file, using Amazon S3 for storage, and AWS KMS for encryption\. For more information, see [Importing and exporting SQL Server databases using native backup and restore](SQLServer.Procedural.Importing.md)\. | July 27, 2016 | -| New feature | You can now copy the source files from a MySQL database to an Amazon Simple Storage Service \(Amazon S3\) bucket, and then restore an Amazon Aurora DB cluster from those files\. This option can be considerably faster than migrating data using `mysqldump`\. For more information, see [ Migrating data from an external MySQL database to an Aurora MySQL DB cluster](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/AuroraMySQL.Migrating.ExtMySQL.html)\. | July 20, 2016 | -| New feature | You can now restore an unencrypted Amazon Aurora DB cluster snapshot to create an encrypted Amazon Aurora DB cluster by including an AWS Key Management Service \(AWS KMS\) encryption key during the restore operation\. For more information, see [Encrypting Amazon RDS resources](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/Overview.Encryption.html)\. | June 30, 2016 | -| New feature | You can use the Oracle Repository Creation Utility \(RCU\) to create a repository on Amazon RDS for Oracle\. For more information, see [Using the Oracle Repository Creation Utility on RDS for Oracle ](Oracle.Resources.RCU.md)\. | June 17, 2016 | -| New feature | Adds support for PostgreSQL cross\-region read replicas\. For more information, see [Creating a read replica in a different AWS Region](USER_ReadRepl.md#USER_ReadRepl.XRgn)\. | June 16, 2016 | -| New feature | You can now use the AWS Management Console to easily add Multi\-AZ with Mirroring to a Microsoft SQL Server DB instance\. For more information, see [Adding Multi\-AZ to a Microsoft SQL Server DB instance](USER_SQLServerMultiAZ.md#USER_SQLServerMultiAZ.Adding)\. | June 9, 2016 | -| New feature | You can now use Multi\-AZ Deployments Using SQL Server Mirroring in the following additional regions: Asia Pacific \(Sydney\), Asia Pacific \(Tokyo\), and South America \(São Paulo\)\. For more information, see [Multi\-AZ deployments for Amazon RDS for Microsoft SQL Server](USER_SQLServerMultiAZ.md)\. | June 9, 2016 | -| New feature | Updated to support MariaDB version 10\.1\. For more information, see [Amazon RDS for MariaDB](CHAP_MariaDB.md)\. | June 1, 2016 | -| New feature | Updated to support Amazon Aurora cross\-region DB clusters that are read replicas\. For more information, see [Replicating Aurora MySQL DB clusters across AWS Regions](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/AuroraMySQL.Replication.CrossRegion.html)\. | June 1, 2016 | -| New feature | Enhanced Monitoring is now available for Oracle DB instances\. For more information, see [Monitoring OS metrics with Enhanced Monitoring](USER_Monitoring.OS.md) and [Modifying an Amazon RDS DB instance](Overview.DBInstance.Modifying.md)\. | May 27, 2016 | -| New feature | Updated to support manual snapshot sharing for Amazon Aurora DB cluster snapshots\. For more information, see [Sharing a DB cluster snapshot](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_ShareSnapshot.html)\. | May 18, 2016 | -| New feature | You can now use the MariaDB Audit Plugin to log database activity on MariaDB and MySQL database instances\. For more information, see [Options for MariaDB database engine](Appendix.MariaDB.Options.md) and [Options for MySQL DB instances](Appendix.MySQL.Options.md)\. | April 27, 2016 | -| New feature | In\-place, major version upgrades are now available for upgrading from MySQL version 5\.6 to version 5\.7\. For more information, see [Upgrading the MySQL DB engine](USER_UpgradeDBInstance.MySQL.md)\. | April 26, 2016 | -| New feature | Enhanced Monitoring is now available for Microsoft SQL Server DB instances\. For more information, see [Monitoring OS metrics with Enhanced Monitoring](USER_Monitoring.OS.md)\. | April 22, 2016 | -| New feature | Updated to provide an Amazon Aurora **Clusters** view in the Amazon RDS console\. For more information, see [Viewing an Aurora DB cluster](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/Aurora.Viewing.html)\. | April 1, 2016 | -| New feature | Updated to support SQL Server Multi\-AZ with mirroring in the Asia Pacific \(Seoul\) region\. For more information, see [Multi\-AZ deployments for Amazon RDS for Microsoft SQL Server](USER_SQLServerMultiAZ.md)\. | March 31, 2016 | -| New feature | Updated to support Amazon Aurora Multi\-AZ with mirroring in the Asia Pacific \(Seoul\) region\. For more information, see [ Availability for Amazon Aurora MySQL](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/Concepts.RegionsAndAvailabilityZones.html#Aurora.AuroraMySQL.Availability)\. | March 31, 2016 | -| New feature | PostgreSQL DB instances have the ability to require connections to use SSL\. For more information, see [Using SSL with a PostgreSQL DB instance](PostgreSQL.Concepts.General.SSL.md)\. | March 25, 2016 | -| New feature | Enhanced Monitoring is now available for PostgreSQL DB instances\. For more information, see [Monitoring OS metrics with Enhanced Monitoring](USER_Monitoring.OS.md)\. | March 25, 2016 | -| New feature | Microsoft SQL Server DB instances can now use Windows Authentication for user authentication\. For more information, see [Using Windows Authentication with an Amazon RDS for SQL Server DB instance](USER_SQLServerWinAuth.md)\. | March 23, 2016 | -| New feature | Enhanced Monitoring is now available in the Asia Pacific \(Seoul\) region\. For more information, see [Monitoring OS metrics with Enhanced Monitoring](USER_Monitoring.OS.md)\. | March 16, 2016 | -| New feature | You can now customize the order in which Aurora Replicas are promoted to primary instance during a failover\. For more information, see [ Fault tolerance for an Aurora DB cluster](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/Aurora.Managing.Backups.html#Aurora.Managing.FaultTolerance)\. | March 14, 2016 | -| New feature | Updated to support encryption when migrating to an Aurora DB cluster\. For more information, see [Migrating data to an Aurora DB cluster](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/Aurora.Migrate.html)\. | March 2, 2016 | -| New feature | Updated to support local time zone for Aurora DB clusters\. For more information, see [ Local time zone for Aurora DB clusters](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/Concepts.RegionsAndAvailabilityZones.html#Aurora.Overview.LocalTimeZone)\. | March 1, 2016 | -| New feature | Updated to add support for MySQL version 5\.7 for current generation Amazon RDS DB instance classes\. | February 22, 2016 | -| New feature | Updated to support *db\.r3* and *db\.t2* DB instance classes in the AWS GovCloud \(US\-West\) region\. | February 11, 2016 | -| New feature | Updated to support encrypting copies of DB snapshots and sharing encrypted DB snapshots\. For more information, see [Copying a DB snapshot](USER_CopySnapshot.md) and [Sharing a DB snapshot](USER_ShareSnapshot.md)\. | February 11, 2016 | -| New feature | Updated to support Amazon Aurora in the Asia Pacific \(Sydney\) region\. For more information, see [ Availability for Amazon Aurora MySQL](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/Concepts.RegionsAndAvailabilityZones.html#Aurora.AuroraMySQL.Availability)\. | February 11, 2016 | -| New feature | Updated to support SSL for Oracle DB Instances\. For more information, see [Using SSL with an RDS for Oracle DB instance](Oracle.Concepts.SSL.md)\. | February 9, 2016 | -| New feature | Updated to support local time zone for MySQL and MariaDB DB instances\. For more information, see [Local time zone for MySQL DB instances](MySQL.Concepts.LocalTimeZone.md) and [Local time zone for MariaDB DB instances](MariaDB.Concepts.LocalTimeZone.md)\. | December 21, 2015 | -| New feature | Updated to support Enhanced Monitoring of OS metrics for MySQL and MariaDB instances and Aurora DB clusters\. For more information, see [Viewing metrics in the Amazon RDS console](USER_Monitoring.md)\. | December 18, 2015 | -| New feature | Updated to support db\.t2, db\.r3, and db\.m4 DB instance classes for MySQL version 5\.5\. For more information, see [DB instance classes](Concepts.DBInstanceClass.md)\. | December 4, 2015 | -| New feature | Updated to support modifying the database port for an existing DB instance\. | December 3, 2015 | -| New feature | Updated to support major version upgrades of the database engine for PostgreSQL instances\. For more information, see [Upgrading the PostgreSQL DB engine for Amazon RDS](USER_UpgradeDBInstance.PostgreSQL.md)\. | November 19, 2015 | -| New feature | Updated to support modifying the public accessibility of an existing DB instance\. Updated to support db\.m4 standard DB instance classes\. | November 11, 2015 | -| New feature | Updated to support manual DB snapshot sharing\. For more information, see [Sharing a DB snapshot](USER_ShareSnapshot.md)\. | October 28, 2015 | -| New feature | Updated to support Microsoft SQL Server 2014 for the Web, Express, and Standard editions\. | October 26, 2015 | -| New feature | Updated to support the MySQL\-based MariaDB database engine\. For more information, see [Amazon RDS for MariaDB](CHAP_MariaDB.md)\. | October 7, 2015 | -| New feature | Updated to support Amazon Aurora in the Asia Pacific \(Tokyo\) region\. For more information, see [ Availability for Amazon Aurora MySQL](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/Concepts.RegionsAndAvailabilityZones.html#Aurora.AuroraMySQL.Availability)\. | October 7, 2015 | -| New feature | Updated to support db\.t2 burst\-capable DB instance classes for all DB engines and the addition of the db\.t2\.large DB instance class\. For more information, see [DB instance classes](Concepts.DBInstanceClass.md)\. | September 25, 2015 | -| New feature | Updated to support Oracle DB instances on R3 and T2 DB instance classes\. For more information, see [DB instance classes](Concepts.DBInstanceClass.md)\. | August 5, 2015 | -| New feature | Microsoft SQL Server Enterprise Edition is now available with the License Included service model\. For more information, see [Licensing Microsoft SQL Server on Amazon RDS](SQLServer.Concepts.General.Licensing.md)\. | July 29, 2015 | -| New feature | Amazon Aurora has officially released\. The Amazon Aurora DB engine supports multiple DB instances in a DB cluster\. For detailed information, see [ What is Amazon Aurora?](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/CHAP_AuroraOverview.html)\. | July 27, 2015 | -| New feature | Updated to support copying tags to DB snapshots\. | July 20, 2015 | -| New feature | Updated to support increases in storage size for all DB engines and an increase in Provisioned IOPS for SQL Server\. | June 18, 2015 | -| New feature | Updated options for reserved DB instances\. | June 15, 2015 | -| New feature | Updated to support using Amazon CloudHSM with Oracle DB instances using TDE\. | January 8, 2015 | -| New feature | Updated to support encrypting data at rest and new API version 2014\-10\-31\. | January 6, 2015 | -| New feature | Updated to include the new Amazon DB engine: Aurora\. The Amazon Aurora DB engine supports multiple DB instances in a DB cluster\. Amazon Aurora is currently in preview release and is subject to change\. For detailed information, see [ What is Amazon Aurora?](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/CHAP_AuroraOverview.html)\. | November 12, 2014 | -| New feature | Updated to support PostgreSQL read replicas\. | November 10, 2014 | -| New API and features | Updated to support the GP2 storage type and new API version 2014\-09\-01\. Updated to support the ability to copy an existing option or parameter group to create a new option or parameter group\. | October 7, 2014 | -| New feature | Updated to support InnoDB Cache Warming for DB instances running MySQL version 5\.6\.19 and later\. | September 3, 2014 | -| New feature | Updated to support SSL certificate verification when connecting to MySQL version 5\.6, SQL Server, and PostgreSQL database engines\. | August 5, 2014 | -| New feature | Updated to support the db\.t2 burstable DB instance classes\. | August 4, 2014 | -| New feature | Updated to support the db\.r3 memory optimized DB instance classes for use with the MySQL \(version 5\.6\), SQL Server, and PostgreSQL database engines\. | May 28, 2014 | -| New feature | Updated to support SQL Server Multi\-AZ deployments using SQL Server Mirroring\. | May 19, 2014 | -| New feature | Updated to support upgrades from MySQL version 5\.5 to version 5\.6\. | April 23, 2014 | -| New feature | Updated to support Oracle GoldenGate\. | April 3, 2014 | -| New feature | Updated to support the M3 DB instance classes\. | February 20, 2014 | -| New feature | Updated to support the Oracle Timezone option\. | January 13, 2014 | -| New feature | Updated to support replication between MySQL DB instances in different regions\. | November 26, 2013 | -| New feature | Updated to support the PostgreSQL DB engine\. | November 14, 2013 | -| New feature | Updated to support SQL Server transparent data encryption \(TDE\)\. | November 7, 2013 | -| New API and new feature | Updated to support cross region DB snapshot copies; new API version, 2013\-09\-09\. | October 31, 2013 | -| New features | Updated to support Oracle Statspack\. | September 26, 2013 | -| New features | Updated to support using replication to import or export data between instances of MySQL running in Amazon RDS and instances of MySQL running on\-premises or on Amazon EC2\. | September 5, 2013 | -| New features | Updated to support the db\.cr1\.8xlarge DB instance class for MySQL 5\.6\. | September 4, 2013 | -| New feature | Updated to support replication of read replicas\. | August 28, 2013 | -| New feature | Updated to support parallel read replica creation\. | July 22, 2013 | -| New feature | Updated to support fine\-grained permissions and tagging for all Amazon RDS resources\. | July 8, 2013 | -| New feature | Updated to support MySQL 5\.6 for new instances, including support for the MySQL 5\.6 memcached interface and binary log access\. | July 1, 2013 | -| New feature | Updated to support major version upgrades from MySQL 5\.1 to MySQL 5\.5\. | June 20, 2013 | -| New feature | Updated DB parameter groups to allow expressions for parameter values\. | June 20, 2013 | -| New API and new feature | Updated to support read replica status; new API version, 2013\-05\-15\. | May 23, 2013 | -| New features | Updated to support Oracle Advanced Security features for native network encryption and Oracle Transparent Data Encryption\. | April 18, 2013 | -| New features | Updated to support major version upgrades for SQL Server and additional functionality for Provisioned IOPS\. | March 13, 2013 | -| New feature | Updated to support VPC By Default for RDS\. | March 11, 2013 | -| New API and feature | Updated to support log access; new API version 2013\-02\-12 | March 4, 2013 | -| New feature | Updated to support RDS event notification subscriptions\. | February 4, 2013 | -| New API and feature | Updated to support DB instance renaming and the migration of DB security group members in a VPC to a VPC security group\. | January 14, 2013 | -| New feature | Updated for AWS GovCloud \(US\-West\) support\. | December 17, 2012 | -| New feature | Updated to support m1\.medium and m1\.xlarge DB Instance classes\. | November 6, 2012 | -| New feature | Updated to support read replica promotion\. | October 11, 2012 | -| New feature | Updated to support SSL in Microsoft SQL Server DB Instances\. | October 10, 2012 | -| New feature | Updated to support Oracle micro DB Instances\. | September 27, 2012 | -| New feature | Updated to support SQL Server 2012\. | September 26, 2012 | -| New API and feature | Updated to support provisioned IOPS\. API version 2012\-09\-17\. | September 25, 2012 | -| New features | Updated for SQL Server support for DB Instances in VPC and Oracle support for Data Pump\. | September 13, 2012 | -| New feature | Updated for support for SQL Server Agent\. | August 22, 2012 | -| New feature | Updated for support for tagging of DB Instances\. | August 21, 2012 | -| New features | Updated for support for Oracle APEX and XML DB, Oracle time zones, and Oracle DB Instances in a VPC\. | August 16, 2012 | -| New features | Updated for support for SQL Server Database Engine Tuning Advisor and Oracle DB Instances in VPC\. | July 18, 2012 | -| New feature | Updated for support for option groups and first option, Oracle Enterprise Manager Database Control\. | May 29, 2012 | -| New feature | Updated for support for read replicas in Amazon Virtual Private Cloud\. | May 17, 2012 | -| New feature | Updated for Microsoft SQL Server support\. | May 8, 2012 | -| New features | Updated for support for forced failover, Multi\-AZ deployment of Oracle DB Instances, and nondefault character sets for Oracle DB Instances\. | May 2, 2012 | -| New feature | Updated for Amazon Virtual Private Cloud \(VPC\) Support\. | February 13, 2012 | -| Updated content | Updated for new Reserved Instance types\. | December 19, 2011 | -| New feature | Updated for Oracle engine support\. | May 23, 2011 | -| Updated content | Console updates\. | May 13, 2011 | -| Updated content | Edited content for shortened backup and maintenance windows\. | February 28, 2011 | -| New feature | Added support for MySQL 5\.5\. | January 31, 2011 | -| New feature | Added support for read replicas\. | October 4, 2010 | -| New feature | Added support for AWS Identity and Access Management \(IAM\)\. | September 2, 2010 | -| New feature | Added DB Engine Version Management\. | August 16, 2010 | -| New feature | Added Reserved DB Instances\. | August 16, 2010 | -| New Feature | Amazon RDS now supports SSL connections to your DB Instances\. | June 28, 2010 | -| New Guide | This is the first release of the Amazon RDS User Guide\. | June 7, 2010 | \ No newline at end of file diff --git a/doc_source/accessing-monitoring.md b/doc_source/accessing-monitoring.md deleted file mode 100644 index a0581be..0000000 --- a/doc_source/accessing-monitoring.md +++ /dev/null @@ -1,167 +0,0 @@ -# Viewing instance status and recommendations - -Using the Amazon RDS console, you can quickly access the status of your DB instance and respond to Amazon RDS recommendations\. - -**Topics** -+ [Viewing Amazon RDS DB instance status](#Overview.DBInstance.Status) -+ [Viewing Amazon RDS recommendations](#USER_Recommendations) - -## Viewing Amazon RDS DB instance status - -The status of a DB instance indicates the health of the DB instance\. You can use the following procedures to view the DB instance status in the Amazon RDS console, the AWS CLI command, or the API operation\. - -**Note** -Amazon RDS also uses another status called *maintenance status*, which is shown in the **Maintenance** column of the Amazon RDS console\. This value indicates the status of any maintenance patches that need to be applied to a DB instance\. Maintenance status is independent of DB instance status\. For more information about maintenance status, see [Applying updates for a DB instance](USER_UpgradeDBInstance.Maintenance.md#USER_UpgradeDBInstance.OSUpgrades)\. - -Find the possible status values for DB instances in the following table\. This table also shows whether you will be billed for the DB instance and storage, billed only for storage, or not billed\. For all DB instance statuses, you are always billed for backup usage\. - - -| DB instance status | Billed | Description | -| --- | --- | --- | -| **Available** | Billed | The DB instance is healthy and available\. | -| **Backing\-up** | Billed | The DB instance is currently being backed up\. | -| **Configuring\-enhanced\-monitoring** | Billed | Enhanced Monitoring is being enabled or disabled for this DB instance\. | -| **Configuring\-iam\-database\-auth** | Billed | AWS Identity and Access Management \(IAM\) database authentication is being enabled or disabled for this DB instance\. | -| **Configuring\-log\-exports** | Billed | Publishing log files to Amazon CloudWatch Logs is being enabled or disabled for this DB instance\. | -| **Converting\-to\-vpc** | Billed | The DB instance is being converted from a DB instance that is not in an Amazon Virtual Private Cloud \(Amazon VPC\) to a DB instance that is in an Amazon VPC\. | -| **Creating** | Not billed | The DB instance is being created\. The DB instance is inaccessible while it is being created\. | -| **Delete\-precheck** | Not billed | Amazon RDS is validating that read replicas are healthy and are safe to delete\. | -| **Deleting** | Not billed | The DB instance is being deleted\. | -| **Failed** | Not billed | The DB instance has failed and Amazon RDS can't recover it\. Perform a point\-in\-time restore to the latest restorable time of the DB instance to recover the data\. | -| **Inaccessible\-encryption\-credentials** | Not billed | The AWS KMS key used to encrypt or decrypt the DB instance can't be accessed or recovered\. | -| **Inaccessible\-encryption\-credentials\-recoverable** | Billed for storage | The KMS key used to encrypt or decrypt the DB instance can't be accessed\. However, if the KMS key is active, restarting the DB instance can recover it\. For more information, see [Encrypting a DB instance](Overview.Encryption.md#Overview.Encryption.Enabling)\. | -| **Incompatible\-network** | Not billed | Amazon RDS is attempting to perform a recovery action on a DB instance but can't do so because the VPC is in a state that prevents the action from being completed\. This status can occur if, for example, all available IP addresses in a subnet are in use and Amazon RDS can't get an IP address for the DB instance\. | -| **Incompatible\-option\-group** | Billed | Amazon RDS attempted to apply an option group change but can't do so, and Amazon RDS can't roll back to the previous option group state\. For more information, check the **Recent Events** list for the DB instance\. This status can occur if, for example, the option group contains an option such as TDE and the DB instance doesn't contain encrypted information\. | -| **Incompatible\-parameters** | Billed | Amazon RDS can't start the DB instance because the parameters specified in the DB instance's DB parameter group aren't compatible with the DB instance\. Revert the parameter changes or make them compatible with the DB instance to regain access to your DB instance\. For more information about the incompatible parameters, check the **Recent Events** list for the DB instance\. | -| **Incompatible\-restore** | Not billed | Amazon RDS can't do a point\-in\-time restore\. Common causes for this status include using temp tables, using MyISAM tables with MySQL, or using Aria tables with MariaDB\. | -| Insufficient\-capacity | Not billed | Amazon RDS can’t create your instance because sufficient capacity isn’t currently available\. To create your DB instance in the same AZ with the same instance type, delete your DB instance, wait a few hours, and try to create again\. Alternatively, create a new instance using a different instance class or AZ\. | -| **Maintenance** | Billed | Amazon RDS is applying a maintenance update to the DB instance\. This status is used for instance\-level maintenance that RDS schedules well in advance\. | -| **Modifying** | Billed | The DB instance is being modified because of a customer request to modify the DB instance\. | -| **Moving\-to\-vpc** | Billed | The DB instance is being moved to a new Amazon Virtual Private Cloud \(Amazon VPC\)\. | -| **Rebooting** | Billed | The DB instance is being rebooted because of a customer request or an Amazon RDS process that requires the rebooting of the DB instance\. | -| **Resetting\-master\-credentials** | Billed | The master credentials for the DB instance are being reset because of a customer request to reset them\. | -| **Renaming** | Billed | The DB instance is being renamed because of a customer request to rename it\. | -| **Restore\-error** | Billed | The DB instance encountered an error attempting to restore to a point\-in\-time or from a snapshot\. | -| **Starting** | Billed for storage | The DB instance is starting\. | -| **Stopped** | Billed for storage | The DB instance is stopped\. | -| **Stopping** | Billed for storage | The DB instance is being stopped\. | -| **Storage\-full** | Billed | The DB instance has reached its storage capacity allocation\. This is a critical status, and we recommend that you fix this issue immediately\. To do so, scale up your storage by modifying the DB instance\. To avoid this situation, set Amazon CloudWatch alarms to warn you when storage space is getting low\. | -| **Storage\-optimization** | Billed | Amazon RDS is optimizing the storage of your DB instance\. The DB instance is fully operational\. The storage optimization process is usually short, but can sometimes take up to and even beyond 24 hours\. | -| **Upgrading** | Billed | The database engine version is being upgraded\. | - -### Console - -**To view the status of a DB instance** - -1. Sign in to the AWS Management Console and open the Amazon RDS console at [https://console\.aws\.amazon\.com/rds/](https://console.aws.amazon.com/rds/)\. - -1. In the navigation pane, choose **Databases**\. - - The **Databases page** appears with the list of DB instances\. For each DB instance , the status value is displayed\. -![\[View the status of a DB instance\]](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/images/RDS_instance_status.png) - -### CLI - -To view DB instance and its status information by using the AWS CLI, use the [describe\-db\-instances](https://docs.aws.amazon.com/cli/latest/reference/rds/describe-db-instances.html) command\. For example, the following AWS CLI command lists all the DB instances information \. - -``` -aws rds describe-db-instances -``` - -To view a specific DB instance and its status, call the [describe\-db\-instances](https://docs.aws.amazon.com/cli/latest/reference/rds/describe-db-instances.html) command with the following option: -+ `DBInstanceIdentifier` – The name of the DB instance\. - -``` -aws rds describe-db-instances --db-instance-identifier mydbinstance -``` - -To view just the status of all the DB instances, use the following query in AWS CLI\. - -``` -aws rds describe-db-instances --query 'DBInstances[*].[DBInstanceIdentifier,DBInstanceStatus]' --output table -``` - -### API - -To view the status of the DB instance using the Amazon RDS API, call the [DescribeDBInstances](https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_DescribeDBInstances.html) operation\. - -## Viewing Amazon RDS recommendations - -Amazon RDS provides automated recommendations for database resources, such as DB instances, read replicas, and DB parameter groups\. These recommendations provide best practice guidance by analyzing DB instance configuration, usage, and performance data\. - -You can find examples of these recommendations in the following table\. - - -| Type | Description | Recommendation | Additional information | -| --- | --- | --- | --- | -| DB instance isn't a Multi\-AZ DB instance | Your DB instance isn't using the Multi\-AZ deployment\. | We recommend that you use Multi\-AZ deployment\. The Multi\-AZ deployments enhance the availability and durability of the DB instance\. For information about Amazon RDS Multi\-AZ pricing, see [Pricing](https://aws.amazon.com/rds/features/multi-az/#Pricing)\. | [ Amazon RDS Multi\-AZ](https://aws.amazon.com/rds/features/multi-az/) | -| | Your DB cluster has all the reader instances in the same Availability Zone\. | We recommend that you distribute the Reader instances across multiple Availability Zones\. Distribution increases the availability of the database, and improves the response time by reducing network latency between clients and database\. | | -| Storage autoscaling isn't turned on | Your DB instance doesn't have Amazon RDS storage autoscaling turned on\. Storage autoscaling automatically scales the storage capacity when there is an increase in the database size, with zero downtime\. | We recommend that you turn on the storage autoscaling with a maximum allocated storage of `{{MaxAllocatedStorage}}` GB for your DB instance `{{DBInstanceIdentifier}}`\. | [Managing capacity automatically with Amazon RDS storage autoscaling](USER_PIOPS.StorageTypes.md#USER_PIOPS.Autoscaling) | -| Engine version outdated | Your DB instance is not running the latest minor engine version\. | We recommend that you upgrade to the latest version because it contains the latest security fixes and other improvements\. | [Upgrading a DB instance engine version](USER_UpgradeDBInstance.Upgrading.md) | -| Pending maintenance available | You have pending maintenance available on your DB instance\. | We recommend that you perform the pending maintenance available on your DB instance\. Updates to the operating system most often occur for security issues and should be done as soon as possible\. | [Maintaining a DB instance](USER_UpgradeDBInstance.Maintenance.md) | -| Automated backups disabled | Your DB instance has automated backups disabled\. | We recommend that you enable automated backups on your DB instance\. Automated backups enable point\-in\-time recovery of your DB instance\. You receive backup storage up to the storage size of your DB instance at no additional charge\. | [Working with backups](USER_WorkingWithAutomatedBackups.md) | -| Magnetic volumes in use | Your DB instance is using magnetic storage\. | Magnetic storage is not recommended for most DB instances\. We recommend switching to General Purpose \(SSD\) storage or provisioned IOPS storage\. | [Amazon RDS DB instance storage](CHAP_Storage.md) | -| Enhanced Monitoring disabled | Your DB instance doesn't have Enhanced Monitoring enabled\. | We recommend enabling Enhanced Monitoring\. Enhanced Monitoring provides real\-time operating system metrics for monitoring and troubleshooting\. | [Monitoring OS metrics with Enhanced Monitoring](USER_Monitoring.OS.md) | -| Performance Insights disabled | Your DB instance doesn't have Performance Insights enabled\. | We recommend enabling Performance Insights\. Performance Insights monitors your database load for better analysis and troubleshooting\. | [Overview of Performance Insights on Amazon RDS](USER_PerfInsights.Overview.md) | -| Encryption disabled | Your DB instance doesn't have encryption enabled\. | We recommend enabling encryption\. You can encrypt your existing Amazon RDS DB instances by restoring from an encrypted snapshot\. | [Encrypting Amazon RDS resources](Overview.Encryption.md) | -| Previous generation DB instance class in use | Your DB instance is running on a previous\-generation DB instance class\. | Previous\-generation DB instance classes have been replaced by DB instance classes with better price, better performance, or both\. We recommend running your DB instance on a later generation DB instance class\. | [DB instance classes](Concepts.DBInstanceClass.md) | -| Huge pages not used for an Oracle DB instance | The `use_large_pages` parameter is not set to `ONLY` in the DB parameter group used by your DB instance\. | For increased database scalability, we recommend setting `use_large_pages` to `ONLY` in the DB parameter group used by your DB instance\. | [Turning on HugePages for an RDS for Oracle instance](Oracle.Concepts.HugePages.md) | -| Nondefault custom memory parameters | Your DB parameter group sets memory parameters that diverge too much from the default values\. | Settings that diverge too much from the default values can cause poor performance and errors\. We recommend setting custom memory parameters to their default values in the DB parameter group used by the DB instance\. | [Working with parameter groups](USER_WorkingWithParamGroups.md) | -| Found an unsafe durability parameter value for a MySQL DB instance | Your DB instance has an unsafe value for the `innodb_flush_log_at_trx_commit` parameter\. This parameter controls the persistence of commit operations to disk\. | We recommend that you set the value of the `innodb_flush_log_at_trx_commit` parameter to `1`\. The current value might improve performance but transactions can be lost if the database crashes\. | [ Best practices for configuring parameters for Amazon RDS for MySQL, part 1: Parameters related to performance](http://aws.amazon.com/blogs/database/best-practices-for-configuring-parameters-for-amazon-rds-for-mysql-part-1-parameters-related-to-performance/) on the AWS Database Blog | -| Optimizer statistics aren't persisted to the disk for a MySQL DB instance | Your DB instance isn't configured to persist the InnoDB statistics to the disk\. When it isn't configured, the statistics may recalculate frequently, which leads to variations in query execution plan\. You can modify the value of this global parameter at the table level\. | Global statistics persistence is disabled\. We recommend that you set the `innodb_stats_persistent` parameter to `ON`\. | [ Best practices for configuring parameters for Amazon RDS for MySQL, part 1: Parameters related to performance](http://aws.amazon.com/blogs/database/best-practices-for-configuring-parameters-for-amazon-rds-for-mysql-part-1-parameters-related-to-performance/) on the AWS Database Blog | -| General logging is enabled for a MySQL DB instance | Your DB instance has the general logging turned on\. Turning on general logging increases the amount of I/O operations and allocated storage space,which can lead to contention and performance degradation\. | Evaluate your required general logging usage\. General logging can increase the amount of I/O operations and allocated storage space, and lead to contention and performance degradation\. | [Managing table\-based MySQL logs](Appendix.MySQL.CommonDBATasks.Logs.md) | -| Maximum InnoDB open files setting is misconfigured for a MySQL DB instance | Your DB instance has a low value for the maximum number of files InnoDB can open at one time\. | We recommend that you set the `innodb_open_files` parameter to a minimum value of `65`\. | [innodb\_open\_files](https://dev.mysql.com/doc/refman/5.7/en/innodb-parameters.html#sysvar_innodb_open_files) | -| Number of allowed simultaneous connections for a given database user is misconfigured for a MySQL DB instance | Your DB instance has a low value for the maximum number of simultaneous connections for each database account\. | We recommend that you increase the setting of the `max_user_connections` parameter to a number greater than 5\. The current `max_user_connections` value is low which impacts the database health checks and regular operations\. | [Setting Account Resource Limits](https://dev.mysql.com/doc/refman/8.0/en/user-resources.html) | -| Read replica is open in writable mode for a MySQL DB instance | Your DB instance has the Read replica in writable mode, which allows updates from clients\. | We recommend that you don't change MySQL read replicas to writable mode for a long duration\. This setting can cause replication errors and data consistency issues\. | [ Best practices for configuring parameters for Amazon RDS for MySQL, part 2: Parameters related to replication](http://aws.amazon.com/blogs/database/best-practices-for-configuring-parameters-for-amazon-rds-for-mysql-part-2-parameters-related-to-replication/) on the AWS Database Blog | -| Found an unsafe durability parameter value for a MySQL DB instance | The synchronization of the binary log to disk isn't enforced before the acknowledgement of the transactions commit in your DB instance\. | We recommend that you set the `sync_binlog` parameter to `1`\. Currently, the synchronization of the binary log to disk isn't enforced before acknowledgement of the transactions commit\. If there is a power failure or the operating system crashes, the committed transactions can be lost\. | [ Best practices for configuring parameters for Amazon RDS for MySQL, part 2: Parameters related to replication](http://aws.amazon.com/blogs/database/best-practices-for-configuring-parameters-for-amazon-rds-for-mysql-part-2-parameters-related-to-replication/) on the AWS Database Blog | -| Found an unsafe setting of the `innodb_default_row_format` parameter for a MySQL DB instance | Your DB instance has the the following known issue: A table created in a MySQL version lower than 8\.0\.26 with row\_format COMPACT or REDUNDANT will be inaccessible and unrecoverable when the index exceeds 767 bytes\. | We recommend that you change the current value of the `innodb_default_row_format` parameter to `DYNAMIC`\. | [Changes in MySQL 8\.0\.26 \(2021\-07\-20, General Availability\)](https://dev.mysql.com/doc/relnotes/mysql/8.0/en/news-8-0-26.html) | -| Change buffering enabled for a MySQL DB instance | Your DB parameter group has change buffering enabled\. | Change buffering allows a MySQL DB instance to defer some writes necessary to maintain secondary indexes\. This configuration can improve performance slightly, but it can create a large delay in crash recovery\. During crash recovery, the secondary index must be brought up to date\. So, the benefits of change buffering are outweighed by the potentially very long crash recovery events\. We recommend disabling change buffering\. | [ Best practices for configuring parameters for Amazon RDS for MySQL, part 1: Parameters related to performance](http://aws.amazon.com/blogs/database/best-practices-for-configuring-parameters-for-amazon-rds-for-mysql-part-1-parameters-related-to-performance/) on the AWS Database Blog | -| Query cache enabled for a MySQL DB instance | Your DB parameter group has query cache parameter enabled\. | The query cache can cause the DB instance to appear to stall when changes require the cache to be purged\. Most workloads don't benefit from a query cache\. The query cache was removed from MySQL version 8\.0\. We recommend that you disable the query cache parameter\. | [ Best practices for configuring parameters for Amazon RDS for MySQL, part 1: Parameters related to performance](http://aws.amazon.com/blogs/database/best-practices-for-configuring-parameters-for-amazon-rds-for-mysql-part-1-parameters-related-to-performance/) on the AWS Database Blog | -| Autovacuum is disabled for a PostgreSQL DB instance | Your DB instance has autovacuum turned off\. Turning off autovacuum increases table and index bloat and impacts performance\. | We recommend that you set the autovacuum parameter to on\. | [Understanding autovacuum in Amazon RDS for PostgreSQL environments](https://aws.amazon.com/blogs/database/understanding-autovacuum-in-amazon-rds-for-postgresql-environments/) | -| Synchronous commit is turned off for a PostgreSQL DB instance | When the `synchronous_commit` parameter is set to `OFF`, it causes data loss when the database crashes, which can impact the durability of the database\. | We recommend that you turn on the `synchronous_commit` parameter\. | [Asynchronous Commit](https://www.postgresql.org/docs/current/wal-async-commit.html) | -| `track_counts` parameter is disabled for a PostgreSQL DB instance | If the track\_counts parameter is turned off, the database doesn't collect the database activity statistics\. Autovacuum requires these statistics to work correctly\. | We recommend that you set `track_counts` parameter to `ON`\. | [track\_counts \(boolean\)](https://www.postgresql.org/docs/current/runtime-config-statistics.html#GUC-TRACK-COUNTS) | -| Index only scan plan type is disabled for a PostgreSQL DB instance | The query planner or optimizer can't use the index only scan plan when it is disabled\. | We recommend that you set the parameter `enable_indexonlyscan` to `ON`\. | [enable\_indexonlyscan \(boolean\)](https://www.postgresql.org/docs/current/runtime-config-query.html#GUC-ENABLE-INDEXONLYSCAN) | -| index\-scan plan type is disabled for a PostgreSQL DB instance | The query planner or optimizer can't use the index scan plan types when it is disabled\. | We recommend that you set the parameter `enable_indexscan` to `ON`\. | [enable\_indexscan \(boolean\) ](https://www.postgresql.org/docs/current/runtime-config-query.html#GUC-ENABLE-INDEXSCAN) | -| Logging to table | Your DB parameter group sets logging output to `TABLE`\. | Setting logging output to `TABLE` uses more storage than setting this parameter to `FILE`\. To avoid reaching the storage limit, we recommend setting the logging output parameter to `FILE`\. | [MySQL database log files](USER_LogAccess.Concepts.MySQL.md) | - -Amazon RDS generates recommendations for a resource when the resource is created or modified\. Amazon RDS also periodically scans your resources and generates recommendations\. - -### - -**To view Amazon RDS recommendations** - -1. Sign in to the AWS Management Console and open the Amazon RDS console at [https://console\.aws\.amazon\.com/rds/](https://console.aws.amazon.com/rds/)\. - -1. In the navigation pane, choose **Recommendations**\. -![\[Select Recommendations in the console\]](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/images/recommendations-select.png) - - The Recommendations page appears\. -![\[Main Recommendations page in the console\]](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/images/recommendations-main.png) - -1. On the **Recommendations** page, choose one of the following: - + **Active** – Shows the current recommendations that you can apply, dismiss, or schedule\. - + **Dismissed** – Shows the recommendations that have been dismissed\. When you choose **Dismissed**, you can apply these dismissed recommendations\. - + **Scheduled** – Shows the recommendations that are scheduled but not yet applied\. These recommendations will be applied in the next scheduled maintenance window\. - + **Applied** – Shows the recommendations that are currently applied\. - - From any list of recommendations, you can open a section to view the recommendations in that section\. -![\[Take action on recommendations in the console\]](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/images/recommendations-active.png) - - To configure preferences for displaying recommendations in each section, choose the **Preferences** icon\. -![\[Preferences icon for Recommendations in the console\]](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/images/recommendations-preferences.png) - - From the **Preferences** window that appears, you can set display options\. These options include the visible columns and the number of recommendations to display on the page\. - -1. \(optional\) Respond to your active recommendations as follows: - - 1. Choose **Active** and open one or more sections to view the recommendations in them\. - - 1. Choose one or more recommendations and choose **Apply now** \(to apply them immediately\), **Schedule** \(to apply them in next maintenance window\), or **Dismiss**\. - - If the **Apply now** button appears for a recommendation but is unavailable \(grayed out\), the DB instance is not available\. You can apply recommendations immediately only if the DB instance status is **available**\. For example, you can't apply recommendations immediately to the DB instance if its status is **modifying**\. In this case, wait for the DB instance to be available and then apply the recommendation\. - - If the **Apply now** button doesn't appear for a recommendation, you can't apply the recommendation using the **Recommendations** page\. You can modify the DB instance to apply the recommendation manually\. - - For more information about modifying a DB instance, see [Modifying an Amazon RDS DB instance](Overview.DBInstance.Modifying.md)\. -**Note** -When you choose **Apply now**, a brief DB instance outage might result\. \ No newline at end of file diff --git a/doc_source/blue-green-deployments-creating.md b/doc_source/blue-green-deployments-creating.md deleted file mode 100644 index 9ecd6d3..0000000 --- a/doc_source/blue-green-deployments-creating.md +++ /dev/null @@ -1,104 +0,0 @@ -# Creating a blue/green deployment - -When you create a blue/green deployment, you specify the DB instance to copy in the deployment\. The DB instance you choose is the production DB instance, and it becomes the primary DB instance in the blue environment\. This DB instance is copied to the green environment, and RDS configures replication from the DB instance in the blue environment to the DB instance in the green environment\. - -RDS copies the blue environment's topology to a staging area, along with its configured features\. When the blue DB instance has read replicas, the read replicas are copied as read replicas of the green DB instance in the deployment\. If the blue DB instance is a Multi\-AZ DB instance deployment, then the green DB instance is created as a Multi\-AZ DB instance deployment\. - -**Topics** -+ [Making changes in the green environment](#blue-green-deployments-creating-changes) -+ [Handling lazy loading when you create a blue/green deployment](#blue-green-deployments-creating-lazy-loading) -+ [Creating the blue/green deployment](#blue-green-deployments-creating-create) - -## Making changes in the green environment - -You can make the following changes to the DB instance in the green environment when you create the blue/green deployment: -+ You can specify a higher engine version if you want to test a DB engine upgrade\. -+ You can specify a DB parameter group that is different from the one used by the DB instance in the blue environment\. You can test how parameter changes affect the DB instances in the green environment or specify a parameter group for a new major DB engine version in the case of an upgrade\. - - If you specify a different DB parameter group, the specified DB parameter group is associated with all of the DB instances in the green environment\. If you don't specify a different parameter group, each DB instance in the green environment is associated with the parameter group of its corresponding blue DB instance\. - -You can make other modifications to the DB instance in the green environment after it is deployed\. For example, you might make schema changes to your database or change the DB instance class used by one or more DB instances in the green environment\. - -For information about modifying a DB instance, see [Modifying an Amazon RDS DB instance](Overview.DBInstance.Modifying.md)\. - -## Handling lazy loading when you create a blue/green deployment - -When you create a blue/green deployment, Amazon RDS creates the primary DB instance in the green environment by restoring from a DB snapshot\. After it is created, the green DB instance continues to load data in the background, which is known as *lazy loading*\. If the DB instance has read replicas, these are also created from DB snapshots and are subject to lazy loading\. - -If you access data that hasn't been loaded yet, the DB instance immediately downloads the requested data from Amazon S3, and then continues loading the rest of the data in the background\. For more information, see [Amazon EBS snapshots](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/EBSSnapshots.html)\. - -To help mitigate the effects of lazy loading on tables to which you require quick access, you can perform operations that involve full\-table scans, such as `SELECT *`\. This operation allows Amazon RDS to download all of the backed\-up table data from S3\. - -If an application attempts to access data that isn't loaded, the application can encounter higher latency than normal while the data is loaded\. This higher latency due to lazy loading could lead to poor performance for latency\-sensitive workloads\. - -**Important** -If you switch over a blue/green deployment before data loading is complete, your application could experience performance issues due to high latency\. - -## Creating the blue/green deployment - -You can create the blue/green deployment using the AWS Management Console, the AWS CLI, or the RDS API\. - -### Console - -**To create a blue/green deployment** - -1. Sign in to the AWS Management Console and open the Amazon RDS console at [https://console\.aws\.amazon\.com/rds/](https://console.aws.amazon.com/rds/)\. - -1. In the navigation pane, choose **Databases**, and then choose the DB instance that you want to copy to a green environment\. - -1. For **Actions**, choose **Create Blue/Green Deployment**\. - - The **Create Blue/Green Deployment** page appears\. -![\[Create blue/green deployment\]](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/images/blue-green-deployment-create.png) - -1. On the **Create Blue/Green Deployment** page, review the blue database identifiers\. Make sure they match the DB instances that you expect in the blue environment\. If they don't, choose **Cancel**\. - -1. For **Blue/Green Deployment identifier**, enter a name for your blue/green deployment\. - -1. \(Optional\) For **Blue/Green Deployment settings**, specify the settings for the green environment: - + Choose a DB engine version if you want to test a DB engine version upgrade\. - + Choose a DB parameter group to associate with the DB instances in the green environment\. - - You can make other modifications to the databases in the green environment after it is deployed\. - -1. Choose **Create Blue/Green Deployment**\. - -### AWS CLI - -To create a blue/green deployment by using the AWS CLI, use the [create\-blue\-green\-deployment](https://docs.aws.amazon.com/cli/latest/reference/rds/create-blue-green-deployment.html) command with the following options: -+ `--blue-green-deployment-name` – Specify the name of the blue/green deployment\. -+ `--source` – Specify the ARN of the DB instance that you want to copy\. -+ `--target-engine-version` – Specify an engine version if you want to test a DB engine version upgrade in the green environment\. This option upgrades the DB instances in the green environment to the specified DB engine version\. - - If not specified, each DB instance in the green environment is created with the same engine version as the corresponding DB instance in the blue environment\. -+ `--target-db-parameter-group-name` – Specify a DB parameter group to associate with the DB instances in the green environment\. - -**Example Create a blue/green deployment** -For Linux, macOS, or Unix: - -``` -aws rds create-blue-green-deployment \ - --blue-green-deployment-name my-blue-green-deployment \ - --source arn:aws:rds:us-east-2:123456789012:db:mydb1 \ - --target-engine-version 8.0.31 \ - --target-db-parameter-group-name mydbparametergroup -``` -For Windows: - -``` -aws rds create-blue-green-deployment ^ - --blue-green-deployment-name my-blue-green-deployment ^ - --source arn:aws:rds:us-east-2:123456789012:db:mydb1 ^ - --target-engine-version 8.0.31 ^ - --target-db-parameter-group-name mydbparametergroup -``` - -### RDS API - -To create a blue/green deployment by using the Amazon RDS API, use the [https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_CreateBlueGreenDeployment.html](https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_CreateBlueGreenDeployment.html) operation with the following parameters: -+ `BlueGreenDeploymentName` – Specify the name of the blue/green deployment\. -+ `Source` – Specify the ARN of the DB instance that you want to copy to the green environment\. -+ `TargetEngineVersion` – Specify an engine version if you want to test a DB engine version upgrade in the green environment\. This option upgrades the DB instances in the green environment to the specified DB engine version\. - - If not specified, each DB instance in the green environment is created with the same engine version as the corresponding DB instance in the blue environment\. -+ `TargetDBParameterGroupName` – Specify a DB parameter group to associate with the DB instances in the green environment\. \ No newline at end of file diff --git a/doc_source/blue-green-deployments-deleting.md b/doc_source/blue-green-deployments-deleting.md deleted file mode 100644 index 5b32e08..0000000 --- a/doc_source/blue-green-deployments-deleting.md +++ /dev/null @@ -1,78 +0,0 @@ -# Deleting a blue/green deployment - -You can delete a blue/green deployment before or after you switch it over\. - -When you delete a blue/green deployment before switching it over, Amazon RDS optionally deletes the DB instances in the green environment: -+ If you choose to delete the DB instances in the green environment \(`--delete-target`\), they must have deletion protection turned off\. -+ If you don't delete the DB instances in the green environment \(`--no-delete-target`\), the instances are retained, but they're no longer part of a blue/green deployment\. Replication continues between the environments\. - -The option to delete the green databases isn't available in the console after [switchover](blue-green-deployments-switching.md)\. When you delete blue/green deployments using the AWS CLI, you can't specify the `--delete-target` option if the deployment [status](https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_BlueGreenDeployment.html) is `SWITCHOVER_COMPLETED`\. - -**Important** -Deleting a blue/green deployment doesn't affect the blue environment\. - -You can delete a blue/green deployment using the AWS Management Console, the AWS CLI, or the RDS API\. - -## Console - -**To delete a blue/green deployment** - -1. Sign in to the AWS Management Console and open the Amazon RDS console at [https://console\.aws\.amazon\.com/rds/](https://console.aws.amazon.com/rds/)\. - -1. In the navigation pane, choose **Databases**, and then choose the blue/green deployment that you want to delete\. - -1. For **Actions**, choose **Delete**\. - - The **Delete Blue/Green Deployment?** window appears\. -![\[Delete blue/green deployment\]](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/images/blue-green-deployment-delete.png) - - To delete the green databases, select **Delete the green databases in this Blue/Green Deployment**\. - -1. Enter **delete me** in the box\. - -1. Choose **Delete**\. - -## AWS CLI - -To delete a blue/green deployment by using the AWS CLI, use the [delete\-blue\-green\-deployment](https://docs.aws.amazon.com/cli/latest/reference/rds/delete-blue-green-deployment.html) command with the following options: -+ `--blue-green-deployment-identifier` – The identifier of the blue/green deployment to be deleted\. -+ `--delete-target` – Specifies that the DB instances in the green environment are deleted\. You can't specify this option if the blue/green deployment has a status of `SWITCHOVER_COMPLETED`\. -+ `--no-delete-target` – Specifies that the DB instances in the green environment are retained\. - -**Example Delete a blue/green deployment and the DB instances in the green environment** -For Linux, macOS, or Unix: - -``` -aws rds delete-blue-green-deployment \ - --blue-green-deployment-identifier bgd-1234567890abcdef \ - --delete-target -``` -For Windows: - -``` -aws rds delete-blue-green-deployment ^ - --blue-green-deployment-identifier bgd-1234567890abcdef ^ - --delete-target -``` - -**Example Delete a blue/green deployment but retain the DB instances in the green environment** -For Linux, macOS, or Unix: - -``` -aws rds delete-blue-green-deployment \ - --blue-green-deployment-identifier bgd-1234567890abcdef \ - --no-delete-target -``` -For Windows: - -``` -aws rds delete-blue-green-deployment ^ - --blue-green-deployment-identifier bgd-1234567890abcdef ^ - --no-delete-target -``` - -## RDS API - -To delete a blue/green deployment by using the Amazon RDS API, use the [https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_DeleteBlueGreenDeployment.html](https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_DeleteBlueGreenDeployment.html) operation with the following parameters: -+ `BlueGreenDeploymentIdentifier` – The identifier of the blue/green deployment to be deleted\. -+ `DeleteTarget` – Specify `TRUE` to delete the DB instances in the green environment or `FALSE` to retain them\. Cannot be `TRUE` if the blue/green deployment has a status of `SWITCHOVER_COMPLETED`\. \ No newline at end of file diff --git a/doc_source/blue-green-deployments-overview.md b/doc_source/blue-green-deployments-overview.md deleted file mode 100644 index b5d830a..0000000 --- a/doc_source/blue-green-deployments-overview.md +++ /dev/null @@ -1,177 +0,0 @@ -# Overview of Amazon RDS Blue/Green Deployments - -By using Amazon RDS Blue/Green Deployments, you can create a blue/green deployment for managed database changes\. A *blue/green deployment* creates a staging environment that copies the production environment\. In a blue/green deployment, the *blue environment* is the current production environment\. The *green environment* is the staging environment\. The staging environment stays in sync with the current production environment using logical replication\. - -You can make changes to the RDS DB instances in the green environment without affecting production workloads\. For example, you can upgrade the major or minor DB engine version, change database parameters, or make schema changes in the staging environment\. You can thoroughly test changes in the green environment\. When ready, you can *switch over* the environments to promote the green environment to be the new production environment\. The switchover typically takes under a minute with no data loss and no need for application changes\. - -Because the green environment is a copy of the topology of the production environment, the green environment includes the features used by the DB instance\. These features include the read replicas, the storage configuration, DB snapshots, automated backups, Performance Insights, and Enhanced Monitoring\. If the blue DB instance is a Multi\-AZ DB instance deployment, then the green DB instance is also a Multi\-AZ DB instance deployment\. - -**Note** -Currently, blue/green deployments are supported only for RDS for MariaDB and RDS for MySQL\. For Amazon Aurora availabilty, see [Using Amazon RDS Blue/Green Deployments for database updates](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/blue-green-deployments.html) in the *Amazon Aurora User Guide*\. - -**Topics** -+ [Benefits of using Amazon RDS Blue/Green Deployments](#blue-green-deployments-benefits) -+ [Workflow of a blue/green deployment](#blue-green-deployments-major-steps) -+ [Authorizing access to blue/green deployment operations](#blue-green-deployments-authorizing-access) -+ [Considerations for blue/green deployments](#blue-green-deployments-considerations) -+ [Best practices for blue/green deployments](#blue-green-deployments-best-practices) -+ [Region and version availability](#blue-green-deployments-region-version-availability) -+ [Limitations for blue/green deployments](#blue-green-deployments-limitations) - -## Benefits of using Amazon RDS Blue/Green Deployments - -By using Amazon RDS Blue/Green Deployments, you can stay current on security patches, improve database performance, and adopt newer database features with short, predictable downtime\. Blue/green deployments reduce the risks and downtime for database updates, such as major or minor engine version upgrades\. - -Blue/green deployments provide the following benefits: -+ Easily create a production\-ready staging environment\. -+ Automatically replicate database changes from the production environment to the staging environment\. -+ Test database changes in a safe staging environment without affecting the production environment\. -+ Stay current with database patches and system updates\. -+ Implement and test newer database features\. -+ Switch over your staging environment to be the new production environment without changes to your application\. -+ Safely switch over through the use of built\-in switchover guardrails\. -+ Eliminate data loss during switchover\. -+ Switch over quickly, typically under a minute depending on your workload\. - -## Workflow of a blue/green deployment - -Complete the following major steps when you use a blue/green deployment for database updates\. - -1. Identify a production environment that requires updates\. - - For example, the production environment in this image has a Multi\-AZ DB instance deployment \(mydb1\) and a read replica \(mydb2\)\. -![\[Production (blue) environment in a blue/green deployment\]](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/images/blue-green-deployment-blue-environment.png) - -1. Create the blue/green deployment\. For instructions, see [Creating a blue/green deployment](blue-green-deployments-creating.md)\. - - The following image shows an example of a blue/green deployment of the production environment from step 1\. While creating the blue/green deployment, RDS copies the complete topology and configuration of the primary DB instance to create the green environment\. The copied DB instance names are appended with `-green-random-characters`\. The staging environment in the image contains a Multi\-AZ DB instance deployment \(mydb1\-green\-**abc123**\) and a read replica \(mydb2\-green\-**abc123**\)\. -![\[Blue/green deployment\]](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/images/blue-green-deployment.png) - - When you create the blue/green deployment, you can upgrade your DB engine version and specify a different DB parameter group for the DB instances in the green environment\. RDS also configures logical replication from the primary DB instance in the blue environment to the primary DB instance in the green environment\. - - After you create the blue/green deployment, the DB instance in the green environment is read\-only by default\. - -1. Make additional changes to the staging environment, if required\. - - For example, you might make schema changes to your database or change the DB instance class used by one or more DB instances in the green environment\. - - For information about modifying a DB instance, see [Modifying an Amazon RDS DB instance](Overview.DBInstance.Modifying.md)\. - -1. Test your staging environment\. - - During testing, we recommend that you keep your databases in the green environment read only\. We recommend that you enable write operations on the green environment with caution because they can result in replication conflicts\. They can also result in unintended data in the production databases after switchover\. - -1. When ready, switch over to promote the staging environment to be the new production environment\. For instructions, see [Switching a blue/green deployment](blue-green-deployments-switching.md)\. - - The switchover results in downtime\. The downtime is usually under one minute, but it can be longer depending on your workload\. - - The following image shows the DB instances after the switchover\. -![\[DB instances after switching over a blue/green deployment\]](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/images/blue-green-deployment-switchover.png) - - After the switchover, the DB instances that were in the green environment become the new production DB instances\. The names and endpoints in the current production environment are assigned to the newly promoted production environment, requiring no changes to your application\. As a result, your production traffic now flows to the new production environment\. The DB instances in the previous blue environment are renamed by appending `-oldn` to the current name, where `n` is a number\. For example, assume the name of the DB instance in the blue environment is `mydb1`\. After switchover, the DB instance name might be `mydb1-old1`\. - - In the example in the image, the following changes occur during switchover: - + The green environment Multi\-AZ DB instance deployment named `mydb1-green-abc123` becomes the production Multi\-AZ DB instance deployment named `mydb1`\. - + The green environment read replica named `mydb2-green-abc123` becomes the production read replica `mydb2`\. - + The blue environment Multi\-AZ DB instance deployment named `mydb1` becomes `mydb1-old1`\. - + The blue environment read replica named `mydb2` becomes `mydb2-old1`\. - -1. If you no longer need a blue/green deployment, you can delete it\. For instructions, see [Deleting a blue/green deployment](blue-green-deployments-deleting.md)\. - - After switchover, the previous production environment isn't deleted so that you can use it for regression testing, if necessary\. - -## Authorizing access to blue/green deployment operations - -Users must have the required permissions to perform operations related to blue/green deployments\. You can create IAM policies that grant users and roles permission to perform specific API operations on the specified resources they need\. You can then attach those policies to the IAM permission sets or roles that require those permissions\. For more information, see [Identity and access management for Amazon RDS](UsingWithRDS.IAM.md)\. - -The user who creates a blue/green deployment must have permissions to perform the following RDS operations: -+ `rds:AddTagsToResource` -+ `rds:CreateDBInstanceReadReplica` - -The user who switches over a blue/green deployment must have permissions to perform the following RDS operations: -+ `rds:ModifyDBInstance` -+ `rds:PromoteDBInstance` - -The user who deletes a blue/green deployment must have permissions to perform the following RDS operation: -+ `rds:DeleteDBInstance` - -## Considerations for blue/green deployments - -Amazon RDS tracks resources in blue/green deployments with the `DbiResourceId` of each resource\. This resource ID is an AWS Region\-unique, immutable identifier for the resource\. - -The *resource* ID is separate from the DB ***instance* ID: - -![\[Create blue/green deployment\]](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/images/blue-green-deployment-resource-id.png) - -The name \(instance ID\) of a resource changes when you switch over a blue/green deployment, but each resource keeps the same resource ID\. For example, a DB instance identifier might be `mydb` in the blue environment\. After switchover, the same DB instance might be renamed to `mydb-old1`\. However, the resource ID of the DB instance doesn't change during switchover\. So, when the green resources are promoted to be the new production resources, their resource IDs don't match the blue resource IDs that were previously in production\. - -After switching over a blue/green deployment, consider updating the resource IDs to those of the newly promoted production resources for integrated features and services that you used with the production resources\. Specifically, consider the following updates: -+ If you perform filtering using the RDS API and resource IDs, adjust the resource IDs used in filtering after switchover\. -+ If you use CloudTrail for auditing resources, adjust the consumers of the CloudTrail to track the new resource IDs after switchover\. For more information, see [Monitoring Amazon RDS API calls in AWS CloudTrail](logging-using-cloudtrail.md)\. -+ If you use the Performance Insights API, adjust the resource IDs in calls to the API after switchover\. For more information, see [Monitoring DB load with Performance Insights on Amazon RDS](USER_PerfInsights.md)\. - - You can monitor a database with the same name after switchover, but it doesn't contain the data from before the switchover\. -+ If you use resource IDs in IAM policies, make sure you add the resource IDs of the newly promoted resources when necessary\. For more information, see [Identity and access management for Amazon RDS](UsingWithRDS.IAM.md)\. -+ If you authenticate to your DB instance using [IAM database authentication](UsingWithRDS.IAMDBAuth.md), make sure that the IAM policy used for database access has both the blue and the green databases listed under the `Resource` element of the policy\. This is required in order to connect to the green database after switchover\. For more information, see [Creating and using an IAM policy for IAM database access](UsingWithRDS.IAMDBAuth.IAMPolicy.md)\. -+ If you use AWS Backup to manage automated backups of resources in a blue/green deployment, adjust the resource IDs used by AWS Backup after switchover\. For more information, see [Using AWS Backup to manage automated backups](USER_WorkingWithAutomatedBackups.md#AutomatedBackups.AWSBackup)\. -+ If you want to restore a manual or automated DB snapshot for a DB instance that was part of a blue/green deployment, make sure you restore the correct DB snapshot by examining the time when the snapshot was taken\. For more information, see [Restoring from a DB snapshot](USER_RestoreFromSnapshot.md)\. -+ If you want to describe a previous blue environment DB instance automated backup or restore it to a point in time, use the resource ID for the operation\. - - Because the name of the DB instance changes during switchover, you can't use its previous name for `DescribeDBInstanceAutomatedBackups` or `RestoreDBInstanceToPointInTime` operations\. - - For more information, see [Restoring a DB instance to a specified time](USER_PIT.md)\. -+ When you add a read replica to a DB instance in the green environment of a blue/green deployment, the new read replica won't replace a read replica in the blue environment when you switch over\. However, the new read replica is retained in the new production environment after switchover\. -+ When you delete a DB instance in the green environment of a blue/green deployment, you can't create a new DB instance to replace it in the blue/green deployment\. - - If you create a new DB instance with the same name and Amazon Resource Name \(ARN\) as the deleted DB instance, it has a different `DbiResourceId`, so it isn't part of the green environment\. - - The following behavior results if you delete a DB instance in the green environment: - + If the DB instance in the blue environment with the same name exists, it won't be switched over to the DB instance in the green environment\. This DB instance won't be renamed by adding `-oldn` to the DB instance name\. - + Any application that points to the DB instance in the blue environment continues to use the same DB instance after switchover\. - - The same behavior applies to DB instances and read replicas\. - -## Best practices for blue/green deployments - -The following are best practices for blue/green deployments: -+ Avoid using non\-transactional storage engines, such as MyISAM, that aren't optimized for replication\. -+ Optimize read replicas for binary log replication\. - - For example, if your DB engine version supports it, consider using GTID replication, parallel replication, and crash\-safe replication in your production environment before deploying your blue/green deployment\. These options promote consistency and durability of your data before you switch over your blue/green deployment\. For more information about GTID replication for read replicas, see [Using GTID\-based replication for Amazon RDS for MySQL](mysql-replication-gtid.md)\. -+ Thoroughly test the DB instances in the green environment before switching over\. -+ Keep your databases in the green environment read only\. We recommend that you enable write operations on the green environment with caution because they can result in replication conflicts\. They can also result in unintended data in the production databases after switchover\. -+ Identify the best time for the switchover\. - - During the switchover, writes are cut off from databases in both environments\. Identify a time when traffic is lowest on your production environment\. Long\-running transactions, such as active DDLs, can increase your switchover time, resulting in longer downtime for your production workloads\. -+ When using a blue/green deployment to implement schema changes, make only replication\-compatible changes\. - - For example, you can add new columns at the end of a table, create indexes, or drop indexes without disrupting replication from the blue deployment to the green deployment\. However, schema changes, such as renaming columns or renaming tables, break binary log replication to the green deployment\. - - For more information about replication\-compatible changes, see [Replication with Differing Table Definitions on Source and Replica](https://dev.mysql.com/doc/refman/8.0/en/replication-features-differing-tables.html) in the MySQL documentation\. -+ After you create the blue/green deployment, handle lazy loading if necessary\. Make sure data loading is complete before switching over\. For more information, see [Handling lazy loading when you create a blue/green deployment](blue-green-deployments-creating.md#blue-green-deployments-creating-lazy-loading)\. - -## Region and version availability - -Feature availability and support varies across specific versions of each database engine, and across AWS Regions\. For more information on version and Region availability with Amazon RDS Blue/Green Deployments, see [Blue/Green Deployments](Concepts.RDS_Fea_Regions_DB-eng.Feature.BlueGreenDeployments.md)\. - -## Limitations for blue/green deployments - -The following limitations apply to blue/green deployments: -+ MySQL versions 8\.0\.11 through 8\.0\.13 have a [community bug](https://bugs.mysql.com/bug.php?id=93901) that prevents RDS from supporting them for blue/green deployments\. -+ Blue/green deployments aren't supported for the following features: - + Amazon RDS Proxy - + Cascading read replicas - + Cross\-Region read replicas - + AWS CloudFormation - + Multi\-AZ DB cluster deployments - - Blue/green deployments are supported for Multi\-AZ DB instance deployments\. For more information about Multi\-AZ deployments, see [Configuring and managing a Multi\-AZ deployment](Concepts.MultiAZ.md)\. -+ The following are limitations for changes in a blue/green deployment: - + You can't change an unencrypted DB instance into an encrypted DB instance\. - + You can't change an encrypted DB instance into an unencrypted DB instance\. - + You can't change a blue environment DB instance to a higher engine version than its corresponding green environment DB instance\. - + The resources in the blue environment and green environment must be in the same AWS account\. - + During switchover, the blue primary DB instance can't be the target of external replication\. - + If the source database is associated with a custom option group, you can't specify a major version upgrade when you create the blue/green deployment\. - - In this case, you can create a blue/green deployment without specifying a major version upgrade\. Then, you can upgrade the database in the green environment\. For more information, see [Upgrading a DB instance engine version](USER_UpgradeDBInstance.Upgrading.md)\. \ No newline at end of file diff --git a/doc_source/blue-green-deployments-switching.md b/doc_source/blue-green-deployments-switching.md deleted file mode 100644 index bc0dbc4..0000000 --- a/doc_source/blue-green-deployments-switching.md +++ /dev/null @@ -1,141 +0,0 @@ -# Switching a blue/green deployment - -A *switchover* promotes the green environment to be the new production environment\. When the green DB instance has read replicas, they are also promoted\. Before you switch over, production traffic is routed to the DB instance and read replicas in the blue environment\. After you switch over, production traffic is routed to the DB instance and read replicas in the green environment\. - -**Topics** -+ [Switchover timeout](#blue-green-deployments-switching-timeout) -+ [Switchover guardrails](#blue-green-deployments-switching-guardrails) -+ [Switchover actions](#blue-green-deployments-switching-actions) -+ [Switchover best practices](#blue-green-deployments-switching-best-practices) -+ [Verifying CloudWatch metrics before switchover](#blue-green-deployments-switching-over-cloudwatch) -+ [Switching over a blue/green deployment](#blue-green-deployments-switching-over) -+ [After switchover](#blue-green-deployments-switching-after) - -## Switchover timeout - -You can specify a switchover timeout period between 30 seconds and 3,600 seconds \(one hour\)\. If the switchover takes longer than the specified duration, then any changes are rolled back and no changes are made to either environment\. The default timeout period is 300 seconds \(five minutes\)\. - -## Switchover guardrails - -When you start a switchover, Amazon RDS runs some basic checks to test the readiness of the blue and green environments for switchover\. These checks are known as *switchover guardrails*\. These switchover guardrails prevent a switchover if the environments aren't ready for it\. Therefore, they avoid longer than expected downtime and prevent the loss of data between the blue and green environments that might result if the switchover started\. - -Amazon RDS runs the following guardrail checks on the green environment: -+ Replication health – Check if green primary DB instance replication status is healthy\. The green primary DB instance is a replica of the blue primary DB instance\. -+ Replication lag – Check if the replica lag of the green primary DB instance is within allowable limits for switchover\. The allowable limits are based on the specified timeout period\. Replica lag indicates how far the green primary DB instance is lagging behind its blue primary DB instance\. Replica lag indicates how much time the green replica might require before it catches up with its blue source\. For more information, see [Diagnosing and resolving lag between read replicas](CHAP_Troubleshooting.md#CHAP_Troubleshooting.MySQL.ReplicaLag)\. -+ Active writes – Make sure there are no active writes on the green primary DB instance\. - -Amazon RDS runs the following guardrail checks on the blue environment: -+ External replication – Make sure the blue primary DB instance isn't the target of external replication to prevent writes on the blue primary DB instance during switchover\. -+ Long\-running active writes – Make sure there are no long\-running active writes on the blue primary DB instance because they can increase replica lag\. -+ Long\-running DDL statements – Make sure there are no long\-running DDL statements on the blue primary DB instance because they can increase replica lag\. - -## Switchover actions - -When you switch over a blue/green deployment, RDS performs the following actions: - -1. Runs guardrail checks to verify if the blue and green environments are ready for switchover\. - -1. Stops new write operations on the primary DB instance in both environments\. - -1. Drops connections to the DB instances in both environments and doesn't allow new connections\. - -1. Waits for replication to catch up in the green environment so that the green environment is in sync with the blue environment\. - -1. Renames the DB instances in the both environments\. - - RDS renames the DB instances in the green environment to match the corresponding DB instances in the blue environment\. For example, assume the name of a DB instance in the blue environment is `mydb`\. Also assume the name of the corresponding DB instance in the green environment is `mydb-green-abc123`\. During switchover, the name of the DB instance in the green environment is changed to `mydb`\. - - RDS renames the DB instances in the blue environment by appending `-oldn` to the current name, where `n` is a number\. For example, assume the name of a DB instance in the blue environment is `mydb`\. After switchover, the DB instance name might be `mydb-old1`\. - - RDS also renames the endpoints in the green environment to match the corresponding endpoints in the blue environment so that application changes aren't required\. - -1. Allows connections to databases in both environments\. - -1. Allows write operations on the primary DB instance in the new production environment\. - - After switchover, the previous production primary DB instance only allows read operations until it is rebooted\. - -You can monitor the status of a switchover using Amazon EventBridge\. For more information, see [Blue/green deployment events](USER_Events.Messages.md#USER_Events.Messages.BlueGreenDeployments)\. - -If you have tags configured in the blue environment, these tags are moved to the new production environment during switchover\. The previous production environment also retains these tags\. For more information about tags, see [Tagging Amazon RDS resources](USER_Tagging.md)\. - -If the switchover starts and then stops before finishing for any reason, then any changes are rolled back, and no changes are made to either environment\. - -## Switchover best practices - -Before you switchover, we strongly recommend that you adhere to best practices by completing the following tasks: -+ Thoroughly test the resources in the green environment\. Make sure they function properly and efficiently\. -+ Monitor relevant Amazon CloudWatch metrics\. For more information, see [Verifying CloudWatch metrics before switchover](#blue-green-deployments-switching-over-cloudwatch)\. -+ Identify a time when traffic is lowest on your production environment\. During the switchover, writes are cut off from the databases in both environments\. Long\-running transactions, such as active DDLs can, increase your switchover time, resulting in longer downtime for your production workloads\. -+ Make sure the DB instances in both environments are in `Available` state\. -+ Make sure the primary DB instance in the green environment is healthy and replicating\. -+ Make sure that your network and client configurations don’t increase the DNS cache Time\-To\-Live \(TTL\) beyond five seconds, which is the default for RDS DNS zones\.
 Otherwise, applications will continue to send write traffic to the blue environment after
 switchover\. -+ Make sure data loading is complete before switching over\. For more information, see [Handling lazy loading when you create a blue/green deployment](blue-green-deployments-creating.md#blue-green-deployments-creating-lazy-loading)\. - -**Note** -During a switchover, you can't modify any DB instances included in the switchover\. - -## Verifying CloudWatch metrics before switchover - -Before you switch over a blue/green deployment, we recommend that you check the values of the following metrics within Amazon CloudWatch\. -+ `ReplicaLag` – Use this metric to identify the current replication lag on the green environment\. To reduce downtime, make sure that this value is close to zero before you switch over -+ `DatabaseConnections` – Use this metric to estimate the level of activity on the blue/green deployment, and make sure that the value is at an acceptable level for your deployment before you switch over\. If Performance Insights is turned on, `DBLoad` is a more accurate metric\. - -For more information about these metrics, see [Amazon CloudWatch metrics for Amazon RDS](rds-metrics.md)\. - -## Switching over a blue/green deployment - -You can switch over a blue/green deployment using the AWS Management Console, the AWS CLI, or the RDS API\. - -### Console - -**To switch over a blue/green deployment** - -1. Sign in to the AWS Management Console and open the Amazon RDS console at [https://console\.aws\.amazon\.com/rds/](https://console.aws.amazon.com/rds/)\. - -1. In the navigation pane, choose **Databases**, and then choose the blue/green deployment that you want to switch over\. - -1. For **Actions**, choose **Switch over**\. - - The **Switch over** page appears\. -![\[Switch over blue/green deployment\]](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/images/blue-green-deployment-switch-over.png) - -1. On the **Switch over** page, review the switchover summary\. Make sure the resources in both environments match what you expect\. If they don't, choose **Cancel**\. - -1. For **Timeout**, enter the time limit for switchover\. - -1. Choose **Switch over**\. - -### AWS CLI - -To switch over a blue/green deployment by using the AWS CLI, use the [switchover\-blue\-green\-deployment](https://docs.aws.amazon.com/cli/latest/reference/rds/switchover-blue-green-deployment.html) command with the following options: -+ `--blue-green-deployment-identifier` – Specify the identifier of the blue/green deployment\. -+ `--switchover-timeout` – Specify the time limit for the switchover, in seconds\. The default is 300\. - -**Example Switch over a blue/green deployment** -For Linux, macOS, or Unix: - -``` -aws rds switchover-blue-green-deployment \ - --blue-green-deployment-identifier bgd-1234567890abcdef \ - --switchover-timeout 600 -``` -For Windows: - -``` -aws rds switchover-blue-green-deployment ^ - --blue-green-deployment-identifier bgd-1234567890abcdef ^ - --switchover-timeout 600 -``` - -### RDS API - -To switch over a blue/green deployment by using the Amazon RDS API, use the [https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_SwitchoverBlueGreenDeployment.html](https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_SwitchoverBlueGreenDeployment.html) operation with the following parameters: -+ `BlueGreenDeploymentIdentifier` – Specify the identifier of the blue/green deployment\. -+ `SwitchoverTimeout` – Specify the time limit for the switchover, in seconds\. The default is 300\. - -## After switchover - -After a switchover, the DB instances in the previous blue environment are retained\. Standard costs apply to these resources\. Replication between the blue and green environments stops\. - -RDS renames the DB instances in the blue environment by appending `-oldn` to the current resource name, where `n` is a number\. The DB instances are read\-only until you set the `read_only` parameter to `0`\. \ No newline at end of file diff --git a/doc_source/blue-green-deployments-viewing.md b/doc_source/blue-green-deployments-viewing.md deleted file mode 100644 index 3385873..0000000 --- a/doc_source/blue-green-deployments-viewing.md +++ /dev/null @@ -1,51 +0,0 @@ -# Viewing a blue/green deployment - -You can view the details about a blue/green deployment using the AWS Management Console, the AWS CLI, or the RDS API\. - -You can also view and subscribe to events for information about a blue/green deployment\. For more information, see [Blue/green deployment events](USER_Events.Messages.md#USER_Events.Messages.BlueGreenDeployments)\. - -## Console - -**To view the details about a blue/green deployment** - -1. Sign in to the AWS Management Console and open the Amazon RDS console at [https://console\.aws\.amazon\.com/rds/](https://console.aws.amazon.com/rds/)\. - -1. In the navigation pane, choose **Databases**, and then find the blue/green deployment in the list\. -![\[Blue/green deployment in the database list\]](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/images/blue-green-deployment-view-db-list.png) - - The **Role** value for the blue/green deployment is **Blue/Green Deployment**\. - -1. Choose the name of blue/green deployment that you want to view to display its details\. - - Each tab has a section for the blue deployment and a section for the green deployment\. The section for the blue deployment shows the details about DB instances in the blue environment\. The section for the green deployment shows the details about DB instances in the green environment\. You can examine the details in both environments to see differences between them\. For example, on the **Configuration** tab, the DB engine version might be different in the blue environment and in the green environment if you are upgrading the DB engine version in the green environment\. Make sure the values for the DB instances in both environments are the expected values\. - - The following image shows an example of the **Connectivity & security** tab\. -![\[Blue/green deployment details\]](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/images/blue-green-deployment-view-details.png) - - The following image shows an example of the **Configuration** tab\. -![\[Blue/green deployment configuration details\]](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/images/blue-green-deployment-view-config.png) - - The following image shows an example of the **Status** tab\. -![\[Blue/green deployment status\]](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/images/blue-green-deployment-view-status.png) - -## AWS CLI - -To view the details about a blue/green deployment by using the AWS CLI, use the [describe\-blue\-green\-deployments](https://docs.aws.amazon.com/cli/latest/reference/rds/describe-blue-green-deployments.html) command\. - -**Example View the details about a blue/green deployment by filtering on its name** -When you use the [describe\-blue\-green\-deployments](https://docs.aws.amazon.com/cli/latest/reference/rds/describe-blue-green-deployments.html) command, you can filter on the `--blue-green-deployment-name`\. The following example shows the details for a blue/green deployment named `my-blue-green-deployment`\. - -``` -aws rds describe-blue-green-deployments --filters Name=blue-green-deployment-name,Values=my-blue-green-deployment -``` - -**Example View the details about a blue/green deployment by specifying its identifier** -When you use the [describe\-blue\-green\-deployments](https://docs.aws.amazon.com/cli/latest/reference/rds/describe-blue-green-deployments.html) command, you can specify the `--blue-green-deployment-identifier`\. The following example shows the details for a blue/green deployment with the identifier `bgd-1234567890abcdef`\. - -``` -aws rds describe-blue-green-deployments --blue-green-deployment-identifier bgd-1234567890abcdef -``` - -## RDS API - -To view the details about a blue/green deployment by using the Amazon RDS API, use the [https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_DescribeBlueGreenDeployments.html](https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_DescribeBlueGreenDeployments.html) operation and specify the `BlueGreenDeploymentIdentifier`\. \ No newline at end of file diff --git a/doc_source/blue-green-deployments.md b/doc_source/blue-green-deployments.md deleted file mode 100644 index fba1817..0000000 --- a/doc_source/blue-green-deployments.md +++ /dev/null @@ -1,13 +0,0 @@ -# Using Amazon RDS Blue/Green Deployments for database updates - -A blue/green deployment copies a production database environment to a separate, synchronized staging environment\. By using Amazon RDS Blue/Green Deployments, you can make changes to the database in the staging environment without affecting the production environment\. For example, you can upgrade the major or minor DB engine version, change database parameters, or make schema changes in the staging environment\. When you are ready, you can promote the staging environment to be the new production database environment, with downtime typically under one minute\. - -**Note** -Currently, blue/green deployments are supported only for RDS for MariaDB and RDS for MySQL\. For Amazon Aurora availabilty, see [Using Amazon RDS Blue/Green Deployments for database updates](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/blue-green-deployments.html) in the *Amazon Aurora User Guide*\. - -**Topics** -+ [Overview of Amazon RDS Blue/Green Deployments](blue-green-deployments-overview.md) -+ [Creating a blue/green deployment](blue-green-deployments-creating.md) -+ [Viewing a blue/green deployment](blue-green-deployments-viewing.md) -+ [Switching a blue/green deployment](blue-green-deployments-switching.md) -+ [Deleting a blue/green deployment](blue-green-deployments-deleting.md) \ No newline at end of file diff --git a/doc_source/create-multi-az-db-cluster.md b/doc_source/create-multi-az-db-cluster.md deleted file mode 100644 index c25f8d1..0000000 --- a/doc_source/create-multi-az-db-cluster.md +++ /dev/null @@ -1,323 +0,0 @@ -# Creating a Multi\-AZ DB cluster - -A Multi\-AZ DB cluster has a writer DB instance and two reader DB instances in three separate Availability Zones\. Multi\-AZ DB clusters provide high availability, increased capacity for read workloads, and lower latency when compared to Multi\-AZ deployments\. For more information about Multi\-AZ DB clusters, see [Multi\-AZ DB cluster deployments](multi-az-db-clusters-concepts.md)\. - -**Note** -Multi\-AZ DB clusters are supported only for the MySQL and PostgreSQL DB engines\. - -## DB cluster prerequisites - -**Important** -Before you can create a Multi\-AZ DB cluster, you must complete the tasks in [Setting up for Amazon RDS](CHAP_SettingUp.md)\. - -The following are prerequisites to complete before creating a Multi\-AZ DB cluster\. - -**Topics** -+ [Configure the network for the DB cluster](#create-multi-az-db-cluster-prerequisites-VPC) -+ [Additional prerequisites](#create-multi-az-db-cluster-prerequisites-additional) - -### Configure the network for the DB cluster - -You can create a Multi\-AZ DB cluster only in a virtual private cloud \(VPC\) based on the Amazon VPC service\. It must be in an AWS Region that has at least three Availability Zones\. The DB subnet group that you choose for the DB cluster must cover at least three Availability Zones\. This configuration ensures that each DB instance in the DB cluster is in a different Availability Zone\. - -To set up connectivity between your new DB cluster and an Amazon EC2 instance in the same VPC, do so when you create the DB cluster\. To connect to your DB cluster from resources other than EC2 instances in the same VPC, configure the network connections manually\. - -**Topics** -+ [Configure automatic network connectivity with an EC2 instance](#create-multi-az-db-cluster-prerequisites-VPC-automatic) -+ [Configure the network manually](#create-multi-az-db-cluster-prerequisites-VPC-manual) - -#### Configure automatic network connectivity with an EC2 instance - -When you create a Multi\-AZ DB cluster, you can use the AWS Management Console to set up connectivity between an EC2 instance and the new DB cluster\. When you do so, RDS configures your VPC and network settings automatically\. The DB cluster is created in the same VPC as the EC2 instance so that the EC2 instance can access the DB cluster\. - -The following are requirements for connecting an EC2 instance with the DB cluster: -+ The EC2 instance must exist in the AWS Region before you create the DB cluster\. - - If no EC2 instances exist in the AWS Region, the console provides a link to create one\. -+ The user who is creating the DB cluster must have permissions to perform the following operations: - + `ec2:AssociateRouteTable` - + `ec2:AuthorizeSecurityGroupEgress` - + `ec2:AuthorizeSecurityGroupIngress` - + `ec2:CreateRouteTable` - + `ec2:CreateSubnet` - + `ec2:CreateSecurityGroup` - + `ec2:DescribeInstances` - + `ec2:DescribeNetworkInterfaces` - + `ec2:DescribeRouteTables` - + `ec2:DescribeSecurityGroups` - + `ec2:DescribeSubnets` - + `ec2:ModifyNetworkInterfaceAttribute` - + `ec2:RevokeSecurityGroupEgress` - -Using this option creates a private DB cluster\. The DB cluster uses a DB subnet group with only private subnets to restrict access to resources within the VPC\. - -To connect an EC2 instance to the DB cluster, choose **Connect to an EC2 compute resource** in the **Connectivity** section on the **Create database** page\. - -![\[Connect an EC2 instance\]](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/images/ec2-set-up-connection-create.png) - -When you choose **Connect to an EC2 compute resource**, RDS sets the following options automatically\. You can't change these settings unless you choose not to set up connectivity with an EC2 instance by choosing **Don't connect to an EC2 compute resource**\. - - -**** - -| Console option | Automatic setting | -| --- | --- | -| **Virtual Private Cloud \(VPC\)** | RDS sets the VPC to the one associated with the EC2 instance\. | -| **DB subnet group** | RDS requires a DB subnet group with a private subnet in the same Availability Zone as the EC2 instance\. If a DB subnet group that meets this requirement exists, then RDS uses the existing DB subnet group\. By default, this option is set to Automatic setup\. When you choose **Automatic setup** and there is no DB subnet group that meets this requirement, the following action happens\. RDS uses three available private subnets in three Availability Zones where one of the Availability Zones is the same as the EC2 instance\. If a private subnet isn’t available in an Availability Zone, RDS creates a private subnet in the Availability Zone\. Then RDS creates the DB subnet group\.When a private subnet is available, RDS uses the route table associated with the subnet and adds any subnets it creates to this route table\. When no private subnet is available, RDS creates a route table without internet gateway access and adds the subnets it creates to the route table\.RDS also allows you to use existing DB subnet groups\. Select **Choose existing** if you want to use an existing DB subnet group of your choice\. | -| **Public access** | RDS chooses **No** so that the DB cluster isn't publicly accessible\. For security, it is a best practice to keep the database private and make sure it isn't accessible from the internet\. | -| **VPC security group \(firewall\)** | RDS creates a new security group that is associated with the DB cluster\. The security group is named `rds-ec2-n`, where `n` is a number\. This security group includes an inbound rule with the EC2 VPC security group \(firewall\) as the source\. This security group that is associated with the DB cluster allows the EC2 instance to access the DB cluster\. RDS also creates a new security group that is associated with the EC2 instance\. The security group is named `ec2-rds-n`, where `n` is a number\. This security group includes an outbound rule with the VPC security group of the DB cluster as the source\. This security group allows the EC2 instance to send traffic to the DB cluster\. You can add another new security group by choosing **Create new** and typing the name of the new security group\. You can add existing security groups by choosing **Choose existing** and selecting security groups to add\. | -| **Availability Zone** | RDS chooses the Availability Zone of the EC2 instance for one DB instance in the Multi\-AZ DB cluster deployment\. RDS randomly chooses a different Availability Zone for both of the other DB instances\. The writer DB instance is created in the same Availability Zone as the EC2 instance\. There is the possibility of cross Availability Zone costs if a failover occurs and the writer DB instance is in a different Availability Zone\. | - -For more information about these settings, see [Settings for creating Multi\-AZ DB clusters](#create-multi-az-db-cluster-settings)\. - -If you change these settings after the DB cluster is created, the changes might affect the connection between the EC2 instance and the DB cluster\. - -#### Configure the network manually - -To connect to your DB cluster from resources other than EC2 instances in the same VPC, configure the network connections manually\. If you use the AWS Management Console to create your Multi\-AZ DB cluster, you can have Amazon RDS automatically create a VPC for you\. Or you can use an existing VPC or create a new VPC for your Multi\-AZ DB cluster\. Your VPC must have at least one subnet in each of at least three Availability Zones for you to use it with a Multi\-AZ DB cluster\. For information on VPCs, see [Amazon VPC VPCs and Amazon RDS](USER_VPC.md)\. - -If you don't have a default VPC or you haven't created a VPC, and you don't plan to use the console, do the following: -+ Create a VPC with at least one subnet in each of at least three of the Availability Zones in the AWS Region where you want to deploy your DB cluster\. For more information, see [Working with a DB instance in a VPC](USER_VPC.WorkingWithRDSInstanceinaVPC.md#Overview.RDSVPC.Create)\. -+ Specify a VPC security group that authorizes connections to your DB cluster\. For more information, see [Provide access to your DB instance in your VPC by creating a security group](CHAP_SettingUp.md#CHAP_SettingUp.SecurityGroup) and [Controlling access with security groups](Overview.RDSSecurityGroups.md)\. -+ Specify an RDS DB subnet group that defines at least three subnets in the VPC that can be used by the Multi\-AZ DB cluster\. For more information, see [Working with DB subnet groups](USER_VPC.WorkingWithRDSInstanceinaVPC.md#USER_VPC.Subnets)\. - -For information about limitations that apply to Multi\-AZ DB clusters, see [Limitations for Multi\-AZ DB clusters](multi-az-db-clusters-concepts.md#multi-az-db-clusters-concepts.Limitations)\. - -If you want to connect to a resource that isn't in the same VPC as the Multi\-AZ DB cluster, see the appropriate scenarios in [Scenarios for accessing a DB instance in a VPC](USER_VPC.Scenarios.md)\. - -### Additional prerequisites - -Before you create your Multi\-AZ DB cluster, consider the following additional prerequisites: -+ To connect to AWS using AWS Identity and Access Management \(IAM\) credentials, your AWS account must have certain IAM policies\. These grant the permissions required to perform Amazon RDS operations\. For more information, see [Identity and access management for Amazon RDS](UsingWithRDS.IAM.md)\. - - If you use IAM to access the RDS console, first sign in to the AWS Management Console with your IAM user credentials\. Then go to the RDS console at [https://console\.aws\.amazon\.com/rds/](https://console.aws.amazon.com/rds/)\. -+ To tailor the configuration parameters for your DB cluster, specify a DB cluster parameter group with the required parameter settings\. For information about creating or modifying a DB cluster parameter group, see [Working with parameter groups for Multi\-AZ DB clusters](multi-az-db-clusters-concepts.md#multi-az-db-clusters-concepts-parameter-groups)\. -+ Determine the TCP/IP port number to specify for your DB cluster\. The firewalls at some companies block connections to the default ports\. If your company firewall blocks the default port, choose another port for your DB cluster\. All DB instances in a DB cluster use the same port\. - -## Creating a DB cluster - -You can create a Multi\-AZ DB cluster using the AWS Management Console, the AWS CLI, or the RDS API\. - -### Console - -You can create a Multi\-AZ DB cluster by choosing **Multi\-AZ DB cluster** in the **Availability and durability** section\. - -**To create a Multi\-AZ DB cluster using the console** - -1. Sign in to the AWS Management Console and open the Amazon RDS console at [https://console\.aws\.amazon\.com/rds/](https://console.aws.amazon.com/rds/)\. - -1. In the upper\-right corner of the AWS Management Console, choose the AWS Region in which you want to create the DB cluster\. - - For information about the AWS Regions that support Multi\-AZ DB clusters, see [Limitations for Multi\-AZ DB clusters](multi-az-db-clusters-concepts.md#multi-az-db-clusters-concepts.Limitations)\. - -1. In the navigation pane, choose **Databases**\. - -1. Choose **Create database**\. - - To create a Multi\-AZ DB cluster, make sure that **Standard Create** is selected and **Easy Create** isn't\. - -1. In **Engine type**, choose **MySQL** or **PostgreSQL**\. - -1. For **Version**, choose the DB engine version\. - - For information about the DB engine versions that support Multi\-AZ DB clusters, see [Limitations for Multi\-AZ DB clusters](multi-az-db-clusters-concepts.md#multi-az-db-clusters-concepts.Limitations)\. - -1. In **Templates**, choose the appropriate template for your deployment\. - -1. In **Availability and durability**, choose **Multi\-AZ DB cluster**\. -![\[Multi-AZ DB cluster choice\]](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/images/multi-az-db-cluster-create.png) - -1. In **DB cluster identifier**, enter the identifier for your DB cluster\. - -1. In **Master username**, enter your master user name, or keep the default setting\. - -1. Enter your master password: - - 1. In the **Settings** section, open **Credential Settings**\. - - 1. If you want to specify a password, clear the **Auto generate a password** box if it is selected\. - - 1. \(Optional\) Change the **Master username** value\. - - 1. Enter the same password in **Master password** and **Confirm password**\. - -1. For **DB instance class**, choose a DB instance class\. For supported instance classes, see the **DB instance class** row in [Settings for creating Multi\-AZ DB clusters](#create-multi-az-db-cluster-settings)\. - -1. \(Optional\) Set up a connection to a compute resource for this DB cluster\. - - You can configure connectivity between an Amazon EC2 instance and the new DB cluster during DB cluster creation\. For more information, see [Configure automatic network connectivity with an EC2 instance](#create-multi-az-db-cluster-prerequisites-VPC-automatic)\. - -1. In the **Connectivity** section under **VPC security group \(firewall\)**, if you select **Create new**, a VPC security group is created is added to the database with an inbound rule that allows your local computer's IP address to access the database\. - -1. For the remaining sections, specify your DB cluster settings\. For information about each setting, see [Settings for creating Multi\-AZ DB clusters](#create-multi-az-db-cluster-settings)\. - -1. Choose **Create database**\. - - If you chose to use an automatically generated password, the **View credential details** button appears on the **Databases** page\. - - To view the master user name and password for the DB cluster, choose **View credential details**\. - - To connect to the DB cluster as the master user, use the user name and password that appear\. -**Important** -You can't view the master user password again\. - -1. For **Databases**, choose the name of the new DB cluster\. - -On the RDS console, the details for the new DB cluster appear\. The DB cluster has a status of **Creating** until the DB cluster is created and ready for use\. When the state changes to **Available**, you can connect to the DB cluster\. Depending on the DB cluster class and storage allocated, it can take several minutes for the new DB cluster to be available\. - -### AWS CLI - -Before you create a Multi\-AZ DB cluster using the AWS CLI, make sure to fulfill the required prerequisites\. These include creating a VPC and an RDS DB subnet group\. For more information, see [DB cluster prerequisites](#create-multi-az-db-cluster-prerequisites)\. - -To create a Multi\-AZ DB cluster by using the AWS CLI, call the [create\-db\-cluster](https://docs.aws.amazon.com/cli/latest/reference/rds/create-db-cluster.html) command\. Specify the `--db-cluster-identifier`\. For the `--engine` option, specify either `mysql` or `postgres`\. - -For information about each option, see [Settings for creating Multi\-AZ DB clusters](#create-multi-az-db-cluster-settings)\. - -For information about the AWS Regions, DB engines, and DB engine versions that support Multi\-AZ DB clusters, see [Limitations for Multi\-AZ DB clusters](multi-az-db-clusters-concepts.md#multi-az-db-clusters-concepts.Limitations)\. - -The `create-db-cluster` command creates the writer DB instance for your DB cluster, and two reader DB instances\. Each DB instance is in a different Availability Zone\. - -For example, the following command creates a MySQL 8\.0 Multi\-AZ DB cluster named `mysql-multi-az-db-cluster`\. - -**Example** -For Linux, macOS, or Unix: - -``` - 1. aws rds create-db-cluster \ - 2. --db-cluster-identifier mysql-multi-az-db-cluster \ - 3. --engine mysql \ - 4. --engine-version 8.0.28 \ - 5. --master-user-password password \ - 6. --master-username admin \ - 7. --port 3306 \ - 8. --backup-retention-period 1 \ - 9. --db-subnet-group-name default \ -10. --allocated-storage 4000 \ -11. --storage-type io1 \ -12. --iops 10000 \ -13. --db-cluster-instance-class db.r6gd.xlarge -``` -For Windows: - -``` - 1. aws rds create-db-cluster ^ - 2. --db-cluster-identifier mysql-multi-az-db-cluster ^ - 3. --engine mysql ^ - 4. --engine-version 8.0.28 ^ - 5. --master-user-password password ^ - 6. --master-username admin ^ - 7. --port 3306 ^ - 8. --backup-retention-period 1 ^ - 9. --db-subnet-group-name default ^ -10. --allocated-storage 4000 ^ -11. --storage-type io1 ^ -12. --iops 10000 ^ -13. --db-cluster-instance-class db.r6gd.xlarge -``` - -The following command creates a PostgreSQL 13\.4 Multi\-AZ DB cluster named `postgresql-multi-az-db-cluster`\. - -**Example** -For Linux, macOS, or Unix: - -``` - 1. aws rds create-db-cluster \ - 2. --db-cluster-identifier postgresql-multi-az-db-cluster \ - 3. --engine postgres \ - 4. --engine-version 13.4 \ - 5. --master-user-password password \ - 6. --master-username postgres \ - 7. --port 5432 \ - 8. --backup-retention-period 1 \ - 9. --db-subnet-group-name default \ -10. --allocated-storage 4000 \ -11. --storage-type io1 \ -12. --iops 10000 \ -13. --db-cluster-instance-class db.r6gd.xlarge -``` -For Windows: - -``` - 1. aws rds create-db-cluster ^ - 2. --db-cluster-identifier postgresql-multi-az-db-cluster ^ - 3. --engine postgres ^ - 4. --engine-version 13.4 ^ - 5. --master-user-password password ^ - 6. --master-username postgres ^ - 7. --port 5432 ^ - 8. --backup-retention-period 1 ^ - 9. --db-subnet-group-name default ^ -10. --allocated-storage 4000 ^ -11. --storage-type io1 ^ -12. --iops 10000 ^ -13. --db-cluster-instance-class db.r6gd.xlarge -``` - -### RDS API - -Before you can create a Multi\-AZ DB cluster using the RDS API, make sure to fulfill the required prerequisites, such as creating a VPC and an RDS DB subnet group\. For more information, see [DB cluster prerequisites](#create-multi-az-db-cluster-prerequisites)\. - -To create a Multi\-AZ DB cluster by using the RDS API, call the [ CreateDBCluster](https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_CreateDBCluster.html) operation\. Specify the `DBClusterIdentifier`\. For the `Engine` parameter, specify either `mysql` or `postgresql`\. - -For information about each option, see [Settings for creating Multi\-AZ DB clusters](#create-multi-az-db-cluster-settings)\. - -The `CreateDBCluster` operation creates the writer DB instance for your DB cluster, and two reader DB instances\. Each DB instance is in a different Availability Zone\. - -## Settings for creating Multi\-AZ DB clusters - -For details about settings that you choose when you create a Multi\-AZ DB cluster, see the following table\. For more information about the AWS CLI options, see [create\-db\-cluster](https://docs.aws.amazon.com/cli/latest/reference/rds/create-db-cluster.html)\. For more information about the RDS API parameters, see [ CreateDBCluster](https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_CreateDBCluster.html)\. - - -| Console setting | Setting description | CLI option and RDS API parameter | -| --- | --- | --- | -| **Allocated storage** | The amount of storage to allocate for each DB instance in your DB cluster \(in gibibyte\)\. For more information, see [Amazon RDS DB instance storage](CHAP_Storage.md)\. | **CLI option:** `--allocated-storage` **API parameter:** `AllocatedStorage` | -| Auto minor version upgrade | **Enable auto minor version upgrade** to have your DB cluster receive preferred minor DB engine version upgrades automatically when they become available\. Amazon RDS performs automatic minor version upgrades in the maintenance window\. | **CLI option:** `--auto-minor-version-upgrade` `--no-auto-minor-version-upgrade` **API parameter:** `AutoMinorVersionUpgrade` | -| Backup retention period | The number of days that you want automatic backups of your DB cluster to be retained\. For a Multi\-AZ DB cluster, this value must be set to **1** or greater\. For more information, see [Working with backups](USER_WorkingWithAutomatedBackups.md)\. | **CLI option:** `--backup-retention-period` **API parameter:** `BackupRetentionPeriod` | -| Backup window | The time period during which Amazon RDS automatically takes a backup of your DB cluster\. Unless you have a specific time that you want to have your database backed up, use the default of **No preference**\. For more information, see [Working with backups](USER_WorkingWithAutomatedBackups.md)\. | **CLI option:** `--preferred-backup-window` **API parameter:** `PreferredBackupWindow` | -| Copy tags to snapshots | This option copies any DB cluster tags to a DB snapshot when you create a snapshot\. For more information, see [Tagging Amazon RDS resources](USER_Tagging.md)\. | **CLI option:** `-copy-tags-to-snapshot` `-no-copy-tags-to-snapshot` **RDS API parameter:** `CopyTagsToSnapshot` | -| Database authentication | For Multi\-AZ DB clusters, only **Password authentication** is supported\. | None because password authentication is the default\. | -| Database port | The port that you want to access the DB cluster through\. The default port is shown\. The port can't be changed after the DB cluster is created\. The firewalls at some companies block connections to the default ports\. If your company firewall blocks the default port, enter another port for your DB cluster\. | **CLI option:** `--port` **RDS API parameter:** `Port` | -| DB cluster identifier | The name for your DB cluster\. Name your DB clusters in the same way that you name your on\-premises servers\. Your DB cluster identifier can contain up to 63 alphanumeric characters, and must be unique for your account in the AWS Region you chose\. | **CLI option:** `--db-cluster-identifier` **RDS API parameter:** `DBClusterIdentifier` | -| DB instance class | The compute and memory capacity of each DB instance in the Multi\-AZ DB cluster, for example `db.r6gd.xlarge`\. If possible, choose a DB instance class large enough that a typical query working set can be held in memory\. When working sets are held in memory the system can avoid writing to disk, which improves performance\. Currently, Multi\-AZ DB clusters only support db\.m5d, db\.m6gd, db\.r5d, db\.r6gd, and db\.x2iedn DB instance classes\. For more information about DB instance classes, see [DB instance classes](Concepts.DBInstanceClass.md)\. | **CLI option:** `--db-cluster-instance-class` **RDS API parameter:** `DBClusterInstanceClass` | -| **DB cluster parameter group** | The DB cluster parameter group that you want associated with the DB cluster\. For more information, see [Working with parameter groups for Multi\-AZ DB clusters](multi-az-db-clusters-concepts.md#multi-az-db-clusters-concepts-parameter-groups)\. | **CLI option:** `--db-cluster-parameter-group-name` **RDS API parameter:** `DBClusterParameterGroupName` | -| DB engine version | The version of database engine that you want to use\. | **CLI option:** `--engine-version` **RDS API parameter:** `EngineVersion` | -| DB parameter group | The DB instance parameter group that you want associated with the DB instances in the DB cluster\. For more information, see [Working with parameter groups for Multi\-AZ DB clusters](multi-az-db-clusters-concepts.md#multi-az-db-clusters-concepts-parameter-groups)\. | Not applicable\. Amazon RDS associates each DB instance with the appropriate default parameter group\. | -| DB subnet group | The DB subnet group you want to use for the DB cluster\. Select Choose existing to use an existing DB subnet group\. Then choose the required subnet group from the Existing DB subnet groups dropdown list\.Choose **Automatic setup** to let RDS select a compatible DB subnet group\. If none exist, RDS creates a new subnet group for your cluster\.For more information, see [Working with DB subnet groups](USER_VPC.WorkingWithRDSInstanceinaVPC.md#USER_VPC.Subnets)\. | **CLI option:** `--db-subnet-group-name` **RDS API parameter:** `DBSubnetGroupName` | -| Deletion protection | **Enable deletion protection** to prevent your DB cluster from being deleted\. If you create a production DB cluster with the console, deletion protection is turned on by default\. For more information, see [Deleting a DB instance](USER_DeleteInstance.md)\. | **CLI option:** `--deletion-protection` `--no-deletion-protection` **RDS API parameter:** `DeletionProtection` | -| Encryption | **Enable Encryption** to turn on encryption at rest for this DB cluster\. Encryption is turned on by default for Multi\-AZ DB clusters\. For more information, see [Encrypting Amazon RDS resources](Overview.Encryption.md)\. | **CLI options:** `--kms-key-id` `--storage-encrypted` `--no-storage-encrypted` **RDS API parameters:** `KmsKeyId` `StorageEncrypted` | -| Enhanced Monitoring | **Enable enhanced monitoring** to turn on metrics gathering in real time for the operating system that your DB cluster runs on\. For more information, see [Monitoring OS metrics with Enhanced Monitoring](USER_Monitoring.OS.md)\. | **CLI options:** `--monitoring-interval` `--monitoring-role-arn` **RDS API parameters:** `MonitoringInterval` `MonitoringRoleArn` | -| Initial database name | The name for the database on your DB cluster\. If you don't provide a name, Amazon RDS doesn't create a database on the DB cluster for MySQL\. However, it does create a database on the DB cluster for PostgreSQL\. The name can't be a word reserved by the database engine\. It has other constraints depending on the DB engine\. MySQL: [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/create-multi-az-db-cluster.html) PostgreSQL: [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/create-multi-az-db-cluster.html) | **CLI option:** `--database-name` **RDS API parameter:** `DatabaseName` | -| **Log exports** | The types of database log files to publish to Amazon CloudWatch Logs\. For more information, see [Publishing database logs to Amazon CloudWatch Logs](USER_LogAccess.Procedural.UploadtoCloudWatch.md)\. | **CLI option:** `-enable-cloudwatch-logs-exports` **RDS API parameter:** `EnableCloudwatchLogsExports` | -| Maintenance window | The 30\-minute window in which pending modifications to your DB cluster are applied\. If the time period doesn't matter, choose **No preference**\. For more information, see [The Amazon RDS maintenance window](USER_UpgradeDBInstance.Maintenance.md#Concepts.DBMaintenance)\. | **CLI option:** `--preferred-maintenance-window` **RDS API parameter:** `PreferredMaintenanceWindow` | -| Manage master credentials in AWS Secrets Manager | Select **Manage master credentials in AWS Secrets Manager** to manage the master user password in a secret in Secrets Manager\. Optionally, choose a KMS key to use to protect the secret\. Choose from the KMS keys in your account, or enter the key from a different account\. For more information, see [Password management with Amazon RDS and AWS Secrets Manager](rds-secrets-manager.md)\. | **CLI option:** `--manage-master-user-password \| --no-manage-master-user-password` `--master-user-secret-kms-key-id` **RDS API parameter:** `ManageMasterUserPassword` `MasterUserSecretKmsKeyId` | -| Master password | The password for your master user account\. | **CLI option:** `--master-user-password` **RDS API parameter:** `MasterUserPassword` | -| Master username | The name that you use as the master user name to log on to your DB cluster with all database privileges\. [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/create-multi-az-db-cluster.html) You can't change the master user name after the Multi\-AZ DB cluster is created\. For more information on privileges granted to the master user, see [Master user account privileges](UsingWithRDS.MasterAccounts.md)\. | **CLI option:** `--master-username` **RDS API parameter:** `MasterUsername` | -| Performance Insights | **Enable Performance Insights** to monitor your DB cluster load so that you can analyze and troubleshoot your database performance\. Choose a retention period to determine how much Performance Insights data history to keep\. The retention setting in the free tier is **Default \(7 days\)**\. To retain your performance data for longer, specify 1–24 months\. For more information about retention periods, see [Pricing and data retention for Performance Insights](USER_PerfInsights.Overview.cost.md)\. Choose a master key to use to protect the key used to encrypt this database volume\. Choose from the master keys in your account, or enter the key from a different account\. For more information, see [Monitoring DB load with Performance Insights on Amazon RDS](USER_PerfInsights.md)\. | **CLI options:** `--enable-performance-insights` `--no-enable-performance-insights` `--performance-insights-retention-period` `--performance-insights-kms-key-id` **RDS API parameters:** `EnablePerformanceInsights` `PerformanceInsightsRetentionPeriod` `PerformanceInsightsKMSKeyId` | -| Provisioned IOPS | The amount of Provisioned IOPS \(input/output operations per second\) to be initially allocated for the DB cluster\. This setting is available only if Provisioned IOPS \(`io1`\) is selected as the storage type\. For more information, see [Provisioned IOPS SSD storage](CHAP_Storage.md#USER_PIOPS)\. | **CLI option:** `--iops` **RDS API parameter:** `Iops` | -| Public access | **Publicly accessible** to give the DB cluster a public IP address, meaning that it's accessible outside the VPC\. To be publicly accessible, the DB cluster also has to be in a public subnet in the VPC\. **Not publicly accessible** to make the DB cluster accessible only from inside the VPC\. For more information, see [Hiding a DB instance in a VPC from the internet](USER_VPC.WorkingWithRDSInstanceinaVPC.md#USER_VPC.Hiding)\. To connect to a DB cluster from outside of its VPC, the DB cluster must be publicly accessible\. Also, access must be granted using the inbound rules of the DB cluster's security group, and other requirements must be met\. For more information, see [Can't connect to Amazon RDS DB instance](CHAP_Troubleshooting.md#CHAP_Troubleshooting.Connecting)\. If your DB cluster isn't publicly accessible, you can use an AWS Site\-to\-Site VPN connection or an AWS Direct Connect connection to access it from a private network\. For more information, see [Internetwork traffic privacy](inter-network-traffic-privacy.md)\. | **CLI option:** `--publicly-accessible` `--no-publicly-accessible` **RDS API parameter:** `PubliclyAccessible` | -| Storage type | The storage type for your DB cluster\. Only Provisioned IOPS \(io1\) storage is supported\. General Purpose \(gp2\) and General Purpose \(gp3\) storage aren't supported\. For more information, see [Amazon RDS storage types](CHAP_Storage.md#Concepts.Storage)\. | **CLI option:** `--storage-type` **RDS API parameter:** `StorageType` | -| Virtual Private Cloud \(VPC\) | A VPC based on the Amazon VPC service to associate with this DB cluster\. For more information, see [Amazon VPC VPCs and Amazon RDS](USER_VPC.md)\. | For the CLI and API, you specify the VPC security group IDs\. | -| VPC security group \(firewall\) | The security groups to associate with the DB cluster\. For more information, see [Overview of VPC security groups](Overview.RDSSecurityGroups.md#Overview.RDSSecurityGroups.VPCSec)\. | **CLI option:** `--vpc-security-group-ids` **RDS API parameter:** `VpcSecurityGroupIds` | - -## Settings that don't apply when creating Multi\-AZ DB clusters - -The following settings in the AWS CLI command [https://docs.aws.amazon.com/cli/latest/reference/rds/create-db-cluster.html](https://docs.aws.amazon.com/cli/latest/reference/rds/create-db-cluster.html) and the RDS API operation [https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_CreateDBCluster.html](https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_CreateDBCluster.html) don't apply to Multi\-AZ DB clusters\. - -You also can't specify these settings for Multi\-AZ DB clusters in the console\. - - -| AWS CLI setting | RDS API setting | -| --- | --- | -| `--availability-zones` | `AvailabilityZones` | -| `--backtrack-window` | `BacktrackWindow` | -| `--character-set-name` | `CharacterSetName` | -| `--domain` | `Domain` | -| `--domain-iam-role-name` | `DomainIAMRoleName` | -| `--enable-global-write-forwarding \| --no-enable-global-write-forwarding` | `EnableGlobalWriteForwarding` | -| `--enable-http-endpoint \| --no-enable-http-endpoint` | `EnableHttpEndpoint` | -| `--enable-iam-database-authentication \| --no-enable-iam-database-authentication` | `EnableIAMDatabaseAuthentication` | -| `--global-cluster-identifier` | `GlobalClusterIdentifier` | -| `--option-group-name` | `OptionGroupName` | -| `--pre-signed-url` | `PreSignedUrl` | -| `--replication-source-identifier` | `ReplicationSourceIdentifier` | -| `--scaling-configuration` | `ScalingConfiguration` | \ No newline at end of file diff --git a/doc_source/creating-elasticache-cluster-with-RDS-settings.md b/doc_source/creating-elasticache-cluster-with-RDS-settings.md deleted file mode 100644 index 7750e66..0000000 --- a/doc_source/creating-elasticache-cluster-with-RDS-settings.md +++ /dev/null @@ -1,128 +0,0 @@ -# Creating an Amazon ElastiCache cluster using Amazon RDS DB instance settings - -ElastiCache is a fully managed, in\-memory caching service that provides microsecond read and write latencies that support flexible, real\-time use cases\. ElastiCache can help you accelerate application and database performance\. You can use ElastiCache as a primary data store for use cases that don't require data durability, such as gaming leaderboards, streaming, and data analytics\. ElastiCache helps remove the complexity associated with deploying and managing a distributed computing environment\. For more information, see [Common ElastiCache Use Cases and How ElastiCache Can Help](https://docs.aws.amazon.com/AmazonElastiCache/latest/mem-ug/elasticache-use-cases.html) for Memcached and [Common ElastiCache Use Cases and How ElastiCache Can Help](https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/elasticache-use-cases.html) for Redis\. You can use the Amazon RDS console for creating ElastiCache clusters\. - -Amazon ElastiCache works with both the Redis and Memcached engines\. If you're unsure which engine you want to use, see [Comparing Memcached and Redis](https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/SelectEngine.html)\. For more information about Amazon ElastiCache, see the [Amazon ElastiCache User Guide](https://docs.aws.amazon.com/AmazonElastiCache/latest/UserGuide/)\. - -**Topics** -+ [Overview of ElastiCache cluster creation with RDS DB instance settings](#creating-elasticache-cluster-with-RDS-settings-overview) -+ [Creating an ElastiCache cluster with settings from a new RDS DB instance](#creating-elasticache-cluster-with-RDS-settings-new-DB) -+ [Creating an ElastiCache cluster with settings from an existing RDS DB instance](#creating-elasticache-cluster-with-RDS-settings-existing-DB) - -## Overview of ElastiCache cluster creation with RDS DB instance settings - -You can create an ElastiCache cluster from Amazon RDS using the same configuration settings as a newly created or existing RDS DB instance\. - -You can use the newly created ElastiCache cluster in your applications as a primary data store for applications that don't require data durability\. Your applications that use Redis or Memcached can use ElastiCache with almost no modification\. - -When you create an ElastiCache cluster from RDS, the ElastiCache cluster inherits the following settings from the associated RDS DB instance: -+ ElastiCache connectivity settings -+ ElastiCache security settings - -You can also set the cluster configuration settings according to your requirements\. - -### Setting up ElastiCache in your applications - -Your applications must be set up to utilize ElastiCache clusters\. You can also optimize and improve cluster performance by setting up your applications to use caching strategies depending on your requirements\. -+ To access your ElastiCache cluster and get started, see [Getting started with Amazon ElastiCache for Redis](https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/GettingStarted.html) and [Getting started with Amazon ElastiCache for Memcached](https://docs.aws.amazon.com/AmazonElastiCache/latest/mem-ug/GettingStarted.html)\. -+ For more information about caching strategies, see [Caching strategies and best practices](https://docs.aws.amazon.com/AmazonElastiCache/latest/mem-ug/BestPractices.html) for Memcached and [Caching strategies and best practices](https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/BestPractices.html) for Redis\. -+ For more information about high availability in ElastiCache for Redis clusters, see [ High availability using replication groups](https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/BestPractices.html)\. -+ You might incur costs associated with backup storage, data transfer within or across regions, or use of AWS Outposts\. For pricing details, see [ Amazon ElastiCache pricing](http://aws.amazon.com/elasticache/pricing/)\. - -## Creating an ElastiCache cluster with settings from a new RDS DB instance - - After creating a new RDS DB instance in the RDS console, you can create add\-ons for your RDS DB instance from the **Suggested add\-ons** window\. - -In the **Suggested add\-ons** window, you can create an ElastiCache cluster from RDS with the same settings as your newly created RDS DB instance\. - -**Create an ElastiCache cluster with settings from a new DB instance** - -1. To create a DB instance, follow the instructions in [Creating an Amazon RDS DB instance](USER_CreateDBInstance.md)\. - -1. After creating a new RDS DB instance, the console displays the **Suggested add\-ons** window\. Select **Create an ElastiCache cluster from RDS using your DB settings**\. - - In the **ElastiCache configuration section**, the **Source DB identifier** displays which DB instance the ElastiCache cluster inherits settings from\. - -1. Choose whether you want to create a Redis or Memcached cluster\. For more information, see [Comparing Memcached and Redis](https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/SelectEngine.html)\. - - If you choose **Redis cluster**, then choose whether you want to keep the cluster mode **Enabled** or **Disabled**\. For more information, see [ Replication: Redis \(Cluster Mode Disabled\) vs\. Redis \(Cluster Mode Enabled\)](https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/Replication.Redis-RedisCluster.html)\. -![\[Choose cluster type and cluster mode.\]](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/images/EC-RDS-Config.png) - -1. Enter values for **Name**, **Description**, and **Engine version**\. - - For **Engine version**, the recommended default value is the latest engine version\. You can also choose an **Engine version** for the ElastiCache cluster that best meets your requirements\. - -1. Choose the node type in the **Node type** option\. For more information, see [Managing nodes](https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/CacheNodes.html)\. - - If you choose to create a Redis cluster with the **Cluster mode** set to **Enabled**, then enter the number of shards \(partitions/node groups\) in the **Number of shards** option\. - - Enter the number of replicas of each shard in **Number of replicas**\. -**Note** -The selected node type, the number of shards, and the number of replicas all affect your cluster performance and resource costs\. Be sure these settings match your database needs\. For pricing information, see [Amazon ElastiCache pricing](http://aws.amazon.com/elasticache/pricing/)\. - -1. Confirm the ElastiCache connectivity settings\. - - RDS automatically fills the **Port** and the **Network type**\. ElastiCache creates an equivalent **Subnet group** from the source database\. To customize these settings, select **Customize your connectivity settings**\. -![\[Confirm or customize your connectivity settings.\]](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/images/EC-RDS-cnnct-sttngs.png) - -1. Confirm the ElastiCache security settings\. - - ElastiCache provides the default values for **Encryption at rest**, **Encryption key**, **Encryption in transit**, **Access control**, and **Security groups**\. To customize these settings, select **Customize your security settings**\. -![\[Confirm or customize your security settings.\]](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/images/EC-RDS-sec-sttngs.png) - -1. Verify the default and inherited settings of your ElastiCache cluster\. Some settings can't be changed after creation\. -**Note** -RDS might adjust the backup window of your ElastiCache cluster to meet the minimum window requirement of 60 minutes\. The backup window of your source database remains the same\. - -1. When you're ready, choose **Create ElastiCache cluster**\. - -The console displays a confirmation banner for the ElastiCache cluster creation\. Follow the link in the banner to the ElastiCache console to view the cluster details\. The ElastiCache console displays the newly created ElastiCache cluster\. - -## Creating an ElastiCache cluster with settings from an existing RDS DB instance - -You can create an ElastiCache cluster for your existing RDS DB instances from the **Actions** dropdown menu in the console\. - -**Create an ElastiCache cluster with settings from an existing DB instance** - -1. In the **Databases** page, select the required DB instance\. - -1. In the **Actions** dropdown menu, choose **Create ElastiCache cluster** to create an ElastiCache cluster in RDS that has the same settings as your existing RDS DB instance\. - - In the **ElastiCache configuration section**, the **Source DB identifier** shows which DB instance the ElastiCache cluster inherits settings from\. - -1. Choose whether you want to create a Redis or Memcached cluster\. For more information, see [Comparing Memcached and Redis](https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/SelectEngine.html)\. - - If you choose **Redis cluster**, then choose whether you want to keep the cluster mode **Enabled** or **Disabled**\. For more information, see [ Replication: Redis \(Cluster Mode Disabled\) vs\. Redis \(Cluster Mode Enabled\)](https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/Replication.Redis-RedisCluster.html)\. -![\[Choose cluster type and cluster mode.\]](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/images/EC-RDS-Config.png) - -1. Enter values for **Name**, **Description**, and **Engine version**\. - - For **Engine version**, the recommended default value is the latest engine version\. You can also choose an **Engine version** for the ElastiCache cluster that best meets your requirements\. - -1. Choose the node type in the **Node type** option\. For more information, see [Managing nodes](https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/CacheNodes.html)\. - - If you choose to create a Redis cluster with the **Cluster mode** set to **Enabled**, then enter the number of shards \(partitions/node groups\) in the **Number of shards** option\. - - Enter the number of replicas of each shard in **Number of replicas**\. -**Note** -The selected node type, the number of shards, and the number of replicas all affect your cluster performance and resource costs\. Be sure these settings match your database needs\. For pricing information, see [Amazon ElastiCache pricing](http://aws.amazon.com/elasticache/pricing/)\. - -1. Confirm the ElastiCache connectivity settings\. - - RDS automatically fills the **Port** and the **Network type**\. ElastiCache creates an equivalent **Subnet group** from the source database\. To customize these settings, select **Customize your connectivity settings**\. -![\[Confirm or customize your connectivity settings.\]](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/images/EC-RDS-cnnct-sttngs.png) - - - -1. Confirm the ElastiCache security settings\. - - ElastiCache provides the default values for **Encryption at rest**, **Encryption key**, **Encryption in transit**, **Access control**, and **Security groups**\. To customize these settings, select **Customize your security settings**\. -![\[Confirm or customize your security settings.\]](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/images/EC-RDS-sec-sttngs.png) - -1. Verify the default and inherited settings of your ElastiCache cluster\. Some settings can't be changed after creation\. -**Note** -RDS might adjust the backup window of your ElastiCache cluster to meet the minimum window requirement of 60 minutes\. The backup window of your source database remains the same\. - -1. When you're ready, choose **Create ElastiCache cluster**\. - -The console displays a confirmation banner for the ElastiCache cluster creation\. Follow the link in the banner to the ElastiCache console to view the cluster details\. The ElastiCache console displays the newly created ElastiCache cluster\. \ No newline at end of file diff --git a/doc_source/creating-resources-with-cloudformation.md b/doc_source/creating-resources-with-cloudformation.md deleted file mode 100644 index 3e7d0c0..0000000 --- a/doc_source/creating-resources-with-cloudformation.md +++ /dev/null @@ -1,19 +0,0 @@ -# Creating Amazon RDS resources with AWS CloudFormation - -Amazon RDS is integrated with AWS CloudFormation, a service that helps you to model and set up your AWS resources so that you can spend less time creating and managing your resources and infrastructure\. You create a template that describes all the AWS resources that you want \(such as DB instances and DB parameter groups\), and AWS CloudFormation provisions and configures those resources for you\. - -When you use AWS CloudFormation, you can reuse your template to set up your RDS resources consistently and repeatedly\. Describe your resources once, and then provision the same resources over and over in multiple AWS accounts and Regions\. - -## RDS and AWS CloudFormation templates - -To provision and configure resources for RDS and related services, you must understand [AWS CloudFormation templates](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/template-guide.html)\. Templates are formatted text files in JSON or YAML\. These templates describe the resources that you want to provision in your AWS CloudFormation stacks\. If you're unfamiliar with JSON or YAML, you can use AWS CloudFormation Designer to help you get started with AWS CloudFormation templates\. For more information, see [What is AWS CloudFormation Designer?](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/working-with-templates-cfn-designer.html) in the *AWS CloudFormation User Guide*\. - -RDS supports creating resources in AWS CloudFormation\. For more information, including examples of JSON and YAML templates for these resources, see the [RDS resource type reference](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/AWS_RDS.html) in the *AWS CloudFormation User Guide*\. - -## Learn more about AWS CloudFormation - -To learn more about AWS CloudFormation, see the following resources: -+ [AWS CloudFormation](http://aws.amazon.com/cloudformation/) -+ [AWS CloudFormation User Guide](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/Welcome.html) -+ [AWS CloudFormation API Reference](https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/Welcome.html) -+ [AWS CloudFormation Command Line Interface User Guide](https://docs.aws.amazon.com/cloudformation-cli/latest/userguide/what-is-cloudformation-cli.html) \ No newline at end of file diff --git a/doc_source/creating_alarms.md b/doc_source/creating_alarms.md deleted file mode 100644 index 872f121..0000000 --- a/doc_source/creating_alarms.md +++ /dev/null @@ -1,55 +0,0 @@ -# Creating CloudWatch alarms to monitor Amazon RDS - -You can create a CloudWatch alarm that sends an Amazon SNS message when the alarm changes state\. An alarm watches a single metric over a time period that you specify\. The alarm can also perform one or more actions based on the value of the metric relative to a given threshold over a number of time periods\. The action is a notification sent to an Amazon SNS topic or Amazon EC2 Auto Scaling policy\. - -Alarms invoke actions for sustained state changes only\. CloudWatch alarms don't invoke actions simply because they are in a particular state\. The state must have changed and have been maintained for a specified number of time periods\. The following procedures show how to create alarms for Amazon RDS\. - -**To set alarms using the CloudWatch console** - -1. Sign in to the AWS Management Console and open the CloudWatch console at [https://console\.aws\.amazon\.com/cloudwatch/](https://console.aws.amazon.com/cloudwatch/)\. - -1. Choose **Alarms**, **All alarms**\. - - Choose **Create an alarm**\. - - This action launches a wizard\. - -1. Choose **Select metric**\. - -1. In **Browse**, choose **RDS**\. - -1. Search for the metric that you want to place an alarm on\. For example, search for **CPUUtilization**\. To display only Amazon RDS metrics, search for the identifier of your resource\. - -1. Choose the metric to create an alarm on\. Then choose **Select metric**\. - -1. In **Conditions**, define the alarm condition\. Then choose **Next**\. - - For example, you can specify that the alarm should be set when CPU utilization is over 75%\. - -1. Choose your notification method\. Then choose **Next**\. - - For example, to configure CloudWatch to send you an email when the alarm state is reached, do the following: - - 1. Choose **Create new topic** \(if one doesn't exist\)\. - - 1. Enter a topic name\. - - 1. Enter the email endpoints\. - - The email addresses must be verified before they receive notifications\. Emails are only sent when the alarm enters an alarm state\. If this alarm state change happens before the email addresses are verified, the addresses don't receive a notification\. - - 1. Choose **Create topic**\. - - 1. Choose **Next**\. - -1. Enter a name and description for the alarm\. The name must contain only ASCII characters\. Then choose **Next**\. - -1. Preview the alarm that you're about to create\. Then choose **Create alarm**\. - -**To set an alarm using the AWS CLI** -+ Call [https://docs.aws.amazon.com/cli/latest/reference/cloudwatch/put-metric-alarm.html](https://docs.aws.amazon.com/cli/latest/reference/cloudwatch/put-metric-alarm.html)\. For more information, see *[AWS CLI Command Reference](https://docs.aws.amazon.com/cli/latest/reference/)*\. - -**To set an alarm using the CloudWatch API** -+ Call [https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_PutMetricAlarm.html](https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_PutMetricAlarm.html)\. For more information, see *[Amazon CloudWatch API Reference](https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/)* - -For more information about setting up Amazon SNS topics and creating alarms, see [Using Amazon CloudWatch alarms](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/AlarmThatSendsEmail.html)\. \ No newline at end of file diff --git a/doc_source/cross-service-confused-deputy-prevention.md b/doc_source/cross-service-confused-deputy-prevention.md deleted file mode 100644 index 6c6ddd7..0000000 --- a/doc_source/cross-service-confused-deputy-prevention.md +++ /dev/null @@ -1,47 +0,0 @@ -# Preventing cross\-service confused deputy problems - -The *confused deputy problem* is a security issue where an entity that doesn't have permission to perform an action can coerce a more\-privileged entity to perform the action\. In AWS, cross\-service impersonation can result in the confused deputy problem\. - -Cross\-service impersonation can occur when one service \(the *calling service*\) calls another service \(the *called service*\)\. The calling service can be manipulated to use its permissions to act on another customer's resources in a way that it shouldn't have permission to access\. To prevent this, AWS provides tools that can help you protect your data for all services with service principals that have been given access to resources in your account\. For more information, see [The confused deputy problem](https://docs.aws.amazon.com/IAM/latest/UserGuide/confused-deputy.html) in the *IAM User Guide*\. - -To limit the permissions that Amazon RDS gives another service for a specific resource, we recommend using the [https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies_condition-keys.html#condition-keys-sourcearn](https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies_condition-keys.html#condition-keys-sourcearn) and [https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies_condition-keys.html#condition-keys-sourceaccount](https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies_condition-keys.html#condition-keys-sourceaccount) global condition context keys in resource policies\. - -In some cases, the `aws:SourceArn` value doesn't contain the account ID, for example when you use the Amazon Resource Name \(ARN\) for an Amazon S3 bucket\. In these cases, make sure to use both global condition context keys to limit permissions\. In some cases, you use both global condition context keys and the `aws:SourceArn` value contains the account ID\. In these cases, make sure that the `aws:SourceAccount` value and the account in the `aws:SourceArn` use the same account ID when they're used in the same policy statement\. If you want only one resource to be associated with the cross\-service access, use `aws:SourceArn`\. If you want to allow any resource in the specified AWS account to be associated with the cross\-service use, use `aws:SourceAccount`\. - -Make sure that the value of `aws:SourceArn` is an ARN for an Amazon RDS resource type\. For more information, see [Working with Amazon Resource Names \(ARNs\) in Amazon RDS](USER_Tagging.ARN.md)\. - -The most effective way to protect against the confused deputy problem is to use the `aws:SourceArn` global condition context key with the full ARN of the resource\. In some cases, you might not know the full ARN of the resource or you might be specifying multiple resources\. In these cases, use the `aws:SourceArn` global context condition key with wildcards \(`*`\) for the unknown portions of the ARN\. An example is `arn:aws:rds:*:123456789012:*`\. - -The following example shows how you can use the `aws:SourceArn` and `aws:SourceAccount` global condition context keys in Amazon RDS to prevent the confused deputy problem\. - -``` -{ - "Version": "2012-10-17", - "Statement": { - "Sid": "ConfusedDeputyPreventionExamplePolicy", - "Effect": "Allow", - "Principal": { - "Service": "rds.amazonaws.com" - }, - "Action": "sts:AssumeRole", - "Condition": { - "ArnLike": { - "aws:SourceArn": "arn:aws:rds:us-east-1:123456789012:db:mydbinstance" - }, - "StringEquals": { - "aws:SourceAccount": "123456789012" - } - } - } -} -``` - -For more examples of policies that use the `aws:SourceArn` and `aws:SourceAccount` global condition context keys, see the following sections: -+ [Granting permissions to publish notifications to an Amazon SNS topic](USER_Events.GrantingPermissions.md) -+ [Manually creating an IAM role for native backup and restore](SQLServer.Procedural.Importing.md#SQLServer.Procedural.Importing.Native.Enabling.IAM) -+ [Setting up Windows Authentication for SQL Server DB instances](USER_SQLServerWinAuth.md#USER_SQLServerWinAuth.SettingUp) -+ [Prerequisites for integrating RDS for SQL Server with S3](User.SQLServer.Options.S3-integration.md#Appendix.SQLServer.Options.S3-integration.preparing) -+ [Manually creating an IAM role for SQL Server Audit](Appendix.SQLServer.Options.Audit.md#Appendix.SQLServer.Options.Audit.IAM) -+ [Configuring IAM permissions for RDS for Oracle integration with Amazon S3](oracle-s3-integration.md#oracle-s3-integration.preparing) -+ [Setting up access to an Amazon S3 bucket](USER_PostgreSQL.S3Import.md#USER_PostgreSQL.S3Import.AccessPermission) \(PostgreSQL import\) -+ [Setting up access to an Amazon S3 bucket](postgresql-s3-export.md#postgresql-s3-export-access-bucket) \(PostgreSQL export\) \ No newline at end of file diff --git a/doc_source/custom-backup-sqlserver.md b/doc_source/custom-backup-sqlserver.md deleted file mode 100644 index 0b2cc5c..0000000 --- a/doc_source/custom-backup-sqlserver.md +++ /dev/null @@ -1,355 +0,0 @@ -# Backing up and restoring an Amazon RDS Custom for SQL Server DB instance - -Like Amazon RDS, RDS Custom creates and saves automated backups of your RDS Custom for SQL Server DB instance during the backup window of your DB instance\. You can also back up your DB instance manually\. - -The procedure is identical to taking a snapshot of an Amazon RDS DB instance\. The first snapshot of an RDS Custom DB instance contains the data for the full DB instance\. Subsequent snapshots are incremental\. - -Restore DB snapshots using either the AWS Management Console or the AWS CLI\. - -**Topics** -+ [Creating an RDS Custom for SQL Server snapshot](#custom-backup-sqlserver.creating) -+ [Restoring from an RDS Custom for SQL Server DB snapshot](#custom-backup-sqlserver.restoring) -+ [Restoring an RDS Custom for SQL Server instance to a point in time](#custom-backup.pitr-sqs) -+ [Deleting an RDS Custom for SQL Server snapshot](#custom-backup-sqlserver.deleting) -+ [Deleting RDS Custom for SQL Server automated backups](#custom-backup-sqlserver.deleting-backups) - -## Creating an RDS Custom for SQL Server snapshot - -RDS Custom for SQL Server creates a storage volume snapshot of your DB instance, backing up the entire DB instance and not just individual databases\. When you create a snapshot, specify which RDS Custom for SQL Server DB instance to back up\. Give your snapshot a name so you can restore from it later\. - -When you create a snapshot, RDS Custom for SQL Server creates an Amazon EBS snapshot for every volume attached to the DB instance\. RDS Custom for SQL Server uses the EBS snapshot of the root volume to register a new Amazon Machine Image \(AMI\)\. To make snapshots easy to associate with a specific DB instance, they're tagged with `DBSnapshotIdentifier`, `DbiResourceId`, and `VolumeType`\. - -Creating a DB snapshot results in a brief I/O suspension\. This suspension can last from a few seconds to a few minutes, depending on the size and class of your DB instance\. The snapshot creation time varies with the size of your database\. Because the snapshot includes the entire storage volume, the size of files, such as temporary files, also affects snapshot creation time\. To learn more about creating snapshots, see [Creating a DB snapshot](USER_CreateSnapshot.md)\. - -Create an RDS Custom for SQL Server snapshot using the console or the AWS CLI\. - -### Console - -**To create an RDS Custom snapshot** - -1. Sign in to the AWS Management Console and open the Amazon RDS console at [https://console\.aws\.amazon\.com/rds/](https://console.aws.amazon.com/rds/)\. - -1. In the navigation pane, choose **Databases**\. - -1. In the list of RDS Custom DB instances, choose the instance for which you want to take a snapshot\. - -1. For **Actions**, choose **Take snapshot**\. - - The **Take DB snapshot** window appears\. - -1. For **Snapshot name**, enter the name of the snapshot\. - -1. Choose **Take snapshot**\. - -### AWS CLI - -You create a snapshot of an RDS Custom DB instance by using the [create\-db\-snapshot](https://docs.aws.amazon.com/cli/latest/reference/rds/create-db-snapshot.html) AWS CLI command\. - -Specify the following options: -+ `--db-instance-identifier` – Identifies which RDS Custom DB instance you are going to back up -+ `--db-snapshot-identifier` – Names your RDS Custom snapshot so you can restore from it later - -In this example, you create a DB snapshot called *`my-custom-snapshot`* for an RDS Custom DB instance called `my-custom-instance`\. - -**Example** -For Linux, macOS, or Unix: - -``` -1. aws rds create-db-snapshot \ -2. --db-instance-identifier my-custom-instance \ -3. --db-snapshot-identifier my-custom-snapshot -``` -For Windows: - -``` -1. aws rds create-db-snapshot ^ -2. --db-instance-identifier my-custom-instance ^ -3. --db-snapshot-identifier my-custom-snapshot -``` - -## Restoring from an RDS Custom for SQL Server DB snapshot - -When you restore an RDS Custom for SQL Server DB instance, you provide the name of the DB snapshot and a name for the new instance\. You can't restore from a snapshot to an existing RDS Custom DB instance\. A new RDS Custom for SQL Server DB instance is created when you restore\. - -The restore process differs in the following ways from restore in Amazon RDS: -+ Before restoring a snapshot, RDS Custom for SQL Server backs up existing configuration files\. These files are available on the restored instance in the directory `/rdsdbdata/config/backup`\. RDS Custom for SQL Server restores the DB snapshot with default parameters and overwrites the previous database configuration files with existing ones\. Thus, the restored instance doesn't preserve custom parameters and changes to database configuration files\. -+ The restored database has the same name as in the snapshot\. You can't specify a different name\. - -### Console - -**To restore an RDS Custom DB instance from a DB snapshot** - -1. Sign in to the AWS Management Console and open the Amazon RDS console at [https://console\.aws\.amazon\.com/rds/](https://console.aws.amazon.com/rds/)\. - -1. In the navigation pane, choose **Snapshots**\. - -1. Choose the DB snapshot that you want to restore from\. - -1. For **Actions**, choose **Restore snapshot**\. - -1. On the **Restore DB instance** page, for **DB instance identifier**, enter the name for your restored RDS Custom DB instance\. - -1. Choose **Restore DB instance**\. - -### AWS CLI - -You restore an RDS Custom DB snapshot by using the [ restore\-db\-instance\-from\-db\-snapshot](https://docs.aws.amazon.com/cli/latest/reference/rds/restore-db-instance-from-db-snapshot.html) AWS CLI command\. - -If the snapshot you are restoring from is for a private DB instance, make sure to specify both the correct `db-subnet-group-name` and `no-publicly-accessible`\. Otherwise, the DB instance defaults to publicly accessible\. The following options are required: -+ `db-snapshot-identifier` – Identifies the snapshot from which to restore -+ `db-instance-identifier` – Specifies the name of the RDS Custom DB instance to create from the DB snapshot -+ `custom-iam-instance-profile` – Specifies the instance profile associated with the underlying Amazon EC2 instance of an RDS Custom DB instance\. - -The following code restores the snapshot named `my-custom-snapshot` for `my-custom-instance`\. - -**Example** -For Linux, macOS, or Unix: - -``` -aws rds restore-db-instance-from-db-snapshot \ - --db-snapshot-identifier my-custom-snapshot \ - --db-instance-identifier my-custom-instance \ - --custom-iam-instance-profile AWSRDSCustomInstanceProfileForRdsCustomInstance \ - --no-publicly-accessible -``` -For Windows: - -``` -aws rds restore-db-instance-from-db-snapshot ^ - --db-snapshot-identifier my-custom-snapshot ^ - --db-instance-identifier my-custom-instance ^ - --custom-iam-instance-profile AWSRDSCustomInstanceProfileForRdsCustomInstance ^ - --no-publicly-accessible -``` - -## Restoring an RDS Custom for SQL Server instance to a point in time - -You can restore a DB instance to a specific point in time \(PITR\), creating a new DB instance\. To support PITR, your DB instances must have backup retention set to a nonzero value\. - -The latest restorable time for an RDS Custom for SQL Server DB instance depends on several factors, but is typically within 5 minutes of the current time\. To see the latest restorable time for a DB instance, use the AWS CLI [describe\-db\-instances](https://docs.aws.amazon.com/cli/latest/reference/rds/describe-db-instances.html) command and look at the value returned in the `LatestRestorableTime` field for the DB instance\. To see the latest restorable time for each DB instance in the Amazon RDS console, choose **Automated backups**\. - -You can restore to any point in time within your backup retention period\. To see the earliest restorable time for each DB instance, choose **Automated backups** in the Amazon RDS console\. - -For general information about PITR, see [Restoring a DB instance to a specified time](USER_PIT.md)\. - -**Topics** -+ [PITR considerations for RDS Custom for SQL Server](#custom-backup.pitr.sqlserver) - -### PITR considerations for RDS Custom for SQL Server - -In RDS Custom for SQL Server, PITR differs in the following important ways from PITR in Amazon RDS: -+ PITR only restores the databases in the DB instance\. It doesn't restore the operating system or files on the C: drive\. -+ For an RDS Custom for SQL Server DB instance, a database is backed up automatically and is eligible for PITR only under the following conditions: - + The database is online\. - + Its recovery model is set to `FULL`\. - + It's writable\. - + It has its physical files on the D: drive\. - + It's not listed in the `rds_pitr_blocked_databases` table\. For more information, see [Making databases ineligible for PITR](#custom-backup.pitr.sqlserver.ineligible)\. -+ RDS Custom for SQL Server allows up to 5,000 databases per DB instance\. However, the maximum number of databases restored by a PITR operation for an RDS Custom for SQL Server DB instance is 100\. The 100 databases are determined by the order of their database ID\. - - Other databases that aren't part of PITR can be restored from DB snapshots, including the automated backups used for PITR\. -+ Adding a new database, renaming a database, or restoring a database that is eligible for PITR initiates a snapshot of the DB instance\. -+ Restored databases have the same name as in the source DB instance\. You can't specify a different name\. -+ `AWSRDSCustomSQLServerIamRolePolicy` requires new permissions\. For more information, see [Add an access policy to AWSRDSCustomSQLServerInstanceRole](custom-setup-sqlserver.md#custom-setup-sqlserver.iam.add-policy)\. -+ Time zone changes aren't supported for RDS Custom for SQL Server\. If you change the operating system or DB instance time zone, PITR \(and other automation\) doesn't work\. - -#### Making databases ineligible for PITR - -You can specify that certain RDS Custom for SQL Server databases aren't part of automated backups and PITR\. To do this, put their `database_id` values into a `rds_pitr_blocked_databases` table\. Use the following SQL script to create the table\. - -**To create the rds\_pitr\_blocked\_databases table** -+ Run the following SQL script\. - - ``` - create table msdb..rds_pitr_blocked_databases - ( - database_id INT NOT NULL, - database_name SYSNAME NOT NULL, - db_entry_updated_date datetime NOT NULL DEFAULT GETDATE(), - db_entry_updated_by SYSNAME NOT NULL DEFAULT CURRENT_USER, - PRIMARY KEY (database_id) - ); - ``` - -For the list of eligible and ineligible databases, see the `RI.End` file in the `RDSCustomForSQLServer/Instances/DB_instance_resource_ID/TransactionLogMetadata` directory in the Amazon S3 bucket `do-not-delete-rds-custom-$ACCOUNT_ID-$REGION-unique_identifier`\. For more information about the `RI.End` file, see [Transaction logs in Amazon S3](#custom-backup.pitr.sqlserver.tlogs)\. - -#### Transaction logs in Amazon S3 - -The backup retention period determines whether transaction logs for RDS Custom for SQL Server DB instances are automatically extracted and uploaded to Amazon S3\. A nonzero value means that automatic backups are created, and that the RDS Custom agent uploads the transaction logs to S3 every 5 minutes\. - -Transaction log files on S3 are encrypted at rest using the AWS KMS key that you provided when you created your DB instance\. For more information, see [Protecting data using server\-side encryption](https://docs.aws.amazon.com/AmazonS3/latest/userguide/serv-side-encryption.html) in the *Amazon Simple Storage Service User Guide*\. - -The transaction logs for each database are uploaded to an S3 bucket named `do-not-delete-rds-custom-$ACCOUNT_ID-$REGION-unique_identifier`\. The `RDSCustomForSQLServer/Instances/DB_instance_resource_ID` directory in the S3 bucket contains two subdirectories: -+ `TransactionLogs` – Contains the transaction logs for each database and their respective metadata\. - - The transaction log file name follows the pattern `yyyyMMddHHmm.database_id.timestamp`, for example: - - ``` - 202110202230.11.1634769287 - ``` - - The same file name with the suffix `_metadata` contains information about the transaction log such as log sequence numbers, database name, and `RdsChunkCount`\. `RdsChunkCount` determines how many physical files represent a single transaction log file\. You might see files with suffixes `_0001`, `_0002`, and so on, which mean the physical chunks of a transaction log file\. If you want to use a chunked transaction log file, make sure to merge the chunks after downloading them\. - - Consider a scenario where you have the following files: - + `202110202230.11.1634769287` - + ` 202110202230.11.1634769287_0001` - + ` 202110202230.11.1634769287_0002 ` - + ` 202110202230.11.1634769287_metadata` - - The `RdsChunkCount` is `3`\. The order for merging the files is the following: `202110202230.11.1634769287`, ` 202110202230.11.1634769287_0001`, `202110202230.11.1634769287_0002`\. -+ `TransactionLogMetadata` – Contains metadata information about each iteration of transaction log extraction\. - - The `RI.End` file contains information for all databases that had their transaction logs extracted, and all databases that exist but didn't have their transaction logs extracted\. The `RI.End` file name follows the pattern `yyyyMMddHHmm.RI.End.timestamp`, for example: - - ``` - 202110202230.RI.End.1634769281 - ``` - -You can restore an RDS Custom for SQL Server DB instance to a point in time using the AWS Management Console, the AWS CLI, or the RDS API\. - -### Console - -**To restore an RDS Custom DB instance to a specified time** - -1. Sign in to the AWS Management Console and open the Amazon RDS console at [https://console\.aws\.amazon\.com/rds/](https://console.aws.amazon.com/rds/)\. - -1. In the navigation pane, choose **Automated backups**\. - -1. Choose the RDS Custom DB instance that you want to restore\. - -1. For **Actions**, choose **Restore to point in time**\. - - The **Restore to point in time** window appears\. - -1. Choose **Latest restorable time** to restore to the latest possible time, or choose **Custom** to choose a time\. - - If you chose **Custom**, enter the date and time to which you want to restore the instance\. - - Times are shown in your local time zone, which is indicated by an offset from Coordinated Universal Time \(UTC\)\. For example, UTC\-5 is Eastern Standard Time/Central Daylight Time\. - -1. For **DB instance identifier**, enter the name of the target restored RDS Custom DB instance\. The name must be unique\. - -1. Choose other options as needed, such as DB instance class\. - -1. Choose **Restore to point in time**\. - -### AWS CLI - -You restore a DB instance to a specified time by using the [ restore\-db\-instance\-to\-point\-in\-time](https://docs.aws.amazon.com/cli/latest/reference/rds/restore-db-instance-to-point-in-time.html) AWS CLI command to create a new RDS Custom DB instance\. - -Use one of the following options to specify the backup to restore from: -+ `--source-db-instance-identifier mysourcedbinstance` -+ `--source-dbi-resource-id dbinstanceresourceID` -+ `--source-db-instance-automated-backups-arn backupARN` - -The `custom-iam-instance-profile` option is required\. - -The following example restores `my-custom-db-instance` to a new DB instance named `my-restored-custom-db-instance`, as of the specified time\. - -**Example** -For Linux, macOS, or Unix: - -``` -1. aws rds restore-db-instance-to-point-in-time \ -2. --source-db-instance-identifier my-custom-db-instance\ -3. --target-db-instance-identifier my-restored-custom-db-instance \ -4. --custom-iam-instance-profile AWSRDSCustomInstanceProfileForRdsCustomInstance \ -5. --restore-time 2022-10-14T23:45:00.000Z -``` -For Windows: - -``` -1. aws rds restore-db-instance-to-point-in-time ^ -2. --source-db-instance-identifier my-custom-db-instance ^ -3. --target-db-instance-identifier my-restored-custom-db-instance ^ -4. --custom-iam-instance-profile AWSRDSCustomInstanceProfileForRdsCustomInstance ^ -5. --restore-time 2022-10-14T23:45:00.000Z -``` - -## Deleting an RDS Custom for SQL Server snapshot - -You can delete DB snapshots managed by RDS Custom for SQL Server when you no longer need them\. The deletion procedure is the same for both Amazon RDS and RDS Custom DB instances\. - -The Amazon EBS snapshots for the binary and root volumes remain in your account for a longer time because they might be linked to some instances running in your account or to other RDS Custom for SQL Server snapshots\. These EBS snapshots are automatically deleted after they're no longer related to any existing RDS Custom for SQL Server resources \(DB instances or backups\)\. - -### Console - -**To delete a snapshot of an RDS Custom DB instance** - -1. Sign in to the AWS Management Console and open the Amazon RDS console at [https://console\.aws\.amazon\.com/rds/](https://console.aws.amazon.com/rds/)\. - -1. In the navigation pane, choose **Snapshots**\. - -1. Choose the DB snapshot that you want to delete\. - -1. For **Actions**, choose **Delete snapshot**\. - -1. Choose **Delete** on the confirmation page\. - -### AWS CLI - -To delete an RDS Custom snapshot, use the AWS CLI command [delete\-db\-snapshot](https://docs.aws.amazon.com/cli/latest/reference/rds/delete-db-snapshot.html)\. - -The following option is required: -+ `--db-snapshot-identifier` – The snapshot to be deleted - -The following example deletes the `my-custom-snapshot` DB snapshot\. - -**Example** -For Linux, macOS, or Unix: - -``` -1. aws rds delete-db-snapshot \ -2. --db-snapshot-identifier my-custom-snapshot -``` -For Windows: - -``` -1. aws rds delete-db-snapshot ^ -2. --db-snapshot-identifier my-custom-snapshot -``` - -## Deleting RDS Custom for SQL Server automated backups - -You can delete retained automated backups for RDS Custom for SQL Server when they are no longer needed\. The procedure is the same as the procedure for deleting Amazon RDS backups\. - -### Console - -**To delete a retained automated backup** - -1. Sign in to the AWS Management Console and open the Amazon RDS console at [https://console\.aws\.amazon\.com/rds/](https://console.aws.amazon.com/rds/)\. - -1. In the navigation pane, choose **Automated backups**\. - -1. Choose **Retained**\. - -1. Choose the retained automated backup that you want to delete\. - -1. For **Actions**, choose **Delete**\. - -1. On the confirmation page, enter **delete me** and choose **Delete**\. - -### AWS CLI - -You can delete a retained automated backup by using the AWS CLI command [delete\-db\-instance\-automated\-backup](https://docs.aws.amazon.com/cli/latest/reference/rds/delete-db-instance-automated-backup.html)\. - -The following option is used to delete a retained automated backup: -+ `--dbi-resource-id` – The resource identifier for the source RDS Custom DB instance\. - - You can find the resource identifier for the source DB instance of a retained automated backup by using the AWS CLI command [describe\-db\-instance\-automated\-backups](https://docs.aws.amazon.com/cli/latest/reference/rds/describe-db-instance-automated-backups.html)\. - -The following example deletes the retained automated backup with source DB instance resource identifier `custom-db-123ABCEXAMPLE`\. - -**Example** -For Linux, macOS, or Unix: - -``` -1. aws rds delete-db-instance-automated-backup \ -2. --dbi-resource-id custom-db-123ABCEXAMPLE -``` -For Windows: - -``` -1. aws rds delete-db-instance-automated-backup ^ -2. --dbi-resource-id custom-db-123ABCEXAMPLE -``` \ No newline at end of file diff --git a/doc_source/custom-backup.md b/doc_source/custom-backup.md deleted file mode 100644 index 23e544d..0000000 --- a/doc_source/custom-backup.md +++ /dev/null @@ -1,319 +0,0 @@ -# Backing up and restoring an Amazon RDS Custom for Oracle DB instance - -Like Amazon RDS, RDS Custom creates and saves automated backups of your RDS Custom for Oracle DB instance during the backup window of your DB instance\. You can also back up your DB instance manually\. - -The procedure is identical to taking a snapshot of an Amazon RDS DB instance\. The first snapshot of an RDS Custom DB instance contains the data for the full DB instance\. Subsequent snapshots are incremental\. - -Restore DB snapshots using either the AWS Management Console or the AWS CLI\. - -**Topics** -+ [Creating an RDS Custom for Oracle snapshot](#custom-backup.creating) -+ [Restoring from an RDS Custom for Oracle DB snapshot](#custom-backup.restoring) -+ [Restoring an RDS Custom for Oracle instance to a point in time](#custom-backup.pitr) -+ [Deleting an RDS Custom for Oracle snapshot](#custom-backup.deleting) -+ [Deleting RDS Custom for Oracle automated backups](#custom-backup.deleting-backups) - -## Creating an RDS Custom for Oracle snapshot - -RDS Custom for Oracle creates a storage volume snapshot of your DB instance, backing up the entire DB instance and not just individual databases\. When your DB instance contains a container database \(CDB\), the snapshot of the instance includes the root CDB and all PDBs\. - -When you create an RDS Custom for Oracle snapshot, specify which RDS Custom DB instance to back up\. Give your snapshot a name so you can restore from it later\. - -When you create a snapshot, RDS Custom for Oracle creates an Amazon EBS snapshot for every volume attached to the DB instance\. RDS Custom for Oracle uses the EBS snapshot of the root volume to register a new Amazon Machine Image \(AMI\)\. To make snapshots easy to associate with a specific DB instance, they're tagged with `DBSnapshotIdentifier`, `DbiResourceId`, and `VolumeType`\. - -Creating a DB snapshot results in a brief I/O suspension\. This suspension can last from a few seconds to a few minutes, depending on the size and class of your DB instance\. The snapshot creation time varies with the size of your database\. Because the snapshot includes the entire storage volume, the size of files, such as temporary files, also affects snapshot creation time\. To learn more about creating snapshots, see [Creating a DB snapshot](USER_CreateSnapshot.md)\. - -Create an RDS Custom for Oracle snapshot using the console or the AWS CLI\. - -### Console - -**To create an RDS Custom snapshot** - -1. Sign in to the AWS Management Console and open the Amazon RDS console at [https://console\.aws\.amazon\.com/rds/](https://console.aws.amazon.com/rds/)\. - -1. In the navigation pane, choose **Databases**\. - -1. In the list of RDS Custom DB instances, choose the instance for which you want to take a snapshot\. - -1. For **Actions**, choose **Take snapshot**\. - - The **Take DB snapshot** window appears\. - -1. For **Snapshot name**, enter the name of the snapshot\. - -1. Choose **Take snapshot**\. - -### AWS CLI - -You create a snapshot of an RDS Custom DB instance by using the [create\-db\-snapshot](https://docs.aws.amazon.com/cli/latest/reference/rds/create-db-snapshot.html) AWS CLI command\. - -Specify the following options: -+ `--db-instance-identifier` – Identifies which RDS Custom DB instance you are going to back up -+ `--db-snapshot-identifier` – Names your RDS Custom snapshot so you can restore from it later - -In this example, you create a DB snapshot called *`my-custom-snapshot`* for an RDS Custom DB instance called `my-custom-instance`\. - -**Example** -For Linux, macOS, or Unix: - -``` -1. aws rds create-db-snapshot \ -2. --db-instance-identifier my-custom-instance \ -3. --db-snapshot-identifier my-custom-snapshot -``` -For Windows: - -``` -1. aws rds create-db-snapshot ^ -2. --db-instance-identifier my-custom-instance ^ -3. --db-snapshot-identifier my-custom-snapshot -``` - -## Restoring from an RDS Custom for Oracle DB snapshot - -When you restore an RDS Custom for Oracle DB instance, you provide the name of the DB snapshot and a name for the new instance\. You can't restore from a snapshot to an existing RDS Custom DB instance\. A new RDS Custom for Oracle DB instance is created when you restore\. - -The restore process differs in the following ways from restore in Amazon RDS: -+ Before restoring a snapshot, RDS Custom for Oracle backs up existing configuration files\. These files are available on the restored instance in the directory `/rdsdbdata/config/backup`\. RDS Custom for Oracle restores the DB snapshot with default parameters and overwrites the previous database configuration files with existing ones\. Thus, the restored instance doesn't preserve custom parameters and changes to database configuration files\. -+ The restored database has the same name as in the snapshot\. You can't specify a different name\. \(For RDS Custom for Oracle, the default is `ORCL`\.\) - -### Console - -**To restore an RDS Custom DB instance from a DB snapshot** - -1. Sign in to the AWS Management Console and open the Amazon RDS console at [https://console\.aws\.amazon\.com/rds/](https://console.aws.amazon.com/rds/)\. - -1. In the navigation pane, choose **Snapshots**\. - -1. Choose the DB snapshot that you want to restore from\. - -1. For **Actions**, choose **Restore snapshot**\. - -1. On the **Restore DB instance** page, for **DB instance identifier**, enter the name for your restored RDS Custom DB instance\. - -1. Choose **Restore DB instance**\. - -### AWS CLI - -You restore an RDS Custom DB snapshot by using the [ restore\-db\-instance\-from\-db\-snapshot](https://docs.aws.amazon.com/cli/latest/reference/rds/restore-db-instance-from-db-snapshot.html) AWS CLI command\. - -If the snapshot you are restoring from is for a private DB instance, make sure to specify both the correct `db-subnet-group-name` and `no-publicly-accessible`\. Otherwise, the DB instance defaults to publicly accessible\. The following options are required: -+ `db-snapshot-identifier` – Identifies the snapshot from which to restore -+ `db-instance-identifier` – Specifies the name of the RDS Custom DB instance to create from the DB snapshot -+ `custom-iam-instance-profile` – Specifies the instance profile associated with the underlying Amazon EC2 instance of an RDS Custom DB instance\. - -The following code restores the snapshot named `my-custom-snapshot` for `my-custom-instance`\. - -**Example** -For Linux, macOS, or Unix: - -``` -aws rds restore-db-instance-from-db-snapshot \ - --db-snapshot-identifier my-custom-snapshot \ - --db-instance-identifier my-custom-instance \ - --custom-iam-instance-profile AWSRDSCustomInstanceProfileForRdsCustomInstance \ - --no-publicly-accessible -``` -For Windows: - -``` -aws rds restore-db-instance-from-db-snapshot ^ - --db-snapshot-identifier my-custom-snapshot ^ - --db-instance-identifier my-custom-instance ^ - --custom-iam-instance-profile AWSRDSCustomInstanceProfileForRdsCustomInstance ^ - --no-publicly-accessible -``` - -## Restoring an RDS Custom for Oracle instance to a point in time - -You can restore a DB instance to a specific point in time \(PITR\), creating a new DB instance\. To support PITR, your DB instances must have backup retention set to a nonzero value\. - -The latest restorable time for an RDS Custom for Oracle DB instance depends on several factors, but is typically within 5 minutes of the current time\. To see the latest restorable time for a DB instance, use the AWS CLI [describe\-db\-instances](https://docs.aws.amazon.com/cli/latest/reference/rds/describe-db-instances.html) command and look at the value returned in the `LatestRestorableTime` field for the DB instance\. To see the latest restorable time for each DB instance in the Amazon RDS console, choose **Automated backups**\. - -You can restore to any point in time within your backup retention period\. To see the earliest restorable time for each DB instance, choose **Automated backups** in the Amazon RDS console\. - -For general information about PITR, see [Restoring a DB instance to a specified time](USER_PIT.md)\. - -**Topics** -+ [PITR considerations for RDS Custom for Oracle](#custom-backup.pitr.oracle) - -### PITR considerations for RDS Custom for Oracle - -In RDS Custom for Oracle, PITR differs in the following important ways from PITR in Amazon RDS: -+ The restored database has the same name as in the source DB instance\. You can't specify a different name\. The default is `ORCL`\. -+ `AWSRDSCustomIamRolePolicy` requires new permissions\. For more information, see [Step 2: Add an access policy to AWSRDSCustomInstanceRoleForRdsCustomInstance](custom-setup-orcl.md#custom-setup-orcl.iam.add-policy)\. -+ All RDS Custom for Oracle DB instances must have backup retention set to a nonzero value\. -+ If you change the operating system or DB instance time zone, PITR might not work\. For information about changing time zones, see [Changing the time zone of an RDS Custom for Oracle DB instance](custom-managing.md#custom-managing.timezone)\. -+ If you set automation to `ALL_PAUSED`, RDS Custom pauses the upload of archived redo logs, including logs created before the latest restorable time \(LRT\)\. We recommend that you pause automation for a brief period\. - - To illustrate, assume that your LRT is 10 minutes ago\. You pause automation\. During the pause, RDS Custom doesn't upload archived redo logs\. If your DB instance crashes, you can only recover to a time before the LRT that existed when you paused\. When you resume automation, RDS Custom resumes uploading logs\. The LRT advances\. Normal PITR rules apply\. -+ In RDS Custom, you can manually specify an arbitrary number of hours to retain archived redo logs before RDS Custom deletes them after upload\. Specify the number of hours as follows: - - 1. Create a text file named `/opt/aws/rdscustomagent/config/redo_logs_custom_configuration.json`\. - - 1. Add a JSON object in the following format: `{"archivedLogRetentionHours" : "num_of_hours"}`\. The number must be an integer in the range 1–840\. -+ Assume that you plug a non\-CDB into a container database \(CDB\) as a PDB and then attempt PITR\. The operation succeeds only if you previously backed up the PDB\. After you create or modify a PDB, we recommend that you always back it up\. -+ We recommend that you don't customize database initialization parameters\. For example, modifying the following parameters affects PITR: - + `CONTROL_FILE_RECORD_KEEP_TIME` affects the rules for uploading and deleting logs\. - + `LOG_ARCHIVE_DEST_n` doesn't support multiple destinations\. - + `ARCHIVE_LAG_TARGET` affects the latest restorable time\. -+ If you customize database initialization parameters, we strongly recommend that you only customize the following: - + `COMPATIBLE` - + `MAX_STRING_SIZE` - + `DB_FILES` - + `UNDO_TABLESPACE` - + `ENABLE_PLUGGABLE_DATABASE` - + `CONTROL_FILES` - + `AUDIT_TRAIL` - + `AUDIT_TRAIL_DEST` - - For all other initialization parameters, RDS Custom restores the default values\. If you modify a parameter that isn't in the preceding list, it might have an adverse effect on PITR and lead to unpredictable results\. For example, `CONTROL_FILE_RECORD_KEEP_TIME` affects the rules for uploading and deleting logs\. - -You can restore an RDS Custom DB instance to a point in time using the AWS Management Console, the AWS CLI, or the RDS API\. - -### Console - -**To restore an RDS Custom DB instance to a specified time** - -1. Sign in to the AWS Management Console and open the Amazon RDS console at [https://console\.aws\.amazon\.com/rds/](https://console.aws.amazon.com/rds/)\. - -1. In the navigation pane, choose **Automated backups**\. - -1. Choose the RDS Custom DB instance that you want to restore\. - -1. For **Actions**, choose **Restore to point in time**\. - - The **Restore to point in time** window appears\. - -1. Choose **Latest restorable time** to restore to the latest possible time, or choose **Custom** to choose a time\. - - If you chose **Custom**, enter the date and time to which you want to restore the instance\. - - Times are shown in your local time zone, which is indicated by an offset from Coordinated Universal Time \(UTC\)\. For example, UTC\-5 is Eastern Standard Time/Central Daylight Time\. - -1. For **DB instance identifier**, enter the name of the target restored RDS Custom DB instance\. The name must be unique\. - -1. Choose other options as needed, such as DB instance class\. - -1. Choose **Restore to point in time**\. - -### AWS CLI - -You restore a DB instance to a specified time by using the [ restore\-db\-instance\-to\-point\-in\-time](https://docs.aws.amazon.com/cli/latest/reference/rds/restore-db-instance-to-point-in-time.html) AWS CLI command to create a new RDS Custom DB instance\. - -Use one of the following options to specify the backup to restore from: -+ `--source-db-instance-identifier mysourcedbinstance` -+ `--source-dbi-resource-id dbinstanceresourceID` -+ `--source-db-instance-automated-backups-arn backupARN` - -The `custom-iam-instance-profile` option is required\. - -The following example restores `my-custom-db-instance` to a new DB instance named `my-restored-custom-db-instance`, as of the specified time\. - -**Example** -For Linux, macOS, or Unix: - -``` -1. aws rds restore-db-instance-to-point-in-time \ -2. --source-db-instance-identifier my-custom-db-instance\ -3. --target-db-instance-identifier my-restored-custom-db-instance \ -4. --custom-iam-instance-profile AWSRDSCustomInstanceProfileForRdsCustomInstance \ -5. --restore-time 2022-10-14T23:45:00.000Z -``` -For Windows: - -``` -1. aws rds restore-db-instance-to-point-in-time ^ -2. --source-db-instance-identifier my-custom-db-instance ^ -3. --target-db-instance-identifier my-restored-custom-db-instance ^ -4. --custom-iam-instance-profile AWSRDSCustomInstanceProfileForRdsCustomInstance ^ -5. --restore-time 2022-10-14T23:45:00.000Z -``` - -## Deleting an RDS Custom for Oracle snapshot - -You can delete DB snapshots managed by RDS Custom for Oracle when you no longer need them\. The deletion procedure is the same for both Amazon RDS and RDS Custom DB instances\. - -The Amazon EBS snapshots for the binary and root volumes remain in your account for a longer time because they might be linked to some instances running in your account or to other RDS Custom for Oracle snapshots\. These EBS snapshots are automatically deleted after they're no longer related to any existing RDS Custom for Oracle resources \(DB instances or backups\)\. - -### Console - -**To delete a snapshot of an RDS Custom DB instance** - -1. Sign in to the AWS Management Console and open the Amazon RDS console at [https://console\.aws\.amazon\.com/rds/](https://console.aws.amazon.com/rds/)\. - -1. In the navigation pane, choose **Snapshots**\. - -1. Choose the DB snapshot that you want to delete\. - -1. For **Actions**, choose **Delete snapshot**\. - -1. Choose **Delete** on the confirmation page\. - -### AWS CLI - -To delete an RDS Custom snapshot, use the AWS CLI command [delete\-db\-snapshot](https://docs.aws.amazon.com/cli/latest/reference/rds/delete-db-snapshot.html)\. - -The following option is required: -+ `--db-snapshot-identifier` – The snapshot to be deleted - -The following example deletes the `my-custom-snapshot` DB snapshot\. - -**Example** -For Linux, macOS, or Unix: - -``` -1. aws rds delete-db-snapshot \ -2. --db-snapshot-identifier my-custom-snapshot -``` -For Windows: - -``` -1. aws rds delete-db-snapshot ^ -2. --db-snapshot-identifier my-custom-snapshot -``` - -## Deleting RDS Custom for Oracle automated backups - -You can delete retained automated backups for RDS Custom for Oracle when they are no longer needed\. The procedure is the same as the procedure for deleting Amazon RDS backups\. - -### Console - -**To delete a retained automated backup** - -1. Sign in to the AWS Management Console and open the Amazon RDS console at [https://console\.aws\.amazon\.com/rds/](https://console.aws.amazon.com/rds/)\. - -1. In the navigation pane, choose **Automated backups**\. - -1. Choose **Retained**\. - -1. Choose the retained automated backup that you want to delete\. - -1. For **Actions**, choose **Delete**\. - -1. On the confirmation page, enter **delete me** and choose **Delete**\. - -### AWS CLI - -You can delete a retained automated backup by using the AWS CLI command [delete\-db\-instance\-automated\-backup](https://docs.aws.amazon.com/cli/latest/reference/rds/delete-db-instance-automated-backup.html)\. - -The following option is used to delete a retained automated backup: -+ `--dbi-resource-id` – The resource identifier for the source RDS Custom DB instance\. - - You can find the resource identifier for the source DB instance of a retained automated backup by using the AWS CLI command [describe\-db\-instance\-automated\-backups](https://docs.aws.amazon.com/cli/latest/reference/rds/describe-db-instance-automated-backups.html)\. - -The following example deletes the retained automated backup with source DB instance resource identifier `custom-db-123ABCEXAMPLE`\. - -**Example** -For Linux, macOS, or Unix: - -``` -1. aws rds delete-db-instance-automated-backup \ -2. --dbi-resource-id custom-db-123ABCEXAMPLE -``` -For Windows: - -``` -1. aws rds delete-db-instance-automated-backup ^ -2. --dbi-resource-id custom-db-123ABCEXAMPLE -``` \ No newline at end of file diff --git a/doc_source/custom-cev-sqlserver-deleting.md b/doc_source/custom-cev-sqlserver-deleting.md deleted file mode 100644 index 793c79a..0000000 --- a/doc_source/custom-cev-sqlserver-deleting.md +++ /dev/null @@ -1,52 +0,0 @@ -# Deleting a CEV for RDS Custom for SQL Server - -You can delete a CEV using the AWS Management Console or the AWS CLI\. Typically, this task takes a few minutes\. - -Before deleting a CEV, make sure it isn't being used by any of the following: -+ An RDS Custom DB instance -+ A snapshot of an RDS Custom DB instance -+ An automated backup of your RDS Custom DB instance - -## Console - -**To delete a CEV** - -1. Sign in to the AWS Management Console and open the Amazon RDS console at [https://console\.aws\.amazon\.com/rds/](https://console.aws.amazon.com/rds/)\. - -1. In the navigation pane, choose **Custom engine versions**\. - -1. Choose a CEV whose description or status you want to delete\. - -1. For **Actions**, choose **Delete**\. - - The **Delete *cev\_name*?** dialog box appears\. - -1. Enter **delete me**, and then choose **Delete**\. - - In the **Custom engine versions** page, the banner shows that your CEV is being deleted\. - -## AWS CLI - -To delete a CEV by using the AWS CLI, run the [delete\-custom\-db\-engine\-version](https://docs.aws.amazon.com/cli/latest/reference/rds/delete-custom-db-engine-version.html) command\. - -The following options are required: -+ `--engine custom-sqlserver-ee` -+ `--engine-version cev`, where *cev* is the name of the custom engine version to be deleted - -The following example deletes a CEV named `15.00.4249.2.my_cevtest`\. - -**Example** -For Linux, macOS, or Unix: - -``` -1. aws rds delete-custom-db-engine-version \ -2. --engine custom-sqlserver-ee \ -3. --engine-version 15.00.4249.2.my_cevtest -``` -For Windows: - -``` -1. aws rds delete-custom-db-engine-version ^ -2. --engine custom-sqlserver-ee ^ -3. --engine-version 15.00.4249.2.my_cevtest -``` \ No newline at end of file diff --git a/doc_source/custom-cev-sqlserver-modifying.md b/doc_source/custom-cev-sqlserver-modifying.md deleted file mode 100644 index fd631b1..0000000 --- a/doc_source/custom-cev-sqlserver-modifying.md +++ /dev/null @@ -1,126 +0,0 @@ -# Modifying a CEV for RDS Custom for SQL Server - -You can modify a CEV using the AWS Management Console or the AWS CLI\. You can modify the CEV description or its availability status\. Your CEV has one of the following status values: -+ `available` – You can use this CEV to create a new RDS Custom DB instance or upgrade a DB instance\. This is the default status for a newly created CEV\. -+ `inactive` – You can't create or upgrade an RDS Custom DB instance with this CEV\. You can't restore a DB snapshot to create a new RDS Custom DB instance with this CEV\. - -You can change the CEV status from `available` to `inactive` or from `inactive` to `available`\. You might change the status to `INACTIVE` to prevent the accidental use of a CEV or to make a discontinued CEV eligible for use again\. - -## Console - -**To modify a CEV** - -1. Sign in to the AWS Management Console and open the Amazon RDS console at [https://console\.aws\.amazon\.com/rds/](https://console.aws.amazon.com/rds/)\. - -1. In the navigation pane, choose **Custom engine versions**\. - -1. Choose a CEV whose description or status you want to modify\. - -1. For **Actions**, choose **Modify**\. - -1. Make any of the following changes: - + For **CEV status settings**, choose a new availability status\. - + For **Version description**, enter a new description\. - -1. Choose **Modify CEV**\. - - If the CEV is in use, the console displays **You can't modify the CEV status**\. Fix the problems, then try again\. - -The **Custom engine versions** page appears\. - -## AWS CLI - -To modify a CEV by using the AWS CLI, run the [modify\-custom\-db\-engine\-version](https://docs.aws.amazon.com/cli/latest/reference/rds/modify-custom-db-engine-version.html) command\. You can find CEVs to modify by running the [describe\-db\-engine\-versions](https://docs.aws.amazon.com/cli/latest/reference/rds/describe-db-engine-versions.html) command\. - -The following options are required: -+ `--engine` -+ `--engine-version cev`, where *`cev`* is the name of the custom engine version that you want to modify -+ `--status`` status`, where *`status`* is the availability status that you want to assign to the CEV - -The following example changes a CEV named `15.00.4249.2.my_cevtest` from its current status to `inactive`\. - -**Example** -For Linux, macOS, or Unix: - -``` -1. aws rds modify-custom-db-engine-version \ -2. --engine custom-sqlserver-ee \ -3. --engine-version 15.00.4249.2.my_cevtest \ -4. --status inactive -``` -For Windows: - -``` -1. aws rds modify-custom-db-engine-version ^ -2. --engine custom-sqlserver-ee ^ -3. --engine-version 15.00.4249.2.my_cevtest ^ -4. --status inactive -``` - -## Modifying an RDS Custom for SQL Server DB instance to use a new CEV - -You can modify an existing RDS Custom for SQL Server DB instance to use a different CEV\. The changes that you can make include: -+ Changing the CEV -+ Changing the DB instance class -+ Changing the backup retention period and backup window -+ Changing the maintenance window - -### Console - -**To modify an RDS Custom for SQL Server DB instance** - -1. Sign in to the AWS Management Console and open the Amazon RDS console at [https://console\.aws\.amazon\.com/rds/](https://console.aws.amazon.com/rds/)\. - -1. In the navigation pane, choose **Databases**\. - -1. Choose the DB instance that you want to modify\. - -1. Choose **Modify**\. - -1. Make the following changes as needed: - - 1. For **DB engine version**, choose a different CEV\. - - 1. Change the value for **DB instance class**\. For supported classes, see [DB instance class support for RDS Custom for SQL Server](custom-reqs-limits-MS.md#custom-reqs-limits.instancesMS)\. - - 1. Change the value for **Backup retention period**\. - - 1. For **Backup window**, set values for the **Start time** and **Duration**\. - - 1. For **DB instance maintenance window**, set values for the **Start day**, **Start time**, and **Duration**\. - -1. Choose **Continue**\. - -1. Choose **Apply immediately** or **Apply during the next scheduled maintenance window**\. - -1. Choose **Modify DB instance**\. -**Note** -When modifying a DB instance from one CEV to an another CEV, for example, when upgrading a minor version, the SQL Server system databases, including their data and configurations, are persisted from the current RDS Custom for SQL Server DB instance\. - -### AWS CLI - -To modify a DB instance to use a different CEV by using the AWS CLI, run the [modify\-db\-instance](https://docs.aws.amazon.com/cli/latest/reference/rds/modify-custom-db-engine-version.html) command\. - -The following options are required: -+ `--db-instance-identifier` -+ `--engine-version cev`, where *`cev`* is the name of the custom engine version that you want the DB instance to change to\. - -The following example modifies a DB instance named `my-cev-db-instance` to use a CEV named `15.00.4249.2.my_cevtest_new` and applies the change immediately\. - -**Example** -For Linux, macOS, or Unix: - -``` -1. aws rds modify-db-instance \ -2. --db-instance-identifier my-cev-db-instance \ -3. --engine-version 15.00.4249.2.my_cevtest_new \ -4. --apply-immediately -``` -For Windows: - -``` -1. aws rds modify-db-instance ^ -2. --db-instance-identifier my-cev-db-instance ^ -3. --engine-version 15.00.4249.2.my_cevtest_new ^ -4. --apply-immediately -``` \ No newline at end of file diff --git a/doc_source/custom-cev-sqlserver.create.md b/doc_source/custom-cev-sqlserver.create.md deleted file mode 100644 index 82f68df..0000000 --- a/doc_source/custom-cev-sqlserver.create.md +++ /dev/null @@ -1,120 +0,0 @@ -# Creating a CEV for RDS Custom for SQL Server - -You can create a custom engine version \(CEV\) using the AWS Management Console or the AWS CLI\. You can then use the CEV to create an RDS Custom for SQL Server DB instance\. - -Make sure that the Amazon Machine Image \(AMI\) is in the same AWS account and Region as your CEV\. Otherwise, the process to create a CEV fails\. - -For more information, see [Creating and connecting to a DB instance for Amazon RDS Custom for SQL Server](custom-creating-sqlserver.md)\. - -**Important** -The steps to create a CEV are the same for AMIs created with pre\-installed SQL Server and those created using bring your own media \(BYOM\)\. - -## Console - -**To create a CEV** - -1. Sign in to the AWS Management Console and open the Amazon RDS console at [https://console\.aws\.amazon\.com/rds/](https://console.aws.amazon.com/rds/)\. - -1. In the navigation pane, choose **Custom engine versions**\. - - The **Custom engine versions** page shows all CEVs that currently exist\. If you haven't created any CEVs, the table is empty\. - -1. Choose **Create custom engine version**\. - -1. For **Engine type**, choose **Microsoft SQL Server**\. - -1. For **Edition**, choose **SQL Server Enterprise, Standard, or Web Edition**\. - -1. For **Major version**, choose the major engine version that's installed on your AMI\. - -1. In **Version details**, enter a valid name in **Custom engine version name**\. - - The name format is `major-engine-version.minor-engine-version.customized_string`\. You can use 1–50 alphanumeric characters, underscores, dashes, and periods\. For example, you might enter the name **15\.00\.4249\.2\.my\_cevtest**\. - - Optionally, enter a description for your CEV\. - -1. For **Installation Media**, browse to or enter the AMI ID that you'd like to create the CEV from\. - -1. In the **Tags** section, add any tags to identify the CEV\. - -1. Choose **Create custom engine version**\. - -The **Custom engine versions** page appears\. Your CEV is shown with the status **pending\-validation** - -## AWS CLI - -To create a CEV by using the AWS CLI, run the [create\-custom\-db\-engine\-version](https://docs.aws.amazon.com/cli/latest/reference/rds/create-custom-db-engine-version.html) command\. - -The following options are required: -+ `--engine` -+ `--engine-version` -+ `--image-id` - -You can also specify the following options: -+ `--kms-key-id` -+ `--description` -+ `--region` -+ `--tags` - -The following example creates a CEV named `15.00.4249.2.my_cevtest`\. Make sure that the name of your CEV begins with the major engine version number\. - -**Example** -For Linux, macOS, or Unix: - -``` -1. aws rds create-custom-db-engine-version \ -2. --engine custom-sqlserver-ee \ -3. --engine-version 15.00.4249.2.my_cevtest \ -4. --image-id ami-0r93cx31t5r596482 \ -5. --kms-key-id my-kms-key \ -6. --description "Custom SQL Server EE 15.00.4249.2 cev test" -``` -The following partial output shows the engine, parameter groups, and other information\. - -``` - 1. "DBEngineVersions": [ - 2. { - 3. "Engine": "custom-sqlserver-ee", - 4. "MajorEngineVersion": "15.00", - 5. "EngineVersion": "15.00.4249.2.my_cevtest", - 6. "DBEngineDescription": "Microsoft SQL Server Enterprise Edition for RDS Custom for SQL Server", - 7. "DBEngineVersionArn": "arn:aws:rds:us-east-1::cev:custom-sqlserver-ee/15.00.4249.2.my_cevtest/a1234a1-123c-12rd-bre1-1234567890", - 8. "DBEngineVersionDescription": "Custom SQL Server EE 15.00.4249.2 cev test", - 9. "KMSKeyId": "arn:aws:kms:us-east-1::key/", -10. -11. "Image": [ -12. "ImageId": "ami-0r93cx31t5r596482", -13. "Status": "pending-validation" -14. ], -15. "CreateTime": "2022-11-20T19:30:01.831000+00:00", -16. "SupportsLogExportsToCloudwatchLogs": false, -17. "SupportsReadReplica": false, -18. "Status": "pending-validation", -19. "SupportsParallelQuery": false, -20. "SupportsGlobalDatabases": false, -21. "TagList": [] -22. } -23. ] -``` - -If the process to create a CEV fails, RDS Custom for SQL Server issues `RDS-EVENT-0198` with the message `Creation failed for custom engine version major-engine-version.cev_name`\. The message includes details about the failure, for example, the event prints missing files\. To find troubleshooting ideas for CEV creation issues, see [Troubleshooting CEV errors for RDS Custom for SQL Server](custom-troubleshooting.md#custom-troubleshooting-sqlserver.cev)\. - -## Create an RDS Custom for SQL Server DB instance from a CEV - -After you successfully create a CEV, the **CEV status** shows `pending-validation`\. You can now create a new RDS Custom for SQL Server DB instance using the CEV\. To create a new RDS Custom for SQL Server DB instance from a CEV, see [Creating an RDS Custom for SQL Server DB instance](custom-creating-sqlserver.md#custom-creating-sqlserver.create)\. - -## Lifecycle of a CEV - -The CEV lifecycle includes the following statuses\. - - -**** - -| CEV status | Description | Troubleshooting suggestions | -| --- | --- | --- | -| `pending-validation` | A CEV was created and is pending the validation of the associated AMI\. A CEV will remain in `pending-validation` until an RDS Custom for SQL Server DB instance is created from it\. | If there are no existing tasks, create a new RDS Custom for SQL Server DB instance from the CEV\. When creating the RDS Custom for SQL Server DB instance, the system attempts to validate the associated AMI for a CEV\. | -| `validating` | A creation task for the RDS Custom for SQL Server DB instance based on a new CEV is in progress\. When creating the RDS Custom for SQL Server DB instance, the system attempts to validate the associated AMI of a CEV\. | Wait for the creation task of the existing RDS Custom for SQL Server DB instance to complete\. You can use the RDS EVENTS console to review detailed event messages for troubleshooting\. | -| `available` | The CEV was successfully validated\. A CEV will enter the `available` status once an RDS Custom for SQL Server DB instance has been successfully created from it\. | The CEV doesn't require any additional validation\. It can be used to create additional RDS Custom for SQL Server DB instances or modify existing ones\. | -| `inactive` | The CEV has been modified to an inactive state\. | You can't create or upgrade an RDS Custom DB instance with this CEV\. Also, you can't restore a DB snapshot to create a new RDS Custom DB instance with this CEV\. For information about how to change the state to `ACTIVE`, see [Modifying a CEV for RDS Custom for SQL Server](custom-cev-sqlserver-modifying.md)\. | -| `failed` | The create DB instance step failed for this CEV before it could validate the AMI\. Alternatively, the underlying AMI used by the CEV isn't in an available state\. | Troubleshoot the root cause for why the system couldn't create the DB instance\. View the detailed error message and try to create a new DB instance again\. Ensure that the underlying AMI used by the CEV is in an available state\. | -| `incompatible-image-configuration` | There was an error validating the AMI\. | View the technical details of the error\. You can't attempt to validate the AMI with this CEV again\. Review the following: recommendations: [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/custom-cev-sqlserver.create.html) Create a new CEV using the correct information\. If needed, create a new EC2 instance using a supported AMI and run the Sysprep process on it\. | \ No newline at end of file diff --git a/doc_source/custom-cev-sqlserver.md b/doc_source/custom-cev-sqlserver.md deleted file mode 100644 index 12ec7c9..0000000 --- a/doc_source/custom-cev-sqlserver.md +++ /dev/null @@ -1,26 +0,0 @@ -# Working with custom engine versions for RDS Custom for SQL Server - -A *custom engine version \(CEV\)* for RDS Custom for SQL Server is an Amazon Machine Image \(AMI\) that includes Microsoft SQL Server\. - -**The basic steps of the CEV workflow are as follows:** - -1. Choose an AWS EC2 Windows AMI to use as a base image for a CEV\. You have the option to use pre\-installed Microsoft SQL Server, or bring your own media to install SQL Server yourself\. - -1. Install other software on the operating system \(OS\) and customize the configuration of the OS and SQL Server to meet your enterprise needs\. - -1. Save the AMI as a golden image - -1. Create a custom engine version \(CEV\) from your golden image\. - -1. Create new RDS Custom for SQL Server DB instances by using your CEV\. - -Amazon RDS then manages these DB instances for you\. - -A CEV allows you to maintain your preferred baseline configuration of the OS and database\. Using a CEV ensures that the host configuration, such as any third\-party agent installation or other OS customizations, are persisted on RDS Custom for SQL Server DB instances\. With a CEV, you can quickly deploy fleets of RDS Custom for SQL Server DB instances with the same configuration\. - -**Topics** -+ [Preparing to create a CEV for RDS Custom for SQL Server](custom-cev-sqlserver.preparing.md) -+ [Creating a CEV for RDS Custom for SQL Server](custom-cev-sqlserver.create.md) -+ [Modifying a CEV for RDS Custom for SQL Server](custom-cev-sqlserver-modifying.md) -+ [Viewing CEV details for Amazon RDS Custom for SQL Server](custom-viewing-sqlserver.md) -+ [Deleting a CEV for RDS Custom for SQL Server](custom-cev-sqlserver-deleting.md) \ No newline at end of file diff --git a/doc_source/custom-cev-sqlserver.preparing.md b/doc_source/custom-cev-sqlserver.preparing.md deleted file mode 100644 index 2dffa06..0000000 --- a/doc_source/custom-cev-sqlserver.preparing.md +++ /dev/null @@ -1,169 +0,0 @@ -# Preparing to create a CEV for RDS Custom for SQL Server - -You can create a CEV using an Amazon Machine Image \(AMI\) that contains pre\-installed, License Included \(LI\) Microsoft SQL Server, or with an AMI on which you install your own SQL Server installation media \(BYOM\)\. - -**Contents** -+ [Preparing a CEV using pre\-installed SQL Server \(LI\)](#custom-cev-sqlserver.preparing.licenseincluded) -+ [Preparing a CEV using Bring Your Own Media \(BYOM\)](#custom-cev-sqlserver.preparing.byom) -+ [Region availability for RDS Custom for SQL Server CEVs](#custom-cev-sqlserver.preparing.RegionVersionAvailability) -+ [Version support for RDS Custom for SQL Server CEVs](#custom-cev-sqlserver.preparing.VersionSupport) -+ [Requirements for RDS Custom for SQL Server CEVs](#custom-cev-sqlserver.preparing.Requirements) -+ [Limitations for RDS Custom for SQL Server CEVs](#custom-cev-sqlserver.preparing.Limitations) - -## Preparing a CEV using pre\-installed SQL Server \(LI\) - -The following steps to create a CEV using pre\-installed Microsoft SQL Server \(LI\) use an AMI with **SQL Server CU20** Release number `2023.05.10` as an example\. When you create a CEV, choose an AMI with the most recent release number\. This ensures that you are using a supported version of Windows Server and SQL Server with the latest Cumulative Update \(CU\)\. - -**To create a CEV using pre\-installed Microsoft SQL Server \(LI\)** - -1. Choose the latest available AWS EC2 Windows Amazon Machine Image \(AMI\) with License Included \(LI\) Microsoft Windows Server and SQL Server\. - - 1. Search for **CU20** within the [Windows AMI version history](https://docs.aws.amazon.com/AWSEC2/latest/WindowsGuide/ec2-windows-ami-version-history.html)\. - - 1. Note the Release number\. For SQL Server 2019 CU20, the release number is `2023.05.10`\. -![\[AMI version history result for SQL Server 2019 CU20.\]](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/images/rds_custom_sqlserver_cev_find_ami_history_li_cu20.png) - - 1. Open the Amazon EC2 console at [https://console\.aws\.amazon\.com/ec2/](https://console.aws.amazon.com/ec2/)\. - - 1. In the left navigation panel of the Amazon EC2 console choose **Images**, then **AMIs**\. - - 1. Choose **Public images**\. - - 1. Enter `2023.05.10` into the search box\. A list of AMIs appears\. - - 1. Enter `Windows_Server-2019-English-Full-SQL_2019` into the search box to filter the results\. The following results should appear\. -![\[Supported AMIs using SQL Server 2019 CU20.\]](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/images/rds_custom_sqlserver_cev_find_ami_li_cu.png) - - 1. Choose the AMI with the SQL Server edition that you want to use\. - -1. Create or launch an EC2 instance from your chosen AMI\. - -1. Log in to the EC2 instance and install additional software or customize the OS and database configuration to meet your requirements\. - -1. Run Sysprep on the EC2 instance\. For more information prepping an AMI using Sysprep, see [Create a standardized Amazon Machine Image \(AMI\) using Sysprep](https://docs.aws.amazon.com/AWSEC2/latest/WindowsGuide/Creating_EBSbacked_WinAMI.html#sysprep-using-ec2launchv2)\. - -1. Save the AMI that contains your installed SQL Server version, other software, and customizations\. This will be your golden image\. - -1. Create a new CEV by providing the AMI ID of the image that you created\. For detailed steps on creating a CEV, see [Creating a CEV for RDS Custom for SQL Server](custom-cev-sqlserver.create.md)\. - -1. Create a new RDS Custom for SQL Server DB instance using the CEV\. For detailed steps, see [Create an RDS Custom for SQL Server DB instance from a CEV](custom-cev-sqlserver.create.md#custom-cev-sqlserver.create.newdbinstance)\. - -## Preparing a CEV using Bring Your Own Media \(BYOM\) - -The following steps use an AMI with **Windows Server 2019** Release number `2023.05.10` as an example\. When creating a CEV, choose an AMI with the most recent release number\. This ensures that you are using the latest supported version of Windows Server\. - -**To create a CEV using BYOM** - -1. Choose the latest available AWS EC2 Windows Amazon Machine Image \(AMI\) with Microsoft Windows Server\. - - 1. View the monthly AMI updates table within the [Windows AMI version history](https://docs.aws.amazon.com/AWSEC2/latest/WindowsGuide/ec2-windows-ami-version-history.html)\. - - 1. Note the latest available **Release** number\. For example, the release number for **Windows Server 2019** might be `2023.05.10`\. Although the **Changes** column may show `SQL Server CUs installed`, the release number also includes an AMI for **Windows Server 2019**, without SQL Server pre\-installed\. You can use this AMI for BYOM\. -![\[Windows AMI version history using Windows Server for BYOM.\]](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/images/rds_custom_sqlserver_cev_find_ami_byom_windows_server_base_no_cu.png) - - 1. Open the Amazon EC2 console at [https://console\.aws\.amazon\.com/ec2/](https://console.aws.amazon.com/ec2/)\. - - 1. In the left navigation panel of the Amazon EC2 console, choose **Images**, then **AMIs**\. - - 1. Choose **Public images**\. - - 1. Enter `Windows_Server-2019-English-Full-Base-2023.05.10` into the search box\. The following results should appear: -![\[Supported AMIs using Windows Server for BYOM.\]](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/images/rds_custom_sqlserver_cev_find_ami_byom_windows_server_cu20.png) - - 1. Choose the AMI with the supported Windows Server version that you want to use\. - -1. Create or launch an EC2 instance from your chosen AMI\. - -1. Log in to the EC2 instance and copy your SQL Server installation media to it\. - -1. Install SQL Server\. Make sure that you do the following: - - 1. Review [Requirements for BYOM for RDS Custom for SQL Server](custom-sqlserver.byom.md#custom-sqlserver.byom.requirements)\. - - 1. Set the instance root directory to the default `C:\Program Files\Microsoft SQL Server\`\. Don't change this directory\. - - 1. Set the SQL Server Database Engine Account Name to either `NT Service\MSSQLSERVER` or `NT AUTHORITY\NETWORK SERVICE`\. - - 1. Set the SQL Server Startup mode to **Manual**\. - - 1. Choose SQL Server Authentication mode as **Mixed**\. - - 1. Leave the current settings for the default Data directories and TempDB locations\. - -1. Grant the SQL Server sysadmin \(SA\) server role privilege to `NT AUTHORITY\SYSTEM`: - - ``` - 1. USE [master] - 2. GO - 3. EXEC master..sp_addsrvrolemember @loginame = N'NT AUTHORITY\SYSTEM' , @rolename = N'sysadmin' - 4. GO - ``` - -1. Install additional software or customize the OS and database configuration to meet your requirements\. - -1. Run Sysprep on the EC2 instance\. For more information, see [Create a standardized Amazon Machine Image \(AMI\) using Sysprep](https://docs.aws.amazon.com/AWSEC2/latest/WindowsGuide/Creating_EBSbacked_WinAMI.html#sysprep-using-ec2launchv2)\. - -1. Save the AMI that contains your installed SQL Server version, other software, and customizations\. This will be your golden image\. - -1. Create a new CEV by providing the AMI ID of the image that you created\. For detailed steps, see [Creating a CEV for RDS Custom for SQL Server](custom-cev-sqlserver.create.md)\. - -1. Create a new RDS Custom for SQL Server DB instance using the CEV\. For detailed steps, see [Create an RDS Custom for SQL Server DB instance from a CEV](custom-cev-sqlserver.create.md#custom-cev-sqlserver.create.newdbinstance)\. - -## Region availability for RDS Custom for SQL Server CEVs - -Custom engine version \(CEV\) support for RDS Custom for SQL Server is available in the following AWS Regions: -+ US East \(Ohio\) -+ US East \(N\. Virginia\) -+ US West \(Oregon\) -+ Asia Pacific \(Mumbai\) -+ Asia Pacific \(Seoul\) -+ Asia Pacific \(Singapore\) -+ Asia Pacific \(Sydney\) -+ Asia Pacific \(Tokyo\) -+ Canada \(Central\) -+ Europe \(Frankfurt\) -+ Europe \(Ireland\) -+ Europe \(London\) -+ Europe \(Stockholm\) -+ South America \(São Paulo\) - -## Version support for RDS Custom for SQL Server CEVs - -CEV creation for RDS Custom for SQL Server is supported for the following AWS EC2 Windows AMIs: -+ For CEVs using pre\-installed media, AWS EC2 Windows AMIs with License Included \(LI\) Microsoft Windows Server 2019 and SQL Server 2019 -+ For CEVs using bring your own media \(BYOM\), AWS EC2 Windows AMIs with Microsoft Windows Server 2019 - -CEV creation for RDS Custom for SQL Server is supported for the following operating system \(OS\) and database editions: -+ For CEVs using pre\-installed media, SQL Server 2019 with CU17, CU18, or CU20, for Enterprise, Standard, and Web editions -+ For CEVs using bring your own media \(BYOM\), SQL Server 2019 with CU17, CU18, or CU20, for Enterprise and Standard editions -+ For CEVs using pre\-installed media or bring your own media \(BYOM\), Windows Server 2019 is the only supported OS - -## Requirements for RDS Custom for SQL Server CEVs - -The following requirements apply to creating a CEV for RDS Custom for SQL Server: -+ The AMI used to create a CEV must be based on an OS and database configuration supported by RDS Custom for SQL Server\. For more information on supported configurations, see [Requirements and limitations for Amazon RDS Custom for SQL Server](custom-reqs-limits-MS.md)\. -+ The CEV must have a unique name\. You can't create a CEV with the same name as an existing CEV\. -+ You must name the CEV using a naming pattern of SQL Server *major version \+ minor version \+ customized string*\. The *major version \+ minor version* must match the SQL Server version provided with the AMI\. For example, you can name an AMI with SQL Server 2019 CU17 as **15\.00\.4249\.2\.my\_cevtest**\. -+ You must prepare an AMI using Sysprep\. For more information about prepping an AMI using Sysprep, see [Create a standardized Amazon Machine Image \(AMI\) using Sysprep](https://docs.aws.amazon.com/AWSEC2/latest/WindowsGuide/Creating_EBSbacked_WinAMI.html#sysprep-using-ec2launchv2)\. -+ You are responsible for maintaining the life cycle of the AMI\. An RDS Custom for SQL Server DB instance created from a CEV doesn't store a copy of the AMI\. It maintains a pointer to the AMI that you used to create the CEV\. The AMI must exist for an RDS Custom for SQL Server DB instance to remain operable\. - -## Limitations for RDS Custom for SQL Server CEVs - -The following limitations apply to custom engine versions with RDS Custom for SQL Server: -+ You can't delete a CEV if there are resources, such as DB instances or DB snapshots, associated with it\. -+ To create an RDS Custom for SQL Server DB instance, a CEV must have a status of `pending-validation`, `available`, `failed`, or `validating`\. You can't create an RDS Custom for SQL Server DB instance using a CEV if the CEV status is `incompatible-image-configuration`\. -+ To modify a RDS Custom for SQL Server DB instance to use a new CEV, the CEV must have a status of `available`\. -+ You can't create an AMI or CEV from an existing RDS Custom for SQL Server DB instance\. -+ You can't modify an existing CEV to use a different AMI\. However, you can modify an RDS Custom for SQL Server DB instance to use a different CEV\. For more information, see [Modifying an RDS Custom for SQL Server DB instance](custom-managing-sqlserver.md#custom-managing.modify-sqlserver)\. -+ Cross\-Region copy of CEVs isn't supported\. -+ Cross\-account copy of CEVs isn't supported\. -+ SQL Server Transparent Data Encryption \(TDE\) isn't supported\. -+ You can't restore or recover a CEV after you delete it\. However, you can create a new CEV from the same AMI\. -+ A RDS Custom for SQL Server DB instance stores your SQL Server database files in the *D:\\*drive\. The AMI associated with a CEV should store the Microsoft SQL Server system database files in the *C:\\* drive\. -+ An RDS Custom for SQL Server DB instance retains your configuration changes made to SQL Server\. Any configuration changes to the OS on a running RDS Custom for SQL Server DB instance created from a CEV aren't retained\. If you need to make a permanent configuration change to the OS and have it retained as your new baseline configuration, create a new CEV and modify the DB instance to use the new CEV\. -**Important** -Modifying an RDS Custom for SQL Server DB instance to use a new CEV is an offline operation\. You can perform the modification immediately or schedule it to occur during a weekly maintenance window\. -+ When you modify a CEV, Amazon RDS doesn't push those modifications to any associated RDS Custom for SQL Server DB instances\. You must modify each RDS Custom for SQL Server DB instance to use the new or updated CEV\. For more information, see [Modifying an RDS Custom for SQL Server DB instance](custom-managing-sqlserver.md#custom-managing.modify-sqlserver)\. -+ -**Important** -If an AMI used by a CEV is deleted, any modifications that may require host replacement, for example, scale compute, will fail\. The RDS Custom for SQL Server DB instance will then be placed outside of the RDS support perimeter\. We recommend that you avoid deleting any AMI that's associated to a CEV\. \ No newline at end of file diff --git a/doc_source/custom-cev.create.md b/doc_source/custom-cev.create.md deleted file mode 100644 index 0a5a0ff..0000000 --- a/doc_source/custom-cev.create.md +++ /dev/null @@ -1,160 +0,0 @@ -# Creating a CEV - -You can create a CEV using the AWS Management Console or the AWS CLI\. Make sure that the Amazon S3 bucket containing your installation files is in the same AWS Region as your CEV\. Otherwise, the process to create a CEV fails\. - -Typically, creating a CEV takes about two hours\. After the CEV is created, you can use it to create an RDS Custom DB instance\. - -For more information, see [Creating an RDS Custom for Oracle DB instance](custom-creating.md#custom-creating.create)\. - -## Console - -**To create a CEV** - -1. Sign in to the AWS Management Console and open the Amazon RDS console at [https://console\.aws\.amazon\.com/rds/](https://console.aws.amazon.com/rds/)\. - -1. In the navigation pane, choose **Custom engine versions**\. - - The **Custom engine versions** page shows all CEVs that currently exist\. If you haven't created any CEVs, the page is empty\. - -1. Choose **Create custom engine version**\. - -1. In **Engine options**, do the following: - - 1. For **Engine type**, choose **Oracle**\. - - 1. For **Architecture settings**, optionally choose **Multitenant architecture** to create a Multitenant CEV, which uses the engine `custom-oracle-ee-cdb`\. You can create an RDS Custom for Oracle CDB with a Multitenant CEV only\. If you don't choose this option, your CEV is a non\-CDB, which uses the engine `custom-oracle-ee`\. -**Note** -The architecture is a permanent characteristic of your CEV\. You can't modify your CEV to use a different architecture later\. - - 1. For **Engine version**, choose the major engine version\. - -1. In **Version details**, do the following: - - 1. Enter a valid name in **Custom engine version name**\. - - The name format is `major-engine-version.customized_string`\. You can use 1–50 alphanumeric characters, underscores, dashes, and periods\. For example, you might enter the name **19\.cdb\_cev1**\. - - 1. \(Optional\) Enter a description for your CEV\. - -1. In **Installation media**, do the following: - - 1. \(Optional\) For **AMI ID**, enter an AMI that you previously used to create a CEV\. To obtain valid AMI IDs, use either of the following techniques: - + In the console, choose **Custom engine versions** in the left navigation pane, and choose the name of a CEV\. The AMI ID used by the CEV appears in the **Configuration** tab\. - + In the AWS CLI, use the `describe-db-engine-versions` command\. Search the output for `ImageID`\. - - If you don't enter an AMI ID, RDS Custom uses the most recent available AMI\. - - 1. For **S3 location of manifest files**, enter the location of the Amazon S3 bucket that you specified in [Step 3: Upload your installation files to Amazon S3](custom-cev.preparing.md#custom-cev.preparing.s3)\. For example, enter **s3://my\-custom\-installation\-files/806242271698/cev1/**\. - - 1. For **CEV manifest**, enter the JSON manifest that you created in [Creating the CEV manifest](custom-cev.preparing.md#custom-cev.preparing.manifest.creating)\. - -1. In the **KMS key** section, select **Enter a key ARN** to list the available AWS KMS keys\. Then select your KMS key from the list\. - - An AWS KMS key is required for RDS Custom\. For more information, see [Step 1: Create or reuse a symmetric encryption AWS KMS key](custom-setup-orcl.md#custom-setup-orcl.cmk)\. - -1. \(Optional\) Choose **Add new tag** to create a key\-value pair for your CEV\. - -1. Choose **Create custom engine version**\. - - If the CEV manifest has an invalid form, the console displays **Error validating the CEV manifest**\. Fix the problems, and try again\. - -The **Custom engine versions** page appears\. Your CEV is shown with the status **Creating**\. The process to create the CEV takes approximately two hours\. - -## AWS CLI - -To create a CEV by using the AWS CLI, run the [create\-custom\-db\-engine\-version](https://docs.aws.amazon.com/cli/latest/reference/rds/create-custom-db-engine-version.html) command\. - -The following options are required: -+ `--engine engine-type`, where *engine\-type* is either `custom-oracle-ee-cdb` for a CDB or `custom-oracle-ee` for a non\-CDB\. You can create CDBs only from a CEV created with `custom-oracle-ee-cdb`\. You can create non\-CDBs only from a CEV created with `custom-oracle-ee`\. -+ `--engine-version major-engine-version.customized_string` -+ `--kms-key-id` -+ `--manifest manifest_string` or `--manifest file:file_name` - - Newline characters aren't permitted in `manifest_string`\. Make sure to escape double quotes \("\) in the JSON code by prefixing them with a backslash \(\\\)\. - - The following example shows the `manifest_string` for 19c from [Step 5: Prepare the CEV manifest](custom-cev.preparing.md#custom-cev.preparing.manifest)\. The example sets new values for the Oracle base, Oracle home, and the ID and name of the UNIX/Linux user and group\. If you copy this string, remove all newline characters before pasting it into your command\. - - `"{\"mediaImportTemplateVersion\": \"2020-08-14\",\"databaseInstallationFileNames\": [\"V982063-01.zip\"],\"opatchFileNames\": [\"p6880880_190000_Linux-x86-64.zip\"],\"psuRuPatchFileNames\": [\"p32126828_190000_Linux-x86-64.zip\"],\"otherPatchFileNames\": [\"p29213893_1910000DBRU_Generic.zip\",\"p29782284_1910000DBRU_Generic.zip\",\"p28730253_190000_Linux-x86-64.zip\",\"p29374604_1910000DBRU_Linux-x86-64.zip\",\"p28852325_190000_Linux-x86-64.zip\",\"p29997937_190000_Linux-x86-64.zip\",\"p31335037_190000_Linux-x86-64.zip\",\"p31335142_190000_Generic.zip\"]\"installationParameters\":{ \"unixGroupName\":\"dba\", \ \"unixUname\":\"oracle\", \ \"oracleHome\":\"/home/oracle/oracle.19.0.0.0.ru-2020-04.rur-2020-04.r1.EE.1\", \ \"oracleBase\":\"/home/oracle/\"}}"` -+ `--database-installation-files-s3-bucket-name`` s3-bucket-name`, where `s3-bucket-name` is the bucket name that you specified in [Step 3: Upload your installation files to Amazon S3](custom-cev.preparing.md#custom-cev.preparing.s3)\. The AWS Region in which you run `create-custom-db-engine-version` must be the same Region as your Amazon S3 bucket\. - -You can also specify the following options: -+ `--description` *`my-cev-description`* -+ `--database-installation-files-s3-prefix` *`prefix`*, where *`prefix`* is the folder name that you specified in [Step 3: Upload your installation files to Amazon S3](custom-cev.preparing.md#custom-cev.preparing.s3)\. -+ `--image-id ami-id`, where *`ami-id`* is an AMI ID that want to reuse\. To find valid IDs, run the `describe-db-engine-versions` command, and then search the output for `ImageID`\. By default, RDS Custom for Oracle uses the most recent available AMI\. - -The following example creates a Multitenant CEV named `19.cdb_cev1`\. The example reuses an existing AMI rather than use the latest available AMI\. Make sure that the name of your CEV starts with the major engine version number\. - -**Example** -For Linux, macOS, or Unix: - -``` -1. aws rds create-custom-db-engine-version \ -2. --engine custom-oracle-ee-cdb \ -3. --engine-version 19.cdb_cev1 \ -4. --database-installation-files-s3-bucket-name us-east-1-123456789012-custom-installation-files \ -5. --database-installation-files-s3-prefix 123456789012/cev1 \ -6. --kms-key-id my-kms-key \ -7. --description "test cev" \ -8. --manifest manifest_string \ -9. --image-id ami-012a345678901bcde -``` -For Windows: - -``` -1. aws rds create-custom-db-engine-version ^ -2. --engine custom-oracle-ee-cdb ^ -3. --engine-version 19.cdb_cev1 ^ -4. --database-installation-files-s3-bucket-name us-east-1-123456789012-custom-installation-files ^ -5. --database-installation-files-s3-prefix 123456789012/cev1 ^ -6. --kms-key-id my-kms-key ^ -7. --description "test cev" ^ -8. --manifest manifest_string ^ -9. --image-id ami-012a345678901bcde -``` - -**Example** -Get details about your CEV by using the `describe-db-engine-versions` command\. - -``` -1. aws rds describe-db-engine-versions \ -2. --engine custom-oracle-ee-cdb \ -3. --include-all -``` -The following partial sample output shows the engine, parameter groups, manifest, and other information\. - -``` - 1. { - 2. "DBEngineVersions": [ - 3. { - 4. "Engine": "custom-oracle-ee-cdb", - 5. "EngineVersion": "19.cdb_cev1", - 6. "DBParameterGroupFamily": "custom-oracle-ee-cdb-19", - 7. "DBEngineDescription": "Containerized Database for Oracle Custom EE", - 8. "DBEngineVersionDescription": "test cev", - 9. "Image": { -10. "ImageId": "ami-012a345678901bcde", -11. "Status": "active" -12. }, -13. "ValidUpgradeTarget": [], -14. "SupportsLogExportsToCloudwatchLogs": false, -15. "SupportsReadReplica": true, -16. "SupportedFeatureNames": [], -17. "Status": "available", -18. "SupportsParallelQuery": false, -19. "SupportsGlobalDatabases": false, -20. "MajorEngineVersion": "19", -21. "DatabaseInstallationFilesS3BucketName": "us-east-1-123456789012-custom-installation-files", -22. "DatabaseInstallationFilesS3Prefix": "123456789012/cev1", -23. "DBEngineVersionArn": "arn:aws:rds:us-east-1:123456789012:cev:custom-oracle-ee-cdb/19.cdb_cev1/abcd12e3-4f5g-67h8-i9j0-k1234l56m789", -24. "KMSKeyId": "arn:aws:kms:us-east-1:732027699161:key/1ab2345c-6d78-9ef0-1gh2-3456i7j89k01", -25. "CreateTime": "2023-03-07T19:47:58.131000+00:00", -26. "TagList": [], -27. "SupportsBabelfish": false, -28. ... -``` - -## Failure to create a CEV - -If the process to create a CEV fails, RDS Custom issues `RDS-EVENT-0198` with the message `Creation failed for custom engine version major-engine-version.cev_name`, and includes details about the failure\. For example, the event prints missing files\. - -You can't modify a failed CEV\. You can only delete it, then try again to create a CEV after fixing the causes of the failure\. For information about troubleshooting the reasons for CEV creation failure, see [Troubleshooting custom engine version creation for RDS Custom for Oracle](custom-troubleshooting.md#custom-troubleshooting.cev)\. \ No newline at end of file diff --git a/doc_source/custom-cev.delete.md b/doc_source/custom-cev.delete.md deleted file mode 100644 index a7a162d..0000000 --- a/doc_source/custom-cev.delete.md +++ /dev/null @@ -1,52 +0,0 @@ -# Deleting a CEV - -You can delete a CEV using the AWS Management Console or the AWS CLI\. Typically, deletion takes a few minutes\. - -To delete a CEV, it can't be in use by any of the following: -+ An RDS Custom DB instance -+ A snapshot of an RDS Custom DB instance -+ An automated backup of your RDS Custom DB instance - -## Console - -**To delete a CEV** - -1. Sign in to the AWS Management Console and open the Amazon RDS console at [https://console\.aws\.amazon\.com/rds/](https://console.aws.amazon.com/rds/)\. - -1. In the navigation pane, choose **Custom engine versions**\. - -1. Choose a CEV whose description or status you want to delete\. - -1. For **Actions**, choose **Delete**\. - - The **Delete *cev\_name*?** dialog box appears\. - -1. Enter **delete me**, and then choose **Delete**\. - - In the **Custom engine versions** page, the banner shows that your CEV is being deleted\. - -## AWS CLI - -To delete a CEV by using the AWS CLI, run the [delete\-custom\-db\-engine\-version](https://docs.aws.amazon.com/cli/latest/reference/rds/delete-custom-db-engine-version.html) command\. - -The following options are required: -+ `--engine custom-oracle-ee` -+ `--engine-version cev`, where *cev* is the name of the custom engine version to be deleted - -The following example deletes a CEV named `19.my_cev1`\. - -**Example** -For Linux, macOS, or Unix: - -``` -1. aws rds delete-custom-db-engine-version \ -2. --engine custom-oracle-ee \ -3. --engine-version 19.my_cev1 -``` -For Windows: - -``` -1. aws rds delete-custom-db-engine-version ^ -2. --engine custom-oracle-ee ^ -3. --engine-version 19.my_cev1 -``` \ No newline at end of file diff --git a/doc_source/custom-cev.md b/doc_source/custom-cev.md deleted file mode 100644 index 1fc3fb6..0000000 --- a/doc_source/custom-cev.md +++ /dev/null @@ -1,10 +0,0 @@ -# Working with custom engine versions for Amazon RDS Custom for Oracle - -A *custom engine version \(CEV\)* for Amazon RDS Custom for Oracle is a binary volume snapshot of a database engine and specific Amazon Machine Image \(AMI\)\. RDS Custom for Oracle uses the latest available AMI by default, but you can reuse an existing AMI\. You store your database installation files in Amazon S3\. RDS Custom uses the installation files to create your CEV for you\. - -**Topics** -+ [Preparing to create a CEV](custom-cev.preparing.md) -+ [Creating a CEV](custom-cev.create.md) -+ [Modifying CEV status](custom-cev.modify.md) -+ [Viewing CEV details](custom-cev.view.md) -+ [Deleting a CEV](custom-cev.delete.md) \ No newline at end of file diff --git a/doc_source/custom-cev.modify.md b/doc_source/custom-cev.modify.md deleted file mode 100644 index 14badd4..0000000 --- a/doc_source/custom-cev.modify.md +++ /dev/null @@ -1,58 +0,0 @@ -# Modifying CEV status - -You can modify a CEV using the AWS Management Console or the AWS CLI\. You can modify the CEV description or its availability status\. Your CEV has one of the following status values: -+ `available` – You can use this CEV to create a new RDS Custom DB instance or upgrade a DB instance\. This is the default status for a newly created CEV\. -+ `inactive` – You can't create or upgrade an RDS Custom instance with this CEV\. You can't restore a DB snapshot to create a new RDS Custom DB instance with this CEV\. - -You can change the CEV from any supported status to any other supported status\. You might change status to prevent the accidental use of a CEV or make a discontinued CEV eligible for use again\. For example, you might change the status of your CEV from `available` to `inactive`, and from `inactive` back to `available`\. - -## Console - -**To modify a CEV** - -1. Sign in to the AWS Management Console and open the Amazon RDS console at [https://console\.aws\.amazon\.com/rds/](https://console.aws.amazon.com/rds/)\. - -1. In the navigation pane, choose **Custom engine versions**\. - -1. Choose a CEV whose description or status you want to modify\. - -1. For **Actions**, choose **Modify**\. - -1. Make any of the following changes: - + For **CEV status settings**, choose a new availability status\. - + For **Version description**, enter a new description\. - -1. Choose **Modify CEV**\. - - If the CEV is in use, the console displays **You can't modify the CEV status**\. Fix the problems, and try again\. - -The **Custom engine versions** page appears\. - -## AWS CLI - -To modify a CEV by using the AWS CLI, run the [modify\-custom\-db\-engine\-version](https://docs.aws.amazon.com/cli/latest/reference/rds/modify-custom-db-engine-version.html) command\. You can find CEVs to modify by running the [describe\-db\-engine\-versions](https://docs.aws.amazon.com/cli/latest/reference/rds/describe-db-engine-versions.html) command\. - -The following options are required: -+ `--engine custom-oracle-ee` -+ `--engine-version cev`, where *`cev`* is the name of the custom engine version that you want to modify -+ `--status`` status`, where *`status`* is the availability status that you want to assign to the CEV - -The following example changes a CEV named `19.my_cev1` from its current status to `inactive`\. - -**Example** -For Linux, macOS, or Unix: - -``` -1. aws rds modify-custom-db-engine-version \ -2. --engine custom-oracle-ee \ -3. --engine-version 19.my_cev1 \ -4. --status inactive -``` -For Windows: - -``` -1. aws rds modify-custom-db-engine-version ^ -2. --engine custom-oracle-ee ^ -3. --engine-version 19.my_cev1 ^ -4. --status inactive -``` \ No newline at end of file diff --git a/doc_source/custom-cev.preparing.md b/doc_source/custom-cev.preparing.md deleted file mode 100644 index d23ca38..0000000 --- a/doc_source/custom-cev.preparing.md +++ /dev/null @@ -1,513 +0,0 @@ -# Preparing to create a CEV - -To create a CEV, access the installation files and patches that are stored in your Amazon S3 bucket for any of the following releases: -+ Oracle Database 19c -+ Oracle Database 18c -+ Oracle Database 12c Release 2 \(12\.2\) -+ Oracle Database 12c Release 1 \(12\.1\) - -For example, you can use the April 2021 RU/RUR for Oracle Database 19c, or any valid combination of installation files and patches\. For more information on the versions and Regions supported by RDS Custom for Oracle, see [RDS Custom with RDS for Oracle](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Concepts.RDS_Fea_Regions_DB-eng.Feature.RDSCustom.html#Concepts.RDS_Fea_Regions_DB-eng.Feature.RDSCustom.ora)\. - -**Topics** -+ [Step 1 \(Optional\): Download the manifest templates](#custom-cev.preparing.templates) -+ [Step 2: Download your database installation files and patches from Oracle Software Delivery Cloud](#custom-cev.preparing.download) -+ [Step 3: Upload your installation files to Amazon S3](#custom-cev.preparing.s3) -+ [Step 4 \(Optional\): Share your installation media in S3 across AWS accounts](#custom-cev.preparing.accounts) -+ [Step 5: Prepare the CEV manifest](#custom-cev.preparing.manifest) -+ [Step 6 \(Optional\): Validate the CEV manifest](#custom-cev.preparing.validating) -+ [Step 7: Add necessary IAM permissions](#custom-cev.preparing.iam) - -## Step 1 \(Optional\): Download the manifest templates - -A *CEV manifest* is a JSON document that includes the list of database installation \.zip files for your CEV\. To create a CEV, do the following: - -1. Identify the Oracle database installation files that you want to include in your CEV\. - -1. Download the installation files\. - -1. Create a JSON manifest that lists the installation files\. - -RDS Custom for Oracle provides JSON manifest templates with our recommended \.zip files for each supported Oracle Database release\. For example, the following template is for the 19\.17\.0\.0\.0 RU\. - -``` -{ - "mediaImportTemplateVersion": "2020-08-14", - "databaseInstallationFileNames": [ - "V982063-01.zip" - ], - "opatchFileNames": [ - "p6880880_190000_Linux-x86-64.zip" - ], - "psuRuPatchFileNames": [ - "p34419443_190000_Linux-x86-64.zip", - "p34411846_190000_Linux-x86-64.zip" - ], - "otherPatchFileNames": [ - "p28852325_190000_Linux-x86-64.zip", - "p29997937_190000_Linux-x86-64.zip", - "p31335037_190000_Linux-x86-64.zip", - "p32327201_190000_Linux-x86-64.zip", - "p33613829_190000_Linux-x86-64.zip", - "p34006614_190000_Linux-x86-64.zip", - "p34533061_190000_Linux-x86-64.zip", - "p34533150_190000_Generic.zip", - "p28730253_190000_Linux-x86-64.zip", - "p29213893_1917000DBRU_Generic.zip", - "p33125873_1917000DBRU_Linux-x86-64.zip", - "p34446152_1917000DBRU_Linux-x86-64.zip" - ] -} -``` - -Each template has an associated readme that includes instructions for downloading the patches, URLs for the \.zip files, and file checksums\. You can use these templates as they are or modify them with your own patches\. To review the templates, download [custom\-oracle\-manifest\.zip](samples/custom-oracle-manifest.zip) to your local disk and then open it with a file archiving application\. For more information, see [Step 5: Prepare the CEV manifest](#custom-cev.preparing.manifest)\. - -## Step 2: Download your database installation files and patches from Oracle Software Delivery Cloud - -When you have identified the installation files that you want for your CEV, download them to your local system\. The Oracle Database installation files and patches are hosted on Oracle Software Delivery Cloud\. Each CEV requires a base release, such as Oracle Database 19c or Oracle Database 12c Release 2 \(12\.2\), and an optional list of patches\. - -**To download the database installation files for Oracle Database** - -1. Go to [https://edelivery.oracle.com/](https://edelivery.oracle.com/) and sign in\. - -1. In the box, enter **Oracle Database Enterprise Edition** and choose **Search**\. - -1. Choose one of the following base releases: - + **DLP: Oracle Database Enterprise Edition 19\.3\.0\.0\.0 \( Oracle Database Enterprise Edition \)**\. - + Choose **DLP: Oracle Database 12c Enterprise Edition 18\.0\.0\.0\.0 \( Oracle Database Enterprise Edition \)**\. - + Choose **DLP: Oracle Database 12c Enterprise Edition 12\.2\.0\.1\.0 \( Oracle Database Enterprise Edition \)**\. - + Choose **DLP: Oracle Database 12c Enterprise Edition 12\.1\.0\.2\.0 \( Oracle Database Enterprise Edition \)**\. - -1. Choose **Continue**\. - -1. Clear the **Download Queue** check box\. - -1. Choose the option that corresponds to your base release: - + **Oracle Database 19\.3\.0\.0\.0 \- Long Term Release**\. - + **Oracle Database 18\.0\.0\.0\.0** - + **Oracle Database 12\.2\.0\.1\.0**\. - + **Oracle Database 12\.1\.0\.2\.0**\. - -1. Choose **Linux x86\-64** in **Platform/Languages**\. - -1. Choose **Continue**, and then sign the waiver\. - -1. Choose the \.zip file that corresponds to your database release: -[\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/custom-cev.preparing.html) - -1. Download your desired Oracle patches from `updates.oracle.com` or `support.oracle.com` to your local system\. You can find the URLs for the patches in the following locations: - + The readme files in the \.zip file that you downloaded in [Step 1 \(Optional\): Download the manifest templates](#custom-cev.preparing.templates) - + The patches listed in each Release Update \(RU\) in [Release notes for Amazon Relational Database Service \(Amazon RDS\) for Oracle](https://docs.aws.amazon.com/AmazonRDS/latest/OracleReleaseNotes) - -## Step 3: Upload your installation files to Amazon S3 - -Upload your Oracle installation and patch files to Amazon S3 using the AWS CLI\. The S3 bucket that contains your installation files must be in the same AWS Region as your CEV\. - -Choose either of the following options: -+ Use `aws s3 cp` to upload a single \.zip file\. - - Upload each installation \.zip file separately\. Don't combine the \.zip files into a single \.zip file\. -+ Use `aws s3 sync` to upload a directory\. - -List your installation files using either the AWS Management Console or the AWS CLI\. - -Examples in this section use the following placeholders: -+ `install-or-patch-file.zip` – Oracle installation media file\. For example, p32126828\_190000\_Linux\-x86\-64\.zip is a patch\. -+ `my-custom-installation-files` – Your Amazon S3 bucket designated for your uploaded installation files\. -+ `123456789012/cev1` – An optional prefix in your Amazon S3 bucket\. -+ `source-bucket` – An Amazon S3 bucket where you can optionally stage files\. - -The following example uploads `install-or-patch-file.zip` to the `123456789012/cev1` folder in the RDS Custom Amazon S3 bucket\. Run a separate `aws s3` command for each \.zip that you want to upload\. - -For Linux, macOS, or Unix: - -``` -1. aws s3 cp install-or-patch-file.zip \ -2. s3://my-custom-installation-files/123456789012/cev1/ -``` - -For Windows: - -``` -1. aws s3 cp install-or-patch-file.zip ^ -2. s3://my-custom-installation-files/123456789012/cev1/ -``` - -Verify that your S3 bucket is in the AWS Region where you plan to run the `create-custom-db-engine-version` command\. - -``` -aws s3api get-bucket-location --bucket my-custom-installation-files -``` - -List the files in your RDS Custom Amazon S3 bucket as follows\. - -``` -aws s3 ls \ - s3://my-custom-installation-files/123456789012/cev1/ -``` - -The following example uploads the files in your local *cev1* folder to the *123456789012/cev1* folder in your Amazon S3 bucket\. - -For Linux, macOS, or Unix: - -``` -aws s3 sync cev1 \ - s3://my-custom-installation-files/123456789012/cev1/ -``` - -For Windows: - -``` -aws s3 sync cev1 ^ - s3://my-custom-installation-files/123456789012/cev1/ -``` - -The following example uploads all files in `source-bucket` to the **`123456789012/cev1`** folder in your Amazon S3 bucket\. - -For Linux, macOS, or Unix: - -``` -aws s3 sync s3://source-bucket/ \ - s3://my-custom-installation-files/123456789012/cev1/ -``` - -For Windows: - -``` -aws s3 sync s3://source-bucket/ ^ - s3://my-custom-installation-files/123456789012/cev1/ -``` - -## Step 4 \(Optional\): Share your installation media in S3 across AWS accounts - -For the purposes of this section, the Amazon S3 bucket that contains your uploaded Oracle installation files is your *media bucket*\. Your organization might use multiple AWS accounts in an AWS Region\. If so, you might want to use one AWS account to populate your media bucket and a different AWS account to create CEVs\. If you don't intend to share your media bucket, skip to the next section\. - -This section assumes the following: -+ You can access the account that created your media bucket and a different account in which you intend to create CEVs\. -+ You intend to create CEVs in only one AWS Region\. If you intend to use multiple Regions, create a media bucket in each Region\. -+ You're using the CLI\. If you're using the Amazon S3 console, adapt the following steps\. - -**To configure your media bucket for sharing across AWS accounts** - -1. Log in to the AWS account that contains the S3 bucket into which you uploaded your installation media\. - -1. Start with either a blank JSON policy template or an existing policy that you can adapt\. - - The following command retrieves an existing policy and saves it as *my\-policy\.json*\. In this example, the S3 bucket containing your installation files is named *oracle\-media\-bucket*\. - - ``` - aws s3api get-bucket-policy \ - --bucket oracle-media-bucket \ - --query Policy \ - --output text > my-policy.json - ``` - -1. Edit the media bucket permissions as follows: - + In the `Resource` element of your template, specify the S3 bucket into which you uploaded your Oracle Database installation files\. - + In the `Principal` element, specify the ARNs for all AWS accounts that you intend to use to create CEVs\. You can add the root, a user, or a role to the S3 bucket allow list\. For more information, see [IAM identifiers](https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_identifiers.html) in the *AWS Identity and Access Management User Guide*\. - - ``` - { - "Version": "2008-10-17", - "Statement": [ - { - "Sid": "GrantAccountsAccess", - "Effect": "Allow", - "Principal": { - "AWS": [ - "arn:aws:iam::account-1:root", - "arn:aws:iam::account-2:user/user-name-with-path", - "arn:aws:iam::account-3:role/role-name-with-path", - ... - ] - }, - "Action": [ - "s3:GetObject", - "s3:GetObjectAcl", - "s3:GetObjectTagging", - "s3:ListBucket", - "s3:GetBucketLocation" - ], - "Resource": [ - "arn:aws:s3:::oracle-media-bucket", - "arn:aws:s3:::oracle-media-bucket/*" - ] - } - ] - } - ``` - -1. Attach the policy to your media bucket\. - - In the following example, *oracle\-media\-bucket* is the name of the S3 bucket that contains your installation files, and *my\-policy\.json* is the name of your JSON file\. - - ``` - aws s3api put-bucket-policy \ - --bucket oracle-media-bucket \ - --policy file://my-policy.json - ``` - -1. Log in to an AWS account in which you intend to create CEVs\. - -1. Verify that this account can access the media bucket in the AWS account that created it\. - - ``` - aws s3 ls --query "Buckets[].Name" - ``` - - For more information, see [aws s3 ls](https://docs.aws.amazon.com/cli/latest/reference/s3/ls.html) in the *AWS CLI Command Reference*\. - -1. Create a CEV by following the steps in [Creating a CEV](custom-cev.create.md)\. - -## Step 5: Prepare the CEV manifest - -A CEV manifest is a JSON document that includes the following: -+ \(Required\) The list of installation \.zip files that you uploaded to Amazon S3\. RDS Custom applies the patches in the order in which they're listed in the manifest\. -+ \(Optional\) Installation parameters that set nondefault values for the Oracle base, Oracle home, and the ID and name of the UNIX/Linux user and group\. Be aware that you can’t modify the installation parameters for an existing CEV or an existing DB instance\. You also can’t upgrade from one CEV to another CEV when the installation parameters have different settings\. - -For sample CEV manifests, see the JSON templates that you downloaded in [Step 1 \(Optional\): Download the manifest templates](#custom-cev.preparing.templates)\. You can also review the samples in [CEV manifest examples](#custom-cev.preparing.manifest.examples)\. - -**Topics** -+ [JSON fields in the CEV manifest](#custom-cev.preparing.manifest.fields) -+ [Creating the CEV manifest](#custom-cev.preparing.manifest.creating) -+ [CEV manifest examples](#custom-cev.preparing.manifest.examples) - -### JSON fields in the CEV manifest - -The following table describes the JSON fields in the manifest\. - - -**JSON fields in the CEV manifest** - -| JSON field | Description | -| --- | --- | -| `MediaImportTemplateVersion` | Version of the CEV manifest\. The date is in the format `YYYY-MM-DD`\. | -| `databaseInstallationFileNames` | Ordered list of installation files for the database\. | -| `opatchFileNames` | Ordered list of OPatch installers used for the Oracle DB engine\. Only one value is valid\. Values for `opatchFileNames` must start with `p6880880_`\. | -| `psuRuPatchFileNames` | The PSU and RU patches for this database\. If you include `psuRuPatchFileNames`, `opatchFileNames` is required\. Values for `opatchFileNames` must start with `p6880880_`\. | -| `OtherPatchFileNames` | The patches that aren't in the list of PSU and RU patches\. RDS Custom applies these patches after applying the PSU and RU patches\. If you include `OtherPatchFileNames`, `opatchFileNames` is required\. Values for `opatchFileNames` must start with `p6880880_`\. | -| `installationParameters` | Nondefault settings for the Oracle base, Oracle home, and the ID and name of the UNIX/Linux user and group\. You can set the following parameters: [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/custom-cev.preparing.html) | - -Each Oracle Database release has a different list of supported installation files\. When you create your CEV manifest, make sure to specify only files that are supported by RDS Custom for Oracle\. Otherwise, CEV creation fails with an error\. All patches listed in [Release notes for Amazon Relational Database Service \(Amazon RDS\) for Oracle](https://docs.aws.amazon.com/AmazonRDS/latest/OracleReleaseNotes) are supported\. - -### Creating the CEV manifest - -**To create a CEV manifest** - -1. List all installation files that you plan to apply, in the order that you want to apply them\. - -1. Correlate the installation files with the JSON fields described in [JSON fields in the CEV manifest](#custom-cev.preparing.manifest.fields)\. - -1. Do either of the following: - + Create the CEV manifest as a JSON text file\. - + Edit the CEV manifest template when you create the CEV in the console\. For more information, see [Creating a CEV](custom-cev.create.md)\. - -### CEV manifest examples - -The following examples show CEV manifest files for different Oracle Database releases\. If you include a JSON field in your manifest, make sure that it isn't empty\. For example, the following CEV manifest isn't valid because `otherPatchFileNames` is empty\. - -``` -{ - "mediaImportTemplateVersion": "2020-08-14", - "databaseInstallationFileNames": [ - "V982063-01.zip" - ], - "opatchFileNames": [ - "p6880880_190000_Linux-x86-64.zip" - ], - "psuRuPatchFileNames": [ - "p32126828_190000_Linux-x86-64.zip" - ], - "otherPatchFileNames": [ - ] -} -``` - -**Topics** -+ [Sample CEV manifest for Oracle Database 12c Release 1 (12.1)](#oracle-cev-manifest-12.1) -+ [Sample CEV manifest for Oracle Database 12c Release 2 (12.2)](#oracle-cev-manifest-12.2) -+ [Sample CEV manifest for Oracle Database 18c](#oracle-cev-manifest-18c) -+ [Sample CEV manifest for Oracle Database 19c](#oracle-cev-manifest-19c) - -**Example Sample CEV manifest for Oracle Database 12c Release 1 \(12\.1\)** -In the following example for the July 2021 PSU for Oracle Database 12c Release 1 \(12\.1\), RDS Custom applies the patches in the order specified\. Thus, RDS Custom applies p32768233, then p32876425, then p18759211, and so on\. The example sets new values for the UNIX user and group, and the Oracle home and Oracle base\. - -``` -{ - "mediaImportTemplateVersion":"2020-08-14", - "databaseInstallationFileNames":[ - "V46095-01_1of2.zip", - "V46095-01_2of2.zip" - ], - "opatchFileNames":[ - "p6880880_121010_Linux-x86-64.zip" - ], - "psuRuPatchFileNames":[ - "p32768233_121020_Linux-x86-64.zip" - ], - "otherPatchFileNames":[ - "p32876425_121020_Linux-x86-64.zip", - "p18759211_121020_Linux-x86-64.zip", - "p19396455_121020_Linux-x86-64.zip", - "p20875898_121020_Linux-x86-64.zip", - "p22037014_121020_Linux-x86-64.zip", - "p22873635_121020_Linux-x86-64.zip", - "p23614158_121020_Linux-x86-64.zip", - "p24701840_121020_Linux-x86-64.zip", - "p25881255_121020_Linux-x86-64.zip", - "p27015449_121020_Linux-x86-64.zip", - "p28125601_121020_Linux-x86-64.zip", - "p28852325_121020_Linux-x86-64.zip", - "p29997937_121020_Linux-x86-64.zip", - "p31335037_121020_Linux-x86-64.zip", - "p32327201_121020_Linux-x86-64.zip", - "p32327208_121020_Generic.zip", - "p17969866_12102210119_Linux-x86-64.zip", - "p20394750_12102210119_Linux-x86-64.zip", - "p24835919_121020_Linux-x86-64.zip", - "p23262847_12102201020_Linux-x86-64.zip", - "p21171382_12102201020_Generic.zip", - "p21091901_12102210720_Linux-x86-64.zip", - "p33013352_12102210720_Linux-x86-64.zip", - "p25031502_12102210720_Linux-x86-64.zip", - "p23711335_12102191015_Generic.zip", - "p19504946_121020_Linux-x86-64.zip" - ], - "installationParameters": { - "unixGroupName": "dba", - "unixGroupId": 12345, - "unixUname": "oracle", - "unixUid": 12345, - "oracleHome": "/home/oracle/oracle.12.1.0.2", - "oracleBase": "/home/oracle" - } -} -``` - -**Example Sample CEV manifest for Oracle Database 12c Release 2 \(12\.2\)** -In following example for the October 2021 PSU for Oracle Database 12c Release 2 \(12\.2\), RDS Custom applies p33261817, then p33192662, then p29213893, and so on\. The example sets new values for the UNIX user and group, and the Oracle home and Oracle base\. - -``` -{ - "mediaImportTemplateVersion":"2020-08-14", - "databaseInstallationFileNames":[ - "V839960-01.zip" - ], - "opatchFileNames":[ - "p6880880_122010_Linux-x86-64.zip" - ], - "psuRuPatchFileNames":[ - "p33261817_122010_Linux-x86-64.zip" - ], - "otherPatchFileNames":[ - "p33192662_122010_Linux-x86-64.zip", - "p29213893_122010_Generic.zip", - "p28730253_122010_Linux-x86-64.zip", - "p26352615_12201211019DBOCT2021RU_Linux-x86-64.zip", - "p23614158_122010_Linux-x86-64.zip", - "p24701840_122010_Linux-x86-64.zip", - "p25173124_122010_Linux-x86-64.zip", - "p25881255_122010_Linux-x86-64.zip", - "p27015449_122010_Linux-x86-64.zip", - "p28125601_122010_Linux-x86-64.zip", - "p28852325_122010_Linux-x86-64.zip", - "p29997937_122010_Linux-x86-64.zip", - "p31335037_122010_Linux-x86-64.zip", - "p32327201_122010_Linux-x86-64.zip", - "p32327208_122010_Generic.zip" - ], - "installationParameters": { - "unixGroupName": "dba", - "unixGroupId": 12345, - "unixUname": "oracle", - "unixUid": 12345, - "oracleHome": "/home/oracle/oracle.12.2.0.1", - "oracleBase": "/home/oracle" - } -} -``` - -**Example Sample CEV manifest for Oracle Database 18c** -In following example for the October 2021 PSU for Oracle Database 18c, RDS Custom applies p32126855, then p28730253, then p27539475, and so on\. The example sets new values for the UNIX user and group, and the Oracle home and Oracle base\. - -``` -{ - "mediaImportTemplateVersion":"2020-08-14", - "databaseInstallationFileNames":[ - "V978967-01.zip" - ], - "opatchFileNames":[ - "p6880880_180000_Linux-x86-64.zip" - ], - "psuRuPatchFileNames":[ - "p32126855_180000_Linux-x86-64.zip" - ], - "otherPatchFileNames":[ - "p28730253_180000_Linux-x86-64.zip", - "p27539475_1813000DBRU_Linux-x86-64.zip", - "p29213893_180000_Generic.zip", - "p29374604_1813000DBRU_Linux-x86-64.zip", - "p29782284_180000_Generic.zip", - "p28125601_180000_Linux-x86-64.zip", - "p28852325_180000_Linux-x86-64.zip", - "p29997937_180000_Linux-x86-64.zip", - "p31335037_180000_Linux-x86-64.zip", - "p31335142_180000_Generic.zip" - ] - "installationParameters": { - "unixGroupName": "dba", - "unixGroupId": 12345, - "unixUname": "oracle", - "unixUid": 12345, - "oracleHome": "/home/oracle/18.0.0.0.ru-2020-10.rur-2020-10.r1", - "oracleBase": "/home/oracle/" - } -} -``` - -**Example Sample CEV manifest for Oracle Database 19c** -In the following example for Oracle Database 19c, RDS Custom applies p32126828, then p29213893, then p29782284, and so on\. The example sets new values for the UNIX user and group, and the Oracle home and Oracle base\. - -``` -{ - "mediaImportTemplateVersion": "2020-08-14", - "databaseInstallationFileNames": [ - "V982063-01.zip" - ], - "opatchFileNames": [ - "p6880880_190000_Linux-x86-64.zip" - ], - "psuRuPatchFileNames": [ - "p32126828_190000_Linux-x86-64.zip" - ], - "otherPatchFileNames": [ - "p29213893_1910000DBRU_Generic.zip", - "p29782284_1910000DBRU_Generic.zip", - "p28730253_190000_Linux-x86-64.zip", - "p29374604_1910000DBRU_Linux-x86-64.zip", - "p28852325_190000_Linux-x86-64.zip", - "p29997937_190000_Linux-x86-64.zip", - "p31335037_190000_Linux-x86-64.zip", - "p31335142_190000_Generic.zip" - ], - "installationParameters": { - "unixGroupName": "dba", - "unixGroupId": 12345, - "unixUname": "oracle", - "unixUid": 12345, - "oracleHome": "/home/oracle/oracle.19.0.0.0.ru-2020-04.rur-2020-04.r1.EE.1", - "oracleBase": "/home/oracle" - } -} -``` - -## Step 6 \(Optional\): Validate the CEV manifest - -Optionally, verify that manifest is a valid JSON file by running the `json.tool` Python script\. For example, if you change into the directory containing a CEV manifest named `manifest.json`, run the following command\. - -``` -python -m json.tool < manifest.json -``` - -## Step 7: Add necessary IAM permissions - -Make sure that the IAM principal that creates the CEV has the necessary policies described in [Step 4: Grant required permissions to your IAM user or role](custom-setup-orcl.md#custom-setup-orcl.iam-user)\. \ No newline at end of file diff --git a/doc_source/custom-cev.view.md b/doc_source/custom-cev.view.md deleted file mode 100644 index 08f497e..0000000 --- a/doc_source/custom-cev.view.md +++ /dev/null @@ -1,74 +0,0 @@ -# Viewing CEV details - -You can view details about your CEV manifest and the command used to create your CEV by using the AWS Management Console or the AWS CLI\. - -## Console - -**To view CEV details** - -1. Sign in to the AWS Management Console and open the Amazon RDS console at [https://console\.aws\.amazon\.com/rds/](https://console.aws.amazon.com/rds/)\. - -1. In the navigation pane, choose **Custom engine versions**\. - - The **Custom engine versions** page shows all CEVs that currently exist\. If you haven't created any CEVs, the page is empty\. - -1. Choose the name of the CEV that you want to view\. - -1. Choose **Configuration** to view the installation parameters specified in your manifest\. -![\[View the installation parameters for a CEV.\]](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/images/cev-configuration-tab.png) - -1. Choose **Manifest** to view the installation parameters specified in the `--manifest` option of the `create-custom-db-engine-version` command\. You can copy this text, replace values as needed, and use them in a new command\. -![\[View the command used to create the CEV.\]](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/images/cev-manifest-tab.png) - -## AWS CLI - -To view details about a CEV by using the AWS CLI, run the [describe\-db\-engine\-versions](https://docs.aws.amazon.com/cli/latest/reference/rds/describe-db-engine-versions.html) command\. - -The following options are required: -+ `--engine custom-oracle-ee` -+ `--engine-version major-engine-version.customized_string` - -The following example creates a CEV named `19.my_cev1`\. Make sure that the name of your CEV starts with the major engine version number\. - -**Example** -For Linux, macOS, or Unix: - -``` -1. aws rds describe-db-engine-versions \ -2. --engine custom-oracle-ee \ -3. --engine-version 19.my_cev1 -``` -For Windows: - -``` -1. aws rds describe-db-engine-versions ^ -2. --engine custom-oracle-ee ^ -3. --engine-version 19.my_cev1 -``` -The following partial sample output shows the engine, parameter groups, manifest, and other information\. - -``` - 1. "DBEngineVersions": [ - 2. { - 3. "Engine": "custom-oracle-ee", - 4. "MajorEngineVersion": "19", - 5. "EngineVersion": "19.my_cev1", - 6. "DatabaseInstallationFilesS3BucketName": "us-east-1-123456789012-cev-customer-installation-files", - 7. "DatabaseInstallationFilesS3Prefix": "123456789012/cev1", - 8. "CustomDBEngineVersionManifest": "{\n\"mediaImportTemplateVersion\": \"2020-08-14\",\n\"databaseInstallationFileNames\": [\n\"V982063-01.zip\"\n],\n\"installationParameters\": {\n\"oracleBase\":\"/tmp\",\n\"oracleHome\":\"/tmp/Oracle\"\n},\n\"opatchFileNames\": [\n\"p6880880_190000_Linux-x86-64.zip\"\n],\n\"psuRuPatchFileNames\": [\n\"p32126828_190000_Linux-x86-64.zip\"\n],\n\"otherPatchFileNames\": [\n\"p29213893_1910000DBRU_Generic.zip\",\n\"p29782284_1910000DBRU_Generic.zip\",\n\"p28730253_190000_Linux-x86-64.zip\",\n\"p29374604_1910000DBRU_Linux-x86-64.zip\",\n\"p28852325_190000_Linux-x86-64.zip\",\n\"p29997937_190000_Linux-x86-64.zip\",\n\"p31335037_190000_Linux-x86-64.zip\",\n\"p31335142_190000_Generic.zip\"\n]\n}\n", - 9. "DBParameterGroupFamily": "custom-oracle-ee-19", -10. "DBEngineDescription": "Oracle Database server EE for RDS Custom", -11. "DBEngineVersionArn": "arn:aws:rds:us-west-2:123456789012:cev:custom-oracle-ee/19.my_cev1/0a123b45-6c78-901d-23e4-5678f901fg23", -12. "DBEngineVersionDescription": "test", -13. "KMSKeyId": "arn:aws:kms:us-east-1:123456789012:key/ab1c2de3-f4g5-6789-h012-h3ijk4567l89", -14. "CreateTime": "2022-11-18T09:17:07.693000+00:00", -15. "ValidUpgradeTarget": [ -16. { -17. "Engine": "custom-oracle-ee", -18. "EngineVersion": "19.cev.2021-01.09", -19. "Description": "test", -20. "AutoUpgrade": false, -21. "IsMajorVersionUpgrade": false -22. } -23. ] -``` \ No newline at end of file diff --git a/doc_source/custom-concept.md b/doc_source/custom-concept.md deleted file mode 100644 index e0a2757..0000000 --- a/doc_source/custom-concept.md +++ /dev/null @@ -1,74 +0,0 @@ -# Amazon RDS Custom architecture - -Amazon RDS Custom architecture is based on Amazon RDS, with important differences\. The following diagram shows the key components of the RDS Custom architecture\. - -![\[RDS Custom architecture components\]](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/./images/RDS_Custom_gen_architecture.png) - -**Topics** -+ [VPC](#custom-concept.components.VPC) -+ [Amazon S3](#custom-concept.components.S3) -+ [AWS CloudTrail](#custom-concept.components.CloudTrail) -+ [RDS Custom automation and monitoring](#custom-concept.workflow.automation) - -## VPC - -As in Amazon RDS, your RDS Custom DB instance resides in a virtual private cloud \(VPC\)\. - -![\[RDS Custom DB instance components\]](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/./images/RDS_Custom_instance.png) - -The DB instance consists of the following main components: -+ Amazon EC2 instance -+ Instance endpoint -+ Operating system installed on the Amazon EC2 instance -+ Amazon EBS storage, which contains any additional file systems - -## Amazon S3 - -If you use RDS Custom for Oracle, you upload installation media to a user\-created Amazon S3 bucket\. RDS Custom for Oracle uses the media in this bucket to create a custom engine version \(CEV\)\. A *CEV* is a binary volume snapshot of a database version and Amazon Machine Image \(AMI\)\. From the CEV, you can create an RDS Custom DB instance\. For more information, see [Working with custom engine versions for Amazon RDS Custom for Oracle](custom-cev.md)\. - -For both RDS Custom for Oracle and RDS Custom for SQL Server, RDS Custom automatically creates an Amazon S3 bucket prefixed with the string `do-not-delete-rds-custom-`\. RDS Custom uses the `do-not-delete-rds-custom-` S3 bucket to store the following types of files: -+ AWS CloudTrail logs for the trail created by RDS Custom -+ Support perimeter artifacts \(see [Support perimeter](#custom-concept.workflow.automation.support-perimeter)\) -+ Database redo log files \(RDS Custom for Oracle only\) -+ Transaction logs \(RDS Custom for SQL Server only\) -+ Custom engine version artifacts \(RDS Custom for Oracle only\) - -RDS Custom creates the `do-not-delete-rds-custom-` S3 bucket when you create either of the following resources: -+ Your first CEV for RDS Custom for Oracle -+ Your first DB instance for RDS Custom for SQL Server - -RDS Custom creates one bucket for each combination of the following: -+ AWS account ID -+ Engine type \(either RDS Custom for Oracle or RDS Custom for SQL Server\) -+ AWS Region - -For example, if you create RDS Custom for Oracle CEVs in a single AWS Region, one `do-not-delete-rds-custom-` bucket exists\. If you create multiple RDS Custom for SQL Server instances, and they reside in different AWS Regions, one `do-not-delete-rds-custom-` bucket exists in each AWS Region\. If you create one RDS Custom for Oracle instance and two RDS Custom for SQL Server instances in a single AWS Region, two `do-not-delete-rds-custom-` buckets exist\. - -## AWS CloudTrail - -RDS Custom automatically creates an AWS CloudTrail trail whose name begins with `do-not-delete-rds-custom-`\. The RDS Custom support perimeter relies on the events from CloudTrail to determine whether your actions affect RDS Custom automation\. For more information, see [Support perimeter](#custom-concept.workflow.automation.support-perimeter)\. - -RDS Custom creates the trail when you create your first DB instance\. RDS Custom creates one trail for each combination of the following: -+ AWS account ID -+ Engine type \(either RDS Custom for Oracle or RDS Custom for SQL Server\) -+ AWS Region - -## RDS Custom automation and monitoring - -RDS Custom has automation software that runs outside of the DB instance\. This software communicates with agents on the DB instance and with other components within the overall RDS Custom environment\. - -### Monitoring and recovery - -The RDS Custom monitoring and recovery features offer similar functionality to Amazon RDS\. By default, RDS Custom is in full automation mode\. The automation software has the following primary responsibilities: -+ Collect metrics and send notifications -+ Perform automatic instance recovery - -An important responsibility of RDS Custom automation is responding to problems with your Amazon EC2 instance\. For various reasons, the host might become impaired or unreachable\. RDS Custom resolves these problems by either rebooting or replacing the Amazon EC2 instance\. - -The automated replacement preserves all database data\. On RDS Custom for SQL Server, host replacement doesn't preserve operating system customizations or data on the C: drive\. - -The only customer\-visible change when a host is replaced is a new public IP address\. For more information, see [How Amazon RDS Custom replaces an impaired host](custom-troubleshooting.md#custom-troubleshooting.host-problems)\. - -### Support perimeter - -RDS Custom provides additional monitoring capability called the *support perimeter*\. This additional monitoring ensures that your RDS Custom instance uses a supported AWS infrastructure, operating system, and database\. For more information about the support perimeter, see [RDS Custom support perimeter and unsupported configurations](custom-troubleshooting.md#custom-troubleshooting.support-perimeter)\. \ No newline at end of file diff --git a/doc_source/custom-concept.workflow.md b/doc_source/custom-concept.workflow.md deleted file mode 100644 index 6da1677..0000000 --- a/doc_source/custom-concept.workflow.md +++ /dev/null @@ -1,67 +0,0 @@ -# RDS Custom for Oracle workflow - -The following diagram shows the typical workflow for RDS Custom for Oracle\. - -![\[RDS Custom for Oracle architecture components\]](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/./images/RDS_Custom_architecture_v2.png) - -The steps are as follows: - -1. Upload your database software to your Amazon S3 bucket\. - - For more information, see [Step 3: Upload your installation files to Amazon S3](custom-cev.preparing.md#custom-cev.preparing.s3)\. - -1. Create an RDS Custom for Oracle custom engine version \(CEV\) from your media\. - - For more information, see [Creating a CEV](custom-cev.create.md)\. - -1. Create an RDS Custom for Oracle DB instance from a CEV\. - - For more information, see [Creating an RDS Custom for Oracle DB instance](custom-creating.md#custom-creating.create)\. - -1. Connect your application to the DB instance endpoint\. - - For more information, see [Connecting to your RDS Custom DB instance using SSH](custom-creating.md#custom-creating.ssh) and [Connecting to your RDS Custom DB instance using Session Manager](custom-creating.md#custom-creating.ssm)\. - -1. \(Optional\) Access the host to customize your software\. - -1. Monitor notifications and messages generated by RDS Custom automation\. - -## Database installation files - -Your responsibility for media is a key difference between Amazon RDS and RDS Custom\. Amazon RDS, which is a fully managed service, supplies the Amazon Machine Image \(AMI\) and database software\. The Amazon RDS database software is preinstalled, so you need only choose a database engine and version, and create your database\. - -For RDS Custom, you supply your own media\. When you create a custom engine version, RDS Custom installs the media that you provide\. RDS Custom media contains your database installation files and patches\. This service model is called Bring Your Own Media \(BYOM\)\. - -## Custom engine version - -An RDS Custom custom engine version \(CEV\) is a binary volume snapshot of a database version and AMI\. By default, RDS Custom for Oracle uses the most recent AMI that Amazon EC2 makes available\. You can also choose to reuse an existing AMI\. - -You store your database installation files in Amazon S3\. When you create your CEV, you specify the files in a JSON document called a CEV manifest\. You can also specify installation parameters that set nondefault values for the Oracle base, Oracle home, and the ID and name of the UNIX/Linux user and group\. - -Name your CEV using a customer\-specified string\. The name format is the following, depending on your Oracle Database release: -+ `19.customized_string` -+ `18.customized_string` -+ `12.2.customized_string` -+ `12.1.customized_string` - -You can use 1–50 alphanumeric characters, underscores, dashes, and periods\. For example, you might name your CEV `19.my_cev1`\. When you create a CEV, you can specify the Oracle Multitenant option\. You can create container databases \(CDBs\) only when the CEV was created with the Oracle Multitenant option\. For more information, see [Working with custom engine versions for Amazon RDS Custom for Oracle](custom-cev.md)\. - -## Creating a DB instance for RDS Custom for Oracle - -After you create your CEV, it's available for use\. You can create multiple CEVs, and you can create multiple RDS Custom for Oracle DB instances from any CEV\. You can also change the status of a CEV to make it available or inactive\. - -You can either create your RDS Custom for Oracle DB instance with the Oracle Multitenant architecture \(`custom-oracle-ee-cdb` engine type\) or with the traditional non\-CDB architecture \(`custom-oracle-ee` engine type\)\. When you create a container database \(CDB\), it contains one pluggable database \(PDB\) and one PDB seed\. You can create additional PDBs manually using Oracle SQL\. - -To create your RDS Custom for Oracle DB instance, use the `create-db-instance` command\. In this command, specify which CEV to use\. The procedure is similar to creating an Amazon RDS DB instance\. However, some parameters are different\. For more information, see [Configuring a DB instance for Amazon RDS Custom for Oracle](custom-creating.md)\. - -## Database connection - -Like an Amazon RDS DB instance, an RDS Custom DB instance resides in a virtual private cloud \(VPC\)\. Your application connects to the Oracle database using an Oracle listener\. - -If your database is a CDB, you can use the listener `L_RDSCDB_001` to connect to the CDB root and to a PDB\. If you plug a non\-CDB into a CDB, make sure to set `USE_SID_AS_SERVICE_LISTENER = ON` so that migrated applications keep the same settings\. - -When you connect to a non\-CDB, the master user is the user for the non\-CDB\. When you connect to a CDB, the master user is the user for the PDB\. To connect to the CDB root, log in to the host, start a SQL client, and create an administrative user with SQL commands\. - -## RDS Custom customization - -You can access the RDS Custom host to install or customize software\. To avoid conflicts between your changes and the RDS Custom automation, you can pause the automation for a specified period\. During this period, RDS Custom doesn't perform monitoring or instance recovery\. At the end of the period, RDS Custom resumes full automation\. For more information, see [Pausing and resuming your RDS Custom DB instance](custom-managing.md#custom-managing.pausing)\. \ No newline at end of file diff --git a/doc_source/custom-creating-sqlserver.md b/doc_source/custom-creating-sqlserver.md deleted file mode 100644 index 949532f..0000000 --- a/doc_source/custom-creating-sqlserver.md +++ /dev/null @@ -1,412 +0,0 @@ -# Creating and connecting to a DB instance for Amazon RDS Custom for SQL Server - -You can create an RDS Custom DB instance, and then connect to it using AWS Systems Manager or Remote Desktop Protocol \(RDP\)\. - -**Important** -Before you can create or connect to an RDS Custom for SQL Server DB instance, make sure to complete the tasks in [Setting up your environment for Amazon RDS Custom for SQL Server](custom-setup-sqlserver.md)\. -You can tag RDS Custom DB instances when you create them, but don't create or modify the `AWSRDSCustom` tag that's required for RDS Custom automation\. For more information, see [Tagging RDS Custom for SQL Server resources](custom-managing-sqlserver.md#custom-managing-sqlserver.tagging)\. -The first time that you create an RDS Custom for SQL Server DB instance, you might receive the following error: The service\-linked role is in the process of being created\. Try again later\. If you do, wait a few minutes and then try again to create the DB instance\. - -**Topics** -+ [Creating an RDS Custom for SQL Server DB instance](#custom-creating-sqlserver.create) -+ [RDS Custom service\-linked role](#custom-creating-sqlserver.slr) -+ [Connecting to your RDS Custom DB instance using AWS Systems Manager](#custom-creating-sqlserver.ssm) -+ [Connecting to your RDS Custom DB instance using RDP](#custom-creating-sqlserver.rdp) - -## Creating an RDS Custom for SQL Server DB instance - -Create an Amazon RDS Custom for SQL Server DB instance using either the AWS Management Console or the AWS CLI\. The procedure is similar to the procedure for creating an Amazon RDS DB instance\. - -For more information, see [Creating an Amazon RDS DB instance](USER_CreateDBInstance.md)\. - -### Console - -**To create an RDS Custom for SQL Server DB instance** - -1. Sign in to the AWS Management Console and open the Amazon RDS console at [https://console\.aws\.amazon\.com/rds/](https://console.aws.amazon.com/rds/)\. - -1. In the navigation pane, choose **Databases**\. - -1. Choose **Create database**\. - -1. Choose **Standard create** for the database creation method\. - -1. For **Engine options**, choose **Microsoft SQL Server** for the engine type\. - -1. For **Database management type**, choose **Amazon RDS Custom**\. - -1. In the **Edition** section, choose the DB engine edition that you want to use\. For RDS Custom for SQL Server, the choices are Enterprise, Standard, and Web\. - -1. \(Optional\) If you intend to create the DB instance from a CEV, check the **Use custom engine version \(CEV\)** check box\. Select your CEV in the drop\-down list\. - -1. For **Database version**, keep the SQL Server 2019 default value\. - -1. For **Templates**, choose **Production**\. - -1. In the **Settings** section, enter a unique name for the **DB instance identifier**\. - -1. To enter your master password, do the following: - - 1. In the **Settings** section, open **Credential Settings**\. - - 1. Clear the **Auto generate a password** check box\. - - 1. Change the **Master username** value and enter the same password in **Master password** and **Confirm password**\. - - By default, the new RDS Custom DB instance uses an automatically generated password for the master user\. - -1. In the **DB instance size** section, choose a value for **DB instance class**\. - - For supported classes, see [DB instance class support for RDS Custom for SQL Server](custom-reqs-limits-MS.md#custom-reqs-limits.instancesMS)\. - -1. Choose **Storage** settings\. - -1. For **RDS Custom security**, do the following: - - 1. For **IAM instance profile**, choose the instance profile for your RDS Custom for SQL Server DB instance\. - - The IAM instance profile must begin with `AWSRDSCustom`, for example `AWSRDSCustomInstanceProfileForRdsCustomInstance`\. - - 1. For **Encryption**, choose **Enter a key ARN** to list the available AWS KMS keys\. Then choose your key from the list\. - - An AWS KMS key is required for RDS Custom\. For more information, see [Make sure that you have a symmetric encryption AWS KMS key](custom-setup-sqlserver.md#custom-setup-sqlserver.cmk)\. - -1. For the remaining sections, specify your preferred RDS Custom DB instance settings\. For information about each setting, see [Settings for DB instances](USER_CreateDBInstance.md#USER_CreateDBInstance.Settings)\. The following settings don't appear in the console and aren't supported: - + **Processor features** - + **Storage autoscaling** - + **Availability & durability** - + **Password and Kerberos authentication** option in **Database authentication** \(only **Password authentication** is supported\) - + **Database options** group in **Additional configuration** - + **Performance Insights** - + **Log exports** - + **Enable auto minor version upgrade** - + **Deletion protection** - - **Backup retention period** is supported, but you can't choose **0 days**\. - -1. Choose **Create database**\. - - The **View credential details** button appears on the **Databases** page\. - - To view the master user name and password for the RDS Custom DB instance, choose **View credential details**\. - - To connect to the DB instance as the master user, use the user name and password that appear\. -**Important** -You can't view the master user password again\. If you don't record it, you might have to change it\. To change the master user password after the RDS Custom DB instance is available, modify the DB instance\. For more information about modifying a DB instance, see [Managing an Amazon RDS Custom for SQL Server DB instance](custom-managing-sqlserver.md)\. - -1. Choose **Databases** to view the list of RDS Custom DB instances\. - -1. Choose the RDS Custom DB instance that you just created\. - - On the RDS console, the details for the new RDS Custom DB instance appear: - + The DB instance has a status of **creating** until the RDS Custom DB instance is created and ready for use\. When the state changes to **available**, you can connect to the DB instance\. Depending on the instance class and storage allocated, it can take several minutes for the new DB instance to be available\. - + **Role** has the value **Instance \(RDS Custom\)**\. - + **RDS Custom automation mode** has the value **Full automation**\. This setting means that the DB instance provides automatic monitoring and instance recovery\. - -### AWS CLI - -You create an RDS Custom DB instance by using the [create\-db\-instance](https://docs.aws.amazon.com/cli/latest/reference/rds/create-db-instance.html) AWS CLI command\. - -The following options are required: -+ `--db-instance-identifier` -+ `--db-instance-class` \(for a list of supported instance classes, see [DB instance class support for RDS Custom for SQL Server](custom-reqs-limits-MS.md#custom-reqs-limits.instancesMS)\) -+ `--engine` \(`custom-sqlserver-ee`, `custom-sqlserver-se`, or `custom-sqlserver-web`\) -+ `--kms-key-id` -+ `--custom-iam-instance-profile` - -The following example creates an RDS Custom for SQL Server DB instance named `my-custom-instance`\. The backup retention period is 3 days\. - -**Note** -To create a DB instance from a custom engine version \(CEV\), supply an existing CEV name to the `--engine-version` parameter\. For example, `--engine-version 15.00.4249.2.my_cevtest` - -**Example** -For Linux, macOS, or Unix: - -``` - 1. aws rds create-db-instance \ - 2. --engine custom-sqlserver-ee \ - 3. --engine-version 15.00.4073.23.v1 \ - 4. --db-instance-identifier my-custom-instance \ - 5. --db-instance-class db.m5.xlarge \ - 6. --allocated-storage 20 \ - 7. --db-subnet-group mydbsubnetgroup \ - 8. --master-username myuser \ - 9. --master-user-password mypassword \ -10. --backup-retention-period 3 \ -11. --no-multi-az \ -12. --port 8200 \ -13. --kms-key-id mykmskey \ -14. --custom-iam-instance-profile AWSRDSCustomInstanceProfileForRdsCustomInstance -``` -For Windows: - -``` - 1. aws rds create-db-instance ^ - 2. --engine custom-sqlserver-ee ^ - 3. --engine-version 15.00.4073.23.v1 ^ - 4. --db-instance-identifier my-custom-instance ^ - 5. --db-instance-class db.m5.xlarge ^ - 6. --allocated-storage 20 ^ - 7. --db-subnet-group mydbsubnetgroup ^ - 8. --master-username myuser ^ - 9. --master-user-password mypassword ^ -10. --backup-retention-period 3 ^ -11. --no-multi-az ^ -12. --port 8200 ^ -13. --kms-key-id mykmskey ^ -14. --custom-iam-instance-profile AWSRDSCustomInstanceProfileForRdsCustomInstance -``` - -Get details about your instance by using the `describe-db-instances` command\. - -``` -1. aws rds describe-db-instances --db-instance-identifier my-custom-instance -``` - -The following partial output shows the engine, parameter groups, and other information\. - -``` - 1. { - 2. "DBInstances": [ - 3. { - 4. "PendingModifiedValues": {}, - 5. "Engine": "custom-sqlserver-ee", - 6. "MultiAZ": false, - 7. "DBSecurityGroups": [], - 8. "DBParameterGroups": [ - 9. { -10. "DBParameterGroupName": "default.custom-sqlserver-ee-15", -11. "ParameterApplyStatus": "in-sync" -12. } -13. ], -14. "AutomationMode": "full", -15. "DBInstanceIdentifier": "my-custom-instance", -16. "TagList": [] -17. } -18. ] -19. } -``` - -## RDS Custom service\-linked role - -A *service\-linked role* gives Amazon RDS Custom access to resources in your AWS account\. It makes using RDS Custom easier because you don't have to manually add the necessary permissions\. RDS Custom defines the permissions of its service\-linked roles, and unless defined otherwise, only RDS Custom can assume its roles\. The defined permissions include the trust policy and the permissions policy, and that permissions policy can't be attached to any other IAM entity\. - -When you create an RDS Custom DB instance, both the Amazon RDS and RDS Custom service\-linked roles are created \(if they don't already exist\) and used\. For more information, see [Using service\-linked roles for Amazon RDS](UsingWithRDS.IAM.ServiceLinkedRoles.md)\. - -The first time that you create an RDS Custom for SQL Server DB instance, you might receive the following error: The service\-linked role is in the process of being created\. Try again later\. If you do, wait a few minutes and then try again to create the DB instance\. - -## Connecting to your RDS Custom DB instance using AWS Systems Manager - -After you create your RDS Custom DB instance, you can connect to it using AWS Systems Manager Session Manager\. Session Manager is a Systems Manager capability that you can use to manage Amazon EC2 instances through a browser\-based shell or through the AWS CLI\. For more information, see [AWS Systems Manager Session Manager](https://docs.aws.amazon.com/systems-manager/latest/userguide/session-manager.html)\. - -### Console - -**To connect to your DB instance using Session Manager** - -1. Sign in to the AWS Management Console and open the Amazon RDS console at [https://console\.aws\.amazon\.com/rds/](https://console.aws.amazon.com/rds/)\. - -1. In the navigation pane, choose **Databases**, and then choose the RDS Custom DB instance to which you want to connect\. - -1. Choose **Configuration**\. - -1. Note the **Resource ID** value for your DB instance\. For example, the resource ID might be `db-ABCDEFGHIJKLMNOPQRS0123456`\. - -1. Open the Amazon EC2 console at [https://console\.aws\.amazon\.com/ec2/](https://console.aws.amazon.com/ec2/)\. - -1. In the navigation pane, choose **Instances**\. - -1. Look for the name of your EC2 instance, and then choose the instance ID associated with it\. For example, the instance ID might be `i-abcdefghijklm01234`\. - -1. Choose **Connect**\. - -1. Choose **Session Manager**\. - -1. Choose **Connect**\. - - A window opens for your session\. - -### AWS CLI - -You can connect to your RDS Custom DB instance using the AWS CLI\. This technique requires the Session Manager plugin for the AWS CLI\. To learn how to install the plugin, see [Install the Session Manager plugin for the AWS CLI](https://docs.aws.amazon.com/systems-manager/latest/userguide/session-manager-working-with-install-plugin.html)\. - -To find the DB resource ID of your RDS Custom DB instance, use `[describe\-db\-instances](https://docs.aws.amazon.com/cli/latest/reference/rds/describe-db-instances.html)`\. - -``` -aws rds describe-db-instances \ - --query 'DBInstances[*].[DBInstanceIdentifier,DbiResourceId]' \ - --output text -``` - -The following sample output shows the resource ID for your RDS Custom instance\. The prefix is `db-`\. - -``` -db-ABCDEFGHIJKLMNOPQRS0123456 -``` - -To find the EC2 instance ID of your DB instance, use `aws ec2 describe-instances`\. The following example uses `db-ABCDEFGHIJKLMNOPQRS0123456` for the resource ID\. - -``` -aws ec2 describe-instances \ - --filters "Name=tag:Name,Values=db-ABCDEFGHIJKLMNOPQRS0123456" \ - --output text \ - --query 'Reservations[*].Instances[*].InstanceId' -``` - -The following sample output shows the EC2 instance ID\. - -``` -i-abcdefghijklm01234 -``` - -Use the `aws ssm start-session` command, supplying the EC2 instance ID in the `--target` parameter\. - -``` -aws ssm start-session --target "i-abcdefghijklm01234" -``` - -A successful connection looks like the following\. - -``` -Starting session with SessionId: yourid-abcdefghijklm1234 -[ssm-user@ip-123-45-67-89 bin]$ -``` - -## Connecting to your RDS Custom DB instance using RDP - -After you create your RDS Custom DB instance, you can connect to this instance using an RDP client\. The procedure is the same as for connecting to an Amazon EC2 instance\. For more information, see [Connect to your Windows instance](https://docs.aws.amazon.com/AWSEC2/latest/WindowsGuide/connecting_to_windows_instance.html)\. - -To connect to the DB instance, you need the key pair associated with the instance\. RDS Custom creates the key pair for you\. The pair name uses the prefix `do-not-delete-rds-custom-DBInstanceIdentifier`\. AWS Secrets Manager stores your private key as a secret\. - -Complete the task in the following steps: - -1. [Configure your DB instance to allow RDP connections](#custom-creating-sqlserver.rdp.port)\. - -1. [Retrieve your secret key](#custom-creating-sqlserver.rdp.key)\. - -1. [Connect to your EC2 instance using the RDP utility](#custom-creating-sqlserver.rdp.connect)\. - -### Configure your DB instance to allow RDP connections - -To allow RDP connections, configure your VPC security group and set a firewall rule on the host\. - -#### Configure your VPC security group - -Make sure that the VPC security group associated with your DB instance permits inbound connections on port 3389 for Transmission Control Protocol \(TCP\)\. To learn how to configure your VPC security group, see [Configure your VPC security group](custom-setup-sqlserver.md#custom-setup-sqlserver.vpc.sg)\. - -#### Set the firewall rule on the host - -To permit inbound connections on port 3389 for TCP, set a firewall rule on the host\. The following examples show how to do this\. - -We recommend that you use the specific `-Profile` value: `Public`, `Private`, or `Domain`\. Using `Any` refers to all three values\. You can also specify a combination of values separated by a comma\. For more information about setting firewall rules, see [Set\-NetFirewallRule](https://docs.microsoft.com/en-us/powershell/module/netsecurity/set-netfirewallrule?view=windowsserver2019-ps) in the Microsoft documentation\. - -**To use Systems Manager Session Manager to set a firewall rule** - -1. Connect to Session Manager as shown in [Connecting to your RDS Custom DB instance using AWS Systems Manager](#custom-creating-sqlserver.ssm)\. - -1. Run the following command\. - - ``` - Set-NetFirewallRule -DisplayName "Remote Desktop - User Mode (TCP-In)" -Direction Inbound -LocalAddress Any -Profile Any - ``` - -**To use Systems Manager CLI commands to set a firewall rule** - -1. Use the following command to open RDP on the host\. - - ``` - OPEN_RDP_COMMAND_ID=$(aws ssm send-command --region $AWS_REGION \ - --instance-ids $RDS_CUSTOM_INSTANCE_EC2_ID \ - --document-name "AWS-RunPowerShellScript" \ - --parameters '{"commands":["Set-NetFirewallRule -DisplayName \"Remote Desktop - User Mode (TCP-In)\" -Direction Inbound -LocalAddress Any -Profile Any"]}' \ - --comment "Open RDP port" | jq -r ".Command.CommandId") - ``` - -1. Use the command ID returned in the output to get the status of the previous command\. To use the following query to return the command ID, make sure that you have the jq plug\-in installed\. - - ``` - aws ssm list-commands \ - --region $AWS_REGION \ - --command-id $OPEN_RDP_COMMAND_ID - ``` - -### Retrieve your secret key - -Retrieve your secret key using either AWS Management Console or the AWS CLI\. - -#### Console - -**To retrieve the secret key** - -1. Sign in to the AWS Management Console and open the Amazon RDS console at [https://console\.aws\.amazon\.com/rds/](https://console.aws.amazon.com/rds/)\. - -1. In the navigation pane, choose **Databases**, and then choose the RDS Custom DB instance to which you want to connect\. - -1. Choose the **Configuration** tab\. - -1. Note the **DB instance ID** for your DB instance, for example, `my-custom-instance`\. - -1. Open the Amazon EC2 console at [https://console\.aws\.amazon\.com/ec2/](https://console.aws.amazon.com/ec2/)\. - -1. In the navigation pane, choose **Instances**\. - -1. Look for the name of your EC2 instance, and then choose the instance ID associated with it\. - - In this example, the instance ID is `i-abcdefghijklm01234`\. - -1. In **Details**, find **Key pair name**\. The pair name includes the DB identifier\. In this example, the pair name is `do-not-delete-rds-custom-my-custom-instance-0d726c`\. - -1. In the instance summary, find **Public IPv4 DNS**\. For the example, the public DNS might be `ec2-12-345-678-901.us-east-2.compute.amazonaws.com`\. - -1. Open the AWS Secrets Manager console at [https://console\.aws\.amazon\.com/secretsmanager/](https://console.aws.amazon.com/secretsmanager/)\. - -1. Choose the secret that has the same name as your key pair\. - -1. Choose **Retrieve secret value**\. - -#### AWS CLI - -**To retrieve the private key** - -1. Get the list of your RDS Custom DB instances by calling the `aws rds describe-db-instances` command\. - - ``` - aws rds describe-db-instances \ - --query 'DBInstances[*].[DBInstanceIdentifier,DbiResourceId]' \ - --output text - ``` - -1. Choose the DB instance identifier from the sample output, for example `do-not-delete-rds-custom-my-custom-instance`\. - -1. Find the EC2 instance ID of your DB instance by calling the `aws ec2 describe-instances` command\. The following example uses the EC2 instance name to describe the DB instance\. - - ``` - aws ec2 describe-instances \ - --filters "Name=tag:Name,Values=do-not-delete-rds-custom-my-custom-instance" \ - --output text \ - --query 'Reservations[*].Instances[*].InstanceId' - ``` - - The following sample output shows the EC2 instance ID\. - - ``` - i-abcdefghijklm01234 - ``` - -1. Find the key name by specifying the EC2 instance ID, as shown in the following example\. - - ``` - aws ec2 describe-instances \ - --instance-ids i-abcdefghijklm01234 \ - --output text \ - --query 'Reservations[*].Instances[*].KeyName' - ``` - - The following sample output shows the key name, which uses the prefix `do-not-delete-rds-custom-DBInstanceIdentifier`\. - - ``` - do-not-delete-rds-custom-my-custom-instance-0d726c - ``` - -### Connect to your EC2 instance using the RDP utility - -Follow the procedure in [Connect to your Windows instance using RDP](https://docs.aws.amazon.com/AWSEC2/latest/WindowsGuide/connecting_to_windows_instance.html#connect-rdp) in the *Amazon EC2 User Guide for Windows Instances*\. This procedure assumes that you created a \.pem file that contains your private key\. \ No newline at end of file diff --git a/doc_source/custom-creating.md b/doc_source/custom-creating.md deleted file mode 100644 index d76d3e1..0000000 --- a/doc_source/custom-creating.md +++ /dev/null @@ -1,589 +0,0 @@ -# Configuring a DB instance for Amazon RDS Custom for Oracle - -You can create an RDS Custom DB instance, and then connect to it using Secure Shell \(SSH\) or AWS Systems Manager\. - -**Topics** -+ [Overview of Amazon RDS Custom for Oracle architecture](#custom-creating.overview) -+ [Creating an RDS Custom for Oracle DB instance](#custom-creating.create) -+ [RDS Custom service\-linked role](#custom-creating.slr) -+ [Connecting to your RDS Custom DB instance using Session Manager](#custom-creating.ssm) -+ [Connecting to your RDS Custom DB instance using SSH](#custom-creating.ssh) -+ [Logging in to your RDS Custom for Oracle database as SYS](#custom-creating.sysdba) - -## Overview of Amazon RDS Custom for Oracle architecture - -If you create an Amazon RDS Custom for Oracle DB instance with the Oracle Multitenant architecture \(`custom-oracle-ee-cdb` engine type\), your database is a container database \(CDB\)\. If you don't specify the Oracle Multitenant architecture, your database is a traditional non\-CDB that uses the `custom-oracle-ee` engine type\. A non\-CDB can't contain pluggable databases \(PDBs\)\. - -An RDS Custom for Oracle CDB supports the following features: -+ Backups -+ Restoring and point\-time\-restore \(PITR\) from backups -+ Read replicas -+ Minor version upgrades - -When you create a CDB instance using the Oracle Multitenant architecture, your CDB includes the following: -+ CDB root \(`CDB$ROOT`\) -+ PDB seed \(`PDB$SEED`\) -+ PDB - -By default, your CDB is named `RDSCDB`, which is also the name of the Oracle System ID \(Oracle SID\), and your initial PDB is named `ORCL`\. You can choose a different name for your PDB, but the Oracle SID and the PDB name can’t be the same\. - -RDS Custom for Oracle doesn't supply APIs for PDBs\. If you want additional PDBs, create them manually using Oracle SQL\. RDS Custom for Oracle doesn't restrict the number of PDBs that you can create\. In general, you are responsible for creating and managing PDBs, as in an on\-premises deployment\. - -**Note** -If you create a PDB, we recommend that you take a manual snapshot afterward in case you need to perform point\-in\-time recovery \(PITR\)\. - -You can't rename existing PDBs using Amazon RDS APIs\. You also can't rename the CDB using the `modify-db-instance` command\. - -The open mode for the CDB root is `READ WRITE` on the primary and `MOUNTED` on a mounted standby database\. RDS Custom for Oracle attempts to open all PDBs when opening the CDB\. If RDS Custom for Oracle can’t open all PDBs, it issues the event `tenant database shutdown`\. - -## Creating an RDS Custom for Oracle DB instance - -Create an Amazon RDS Custom for Oracle DB instance using either the AWS Management Console or the AWS CLI\. The procedure is similar to the procedure for creating an Amazon RDS DB instance\. For more information, see [Creating an Amazon RDS DB instance](USER_CreateDBInstance.md)\. - -If you included installation parameters in your CEV manifest, then your DB instance uses the Oracle base, Oracle home, and the ID and name of the UNIX/Linux user and group that you specified\. The `oratab` file, which is created by Oracle Database during installation, points to the real installation location rather than to a symbolic link\. When RDS Custom runs commands, it runs as the configured OS user rather than the default user `rdsdb`\. For more information, see [Step 5: Prepare the CEV manifest](custom-cev.preparing.md#custom-cev.preparing.manifest)\. - -Before you attempt to create or connect to an RDS Custom DB instance, complete the tasks in [Setting up your environment for Amazon RDS Custom for Oracle](custom-setup-orcl.md)\. - -### Console - -**To create an RDS Custom for Oracle DB instance** - -1. Sign in to the AWS Management Console and open the Amazon RDS console at [https://console\.aws\.amazon\.com/rds/](https://console.aws.amazon.com/rds/)\. - -1. In the navigation pane, choose **Databases**\. - -1. Choose **Create database**\. - -1. In **Choose a database creation method**, select **Standard create**\. - -1. In the **Engine options** section, do the following: - - 1. For **Engine type**, choose **Oracle**\. - - 1. For **Database management type**, choose **Amazon RDS Custom**\. - - 1. For **Architecture settings**, do one of the following: - + Select **Multitenant architecture** to create a container database \(CDB\)\. At creation, your CDB contains one PDB and one PDB seed\. - + Clear **Multitenant architecture** to create a non\-CDB\. A non\-CDB can't contain PDBs\. - - 1. For **Edition**, choose **Oracle Enterprise Edition**\. - - 1. For **Custom engine version**, choose an existing RDS Custom custom engine version \(CEV\)\. A CEV has the following format: `major-engine-version.customized_string`\. An example identifier is `19.cdb_cev1`\. - - If you chose **Multitenant architecture** in the previous step, you can only specify a Multitenant CEV\. The console filters out CEVs that were created as non\-CDBs\. - -1. In **Templates**, choose **Production**\. - -1. In the **Settings** section, do the following: - - 1. For **DB instance identifier**, enter a unique name for your DB instance\. - - 1. For **Master username**, enter a username\. You can retrieve this value from the console later\. - - When you connect to a non\-CDB, the master user is the user for the non\-CDB\. When you connect to a CDB, the master user is the user for the PDB\. To connect to the CDB root, log in to the host, start a SQL client, and create an administrative user with SQL commands\. - - 1. Clear **Auto generate a password**\. - -1. Choose a **DB instance class**\. - - For supported classes, see [DB instance class support for RDS Custom for Oracle](custom-reqs-limits.md#custom-reqs-limits.instances)\. - -1. In the **Storage** section, do the following: - - 1. For **Storage type**, choose an SSD type: io1, gp2, or gp3\. You have the following additional options: - + For io1 or gp3, choose a rate for **Provisioned IOPS**\. The default is 1000 for io1 and 12000 for gp3\. - + For gp3, choose a rate for **Storage throughput**\. The default is 500 MiBps\. - - 1. For **Allocated storage**, choose a storage size\. The default is 40 GiB\. - -1. For **Connectivity**, specify your **Virtual private cloud \(VPC\)**, **DB subnet group**, and **VPC security group \(firewall\)**\. - -1. For **RDS Custom security**, do the following: - - 1. For **IAM instance profile**, choose the instance profile for your RDS Custom for Oracle DB instance\. - - The IAM instance profile must begin with `AWSRDSCustom`, for example *AWSRDSCustomInstanceProfileForRdsCustomInstance*\. - - 1. For **Encryption**, choose **Enter a key ARN** to list the available AWS KMS keys\. Then choose your key from the list\. - - An AWS KMS key is required for RDS Custom\. For more information, see [Step 1: Create or reuse a symmetric encryption AWS KMS key](custom-setup-orcl.md#custom-setup-orcl.cmk)\. - -1. For **Database options**, do the following: - - 1. \(Optional\) For **Initial database name**, enter a name\. The default value is **ORCL**\. In the multitenant architecture, the initial database name is the PDB name\. - - The **System ID \(SID\)** value of `RDSCDB` is the name of the Oracle database instance that manages your database files\. In this context, the term "Oracle database instance" refers exclusively to the system global area \(SGA\) and Oracle background processes\. The Oracle SID is also the name of your CDB\. You can't change this value\. - - 1. For **Backup retention period** choose a value\. You can't choose **0 days**\. - - 1. For the remaining sections, specify your preferred RDS Custom DB instance settings\. For information about each setting, see [Settings for DB instances](USER_CreateDBInstance.md#USER_CreateDBInstance.Settings)\. The following settings don't appear in the console and aren't supported: - + **Processor features** - + **Storage autoscaling** - + **Availability & durability** - + **Password and Kerberos authentication** option in **Database authentication** \(only **Password authentication** is supported\) - + **Database options** group in **Additional configuration** - + **Performance Insights** - + **Log exports** - + **Enable auto minor version upgrade** - + **Deletion protection** - -1. Choose **Create database**\. -**Important** -When you create an RDS Custom for Oracle DB instance, you might receive the following error: The service\-linked role is in the process of being created\. Try again later\. If you do, wait a few minutes and then try again to create the DB instance\. - - The **View credential details** button appears on the **Databases** page\. - - To view the master user name and password for the RDS Custom DB instance, choose **View credential details**\. - - To connect to the DB instance as the master user, use the user name and password that appear\. -**Important** -You can't view the master user password again\. If you don't record it, you might have to change it\. If you need to change the master user password after the RDS Custom DB instance is available, modify the DB instance to do so\. For more information about modifying a DB instance, see [Managing an Amazon RDS Custom for Oracle DB instance](custom-managing.md)\. - -1. Choose **Databases** to view the list of RDS Custom DB instances\. - -1. Choose the RDS Custom DB instance that you just created\. - - On the RDS console, the details for the new RDS Custom DB instance appear: - + The DB instance has a status of **creating** until the RDS Custom DB instance is created and ready for use\. When the state changes to **available**, you can connect to the DB instance\. Depending on the instance class and storage allocated, it can take several minutes for the new DB instance to be available\. - + **Role** has the value **Instance \(RDS Custom\)**\. - + **RDS Custom automation mode** has the value **Full automation**\. This setting means that the DB instance provides automatic monitoring and instance recovery\. - -### AWS CLI - -You create an RDS Custom DB instance by using the [create\-db\-instance](https://docs.aws.amazon.com/cli/latest/reference/rds/create-db-instance.html) AWS CLI command\. - -The following options are required: -+ `--db-instance-identifier` -+ `--db-instance-class` \(for a list of supported instance classes, see [DB instance class support for RDS Custom for Oracle](custom-reqs-limits.md#custom-reqs-limits.instances)\) -+ `--engine engine-type` \(where *`engine-type`* is `custom-oracle-ee-cdb` for a CDB and `custom-oracle-ee` for a non\-CDB\) -+ `--engine-version cev` \(where *`cev`* is the name of the custom engine version that you specified in [Creating a CEV](custom-cev.create.md)\) -+ `--kms-key-id my-kms-key` -+ `--backup-retention-period days` \(where *`days`* is a value greater than `0`\) -+ `--no-auto-minor-version-upgrade` -+ `--custom-iam-instance-profile AWSRDSCustomInstanceRole-us-east-1` \(where *`region`* is the AWS Region where you are creating your DB instance\) - -The following example creates an RDS Custom DB instance named `my-cdb-instance`\. The database is a CDB\. The PDB name is *mypdb*\. The backup retention period is three days\. - -**Example** -For Linux, macOS, or Unix: - -``` - 1. aws rds create-db-instance \ - 2. --engine custom-oracle-ee-cdb \ - 3. --db-instance-identifier my-cdb-instance \ - 4. --engine-version 19.cdb_cev1 \ - 5. --db-name mypdb \ - 6. --allocated-storage 250 \ - 7. --db-instance-class db.m5.xlarge \ - 8. --db-subnet-group mydbsubnetgroup \ - 9. --master-username myawsuser \ -10. --master-user-password mypassword \ -11. --backup-retention-period 3 \ -12. --port 8200 \ -13. --license-model bring-your-own-license \ -14. --kms-key-id my-kms-key \ -15. --no-auto-minor-version-upgrade \ -16. --custom-iam-instance-profile AWSRDSCustomInstanceRole-us-east-1 -``` -For Windows: - -``` - 1. aws rds create-db-instance ^ - 2. --engine custom-oracle-ee-cdb ^ - 3. --db-instance-identifier my-cdb-instance ^ - 4. --engine-version 19.cdb_cev1 ^ - 5. --db-name mypdb ^ - 6. --allocated-storage 250 ^ - 7. --db-instance-class db.m5.xlarge ^ - 8. --db-subnet-group mydbsubnetgroup ^ - 9. --master-username myawsuser ^ -10. --master-user-password mypassword ^ -11. --backup-retention-period 3 ^ -12. --port 8200 ^ -13. --license-model bring-your-own-license ^ -14. --kms-key-id my-kms-key ^ -15. --no-auto-minor-version-upgrade ^ -16. --custom-iam-instance-profile AWSRDSCustomInstanceRole-us-east-1 -``` - -Get details about your instance by using the `describe-db-instances` command\. - -**Example** - -``` -1. aws rds describe-db-instances --db-instance-identifier my-cdb-instance -``` -The following partial output shows the engine, parameter groups, and other information\. - -``` - 1. { - 2. "DBInstances": [ - 3. { - 4. "PendingModifiedValues": {}, - 5. "Engine": "custom-oracle-ee-cdb", - 6. "MultiAZ": false, - 7. "DBSecurityGroups": [], - 8. "DBParameterGroups": [ - 9. { -10. "DBParameterGroupName": "default.custom-oracle-ee-cdb-19", -11. "ParameterApplyStatus": "in-sync" -12. } -13. ], -14. "AutomationMode": "full", -15. "DBInstanceIdentifier": "my-cdb-instance", -16. ... -17. "TagList": [ -18. { -19. "Key": "AWSRDSCustom", -20. "Value": "custom-oracle" -21. } -22. ] -23. } -24. ] -25. } -``` - -## RDS Custom service\-linked role - -A *service\-linked role* gives Amazon RDS Custom access to resources in your AWS account\. It makes using RDS Custom easier because you don't have to manually add the necessary permissions\. RDS Custom defines the permissions of its service\-linked roles, and unless defined otherwise, only RDS Custom can assume its roles\. The defined permissions include the trust policy and the permissions policy, and that permissions policy can't be attached to any other IAM entity\. - -When you create an RDS Custom DB instance, both the Amazon RDS and RDS Custom service\-linked roles are created \(if they don't already exist\) and used\. For more information, see [Using service\-linked roles for Amazon RDS](UsingWithRDS.IAM.ServiceLinkedRoles.md)\. - -The first time that you create an RDS Custom for Oracle DB instance, you might receive the following error: The service\-linked role is in the process of being created\. Try again later\. If you do, wait a few minutes and then try again to create the DB instance\. - -## Connecting to your RDS Custom DB instance using Session Manager - -After you create your RDS Custom DB instance, you can connect to it using AWS Systems Manager Session Manager\. This is the preferred technique when your DB instance isn't publicly accessible\. - -Session Manager allows you to access Amazon EC2 instances through a browser\-based shell or through the AWS CLI\. For more information, see [AWS Systems Manager Session Manager](https://docs.aws.amazon.com/systems-manager/latest/userguide/session-manager.html)\. - -### Console - -**To connect to your DB instance using Session Manager** - -1. Sign in to the AWS Management Console and open the Amazon RDS console at [https://console\.aws\.amazon\.com/rds/](https://console.aws.amazon.com/rds/)\. - -1. In the navigation pane, choose **Databases**, and then choose the RDS Custom DB instance to which you want to connect\. - -1. Choose **Configuration**\. - -1. Note the **Resource ID** for your DB instance\. For example, the resource ID might be `db-ABCDEFGHIJKLMNOPQRS0123456`\. - -1. Open the Amazon EC2 console at [https://console\.aws\.amazon\.com/ec2/](https://console.aws.amazon.com/ec2/)\. - -1. In the navigation pane, choose **Instances**\. - -1. Look for the name of your EC2 instance, and then click the instance ID associated with it\. For example, the instance ID might be `i-abcdefghijklm01234`\. - -1. Choose **Connect**\. - -1. Choose **Session Manager**\. - -1. Choose **Connect**\. - - A window opens for your session\. - -### AWS CLI - -You can connect to your RDS Custom DB instance using the AWS CLI\. This technique requires the Session Manager plugin for the AWS CLI\. To learn how to install the plugin, see [Install the Session Manager plugin for the AWS CLI](https://docs.aws.amazon.com/systems-manager/latest/userguide/session-manager-working-with-install-plugin.html)\. - -To find the DB resource ID of your RDS Custom DB instance, use `aws rds [describe\-db\-instances](https://docs.aws.amazon.com/cli/latest/reference/rds/describe-db-instances.html)`\. - -``` -aws rds describe-db-instances \ - --query 'DBInstances[*].[DBInstanceIdentifier,DbiResourceId]' \ - --output text -``` - -The following sample output shows the resource ID for your RDS Custom instance\. The prefix is `db-`\. - -``` -db-ABCDEFGHIJKLMNOPQRS0123456 -``` - -To find the EC2 instance ID of your DB instance, use `aws ec2 describe-instances`\. The following example uses `db-ABCDEFGHIJKLMNOPQRS0123456` for the resource ID\. - -``` -aws ec2 describe-instances \ - --filters "Name=tag:Name,Values=db-ABCDEFGHIJKLMNOPQRS0123456" \ - --output text \ - --query 'Reservations[*].Instances[*].InstanceId' -``` - -The following sample output shows the EC2 instance ID\. - -``` -i-abcdefghijklm01234 -``` - -Use the `aws ssm start-session` command, supplying the EC2 instance ID in the `--target` parameter\. - -``` -aws ssm start-session --target "i-abcdefghijklm01234" -``` - -A successful connection looks like the following\. - -``` -Starting session with SessionId: yourid-abcdefghijklm1234 -[ssm-user@ip-123-45-67-89 bin]$ -``` - -## Connecting to your RDS Custom DB instance using SSH - -The Secure Shell Protocol \(SSH\) is a network protocol that supports encrypted communication over an unsecured network\. After you create your RDS Custom DB instance, you can connect to it using an ssh client\. For more information, see [Connecting to your Linux instance using SSH](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/AccessingInstancesLinux.html)\. - -Your SSH connection technique depends on whether your DB instance is private, meaning that it doesn't accept connections from the public internet\. In this case, you must use SSH tunneling to connect the ssh utility to your instance\. This technique transports data with a dedicated data stream \(tunnel\) inside an existing SSH session\. You can configure SSH tunneling using AWS Systems Manager\. - -**Note** -Various strategies are supported for accessing private instances\. To learn how to connect an ssh client to private instances using bastion hosts, see [Linux Bastion Hosts on AWS](http://aws.amazon.com/solutions/implementations/linux-bastion/)\. To learn how to configure port forwarding, see [Port Forwarding Using AWS Systems Manager Session Manager](http://aws.amazon.com/blogs/aws/new-port-forwarding-using-aws-system-manager-sessions-manager/)\. - -If your DB instance is in a public subnet and has the publicly available setting, then no SSH tunneling is required\. You can connect with SSH just as would to a public Amazon EC2 instance\. - -To connect an ssh client to your DB instance, complete the following steps: - -1. [Step 1: Configure your DB instance to allow SSH connections](#custom-managing.ssh.port-22) - -1. [Step 2: Retrieve your SSH secret key and EC2 instance ID](#custom-managing.ssh.obtaining-key) - -1. [Step 3: Connect to your EC2 instance using the ssh utility](#custom-managing.ssh.connecting) - -### Step 1: Configure your DB instance to allow SSH connections - -To make sure that your DB instance can accept SSH connections, do the following: -+ Make sure that your DB instance security group permits inbound connections on port 22 for TCP\. - - To learn how to configure the security group for your DB instance, see [Controlling access with security groups](Overview.RDSSecurityGroups.md)\. -+ If you don't plan to use SSH tunneling, make sure your DB instance resides in a public subnet and is publicly accessible\. - - In the console, the relevant field is **Publicly accessible** on the **Connectivity & security** tab of the database details page\. To check your settings in the CLI, run the following command: - - ``` - aws rds describe-db-instances \ - --query 'DBInstances[*].{DBInstanceIdentifier:DBInstanceIdentifier,PubliclyAccessible:PubliclyAccessible}' \ - --output table - ``` - - To change the accessibility settings for your DB instance, see [Modifying an Amazon RDS DB instance](Overview.DBInstance.Modifying.md)\. - -### Step 2: Retrieve your SSH secret key and EC2 instance ID - -To connect to the DB instance using SSH, you need the SSH key pair associated with the instance\. RDS Custom creates the SSH key pair on your behalf, naming it with the prefix `do-not-delete-rds-custom-ssh-privatekey-db-`\. AWS Secrets Manager stores your SSH private key as a secret\. - -Retrieve your SSH secret key using either AWS Management Console or the AWS CLI\. If your instance has a public DNS, and you don't intend to use SSH tunneling, then also retrieve the DNS name\. You specify the DNS name for public connections\. - -#### Console - -**To retrieve the secret SSH key** - -1. Sign in to the AWS Management Console and open the Amazon RDS console at [https://console\.aws\.amazon\.com/rds/](https://console.aws.amazon.com/rds/)\. - -1. In the navigation pane, choose **Databases**, and then choose the RDS Custom DB instance to which you want to connect\. - -1. Choose **Configuration**\. - -1. Note the **Resource ID** value\. For example, the DB instance resource ID might be `db-ABCDEFGHIJKLMNOPQRS0123456`\. - -1. Open the Amazon EC2 console at [https://console\.aws\.amazon\.com/ec2/](https://console.aws.amazon.com/ec2/)\. - -1. In the navigation pane, choose **Instances**\. - -1. Find the name of your EC2 instance, and choose the instance ID associated with it\. For example, the EC2 instance ID might be `i-abcdefghijklm01234`\. - -1. In **Details**, find **Key pair name**\. The pair name includes the DB instance resource ID\. For example, the pair name might be `do-not-delete-rds-custom-ssh-privatekey-db-ABCDEFGHIJKLMNOPQRS0123456-0d726c`\. - -1. If your EC2 instance is public, note the **Public IPv4 DNS**\. For the example, the public Domain Name System \(DNS\) address might be `ec2-12-345-678-901.us-east-2.compute.amazonaws.com`\. - -1. Open the AWS Secrets Manager console at [https://console\.aws\.amazon\.com/secretsmanager/](https://console.aws.amazon.com/secretsmanager/)\. - -1. Choose the secret that has the same name as your key pair\. - -1. Choose **Retrieve secret value**\. - -1. Copy the SSH private key into a text file, and then save the file with the `.pem` extension\. For example, save the file as `/tmp/do-not-delete-rds-custom-ssh-privatekey-db-ABCDEFGHIJKLMNOPQRS0123456-0d726c.pem`\. - -#### AWS CLI - -To retrieve the SSH private key and save it in a \.pem file, you can use the AWS CLI\. - -1. Find the DB resource ID of your RDS Custom DB instance using `aws rds [describe\-db\-instances](https://docs.aws.amazon.com/cli/latest/reference/rds/describe-db-instances.html)`\. - - ``` - aws rds describe-db-instances \ - --query 'DBInstances[*].[DBInstanceIdentifier,DbiResourceId]' \ - --output text - ``` - - The following sample output shows the resource ID for your RDS Custom instance\. The prefix is `db-`\. - - ``` - db-ABCDEFGHIJKLMNOPQRS0123456 - ``` - -1. Find the EC2 instance ID of your DB instance using `aws ec2 describe-instances`\. The following example uses `db-ABCDEFGHIJKLMNOPQRS0123456` for the resource ID\. - - ``` - aws ec2 describe-instances \ - --filters "Name=tag:Name,Values=db-ABCDEFGHIJKLMNOPQRS0123456" \ - --output text \ - --query 'Reservations[*].Instances[*].InstanceId' - ``` - - The following sample output shows the EC2 instance ID\. - - ``` - i-abcdefghijklm01234 - ``` - -1. To find the key name, specify the EC2 instance ID\. The following example describes EC2 instance *i\-0bdc4219e66944afa*\. - - ``` - aws ec2 describe-instances \ - --instance-ids i-0bdc4219e66944afa \ - --output text \ - --query 'Reservations[*].Instances[*].KeyName' - ``` - - The following sample output shows the key name, which uses the prefix `do-not-delete-rds-custom-ssh-privatekey-`\. - - ``` - do-not-delete-rds-custom-ssh-privatekey-db-ABCDEFGHIJKLMNOPQRS0123456-0d726c - ``` - -1. Save the private key in a \.pem file named after the key using `aws secretsmanager`\. The following example saves the file in your `/tmp` directory\. - - ``` - aws secretsmanager get-secret-value \ - --secret-id do-not-delete-rds-custom-ssh-privatekey-db-ABCDEFGHIJKLMNOPQRS0123456-0d726c \ - --query SecretString \ - --output text >/tmp/do-not-delete-rds-custom-ssh-privatekey-db-ABCDEFGHIJKLMNOPQRS0123456-0d726c.pem - ``` - -### Step 3: Connect to your EC2 instance using the ssh utility - -Your connection technique depends on whether you are connecting to a private DB instance or connecting to a public instance\. A private connection requires you to configure SSH tunneling through AWS Systems Manager\. - -**To connect to an EC2 instance using the ssh utility** - -1. For private connections, modify your SSH configuration file to proxy commands to AWS Systems Manager Session Manager\. For public connections, skip to Step 2\. - - Add the following lines to `~/.ssh/config`\. These lines proxy SSH commands for hosts whose names begin with `i-` or `mi-`\. - - ``` - Host i-* mi-* - ProxyCommand sh -c "aws ssm start-session --target %h --document-name AWS-StartSSHSession --parameters 'portNumber=%p'" - ``` - -1. Change to the directory that contains your \.pem file\. Using `chmod`, set the permissions to `400`\. - - ``` - cd /tmp - chmod 400 do-not-delete-rds-custom-ssh-privatekey-db-ABCDEFGHIJKLMNOPQRS0123456-0d726c.pem - ``` - -1. Run the ssh utility, specifying the \.pem file and either the public DNS name \(for public connections\) or the EC2 instance ID \(for private connections\)\. Log in as user `ec2-user`\. - - The following example connects to a public instance using the DNS name *ec2\-12\-345\-678\-901\.us\-east\-2\.compute\.amazonaws\.com*\. - - ``` - ssh -i \ - "do-not-delete-rds-custom-ssh-privatekey-db-ABCDEFGHIJKLMNOPQRS0123456-0d726c.pem" \ - ec2-user@ec2-12-345-678-901.us-east-2.compute.amazonaws.com - ``` - - The following example connects to a private instance using the EC2 instance ID *i\-0bdc4219e66944afa*\. - - ``` - ssh -i \ - "do-not-delete-rds-custom-ssh-privatekey-db-ABCDEFGHIJKLMNOPQRS0123456-0d726c.pem" \ - ec2-user@i-0bdc4219e66944afa - ``` - -## Logging in to your RDS Custom for Oracle database as SYS - -After you create your RDS Custom DB instance, you can log in to your Oracle database as user `SYS`, which gives you `SYSDBA` privileges\. You have the following login options: -+ Get the `SYS` password from Secrets Manager, and specify this password in your SQL client\. -+ Use OS authentication to log in to your database\. In this case, you don't need a password\. - -### Finding the SYS password for your RDS Custom for Oracle database - -Your can log in to your Oracle database as `SYS` or `SYSTEM` or by specifying the master user name in an API call\. The password for `SYS` and `SYSTEM` is stored in Secrets Manager\. The secret uses the naming format do\-not\-delete\-rds\-custom\-*resource\_id*\-*uuid*\. You can find the password using the AWS Management Console\. - -#### Console - -**To find the SYS password for your database in Secrets Manager** - -1. Sign in to the AWS Management Console and open the Amazon RDS console at [https://console\.aws\.amazon\.com/rds/](https://console.aws.amazon.com/rds/)\. - -1. In the RDS console, complete the following steps: - - 1. In the navigation pane, choose **Databases**\. - - 1. Choose the name of your RDS Custom for Oracle DB instance\. - - 1. Choose **Configuration**\. - - 1. Copy the value underneath **Resource ID**\. For example, you resource ID might be **db\-ABC12CDE3FGH4I5JKLMNO6PQR7**\. - -1. Open the Secrets Manager console at [https://console\.aws\.amazon\.com/secretsmanager/](https://console.aws.amazon.com/secretsmanager/)\. - -1. In the Secrets Manager console, complete the following steps: - - 1. In the left navigation pane, choose **Secrets**\. - - 1. Filter the secrets by the resource ID that you copied in step 5\. - - 1. Choose the secret named **do\-not\-delete\-rds\-custom\-*resource\_id*\-*uuid***, where *resource\_id* is the resource ID that you copied in step 5\. For example, if your resource ID is **db\-ABC12CDE3FGH4I5JKLMNO6PQR7**, your secret will be named **do\-not\-delete\-rds\-custom\-db\-ABC12CDE3FGH4I5JKLMNO6PQR7**\. - - 1. In **Secret value**, choose **Retrieve secret value**\. - - 1. In **Key/value**, copy the value for **password**\. - -1. Install SQL\*Plus on your DB instance and log in to your database as `SYS`\. For more information, see [Step 3: Connect your SQL client to an Oracle DB instance](CHAP_GettingStarted.CreatingConnecting.Oracle.md#CHAP_GettingStarted.Connecting.Oracle)\. - -### Logging in to your RDS Custom for Oracle database using OS authentication - -The OS user `rdsdb` owns the Oracle database binaries\. You can switch to the `rdsdb` user and log in to your RDS Custom for Oracle database without a password\. - -1. Connect to your DB instance with AWS Systems Manager\. For more information, see [Connecting to your RDS Custom DB instance using Session Manager](#custom-creating.ssm)\. - -1. In a web browser, go to [https://www\.oracle\.com/database/technologies/instant\-client/linux\-x86\-64\-downloads\.html](https://www.oracle.com/database/technologies/instant-client/linux-x86-64-downloads.html)\. - -1. For the latest database version that appears on the web page, copy the \.rpm links \(not the \.zip links\) for the Instant Client Basic Package and SQL\*Plus Package\. For example, the following links are for Oracle Database version 21\.9: - + https://download\.oracle\.com/otn\_software/linux/instantclient/219000/oracle\-instantclient\-basic\-21\.9\.0\.0\.0\-1\.el8\.x86\_64\.rpm - + https://download\.oracle\.com/otn\_software/linux/instantclient/219000/oracle\-instantclient\-sqlplus\-21\.9\.0\.0\.0\-1\.el8\.x86\_64\.rpm - -1. In your SSH session, run the `wget` command to the download the \.rpm files from the links that you obtained in the previous step\. The following example downloads the \.rpm files for Oracle Database version 21\.9: - - ``` - wget https://download.oracle.com/otn_software/linux/instantclient/219000/oracle-instantclient-basic-21.9.0.0.0-1.el8.x86_64.rpm - wget https://download.oracle.com/otn_software/linux/instantclient/219000/oracle-instantclient-sqlplus-21.9.0.0.0-1.el8.x86_64.rpm - ``` - -1. Install the packages by running the `yum` command as follows: - - ``` - sudo yum install oracle-instantclient-*.rpm - ``` - -1. Switch to the `rdsdb` user\. - - ``` - sudo su - rdsdb - ``` - -1. Log in to your database using OS authentication\. - - ``` - $ sqlplus / as sysdba - - SQL*Plus: Release 21.0.0.0.0 - Production on Wed Apr 12 20:11:08 2023 - Version 21.9.0.0.0 - - Copyright (c) 1982, 2020, Oracle. All rights reserved. - - - Connected to: - Oracle Database 19c Enterprise Edition Release 19.0.0.0.0 - Production - Version 19.10.0.0.0 - ``` \ No newline at end of file diff --git a/doc_source/custom-managing-sqlserver.md b/doc_source/custom-managing-sqlserver.md deleted file mode 100644 index ed2817e..0000000 --- a/doc_source/custom-managing-sqlserver.md +++ /dev/null @@ -1,405 +0,0 @@ -# Managing an Amazon RDS Custom for SQL Server DB instance - -Amazon RDS Custom for SQL Server supports a subset of the usual management tasks for Amazon RDS DB instances\. Following, you can find instructions for the supported RDS Custom for SQL Server management tasks using the AWS Management Console and the AWS CLI\. - -**Topics** -+ [Pausing and resuming RDS Custom automation](#custom-managing-sqlserver.pausing) -+ [Modifying an RDS Custom for SQL Server DB instance](#custom-managing.modify-sqlserver) -+ [Modifying the storage for an RDS Custom for SQL Server DB instance](#custom-managing-sqlserver.storage-modify) -+ [Tagging RDS Custom for SQL Server resources](#custom-managing-sqlserver.tagging) -+ [Deleting an RDS Custom for SQL Server DB instance](#custom-managing-sqlserver.deleting) - -## Pausing and resuming RDS Custom automation - -RDS Custom automatically provides monitoring and instance recovery for an RDS Custom for SQL Server DB instance\. If you need to customize the instance, do the following: - -1. Pause RDS Custom automation for a specified period\. The pause ensures that your customizations don't interfere with RDS Custom automation\. - -1. Customize the RDS Custom for SQL Server DB instance as needed\. - -1. Do either of the following: - + Resume automation manually\. - + Wait for the pause period to end\. In this case, RDS Custom resumes monitoring and instance recovery automatically\. - -**Important** -Pausing and resuming automation are the only supported automation tasks when modifying an RDS Custom for SQL Server DB instance\. - -### Console - -**To pause or resume RDS Custom automation** - -1. Sign in to the AWS Management Console and open the Amazon RDS console at [https://console\.aws\.amazon\.com/rds/](https://console.aws.amazon.com/rds/)\. - -1. In the navigation pane, choose **Databases**, and then choose the RDS Custom DB instance that you want to modify\. - -1. Choose **Modify**\. The **Modify DB instance** page appears\. - -1. For **RDS Custom automation mode**, choose one of the following options: - + **Paused** pauses the monitoring and instance recovery for the RDS Custom DB instance\. Enter the pause duration that you want \(in minutes\) for **Automation mode duration**\. The minimum value is 60 minutes \(default\)\. The maximum value is 1,440 minutes\. - + **Full automation** resumes automation\. - -1. Choose **Continue** to check the summary of modifications\. - - A message indicates that RDS Custom will apply the changes immediately\. - -1. If your changes are correct, choose **Modify DB instance**\. Or choose **Back** to edit your changes or **Cancel** to cancel your changes\. - - On the RDS console, the details for the modification appear\. If you paused automation, the **Status** of your RDS Custom DB instance indicates **Automation paused**\. - -1. \(Optional\) In the navigation pane, choose **Databases**, and then your RDS Custom DB instance\. - - In the **Summary** pane, **RDS Custom automation mode** indicates the automation status\. If automation is paused, the value is **Paused\. Automation resumes in *num* minutes**\. - -### AWS CLI - -To pause or resume RDS Custom automation, use the `modify-db-instance` AWS CLI command\. Identify the DB instance using the required parameter `--db-instance-identifier`\. Control the automation mode with the following parameters: -+ `--automation-mode` specifies the pause state of the DB instance\. Valid values are `all-paused`, which pauses automation, and `full`, which resumes it\. -+ `--resume-full-automation-mode-minutes` specifies the duration of the pause\. The default value is 60 minutes\. - -**Note** -Regardless of whether you specify `--no-apply-immediately` or `--apply-immediately`, RDS Custom applies modifications asynchronously as soon as possible\. - -In the command response, `ResumeFullAutomationModeTime` indicates the resume time as a UTC timestamp\. When the automation mode is `all-paused`, you can use `modify-db-instance` to resume automation mode or extend the pause period\. No other `modify-db-instance` options are supported\. - -The following example pauses automation for `my-custom-instance` for 90 minutes\. - -**Example** -For Linux, macOS, or Unix: - -``` -aws rds modify-db-instance \ - --db-instance-identifier my-custom-instance \ - --automation-mode all-paused \ - --resume-full-automation-mode-minutes 90 -``` -For Windows: - -``` -aws rds modify-db-instance ^ - --db-instance-identifier my-custom-instance ^ - --automation-mode all-paused ^ - --resume-full-automation-mode-minutes 90 -``` - -The following example extends the pause duration for an extra 30 minutes\. The 30 minutes is added to the original time shown in `ResumeFullAutomationModeTime`\. - -**Example** -For Linux, macOS, or Unix: - -``` -aws rds modify-db-instance \ - --db-instance-identifier my-custom-instance \ - --automation-mode all-paused \ - --resume-full-automation-mode-minutes 30 -``` -For Windows: - -``` -aws rds modify-db-instance ^ - --db-instance-identifier my-custom-instance ^ - --automation-mode all-paused ^ - --resume-full-automation-mode-minutes 30 -``` - -The following example resumes full automation for `my-custom-instance`\. - -**Example** -For Linux, macOS, or Unix: - -``` -aws rds modify-db-instance \ - --db-instance-identifier my-custom-instance \ - --automation-mode full \ -``` -For Windows: - -``` -aws rds modify-db-instance ^ - --db-instance-identifier my-custom-instance ^ - --automation-mode full -``` -In the following partial sample output, the pending `AutomationMode` value is `full`\. - -``` -{ - "DBInstance": { - "PubliclyAccessible": true, - "MasterUsername": "admin", - "MonitoringInterval": 0, - "LicenseModel": "bring-your-own-license", - "VpcSecurityGroups": [ - { - "Status": "active", - "VpcSecurityGroupId": "0123456789abcdefg" - } - ], - "InstanceCreateTime": "2020-11-07T19:50:06.193Z", - "CopyTagsToSnapshot": false, - "OptionGroupMemberships": [ - { - "Status": "in-sync", - "OptionGroupName": "default:custom-oracle-ee-19" - } - ], - "PendingModifiedValues": { - "AutomationMode": "full" - }, - "Engine": "custom-oracle-ee", - "MultiAZ": false, - "DBSecurityGroups": [], - "DBParameterGroups": [ - { - "DBParameterGroupName": "default.custom-oracle-ee-19", - "ParameterApplyStatus": "in-sync" - } - ], - ... - "ReadReplicaDBInstanceIdentifiers": [], - "AllocatedStorage": 250, - "DBInstanceArn": "arn:aws:rds:us-west-2:012345678912:db:my-custom-instance", - "BackupRetentionPeriod": 3, - "DBName": "ORCL", - "PreferredMaintenanceWindow": "fri:10:56-fri:11:26", - "Endpoint": { - "HostedZoneId": "ABCDEFGHIJKLMNO", - "Port": 8200, - "Address": "my-custom-instance.abcdefghijk.us-west-2.rds.amazonaws.com" - }, - "DBInstanceStatus": "automation-paused", - "IAMDatabaseAuthenticationEnabled": false, - "AutomationMode": "all-paused", - "EngineVersion": "19.my_cev1", - "DeletionProtection": false, - "AvailabilityZone": "us-west-2a", - "DomainMemberships": [], - "StorageType": "gp2", - "DbiResourceId": "db-ABCDEFGHIJKLMNOPQRSTUVW", - "ResumeFullAutomationModeTime": "2020-11-07T20:56:50.565Z", - "KmsKeyId": "arn:aws:kms:us-west-2:012345678912:key/aa111a11-111a-11a1-1a11-1111a11a1a1a", - "StorageEncrypted": false, - "AssociatedRoles": [], - "DBInstanceClass": "db.m5.xlarge", - "DbInstancePort": 0, - "DBInstanceIdentifier": "my-custom-instance", - "TagList": [] - } -``` - -## Modifying an RDS Custom for SQL Server DB instance - -Modifying an RDS Custom for SQL Server DB instance is similar to doing this for Amazon RDS, but the changes that you can make are limited to the following: -+ Changing the DB instance class -+ Changing the backup retention period and backup window -+ Changing the maintenance window -+ Upgrading the DB engine version when a new version becomes available -+ Changing the allocated storage, provisioned IOPS, and storage type -+ Changing the database port -+ Changing the DB instance identifier -+ Changing the master credentials -+ Allowing and removing Multi\-AZ deployments -+ Allowing public access -+ Changing the security groups -+ Changing subnet groups - -The following limitations apply to modifying an RDS Custom for SQL Server DB instance: -+ Custom DB option and parameter groups aren't supported\. -+ Any storage volumes that you attach manually to your RDS Custom DB instance are outside the support perimeter\. - - For more information, see [RDS Custom support perimeter and unsupported configurations](custom-troubleshooting.md#custom-troubleshooting.support-perimeter)\. - -### Console - -**To modify an RDS Custom for SQL Server DB instance** - -1. Sign in to the AWS Management Console and open the Amazon RDS console at [https://console\.aws\.amazon\.com/rds/](https://console.aws.amazon.com/rds/)\. - -1. In the navigation pane, choose **Databases**\. - -1. Choose the DB instance that you want to modify\. - -1. Choose **Modify**\. - -1. Make the following changes as needed: - - 1. For **DB engine version**, choose the new version\. - - 1. Change the value for **DB instance class**\. For supported classes, see [DB instance class support for RDS Custom for SQL Server](custom-reqs-limits-MS.md#custom-reqs-limits.instancesMS) - - 1. Change the value for **Backup retention period**\. - - 1. For **Backup window**, set values for the **Start time** and **Duration**\. - - 1. For **DB instance maintenance window**, set values for the **Start day**, **Start time**, and **Duration**\. - -1. Choose **Continue**\. - -1. Choose **Apply immediately** or **Apply during the next scheduled maintenance window**\. - -1. Choose **Modify DB instance**\. - -### AWS CLI - -To modify an RDS Custom for SQL Server DB instance, use the [modify\-db\-instance](https://docs.aws.amazon.com/cli/latest/reference/rds/modify-db-instance.html) AWS CLI command\. Set the following parameters as needed: -+ `--db-instance-class` – For supported classes, see [DB instance class support for RDS Custom for SQL Server](custom-reqs-limits-MS.md#custom-reqs-limits.instancesMS) -+ `--engine-version` – The version number of the database engine to which you're upgrading\. -+ `--backup-retention-period` – How long to retain automated backups, from 0–35 days\. -+ `--preferred-backup-window` – The daily time range during which automated backups are created\. -+ `--preferred-maintenance-window` – The weekly time range \(in UTC\) during which system maintenance can occur\. -+ `--apply-immediately` – Use `--apply-immediately` to apply the storage changes immediately\. - - Or use `--no-apply-immediately` \(the default\) to apply the changes during the next maintenance window\. - -## Modifying the storage for an RDS Custom for SQL Server DB instance - -Modifying storage for an RDS Custom for SQL Server DB instance is similar to modifying storage for an Amazon RDS DB instance, but you can only do the following: -+ Increase the allocated storage size\. -+ Change the storage type\. You can use available storage types such as General Purpose or Provisioned IOPS\. Provisioned IOPS is supported for gp3 and io1 storage types\. -+ Change the provisioned IOPS, if you're using the volume types that supports provisioned IOPS, such as io1 or gp3\. - -The following limitations apply to modifying the storage for an RDS Custom for SQL Server DB instance: -+ The minimum allocated storage size for RDS Custom for SQL Server is 20 GiB, and the maximum supported storage size is 16 TiB\. -+ As with Amazon RDS, you can't decrease the allocated storage\. This is a limitation of Amazon Elastic Block Store \(Amazon EBS\) volumes\. For more information, see [Working with storage for Amazon RDS DB instances](USER_PIOPS.StorageTypes.md) -+ Storage autoscaling isn't supported for RDS Custom for SQL Server DB instances\. -+ Any storage volumes that you manually attach to your RDS Custom DB instance are not considered for storage scaling\. Only the RDS\-provided default data volumes, i\.e\., the D drive, are considered for storage scaling\. - - For more information, see [RDS Custom support perimeter and unsupported configurations](custom-troubleshooting.md#custom-troubleshooting.support-perimeter)\. -+ Scaling storage usually doesn't cause any outage or performance degradation of the DB instance\. After you modify the storage size for a DB instance, the status of the DB instance is **storage\-optimization**\. -+ Storage optimization can take several hours\. You can't make further storage modifications for either six \(6\) hours or until storage optimization has completed on the instance, whichever is longer\. For more information, see [Working with storage for Amazon RDS DB instances](USER_PIOPS.StorageTypes.md) - -For more information about storage, see [Amazon RDS DB instance storage](CHAP_Storage.md)\. - -For general information about storage modification, see [Working with storage for Amazon RDS DB instances](USER_PIOPS.StorageTypes.md)\. - -### Console - -**To modify the storage for an RDS Custom for SQL Server DB instance** - -1. Sign in to the AWS Management Console and open the Amazon RDS console at [https://console\.aws\.amazon\.com/rds/](https://console.aws.amazon.com/rds/)\. - -1. In the navigation pane, choose **Databases**\. - -1. Choose the DB instance that you want to modify\. - -1. Choose **Modify**\. - -1. Make the following changes as needed: - - 1. Enter a new value for **Allocated storage**\. It must be greater than the current value, and from 20 GiB–16 TiB\. - - 1. Change the value for **Storage type**\. You can use available storage types like General Purpose or Provisioned IOPS\. Provisioned IOPS is supported for gp3 and io1 storage types\. - - 1. If you are specifying volume types that support provisioned IOPS, you can define the **Provisioned IOPS** value\. - -1. Choose **Continue**\. - -1. Choose **Apply immediately** or **Apply during the next scheduled maintenance window**\. - -1. Choose **Modify DB instance**\. - -### AWS CLI - -To modify the storage for an RDS Custom for SQL Server DB instance, use the [modify\-db\-instance](https://docs.aws.amazon.com/cli/latest/reference/rds/modify-db-instance.html) AWS CLI command\. Set the following parameters as needed: -+ `--allocated-storage` – Amount of storage to be allocated for the DB instance, in gibibytes\. It must be greater than the current value, and from 20–16,384 GiB\. -+ `--storage-type` – The storage type, for example, gp3, gp2, or io1\. -+ `--iops` – Provisioned IOPS for the DB instance\. You can specify this only for storage types that support provisioned IOPS, like io1\. -+ `--apply-immediately` – Use `--apply-immediately` to apply the storage changes immediately\. - - Or use `--no-apply-immediately` \(the default\) to apply the changes during the next maintenance window\. - -The following example changes the storage size of my\-custom\-instance to 200 GiB, storage type to io1, and Provisioned IOPS to 3000\. - -**Example** -For Linux, macOS, or Unix: - -``` -aws rds modify-db-instance \ - --db-instance-identifier my-custom-instance \ - --storage-type io1 \ - --iops 3000 \ - --allocated-storage 200 \ - --apply-immediately -``` -For Windows: - -``` -aws rds modify-db-instance ^ - --db-instance-identifier my-custom-instance ^ - --storage-type io1 ^ - --iops 3000 ^ - --allocated-storage 200 ^ - --apply-immediately -``` - -## Tagging RDS Custom for SQL Server resources - -You can tag RDS Custom resources as with Amazon RDS resources, but with some important differences: -+ Don't create or modify the `AWSRDSCustom` tag that's required for RDS Custom automation\. If you do, you might break the automation\. -+ Tags added to RDS Custom DB instances during creation are propagated to all other related RDS Custom resources\. -+ Tags aren't propagated when you add them to RDS Custom resources after DB instance creation\. - -For general information about resource tagging, see [Tagging Amazon RDS resources](USER_Tagging.md)\. - -## Deleting an RDS Custom for SQL Server DB instance - -To delete an RDS Custom for SQL Server DB instance, do the following: -+ Provide the name of the DB instance\. -+ Choose or clear the option to take a final DB snapshot of the DB instance\. -+ Choose or clear the option to retain automated backups\. - -You can delete an RDS Custom for SQL Server DB instance using the console or the CLI\. The time required to delete the DB instance can vary depending on the backup retention period \(that is, how many backups to delete\), how much data is deleted, and whether a final snapshot is taken\. - -**Note** -You can't create a final DB snapshot of your DB instance if it has a status of `creating`, `failed`, `incompatible-create`, `incompatible-restore`, or `incompatible-network`\. For more information, see [Viewing Amazon RDS DB instance status](accessing-monitoring.md#Overview.DBInstance.Status)\. - -**Important** -When you choose to take a final snapshot, we recommend that you avoid writing data to your DB instance while the DB instance deletion is in progress\. Once the DB instance deletion is initiated, data changes are not guaranteed to be captured by the final snapshot\. - -### Console - -**To delete an RDS Custom DB instance** - -1. Sign in to the AWS Management Console and open the Amazon RDS console at [https://console\.aws\.amazon\.com/rds/](https://console.aws.amazon.com/rds/)\. - -1. In the navigation pane, choose **Databases**, and then choose the RDS Custom for SQL Server DB instance that you want to delete\. RDS Custom for SQL Server DB instances show the role **Instance \(RDS Custom for SQL Server\)**\. - -1. For **Actions**, choose **Delete**\. - -1. To take a final snapshot, choose **Create final snapshot**, and provide a name for the **Final snapshot name**\. - -1. To retain automated backups, choose **Retain automated backups**\. - -1. Enter **delete me** in the box\. - -1. Choose **Delete**\. - -### AWS CLI - -You delete an RDS Custom for SQL Server DB instance by using the [delete\-db\-instance](https://docs.aws.amazon.com/cli/latest/reference/rds/delete-db-instance.html) AWS CLI command\. Identify the DB instance using the required parameter `--db-instance-identifier`\. The remaining parameters are the same as for an Amazon RDS DB instance\. - -The following example deletes the RDS Custom for SQL Server DB instance named `my-custom-instance`, takes a final snapshot, and retains automated backups\. - -**Example** -For Linux, macOS, or Unix: - -``` -aws rds delete-db-instance \ - --db-instance-identifier my-custom-instance \ - --no-skip-final-snapshot \ - --final-db-snapshot-identifier my-custom-instance-final-snapshot \ - --no-delete-automated-backups -``` -For Windows: - -``` -aws rds delete-db-instance ^ - --db-instance-identifier my-custom-instance ^ - --no-skip-final-snapshot ^ - --final-db-snapshot-identifier my-custom-instance-final-snapshot ^ - --no-delete-automated-backups -``` - -To take a final snapshot, the `--final-db-snapshot-identifier` option is required and must be specified\. - -To skip the final snapshot, specify the `--skip-final-snapshot` option instead of the `--no-skip-final-snapshot` and `--final-db-snapshot-identifier` options in the command\. - -To delete automated backups, specify the `--delete-automated-backups` option instead of the `--no-delete-automated-backups` option in the command\. \ No newline at end of file diff --git a/doc_source/custom-managing.md b/doc_source/custom-managing.md deleted file mode 100644 index 2b93050..0000000 --- a/doc_source/custom-managing.md +++ /dev/null @@ -1,581 +0,0 @@ -# Managing an Amazon RDS Custom for Oracle DB instance - -Amazon RDS Custom supports a subset of the usual management tasks for Amazon RDS DB instances\. Following, you can find instructions for the supported RDS Custom for Oracle management tasks using the AWS Management Console and the AWS CLI\. - -**Topics** -+ [Working with container databases \(CDBs\) in RDS Custom for Oracle](#custom-managing.multitenant) -+ [Working with high availability features for RDS Custom for Oracle](#custom-managing.ha) -+ [Customizing your RDS Custom environment](#custom-managing.customizing-env) -+ [Modifying your RDS Custom for Oracle DB instance](#custom-managing.modifying) -+ [Changing the time zone of an RDS Custom for Oracle DB instance](#custom-managing.timezone) -+ [Changing the character set of an RDS Custom for Oracle DB instance](#custom-managing.character-set) -+ [Setting the NLS\_LANG value in RDS Custom for Oracle](#custom-managing.nlslang) -+ [Support for Transparent Data Encryption](#custom-managing.tde) -+ [Tagging RDS Custom for Oracle resources](#custom-managing.tagging) -+ [Deleting an RDS Custom for Oracle DB instance](#custom-managing.deleting) - -## Working with container databases \(CDBs\) in RDS Custom for Oracle - -You can either create your RDS Custom for Oracle DB instance with the Oracle Multitenant architecture \(`custom-oracle-ee-cdb` engine type\) or with the traditional non\-CDB architecture \(`custom-oracle-ee` engine type\)\. When you create a container database \(CDB\), it contains one pluggable database \(PDB\) and one PDB seed\. You can create additional PDBs manually using Oracle SQL\. - -### PDB and CDB names - -When you create an RDS Custom for Oracle CDB instance, you specify a name for the initial PDB\. By default, your initial PDB is named `ORCL`\. You can choose a different name\. - -Your CDB is always named `RDSCDB`\. You can't change this value\. The CDB name is also the name of your Oracle system identifier \(SID\), which uniquely identifies the memory and processes that manage your CDB\. For more information about the SID, see [Oracle System Identifier \(SID\)](https://docs.oracle.com/en/database/oracle/oracle-database/19/cncpt/oracle-database-instance.html#GUID-8BB8140D-63ED-454E-AAC3-1964F80D102D) in *Oracle Database Concepts*\. - -You can't rename existing PDBs using Amazon RDS APIs\. You also can't rename the CDB using the `modify-db-instance` command\. - -### PDB management - -In the RDS Custom for Oracle shared responsibility model, you are responsible for managing PDBs and creating any additional PDBs\. RDS Custom doesn't restrict the number of PDBs\. You can manually create, modify, and delete PDBs by connecting to the CDB root and running a SQL statement\. Create PDBs on an Amazon EBS data volume to prevent the DB instance from going outside the support perimeter\. - -To modify your CDBs or PDBs, complete the following steps: - -1. Pause automation to prevent interference with RDS Custom actions\. - -1. Modify your CDB or PDBs\. - -1. Back up any modified PDBs\. - -1. Resume RDS Custom automation\. - -### Automatic recovery of the CDB root - -RDS Custom keeps the CDB root open in the same way as it keeps a non\-CDB open\. If the state of the CDB root changes, the monitoring and recovery automation attempts to recover the CDB root to the desired state\. You receive RDS event notifications when the root CDB is shut down \(`RDS-EVENT-0004`\) or restarted \(`RDS-EVENT-0006`\), similar to the non\-CDB architecture\. RDS Custom attempts to open all PDBs in `READ WRITE` mode at DB instance startup\. If some PDBs can't be opened, RDS Custom publishes the following event: `tenant database shutdown`\. - -## Working with high availability features for RDS Custom for Oracle - -To support replication between RDS Custom for Oracle instances, you can configure high availability \(HA\) with Oracle Data Guard\. The primary DB instance automatically synchronizes data to the standby instances\. - -You can configure your high availability environment in the following ways: -+ Configure standby instances in different Availability Zones \(AZs\) to be resilient to AZ failures\. -+ Place your standby databases in mounted or read\-only mode\. -+ Fail over or switch over from the primary database to a standby database with no data loss\. -+ Migrate data by configuring high availability for your on\-premises instance, and then failing over or switching over to the RDS Custom standby database\. - -To learn how to configure high availability, see the whitepaper [Build high availability for Amazon RDS Custom for Oracle using read replicas](http://aws.amazon.com/blogs/database/build-high-availability-for-amazon-rds-custom-for-oracle-using-read-replicas/)\. You can perform the following tasks: -+ Use a virtual private network \(VPN\) tunnel to encrypt data in transit for your high availability instances\. Encryption in transit isn't configured automatically by RDS Custom\. -+ Configure Oracle Fast\-Failover Observer \(FSFO\) to monitor your high availability instances\. -+ Allow the observer to perform automatic failover when necessary conditions are met\. - -## Customizing your RDS Custom environment - -RDS Custom for Oracle includes built\-in features that allow you to customize your DB instance environment without pausing automation\. For example, you can use RDS APIs to customize your environment as follows: -+ Create and restore DB snapshots to create a clone environment\. -+ Create read replicas\. -+ Modify storage settings\. -+ Change the CEV to apply release updates - -For some customizations, such as changing the time zone or character set, you can't use the RDS APIs\. In these cases, you need to change the environment manually by accessing your Amazon EC2 instance as the root user or logging in to your Oracle database as `SYSDBA`\. - -To customize your instance manually, you must pause and resume RDS Custom automation\. This pause ensures that your customizations don't interfere with RDS Custom automation\. In this way, you avoid breaking the support perimeter, which places the instance in the `unsupported-configuration` state until you fix the underlying issues\. Pausing and resuming are the only supported automation tasks when you modify an RDS Custom for Oracle DB instance\. - -### General steps for customizing your RDS Custom environment - -To customize your RDS Custom DB instance, complete the following steps: - -1. Pause RDS Custom automation for a specified period using the console or CLI\. - -1. Identify your underlying Amazon EC2 instance\. - -1. Connect to your underlying Amazon EC2 instance using SSH keys or AWS Systems Manager\. - -1. Verify your current configuration settings at the database or operating system layer\. - - You can validate your changes by comparing the initial configuration to the changed configuration\. Depending on the type of customization, use OS tools or database queries\. - -1. Customize your RDS Custom for Oracle DB instance as needed\. - -1. Reboot your instance or database, if required\. -**Note** -In an on\-premises Oracle CDB, you can preserve a specified open mode for PDBs using a built\-in command or after a startup trigger\. This mechanism brings PDBs to a specified state when the CDB restarts\. When opening your CDB, RDS Custom automation discards any user\-specified preserved states and attempts to open all PDBs\. If RDS Custom can't open all PDBs, the following event is issued: `The following PDBs failed to open: list-of-PDBs`\. - -1. Verify your new configuration settings by comparing them with the previous settings\. - -1. Resume RDS Custom automation in either of the following ways: - + Resume automation manually\. - + Wait for the pause period to end\. In this case, RDS Custom resumes monitoring and instance recovery automatically\. - -1. Verify the RDS Custom automation framework - - If you followed the preceding steps correctly, RDS Custom starts an automated backup\. The status of the instance in the console shows **Available**\. - -For best practices and step\-by\-step instructions, see the AWS blog posts [Make configuration changes to an Amazon RDS Custom for Oracle instance: Part 1](http://aws.amazon.com/blogs/database/part-1-make-configuration-changes-to-an-amazon-rds-custom-for-oracle-instance/) and [Recreate an Amazon RDS Custom for Oracle database: Part 2](http://aws.amazon.com/blogs/database/part-2-recreate-an-amazon-rds-custom-for-oracle-database/)\. - -### Pausing and resuming your RDS Custom DB instance - -You can pause and resume automation for your DB instance using the console or CLI\. - -#### Console - -**To pause or resume RDS Custom automation** - -1. Sign in to the AWS Management Console and open the Amazon RDS console at [https://console\.aws\.amazon\.com/rds/](https://console.aws.amazon.com/rds/)\. - -1. In the navigation pane, choose **Databases**, and then choose the RDS Custom DB instance that you want to modify\. - -1. Choose **Modify**\. The **Modify DB instance** page appears\. - -1. For **RDS Custom automation mode**, choose one of the following options: - + **Paused** pauses the monitoring and instance recovery for the RDS Custom DB instance\. Enter the pause duration that you want \(in minutes\) for **Automation mode duration**\. The minimum value is 60 minutes \(default\)\. The maximum value is 1,440 minutes\. - + **Full automation** resumes automation\. - -1. Choose **Continue** to check the summary of modifications\. - - A message indicates that RDS Custom will apply the changes immediately\. - -1. If your changes are correct, choose **Modify DB instance**\. Or choose **Back** to edit your changes or **Cancel** to cancel your changes\. - - On the RDS console, the details for the modification appear\. If you paused automation, the **Status** of your RDS Custom DB instance indicates **Automation paused**\. - -1. \(Optional\) In the navigation pane, choose **Databases**, and then your RDS Custom DB instance\. - - In the **Summary** pane, **RDS Custom automation mode** indicates the automation status\. If automation is paused, the value is **Paused\. Automation resumes in *num* minutes**\. - -#### AWS CLI - -To pause or resume RDS Custom automation, use the `modify-db-instance` AWS CLI command\. Identify the DB instance using the required parameter `--db-instance-identifier`\. Control the automation mode with the following parameters: -+ `--automation-mode` specifies the pause state of the DB instance\. Valid values are `all-paused`, which pauses automation, and `full`, which resumes it\. -+ `--resume-full-automation-mode-minutes` specifies the duration of the pause\. The default value is 60 minutes\. - -**Note** -Regardless of whether you specify `--no-apply-immediately` or `--apply-immediately`, RDS Custom applies modifications asynchronously as soon as possible\. - -In the command response, `ResumeFullAutomationModeTime` indicates the resume time as a UTC timestamp\. When the automation mode is `all-paused`, you can use `modify-db-instance` to resume automation mode or extend the pause period\. No other `modify-db-instance` options are supported\. - -The following example pauses automation for `my-custom-instance` for 90 minutes\. - -**Example** -For Linux, macOS, or Unix: - -``` -aws rds modify-db-instance \ - --db-instance-identifier my-custom-instance \ - --automation-mode all-paused \ - --resume-full-automation-mode-minutes 90 -``` -For Windows: - -``` -aws rds modify-db-instance ^ - --db-instance-identifier my-custom-instance ^ - --automation-mode all-paused ^ - --resume-full-automation-mode-minutes 90 -``` - -The following example extends the pause duration for an extra 30 minutes\. The 30 minutes is added to the original time shown in `ResumeFullAutomationModeTime`\. - -**Example** -For Linux, macOS, or Unix: - -``` -aws rds modify-db-instance \ - --db-instance-identifier my-custom-instance \ - --automation-mode all-paused \ - --resume-full-automation-mode-minutes 30 -``` -For Windows: - -``` -aws rds modify-db-instance ^ - --db-instance-identifier my-custom-instance ^ - --automation-mode all-paused ^ - --resume-full-automation-mode-minutes 30 -``` - -The following example resumes full automation for `my-custom-instance`\. - -**Example** -For Linux, macOS, or Unix: - -``` -aws rds modify-db-instance \ - --db-instance-identifier my-custom-instance \ - --automation-mode full \ -``` -For Windows: - -``` -aws rds modify-db-instance ^ - --db-instance-identifier my-custom-instance ^ - --automation-mode full -``` -In the following partial sample output, the pending `AutomationMode` value is `full`\. - -``` -{ - "DBInstance": { - "PubliclyAccessible": true, - "MasterUsername": "admin", - "MonitoringInterval": 0, - "LicenseModel": "bring-your-own-license", - "VpcSecurityGroups": [ - { - "Status": "active", - "VpcSecurityGroupId": "0123456789abcdefg" - } - ], - "InstanceCreateTime": "2020-11-07T19:50:06.193Z", - "CopyTagsToSnapshot": false, - "OptionGroupMemberships": [ - { - "Status": "in-sync", - "OptionGroupName": "default:custom-oracle-ee-19" - } - ], - "PendingModifiedValues": { - "AutomationMode": "full" - }, - "Engine": "custom-oracle-ee", - "MultiAZ": false, - "DBSecurityGroups": [], - "DBParameterGroups": [ - { - "DBParameterGroupName": "default.custom-oracle-ee-19", - "ParameterApplyStatus": "in-sync" - } - ], - ... - "ReadReplicaDBInstanceIdentifiers": [], - "AllocatedStorage": 250, - "DBInstanceArn": "arn:aws:rds:us-west-2:012345678912:db:my-custom-instance", - "BackupRetentionPeriod": 3, - "DBName": "ORCL", - "PreferredMaintenanceWindow": "fri:10:56-fri:11:26", - "Endpoint": { - "HostedZoneId": "ABCDEFGHIJKLMNO", - "Port": 8200, - "Address": "my-custom-instance.abcdefghijk.us-west-2.rds.amazonaws.com" - }, - "DBInstanceStatus": "automation-paused", - "IAMDatabaseAuthenticationEnabled": false, - "AutomationMode": "all-paused", - "EngineVersion": "19.my_cev1", - "DeletionProtection": false, - "AvailabilityZone": "us-west-2a", - "DomainMemberships": [], - "StorageType": "gp2", - "DbiResourceId": "db-ABCDEFGHIJKLMNOPQRSTUVW", - "ResumeFullAutomationModeTime": "2020-11-07T20:56:50.565Z", - "KmsKeyId": "arn:aws:kms:us-west-2:012345678912:key/aa111a11-111a-11a1-1a11-1111a11a1a1a", - "StorageEncrypted": false, - "AssociatedRoles": [], - "DBInstanceClass": "db.m5.xlarge", - "DbInstancePort": 0, - "DBInstanceIdentifier": "my-custom-instance", - "TagList": [] - } -``` - -## Modifying your RDS Custom for Oracle DB instance - -Modifying an RDS Custom for Oracle DB instance is similar to modifying an Amazon RDS instance, but you can only do the following: -+ Change the DB instance class\. -+ Increase the allocated storage for your DB instance\. -+ Change the storage type to io1, gp2, or gp3\. -+ Change the Provisioned IOPS, if you're using the io1 or gp3 storage types\. - -**Topics** -+ [Requirements and limitations when modifying your DB instance storage](#custom-managing.storage-modify) -+ [Requirements and limitations when modifying your DB instance class](#custom-managing.instance-class-reqs) -+ [How RDS Custom creates your DB instance when you modify the instance class](#custom-managing.instance-class-resources) -+ [Modifying the instance class or storage for your RDS Custom for Oracle DB instance](#custom-managing.modifying.procedure) - -### Requirements and limitations when modifying your DB instance storage - -Consider the following requirements and limitations when you modify the storage for an RDS Custom for Oracle DB instance: -+ The minimum allocated storage for RDS Custom for Oracle is 40 GiB, and the maximum is 64 TiB\. -+ As with Amazon RDS, you can't decrease the allocated storage\. This is a limitation of Amazon EBS volumes\. -+ Storage autoscaling isn't supported for RDS Custom DB instances\. -+ Any storage volumes that you attach manually to your RDS Custom DB instance are outside the support perimeter\. - - For more information, see [RDS Custom support perimeter and unsupported configurations](custom-troubleshooting.md#custom-troubleshooting.support-perimeter)\. -+ Magnetic \(standard\) Amazon EBS storage isn't supported for RDS Custom\. You can choose only the io1, gp2, or gp3 SSD storage types\. - -For more information about Amazon EBS storage, see [Amazon RDS DB instance storage](CHAP_Storage.md)\. For general information about storage modification, see [Working with storage for Amazon RDS DB instances](USER_PIOPS.StorageTypes.md)\. - -### Requirements and limitations when modifying your DB instance class - -Consider the following requirements and limitations when you modify the instance class for an RDS Custom for Oracle DB instance: -+ Your DB instance must be in the `available` state\. -+ Your DB instance must have a minimum of 100 MiB of free space on the root volume, data volume, and binary volume\. -+ You can assign only a single elastic IP \(EIP\) to your RDS Custom for Oracle DB instance when using the default elastic network interface \(ENI\)\. If you attach multiple ENIs to your DB instance, the modify operation fails\. -+ All RDS Custom for Oracle tags must be present\. -+ If you use RDS Custom for Oracle replication, note the following requirements and limitations: - + For primary DB instances and read replicas, you can change the instance class for only one DB instance at a time\. - + If your RDS Custom for Oracle DB instance has an on\-premises primary or replica database, make sure to manually update private IP addresses on the on\-premises DB instance after the modification completes\. This action is necessary to preserve Oracle DataGuard functionality\. RDS Custom for Oracle publishes an event when the modification succeeds\. - + You can't modify your RDS Custom for Oracle DB instance class when the primary or read replica DB instances have FSFO \(Fast\-Start Failover\) configured\. - -### How RDS Custom creates your DB instance when you modify the instance class - -When you modify your instance class, RDS Custom creates your DB instance as follows: -+ Creates the Amazon EC2 instance\. -+ Creates the root volume from the latest DB snapshot\. RDS Custom for Oracle doesn't retain information added to the root volume after the latest DB snapshot\. -+ Creates Amazon CloudWatch alarms\. -+ Creates an Amazon EC2 SSH key pair if you have deleted the original key pair\. Otherwise, RDS Custom for Oracle retains the original key pair\. -+ Creates new resources using the tags that are attached to your DB instance when you initiate the modification\. RDS Custom doesn't transfer tags to the new resources when they are attached directly to underlying resources\. -+ Transfers the binary and data volumes with the most recent modifications to the new DB instance\. -+ Transfers the elastic IP address \(EIP\)\. If the DB instance is publicly accessible, then RDS Custom temporarily attaches a public IP address to the new DB instance before transferring the EIP\. If the DB instance isn't publicly accessible, RDS Custom doesn't create public IP addresses\. - -### Modifying the instance class or storage for your RDS Custom for Oracle DB instance - -You can modify the DB instance class or storage using the console, AWS CLI, or RDS API\. - -#### Console - -**To modify an RDS Custom for Oracle DB instance** - -1. Sign in to the AWS Management Console and open the Amazon RDS console at [https://console\.aws\.amazon\.com/rds/](https://console.aws.amazon.com/rds/)\. - -1. In the navigation pane, choose **Databases**\. - -1. Choose the DB instance that you want to modify\. - -1. Choose **Modify**\. - -1. Make the following changes as needed: - - 1. Change the value for **DB instance class**\. For supported classes, see [DB instance class support for RDS Custom for Oracle](custom-reqs-limits.md#custom-reqs-limits.instances)\. - - 1. Enter a new value for **Allocated storage**\. It must be greater than the current value, and from 40 GiB–64 TiB\. - - 1. Change the value for **Storage type** to **General Purpose SSD \(gp2\)**, **General Purpose SSD \(gp3\)**, or **Provisioned IOPS \(io1\)**\. - - 1. If you use **Provisioned IOPS \(io1\)** or **General Purpose SSD \(gp3\)**, you can change the **Provisioned IOPS** value\. - -1. Choose **Continue**\. - -1. Choose **Apply immediately** or **Apply during the next scheduled maintenance window**\. - -1. Choose **Modify DB instance**\. - -#### AWS CLI - -To modify the storage for an RDS Custom for Oracle DB instance, use the [modify\-db\-instance](https://docs.aws.amazon.com/cli/latest/reference/rds/modify-db-instance.html) AWS CLI command\. Set the following parameters as needed: -+ `--db-instance-class` – A new instance class\. For supported classes, see [DB instance class support for RDS Custom for Oracle](custom-reqs-limits.md#custom-reqs-limits.instances)\. -+ `--allocated-storage` – Amount of storage to be allocated for the DB instance, in gibibytes\. It must be greater than the current value, and from 40–65,536 GiB\. -+ `--storage-type` – The storage type: gp2, gp3, or io1\. -+ `--iops` – Provisioned IOPS for the DB instance, if using the io1 or gp3 storage types\. -+ `--apply-immediately` – Use `--apply-immediately` to apply the storage changes immediately\. - - Or use `--no-apply-immediately` \(the default\) to apply the changes during the next maintenance window\. - -The following example changes the DB instance class of my\-custom\-instance to db\.m5\.16xlarge\. The command also changes the storage size to 1 TiB, storage type to io1, and Provisioned IOPS to 3000\. - -**Example** -For Linux, macOS, or Unix: - -``` -aws rds modify-db-instance \ - --db-instance-identifier my-custom-instance \ - --db-instance-class db.m5.16xlarge \ - --storage-type io1 \ - --iops 3000 \ - --allocated-storage 1024 \ - --apply-immediately -``` -For Windows: - -``` -aws rds modify-db-instance ^ - --db-instance-identifier my-custom-instance ^ - --db-instance-class db.m5.16xlarge ^ - --storage-type io1 ^ - --iops 3000 ^ - --allocated-storage 1024 ^ - --apply-immediately -``` - -## Changing the time zone of an RDS Custom for Oracle DB instance - -You change the time zone of an RDS Custom for Oracle DB instance manually\. This approach contrasts with RDS for Oracle, where you use the `TIME_ZONE` option in a custom DB option group\. - -You can change time zones for RDS Custom for Oracle DB instances multiple times\. However, we recommend not changing them more than once every 48 hours\. We also recommend changing them only when the latest restorable time is within the last 30 minutes\. - -If you don't follow these recommendations, cleaning up redo logs might remove more logs than intended\. Redo log timestamps might also be converted incorrectly to UTC, which can prevent the redo log files from being downloaded and replayed correctly\. This in turn can prevent point\-in\-time recovery \(PITR\) from performing correctly\. - -Changing the time zone of an RDS Custom for Oracle DB instance has the following limitations: -+ PITR is supported for recovery times before RDS Custom automation is paused, and after automation is resumed\. - - For more information about PITR, see [Restoring an RDS Custom for Oracle instance to a point in time](custom-backup.md#custom-backup.pitr)\. -+ Changing the time zone of an existing read replica causes downtime\. We recommend changing the time zone of the DB instance before creating read replicas\. - - You can create a read replica from a DB instance with a modified time zone\. For more information about read replicas, see [Working with Oracle replicas for RDS Custom for Oracle](custom-rr.md)\. - -Use the following procedures to change the time zone of an RDS Custom for Oracle DB instance\. - -Make sure to follow these procedures\. If they aren't followed, it can result in these issues: -+ Disruption of redo log download and replay -+ Incorrect redo log timestamps -+ Cleanup of redo logs on the host that doesn't use the redo log retention period - -**To change the time zone for a primary DB instance** - -1. Pause RDS Custom automation\. For more information, see [Pausing and resuming your RDS Custom DB instance](#custom-managing.pausing)\. - -1. \(Optional\) Change the time zone of the DB instance, for example by using the following command\. - - ``` - ALTER DATABASE SET TIME_ZONE = 'US/Pacific'; - ``` - -1. Shut down the DB instance\. - -1. Log in to the host and change the system time zone\. - -1. Start the DB instance\. - -1. Resume RDS Custom automation\. - -**To change the time zone for a primary DB instance and its read replicas** - -1. Pause RDS Custom automation on the primary DB instance\. - -1. Pause RDS Custom automation on the read replicas\. - -1. \(Optional\) Change the time zone of the primary and read replicas, for example by using the following command\. - - ``` - ALTER DATABASE SET TIME_ZONE = 'US/Pacific'; - ``` - -1. Shut down the primary DB instance\. - -1. Shut down the read replicas\. - -1. Log in to the host and change the system time zone for the read replicas\. - -1. Change the system time zone for the primary DB instance\. - -1. Mount the read replicas\. - -1. Start the primary DB instance\. - -1. Resume RDS Custom automation on the primary DB instance and then on the read replicas\. - -## Changing the character set of an RDS Custom for Oracle DB instance - -RDS Custom for Oracle defaults to the character set US7ASCII\. You might want to specify different character sets to meet language or multibyte character requirements\. When you use RDS Custom for Oracle, you can pause automation and then change the character set of your database manually\. - -Changing the character set of an RDS Custom for Oracle DB instance has the following requirements: -+ You can only change the character on a newly provisioned RDS Custom instance that has an empty or starter database with no application data\. For all other scenarios, change the character set using DMU \(Database Migration Assistant for Unicode\)\. -+ You can only change to a character set supported by RDS for Oracle\. For more information, see [Supported DB character sets](Appendix.OracleCharacterSets.md#Appendix.OracleCharacterSets.db-character-set.supported)\. - -**To change the character set of an RDS Custom for Oracle DB instance** - -1. Pause RDS Custom automation\. For more information, see [Pausing and resuming your RDS Custom DB instance](#custom-managing.pausing)\. - -1. Log in to your database as a user with `SYSDBA` privileges\. - -1. Restart the database in restricted mode, change the character set, and then restart the database in normal mode\. - - Run the following script in your SQL client: - - ``` - SHUTDOWN IMMEDIATE; - STARTUP RESTRICT; - ALTER DATABASE CHARACTER SET INTERNAL_CONVERT AL32UTF8; - SHUTDOWN IMMEDIATE; - STARTUP; - SELECT VALUE FROM NLS_DATABASE_PARAMETERS WHERE PARAMETER = 'NLS_CHARACTERSET'; - ``` - - Verify that the output shows the correct character set: - - ``` - VALUE - -------- - AL32UTF8 - ``` - -1. Resume RDS Custom automation\. For more information, see [Pausing and resuming your RDS Custom DB instance](#custom-managing.pausing)\. - -## Setting the NLS\_LANG value in RDS Custom for Oracle - -A *locale* is a set of information addressing linguistic and cultural requirements that corresponds to a given language and country\. To specify locale behavior for Oracle software, set the `NLS_LANG` environment variable on your client host\. This variable sets the language, territory, and character set used by the client application in a database session\. - -For RDS Custom for Oracle, you can set only the language in the `NLS_LANG` variable: the territory and character use defaults\. The language is used for Oracle database messages, collation, day names, and month names\. Each supported language has a unique name, for example, American, French, or German\. If language is not specified, the value defaults to American\. - -After you create your RDS Custom for Oracle database, you can set `NLS_LANG` on your client host to a language other than English\. To see a list of languages supported by Oracle Database, log in to your RDS Custom for Oracle database and run the following query: - -``` -SELECT VALUE FROM V$NLS_VALID_VALUES WHERE PARAMETER='LANGUAGE' ORDER BY VALUE; -``` - -You can set `NLS_LANG` on the host command line\. The following example sets the language to German for your client application using the Z shell on Linux\. - -``` -export NLS_LANG=German -``` - -Your application reads the `NLS_LANG` value when it starts and then communicates it to the database when it connects\. - -For more information, see [Choosing a Locale with the NLS\_LANG Environment Variable ](https://docs.oracle.com/en/database/oracle/oracle-database/21/nlspg/setting-up-globalization-support-environment.html#GUID-86A29834-AE29-4BA5-8A78-E19C168B690A) in the *Oracle Database Globalization Support Guide*\. - -## Support for Transparent Data Encryption - -RDS Custom supports Transparent Data Encryption \(TDE\) for RDS Custom for Oracle DB instances\. - -However, you can't enable TDE using an option in a custom option group as you can in RDS for Oracle\. You turn on TDE manually\. For information about using Oracle Transparent Data Encryption, see [Securing stored data using Transparent Data Encryption](http://docs.oracle.com/cd/E11882_01/network.112/e40393/asotrans.htm#BABFGJAG) in the Oracle documentation\. - -## Tagging RDS Custom for Oracle resources - -You can tag RDS Custom resources as with Amazon RDS resources, but with some important differences: -+ Don't create or modify the `AWSRDSCustom` tag that's required for RDS Custom automation\. If you do, you might break the automation\. -+ Tags added to RDS Custom DB instances during creation are propagated to all other related RDS Custom resources\. -+ Tags aren't propagated when you add them to RDS Custom resources after DB instance creation\. - -For general information about resource tagging, see [Tagging Amazon RDS resources](USER_Tagging.md)\. - -## Deleting an RDS Custom for Oracle DB instance - -To delete an RDS Custom DB instance, do the following: -+ Provide the name of the DB instance\. -+ Clear the option to take a final DB snapshot of the DB instance\. -+ Choose or clear the option to retain automated backups\. - -You can delete an RDS Custom DB instance using the console or the CLI\. The time required to delete the DB instance can vary depending on the backup retention period \(that is, how many backups to delete\) and how much data is deleted\. - -### Console - -**To delete an RDS Custom DB instance** - -1. Sign in to the AWS Management Console and open the Amazon RDS console at [https://console\.aws\.amazon\.com/rds/](https://console.aws.amazon.com/rds/)\. - -1. In the navigation pane, choose **Databases**, and then choose the RDS Custom DB instance that you want to delete\. RDS Custom DB instances show the role **Instance \(RDS Custom\)**\. - -1. For **Actions**, choose **Delete**\. - -1. To retain automated backups, choose **Retain automated backups**\. - -1. Enter **delete me** in the box\. - -1. Choose **Delete**\. - -### AWS CLI - -You delete an RDS Custom DB instance by using the [delete\-db\-instance](https://docs.aws.amazon.com/cli/latest/reference/rds/delete-db-instance.html) AWS CLI command\. Identify the DB instance using the required parameter `--db-instance-identifier`\. The remaining parameters are the same as for an Amazon RDS DB instance, with the following exceptions: -+ `--skip-final-snapshot` is required\. -+ `--no-skip-final-snapshot` isn't supported\. -+ `--final-db-snapshot-identifier` isn't supported\. - -The following example deletes the RDS Custom DB instance named `my-custom-instance`, and retains automated backups\. - -**Example** -For Linux, macOS, or Unix: - -``` -aws rds delete-db-instance \ - --db-instance-identifier my-custom-instance \ - --skip-final-snapshot \ - --no-delete-automated-backups -``` -For Windows: - -``` -aws rds delete-db-instance ^ - --db-instance-identifier my-custom-instance ^ - --skip-final-snapshot ^ - --no-delete-automated-backups -``` \ No newline at end of file diff --git a/doc_source/custom-migrating-oracle.md b/doc_source/custom-migrating-oracle.md deleted file mode 100644 index 8e3fa1e..0000000 --- a/doc_source/custom-migrating-oracle.md +++ /dev/null @@ -1,19 +0,0 @@ -# Migrating an on\-premises database to RDS Custom for Oracle - -Before you migrate an on\-premises Oracle database to RDS Custom for Oracle, you need to consider the following factors: -+ The amount of downtime the application can afford -+ The size of the source database -+ Network connectivity -+ A requirement for a fallback plan -+ The source and target Oracle database version and DB instance OS types -+ Available replication tools, such as AWS Database Migration Service, Oracle GoldenGate, or third\-party replication tools - -Based on these factors, you can choose physical migration, logical migration, or a combination\. If you choose physical migration, you can use the following techniques: - -RMAN duplication -Active database duplication doesn’t require a backup of your source database\. It duplicates the live source database to the destination host by copying database files over the network to the auxiliary instance\. The RMAN `DUPLICATE` command copies the required files as image copies or backup sets\. To learn this technique, see the AWS blog post [Physical migration of Oracle databases to Amazon RDS Custom using RMAN duplication](http://aws.amazon.com/blogs/database/physical-migration-of-oracle-databases-to-amazon-rds-custom-using-rman-duplication/)\. - -Oracle Data Guard -In this technique, you back up a primary on\-premises database and copy the backups to an Amazon S3 bucket\. You then copy the backups to your RDS Custom for Oracle standby DB instance\. After performing the necessary configuration, you manually switch over your primary database to your RDS Custom for Oracle standby database\. To learn this technique, see the AWS blog post [Physical migration of Oracle databases to Amazon RDS Custom using Data Guard](http://aws.amazon.com/blogs/database/physical-migration-of-oracle-databases-to-amazon-rds-custom-using-data-guard/)\. - -For general information about logically importing data into RDS for Oracle, see [Importing data into Oracle on Amazon RDS](Oracle.Procedural.Importing.md)\. \ No newline at end of file diff --git a/doc_source/custom-migrating.md b/doc_source/custom-migrating.md deleted file mode 100644 index 215ccda..0000000 --- a/doc_source/custom-migrating.md +++ /dev/null @@ -1,104 +0,0 @@ -# Migrating an on\-premises database to Amazon RDS Custom for SQL Server - -You can use the following process to migrate an on\-premises Microsoft SQL Server database to Amazon RDS Custom for SQL Server using native backup and restore: - -1. Take a full backup of the database on the on\-premises DB instance\. - -1. Upload the backup file to Amazon S3\. - -1. Download the backup file from S3 to your RDS Custom for SQL Server DB instance\. - -1. Restore a database using the downloaded backup file on the RDS Custom for SQL Server DB instance\. - -This process explains the migration of a database from on\-premises to RDS Custom for SQL Server, using native full backup and restore\. To reduce the cutover time during the migration process, you might also consider using differential or log backups\. - -For general information about native backup and restore for RDS for SQL Server, see [Importing and exporting SQL Server databases using native backup and restore](SQLServer.Procedural.Importing.md)\. - -**Topics** -+ [Prerequisites](#custom-migrating.prereqs) -+ [Backing up the on\-premises database](#custom-migrating.backup) -+ [Uploading the backup file to Amazon S3](#custom-migrating.upload) -+ [Downloading the backup file from Amazon S3](#custom-migrating.upload) -+ [Restoring the backup file to the RDS Custom for SQL Server DB instance](#custom-migrating.restore) - -## Prerequisites - -Perform the following tasks before migrating the database: - -1. Configure Remote Desktop Connection \(RDP\) for your RDS Custom for SQL Server DB instance\. For more information, see [Connecting to your RDS Custom DB instance using RDP](custom-creating-sqlserver.md#custom-creating-sqlserver.rdp)\. - -1. Configure access to Amazon S3 so you can upload and download the database backup file\. For more information, see [Integrating an Amazon RDS for SQL Server DB instance with Amazon S3](User.SQLServer.Options.S3-integration.md)\. - -## Backing up the on\-premises database - -You use SQL Server native backup to take a full backup of the database on the on\-premises DB instance\. - -The following example shows a backup of a database called `mydatabase`, with the `COMPRESSION` option specified to reduce the backup file size\. - -**To back up the on\-premises database** - -1. Using SQL Server Management Studio \(SSMS\), connect to the on\-premises SQL Server instance\. - -1. Run the following T\-SQL command\. - - ``` - backup database mydatabase to - disk ='C:\Program Files\Microsoft SQL Server\MSSQL13.MSSQLSERVER\MSSQL\Backup\mydb-full-compressed.bak' - with compression; - ``` - -## Uploading the backup file to Amazon S3 - -You use the AWS Management Console to upload the backup file `mydb-full-compressed.bak` to Amazon S3\. - -**To upload the backup file to S3** - -1. Sign in to the AWS Management Console and open the Amazon S3 console at [https://console\.aws\.amazon\.com/s3/](https://console.aws.amazon.com/s3/)\. - -1. For **Buckets**, choose the name of the bucket to which you want to upload your backup file\. - -1. Choose **Upload**\. - -1. In the **Upload** window, do one of the following: - + Drag and drop `mydb-full-compressed.bak` to the **Upload** window\. - + Choose **Add file**, choose `mydb-full-compressed.bak`, and then choose **Open**\. - - Amazon S3 uploads your backup file as an S3 object\. When the upload completes, you can see a success message on the **Upload: status** page\. - -## Downloading the backup file from Amazon S3 - -You use the console to download the backup file from S3 to the RDS Custom for SQL Server DB instance\. - -**To download the backup file from S3** - -1. Using RDP, connect to your RDS Custom for SQL Server DB instance\. - -1. Sign in to the AWS Management Console and open the Amazon S3 console at [https://console\.aws\.amazon\.com/s3/](https://console.aws.amazon.com/s3/)\. - -1. In the **Buckets** list, choose the name of the bucket that contains your backup file\. - -1. Choose the backup file `mydb-full-compressed.bak`\. - -1. For **Actions**, choose **Download as**\. - -1. Open the context \(right\-click\) menu for the link provided, then choose **Save As**\. - -1. Save `mydb-full-compressed.bak` to the `D:\rdsdbdata\BACKUP` directory\. - -## Restoring the backup file to the RDS Custom for SQL Server DB instance - -You use SQL Server native restore to restore the backup file to your RDS Custom for SQL Server DB instance\. - -In this example, the `MOVE` option is specified because the data and log file directories are different from the on\-premises DB instance\. - -**To restore the backup file** - -1. Using SSMS, connect to your RDS Custom for SQL Server DB instance\. - -1. Run the following T\-SQL command\. - - ``` - restore database mydatabase from disk='D:\rdsdbdata\BACKUP\mydb-full-compressed.bak' - with move 'mydatabase' to 'D:\rdsdbdata\DATA\mydatabase.mdf', - move 'mydatabase_log' to 'D:\rdsdbdata\DATA\mydatabase_log.ldf'; - ``` \ No newline at end of file diff --git a/doc_source/custom-reqs-limits-MS.md b/doc_source/custom-reqs-limits-MS.md deleted file mode 100644 index 229493c..0000000 --- a/doc_source/custom-reqs-limits-MS.md +++ /dev/null @@ -1,51 +0,0 @@ -# Requirements and limitations for Amazon RDS Custom for SQL Server - -Following, you can find a summary of the Amazon RDS Custom for SQL Server requirements and limitations for quick reference\. Requirements and limitations also appear in the relevant sections\. - -**Topics** -+ [Region and version availability](#custom-reqs-limits-MS.RegionVersionAvailability) -+ [General requirements for RDS Custom for SQL Server](#custom-reqs-limits.reqsMS) -+ [DB instance class support for RDS Custom for SQL Server](#custom-reqs-limits.instancesMS) -+ [Limitations for RDS Custom for SQL Server](#custom-reqs-limits.limitsMS) - -## Region and version availability - -Feature availability and support varies across specific versions of each database engine, and across AWS Regions\. For more information on version and Region availability of Amazon RDS with Amazon RDS Custom for SQL Server, see [RDS Custom for SQL Server](Concepts.RDS_Fea_Regions_DB-eng.Feature.RDSCustom.md#Concepts.RDS_Fea_Regions_DB-eng.Feature.RDSCustom.sq)\. - -## General requirements for RDS Custom for SQL Server - -Make sure to follow these requirements for Amazon RDS Custom for SQL Server: -+ Use the instance classes shown in [DB instance class support for RDS Custom for SQL Server](#custom-reqs-limits.instancesMS)\. The only storage types supported are solid state drives \(SSD\) of types gp2, gp3, and io1\. The maximum storage limit is 16 TiB\. -+ Make sure that you have a symmetric encryption AWS KMS key to create an RDS Custom DB instance\. For more information, see [Make sure that you have a symmetric encryption AWS KMS key](custom-setup-sqlserver.md#custom-setup-sqlserver.cmk)\. -+ Make sure that you create an AWS Identity and Access Management \(IAM\) role and instance profile\. For more information, see [Creating your IAM role and instance profile manually](custom-setup-sqlserver.md#custom-setup-sqlserver.iam)\. -+ Make sure to supply a networking configuration that RDS Custom can use to access other AWS services\. For specific requirements, see [Configure networking, instance profile, and encryption](custom-setup-sqlserver.md#custom-setup-sqlserver.iam-vpc)\. -+ The combined number of RDS Custom and Amazon RDS DB instances can't exceed your quota limit\. For example, if your quota is 40 DB instances, you can have 20 RDS Custom for SQL Server DB instances and 20 Amazon RDS DB instances\. - -## DB instance class support for RDS Custom for SQL Server - -RDS Custom for SQL Server supports the DB instance classes shown in the following table\. - - -| SQL Server edition | RDS Custom support | -| --- | --- | -| Enterprise Edition | db\.r5\.xlarge–db\.r5\.24xlarge db\.m5\.xlarge–db\.m5\.24xlarge | -| Standard Edition | db\.r5\.large–db\.r5\.24xlarge db\.m5\.large–db\.m5\.24xlarge | -| Web Edition | db\.r5\.large–db\.r5\.4xlarge db\.m5\.large–db\.m5\.4xlarge | - -## Limitations for RDS Custom for SQL Server - -The following limitations apply to RDS Custom for SQL Server: -+ You can't create read replicas in Amazon RDS for RDS Custom for SQL Server DB instances\. However, you can configure high availability automatically with a Multi\-AZ deployment\. For more information, see [Managing a Multi\-AZ deployment for RDS Custom for SQL Server](custom-sqlserver-multiaz.md)\. -+ You can't modify the time zone of an existing RDS Custom for SQL Server DB instance\. -+ You can't modify the server\-level collation of an existing RDS Custom for SQL Server DB instance\. -+ Transparent Data Encryption \(TDE\) for database encryption isn't supported for RDS Custom for SQL Server\. However, you can use KMS for storage\-level encryption\. For more information on using KMS with RDS Custom for SQL Server, see [Make sure that you have a symmetric encryption AWS KMS key](custom-setup-sqlserver.md#custom-setup-sqlserver.cmk)\. -+ For an RDS Custom for SQL Server DB instance that wasn't created with a custom engine version \(CEV\), changes to the Microsoft Windows operating system or C: drive aren't guaranteed to persist\. For example, you will lose these changes when you scale compute or initiate a snapshot restore operation\. If the RDS Custom for SQL Server DB instance was created with a CEV, then those changes are persisted\. -+ You can’t stop your RDS Custom for SQL Server DB instance or its underlying Amazon EC2 instance\. Billing for an RDS Custom for SQL Server DB instance can't be stopped\. -+ Not all options are supported\. For example, when you create an RDS Custom for SQL Server DB instance, you can't do the following: - + Change the number of CPU cores and threads per core on the DB instance class\. - + Turn on storage autoscaling\. - + Configure Kerberos authentication using the AWS Management Console\. However, you can configure Windows Authentication manually and use Kerberos\. - + Specify your own DB parameter group, option group, or character set\. - + Turn on Performance Insights\. - + Turn on automatic minor version upgrade\. -+ The maximum DB instance storage is 16 TiB\. \ No newline at end of file diff --git a/doc_source/custom-reqs-limits.md b/doc_source/custom-reqs-limits.md deleted file mode 100644 index 2394f5d..0000000 --- a/doc_source/custom-reqs-limits.md +++ /dev/null @@ -1,65 +0,0 @@ -# RDS Custom for Oracle requirements and limitations - -In this topic, you can find a summary of the Amazon RDS Custom for Oracle feature availability and requirements for quick reference\. - -**Topics** -+ [AWS Region and database version support for RDS Custom for Oracle](#custom-reqs-limits.RegionVersionAvailability) -+ [Edition and licensing support for RDS Custom for Oracle](#custom-reqs-limits.edition-license) -+ [DB instance class support for RDS Custom for Oracle](#custom-reqs-limits.instances) -+ [General requirements for RDS Custom for Oracle](#custom-reqs-limits.reqs) -+ [General limitations for RDS Custom for Oracle](#custom-reqs-limits.limits) - -## AWS Region and database version support for RDS Custom for Oracle - -Feature availability and support vary across specific versions of each database engine, and across AWS Regions\. For more information on version and Region availability of RDS Custom for Oracle, see [RDS Custom](Concepts.RDS_Fea_Regions_DB-eng.Feature.RDSCustom.md)\. - -## Edition and licensing support for RDS Custom for Oracle - - RDS Custom for Oracle supports only Enterprise Edition on the BYOL model\. - -## DB instance class support for RDS Custom for Oracle - -RDS Custom for Oracle supports the following DB instance classes\. - - -| Type | Size | -| --- | --- | -| db\.m5 | db\.m5\.large \| db\.m5\.xlarge \| db\.m5\.2xlarge \| db\.m5\.4xlarge \| db\.m5\.8xlarge \| db\.m5\.12xlarge \| db\.m5\.16xlarge \| db\.m5\.24xlarge | -| db\.r5 | db\.r5\.large \| db\.r5\.xlarge \| db\.r5\.2xlarge \| db\.r5\.4xlarge \| db\.r5\.8xlarge \| db\.r5\.12xlarge \| db\.r5\.16xlarge \| db\.r5\.24xlarge | - -## General requirements for RDS Custom for Oracle - -Make sure to follow these requirements for Amazon RDS Custom for Oracle: -+ Use [Oracle Software Delivery Cloud](https://edelivery.oracle.com/) to download Oracle installation and patch files\. For more information, see [Prerequisites for creating an RDS Custom for Oracle DB instance](custom-setup-orcl.md#custom-setup-orcl.review)\. -+ Use the DB instance classes shown in [DB instance class support for RDS Custom for Oracle](#custom-reqs-limits.instances)\. The DB instances must run Oracle Linux 7 Update 9\. -+ Specify the gp2, gp3, or io1 solid state drives for storage\. The maximum storage limit is 64 TiB\. -+ Make sure that you have an AWS KMS key to create an RDS Custom DB instance\. For more information, see [Step 1: Create or reuse a symmetric encryption AWS KMS key](custom-setup-orcl.md#custom-setup-orcl.cmk)\. -+ Use only the approved database installation and patch files\. For more information, see [Step 2: Download your database installation files and patches from Oracle Software Delivery Cloud](custom-cev.preparing.md#custom-cev.preparing.download)\. -+ Create an AWS Identity and Access Management \(IAM\) role and instance profile\. For more information, see [Step 3: Configure IAM and your Amazon VPC](custom-setup-orcl.md#custom-setup-orcl.iam-vpc)\. -+ Make sure to supply a networking configuration that RDS Custom can use to access other AWS services\. For specific requirements, see [Step 3: Configure IAM and your Amazon VPC](custom-setup-orcl.md#custom-setup-orcl.iam-vpc)\. -+ Make sure that the combined number of RDS Custom and Amazon RDS DB instances doesn't exceed your quota limit\. For example, if your quota for Amazon RDS is 40 DB instances, you can have 20 RDS Custom for Oracle DB instances and 20 Amazon RDS DB instances\. - -## General limitations for RDS Custom for Oracle - -The following limitations apply to RDS Custom for Oracle: -+ You can't provide your own AMI\. -+ You can specify only the default AMI or an AMI that has been previously used by a CEV\. -+ You can't modify a CEV to use a different AMI\. -+ Not all options are supported\. For example, when you create or modify an RDS Custom for Oracle DB instance, you can't do the following: - + Change the number of CPU cores and threads per core on the DB instance class\. - + Turn on storage autoscaling\. - + Create a Multi\-AZ deployment\. -**Note** -For an alternative HA solution, see the AWS blog article [Build high availability for Amazon RDS Custom for Oracle using read replicas](http://aws.amazon.com/blogs/database/build-high-availability-for-amazon-rds-custom-for-oracle-using-read-replicas/)\. - + Set backup retention to `0`\. - + Configure Kerberos authentication\. - + Specify your own DB parameter group or option group\. - + Turn on Performance Insights\. - + Turn on automatic minor version upgrade\. -+ You can't specify a DB instance storage size greater than the maximum of 64 TiB\. -+ You can't create multiple Oracle databases on a single RDS Custom for Oracle DB instance\. -+ You can’t stop your RDS Custom for Oracle DB instance or its underlying Amazon EC2 instance\. Billing for an RDS Custom for Oracle DB instance can't be stopped\. -+ You can't use automatic shared memory management\. RDS Custom for Oracle supports only automatic memory management\. For more information, see [Automatic Memory Management](https://docs.oracle.com/en/database/oracle/oracle-database/19/admin/managing-memory.html#GUID-04EFED7D-D1F1-43C3-B78F-0FF9AFAC02B0) in the *Oracle Database Administrator’s Guide*\. -+ Make sure not to change the `DB_UNIQUE_NAME` for the primary DB instance\. Changing the name causes any restore operation to become stuck\. - -For limitations specific to modifying an RDS Custom for Oracle DB instance, see [Modifying your RDS Custom for Oracle DB instance](custom-managing.md#custom-managing.modifying)\. For replication limitations, see [General limitations for RDS Custom for Oracle replication](custom-rr.md#custom-rr.limitations)\. \ No newline at end of file diff --git a/doc_source/custom-rr.md b/doc_source/custom-rr.md deleted file mode 100644 index 2a3857a..0000000 --- a/doc_source/custom-rr.md +++ /dev/null @@ -1,172 +0,0 @@ -# Working with Oracle replicas for RDS Custom for Oracle - -You can create Oracle replicas for RDS Custom for Oracle DB instances\. Both container databases \(CDBs\) and non\-CDBs are supported\. Creating an RDS Custom for Oracle replica is similar to creating an RDS for Oracle replica, but with important differences\. For general information about creating and managing Oracle replicas, see [Working with DB instance read replicas](USER_ReadRepl.md) and [Working with read replicas for Amazon RDS for Oracle](oracle-read-replicas.md)\. - -**Topics** -+ [Overview of RDS Custom for Oracle replication](#custom-rr.overview) -+ [Guidelines and limitations for RDS Custom for Oracle replication](#custom-rr.reqs-limitations) -+ [Promoting an RDS Custom for Oracle replica to a standalone DB instance](#custom-rr.promoting) - -## Overview of RDS Custom for Oracle replication - -The architecture of RDS Custom for Oracle replication is analogous to RDS for Oracle replication\. A primary DB instance replicates asynchronously to one or more Oracle replicas\. - -![\[RDS Custom for Oracle supports Oracle replicas\]](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/images/read-replica-custom-oracle.png) - -### Maximum number of replicas - -As with RDS for Oracle, you can create up to five managed Oracle replicas of your RDS Custom for Oracle primary DB instance\. You can also create your own manually configured \(external\) Oracle replicas\. External replicas don't count toward your DB instance limit\. They also lie outside the RDS Custom support perimeter\. For more information about the support perimeter, see [RDS Custom support perimeter and unsupported configurations](custom-troubleshooting.md#custom-troubleshooting.support-perimeter)\. - -### Replica naming convention - -Oracle replica names are based on the database unique name\. The format is `DB_UNIQUE_NAME_X`, with letters appended sequentially\. For example, if your database unique name is `ORCL`, the first two replicas are named `ORCL_A` and `ORCL_B`\. The first six letters, A–F, are reserved for RDS Custom\. RDS Custom copies database parameters from your primary DB instance to the replicas\. For more information, see [DB\_UNIQUE\_NAME](https://docs.oracle.com/database/121/REFRN/GUID-3547C937-5DDA-49FF-A9F9-14FF306545D8.htm#REFRN10242) in the Oracle documentation\. - -### Replica backup retention - -By default, RDS Custom Oracle replicas use the same backup retention period as your primary DB instance\. You can modify the backup retention period to 1–35 days\. RDS Custom supports backing up, restoring, and point\-in\-time recovery \(PITR\)\. For more information about backing up and restoring RDS Custom DB instances, see [Backing up and restoring an Amazon RDS Custom for Oracle DB instance](custom-backup.md)\. - -**Note** -While creating a Oracle replica, RDS Custom temporarily pauses the cleanup of redo log files\. In this way, RDS Custom ensures that it can apply these logs to the new Oracle replica after it becomes available\. - -### Replica promotion - -You can promote managed Oracle replicas in RDS Custom for Oracle using the console, `promote-read-replica` AWS CLI command, or `PromoteReadReplica` API\. If you delete your primary DB instance, and all replicas are healthy, RDS Custom for Oracle promotes your managed replicas to standalone instances automatically\. If a replica has paused automation or is outside the support perimeter, you must fix the replica before RDS Custom can promote it automatically\. You can only promote external Oracle replicas manually\. - -## Guidelines and limitations for RDS Custom for Oracle replication - -When you create RDS Custom for Oracle replicas, not all RDS Oracle replica options are supported\. - -**Topics** -+ [General guidelines for RDS Custom for Oracle replication](#custom-rr.guidelines) -+ [General limitations for RDS Custom for Oracle replication](#custom-rr.limitations) -+ [Networking requirements and limitations for RDS Custom for Oracle replication](#custom-rr.network) -+ [External replica limitations for RDS Custom for Oracle](#custom-rr.external-replica-reqs) -+ [Replica promotion limitations for RDS Custom for Oracle](#custom-rr.promotion-reqs) -+ [Replica promotion guidelines for RDS Custom for Oracle](#custom-rr.promotion-guidelines) - -### General guidelines for RDS Custom for Oracle replication - -When working with RDS Custom for Oracle, follow these guidelines: -+ Don't modify the `RDS_DATAGUARD` user\. This user is reserved for RDS Custom for Oracle automation\. Modifying this user can result in undesired outcomes, such as an inability to create Oracle replicas for your RDS Custom for Oracle DB instance\. -+ Don't change the replication user password\. It is required to administer the Oracle Data Guard configuration on the RDS Custom host\. If you change the password, RDS Custom for Oracle might put your Oracle replica outside the support perimeter\. For more information, see [RDS Custom support perimeter and unsupported configurations](custom-troubleshooting.md#custom-troubleshooting.support-perimeter)\. - - The password is stored in AWS Secrets Manager, tagged with the DB resource ID\. Each Oracle replica has its own secret in Secrets Manager\. The format for the secret is the following\. - - ``` - do-not-delete-rds-custom-db-DB_resource_id-6-digit_UUID-dg - ``` -+ Don't change the `DB_UNIQUE_NAME` for the primary DB instance\. Changing the name causes any restore operation to become stuck\. -+ Don't specify the clause `STANDBYS=NONE` in a `CREATE PLUGGABLE DATABASE` command in an RDS Custom CDB\. This way, if a failover occurs, your standby CDB contains all PDBs\. - -### General limitations for RDS Custom for Oracle replication - -RDS Custom for Oracle replicas have the following limitations: -+ You can't create RDS Custom for Oracle replicas in read\-only mode\. However, you can manually change the mode of mounted replicas to read\-only, and from read\-only to mounted\. For more information, see the documentation for the [create\-db\-instance\-read\-replica](https://docs.aws.amazon.com/cli/latest/reference/rds/create-db-instance-read-replica.html) AWS CLI command\. -+ You can't create cross\-Region RDS Custom for Oracle replicas\. -+ You can't change the value of the Oracle Data Guard `CommunicationTimeout` parameter\. This parameter is set to 15 seconds for RDS Custom for Oracle DB instances\. - -### Networking requirements and limitations for RDS Custom for Oracle replication - -Make sure that your network configuration supports RDS Custom for Oracle replicas\. Consider the following: -+ Make sure to enable port 1140 for both inbound and outbound communication within your virtual private cloud \(VPC\) for the primary DB instance and all of its replicas\. This is required for Oracle Data Guard communication between read replicas\. -+ RDS Custom for Oracle validates the network while creating a Oracle replica\. If the primary DB instance and the new replica can't connect over the network, RDS Custom for Oracle doesn't create the replica and places it in the `INCOMPATIBLE_NETWORK` state\. -+ For external Oracle replicas, such as those you create on Amazon EC2 or on\-premises, use another port and listener for Oracle Data Guard replication\. Trying to use port 1140 could cause conflicts with RDS Custom automation\. -+ The `/rdsdbdata/config/tnsnames.ora` file contains network service names mapped to listener protocol addresses\. Note the following requirements and recommendations: - + Entries in `tnsnames.ora` prefixed with `rds_custom_` are reserved for RDS Custom when handling Oracle replica operations\. - - When creating manual entries in `tnsnames.ora`, don't use this prefix\. - + In some cases, you might want to switch over or fail over manually, or use failover technologies such as Fast\-Start Failover \(FSFO\)\. If so, make sure to manually synchronize `tnsnames.ora` entries from the primary DB instance to all of the standby instances\. This recommendation applies to both Oracle replicas managed by RDS Custom and to external Oracle replicas\. - - RDS Custom automation updates `tnsnames.ora` entries on only the primary DB instance\. Make sure also to synchronize when you add or remove a Oracle replica\. - - If you don't synchronize the `tnsnames.ora` files and switch over or fail over manually, Oracle Data Guard on the primary DB instance might not be able to communicate with the Oracle replicas\. - -### External replica limitations for RDS Custom for Oracle - - RDS Custom for Oracle external replicas, which include on\-premises replicas, have the following limitations: -+ RDS Custom for Oracle doesn't detect instance role changes upon manual failover, such as FSFO, for external Oracle replicas\. - - RDS Custom for Oracle does detect changes for managed replicas\. The role change is noted in the event log\. You can also see the new state by using the [describe\-db\-instances](https://docs.aws.amazon.com/cli/latest/reference/rds/describe-db-instances.html) AWS CLI command\. -+ RDS Custom for Oracle doesn't detect high replication lag for external Oracle replicas\. - - RDS Custom for Oracle does detect lag for managed replicas\. High replication lag produces the `Replication has stopped` event\. You can also see the replication status by using the [describe\-db\-instances](https://docs.aws.amazon.com/cli/latest/reference/rds/describe-db-instances.html) AWS CLI command, but there might be a delay for it to be updated\. -+ RDS Custom for Oracle doesn't promote external Oracle replicas automatically if you delete your primary DB instance\. - - The automatic promotion feature is available only for managed Oracle replicas\. For information about promoting Oracle replicas manually, see the white paper [Enabling high availability with Data Guard on Amazon RDS Custom for Oracle](https://d1.awsstatic.com/whitepapers/enabling-high-availability-with-data-guard-on-amazon-rds-custom-for-oracle.pdf)\. - -### Replica promotion limitations for RDS Custom for Oracle - -Promoting RDS Custom for Oracle managed Oracle replicas is the same as promoting RDS managed replicas, with some differences\. Note the following limitations for RDS Custom for Oracle replicas: -+ You can't promote a replica while RDS Custom for Oracle is backing it up\. -+ You can't change the backup retention period to `0` when you promote your Oracle replica\. -+ You can't promote your replica when it isn't in a healthy state\. - - If you issue `delete-db-instance` on the primary DB instance, RDS Custom for Oracle validates that each managed Oracle replica is healthy and available for promotion\. A replica might be ineligible for promotion because automation is paused or it is outside the support perimeter\. In such cases, RDS Custom for Oracle publishes an event explaining the issue so that you can repair your Oracle replica manually\. - -### Replica promotion guidelines for RDS Custom for Oracle - -When promoting a replica, note the following guidelines: -+ Don't initiate a failover while RDS Custom for Oracle is promoting your replica\. Otherwise, the promotion workflow could become stuck\. -+ Don't switch over your primary DB instance while RDS Custom for Oracle is promoting your Oracle replica\. Otherwise, the promotion workflow could become stuck\. -+ Don't shut down your primary DB instance while RDS Custom for Oracle is promoting your Oracle replica\. Otherwise, the promotion workflow could become stuck\. -+ Don't try to restart replication with your newly promoted DB instance as a target\. After RDS Custom for Oracle promotes your Oracle replica, it becomes a standalone DB instance and no longer has the replica role\. - -For more information, see [Troubleshooting replica promotion for RDS Custom for Oracle](custom-troubleshooting.md#custom-troubleshooting-promote)\. - -## Promoting an RDS Custom for Oracle replica to a standalone DB instance - -Just as with RDS for Oracle, you can promote an RDS Custom for Oracle replica to a standalone DB instance\. When you promote a Oracle replica, RDS Custom for Oracle reboots the DB instance before it becomes available\. For more information about promoting Oracle replicas, see [Promoting a read replica to be a standalone DB instance](USER_ReadRepl.md#USER_ReadRepl.Promote)\. - -The following steps show the general process for promoting a Oracle replica to a DB instance: - -1. Stop any transactions from being written to the primary DB instance\. - -1. Wait for RDS Custom for Oracle to apply all updates to your Oracle replica\. - -1. Promote your Oracle replica by choosing the **Promote** option on the Amazon RDS console, the AWS CLI command [https://docs.aws.amazon.com/cli/latest/reference/rds/promote-read-replica.html](https://docs.aws.amazon.com/cli/latest/reference/rds/promote-read-replica.html), or the [https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_PromoteReadReplica.html](https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_PromoteReadReplica.html) Amazon RDS API operation\. - -Promoting a Oracle replica takes a few minutes to complete\. During the process, RDS Custom for Oracle stops replication and reboots your replica\. When the reboot completes, the Oracle replica is available as a standalone DB instance\. - -### Console - -**To promote an RDS Custom for Oracle replica to a standalone DB instance** - -1. Sign in to the AWS Management Console and open the Amazon RDS console at [https://console\.aws\.amazon\.com/rds/](https://console.aws.amazon.com/rds/)\. - -1. In the Amazon RDS console, choose **Databases**\. - - The **Databases** pane appears\. Each Oracle replica shows **Replica** in the **Role** column\. - -1. Choose the RDS Custom for Oracle replica that you want to promote\. - -1. For **Actions**, choose **Promote**\. - -1. On the **Promote Oracle replica** page, enter the backup retention period and the backup window for the newly promoted DB instance\. You can't set this value to **0**\. - -1. When the settings are as you want them, choose **Promote Oracle replica**\. - -### AWS CLI - -To promote your RDS Custom for Oracle replica to a standalone DB instance, use the AWS CLI [https://docs.aws.amazon.com/cli/latest/reference/rds/promote-read-replica.html](https://docs.aws.amazon.com/cli/latest/reference/rds/promote-read-replica.html) command\. - -**Example** -For Linux, macOS, or Unix: - -``` -aws rds promote-read-replica \ ---db-instance-identifier my-custom-read-replica \ ---backup-retention-period 2 \ ---preferred-backup-window 23:00-24:00 -``` -For Windows: - -``` -aws rds promote-read-replica ^ ---db-instance-identifier my-custom-read-replica ^ ---backup-retention-period 2 ^ ---preferred-backup-window 23:00-24:00 -``` - -### RDS API - -To promote your RDS Custom for Oracle replica to be a standalone DB instance, call the Amazon RDS API [https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_PromoteReadReplica.html](https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_PromoteReadReplica.html) operation with the required parameter `DBInstanceIdentifier`\. \ No newline at end of file diff --git a/doc_source/custom-security.md b/doc_source/custom-security.md deleted file mode 100644 index dcccd1f..0000000 --- a/doc_source/custom-security.md +++ /dev/null @@ -1,170 +0,0 @@ -# Security in Amazon RDS Custom - -Familiarize yourself with the security considerations for RDS Custom\. - -**Topics** -+ [How RDS Custom securely manages tasks on your behalf](#custom-security.security-tools) -+ [Securing your Amazon S3 bucket against the confused deputy problem](#custom-security.confused-deputy) -+ [Rotating RDS Custom for Oracle credentials for compliance programs](#custom-security.cred-rotation) - -## How RDS Custom securely manages tasks on your behalf - -RDS Custom uses the following tools and techniques to secure your DB instance: - -**AWSServiceRoleForRDSCustom service\-linked role** -A *service\-linked role* is predefined by the service and includes all permissions that the service needs to call other AWS services on your behalf\. For RDS Custom, `AWSServiceRoleForRDSCustom` is a service\-linked role that is defined according to the principle of least privilege\. RDS Custom uses the permissions in `AmazonRDSCustomServiceRolePolicy`, which is the policy attached to this role, to perform most provisioning and all off\-host management tasks\. For more information, see [AmazonRDSCustomServiceRolePolicy](https://docs.aws.amazon.com/aws-managed-policy/latest/reference/AmazonRDSCustomServiceRolePolicy.html)\. -When it performs tasks on the host, RDS Custom automation uses credentials from the service\-linked role to run commands using AWS Systems Manager\. You can audit the command history through the Systems Manager command history and AWS CloudTrail\. Systems Manager connects to your RDS Custom DB instance using your networking setup\. For more information, see [Step 3: Configure IAM and your Amazon VPC](custom-setup-orcl.md#custom-setup-orcl.iam-vpc)\. - -**Temporary IAM credentials** -When provisioning or deleting resources, RDS Custom sometimes uses temporary credentials derived from the credentials of the calling IAM principal\. These IAM credentials are restricted by the IAM policies attached to that principal and expire after the operation is completed\. To learn about the permissions required for IAM principals who use RDS Custom, see [Step 4: Grant required permissions to your IAM user or role](custom-setup-orcl.md#custom-setup-orcl.iam-user)\. - -**Amazon EC2 instance profile** -An EC2 instance profile is a container for an IAM role that you can use to pass role information to an EC2 instance\. An EC2 instance underlies an RDS Custom DB instance\. You provide an instance profile when you create an RDS Custom DB instance\. RDS Custom uses EC2 instance profile credentials when it performs host\-based management tasks such as backups\. For more information, see [Create your IAM role and instance profile manually](custom-setup-orcl.md#custom-setup-orcl.iam)\. - -**SSH key pair** -When RDS Custom creates the EC2 instance that underlies a DB instance, it creates an SSH key pair on your behalf\. The key uses the naming prefix `do-not-delete-rds-custom-ssh-privatekey-db-`\. AWS Secrets Manager stores this SSH private key as a secret in your AWS account\. Amazon RDS doesn't store, access, or use these credentials\. For more information, see [Amazon EC2 key pairs and Linux instances](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-key-pairs.html)\. - -## Securing your Amazon S3 bucket against the confused deputy problem - -When you create an Amazon RDS Custom for Oracle custom engine version \(CEV\) or an RDS Custom for SQL Server DB instance, RDS Custom creates an Amazon S3 bucket\. The S3 bucket stores files such as CEV artifacts, redo \(transaction\) logs, configuration items for the support perimeter, and AWS CloudTrail logs\. - -You can make these S3 buckets more secure by using the global condition context keys to prevent the *confused deputy problem*\. For more information, see [Preventing cross\-service confused deputy problems](cross-service-confused-deputy-prevention.md)\. - -The following RDS Custom for Oracle example shows the use of the `aws:SourceArn` and `aws:SourceAccount` global condition context keys in an S3 bucket policy\. For RDS Custom for Oracle, make sure to include the Amazon Resource Names \(ARNs\) for the CEVs and the DB instances\. For RDS Custom for SQL Server, make sure to include the ARN for the DB instances\. - -``` -... -{ - "Sid": "AWSRDSCustomForOracleInstancesObjectLevelAccess", - "Effect": "Allow", - "Principal": { - "Service": "custom.rds.amazonaws.com" - }, - "Action": [ - "s3:GetObject", - "s3:GetObjectVersion", - "s3:DeleteObject", - "s3:DeleteObjectVersion", - "s3:GetObjectRetention", - "s3:BypassGovernanceRetention" - ], - "Resource": "arn:aws:s3:::do-not-delete-rds-custom-123456789012-us-east-2-c8a6f7/RDSCustomForOracle/Instances/*", - "Condition": { - "ArnLike": { - "aws:SourceArn": [ - "arn:aws:rds:us-east-2:123456789012:db:*", - "arn:aws:rds:us-east-2:123456789012:cev:*/*" - ] - }, - "StringEquals": { - "aws:SourceAccount": "123456789012" - } - } -}, -... -``` - -## Rotating RDS Custom for Oracle credentials for compliance programs - -Some compliance programs require database user credentials to change periodically, for example, every 90 days\. RDS Custom for Oracle automatically rotates credentials for some predefined database users\. - -**Topics** -+ [Automatic rotation of credentials for predefined users](#custom-security.cred-rotation.auto) -+ [Guidelines for rotating user credentials](#custom-security.cred-rotation.guidelines) -+ [Rotating user credentials manually](#custom-security.cred-rotation.manual) - -### Automatic rotation of credentials for predefined users - -If your RDS Custom for Oracle DB instance is hosted in Amazon RDS, credentials for the following predefined Oracle users rotate every 30 days automatically\. Credentials for the preceding users reside in AWS Secrets Manager\. - - -**Predefined Oracle users** - -| Database user | Created by | Supported engine versions | Notes | -| --- | --- | --- | --- | -| SYS | Oracle | custom\-oracle\-ee and custom\-oracle\-ee\-cdb | | -| SYSTEM | Oracle | custom\-oracle\-ee and custom\-oracle\-ee\-cdb | | -| RDSADMIN | RDS | custom\-oracle\-ee | | -| C\#\#RDSADMIN | RDS | custom\-oracle\-ee\-cdb | Usernames with a C\#\# prefix exist only in CDBs\. For more information about CDBs, see [Overview of Amazon RDS Custom for Oracle architecture](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/custom-creating.html#custom-creating.overview)\. | -| RDS\_DATAGUARD | RDS | custom\-oracle\-ee | This user exists only in read replicas, source databases for read replicas, and databases that you have physically migrated into RDS Custom using Oracle Data Guard\. | -| C\#\#RDS\_DATAGUARD | RDS | custom\-oracle\-ee\-cdb | This user exists only in read replicas, source databases for read replicas, and databases that you have physically migrated into RDS Custom using Oracle Data Guard\. Usernames with a C\#\# prefix exist only in CDBs\. For more information about CDBs, see [Overview of Amazon RDS Custom for Oracle architecture](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/custom-creating.html#custom-creating.overview)\. | - -An exception to the automatic credential rotation is an RDS Custom for Oracle DB instance that you have manually configured as a standby database\. RDS only rotates credentials for read replicas that you have created using the `create-db-instance-read-replica` CLI command or `CreateDBInstanceReadReplica` API\. - -### Guidelines for rotating user credentials - -To make sure that your credentials rotate according to your compliance program, note the following guidelines: -+ If your DB instance rotates credentials automatically, don't manually change or delete a secret, password file, or password for users listed in [Predefined Oracle users](#auto-rotation)\. Otherwise, RDS Custom might place your DB instance outside of the support perimeter, which suspends automatic rotation\. -+ The RDS master user is not predefined, so you are responsible for either changing the password manually or setting up automatic rotation in Secrets Manager\. For more information, see [Rotate AWS Secrets Manager secrets](https://docs.aws.amazon.com/secretsmanager/latest/userguide/rotating-secrets.html)\. - -### Rotating user credentials manually - -For the following categories of databases, RDS doesn't automatically rotate the credentials for the users listed in [Predefined Oracle users](#auto-rotation): -+ A database that you configured manually to function as a standby database\. -+ An on\-premises database\. -+ A DB instance that is outside of the support perimeter or in a state in which the RDS Custom automation can't run\. In this case, RDS Custom also doesn't rotate keys\. - -If your database is in any of the preceding categories, you must rotate your user credentials manually\. - -**To rotate user credentials manually for a DB instance** - -1. Sign in to the AWS Management Console and open the Amazon RDS console at [https://console\.aws\.amazon\.com/rds/](https://console.aws.amazon.com/rds/)\. - -1. In **Databases**, make sure that RDS isn't currently backing up your DB instance or performing operations such configuring high availability\. - -1. In the database details page, choose **Configuration** and note the Resource ID for the DB instance\. Or you can use the AWS CLI command `describe-db-instances`\. - -1. Open the Secrets Manager console at [https://console\.aws\.amazon\.com/secretsmanager/](https://console.aws.amazon.com/secretsmanager/)\. - -1. In the search box, enter your DB Resource ID and find the secret in the following form: - - ``` - do-not-delete-rds-custom-db-resource-id-numeric-string - ``` - - This secret stores the password for `RDSADMIN`, `SYS`, and `SYSTEM`\. The following sample key is for the DB instance with the DB resource ID `db-ABCDEFG12HIJKLNMNOPQRS3TUVWX`: - - ``` - do-not-delete-rds-custom-db-ABCDEFG12HIJKLNMNOPQRS3TUVWX-123456 - ``` -**Important** -If your DB instance is a read replica and uses the `custom-oracle-ee-cdb` engine, two secrets exist with the suffix `db-resource-id-numeric-string`, one for the master user and the other for `RDSADMIN`, `SYS`, and `SYSTEM`\. To find the correct secret, run the following command on the host: - - ``` - cat /opt/aws/rdscustomagent/config/database_metadata.json | python3 -c "import sys,json; print(json.load(sys.stdin)['dbMonitoringUserPassword'])" - ``` -The `dbMonitoringUserPassword` attribute indicates the secret for `RDSADMIN`, `SYS`, and `SYSTEM`\. - -1. If your DB instance exists in an Oracle Data Guard configuration, find the secret in the following form: - - ``` - do-not-delete-rds-custom-db-resource-id-numeric-string-dg - ``` - - This secret stores the password for `RDS_DATAGUARD`\. The following sample key is for the DB instance with the DB resource ID `db-ABCDEFG12HIJKLNMNOPQRS3TUVWX`: - - ``` - do-not-delete-rds-custom-db-ABCDEFG12HIJKLNMNOPQRS3TUVWX-789012-dg - ``` - -1. For all database users listed in [Predefined Oracle users](#auto-rotation), update the passwords by following the instructions in [Modify an AWS Secrets Manager secret](https://docs.aws.amazon.com/secretsmanager/latest/userguide/manage_update-secret.html)\. - -1. If your database is a standalone database or a source database in an Oracle Data Guard configuration: - - 1. Start your Oracle SQL client and log in as `SYS`\. - - 1. Run a SQL statement in the following form for each database user listed in [Predefined Oracle users](#auto-rotation): - - ``` - ALTER USER user-name IDENTIFIED BY pwd-from-secrets-manager ACCOUNT UNLOCK; - ``` - - For example, if the new password for `RDSADMIN` stored in Secrets Manager is `pwd-123`, run the following statement: - - ``` - ALTER USER RDSADMIN IDENTIFIED BY pwd-123 ACCOUNT UNLOCK; - ``` - -1. If your DB instance runs Oracle Database 12c Release 1 \(12\.1\) and is managed by Oracle Data Guard, manually copy the password file \(`orapw`\) from the primary DB instance to each standby DB instance\. - - If your DB instance is hosted in Amazon RDS, the password file location is `/rdsdbdata/config/orapw`\. For databases that aren't hosted in Amazon RDS, the default location is `$ORACLE_HOME/dbs/orapw$ORACLE_SID` on Linux and UNIX and `%ORACLE_HOME%\database\PWD%ORACLE_SID%.ora` on Windows\. \ No newline at end of file diff --git a/doc_source/custom-setup-orcl.md b/doc_source/custom-setup-orcl.md deleted file mode 100644 index dd6b72d..0000000 --- a/doc_source/custom-setup-orcl.md +++ /dev/null @@ -1,646 +0,0 @@ -# Setting up your environment for Amazon RDS Custom for Oracle - -Before you create an Amazon RDS Custom for Oracle DB instance, perform the following tasks\. - -**Topics** -+ [Prerequisites for creating an RDS Custom for Oracle DB instance](#custom-setup-orcl.review) -+ [Step 1: Create or reuse a symmetric encryption AWS KMS key](#custom-setup-orcl.cmk) -+ [Step 2: Download and install the AWS CLI](#custom-setup-orcl.cli) -+ [Step 3: Configure IAM and your Amazon VPC](#custom-setup-orcl.iam-vpc) -+ [Step 4: Grant required permissions to your IAM user or role](#custom-setup-orcl.iam-user) - -## Prerequisites for creating an RDS Custom for Oracle DB instance - -Before creating an RDS Custom for Oracle DB instance, make sure that you meet the following prerequisites: -+ You have access to [My Oracle Support](https://support.oracle.com/portal/) and [Oracle Software Delivery Cloud](https://edelivery.oracle.com/osdc/faces/Home.jspx) to download the supported list of installation files and patches for the Enterprise Edition of any of the following Oracle Database releases: - + Oracle Database 19c - + Oracle Database 18c - + Oracle Database 12c Release 2 \(12\.2\) - + Oracle Database 12c Release 1 \(12\.1\) - - If you use an unknown patch, custom engine version \(CEV\) creation fails\. In this case, contact the RDS Custom support team and ask it to add the missing patch\. - - For more information, see [Step 2: Download your database installation files and patches from Oracle Software Delivery Cloud](custom-cev.preparing.md#custom-cev.preparing.download)\. -+ You have access to Amazon S3\. This service is required for the following reasons: - + You upload your Oracle installation files to S3 buckets\. You use the uploaded installation files to create your RDS Custom CEV\. - + RDS Custom for Oracle uses scripts downloaded from internally defined S3 buckets to perform actions on your DB instances\. These scripts are necessary for onboarding and RDS Custom automation\. - + RDS Custom for Oracle uploads certain files to S3 buckets located in your customer account\. These buckets use the following naming format: `do-not-delete-rds-custom-`*account\_id*\-*region*\-*six\_character\_alphanumeric\_string*\. For example, you might have a bucket named `do-not-delete-rds-custom-123456789012-us-east-1-12a3b4`\. - - For more information, see [Step 3: Upload your installation files to Amazon S3](custom-cev.preparing.md#custom-cev.preparing.s3) and [Creating a CEV](custom-cev.create.md)\. -+ You supply your own virtual private cloud \(VPC\) and security group configuration\. For more information, see [Step 3: Configure IAM and your Amazon VPC](#custom-setup-orcl.iam-vpc)\. -+ The AWS Identity and Access Management \(IAM\) user that creates a CEV or RDS Custom DB instance has the required permissions for IAM, CloudTrail, and Amazon S3\. - - For more information, see [Step 4: Grant required permissions to your IAM user or role](#custom-setup-orcl.iam-user)\. - -For each task, the following sections describe the requirements and limitations specific to the task\. For example, when you create your RDS Custom DB for Oracle instance, use either the db\.m5 or db\.r5 instance classes running Oracle Linux 7 Update 9\. For general requirements that apply to RDS Custom, see [RDS Custom for Oracle requirements and limitations](custom-reqs-limits.md)\. - -## Step 1: Create or reuse a symmetric encryption AWS KMS key - -*Customer managed keys* are AWS KMS keys in your AWS account that you create, own, and manage\. A customer managed symmetric encryption KMS key is required for RDS Custom\. When you create an RDS Custom for Oracle DB instance, you supply the KMS key identifier\. For more information, see [Configuring a DB instance for Amazon RDS Custom for Oracle](custom-creating.md)\. - -You have the following options: -+ If you have an existing customer managed KMS key in your AWS account, you can use it with RDS Custom\. No further action is necessary\. -+ If you already created a customer managed symmetric encryption KMS key for a different RDS Custom engine, you can reuse the same KMS key\. No further action is necessary\. -+ If you don't have an existing customer managed symmetric encryption KMS key in your account, create a KMS key by following the instructions in [Creating keys](https://docs.aws.amazon.com/kms/latest/developerguide/create-keys.html#create-symmetric-cmk) in the *AWS Key Management Service Developer Guide*\. -+ If you're creating a CEV or RDS Custom DB instance, and your KMS key is in a different AWS account, make sure to use the AWS CLI\. You can't use the AWS console with cross\-account KMS keys\. - -**Important** -RDS Custom doesn't support AWS managed KMS keys\. - -Make sure that your symmetric encryption key grants access to the `kms:Decrypt` and `kms:GenerateDataKey` operations to the AWS Identity and Access Management \(IAM\) role in your IAM instance profile\. If you have a new symmetric encryption key in your account, no changes are required\. Otherwise, make sure that your symmetric encryption key's policy grants access to these operations\. - -For more information, see [Step 3: Configure IAM and your Amazon VPC](#custom-setup-orcl.iam-vpc)\. - -For more information about configuring IAM for RDS Custom for Oracle, see [Step 3: Configure IAM and your Amazon VPC](#custom-setup-orcl.iam-vpc)\. - -## Step 2: Download and install the AWS CLI - -AWS provides you with a command\-line interface to use RDS Custom features\. You can use either version 1 or version 2 of the AWS CLI\. - -For information about downloading and installing the AWS CLI, see [Installing or updating the latest version of the AWS CLI](https://docs.aws.amazon.com/cli/latest/userguide/getting-started-install.html)\. - -Skip this step if either of the following is true: -+ You plan to access RDS Custom only from the AWS Management Console\. -+ You have already downloaded the AWS CLI for Amazon RDS or a different RDS Custom DB engine\. - -## Step 3: Configure IAM and your Amazon VPC - -You use an IAM role or IAM user \(known as an IAM entity\) to create an RDS Custom DB instance using the console or AWS CLI\. This IAM entity must have the necessary permissions for instance creation\. - -Your RDS Custom DB instance is in a virtual private cloud \(VPC\) based on the Amazon VPC service, just like an Amazon EC2 instance or Amazon RDS instance\. You provide and configure your own VPC\. Thus, you have full control over your instance networking setup\. - -You can configure your IAM identity and virtual private cloud \(VPC\) using either of the following techniques: -+ [Configure IAM and your VPC using AWS CloudFormation](#custom-setup-orcl.cf) \(recommended\) -+ Follow the procedures in [Create your IAM role and instance profile manually](#custom-setup-orcl.iam) and [Configure your VPC manually](#custom-setup-orcl.vpc) - -We strongly recommend that you configure your RDS Custom for Oracle environment using AWS CloudFormation\. This technique is the easiest and least error\-prone\. - -### Configure IAM and your VPC using AWS CloudFormation - -A CloudFormation stack is a collection of AWS resources that you can manage as a single unit\. To simplify RDS Custom configuration, you can use the AWS CloudFormation template files to create CloudFormation stacks\. For more information, see [Creating a stack on the AWS CloudFormation console](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/cfn-console-create-stack.html) in *AWS CloudFormation User Guide*\. - -**Topics** -+ [IAM and VPC resources created by CloudFormation](#custom-setup-orcl.cf.resources) -+ [Step 1: Download the CloudFormation template files](#custom-setup-orcl.cf.dl-templates) -+ [Step 2: Configure IAM using CloudFormation](#custom-setup-orcl.cf.config-iam) -+ [Step 3: Configure your VPC using CloudFormation](#custom-setup-orcl.cf.config-vpc) - -#### IAM and VPC resources created by CloudFormation - -When you use the CloudFormation templates, they create stacks that includes the following resources in your AWS account: -+ An Amazon EC2 instance profile named `AWSRDSCustomInstanceProfile-region` -+ An IAM role named `AWSRDSCustomInstanceRole-region` -+ A DB subnet group named `rds-custom-private` -+ The following VPC endpoints, which are necessary for your DB instance to communicate with dependent AWS services: - + `com.amazonaws.region.ec2messages` - + `com.amazonaws.region.events` - + `com.amazonaws.region.logs` - + `com.amazonaws.region.monitoring` - + `com.amazonaws.region.s3` - + `com.amazonaws.region.secretsmanager` - + `com.amazonaws.region.ssm` - + `com.amazonaws.region.ssmmessages` - -Unlike RDS Custom for SQL Server, RDS Custom for Oracle doesn't create an access control list or security groups\. You must attach you own security group, subnets, and route tables\. - -#### Step 1: Download the CloudFormation template files - -A CloudFormation template is a declaration of the AWS resources that make up a stack\. The template is stored as a JSON file\. - -**To download the CloudFormation template files** - -1. Open the context \(right\-click\) menu for the link [ custom\-oracle\-iam\.zip](samples/custom-oracle-iam.zip) and choose **Save Link As**\. - -1. Save the file to your computer\. - -1. Repeat the previous steps for the link [custom\-vpc\.zip](samples/custom-vpc.zip)\. - - If you already configured your VPC for RDS Custom, skip this step\. - -#### Step 2: Configure IAM using CloudFormation - -When you use the CloudFormation template for IAM, it creates the following required resources: -+ An instance profile named AWSRDSCustomInstanceProfile\-*region* -+ A service role named AWSRDSCustomInstanceRole\-*region* -+ An access policy named AWSRDSCustomIamRolePolicy that is attached to the service role - -**To configure IAM using CloudFormation** - -1. Open the CloudFormation console at [https://console\.aws\.amazon\.com/cloudformation](https://console.aws.amazon.com/cloudformation/)\. - -1. Start the Create Stack wizard, and choose **Create Stack**\. - -1. On the **Create stack** page, do the following: - - 1. For **Prepare template**, choose **Template is ready**\. - - 1. For **Template source**, choose **Upload a template file**\. - - 1. For **Choose file**, navigate to, then choose **custom\-oracle\-iam\.json**\. - - 1. Choose **Next**\. - -1. On the **Specify stack details** page, do the following: - - 1. For **Stack name**, enter **custom\-oracle\-iam**\. - - 1. Choose **Next**\. - -1. On the **Configure stack options page**, choose **Next**\. - -1. On the **Review custom\-oracle\-iam** page, do the following: - - 1. Select the ****I acknowledge that AWS CloudFormation might create IAM resources with custom names**** check box\. - - 1. Choose **Submit**\. - - CloudFormation creates the IAM roles that RDS Custom for Oracle requires\. In the left panel, when **custom\-oracle\-iam** shows **CREATE\_COMPLETE**, proceed to the next step\. - -1. In the left panel, choose **custom\-oracle\-iam**\. In the right panel, do the following: - - 1. Choose **Stack info**\. Your stack has an ID in the format **arn:aws:cloudformation:*region*:*account\-no*:stack/custom\-oracle\-iam/*identifier***\. - - 1. Choose **Resources**\. You should see the following: - + An instance profile named **AWSRDSCustomInstanceProfile\-*region*** - + A service role named **AWSRDSCustomInstanceRole\-*region*** - - When you create your RDS Custom DB instance, you need to supply the instance profile ID\. - -#### Step 3: Configure your VPC using CloudFormation - -If you've already configured your VPC for a different RDS Custom engine, and want to reuse the existing VPC, skip this step\. This section assumes that the following: -+ You've already used CloudFormation to create your IAM instance profile and role\. -+ You know your route table ID\. - - For a DB instance to be private, it must be in a private subnet\. For a subnet to be private, it must not be associated with a route table that has a default internet gateway\. For more information, see [Configure route tables](https://docs.aws.amazon.com/vpc/latest/userguide/VPC_Route_Tables.html) in the *Amazon VPC User Guide*\. - -When you use the CloudFormation template for your VPC, it creates the following required resources: -+ A private VPC -+ A subnet group named rds\-custom\-private -+ VPC endpoints that use the naming format vpce\-*string* - -**To configure your VPC using CloudFormation** - -1. Open the CloudFormation console at [https://console\.aws\.amazon\.com/cloudformation](https://console.aws.amazon.com/cloudformation/)\. - -1. Start the Create Stack wizard, and choose **Create Stack** and then **With new resources \(standard\)**\. - -1. On the **Create stack** page, do the following: - - 1. For **Prepare template**, choose **Template is ready**\. - - 1. For **Template source**, choose **Upload a template file**\. - - 1. For **Choose file**, navigate to, then choose `custom-vpc.json`\. - - 1. Choose **Next**\. - -1. On the **Specify stack details** page, do the following: - - 1. For **Stack name**, enter **custom\-vpc**\. - - 1. For **Parameters**, choose the private subnets to use for RDS Custom DB instances\. - - 1. Choose the private VPC ID to use for RDS Custom DB instances\. - - 1. Enter the route table associated with the private subnets\. - - 1. Choose **Next**\. - -1. On the **Configure stack options page**, choose **Next**\. - -1. On the **Review custom\-vpc** page, choose **Submit**\. - - CloudFormation configures your private VPC\. In the left panel, when **custom\-vpc** shows **CREATE\_COMPLETE**, proceed to the next step\. - -1. \(Optional\) Review the details of your VPC\. In the **Stacks** pane, choose **custom\-vpc**\. In the right pane, do the following: - - 1. Choose **Stack info**\. Your stack has an ID in the format **arn:aws:cloudformation:*region*:*account\-no*:stack/custom\-vpc/*identifier***\. - - 1. Choose **Resources**\. You should see a subnet group named **rds\-custom\-private** and several VPC endpoints that use the naming format **vpce\-*string***\. Each endpoint corresponds to an AWS service that RDS Custom needs to communicate with\. - - 1. Choose **Parameters**\. You should see the private subnets, private VPC, and the route table that you specified when you created the stack\. When you create a DB instance, you need to supply the VPC ID and subnet group\. - -### Create your IAM role and instance profile manually - -Configuration is easiest when you use CloudFormation\. However, you can also configure IAM manually\. For manual setup, you create the following resources: -+ An IAM instance profile named `AWSRDSCustomInstanceProfile-region`, where *region* is the AWS Region where you plan to deploy your DB instances\. -+ An IAM role `AWSRDSCustomInstanceRole-region` for the instance profile\. - -The following steps show how to create the instance profile and role and then add the role to your profile\. - -**To create the RDS Custom instance profile and add the necessary role to it** - -1. Create the IAM role that uses the naming format `AWSRDSCustomInstanceRole-region` with a trust policy that Amazon EC2 can use to assume this role\. - -1. Add an access policy to `AWSRDSCustomInstanceRole-region`\. - -1. Create an IAM instance profile for RDS Custom that uses the naming format `AWSRDSCustomInstanceProfile-region`\. - -1. Add the `AWSRDSCustomInstanceRole-region` IAM role to the instance profile\. - -#### Step 1: Create the role AWSRDSCustomInstanceRoleForRdsCustomInstance - -In this step, you create the role using the naming format `AWSRDSCustomInstanceRole-region`\. Using the trust policy, Amazon EC2 can assume the role\. The following example assumes that you have set the environment variable `$REGION` to the AWS Region in which you want to create your DB instance\. - -``` -aws iam create-role \ - --role-name AWSRDSCustomInstanceRole-$REGION \ - --assume-role-policy-document '{ - "Version": "2012-10-17", - "Statement": [ - { - "Action": "sts:AssumeRole", - "Effect": "Allow", - "Principal": { - "Service": "ec2.amazonaws.com" - } - } - ] - }' -``` - -#### Step 2: Add an access policy to AWSRDSCustomInstanceRoleForRdsCustomInstance - -When you embed an inline policy in an IAM role, the inline policy is used as part of the role's access \(permissions\) policy\. You create the `AWSRDSCustomIamRolePolicy` policy that permits Amazon EC2 to send and receive messages and perform various actions\. - -The following example creates the access policy named `AWSRDSCustomIamRolePolicy`, and adds it to the IAM role `AWSRDSCustomInstanceRole-region`\. This example assumes that you have set the following environment variables: - -`$REGION` -Set this variable to the AWS Region in which you plan to create your DB instance\. - -`$ACCOUNT_ID` -Set this variable to your AWS account number\. - -`$KMS_KEY` -Set this variable to the Amazon Resource Name \(ARN\) of the AWS KMS key that you want to use for your RDS Custom DB instances\. To specify more than one KMS key, add it to the `Resources` section of statement ID \(Sid\) 11\. - -``` -aws iam put-role-policy \ - --role-name AWSRDSCustomInstanceRole-$REGION \ - --policy-name AWSRDSCustomIamRolePolicy \ - --policy-document '{ - "Version": "2012-10-17", - "Statement": [ - { - "Sid": "1", - "Effect": "Allow", - "Action": [ - "ssm:DescribeAssociation", - "ssm:GetDeployablePatchSnapshotForInstance", - "ssm:GetDocument", - "ssm:DescribeDocument", - "ssm:GetManifest", - "ssm:GetParameter", - "ssm:GetParameters", - "ssm:ListAssociations", - "ssm:ListInstanceAssociations", - "ssm:PutInventory", - "ssm:PutComplianceItems", - "ssm:PutConfigurePackageResult", - "ssm:UpdateAssociationStatus", - "ssm:UpdateInstanceAssociationStatus", - "ssm:UpdateInstanceInformation", - "ssm:GetConnectionStatus", - "ssm:DescribeInstanceInformation", - "ssmmessages:CreateControlChannel", - "ssmmessages:CreateDataChannel", - "ssmmessages:OpenControlChannel", - "ssmmessages:OpenDataChannel" - ], - "Resource": [ - "*" - ] - }, - { - "Sid": "2", - "Effect": "Allow", - "Action": [ - "ec2messages:AcknowledgeMessage", - "ec2messages:DeleteMessage", - "ec2messages:FailMessage", - "ec2messages:GetEndpoint", - "ec2messages:GetMessages", - "ec2messages:SendReply" - ], - "Resource": [ - "*" - ] - }, - { - "Sid": "3", - "Effect": "Allow", - "Action": [ - "logs:PutRetentionPolicy", - "logs:PutLogEvents", - "logs:DescribeLogStreams", - "logs:DescribeLogGroups", - "logs:CreateLogStream", - "logs:CreateLogGroup" - ], - "Resource": [ - "arn:aws:logs:'$REGION':*:log-group:rds-custom-instance*" - ] - }, - { - "Sid": "4", - "Effect": "Allow", - "Action": [ - "s3:putObject", - "s3:getObject", - "s3:getObjectVersion" - ], - "Resource": [ - "arn:aws:s3:::do-not-delete-rds-custom-*/*" - ] - }, - { - "Sid": "5", - "Effect": "Allow", - "Action": [ - "cloudwatch:PutMetricData" - ], - "Resource": [ - "*" - ], - "Condition": { - "StringEquals": { - "cloudwatch:namespace": [ - "RDSCustomForOracle/Agent" - ] - } - } - }, - { - "Sid": "6", - "Effect": "Allow", - "Action": [ - "events:PutEvents" - ], - "Resource": [ - "*" - ] - }, - { - "Sid": "7", - "Effect": "Allow", - "Action": [ - "secretsmanager:GetSecretValue", - "secretsmanager:DescribeSecret" - ], - "Resource": [ - "arn:aws:secretsmanager:'$REGION':'$ACCOUNT_ID':secret:do-not-delete-rds-custom-*" - ] - }, - { - "Sid": "8", - "Effect": "Allow", - "Action": [ - "s3:ListBucketVersions" - ], - "Resource": [ - "arn:aws:s3:::do-not-delete-rds-custom-*" - ] - }, - { - "Sid": "9", - "Effect": "Allow", - "Action": "ec2:CreateSnapshots", - "Resource": [ - "arn:aws:ec2:*:*:instance/*", - "arn:aws:ec2:*:*:volume/*" - ], - "Condition": { - "StringEquals": { - "ec2:ResourceTag/AWSRDSCustom": "custom-oracle" - } - } - }, - { - "Sid": "10", - "Effect": "Allow", - "Action": "ec2:CreateSnapshots", - "Resource": [ - "arn:aws:ec2:*::snapshot/*" - ] - }, - { - "Sid": "11", - "Effect": "Allow", - "Action": [ - "kms:Decrypt", - "kms:GenerateDataKey" - ], - "Resource": [ - "arn:aws:kms:'$REGION':'$ACCOUNT_ID':key/'$KMS_KEY'" - ] - }, - { - "Sid": "12", - "Effect": "Allow", - "Action": "ec2:CreateTags", - "Resource": "*", - "Condition": { - "StringLike": { - "ec2:CreateAction": [ - "CreateSnapshots" - ] - } - } - } - ] -}' -``` - -#### Step 3: Create your RDS Custom instance profile - -An instance profile is a container that includes a single IAM role\. RDS Custom uses the instance profile to pass the role to the instance\. - -If you use the CLI to create a role, you create the role and instance profile as separate actions, with potentially different names\. Create your IAM instance profile as follows, naming it using the format `AWSRDSCustomInstanceProfile-region`\. The following example assumes that you have set the environment variable `$REGION` to the AWS Region in which you want to create your DB instance\. - -``` -aws iam create-instance-profile \ - --instance-profile-name AWSRDSCustomInstanceProfile-$REGION -``` - -#### Step 4: Add AWSRDSCustomInstanceRoleForRdsCustomInstance to your RDS Custom instance profile - -Add your IAM role to the instance profile that you previously created\. The following example assumes that you have set the environment variable `$REGION` to the AWS Region in which you want to create your DB instance\. - -``` -aws iam add-role-to-instance-profile \ - --instance-profile-name AWSRDSCustomInstanceProfile-$REGION \ - --role-name AWSRDSCustomInstanceRole-$REGION -``` - -### Configure your VPC manually - -If you don't want to use AWS CloudFormation, you can configure your VPC endpoints manually\. - -**Topics** -+ [Create VPC endpoints for dependent AWS services](#custom-setup-orcl.vpc.endpoints) -+ [Configure the instance metadata service](#custom-setup-orcl.vpc.imds) - -#### Create VPC endpoints for dependent AWS services - -RDS Custom sends communication from your DB instance to other AWS services\. To make sure that RDS Custom can communicate, it validates network connectivity to the following AWS services: -+ Amazon CloudWatch -+ Amazon CloudWatch Logs -+ Amazon CloudWatch Events -+ Amazon EC2 -+ Amazon EventBridge -+ Amazon S3 -+ AWS Secrets Manager -+ AWS Systems Manager - -If RDS Custom can't communicate with the necessary services, it publishes the following event: - -``` -Database instance in incompatible-network. SSM Agent connection not available. Amazon RDS can't connect to the dependent AWS services. -``` - -To avoid `incompatible-network` errors, make sure that VPC components involved in communication between your RDS Custom DB instance and AWS services satisfy the following requirements: -+ The DB instance can make outbound connections on port 443 to other AWS services\. -+ The VPC allows incoming responses to requests originating from your RDS Custom DB instance\. -+ RDS Custom can correctly resolve the domain names of endpoints for each AWS service\. - -RDS Custom relies on AWS Systems Manager connectivity for its automation\. For information about how to configure VPC endpoints, see [Creating VPC endpoints for Systems Manager](https://docs.aws.amazon.com/systems-manager/latest/userguide/setup-create-vpc.html#sysman-setting-up-vpc-create)\. For the list of endpoints in each Region, see [AWS Systems Manager endpoints and quotas](https://docs.aws.amazon.com/general/latest/gr/ssm.html) in the *Amazon Web Services General Reference*\. - -If you already configured a VPC for a different RDS Custom DB engine, you can reuse that VPC and skip this process\. - -#### Configure the instance metadata service - -Make sure that your instance can do the following: -+ Access the instance metadata service using Instance Metadata Service Version 2 \(IMDSv2\)\. -+ Allow outbound communications through port 80 \(HTTP\) to the IMDS link IP address\. -+ Request instance metadata from `http://169.254.169.254`, the IMDSv2 link\. - -For more information, see [Use IMDSv2](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/configuring-instance-metadata-service.html) in the *Amazon EC2 User Guide for Linux Instances*\. - -RDS Custom for Oracle automation uses IMDSv2 by default, by setting `HttpTokens=enabled` on the underlying Amazon EC2 instance\. However, you can use IMDSv1 if you want\. For more information, see [Configure the instance metadata options](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/configuring-instance-metadata-options.html) in the *Amazon EC2 User Guide for Linux Instances*\. - -## Step 4: Grant required permissions to your IAM user or role - -Make sure that the IAM user or role that creates the CEV or RDS Custom DB instance has either of the following policies: -+ The `AdministratorAccess` policy -+ The `AmazonRDSFullAccess` policy with required permissions for Amazon S3 and AWS KMS \(required for both CEV and DB creation\), CEV creation, and DB instance creation\. - -**Topics** -+ [IAM permissions required for Amazon S3 and AWS KMS](#custom-setup-orcl.s3-kms) -+ [IAM permissions required for creating a CEV](#custom-setup-orcl.cev) -+ [IAM permissions required for creating a DB instance from a CEV](#custom-setup-orcl.db) - -### IAM permissions required for Amazon S3 and AWS KMS - -To create CEVs or RDS Custom for Oracle DB instances, the IAM identity needs to access Amazon S3 and AWS KMS\. The following sample JSON policy grants the required permissions\. - -``` -{ - "Version": "2012-10-17", - "Statement": [ - { - "Sid": "CreateS3Bucket", - "Effect": "Allow", - "Action": [ - "s3:CreateBucket", - "s3:PutBucketPolicy", - "s3:PutBucketObjectLockConfiguration", - "s3:PutBucketVersioning" - ], - "Resource": "arn:aws:s3:::do-not-delete-rds-custom-*" - }, - { - "Sid": "CreateKmsGrant", - "Effect": "Allow", - "Action": [ - "kms:CreateGrant", - "kms:DescribeKey" - ], - "Resource": "*" - } - ] -} -``` - -For more information about the `kms:CreateGrant` permission, see [AWS KMS key management](Overview.Encryption.Keys.md)\. - -### IAM permissions required for creating a CEV - -To create a CEV, the IAM identity needs the following additional permissions: - -``` -s3:GetObjectAcl -s3:GetObject -s3:GetObjectTagging -s3:ListBucket -mediaimport:CreateDatabaseBinarySnapshot -``` - -The following sample JSON policy grants the additional permissions necessary to access bucket *my\-custom\-installation\-files* and its contents\. - -``` -{ - "Version": "2012-10-17", - "Statement": [ - { - "Sid": "AccessToS3MediaBucket", - "Effect": "Allow", - "Action": [ - "s3:GetObjectAcl", - "s3:GetObject", - "s3:GetObjectTagging", - "s3:ListBucket" - ], - "Resource": [ - "arn:aws:s3:::my-custom-installation-files", - "arn:aws:s3:::my-custom-installation-files/*" - ] - }, - { - "Sid": "PermissionForByom", - "Effect": "Allow", - "Action": [ - "mediaimport:CreateDatabaseBinarySnapshot" - ], - "Resource": "*" - } - ] -} -``` - -You can grant similar permissions for Amazon S3 to caller accounts using an S3 bucket policy\. - -### IAM permissions required for creating a DB instance from a CEV - -To create an RDS Custom for Oracle DB instance from an existing CEV, the IAM entity needs the following additional permissions\. - -``` -iam:SimulatePrincipalPolicy -cloudtrail:CreateTrail -cloudtrail:StartLogging -``` - -The following sample JSON policy grants the permissions necessary to validate an IAM role and log information to an AWS CloudTrail\. - -``` -{ - "Version": "2012-10-17", - "Statement": [ - { - "Sid": "ValidateIamRole", - "Effect": "Allow", - "Action": "iam:SimulatePrincipalPolicy", - "Resource": "*" - }, - { - "Sid": "CreateCloudTrail", - "Effect": "Allow", - "Action": [ - "cloudtrail:CreateTrail", - "cloudtrail:StartLogging" - ], - "Resource": "arn:aws:cloudtrail:*:*:trail/do-not-delete-rds-custom-*" - } - ] -} -``` \ No newline at end of file diff --git a/doc_source/custom-setup-sqlserver.md b/doc_source/custom-setup-sqlserver.md deleted file mode 100644 index 16f326e..0000000 --- a/doc_source/custom-setup-sqlserver.md +++ /dev/null @@ -1,679 +0,0 @@ -# Setting up your environment for Amazon RDS Custom for SQL Server - -Before you create and manage a DB instance for Amazon RDS Custom for SQL Server DB instance, make sure to perform the following tasks\. - -**Contents** -+ [Prerequisites for setting up RDS Custom for SQL Server](#custom-setup-sqlserver.review) -+ [Download and install the AWS CLI](#custom-setup-sqlserver.cli) -+ [Grant required permissions to your IAM principal](#custom-setup-sqlserver.iam-user) -+ [Configure networking, instance profile, and encryption](#custom-setup-sqlserver.iam-vpc) - + [Configuring with AWS CloudFormation](#custom-setup-sqlserver.cf) - + [Resources created by CloudFormation](#custom-setup-sqlserver.cf.list) - + [Downloading the template file](#custom-setup-sqlserver.cf.download) - + [Configuring resources using CloudFormation](#custom-setup-sqlserver.cf.config) - + [Configuring manually](#custom-setup-sqlserver.manual) - + [Make sure that you have a symmetric encryption AWS KMS key](#custom-setup-sqlserver.cmk) - + [Creating your IAM role and instance profile manually](#custom-setup-sqlserver.iam) - + [Create the AWSRDSCustomSQLServerInstanceRole IAM role](#custom-setup-sqlserver.iam.create-role) - + [Add an access policy to AWSRDSCustomSQLServerInstanceRole](#custom-setup-sqlserver.iam.add-policy) - + [Create your RDS Custom for SQL Server instance profile](#custom-setup-sqlserver.iam.create-profile) - + [Add AWSRDSCustomSQLServerInstanceRole to your RDS Custom for SQL Server instance profile](#custom-setup-sqlserver.iam.add-profile) - + [Configuring your VPC manually](#custom-setup-sqlserver.vpc) - + [Configure your VPC security group](#custom-setup-sqlserver.vpc.sg) - + [Configure endpoints for dependent AWS services](#custom-setup-sqlserver.vpc.endpoints) - + [Configure the instance metadata service](#custom-setup-sqlserver.vpc.imds) - -## Prerequisites for setting up RDS Custom for SQL Server - -Before creating an RDS Custom for SQL Server DB instance, make sure that your environment meets the requirements described in this topic\. As part of this setup process, make sure to configure the following prerequisites: -+ Configure the specified AWS Identity and Access Management \(IAM\) users and roles\. - - These are either used to create an RDS Custom DB instance or passed as a parameter in a creation request\. -+ Confirm there aren't any service control policies \(SCPs\) restricting account level permissions\. - - If the account that you're using is part of an AWS Organization, it might have service control policies \(SCPs\) restricting account level permissions\. Make sure that the SCPs don't restrict the permissions on users and roles that you create using the following procedures\. - - For more information about SCPs, see [Service control policies \(SCPs\)](https://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_policies_scps.html) in the *AWS Organizations User Guide*\. Use the [describe\-organization](https://docs.aws.amazon.com/cli/latest/reference/organizations/describe-organization.html) AWS CLI command to check whether your account is part of an AWS Organization\. - - For more information about AWS Organizations, see [What is AWS Organizations](https://docs.aws.amazon.com/organizations/latest/userguide/orgs_introduction.html) in the *AWS Organizations User Guide*\. - -**Note** -For a step\-by\-step tutorial on how to set up prerequisites and launch Amazon RDS Custom for SQL Server, see the blog post [Get started with Amazon RDS Custom for SQL Server using an CloudFormation template \(Network setup\)](http://aws.amazon.com/blogs/database/get-started-with-amazon-rds-custom-for-sql-server-using-an-aws-cloudformation-template-network-setup/) - -For each task, you can find descriptions following for the requirements and limitations specific to that task\. For example, when you create your RDS Custom for SQL Server DB instance, use one of the SQL Server instances listed in [DB instance class support for RDS Custom for SQL Server](custom-reqs-limits-MS.md#custom-reqs-limits.instancesMS)\. - -For general requirements that apply to RDS Custom for SQL Server, see [General requirements for RDS Custom for SQL Server](custom-reqs-limits-MS.md#custom-reqs-limits.reqsMS)\. - -## Download and install the AWS CLI - -AWS provides you with a command\-line interface to use RDS Custom features\. You can use either version 1 or version 2 of the AWS CLI\. - -For information about downloading and installing the AWS CLI, see [Installing or updating the latest version of the AWS CLI](https://docs.aws.amazon.com/cli/latest/userguide/getting-started-install.html)\. - -Skip this step if either of the following is true: -+ You plan to access RDS Custom only from the AWS Management Console\. -+ You have already downloaded the AWS CLI for Amazon RDS or a different RDS Custom DB engine\. - -## Grant required permissions to your IAM principal - -You use an IAM role or IAM user \(referred to as the *IAM principal*\) for creating an RDS Custom for SQL Server DB instance using the console or CLI\. This IAM principal must have either of the following policies for successful DB instance creation: -+ The `AdministratorAccess` policy -+ The `AmazonRDSFullAccess` policy with the following additional permissions: - - ``` - iam:SimulatePrincipalPolicy - cloudtrail:CreateTrail - cloudtrail:StartLogging - s3:CreateBucket - s3:PutBucketPolicy - s3:PutBucketObjectLockConfiguration - s3:PutBucketVersioning - kms:CreateGrant - kms:DescribeKey - ``` - - For more information about the `kms:CreateGrant` permission, see [AWS KMS key management](Overview.Encryption.Keys.md)\. - -The following sample JSON policy grants the required permissions\. - -``` -{ - "Version": "2012-10-17", - "Statement": [ - { - "Sid": "ValidateIamRole", - "Effect": "Allow", - "Action": "iam:SimulatePrincipalPolicy", - "Resource": "*" - }, - { - "Sid": "CreateCloudTrail", - "Effect": "Allow", - "Action": [ - "cloudtrail:CreateTrail", - "cloudtrail:StartLogging" - ], - "Resource": "arn:aws:cloudtrail:*:*:trail/do-not-delete-rds-custom-*" - }, - { - "Sid": "CreateS3Bucket", - "Effect": "Allow", - "Action": [ - "s3:CreateBucket", - "s3:PutBucketPolicy", - "s3:PutBucketObjectLockConfiguration", - "s3:PutBucketVersioning" - ], - "Resource": "arn:aws:s3:::do-not-delete-rds-custom-*" - }, - { - "Sid": "CreateKmsGrant", - "Effect": "Allow", - "Action": [ - "kms:CreateGrant", - "kms:DescribeKey" - ], - "Resource": "*" - } - ] -} -``` - -Also, the IAM principal requires the `iam:PassRole` permission on the IAM role\. That must be attached to the instance profile passed in the `custom-iam-instance-profile` parameter in the request to create the RDS Custom DB instance\. The instance profile and its attached role are created later in [Configure networking, instance profile, and encryption](#custom-setup-sqlserver.iam-vpc)\. - -Make sure that the previously listed permissions aren't restricted by service control policies \(SCPs\), permission boundaries, or session policies associated with the IAM principal\. - -## Configure networking, instance profile, and encryption - -You can configure your IAM instance profile role, virtual private cloud \(VPC\), and AWS KMS symmetric encryption key by using either of the following processes: -+ [Configuring with AWS CloudFormation](#custom-setup-sqlserver.cf) \(recommended\) -+ [Configuring manually](#custom-setup-sqlserver.manual) - -If your account is part of an AWS Organization, make sure that the permissions required by the instance profile role aren’t restricted by service control policies \(SCPs\)\. - -The following networking configurations are designed to work best with DB instances that aren't publicly accessible\. That is, you can’t connect directly to the DB instance from outside the VPC\. - -### Configuring with AWS CloudFormation - -To simplify setup, you can use an AWS CloudFormation template file to create a CloudFormation stack\. To learn how to create stacks, see [Creating a stack on the AWS CloudFormation console](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/cfn-console-create-stack.html) in the *AWS CloudFormation User Guide*\. - -For a tutorial on how to launch Amazon RDS Custom for SQL Server using an AWS CloudFormation template, see [Get started with Amazon RDS Custom for SQL Server using an AWS CloudFormation template](https://aws.amazon.com/blogs/database/get-started-with-amazon-rds-custom-for-sql-server-using-an-aws-cloudformation-template-network-setup/) in the *AWS Database Blog *\. - -**Topics** -+ [Resources created by CloudFormation](#custom-setup-sqlserver.cf.list) -+ [Downloading the template file](#custom-setup-sqlserver.cf.download) -+ [Configuring resources using CloudFormation](#custom-setup-sqlserver.cf.config) - -#### Resources created by CloudFormation - -Successfully creating the CloudFormation stack creates the following resources in your AWS account: -+ Symmetric encryption KMS key for encryption of data managed by RDS Custom\. -+ Instance profile and associated IAM role for attaching to RDS Custom instances\. -+ VPC with the CIDR range specified as the CloudFormation parameter\. The default value is `10.0.0.0/16`\. -+ Two private subnets with the CIDR range specified in the parameters, and two different Availability Zones in the AWS Region\. The default values for the subnet CIDRs are `10.0.128.0/20` and `10.0.144.0/20`\. -+ DHCP option set for the VPC with domain name resolution to an Amazon Domain Name System \(DNS\) server\. -+ Route table to associate with two private subnets and no access to the internet\. -+ Network access control list \(ACL\) to associate with two private subnets and access restricted to HTTPS\. -+ VPC security group to be associated with the RDS Custom instance\. Access is restricted for outbound HTTPS to AWS service endpoints that are required by RDS Custom\. -+ VPC security group to be associated with VPC endpoints that are created for AWS service endpoints that are required by RDS Custom\. -+ DB subnet group in which RDS Custom instances are created\. -+ VPC endpoints for each of the AWS service endpoints that are required by RDS Custom\. - -Use the following procedures to create the CloudFormation stack for RDS Custom for SQL Server\. - -#### Downloading the template file - -**To download the template file** - -1. Open the context \(right\-click\) menu for the link [ custom\-sqlserver\-onboard\.zip](samples/custom-sqlserver-onboard.zip) and choose **Save Link As**\. - -1. Save and extract the file to your computer\. - -#### Configuring resources using CloudFormation - -**To configure resources using CloudFormation** - -1. Open the CloudFormation console at [https://console\.aws\.amazon\.com/cloudformation](https://console.aws.amazon.com/cloudformation/)\. - -1. To start the Create Stack wizard, choose **Create Stack**\. - - The **Create stack** page appears\. - -1. For **Prerequisite \- Prepare template**, choose **Template is ready**\. - -1. For **Specify template**, do the following: - - 1. For **Template source**, choose **Upload a template file**\. - - 1. For **Choose file**, navigate to and then choose the correct file\. - -1. Choose **Next**\. - - The **Specify stack details** page appears\. - -1. For **Stack name**, enter **rds\-custom\-sqlserver**\. - -1. For **Parameters**, do the following: - - 1. To keep the default options, choose **Next**\. - - 1. To change options, choose the appropriate CIDR block range for the VPC and two of its subnets, and then choose **Next**\. - - Read the description of each parameter carefully before changing parameters\. - -1. On the **Configure stack options page**, choose **Next\.** - -1. On the **Review rds\-custom\-sqlserver** page, do the following: - - 1. For **Capabilities**, select the ****I acknowledge that AWS CloudFormation might create IAM resources with custom names**** check box\. - - 1. Choose **Create stack**\. - -1. **\(Optional\):** You can update the SQS permissions in the instance profile role\. - - If you want to deploy only a Single\-AZ DB instance, you can edit the CloudFormation template file to remove SQS permissions\. SQS permissions are only required for a Multi\-AZ deployment and allow RDS Custom for SQL Server to call Amazon SQS to perform specific actions\. Because they are not required for a Single\-AZ deployment, you may opt to remove these permissions to follow the principle of least privilege\. - - If you want to configure a Multi\-AZ deployment, you don't need to remove the SQS permissions\. -**Note** -If you remove the SQS permissions and later choose to modify to a Multi\-AZ deployment, the Multi\-AZ creation will fail\. You would need to re\-add the SQS permissions before modifying to a Multi\-AZ deployment\. - - To make this optional change to the CloudFormation template, open the CloudFormation console at [https://console\.aws\.amazon\.com/cloudformation](https://console.aws.amazon.com/cloudformation/), and edit the template file by removing the following lines: - - ``` - { - "Sid": "SendMessageToSQSQueue", - "Effect": "Allow", - "Action": [ - "SQS:SendMessage", - "SQS:ReceiveMessage", - "SQS:DeleteMessage", - "SQS:GetQueueUrl" - - ], - "Resource": [ - { - "Fn::Sub": "arn:${AWS::Partition}:sqs:${AWS::Region}:${AWS::AccountId}:do-not-delete-rds-custom-*" - } - ], - "Condition": { - "StringLike": { - "aws:ResourceTag/AWSRDSCustom": "custom-sqlserver" - } - } - } - ``` - -CloudFormation creates the resources that RDS Custom for SQL Server requires\. If the stack creation fails, read through the **Events** tab to see which resource creation failed and its status reason\. - -The **Outputs** tab for this CloudFormation stack in the console should have information about all resources to be passed as parameters for creating an RDS Custom for SQL Server DB instance\. Make sure to use the VPC security group and DB subnet group created by CloudFormation for RDS Custom DB instances\. By default, RDS tries to attach the default VPC security group, which might not have the access that you need\. - -**Note** -When you delete a CloudFormation stack, all of the resources created by the stack are deleted except the KMS key\. The KMS key goes into a `pending-deletion` state and is deleted after 30 days\. To keep the KMS key, perform a [CancelKeyDeletion](https://docs.aws.amazon.com/kms/latest/APIReference/API_CancelKeyDeletion.html) operation during the 30\-day grace period\. - -If you used CloudFormation to create resources, you can skip [Configuring manually](#custom-setup-sqlserver.manual)\. - -### Configuring manually - -If you choose to configure resources manually, perform the following tasks\. - -**Note** -To simplify setup, you can use the AWS CloudFormation template file to create a CloudFormation stack rather than a manual configuration\. For more information, see [Configuring with AWS CloudFormation](#custom-setup-sqlserver.cf)\. - -**Topics** -+ [Make sure that you have a symmetric encryption AWS KMS key](#custom-setup-sqlserver.cmk) -+ [Creating your IAM role and instance profile manually](#custom-setup-sqlserver.iam) -+ [Configuring your VPC manually](#custom-setup-sqlserver.vpc) - -#### Make sure that you have a symmetric encryption AWS KMS key - -A symmetric encryption AWS KMS key is required for RDS Custom\. When you create an RDS Custom for SQL Server DB instance, make sure to supply the KMS key identifier\. For more information, see [Creating and connecting to a DB instance for Amazon RDS Custom for SQL Server](custom-creating-sqlserver.md)\. - -You have the following options: -+ If you have an existing customer managed KMS key in your AWS account, you can use it with RDS Custom\. No further action is necessary\. -+ If you already created a customer managed symmetric encryption KMS key for a different RDS Custom engine, you can reuse the same KMS key\. No further action is necessary\. -+ If you don't have an existing customer managed symmetric encryption KMS key in your account, create a KMS key by following the instructions in [Creating keys](https://docs.aws.amazon.com/kms/latest/developerguide/create-keys.html#create-symmetric-cmk) in the *AWS Key Management Service Developer Guide*\. -+ If you're creating a CEV or RDS Custom DB instance, and your KMS key is in a different AWS account, make sure to use the AWS CLI\. You can't use the AWS console with cross\-account KMS keys\. - -**Important** -RDS Custom doesn't support AWS managed KMS keys\. - -Make sure that your symmetric encryption key grants access to the `kms:Decrypt` and `kms:GenerateDataKey` operations to the AWS Identity and Access Management \(IAM\) role in your IAM instance profile\. If you have a new symmetric encryption key in your account, no changes are required\. Otherwise, make sure that your symmetric encryption key's policy grants access to these operations\. - -For more information, see [Step 3: Configure IAM and your Amazon VPC](custom-setup-orcl.md#custom-setup-orcl.iam-vpc)\. - -#### Creating your IAM role and instance profile manually - -To use RDS Custom for SQL Server, create an IAM instance profile and IAM role as described following\. - -**To create the IAM instance profile and IAM roles for RDS Custom for SQL Server** - -1. Create the IAM role named `AWSRDSCustomSQLServerInstanceRole` with a trust policy that lets Amazon EC2 assume this role\. - -1. Add an access policy to `AWSRDSCustomSQLServerInstanceRole`\. - -1. Create an IAM instance profile for RDS Custom for SQL Server that is named `AWSRDSCustomSQLServerInstanceProfile`\. - -1. Add `AWSRDSCustomSQLServerInstanceRole` to the instance profile\. - -##### Create the AWSRDSCustomSQLServerInstanceRole IAM role - -The following example creates the `AWSRDSCustomSQLServerInstanceRole` role\. The trust policy lets Amazon EC2 assume the role\. - -``` -aws iam create-role \ - --role-name AWSRDSCustomSQLServerInstanceRole \ - --assume-role-policy-document '{ - "Version": "2012-10-17", - "Statement": [ - { - "Action": "sts:AssumeRole", - "Effect": "Allow", - "Principal": { - "Service": "ec2.amazonaws.com" - } - } - ] - }' -``` - -##### Add an access policy to AWSRDSCustomSQLServerInstanceRole - -When you embed an inline policy in a role, the inline policy is used as part of the role's access \(permissions\) policy\. You create the `AWSRDSCustomSQLServerIamRolePolicy` policy, which lets Amazon EC2 get and receive messages and perform various actions\. - -Make sure that the permissions in the access policy aren't restricted by SCPs or permission boundaries associated with the instance profile role\. - -The following example creates the access policy named `AWSRDSCustomSQLServerIamRolePolicy`, and adds it to the `AWSRDSCustomSQLServerInstanceRole` role\. This example assumes that the `'$REGION'`, `$ACCOUNT_ID`, and `'$CUSTOMER_KMS_KEY_ID'` variables have been set\. `'$CUSTOMER_KMS_KEY_ID'` is the ID, not the Amazon Resource Name \(ARN\), of the KMS key that you defined in [Make sure that you have a symmetric encryption AWS KMS key](#custom-setup-sqlserver.cmk)\. - -``` - aws iam put-role-policy \ - --role-name AWSRDSCustomSQLServerInstanceRole \ - --policy-name AWSRDSCustomSQLServerIamRolePolicy \ - --policy-document '{ - "Version": "2012-10-17", - "Statement": [ - { - "Sid": "ssmAgent1", - "Effect": "Allow", - "Action": [ - "ssm:GetDeployablePatchSnapshotForInstance", - "ssm:ListAssociations", - "ssm:PutInventory", - "ssm:PutConfigurePackageResult", - "ssm:UpdateInstanceInformation", - "ssm:GetManifest" - ], - "Resource": "*" - }, - { - "Sid": "ssmAgent2", - "Effect": "Allow", - "Action": [ - "ssm:ListInstanceAssociations", - "ssm:PutComplianceItems", - "ssm:UpdateAssociationStatus", - "ssm:DescribeAssociation", - "ssm:UpdateInstanceAssociationStatus" - ], - "Resource": "arn:aws:ec2:'$REGION':'$ACCOUNT_ID':instance/*", - "Condition": { - "StringLike": { - "aws:ResourceTag/AWSRDSCustom": "custom-sqlserver" - } - } - }, - { - "Sid": "ssmAgent3", - "Effect": "Allow", - "Action": [ - "ssm:UpdateAssociationStatus", - "ssm:DescribeAssociation", - "ssm:GetDocument", - "ssm:DescribeDocument" - ], - "Resource": "arn:aws:ssm:*:*:document/*" - }, - { - "Sid": "ssmAgent4", - "Effect": "Allow", - "Action": [ - "ssmmessages:CreateControlChannel", - "ssmmessages:CreateDataChannel", - "ssmmessages:OpenControlChannel", - "ssmmessages:OpenDataChannel" - ], - "Resource": "*" - }, - { - "Sid": "ssmAgent5", - "Effect": "Allow", - "Action": [ - "ec2messages:AcknowledgeMessage", - "ec2messages:DeleteMessage", - "ec2messages:FailMessage", - "ec2messages:GetEndpoint", - "ec2messages:GetMessages", - "ec2messages:SendReply" - ], - "Resource": "*" - }, - { - "Sid": "ssmAgent6", - "Effect": "Allow", - "Action": [ - "ssm:GetParameters", - "ssm:GetParameter" - ], - "Resource": "arn:aws:ssm:*:*:parameter/*" - }, - { - "Sid": "ssmAgent7", - "Effect": "Allow", - "Action": [ - "ssm:UpdateInstanceAssociationStatus", - "ssm:DescribeAssociation" - ], - "Resource": "arn:aws:ssm:*:*:association/*" - }, - { - "Sid": "eccSnapshot1", - "Effect": "Allow", - "Action": "ec2:CreateSnapshot", - "Resource": [ - "arn:aws:ec2:'$REGION':'$ACCOUNT_ID':volume/*" - ], - "Condition": { - "StringLike": { - "aws:ResourceTag/AWSRDSCustom": "custom-sqlserver" - } - } - }, - { - "Sid": "eccSnapshot2", - "Effect": "Allow", - "Action": "ec2:CreateSnapshot", - "Resource": [ - "arn:aws:ec2:'$REGION'::snapshot/*" - ], - "Condition": { - "StringLike": { - "aws:RequestTag/AWSRDSCustom": "custom-sqlserver" - } - } - }, - { - "Sid": "eccCreateTag", - "Effect": "Allow", - "Action": "ec2:CreateTags", - "Resource": "*", - "Condition": { - "StringLike": { - "aws:RequestTag/AWSRDSCustom": "custom-sqlserver", - "ec2:CreateAction": [ - "CreateSnapshot" - ] - } - } - }, - { - "Sid": "s3BucketAccess", - "Effect": "Allow", - "Action": [ - "s3:putObject", - "s3:getObject", - "s3:getObjectVersion", - "s3:AbortMultipartUpload" - ], - "Resource": [ - "arn:aws:s3:::do-not-delete-rds-custom-*/*" - ] - }, - { - "Sid": "customerKMSEncryption", - "Effect": "Allow", - "Action": [ - "kms:Decrypt", - "kms:GenerateDataKey*" - ], - "Resource": [ - "arn:aws:kms:'$REGION':'$ACCOUNT_ID':key/'$CUSTOMER_KMS_KEY_ID'" - ] - }, - { - "Sid": "readSecretsFromCP", - "Effect": "Allow", - "Action": [ - "secretsmanager:GetSecretValue", - "secretsmanager:DescribeSecret" - ], - "Resource": [ - "arn:aws:secretsmanager:'$REGION':'$ACCOUNT_ID':secret:do-not-delete-rds-custom-*" - ], - "Condition": { - "StringLike": { - "aws:ResourceTag/AWSRDSCustom": "custom-sqlserver" - } - } - }, - { - "Sid": "publishCWMetrics", - "Effect": "Allow", - "Action": "cloudwatch:PutMetricData", - "Resource": "*", - "Condition": { - "StringEquals": { - "cloudwatch:namespace": "rdscustom/rds-custom-sqlserver-agent" - } - } - }, - { - "Sid": "putEventsToEventBus", - "Effect": "Allow", - "Action": "events:PutEvents", - "Resource": "arn:aws:events:'$REGION':'$ACCOUNT_ID':event-bus/default" - }, - { - "Sid": "cwlOperations1", - "Effect": "Allow", - "Action": [ - "logs:PutRetentionPolicy", - "logs:PutLogEvents", - "logs:DescribeLogStreams", - "logs:CreateLogStream", - "logs:CreateLogGroup" - ], - "Resource": "arn:aws:logs:'$REGION':'$ACCOUNT_ID':log-group:rds-custom-instance-*" - }, - { - "Condition": { - "StringLike": { - "aws:ResourceTag/AWSRDSCustom": "custom-sqlserver" - } - }, - "Action": [ - "SQS:SendMessage", - "SQS:ReceiveMessage", - "SQS:DeleteMessage", - "SQS:GetQueueUrl" - ], - "Resource": [ - "arn:aws:sqs:'$REGION':'$ACCOUNT_ID':do-not-delete-rds-custom-*" - ], - "Effect": "Allow", - "Sid": "SendMessageToSQSQueue" - } - ] - }' -``` - -##### Create your RDS Custom for SQL Server instance profile - -Create your instance profile as follows, naming it `AWSRDSCustomSQLServerInstanceProfile`\. - -``` -aws iam create-instance-profile \ - --instance-profile-name AWSRDSCustomSQLServerInstanceProfile -``` - -##### Add AWSRDSCustomSQLServerInstanceRole to your RDS Custom for SQL Server instance profile - -Add the `AWSRDSCustomInstanceRoleForRdsCustomInstance` role to the `AWSRDSCustomSQLServerInstanceProfile` profile\. - -``` -aws iam add-role-to-instance-profile \ - --instance-profile-name AWSRDSCustomSQLServerInstanceProfile \ - --role-name AWSRDSCustomSQLServerInstanceRole -``` - -#### Configuring your VPC manually - -Your RDS Custom DB instance is in a virtual private cloud \(VPC\) based on the Amazon VPC service, just like an Amazon EC2 instance or Amazon RDS instance\. You provide and configure your own VPC\. Thus, you have full control over your instance networking setup\. - -RDS Custom sends communication from your DB instance to other AWS services\. To make sure that RDS Custom can communicate, it validates network connectivity to the following AWS services: -+ Amazon CloudWatch -+ Amazon CloudWatch Logs -+ Amazon CloudWatch Events -+ Amazon EC2 -+ Amazon EventBridge -+ Amazon S3 -+ AWS Secrets Manager -+ AWS Systems Manager - -If RDS Custom can't communicate with the necessary services, it publishes the following event: - -``` -Database instance in incompatible-network. SSM Agent connection not available. Amazon RDS can't connect to the dependent AWS services. -``` - -To avoid `incompatible-network` errors, make sure that VPC components involved in communication between your RDS Custom DB instance and AWS services satisfy the following requirements: -+ The DB instance can make outbound connections on port 443 to other AWS services\. -+ The VPC allows incoming responses to requests originating from your RDS Custom DB instance\. -+ RDS Custom can correctly resolve the domain names of endpoints for each AWS service\. - -RDS Custom relies on AWS Systems Manager connectivity for its automation\. For information about how to configure VPC endpoints, see [Creating VPC endpoints for Systems Manager](https://docs.aws.amazon.com/systems-manager/latest/userguide/setup-create-vpc.html#sysman-setting-up-vpc-create)\. For the list of endpoints in each Region, see [AWS Systems Manager endpoints and quotas](https://docs.aws.amazon.com/general/latest/gr/ssm.html) in the *Amazon Web Services General Reference*\. - -If you already configured a VPC for a different RDS Custom DB engine, you can reuse that VPC and skip this process\. - -**Topics** -+ [Configure your VPC security group](#custom-setup-sqlserver.vpc.sg) -+ [Configure endpoints for dependent AWS services](#custom-setup-sqlserver.vpc.endpoints) -+ [Configure the instance metadata service](#custom-setup-sqlserver.vpc.imds) - -##### Configure your VPC security group - -A *security group* acts as a virtual firewall for a VPC instance, controlling both inbound and outbound traffic\. An RDS Custom DB instance has a default security group that protects the instance\. Make sure that your security group permits traffic between RDS Custom and other AWS services\. - -**To configure your security group for RDS Custom** - -1. Sign in to the AWS Management Console and open the Amazon VPC console at [https://console\.aws\.amazon\.com/vpc](https://console.aws.amazon.com/vpc)\. - -1. Allow RDS Custom to use the default security group, or create your own security group\. - - For detailed instructions, see [Provide access to your DB instance in your VPC by creating a security group](CHAP_SettingUp.md#CHAP_SettingUp.SecurityGroup)\. - -1. Make sure that your security group permits outbound connections on port 443\. RDS Custom needs this port to communicate with dependent AWS services\. - -1. If you have a private VPC and use VPC endpoints, make sure that the security group associated with the DB instance allows outbound connections on port 443 to VPC endpoints\. Also make sure that the security group associated with the VPC endpoint allows inbound connections on port 443 from the DB instance\. - - If incoming connections aren't allowed, the RDS Custom instance can't connect to the AWS Systems Manager and Amazon EC2 endpoints\. For more information, see [Create a Virtual Private Cloud endpoint](https://docs.aws.amazon.com/systems-manager/latest/userguide/setup-create-vpc.html) in the *AWS Systems Manager User Guide*\. - -For more information about security groups, see [Security groups for your VPC](https://docs.aws.amazon.com/vpc/latest/userguide/VPC_SecurityGroups.html) in the *Amazon VPC Developer Guide*\. - -##### Configure endpoints for dependent AWS services - -Make sure that your VPC allows outbound traffic to the following AWS services with which the DB instance communicates: -+ Amazon CloudWatch -+ Amazon CloudWatch Logs -+ Amazon CloudWatch Events -+ Amazon EC2 -+ Amazon EventBridge -+ Amazon S3 -+ AWS Secrets Manager -+ AWS Systems Manager - -We recommend that you add endpoints for every service to your VPC using the following instructions\. However, you can use any solution that lets your VPC communicate with AWS service endpoints\. For example, you can use Network Address Translation \(NAT\) or AWS Direct Connect\. - -**To configure endpoints for AWS services with which RDS Custom works** - -1. Open the Amazon VPC console at [https://console\.aws\.amazon\.com/vpc/](https://console.aws.amazon.com/vpc/)\. - -1. On the navigation bar, use the Region selector to choose the AWS Region\. - -1. In the navigation pane, choose **Endpoints**\. In the main pane, choose **Create Endpoint**\. - -1. For **Service category**, choose **AWS services**\. - -1. For **Service Name**, choose the endpoint shown in the table\. - -1. For **VPC**, choose your VPC\. - -1. For **Subnets**, choose a subnet from each Availability Zone to include\. - - The VPC endpoint can span multiple Availability Zones\. AWS creates an elastic network interface for the VPC endpoint in each subnet that you choose\. Each network interface has a Domain Name System \(DNS\) host name and a private IP address\. - -1. For **Security group**, choose or create a security group\. - - You can use security groups to control access to your endpoint, much as you use a firewall\. For more information about security groups, see [Security groups for your VPC](https://docs.aws.amazon.com/vpc/latest/userguide/VPC_SecurityGroups.html) in the *Amazon VPC User Guide*\. - -1. Optionally, you can attach a policy to the VPC endpoint\. Endpoint policies can control access to the AWS service to which you are connecting\. The default policy allows all requests to pass through the endpoint\. If you're using a custom policy, make sure that requests from the DB instance are allowed in the policy\. - -1. Choose **Create endpoint**\. - -The following table explains how to find the list of endpoints that your VPC needs for outbound communications\. - - -| Service | Endpoint format | Notes and links | -| --- | --- | --- | -| AWS Systems Manager | Use the following endpoint formats: [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/custom-setup-sqlserver.html) | For the list of endpoints in each Region, see [AWS Systems Manager endpoints and quotas](https://docs.aws.amazon.com/general/latest/gr/ssm.html) in the *Amazon Web Services General Reference*\. | -| AWS Secrets Manager | Use the endpoint format `secretsmanager.region.amazonaws.com`\. | For the list of endpoints in each Region, see [AWS Secrets Manager endpoints and quotas](https://docs.aws.amazon.com/general/latest/gr/asm.html) in the *Amazon Web Services General Reference*\. | -| Amazon CloudWatch | Use the following endpoint formats: [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/custom-setup-sqlserver.html) | For the list of endpoints in every Region, see: [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/custom-setup-sqlserver.html) | -| Amazon EC2 | Use the following endpoint formats: [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/custom-setup-sqlserver.html) | For the list of endpoints in each Region, see [Amazon Elastic Compute Cloud endpoints and quotas](https://docs.aws.amazon.com/general/latest/gr/ec2-service.html) in the *Amazon Web Services General Reference*\. | -| Amazon S3 | Use the endpoint format `s3.region.amazonaws.com`\. | For the list of endpoints in each Region, see [Amazon Simple Storage Service endpoints and quotas](https://docs.aws.amazon.com/general/latest/gr/s3.html) in the *Amazon Web Services General Reference*\. To learn more about gateway endpoints for Amazon S3, see [Endpoints for Amazon S3](https://docs.aws.amazon.com/vpc/latest/userguide/vpc-endpoints-s3.html) in the *Amazon VPC Developer Guide*\. To learn how to create an access point, see [Creating access points](https://docs.aws.amazon.com/AmazonS3/latest/user-guide/access-points-create-ap.html) in the *Amazon VPC Developer Guide*\. To learn how to create a gateway endpoints for Amazon S3, see [Gateway VPC endpoints](https://docs.aws.amazon.com/vpc/latest/privatelink/vpce-gateway.html)\. | - -##### Configure the instance metadata service - -Make sure that your instance can do the following: -+ Access the instance metadata service using Instance Metadata Service Version 2 \(IMDSv2\)\. -+ Allow outbound communications through port 80 \(HTTP\) to the IMDS link IP address\. -+ Request instance metadata from `http://169.254.169.254`, the IMDSv2 link\. - -For more information, see [Use IMDSv2](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/configuring-instance-metadata-service.html) in the *Amazon EC2 User Guide for Linux Instances*\. \ No newline at end of file diff --git a/doc_source/custom-sqlserver-multiaz.md b/doc_source/custom-sqlserver-multiaz.md deleted file mode 100644 index 7b206ba..0000000 --- a/doc_source/custom-sqlserver-multiaz.md +++ /dev/null @@ -1,361 +0,0 @@ -# Managing a Multi\-AZ deployment for RDS Custom for SQL Server - - In a Multi\-AZ DB instance deployment for RDS Custom for SQL Server, Amazon RDS automatically provisions and maintains a synchronous standby replica in a different Availability Zone \(AZ\)\. The primary DB instance is synchronously replicated across Availability Zones to a standby replica to provide data redundancy\. - -**Important** -A Multi\-AZ deployment for RDS Custom for SQL Server is different than Multi\-AZ for RDS for SQL Server\. Unlike Multi\-AZ for RDS for SQL Server, you must set up prerequisites for RDS Custom for SQL Server before creating your Multi\-AZ DB instance because RDS Custom runs inside your own account, which requires permissions\. -If you don't complete the prerequisites, your Multi\-AZ DB instance might fail to run, or automatically revert to a Single\-AZ DB instance\. For more information about prerequisites, see [Prerequisites for a Multi\-AZ deployment with RDS Custom for SQL Server](#custom-sqlserver-multiaz.prerequisites)\. - -Running a DB instance with high availability can enhance availability during planned system maintenance\. In the event of planned database maintenance or unplanned service disruption, Amazon RDS automatically fails over to the up\-to\-date secondary DB instance\. This functionality lets database operations resume quickly without manual intervention\. The primary and standby instances use the same endpoint, whose physical network address transitions to the secondary replica as part of the failover process\. You don't have to reconfigure your application when a failover occurs\. - -![\[RDS Custom for SQL Server supports Multi-AZ.\]](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/images/custom-sqlserver-multiaz-architecture.png) - -You can create an RDS Custom for SQL Server Multi\-AZ deployment by specifying Multi\-AZ when creating an RDS Custom DB instance\. You can use the console to convert existing RDS Custom for SQL Server DB instances to Multi\-AZ deployments by modifying the DB instance and specifying the Multi\-AZ option\. You can also specify a Multi\-AZ DB instance deployment with the AWS CLI or Amazon RDS API\. - -The RDS console shows the Availability Zone of the standby replica \(the secondary AZ\)\. You can also use the `describe-db-instances` CLI command or the `DescribeDBInstances` API operation to find the secondary AZ\. - -RDS Custom for SQL Server DB instances with Multi\-AZ deployment can have increased write and commit latency compared to a Single\-AZ deployment\. This increase can happen because of the synchronous data replication between DB instances\. You might have a change in latency if your deployment fails over to the standby replica, although AWS is engineered with low\-latency network connectivity between Availability Zones\. - -**Note** -For production workloads, we recommend that you use a DB instance class with Provisioned IOPS \(input/output operations per second\) for fast, consistent performance\. For more information about DB instance classes, see [Requirements and limitations for Amazon RDS Custom for SQL Server](custom-reqs-limits-MS.md)\. - -**Topics** -+ [Region and version availability](#custom-sqlserver-multiaz.regionversion) -+ [Limitations for a Multi\-AZ deployment with RDS Custom for SQL Server](#custom-sqlserver-multiaz.limitations) -+ [Prerequisites for a Multi\-AZ deployment with RDS Custom for SQL Server](#custom-sqlserver-multiaz.prerequisites) -+ [Creating an RDS Custom for SQL Server Multi\-AZ deployment](#custom-sqlserver-multiaz.creating) -+ [Modifying an RDS Custom for SQL Server Single\-AZ deployment to a Multi\-AZ deployment](#custom-sqlserver-multiaz.modify-saztomaz) -+ [Modifying an RDS Custom for SQL Server Multi\-AZ deployment to a Single\-AZ deployment](#custom-sqlserver-multiaz.modify-maztosaz) -+ [Failover process for an RDS Custom for SQL Server Multi\-AZ deployment](#custom-sqlserver-multiaz.failover) -+ [Time to live \(TTL\) settings with applications using an RDS Custom for SQL Server Multi\-AZ deployment](#custom-sqlserver-multiaz.ttldns) - -## Region and version availability - -Multi\-AZ deployments for RDS Custom for SQL Server are supported for the following SQL Server editions: -+ SQL Server 2019 Enterprise Edition -+ SQL Server 2019 Standard Edition -+ SQL Server 2019 Web Edition - -Multi\-AZ deployments for RDS Custom for SQL Server are supported for the following SQL Server versions: -+ SQL Server 2019 CU18 \(15\.0\.4261\.1\) -+ SQL Server 2019 CU17 \(15\.0\.4249\.2\) - -Multi\-AZ deployments for RDS Custom for SQL Server are available in all Regions where RDS Custom for SQL Server is available\. For more information on Region availability of Multi\-AZ deployments for RDS Custom for SQL Server, see [RDS Custom for SQL Server](Concepts.RDS_Fea_Regions_DB-eng.Feature.RDSCustom.md#Concepts.RDS_Fea_Regions_DB-eng.Feature.RDSCustom.sq)\. - -## Limitations for a Multi\-AZ deployment with RDS Custom for SQL Server - -Multi\-AZ deployments with RDS Custom for SQL Server have the following limitations: -+ Cross\-Region Multi\-AZ deployments aren't supported\. -+ You can’t configure the secondary DB instance to accept database read activity\. -+ When you use a Custom Engine Version \(CEV\) with a Multi\-AZ deployment, your secondary DB instance will also use the same CEV\. The secondary DB instance can't use a different CEV\. - -## Prerequisites for a Multi\-AZ deployment with RDS Custom for SQL Server - -If you have an existing RDS Custom for SQL Server Single\-AZ deployment, the following additional prerequisites are required before modifying it to a Multi\-AZ deployment\. You can choose to complete the prerequisites manually or with the provided CloudFormation template\. The latest CloudFormation template contains the prerequisites for both Single\-AZ and Multi\-AZ deployments\. - -**Important** -To simplify setup, we recommend that you use the latest AWS CloudFormation template file provided in the network setup instructions to create the prerequisites\. For more information, see [Configuring with AWS CloudFormation](custom-setup-sqlserver.md#custom-setup-sqlserver.cf)\. - -**Note** -When you modify an existing RDS Custom for SQL Server Single\-AZ deployment to a Multi\-AZ deployment, you must complete these prerequisites\. If you don't complete the prerequisites, the Multi\-AZ setup will fail\. To complete the prerequisites, follow the steps in [Modifying an RDS Custom for SQL Server Single\-AZ deployment to a Multi\-AZ deployment](#custom-sqlserver-multiaz.modify-saztomaz)\. -+ Update the RDS security group inbound and outbound rules to allow port 1120\. -+ Add a rule in your private network Access Control List \(ACL\) that allows TCP ports `0-65535` for the DB instance VPC\. -+ Create new Amazon SQS VPC endpoints that allow the RDS Custom for SQL Server DB instance to communicate with SQS\. -+ Update the SQS permissions in the instance profile role\. - -## Creating an RDS Custom for SQL Server Multi\-AZ deployment - -To create an RDS Custom for SQL Server Multi\-AZ deployment, follow the steps in [Creating and connecting to a DB instance for Amazon RDS Custom for SQL Server](custom-creating-sqlserver.md)\. - -**Important** -To simplify setup, we recommend that you use the latest AWS CloudFormation template file provided in the network setup instructions\. For more information, see [Configuring with AWS CloudFormation](custom-setup-sqlserver.md#custom-setup-sqlserver.cf)\. - -Creating a Multi\-AZ deployment takes a few minutes to complete\. - -## Modifying an RDS Custom for SQL Server Single\-AZ deployment to a Multi\-AZ deployment - -You can modify an existing RDS Custom for SQL Server DB instance from a Single\-AZ deployment to a Multi\-AZ deployment\. When you modify the DB instance,Amazon RDS performs several actions: -+ Takes a snapshot of the primary DB instance\. -+ Creates new volumes for the standby replica from the snapshot\. These volumes initialize in the background, and maximum volume performance is achieved after the data is fully initialized\. -+ Turns on synchronous block\-level replication between the primary and secondary DB instances\. - -**Important** -We recommend that you avoid modifying your RDS Custom for SQL Server DB instance from a Single\-AZ to a Multi\-AZ deployment on a production DB instance during periods of peak activity\. - -AWS uses a snapshot to create the standby instance to avoid downtime when you convert from Single\-AZ to Multi\-AZ, but performance might be impacted during and after converting to Multi\-AZ\. This impact can be significant for workloads that are sensitive to write latency\. While this capability allows large volumes to quickly be restored from snapshots, it can cause increase in the latency of I/O operations because of the synchronous replication\. This latency can impact your database performance\. - -**Topics** -+ [Configuring prerequisites to modify a Single\-AZ to a Multi\-AZ deployment using CloudFormation](#custom-sqlserver-multiaz.modify-saztomaz-prereqs.cf) -+ [Configuring prerequisites to modify a Single\-AZ to a Multi\-AZ deployment manually](#custom-sqlserver-multiaz.modify-saztomaz-prereqs.manual) -+ [Modify using the RDS console, AWS CLI, or RDS API\.](#custom-sqlserver-multiaz.modify-saztomaz-afterprereqs) - -### Configuring prerequisites to modify a Single\-AZ to a Multi\-AZ deployment using CloudFormation - -To use a Multi\-AZ deployment, you must ensure you've applied the latest CloudFormation template with prerequisites, or manually configure the latest prerequisites\. If you've already applied the latest CloudFormation prerequisite template, you can skip these steps\. - -To configure the RDS Custom for SQL Server Multi\-AZ deployment prerequisites using CloudFormation - -1. Open the CloudFormation console at [https://console\.aws\.amazon\.com/cloudformation](https://console.aws.amazon.com/cloudformation/)\. - -1. To start the Create Stack wizard, select the existing stack you used to create a Single\-AZ deployment and choose** Update**\. - - The **Update stack** page appears\. - -1. For **Prerequisite \- Prepare template**, choose **Replace current template**\. - -1. For **Specify template**, do the following: - - 1. Download the latest AWS CloudFormation template file\. Open the context \(right\-click\) menu for the link [custom\-sqlserver\-onboard\.zip](samples/custom-sqlserver-onboard.zip) and choose **Save Link As**\. - - 1. Save and extract the `custom-sqlserver-onboard.json` file to your computer\. - - 1. For **Template source**, choose **Upload a template file**\. - - 1. For **Choose file**, navigate to and then choose `custom-sqlserver-onboard.json`\. - -1. Choose **Next**\. - - The **Specify stack details** page appears\. - -1. To keep the default options, choose **Next**\. - - The **Advanced Options** page appears\. - -1. To keep the default options, choose **Next**\. - -1. To keep the default options, choose **Next**\. - -1. On the **Review Changes** page, do the following: - - 1. For **Capabilities**, select the ****I acknowledge that AWS CloudFormation might create IAM resources with custom names**** check box\. - - 1. Choose **Submit**\. - -1. Verify the update is successful\. The status of a successful operation shows `UPDATE_COMPLETE`\. - -If the update fails, any new configuration specified in the update process will be rolled back\. The existing resource will still be usable\. For example, if you add network ACL rules numbered 18 and 19, but there were existing rules with same numbers, the update would return the following error: `Resource handler returned message: "The network acl entry identified by 18 already exists.` In this scenario you can modify the existing ACL rules to use a number lower than 18, then retry the update\. - -### Configuring prerequisites to modify a Single\-AZ to a Multi\-AZ deployment manually - -**Important** -To simplify setup, we recommend that you use the latest AWS CloudFormation template file provided in the network setup instructions\. For more information, see [Configuring prerequisites to modify a Single\-AZ to a Multi\-AZ deployment using CloudFormation](#custom-sqlserver-multiaz.modify-saztomaz-prereqs.cf)\. - -If you choose to configure the prerequisites manually, perform the following tasks\. - -1. Open the Amazon VPC console at [https://console\.aws\.amazon\.com/vpc/](https://console.aws.amazon.com/vpc/)\. - -1. Choose **Endpoint**\. The **Create Endpoint** page appears\. - -1. For **Service Category**, choose **AWS services**\. - -1. In **Services**, search for *SQS* - -1. In **VPC**, choose the VPC where your RDS Custom for SQL Server DB instance is deployed\. - -1. In **Subnets**, choose the subnets where your RDS Custom for SQL Server DB instance is deployed\. - -1. In **Security Groups**, choose the *\-vpc\-endpoint\-sg* group\. - -1. For **Policy**, choose **Custom** - -1. In your custom policy, replace the *AWS partition*, *Region*, *accountId*,and *IAM\-Instance\-role* with your own values\. - - ``` - { - "Version": "2012-10-17", - "Statement": [ - { - "Condition": { - "StringLike": { - "aws:ResourceTag/AWSRDSCustom": "custom-sqlserver" - } - }, - "Action": [ - "SQS:SendMessage", - "SQS:ReceiveMessage", - "SQS:DeleteMessage", - "SQS:GetQueueUrl" - ], - "Resource": "arn:${AWS::Partition}:sqs:${AWS::Region}:${AWS::AccountId}:do-not-delete-rds-custom-*", - "Effect": "Allow", - "Principal": { - "AWS": "arn:${AWS::Partition}:iam::${AWS::AccountId}:role/{IAM-Instance-role}" - } - } - ] - } - ``` - -1. Update the **Instance profile** with permission to access Amazon SQS\. Replace the *AWS partition*, *Region*, and *accountId* with your own values\. - - ``` - { - "Sid": "SendMessageToSQSQueue", - "Effect": "Allow", - "Action": [ - "SQS:SendMessage", - "SQS:ReceiveMessage", - "SQS:DeleteMessage", - "SQS:GetQueueUrl" - - ], - "Resource": [ - { - "Fn::Sub": "arn:${AWS::Partition}:sqs:${AWS::Region}:${AWS::AccountId}:do-not-delete-rds-custom-*" - } - ], - "Condition": { - "StringLike": { - "aws:ResourceTag/AWSRDSCustom": "custom-sqlserver" - } - } - } - > - ``` - -1. Update the Amazon RDS security group inbound and outbound rules to allow port 1120\. - - 1. In **Security Groups**, choose the *\-rds\-custom\-instance\-sg* group\. - - 1. For **Inbound Rules**, create a **Custom TCP** rule to allow port *1120* from the source *\-rds\-custom\-instance\-sg* group\. - - 1. For **Outbound Rules**, create a **Custom TCP** rule to allow port *1120* to the destination *\-rds\-custom\-instance\-sg* group\. - -1. Add a rule in your private network Access Control List \(ACL\) that allows TCP ports `0-65535` for the source subnet of the DB instance\. -**Note** -When creating an **Inbound Rule** and **Outbound Rule**, take note of the highest existing **Rule number**\. The new rules you create must have a **Rule number** lower than 100 and not match any existing **Rule number**\. - - 1. In **Network ACLs**, choose the *\-private\-network\-acl* group\. - - 1. For **Inbound Rules**, create an **All TCP** rule to allow TCP ports `0-65535` with a source from *privatesubnet1* and *privatesubnet2*\. - - 1. For **Outbound Rules**, create an **All TCP** rule to allow TCP ports `0-65535` to destination *privatesubnet1* and *privatesubnet2*\. - -### Modify using the RDS console, AWS CLI, or RDS API\. - -After you've completed the prerequisites, you can modify an RDS Custom for SQL Server DB instance from a Single\-AZ to Multi\-AZ deployment using the RDS console, AWS CLI, or RDS API\. - -#### Console - -**To modify an existing RDS Custom for SQL Server Single\-AZ to Multi\-AZ deployment** - -1. Sign in to the AWS Management Console and open the Amazon RDS console at [https://console\.aws\.amazon\.com/rds/](https://console.aws.amazon.com/rds/)\. - -1. In the Amazon RDS console, choose **Databases**\. - - The **Databases** pane appears\. - -1. Choose the RDS Custom for SQL Server DB instance that you want to modify\. - -1. For **Actions**, choose **Convert to Multi\-AZ deployment**\. - -1. On the **Confirmation** page, choose **Apply immediately** to apply the changes immediately\. Choosing this option doesn't cause downtime, but there is a possible performance impact\. Alternatively, you can choose to apply the update during the next maintenance window\. For more information, see [Using the Apply Immediately setting](Overview.DBInstance.Modifying.md#USER_ModifyInstance.ApplyImmediately)\. - -1. On the **Confirmation** page, choose **Convert to Multi\-AZ**\. - -#### AWS CLI - -To convert to a Multi\-AZ DB instance deployment by using the AWS CLI, call the [modify\-db\-instance](https://docs.aws.amazon.com/cli/latest/reference/rds/modify-db-instance.html) command and set the `--multi-az` option\. Specify the DB instance identifier and the values for other options that you want to modify\. For information about each option, see [Settings for DB instances](Overview.DBInstance.Modifying.md#USER_ModifyInstance.Settings)\. - -**Example** -The following code modifies `mycustomdbinstance` by including the `--multi-az` option\. The changes are applied during the next maintenance window by using `--no-apply-immediately`\. Use `--apply-immediately` to apply the changes immediately\. For more information, see [Using the Apply Immediately setting](Overview.DBInstance.Modifying.md#USER_ModifyInstance.ApplyImmediately)\. -For Linux, macOS, or Unix: - -``` -aws rds modify-db-instance \ - --db-instance-identifier mycustomdbinstance \ - --multi-az \ - --no-apply-immediately -``` -For Windows: - -``` -aws rds modify-db-instance ^ - --db-instance-identifier mycustomdbinstance ^ - --multi-az \ ^ - --no-apply-immediately -``` - -#### RDS API - -To convert to a Multi\-AZ DB instance deployment with the RDS API, call the [ModifyDBInstance](https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_ModifyDBInstance.html) operation and set the `MultiAZ` parameter to true\. - -## Modifying an RDS Custom for SQL Server Multi\-AZ deployment to a Single\-AZ deployment - -You can modify an existing RDS Custom for SQL Server DB instance from a Multi\-AZ to a Single\-AZ deployment\. - -### Console - -**To modify an RDS Custom for SQL Server DB instance from a Multi\-AZ to Single\-AZ deployment\.** - -1. Sign in to the AWS Management Console and open the Amazon RDS console at [https://console\.aws\.amazon\.com/rds/](https://console.aws.amazon.com/rds/)\. - -1. In the Amazon RDS console, choose **Databases**\. - - The **Databases** pane appears\. - -1. Choose the RDS Custom for SQL Server DB instance that you want to modify\. - -1. For **Multi\-AZ deployment**, choose **No**\. - -1. On the **Confirmation** page, choose **Apply immediately** to apply the changes immediately\. Choosing this option doesn't cause downtime, but there is a possible performance impact\. Alternatively, you can choose to apply the update during the next maintenance window\. For more information, see [Using the Apply Immediately setting](Overview.DBInstance.Modifying.md#USER_ModifyInstance.ApplyImmediately)\. - -1. On the **Confirmation** page, choose **Modify DB Instance**\. - -### AWS CLI - -To modify a Multi\-AZ deployment to a Single\-AZ deployment by using the AWS CLI, call the [modify\-db\-instance](https://docs.aws.amazon.com/cli/latest/reference/rds/modify-db-instance.html) command and include the `--no-multi-az` option\. Specify the DB instance identifier and the values for other options that you want to modify\. For information about each option, see [Settings for DB instances](Overview.DBInstance.Modifying.md#USER_ModifyInstance.Settings)\. - -**Example** -The following code modifies `mycustomdbinstance` by including the `--no-multi-az` option\. The changes are applied during the next maintenance window by using `--no-apply-immediately`\. Use `--apply-immediately` to apply the changes immediately\. For more information, see [Using the Apply Immediately setting](Overview.DBInstance.Modifying.md#USER_ModifyInstance.ApplyImmediately)\. -For Linux, macOS, or Unix: - -``` -aws rds modify-db-instance \ - --db-instance-identifier mycustomdbinstance \ - --no-multi-az \ - --no-apply-immediately -``` -For Windows: - -``` -aws rds modify-db-instance ^ - --db-instance-identifier mycustomdbinstance ^ - --no-multi-az \ ^ - --no-apply-immediately -``` - -### RDS API - -To modify a Multi\-AZ deployment to a Single\-AZ deployment by using the RDS API, call the [ModifyDBInstance](https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_ModifyDBInstance.html) operation and set the `MultiAZ` parameter to `false`\. - -## Failover process for an RDS Custom for SQL Server Multi\-AZ deployment - -If a planned or unplanned outage of your DB instance results from an infrastructure defect, Amazon RDS automatically switches to a standby replica in another Availability Zone if you have turned on Multi\-AZ\. The time that it takes for the failover to complete depends on the database activity and other conditions at the time that the primary DB instance became unavailable\. Failover times are typically 60 – 120 seconds\. However, large transactions or a lengthy recovery process can increase failover time\. When the failover is complete, it can take additional time for the RDS console to show the new Availability Zone\. - -**Note** -You can force a failover manually when you reboot a DB instance with failover\. For more information on rebooting a DB instance, see [Rebooting a DB instance](USER_RebootInstance.md) - -Amazon RDS handles failovers automatically so you can resume database operations as quickly as possible without administrative intervention\. The primary DB instance switches over automatically to the standby replica if any of the conditions described in the following table occurs\. You can view these failover reasons in the RDS event log\. - - -**** - -| Failover reason | Description | -| --- | --- | -| `The operating system for the RDS Custom for SQL Server Multi-AZ DB instance is being patched in an offline operation` | A failover was triggered during the maintenance window for an OS patch or a security update\. For more information, see [Maintaining a DB instance](USER_UpgradeDBInstance.Maintenance.md)\. | -| `The primary host of the RDS Custom for SQL Server Multi-AZ DB instance is unhealthy.` | The Multi\-AZ DB instance deployment detected an impaired primary DB instance and failed over\. | -| `The primary host of the RDS Custom for SQL Server Multi-AZ DB instance is unreachable due to loss of network connectivity.` | RDS monitoring detected a network reachability failure to the primary DB instance and triggered a failover\. | -| `The RDS Custom for SQL Server Multi-AZ DB instance was modified by the customer.` | A DB instance modification triggered a failover\. For more information, see [Modifying an RDS Custom for SQL Server DB instance](custom-managing-sqlserver.md#custom-managing.modify-sqlserver)\. | -| `The storage volume of the primary host of the RDS Custom for SQL Server Multi-AZ DB instance experienced a failure.` | The Multi\-AZ DB instance deployment detected a storage issue on the primary DB instance and failed over\. | -| `The user requested a failover of the RDS Custom for SQL Server Multi-AZ DB instance.` | The RDS Custom for SQL Server Multi\-AZ DB instance was rebooted with failover\. For more information, see [Rebooting a DB instance](USER_RebootInstance.md)\. | -| `The RDS Custom for SQL Server Multi-AZ primary DB instance is busy or unresponsive.` | The primary DB instance is unresponsive\. We recommend that you try the following steps: [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/custom-sqlserver-multiaz.html) | - -To determine if your Multi\-AZ DB instance has failed over, you can do the following: -+ Set up DB event subscriptions to notify you by email or SMS that a failover has been initiated\. For more information about events, see [Working with Amazon RDS event notification](USER_Events.md)\. -+ View your DB events by using the RDS console or API operations\. -+ View the current state of your RDS Custom for SQL Server Multi\-AZ DB instance deployment by using the RDS console, CLI, or API operations\. - -## Time to live \(TTL\) settings with applications using an RDS Custom for SQL Server Multi\-AZ deployment - -The failover mechanism automatically changes the Domain Name System \(DNS\) record of the DB instance to point to the standby DB instance\. As a result, you need to re\-establish any existing connections to your DB instance\. Ensure that any DNS cache time\-to\-live \(TTL\) configuration value is low, and validate that your application will not cache DNS for an extended time\. A high TTL value might prevent your application from quickly reconnecting to the DB instance after failover\. \ No newline at end of file diff --git a/doc_source/custom-sqlserver.byom.md b/doc_source/custom-sqlserver.byom.md deleted file mode 100644 index c326a54..0000000 --- a/doc_source/custom-sqlserver.byom.md +++ /dev/null @@ -1,45 +0,0 @@ -# Bring Your Own Media with RDS Custom for SQL Server - -RDS Custom for SQL Server supports two licensing models: License Included \(LI\) and Bring Your Own Media \(BYOM\)\. - -**With BYOM, you can do the following:** - -1. Provide and install your own Microsoft SQL Server binaries with supported cumulative updates \(CU\) on an AWS EC2 Windows AMI\. - -1. Save the AMI as a golden image, which is a template that you can use to create a custom engine version \(CEV\)\. - -1. Create a CEV from your golden image\. - -1. Create new RDS Custom for SQL Server DB instances by using your CEV\. - -Amazon RDS then manages your DB instances for you\. - -**Note** -If you also have a License Included \(LI\) RDS Custom for SQL Server DB instance, you can't use the SQL Server software from this DB instance with BYOM\. You must bring your own SQL Server binaries to BYOM\. - -## Requirements for BYOM for RDS Custom for SQL Server - -The same general requirements for custom engine versions with RDS Custom for SQL Server also apply to BYOM\. For more information, see [Requirements for RDS Custom for SQL Server CEVs](custom-cev-sqlserver.preparing.md#custom-cev-sqlserver.preparing.Requirements)\. - -When using BYOM, make you sure that you meet the following additional requirements: -+ Use only SQL Server 2019 Enterprise and Standard edition\. These are the only supported editions\. -+ Grant the SQL Server sysadmin \(SA\) server role privilege to `NT AUTHORITY\SYSTEM`\. -+ Keep the Windows Server OS configured with `UTC` time\. - - Amazon EC2 Windows instances are set to the UTC time zone by default\. For more information about viewing and changing the time for a Windows instance, see [Set the time for a Windows instance](https://docs.aws.amazon.com/AWSEC2/latest/WindowsGuide/windows-set-time.html)\. -+ Open TCP port 1433 and UDP port 1434 to allow SSM connections\. - -## Limitations of BYOM for RDS Custom for SQL Server - -The same general limitations for RDS Custom for SQL Server also apply to BYOM\. For more information, see [Requirements and limitations for Amazon RDS Custom for SQL Server](custom-reqs-limits-MS.md)\. - -With BYOM, the following additional limitations apply: -+ Only the default SQL Server instance \(MSSQLSERVER\) is supported\. Named SQL Server instances aren't supported\. RDS Custom for SQL Server detects and monitors only the default SQL Server instance\. -+ Only a single installation of SQL Server is supported on each AMI\. Multiple installations of different SQL Server versions aren't supported\. -+ SQL Server Web edition isn't supported with BYOM\. -+ Evaluation versions of SQL Server editions aren't supported with BYOM\. When you install SQL Server, don't select the checkbox for using an evaluation version\. -+ Feature availability and support varies across specific versions of each database engine, and across AWS Regions\. For more information, see [Region availability for RDS Custom for SQL Server CEVs](custom-cev-sqlserver.preparing.md#custom-cev-sqlserver.preparing.RegionVersionAvailability) and [Version support for RDS Custom for SQL Server CEVs](custom-cev-sqlserver.preparing.md#custom-cev-sqlserver.preparing.VersionSupport)\. - -## Creating an RDS Custom for SQL Server DB instance with BYOM - -To prepare and create an RDS Custom for SQL Server DB instance with BYOM, see [Preparing a CEV using Bring Your Own Media \(BYOM\)](custom-cev-sqlserver.preparing.md#custom-cev-sqlserver.preparing.byom)\. \ No newline at end of file diff --git a/doc_source/custom-sqlserver.workflow.md b/doc_source/custom-sqlserver.workflow.md deleted file mode 100644 index 5140bd2..0000000 --- a/doc_source/custom-sqlserver.workflow.md +++ /dev/null @@ -1,31 +0,0 @@ -# RDS Custom for SQL Server workflow - -The following diagram shows the typical workflow for RDS Custom for SQL Server\. - -![\[RDS Custom for SQL Server architecture\]](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/./images/custom_sqlserver_architecture_v2.png) - -The steps are as follows: - -1. Create an RDS Custom for SQL Server DB instance from an engine version offered by RDS Custom\. - - For more information, see [Creating an RDS Custom for SQL Server DB instance](custom-creating-sqlserver.md#custom-creating-sqlserver.create)\. - -1. Connect your application to the RDS Custom DB instance endpoint\. - - For more information, see [Connecting to your RDS Custom DB instance using AWS Systems Manager](custom-creating-sqlserver.md#custom-creating-sqlserver.ssm) and [Connecting to your RDS Custom DB instance using RDP](custom-creating-sqlserver.md#custom-creating-sqlserver.rdp)\. - -1. \(Optional\) Access the host to customize your software\. - -1. Monitor notifications and messages generated by RDS Custom automation\. - -## Creating a DB instance for RDS Custom - -You create your RDS Custom DB instance using the `create-db-instance` command\. The procedure is similar to creating an Amazon RDS instance\. However, some of the parameters are different\. For more information, see [Creating and connecting to a DB instance for Amazon RDS Custom for SQL Server](custom-creating-sqlserver.md)\. - -## Database connection - -Like an Amazon RDS DB instance, your RDS Custom for SQL Server DB instance resides in a VPC\. Your application connects to the RDS Custom instance using a client such as SQL Server Management Suite \(SSMS\), just as in RDS for SQL Server\. - -## RDS Custom customization - -You can access the RDS Custom host to install or customize software\. To avoid conflicts between your changes and the RDS Custom automation, you can pause the automation for a specified period\. During this period, RDS Custom doesn't perform monitoring or instance recovery\. At the end of the period, RDS Custom resumes full automation\. For more information, see [Pausing and resuming RDS Custom automation](custom-managing-sqlserver.md#custom-managing-sqlserver.pausing)\. \ No newline at end of file diff --git a/doc_source/custom-troubleshooting.md b/doc_source/custom-troubleshooting.md deleted file mode 100644 index 5b1c15e..0000000 --- a/doc_source/custom-troubleshooting.md +++ /dev/null @@ -1,280 +0,0 @@ -# Troubleshooting DB issues for Amazon RDS Custom - -The shared responsibility model of RDS Custom provides OS shell–level access and database administrator access\. RDS Custom runs resources in your account, unlike Amazon RDS, which runs resources in a system account\. With greater access comes greater responsibility\. In the following sections, you can learn how to troubleshoot issues with Amazon RDS Custom DB instances\. - -**Topics** -+ [Viewing RDS Custom events](#custom-troubleshooting.support-perimeter.viewing-events) -+ [Subscribing to event notifications](#custom-troubleshooting.support-perimeter.subscribing) -+ [Troubleshooting custom engine version creation for RDS Custom for Oracle](#custom-troubleshooting.cev) -+ [Troubleshooting CEV errors for RDS Custom for SQL Server](#custom-troubleshooting-sqlserver.cev) -+ [RDS Custom support perimeter and unsupported configurations](#custom-troubleshooting.support-perimeter) -+ [Fixing unsupported configurations](#custom-troubleshooting.fix-unsupported) -+ [How Amazon RDS Custom replaces an impaired host](#custom-troubleshooting.host-problems) -+ [Troubleshooting upgrades for RDS Custom for Oracle](#custom-troubleshooting-upgrade) -+ [Troubleshooting replica promotion for RDS Custom for Oracle](#custom-troubleshooting-promote) - -## Viewing RDS Custom events - -The procedure for viewing events is the same for RDS Custom and Amazon RDS DB instances\. For more information, see [Viewing Amazon RDS events](USER_ListEvents.md)\. - -To view RDS Custom event notification using the AWS CLI, use the `describe-events` command\. RDS Custom introduces several new events\. The event categories are the same as for Amazon RDS\. For the list of events, see [Amazon RDS event categories and event messages](USER_Events.Messages.md)\. - -The following example retrieves details for the events that have occurred for the specified RDS Custom DB instance\. - -``` -1. aws rds describe-events \ -2. --source-identifier my-custom-instance \ -3. --source-type db-instance -``` - -## Subscribing to event notifications - -The procedure for subscribing to events is the same for RDS Custom and Amazon RDS DB instances\. For more information, see [Subscribing to Amazon RDS event notification](USER_Events.Subscribing.md)\. - -To subscribe to RDS Custom event notification using the CLI, use the `create-event-subscription` command\. Include the following required parameters: -+ `--subscription-name` -+ `--sns-topic-arn` - -The following example creates a subscription for backup and recovery events for an RDS Custom DB instance in the current AWS account\. Notifications are sent to an Amazon Simple Notification Service \(Amazon SNS\) topic, specified by `--sns-topic-arn`\. - -``` -1. aws rds create-event-subscription \ -2. --subscription-name my-instance-events \ -3. --source-type db-instance \ -4. --event-categories '["backup","recovery"]' \ -5. --sns-topic-arn arn:aws:sns:us-east-1:123456789012:interesting-events -``` - -## Troubleshooting custom engine version creation for RDS Custom for Oracle - -When CEV creation fails, RDS Custom issues `RDS-EVENT-0198` with the message `Creation failed for custom engine version major-engine-version.cev_name`, and includes details about the failure\. For example, the event prints missing files\. - -CEV creation might fail because of the following issues: -+ The Amazon S3 bucket containing your installation files isn't in the same AWS Region as your CEV\. -+ When you request CEV creation in an AWS Region for the first time, RDS Custom creates an S3 bucket for storing RDS Custom resources \(such as CEV artifacts, AWS CloudTrail logs, and transaction logs\)\. - - CEV creation fails if RDS Custom can't create the S3 bucket\. Either the caller doesn't have S3 permissions as described in [Step 4: Grant required permissions to your IAM user or role](custom-setup-orcl.md#custom-setup-orcl.iam-user), or the number of S3 buckets has reached the limit\. -+ The caller doesn't have permissions to get files from your S3 bucket that contains the installation media files\. These permissions are described in [Step 7: Add necessary IAM permissions](custom-cev.preparing.md#custom-cev.preparing.iam)\. -+ Your IAM policy has an `aws:SourceIp` condition\. Make sure to follow the recommendations in [AWS Denies access to AWS based on the source IP](https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies_examples_aws_deny-ip.html) in the *AWS Identity and Access Management User Guide*\. Also make sure that the caller has the S3 permissions described in [Step 4: Grant required permissions to your IAM user or role](custom-setup-orcl.md#custom-setup-orcl.iam-user)\. -+ Installation media files listed in the CEV manifest aren't in your S3 bucket\. -+ The SHA\-256 checksums of the installation files are unknown to RDS Custom\. - - Confirm that the SHA\-256 checksums of the provided files match the SHA\-256 checksum on the Oracle website\. If the checksums match, contact [AWS Support](http://aws.amazon.com/premiumsupport) and provide the failed CEV name, file name, and checksum\. -+ The OPatch version is incompatible with your patch files\. You might get the following message: `OPatch is lower than minimum required version. Check that the version meets the requirements for all patches, and try again`\. To apply an Oracle patch, you must use a compatible version of the OPatch utility\. You can find the required version of the Opatch utility in the readme file for the patch\. Download the most recent OPatch utility from My Oracle Support, and try creating your CEV again\. -+ The patches specified in the CEV manifest are in the wrong order\. - -You can view RDS events either on the RDS console \(in the navigation pane, choose **Events**\) or by using the `describe-events` AWS CLI command\. The default duration is 60 minutes\. If no events are returned, specify a longer duration, as shown in the following example\. - -``` -aws rds describe-events --duration 360 -``` - -Currently, the MediaImport service that imports files from Amazon S3 to create CEVs isn't integrated with AWS CloudTrail\. Therefore, if you turn on data logging for Amazon RDS in CloudTrail, calls to the MediaImport service such as the `CreateCustomDbEngineVersion` event aren't logged\. - -However, you might see calls from the API gateway that accesses your Amazon S3 bucket\. These calls come from the MediaImport service for the `CreateCustomDbEngineVersion` event\. - -## Troubleshooting CEV errors for RDS Custom for SQL Server - -When you try to create a CEV, it might fail\. In this case, RDS Custom issues the `RDS-EVENT-0198` event message\. For more information on viewing RDS events, see [Amazon RDS event categories and event messages](USER_Events.Messages.md)\. - -Use the following information to help you address possible causes\. - - -**** - -| Message | Troubleshooting suggestions | -| --- | --- | -| `Custom Engine Version creation expected a Sysprep’d AMI. Retry creation using a Sysprep’d AMI.` | Run Sysprep on the EC2 instance that you created from the AMI\. For more information about prepping an AMI using Sysprep, see [Create a standardized Amazon Machine Image \(AMI\) using Sysprep](https://docs.aws.amazon.com/AWSEC2/latest/WindowsGuide/Creating_EBSbacked_WinAMI.html#sysprep-using-ec2launchv2)\. | -| `EC2 Image permissions for image (AMI_ID) weren't found for customer (Customer_ID). Verify customer (Customer_ID) has valid permissions on the EC2 Image.` | Verify that your account and profile used for creation has the required permissions on `create EC2 Instance` and `Describe Images` for the selected AMI\. | -| `Image (AMI_ID) doesn't exist in your account (ACCOUNT_ID). Verify (ACCOUNT_ID) is the owner of the EC2 image.` | Ensure the AMI exists in the same customer account\. | -| `Image id (AMI_ID) isn't valid. Specify a valid image id, and try again.` | The name of the AMI is incorrect\. Ensure the correct AMI ID is provided\. | -| `Image (AMI_ID) operating system platform isn't supported. Specify a valid image, and try again.` | Choose a supported AMI that has Windows Server with SQL Server Enterprise, Standard, or Web edition\. Choose an AMI with one of the following usage operation codes from the EC2 Marketplace: [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/custom-troubleshooting.html) | -| `SQL Server Web Edition isn't supported for creating a Custom Engine Version using Bring Your Own Media. Specify a valid image, and try again.` | Use an AMI that contains a supported edition of SQL Server\. For more information, see [Version support for RDS Custom for SQL Server CEVs](custom-cev-sqlserver.preparing.md#custom-cev-sqlserver.preparing.VersionSupport)\. | -| `The custom engine version can't be the same as the OEV engine version. Specify a valid CEV, and try again.` | Classic RDS Custom for SQL Server engine versions aren't supported\. For example, version **15\.00\.4073\.23\.v1**\. Use a supported version number\. | -| `The custom engine version isn't in an active state. Specify a valid CEV, and try again.` | The CEV must be in an `AVAILABLE` state to complete the operation\. Modify the CEV from `INACTIVE` to `AVAILABLE`\. | -| `The custom engine version isn't valid for an upgrade. Specify a valid CEV with an engine version greater or equal to (X), and try again.` | The target CEV is not valid\. Check the requirements for a valid upgrade path\. | -| `The custom engine version isn't valid. Names can include only lowercase letters (a-z), dashes (-), underscores (_), and periods (.). Specify a valid CEV, and try again.` | Follow the required CEV naming convention\. For more information, see [Requirements for RDS Custom for SQL Server CEVs](custom-cev-sqlserver.preparing.md#custom-cev-sqlserver.preparing.Requirements)\. | -| `The custom engine version isn't valid. Specify valid database engine version, and try again. Example: 15.00.4073.23-cev123.` | An unsupported DB engine version was provided\. Use a supported DB engine version\. | -| `The expected architecture is (X) for image (AMI_ID), but architecture (Y) was found.` | Use an AMI built on the **x86\_64** architecture\. | -| `The expected owner of image (AMI_ID) is customer account ID (ACCOUNT_ID), but owner (ACCOUNT_ID) was found.` | Create the EC2 instance from the AMI that you have permission for\. Run Sysprep on the EC2 instance to create and save a base image\. | -| `The expected platform is (X) for image (AMI_ID), but platform (Y) was found.` | Use an AMI built with the Windows platform\. | -| `The expected root device type is (X) for image %s, but root device type (Y) was found.` | Create the AMI with the EBS device type\. | -| `The expected SQL Server edition is (X), but (Y) was found.` | Choose a supported AMI that has Windows Server with SQL Server Enterprise, Standard, or Web edition\. Choose an AMI with one of the following usage operation codes from the EC2 Marketplace: [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/custom-troubleshooting.html) | -| `The expected state is (X) for image (AMI_ID), but the following state was found: (Y).` | Ensure the AMI is in a state of `AVAILABLE`\. | -| `The provided Windows OS name (X) isn’t valid. Make sure the OS is one of the following: (Y).` | Use a supported Windows OS\. | -| `RDS expected a Windows build version greater than or equal to (X), but found version (Y).` | Use an AMI with a minimum OS build version of **14393**\. | -| `RDS expected a Windows major version greater than or equal to (X).1f, but found version (Y).1f.` | Use an AMI with a minimum OS major version of **10\.0** or higher\. | - -## RDS Custom support perimeter and unsupported configurations - -RDS Custom provides monitoring capability called the *support perimeter*\. The support perimeter ensures that your RDS Custom instance uses a supported AWS infrastructure, operating system, and database\. - -The support perimeter checks that the requirements listed in [Fixing unsupported configurations](#custom-troubleshooting.fix-unsupported) are met\. If any of these requirements aren't met, RDS Custom considers the DB instance to be outside of the support perimeter\. RDS Custom then changes the DB instance status to `unsupported-configuration`, and sends event notifications\. After you fix the configuration problems, RDS Custom changes the DB instance status to `available`\. - -### What happens in the `unsupported-configuration` state - -While the DB instance is in the `unsupported-configuration` state, the following is the case: -+ You can't modify the DB instance\. -+ You can't take DB snapshots\. -+ Automated backups aren't created\. -+ RDS Custom automation doesn't replace the underlying Amazon EC2 instance if it becomes impaired\. - -However, the following RDS Custom automation continues to run: -+ The RDS Custom agent monitors the DB instance and sends notifications to the support perimeter of further changes\. -+ The support perimeter continues to run and captures change events for the DB instance\. This has two purposes: - + When you fix the configuration that caused the DB instance to be in the `unsupported-configuration` state, the support perimeter can return the DB instance to the `available` state\. - + If you make other unsupported configurations, the support perimeter notifies you about them so that you can correct them\. -+ Redo logs are still archived and uploaded to Amazon S3 to facilitate point\-in\-time recovery \(PITR\)\. However, be aware of the following: - + PITR can take a long time to completely restore to a new DB instance\. This is because you can't take either automated or manual snapshots while the DB instance is in the `unsupported-configuration` state\. - - PITR has to replay more redo logs starting from the most recent snapshot taken before the instance entered the `unsupported-configuration` state\. - + In some cases, the DB instance is in the `unsupported-configuration` state because of changes you made that impacted redo log upload functionality\. In these cases, PITR can't restore the DB instance to the latest restorable time\. - -## Fixing unsupported configurations - -It's your responsibility to fix configuration issues that put your RDS Custom DB instance into the `unsupported-configuration` state\. If the issue is with the AWS infrastructure, you can use the console or the AWS CLI to fix it\. If the issue is with the operating system or the database configuration, you can log in to the host to fix it\. - -In the following table, you can find descriptions of the notifications that the support perimeter sends and how to fix them\. These notifications and the support perimeter are subject to change\. - - -| Notification | Description | Action | -| --- | --- | --- | -| Database health: [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/custom-troubleshooting.html) | The support perimeter monitors the DB instance state\. It also monitors how many restarts occurred during the previous hour and day\. You're notified when the instance is in a state where it still exists, but you can't interact with it\. | Log in to the host and examine the database state\. 
ps -eo pid,state,command | grep smon
Restart the DB instance if necessary to get it running again\. Sometimes it's necessary to reboot the host\. After the restart, the RDS Custom agent detects that the DB instance is no longer in an unresponsive state\. It then notifies the support perimeter to reevaluate the DB instance state\. | -| Database archive lag target \(RDS Custom for Oracle only\): [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/custom-troubleshooting.html) | The support perimeter monitors the `ARCHIVE_LAG_TARGET` database parameter to verify that the DB instance's latest restorable time is within reasonable bounds\. | Log in to the host, connect to the DB instance, and change the `ARCHIVE_LAG_TARGET` parameter to a value from 60–7200\. For example, use the following SQL command\. 
alter system set archive_lag_target=300 scope=both;
The DB instance becomes available within 30 minutes\. | -| Database log mode \(RDS Custom for Oracle only\): The monitored log mode of the database on Amazon EC2 instance \[i\-*xxxxxxxxxxxxxxxxx*\] has changed from \[ARCHIVELOG\] to \[NOARCHIVELOG\]\. | The DB instance log mode must be set to ARCHIVELOG\. | Log in to the host and shut down the DB instance\. You can use the following SQL command\. 
shutdown immediate;
The RDS Custom agent restarts the DB instance and sets the log mode to `ARCHIVELOG`\. The DB instance becomes available within 30 minutes\. | -| RDS Custom agent status \(RDS Custom for Oracle\): The monitored state of the RDS Custom agent on EC2 instance \[i\-*xxxxxxxxxxxxxxxxx*\] has changed from RUNNING to STOPPED\. | The RDS Custom agent must always be running\. The agent publishes the `IamAlive` metric to Amazon CloudWatch every 30 seconds\. An alarm is triggered if the metric hasn't been published for 30 seconds\. The support perimeter also monitors the RDS Custom agent process state on the host every 30 minutes\. On RDS Custom for Oracle, the DB instance goes outside the support perimeter if the RDS Custom agent stops\. | Log in to the host and make sure that the RDS Custom agent is running\. You can use the following commands to find the agent's status\. 
ps -ef | grep RDSCustomAgent
pgrep java
When the RDS Custom agent is running again, the `IamAlive` metric is published to Amazon CloudWatch, and the alarm switches to the `OK` state\. This switch notifies the support perimeter that the agent is running\. | -| RDS Custom agent status \(RDS Custom for SQL Server\): The RDS Custom instance is going out of perimeter because an unsupported configuration was used for RDS Custom agent\. | The RDS Custom agent must always be running\. The support perimeter monitors the RDS Custom agent process state on the host every 1 minute\. On RDS Custom for SQL Server, a stopped agent is recovered by the monitoring service\. The DB instance goes outside the support perimeter if the RDS Custom agent is uninstalled\. | Log in to the host and make sure that the RDS Custom agent is running\. You can use the following commands to find the agent's status\. 
$name = "RDSCustomAgent"
$service = Get-Service $name
Write-Host $service.Status
If the status isn't `Running`, you can start the service with the following command: 
Start-Service $name
| -| AWS Systems Manager agent \(SSM agent\) status \(RDS Custom for Oracle\): The AWS Systems Manager agent on EC2 instance \[i\-*xxxxxxxxxxxxxxxxx*\] is currently unreachable\. Make sure you have correctly configured the network, agent, and IAM permissions\. | The SSM agent must always be running\. The RDS Custom agent is responsible for making sure that the Systems Manager agent is running\. If the SSM agent was down and restarted, the RDS Custom agent publishes a metric to CloudWatch\. The RDS Custom agent has an alarm on the metric set to trigger when there has been a restart in each of the previous three minutes\. The support perimeter also monitors the SSM agent process state on the host every 30 minutes\. | For more information, see [Troubleshooting SSM Agent](https://docs.aws.amazon.com/systems-manager/latest/userguide/troubleshooting-ssm-agent.html)\. When the SSM agent is running again, the alarm switches to the `OK` state\. This switch notifies the support perimeter that the agent is running\. | -| SSM agent status \(RDS Custom for SQL Server\): The RDS Custom instance is going out of perimeter because an unsupported configuration was used for SSM agent\. | The SSM agent must always be running\. The RDS Custom agent is responsible for making sure that the Systems Manager agent is running\. The support perimeter monitors the SSM agent process state on the host every 1 minute\. | For more information, see [Troubleshooting SSM Agent](https://docs.aws.amazon.com/systems-manager/latest/userguide/troubleshooting-ssm-agent.html)\. | -| `sudo` configurations \(RDS Custom for Oracle only\): The sudo configurations on EC2 instance \[i\-*xxxxxxxxxxxxxxxxx*\] have changed\. | The support perimeter monitors that certain OS users are allowed to run certain commands on the box\. It monitors `sudo` configurations against the supported state\. When the `sudo` configurations aren't supported, the RDS Custom tries to overwrite them back to the previous supported state\. If that is successful, the following notification is sent: RDS Custom successfully overwrote your configuration\. | If the overwrite is unsuccessful, you can log in to the host and investigate why recent changes to the `sudo` configurations aren't supported\. You can use the following command\. 
visudo -c -f /etc/sudoers.d/individual_sudo_files
After the support perimeter determines that the `sudo` configurations are supported, the DB instance becomes available within 30 minutes\. | -| Amazon Elastic Block Store \(Amazon EBS\) volumes: RDS Custom for Oracle: [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/custom-troubleshooting.html) RDS Custom for SQL Server: [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/custom-troubleshooting.html) | RDS Custom creates two types of EBS volume, besides the root volume created from the Amazon Machine Image \(AMI\), and associates them with the EC2 instance\. The binary volume is where the database software binaries are located\. The data volumes are where database files are located\. The storage configurations that you set when creating the DB instance are used to configure the data volumes\. The support perimeter monitors the following: [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/custom-troubleshooting.html) | If you detached any initial EBS volumes, contact AWS Support\. If you modified the storage type, Provisioned IOPS, or storage throughput of an EBS volume, revert the modification to the original value\. If you modified the storage size of an EBS volume, contact AWS Support\. \(RDS Custom for Oracle only\) If you attached any additional EBS volumes, do either of the following: [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/custom-troubleshooting.html) | -| EBS\-optimized instances \(RDS Custom for Oracle only\): The EBS\-optimized attribute of Amazon EC2 instance \[i\-*xxxxxxxxxxxxxxxxx*\] has changed from \[enabled\] to \[disabled\]\. | Amazon EC2 instances should be EBS optimized\. If the `EBS-optimized` attribute is turned off \(`disabled`\), the support perimeter doesn't put the DB instance into the `unsupported-configuration` state\. | To turn on the `EBS-optimized` attribute: [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/custom-troubleshooting.html) | -| Amazon EC2 instance state: [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/custom-troubleshooting.html) | The support perimeter monitors EC2 instance state\-change notifications\. The EC2 instance must always be running\. | If the EC2 instance is stopped, start it and remount the binary and data volumes\. On RDS Custom for Oracle, if the EC2 instance is terminated, delete the RDS Custom DB instance\. On RDS Custom for SQL Server, if the EC2 instance is terminated, RDS Custom performs an automated recovery to provision a new EC2 instance\. | -| Amazon EC2 instance attributes: RDS Custom for Oracle: [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/custom-troubleshooting.html) RDS Custom for SQL Server: [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/custom-troubleshooting.html) | The support perimeter monitors the instance type of the EC2 instance where the RDS Custom DB instance is running\. The EC2 instance type must stay the same as when you set it up during RDS Custom DB instance creation\. | Change the EC2 instance type back to the original type using the EC2 console or CLI\. To change the instance type because of scaling requirements, do a PITR and specify the new instance type and class\. However, doing this results in a new RDS Custom DB instance with a new host and Domain Name System \(DNS\) name\. | -| Oracle Data Guard role \(RDS Custom for Oracle only\): [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/custom-troubleshooting.html) | The support perimeter monitors the current database role every 15 seconds and sends a CloudWatch notification if the database role has changed\. The Oracle Data Guard `DATABASE_ROLE` parameter must be either `PRIMARY` or `PHYSICAL STANDBY`\. | Restore the Oracle Data Guard database role to a supported value\. After the support perimeter determines that the database role is supported, the RDS Custom for Oracle DB instance becomes available within 15 seconds\. | -| Shared memory connections \(RDS Custom for SQL Server only\): The RDS Custom instance is going out of perimeter because an unsupported configuration was used for shared memory protocol\. | The RDS Custom agent on the EC2 host connects to SQL Server using the shared memory protocol\. If this protocol is turned off \(`Enabled` is set to `No`\), then RDS Custom can't perform its management actions and places the DB instance outside the support perimeter\. | To bring the RDS Custom for SQL Server DB instance back within the support perimeter, turn on the shared memory protocol on the **Protocol** page of the **Shared Memory Properties** window by setting `Enabled` to `Yes`\. Restart SQL Server after enabling the protocol\. | -| Database file locations \(RDS Custom for SQL Server only\): The RDS Custom instance is going out of perimeter because an unsupported configuration was used for database files location\. | All SQL Server database files are stored on the D: drive by default, in the `D:\rdsdbdata\DATA` directory\. If you create or alter the database file location to be anywhere other than the D: drive, then RDS Custom places the DB instance outside the support perimeter\. We strongly recommend that you don't save any database files on the C: drive\. You can lose data on the C: drive during certain operations, such as hardware failure\. Storage on the C: drive doesn't offer the same durability as on the D: drive, which is an EBS volume\. Also, if database files can't be found, RDS Custom places the DB instance outside the support perimeter\. | Store all RDS Custom for SQL Server database files on the D: drive\. | - -## How Amazon RDS Custom replaces an impaired host - -If the Amazon EC2 host becomes impaired, RDS Custom attempts to reboot it\. If this effort fails, RDS Custom uses the same stop and start feature included in Amazon EC2\. - -**Topics** -+ [Stopping and starting the host](#custom-troubleshooting.host-problems.replacement.stop-start) -+ [Effects of host replacement](#custom-troubleshooting.host-problems.replacement.host-state) -+ [Best practices for Amazon EC2 hosts](#custom-troubleshooting.host-problems.best-practices) - -### Stopping and starting the host - -RDS Custom automatically takes the following steps, with no user intervention required: - -1. Stops the Amazon EC2 host\. - - The EC2 instance performs a normal shutdown and stops running\. Any Amazon EBS volumes remain attached to the instance, and their data persists\. Any data stored in the instance store volumes \(not supported on RDS Custom\) or RAM of the host computer is gone\. - - For more information, see [Stop and start your instance](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/Stop_Start.html) in the *Amazon EC2 User Guide for Linux Instances*\. - -1. Starts the Amazon EC2 host\. - - The EC2 instance migrates to a new underlying host hardware\. In some cases, the RDS Custom DB instance remains on the original host\. - -### Effects of host replacement - -In RDS Custom, you have full control over the root device volume and Amazon EBS storage volumes\. The root volume can contain important data and configurations that you don't want to lose\. - -RDS Custom for Oracle retains all database and customer data after the operation, including root volume data\. No user intervention is required\. On RDS Custom for SQL Server, database data is retained, but any data on the C: drive, including operating system and customer data, is lost\. - -After the replacement process, the Amazon EC2 host has a new public IP address\. The host retains the following: -+ Instance ID -+ Private IP addresses -+ Elastic IP addresses -+ Instance metadata -+ Data storage volume data -+ Root volume data \(on RDS Custom for Oracle\) - -### Best practices for Amazon EC2 hosts - -The Amazon EC2 host replacement feature covers the majority of Amazon EC2 impairment scenarios\. We recommend that you adhere to the following best practices: -+ Before you change your configuration or the operating system, back up your data\. If the root volume or operating system becomes corrupt, host replacement can't repair it\. Your only options are restoring from a DB snapshot or point\-in\-time recovery\. -+ Don't manually stop or terminate the physical Amazon EC2 host\. Both actions result in the instance being put outside the RDS Custom support perimeter\. -+ \(RDS Custom for SQL Server\) If you attach additional volumes to the Amazon EC2 host, configure them to remount upon restart\. If the host is impaired, RDS Custom might stop and start the host automatically\. - -## Troubleshooting upgrades for RDS Custom for Oracle - -Your upgrade of an RDS Custom for Oracle instance might fail\. Following, you can find techniques that you can use during upgrades of RDS Custom DB for Oracle DB instances: -+ Examine the upgrade output log files in the `/tmp` directory on your DB instance\. The names of the logs depend on your DB engine version\. For example, you might see logs that contain the strings `catupgrd` or `catup`\. -+ Examine the `alert.log` file located in the `/rdsdbdata/log/trace` directory\. -+ Run the following `grep` command in the `root` directory to track the upgrade OS process\. This command shows where the log files are being written and determine the state of the upgrade process\. - - ``` - ps -aux | grep upg - ``` - - The following shows sample output\. - - ``` - root 18884 0.0 0.0 235428 8172 ? S< 17:03 0:00 /usr/bin/sudo -u rdsdb /rdsdbbin/scripts/oracle-control ORCL op_apply_upgrade_sh RDS-UPGRADE/2.upgrade.sh - rdsdb 18886 0.0 0.0 153968 12164 ? S< 17:03 0:00 /usr/bin/perl -T -w /rdsdbbin/scripts/oracle-control ORCL op_apply_upgrade_sh RDS-UPGRADE/2.upgrade.sh - rdsdb 18887 0.0 0.0 113196 3032 ? S< 17:03 0:00 /bin/sh /rdsdbbin/oracle/rdbms/admin/RDS-UPGRADE/2.upgrade.sh - rdsdb 18900 0.0 0.0 113196 1812 ? S< 17:03 0:00 /bin/sh /rdsdbbin/oracle/rdbms/admin/RDS-UPGRADE/2.upgrade.sh - rdsdb 18901 0.1 0.0 167652 20620 ? S< 17:03 0:07 /rdsdbbin/oracle/perl/bin/perl catctl.pl -n 4 -d /rdsdbbin/oracle/rdbms/admin -l /tmp catupgrd.sql - root 29944 0.0 0.0 112724 2316 pts/0 S+ 18:43 0:00 grep --color=auto upg - ``` -+ Run the following SQL query to verify the current state of the components to find the database version and the options installed on the DB instance\. - - ``` - SET LINESIZE 180 - COLUMN COMP_ID FORMAT A15 - COLUMN COMP_NAME FORMAT A40 TRUNC - COLUMN STATUS FORMAT A15 TRUNC - SELECT COMP_ID, COMP_NAME, VERSION, STATUS FROM DBA_REGISTRY ORDER BY 1; - ``` - - The output resembles the following\. - - ``` - COMP_NAME STATUS PROCEDURE - ---------------------------------------- -------------------- -------------------------------------------------- - Oracle Database Catalog Views VALID DBMS_REGISTRY_SYS.VALIDATE_CATALOG - Oracle Database Packages and Types VALID DBMS_REGISTRY_SYS.VALIDATE_CATPROC - Oracle Text VALID VALIDATE_CONTEXT - Oracle XML Database VALID DBMS_REGXDB.VALIDATEXDB - - 4 rows selected. - ``` -+ Run the following SQL query to check for invalid objects that might interfere with the upgrade process\. - - ``` - SET PAGES 1000 LINES 2000 - COL OBJECT FOR A40 - SELECT SUBSTR(OWNER,1,12) OWNER, - SUBSTR(OBJECT_NAME,1,30) OBJECT, - SUBSTR(OBJECT_TYPE,1,30) TYPE, STATUS, - CREATED - FROM DBA_OBJECTS - WHERE STATUS <>'VALID' - AND OWNER IN ('SYS','SYSTEM','RDSADMIN','XDB'); - ``` - -## Troubleshooting replica promotion for RDS Custom for Oracle - -You can promote managed Oracle replicas in RDS Custom for Oracle using the console, `promote-read-replica` AWS CLI command, or `PromoteReadReplica` API\. If you delete your primary DB instance, and all replicas are healthy, RDS Custom for Oracle promotes your managed replicas to standalone instances automatically\. If a replica has paused automation or is outside the support perimeter, you must fix the replica before RDS Custom can promote it automatically\. For more information, see [Replica promotion limitations for RDS Custom for Oracle](custom-rr.md#custom-rr.promotion-reqs)\. - -The replica promotion workflow might become stuck in the following situation: -+ The primary DB instance is in the state `STORAGE_FULL`\. -+ The primary DB can't archive all of its online redo logs\. -+ A gap exists between the archived redo log files on your Oracle replica and the primary database\. - -To respond to the stuck workflow, complete the following steps: - -1. Synchronize the redo log gap on your Oracle replica DB instance\. - -1. Force the promotion of your read replica to the latest applied redo log\. Run the following commands in SQL\*Plus: - - ``` - ALTER DATABASE ACTIVATE STANDBY DATABASE; - SHUTDOWN IMMEDIATE - STARTUP - ``` - -1. Contact AWS Support and request it to move your DB instance to available status\. \ No newline at end of file diff --git a/doc_source/custom-upgrading-sqlserver.md b/doc_source/custom-upgrading-sqlserver.md deleted file mode 100644 index 0f29184..0000000 --- a/doc_source/custom-upgrading-sqlserver.md +++ /dev/null @@ -1,7 +0,0 @@ -# Upgrading a DB instance for Amazon RDS Custom for SQL Server - -You can upgrade an Amazon RDS Custom for SQL Server DB instance by modifying it to use a new DB engine version, the same as you do for Amazon RDS\. - -The same limitations for upgrading an RDS Custom for SQL Server DB instance apply as for modifying an RDS Custom for SQL Server DB instance in general\. For more information, see [Modifying an RDS Custom for SQL Server DB instance](custom-managing-sqlserver.md#custom-managing.modify-sqlserver)\. - -For general information about upgrading DB instances, see [Upgrading a DB instance engine version](USER_UpgradeDBInstance.Upgrading.md)\. \ No newline at end of file diff --git a/doc_source/custom-upgrading.md b/doc_source/custom-upgrading.md deleted file mode 100644 index 7ea7fd7..0000000 --- a/doc_source/custom-upgrading.md +++ /dev/null @@ -1,230 +0,0 @@ -# Upgrading a DB instance for Amazon RDS Custom for Oracle - -You can upgrade an Amazon RDS Custom DB instance by modifying it to use a new custom engine version \(CEV\)\. For general information about upgrades, see [Upgrading a DB instance engine version](USER_UpgradeDBInstance.Upgrading.md)\. - -**Topics** -+ [Requirements and considerations for RDS Custom for Oracle upgrades](#custom-upgrading-considerations) -+ [Viewing valid upgrade targets for RDS Custom for Oracle DB instances](#custom-upgrading-target) -+ [Upgrading an RDS Custom DB instance](#custom-upgrading-modify) -+ [Viewing pending upgrades for RDS Custom DB instances](#custom-upgrading-pending) -+ [Troubleshooting an upgrade failure for an RDS Custom for Oracle DB instance](#custom-upgrading-failure) - -## Requirements and considerations for RDS Custom for Oracle upgrades - -Before upgrading your DB instance, note the following requirements: -+ You can upgrade your DB instance to a new CEV only if it already exists\. -+ You can upgrade your DB instance to a new CEV only if it uses the same installation parameter settings in the manifest\. For example, you can't upgrade a database that uses the default Oracle home to a CEV that uses a nondefault Oracle home\. -+ You can upgrade your DB instance to a new minor version only\. For example, you can't upgrade a DB instance using an Oracle Database 12c CEV to an Oracle Database 19c CEV\. - -Consider the following: -+ We strongly recommend that you upgrade your RDS Custom for Oracle DB instance using CEVs\. RDS Custom for Oracle automation synchronizes the patch metadata with the database binary on your DB instance\. - - In special circumstances, RDS Custom supports applying a "one\-off" patch directly to the underlying Amazon EC2 instance directly using OPATCH\. A valid use case might be a patch that you want to apply immediately, but the RDS Custom team is upgrading the CEV feature, causing a delay\. To apply a patch manually, perform the following steps: - - 1. Pause RDS Custom automation\. - - 1. Apply your patch to the database binaries on the Amazon EC2 instance\. - - 1. Resume RDS Custom automation\. - - A disadvantage of the preceding technique is that you must apply the patch manually to every instance that you want to upgrade\. In contrast, when you create a new CEV, you can create or upgrade multiple DB instances using the same CEV\. -+ When you upgrade your primary DB instance, RDS Custom for Oracle upgrades your read replicas automatically\. You don't have to upgrade read replicas manually\. -+ When you upgrade a CEV, RDS Custom deletes the data in the `bin` volume of your DB instance\. -+ When you upgrade a container database \(CDB\), RDS Custom for Oracle checks that all PDBs are open or could be opened\. If these conditions aren't met, RDS Custom stops the check and returns the database to its original state without attempting the upgrade\. If the conditions are met, RDS Custom patches the CDB root first, and then patches all other PDBs \(including `PDB$SEED`\) in parallel\. - - After the patching process completes, RDS Custom attempts to open all PDBs\. If any PDBs fail to open, you receive the following event: `The following PDBs failed to open: list-of-PDBs`\. If RDS Custom fails to patch the CDB root or any PDBs, the instance is put into the `PATCH_DB_FAILED` state\. -+ You might want to perform a major version upgrade and a conversion of non\-CDB to CDB at the same time\. In this case, we recommend that you complete this goal in the following process: - - 1. Create a new RDS Custom DB instance that uses the Oracle Multitenant architecture\. - - 1. Plug in a non\-CDB into your CDB root, creating it as a PDB\. Make sure that the non\-CDB is the same major version as your CDB\. - - 1. Convert your PDB by running the `noncdb_to_pdb.sql` Oracle script\. - - 1. Validate your CDB instance\. - - 1. Upgrade your CDB instance\. - -## Viewing valid upgrade targets for RDS Custom for Oracle DB instances - -You can see existing CEVs on the **Custom engine versions** page in the AWS Management Console\. - -You can also use the [describe\-db\-engine\-versions](https://docs.aws.amazon.com/cli/latest/reference/rds/describe-db-engine-versions.html) AWS CLI command to find valid upgrades for your DB instances, as shown in the following example\. This example assumes that a DB instance was created using the version 19\.my\_cev1, and that the upgrade versions 19\.my\_cev2 and 19\.my\_cev exist\. - -``` -aws rds describe-db-engine-versions --engine custom-oracle-ee --engine-version 19.my_cev1 -``` - -The output resembles the following\. - -``` -{ - "DBEngineVersions": [ - { - "Engine": "custom-oracle-ee", - "EngineVersion": "19.my_cev1", - ... - "ValidUpgradeTarget": [ - { - "Engine": "custom-oracle-ee", - "EngineVersion": "19.my_cev2", - "Description": "19.my_cev2 description", - "AutoUpgrade": false, - "IsMajorVersionUpgrade": false - }, - { - "Engine": "custom-oracle-ee", - "EngineVersion": "19.my_cev3", - "Description": "19.my_cev3 description", - "AutoUpgrade": false, - "IsMajorVersionUpgrade": false - } - ] - ... -``` - -## Upgrading an RDS Custom DB instance - -To upgrade your RDS Custom DB instance, you modify it to use a new CEV\. - -Read replicas managed by RDS Custom are automatically upgraded after the primary DB instance is upgraded\. - -### Console - -**To upgrade an RDS Custom DB instance** - -1. Sign in to the AWS Management Console and open the Amazon RDS console at [https://console\.aws\.amazon\.com/rds/](https://console.aws.amazon.com/rds/)\. - -1. In the navigation pane, choose **Databases**, and then choose the RDS Custom DB instance that you want to modify\. - -1. Choose **Modify**\. The **Modify DB instance** page appears\. - -1. For **DB engine version**, choose the CEV to upgrade to, such as `19.my_cev3`\. - -1. Choose **Continue** to check the summary of modifications\. - - Choose **Apply immediately** to apply the changes immediately\. - -1. If your changes are correct, choose **Modify DB instance**\. Or choose **Back** to edit your changes or **Cancel** to cancel your changes\. - -### AWS CLI - -To upgrade an RDS Custom DB instance, use the [modify\-db\-instance](https://docs.aws.amazon.com/cli/latest/reference/rds/modify-db-instance.html) AWS CLI command with the following parameters: -+ `--db-instance-identifier` – The DB instance to be upgraded -+ `--engine-version` – The new CEV -+ `--no-apply-immediately` \| `--apply-immediately` – Whether to perform the upgrade immediately or wait until the scheduled maintenance window - -The following example upgrades `my-custom-instance` to version `19.my_cev3`\. - -**Example** -For Linux, macOS, or Unix: - -``` -aws rds modify-db-instance \ - --db-instance-identifier my-custom-instance \ - --engine-version 19.my_cev3 \ - --apply-immediately -``` -For Windows: - -``` -aws rds modify-db-instance ^ - --db-instance-identifier my-custom-instance ^ - --engine-version 19.my_cev3 ^ - --apply-immediately -``` - -## Viewing pending upgrades for RDS Custom DB instances - -You can see pending upgrades for your Amazon RDS Custom DB instances by using the [describe\-db\-instances](https://docs.aws.amazon.com/cli/latest/reference/rds/describe-db-instances.html) or [describe\-pending\-maintenance\-actions](https://docs.aws.amazon.com/cli/latest/reference/rds/describe-pending-maintenance-actions.html) AWS CLI command\. - -However, this approach doesn't work if you used the `--apply-immediately` option or if the upgrade is in progress\. - -The following `describe-db-instances` command shows pending upgrades for `my-custom-instance`\. - -``` -aws rds describe-db-instances --db-instance-identifier my-custom-instance -``` - -The output resembles the following\. - -``` -{ - "DBInstances": [ - { - "DBInstanceIdentifier": "my-custom-instance", - "EngineVersion": "19.my_cev1", - ... - "PendingModifiedValues": { - "EngineVersion": "19.my_cev3" - ... - } - } - ] -} -``` - -The following shows use of the `describe-pending-maintenance-actions` command\. - -``` -aws rds describe-pending-maintenance-actions -``` - -The output resembles the following\. - -``` -{ - "PendingMaintenanceActions": [ - { - "ResourceIdentifier": "arn:aws:rds:us-west-2:123456789012:instance:my-custom-instance", - "PendingMaintenanceActionDetails": [ - { - "Action": "db-upgrade", - "Description": "Upgrade to 19.my_cev3" - } - ] - } - ] -} -``` - -## Troubleshooting an upgrade failure for an RDS Custom for Oracle DB instance - -If an RDS Custom DB instance upgrade fails, an RDS event is generated and the DB instance status becomes `upgrade-failed`\. - -You can see this status by using the [describe\-db\-instances](https://docs.aws.amazon.com/cli/latest/reference/rds/describe-db-instances.html) AWS CLI command, as shown in the following example\. - -``` -aws rds describe-db-instances --db-instance-identifier my-custom-instance -``` - -The output resembles the following\. - -``` -{ - "DBInstances": [ - { - "DBInstanceIdentifier": "my-custom-instance", - "EngineVersion": "19.my_cev1", - ... - "PendingModifiedValues": { - "EngineVersion": "19.my_cev3" - ... - } - "DBInstanceStatus": "upgrade-failed" - } - ] -} -``` - -After an upgrade failure, all database actions are blocked except for modifying the DB instance to perform the following tasks: -+ Retrying the same upgrade -+ Pausing and resuming RDS Custom automation -+ Point\-in\-time recovery \(PITR\) -+ Deleting the DB instance - -**Note** -If automation has been paused for the RDS Custom DB instance, you can't retry the upgrade until you resume automation\. -The same actions apply to an upgrade failure for an RDS\-managed read replica as for the primary\. - -For more information, see [Troubleshooting upgrades for RDS Custom for Oracle](custom-troubleshooting.md#custom-troubleshooting-upgrade)\. \ No newline at end of file diff --git a/doc_source/custom-viewing-sqlserver.md b/doc_source/custom-viewing-sqlserver.md deleted file mode 100644 index 31c7917..0000000 --- a/doc_source/custom-viewing-sqlserver.md +++ /dev/null @@ -1,65 +0,0 @@ -# Viewing CEV details for Amazon RDS Custom for SQL Server - -You can view details about your CEV by using the AWS Management Console or the AWS CLI\. - -## Console - -**To view CEV details** - -1. Sign in to the AWS Management Console and open the Amazon RDS console at [https://console\.aws\.amazon\.com/rds/](https://console.aws.amazon.com/rds/)\. - -1. In the navigation pane, choose **Custom engine versions**\. - - The **Custom engine versions** page shows all CEVs that currently exist\. If you haven't created any CEVs, the page is empty\. - -1. Choose the name of the CEV that you want to view\. - -1. Choose **Configuration** to view the details\. -![\[View the configuration details for a CEV.\]](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/images/rds_custom_sqlserver_cev_viewdetails.PNG) - -## AWS CLI - -To view details about a CEV by using the AWS CLI, run the [describe\-db\-engine\-versions](https://docs.aws.amazon.com/cli/latest/reference/rds/describe-db-engine-versions.html) command\. - -You can also specify the following options: -+ `--include-all`, to view all CEVs with any lifecycle state\. Without the `--include-all` option, only the CEVs in an `available` lifecycle state will be returned\. - -``` -aws rds describe-db-engine-versions --engine custom-sqlserver-ee --engine-version 15.00.4249.2.my_cevtest --include-all -{ - "DBEngineVersions": [ - { - "Engine": "custom-sqlserver-ee", - "MajorEngineVersion": "15.00", - "EngineVersion": "15.00.4249.2.my_cevtest", - "DBParameterGroupFamily": "custom-sqlserver-ee-15.0", - "DBEngineDescription": "Microsoft SQL Server Enterprise Edition for custom RDS", - "DBEngineVersionArn": "arn:aws:rds:us-east-1:{my-account-id}:cev:custom-sqlserver-ee/15.00.4249.2.my_cevtest/a1234a1-123c-12rd-bre1-1234567890", - "DBEngineVersionDescription": "Custom SQL Server EE 15.00.4249.2 cev test", - "Image": { - "ImageId": "ami-0r93cx31t5r596482", - "Status": "pending-validation" - }, - "DBEngineMediaType": "AWS Provided", - "CreateTime": "2022-11-20T19:30:01.831000+00:00", - "ValidUpgradeTarget": [], - "SupportsLogExportsToCloudwatchLogs": false, - "SupportsReadReplica": false, - "SupportedFeatureNames": [], - "Status": "pending-validation", - "SupportsParallelQuery": false, - "SupportsGlobalDatabases": false, - "TagList": [], - "SupportsBabelfish": false - } - ] -} -``` - -You can use filters to view CEVs with a certain lifecycle status\. For example, to view CEVs that have a lifecycle status of either `pending-validation`, `available`, or `failed`: - -``` -aws rds describe-db-engine-versions engine custom-sqlserver-ee - region us-west-2 include-all query 'DBEngineVersions[?Status == pending-validation || - Status == available || Status == failed]' -``` \ No newline at end of file diff --git a/doc_source/cw-metrics-overview.md b/doc_source/cw-metrics-overview.md deleted file mode 100644 index f111a56..0000000 --- a/doc_source/cw-metrics-overview.md +++ /dev/null @@ -1,23 +0,0 @@ -# Overview of Amazon RDS and Amazon CloudWatch - -By default, Amazon RDS automatically sends metric data to CloudWatch in 1\-minute periods\. For example, the `CPUUtilization` metric records the percentage of CPU utilization for a DB instance over time\. Data points with a period of 60 seconds \(1 minute\) are available for 15 days\. This means that you can access historical information and see how your web application or service is performing\. - -As shown in the following diagram, you can set up alarms for your CloudWatch metrics\. For example, you might create an alarm that signals when the CPU utilization for an instance is over 70%\. You can configure Amazon Simple Notification Service to email you when the threshold is passed\. - -![\[RDS metrics in AWS CloudWatch\]](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/images/rds-cloudwatch.png) - -Amazon RDS publishes the following types of metrics to Amazon CloudWatch: -+ Metrics for your RDS DB instances - - For a table of these metrics, see [Amazon CloudWatch metrics for Amazon RDS](rds-metrics.md)\. -+ Performance Insights metrics - - For a table of these metrics, see [Amazon CloudWatch metrics for Performance Insights](USER_PerfInsights.Cloudwatch.md) and [Performance Insights counter metrics](USER_PerfInsights_Counters.md)\. -+ Enhanced Monitoring metrics \(published to Amazon CloudWatch Logs\) - - For a table of these metrics, see [OS metrics in Enhanced Monitoring](USER_Monitoring-Available-OS-Metrics.md)\. -+ Usage metrics for the Amazon RDS service quotas in your AWS account - - For a table of these metrics, see [Amazon CloudWatch usage metrics for Amazon RDS](rds-metrics.md#rds-metrics-usage)\. For more information about Amazon RDS quotas, see [Quotas and constraints for Amazon RDS](CHAP_Limits.md)\. - -For more information about CloudWatch, see [ What is Amazon CloudWatch?](https://docs.aws.amazon.com/AmazonCloudWatch/latest/DeveloperGuide/WhatIsCloudWatch.html) in the *Amazon CloudWatch User Guide*\. For more information about CloudWatch metrics retention, see [Metrics retention](https://docs.aws.amazon.com/AmazonCloudWatch/latest/DeveloperGuide/cloudwatch_concepts.html#metrics-retention)\. \ No newline at end of file diff --git a/doc_source/database-authentication.md b/doc_source/database-authentication.md deleted file mode 100644 index 6952125..0000000 --- a/doc_source/database-authentication.md +++ /dev/null @@ -1,53 +0,0 @@ -# Database authentication with Amazon RDS - -Amazon RDS supports several ways to authenticate database users\. - -Password, Kerberos, and IAM database authentication use different methods of authenticating to the database\. Therefore, a specific user can log in to a database using only one authentication method\. - -For PostgreSQL, use only one of the following role settings for a user of a specific database: -+ To use IAM database authentication, assign the `rds_iam` role to the user\. -+ To use Kerberos authentication, assign the `rds_ad` role to the user\. -+ To use password authentication, don't assign either the `rds_iam` or `rds_ad` roles to the user\. - -Don't assign both the `rds_iam` and `rds_ad` roles to a user of a PostgreSQL database either directly or indirectly by nested grant access\. If the `rds_iam` role is added to the master user, IAM authentication takes precedence over password authentication so the master user has to log in as an IAM user\. - -**Important** -We strongly recommend that you do not use the master user directly in your applications\. Instead, adhere to the best practice of using a database user created with the minimal privileges required for your application\. - -**Topics** -+ [Password authentication](#password-authentication) -+ [IAM database authentication](#iam-database-authentication) -+ [Kerberos authentication](#kerberos-authentication) - -## Password authentication - -With *password authentication,* your database performs all administration of user accounts\. You create users with SQL statements such as `CREATE USER`, with the appropriate clause required by the DB engine for specifying passwords\. For example, in MySQL the statement is `CREATE USER` *name* `IDENTIFIED BY` *password*, while in PostgreSQL, the statement is `CREATE USER` *name* `WITH PASSWORD` *password*\. - -With password authentication, your database controls and authenticates user accounts\. If a DB engine has strong password management features, they can enhance security\. Database authentication might be easier to administer using password authentication when you have small user communities\. Because clear text passwords are generated in this case, integrating with AWS Secrets Manager can enhance security\. - -For information about using Secrets Manager with Amazon RDS, see [Creating a basic secret](https://docs.aws.amazon.com/secretsmanager/latest/userguide/manage_create-basic-secret.html) and [Rotating secrets for supported Amazon RDS databases](https://docs.aws.amazon.com/secretsmanager/latest/userguide/rotating-secrets-rds.html) in the *AWS Secrets Manager User Guide*\. For information about programmatically retrieving your secrets in your custom applications, see [Retrieving the secret value](https://docs.aws.amazon.com/secretsmanager/latest/userguide/manage_retrieve-secret.html) in the *AWS Secrets Manager User Guide*\. - -## IAM database authentication - -You can authenticate to your DB instance using AWS Identity and Access Management \(IAM\) database authentication\. IAM database authentication works with MySQL and PostgreSQL\. With this authentication method, you don't need to use a password when you connect to a DB instance\. Instead, you use an authentication token\. - -For more information about IAM database authentication, including information about availability for specific DB engines, see [IAM database authentication for MariaDB, MySQL, and PostgreSQL](UsingWithRDS.IAMDBAuth.md)\. - -## Kerberos authentication - -Amazon RDS supports external authentication of database users using Kerberos and Microsoft Active Directory\. Kerberos is a network authentication protocol that uses tickets and symmetric\-key cryptography to eliminate the need to transmit passwords over the network\. Kerberos has been built into Active Directory and is designed to authenticate users to network resources, such as databases\. - -Amazon RDS support for Kerberos and Active Directory provides the benefits of single sign\-on and centralized authentication of database users\. You can keep your user credentials in Active Directory\. Active Directory provides a centralized place for storing and managing credentials for multiple DB instances\. - -You can make it possible for your database users to authenticate against DB instances in two ways\. They can use credentials stored either in AWS Directory Service for Microsoft Active Directory or in your on\-premises Active Directory\. - -Microsoft SQL Server and PostgreSQL DB instances support one\- and two\-way forest trust relationships\. Oracle DB instances support one\- and two\-way external and forest trust relationships\. For more information, see [When to create a trust relationship](https://docs.aws.amazon.com/directoryservice/latest/admin-guide/setup_trust.html) in the *AWS Directory Service Administration Guide*\. - -For information about Kerberos authentication with a specific DB engine, see the following: -+ [Using Windows Authentication with an Amazon RDS for SQL Server DB instance](USER_SQLServerWinAuth.md) -+ [Using Kerberos authentication for MySQL](mysql-kerberos.md) -+ [Configuring Kerberos authentication for Amazon RDS for Oracle](oracle-kerberos.md) -+ [Using Kerberos authentication with Amazon RDS for PostgreSQL](postgresql-kerberos.md) - -**Note** -Currently, Kerberos authentication isn't supported for MariaDB DB instances\. \ No newline at end of file diff --git a/doc_source/devops-guru-for-rds.md b/doc_source/devops-guru-for-rds.md deleted file mode 100644 index d301a1e..0000000 --- a/doc_source/devops-guru-for-rds.md +++ /dev/null @@ -1,235 +0,0 @@ -# Analyzing performance anomalies with Amazon DevOps Guru for Amazon RDS - -Amazon DevOps Guru is a fully managed operations service that helps developers and operators improve the performance and availability of their applications\. DevOps Guru offloads the tasks associated with identifying operational issues so that you can quickly implement recommendations to improve your application\. For more information, see [What is Amazon DevOps Guru?](https://docs.aws.amazon.com/devops-guru/latest/userguide/welcome.html) in the *Amazon DevOps Guru User Guide*\. - -DevOps Guru detects, analyzes, and makes recommendations for existing operational issues for all Amazon RDS DB engines\. DevOps Guru for RDS extends this capability by applying machine learning to Performance Insights metrics for RDS for PostgreSQL databases\. These monitoring features allow DevOps Guru for RDS to detect and diagnose performance bottlenecks and recommend specific corrective actions\. DevOps Guru for RDS can also detect problematic conditions in your RDS for PostgreSQL database before they occur\. - -The following video is an overview of DevOps Guru for RDS\. - -[![AWS Videos](http://img.youtube.com/vi/N3NNYgzYUDA/0.jpg)](http://www.youtube.com/watch?v=N3NNYgzYUDA) - -For a deep dive on this subject, see [Amazon DevOps Guru for RDS under the hood\.](http://aws.amazon.com/blogs/database/amazon-devops-guru-for-rds-under-the-hood/) - -**Topics** -+ [Benefits of DevOps Guru for RDS](#devops-guru-for-rds.benefits) -+ [How DevOps Guru for RDS works](#devops-guru-for-rds.how-it-works) -+ [Setting up DevOps Guru for RDS](#devops-guru-for-rds.configuring) - -## Benefits of DevOps Guru for RDS - -If you're responsible for RDS for PostgreSQL database, you might not know that an event or regression that is affecting that database is occurring\. When you learn about the issue, you might not know why it's occurring or what to do about it\. Rather than turning to a database administrator \(DBA\) for help or relying on third\-party tools, you can follow recommendations from DevOps Guru for RDS\. - -You gain the following advantages from the detailed analysis of DevOps Guru for RDS: - -**Fast diagnosis** -DevOps Guru for RDS continuously monitors and analyzes database telemetry\. Performance Insights, Enhanced Monitoring, and Amazon CloudWatch collect telemetry data for your database instance\. DevOps Guru for RDS uses statistical and machine learning techniques to mine this data and detect anomalies\. To learn more about telemetry data, see [Monitoring DB load with Performance Insights on Amazon RDS](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_PerfInsights.html) and [Monitoring OS metrics with Enhanced Monitoring](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Monitoring.OS.html) in the *Amazon RDS User Guide*\. - -**Fast resolution** -Each anomaly identifies the performance issue and suggests avenues of investigation or corrective actions\. For example, DevOps Guru for RDS might recommend that you investigate specific wait events\. Or it might recommend that you tune your application pool settings to limit the number of database connections\. Based on these recommendations, you can resolve performance issues more quickly than by troubleshooting manually\. - -**Proactive insights** -DevOps Guru for RDS uses metrics from your resources to detect potentially problematic behavior before it becomes a bigger problem\. For example, it can detect when your database is using an increasing number of on\-disk temporary tables, which could start to impact performance\. DevOps Guru then provides recommendations to help you address issues before they become bigger problems\. - -**Deep knowledge of Amazon engineers and machine learning** -To detect performance issues and help you resolve bottlenecks, DevOps Guru for RDS relies on machine learning \(ML\) and advanced mathematical formulas\. Amazon database engineers contributed to the development of the DevOps Guru for RDS findings, which encapsulate many years of managing hundreds of thousands of databases\. By drawing on this collective knowledge, DevOps Guru for RDS can teach you best practices\. - -## How DevOps Guru for RDS works - -DevOps Guru for RDS collects data about your RDS for PostgreSQL databases from Amazon RDS Performance Insights\. The most important metric is `DBLoad`\. DevOps Guru for RDS consumes the Performance Insights metrics, analyzes them with machine learning, and publishes insights to the dashboard\. - -An *insight* is a collection of related anomalies that were detected by DevOps Guru\. - -In DevOps Guru for RDS, an *anomaly* is a pattern that deviates from what is considered normal performance for your RDS for PostgreSQL database\. - -### Proactive insights - -A *proactive insight* lets you know about problematic behavior before it occurs\. It contains anomalies with recommendations and related metrics to help you address issues in your RDS for PostgreSQL databases before become bigger problems\. These insights are published in the DevOps Guru dashboard\. - -For example, DevOps Guru might detect that your RDS for PostgreSQL database is creating many on\-disk temporary tables\. If not addressed, this trend might lead to performance issues\. Each proactive insight includes recommendations for corrective behavior and links to relevant topics in [Tuning RDS for PostgreSQL with Amazon DevOps Guru proactive insights](PostgreSQL.Tuning_proactive_insights.md)\. For more information, see [Working with insights in DevOps Guru](https://docs.aws.amazon.com/devops-guru/latest/userguide/working-with-insights.html) in the *Amazon DevOps Guru User Guide*\. - -### Reactive insights - -A *reactive insight* identifies anomalous behavior as it occurs\. If DevOps Guru for RDS finds performance issues in your RDS for PostgreSQL DB instances, it publishes a reactive insight in the DevOps Guru dashboard\. For more information, see [Working with insights in DevOps Guru](https://docs.aws.amazon.com/devops-guru/latest/userguide/working-with-insights.html) in the *Amazon DevOps Guru User Guide*\. - -#### Causal anomalies - -A *causal anomaly* is a top\-level anomaly within a reactive insight\. **Database load \(DB load\)** is the causal anomaly for DevOps Guru for RDS\. - -An anomaly measures performance impact by assigning a severity level of **High**, **Medium**, or **Low**\. To learn more, see [Key concepts for DevOps Guru for RDS](https://docs.aws.amazon.com/devops-guru/latest/userguide/working-with-rds.overview.definitions.html) in the *Amazon DevOps Guru User Guide*\. - -If DevOps Guru detects a current anomaly on your DB instance, you're alerted in the **Databases** page of the RDS console\. The console also alerts you to anomalies that occurred in the past 24 hours\. To go to the anomaly page from the RDS console, choose the link in the alert message\. The RDS console also alerts you in the page for your RDS for PostgreSQL DB instance\. - -#### Contextual anomalies - -A *contextual anomaly* is a finding within **Database load \(DB load\)** that is related to a reactive insight\. Each contextual anomaly describes a specific RDS for PostgreSQL performance issue that requires investigation\. For example, DevOps Guru for RDS might recommend that you consider increasing CPU capacity or investigate wait events that are contributing to DB load\. - -**Important** -We recommend that you test any changes on a test instance before modifying a production instance\. In this way, you understand the impact of the change\. - -To learn more, see [Analyzing anomalies in Amazon RDS](https://docs.aws.amazon.com/devops-guru/latest/userguide/working-with-rds.analyzing.html) in the *Amazon DevOps Guru User Guide*\. - -## Setting up DevOps Guru for RDS - -To allow DevOps Guru for Amazon RDS to publish insights for a RDS for PostgreSQL database, complete the following tasks\. - -**Topics** -+ [Configuring IAM access policies for DevOps Guru for RDS](#devops-guru-for-rds.configuring.access) -+ [Turning on Performance Insights for your RDS for PostgreSQL DB instances](#devops-guru-for-rds.configuring.performance-insights) -+ [Turning on DevOps Guru and specifying resource coverage](#devops-guru-for-rds.configuring.coverage) - -### Configuring IAM access policies for DevOps Guru for RDS - -To view alerts from DevOps Guru in the RDS console, your AWS Identity and Access Management \(IAM\) user or role must have either of the following policies: -+ The AWS managed policy `AmazonDevOpsGuruConsoleFullAccess` -+ The AWS managed policy `AmazonDevOpsGuruConsoleReadOnlyAccess` and either of the following policies: - + The AWS managed policy `AmazonRDSFullAccess` - + A customer managed policy that includes `pi:GetResourceMetrics` and `pi:DescribeDimensionKeys` - -For more information, see [Configuring access policies for Performance Insights](USER_PerfInsights.access-control.md)\. - -### Turning on Performance Insights for your RDS for PostgreSQL DB instances - -DevOps Guru for RDS relies on Performance Insights for its data\. Without Performance Insights, DevOps Guru publishes anomalies, but doesn't include the detailed analysis and recommendations\. - -When you create or modify a RDS for PostgreSQL DB instance, you can turn on Performance Insights\. For more information, see [Turning Performance Insights on and off](USER_PerfInsights.Enabling.md)\. - -### Turning on DevOps Guru and specifying resource coverage - -You can turn on DevOps Guru to have it monitor your RDS for PostgreSQL databases in either of the following ways\. - -**Topics** -+ [Turning on DevOps Guru in the RDS console](#devops-guru-for-rds.configuring.coverage.rds-console) -+ [Adding RDS for PostgreSQL resources in the DevOps Guru console](#devops-guru-for-rds.configuring.coverage.guru-console) -+ [Adding RDS for PostgreSQL resources using AWS CloudFormation](#devops-guru-for-rds.configuring.coverage.cfn) - -#### Turning on DevOps Guru in the RDS console - -You can take multiple paths in the Amazon RDS console to turn on DevOps Guru\. - -**Topics** -+ [Turning on DevOps Guru when you create an RDS for PostgreSQL database](#devops-guru-for-rds.configuring.coverage.rds-console.create) -+ [Turning on DevOps Guru from the notification banner](#devops-guru-for-rds.configuring.coverage.rds-console.existing) -+ [Responding to a permissions error when you turn on DevOps Guru](#devops-guru-for-rds.configuring.coverage.rds-console.error) - -##### Turning on DevOps Guru when you create an RDS for PostgreSQL database - -The creation workflow includes a setting that turns on DevOps Guru coverage for your database\. This setting is turned on by default when you choose the **Production** template\. - -**To turn on DevOps Guru when you create an RDS for PostgreSQL database** - -1. Sign in to the AWS Management Console and open the Amazon RDS console at [https://console\.aws\.amazon\.com/rds/](https://console.aws.amazon.com/rds/)\. - -1. Follow the steps in [Creating a DB instance](USER_CreateDBInstance.md#USER_CreateDBInstance.Creating), up to but not including the step where you choose monitoring settings\. - -1. In **Monitoring**, choose **Turn on Performance Insights**\. For DevOps Guru for RDS to provide detailed analysis of performance anomalies, Performance Insights must be turned on\. - -1. Choose **Turn on DevOps Guru**\. -![\[Turn on DevOps Guru when you create a DB instance\]](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/images/devops-guru-enable-create.png) - -1. Create a tag for your database so that DevOps Guru can monitor it\. Do the following: - + In the text field for **Tag key**, enter a name that begins with **Devops\-Guru\-**\. - + In the text field for **Tag value**, enter any value\. For example, if you enter **rds\-database\-1** for the name of your RDS for PostgreSQL database, you can also enter **rds\-database\-1** as the tag value\. - - For more information about tags, see "[Use tags to identify resources in your DevOps Guru applications](https://docs.aws.amazon.com/devops-guru/latest/userguide/working-with-resource-tags.html)" in the *Amazon DevOps Guru User Guide*\. - -1. Complete the remaining steps in [Creating a DB instance](USER_CreateDBInstance.md#USER_CreateDBInstance.Creating)\. - -##### Turning on DevOps Guru from the notification banner - -If your resources aren't covered by DevOps Guru, Amazon RDS notifies you with a banner in the following locations: -+ The **Monitoring** tab of a DB cluster instance -+ The Performance Insights dashboard - -![\[DevOps Guru banner\]](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/images/devops-guru-enable-banner.png) - -**To turn on DevOps Guru for your RDS for PostgreSQL database** - -1. In the banner, choose **Turn on DevOps Guru for RDS**\. - -1. Enter a tag key name and value\. For more information about tags, see "[Use tags to identify resources in your DevOps Guru applications](https://docs.aws.amazon.com/devops-guru/latest/userguide/working-with-resource-tags.html)" in the *Amazon DevOps Guru User Guide*\. -![\[Turn on DevOps Guru in the RDS console\]](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/images/devops-guru-turn-on.png) - -1. Choose **Turn on DevOps Guru**\. - -##### Responding to a permissions error when you turn on DevOps Guru - -If you turn on DevOps Guru from the RDS console when you create a database, RDS might display the following banner about missing permissions\. - -![\[Image NOT FOUND\]](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/images/devops-guru-permissions-error.png) - -**To respond to a permissions error** - -1. Grant your IAM user or role the user managed role `AmazonDevOpsGuruConsoleFullAccess`\. For more information, see [Configuring IAM access policies for DevOps Guru for RDS](#devops-guru-for-rds.configuring.access)\. - -1. Open the RDS console\. - -1. In the navigation pane, choose **Performance Insights**\. - -1. Choose a DB instance in the cluster that you just created\. - -1. Turn on **DevOps Guru for RDS**\. -![\[Image NOT FOUND\]](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/images/devops-guru-pi-toggle-off.png) - -1. Choose a tag value\. For more information, see "[Use tags to identify resources in your DevOps Guru applications](https://docs.aws.amazon.com/devops-guru/latest/userguide/working-with-resource-tags.html)" in the *Amazon DevOps Guru User Guide*\. -![\[Image NOT FOUND\]](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/images/devops-guru-turn-on.png) - -1. Choose **Turn on DevOps Guru**\. - -#### Adding RDS for PostgreSQL resources in the DevOps Guru console - -You can specify your DevOps Guru resource coverage on the DevOps Guru console\. Follow the step described in [Specify your DevOps Guru resource coverage](https://docs.aws.amazon.com/devops-guru/latest/userguide/choose-coverage.html) in the *Amazon DevOps Guru User Guide*\. When you edit your analyzed resources, choose one of the following options: -+ Choose **All account resources** to analyze all supported resources, including the RDS for PostgreSQL databases, in your AWS account and Region\. -+ Choose **CloudFormation stacks** to analyze the RDS for PostgreSQL databases that are in stacks you choose\. For more information, see [Use AWS CloudFormation stacks to identify resources in your DevOps Guru applications](https://docs.aws.amazon.com/devops-guru/latest/userguide/working-with-cfn-stacks.html) in the *Amazon DevOps Guru User Guide*\. -+ Choose **Tags** to analyze the RDS for PostgreSQL databases that you have tagged\. For more information, see [Use tags to identify resources in your DevOps Guru applications](https://docs.aws.amazon.com/devops-guru/latest/userguide/working-with-resource-tags.html) in the *Amazon DevOps Guru User Guide*\. - -For more information, see [Enable DevOps Guru](https://docs.aws.amazon.com/devops-guru/latest/userguide/getting-started-enable-service.html) in the *Amazon DevOps Guru User Guide*\. - -#### Adding RDS for PostgreSQL resources using AWS CloudFormation - -You can use tags to add coverage for your RDS for PostgreSQL resources to your CloudFormation templates\. The following procedure assumes that you have a CloudFormation template both for your RDS for PostgreSQL DB instance and DevOps Guru stack\. - -**To specify an RDS for PostgreSQL DB instance using a CloudFormation tag** - -1. In the CloudFormation template for your DB instance, define a tag using a key/value pair\. - - The following example assigns the value `my-db-instance1` to `Devops-guru-cfn-default` for an RDS for PostgreSQL DB instance\. - - ``` - MyDBInstance1: - Type: "AWS::RDS::DBInstance" - Properties: - DBInstanceIdentifier: my-db-instance1 - Tags: - - Key: Devops-guru-cfn-default - Value: devopsguru-my-db-instance1 - ``` - -1. In the CloudFormation template for your DevOps Guru stack, specify the same tag in your resource collection filter\. - - The following example configures DevOps Guru to provide coverage for the resource with the tag value `my-db-instance1`\. - - ``` - DevOpsGuruResourceCollection: - Type: AWS::DevOpsGuru::ResourceCollection - Properties: - ResourceCollectionFilter: - Tags: - - AppBoundaryKey: "Devops-guru-cfn-default" - TagValues: - - "devopsguru-my-db-instance1" - ``` - - The following example provides coverage for all resources within the application boundary `Devops-guru-cfn-default`\. - - ``` - DevOpsGuruResourceCollection: - Type: AWS::DevOpsGuru::ResourceCollection - Properties: - ResourceCollectionFilter: - Tags: - - AppBoundaryKey: "Devops-guru-cfn-default" - TagValues: - - "*" - ``` - -For more information, see [AWS::DevOpsGuru::ResourceCollection](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-devopsguru-resourcecollection.html) and [AWS::RDS::DBInstance](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbinstance.html) in the *AWS CloudFormation User Guide*\. \ No newline at end of file diff --git a/doc_source/dimensions.md b/doc_source/dimensions.md deleted file mode 100644 index 7b85f7a..0000000 --- a/doc_source/dimensions.md +++ /dev/null @@ -1,11 +0,0 @@ -# Amazon CloudWatch dimensions for Amazon RDS - -You can filter Amazon RDS metrics data by using any dimension in the following table\. - - -| Dimension | Filters the requested data for \. \. \. | -| --- | --- | -| DBInstanceIdentifier | A specific DB instance\. | -| DatabaseClass | All instances in a database class\. For example, you can aggregate metrics for all instances that belong to the database class `db.r5.large`\. | -| EngineName | The identified engine name only\. For example, you can aggregate metrics for all instances that have the engine name `postgres`\. | -| SourceRegion | The specified Region only\. For example, you can aggregate metrics for all DB instances in the `us-east-1` Region\. | \ No newline at end of file diff --git a/doc_source/disaster-recovery-resiliency.md b/doc_source/disaster-recovery-resiliency.md deleted file mode 100644 index d23ba61..0000000 --- a/doc_source/disaster-recovery-resiliency.md +++ /dev/null @@ -1,29 +0,0 @@ -# Resilience in Amazon RDS - -The AWS global infrastructure is built around AWS Regions and Availability Zones\. AWS Regions provide multiple physically separated and isolated Availability Zones, which are connected with low\-latency, high\-throughput, and highly redundant networking\. With Availability Zones, you can design and operate applications and databases that automatically fail over between Availability Zones without interruption\. Availability Zones are more highly available, fault tolerant, and scalable than traditional single or multiple data center infrastructures\. - -For more information about AWS Regions and Availability Zones, see [AWS global infrastructure](https://aws.amazon.com/about-aws/global-infrastructure/)\. - -In addition to the AWS global infrastructure, Amazon RDS offers features to help support your data resiliency and backup needs\. - -## Backup and restore - -Amazon RDS creates and saves automated backups of your DB instance\. Amazon RDS creates a storage volume snapshot of your DB instance, backing up the entire DB instance and not just individual databases\. - -Amazon RDS creates automated backups of your DB instance during the backup window of your DB instance\. Amazon RDS saves the automated backups of your DB instance according to the backup retention period that you specify\. If necessary, you can recover your database to any point in time during the backup retention period\. You can also back up your DB instance manually, by manually creating a DB snapshot\. - -You can create a DB instance by restoring from this DB snapshot as a disaster recovery solution if the source DB instance fails\. - -For more information, see [Backing up and restoring](CHAP_CommonTasks.BackupRestore.md)\. - -## Replication - -Amazon RDS uses the MariaDB, MySQL, Oracle, and PostgreSQL DB engines' built\-in replication functionality to create a special type of DB instance called a read replica from a source DB instance\. Updates made to the source DB instance are asynchronously copied to the read replica\. You can reduce the load on your source DB instance by routing read queries from your applications to the read replica\. Using read replicas, you can elastically scale out beyond the capacity constraints of a single DB instance for read\-heavy database workloads\. You can promote a read replica to a standalone instance as a disaster recovery solution if the source DB instance fails\. For some DB engines, Amazon RDS also supports other replication options\. - -For more information, see [Working with DB instance read replicas](USER_ReadRepl.md)\. - -## Failover - -Amazon RDS provides high availability and failover support for DB instances using Multi\-AZ deployments\. Amazon RDS uses several different technologies to provide failover support\. Multi\-AZ deployments for Oracle, PostgreSQL, MySQL, and MariaDB DB instances use Amazon's failover technology\. SQL Server DB instances use SQL Server Database Mirroring \(DBM\)\. - -For more information, see [Configuring and managing a Multi\-AZ deployment](Concepts.MultiAZ.md)\. \ No newline at end of file diff --git a/doc_source/ec2-rds-connect.md b/doc_source/ec2-rds-connect.md deleted file mode 100644 index eee7b79..0000000 --- a/doc_source/ec2-rds-connect.md +++ /dev/null @@ -1,127 +0,0 @@ -# Connecting an EC2 instance and a DB instance automatically - -You can use the RDS console to simplify setting up a connection between an EC2 instance and a DB instance\. Often, your DB instance is in a private subnet and your EC2 instance is in a public subnet within a VPC\. You can use a SQL client on your EC2 instance to connect to your DB instance\. The EC2 instance can also run web servers or applications that access your private DB instance\. For instructions about setting up a connection between an EC2 instance and a Multi\-AZ DB cluster, see [Connecting an EC2 instance and a Multi\-AZ DB cluster automatically](multiaz-ec2-rds-connect.md)\. - -![\[Automatically connect a DB instance with an EC2 instance.\]](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/images/auto-connect-rds-ec2.png) - -If you want to connect to an EC2 instance that isn't in the same VPC as the DB instance, see the scenarios in [Scenarios for accessing a DB instance in a VPC](USER_VPC.Scenarios.md)\. - -**Topics** -+ [Overview of automatic connectivity with an EC2 instance](#ec2-rds-connect-overview) -+ [Connecting an EC2 instance and an RDS database automatically](#ec2-rds-connect-connecting) -+ [Viewing connected compute resources](#ec2-rds-connect-viewing) -+ [Connecting to a DB instance that is running a specific DB engine](#ec2-rds-Connect-DBEngine) - -## Overview of automatic connectivity with an EC2 instance - -When you set up a connection between an EC2 instance and an RDS database automatically, RDS configures the VPC security group for your EC2 instance and for your RDS database\. - -The following are requirements for connecting an EC2 instance with an RDS database: -+ The EC2 instance must exist in the same VPC as the RDS database\. - - If no EC2 instances exist in the same VPC, the console provides a link to create one\. -+ The user who is setting up connectivity must have permissions to perform the following EC2 operations: - + `ec2:AuthorizeSecurityGroupEgress` - + `ec2:AuthorizeSecurityGroupIngress` - + `ec2:CreateSecurityGroup` - + `ec2:DescribeInstances` - + `ec2:DescribeNetworkInterfaces` - + `ec2:DescribeSecurityGroups` - + `ec2:ModifyNetworkInterfaceAttribute` - + `ec2:RevokeSecurityGroupEgress` - -If the DB instance and EC2 instance are in different Availability Zones, there is the possibility of cross Availability Zone costs\. - -When you set up a connection to an EC2 instance, RDS takes an action based on the current configuration of the security groups associated with the RDS database and EC2 instance, as described in the following table\. - - -**** - -| Current RDS security group configuration | Current EC2 security group configuration | RDS action | -| --- | --- | --- | -| There are one or more security groups associated with the RDS database with a name that matches the pattern `rds-ec2-n` \(where `n` is a number\)\. A security group that matches the pattern hasn't been modified\. This security group has only one inbound rule with the VPC security group of the EC2 instance as the source\. | There are one or more security groups associated with the EC2 instance with a name that matches the pattern `rds-ec2-n` \(where `n` is a number\)\. A security group that matches the pattern hasn't been modified\. This security group has only one outbound rule with the VPC security group of the RDS database as the source\. | RDS takes no action\. A connection was already configured automatically between the EC2 instance and RDS database\. Because a connection already exists between the EC2 instance and the RDS database, the security groups aren't modified\. | -| Either of the following conditions apply: [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/ec2-rds-connect.html) | Either of the following conditions apply: [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/ec2-rds-connect.html) | [RDS action: create new security groups](#rds-action-create-new-security-groups) | -| There are one or more security groups associated with the RDS database with a name that matches the pattern `rds-ec2-n`\. A security group that matches the pattern hasn't been modified\. This security group has only one inbound rule with the VPC security group of the EC2 instance as the source\. | There are one or more security groups associated with the EC2 instance with a name that matches the pattern `ec2-rds-n`\. However, none of these security groups can be used for the connection with the RDS database\. A security group can't be used if it doesn't have one outbound rule with the VPC security group of the RDS database as the source\. A security group also can't be used if it has been modified\. | [RDS action: create new security groups](#rds-action-create-new-security-groups) | -| There are one or more security groups associated with the RDS database with a name that matches the pattern `rds-ec2-n`\. A security group that matches the pattern hasn't been modified\. This security group has only one inbound rule with the VPC security group of the EC2 instance as the source\. | A valid EC2 security group for the connection exists, but it is not associated with the EC2 instance\. This security group has a name that matches the pattern `rds-ec2-n`\. It hasn't been modified\. It has only one outbound rule with the VPC security group of the RDS database as the source\. | [RDS action: associate EC2 security group](#rds-action-associate-ec2-security-group) | -| Either of the following conditions apply: [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/ec2-rds-connect.html) | There are one or more security groups associated with the EC2 instance with a name that matches the pattern `rds-ec2-n`\. A security group that matches the pattern hasn't been modified\. This security group has only one outbound rule with the VPC security group of the RDS database as the source\. | [RDS action: create new security groups](#rds-action-create-new-security-groups) | - -**RDS action: create new security groups** -RDS takes the following actions: -+ Creates a new security group that matches the pattern `rds-ec2-n`\. This security group has an inbound rule with the VPC security group of the EC2 instance as the source\. This security group is associated with the RDS database and allows the EC2 instance to access the RDS database\. -+ Creates a new security group that matches the pattern `ec2-rds-n`\. This security group has an outbound rule with the VPC security group of the RDS database as the source\. This security group is associated with the EC2 instance and allows the EC2 instance to send traffic to the RDS database\. - -**RDS action: associate EC2 security group** -RDS associates the valid, existing EC2 security group with the EC2 instance\. This security group allows the EC2 instance to send traffic to the RDS database\. - -## Connecting an EC2 instance and an RDS database automatically - -Before setting up a connection between an EC2 instance and an RDS database, make sure you meet the requirements described in [Overview of automatic connectivity with an EC2 instance](#ec2-rds-connect-overview)\. - -If you make changes to security groups after you configure connectivity, the changes might affect the connection between the EC2 instance and the RDS database\. - -**Note** -You can only set up a connection between an EC2 instance and an RDS database automatically by using the AWS Management Console\. You can't set up a connection automatically with the AWS CLI or RDS API\. - -**To connect an EC2 instance and an RDS database automatically** - -1. Sign in to the AWS Management Console and open the Amazon RDS console at [https://console\.aws\.amazon\.com/rds/](https://console.aws.amazon.com/rds/)\. - -1. In the navigation pane, choose **Databases**, and then choose the RDS database\. - -1. For **Actions**, choose **Set up EC2 connection**\. - - The **Set up EC2 connection** page appears\. - -1. On the **Set up EC2 connection** page, choose the EC2 instance\. -![\[Set up EC2 connection page.\]](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/images/auto-connect-rds-ec2-set-up.png) - - If no EC2 instances exist in the same VPC, choose **Create EC2 instance** to create one\. In this case, make sure the new EC2 instance is in the same VPC as the RDS database\. - -1. Choose **Continue**\. - - The **Review and confirm** page appears\. -![\[EC2 connection review and confirmation page.\]](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/images/auto-connect-rds-ec2-confirm.png) - -1. On the **Review and confirm** page, review the changes that RDS will make to set up connectivity with the EC2 instance\. - - If the changes are correct, choose **Confirm and set up**\. - - If the changes aren't correct, choose **Previous** or **Cancel**\. - -## Viewing connected compute resources - -You can use the AWS Management Console to view the compute resources that are connected to an RDS database\. The resources shown include compute resource connections that were set up automatically\. You can set up connectivity with compute resources automatically in the following ways: -+ You can select the compute resource when you create the database\. - - For more information, see [Creating an Amazon RDS DB instance](USER_CreateDBInstance.md) and [Creating a Multi\-AZ DB cluster](create-multi-az-db-cluster.md)\. -+ You can set up connectivity between an existing database and a compute resource\. - - For more information, see [Connecting an EC2 instance and an RDS database automatically](#ec2-rds-connect-connecting)\. - -The listed compute resources don't include ones that were connected to the database manually\. For example, you can allow a compute resource to access a database manually by adding a rule to the VPC security group associated with the database\. - -For a compute resource to be listed, the following conditions must apply: -+ The name of the security group associated with the compute resource matches the pattern `ec2-rds-n` \(where `n` is a number\)\. -+ The security group associated with the compute resource has an outbound rule with the port range set to the port used by the RDS database\. -+ The security group associated with the compute resource has an outbound rule with the source set to a security group associated with the RDS database\. -+ The name of the security group associated with the RDS database matches the pattern `rds-ec2-n` \(where `n` is a number\)\. -+ The security group associated with the RDS database has an inbound rule with the port range set to the port used by the RDS database\. -+ The security group associated with the RDS database has an inbound rule with the source set to a security group associated with the compute resource\. - -**To connect an EC2 instance and an RDS database automatically** - -1. Sign in to the AWS Management Console and open the Amazon RDS console at [https://console\.aws\.amazon\.com/rds/](https://console.aws.amazon.com/rds/)\. - -1. In the navigation pane, choose **Databases**, and then choose the name of the RDS database\. - -1. On the **Connectivity & security** tab, view the compute resources in the **Connected compute resources**\. -![\[Connected compute resources.\]](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/images/ec2-connected-compute-resources.png) - -## Connecting to a DB instance that is running a specific DB engine - -For information about connecting to a DB instance that is running a specific DB engine, follow the instructions for your DB engine: -+ [Connecting to a DB instance running the MariaDB database engine](USER_ConnectToMariaDBInstance.md) -+ [Connecting to a DB instance running the Microsoft SQL Server database engine](USER_ConnectToMicrosoftSQLServerInstance.md) -+ [Connecting to a DB instance running the MySQL database engine](USER_ConnectToInstance.md) -+ [Connecting to your RDS for Oracle DB instance](USER_ConnectToOracleInstance.md) -+ [Connecting to a DB instance running the PostgreSQL database engine](USER_ConnectToPostgreSQLInstance.md) \ No newline at end of file diff --git a/doc_source/example_cross_AuroraRestLendingLibrary_section.md b/doc_source/example_cross_AuroraRestLendingLibrary_section.md deleted file mode 100644 index 8bbd9bd..0000000 --- a/doc_source/example_cross_AuroraRestLendingLibrary_section.md +++ /dev/null @@ -1,28 +0,0 @@ -# Create a lending library REST API - -The following code example shows how to create a lending library where patrons can borrow and return books by using a REST API backed by an Amazon Aurora database\. - -**Note** -The source code for these examples is in the [AWS Code Examples GitHub repository](https://github.com/awsdocs/aws-doc-sdk-examples)\. Have feedback on a code example? [Create an Issue](https://github.com/awsdocs/aws-doc-sdk-examples/issues/new/choose) in the code examples repo\. - ------- -#### [ Python ] - -**SDK for Python \(Boto3\)** - Shows how to use the AWS SDK for Python \(Boto3\) with the Amazon Relational Database Service \(Amazon RDS\) API and AWS Chalice to create a REST API backed by an Amazon Aurora database\. The web service is fully serverless and represents a simple lending library where patrons can borrow and return books\. Learn how to: -+ Create and manage a serverless Aurora database cluster\. -+ Use AWS Secrets Manager to manage database credentials\. -+ Implement a data storage layer that uses Amazon RDS to move data into and out of the database\. -+ Use AWS Chalice to deploy a serverless REST API to Amazon API Gateway and AWS Lambda\. -+ Use the Requests package to send requests to the web service\. - For complete source code and instructions on how to set up and run, see the full example on [GitHub](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/python/cross_service/aurora_rest_lending_library)\. - -**Services used in this example** -+ API Gateway -+ Lambda -+ Amazon RDS -+ Secrets Manager - ------- - -For a complete list of AWS SDK developer guides and code examples, see [Using this service with an AWS SDK](CHAP_Tutorials.md#sdk-general-information-section)\. This topic also includes information about getting started and details about previous SDK versions\. \ No newline at end of file diff --git a/doc_source/example_cross_RDSDataTracker_section.md b/doc_source/example_cross_RDSDataTracker_section.md deleted file mode 100644 index 5ce9b16..0000000 --- a/doc_source/example_cross_RDSDataTracker_section.md +++ /dev/null @@ -1,119 +0,0 @@ -# Create an Aurora Serverless work item tracker - -The following code examples show how to create a web application that tracks work items in an Amazon Aurora Serverless database and uses Amazon Simple Email Service \(Amazon SES\) to send reports\. - -**Note** -The source code for these examples is in the [AWS Code Examples GitHub repository](https://github.com/awsdocs/aws-doc-sdk-examples)\. Have feedback on a code example? [Create an Issue](https://github.com/awsdocs/aws-doc-sdk-examples/issues/new/choose) in the code examples repo\. - ------- -#### [ \.NET ] - -**AWS SDK for \.NET** - Shows how to use the AWS SDK for \.NET to create a web application that tracks work items in an Amazon Aurora database and emails reports by using Amazon Simple Email Service \(Amazon SES\)\. This example uses a front end built with React\.js to interact with a RESTful \.NET backend\. -+ Integrate a React web application with AWS services\. -+ List, add, update, and delete items in an Aurora table\. -+ Send an email report of filtered work items using Amazon SES\. -+ Deploy and manage example resources with the included AWS CloudFormation script\. - For complete source code and instructions on how to set up and run, see the full example on [GitHub](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/dotnetv3/cross-service/AuroraItemTracker)\. - -**Services used in this example** -+ Aurora -+ Amazon RDS -+ Amazon RDS Data Service -+ Amazon SES - ------- -#### [ C\+\+ ] - -**SDK for C\+\+** - Shows how to create a web application that tracks and reports on work items stored in an Amazon Aurora Serverless database\. - For complete source code and instructions on how to set up a C\+\+ REST API that queries Amazon Aurora Serverless data and for use by a React application, see the full example on [GitHub](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/cpp/example_code/cross-service/serverless-aurora)\. - -**Services used in this example** -+ Aurora -+ Amazon RDS -+ Amazon RDS Data Service -+ Amazon SES - ------- -#### [ Java ] - -**SDK for Java 2\.x** - Shows how to create a web application that tracks and reports on work items stored in an Amazon RDS database\. - For complete source code and instructions on how to set up a Spring REST API that queries Amazon Aurora Serverless data and for use by a React application, see the full example on [GitHub](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/javav2/usecases/Creating_Spring_RDS_%20Rest)\. - For complete source code and instructions on how to set up and run an example that uses the JDBC API, see the full example on [GitHub](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/javav2/usecases/Creating_rds_item_tracker)\. - -**Services used in this example** -+ Aurora -+ Amazon RDS -+ Amazon RDS Data Service -+ Amazon SES - ------- -#### [ JavaScript ] - -**SDK for JavaScript \(v3\)** - Shows how to use the AWS SDK for JavaScript \(v3\) to create a web application that tracks work items in an Amazon Aurora database and emails reports by using Amazon Simple Email Service \(Amazon SES\)\. This example uses a front end built with React\.js to interact with an Express Node\.js backend\. -+ Integrate a React\.js web application with AWS services\. -+ List, add, and update items in an Aurora table\. -+ Send an email report of filtered work items by using Amazon SES\. -+ Deploy and manage example resources with the included AWS CloudFormation script\. - For complete source code and instructions on how to set up and run, see the full example on [GitHub](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/javascriptv3/example_code/cross-services/aurora-serverless-app)\. - -**Services used in this example** -+ Aurora -+ Amazon RDS -+ Amazon RDS Data Service -+ Amazon SES - ------- -#### [ Kotlin ] - -**SDK for Kotlin** -This is prerelease documentation for a feature in preview release\. It is subject to change\. - Shows how to create a web application that tracks and reports on work items stored in an Amazon RDS database\. - For complete source code and instructions on how to set up a Spring REST API that queries Amazon Aurora Serverless data and for use by a React application, see the full example on [GitHub](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/kotlin/usecases/serverless_rds)\. - -**Services used in this example** -+ Aurora -+ Amazon RDS -+ Amazon RDS Data Service -+ Amazon SES - ------- -#### [ PHP ] - -**SDK for PHP** - Shows how to use the AWS SDK for PHP to create a web application that tracks work items in an Amazon RDS database and emails reports by using Amazon Simple Email Service \(Amazon SES\)\. This example uses a front end built with React\.js to interact with a RESTful PHP backend\. -+ Integrate a React\.js web application with AWS services\. -+ List, add, update, and delete items in an Amazon RDS table\. -+ Send an email report of filtered work items using Amazon SES\. -+ Deploy and manage example resources with the included AWS CloudFormation script\. - For complete source code and instructions on how to set up and run, see the full example on [GitHub](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/php/cross_service/aurora_item_tracker)\. - -**Services used in this example** -+ Aurora -+ Amazon RDS -+ Amazon RDS Data Service -+ Amazon SES - ------- -#### [ Python ] - -**SDK for Python \(Boto3\)** - Shows how to use the AWS SDK for Python \(Boto3\) to create a REST service that tracks work items in an Amazon Aurora Serverless database and emails reports by using Amazon Simple Email Service \(Amazon SES\)\. This example uses the Flask web framework to handle HTTP routing and integrates with a React webpage to present a fully functional web application\. -+ Build a Flask REST service that integrates with AWS services\. -+ Read, write, and update work items that are stored in an Aurora Serverless database\. -+ Create an AWS Secrets Manager secret that contains database credentials and use it to authenticate calls to the database\. -+ Use Amazon SES to send email reports of work items\. - For complete source code and instructions on how to set up and run, see the full example on [GitHub](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/python/cross_service/aurora_item_tracker)\. - -**Services used in this example** -+ Aurora -+ Amazon RDS -+ Amazon RDS Data Service -+ Amazon SES - ------- - -For a complete list of AWS SDK developer guides and code examples, see [Using this service with an AWS SDK](CHAP_Tutorials.md#sdk-general-information-section)\. This topic also includes information about getting started and details about previous SDK versions\. \ No newline at end of file diff --git a/doc_source/example_rds_CreateDBInstance_section.md b/doc_source/example_rds_CreateDBInstance_section.md deleted file mode 100644 index 2dcb89c..0000000 --- a/doc_source/example_rds_CreateDBInstance_section.md +++ /dev/null @@ -1,307 +0,0 @@ -# Create an Amazon RDS DB instance using an AWS SDK - -The following code examples show how to create an Amazon RDS DB instance and wait for it to become available\. - -**Note** -The source code for these examples is in the [AWS Code Examples GitHub repository](https://github.com/awsdocs/aws-doc-sdk-examples)\. Have feedback on a code example? [Create an Issue](https://github.com/awsdocs/aws-doc-sdk-examples/issues/new/choose) in the code examples repo\. - -Action examples are code excerpts from larger programs and must be run in context\. You can see this action in context in the following code example: -+ [Get started with DB instances](example_rds_Scenario_GetStartedInstances_section.md) - ------- -#### [ \.NET ] - -**AWS SDK for \.NET** - There's more on GitHub\. Find the complete example and learn how to set up and run in the [AWS Code Examples Repository](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/dotnetv3/RDS#code-examples)\. - - -``` - /// - /// Create an RDS DB instance with a particular set of properties. Use the action DescribeDBInstancesAsync - /// to determine when the DB instance is ready to use. - /// - /// Name for the DB instance. - /// DB instance identifier. - /// DB parameter group to associate with the instance. - /// The engine for the DB instance. - /// Version for the DB instance. - /// Class for the DB instance. - /// The amount of storage in gibibytes (GiB) to allocate to the DB instance. - /// Admin user name. - /// Admin user password. - /// DB instance object. - public async Task CreateDBInstance(string dbName, string dbInstanceIdentifier, - string parameterGroupName, string dbEngine, string dbEngineVersion, - string instanceClass, int allocatedStorage, string adminName, string adminPassword) - { - var response = await _amazonRDS.CreateDBInstanceAsync( - new CreateDBInstanceRequest() - { - DBName = dbName, - DBInstanceIdentifier = dbInstanceIdentifier, - DBParameterGroupName = parameterGroupName, - Engine = dbEngine, - EngineVersion = dbEngineVersion, - DBInstanceClass = instanceClass, - AllocatedStorage = allocatedStorage, - MasterUsername = adminName, - MasterUserPassword = adminPassword - }); - - return response.DBInstance; - } -``` -+ For API details, see [CreateDBInstance](https://docs.aws.amazon.com/goto/DotNetSDKV3/rds-2014-10-31/CreateDBInstance) in *AWS SDK for \.NET API Reference*\. - ------- -#### [ C\+\+ ] - -**SDK for C\+\+** - There's more on GitHub\. Find the complete example and learn how to set up and run in the [AWS Code Examples Repository](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/cpp/example_code/rds#code-examples)\. - - -``` - Aws::Client::ClientConfiguration clientConfig; - // Optional: Set to the AWS Region (overrides config file). - // clientConfig.region = "us-east-1"; - - Aws::RDS::RDSClient client(clientConfig); - - Aws::RDS::Model::CreateDBInstanceRequest request; - request.SetDBName(DB_NAME); - request.SetDBInstanceIdentifier(DB_INSTANCE_IDENTIFIER); - request.SetDBParameterGroupName(PARAMETER_GROUP_NAME); - request.SetEngine(engineVersion.GetEngine()); - request.SetEngineVersion(engineVersion.GetEngineVersion()); - request.SetDBInstanceClass(dbInstanceClass); - request.SetStorageType(DB_STORAGE_TYPE); - request.SetAllocatedStorage(DB_ALLOCATED_STORAGE); - request.SetMasterUsername(administratorName); - request.SetMasterUserPassword(administratorPassword); - - Aws::RDS::Model::CreateDBInstanceOutcome outcome = - client.CreateDBInstance(request); - - if (outcome.IsSuccess()) { - std::cout << "The DB instance creation has started." - << std::endl; - } - else { - std::cerr << "Error with RDS::CreateDBInstance. " - << outcome.GetError().GetMessage() - << std::endl; - cleanUpResources(PARAMETER_GROUP_NAME, "", client); - return false; - } -``` -+ For API details, see [CreateDBInstance](https://docs.aws.amazon.com/goto/SdkForCpp/rds-2014-10-31/CreateDBInstance) in *AWS SDK for C\+\+ API Reference*\. - ------- -#### [ Java ] - -**SDK for Java 2\.x** - There's more on GitHub\. Find the complete example and learn how to set up and run in the [AWS Code Examples Repository](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/javav2/example_code/rds#readme)\. - - -``` - public static void createDatabaseInstance(RdsClient rdsClient, - String dbInstanceIdentifier, - String dbName, - String masterUsername, - String masterUserPassword) { - - try { - CreateDbInstanceRequest instanceRequest = CreateDbInstanceRequest.builder() - .dbInstanceIdentifier(dbInstanceIdentifier) - .allocatedStorage(100) - .dbName(dbName) - .engine("mysql") - .dbInstanceClass("db.m4.large") - .engineVersion("8.0.15") - .storageType("standard") - .masterUsername(masterUsername) - .masterUserPassword(masterUserPassword) - .build(); - - CreateDbInstanceResponse response = rdsClient.createDBInstance(instanceRequest); - System.out.print("The status is " + response.dbInstance().dbInstanceStatus()); - - } catch (RdsException e) { - System.out.println(e.getLocalizedMessage()); - System.exit(1); - } - } - - // Waits until the database instance is available - public static void waitForInstanceReady(RdsClient rdsClient, String dbInstanceIdentifier) { - - Boolean instanceReady = false; - String instanceReadyStr = ""; - System.out.println("Waiting for instance to become available."); - - try { - DescribeDbInstancesRequest instanceRequest = DescribeDbInstancesRequest.builder() - .dbInstanceIdentifier(dbInstanceIdentifier) - .build(); - - // Loop until the cluster is ready - while (!instanceReady) { - - DescribeDbInstancesResponse response = rdsClient.describeDBInstances(instanceRequest); - List instanceList = response.dbInstances(); - for (DBInstance instance : instanceList) { - instanceReadyStr = instance.dbInstanceStatus(); - if (instanceReadyStr.contains("available")) - instanceReady = true; - else { - System.out.print("."); - Thread.sleep(sleepTime * 1000); - } - } - } - System.out.println("Database instance is available!"); - - } catch (RdsException | InterruptedException e) { - System.err.println(e.getMessage()); - System.exit(1); - } - } -``` -+ For API details, see [CreateDBInstance](https://docs.aws.amazon.com/goto/SdkForJavaV2/rds-2014-10-31/CreateDBInstance) in *AWS SDK for Java 2\.x API Reference*\. - ------- -#### [ Kotlin ] - -**SDK for Kotlin** -This is prerelease documentation for a feature in preview release\. It is subject to change\. - There's more on GitHub\. Find the complete example and learn how to set up and run in the [AWS Code Examples Repository](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/kotlin/services/rds#code-examples)\. - - -``` -suspend fun createDatabaseInstance( - dbInstanceIdentifierVal: String?, - dbNamedbVal: String?, - masterUsernameVal: String?, - masterUserPasswordVal: String? -) { - - val instanceRequest = CreateDbInstanceRequest { - dbInstanceIdentifier = dbInstanceIdentifierVal - allocatedStorage = 100 - dbName = dbNamedbVal - engine = "mysql" - dbInstanceClass = "db.m4.large" - engineVersion = "8.0.15" - storageType = "standard" - masterUsername = masterUsernameVal - masterUserPassword = masterUserPasswordVal - } - - RdsClient { region = "us-west-2" }.use { rdsClient -> - val response = rdsClient.createDbInstance(instanceRequest) - print("The status is ${response.dbInstance?.dbInstanceStatus}") - } -} - -// Waits until the database instance is available. -suspend fun waitForInstanceReady(dbInstanceIdentifierVal: String?) { - val sleepTime: Long = 20 - var instanceReady = false - var instanceReadyStr = "" - println("Waiting for instance to become available.") - - val instanceRequest = DescribeDbInstancesRequest { - dbInstanceIdentifier = dbInstanceIdentifierVal - } - - RdsClient { region = "us-west-2" }.use { rdsClient -> - while (!instanceReady) { - val response = rdsClient.describeDbInstances(instanceRequest) - val instanceList = response.dbInstances - if (instanceList != null) { - - for (instance in instanceList) { - instanceReadyStr = instance.dbInstanceStatus.toString() - if (instanceReadyStr.contains("available")) - instanceReady = true - else { - println("...$instanceReadyStr") - delay(sleepTime * 1000) - } - } - } - } - println("Database instance is available!") - } -} -``` -+ For API details, see [CreateDBInstance](https://github.com/awslabs/aws-sdk-kotlin#generating-api-documentation) in *AWS SDK for Kotlin API reference*\. - ------- -#### [ Python ] - -**SDK for Python \(Boto3\)** - There's more on GitHub\. Find the complete example and learn how to set up and run in the [AWS Code Examples Repository](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/python/example_code/rds#code-examples)\. - - -``` -class InstanceWrapper: - """Encapsulates Amazon RDS DB instance actions.""" - def __init__(self, rds_client): - """ - :param rds_client: A Boto3 Amazon RDS client. - """ - self.rds_client = rds_client - - @classmethod - def from_client(cls): - """ - Instantiates this class from a Boto3 client. - """ - rds_client = boto3.client('rds') - return cls(rds_client) - - def create_db_instance( - self, db_name, instance_id, parameter_group_name, db_engine, db_engine_version, - instance_class, storage_type, allocated_storage, admin_name, admin_password): - """ - Creates a DB instance. - - :param db_name: The name of the database that is created in the DB instance. - :param instance_id: The ID to give the newly created DB instance. - :param parameter_group_name: A parameter group to associate with the DB instance. - :param db_engine: The database engine of a database to create in the DB instance. - :param db_engine_version: The engine version for the created database. - :param instance_class: The DB instance class for the newly created DB instance. - :param storage_type: The storage type of the DB instance. - :param allocated_storage: The amount of storage allocated on the DB instance, in GiBs. - :param admin_name: The name of the admin user for the created database. - :param admin_password: The admin password for the created database. - :return: Data about the newly created DB instance. - """ - try: - response = self.rds_client.create_db_instance( - DBName=db_name, - DBInstanceIdentifier=instance_id, - DBParameterGroupName=parameter_group_name, - Engine=db_engine, - EngineVersion=db_engine_version, - DBInstanceClass=instance_class, - StorageType=storage_type, - AllocatedStorage=allocated_storage, - MasterUsername=admin_name, - MasterUserPassword=admin_password) - db_inst = response['DBInstance'] - except ClientError as err: - logger.error( - "Couldn't create DB instance %s. Here's why: %s: %s", instance_id, - err.response['Error']['Code'], err.response['Error']['Message']) - raise - else: - return db_inst -``` -+ For API details, see [CreateDBInstance](https://docs.aws.amazon.com/goto/boto3/rds-2014-10-31/CreateDBInstance) in *AWS SDK for Python \(Boto3\) API Reference*\. - ------- - -For a complete list of AWS SDK developer guides and code examples, see [Using this service with an AWS SDK](CHAP_Tutorials.md#sdk-general-information-section)\. This topic also includes information about getting started and details about previous SDK versions\. \ No newline at end of file diff --git a/doc_source/example_rds_CreateDBParameterGroup_section.md b/doc_source/example_rds_CreateDBParameterGroup_section.md deleted file mode 100644 index db22a29..0000000 --- a/doc_source/example_rds_CreateDBParameterGroup_section.md +++ /dev/null @@ -1,156 +0,0 @@ -# Create an Amazon RDS DB parameter group using an AWS SDK - -The following code examples show how to create an Amazon RDS DB parameter group\. - -**Note** -The source code for these examples is in the [AWS Code Examples GitHub repository](https://github.com/awsdocs/aws-doc-sdk-examples)\. Have feedback on a code example? [Create an Issue](https://github.com/awsdocs/aws-doc-sdk-examples/issues/new/choose) in the code examples repo\. - -Action examples are code excerpts from larger programs and must be run in context\. You can see this action in context in the following code example: -+ [Get started with DB instances](example_rds_Scenario_GetStartedInstances_section.md) - ------- -#### [ \.NET ] - -**AWS SDK for \.NET** - There's more on GitHub\. Find the complete example and learn how to set up and run in the [AWS Code Examples Repository](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/dotnetv3/RDS#code-examples)\. - - -``` - /// - /// Create a new DB parameter group. Use the action DescribeDBParameterGroupsAsync - /// to determine when the DB parameter group is ready to use. - /// - /// Name of the DB parameter group. - /// Family of the DB parameter group. - /// Description of the DB parameter group. - /// The new DB parameter group. - public async Task CreateDBParameterGroup( - string name, string family, string description) - { - var response = await _amazonRDS.CreateDBParameterGroupAsync( - new CreateDBParameterGroupRequest() - { - DBParameterGroupName = name, - DBParameterGroupFamily = family, - Description = description - }); - return response.DBParameterGroup; - } -``` -+ For API details, see [CreateDBParameterGroup](https://docs.aws.amazon.com/goto/DotNetSDKV3/rds-2014-10-31/CreateDBParameterGroup) in *AWS SDK for \.NET API Reference*\. - ------- -#### [ C\+\+ ] - -**SDK for C\+\+** - There's more on GitHub\. Find the complete example and learn how to set up and run in the [AWS Code Examples Repository](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/cpp/example_code/rds#code-examples)\. - - -``` - Aws::Client::ClientConfiguration clientConfig; - // Optional: Set to the AWS Region (overrides config file). - // clientConfig.region = "us-east-1"; - - Aws::RDS::RDSClient client(clientConfig); - - Aws::RDS::Model::CreateDBParameterGroupRequest request; - request.SetDBParameterGroupName(PARAMETER_GROUP_NAME); - request.SetDBParameterGroupFamily(dbParameterGroupFamily); - request.SetDescription("Example parameter group."); - - Aws::RDS::Model::CreateDBParameterGroupOutcome outcome = - client.CreateDBParameterGroup(request); - - if (outcome.IsSuccess()) { - std::cout << "The DB parameter group was successfully created." - << std::endl; - } - else { - std::cerr << "Error with RDS::CreateDBParameterGroup. " - << outcome.GetError().GetMessage() - << std::endl; - return false; - } -``` -+ For API details, see [CreateDBParameterGroup](https://docs.aws.amazon.com/goto/SdkForCpp/rds-2014-10-31/CreateDBParameterGroup) in *AWS SDK for C\+\+ API Reference*\. - ------- -#### [ Java ] - -**SDK for Java 2\.x** - There's more on GitHub\. Find the complete example and learn how to set up and run in the [AWS Code Examples Repository](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/javav2/example_code/rds#readme)\. - - -``` - public static void createDBParameterGroup(RdsClient rdsClient, String dbGroupName, String dbParameterGroupFamily) { - try { - CreateDbParameterGroupRequest groupRequest = CreateDbParameterGroupRequest.builder() - .dbParameterGroupName(dbGroupName) - .dbParameterGroupFamily(dbParameterGroupFamily) - .description("Created by using the AWS SDK for Java") - .build(); - - CreateDbParameterGroupResponse response = rdsClient.createDBParameterGroup(groupRequest); - System.out.println("The group name is "+ response.dbParameterGroup().dbParameterGroupName()); - - } catch (RdsException e) { - System.out.println(e.getLocalizedMessage()); - System.exit(1); - } - } -``` -+ For API details, see [CreateDBParameterGroup](https://docs.aws.amazon.com/goto/SdkForJavaV2/rds-2014-10-31/CreateDBParameterGroup) in *AWS SDK for Java 2\.x API Reference*\. - ------- -#### [ Python ] - -**SDK for Python \(Boto3\)** - There's more on GitHub\. Find the complete example and learn how to set up and run in the [AWS Code Examples Repository](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/python/example_code/rds#code-examples)\. - - -``` -class InstanceWrapper: - """Encapsulates Amazon RDS DB instance actions.""" - def __init__(self, rds_client): - """ - :param rds_client: A Boto3 Amazon RDS client. - """ - self.rds_client = rds_client - - @classmethod - def from_client(cls): - """ - Instantiates this class from a Boto3 client. - """ - rds_client = boto3.client('rds') - return cls(rds_client) - - def create_parameter_group(self, parameter_group_name, parameter_group_family, description): - """ - Creates a DB parameter group that is based on the specified parameter group - family. - - :param parameter_group_name: The name of the newly created parameter group. - :param parameter_group_family: The family that is used as the basis of the new - parameter group. - :param description: A description given to the parameter group. - :return: Data about the newly created parameter group. - """ - try: - response = self.rds_client.create_db_parameter_group( - DBParameterGroupName=parameter_group_name, - DBParameterGroupFamily=parameter_group_family, - Description=description) - except ClientError as err: - logger.error( - "Couldn't create parameter group %s. Here's why: %s: %s", parameter_group_name, - err.response['Error']['Code'], err.response['Error']['Message']) - raise - else: - return response -``` -+ For API details, see [CreateDBParameterGroup](https://docs.aws.amazon.com/goto/boto3/rds-2014-10-31/CreateDBParameterGroup) in *AWS SDK for Python \(Boto3\) API Reference*\. - ------- - -For a complete list of AWS SDK developer guides and code examples, see [Using this service with an AWS SDK](CHAP_Tutorials.md#sdk-general-information-section)\. This topic also includes information about getting started and details about previous SDK versions\. \ No newline at end of file diff --git a/doc_source/example_rds_CreateDBSnapshot_section.md b/doc_source/example_rds_CreateDBSnapshot_section.md deleted file mode 100644 index d1762c0..0000000 --- a/doc_source/example_rds_CreateDBSnapshot_section.md +++ /dev/null @@ -1,177 +0,0 @@ -# Create a snapshot of an Amazon RDS DB instance using an AWS SDK - -The following code examples show how to create a snapshot of an Amazon RDS DB instance\. - -**Note** -The source code for these examples is in the [AWS Code Examples GitHub repository](https://github.com/awsdocs/aws-doc-sdk-examples)\. Have feedback on a code example? [Create an Issue](https://github.com/awsdocs/aws-doc-sdk-examples/issues/new/choose) in the code examples repo\. - -Action examples are code excerpts from larger programs and must be run in context\. You can see this action in context in the following code example: -+ [Get started with DB instances](example_rds_Scenario_GetStartedInstances_section.md) - ------- -#### [ \.NET ] - -**AWS SDK for \.NET** - There's more on GitHub\. Find the complete example and learn how to set up and run in the [AWS Code Examples Repository](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/dotnetv3/RDS#code-examples)\. - - -``` - /// - /// Create a snapshot of a DB instance. - /// - /// DB instance identifier. - /// Identifier for the snapshot. - /// DB snapshot object. - public async Task CreateDBSnapshot(string dbInstanceIdentifier, string snapshotIdentifier) - { - var response = await _amazonRDS.CreateDBSnapshotAsync( - new CreateDBSnapshotRequest() - { - DBSnapshotIdentifier = snapshotIdentifier, - DBInstanceIdentifier = dbInstanceIdentifier - }); - - return response.DBSnapshot; - } -``` -+ For API details, see [CreateDBSnapshot](https://docs.aws.amazon.com/goto/DotNetSDKV3/rds-2014-10-31/CreateDBSnapshot) in *AWS SDK for \.NET API Reference*\. - ------- -#### [ C\+\+ ] - -**SDK for C\+\+** - There's more on GitHub\. Find the complete example and learn how to set up and run in the [AWS Code Examples Repository](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/cpp/example_code/rds#code-examples)\. - - -``` - Aws::Client::ClientConfiguration clientConfig; - // Optional: Set to the AWS Region (overrides config file). - // clientConfig.region = "us-east-1"; - - Aws::RDS::RDSClient client(clientConfig); - - Aws::RDS::Model::CreateDBSnapshotRequest request; - request.SetDBInstanceIdentifier(DB_INSTANCE_IDENTIFIER); - request.SetDBSnapshotIdentifier(snapshotID); - - Aws::RDS::Model::CreateDBSnapshotOutcome outcome = - client.CreateDBSnapshot(request); - - if (outcome.IsSuccess()) { - std::cout << "Snapshot creation has started." - << std::endl; - } - else { - std::cerr << "Error with RDS::CreateDBSnapshot. " - << outcome.GetError().GetMessage() - << std::endl; - cleanUpResources(PARAMETER_GROUP_NAME, DB_INSTANCE_IDENTIFIER, client); - return false; - } -``` -+ For API details, see [CreateDBSnapshot](https://docs.aws.amazon.com/goto/SdkForCpp/rds-2014-10-31/CreateDBSnapshot) in *AWS SDK for C\+\+ API Reference*\. - ------- -#### [ Java ] - -**SDK for Java 2\.x** - There's more on GitHub\. Find the complete example and learn how to set up and run in the [AWS Code Examples Repository](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/javav2/example_code/rds#readme)\. - - -``` - // Create an Amazon RDS snapshot. - public static void createSnapshot(RdsClient rdsClient, String dbInstanceIdentifier, String dbSnapshotIdentifier) { - try { - CreateDbSnapshotRequest snapshotRequest = CreateDbSnapshotRequest.builder() - .dbInstanceIdentifier(dbInstanceIdentifier) - .dbSnapshotIdentifier(dbSnapshotIdentifier) - .build(); - - CreateDbSnapshotResponse response = rdsClient.createDBSnapshot(snapshotRequest); - System.out.println("The Snapshot id is " + response.dbSnapshot().dbiResourceId()); - - } catch (RdsException e) { - System.out.println(e.getLocalizedMessage()); - System.exit(1); - } - } -``` -+ For API details, see [CreateDBSnapshot](https://docs.aws.amazon.com/goto/SdkForJavaV2/rds-2014-10-31/CreateDBSnapshot) in *AWS SDK for Java 2\.x API Reference*\. - ------- -#### [ Python ] - -**SDK for Python \(Boto3\)** - There's more on GitHub\. Find the complete example and learn how to set up and run in the [AWS Code Examples Repository](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/python/example_code/rds#code-examples)\. - - -``` -class InstanceWrapper: - """Encapsulates Amazon RDS DB instance actions.""" - def __init__(self, rds_client): - """ - :param rds_client: A Boto3 Amazon RDS client. - """ - self.rds_client = rds_client - - @classmethod - def from_client(cls): - """ - Instantiates this class from a Boto3 client. - """ - rds_client = boto3.client('rds') - return cls(rds_client) - - def create_snapshot(self, snapshot_id, instance_id): - """ - Creates a snapshot of a DB instance. - - :param snapshot_id: The ID to give the created snapshot. - :param instance_id: The ID of the DB instance to snapshot. - :return: Data about the newly created snapshot. - """ - try: - response = self.rds_client.create_db_snapshot( - DBSnapshotIdentifier=snapshot_id, DBInstanceIdentifier=instance_id) - snapshot = response['DBSnapshot'] - except ClientError as err: - logger.error( - "Couldn't create snapshot of %s. Here's why: %s: %s", instance_id, - err.response['Error']['Code'], err.response['Error']['Message']) - raise - else: - return snapshot -``` -+ For API details, see [CreateDBSnapshot](https://docs.aws.amazon.com/goto/boto3/rds-2014-10-31/CreateDBSnapshot) in *AWS SDK for Python \(Boto3\) API Reference*\. - ------- -#### [ Ruby ] - -**SDK for Ruby** - There's more on GitHub\. Find the complete example and learn how to set up and run in the [AWS Code Examples Repository](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/ruby/example_code/rds#code-examples)\. - - -``` -require "aws-sdk-rds" # v2: require 'aws-sdk' - -# Create a snapshot for an Amazon Relational Database Service (Amazon RDS) -# DB instance. -# -# @param rds_resource [Aws::RDS::Resource] The resource containing SDK logic. -# @param db_instance_name [String] The name of the Amazon RDS DB instance. -# @return [Aws::RDS::DBSnapshot, nil] The snapshot created, or nil if error. -def create_snapshot(rds_resource, db_instance_name) - id = "snapshot-#{rand(10**6)}" - db_instance = rds_resource.db_instance(db_instance_name) - db_instance.create_snapshot({ - db_snapshot_identifier: id - }) -rescue Aws::Errors::ServiceError => e - puts "Couldn't create DB instance snapshot #{id}:\n #{e.message}" -end -``` -+ For API details, see [CreateDBSnapshot](https://docs.aws.amazon.com/goto/SdkForRubyV3/rds-2014-10-31/CreateDBSnapshot) in *AWS SDK for Ruby API Reference*\. - ------- - -For a complete list of AWS SDK developer guides and code examples, see [Using this service with an AWS SDK](CHAP_Tutorials.md#sdk-general-information-section)\. This topic also includes information about getting started and details about previous SDK versions\. \ No newline at end of file diff --git a/doc_source/example_rds_DeleteDBInstance_section.md b/doc_source/example_rds_DeleteDBInstance_section.md deleted file mode 100644 index ec53361..0000000 --- a/doc_source/example_rds_DeleteDBInstance_section.md +++ /dev/null @@ -1,174 +0,0 @@ -# Delete an Amazon RDS DB instance using an AWS SDK - -The following code examples show how to delete an Amazon RDS DB instance\. - -**Note** -The source code for these examples is in the [AWS Code Examples GitHub repository](https://github.com/awsdocs/aws-doc-sdk-examples)\. Have feedback on a code example? [Create an Issue](https://github.com/awsdocs/aws-doc-sdk-examples/issues/new/choose) in the code examples repo\. - -Action examples are code excerpts from larger programs and must be run in context\. You can see this action in context in the following code example: -+ [Get started with DB instances](example_rds_Scenario_GetStartedInstances_section.md) - ------- -#### [ \.NET ] - -**AWS SDK for \.NET** - There's more on GitHub\. Find the complete example and learn how to set up and run in the [AWS Code Examples Repository](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/dotnetv3/RDS#code-examples)\. - - -``` - /// - /// Delete a particular DB instance. - /// - /// DB instance identifier. - /// DB instance object. - public async Task DeleteDBInstance(string dbInstanceIdentifier) - { - var response = await _amazonRDS.DeleteDBInstanceAsync( - new DeleteDBInstanceRequest() - { - DBInstanceIdentifier = dbInstanceIdentifier, - SkipFinalSnapshot = true, - DeleteAutomatedBackups = true - }); - - return response.DBInstance; - } -``` -+ For API details, see [DeleteDBInstance](https://docs.aws.amazon.com/goto/DotNetSDKV3/rds-2014-10-31/DeleteDBInstance) in *AWS SDK for \.NET API Reference*\. - ------- -#### [ C\+\+ ] - -**SDK for C\+\+** - There's more on GitHub\. Find the complete example and learn how to set up and run in the [AWS Code Examples Repository](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/cpp/example_code/rds#code-examples)\. - - -``` - Aws::Client::ClientConfiguration clientConfig; - // Optional: Set to the AWS Region (overrides config file). - // clientConfig.region = "us-east-1"; - - Aws::RDS::RDSClient client(clientConfig); - - Aws::RDS::Model::DeleteDBInstanceRequest request; - request.SetDBInstanceIdentifier(dbInstanceIdentifier); - request.SetSkipFinalSnapshot(true); - request.SetDeleteAutomatedBackups(true); - - Aws::RDS::Model::DeleteDBInstanceOutcome outcome = - client.DeleteDBInstance(request); - - if (outcome.IsSuccess()) { - std::cout << "DB instance deletion has started." - << std::endl; - } - else { - std::cerr << "Error with RDS::DeleteDBInstance. " - << outcome.GetError().GetMessage() - << std::endl; - result = false; - } -``` -+ For API details, see [DeleteDBInstance](https://docs.aws.amazon.com/goto/SdkForCpp/rds-2014-10-31/DeleteDBInstance) in *AWS SDK for C\+\+ API Reference*\. - ------- -#### [ Java ] - -**SDK for Java 2\.x** - There's more on GitHub\. Find the complete example and learn how to set up and run in the [AWS Code Examples Repository](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/javav2/example_code/rds#readme)\. - - -``` - public static void deleteDatabaseInstance( RdsClient rdsClient, String dbInstanceIdentifier) { - try { - DeleteDbInstanceRequest deleteDbInstanceRequest = DeleteDbInstanceRequest.builder() - .dbInstanceIdentifier(dbInstanceIdentifier) - .deleteAutomatedBackups(true) - .skipFinalSnapshot(true) - .build(); - - DeleteDbInstanceResponse response = rdsClient.deleteDBInstance(deleteDbInstanceRequest); - System.out.print("The status of the database is " + response.dbInstance().dbInstanceStatus()); - - } catch (RdsException e) { - System.out.println(e.getLocalizedMessage()); - System.exit(1); - } - } -``` -+ For API details, see [DeleteDBInstance](https://docs.aws.amazon.com/goto/SdkForJavaV2/rds-2014-10-31/DeleteDBInstance) in *AWS SDK for Java 2\.x API Reference*\. - ------- -#### [ Kotlin ] - -**SDK for Kotlin** -This is prerelease documentation for a feature in preview release\. It is subject to change\. - There's more on GitHub\. Find the complete example and learn how to set up and run in the [AWS Code Examples Repository](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/kotlin/services/rds#code-examples)\. - - -``` -suspend fun deleteDatabaseInstance(dbInstanceIdentifierVal: String?) { - - val deleteDbInstanceRequest = DeleteDbInstanceRequest { - dbInstanceIdentifier = dbInstanceIdentifierVal - deleteAutomatedBackups = true - skipFinalSnapshot = true - } - - RdsClient { region = "us-west-2" }.use { rdsClient -> - val response = rdsClient.deleteDbInstance(deleteDbInstanceRequest) - print("The status of the database is ${response.dbInstance?.dbInstanceStatus}") - } -} -``` -+ For API details, see [DeleteDBInstance](https://github.com/awslabs/aws-sdk-kotlin#generating-api-documentation) in *AWS SDK for Kotlin API reference*\. - ------- -#### [ Python ] - -**SDK for Python \(Boto3\)** - There's more on GitHub\. Find the complete example and learn how to set up and run in the [AWS Code Examples Repository](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/python/example_code/rds#code-examples)\. - - -``` -class InstanceWrapper: - """Encapsulates Amazon RDS DB instance actions.""" - def __init__(self, rds_client): - """ - :param rds_client: A Boto3 Amazon RDS client. - """ - self.rds_client = rds_client - - @classmethod - def from_client(cls): - """ - Instantiates this class from a Boto3 client. - """ - rds_client = boto3.client('rds') - return cls(rds_client) - - def delete_db_instance(self, instance_id): - """ - Deletes a DB instance. - - :param instance_id: The ID of the DB instance to delete. - :return: Data about the deleted DB instance. - """ - try: - response = self.rds_client.delete_db_instance( - DBInstanceIdentifier=instance_id, SkipFinalSnapshot=True, - DeleteAutomatedBackups=True) - db_inst = response['DBInstance'] - except ClientError as err: - logger.error( - "Couldn't delete DB instance %s. Here's why: %s: %s", instance_id, - err.response['Error']['Code'], err.response['Error']['Message']) - raise - else: - return db_inst -``` -+ For API details, see [DeleteDBInstance](https://docs.aws.amazon.com/goto/boto3/rds-2014-10-31/DeleteDBInstance) in *AWS SDK for Python \(Boto3\) API Reference*\. - ------- - -For a complete list of AWS SDK developer guides and code examples, see [Using this service with an AWS SDK](CHAP_Tutorials.md#sdk-general-information-section)\. This topic also includes information about getting started and details about previous SDK versions\. \ No newline at end of file diff --git a/doc_source/example_rds_DeleteDBParameterGroup_section.md b/doc_source/example_rds_DeleteDBParameterGroup_section.md deleted file mode 100644 index a7131a3..0000000 --- a/doc_source/example_rds_DeleteDBParameterGroup_section.md +++ /dev/null @@ -1,169 +0,0 @@ -# Delete an Amazon RDS DB parameter group using an AWS SDK - -The following code examples show how to delete an Amazon RDS DB parameter group\. - -**Note** -The source code for these examples is in the [AWS Code Examples GitHub repository](https://github.com/awsdocs/aws-doc-sdk-examples)\. Have feedback on a code example? [Create an Issue](https://github.com/awsdocs/aws-doc-sdk-examples/issues/new/choose) in the code examples repo\. - -Action examples are code excerpts from larger programs and must be run in context\. You can see this action in context in the following code example: -+ [Get started with DB instances](example_rds_Scenario_GetStartedInstances_section.md) - ------- -#### [ \.NET ] - -**AWS SDK for \.NET** - There's more on GitHub\. Find the complete example and learn how to set up and run in the [AWS Code Examples Repository](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/dotnetv3/RDS#code-examples)\. - - -``` - /// - /// Delete a DB parameter group. The group cannot be a default DB parameter group - /// or be associated with any DB instances. - /// - /// Name of the DB parameter group. - /// True if successful. - public async Task DeleteDBParameterGroup(string name) - { - var response = await _amazonRDS.DeleteDBParameterGroupAsync( - new DeleteDBParameterGroupRequest() - { - DBParameterGroupName = name, - }); - return response.HttpStatusCode == HttpStatusCode.OK; - } -``` -+ For API details, see [DeleteDBParameterGroup](https://docs.aws.amazon.com/goto/DotNetSDKV3/rds-2014-10-31/DeleteDBParameterGroup) in *AWS SDK for \.NET API Reference*\. - ------- -#### [ C\+\+ ] - -**SDK for C\+\+** - There's more on GitHub\. Find the complete example and learn how to set up and run in the [AWS Code Examples Repository](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/cpp/example_code/rds#code-examples)\. - - -``` - Aws::Client::ClientConfiguration clientConfig; - // Optional: Set to the AWS Region (overrides config file). - // clientConfig.region = "us-east-1"; - - Aws::RDS::RDSClient client(clientConfig); - - Aws::RDS::Model::DeleteDBParameterGroupRequest request; - request.SetDBParameterGroupName(parameterGroupName); - - Aws::RDS::Model::DeleteDBParameterGroupOutcome outcome = - client.DeleteDBParameterGroup(request); - - if (outcome.IsSuccess()) { - std::cout << "The DB parameter group was successfully deleted." - << std::endl; - } - else { - std::cerr << "Error with RDS::DeleteDBParameterGroup. " - << outcome.GetError().GetMessage() - << std::endl; - result = false; - } -``` -+ For API details, see [DeleteDBParameterGroup](https://docs.aws.amazon.com/goto/SdkForCpp/rds-2014-10-31/DeleteDBParameterGroup) in *AWS SDK for C\+\+ API Reference*\. - ------- -#### [ Java ] - -**SDK for Java 2\.x** - There's more on GitHub\. Find the complete example and learn how to set up and run in the [AWS Code Examples Repository](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/javav2/example_code/rds#readme)\. - - -``` - // Delete the parameter group after database has been deleted. - // An exception is thrown if you attempt to delete the para group while database exists. - public static void deleteParaGroup( RdsClient rdsClient, String dbGroupName, String dbARN) throws InterruptedException { - try { - boolean isDataDel = false; - boolean didFind; - String instanceARN ; - - // Make sure that the database has been deleted. - while (!isDataDel) { - DescribeDbInstancesResponse response = rdsClient.describeDBInstances(); - List instanceList = response.dbInstances(); - int listSize = instanceList.size(); - isDataDel = false ; - didFind = false; - int index = 1; - for (DBInstance instance: instanceList) { - instanceARN = instance.dbInstanceArn(); - if (instanceARN.compareTo(dbARN) == 0) { - System.out.println(dbARN + " still exists"); - didFind = true ; - } - if ((index == listSize) && (!didFind)) { - // Went through the entire list and did not find the database ARN. - isDataDel = true; - } - Thread.sleep(sleepTime * 1000); - index ++; - } - } - - // Delete the para group. - DeleteDbParameterGroupRequest parameterGroupRequest = DeleteDbParameterGroupRequest.builder() - .dbParameterGroupName(dbGroupName) - .build(); - - rdsClient.deleteDBParameterGroup(parameterGroupRequest); - System.out.println(dbGroupName +" was deleted."); - - } catch (RdsException e) { - System.out.println(e.getLocalizedMessage()); - System.exit(1); - } - } -``` -+ For API details, see [DeleteDBParameterGroup](https://docs.aws.amazon.com/goto/SdkForJavaV2/rds-2014-10-31/DeleteDBParameterGroup) in *AWS SDK for Java 2\.x API Reference*\. - ------- -#### [ Python ] - -**SDK for Python \(Boto3\)** - There's more on GitHub\. Find the complete example and learn how to set up and run in the [AWS Code Examples Repository](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/python/example_code/rds#code-examples)\. - - -``` -class InstanceWrapper: - """Encapsulates Amazon RDS DB instance actions.""" - def __init__(self, rds_client): - """ - :param rds_client: A Boto3 Amazon RDS client. - """ - self.rds_client = rds_client - - @classmethod - def from_client(cls): - """ - Instantiates this class from a Boto3 client. - """ - rds_client = boto3.client('rds') - return cls(rds_client) - - def delete_parameter_group(self, parameter_group_name): - """ - Deletes a DB parameter group. - - :param parameter_group_name: The name of the parameter group to delete. - :return: Data about the parameter group. - """ - try: - self.rds_client.delete_db_parameter_group( - DBParameterGroupName=parameter_group_name) - except ClientError as err: - logger.error( - "Couldn't delete parameter group %s. Here's why: %s: %s", parameter_group_name, - err.response['Error']['Code'], err.response['Error']['Message']) - raise -``` -+ For API details, see [DeleteDBParameterGroup](https://docs.aws.amazon.com/goto/boto3/rds-2014-10-31/DeleteDBParameterGroup) in *AWS SDK for Python \(Boto3\) API Reference*\. - ------- - -For a complete list of AWS SDK developer guides and code examples, see [Using this service with an AWS SDK](CHAP_Tutorials.md#sdk-general-information-section)\. This topic also includes information about getting started and details about previous SDK versions\. \ No newline at end of file diff --git a/doc_source/example_rds_DescribeAccountAttributes_section.md b/doc_source/example_rds_DescribeAccountAttributes_section.md deleted file mode 100644 index 9e0e535..0000000 --- a/doc_source/example_rds_DescribeAccountAttributes_section.md +++ /dev/null @@ -1,59 +0,0 @@ -# Retrieve attributes that belongs to an Amazon RDS account using an AWS SDK - -The following code examples show how to retrieve attributes that belong to an Amazon RDS account\. - -**Note** -The source code for these examples is in the [AWS Code Examples GitHub repository](https://github.com/awsdocs/aws-doc-sdk-examples)\. Have feedback on a code example? [Create an Issue](https://github.com/awsdocs/aws-doc-sdk-examples/issues/new/choose) in the code examples repo\. - ------- -#### [ Java ] - -**SDK for Java 2\.x** - There's more on GitHub\. Find the complete example and learn how to set up and run in the [AWS Code Examples Repository](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/javav2/example_code/rds#readme)\. - - -``` - public static void getAccountAttributes(RdsClient rdsClient) { - - try { - DescribeAccountAttributesResponse response = rdsClient.describeAccountAttributes(); - List quotasList = response.accountQuotas(); - for (AccountQuota quotas: quotasList) { - System.out.println("Name is: "+quotas.accountQuotaName()); - System.out.println("Max value is " +quotas.max()); - } - - } catch (RdsException e) { - System.out.println(e.getLocalizedMessage()); - System.exit(1); - } - } -``` -+ For API details, see [DescribeAccountAttributes](https://docs.aws.amazon.com/goto/SdkForJavaV2/rds-2014-10-31/DescribeAccountAttributes) in *AWS SDK for Java 2\.x API Reference*\. - ------- -#### [ Kotlin ] - -**SDK for Kotlin** -This is prerelease documentation for a feature in preview release\. It is subject to change\. - There's more on GitHub\. Find the complete example and learn how to set up and run in the [AWS Code Examples Repository](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/kotlin/services/rds#code-examples)\. - - -``` -suspend fun getAccountAttributes() { - - RdsClient { region = "us-west-2" }.use { rdsClient -> - val response = rdsClient.describeAccountAttributes(DescribeAccountAttributesRequest {}) - response.accountQuotas?.forEach { quotas -> - val response = response.accountQuotas - println("Name is: ${quotas.accountQuotaName}") - println("Max value is ${quotas.max}") - } - } -} -``` -+ For API details, see [DescribeAccountAttributes](https://github.com/awslabs/aws-sdk-kotlin#generating-api-documentation) in *AWS SDK for Kotlin API reference*\. - ------- - -For a complete list of AWS SDK developer guides and code examples, see [Using this service with an AWS SDK](CHAP_Tutorials.md#sdk-general-information-section)\. This topic also includes information about getting started and details about previous SDK versions\. \ No newline at end of file diff --git a/doc_source/example_rds_DescribeDBEngineVersions_section.md b/doc_source/example_rds_DescribeDBEngineVersions_section.md deleted file mode 100644 index 9c8fedc..0000000 --- a/doc_source/example_rds_DescribeDBEngineVersions_section.md +++ /dev/null @@ -1,178 +0,0 @@ -# Describe Amazon RDS database engine versions using an AWS SDK - -The following code examples show how to describe Amazon RDS database engine versions\. - -**Note** -The source code for these examples is in the [AWS Code Examples GitHub repository](https://github.com/awsdocs/aws-doc-sdk-examples)\. Have feedback on a code example? [Create an Issue](https://github.com/awsdocs/aws-doc-sdk-examples/issues/new/choose) in the code examples repo\. - -Action examples are code excerpts from larger programs and must be run in context\. You can see this action in context in the following code example: -+ [Get started with DB instances](example_rds_Scenario_GetStartedInstances_section.md) - ------- -#### [ \.NET ] - -**AWS SDK for \.NET** - There's more on GitHub\. Find the complete example and learn how to set up and run in the [AWS Code Examples Repository](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/dotnetv3/RDS#code-examples)\. - - -``` - /// - /// Get a list of DB engine versions for a particular DB engine. - /// - /// Name of the engine. - /// Optional parameter group family name. - /// List of DBEngineVersions. - public async Task> DescribeDBEngineVersions(string engine, - string dbParameterGroupFamily = null) - { - var response = await _amazonRDS.DescribeDBEngineVersionsAsync( - new DescribeDBEngineVersionsRequest() - { - Engine = engine, - DBParameterGroupFamily = dbParameterGroupFamily - }); - return response.DBEngineVersions; - } -``` -+ For API details, see [DescribeDBEngineVersions](https://docs.aws.amazon.com/goto/DotNetSDKV3/rds-2014-10-31/DescribeDBEngineVersions) in *AWS SDK for \.NET API Reference*\. - ------- -#### [ C\+\+ ] - -**SDK for C\+\+** - There's more on GitHub\. Find the complete example and learn how to set up and run in the [AWS Code Examples Repository](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/cpp/example_code/rds#code-examples)\. - - -``` - Aws::Client::ClientConfiguration clientConfig; - // Optional: Set to the AWS Region (overrides config file). - // clientConfig.region = "us-east-1"; - - Aws::RDS::RDSClient client(clientConfig); - - -//! Routine which gets available DB engine versions for an engine name and -//! an optional parameter group family. -/*! - \sa getDBEngineVersions() - \param engineName: A DB engine name. - \param parameterGroupFamily: A parameter group family name, ignored if empty. - \param engineVersionsResult: Vector of 'DBEngineVersion' objects returned by the routine. - \param client: 'RDSClient' instance. - \return bool: Successful completion. - */ -bool AwsDoc::RDS::getDBEngineVersions(const Aws::String &engineName, - const Aws::String ¶meterGroupFamily, - Aws::Vector &engineVersionsResult, - const Aws::RDS::RDSClient &client) { - Aws::RDS::Model::DescribeDBEngineVersionsRequest request; - request.SetEngine(engineName); - if (!parameterGroupFamily.empty()) { - request.SetDBParameterGroupFamily(parameterGroupFamily); - } - - Aws::RDS::Model::DescribeDBEngineVersionsOutcome outcome = - client.DescribeDBEngineVersions(request); - - if (outcome.IsSuccess()) { - engineVersionsResult = outcome.GetResult().GetDBEngineVersions(); - } - else { - std::cerr << "Error with RDS::DescribeDBEngineVersionsRequest. " - << outcome.GetError().GetMessage() - << std::endl; - } - - return outcome.IsSuccess(); -} -``` -+ For API details, see [DescribeDBEngineVersions](https://docs.aws.amazon.com/goto/SdkForCpp/rds-2014-10-31/DescribeDBEngineVersions) in *AWS SDK for C\+\+ API Reference*\. - ------- -#### [ Java ] - -**SDK for Java 2\.x** - There's more on GitHub\. Find the complete example and learn how to set up and run in the [AWS Code Examples Repository](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/javav2/example_code/rds#readme)\. - - -``` - public static void describeDBEngines( RdsClient rdsClient) { - try { - DescribeDbEngineVersionsRequest engineVersionsRequest = DescribeDbEngineVersionsRequest.builder() - .defaultOnly(true) - .engine("mysql") - .maxRecords(20) - .build(); - - DescribeDbEngineVersionsResponse response = rdsClient.describeDBEngineVersions(engineVersionsRequest); - List engines = response.dbEngineVersions(); - - // Get all DBEngineVersion objects. - for (DBEngineVersion engineOb: engines) { - System.out.println("The name of the DB parameter group family for the database engine is "+engineOb.dbParameterGroupFamily()); - System.out.println("The name of the database engine "+engineOb.engine()); - System.out.println("The version number of the database engine "+engineOb.engineVersion()); - } - - } catch (RdsException e) { - System.out.println(e.getLocalizedMessage()); - System.exit(1); - } - } -``` -+ For API details, see [DescribeDBEngineVersions](https://docs.aws.amazon.com/goto/SdkForJavaV2/rds-2014-10-31/DescribeDBEngineVersions) in *AWS SDK for Java 2\.x API Reference*\. - ------- -#### [ Python ] - -**SDK for Python \(Boto3\)** - There's more on GitHub\. Find the complete example and learn how to set up and run in the [AWS Code Examples Repository](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/python/example_code/rds#code-examples)\. - - -``` -class InstanceWrapper: - """Encapsulates Amazon RDS DB instance actions.""" - def __init__(self, rds_client): - """ - :param rds_client: A Boto3 Amazon RDS client. - """ - self.rds_client = rds_client - - @classmethod - def from_client(cls): - """ - Instantiates this class from a Boto3 client. - """ - rds_client = boto3.client('rds') - return cls(rds_client) - - def get_engine_versions(self, engine, parameter_group_family=None): - """ - Gets database engine versions that are available for the specified engine - and parameter group family. - - :param engine: The database engine to look up. - :param parameter_group_family: When specified, restricts the returned list of - engine versions to those that are compatible with - this parameter group family. - :return: The list of database engine versions. - """ - try: - kwargs = {'Engine': engine} - if parameter_group_family is not None: - kwargs['DBParameterGroupFamily'] = parameter_group_family - response = self.rds_client.describe_db_engine_versions(**kwargs) - versions = response['DBEngineVersions'] - except ClientError as err: - logger.error( - "Couldn't get engine versions for %s. Here's why: %s: %s", engine, - err.response['Error']['Code'], err.response['Error']['Message']) - raise - else: - return versions -``` -+ For API details, see [DescribeDBEngineVersions](https://docs.aws.amazon.com/goto/boto3/rds-2014-10-31/DescribeDBEngineVersions) in *AWS SDK for Python \(Boto3\) API Reference*\. - ------- - -For a complete list of AWS SDK developer guides and code examples, see [Using this service with an AWS SDK](CHAP_Tutorials.md#sdk-general-information-section)\. This topic also includes information about getting started and details about previous SDK versions\. \ No newline at end of file diff --git a/doc_source/example_rds_DescribeDBInstances_section.md b/doc_source/example_rds_DescribeDBInstances_section.md deleted file mode 100644 index 14c1d46..0000000 --- a/doc_source/example_rds_DescribeDBInstances_section.md +++ /dev/null @@ -1,222 +0,0 @@ -# Describe Amazon RDS DB instances using an AWS SDK - -The following code examples show how to describe Amazon RDS DB instances\. - -**Note** -The source code for these examples is in the [AWS Code Examples GitHub repository](https://github.com/awsdocs/aws-doc-sdk-examples)\. Have feedback on a code example? [Create an Issue](https://github.com/awsdocs/aws-doc-sdk-examples/issues/new/choose) in the code examples repo\. - -Action examples are code excerpts from larger programs and must be run in context\. You can see this action in context in the following code example: -+ [Get started with DB instances](example_rds_Scenario_GetStartedInstances_section.md) - ------- -#### [ \.NET ] - -**AWS SDK for \.NET** - There's more on GitHub\. Find the complete example and learn how to set up and run in the [AWS Code Examples Repository](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/dotnetv3/RDS#code-examples)\. - - -``` - /// - /// Returns a list of DB instances. - /// - /// Optional name of a specific DB instance. - /// List of DB instances. - public async Task> DescribeDBInstances(string dbInstanceIdentifier = null) - { - var results = new List(); - var instancesPaginator = _amazonRDS.Paginators.DescribeDBInstances( - new DescribeDBInstancesRequest - { - DBInstanceIdentifier = dbInstanceIdentifier - }); - // Get the entire list using the paginator. - await foreach (var instances in instancesPaginator.DBInstances) - { - results.Add(instances); - } - return results; - } -``` -+ For API details, see [DescribeDBInstances](https://docs.aws.amazon.com/goto/DotNetSDKV3/rds-2014-10-31/DescribeDBInstances) in *AWS SDK for \.NET API Reference*\. - ------- -#### [ C\+\+ ] - -**SDK for C\+\+** - There's more on GitHub\. Find the complete example and learn how to set up and run in the [AWS Code Examples Repository](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/cpp/example_code/rds#code-examples)\. - - -``` - Aws::Client::ClientConfiguration clientConfig; - // Optional: Set to the AWS Region (overrides config file). - // clientConfig.region = "us-east-1"; - - Aws::RDS::RDSClient client(clientConfig); - - -//! Routine which gets a DB instance description. -/*! - \sa describeDBInstance() - \param dbInstanceIdentifier: A DB instance identifier. - \param instanceResult: The 'DBInstance' object containing the description. - \param client: 'RDSClient' instance. - \return bool: Successful completion. - */ -bool AwsDoc::RDS::describeDBInstance(const Aws::String &dbInstanceIdentifier, - Aws::RDS::Model::DBInstance &instanceResult, - const Aws::RDS::RDSClient &client) { - Aws::RDS::Model::DescribeDBInstancesRequest request; - request.SetDBInstanceIdentifier(dbInstanceIdentifier); - - Aws::RDS::Model::DescribeDBInstancesOutcome outcome = - client.DescribeDBInstances(request); - - bool result = true; - if (outcome.IsSuccess()) { - instanceResult = outcome.GetResult().GetDBInstances()[0]; - } - // This example does not log an error if the DB instance does not exist. - // Instead, it returns false. - else if (outcome.GetError().GetErrorType() != - Aws::RDS::RDSErrors::D_B_INSTANCE_NOT_FOUND_FAULT) { - result = false; - std::cerr << "Error with RDS::DescribeDBInstances. " - << outcome.GetError().GetMessage() - << std::endl; - } - - return result; -} -``` -+ For API details, see [DescribeDBInstances](https://docs.aws.amazon.com/goto/SdkForCpp/rds-2014-10-31/DescribeDBInstances) in *AWS SDK for C\+\+ API Reference*\. - ------- -#### [ Java ] - -**SDK for Java 2\.x** - There's more on GitHub\. Find the complete example and learn how to set up and run in the [AWS Code Examples Repository](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/javav2/example_code/rds#readme)\. - - -``` - public static void describeInstances(RdsClient rdsClient) { - - try { - DescribeDbInstancesResponse response = rdsClient.describeDBInstances(); - List instanceList = response.dbInstances(); - for (DBInstance instance: instanceList) { - System.out.println("Instance ARN is: "+instance.dbInstanceArn()); - System.out.println("The Engine is " +instance.engine()); - System.out.println("Connection endpoint is" +instance.endpoint().address()); - } - - } catch (RdsException e) { - System.out.println(e.getLocalizedMessage()); - System.exit(1); - } - } -``` -+ For API details, see [DescribeDBInstances](https://docs.aws.amazon.com/goto/SdkForJavaV2/rds-2014-10-31/DescribeDBInstances) in *AWS SDK for Java 2\.x API Reference*\. - ------- -#### [ Kotlin ] - -**SDK for Kotlin** -This is prerelease documentation for a feature in preview release\. It is subject to change\. - There's more on GitHub\. Find the complete example and learn how to set up and run in the [AWS Code Examples Repository](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/kotlin/services/rds#code-examples)\. - - -``` -suspend fun describeInstances() { - - RdsClient { region = "us-west-2" }.use { rdsClient -> - val response = rdsClient.describeDbInstances(DescribeDbInstancesRequest {}) - response.dbInstances?.forEach { instance -> - println("Instance Identifier is ${instance.dbInstanceIdentifier}") - println("The Engine is ${instance.engine}") - println("Connection endpoint is ${instance.endpoint?.address}") - } - } -} -``` -+ For API details, see [DescribeDBInstances](https://github.com/awslabs/aws-sdk-kotlin#generating-api-documentation) in *AWS SDK for Kotlin API reference*\. - ------- -#### [ Python ] - -**SDK for Python \(Boto3\)** - There's more on GitHub\. Find the complete example and learn how to set up and run in the [AWS Code Examples Repository](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/python/example_code/rds#code-examples)\. - - -``` -class InstanceWrapper: - """Encapsulates Amazon RDS DB instance actions.""" - def __init__(self, rds_client): - """ - :param rds_client: A Boto3 Amazon RDS client. - """ - self.rds_client = rds_client - - @classmethod - def from_client(cls): - """ - Instantiates this class from a Boto3 client. - """ - rds_client = boto3.client('rds') - return cls(rds_client) - - def get_db_instance(self, instance_id): - """ - Gets data about a DB instance. - - :param instance_id: The ID of the DB instance to retrieve. - :return: The retrieved DB instance. - """ - try: - response = self.rds_client.describe_db_instances( - DBInstanceIdentifier=instance_id) - db_inst = response['DBInstances'][0] - except ClientError as err: - if err.response['Error']['Code'] == 'DBInstanceNotFound': - logger.info("Instance %s does not exist.", instance_id) - else: - logger.error( - "Couldn't get DB instance %s. Here's why: %s: %s", instance_id, - err.response['Error']['Code'], err.response['Error']['Message']) - raise - else: - return db_inst -``` -+ For API details, see [DescribeDBInstances](https://docs.aws.amazon.com/goto/boto3/rds-2014-10-31/DescribeDBInstances) in *AWS SDK for Python \(Boto3\) API Reference*\. - ------- -#### [ Ruby ] - -**SDK for Ruby** - There's more on GitHub\. Find the complete example and learn how to set up and run in the [AWS Code Examples Repository](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/ruby/example_code/rds#code-examples)\. - - -``` -require "aws-sdk-rds" # v2: require 'aws-sdk' - -# List all Amazon Relational Database Service (Amazon RDS) DB instances. -# -# @param rds_resource [Aws::RDS::Resource] An SDK for Ruby Amazon RDS resource. -# @return [Array, nil] List of all DB instances, or nil if error. -def list_instances(rds_resource) - db_instances = [] - rds_resource.db_instances.each do |i| - db_instances.append({ - "name": i.id, - "status": i.db_instance_status - }) - end - db_instances -rescue Aws::Errors::ServiceError => e - puts "Couldn't list instances:\n#{e.message}" -end -``` -+ For API details, see [DescribeDBInstances](https://docs.aws.amazon.com/goto/SdkForRubyV3/rds-2014-10-31/DescribeDBInstances) in *AWS SDK for Ruby API Reference*\. - ------- - -For a complete list of AWS SDK developer guides and code examples, see [Using this service with an AWS SDK](CHAP_Tutorials.md#sdk-general-information-section)\. This topic also includes information about getting started and details about previous SDK versions\. \ No newline at end of file diff --git a/doc_source/example_rds_DescribeDBParameterGroups_section.md b/doc_source/example_rds_DescribeDBParameterGroups_section.md deleted file mode 100644 index 6075059..0000000 --- a/doc_source/example_rds_DescribeDBParameterGroups_section.md +++ /dev/null @@ -1,180 +0,0 @@ -# Describe Amazon RDS DB parameter groups using an AWS SDK - -The following code examples show how to describe Amazon RDS DB parameter groups\. - -**Note** -The source code for these examples is in the [AWS Code Examples GitHub repository](https://github.com/awsdocs/aws-doc-sdk-examples)\. Have feedback on a code example? [Create an Issue](https://github.com/awsdocs/aws-doc-sdk-examples/issues/new/choose) in the code examples repo\. - -Action examples are code excerpts from larger programs and must be run in context\. You can see this action in context in the following code example: -+ [Get started with DB instances](example_rds_Scenario_GetStartedInstances_section.md) - ------- -#### [ \.NET ] - -**AWS SDK for \.NET** - There's more on GitHub\. Find the complete example and learn how to set up and run in the [AWS Code Examples Repository](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/dotnetv3/RDS#code-examples)\. - - -``` - /// - /// Get descriptions of DB parameter groups. - /// - /// Optional name of the DB parameter group to describe. - /// The list of DB parameter group descriptions. - public async Task> DescribeDBParameterGroups(string name = null) - { - var response = await _amazonRDS.DescribeDBParameterGroupsAsync( - new DescribeDBParameterGroupsRequest() - { - DBParameterGroupName = name - }); - return response.DBParameterGroups; - } -``` -+ For API details, see [DescribeDBParameterGroups](https://docs.aws.amazon.com/goto/DotNetSDKV3/rds-2014-10-31/DescribeDBParameterGroups) in *AWS SDK for \.NET API Reference*\. - ------- -#### [ C\+\+ ] - -**SDK for C\+\+** - There's more on GitHub\. Find the complete example and learn how to set up and run in the [AWS Code Examples Repository](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/cpp/example_code/rds#code-examples)\. - - -``` - Aws::Client::ClientConfiguration clientConfig; - // Optional: Set to the AWS Region (overrides config file). - // clientConfig.region = "us-east-1"; - - Aws::RDS::RDSClient client(clientConfig); - - Aws::RDS::Model::DescribeDBParameterGroupsRequest request; - request.SetDBParameterGroupName(PARAMETER_GROUP_NAME); - - Aws::RDS::Model::DescribeDBParameterGroupsOutcome outcome = - client.DescribeDBParameterGroups(request); - - if (outcome.IsSuccess()) { - std::cout << "DB parameter group named '" << - PARAMETER_GROUP_NAME << "' already exists." << std::endl; - dbParameterGroupFamily = outcome.GetResult().GetDBParameterGroups()[0].GetDBParameterGroupFamily(); - } - - else { - std::cerr << "Error with RDS::DescribeDBParameterGroups. " - << outcome.GetError().GetMessage() - << std::endl; - return false; - } -``` -+ For API details, see [DescribeDBParameterGroups](https://docs.aws.amazon.com/goto/SdkForCpp/rds-2014-10-31/DescribeDBParameterGroups) in *AWS SDK for C\+\+ API Reference*\. - ------- -#### [ Java ] - -**SDK for Java 2\.x** - There's more on GitHub\. Find the complete example and learn how to set up and run in the [AWS Code Examples Repository](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/javav2/example_code/rds#readme)\. - - -``` - public static void describeDbParameterGroups(RdsClient rdsClient, String dbGroupName) { - try { - DescribeDbParameterGroupsRequest groupsRequest = DescribeDbParameterGroupsRequest.builder() - .dbParameterGroupName(dbGroupName) - .maxRecords(20) - .build(); - - DescribeDbParameterGroupsResponse response = rdsClient.describeDBParameterGroups(groupsRequest); - List groups = response.dbParameterGroups(); - for (DBParameterGroup group: groups) { - System.out.println("The group name is "+group.dbParameterGroupName()); - System.out.println("The group description is "+group.description()); - } - - } catch (RdsException e) { - System.out.println(e.getLocalizedMessage()); - System.exit(1); - } - } -``` -+ For API details, see [DescribeDBParameterGroups](https://docs.aws.amazon.com/goto/SdkForJavaV2/rds-2014-10-31/DescribeDBParameterGroups) in *AWS SDK for Java 2\.x API Reference*\. - ------- -#### [ Python ] - -**SDK for Python \(Boto3\)** - There's more on GitHub\. Find the complete example and learn how to set up and run in the [AWS Code Examples Repository](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/python/example_code/rds#code-examples)\. - - -``` -class InstanceWrapper: - """Encapsulates Amazon RDS DB instance actions.""" - def __init__(self, rds_client): - """ - :param rds_client: A Boto3 Amazon RDS client. - """ - self.rds_client = rds_client - - @classmethod - def from_client(cls): - """ - Instantiates this class from a Boto3 client. - """ - rds_client = boto3.client('rds') - return cls(rds_client) - - def get_parameter_group(self, parameter_group_name): - """ - Gets a DB parameter group. - - :param parameter_group_name: The name of the parameter group to retrieve. - :return: The parameter group. - """ - try: - response = self.rds_client.describe_db_parameter_groups( - DBParameterGroupName=parameter_group_name) - parameter_group = response['DBParameterGroups'][0] - except ClientError as err: - if err.response['Error']['Code'] == 'DBParameterGroupNotFound': - logger.info("Parameter group %s does not exist.", parameter_group_name) - else: - logger.error( - "Couldn't get parameter group %s. Here's why: %s: %s", parameter_group_name, - err.response['Error']['Code'], err.response['Error']['Message']) - raise - else: - return parameter_group -``` -+ For API details, see [DescribeDBParameterGroups](https://docs.aws.amazon.com/goto/boto3/rds-2014-10-31/DescribeDBParameterGroups) in *AWS SDK for Python \(Boto3\) API Reference*\. - ------- -#### [ Ruby ] - -**SDK for Ruby** - There's more on GitHub\. Find the complete example and learn how to set up and run in the [AWS Code Examples Repository](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/ruby/example_code/rds#code-examples)\. - - -``` -require "aws-sdk-rds" # v2: require 'aws-sdk' - -# List all Amazon Relational Database Service (Amazon RDS) parameter groups. -# -# @param rds_resource [Aws::RDS::Resource] An SDK for Ruby Amazon RDS resource. -# @return [Array, nil] List of all parameter groups, or nil if error. -def list_parameter_groups(rds_resource) - parameter_groups = [] - rds_resource.db_parameter_groups.each do |p| - parameter_groups.append({ - "name": p.db_parameter_group_name, - "description": p.description - }) - end - parameter_groups -rescue Aws::Errors::ServiceError => e - puts "Couldn't list parameter groups:\n #{e.message}" -end -``` -+ For API details, see [DescribeDBParameterGroups](https://docs.aws.amazon.com/goto/SdkForRubyV3/rds-2014-10-31/DescribeDBParameterGroups) in *AWS SDK for Ruby API Reference*\. - ------- - -For a complete list of AWS SDK developer guides and code examples, see [Using this service with an AWS SDK](CHAP_Tutorials.md#sdk-general-information-section)\. This topic also includes information about getting started and details about previous SDK versions\. \ No newline at end of file diff --git a/doc_source/example_rds_DescribeDBParameters_section.md b/doc_source/example_rds_DescribeDBParameters_section.md deleted file mode 100644 index 131bed3..0000000 --- a/doc_source/example_rds_DescribeDBParameters_section.md +++ /dev/null @@ -1,249 +0,0 @@ -# Describe parameters in an Amazon RDS DB parameter group using an AWS SDK - -The following code examples show how to describe parameters in an Amazon RDS DB parameter group\. - -**Note** -The source code for these examples is in the [AWS Code Examples GitHub repository](https://github.com/awsdocs/aws-doc-sdk-examples)\. Have feedback on a code example? [Create an Issue](https://github.com/awsdocs/aws-doc-sdk-examples/issues/new/choose) in the code examples repo\. - -Action examples are code excerpts from larger programs and must be run in context\. You can see this action in context in the following code example: -+ [Get started with DB instances](example_rds_Scenario_GetStartedInstances_section.md) - ------- -#### [ \.NET ] - -**AWS SDK for \.NET** - There's more on GitHub\. Find the complete example and learn how to set up and run in the [AWS Code Examples Repository](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/dotnetv3/RDS#code-examples)\. - - -``` - /// - /// Get a list of DB parameters from a specific parameter group. - /// - /// Name of a specific DB parameter group. - /// Optional source for selecting parameters. - /// List of parameter values. - public async Task> DescribeDBParameters(string dbParameterGroupName, string source = null) - { - var results = new List(); - var paginateParameters = _amazonRDS.Paginators.DescribeDBParameters( - new DescribeDBParametersRequest() - { - DBParameterGroupName = dbParameterGroupName, - Source = source - }); - // Get the entire list using the paginator. - await foreach (var parameters in paginateParameters.Parameters) - { - results.Add(parameters); - } - return results; - } -``` -+ For API details, see [DescribeDBParameters](https://docs.aws.amazon.com/goto/DotNetSDKV3/rds-2014-10-31/DescribeDBParameters) in *AWS SDK for \.NET API Reference*\. - ------- -#### [ C\+\+ ] - -**SDK for C\+\+** - There's more on GitHub\. Find the complete example and learn how to set up and run in the [AWS Code Examples Repository](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/cpp/example_code/rds#code-examples)\. - - -``` - Aws::Client::ClientConfiguration clientConfig; - // Optional: Set to the AWS Region (overrides config file). - // clientConfig.region = "us-east-1"; - - Aws::RDS::RDSClient client(clientConfig); - - -//! Routine which gets DB parameters using the 'DescribeDBParameters' api. -/*! - \sa getDBParameters() - \param parameterGroupName: The name of the parameter group. - \param namePrefix: Prefix string to filter results by parameter name. - \param source: A source such as 'user', ignored if empty. - \param parametersResult: Vector of 'Parameter' objects returned by the routine. - \param client: 'RDSClient' instance. - \return bool: Successful completion. - */ -bool AwsDoc::RDS::getDBParameters(const Aws::String ¶meterGroupName, - const Aws::String &namePrefix, - const Aws::String &source, - Aws::Vector ¶metersResult, - const Aws::RDS::RDSClient &client) { - Aws::String marker; - do { - Aws::RDS::Model::DescribeDBParametersRequest request; - request.SetDBParameterGroupName(PARAMETER_GROUP_NAME); - if (!marker.empty()) { - request.SetMarker(marker); - } - if (!source.empty()) { - request.SetSource(source); - } - - Aws::RDS::Model::DescribeDBParametersOutcome outcome = - client.DescribeDBParameters(request); - - if (outcome.IsSuccess()) { - const Aws::Vector ¶meters = - outcome.GetResult().GetParameters(); - for (const Aws::RDS::Model::Parameter ¶meter: parameters) { - if (!namePrefix.empty()) { - if (parameter.GetParameterName().find(namePrefix) == 0) { - parametersResult.push_back(parameter); - } - } - else { - parametersResult.push_back(parameter); - } - } - - marker = outcome.GetResult().GetMarker(); - } - else { - std::cerr << "Error with RDS::DescribeDBParameters. " - << outcome.GetError().GetMessage() - << std::endl; - return false; - } - } while (!marker.empty()); - - return true; -} -``` -+ For API details, see [DescribeDBParameters](https://docs.aws.amazon.com/goto/SdkForCpp/rds-2014-10-31/DescribeDBParameters) in *AWS SDK for C\+\+ API Reference*\. - ------- -#### [ Java ] - -**SDK for Java 2\.x** - There's more on GitHub\. Find the complete example and learn how to set up and run in the [AWS Code Examples Repository](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/javav2/example_code/rds#readme)\. - - -``` - // Retrieve parameters in the group. - public static void describeDbParameters(RdsClient rdsClient, String dbGroupName, int flag) { - try { - DescribeDbParametersRequest dbParameterGroupsRequest; - if (flag == 0) { - dbParameterGroupsRequest = DescribeDbParametersRequest.builder() - .dbParameterGroupName(dbGroupName) - .build(); - } else { - dbParameterGroupsRequest = DescribeDbParametersRequest.builder() - .dbParameterGroupName(dbGroupName) - .source("user") - .build(); - } - - DescribeDbParametersResponse response = rdsClient.describeDBParameters(dbParameterGroupsRequest); - List dbParameters = response.parameters(); - String paraName; - for (Parameter para: dbParameters) { - // Only print out information about either auto_increment_offset or auto_increment_increment. - paraName = para.parameterName(); - if ( (paraName.compareTo("auto_increment_offset") ==0) || (paraName.compareTo("auto_increment_increment ") ==0)) { - System.out.println("*** The parameter name is " + paraName); - System.out.println("*** The parameter value is " + para.parameterValue()); - System.out.println("*** The parameter data type is " + para.dataType()); - System.out.println("*** The parameter description is " + para.description()); - System.out.println("*** The parameter allowed values is " + para.allowedValues()); - } - } - - } catch (RdsException e) { - System.out.println(e.getLocalizedMessage()); - System.exit(1); - } - } -``` -+ For API details, see [DescribeDBParameters](https://docs.aws.amazon.com/goto/SdkForJavaV2/rds-2014-10-31/DescribeDBParameters) in *AWS SDK for Java 2\.x API Reference*\. - ------- -#### [ Python ] - -**SDK for Python \(Boto3\)** - There's more on GitHub\. Find the complete example and learn how to set up and run in the [AWS Code Examples Repository](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/python/example_code/rds#code-examples)\. - - -``` -class InstanceWrapper: - """Encapsulates Amazon RDS DB instance actions.""" - def __init__(self, rds_client): - """ - :param rds_client: A Boto3 Amazon RDS client. - """ - self.rds_client = rds_client - - @classmethod - def from_client(cls): - """ - Instantiates this class from a Boto3 client. - """ - rds_client = boto3.client('rds') - return cls(rds_client) - - def get_parameters(self, parameter_group_name, name_prefix='', source=None): - """ - Gets the parameters that are contained in a DB parameter group. - - :param parameter_group_name: The name of the parameter group to query. - :param name_prefix: When specified, the retrieved list of parameters is filtered - to contain only parameters that start with this prefix. - :param source: When specified, only parameters from this source are retrieved. - For example, a source of 'user' retrieves only parameters that - were set by a user. - :return: The list of requested parameters. - """ - try: - kwargs = {'DBParameterGroupName': parameter_group_name} - if source is not None: - kwargs['Source'] = source - parameters = [] - paginator = self.rds_client.get_paginator('describe_db_parameters') - for page in paginator.paginate(**kwargs): - parameters += [ - p for p in page['Parameters'] if p['ParameterName'].startswith(name_prefix)] - except ClientError as err: - logger.error( - "Couldn't get parameters for %s. Here's why: %s: %s", parameter_group_name, - err.response['Error']['Code'], err.response['Error']['Message']) - raise - else: - return parameters -``` -+ For API details, see [DescribeDBParameters](https://docs.aws.amazon.com/goto/boto3/rds-2014-10-31/DescribeDBParameters) in *AWS SDK for Python \(Boto3\) API Reference*\. - ------- -#### [ Ruby ] - -**SDK for Ruby** - There's more on GitHub\. Find the complete example and learn how to set up and run in the [AWS Code Examples Repository](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/ruby/example_code/rds#code-examples)\. - - -``` -require "aws-sdk-rds" # v2: require 'aws-sdk' - -# List all Amazon Relational Database Service (Amazon RDS) parameter groups. -# -# @param rds_resource [Aws::RDS::Resource] An SDK for Ruby Amazon RDS resource. -# @return [Array, nil] List of all parameter groups, or nil if error. -def list_parameter_groups(rds_resource) - parameter_groups = [] - rds_resource.db_parameter_groups.each do |p| - parameter_groups.append({ - "name": p.db_parameter_group_name, - "description": p.description - }) - end - parameter_groups -rescue Aws::Errors::ServiceError => e - puts "Couldn't list parameter groups:\n #{e.message}" -end -``` -+ For API details, see [DescribeDBParameters](https://docs.aws.amazon.com/goto/SdkForRubyV3/rds-2014-10-31/DescribeDBParameters) in *AWS SDK for Ruby API Reference*\. - ------- - -For a complete list of AWS SDK developer guides and code examples, see [Using this service with an AWS SDK](CHAP_Tutorials.md#sdk-general-information-section)\. This topic also includes information about getting started and details about previous SDK versions\. \ No newline at end of file diff --git a/doc_source/example_rds_DescribeDBSnapshots_section.md b/doc_source/example_rds_DescribeDBSnapshots_section.md deleted file mode 100644 index 4610316..0000000 --- a/doc_source/example_rds_DescribeDBSnapshots_section.md +++ /dev/null @@ -1,153 +0,0 @@ -# Describe snapshots of Amazon RDS DB instances using an AWS SDK - -The following code examples show how to describe snapshots of Amazon RDS DB instances\. - -**Note** -The source code for these examples is in the [AWS Code Examples GitHub repository](https://github.com/awsdocs/aws-doc-sdk-examples)\. Have feedback on a code example? [Create an Issue](https://github.com/awsdocs/aws-doc-sdk-examples/issues/new/choose) in the code examples repo\. - -Action examples are code excerpts from larger programs and must be run in context\. You can see this action in context in the following code example: -+ [Get started with DB instances](example_rds_Scenario_GetStartedInstances_section.md) - ------- -#### [ \.NET ] - -**AWS SDK for \.NET** - There's more on GitHub\. Find the complete example and learn how to set up and run in the [AWS Code Examples Repository](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/dotnetv3/RDS#code-examples)\. - - -``` - /// - /// Return a list of DB snapshots for a particular DB instance. - /// - /// DB instance identifier. - /// List of DB snapshots. - public async Task> DescribeDBSnapshots(string dbInstanceIdentifier) - { - var results = new List(); - var snapshotsPaginator = _amazonRDS.Paginators.DescribeDBSnapshots( - new DescribeDBSnapshotsRequest() - { - DBInstanceIdentifier = dbInstanceIdentifier - }); - - // Get the entire list using the paginator. - await foreach (var snapshots in snapshotsPaginator.DBSnapshots) - { - results.Add(snapshots); - } - return results; - } -``` -+ For API details, see [DescribeDBSnapshots](https://docs.aws.amazon.com/goto/DotNetSDKV3/rds-2014-10-31/DescribeDBSnapshots) in *AWS SDK for \.NET API Reference*\. - ------- -#### [ C\+\+ ] - -**SDK for C\+\+** - There's more on GitHub\. Find the complete example and learn how to set up and run in the [AWS Code Examples Repository](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/cpp/example_code/rds#code-examples)\. - - -``` - Aws::Client::ClientConfiguration clientConfig; - // Optional: Set to the AWS Region (overrides config file). - // clientConfig.region = "us-east-1"; - - Aws::RDS::RDSClient client(clientConfig); - - Aws::RDS::Model::DescribeDBSnapshotsRequest request; - request.SetDBSnapshotIdentifier(snapshotID); - - Aws::RDS::Model::DescribeDBSnapshotsOutcome outcome = - client.DescribeDBSnapshots(request); - - if (outcome.IsSuccess()) { - snapshot = outcome.GetResult().GetDBSnapshots()[0]; - } - else { - std::cerr << "Error with RDS::DescribeDBSnapshots. " - << outcome.GetError().GetMessage() - << std::endl; - cleanUpResources(PARAMETER_GROUP_NAME, DB_INSTANCE_IDENTIFIER, client); - return false; - } -``` -+ For API details, see [DescribeDBSnapshots](https://docs.aws.amazon.com/goto/SdkForCpp/rds-2014-10-31/DescribeDBSnapshots) in *AWS SDK for C\+\+ API Reference*\. - ------- -#### [ Python ] - -**SDK for Python \(Boto3\)** - There's more on GitHub\. Find the complete example and learn how to set up and run in the [AWS Code Examples Repository](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/python/example_code/rds#code-examples)\. - - -``` -class InstanceWrapper: - """Encapsulates Amazon RDS DB instance actions.""" - def __init__(self, rds_client): - """ - :param rds_client: A Boto3 Amazon RDS client. - """ - self.rds_client = rds_client - - @classmethod - def from_client(cls): - """ - Instantiates this class from a Boto3 client. - """ - rds_client = boto3.client('rds') - return cls(rds_client) - - def get_snapshot(self, snapshot_id): - """ - Gets a DB instance snapshot. - - :param snapshot_id: The ID of the snapshot to retrieve. - :return: The retrieved snapshot. - """ - try: - response = self.rds_client.describe_db_snapshots( - DBSnapshotIdentifier=snapshot_id) - snapshot = response['DBSnapshots'][0] - except ClientError as err: - logger.error( - "Couldn't get snapshot %s. Here's why: %s: %s", snapshot_id, - err.response['Error']['Code'], err.response['Error']['Message']) - raise - else: - return snapshot -``` -+ For API details, see [DescribeDBSnapshots](https://docs.aws.amazon.com/goto/boto3/rds-2014-10-31/DescribeDBSnapshots) in *AWS SDK for Python \(Boto3\) API Reference*\. - ------- -#### [ Ruby ] - -**SDK for Ruby** - There's more on GitHub\. Find the complete example and learn how to set up and run in the [AWS Code Examples Repository](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/ruby/example_code/rds#code-examples)\. - - -``` -require "aws-sdk-rds" # v2: require 'aws-sdk' - -# List all Amazon Relational Database Service (Amazon RDS) DB instance -# snapshots. -# -# @param rds_resource [Aws::RDS::Resource] An SDK for Ruby Amazon RDS resource. -# @return instance_snapshots [Array, nil] All instance snapshots, or nil if error. -def list_instance_snapshots(rds_resource) - instance_snapshots = [] - rds_resource.db_snapshots.each do |s| - instance_snapshots.append({ - "id": s.snapshot_id, - "status": s.status - }) - end - instance_snapshots -rescue Aws::Errors::ServiceError => e - puts "Couldn't list instance snapshots:\n #{e.message}" -end -``` -+ For API details, see [DescribeDBSnapshots](https://docs.aws.amazon.com/goto/SdkForRubyV3/rds-2014-10-31/DescribeDBSnapshots) in *AWS SDK for Ruby API Reference*\. - ------- - -For a complete list of AWS SDK developer guides and code examples, see [Using this service with an AWS SDK](CHAP_Tutorials.md#sdk-general-information-section)\. This topic also includes information about getting started and details about previous SDK versions\. \ No newline at end of file diff --git a/doc_source/example_rds_DescribeOrderableDBInstanceOptions_section.md b/doc_source/example_rds_DescribeOrderableDBInstanceOptions_section.md deleted file mode 100644 index 79961a0..0000000 --- a/doc_source/example_rds_DescribeOrderableDBInstanceOptions_section.md +++ /dev/null @@ -1,207 +0,0 @@ -# Describe options for Amazon RDS DB instances using an AWS SDK - -The following code examples show how to describe options for Amazon RDS DB instances\. - -**Note** -The source code for these examples is in the [AWS Code Examples GitHub repository](https://github.com/awsdocs/aws-doc-sdk-examples)\. Have feedback on a code example? [Create an Issue](https://github.com/awsdocs/aws-doc-sdk-examples/issues/new/choose) in the code examples repo\. - -Action examples are code excerpts from larger programs and must be run in context\. You can see this action in context in the following code example: -+ [Get started with DB instances](example_rds_Scenario_GetStartedInstances_section.md) - ------- -#### [ \.NET ] - -**AWS SDK for \.NET** - There's more on GitHub\. Find the complete example and learn how to set up and run in the [AWS Code Examples Repository](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/dotnetv3/RDS#code-examples)\. - - -``` - /// - /// Get a list of orderable DB instance options for a specific - /// engine and engine version. - /// - /// Name of the engine. - /// Version of the engine. - /// List of OrderableDBInstanceOptions. - public async Task> DescribeOrderableDBInstanceOptions(string engine, string engineVersion) - { - // Use a paginator to get a list of DB instance options. - var results = new List(); - var paginateInstanceOptions = _amazonRDS.Paginators.DescribeOrderableDBInstanceOptions( - new DescribeOrderableDBInstanceOptionsRequest() - { - Engine = engine, - EngineVersion = engineVersion, - }); - // Get the entire list using the paginator. - await foreach (var instanceOptions in paginateInstanceOptions.OrderableDBInstanceOptions) - { - results.Add(instanceOptions); - } - return results; - } -``` -+ For API details, see [DescribeOrderableDBInstanceOptions](https://docs.aws.amazon.com/goto/DotNetSDKV3/rds-2014-10-31/DescribeOrderableDBInstanceOptions) in *AWS SDK for \.NET API Reference*\. - ------- -#### [ C\+\+ ] - -**SDK for C\+\+** - There's more on GitHub\. Find the complete example and learn how to set up and run in the [AWS Code Examples Repository](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/cpp/example_code/rds#code-examples)\. - - -``` - Aws::Client::ClientConfiguration clientConfig; - // Optional: Set to the AWS Region (overrides config file). - // clientConfig.region = "us-east-1"; - - Aws::RDS::RDSClient client(clientConfig); - - -//! Routine which gets available 'micro' DB instance classes, displays the list -//! to the user, and returns the user selection. -/*! - \sa chooseMicroDBInstanceClass() - \param engineName: The DB engine name. - \param engineVersion: The DB engine version. - \param dbInstanceClass: String for DB instance class chosen by the user. - \param client: 'RDSClient' instance. - \return bool: Successful completion. - */ -bool AwsDoc::RDS::chooseMicroDBInstanceClass(const Aws::String &engine, - const Aws::String &engineVersion, - Aws::String &dbInstanceClass, - const Aws::RDS::RDSClient &client) { - std::vector instanceClasses; - Aws::String marker; - do { - Aws::RDS::Model::DescribeOrderableDBInstanceOptionsRequest request; - request.SetEngine(engine); - request.SetEngineVersion(engineVersion); - if (!marker.empty()) { - request.SetMarker(marker); - } - - Aws::RDS::Model::DescribeOrderableDBInstanceOptionsOutcome outcome = - client.DescribeOrderableDBInstanceOptions(request); - - if (outcome.IsSuccess()) { - const Aws::Vector &options = - outcome.GetResult().GetOrderableDBInstanceOptions(); - for (const Aws::RDS::Model::OrderableDBInstanceOption &option: options) { - const Aws::String &instanceClass = option.GetDBInstanceClass(); - if (instanceClass.find("micro") != std::string::npos) { - if (std::find(instanceClasses.begin(), instanceClasses.end(), - instanceClass) == - instanceClasses.end()) { - instanceClasses.push_back(instanceClass); - } - } - } - marker = outcome.GetResult().GetMarker(); - } - else { - std::cerr << "Error with RDS::DescribeOrderableDBInstanceOptions. " - << outcome.GetError().GetMessage() - << std::endl; - return false; - } - } while (!marker.empty()); - - std::cout << "The available micro DB instance classes for your database engine are:" - << std::endl; - for (int i = 0; i < instanceClasses.size(); ++i) { - std::cout << " " << i + 1 << ": " << instanceClasses[i] << std::endl; - } - - int choice = askQuestionForIntRange( - "Which micro DB instance class do you want to use? ", - 1, static_cast(instanceClasses.size())); - dbInstanceClass = instanceClasses[choice - 1]; - return true; -} -``` -+ For API details, see [DescribeOrderableDBInstanceOptions](https://docs.aws.amazon.com/goto/SdkForCpp/rds-2014-10-31/DescribeOrderableDBInstanceOptions) in *AWS SDK for C\+\+ API Reference*\. - ------- -#### [ Java ] - -**SDK for Java 2\.x** - There's more on GitHub\. Find the complete example and learn how to set up and run in the [AWS Code Examples Repository](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/javav2/example_code/rds#readme)\. - - -``` - // Get a list of allowed engine versions. - public static void getAllowedEngines(RdsClient rdsClient, String dbParameterGroupFamily) { - try { - DescribeDbEngineVersionsRequest versionsRequest = DescribeDbEngineVersionsRequest.builder() - .dbParameterGroupFamily(dbParameterGroupFamily) - .engine("mysql") - .build(); - - DescribeDbEngineVersionsResponse response = rdsClient.describeDBEngineVersions(versionsRequest); - List dbEngines = response.dbEngineVersions(); - for (DBEngineVersion dbEngine: dbEngines) { - System.out.println("The engine version is " +dbEngine.engineVersion()); - System.out.println("The engine description is " +dbEngine.dbEngineDescription()); - } - - } catch (RdsException e) { - System.out.println(e.getLocalizedMessage()); - System.exit(1); - } - } -``` -+ For API details, see [DescribeOrderableDBInstanceOptions](https://docs.aws.amazon.com/goto/SdkForJavaV2/rds-2014-10-31/DescribeOrderableDBInstanceOptions) in *AWS SDK for Java 2\.x API Reference*\. - ------- -#### [ Python ] - -**SDK for Python \(Boto3\)** - There's more on GitHub\. Find the complete example and learn how to set up and run in the [AWS Code Examples Repository](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/python/example_code/rds#code-examples)\. - - -``` -class InstanceWrapper: - """Encapsulates Amazon RDS DB instance actions.""" - def __init__(self, rds_client): - """ - :param rds_client: A Boto3 Amazon RDS client. - """ - self.rds_client = rds_client - - @classmethod - def from_client(cls): - """ - Instantiates this class from a Boto3 client. - """ - rds_client = boto3.client('rds') - return cls(rds_client) - - def get_orderable_instances(self, db_engine, db_engine_version): - """ - Gets DB instance options that can be used to create DB instances that are - compatible with a set of specifications. - - :param db_engine: The database engine that must be supported by the DB instance. - :param db_engine_version: The engine version that must be supported by the DB instance. - :return: The list of DB instance options that can be used to create a compatible DB instance. - """ - try: - inst_opts = [] - paginator = self.rds_client.get_paginator('describe_orderable_db_instance_options') - for page in paginator.paginate(Engine=db_engine, EngineVersion=db_engine_version): - inst_opts += page['OrderableDBInstanceOptions'] - except ClientError as err: - logger.error( - "Couldn't get orderable DB instances. Here's why: %s: %s", - err.response['Error']['Code'], err.response['Error']['Message']) - raise - else: - return inst_opts -``` -+ For API details, see [DescribeOrderableDBInstanceOptions](https://docs.aws.amazon.com/goto/boto3/rds-2014-10-31/DescribeOrderableDBInstanceOptions) in *AWS SDK for Python \(Boto3\) API Reference*\. - ------- - -For a complete list of AWS SDK developer guides and code examples, see [Using this service with an AWS SDK](CHAP_Tutorials.md#sdk-general-information-section)\. This topic also includes information about getting started and details about previous SDK versions\. \ No newline at end of file diff --git a/doc_source/example_rds_GenerateRDSAuthToken_section.md b/doc_source/example_rds_GenerateRDSAuthToken_section.md deleted file mode 100644 index 14a2ff0..0000000 --- a/doc_source/example_rds_GenerateRDSAuthToken_section.md +++ /dev/null @@ -1,69 +0,0 @@ -# Create an authentication token for IAM authentication to an Amazon RDS database using an AWS SDK - -The following code example shows how to create an authentication token for IAM authentication\. - -**Note** -The source code for these examples is in the [AWS Code Examples GitHub repository](https://github.com/awsdocs/aws-doc-sdk-examples)\. Have feedback on a code example? [Create an Issue](https://github.com/awsdocs/aws-doc-sdk-examples/issues/new/choose) in the code examples repo\. - ------- -#### [ Java ] - -**SDK for Java 2\.x** - There's more on GitHub\. Find the complete example and learn how to set up and run in the [AWS Code Examples Repository](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/javav2/example_code/rds#readme)\. -Use the [RdsUtilities](https://sdk.amazonaws.com/java/api/latest/software/amazon/awssdk/services/rds/RdsUtilities.html) class to generate an authentication token\. - -``` -public class GenerateRDSAuthToken { - - public static void main(String[] args) { - - final String usage = "\n" + - "Usage:\n" + - " \n\n" + - "Where:\n" + - " dbInstanceIdentifier - The database instance identifier. \n" + - " masterUsername - The master user name. \n"; - - if (args.length != 2) { - System.out.println(usage); - System.exit(1); - } - - String dbInstanceIdentifier = args[0]; - String masterUsername = args[1]; - Region region = Region.US_WEST_2; - RdsClient rdsClient = RdsClient.builder() - .region(region) - .credentialsProvider(ProfileCredentialsProvider.create()) - .build(); - - String token = getAuthToken(rdsClient, dbInstanceIdentifier, masterUsername); - System.out.println("The token response is "+token); - } - - public static String getAuthToken(RdsClient rdsClient, String dbInstanceIdentifier, String masterUsername ) { - - RdsUtilities utilities = rdsClient.utilities(); - try { - GenerateAuthenticationTokenRequest tokenRequest = GenerateAuthenticationTokenRequest.builder() - .credentialsProvider(ProfileCredentialsProvider.create()) - .username(masterUsername) - .port(3306) - .hostname(dbInstanceIdentifier) - .build(); - - return utilities.generateAuthenticationToken(tokenRequest); - - } catch (RdsException e) { - System.out.println(e.getLocalizedMessage()); - System.exit(1); - } - return ""; - } -} -``` -+ For API details, see [GenerateRDSAuthToken](https://docs.aws.amazon.com/goto/SdkForJavaV2/rds-2014-10-31/GenerateRDSAuthToken) in *AWS SDK for Java 2\.x API Reference*\. - ------- - -For a complete list of AWS SDK developer guides and code examples, see [Using this service with an AWS SDK](CHAP_Tutorials.md#sdk-general-information-section)\. This topic also includes information about getting started and details about previous SDK versions\. \ No newline at end of file diff --git a/doc_source/example_rds_ModifyDBInstance_section.md b/doc_source/example_rds_ModifyDBInstance_section.md deleted file mode 100644 index 3fdf54c..0000000 --- a/doc_source/example_rds_ModifyDBInstance_section.md +++ /dev/null @@ -1,64 +0,0 @@ -# Modify an Amazon RDS DB instance using an AWS SDK - -The following code examples show how to modify an Amazon RDS DB instance\. - -**Note** -The source code for these examples is in the [AWS Code Examples GitHub repository](https://github.com/awsdocs/aws-doc-sdk-examples)\. Have feedback on a code example? [Create an Issue](https://github.com/awsdocs/aws-doc-sdk-examples/issues/new/choose) in the code examples repo\. - ------- -#### [ Java ] - -**SDK for Java 2\.x** - There's more on GitHub\. Find the complete example and learn how to set up and run in the [AWS Code Examples Repository](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/javav2/example_code/rds#readme)\. - - -``` - public static void updateIntance(RdsClient rdsClient, String dbInstanceIdentifier, String masterUserPassword) { - - try { - // For a demo - modify the DB instance by modifying the master password. - ModifyDbInstanceRequest modifyDbInstanceRequest = ModifyDbInstanceRequest.builder() - .dbInstanceIdentifier(dbInstanceIdentifier) - .publiclyAccessible(true) - .masterUserPassword(masterUserPassword) - .build(); - - ModifyDbInstanceResponse instanceResponse = rdsClient.modifyDBInstance(modifyDbInstanceRequest); - System.out.print("The ARN of the modified database is: " +instanceResponse.dbInstance().dbInstanceArn()); - - } catch (RdsException e) { - System.out.println(e.getLocalizedMessage()); - System.exit(1); - } - } -``` -+ For API details, see [ModifyDBInstance](https://docs.aws.amazon.com/goto/SdkForJavaV2/rds-2014-10-31/ModifyDBInstance) in *AWS SDK for Java 2\.x API Reference*\. - ------- -#### [ Kotlin ] - -**SDK for Kotlin** -This is prerelease documentation for a feature in preview release\. It is subject to change\. - There's more on GitHub\. Find the complete example and learn how to set up and run in the [AWS Code Examples Repository](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/kotlin/services/rds#code-examples)\. - - -``` -suspend fun updateIntance(dbInstanceIdentifierVal: String?, masterUserPasswordVal: String?) { - - val request = ModifyDbInstanceRequest { - dbInstanceIdentifier = dbInstanceIdentifierVal - publiclyAccessible = true - masterUserPassword = masterUserPasswordVal - } - - RdsClient { region = "us-west-2" }.use { rdsClient -> - val instanceResponse = rdsClient.modifyDbInstance(request) - println("The ARN of the modified database is ${instanceResponse.dbInstance?.dbInstanceArn}") - } -} -``` -+ For API details, see [ModifyDBInstance](https://github.com/awslabs/aws-sdk-kotlin#generating-api-documentation) in *AWS SDK for Kotlin API reference*\. - ------- - -For a complete list of AWS SDK developer guides and code examples, see [Using this service with an AWS SDK](CHAP_Tutorials.md#sdk-general-information-section)\. This topic also includes information about getting started and details about previous SDK versions\. \ No newline at end of file diff --git a/doc_source/example_rds_ModifyDBParameterGroup_section.md b/doc_source/example_rds_ModifyDBParameterGroup_section.md deleted file mode 100644 index 9387df7..0000000 --- a/doc_source/example_rds_ModifyDBParameterGroup_section.md +++ /dev/null @@ -1,155 +0,0 @@ -# Update parameters in an Amazon RDS DB parameter group using an AWS SDK - -The following code examples show how to update parameters in an Amazon RDS DB parameter group\. - -**Note** -The source code for these examples is in the [AWS Code Examples GitHub repository](https://github.com/awsdocs/aws-doc-sdk-examples)\. Have feedback on a code example? [Create an Issue](https://github.com/awsdocs/aws-doc-sdk-examples/issues/new/choose) in the code examples repo\. - -Action examples are code excerpts from larger programs and must be run in context\. You can see this action in context in the following code example: -+ [Get started with DB instances](example_rds_Scenario_GetStartedInstances_section.md) - ------- -#### [ \.NET ] - -**AWS SDK for \.NET** - There's more on GitHub\. Find the complete example and learn how to set up and run in the [AWS Code Examples Repository](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/dotnetv3/RDS#code-examples)\. - - -``` - /// - /// Update a DB parameter group. Use the action DescribeDBParameterGroupsAsync - /// to determine when the DB parameter group is ready to use. - /// - /// Name of the DB parameter group. - /// List of parameters. Maximum of 20 per request. - /// The updated DB parameter group name. - public async Task ModifyDBParameterGroup( - string name, List parameters) - { - var response = await _amazonRDS.ModifyDBParameterGroupAsync( - new ModifyDBParameterGroupRequest() - { - DBParameterGroupName = name, - Parameters = parameters, - }); - return response.DBParameterGroupName; - } -``` -+ For API details, see [ModifyDBParameterGroup](https://docs.aws.amazon.com/goto/DotNetSDKV3/rds-2014-10-31/ModifyDBParameterGroup) in *AWS SDK for \.NET API Reference*\. - ------- -#### [ C\+\+ ] - -**SDK for C\+\+** - There's more on GitHub\. Find the complete example and learn how to set up and run in the [AWS Code Examples Repository](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/cpp/example_code/rds#code-examples)\. - - -``` - Aws::Client::ClientConfiguration clientConfig; - // Optional: Set to the AWS Region (overrides config file). - // clientConfig.region = "us-east-1"; - - Aws::RDS::RDSClient client(clientConfig); - - Aws::RDS::Model::ModifyDBParameterGroupRequest request; - request.SetDBParameterGroupName(PARAMETER_GROUP_NAME); - request.SetParameters(updateParameters); - - Aws::RDS::Model::ModifyDBParameterGroupOutcome outcome = - client.ModifyDBParameterGroup(request); - - if (outcome.IsSuccess()) { - std::cout << "The DB parameter group was successfully modified." - << std::endl; - } - else { - std::cerr << "Error with RDS::ModifyDBParameterGroup. " - << outcome.GetError().GetMessage() - << std::endl; - } -``` -+ For API details, see [ModifyDBParameterGroup](https://docs.aws.amazon.com/goto/SdkForCpp/rds-2014-10-31/ModifyDBParameterGroup) in *AWS SDK for C\+\+ API Reference*\. - ------- -#### [ Java ] - -**SDK for Java 2\.x** - There's more on GitHub\. Find the complete example and learn how to set up and run in the [AWS Code Examples Repository](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/javav2/example_code/rds#readme)\. - - -``` - // Modify auto_increment_offset and auto_increment_increment parameters. - public static void modifyDBParas(RdsClient rdsClient, String dbGroupName) { - try { - Parameter parameter1 = Parameter.builder() - .parameterName("auto_increment_offset") - .applyMethod("immediate") - .parameterValue("5") - .build(); - - List paraList = new ArrayList<>(); - paraList.add(parameter1); - ModifyDbParameterGroupRequest groupRequest = ModifyDbParameterGroupRequest.builder() - .dbParameterGroupName(dbGroupName) - .parameters(paraList) - .build(); - - ModifyDbParameterGroupResponse response = rdsClient.modifyDBParameterGroup(groupRequest); - System.out.println("The parameter group "+ response.dbParameterGroupName() +" was successfully modified"); - - } catch (RdsException e) { - System.out.println(e.getLocalizedMessage()); - System.exit(1); - } - } -``` -+ For API details, see [ModifyDBParameterGroup](https://docs.aws.amazon.com/goto/SdkForJavaV2/rds-2014-10-31/ModifyDBParameterGroup) in *AWS SDK for Java 2\.x API Reference*\. - ------- -#### [ Python ] - -**SDK for Python \(Boto3\)** - There's more on GitHub\. Find the complete example and learn how to set up and run in the [AWS Code Examples Repository](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/python/example_code/rds#code-examples)\. - - -``` -class InstanceWrapper: - """Encapsulates Amazon RDS DB instance actions.""" - def __init__(self, rds_client): - """ - :param rds_client: A Boto3 Amazon RDS client. - """ - self.rds_client = rds_client - - @classmethod - def from_client(cls): - """ - Instantiates this class from a Boto3 client. - """ - rds_client = boto3.client('rds') - return cls(rds_client) - - def update_parameters(self, parameter_group_name, update_parameters): - """ - Updates parameters in a custom DB parameter group. - - :param parameter_group_name: The name of the parameter group to update. - :param update_parameters: The parameters to update in the group. - :return: Data about the modified parameter group. - """ - try: - response = self.rds_client.modify_db_parameter_group( - DBParameterGroupName=parameter_group_name, Parameters=update_parameters) - except ClientError as err: - logger.error( - "Couldn't update parameters in %s. Here's why: %s: %s", parameter_group_name, - err.response['Error']['Code'], err.response['Error']['Message']) - raise - else: - return response -``` -+ For API details, see [ModifyDBParameterGroup](https://docs.aws.amazon.com/goto/boto3/rds-2014-10-31/ModifyDBParameterGroup) in *AWS SDK for Python \(Boto3\) API Reference*\. - ------- - -For a complete list of AWS SDK developer guides and code examples, see [Using this service with an AWS SDK](CHAP_Tutorials.md#sdk-general-information-section)\. This topic also includes information about getting started and details about previous SDK versions\. \ No newline at end of file diff --git a/doc_source/example_rds_RebootDBInstance_section.md b/doc_source/example_rds_RebootDBInstance_section.md deleted file mode 100644 index 020b340..0000000 --- a/doc_source/example_rds_RebootDBInstance_section.md +++ /dev/null @@ -1,36 +0,0 @@ -# Reboot an Amazon RDS DB instance using an AWS SDK - -The following code example shows how to reboot an Amazon RDS DB instance\. - -**Note** -The source code for these examples is in the [AWS Code Examples GitHub repository](https://github.com/awsdocs/aws-doc-sdk-examples)\. Have feedback on a code example? [Create an Issue](https://github.com/awsdocs/aws-doc-sdk-examples/issues/new/choose) in the code examples repo\. - ------- -#### [ Java ] - -**SDK for Java 2\.x** - There's more on GitHub\. Find the complete example and learn how to set up and run in the [AWS Code Examples Repository](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/javav2/example_code/rds#readme)\. - - -``` - public static void rebootInstance(RdsClient rdsClient, String dbInstanceIdentifier ) { - - try { - RebootDbInstanceRequest rebootDbInstanceRequest = RebootDbInstanceRequest.builder() - .dbInstanceIdentifier(dbInstanceIdentifier) - .build(); - - RebootDbInstanceResponse instanceResponse = rdsClient.rebootDBInstance(rebootDbInstanceRequest); - System.out.print("The database "+ instanceResponse.dbInstance().dbInstanceArn() +" was rebooted"); - - } catch (RdsException e) { - System.out.println(e.getLocalizedMessage()); - System.exit(1); - } - } -``` -+ For API details, see [RebootDBInstance](https://docs.aws.amazon.com/goto/SdkForJavaV2/rds-2014-10-31/RebootDBInstance) in *AWS SDK for Java 2\.x API Reference*\. - ------- - -For a complete list of AWS SDK developer guides and code examples, see [Using this service with an AWS SDK](CHAP_Tutorials.md#sdk-general-information-section)\. This topic also includes information about getting started and details about previous SDK versions\. \ No newline at end of file diff --git a/doc_source/example_rds_Scenario_GetStartedInstances_section.md b/doc_source/example_rds_Scenario_GetStartedInstances_section.md deleted file mode 100644 index aeefc8c..0000000 --- a/doc_source/example_rds_Scenario_GetStartedInstances_section.md +++ /dev/null @@ -1,2945 +0,0 @@ -# Get started with Amazon RDS DB instances using an AWS SDK - -The following code examples show how to: -+ Create a custom DB parameter group and set parameter values\. -+ Create a DB instance that's configured to use the parameter group\. The DB instance also contains a database\. -+ Take a snapshot of the instance\. -+ Delete the instance and parameter group\. - -**Note** -The source code for these examples is in the [AWS Code Examples GitHub repository](https://github.com/awsdocs/aws-doc-sdk-examples)\. Have feedback on a code example? [Create an Issue](https://github.com/awsdocs/aws-doc-sdk-examples/issues/new/choose) in the code examples repo\. - ------- -#### [ \.NET ] - -**AWS SDK for \.NET** - There's more on GitHub\. Find the complete example and learn how to set up and run in the [AWS Code Examples Repository](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/dotnetv3/RDS#code-examples)\. -Run an interactive scenario at a command prompt\. - -``` -/// -/// Scenario for RDS DB instance example. -/// -public class RDSInstanceScenario -{ - /* - Before running this .NET code example, set up your development environment, including your credentials. - - This .NET example performs the following tasks: - 1. Returns a list of the available DB engine families using the DescribeDBEngineVersionsAsync method. - 2. Selects an engine family and creates a custom DB parameter group using the CreateDBParameterGroupAsync method. - 3. Gets the parameter groups using the DescribeDBParameterGroupsAsync method. - 4. Gets parameters in the group using the DescribeDBParameters method. - 5. Parses and displays parameters in the group. - 6. Modifies both the auto_increment_offset and auto_increment_increment parameters - using the ModifyDBParameterGroupAsync method. - 7. Gets and displays the updated parameters using the DescribeDBParameters method with a source of "user". - 8. Gets a list of allowed engine versions using the DescribeDBEngineVersionsAsync method. - 9. Displays and selects from a list of micro instance classes available for the selected engine and version. - 10. Creates an RDS DB instance that contains a MySql database and uses the parameter group - using the CreateDBInstanceAsync method. - 11. Waits for DB instance to be ready using the DescribeDBInstancesAsync method. - 12. Prints out the connection endpoint string for the new DB instance. - 13. Creates a snapshot of the DB instance using the CreateDBSnapshotAsync method. - 14. Waits for DB snapshot to be ready using the DescribeDBSnapshots method. - 15. Deletes the DB instance using the DeleteDBInstanceAsync method. - 16. Waits for DB instance to be deleted using the DescribeDbInstances method. - 17. Deletes the parameter group using the DeleteDBParameterGroupAsync. - */ - - private static readonly string sepBar = new('-', 80); - private static RDSWrapper rdsWrapper = null!; - private static ILogger logger = null!; - private static readonly string engine = "mysql"; - static async Task Main(string[] args) - { - // Set up dependency injection for the Amazon RDS service. - using var host = Host.CreateDefaultBuilder(args) - .ConfigureLogging(logging => - logging.AddFilter("System", LogLevel.Debug) - .AddFilter("Microsoft", LogLevel.Information) - .AddFilter("Microsoft", LogLevel.Trace)) - .ConfigureServices((_, services) => - services.AddAWSService() - .AddTransient() - ) - .Build(); - - logger = LoggerFactory.Create(builder => - { - builder.AddConsole(); - }).CreateLogger(); - - rdsWrapper = host.Services.GetRequiredService(); - - Console.WriteLine(sepBar); - Console.WriteLine( - "Welcome to the Amazon Relational Database Service (Amazon RDS) DB instance scenario example."); - Console.WriteLine(sepBar); - - try - { - var parameterGroupFamily = await ChooseParameterGroupFamily(); - - var parameterGroup = await CreateDbParameterGroup(parameterGroupFamily); - - var parameters = await DescribeParametersInGroup(parameterGroup.DBParameterGroupName, - new List { "auto_increment_offset", "auto_increment_increment" }); - - await ModifyParameters(parameterGroup.DBParameterGroupName, parameters); - - await DescribeUserSourceParameters(parameterGroup.DBParameterGroupName); - - var engineVersionChoice = await ChooseDbEngineVersion(parameterGroupFamily); - - var instanceChoice = await ChooseDbInstanceClass(engine, engineVersionChoice.EngineVersion); - - var newInstanceIdentifier = "Example-Instance-" + DateTime.Now.Ticks; - - var newInstance = await CreateRdsNewInstance(parameterGroup, engine, engineVersionChoice.EngineVersion, - instanceChoice.DBInstanceClass, newInstanceIdentifier); - if (newInstance != null) - { - DisplayConnectionString(newInstance); - - await CreateSnapshot(newInstance); - - await DeleteRdsInstance(newInstance); - } - - await DeleteParameterGroup(parameterGroup); - - Console.WriteLine("Scenario complete."); - Console.WriteLine(sepBar); - } - catch (Exception ex) - { - logger.LogError(ex, "There was a problem executing the scenario."); - } - } - - /// - /// Choose the RDS DB parameter group family from a list of available options. - /// - /// The selected parameter group family. - public static async Task ChooseParameterGroupFamily() - { - Console.WriteLine(sepBar); - // 1. Get a list of available engines. - var engines = await rdsWrapper.DescribeDBEngineVersions(engine); - - Console.WriteLine("1. The following is a list of available DB parameter group families:"); - int i = 1; - var parameterGroupFamilies = engines.GroupBy(e => e.DBParameterGroupFamily).ToList(); - foreach (var parameterGroupFamily in parameterGroupFamilies) - { - // List the available parameter group families. - Console.WriteLine( - $"\t{i}. Family: {parameterGroupFamily.Key}"); - i++; - } - - var choiceNumber = 0; - while (choiceNumber < 1 || choiceNumber > parameterGroupFamilies.Count) - { - Console.WriteLine("Select an available DB parameter group family by entering a number from the list above:"); - var choice = Console.ReadLine(); - Int32.TryParse(choice, out choiceNumber); - } - var parameterGroupFamilyChoice = parameterGroupFamilies[choiceNumber - 1]; - Console.WriteLine(sepBar); - return parameterGroupFamilyChoice.Key; - } - - /// - /// Create and get information on a DB parameter group. - /// - /// The DBParameterGroupFamily for the new DB parameter group. - /// The new DBParameterGroup. - public static async Task CreateDbParameterGroup(string dbParameterGroupFamily) - { - Console.WriteLine(sepBar); - Console.WriteLine($"2. Create new DB parameter group with family {dbParameterGroupFamily}:"); - - var parameterGroup = await rdsWrapper.CreateDBParameterGroup( - "ExampleParameterGroup-" + DateTime.Now.Ticks, - dbParameterGroupFamily, "New example parameter group"); - - var groupInfo = - await rdsWrapper.DescribeDBParameterGroups(parameterGroup - .DBParameterGroupName); - - Console.WriteLine( - $"3. New DB parameter group: \n\t{groupInfo[0].Description}, \n\tARN {groupInfo[0].DBParameterGroupArn}"); - Console.WriteLine(sepBar); - return parameterGroup; - } - - /// - /// Get and describe parameters from a DBParameterGroup. - /// - /// Name of the DBParameterGroup. - /// Optional specific names of parameters to describe. - /// The list of requested parameters. - public static async Task> DescribeParametersInGroup(string parameterGroupName, List? parameterNames = null) - { - Console.WriteLine(sepBar); - Console.WriteLine("4. Get some parameters from the group."); - Console.WriteLine(sepBar); - - var parameters = - await rdsWrapper.DescribeDBParameters(parameterGroupName); - - var matchingParameters = - parameters.Where(p => parameterNames == null || parameterNames.Contains(p.ParameterName)).ToList(); - - Console.WriteLine("5. Parameter information:"); - matchingParameters.ForEach(p => - Console.WriteLine( - $"\n\tParameter: {p.ParameterName}." + - $"\n\tDescription: {p.Description}." + - $"\n\tAllowed Values: {p.AllowedValues}." + - $"\n\tValue: {p.ParameterValue}.")); - - Console.WriteLine(sepBar); - - return matchingParameters; - } - - /// - /// Modify a parameter from a DBParameterGroup. - /// - /// Name of the DBParameterGroup. - /// The parameters to modify. - /// Async task. - public static async Task ModifyParameters(string parameterGroupName, List parameters) - { - Console.WriteLine(sepBar); - Console.WriteLine("6. Modify some parameters in the group."); - - foreach (var p in parameters) - { - if (p.IsModifiable && p.DataType == "integer") - { - int newValue = 0; - while (newValue == 0) - { - Console.WriteLine( - $"Enter a new value for {p.ParameterName} from the allowed values {p.AllowedValues} "); - - var choice = Console.ReadLine(); - Int32.TryParse(choice, out newValue); - } - - p.ParameterValue = newValue.ToString(); - } - } - - await rdsWrapper.ModifyDBParameterGroup(parameterGroupName, parameters); - - Console.WriteLine(sepBar); - } - - /// - /// Describe the user source parameters in the group. - /// - /// Name of the DBParameterGroup. - /// Async task. - public static async Task DescribeUserSourceParameters(string parameterGroupName) - { - Console.WriteLine(sepBar); - Console.WriteLine("7. Describe user source parameters in the group."); - - var parameters = - await rdsWrapper.DescribeDBParameters(parameterGroupName, "user"); - - - parameters.ForEach(p => - Console.WriteLine( - $"\n\tParameter: {p.ParameterName}." + - $"\n\tDescription: {p.Description}." + - $"\n\tAllowed Values: {p.AllowedValues}." + - $"\n\tValue: {p.ParameterValue}.")); - - Console.WriteLine(sepBar); - } - - - /// - /// Choose a DB engine version. - /// - /// DB parameter group family for engine choice. - /// The selected engine version. - public static async Task ChooseDbEngineVersion(string dbParameterGroupFamily) - { - Console.WriteLine(sepBar); - // Get a list of allowed engines. - var allowedEngines = - await rdsWrapper.DescribeDBEngineVersions(engine, dbParameterGroupFamily); - - Console.WriteLine($"Available DB engine versions for parameter group family {dbParameterGroupFamily}:"); - int i = 1; - foreach (var version in allowedEngines) - { - Console.WriteLine( - $"\t{i}. Engine: {version.Engine} Version {version.EngineVersion}."); - i++; - } - - var choiceNumber = 0; - while (choiceNumber < 1 || choiceNumber > allowedEngines.Count) - { - Console.WriteLine("8. Select an available DB engine version by entering a number from the list above:"); - var choice = Console.ReadLine(); - Int32.TryParse(choice, out choiceNumber); - } - - var engineChoice = allowedEngines[choiceNumber - 1]; - Console.WriteLine(sepBar); - return engineChoice; - } - - /// - /// Choose a DB instance class for a particular engine and engine version. - /// - /// DB engine for DB instance choice. - /// DB engine version for DB instance choice. - /// The selected orderable DB instance option. - public static async Task ChooseDbInstanceClass(string engine, string engineVersion) - { - Console.WriteLine(sepBar); - // Get a list of allowed DB instance classes. - var allowedInstances = - await rdsWrapper.DescribeOrderableDBInstanceOptions(engine, engineVersion); - - Console.WriteLine($"8. Available micro DB instance classes for engine {engine} and version {engineVersion}:"); - int i = 1; - - // Filter to micro instances for this example. - allowedInstances = allowedInstances - .Where(i => i.DBInstanceClass.Contains("micro")).ToList(); - - foreach (var instance in allowedInstances) - { - Console.WriteLine( - $"\t{i}. Instance class: {instance.DBInstanceClass} (storage type {instance.StorageType})"); - i++; - } - - var choiceNumber = 0; - while (choiceNumber < 1 || choiceNumber > allowedInstances.Count) - { - Console.WriteLine("9. Select an available DB instance class by entering a number from the list above:"); - var choice = Console.ReadLine(); - Int32.TryParse(choice, out choiceNumber); - } - - var instanceChoice = allowedInstances[choiceNumber - 1]; - Console.WriteLine(sepBar); - return instanceChoice; - } - - /// - /// Create a new RDS DB instance. - /// - /// Parameter group to use for the DB instance. - /// Engine to use for the DB instance. - /// Engine version to use for the DB instance. - /// Instance class to use for the DB instance. - /// Instance identifier to use for the DB instance. - /// The new DB instance. - public static async Task CreateRdsNewInstance(DBParameterGroup parameterGroup, - string engineName, string engineVersion, string instanceClass, string instanceIdentifier) - { - Console.WriteLine(sepBar); - Console.WriteLine($"10. Create a new DB instance with identifier {instanceIdentifier}."); - bool isInstanceReady = false; - DBInstance newInstance; - var instances = await rdsWrapper.DescribeDBInstances(); - isInstanceReady = instances.FirstOrDefault(i => - i.DBInstanceIdentifier == instanceIdentifier)?.DBInstanceStatus == "available"; - - if (isInstanceReady) - { - Console.WriteLine("Instance already created."); - newInstance = instances.First(i => i.DBInstanceIdentifier == instanceIdentifier); - } - else - { - Console.WriteLine("Please enter an admin user name:"); - var username = Console.ReadLine(); - - Console.WriteLine("Please enter an admin password:"); - var password = Console.ReadLine(); - - newInstance = await rdsWrapper.CreateDBInstance( - "ExampleInstance", - instanceIdentifier, - parameterGroup.DBParameterGroupName, - engineName, - engineVersion, - instanceClass, - 20, - username, - password - ); - - // 11. Wait for the DB instance to be ready. - - Console.WriteLine("11. Waiting for DB instance to be ready..."); - while (!isInstanceReady) - { - instances = await rdsWrapper.DescribeDBInstances(instanceIdentifier); - isInstanceReady = instances.FirstOrDefault()?.DBInstanceStatus == "available"; - newInstance = instances.First(); - Thread.Sleep(30000); - } - } - - Console.WriteLine(sepBar); - return newInstance; - } - - /// - /// Display a connection string for an RDS DB instance. - /// - /// The DB instance to use to get a connection string. - public static void DisplayConnectionString(DBInstance instance) - { - Console.WriteLine(sepBar); - // Display the connection string. - Console.WriteLine("12. New DB instance connection string: "); - Console.WriteLine( - $"\n{engine} -h {instance.Endpoint.Address} -P {instance.Endpoint.Port} " - + $"-u {instance.MasterUsername} -p [YOUR PASSWORD]\n"); - - Console.WriteLine(sepBar); - } - - /// - /// Create a snapshot from an RDS DB instance. - /// - /// DB instance to use when creating a snapshot. - /// The snapshot object. - public static async Task CreateSnapshot(DBInstance instance) - { - Console.WriteLine(sepBar); - // Create a snapshot. - Console.WriteLine($"13. Creating snapshot from DB instance {instance.DBInstanceIdentifier}."); - var snapshot = await rdsWrapper.CreateDBSnapshot(instance.DBInstanceIdentifier, "ExampleSnapshot-" + DateTime.Now.Ticks); - - // Wait for the snapshot to be available - bool isSnapshotReady = false; - - Console.WriteLine($"14. Waiting for snapshot to be ready..."); - while (!isSnapshotReady) - { - var snapshots = await rdsWrapper.DescribeDBSnapshots(instance.DBInstanceIdentifier); - isSnapshotReady = snapshots.FirstOrDefault()?.Status == "available"; - snapshot = snapshots.First(); - Thread.Sleep(30000); - } - - Console.WriteLine( - $"Snapshot {snapshot.DBSnapshotIdentifier} status is {snapshot.Status}."); - Console.WriteLine(sepBar); - return snapshot; - } - - /// - /// Delete an RDS DB instance. - /// - /// The DB instance to delete. - /// Async task. - public static async Task DeleteRdsInstance(DBInstance newInstance) - { - Console.WriteLine(sepBar); - // Delete the DB instance. - Console.WriteLine($"15. Delete the DB instance {newInstance.DBInstanceIdentifier}."); - await rdsWrapper.DeleteDBInstance(newInstance.DBInstanceIdentifier); - - // Wait for the DB instance to delete. - Console.WriteLine($"16. Waiting for the DB instance to delete..."); - bool isInstanceDeleted = false; - - while (!isInstanceDeleted) - { - var instance = await rdsWrapper.DescribeDBInstances(); - isInstanceDeleted = instance.All(i => i.DBInstanceIdentifier != newInstance.DBInstanceIdentifier); - Thread.Sleep(30000); - } - - Console.WriteLine("DB instance deleted."); - Console.WriteLine(sepBar); - } - - /// - /// Delete a DB parameter group. - /// - /// The parameter group to delete. - /// Async task. - public static async Task DeleteParameterGroup(DBParameterGroup parameterGroup) - { - Console.WriteLine(sepBar); - // Delete the parameter group. - Console.WriteLine($"17. Delete the DB parameter group {parameterGroup.DBParameterGroupName}."); - await rdsWrapper.DeleteDBParameterGroup(parameterGroup.DBParameterGroupName); - - Console.WriteLine(sepBar); - } -``` -Wrapper methods used by the scenario for DB instance actions\. - -``` -/// -/// Wrapper methods to use Amazon Relational Database Service (Amazon RDS) with DB instance operations. -/// -public partial class RDSWrapper -{ - private readonly IAmazonRDS _amazonRDS; - public RDSWrapper(IAmazonRDS amazonRDS) - { - _amazonRDS = amazonRDS; - } - - - /// - /// Get a list of DB engine versions for a particular DB engine. - /// - /// Name of the engine. - /// Optional parameter group family name. - /// List of DBEngineVersions. - public async Task> DescribeDBEngineVersions(string engine, - string dbParameterGroupFamily = null) - { - var response = await _amazonRDS.DescribeDBEngineVersionsAsync( - new DescribeDBEngineVersionsRequest() - { - Engine = engine, - DBParameterGroupFamily = dbParameterGroupFamily - }); - return response.DBEngineVersions; - } - - - - /// - /// Get a list of orderable DB instance options for a specific - /// engine and engine version. - /// - /// Name of the engine. - /// Version of the engine. - /// List of OrderableDBInstanceOptions. - public async Task> DescribeOrderableDBInstanceOptions(string engine, string engineVersion) - { - // Use a paginator to get a list of DB instance options. - var results = new List(); - var paginateInstanceOptions = _amazonRDS.Paginators.DescribeOrderableDBInstanceOptions( - new DescribeOrderableDBInstanceOptionsRequest() - { - Engine = engine, - EngineVersion = engineVersion, - }); - // Get the entire list using the paginator. - await foreach (var instanceOptions in paginateInstanceOptions.OrderableDBInstanceOptions) - { - results.Add(instanceOptions); - } - return results; - } - - - - /// - /// Returns a list of DB instances. - /// - /// Optional name of a specific DB instance. - /// List of DB instances. - public async Task> DescribeDBInstances(string dbInstanceIdentifier = null) - { - var results = new List(); - var instancesPaginator = _amazonRDS.Paginators.DescribeDBInstances( - new DescribeDBInstancesRequest - { - DBInstanceIdentifier = dbInstanceIdentifier - }); - // Get the entire list using the paginator. - await foreach (var instances in instancesPaginator.DBInstances) - { - results.Add(instances); - } - return results; - } - - - - /// - /// Create an RDS DB instance with a particular set of properties. Use the action DescribeDBInstancesAsync - /// to determine when the DB instance is ready to use. - /// - /// Name for the DB instance. - /// DB instance identifier. - /// DB parameter group to associate with the instance. - /// The engine for the DB instance. - /// Version for the DB instance. - /// Class for the DB instance. - /// The amount of storage in gibibytes (GiB) to allocate to the DB instance. - /// Admin user name. - /// Admin user password. - /// DB instance object. - public async Task CreateDBInstance(string dbName, string dbInstanceIdentifier, - string parameterGroupName, string dbEngine, string dbEngineVersion, - string instanceClass, int allocatedStorage, string adminName, string adminPassword) - { - var response = await _amazonRDS.CreateDBInstanceAsync( - new CreateDBInstanceRequest() - { - DBName = dbName, - DBInstanceIdentifier = dbInstanceIdentifier, - DBParameterGroupName = parameterGroupName, - Engine = dbEngine, - EngineVersion = dbEngineVersion, - DBInstanceClass = instanceClass, - AllocatedStorage = allocatedStorage, - MasterUsername = adminName, - MasterUserPassword = adminPassword - }); - - return response.DBInstance; - } - - - - /// - /// Delete a particular DB instance. - /// - /// DB instance identifier. - /// DB instance object. - public async Task DeleteDBInstance(string dbInstanceIdentifier) - { - var response = await _amazonRDS.DeleteDBInstanceAsync( - new DeleteDBInstanceRequest() - { - DBInstanceIdentifier = dbInstanceIdentifier, - SkipFinalSnapshot = true, - DeleteAutomatedBackups = true - }); - - return response.DBInstance; - } -``` -Wrapper methods used by the scenario for DB parameter groups\. - -``` -/// -/// Wrapper methods to use Amazon Relational Database Service (Amazon RDS) with parameter groups. -/// -public partial class RDSWrapper -{ - - /// - /// Get descriptions of DB parameter groups. - /// - /// Optional name of the DB parameter group to describe. - /// The list of DB parameter group descriptions. - public async Task> DescribeDBParameterGroups(string name = null) - { - var response = await _amazonRDS.DescribeDBParameterGroupsAsync( - new DescribeDBParameterGroupsRequest() - { - DBParameterGroupName = name - }); - return response.DBParameterGroups; - } - - - - /// - /// Create a new DB parameter group. Use the action DescribeDBParameterGroupsAsync - /// to determine when the DB parameter group is ready to use. - /// - /// Name of the DB parameter group. - /// Family of the DB parameter group. - /// Description of the DB parameter group. - /// The new DB parameter group. - public async Task CreateDBParameterGroup( - string name, string family, string description) - { - var response = await _amazonRDS.CreateDBParameterGroupAsync( - new CreateDBParameterGroupRequest() - { - DBParameterGroupName = name, - DBParameterGroupFamily = family, - Description = description - }); - return response.DBParameterGroup; - } - - - - /// - /// Update a DB parameter group. Use the action DescribeDBParameterGroupsAsync - /// to determine when the DB parameter group is ready to use. - /// - /// Name of the DB parameter group. - /// List of parameters. Maximum of 20 per request. - /// The updated DB parameter group name. - public async Task ModifyDBParameterGroup( - string name, List parameters) - { - var response = await _amazonRDS.ModifyDBParameterGroupAsync( - new ModifyDBParameterGroupRequest() - { - DBParameterGroupName = name, - Parameters = parameters, - }); - return response.DBParameterGroupName; - } - - - - /// - /// Delete a DB parameter group. The group cannot be a default DB parameter group - /// or be associated with any DB instances. - /// - /// Name of the DB parameter group. - /// True if successful. - public async Task DeleteDBParameterGroup(string name) - { - var response = await _amazonRDS.DeleteDBParameterGroupAsync( - new DeleteDBParameterGroupRequest() - { - DBParameterGroupName = name, - }); - return response.HttpStatusCode == HttpStatusCode.OK; - } - - - - /// - /// Get a list of DB parameters from a specific parameter group. - /// - /// Name of a specific DB parameter group. - /// Optional source for selecting parameters. - /// List of parameter values. - public async Task> DescribeDBParameters(string dbParameterGroupName, string source = null) - { - var results = new List(); - var paginateParameters = _amazonRDS.Paginators.DescribeDBParameters( - new DescribeDBParametersRequest() - { - DBParameterGroupName = dbParameterGroupName, - Source = source - }); - // Get the entire list using the paginator. - await foreach (var parameters in paginateParameters.Parameters) - { - results.Add(parameters); - } - return results; - } -``` -Wrapper methods used by the scenario for DB snapshot actions\. - -``` -/// -/// Wrapper methods to use Amazon Relational Database Service (Amazon RDS) with snapshots. -/// -public partial class RDSWrapper -{ - - /// - /// Create a snapshot of a DB instance. - /// - /// DB instance identifier. - /// Identifier for the snapshot. - /// DB snapshot object. - public async Task CreateDBSnapshot(string dbInstanceIdentifier, string snapshotIdentifier) - { - var response = await _amazonRDS.CreateDBSnapshotAsync( - new CreateDBSnapshotRequest() - { - DBSnapshotIdentifier = snapshotIdentifier, - DBInstanceIdentifier = dbInstanceIdentifier - }); - - return response.DBSnapshot; - } - - - - /// - /// Return a list of DB snapshots for a particular DB instance. - /// - /// DB instance identifier. - /// List of DB snapshots. - public async Task> DescribeDBSnapshots(string dbInstanceIdentifier) - { - var results = new List(); - var snapshotsPaginator = _amazonRDS.Paginators.DescribeDBSnapshots( - new DescribeDBSnapshotsRequest() - { - DBInstanceIdentifier = dbInstanceIdentifier - }); - - // Get the entire list using the paginator. - await foreach (var snapshots in snapshotsPaginator.DBSnapshots) - { - results.Add(snapshots); - } - return results; - } -``` -+ For API details, see the following topics in *AWS SDK for \.NET API Reference*\. - + [CreateDBInstance](https://docs.aws.amazon.com/goto/DotNetSDKV3/rds-2014-10-31/CreateDBInstance) - + [CreateDBParameterGroup](https://docs.aws.amazon.com/goto/DotNetSDKV3/rds-2014-10-31/CreateDBParameterGroup) - + [CreateDBSnapshot](https://docs.aws.amazon.com/goto/DotNetSDKV3/rds-2014-10-31/CreateDBSnapshot) - + [DeleteDBInstance](https://docs.aws.amazon.com/goto/DotNetSDKV3/rds-2014-10-31/DeleteDBInstance) - + [DeleteDBParameterGroup](https://docs.aws.amazon.com/goto/DotNetSDKV3/rds-2014-10-31/DeleteDBParameterGroup) - + [DescribeDBEngineVersions](https://docs.aws.amazon.com/goto/DotNetSDKV3/rds-2014-10-31/DescribeDBEngineVersions) - + [DescribeDBInstances](https://docs.aws.amazon.com/goto/DotNetSDKV3/rds-2014-10-31/DescribeDBInstances) - + [DescribeDBParameterGroups](https://docs.aws.amazon.com/goto/DotNetSDKV3/rds-2014-10-31/DescribeDBParameterGroups) - + [DescribeDBParameters](https://docs.aws.amazon.com/goto/DotNetSDKV3/rds-2014-10-31/DescribeDBParameters) - + [DescribeDBSnapshots](https://docs.aws.amazon.com/goto/DotNetSDKV3/rds-2014-10-31/DescribeDBSnapshots) - + [DescribeOrderableDBInstanceOptions](https://docs.aws.amazon.com/goto/DotNetSDKV3/rds-2014-10-31/DescribeOrderableDBInstanceOptions) - + [ModifyDBParameterGroup](https://docs.aws.amazon.com/goto/DotNetSDKV3/rds-2014-10-31/ModifyDBParameterGroup) - ------- -#### [ C\+\+ ] - -**SDK for C\+\+** - There's more on GitHub\. Find the complete example and learn how to set up and run in the [AWS Code Examples Repository](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/cpp/example_code/rds#code-examples)\. - - -``` - Aws::Client::ClientConfiguration clientConfig; - // Optional: Set to the AWS Region (overrides config file). - // clientConfig.region = "us-east-1"; - -//! Routine which creates an Amazon RDS instance and demonstrates several operations -//! on that instance. -/*! - \sa gettingStartedWithDBInstances() - \param clientConfiguration: AWS client configuration. - \return bool: Successful completion. - */ -bool AwsDoc::RDS::gettingStartedWithDBInstances( - const Aws::Client::ClientConfiguration &clientConfig) { - Aws::RDS::RDSClient client(clientConfig); - - printAsterisksLine(); - std::cout << "Welcome to the Amazon Relational Database Service (Amazon RDS)" - << std::endl; - std::cout << "get started with DB instances demo." << std::endl; - printAsterisksLine(); - - std::cout << "Checking for an existing DB parameter group named '" << - PARAMETER_GROUP_NAME << "'." << std::endl; - Aws::String dbParameterGroupFamily("Undefined"); - bool parameterGroupFound = true; - { - // 1. Check if the DB parameter group already exists. - Aws::RDS::Model::DescribeDBParameterGroupsRequest request; - request.SetDBParameterGroupName(PARAMETER_GROUP_NAME); - - Aws::RDS::Model::DescribeDBParameterGroupsOutcome outcome = - client.DescribeDBParameterGroups(request); - - if (outcome.IsSuccess()) { - std::cout << "DB parameter group named '" << - PARAMETER_GROUP_NAME << "' already exists." << std::endl; - dbParameterGroupFamily = outcome.GetResult().GetDBParameterGroups()[0].GetDBParameterGroupFamily(); - } - else if (outcome.GetError().GetErrorType() == - Aws::RDS::RDSErrors::D_B_PARAMETER_GROUP_NOT_FOUND_FAULT) { - std::cout << "DB parameter group named '" << - PARAMETER_GROUP_NAME << "' does not exist." << std::endl; - parameterGroupFound = false; - } - else { - std::cerr << "Error with RDS::DescribeDBParameterGroups. " - << outcome.GetError().GetMessage() - << std::endl; - return false; - } - } - - if (!parameterGroupFound) { - Aws::Vector engineVersions; - - // 2. Get available engine versions for the specified engine. - if (!getDBEngineVersions(DB_ENGINE, NO_PARAMETER_GROUP_FAMILY, - engineVersions, client)) { - return false; - } - - std::cout << "Getting available database engine versions for " << DB_ENGINE - << "." - << std::endl; - std::vector families; - for (const Aws::RDS::Model::DBEngineVersion &version: engineVersions) { - Aws::String family = version.GetDBParameterGroupFamily(); - if (std::find(families.begin(), families.end(), family) == - families.end()) { - families.push_back(family); - std::cout << " " << families.size() << ": " << family << std::endl; - } - } - - int choice = askQuestionForIntRange("Which family do you want to use? ", 1, - static_cast(families.size())); - dbParameterGroupFamily = families[choice - 1]; - } - if (!parameterGroupFound) { - // 3. Create a DB parameter group. - Aws::RDS::Model::CreateDBParameterGroupRequest request; - request.SetDBParameterGroupName(PARAMETER_GROUP_NAME); - request.SetDBParameterGroupFamily(dbParameterGroupFamily); - request.SetDescription("Example parameter group."); - - Aws::RDS::Model::CreateDBParameterGroupOutcome outcome = - client.CreateDBParameterGroup(request); - - if (outcome.IsSuccess()) { - std::cout << "The DB parameter group was successfully created." - << std::endl; - } - else { - std::cerr << "Error with RDS::CreateDBParameterGroup. " - << outcome.GetError().GetMessage() - << std::endl; - return false; - } - } - - printAsterisksLine(); - std::cout << "Let's set some parameter values in your parameter group." - << std::endl; - - Aws::String marker; - Aws::Vector autoIncrementParameters; - // 4. Get the parameters in the DB parameter group. - if (!getDBParameters(PARAMETER_GROUP_NAME, AUTO_INCREMENT_PREFIX, NO_SOURCE, - autoIncrementParameters, - client)) { - cleanUpResources(PARAMETER_GROUP_NAME, "", client); - return false; - } - - Aws::Vector updateParameters; - - for (Aws::RDS::Model::Parameter &autoIncParameter: autoIncrementParameters) { - if (autoIncParameter.GetIsModifiable() && - (autoIncParameter.GetDataType() == "integer")) { - std::cout << "The " << autoIncParameter.GetParameterName() - << " is described as: " << - autoIncParameter.GetDescription() << "." << std::endl; - if (autoIncParameter.ParameterValueHasBeenSet()) { - std::cout << "The current value is " - << autoIncParameter.GetParameterValue() - << "." << std::endl; - } - std::vector splitValues = splitToInts( - autoIncParameter.GetAllowedValues(), '-'); - if (splitValues.size() == 2) { - int newValue = askQuestionForIntRange( - Aws::String("Enter a new value in the range ") + - autoIncParameter.GetAllowedValues() + ": ", - splitValues[0], splitValues[1]); - autoIncParameter.SetParameterValue(std::to_string(newValue)); - updateParameters.push_back(autoIncParameter); - - } - else { - std::cerr << "Error parsing " << autoIncParameter.GetAllowedValues() - << std::endl; - } - } - } - - { - // 5. Modify the auto increment parameters in the group. - Aws::RDS::Model::ModifyDBParameterGroupRequest request; - request.SetDBParameterGroupName(PARAMETER_GROUP_NAME); - request.SetParameters(updateParameters); - - Aws::RDS::Model::ModifyDBParameterGroupOutcome outcome = - client.ModifyDBParameterGroup(request); - - if (outcome.IsSuccess()) { - std::cout << "The DB parameter group was successfully modified." - << std::endl; - } - else { - std::cerr << "Error with RDS::ModifyDBParameterGroup. " - << outcome.GetError().GetMessage() - << std::endl; - } - } - - std::cout - << "You can get a list of parameters you've set by specifying a source of 'user'." - << std::endl; - - Aws::Vector userParameters; - // 6. Display the modified parameters in the group. - if (!getDBParameters(PARAMETER_GROUP_NAME, NO_NAME_PREFIX, "user", userParameters, - client)) { - cleanUpResources(PARAMETER_GROUP_NAME, "", client); - return false; - } - - for (const auto &userParameter: userParameters) { - std::cout << " " << userParameter.GetParameterName() << ", " << - userParameter.GetDescription() << ", parameter value - " - << userParameter.GetParameterValue() << std::endl; - } - - printAsterisksLine(); - std::cout << "Checking for an existing DB instance." << std::endl; - - Aws::RDS::Model::DBInstance dbInstance; - // 7. Check if the DB instance already exists. - if (!describeDBInstance(DB_INSTANCE_IDENTIFIER, dbInstance, client)) { - cleanUpResources(PARAMETER_GROUP_NAME, "", client); - return false; - } - - if (dbInstance.DbInstancePortHasBeenSet()) { - std::cout << "The DB instance already exists." << std::endl; - } - else { - std::cout << "Let's create a DB instance." << std::endl; - const Aws::String administratorName = askQuestion( - "Enter an administrator username for the database: "); - const Aws::String administratorPassword = askQuestion( - "Enter a password for the administrator (at least 8 characters): "); - Aws::Vector engineVersions; - - // 8. Get a list of available engine versions. - if (!getDBEngineVersions(DB_ENGINE, dbParameterGroupFamily, engineVersions, - client)) { - cleanUpResources(PARAMETER_GROUP_NAME, "", client); - return false; - } - - std::cout << "The available engines for your parameter group are:" << std::endl; - - int index = 1; - for (const Aws::RDS::Model::DBEngineVersion &engineVersion: engineVersions) { - std::cout << " " << index << ": " << engineVersion.GetEngineVersion() - << std::endl; - ++index; - } - int choice = askQuestionForIntRange("Which engine do you want to use? ", 1, - static_cast(engineVersions.size())); - const Aws::RDS::Model::DBEngineVersion engineVersion = engineVersions[choice - - 1]; - - Aws::String dbInstanceClass; - // 9. Get a list of micro instance classes. - if (!chooseMicroDBInstanceClass(engineVersion.GetEngine(), - engineVersion.GetEngineVersion(), - dbInstanceClass, - client)) { - cleanUpResources(PARAMETER_GROUP_NAME, "", client); - return false; - } - - std::cout << "Creating a DB instance named '" << DB_INSTANCE_IDENTIFIER - << "' and database '" << DB_NAME << "'.\n" - << "The DB instance is configured to use your custom parameter group '" - << PARAMETER_GROUP_NAME << "',\n" - << "selected engine version " << engineVersion.GetEngineVersion() - << ",\n" - << "selected DB instance class '" << dbInstanceClass << "'," - << " and " << DB_ALLOCATED_STORAGE << " GiB of " << DB_STORAGE_TYPE - << " storage.\nThis typically takes several minutes." << std::endl; - - Aws::RDS::Model::CreateDBInstanceRequest request; - request.SetDBName(DB_NAME); - request.SetDBInstanceIdentifier(DB_INSTANCE_IDENTIFIER); - request.SetDBParameterGroupName(PARAMETER_GROUP_NAME); - request.SetEngine(engineVersion.GetEngine()); - request.SetEngineVersion(engineVersion.GetEngineVersion()); - request.SetDBInstanceClass(dbInstanceClass); - request.SetStorageType(DB_STORAGE_TYPE); - request.SetAllocatedStorage(DB_ALLOCATED_STORAGE); - request.SetMasterUsername(administratorName); - request.SetMasterUserPassword(administratorPassword); - - Aws::RDS::Model::CreateDBInstanceOutcome outcome = - client.CreateDBInstance(request); - - if (outcome.IsSuccess()) { - std::cout << "The DB instance creation has started." - << std::endl; - } - else { - std::cerr << "Error with RDS::CreateDBInstance. " - << outcome.GetError().GetMessage() - << std::endl; - cleanUpResources(PARAMETER_GROUP_NAME, "", client); - return false; - } - } - - std::cout << "Waiting for the DB instance to become available." << std::endl; - - int counter = 0; - // 11. Wait for the DB instance to become available. - do { - std::this_thread::sleep_for(std::chrono::seconds(1)); - ++counter; - if (counter > 900) { - std::cerr << "Wait for instance to become available timed out ofter " - << counter - << " seconds." << std::endl; - cleanUpResources(PARAMETER_GROUP_NAME, DB_INSTANCE_IDENTIFIER, client); - return false; - } - - dbInstance = Aws::RDS::Model::DBInstance(); - if (!describeDBInstance(DB_INSTANCE_IDENTIFIER, dbInstance, client)) { - cleanUpResources(PARAMETER_GROUP_NAME, DB_INSTANCE_IDENTIFIER, client); - return false; - } - - if ((counter % 20) == 0) { - std::cout << "Current DB instance status is '" - << dbInstance.GetDBInstanceStatus() - << "' after " << counter << " seconds." << std::endl; - } - } while (dbInstance.GetDBInstanceStatus() != "available"); - - if (dbInstance.GetDBInstanceStatus() == "available") { - std::cout << "The DB instance has been created." << std::endl; - } - - printAsterisksLine(); - - // 12. Display the connection string that can be used to connect a 'mysql' shell to the database. - displayConnection(dbInstance); - - printAsterisksLine(); - - if (askYesNoQuestion( - "Do you want to create a snapshot of your DB instance (y/n)? ")) { - Aws::String snapshotID(DB_INSTANCE_IDENTIFIER + "-" + - Aws::String(Aws::Utils::UUID::RandomUUID())); - { - std::cout << "Creating a snapshot named " << snapshotID << "." << std::endl; - std::cout << "This typically takes a few minutes." << std::endl; - - // 13. Create a snapshot of the DB instance. - Aws::RDS::Model::CreateDBSnapshotRequest request; - request.SetDBInstanceIdentifier(DB_INSTANCE_IDENTIFIER); - request.SetDBSnapshotIdentifier(snapshotID); - - Aws::RDS::Model::CreateDBSnapshotOutcome outcome = - client.CreateDBSnapshot(request); - - if (outcome.IsSuccess()) { - std::cout << "Snapshot creation has started." - << std::endl; - } - else { - std::cerr << "Error with RDS::CreateDBSnapshot. " - << outcome.GetError().GetMessage() - << std::endl; - cleanUpResources(PARAMETER_GROUP_NAME, DB_INSTANCE_IDENTIFIER, client); - return false; - } - } - - std::cout << "Waiting for snapshot to become available." << std::endl; - - Aws::RDS::Model::DBSnapshot snapshot; - counter = 0; - do { - std::this_thread::sleep_for(std::chrono::seconds(1)); - ++counter; - if (counter > 600) { - std::cerr << "Wait for snapshot to be available timed out ofter " - << counter - << " seconds." << std::endl; - cleanUpResources(PARAMETER_GROUP_NAME, DB_INSTANCE_IDENTIFIER, client); - return false; - } - - // 14. Wait for the snapshot to become available. - Aws::RDS::Model::DescribeDBSnapshotsRequest request; - request.SetDBSnapshotIdentifier(snapshotID); - - Aws::RDS::Model::DescribeDBSnapshotsOutcome outcome = - client.DescribeDBSnapshots(request); - - if (outcome.IsSuccess()) { - snapshot = outcome.GetResult().GetDBSnapshots()[0]; - } - else { - std::cerr << "Error with RDS::DescribeDBSnapshots. " - << outcome.GetError().GetMessage() - << std::endl; - cleanUpResources(PARAMETER_GROUP_NAME, DB_INSTANCE_IDENTIFIER, client); - return false; - } - - if ((counter % 20) == 0) { - std::cout << "Current snapshot status is '" - << snapshot.GetStatus() - << "' after " << counter << " seconds." << std::endl; - } - } while (snapshot.GetStatus() != "available"); - - if (snapshot.GetStatus() != "available") { - std::cout << "A snapshot has been created." << std::endl; - } - } - - printAsterisksLine(); - - bool result = true; - if (askYesNoQuestion( - "Do you want to delete the DB instance and parameter group (y/n)? ")) { - result = cleanUpResources(PARAMETER_GROUP_NAME, DB_INSTANCE_IDENTIFIER, client); - } - - return result; -} - - -//! Routine which gets DB parameters using the 'DescribeDBParameters' api. -/*! - \sa getDBParameters() - \param parameterGroupName: The name of the parameter group. - \param namePrefix: Prefix string to filter results by parameter name. - \param source: A source such as 'user', ignored if empty. - \param parametersResult: Vector of 'Parameter' objects returned by the routine. - \param client: 'RDSClient' instance. - \return bool: Successful completion. - */ -bool AwsDoc::RDS::getDBParameters(const Aws::String ¶meterGroupName, - const Aws::String &namePrefix, - const Aws::String &source, - Aws::Vector ¶metersResult, - const Aws::RDS::RDSClient &client) { - Aws::String marker; - do { - Aws::RDS::Model::DescribeDBParametersRequest request; - request.SetDBParameterGroupName(PARAMETER_GROUP_NAME); - if (!marker.empty()) { - request.SetMarker(marker); - } - if (!source.empty()) { - request.SetSource(source); - } - - Aws::RDS::Model::DescribeDBParametersOutcome outcome = - client.DescribeDBParameters(request); - - if (outcome.IsSuccess()) { - const Aws::Vector ¶meters = - outcome.GetResult().GetParameters(); - for (const Aws::RDS::Model::Parameter ¶meter: parameters) { - if (!namePrefix.empty()) { - if (parameter.GetParameterName().find(namePrefix) == 0) { - parametersResult.push_back(parameter); - } - } - else { - parametersResult.push_back(parameter); - } - } - - marker = outcome.GetResult().GetMarker(); - } - else { - std::cerr << "Error with RDS::DescribeDBParameters. " - << outcome.GetError().GetMessage() - << std::endl; - return false; - } - } while (!marker.empty()); - - return true; -} - - -//! Routine which gets available DB engine versions for an engine name and -//! an optional parameter group family. -/*! - \sa getDBEngineVersions() - \param engineName: A DB engine name. - \param parameterGroupFamily: A parameter group family name, ignored if empty. - \param engineVersionsResult: Vector of 'DBEngineVersion' objects returned by the routine. - \param client: 'RDSClient' instance. - \return bool: Successful completion. - */ -bool AwsDoc::RDS::getDBEngineVersions(const Aws::String &engineName, - const Aws::String ¶meterGroupFamily, - Aws::Vector &engineVersionsResult, - const Aws::RDS::RDSClient &client) { - Aws::RDS::Model::DescribeDBEngineVersionsRequest request; - request.SetEngine(engineName); - if (!parameterGroupFamily.empty()) { - request.SetDBParameterGroupFamily(parameterGroupFamily); - } - - Aws::RDS::Model::DescribeDBEngineVersionsOutcome outcome = - client.DescribeDBEngineVersions(request); - - if (outcome.IsSuccess()) { - engineVersionsResult = outcome.GetResult().GetDBEngineVersions(); - } - else { - std::cerr << "Error with RDS::DescribeDBEngineVersionsRequest. " - << outcome.GetError().GetMessage() - << std::endl; - } - - return outcome.IsSuccess(); -} - - -//! Routine which gets a DB instance description. -/*! - \sa describeDBInstance() - \param dbInstanceIdentifier: A DB instance identifier. - \param instanceResult: The 'DBInstance' object containing the description. - \param client: 'RDSClient' instance. - \return bool: Successful completion. - */ -bool AwsDoc::RDS::describeDBInstance(const Aws::String &dbInstanceIdentifier, - Aws::RDS::Model::DBInstance &instanceResult, - const Aws::RDS::RDSClient &client) { - Aws::RDS::Model::DescribeDBInstancesRequest request; - request.SetDBInstanceIdentifier(dbInstanceIdentifier); - - Aws::RDS::Model::DescribeDBInstancesOutcome outcome = - client.DescribeDBInstances(request); - - bool result = true; - if (outcome.IsSuccess()) { - instanceResult = outcome.GetResult().GetDBInstances()[0]; - } - // This example does not log an error if the DB instance does not exist. - // Instead, it returns false. - else if (outcome.GetError().GetErrorType() != - Aws::RDS::RDSErrors::D_B_INSTANCE_NOT_FOUND_FAULT) { - result = false; - std::cerr << "Error with RDS::DescribeDBInstances. " - << outcome.GetError().GetMessage() - << std::endl; - } - - return result; -} - - -//! Routine which gets available 'micro' DB instance classes, displays the list -//! to the user, and returns the user selection. -/*! - \sa chooseMicroDBInstanceClass() - \param engineName: The DB engine name. - \param engineVersion: The DB engine version. - \param dbInstanceClass: String for DB instance class chosen by the user. - \param client: 'RDSClient' instance. - \return bool: Successful completion. - */ -bool AwsDoc::RDS::chooseMicroDBInstanceClass(const Aws::String &engine, - const Aws::String &engineVersion, - Aws::String &dbInstanceClass, - const Aws::RDS::RDSClient &client) { - std::vector instanceClasses; - Aws::String marker; - do { - Aws::RDS::Model::DescribeOrderableDBInstanceOptionsRequest request; - request.SetEngine(engine); - request.SetEngineVersion(engineVersion); - if (!marker.empty()) { - request.SetMarker(marker); - } - - Aws::RDS::Model::DescribeOrderableDBInstanceOptionsOutcome outcome = - client.DescribeOrderableDBInstanceOptions(request); - - if (outcome.IsSuccess()) { - const Aws::Vector &options = - outcome.GetResult().GetOrderableDBInstanceOptions(); - for (const Aws::RDS::Model::OrderableDBInstanceOption &option: options) { - const Aws::String &instanceClass = option.GetDBInstanceClass(); - if (instanceClass.find("micro") != std::string::npos) { - if (std::find(instanceClasses.begin(), instanceClasses.end(), - instanceClass) == - instanceClasses.end()) { - instanceClasses.push_back(instanceClass); - } - } - } - marker = outcome.GetResult().GetMarker(); - } - else { - std::cerr << "Error with RDS::DescribeOrderableDBInstanceOptions. " - << outcome.GetError().GetMessage() - << std::endl; - return false; - } - } while (!marker.empty()); - - std::cout << "The available micro DB instance classes for your database engine are:" - << std::endl; - for (int i = 0; i < instanceClasses.size(); ++i) { - std::cout << " " << i + 1 << ": " << instanceClasses[i] << std::endl; - } - - int choice = askQuestionForIntRange( - "Which micro DB instance class do you want to use? ", - 1, static_cast(instanceClasses.size())); - dbInstanceClass = instanceClasses[choice - 1]; - return true; -} - -//! Routine which deletes resources created by the scenario. -/*! -\sa cleanUpResources() -\param parameterGroupName: A parameter group name, this may be empty. -\param dbInstanceIdentifier: A DB instance identifier, this may be empty. -\param client: 'RDSClient' instance. -\return bool: Successful completion. -*/ -bool AwsDoc::RDS::cleanUpResources(const Aws::String ¶meterGroupName, - const Aws::String &dbInstanceIdentifier, - const Aws::RDS::RDSClient &client) { - bool result = true; - if (!dbInstanceIdentifier.empty()) { - { - // 15. Delete the DB instance. - Aws::RDS::Model::DeleteDBInstanceRequest request; - request.SetDBInstanceIdentifier(dbInstanceIdentifier); - request.SetSkipFinalSnapshot(true); - request.SetDeleteAutomatedBackups(true); - - Aws::RDS::Model::DeleteDBInstanceOutcome outcome = - client.DeleteDBInstance(request); - - if (outcome.IsSuccess()) { - std::cout << "DB instance deletion has started." - << std::endl; - } - else { - std::cerr << "Error with RDS::DeleteDBInstance. " - << outcome.GetError().GetMessage() - << std::endl; - result = false; - } - } - - std::cout - << "Waiting for DB instance to delete before deleting the parameter group." - << std::endl; - std::cout << "This may take a while." << std::endl; - - int counter = 0; - Aws::RDS::Model::DBInstance dbInstance; - do { - std::this_thread::sleep_for(std::chrono::seconds(1)); - ++counter; - if (counter > 800) { - std::cerr << "Wait for instance to delete timed out ofter " << counter - << " seconds." << std::endl; - return false; - } - - dbInstance = Aws::RDS::Model::DBInstance(); - // 16. Wait for the DB instance to be deleted. - if (!describeDBInstance(dbInstanceIdentifier, dbInstance, client)) { - return false; - } - - if (dbInstance.DBInstanceIdentifierHasBeenSet() && (counter % 20) == 0) { - std::cout << "Current DB instance status is '" - << dbInstance.GetDBInstanceStatus() - << "' after " << counter << " seconds." << std::endl; - } - } while (dbInstance.DBInstanceIdentifierHasBeenSet()); - } - - if (!parameterGroupName.empty()) { - // 17. Delete the parameter group. - Aws::RDS::Model::DeleteDBParameterGroupRequest request; - request.SetDBParameterGroupName(parameterGroupName); - - Aws::RDS::Model::DeleteDBParameterGroupOutcome outcome = - client.DeleteDBParameterGroup(request); - - if (outcome.IsSuccess()) { - std::cout << "The DB parameter group was successfully deleted." - << std::endl; - } - else { - std::cerr << "Error with RDS::DeleteDBParameterGroup. " - << outcome.GetError().GetMessage() - << std::endl; - result = false; - } - } - - return result; -} -``` -+ For API details, see the following topics in *AWS SDK for C\+\+ API Reference*\. - + [CreateDBInstance](https://docs.aws.amazon.com/goto/SdkForCpp/rds-2014-10-31/CreateDBInstance) - + [CreateDBParameterGroup](https://docs.aws.amazon.com/goto/SdkForCpp/rds-2014-10-31/CreateDBParameterGroup) - + [CreateDBSnapshot](https://docs.aws.amazon.com/goto/SdkForCpp/rds-2014-10-31/CreateDBSnapshot) - + [DeleteDBInstance](https://docs.aws.amazon.com/goto/SdkForCpp/rds-2014-10-31/DeleteDBInstance) - + [DeleteDBParameterGroup](https://docs.aws.amazon.com/goto/SdkForCpp/rds-2014-10-31/DeleteDBParameterGroup) - + [DescribeDBEngineVersions](https://docs.aws.amazon.com/goto/SdkForCpp/rds-2014-10-31/DescribeDBEngineVersions) - + [DescribeDBInstances](https://docs.aws.amazon.com/goto/SdkForCpp/rds-2014-10-31/DescribeDBInstances) - + [DescribeDBParameterGroups](https://docs.aws.amazon.com/goto/SdkForCpp/rds-2014-10-31/DescribeDBParameterGroups) - + [DescribeDBParameters](https://docs.aws.amazon.com/goto/SdkForCpp/rds-2014-10-31/DescribeDBParameters) - + [DescribeDBSnapshots](https://docs.aws.amazon.com/goto/SdkForCpp/rds-2014-10-31/DescribeDBSnapshots) - + [DescribeOrderableDBInstanceOptions](https://docs.aws.amazon.com/goto/SdkForCpp/rds-2014-10-31/DescribeOrderableDBInstanceOptions) - + [ModifyDBParameterGroup](https://docs.aws.amazon.com/goto/SdkForCpp/rds-2014-10-31/ModifyDBParameterGroup) - ------- -#### [ Java ] - -**SDK for Java 2\.x** - There's more on GitHub\. Find the complete example and learn how to set up and run in the [AWS Code Examples Repository](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/javav2/example_code/rds#readme)\. -Run multiple operations\. - -``` -/** - * Before running this Java (v2) code example, set up your development environment, including your credentials. - * - * For more information, see the following documentation topic: - * - * https://docs.aws.amazon.com/sdk-for-java/latest/developer-guide/get-started.html - * - * This Java example performs the following tasks: - * - * 1. Returns a list of the available DB engines. - * 2. Selects an engine family and create a custom DB parameter group. - * 3. Gets the parameter groups. - * 4. Gets parameters in the group. - * 5. Modifies the auto_increment_offset parameter. - * 6. Gets and displays the updated parameters. - * 7. Gets a list of allowed engine versions. - * 8. Gets a list of micro instance classes available for the selected engine. - * 9. Creates an RDS database instance that contains a MySql database and uses the parameter group. - * 10. Waits for the DB instance to be ready and prints out the connection endpoint value. - * 11. Creates a snapshot of the DB instance. - * 12. Waits for an RDS DB snapshot to be ready. - * 13. Deletes the RDS DB instance. - * 14. Deletes the parameter group. - */ -public class RDSScenario { - - public static long sleepTime = 20; - public static final String DASHES = new String(new char[80]).replace("\0", "-"); - public static void main(String[] args) throws InterruptedException { - - final String usage = "\n" + - "Usage:\n" + - " \n\n" + - "Where:\n" + - " dbGroupName - The database group name. \n"+ - " dbParameterGroupFamily - The database parameter group name (for example, mysql8.0).\n"+ - " dbInstanceIdentifier - The database instance identifier \n"+ - " dbName - The database name. \n"+ - " masterUsername - The master user name. \n"+ - " masterUserPassword - The password that corresponds to the master user name. \n"+ - " dbSnapshotIdentifier - The snapshot identifier. \n" ; - - if (args.length != 7) { - System.out.println(usage); - System.exit(1); - } - - String dbGroupName = args[0]; - String dbParameterGroupFamily = args[1]; - String dbInstanceIdentifier = args[2]; - String dbName = args[3]; - String masterUsername = args[4]; - String masterUserPassword = args[5]; - String dbSnapshotIdentifier = args[6]; - - Region region = Region.US_WEST_2; - RdsClient rdsClient = RdsClient.builder() - .region(region) - .credentialsProvider(ProfileCredentialsProvider.create()) - .build(); - System.out.println(DASHES); - System.out.println("Welcome to the Amazon RDS example scenario."); - System.out.println(DASHES); - - System.out.println(DASHES); - System.out.println("1. Return a list of the available DB engines"); - describeDBEngines(rdsClient); - System.out.println(DASHES); - - System.out.println(DASHES); - System.out.println("2. Create a custom parameter group"); - createDBParameterGroup(rdsClient, dbGroupName, dbParameterGroupFamily); - System.out.println(DASHES); - - System.out.println(DASHES); - System.out.println("3. Get the parameter group"); - describeDbParameterGroups(rdsClient, dbGroupName); - System.out.println(DASHES); - - System.out.println(DASHES); - System.out.println("4. Get the parameters in the group"); - describeDbParameters(rdsClient, dbGroupName, 0); - System.out.println(DASHES); - - System.out.println(DASHES); - System.out.println("5. Modify the auto_increment_offset parameter"); - modifyDBParas(rdsClient, dbGroupName); - System.out.println(DASHES); - - System.out.println(DASHES); - System.out.println("6. Display the updated value"); - describeDbParameters(rdsClient, dbGroupName, -1); - System.out.println(DASHES); - - System.out.println(DASHES); - System.out.println("7. Get a list of allowed engine versions"); - getAllowedEngines(rdsClient, dbParameterGroupFamily); - System.out.println(DASHES); - - System.out.println(DASHES); - System.out.println("8. Get a list of micro instance classes available for the selected engine") ; - getMicroInstances(rdsClient); - System.out.println(DASHES); - - System.out.println(DASHES); - System.out.println("9. Create an RDS database instance that contains a MySql database and uses the parameter group"); - String dbARN = createDatabaseInstance(rdsClient, dbGroupName, dbInstanceIdentifier, dbName, masterUsername, masterUserPassword); - System.out.println("The ARN of the new database is "+dbARN); - System.out.println(DASHES); - - System.out.println(DASHES); - System.out.println("10. Wait for DB instance to be ready" ); - waitForInstanceReady(rdsClient, dbInstanceIdentifier); - System.out.println(DASHES); - - System.out.println(DASHES); - System.out.println("11. Create a snapshot of the DB instance"); - createSnapshot(rdsClient, dbInstanceIdentifier, dbSnapshotIdentifier); - System.out.println(DASHES); - - System.out.println(DASHES); - System.out.println("12. Wait for DB snapshot to be ready" ); - waitForSnapshotReady(rdsClient, dbInstanceIdentifier, dbSnapshotIdentifier); - System.out.println(DASHES); - - System.out.println(DASHES); - System.out.println("13. Delete the DB instance" ); - deleteDatabaseInstance(rdsClient, dbInstanceIdentifier); - System.out.println(DASHES); - - System.out.println(DASHES); - System.out.println("14. Delete the parameter group"); - deleteParaGroup(rdsClient, dbGroupName, dbARN); - System.out.println(DASHES); - - System.out.println(DASHES); - System.out.println("The Scenario has successfully completed." ); - System.out.println(DASHES); - - rdsClient.close(); - } - - // Delete the parameter group after database has been deleted. - // An exception is thrown if you attempt to delete the para group while database exists. - public static void deleteParaGroup( RdsClient rdsClient, String dbGroupName, String dbARN) throws InterruptedException { - try { - boolean isDataDel = false; - boolean didFind; - String instanceARN ; - - // Make sure that the database has been deleted. - while (!isDataDel) { - DescribeDbInstancesResponse response = rdsClient.describeDBInstances(); - List instanceList = response.dbInstances(); - int listSize = instanceList.size(); - isDataDel = false ; - didFind = false; - int index = 1; - for (DBInstance instance: instanceList) { - instanceARN = instance.dbInstanceArn(); - if (instanceARN.compareTo(dbARN) == 0) { - System.out.println(dbARN + " still exists"); - didFind = true ; - } - if ((index == listSize) && (!didFind)) { - // Went through the entire list and did not find the database ARN. - isDataDel = true; - } - Thread.sleep(sleepTime * 1000); - index ++; - } - } - - // Delete the para group. - DeleteDbParameterGroupRequest parameterGroupRequest = DeleteDbParameterGroupRequest.builder() - .dbParameterGroupName(dbGroupName) - .build(); - - rdsClient.deleteDBParameterGroup(parameterGroupRequest); - System.out.println(dbGroupName +" was deleted."); - - } catch (RdsException e) { - System.out.println(e.getLocalizedMessage()); - System.exit(1); - } - } - - // Delete the DB instance. - public static void deleteDatabaseInstance( RdsClient rdsClient, String dbInstanceIdentifier) { - try { - DeleteDbInstanceRequest deleteDbInstanceRequest = DeleteDbInstanceRequest.builder() - .dbInstanceIdentifier(dbInstanceIdentifier) - .deleteAutomatedBackups(true) - .skipFinalSnapshot(true) - .build(); - - DeleteDbInstanceResponse response = rdsClient.deleteDBInstance(deleteDbInstanceRequest); - System.out.print("The status of the database is " + response.dbInstance().dbInstanceStatus()); - - } catch (RdsException e) { - System.out.println(e.getLocalizedMessage()); - System.exit(1); - } - } - - // Waits until the snapshot instance is available. - public static void waitForSnapshotReady(RdsClient rdsClient, String dbInstanceIdentifier, String dbSnapshotIdentifier) { - try { - boolean snapshotReady = false; - String snapshotReadyStr; - System.out.println("Waiting for the snapshot to become available."); - - DescribeDbSnapshotsRequest snapshotsRequest = DescribeDbSnapshotsRequest.builder() - .dbSnapshotIdentifier(dbSnapshotIdentifier) - .dbInstanceIdentifier(dbInstanceIdentifier) - .build(); - - while (!snapshotReady) { - DescribeDbSnapshotsResponse response = rdsClient.describeDBSnapshots(snapshotsRequest); - List snapshotList = response.dbSnapshots(); - for (DBSnapshot snapshot : snapshotList) { - snapshotReadyStr = snapshot.status(); - if (snapshotReadyStr.contains("available")) { - snapshotReady = true; - } else { - System.out.print("."); - Thread.sleep(sleepTime * 1000); - } - } - } - - System.out.println("The Snapshot is available!"); - } catch (RdsException | InterruptedException e) { - System.out.println(e.getLocalizedMessage()); - System.exit(1); - } - } - - // Create an Amazon RDS snapshot. - public static void createSnapshot(RdsClient rdsClient, String dbInstanceIdentifier, String dbSnapshotIdentifier) { - try { - CreateDbSnapshotRequest snapshotRequest = CreateDbSnapshotRequest.builder() - .dbInstanceIdentifier(dbInstanceIdentifier) - .dbSnapshotIdentifier(dbSnapshotIdentifier) - .build(); - - CreateDbSnapshotResponse response = rdsClient.createDBSnapshot(snapshotRequest); - System.out.println("The Snapshot id is " + response.dbSnapshot().dbiResourceId()); - - } catch (RdsException e) { - System.out.println(e.getLocalizedMessage()); - System.exit(1); - } - } - - // Waits until the database instance is available. - public static void waitForInstanceReady(RdsClient rdsClient, String dbInstanceIdentifier) { - boolean instanceReady = false; - String instanceReadyStr; - System.out.println("Waiting for instance to become available."); - - try { - DescribeDbInstancesRequest instanceRequest = DescribeDbInstancesRequest.builder() - .dbInstanceIdentifier(dbInstanceIdentifier) - .build(); - - String endpoint=""; - while (!instanceReady) { - DescribeDbInstancesResponse response = rdsClient.describeDBInstances(instanceRequest); - List instanceList = response.dbInstances(); - for (DBInstance instance : instanceList) { - instanceReadyStr = instance.dbInstanceStatus(); - if (instanceReadyStr.contains("available")) { - endpoint = instance.endpoint().address(); - instanceReady = true; - } else { - System.out.print("."); - Thread.sleep(sleepTime * 1000); - } - } - } - System.out.println("Database instance is available! The connection endpoint is "+ endpoint); - - } catch (RdsException | InterruptedException e) { - System.err.println(e.getMessage()); - System.exit(1); - } - } - - // Create a database instance and return the ARN of the database. - public static String createDatabaseInstance(RdsClient rdsClient, - String dbGroupName, - String dbInstanceIdentifier, - String dbName, - String masterUsername, - String masterUserPassword) { - - try { - CreateDbInstanceRequest instanceRequest = CreateDbInstanceRequest.builder() - .dbInstanceIdentifier(dbInstanceIdentifier) - .allocatedStorage(100) - .dbName(dbName) - .dbParameterGroupName(dbGroupName) - .engine("mysql") - .dbInstanceClass("db.m4.large") - .engineVersion("8.0") - .storageType("standard") - .masterUsername(masterUsername) - .masterUserPassword(masterUserPassword) - .build(); - - CreateDbInstanceResponse response = rdsClient.createDBInstance(instanceRequest); - System.out.print("The status is " + response.dbInstance().dbInstanceStatus()); - return response.dbInstance().dbInstanceArn(); - - } catch (RdsException e) { - System.out.println(e.getLocalizedMessage()); - System.exit(1); - } - - return ""; - } - - // Get a list of micro instances. - public static void getMicroInstances(RdsClient rdsClient) { - try { - DescribeOrderableDbInstanceOptionsRequest dbInstanceOptionsRequest = DescribeOrderableDbInstanceOptionsRequest.builder() - .engine("mysql") - .build(); - - DescribeOrderableDbInstanceOptionsResponse response = rdsClient.describeOrderableDBInstanceOptions(dbInstanceOptionsRequest); - List orderableDBInstances = response.orderableDBInstanceOptions(); - for (OrderableDBInstanceOption dbInstanceOption: orderableDBInstances) { - System.out.println("The engine version is " +dbInstanceOption.engineVersion()); - System.out.println("The engine description is " +dbInstanceOption.engine()); - } - - } catch (RdsException e) { - System.out.println(e.getLocalizedMessage()); - System.exit(1); - } - } - - // Get a list of allowed engine versions. - public static void getAllowedEngines(RdsClient rdsClient, String dbParameterGroupFamily) { - try { - DescribeDbEngineVersionsRequest versionsRequest = DescribeDbEngineVersionsRequest.builder() - .dbParameterGroupFamily(dbParameterGroupFamily) - .engine("mysql") - .build(); - - DescribeDbEngineVersionsResponse response = rdsClient.describeDBEngineVersions(versionsRequest); - List dbEngines = response.dbEngineVersions(); - for (DBEngineVersion dbEngine: dbEngines) { - System.out.println("The engine version is " +dbEngine.engineVersion()); - System.out.println("The engine description is " +dbEngine.dbEngineDescription()); - } - - } catch (RdsException e) { - System.out.println(e.getLocalizedMessage()); - System.exit(1); - } - } - - // Modify auto_increment_offset and auto_increment_increment parameters. - public static void modifyDBParas(RdsClient rdsClient, String dbGroupName) { - try { - Parameter parameter1 = Parameter.builder() - .parameterName("auto_increment_offset") - .applyMethod("immediate") - .parameterValue("5") - .build(); - - List paraList = new ArrayList<>(); - paraList.add(parameter1); - ModifyDbParameterGroupRequest groupRequest = ModifyDbParameterGroupRequest.builder() - .dbParameterGroupName(dbGroupName) - .parameters(paraList) - .build(); - - ModifyDbParameterGroupResponse response = rdsClient.modifyDBParameterGroup(groupRequest); - System.out.println("The parameter group "+ response.dbParameterGroupName() +" was successfully modified"); - - } catch (RdsException e) { - System.out.println(e.getLocalizedMessage()); - System.exit(1); - } - } - - // Retrieve parameters in the group. - public static void describeDbParameters(RdsClient rdsClient, String dbGroupName, int flag) { - try { - DescribeDbParametersRequest dbParameterGroupsRequest; - if (flag == 0) { - dbParameterGroupsRequest = DescribeDbParametersRequest.builder() - .dbParameterGroupName(dbGroupName) - .build(); - } else { - dbParameterGroupsRequest = DescribeDbParametersRequest.builder() - .dbParameterGroupName(dbGroupName) - .source("user") - .build(); - } - - DescribeDbParametersResponse response = rdsClient.describeDBParameters(dbParameterGroupsRequest); - List dbParameters = response.parameters(); - String paraName; - for (Parameter para: dbParameters) { - // Only print out information about either auto_increment_offset or auto_increment_increment. - paraName = para.parameterName(); - if ( (paraName.compareTo("auto_increment_offset") ==0) || (paraName.compareTo("auto_increment_increment ") ==0)) { - System.out.println("*** The parameter name is " + paraName); - System.out.println("*** The parameter value is " + para.parameterValue()); - System.out.println("*** The parameter data type is " + para.dataType()); - System.out.println("*** The parameter description is " + para.description()); - System.out.println("*** The parameter allowed values is " + para.allowedValues()); - } - } - - } catch (RdsException e) { - System.out.println(e.getLocalizedMessage()); - System.exit(1); - } - } - - public static void describeDbParameterGroups(RdsClient rdsClient, String dbGroupName) { - try { - DescribeDbParameterGroupsRequest groupsRequest = DescribeDbParameterGroupsRequest.builder() - .dbParameterGroupName(dbGroupName) - .maxRecords(20) - .build(); - - DescribeDbParameterGroupsResponse response = rdsClient.describeDBParameterGroups(groupsRequest); - List groups = response.dbParameterGroups(); - for (DBParameterGroup group: groups) { - System.out.println("The group name is "+group.dbParameterGroupName()); - System.out.println("The group description is "+group.description()); - } - - } catch (RdsException e) { - System.out.println(e.getLocalizedMessage()); - System.exit(1); - } - } - - public static void createDBParameterGroup(RdsClient rdsClient, String dbGroupName, String dbParameterGroupFamily) { - try { - CreateDbParameterGroupRequest groupRequest = CreateDbParameterGroupRequest.builder() - .dbParameterGroupName(dbGroupName) - .dbParameterGroupFamily(dbParameterGroupFamily) - .description("Created by using the AWS SDK for Java") - .build(); - - CreateDbParameterGroupResponse response = rdsClient.createDBParameterGroup(groupRequest); - System.out.println("The group name is "+ response.dbParameterGroup().dbParameterGroupName()); - - } catch (RdsException e) { - System.out.println(e.getLocalizedMessage()); - System.exit(1); - } - } - - - public static void describeDBEngines( RdsClient rdsClient) { - try { - DescribeDbEngineVersionsRequest engineVersionsRequest = DescribeDbEngineVersionsRequest.builder() - .defaultOnly(true) - .engine("mysql") - .maxRecords(20) - .build(); - - DescribeDbEngineVersionsResponse response = rdsClient.describeDBEngineVersions(engineVersionsRequest); - List engines = response.dbEngineVersions(); - - // Get all DBEngineVersion objects. - for (DBEngineVersion engineOb: engines) { - System.out.println("The name of the DB parameter group family for the database engine is "+engineOb.dbParameterGroupFamily()); - System.out.println("The name of the database engine "+engineOb.engine()); - System.out.println("The version number of the database engine "+engineOb.engineVersion()); - } - - } catch (RdsException e) { - System.out.println(e.getLocalizedMessage()); - System.exit(1); - } - } -} -``` -+ For API details, see the following topics in *AWS SDK for Java 2\.x API Reference*\. - + [CreateDBInstance](https://docs.aws.amazon.com/goto/SdkForJavaV2/rds-2014-10-31/CreateDBInstance) - + [CreateDBParameterGroup](https://docs.aws.amazon.com/goto/SdkForJavaV2/rds-2014-10-31/CreateDBParameterGroup) - + [CreateDBSnapshot](https://docs.aws.amazon.com/goto/SdkForJavaV2/rds-2014-10-31/CreateDBSnapshot) - + [DeleteDBInstance](https://docs.aws.amazon.com/goto/SdkForJavaV2/rds-2014-10-31/DeleteDBInstance) - + [DeleteDBParameterGroup](https://docs.aws.amazon.com/goto/SdkForJavaV2/rds-2014-10-31/DeleteDBParameterGroup) - + [DescribeDBEngineVersions](https://docs.aws.amazon.com/goto/SdkForJavaV2/rds-2014-10-31/DescribeDBEngineVersions) - + [DescribeDBInstances](https://docs.aws.amazon.com/goto/SdkForJavaV2/rds-2014-10-31/DescribeDBInstances) - + [DescribeDBParameterGroups](https://docs.aws.amazon.com/goto/SdkForJavaV2/rds-2014-10-31/DescribeDBParameterGroups) - + [DescribeDBParameters](https://docs.aws.amazon.com/goto/SdkForJavaV2/rds-2014-10-31/DescribeDBParameters) - + [DescribeDBSnapshots](https://docs.aws.amazon.com/goto/SdkForJavaV2/rds-2014-10-31/DescribeDBSnapshots) - + [DescribeOrderableDBInstanceOptions](https://docs.aws.amazon.com/goto/SdkForJavaV2/rds-2014-10-31/DescribeOrderableDBInstanceOptions) - + [ModifyDBParameterGroup](https://docs.aws.amazon.com/goto/SdkForJavaV2/rds-2014-10-31/ModifyDBParameterGroup) - ------- -#### [ Kotlin ] - -**SDK for Kotlin** -This is prerelease documentation for a feature in preview release\. It is subject to change\. - There's more on GitHub\. Find the complete example and learn how to set up and run in the [AWS Code Examples Repository](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/kotlin/services/rds#code-examples)\. - - -``` -/** - Before running this Java V2 code example, set up your development environment, including your credentials. - - For more information, see the following documentation topic: - - https://docs.aws.amazon.com/sdk-for-java/latest/developer-guide/get-started.html - - This example performs the following tasks: - - 1. Returns a list of the available DB engines by invoking the DescribeDbEngineVersions method. - 2. Selects an engine family and create a custom DB parameter group by invoking the createDBParameterGroup method. - 3. Gets the parameter groups by invoking the DescribeDbParameterGroups method. - 4. Gets parameters in the group by invoking the DescribeDbParameters method. - 5. Modifies both the auto_increment_offset and auto_increment_increment parameters by invoking the modifyDbParameterGroup method. - 6. Gets and displays the updated parameters. - 7. Gets a list of allowed engine versions by invoking the describeDbEngineVersions method. - 8. Gets a list of micro instance classes available for the selected engine. - 9. Creates an RDS database instance that contains a MySql database and uses the parameter group - 10. Waits for DB instance to be ready and print out the connection endpoint value. - 11. Creates a snapshot of the DB instance. - 12. Waits for DB snapshot to be ready. - 13. Deletes the DB instance. rds.DeleteDbInstance. - 14. Deletes the parameter group. - */ - -var sleepTime: Long = 20 -suspend fun main(args: Array) { - val usage = """ - Usage: - - - Where: - dbGroupName - The database group name. - dbParameterGroupFamily - The database parameter group name. - dbInstanceIdentifier - The database instance identifier. - dbName - The database name. - username - The user name. - userPassword - The password that corresponds to the user name. - dbSnapshotIdentifier - The snapshot identifier. - """ - - if (args.size != 7) { - println(usage) - exitProcess(1) - } - - val dbGroupName = args[0] - val dbParameterGroupFamily = args[1] - val dbInstanceIdentifier = args[2] - val dbName = args[3] - val username = args[4] - val userPassword = args[5] - val dbSnapshotIdentifier = args[6] - - println("1. Return a list of the available DB engines") - describeDBEngines() - - println("2. Create a custom parameter group") - createDBParameterGroup(dbGroupName, dbParameterGroupFamily) - - println("3. Get the parameter groups") - describeDbParameterGroups(dbGroupName) - - println("4. Get the parameters in the group") - describeDbParameters(dbGroupName, 0) - - println("5. Modify the auto_increment_offset parameter") - modifyDBParas(dbGroupName) - - println("6. Display the updated value") - describeDbParameters(dbGroupName, -1) - - println("7. Get a list of allowed engine versions") - getAllowedEngines(dbParameterGroupFamily) - - println("8. Get a list of micro instance classes available for the selected engine") - getMicroInstances() - - println("9. Create an RDS database instance that contains a MySql database and uses the parameter group") - val dbARN = createDatabaseInstance(dbGroupName, dbInstanceIdentifier, dbName, username, userPassword) - println("The ARN of the new database is $dbARN") - - println("10. Wait for DB instance to be ready") - waitForDbInstanceReady(dbInstanceIdentifier) - - println("11. Create a snapshot of the DB instance") - createDbSnapshot(dbInstanceIdentifier, dbSnapshotIdentifier) - - println("12. Wait for DB snapshot to be ready") - waitForSnapshotReady(dbInstanceIdentifier, dbSnapshotIdentifier) - - println("13. Delete the DB instance") - deleteDbInstance(dbInstanceIdentifier) - - println("14. Delete the parameter group") - if (dbARN != null) { - deleteParaGroup(dbGroupName, dbARN) - } - - println("The Scenario has successfully completed.") -} - -suspend fun deleteParaGroup(dbGroupName: String, dbARN: String) { - var isDataDel = false - var didFind: Boolean - var instanceARN: String - - RdsClient { region = "us-west-2" }.use { rdsClient -> - // Make sure that the database has been deleted. - while (!isDataDel) { - val response = rdsClient.describeDbInstances() - val instanceList = response.dbInstances - val listSize = instanceList?.size - isDataDel = false // Reset this value. - didFind = false // Reset this value. - var index = 1 - if (instanceList != null) { - for (instance in instanceList) { - instanceARN = instance.dbInstanceArn.toString() - if (instanceARN.compareTo(dbARN) == 0) { - println("$dbARN still exists") - didFind = true - } - if (index == listSize && !didFind) { - // Went through the entire list and did not find the database name. - isDataDel = true - } - index++ - } - } - } - - // Delete the para group. - val parameterGroupRequest = DeleteDbParameterGroupRequest { - dbParameterGroupName = dbGroupName - } - rdsClient.deleteDbParameterGroup(parameterGroupRequest) - println("$dbGroupName was deleted.") - } -} - -suspend fun deleteDbInstance(dbInstanceIdentifierVal: String) { - val deleteDbInstanceRequest = DeleteDbInstanceRequest { - dbInstanceIdentifier = dbInstanceIdentifierVal - deleteAutomatedBackups = true - skipFinalSnapshot = true - } - - RdsClient { region = "us-west-2" }.use { rdsClient -> - val response = rdsClient.deleteDbInstance(deleteDbInstanceRequest) - print("The status of the database is ${response.dbInstance?.dbInstanceStatus}") - } -} - -// Waits until the snapshot instance is available. -suspend fun waitForSnapshotReady(dbInstanceIdentifierVal: String?, dbSnapshotIdentifierVal: String?) { - var snapshotReady = false - var snapshotReadyStr: String - println("Waiting for the snapshot to become available.") - - val snapshotsRequest = DescribeDbSnapshotsRequest { - dbSnapshotIdentifier = dbSnapshotIdentifierVal - dbInstanceIdentifier = dbInstanceIdentifierVal - } - - while (!snapshotReady) { - RdsClient { region = "us-west-2" }.use { rdsClient -> - val response = rdsClient.describeDbSnapshots(snapshotsRequest) - val snapshotList: List? = response.dbSnapshots - if (snapshotList != null) { - for (snapshot in snapshotList) { - snapshotReadyStr = snapshot.status.toString() - if (snapshotReadyStr.contains("available")) { - snapshotReady = true - } else { - print(".") - delay(sleepTime * 1000) - } - } - } - } - } - println("The Snapshot is available!") -} - -// Create an Amazon RDS snapshot. -suspend fun createDbSnapshot(dbInstanceIdentifierVal: String?, dbSnapshotIdentifierVal: String?) { - val snapshotRequest = CreateDbSnapshotRequest { - dbInstanceIdentifier = dbInstanceIdentifierVal - dbSnapshotIdentifier = dbSnapshotIdentifierVal - } - - RdsClient { region = "us-west-2" }.use { rdsClient -> - val response = rdsClient.createDbSnapshot(snapshotRequest) - print("The Snapshot id is ${response.dbSnapshot?.dbiResourceId}") - } -} - -// Waits until the database instance is available. -suspend fun waitForDbInstanceReady(dbInstanceIdentifierVal: String?) { - var instanceReady = false - var instanceReadyStr: String - println("Waiting for instance to become available.") - - val instanceRequest = DescribeDbInstancesRequest { - dbInstanceIdentifier = dbInstanceIdentifierVal - } - var endpoint = "" - while (!instanceReady) { - RdsClient { region = "us-west-2" }.use { rdsClient -> - val response = rdsClient.describeDbInstances(instanceRequest) - val instanceList = response.dbInstances - if (instanceList != null) { - for (instance in instanceList) { - instanceReadyStr = instance.dbInstanceStatus.toString() - if (instanceReadyStr.contains("available")) { - endpoint = instance.endpoint?.address.toString() - instanceReady = true - } else { - print(".") - delay(sleepTime * 1000) - } - } - } - } - } - println("Database instance is available! The connection endpoint is $endpoint") -} - -// Create a database instance and return the ARN of the database. -suspend fun createDatabaseInstance(dbGroupNameVal: String?, dbInstanceIdentifierVal: String?, dbNameVal: String?, masterUsernameVal: String?, masterUserPasswordVal: String?): String? { - val instanceRequest = CreateDbInstanceRequest { - dbInstanceIdentifier = dbInstanceIdentifierVal - allocatedStorage = 100 - dbName = dbNameVal - dbParameterGroupName = dbGroupNameVal - engine = "mysql" - dbInstanceClass = "db.m4.large" - engineVersion = "8.0" - storageType = "standard" - masterUsername = masterUsernameVal - masterUserPassword = masterUserPasswordVal - } - - RdsClient { region = "us-west-2" }.use { rdsClient -> - val response = rdsClient.createDbInstance(instanceRequest) - print("The status is ${response.dbInstance?.dbInstanceStatus}") - return response.dbInstance?.dbInstanceArn - } -} - -// Get a list of micro instances. -suspend fun getMicroInstances() { - val dbInstanceOptionsRequest = DescribeOrderableDbInstanceOptionsRequest { - engine = "mysql" - } - RdsClient { region = "us-west-2" }.use { rdsClient -> - val response = rdsClient.describeOrderableDbInstanceOptions(dbInstanceOptionsRequest) - val orderableDBInstances = response.orderableDbInstanceOptions - if (orderableDBInstances != null) { - for (dbInstanceOption in orderableDBInstances) { - println("The engine version is ${dbInstanceOption.engineVersion}") - println("The engine description is ${dbInstanceOption.engine}") - } - } - } -} - -// Get a list of allowed engine versions. -suspend fun getAllowedEngines(dbParameterGroupFamilyVal: String?) { - val versionsRequest = DescribeDbEngineVersionsRequest { - dbParameterGroupFamily = dbParameterGroupFamilyVal - engine = "mysql" - } - RdsClient { region = "us-west-2" }.use { rdsClient -> - val response = rdsClient.describeDbEngineVersions(versionsRequest) - val dbEngines: List? = response.dbEngineVersions - if (dbEngines != null) { - for (dbEngine in dbEngines) { - println("The engine version is ${dbEngine.engineVersion}") - println("The engine description is ${dbEngine.dbEngineDescription}") - } - } - } -} - -// Modify the auto_increment_offset parameter. -suspend fun modifyDBParas(dbGroupName: String) { - val parameter1 = Parameter { - parameterName = "auto_increment_offset" - applyMethod = ApplyMethod.Immediate - parameterValue = "5" - } - - val paraList: ArrayList = ArrayList() - paraList.add(parameter1) - val groupRequest = ModifyDbParameterGroupRequest { - dbParameterGroupName = dbGroupName - parameters = paraList - } - - RdsClient { region = "us-west-2" }.use { rdsClient -> - val response = rdsClient.modifyDbParameterGroup(groupRequest) - println("The parameter group ${response.dbParameterGroupName} was successfully modified") - } -} - -// Retrieve parameters in the group. -suspend fun describeDbParameters(dbGroupName: String?, flag: Int) { - val dbParameterGroupsRequest: DescribeDbParametersRequest - dbParameterGroupsRequest = if (flag == 0) { - DescribeDbParametersRequest { - dbParameterGroupName = dbGroupName - } - } else { - DescribeDbParametersRequest { - dbParameterGroupName = dbGroupName - source = "user" - } - } - RdsClient { region = "us-west-2" }.use { rdsClient -> - val response = rdsClient.describeDbParameters(dbParameterGroupsRequest) - val dbParameters: List? = response.parameters - var paraName: String - if (dbParameters != null) { - for (para in dbParameters) { - // Only print out information about either auto_increment_offset or auto_increment_increment. - paraName = para.parameterName.toString() - if (paraName.compareTo("auto_increment_offset") == 0 || paraName.compareTo("auto_increment_increment ") == 0) { - println("*** The parameter name is $paraName") - System.out.println("*** The parameter value is ${para.parameterValue}") - System.out.println("*** The parameter data type is ${para.dataType}") - System.out.println("*** The parameter description is ${para.description}") - System.out.println("*** The parameter allowed values is ${para.allowedValues}") - } - } - } - } -} - -suspend fun describeDbParameterGroups(dbGroupName: String?) { - val groupsRequest = DescribeDbParameterGroupsRequest { - dbParameterGroupName = dbGroupName - maxRecords = 20 - } - RdsClient { region = "us-west-2" }.use { rdsClient -> - val response = rdsClient.describeDbParameterGroups(groupsRequest) - val groups = response.dbParameterGroups - if (groups != null) { - for (group in groups) { - println("The group name is ${group.dbParameterGroupName}") - println("The group description is ${group.description}") - } - } - } -} - -// Create a parameter group. -suspend fun createDBParameterGroup(dbGroupName: String?, dbParameterGroupFamilyVal: String?) { - val groupRequest = CreateDbParameterGroupRequest { - dbParameterGroupName = dbGroupName - dbParameterGroupFamily = dbParameterGroupFamilyVal - description = "Created by using the AWS SDK for Kotlin" - } - - RdsClient { region = "us-west-2" }.use { rdsClient -> - val response = rdsClient.createDbParameterGroup(groupRequest) - println("The group name is ${response.dbParameterGroup?.dbParameterGroupName}") - } -} - -// Returns a list of the available DB engines. -suspend fun describeDBEngines() { - val engineVersionsRequest = DescribeDbEngineVersionsRequest { - defaultOnly = true - engine = "mysql" - maxRecords = 20 - } - - RdsClient { region = "us-west-2" }.use { rdsClient -> - val response = rdsClient.describeDbEngineVersions(engineVersionsRequest) - val engines: List? = response.dbEngineVersions - - // Get all DbEngineVersion objects. - if (engines != null) { - for (engineOb in engines) { - println("The name of the DB parameter group family for the database engine is ${engineOb.dbParameterGroupFamily}.") - println("The name of the database engine ${engineOb.engine}.") - println("The version number of the database engine ${engineOb.engineVersion}") - } - } - } -} -``` -+ For API details, see the following topics in *AWS SDK for Kotlin API reference*\. - + [CreateDBInstance](https://github.com/awslabs/aws-sdk-kotlin#generating-api-documentation) - + [CreateDBParameterGroup](https://github.com/awslabs/aws-sdk-kotlin#generating-api-documentation) - + [CreateDBSnapshot](https://github.com/awslabs/aws-sdk-kotlin#generating-api-documentation) - + [DeleteDBInstance](https://github.com/awslabs/aws-sdk-kotlin#generating-api-documentation) - + [DeleteDBParameterGroup](https://github.com/awslabs/aws-sdk-kotlin#generating-api-documentation) - + [DescribeDBEngineVersions](https://github.com/awslabs/aws-sdk-kotlin#generating-api-documentation) - + [DescribeDBInstances](https://github.com/awslabs/aws-sdk-kotlin#generating-api-documentation) - + [DescribeDBParameterGroups](https://github.com/awslabs/aws-sdk-kotlin#generating-api-documentation) - + [DescribeDBParameters](https://github.com/awslabs/aws-sdk-kotlin#generating-api-documentation) - + [DescribeDBSnapshots](https://github.com/awslabs/aws-sdk-kotlin#generating-api-documentation) - + [DescribeOrderableDBInstanceOptions](https://github.com/awslabs/aws-sdk-kotlin#generating-api-documentation) - + [ModifyDBParameterGroup](https://github.com/awslabs/aws-sdk-kotlin#generating-api-documentation) - ------- -#### [ Python ] - -**SDK for Python \(Boto3\)** - There's more on GitHub\. Find the complete example and learn how to set up and run in the [AWS Code Examples Repository](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/python/example_code/rds#code-examples)\. -Run an interactive scenario at a command prompt\. - -``` -class RdsInstanceScenario: - """Runs a scenario that shows how to get started using Amazon RDS DB instances.""" - def __init__(self, instance_wrapper): - """ - :param instance_wrapper: An object that wraps Amazon RDS DB instance actions. - """ - self.instance_wrapper = instance_wrapper - - def create_parameter_group(self, parameter_group_name, db_engine): - """ - Shows how to get available engine versions for a specified database engine and - create a DB parameter group that is compatible with a selected engine family. - - :param parameter_group_name: The name given to the newly created parameter group. - :param db_engine: The database engine to use as a basis. - :return: The newly created parameter group. - """ - print(f"Checking for an existing DB instance parameter group named {parameter_group_name}.") - parameter_group = self.instance_wrapper.get_parameter_group(parameter_group_name) - if parameter_group is None: - print(f"Getting available database engine versions for {db_engine}.") - engine_versions = self.instance_wrapper.get_engine_versions(db_engine) - families = list({ver['DBParameterGroupFamily'] for ver in engine_versions}) - family_index = q.choose("Which family do you want to use? ", families) - print(f"Creating a parameter group.") - self.instance_wrapper.create_parameter_group( - parameter_group_name, families[family_index], 'Example parameter group.') - parameter_group = self.instance_wrapper.get_parameter_group(parameter_group_name) - print(f"Parameter group {parameter_group['DBParameterGroupName']}:") - pp(parameter_group) - print('-'*88) - return parameter_group - - def update_parameters(self, parameter_group_name): - """ - Shows how to get the parameters contained in a custom parameter group and - update some of the parameter values in the group. - - :param parameter_group_name: The name of the parameter group to query and modify. - """ - print("Let's set some parameter values in your parameter group.") - auto_inc_parameters = self.instance_wrapper.get_parameters( - parameter_group_name, name_prefix='auto_increment') - update_params = [] - for auto_inc in auto_inc_parameters: - if auto_inc['IsModifiable'] and auto_inc['DataType'] == 'integer': - print(f"The {auto_inc['ParameterName']} parameter is described as:") - print(f"\t{auto_inc['Description']}") - param_range = auto_inc['AllowedValues'].split('-') - auto_inc['ParameterValue'] = str(q.ask( - f"Enter a value between {param_range[0]} and {param_range[1]}: ", - q.is_int, q.in_range(int(param_range[0]), int(param_range[1])))) - update_params.append(auto_inc) - self.instance_wrapper.update_parameters(parameter_group_name, update_params) - print("You can get a list of parameters you've set by specifying a source of 'user'.") - user_parameters = self.instance_wrapper.get_parameters(parameter_group_name, source='user') - pp(user_parameters) - print('-'*88) - - def create_instance(self, instance_name, db_name, db_engine, parameter_group): - """ - Shows how to create a DB instance that contains a database of a specified - type and is configured to use a custom DB parameter group. - - :param instance_name: The name given to the newly created DB instance. - :param db_name: The name given to the created database. - :param db_engine: The engine of the created database. - :param parameter_group: The parameter group that is associated with the DB instance. - :return: The newly created DB instance. - """ - print("Checking for an existing DB instance.") - db_inst = self.instance_wrapper.get_db_instance(instance_name) - if db_inst is None: - print("Let's create a DB instance.") - admin_username = q.ask("Enter an administrator user name for the database: ", q.non_empty) - admin_password = q.ask( - "Enter a password for the administrator (at least 8 characters): ", q.non_empty) - engine_versions = self.instance_wrapper.get_engine_versions( - db_engine, parameter_group['DBParameterGroupFamily']) - engine_choices = [ver['EngineVersion'] for ver in engine_versions] - print("The available engines for your parameter group are:") - engine_index = q.choose("Which engine do you want to use? ", engine_choices) - engine_selection = engine_versions[engine_index] - print("The available micro DB instance classes for your database engine are:") - inst_opts = self.instance_wrapper.get_orderable_instances( - engine_selection['Engine'], engine_selection['EngineVersion']) - inst_choices = list({opt['DBInstanceClass'] for opt in inst_opts if 'micro' in opt['DBInstanceClass']}) - inst_index = q.choose("Which micro DB instance class do you want to use? ", inst_choices) - group_name = parameter_group['DBParameterGroupName'] - storage_type = 'standard' - allocated_storage = 5 - print(f"Creating a DB instance named {instance_name} and database {db_name}.\n" - f"The DB instance is configured to use your custom parameter group {group_name},\n" - f"selected engine {engine_selection['EngineVersion']},\n" - f"selected DB instance class {inst_choices[inst_index]}," - f"and {allocated_storage} GiB of {storage_type} storage.\n" - f"This typically takes several minutes.") - db_inst = self.instance_wrapper.create_db_instance( - db_name, instance_name, group_name, engine_selection['Engine'], - engine_selection['EngineVersion'], inst_choices[inst_index], storage_type, - allocated_storage, admin_username, admin_password) - while db_inst.get('DBInstanceStatus') != 'available': - wait(10) - db_inst = self.instance_wrapper.get_db_instance(instance_name) - print("Instance data:") - pp(db_inst) - print('-'*88) - return db_inst - - @staticmethod - def display_connection(db_inst): - """ - Displays connection information about a DB instance and tips on how to - connect to it. - - :param db_inst: The DB instance to display. - """ - print("You can now connect to your database using your favorite MySql client.\n" - "One way to connect is by using the 'mysql' shell on an Amazon EC2 instance\n" - "that is running in the same VPC as your DB instance. Pass the endpoint,\n" - "port, and administrator user name to 'mysql' and enter your password\n" - "when prompted:\n") - print(f"\n\tmysql -h {db_inst['Endpoint']['Address']} -P {db_inst['Endpoint']['Port']} " - f"-u {db_inst['MasterUsername']} -p\n") - print("For more information, see the User Guide for Amazon RDS:\n" - "\thttps://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_GettingStarted.CreatingConnecting.MySQL.html#CHAP_GettingStarted.Connecting.MySQL") - print('-'*88) - - def create_snapshot(self, instance_name): - """ - Shows how to create a DB instance snapshot and wait until it's available. - - :param instance_name: The name of a DB instance to snapshot. - """ - if q.ask("Do you want to create a snapshot of your DB instance (y/n)? ", q.is_yesno): - snapshot_id = f"{instance_name}-{uuid.uuid4()}" - print(f"Creating a snapshot named {snapshot_id}. This typically takes a few minutes.") - snapshot = self.instance_wrapper.create_snapshot(snapshot_id, instance_name) - while snapshot.get('Status') != 'available': - wait(10) - snapshot = self.instance_wrapper.get_snapshot(snapshot_id) - pp(snapshot) - print('-'*88) - - def cleanup(self, db_inst, parameter_group_name): - """ - Shows how to clean up a DB instance and parameter group. - Before the parameter group can be deleted, all associated DB instances must first - be deleted. - - :param db_inst: The DB instance to delete. - :param parameter_group_name: The DB parameter group to delete. - """ - if q.ask( - "\nDo you want to delete the DB instance and parameter group (y/n)? ", - q.is_yesno): - print(f"Deleting DB instance {db_inst['DBInstanceIdentifier']}.") - self.instance_wrapper.delete_db_instance(db_inst['DBInstanceIdentifier']) - print("Waiting for the DB instance to delete. This typically takes several minutes.") - while db_inst is not None: - wait(10) - db_inst = self.instance_wrapper.get_db_instance(db_inst['DBInstanceIdentifier']) - print(f"Deleting parameter group {parameter_group_name}.") - self.instance_wrapper.delete_parameter_group(parameter_group_name) - - def run_scenario( - self, db_engine, parameter_group_name, instance_name, db_name): - logging.basicConfig(level=logging.INFO, format='%(levelname)s: %(message)s') - - print('-'*88) - print("Welcome to the Amazon Relational Database Service (Amazon RDS)\n" - "get started with DB instances demo.") - print('-'*88) - - parameter_group = self.create_parameter_group(parameter_group_name, db_engine) - self.update_parameters(parameter_group_name) - db_inst = self.create_instance(instance_name, db_name, db_engine, parameter_group) - self.display_connection(db_inst) - self.create_snapshot(instance_name) - self.cleanup(db_inst, parameter_group_name) - - print("\nThanks for watching!") - print('-'*88) - - -if __name__ == '__main__': - try: - scenario = RdsInstanceScenario(InstanceWrapper.from_client()) - scenario.run_scenario( - 'mysql', 'doc-example-parameter-group', 'doc-example-instance', 'docexampledb') - except Exception: - logging.exception("Something went wrong with the demo.") -``` -Define functions that are called by the scenario to manage Amazon RDS actions\. - -``` -class InstanceWrapper: - """Encapsulates Amazon RDS DB instance actions.""" - def __init__(self, rds_client): - """ - :param rds_client: A Boto3 Amazon RDS client. - """ - self.rds_client = rds_client - - @classmethod - def from_client(cls): - """ - Instantiates this class from a Boto3 client. - """ - rds_client = boto3.client('rds') - return cls(rds_client) - - def get_parameter_group(self, parameter_group_name): - """ - Gets a DB parameter group. - - :param parameter_group_name: The name of the parameter group to retrieve. - :return: The parameter group. - """ - try: - response = self.rds_client.describe_db_parameter_groups( - DBParameterGroupName=parameter_group_name) - parameter_group = response['DBParameterGroups'][0] - except ClientError as err: - if err.response['Error']['Code'] == 'DBParameterGroupNotFound': - logger.info("Parameter group %s does not exist.", parameter_group_name) - else: - logger.error( - "Couldn't get parameter group %s. Here's why: %s: %s", parameter_group_name, - err.response['Error']['Code'], err.response['Error']['Message']) - raise - else: - return parameter_group - - def create_parameter_group(self, parameter_group_name, parameter_group_family, description): - """ - Creates a DB parameter group that is based on the specified parameter group - family. - - :param parameter_group_name: The name of the newly created parameter group. - :param parameter_group_family: The family that is used as the basis of the new - parameter group. - :param description: A description given to the parameter group. - :return: Data about the newly created parameter group. - """ - try: - response = self.rds_client.create_db_parameter_group( - DBParameterGroupName=parameter_group_name, - DBParameterGroupFamily=parameter_group_family, - Description=description) - except ClientError as err: - logger.error( - "Couldn't create parameter group %s. Here's why: %s: %s", parameter_group_name, - err.response['Error']['Code'], err.response['Error']['Message']) - raise - else: - return response - - def delete_parameter_group(self, parameter_group_name): - """ - Deletes a DB parameter group. - - :param parameter_group_name: The name of the parameter group to delete. - :return: Data about the parameter group. - """ - try: - self.rds_client.delete_db_parameter_group( - DBParameterGroupName=parameter_group_name) - except ClientError as err: - logger.error( - "Couldn't delete parameter group %s. Here's why: %s: %s", parameter_group_name, - err.response['Error']['Code'], err.response['Error']['Message']) - raise - - def get_parameters(self, parameter_group_name, name_prefix='', source=None): - """ - Gets the parameters that are contained in a DB parameter group. - - :param parameter_group_name: The name of the parameter group to query. - :param name_prefix: When specified, the retrieved list of parameters is filtered - to contain only parameters that start with this prefix. - :param source: When specified, only parameters from this source are retrieved. - For example, a source of 'user' retrieves only parameters that - were set by a user. - :return: The list of requested parameters. - """ - try: - kwargs = {'DBParameterGroupName': parameter_group_name} - if source is not None: - kwargs['Source'] = source - parameters = [] - paginator = self.rds_client.get_paginator('describe_db_parameters') - for page in paginator.paginate(**kwargs): - parameters += [ - p for p in page['Parameters'] if p['ParameterName'].startswith(name_prefix)] - except ClientError as err: - logger.error( - "Couldn't get parameters for %s. Here's why: %s: %s", parameter_group_name, - err.response['Error']['Code'], err.response['Error']['Message']) - raise - else: - return parameters - - def update_parameters(self, parameter_group_name, update_parameters): - """ - Updates parameters in a custom DB parameter group. - - :param parameter_group_name: The name of the parameter group to update. - :param update_parameters: The parameters to update in the group. - :return: Data about the modified parameter group. - """ - try: - response = self.rds_client.modify_db_parameter_group( - DBParameterGroupName=parameter_group_name, Parameters=update_parameters) - except ClientError as err: - logger.error( - "Couldn't update parameters in %s. Here's why: %s: %s", parameter_group_name, - err.response['Error']['Code'], err.response['Error']['Message']) - raise - else: - return response - - def create_snapshot(self, snapshot_id, instance_id): - """ - Creates a snapshot of a DB instance. - - :param snapshot_id: The ID to give the created snapshot. - :param instance_id: The ID of the DB instance to snapshot. - :return: Data about the newly created snapshot. - """ - try: - response = self.rds_client.create_db_snapshot( - DBSnapshotIdentifier=snapshot_id, DBInstanceIdentifier=instance_id) - snapshot = response['DBSnapshot'] - except ClientError as err: - logger.error( - "Couldn't create snapshot of %s. Here's why: %s: %s", instance_id, - err.response['Error']['Code'], err.response['Error']['Message']) - raise - else: - return snapshot - - def get_snapshot(self, snapshot_id): - """ - Gets a DB instance snapshot. - - :param snapshot_id: The ID of the snapshot to retrieve. - :return: The retrieved snapshot. - """ - try: - response = self.rds_client.describe_db_snapshots( - DBSnapshotIdentifier=snapshot_id) - snapshot = response['DBSnapshots'][0] - except ClientError as err: - logger.error( - "Couldn't get snapshot %s. Here's why: %s: %s", snapshot_id, - err.response['Error']['Code'], err.response['Error']['Message']) - raise - else: - return snapshot - - def get_engine_versions(self, engine, parameter_group_family=None): - """ - Gets database engine versions that are available for the specified engine - and parameter group family. - - :param engine: The database engine to look up. - :param parameter_group_family: When specified, restricts the returned list of - engine versions to those that are compatible with - this parameter group family. - :return: The list of database engine versions. - """ - try: - kwargs = {'Engine': engine} - if parameter_group_family is not None: - kwargs['DBParameterGroupFamily'] = parameter_group_family - response = self.rds_client.describe_db_engine_versions(**kwargs) - versions = response['DBEngineVersions'] - except ClientError as err: - logger.error( - "Couldn't get engine versions for %s. Here's why: %s: %s", engine, - err.response['Error']['Code'], err.response['Error']['Message']) - raise - else: - return versions - - def get_orderable_instances(self, db_engine, db_engine_version): - """ - Gets DB instance options that can be used to create DB instances that are - compatible with a set of specifications. - - :param db_engine: The database engine that must be supported by the DB instance. - :param db_engine_version: The engine version that must be supported by the DB instance. - :return: The list of DB instance options that can be used to create a compatible DB instance. - """ - try: - inst_opts = [] - paginator = self.rds_client.get_paginator('describe_orderable_db_instance_options') - for page in paginator.paginate(Engine=db_engine, EngineVersion=db_engine_version): - inst_opts += page['OrderableDBInstanceOptions'] - except ClientError as err: - logger.error( - "Couldn't get orderable DB instances. Here's why: %s: %s", - err.response['Error']['Code'], err.response['Error']['Message']) - raise - else: - return inst_opts - - def get_db_instance(self, instance_id): - """ - Gets data about a DB instance. - - :param instance_id: The ID of the DB instance to retrieve. - :return: The retrieved DB instance. - """ - try: - response = self.rds_client.describe_db_instances( - DBInstanceIdentifier=instance_id) - db_inst = response['DBInstances'][0] - except ClientError as err: - if err.response['Error']['Code'] == 'DBInstanceNotFound': - logger.info("Instance %s does not exist.", instance_id) - else: - logger.error( - "Couldn't get DB instance %s. Here's why: %s: %s", instance_id, - err.response['Error']['Code'], err.response['Error']['Message']) - raise - else: - return db_inst - - def create_db_instance( - self, db_name, instance_id, parameter_group_name, db_engine, db_engine_version, - instance_class, storage_type, allocated_storage, admin_name, admin_password): - """ - Creates a DB instance. - - :param db_name: The name of the database that is created in the DB instance. - :param instance_id: The ID to give the newly created DB instance. - :param parameter_group_name: A parameter group to associate with the DB instance. - :param db_engine: The database engine of a database to create in the DB instance. - :param db_engine_version: The engine version for the created database. - :param instance_class: The DB instance class for the newly created DB instance. - :param storage_type: The storage type of the DB instance. - :param allocated_storage: The amount of storage allocated on the DB instance, in GiBs. - :param admin_name: The name of the admin user for the created database. - :param admin_password: The admin password for the created database. - :return: Data about the newly created DB instance. - """ - try: - response = self.rds_client.create_db_instance( - DBName=db_name, - DBInstanceIdentifier=instance_id, - DBParameterGroupName=parameter_group_name, - Engine=db_engine, - EngineVersion=db_engine_version, - DBInstanceClass=instance_class, - StorageType=storage_type, - AllocatedStorage=allocated_storage, - MasterUsername=admin_name, - MasterUserPassword=admin_password) - db_inst = response['DBInstance'] - except ClientError as err: - logger.error( - "Couldn't create DB instance %s. Here's why: %s: %s", instance_id, - err.response['Error']['Code'], err.response['Error']['Message']) - raise - else: - return db_inst - - def delete_db_instance(self, instance_id): - """ - Deletes a DB instance. - - :param instance_id: The ID of the DB instance to delete. - :return: Data about the deleted DB instance. - """ - try: - response = self.rds_client.delete_db_instance( - DBInstanceIdentifier=instance_id, SkipFinalSnapshot=True, - DeleteAutomatedBackups=True) - db_inst = response['DBInstance'] - except ClientError as err: - logger.error( - "Couldn't delete DB instance %s. Here's why: %s: %s", instance_id, - err.response['Error']['Code'], err.response['Error']['Message']) - raise - else: - return db_inst -``` -+ For API details, see the following topics in *AWS SDK for Python \(Boto3\) API Reference*\. - + [CreateDBInstance](https://docs.aws.amazon.com/goto/boto3/rds-2014-10-31/CreateDBInstance) - + [CreateDBParameterGroup](https://docs.aws.amazon.com/goto/boto3/rds-2014-10-31/CreateDBParameterGroup) - + [CreateDBSnapshot](https://docs.aws.amazon.com/goto/boto3/rds-2014-10-31/CreateDBSnapshot) - + [DeleteDBInstance](https://docs.aws.amazon.com/goto/boto3/rds-2014-10-31/DeleteDBInstance) - + [DeleteDBParameterGroup](https://docs.aws.amazon.com/goto/boto3/rds-2014-10-31/DeleteDBParameterGroup) - + [DescribeDBEngineVersions](https://docs.aws.amazon.com/goto/boto3/rds-2014-10-31/DescribeDBEngineVersions) - + [DescribeDBInstances](https://docs.aws.amazon.com/goto/boto3/rds-2014-10-31/DescribeDBInstances) - + [DescribeDBParameterGroups](https://docs.aws.amazon.com/goto/boto3/rds-2014-10-31/DescribeDBParameterGroups) - + [DescribeDBParameters](https://docs.aws.amazon.com/goto/boto3/rds-2014-10-31/DescribeDBParameters) - + [DescribeDBSnapshots](https://docs.aws.amazon.com/goto/boto3/rds-2014-10-31/DescribeDBSnapshots) - + [DescribeOrderableDBInstanceOptions](https://docs.aws.amazon.com/goto/boto3/rds-2014-10-31/DescribeOrderableDBInstanceOptions) - + [ModifyDBParameterGroup](https://docs.aws.amazon.com/goto/boto3/rds-2014-10-31/ModifyDBParameterGroup) - ------- - -For a complete list of AWS SDK developer guides and code examples, see [Using this service with an AWS SDK](CHAP_Tutorials.md#sdk-general-information-section)\. This topic also includes information about getting started and details about previous SDK versions\. \ No newline at end of file diff --git a/doc_source/glossary.md b/doc_source/glossary.md deleted file mode 100644 index 0fccc48..0000000 --- a/doc_source/glossary.md +++ /dev/null @@ -1,3 +0,0 @@ -# AWS glossary - -For the latest AWS terminology, see the [AWS glossary](https://docs.aws.amazon.com/general/latest/gr/glos-chap.html) in the *AWS General Reference*\. \ No newline at end of file diff --git a/doc_source/index.md b/doc_source/index.md deleted file mode 100644 index 850055f..0000000 --- a/doc_source/index.md +++ /dev/null @@ -1,609 +0,0 @@ -# Amazon Relational Database Service User Guide - ------ -*****Copyright © Amazon Web Services, Inc. and/or its affiliates. All rights reserved.***** - ------ -Amazon's trademarks and trade dress may not be used in -connection with any product or service that is not Amazon's, -in any manner that is likely to cause confusion among customers, -or in any manner that disparages or discredits Amazon. All other -trademarks not owned by Amazon are the property of their respective -owners, who may or may not be affiliated with, connected to, or -sponsored by Amazon. - ------ -## Contents -+ [What is Amazon Relational Database Service (Amazon RDS)?](Welcome.md) - + [Amazon RDS DB instances](Overview.DBInstance.md) - + [DB instance classes](Concepts.DBInstanceClass.md) - + [Amazon RDS DB instance storage](CHAP_Storage.md) - + [Regions, Availability Zones, and Local Zones](Concepts.RegionsAndAvailabilityZones.md) - + [Supported features in Amazon RDS by AWS Region and DB engine](Concepts.RDSFeaturesRegionsDBEngines.grids.md) - + [Blue/Green Deployments](Concepts.RDS_Fea_Regions_DB-eng.Feature.BlueGreenDeployments.md) - + [Cross-Region automated backups](Concepts.RDS_Fea_Regions_DB-eng.Feature.CrossRegionAutomatedBackups.md) - + [Cross-Region read replicas](Concepts.RDS_Fea_Regions_DB-eng.Feature.CrossRegionReadReplicas.md) - + [Database activity streams](Concepts.RDS_Fea_Regions_DB-eng.Feature.DBActivityStreams.md) - + [Dual-stack mode](Concepts.RDS_Fea_Regions_DB-eng.Feature.DualStackMode.md) - + [Export snapshots to S3](Concepts.RDS_Fea_Regions_DB-eng.Feature.ExportSnapshotToS3.md) - + [IAM database authentication](Concepts.RDS_Fea_Regions_DB-eng.Feature.IamDatabaseAuthentication.md) - + [Kerberos authentication](Concepts.RDS_Fea_Regions_DB-eng.Feature.KerberosAuthentication.md) - + [Multi-AZ DB clusters](Concepts.RDS_Fea_Regions_DB-eng.Feature.MultiAZDBClusters.md) - + [Performance Insights](Concepts.RDS_Fea_Regions_DB-eng.Feature.PerformanceInsights.md) - + [RDS Custom](Concepts.RDS_Fea_Regions_DB-eng.Feature.RDSCustom.md) - + [Amazon RDS Proxy](Concepts.RDS_Fea_Regions_DB-eng.Feature.RDSProxy.md) - + [Secrets Manager integration](Concepts.RDS_Fea_Regions_DB-eng.Feature.SecretsManager.md) - + [Engine-native features](Concepts.RDS_Fea_Regions_DB-eng.Feature.EngineNativeFeatures.md) - + [DB instance billing for Amazon RDS](User_DBInstanceBilling.md) - + [On-Demand DB instances for Amazon RDS](USER_OnDemandDBInstances.md) - + [Reserved DB instances for Amazon RDS](USER_WorkingWithReservedDBInstances.md) -+ [Setting up for Amazon RDS](CHAP_SettingUp.md) -+ [Getting started with Amazon RDS](CHAP_GettingStarted.md) - + [Creating and connecting to a MariaDB DB instance](CHAP_GettingStarted.CreatingConnecting.MariaDB.md) - + [Creating and connecting to a Microsoft SQL Server DB instance](CHAP_GettingStarted.CreatingConnecting.SQLServer.md) - + [Creating and connecting to a MySQL DB instance](CHAP_GettingStarted.CreatingConnecting.MySQL.md) - + [Creating and connecting to an Oracle DB instance](CHAP_GettingStarted.CreatingConnecting.Oracle.md) - + [Creating and connecting to a PostgreSQL DB instance](CHAP_GettingStarted.CreatingConnecting.PostgreSQL.md) - + [Tutorial: Create a web server and an Amazon RDS DB instance](TUT_WebAppWithRDS.md) - + [Launch an EC2 instance](CHAP_Tutorials.WebServerDB.LaunchEC2.md) - + [Create a DB instance](CHAP_Tutorials.WebServerDB.CreateDBInstance.md) - + [Install a web server on your EC2 instance](CHAP_Tutorials.WebServerDB.CreateWebServer.md) -+ [Amazon RDS tutorials and sample code](CHAP_Tutorials.md) -+ [Best practices for Amazon RDS](CHAP_BestPractices.md) -+ [Configuring an Amazon RDS DB instance](CHAP_RDS_Configuring.md) - + [Creating an Amazon RDS DB instance](USER_CreateDBInstance.md) - + [Creating Amazon RDS resources with AWS CloudFormation](creating-resources-with-cloudformation.md) - + [Connecting to an Amazon RDS DB instance](CHAP_CommonTasks.Connect.md) - + [Working with option groups](USER_WorkingWithOptionGroups.md) - + [Working with parameter groups](USER_WorkingWithParamGroups.md) - + [Overview of parameter groups](parameter-groups-overview.md) - + [Working with DB parameter groups](USER_WorkingWithDBInstanceParamGroups.md) - + [Working with DB cluster parameter groups for Multi-AZ DB clusters](USER_WorkingWithDBClusterParamGroups.md) - + [Comparing parameter groups](USER_WorkingWithParamGroups.Comparing.md) - + [Specifying DB parameters](USER_ParamValuesRef.md) - + [Creating an Amazon ElastiCache cluster using Amazon RDS DB instance settings](creating-elasticache-cluster-with-RDS-settings.md) -+ [Managing an Amazon RDS DB instance](CHAP_RDS_Managing.md) - + [Stopping an Amazon RDS DB instance temporarily](USER_StopInstance.md) - + [Starting an Amazon RDS DB instance that was previously stopped](USER_StartInstance.md) - + [Connecting an EC2 instance and a DB instance automatically](ec2-rds-connect.md) - + [Modifying an Amazon RDS DB instance](Overview.DBInstance.Modifying.md) - + [Maintaining a DB instance](USER_UpgradeDBInstance.Maintenance.md) - + [Upgrading a DB instance engine version](USER_UpgradeDBInstance.Upgrading.md) - + [Renaming a DB instance](USER_RenameInstance.md) - + [Rebooting a DB instance](USER_RebootInstance.md) - + [Working with DB instance read replicas](USER_ReadRepl.md) - + [Tagging Amazon RDS resources](USER_Tagging.md) - + [Working with Amazon Resource Names (ARNs) in Amazon RDS](USER_Tagging.ARN.md) - + [Working with storage for Amazon RDS DB instances](USER_PIOPS.StorageTypes.md) - + [Deleting a DB instance](USER_DeleteInstance.md) -+ [Configuring and managing a Multi-AZ deployment](Concepts.MultiAZ.md) - + [Multi-AZ DB instance deployments](Concepts.MultiAZSingleStandby.md) - + [Multi-AZ DB cluster deployments](multi-az-db-clusters-concepts.md) - + [Creating a Multi-AZ DB cluster](create-multi-az-db-cluster.md) - + [Connecting to a Multi-AZ DB cluster](multi-az-db-clusters-concepts-connection-management.md) - + [Connecting an EC2 instance and a Multi-AZ DB cluster automatically](multiaz-ec2-rds-connect.md) - + [Modifying a Multi-AZ DB cluster](modify-multi-az-db-cluster.md) - + [Renaming a Multi-AZ DB cluster](multi-az-db-cluster-rename.md) - + [Rebooting a Multi-AZ DB cluster and reader DB instances](multi-az-db-clusters-concepts-rebooting.md) - + [Working with Multi-AZ DB cluster read replicas](USER_MultiAZDBCluster_ReadRepl.md) - + [Deleting a Multi-AZ DB cluster](USER_DeleteMultiAZDBCluster.Deleting.md) -+ [Using Amazon RDS Blue/Green Deployments for database updates](blue-green-deployments.md) - + [Overview of Amazon RDS Blue/Green Deployments](blue-green-deployments-overview.md) - + [Creating a blue/green deployment](blue-green-deployments-creating.md) - + [Viewing a blue/green deployment](blue-green-deployments-viewing.md) - + [Switching a blue/green deployment](blue-green-deployments-switching.md) - + [Deleting a blue/green deployment](blue-green-deployments-deleting.md) -+ [Backing up and restoring](CHAP_CommonTasks.BackupRestore.md) - + [Working with backups](USER_WorkingWithAutomatedBackups.md) - + [Backing up and restoring a DB instance](CHAP_BackupRestore_Instance.md) - + [Replicating automated backups to another AWS Region](USER_ReplicateBackups.md) - + [Creating a DB snapshot](USER_CreateSnapshot.md) - + [Restoring from a DB snapshot](USER_RestoreFromSnapshot.md) - + [Copying a DB snapshot](USER_CopySnapshot.md) - + [Sharing a DB snapshot](USER_ShareSnapshot.md) - + [Exporting DB snapshot data to Amazon S3](USER_ExportSnapshot.md) - + [Restoring a DB instance to a specified time](USER_PIT.md) - + [Deleting a DB snapshot](USER_DeleteSnapshot.md) - + [Tutorial: Restore an Amazon RDS DB instance from a DB snapshot](CHAP_Tutorials.RestoringFromSnapshot.md) - + [Backing up and restoring a Multi-AZ DB cluster](CHAP_BackupRestore_MAZ.md) - + [Creating a Multi-AZ DB cluster snapshot](USER_CreateMultiAZDBClusterSnapshot.md) - + [Restoring from a snapshot to a Multi-AZ DB cluster](USER_RestoreFromMultiAZDBClusterSnapshot.Restoring.md) - + [Restoring from a Multi-AZ DB cluster snapshot to a DB instance](USER_RestoreFromMultiAZDBClusterSnapshot.md) - + [Restoring a Multi-AZ DB cluster to a specified time](USER_PIT.MultiAZDBCluster.md) -+ [Monitoring metrics in an Amazon RDS instance](CHAP_Monitoring.md) - + [Overview of monitoring metrics in Amazon RDS](MonitoringOverview.md) - + [Viewing instance status and recommendations](accessing-monitoring.md) - + [Viewing metrics in the Amazon RDS console](USER_Monitoring.md) - + [Viewing combined metrics in the Amazon RDS console](Viewing_Unifiedmetrics.md) - + [Monitoring Amazon RDS metrics with Amazon CloudWatch](monitoring-cloudwatch.md) - + [Overview of Amazon RDS and Amazon CloudWatch](cw-metrics-overview.md) - + [Viewing DB instance metrics in the CloudWatch console and AWS CLI](metrics_dimensions.md) - + [Creating CloudWatch alarms to monitor Amazon RDS](creating_alarms.md) - + [Tutorial: Creating an Amazon CloudWatch alarm for Multi-AZ DB cluster replica lag](multi-az-db-cluster-cloudwatch-alarm.md) - + [Monitoring DB load with Performance Insights on Amazon RDS](USER_PerfInsights.md) - + [Overview of Performance Insights on Amazon RDS](USER_PerfInsights.Overview.md) - + [Database load](USER_PerfInsights.Overview.ActiveSessions.md) - + [Maximum CPU](USER_PerfInsights.Overview.MaxCPU.md) - + [Amazon RDS DB engine, Region, and instance class support for Performance Insights](USER_PerfInsights.Overview.Engines.md) - + [Pricing and data retention for Performance Insights](USER_PerfInsights.Overview.cost.md) - + [Turning Performance Insights on and off](USER_PerfInsights.Enabling.md) - + [Turning on the Performance Schema for Performance Insights on Amazon RDS for MariaDB or MySQL](USER_PerfInsights.EnableMySQL.md) - + [Configuring access policies for Performance Insights](USER_PerfInsights.access-control.md) - + [Analyzing metrics with the Performance Insights dashboard](USER_PerfInsights.UsingDashboard.md) - + [Overview of the Performance Insights dashboard](USER_PerfInsights.UsingDashboard.Components.md) - + [Accessing the Performance Insights dashboard](USER_PerfInsights.UsingDashboard.Opening.md) - + [Analyzing DB load by wait events](USER_PerfInsights.UsingDashboard.AnalyzeDBLoad.md) - + [Analyzing queries in the Performance Insights dashboard](USER_PerfInsights.UsingDashboard.AnalyzeDBLoad.AdditionalMetrics.md) - + [Overview of the Top SQL tab](USER_PerfInsights.UsingDashboard.Components.AvgActiveSessions.TopLoadItemsTable.TopSQL.md) - + [Accessing more SQL text in the Performance Insights dashboard](USER_PerfInsights.UsingDashboard.SQLTextSize.md) - + [Viewing SQL statistics in the Performance Insights dashboard](USER_PerfInsights.UsingDashboard.AnalyzeDBLoad.AdditionalMetrics.AnalyzingSQLLevel.md) - + [Analyzing Oracle execution plans using the Performance Insights dashboard](USER_PerfInsights.UsingDashboard.AccessPlans.md) - + [Retrieving metrics with the Performance Insights API](USER_PerfInsights.API.md) - + [Logging Performance Insights calls using AWS CloudTrail](USER_PerfInsights.CloudTrail.md) - + [Analyzing performance anomalies with Amazon DevOps Guru for Amazon RDS](devops-guru-for-rds.md) - + [Monitoring OS metrics with Enhanced Monitoring](USER_Monitoring.OS.md) - + [Overview of Enhanced Monitoring](USER_Monitoring.OS.overview.md) - + [Setting up and enabling Enhanced Monitoring](USER_Monitoring.OS.Enabling.md) - + [Viewing OS metrics in the RDS console](USER_Monitoring.OS.Viewing.md) - + [Viewing OS metrics using CloudWatch Logs](USER_Monitoring.OS.CloudWatchLogs.md) - + [Metrics reference for Amazon RDS](metrics-reference.md) - + [Amazon CloudWatch metrics for Amazon RDS](rds-metrics.md) - + [Amazon CloudWatch dimensions for Amazon RDS](dimensions.md) - + [Amazon CloudWatch metrics for Performance Insights](USER_PerfInsights.Cloudwatch.md) - + [Performance Insights counter metrics](USER_PerfInsights_Counters.md) - + [SQL statistics for Performance Insights](sql-statistics.md) - + [SQL statistics for MariaDB and MySQL](USER_PerfInsights.UsingDashboard.AnalyzeDBLoad.AdditionalMetrics.MySQL.md) - + [SQL statistics for Oracle](USER_PerfInsights.UsingDashboard.AnalyzeDBLoad.AdditionalMetrics.Oracle.md) - + [SQL statistics for RDS PostgreSQL](USER_PerfInsights.UsingDashboard.AnalyzeDBLoad.AdditionalMetrics.PostgreSQL.md) - + [OS metrics in Enhanced Monitoring](USER_Monitoring-Available-OS-Metrics.md) -+ [Monitoring events, logs, and streams in an Amazon RDS DB instance](CHAP_Monitor_Logs_Events.md) - + [Viewing logs, events, and streams in the Amazon RDS console](logs-events-streams-console.md) - + [Monitoring Amazon RDS events](working-with-events.md) - + [Overview of events for Amazon RDS](rds-cloudwatch-events.sample.md) - + [Viewing Amazon RDS events](USER_ListEvents.md) - + [Working with Amazon RDS event notification](USER_Events.md) - + [Overview of Amazon RDS event notification](USER_Events.overview.md) - + [Granting permissions to publish notifications to an Amazon SNS topic](USER_Events.GrantingPermissions.md) - + [Subscribing to Amazon RDS event notification](USER_Events.Subscribing.md) - + [Amazon RDS event notification tags and attributes](USER_Events.TagsAttributesForFiltering.md) - + [Listing Amazon RDS event notification subscriptions](USER_Events.ListSubscription.md) - + [Modifying an Amazon RDS event notification subscription](USER_Events.Modifying.md) - + [Adding a source identifier to an Amazon RDS event notification subscription](USER_Events.AddingSource.md) - + [Removing a source identifier from an Amazon RDS event notification subscription](USER_Events.RemovingSource.md) - + [Listing the Amazon RDS event notification categories](USER_Events.ListingCategories.md) - + [Deleting an Amazon RDS event notification subscription](USER_Events.Deleting.md) - + [Creating a rule that triggers on an Amazon RDS event](rds-cloud-watch-events.md) - + [Amazon RDS event categories and event messages](USER_Events.Messages.md) - + [Monitoring Amazon RDS log files](USER_LogAccess.md) - + [Viewing and listing database log files](USER_LogAccess.Procedural.Viewing.md) - + [Downloading a database log file](USER_LogAccess.Procedural.Downloading.md) - + [Watching a database log file](USER_LogAccess.Procedural.Watching.md) - + [Publishing database logs to Amazon CloudWatch Logs](USER_LogAccess.Procedural.UploadtoCloudWatch.md) - + [Reading log file contents using REST](DownloadCompleteDBLogFile.md) - + [MariaDB database log files](USER_LogAccess.Concepts.MariaDB.md) - + [Microsoft SQL Server database log files](USER_LogAccess.Concepts.SQLServer.md) - + [MySQL database log files](USER_LogAccess.Concepts.MySQL.md) - + [Overview of RDS for MySQL database logs](USER_LogAccess.MySQL.LogFileSize.md) - + [Publishing MySQL logs to Amazon CloudWatch Logs](USER_LogAccess.MySQLDB.PublishtoCloudWatchLogs.md) - + [Managing table-based MySQL logs](Appendix.MySQL.CommonDBATasks.Logs.md) - + [Configuring MySQL binary logging](USER_LogAccess.MySQL.BinaryFormat.md) - + [Accessing MySQL binary logs](USER_LogAccess.MySQL.Binarylog.md) - + [Oracle database log files](USER_LogAccess.Concepts.Oracle.md) - + [RDS for PostgreSQL database log files](USER_LogAccess.Concepts.PostgreSQL.md) - + [Monitoring Amazon RDS API calls in AWS CloudTrail](logging-using-cloudtrail.md) - + [Monitoring Amazon RDS with Database Activity Streams](DBActivityStreams.md) - + [Overview of Database Activity Streams](DBActivityStreams.Overview.md) - + [Configuring unified auditing for Oracle Database](DBActivityStreams.configuring-auditing.md) - + [Configuring auditing policy for Microsoft SQL Server](DBActivityStreams.configuring-auditing-SQLServer.md) - + [Starting a database activity stream](DBActivityStreams.Enabling.md) - + [Modifying a database activity stream](DBActivityStreams.Modifying.md) - + [Getting the status of a database activity stream](DBActivityStreams.Status.md) - + [Stopping a database activity stream](DBActivityStreams.Disabling.md) - + [Monitoring database activity streams](DBActivityStreams.Monitoring.md) - + [Managing access to database activity streams](DBActivityStreams.ManagingAccess.md) -+ [Working with Amazon RDS Custom](rds-custom.md) - + [Amazon RDS Custom architecture](custom-concept.md) - + [Security in Amazon RDS Custom](custom-security.md) - + [Working with RDS Custom for Oracle](working-with-custom-oracle.md) - + [RDS Custom for Oracle workflow](custom-concept.workflow.md) - + [RDS Custom for Oracle requirements and limitations](custom-reqs-limits.md) - + [Setting up your environment for Amazon RDS Custom for Oracle](custom-setup-orcl.md) - + [Working with custom engine versions for Amazon RDS Custom for Oracle](custom-cev.md) - + [Preparing to create a CEV](custom-cev.preparing.md) - + [Creating a CEV](custom-cev.create.md) - + [Modifying CEV status](custom-cev.modify.md) - + [Viewing CEV details](custom-cev.view.md) - + [Deleting a CEV](custom-cev.delete.md) - + [Configuring a DB instance for Amazon RDS Custom for Oracle](custom-creating.md) - + [Managing an Amazon RDS Custom for Oracle DB instance](custom-managing.md) - + [Working with Oracle replicas for RDS Custom for Oracle](custom-rr.md) - + [Backing up and restoring an Amazon RDS Custom for Oracle DB instance](custom-backup.md) - + [Migrating an on-premises database to RDS Custom for Oracle](custom-migrating-oracle.md) - + [Upgrading a DB instance for Amazon RDS Custom for Oracle](custom-upgrading.md) - + [Working with RDS Custom for SQL Server](working-with-custom-sqlserver.md) - + [RDS Custom for SQL Server workflow](custom-sqlserver.workflow.md) - + [Requirements and limitations for Amazon RDS Custom for SQL Server](custom-reqs-limits-MS.md) - + [Setting up your environment for Amazon RDS Custom for SQL Server](custom-setup-sqlserver.md) - + [Bring Your Own Media with RDS Custom for SQL Server](custom-sqlserver.byom.md) - + [Working with custom engine versions for RDS Custom for SQL Server](custom-cev-sqlserver.md) - + [Preparing to create a CEV for RDS Custom for SQL Server](custom-cev-sqlserver.preparing.md) - + [Creating a CEV for RDS Custom for SQL Server](custom-cev-sqlserver.create.md) - + [Modifying a CEV for RDS Custom for SQL Server](custom-cev-sqlserver-modifying.md) - + [Viewing CEV details for Amazon RDS Custom for SQL Server](custom-viewing-sqlserver.md) - + [Deleting a CEV for RDS Custom for SQL Server](custom-cev-sqlserver-deleting.md) - + [Creating and connecting to a DB instance for Amazon RDS Custom for SQL Server](custom-creating-sqlserver.md) - + [Managing an Amazon RDS Custom for SQL Server DB instance](custom-managing-sqlserver.md) - + [Managing a Multi-AZ deployment for RDS Custom for SQL Server](custom-sqlserver-multiaz.md) - + [Backing up and restoring an Amazon RDS Custom for SQL Server DB instance](custom-backup-sqlserver.md) - + [Migrating an on-premises database to Amazon RDS Custom for SQL Server](custom-migrating.md) - + [Upgrading a DB instance for Amazon RDS Custom for SQL Server](custom-upgrading-sqlserver.md) - + [Troubleshooting DB issues for Amazon RDS Custom](custom-troubleshooting.md) -+ [Working with Amazon RDS on AWS Outposts](rds-on-outposts.md) - + [Amazon RDS on AWS Outposts support for Amazon RDS features](rds-on-outposts.features.md) - + [Supported DB instance classes for Amazon RDS on AWS Outposts](rds-on-outposts.db-instance-classes.md) - + [Customer-owned IP addresses for Amazon RDS on AWS Outposts](rds-on-outposts.coip.md) - + [Working with Multi-AZ deployments for Amazon RDS on AWS Outposts](rds-on-outposts.maz.md) - + [Creating DB instances for Amazon RDS on AWS Outposts](rds-on-outposts.creating.md) - + [Creating read replicas for Amazon RDS on AWS Outposts](rds-on-outposts.rr.md) - + [Considerations for restoring DB instances on Amazon RDS on AWS Outposts](rds-on-outposts.restoring.md) -+ [Using Amazon RDS Proxy](rds-proxy.md) - + [Planning where to use RDS Proxy](rds-proxy-planning.md) - + [RDS Proxy concepts and terminology](rds-proxy.howitworks.md) - + [Getting started with RDS Proxy](rds-proxy-setup.md) - + [Managing an RDS Proxy](rds-proxy-managing.md) - + [Working with Amazon RDS Proxy endpoints](rds-proxy-endpoints.md) - + [Monitoring RDS Proxy metrics with Amazon CloudWatch](rds-proxy.monitoring.md) - + [Working with RDS Proxy events](rds-proxy.events.md) - + [RDS Proxy command-line examples](rds-proxy.examples.md) - + [Troubleshooting for RDS Proxy](rds-proxy.troubleshooting.md) - + [Using RDS Proxy with AWS CloudFormation](rds-proxy-cfn.md) -+ [Amazon RDS for MariaDB](CHAP_MariaDB.md) - + [MariaDB feature support on Amazon RDS](MariaDB.Concepts.FeatureSupport.md) - + [MariaDB on Amazon RDS versions](MariaDB.Concepts.VersionMgmt.md) - + [Connecting to a DB instance running the MariaDB database engine](USER_ConnectToMariaDBInstance.md) - + [Securing MariaDB DB instance connections](securing-mariadb-connections.md) - + [MariaDB security on Amazon RDS](MariaDB.Concepts.UsersAndPrivileges.md) - + [Encrypting client connections to MariaDB DB instances with SSL/TLS](mariadb-ssl-connections.md) - + [Using new SSL/TLS certificates for MariaDB DB instances](ssl-certificate-rotation-mariadb.md) - + [Improving query performance for RDS for MariaDB with Amazon RDS Optimized Reads](rds-optimized-reads-mariadb.md) - + [Improving write performance with Amazon RDS Optimized Writes for MariaDB](rds-optimized-writes-mariadb.md) - + [Upgrading the MariaDB DB engine](USER_UpgradeDBInstance.MariaDB.md) - + [Importing data into a MariaDB DB instance](MariaDB.Procedural.Importing.md) - + [Importing data from a MariaDB or MySQL database to a MariaDB or MySQL DB instance](MySQL.Procedural.Importing.SmallExistingMariaDB.md) - + [Importing data to an Amazon RDS MariaDB or MySQL DB instance with reduced downtime](MySQL.Procedural.Importing.NonRDSReplMariaDB.md) - + [Importing data from any source to a MariaDB or MySQL DB instance](MySQL.Procedural.Importing.AnySourceMariaDB.md) - + [Working with MariaDB replication in Amazon RDS](USER_MariaDB.Replication.md) - + [Working with MariaDB read replicas](USER_MariaDB.Replication.ReadReplicas.md) - + [Configuring GTID-based replication with an external source instance](MariaDB.Procedural.Replication.GTID.md) - + [Configuring binary log file position replication with an external source instance](MySQL.Procedural.Importing.External.ReplMariaDB.md) - + [Options for MariaDB database engine](Appendix.MariaDB.Options.md) - + [Parameters for MariaDB](Appendix.MariaDB.Parameters.md) - + [Migrating data from a MySQL DB snapshot to a MariaDB DB instance](USER_Migrate_MariaDB.md) - + [MariaDB on Amazon RDS SQL reference](Appendix.MariaDB.SQLRef.md) - + [mysql.rds_replica_status](mysql_rds_replica_status.md) - + [mysql.rds_set_external_master_gtid](mysql_rds_set_external_master_gtid.md) - + [mysql.rds_kill_query_id](mysql_rds_kill_query_id.md) - + [Local time zone for MariaDB DB instances](MariaDB.Concepts.LocalTimeZone.md) - + [RDS for MariaDB limitations](CHAP_MariaDB.Limitations.md) -+ [Amazon RDS for Microsoft SQL Server](CHAP_SQLServer.md) - + [Licensing Microsoft SQL Server on Amazon RDS](SQLServer.Concepts.General.Licensing.md) - + [Connecting to a DB instance running the Microsoft SQL Server database engine](USER_ConnectToMicrosoftSQLServerInstance.md) - + [Updating applications to connect to Microsoft SQL Server DB instances using new SSL/TLS certificates](ssl-certificate-rotation-sqlserver.md) - + [Upgrading the Microsoft SQL Server DB engine](USER_UpgradeDBInstance.SQLServer.md) - + [Importing and exporting SQL Server databases using native backup and restore](SQLServer.Procedural.Importing.md) - + [Importing and exporting SQL Server data using other methods](SQLServer.Procedural.Importing.Snapshots.md) - + [Working with read replicas for Microsoft SQL Server in Amazon RDS](SQLServer.ReadReplicas.md) - + [Multi-AZ deployments for Amazon RDS for Microsoft SQL Server](USER_SQLServerMultiAZ.md) - + [Additional features for Microsoft SQL Server on Amazon RDS](User.SQLServer.AdditionalFeatures.md) - + [Using SSL with a Microsoft SQL Server DB instance](SQLServer.Concepts.General.SSL.Using.md) - + [Configuring security protocols and ciphers](SQLServer.Ciphers.md) - + [Using Windows Authentication with an Amazon RDS for SQL Server DB instance](USER_SQLServerWinAuth.md) - + [Integrating an Amazon RDS for SQL Server DB instance with Amazon S3](User.SQLServer.Options.S3-integration.md) - + [Using Database Mail on Amazon RDS for SQL Server](SQLServer.DBMail.md) - + [Instance store support for the tempdb database on Amazon RDS for SQL Server](SQLServer.InstanceStore.md) - + [Using extended events with Amazon RDS for Microsoft SQL Server](SQLServer.ExtendedEvents.md) - + [Access to transaction log backups with RDS for SQL Server](USER.SQLServer.AddlFeat.TransactionLogAccess.md) - + [Options for the Microsoft SQL Server database engine](Appendix.SQLServer.Options.md) - + [Support for Linked Servers with Oracle OLEDB in Amazon RDS for SQL Server](Appendix.SQLServer.Options.LinkedServers_Oracle_OLEDB.md) - + [Support for native backup and restore in SQL Server](Appendix.SQLServer.Options.BackupRestore.md) - + [Support for Transparent Data Encryption in SQL Server](Appendix.SQLServer.Options.TDE.md) - + [SQL Server Audit](Appendix.SQLServer.Options.Audit.md) - + [Support for SQL Server Analysis Services in Amazon RDS for SQL Server](Appendix.SQLServer.Options.SSAS.md) - + [Support for SQL Server Integration Services in Amazon RDS for SQL Server](Appendix.SQLServer.Options.SSIS.md) - + [Support for SQL Server Reporting Services in Amazon RDS for SQL Server](Appendix.SQLServer.Options.SSRS.md) - + [Support for Microsoft Distributed Transaction Coordinator in RDS for SQL Server](Appendix.SQLServer.Options.MSDTC.md) - + [Common DBA tasks for Microsoft SQL Server](Appendix.SQLServer.CommonDBATasks.md) - + [Accessing the tempdb database on Microsoft SQL Server DB instances on Amazon RDS](SQLServer.TempDB.md) - + [Analyzing your database workload on an Amazon RDS for SQL Server DB instance with Database Engine Tuning Advisor](Appendix.SQLServer.CommonDBATasks.Workload.md) - + [Collations and character sets for Microsoft SQL Server](Appendix.SQLServer.CommonDBATasks.Collation.md) - + [Creating a database user](Appendix.SQLServer.CommonDBATasks.CreateUser.md) - + [Determining a recovery model for your Microsoft SQL Server database](Appendix.SQLServer.CommonDBATasks.DatabaseRecovery.md) - + [Determining the last failover time](Appendix.SQLServer.CommonDBATasks.LastFailover.md) - + [Disabling fast inserts during bulk loading](Appendix.SQLServer.CommonDBATasks.DisableFastInserts.md) - + [Dropping a Microsoft SQL Server database](Appendix.SQLServer.CommonDBATasks.DropMirrorDB.md) - + [Renaming a Microsoft SQL Server database in a Multi-AZ deployment](Appendix.SQLServer.CommonDBATasks.RenamingDB.md) - + [Resetting the db_owner role password](Appendix.SQLServer.CommonDBATasks.ResetPassword.md) - + [Restoring license-terminated DB instances](Appendix.SQLServer.CommonDBATasks.RestoreLTI.md) - + [Transitioning a Microsoft SQL Server database from OFFLINE to ONLINE](Appendix.SQLServer.CommonDBATasks.TransitionOnline.md) - + [Using change data capture](Appendix.SQLServer.CommonDBATasks.CDC.md) - + [Using SQL Server Agent](Appendix.SQLServer.CommonDBATasks.Agent.md) - + [Working with Microsoft SQL Server logs](Appendix.SQLServer.CommonDBATasks.Logs.md) - + [Working with trace and dump files](Appendix.SQLServer.CommonDBATasks.TraceFiles.md) -+ [Amazon RDS for MySQL](CHAP_MySQL.md) - + [MySQL feature support on Amazon RDS](MySQL.Concepts.FeatureSupport.md) - + [MySQL on Amazon RDS versions](MySQL.Concepts.VersionMgmt.md) - + [Connecting to a DB instance running the MySQL database engine](USER_ConnectToInstance.md) - + [Securing MySQL DB instance connections](securing-mysql-connections.md) - + [MySQL security on Amazon RDS](MysQL.Concepts.UsersAndPrivileges.md) - + [Using the Password Validation Plugin for RDS for MySQL](MySQL.Concepts.PasswordValidationPlugin.md) - + [Encrypting client connections to MySQL DB instances with SSL/TLS](mysql-ssl-connections.md) - + [Using new SSL/TLS certificates for MySQL DB instances](ssl-certificate-rotation-mysql.md) - + [Using Kerberos authentication for MySQL](mysql-kerberos.md) - + [Improving query performance for RDS for MySQL with Amazon RDS Optimized Reads](rds-optimized-reads.md) - + [Improving write performance with Amazon RDS Optimized Writes for MySQL](rds-optimized-writes.md) - + [Upgrading the MySQL DB engine](USER_UpgradeDBInstance.MySQL.md) - + [Importing data into a MySQL DB instance](MySQL.Procedural.Importing.Other.md) - + [Restoring a backup into a MySQL DB instance](MySQL.Procedural.Importing.md) - + [Importing data from a MariaDB or MySQL database to a MariaDB or MySQL DB instance](MySQL.Procedural.Importing.SmallExisting.md) - + [Importing data to an Amazon RDS MariaDB or MySQL database with reduced downtime](MySQL.Procedural.Importing.NonRDSRepl.md) - + [Importing data from any source to a MariaDB or MySQL DB instance](MySQL.Procedural.Importing.AnySource.md) - + [Working with MySQL replication in Amazon RDS](USER_MySQL.Replication.md) - + [Working with MySQL read replicas](USER_MySQL.Replication.ReadReplicas.md) - + [Using GTID-based replication for Amazon RDS for MySQL](mysql-replication-gtid.md) - + [Configuring GTID-based replication with an external source instance](MySQL.Procedural.Importing.External.Repl.GTIDProcedure.md) - + [Configuring binary log file position replication with an external source instance](MySQL.Procedural.Importing.External.Repl.md) - + [Exporting data from a MySQL DB instance by using replication](MySQL.Procedural.Exporting.NonRDSRepl.md) - + [Options for MySQL DB instances](Appendix.MySQL.Options.md) - + [MariaDB Audit Plugin support for MySQL](Appendix.MySQL.Options.AuditPlugin.md) - + [MySQL memcached support](Appendix.MySQL.Options.memcached.md) - + [Parameters for MySQL](Appendix.MySQL.Parameters.md) - + [Common DBA tasks for MySQL DB instances](Appendix.MySQL.CommonDBATasks.md) - + [Local time zone for MySQL DB instances](MySQL.Concepts.LocalTimeZone.md) - + [Known issues and limitations for Amazon RDS for MySQL](MySQL.KnownIssuesAndLimitations.md) - + [RDS for MySQL stored procedure reference](Appendix.MySQL.SQLRef.md) - + [Configuring](mysql-stored-proc-configuring.md) - + [Ending a session or query](mysql-stored-proc-ending.md) - + [Logging](mysql-stored-proc-logging.md) - + [Managing the Global Status History](mysql-stored-proc-gsh.md) - + [Replicating](mysql-stored-proc-replicating.md) - + [Warming the InnoDB cache](mysql-stored-proc-warming.md) -+ [Amazon RDS for Oracle](CHAP_Oracle.md) - + [Overview of Oracle on Amazon RDS](Oracle.Concepts.overview.md) - + [RDS for Oracle features](Oracle.Concepts.FeatureSupport.md) - + [RDS for Oracle releases](Oracle.Concepts.database-versions.md) - + [RDS for Oracle licensing options](Oracle.Concepts.Licensing.md) - + [RDS for Oracle instance classes](Oracle.Concepts.InstanceClasses.md) - + [RDS for Oracle database architecture](oracle-multi-architecture.md) - + [RDS for Oracle parameters](Oracle.Concepts.FeatureSupport.Parameters.md) - + [RDS for Oracle character sets](Appendix.OracleCharacterSets.md) - + [RDS for Oracle limitations](Oracle.Concepts.limitations.md) - + [Connecting to your RDS for Oracle DB instance](USER_ConnectToOracleInstance.md) - + [Finding the endpoint of your Oracle DB instance](USER_Endpoint.md) - + [Connecting to your DB instance using Oracle SQL developer](USER_ConnectToOracleInstance.SQLDeveloper.md) - + [Connecting to your DB instance using SQL*Plus](USER_ConnectToOracleInstance.SQLPlus.md) - + [Considerations for security groups](USER_ConnectToOracleInstance.Security.md) - + [Considerations for process architecture](USER_ConnectToOracleInstance.SharedServer.md) - + [Troubleshooting connections to your Oracle DB instance](USER_ConnectToOracleInstance.Troubleshooting.md) - + [Modifying connection properties using sqlnet.ora parameters](USER_ModifyInstance.Oracle.sqlnet.md) - + [Securing Oracle DB instance connections](Oracle.Concepts.RestrictedDBAPrivileges.md) - + [Using SSL with an RDS for Oracle DB instance](Oracle.Concepts.SSL.md) - + [Updating your applications to use new SSL/TLS certificates](ssl-certificate-rotation-oracle.md) - + [Using native network encryption with an RDS for Oracle DB instance](Oracle.Concepts.NNE.md) - + [Configuring Kerberos authentication for Amazon RDS for Oracle](oracle-kerberos.md) - + [Setting up Kerberos authentication for Oracle DB instances](oracle-kerberos-setting-up.md) - + [Managing a DB instance in a domain](oracle-kerberos-managing.md) - + [Connecting to Oracle with Kerberos authentication](oracle-kerberos-connecting.md) - + [Configuring UTL_HTTP access using certificates and an Oracle wallet](Oracle.Concepts.ONA.md) - + [Working with CDBs in RDS for Oracle](oracle-multitenant.md) - + [Administering your Oracle DB instance](Appendix.Oracle.CommonDBATasks.md) - + [Performing common system tasks for Oracle DB instances](Appendix.Oracle.CommonDBATasks.System.md) - + [Performing common database tasks for Oracle DB instances](Appendix.Oracle.CommonDBATasks.Database.md) - + [Performing common log-related tasks for Oracle DB instances](Appendix.Oracle.CommonDBATasks.Log.md) - + [Performing common RMAN tasks for Oracle DB instances](Appendix.Oracle.CommonDBATasks.RMAN.md) - + [Performing common scheduling tasks for Oracle DB instances](Appendix.Oracle.CommonDBATasks.Scheduler.md) - + [Performing common diagnostic tasks for Oracle DB instances](Appendix.Oracle.CommonDBATasks.Diagnostics.md) - + [Performing miscellaneous tasks for Oracle DB instances](Appendix.Oracle.CommonDBATasks.Misc.md) - + [Configuring advanced RDS for Oracle features](CHAP_Oracle.advanced-features.md) - + [Storing temporary data in an RDS for Oracle instance store](CHAP_Oracle.advanced-features.instance-store.md) - + [Turning on HugePages for an RDS for Oracle instance](Oracle.Concepts.HugePages.md) - + [Turning on extended data types in RDS for Oracle](Oracle.Concepts.ExtendedDataTypes.md) - + [Importing data into Oracle on Amazon RDS](Oracle.Procedural.Importing.md) - + [Importing using Oracle SQL Developer](Oracle.Procedural.Importing.SQLDeveloper.md) - + [Importing using Oracle Data Pump](Oracle.Procedural.Importing.DataPump.md) - + [Importing using Oracle Export/Import](Oracle.Procedural.Importing.ExportImport.md) - + [Importing using Oracle SQL*Loader](Oracle.Procedural.Importing.SQLLoader.md) - + [Migrating with Oracle materialized views](Oracle.Procedural.Importing.Materialized.md) - + [Working with read replicas for Amazon RDS for Oracle](oracle-read-replicas.md) - + [Overview of RDS for Oracle replicas](oracle-read-replicas.overview.md) - + [Requirements and considerations for RDS for Oracle replicas](oracle-read-replicas.limitations.md) - + [Preparing to create an Oracle replica](oracle-read-replicas.Configuration.md) - + [Creating an RDS for Oracle replica in mounted mode](oracle-read-replicas.creating-in-mounted-mode.md) - + [Modifying the RDS for Oracle replica mode](oracle-read-replicas.changing-replica-mode.md) - + [Working with RDS for Oracle replica backups](oracle-read-replicas.backups.md) - + [Performing an Oracle Data Guard switchover](oracle-replication-switchover.md) - + [Troubleshooting RDS for Oracle replicas](oracle-read-replicas.troubleshooting.md) - + [Adding options to Oracle DB instances](Appendix.Oracle.Options.md) - + [Overview of Oracle DB options](Appendix.Oracle.Options.overview.md) - + [Amazon S3 integration](oracle-s3-integration.md) - + [Oracle Application Express (APEX)](Appendix.Oracle.Options.APEX.md) - + [Amazon EFS integration](oracle-efs-integration.md) - + [Oracle Java virtual machine](oracle-options-java.md) - + [Oracle Enterprise Manager](Oracle.Options.OEM.md) - + [Oracle Enterprise Manager Database Express](Appendix.Oracle.Options.OEM_DBControl.md) - + [Oracle Management Agent for Enterprise Manager Cloud Control](Oracle.Options.OEMAgent.md) - + [Oracle Label Security](Oracle.Options.OLS.md) - + [Oracle Locator](Oracle.Options.Locator.md) - + [Oracle Multimedia](Oracle.Options.Multimedia.md) - + [Oracle native network encryption](Appendix.Oracle.Options.NetworkEncryption.md) - + [Oracle OLAP](Oracle.Options.OLAP.md) - + [Oracle Secure Sockets Layer](Appendix.Oracle.Options.SSL.md) - + [Oracle Spatial](Oracle.Options.Spatial.md) - + [Oracle SQLT](Oracle.Options.SQLT.md) - + [Oracle Statspack](Appendix.Oracle.Options.Statspack.md) - + [Oracle time zone](Appendix.Oracle.Options.Timezone.md) - + [Oracle time zone file autoupgrade](Appendix.Oracle.Options.Timezone-file-autoupgrade.md) - + [Oracle Transparent Data Encryption](Appendix.Oracle.Options.AdvSecurity.md) - + [Oracle UTL_MAIL](Oracle.Options.UTLMAIL.md) - + [Oracle XML DB](Appendix.Oracle.Options.XMLDB.md) - + [Upgrading the RDS for Oracle DB engine](USER_UpgradeDBInstance.Oracle.md) - + [Overview of RDS for Oracle engine upgrades](USER_UpgradeDBInstance.Oracle.Overview.md) - + [Oracle major version upgrades](USER_UpgradeDBInstance.Oracle.Major.md) - + [Oracle minor version upgrades](USER_UpgradeDBInstance.Oracle.Minor.md) - + [Considerations for Oracle DB upgrades](USER_UpgradeDBInstance.Oracle.OGPG.md) - + [Testing an Oracle DB upgrade](USER_UpgradeDBInstance.Oracle.UpgradeTesting.md) - + [Upgrading an Oracle DB instance](USER_UpgradeDBInstance.Oracle.Upgrading.md) - + [Upgrading an Oracle DB snapshot](USER_UpgradeDBSnapshot.Oracle.md) - + [Using third-party software with your RDS for Oracle DB instance](Oracle.Resources.md) - + [Setting up Amazon RDS to host tools and third-party software for Oracle](Oracle.Resources.Shared.md) - + [Using Oracle GoldenGate with Amazon RDS for Oracle](Appendix.OracleGoldenGate.md) - + [Using the Oracle Repository Creation Utility on RDS for Oracle](Oracle.Resources.RCU.md) - + [Configuring Oracle Connection Manager on an Amazon EC2 instance](oracle-cman.md) - + [Installing a Siebel database on Oracle on Amazon RDS](Oracle.Resources.Siebel.md) - + [Oracle Database engine release notes](USER_Oracle_Releases.md) -+ [Amazon RDS for PostgreSQL](CHAP_PostgreSQL.md) - + [Working with PostgreSQL features supported by Amazon RDS for PostgreSQL](PostgreSQL.Concepts.General.FeatureSupport.md) - + [Connecting to a DB instance running the PostgreSQL database engine](USER_ConnectToPostgreSQLInstance.md) - + [Securing connections to RDS for PostgreSQL with SSL/TLS](PostgreSQL.Concepts.General.Security.md) - + [Using SSL with a PostgreSQL DB instance](PostgreSQL.Concepts.General.SSL.md) - + [Updating applications to use new SSL/TLS certificates](ssl-certificate-rotation-postgresql.md) - + [Using Kerberos authentication with Amazon RDS for PostgreSQL](postgresql-kerberos.md) - + [Setting up Kerberos authentication for PostgreSQL DB instances](postgresql-kerberos-setting-up.md) - + [Managing a DB instance in a Domain](postgresql-kerberos-managing.md) - + [Connecting to PostgreSQL with Kerberos authentication](postgresql-kerberos-connecting.md) - + [Using a custom DNS server for outbound network access](Appendix.PostgreSQL.CommonDBATasks.CustomDNS.md) - + [Upgrading the PostgreSQL DB engine for Amazon RDS](USER_UpgradeDBInstance.PostgreSQL.md) - + [Upgrading a PostgreSQL DB snapshot engine version](USER_UpgradeDBSnapshot.PostgreSQL.md) - + [Working with read replicas for Amazon RDS for PostgreSQL](USER_PostgreSQL.Replication.ReadReplicas.md) - + [Improving query performance for RDS for PostgreSQL with Amazon RDS Optimized Reads](USER_PostgreSQL.optimizedreads.md) - + [Importing data into PostgreSQL on Amazon RDS](PostgreSQL.Procedural.Importing.md) - + [Importing a PostgreSQL database from an Amazon EC2 instance](PostgreSQL.Procedural.Importing.EC2.md) - + [Using the \copy command to import data to a table on a PostgreSQL DB instance](PostgreSQL.Procedural.Importing.Copy.md) - + [Importing data from Amazon S3 into an RDS for PostgreSQL DB instance](USER_PostgreSQL.S3Import.md) - + [Transporting PostgreSQL databases between DB instances](PostgreSQL.TransportableDB.md) - + [Exporting data from an RDS for PostgreSQL DB instance to Amazon S3](postgresql-s3-export.md) - + [Invoking an AWS Lambda function from an RDS for PostgreSQL DB instance](PostgreSQL-Lambda.md) - + [AWS Lambda function reference](PostgreSQL-Lambda-functions.md) - + [Common DBA tasks for Amazon RDS for PostgreSQL](Appendix.PostgreSQL.CommonDBATasks.md) - + [Collations supported in RDS for PostgreSQL](PostgreSQL-Collations.md) - + [Understanding PostgreSQL roles and permissions](Appendix.PostgreSQL.CommonDBATasks.Roles.md) - + [Working with the PostgreSQL autovacuum on Amazon RDS for PostgreSQL](Appendix.PostgreSQL.CommonDBATasks.Autovacuum.md) - + [Managing temporary files with PostgreSQL](PostgreSQL.ManagingTempFiles.md) - + [Working with parameters on your RDS for PostgreSQL DB instance](Appendix.PostgreSQL.CommonDBATasks.Parameters.md) - + [Tuning with wait events for RDS for PostgreSQL](PostgreSQL.Tuning.md) - + [Essential concepts for RDS for PostgreSQL tuning](PostgreSQL.Tuning.concepts.md) - + [RDS for PostgreSQL wait events](PostgreSQL.Tuning.concepts.summary.md) - + [Client:ClientRead](wait-event.clientread.md) - + [Client:ClientWrite](wait-event.clientwrite.md) - + [CPU](wait-event.cpu.md) - + [IO:BufFileRead and IO:BufFileWrite](wait-event.iobuffile.md) - + [IO:DataFileRead](wait-event.iodatafileread.md) - + [IO:WALWrite](wait-event.iowalwrite.md) - + [Lock:advisory](wait-event.lockadvisory.md) - + [Lock:extend](wait-event.lockextend.md) - + [Lock:Relation](wait-event.lockrelation.md) - + [Lock:transactionid](wait-event.locktransactionid.md) - + [Lock:tuple](wait-event.locktuple.md) - + [LWLock:BufferIO](wait-event.lwlockbufferio.md) - + [LWLock:buffer_content (BufferContent)](wait-event.lwlockbuffercontent.md) - + [LWLock:lock_manager (LWLock:lockmanager)](wait-event.lw-lock-manager.md) - + [Timeout:PgSleep](wait-event.timeoutpgsleep.md) - + [Timeout:VacuumDelay](wait-event.timeoutvacuumdelay.md) - + [Tuning RDS for PostgreSQL with Amazon DevOps Guru proactive insights](PostgreSQL.Tuning_proactive_insights.md) - + [Database has long running idle in transaction connection](proactive-insights.idle-txn.md) - + [Using PostgreSQL extensions with Amazon RDS for PostgreSQL](Appendix.PostgreSQL.CommonDBATasks.Extensions.md) - + [Managing PostgreSQL partitions with the pg_partman extension](PostgreSQL_Partitions.md) - + [Scheduling maintenance with the PostgreSQL pg_cron extension](PostgreSQL_pg_cron.md) - + [Managing spatial data with the PostGIS extension](Appendix.PostgreSQL.CommonDBATasks.PostGIS.md) - + [Working with the supported foreign data wrappers for Amazon RDS for PostgreSQL](Appendix.PostgreSQL.CommonDBATasks.Extensions.foreign-data-wrappers.md) - + [Working with Trusted Language Extensions for PostgreSQL](PostgreSQL_trusted_language_extension.md) - + [Functions reference for Trusted Language Extensions for PostgreSQL](PostgreSQL_trusted_language_extension-functions-reference.md) - + [pgtle.available_extensions](pgtle.available_extensions.md) - + [pgtle.available_extension_versions](pgtle.available_extension_versions.md) - + [pgtle.extension_update_paths](pgtle.extension_update_paths.md) - + [pgtle.install_extension](pgtle.install_extension.md) - + [pgtle.install_update_path](pgtle.install_update_path.md) - + [pgtle.register_feature](pgtle.register_feature.md) - + [pgtle.register_feature_if_not_exists](pgtle.register_feature_if_not_exists.md) - + [pgtle.set_default_version](pgtle.set_default_version.md) - + [pgtle.uninstall_extension(name)](pgtle.uninstall_extension-name.md) - + [pgtle.uninstall_extension(name, version)](pgtle.uninstall_extension-name-version.md) - + [pgtle.uninstall_extension_if_exists](pgtle.uninstall_extension_if_exists.md) - + [pgtle.uninstall_update_path](pgtle.uninstall_update_path.md) - + [pgtle.uninstall_update_path_if_exists](pgtle.uninstall_update_path_if_exists.md) - + [pgtle.unregister_feature](pgtle.unregister_feature.md) - + [pgtle.unregister_feature_if_exists](pgtle.unregister_feature_if_exists.md) - + [Hooks reference for Trusted Language Extensions for PostgreSQL](PostgreSQL_trusted_language_extension-hooks-reference.md) - + [Password-check hook (passcheck)](passcheck_hook.md) -+ [Code examples for Amazon RDS using AWS SDKs](service_code_examples.md) - + [Actions for Amazon RDS using AWS SDKs](service_code_examples_actions.md) - + [Create an Amazon RDS DB instance using an AWS SDK](example_rds_CreateDBInstance_section.md) - + [Create an Amazon RDS DB parameter group using an AWS SDK](example_rds_CreateDBParameterGroup_section.md) - + [Create a snapshot of an Amazon RDS DB instance using an AWS SDK](example_rds_CreateDBSnapshot_section.md) - + [Create an authentication token for IAM authentication to an Amazon RDS database using an AWS SDK](example_rds_GenerateRDSAuthToken_section.md) - + [Delete an Amazon RDS DB instance using an AWS SDK](example_rds_DeleteDBInstance_section.md) - + [Delete an Amazon RDS DB parameter group using an AWS SDK](example_rds_DeleteDBParameterGroup_section.md) - + [Describe Amazon RDS DB instances using an AWS SDK](example_rds_DescribeDBInstances_section.md) - + [Describe Amazon RDS DB parameter groups using an AWS SDK](example_rds_DescribeDBParameterGroups_section.md) - + [Describe Amazon RDS database engine versions using an AWS SDK](example_rds_DescribeDBEngineVersions_section.md) - + [Describe options for Amazon RDS DB instances using an AWS SDK](example_rds_DescribeOrderableDBInstanceOptions_section.md) - + [Describe parameters in an Amazon RDS DB parameter group using an AWS SDK](example_rds_DescribeDBParameters_section.md) - + [Describe snapshots of Amazon RDS DB instances using an AWS SDK](example_rds_DescribeDBSnapshots_section.md) - + [Modify an Amazon RDS DB instance using an AWS SDK](example_rds_ModifyDBInstance_section.md) - + [Reboot an Amazon RDS DB instance using an AWS SDK](example_rds_RebootDBInstance_section.md) - + [Retrieve attributes that belongs to an Amazon RDS account using an AWS SDK](example_rds_DescribeAccountAttributes_section.md) - + [Update parameters in an Amazon RDS DB parameter group using an AWS SDK](example_rds_ModifyDBParameterGroup_section.md) - + [Scenarios for Amazon RDS using AWS SDKs](service_code_examples_scenarios.md) - + [Get started with Amazon RDS DB instances using an AWS SDK](example_rds_Scenario_GetStartedInstances_section.md) - + [Cross-service examples for Amazon RDS using AWS SDKs](service_code_examples_cross-service_examples.md) - + [Create an Aurora Serverless work item tracker](example_cross_RDSDataTracker_section.md) -+ [Security in Amazon RDS](UsingWithRDS.md) - + [Database authentication with Amazon RDS](database-authentication.md) - + [Password management with Amazon RDS and AWS Secrets Manager](rds-secrets-manager.md) - + [Data protection in Amazon RDS](DataDurability.md) - + [Protecting data using encryption](Encryption.md) - + [Encrypting Amazon RDS resources](Overview.Encryption.md) - + [AWS KMS key management](Overview.Encryption.Keys.md) - + [Using SSL/TLS to encrypt a connection to a DB instance](UsingWithRDS.SSL.md) - + [Rotating your SSL/TLS certificate](UsingWithRDS.SSL-certificate-rotation.md) - + [Internetwork traffic privacy](inter-network-traffic-privacy.md) - + [Identity and access management for Amazon RDS](UsingWithRDS.IAM.md) - + [How Amazon RDS works with IAM](security_iam_service-with-iam.md) - + [Identity-based policy examples for Amazon RDS](security_iam_id-based-policy-examples.md) - + [AWS managed policies for Amazon RDS](rds-security-iam-awsmanpol.md) - + [Amazon RDS updates to AWS managed policies](rds-manpol-updates.md) - + [Preventing cross-service confused deputy problems](cross-service-confused-deputy-prevention.md) - + [IAM database authentication for MariaDB, MySQL, and PostgreSQL](UsingWithRDS.IAMDBAuth.md) - + [Enabling and disabling IAM database authentication](UsingWithRDS.IAMDBAuth.Enabling.md) - + [Creating and using an IAM policy for IAM database access](UsingWithRDS.IAMDBAuth.IAMPolicy.md) - + [Creating a database account using IAM authentication](UsingWithRDS.IAMDBAuth.DBAccounts.md) - + [Connecting to your DB instance using IAM authentication](UsingWithRDS.IAMDBAuth.Connecting.md) - + [Connecting to your DB instance using IAM authentication from the command line: AWS CLI and mysql client](UsingWithRDS.IAMDBAuth.Connecting.AWSCLI.md) - + [Connecting to your DB instance using IAM authentication from the command line: AWS CLI and psql client](UsingWithRDS.IAMDBAuth.Connecting.AWSCLI.PostgreSQL.md) - + [Connecting to your DB instance using IAM authentication and the AWS SDK for .NET](UsingWithRDS.IAMDBAuth.Connecting.NET.md) - + [Connecting to your DB instance using IAM authentication and the AWS SDK for Go](UsingWithRDS.IAMDBAuth.Connecting.Go.md) - + [Connecting to your DB instance using IAM authentication and the AWS SDK for Java](UsingWithRDS.IAMDBAuth.Connecting.Java.md) - + [Connecting to your DB instance using IAM authentication and the AWS SDK for Python (Boto3)](UsingWithRDS.IAMDBAuth.Connecting.Python.md) - + [Troubleshooting Amazon RDS identity and access](security_iam_troubleshoot.md) - + [Logging and monitoring in Amazon RDS](Overview.LoggingAndMonitoring.md) - + [Compliance validation for Amazon RDS](RDS-compliance.md) - + [Resilience in Amazon RDS](disaster-recovery-resiliency.md) - + [Infrastructure security in Amazon RDS](infrastructure-security.md) - + [Amazon RDS API and interface VPC endpoints (AWS PrivateLink)](vpc-interface-endpoints.md) - + [Security best practices for Amazon RDS](CHAP_BestPractices.Security.md) - + [Controlling access with security groups](Overview.RDSSecurityGroups.md) - + [Master user account privileges](UsingWithRDS.MasterAccounts.md) - + [Using service-linked roles for Amazon RDS](UsingWithRDS.IAM.ServiceLinkedRoles.md) - + [Amazon VPC VPCs and Amazon RDS](USER_VPC.md) - + [Working with a DB instance in a VPC](USER_VPC.WorkingWithRDSInstanceinaVPC.md) - + [Updating the VPC for a DB instance](USER_VPC.VPC2VPC.md) - + [Scenarios for accessing a DB instance in a VPC](USER_VPC.Scenarios.md) - + [Tutorial: Create a VPC for use with a DB instance (IPv4 only)](CHAP_Tutorials.WebServerDB.CreateVPC.md) - + [Tutorial: Create a VPC for use with a DB instance (dual-stack mode)](CHAP_Tutorials.CreateVPCDualStack.md) - + [Moving a DB instance not in a VPC into a VPC](USER_VPC.Non-VPC2VPC.md) -+ [Quotas and constraints for Amazon RDS](CHAP_Limits.md) -+ [Troubleshooting for Amazon RDS](CHAP_Troubleshooting.md) -+ [Amazon RDS API reference](ProgrammingGuide.md) - + [Using the Query API](Using_the_Query_API.md) - + [Troubleshooting applications on Amazon RDS](APITroubleshooting.md) -+ [Document history](WhatsNew.md) -+ [AWS glossary](glossary.md) \ No newline at end of file diff --git a/doc_source/infrastructure-security.md b/doc_source/infrastructure-security.md deleted file mode 100644 index b392b6d..0000000 --- a/doc_source/infrastructure-security.md +++ /dev/null @@ -1,26 +0,0 @@ -# Infrastructure security in Amazon RDS - -As a managed service, Amazon Relational Database Service is protected by the AWS global network security\. For information about AWS security services and how AWS protects infrastructure, see [AWS Cloud Security](http://aws.amazon.com/security/)\. To design your AWS environment using the best practices for infrastructure security, see [Infrastructure Protection](https://docs.aws.amazon.com/wellarchitected/latest/security-pillar/infrastructure-protection.html) in *Security Pillar AWS Well‐Architected Framework*\. - -You use AWS published API calls to access Amazon RDS through the network\. Clients must support the following: -+ Transport Layer Security \(TLS\)\. We require TLS 1\.2 and recommend TLS 1\.3\. -+ Cipher suites with perfect forward secrecy \(PFS\) such as DHE \(Ephemeral Diffie\-Hellman\) or ECDHE \(Elliptic Curve Ephemeral Diffie\-Hellman\)\. Most modern systems such as Java 7 and later support these modes\. - -Additionally, requests must be signed by using an access key ID and a secret access key that is associated with an IAM principal\. Or you can use the [AWS Security Token Service](https://docs.aws.amazon.com/STS/latest/APIReference/Welcome.html) \(AWS STS\) to generate temporary security credentials to sign requests\. - -In addition, Amazon RDS offers features to help support infrastructure security\. - -## Security groups - -Security groups control the access that traffic has in and out of a DB instance\. By default, network access is turned off to a DB instance\. You can specify rules in a security group that allow access from an IP address range, port, or security group\. After ingress rules are configured, the same rules apply to all DB instances that are associated with that security group\. - -For more information, see [Controlling access with security groups](Overview.RDSSecurityGroups.md)\. - -## Public accessibility - -When you launch a DB instance inside a virtual private cloud \(VPC\) based on the Amazon VPC service, you can turn on or off public accessibility for that DB instance\. To designate whether the DB instance that you create has a DNS name that resolves to a public IP address, you use the *Public accessibility* parameter\. By using this parameter, you can designate whether there is public access to the DB instance\. You can modify a DB instance to turn on or off public accessibility by modifying the *Public accessibility* parameter\. - -For more information, see [Hiding a DB instance in a VPC from the internet](USER_VPC.WorkingWithRDSInstanceinaVPC.md#USER_VPC.Hiding)\. - -**Note** -If your DB instance is in a VPC but isn't publicly accessible, you can also use an AWS Site\-to\-Site VPN connection or an AWS Direct Connect connection to access it from a private network\. For more information, see [Internetwork traffic privacy](inter-network-traffic-privacy.md)\. \ No newline at end of file diff --git a/doc_source/inter-network-traffic-privacy.md b/doc_source/inter-network-traffic-privacy.md deleted file mode 100644 index 9105d44..0000000 --- a/doc_source/inter-network-traffic-privacy.md +++ /dev/null @@ -1,11 +0,0 @@ -# Internetwork traffic privacy - -Connections are protected both between Amazon RDS and on\-premises applications and between Amazon RDS and other AWS resources within the same AWS Region\. - -## Traffic between service and on\-premises clients and applications - -You have two connectivity options between your private network and AWS: -+ An AWS Site\-to\-Site VPN connection\. For more information, see [What is AWS Site\-to\-Site VPN?](https://docs.aws.amazon.com/vpn/latest/s2svpn/VPC_VPN.html) -+ An AWS Direct Connect connection\. For more information, see [What is AWS Direct Connect?](https://docs.aws.amazon.com/directconnect/latest/UserGuide/Welcome.html) - -You get access to Amazon RDS through the network by using AWS\-published API operations\. Clients must support Transport Layer Security \(TLS\) 1\.0\. We recommend TLS 1\.2\. Clients must also support cipher suites with Perfect Forward Secrecy \(PFS\), such as Ephemeral Diffie\-Hellman \(DHE\) or Elliptic Curve Diffie\-Hellman Ephemeral \(ECDHE\)\. Most modern systems such as Java 7 and later support these modes\. Additionally, you must sign requests using an access key identifier and a secret access key that are associated with an IAM principal\. Or you can use the [AWS security token service \(STS\)](https://docs.aws.amazon.com/STS/latest/APIReference/Welcome.html) to generate temporary security credentials to sign requests\. \ No newline at end of file diff --git a/doc_source/kerberos-authentication.md b/doc_source/kerberos-authentication.md deleted file mode 100644 index 7417098..0000000 --- a/doc_source/kerberos-authentication.md +++ /dev/null @@ -1,15 +0,0 @@ -# Kerberos Authentication - -Amazon RDS supports external authentication of database users using Kerberos and Microsoft Active Directory\. Kerberos is a network authentication protocol that uses tickets and symmetric\-key cryptography to eliminate the need to transmit passwords over the network\. Kerberos has been built into Active Directory and is designed to authenticate users to network resources, such as databases\. - -Amazon RDS support for Kerberos and Active Directory provides the benefits of single sign\-on and centralized authentication of database users\. You can keep your user credentials in Active Directory\. Active Directory provides a centralized place for storing and managing credentials for multiple DB instances\. - -You can enable your database users to authenticate against DB instances in two ways\. They can use credentials stored either in AWS Directory Service for Microsoft Active Directory or in your on\-premises Active Directory\. - -Currently, RDS supports Kerberos authentication for MySQL, Microsoft SQL Server, Oracle, and PostgreSQL DB instances\. Microsoft SQL Server, Oracle, and PostgreSQL DB instances support one and two\-way external and forest trust relationships\. For more information, see [When to Create a Trust Relationship](https://docs.aws.amazon.com/directoryservice/latest/admin-guide/setup_trust.html) in the *AWS Directory Service Administration Guide*\. - -For information about Kerberos authentication with a specific engine, see the following: -+ [Using Windows Authentication with an Amazon RDS for SQL Server DB Instance](USER_SQLServerWinAuth.md) -+ [Using Kerberos Authentication for MySQL](mysql-kerberos.md) -+ [Using Kerberos Authentication with Amazon RDS for Oracle](oracle-kerberos.md) -+ [Using Kerberos Authentication with Amazon RDS for PostgreSQL](postgresql-kerberos.md) \ No newline at end of file diff --git a/doc_source/logging-using-cloudtrail.md b/doc_source/logging-using-cloudtrail.md deleted file mode 100644 index b582842..0000000 --- a/doc_source/logging-using-cloudtrail.md +++ /dev/null @@ -1,179 +0,0 @@ -# Monitoring Amazon RDS API calls in AWS CloudTrail - -AWS CloudTrail is an AWS service that helps you audit your AWS account\. AWS CloudTrail is turned on for your AWS account when you create it\. For more information about CloudTrail, see the [AWS CloudTrail User Guide](https://docs.aws.amazon.com/awscloudtrail/latest/userguide/)\. - -**Topics** -+ [CloudTrail integration with Amazon RDS](#service-name-info-in-cloudtrail) -+ [Amazon RDS log file entries](#understanding-service-name-entries) - -## CloudTrail integration with Amazon RDS - -All Amazon RDS actions are logged by CloudTrail\. CloudTrail provides a record of actions taken by a user, role, or an AWS service in Amazon RDS\. - -### CloudTrail events - -CloudTrail captures API calls for Amazon RDS as events\. An event represents a single request from any source and includes information about the requested action, the date and time of the action, request parameters, and so on\. Events include calls from the Amazon RDS console and from code calls to the Amazon RDS API operations\. - -Amazon RDS activity is recorded in a CloudTrail event in **Event history**\. You can use the CloudTrail console to view the last 90 days of recorded API activity and events in an AWS Region\. For more information, see [Viewing events with CloudTrail event history](https://docs.aws.amazon.com/awscloudtrail/latest/userguide/view-cloudtrail-events.html)\. - -### CloudTrail trails - -For an ongoing record of events in your AWS account, including events for Amazon RDS, create a trail\. A trail is a configuration that enables delivery of events to a specified Amazon S3 bucket\. CloudTrail typically delivers log files within 15 minutes of account activity\. - -**Note** -If you don't configure a trail, you can still view the most recent events in the CloudTrail console in **Event history**\. - -You can create two types of trails for an AWS account: a trail that applies to all Regions, or a trail that applies to one Region\. By default, when you create a trail in the console, the trail applies to all Regions\. - -Additionally, you can configure other AWS services to further analyze and act upon the event data collected in CloudTrail logs\. For more information, see: -+ [Overview for creating a trail](https://docs.aws.amazon.com/awscloudtrail/latest/userguide/cloudtrail-create-and-update-a-trail.html) -+ [CloudTrail supported services and integrations](https://docs.aws.amazon.com/awscloudtrail/latest/userguide/cloudtrail-aws-service-specific-topics.html#cloudtrail-aws-service-specific-topics-integrations) -+ [Configuring Amazon SNS notifications for CloudTrail](https://docs.aws.amazon.com/awscloudtrail/latest/userguide/getting_notifications_top_level.html) -+ [Receiving CloudTrail log files from multiple Regions](https://docs.aws.amazon.com/awscloudtrail/latest/userguide/receive-cloudtrail-log-files-from-multiple-regions.html) and [Receiving CloudTrail log files from multiple accounts](https://docs.aws.amazon.com/awscloudtrail/latest/userguide/cloudtrail-receive-logs-from-multiple-accounts.html) - -## Amazon RDS log file entries - -CloudTrail log files contain one or more log entries\. CloudTrail log files are not an ordered stack trace of the public API calls, so they do not appear in any specific order\. - -The following example shows a CloudTrail log entry that demonstrates the `CreateDBInstance` action\. - -``` -{ - "eventVersion": "1.04", - "userIdentity": { - "type": "IAMUser", - "principalId": "AKIAIOSFODNN7EXAMPLE", - "arn": "arn:aws:iam::123456789012:user/johndoe", - "accountId": "123456789012", - "accessKeyId": "AKIAI44QH8DHBEXAMPLE", - "userName": "johndoe" - }, - "eventTime": "2018-07-30T22:14:06Z", - "eventSource": "rds.amazonaws.com", - "eventName": "CreateDBInstance", - "awsRegion": "us-east-1", - "sourceIPAddress": "192.0.2.0", - "userAgent": "aws-cli/1.15.42 Python/3.6.1 Darwin/17.7.0 botocore/1.10.42", - "requestParameters": { - "enableCloudwatchLogsExports": [ - "audit", - "error", - "general", - "slowquery" - ], - "dBInstanceIdentifier": "test-instance", - "engine": "mysql", - "masterUsername": "myawsuser", - "allocatedStorage": 20, - "dBInstanceClass": "db.m1.small", - "masterUserPassword": "****" - }, - "responseElements": { - "dBInstanceArn": "arn:aws:rds:us-east-1:123456789012:db:test-instance", - "storageEncrypted": false, - "preferredBackupWindow": "10:27-10:57", - "preferredMaintenanceWindow": "sat:05:47-sat:06:17", - "backupRetentionPeriod": 1, - "allocatedStorage": 20, - "storageType": "standard", - "engineVersion": "8.0.28", - "dbInstancePort": 0, - "optionGroupMemberships": [ - { - "status": "in-sync", - "optionGroupName": "default:mysql-8-0" - } - ], - "dBParameterGroups": [ - { - "dBParameterGroupName": "default.mysql8.0", - "parameterApplyStatus": "in-sync" - } - ], - "monitoringInterval": 0, - "dBInstanceClass": "db.m1.small", - "readReplicaDBInstanceIdentifiers": [], - "dBSubnetGroup": { - "dBSubnetGroupName": "default", - "dBSubnetGroupDescription": "default", - "subnets": [ - { - "subnetAvailabilityZone": {"name": "us-east-1b"}, - "subnetIdentifier": "subnet-cbfff283", - "subnetStatus": "Active" - }, - { - "subnetAvailabilityZone": {"name": "us-east-1e"}, - "subnetIdentifier": "subnet-d7c825e8", - "subnetStatus": "Active" - }, - { - "subnetAvailabilityZone": {"name": "us-east-1f"}, - "subnetIdentifier": "subnet-6746046b", - "subnetStatus": "Active" - }, - { - "subnetAvailabilityZone": {"name": "us-east-1c"}, - "subnetIdentifier": "subnet-bac383e0", - "subnetStatus": "Active" - }, - { - "subnetAvailabilityZone": {"name": "us-east-1d"}, - "subnetIdentifier": "subnet-42599426", - "subnetStatus": "Active" - }, - { - "subnetAvailabilityZone": {"name": "us-east-1a"}, - "subnetIdentifier": "subnet-da327bf6", - "subnetStatus": "Active" - } - ], - "vpcId": "vpc-136a4c6a", - "subnetGroupStatus": "Complete" - }, - "masterUsername": "myawsuser", - "multiAZ": false, - "autoMinorVersionUpgrade": true, - "engine": "mysql", - "cACertificateIdentifier": "rds-ca-2015", - "dbiResourceId": "db-ETDZIIXHEWY5N7GXVC4SH7H5IA", - "dBSecurityGroups": [], - "pendingModifiedValues": { - "masterUserPassword": "****", - "pendingCloudwatchLogsExports": { - "logTypesToEnable": [ - "audit", - "error", - "general", - "slowquery" - ] - } - }, - "dBInstanceStatus": "creating", - "publiclyAccessible": true, - "domainMemberships": [], - "copyTagsToSnapshot": false, - "dBInstanceIdentifier": "test-instance", - "licenseModel": "general-public-license", - "iAMDatabaseAuthenticationEnabled": false, - "performanceInsightsEnabled": false, - "vpcSecurityGroups": [ - { - "status": "active", - "vpcSecurityGroupId": "sg-f839b688" - } - ] - }, - "requestID": "daf2e3f5-96a3-4df7-a026-863f96db793e", - "eventID": "797163d3-5726-441d-80a7-6eeb7464acd4", - "eventType": "AwsApiCall", - "recipientAccountId": "123456789012" -} -``` - -As shown in the `userIdentity` element in the preceding example, every event or log entry contains information about who generated the request\. The identity information helps you determine the following: -+ Whether the request was made with root or IAM user credentials\. -+ Whether the request was made with temporary security credentials for a role or federated user\. -+ Whether the request was made by another AWS service\. - -For more information about the `userIdentity`, see the [CloudTrail userIdentity element](https://docs.aws.amazon.com/awscloudtrail/latest/userguide/cloudtrail-event-reference-user-identity.html)\. For more information about `CreateDBInstance` and other Amazon RDS actions, see the [Amazon RDS API Reference](https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/)\. \ No newline at end of file diff --git a/doc_source/logs-events-streams-console.md b/doc_source/logs-events-streams-console.md deleted file mode 100644 index 3fd239c..0000000 --- a/doc_source/logs-events-streams-console.md +++ /dev/null @@ -1,31 +0,0 @@ -# Viewing logs, events, and streams in the Amazon RDS console - -Amazon RDS integrates with AWS services to show information about logs, events, and database activity streams in the RDS console\. - -The **Logs & events** tab for your RDS DB instance shows the following information: -+ **Amazon CloudWatch alarms** – Shows any metric alarms that you have configured for the DB instance\. If you haven't configured alarms, you can create them in the RDS console\. For more information, see [Monitoring Amazon RDS metrics with Amazon CloudWatch](monitoring-cloudwatch.md)\. -+ **Recent events** – Shows a summary of events \(environment changes\) for your RDS DB instance \. For more information, see [Viewing Amazon RDS events](USER_ListEvents.md)\. -+ **Logs** – Shows database log files generated by a DB instance\. For more information, see [Monitoring Amazon RDS log files](USER_LogAccess.md)\. - -The **Configuration** tab displays information about database activity streams\. - -**To view logs, events, and streams for your DB instance in the RDS console** - -1. Sign in to the AWS Management Console and open the Amazon RDS console at [https://console\.aws\.amazon\.com/rds/](https://console.aws.amazon.com/rds/)\. - -1. In the navigation pane, choose **Databases**\. - -1. Choose the name of the DB instance that you want to monitor\. - - The database page appears\. The following example shows an Oracle database named `orclb`\. -![\[Database page with monitoring tab shown\]](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/images/oracle-with-monitoring-tab.png) - -1. Choose **Logs & events**\. - - The Logs & events section appears\. -![\[Database page with Logs & events tab shown\]](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/images/oracle-logs-and-events-subpage.png) - -1. Choose **Configuration**\. - - The following example shows the status of the database activity streams for your DB instance\. -![\[Enhanced Monitoring\]](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/images/oracle-das.png) \ No newline at end of file diff --git a/doc_source/mariadb-ssl-connections.md b/doc_source/mariadb-ssl-connections.md deleted file mode 100644 index d4b4537..0000000 --- a/doc_source/mariadb-ssl-connections.md +++ /dev/null @@ -1,104 +0,0 @@ -# Encrypting client connections to MariaDB DB instances with SSL/TLS - -Secure Sockets Layer \(SSL\) is an industry\-standard protocol for securing network connections between client and server\. After SSL version 3\.0, the name was changed to Transport Layer Security \(TLS\)\. Amazon RDS supports SSL/TLS encryption for MariaDB DB instances\. Using SSL/TLS, you can encrypt a connection between your application client and your MariaDB DB instance\. SSL/TLS support is available in all AWS Regions\. - -**Topics** -+ [Using SSL/TLS with a MariaDB DB instance](#MariaDB.Concepts.SSLSupport) -+ [Requiring SSL/TLS for all connections to a MariaDB DB instance](#mariadb-ssl-connections.require-ssl) -+ [Connecting from the MySQL command\-line client with SSL/TLS \(encrypted\)](#USER_ConnectToMariaDBInstanceSSL.CLI) - -## Using SSL/TLS with a MariaDB DB instance - -Amazon RDS creates an SSL/TLS certificate and installs the certificate on the DB instance when Amazon RDS provisions the instance\. These certificates are signed by a certificate authority\. The SSL/TLS certificate includes the DB instance endpoint as the Common Name \(CN\) for the SSL/TLS certificate to guard against spoofing attacks\. - -An SSL/TLS certificate created by Amazon RDS is the trusted root entity and should work in most cases but might fail if your application does not accept certificate chains\. If your application does not accept certificate chains, you might need to use an intermediate certificate to connect to your AWS Region\. For example, you must use an intermediate certificate to connect to the AWS GovCloud \(US\) Regions using SSL/TLS\. - -For information about downloading certificates, see [Using SSL/TLS to encrypt a connection to a DB instance](UsingWithRDS.SSL.md)\. For more information about using SSL/TLS with MySQL, see [Using new SSL/TLS certificates for MariaDB DB instances](ssl-certificate-rotation-mariadb.md)\. - -Amazon RDS for MariaDB supports Transport Layer Security \(TLS\) versions 1\.0, 1\.1, 1\.2, and 1\.3 for all MariaDB versions\. - -You can require SSL/TLS connections for specific users accounts\. For example, you can use one of the following statements, depending on your MariaDB version, to require SSL/TLS connections on the user account `encrypted_user`\. - -Use the following statement\. - -``` -ALTER USER 'encrypted_user'@'%' REQUIRE SSL; -``` - -For more information on SSL/TLS connections with MariaDB, see [ Securing Connections for Client and Server](https://mariadb.com/kb/en/securing-connections-for-client-and-server/) in the MariaDB documentation\. - -## Requiring SSL/TLS for all connections to a MariaDB DB instance - -Use the `require_secure_transport` parameter to require that all user connections to your MariaDB DB instance use SSL/TLS\. By default, the `require_secure_transport` parameter is set to `OFF`\. You can set the `require_secure_transport` parameter to `ON` to require SSL/TLS for connections to your DB instance\. - -**Note** -The `require_secure_transport` parameter is only supported for MariaDB version 10\.5 and higher\. - -You can set the `require_secure_transport` parameter value by updating the DB parameter group for your DB instance\. You don't need to reboot your DB instance for the change to take effect\. - -When the `require_secure_transport` parameter is set to `ON` for a DB instance, a database client can connect to it if it can establish an encrypted connection\. Otherwise, an error message similar to the following is returned to the client: - -``` -ERROR 1045 (28000): Access denied for user 'USER'@'localhost' (using password: YES | NO) -``` - -For information about setting parameters, see [Modifying parameters in a DB parameter group](USER_WorkingWithDBInstanceParamGroups.md#USER_WorkingWithParamGroups.Modifying)\. - -For more information about the `require_secure_transport` parameter, see the [MariaDB documentation](https://mariadb.com/docs/ent/ref/mdb/system-variables/require_secure_transport/)\. - -## Connecting from the MySQL command\-line client with SSL/TLS \(encrypted\) - -The `mysql` client program parameters are slightly different if you are using the MySQL 5\.7 version, the MySQL 8\.0 version, or the MariaDB version\. - -To find out which version you have, run the `mysql` command with the `--version` option\. In the following example, the output shows that the client program is from MariaDB\. - -``` -$ mysql --version -mysql Ver 15.1 Distrib 10.5.15-MariaDB, for osx10.15 (x86_64) using readline 5.1 -``` - -Most Linux distributions, such as Amazon Linux, CentOS, SUSE, and Debian have replaced MySQL with MariaDB, and the `mysql` version in them is from MariaDB\. - -To connect to your DB instance using SSL/TLS, follow these steps: - -**To connect to a DB instance with SSL/TLS using the MySQL command\-line client** - -1. Download a root certificate that works for all AWS Regions\. - - For information about downloading certificates, see [Using SSL/TLS to encrypt a connection to a DB instance](UsingWithRDS.SSL.md)\. - -1. Use a MySQL command\-line client to connect to a DB instance with SSL/TLS encryption\. For the `-h` parameter, substitute the DNS name \(endpoint\) for your DB instance\. For the `--ssl-ca` parameter, substitute the SSL/TLS certificate file name\. For the `-P` parameter, substitute the port for your DB instance\. For the `-u` parameter, substitute the user name of a valid database user, such as the master user\. Enter the master user password when prompted\. - - The following example shows how to launch the client using the `--ssl-ca` parameter using the MariaDB client: - - ``` - mysql -h mysql–instance1.123456789012.us-east-1.rds.amazonaws.com --ssl-ca=global-bundle.pem --ssl -P 3306 -u myadmin -p - ``` - - To require that the SSL/TLS connection verifies the DB instance endpoint against the endpoint in the SSL/TLS certificate, enter the following command: - - ``` - mysql -h mysql–instance1.123456789012.us-east-1.rds.amazonaws.com --ssl-ca=global-bundle.pem --ssl-verify-server-cert -P 3306 -u myadmin -p - ``` - - The following example shows how to launch the client using the `--ssl-ca` parameter using the MySQL 5\.7 client or later: - - ``` - mysql -h mysql–instance1.123456789012.us-east-1.rds.amazonaws.com --ssl-ca=global-bundle.pem --ssl-mode=REQUIRED -P 3306 -u myadmin -p - ``` - -1. Enter the master user password when prompted\. - -You should see output similar to the following\. - -``` -Welcome to the MariaDB monitor. Commands end with ; or \g. -Your MariaDB connection id is 31 -Server version: 10.6.10-MariaDB-log Source distribution - -Copyright (c) 2000, 2018, Oracle, MariaDB Corporation Ab and others. - -Type 'help;' or '\h' for help. Type '\c' to clear the current input statement. - -MariaDB [(none)]> -``` \ No newline at end of file diff --git a/doc_source/metrics-reference.md b/doc_source/metrics-reference.md deleted file mode 100644 index f8b60a4..0000000 --- a/doc_source/metrics-reference.md +++ /dev/null @@ -1,11 +0,0 @@ -# Metrics reference for Amazon RDS - -In this reference, you can find descriptions of Amazon RDS metrics for Amazon CloudWatch, Performance Insights, and Enhanced Monitoring\. - -**Topics** -+ [Amazon CloudWatch metrics for Amazon RDS](rds-metrics.md) -+ [Amazon CloudWatch dimensions for Amazon RDS](dimensions.md) -+ [Amazon CloudWatch metrics for Performance Insights](USER_PerfInsights.Cloudwatch.md) -+ [Performance Insights counter metrics](USER_PerfInsights_Counters.md) -+ [SQL statistics for Performance Insights](sql-statistics.md) -+ [OS metrics in Enhanced Monitoring](USER_Monitoring-Available-OS-Metrics.md) \ No newline at end of file diff --git a/doc_source/metrics_dimensions.md b/doc_source/metrics_dimensions.md deleted file mode 100644 index 8e239ad..0000000 --- a/doc_source/metrics_dimensions.md +++ /dev/null @@ -1,102 +0,0 @@ -# Viewing DB instance metrics in the CloudWatch console and AWS CLI - -Following, you can find details about how to view metrics for your DB instance using CloudWatch\. For information on monitoring metrics for your DB instance's operating system in real time using CloudWatch Logs, see [Monitoring OS metrics with Enhanced Monitoring](USER_Monitoring.OS.md)\. - -When you use Amazon RDS resources, Amazon RDS sends metrics and dimensions to Amazon CloudWatch every minute\. You can use the following procedures to view the metrics for Amazon RDS in the CloudWatch console and CLI\. - -## Console - -**To view metrics using the Amazon CloudWatch console** - -Metrics are grouped first by the service namespace, and then by the various dimension combinations within each namespace\. - -1. Open the CloudWatch console at [https://console\.aws\.amazon\.com/cloudwatch/](https://console.aws.amazon.com/cloudwatch/)\. - - The CloudWatch overview home page appears\. -![\[CloudWatch overview page\]](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/images/monitoring-overviewpage-console2.png) - -1. If necessary, change the AWS Region\. From the navigation bar, choose the AWS Region where your AWS resources are\. For more information, see [Regions and endpoints](https://docs.aws.amazon.com/general/latest/gr/rande.html)\. - -1. In the navigation pane, choose **Metrics** and then **All metrics**\. -![\[Choose metric namespace\]](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/images/cw-all-metrics.png) - -1. Scroll down and choose the **RDS** metric namespace\. - - The page displays the Amazon RDS dimensions\. For descriptions of these dimensions, see [Amazon CloudWatch dimensions for Amazon RDS](dimensions.md)\. -![\[Choose metric namespace\]](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/images/rds-monitoring-01.png) - -1. Choose a metric dimension, for example **By Database Class**\. -![\[Filter metrics\]](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/images/metrics-by-instance-class.png) - -1. Do any of the following actions: - + To sort the metrics, use the column heading\. - + To graph a metric, select the check box next to the metric\. - + To filter by resource, choose the resource ID, and then choose **Add to search**\. - + To filter by metric, choose the metric name, and then choose **Add to search**\. - - The following example filters on the **db\.t3\.medium** class and graphs the **CPUUtilization** metric\. -![\[Filter metrics\]](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/images/rds-monitoring-03.png) - -## AWS CLI - -To obtain metric information by using the AWS CLI, use the CloudWatch command [https://docs.aws.amazon.com/cli/latest/reference/cloudwatch/list-metrics.html](https://docs.aws.amazon.com/cli/latest/reference/cloudwatch/list-metrics.html)\. In the following example, you list all metrics in the `AWS/RDS` namespace\. - -``` -aws cloudwatch list-metrics --namespace AWS/RDS -``` - -To obtain metric statistics, use the command [https://docs.aws.amazon.com/cli/latest/reference/cloudwatch/get-metric-statistics.html](https://docs.aws.amazon.com/cli/latest/reference/cloudwatch/get-metric-statistics.html)\. The following command gets `CPUUtilization` statistics for instance `my-instance` over the specific 24\-hour period, with a 5\-minute granularity\. - -**Example** -For Linux, macOS, or Unix: - -``` -1. aws cloudwatch get-metric-statistics --namespace AWS/RDS \ -2. --metric-name CPUUtilization \ -3. --start-time 2021-12-15T00:00:00Z \ -4. --end-time 2021-12-16T00:00:00Z \ -5. --period 360 \ -6. --statistics Minimum \ -7. --dimensions Name=DBInstanceIdentifier,Value=my-instance -``` -For Windows: - -``` -1. aws cloudwatch get-metric-statistics --namespace AWS/RDS ^ -2. --metric-name CPUUtilization ^ -3. --start-time 2021-12-15T00:00:00Z ^ -4. --end-time 2021-12-16T00:00:00Z ^ -5. --period 360 ^ -6. --statistics Minimum ^ -7. --dimensions Name=DBInstanceIdentifier,Value=my-instance -``` -Sample output appears as follows: - -``` -{ - "Datapoints": [ - { - "Timestamp": "2021-12-15T18:00:00Z", - "Minimum": 8.7, - "Unit": "Percent" - }, - { - "Timestamp": "2021-12-15T23:54:00Z", - "Minimum": 8.12486458559024, - "Unit": "Percent" - }, - { - "Timestamp": "2021-12-15T17:24:00Z", - "Minimum": 8.841666666666667, - "Unit": "Percent" - }, ... - { - "Timestamp": "2021-12-15T22:48:00Z", - "Minimum": 8.366248354248954, - "Unit": "Percent" - } - ], - "Label": "CPUUtilization" -} -``` -For more information, see [Getting statistics for a metric](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/getting-metric-statistics.html) in the *Amazon CloudWatch User Guide*\. \ No newline at end of file diff --git a/doc_source/modify-multi-az-db-cluster.md b/doc_source/modify-multi-az-db-cluster.md deleted file mode 100644 index c64ff23..0000000 --- a/doc_source/modify-multi-az-db-cluster.md +++ /dev/null @@ -1,123 +0,0 @@ -# Modifying a Multi\-AZ DB cluster - -A Multi\-AZ DB cluster has a writer DB instance and two reader DB instances in three separate Availability Zones\. Multi\-AZ DB clusters provide high availability, increased capacity for read workloads, and lower latency when compared to Multi\-AZ deployments\. For more information about Multi\-AZ DB clusters, see [Multi\-AZ DB cluster deployments](multi-az-db-clusters-concepts.md)\. - -You can modify a Multi\-AZ DB cluster to change its settings\. You can also perform operations on a Multi\-AZ DB cluster, such as taking a snapshot of it\. However, you can't modify the DB instances in a Multi\-AZ DB cluster, and the only supported operation is rebooting a DB instance\. - -**Note** -Multi\-AZ DB clusters are supported only for the MySQL and PostgreSQL DB engines\. - -You can modify a Multi\-AZ DB cluster using the AWS Management Console, the AWS CLI, or the RDS API\. - -## Console - -**To modify a Multi\-AZ DB cluster** - -1. Sign in to the AWS Management Console and open the Amazon RDS console at [https://console\.aws\.amazon\.com/rds/](https://console.aws.amazon.com/rds/)\. - -1. In the navigation pane, choose **Databases**, and then choose the Multi\-AZ DB cluster that you want to modify\. - -1. Choose **Modify**\. The **Modify DB cluster** page appears\. - -1. Change any of the settings that you want\. For information about each setting, see [Settings for modifying Multi\-AZ DB clusters](#modify-multi-az-db-cluster-settings)\. - -1. When all the changes are as you want them, choose **Continue** and check the summary of modifications\. - -1. \(Optional\) Choose **Apply immediately** to apply the changes immediately\. Choosing this option can cause downtime in some cases\. For more information, see [Applying changes immediately](#modify-multi-az-db-cluster-apply-immediately)\. - -1. On the confirmation page, review your changes\. If they're correct, choose **Modify DB cluster** to save your changes\. - - Or choose **Back** to edit your changes or **Cancel** to cancel your changes\. - -## AWS CLI - -To modify a Multi\-AZ DB cluster by using the AWS CLI, call the [modify\-db\-cluster](https://docs.aws.amazon.com/cli/latest/reference/rds/modify-db-cluster.html) command\. Specify the DB cluster identifier and the values for the options that you want to modify\. For information about each option, see [Settings for modifying Multi\-AZ DB clusters](#modify-multi-az-db-cluster-settings)\. - -**Example** -The following code modifies `my-multi-az-dbcluster` by setting the backup retention period to 1 week \(7 days\)\. The code turns on deletion protection by using `--deletion-protection`\. To turn off deletion protection, use `--no-deletion-protection`\. The changes are applied during the next maintenance window by using `--no-apply-immediately`\. Use `--apply-immediately` to apply the changes immediately\. For more information, see [Applying changes immediately](#modify-multi-az-db-cluster-apply-immediately)\. -For Linux, macOS, or Unix: - -``` -aws rds modify-db-cluster \ - --db-cluster-identifier my-multi-az-dbcluster \ - --backup-retention-period 7 \ - --deletion-protection \ - --no-apply-immediately -``` -For Windows: - -``` -aws rds modify-db-cluster ^ - --db-cluster-identifier my-multi-az-dbcluster ^ - --backup-retention-period 7 ^ - --deletion-protection ^ - --no-apply-immediately -``` - -## RDS API - -To modify a Multi\-AZ DB cluster by using the Amazon RDS API, call the [ModifyDBCluster](https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_ModifyDBCluster.html) operation\. Specify the DB cluster identifier, and the parameters for the settings that you want to modify\. For information about each parameter, see [Settings for modifying Multi\-AZ DB clusters](#modify-multi-az-db-cluster-settings)\. - -## Applying changes immediately - -When you modify a Multi\-AZ DB cluster, you can apply the changes immediately\. To apply changes immediately, you choose the **Apply Immediately** option in the AWS Management Console\. Or you use the `--apply-immediately` option when calling the AWS CLI or set the `ApplyImmediately` parameter to `true` when using the Amazon RDS API\. - -If you don't choose to apply changes immediately, the changes are put into the pending modifications queue\. During the next maintenance window, any pending changes in the queue are applied\. If you choose to apply changes immediately, your new changes and any changes in the pending modifications queue are applied\. - -**Important** -If any of the pending modifications require the DB cluster to be temporarily unavailable \(*downtime*\), choosing the apply immediately option can cause unexpected downtime\. -When you choose to apply a change immediately, any pending modifications are also applied immediately, instead of during the next maintenance window\. -If you don't want a pending change to be applied in the next maintenance window, you can modify the DB instance to revert the change\. You can do this by using the AWS CLI and specifying the `--apply-immediately` option\. - -Changes to some database settings are applied immediately, even if you choose to defer your changes\. To see how the different database settings interact with the apply immediately setting, see [Settings for modifying Multi\-AZ DB clusters](#modify-multi-az-db-cluster-settings)\. - -## Settings for modifying Multi\-AZ DB clusters - -For details about settings that you can use to modify a Multi\-AZ DB cluster, see the following table\. For more information about the AWS CLI options, see [modify\-db\-cluster](https://docs.aws.amazon.com/cli/latest/reference/rds/modify-db-cluster.html)\. For more information about the RDS API parameters, see [ ModifyDBCluster](https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_ModifyDBCluster.html)\. - - -| Console setting | Setting description | CLI option and RDS API parameter | When the change occurs | Downtime notes | -| --- | --- | --- | --- | --- | -| **Allocated storage** | The amount of storage to allocate for each DB instance in your DB cluster \(in gibibytes\)\. For more information, see [Amazon RDS DB instance storage](CHAP_Storage.md)\. | **CLI option:** `--allocated-storage` **API parameter:** `AllocatedStorage` | If you choose to apply the change immediately, it occurs immediately\. If you don't choose to apply the change immediately, it occurs during the next maintenance window\. | Downtime doesn't occur during this change\. | -| Auto minor version upgrade | **Enable auto minor version upgrade** to have your DB cluster receive preferred minor DB engine version upgrades automatically when they become available\. Amazon RDS performs automatic minor version upgrades in the maintenance window\. | **CLI option:** `--auto-minor-version-upgrade` `--no-auto-minor-version-upgrade` **API parameter:** `AutoMinorVersionUpgrade` | The change occurs immediately\. This setting ignores the apply immediately setting\. | Downtime doesn't occur during this change\. | -| Backup retention period | The number of days that you want automatic backups of your DB cluster to be retained\. For any nontrivial DB cluster, set this value to **1** or greater\. For more information, see [Working with backups](USER_WorkingWithAutomatedBackups.md)\. | **CLI option:** `--backup-retention-period` **API parameter:** `BackupRetentionPeriod` | If you choose to apply the change immediately, it occurs immediately\. If you don't choose to apply the change immediately, and you change the setting from a nonzero value to another nonzero value, the change is applied asynchronously, as soon as possible\. Otherwise, the change occurs during the next maintenance window\. | Downtime occurs if you change from 0 to a nonzero value, or from a nonzero value to 0\. | -| Backup window | The time period during which Amazon RDS automatically takes a backup of your DB cluster\. Unless you have a specific time that you want to have your database backed up, use the default of **No preference**\. For more information, see [Working with backups](USER_WorkingWithAutomatedBackups.md)\. | **CLI option:** `--preferred-backup-window` **API parameter:** `PreferredBackupWindow` | The change is applied asynchronously, as soon as possible\. | Downtime doesn't occur during this change\. | -| Copy tags to snapshots | This option copies any DB cluster tags to a DB snapshot when you create a snapshot\. For more information, see [Tagging Amazon RDS resources](USER_Tagging.md)\. | **CLI option:** `-copy-tags-to-snapshot` `-no-copy-tags-to-snapshot` **RDS API parameter:** `CopyTagsToSnapshot` | The change occurs immediately\. This setting ignores the apply immediately setting\. | Downtime doesn't occur during this change\. | -| Database authentication | For Multi\-AZ DB clusters, only **Password authentication** is supported\. | None because password authentication is the default\. | If you choose to apply the change immediately, it occurs immediately\. If you don't choose to apply the change immediately, it occurs during the next maintenance window\. | Downtime doesn't occur during this change\. | -| **DB cluster identifier** | The DB cluster identifier\. This value is stored as a lowercase string\. When you change the DB cluster identifier, the DB cluster endpoint changes\. The identifiers and endpoints of the DB instances in the DB cluster also change\. The new DB cluster name must be unique\. The maximum length is 63 characters\. The names of the DB instances in the DB cluster are changed to correspond with the new name of the DB cluster\. A new DB instance name can't be the same as the name of an existing DB instance\. For example, if you change the DB cluster name to `maz`, a DB instance name might be changed to `maz-instance-1`\. In this case, there can't be an existing DB instance named `maz-instance-1`\. For more information, see [Renaming a Multi\-AZ DB cluster](multi-az-db-cluster-rename.md)\. | **CLI option:** `--new-db-cluster-identifier` **RDS API parameter:** `NewDBClusterIdentifier` | If you choose to apply the change immediately, it occurs immediately\. If you don't choose to apply the change immediately, it occurs during the next maintenance window\. | An outage doesn't occur during this change\. | -| DB cluster instance class | The compute and memory capacity of each DB instance in the Multi\-AZ DB cluster, for example `db.r6gd.xlarge`\. If possible, choose a DB instance class large enough that a typical query working set can be held in memory\. When working sets are held in memory, the system can avoid writing to disk, which improves performance\. Currently, Multi\-AZ DB clusters only support db\.m6gd and db\.r6gd DB instance classes\. For more information about DB instance classes, see [DB instance classes](Concepts.DBInstanceClass.md)\. | **CLI option:** `--db-cluster-instance-class` **RDS API parameter:** `DBClusterInstanceClass` | If you choose to apply the change immediately, it occurs immediately\. If you don't choose to apply the change immediately, it occurs during the next maintenance window\. | Downtime occurs during this change\. | -| **DB cluster parameter group** | The DB cluster parameter group that you want associated with the DB cluster\. For more information, see [Working with parameter groups for Multi\-AZ DB clusters](multi-az-db-clusters-concepts.md#multi-az-db-clusters-concepts-parameter-groups)\. | **CLI option:** `--db-cluster-parameter-group-name` **RDS API parameter:** `DBClusterParameterGroupName` | The parameter group change occurs immediately\. | An outage doesn't occur during this change\. When you change the parameter group, changes to some parameters are applied to the DB instances in the Multi\-AZ DB cluster immediately without a reboot\. Changes to other parameters are applied only after the DB instances are rebooted\. | -| DB engine version | The version of database engine that you want to use\. | **CLI option:** `--engine-version` **RDS API parameter:** `EngineVersion` | If you choose to apply the change immediately, it occurs immediately\. If you don't choose to apply the change immediately, it occurs during the next maintenance window\. | An outage occurs during this change\. | -| Deletion protection | **Enable deletion protection** to prevent your DB cluster from being deleted\. For more information, see [Deleting a DB instance](USER_DeleteInstance.md)\. | **CLI option:** `--deletion-protection` `--no-deletion-protection` **RDS API parameter:** `DeletionProtection` | The change occurs immediately\. This setting ignores the apply immediately setting\. | An outage doesn't occur during this change\. | -| Maintenance window | The 30\-minute window in which pending modifications to your DB cluster are applied\. If the time period doesn't matter, choose **No preference**\. For more information, see [The Amazon RDS maintenance window](USER_UpgradeDBInstance.Maintenance.md#Concepts.DBMaintenance)\. | **CLI option:** `--preferred-maintenance-window` **RDS API parameter:** `PreferredMaintenanceWindow` | The change occurs immediately\. This setting ignores the apply immediately setting\. | If there are one or more pending actions that cause downtime, and the maintenance window is changed to include the current time, those pending actions are applied immediately and downtime occurs\. | -| Manage master credentials in AWS Secrets Manager | Select **Manage master credentials in AWS Secrets Manager** to manage the master user password in a secret in Secrets Manager\. Optionally, choose a KMS key to use to protect the secret\. Choose from the KMS keys in your account, or enter the key from a different account\. If RDS is already managing the master user password for the DB cluster, you can rotate the master user password by choosing **Rotate secret immediately**\. For more information, see [Password management with Amazon RDS and AWS Secrets Manager](rds-secrets-manager.md)\. | **CLI option:** `--manage-master-user-password \| --no-manage-master-user-password` `--master-user-secret-kms-key-id` `--rotate-master-user-password \| --no-rotate-master-user-password` **RDS API parameter:** `ManageMasterUserPassword` `MasterUserSecretKmsKeyId` `RotateMasterUserPassword` | If you are turning on or turning off automatic master user password management, the change occurs immediately\. This change ignores the apply immediately setting\. If you are rotating the master user password, you must specify that the change is applied immediately\. | Downtime doesn't occur during this change\. | -| New master password | The password for your master user account\. | **CLI option:** `--master-user-password` **RDS API parameter:** `MasterUserPassword` | The change is applied asynchronously, as soon as possible\. This setting ignores the apply immediately setting\. | Downtime doesn't occur during this change\. | -| Provisioned IOPS | The amount of Provisioned IOPS \(input/output operations per second\) to be initially allocated for the DB cluster\. This setting is available only if Provisioned IOPS \(`io1`\) is selected as the storage type\. For more information, see [Provisioned IOPS SSD storage](CHAP_Storage.md#USER_PIOPS)\. | **CLI option:** `--iops` **RDS API parameter:** `Iops` | If you choose to apply the change immediately, it occurs immediately\. If you don't choose to apply the change immediately, it occurs during the next maintenance window\. | Downtime doesn't occur during this change\. | -| Public access | **Publicly accessible** to give the DB cluster a public IP address, meaning that it's accessible outside its virtual private cloud \(VPC\)\. To be publicly accessible, the DB cluster also has to be in a public subnet in the VPC\. **Not publicly accessible** to make the DB cluster accessible only from inside the VPC\. For more information, see [Hiding a DB instance in a VPC from the internet](USER_VPC.WorkingWithRDSInstanceinaVPC.md#USER_VPC.Hiding)\. To connect to a DB cluster from outside of its VPC, the DB cluster must be publicly accessible\. Also, access must be granted using the inbound rules of the DB cluster's security group, and other requirements must be met\. For more information, see [Can't connect to Amazon RDS DB instance](CHAP_Troubleshooting.md#CHAP_Troubleshooting.Connecting)\. If your DB cluster isn't publicly accessible, you can use an AWS Site\-to\-Site VPN connection or an AWS Direct Connect connection to access it from a private network\. For more information, see [Internetwork traffic privacy](inter-network-traffic-privacy.md)\. | **CLI option:** `--publicly-accessible` `--no-publicly-accessible` **RDS API parameter:** `PubliclyAccessible` | The change occurs immediately\. This setting ignores the apply immediately setting\. | An outage doesn't occur during this change\. | -| VPC security group | The security groups to associate with the DB cluster\. For more information, see [Overview of VPC security groups](Overview.RDSSecurityGroups.md#Overview.RDSSecurityGroups.VPCSec)\. | **CLI option:** `--vpc-security-group-ids` **RDS API parameter:** `VpcSecurityGroupIds` | The change is applied asynchronously, as soon as possible\. This setting ignores the apply immediately setting\. | An outage doesn't occur during this change\. | - -## Settings that don't apply when modifying Multi\-AZ DB clusters - -The following settings in the AWS CLI command [modify\-db\-cluster](https://docs.aws.amazon.com/cli/latest/reference/rds/modify-db-cluster.html) and the RDS API operation [ModifyDBCluster](https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_ModifyDBCluster.html) don't apply to Multi\-AZ DB clusters\. - -You also can't modify these settings for Multi\-AZ DB clusters in the console\. - - -**** - -| AWS CLI setting | RDS API setting | -| --- | --- | -| `--allow-major-version-upgrade\|--no-allow-major-version-upgrade` | `AllowMajorVersionUpgrade` | -| `--backtrack-window` | `BacktrackWindow` | -| `--cloudwatch-logs-export-configuration` | `CloudwatchLogsExportConfiguration` | -| `--copy-tags-to-snapshot \| --no-copy-tags-to-snapshot` | `CopyTagsToSnapshot` | -| `--db-instance-parameter-group-name` | `DBInstanceParameterGroupName` | -| `--domain` | `Domain` | -| `--domain-iam-role-name` | `DomainIAMRoleName` | -| `--enable-global-write-forwarding \| --no-enable-global-write-forwarding` | `EnableGlobalWriteForwarding` | -| `--enable-http-endpoint \| --no-enable-http-endpoint` | `EnableHttpEndpoint` | -| `--enable-iam-database-authentication \| --no-enable-iam-database-authentication` | `EnableIAMDatabaseAuthentication` | -| `--option-group-name` | `OptionGroupName` | -| `--port` | `Port` | -| `--scaling-configuration` | `ScalingConfiguration` | -| `--storage-type` | `StorageType` | \ No newline at end of file diff --git a/doc_source/monitoring-cloudwatch.md b/doc_source/monitoring-cloudwatch.md deleted file mode 100644 index 083f9c7..0000000 --- a/doc_source/monitoring-cloudwatch.md +++ /dev/null @@ -1,9 +0,0 @@ -# Monitoring Amazon RDS metrics with Amazon CloudWatch - -Amazon CloudWatch is a metrics repository\. The repository collects and processes raw data from Amazon RDS into readable, near real\-time metrics\. For a complete list of Amazon RDS metrics sent to CloudWatch, see [ Metrics reference for Amazon RDS](https://docs.aws.amazon.com/en_us/AmazonRDS/latest/UserGuide/metrics-reference.html)\. - -**Topics** -+ [Overview of Amazon RDS and Amazon CloudWatch](cw-metrics-overview.md) -+ [Viewing DB instance metrics in the CloudWatch console and AWS CLI](metrics_dimensions.md) -+ [Creating CloudWatch alarms to monitor Amazon RDS](creating_alarms.md) -+ [Tutorial: Creating an Amazon CloudWatch alarm for Multi\-AZ DB cluster replica lag](multi-az-db-cluster-cloudwatch-alarm.md) \ No newline at end of file diff --git a/doc_source/multi-az-db-cluster-cloudwatch-alarm.md b/doc_source/multi-az-db-cluster-cloudwatch-alarm.md deleted file mode 100644 index ebc7ffe..0000000 --- a/doc_source/multi-az-db-cluster-cloudwatch-alarm.md +++ /dev/null @@ -1,58 +0,0 @@ -# Tutorial: Creating an Amazon CloudWatch alarm for Multi\-AZ DB cluster replica lag - -You can create an Amazon CloudWatch alarm that sends an Amazon SNS message when replica lag for a Multi\-AZ DB cluster has exceeded a threshold\. An alarm watches the `ReplicaLag` metric over a time period that you specify\. The action is a notification sent to an Amazon SNS topic or Amazon EC2 Auto Scaling policy\. - -**To set a CloudWatch alarm for Multi\-AZ DB cluster replica lag** - -1. Sign in to the AWS Management Console and open the CloudWatch console at [https://console\.aws\.amazon\.com/cloudwatch/](https://console.aws.amazon.com/cloudwatch/)\. - -1. In the navigation pane, choose **Alarms**, **All alarms**\. - -1. Choose **Create alarm**\. - -1. On the **Specify metric and conditions** page, choose **Select metric**\. - -1. In the search box, enter the name of your Multi\-AZ DB cluster and press Enter\. - - The following image shows the **Select metric** page with a Multi\-AZ DB cluster named `rds-cluster` entered\. -![\[Select metric page\]](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/images/multi-az-db-cluster-cw-tutorial-select-metric.png) - -1. Choose **RDS**, **Per\-Database Metrics**\. - -1. In the search box, enter **ReplicaLag** and press Enter, then select each DB instance in the DB cluster\. - - The following image shows the **Select metric** page with the DB instances selected for the **ReplicaLag** metric\. -![\[Select metric page with DB instances selected for the ReplicaLag metric\]](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/images/multi-az-db-cluster-cw-tutorial-metric-replica-lag.png) - - This alarm considers the replica lag for all three of the DB instances in the Multi\-AZ DB cluster\. The alarm responds when any DB instance exceeds the threshold\. It uses a math expression that returns the maximum value of the three metrics\. Start by sorting by metric name, and then choose all three **ReplicaLag** metrics\. - -1. From **Add math**, choose **All functions**, **MAX**\. -![\[The Add math setting\]](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/images/multi-az-db-cluster-cw-tutorial-select-metric-math.png) - -1. Choose the **Graphed metrics** tab, and edit the details for **Expression1** to **MAX\(\[m1,m2,m3\]\)**\. - -1. For all three **ReplicaLag** metrics, change the **Period** to **1 minute**\. - -1. Clear selection from all metrics except for **Expression1**\. - - The **Select metric** page should look similar to the following image\. -![\[The Select metric page with the metric selected\]](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/images/multi-az-db-cluster-cw-tutorial-select-metric-expression1.png) - -1. Choose **Select metric**\. - -1. On the **Specify metric and conditions** page, change the label to a meaningful name, such as **ClusterReplicaLag**, and enter a number of seconds in **Define the threshold value**\. For this tutorial, enter **1200** seconds \(20 minutes\)\. You can adjust this value for your workload requirements\. - - The **Specify metric and conditions** page should look similar to the following image\. -![\[The Specify metric and conditions page\]](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/images/multi-az-db-cluster-cw-tutorial-specify-metric-conditions.png) - -1. Choose **Next**, and the **Configure actions** page appears\. - -1. Keep **In alarm** selected, choose **Create new topic**, and enter the topic name and a valid email address\. -![\[The Configure actions page\]](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/images/multi-az-db-cluster-cw-tutorial-configure-actions.png) - -1. Choose **Create topic**, and then choose **Next**\. - -1. On the **Add name and description** page, enter the **Alarm name** and **Alarm description**, and then choose **Next**\. -![\[The Add name and description page\]](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/images/multi-az-db-cluster-cw-tutorial-add-name-and-description.png) - -1. Preview the alarm that you're about to create on the **Preview and create** page, and then choose **Create alarm**\. \ No newline at end of file diff --git a/doc_source/multi-az-db-cluster-rename.md b/doc_source/multi-az-db-cluster-rename.md deleted file mode 100644 index ec9020f..0000000 --- a/doc_source/multi-az-db-cluster-rename.md +++ /dev/null @@ -1,72 +0,0 @@ -# Renaming a Multi\-AZ DB cluster - -You can rename a Multi\-AZ DB cluster by using the AWS Management Console, the AWS CLI `modify-db-cluster` command, or the Amazon RDS API `ModifyDBCluster` operation\. Renaming a Multi\-AZ DB cluster can have significant effects\. The following is a list of considerations before you rename a Multi\-AZ DB cluster\. -+ When you rename a Multi\-AZ DB cluster, the cluster endpoints for the Multi\-AZ DB cluster change\. These endpoints change because they include the name you assigned to the Multi\-AZ DB cluster\. You can redirect traffic from an old endpoint to a new one\. For more information about Multi\-AZ DB cluster endpoints, see [Connecting to a Multi\-AZ DB cluster](multi-az-db-clusters-concepts-connection-management.md)\. -+ When you rename a Multi\-AZ DB cluster, the old DNS name that was used by the Multi\-AZ DB cluster is deleted, although it could remain cached for a few minutes\. The new DNS name for the renamed Multi\-AZ DB cluster becomes effective in about two minutes\. The renamed Multi\-AZ DB cluster isn't available until the new name becomes effective\. -+ You can't use an existing Multi\-AZ DB cluster name when renaming a cluster\. -+ Metrics and events associated with the name of a Multi\-AZ DB cluster are maintained if you reuse a DB cluster name\. -+ Multi\-AZ DB cluster tags remain with the Multi\-AZ DB cluster, regardless of renaming\. -+ DB cluster snapshots are retained for a renamed Multi\-AZ DB cluster\. - -**Note** -A Multi\-AZ DB cluster is an isolated database environment running in the cloud\. A Multi\-AZ DB cluster can host multiple databases\. For information about changing a database name, see the documentation for your DB engine\. - -## Renaming to replace an existing Multi\-AZ DB cluster - -The most common scenarios for renaming a Multi\-AZ DB cluster include restoring data from a DB cluster snapshot or performing point\-in\-time recovery \(PITR\)\. By renaming the Multi\-AZ DB cluster, you can replace the Multi\-AZ DB cluster without changing any application code that references the Multi\-AZ DB cluster\. In these cases, complete the following steps: - -1. Stop all traffic going to the Multi\-AZ DB cluster\. You can redirect traffic from accessing the databases on the Multi\-AZ DB cluster, or choose another way to prevent traffic from accessing your databases on the Multi\-AZ DB cluster\. - -1. Rename the existing Multi\-AZ DB cluster\. - -1. Create a new Multi\-AZ DB cluster by restoring from a DB cluster snapshot or recovering to a point in time\. Then, give the new Multi\-AZ DB cluster the name of the previous Multi\-AZ DB cluster\. - -If you delete the old Multi\-AZ DB cluster, you are responsible for deleting any unwanted DB cluster snapshots of the old Multi\-AZ DB cluster\. - -## Console - -**To rename a Multi\-AZ DB cluster** - -1. Sign in to the AWS Management Console and open the Amazon RDS console at [https://console\.aws\.amazon\.com/rds/](https://console.aws.amazon.com/rds/)\. - -1. In the navigation pane, choose **Databases**\. - -1. Choose the Multi\-AZ DB cluster that you want to rename\. - -1. Choose **Modify**\. - -1. In **Settings**, enter a new name for **DB cluster identifier**\. - -1. Choose **Continue**\. - -1. To apply the changes immediately, choose **Apply immediately**\. Choosing this option can cause an outage in some cases\. For more information, see [Applying changes immediately](modify-multi-az-db-cluster.md#modify-multi-az-db-cluster-apply-immediately)\. - -1. On the confirmation page, review your changes\. If they are correct, choose **Modify cluster** to save your changes\. - - Alternatively, choose **Back** to edit your changes, or choose **Cancel** to discard your changes\. - -## AWS CLI - -To rename a Multi\-AZ DB cluster, use the AWS CLI command [ modify\-db\-cluster](https://docs.aws.amazon.com/cli/latest/reference/rds/modify-db-cluster.html)\. Provide the current `--db-cluster-identifier` value and `--new-db-cluster-identifier` parameter with the new name of the Multi\-AZ DB cluster\. - -**Example** -For Linux, macOS, or Unix: - -``` -1. aws rds modify-db-cluster \ -2. --db-cluster-identifier DBClusterIdentifier \ -3. --new-db-cluster-identifier NewDBClusterIdentifier -``` -For Windows: - -``` -1. aws rds modify-db-cluster ^ -2. --db-cluster-identifier DBClusterIdentifier ^ -3. --new-db-cluster-identifier NewDBClusterIdentifier -``` - -## RDS API - -To rename a Multi\-AZ DB cluster, call the Amazon RDS API operation [ ModifyDBCluster](https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_ModifyDBCluster.html) with the following parameters: -+ `DBClusterIdentifier` – The existing name of the DB cluster\. -+ `NewDBClusterIdentifier` – The new name of the DB cluster\. \ No newline at end of file diff --git a/doc_source/multi-az-db-clusters-concepts-connection-management.md b/doc_source/multi-az-db-clusters-concepts-connection-management.md deleted file mode 100644 index b76c58b..0000000 --- a/doc_source/multi-az-db-clusters-concepts-connection-management.md +++ /dev/null @@ -1,79 +0,0 @@ -# Connecting to a Multi\-AZ DB cluster - - A Multi\-AZ DB cluster has three DB instances instead of a single DB instance\. Each connection is handled by a specific DB instance\. When you connect to a Multi\-AZ DB cluster, the hostname and port that you specify point to a fully qualified domain name called an *endpoint*\. The Multi\-AZ DB cluster uses the endpoint mechanism to abstract these connections so that you don't need to specify exactly which DB instance in the DB cluster to connect to\. Thus, you don't have to hardcode all the hostnames or write your own logic for rerouting connections when some DB instances aren't available\. - -The writer endpoint connects to the writer DB instance of the DB cluster, which supports both read and write operations\. The reader endpoint connects to either of the two reader DB instances, which support only read operations\. - - Using endpoints, you can map each connection to the appropriate DB instance or group of DB instances based on your use case\. For example, to perform DDL and DML statements, you can connect to whichever DB instance is the writer DB instance\. To perform queries, you can connect to the reader endpoint, with the Multi\-AZ DB cluster automatically managing connections among the reader DB instances\. For diagnosis or tuning, you can connect to a specific DB instance endpoint to examine details about a specific DB instance\. - -For information about connecting to a DB instance, see [Connecting to an Amazon RDS DB instance](CHAP_CommonTasks.Connect.md)\. - -**Topics** -+ [Types of Multi\-AZ DB cluster endpoints](#multi-az-db-clusters-concepts-connection-management-endpoint-types) -+ [Viewing the endpoints for a Multi\-AZ DB cluster](#multi-az-db-clusters-concepts-connection-management-viewing) -+ [Using the cluster endpoint](#multi-az-db-clusters-concepts-connection-management-endpoints-cluster) -+ [Using the reader endpoint](#multi-az-db-clusters-concepts-connection-management-endpoints-reader) -+ [Using the instance endpoints](#multi-az-db-clusters-concepts-connection-management-endpoints-instance) -+ [How Multi\-AZ DB endpoints work with high availability](#multi-az-db-clusters-concepts-connection-management-endpoints-ha) - -## Types of Multi\-AZ DB cluster endpoints - - An endpoint is represented by a unique identifier that contains a host address\. The following types of endpoints are available from a Multi\-AZ DB cluster: - -**Cluster endpoint** - A *cluster endpoint* \(or *writer endpoint*\) for a Multi\-AZ DB cluster connects to the current writer DB instance for that DB cluster\. This endpoint is the only one that can perform write operations such as DDL and DML statements\. This endpoint can also perform read operations\. - Each Multi\-AZ DB cluster has one cluster endpoint and one writer DB instance\. - You use the cluster endpoint for all write operations on the DB cluster, including inserts, updates, deletes, and DDL changes\. You can also use the cluster endpoint for read operations, such as queries\. - If the current writer DB instance of a DB cluster fails, the Multi\-AZ DB cluster automatically fails over to a new writer DB instance\. During a failover, the DB cluster continues to serve connection requests to the cluster endpoint from the new writer DB instance, with minimal interruption of service\. - The following example illustrates a cluster endpoint for a Multi\-AZ DB cluster\. - `mydbcluster.cluster-123456789012.us-east-1.rds.amazonaws.com` - -**Reader endpoint** - A *reader endpoint* for a Multi\-AZ DB cluster provides support for read\-only connections to the DB cluster\. Use the reader endpoint for read operations, such as `SELECT` queries\. By processing those statements on the reader DB instances, this endpoint reduces the overhead on the writer DB instance\. It also helps the cluster to scale the capacity to handle simultaneous `SELECT` queries\. Each Multi\-AZ DB cluster has one reader endpoint\. - The reader endpoint sends each connection request to one of the reader DB instances\. When you use the reader endpoint for a session, you can only perform read\-only statements such as `SELECT` in that session\. - The following example illustrates a reader endpoint for a Multi\-AZ DB cluster\. The read\-only intent of a reader endpoint is denoted by the `-ro` within the cluster endpoint name\. - `mydbcluster.cluster-ro-123456789012.us-east-1.rds.amazonaws.com` - -**Instance endpoint** - An *instance endpoint* connects to a specific DB instance within a Multi\-AZ DB cluster\. Each DB instance in a DB cluster has its own unique instance endpoint\. So there is one instance endpoint for the current writer DB instance of the DB cluster, and there is one instance endpoint for each of the reader DB instances in the DB cluster\. - The instance endpoint provides direct control over connections to the DB cluster\. This control can help you address scenarios where using the cluster endpoint or reader endpoint might not be appropriate\. For example, your client application might require more fine\-grained load balancing based on workload type\. In this case, you can configure multiple clients to connect to different reader DB instances in a DB cluster to distribute read workloads\. - The following example illustrates an instance endpoint for a DB instance in a Multi\-AZ DB cluster\. - `mydbinstance.123456789012.us-east-1.rds.amazonaws.com` - -## Viewing the endpoints for a Multi\-AZ DB cluster - - In the AWS Management Console, you see the cluster endpoint and the reader endpoint on the details page for each Multi\-AZ DB cluster\. You see the instance endpoint in the details page for each DB instance\. - - With the AWS CLI, you see the writer and reader endpoints in the output of the [describe\-db\-clusters](https://docs.aws.amazon.com/cli/latest/reference/rds/describe-db-clusters.html) command\. For example, the following command shows the endpoint attributes for all clusters in your current AWS Region\. - -``` -aws rds describe-db-cluster-endpoints -``` - - With the Amazon RDS API, you retrieve the endpoints by calling the [DescribeDBClusterEndpoints](https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_DescribeDBClusterEndpoints.html) action\. The output also shows Amazon Aurora DB cluster endpoints, if any exist\. - -## Using the cluster endpoint - -Each Multi\-AZ DB cluster has a single built\-in cluster endpoint, whose name and other attributes are managed by Amazon RDS\. You can't create, delete, or modify this kind of endpoint\. - - You use the cluster endpoint when you administer your DB cluster, perform extract, transform, load \(ETL\) operations, or develop and test applications\. The cluster endpoint connects to the writer DB instance of the cluster\. The writer DB instance is the only DB instance where you can create tables and indexes, run `INSERT` statements, and perform other DDL and DML operations\. - - The physical IP address pointed to by the cluster endpoint changes when the failover mechanism promotes a new DB instance to be the writer DB instance for the cluster\. If you use any form of connection pooling or other multiplexing, be prepared to flush or reduce the time\-to\-live for any cached DNS information\. Doing so ensures that you don't try to establish a read/write connection to a DB instance that became unavailable or is now read\-only after a failover\. - -## Using the reader endpoint - - You use the reader endpoint for read\-only connections to your Multi\-AZ DB cluster\. This endpoint helps your DB cluster handle a query\-intensive workload\. The reader endpoint is the endpoint that you supply to applications that do reporting or other read\-only operations on the cluster\. The reader endpoint sends connections to available reader DB instances in a Multi\-AZ DB cluster\. - - Each Multi\-AZ cluster has a single built\-in reader endpoint, whose name and other attributes are managed by Amazon RDS\. You can't create, delete, or modify this kind of endpoint\. - -## Using the instance endpoints - - Each DB instance in a Multi\-AZ DB cluster has its own built\-in instance endpoint, whose name and other attributes are managed by Amazon RDS\. You can't create, delete, or modify this kind of endpoint\. With a Multi\-AZ DB cluster, you typically use the writer and reader endpoints more often than the instance endpoints\. - -In day\-to\-day operations, the main way that you use instance endpoints is to diagnose capacity or performance issues that affect one specific DB instance in a Multi\-AZ DB cluster\. While connected to a specific DB instance, you can examine its status variables, metrics, and so on\. Doing this can help you determine what's happening for that DB instance that's different from what's happening for other DB instances in the cluster\. - -## How Multi\-AZ DB endpoints work with high availability - -For Multi\-AZ DB clusters where high availability is important, use the writer endpoint for read/write or general\-purpose connections and the reader endpoint for read\-only connections\. The writer and reader endpoints manage DB instance failover better than instance endpoints do\. Unlike the instance endpoints, the writer and reader endpoints automatically change which DB instance they connect to if a DB instance in your cluster becomes unavailable\. - - If the writer DB instance of a DB cluster fails, Amazon RDS automatically fails over to a new writer DB instance\. It does so by promoting a reader DB instance to a new writer DB instance\. If a failover occurs, you can use the writer endpoint to reconnect to the newly promoted writer DB instance\. Or you can use the reader endpoint to reconnect to one of the reader DB instances in the DB cluster\. During a failover, the reader endpoint might direct connections to the new writer DB instance of a DB cluster for a short time after a reader DB instance is promoted to the new writer DB instance\. If you design your own application logic to manage instance endpoint connections, you can manually or programmatically discover the resulting set of available DB instances in the DB cluster\. \ No newline at end of file diff --git a/doc_source/multi-az-db-clusters-concepts-rebooting.md b/doc_source/multi-az-db-clusters-concepts-rebooting.md deleted file mode 100644 index 807b15f..0000000 --- a/doc_source/multi-az-db-clusters-concepts-rebooting.md +++ /dev/null @@ -1,42 +0,0 @@ -# Rebooting a Multi\-AZ DB cluster and reader DB instances - -You might need to reboot your Multi\-AZ DB cluster, usually for maintenance reasons\. For example, if you make certain modifications or change the DB cluster parameter group associated with a DB cluster, you reboot the DB cluster\. Doing so causes the changes to take effect\. - -If a DB cluster isn't using the latest changes to its associated DB cluster parameter group, the AWS Management Console shows the DB cluster parameter group with a status of **pending\-reboot**\. The **pending\-reboot** parameter groups status doesn't result in an automatic reboot during the next maintenance window\. To apply the latest parameter changes to that DB cluster, manually reboot the DB cluster\. For more information about parameter groups, see [Working with parameter groups for Multi\-AZ DB clusters](multi-az-db-clusters-concepts.md#multi-az-db-clusters-concepts-parameter-groups)\. - -Rebooting a DB cluster restarts the database engine service\. Rebooting a DB cluster results in a momentary outage, during which the DB cluster status is set to **rebooting**\. - -You can't reboot your DB cluster if it isn't in the **Available** state\. Your database can be unavailable for several reasons, such as an in\-progress backup, a previously requested modification, or a maintenance\-window action\. - -The time required to reboot your DB cluster depends on the crash recovery process, the database activity at the time of reboot, and the behavior of your specific DB cluster\. To improve the reboot time, we recommend that you reduce database activity as much as possible during the reboot process\. Reducing database activity reduces rollback activity for in\-transit transactions\. - -**Important** -Multi\-AZ DB clusters don't support reboot with a failover\. When you reboot the writer instance of a Multi\-AZ DB cluster, it doesn't affect the reader DB instances in that DB cluster and no failover occurs\. When you reboot a reader DB instance, no failover occurs\. To fail over a Multi\-AZ DB cluster, choose **Failover** in the console, call the AWS CLI command [https://docs.aws.amazon.com/cli/latest/reference/rds/failover-db-cluster.html](https://docs.aws.amazon.com/cli/latest/reference/rds/failover-db-cluster.html), or call the API operation [https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_FailoverDBCluster.html](https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_FailoverDBCluster.html)\. - -## Console - -**To reboot a DB cluster** - -1. Sign in to the AWS Management Console and open the Amazon RDS console at [https://console\.aws\.amazon\.com/rds/](https://console.aws.amazon.com/rds/)\. - -1. In the navigation pane, choose **Databases**, and then choose the Multi\-AZ DB cluster that you want to reboot\. - -1. For **Actions**, choose **Reboot**\. - - The **Reboot DB cluster** page appears\. - -1. Choose **Reboot** to reboot your DB cluster\. - - Or choose **Cancel**\. - -## AWS CLI - -To reboot a Multi\-AZ DB cluster by using the AWS CLI, call the [reboot\-db\-cluster](https://docs.aws.amazon.com/cli/latest/reference/rds/reboot-db-cluster.html) command\. - -``` -aws rds reboot-db-cluster --db-cluster-identifier mymultiazdbcluster -``` - -## RDS API - -To reboot a Multi\-AZ DB cluster by using the Amazon RDS API, call the [RebootDBCluster](https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_RebootDBCluster.html) operation\. \ No newline at end of file diff --git a/doc_source/multi-az-db-clusters-concepts.md b/doc_source/multi-az-db-clusters-concepts.md deleted file mode 100644 index c63f1cd..0000000 --- a/doc_source/multi-az-db-clusters-concepts.md +++ /dev/null @@ -1,266 +0,0 @@ -# Multi\-AZ DB cluster deployments - -A *Multi\-AZ DB cluster deployment* is a semisynchronous, high availability deployment mode of Amazon RDS with two readable standby DB instances\. A Multi\-AZ DB cluster has a writer DB instance and two reader DB instances in three separate Availability Zones in the same AWS Region\. Multi\-AZ DB clusters provide high availability, increased capacity for read workloads, and lower write latency when compared to Multi\-AZ DB instance deployments\. - -You can import data from an on\-premises database to a Multi\-AZ DB cluster by following the instructions in [Importing data to an Amazon RDS MariaDB or MySQL database with reduced downtime](MySQL.Procedural.Importing.NonRDSRepl.md)\. - -You can purchase reserved DB instances for a Multi\-AZ DB cluster\. For more information, see [Reserved DB instances for a Multi\-AZ DB cluster](USER_WorkingWithReservedDBInstances.md#USER_WorkingWithReservedDBInstances.MultiAZDBClusters)\. - -**Topics** -+ [Region and version availability](#multi-az-db-clusters-concepts.RegionVersionAvailability) -+ [Instance class availability](#multi-az-db-clusters-concepts.InstanceAvailability) -+ [Overview of Multi\-AZ DB clusters](#multi-az-db-clusters-concepts-overview) -+ [Limitations for Multi\-AZ DB clusters](#multi-az-db-clusters-concepts.Limitations) -+ [Managing a Multi\-AZ DB cluster with the AWS Management Console](#multi-az-db-clusters-concepts-managing-console) -+ [Working with parameter groups for Multi\-AZ DB clusters](#multi-az-db-clusters-concepts-parameter-groups) -+ [Replica lag and Multi\-AZ DB clusters](#multi-az-db-clusters-concepts-replica-lag) -+ [Failover process for Multi\-AZ DB clusters](#multi-az-db-clusters-concepts-failover) -+ [Creating a Multi\-AZ DB cluster](create-multi-az-db-cluster.md) -+ [Connecting to a Multi\-AZ DB cluster](multi-az-db-clusters-concepts-connection-management.md) -+ [Connecting an EC2 instance and a Multi\-AZ DB cluster automatically](multiaz-ec2-rds-connect.md) -+ [Modifying a Multi\-AZ DB cluster](modify-multi-az-db-cluster.md) -+ [Renaming a Multi\-AZ DB cluster](multi-az-db-cluster-rename.md) -+ [Rebooting a Multi\-AZ DB cluster and reader DB instances](multi-az-db-clusters-concepts-rebooting.md) -+ [Working with Multi\-AZ DB cluster read replicas](USER_MultiAZDBCluster_ReadRepl.md) -+ [Deleting a Multi\-AZ DB cluster](USER_DeleteMultiAZDBCluster.Deleting.md) - -**Important** -Multi\-AZ DB clusters aren't the same as Aurora DB clusters\. For information about Aurora DB clusters, see the [Amazon Aurora User Guide](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/CHAP_AuroraOverview.html)\. - -## Region and version availability - -Feature availability and support varies across specific versions of each database engine, and across AWS Regions\. For more information on version and Region availability of Amazon RDS with Multi\-AZ DB clusters, see [Multi\-AZ DB clusters](Concepts.RDS_Fea_Regions_DB-eng.Feature.MultiAZDBClusters.md)\. - -## Instance class availability - -Multi\-AZ DB cluster deployments are supported for a subset of DB instance classes\. For a list of supported instance classes, see the **DB instance class** row in [Settings for creating Multi\-AZ DB clusters](create-multi-az-db-cluster.md#create-multi-az-db-cluster-settings)\. - -For more information about DB instance classes, see [DB instance classes](Concepts.DBInstanceClass.md)\. - -## Overview of Multi\-AZ DB clusters - -With a Multi\-AZ DB cluster, Amazon RDS replicates data from the writer DB instance to both of the reader DB instances using the DB engine's native replication capabilities\. When a change is made on the writer DB instance, it's sent to each reader DB instance\. - -Multi\-AZ DB cluster deployments use semisynchronous replication, which requires acknowledgment from at least one reader DB instance in order for a change to be committed\. It doesn't require acknowledgment that events have been fully executed and committed on *all* replicas\. - -Reader DB instances act as automatic failover targets and also serve read traffic to increase application read throughput\. If an outage occurs on your writer DB instance, RDS manages failover to one of the reader DB instances\. RDS does this based on which reader DB instance has the most recent change record\. - -The following diagram shows a Multi\-AZ DB cluster\. - -![\[Multi-AZ DB cluster\]](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/images/multi-az-db-cluster.png) - -Multi\-AZ DB clusters typically have lower write latency when compared to Multi\-AZ DB instance deployments\. They also allow read\-only workloads to run on reader DB instances\. The RDS console shows the Availability Zone of the writer DB instance and the Availability Zones of the reader DB instances\. You can also use the [describe\-db\-clusters](https://docs.aws.amazon.com/cli/latest/reference/rds/describe-db-clusters.html) CLI command or the [DescribeDBClusters](https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_DescribeDBClusters.html) API operation to find this information\. - -**Important** -To prevent replication errors in RDS for MySQL Multi\-AZ DB clusters, we strongly recommend that all tables have a primary key\. - -## Limitations for Multi\-AZ DB clusters - -The following limitations apply to Multi\-AZ DB clusters: -+ Multi\-AZ DB clusters only support Provisioned IOPS storage\. -+ You can't change a Single\-AZ DB instance deployment or Multi\-AZ DB instance deployment into a Multi\-AZ DB cluster\. As an alternative, you can restore a snapshot of a Single\-AZ DB instance deployment or Multi\-AZ DB instance deployment to a Multi\-AZ DB cluster\. -+ You can't change a Multi\-AZ DB cluster deployment into a Single\-AZ DB instance or Multi\-AZ DB instance\. As an alternative, you can restore a snapshot of a Multi\-AZ DB cluster deployment to a Single\-AZ DB instance deployment or Multi\-AZ DB instance deployment\. -+ Multi\-AZ DB clusters don't support modifications at the DB instance level because all modifications are done at the DB cluster level\. -+ Multi\-AZ DB clusters don't support the following features: - + Amazon RDS Proxy - + Support for IPv6 connections \(dual\-stack mode\) - + Cross\-Region automated backups - + Exporting Multi\-AZ DB cluster snapshot data to an Amazon S3 bucket - + IAM DB authentication - + Kerberos authentication - + Modifying the port - - As an alternative, you can restore a Multi\-AZ DB cluster to a point in time and specify a different port\. - + Option groups - + Point\-in\-time\-recovery \(PITR\) for deleted clusters - + Reserved DB instances - + Restoring a Multi\-AZ DB cluster snapshot from an Amazon S3 bucket - + Storage autoscaling by setting the maximum allocated storage - - As an alternative, you can scale storage manually\. - + Stopping and starting the DB cluster - + Copying a snapshot of a Multi\-AZ DB cluster - + Encrypting an unencrypted Multi\-AZ DB cluster -+ RDS for MySQL Multi\-AZ DB clusters don't support replication to an external target database\. -+ RDS for MySQL Multi\-AZ DB clusters support only the following system stored procedures: - + `mysql.rds_rotate_general_log` - + `mysql.rds_rotate_slow_log` - + `mysql.rds_show_configuration` - - RDS for MySQL Multi\-AZ DB clusters don't support other system stored procedures\. For information about these procedures, see [RDS for MySQL stored procedure reference](Appendix.MySQL.SQLRef.md)\. -+ RDS for PostgreSQL Multi\-AZ DB clusters don't support the following PostgreSQL extensions: `aws_s3`, `pg_transport`, and `pglogical`\. -+ RDS for PostgreSQL Multi\-AZ DB clusters don't support using a custom DNS server for outbound network access\. -+ RDS for PostgreSQL Multi\-AZ DB clusters don't support logical replication\. - -## Managing a Multi\-AZ DB cluster with the AWS Management Console - -You can manage a Multi\-AZ DB cluster with the console\. - -**To manage a Multi\-AZ DB cluster with the console** - -1. Sign in to the AWS Management Console and open the Amazon RDS console at [https://console\.aws\.amazon\.com/rds/](https://console.aws.amazon.com/rds/)\. - -1. In the navigation pane, choose **Databases**, and then choose the Multi\-AZ DB cluster that you want to manage\. - -The following image shows a Multi\-AZ DB cluster in the console\. - -![\[Multi-AZ DB cluster in the AWS Management Console\]](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/images/multi-az-db-cluster-view-console-postgresql.png) - -The available actions in the **Actions** menu depend on whether the Multi\-AZ DB cluster is selected or a DB instance in the cluster is selected\. - -Choose the Multi\-AZ DB cluster to view the cluster details and perform actions at the cluster level\. - -![\[Multi-AZ DB cluster actions in the AWS Management Console\]](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/images/multi-az-db-cluster-actions-console-postgresql.png) - -Choose a DB instance in a Multi\-AZ DB cluster to view the DB instance details and perform actions at the DB instance level\. - -![\[DB instance actions in a Multi-AZ DB cluster in the AWS Management Console\]](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/images/multi-az-db-cluster-instance-actions-console-postgresql.png) - -## Working with parameter groups for Multi\-AZ DB clusters - -In a Multi\-AZ DB cluster, a *DB cluster parameter group* acts as a container for engine configuration values that are applied to every DB instance in the Multi\-AZ DB cluster\. - -In a Multi\-AZ DB cluster, a *DB parameter group* is set to the default DB parameter group for the DB engine and DB engine version\. The settings in the DB cluster parameter group are used for all of the DB instances in the cluster\. - -For information about parameter groups, see [Working with parameter groups](USER_WorkingWithParamGroups.md)\. - -## Replica lag and Multi\-AZ DB clusters - -*Replica lag* is the difference in time between the latest transaction on the writer DB instance and the latest applied transaction on a reader DB instance\. The Amazon CloudWatch metric `ReplicaLag` represents this time difference\. For more information about CloudWatch metrics, see [Monitoring Amazon RDS metrics with Amazon CloudWatch](monitoring-cloudwatch.md)\. - -Although Multi\-AZ DB clusters allow for high write performance, replica lag can still occur due to the nature of engine\-based replication\. Because any failover must first resolve the replica lag before it promotes a new writer DB instance, monitoring and managing this replica lag is a consideration\. - -For RDS for MySQL Multi\-AZ DB clusters, failover time depends on replica lag of both remaining reader DB instances\. Both the reader DB instances must apply unapplied transactions before one of them is promoted to the new writer DB instance\. - -For RDS for PostgreSQL Multi\-AZ DB clusters, failover time depends on the lowest replica lag of the two remaining reader DB instances\. The reader DB instance with the lowest replica lag must apply unapplied transactions before it is promoted to the new writer DB instance\. - -For a tutorial that shows you how to create a CloudWatch alarm when replica lag exceeds a set amount of time, see [Tutorial: Creating an Amazon CloudWatch alarm for Multi\-AZ DB cluster replica lag](multi-az-db-cluster-cloudwatch-alarm.md)\. - -### Common causes of replica lag - -In general, replica lag occurs when the write workload is too high for the reader DB instances to apply the transactions efficiently\. Various workloads can incur temporary or continuous replica lag\. Some examples of common causes are the following: -+ High write concurrency or heavy batch updating on the writer DB instance, causing the apply process on the reader DB instances to fall behind\. -+ Heavy read workload that is using resources on one or more reader DB instances\. Running slow or large queries can affect the apply process and can cause replica lag\. -+ Transactions that modify large amounts of data or DDL statements can sometimes cause a temporary increase in replica lag because the database must preserve commit order\. - -### Mitigating replica lag - -For Multi\-AZ DB clusters for RDS for MySQL and RDS for PostgreSQL, you can mitigate replica lag by reducing the load on your writer DB instance\. You can also use flow control to reduce replica lag\. *Flow control* works by throttling writes on the writer DB instance, which ensures that replica lag doesn't continue to grow unbounded\. Write throttling is accomplished by adding a delay into the end of a transaction, which decreases the write throughput on the writer DB instance\. Although flow control doesn't guarantee lag elimination, it can help reduce overall lag in many workloads\. The following sections provide information about using flow control with RDS for MySQL and RDS for PostgreSQL\. - -#### Mitigating replica lag with flow control for RDS for MySQL - -When you are using RDS for MySQL Multi\-AZ DB clusters, flow control is turned on by default using the dynamic parameter `rpl_semi_sync_master_target_apply_lag`\. This parameter specifies the upper limit that you want for replica lag\. As replica lag approaches this configured limit, flow control throttles the write transactions on the writer DB Instance to try to contain the replica lag below the specified value\. In some cases, replica lag can exceed the specified limit\. By default, this parameter is set to 120 seconds\. To turn off flow control, set this parameter to its maximum value of 86400 seconds \(one day\)\. - -To view the current delay injected by flow control, show the parameter `Rpl_semi_sync_master_flow_control_current_delay` by running the following query\. - -``` -SHOW GLOBAL STATUS like '%flow_control%'; -``` - -Your output looks similar to the following\. - -``` -+-------------------------------------------------+-------+ -| Variable_name | Value | -+-------------------------------------------------+-------+ -| Rpl_semi_sync_master_flow_control_current_delay | 2010 | -+-------------------------------------------------+-------+ -1 row in set (0.00 sec) -``` - -**Note** -The delay is shown in microseconds\. - -When you have Performance Insights turned on for an RDS for MySQL Multi\-AZ DB cluster, you can monitor the wait event corresponding to a SQL statement indicating that the queries were delayed by a flow control\. When a delay was introduced by a flow control, you can view the wait event `/wait/synch/cond/semisync/semi_sync_flow_control_delay_cond` corresponding to the SQL statement on the Performance Insights dashboard\. To view these metrics, make sure that the Performance Schema is turned on\. For information about Performance Insights, see [Monitoring DB load with Performance Insights on Amazon RDS](USER_PerfInsights.md)\. - -#### Mitigating replica lag with flow control for RDS for PostgreSQL - -When you are using RDS for PostgreSQL Multi\-AZ DB clusters, flow control is deployed as an extension\. It turns on a background worker for all DB instances in the DB cluster\. By default, the background workers on the reader DB instances communicate the current replica lag with the background worker on the writer DB instance\. If the lag exceeds two minutes on any reader DB instance, the background worker on the writer DB instance adds a delay at the end of a transaction\. To control the lag threshold, use the parameter `flow_control.target_standby_apply_lag`\. - -When a flow control throttles a PostgreSQL process, the `Extension` wait event in `pg_stat_activity` and Performance Insights indicates that\. The function `get_flow_control_stats` displays details about how much delay is currently being added\. - -Flow control can benefit most online transaction processing \(OLTP\) workloads that have short but highly concurrent transactions\. If the lag is caused by long\-running transactions, such as batch operations, flow control doesn't provide as strong a benefit\. - -You can turn off flow control by removing the extension from the `preload_shared_libraries` and rebooting your DB instance\. - -## Failover process for Multi\-AZ DB clusters - -If there is a planned or unplanned outage of your writer DB instance in a Multi\-AZ DB cluster, Amazon RDS automatically fails over to a reader DB instance in different Availability Zone\. The time it takes for the failover to complete depends on the database activity and other conditions when the writer DB instance became unavailable\. Failover times are typically under 35 seconds\. Failover completes when both reader DB instances have applied outstanding transactions from the failed writer\. When the failover is complete, it can take additional time for the RDS console to reflect the new Availability Zone\. - -**Topics** -+ [Automatic failovers](#multi-az-db-clusters-concepts-failover-automatic) -+ [Manually failing over a Multi\-AZ DB cluster](#multi-az-db-clusters-concepts-failover-manual) -+ [Determining whether a Multi\-AZ DB cluster has failed over](#multi-az-db-clusters-concepts-failover-determining) -+ [Setting the JVM TTL for DNS name lookups](#multi-az-db-clusters-concepts-failover-java-dns) - -### Automatic failovers - -Amazon RDS handles failovers automatically so you can resume database operations as quickly as possible without administrative intervention\. To fail over, the writer DB instance switches automatically to a reader DB instance\. - -### Manually failing over a Multi\-AZ DB cluster - -You can fail over a Multi\-AZ DB cluster manually using the AWS Management Console, the AWS CLI, or the RDS API\. - -#### Console - -**To fail over a Multi\-AZ DB cluster manually** - -1. Sign in to the AWS Management Console and open the Amazon RDS console at [https://console\.aws\.amazon\.com/rds/](https://console.aws.amazon.com/rds/)\. - -1. In the navigation pane, choose **Databases**\. - -1. Choose the Multi\-AZ DB cluster that you want to fail over\. - -1. For **Actions**, choose **Failover**\. - - The **Failover DB Cluster** page appears\. - -1. Choose **Failover** to confirm the manual failover\. - -#### AWS CLI - -To fail over a Multi\-AZ DB cluster manually, use the AWS CLI command [ failover\-db\-cluster](https://docs.aws.amazon.com/cli/latest/reference/rds/failover-db-cluster.html)\. - -**Example** - -``` -1. aws rds failover-db-cluster --db-cluster-identifier mymultiazdbcluster -``` - -#### RDS API - -To fail over a Multi\-AZ DB cluster manually, call the Amazon RDS API [FailoverDBCluster](https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_FailoverDBCluster.html) and specify the `DBClusterIdentifier`\. - -### Determining whether a Multi\-AZ DB cluster has failed over - -To determine if your Multi\-AZ DB cluster has failed over, you can do the following: -+ Set up DB event subscriptions to notify you by email or SMS that a failover has been initiated\. For more information about events, see [Working with Amazon RDS event notification](USER_Events.md)\. -+ View your DB events by using the Amazon RDS console or API operations\. -+ View the current state of your Multi\-AZ DB cluster by using the Amazon RDS console, the AWS CLI, and the RDS API\. - -For information on how you can respond to failovers, reduce recovery time, and other best practices for Amazon RDS, see [Best practices for Amazon RDS](CHAP_BestPractices.md)\. - -### Setting the JVM TTL for DNS name lookups - -The failover mechanism automatically changes the Domain Name System \(DNS\) record of the DB instance to point to the reader DB instance\. As a result, you need to re\-establish any existing connections to your DB instance\. In a Java virtual machine \(JVM\) environment, due to how the Java DNS caching mechanism works, you might need to reconfigure JVM settings\. - -The JVM caches DNS name lookups\. When the JVM resolves a host name to an IP address, it caches the IP address for a specified period of time, known as the *time\-to\-live* \(TTL\)\. - -Because AWS resources use DNS name entries that occasionally change, we recommend that you configure your JVM with a TTL value of no more than 60 seconds\. Doing this makes sure that when a resource's IP address changes, your application can receive and use the resource's new IP address by requerying the DNS\. - -On some Java configurations, the JVM default TTL is set so that it never refreshes DNS entries until the JVM is restarted\. Thus, if the IP address for an AWS resource changes while your application is still running, it can't use that resource until you manually restart the JVM and the cached IP information is refreshed\. In this case, it's crucial to set the JVM's TTL so that it periodically refreshes its cached IP information\. - -**Note** -The default TTL can vary according to the version of your JVM and whether a security manager is installed\. Many JVMs provide a default TTL less than 60 seconds\. If you're using such a JVM and not using a security manager, you can ignore the rest of this topic\. For more information on security managers in Oracle, see [The security manager](https://docs.oracle.com/javase/tutorial/essential/environment/security.html) in the Oracle documentation\. - -To modify the JVM's TTL, set the [https://docs.oracle.com/javase/7/docs/technotes/guides/net/properties.html](https://docs.oracle.com/javase/7/docs/technotes/guides/net/properties.html) property value\. Use one of the following methods, depending on your needs: -+ To set the property value globally for all applications that use the JVM, set `networkaddress.cache.ttl` in the `$JAVA_HOME/jre/lib/security/java.security` file\. - - ``` - networkaddress.cache.ttl=60 - ``` -+ To set the property locally for your application only, set `networkaddress.cache.ttl` in your application's initialization code before any network connections are established\. - - ``` - java.security.Security.setProperty("networkaddress.cache.ttl" , "60"); - ``` \ No newline at end of file diff --git a/doc_source/multiaz-ec2-rds-connect.md b/doc_source/multiaz-ec2-rds-connect.md deleted file mode 100644 index bdbfdc6..0000000 --- a/doc_source/multiaz-ec2-rds-connect.md +++ /dev/null @@ -1,113 +0,0 @@ -# Connecting an EC2 instance and a Multi\-AZ DB cluster automatically - -You can use the RDS console to simplify setting up a connection between an EC2 instance and a Multi\-AZ DB cluster\.You can use the RDS console to simplify setting up a connection between an EC2 instance and a Multi\-AZ DB cluster\. Often, your Multi\-AZ DB cluster is in a private subnet and your EC2 instance is in a public subnet within a VPC\. You can use a SQL client on your EC2 instance to connect to your Multi\-AZ DB cluster\. The EC2 instance can also run web servers or applications that access your private Multi\-AZ DB cluster\. - -![\[Automatically connect a Multi-AZ DB cluster with an EC2 instance.\]](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/images/multi-az-ec2-connect-overview.png) - -If you want to connect to an EC2 instance that isn't in the same VPC as the Multi\-AZ DB cluster, see the scenarios in [Scenarios for accessing a DB instance in a VPC](USER_VPC.Scenarios.md)\. - -**Topics** -+ [Overview of automatic connectivity with an EC2 instance](#multiaz-ec2-rds-connect-overview) -+ [Connecting an EC2 instance and a Multi\-AZ DB cluster automatically](#multiaz-ec2-rds-connect-connecting) -+ [Viewing connected compute resources](#multiaz-ec2-rds-connect-viewing) - -## Overview of automatic connectivity with an EC2 instance - -When you set up a connection between an EC2 instance and a Multi\-AZ DB cluster automatically, RDS configures the VPC security group for your EC2 instance and for your DB cluster\. - -The following are requirements for connecting an EC2 instance with a Multi\-AZ DB cluster: -+ The EC2 instance must exist in the same VPC as the Multi\-AZ DB cluster\. - - If no EC2 instances exist in the same VPC, the console provides a link to create one\. -+ The user who is setting up connectivity must have permissions to perform the following EC2 operations: - + `ec2:AuthorizeSecurityGroupEgress` - + `ec2:AuthorizeSecurityGroupIngress` - + `ec2:CreateSecurityGroup` - + `ec2:DescribeInstances` - + `ec2:DescribeNetworkInterfaces` - + `ec2:DescribeSecurityGroups` - + `ec2:ModifyNetworkInterfaceAttribute` - + `ec2:RevokeSecurityGroupEgress` - -When you set up a connection to an EC2 instance, RDS takes an action based on the current configuration of the security groups associated with the Multi\-AZ DB cluster and EC2 instance, as described in the following table\. - - -| Current RDS security group configuration | Current EC2 security group configuration | RDS action | -| --- | --- | --- | -| There are one or more security groups associated with the Multi\-AZ DB cluster with a name that matches the pattern `rds-ec2-n` \(where `n` is a number\)\. A security group that matches the pattern hasn't been modified\. This security group has only one inbound rule with the VPC security group of the EC2 instance as the source\. | There are one or more security groups associated with the EC2 instance with a name that matches the pattern `rds-ec2-n` \(where `n` is a number\)\. A security group that matches the pattern hasn't been modified\. This security group has only one outbound rule with the VPC security group of the Multi\-AZ DB cluster as the source\. | RDS takes no action\. A connection was already configured automatically between the EC2 instance and Multi\-AZ DB cluster\. Because a connection already exists between the EC2 instance and the RDS database, the security groups aren't modified\. | -| Either of the following conditions apply: [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/multiaz-ec2-rds-connect.html) | Either of the following conditions apply: [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/multiaz-ec2-rds-connect.html) | [RDS action: create new security groups](ec2-rds-connect.md#rds-action-create-new-security-groups) | -| There are one or more security groups associated with the Multi\-AZ DB cluster with a name that matches the pattern `rds-ec2-n`\. A security group that matches the pattern hasn't been modified\. This security group has only one inbound rule with the VPC security group of the EC2 instance as the source\. | There are one or more security groups associated with the EC2 instance with a name that matches the pattern `ec2-rds-n`\. However, none of these security groups can be used for the connection with the Multi\-AZ DB cluster\. A security group can't be used if it doesn't have one outbound rule with the VPC security group of the Multi\-AZ DB cluster as the source\. A security group also can't be used if it has been modified\. | [RDS action: create new security groups](ec2-rds-connect.md#rds-action-create-new-security-groups) | -| There are one or more security groups associated with the Multi\-AZ DB cluster with a name that matches the pattern `rds-ec2-n`\. A security group that matches the pattern hasn't been modified\. This security group has only one inbound rule with the VPC security group of the EC2 instance as the source\. | A valid EC2 security group for the connection exists, but it is not associated with the EC2 instance\. This security group has a name that matches the pattern `rds-ec2-n`\. It hasn't been modified\. It has only one outbound rule with the VPC security group of the Multi\-AZ DB cluster as the source\. | [RDS action: associate EC2 security group](ec2-rds-connect.md#rds-action-associate-ec2-security-group) | -| Either of the following conditions apply: [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/multiaz-ec2-rds-connect.html) | There are one or more security groups associated with the EC2 instance with a name that matches the pattern `rds-ec2-n`\. A security group that matches the pattern hasn't been modified\. This security group has only one outbound rule with the VPC security group of the Multi\-AZ DB cluster as the source\. | [RDS action: create new security groups](ec2-rds-connect.md#rds-action-create-new-security-groups) | - -**RDS action: create new security groups** -RDS takes the following actions: -+ Creates a new security group that matches the pattern `rds-ec2-n`\. This security group has an inbound rule with the VPC security group of the EC2 instance as the source\. This security group is associated with the Multi\-AZ DB cluster and allows the EC2 instance to access the Multi\-AZ DB cluster\. -+ Creates a new security group that matches the pattern `ec2-rds-n`\. This security group has an outbound rule with the VPC security group of the Multi\-AZ DB cluster as the source\. This security group is associated with the EC2 instance and allows the EC2 instance to send traffic to the Multi\-AZ DB cluster\. - -**RDS action: associate EC2 security group** -RDS associates the valid, existing EC2 security group with the EC2 instance\. This security group allows the EC2 instance to send traffic to the Multi\-AZ DB cluster\. - -## Connecting an EC2 instance and a Multi\-AZ DB cluster automatically - -Before setting up a connection between an EC2 instance and an RDS database, make sure you meet the requirements described in [Overview of automatic connectivity with an EC2 instance](ec2-rds-connect.md#ec2-rds-connect-overview)\. - -If you make changes to security groups after you configure connectivity, the changes might affect the connection between the EC2 instance and the RDS database\. - -**Note** -You can only set up a connection between an EC2 instance and an RDS database automatically by using the AWS Management Console\. You can't set up a connection automatically with the AWS CLI or RDS API\. - -**To connect an EC2 instance and an RDS database automatically** - -1. Sign in to the AWS Management Console and open the Amazon RDS console at [https://console\.aws\.amazon\.com/rds/](https://console.aws.amazon.com/rds/)\. - -1. In the navigation pane, choose **Databases**, and then choose the RDS database\. - -1. For **Actions**, choose **Set up EC2 connection**\. - - The **Set up EC2 connection** page appears\. - -1. On the **Set up EC2 connection** page, choose the EC2 instance\. -![\[Set up EC2 connection page.\]](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/images/auto-connect-rds-ec2-set-up.png) - - If no EC2 instances exist in the same VPC, choose **Create EC2 instance** to create one\. In this case, make sure the new EC2 instance is in the same VPC as the RDS database\. - -1. Choose **Continue**\. - - The **Review and confirm** page appears\. -![\[EC2 connection review and confirmation page.\]](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/images/auto-connect-rds-ec2-confirm.png) - -1. On the **Review and confirm** page, review the changes that RDS will make to set up connectivity with the EC2 instance\. - - If the changes are correct, choose **Confirm and set up**\. - - If the changes aren't correct, choose **Previous** or **Cancel**\. - -## Viewing connected compute resources - -You can use the AWS Management Console to view the compute resources that are connected to an RDS database\. The resources shown include compute resource connections that were set up automatically\. You can set up connectivity with compute resources automatically in the following ways: -+ You can select the compute resource when you create the database\. - - For more information, see [Creating an Amazon RDS DB instance](USER_CreateDBInstance.md) and [Creating a Multi\-AZ DB cluster](create-multi-az-db-cluster.md)\. -+ You can set up connectivity between an existing database and a compute resource\. - - For more information, see [Connecting an EC2 instance and an RDS database automatically](ec2-rds-connect.md#ec2-rds-connect-connecting)\. - -The listed compute resources don't include ones that were connected to the database manually\. For example, you can allow a compute resource to access a database manually by adding a rule to the VPC security group associated with the database\. - -For a compute resource to be listed, the following conditions must apply: -+ The name of the security group associated with the compute resource matches the pattern `ec2-rds-n` \(where `n` is a number\)\. -+ The security group associated with the compute resource has an outbound rule with the port range set to the port used by the RDS database\. -+ The security group associated with the compute resource has an outbound rule with the source set to a security group associated with the RDS database\. -+ The name of the security group associated with the RDS database matches the pattern `rds-ec2-n` \(where `n` is a number\)\. -+ The security group associated with the RDS database has an inbound rule with the port range set to the port used by the RDS database\. -+ The security group associated with the RDS database has an inbound rule with the source set to a security group associated with the compute resource\. - -**To connect an EC2 instance and an RDS database automatically** - -1. Sign in to the AWS Management Console and open the Amazon RDS console at [https://console\.aws\.amazon\.com/rds/](https://console.aws.amazon.com/rds/)\. - -1. In the navigation pane, choose **Databases**, and then choose the name of the RDS database\. - -1. On the **Connectivity & security** tab, view the compute resources in the **Connected compute resources**\. -![\[Connected compute resources.\]](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/images/ec2-connected-compute-resources.png) \ No newline at end of file diff --git a/doc_source/mysql-kerberos.md b/doc_source/mysql-kerberos.md deleted file mode 100644 index 07b8428..0000000 --- a/doc_source/mysql-kerberos.md +++ /dev/null @@ -1,281 +0,0 @@ -# Using Kerberos authentication for MySQL - - You can use Kerberos authentication to authenticate users when they connect to your MySQL DB instance\. The DB instance works with AWS Directory Service for Microsoft Active Directory \(AWS Managed Microsoft AD\) to enable Kerberos authentication\. When users authenticate with a MySQL DB instance joined to the trusting domain, authentication requests are forwarded\. Forwarded requests go to the domain directory that you create with AWS Directory Service\. - - Keeping all of your credentials in the same directory can save you time and effort\. With this approach, you have a centralized place for storing and managing credentials for multiple DB instances\. Using a directory can also improve your overall security profile\. - -## Region and version availability - -Feature availability and support varies across specific versions of each database engine, and across AWS Regions\. For more information on version and Region availability of Amazon RDS with Kerberos authentication, see [Kerberos authentication](Concepts.RDS_Fea_Regions_DB-eng.Feature.KerberosAuthentication.md)\. - -## Overview of Setting up Kerberos authentication for MySQL DB instances - - To set up Kerberos authentication for a MySQL DB instance, complete the following general steps, described in more detail later: - -1. Use AWS Managed Microsoft AD to create an AWS Managed Microsoft AD directory\. You can use the AWS Management Console, the AWS CLI, or the AWS Directory Service to create the directory\. For details about doing so, see [Create your AWS Managed Microsoft AD directory](https://docs.aws.amazon.com/directoryservice/latest/admin-guide/ms_ad_getting_started_create_directory.html) in the *AWS Directory Service Administration Guide*\. - -1. Create an AWS Identity and Access Management \(IAM\) role that uses the managed IAM policy `AmazonRDSDirectoryServiceAccess`\. The role allows Amazon RDS to make calls to your directory\. - - For the role to allow access, the AWS Security Token Service \(AWS STS\) endpoint must be activated in the AWS Region for your AWS account\. AWS STS endpoints are active by default in all AWS Regions, and you can use them without any further actions\. For more information, see [ Activating and deactivating AWS STS in an AWS Region](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp_enable-regions.html#sts-regions-activate-deactivate) in the *IAM User Guide*\. - -1. Create and configure users in the AWS Managed Microsoft AD directory using the Microsoft Active Directory tools\. For more information about creating users in your Active Directory, see [Manage users and groups in AWS managed Microsoft AD](https://docs.aws.amazon.com/directoryservice/latest/admin-guide/ms_ad_manage_users_groups.html) in the *AWS Directory Service Administration Guide*\. - -1. Create or modify a MySQL DB instance\. If you use either the CLI or RDS API in the create request, specify a domain identifier with the `Domain` parameter\. Use the `d-*` identifier that was generated when you created your directory and the name of the role that you created\. - - If you modify an existing MySQL DB instance to use Kerberos authentication, set the domain and IAM role parameters for the DB instance\. Locate the DB instance in the same VPC as the domain directory\. - -1. Use the Amazon RDS master user credentials to connect to the MySQL DB instance\. Create the user in MySQL using the `CREATE USER` clause `IDENTIFIED WITH 'auth_pam'`\. Users that you create this way can log in to the MySQL DB instance using Kerberos authentication\. - -## Setting up Kerberos authentication for MySQL DB instances - - You use AWS Managed Microsoft AD to set up Kerberos authentication for a MySQL DB instance\. To set up Kerberos authentication, you take the following steps\. - -### Step 1: Create a directory using AWS Managed Microsoft AD - - AWS Directory Service creates a fully managed Active Directory in the AWS Cloud\. When you create an AWS Managed Microsoft AD directory, AWS Directory Service creates two domain controllers and Domain Name System \(DNS\) servers on your behalf\. The directory servers are created in different subnets in a VPC\. This redundancy helps make sure that your directory remains accessible even if a failure occurs\. - - When you create an AWS Managed Microsoft AD directory, AWS Directory Service performs the following tasks on your behalf: -+ Sets up an Active Directory within the VPC\. -+ Creates a directory administrator account with the user name Admin and the specified password\. You use this account to manage your directory\. -**Note** - Be sure to save this password\. AWS Directory Service doesn't store it\. You can reset it, but you can't retrieve it\. -+ Creates a security group for the directory controllers\. - - When you launch an AWS Managed Microsoft AD, AWS creates an Organizational Unit \(OU\) that contains all of your directory's objects\. This OU has the NetBIOS name that you typed when you created your directory and is located in the domain root\. The domain root is owned and managed by AWS\. - - The Admin account that was created with your AWS Managed Microsoft AD directory has permissions for the most common administrative activities for your OU: -+ Create, update, or delete users -+ Add resources to your domain such as file or print servers, and then assign permissions for those resources to users in your OU -+ Create additional OUs and containers -+ Delegate authority -+ Restore deleted objects from the Active Directory Recycle Bin -+ Run AD and DNS Windows PowerShell modules on the Active Directory Web Service - - The Admin account also has rights to perform the following domain\-wide activities: -+ Manage DNS configurations \(add, remove, or update records, zones, and forwarders\) -+ View DNS event logs -+ View security event logs - -**To create a directory with AWS Managed Microsoft AD** - -1. Sign in to the AWS Management Console and open the AWS Directory Service console at [https://console\.aws\.amazon\.com/directoryservicev2/](https://console.aws.amazon.com/directoryservicev2/)\. - -1. In the navigation pane, choose **Directories** and choose **Set up Directory**\. - -1. Choose **AWS Managed Microsoft AD**\. AWS Managed Microsoft AD is the only option that you can currently use with Amazon RDS\. - -1. Enter the following information: -**Directory DNS name** - The fully qualified name for the directory, such as **corp\.example\.com**\. -**Directory NetBIOS name** - The short name for the directory, such as **CORP**\. -**Directory description** - \(Optional\) A description for the directory\. -**Admin password** - The password for the directory administrator\. The directory creation process creates an administrator account with the user name Admin and this password\. - The directory administrator password and can't include the word "admin\." The password is case\-sensitive and must be 8–64 characters in length\. It must also contain at least one character from three of the following four categories: - + Lowercase letters \(a–z\) - + Uppercase letters \(A–Z\) - + Numbers \(0–9\) - + Non\-alphanumeric characters \(\~\!@\#$%^&\*\_\-\+=`\|\\\(\)\{\}\[\]:;"'<>,\.?/\) -**Confirm password** - The administrator password retyped\. - -1. Choose **Next**\. - -1. Enter the following information in the **Networking** section and then choose **Next**: -**VPC** - The VPC for the directory\. Create the MySQL DB instance in this same VPC\. -**Subnets** - Subnets for the directory servers\. The two subnets must be in different Availability Zones\. - -1. Review the directory information and make any necessary changes\. When the information is correct, choose **Create directory**\. -![\[Directory details page during creation\]](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/images/WinAuth2.png) - - It takes several minutes for the directory to be created\. When it has been successfully created, the **Status** value changes to **Active**\. - - To see information about your directory, choose the directory name in the directory listing\. Note the **Directory ID** value because you need this value when you create or modify your MySQL DB instance\. - -![\[Directory details page\]](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/images/WinAuth3.png) - -### Step 2: Create the IAM role for use by Amazon RDS - -For Amazon RDS to call AWS Directory Service for you, an IAM role that uses the managed IAM policy `AmazonRDSDirectoryServiceAccess` is required\. This role allows Amazon RDS to make calls to the AWS Directory Service\. - -When a DB instance is created using the AWS Management Console and the console user has the `iam:CreateRole` permission, the console creates this role automatically\. In this case, the role name is `rds-directoryservice-kerberos-access-role`\. Otherwise, you must create the IAM role manually\. When you create this IAM role, choose `Directory Service`, and attach the AWS managed policy `AmazonRDSDirectoryServiceAccess` to it\. - -For more information about creating IAM roles for a service, see [Creating a role to delegate permissions to an AWS service](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_create_for-service.html) in the *IAM User Guide*\. - -**Note** -The IAM role used for Windows Authentication for RDS for SQL Server can't be used for RDS for MySQL\. - -Optionally, you can create policies with the required permissions instead of using the managed IAM policy `AmazonRDSDirectoryServiceAccess`\. In this case, the IAM role must have the following IAM trust policy\. - -``` -{ - "Version": "2012-10-17", - "Statement": [ - { - "Sid": "", - "Effect": "Allow", - "Principal": { - "Service": [ - "directoryservice.rds.amazonaws.com", - "rds.amazonaws.com" - ] - }, - "Action": "sts:AssumeRole" - } - ] -} -``` - -The role must also have the following IAM role policy\. - -``` -{ - "Version": "2012-10-17", - "Statement": [ - { - "Action": [ - "ds:DescribeDirectories", - "ds:AuthorizeApplication", - "ds:UnauthorizeApplication", - "ds:GetAuthorizedApplicationDetails" - ], - "Effect": "Allow", - "Resource": "*" - } - ] -} -``` - -### Step 3: Create and configure users - - You can create users with the Active Directory Users and Computers tool\. This tool is part of the Active Directory Domain Services and Active Directory Lightweight Directory Services tools\. Users represent individual people or entities that have access to your directory\. - - To create users in an AWS Directory Service directory, you must be connected to an Amazon EC2 instance based on Microsoft Windows\. This instance must be a member of the AWS Directory Service directory and be logged in as a user that has privileges to create users\. For more information, see [Manage users and groups in AWS Managed Microsoft AD](https://docs.aws.amazon.com/directoryservice/latest/admin-guide/creating_ad_users_and_groups.html) in the *AWS Directory Service Administration Guide*\. - -### Step 4: Create or modify a MySQL DB instance - -Create or modify a MySQL DB instance for use with your directory\. You can use the console, CLI, or RDS API to associate a DB instance with a directory\. You can do this in one of the following ways: -+ Create a new MySQL DB instance using the console, the [ create\-db\-instance](https://docs.aws.amazon.com/cli/latest/reference/rds/create-db-instance.html) CLI command, or the [CreateDBInstance](https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_CreateDBInstance.html) RDS API operation\. - - For instructions, see [Creating an Amazon RDS DB instance](USER_CreateDBInstance.md)\. -+ Modify an existing MySQL DB instance using the console, the [modify\-db\-instance](https://docs.aws.amazon.com/cli/latest/reference/rds/modify-db-instance.html) CLI command, or the [ModifyDBInstance](https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_ModifyDBInstance.html) RDS API operation\. - - For instructions, see [Modifying an Amazon RDS DB instance](Overview.DBInstance.Modifying.md)\. -+ Restore a MySQL DB instance from a DB snapshot using the console, the [ restore\-db\-instance\-from\-db\-snapshot](https://docs.aws.amazon.com/cli/latest/reference/rds/restore-db-instance-from-db-snapshot.html) CLI command, or the [ RestoreDBInstanceFromDBSnapshot](https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_RestoreDBInstanceFromDBSnapshot.html) RDS API operation\. - - For instructions, see [Restoring from a DB snapshot](USER_RestoreFromSnapshot.md)\. -+ Restore a MySQL DB instance to a point\-in\-time using the console, the [ restore\-db\-instance\-to\-point\-in\-time](https://docs.aws.amazon.com/cli/latest/reference/rds/restore-db-instance-to-point-in-time.html) CLI command, or the [ RestoreDBInstanceToPointInTime](https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_RestoreDBInstanceToPointInTime.html) RDS API operation\. - - For instructions, see [Restoring a DB instance to a specified time](USER_PIT.md)\. - -Kerberos authentication is only supported for MySQL DB instances in a VPC\. The DB instance can be in the same VPC as the directory, or in a different VPC\. The DB instance must use a security group that allows egress within the directory's VPC so the DB instance can communicate with the directory\. - -When you use the console to create, modify, or restore a DB instance, choose **Password and Kerberos authentication** in the **Database authentication** section\. Choose **Browse Directory** and then select the directory, or choose **Create a new directory**\. - -![\[Kerberos authentication setting when creating a DB instance\]](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/images/kerberos-authentication.png) - -When you use the AWS CLI or RDS API, associate a DB instance with a directory\. The following parameters are required for the DB instance to use the domain directory you created: -+ For the `--domain` parameter, use the domain identifier \("d\-\*" identifier\) generated when you created the directory\. -+ For the `--domain-iam-role-name` parameter, use the role you created that uses the managed IAM policy `AmazonRDSDirectoryServiceAccess`\. - - For example, the following CLI command modifies a DB instance to use a directory\. - -For Linux, macOS, or Unix: - -``` -aws rds modify-db-instance \ - --db-instance-identifier mydbinstance \ - --domain d-ID \ - --domain-iam-role-name role-name -``` - -For Windows: - -``` -aws rds modify-db-instance ^ - --db-instance-identifier mydbinstance ^ - --domain d-ID ^ - --domain-iam-role-name role-name -``` - -**Important** -If you modify a DB instance to enable Kerberos authentication, reboot the DB instance after making the change\. - -### Step 5: Create Kerberos authentication MySQL logins - - Use the Amazon RDS master user credentials to connect to the MySQL DB instance as you do any other DB instance\. The DB instance is joined to the AWS Managed Microsoft AD domain\. Thus, you can provision MySQL logins and users from the Active Directory users in your domain\. Database permissions are managed through standard MySQL permissions that are granted to and revoked from these logins\. - - You can allow an Active Directory user to authenticate with MySQL\. To do this, first use the Amazon RDS master user credentials to connect to the MySQL DB instance as with any other DB instance\. After you're logged in, create an externally authenticated user with PAM \(Pluggable Authentication Modules\) in MySQL as shown following\. - -``` -CREATE USER 'testuser'@'%' IDENTIFIED WITH 'auth_pam'; -``` - - Replace `testuser` with the user name\. Users \(both humans and applications\) from your domain can now connect to the DB instance from a domain joined client machine using Kerberos authentication\. - -**Important** -We strongly recommended that clients use SSL/TLS connections when using PAM authentication\. If they don't use SSL/TLS connections, the password might be sent as clear text in some cases\. To require an SSL/TLS encrypted connection for your AD user, run the following command: - -``` -UPDATE mysql.user SET ssl_type = 'any' WHERE ssl_type = '' AND PLUGIN = 'auth_pam' and USER = 'testuser'; -FLUSH PRIVILEGES; -``` -For more information, see [Using SSL/TLS with a MySQL DB instance](mysql-ssl-connections.md#MySQL.Concepts.SSLSupport)\. - -## Managing a DB instance in a domain - - You can use the CLI or the RDS API to manage your DB instance and its relationship with your managed Active Directory\. For example, you can associate an Active Directory for Kerberos authentication and disassociate an Active Directory to disable Kerberos authentication\. You can also move a DB instance to be externally authenticated by one Active Directory to another\. - - For example, using the Amazon RDS API, you can do the following: -+ To reattempt enabling Kerberos authentication for a failed membership, use the `ModifyDBInstance` API operation and specify the current membership's directory ID\. -+ To update the IAM role name for membership, use the `ModifyDBInstance` API operation and specify the current membership's directory ID and the new IAM role\. -+ To disable Kerberos authentication on a DB instance, use the `ModifyDBInstance` API operation and specify `none` as the domain parameter\. -+ To move a DB instance from one domain to another, use the `ModifyDBInstance` API operation and specify the domain identifier of the new domain as the domain parameter\. -+ To list membership for each DB instance, use the `DescribeDBInstances` API operation\. - -### Understanding domain membership - - After you create or modify your DB instance, it becomes a member of the domain\. You can view the status of the domain membership for the DB instance by running the [describe\-db\-instances](https://docs.aws.amazon.com/cli/latest/reference/rds/describe-db-instances.html) CLI command\. The status of the DB instance can be one of the following: -+ `kerberos-enabled` – The DB instance has Kerberos authentication enabled\. -+ `enabling-kerberos` – AWS is in the process of enabling Kerberos authentication on this DB instance\. -+ `pending-enable-kerberos` – The enabling of Kerberos authentication is pending on this DB instance\. -+ `pending-maintenance-enable-kerberos` – AWS will attempt to enable Kerberos authentication on the DB instance during the next scheduled maintenance window\. -+ `pending-disable-kerberos` – The disabling of Kerberos authentication is pending on this DB instance\. -+ `pending-maintenance-disable-kerberos` – AWS will attempt to disable Kerberos authentication on the DB instance during the next scheduled maintenance window\. -+ `enable-kerberos-failed` – A configuration problem has prevented AWS from enabling Kerberos authentication on the DB instance\. Check and fix your configuration before reissuing the DB instance modify command\. -+ `disabling-kerberos` – AWS is in the process of disabling Kerberos authentication on this DB instance\. - - A request to enable Kerberos authentication can fail because of a network connectivity issue or an incorrect IAM role\. For example, suppose that you create a DB instance or modify an existing DB instance and the attempt to enable Kerberos authentication fails\. If this happens, re\-issue the modify command or modify the newly created DB instance to join the domain\. - -## Connecting to MySQL with Kerberos authentication - - To connect to MySQL with Kerberos authentication, you must log in using the Kerberos authentication type\. - - To create a database user that you can connect to using Kerberos authentication, use an `IDENTIFIED WITH` clause on the `CREATE USER` statement\. For instructions, see [Step 5: Create Kerberos authentication MySQL logins](#mysql-kerberos-setting-up.create-logins)\. - -To avoid errors, use the MariaDB `mysql` client\. You can download MariaDB software at [https://downloads\.mariadb\.org/](https://downloads.mariadb.org/)\. - -At a command prompt, connect to one of the endpoints associated with your MySQL DB instance\. Follow the general procedures in [Connecting to a DB instance running the MySQL database engine](USER_ConnectToInstance.md)\. When you're prompted for the password, enter the Kerberos password associated with that user name\. - -## Restoring a MySQL DB instance and adding it to a domain - - You can restore a DB snapshot or complete a point\-in\-time restore for a MySQL DB instance and then add it to a domain\. After the DB instance is restored, modify the DB instance using the process explained in [Step 4: Create or modify a MySQL DB instance](#mysql-kerberos-setting-up.create-modify) to add the DB instance to a domain\. - -## Kerberos authentication MySQL limitations - - The following limitations apply to Kerberos authentication for MySQL: -+ Only an AWS Managed Microsoft AD is supported\. However, you can join RDS for MySQL DB instances to shared Managed Microsoft AD domains owned by different accounts in the same AWS Region\. -+ You must reboot the DB instance after enabling the feature\. -+ The domain name length can't be longer than 61 characters\. -+ You can't enable Kerberos authentication and IAM authentication at the same time\. Choose one authentication method or the other for your MySQL DB instance\. -+ Don't modify the DB instance port after enabling the feature\. -+ Don't use Kerberos authentication with read replicas\. -+ If you have auto minor version upgrade turned on for a MySQL DB instance that is using Kerberos authentication, you must turn off Kerberos authentication and then turn it back on after an automatic upgrade\. For more information about auto minor version upgrades, see [Automatic minor version upgrades for MySQL](USER_UpgradeDBInstance.MySQL.md#USER_UpgradeDBInstance.MySQL.Minor)\. -+ To delete a DB instance with this feature enabled, first disable the feature\. To do so, use the `modify-db-instance` CLI command for the DB instance and specify `none` for the `--domain` parameter\. - - If you use the CLI or RDS API to delete a DB instance with this feature enabled, expect a delay\. -+ You can't set up a forest trust relationship between your on\-premises or self\-hosted Microsoft Active Directory and the AWS Managed Microsoft AD\. \ No newline at end of file diff --git a/doc_source/mysql-replication-gtid.md b/doc_source/mysql-replication-gtid.md deleted file mode 100644 index 4e66866..0000000 --- a/doc_source/mysql-replication-gtid.md +++ /dev/null @@ -1,207 +0,0 @@ -# Using GTID\-based replication for Amazon RDS for MySQL - -Following, you can learn how to use global transaction identifiers \(GTIDs\) with binary log \(binlog\) replication among Amazon RDS for MySQL DB instances\. - -If you use binlog replication and aren't familiar with GTID\-based replication with MySQL, see [Replication with global transaction identifiers](https://dev.mysql.com/doc/refman/5.7/en/replication-gtids.html) in the MySQL documentation for background\. - -GTID\-based replication is supported for all RDS for MySQL 5\.7 versions, and RDS for MySQL version 8\.0\.26 and higher MySQL 8\.0 versions\. All MySQL DB instances in a replication configuration must meet this requirement\. - -**Topics** -+ [Overview of global transaction identifiers \(GTIDs\)](#mysql-replication-gtid.overview) -+ [Parameters for GTID\-based replication](#mysql-replication-gtid.parameters) -+ [Configuring GTID\-based replication for new read replicas](#mysql-replication-gtid.configuring-new-read-replicas) -+ [Configuring GTID\-based replication for existing read replicas](#mysql-replication-gtid.configuring-existing-read-replicas) -+ [Disabling GTID\-based replication for a MySQL DB instance with read replicas](#mysql-replication-gtid.disabling) - -**Note** -For information about configuring GTID\-based replication with an external database, see [Configuring GTID\-based replication with an external source instance](MySQL.Procedural.Importing.External.Repl.GTIDProcedure.md)\. - -## Overview of global transaction identifiers \(GTIDs\) - -*Global transaction identifiers \(GTIDs\)* are unique identifiers generated for committed MySQL transactions\. You can use GTIDs to make binlog replication simpler and easier to troubleshoot\. - -MySQL uses two different types of transactions for binlog replication: -+ *GTID transactions* – Transactions that are identified by a GTID\. -+ *Anonymous transactions* – Transactions that don't have a GTID assigned\. - -In a replication configuration, GTIDs are unique across all DB instances\. GTIDs simplify replication configuration because when you use them, you don't have to refer to log file positions\. GTIDs also make it easier to track replicated transactions and determine whether the source instance and replicas are consistent\. - -You can use GTID\-based replication to replicate data with RDS for MySQL read replicas\. You can configure GTID\-based replication when you are creating new read replicas, or you can convert existing read replicas to use GTID\-based replication\. - -You can also use GTID\-based replication in a delayed replication configuration with RDS for MySQL\. For more information, see [Configuring delayed replication with MySQL](USER_MySQL.Replication.ReadReplicas.md#USER_MySQL.Replication.ReadReplicas.DelayReplication)\. - -## Parameters for GTID\-based replication - -Use the following parameters to configure GTID\-based replication\. - - -**** - -| Parameter | Valid values | Description | -| --- | --- | --- | -| `gtid_mode` | `OFF`, `OFF_PERMISSIVE`, `ON_PERMISSIVE`, `ON` | `OFF` specifies that new transactions are anonymous transactions \(that is, don't have GTIDs\), and a transaction must be anonymous to be replicated\. `OFF_PERMISSIVE` specifies that new transactions are anonymous transactions, but all transactions can be replicated\. `ON_PERMISSIVE` specifies that new transactions are GTID transactions, but all transactions can be replicated\. `ON` specifies that new transactions are GTID transactions, and a transaction must be a GTID transaction to be replicated\. | -| `enforce_gtid_consistency` | `OFF`, `ON`, `WARN` | `OFF` allows transactions to violate GTID consistency\. `ON` prevents transactions from violating GTID consistency\. `WARN` allows transactions to violate GTID consistency but generates a warning when a violation occurs\. | - -**Note** -In the AWS Management Console, the `gtid_mode` parameter appears as `gtid-mode`\. - -For GTID\-based replication, use these settings for the parameter group for your DB instance or read replica: -+ `ON` and `ON_PERMISSIVE` apply only to outgoing replication from an RDS DB instance\. Both of these values cause your RDS DB instance to use GTIDs for transactions that are replicated\. `ON` requires that the target database also use GTID\-based replication\. `ON_PERMISSIVE` makes GTID\-based replication optional on the target database\. -+ `OFF_PERMISSIVE`, if set, means that your RDS DB instances can accept incoming replication from a source database\. They can do this regardless of whether the source database uses GTID\-based replication\. -+ `OFF`, if set, means that your RDS DB instance only accepts incoming replication from source databases that don't use GTID\-based replication\. - -For more information about parameter groups, see [Working with parameter groups](USER_WorkingWithParamGroups.md)\. - -## Configuring GTID\-based replication for new read replicas - -When GTID\-based replication is enabled for an RDS for MySQL DB instance, GTID\-based replication is configured automatically for read replicas of the DB instance\. - -**To enable GTID\-based replication for new read replicas** - -1. Make sure that the parameter group associated with the DB instance has the following parameter settings: - + `gtid_mode` – `ON` or `ON_PERMISSIVE` - + `enforce_gtid_consistency` – `ON` - - For more information about setting configuration parameters using parameter groups, see [Working with parameter groups](USER_WorkingWithParamGroups.md)\. - -1. If you changed the parameter group of the DB instance, reboot the DB instance\. For more information on how to do so, see [Rebooting a DB instance](USER_RebootInstance.md)\. - -1. Create one or more read replicas of the DB instance\. For more information on how to do so, see [Creating a read replica](USER_ReadRepl.md#USER_ReadRepl.Create)\. - -Amazon RDS attempts to establish GTID\-based replication between the MySQL DB instance and the read replicas using the `MASTER_AUTO_POSITION`\. If the attempt fails, Amazon RDS uses log file positions for replication with the read replicas\. For more information about the `MASTER_AUTO_POSITION`, see [ GTID auto\-positioning](https://dev.mysql.com/doc/refman/5.7/en/replication-gtids-auto-positioning.html) in the MySQL documentation\. - -## Configuring GTID\-based replication for existing read replicas - -For an existing MySQL DB instance with read replicas that doesn't use GTID\-based repl ication, you can configure GTID\-based replication between the DB instance and the read replicas\. - -**To enable GTID\-based replication for existing read replicas** - -1. If the DB instance or any read replica is using an 8\.0 version of RDS for MySQL version lower than 8\.0\.26, upgrade the DB instance or read replica to 8\.0\.26 or a higher MySQL 8\.0 version\. All RDS for MySQL 5\.7 versions support GTID\-based replication\. - - For more information, see [Upgrading the MySQL DB engine](USER_UpgradeDBInstance.MySQL.md)\. - -1. \(Optional\) Reset the GTID parameters and test the behavior of the DB instance and read replicas: - - 1. Make sure that the parameter group associated with the DB instance and each read replica has the `enforce_gtid_consistency` parameter set to `WARN`\. - - For more information about setting configuration parameters using parameter groups, see [Working with parameter groups](USER_WorkingWithParamGroups.md)\. - - 1. If you changed the parameter group of the DB instance, reboot the DB instance\. If you changed the parameter group for a read replica, reboot the read replica\. - - For more information, see [Rebooting a DB instance](USER_RebootInstance.md)\. - - 1. Run your DB instance and read replicas with your normal workload and monitor the log files\. - - If you see warnings about GTID\-incompatible transactions, adjust your application so that it only uses GTID\-compatible features\. Make sure that the DB instance is not generating any warnings about GTID\-incompatible transactions before proceeding to the next step\. - -1. Reset the GTID parameters for GTID\-based replication that allows anonymous transactions until the read replicas have processed all of them\. - - 1. Make sure that the parameter group associated with the DB instance and each read replica has the following parameter settings: - + `gtid_mode` – `ON_PERMISSIVE` - + `enforce_gtid_consistency` – `ON` - - 1. If you changed the parameter group of the DB instance, reboot the DB instance\. If you changed the parameter group for a read replica, reboot the read replica\. - -1. Wait for all of your anonymous transactions to be replicated\. To check that these are replicated, do the following: - - 1. Run the following statement on your source DB instance\. - - ``` - SHOW MASTER STATUS; - ``` - - Note the values in the `File` and `Position` columns\. - - 1. On each read replica, use the file and position information from its source instance in the previous step to run the following query\. - - ``` - SELECT MASTER_POS_WAIT('file', position); - ``` - - For example, if the file name is `mysql-bin-changelog.000031` and the position is `107`, run the following statement\. - - ``` - SELECT MASTER_POS_WAIT('mysql-bin-changelog.000031', 107); - ``` - - If the read replica is past the specified position, the query returns immediately\. Otherwise, the function waits\. Proceed to the next step when the query returns for all read replicas\. - -1. Reset the GTID parameters for GTID\-based replication only\. - - 1. Make sure that the parameter group associated with the DB instance and each read replica has the following parameter settings: - + `gtid_mode` – `ON` - + `enforce_gtid_consistency` – `ON` - - 1. Reboot the DB instance and each read replica\. - -1. On each read replica, run the following procedure\. - - ``` - CALL mysql.rds_set_master_auto_position(1); - ``` - -## Disabling GTID\-based replication for a MySQL DB instance with read replicas - -You can disable GTID\-based replication for a MySQL DB instance with read replicas\. - -**To disable GTID\-based replication for a MySQL DB instance with read replicas** - -1. On each read replica, run the following procedure\. - - ``` - CALL mysql.rds_set_master_auto_position(0); (Aurora MySQL version 2) - CALL mysql.rds_set_source_auto_position(0); (Aurora MySQL version 3) - ``` - -1. Reset the `gtid_mode` to `ON_PERMISSIVE`\. - - 1. Make sure that the parameter group associated with the MySQL DB instance and each read replica has `gtid_mode` set to `ON_PERMISSIVE`\. - - For more information about setting configuration parameters using parameter groups, see [Working with parameter groups](USER_WorkingWithParamGroups.md)\. - - 1. Reboot the MySQL DB instance and each read replica\. For more information about rebooting, see [Rebooting a DB instance](USER_RebootInstance.md)\. - -1. Reset the `gtid_mode` to `OFF_PERMISSIVE`: - - 1. Make sure that the parameter group associated with the MySQL DB instance and each read replica has `gtid_mode` set to `OFF_PERMISSIVE`\. - - 1. Reboot the MySQL DB instance and each read replica\. - -1. Wait for all of the GTID transactions to be applied on all of the read replicas\. To check that these are applied, do the following: - - Wait for all of the GTID transactions to be applied on the Aurora primary instance\. To check that these are applied, do the following: - - 1. On the MySQL DB instance, run the `SHOW MASTER STATUS` command\. - - Your output should be similar to the following\. - - ``` - File Position - ------------------------------------ - mysql-bin-changelog.000031 107 - ------------------------------------ - ``` - - Note the file and position in your output\. - - 1. On each read replica, use the file and position information from its source instance in the previous step to run the following query\. - - ``` - SELECT MASTER_POS_WAIT('file', position); - ``` - - For example, if the file name is `mysql-bin-changelog.000031` and the position is `107`, run the following statement\. - - ``` - SELECT MASTER_POS_WAIT('mysql-bin-changelog.000031', 107); - ``` - - If the read replica is past the specified position, the query returns immediately\. Otherwise, the function waits\. When the query returns for all read replicas, go to the next step\. - -1. Reset the GTID parameters to disable GTID\-based replication: - - 1. Make sure that the parameter group associated with the MySQL DB instance and each read replica has the following parameter settings: - + `gtid_mode` – `OFF` - + `enforce_gtid_consistency` – `OFF` - - 1. Reboot the MySQL DB instance and each read replica\. \ No newline at end of file diff --git a/doc_source/mysql-ssl-connections.md b/doc_source/mysql-ssl-connections.md deleted file mode 100644 index 6bd7dc9..0000000 --- a/doc_source/mysql-ssl-connections.md +++ /dev/null @@ -1,107 +0,0 @@ -# Encrypting client connections to MySQL DB instances with SSL/TLS - -Secure Sockets Layer \(SSL\) is an industry\-standard protocol for securing network connections between client and server\. After SSL version 3\.0, the name was changed to Transport Layer Security \(TLS\)\. Amazon RDS supports SSL/TLS encryption for MySQL DB instances\. Using SSL/TLS, you can encrypt a connection between your application client and your MySQL DB instance\. SSL/TLS support is available in all AWS Regions for MySQL\. - -**Topics** -+ [Using SSL/TLS with a MySQL DB instance](#MySQL.Concepts.SSLSupport) -+ [Requiring SSL/TLS for all connections to a MySQL DB instance](#mysql-ssl-connections.require-ssl) -+ [Connecting from the MySQL command\-line client with SSL/TLS \(encrypted\)](#USER_ConnectToInstanceSSL.CLI) - -## Using SSL/TLS with a MySQL DB instance - -Amazon RDS creates an SSL/TLS certificate and installs the certificate on the DB instance when Amazon RDS provisions the instance\. These certificates are signed by a certificate authority\. The SSL/TLS certificate includes the DB instance endpoint as the Common Name \(CN\) for the SSL/TLS certificate to guard against spoofing attacks\. - -An SSL/TLS certificate created by Amazon RDS is the trusted root entity and should work in most cases but might fail if your application does not accept certificate chains\. If your application does not accept certificate chains, you might need to use an intermediate certificate to connect to your AWS Region\. For example, you must use an intermediate certificate to connect to the AWS GovCloud \(US\) Regions using SSL/TLS\. - -For information about downloading certificates, see [Using SSL/TLS to encrypt a connection to a DB instance](UsingWithRDS.SSL.md)\. For more information about using SSL/TLS with MySQL, see [Using new SSL/TLS certificates for MySQL DB instances](ssl-certificate-rotation-mysql.md)\. - -MySQL uses OpenSSL for secure connections\. Amazon RDS for MySQL supports Transport Layer Security \(TLS\) versions 1\.0, 1\.1, and 1\.2\. The following table shows the TLS support for MySQL versions\. - - -**** - -| MySQL version | TLS 1\.0 | TLS 1\.1 | TLS 1\.2 | -| --- | --- | --- | --- | -| MySQL 8\.0 | Not supported | Not supported | Supported | -| MySQL 5\.7 | Supported | Supported | Supported | - -You can require SSL/TLS connections for specific users accounts\. For example, you can use one of the following statements, depending on your MySQL version, to require SSL/TLS connections on the user account `encrypted_user`\. - -To do so, use the following statement\. - -``` -ALTER USER 'encrypted_user'@'%' REQUIRE SSL; -``` - -For more information on SSL/TLS connections with MySQL, see the [ Using encrypted connections](https://dev.mysql.com/doc/refman/8.0/en/encrypted-connections.html) in the MySQL documentation\. - -## Requiring SSL/TLS for all connections to a MySQL DB instance - -Use the `require_secure_transport` parameter to require that all user connections to your MySQL DB instance use SSL/TLS\. By default, the `require_secure_transport` parameter is set to `OFF`\. You can set the `require_secure_transport` parameter to `ON` to require SSL/TLS for connections to your DB instance\. - -You can set the `require_secure_transport` parameter value by updating the DB parameter group for your DB instance\. You don't need to reboot your DB instance for the change to take effect\. - -When the `require_secure_transport` parameter is set to `ON` for a DB instance, a database client can connect to it if it can establish an encrypted connection\. Otherwise, an error message similar to the following is returned to the client: - -``` -MySQL Error 3159 (HY000): Connections using insecure transport are prohibited while --require_secure_transport=ON. -``` - -For information about setting parameters, see [Modifying parameters in a DB parameter group](USER_WorkingWithDBInstanceParamGroups.md#USER_WorkingWithParamGroups.Modifying)\. - -For more information about the `require_secure_transport` parameter, see the [ MySQL documentation](https://dev.mysql.com/doc/refman/8.0/en/server-system-variables.html#sysvar_require_secure_transport)\. - -## Connecting from the MySQL command\-line client with SSL/TLS \(encrypted\) - -The `mysql` client program parameters are slightly different if you are using the MySQL 5\.7 version, the MySQL 8\.0 version, or the MariaDB version\. - -To find out which version you have, run the `mysql` command with the `--version` option\. In the following example, the output shows that the client program is from MariaDB\. - -``` -$ mysql --version -mysql Ver 15.1 Distrib 10.5.15-MariaDB, for osx10.15 (x86_64) using readline 5.1 -``` - -Most Linux distributions, such as Amazon Linux, CentOS, SUSE, and Debian have replaced MySQL with MariaDB, and the `mysql` version in them is from MariaDB\. - -To connect to your DB instance using SSL/TLS, follow these steps: - -**To connect to a DB instance with SSL/TLS using the MySQL command\-line client** - -1. Download a root certificate that works for all AWS Regions\. - - For information about downloading certificates, see [Using SSL/TLS to encrypt a connection to a DB instance](UsingWithRDS.SSL.md)\. - -1. Use a MySQL command\-line client to connect to a DB instance with SSL/TLS encryption\. For the `-h` parameter, substitute the DNS name \(endpoint\) for your DB instance\. For the `--ssl-ca` parameter, substitute the SSL/TLS certificate file name\. For the `-P` parameter, substitute the port for your DB instance\. For the `-u` parameter, substitute the user name of a valid database user, such as the master user\. Enter the master user password when prompted\. - - The following example shows how to launch the client using the `--ssl-ca` parameter using the MySQL 5\.7 client or later: - - ``` - mysql -h mysql–instance1.123456789012.us-east-1.rds.amazonaws.com --ssl-ca=global-bundle.pem --ssl-mode=REQUIRED -P 3306 -u myadmin -p - ``` - - To require that the SSL/TLS connection verifies the DB instance endpoint against the endpoint in the SSL/TLS certificate, enter the following command: - - ``` - mysql -h mysql–instance1.123456789012.us-east-1.rds.amazonaws.com --ssl-ca=global-bundle.pem --ssl-mode=VERIFY_IDENTITY -P 3306 -u myadmin -p - ``` - - The following example shows how to launch the client using the `--ssl-ca` parameter using the MariaDB client: - - ``` - mysql -h mysql–instance1.123456789012.us-east-1.rds.amazonaws.com --ssl-ca=global-bundle.pem --ssl -P 3306 -u myadmin -p - ``` - -1. Enter the master user password when prompted\. - -You will see output similar to the following\. - -``` -Welcome to the MySQL monitor. Commands end with ; or \g. -Your MySQL connection id is 9738 -Server version: 8.0.28 Source distribution - -Type 'help;' or '\h' for help. Type '\c' to clear the buffer. - -mysql> -``` \ No newline at end of file diff --git a/doc_source/mysql-stored-proc-configuring.md b/doc_source/mysql-stored-proc-configuring.md deleted file mode 100644 index 82dc689..0000000 --- a/doc_source/mysql-stored-proc-configuring.md +++ /dev/null @@ -1,113 +0,0 @@ -# Configuring - -The following stored procedures set and show configuration parameters, such as for binary log file retention\. - -**Topics** -+ [mysql\.rds\_set\_configuration](#mysql_rds_set_configuration) -+ [mysql\.rds\_show\_configuration](#mysql_rds_show_configuration) - -## mysql\.rds\_set\_configuration - -Specifies the number of hours to retain binary logs or the number of seconds to delay replication\. - -### Syntax - - - -``` -CALL mysql.rds_set_configuration(name,value); -``` - -### Parameters - - *name* -The name of the configuration parameter to set\. - - *value* -The value of the configuration parameter\. - -### Usage notes - -The `mysql.rds_set_configuration` procedure supports the following configuration parameters: -+ [Binlog retention hours](#mysql_rds_set_configuration-usage-notes.binlog-retention-hours) -+ [Source delay ](#mysql_rds_set_configuration-usage-notes.source-delay) -+ [Target delay](#mysql_rds_set_configuration-usage-notes.target-delay) - -The configuration parameters are stored permanently and survive any DB instance reboot or failover\. - -#### Binlog retention hours - -The `binlog retention hours` parameter is used to specify the number of hours to retain binary log files\. Amazon RDS normally purges a binary log as soon as possible, but the binary log might still be required for replication with a MySQL database external to RDS\. - -The default value of `binlog retention hours` is `NULL`\. For RDS for MySQL, `NULL` means binary logs aren't retained \(0 hours\)\. - -To specify the number of hours to retain binary logs on a DB instance, use the `mysql.rds_set_configuration` stored procedure and specify a period with enough time for replication to occur, as shown in the following example\. - -`call mysql.rds_set_configuration('binlog retention hours', 24);` - -**Note** -You can't use the value `0` for `binlog retention hours`\. - -For MySQL DB instances, the maximum `binlog retention hours` value is 168 \(7 days\)\. - -After you set the retention period, monitor storage usage for the DB instance to make sure that the retained binary logs don't take up too much storage\. - -#### Source delay - -Use the `source delay` parameter in a read replica to specify the number of seconds to delay replication from the read replica to its source DB instance\. Amazon RDS normally replicates changes as soon as possible, but you might want some environments to delay replication\. For example, when replication is delayed, you can roll forward a delayed read replica to the time just before a disaster\. If a table is dropped accidentally, you can use delayed replication to quickly recover it\. The default value of `target delay` is `0` \(don't delay replication\)\. - -When you use this parameter, it runs [mysql\.rds\_set\_source\_delay](mysql-stored-proc-replicating.md#mysql_rds_set_source_delay) and applies CHANGE primary TO MASTER\_DELAY = input value\. If successful, the procedure saves the `source delay` parameter to the `mysql.rds_configuration` table\. - -To specify the number of seconds for Amazon RDS to delay replication to a source DB instance, use the `mysql.rds_set_configuration` stored procedure and specify the number of seconds to delay replication\. In the following example, the replication is delayed by at least one hour \(3,600 seconds\)\. - -`call mysql.rds_set_configuration('source delay', 3600);` - -The procedure then runs `mysql.rds_set_source_delay(3600)`\. - -The limit for the `source delay` parameter is one day \(86400 seconds\)\. - -**Note** -The `source delay` parameter isn't supported for RDS for MySQL version 8\.0 or MariaDB versions below 10\.2\. - -#### Target delay - -Use the `target delay` parameter to specify the number of seconds to delay replication between a DB instance and any future RDS\-managed read replicas created from this instance\. This parameter is ignored for non\-RDS\-managed read replicas\. Amazon RDS normally replicates changes as soon as possible, but you might want some environments to delay replication\. For example, when replication is delayed, you can roll forward a delayed read replica to the time just before a disaster\. If a table is dropped accidentally, you can use delayed replication to recover it quickly\. The default value of `target delay` is `0` \(don't delay replication\)\. - -For disaster recovery, you can use this configuration parameter with the [mysql\.rds\_start\_replication\_until](mysql-stored-proc-replicating.md#mysql_rds_start_replication_until) stored procedure or the [mysql\.rds\_start\_replication\_until\_gtid](mysql-stored-proc-replicating.md#mysql_rds_start_replication_until_gtid) stored procedure\. To roll forward changes to a delayed read replica to the time just before a disaster, you can run the `mysql.rds_set_configuration` procedure with this parameter set\. After the `mysql.rds_start_replication_until` or `mysql.rds_start_replication_until_gtid` procedure stops replication, you can promote the read replica to be the new primary DB instance by using the instructions in [Promoting a read replica to be a standalone DB instance](USER_ReadRepl.md#USER_ReadRepl.Promote)\. - -To use the `mysql.rds_rds_start_replication_until_gtid` procedure, GTID\-based replication must be enabled\. To skip a specific GTID\-based transaction that is known to cause disaster, you can use the [mysql\.rds\_skip\_transaction\_with\_gtid](mysql-stored-proc-replicating.md#mysql_rds_skip_transaction_with_gtid) stored procedure\. For more information about working with GTID\-based replication, see [Using GTID\-based replication for Amazon RDS for MySQL](mysql-replication-gtid.md)\. - -To specify the number of seconds for Amazon RDS to delay replication to a read replica, use the `mysql.rds_set_configuration` stored procedure and specify the number of seconds to delay replication\. The following example specifies that replication is delayed by at least one hour \(3,600 seconds\)\. - -`call mysql.rds_set_configuration('target delay', 3600);` - -The limit for the `target delay` parameter is one day \(86400 seconds\)\. - -**Note** -The `target delay` parameter isn't supported for RDS for MySQL version 8\.0 or MariaDB versions earlier than 10\.2\. - -## mysql\.rds\_show\_configuration - -The number of hours that binary logs are retained\. - -### Syntax - - - -``` -CALL mysql.rds_show_configuration; -``` - -### Usage notes - -To verify the number of hours that Amazon RDS retains binary logs, use the `mysql.rds_show_configuration` stored procedure\. - -### Examples - -The following example displays the retention period: - -``` -call mysql.rds_show_configuration; - name value description - binlog retention hours 24 binlog retention hours specifies the duration in hours before binary logs are automatically deleted. -``` \ No newline at end of file diff --git a/doc_source/mysql-stored-proc-ending.md b/doc_source/mysql-stored-proc-ending.md deleted file mode 100644 index fcf30b6..0000000 --- a/doc_source/mysql-stored-proc-ending.md +++ /dev/null @@ -1,65 +0,0 @@ -# Ending a session or query - -The following stored procedures end a session or query\. - -**Topics** -+ [mysql\.rds\_kill](#mysql_rds_kill) -+ [mysql\.rds\_kill\_query](#mysql_rds_kill_query) - -## mysql\.rds\_kill - -Ends a connection to the MySQL server\. - -### Syntax - - - -``` -CALL mysql.rds_kill(processID); -``` - -### Parameters - - *processID* -The identity of the connection thread to be ended\. - -### Usage notes - -Each connection to the MySQL server runs in a separate thread\. To end a connection, use the `mysql.rds_kill` procedure and pass in the thread ID of that connection\. To obtain the thread ID, use the MySQL [SHOW PROCESSLIST](https://dev.mysql.com/doc/refman/8.0/en/show-processlist.html) command\. - -### Examples - -The following example ends a connection with a thread ID of 4243: - -``` -call mysql.rds_kill(4243); -``` - -## mysql\.rds\_kill\_query - -Ends a query running against the MySQL server\. - -### Syntax - - - -``` -CALL mysql.rds_kill_query(queryID); -``` - -### Parameters - - *queryID* -The identity of the query to be ended\. - -### Usage notes - -To stop a query running against the MySQL server, use the `mysql_rds_kill_query` procedure and pass in the ID of that query\. To obtain the query ID, query the MySQL [INFORMATION\_SCHEMA PROCESSLIST table](https://dev.mysql.com/doc/refman/8.0/en/information-schema-processlist-table.html)\. The connection to the MySQL server is retained\. - -### Examples - -The following example stops a query with a thread ID of 230040: - -``` -call mysql.rds_kill_query(230040); -``` \ No newline at end of file diff --git a/doc_source/mysql-stored-proc-gsh.md b/doc_source/mysql-stored-proc-gsh.md deleted file mode 100644 index f18f13d..0000000 --- a/doc_source/mysql-stored-proc-gsh.md +++ /dev/null @@ -1,121 +0,0 @@ -# Managing the Global Status History - -Amazon RDS provides a set of procedures that take snapshots of the values of status variables over time and write them to a table, along with any changes since the last snapshot\. This infrastructure is called Global Status History\. For more information, see [Managing the Global Status History](Appendix.MySQL.CommonDBATasks.md#Appendix.MySQL.CommonDBATasks.GoSH)\. - -The following stored procedures manage how the Global Status History is collected and maintained\. - -**Topics** -+ [mysql\.rds\_collect\_global\_status\_history](#mysql_rds_collect_global_status_history) -+ [mysql\.rds\_disable\_gsh\_collector](#mysql_rds_disable_gsh_collector) -+ [mysql\.rds\_disable\_gsh\_rotation](#mysql_rds_disable_gsh_rotation) -+ [mysql\.rds\_enable\_gsh\_collector](#mysql_rds_enable_gsh_collector) -+ [mysql\.rds\_enable\_gsh\_rotation](#mysql_rds_enable_gsh_rotation) -+ [mysql\.rds\_rotate\_global\_status\_history](#mysql_rds_rotate_global_status_history) -+ [mysql\.rds\_set\_gsh\_collector](#mysql_rds_set_gsh_collector) -+ [mysql\.rds\_set\_gsh\_rotation](#mysql_rds_set_gsh_rotation) - -## mysql\.rds\_collect\_global\_status\_history - -Takes a snapshot on demand for the Global Status History\. - -### Syntax - - - -``` -CALL mysql.rds_collect_global_status_history; -``` - -## mysql\.rds\_disable\_gsh\_collector - -Turns off snapshots taken by the Global Status History\. - -### Syntax - - - -``` -CALL mysql.rds_disable_gsh_collector; -``` - -## mysql\.rds\_disable\_gsh\_rotation - -Turns off rotation of the `mysql.global_status_history` table\. - -### Syntax - - - -``` -CALL mysql.rds_disable_gsh_rotation; -``` - -## mysql\.rds\_enable\_gsh\_collector - -Turns on the Global Status History to take default snapshots at intervals specified by `rds_set_gsh_collector`\. - -### Syntax - - - -``` -CALL mysql.rds_enable_gsh_collector; -``` - -## mysql\.rds\_enable\_gsh\_rotation - -Turns on rotation of the contents of the `mysql.global_status_history` table to `mysql.global_status_history_old` at intervals specified by `rds_set_gsh_rotation`\. - -### Syntax - - - -``` -CALL mysql.rds_enable_gsh_rotation; -``` - -## mysql\.rds\_rotate\_global\_status\_history - -Rotates the contents of the `mysql.global_status_history` table to `mysql.global_status_history_old` on demand\. - -### Syntax - - - -``` -CALL mysql.rds_rotate_global_status_history; -``` - -## mysql\.rds\_set\_gsh\_collector - -Specifies the interval, in minutes, between snapshots taken by the Global Status History\. - -### Syntax - - - -``` -CALL mysql.rds_set_gsh_collector(intervalPeriod); -``` - -### Parameters - - *intervalPeriod* -The interval, in minutes, between snapshots\. Default value is `5`\. - -## mysql\.rds\_set\_gsh\_rotation - -Specifies the interval, in days, between rotations of the `mysql.global_status_history` table\. - -### Syntax - - - -``` -CALL mysql.rds_set_gsh_rotation(intervalPeriod); -``` - -### Parameters - - *intervalPeriod* -The interval, in days, between table rotations\. Default value is `7`\. \ No newline at end of file diff --git a/doc_source/mysql-stored-proc-logging.md b/doc_source/mysql-stored-proc-logging.md deleted file mode 100644 index 85759b9..0000000 --- a/doc_source/mysql-stored-proc-logging.md +++ /dev/null @@ -1,43 +0,0 @@ -# Logging - -The following stored procedures rotate MySQL logs to backup tables\. For more information, see [MySQL database log files](USER_LogAccess.Concepts.MySQL.md)\. - -**Topics** -+ [mysql\.rds\_rotate\_general\_log](#mysql_rds_rotate_general_log) -+ [mysql\.rds\_rotate\_slow\_log](#mysql_rds_rotate_slow_log) - -## mysql\.rds\_rotate\_general\_log - -Rotates the `mysql.general_log` table to a backup table\. - -### Syntax - - - -``` -CALL mysql.rds_rotate_general_log; -``` - -### Usage notes - -You can rotate the `mysql.general_log` table to a backup table by calling the `mysql.rds_rotate_general_log` procedure\. When log tables are rotated, the current log table is copied to a backup log table and the entries in the current log table are removed\. If a backup log table already exists, then it is deleted before the current log table is copied to the backup\. You can query the backup log table if needed\. The backup log table for the `mysql.general_log` table is named `mysql.general_log_backup`\. - -You can run this procedure only when the `log_output` parameter is set to `TABLE`\. - -## mysql\.rds\_rotate\_slow\_log - -Rotates the `mysql.slow_log` table to a backup table\. - -### Syntax - - - -``` -CALL mysql.rds_rotate_slow_log; -``` - -### Usage notes - -You can rotate the `mysql.slow_log` table to a backup table by calling the `mysql.rds_rotate_slow_log` procedure\. When log tables are rotated, the current log table is copied to a backup log table and the entries in the current log table are removed\. If a backup log table already exists, then it is deleted before the current log table is copied to the backup\. - -You can query the backup log table if needed\. The backup log table for the `mysql.slow_log` table is named `mysql.slow_log_backup`\. \ No newline at end of file diff --git a/doc_source/mysql-stored-proc-replicating.md b/doc_source/mysql-stored-proc-replicating.md deleted file mode 100644 index d9d79bb..0000000 --- a/doc_source/mysql-stored-proc-replicating.md +++ /dev/null @@ -1,810 +0,0 @@ -# Replicating - -The following stored procedures control how transactions are replicated from an external database into RDS for MySQL, or from RDS for MySQL to an external database\. To learn how to use replication based on global transaction identifiers \(GTIDs\) with RDS for MySQL, see [Using GTID\-based replication for Amazon RDS for MySQL](mysql-replication-gtid.md)\. - -**Topics** -+ [mysql\.rds\_import\_binlog\_ssl\_material](#mysql_rds_import_binlog_ssl_material) -+ [mysql\.rds\_next\_master\_log](#mysql_rds_next_master_log) -+ [mysql\.rds\_remove\_binlog\_ssl\_material](#mysql_rds_remove_binlog_ssl_material) -+ [mysql\.rds\_reset\_external\_master](#mysql_rds_reset_external_master) -+ [mysql\.rds\_set\_external\_master](#mysql_rds_set_external_master) -+ [mysql\.rds\_set\_external\_master\_with\_auto\_position](#mysql_rds_set_external_master_with_auto_position) -+ [mysql\.rds\_set\_external\_master\_with\_delay](#mysql_rds_set_external_master_with_delay) -+ [mysql\.rds\_set\_master\_auto\_position](#mysql_rds_set_master_auto_position) -+ [mysql\.rds\_set\_source\_delay](#mysql_rds_set_source_delay) -+ [mysql\.rds\_skip\_transaction\_with\_gtid](#mysql_rds_skip_transaction_with_gtid) -+ [mysql\.rds\_skip\_repl\_error](#mysql_rds_skip_repl_error) -+ [mysql\.rds\_start\_replication](#mysql_rds_start_replication) -+ [mysql\.rds\_start\_replication\_until](#mysql_rds_start_replication_until) -+ [mysql\.rds\_start\_replication\_until\_gtid](#mysql_rds_start_replication_until_gtid) -+ [mysql\.rds\_stop\_replication](#mysql_rds_stop_replication) - -## mysql\.rds\_import\_binlog\_ssl\_material - -Imports the certificate authority certificate, client certificate, and client key into an RDS for MySQL DB instance\. The information is required for SSL communication and encrypted replication\. - -### Syntax - - - -``` -CALL mysql.rds_import_binlog_ssl_material ( - ssl_material -); -``` - -### Parameters - - *ssl\_material* -JSON payload that contains the contents of the following \.pem format files for a MySQL client: -+ "ssl\_ca":"*Certificate authority certificate*" -+ "ssl\_cert":"*Client certificate*" -+ "ssl\_key":"*Client key*" - -### Usage notes - -Prepare for encrypted replication before you run this procedure: -+ If you don't have SSL enabled on the external MySQL source database instance and don't have a client key and client certificate prepared, enable SSL on the MySQL database server and generate the required client key and client certificate\. -+ If SSL is enabled on the external source database instance, supply a client key and certificate for the RDS for MySQL DB instance\. If you don't have these, generate a new key and certificate for the RDS for MySQL DB instance\. To sign the client certificate, you must have the certificate authority key you used to configure SSL on the external MySQL source database instance\. - -For more information, see [ Creating SSL certificates and keys using openssl](https://dev.mysql.com/doc/refman/8.0/en/creating-ssl-files-using-openssl.html) in the MySQL documentation\. - -**Important** -After you prepare for encrypted replication, use an SSL connection to run this procedure\. The client key must not be transferred across an insecure connection\. - -This procedure imports SSL information from an external MySQL database into an RDS for MySQL DB instance\. The SSL information is in \.pem format files that contain the SSL information for the RDS for MySQL DB instance\. During encrypted replication, the RDS for MySQL DB instance acts a client to the MySQL database server\. The certificates and keys for the RDS for MySQL client are in files in \.pem format\. - -You can copy the information from these files into the `ssl_material` parameter in the correct JSON payload\. To support encrypted replication, import this SSL information into the RDS for MySQL DB instance\. - -The JSON payload must be in the following format\. - -``` -'{"ssl_ca":"-----BEGIN CERTIFICATE----- -ssl_ca_pem_body_code ------END CERTIFICATE-----\n","ssl_cert":"-----BEGIN CERTIFICATE----- -ssl_cert_pem_body_code ------END CERTIFICATE-----\n","ssl_key":"-----BEGIN RSA PRIVATE KEY----- -ssl_key_pem_body_code ------END RSA PRIVATE KEY-----\n"}' -``` - -### Examples - -The following example imports SSL information into an RDS for MySQL DB instance\. In \.pem format files, the body code typically is longer than the body code shown in the example\. - -``` -call mysql.rds_import_binlog_ssl_material( -'{"ssl_ca":"-----BEGIN CERTIFICATE----- -AAAAB3NzaC1yc2EAAAADAQABAAABAQClKsfkNkuSevGj3eYhCe53pcjqP3maAhDFcvBS7O6V -hz2ItxCih+PnDSUaw+WNQn/mZphTk/a/gU8jEzoOWbkM4yxyb/wB96xbiFveSFJuOp/d6RJhJOI0iBXr -lsLnBItntckiJ7FbtxJMXLvvwJryDUilBMTjYtwB+QhYXUMOzce5Pjz5/i8SeJtjnV3iAoG/cQk+0FzZ -qaeJAAHco+CY/5WrUBkrHmFJr6HcXkvJdWPkYQS3xqC0+FmUZofz221CBt5IMucxXPkX4rWi+z7wB3Rb -BQoQzd8v7yeb7OzlPnWOyN0qFU0XA246RA8QFYiCNYwI3f05p6KLxEXAMPLE ------END CERTIFICATE-----\n","ssl_cert":"-----BEGIN CERTIFICATE----- -AAAAB3NzaC1yc2EAAAADAQABAAABAQClKsfkNkuSevGj3eYhCe53pcjqP3maAhDFcvBS7O6V -hz2ItxCih+PnDSUaw+WNQn/mZphTk/a/gU8jEzoOWbkM4yxyb/wB96xbiFveSFJuOp/d6RJhJOI0iBXr -lsLnBItntckiJ7FbtxJMXLvvwJryDUilBMTjYtwB+QhYXUMOzce5Pjz5/i8SeJtjnV3iAoG/cQk+0FzZ -qaeJAAHco+CY/5WrUBkrHmFJr6HcXkvJdWPkYQS3xqC0+FmUZofz221CBt5IMucxXPkX4rWi+z7wB3Rb -BQoQzd8v7yeb7OzlPnWOyN0qFU0XA246RA8QFYiCNYwI3f05p6KLxEXAMPLE ------END CERTIFICATE-----\n","ssl_key":"-----BEGIN RSA PRIVATE KEY----- -AAAAB3NzaC1yc2EAAAADAQABAAABAQClKsfkNkuSevGj3eYhCe53pcjqP3maAhDFcvBS7O6V -hz2ItxCih+PnDSUaw+WNQn/mZphTk/a/gU8jEzoOWbkM4yxyb/wB96xbiFveSFJuOp/d6RJhJOI0iBXr -lsLnBItntckiJ7FbtxJMXLvvwJryDUilBMTjYtwB+QhYXUMOzce5Pjz5/i8SeJtjnV3iAoG/cQk+0FzZ -qaeJAAHco+CY/5WrUBkrHmFJr6HcXkvJdWPkYQS3xqC0+FmUZofz221CBt5IMucxXPkX4rWi+z7wB3Rb -BQoQzd8v7yeb7OzlPnWOyN0qFU0XA246RA8QFYiCNYwI3f05p6KLxEXAMPLE ------END RSA PRIVATE KEY-----\n"}'); -``` - -## mysql\.rds\_next\_master\_log - -Changes the source database instance log position to the start of the next binary log on the source database instance\. Use this procedure only if you are receiving replication I/O error 1236 on a read replica\. - -### Syntax - - - -``` -CALL mysql.rds_next_master_log( -curr_master_log -); -``` - -### Parameters - - *curr\_master\_log* -The index of the current master log file\. For example, if the current file is named `mysql-bin-changelog.012345`, then the index is 12345\. To determine the current master log file name, run the `SHOW REPLICA STATUS` command and view the `Master_Log_File` field\. -Previous versions of MySQL used `SHOW SLAVE STATUS` instead of `SHOW REPLICA STATUS`\. If you are using a MySQL version before 8\.0\.23, then use `SHOW SLAVE STATUS`\. - -### Usage notes - -The master user must run the `mysql.rds_next_master_log` procedure\. - -**Warning** -Call `mysql.rds_next_master_log` only if replication fails after a failover of a Multi\-AZ DB instance that is the replication source, and the `Last_IO_Errno` field of `SHOW REPLICA STATUS` reports I/O error 1236\. -Calling `mysql.rds_next_master_log` can result in data loss in the read replica if transactions in the source instance were not written to the binary log on disk before the failover event occurred\. -You can reduce the chance of this happening by setting the source instance parameters `sync_binlog` and `innodb_support_xa` to `1`, although this might reduce performance\. For more information, see [Troubleshooting a MySQL read replica problem](USER_MySQL.Replication.ReadReplicas.md#USER_ReadRepl.Troubleshooting)\. - -### Examples - -Assume replication fails on an RDS for MySQL read replica\. Running `SHOW REPLICA STATUS\G` on the read replica returns the following result: - -``` -*************************** 1. row *************************** - Replica_IO_State: - Source_Host: myhost.XXXXXXXXXXXXXXX.rr-rrrr-1.rds.amazonaws.com - Source_User: MasterUser - Source_Port: 3306 - Connect_Retry: 10 - Source_Log_File: mysql-bin-changelog.012345 - Read_Source_Log_Pos: 1219393 - Relay_Log_File: relaylog.012340 - Relay_Log_Pos: 30223388 - Relay_Source_Log_File: mysql-bin-changelog.012345 - Replica_IO_Running: No - Replica_SQL_Running: Yes - Replicate_Do_DB: - Replicate_Ignore_DB: - Replicate_Do_Table: - Replicate_Ignore_Table: - Replicate_Wild_Do_Table: - Replicate_Wild_Ignore_Table: - Last_Errno: 0 - Last_Error: - Skip_Counter: 0 - Exec_Source_Log_Pos: 30223232 - Relay_Log_Space: 5248928866 - Until_Condition: None - Until_Log_File: - Until_Log_Pos: 0 - Source_SSL_Allowed: No - Source_SSL_CA_File: - Source_SSL_CA_Path: - Source_SSL_Cert: - Source_SSL_Cipher: - Source_SSL_Key: - Seconds_Behind_Master: NULL -Source_SSL_Verify_Server_Cert: No - Last_IO_Errno: 1236 - Last_IO_Error: Got fatal error 1236 from master when reading data from binary log: 'Client requested master to start replication from impossible position; the first event 'mysql-bin-changelog.013406' at 1219393, the last event read from '/rdsdbdata/log/binlog/mysql-bin-changelog.012345' at 4, the last byte read from '/rdsdbdata/log/binlog/mysql-bin-changelog.012345' at 4.' - Last_SQL_Errno: 0 - Last_SQL_Error: - Replicate_Ignore_Server_Ids: - Source_Server_Id: 67285976 -``` - -The `Last_IO_Errno` field shows that the instance is receiving I/O error 1236\. The `Master_Log_File` field shows that the file name is `mysql-bin-changelog.012345`, which means that the log file index is `12345`\. To resolve the error, you can call `mysql.rds_next_master_log` with the following parameter: - -``` -CALL mysql.rds_next_master_log(12345); -``` - -**Note** -Previous versions of MySQL used `SHOW SLAVE STATUS` instead of `SHOW REPLICA STATUS`\. If you are using a MySQL version before 8\.0\.23, then use `SHOW SLAVE STATUS`\. - -## mysql\.rds\_remove\_binlog\_ssl\_material - -Removes the certificate authority certificate, client certificate, and client key for SSL communication and encrypted replication\. This information is imported by using [mysql\.rds\_import\_binlog\_ssl\_material](#mysql_rds_import_binlog_ssl_material)\. - -### Syntax - - - -``` -CALL mysql.rds_remove_binlog_ssl_material; -``` - -## mysql\.rds\_reset\_external\_master - -Reconfigures an RDS for MySQL DB instance to no longer be a read replica of an instance of MySQL running external to Amazon RDS\. - -**Important** -To run this procedure, `autocommit` must be enabled\. To enable it, set the `autocommit` parameter to `1`\. For information about modifying parameters, see [Modifying parameters in a DB parameter group](USER_WorkingWithDBInstanceParamGroups.md#USER_WorkingWithParamGroups.Modifying)\. - -### Syntax - - - -``` -CALL mysql.rds_reset_external_master; -``` - -### Usage notes - -The master user must run the `mysql.rds_reset_external_master` procedure\. This procedure must be run on the MySQL DB instance to be removed as a read replica of a MySQL instance running external to Amazon RDS\. - -**Note** -We recommend that you use read replicas to manage replication between two Amazon RDS DB instances when possible\. When you do so, we recommend that you use only this and other replication\-related stored procedures\. These practices enable more complex replication topologies between Amazon RDS DB instances\. We offer these stored procedures primarily to enable replication with MySQL instances running external to Amazon RDS\. For information about managing replication between Amazon RDS DB instances, see [Working with DB instance read replicas](USER_ReadRepl.md)\. - -For more information about using replication to import data from an instance of MySQL running external to Amazon RDS, see [Configuring binary log file position replication with an external source instance](MySQL.Procedural.Importing.External.Repl.md)\. - -## mysql\.rds\_set\_external\_master - -Configures an RDS for MySQL DB instance to be a read replica of an instance of MySQL running external to Amazon RDS\. - -**Important** -To run this procedure, `autocommit` must be enabled\. To enable it, set the `autocommit` parameter to `1`\. For information about modifying parameters, see [Modifying parameters in a DB parameter group](USER_WorkingWithDBInstanceParamGroups.md#USER_WorkingWithParamGroups.Modifying)\. - -**Note** -You can use the [mysql\.rds\_set\_external\_master\_with\_delay](#mysql_rds_set_external_master_with_delay) stored procedure to configure an external source database instance and delayed replication\. - -### Syntax - - - -``` -CALL mysql.rds_set_external_master ( - host_name - , host_port - , replication_user_name - , replication_user_password - , mysql_binary_log_file_name - , mysql_binary_log_file_location - , ssl_encryption -); -``` - -### Parameters - - *host\_name* -The host name or IP address of the MySQL instance running external to Amazon RDS to become the source database instance\. - - *host\_port* -The port used by the MySQL instance running external to Amazon RDS to be configured as the source database instance\. If your network configuration includes Secure Shell \(SSH\) port replication that converts the port number, specify the port number that is exposed by SSH\. - - *replication\_user\_name* -The ID of a user with `REPLICATION CLIENT` and `REPLICATION SLAVE` permissions on the MySQL instance running external to Amazon RDS\. We recommend that you provide an account that is used solely for replication with the external instance\. - - *replication\_user\_password* -The password of the user ID specified in `replication_user_name`\. - - *mysql\_binary\_log\_file\_name* -The name of the binary log on the source database instance that contains the replication information\. - - *mysql\_binary\_log\_file\_location* -The location in the `mysql_binary_log_file_name` binary log at which replication starts reading the replication information\. -You can determine the binlog file name and location by running `SHOW MASTER STATUS` on the source database instance\. - - *ssl\_encryption* -A value that specifies whether Secure Socket Layer \(SSL\) encryption is used on the replication connection\. 1 specifies to use SSL encryption, 0 specifies to not use encryption\. The default is 0\. -The `MASTER_SSL_VERIFY_SERVER_CERT` option isn't supported\. This option is set to 0, which means that the connection is encrypted, but the certificates aren't verified\. - -### Usage notes - - The master user must run the `mysql.rds_set_external_master` procedure\. This procedure must be run on the MySQL DB instance to be configured as the read replica of a MySQL instance running external to Amazon RDS\. - - Before you run `mysql.rds_set_external_master`, you must configure the instance of MySQL running external to Amazon RDS to be a source database instance\. To connect to the MySQL instance running external to Amazon RDS, you must specify `replication_user_name` and `replication_user_password` values that indicate a replication user that has `REPLICATION CLIENT` and `REPLICATION SLAVE` permissions on the external instance of MySQL\. - -**To configure an external instance of MySQL as a source database instance** - -1. Using the MySQL client of your choice, connect to the external instance of MySQL and create a user account to be used for replication\. The following is an example\. - - **MySQL 5\.7** - - ``` - CREATE USER 'repl_user'@'mydomain.com' IDENTIFIED BY 'password'; - ``` - - **MySQL 8\.0** - - ``` - CREATE USER 'repl_user'@'mydomain.com' IDENTIFIED WITH mysql_native_password BY 'password'; - ``` - -1. On the external instance of MySQL, grant `REPLICATION CLIENT` and `REPLICATION SLAVE` privileges to your replication user\. The following example grants `REPLICATION CLIENT` and `REPLICATION SLAVE` privileges on all databases for the 'repl\_user' user for your domain\. - - **MySQL 5\.7** - - ``` - GRANT REPLICATION CLIENT, REPLICATION SLAVE ON *.* TO 'repl_user'@'mydomain.com' IDENTIFIED BY 'password'; - ``` - - **MySQL 8\.0** - - ``` - GRANT REPLICATION CLIENT, REPLICATION SLAVE ON *.* TO 'repl_user'@'mydomain.com'; - ``` - -To use encrypted replication, configure source database instance to use SSL connections\. Also, import the certificate authority certificate, client certificate, and client key into the DB instance or DB cluster using the [mysql\.rds\_import\_binlog\_ssl\_material](#mysql_rds_import_binlog_ssl_material) procedure\. - -**Note** -We recommend that you use read replicas to manage replication between two Amazon RDS DB instances when possible\. When you do so, we recommend that you use only this and other replication\-related stored procedures\. These practices enable more complex replication topologies between Amazon RDS DB instances\. We offer these stored procedures primarily to enable replication with MySQL instances running external to Amazon RDS\. For information about managing replication between Amazon RDS DB instances, see [Working with DB instance read replicas](USER_ReadRepl.md)\. - -After calling `mysql.rds_set_external_master` to configure an Amazon RDS DB instance as a read replica, you can call [mysql\.rds\_start\_replication](#mysql_rds_start_replication) on the read replica to start the replication process\. You can call [mysql\.rds\_reset\_external\_master](#mysql_rds_reset_external_master) to remove the read replica configuration\. - -When `mysql.rds_set_external_master` is called, Amazon RDS records the time, user, and an action of `set master` in the `mysql.rds_history` and `mysql.rds_replication_status` tables\. - -### Examples - -When run on a MySQL DB instance, the following example configures the DB instance to be a read replica of an instance of MySQL running external to Amazon RDS\. - -``` -call mysql.rds_set_external_master( - 'Externaldb.some.com', - 3306, - 'repl_user', - 'password', - 'mysql-bin-changelog.0777', - 120, - 0); -``` - -## mysql\.rds\_set\_external\_master\_with\_auto\_position - -Configures an RDS for MySQL DB instance to be a read replica of an instance of MySQL running external to Amazon RDS\. This procedure also configures delayed replication and replication based on global transaction identifiers \(GTIDs\)\. - -**Important** -To run this procedure, `autocommit` must be enabled\. To enable it, set the `autocommit` parameter to `1`\. For information about modifying parameters, see [Modifying parameters in a DB parameter group](USER_WorkingWithDBInstanceParamGroups.md#USER_WorkingWithParamGroups.Modifying)\. - -### Syntax - - - -``` -CALL mysql.rds_set_external_master_with_auto_position ( - host_name - , host_port - , replication_user_name - , replication_user_password - , ssl_encryption - , delay -); -``` - -### Parameters - - *host\_name* -The host name or IP address of the MySQL instance running external to Amazon RDS to become the source database instance\. - - *host\_port* -The port used by the MySQL instance running external to Amazon RDS to be configured as the source database instance\. If your network configuration includes Secure Shell \(SSH\) port replication that converts the port number, specify the port number that is exposed by SSH\. - - *replication\_user\_name* -The ID of a user with `REPLICATION CLIENT` and `REPLICATION SLAVE` permissions on the MySQL instance running external to Amazon RDS\. We recommend that you provide an account that is used solely for replication with the external instance\. - - *replication\_user\_password* -The password of the user ID specified in `replication_user_name`\. - - *ssl\_encryption* -A value that specifies whether Secure Socket Layer \(SSL\) encryption is used on the replication connection\. 1 specifies to use SSL encryption, 0 specifies to not use encryption\. The default is 0\. -The `MASTER_SSL_VERIFY_SERVER_CERT` option isn't supported\. This option is set to 0, which means that the connection is encrypted, but the certificates aren't verified\. - - *delay* -The minimum number of seconds to delay replication from source database instance\. -The limit for this parameter is one day \(86,400 seconds\)\. - -### Usage notes - -The master user must run the `mysql.rds_set_external_master_with_auto_position` procedure\. This procedure must be run on the MySQL DB instance to be configured as the read replica of a MySQL instance running external to Amazon RDS\. - -This procedure is supported for all RDS for MySQL 5\.7 versions, and RDS for MySQL 8\.0\.26 and higher 8\.0 versions\. - -Before you run `mysql.rds_set_external_master_with_auto_position`, you must configure the instance of MySQL running external to Amazon RDS to be a source database instance\. To connect to the MySQL instance running external to Amazon RDS, you must specify values for `replication_user_name` and `replication_user_password`\. These values must indicate a replication user that has `REPLICATION CLIENT` and `REPLICATION SLAVE` permissions on the external instance of MySQL\. - -**To configure an external instance of MySQL as a source database instance** - -1. Using the MySQL client of your choice, connect to the external instance of MySQL and create a user account to be used for replication\. The following is an example\. - - ``` - CREATE USER 'repl_user'@'mydomain.com' IDENTIFIED BY 'SomePassW0rd' - ``` - -1. On the external instance of MySQL, grant `REPLICATION CLIENT` and `REPLICATION SLAVE` privileges to your replication user\. The following example grants `REPLICATION CLIENT` and `REPLICATION SLAVE` privileges on all databases for the `'repl_user'` user for your domain\. - - ``` - GRANT REPLICATION CLIENT, REPLICATION SLAVE ON *.* TO 'repl_user'@'mydomain.com' - IDENTIFIED BY 'SomePassW0rd' - ``` - -For more information, see [Configuring binary log file position replication with an external source instance](MySQL.Procedural.Importing.External.Repl.md)\. - -**Note** -We recommend that you use read replicas to manage replication between two Amazon RDS DB instances when possible\. When you do so, we recommend that you use only this and other replication\-related stored procedures\. These practices enable more complex replication topologies between Amazon RDS DB instances\. We offer these stored procedures primarily to enable replication with MySQL instances running external to Amazon RDS\. For information about managing replication between Amazon RDS DB instances, see [Working with DB instance read replicas](USER_ReadRepl.md)\. - -After calling `mysql.rds_set_external_master_with_auto_position` to configure an Amazon RDS DB instance as a read replica, you can call [mysql\.rds\_start\_replication](#mysql_rds_start_replication) on the read replica to start the replication process\. You can call [mysql\.rds\_reset\_external\_master](#mysql_rds_reset_external_master) to remove the read replica configuration\. - -When you call `mysql.rds_set_external_master_with_auto_position`, Amazon RDS records the time, the user, and an action of `set master` in the `mysql.rds_history` and `mysql.rds_replication_status` tables\. - -For disaster recovery, you can use this procedure with the [mysql\.rds\_start\_replication\_until](#mysql_rds_start_replication_until) or [mysql\.rds\_start\_replication\_until\_gtid](#mysql_rds_start_replication_until_gtid) stored procedure\. To roll forward changes to a delayed read replica to the time just before a disaster, you can run the `mysql.rds_set_external_master_with_auto_position` procedure\. After the `mysql.rds_start_replication_until_gtid` procedure stops replication, you can promote the read replica to be the new primary DB instance by using the instructions in [Promoting a read replica to be a standalone DB instance](USER_ReadRepl.md#USER_ReadRepl.Promote)\. - -To use the `mysql.rds_rds_start_replication_until_gtid` procedure, GTID\-based replication must be enabled\. To skip a specific GTID\-based transaction that is known to cause disaster, you can use the [mysql\.rds\_skip\_transaction\_with\_gtid](#mysql_rds_skip_transaction_with_gtid) stored procedure\. For more information about working with GTID\-based replication, see [Using GTID\-based replication for Amazon RDS for MySQL](mysql-replication-gtid.md)\. - -### Examples - -When run on a MySQL DB instance, the following example configures the DB instance to be a read replica of an instance of MySQL running external to Amazon RDS\. It sets the minimum replication delay to one hour \(3,600 seconds\) on the MySQL DB instance\. A change from the MySQL source database instance running external to Amazon RDS isn't applied on the MySQL DB instance read replica for at least one hour\. - -``` -call mysql.rds_set_external_master_with_auto_position( - 'Externaldb.some.com', - 3306, - 'repl_user', - 'SomePassW0rd', - 0, - 3600); -``` - -## mysql\.rds\_set\_external\_master\_with\_delay - -Configures an RDS for MySQL DB instance to be a read replica of an instance of MySQL running external to Amazon RDS and configures delayed replication\. - -**Important** -To run this procedure, `autocommit` must be enabled\. To enable it, set the `autocommit` parameter to `1`\. For information about modifying parameters, see [Modifying parameters in a DB parameter group](USER_WorkingWithDBInstanceParamGroups.md#USER_WorkingWithParamGroups.Modifying)\. - -### Syntax - - - -``` -CALL mysql.rds_set_external_master_with_delay ( - host_name - , host_port - , replication_user_name - , replication_user_password - , mysql_binary_log_file_name - , mysql_binary_log_file_location - , ssl_encryption - , delay -); -``` - -### Parameters - - *host\_name* -The host name or IP address of the MySQL instance running external to Amazon RDS that will become the source database instance\. - - *host\_port* -The port used by the MySQL instance running external to Amazon RDS to be configured as the source database instance\. If your network configuration includes SSH port replication that converts the port number, specify the port number that is exposed by SSH\. - - *replication\_user\_name* -The ID of a user with `REPLICATION CLIENT` and `REPLICATION SLAVE` permissions on the MySQL instance running external to Amazon RDS\. We recommend that you provide an account that is used solely for replication with the external instance\. - - *replication\_user\_password* -The password of the user ID specified in `replication_user_name`\. - - *mysql\_binary\_log\_file\_name* -The name of the binary log on the source database instance contains the replication information\. - - *mysql\_binary\_log\_file\_location* -The location in the `mysql_binary_log_file_name` binary log at which replication will start reading the replication information\. -You can determine the binlog file name and location by running `SHOW MASTER STATUS` on the source database instance\. - - *ssl\_encryption* -A value that specifies whether Secure Socket Layer \(SSL\) encryption is used on the replication connection\. 1 specifies to use SSL encryption, 0 specifies to not use encryption\. The default is 0\. -The `MASTER_SSL_VERIFY_SERVER_CERT` option isn't supported\. This option is set to 0, which means that the connection is encrypted, but the certificates aren't verified\. - - *delay* -The minimum number of seconds to delay replication from source database instance\. -The limit for this parameter is one day \(86400 seconds\)\. - -### Usage notes - - The master user must run the `mysql.rds_set_external_master_with_delay` procedure\. This procedure must be run on the MySQL DB instance to be configured as the read replica of a MySQL instance running external to Amazon RDS\. - - Before you run `mysql.rds_set_external_master_with_delay`, you must configure the instance of MySQL running external to Amazon RDS to be a source database instance\. To connect to the MySQL instance running external to Amazon RDS, you must specify values for `replication_user_name` and `replication_user_password`\. These values must indicate a replication user that has `REPLICATION CLIENT` and `REPLICATION SLAVE` permissions on the external instance of MySQL\. - -**To configure an external instance of MySQL as a source database instance** - -1. Using the MySQL client of your choice, connect to the external instance of MySQL and create a user account to be used for replication\. The following is an example\. - - ``` - CREATE USER 'repl_user'@'mydomain.com' IDENTIFIED BY 'SomePassW0rd' - ``` - -1. On the external instance of MySQL, grant `REPLICATION CLIENT` and `REPLICATION SLAVE` privileges to your replication user\. The following example grants `REPLICATION CLIENT` and `REPLICATION SLAVE` privileges on all databases for the `'repl_user'` user for your domain\. - - ``` - GRANT REPLICATION CLIENT, REPLICATION SLAVE ON *.* TO 'repl_user'@'mydomain.com' - IDENTIFIED BY 'SomePassW0rd' - ``` - -For more information, see [Configuring binary log file position replication with an external source instance](MySQL.Procedural.Importing.External.Repl.md)\. - -**Note** -We recommend that you use read replicas to manage replication between two Amazon RDS DB instances when possible\. When you do so, we recommend that you use only this and other replication\-related stored procedures\. These practices enable more complex replication topologies between Amazon RDS DB instances\. We offer these stored procedures primarily to enable replication with MySQL instances running external to Amazon RDS\. For information about managing replication between Amazon RDS DB instances, see [Working with DB instance read replicas](USER_ReadRepl.md)\. - -After calling `mysql.rds_set_external_master_with_delay` to configure an Amazon RDS DB instance as a read replica, you can call [mysql\.rds\_start\_replication](#mysql_rds_start_replication) on the read replica to start the replication process\. You can call [mysql\.rds\_reset\_external\_master](#mysql_rds_reset_external_master) to remove the read replica configuration\. - -When you call `mysql.rds_set_external_master_with_delay`, Amazon RDS records the time, the user, and an action of `set master` in the `mysql.rds_history` and `mysql.rds_replication_status` tables\. - -For disaster recovery, you can use this procedure with the [mysql\.rds\_start\_replication\_until](#mysql_rds_start_replication_until) or [mysql\.rds\_start\_replication\_until\_gtid](#mysql_rds_start_replication_until_gtid) stored procedure\. To roll forward changes to a delayed read replica to the time just before a disaster, you can run the `mysql.rds_set_external_master_with_delay` procedure\. After the `mysql.rds_start_replication_until` procedure stops replication, you can promote the read replica to be the new primary DB instance by using the instructions in [Promoting a read replica to be a standalone DB instance](USER_ReadRepl.md#USER_ReadRepl.Promote)\. - -To use the `mysql.rds_rds_start_replication_until_gtid` procedure, GTID\-based replication must be enabled\. To skip a specific GTID\-based transaction that is known to cause disaster, you can use the [mysql\.rds\_skip\_transaction\_with\_gtid](#mysql_rds_skip_transaction_with_gtid) stored procedure\. For more information about working with GTID\-based replication, see [Using GTID\-based replication for Amazon RDS for MySQL](mysql-replication-gtid.md)\. - -The `mysql.rds_set_external_master_with_delay` procedure is available in these versions of RDS for MySQL: -+ MySQL 8\.0\.26 and higher 8\.0 versions -+ All 5\.7 versions - -### Examples - -When run on a MySQL DB instance, the following example configures the DB instance to be a read replica of an instance of MySQL running external to Amazon RDS\. It sets the minimum replication delay to one hour \(3,600 seconds\) on the MySQL DB instance\. A change from the MySQL source database instance running external to Amazon RDS isn't applied on the MySQL DB instance read replica for at least one hour\. - -``` -call mysql.rds_set_external_master_with_delay( - 'Externaldb.some.com', - 3306, - 'repl_user', - 'SomePassW0rd', - 'mysql-bin-changelog.000777', - 120, - 0, - 3600); -``` - -## mysql\.rds\_set\_master\_auto\_position - -Sets the replication mode to be based on either binary log file positions or on global transaction identifiers \(GTIDs\)\. - -### Syntax - - - -``` -CALL mysql.rds_set_master_auto_position ( -auto_position_mode -); -``` - -### Parameters - - *auto\_position\_mode* -A value that indicates whether to use log file position replication or GTID\-based replication: -+ `0` – Use the replication method based on binary log file position\. The default is `0`\. -+ `1` – Use the GTID\-based replication method\. - -### Usage notes - -The master user must run the `mysql.rds_set_master_auto_position` procedure\. - -This procedure is supported for all RDS for MySQL 5\.7 versions, and RDS for MySQL 8\.0\.26 and higher 8\.0 versions\. - -## mysql\.rds\_set\_source\_delay - -Sets the minimum number of seconds to delay replication from source database instance to the current read replica\. Use this procedure when you are connected to a read replica to delay replication from its source database instance\. - -### Syntax - -``` -CALL mysql.rds_set_source_delay( -delay -); -``` - -### Parameters - - *delay* -The minimum number of seconds to delay replication from the source database instance\. -The limit for this parameter is one day \(86400 seconds\)\. - -### Usage notes - -The master user must run the `mysql.rds_set_source_delay` procedure\. - -For disaster recovery, you can use this procedure with the [mysql\.rds\_start\_replication\_until](#mysql_rds_start_replication_until) stored procedure or the [mysql\.rds\_start\_replication\_until\_gtid](#mysql_rds_start_replication_until_gtid) stored procedure\. To roll forward changes to a delayed read replica to the time just before a disaster, you can run the `mysql.rds_set_source_delay` procedure\. After the `mysql.rds_start_replication_until` or `mysql.rds_start_replication_until_gtid` procedure stops replication, you can promote the read replica to be the new primary DB instance by using the instructions in [Promoting a read replica to be a standalone DB instance](USER_ReadRepl.md#USER_ReadRepl.Promote)\. - -To use the `mysql.rds_rds_start_replication_until_gtid` procedure, GTID\-based replication must be enabled\. To skip a specific GTID\-based transaction that is known to cause disaster, you can use the [mysql\.rds\_skip\_transaction\_with\_gtid](#mysql_rds_skip_transaction_with_gtid) stored procedure\. For more information on GTID\-based replication, see [Using GTID\-based replication for Amazon RDS for MySQL](mysql-replication-gtid.md)\. - -The `mysql.rds_set_source_delay` procedure is available in these versions of RDS for MySQL: -+ MySQL 8\.0\.26 and higher 8\.0 versions -+ All 5\.7 versions - -### Examples - -To delay replication from source database instance to the current read replica for at least one hour \(3,600 seconds\), you can call `mysql.rds_set_source_delay` with the following parameter: - -``` -CALL mysql.rds_set_source_delay(3600); -``` - -## mysql\.rds\_skip\_transaction\_with\_gtid - -Skips replication of a transaction with the specified global transaction identifier \(GTID\) on a MySQL DB instance\. - -You can use this procedure for disaster recovery when a specific GTID transaction is known to cause a problem\. Use this stored procedure to skip the problematic transaction\. Examples of problematic transactions include transactions that disable replication, delete important data, or cause the DB instance to become unavailable\. - -### Syntax - - - -``` -CALL mysql.rds_skip_transaction_with_gtid ( -gtid_to_skip -); -``` - -### Parameters - - *gtid\_to\_skip* -The GTID of the replication transaction to skip\. - -### Usage notes - -The master user must run the `mysql.rds_skip_transaction_with_gtid` procedure\. - -This procedure is supported for all RDS for MySQL 5\.7 versions, and RDS for MySQL 8\.0\.26 and higher 8\.0 versions\. - -### Examples - -The following example skips replication of the transaction with the GTID `3E11FA47-71CA-11E1-9E33-C80AA9429562:23`\. - -``` -call mysql.rds_skip_transaction_with_gtid('3E11FA47-71CA-11E1-9E33-C80AA9429562:23'); -``` - -## mysql\.rds\_skip\_repl\_error - -Skips and deletes a replication error on a MySQL DB read replica\. - -### Syntax - - - -``` -CALL mysql.rds_skip_repl_error; -``` - -### Usage notes - -The master user must run the `mysql.rds_skip_repl_error` procedure on a read replica\. For more information about this procedure, see [Calling the mysql\.rds\_skip\_repl\_error procedure](Appendix.MySQL.CommonDBATasks.md#Appendix.MySQL.CommonDBATasks.SkipError.procedure)\. - -To determine if there are errors, run the MySQL `SHOW REPLICA STATUS\G` command\. If a replication error isn't critical, you can run `mysql.rds_skip_repl_error` to skip the error\. If there are multiple errors, `mysql.rds_skip_repl_error` deletes the first error, then warns that others are present\. You can then use `SHOW REPLICA STATUS\G` to determine the correct course of action for the next error\. For information about the values returned, see [SHOW REPLICA STATUS statement](https://dev.mysql.com/doc/refman/8.0/en/show-replica-status.html) in the MySQL documentation\. - -**Note** -Previous versions of MySQL used `SHOW SLAVE STATUS` instead of `SHOW REPLICA STATUS`\. If you are using a MySQL version before 8\.0\.23, then use `SHOW SLAVE STATUS`\. - -For more information about addressing replication errors with Amazon RDS, see [Troubleshooting a MySQL read replica problem](USER_MySQL.Replication.ReadReplicas.md#USER_ReadRepl.Troubleshooting)\. - -#### Replication stopped error - -When you call the `mysql.rds_skip_repl_error` procedure, you might receive an error message stating that the replica is down or disabled\. - -This error message appears if you run the procedure on the primary instance instead of the read replica\. You must run this procedure on the read replica for the procedure to work\. - -This error message might also appear if you run the procedure on the read replica, but replication can't be restarted successfully\. - -If you need to skip a large number of errors, the replication lag can increase beyond the default retention period for binary log \(binlog\) files\. In this case, you might encounter a fatal error due to binlog files being purged before they have been replayed on the read replica\. This purge causes replication to stop, and you can no longer call the `mysql.rds_skip_repl_error` command to skip replication errors\. - -You can mitigate this issue by increasing the number of hours that binlog files are retained on your source database instance\. After you have increased the binlog retention time, you can restart replication and call the `mysql.rds_skip_repl_error` command as needed\. - -To set the binlog retention time, use the [mysql\.rds\_set\_configuration](mysql-stored-proc-configuring.md#mysql_rds_set_configuration) procedure and specify a configuration parameter of `'binlog retention hours'` along with the number of hours to retain binlog files on the DB cluster\. The following example sets the retention period for binlog files to 48 hours\. - -``` -CALL mysql.rds_set_configuration('binlog retention hours', 48); -``` - -## mysql\.rds\_start\_replication - -Initiates replication from an RDS for MySQL DB instance\. - -**Note** -You can use the [mysql\.rds\_start\_replication\_until](#mysql_rds_start_replication_until) or [mysql\.rds\_start\_replication\_until\_gtid](#mysql_rds_start_replication_until_gtid) stored procedure to initiate replication from an RDS for MySQL DB instance and stop replication at the specified binary log file location\. - -### Syntax - - - -``` -CALL mysql.rds_start_replication; -``` - -### Usage notes - -The master user must run the `mysql.rds_start_replication` procedure\. - -To import data from an instance of MySQL external to Amazon RDS, call `mysql.rds_start_replication` on the read replica to start the replication process after you call `mysql.rds_set_external_master` to build the replication configuration\. For more information, see [Restoring a backup into a MySQL DB instance](MySQL.Procedural.Importing.md)\. - -To export data to an instance of MySQL external to Amazon RDS, call `mysql.rds_start_replication` and `mysql.rds_stop_replication` on the read replica to control some replication actions, such as purging binary logs\. For more information, see [Exporting data from a MySQL DB instance by using replication](MySQL.Procedural.Exporting.NonRDSRepl.md)\. - -You can also call `mysql.rds_start_replication` on the read replica to restart any replication process that you previously stopped by calling `mysql.rds_stop_replication`\. For more information, see [Working with DB instance read replicas](USER_ReadRepl.md)\. - -## mysql\.rds\_start\_replication\_until - -Initiates replication from an RDS for MySQL DB instance and stops replication at the specified binary log file location\. - -### Syntax - - - -``` -CALL mysql.rds_start_replication_until ( -replication_log_file - , replication_stop_point -); -``` - -### Parameters - - *replication\_log\_file* -The name of the binary log on the source database instance contains the replication information\. - - *replication\_stop\_point * -The location in the `replication_log_file` binary log at which replication will stop\. - -### Usage notes - -The master user must run the `mysql.rds_start_replication_until` procedure\. - -The `mysql.rds_start_replication_until` procedure is available in these versions of RDS for MySQL: -+ MySQL 8\.0\.26 and higher 8\.0 versions -+ All 5\.7 versions - -You can use this procedure with delayed replication for disaster recovery\. If you have delayed replication configured, you can use this procedure to roll forward changes to a delayed read replica to the time just before a disaster\. After this procedure stops replication, you can promote the read replica to be the new primary DB instance by using the instructions in [Promoting a read replica to be a standalone DB instance](USER_ReadRepl.md#USER_ReadRepl.Promote)\. - -You can configure delayed replication using the following stored procedures: -+ [mysql\.rds\_set\_configuration](mysql-stored-proc-configuring.md#mysql_rds_set_configuration) -+ [mysql\.rds\_set\_external\_master\_with\_delay](#mysql_rds_set_external_master_with_delay) -+ [mysql\.rds\_set\_source\_delay](#mysql_rds_set_source_delay) - -The file name specified for the `replication_log_file` parameter must match the source database instance binlog file name\. - -When the `replication_stop_point ` parameter specifies a stop location that is in the past, replication is stopped immediately\. - -### Examples - -The following example initiates replication and replicates changes until it reaches location `120` in the `mysql-bin-changelog.000777` binary log file\. - -``` -call mysql.rds_start_replication_until( - 'mysql-bin-changelog.000777', - 120); -``` - -## mysql\.rds\_start\_replication\_until\_gtid - -Initiates replication from an RDS for MySQL DB instance and stops replication immediately after the specified global transaction identifier \(GTID\)\. - -### Syntax - - - -``` -CALL mysql.rds_start_replication_until_gtid(gtid); -``` - -### Parameters - - *gtid* -The GTID after which replication is to stop\. - -### Usage notes - -The master user must run the `mysql.rds_start_replication_until_gtid` procedure\. - -This procedure is supported for all RDS for MySQL 5\.7 versions, and RDS for MySQL 8\.0\.26 and higher 8\.0 versions\. - -You can use this procedure with delayed replication for disaster recovery\. If you have delayed replication configured, you can use this procedure to roll forward changes to a delayed read replica to the time just before a disaster\. After this procedure stops replication, you can promote the read replica to be the new primary DB instance by using the instructions in [Promoting a read replica to be a standalone DB instance](USER_ReadRepl.md#USER_ReadRepl.Promote)\. - -You can configure delayed replication using the following stored procedures: -+ [mysql\.rds\_set\_configuration](mysql-stored-proc-configuring.md#mysql_rds_set_configuration) -+ [mysql\.rds\_set\_external\_master\_with\_delay](#mysql_rds_set_external_master_with_delay) -+ [mysql\.rds\_set\_source\_delay](#mysql_rds_set_source_delay) - -When the `gtid` parameter specifies a transaction that has already been run by the replica, replication is stopped immediately\. - -### Examples - -The following example initiates replication and replicates changes until it reaches GTID `3E11FA47-71CA-11E1-9E33-C80AA9429562:23`\. - -``` -call mysql.rds_start_replication_until_gtid('3E11FA47-71CA-11E1-9E33-C80AA9429562:23'); -``` - -## mysql\.rds\_stop\_replication - -Stops replication from a MySQL DB instance\. - -### Syntax - - - -``` -CALL mysql.rds_stop_replication; -``` - -### Usage notes - -The master user must run the `mysql.rds_stop_replication` procedure\. - -If you are configuring replication to import data from an instance of MySQL running external to Amazon RDS, you call `mysql.rds_stop_replication` on the read replica to stop the replication process after the import has completed\. For more information, see [Restoring a backup into a MySQL DB instance](MySQL.Procedural.Importing.md)\. - -If you are configuring replication to export data to an instance of MySQL external to Amazon RDS, you call `mysql.rds_start_replication` and `mysql.rds_stop_replication` on the read replica to control some replication actions, such as purging binary logs\. For more information, see [Exporting data from a MySQL DB instance by using replication](MySQL.Procedural.Exporting.NonRDSRepl.md)\. - -You can also use `mysql.rds_stop_replication` to stop replication between two Amazon RDS DB instances\. You typically stop replication to perform a long running operation on the read replica, such as creating a large index on the read replica\. You can restart any replication process that you stopped by calling [mysql\.rds\_start\_replication](#mysql_rds_start_replication) on the read replica\. For more information, see [Working with DB instance read replicas](USER_ReadRepl.md)\. \ No newline at end of file diff --git a/doc_source/mysql-stored-proc-warming.md b/doc_source/mysql-stored-proc-warming.md deleted file mode 100644 index 2a346e8..0000000 --- a/doc_source/mysql-stored-proc-warming.md +++ /dev/null @@ -1,56 +0,0 @@ -# Warming the InnoDB cache - -The following stored procedures save, load, or cancel loading the InnoDB buffer pool on RDS for MySQL DB instances\. For more information, see [InnoDB cache warming for MySQL on Amazon RDS](MySQL.Concepts.FeatureSupport.md#MySQL.Concepts.InnoDBCacheWarming)\. - -**Topics** -+ [mysql\.rds\_innodb\_buffer\_pool\_dump\_now](#mysql_rds_innodb_buffer_pool_dump_now) -+ [mysql\.rds\_innodb\_buffer\_pool\_load\_abort](#mysql_rds_innodb_buffer_pool_load_abort) -+ [mysql\.rds\_innodb\_buffer\_pool\_load\_now](#mysql_rds_innodb_buffer_pool_load_now) - -## mysql\.rds\_innodb\_buffer\_pool\_dump\_now - -Dumps the current state of the buffer pool to disk\. - -### Syntax - - - -``` -CALL mysql.rds_innodb_buffer_pool_dump_now(); -``` - -### Usage notes - -The master user must run the `mysql.rds_innodb_buffer_pool_dump_now` procedure\. - -## mysql\.rds\_innodb\_buffer\_pool\_load\_abort - -Cancels a load of the saved buffer pool state while in progress\. - -### Syntax - - - -``` -CALL mysql.rds_innodb_buffer_pool_load_abort(); -``` - -### Usage notes - -The master user must run the `mysql.rds_innodb_buffer_pool_load_abort` procedure\. - -## mysql\.rds\_innodb\_buffer\_pool\_load\_now - -Loads the saved state of the buffer pool from disk\. - -### Syntax - - - -``` -CALL mysql.rds_innodb_buffer_pool_load_now(); -``` - -### Usage notes - -The master user must run the `mysql.rds_innodb_buffer_pool_load_now` procedure\. \ No newline at end of file diff --git a/doc_source/mysql_rds_collect_global_status_history.md b/doc_source/mysql_rds_collect_global_status_history.md deleted file mode 100644 index 30ccef0..0000000 --- a/doc_source/mysql_rds_collect_global_status_history.md +++ /dev/null @@ -1,11 +0,0 @@ -# mysql\.rds\_collect\_global\_status\_history - -Takes a snapshot on demand for the Global Status History \(GoSH\)\. For more information, see [Managing the global status history](Appendix.MySQL.CommonDBATasks.md#Appendix.MySQL.CommonDBATasks.GoSH)\. - -## Syntax - - - -``` -CALL mysql.rds_collect_global_status_history; -``` \ No newline at end of file diff --git a/doc_source/mysql_rds_disable_gsh_collector.md b/doc_source/mysql_rds_disable_gsh_collector.md deleted file mode 100644 index 84aa0fe..0000000 --- a/doc_source/mysql_rds_disable_gsh_collector.md +++ /dev/null @@ -1,11 +0,0 @@ -# mysql\.rds\_disable\_gsh\_collector - -Disables snapshots taken by the Global Status History \(GoSH\)\. For more information, see [Managing the global status history](Appendix.MySQL.CommonDBATasks.md#Appendix.MySQL.CommonDBATasks.GoSH)\. - -## Syntax - - - -``` -CALL mysql.rds_disable_gsh_collector; -``` \ No newline at end of file diff --git a/doc_source/mysql_rds_disable_gsh_rotation.md b/doc_source/mysql_rds_disable_gsh_rotation.md deleted file mode 100644 index f21c36d..0000000 --- a/doc_source/mysql_rds_disable_gsh_rotation.md +++ /dev/null @@ -1,11 +0,0 @@ -# mysql\.rds\_disable\_gsh\_rotation - -Disables rotation of the `mysql.global_status_history` table\. For more information, see [Managing the global status history](Appendix.MySQL.CommonDBATasks.md#Appendix.MySQL.CommonDBATasks.GoSH)\. - -## Syntax - - - -``` -CALL mysql.rds_disable_gsh_rotation; -``` \ No newline at end of file diff --git a/doc_source/mysql_rds_enable_gsh_collector.md b/doc_source/mysql_rds_enable_gsh_collector.md deleted file mode 100644 index 9639355..0000000 --- a/doc_source/mysql_rds_enable_gsh_collector.md +++ /dev/null @@ -1,11 +0,0 @@ -# mysql\.rds\_enable\_gsh\_collector - -Enables the Global Status History \(GoSH\) to take default snapshots at intervals specified by `rds_set_gsh_collector`\. For more information, see [Managing the global status history](Appendix.MySQL.CommonDBATasks.md#Appendix.MySQL.CommonDBATasks.GoSH)\. - -## Syntax - - - -``` -CALL mysql.rds_enable_gsh_collector; -``` \ No newline at end of file diff --git a/doc_source/mysql_rds_enable_gsh_rotation.md b/doc_source/mysql_rds_enable_gsh_rotation.md deleted file mode 100644 index 0c3cba8..0000000 --- a/doc_source/mysql_rds_enable_gsh_rotation.md +++ /dev/null @@ -1,11 +0,0 @@ -# mysql\.rds\_enable\_gsh\_rotation - -Enables rotation of the contents of the `mysql.global_status_history` table to `mysql.global_status_history_old` at intervals specified by `rds_set_gsh_rotation`\. For more information, see [Managing the global status history](Appendix.MySQL.CommonDBATasks.md#Appendix.MySQL.CommonDBATasks.GoSH)\. - -## Syntax - - - -``` -CALL mysql.rds_enable_gsh_rotation; -``` \ No newline at end of file diff --git a/doc_source/mysql_rds_import_binlog_ssl_material.md b/doc_source/mysql_rds_import_binlog_ssl_material.md deleted file mode 100644 index 4dd5042..0000000 --- a/doc_source/mysql_rds_import_binlog_ssl_material.md +++ /dev/null @@ -1,81 +0,0 @@ -# mysql\.rds\_import\_binlog\_ssl\_material - -Imports the certificate authority certificate, client certificate, and client key into an Aurora MySQL DB cluster\. The information is required for SSL communication and encrypted replication\. - -**Note** -Currently, this procedure is supported for Aurora MySQL version 1; version 2: 2\.09\.2, 2\.10\.0, 2\.10\.1, and 2\.11\.0; and version 3: 3\.01\.1 and higher\. - -## Syntax - - - -``` -CALL mysql.rds_import_binlog_ssl_material ( - ssl_material -); -``` - -## Parameters - - *ssl\_material* -JSON payload that contains the contents of the following \.pem format files for a MySQL client: -+ "ssl\_ca":"*Certificate authority certificate*" -+ "ssl\_cert":"*Client certificate*" -+ "ssl\_key":"*Client key*" - -## Usage notes - -Prepare for encrypted replication before you run this procedure: -+ If you don't have SSL enabled on the external MySQL source database instance and don't have a client key and client certificate prepared, enable SSL on the MySQL database server and generate the required client key and client certificate\. -+ If SSL is enabled on the external source database instance, supply a client key and certificate for the Aurora MySQL DB cluster\. If you don't have these, generate a new key and certificate for the Aurora MySQL DB cluster\. To sign the client certificate, you must have the certificate authority key you used to configure SSL on the external MySQL source database instance\. - -For more information, see [ Creating SSL certificates and keys using openssl](https://dev.mysql.com/doc/refman/8.0/en/creating-ssl-files-using-openssl.html) in the MySQL documentation\. - -**Important** -After you prepare for encrypted replication, use an SSL connection to run this procedure\. The client key must not be transferred across an insecure connection\. - -This procedure imports SSL information from an external MySQL database into an Aurora MySQL DB cluster\. The SSL information is in \.pem format files that contain the SSL information for the Aurora MySQL DB cluster\. During encrypted replication, the Aurora MySQL DB cluster acts a client to the MySQL database server\. The certificates and keys for the Aurora MySQL client are in files in \.pem format\. - -You can copy the information from these files into the `ssl_material` parameter in the correct JSON payload\. To support encrypted replication, import this SSL information into the Aurora MySQL DB cluster\. - -The JSON payload must be in the following format\. - -``` -'{"ssl_ca":"-----BEGIN CERTIFICATE----- -ssl_ca_pem_body_code ------END CERTIFICATE-----\n","ssl_cert":"-----BEGIN CERTIFICATE----- -ssl_cert_pem_body_code ------END CERTIFICATE-----\n","ssl_key":"-----BEGIN RSA PRIVATE KEY----- -ssl_key_pem_body_code ------END RSA PRIVATE KEY-----\n"}' -``` - -## Examples - -The following example imports SSL information into an Aurora MySQL DB cluster\. In \.pem format files, the body code typically is longer than the body code shown in the example\. - -``` -call mysql.rds_import_binlog_ssl_material( -'{"ssl_ca":"-----BEGIN CERTIFICATE----- -AAAAB3NzaC1yc2EAAAADAQABAAABAQClKsfkNkuSevGj3eYhCe53pcjqP3maAhDFcvBS7O6V -hz2ItxCih+PnDSUaw+WNQn/mZphTk/a/gU8jEzoOWbkM4yxyb/wB96xbiFveSFJuOp/d6RJhJOI0iBXr -lsLnBItntckiJ7FbtxJMXLvvwJryDUilBMTjYtwB+QhYXUMOzce5Pjz5/i8SeJtjnV3iAoG/cQk+0FzZ -qaeJAAHco+CY/5WrUBkrHmFJr6HcXkvJdWPkYQS3xqC0+FmUZofz221CBt5IMucxXPkX4rWi+z7wB3Rb -BQoQzd8v7yeb7OzlPnWOyN0qFU0XA246RA8QFYiCNYwI3f05p6KLxEXAMPLE ------END CERTIFICATE-----\n","ssl_cert":"-----BEGIN CERTIFICATE----- -AAAAB3NzaC1yc2EAAAADAQABAAABAQClKsfkNkuSevGj3eYhCe53pcjqP3maAhDFcvBS7O6V -hz2ItxCih+PnDSUaw+WNQn/mZphTk/a/gU8jEzoOWbkM4yxyb/wB96xbiFveSFJuOp/d6RJhJOI0iBXr -lsLnBItntckiJ7FbtxJMXLvvwJryDUilBMTjYtwB+QhYXUMOzce5Pjz5/i8SeJtjnV3iAoG/cQk+0FzZ -qaeJAAHco+CY/5WrUBkrHmFJr6HcXkvJdWPkYQS3xqC0+FmUZofz221CBt5IMucxXPkX4rWi+z7wB3Rb -BQoQzd8v7yeb7OzlPnWOyN0qFU0XA246RA8QFYiCNYwI3f05p6KLxEXAMPLE ------END CERTIFICATE-----\n","ssl_key":"-----BEGIN RSA PRIVATE KEY----- -AAAAB3NzaC1yc2EAAAADAQABAAABAQClKsfkNkuSevGj3eYhCe53pcjqP3maAhDFcvBS7O6V -hz2ItxCih+PnDSUaw+WNQn/mZphTk/a/gU8jEzoOWbkM4yxyb/wB96xbiFveSFJuOp/d6RJhJOI0iBXr -lsLnBItntckiJ7FbtxJMXLvvwJryDUilBMTjYtwB+QhYXUMOzce5Pjz5/i8SeJtjnV3iAoG/cQk+0FzZ -qaeJAAHco+CY/5WrUBkrHmFJr6HcXkvJdWPkYQS3xqC0+FmUZofz221CBt5IMucxXPkX4rWi+z7wB3Rb -BQoQzd8v7yeb7OzlPnWOyN0qFU0XA246RA8QFYiCNYwI3f05p6KLxEXAMPLE ------END RSA PRIVATE KEY-----\n"}'); -``` - -**Note** -For information about using Amazon Aurora, see the [https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/CHAP_AuroraOverview.html](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/CHAP_AuroraOverview.html)\. \ No newline at end of file diff --git a/doc_source/mysql_rds_innodb_buffer_pool_dump_now.md b/doc_source/mysql_rds_innodb_buffer_pool_dump_now.md deleted file mode 100644 index 1e4249d..0000000 --- a/doc_source/mysql_rds_innodb_buffer_pool_dump_now.md +++ /dev/null @@ -1,15 +0,0 @@ -# mysql\.rds\_innodb\_buffer\_pool\_dump\_now - -Dumps the current state of the buffer pool to disk\. For more information, see [InnoDB cache warming for MySQL on Amazon RDS](MySQL.Concepts.FeatureSupport.md#MySQL.Concepts.InnoDBCacheWarming)\. - -## Syntax - - - -``` -CALL mysql.rds_innodb_buffer_pool_dump_now(); -``` - -## Usage notes - -The master user must run the `mysql.rds_innodb_buffer_pool_dump_now` procedure\. \ No newline at end of file diff --git a/doc_source/mysql_rds_innodb_buffer_pool_load_abort.md b/doc_source/mysql_rds_innodb_buffer_pool_load_abort.md deleted file mode 100644 index 3f7ffd2..0000000 --- a/doc_source/mysql_rds_innodb_buffer_pool_load_abort.md +++ /dev/null @@ -1,15 +0,0 @@ -# mysql\.rds\_innodb\_buffer\_pool\_load\_abort - -Cancels a load of the saved buffer pool state while in progress\. For more information, see [InnoDB cache warming for MySQL on Amazon RDS](MySQL.Concepts.FeatureSupport.md#MySQL.Concepts.InnoDBCacheWarming)\. - -## Syntax - - - -``` -CALL mysql.rds_innodb_buffer_pool_load_abort(); -``` - -## Usage notes - -The master user must run the `mysql.rds_innodb_buffer_pool_load_abort` procedure\. \ No newline at end of file diff --git a/doc_source/mysql_rds_innodb_buffer_pool_load_now.md b/doc_source/mysql_rds_innodb_buffer_pool_load_now.md deleted file mode 100644 index dc6486c..0000000 --- a/doc_source/mysql_rds_innodb_buffer_pool_load_now.md +++ /dev/null @@ -1,15 +0,0 @@ -# mysql\.rds\_innodb\_buffer\_pool\_load\_now - -Loads the saved state of the buffer pool from disk\. For more information, see [InnoDB cache warming for MySQL on Amazon RDS](MySQL.Concepts.FeatureSupport.md#MySQL.Concepts.InnoDBCacheWarming)\. - -## Syntax - - - -``` -CALL mysql.rds_innodb_buffer_pool_load_now(); -``` - -## Usage notes - -The master user must run the `mysql.rds_innodb_buffer_pool_load_now` procedure\. \ No newline at end of file diff --git a/doc_source/mysql_rds_kill.md b/doc_source/mysql_rds_kill.md deleted file mode 100644 index 5d73f8a..0000000 --- a/doc_source/mysql_rds_kill.md +++ /dev/null @@ -1,28 +0,0 @@ -# mysql\.rds\_kill - -Ends a connection to the MySQL server\. - -## Syntax - - - -``` -CALL mysql.rds_kill(processID); -``` - -## Parameters - - *processID* -The identity of the connection thread to be ended\. - -## Usage notes - -Each connection to the MySQL server runs in a separate thread\. To end a connection, use the `mysql.rds_kill` procedure and pass in the thread ID of that connection\. To obtain the thread ID, use the MySQL [SHOW PROCESSLIST](https://dev.mysql.com/doc/refman/8.0/en/show-processlist.html) command\. - -## Examples - -The following example ends a connection with a thread ID of 4243: - -``` -call mysql.rds_kill(4243); -``` \ No newline at end of file diff --git a/doc_source/mysql_rds_kill_query.md b/doc_source/mysql_rds_kill_query.md deleted file mode 100644 index c816655..0000000 --- a/doc_source/mysql_rds_kill_query.md +++ /dev/null @@ -1,28 +0,0 @@ -# mysql\.rds\_kill\_query - -Ends a query running against the MySQL server\. - -## Syntax - - - -``` -CALL mysql.rds_kill_query(queryID); -``` - -## Parameters - - *queryID* -The identity of the query to be ended\. - -## Usage notes - -To stop a query running against the MySQL server, use the `mysql_rds_kill_query` procedure and pass in the ID of that query\. To obtain the query ID, query the MySQL [INFORMATION\_SCHEMA PROCESSLIST table](https://dev.mysql.com/doc/refman/8.0/en/information-schema-processlist-table.html)\. The connection to the MySQL server is retained\. - -## Examples - -The following example stops a query with a thread ID of 230040: - -``` -call mysql.rds_kill_query(230040); -``` \ No newline at end of file diff --git a/doc_source/mysql_rds_kill_query_id.md b/doc_source/mysql_rds_kill_query_id.md deleted file mode 100644 index bb724ee..0000000 --- a/doc_source/mysql_rds_kill_query_id.md +++ /dev/null @@ -1,33 +0,0 @@ -# mysql\.rds\_kill\_query\_id - -Ends a query running against the MariaDB server\. - -## Syntax - -``` -CALL mysql.rds_kill_query_id(queryID); -``` - -## Parameters - - *queryID* -Integer\. The identity of the query to be ended\. - -## Usage notes - -To stop a query running against the MariaDB server, use the `mysql.rds_kill_query_id` procedure and pass in the ID of that query\. To obtain the query ID, query the MariaDB [Information schema PROCESSLIST table](http://mariadb.com/kb/en/mariadb/information-schema-processlist-table/), as shown following: - -``` -SELECT USER, HOST, COMMAND, TIME, STATE, INFO, QUERY_ID FROM - INFORMATION_SCHEMA.PROCESSLIST WHERE USER = ''; -``` - -The connection to the MariaDB server is retained\. - -## Examples - -The following example ends a query with a query ID of 230040: - -``` -call mysql.rds_kill_query_id(230040); -``` \ No newline at end of file diff --git a/doc_source/mysql_rds_next_master_log.md b/doc_source/mysql_rds_next_master_log.md deleted file mode 100644 index 69f5a6f..0000000 --- a/doc_source/mysql_rds_next_master_log.md +++ /dev/null @@ -1,84 +0,0 @@ -# mysql\.rds\_next\_master\_log - -Changes the source database instance log position to the start of the next binary log on the source database instance\. Use this procedure only if you are receiving replication I/O error 1236 on a read replica\. - -## Syntax - - - -``` -CALL mysql.rds_next_master_log( -curr_master_log -); -``` - -## Parameters - - *curr\_master\_log* -The index of the current master log file\. For example, if the current file is named `mysql-bin-changelog.012345`, then the index is 12345\. To determine the current master log file name, run the `SHOW REPLICA STATUS` command and view the `Master_Log_File` field\. -Previous versions of MySQL used `SHOW SLAVE STATUS` instead of `SHOW REPLICA STATUS`\. If you are using a MySQL version before 8\.0\.23, then use `SHOW SLAVE STATUS`\. - -## Usage notes - -The master user must run the `mysql.rds_next_master_log` procedure\. - -**Warning** -Call `mysql.rds_next_master_log` only if replication fails after a failover of a Multi\-AZ DB instance that is the replication source, and the `Last_IO_Errno` field of `SHOW REPLICA STATUS` reports I/O error 1236\. -Calling `mysql.rds_next_master_log` may result in data loss in the read replica if transactions in the source instance were not written to the binary log on disk before the failover event occurred\. You can reduce the chance of this happening by configuring the source instance parameters sync\_binlog = 1 and innodb\_support\_xa = 1, although this may reduce performance\. For more information, see [Working with read replicas](USER_ReadRepl.md)\. - -## Examples - -Assume replication fails on an Amazon RDS read replica\. Running `SHOW REPLICA STATUS\G` on the read replica returns the following result: - -``` -*************************** 1. row *************************** - Replica_IO_State: - Source_Host: myhost.XXXXXXXXXXXXXXX.rr-rrrr-1.rds.amazonaws.com - Source_User: MasterUser - Source_Port: 3306 - Connect_Retry: 10 - Source_Log_File: mysql-bin-changelog.012345 - Read_Source_Log_Pos: 1219393 - Relay_Log_File: relaylog.012340 - Relay_Log_Pos: 30223388 - Relay_Source_Log_File: mysql-bin-changelog.012345 - Replica_IO_Running: No - Replica_SQL_Running: Yes - Replicate_Do_DB: - Replicate_Ignore_DB: - Replicate_Do_Table: - Replicate_Ignore_Table: - Replicate_Wild_Do_Table: - Replicate_Wild_Ignore_Table: - Last_Errno: 0 - Last_Error: - Skip_Counter: 0 - Exec_Source_Log_Pos: 30223232 - Relay_Log_Space: 5248928866 - Until_Condition: None - Until_Log_File: - Until_Log_Pos: 0 - Source_SSL_Allowed: No - Source_SSL_CA_File: - Source_SSL_CA_Path: - Source_SSL_Cert: - Source_SSL_Cipher: - Source_SSL_Key: - Seconds_Behind_Master: NULL -Source_SSL_Verify_Server_Cert: No - Last_IO_Errno: 1236 - Last_IO_Error: Got fatal error 1236 from master when reading data from binary log: 'Client requested master to start replication from impossible position; the first event 'mysql-bin-changelog.013406' at 1219393, the last event read from '/rdsdbdata/log/binlog/mysql-bin-changelog.012345' at 4, the last byte read from '/rdsdbdata/log/binlog/mysql-bin-changelog.012345' at 4.' - Last_SQL_Errno: 0 - Last_SQL_Error: - Replicate_Ignore_Server_Ids: - Source_Server_Id: 67285976 -``` - -The `Last_IO_Errno` field shows that the instance is receiving I/O error 1236\. The `Master_Log_File` field shows that the file name is `mysql-bin-changelog.012345`, which means that the log file index is `12345`\. To resolve the error, you can call `mysql.rds_next_master_log` with the following parameter: - -``` -CALL mysql.rds_next_master_log(12345); -``` - -**Note** -Previous versions of MySQL used `SHOW SLAVE STATUS` instead of `SHOW REPLICA STATUS`\. If you are using a MySQL version before 8\.0\.23, then use `SHOW SLAVE STATUS`\. \ No newline at end of file diff --git a/doc_source/mysql_rds_remove_binlog_ssl_material.md b/doc_source/mysql_rds_remove_binlog_ssl_material.md deleted file mode 100644 index 629c198..0000000 --- a/doc_source/mysql_rds_remove_binlog_ssl_material.md +++ /dev/null @@ -1,14 +0,0 @@ -# mysql\.rds\_remove\_binlog\_ssl\_material - -Removes the certificate authority certificate, client certificate, and client key for SSL communication and encrypted replication\. This information is imported by using [mysql\.rds\_import\_binlog\_ssl\_material](mysql_rds_import_binlog_ssl_material.md)\. - -**Note** -Currently, this procedure is only supported for Aurora MySQL version 5\.6\. - -## Syntax - - - -``` -CALL mysql.rds_remove_binlog_ssl_material; -``` \ No newline at end of file diff --git a/doc_source/mysql_rds_replica_status.md b/doc_source/mysql_rds_replica_status.md deleted file mode 100644 index 68cb5f6..0000000 --- a/doc_source/mysql_rds_replica_status.md +++ /dev/null @@ -1,89 +0,0 @@ -# mysql\.rds\_replica\_status - -Shows the replication status of a MariaDB read replica\. - -Call this procedure on the read replica to show status information on essential parameters of the replica threads\. - -## Syntax - -``` -CALL mysql.rds_replica_status; -``` - -## Usage notes - -This procedure is only supported for MariaDB DB instances running MariaDB version 10\.5 and higher\. - -This procedure is the equivalent of the `SHOW REPLICA STATUS` command\. This command isn't supported for MariaDB version 10\.5 and higher DB instances\. - -In prior versions of MariaDB, the equivalent `SHOW SLAVE STATUS` command required the `REPLICATION SLAVE` privilege\. In MariaDB version 10\.5 and higher, it requires the `REPLICATION REPLICA ADMIN` privilege\. To protect the RDS management of MariaDB 10\.5 and higher DB instances, this new privilege isn't granted to the RDS master user\. - -## Examples - -The following example shows the status of a MariaDB read replica: - -``` -call mysql.rds_replica_status; -``` - -The response is similar to the following: - -``` -*************************** 1. row *************************** - Replica_IO_State: Waiting for master to send event - Source_Host: XX.XX.XX.XXX - Source_User: rdsrepladmin - Source_Port: 3306 - Connect_Retry: 60 - Source_Log_File: mysql-bin-changelog.003988 - Read_Source_Log_Pos: 405 - Relay_Log_File: relaylog.011024 - Relay_Log_Pos: 657 - Relay_Source_Log_File: mysql-bin-changelog.003988 - Replica_IO_Running: Yes - Replica_SQL_Running: Yes - Replicate_Do_DB: - Replicate_Ignore_DB: - Replicate_Do_Table: - Replicate_Ignore_Table: mysql.rds_sysinfo,mysql.rds_history,mysql.rds_replication_status - Replicate_Wild_Do_Table: - Replicate_Wild_Ignore_Table: - Last_Errno: 0 - Last_Error: - Skip_Counter: 0 - Exec_Source_Log_Pos: 405 - Relay_Log_Space: 1016 - Until_Condition: None - Until_Log_File: - Until_Log_Pos: 0 - Source_SSL_Allowed: No - Source_SSL_CA_File: - Source_SSL_CA_Path: - Source_SSL_Cert: - Source_SSL_Cipher: - Source_SSL_Key: - Seconds_Behind_Master: 0 - Source_SSL_Verify_Server_Cert: No - Last_IO_Errno: 0 - Last_IO_Error: - Last_SQL_Errno: 0 - Last_SQL_Error: - Replicate_Ignore_Server_Ids: - Source_Server_Id: 807509301 - Source_SSL_Crl: - Source_SSL_Crlpath: - Using_Gtid: Slave_Pos - Gtid_IO_Pos: 0-807509301-3980 - Replicate_Do_Domain_Ids: - Replicate_Ignore_Domain_Ids: - Parallel_Mode: optimistic - SQL_Delay: 0 - SQL_Remaining_Delay: NULL - Replica_SQL_Running_State: Reading event from the relay log - Replica_DDL_Groups: 15 -Replica_Non_Transactional_Groups: 0 - Replica_Transactional_Groups: 3658 -1 row in set (0.000 sec) - -Query OK, 0 rows affected (0.000 sec) -``` \ No newline at end of file diff --git a/doc_source/mysql_rds_reset_external_master.md b/doc_source/mysql_rds_reset_external_master.md deleted file mode 100644 index 0b09730..0000000 --- a/doc_source/mysql_rds_reset_external_master.md +++ /dev/null @@ -1,23 +0,0 @@ -# mysql\.rds\_reset\_external\_master - -Reconfigures a MySQL DB instance to no longer be a read replica of an instance of MySQL running external to Amazon RDS\. - -**Important** -To run this procedure, `autocommit` must be enabled\. To enable it, set the `autocommit` parameter to `1`\. For information about modifying parameters, see [Modifying parameters in a DB parameter group](USER_WorkingWithDBInstanceParamGroups.md#USER_WorkingWithParamGroups.Modifying)\. - -## Syntax - - - -``` -CALL mysql.rds_reset_external_master; -``` - -## Usage notes - -The master user must run the `mysql.rds_reset_external_master` procedure\. This procedure must be run on the MySQL DB instance to be removed as a read replica of a MySQL instance running external to Amazon RDS\. - -**Note** -We recommend that you use read replicas to manage replication between two Amazon RDS DB instances when possible\. When you do so, we recommend that you use only this and other replication\-related stored procedures\. These practices enable more complex replication topologies between Amazon RDS DB instances\. We offer these stored procedures primarily to enable replication with MySQL instances running external to Amazon RDS\. For information about managing replication between Amazon RDS DB instances, see [Working with read replicas](USER_ReadRepl.md)\. - -For more information about using replication to import data from an instance of MySQL running external to Amazon RDS, see [Restoring a backup into a MySQL DB instance](MySQL.Procedural.Importing.md)\. \ No newline at end of file diff --git a/doc_source/mysql_rds_reset_external_source.md b/doc_source/mysql_rds_reset_external_source.md deleted file mode 100644 index a74891b..0000000 --- a/doc_source/mysql_rds_reset_external_source.md +++ /dev/null @@ -1,23 +0,0 @@ -# mysql\.rds\_reset\_external\_source - -Reconfigures a MySQL DB instance to no longer be a read replica of an instance of MySQL running external to Amazon RDS\. - -**Important** -To run this procedure, `autocommit` must be enabled\. To enable it, set the `autocommit` parameter to `1`\. For information about modifying parameters, see [Modifying parameters in a DB parameter group](USER_WorkingWithDBInstanceParamGroups.md#USER_WorkingWithParamGroups.Modifying)\. - -## Syntax - - - -``` -CALL mysql.rds_reset_external_source; -``` - -## Usage notes - -The master user must run the `mysql.rds_reset_external_source` procedure\. This procedure must be run on the MySQL DB instance to be removed as a read replica of a MySQL instance running external to Amazon RDS\. - -**Note** -We recommend that you use read replicas to manage replication between two Amazon RDS DB instances when possible\. When you do so, we recommend that you use only this and other replication\-related stored procedures\. These practices enable more complex replication topologies between Amazon RDS DB instances\. We offer these stored procedures primarily to enable replication with MySQL instances running external to Amazon RDS\. For information about managing replication between Amazon RDS DB instances, see [Working with read replicas](USER_ReadRepl.md)\. - -For more information about using replication to import data from an instance of MySQL running external to Amazon RDS, see [Restoring a backup into a MySQL DB instance](MySQL.Procedural.Importing.md)\. \ No newline at end of file diff --git a/doc_source/mysql_rds_rotate_general_log.md b/doc_source/mysql_rds_rotate_general_log.md deleted file mode 100644 index 88531ad..0000000 --- a/doc_source/mysql_rds_rotate_general_log.md +++ /dev/null @@ -1,17 +0,0 @@ -# mysql\.rds\_rotate\_general\_log - -Rotates the `mysql.general_log` table to a backup table\. For more information, see [MySQL database log files](USER_LogAccess.Concepts.MySQL.md)\. - -## Syntax - - - -``` -CALL mysql.rds_rotate_general_log; -``` - -## Usage notes - -You can rotate the `mysql.general_log` table to a backup table by calling the `mysql.rds_rotate_general_log` procedure\. When log tables are rotated, the current log table is copied to a backup log table and the entries in the current log table are removed\. If a backup log table already exists, then it is deleted before the current log table is copied to the backup\. You can query the backup log table if needed\. The backup log table for the `mysql.general_log` table is named `mysql.general_log_backup`\. - -You can run this procedure only when the `log_output` parameter is set to `TABLE`\. \ No newline at end of file diff --git a/doc_source/mysql_rds_rotate_global_status_history.md b/doc_source/mysql_rds_rotate_global_status_history.md deleted file mode 100644 index 32668e5..0000000 --- a/doc_source/mysql_rds_rotate_global_status_history.md +++ /dev/null @@ -1,11 +0,0 @@ -# mysql\.rds\_rotate\_global\_status\_history - -Rotates the contents of the `mysql.global_status_history` table to `mysql.global_status_history_old` on demand\. For more information, see [Managing the global status history](Appendix.MySQL.CommonDBATasks.md#Appendix.MySQL.CommonDBATasks.GoSH)\. - -## Syntax - - - -``` -CALL mysql.rds_rotate_global_status_history; -``` \ No newline at end of file diff --git a/doc_source/mysql_rds_rotate_slow_log.md b/doc_source/mysql_rds_rotate_slow_log.md deleted file mode 100644 index 30ca3cf..0000000 --- a/doc_source/mysql_rds_rotate_slow_log.md +++ /dev/null @@ -1,17 +0,0 @@ -# mysql\.rds\_rotate\_slow\_log - -Rotates the `mysql.slow_log` table to a backup table\. For more information, see [MySQL database log files](USER_LogAccess.Concepts.MySQL.md)\. - -## Syntax - - - -``` -CALL mysql.rds_rotate_slow_log; -``` - -## Usage notes - -You can rotate the `mysql.slow_log` table to a backup table by calling the `mysql.rds_rotate_slow_log` procedure\. When log tables are rotated, the current log table is copied to a backup log table and the entries in the current log table are removed\. If a backup log table already exists, then it is deleted before the current log table is copied to the backup\. - -You can query the backup log table if needed\. The backup log table for the `mysql.slow_log` table is named `mysql.slow_log_backup`\. \ No newline at end of file diff --git a/doc_source/mysql_rds_set_configuration.md b/doc_source/mysql_rds_set_configuration.md deleted file mode 100644 index cc972db..0000000 --- a/doc_source/mysql_rds_set_configuration.md +++ /dev/null @@ -1,76 +0,0 @@ -# mysql\.rds\_set\_configuration - -Specifies the number of hours to retain binary logs or the number of seconds to delay replication\. - -## Syntax - - - -``` -CALL mysql.rds_set_configuration(name,value); -``` - -## Parameters - - *name* -The name of the configuration parameter to set\. - - *value* -The value of the configuration parameter\. - -## Usage notes - -The `mysql.rds_set_configuration` procedure supports the following configuration parameters: -+ [Binlog retention hours](#mysql_rds_set_configuration-usage-notes.binlog-retention-hours) -+ [Source delay ](#mysql_rds_set_configuration-usage-notes.source-delay) -+ [Target delay](#mysql_rds_set_configuration-usage-notes.target-delay) - -The configuration parameters are stored permanently and survive any DB instance reboot or failover\. - -### Binlog retention hours - -The `binlog retention hours` parameter is used to specify the number of hours to retain binary log files\. Amazon RDS normally purges a binary log as soon as possible, but the binary log might still be required for replication with a MySQL database external to Amazon RDS\. The default value of `binlog retention hours` is `NULL`\. This default value is interpreted as follows: -+ For RDS for MySQL, `NULL` means binary logs are not retained \(0 hours\)\. -+ For Aurora MySQL, `NULL` means binary logs are cleaned up lazily\. Aurora MySQL binary logs might remain in the system for a certain period, usually not longer than a day\. - -To specify the number of hours for Amazon RDS to retain binary logs on a DB instance, use the `mysql.rds_set_configuration` stored procedure and specify a period with enough time for replication to occur, as shown in the following example\. - -`call mysql.rds_set_configuration('binlog retention hours', 24);` - -For MySQL DB instances, the maximum `binlog retention hours` value is 168 \(7 days\)\. - -After you set the retention period, monitor storage usage for the DB instance to make sure that the retained binary logs don't take up too much storage\. - -### Source delay - -Use the `source delay` parameter in a read replica to specify the number of seconds to delay replication from the read replica to its source DB instance\. Amazon RDS normally replicates changes as soon as possible, but you might want some environments to delay replication\. For example, when replication is delayed, you can roll forward a delayed read replica to the time just before a disaster\. If a table is dropped accidentally, you can use delayed replication to quickly recover it\. The default value of `target delay` is `0` \(don't delay replication\)\. - -When you use this parameter, it runs [mysql\.rds\_set\_source\_delay](mysql_rds_set_source_delay.md) and applies CHANGE primary TO MASTER\_DELAY = input value\. If successful, the procedure saves the `source delay` parameter to the `mysql.rds_configuration` table\. - -To specify the number of seconds for Amazon RDS to delay replication to a source DB instance, use the `mysql.rds_set_configuration` stored procedure and specify the number of seconds to delay replication\. In the following example, the replication is delayed by at least one hour \(3,600 seconds\)\. - -`call mysql.rds_set_configuration('source delay', 3600);` - -The procedure then runs `mysql.rds_set_source_delay(3600)`\. - -The limit for the `source delay` parameter is one day \(86400 seconds\)\. - -**Note** -The `source delay` parameter isn't supported for RDS for MySQL version 8\.0 or MariaDB versions below 10\.2\. - -### Target delay - -Use the `target delay` parameter to specify the number of seconds to delay replication between a DB instance and any future RDS\-managed read replicas created from this instance\. This parameter is ignored for non\-RDS\-managed read replicas\. Amazon RDS normally replicates changes as soon as possible, but you might want some environments to delay replication\. For example, when replication is delayed, you can roll forward a delayed read replica to the time just before a disaster\. If a table is dropped accidentally, you can use delayed replication to recover it quickly\. The default value of `target delay` is `0` \(don't delay replication\)\. - -For disaster recovery, you can use this configuration parameter with the [mysql\.rds\_start\_replication\_until](mysql_rds_start_replication_until.md) stored procedure or the [mysql\.rds\_start\_replication\_until\_gtid](mysql_rds_start_replication_until_gtid.md) stored procedure\. To roll forward changes to a delayed read replica to the time just before a disaster, you can run the `mysql.rds_set_configuration` procedure with this parameter set\. After the `mysql.rds_start_replication_until` or `mysql.rds_start_replication_until_gtid` procedure stops replication, you can promote the read replica to be the new primary DB instance by using the instructions in [Promoting a read replica to be a standalone DB instance](USER_ReadRepl.md#USER_ReadRepl.Promote)\. - -To use the `mysql.rds_rds_start_replication_until_gtid` procedure, GTID\-based replication must be enabled\. To skip a specific GTID\-based transaction that is known to cause disaster, you can use the [mysql\.rds\_skip\_transaction\_with\_gtid](mysql_rds_skip_transaction_with_gtid.md) stored procedure\. For more information about working with GTID\-based replication, see [Using GTID\-based replication for Amazon RDS for MySQL](mysql-replication-gtid.md)\. - -To specify the number of seconds for Amazon RDS to delay replication to a read replica, use the `mysql.rds_set_configuration` stored procedure and specify the number of seconds to delay replication\. The following example specifies that replication is delayed by at least one hour \(3,600 seconds\)\. - -`call mysql.rds_set_configuration('target delay', 3600);` - -The limit for the `target delay` parameter is one day \(86400 seconds\)\. - -**Note** -The `target delay` parameter isn't supported for RDS for MySQL version 8\.0 or MariaDB versions below 10\.2\. \ No newline at end of file diff --git a/doc_source/mysql_rds_set_external_master.md b/doc_source/mysql_rds_set_external_master.md deleted file mode 100644 index b0479d8..0000000 --- a/doc_source/mysql_rds_set_external_master.md +++ /dev/null @@ -1,110 +0,0 @@ -# mysql\.rds\_set\_external\_master - -Configures a MySQL DB instance to be a read replica of an instance of MySQL running external to Amazon RDS\. - -**Important** -To run this procedure, `autocommit` must be enabled\. To enable it, set the `autocommit` parameter to `1`\. For information about modifying parameters, see [Modifying parameters in a DB parameter group](USER_WorkingWithDBInstanceParamGroups.md#USER_WorkingWithParamGroups.Modifying)\. - -**Note** -You can use the [mysql\.rds\_set\_external\_master\_with\_delay](mysql_rds_set_external_master_with_delay.md) stored procedure to configure an external source database instance and delayed replication\. - -## Syntax - - - -``` -CALL mysql.rds_set_external_master ( - host_name - , host_port - , replication_user_name - , replication_user_password - , mysql_binary_log_file_name - , mysql_binary_log_file_location - , ssl_encryption -); -``` - -## Parameters - - *host\_name* -The host name or IP address of the MySQL instance running external to Amazon RDS to become the source database instance\. - - *host\_port* -The port used by the MySQL instance running external to Amazon RDS to be configured as the source database instance\. If your network configuration includes Secure Shell \(SSH\) port replication that converts the port number, specify the port number that is exposed by SSH\. - - *replication\_user\_name* -The ID of a user with `REPLICATION CLIENT` and `REPLICATION SLAVE` permissions on the MySQL instance running external to Amazon RDS\. We recommend that you provide an account that is used solely for replication with the external instance\. - - *replication\_user\_password* -The password of the user ID specified in `replication_user_name`\. - - *mysql\_binary\_log\_file\_name* -The name of the binary log on the source database instance that contains the replication information\. - - *mysql\_binary\_log\_file\_location* -The location in the `mysql_binary_log_file_name` binary log at which replication starts reading the replication information\. -You can determine the binlog file name and location by running `SHOW MASTER STATUS` on the source database instance\. - - *ssl\_encryption* -A value that specifies whether Secure Socket Layer \(SSL\) encryption is used on the replication connection\. 1 specifies to use SSL encryption, 0 specifies to not use encryption\. The default is 0\. -The `MASTER_SSL_VERIFY_SERVER_CERT` option isn't supported\. This option is set to 0, which means that the connection is encrypted, but the certificates aren't verified\. - -## Usage notes - - The master user must run the `mysql.rds_set_external_master` procedure\. This procedure must be run on the MySQL DB instance to be configured as the read replica of a MySQL instance running external to Amazon RDS\. - - Before you run `mysql.rds_set_external_master`, you must configure the instance of MySQL running external to Amazon RDS to be a source database instance\. To connect to the MySQL instance running external to Amazon RDS, you must specify `replication_user_name` and `replication_user_password` values that indicate a replication user that has `REPLICATION CLIENT` and `REPLICATION SLAVE` permissions on the external instance of MySQL\. - -**To configure an external instance of MySQL as a source database instance** - -1. Using the MySQL client of your choice, connect to the external instance of MySQL and create a user account to be used for replication\. The following is an example\. - - **MySQL 5\.7** - - ``` - CREATE USER 'repl_user'@'mydomain.com' IDENTIFIED BY 'password'; - ``` - - **MySQL 8\.0** - - ``` - CREATE USER 'repl_user'@'mydomain.com' IDENTIFIED WITH mysql_native_password BY 'password'; - ``` - -1. On the external instance of MySQL, grant `REPLICATION CLIENT` and `REPLICATION SLAVE` privileges to your replication user\. The following example grants `REPLICATION CLIENT` and `REPLICATION SLAVE` privileges on all databases for the 'repl\_user' user for your domain\. - - **MySQL 5\.7** - - ``` - GRANT REPLICATION CLIENT, REPLICATION SLAVE ON *.* TO 'repl_user'@'mydomain.com' IDENTIFIED BY 'password'; - ``` - - **MySQL 8\.0** - - ``` - GRANT REPLICATION CLIENT, REPLICATION SLAVE ON *.* TO 'repl_user'@'mydomain.com'; - ``` - -To use encrypted replication, configure source database instance to use SSL connections\. Also, import the certificate authority certificate, client certificate, and client key into the DB instance or DB cluster using the [mysql\.rds\_import\_binlog\_ssl\_material](mysql_rds_import_binlog_ssl_material.md) procedure\. - -**Note** -We recommend that you use read replicas to manage replication between two Amazon RDS DB instances when possible\. When you do so, we recommend that you use only this and other replication\-related stored procedures\. These practices enable more complex replication topologies between Amazon RDS DB instances\. We offer these stored procedures primarily to enable replication with MySQL instances running external to Amazon RDS\. For information about managing replication between Amazon RDS DB instances, see [Working with read replicas](USER_ReadRepl.md)\. - -After calling `mysql.rds_set_external_master` to configure an Amazon RDS DB instance as a read replica, you can call [mysql\.rds\_start\_replication](mysql_rds_start_replication.md) on the read replica to start the replication process\. You can call [mysql\.rds\_reset\_external\_master](mysql_rds_reset_external_master.md) to remove the read replica configuration\. - -When `mysql.rds_set_external_master` is called, Amazon RDS records the time, user, and an action of `set master` in the `mysql.rds_history` and `mysql.rds_replication_status` tables\. - -## Examples - -When run on a MySQL DB instance, the following example configures the DB instance to be a read replica of an instance of MySQL running external to Amazon RDS\. - -``` -call mysql.rds_set_external_master( - 'Externaldb.some.com', - 3306, - 'repl_user', - 'password', - 'mysql-bin-changelog.0777', - 120, - 0); -``` \ No newline at end of file diff --git a/doc_source/mysql_rds_set_external_master_gtid.md b/doc_source/mysql_rds_set_external_master_gtid.md deleted file mode 100644 index 55db549..0000000 --- a/doc_source/mysql_rds_set_external_master_gtid.md +++ /dev/null @@ -1,67 +0,0 @@ -# mysql\.rds\_set\_external\_master\_gtid - -Configures GTID\-based replication from a MariaDB instance running external to Amazon RDS to a MariaDB DB instance\. This stored procedure is supported only where the external MariaDB instance is version 10\.0\.24 or higher\. When setting up replication where one or both instances do not support MariaDB global transaction identifiers \(GTIDs\), use [mysql\.rds\_set\_external\_master](mysql-stored-proc-replicating.md#mysql_rds_set_external_master)\. - -Using GTIDs for replication provides crash\-safety features not offered by binary log replication, so we recommend it in cases where the replicating instances support it\. - -## Syntax - - - -``` -CALL mysql.rds_set_external_master_gtid( - host_name - , host_port - , replication_user_name - , replication_user_password - , gtid - , ssl_encryption -); -``` - -## Parameters - - *host\_name* -String\. The host name or IP address of the MariaDB instance running external to Amazon RDS that will become the source instance\. - - *host\_port* -Integer\. The port used by the MariaDB instance running external to Amazon RDS to be configured as the source instance\. If your network configuration includes SSH port replication that converts the port number, specify the port number that is exposed by SSH\. - - *replication\_user\_name* -String\. The ID of a user with `REPLICATION SLAVE` permissions in the MariaDB DB instance to be configured as the read replica\. - - *replication\_user\_password* -String\. The password of the user ID specified in `replication_user_name`\. - - *gtid* -String\. The global transaction ID on the source instance that replication should start from\. -You can use `@@gtid_current_pos` to get the current GTID if the source instance has been locked while you are configuring replication, so the binary log doesn't change between the points when you get the GTID and when replication starts\. -Otherwise, if you are using `mysqldump` version 10\.0\.13 or greater to populate the replica instance prior to starting replication, you can get the GTID position in the output by using the `--master-data` or `--dump-slave` options\. If you are not using `mysqldump` version 10\.0\.13 or greater, you can run the `SHOW MASTER STATUS` or use those same `mysqldump` options to get the binary log file name and position, then convert them to a GTID by running `BINLOG_GTID_POS` on the external MariaDB instance: - -``` -SELECT BINLOG_GTID_POS('', ); -``` -For more information about the MariaDB implementation of GTIDs, go to [Global transaction ID](http://mariadb.com/kb/en/mariadb/global-transaction-id/) in the MariaDB documentation\. - - *ssl\_encryption* -A value that specifies whether Secure Socket Layer \(SSL\) encryption is used on the replication connection\. 1 specifies to use SSL encryption, 0 specifies to not use encryption\. The default is 0\. -The `MASTER_SSL_VERIFY_SERVER_CERT` option isn't supported\. This option is set to 0, which means that the connection is encrypted, but the certificates aren't verified\. - -## Usage notes - -The `mysql.rds_set_external_master_gtid` procedure must be run by the master user\. It must be run on the MariaDB DB instance that you are configuring as the replica of a MariaDB instance running external to Amazon RDS\. Before running `mysql.rds_set_external_master_gtid`, you must have configured the instance of MariaDB running external to Amazon RDS as a source instance\. For more information, see [Importing data into a MariaDB DB instance](MariaDB.Procedural.Importing.md)\. - -**Warning** -Do not use `mysql.rds_set_external_master_gtid` to manage replication between two Amazon RDS DB instances\. Use it only when replicating with a MariaDB instance running external to RDS\. For information about managing replication between Amazon RDS DB instances, see [Working with DB instance read replicas](USER_ReadRepl.md)\. - -After calling `mysql.rds_set_external_master_gtid` to configure an Amazon RDS DB instance as a read replica, you can call [mysql\.rds\_start\_replication](mysql-stored-proc-replicating.md#mysql_rds_start_replication) on the replica to start the replication process\. You can call [mysql\.rds\_reset\_external\_master](mysql-stored-proc-replicating.md#mysql_rds_reset_external_master) to remove the read replica configuration\. - -When `mysql.rds_set_external_master_gtid` is called, Amazon RDS records the time, user, and an action of "set master" in the `mysql.rds_history` and `mysql.rds_replication_status` tables\. - -## Examples - -When run on a MariaDB DB instance, the following example configures it as the replica of an instance of MariaDB running external to Amazon RDS\. - -``` -call mysql.rds_set_external_master_gtid ('Sourcedb.some.com',3306,'ReplicationUser','SomePassW0rd','0-123-456',0); -``` \ No newline at end of file diff --git a/doc_source/mysql_rds_set_external_master_with_auto_position.md b/doc_source/mysql_rds_set_external_master_with_auto_position.md deleted file mode 100644 index d3c498f..0000000 --- a/doc_source/mysql_rds_set_external_master_with_auto_position.md +++ /dev/null @@ -1,93 +0,0 @@ -# mysql\.rds\_set\_external\_master\_with\_auto\_position - -Configures an RDS for MySQL DB instance to be a read replica of an instance of MySQL running external to Amazon RDS\. This procedure also configures delayed replication and replication based on global transaction identifiers \(GTIDs\)\. - -**Important** -To run this procedure, `autocommit` must be enabled\. To enable it, set the `autocommit` parameter to `1`\. For information about modifying parameters, see [Modifying parameters in a DB parameter group](USER_WorkingWithDBInstanceParamGroups.md#USER_WorkingWithParamGroups.Modifying)\. - -## Syntax - - - -``` -CALL mysql.rds_set_external_master_with_auto_position ( - host_name - , host_port - , replication_user_name - , replication_user_password - , ssl_encryption - , delay -); -``` - -## Parameters - - *host\_name* -The host name or IP address of the MySQL instance running external to Amazon RDS to become the source database instance\. - - *host\_port* -The port used by the MySQL instance running external to Amazon RDS to be configured as the source database instance\. If your network configuration includes Secure Shell \(SSH\) port replication that converts the port number, specify the port number that is exposed by SSH\. - - *replication\_user\_name* -The ID of a user with `REPLICATION CLIENT` and `REPLICATION SLAVE` permissions on the MySQL instance running external to Amazon RDS\. We recommend that you provide an account that is used solely for replication with the external instance\. - - *replication\_user\_password* -The password of the user ID specified in `replication_user_name`\. - - *ssl\_encryption* -A value that specifies whether Secure Socket Layer \(SSL\) encryption is used on the replication connection\. 1 specifies to use SSL encryption, 0 specifies to not use encryption\. The default is 0\. -The `MASTER_SSL_VERIFY_SERVER_CERT` option isn't supported\. This option is set to 0, which means that the connection is encrypted, but the certificates aren't verified\. - - *delay* -The minimum number of seconds to delay replication from source database instance\. -The limit for this parameter is one day \(86,400 seconds\)\. - -## Usage notes - -The master user must run the `mysql.rds_set_external_master_with_auto_position` procedure\. This procedure must be run on the MySQL DB instance to be configured as the read replica of a MySQL instance running external to Amazon RDS\. - -This procedure is supported for all RDS for MySQL 5\.7 versions, and RDS for MySQL 8\.0\.26 and higher 8\.0 versions\. - -Before you run `mysql.rds_set_external_master_with_auto_position`, you must configure the instance of MySQL running external to Amazon RDS to be a source database instance\. To connect to the MySQL instance running external to Amazon RDS, you must specify values for `replication_user_name` and `replication_user_password`\. These values must indicate a replication user that has `REPLICATION CLIENT` and `REPLICATION SLAVE` permissions on the external instance of MySQL\. - -**To configure an external instance of MySQL as a source database instance** - -1. Using the MySQL client of your choice, connect to the external instance of MySQL and create a user account to be used for replication\. The following is an example\. - - ``` - CREATE USER 'repl_user'@'mydomain.com' IDENTIFIED BY 'SomePassW0rd' - ``` - -1. On the external instance of MySQL, grant `REPLICATION CLIENT` and `REPLICATION SLAVE` privileges to your replication user\. The following example grants `REPLICATION CLIENT` and `REPLICATION SLAVE` privileges on all databases for the `'repl_user'` user for your domain\. - - ``` - GRANT REPLICATION CLIENT, REPLICATION SLAVE ON *.* TO 'repl_user'@'mydomain.com' - IDENTIFIED BY 'SomePassW0rd' - ``` - -For more information, see [Configuring binary log file position replication with an external source instance](MySQL.Procedural.Importing.External.Repl.md)\. - -**Note** -We recommend that you use read replicas to manage replication between two Amazon RDS DB instances when possible\. When you do so, we recommend that you use only this and other replication\-related stored procedures\. These practices enable more complex replication topologies between Amazon RDS DB instances\. We offer these stored procedures primarily to enable replication with MySQL instances running external to Amazon RDS\. For information about managing replication between Amazon RDS DB instances, see [Working with read replicas](USER_ReadRepl.md)\. - -After calling `mysql.rds_set_external_master_with_auto_position` to configure an Amazon RDS DB instance as a read replica, you can call [mysql\.rds\_start\_replication](mysql_rds_start_replication.md) on the read replica to start the replication process\. You can call [mysql\.rds\_reset\_external\_master](mysql_rds_reset_external_master.md) to remove the read replica configuration\. - -When you call `mysql.rds_set_external_master_with_auto_position`, Amazon RDS records the time, the user, and an action of `set master` in the `mysql.rds_history` and `mysql.rds_replication_status` tables\. - -For disaster recovery, you can use this procedure with the [mysql\.rds\_start\_replication\_until](mysql_rds_start_replication_until.md) or [mysql\.rds\_start\_replication\_until\_gtid](mysql_rds_start_replication_until_gtid.md) stored procedure\. To roll forward changes to a delayed read replica to the time just before a disaster, you can run the `mysql.rds_set_external_master_with_auto_position` procedure\. After the `mysql.rds_start_replication_until_gtid` procedure stops replication, you can promote the read replica to be the new primary DB instance by using the instructions in [Promoting a read replica to be a standalone DB instance](USER_ReadRepl.md#USER_ReadRepl.Promote)\. - -To use the `mysql.rds_rds_start_replication_until_gtid` procedure, GTID\-based replication must be enabled\. To skip a specific GTID\-based transaction that is known to cause disaster, you can use the [mysql\.rds\_skip\_transaction\_with\_gtid](mysql_rds_skip_transaction_with_gtid.md) stored procedure\. For more information about working with GTID\-based replication, see [Using GTID\-based replication for Amazon RDS for MySQL](mysql-replication-gtid.md)\. - -## Examples - -When run on a MySQL DB instance, the following example configures the DB instance to be a read replica of an instance of MySQL running external to Amazon RDS\. It sets the minimum replication delay to one hour \(3,600 seconds\) on the MySQL DB instance\. A change from the MySQL source database instance running external to Amazon RDS isn't applied on the MySQL DB instance read replica for at least one hour\. - -``` -call mysql.rds_set_external_master_with_auto_position( - 'Externaldb.some.com', - 3306, - 'repl_user', - 'SomePassW0rd', - 0, - 3600); -``` \ No newline at end of file diff --git a/doc_source/mysql_rds_set_external_master_with_delay.md b/doc_source/mysql_rds_set_external_master_with_delay.md deleted file mode 100644 index fbcf151..0000000 --- a/doc_source/mysql_rds_set_external_master_with_delay.md +++ /dev/null @@ -1,106 +0,0 @@ -# mysql\.rds\_set\_external\_master\_with\_delay - -Configures an RDS for MySQL DB instance to be a read replica of an instance of MySQL running external to Amazon RDS and configures delayed replication\. - -**Important** -To run this procedure, `autocommit` must be enabled\. To enable it, set the `autocommit` parameter to `1`\. For information about modifying parameters, see [Modifying parameters in a DB parameter group](USER_WorkingWithDBInstanceParamGroups.md#USER_WorkingWithParamGroups.Modifying)\. - -## Syntax - - - -``` -CALL mysql.rds_set_external_master_with_delay ( - host_name - , host_port - , replication_user_name - , replication_user_password - , mysql_binary_log_file_name - , mysql_binary_log_file_location - , ssl_encryption - , delay -); -``` - -## Parameters - - *host\_name* -The host name or IP address of the MySQL instance running external to Amazon RDS that will become the source database instance\. - - *host\_port* -The port used by the MySQL instance running external to Amazon RDS to be configured as the source database instance\. If your network configuration includes SSH port replication that converts the port number, specify the port number that is exposed by SSH\. - - *replication\_user\_name* -The ID of a user with `REPLICATION CLIENT` and `REPLICATION SLAVE` permissions on the MySQL instance running external to Amazon RDS\. We recommend that you provide an account that is used solely for replication with the external instance\. - - *replication\_user\_password* -The password of the user ID specified in `replication_user_name`\. - - *mysql\_binary\_log\_file\_name* -The name of the binary log on the source database instance contains the replication information\. - - *mysql\_binary\_log\_file\_location* -The location in the `mysql_binary_log_file_name` binary log at which replication will start reading the replication information\. -You can determine the binlog file name and location by running `SHOW MASTER STATUS` on the source database instance\. - - *ssl\_encryption* -A value that specifies whether Secure Socket Layer \(SSL\) encryption is used on the replication connection\. 1 specifies to use SSL encryption, 0 specifies to not use encryption\. The default is 0\. -The `MASTER_SSL_VERIFY_SERVER_CERT` option isn't supported\. This option is set to 0, which means that the connection is encrypted, but the certificates aren't verified\. - - *delay* -The minimum number of seconds to delay replication from source database instance\. -The limit for this parameter is one day \(86400 seconds\)\. - -## Usage notes - - The master user must run the `mysql.rds_set_external_master_with_delay` procedure\. This procedure must be run on the MySQL DB instance to be configured as the read replica of a MySQL instance running external to Amazon RDS\. - - Before you run `mysql.rds_set_external_master_with_delay`, you must configure the instance of MySQL running external to Amazon RDS to be a source database instance\. To connect to the MySQL instance running external to Amazon RDS, you must specify values for `replication_user_name` and `replication_user_password`\. These values must indicate a replication user that has `REPLICATION CLIENT` and `REPLICATION SLAVE` permissions on the external instance of MySQL\. - -**To configure an external instance of MySQL as a source database instance** - -1. Using the MySQL client of your choice, connect to the external instance of MySQL and create a user account to be used for replication\. The following is an example\. - - ``` - CREATE USER 'repl_user'@'mydomain.com' IDENTIFIED BY 'SomePassW0rd' - ``` - -1. On the external instance of MySQL, grant `REPLICATION CLIENT` and `REPLICATION SLAVE` privileges to your replication user\. The following example grants `REPLICATION CLIENT` and `REPLICATION SLAVE` privileges on all databases for the `'repl_user'` user for your domain\. - - ``` - GRANT REPLICATION CLIENT, REPLICATION SLAVE ON *.* TO 'repl_user'@'mydomain.com' - IDENTIFIED BY 'SomePassW0rd' - ``` - -For more information, see [Configuring binary log file position replication with an external source instance](MySQL.Procedural.Importing.External.Repl.md)\. - -**Note** -We recommend that you use read replicas to manage replication between two Amazon RDS DB instances when possible\. When you do so, we recommend that you use only this and other replication\-related stored procedures\. These practices enable more complex replication topologies between Amazon RDS DB instances\. We offer these stored procedures primarily to enable replication with MySQL instances running external to Amazon RDS\. For information about managing replication between Amazon RDS DB instances, see [Working with read replicas](USER_ReadRepl.md)\. - -After calling `mysql.rds_set_external_master_with_delay` to configure an Amazon RDS DB instance as a read replica, you can call [mysql\.rds\_start\_replication](mysql_rds_start_replication.md) on the read replica to start the replication process\. You can call [mysql\.rds\_reset\_external\_master](mysql_rds_reset_external_master.md) to remove the read replica configuration\. - -When you call `mysql.rds_set_external_master_with_delay`, Amazon RDS records the time, the user, and an action of `set master` in the `mysql.rds_history` and `mysql.rds_replication_status` tables\. - -For disaster recovery, you can use this procedure with the [mysql\.rds\_start\_replication\_until](mysql_rds_start_replication_until.md) or [mysql\.rds\_start\_replication\_until\_gtid](mysql_rds_start_replication_until_gtid.md) stored procedure\. To roll forward changes to a delayed read replica to the time just before a disaster, you can run the `mysql.rds_set_external_master_with_delay` procedure\. After the `mysql.rds_start_replication_until` procedure stops replication, you can promote the read replica to be the new primary DB instance by using the instructions in [Promoting a read replica to be a standalone DB instance](USER_ReadRepl.md#USER_ReadRepl.Promote)\. - -To use the `mysql.rds_rds_start_replication_until_gtid` procedure, GTID\-based replication must be enabled\. To skip a specific GTID\-based transaction that is known to cause disaster, you can use the [mysql\.rds\_skip\_transaction\_with\_gtid](mysql_rds_skip_transaction_with_gtid.md) stored procedure\. For more information about working with GTID\-based replication, see [Using GTID\-based replication for Amazon RDS for MySQL](mysql-replication-gtid.md)\. - -The `mysql.rds_set_external_master_with_delay` procedure is available in these versions of RDS for MySQL: -+ MySQL 8\.0\.26 and higher 8\.0 versions -+ All 5\.7 versions - -## Examples - -When run on a MySQL DB instance, the following example configures the DB instance to be a read replica of an instance of MySQL running external to Amazon RDS\. It sets the minimum replication delay to one hour \(3,600 seconds\) on the MySQL DB instance\. A change from the MySQL source database instance running external to Amazon RDS isn't applied on the MySQL DB instance read replica for at least one hour\. - -``` -call mysql.rds_set_external_master_with_delay( - 'Externaldb.some.com', - 3306, - 'repl_user', - 'SomePassW0rd', - 'mysql-bin-changelog.000777', - 120, - 0, - 3600); -``` \ No newline at end of file diff --git a/doc_source/mysql_rds_set_external_source.md b/doc_source/mysql_rds_set_external_source.md deleted file mode 100644 index b495a61..0000000 --- a/doc_source/mysql_rds_set_external_source.md +++ /dev/null @@ -1,110 +0,0 @@ -# mysql\.rds\_set\_external\_source - -Configures a MySQL DB instance to be a read replica of an instance of MySQL running external to Amazon RDS\. - -**Important** -To run this procedure, `autocommit` must be enabled\. To enable it, set the `autocommit` parameter to `1`\. For information about modifying parameters, see [Modifying parameters in a DB parameter group](USER_WorkingWithDBInstanceParamGroups.md#USER_WorkingWithParamGroups.Modifying)\. - -**Note** -You can use the [mysql\.rds\_set\_external\_master\_with\_delay](mysql_rds_set_external_master_with_delay.md) stored procedure to configure an external source database instance and delayed replication\. - -## Syntax - - - -``` -CALL mysql.rds_set_external_source ( - host_name - , host_port - , replication_user_name - , replication_user_password - , mysql_binary_log_file_name - , mysql_binary_log_file_location - , ssl_encryption -); -``` - -## Parameters - - *host\_name* -The host name or IP address of the MySQL instance running external to Amazon RDS to become the source database instance\. - - *host\_port* -The port used by the MySQL instance running external to Amazon RDS to be configured as the source database instance\. If your network configuration includes Secure Shell \(SSH\) port replication that converts the port number, specify the port number that is exposed by SSH\. - - *replication\_user\_name* -The ID of a user with `REPLICATION CLIENT` and `REPLICATION SLAVE` permissions on the MySQL instance running external to Amazon RDS\. We recommend that you provide an account that is used solely for replication with the external instance\. - - *replication\_user\_password* -The password of the user ID specified in `replication_user_name`\. - - *mysql\_binary\_log\_file\_name* -The name of the binary log on the source database instance that contains the replication information\. - - *mysql\_binary\_log\_file\_location* -The location in the `mysql_binary_log_file_name` binary log at which replication starts reading the replication information\. -You can determine the binlog file name and location by running `SHOW MASTER STATUS` on the source database instance\. - - *ssl\_encryption* -A value that specifies whether Secure Socket Layer \(SSL\) encryption is used on the replication connection\. 1 specifies to use SSL encryption, 0 specifies to not use encryption\. The default is 0\. -The `MASTER_SSL_VERIFY_SERVER_CERT` option isn't supported\. This option is set to 0, which means that the connection is encrypted, but the certificates aren't verified\. - -## Usage notes - - The master user must run the `mysql.rds_set_external_source` procedure\. This procedure must be run on the MySQL DB instance to be configured as the read replica of a MySQL instance running external to Amazon RDS\. - - Before you run `mysql.rds_set_external_source`, you must configure the instance of MySQL running external to Amazon RDS to be a source database instance\. To connect to the MySQL instance running external to Amazon RDS, you must specify `replication_user_name` and `replication_user_password` values that indicate a replication user that has `REPLICATION CLIENT` and `REPLICATION SLAVE` permissions on the external instance of MySQL\. - -**To configure an external instance of MySQL as a source database instance** - -1. Using the MySQL client of your choice, connect to the external instance of MySQL and create a user account to be used for replication\. The following is an example\. - - **MySQL 5\.7** - - ``` - CREATE USER 'repl_user'@'mydomain.com' IDENTIFIED BY 'password'; - ``` - - **MySQL 8\.0** - - ``` - CREATE USER 'repl_user'@'mydomain.com' IDENTIFIED WITH mysql_native_password BY 'password'; - ``` - -1. On the external instance of MySQL, grant `REPLICATION CLIENT` and `REPLICATION SLAVE` privileges to your replication user\. The following example grants `REPLICATION CLIENT` and `REPLICATION SLAVE` privileges on all databases for the 'repl\_user' user for your domain\. - - **MySQL 5\.7** - - ``` - GRANT REPLICATION CLIENT, REPLICATION SLAVE ON *.* TO 'repl_user'@'mydomain.com' IDENTIFIED BY 'password'; - ``` - - **MySQL 8\.0** - - ``` - GRANT REPLICATION CLIENT, REPLICATION SLAVE ON *.* TO 'repl_user'@'mydomain.com'; - ``` - -To use encrypted replication, configure source database instance to use SSL connections\. Also, import the certificate authority certificate, client certificate, and client key into the DB instance or DB cluster using the [mysql\.rds\_import\_binlog\_ssl\_material](mysql_rds_import_binlog_ssl_material.md) procedure\. - -**Note** -We recommend that you use read replicas to manage replication between two Amazon RDS DB instances when possible\. When you do so, we recommend that you use only this and other replication\-related stored procedures\. These practices enable more complex replication topologies between Amazon RDS DB instances\. We offer these stored procedures primarily to enable replication with MySQL instances running external to Amazon RDS\. For information about managing replication between Amazon RDS DB instances, see [Working with read replicas](USER_ReadRepl.md)\. - -After calling `mysql.rds_set_external_source` to configure an Amazon RDS DB instance as a read replica, you can call [mysql\.rds\_start\_replication](mysql_rds_start_replication.md) on the read replica to start the replication process\. You can call [mysql\.rds\_reset\_external\_master](mysql_rds_reset_external_master.md) to remove the read replica configuration\. - -When `mysql.rds_set_external_source` is called, Amazon RDS records the time, user, and an action of `set master` in the `mysql.rds_history` and `mysql.rds_replication_status` tables\. - -## Examples - -When run on a MySQL DB instance, the following example configures the DB instance to be a read replica of an instance of MySQL running external to Amazon RDS\. - -``` -call mysql.rds_set_external_source( - 'Externaldb.some.com', - 3306, - 'repl_user', - 'password', - 'mysql-bin-changelog.0777', - 120, - 0); -``` \ No newline at end of file diff --git a/doc_source/mysql_rds_set_external_source_with_auto_position.md b/doc_source/mysql_rds_set_external_source_with_auto_position.md deleted file mode 100644 index 4c3ada7..0000000 --- a/doc_source/mysql_rds_set_external_source_with_auto_position.md +++ /dev/null @@ -1,93 +0,0 @@ -# mysql\.rds\_set\_external\_source\_with\_auto\_position - -Configures an RDS for MySQL DB instance to be a read replica of an instance of MySQL running external to Amazon RDS\. This procedure also configures delayed replication and replication based on global transaction identifiers \(GTIDs\)\. - -**Important** -To run this procedure, `autocommit` must be enabled\. To enable it, set the `autocommit` parameter to `1`\. For information about modifying parameters, see [Modifying parameters in a DB parameter group](USER_WorkingWithDBInstanceParamGroups.md#USER_WorkingWithParamGroups.Modifying)\. - -## Syntax - - - -``` -CALL mysql.rds_set_external_source_with_auto_position ( - host_name - , host_port - , replication_user_name - , replication_user_password - , ssl_encryption - , delay -); -``` - -## Parameters - - *host\_name* -The host name or IP address of the MySQL instance running external to Amazon RDS to become the source database instance\. - - *host\_port* -The port used by the MySQL instance running external to Amazon RDS to be configured as the source database instance\. If your network configuration includes Secure Shell \(SSH\) port replication that converts the port number, specify the port number that is exposed by SSH\. - - *replication\_user\_name* -The ID of a user with `REPLICATION CLIENT` and `REPLICATION SLAVE` permissions on the MySQL instance running external to Amazon RDS\. We recommend that you provide an account that is used solely for replication with the external instance\. - - *replication\_user\_password* -The password of the user ID specified in `replication_user_name`\. - - *ssl\_encryption* -A value that specifies whether Secure Socket Layer \(SSL\) encryption is used on the replication connection\. 1 specifies to use SSL encryption, 0 specifies to not use encryption\. The default is 0\. -The `MASTER_SSL_VERIFY_SERVER_CERT` option isn't supported\. This option is set to 0, which means that the connection is encrypted, but the certificates aren't verified\. - - *delay* -The minimum number of seconds to delay replication from source database instance\. -The limit for this parameter is one day \(86,400 seconds\)\. - -## Usage notes - -The master user must run the `mysql.rds_set_external_source_with_auto_position` procedure\. This procedure must be run on the MySQL DB instance to be configured as the read replica of a MySQL instance running external to Amazon RDS\. - -This procedure is supported for all RDS for MySQL 5\.7 versions, and RDS for MySQL 8\.0\.26 and higher 8\.0 versions\. - -Before you run `mysql.rds_set_external_source_with_auto_position`, you must configure the instance of MySQL running external to Amazon RDS to be a source database instance\. To connect to the MySQL instance running external to Amazon RDS, you must specify values for `replication_user_name` and `replication_user_password`\. These values must indicate a replication user that has `REPLICATION CLIENT` and `REPLICATION SLAVE` permissions on the external instance of MySQL\. - -**To configure an external instance of MySQL as a source database instance** - -1. Using the MySQL client of your choice, connect to the external instance of MySQL and create a user account to be used for replication\. The following is an example\. - - ``` - CREATE USER 'repl_user'@'mydomain.com' IDENTIFIED BY 'SomePassW0rd' - ``` - -1. On the external instance of MySQL, grant `REPLICATION CLIENT` and `REPLICATION SLAVE` privileges to your replication user\. The following example grants `REPLICATION CLIENT` and `REPLICATION SLAVE` privileges on all databases for the `'repl_user'` user for your domain\. - - ``` - GRANT REPLICATION CLIENT, REPLICATION SLAVE ON *.* TO 'repl_user'@'mydomain.com' - IDENTIFIED BY 'SomePassW0rd' - ``` - -For more information, see [Configuring binary log file position replication with an external source instance](MySQL.Procedural.Importing.External.Repl.md)\. - -**Note** -We recommend that you use read replicas to manage replication between two Amazon RDS DB instances when possible\. When you do so, we recommend that you use only this and other replication\-related stored procedures\. These practices enable more complex replication topologies between Amazon RDS DB instances\. We offer these stored procedures primarily to enable replication with MySQL instances running external to Amazon RDS\. For information about managing replication between Amazon RDS DB instances, see [Working with read replicas](USER_ReadRepl.md)\. - -After calling `mysql.rds_set_external_source_with_auto_position` to configure an Amazon RDS DB instance as a read replica, you can call [mysql\.rds\_start\_replication](mysql_rds_start_replication.md) on the read replica to start the replication process\. You can call [mysql\.rds\_reset\_external\_master](mysql_rds_reset_external_master.md) to remove the read replica configuration\. - -When you call `mysql.rds_set_external_source_with_auto_position`, Amazon RDS records the time, the user, and an action of `set master` in the `mysql.rds_history` and `mysql.rds_replication_status` tables\. - -For disaster recovery, you can use this procedure with the [mysql\.rds\_start\_replication\_until](mysql_rds_start_replication_until.md) or [mysql\.rds\_start\_replication\_until\_gtid](mysql_rds_start_replication_until_gtid.md) stored procedure\. To roll forward changes to a delayed read replica to the time just before a disaster, you can run the `mysql.rds_set_external_source_with_auto_position` procedure\. After the `mysql.rds_start_replication_until_gtid` procedure stops replication, you can promote the read replica to be the new primary DB instance by using the instructions in [Promoting a read replica to be a standalone DB instance](USER_ReadRepl.md#USER_ReadRepl.Promote)\. - -To use the `mysql.rds_rds_start_replication_until_gtid` procedure, GTID\-based replication must be enabled\. To skip a specific GTID\-based transaction that is known to cause disaster, you can use the [mysql\.rds\_skip\_transaction\_with\_gtid](mysql_rds_skip_transaction_with_gtid.md) stored procedure\. For more information about working with GTID\-based replication, see [Using GTID\-based replication for Amazon RDS for MySQL](mysql-replication-gtid.md)\. - -## Examples - -When run on a MySQL DB instance, the following example configures the DB instance to be a read replica of an instance of MySQL running external to Amazon RDS\. It sets the minimum replication delay to one hour \(3,600 seconds\) on the MySQL DB instance\. A change from the MySQL source database instance running external to Amazon RDS isn't applied on the MySQL DB instance read replica for at least one hour\. - -``` -call mysql.rds_set_external_source_with_auto_position( - 'Externaldb.some.com', - 3306, - 'repl_user', - 'SomePassW0rd', - 0, - 3600); -``` \ No newline at end of file diff --git a/doc_source/mysql_rds_set_gsh_collector.md b/doc_source/mysql_rds_set_gsh_collector.md deleted file mode 100644 index a76a2b7..0000000 --- a/doc_source/mysql_rds_set_gsh_collector.md +++ /dev/null @@ -1,16 +0,0 @@ -# mysql\.rds\_set\_gsh\_collector - -Specifies the interval, in minutes, between snapshots taken by the Global Status History \(GoSH\)\. Default value is For more information, see [Managing the global status history](Appendix.MySQL.CommonDBATasks.md#Appendix.MySQL.CommonDBATasks.GoSH)\. - -## Syntax - - - -``` -CALL mysql.rds_set_gsh_collector(intervalPeriod); -``` - -## Parameters - - *intervalPeriod* -The interval, in minutes, between snapshots\. Default value is \ No newline at end of file diff --git a/doc_source/mysql_rds_set_gsh_rotation.md b/doc_source/mysql_rds_set_gsh_rotation.md deleted file mode 100644 index e57ab99..0000000 --- a/doc_source/mysql_rds_set_gsh_rotation.md +++ /dev/null @@ -1,16 +0,0 @@ -# mysql\.rds\_set\_gsh\_rotation - -Specifies the interval, in days, between rotations of the `mysql.global_status_history` table\. Default value is 7\. For more information, see [Managing the global status history](Appendix.MySQL.CommonDBATasks.md#Appendix.MySQL.CommonDBATasks.GoSH)\. - -## Syntax - - - -``` -CALL mysql.rds_set_gsh_rotation(intervalPeriod); -``` - -## Parameters - - *intervalPeriod* -The interval, in days, between table rotations\. Default value is 7\. \ No newline at end of file diff --git a/doc_source/mysql_rds_set_master_auto_position.md b/doc_source/mysql_rds_set_master_auto_position.md deleted file mode 100644 index 99cd7a2..0000000 --- a/doc_source/mysql_rds_set_master_auto_position.md +++ /dev/null @@ -1,26 +0,0 @@ -# mysql\.rds\_set\_master\_auto\_position - -Sets the replication mode to be based on either binary log file positions or on global transaction identifiers \(GTIDs\)\. - -## Syntax - - - -``` -CALL mysql.rds_set_master_auto_position ( -auto_position_mode -); -``` - -## Parameters - - *auto\_position\_mode* -A value that indicates whether to use log file position replication or GTID\-based replication: -+ `0` – Use the replication method based on binary log file position\. The default is `0`\. -+ `1` – Use the GTID\-based replication method\. - -## Usage notes - -The master user must run the `mysql.rds_set_master_auto_position` procedure\. - -This procedure is supported for all RDS for MySQL 5\.7 versions, and RDS for MySQL 8\.0\.26 and higher 8\.0 versions\. \ No newline at end of file diff --git a/doc_source/mysql_rds_set_source_delay.md b/doc_source/mysql_rds_set_source_delay.md deleted file mode 100644 index 0e812d7..0000000 --- a/doc_source/mysql_rds_set_source_delay.md +++ /dev/null @@ -1,37 +0,0 @@ -# mysql\.rds\_set\_source\_delay - -Sets the minimum number of seconds to delay replication from source database instance to the current read replica\. Use this procedure when you are connected to a read replica to delay replication from its source database instance\. - -## Syntax - -``` -CALL mysql.rds_set_source_delay( -delay -); -``` - -## Parameters - - *delay* -The minimum number of seconds to delay replication from the source database instance\. -The limit for this parameter is one day \(86400 seconds\)\. - -## Usage notes - -The master user must run the `mysql.rds_set_source_delay` procedure\. - -For disaster recovery, you can use this procedure with the [mysql\.rds\_start\_replication\_until](mysql_rds_start_replication_until.md) stored procedure or the [mysql\.rds\_start\_replication\_until\_gtid](mysql_rds_start_replication_until_gtid.md) stored procedure\. To roll forward changes to a delayed read replica to the time just before a disaster, you can run the `mysql.rds_set_source_delay` procedure\. After the `mysql.rds_start_replication_until` or `mysql.rds_start_replication_until_gtid` procedure stops replication, you can promote the read replica to be the new primary DB instance by using the instructions in [Promoting a read replica to be a standalone DB instance](USER_ReadRepl.md#USER_ReadRepl.Promote)\. - -To use the `mysql.rds_rds_start_replication_until_gtid` procedure, GTID\-based replication must be enabled\. To skip a specific GTID\-based transaction that is known to cause disaster, you can use the [mysql\.rds\_skip\_transaction\_with\_gtid](mysql_rds_skip_transaction_with_gtid.md) stored procedure\. For more information on GTID\-based replication, see [Using GTID\-based replication for Amazon RDS for MySQL](mysql-replication-gtid.md)\. - -The `mysql.rds_set_source_delay` procedure is available in these versions of RDS for MySQL: -+ MySQL 8\.0\.26 and higher 8\.0 versions -+ All 5\.7 versions - -## Examples - -To delay replication from source database instance to the current read replica for at least one hour \(3,600 seconds\), you can call `mysql.rds_set_source_delay` with the following parameter: - -``` -CALL mysql.rds_set_source_delay(3600); -``` \ No newline at end of file diff --git a/doc_source/mysql_rds_show_configuration.md b/doc_source/mysql_rds_show_configuration.md deleted file mode 100644 index 5a7b1bc..0000000 --- a/doc_source/mysql_rds_show_configuration.md +++ /dev/null @@ -1,25 +0,0 @@ -# mysql\.rds\_show\_configuration - -The number of hours that binary logs are retained\. - -## Syntax - - - -``` -CALL mysql.rds_show_configuration; -``` - -## Usage notes - -To verify the number of hours that Amazon RDS retains binary logs, use the `mysql.rds_show_configuration` stored procedure\. - -## Examples - -The following example displays the retention period: - -``` -call mysql.rds_show_configuration; - name value description - binlog retention hours 24 binlog retention hours specifies the duration in hours before binary logs are automatically deleted. -``` \ No newline at end of file diff --git a/doc_source/mysql_rds_skip_repl_error.md b/doc_source/mysql_rds_skip_repl_error.md deleted file mode 100644 index 79a865f..0000000 --- a/doc_source/mysql_rds_skip_repl_error.md +++ /dev/null @@ -1,40 +0,0 @@ -# mysql\.rds\_skip\_repl\_error - -Skips and deletes a replication error on a MySQL DB read replica\. - -## Syntax - - - -``` -CALL mysql.rds_skip_repl_error; -``` - -## Usage notes - -The master user must run the `mysql.rds_skip_repl_error` procedure on a read replica\. For more information about this procedure, see [Calling the mysql\.rds\_skip\_repl\_error procedure](Appendix.MySQL.CommonDBATasks.md#Appendix.MySQL.CommonDBATasks.SkipError.procedure)\. - -To determine if there are errors, run the MySQL `SHOW REPLICA STATUS\G` command\. If a replication error isn't critical, you can run `mysql.rds_skip_repl_error` to skip the error\. If there are multiple errors, `mysql.rds_skip_repl_error` deletes the first error, then warns that others are present\. You can then use `SHOW REPLICA STATUS\G` to determine the correct course of action for the next error\. For information about the values returned, see [the MySQL documentation](https://dev.mysql.com/doc/refman/8.0/en/show-replica-status.html)\. - -**Note** -Previous versions of MySQL used `SHOW SLAVE STATUS` instead of `SHOW REPLICA STATUS`\. If you are using a MySQL version before 8\.0\.23, then use `SHOW SLAVE STATUS`\. - -For more information about addressing replication errors with Amazon RDS, see [Troubleshooting a MySQL read replica problem](USER_MySQL.Replication.ReadReplicas.md#USER_ReadRepl.Troubleshooting)\. - -### Replication stopped error - -When you call the `mysql.rds_skip_repl_error` procedure, you might receive an error message stating that the replica is down or disabled\. - -This error message appears if you run the procedure on the primary instance instead of the read replica\. You must run this procedure on the read replica for the procedure to work\. - -This error message might also appear if you run the procedure on the read replica, but replication can't be restarted successfully\. - -If you need to skip a large number of errors, the replication lag can increase beyond the default retention period for binary log \(binlog\) files\. In this case, you might encounter a fatal error due to binlog files being purged before they have been replayed on the read replica\. This purge causes replication to stop, and you can no longer call the `mysql.rds_skip_repl_error` command to skip replication errors\. - -You can mitigate this issue by increasing the number of hours that binlog files are retained on your source database instance\. After you have increased the binlog retention time, you can restart replication and call the `mysql.rds_skip_repl_error` command as needed\. - -To set the binlog retention time, use the [mysql\.rds\_set\_configuration](mysql_rds_set_configuration.md) procedure and specify a configuration parameter of `'binlog retention hours'` along with the number of hours to retain binlog files on the DB cluster\. The following example sets the retention period for binlog files to 48 hours\. - -``` -CALL mysql.rds_set_configuration('binlog retention hours', 48); -``` \ No newline at end of file diff --git a/doc_source/mysql_rds_skip_transaction_with_gtid.md b/doc_source/mysql_rds_skip_transaction_with_gtid.md deleted file mode 100644 index af2ac0b..0000000 --- a/doc_source/mysql_rds_skip_transaction_with_gtid.md +++ /dev/null @@ -1,34 +0,0 @@ -# mysql\.rds\_skip\_transaction\_with\_gtid - -Skips replication of a transaction with the specified global transaction identifier \(GTID\) on a MySQL DB instance\. - -You can use this procedure for disaster recovery when a specific GTID transaction is known to cause a problem\. Use this stored procedure to skip the problematic transaction\. Examples of problematic transactions include transactions that disable replication, delete important data, or cause the DB instance to become unavailable\. - -## Syntax - - - -``` -CALL mysql.rds_skip_transaction_with_gtid ( -gtid_to_skip -); -``` - -## Parameters - - *gtid\_to\_skip* -The GTID of the replication transaction to skip\. - -## Usage notes - -The master user must run the `mysql.rds_skip_transaction_with_gtid` procedure\. - -This procedure is supported for all RDS for MySQL 5\.7 versions, and RDS for MySQL 8\.0\.26 and higher 8\.0 versions\. - -## Examples - -The following example skips replication of the transaction with the GTID `3E11FA47-71CA-11E1-9E33-C80AA9429562:23`\. - -``` -call mysql.rds_skip_transaction_with_gtid('3E11FA47-71CA-11E1-9E33-C80AA9429562:23'); -``` \ No newline at end of file diff --git a/doc_source/mysql_rds_start_replication.md b/doc_source/mysql_rds_start_replication.md deleted file mode 100644 index 4f5c952..0000000 --- a/doc_source/mysql_rds_start_replication.md +++ /dev/null @@ -1,24 +0,0 @@ -# mysql\.rds\_start\_replication - -Initiates replication from a MySQL DB instance\. - -**Note** -You can use the [mysql\.rds\_start\_replication\_until](mysql_rds_start_replication_until.md) or [mysql\.rds\_start\_replication\_until\_gtid](mysql_rds_start_replication_until_gtid.md) stored procedure to initiate replication from an RDS for MySQL DB instance and stop replication at the specified binary log file location\. - -## Syntax - - - -``` -CALL mysql.rds_start_replication; -``` - -## Usage notes - -The master user must run the `mysql.rds_start_replication` procedure\. - -If you are configuring replication to import data from an instance of MySQL running external to Amazon RDS, you call `mysql.rds_start_replication` on the read replica to start the replication process after you have called [mysql\.rds\_set\_external\_master](mysql_rds_set_external_master.md) to build the replication configuration\. For more information, see [Restoring a backup into a MySQL DB instance](MySQL.Procedural.Importing.md)\. - -If you are configuring replication to export data to an instance of MySQL external to Amazon RDS, you call `mysql.rds_start_replication` and `mysql.rds_stop_replication` on the read replica to control some replication actions, such as purging binary logs\. For more information, see [Exporting data from a MySQL DB instance by using replication](MySQL.Procedural.Exporting.NonRDSRepl.md)\. - -You can also call `mysql.rds_start_replication` on the read replica to restart any replication process that you previously stopped by calling [mysql\.rds\_stop\_replication](mysql_rds_stop_replication.md)\. For more information, see [Working with read replicas](USER_ReadRepl.md)\. \ No newline at end of file diff --git a/doc_source/mysql_rds_start_replication_until.md b/doc_source/mysql_rds_start_replication_until.md deleted file mode 100644 index f3d3aad..0000000 --- a/doc_source/mysql_rds_start_replication_until.md +++ /dev/null @@ -1,51 +0,0 @@ -# mysql\.rds\_start\_replication\_until - -Initiates replication from an RDS for MySQL DB instance and stops replication at the specified binary log file location\. - -## Syntax - - - -``` -CALL mysql.rds_start_replication_until ( -replication_log_file - , replication_stop_point -); -``` - -## Parameters - - *replication\_log\_file* -The name of the binary log on the source database instance contains the replication information\. - - *replication\_stop\_point * -The location in the `replication_log_file` binary log at which replication will stop\. - -## Usage notes - -The master user must run the `mysql.rds_start_replication_until` procedure\. - -You can use this procedure with delayed replication for disaster recovery\. If you have delayed replication configured, you can use this procedure to roll forward changes to a delayed read replica to the time just before a disaster\. After this procedure stops replication, you can promote the read replica to be the new primary DB instance by using the instructions in [Promoting a read replica to be a standalone DB instance](USER_ReadRepl.md#USER_ReadRepl.Promote)\. - -You can configure delayed replication using the following stored procedures: -+ [mysql\.rds\_set\_configuration](mysql_rds_set_configuration.md) -+ [mysql\.rds\_set\_external\_master\_with\_delay](mysql_rds_set_external_master_with_delay.md) -+ [mysql\.rds\_set\_source\_delay](mysql_rds_set_source_delay.md) - -The file name specified for the `replication_log_file` parameter must match the source database instance binlog file name\. - -When the `replication_stop_point ` parameter specifies a stop location that is in the past, replication is stopped immediately\. - -The `mysql.rds_start_replication_until` procedure is available in these versions of RDS for MySQL: -+ MySQL 8\.0\.26 and higher 8\.0 versions -+ All 5\.7 versions - -## Examples - -The following example initiates replication and replicates changes until it reaches location `120` in the `mysql-bin-changelog.000777` binary log file\. - -``` -call mysql.rds_start_replication_until( - 'mysql-bin-changelog.000777', - 120); -``` \ No newline at end of file diff --git a/doc_source/mysql_rds_start_replication_until_gtid.md b/doc_source/mysql_rds_start_replication_until_gtid.md deleted file mode 100644 index 9cfe28e..0000000 --- a/doc_source/mysql_rds_start_replication_until_gtid.md +++ /dev/null @@ -1,41 +0,0 @@ -# mysql\.rds\_start\_replication\_until\_gtid - -Initiates replication from an RDS for MySQL DB instance and stops replication immediately after the specified global transaction identifier \(GTID\)\. - -## Syntax - - - -``` -CALL mysql.rds_start_replication_until_gtid ( -gtid -); -``` - -## Parameters - - *gtid* -The GTID after which replication is to stop\. - -## Usage notes - -The master user must run the `mysql.rds_start_replication_until_gtid` procedure\. - -This procedure is supported for all RDS for MySQL 5\.7 versions, and RDS for MySQL 8\.0\.26 and higher 8\.0 versions\. - -You can use this procedure with delayed replication for disaster recovery\. If you have delayed replication configured, you can use this procedure to roll forward changes to a delayed read replica to the time just before a disaster\. After this procedure stops replication, you can promote the read replica to be the new primary DB instance by using the instructions in [Promoting a read replica to be a standalone DB instance](USER_ReadRepl.md#USER_ReadRepl.Promote)\. - -You can configure delayed replication using the following stored procedures: -+ [mysql\.rds\_set\_configuration](mysql_rds_set_configuration.md) -+ [mysql\.rds\_set\_external\_master\_with\_auto\_position](mysql_rds_set_external_master_with_auto_position.md) -+ [mysql\.rds\_set\_source\_delay](mysql_rds_set_source_delay.md) - -When the `gtid` parameter specifies a transaction that has already been run by the replica, replication is stopped immediately\. - -## Examples - -The following example initiates replication and replicates changes until it reaches GTID `3E11FA47-71CA-11E1-9E33-C80AA9429562:23`\. - -``` -call mysql.rds_start_replication_until_gtid('3E11FA47-71CA-11E1-9E33-C80AA9429562:23'); -``` \ No newline at end of file diff --git a/doc_source/mysql_rds_stop_replication.md b/doc_source/mysql_rds_stop_replication.md deleted file mode 100644 index 3a2ed6f..0000000 --- a/doc_source/mysql_rds_stop_replication.md +++ /dev/null @@ -1,21 +0,0 @@ -# mysql\.rds\_stop\_replication - -Stops replication from a MySQL DB instance\. - -## Syntax - - - -``` -CALL mysql.rds_stop_replication; -``` - -## Usage notes - -The master user must run the `mysql.rds_stop_replication` procedure\. - -If you are configuring replication to import data from an instance of MySQL running external to Amazon RDS, you call `mysql.rds_stop_replication` on the read replica to stop the replication process after the import has completed\. For more information, see [Restoring a backup into a MySQL DB instance](MySQL.Procedural.Importing.md)\. - -If you are configuring replication to export data to an instance of MySQL external to Amazon RDS, you call `mysql.rds_start_replication` and `mysql.rds_stop_replication` on the read replica to control some replication actions, such as purging binary logs\. For more information, see [Exporting data from a MySQL DB instance by using replication](MySQL.Procedural.Exporting.NonRDSRepl.md)\. - -You can also use `mysql.rds_stop_replication` to stop replication between two Amazon RDS DB instances\. You typically stop replication to perform a long running operation on the read replica, such as creating a large index on the read replica\. You can restart any replication process that you stopped by calling [mysql\.rds\_start\_replication](mysql_rds_start_replication.md) on the read replica\. For more information, see [Working with read replicas](USER_ReadRepl.md)\. \ No newline at end of file diff --git a/doc_source/oracle-cman.md b/doc_source/oracle-cman.md deleted file mode 100644 index cfa2181..0000000 --- a/doc_source/oracle-cman.md +++ /dev/null @@ -1,58 +0,0 @@ -# Configuring Oracle Connection Manager on an Amazon EC2 instance - -Oracle Connection Manager \(CMAN\) is a proxy server that forwards connection requests to database servers or other proxy servers\. You can use CMAN to configure the following: - -Access control -You can create rules that filter out user\-specified client requests and accept others\. - -Session multiplexing -You can funnel multiple client sessions through a network connection to a shared server destination\. - -Typically, CMAN resides on a host separate from the database server and client hosts\. For more information, see [Configuring Oracle Connection Manager](https://docs.oracle.com/en/database/oracle/oracle-database/19/netag/configuring-oracle-connection-manager.html#GUID-AF8A511E-9AE6-4F4D-8E58-F28BC53F64E4) in the Oracle Database documentation\. - -**Topics** -+ [Supported versions and licensing options for CMAN](#oracle-cman.Versions) -+ [Requirements and limitations for CMAN](#oracle-cman.requirements) -+ [Configuring CMAN](#oracle-cman.configuring-cman) - -## Supported versions and licensing options for CMAN - -CMAN supports the Enterprise Edition of all versions of Oracle Database that Amazon RDS supports\. For more information, see [RDS for Oracle releases](Oracle.Concepts.database-versions.md)\. - -You can install Oracle Connection Manager on a separate host from the host where Oracle Database is installed\. You don't need a separate license for the host that runs CMAN\. - -## Requirements and limitations for CMAN - -To provide a fully managed experience, Amazon RDS restricts access to the operating system\. You can't modify database parameters that require operating system access\. Thus, Amazon RDS doesn't support features of CMAN that require you to log in to the operating system\. - -## Configuring CMAN - -When you configure CMAN, you perform most of the work outside of your RDS for Oracle database\. - -**Topics** -+ [Step 1: Configure CMAN on an Amazon EC2 instance in the same VPC as the RDS for Oracle instance](#oracle-cman.configuring-cman.vpc) -+ [Step 2: Configure database parameters for CMAN](#oracle-cman.configuring-cman.parameters) -+ [Step 3: Associate your DB instance with the parameter group](#oracle-cman.configuring-cman.parameter-group) - -### Step 1: Configure CMAN on an Amazon EC2 instance in the same VPC as the RDS for Oracle instance - -To learn how to set up CMAN, follow the detailed instructions in the blog post [Configuring and using Oracle Connection Manager on Amazon EC2 for Amazon RDS for Oracle](http://aws.amazon.com/blogs/database/configuring-and-using-oracle-connection-manager-on-amazon-ec2-for-amazon-rds-for-oracle/)\. - -### Step 2: Configure database parameters for CMAN - -For CMAN features such as Traffic Director Mode and session multiplexing, set `REMOTE_LISTENER` parameter to the address of CMAN instance in a DB parameter group\. Consider the following scenario: -+ The CMAN instance resides on a host with IP address `10.0.159.100` and uses port `1521`\. -+ The databases `orcla`, `orclb`, and `orclc` reside on separate RDS for Oracle DB instances\. - -The following table shows how to set the `REMOTE_LISTENER` value\. The `LOCAL_LISTENER` value is set automatically by Amazon RDS\. - - -| DB instance name | DB instance IP | Local listener value \(set automatically\) | Remote listener value \(set by user\) | -| --- | --- | --- | --- | -| orcla | 10\.0\.159\.200 | 
( address=
  (protocol=tcp)
  (host=10.0.159.200)
  (port=1521)
)
| 10\.0\.159\.100:1521 | -| orclb | 10\.0\.159\.300 | 
( address=
  (protocol=tcp)
  (host=10.0.159.300)
  (port=1521)
)
| 10\.0\.159\.100:1521 | -| orclc | 10\.0\.159\.400 | 
( address=
  (protocol=tcp)
  (host=10.0.159.400)
  (port=1521)
)
| 10\.0\.159\.100:1521 | - -### Step 3: Associate your DB instance with the parameter group - -Create or modify your DB instance to use the parameter group that you configured in [Step 2: Configure database parameters for CMAN](#oracle-cman.configuring-cman.parameters)\. For more information, see [Associating a DB parameter group with a DB instance](USER_WorkingWithDBInstanceParamGroups.md#USER_WorkingWithParamGroups.Associating)\. \ No newline at end of file diff --git a/doc_source/oracle-efs-integration.md b/doc_source/oracle-efs-integration.md deleted file mode 100644 index ed33020..0000000 --- a/doc_source/oracle-efs-integration.md +++ /dev/null @@ -1,408 +0,0 @@ -# Amazon EFS integration - -You can transfer files between your RDS for Oracle DB instance and an Amazon EFS file system\. You can use Amazon EFS integration with Oracle Database features such as Oracle Data Pump\. For example, you can import Data Pump files from Amazon EFS to your RDS for Oracle DB instance\. You don’t need to copy these files locally because Data Pump imports directly from the EFS file system\. For more information, see [Importing data into Oracle on Amazon RDS](Oracle.Procedural.Importing.md)\. - -Note the following requirements and restrictions: -+ Amazon EFS integration is supported only for Oracle Database 19c \- July 2022 Patch Set Update \(PSU\) 19\.0\.0\.0\.ru\-2022\-07\.rur\-2022\-07\.r1 or later\. -+ Your DB instance and your EFS file system must be in the same AWS Region and the same VPC\. -+ Your VPC must have the `enableDnsSupport` attribute enabled\. For more information, see [DNS attributes in your VPC](https://docs.aws.amazon.com/vpc/latest/userguide/vpc-dns.html#vpc-dns-support) in the *Amazon Virtual Private Cloud User Guide*\. -+ Your EFS file system must use the Standard or Standard\-IA storage class\. -+ RDS for Oracle doesn't support automated backups or manual DB snapshots of an EFS file system\. Instead, you must use AWS Backup or other solutions to back up your EFS file system\. For more information, see [Backing up your Amazon EFS file systems](https://docs.aws.amazon.com/efs/latest/ug/efs-backup-solutions.html)\. - -**Topics** -+ [Configuring network permissions for RDS for Oracle integration with Amazon EFS](#oracle-efs-integration.network) -+ [Configuring IAM permissions for RDS for Oracle integration with Amazon EFS](#oracle-efs-integration.iam) -+ [Adding the EFS\_INTEGRATION option](#oracle-efs-integration.adding) -+ [Configuring Amazon EFS file system permissions](#oracle-efs-integration.file-system) -+ [Transferring files between RDS for Oracle and an Amazon EFS file system](#oracle-efs-integration.transferring) -+ [Removing the EFS\_INTEGRATION option](#oracle-efs-integration.removing) -+ [Troubleshooting Amazon EFS integration](#oracle-efs-integration.troubleshooting) - -## Configuring network permissions for RDS for Oracle integration with Amazon EFS - -For RDS for Oracle to integrate with Amazon EFS, make sure that your DB instance has network access to an EFS file system\. For more information, see [Controlling network access to Amazon EFS file systems for NFS clients](https://docs.aws.amazon.com/efs/latest/ug/NFS-access-control-efs.html) in the *Amazon Elastic File System User Guide*\. - -**Topics** -+ [Controlling network access with security groups](#oracle-efs-integration.network.inst-access) -+ [Controlling network access with file system policies](#oracle-efs-integration.network.file-system-policy) - -### Controlling network access with security groups - -You can control your DB instance access to EFS file systems using network layer security mechanisms such as VPC security groups\. To allow access to an EFS file system for your DB instance, make sure that your EFS file system meets the following requirements: -+ An EFS mount target exists in every Availability Zone used by an RDS for Oracle DB instance\. - - You can configure DB instances in different AZs to use the same EFS file system\. For Multi\-AZ, you need a mount point for each AZ in your deployment\. You might need to move a DB instance to a different AZ\. For these reasons, we recommend that you create an EFS mount point in each AZ in your VPC\. By default, when you create a new EFS file system using the console, RDS creates mount targets for all AZs\. -+ A security group is attached to the mount target\. -+ The security group has an inbound rule to allow the network subnet or security group of the RDS for Oracle DB instance on TCP/2049 \(Type NFS\)\. - -For more information, see [Creating Amazon EFS file systems](https://docs.aws.amazon.com/efs/latest/ug/creating-using-create-fs.html#configure-efs-network-access) and [Creating and managing EFS mount targets and security groups](https://docs.aws.amazon.com/efs/latest/ug/accessing-fs.html) in the *Amazon Elastic File System User Guide*\. - -### Controlling network access with file system policies - -Amazon EFS integration with RDS for Oracle works with the default \(empty\) EFS file system policy\. The default policy doesn't use IAM to authenticate\. Instead, it grants full access to any anonymous client that can connect to the file system using a mount target\. The default policy is in effect whenever a user\-configured file system policy isn't in effect, including at file system creation\. For more information, see [Default EFS file system policy](https://docs.aws.amazon.com/efs/latest/ug/iam-access-control-nfs-efs.html#default-filesystempolicy) in the *Amazon Elastic File System User Guide*\. - -To strengthen access to your EFS file system for all clients, including RDS for Oracle, you can configure IAM permissions\. In this approach, you create a file system policy\. For more information, see [Creating file system policies](https://docs.aws.amazon.com/efs/latest/ug/create-file-system-policy.html) in the *Amazon Elastic File System User Guide*\. - -## Configuring IAM permissions for RDS for Oracle integration with Amazon EFS - -For RDS for Oracle to integrate with Amazon EFS, your DB instance must have IAM permissions to access to an Amazon EFS file system\. - -### Step 1: Create an IAM role for your DB instance and attach your policy - -In this step, you create a role for your RDS for Oracle DB instance to allow Amazon RDS to access your EFS file system\. - -#### Console - -**To create an IAM role to allow Amazon RDS access to an EFS file system** - -1. Open the [IAM Management Console](https://console.aws.amazon.com/iam/home?#home)\. - -1. In the navigation pane, choose **Roles**\. - -1. Choose **Create role**\. - -1. For **AWS service**, choose **RDS**\. - -1. For **Select your use case**, choose **RDS – Add Role to Database**\. - -1. Choose **Next**\. - -1. Don't add any permissions policies\. Choose **Next**\. - -1. Set **Role name** to a name for your IAM role, for example `rds-efs-integration-role`\. You can also add an optional **Description** value\. - -1. Choose **Create role**\. - -#### AWS CLI - -To limit the service's permissions to a specific resource, we recommend using the [https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies_condition-keys.html#condition-keys-sourcearn](https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies_condition-keys.html#condition-keys-sourcearn) and [https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies_condition-keys.html#condition-keys-sourceaccount](https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies_condition-keys.html#condition-keys-sourceaccount) global condition context keys in resource\-based trust relationships\. This is the most effective way to protect against the [confused deputy problem](https://docs.aws.amazon.com/IAM/latest/UserGuide/confused-deputy.html)\. - -You might use both global condition context keys and have the `aws:SourceArn` value contain the account ID\. In this case, the `aws:SourceAccount` value and the account in the `aws:SourceArn` value must use the same account ID when used in the same statement\. -+ Use `aws:SourceArn` if you want cross\-service access for a single resource\. -+ Use `aws:SourceAccount` if you want to allow any resource in that account to be associated with the cross\-service use\. - -In the trust relationship, make sure to use the `aws:SourceArn` global condition context key with the full Amazon Resource Name \(ARN\) of the resources accessing the role\. - -The following AWS CLI command creates the role named `rds-efs-integration-role` for this purpose\. - -**Example** -For Linux, macOS, or Unix: - -``` -aws iam create-role \ - --role-name rds-efs-integration-role \ - --assume-role-policy-document '{ - "Version": "2012-10-17", - "Statement": [ - { - "Effect": "Allow", - "Principal": { - "Service": "rds.amazonaws.com" - }, - "Action": "sts:AssumeRole", - "Condition": { - "StringEquals": { - "aws:SourceAccount": my_account_ID, - "aws:SourceArn": "arn:aws:rds:Region:my_account_ID:db:dbname" - } - } - } - ] - }' -``` -For Windows: - -``` -aws iam create-role ^ - --role-name rds-efs-integration-role ^ - --assume-role-policy-document '{ - "Version": "2012-10-17", - "Statement": [ - { - "Effect": "Allow", - "Principal": { - "Service": "rds.amazonaws.com" - }, - "Action": "sts:AssumeRole", - "Condition": { - "StringEquals": { - "aws:SourceAccount": my_account_ID, - "aws:SourceArn": "arn:aws:rds:Region:my_account_ID:db:dbname" - } - } - } - ] - }' -``` - -For more information, see [Creating a role to delegate permissions to an IAM user](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_create_for-user.html) in the *IAM User Guide*\. - -### Step 2: Create a file system policy for your Amazon EFS file system - -In this step, you create a file system policy for your EFS file system\. - -**To create or edit an EFS file system policy** - -1. Open the [EFS Management Console](https://console.aws.amazon.com/efs/home?#home)\. - -1. Choose **File Systems**\. - -1. On the **File systems** page, choose the file system that you want to edit or create a file system policy for\. The details page for that file system is displayed\. - -1. Choose the **File system policy** tab\. - - If the policy is empty, then the default EFS file system policy is in use\. For more information, see [Default EFS file system policy](https://docs.aws.amazon.com/efs/latest/ug/iam-access-control-nfs-efs.html#default-filesystempolicy ) in the *Amazon Elastic File System User Guide*\. - -1. Choose **Edit**\. The **File system policy** page appears\. - -1. In **Policy editor**, enter a policy such as the following, and then choose **Save**\. - - ``` - { - "Version": "2012-10-17", - "Id": "ExamplePolicy01", - "Statement": [ - { - "Sid": "ExampleStatement01", - "Effect": "Allow", - "Principal": { - "AWS": "arn:aws:iam::123456789012:role/rds-efs-integration-role" - }, - "Action": [ - "elasticfilesystem:ClientMount", - "elasticfilesystem:ClientWrite", - "elasticfilesystem:ClientRootAccess" - ], - "Resource": "arn:aws:elasticfilesystem:us-east-1:123456789012:file-system/fs-1234567890abcdef0" - } - ] - } - ``` - -### Step 3: Associate your IAM role with your RDS for Oracle DB instance - -In this step, you associate your IAM role with your DB instance\. Be aware of the following requirements: -+ You must have access to an IAM role with the required Amazon EFS permissions policy attached to it\. -+ You can associate only one IAM role with your RDS for Oracle DB instance at a time\. -+ The status of your instance must be **Available**\. - -For more information, see [Identity and access management for Amazon EFS](https://docs.aws.amazon.com/efs/latest/ug/auth-and-access-control.html) in the *Amazon Elastic File System User Guide*\. - -#### Console - -**To associate your IAM role with your RDS for Oracle DB instance** - -1. Sign in to the AWS Management Console and open the Amazon RDS console at [https://console\.aws\.amazon\.com/rds/](https://console.aws.amazon.com/rds/)\. - -1. Choose **Databases**\. - -1. If your database instance is unavailable, choose **Actions** and then **Start**\. When the instance status shows **Started**, go to the next step\. - -1. Choose the Oracle DB instance name to display its details\. - -1. On the **Connectivity & security** tab, scroll down to the **Manage IAM roles** section at the bottom of the page\. - -1. Choose the role to add in the **Add IAM roles to this instance** section\. - -1. For **Feature**, choose **EFS\_INTEGRATION**\. - -1. Choose **Add role**\. - -#### AWS CLI - -The following AWS CLI command adds the role to an Oracle DB instance named `mydbinstance`\. - -**Example** -For Linux, macOS, or Unix: - -``` -aws rds add-role-to-db-instance \ - --db-instance-identifier mydbinstance \ - --feature-name EFS_INTEGRATION \ - --role-arn your-role-arn -``` -For Windows: - -``` -aws rds add-role-to-db-instance ^ - --db-instance-identifier mydbinstance ^ - --feature-name EFS_INTEGRATION ^ - --role-arn your-role-arn -``` - -Replace `your-role-arn` with the role ARN that you noted in a previous step\. `EFS_INTEGRATION` must be specified for the `--feature-name` option\. - -## Adding the EFS\_INTEGRATION option - -To integrate Amazon RDS for Oracle with Amazon EFS, your DB instance must be associated with an option group that includes the `EFS_INTEGRATION` option\. - -Multiple Oracle DB instances that belong to the same option group share the same EFS file system\. Different DB instances can access the same data, but access can be divided by using different Oracle directories\. For more information see [Transferring files between RDS for Oracle and an Amazon EFS file system](#oracle-efs-integration.transferring)\. - -### Console - -**To configure an option group for Amazon EFS integration** - -1. Create a new option group or identify an existing option group to which you can add the `EFS_INTEGRATION` option\. - - For information about creating an option group, see [Creating an option group](USER_WorkingWithOptionGroups.md#USER_WorkingWithOptionGroups.Create)\. - -1. Add the `EFS_INTEGRATION` option to the option group\. You need to specify the `EFS_ID` file system ID and set the `USE_IAM_ROLE` flag\. - - For more information, see [Adding an option to an option group](USER_WorkingWithOptionGroups.md#USER_WorkingWithOptionGroups.AddOption)\. - -1. Associate the option group with your DB instance in either of the following ways: - + Create a new Oracle DB instance and associate the option group with it\. For information about creating a DB instance, see [Creating an Amazon RDS DB instance](USER_CreateDBInstance.md)\. - + Modify an Oracle DB instance to associate the option group with it\. For information about modifying an Oracle DB instance, see [Modifying an Amazon RDS DB instance](Overview.DBInstance.Modifying.md)\. - -### AWS CLI - -**To configure an option group for EFS integration** - -1. Create a new option group or identify an existing option group to which you can add the `EFS_INTEGRATION` option\. - - For information about creating an option group, see [Creating an option group](USER_WorkingWithOptionGroups.md#USER_WorkingWithOptionGroups.Create)\. - -1. Add the `EFS_INTEGRATION` option to the option group\. - - For example, the following AWS CLI command adds the `EFS_INTEGRATION` option to an option group named **myoptiongroup**\. -**Example** - - For Linux, macOS, or Unix: - - ``` - aws rds add-option-to-option-group \ - --option-group-name myoptiongroup \ - --options "OptionName=EFS_INTEGRATION,OptionSettings=\ - [{Name=EFS_ID,Value=fs-1234567890abcdef0},{Name=USE_IAM_ROLE,Value=TRUE}]" - ``` - - For Windows: - - ``` - aws rds add-option-to-option-group ^ - --option-group-name myoptiongroup ^ - --options "OptionName=EFS_INTEGRATION,OptionSettings=^ - [{Name=EFS_ID,Value=fs-1234567890abcdef0},{Name=USE_IAM_ROLE,Value=TRUE}]" - ``` - -1. Associate the option group with your DB instance in either of the following ways: - + Create a new Oracle DB instance and associate the option group with it\. For information about creating a DB instance, see [Creating an Amazon RDS DB instance](USER_CreateDBInstance.md)\. - + Modify an Oracle DB instance to associate the option group with it\. For information about modifying an Oracle DB instance, see [Modifying an Amazon RDS DB instance](Overview.DBInstance.Modifying.md)\. - -## Configuring Amazon EFS file system permissions - -By default, only the root user \(UID `0`\) has read, write, and execute permissions for a newly created EFS file system\. For other users to modify the file system, the root user must explicitly grant them access\. The user for the RDS for Oracle DB instance is in the `others` category\. For more information, see [Working with users, groups, and permissions at the Network File System \(NFS\) Level](https://docs.aws.amazon.com/efs/latest/ug/accessing-fs-nfs-permissions.html) in the *Amazon Elastic File System User Guide*\. - -To allow your RDS for Oracle DB instance to read and write files on an EFS file system, do the following: -+ Mount an EFS file system locally on your Amazon EC2 or on\-premises instance\. -+ Configure fine grain permissions\. - -For example, to grant `other` users permissions to write to the EFS file system root, run `chmod 777` on this directory\. For more information, see [Example Amazon EFS file system use cases and permissions](https://docs.aws.amazon.com/efs/latest/ug/accessing-fs-nfs-permissions.html#accessing-fs-nfs-permissions-ex-scenarios) in the *Amazon Elastic File System User Guide*\. - -## Transferring files between RDS for Oracle and an Amazon EFS file system - -To transfer files between an RDS for Oracle instance and an Amazon EFS file system, create at least one Oracle directory and configure EFS file system permissions to control DB instance access\. - -**Topics** -+ [Creating an Oracle directory](#oracle-efs-integration.transferring.od) -+ [Transferring data to and from an EFS file system: examples](#oracle-efs-integration.transferring.upload) - -### Creating an Oracle directory - -To create an Oracle directory, use the procedure `rdsadmin.rdsadmin_util.create_directory_efs`\. The procedure has the following parameters\. - - -**** - -| Parameter name | Data type | Default | Required | Description | -| --- | --- | --- | --- | --- | -| `p_directory_name` | VARCHAR2 | – | Yes | The name of the Oracle directory\. | -| `p_path_on_efs` | VARCHAR2 | – | Yes | The path on the EFS file system\. The prefix of the path name uses the pattern `/rdsefs-fsid/`, where *fsid* is a placeholder for your EFS file system ID\. For example, if your EFS file system is named `fs-1234567890abcdef0`, and you create a subdirectory on this file system named `mydir`, you could specify the following value: 
/rdsefs-fs-1234567890abcdef0/mydir
| - -Assume that you create a subdirectory named `/datapump1` on the EFS file system `fs-1234567890abcdef0`\. The following example creates an Oracle directory `DATA_PUMP_DIR_EFS` that points to the `/datapump1` directory on the EFS file system\. The file system path value for the `p_path_on_efs` parameter is prefixed with the string `/rdsefs-`\. - -``` -BEGIN - rdsadmin.rdsadmin_util.create_directory_efs( - p_directory_name => 'DATA_PUMP_DIR_EFS', - p_path_on_efs => '/rdsefs-fs-1234567890abcdef0/datapump1'); -END; -/ -``` - -### Transferring data to and from an EFS file system: examples - -The following example uses Oracle Data Pump to export the table named `MY_TABLE` to file `datapump.dmp`\. This file resides on an EFS file system\. - -``` -DECLARE - v_hdnl NUMBER; -BEGIN - v_hdnl := DBMS_DATAPUMP.OPEN(operation => 'EXPORT', job_mode => 'TABLE', job_name=>null); - DBMS_DATAPUMP.ADD_FILE( - handle => v_hdnl, - filename => 'datapump.dmp', - directory => 'DATA_PUMP_DIR_EFS', - filetype => dbms_datapump.ku$_file_type_dump_file); - DBMS_DATAPUMP.ADD_FILE( - handle => v_hdnl, - filename => 'datapump-exp.log', - directory => 'DATA_PUMP_DIR_EFS', - filetype => dbms_datapump.ku$_file_type_log_file); - DBMS_DATAPUMP.METADATA_FILTER(v_hdnl,'NAME_EXPR','IN (''MY_TABLE'')'); - DBMS_DATAPUMP.START_JOB(v_hdnl); -END; -/ -``` - -The following example uses Oracle Data Pump to import the table named `MY_TABLE` from file `datapump.dmp`\. This file resides on an EFS file system\. - -``` -DECLARE - v_hdnl NUMBER; -BEGIN - v_hdnl := DBMS_DATAPUMP.OPEN( - operation => 'IMPORT', - job_mode => 'TABLE', - job_name => null); - DBMS_DATAPUMP.ADD_FILE( - handle => v_hdnl, - filename => 'datapump.dmp', - directory => 'DATA_PUMP_DIR_EFS', - filetype => dbms_datapump.ku$_file_type_dump_file ); - DBMS_DATAPUMP.ADD_FILE( - handle => v_hdnl, - filename => 'datapump-imp.log', - directory => 'DATA_PUMP_DIR_EFS', - filetype => dbms_datapump.ku$_file_type_log_file); - DBMS_DATAPUMP.METADATA_FILTER(v_hdnl,'NAME_EXPR','IN (''MY_TABLE'')'); - DBMS_DATAPUMP.START_JOB(v_hdnl); -END; -/ -``` - -For more information, see [Importing data into Oracle on Amazon RDS](Oracle.Procedural.Importing.md)\. - -## Removing the EFS\_INTEGRATION option - -To remove the `EFS_INTEGRATION` option from an RDS for Oracle DB instance, do one of the following: -+ To remove the `EFS_INTEGRATION` option from multiple DB instances, remove the `EFS_INTEGRATION` option from the option group to which the DB instances belong\. This change affects all DB instances that use the option group\. For more information, see [Removing an option from an option group](USER_WorkingWithOptionGroups.md#USER_WorkingWithOptionGroups.RemoveOption)\. - - -+ To remove the `EFS_INTEGRATION` option from a single DB instance, modify the instance and specify a different option group that doesn't include the `EFS_INTEGRATION` option\. You can specify the default \(empty\) option group or a different custom option group\. For more information, see [Modifying an Amazon RDS DB instance](Overview.DBInstance.Modifying.md)\. - -## Troubleshooting Amazon EFS integration - -Your RDS for Oracle DB instance monitors the connectivity to an Amazon EFS file system\. When monitoring detects an issue, it might try to correct the issue and publish an event in the RDS console\. For more information, see [Viewing Amazon RDS events](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_ListEvents.html)\. - -Use the information in this section to help you diagnose and fix common issues when you work with Amazon EFS integration\. - - -| Notification | Description | Action | -| --- | --- | --- | -| `The EFS for RDS Oracle instance instance_name isn't available on the primary host. NFS port 2049 of your EFS isn't reachable.` | The DB instance can't communicate with the EFS file system\. | Make sure of the following: [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/oracle-efs-integration.html) | -| `The EFS isn't reachable.` | An error occurred during the installation of the `EFS_INTEGRATION` option\. | Make sure of the following: [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/oracle-efs-integration.html) | -| `The associated role with your DB instance wasn't found.` | An error occurred during the installation of the `EFS_INTEGRATION` option\. | Make sure that you associated an IAM role with your RDS for Oracle DB instance\. | -| `N/A` | You might see the following error: `PLS-00302: component 'CREATE_DIRECTORY_EFS' must be declared`\. This error can occur when you're using a version of RDS for Oracle that doesn't support Amazon EFS\. | Make sure that you are using RDS for Oracle DB instance version 19\.0\.0\.0\.ru\-2022\-07\.rur\-2022\-07\.r1 or higher\. | -| `Read access of your EFS is denied. Check your file system policy.` | Your DB instance can't read the EFS file system\. | Make sure that your EFS file system allows read access through the IAM role or on the EFS file system level\. | -| N/A | Your DB instance can't write to the EFS file system\. | Take the following steps: [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/oracle-efs-integration.html) | \ No newline at end of file diff --git a/doc_source/oracle-kerberos-connecting.md b/doc_source/oracle-kerberos-connecting.md deleted file mode 100644 index 05e3c0f..0000000 --- a/doc_source/oracle-kerberos-connecting.md +++ /dev/null @@ -1,19 +0,0 @@ -# Connecting to Oracle with Kerberos authentication - -This section assumes that you have set up your Oracle client as described in [Step 8: Configure an Oracle client](oracle-kerberos-setting-up.md#oracle-kerberos.setting-up.configure-oracle-client)\. To connect to the Oracle DB with Kerberos authentication, log in using the Kerberos authentication type\. For example, after launching Oracle SQL Developer, choose **Kerberos Authentication** as the authentication type, as shown following\. - -![\[\]](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/images/ora-kerberos-auth.png) - -To connect to Oracle with Kerberos authentication with SQL\*Plus: - -1. At a command prompt, run the following command: - - ``` - kinit username - ``` - - Replace *`username`* with the user name and, at the prompt, enter the password stored in the Microsoft Active Directory for the user\. - -1. Open SQL\*Plus and connect using the DNS name and port number for the Oracle DB instance\. - - For more information about connecting to an Oracle DB instance in SQL\*Plus, see [Connecting to your DB instance using SQL\*Plus](USER_ConnectToOracleInstance.SQLPlus.md)\. \ No newline at end of file diff --git a/doc_source/oracle-kerberos-managing.md b/doc_source/oracle-kerberos-managing.md deleted file mode 100644 index cdf36b3..0000000 --- a/doc_source/oracle-kerberos-managing.md +++ /dev/null @@ -1,53 +0,0 @@ -# Managing a DB instance in a domain - -You can use the console, the CLI, or the RDS API to manage your DB instance and its relationship with your Microsoft Active Directory\. For example, you can associate a Microsoft Active Directory to enable Kerberos authentication\. You can also disassociate a Microsoft Active Directory to disable Kerberos authentication\. You can also move a DB instance to be externally authenticated by one Microsoft Active Directory to another\. - -For example, using the CLI, you can do the following: -+ To reattempt enabling Kerberos authentication for a failed membership, use the [modify\-db\-instance](https://docs.aws.amazon.com/cli/latest/reference/rds/modify-db-instance.html) CLI command and specify the current membership's directory ID for the `--domain` option\. -+ To disable Kerberos authentication on a DB instance, use the [modify\-db\-instance](https://docs.aws.amazon.com/cli/latest/reference/rds/modify-db-instance.html) CLI command and specify `none` for the `--domain` option\. -+ To move a DB instance from one domain to another, use the [modify\-db\-instance](https://docs.aws.amazon.com/cli/latest/reference/rds/modify-db-instance.html) CLI command and specify the domain identifier of the new domain for the `--domain` option\. - -## Viewing the status of domain membership - -After you create or modify your DB instance, the DB instance becomes a member of the domain\. You can view the status of the domain membership for the DB instance in the console or by running the [describe\-db\-instances](https://docs.aws.amazon.com/cli/latest/reference/rds/describe-db-instances.html) CLI command\. The status of the DB instance can be one of the following: -+ `kerberos-enabled` – The DB instance has Kerberos authentication enabled\. -+ `enabling-kerberos` – AWS is in the process of enabling Kerberos authentication on this DB instance\. -+ `pending-enable-kerberos` – Enabling Kerberos authentication is pending on this DB instance\. -+ `pending-maintenance-enable-kerberos` – AWS will attempt to enable Kerberos authentication on the DB instance during the next scheduled maintenance window\. -+ `pending-disable-kerberos` – Disabling Kerberos authentication is pending on this DB instance\. -+ `pending-maintenance-disable-kerberos` – AWS will attempt to disable Kerberos authentication on the DB instance during the next scheduled maintenance window\. -+ `enable-kerberos-failed` – A configuration problem has prevented AWS from enabling Kerberos authentication on the DB instance\. Correct the configuration problem before reissuing the command to modify the DB instance\. -+ `disabling-kerberos` – AWS is in the process of disabling Kerberos authentication on this DB instance\. - -A request to enable Kerberos authentication can fail because of a network connectivity issue or an incorrect IAM role\. If the attempt to enable Kerberos authentication fails when you create or modify a DB instance, make sure that you're using the correct IAM role\. Then modify the DB instance to join the domain\. - -**Note** -Only Kerberos authentication with Amazon RDS for Oracle sends traffic to the domain's DNS servers\. All other DNS requests are treated as outbound network access on your DB instances running Oracle\. For more information about outbound network access with Amazon RDS for Oracle, see [Setting up a custom DNS server](Appendix.Oracle.CommonDBATasks.System.md#Appendix.Oracle.CommonDBATasks.CustomDNS)\. - -## Force\-rotating Kerberos keys - -A secret key is shared between AWS Managed Microsoft AD and Amazon RDS for Oracle DB instance\. This key is rotated automatically every 45 days\. You can use the following Amazon RDS procedure to force the rotation of this key\. - -``` -SELECT rdsadmin.rdsadmin_kerberos_auth_tasks.rotate_kerberos_keytab AS TASK_ID FROM DUAL; -``` - -**Note** -In a read replica configuration, this procedure is available only on the source DB instance and not on the read replica\. - -The `SELECT` statement returns the ID of the task in a `VARCHAR2` data type\. You can view the status of an ongoing task in a bdump file\. The bdump files are located in the `/rdsdbdata/log/trace` directory\. Each bdump file name is in the following format\. - -``` -dbtask-task-id.log -``` - -You can view the result by displaying the task's output file\. - -``` -SELECT text FROM table(rdsadmin.rds_file_util.read_text_file('BDUMP','dbtask-task-id.log')); -``` - -Replace *`task-id`* with the task ID returned by the procedure\. - -**Note** -Tasks are executed asynchronously\. \ No newline at end of file diff --git a/doc_source/oracle-kerberos-setting-up.md b/doc_source/oracle-kerberos-setting-up.md deleted file mode 100644 index aa48d77..0000000 --- a/doc_source/oracle-kerberos-setting-up.md +++ /dev/null @@ -1,324 +0,0 @@ -# Setting up Kerberos authentication for Oracle DB instances - -Use AWS Directory Service for Microsoft Active Directory, also called AWS Managed Microsoft AD, to set up Kerberos authentication for an Oracle DB instance\. To set up Kerberos authentication, complete the following steps: -+ [Step 1: Create a directory using the AWS Managed Microsoft AD](#oracle-kerberos.setting-up.create-directory) -+ [Step 2: Create a trust](#oracle-kerberos.setting-up.create-forest-trust) -+ [Step 3: Configure IAM permissions for Amazon RDS](#oracle-kerberos.setting-up.CreateIAMRole) -+ [Step 4: Create and configure users](#oracle-kerberos.setting-up.create-users) -+ [Step 5: Enable cross\-VPC traffic between the directory and the DB instance](#oracle-kerberos.setting-up.vpc-peering) -+ [Step 6: Create or modify an Oracle DB instance](#oracle-kerberos.setting-up.create-modify) -+ [Step 7: Create Kerberos authentication Oracle logins](#oracle-kerberos.setting-up.create-logins) -+ [Step 8: Configure an Oracle client](#oracle-kerberos.setting-up.configure-oracle-client) - -**Note** -During the setup, RDS creates an Oracle database user named *managed\_service\_user*@*example\.com* with the `CREATE SESSION` privilege, where *example\.com* is your domain name\. This user corresponds to the user that Directory Service creates inside your Managed Active Directory\. Periodically, RDS uses the credentials provided by the Directory Service to log in to your Oracle database\. Afterwards, RDS immediately destroys the ticket cache\. - -## Step 1: Create a directory using the AWS Managed Microsoft AD - -AWS Directory Service creates a fully managed Active Directory in the AWS Cloud\. When you create an AWS Managed Microsoft AD directory, AWS Directory Service creates two domain controllers and Domain Name System \(DNS\) servers on your behalf\. The directory servers are created in different subnets in a VPC\. This redundancy helps make sure that your directory remains accessible even if a failure occurs\. - -When you create an AWS Managed Microsoft AD directory, AWS Directory Service performs the following tasks on your behalf: -+ Sets up an Active Directory within the VPC\. -+ Creates a directory administrator account with the user name Admin and the specified password\. You use this account to manage your directory\. -**Note** -Be sure to save this password\. AWS Directory Service doesn't store it\. You can reset it, but you can't retrieve it\. -+ Creates a security group for the directory controllers\. - -When you launch an AWS Managed Microsoft AD, AWS creates an Organizational Unit \(OU\) that contains all of your directory's objects\. This OU has the NetBIOS name that you typed when you created your directory and is located in the domain root\. The domain root is owned and managed by AWS\. - -The Admin account that was created with your AWS Managed Microsoft AD directory has permissions for the most common administrative activities for your OU: -+ Create, update, or delete users -+ Add resources to your domain such as file or print servers, and then assign permissions for those resources to users in your OU -+ Create additional OUs and containers -+ Delegate authority -+ Restore deleted objects from the Active Directory Recycle Bin -+ Run AD and DNS Windows PowerShell modules on the Active Directory Web Service - -The Admin account also has rights to perform the following domain\-wide activities: -+ Manage DNS configurations \(add, remove, or update records, zones, and forwarders\) -+ View DNS event logs -+ View security event logs - -To create the directory, use the AWS Management Console, the AWS CLI, or the AWS Directory Service API\. Make sure to open the relevant outbound ports on the directory security group so that the directory can communicate with the Oracle DB instance\. - -**To create a directory with AWS Managed Microsoft AD** - -1. Sign in to the AWS Management Console and open the AWS Directory Service console at [https://console\.aws\.amazon\.com/directoryservicev2/](https://console.aws.amazon.com/directoryservicev2/)\. - -1. In the navigation pane, choose **Directories** and choose **Set up Directory**\. - -1. Choose **AWS Managed Microsoft AD**\. AWS Managed Microsoft AD is the only option that you can currently use with Amazon RDS\. - -1. Enter the following information: -**Directory DNS name** -The fully qualified name for the directory, such as **corp\.example\.com**\. -**Directory NetBIOS name** -The short name for the directory, such as **CORP**\. -**Directory description** -\(Optional\) A description for the directory\. -**Admin password** -The password for the directory administrator\. The directory creation process creates an administrator account with the user name Admin and this password\. -The directory administrator password and can't include the word "admin\." The password is case\-sensitive and must be 8–64 characters in length\. It must also contain at least one character from three of the following four categories: - + Lowercase letters \(a–z\) - + Uppercase letters \(A–Z\) - + Numbers \(0–9\) - + Non\-alphanumeric characters \(\~\!@\#$%^&\*\_\-\+=`\|\\\(\)\{\}\[\]:;"'<>,\.?/\) -**Confirm password** -The administrator password retyped\. - -1. Choose **Next**\. - -1. Enter the following information in the **Networking** section and then choose **Next**: -**VPC** -The VPC for the directory\. Create the Oracle DB instance in this same VPC\. -**Subnets** -Subnets for the directory servers\. The two subnets must be in different Availability Zones\. - -1. Review the directory information and make any necessary changes\. When the information is correct, choose **Create directory**\. -![\[Directory details page during creation\]](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/images/WinAuth2.png) - -It takes several minutes for the directory to be created\. When it has been successfully created, the **Status** value changes to **Active**\. - -To see information about your directory, choose the directory name in the directory listing\. Note the **Directory ID** value because you need this value when you create or modify your Oracle DB instance\. - -![\[Directory details page\]](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/images/WinAuth3.png) - -## Step 2: Create a trust - -If you plan to use AWS Managed Microsoft AD only, move on to [Step 3: Configure IAM permissions for Amazon RDS](#oracle-kerberos.setting-up.CreateIAMRole)\. - -To get Kerberos authentication using an on\-premises or self\-hosted Microsoft Active Directory, create a forest trust or external trust\. The trust can be one\-way or two\-way\. For more information about setting up forest trusts using AWS Directory Service, see [When to create a trust relationship](https://docs.aws.amazon.com/directoryservice/latest/admin-guide/ms_ad_setup_trust.html) in the *AWS Directory Service Administration Guide*\. - -## Step 3: Configure IAM permissions for Amazon RDS - -To call AWS Directory Service for you, Amazon RDS requires an IAM role that uses the managed IAM policy `AmazonRDSDirectoryServiceAccess`\. This role allows Amazon RDS to make calls to the AWS Directory Service\. - -**Note** -For the role to allow access, the AWS Security Token Service \(AWS STS\) endpoint must be activated in the correct AWS Region for your AWS account\. AWS STS endpoints are active by default in all AWS Regions, and you can use them without any further actions\. For more information, see [Activating and deactivating AWS STS in an AWS Region](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp_enable-regions.html#sts-regions-activate-deactivate) in the *IAM User Guide*\. - -### Creating an IAM role - -When you create a DB instance using the AWS Management Console, and the console user has the `iam:CreateRole` permission, the console creates `rds-directoryservice-kerberos-access-role` automatically\. Otherwise, you must create the IAM role manually\. When you create an IAM role manually, choose `Directory Service`, and attach the AWS managed policy `AmazonRDSDirectoryServiceAccess` to it\. - -For more information about creating IAM roles for a service, see [Creating a role to delegate permissions to an AWS service](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_create_for-service.html) in the *IAM User Guide*\. - -**Note** -The IAM role used for Windows Authentication for RDS for Microsoft SQL Server can't be used for RDS for Oracle\. - -### Creating an IAM trust policy manually - -Optionally, you can create resource policies with the required permissions instead of using the managed IAM policy `AmazonRDSDirectoryServiceAccess`\. Specify both `directoryservice.rds.amazonaws.com` and `rds.amazonaws.com` as principals\. - -To limit the permissions that Amazon RDS gives another service for a specific resource, we recommend using the [https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies_condition-keys.html#condition-keys-sourcearn](https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies_condition-keys.html#condition-keys-sourcearn) and [https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies_condition-keys.html#condition-keys-sourceaccount](https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies_condition-keys.html#condition-keys-sourceaccount) global condition context keys in resource policies\. The most effective way to protect against the confused deputy problem is to use the `aws:SourceArn` global condition context key with the full ARN of an Amazon RDS resource\. For more information, see [Preventing cross\-service confused deputy problems](cross-service-confused-deputy-prevention.md)\. - -The following example shows how you can use the `aws:SourceArn` and `aws:SourceAccount` global condition context keys in Amazon RDS to prevent the confused deputy problem\. - -``` -{ - "Version": "2012-10-17", - "Statement": [ - { - "Sid": "", - "Effect": "Allow", - "Principal": { - "Service": [ - "directoryservice.rds.amazonaws.com", - "rds.amazonaws.com" - ] - }, - "Action": "sts:AssumeRole", - "Condition": { - "ArnLike": { - "aws:SourceArn": "arn:aws:rds:us-east-1:123456789012:db:mydbinstance" - }, - "StringEquals": { - "aws:SourceAccount": "123456789012" - } - } - } - ] -} -``` - -The role must also have the following IAM policy\. - -``` -{ - "Version": "2012-10-17", - "Statement": [ - { - "Action": [ - "ds:DescribeDirectories", - "ds:AuthorizeApplication", - "ds:UnauthorizeApplication", - "ds:GetAuthorizedApplicationDetails" - ], - "Effect": "Allow", - "Resource": "*" - } - ] -} -``` - -## Step 4: Create and configure users - - You can create users with the Active Directory Users and Computers tool, which is one of the Active Directory Domain Services and Active Directory Lightweight Directory Services tools\. In this case, *users* are individual people or entities that have access to your directory\. - -To create users in an AWS Directory Service directory, you must be connected to a Windows\-based Amazon EC2 instance that is a member of the AWS Directory Service directory\. At the same time, you must be logged in as a user that has privileges to create users\. For more information about creating users in your Microsoft Active Directory, see [Manage users and groups in AWS Managed Microsoft AD](https://docs.aws.amazon.com/directoryservice/latest/admin-guide/ms_ad_manage_users_groups.html) in the *AWS Directory Service Administration Guide*\. - -## Step 5: Enable cross\-VPC traffic between the directory and the DB instance - -If you plan to locate the directory and the DB instance in the same VPC, skip this step and move on to [Step 6: Create or modify an Oracle DB instance](#oracle-kerberos.setting-up.create-modify)\. - -If you plan to locate the directory and the DB instance in different AWS accounts or VPCs, configure cross\-VPC traffic using VPC peering or [AWS Transit Gateway](https://docs.aws.amazon.com/vpc/latest/tgw/what-is-transit-gateway.html)\. The following procedure enables traffic between VPCs using VPC peering\. Follow the instructions in [What is VPC peering?](https://docs.aws.amazon.com/vpc/latest/peering/Welcome.html) in the *Amazon Virtual Private Cloud Peering Guide*\. - -**To enable cross\-VPC traffic using VPC peering** - -1. Set up appropriate VPC routing rules to ensure that network traffic can flow both ways\. - -1. Ensure that the DB instance's security group can receive inbound traffic from the directory's security group\. For more information, see [ Best practices for AWS Managed Microsoft AD](https://docs.aws.amazon.com/directoryservice/latest/admin-guide/ms_ad_best_practices.html) in the *AWS Directory Service Administration Guide*\. - -1. Ensure that there is no network access control list \(ACL\) rule to block traffic\. - -If a different AWS account owns the directory, you must share the directory\. - -**To share the directory between AWS accounts** - -1. Start sharing the directory with the AWS account that the DB instance will be created in by following the instructions in [Tutorial: Sharing your AWS Managed Microsoft AD directory for seamless EC2 Domain\-join](https://docs.aws.amazon.com/directoryservice/latest/admin-guide/ms_ad_tutorial_directory_sharing.html) in the *AWS Directory Service Administration Guide*\. - -1. Sign in to the AWS Directory Service console using the account for the DB instance, and ensure that the domain has the `SHARED` status before proceeding\. - -1. While signed into the AWS Directory Service console using the account for the DB instance, note the **Directory ID** value\. You use this directory ID to join the DB instance to the domain\. - -## Step 6: Create or modify an Oracle DB instance - -Create or modify an Oracle DB instance for use with your directory\. You can use the console, CLI, or RDS API to associate a DB instance with a directory\. You can do this in one of the following ways: -+ Create a new Oracle DB instance using the console, the [ create\-db\-instance](https://docs.aws.amazon.com/cli/latest/reference/rds/create-db-instance.html) CLI command, or the [CreateDBInstance](https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_CreateDBInstance.html) RDS API operation\. - - For instructions, see [Creating an Amazon RDS DB instance](USER_CreateDBInstance.md)\. -+ Modify an existing Oracle DB instance using the console, the [modify\-db\-instance](https://docs.aws.amazon.com/cli/latest/reference/rds/modify-db-instance.html) CLI command, or the [ModifyDBInstance](https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_ModifyDBInstance.html) RDS API operation\. - - For instructions, see [Modifying an Amazon RDS DB instance](Overview.DBInstance.Modifying.md)\. -+ Restore an Oracle DB instance from a DB snapshot using the console, the [ restore\-db\-instance\-from\-db\-snapshot](https://docs.aws.amazon.com/cli/latest/reference/rds/restore-db-instance-from-db-snapshot.html) CLI command, or the [ RestoreDBInstanceFromDBSnapshot](https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_RestoreDBInstanceFromDBSnapshot.html) RDS API operation\. - - For instructions, see [Restoring from a DB snapshot](USER_RestoreFromSnapshot.md)\. -+ Restore an Oracle DB instance to a point\-in\-time using the console, the [ restore\-db\-instance\-to\-point\-in\-time](https://docs.aws.amazon.com/cli/latest/reference/rds/restore-db-instance-to-point-in-time.html) CLI command, or the [ RestoreDBInstanceToPointInTime](https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_RestoreDBInstanceToPointInTime.html) RDS API operation\. - - For instructions, see [Restoring a DB instance to a specified time](USER_PIT.md)\. - -Kerberos authentication is only supported for Oracle DB instances in a VPC\. The DB instance can be in the same VPC as the directory, or in a different VPC\. When you create or modify the DB instance, do the following: -+ Provide the domain identifier \(`d-*` identifier\) that was generated when you created your directory\. -+ Provide the name of the IAM role that you created\. -+ Ensure that the DB instance security group can receive inbound traffic from the directory security group and send outbound traffic to the directory\. - -When you use the console to create a DB instance, choose **Password and Kerberos authentication** in the **Database authentication** section\. Choose **Browse Directory** and then select the directory, or choose **Create a new directory**\. - -![\[Kerberos authentication setting when creating a DB instance\]](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/images/kerberos-authentication.png) - -When you use the console to modify or restore a DB instance, choose the directory in the **Kerberos authentication** section, or choose **Create a new directory**\. - -![\[Kerberos authentication setting when modifying or restoring a DB instance\]](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/images/kerberos-auth-modify-restore.png) - -When you use the AWS CLI, the following parameters are required for the DB instance to be able to use the directory that you created: -+ For the `--domain` parameter, use the domain identifier \("d\-\*" identifier\) generated when you created the directory\. -+ For the `--domain-iam-role-name` parameter, use the role you created that uses the managed IAM policy `AmazonRDSDirectoryServiceAccess`\. - -For example, the following CLI command modifies a DB instance to use a directory\. - -For Linux, macOS, or Unix: - -``` -aws rds modify-db-instance \ - --db-instance-identifier mydbinstance \ - --domain d-ID \ - --domain-iam-role-name role-name -``` - -For Windows: - -``` -aws rds modify-db-instance ^ - --db-instance-identifier mydbinstance ^ - --domain d-ID ^ - --domain-iam-role-name role-name -``` - -**Important** -If you modify a DB instance to enable Kerberos authentication, reboot the DB instance after making the change\. - -**Note** -*MANAGED\_SERVICE\_USER* is a service account whose name is randomly generated by Directory Service for RDS\. During the Kerberos authentication setup, RDS for Oracle creates a user with the same name and assigns it the `CREATE SESSION` privilege\. The Oracle DB user is identified externally as *MANAGED\_SERVICE\_USER@EXAMPLE\.COM*, where *EXAMPLE\.COM* is the name of your domain\. Periodically, RDS uses the credentials provided by the Directory Service to log in to your Oracle database\. Afterward, RDS immediately destroys the ticket cache\. - -## Step 7: Create Kerberos authentication Oracle logins - -Use the Amazon RDS master user credentials to connect to the Oracle DB instance as you do any other DB instance\. The DB instance is joined to the AWS Managed Microsoft AD domain\. Thus, you can provision Oracle logins and users from the Microsoft Active Directory users and groups in your domain\. To manage database permissions, you grant and revoke standard Oracle permissions to these logins\. - -**To allow a Microsoft Active Directory user to authenticate with Oracle** - -1. Connect to the Oracle DB instance using your Amazon RDS master user credentials\. - -1. Create an externally authenticated user in Oracle database\. - - In the following example, replace `KRBUSER@CORP.EXAMPLE.COM` with the user name and domain name\. - - ``` - CREATE USER "KRBUSER@CORP.EXAMPLE.COM" IDENTIFIED EXTERNALLY; - GRANT CREATE SESSION TO "KRBUSER@CORP.EXAMPLE.COM"; - ``` - - Users \(both humans and applications\) from your domain can now connect to the Oracle DB instance from a domain joined client machine using Kerberos authentication\. - -## Step 8: Configure an Oracle client - -To configure an Oracle client, meet the following requirements: -+ Create a configuration file named krb5\.conf \(Linux\) or krb5\.ini \(Windows\) to point to the domain\. Configure the Oracle client to use this configuration file\. -+ Verify that traffic can flow between the client host and AWS Directory Service over DNS port 53 over TCP/UDP, Kerberos ports \(88 and 464 for managed AWS Directory Service\) over TCP, and LDAP port 389 over TCP\. -+ Verify that traffic can flow between the client host and the DB instance over the database port\. - -Following is sample content for AWS Managed Microsoft AD\. - -``` -[libdefaults] - default_realm = EXAMPLE.COM -[realms] - EXAMPLE.COM = { - kdc = example.com - admin_server = example.com - } -[domain_realm] - .example.com = CORP.EXAMPLE.COM - example.com = CORP.EXAMPLE.COM -``` - -Following is sample content for on\-premise Microsoft AD\. In your krb5\.conf or krb5\.ini file, replace *on\-prem\-ad\-server\-name* with the name of your on\-premises AD server\. - -``` -[libdefaults] - default_realm = ONPREM.COM -[realms] - AWSAD.COM = { - kdc = awsad.com - admin_server = awsad.com - } - ONPREM.COM = { - kdc = on-prem-ad-server-name - admin_server = on-prem-ad-server-name - } -[domain_realm] - .awsad.com = AWSAD.COM - awsad.com= AWSAD.COM - .onprem.com = ONPREM.COM - onprem.com= ONPREM.COM -``` - -**Note** -After you configure your krb5\.ini or krb5\.conf file, we recommend that you reboot the server\. - -The following is sample sqlnet\.ora content for a SQL\*Plus configuration: - -``` -SQLNET.AUTHENTICATION_SERVICES=(KERBEROS5PRE,KERBEROS5) -SQLNET.KERBEROS5_CONF=path_to_krb5.conf_file -``` - -For an example of a SQL Developer configuration, see [Document 1609359\.1](https://support.oracle.com/epmos/faces/DocumentDisplay?id=1609359.1) from Oracle Support\. \ No newline at end of file diff --git a/doc_source/oracle-kerberos.md b/doc_source/oracle-kerberos.md deleted file mode 100644 index 1bf22d9..0000000 --- a/doc_source/oracle-kerberos.md +++ /dev/null @@ -1,18 +0,0 @@ -# Configuring Kerberos authentication for Amazon RDS for Oracle - -You can use Kerberos authentication to authenticate users when they connect to your Amazon RDS for Oracle DB instance\. In this configuration, your DB instance works with AWS Directory Service for Microsoft Active Directory, also called AWS Managed Microsoft AD\. When users authenticate with an RDS for Oracle DB instance joined to the trusting domain, authentication requests are forwarded to the directory that you create with AWS Directory Service\. - -Keeping all of your credentials in the same directory can save you time and effort\. You have a centralized place for storing and managing credentials for multiple database instances\. A directory can also improve your overall security profile\. - -## Region and version availability - -Feature availability and support varies across specific versions of each database engine, and across AWS Regions\. For more information on version and Region availability of RDS for Oracle with Kerberos authentication, see [Kerberos authentication](Concepts.RDS_Fea_Regions_DB-eng.Feature.KerberosAuthentication.md)\. - -**Note** -Kerberos authentication isn't supported for DB instance classes that are deprecated for RDS for Oracle DB instances\. For more information, see [RDS for Oracle instance classes](Oracle.Concepts.InstanceClasses.md)\. - -**Topics** -+ [Region and version availability](#oracle-kerberos-setting-up.RegionVersionAvailability) -+ [Setting up Kerberos authentication for Oracle DB instances](oracle-kerberos-setting-up.md) -+ [Managing a DB instance in a domain](oracle-kerberos-managing.md) -+ [Connecting to Oracle with Kerberos authentication](oracle-kerberos-connecting.md) \ No newline at end of file diff --git a/doc_source/oracle-multi-architecture.md b/doc_source/oracle-multi-architecture.md deleted file mode 100644 index ab8a449..0000000 --- a/doc_source/oracle-multi-architecture.md +++ /dev/null @@ -1,15 +0,0 @@ -# RDS for Oracle database architecture - -The multitenant architecture enables an Oracle database to function as a multitenant container database \(CDB\)\. A CDB can include customer\-created pluggable databases \(PDBs\)\. A non\-CDB is an Oracle database that uses the traditional architecture, which can't contain PDBs\. For more information about the multitenant architecture, see [https://docs.oracle.com/en/database/oracle/oracle-database/19/multi/introduction-to-the-multitenant-architecture.html#GUID-267F7D12-D33F-4AC9-AA45-E9CD671B6F22](https://docs.oracle.com/en/database/oracle/oracle-database/19/multi/introduction-to-the-multitenant-architecture.html#GUID-267F7D12-D33F-4AC9-AA45-E9CD671B6F22)\. - -For Oracle Database 19c and higher, RDS for Oracle supports the single\-tenant configuration of the multitenant architecture\. In this case, your CDB contains only one PDB\. The single\-tenant configuration of the multitenant architecture uses the same RDS APIs as the non\-CDB architecture\. Thus, your experience with a PDB is mostly identical to your experience with a non\-CDB\. - -**Note** -You can't access the CDB itself\. - -In Oracle Database 21c and higher, all databases are CDBs\. In contrast, you can create an Oracle Database 19c DB instance as either a CDB or non\-CDB\. You can't upgrade a non\-CDB to a CDB, but you convert an Oracle Database 19c non\-CDB to a CDB, and then upgrade it\. You can't convert a CDB to a non\-CDB\. - -For more information, see the following resources: -+ [Working with CDBs in RDS for Oracle](oracle-multitenant.md) -+ [Limitations of a single\-tenant CDB](Oracle.Concepts.limitations.md#Oracle.Concepts.single-tenant-limitations) -+ [Creating an Amazon RDS DB instance](USER_CreateDBInstance.md) \ No newline at end of file diff --git a/doc_source/oracle-multitenant.md b/doc_source/oracle-multitenant.md deleted file mode 100644 index 9b3f4c1..0000000 --- a/doc_source/oracle-multitenant.md +++ /dev/null @@ -1,302 +0,0 @@ -# Working with CDBs in RDS for Oracle - -In the Oracle multitenant architecture, a container database \(CDB\) can include customer\-created pluggable databases \(PDBs\)\. For more information about CDBs, see [Introduction to the Multitenant Architecture ](https://docs.oracle.com/en/database/oracle/oracle-database/19/multi/introduction-to-the-multitenant-architecture.html#GUID-267F7D12-D33F-4AC9-AA45-E9CD671B6F22) in the Oracle Database documentation\. - -**Topics** -+ [Overview of RDS for Oracle CDBs](#Oracle.Concepts.single-tenant) -+ [Configuring an RDS for Oracle CDB](#oracle-cdb.configuring) -+ [Backing up and restoring a CDB](#Oracle.Concepts.single-tenant.snapshots) -+ [Converting an RDS for Oracle non\-CDB to a CDB](#oracle-cdb-converting) -+ [Upgrading your CDB](#Oracle.Concepts.single-tenant.upgrades) - -## Overview of RDS for Oracle CDBs - -You can create an RDS for Oracle DB instance as a container database \(CDB\) when you run Oracle Database 19c or higher\. A CDB differs from a non\-CDB because it can contain pluggable databases \(PDBs\)\. A PDB is a portable collection of schemas and objects that appears to an application as a separate database\. - -Starting with Oracle Database 21c, all databases are CDBs\. If your DB instance runs Oracle Database 19c, you can create either a CDB or a non\-CDB\. A non\-CDB uses the traditional Oracle database architecture and can't contain PDBs\. You can convert an Oracle Database 19c non\-CDB to a CDB, but you can't convert a CDB to a non\-CDB\. You can only upgrade a CDB to a CDB\. - -**Topics** -+ [Single\-tenant configuration](#single-tenant-access) -+ [Creation and conversion options in a CDB](#oracle-cdb-creation-conversion) -+ [User accounts and privileges in a CDB](#Oracle.Concepts.single-tenant.users) -+ [Parameter group families in a CDB](#Oracle.Concepts.single-tenant.parameters) -+ [PDB portability in a CDB](#Oracle.Concepts.single-tenant.migration) - -### Single\-tenant configuration - -RDS for Oracle supports the single\-tenant configuration of the Oracle multitenant architecture\. This means that an RDS for Oracle DB instance can contain only one PDB\. You name the PDB when you create your DB instance\. The CDB name defaults to `RDSCDB` and can't be changed\. - -In RDS for Oracle, your client application interacts with the PDB rather than the CDB\. Your experience with a PDB is mostly identical to your experience with a non\-CDB\. You use the same Amazon RDS APIs in the single\-tenant configuration as you do in the non\-CDB architecture\. You can't access the CDB itself\. - -### Creation and conversion options in a CDB - -Although Oracle Database 21c supports only CDBs, Oracle Database 19c supports both CDBs and non\-CDBs\. The following table shows the different options for creating and converting CDBs and non\-CDBs\. - - -| Release | Database creation options | Architecture conversion options | Major version upgrade targets | -| --- | --- | --- | --- | -| Oracle Database 21c | CDB only | N/A | N/A | -| Oracle Database 19c | CDB or non\-CDB | Non\-CDB to CDB \(April 2021 RU or higher\) | 21c CDB \(from 19c CDB only\) | -| Oracle Database 12c \(desupported\) | Non\-CDB only | N/A | 19c non\-CDB | - -As shown in the preceding table, you can't directly upgrade a non\-CDB to a CDB in a new major version\. But you can convert an Oracle Database 19c non\-CDB to an Oracle Database 19c CDB, and then upgrade the Oracle Database 19c CDB to an Oracle Database 21c CDB\. For more information, see [Converting an RDS for Oracle non\-CDB to a CDB](#oracle-cdb-converting)\. - -### User accounts and privileges in a CDB - -In the Oracle multitenant architecture, all user accounts are either common users or local users\. A CDB common user is a database user whose single identity and password are known in the CDB root and in every existing and future PDB\. In contrast, a local user exists only in a single PDB\. - -The RDS master user is a local user account in the PDB, which you name when you create your DB instance\. If you create new user accounts, these users will also be local users residing in the PDB\. You can't use any user accounts to create new PDBs or modify the state of the existing PDB\. - -The `rdsadmin` user is a common user account\. You can run RDS for Oracle packages that exist in this account, but you can't log in as `rdsadmin`\. For more information, see [About Common Users and Local Users](https://docs.oracle.com/en/database/oracle/oracle-database/19/dbseg/managing-security-for-oracle-database-users.html#GUID-BBBD9904-F2F3-442B-9AFC-8ACDD9A588D8) in the Oracle documentation\. - -### Parameter group families in a CDB - -CDBs have their own parameter group families and default parameter values\. The CDB parameter group families are as follows: -+ oracle\-ee\-cdb\-21 -+ oracle\-se2\-cdb\-21 -+ oracle\-ee\-cdb\-19 -+ oracle\-se2\-cdb\-19 - -You specify parameters at the CDB level rather than the PDB level\. The PDB inherits parameter settings from the CDB\. For more information about setting parameters, see [Working with parameter groups](USER_WorkingWithParamGroups.md)\. For best practices, see [Working with DB parameter groups](CHAP_BestPractices.md#CHAP_BestPractices.DBParameterGroup)\. - -### PDB portability in a CDB - -Your CDB can contain only a single PDB\. You can't unplug this PDB or plug in a different PDB\. To move data into or out of your CDB, use the same techniques as for a non\-CDB\. For more information about migrating data, see [Importing data into Oracle on Amazon RDS](Oracle.Procedural.Importing.md)\. - -## Configuring an RDS for Oracle CDB - -Configuring a CDB is similar to configuring a non\-CDB\. - -**Topics** -+ [Creating an RDS for Oracle CDB instance](#Oracle.Concepts.single-tenant.creation) -+ [Connecting to a PDB in your RDS for Oracle CDB](#Oracle.Concepts.single-tenant.users) - -### Creating an RDS for Oracle CDB instance - -In RDS for Oracle, creating a CDB is almost identical to creating a non\-CDB\. The difference is that you choose the Multitenant architecture when creating your DB instance\. To create a CDB, use the AWS Management Console, the AWS CLI, or the RDS API\. - -#### Console - -**To create a CDB instance** - -1. Sign in to the AWS Management Console and open the Amazon RDS console at [https://console\.aws\.amazon\.com/rds/](https://console.aws.amazon.com/rds/)\. - -1. In the upper\-right corner of the Amazon RDS console, choose the AWS Region in which you want to create the CDB instance\. - -1. In the navigation pane, choose **Databases**\. - -1. Choose **Create database**\. - -1. In **Choose a database creation method**, select **Standard Create**\. - -1. In **Engine options**, choose **Oracle**\. - -1. For **Database management type**, choose **Amazon RDS**\. - -1. For **Architecture settings**, choose **Multitenant architecture**\. - -1. Choose the settings that you want based on the options listed in [Settings for DB instances](USER_CreateDBInstance.md#USER_CreateDBInstance.Settings)\. Note the following: - + For **Master username**, enter the name for a local user in your PDB\. You can't use the master username to log in to the CDB root\. - + For **Initial database name**, enter the name of your PDB\. You can't name the CDB, which has the default name `RDSCDB`\. - -1. Choose **Create database**\. - -#### AWS CLI - -To create a DB instance by using the AWS CLI, call the [create\-db\-instance](https://docs.aws.amazon.com/cli/latest/reference/rds/create-db-instance.html) command with the following parameters: -+ `--db-instance-identifier` -+ `--db-instance-class` -+ `--engine { oracle-ee-cdb | oracle-se2-cdb }` -+ `--master-username` -+ `--master-user-password` -+ `--allocated-storage` -+ `--backup-retention-period` - -For information about each setting, see [Settings for DB instances](USER_CreateDBInstance.md#USER_CreateDBInstance.Settings)\. - -This following example creates an RDS for Oracle DB instance named *my\-cdb\-inst*\. The PDB is named *mypdb*\. - -**Example** -For Linux, macOS, or Unix: - -``` -1. aws rds create-db-instance \ -2. --engine oracle-ee-cdb \ -3. --db-instance-identifier my-cdb-inst \ -4. --db-name mypdb \ -5. --allocated-storage 250 \ -6. --db-instance-class db.t3.large \ -7. --master-username pdb_admin \ -8. --master-user-password masteruserpassword \ -9. --backup-retention-period 3 -``` -For Windows: - -``` -1. aws rds create-db-instance ^ -2. --engine oracle-ee-cdb ^ -3. --db-instance-identifier my-cdb-inst ^ -4. --db-name mypdb ^ -5. --allocated-storage 250 ^ -6. --db-instance-class db.t3.large ^ -7. --master-username pdb_admin ^ -8. --master-user-password masteruserpassword ^ -9. --backup-retention-period 3 -``` -This command produces output similar to the following\. - -``` - 1. { - 2. "DBInstance": { - 3. "DBInstanceIdentifier": "my-cdb-inst", - 4. "DBInstanceClass": "db.t3.large", - 5. "Engine": "oracle-ee-cdb", - 6. "DBInstanceStatus": "creating", - 7. "MasterUsername": "pdb_user", - 8. "DBName": "MYPDB", - 9. "AllocatedStorage": 250, -10. "PreferredBackupWindow": "04:59-05:29", -11. "BackupRetentionPeriod": 3, -12. "DBSecurityGroups": [], -13. "VpcSecurityGroups": [ -14. { -15. "VpcSecurityGroupId": "sg-0a2bcd3e", -16. "Status": "active" -17. } -18. ], -19. "DBParameterGroups": [ -20. { -21. "DBParameterGroupName": "default.oracle-ee-cdb-19", -22. "ParameterApplyStatus": "in-sync" -23. } -24. ], -25. "DBSubnetGroup": { -26. "DBSubnetGroupName": "default", -27. "DBSubnetGroupDescription": "default", -28. "VpcId": "vpc-1234567a", -29. "SubnetGroupStatus": "Complete", -30. ... -``` - -#### RDS API - -To create a DB instance by using the Amazon RDS API, call the [CreateDBInstance](https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_CreateDBInstance.html) operation\. - -For information about each setting, see [Settings for DB instances](USER_CreateDBInstance.md#USER_CreateDBInstance.Settings)\. - -### Connecting to a PDB in your RDS for Oracle CDB - -You can use a utility like SQL\*Plus to connect to a PDB\. To download Oracle Instant Client, which includes a standalone version of SQL\*Plus, see [ Oracle Instant Client Downloads](https://www.oracle.com/database/technologies/instant-client/downloads.html)\. - -To connect SQL\*Plus to your PDB, you need the following information: -+ Database user name and password -+ Endpoint for your DB instance -+ Port number - -For information about finding the preceding information, see [Finding the endpoint of your Oracle DB instance](USER_Endpoint.md)\. - -**Example To connect to your PDB using SQL\*Plus** -In the following examples, substitute your master user for *master\_user\_name*\. Also, substitute the endpoint for your DB instance, and then include the port number and the Oracle SID\. The SID value is the name of the PDB that you specified when you created your DB instance, and not the DB instance identifier\. -For Linux, macOS, or Unix: - -``` -1. sqlplus 'master_user_name@(DESCRIPTION=(ADDRESS=(PROTOCOL=TCP)(HOST=endpoint)(PORT=port))(CONNECT_DATA=(SID=pdb_name)))' -``` -For Windows: - -``` -1. sqlplus master_user_name@(DESCRIPTION=(ADDRESS=(PROTOCOL=TCP)(HOST=endpoint)(PORT=port))(CONNECT_DATA=(SID=pdb_name))) -``` -You should see output similar to the following\. - -``` -SQL*Plus: Release 19.0.0.0.0 Production on Mon Aug 21 09:42:20 2021 -``` -After you enter the password for the user, the SQL prompt appears\. - -``` -SQL> -``` - -**Note** -The shorter format connection string \(Easy connect or EZCONNECT\), such as `sqlplus username/password@LONGER-THAN-63-CHARS-RDS-ENDPOINT-HERE:1521/database-identifier`, might encounter a maximum character limit and should not be used to connect\. - -## Backing up and restoring a CDB - -DB snapshots work the same way in the multitenant and non\-multitenant architecture\. The only difference is that when you restore a DB snapshot, you can only rename the PDB, not the CDB\. The CDB is always named `RDSCDB`\. For more information, see [Oracle Database considerations](USER_RestoreFromSnapshot.md#USER_RestoreFromSnapshot.Oracle)\. - -## Converting an RDS for Oracle non\-CDB to a CDB - -You can change the architecture of an Oracle database from the traditional non\-CDB architecture to the multitenant architecture\. When you upgrade your database engine version, you can't change the database architecture in the same operation\. Therefore, to upgrade an Oracle Database 19c non\-CDB to an Oracle Database 21c CDB, you first need to convert the non\-CDB to a CDB, and then upgrade the 19c CDB to a 21c CDB\. - -The non\-CDB conversion operation has the following requirements: -+ Make sure that you specify `oracle-ee-cdb` or `oracle-se2-cdb` for the engine type\. These are the only supported values\. -+ Make sure that your DB engine runs Oracle Database 19c with an April 2021 or later RU\. - -The operation has the following limitations: -+ You can't convert a CDB to a non\-CDB\. You can only convert a non\-CDB to a CDB\. -+ You can't convert a primary or replica database that has Oracle Data Guard enabled\. -+ You can't upgrade the DB engine version and convert a non\-CDB to a CDB in the same operation\. -+ The considerations for option and parameter groups are the same as for upgrading the DB engine\. For more information, see [Considerations for Oracle DB upgrades](USER_UpgradeDBInstance.Oracle.OGPG.md)\. - -### Console - -**To convert a non\-CDB to a CDB** - -1. Sign in to the AWS Management Console and open the Amazon RDS console at [https://console\.aws\.amazon\.com/rds/](https://console.aws.amazon.com/rds/)\. - -1. In the upper\-right corner of the Amazon RDS console, choose the AWS Region where your DB instance resides\. - -1. In the navigation pane, choose **Databases**, and then choose the non\-CDB instance that you want to convert to a CDB instance\. - -1. Choose **Modify**\. - -1. For **Architecture settings**, select **Multitenant architecture**\. - -1. \(Optional\) For **DB parameter group**, choose a new parameter group for your CDB instance\. The same parameter group considerations apply when converting a DB instance as when upgrading a DB instance\. For more information, see [Parameter group considerations](USER_UpgradeDBInstance.Oracle.OGPG.md#USER_UpgradeDBInstance.Oracle.OGPG.PG)\. - -1. \(Optional\) For **Option group**, choose a new option group for your CDB instance\. The same option group considerations apply when converting a DB instance as when upgrading a DB instance\. For more information, see [Option group considerations](USER_UpgradeDBInstance.Oracle.OGPG.md#USER_UpgradeDBInstance.Oracle.OGPG.OG)\. - -1. When all the changes are as you want them, choose **Continue** and check the summary of modifications\. - -1. \(Optional\) Choose **Apply immediately** to apply the changes immediately\. Choosing this option can cause downtime in some cases\. For more information, see [Using the Apply Immediately setting](Overview.DBInstance.Modifying.md#USER_ModifyInstance.ApplyImmediately)\. - -1. On the confirmation page, review your changes\. If they are correct, choose **Modify DB instance**\. - - Or choose **Back** to edit your changes or **Cancel** to cancel your changes\. - -### AWS CLI - -To convert the non\-CDB on your DB instance to a CDB, set `--engine` to `oracle-ee-cdb` or `oracle-se2-cdb` in the AWS CLI command [modify\-db\-instance](https://docs.aws.amazon.com/cli/latest/reference/rds/modify-db-instance.html)\. - -The following example converts the DB instance named *my\-non\-cdb* and specifies a custom option group and parameter group\. - -**Example** -For Linux, macOS, or Unix: - -``` -aws rds modify-db-instance \ - --db-instance-identifier my-non-cdb \ - --engine oracle-ee-cdb \ - --option-group-name custom-option-group \ - --db-parameter-group-name custom-parameter-group -``` -For Windows: - -``` -aws rds modify-db-instance ^ - --db-instance-identifier my-non-cdb ^ - --engine oracle-ee-cdb ^ - --option-group-name custom-option-group ^ - --db-parameter-group-name custom-parameter-group -``` - -### RDS API - -To convert a non\-CDB to a CDB, specify `Engine` in the RDS API operation [ModifyDBInstance](https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_ModifyDBInstance.html)\. - -## Upgrading your CDB - -You can upgrade a CDB to a different Oracle Database release\. For example, you can upgrade an Oracle Database 19c CDB to an Oracle Database 21c CDB\. You can't change the database architecture during an upgrade\. Thus, you can't upgrade a non\-CDB to a CDB or upgrade a CDB to a non\-CDB\. - -The procedure for upgrading a CDB to a CDB is the same as for upgrading a non\-CDB to a non\-CDB\. For more information, see [Upgrading the RDS for Oracle DB engine](USER_UpgradeDBInstance.Oracle.md)\. \ No newline at end of file diff --git a/doc_source/oracle-options-java.md b/doc_source/oracle-options-java.md deleted file mode 100644 index 6df134d..0000000 --- a/doc_source/oracle-options-java.md +++ /dev/null @@ -1,95 +0,0 @@ -# Oracle Java virtual machine - -Amazon RDS supports Oracle Java Virtual Machine \(JVM\) through the use of the `JVM` option\. Oracle Java provides a SQL schema and functions that facilitate Oracle Java features in an Oracle database\. For more information, see [ Introduction to Java in Oracle database](https://docs.oracle.com/database/121/JJDEV/chone.htm) in the Oracle documentation\. - -You can use Oracle JVM with the following Oracle Database versions: -+ Oracle Database 21c \(21\.0\.0\), all versions -+ Oracle Database 19c \(19\.0\.0\), all versions -+ Oracle Database 12c Release 2 \(12\.2\), all versions -+ Oracle Database 12c Release 1 \(12\.1\), version 12\.1\.0\.2\.v13 and higher - -Java implementation in Amazon RDS has a limited set of permissions\. The master user is granted the `RDS_JAVA_ADMIN` role, which grants a subset of the privileges granted by the `JAVA_ADMIN` role\. To list the privileges granted to the `RDS_JAVA_ADMIN` role, run the following query on your DB instance: - -``` -SELECT * FROM dba_java_policy - WHERE grantee IN ('RDS_JAVA_ADMIN', 'PUBLIC') - AND enabled = 'ENABLED' - ORDER BY type_name, name, grantee; -``` - -## Prerequisites for Oracle JVM - -The following are prerequisites for using Oracle Java: -+ Your DB instance must be of a large enough class\. Oracle Java isn't supported for the db\.t3\.micro or db\.t3\.small DB instance classes\. For more information, see [DB instance classes](Concepts.DBInstanceClass.md)\. -+ Your DB instance must have **Auto Minor Version Upgrade** enabled\. This option enables your DB instance to receive minor DB engine version upgrades automatically when they become available\. Amazon RDS uses this option to update your DB instance to the latest Oracle Patch Set Update \(PSU\) or Release Update \(RU\)\. For more information, see [Modifying an Amazon RDS DB instance](Overview.DBInstance.Modifying.md)\. - -## Best practices for Oracle JVM - -The following are best practices for using Oracle Java: -+ For maximum security, use the `JVM` option with Secure Sockets Layer \(SSL\)\. For more information, see [Oracle Secure Sockets Layer](Appendix.Oracle.Options.SSL.md)\. -+ Configure your DB instance to restrict network access\. For more information, see [Scenarios for accessing a DB instance in a VPC](USER_VPC.Scenarios.md) and [Working with a DB instance in a VPC](USER_VPC.WorkingWithRDSInstanceinaVPC.md)\. -+ Update the configuration of your HTTPS endpoints to support TLSv1\.2 if you meet the following conditions: - + You use Oracle Java Virtual Machine \(JVM\) to connect an HTTPS endpoint over TLSv1 or TLSv1\.1 protocols\. - + Your endpoint doesn't support the TLSv1\.2 protocol\. - + You haven't applied the April 2021 release update to your Oracle DB\. - - By updating your endpoint configuration, you ensure that the connectivity of the JVM to the HTTPS endpoint will continue to work\. For more information about TLS changes in the Oracle JRE and JDK, see [Oracle JRE and JDK Cryptographic Roadmap](https://java.com/en/jre-jdk-cryptoroadmap.html)\. - -## Adding the Oracle JVM option - -The following is the general process for adding the `JVM` option to a DB instance: - -1. Create a new option group, or copy or modify an existing option group\. - -1. Add the option to the option group\. - -1. Associate the option group with the DB instance\. - -There is a brief outage while the `JVM` option is added\. After you add the option, you don't need to restart your DB instance\. As soon as the option group is active, Oracle Java is available\. - -**Note** -During this outage, password verification functions are disabled briefly\. You can also expect to see events related to password verification functions during the outage\. Password verification functions are enabled again before the Oracle DB instance is available\. - -**To add the JVM option to a DB instance** - -1. Determine the option group that you want to use\. You can create a new option group or use an existing option group\. If you want to use an existing option group, skip to the next step\. Otherwise, create a custom DB option group with the following settings: - + For **Engine**, choose the DB engine used by the DB instance \(**oracle\-ee**, **oracle\-se**, **oracle\-se1**, or **oracle\-se2**\)\. - + For **Major engine version**, choose the version of your DB instance\. - - For more information, see [Creating an option group](USER_WorkingWithOptionGroups.md#USER_WorkingWithOptionGroups.Create)\. - -1. Add the **JVM** option to the option group\. For more information about adding options, see [Adding an option to an option group](USER_WorkingWithOptionGroups.md#USER_WorkingWithOptionGroups.AddOption)\. - -1. Apply the option group to a new or existing DB instance: - + For a new DB instance, apply the option group when you launch the instance\. For more information, see [Creating an Amazon RDS DB instance](USER_CreateDBInstance.md)\. - + For an existing DB instance, apply the option group by modifying the instance and attaching the new option group\. For more information, see [Modifying an Amazon RDS DB instance](Overview.DBInstance.Modifying.md)\. - -1. Grant the required permissions to users\. - - The Amazon RDS master user has the permissions to use the `JVM` option by default\. If other users require these permissions, connect to the DB instance as the master user in a SQL client and grant the permissions to the users\. - - The following example grants the permissions to use the `JVM` option to the `test_proc` user\. - - ``` - create user test_proc identified by password; - CALL dbms_java.grant_permission('TEST_PROC', 'oracle.aurora.security.JServerPermission', 'LoadClassInPackage.*', ''); - ``` - - After the user is granted the permissions, the following query should return output\. - - ``` - select * from dba_java_policy where grantee='TEST_PROC'; - ``` -**Note** -The Oracle user name is case\-sensitive, and it usually has all uppercase characters\. - -## Removing the Oracle JVM option - -You can remove the `JVM` option from a DB instance\. There is a brief outage while the option is removed\. After you remove the `JVM` option, you don't need to restart your DB instance\. - -**Warning** - Removing the `JVM` option can result in data loss if the DB instance is using data types that were enabled as part of the option\. Back up your data before proceeding\. For more information, see [Backing up and restoring](CHAP_CommonTasks.BackupRestore.md)\. - -To remove the `JVM` option from a DB instance, do one of the following: -+ Remove the `JVM` option from the option group it belongs to\. This change affects all DB instances that use the option group\. For more information, see [Removing an option from an option group](USER_WorkingWithOptionGroups.md#USER_WorkingWithOptionGroups.RemoveOption)\. -+ Modify the DB instance and specify a different option group that doesn't include the `JVM` option\. This change affects a single DB instance\. You can specify the default \(empty\) option group, or a different custom option group\. For more information, see [Modifying an Amazon RDS DB instance](Overview.DBInstance.Modifying.md)\. \ No newline at end of file diff --git a/doc_source/oracle-read-replicas.Configuration.md b/doc_source/oracle-read-replicas.Configuration.md deleted file mode 100644 index 1ffa2d4..0000000 --- a/doc_source/oracle-read-replicas.Configuration.md +++ /dev/null @@ -1,44 +0,0 @@ -# Preparing to create an Oracle replica - -Before you can begin using your replica, perform the following tasks\. - -**Topics** -+ [Enabling automatic backups](#oracle-read-replicas.configuration.autobackups) -+ [Enabling force logging mode](#oracle-read-replicas.configuration.force-logging) -+ [Changing your logging configuration](#oracle-read-replicas.configuration.logging-config) -+ [Setting the MAX\_STRING\_SIZE parameter](#oracle-read-replicas.configuration.string-size) -+ [Planning compute and storage resources](#oracle-read-replicas.configuration.planning-resources) - -## Enabling automatic backups - -Before a DB instance can serve as a source DB instance, make sure to enable automatic backups on the source DB instance\. To learn how to perform this procedure, see [Enabling automated backups](USER_WorkingWithAutomatedBackups.md#USER_WorkingWithAutomatedBackups.Enabling)\. - -## Enabling force logging mode - -We recommend that you enable force logging mode\. In force logging mode, the Oracle database writes redo records even when `NOLOGGING` is used with data definition language \(DDL\) statements\. - -**To enable force logging mode** - -1. Log in to your Oracle database using a client tool such as SQL Developer\. - -1. Enable force logging mode by running the following procedure\. - - ``` - exec rdsadmin.rdsadmin_util.force_logging(p_enable => true); - ``` - -For more information about this procedure, see [Setting force logging](Appendix.Oracle.CommonDBATasks.Log.md#Appendix.Oracle.CommonDBATasks.SettingForceLogging)\. - -## Changing your logging configuration - -If you want to change your logging configuration, we recommend that you complete the changes before making a DB instance the source for replicas\. Also, we recommend that you not modify the logging configuration after you create the replicas\. Modifications can cause the online redo logging configuration to get out of sync with the standby logging configuration\. - -Modify the logging configuration for a DB instance by using the Amazon RDS procedures `rdsadmin.rdsadmin_util.add_logfile` and `rdsadmin.rdsadmin_util.drop_logfile`\. For more information, see [Adding online redo logs](Appendix.Oracle.CommonDBATasks.Log.md#Appendix.Oracle.CommonDBATasks.RedoLogs) and [Dropping online redo logs](Appendix.Oracle.CommonDBATasks.Log.md#Appendix.Oracle.CommonDBATasks.DroppingRedoLogs)\. - -## Setting the MAX\_STRING\_SIZE parameter - -Before you create an Oracle replica, ensure that the setting of the `MAX_STRING_SIZE` parameter is the same on the source DB instance and the replica\. You can do this by associating them with the same parameter group\. If you have different parameter groups for the source and the replica, you can set `MAX_STRING_SIZE` to the same value\. For more information about setting this parameter, see [Turning on extended data types for a new DB instance](Oracle.Concepts.ExtendedDataTypes.md#Oracle.Concepts.ExtendedDataTypes.CreateDBInstance)\. - -## Planning compute and storage resources - -Ensure that the source DB instance and its replicas are sized properly, in terms of compute and storage, to suit their operational load\. If a replica reaches compute, network, or storage resource capacity, the replica stops receiving or applying changes from its source\. Amazon RDS for Oracle doesn't intervene to mitigate high replica lag between a source DB instance and its replicas\. You can modify the storage and CPU resources of a replica independently from its source and other replicas\. \ No newline at end of file diff --git a/doc_source/oracle-read-replicas.backups.md b/doc_source/oracle-read-replicas.backups.md deleted file mode 100644 index a0377a5..0000000 --- a/doc_source/oracle-read-replicas.backups.md +++ /dev/null @@ -1,88 +0,0 @@ -# Working with RDS for Oracle replica backups - -You can create and restore backups of an RDS for Oracle replica\. Both automatic backups and manual snapshots are supported\. For more information, see [Backing up and restoring](CHAP_CommonTasks.BackupRestore.md)\. The following sections describe the key differences between managing backups of a primary and an RDS for Oracle replica\. - -## Turning on RDS for Oracle replica backups - -An Oracle replica doesn't have automated backups turned on by default\. You turn on automated backups by setting the backup retention period to a positive nonzero value\. - -### Console - -**To enable automated backups immediately** - -1. Sign in to the AWS Management Console and open the Amazon RDS console at [https://console\.aws\.amazon\.com/rds/](https://console.aws.amazon.com/rds/)\. - -1. In the navigation pane, choose **Databases**, and then choose the DB instance or Multi\-AZ DB cluster that you want to modify\. - -1. Choose **Modify**\. - -1. For **Backup retention period**, choose a positive nonzero value, for example 3 days\. - -1. Choose **Continue**\. - -1. Choose **Apply immediately**\. - -1. Choose **Modify DB instance** or **Modify cluster** to save your changes and enable automated backups\. - -### AWS CLI - -To enable automated backups, use the AWS CLI [https://docs.aws.amazon.com/cli/latest/reference/rds/modify-db-instance.html](https://docs.aws.amazon.com/cli/latest/reference/rds/modify-db-instance.html) or [https://docs.aws.amazon.com/cli/latest/reference/rds/modify-db-cluster.html](https://docs.aws.amazon.com/cli/latest/reference/rds/modify-db-cluster.html) command\. - -Include the following parameters: -+ `--db-instance-identifier` \(or `--db-cluster-identifier` for a Multi\-AZ DB cluster\) -+ `--backup-retention-period` -+ `--apply-immediately` or `--no-apply-immediately` - -In the following example, we enable automated backups by setting the backup retention period to three days\. The changes are applied immediately\. - -**Example** -For Linux, macOS, or Unix: - -``` -aws rds modify-db-instance \ - --db-instance-identifier mydbinstance \ - --backup-retention-period 3 \ - --apply-immediately -``` -For Windows: - -``` -aws rds modify-db-instance ^ - --db-instance-identifier mydbinstance ^ - --backup-retention-period 3 ^ - --apply-immediately -``` - -### RDS API - -To enable automated backups, use the RDS API [https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_ModifyDBInstance.html](https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_ModifyDBInstance.html) or [https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_ModifyDBCluster.html](https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_ModifyDBCluster.html) operation with the following required parameters: -+ `DBInstanceIdentifier` or `DBClusterIdentifier` -+ `BackupRetentionPeriod` - -## Restoring an RDS for Oracle replica backup - -You can restore an Oracle replica backup just as you can restore a backup of the primary instance\. For more information, see the following: -+ [Restoring from a DB snapshot](USER_RestoreFromSnapshot.md) -+ [Restoring a DB instance to a specified time](USER_PIT.md) - -The main consideration when you restore a replica backup is determining the point in time to which you are restoring\. The database time refers to the latest applied transaction time of the data in the backup\. When you restore a replica backup, you restore to the database time, not the time when the backup completed\. The difference is significant because an RDS for Oracle replica can lag behind the primary by minutes or hours\. Thus, the database time of a replica backup, and thus the point in time to which you restore it, might be much earlier than the backup creation time\. - -To find the difference between database time and creation time, use the `describe-db-snapshots` command\. Compare the `SnapshotDatabaseTime`, which is the database time of the replica backup, and the `OriginalSnapshotCreateTime` field, which is the latest applied transaction on the primary database\. The following example shows the difference between the two times: - -``` -aws rds describe-db-snapshots \ - --db-instance-identifier my-oracle-replica - --db-snapshot-identifier my-replica-snapshot - -{ - "DBSnapshots": [ - { - "DBSnapshotIdentifier": "my-replica-snapshot", - "DBInstanceIdentifier": "my-oracle-replica", - "SnapshotDatabaseTime": "2022-07-26T17:49:44Z", - ... - "OriginalSnapshotCreateTime": "2021-07-26T19:49:44Z" - } - ] -} -``` \ No newline at end of file diff --git a/doc_source/oracle-read-replicas.changing-replica-mode.md b/doc_source/oracle-read-replicas.changing-replica-mode.md deleted file mode 100644 index 3191c87..0000000 --- a/doc_source/oracle-read-replicas.changing-replica-mode.md +++ /dev/null @@ -1,51 +0,0 @@ -# Modifying the RDS for Oracle replica mode - -To change the replica mode of an existing replica, use the console, AWS CLI, or RDS API\. When you change to mounted mode, the replica disconnects all active connections\. When you change to read\-only mode, Amazon RDS initializes Active Data Guard\. - -The change operation can take a few minutes\. During the operation, the DB instance status changes to **modifying**\. For more information about status changes, see [Viewing Amazon RDS DB instance status](accessing-monitoring.md#Overview.DBInstance.Status)\. - -## Console - -**To change the replica mode of an Oracle replica from mounted to read\-only** - -1. Sign in to the AWS Management Console and open the Amazon RDS console at [https://console\.aws\.amazon\.com/rds/](https://console.aws.amazon.com/rds/)\. - -1. In the navigation pane, choose **Databases**\. - -1. Choose the mounted replica database\. - -1. Choose **Modify**\. - -1. For **Replica mode**, choose **Read\-only**\. - -1. Choose the other settings that you want to change\. - -1. Choose **Continue**\. - -1. For **Scheduling of modifications**, choose **Apply immediately**\. - -1. Choose **Modify DB instance**\. - -## AWS CLI - -To change a read replica to mounted mode, set `--replica-mode` to `mounted` in the AWS CLI command [modify\-db\-instance](https://docs.aws.amazon.com/cli/latest/reference/rds/modify-db-instance.html)\. To change a mounted replica to read\-only mode, set `--replica-mode` to `open-read-only`\. - -**Example** -For Linux, macOS, or Unix: - -``` -aws rds modify-db-instance \ - --db-instance-identifier myreadreplica \ - --replica-mode mode -``` -For Windows: - -``` -aws rds modify-db-instance ^ - --db-instance-identifier myreadreplica ^ - --replica-mode mode -``` - -## RDS API - -To change a read\-only replica to mounted mode, set `ReplicaMode=mounted` in [ModifyDBInstance](https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_CreateDBInstanceReadReplica.html)\. To change a mounted replica to read\-only mode, set `ReplicaMode=read-only`\. \ No newline at end of file diff --git a/doc_source/oracle-read-replicas.creating-in-mounted-mode.md b/doc_source/oracle-read-replicas.creating-in-mounted-mode.md deleted file mode 100644 index d651fe6..0000000 --- a/doc_source/oracle-read-replicas.creating-in-mounted-mode.md +++ /dev/null @@ -1,59 +0,0 @@ -# Creating an RDS for Oracle replica in mounted mode - -By default, Oracle replicas are read\-only\. To create a replica in mounted mode, use the console, the AWS CLI, or the RDS API\. - -## Console - -**To create a mounted replica from a source Oracle DB instance** - -1. Sign in to the AWS Management Console and open the Amazon RDS console at [https://console\.aws\.amazon\.com/rds/](https://console.aws.amazon.com/rds/)\. - -1. In the navigation pane, choose **Databases**\. - -1. Choose the Oracle DB instance that you want to use as the source for a mounted replica\. - -1. For **Actions**, choose **Create replica**\. - -1. For **Replica mode**, choose **Mounted**\. - -1. Choose the settings that you want to use\. For **DB instance identifier**, enter a name for the read replica\. Adjust other settings as needed\. - -1. For **Regions**, choose the Region where the mounted replica will be launched\. - -1. Choose your instance size and storage type\. We recommend that you use the same DB instance class and storage type as the source DB instance for the read replica\. - -1. For **Multi\-AZ deployment**, choose **Create a standby instance** to create a standby of your replica in another Availability Zone for failover support for the mounted replica\. Creating your mounted replica as a Multi\-AZ DB instance is independent of whether the source database is a Multi\-AZ DB instance\. - -1. Choose the other settings that you want to use\. - -1. Choose **Create replica**\. - -In the **Databases** page, the mounted replica has the role Replica\. - -## AWS CLI - -To create an Oracle replica in mounted mode, set `--replica-mode` to `mounted` in the AWS CLI command [create\-db\-instance\-read\-replica](https://docs.aws.amazon.com/cli/latest/reference/rds/create-db-instance-read-replica.html)\. - -**Example** -For Linux, macOS, or Unix: - -``` -aws rds create-db-instance-read-replica \ - --db-instance-identifier myreadreplica \ - --source-db-instance-identifier mydbinstance \ - --replica-mode mounted -``` -For Windows: - -``` -aws rds create-db-instance-read-replica ^ - --db-instance-identifier myreadreplica ^ - --source-db-instance-identifier mydbinstance ^ - --replica-mode mounted -``` - -To change a read\-only replica to a mounted state, set `--replica-mode` to `mounted` in the AWS CLI command [modify\-db\-instance](https://docs.aws.amazon.com/cli/latest/reference/rds/modify-db-instance.html)\. To place a mounted replica in read\-only mode, set `--replica-mode` to `open-read-only`\. - -## RDS API - -To create an Oracle replica in mounted mode, specify `ReplicaMode=mounted` in the RDS API operation [CreateDBInstanceReadReplica](https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_CreateDBInstanceReadReplica.html)\. \ No newline at end of file diff --git a/doc_source/oracle-read-replicas.limitations.md b/doc_source/oracle-read-replicas.limitations.md deleted file mode 100644 index 88cb2fa..0000000 --- a/doc_source/oracle-read-replicas.limitations.md +++ /dev/null @@ -1,72 +0,0 @@ -# Requirements and considerations for RDS for Oracle replicas - -Before creating an Oracle replica, familiarize yourself with the following requirements and considerations\. - -**Topics** -+ [Version and licensing requirements for RDS for Oracle replicas](#oracle-read-replicas.limitations.versions-and-licenses) -+ [Option considerations for RDS for Oracle replicas](#oracle-read-replicas.limitations.options) -+ [Backup and restore considerations for RDS for Oracle replicas](#oracle-read-replicas.limitations.backups) -+ [Miscellaneous considerations for RDS for Oracle replicas](#oracle-read-replicas.limitations.miscellaneous) - -## Version and licensing requirements for RDS for Oracle replicas - -Before you create an RDS for Oracle replica, consider the following: -+ If the replica is in read\-only mode, make sure that you have an Active Data Guard license\. If you place the replica in mounted mode, you don't need an Active Data Guard license\. Only the Oracle DB engine supports mounted replicas\. -+ Oracle replicas are supported for the Oracle Enterprise Edition \(EE\) engine only\. -+ Oracle replicas are available only for instances created using version Oracle Database 12c Release 1 \(12\.1\.0\.2\.v10\) and higher 12c releases, and for non\-CDB instances of Oracle Database 19c\. Replicas of CDBs aren't supported\. -+ Oracle replicas are available for DB instances running only on DB instance classes with two or more vCPUs\. A source DB instance can't use the db\.t3\.micro or db\.t3\.small instance classes\. -+ The Oracle DB engine version of the source DB instance and all of its replicas must be the same\. Amazon RDS upgrades the replicas immediately after upgrading the source DB instance, regardless of a replica's maintenance window\. For major version upgrades of cross\-Region replicas, Amazon RDS automatically does the following: - + Generates an option group for the target version\. - + Copies all options and option settings from the original option group to the new option group\. - + Associates the upgraded cross\-Region replica with the new option group\. - - For more information about upgrading the DB engine version, see [Upgrading the RDS for Oracle DB engine](USER_UpgradeDBInstance.Oracle.md)\. - -## Option considerations for RDS for Oracle replicas - -Before you create an RDS for Oracle replica, consider the following: -+ If your Oracle replica is in the same AWS Region as its source DB instance, make sure that it belongs to the same option group as the source DB instance\. Modifications to the source option group or source option group membership propagate to replicas\. These changes are applied to the replicas immediately after they are applied to the source DB instance, regardless of the replica's maintenance window\. - - For more information about option groups, see [Working with option groups](USER_WorkingWithOptionGroups.md)\. -+ When you create an Oracle cross\-Region replica, Amazon RDS creates a dedicated option group for it\. - - You can't remove an Oracle cross\-Region replica from its dedicated option group\. No other DB instances can use the dedicated option group for an Oracle cross\-Region replica\. - - You can only add or remove the following nonreplicated options from a dedicated option group: - + `NATIVE_NETWORK_ENCRYPTION` - + `OEM` - + `OEM_AGENT` - + `SSL` - - To add other options to an Oracle cross\-Region replica, add them to the source DB instance's option group\. The option is also installed on all of the source DB instance's replicas\. For licensed options, make sure that there are sufficient licenses for the replicas\. - - When you promote an Oracle cross\-Region replica, the promoted replica behaves the same as other Oracle DB instances, including the management of its options\. You can promote a replica explicitly or implicitly by deleting its source DB instance\. - - For more information about option groups, see [Working with option groups](USER_WorkingWithOptionGroups.md)\. - -## Backup and restore considerations for RDS for Oracle replicas - -Before you create an RDS for Oracle replica, consider the following: -+ To create snapshots of RDS for Oracle replicas or turn on automatic backups, make sure to set the backup retention period manually\. Automatic backups aren't turned on by default\. -+ The database time refers to the latest applied transaction time of the data in the backup\. When you restore a replica backup, you restore to the database time, not the time that the backup was taken\. The difference is significant because a replica can lag behind the primary for minutes or hours\. - - To find the difference, use the `describe-db-snapshots` command\. Compare the `snapshotDatabaseTime`, which is the database time of the replica backup, and the `OriginalSnapshotCreateTime` field, which is the latest applied transaction on the primary database\. - -## Miscellaneous considerations for RDS for Oracle replicas - -Before you create an RDS for Oracle replica, consider the following: -+ If a DB instance is a source for one or more cross\-Region replicas, the source DB retains its archived redo logs until they are applied on all cross\-Region replicas\. The archived redo logs might result in increased storage consumption\. -+ RDS for Oracle CDBs don't support Oracle Data Guard\. For more information, see [Limitations of a single\-tenant CDB](Oracle.Concepts.limitations.md#Oracle.Concepts.single-tenant-limitations)\. -+ A logon trigger on a primary instance must permit access to the `RDS_DATAGUARD` user and to any user whose `AUTHENTICATED_IDENTITY` value is `RDS_DATAGUARD` or `rdsdb`\. Also, the trigger must not set the current schema for the `RDS_DATAGUARD` user\. -+ To avoid disrupting RDS automation, system triggers must permit specific users to log on to the primary and replica database\. [System triggers](https://docs.oracle.com/en/database/oracle/oracle-database/19/lnpls/plsql-triggers.html#GUID-FE23FCE8-DE36-41EF-80A9-6B4B49E80E5B) include DDL, logon, and database role triggers\. We recommend that you add code to your triggers to exclude the users listed in the following sample code: - - ``` - -- Determine who the user is - SELECT SYS_CONTEXT('USERENV','AUTHENTICATED_IDENTITY') INTO CURRENT_USER FROM DUAL; - -- The following users should always be able to login to either the Primary or Replica - IF CURRENT_USER IN ('master_user', 'SYS', 'SYSTEM', 'RDS_DATAGUARD', 'rdsdb') THEN - RETURN; - END IF; - ``` -+ To avoid blocking connections from the Data Guard broker process, don't enable restricted sessions\. For more information about restricted sessions, see [Enabling and disabling restricted sessions](Appendix.Oracle.CommonDBATasks.System.md#Appendix.Oracle.CommonDBATasks.RestrictedSession)\. -+ Block change tracking is supported for read\-only replicas, but not for mounted replicas\. You can change a mounted replica to a read\-only replica, and then enable block change tracking\. For more information, see [Enabling and disabling block change tracking](Appendix.Oracle.CommonDBATasks.RMAN.md#Appendix.Oracle.CommonDBATasks.BlockChangeTracking)\. \ No newline at end of file diff --git a/doc_source/oracle-read-replicas.md b/doc_source/oracle-read-replicas.md deleted file mode 100644 index 35ed4b5..0000000 --- a/doc_source/oracle-read-replicas.md +++ /dev/null @@ -1,13 +0,0 @@ -# Working with read replicas for Amazon RDS for Oracle - -To configure replication between Oracle DB instances, you can create replica databases\. For an overview of Amazon RDS read replicas, see [Overview of Amazon RDS read replicasOverview](USER_ReadRepl.md#USER_ReadRepl.Overview)\. For a summary of the differences between Oracle replicas and other DB engines, see [Differences among read replicas for DB engines](USER_ReadRepl.md#USER_ReadRepl.Overview.Differences)\. - -**Topics** -+ [Overview of RDS for Oracle replicas](oracle-read-replicas.overview.md) -+ [Requirements and considerations for RDS for Oracle replicas](oracle-read-replicas.limitations.md) -+ [Preparing to create an Oracle replica](oracle-read-replicas.Configuration.md) -+ [Creating an RDS for Oracle replica in mounted mode](oracle-read-replicas.creating-in-mounted-mode.md) -+ [Modifying the RDS for Oracle replica mode](oracle-read-replicas.changing-replica-mode.md) -+ [Working with RDS for Oracle replica backups](oracle-read-replicas.backups.md) -+ [Performing an Oracle Data Guard switchover](oracle-replication-switchover.md) -+ [Troubleshooting RDS for Oracle replicas](oracle-read-replicas.troubleshooting.md) \ No newline at end of file diff --git a/doc_source/oracle-read-replicas.overview.md b/doc_source/oracle-read-replicas.overview.md deleted file mode 100644 index cacfef5..0000000 --- a/doc_source/oracle-read-replicas.overview.md +++ /dev/null @@ -1,40 +0,0 @@ -# Overview of RDS for Oracle replicas - -An *Oracle replica* database is a physical copy of your primary database\. An Oracle replica in read\-only mode is called a *read replica*\. An Oracle replica in mounted mode is called a *mounted replica*\. Oracle Database doesn't permit writes in a replica, but you can promote a replica to make it writable\. The promoted read replica has the replicated data to the point when the request was made to promote it\. - -The following video provides a helpful overview of RDS for Oracle disaster recovery\. - -[![AWS Videos](http://img.youtube.com/vi/-XpzhIevwVg/0.jpg)](http://www.youtube.com/watch?v=-XpzhIevwVg) - -For more information, see the blog post [Managed disaster recovery with Amazon RDS for Oracle cross\-Region automated backups \- Part 1](http://aws.amazon.com/blogs/database/managed-disaster-recovery-with-amazon-rds-for-oracle-cross-region-automated-backups-part-1/) and [Managed disaster recovery with Amazon RDS for Oracle cross\-Region automated backups \- Part 2](http://aws.amazon.com/blogs/database/part-2-managed-disaster-recovery-with-amazon-rds-for-oracle-xrab/)\. - -**Topics** -+ [Read\-only and mounted replicas](#oracle-read-replicas.overview.modes) -+ [Archived redo log retention](#oracle-read-replicas.overview.log-retention) -+ [Outages during replication](#oracle-read-replicas.overview.outages) - -## Read\-only and mounted replicas - -When creating or modifying an Oracle replica, you can place it in either of the following modes: - -Read\-only -This is the default\. Active Data Guard transmits and applies changes from the source database to all read replica databases\. -You can create up to five read replicas from one source DB instance\. For general information about read replicas that applies to all DB engines, see [Working with DB instance read replicas](USER_ReadRepl.md)\. For information about Oracle Data Guard, see [Oracle Data Guard concepts and administration](https://docs.oracle.com/en/database/oracle/oracle-database/19/sbydb/oracle-data-guard-concepts.html#GUID-F78703FB-BD74-4F20-9971-8B37ACC40A65) in the Oracle documentation\. - -Mounted -In this case, replication uses Oracle Data Guard, but the replica database doesn't accept user connections\. The primary use for mounted replicas is cross\-Region disaster recovery\. -A mounted replica can't serve a read\-only workload\. The mounted replica deletes archived redo log files after it applies them, regardless of the archived log retention policy\. - -You can create a combination of mounted and read\-only DB replicas for the same source DB instance\. You can change a read\-only replica to mounted mode, or change a mounted replica to read\-only mode\. In either case, the Oracle database preserves the archived log retention setting\. - -## Archived redo log retention - -If a primary DB instance has no cross\-Region read replicas, Amazon RDS for Oracle keeps a minimum of two hours of archived redo logs on the source DB instance\. This is true regardless of the setting for `archivelog retention hours` in `rdsadmin.rdsadmin_util.set_configuration`\. - -RDS purges logs from the source DB instance after two hours or after the archive log retention hours setting has passed, whichever is longer\. RDS purges logs from the read replica after the archive log retention hours setting has passed only if they have been successfully applied to the database\. - -In some cases, a primary DB instance might have one or more cross\-Region read replicas\. If so, Amazon RDS for Oracle keeps the transaction logs on the source DB instance until they have been transmitted and applied to all cross\-Region read replicas\. For information about `rdsadmin.rdsadmin_util.set_configuration`, see [Retaining archived redo logs](Appendix.Oracle.CommonDBATasks.Log.md#Appendix.Oracle.CommonDBATasks.RetainRedoLogs)\. - -## Outages during replication - -When you create an Oracle replica, no outage occurs for the source DB instance\. Amazon RDS takes a snapshot of the source DB instance\. This snapshot becomes the replica\. Amazon RDS sets the necessary parameters and permissions for the source DB and replica without service interruption\. Similarly, if you delete a replica, no outage occurs\. \ No newline at end of file diff --git a/doc_source/oracle-read-replicas.troubleshooting.md b/doc_source/oracle-read-replicas.troubleshooting.md deleted file mode 100644 index f6a0019..0000000 --- a/doc_source/oracle-read-replicas.troubleshooting.md +++ /dev/null @@ -1,31 +0,0 @@ -# Troubleshooting RDS for Oracle replicas - -This section describes possible replication problems and solutions\. - -**Topics** -+ [Monitoring Oracle replication lag](#oracle-read-replicas.troubleshooting.lag) -+ [Troubleshooting Oracle replication failure after adding or modifying triggers](#oracle-read-replicas.troubleshooting.triggers) - -## Monitoring Oracle replication lag - -To monitor replication lag in Amazon CloudWatch, view the Amazon RDS `ReplicaLag` metric\. For more information about replication lag time, see [Monitoring read replication](USER_ReadRepl.md#USER_ReadRepl.Monitoring) and [Amazon CloudWatch metrics for Amazon RDS](rds-metrics.md)\. - -For a read replica, if the lag time is too long, query the following views: -+ `V$ARCHIVED_LOG` – Shows which commits have been applied to the read replica\. -+ `V$DATAGUARD_STATS` – Shows a detailed breakdown of the components that make up the `ReplicaLag` metric\. -+ `V$DATAGUARD_STATUS` – Shows the log output from Oracle's internal replication processes\. - -For a mounted replica, if the lag time is too long, you can't query the `V$` views\. Instead, do the following: -+ Check the `ReplicaLag` metric in CloudWatch\. -+ Check the alert log file for the replica in the console\. Look for errors in the recovery messages\. The messages include the log sequence number, which you can compare to the primary sequence number\. For more information, see [Oracle database log files](USER_LogAccess.Concepts.Oracle.md)\. - -## Troubleshooting Oracle replication failure after adding or modifying triggers - -If you add or modify any triggers, and if replication fails afterward, the problem may be the triggers\. Ensure that the trigger excludes the following user accounts, which are required by RDS for replication: -+ User accounts with administrator privileges -+ `SYS` -+ `SYSTEM` -+ `RDS_DATAGUARD` -+ `rdsdb` - -For more information, see [Miscellaneous considerations for RDS for Oracle replicas](oracle-read-replicas.limitations.md#oracle-read-replicas.limitations.miscellaneous)\. \ No newline at end of file diff --git a/doc_source/oracle-replication-switchover.md b/doc_source/oracle-replication-switchover.md deleted file mode 100644 index 94aa9eb..0000000 --- a/doc_source/oracle-replication-switchover.md +++ /dev/null @@ -1,203 +0,0 @@ -# Performing an Oracle Data Guard switchover - -In an Oracle Data Guard environment, a primary database supports one or more standby databases\. You can perform a managed, switchover\-based role transition from a primary database to a standby database\. - -**Topics** -+ [Overview of Oracle Data Guard switchover](#oracle-replication-switchover.overview) -+ [Preparing for the Oracle Data Guard switchover](#oracle-switchover.preparing) -+ [Initiating the Oracle Data Guard switchover](#oracle-switchover.initiating) -+ [Monitoring the Oracle Data Guard switchover](#oracle-switchover.monitoring) - -## Overview of Oracle Data Guard switchover - -A *switchover* is a role reversal between a primary database and a standby database\. During a switchover, the original primary database transitions to a standby role, while the original standby database transitions to the primary role\. - -![\[Switch over a standby instance to make it the primary instance\]](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/images/read-replica-switchover.png) - -Amazon RDS supports a fully managed, switchover\-based role transition for Oracle Database replicas\. The replicas can reside in separate AWS Regions or in different Availability Zones \(AZs\) of a single Region\. You can only initiate a switchover to a standby database that is mounted or open read\-only\. - -**Topics** -+ [Benefits of Oracle Data Guard switchover](#oracle-replication-switchover.overview.benefits) -+ [Supported Oracle Database versions](#oracle-replication-switchover.overview.engine-support) -+ [AWS Region support](#oracle-replication-switchover.overview.Region) -+ [Cost of Oracle Data Guard switchover](#oracle-replication-switchover.overview.cost) -+ [How Oracle Data Guard switchover works](#oracle-replication-switchover.overview.how-it-works) - -### Benefits of Oracle Data Guard switchover - -Just as for RDS for Oracle read replicas, a managed switchover relies on Oracle Data Guard\. The operation is designed to have zero data loss\. Amazon RDS automates the following aspects of the switchover: -+ Reverses the roles of your primary database and specified standby database, putting the new standby database in the same state \(mounted or read\-only\) as the original standby -+ Ensures data consistency -+ Maintains your replication configuration after the transition -+ Supports repeated reversals, allowing your new standby database to return to its original primary role - -### Supported Oracle Database versions - -Oracle Data Guard switchover is supported for the following releases: -+ Oracle Database 19c -+ Oracle Database 12c Release 2 \(12\.2\) -+ Oracle Database 12c Release 1 \(12\.1\) using PSU 12\.1\.0\.2\.v10 or higher - -### AWS Region support - -Oracle Data Guard switchover is available in the following AWS Regions: -+ Asia Pacific \(Mumbai\) -+ Asia Pacific \(Osaka\) -+ Asia Pacific \(Seoul\) -+ Asia Pacific \(Singapore\) -+ Asia Pacific \(Sydney\) -+ Asia Pacific \(Tokyo\) -+ Canada \(Central\) -+ Europe \(Frankfurt\) -+ Europe \(Ireland\) -+ Europe \(London\) -+ Europe \(Paris\) -+ Europe \(Stockholm\) -+ South America \(São Paulo\) -+ US East \(N\. Virginia\) -+ US East \(Ohio\) -+ US West \(N\. California\) -+ US West \(Oregon\) -+ AWS GovCloud \(US\-East\) -+ AWS GovCloud \(US\-West\) - -### Cost of Oracle Data Guard switchover - -The Oracle Data Guard switchover feature doesn't incur additional costs\. Oracle Database Enterprise Edition includes support for standby databases in mounted mode\. To open standby databases in read\-only mode, you need the Oracle Active Data Guard option\. - -### How Oracle Data Guard switchover works - -Oracle Data Guard switchover is a fully managed operation\. You initiate the switchover for a standby database by issuing the CLI command `switchover-read-replica`\. Then Amazon RDS modifies the primary and standby roles in your replication configuration\. - -The *original standby* and *original primary* are the roles that exist before the switchover\. The *new standby* and *new primary* are the roles that exist after the switchover\. A *bystander replica* is a replica database that serves as a standby database in the Oracle Data Guard environment but is not switching roles\. - -**Topics** -+ [Stages of the Oracle Data Guard switchover](#oracle-replication-switchover.overview.how-it-works.during-switchover) -+ [After the Oracle Data Guard switchover](#oracle-replication-switchover.overview.how-it-works.after-switchover) - -#### Stages of the Oracle Data Guard switchover - -To perform the switchover, Amazon RDS must take the following steps: - -1. Block new transactions on the original primary database\. During the switchover, Amazon RDS interrupts replication for all databases in your Oracle Data Guard configuration\. During the switchover, the original primary database can't process write requests\. - -1. Ship unapplied transactions to the original standby database, and apply them\. - -1. Restart the new standby database in read\-only or mounted mode\. The mode depends on the open state of the original standby database before the switchover\. - -1. Open the new primary database in read/write mode\. - -#### After the Oracle Data Guard switchover - -Amazon RDS switches the roles of the primary and standby database\. You are responsible for reconnecting your application and performing any other desired configuration\. - -**Topics** -+ [Success criteria](#oracle-replication-switchover.overview.how-it-works.after-switchover.success) -+ [Connection to the new primary database](#oracle-replication-switchover.overview.how-it-works.after-switchover.connection) -+ [Configuration of the new primary database](#oracle-replication-switchover.overview.how-it-works.after-switchover.success.configuration) - -##### Success criteria - -The Oracle Data Guard switchover is successful when the original standby database does the following: -+ Transitions to its role as new primary database -+ Completes its reconfiguration - -To limit downtime, your new primary database becomes active as soon as possible\. Because Amazon RDS configures bystander replicas asynchronously, these replicas might become active after the original primary database\. - -##### Connection to the new primary database - -Amazon RDS won't propagate your current database connections to the new primary database after the switchover\. After the Oracle Data Guard switchover completes, reconnect your application to the new primary database\. - -##### Configuration of the new primary database - -To perform a switchover to the new primary database, Amazon RDS changes the mode of the original standby database to open\. The change in role is the only change to the database\. Amazon RDS doesn't set up features such as Multi\-AZ replication\. - -If you perform a switchover to a cross\-Region replica with different options, the new primary database keeps its own options\. Amazon RDS won't migrate the options on the original primary database\. If the original primary database had options such as SSL, NNE, OEM, and OEM\_AGENT, Amazon RDS doesn't propagate them to the new primary database\. - -## Preparing for the Oracle Data Guard switchover - -Before initiating the Oracle Data Guard switchover, make sure that your replication environment meets the following requirements: -+ The original standby database is mounted or open read\-only\. -+ Automatic backups are enabled on the original standby database\. -+ The original primary database and the original standby database are in an available state\. -+ The original primary database and the original standby database have no pending maintenance actions\. -+ The original standby database is in the replicating state\. -+ You aren't attempting to initiate a switchover when either the primary database or standby database is currently in a switchover lifecycle\. If a replica database is reconfiguring after a switchover, Amazon RDS prevents you from initiating another switchover\. -**Note** -A *bystander replica* is a replica in the Oracle Data Guard configuration that isn't the target of the switchover\. Bystander replicas can be in any state during the switchover\. -+ The original standby database has a configuration that is as close as desired to the original primary database\. Assume a scenario where the original primary and original standby databases have different options\. After the switchover completes, Amazon RDS doesn't automatically reconfigure the new primary database to have the same options as the original primary database\. -+ You configure your desired Multi\-AZ deployment before initiating a switchover\. Amazon RDS doesn't manage Multi\-AZ as part of the switchover\. The Multi\-AZ deployment remains as it is\. - - Assume that db\_maz is the primary database in a Multi\-AZ deployment, and db\_saz is a Single\-AZ replica\. You initiate a switchover from db\_maz to db\_saz\. Afterward, db\_maz is a Multi\-AZ replica database, and db\_saz is a Single\-AZ primary database\. The new primary database is now unprotected by a Multi\-AZ deployment\. -+ In preparation for a cross\-Region switchover, the primary database doesn't use the same option group as a DB instance outside of the replication configuration\. For a cross\-Region switchover to succeed, the current primary database and its read replicas must be the only DB instances to use the option group of the current primary database\. Otherwise, Amazon RDS prevents the switchover\. - -## Initiating the Oracle Data Guard switchover - -You can switch over an RDS for Oracle read replica to the primary role, and the former primary DB instance to a replica role\. - -### Console - -**To switch over an Oracle read replica to the primary DB role** - -1. Sign in to the AWS Management Console and open the Amazon RDS console at [https://console\.aws\.amazon\.com/rds/](https://console.aws.amazon.com/rds/)\. - -1. In the Amazon RDS console, choose **Databases**\. - - The **Databases** pane appears\. Each read replica shows **Replica** in the **Role** column\. - -1. Choose the read replica that you want to switch over to the primary role\. - -1. For **Actions**, choose **Switch over replica**\. - -1. Choose **I acknowledge**\. Then choose **Switch over replica**\. - -1. On the **Databases** page, monitor the progress of the switchover\. -![\[Monitor the progress of the Oracle Data Guard switchover.\]](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/images/oracle-switchover-progress.png) - - When the switchover completes, the role of the switchover target changes from **Replica** to **Source**\. -![\[The source and replica databases change roles.\]](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/images/oracle-switchover-complete.png) - -### AWS CLI - -To switch over an Oracle replica to the primary DB role, use the AWS CLI [https://docs.aws.amazon.com/cli/latest/reference/rds/switchover-read-replica.html](https://docs.aws.amazon.com/cli/latest/reference/rds/switchover-read-replica.html) command\. The following examples make the Oracle replica named *replica\-to\-be\-made\-primary* into the new primary database\. - -**Example** -For Linux, macOS, or Unix: - -``` -aws rds switchover-read-replica \ - --db-instance-identifier replica-to-be-made-primary -``` -For Windows: - -``` -aws rds switchover-read-replica ^ - --db-instance-identifier replica-to-be-made-primary -``` - -### RDS API - -To switch over an Oracle replica to the primary DB role, call the Amazon RDS API [https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_SwitchoverReadReplica.html](https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_SwitchoverReadReplica.html) operation with the required parameter `DBInstanceIdentifier`\. This parameter specifies the name of the Oracle replica that you want to assume the primary DB role\. - -## Monitoring the Oracle Data Guard switchover - -To check the status of your instances, use the AWS CLI command `describe-db-instances`\. The following command checks the status of the DB instance *orcl2*\. This database was a standby database before the switchover, but is the new primary database after the switchover\. - -``` -aws rds describe-db-instances \ - --db-instance-identifier orcl2 -``` - -To confirm that the switchover completed successfully, query `V$DATABASE.OPEN_MODE`\. Check that the value for the new primary database is `READ WRITE`\. - -``` -SELECT OPEN_MODE FROM V$DATABASE; -``` - -To look for switchover\-related events, use the AWS CLI command `describe-events`\. The following example looks for events on the *orcl2* instance\. - -``` -aws rds describe-events \ - --source-identifier orcl2 \ - --source-type db-instance -``` \ No newline at end of file diff --git a/doc_source/oracle-s3-integration.md b/doc_source/oracle-s3-integration.md deleted file mode 100644 index 1c2f883..0000000 --- a/doc_source/oracle-s3-integration.md +++ /dev/null @@ -1,738 +0,0 @@ -# Amazon S3 integration - -You can transfer files between your RDS for Oracle DB instance and an Amazon S3 bucket\. You can use Amazon S3 integration with Oracle Database features such as Oracle Data Pump\. For example, you can download Data Pump files from Amazon S3 to your RDS for Oracle DB instance\. For more information, see [Importing data into Oracle on Amazon RDS](Oracle.Procedural.Importing.md)\. - -**Note** -Your DB instance and your Amazon S3 bucket must be in the same AWS Region\. - -**Topics** -+ [Configuring IAM permissions for RDS for Oracle integration with Amazon S3](#oracle-s3-integration.preparing) -+ [Adding the Amazon S3 integration option](#oracle-s3-integration.preparing.option-group) -+ [Transferring files between Amazon RDS for Oracle and an Amazon S3 bucket](#oracle-s3-integration.using) -+ [Troubleshooting Amazon S3 integration](#oracle-s3-integration.troubleshooting) -+ [Removing the Amazon S3 integration option](#oracle-s3-integration.removing) - -## Configuring IAM permissions for RDS for Oracle integration with Amazon S3 - -For RDS for Oracle to integrate with Amazon S3, your DB instance must have access to an Amazon S3 bucket\. The Amazon VPC used by your DB instance doesn't need to provide access to the Amazon S3 endpoints\. - -RDS for Oracle supports uploading files from a DB instance in one account to an Amazon S3 bucket in a different account\. Where additional steps are required, they are noted in the following sections\. - -**Topics** -+ [Step 1: Create an IAM policy for your Amazon RDS role](#oracle-s3-integration.preparing.policy) -+ [Step 2: \(Optional\) Create an IAM policy for your Amazon S3 bucket](#oracle-s3-integration.preparing.policy-bucket) -+ [Step 3: Create an IAM role for your DB instance and attach your policy](#oracle-s3-integration.preparing.role) -+ [Step 4: Associate your IAM role with your RDS for Oracle DB instance](#oracle-s3-integration.preparing.instance) - -### Step 1: Create an IAM policy for your Amazon RDS role - -In this step, you create an AWS Identity and Access Management \(IAM\) policy with the permissions required to transfer files from your Amazon S3 bucket to your RDS DB instance\. This step assumes that you have already created an S3 bucket\. - -Before you create the policy, note the following pieces of information: -+ The Amazon Resource Name \(ARN\) for your bucket -+ The ARN for your AWS KMS key, if your bucket uses SSE\-KMS or SSE\-S3 encryption -**Note** -An RDS for Oracle DB instance can't access Amazon S3 buckets encrypted with SSE\-C\. - -For more information, see [Protecting data using server\-side encryption](https://docs.aws.amazon.com/AmazonS3/latest/userguide/serv-side-encryption.html) in the *Amazon Simple Storage Service User Guide*\. - -#### Console - -**To create an IAM policy to allow Amazon RDS to access your Amazon S3 bucket** - -1. Open the [IAM Management Console](https://console.aws.amazon.com/iam/home?#home)\. - -1. Under **Access management**, choose **Policies**\. - -1. Choose **Create Policy**\. - -1. On the **Visual editor** tab, choose **Choose a service**, and then choose **S3**\. - -1. For **Actions**, choose **Expand all**, and then choose the bucket permissions and object permissions required to transfer files from an Amazon S3 bucket to Amazon RDS\. For example, do the following: - + Expand **List**, and then select **ListBucket**\. - + Expand **Read**, and then select **GetObject**\. - + Expand **Write**, and then select **PutObject** and **DeleteObject**\. - + Expand **Permissions management**, and then select **PutObjectAcl**\. This permission is necessary if you plan to upload files to a bucket owned by a different account, and this account needs full control of the bucket contents\. - - *Object permissions* are permissions for object operations in Amazon S3\. You must grant them for objects in a bucket, not the bucket itself\. For more information, see [Permissions for object operations](https://docs.aws.amazon.com/AmazonS3/latest/dev/using-with-s3-actions.html#using-with-s3-actions-related-to-objects)\. - -1. Choose **Resources**, and then do the following: - - 1. Choose **Specific**\. - - 1. For **bucket**, choose **Add ARN**\. Enter your bucket ARN\. The bucket name is filled in automatically\. Then choose **Add**\. - - 1. If the **object** resource is shown, either choose **Add ARN** to add resources manually or choose **Any**\. -**Note** -You can set **Amazon Resource Name \(ARN\)** to a more specific ARN value to allow Amazon RDS to access only specific files or folders in an Amazon S3 bucket\. For more information about how to define an access policy for Amazon S3, see [Managing access permissions to your Amazon S3 resources](https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-access-control.html)\. - -1. \(Optional\) Choose **Add additional permissions** to add resources to the policy\. For example, do the following: - - 1. If your bucket is encrypted with a custom KMS key, select **KMS** for the service\. - - 1. For **Manual actions**, select the following: - + **Encrypt** - + **ReEncrypt from** and **ReEncrypt to** - + **Decrypt** - + **DescribeKey** - + **GenerateDataKey** - - 1. For **Resources**, choose **Specific**\. - - 1. For **key**, choose **Add ARN**\. Enter the ARN of your custom key as the resource, and then choose **Add**\. - - For more information, see [Protecting Data Using Server\-Side Encryption with KMS keys Stored in AWS Key Management Service \(SSE\-KMS\)](https://docs.aws.amazon.com/AmazonS3/latest/userguide/UsingKMSEncryption.html) in the *Amazon Simple Storage Service User Guide*\. - - 1. If you want Amazon RDS to access to access other buckets, add the ARNs for these buckets\. Optionally, you can also grant access to all buckets and objects in Amazon S3\. - -1. Choose **Next: Tags** and then **Next: Review**\. - -1. For **Name**, enter a name for your IAM policy, for example `rds-s3-integration-policy`\. You use this name when you create an IAM role to associate with your DB instance\. You can also add an optional **Description** value\. - -1. Choose **Create policy**\. - -#### AWS CLI - -Create an AWS Identity and Access Management \(IAM\) policy that grants Amazon RDS access to an Amazon S3 bucket\. After you create the policy, note the ARN of the policy\. You need the ARN for a subsequent step\. - -Include the appropriate actions in the policy based on the type of access required: -+ `GetObject` – Required to transfer files from an Amazon S3 bucket to Amazon RDS\. -+ `ListBucket` – Required to transfer files from an Amazon S3 bucket to Amazon RDS\. -+ `PutObject` – Required to transfer files from Amazon RDS to an Amazon S3 bucket\. - -The following AWS CLI command creates an IAM policy named `rds-s3-integration-policy` with these options\. It grants access to a bucket named `your-s3-bucket-arn`\. - -**Example** -For Linux, macOS, or Unix: - -``` -aws iam create-policy \ - --policy-name rds-s3-integration-policy \ - --policy-document '{ - "Version": "2012-10-17", - "Statement": [ - { - "Sid": "s3integration", - "Action": [ - "s3:GetObject", - "s3:ListBucket", - "s3:PutObject" - ], - "Effect": "Allow", - "Resource": [ - "arn:aws:s3:::your-s3-bucket-arn", - "arn:aws:s3:::your-s3-bucket-arn/*" - ] - } - ] - }' -``` -The following example includes permissions for custom KMS keys\. - -``` -aws iam create-policy \ - --policy-name rds-s3-integration-policy \ - --policy-document '{ - "Version": "2012-10-17", - "Statement": [ - { - "Sid": "s3integration", - "Action": [ - "s3:GetObject", - "s3:ListBucket", - "s3:PutObject", - "kms:Decrypt", - "kms:Encrypt", - "kms:ReEncrypt", - "kms:GenerateDataKey", - "kms:DescribeKey", - ], - "Effect": "Allow", - "Resource": [ - "arn:aws:s3:::your-s3-bucket-arn", - "arn:aws:s3:::your-s3-bucket-arn/*", - "arn:aws:kms:::your-kms-arn" - ] - } - ] - }' -``` -For Windows: - -``` -aws iam create-policy ^ - --policy-name rds-s3-integration-policy ^ - --policy-document '{ - "Version": "2012-10-17", - "Statement": [ - { - "Sid": "s3integration", - "Action": [ - "s3:GetObject", - "s3:ListBucket", - "s3:PutObject" - ], - "Effect": "Allow", - "Resource": [ - "arn:aws:s3:::your-s3-bucket-arn", - "arn:aws:s3:::your-s3-bucket-arn/*" - ] - } - ] - }' -``` -The following example includes permissions for custom KMS keys\. - -``` -aws iam create-policy ^ - --policy-name rds-s3-integration-policy ^ - --policy-document '{ - "Version": "2012-10-17", - "Statement": [ - { - "Sid": "s3integration", - "Action": [ - "s3:GetObject", - "s3:ListBucket", - "s3:PutObject", - "kms:Decrypt", - "kms:Encrypt", - "kms:ReEncrypt", - "kms:GenerateDataKey", - "kms:DescribeKey", - ], - "Effect": "Allow", - "Resource": [ - "arn:aws:s3:::your-s3-bucket-arn", - "arn:aws:s3:::your-s3-bucket-arn/*", - "arn:aws:kms:::your-kms-arn" - ] - } - ] - }' -``` - -### Step 2: \(Optional\) Create an IAM policy for your Amazon S3 bucket - -This step is necessary only in the following conditions: -+ You plan to upload files to an Amazon S3 bucket from one account \(account A\) and access them from a different account \(account B\)\. -+ Account B owns the bucket\. -+ Account B needs full control of objects loaded into the bucket\. - -If the preceding conditions don't apply to you, skip to [Step 3: Create an IAM role for your DB instance and attach your policy](#oracle-s3-integration.preparing.role)\. - -To create your bucket policy, make sure you have the following: -+ The account ID for account A -+ The user name for account A -+ The ARN value for the Amazon S3 bucket in account B - -#### Console - -**To create or edit a bucket policy** - -1. Sign in to the AWS Management Console and open the Amazon S3 console at [https://console\.aws\.amazon\.com/s3/](https://console.aws.amazon.com/s3/)\. - -1. In the **Buckets** list, choose the name of the bucket that you want to create a bucket policy for or whose bucket policy you want to edit\. - -1. Choose **Permissions**\. - -1. Under **Bucket policy**, choose **Edit**\. This opens the Edit bucket policy page\. - -1. On the **Edit bucket policy **page, explore **Policy examples** in the *Amazon S3 User Guide*, choose **Policy generator** to generate a policy automatically, or edit the JSON in the **Policy** section\. - - If you choose **Policy generator**, the AWS Policy Generator opens in a new window: - - 1. On the **AWS Policy Generator** page, in **Select Type of Policy**, choose **S3 Bucket Policy**\. - - 1. Add a statement by entering the information in the provided fields, and then choose **Add Statement**\. Repeat for as many statements as you would like to add\. For more information about these fields, see the [IAM JSON policy elements reference](https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies_elements.html) in the *IAM User Guide*\. -**Note** -For convenience, the **Edit bucket policy** page displays the **Bucket ARN **\(Amazon Resource Name\) of the current bucket above the **Policy** text field\. You can copy this ARN for use in the statements on the **AWS Policy Generator** page\. - - 1. After you finish adding statements, choose **Generate Policy**\. - - 1. Copy the generated policy text, choose **Close**, and return to the **Edit bucket policy** page in the Amazon S3 console\. - -1. In the **Policy** box, edit the existing policy or paste the bucket policy from the Policy generator\. Make sure to resolve security warnings, errors, general warnings, and suggestions before you save your policy\. - - ``` - { - "Version": "2012-10-17", - "Statement": [ - { - "Sid": "Example permissions", - "Effect": "Allow", - "Principal": { - "AWS": "arn:aws:iam::account-A-ID:account-A-user" - }, - "Action": [ - "s3:PutObject", - "s3:PutObjectAcl" - ], - "Resource": [ - "arn:aws:s3:::account-B-bucket-arn", - "arn:aws:s3:::account-B-bucket-arn/*" - ] - } - ] - } - ``` - -1. Choose **Save changes**, which returns you to the Bucket Permissions page\. - -### Step 3: Create an IAM role for your DB instance and attach your policy - -This step assumes that you have created the IAM policy in [Step 1: Create an IAM policy for your Amazon RDS role](#oracle-s3-integration.preparing.policy)\. In this step, you create a role for your RDS for Oracle DB instance and then attach your policy to the role\. - -#### Console - -**To create an IAM role to allow Amazon RDS to access an Amazon S3 bucket** - -1. Open the [IAM Management Console](https://console.aws.amazon.com/iam/home?#home)\. - -1. In the navigation pane, choose **Roles**\. - -1. Choose **Create role**\. - -1. Choose **AWS service**\. - -1. For **Use cases for other AWS services:**, choose **RDS** and then **RDS – Add Role to Database**\. Then choose **Next**\. - -1. For **Search** under **Permissions policies**, enter the name of the IAM policy you created in [Step 1: Create an IAM policy for your Amazon RDS role](#oracle-s3-integration.preparing.policy), and select the policy when it appears in the list\. Then choose **Next**\. - -1. For **Role name**, enter a name for your IAM role, for example, `rds-s3-integration-role`\. You can also add an optional **Description** value\. - -1. Choose **Create role**\. - -#### AWS CLI - -**To create a role and attach your policy to it** - -1. Create an IAM role that Amazon RDS can assume on your behalf to access your Amazon S3 buckets\. - - We recommend using the [https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies_condition-keys.html#condition-keys-sourcearn](https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies_condition-keys.html#condition-keys-sourcearn) and [https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies_condition-keys.html#condition-keys-sourceaccount](https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies_condition-keys.html#condition-keys-sourceaccount) global condition context keys in resource\-based trust relationships to limit the service's permissions to a specific resource\. This is the most effective way to protect against the [confused deputy problem](https://docs.aws.amazon.com/IAM/latest/UserGuide/confused-deputy.html)\. - - You might use both global condition context keys and have the `aws:SourceArn` value contain the account ID\. In this case, the `aws:SourceAccount` value and the account in the `aws:SourceArn` value must use the same account ID when used in the same statement\. - + Use `aws:SourceArn` if you want cross\-service access for a single resource\. - + Use `aws:SourceAccount` if you want to allow any resource in that account to be associated with the cross\-service use\. - - In the trust relationship, make sure to use the `aws:SourceArn` global condition context key with the full Amazon Resource Name \(ARN\) of the resources accessing the role\. - - The following AWS CLI command creates the role named `rds-s3-integration-role` for this purpose\. -**Example** - - For Linux, macOS, or Unix: - - ``` - aws iam create-role \ - --role-name rds-s3-integration-role \ - --assume-role-policy-document '{ - "Version": "2012-10-17", - "Statement": [ - { - "Effect": "Allow", - "Principal": { - "Service": "rds.amazonaws.com" - }, - "Action": "sts:AssumeRole", - "Condition": { - "StringEquals": { - "aws:SourceAccount": my_account_ID, - "aws:SourceArn": "arn:aws:rds:Region:my_account_ID:db:dbname" - } - } - } - ] - }' - ``` - - For Windows: - - ``` - aws iam create-role ^ - --role-name rds-s3-integration-role ^ - --assume-role-policy-document '{ - "Version": "2012-10-17", - "Statement": [ - { - "Effect": "Allow", - "Principal": { - "Service": "rds.amazonaws.com" - }, - "Action": "sts:AssumeRole", - "Condition": { - "StringEquals": { - "aws:SourceAccount": my_account_ID, - "aws:SourceArn": "arn:aws:rds:Region:my_account_ID:db:dbname" - } - } - } - ] - }' - ``` - - For more information, see [Creating a role to delegate permissions to an IAM user](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_create_for-user.html) in the *IAM User Guide*\. - -1. After the role is created, note the ARN of the role\. You need the ARN for a subsequent step\. - -1. Attach the policy you created to the role you created\. - - The following AWS CLI command attaches the policy to the role named `rds-s3-integration-role`\. -**Example** - - For Linux, macOS, or Unix: - - ``` - aws iam attach-role-policy \ - --policy-arn your-policy-arn \ - --role-name rds-s3-integration-role - ``` - - For Windows: - - ``` - aws iam attach-role-policy ^ - --policy-arn your-policy-arn ^ - --role-name rds-s3-integration-role - ``` - - Replace `your-policy-arn` with the policy ARN that you noted in a previous step\. - -### Step 4: Associate your IAM role with your RDS for Oracle DB instance - -The last step in configuring permissions for Amazon S3 integration is associating your IAM role with your DB instance\. Note the following requirements: -+ You must have access to an IAM role with the required Amazon S3 permissions policy attached to it\. -+ You can only associate one IAM role with your RDS for Oracle DB instance at a time\. -+ Your DB instance must be in the **Available** state\. - -#### Console - -**To associate your IAM role with your RDS for Oracle DB instance** - -1. Sign in to the AWS Management Console and open the Amazon RDS console at [https://console\.aws\.amazon\.com/rds/](https://console.aws.amazon.com/rds/)\. - -1. Choose **Databases** from the navigation pane\. - -1. Choose the RDS for Oracle DB instance name to display its details\. - -1. On the **Connectivity & security** tab, scroll down to the **Manage IAM roles** section at the bottom of the page\. - -1. For **Add IAM roles to this instance**, choose the role that you created in [Step 3: Create an IAM role for your DB instance and attach your policy](#oracle-s3-integration.preparing.role)\. - -1. For **Feature**, choose **S3\_INTEGRATION**\. -![\[Add S3_INTEGRATION role\]](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/images/ora-s3-integration-role.png) - -1. Choose **Add role**\. - -#### AWS CLI - -The following AWS CLI command adds the role to an Oracle DB instance named `mydbinstance`\. - -**Example** -For Linux, macOS, or Unix: - -``` -aws rds add-role-to-db-instance \ - --db-instance-identifier mydbinstance \ - --feature-name S3_INTEGRATION \ - --role-arn your-role-arn -``` -For Windows: - -``` -aws rds add-role-to-db-instance ^ - --db-instance-identifier mydbinstance ^ - --feature-name S3_INTEGRATION ^ - --role-arn your-role-arn -``` - -Replace `your-role-arn` with the role ARN that you noted in a previous step\. `S3_INTEGRATION` must be specified for the `--feature-name` option\. - -## Adding the Amazon S3 integration option - -To integrate Amazon RDS for Oracle with Amazon S3, your DB instance must be associated with an option group that includes the `S3_INTEGRATION` option\. - -### Console - -**To configure an option group for Amazon S3 integration** - -1. Create a new option group or identify an existing option group to which you can add the `S3_INTEGRATION` option\. - - For information about creating an option group, see [Creating an option group](USER_WorkingWithOptionGroups.md#USER_WorkingWithOptionGroups.Create)\. - -1. Add the `S3_INTEGRATION` option to the option group\. - - For information about adding an option to an option group, see [Adding an option to an option group](USER_WorkingWithOptionGroups.md#USER_WorkingWithOptionGroups.AddOption)\. - -1. Create a new RDS for Oracle DB instance and associate the option group with it, or modify an RDS for Oracle DB instance to associate the option group with it\. - - For information about creating a DB instance, see [Creating an Amazon RDS DB instance](USER_CreateDBInstance.md)\. - - For information about modifying a DB instance, see [Modifying an Amazon RDS DB instance](Overview.DBInstance.Modifying.md)\. - -### AWS CLI - -**To configure an option group for Amazon S3 integration** - -1. Create a new option group or identify an existing option group to which you can add the `S3_INTEGRATION` option\. - - For information about creating an option group, see [Creating an option group](USER_WorkingWithOptionGroups.md#USER_WorkingWithOptionGroups.Create)\. - -1. Add the `S3_INTEGRATION` option to the option group\. - - For example, the following AWS CLI command adds the `S3_INTEGRATION` option to an option group named **myoptiongroup**\. -**Example** - - For Linux, macOS, or Unix: - - ``` - aws rds add-option-to-option-group \ - --option-group-name myoptiongroup \ - --options OptionName=S3_INTEGRATION,OptionVersion=1.0 - ``` - - For Windows: - - ``` - aws rds add-option-to-option-group ^ - --option-group-name myoptiongroup ^ - --options OptionName=S3_INTEGRATION,OptionVersion=1.0 - ``` - -1. Create a new RDS for Oracle DB instance and associate the option group with it, or modify an RDS for Oracle DB instance to associate the option group with it\. - - For information about creating a DB instance, see [Creating an Amazon RDS DB instance](USER_CreateDBInstance.md)\. - - For information about modifying an RDS for Oracle DB instance, see [Modifying an Amazon RDS DB instance](Overview.DBInstance.Modifying.md)\. - -## Transferring files between Amazon RDS for Oracle and an Amazon S3 bucket - -To transfer files between an RDS for Oracle DB instance and an Amazon S3 bucket, you can use the Amazon RDS package `rdsadmin_s3_tasks`\. You can compress files with GZIP when uploading them, and decompress them when downloading\. - -**Note** -The procedures in `rdsadmin_s3_tasks` upload or download the files in a single directory\. You can't include subdirectories in these operations\. - -**Topics** -+ [Uploading files from your RDS for Oracle DB instance to an Amazon S3 bucket](#oracle-s3-integration.using.upload) -+ [Downloading files from an Amazon S3 bucket to an Oracle DB instance](#oracle-s3-integration.using.download) -+ [Monitoring the status of a file transfer](#oracle-s3-integration.using.task-status) - -### Uploading files from your RDS for Oracle DB instance to an Amazon S3 bucket - -To upload files from your DB instance to an Amazon S3 bucket, use the procedure `rdsadmin.rdsadmin_s3_tasks.upload_to_s3`\. For example, you can upload Oracle Recovery Manager \(RMAN\) backup files or Oracle Data Pump files\. The maximum object size in an Amazon S3 bucket is 5 TB\. For more information about working with objects, see [Amazon Simple Storage Service User Guide](https://docs.aws.amazon.com/AmazonS3/latest/dev/UsingObjects.html)\. For more information about performing RMAN backups, see [Performing common RMAN tasks for Oracle DB instances](Appendix.Oracle.CommonDBATasks.RMAN.md)\. - -The `rdsadmin.rdsadmin_s3_tasks.upload_to_s3` procedure has the following parameters\. - - -**** - -| Parameter name | Data type | Default | Required | Description | -| --- | --- | --- | --- | --- | -| `p_bucket_name` | VARCHAR2 | – | required | The name of the Amazon S3 bucket to upload files to\. | -| `p_directory_name` | VARCHAR2 | – | required | The name of the Oracle directory object to upload files from\. The directory can be any user\-created directory object or the Data Pump directory, such as `DATA_PUMP_DIR`\. You can only upload files from the specified directory\. You can't upload files in subdirectories in the specified directory\. | -| `p_s3_prefix` | VARCHAR2 | – | required | An Amazon S3 file name prefix that files are uploaded to\. An empty prefix uploads all files to the top level in the specified Amazon S3 bucket and doesn't add a prefix to the file names\. For example, if the prefix is `folder_1/oradb`, files are uploaded to `folder_1`\. In this case, the `oradb` prefix is added to each file\. | -| `p_prefix` | VARCHAR2 | – | required | A file name prefix that file names must match to be uploaded\. An empty prefix uploads all files in the specified directory\. | -| `p_compression_level` | NUMBER | `0` | optional | The level of GZIP compression\. Valid values range from `0` to `9`: [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/oracle-s3-integration.html) | -| `p_bucket_owner_full_control` | VARCHAR2 | – | optional | The access control setting for the bucket\. The only valid values are null or `FULL_CONTROL`\. This setting is required only if you upload files from one account \(account A\) into a bucket owned by a different account \(account B\), and account B needs full control of the files\. | - -The return value for the `rdsadmin.rdsadmin_s3_tasks.upload_to_s3` procedure is a task ID\. - -The following example uploads all of the files in the `DATA_PUMP_DIR` directory to the Amazon S3 bucket named `mys3bucket`\. The files aren't compressed\. - -``` -SELECT rdsadmin.rdsadmin_s3_tasks.upload_to_s3( - p_bucket_name => 'mys3bucket', - p_prefix => '', - p_s3_prefix => '', - p_directory_name => 'DATA_PUMP_DIR') - AS TASK_ID FROM DUAL; -``` - -The following example uploads all of the files with the prefix `db` in the `DATA_PUMP_DIR` directory to the Amazon S3 bucket named `mys3bucket`\. Amazon RDS applies the highest level of GZIP compression to the files\. - -``` -SELECT rdsadmin.rdsadmin_s3_tasks.upload_to_s3( - p_bucket_name => 'mys3bucket', - p_prefix => 'db', - p_s3_prefix => '', - p_directory_name => 'DATA_PUMP_DIR', - p_compression_level => 9) - AS TASK_ID FROM DUAL; -``` - -The following example uploads all of the files in the `DATA_PUMP_DIR` directory to the Amazon S3 bucket named `mys3bucket`\. The files are uploaded to a `dbfiles` folder\. In this example, the GZIP compression level is *1*, which is the fastest level of compression\. - -``` -SELECT rdsadmin.rdsadmin_s3_tasks.upload_to_s3( - p_bucket_name => 'mys3bucket', - p_prefix => '', - p_s3_prefix => 'dbfiles/', - p_directory_name => 'DATA_PUMP_DIR', - p_compression_level => 1) - AS TASK_ID FROM DUAL; -``` - -The following example uploads all of the files in the `DATA_PUMP_DIR` directory to the Amazon S3 bucket named `mys3bucket`\. The files are uploaded to a `dbfiles` folder and `ora` is added to the beginning of each file name\. No compression is applied\. - -``` -SELECT rdsadmin.rdsadmin_s3_tasks.upload_to_s3( - p_bucket_name => 'mys3bucket', - p_prefix => '', - p_s3_prefix => 'dbfiles/ora', - p_directory_name => 'DATA_PUMP_DIR') - AS TASK_ID FROM DUAL; -``` - -The following example assumes that the command is run in account A, but account B requires full control of the bucket contents\. The command `rdsadmin_s3_tasks.upload_to_s3` transfers all files in the `DATA_PUMP_DIR` directory to the bucket named `s3bucketOwnedByAccountB`\. Access control is set to `FULL_CONTROL` so that account B can access the files in the bucket\. The GZIP compression level is *6*, which balances speed and file size\. - -``` -SELECT rdsadmin.rdsadmin_s3_tasks.upload_to_s3( - p_bucket_name => 's3bucketOwnedByAccountB', - p_prefix => '', - p_s3_prefix => '', - p_directory_name => 'DATA_PUMP_DIR', - p_bucket_owner_full_control => 'FULL_CONTROL', - p_compression_level => 6) - AS TASK_ID FROM DUAL; -``` - -In each example, the `SELECT` statement returns the ID of the task in a `VARCHAR2` data type\. - -You can view the result by displaying the task's output file\. - -``` -SELECT text FROM table(rdsadmin.rds_file_util.read_text_file('BDUMP','dbtask-task-id.log')); -``` - -Replace *`task-id`* with the task ID returned by the procedure\. - -**Note** -Tasks are executed asynchronously\. - -### Downloading files from an Amazon S3 bucket to an Oracle DB instance - -To download files from an Amazon S3 bucket to an RDS for Oracle instance, use the Amazon RDS procedure `rdsadmin.rdsadmin_s3_tasks.download_from_s3`\. - -When you download files using the procedure `download_from_s3`, consider the following: -+ The download limit is 2000 files per procedure call\. If you need to download more than 2000 files from Amazon S3, split your download into separate actions, with no more than 2000 files per procedure call\. -+ If a file exists in your download folder, and you attempt to download a file with the same name, `download_from_s3` skips the download\. To remove a file from the download directory, use [UTL\_FILE\.FREMOVE](https://docs.oracle.com/en/database/oracle/oracle-database/19/arpls/UTL_FILE.html#GUID-09B09C2A-2C21-4F70-BF04-D0EEA7B59CAF), found on the Oracle website\. - -The `download_from_s3` procedure has the following parameters\. - - -**** - -| Parameter name | Data type | Default | Required | Description | -| --- | --- | --- | --- | --- | -| `p_bucket_name` | VARCHAR2 | – | Required | The name of the Amazon S3 bucket to download files from\. | -| `p_directory_name` | VARCHAR2 | – | Required | The name of the Oracle directory object to download files to\. The directory can be any user\-created directory object or the Data Pump directory, such as `DATA_PUMP_DIR`\. | -| `p_error_on_zero_downloads` | VARCHAR2 | FALSE | Optional | A flag that determines whether the task raises an error when no objects in the Amazon S3 bucket match the prefix\. If this parameter is not set or set to FALSE \(default\), the task prints a message that no objects were found, but doesn't raise an exception or fail\. If this parameter is TRUE, the task raises an exception and fails\. Examples of prefix specifications that can fail match tests are spaces in prefixes, as in `' import/test9.log'`, and case mismatches, as in `test9.log` and `test9.LOG`\. | -| `p_s3_prefix` | VARCHAR2 | – | Required | A file name prefix that file names must match to be downloaded\. An empty prefix downloads all of the top level files in the specified Amazon S3 bucket, but not the files in folders in the bucket\. The procedure downloads Amazon S3 objects only from the first level folder that matches the prefix\. Nested directory structures matching the specified prefix are not downloaded\. For example, suppose that an Amazon S3 bucket has the folder structure `folder_1/folder_2/folder_3`\. You specify the `'folder_1/folder_2/'` prefix\. In this case, only the files in `folder_2` are downloaded, not the files in `folder_1` or `folder_3`\. If, instead, you specify the `'folder_1/folder_2'` prefix, all files in `folder_1` that match the `'folder_2'` prefix are downloaded, and no files in `folder_2` are downloaded\. | -| `p_decompression_format` | VARCHAR2 | – | Optional | The decompression format\. Valid values are `NONE` for no decompression and `GZIP` for decompression\. | - -The return value for the `rdsadmin.rdsadmin_s3_tasks.download_from_s3` procedure is a task ID\. - -The following example downloads all files in the Amazon S3 bucket named `mys3bucket` to the `DATA_PUMP_DIR` directory\. The files aren't compressed, so no decompression is applied\. - -``` -SELECT rdsadmin.rdsadmin_s3_tasks.download_from_s3( - p_bucket_name => 'mys3bucket', - p_directory_name => 'DATA_PUMP_DIR') - AS TASK_ID FROM DUAL; -``` - -The following example downloads all of the files with the prefix `db` in the Amazon S3 bucket named `mys3bucket` to the `DATA_PUMP_DIR` directory\. The files are compressed with GZIP, so decompression is applied\. The parameter `p_error_on_zero_downloads` turns on prefix error checking, so if the prefix doesn't match any files in the bucket, the task raises and exception and fails\. - -``` -SELECT rdsadmin.rdsadmin_s3_tasks.download_from_s3( - p_bucket_name => 'mys3bucket', - p_s3_prefix => 'db', - p_directory_name => 'DATA_PUMP_DIR', - p_decompression_format => 'GZIP', - p_error_on_zero_downloads => 'TRUE') - AS TASK_ID FROM DUAL; -``` - -The following example downloads all of the files in the folder `myfolder/` in the Amazon S3 bucket named `mys3bucket` to the `DATA_PUMP_DIR` directory\. Use the `p_s3_prefix` parameter to specify the Amazon S3 folder\. The uploaded files are compressed with GZIP, but aren't decompressed during the download\. - -``` -SELECT rdsadmin.rdsadmin_s3_tasks.download_from_s3( - p_bucket_name => 'mys3bucket', - p_s3_prefix => 'myfolder/', - p_directory_name => 'DATA_PUMP_DIR', - p_decompression_format => 'NONE') - AS TASK_ID FROM DUAL; -``` - -The following example downloads the file `mydumpfile.dmp` in the Amazon S3 bucket named `mys3bucket` to the `DATA_PUMP_DIR` directory\. No decompression is applied\. - -``` -SELECT rdsadmin.rdsadmin_s3_tasks.download_from_s3( - p_bucket_name => 'mys3bucket', - p_s3_prefix => 'mydumpfile.dmp', - p_directory_name => 'DATA_PUMP_DIR') - AS TASK_ID FROM DUAL; -``` - -In each example, the `SELECT` statement returns the ID of the task in a `VARCHAR2` data type\. - -You can view the result by displaying the task's output file\. - -``` -SELECT text FROM table(rdsadmin.rds_file_util.read_text_file('BDUMP','dbtask-task-id.log')); -``` - -Replace *`task-id`* with the task ID returned by the procedure\. - -**Note** -Tasks are executed asynchronously\. -You can use the `UTL_FILE.FREMOVE` Oracle procedure to remove files from a directory\. For more information, see [FREMOVE procedure](https://docs.oracle.com/database/121/ARPLS/u_file.htm#ARPLS70924) in the Oracle documentation\. - -### Monitoring the status of a file transfer - -File transfer tasks publish Amazon RDS events when they start and when they complete\. The event message contains the task ID for the file transfer\. For information about viewing events, see [Viewing Amazon RDS events](USER_ListEvents.md)\. - -You can view the status of an ongoing task in a bdump file\. The bdump files are located in the `/rdsdbdata/log/trace` directory\. Each bdump file name is in the following format\. - -``` -dbtask-task-id.log -``` - -Replace `task-id` with the ID of the task that you want to monitor\. - -**Note** -Tasks are executed asynchronously\. - -You can use the `rdsadmin.rds_file_util.read_text_file` stored procedure to view the contents of bdump files\. For example, the following query returns the contents of the `dbtask-1234567890123-1234.log` bdump file\. - -``` -SELECT text FROM table(rdsadmin.rds_file_util.read_text_file('BDUMP','dbtask-1234567890123-1234.log')); -``` - -The following sample shows the log file for a failed transfer\. - -``` -TASK_ID --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- -1234567890123-1234 - - -TEXT --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- -2023-04-17 18:21:33.993 UTC [INFO ] File #1: Uploading the file /rdsdbdata/datapump/A123B4CDEF567890G1234567890H1234/sample.dmp to Amazon S3 with bucket name mys3bucket and key sample.dmp. -2023-04-17 18:21:34.188 UTC [ERROR] RDS doesn't have permission to write to Amazon S3 bucket name mys3bucket and key sample.dmp. -2023-04-17 18:21:34.189 UTC [INFO ] The task failed. -``` - -## Troubleshooting Amazon S3 integration - -For troubleshooting tips, see the AWS re:Post article [How do troubleshoot issues when I integrate Amazon RDS for Oracle with Amazon S3?](https://repost.aws/en/knowledge-center/rds-oracle-s3-integration)\. - -## Removing the Amazon S3 integration option - -You can remove Amazon S3 integration option from a DB instance\. - -To remove the Amazon S3 integration option from a DB instance, do one of the following: -+ To remove the Amazon S3 integration option from multiple DB instances, remove the `S3_INTEGRATION` option from the option group to which the DB instances belong\. This change affects all DB instances that use the option group\. For more information, see [Removing an option from an option group](USER_WorkingWithOptionGroups.md#USER_WorkingWithOptionGroups.RemoveOption)\. - - -+ To remove the Amazon S3 integration option from a single DB instance, modify the instance and specify a different option group that doesn't include the `S3_INTEGRATION` option\. You can specify the default \(empty\) option group or a different custom option group\. For more information, see [Modifying an Amazon RDS DB instance](Overview.DBInstance.Modifying.md)\. \ No newline at end of file diff --git a/doc_source/parameter-groups-overview.md b/doc_source/parameter-groups-overview.md deleted file mode 100644 index 5c5a4ed..0000000 --- a/doc_source/parameter-groups-overview.md +++ /dev/null @@ -1,70 +0,0 @@ -# Overview of parameter groups - -A *DB parameter group* acts as a container for engine configuration values that are applied to one or more DB instances\. *DB cluster parameter groups* apply to Multi\-AZ DB clusters only\. In a Multi\-AZ DB cluster, the settings in the DB cluster parameter group apply to all of the DB instances in the cluster\. The default DB parameter group for the DB engine and DB engine version is used for each DB instance in the DB cluster\. - -**Topics** -+ [Default and custom parameter groups](#parameter-groups-overview.custom) -+ [Static and dynamic DB instance parameters](#parameter-groups-overview.db-instance) -+ [Static and dynamic DB cluster parameters](#parameter-groups-overview.maz) -+ [Character set parameters](#parameter-groups-overview.char-sets) -+ [Supported parameters and parameter values](#parameter-groups-overview.supported) - -## Default and custom parameter groups - -If you create a DB instance without specifying a DB parameter group, the DB instance uses a default DB parameter group\. Likewise, if you create a Multi\-AZ DB cluster without specifying a DB cluster parameter group, the DB cluster uses a default DB cluster parameter group\. Each default parameter group contains database engine defaults and Amazon RDS system defaults based on the engine, compute class, and allocated storage of the instance\. - -You can't modify the parameter settings of a default parameter group\. Instead, you can do the following: - -1. Create a new parameter group\. - -1. Change the settings of your desired parameters\. Not all DB engine parameters in a parameter group are eligible to be modified\. - -1. Modify your DB instance or DB cluster to use the custom parameter group\. For information about modifying a DB instance, see [Modifying an Amazon RDS DB instance](Overview.DBInstance.Modifying.md)\. For information about modifying a Multi\-AZ DB clusters, see [Modifying a Multi\-AZ DB cluster](modify-multi-az-db-cluster.md)\. -**Note** -If you have modified your DB instance to use a custom parameter group, and you start the DB instance, RDS automatically reboots the DB instance as part of the startup process\. - -If you update parameters within a DB parameter group, the changes apply to all DB instances that are associated with that parameter group\. Likewise, if you update parameters within a Multi\-AZ DB cluster parameter group, the changes apply to all Aurora DB clusters that are associated with that DB cluster parameter group\. - -If you don't want to create a parameter group from scratch, you can copy an existing parameter group with the AWS CLI [copy\-db\-parameter\-group](https://docs.aws.amazon.com/cli/latest/reference/rds/copy-db-parameter-group.html) command or [copy\-db\-cluster\-parameter\-group](https://docs.aws.amazon.com/cli/latest/reference/rds/copy-db-cluster-parameter-group.html) command\. You might find that copying a parameter group is useful in some cases\. For example, you might want to include most of an existing DB parameter group's custom parameters and values in a new DB parameter group\. - -## Static and dynamic DB instance parameters - -DB instance parameters are either static or dynamic\. They differ as follows: -+ When you change a static parameter and save the DB parameter group, the parameter change takes effect after you manually reboot the associated DB instances\. For static parameters, the console always uses `pending-reboot` for the `ApplyMethod`\. -+ When you change a dynamic parameter, by default the parameter change takes effect immediately, without requiring a reboot\. When you use the AWS Management Console to change DB instance parameter values, it always uses `immediate` for the `ApplyMethod` for dynamic parameters\. To defer the parameter change until after you reboot an associated DB instance, use the AWS CLI or RDS API\. Set the `ApplyMethod` to `pending-reboot` for the parameter change\. -**Note** -Using `pending-reboot` with dynamic parameters in the AWS CLI or RDS API on RDS for SQL Server DB instances generates an error\. Use `apply-immediately` on RDS for SQL Server\. - -For more information about using the AWS CLI to change a parameter value, see [modify\-db\-parameter\-group](https://docs.aws.amazon.com/cli/latest/reference/rds/modify-db-parameter-group.html)\. For more information about using the RDS API to change a parameter value, see [ModifyDBParameterGroup](https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_ModifyDBParameterGroup.html)\. - -When you associate a new DB parameter group with a DB instance, RDS applies the modified static and dynamic parameters only after the DB instance is rebooted\. However, if you modify dynamic parameters in the DB parameter group after you associate it with the DB instance, these changes are applied immediately without a reboot\. For more information about changing the DB parameter group, see [Modifying an Amazon RDS DB instance](Overview.DBInstance.Modifying.md)\. - -If a DB instance isn't using the latest changes to its associated DB parameter group, the console shows a status of **pending\-reboot** for the DB parameter group\. This status doesn't result in an automatic reboot during the next maintenance window\. To apply the latest parameter changes to that DB instance, manually reboot the DB instance\. - -## Static and dynamic DB cluster parameters - -DB cluster parameters are either static or dynamic\. They differ as follows: -+ When you change a static parameter and save the DB cluster parameter group, the parameter change takes effect after you manually reboot the associated DB clusters\. For static parameters, the console always uses `pending-reboot` for the `ApplyMethod`\. -+ When you change a dynamic parameter, by default the parameter change takes effect immediately, without requiring a reboot\. When you use the AWS Management Console to change DB cluster parameter values, it always uses `immediate` for the `ApplyMethod` for dynamic parameters\. To defer the parameter change until after an associated DB cluster is rebooted, use the AWS CLI or RDS API\. Set the `ApplyMethod` to `pending-reboot` for the parameter change\. - -For more information about using the AWS CLI to change a parameter value, see [modify\-db\-cluster\-parameter\-group](https://docs.aws.amazon.com/cli/latest/reference/rds/modify-db-cluster-parameter-group.html)\. For more information about using the RDS API to change a parameter value, see [ModifyDBClusterParameterGroup](https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_ModifyDBClusterParameterGroup.html)\. - -## Character set parameters - -Before you create a DB instance or Multi\-AZ DB cluster, set any parameters that relate to the character set or collation of your database in your parameter group\. Also do so before you create a database in it\. In this way, you ensure that the default database and new databases use the character set and collation values that you specify\. If you change character set or collation parameters, the parameter changes aren't applied to existing databases\. - -For some DB engines, you can change character set or collation values for an existing database using the `ALTER DATABASE` command, for example: - -``` -ALTER DATABASE database_name CHARACTER SET character_set_name COLLATE collation; -``` - -For more information about changing the character set or collation values for a database, check the documentation for your DB engine\. - -## Supported parameters and parameter values - -To determine the supported parameters for your DB engine, view the parameters in the DB parameter group and DB cluster parameter group used by the DB instance or DB cluster\. For more information, see [Viewing parameter values for a DB parameter group](USER_WorkingWithDBInstanceParamGroups.md#USER_WorkingWithParamGroups.Viewing) and [Viewing parameter values for a DB cluster parameter group](USER_WorkingWithDBClusterParamGroups.md#USER_WorkingWithParamGroups.ViewingCluster)\. - -In many cases, you can specify integer and Boolean parameter values using expressions, formulas, and functions\. Functions can include a mathematical log expression\. However, not all parameters support expressions, formulas, and functions for parameter values\. For more information, see [Specifying DB parameters](USER_ParamValuesRef.md)\. - -Improperly setting parameters in a parameter group can have unintended adverse effects, including degraded performance and system instability\. Always be cautious when modifying database parameters, and back up your data before modifying a parameter group\. Try parameter group setting changes on a test DB instance or DB cluster before applying those parameter group changes to a production DB instance or DB cluster\. \ No newline at end of file diff --git a/doc_source/passcheck_hook.md b/doc_source/passcheck_hook.md deleted file mode 100644 index 176e68e..0000000 --- a/doc_source/passcheck_hook.md +++ /dev/null @@ -1,55 +0,0 @@ -# Password\-check hook \(passcheck\) - -The `passcheck` hook is used to customize PostgreSQL behavior during the password\-checking process for the following SQL commands and `psql` metacommand\. -+ `CREATE ROLE username ...PASSWORD` – For more information, see [CREATE ROLE](https://www.postgresql.org/docs/current/sql-createrole.html) in the PostgreSQL documentation\. -+ `ALTER ROLE username...PASSWORD` – For more information, see [ALTER ROLE](https://www.postgresql.org/docs/current/sql-alterrole.html) in the PostgreSQL documentation\. -+ `\password username` – This interactive `psql` metacommand securely changes the password for the specified user by hashing the password before transparently using the `ALTER ROLE ... PASSWORD` syntax\. The metacommand is a secure wrapper for the `ALTER ROLE ... PASSWORD` command, thus the hook applies to the behavior of the `psql` metacommand\. - -For an example, see [Password\-check hook code listing](PostgreSQL_trusted_language_extension.md#PostgreSQL_trusted_language_extension-example-hook_code_listing)\. - -## Function prototype - -``` -passcheck_hook(username text, password text, password_type pgtle.password_types, valid_until timestamptz, valid_null boolean) -``` - -## Arguments - -A `passcheck` hook function takes the following arguments\. -+ `username` – The name \(as text\) of the role \(username\) that's setting a password\. -+ `password` – The plaintext or hashed password\. The password entered should match the type specified in `password_type`\. -+ `password_type` – Specify the `pgtle.password_type` format of the password\. This format can be one of the following options\. - + `PASSWORD_TYPE_PLAINTEXT` – A plaintext password\. - + `PASSWORD_TYPE_MD5` – A password that's been hashed using MD5 \(message digest 5\) algorithm\. - + `PASSWORD_TYPE_SCRAM_SHA_256` – A password that's been hashed using SCRAM\-SHA\-256 algorithm\. -+ `valid_until` – Specify the time when the password becomes invalid\. This argument is optional\. If you use this argument, specify the time as a `timestamptz` value\. -+ `valid_null` – If this Boolean is set to `true`, the `valid_until` option is set to `NULL`\. - -## Configuration - -The function `pgtle.enable_password_check` controls whether the passcheck hook is active\. The passcheck hook has three possible settings\. -+ `off` – Turns off the `passcheck` password\-check hook\. This is the default value\. -+ `on` – Turns on the `passcode` password\-check hook so that passwords are checked against the table\. -+ `require` – Requires a password check hook to be defined\. - -## Usage notes - -To turn the `passcheck` hook on or off, you need to modify the custom DB parameter group for your RDS for PostgreSQL DB instance\. - -For Linux, macOS, or Unix: - -``` -aws rds modify-db-parameter-group \ - --region aws-region \ - --db-parameter-group-name your-custom-parameter-group \ - --parameters "ParameterName=pgtle.enable_password_check,ParameterValue=on,ApplyMethod=immediate" -``` - -For Windows: - -``` -aws rds modify-db-parameter-group ^ - --region aws-region ^ - --db-parameter-group-name your-custom-parameter-group ^ - --parameters "ParameterName=pgtle.enable_password_check,ParameterValue=on,ApplyMethod=immediate" -``` \ No newline at end of file diff --git a/doc_source/pgtle.available_extension_versions.md b/doc_source/pgtle.available_extension_versions.md deleted file mode 100644 index 7dccbeb..0000000 --- a/doc_source/pgtle.available_extension_versions.md +++ /dev/null @@ -1,35 +0,0 @@ -# pgtle\.available\_extension\_versions - -The `available_extension_versions` function is a set\-returning function\. It returns a list of all available TLE extensions and their versions\. Each row contains information about a specific version of the given TLE extension, including whether it requires a specific role\. - -## Function prototype - -``` -pgtle.available_extension_versions() -``` - -## Role - -None\. - -## Arguments - -None\. - -## Output -+ `name` – The name of the TLE extension\. -+ `version` – The version of the TLE extension\. -+ `superuser` – This value is always `false` for your TLE extensions\. The permissions needed to create the TLE extension or update it are the same as for creating other objects in the given database\. -+ `trusted` – This value is always `false` for a TLE extension\. -+ `relocatable` – This value is always `false` for a TLE extension\. -+ `schema` – Specifies the name of the schema in which the TLE extension is installed\. -+ `requires` – An array containing the names of other extensions needed by this TLE extension\. -+ `description` – A detailed description of the TLE extension\. - -For more information about output values, see [Packaging Related Objects into an Extension > Extension Files](https://www.postgresql.org/docs/current/extend-extensions.html#id-1.8.3.20.11) in the PostgreSQL documentation\. - -## Usage example - -``` -SELECT * FROM pgtle.available_extension_versions(); -``` \ No newline at end of file diff --git a/doc_source/pgtle.available_extensions.md b/doc_source/pgtle.available_extensions.md deleted file mode 100644 index 5056c74..0000000 --- a/doc_source/pgtle.available_extensions.md +++ /dev/null @@ -1,28 +0,0 @@ -# pgtle\.available\_extensions - -The `pgtle.available_extensions` function is a set\-returning function\. It returns all available TLE extensions in the database\. Each returned row contains information about a single TLE extension\. - -## Function prototype - -``` -pgtle.available_extensions() -``` - -## Role - -None\. - -## Arguments - -None\. - -## Output -+ `name` – The name of the TLE extension\. -+ `default_version` – The version of the TLE extension to use when `CREATE EXTENSION` is called without a version specified\. -+ `description` – A more detailed description about the TLE extension\. - -## Usage example - -``` -SELECT * FROM pgtle.available_extensions(); -``` \ No newline at end of file diff --git a/doc_source/pgtle.extension_update_paths.md b/doc_source/pgtle.extension_update_paths.md deleted file mode 100644 index 70b885f..0000000 --- a/doc_source/pgtle.extension_update_paths.md +++ /dev/null @@ -1,28 +0,0 @@ -# pgtle\.extension\_update\_paths - -The `extension_update_paths` function is a set\-returning function\. It returns a list of all the possible update paths for a TLE extension\. Each row includes the available upgrades or downgrades for that TLE extension\. - -## Function prototype - -``` -pgtle.extension_update_paths(name) -``` - -## Role - -None\. - -## Arguments - -`name` – The name of the TLE extension from which to get upgrade paths\. - -## Output -+ `source` – The source version for an update\. -+ `target` – The target version for an update\. -+ `path` – The upgrade path used to update a TLE extension from `source` version to `target` version, for example, `0.1--0.2`\. - -## Usage example - -``` -SELECT * FROM pgtle.extension_update_paths('your-TLE); -``` \ No newline at end of file diff --git a/doc_source/pgtle.install_extension.md b/doc_source/pgtle.install_extension.md deleted file mode 100644 index 0005e77..0000000 --- a/doc_source/pgtle.install_extension.md +++ /dev/null @@ -1,45 +0,0 @@ -# pgtle\.install\_extension - -The `install_extension` function lets you install the artifacts that make up your TLE extension in the database, after which it can be created using the `CREATE EXTENSION` command\. - -## Function prototype - -``` -pgtle.install_extension(name text, version text, description text, ext text, requires text[] DEFAULT NULL::text[]) -``` - -## Role - -None\. - -## Arguments -+ `name` – The name of the TLE extension\. This value is used when calling `CREATE EXTENSION`\. -+ `version` – The version of the TLE extension\. -+ `description` – A detailed description about the TLE extension\. This description is displayed in the `comment` field in `pgtle.available_extensions()`\. -+ `ext` – The contents of the TLE extension\. This value contains objects such as functions\. -+ `requires` – An optional parameter that specifies dependencies for this TLE extension\. The `pg_tle` extension is automatically added as a dependency\. - -Many of these arguments are the same as those that are included in an extension control file for installing a PostgreSQL extension on the file system of a PostgreSQL instance\. For more information, see the [Extension Files](http://www.postgresql.org/docs/current/extend-extensions.html#id-1.8.3.20.11) in [Packaging Related Objects into an Extension](https://www.postgresql.org/docs/current/extend-extensions.html) in the PostgreSQL documentation\. - -## Output - -This functions returns `OK` on success and `NULL` on error\. -+ `OK` – The TLE extension has been successfully installed in the database\. -+ `NULL` – The TLE extension hasn't been successfully installed in the database\. - -## Usage example - -``` -SELECT pgtle.install_extension( - pg_tle_test, - 0.1, - My first pg_tle extension, -$_pgtle_$ - CREATE FUNCTION my_test() - RETURNS INT - AS $$ - SELECT 42; - $$ LANGUAGE SQL IMMUTABLE; -$_pgtle_$ -); -``` \ No newline at end of file diff --git a/doc_source/pgtle.install_update_path.md b/doc_source/pgtle.install_update_path.md deleted file mode 100644 index abaaaba..0000000 --- a/doc_source/pgtle.install_update_path.md +++ /dev/null @@ -1,37 +0,0 @@ -# pgtle\.install\_update\_path - -The `install_update_path` function provides an update path between two different versions of a TLE extension\. This function allows users of your TLE extension to update its version by using the `ALTER EXTENSION ... UPDATE` syntax\. - -## Function prototype - -``` -pgtle.install_update_path(name text, fromvers text, tovers text, ext text) -``` - -## Role - -`pgtle_admin` - -## Arguments -+ `name` – The name of the TLE extension\. This value is used when calling `CREATE EXTENSION`\. -+ `fromvers` – The source version of the TLE extension for the upgrade\. -+ `tovers` – The destination version of the TLE extension for the upgrade\. -+ `ext` – The contents of the update\. This value contains objects such as functions\. - -## Output - -None\. - -## Usage example - -``` -SELECT pgtle.install_update_path(pg_tle_test, 0.1, 0.2, - $_pgtle_$ - CREATE OR REPLACE FUNCTION my_test() - RETURNS INT - AS $$ - SELECT 21; - $$ LANGUAGE SQL IMMUTABLE; - $_pgtle_$ -); -``` \ No newline at end of file diff --git a/doc_source/pgtle.register_feature.md b/doc_source/pgtle.register_feature.md deleted file mode 100644 index 92183c8..0000000 --- a/doc_source/pgtle.register_feature.md +++ /dev/null @@ -1,28 +0,0 @@ -# pgtle\.register\_feature - -The `register_feature` function adds the specified internal PostgreSQL feature to the `pgtle.feature_info` table\. PostgreSQL hooks are an example of an internal PostgreSQL feature\. The Trusted Language Extensions development kit supports the use of PostgreSQL hooks\. Currently, this function supports the following feature\. -+ `passcheck` – Registers the password\-check hook with your procedure or function that customizes PostgreSQL's password\-check behavior\. - -## Function prototype - -``` -pgtle.register_feature(proc regproc, feature pg_tle_feature) -``` - -## Role - -`pgtle_admin` - -## Arguments -+ `proc` – The name of a stored procedure or function to use for the feature\. -+ `feature` – The name of the `pg_tle` feature \(such as `passcheck`\) to register with the function\. - -## Output - -None\. - -## Usage example - -``` -SELECT pgtle.register_feature('pw_hook', 'passcheck'); -``` \ No newline at end of file diff --git a/doc_source/pgtle.register_feature_if_not_exists.md b/doc_source/pgtle.register_feature_if_not_exists.md deleted file mode 100644 index c145cd4..0000000 --- a/doc_source/pgtle.register_feature_if_not_exists.md +++ /dev/null @@ -1,27 +0,0 @@ -# pgtle\.register\_feature\_if\_not\_exists - -The `pgtle.register_feature_if_not_exists` function adds the specified PostgreSQL feature to the `pgtle.feature_info` table and identifies the TLE extension or other procedure or function that uses the feature\. For more information about hooks and Trusted Language Extensions, see [Using PostgreSQL hooks with your TLE extensions](PostgreSQL_trusted_language_extension.md#PostgreSQL_trusted_language_extension.overview.tles-and-hooks)\. - -## Function prototype - -``` -pgtle.register_feature_if_not_exists(proc regproc, feature pg_tle_feature) -``` - -## Role - -`pgtle_admin` - -## Arguments -+ `proc` – The name of a stored procedure or function that contains the logic \(code\) to use as a feature for your TLE extension\. For example, the `pw_hook` code\. -+ `feature` – The name of the PostgreSQL feature to register for the TLE function\. Currently, the only available feature is the `passcheck` hook\. For more information, see [Password\-check hook \(passcheck\)](passcheck_hook.md)\. - -## Output - -Returns `true` after registering the feature for the specified extension\. Returns `false` if the feature is already registered\. - -## Usage example - -``` -SELECT pgtle.register_feature_if_not_exists('pw_hook', 'passcheck'); -``` \ No newline at end of file diff --git a/doc_source/pgtle.set_default_version.md b/doc_source/pgtle.set_default_version.md deleted file mode 100644 index 02f55fc..0000000 --- a/doc_source/pgtle.set_default_version.md +++ /dev/null @@ -1,29 +0,0 @@ -# pgtle\.set\_default\_version - -The `set_default_version` function lets you specify a `default_version` for your TLE extension\. You can use this function to define an upgrade path and designate the version as the default for your TLE extension\. When database users specify your TLE extension in the `CREATE EXTENSION` and `ALTER EXTENSION ... UPDATE` commands, that version of your TLE extension is created in the database for that user\. - -This function returns `true` on success\. If the TLE extension specified in the `name` argument doesn't exist, the function returns an error\. Similarly, if the `version` of the TLE extension doesn't exist, it returns an error\. - -## Function prototype - -``` -pgtle.set_default_version(name text, version text) -``` - -## Role - -`pgtle_admin` - -## Arguments -+ `name` – The name of the TLE extension\. This value is used when calling `CREATE EXTENSION`\. -+ `version` – The version of the TLE extension to set the default\. - -## Output -+ `true` – When setting default version succeeds, the function returns `true`\. -+ `ERROR` – Returns an error message if a TLE extension with the specified name or version doesn't exist\. - -## Usage example - -``` -SELECT * FROM pgtle.set_default_version(my-extension, 1.1); -``` \ No newline at end of file diff --git a/doc_source/pgtle.uninstall_extension-name-version.md b/doc_source/pgtle.uninstall_extension-name-version.md deleted file mode 100644 index 2e94d95..0000000 --- a/doc_source/pgtle.uninstall_extension-name-version.md +++ /dev/null @@ -1,27 +0,0 @@ -# pgtle\.uninstall\_extension\(name, version\) - -The `uninstall_extension(name, version)` function removes the specified version of the TLE extension from the database\. This function prevents `CREATE EXTENSION` and `ALTER EXTENSION` from installing or updating a TLE extension to the specified version\. This function also removes all update paths for the specified version of the TLE extension\. This function won't uninstall the TLE extension if it's currently active in the database\. You must explicitly call `DROP EXTENSION` to remove the TLE extension\. To uninstall all versions of a TLE extension, see [pgtle\.uninstall\_extension\(name\)](pgtle.uninstall_extension-name.md)\. - -## Function prototype - -``` -pgtle.uninstall_extension(extname text, version text) -``` - -## Role - -`pgtle_admin` - -## Arguments -+ `extname` – The name of the TLE extension\. This value is used when calling `CREATE EXTENSION`\. -+ `version` – The version of the TLE extension to uninstall from the database\. - -## Output - -None\. - -## Usage example - -``` -SELECT * FROM pgtle.uninstall_extension(pg_tle_test, 0.2); -``` \ No newline at end of file diff --git a/doc_source/pgtle.uninstall_extension-name.md b/doc_source/pgtle.uninstall_extension-name.md deleted file mode 100644 index deddf1c..0000000 --- a/doc_source/pgtle.uninstall_extension-name.md +++ /dev/null @@ -1,28 +0,0 @@ -# pgtle\.uninstall\_extension\(name\) - -The `uninstall_extension` function removes all versions of a TLE extension from a database\. This function prevents future calls of `CREATE EXTENSION` from installing the TLE extension\. If the TLE extension doesn't exist in the database, an error is raised\. - -The `uninstall_extension` function won't drop a TLE extension that's currently active in the database\. To remove a TLE extension that's currently active, you need to explicitly call `DROP EXTENSION` to remove it\. - -## Function prototype - -``` -pgtle.uninstall_extension(extname text) -``` - -## Role - -`pgtle_admin` - -## Arguments -+ `extname` – The name of the TLE extension to uninstall\. This name is the same as the one used with `CREATE EXTENSION` to load the TLE extension for use in a given database\. - -## Output - -None\. - -## Usage example - -``` -SELECT * FROM pgtle.uninstall_extension(pg_tle_test); -``` \ No newline at end of file diff --git a/doc_source/pgtle.uninstall_extension_if_exists.md b/doc_source/pgtle.uninstall_extension_if_exists.md deleted file mode 100644 index 7524b99..0000000 --- a/doc_source/pgtle.uninstall_extension_if_exists.md +++ /dev/null @@ -1,28 +0,0 @@ -# pgtle\.uninstall\_extension\_if\_exists - -The `uninstall_extension_if_exists` function removes all versions of a TLE extension from a given database\. If the TLE extension doesn't exist, the function returns silently \(no error message is raised\)\. If the specified extension is currently active within a database, this function doesn't drop it\. You must explicitly call `DROP EXTENSION` to remove the TLE extension before using this function to uninstall its artifacts\. - -## Function prototype - -``` -pgtle.uninstall_extension_if_exists(extname text) -``` - -## Role - -`pgtle_admin` - -## Arguments -+ `extname` – The name of the TLE extension\. This value is used when calling `CREATE EXTENSION`\. - -## Output - -The `uninstall_extension_if_exists` function returns `true` after uninstalling the specified extension\. If the specified extension doesn't exist, the function returns `false`\. -+ `true` – Returns `true` after uninstalling the TLE extension\. -+ `false` – Returns `false` when the TLE extension doesn't exist in the database\. - -## Usage example - -``` -SELECT * FROM pgtle.uninstall_extension_if_exists(pg_tle_test); -``` \ No newline at end of file diff --git a/doc_source/pgtle.uninstall_update_path.md b/doc_source/pgtle.uninstall_update_path.md deleted file mode 100644 index ef7c353..0000000 --- a/doc_source/pgtle.uninstall_update_path.md +++ /dev/null @@ -1,32 +0,0 @@ -# pgtle\.uninstall\_update\_path - -The `uninstall_update_path` function removes the specific update path from a TLE extension\. This prevents `ALTER EXTENSION ... UPDATE TO` from using this as an update path\. - -If the TLE extension is currently being used by one of the versions on this update path, it remains in the database\. - -If the update path specified doesn't exist, this function raises an error\. - -## Function prototype - -``` -pgtle.uninstall_update_path(extname text, fromvers text, tovers text) -``` - -## Role - -`pgtle_admin` - -## Arguments -+ `extname` – The name of the TLE extension\. This value is used when calling `CREATE EXTENSION`\. -+ `fromvers` – The source version of the TLE extension used on the update path\. -+ `tovers` – The destination version of the TLE extension used on the update path\. - -## Output - -None\. - -## Usage example - -``` -SELECT * FROM pgtle.uninstall_update_path(pg_tle_test, 0.1, 0.2); -``` \ No newline at end of file diff --git a/doc_source/pgtle.uninstall_update_path_if_exists.md b/doc_source/pgtle.uninstall_update_path_if_exists.md deleted file mode 100644 index fe3c16e..0000000 --- a/doc_source/pgtle.uninstall_update_path_if_exists.md +++ /dev/null @@ -1,28 +0,0 @@ -# pgtle\.uninstall\_update\_path\_if\_exists - -The `uninstall_update_path_if_exists` function is similar to `uninstall_update_path` in that it removes the specified update path from a TLE extension\. However, if the update path doesn't exist, this function doesn't raise an error message\. Instead, the function returns `false`\. - -## Function prototype - -``` -pgtle.uninstall_update_path_if_exists(extname text, fromvers text, tovers text) -``` - -## Role - -`pgtle_admin` - -## Arguments -+ `extname` – The name of the TLE extension\. This value is used when calling `CREATE EXTENSION`\. -+ `fromvers` – The source version of the TLE extension used on the update path\. -+ `tovers` – The destination version of the TLE extension used on the update path\. - -## Output -+ `true` – The function has successfully updated the path for the TLE extension\. -+ `false` – The function wasn't able to update the path for the TLE extension\. - -## Usage example - -``` -SELECT * FROM pgtle.uninstall_update_path_if_exists(pg_tle_test, 0.1, 0.2); -``` \ No newline at end of file diff --git a/doc_source/pgtle.unregister_feature.md b/doc_source/pgtle.unregister_feature.md deleted file mode 100644 index 032bfe4..0000000 --- a/doc_source/pgtle.unregister_feature.md +++ /dev/null @@ -1,27 +0,0 @@ -# pgtle\.unregister\_feature - -The `unregister_feature` function provides a way to remove functions that were registered to use `pg_tle` features, such as hooks\. For information about registering a feature, see [pgtle\.register\_feature](pgtle.register_feature.md)\. - -## Function prototype - -``` -pgtle.unregister_feature(proc regproc, feature pg_tle_features) -``` - -## Role - -`pgtle_admin` - -## Arguments -+ `proc` – The name of a stored function to register with a `pg_tle` feature\. -+ `feature` – The name of the `pg_tle` feature to register with the function\. For example, `passcheck` is a feature that can be registered for use by the trusted language extensions that you develop\. For more information, see [Password\-check hook \(passcheck\)](passcheck_hook.md)\. - -## Output - -None\. - -## Usage example - -``` -SELECT * FROM pgtle.unregister_feature(pw_hook, passcheck); -``` \ No newline at end of file diff --git a/doc_source/pgtle.unregister_feature_if_exists.md b/doc_source/pgtle.unregister_feature_if_exists.md deleted file mode 100644 index c793ba5..0000000 --- a/doc_source/pgtle.unregister_feature_if_exists.md +++ /dev/null @@ -1,31 +0,0 @@ -# pgtle\.unregister\_feature\_if\_exists - -The `unregister_feature` function provides a way to remove functions that were registered to use `pg_tle` features, such as hooks\. For more information, see [Using PostgreSQL hooks with your TLE extensions](PostgreSQL_trusted_language_extension.md#PostgreSQL_trusted_language_extension.overview.tles-and-hooks)\. Returns `true` after successfully unregistering the feature\. Returns `false` if the feature wasn't registered\. - -For information about registering `pg_tle` features for your TLE extensions, see [pgtle\.register\_feature](pgtle.register_feature.md)\. - -## Function prototype - -``` -pgtle.unregister_feature_if_exists(proc regproc, feature pg_tle_features) -``` - -## Role - -`pgtle_admin` - -## Arguments -+ `proc` – The name of the stored function that was registered to include a `pg_tle` feature\. -+ `feature` – The name of the `pg_tle` feature that was registered with the trusted language extension\. - -## Output - -Returns `true` or `false`, as follows\. -+ `true` – The function has successfully unregistered the feature from extension\. -+ `false` – The function wasn't able to unregister the feature from the TLE extension\. - -## Usage example - -``` -SELECT * FROM pgtle.unregister_feature_if_exists(pw_hook, passcheck); -``` \ No newline at end of file diff --git a/doc_source/postgresql-kerberos-connecting.md b/doc_source/postgresql-kerberos-connecting.md deleted file mode 100644 index 4023a2a..0000000 --- a/doc_source/postgresql-kerberos-connecting.md +++ /dev/null @@ -1,74 +0,0 @@ -# Connecting to PostgreSQL with Kerberos authentication - -You can connect to PostgreSQL with Kerberos authentication with the pgAdmin interface or with a command\-line interface such as psql\. For more information about connecting, see [Connecting to a DB instance running the PostgreSQL database engine](USER_ConnectToPostgreSQLInstance.md) \. For information about obtaining the endpoint, port number, and other details needed for connection, see [Step 3: Connect to a PostgreSQL DB instance](CHAP_GettingStarted.CreatingConnecting.PostgreSQL.md#CHAP_GettingStarted.Connecting.PostgreSQL)\. - -## pgAdmin - -To use pgAdmin to connect to PostgreSQL with Kerberos authentication, take the following steps: - -1. Launch the pgAdmin application on your client computer\. - -1. On the **Dashboard** tab, choose **Add New Server**\. - -1. In the **Create \- Server** dialog box, enter a name on the **General** tab to identify the server in pgAdmin\. - -1. On the **Connection** tab, enter the following information from your RDS for PostgreSQL database\. - + For **Host**, enter the endpoint for the RDS for PostgreSQL DB instance\. An endpoint looks similar to the following: - - ``` - RDS-DB-instance.111122223333.aws-region.rds.amazonaws.com - ``` - - To connect to an on\-premises Microsoft Active Directory from a Windows client, you use the domain name of the AWS Managed Active Directory instead of `rds.amazonaws.com` in the host endpoint\. For example, suppose that the domain name for the AWS Managed Active Directory is `corp.example.com`\. Then for **Host**, the endpoint would be specified as follows: - - ``` - RDS-DB-instance.111122223333.aws-region.corp.example.com - ``` - + For **Port**, enter the assigned port\. - + For **Maintenance database**, enter the name of the initial database to which the client will connect\. - + For **Username**, enter the user name that you entered for Kerberos authentication in [ Step 7: Create PostgreSQL users for your Kerberos principals ](postgresql-kerberos-setting-up.md#postgresql-kerberos-setting-up.create-logins)\. - -1. Choose **Save**\. - -## Psql - -To use psql to connect to PostgreSQL with Kerberos authentication, take the following steps: - -1. At a command prompt, run the following command\. - - ``` - kinit username - ``` - - Replace *`username`* with the user name\. At the prompt, enter the password stored in the Microsoft Active Directory for the user\. - -1. If the PostgreSQL DB instance is using a publicly accessible VPC, put a private IP address for your DB instance endpoint in your `/etc/hosts` file on the EC2 client\. For example, the following commands obtain the private IP address and then put it in the `/etc/hosts` file\. - - ``` - % dig +short PostgreSQL-endpoint.AWS-Region.rds.amazonaws.com - ;; Truncated, retrying in TCP mode. - ec2-34-210-197-118.AWS-Region.compute.amazonaws.com. - 34.210.197.118 - - % echo " 34.210.197.118 PostgreSQL-endpoint.AWS-Region.rds.amazonaws.com" >> /etc/hosts - ``` - - If you're using an on\-premises Microsoft Active Directory from a Windows client, then you need to connect using a specialized endpoint\. Instead of using the Amazon domain `rds.amazonaws.com` in the host endpoint, use the domain name of the AWS Managed Active Directory\. - - For example, suppose that the domain name for your AWS Managed Active Directory is `corp.example.com`\. Then use the format `PostgreSQL-endpoint.AWS-Region.corp.example.com` for the endpoint and put it in the `/etc/hosts` file\. - - ``` - % echo " 34.210.197.118 PostgreSQL-endpoint.AWS-Region.corp.example.com" >> /etc/hosts - ``` - -1. Use the following psql command to log in to a PostgreSQL DB instance that is integrated with Active Directory\. - - ``` - psql -U username@CORP.EXAMPLE.COM -p 5432 -h PostgreSQL-endpoint.AWS-Region.rds.amazonaws.com postgres - ``` - - To log in to the PostgreSQL DB cluster from a Windows client using an on\-premises Active Directory, use the following psql command with the domain name from the previous step \(`corp.example.com`\): - - ``` - psql -U username@CORP.EXAMPLE.COM -p 5432 -h PostgreSQL-endpoint.AWS-Region.corp.example.com postgres - ``` \ No newline at end of file diff --git a/doc_source/postgresql-kerberos-managing.md b/doc_source/postgresql-kerberos-managing.md deleted file mode 100644 index becb849..0000000 --- a/doc_source/postgresql-kerberos-managing.md +++ /dev/null @@ -1,25 +0,0 @@ -# Managing a DB instance in a Domain - -You can use the console, the CLI, or the RDS API to manage your DB instance and its relationship with your Microsoft Active Directory\. For example, you can associate an Active Directory to enable Kerberos authentication\. You can also remove the association for an Active Directory to disable Kerberos authentication\. You can also move a DB instance to be externally authenticated by one Microsoft Active Directory to another\. - -For example, using the CLI, you can do the following: -+ To reattempt enabling Kerberos authentication for a failed membership, use the [modify\-db\-instance](https://docs.aws.amazon.com/cli/latest/reference/rds/modify-db-instance.html) CLI command\. Specify the current membership's directory ID for the `--domain` option\. -+ To disable Kerberos authentication on a DB instance, use the [modify\-db\-instance](https://docs.aws.amazon.com/cli/latest/reference/rds/modify-db-instance.html) CLI command\. Specify `none` for the `--domain` option\. -+ To move a DB instance from one domain to another, use the [modify\-db\-instance](https://docs.aws.amazon.com/cli/latest/reference/rds/modify-db-instance.html) CLI command\. Specify the domain identifier of the new domain for the `--domain` option\. - -## Understanding Domain membership - -After you create or modify your DB instance, it becomes a member of the domain\. You can view the status of the domain membership in the console or by running the [describe\-db\-instances](https://docs.aws.amazon.com/cli/latest/reference/rds/describe-db-instances.html) CLI command\. The status of the DB instance can be one of the following: -+ `kerberos-enabled` – The DB instance has Kerberos authentication enabled\. -+ `enabling-kerberos` – AWS is in the process of enabling Kerberos authentication on this DB instance\. -+ `pending-enable-kerberos` – Enabling Kerberos authentication is pending on this DB instance\. -+ `pending-maintenance-enable-kerberos` – AWS will attempt to enable Kerberos authentication on the DB instance during the next scheduled maintenance window\. -+ `pending-disable-kerberos` – Disabling Kerberos authentication is pending on this DB instance\. -+ `pending-maintenance-disable-kerberos` – AWS will attempt to disable Kerberos authentication on the DB instance during the next scheduled maintenance window\. -+ `enable-kerberos-failed` – A configuration problem prevented AWS from enabling Kerberos authentication on the DB instance\. Correct the configuration problem before reissuing the command to modify the DB instance\. -+ `disabling-kerberos` – AWS is in the process of disabling Kerberos authentication on this DB instance\. - -A request to enable Kerberos authentication can fail because of a network connectivity issue or an incorrect IAM role\. In some cases, the attempt to enable Kerberos authentication might fail when you create or modify a DB instance\. If so, make sure that you are using the correct IAM role, then modify the DB instance to join the domain\. - -**Note** -Only Kerberos authentication with RDS for PostgreSQL sends traffic to the domain's DNS servers\. All other DNS requests are treated as outbound network access on your DB instances running PostgreSQL\. For more information about outbound network access with RDS for PostgreSQL, see [Using a custom DNS server for outbound network access](Appendix.PostgreSQL.CommonDBATasks.CustomDNS.md)\. \ No newline at end of file diff --git a/doc_source/postgresql-kerberos-setting-up.md b/doc_source/postgresql-kerberos-setting-up.md deleted file mode 100644 index 6964215..0000000 --- a/doc_source/postgresql-kerberos-setting-up.md +++ /dev/null @@ -1,294 +0,0 @@ -# Setting up Kerberos authentication for PostgreSQL DB instances - -You use AWS Directory Service for Microsoft Active Directory \(AWS Managed Microsoft AD\) to set up Kerberos authentication for a PostgreSQL DB instance\. To set up Kerberos authentication, take the following steps\. - -**Topics** -+ [Step 1: Create a directory using AWS Managed Microsoft AD](#postgresql-kerberos-setting-up.create-directory) -+ [Step 2: \(Optional\) Create a trust relationship between your on\-premises Active Directory and AWS Directory Service](#postgresql-kerberos-setting-up.create-trust) -+ [Step 3: Create an IAM role for Amazon RDS to access the AWS Directory Service](#postgresql-kerberos-setting-up.CreateIAMRole) -+ [Step 4: Create and configure users](#postgresql-kerberos-setting-up.create-users) -+ [Step 5: Enable cross\-VPC traffic between the directory and the DB instance](#postgresql-kerberos-setting-up.vpc-peering) -+ [Step 6: Create or modify a PostgreSQL DB instance](#postgresql-kerberos-setting-up.create-modify) -+ [Step 7: Create PostgreSQL users for your Kerberos principals](#postgresql-kerberos-setting-up.create-logins) -+ [Step 8: Configure a PostgreSQL client](#postgresql-kerberos-setting-up.configure-client) - -## Step 1: Create a directory using AWS Managed Microsoft AD - -AWS Directory Service creates a fully managed Active Directory in the AWS Cloud\. When you create an AWS Managed Microsoft AD directory, AWS Directory Service creates two domain controllers and DNS servers for you\. The directory servers are created in different subnets in a VPC\. This redundancy helps make sure that your directory remains accessible even if a failure occurs\. - - When you create an AWS Managed Microsoft AD directory, AWS Directory Service performs the following tasks on your behalf: -+ Sets up an Active Directory within your VPC\. -+ Creates a directory administrator account with the user name `Admin` and the specified password\. You use this account to manage your directory\. -**Important** -Make sure to save this password\. AWS Directory Service doesn't store this password, and it can't be retrieved or reset\. -+ Creates a security group for the directory controllers\. The security group must permit communication with the PostgreSQL DB instance\. - -When you launch AWS Directory Service for Microsoft Active Directory, AWS creates an Organizational Unit \(OU\) that contains all of your directory's objects\. This OU, which has the NetBIOS name that you entered when you created your directory, is located in the domain root\. The domain root is owned and managed by AWS\. - - The `Admin` account that was created with your AWS Managed Microsoft AD directory has permissions for the most common administrative activities for your OU: -+ Create, update, or delete users -+ Add resources to your domain such as file or print servers, and then assign permissions for those resources to users in your OU -+ Create additional OUs and containers -+ Delegate authority -+ Restore deleted objects from the Active Directory Recycle Bin -+ Run Active Directory and Domain Name Service \(DNS\) modules for Windows PowerShell on the Active Directory Web Service - -The `Admin` account also has rights to perform the following domain\-wide activities: -+ Manage DNS configurations \(add, remove, or update records, zones, and forwarders\) -+ View DNS event logs -+ View security event logs - -**To create a directory with AWS Managed Microsoft AD** - -1. In the [AWS Directory Service console](https://console.aws.amazon.com/directoryservicev2/) navigation pane, choose **Directories**, and then choose **Set up directory**\. - -1. Choose **AWS Managed Microsoft AD**\. AWS Managed Microsoft AD is the only option currently supported for use with Amazon RDS\. - -1. Choose **Next**\. - -1. On the **Enter directory information** page, provide the following information: -**Edition** - Choose the edition that meets your requirements\. -**Directory DNS name** - The fully qualified name for the directory, such as **corp\.example\.com**\. -**Directory NetBIOS name** - An optional short name for the directory, such as `CORP`\. -**Directory description** - An optional description for the directory\. -**Admin password** - The password for the directory administrator\. The directory creation process creates an administrator account with the user name `Admin` and this password\. - The directory administrator password can't include the word "admin\." The password is case\-sensitive and must be 8–64 characters in length\. It must also contain at least one character from three of the following four categories: - + Lowercase letters \(a–z\) - + Uppercase letters \(A–Z\) - + Numbers \(0–9\) - + Nonalphanumeric characters \(\~\!@\#$%^&\*\_\-\+=`\|\\\(\)\{\}\[\]:;"'<>,\.?/\) -**Confirm password** - Retype the administrator password\. -Make sure that you save this password\. AWS Directory Service doesn't store this password, and it can't be retrieved or reset\. - -1. Choose **Next**\. - -1. On the **Choose VPC and subnets** page, provide the following information: -**VPC** -Choose the VPC for the directory\. You can create the PostgreSQL DB instance in this same VPC or in a different VPC\. -**Subnets** - Choose the subnets for the directory servers\. The two subnets must be in different Availability Zones\. - -1. Choose **Next**\. - -1. Review the directory information\. If changes are needed, choose **Previous** and make the changes\. When the information is correct, choose **Create directory**\. -![\[Directory details page\]](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/images/WinAuth2.png) - - It takes several minutes for the directory to be created\. When it has been successfully created, the **Status** value changes to **Active**\. - - To see information about your directory, choose the directory ID in the directory listing\. Make a note of the **Directory ID** value\. You need this value when you create or modify your PostgreSQL DB instance\. - -![\[Image of details page\]](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/images/WinAuth3.png) - -## Step 2: \(Optional\) Create a trust relationship between your on\-premises Active Directory and AWS Directory Service - -If you don't plan to use your own on\-premises Microsoft Active Directory, skip to [Step 3: Create an IAM role for Amazon RDS to access the AWS Directory Service](#postgresql-kerberos-setting-up.CreateIAMRole)\. - -To get Kerberos authentication using your on\-premises Active Directory, you need to create a trusting domain relationship using a forest trust between your on\-premises Microsoft Active Directory and the AWS Managed Microsoft AD directory \(created in [Step 1: Create a directory using AWS Managed Microsoft AD](#postgresql-kerberos-setting-up.create-directory)\)\. The trust can be one\-way, where the AWS Managed Microsoft AD directory trusts the on\-premises Microsoft Active Directory\. The trust can also be two\-way, where both Active Directories trust each other\. For more information about setting up trusts using AWS Directory Service, see [When to create a trust relationship](https://docs.aws.amazon.com/directoryservice/latest/admin-guide/ms_ad_setup_trust.html) in the *AWS Directory Service Administration Guide*\. - -**Note** -If you use an on\-premises Microsoft Active Directory, Windows clients connect using the domain name of the AWS Directory Service in the endpoint rather than rds\.amazonaws\.com\. To learn more, see [Connecting to PostgreSQL with Kerberos authentication](postgresql-kerberos-connecting.md)\. - -Make sure that your on\-premises Microsoft Active Directory domain name includes a DNS suffix routing that corresponds to the newly created trust relationship\. The following screenshot shows an example\. - -![\[DNS routing corresponds to the created trust\]](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/images/kerberos-auth-trust.png) - -## Step 3: Create an IAM role for Amazon RDS to access the AWS Directory Service - -For Amazon RDS to call AWS Directory Service for you, your AWS account needs an IAM role that uses the managed IAM policy `AmazonRDSDirectoryServiceAccess`\. This role allows Amazon RDS to make calls to AWS Directory Service\. - -When you create a DB instance using the AWS Management Console and your console user account has the `iam:CreateRole` permission, the console creates the needed IAM role automatically\. In this case, the role name is `rds-directoryservice-kerberos-access-role`\. Otherwise, you must create the IAM role manually\. When you create this IAM role, choose `Directory Service`, and attach the AWS managed policy `AmazonRDSDirectoryServiceAccess` to it\. - -For more information about creating IAM roles for a service, see [Creating a role to delegate permissions to an AWS service](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_create_for-service.html) in the *IAM User Guide*\. - -**Note** -The IAM role used for Windows Authentication for RDS for Microsoft SQL Server can't be used for Amazon RDS for PostgreSQL\. - -As an alternative to using the `AmazonRDSDirectoryServiceAccess` managed policy, you can create policies with the required permissions\. In this case, the IAM role must have the following IAM trust policy\. - -``` -{ - "Version": "2012-10-17", - "Statement": [ - { - "Sid": "", - "Effect": "Allow", - "Principal": { - "Service": [ - "directoryservice.rds.amazonaws.com", - "rds.amazonaws.com" - ] - }, - "Action": "sts:AssumeRole" - } - ] -} -``` - -The role must also have the following IAM role policy\. - -``` -{ - "Version": "2012-10-17", - "Statement": [ - { - "Action": [ - "ds:DescribeDirectories", - "ds:AuthorizeApplication", - "ds:UnauthorizeApplication", - "ds:GetAuthorizedApplicationDetails" - ], - "Effect": "Allow", - "Resource": "*" - } - ] -} -``` - -## Step 4: Create and configure users - - You can create users by using the Active Directory Users and Computers tool\. This is one of the Active Directory Domain Services and Active Directory Lightweight Directory Services tools\. For more information, see [Add Users and Computers to the Active Directory domain](https://learn.microsoft.com/en-us/troubleshoot/windows-server/identity/create-an-active-directory-server#add-users-and-computers-to-the-active-directory-domain) in the Microsoft documentation\. In this case, users are individuals or other entities, such as their computers that are part of the domain and whose identities are being maintained in the directory\. - -To create users in an AWS Directory Service directory, you must be connected to a Windows\-based Amazon EC2 instance that's a member of the AWS Directory Service directory\. At the same time, you must be logged in as a user that has privileges to create users\. For more information, see [Create a user](https://docs.aws.amazon.com/directoryservice/latest/admin-guide/ms_ad_manage_users_groups_create_user.html) in the *AWS Directory Service Administration Guide*\. - -## Step 5: Enable cross\-VPC traffic between the directory and the DB instance - -If you plan to locate the directory and the DB instance in the same VPC, skip this step and move on to [ Step 6: Create or modify a PostgreSQL DB instance](#postgresql-kerberos-setting-up.create-modify)\. - -If you plan to locate the directory and the DB instance in different VPCs, configure cross\-VPC traffic using VPC peering or [AWS Transit Gateway](https://docs.aws.amazon.com/vpc/latest/tgw/what-is-transit-gateway.html)\. - -The following procedure enables traffic between VPCs using VPC peering\. Follow the instructions in [What is VPC peering?](https://docs.aws.amazon.com/vpc/latest/peering/Welcome.html) in the *Amazon Virtual Private Cloud Peering Guide*\. - -**To enable cross\-VPC traffic using VPC peering** - -1. Set up appropriate VPC routing rules to ensure that network traffic can flow both ways\. - -1. Ensure that the DB instance security group can receive inbound traffic from the directory security group\. - -1. Ensure that there is no network access control list \(ACL\) rule to block traffic\. - -If a different AWS account owns the directory, you must share the directory\. - -**To share the directory between AWS accounts** - -1. Start sharing the directory with the AWS account that the DB instance will be created in by following the instructions in [Tutorial: Sharing your AWS Managed Microsoft AD directory for seamless EC2 Domain\-join](https://docs.aws.amazon.com/directoryservice/latest/admin-guide/ms_ad_tutorial_directory_sharing.html) in the *AWS Directory Service Administration Guide*\. - -1. Sign in to the AWS Directory Service console using the account for the DB instance, and ensure that the domain has the `SHARED` status before proceeding\. - -1. While signed into the AWS Directory Service console using the account for the DB instance, note the **Directory ID** value\. You use this directory ID to join the DB instance to the domain\. - -## Step 6: Create or modify a PostgreSQL DB instance - -Create or modify a PostgreSQL DB instance for use with your directory\. You can use the console, CLI, or RDS API to associate a DB instance with a directory\. You can do this in one of the following ways: -+ Create a new PostgreSQL DB instance using the console, the [ create\-db\-instance](https://docs.aws.amazon.com/cli/latest/reference/rds/create-db-instance.html) CLI command, or the [CreateDBInstance](https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_CreateDBInstance.html) RDS API operation\. For instructions, see [Creating an Amazon RDS DB instance](USER_CreateDBInstance.md)\. -+ Modify an existing PostgreSQL DB instance using the console, the [modify\-db\-instance](https://docs.aws.amazon.com/cli/latest/reference/rds/modify-db-instance.html) CLI command, or the [ModifyDBInstance](https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_ModifyDBInstance.html) RDS API operation\. For instructions, see [Modifying an Amazon RDS DB instance](Overview.DBInstance.Modifying.md)\. -+ Restore a PostgreSQL DB instance from a DB snapshot using the console, the [restore\-db\-instance\-from\-db\-snapshot](https://docs.aws.amazon.com/cli/latest/reference/rds/restore-db-instance-from-db-snapshot.html) CLI command, or the [ RestoreDBInstanceFromDBSnapshot](https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_RestoreDBInstanceFromDBSnapshot.html) RDS API operation\. For instructions, see [Restoring from a DB snapshot](USER_RestoreFromSnapshot.md)\. -+ Restore a PostgreSQL DB instance to a point\-in\-time using the console, the [ restore\-db\-instance\-to\-point\-in\-time](https://docs.aws.amazon.com/cli/latest/reference/rds/restore-db-instance-to-point-in-time.html) CLI command, or the [ RestoreDBInstanceToPointInTime](https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_RestoreDBInstanceToPointInTime.html) RDS API operation\. For instructions, see [Restoring a DB instance to a specified time](USER_PIT.md)\. - -Kerberos authentication is only supported for PostgreSQL DB instances in a VPC\. The DB instance can be in the same VPC as the directory, or in a different VPC\. The DB instance must use a security group that allows ingress and egress within the directory's VPC so the DB instance can communicate with the directory\. - -### Console - -When you use the console to create, modify, or restore a DB instance, choose **Password and Kerberos authentication** in the **Database authentication** section\. Then choose **Browse Directory**\. Select the directory or choose **Create a new directory** to use the Directory Service\. - -![\[Choosing Kerberos for authentication and identifying the directory to use.\]](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/images/rpg-authentication-use-kerberos.png) - -### AWS CLI - -When you use the AWS CLI, the following parameters are required for the DB instance to be able to use the directory that you created: -+ For the `--domain` parameter, use the domain identifier \("d\-\*" identifier\) generated when you created the directory\. -+ For the `--domain-iam-role-name` parameter, use the role you created that uses the managed IAM policy `AmazonRDSDirectoryServiceAccess`\. - -For example, the following CLI command modifies a DB instance to use a directory\. - -``` -aws rds modify-db-instance --db-instance-identifier mydbinstance --domain d-Directory-ID --domain-iam-role-name role-name -``` - -**Important** -If you modify a DB instance to enable Kerberos authentication, reboot the DB instance after making the change\. - -## Step 7: Create PostgreSQL users for your Kerberos principals - -At this point, your RDS for PostgreSQL DB instance is joined to the AWS Managed Microsoft AD domain\. The users that you created in the directory in [ Step 4: Create and configure users ](#postgresql-kerberos-setting-up.create-users) need to be set up as PostgreSQL database users and granted privileges to login to the database\. You do that by signing in as the database user with `rds_superuser` privileges\. For example, if you accepted the defaults when you created your RDS for PostgreSQL DB instance, you use `postgres`, as shown in the following steps\. - -**To create PostgreSQL database users for Kerberos principals** - -1. Use `psql` to connect to your RDS for PostgreSQL DB instance endpoint using `psql`\. The following example uses the default `postgres` account for the `rds_superuser` role\. - - ``` - psql --host=cluster-instance-1.111122223333.aws-region.rds.amazonaws.com --port=5432 --username=postgres --password - ``` - -1. Create a database user name for each Kerberos principal \(Active Directory username\) that you want to have access to the database\. Use the canonical username \(identity\) as defined in the Active Directory instance, that is, a lower\-case `alias` \(username in Active Directory\) and the upper\-case name of the Active Directory domain for that user name\. The Active Directory user name is an externally authenticated user, so use quotes around the name as shown following\. - - ``` - postgres=> CREATE USER "username@CORP.EXAMPLE.COM" WITH LOGIN; - CREATE ROLE - ``` - -1. Grant the `rds_ad` role to the database user\. - - ``` - postgres=> GRANT rds_ad TO "username@CORP.EXAMPLE.COM"; - GRANT ROLE - ``` - -After you finish creating all the PostgreSQL users for your Active Directory user identities, users can access the RDS for PostgreSQL DB instance by using their Kerberos credentials\. - -It's assumed that the database users who authenticate using Kerberos are doing so from client machines that are members of the Active Directory domain\. - -Database users that have been granted the `rds_ad` role can't also have the `rds_iam` role\. This also applies to nested memberships\. For more information, see [IAM database authentication for MariaDB, MySQL, and PostgreSQL](UsingWithRDS.IAMDBAuth.md)\. - -## Step 8: Configure a PostgreSQL client - -To configure a PostgreSQL client, take the following steps: -+ Create a krb5\.conf file \(or equivalent\) to point to the domain\. -+ Verify that traffic can flow between the client host and AWS Directory Service\. Use a network utility such as Netcat for the following: - + Verify traffic over DNS for port 53\. - + Verify traffic over TCP/UDP for port 53 and for Kerberos, which includes ports 88 and 464 for AWS Directory Service\. -+ Verify that traffic can flow between the client host and the DB instance over the database port\. For example, use psql to connect and access the database\. - -The following is sample krb5\.conf content for AWS Managed Microsoft AD\. - -``` -[libdefaults] - default_realm = EXAMPLE.COM -[realms] - EXAMPLE.COM = { - kdc = example.com - admin_server = example.com - } -[domain_realm] - .example.com = EXAMPLE.COM - example.com = EXAMPLE.COM -``` - -The following is sample krb5\.conf content for an on\-premises Microsoft Active Directory\. - -``` -[libdefaults] - default_realm = EXAMPLE.COM -[realms] - EXAMPLE.COM = { - kdc = example.com - admin_server = example.com - } - ONPREM.COM = { - kdc = onprem.com - admin_server = onprem.com - } -[domain_realm] - .example.com = EXAMPLE.COM - example.com = EXAMPLE.COM - .onprem.com = ONPREM.COM - onprem.com = ONPREM.COM - .rds.amazonaws.com = EXAMPLE.COM - .amazonaws.com.cn = EXAMPLE.COM - .amazon.com = EXAMPLE.COM -``` \ No newline at end of file diff --git a/doc_source/postgresql-kerberos.md b/doc_source/postgresql-kerberos.md deleted file mode 100644 index 1cec8df..0000000 --- a/doc_source/postgresql-kerberos.md +++ /dev/null @@ -1,49 +0,0 @@ -# Using Kerberos authentication with Amazon RDS for PostgreSQL - -You can use Kerberos to authenticate users when they connect to your DB instance running PostgreSQL\. To do so, configure your DB instance to use AWS Directory Service for Microsoft Active Directory for Kerberos authentication\. AWS Directory Service for Microsoft Active Directory is also called AWS Managed Microsoft AD\. It's a feature available with AWS Directory Service\. To learn more, see [What is AWS Directory Service?](https://docs.aws.amazon.com/directoryservice/latest/admin-guide/what_is.html) in the *AWS Directory Service Administration Guide*\. - -To start, create an AWS Managed Microsoft AD directory to store user credentials\. Then, provide to your PostgreSQL DB instance the Active Directory's domain and other information\. When users authenticate with the PostgreSQL DB instance, authentication requests are forwarded to the AWS Managed Microsoft AD directory\. - -Keeping all of your credentials in the same directory can save you time and effort\. You have a centralized location for storing and managing credentials for multiple DB instances\. Using a directory can also improve your overall security profile\. - -In addition, you can access credentials from your own on\-premises Microsoft Active Directory\. To do so, create a trusting domain relationship so that the AWS Managed Microsoft AD directory trusts your on\-premises Microsoft Active Directory\. In this way, your users can access your PostgreSQL instances with the same Windows single sign\-on \(SSO\) experience as when they access workloads in your on\-premises network\. - -A database can use password authentication or password authentication with either Kerberos or AWS Identity and Access Management \(IAM\) authentication\. For more information about IAM authentication, see [IAM database authentication for MariaDB, MySQL, and PostgreSQL](UsingWithRDS.IAMDBAuth.md)\. - -**Topics** -+ [Region and version availability](#postgresql-kerberos.RegionVersionAvailability) -+ [Overview of Kerberos authentication for PostgreSQL DB instances](#postgresql-kerberos-overview) -+ [Setting up Kerberos authentication for PostgreSQL DB instances](postgresql-kerberos-setting-up.md) -+ [Managing a DB instance in a Domain](postgresql-kerberos-managing.md) -+ [Connecting to PostgreSQL with Kerberos authentication](postgresql-kerberos-connecting.md) - -## Region and version availability - -Feature availability and support varies across specific versions of each database engine, and across AWS Regions\. For more information on version and Region availability of RDS for PostgreSQL with Kerberos authentication, see [Kerberos authentication](Concepts.RDS_Fea_Regions_DB-eng.Feature.KerberosAuthentication.md)\. - -## Overview of Kerberos authentication for PostgreSQL DB instances - -To set up Kerberos authentication for a PostgreSQL DB instance, take the following steps, described in more detail later: - -1. Use AWS Managed Microsoft AD to create an AWS Managed Microsoft AD directory\. You can use the AWS Management Console, the AWS CLI, or the AWS Directory Service API to create the directory\. Make sure to open the relevant outbound ports on the directory security group so that the directory can communicate with the instance\. - -1. Create a role that provides Amazon RDS access to make calls to your AWS Managed Microsoft AD directory\. To do so, create an AWS Identity and Access Management \(IAM\) role that uses the managed IAM policy `AmazonRDSDirectoryServiceAccess`\. - - For the IAM role to allow access, the AWS Security Token Service \(AWS STS\) endpoint must be activated in the correct AWS Region for your AWS account\. AWS STS endpoints are active by default in all AWS Regions, and you can use them without any further actions\. For more information, see [Activating and deactivating AWS STS in an AWS Region](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp_enable-regions.html#sts-regions-activate-deactivate) in the *IAM User Guide*\. - -1. Create and configure users in the AWS Managed Microsoft AD directory using the Microsoft Active Directory tools\. For more information about creating users in your Active Directory, see [Manage users and groups in AWS Managed Microsoft AD](https://docs.aws.amazon.com/directoryservice/latest/admin-guide/ms_ad_manage_users_groups.html) in the *AWS Directory Service Administration Guide*\. - -1. If you plan to locate the directory and the DB instance in different AWS accounts or virtual private clouds \(VPCs\), configure VPC peering\. For more information, see [What is VPC peering?](https://docs.aws.amazon.com/vpc/latest/peering/Welcome.html) in the *Amazon VPC Peering Guide*\. - -1. Create or modify a PostgreSQL DB instance either from the console, CLI, or RDS API using one of the following methods: - + [Creating an Amazon RDS DB instance](USER_CreateDBInstance.md) - + [Modifying an Amazon RDS DB instance](Overview.DBInstance.Modifying.md) - + [Restoring from a DB snapshot](USER_RestoreFromSnapshot.md) - + [Restoring a DB instance to a specified time](USER_PIT.md) - - You can locate the instance in the same Amazon Virtual Private Cloud \(VPC\) as the directory or in a different AWS account or VPC\. When you create or modify the PostgreSQL DB instance, do the following: - + Provide the domain identifier \(`d-*` identifier\) that was generated when you created your directory\. - + Provide the name of the IAM role that you created\. - + Ensure that the DB instance security group can receive inbound traffic from the directory security group\. - -1. Use the RDS master user credentials to connect to the PostgreSQL DB instance\. Create the user in PostgreSQL to be identified externally\. Externally identified users can log in to the PostgreSQL DB instance using Kerberos authentication\. \ No newline at end of file diff --git a/doc_source/postgresql-s3-export.md b/doc_source/postgresql-s3-export.md deleted file mode 100644 index 758a2f7..0000000 --- a/doc_source/postgresql-s3-export.md +++ /dev/null @@ -1,513 +0,0 @@ -# Exporting data from an RDS for PostgreSQL DB instance to Amazon S3 - -You can query data from an RDS for PostgreSQL DB instance and export it directly into files stored in an Amazon S3 bucket\. To do this, you first install the RDS for PostgreSQL `aws_s3` extension\. This extension provides you with the functions that you use to export the results of queries to Amazon S3\. Following, you can find out how to install the extension and how to export data to Amazon S3\. - -You can export from a provisioned or an Aurora Serverless v2 DB instance\. These steps aren't supported for Aurora Serverless v1\. - -**Note** -Cross\-account export to Amazon S3 isn't supported\. - -All currently available versions of RDS for PostgreSQL support exporting data to Amazon Simple Storage Service\. For detailed version information, see [Amazon RDS for PostgreSQL updates](https://docs.aws.amazon.com/AmazonRDS/latest/PostgreSQLReleaseNotes/postgresql-versions.html) in the *Amazon RDS for PostgreSQL Release Notes*\. - -If you don't have a bucket set up for your export, see the following topics the *Amazon Simple Storage Service User Guide*\. -+ [Setting up Amazon S3](https://docs.aws.amazon.com/AmazonS3/latest/userguide/setting-up-s3.html) -+ [Create a bucket](https://docs.aws.amazon.com/AmazonS3/latest/gsg/CreatingABucket.html) - -The upload to Amazon S3 uses server\-side encryption by default\. If you are using encryption, the Amazon S3 bucket must be encrypted with an AWS managed key\. Currently, you can't export data to a bucket that's encrypted with a customer managed key\. - -**Note** -You can save DB snapshot data to Amazon S3 using the AWS Management Console, AWS CLI, or Amazon RDS API\. For more information, see [Exporting DB snapshot data to Amazon S3](USER_ExportSnapshot.md)\. - -**Topics** -+ [Installing the aws\_s3 extension](#USER_PostgreSQL.S3Export.InstallExtension) -+ [Overview of exporting data to Amazon S3](#postgresql-s3-export-overview) -+ [Specifying the Amazon S3 file path to export to](#postgresql-s3-export-file) -+ [Setting up access to an Amazon S3 bucket](#postgresql-s3-export-access-bucket) -+ [Exporting query data using the aws\_s3\.query\_export\_to\_s3 function](#postgresql-s3-export-examples) -+ [Troubleshooting access to Amazon S3](#postgresql-s3-export-troubleshoot) -+ [Function reference](#postgresql-s3-export-functions) - -## Installing the aws\_s3 extension - -Before you can use Amazon Simple Storage Service with your RDS for PostgreSQL DB instance, you need to install the `aws_s3` extension\. This extension provides functions for exporting data from an RDS for PostgreSQL DB instance to an Amazon S3 bucket\. It also provides functions for importing data from an Amazon S3\. For more information, see [Importing data from Amazon S3 into an RDS for PostgreSQL DB instance](USER_PostgreSQL.S3Import.md)\. The `aws_s3` extension depends on some of the helper functions in the `aws_commons` extension, which is installed automatically when needed\. - -**To install the `aws_s3` extension** - -1. Use psql \(or pgAdmin\) to connect to the RDS for PostgreSQL DB instance as a user that has `rds_superuser` privileges\. If you kept the default name during the setup process, you connect as `postgres`\. - - ``` - psql --host=111122223333.aws-region.rds.amazonaws.com --port=5432 --username=postgres --password - ``` - -1. To install the extension, run the following command\. - - ``` - postgres=> CREATE EXTENSION aws_s3 CASCADE; - NOTICE: installing required extension "aws_commons" - CREATE EXTENSION - ``` - -1. To verify that the extension is installed, you can use the psql `\dx` metacommand\. - - ``` - postgres=> \dx - List of installed extensions - Name | Version | Schema | Description - -------------+---------+------------+--------------------------------------------- - aws_commons | 1.2 | public | Common data types across AWS services - aws_s3 | 1.1 | public | AWS S3 extension for importing data from S3 - plpgsql | 1.0 | pg_catalog | PL/pgSQL procedural language - (3 rows) - ``` - -The functions for importing data from Amazon S3 and exporting data to Amazon S3 are now available to use\. - -### Verify that your RDS for PostgreSQL version supports exports to Amazon S3 - -You can verify that your RDS for PostgreSQL version supports export to Amazon S3 by using the `describe-db-engine-versions` command\. The following example verifies support for version 10\.14\. - -``` -aws rds describe-db-engine-versions --region us-east-1 ^ ---engine postgres --engine-version 10.14 | grep s3Export -``` - -If the output includes the string `"s3Export"`, then the engine supports Amazon S3 exports\. Otherwise, the engine doesn't support them\. - -## Overview of exporting data to Amazon S3 - -To export data stored in an RDS for PostgreSQL database to an Amazon S3 bucket, use the following procedure\. - -**To export RDS for PostgreSQL data to S3** - -1. Identify an Amazon S3 file path to use for exporting data\. For details about this process, see [Specifying the Amazon S3 file path to export to](#postgresql-s3-export-file)\. - -1. Provide permission to access the Amazon S3 bucket\. - - To export data to an Amazon S3 file, give the RDS for PostgreSQL DB instance permission to access the Amazon S3 bucket that the export will use for storage\. Doing this includes the following steps: - - 1. Create an IAM policy that provides access to an Amazon S3 bucket that you want to export to\. - - 1. Create an IAM role\. - - 1. Attach the policy you created to the role you created\. - - 1. Add this IAM role to your DB instance\. - - For details about this process, see [Setting up access to an Amazon S3 bucket](#postgresql-s3-export-access-bucket)\. - -1. Identify a database query to get the data\. Export the query data by calling the `aws_s3.query_export_to_s3` function\. - - After you complete the preceding preparation tasks, use the [aws\_s3\.query\_export\_to\_s3](#aws_s3.export_query_to_s3) function to export query results to Amazon S3\. For details about this process, see [Exporting query data using the aws\_s3\.query\_export\_to\_s3 function](#postgresql-s3-export-examples)\. - -## Specifying the Amazon S3 file path to export to - -Specify the following information to identify the location in Amazon S3 where you want to export data to: -+ Bucket name – A *bucket* is a container for Amazon S3 objects or files\. - - For more information on storing data with Amazon S3, see [Create a bucket](https://docs.aws.amazon.com/AmazonS3/latest/gsg/CreatingABucket.html) and [View an object](https://docs.aws.amazon.com/AmazonS3/latest/gsg/OpeningAnObject.html) in the *Amazon Simple Storage Service User Guide*\. -+ File path – The file path identifies where the export is stored in the Amazon S3 bucket\. The file path consists of the following: - + An optional path prefix that identifies a virtual folder path\. - + A file prefix that identifies one or more files to be stored\. Larger exports are stored in multiple files, each with a maximum size of approximately 6 GB\. The additional file names have the same file prefix but with `_partXX` appended\. The `XX` represents 2, then 3, and so on\. - - For example, a file path with an `exports` folder and a `query-1-export` file prefix is `/exports/query-1-export`\. -+ AWS Region \(optional\) – The AWS Region where the Amazon S3 bucket is located\. If you don't specify an AWS Region value, then Amazon RDS saves your files into Amazon S3 in the same AWS Region as the exporting DB instance\. -**Note** -Currently, the AWS Region must be the same as the region of the exporting DB instance\. - - For a listing of AWS Region names and associated values, see [Regions, Availability Zones, and Local Zones](Concepts.RegionsAndAvailabilityZones.md)\. - -To hold the Amazon S3 file information about where the export is to be stored, you can use the [aws\_commons\.create\_s3\_uri](#aws_commons.create_s3_uri) function to create an `aws_commons._s3_uri_1` composite structure as follows\. - -``` -psql=> SELECT aws_commons.create_s3_uri( - 'sample-bucket', - 'sample-filepath', - 'us-west-2' -) AS s3_uri_1 \gset -``` - -You later provide this `s3_uri_1` value as a parameter in the call to the [aws\_s3\.query\_export\_to\_s3](#aws_s3.export_query_to_s3) function\. For examples, see [Exporting query data using the aws\_s3\.query\_export\_to\_s3 function](#postgresql-s3-export-examples)\. - -## Setting up access to an Amazon S3 bucket - -To export data to Amazon S3, give your PostgreSQL DB instance permission to access the Amazon S3 bucket that the files are to go in\. - -To do this, use the following procedure\. - -**To give a PostgreSQL DB instance access to Amazon S3 through an IAM role** - -1. Create an IAM policy\. - - This policy provides the bucket and object permissions that allow your PostgreSQL DB instance to access Amazon S3\. - - As part of creating this policy, take the following steps: - - 1. Include in the policy the following required actions to allow the transfer of files from your PostgreSQL DB instance to an Amazon S3 bucket: - + `s3:PutObject` - + `s3:AbortMultipartUpload` - - 1. Include the Amazon Resource Name \(ARN\) that identifies the Amazon S3 bucket and objects in the bucket\. The ARN format for accessing Amazon S3 is: `arn:aws:s3:::your-s3-bucket/*` - - For more information on creating an IAM policy for Amazon RDS for PostgreSQL, see [Creating and using an IAM policy for IAM database access](UsingWithRDS.IAMDBAuth.IAMPolicy.md)\. See also [Tutorial: Create and attach your first customer managed policy](https://docs.aws.amazon.com/IAM/latest/UserGuide/tutorial_managed-policies.html) in the *IAM User Guide*\. - - The following AWS CLI command creates an IAM policy named `rds-s3-export-policy` with these options\. It grants access to a bucket named `your-s3-bucket`\. -**Warning** -We recommend that you set up your database within a private VPC that has endpoint policies configured for accessing specific buckets\. For more information, see [ Using endpoint policies for Amazon S3](https://docs.aws.amazon.com/vpc/latest/userguide/vpc-endpoints-s3.html#vpc-endpoints-policies-s3) in the Amazon VPC User Guide\. -We strongly recommend that you do not create a policy with all\-resource access\. This access can pose a threat for data security\. If you create a policy that gives `S3:PutObject` access to all resources using `"Resource":"*"`, then a user with export privileges can export data to all buckets in your account\. In addition, the user can export data to *any publicly writable bucket within your AWS Region*\. - - After you create the policy, note the Amazon Resource Name \(ARN\) of the policy\. You need the ARN for a subsequent step when you attach the policy to an IAM role\. - - ``` - aws iam create-policy --policy-name rds-s3-export-policy --policy-document '{ - "Version": "2012-10-17", - "Statement": [ - { - "Sid": "s3export", - "Action": [ - "s3:PutObject", - "s3:AbortMultipartUpload" - ], - "Effect": "Allow", - "Resource": [ - "arn:aws:s3:::your-s3-bucket/*" - ] - } - ] - }' - ``` - -1. Create an IAM role\. - - You do this so Amazon RDS can assume this IAM role on your behalf to access your Amazon S3 buckets\. For more information, see [Creating a role to delegate permissions to an IAM user](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_create_for-user.html) in the *IAM User Guide*\. - - We recommend using the `[aws:SourceArn](https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies_condition-keys.html#condition-keys-sourcearn)` and `[aws:SourceAccount](https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies_condition-keys.html#condition-keys-sourceaccount)` global condition context keys in resource\-based policies to limit the service's permissions to a specific resource\. This is the most effective way to protect against the [confused deputy problem](https://docs.aws.amazon.com/IAM/latest/UserGuide/confused-deputy.html)\. - - If you use both global condition context keys and the `aws:SourceArn` value contains the account ID, the `aws:SourceAccount` value and the account in the `aws:SourceArn` value must use the same account ID when used in the same policy statement\. - + Use `aws:SourceArn` if you want cross\-service access for a single resource\. - + Use `aws:SourceAccount` if you want to allow any resource in that account to be associated with the cross\-service use\. - - In the policy, be sure to use the `aws:SourceArn` global condition context key with the full ARN of the resource\. The following example shows how to do so using the AWS CLI command to create a role named `rds-s3-export-role`\. -**Example** - - For Linux, macOS, or Unix: - - ``` - aws iam create-role \ - --role-name rds-s3-export-role \ - --assume-role-policy-document '{ - "Version": "2012-10-17", - "Statement": [ - { - "Effect": "Allow", - "Principal": { - "Service": "rds.amazonaws.com" - }, - "Action": "sts:AssumeRole", - "Condition": { - "StringEquals": { - "aws:SourceAccount": "111122223333", - "aws:SourceArn": "arn:aws:rds:us-east-1:111122223333:db:dbname" - } - } - } - ] - }' - ``` - - For Windows: - - ``` - aws iam create-role ^ - --role-name rds-s3-export-role ^ - --assume-role-policy-document '{ - "Version": "2012-10-17", - "Statement": [ - { - "Effect": "Allow", - "Principal": { - "Service": "rds.amazonaws.com" - }, - "Action": "sts:AssumeRole", - "Condition": { - "StringEquals": { - "aws:SourceAccount": "111122223333", - "aws:SourceArn": "arn:aws:rds:us-east-1:111122223333:db:dbname" - } - } - } - ] - }' - ``` - -1. Attach the IAM policy that you created to the IAM role that you created\. - - The following AWS CLI command attaches the policy created earlier to the role named `rds-s3-export-role.` Replace `your-policy-arn` with the policy ARN that you noted in an earlier step\. - - ``` - aws iam attach-role-policy --policy-arn your-policy-arn --role-name rds-s3-export-role - ``` - -1. Add the IAM role to the DB instance\. You do so by using the AWS Management Console or AWS CLI, as described following\. - -### Console - -**To add an IAM role for a PostgreSQL DB instance using the console** - -1. Sign in to the AWS Management Console and open the Amazon RDS console at [https://console\.aws\.amazon\.com/rds/](https://console.aws.amazon.com/rds/)\. - -1. Choose the PostgreSQL DB instance name to display its details\. - -1. On the **Connectivity & security** tab, in the **Manage IAM roles **section, choose the role to add under **Add IAM roles to this instance**\. - -1. Under **Feature**, choose **s3Export**\. - -1. Choose **Add role**\. - -### AWS CLI - -**To add an IAM role for a PostgreSQL DB instance using the CLI** -+ Use the following command to add the role to the PostgreSQL DB instance named `my-db-instance`\. Replace *`your-role-arn`* with the role ARN that you noted in a previous step\. Use `s3Export` for the value of the `--feature-name` option\. -**Example** - - For Linux, macOS, or Unix: - - ``` - aws rds add-role-to-db-instance \ - --db-instance-identifier my-db-instance \ - --feature-name s3Export \ - --role-arn your-role-arn \ - --region your-region - ``` - - For Windows: - - ``` - aws rds add-role-to-db-instance ^ - --db-instance-identifier my-db-instance ^ - --feature-name s3Export ^ - --role-arn your-role-arn ^ - --region your-region - ``` - -## Exporting query data using the aws\_s3\.query\_export\_to\_s3 function - -Export your PostgreSQL data to Amazon S3 by calling the [aws\_s3\.query\_export\_to\_s3](#aws_s3.export_query_to_s3) function\. - -**Topics** -+ [Prerequisites](#postgresql-s3-export-examples-prerequisites) -+ [Calling aws\_s3\.query\_export\_to\_s3](#postgresql-s3-export-examples-basic) -+ [Exporting to a CSV file that uses a custom delimiter](#postgresql-s3-export-examples-custom-delimiter) -+ [Exporting to a binary file with encoding](#postgresql-s3-export-examples-encoded) - -### Prerequisites - -Before you use the `aws_s3.query_export_to_s3` function, be sure to complete the following prerequisites: -+ Install the required PostgreSQL extensions as described in [Overview of exporting data to Amazon S3](#postgresql-s3-export-overview)\. -+ Determine where to export your data to Amazon S3 as described in [Specifying the Amazon S3 file path to export to](#postgresql-s3-export-file)\. -+ Make sure that the DB instance has export access to Amazon S3 as described in [Setting up access to an Amazon S3 bucket](#postgresql-s3-export-access-bucket)\. - -The examples following use a database table called `sample_table`\. These examples export the data into a bucket called `sample-bucket`\. The example table and data are created with the following SQL statements in psql\. - -``` -psql=> CREATE TABLE sample_table (bid bigint PRIMARY KEY, name varchar(80)); -psql=> INSERT INTO sample_table (bid,name) VALUES (1, 'Monday'), (2,'Tuesday'), (3, 'Wednesday'); -``` - -### Calling aws\_s3\.query\_export\_to\_s3 - -The following shows the basic ways of calling the [aws\_s3\.query\_export\_to\_s3](#aws_s3.export_query_to_s3) function\. - -These examples use the variable `s3_uri_1` to identify a structure that contains the information identifying the Amazon S3 file\. Use the [aws\_commons\.create\_s3\_uri](#aws_commons.create_s3_uri) function to create the structure\. - -``` -psql=> SELECT aws_commons.create_s3_uri( - 'sample-bucket', - 'sample-filepath', - 'us-west-2' -) AS s3_uri_1 \gset -``` - -Although the parameters vary for the following two `aws_s3.query_export_to_s3` function calls, the results are the same for these examples\. All rows of the `sample_table` table are exported into a bucket called `sample-bucket`\. - -``` -psql=> SELECT * FROM aws_s3.query_export_to_s3('SELECT * FROM sample_table', :'s3_uri_1'); - -psql=> SELECT * FROM aws_s3.query_export_to_s3('SELECT * FROM sample_table', :'s3_uri_1', options :='format text'); -``` - -The parameters are described as follows: -+ `'SELECT * FROM sample_table'` – The first parameter is a required text string containing an SQL query\. The PostgreSQL engine runs this query\. The results of the query are copied to the S3 bucket identified in other parameters\. -+ `:'s3_uri_1'` – This parameter is a structure that identifies the Amazon S3 file\. This example uses a variable to identify the previously created structure\. You can instead create the structure by including the `aws_commons.create_s3_uri` function call inline within the `aws_s3.query_export_to_s3` function call as follows\. - - ``` - SELECT * from aws_s3.query_export_to_s3('select * from sample_table', - aws_commons.create_s3_uri('sample-bucket', 'sample-filepath', 'us-west-2') - ); - ``` -+ `options :='format text'` – The `options` parameter is an optional text string containing PostgreSQL `COPY` arguments\. The copy process uses the arguments and format of the [PostgreSQL COPY](https://www.postgresql.org/docs/current/sql-copy.html) command\. - -If the file specified doesn't exist in the Amazon S3 bucket, it's created\. If the file already exists, it's overwritten\. The syntax for accessing the exported data in Amazon S3 is the following\. - -``` -s3-region://bucket-name[/path-prefix]/file-prefix -``` - -Larger exports are stored in multiple files, each with a maximum size of approximately 6 GB\. The additional file names have the same file prefix but with `_partXX` appended\. The `XX` represents 2, then 3, and so on\. For example, suppose that you specify the path where you store data files as the following\. - -``` -s3-us-west-2://my-bucket/my-prefix -``` - -If the export has to create three data files, the Amazon S3 bucket contains the following data files\. - -``` -s3-us-west-2://my-bucket/my-prefix -s3-us-west-2://my-bucket/my-prefix_part2 -s3-us-west-2://my-bucket/my-prefix_part3 -``` - -For the full reference for this function and additional ways to call it, see [aws\_s3\.query\_export\_to\_s3](#aws_s3.export_query_to_s3)\. For more about accessing files in Amazon S3, see [View an object](https://docs.aws.amazon.com/AmazonS3/latest/gsg/OpeningAnObject.html) in the *Amazon Simple Storage Service User Guide*\. - -### Exporting to a CSV file that uses a custom delimiter - -The following example shows how to call the [aws\_s3\.query\_export\_to\_s3](#aws_s3.export_query_to_s3) function to export data to a file that uses a custom delimiter\. The example uses arguments of the [PostgreSQL COPY](https://www.postgresql.org/docs/current/sql-copy.html) command to specify the comma\-separated value \(CSV\) format and a colon \(:\) delimiter\. - -``` -SELECT * from aws_s3.query_export_to_s3('select * from basic_test', :'s3_uri_1', options :='format csv, delimiter $$:$$'); -``` - -### Exporting to a binary file with encoding - -The following example shows how to call the [aws\_s3\.query\_export\_to\_s3](#aws_s3.export_query_to_s3) function to export data to a binary file that has Windows\-1253 encoding\. - -``` -SELECT * from aws_s3.query_export_to_s3('select * from basic_test', :'s3_uri_1', options :='format binary, encoding WIN1253'); -``` - -## Troubleshooting access to Amazon S3 - -If you encounter connection problems when attempting to export data to Amazon S3, first confirm that the outbound access rules for the VPC security group associated with your DB instance permit network connectivity\. Specifically, the security group must have a rule that allows the DB instance to send TCP traffic to port 443 and to any IPv4 addresses \(0\.0\.0\.0/0\)\. For more information, see [Provide access to your DB instance in your VPC by creating a security group](CHAP_SettingUp.md#CHAP_SettingUp.SecurityGroup)\. - -See also the following for recommendations: -+ [Troubleshooting Amazon RDS identity and access](security_iam_troubleshoot.md) -+ [Troubleshooting Amazon S3](https://docs.aws.amazon.com/AmazonS3/latest/dev/troubleshooting.html) in the *Amazon Simple Storage Service User Guide* -+ [Troubleshooting Amazon S3 and IAM](https://docs.aws.amazon.com/IAM/latest/UserGuide/troubleshoot_iam-s3.html) in the *IAM User Guide* - -## Function reference - -**Topics** -+ [aws\_s3\.query\_export\_to\_s3](#aws_s3.export_query_to_s3) -+ [aws\_commons\.create\_s3\_uri](#aws_commons.create_s3_uri) - -### aws\_s3\.query\_export\_to\_s3 - -Exports a PostgreSQL query result to an Amazon S3 bucket\. The `aws_s3` extension provides the `aws_s3.query_export_to_s3` function\. - -The two required parameters are `query` and `s3_info`\. These define the query to be exported and identify the Amazon S3 bucket to export to\. An optional parameter called `options` provides for defining various export parameters\. For examples of using the `aws_s3.query_export_to_s3` function, see [Exporting query data using the aws\_s3\.query\_export\_to\_s3 function](#postgresql-s3-export-examples)\. - -**Syntax** - -``` -aws_s3.query_export_to_s3( - query text, - s3_info aws_commons._s3_uri_1, - options text -) -```Input parameters - -*query* -A required text string containing an SQL query that the PostgreSQL engine runs\. The results of this query are copied to an S3 bucket identified in the `s3_info` parameter\. - -*s3\_info* -An `aws_commons._s3_uri_1` composite type containing the following information about the S3 object: -+ `bucket` – The name of the Amazon S3 bucket to contain the file\. -+ `file_path` – The Amazon S3 file name and path\. -+ `region` – The AWS Region that the bucket is in\. For a listing of AWS Region names and associated values, see [Regions, Availability Zones, and Local Zones](Concepts.RegionsAndAvailabilityZones.md)\. - - Currently, this value must be the same AWS Region as that of the exporting DB instance\. The default is the AWS Region of the exporting DB instance\. -To create an `aws_commons._s3_uri_1` composite structure, see the [aws\_commons\.create\_s3\_uri](#aws_commons.create_s3_uri) function\. - -*options* -An optional text string containing arguments for the PostgreSQL `COPY` command\. These arguments specify how the data is to be copied when exported\. For more details, see the [PostgreSQL COPY documentation](https://www.postgresql.org/docs/current/sql-copy.html)\. - -#### Alternate input parameters - -To help with testing, you can use an expanded set of parameters instead of the `s3_info` parameter\. Following are additional syntax variations for the `aws_s3.query_export_to_s3` function\. - -Instead of using the `s3_info` parameter to identify an Amazon S3 file, use the combination of the `bucket`, `file_path`, and `region` parameters\. - -``` -aws_s3.query_export_to_s3( - query text, - bucket text, - file_path text, - region text, - options text -) -``` - -*query* -A required text string containing an SQL query that the PostgreSQL engine runs\. The results of this query are copied to an S3 bucket identified in the `s3_info` parameter\. - -*bucket* -A required text string containing the name of the Amazon S3 bucket that contains the file\. - -*file\_path* -A required text string containing the Amazon S3 file name including the path of the file\. - -*region* -An optional text string containing the AWS Region that the bucket is in\. For a listing of AWS Region names and associated values, see [Regions, Availability Zones, and Local Zones](Concepts.RegionsAndAvailabilityZones.md)\. -Currently, this value must be the same AWS Region as that of the exporting DB instance\. The default is the AWS Region of the exporting DB instance\. - -*options* -An optional text string containing arguments for the PostgreSQL `COPY` command\. These arguments specify how the data is to be copied when exported\. For more details, see the [PostgreSQL COPY documentation](https://www.postgresql.org/docs/current/sql-copy.html)\. - -#### Output parameters - -``` -aws_s3.query_export_to_s3( - OUT rows_uploaded bigint, - OUT files_uploaded bigint, - OUT bytes_uploaded bigint -) -``` - -*rows\_uploaded* -The number of table rows that were successfully uploaded to Amazon S3 for the given query\. - -*files\_uploaded* -The number of files uploaded to Amazon S3\. Files are created in sizes of approximately 6 GB\. Each additional file created has `_partXX` appended to the name\. The `XX` represents 2, then 3, and so on as needed\. - -*bytes\_uploaded* -The total number of bytes uploaded to Amazon S3\. - -#### Examples - -``` -psql=> SELECT * from aws_s3.query_export_to_s3('select * from sample_table', 'sample-bucket', 'sample-filepath'); -psql=> SELECT * from aws_s3.query_export_to_s3('select * from sample_table', 'sample-bucket', 'sample-filepath','us-west-2'); -psql=> SELECT * from aws_s3.query_export_to_s3('select * from sample_table', 'sample-bucket', 'sample-filepath','us-west-2','format text'); -``` - -### aws\_commons\.create\_s3\_uri - -Creates an `aws_commons._s3_uri_1` structure to hold Amazon S3 file information\. You use the results of the `aws_commons.create_s3_uri` function in the `s3_info` parameter of the [aws\_s3\.query\_export\_to\_s3](#aws_s3.export_query_to_s3) function\. For an example of using the `aws_commons.create_s3_uri` function, see [Specifying the Amazon S3 file path to export to](#postgresql-s3-export-file)\. - -**Syntax** - -``` -aws_commons.create_s3_uri( - bucket text, - file_path text, - region text -) -```Input parameters - -*bucket* -A required text string containing the Amazon S3 bucket name for the file\. - -*file\_path* -A required text string containing the Amazon S3 file name including the path of the file\. - -*region* -A required text string containing the AWS Region that the file is in\. For a listing of AWS Region names and associated values, see [Regions, Availability Zones, and Local Zones](Concepts.RegionsAndAvailabilityZones.md)\. \ No newline at end of file diff --git a/doc_source/proactive-insights.idle-txn.md b/doc_source/proactive-insights.idle-txn.md deleted file mode 100644 index adf0b46..0000000 --- a/doc_source/proactive-insights.idle-txn.md +++ /dev/null @@ -1,98 +0,0 @@ -# Database has long running idle in transaction connection - -A connection to the database has been in the `idle in transaction` state for more than 1800 seconds\. - -**Topics** -+ [Supported engine versions](#proactive-insights.idle-txn.context.supported) -+ [Context](#proactive-insights.idle-txn.context) -+ [Likely causes for this issue](#proactive-insights.idle-txn.causes) -+ [Actions](#proactive-insights.idle-txn.actions) -+ [Relevant metrics](#proactive-insights.idle-txn.metrics) - -## Supported engine versions - -This insight information is supported for all versions of RDS for PostgreSQL\. - -## Context - -A transaction in the `idle in transaction` state can hold locks that block other queries\. It can also prevent `VACUUM` \(including autovacuum\) from cleaning up dead rows, leading to index or table bloat or transaction ID wraparound\. - -## Likely causes for this issue - -A transaction initiated in an interactive session with BEGIN or START TRANSACTION hasn't ended by using a COMMIT, ROLLBACK, or END command\. This causes the transaction to move to `idle in transaction` state\. - -## Actions - -### - -You can find idle transactions by querying `pg_stat_activity`\. - -In your SQL client, run the following query to list all connections in `idle in transaction` state and to order them by duration: - -``` -SELECT now() - xact_start as duration ,* -FROM pg_stat_activity -WHERE state = 'idle in transaction' -AND xact_start is not null -ORDER BY 1 DESC; -``` - -### - -We recommend different actions depending on the causes of your insight\. - -**Topics** -+ [End transaction](#proactive-insights.idle-txn.actions.end-txn) -+ [Terminate the connection](#proactive-insights.idle-txn.actions.end-connection) -+ [Configure the idle\_in\_transaction\_session\_timeout parameter](#proactive-insights.idle-txn.actions.parameter) -+ [Check the AUTOCOMMIT status](#proactive-insights.idle-txn.actions.autocommit) -+ [Check the transaction logic in your application code](#proactive-insights.idle-txn.actions.app-logic) - -#### End transaction - -When you initiate a transaction in an interactive session with BEGIN or START TRANSACTION, it moves to `idle in transaction` state\. It remains in this state until you end the transaction by issuing a COMMIT, ROLLBACK, END command or disconnect the connection completely to roll back the transaction\. - -#### Terminate the connection - -Terminate the connection with an idle transaction using the following query: - -``` -SELECT pg_terminate_backend(pid); -``` - -pid is the process ID of the connection\. - -#### Configure the idle\_in\_transaction\_session\_timeout parameter - -Configure the `idle_in_transaction_session_timeout` parameter in the parameter group\. The advantage of configuring this parameter is that it does not require a manual intervention to terminate the long idle in transaction\. For more information on this parameter, see [the PostgreSQL documentation](https://www.postgresql.org/docs/current/runtime-config-client.html)\. - -The following message will be reported in the PostgreSQL log file after the connection is terminated and when there is an open transaction for longer than the specified time\. - -``` -FATAL: terminating connection due to idle in transaction timeout -``` - -#### Check the AUTOCOMMIT status - -AUTOCOMMIT is turned on by default\. But if it is accidentally turned off in the client ensure that you turn it back on\. -+ In your psql client, run the following command: - - ``` - postgres=> \set AUTOCOMMIT on - ``` -+ In pgadmin, turn it on by choosing the AUTOCOMMIT option from the down arrow\. -![\[In pgadmin, choose AUTOCOMMIT to turn it on.\]](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/images/apg-insight-pgadmin-autocommit.png) - -#### Check the transaction logic in your application code - -Investigate your application logic for possible problems\. Consider the following actions: -+ Check if the JDBC auto commit is set true in your application\. Also, consider using explicit `COMMIT` commands in your code\. -+ Check your error handling logic to see whether it closes a transaction after errors\. -+ Check whether your application is taking long to process the rows returned by a query while the transaction is open\. If so, consider coding the application to close the transaction before processing the rows\. -+ Check whether a transaction contains many long\-running operations\. If so, divide a single transaction into multiple transactions\. - -## Relevant metrics - -The following PI metrics are related to this insight: -+ idle\_in\_transaction\_count \- Number of sessions in `idle in transaction` state\. -+ idle\_in\_transaction\_max\_time \- The duration of the longest running transaction in the `idle in transaction` state\. \ No newline at end of file diff --git a/doc_source/publishing_cloudwatchlogs.md b/doc_source/publishing_cloudwatchlogs.md deleted file mode 100644 index 01ca422..0000000 --- a/doc_source/publishing_cloudwatchlogs.md +++ /dev/null @@ -1,85 +0,0 @@ -# Publishing database engine logs to Amazon CloudWatch Logs - -You can configure your Amazon RDS database engine to publish log data to a log group in Amazon CloudWatch Logs\. With CloudWatch Logs, you can perform real\-time analysis of the log data, and use CloudWatch to create alarms and view metrics\. You can use CloudWatch Logs to store your log records in highly durable storage, which you can manage with the CloudWatch Logs Agent\. For example, you can determine when to rotate log records from a host to the log service, so you can access the raw logs when you need to\. - -For engine\-specific information, see the following topics: -+ [Publishing MariaDB logs to Amazon CloudWatch Logs](USER_LogAccess.Concepts.MariaDB.md#USER_LogAccess.MariaDB.PublishtoCloudWatchLogs) -+ [Publishing MySQL logs to Amazon CloudWatch Logs](USER_LogAccess.Concepts.MySQL.md#USER_LogAccess.MySQLDB.PublishtoCloudWatchLogs) -+ [Publishing Oracle logs to Amazon CloudWatch Logs](USER_LogAccess.Concepts.Oracle.md#USER_LogAccess.Oracle.PublishtoCloudWatchLogs) -+ [Publishing PostgreSQL logs to Amazon CloudWatch Logs](USER_LogAccess.Concepts.PostgreSQL.md#USER_LogAccess.Concepts.PostgreSQL.PublishtoCloudWatchLogs) -+ [Publishing SQL Server logs to Amazon CloudWatch Logs](USER_LogAccess.Concepts.SQLServer.md#USER_LogAccess.SQLServer.PublishtoCloudWatchLogs) - -**Note** -Before you enable log data publishing, make sure that you have a service\-linked role in AWS Identity and Access Management \(IAM\)\. For more information about service\-linked roles, see [Using service\-linked roles for Amazon RDS](UsingWithRDS.IAM.ServiceLinkedRoles.md)\. - -## Configuring CloudWatch log integration - -To publish your database log files to CloudWatch Logs, choose which logs to publish\. Make this choice in the **Advanced Settings** section when you create a new DB instance\. You can also modify an existing DB instance to begin publishing\. - -![\[Add CloudWatch Logs\]](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/images/AddCWLogs.png) - - After you have enabled publishing, Amazon RDS continuously streams all of the DB instance log records to a log group\. For example, you have a log group `/aws/rds/instance/log type` for each type of log that you publish\. This log group is in the same AWS Region as the database instance that generates the log\. - -After you have published log records, you can use CloudWatch Logs to search and filter the records\. For more information about searching and filtering logs, see [Searching and filtering log data](https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/MonitoringLogData.html)\. For a tutorial explaining how to monitor RDS logs, see [Build proactive database monitoring for Amazon RDS with Amazon CloudWatch Logs, AWS Lambda, and Amazon SNS](https://aws.amazon.com/blogs/database/build-proactive-database-monitoring-for-amazon-rds-with-amazon-cloudwatch-logs-aws-lambda-and-amazon-sns/)\. - -## Viewing DB instance metrics - -Amazon RDS provides metrics so that you can monitor the health of your DB instances\. You can monitor both DB instance metrics and operating system \(OS\) metrics\. - -Following, you can find details about how to view metrics for your DB instance using the RDS console and CloudWatch\. For information on monitoring metrics for your DB instance's operating system in real time using CloudWatch Logs, see [Using Enhanced Monitoring](USER_Monitoring.OS.md)\. - -### Viewing metrics by using the console - -**To view DB and OS metrics for a DB instance** - -1. Sign in to the AWS Management Console and open the Amazon RDS console at [https://console\.aws\.amazon\.com/rds/](https://console.aws.amazon.com/rds/)\. - -1. In the navigation pane, choose **Databases**\. - -1. Choose the name of the DB instance that you need information about to show its details\. - -1. Choose the **Monitoring** tab\. - -1. For **Monitoring**, choose the option for how you want to view your metrics from these: - + **CloudWatch** – Shows a summary of DB instance metrics available from Amazon CloudWatch\. Each metric includes a graph showing the metric monitored over a specific time span\. - + **Enhanced monitoring** – Shows a summary of OS metrics available for a DB instance with Enhanced Monitoring enabled\. Each metric includes a graph showing the metric monitored over a specific time span\. - + **OS Process list** – Shows details for each process running in the selected instance\. - + **Performance Insights** – Opens the Amazon RDS Performance Insights console for your DB instance\. - - -![\[RDS metrics viewing options\]](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/images/metrics0.png) -**Tip** -To choose the time range of the metrics represented by the graphs, you can use the time range list\. -To bring up a more detailed view, you can choose any graph\. You can also apply metric\-specific filters to the data\. - -### Viewing DB instance metrics with the CLI or API - -Amazon RDS integrates with CloudWatch metrics to provide a variety of DB instance metrics\. You can view CloudWatch metrics using the RDS console, AWS CLI, or API\. - - For a complete list of Amazon RDS metrics, go to [ Amazon RDS dimensions and metrics](https://docs.aws.amazon.com/AmazonCloudWatch/latest/DeveloperGuide/rds-metricscollected.html) in the *Amazon CloudWatch User Guide*\. - -#### Viewing DB metrics by using the CloudWatch CLI - -**Note** -The following CLI example requires the CloudWatch command line tools\. For more information on CloudWatch and to download the developer tools, see [Amazon CloudWatch](https://aws.amazon.com/cloudwatch) on the AWS website\. The `StartTime` and `EndTime` values supplied in this example are for illustration only\. Substitute appropriate start and end time values for your DB instance\. - -**To view usage and performance statistics for a DB instance** -+ Use the CloudWatch command `mon-get-stats` with the following parameters\. - - ``` - 1. PROMPT>mon-get-stats FreeStorageSpace --dimensions="DBInstanceIdentifier=mydbinstance" --statistics= Average - 2. --namespace="AWS/RDS" --start-time 2009-10-16T00:00:00 --end-time 2009-10-16T00:02:00 - ``` - -#### Viewing DB metrics by using the CloudWatch API - -The `StartTime` and `EndTime` values supplied in this example are for illustration only\. Substitute appropriate start and end time values for your DB instance\. - -**To view usage and performance statistics for a DB instance** -+ Call the CloudWatch API `GetMetricStatistics` with the following parameters: - + `Statistics.member.1` = `Average` - + `Namespace` = `AWS/RDS` - + `StartTime` = `2009-10-16T00:00:00` - + `EndTime` = `2009-10-16T00:02:00` - + `Period` = `60` - + `MeasureName` = `FreeStorageSpace` \ No newline at end of file diff --git a/doc_source/rds-cloud-watch-events.md b/doc_source/rds-cloud-watch-events.md deleted file mode 100644 index 7f507a3..0000000 --- a/doc_source/rds-cloud-watch-events.md +++ /dev/null @@ -1,197 +0,0 @@ -# Creating a rule that triggers on an Amazon RDS event - -Using Amazon CloudWatch Events and Amazon EventBridge, you can automate AWS services and respond to system events such as application availability issues or resource changes\. - -**Topics** -+ [Creating rules to send Amazon RDS events to CloudWatch Events](#rds-cloudwatch-events.sending-to-cloudwatch-events) -+ [Tutorial: Log DB instance state changes using Amazon EventBridge](#log-rds-instance-state) - -## Creating rules to send Amazon RDS events to CloudWatch Events - -You can write simple rules to indicate which Amazon RDS events interest you and which automated actions to take when an event matches a rule\. You can set a variety of targets, such as an AWS Lambda function or an Amazon SNS topic, which receive events in JSON format\. For example, you can configure Amazon RDS to send events to CloudWatch Events or Amazon EventBridge whenever a DB instance is created or deleted\. For more information, see the [Amazon CloudWatch Events User Guide](https://docs.aws.amazon.com/AmazonCloudWatch/latest/events/) and the [Amazon EventBridge User Guide](https://docs.aws.amazon.com/eventbridge/latest/userguide/)\. - -**To create a rule that triggers on an RDS event:** - -1. Open the CloudWatch console at [https://console\.aws\.amazon\.com/cloudwatch/](https://console.aws.amazon.com/cloudwatch/)\. - -1. Under **Events** in the navigation pane, choose **Rules**\. - -1. Choose **Create rule**\. - -1. For **Event Source**, do the following: - - 1. Choose **Event Pattern**\. - - 1. For **Service Name**, choose **Relational Database Service \(RDS\)**\. - - 1. For **Event Type**, choose the type of Amazon RDS resource that triggers the event\. For example, if a DB instance triggers the event, choose **RDS DB Instance Event**\. - -1. For **Targets**, choose **Add Target** and choose the AWS service that is to act when an event of the selected type is detected\. - -1. In the other fields in this section, enter information specific to this target type, if any is needed\. - -1. For many target types, CloudWatch Events needs permissions to send events to the target\. In these cases, CloudWatch Events can create the IAM role needed for your event to run: - + To create an IAM role automatically, choose **Create a new role for this specific resource**\. - + To use an IAM role that you created before, choose **Use existing role**\. - -1. Optionally, repeat steps 5\-7 to add another target for this rule\. - -1. Choose **Configure details**\. For **Rule definition**, type a name and description for the rule\. - - The rule name must be unique within this Region\. - -1. Choose **Create rule**\. - -For more information, see [Creating a CloudWatch Events Rule That Triggers on an Event](https://docs.aws.amazon.com/AmazonCloudWatch/latest/events/Create-CloudWatch-Events-Rule.html) in the *Amazon CloudWatch User Guide*\. - -## Tutorial: Log DB instance state changes using Amazon EventBridge - -In this tutorial, you create an AWS Lambda function that logs the state changes for an Amazon RDS instance\. You then create a rule that runs the function whenever there is a state change of an existing RDS DB instance\. The tutorial assumes that you have a small running test instance that you can shut down temporarily\. - -**Important** -Don't perform this tutorial on a running production DB instance\. - -**Topics** -+ [Step 1: Create an AWS Lambda function](#rds-create-lambda-function) -+ [Step 2: Create a rule](#rds-create-rule) -+ [Step 3: Test the rule](#rds-test-rule) - -### Step 1: Create an AWS Lambda function - -Create a Lambda function to log the state change events\. You specify this function when you create your rule\. - -**To create a Lambda function** - -1. Open the AWS Lambda console at [https://console\.aws\.amazon\.com/lambda/](https://console.aws.amazon.com/lambda/)\. - -1. If you're new to Lambda, you see a welcome page\. Choose **Get Started Now**\. Otherwise, choose **Create function**\. - -1. Choose **Author from scratch**\. - -1. On the **Create function** page, do the following: - - 1. Enter a name and description for the Lambda function\. For example, name the function **RDSInstanceStateChange**\. - - 1. In **Runtime**, select **Node\.js 16x**\. - - 1. For **Architecture**, choose **x86\_64**\. - - 1. For **Execution role**, do either of the following: - + Choose **Create a new role with basic Lambda permissions**\. - + For **Existing role**, choose **Use an existing role**\. Choose the role that you want to use\. - - 1. Choose **Create function**\. - -1. On the **RDSInstanceStateChange** page, do the following: - - 1. In **Code source**, select **index\.js**\. - - 1. In the **index\.js** pane, delete the existing code\. - - 1. Enter the following code: - - ``` - console.log('Loading function'); - - exports.handler = async (event, context) => { - console.log('Received event:', JSON.stringify(event)); - }; - ``` - - 1. Choose **Deploy**\. - -### Step 2: Create a rule - -Create a rule to run your Lambda function whenever you launch an Amazon RDS instance\. - -**To create the EventBridge rule** - -1. Open the Amazon EventBridge console at [https://console\.aws\.amazon\.com/events/](https://console.aws.amazon.com/events/)\. - -1. In the navigation pane, choose **Rules**\. - -1. Choose **Create rule**\. - -1. Enter a name and description for the rule\. For example, enter **RDSInstanceStateChangeRule**\. - -1. Choose **Rule with an event pattern**, and then choose **Next**\. - -1. For **Event source**, choose **AWS events or EventBridge partner events**\. - -1. Scroll down to the **Event pattern** section\. - -1. For **Event source**, choose **AWS services**\. - -1. For **AWS service**, choose **Relational Database Service \(RDS\)**\. - -1. For **Event type**, choose **RDS DB Instance Event**\. - -1. Leave the default event pattern\. Then choose **Next**\. - -1. For **Target types**, choose **AWS service**\. - -1. For **Select a target**, choose **Lambda function**\. - -1. For **Function**, choose the Lambda function that you created\. Then choose **Next**\. - -1. In **Configure tags**, choose **Next**\. - -1. Review the steps in your rule\. Then choose **Create rule**\. - -### Step 3: Test the rule - -To test your rule, shut down an RDS DB instance\. After waiting a few minutes for the instance to shut down, verify that your Lambda function was invoked\. - -**To test your rule by stopping a DB instance** - -1. Open the Amazon RDS console at [https://console\.aws\.amazon\.com/rds/](https://console.aws.amazon.com/rds/)\. - -1. Stop an RDS DB instance\. - -1. Open the Amazon EventBridge console at [https://console\.aws\.amazon\.com/events/](https://console.aws.amazon.com/events/)\. - -1. In the navigation pane, choose **Rules**, choose the name of the rule that you created\. - -1. In **Rule details**, choose **Monitoring**\. - - You are redirected to the Amazon CloudWatch console\. If you are not redirected, click **View the metrics in CloudWatch**\. - -1. In **All metrics**, choose the name of the rule that you created\. - - The graph should indicate that the rule was invoked\. - -1. In the navigation pane, choose **Log groups**\. - -1. Choose the name of the log group for your Lambda function \(**/aws/lambda/*function\-name***\)\. - -1. Choose the name of the log stream to view the data provided by the function for the instance that you launched\. You should see a received event similar to the following: - - ``` - { - "version": "0", - "id": "12a345b6-78c9-01d2-34e5-123f4ghi5j6k", - "detail-type": "RDS DB Instance Event", - "source": "aws.rds", - "account": "111111111111", - "time": "2021-03-19T19:34:09Z", - "region": "us-east-1", - "resources": [ - "arn:aws:rds:us-east-1:111111111111:db:testdb" - ], - "detail": { - "EventCategories": [ - "notification" - ], - "SourceType": "DB_INSTANCE", - "SourceArn": "arn:aws:rds:us-east-1:111111111111:db:testdb", - "Date": "2021-03-19T19:34:09.293Z", - "Message": "DB instance stopped", - "SourceIdentifier": "testdb", - "EventID": "RDS-EVENT-0087" - } - } - ``` - - For more examples of RDS events in JSON format, see [Overview of events for Amazon RDS](rds-cloudwatch-events.sample.md)\. - -1. \(Optional\) When you're finished, you can open the Amazon RDS console and start the instance that you stopped\. \ No newline at end of file diff --git a/doc_source/rds-cloudwatch-events.sample.md b/doc_source/rds-cloudwatch-events.sample.md deleted file mode 100644 index 7f6a59b..0000000 --- a/doc_source/rds-cloudwatch-events.sample.md +++ /dev/null @@ -1,32 +0,0 @@ -# Overview of events for Amazon RDS - -An *RDS event* indicates a change in the Amazon RDS environment\. For example, Amazon RDS generates an event when the state of a DB instance changes from pending to running\. Amazon RDS delivers events to CloudWatch Events and EventBridge in near\-real time\. - -**Note** -Amazon RDS emits events on a best effort basis\. We recommend that you avoid writing programs that depend on the order or existence of notification events, because they might be out of sequence or missing\. - -Amazon RDS records events that relate to the following resources: -+ DB instances - - For a list of DB instance events, see [DB instance events](USER_Events.Messages.md#USER_Events.Messages.instance)\. -+ DB parameter groups - - For a list of DB parameter group events, see [DB parameter group events](USER_Events.Messages.md#USER_Events.Messages.parameter-group)\. -+ DB security groups - - For a list of DB security group events, see [DB security group events](USER_Events.Messages.md#USER_Events.Messages.security-group)\. -+ DB snapshots - - For a list of DB snapshot events, see [DB snapshot events](USER_Events.Messages.md#USER_Events.Messages.snapshot)\. -+ RDS Proxy events - - For a list of RDS Proxy events, see [RDS Proxy events](USER_Events.Messages.md#USER_Events.Messages.rds-proxy)\. -+ Blue/green deployment events - - For a list of blue/green deployment events, see [Blue/green deployment events](USER_Events.Messages.md#USER_Events.Messages.BlueGreenDeployments)\. - -This information includes the following: -+ The date and time of the event -+ The source name and source type of the event -+ A message associated with the event -+ Event notifications include tags from when the message was sent and may not reflect tags at the time when the event occurred \ No newline at end of file diff --git a/doc_source/rds-custom.md b/doc_source/rds-custom.md deleted file mode 100644 index ecb18f4..0000000 --- a/doc_source/rds-custom.md +++ /dev/null @@ -1,112 +0,0 @@ -# Working with Amazon RDS Custom - -Amazon RDS Custom automates database administration tasks and operations\. RDS Custom makes it possible for you as a database administrator to access and customize your database environment and operating system\. With RDS Custom, you can customize to meet the requirements of legacy, custom, and packaged applications\. - -For the latest webinars and blogs about RDS Custom, see [Amazon RDS Custom resources](http://aws.amazon.com/rds/custom/resources/)\. - -**Topics** -+ [Addressing the challenge of database customization](#custom-intro.challenge) -+ [Management model and benefits for Amazon RDS Custom](#custom-intro.solution) -+ [Amazon RDS Custom architecture](custom-concept.md) -+ [Security in Amazon RDS Custom](custom-security.md) -+ [Working with RDS Custom for Oracle](working-with-custom-oracle.md) -+ [Working with RDS Custom for SQL Server](working-with-custom-sqlserver.md) -+ [Troubleshooting DB issues for Amazon RDS Custom](custom-troubleshooting.md) - -## Addressing the challenge of database customization - -Amazon RDS Custom brings the benefits of Amazon RDS to a market that can't easily move to a fully managed service because of customizations that are required with third\-party applications\. Amazon RDS Custom saves administrative time, is durable, and scales with your business\. - -If you need the entire database and operating system to be fully managed by AWS, we recommend Amazon RDS\. If you need administrative rights to the database and underlying operating system to make dependent applications available, Amazon RDS Custom is the better choice\. If you want full management responsibility and simply need a managed compute service, the best option is self\-managing your commercial databases on Amazon EC2\. - -To deliver a managed service experience, Amazon RDS doesn't let you access the underlying host\. Amazon RDS also restricts access to some procedures and objects that require high\-level privileges\. However, for some applications, you might need to perform operations as a privileged operating system \(OS\) user\. - -For example, you might need to do the following: -+ Install custom database and OS patches and packages\. -+ Configure specific database settings\. -+ Configure file systems to share files directly with their applications\. - -Previously, if you needed to customize your application, you had to deploy your database on\-premises or on Amazon EC2\. In this case, you bear most or all of the responsibility for database management, as summarized in the following table\. - - -| Feature | On\-premises responsibility | Amazon EC2 responsibility | Amazon RDS responsibility | -| --- | --- | --- | --- | -| Application optimization | Customer | Customer | Customer | -| Scaling | Customer | Customer | AWS | -| High availability | Customer | Customer | AWS | -| Database backups | Customer | Customer | AWS | -| Database software patching | Customer | Customer | AWS | -| Database software install | Customer | Customer | AWS | -| OS patching | Customer | Customer | AWS | -| OS installation | Customer | Customer | AWS | -| Server maintenance | Customer | AWS | AWS | -| Hardware lifecycle | Customer | AWS | AWS | -| Power, network, and cooling | Customer | AWS | AWS | - -When you manage database software yourself, you gain more control, but you're also more prone to user errors\. For example, when you make changes manually, you might accidentally cause application downtime\. You might spend hours checking every change to identify and fix an issue\. Ideally, you want a managed database service that automates common DBA tasks, but also supports privileged access to the database and underlying operating system\. - -## Management model and benefits for Amazon RDS Custom - -Amazon RDS Custom is a managed database service for legacy, custom, and packaged applications that require access to the underlying operating system and database environment\. Amazon RDS Custom automates setup, operation, and scaling of databases in the AWS Cloud while granting you access to the database and underlying operating system\. With this access, you can configure settings, install patches, and enable native features to meet the dependent application's requirements\. With RDS Custom, you can run your database workload using the AWS Management Console or the AWS CLI\. - -Currently, Amazon RDS Custom supports only the Oracle Database and Microsoft SQL Server engines\. - -### Shared responsibility model - -With Amazon RDS Custom, you get the automation of Amazon RDS and the flexibility of Amazon EC2\. You take on on additional database management responsibilities beyond what you do in Amazon RDS\. By doing so, you can benefit from RDS automation and the deeper customization of EC2\. To meet your application and business requirements, you manage the host yourself\. - -In the shared responsibility model of RDS Custom, you get more control than in Amazon RDS but also more responsibility\. Shared responsibility has two meanings: - -1. You own part of the process when using a feature\. - -1. You have full access to the feature, and it's your responsibility to make sure that any customizations work with that feature\. - -The following table details the shared responsibility model for RDS Custom\. - - -| Feature | Amazon EC2 responsibility | Amazon RDS responsibility | RDS Custom for Oracle responsibility | RDS Custom for SQL Server responsibility | -| --- | --- | --- | --- | --- | -| Application optimization | Customer | Customer | Customer | Customer | -| Scaling | Customer | AWS | Shared | Shared | -| High availability | Customer | AWS | Customer | Customer | -| Database backups | Customer | AWS | Shared | Shared | -| Database software patching | Customer | AWS | Shared | AWS | -| Database software install | Customer | AWS | Shared | AWS | -| OS patching | Customer | AWS | Customer | AWS | -| OS installation | Customer | AWS | Shared | AWS | -| Server maintenance | AWS | AWS | AWS | AWS | -| Hardware lifecycle | AWS | AWS | AWS | AWS | -| Power, network, and cooling | AWS | AWS | AWS | AWS | - -You can create an RDS Custom DB instance using Microsoft SQL Server\. In this case: -+ You don't manage your own media\. -+ You don't need to purchase SQL Server licenses separately\. AWS holds the license for the SQL Server database software\. - -You can create an RDS Custom DB instance using Oracle Database\. In this case, you do the following: -+ Manage your own media\. - - When using RDS Custom, you upload your own database installation files and patches\. You create a custom engine version \(CEV\) from these files\. Then you can create an RDS Custom DB instance by using this CEV\. -+ Manage your own licenses\. - - You bring your own Oracle Database licenses and manage licenses by yourself\. - -### Key benefits of RDS Custom - -With RDS Custom, you can do the following: -+ Automate many of the same administrative tasks as Amazon RDS, including the following: - + Lifecycle management of databases - + Automated backups and point\-in\-time recovery \(PITR\) - + Monitoring the health of RDS Custom DB instances and observing changes to the infrastructure, operating system, and databases - + Notification or taking action to fix issues depending on disruption to the DB instance -+ Install third\-party applications\. - - You can install software to run custom applications and agents\. Because you have privileged access to the host, you can modify file systems to support legacy applications\. -+ Install custom patches\. - - You can apply custom database patches or modify OS packages on your RDS Custom DB instances\. -+ Stage an on\-premises database before moving it to a fully managed service\. - - If you manage your own on\-premises database, you can stage the database to RDS Custom as\-is\. After you familiarize yourself with the cloud environment, you can migrate your database to a fully managed Amazon RDS DB instance\. -+ Create your own automation\. - - You can create, schedule, and run custom automation scripts for reporting, management, or diagnostic tools\. \ No newline at end of file diff --git a/doc_source/rds-manpol-updates.md b/doc_source/rds-manpol-updates.md deleted file mode 100644 index b7c1f9f..0000000 --- a/doc_source/rds-manpol-updates.md +++ /dev/null @@ -1,26 +0,0 @@ -# Amazon RDS updates to AWS managed policies - -View details about updates to AWS managed policies for Amazon RDS since this service began tracking these changes\. For automatic alerts about changes to this page, subscribe to the RSS feed on the Amazon RDS [Document history](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/WhatsNew.html) page\. - - - - -| Change | Description | Date | -| --- | --- | --- | -| [Service\-linked role permissions for Amazon RDS](UsingWithRDS.IAM.ServiceLinkedRoles.md#service-linked-role-permissions) – Update to an existing policy | Amazon RDS added new permissions to the `AmazonRDSCustomServiceRolePolicy` of the `AWSServiceRoleForRDSCustom` service\-linked role\. These new permissions allow RDS Custom to create network interfaces\. For more information, see [Service\-linked role permissions for Amazon RDS Custom](UsingWithRDS.IAM.ServiceLinkedRoles.md#slr-permissions-custom)\. | May 30, 2023 | -| [Service\-linked role permissions for Amazon RDS](UsingWithRDS.IAM.ServiceLinkedRoles.md#service-linked-role-permissions) – Update to an existing policy | Amazon RDS added new permissions to the `AmazonRDSCustomServiceRolePolicy` of the `AWSServiceRoleForRDSCustom` service\-linked role\. These new permissions allow RDS Custom to call Amazon EBS to check the storage quota\. For more information, see [Service\-linked role permissions for Amazon RDS Custom](UsingWithRDS.IAM.ServiceLinkedRoles.md#slr-permissions-custom)\. | April 18, 2023 | -| [Service\-linked role permissions for Amazon RDS](UsingWithRDS.IAM.ServiceLinkedRoles.md#service-linked-role-permissions) – Update to an existing policy | Amazon RDS Custom added new permissions to the `AmazonRDSCustomServiceRolePolicy` of the `AWSServiceRoleForRDSCustom` service\-linked role for integration with Amazon SQS\. RDS Custom requires integration with Amazon SQS to create and manage SQS queues in the customer account\. The SQS queue names follow the format `do-not-delete-rds-custom-[identifier]` and are tagged with `Amazon RDS Custom`\. The permission for `ec2:CreateSnapshot` was also added to allow RDS Custom to create backups for volumes attached to the instance\. For more information, see [Service\-linked role permissions for Amazon RDS Custom](UsingWithRDS.IAM.ServiceLinkedRoles.md#slr-permissions-custom)\. | April 6, 2023 | -| [AWS managed policies for Amazon RDS](rds-security-iam-awsmanpol.md) – Update to an existing policy | Amazon RDS added a new Amazon CloudWatch namespace `ListMetrics` to `AmazonRDSFullAccess` and `AmazonRDSReadOnlyAccess`\. This namespace is required for Amazon RDS to list specific resource usage metrics\. For more information, see [Overview of managing access permissions to your CloudWatch resources](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/iam-access-control-overview-cw.html) in the *Amazon CloudWatch User Guide*\. | April 4, 2023 | -| [AWS managed policies for Amazon RDS](rds-security-iam-awsmanpol.md) – Update to an existing policy | Amazon RDS added a new permission to `AmazonRDSFullAccess` and `AmazonRDSReadOnlyAccess` managed policies to allow the display of Amazon DevOps Guru findings in the RDS console\. This permission is required to allow the display of DevOps Guru findings\. For more information, see [ Amazon RDS updates to AWS managed policies](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/rds-manpol-updates.html)\. | March, 30 2023 | -| [Service\-linked role permissions for Amazon RDS](UsingWithRDS.IAM.ServiceLinkedRoles.md#service-linked-role-permissions) – Update to an existing policy | Amazon RDS added new permissions to the `AmazonRDSServiceRolePolicy` of the `AWSServiceRoleForRDS` service\-linked role for integration with AWS Secrets Manager\. RDS requires integration with Secrets Manager for managing master user passwords in Secrets Manager\. The secret uses a reserved naming convention and restricts customer updates\. For more information, see [Password management with Amazon RDS and AWS Secrets Manager](rds-secrets-manager.md)\. | December 22, 2022 | -| [Service\-linked role permissions for Amazon RDS](UsingWithRDS.IAM.ServiceLinkedRoles.md#service-linked-role-permissions) – Update to an existing policy | Amazon RDS added new permissions to the `AmazonRDSCustomServiceRolePolicy` of the `AWSServiceRoleForRDSCustom` service\-linked role\. RDS Custom supports DB clusters\. These new permissions in the policy allow RDS Custom to call AWS services on behalf of your DB clusters\. For more information, see [Service\-linked role permissions for Amazon RDS Custom](UsingWithRDS.IAM.ServiceLinkedRoles.md#slr-permissions-custom)\. | November 9, 2022 | -| [Service\-linked role permissions for Amazon RDS](UsingWithRDS.IAM.ServiceLinkedRoles.md#service-linked-role-permissions) – Update to an existing policy | Amazon RDS added new permissions to the `AWSServiceRoleForRDS` service\-linked role for integration with AWS Secrets Manager\. Integration with Secrets Manager is required for SQL Server Reporting Services \(SSRS\) Email to function on RDS\. SSRS Email creates a secret on behalf of the customer\. The secret uses a reserved naming convention and restricts customer updates\. For more information, see [Using SSRS Email to send reports](Appendix.SQLServer.Options.SSRS.md#SSRS.Email)\. | August 26, 2022 | -| [Service\-linked role permissions for Amazon RDS](UsingWithRDS.IAM.ServiceLinkedRoles.md#service-linked-role-permissions) – Update to an existing policy | Amazon RDS added a new Amazon CloudWatch namespace to `AmazonRDSPreviewServiceRolePolicy` for `PutMetricData`\. This namespace is required for Amazon RDS to publish resource usage metrics\. For more information, see [Using condition keys to limit access to CloudWatch namespaces](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/iam-cw-condition-keys-namespace.html) in the *Amazon CloudWatch User Guide*\. | June 7, 2022 | -| [Service\-linked role permissions for Amazon RDS](UsingWithRDS.IAM.ServiceLinkedRoles.md#service-linked-role-permissions) – Update to an existing policy | Amazon RDS added a new Amazon CloudWatch namespace to `AmazonRDSBetaServiceRolePolicy` for `PutMetricData`\. This namespace is required for Amazon RDS to publish resource usage metrics\. For more information, see [Using condition keys to limit access to CloudWatch namespaces](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/iam-cw-condition-keys-namespace.html) in the *Amazon CloudWatch User Guide*\. | June 7, 2022 | -| [Service\-linked role permissions for Amazon RDS](UsingWithRDS.IAM.ServiceLinkedRoles.md#service-linked-role-permissions) – Update to an existing policy | Amazon RDS added a new Amazon CloudWatch namespace to `AWSServiceRoleForRDS` for `PutMetricData`\. This namespace is required for Amazon RDS to publish resource usage metrics\. For more information, see [Using condition keys to limit access to CloudWatch namespaces](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/iam-cw-condition-keys-namespace.html) in the *Amazon CloudWatch User Guide*\. | April 22, 2022 | -| [Service\-linked role permissions for Amazon RDS](UsingWithRDS.IAM.ServiceLinkedRoles.md#service-linked-role-permissions) – Update to an existing policy | Amazon RDS added new permissions to the `AWSServiceRoleForRDS` service\-linked role to manage permissions for customer\-owned IP pools and local gateway route tables \(LGW\-RTBs\)\. These permissions are required for RDS on Outposts to perform Multi\-AZ replication across the Outposts’ local network\. For more information, see [Working with Multi\-AZ deployments for Amazon RDS on AWS Outposts](rds-on-outposts.maz.md)\. | April 19, 2022 | -| [Identity\-based policies](UsingWithRDS.IAM.md#security_iam_access-manage-id-based-policies) – Update to an existing policy | Amazon RDS added a new permission to the `AmazonRDSFullAccess` managed policy to describe permissions on LGW\-RTBs\. This permission is required to describe permissions for RDS on Outposts to perform Multi\-AZ replication across the Outposts’ local network\. For more information, see [Working with Multi\-AZ deployments for Amazon RDS on AWS Outposts](rds-on-outposts.maz.md)\. | April 19, 2022 | -| [Configuring access policies for Performance Insights](USER_PerfInsights.access-control.md) – New policy | Amazon RDS added a new service\-linked role named `AmazonRDSPerformanceInsightsReadOnly` to allow Amazon RDS to call AWS services on behalf of your DB instances\. | March 10, 2022 | -| [Service\-linked role permissions for Amazon RDS](UsingWithRDS.IAM.ServiceLinkedRoles.md#service-linked-role-permissions) – Update to an existing policy | Amazon RDS added new Amazon CloudWatch namespaces to `AWSServiceRoleForRDS` for `PutMetricData`\. These namespaces are required for Amazon DocumentDB \(with MongoDB compatibility\) and Amazon Neptune to publish CloudWatch metrics\. For more information, see [Using condition keys to limit access to CloudWatch namespaces](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/iam-cw-condition-keys-namespace.html) in the *Amazon CloudWatch User Guide*\. | March 4, 2022 | -| [Service\-linked role permissions for Amazon RDS Custom](UsingWithRDS.IAM.ServiceLinkedRoles.md#slr-permissions-custom) – New policy | Amazon RDS added a new service\-linked role named `AWSServiceRoleForRDSCustom` to allow RDS Custom to call AWS services on behalf of your DB instances\. | October 26, 2021 | -| Amazon RDS started tracking changes | Amazon RDS started tracking changes for its AWS managed policies\. | October 26, 2021 | \ No newline at end of file diff --git a/doc_source/rds-metrics.md b/doc_source/rds-metrics.md deleted file mode 100644 index 058a175..0000000 --- a/doc_source/rds-metrics.md +++ /dev/null @@ -1,77 +0,0 @@ -# Amazon CloudWatch metrics for Amazon RDS - -Amazon RDS publishes metrics to Amazon CloudWatch in the `AWS/RDS` and `AWS/Usage` namespaces\. - -**Topics** -+ [Amazon CloudWatch instance\-level metrics for Amazon RDS](#rds-cw-metrics-instance) -+ [Amazon CloudWatch usage metrics for Amazon RDS](#rds-metrics-usage) - -## Amazon CloudWatch instance\-level metrics for Amazon RDS - -The `AWS/RDS` namespace in Amazon CloudWatch includes the following instance\-level metrics\. - -**Note** -The Amazon RDS console might display metrics in units that are different from the units sent to Amazon CloudWatch\. For example, the Amazon RDS console might display a metric in megabytes \(MB\), while the metric is sent to Amazon CloudWatch in bytes\. - - -| Metric | Console name | Description | Units | -| --- | --- | --- | --- | -| BinLogDiskUsage | **Binary Log Disk Usage \(MB\)** | The amount of disk space occupied by binary logs\. If automatic backups are enabled for MySQL and MariaDB instances, including read replicas, binary logs are created\. | Bytes | -| BurstBalance | **Burst Balance \(Percent\)** | The percent of General Purpose SSD \(gp2\) burst\-bucket I/O credits available\. | Percent | -| CheckpointLag | Checkpoint Lag \(Seconds\) | The amount of time since the most recent checkpoint\. Applies to only RDS for PostgreSQL\. | Seconds | -| `ConnectionAttempts` | **Connection Attempts \(Count\)** | The number of attempts to connect to an instance, whether successful or not\. | Count | -| CPUUtilization | **CPU Utilization \(Percent\)** | The percentage of CPU utilization\. | Percentage | -| CPUCreditUsage | **CPU Credit Usage \(Count\)** | \(T2 instances\) The number of CPU credits spent by the instance for CPU utilization\. One CPU credit equals one vCPU running at 100 percent utilization for one minute or an equivalent combination of vCPUs, utilization, and time\. For example, you might have one vCPU running at 50 percent utilization for two minutes or two vCPUs running at 25 percent utilization for two minutes\. CPU credit metrics are available at a five\-minute frequency only\. If you specify a period greater than five minutes, use the `Sum` statistic instead of the `Average` statistic\. | Credits \(vCPU\-minutes\) | -| CPUCreditBalance | **CPU Credit Balance \(Count\)** | \(T2 instances\) The number of earned CPU credits that an instance has accrued since it was launched or started\. For T2 Standard, the `CPUCreditBalance` also includes the number of launch credits that have been accrued\. Credits are accrued in the credit balance after they are earned, and removed from the credit balance when they are spent\. The credit balance has a maximum limit, determined by the instance size\. After the limit is reached, any new credits that are earned are discarded\. For T2 Standard, launch credits don't count towards the limit\. The credits in the `CPUCreditBalance` are available for the instance to spend to burst beyond its baseline CPU utilization\. When an instance is running, credits in the `CPUCreditBalance` don't expire\. When the instance stops, the `CPUCreditBalance` does not persist, and all accrued credits are lost\. CPU credit metrics are available at a five\-minute frequency only\. Launch credits work the same way in Amazon RDS as they do in Amazon EC2\. For more information, see [Launch credits](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/burstable-performance-instances-standard-mode-concepts.html#launch-credits) in the *Amazon Elastic Compute Cloud User Guide for Linux Instances*\. | Credits \(vCPU\-minutes\) | -| DatabaseConnections | **DB Connections \(Count\)** | The number of client network connections to the database instance\. The number of database sessions can be higher than the metric value because the metric value doesn't include the following: [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/rds-metrics.html) | Count | -| DiskQueueDepth | **Queue Depth \(Count\)** | The number of outstanding I/Os \(read/write requests\) waiting to access the disk\. | Count | -| EBSByteBalance% | **EBS Byte Balance \(Percent\)** | The percentage of throughput credits remaining in the burst bucket of your RDS database\. This metric is available for basic monitoring only\. The metric value is based on the throughput and IOPS of all volumes, including the root volume, rather than on only those volumes containing database files\. To find the instance sizes that support this metric, see the instance sizes with an asterisk \(\*\) in the [EBS optimized by default](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ebs-optimized.html#current) table in *Amazon EC2 User Guide for Linux Instances*\. The `Sum` statistic is not applicable to this metric\. | Percentage | -| EBSIOBalance% | **EBS IO Balance \(Percent\)** | The percentage of I/O credits remaining in the burst bucket of your RDS database\. This metric is available for basic monitoring only\. The metric value is based on the throughput and IOPS of all volumes, including the root volume, rather than on only those volumes containing database files\. To find the instance sizes that support this metric, see the instance sizes with an asterisk \(\*\) in the [EBS optimized by default](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ebs-optimized.html#current) table in *Amazon EC2 User Guide for Linux Instances*\. The `Sum` statistic is not applicable to this metric\. This metric is different from `BurstBalance`\. To learn how to use this metric, see [Improving application performance and reducing costs with Amazon EBS\-Optimized Instance burst capability](http://aws.amazon.com/blogs/compute/improving-application-performance-and-reducing-costs-with-amazon-ebs-optimized-instance-burst-capability/)\. | Percentage | -| FailedSQLServerAgentJobsCount | **Failed SQL Server Agent Jobs Count \(Count/Minute\)** | The number of failed Microsoft SQL Server Agent jobs during the last minute\. | Count per minute | -| FreeableMemory | **Freeable Memory \(MB\)** | The amount of available random access memory\. For MariaDB, MySQL, Oracle, and PostgreSQL DB instances, this metric reports the value of the `MemAvailable` field of `/proc/meminfo`\. | Bytes | -| FreeLocalStorage | **Free Local Storage \(MB\)** | The amount of available local storage space\. This metric only applies to DB instance classes with NVMe SSD instance store volumes\. For information about Amazon EC2 instances with NVMe SSD instance store volumes, see [ Instance store volumes](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/InstanceStorage.html#instance-store-volumes)\. The equivalent RDS DB instance classes have the same instance store volumes\. For example, the db\.m6gd and db\.r6gd DB instance classes have NVMe SSD instance store volumes\. \(This doesn't apply to Aurora Serverless v2\.\) | Bytes | -| FreeStorageSpace | **Free Storage Space \(MB\)** | The amount of available storage space\. | Bytes | -| MaximumUsedTransactionIDs | **Maximum Used Transaction IDs \(Count\)** | The maximum transaction IDs that have been used\. Applies to only PostgreSQL\. | Count | -| NetworkReceiveThroughput | **Network Receive Throughput \(MB/Second\)** | The incoming \(receive\) network traffic on the DB instance, including both customer database traffic and Amazon RDS traffic used for monitoring and replication\. | Bytes per second | -| NetworkTransmitThroughput | **Network Transmit Throughput \(MB/Second\)** | The outgoing \(transmit\) network traffic on the DB instance, including both customer database traffic and Amazon RDS traffic used for monitoring and replication\. | Bytes per second | -| OldestReplicationSlotLag | **Oldest Replication Slot Lag \(MB\)** | The lagging size of the replica lagging the most in terms of write\-ahead log \(WAL\) data received\. Applies to PostgreSQL\. | Bytes | -| ReadIOPS | **Read IOPS \(Count/Second\)** | The average number of disk read I/O operations per second\. | Count per second | -| ReadIOPSLocalStorage | **Read IOPS Local Storage \(Count/Second\)** | The average number of disk read I/O operations to local storage per second\. This metric only applies to DB instance classes with NVMe SSD instance store volumes\. For information about Amazon EC2 instances with NVMe SSD instance store volumes, see [ Instance store volumes](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/InstanceStorage.html#instance-store-volumes)\. The equivalent RDS DB instance classes have the same instance store volumes\. For example, the db\.m6gd and db\.r6gd DB instance classes have NVMe SSD instance store volumes\. | Count per second | -| ReadLatency | **Read Latency \(Seconds\)** | The average amount of time taken per disk I/O operation\. | Seconds | -| ReadLatencyLocalStorage | **Read Latency Local Storage \(Seconds\)** | The average amount of time taken per disk I/O operation for local storage\. This metric only applies to DB instance classes with NVMe SSD instance store volumes\. For information about Amazon EC2 instances with NVMe SSD instance store volumes, see [ Instance store volumes](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/InstanceStorage.html#instance-store-volumes)\. The equivalent RDS DB instance classes have the same instance store volumes\. For example, the db\.m6gd and db\.r6gd DB instance classes have NVMe SSD instance store volumes\. | Seconds | -| ReadThroughput | **Read Throughput \(MB/Second\)** | The average number of bytes read from disk per second\. | Bytes per second | -| ReadThroughputLocalStorage | **Read Throughput Local Storage \(MB/Second\)** | The average number of bytes read from disk per second for local storage\. This metric only applies to DB instance classes with NVMe SSD instance store volumes\. For information about Amazon EC2 instances with NVMe SSD instance store volumes, see [ Instance store volumes](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/InstanceStorage.html#instance-store-volumes)\. The equivalent RDS DB instance classes have the same instance store volumes\. For example, the db\.m6gd and db\.r6gd DB instance classes have NVMe SSD instance store volumes\. | Bytes per second | -| ReplicaLag | **Replica Lag \(Seconds\)** | For read replica configurations, the amount of time a read replica DB instance lags behind the source DB instance\. Applies to MariaDB, Microsoft SQL Server, MySQL, Oracle, and PostgreSQL read replicas\. For Multi\-AZ DB clusters, the difference in time between the latest transaction on the writer DB instance and the latest applied transaction on a reader DB instance\. | Seconds | -| ReplicationSlotDiskUsage | **Replica Slot Disk Usage \(MB\)** | The disk space used by replication slot files\. Applies to PostgreSQL\. | Bytes | -| SwapUsage | **Swap Usage \(MB\)** | The amount of swap space used on the DB instance\. This metric is not available for SQL Server\. | Bytes | -| TransactionLogsDiskUsage | **Transaction Logs Disk Usage \(MB\)** | The disk space used by transaction logs\. Applies to PostgreSQL\. | Bytes | -| TransactionLogsGeneration | **Transaction Logs Generation \(MB/Second\)** | The size of transaction logs generated per second\. Applies to PostgreSQL\. | Bytes per second | -| WriteIOPS | **Write IOPS \(Count/Second\)** | The average number of disk write I/O operations per second\. | Count per second | -| WriteIOPSLocalStorage | **Write IOPS Local Storage \(Count/Second\)** | The average number of disk write I/O operations per second on local storage\. This metric only applies to DB instance classes with NVMe SSD instance store volumes\. For information about Amazon EC2 instances with NVMe SSD instance store volumes, see [ Instance store volumes](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/InstanceStorage.html#instance-store-volumes)\. The equivalent RDS DB instance classes have the same instance store volumes\. For example, the db\.m6gd and db\.r6gd DB instance classes have NVMe SSD instance store volumes\. | Count per second | -| WriteLatency | **Write Latency \(Seconds\)** | The average amount of time taken per disk I/O operation\. | Seconds | -| WriteLatencyLocalStorage | **Write Latency Local Storage \(Seconds\)** | The average amount of time taken per disk I/O operation on local storage\. This metric only applies to DB instance classes with NVMe SSD instance store volumes\. For information about Amazon EC2 instances with NVMe SSD instance store volumes, see [ Instance store volumes](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/InstanceStorage.html#instance-store-volumes)\. The equivalent RDS DB instance classes have the same instance store volumes\. For example, the db\.m6gd and db\.r6gd DB instance classes have NVMe SSD instance store volumes\. | Seconds | -| WriteThroughput | **Write Throughput \(MB/Second\)** | The average number of bytes written to disk per second\. | Bytes per second | -| WriteThroughputLocalStorage | **Write Throughput Local Storage \(MB/Second\)** | The average number of bytes written to disk per second for local storage\. This metric only applies to DB instance classes with NVMe SSD instance store volumes\. For information about Amazon EC2 instances with NVMe SSD instance store volumes, see [ Instance store volumes](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/InstanceStorage.html#instance-store-volumes)\. The equivalent RDS DB instance classes have the same instance store volumes\. For example, the db\.m6gd and db\.r6gd DB instance classes have NVMe SSD instance store volumes\. | Bytes per second | - -## Amazon CloudWatch usage metrics for Amazon RDS - -The `AWS/Usage` namespace in Amazon CloudWatch includes account\-level usage metrics for your Amazon RDS service quotas\. CloudWatch collects usage metrics automatically for all AWS Regions\. - -For more information, see [CloudWatch usage metrics](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-Usage-Metrics.html) in the *Amazon CloudWatch User Guide*\. For more information about quotas, see [Quotas and constraints for Amazon RDS](CHAP_Limits.md) and [Requesting a quota increase](https://docs.aws.amazon.com/servicequotas/latest/userguide/request-quota-increase.html) in the *Service Quotas User Guide*\. - - -| Metric | Description | Units\* | -| --- | --- | --- | -| AllocatedStorage | The total storage for all DB instances\. The sum excludes temporary migration instances\. | Gigabytes | -| DBClusterParameterGroups | The number of DB cluster parameter groups in your AWS account\. The count excludes default parameter groups\. | Count | -| DBClusters | The number of Amazon Aurora DB clusters in your AWS account\. | Count | -| DBInstances | The number of DB instances in your AWS account\. | Count | -| DBParameterGroups | The number of DB parameter groups in your AWS account\. The count excludes the default DB parameter groups\. | Count | -| DBSecurityGroups | The number of security groups in your AWS account\. The count excludes the default security group and the default VPC security group\. | Count | -| DBSubnetGroups | The number of DB subnet groups in your AWS account\. The count excludes the default subnet group\. | Count | -| ManualClusterSnapshots | The number of manually created DB cluster snapshots in your AWS account\. The count excludes invalid snapshots\. | Count | -| ManualSnapshots | The number of manually created DB snapshots in your AWS account\. The count excludes invalid snapshots\. | Count | -| OptionGroups | The number of option groups in your AWS account\. The count excludes the default option groups\. | Count | -| ReservedDBInstances | The number of reserved DB instances in your AWS account\. The count excludes retired or declined instances\. | Count | - -\* Amazon RDS doesn't publish units for usage metrics to CloudWatch\. The units only appear in the documentation\. \ No newline at end of file diff --git a/doc_source/rds-on-outposts.coip.md b/doc_source/rds-on-outposts.coip.md deleted file mode 100644 index 59137c2..0000000 --- a/doc_source/rds-on-outposts.coip.md +++ /dev/null @@ -1,52 +0,0 @@ -# Customer\-owned IP addresses for Amazon RDS on AWS Outposts - -Amazon RDS on AWS Outposts uses information that you provide about your on\-premises network to create an address pool\. This pool is known as a *customer\-owned IP address pool* \(CoIP pool\)\. *Customer\-owned IP addresses* \(CoIPs\) provide local or external connectivity to resources in your Outpost subnets through your on\-premises network\. For more information about CoIPs, see [Customer\-owned IP addresses](https://docs.aws.amazon.com/outposts/latest/userguide/routing.html#ip-addressing) in the *AWS Outposts User Guide*\. - -Each RDS on Outposts DB instance has a private IP address for traffic inside its virtual private cloud \(VPC\)\. This private IP address isn't publicly accessible\. You can use the **Public** option to set whether the DB instance also has a public IP address in addition to the private IP address\. Using the public IP address for connections routes them through the internet and can result in high latencies in some cases\. - -Instead of using these private and public IP addresses, RDS on Outposts supports using CoIPs for DB instances through their subnets\. When you use a CoIP for an RDS on Outposts DB instance, you connect to the DB instance with the DB instance endpoint\. RDS on Outposts then automatically uses the CoIP for all connections from both inside and outside of the VPC\. - -CoIPs can provide the following benefits for RDS on Outposts DB instances: -+ Lower connection latency -+ Enhanced security - -## Using CoIPs - -You can turn CoIPs on or off for an RDS on Outposts DB instance using the AWS Management Console, the AWS CLI, or the RDS API: -+ With the AWS Management Console, choose the **Customer\-owned IP address \(CoIP\)** setting in **Access type** to use CoIPs\. Choose one of the other settings to turn them off\. -![\[The Customer-owned IP address (CoIP) setting in the AWS Management Console.\]](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/images/outpost-coip.png) -+ With the AWS CLI, use the `--enable-customer-owned-ip | --no-enable-customer-owned-ip` option\. -+ With the RDS API, use the `EnableCustomerOwnedIp` parameter\. - -You can turn CoIPs on or off when you perform any of the following actions: -+ Create a DB instance - - For more information, see [Creating DB instances for Amazon RDS on AWS Outposts](rds-on-outposts.creating.md)\. -+ Modify a DB instance - - For more information, see [Modifying an Amazon RDS DB instance](Overview.DBInstance.Modifying.md)\. -+ Create a read replica - - For more information, see [Creating read replicas for Amazon RDS on AWS Outposts](rds-on-outposts.rr.md)\. -+ Restore a DB instance from a snapshot - - For more information, see [Restoring from a DB snapshot](USER_RestoreFromSnapshot.md)\. -+ Restore a DB instance to a specified time - - For more information, see [Restoring a DB instance to a specified time](USER_PIT.md)\. - -**Note** -In some cases, you might turn on CoIPs for a DB instance but Amazon RDS isn't able to allocate a CoIP for the DB instance\. In such cases, the DB instance status is changed to **incompatible\-network**\. For more information about the DB instance status, see [Viewing Amazon RDS DB instance status](accessing-monitoring.md#Overview.DBInstance.Status)\. - -## Limitations - -The following limitations apply to CoIP support for RDS on Outposts DB instances: -+ When using a CoIP for a DB instance, make sure that public accessibility is turned off for that DB instance\. -+ Make sure that the inbound rules for your VPC security groups include the CoIP address range \(CIDR block\)\. For more information about setting up security groups, see [Provide access to your DB instance in your VPC by creating a security group](CHAP_SettingUp.md#CHAP_SettingUp.SecurityGroup)\. -+ You can't assign a CoIP from a CoIP pool to a DB instance\. When you use a CoIP for a DB instance, Amazon RDS automatically assigns a CoIP from a CoIP pool to the DB instance\. -+ You must use the AWS account that owns the Outpost resources \(owner\) or share the following resources with other AWS accounts \(consumers\) in the same organization: - + The Outpost - + The local gateway \(LGW\) route table for the DB instance's VPC - + The CoIP pool or pools for the LGW route table - - For more information, see [ Working with shared AWS Outposts resources](https://docs.aws.amazon.com/outposts/latest/userguide/sharing-outposts.html) in the *AWS Outposts User Guide*\. \ No newline at end of file diff --git a/doc_source/rds-on-outposts.creating.md b/doc_source/rds-on-outposts.creating.md deleted file mode 100644 index e29f131..0000000 --- a/doc_source/rds-on-outposts.creating.md +++ /dev/null @@ -1,245 +0,0 @@ -# Creating DB instances for Amazon RDS on AWS Outposts - -Creating an Amazon RDS on AWS Outposts DB instance is similar to creating an Amazon RDS DB instance in the AWS Cloud\. However, make sure that you specify a DB subnet group that is associated with your Outpost\. - -A virtual private cloud \(VPC\) based on the Amazon VPC service can span all of the Availability Zones in an AWS Region\. You can extend any VPC in the AWS Region to your Outpost by adding an Outpost subnet\. To add an Outpost subnet to a VPC, specify the Amazon Resource Name \(ARN\) of the Outpost when you create the subnet\. - -Before you create an RDS on Outposts DB instance, you can create a DB subnet group that includes one subnet that is associated with your Outpost\. When you create an RDS on Outposts DB instance, specify this DB subnet group\. You can also choose to create a new DB subnet group when you create your DB instance\. - -For information about configuring AWS Outposts, see the [AWS Outposts User Guide](https://docs.aws.amazon.com/outposts/latest/userguide/)\. - -## Console - -### Creating a DB subnet group - -Create a DB subnet group with one subnet that is associated with your Outpost\. - -You can also create a new DB subnet group for the Outpost when you create your DB instance\. If you want to do so, then skip this procedure\. - -**Note** -To create a DB subnet group for the AWS Cloud, specify at least two subnets\. - -**To create a DB subnet group for your Outpost** - -1. Sign in to the AWS Management Console and open the Amazon RDS console at [https://console\.aws\.amazon\.com/rds/](https://console.aws.amazon.com/rds/)\. - -1. In the upper\-right corner of the Amazon RDS console, choose the AWS Region where you want to create the DB subnet group\. - -1. Choose **Subnet groups**, and then choose **Create DB Subnet Group**\. - - The **Create DB subnet group** page appears\. -![\[Create DB subnet group page.\]](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/images/create-db-subnet-group.png) - -1. For **Name**, choose the name of the DB subnet group\. - -1. For **Description**, choose a description for the DB subnet group\. - -1. For **VPC**, choose the VPC that you're creating the DB subnet group for\. - -1. For **Availability Zones**, choose the Availability Zone for your Outpost\. - -1. For **Subnets**, choose the subnet for use by RDS on Outposts\. - -1. Choose **Create** to create the DB subnet group\. - -### Creating the RDS on Outposts DB instance - -Create the DB instance, and choose the Outpost for your DB instance\. - -**To create an RDS on Outposts DB instance using the console** - -1. Sign in to the AWS Management Console and open the Amazon RDS console at [https://console\.aws\.amazon\.com/rds/](https://console.aws.amazon.com/rds/)\. - -1. In the upper\-right corner of the Amazon RDS console, choose the AWS Region where the Outpost on which you want to create the DB instance is attached\. - -1. In the navigation pane, choose **Databases**\. - -1. Choose **Create database**\. - - The AWS Management Console detects available Outposts that you have configured and presents the **On\-premises** option in the **Database location** section\. -**Note** -If you haven't configured any Outposts, either the **Database location** section doesn't appear or the **RDS on Outposts** option isn't available in the **Choose an on\-premises creation method** section\. - -1. For **Database location**, choose **On\-premises**\. - -1. For **On\-premises creation method**, choose **RDS on Outposts**\. - -1. Specify your settings for **Outposts Connectivity**\. These settings are for the Outpost that uses the VPC that has the DB subnet group for your DB instance\. Your VPC must be based on the Amazon VPC service\. - - 1. For **Virtual Private Cloud \(VPC\)**, choose the VPC that contains the DB subnet group for your DB instance\. - - 1. For **VPC security group**, choose the Amazon VPC security group for your DB instance\. - - 1. For **DB subnet group**, choose the DB subnet group for your DB instance\. - - You can choose an existing DB subnet group that's associated with the Outpost—for example, if you performed the procedure in [Creating a DB subnet group](#rds-on-outposts.creating.console.subnet)\. - - You can also create a new DB subnet group for the Outpost\. - -1. For **Multi\-AZ deployment**, choose **Create a standby instance \(recommended for production usage\)** to create a standby DB instance in another Outpost\. -**Note** -This option isn't available for Microsoft SQL Server\. -If you choose to create a Multi\-AZ deployment, you can't store backups on your Outpost\. - -1. Under **Backup**, do the following: - - 1. For **Backup target**, choose one of the following: - + **AWS Cloud** to store automated backups and manual snapshots in the parent AWS Region\. - + **Outposts \(on\-premises\)** to create local backups\. -**Note** -To store backups on your Outpost, your Outpost must have Amazon S3 capability\. For more information, see [Amazon S3 on Outposts](https://aws.amazon.com/s3/outposts/)\. -Local backups aren't supported for Multi\-AZ deployments or read replicas\. - - 1. Choose **Enable automated backups** to create point\-in\-time snapshots of your DB instance\. - - If you turn on automated backups, then you can choose values for **Backup retention period** and **Backup window**, or leave the default values\. - -1. Specify other DB instance settings as needed\. - - For information about each setting when creating a DB instance, see [Settings for DB instances](USER_CreateDBInstance.md#USER_CreateDBInstance.Settings)\. - -1. Choose **Create database**\. - - The **Databases** page appears\. A banner tells you that your DB instance is being created, and displays the **View credential details** button\. - -### Viewing DB instance details - -After you create your DB instance, you can view credentials and other details for it\. - -**To view DB instance details** - -1. To view the master user name and password for the DB instance, choose **View credential details** on the **Databases** page\. - - You can connect to the DB instance as the master user by using these credentials\. -**Important** -You can't view the master user password again\. If you don't record it, you might have to change it\. To change the master user password after the DB instance is available, modify the DB instance\. For more information about modifying a DB instance, see [Modifying an Amazon RDS DB instance](Overview.DBInstance.Modifying.md)\. - -1. Choose the name of the new DB instance on the **Databases** page\. - - On the RDS console, the details for the new DB instance appear\. The DB instance has a status of **Creating** until the DB instance is created and ready for use\. When the state changes to **Available**, you can connect to the DB instance\. Depending on the DB instance class and storage allocated, it can take several minutes for the new DB instance to be available\. -![\[My DB instances details\]](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/images/create-outpost-launch.png) - - After the DB instance is available, you can manage it the same way that you manage RDS DB instances in the AWS Cloud\. - -## AWS CLI - -Before you create a new DB instance in an Outpost with the AWS CLI, first create a DB subnet group for use by RDS on Outposts\. - -**To create a DB subnet group for your Outpost** -+ Use the [create\-db\-subnet\-group](https://docs.aws.amazon.com/cli/latest/reference/rds/create-db-subnet-group.html) command\. For `--subnet-ids`, specify the subnet group in the Outpost for use by RDS on Outposts\. - - For Linux, macOS, or Unix: - - ``` - 1. aws rds create-db-subnet-group \ - 2. --db-subnet-group-name myoutpostdbsubnetgr \ - 3. --db-subnet-group-description "DB subnet group for RDS on Outposts" \ - 4. --subnet-ids subnet-abc123 - ``` - - For Windows: - - ``` - 1. aws rds create-db-subnet-group ^ - 2. --db-subnet-group-name myoutpostdbsubnetgr ^ - 3. --db-subnet-group-description "DB subnet group for RDS on Outposts" ^ - 4. --subnet-ids subnet-abc123 - ``` - -**To create an RDS on Outposts DB instance using the AWS CLI** -+ Use the [create\-db\-instance](https://docs.aws.amazon.com/cli/latest/reference/rds/create-db-instance.html) command\. Specify an Availability Zone for the Outpost, an Amazon VPC security group associated with the Outpost, and the DB subnet group you created for the Outpost\. You can include the following options: - + `--db-instance-identifier` - + `--db-instance-class` - + `--engine` – The database engine\. Use one of the following values: - + MySQL – Specify `mysql`\. - + PostgreSQL – Specify `postgres`\. - + Microsoft SQL Server – Specify `sqlserver-ee`, `sqlserver-se`, or `sqlserver-web`\. - + `--availability-zone` - + `--vpc-security-group-ids` - + `--db-subnet-group-name` - + `--allocated-storage` - + `--max-allocated-storage` - + `--master-username` - + `--master-user-password` - + `--multi-az | --no-multi-az` – \(Optional\) Whether to create a standby DB instance in a different Availability Zone\. The default is `--no-multi-az`\. - - The `--multi-az` option isn't available for SQL Server\. - + `--backup-retention-period` - + `--backup-target` – \(Optional\) Where to store automated backups and manual snapshots\. Use one of the following values: - + `outposts` – Store them locally on your Outpost\. - + `region` – Store them in the parent AWS Region\. This is the default value\. - - If you use the `--multi-az` option, you can't use `outposts` for `--backup-target`\. In addition, the DB instance can't have read replicas if you use `outposts` for `--backup-target`\. - + `--storage-encrypted` - + `--kms-key-id` - -**Example** -The following example creates a MySQL DB instance named `myoutpostdbinstance` with backups stored on your Outpost\. -For Linux, macOS, or Unix: - -``` - 1. aws rds create-db-instance \ - 2. --db-instance-identifier myoutpostdbinstance \ - 3. --engine-version 8.0.17 \ - 4. --db-instance-class db.m5.large \ - 5. --engine mysql \ - 6. --availability-zone us-east-1d \ - 7. --vpc-security-group-ids outpost-sg \ - 8. --db-subnet-group-name myoutpostdbsubnetgr \ - 9. --allocated-storage 100 \ -10. --max-allocated-storage 1000 \ -11. --master-username masterawsuser \ -12. --master-user-password masteruserpassword \ -13. --backup-retention-period 3 \ -14. --backup-target outposts \ -15. --storage-encrypted \ -16. --kms-key-id mykey -``` -For Windows: - -``` - 1. aws rds create-db-instance ^ - 2. --db-instance-identifier myoutpostdbinstance ^ - 3. --engine-version 8.0.17 ^ - 4. --db-instance-class db.m5.large ^ - 5. --engine mysql ^ - 6. --availability-zone us-east-1d ^ - 7. --vpc-security-group-ids outpost-sg ^ - 8. --db-subnet-group-name myoutpostdbsubnetgr ^ - 9. --allocated-storage 100 ^ -10. --max-allocated-storage 1000 ^ -11. --master-username masterawsuser ^ -12. --master-user-password masteruserpassword ^ -13. --backup-retention-period 3 ^ -14. --backup-target outposts ^ -15. --storage-encrypted ^ -16. --kms-key-id mykey -``` - -For information about each setting when creating a DB instance, see [Settings for DB instances](USER_CreateDBInstance.md#USER_CreateDBInstance.Settings)\. - -## RDS API - -To create a new DB instance in an Outpost with the RDS API, first create a DB subnet group for use by RDS on Outposts by calling the [CreateDBSubnetGroup](https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_CreateDBSubnetGroup.html) operation\. For `SubnetIds`, specify the subnet group in the Outpost for use by RDS on Outposts\. - -Next, call the [CreateDBInstance](https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_CreateDBInstance.html) operation with the following parameters\. Specify an Availability Zone for the Outpost, an Amazon VPC security group associated with the Outpost, and the DB subnet group you created for the Outpost\. -+ `AllocatedStorage` -+ `AvailabilityZone` -+ `BackupRetentionPeriod` -+ `BackupTarget` - - If you are creating a Multi\-AZ DB instance deployment, you can't use `outposts` for `BackupTarget`\. In addition, the DB instance can't have read replicas if you use `outposts` for `BackupTarget`\. -+ `DBInstanceClass` -+ `DBInstanceIdentifier` -+ `VpcSecurityGroupIds` -+ `DBSubnetGroupName` -+ `Engine` -+ `EngineVersion` -+ `MasterUsername` -+ `MasterUserPassword` -+ `MaxAllocatedStorage` \(optional\) -+ `MultiAZ` \(optional\) -+ `StorageEncrypted` -+ `KmsKeyID` - -For information about each setting when creating a DB instance, see [Settings for DB instances](USER_CreateDBInstance.md#USER_CreateDBInstance.Settings)\. \ No newline at end of file diff --git a/doc_source/rds-on-outposts.db-instance-classes.md b/doc_source/rds-on-outposts.db-instance-classes.md deleted file mode 100644 index 7a77cf7..0000000 --- a/doc_source/rds-on-outposts.db-instance-classes.md +++ /dev/null @@ -1,23 +0,0 @@ -# Supported DB instance classes for Amazon RDS on AWS Outposts - -Amazon RDS on AWS Outposts supports the following DB instance classes: -+ General purpose DB instance classes - + db\.m5\.24xlarge - + db\.m5\.12xlarge - + db\.m5\.4xlarge - + db\.m5\.2xlarge - + db\.m5\.xlarge - + db\.m5\.large -+ Memory optimized DB instance classes - + db\.r5\.24xlarge - + db\.r5\.12xlarge - + db\.r5\.4xlarge - + db\.r5\.2xlarge - + db\.r5\.xlarge - + db\.r5\.large - -Depending on how you've configured your Outpost, you might not have all of these classes available\. For example, if you haven't purchased the db\.r5 classes for your Outpost, you can't use them with RDS on Outposts\. - -Only general purpose SSD storage is supported for RDS on Outposts DB instances\. For more information about DB instance classes, see [DB instance classes](Concepts.DBInstanceClass.md)\. - -Amazon RDS manages maintenance and recovery for your DB instances and requires active capacity on the Outpost to do so\. We recommend that you configure N\+1 EC2 instances for each DB instance class in your production environments\. RDS on Outposts can use the extra capacity of these EC2 instances for maintenance and repair operations\. For example, if your production environments have 3 db\.m5\.large and 5 db\.r5\.xlarge DB instance classes, then we recommend that they have at least 4 m5\.large EC2 instances and 6 r5\.xlarge EC2 instances\. For more information, see [Resilience in AWS Outposts](https://docs.aws.amazon.com/outposts/latest/userguide/disaster-recovery-resiliency.html) in the *AWS Outposts User Guide*\. \ No newline at end of file diff --git a/doc_source/rds-on-outposts.features.md b/doc_source/rds-on-outposts.features.md deleted file mode 100644 index 5dbd0ab..0000000 --- a/doc_source/rds-on-outposts.features.md +++ /dev/null @@ -1,44 +0,0 @@ -# Amazon RDS on AWS Outposts support for Amazon RDS features - -The following table describes the Amazon RDS features supported by Amazon RDS on AWS Outposts\. - - -| Feature | Supported | Notes | More information | -| --- | --- | --- | --- | -| DB instance provisioning | Yes | You can only create DB instances for RDS for SQL Server, RDS for MySQL, and RDS for PostgreSQL DB engines\. The following versions are supported: [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/rds-on-outposts.features.html) | [Creating DB instances for Amazon RDS on AWS Outposts](rds-on-outposts.creating.md) | -| Connect to a Microsoft SQL Server DB instance with Microsoft SQL Server Management Studio | Yes | Some TLS versions and encryption ciphers might not be secure\. To turn them off, follow the instructions in [Configuring security protocols and ciphers](SQLServer.Ciphers.md)\. | [Connecting to a DB instance running the Microsoft SQL Server database engine](USER_ConnectToMicrosoftSQLServerInstance.md) | -| Modifying the master user password | Yes | — | [Modifying an Amazon RDS DB instance](Overview.DBInstance.Modifying.md) | -| Renaming a DB instance | Yes | — | [Modifying an Amazon RDS DB instance](Overview.DBInstance.Modifying.md) | -| Rebooting a DB instance | Yes | — | [Rebooting a DB instance](USER_RebootInstance.md) | -| Stopping a DB instance | Yes | — | [Stopping an Amazon RDS DB instance temporarily](USER_StopInstance.md) | -| Starting a DB instance | Yes | — | [Starting an Amazon RDS DB instance that was previously stopped](USER_StartInstance.md) | -| Multi\-AZ deployments | Yes | Multi\-AZ deployments are supported on MySQL and PostgreSQL DB instances\. | [Creating DB instances for Amazon RDS on AWS Outposts](rds-on-outposts.creating.md) [Configuring and managing a Multi\-AZ deployment](Concepts.MultiAZ.md) | -| DB parameter groups | Yes | — | [Working with parameter groups](USER_WorkingWithParamGroups.md) | -| Read replicas | Yes | Read replicas are supported for MySQL and PostgreSQL DB instances\. | [Creating read replicas for Amazon RDS on AWS Outposts](rds-on-outposts.rr.md) | -| Encryption at rest | Yes | RDS on Outposts doesn't support unencrypted DB instances\. | [Encrypting Amazon RDS resources](Overview.Encryption.md) | -| AWS Identity and Access Management \(IAM\) database authentication | No | — | [IAM database authentication for MariaDB, MySQL, and PostgreSQL](UsingWithRDS.IAMDBAuth.md) | -| Associating an IAM role with a DB instance | No | — | [add\-role\-to\-db\-instance](https://docs.aws.amazon.com/cli/latest/reference/rds/add-role-to-db-instance.html) AWS CLI command [AddRoleToDBInstance](https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_AddRoleToDBInstance.html) RDS API operation | -| Kerberos authentication | No | — | [Kerberos authentication](database-authentication.md#kerberos-authentication) | -| Tagging Amazon RDS resources | Yes | — | [Tagging Amazon RDS resources](USER_Tagging.md) | -| Option groups | Yes | — | [Working with option groups](USER_WorkingWithOptionGroups.md) | -| Modifying the maintenance window | Yes | — | [Maintaining a DB instance](USER_UpgradeDBInstance.Maintenance.md) | -| Automatic minor version upgrade | Yes | — | [Automatically upgrading the minor engine version](USER_UpgradeDBInstance.Upgrading.md#USER_UpgradeDBInstance.Upgrading.AutoMinorVersionUpgrades) | -| Modifying the backup window | Yes | — | [Working with backups](USER_WorkingWithAutomatedBackups.md) [Modifying an Amazon RDS DB instance](Overview.DBInstance.Modifying.md) | -| Changing the DB instance class | Yes | — | [Modifying an Amazon RDS DB instance](Overview.DBInstance.Modifying.md) | -| Changing the allocated storage | Yes | — | [Modifying an Amazon RDS DB instance](Overview.DBInstance.Modifying.md) | -| Storage autoscaling | Yes | — | [Managing capacity automatically with Amazon RDS storage autoscaling](USER_PIOPS.StorageTypes.md#USER_PIOPS.Autoscaling) | -| Manual and automatic DB instance snapshots | Yes | You can store automated backups and manual snapshots in your AWS Region\. Or you can store them locally on your Outpost\. Local backups are supported on MySQL and PostgreSQL DB instances\. To store backups on your Outpost, make sure that you have Amazon S3 on Outposts configured\. | [Creating DB instances for Amazon RDS on AWS Outposts](rds-on-outposts.creating.md) [Amazon S3 on Outposts](https://aws.amazon.com/s3/outposts/) [Creating a DB snapshot](USER_CreateSnapshot.md) | -| Restoring from a DB snapshot | Yes | You can store automated backups and manual snapshots for the restored DB instance in the parent AWS Region or locally on your Outpost\. | [Considerations for restoring DB instances on Amazon RDS on AWS Outposts](rds-on-outposts.restoring.md) [Restoring from a DB snapshot](USER_RestoreFromSnapshot.md) | -| Restoring a DB instance from Amazon S3 | No | — | [Restoring a backup into a MySQL DB instance](MySQL.Procedural.Importing.md) | -| Exporting snapshot data to Amazon S3 | No | — | [Exporting DB snapshot data to Amazon S3](USER_ExportSnapshot.md) | -| Point\-in\-time recovery | Yes | You can store automated backups and manual snapshots for the restored DB instance in the parent AWS Region or locally on your Outpost, with one exception\. | [Considerations for restoring DB instances on Amazon RDS on AWS Outposts](rds-on-outposts.restoring.md) [Restoring a DB instance to a specified time](USER_PIT.md) | -| Enhanced monitoring | No | — | [Monitoring OS metrics with Enhanced Monitoring](USER_Monitoring.OS.md) | -| Amazon CloudWatch monitoring | Yes | You can view the same set of metrics that are available for your databases in the AWS Region\. | [Monitoring Amazon RDS metrics with Amazon CloudWatch](monitoring-cloudwatch.md) | -| Publishing database engine logs to CloudWatch Logs | Yes | — | [Publishing database logs to Amazon CloudWatch Logs](USER_LogAccess.Procedural.UploadtoCloudWatch.md) | -| Event notification | Yes | — | [Working with Amazon RDS event notification](USER_Events.md) | -| Amazon RDS Performance Insights | No | — | [Monitoring DB load with Performance Insights on Amazon RDS](USER_PerfInsights.md) | -| Viewing or downloading database logs | No | RDS on Outposts doesn't support viewing database logs using the console or describing database logs using the AWS CLI or RDS API\. RDS on Outposts doesn't support downloading database logs using the console or downloading database logs using the AWS CLI or RDS API\. | [Monitoring Amazon RDS log files](USER_LogAccess.md) | -| Amazon RDS Proxy | No | — | [Using Amazon RDS Proxy](rds-proxy.md) | -| Stored procedures for Amazon RDS for MySQL | Yes | — | [RDS for MySQL stored procedure reference](Appendix.MySQL.SQLRef.md) | -| Replication with external databases for RDS for MySQL | No | — | [Configuring binary log file position replication with an external source instance](MySQL.Procedural.Importing.External.Repl.md) | -| Native backup and restore for Amazon RDS for Microsoft SQL Server | Yes | — | [Importing and exporting SQL Server databases using native backup and restore](SQLServer.Procedural.Importing.md) | \ No newline at end of file diff --git a/doc_source/rds-on-outposts.maz.md b/doc_source/rds-on-outposts.maz.md deleted file mode 100644 index 22823df..0000000 --- a/doc_source/rds-on-outposts.maz.md +++ /dev/null @@ -1,69 +0,0 @@ -# Working with Multi\-AZ deployments for Amazon RDS on AWS Outposts - -For Multi\-AZ deployments, Amazon RDS creates a primary DB instance on one AWS Outpost\. RDS synchronously replicates the data to a standby DB instance on a different Outpost\. - -Multi\-AZ deployments on AWS Outposts operate like Multi\-AZ deployments in AWS Regions, but with the following differences: -+ They require a local connection between two or more Outposts\. -+ They require customer\-owned IP \(CoIP\) pools\. For more information, see [Customer\-owned IP addresses for Amazon RDS on AWS Outposts](rds-on-outposts.coip.md)\. -+ Replication runs on your local network\. - -Multi\-AZ on AWS Outposts is available for all supported versions of MySQL and PostgreSQL on RDS on Outposts\. Local backups aren't supported for Multi\-AZ deployments\. For more information, see [Creating DB instances for Amazon RDS on AWS Outposts](rds-on-outposts.creating.md)\. - -## Working with the shared responsibility model - -Although AWS uses commercially reasonable efforts to provide DB instances configured for high availability, the availability uses a shared responsibility model\. The ability of RDS on Outposts to fail over and repair DB instances requires each of your Outposts to be connected to its AWS Region\. - -RDS on Outposts also requires connectivity between the Outpost that is hosting the primary DB instance and the Outpost that is hosting the standby DB instance for synchronous replication\. Any impact to this connection can prevent RDS on Outposts from performing a failover\. - -You might see elevated latencies for a standard DB instance deployment as a result of the synchronous data replication\. The bandwidth and latency of the connection between the Outpost hosting the primary DB instance and the Outpost hosting the standby DB instance directly affect latencies\. For more information, see [Prerequisites](#rds-on-outposts.maz.prereqs)\. - -## Improving availability - -We recommend the following actions to improve availability: -+ Allocate enough additional capacity for your mission\-critical applications to allow recovery and failover if there is an underlying host issue\. This applies to all Outposts that contain subnets in your DB subnet group\. For more information, see [Resilience in AWS Outposts](https://docs.aws.amazon.com/outposts/latest/userguide/disaster-recovery-resiliency.html)\. -+ Provide redundant network connectivity for your Outposts\. -+ Use more than two Outposts\. Having more than two Outposts allows Amazon RDS to recover a DB instance\. RDS does this recovery by moving the DB instance to another Outpost if the current Outpost experiences a failure\. -+ Provide dual power sources and redundant network connectivity for your Outpost\. - -We recommend the following for your local networks: -+ The round trip time \(RTT\) latency between the Outpost hosting your primary DB instance and the Outpost hosting your standby DB instance directly affects write latency\. Keep the RTT latency between the AWS Outposts in the low single\-digit milliseconds\. We recommend not more than 5 milliseconds, but your requirements might vary\. - - You can find the net impact to network latency in the Amazon CloudWatch metrics for `WriteLatency`\. For more information, see [Amazon CloudWatch metrics for Amazon RDS](rds-metrics.md)\. -+ The availability of the connection between the Outposts affects the overall availability of your DB instances\. Have redundant network connectivity between the Outposts\. - -## Prerequisites - -Multi\-AZ deployments on RDS on Outposts have the following prerequisites: -+ Have at least two Outposts, connected over local connections and attached to different Availability Zones in an AWS Region\. -+ Make sure that your DB subnet groups contain the following: - + At least two subnets in at least two Availability Zones in a given AWS Region\. - + Subnets only in Outposts\. - + At least two subnets in at least two Outposts within the same virtual private cloud \(VPC\)\. -+ Associate your DB instance's VPC with all of your local gateway route tables\. This association is necessary because replication runs over your local network using your Outposts' local gateways\. - - For example, suppose that your VPC contains subnet\-A in Outpost\-A and subnet\-B in Outpost\-B\. Outpost\-A uses LocalGateway\-A \(LGW\-A\), and Outpost\-B uses LocalGateway\-B \(LGW\-B\)\. LGW\-A has RouteTable\-A, and LGW\-B has RouteTable\-B\. You want to use both RouteTable\-A and RouteTable\-B for replication traffic\. To do this, associate your VPC with both RouteTable\-A and RouteTable\-B\. - - For more information about how to create an association, see the Amazon EC2 [create\-local\-gateway\-route\-table\-vpc\-association](https://docs.aws.amazon.com/cli/latest/reference/ec2/create-local-gateway-route-table-vpc-association.html) AWS CLI command\. -+ Make sure that your Outposts use customer\-owned IP \(CoIP\) routing\. Each route table must also each have at least one address pool\. Amazon RDS allocates an additional IP address each for the primary and standby DB instances for data synchronization\. -+ Make sure that the AWS account that owns the RDS DB instances owns the local gateway route tables and CoIP pools\. Or make sure it's part of a Resource Access Manager share with access to the local gateway route tables and CoIP pools\. -+ Make sure that the IP addresses in your CoIP pools can be routed from one Outpost local gateway to the others\. -+ Make sure that the VPC's CIDR blocks \(for example, 10\.0\.0\.0/4\) and your CoIP pool CIDR blocks don't contain IP addresses from Class E \(240\.0\.0\.0/4\)\. RDS uses these IP addresses internally\. -+ Make sure that you correctly set up outbound and related inbound traffic\. - - RDS on Outposts establishes a virtual private network \(VPN\) connection between the primary and standby DB instances\. For this to work correctly, your local network must allow outbound and related inbound traffic for Internet Security Association and Key Management Protocol \(ISAKMP\)\. It does so using User Datagram Protocol \(UDP\) port 500 and IP Security \(IPsec\) Network Address Translation Traversal \(NAT\-T\) using UDP port 4500\. - -For more information on CoIPs, see [Customer\-owned IP addresses for Amazon RDS on AWS Outposts](rds-on-outposts.coip.md) in this guide, and [Customer\-owned IP addresses](https://docs.aws.amazon.com/outposts/latest/userguide/how-racks-work.html#ip-addressing) in the *AWS Outposts User Guide*\. - -## Working with API operations for Amazon EC2 permissions - -Regardless of whether you use CoIPs for your DB instance on AWS Outposts, RDS requires access to your CoIP pool resources\. RDS can call the following EC2 permissions API operations for CoIPs on your behalf for Multi\-AZ deployments: -+ `CreateCoipPoolPermission` – When you create a Multi\-AZ DB instance on RDS on Outposts -+ `DeleteCoipPoolPermission` – When you delete a Multi\-AZ DB instance on RDS on Outposts - -These API operations grant to, or remove from, internal RDS accounts the permission to allocate elastic IP addresses from the CoIP pool specified by the permission\. You can view these IP addresses using the `DescribeCoipPoolUsage` API operation\. For more information on CoIPs, see [Customer\-owned IP addresses for Amazon RDS on AWS Outposts](rds-on-outposts.coip.md) and [Customer\-owned IP addresses](https://docs.aws.amazon.com/outposts/latest/userguide/how-racks-work.html#ip-addressing) in the *AWS Outposts User Guide*\. - -RDS can also call the following EC2 permission API operations for local gateway route tables on your behalf for Multi\-AZ deployments: -+ `CreateLocalGatewayRouteTablePermission` – When you create a Multi\-AZ DB instance on RDS on Outposts -+ `DeleteLocalGatewayRouteTablePermission` – When you delete a Multi\-AZ DB instance on RDS on Outposts - -These API operations grant to, or remove from, internal RDS accounts the permission to associate internal RDS VPCs with your local gateway route tables\. You can view these route table–VPC associations using the `DescribeLocalGatewayRouteTableVpcAssociations` API operations\. \ No newline at end of file diff --git a/doc_source/rds-on-outposts.md b/doc_source/rds-on-outposts.md deleted file mode 100644 index 06dcefa..0000000 --- a/doc_source/rds-on-outposts.md +++ /dev/null @@ -1,32 +0,0 @@ -# Working with Amazon RDS on AWS Outposts - -Amazon RDS on AWS Outposts extends RDS for SQL Server, RDS for MySQL, and RDS for PostgreSQL databases to AWS Outposts environments\. AWS Outposts uses the same hardware as in public AWS Regions to bring AWS services, infrastructure, and operation models on\-premises\. With RDS on Outposts, you can provision managed DB instances close to the business applications that must run on\-premises\. For more information about AWS Outposts, see [AWS Outposts](http://aws.amazon.com/outposts/)\. - -You use the same AWS Management Console, AWS CLI, and RDS API to provision and manage on\-premises RDS on Outposts DB instances as you do for RDS DB instances running in the AWS Cloud\. RDS on Outposts automates tasks, such as database provisioning, operating system and database patching, backup, and long\-term archival in Amazon S3\. - -RDS on Outposts supports automated backups of DB instances\. Network connectivity between your Outpost and your AWS Region is required to back up and restore DB instances\. All DB snapshots and transaction logs from an Outpost are stored in your AWS Region\. From your AWS Region, you can restore a DB instance from a DB snapshot to a different Outpost\. For more information, see [Working with backups](USER_WorkingWithAutomatedBackups.md)\. - -RDS on Outposts supports automated maintenance and upgrades of DB instances\. For more information, see [Maintaining a DB instance](USER_UpgradeDBInstance.Maintenance.md)\. - -RDS on Outposts uses encryption at rest for DB instances and DB snapshots using your AWS KMS key\. For more information about encryption at rest, see [Encrypting Amazon RDS resources](Overview.Encryption.md)\. - -By default, EC2 instances in Outposts subnets can use the Amazon Route 53 DNS Service to resolve domain names to IP addresses\. You might encounter longer DNS resolution times with Route 53, depending on the path latency between your Outpost and the AWS Region\. In such cases, you can use the DNS servers installed locally in your on\-premises environment\. For more information, see [DNS](https://docs.aws.amazon.com/outposts/latest/userguide/outposts-networking-components.html#dns) in the *AWS Outposts User Guide*\. - -When network connectivity to the AWS Region isn't available, your DB instance continues to run locally\. You can continue to access DB instances using DNS name resolution by configuring a local DNS server as a secondary server\. However, you can't create new DB instances or take new actions on existing DB instances\. Automatic backups don't occur when there is no connectivity\. If there is a DB instance failure, the DB instance isn't automatically replaced until connectivity is restored\. We recommend restoring network connectivity as soon as possible\. - -**Topics** -+ [Prerequisites for Amazon RDS on AWS Outposts](#rds-on-outposts.prerequisites) -+ [Amazon RDS on AWS Outposts support for Amazon RDS features](rds-on-outposts.features.md) -+ [Supported DB instance classes for Amazon RDS on AWS Outposts](rds-on-outposts.db-instance-classes.md) -+ [Customer\-owned IP addresses for Amazon RDS on AWS Outposts](rds-on-outposts.coip.md) -+ [Working with Multi\-AZ deployments for Amazon RDS on AWS Outposts](rds-on-outposts.maz.md) -+ [Creating DB instances for Amazon RDS on AWS Outposts](rds-on-outposts.creating.md) -+ [Creating read replicas for Amazon RDS on AWS Outposts](rds-on-outposts.rr.md) -+ [Considerations for restoring DB instances on Amazon RDS on AWS Outposts](rds-on-outposts.restoring.md) - -## Prerequisites for Amazon RDS on AWS Outposts - -The following are prerequisites for using Amazon RDS on AWS Outposts: -+ Install AWS Outposts in your on\-premises data center\. For more information about AWS Outposts, see [AWS Outposts](http://aws.amazon.com/outposts/)\. -+ Make sure that you have at least one subnet available for RDS on Outposts\. You can use the same subnet for other workloads\. -+ Make sure that you have a reliable network connection between your Outpost and an AWS Region\. \ No newline at end of file diff --git a/doc_source/rds-on-outposts.restoring.md b/doc_source/rds-on-outposts.restoring.md deleted file mode 100644 index 35833fb..0000000 --- a/doc_source/rds-on-outposts.restoring.md +++ /dev/null @@ -1,7 +0,0 @@ -# Considerations for restoring DB instances on Amazon RDS on AWS Outposts - -When you restore a DB instance in Amazon RDS on AWS Outposts, you can generally choose the storage location for automated backups and manual snapshots of the restored DB instance\. -+ When restoring from a manual DB snapshot, you can store backups either in the parent AWS Region or locally on your Outpost\. -+ When restoring from an automated backup \(point\-in\-time recovery\), you have fewer choices: - + If restoring from the parent AWS Region, you can store backups either in the AWS Region or on your Outpost\. - + If restoring from your Outpost, you can store backups only on your Outpost\. \ No newline at end of file diff --git a/doc_source/rds-on-outposts.rr.md b/doc_source/rds-on-outposts.rr.md deleted file mode 100644 index 4f19160..0000000 --- a/doc_source/rds-on-outposts.rr.md +++ /dev/null @@ -1,94 +0,0 @@ -# Creating read replicas for Amazon RDS on AWS Outposts - -Amazon RDS on AWS Outposts uses the MySQL and PostgreSQL DB engines' built\-in replication functionality to create a read replica from a source DB instance\. The source DB instance becomes the primary DB instance\. Updates made to the primary DB instance are asynchronously copied to the read replica\. You can reduce the load on your primary DB instance by routing read queries from your applications to the read replica\. Using read replicas, you can elastically scale out beyond the capacity constraints of a single DB instance for read\-heavy database workloads\. - -When you create a read replica from an RDS on Outposts DB instance, the read replica uses a customer\-owned IP address \(CoIP\)\. For more information, see [Customer\-owned IP addresses for Amazon RDS on AWS Outposts](rds-on-outposts.coip.md)\. - -Read replicas on RDS on Outposts have the following limitations: -+ You can't create read replicas for RDS for SQL Server on RDS on Outposts DB instances\. -+ Cross\-Region read replicas aren't supported on RDS on Outposts\. -+ Cascading read replicas aren't supported on RDS on Outposts\. -+ The source RDS on Outposts DB instance can't have local backups\. The backup target for the source DB instance must be your AWS Region\. -+ Read replicas require customer\-owned IP \(CoIP\) pools\. For more information, see [Customer\-owned IP addresses for Amazon RDS on AWS Outposts](rds-on-outposts.coip.md)\. - -You can create a read replica from an RDS on Outposts DB instance using the AWS Management Console, AWS CLI, or RDS API\. For more information on read replicas, see [Working with DB instance read replicas](USER_ReadRepl.md)\. - -## Console - -**To create a read replica from a source DB instance** - -1. Sign in to the AWS Management Console and open the Amazon RDS console at [https://console\.aws\.amazon\.com/rds/](https://console.aws.amazon.com/rds/)\. - -1. In the navigation pane, choose **Databases**\. - -1. Choose the DB instance that you want to use as the source for a read replica\. - -1. For **Actions**, choose **Create read replica**\. - -1. For **DB instance identifier**, enter a name for the read replica\. - -1. Specify your settings for **Outposts Connectivity**\. These settings are for the Outpost that uses the virtual private cloud \(VPC\) that has the DB subnet group for your DB instance\. Your VPC must be based on the Amazon VPC service\. - -1. Choose your **DB instance class**\. We recommend that you use the same or larger DB instance class and storage type as the source DB instance for the read replica\. - -1. For **Multi\-AZ deployment**, choose **Create a standby instance \(recommended for production usage\)** to create a standby DB instance in a different Availability Zone\. - - Creating your read replica as a Multi\-AZ DB instance is independent of whether the source database is a Multi\-AZ DB instance\. - -1. \(Optional\) Under **Connectivity**, set values for **Subnet Group** and **Availability Zone**\. - - If you specify values for both **Subnet Group** and **Availability Zone**, the read replica is created on an Outpost that is associated with the Availability Zone in the DB subnet group\. - - If you specify a value for **Subnet Group** and **No preference** for **Availability Zone**, the read replica is created on a random Outpost in the DB subnet group\. - -1. For **AWS KMS key**, choose the AWS KMS key identifier of the KMS key\. - - The read replica must be encrypted\. - -1. Choose other options as needed\. - -1. Choose **Create read replica**\. - -After the read replica is created, you can see it on the **Databases** page in the RDS console\. It shows **Replica** in the **Role** column\. - -## AWS CLI - -To create a read replica from a source MySQL or PostgreSQL DB instance, use the AWS CLI command [create\-db\-instance\-read\-replica](https://docs.aws.amazon.com/cli/latest/reference/rds/create-db-instance-read-replica.html)\. - -You can control where the read replica is created by specifying the `--db-subnet-group-name` and `--availability-zone` options: -+ If you specify both the `--db-subnet-group-name` and `--availability-zone` options, the read replica is created on an Outpost that is associated with the Availability Zone in the DB subnet group\. -+ If you specify the `--db-subnet-group-name` option and don't specify the `--availability-zone` option, the read replica is created on a random Outpost in the DB subnet group\. -+ If you don't specify either option, the read replica is created on the same Outpost as the source RDS on Outposts DB instance\. - -The following example creates a replica and specifies the location of the read replica by including `--db-subnet-group-name` and `--availability-zone` options\. - -**Example** -For Linux, macOS, or Unix: - -``` -aws rds create-db-instance-read-replica \ - --db-instance-identifier myreadreplica \ - --source-db-instance-identifier mydbinstance \ - --db-subnet-group-name myoutpostdbsubnetgr \ - --availability-zone us-west-2a -``` -For Windows: - -``` -aws rds create-db-instance-read-replica ^ - --db-instance-identifier myreadreplica ^ - --source-db-instance-identifier mydbinstance ^ - --db-subnet-group-name myoutpostdbsubnetgr ^ - --availability-zone us-west-2a -``` - -## RDS API - -To create a read replica from a source MySQL or PostgreSQL DB instance, call the Amazon RDS API [CreateDBInstanceReadReplica](https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_CreateDBInstanceReadReplica.html) operation with the following required parameters: -+ `DBInstanceIdentifier` -+ `SourceDBInstanceIdentifier` - -You can control where the read replica is created by specifying the `DBSubnetGroupName` and `AvailabilityZone` parameters: -+ If you specify both the `DBSubnetGroupName` and `AvailabilityZone` parameters, the read replica is created on an Outpost that is associated with the Availability Zone in the DB subnet group\. -+ If you specify the `DBSubnetGroupName` parameter and don't specify the `AvailabilityZone` parameter, the read replica is created on a random Outpost in the DB subnet group\. -+ If you don't specify either parameter, the read replica is created on the same Outpost as the source RDS on Outposts DB instance\. \ No newline at end of file diff --git a/doc_source/rds-optimized-reads-mariadb.md b/doc_source/rds-optimized-reads-mariadb.md deleted file mode 100644 index 0ce8fb6..0000000 --- a/doc_source/rds-optimized-reads-mariadb.md +++ /dev/null @@ -1,91 +0,0 @@ -# Improving query performance for RDS for MariaDB with Amazon RDS Optimized Reads - -You can achieve faster query processing for RDS for MariaDB with Amazon RDS Optimized Reads\. An RDS for MariaDB DB instance that uses RDS Optimized Reads can achieve up to 2x faster query processing compared to a DB instance that doesn't use it\. - -**Topics** -+ [Overview of RDS Optimized Reads](#rds-optimized-reads-mariadb-overview) -+ [Use cases for RDS Optimized Reads](#rds-optimized-reads-mariadb-use-cases) -+ [Best practices for RDS Optimized Reads](#rds-optimized-reads-mariadb-best-practices) -+ [Using RDS Optimized Reads](#rds-optimized-reads-mariadb-using) -+ [Monitoring DB instances that use RDS Optimized Reads](#rds-optimized-reads-mariadb-monitoring) -+ [Limitations for RDS Optimized Reads](#rds-optimized-reads-mariadb-limitations) - -## Overview of RDS Optimized Reads - -When you use an RDS for MariaDB DB instance that has RDS Optimized Reads turned on, your DB instance achieves faster query performance through the use of an instance store\. An *instance store* provides temporary block\-level storage for your DB instance\. The storage is located on Non\-Volatile Memory Express \(NVMe\) solid state drives \(SSDs\) that are physically attached to the host server\. This storage is optimized for low latency, high random I/O performance, and high sequential read throughput\. - -RDS Optimized Reads is turned on by default when a DB instance uses a DB instance class with an instance store, such as db\.m5d or db\.m6gd\. With RDS Optimized Reads, some temporary objects are stored on the instance store\. These temporary objects include internal temporary files, internal on\-disk temp tables, memory map files, and binary log \(binlog\) cache files\. For more information about the instance store, see [Amazon EC2 instance store](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/InstanceStorage.html) in the *Amazon Elastic Compute Cloud User Guide for Linux Instances*\. - -The workloads that generate temporary objects in MariaDB for query processing can take advantage of the instance store for faster query processing\. This type of workload includes queries involving sorts, hash aggregations, high\-load joins, Common Table Expressions \(CTEs\), and queries on unindexed columns\. These instance store volumes provide higher IOPS and performance, regardless of the storage configurations used for persistent Amazon EBS storage\. Because RDS Optimized Reads offloads operations on temporary objects to the instance store, the input/output operations per second \(IOPS\) or throughput of the persistent storage \(Amazon EBS\) can now be used for operations on persistent objects\. These operations include regular data file reads and writes and background engine operations, such as flushing and insert buffer merges\. - -**Note** -Both manual and automated RDS snapshots contain only the engine files for persistent objects\. The temporary objects created in the instance store aren't included in RDS snapshots\. - -## Use cases for RDS Optimized Reads - -If you have workloads that rely heavily on temporary objects, such as internal tables or files, for their query execution, then you can benefit from turning on RDS Optimized Reads\. The following use cases are candidates for RDS Optimized Reads: -+ Applications that run analytical queries with complex common table expressions \(CTEs\), derived tables, and grouping operations -+ Read replicas that serve heavy read traffic with unoptimized queries -+ Applications that run on\-demand or dynamic reporting queries that involve complex operations, such as queries with `GROUP BY` and `ORDER BY` clauses -+ Workloads that use internal temporary tables for query processing - - You can monitor the engine status variable `created_tmp_disk_tables` to determine the number of disk\-based temporary tables created on your DB instance\. -+ Applications that create large temporary tables, either directly or in procedures, to store intermediate results -+ Database queries that perform grouping or ordering on non\-indexed columns - -## Best practices for RDS Optimized Reads - -Use the following best practices for RDS Optimized Reads: -+ Add retry logic for read\-only queries in case they fail because the instance store is full during the execution\. -+ Monitor the storage space available on the instance store with the CloudWatch metric `FreeLocalStorage`\. If the instance store is reaching its limit because of workload on the DB instance, modify the DB instance to use a larger DB instance class\. -+ When your DB instance has sufficient memory but is still reaching the storage limit on the instance store, increase the `binlog_cache_size` value to maintain the session\-specific binlog entries in memory\. This configuration prevents writing the binlog entries to temporary binlog cache files on disk\. - - The `binlog_cache_size` parameter is session\-specific\. You can change the value for each new session\. The setting for this parameter can increase the memory utilization on the DB instance during peak workload\. Therefore, consider increasing the parameter value based on the workload pattern of your application and available memory on the DB instance\. -+ Use the default value of `MIXED` for the `binlog_format`\. Depending on the size of the transactions, setting `binlog_format` to `ROW` can result in large binlog cache files on the instance store\. -+ Avoid performing bulk changes in a single transaction\. These types of transactions can generate large binlog cache files on the instance store and can cause issues when the instance store is full\. Consider splitting writes into multiple small transactions to minimize storage use for binlog cache files\. - -## Using RDS Optimized Reads - -When you provision an RDS for MariaDB DB instance with one of the following DB instance classes in a Single\-AZ DB instance deployment or Multi\-AZ DB instance deployment, the DB instance automatically uses RDS Optimized Reads: -+ db\.x2idn -+ db\.x2iedn -+ db\.m6gd -+ db\.r6gd -+ db\.m5d -+ db\.r5d - -To turn on RDS Optimized Reads, do one of the following: -+ Create an RDS for MariaDB DB instance using one of these DB instance classes\. For more information, see [Creating an Amazon RDS DB instance](USER_CreateDBInstance.md)\. -+ Modify an existing RDS for MariaDB DB instance to use one of these DB instance classes\. For more information, see [Modifying an Amazon RDS DB instance](Overview.DBInstance.Modifying.md)\. - -RDS Optimized Reads is available in all AWS Regions where one or more of these DB instance classes are supported\. For information about DB instance classes, see [DB instance classes](Concepts.DBInstanceClass.md)\. - -DB instance class availability differs for AWS Regions\. To determine whether a DB instance class is supported in a specific AWS Region, see [Determining DB instance class support in AWS Regions](Concepts.DBInstanceClass.md#Concepts.DBInstanceClass.RegionSupport)\. - -If you don't want to use RDS Optimized Reads, modify your DB instance so that it doesn't use a DB instance class that supports the feature\. - -## Monitoring DB instances that use RDS Optimized Reads - -You can monitor DB instances that use RDS Optimized Reads with the following CloudWatch metrics: -+ `FreeLocalStorage` -+ `ReadIOPSLocalStorage` -+ `ReadLatencyLocalStorage` -+ `ReadThroughputLocalStorage` -+ `WriteIOPSLocalStorage` -+ `WriteLatencyLocalStorage` -+ `WriteThroughputLocalStorage` - -These metrics provide data about available instance store storage, IOPS, and throughput\. For more information about these metrics, see [Amazon CloudWatch instance\-level metrics for Amazon RDS](rds-metrics.md#rds-cw-metrics-instance)\. - -## Limitations for RDS Optimized Reads - -The following limitations apply to RDS Optimized Reads: -+ RDS Optimized Reads is supported for the following RDS for MariaDB versions: - + 10\.6\.7 and higher 10\.6 versions - + 10\.5\.16 and higher 10\.5 versions - + 10\.4\.25 and higher 10\.4 versions - - For information about RDS for MariaDB versions, see [MariaDB on Amazon RDS versions](MariaDB.Concepts.VersionMgmt.md)\. -+ You can't change the location of temporary objects to persistent storage \(Amazon EBS\) on the DB instance classes that support RDS Optimized Reads\. -+ When binary logging is enabled on a DB instance, the maximum transaction size is limited by the size of the instance store\. In MariaDB, any session that requires more storage than the value of `binlog_cache_size` writes transaction changes to temporary binlog cache files, which are created on the instance store\. -+ Transactions can fail when the instance store is full\. \ No newline at end of file diff --git a/doc_source/rds-optimized-reads.md b/doc_source/rds-optimized-reads.md deleted file mode 100644 index 4cb6fed..0000000 --- a/doc_source/rds-optimized-reads.md +++ /dev/null @@ -1,88 +0,0 @@ -# Improving query performance for RDS for MySQL with Amazon RDS Optimized Reads - -You can achieve faster query processing for RDS for MySQL with Amazon RDS Optimized Reads\. An RDS for MySQL DB instance or Multi\-AZ DB cluster that uses RDS Optimized Reads can achieve up to 2x faster query processing compared to a DB instance or cluster that doesn't use it\. - -**Topics** -+ [Overview of RDS Optimized Reads](#rds-optimized-reads-overview) -+ [Use cases for RDS Optimized Reads](#rds-optimized-reads-use-cases) -+ [Best practices for RDS Optimized Reads](#rds-optimized-reads-best-practices) -+ [Using RDS Optimized Reads](#rds-optimized-reads-using) -+ [Monitoring DB instances that use RDS Optimized Reads](#rds-optimized-reads-monitoring) -+ [Limitations for RDS Optimized Reads](#rds-optimized-reads-limitations) - -## Overview of RDS Optimized Reads - -When you use an RDS for MySQL DB instance or Multi\-AZ DB cluster that has RDS Optimized Reads turned on, it achieves faster query performance through the use of an instance store\. An *instance store* provides temporary block\-level storage for your DB instance or Multi\-AZ DB cluster\. The storage is located on Non\-Volatile Memory Express \(NVMe\) solid state drives \(SSDs\) that are physically attached to the host server\. This storage is optimized for low latency, high random I/O performance, and high sequential read throughput\. - -RDS Optimized Reads is turned on by default when a DB instance or Multi\-AZ DB cluster uses a DB instance class with an instance store, such as db\.m5d or db\.m6gd\. With RDS Optimized Reads, some temporary objects are stored on the instance store\. These temporary objects include internal temporary files, internal on\-disk temp tables, memory map files, and binary log \(binlog\) cache files\. For more information about the instance store, see [Amazon EC2 instance store](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/InstanceStorage.html) in the *Amazon Elastic Compute Cloud User Guide for Linux Instances*\. - -The workloads that generate temporary objects in MySQL for query processing can take advantage of the instance store for faster query processing\. This type of workload includes queries involving sorts, hash aggregations, high\-load joins, Common Table Expressions \(CTEs\), and queries on unindexed columns\. These instance store volumes provide higher IOPS and performance, regardless of the storage configurations used for persistent Amazon EBS storage\. Because RDS Optimized Reads offloads operations on temporary objects to the instance store, the input/output operations per second \(IOPS\) or throughput of the persistent storage \(Amazon EBS\) can now be used for operations on persistent objects\. These operations include regular data file reads and writes, and background engine operations, such as flushing and insert buffer merges\. - -**Note** -Both manual and automated RDS snapshots only contain engine files for persistent objects\. The temporary objects created in the instance store aren't included in RDS snapshots\. - -## Use cases for RDS Optimized Reads - -If you have workloads that rely heavily on temporary objects, such as internal tables or files, for their query execution, then you can benefit from turning on RDS Optimized Reads\. The following use cases are candidates for RDS Optimized Reads: -+ Applications that run analytical queries with complex common table expressions \(CTEs\), derived tables, and grouping operations -+ Read replicas that serve heavy read traffic with unoptimized queries -+ Applications that run on\-demand or dynamic reporting queries that involve complex operations, such as queries with `GROUP BY` and `ORDER BY` clauses -+ Workloads that use internal temporary tables for query processing - - You can monitor the engine status variable `created_tmp_disk_tables` to determine the number of disk\-based temporary tables created on your DB instance\. -+ Applications that create large temporary tables, either directly or in procedures, to store intermediate results -+ Database queries that perform grouping or ordering on non\-indexed columns - -## Best practices for RDS Optimized Reads - -Use the following best practices for RDS Optimized Reads: -+ Add retry logic for read\-only queries in case they fail because the instance store is full during the execution\. -+ Monitor the storage space available on the instance store with the CloudWatch metric `FreeLocalStorage`\. If the instance store is reaching its limit because of workload on the DB instance, modify the DB instance to use a larger DB instance class\. -+ When your DB instance or Multi\-AZ DB cluster has sufficient memory but is still reaching the storage limit on the instance store, increase the `binlog_cache_size` value to maintain the session\-specific binlog entries in memory\. This configuration prevents writing the binlog entries to temporary binlog cache files on disk\. - - The `binlog_cache_size` parameter is session\-specific\. You can change the value for each new session\. The setting for this parameter can increase the memory utilization on the DB instance during peak workload\. Therefore, consider increasing the parameter value based on the workload pattern of your application and available memory on the DB instance\. -+ Use the default value of `MIXED` for the `binlog_format`\. Depending on the size of the transactions, setting `binlog_format` to `ROW` can result in large binlog cache files on the instance store\. -+ Set the [internal\_tmp\_mem\_storage\_engine](https://dev.mysql.com/doc/refman/8.0/en/server-system-variables.html#sysvar_internal_tmp_mem_storage_engine) parameter to `TempTable`, and set the [temptable\_max\_mmap](https://dev.mysql.com/doc/refman/8.0/en/server-system-variables.html#sysvar_temptable_max_mmap) parameter to match the size of the available storage on the instance store\. -+ Avoid performing bulk changes in a single transaction\. These types of transactions can generate large binlog cache files on the instance store and can cause issues when the instance store is full\. Consider splitting writes into multiple small transactions to minimize storage use for binlog cache files\. -+ Use the default value of `ABORT_SERVER` for the `binlog_error_action` parameter\. Doing so avoids issues with the binary logging on DB instances with backups enabled\. - -## Using RDS Optimized Reads - -When you provision an RDS for MySQL DB instance with one of the following DB instance classes in a Single\-AZ DB instance deployment, Multi\-AZ DB instance deployment, or Multi\-AZ DB cluster deployment, the DB instance automatically uses RDS Optimized Reads: -+ db\.x2idn -+ db\.x2iedn -+ db\.m6gd -+ db\.r6gd -+ db\.m5d -+ db\.r5d - -To turn on RDS Optimized Reads, do one of the following: -+ Create an RDS for MySQL DB instance or Multi\-AZ DB cluster using one of these DB instance classes\. For more information, see [Creating an Amazon RDS DB instance](USER_CreateDBInstance.md)\. -+ Modify an existing RDS for MySQL DB instance or Multi\-AZ DB cluster to use one of these DB instance classes\. For more information, see [Modifying an Amazon RDS DB instance](Overview.DBInstance.Modifying.md)\. - -RDS Optimized Reads is available in all AWS Regions where one or more of these DB instance classes are supported\. For information about DB instance classes, see [DB instance classes](Concepts.DBInstanceClass.md)\. - -DB instance class availability differs for AWS Regions\. To determine whether a DB instance class is supported in a specific AWS Region, see [Determining DB instance class support in AWS Regions](Concepts.DBInstanceClass.md#Concepts.DBInstanceClass.RegionSupport)\. - -If you don't want to use RDS Optimized Reads, modify your DB instance or Multi\-AZ DB cluster so that it doesn't use a DB instance class that supports the feature\. - -## Monitoring DB instances that use RDS Optimized Reads - -You can monitor DB instances that use RDS Optimized Reads with the following CloudWatch metrics: -+ `FreeLocalStorage` -+ `ReadIOPSLocalStorage` -+ `ReadLatencyLocalStorage` -+ `ReadThroughputLocalStorage` -+ `WriteIOPSLocalStorage` -+ `WriteLatencyLocalStorage` -+ `WriteThroughputLocalStorage` - -These metrics provide data about available instance store storage, IOPS, and throughput\. For more information about these metrics, see [Amazon CloudWatch instance\-level metrics for Amazon RDS](rds-metrics.md#rds-cw-metrics-instance)\. - -## Limitations for RDS Optimized Reads - -The following limitations apply to RDS Optimized Reads: -+ RDS Optimized Reads is supported for RDS for MySQL version 8\.0\.28 and higher\. For information about RDS for MySQL versions, see [MySQL on Amazon RDS versions](MySQL.Concepts.VersionMgmt.md)\. -+ You can't change the location of temporary objects to persistent storage \(Amazon EBS\) on the DB instance classes that support RDS Optimized Reads\. -+ When binary logging is enabled on a DB instance, the maximum transaction size is limited by the size of the instance store\. In MySQL, any session that requires more storage than the value of `binlog_cache_size` writes transaction changes to temporary binlog cache files, which are created on the instance store\. -+ Transactions can fail when the instance store is full\. \ No newline at end of file diff --git a/doc_source/rds-optimized-writes-mariadb.md b/doc_source/rds-optimized-writes-mariadb.md deleted file mode 100644 index a8c7f91..0000000 --- a/doc_source/rds-optimized-writes-mariadb.md +++ /dev/null @@ -1,113 +0,0 @@ -# Improving write performance with Amazon RDS Optimized Writes for MariaDB - -You can improve the performance of write transactions with Amazon RDS Optimized Writes for MariaDB\. When your RDS for MariaDB database uses RDS Optimized Writes, it can achieve up to two times higher write transaction throughput\. - -**Topics** -+ [Overview of RDS Optimized Writes](#rds-optimized-writes-overview) -+ [Using RDS Optimized Writes](#rds-optimized-writes-using-mariadb) -+ [Limitations for RDS Optimized Writes](#rds-optimized-writes-limitations-mariadb) - -## Overview of RDS Optimized Writes - -When you turn on Amazon RDS Optimized Writes, your RDS for MariaDB databases write only once when flushing data to durable storage without the need for the doublewrite buffer\. The databases continue to provide ACID property protections for reliable database transactions, along with improved performance\. - -Relational databases, like MariaDB, provide the *ACID properties* of atomicity, consistency, isolation, and durability for reliable database transactions\. To help provide these properties, MariaDB uses a data storage area called the *doublewrite buffer* that prevents partial page write errors\. These errors occur when there is a hardware failure while the database is updating a page, such as in the case of a power outage\. A MariaDB database can detect partial page writes and recover with a copy of the page in the doublewrite buffer\. While this technique provides protection, it also results in extra write operations\. For more information about the MariaDB doublewrite buffer, see [InnoDB Doublewrite Buffer](https://mariadb.com/kb/en/innodb-doublewrite-buffer/) in the MariaDB documentation\. - -With RDS Optimized Writes turned on, RDS for MariaDB databases write only once when flushing data to durable storage without using the doublewrite buffer\. RDS Optimized Writes is useful if you run write\-heavy workloads on your RDS for MariaDB databases\. Examples of databases with write\-heavy workloads include ones that support digital payments, financial trading, and gaming applications\. - -These databases run on DB instance classes that use the AWS Nitro System\. Because of the hardware configuration in these systems, the database can write 16\-KiB pages directly to data files reliably and durably in one step\. The AWS Nitro System makes RDS Optimized Writes possible\. - -You can set the new database parameter `rds.optimized_writes` to control the RDS Optimized Writes feature for RDS for MariaDB databases\. Access this parameter in the DB parameter groups of RDS for MariaDB version 10\.6\.10 or higher\. Set the parameter using the following values: -+ `AUTO` – Turn on RDS Optimized Writes if the database supports it\. Turn off RDS Optimized Writes if the database doesn't support it\. This setting is the default\. -+ `OFF` – Turn off RDS Optimized Writes even if the database supports it\. - -If you migrate an RDS for MariaDB database that is configured to use RDS Optimized Writes to a DB instance class that doesn't support the feature, RDS automatically turns off RDS Optimized Writes for the database\. - -When RDS Optimized Writes is turned off, the database uses the MariaDB doublewrite buffer\. - -To determine whether an RDS for MariaDB database is using RDS Optimized Writes, view the current value of the `innodb_doublewrite` parameter for the database\. If the database is using RDS Optimized Writes, this parameter is set to `FALSE` \(`0`\)\. - -## Using RDS Optimized Writes - -You can turn on RDS Optimized Writes when you create an RDS for MariaDB database with the RDS console, the AWS CLI, or the RDS API\. RDS Optimized Writes is turned on automatically when both of the following conditions apply during database creation: -+ You specify a DB engine version and DB instance class that support RDS Optimized Writes\. - + RDS Optimized Writes is supported for RDS for MariaDB version 10\.6\.10 and higher\. For information about RDS for MariaDB versions, see [MariaDB on Amazon RDS versions](MariaDB.Concepts.VersionMgmt.md)\. - + RDS Optimized Writes is supported for RDS for MariaDB databases that use the following DB instance classes: - + db\.x2idn - + db\.x2iedn - + db\.m7g - + db\.r7g - + db\.r6g - + db\.r6gd - + db\.r6i - + db\.r5b - - For information about DB instance classes, see [DB instance classes](Concepts.DBInstanceClass.md)\. - - DB instance class availability differs for AWS Regions\. To determine whether a DB instance class is supported in a specific AWS Region, see [Determining DB instance class support in AWS Regions](Concepts.DBInstanceClass.md#Concepts.DBInstanceClass.RegionSupport)\. -+ In the parameter group associated with the database, the `rds.optimized_writes` parameter is set to `AUTO`\. In default parameter groups, this parameter is always set to `AUTO`\. - -If you want to use a DB engine version and DB instance class that support RDS Optimized Writes, but you don't want to use this feature, then specify a custom parameter group when you create the database\. In this parameter group, set the `rds.optimized_writes` parameter to `OFF`\. If you want the database to use RDS Optimized Writes later, you can set the parameter to `AUTO` to turn it on\. For information about creating custom parameter groups and setting parameters, see [Working with parameter groups](USER_WorkingWithParamGroups.md)\. - -For information about creating a DB instance, see [Creating an Amazon RDS DB instance](USER_CreateDBInstance.md)\. - -### Console - -When you use the RDS console to create an RDS for MariaDB database, you can filter for the DB engine versions and DB instance classes that support RDS Optimized Writes\. After you turn on the filters, you can choose from the available DB engine versions and DB instance classes\. - -To choose a DB engine version that supports RDS Optimized Writes, filter for the RDS for MariaDB DB engine versions that support it in **Engine version**, and then choose a version\. - -![\[DB engine version filter for RDS Optimized Writes.\]](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/images/rds-optimized-writes-version-filter-mariadb.png) - -In the **Instance configuration** section, filter for the DB instance classes that support RDS Optimized Writes, and then choose a DB instance class\. - -![\[DB instance class filter for RDS Optimized Writes.\]](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/images/rds-optimized-writes-class-filter.png) - -After you make these selections, you can choose other settings that meet your requirements and finish creating the RDS for MariaDB database with the console\. - -### AWS CLI - -To create a DB instance by using the AWS CLI, use the [create\-db\-instance](https://docs.aws.amazon.com/cli/latest/reference/rds/create-db-instance.html) command\. Make sure the `--engine-version` and `--db-instance-class` values support RDS Optimized Writes\. In addition, make sure the parameter group associated with the DB instance has the `rds.optimized_writes` parameter set to `AUTO`\. This example associates the default parameter group with the DB instance\. - -**Example Creating a DB instance that uses RDS Optimized Writes** -For Linux, macOS, or Unix: - -``` -1. aws rds create-db-instance \ -2. --db-instance-identifier mydbinstance \ -3. --engine mariadb \ -4. --engine-version 10.6.10 \ -5. --db-instance-class db.r5b.large \ -6. --master-user-password password \ -7. --master-username admin \ -8. --allocated-storage 200 -``` -For Windows: - -``` -1. aws rds create-db-instance ^ -2. --db-instance-identifier mydbinstance ^ -3. --engine mariadb ^ -4. --engine-version 10.6.10 ^ -5. --db-instance-class db.r5b.large ^ -6. --master-user-password password ^ -7. --master-username admin ^ -8. --allocated-storage 200 -``` - -### RDS API - -You can create a DB instance using the [ CreateDBInstance](https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_CreateDBInstance.html) operation\. When you use this operation, make sure the `EngineVersion` and `DBInstanceClass` values support RDS Optimized Writes\. In addition, make sure the parameter group associated with the DB instance has the `rds.optimized_writes` parameter set to `AUTO`\. - -## Limitations for RDS Optimized Writes - -The following limitations apply to RDS Optimized Writes: -+ You can only modify a database to turn on RDS Optimized Writes if the database was created with a DB engine version and DB instance class that support the feature\. In this case, if RDS Optimized Writes is turned off for the database, you can turn it on by setting the `rds.optimized_writes` parameter to `AUTO`\. For more information, see [Using RDS Optimized Writes](#rds-optimized-writes-using-mariadb)\. -+ You can only modify a database to turn on RDS Optimized Writes if the database was created *after* the feature was released\. The underlying file system format and organization that RDS Optimized Writes needs is incompatible with the file system format of databases created before the feature was released\. By extension, you can't use any snapshots of previously created instances with this feature because the snapshots use the older, incompatible file system\. -**Important** -To convert from the old format to the new format, you need to perform a full database migration\. If you want to use this feature on DB instances that were created *before* the feature was released, create a new empty DB instance and manually migrate your older DB instance to the newer DB instance\. You can migrate your older DB instance using the native `mysqldump` tool, replication, or AWS Database Migration Service\. For more information, see [mariadb\-dump/mysqldump](https://mariadb.com/kb/en/mariadb-dumpmysqldump/) in the MariaDB documentation, [Working with MariaDB replication in Amazon RDS](USER_MariaDB.Replication.md), and the [https://docs.aws.amazon.com/dms/latest/userguide/Welcome.html](https://docs.aws.amazon.com/dms/latest/userguide/Welcome.html)\. For help with migrating using AWS tools, contact support\. -+ When you are restoring an RDS for MariaDB database from a snapshot, you can only turn on RDS Optimized Writes for the database if all of the following conditions apply: - + The snapshot was created from a database that supports RDS Optimized Writes\. - + The snapshot was created from a database that was created *after* RDS Optimized Writes was released\. - + The snapshot is restored to a database that supports RDS Optimized Writes\. - + The restored database is associated with a parameter group that has the `rds.optimized_writes` parameter set to `AUTO`\. \ No newline at end of file diff --git a/doc_source/rds-optimized-writes.md b/doc_source/rds-optimized-writes.md deleted file mode 100644 index 9f23672..0000000 --- a/doc_source/rds-optimized-writes.md +++ /dev/null @@ -1,112 +0,0 @@ -# Improving write performance with Amazon RDS Optimized Writes for MySQL - -You can improve the performance of write transactions with Amazon RDS Optimized Writes for MySQL\. When your RDS for MySQL database uses RDS Optimized Writes, it can achieve up to two times higher write transaction throughput\. - -**Topics** -+ [Overview of RDS Optimized Writes](#rds-optimized-writes-overview) -+ [Using RDS Optimized Writes](#rds-optimized-writes-using) -+ [Limitations for RDS Optimized Writes](#rds-optimized-writes-limitations) - -## Overview of RDS Optimized Writes - -When you turn on Amazon RDS Optimized Writes, your RDS for MySQL databases write only once when flushing data to durable storage without the need for the doublewrite buffer\. The databases continue to provide ACID property protections for reliable database transactions, along with improved performance\. - -Relational databases, like MySQL, provide the *ACID properties* of atomicity, consistency, isolation, and durability for reliable database transactions\. To help provide these properties, MySQL uses a data storage area called the *doublewrite buffer* that prevents partial page write errors\. These errors occur when there is a hardware failure while the database is updating a page, such as in the case of a power outage\. A MySQL database can detect partial page writes and recover with a copy of the page in the doublewrite buffer\. While this technique provides protection, it also results in extra write operations\. For more information about the MySQL doublewrite buffer, see [Doublewrite Buffer](https://dev.mysql.com/doc/refman/8.0/en/innodb-doublewrite-buffer.html) in the MySQL documentation\. - -With RDS Optimized Writes turned on, RDS for MySQL databases write only once when flushing data to durable storage without using the doublewrite buffer\. RDS Optimized Writes is useful if you run write\-heavy workloads on your RDS for MySQL databases\. Examples of databases with write\-heavy workloads include ones that support digital payments, financial trading, and gaming applications\. - -These databases run on DB instance classes that use the AWS Nitro System\. Because of the hardware configuration in these systems, the database can write 16\-KiB pages directly to data files reliably and durably in one step\. The AWS Nitro System makes RDS Optimized Writes possible\. - -You can set the new database parameter `rds.optimized_writes` to control the RDS Optimized Writes feature for RDS for MySQL databases\. Access this parameter in the DB parameter groups of RDS for MySQL version 8\.0\. Set the parameter using the following values: -+ `AUTO` – Turn on RDS Optimized Writes if the database supports it\. Turn off RDS Optimized Writes if the database doesn't support it\. This setting is the default\. -+ `OFF` – Turn off RDS Optimized Writes even if the database supports it\. - -If you migrate an RDS for MySQL database that is configured to use RDS Optimized Writes to a DB instance class that doesn't support the feature, RDS automatically turns off RDS Optimized Writes for the database\. - -When RDS Optimized Writes is turned off, the database uses the MySQL doublewrite buffer\. - -To determine whether an RDS for MySQL database is using RDS Optimized Writes, view the current value of the `innodb_doublewrite` parameter for the database\. If the database is using RDS Optimized Writes, this parameter is set to `FALSE` \(`0`\)\. - -## Using RDS Optimized Writes - -You can turn on RDS Optimized Writes when you create an RDS for MySQL database with the RDS console, the AWS CLI, or the RDS API\. RDS Optimized Writes is turned on automatically when both of the following conditions apply during database creation: -+ You specify a DB engine version and DB instance class that support RDS Optimized Writes\. - + RDS Optimized Writes is supported for RDS for MySQL version 8\.0\.30 and higher\. For information about RDS for MySQL versions, see [MySQL on Amazon RDS versions](MySQL.Concepts.VersionMgmt.md)\. - + RDS Optimized Writes is supported for RDS for MySQL databases that use the following DB instance classes: - + db\.x2iedn - + db\.m7g - + db\.r7g - + db\.r6g - + db\.r6gd - + db\.r6i - + db\.r5b - - For information about DB instance classes, see [DB instance classes](Concepts.DBInstanceClass.md)\. - - DB instance class availability differs for AWS Regions\. To determine whether a DB instance class is supported in a specific AWS Region, see [Determining DB instance class support in AWS Regions](Concepts.DBInstanceClass.md#Concepts.DBInstanceClass.RegionSupport)\. -+ In the parameter group associated with the database, the `rds.optimized_writes` parameter is set to `AUTO`\. In default parameter groups, this parameter is always set to `AUTO`\. - -If you want to use a DB engine version and DB instance class that support RDS Optimized Writes, but you don't want to use this feature, then specify a custom parameter group when you create the database\. In this parameter group, set the `rds.optimized_writes` parameter to `OFF`\. If you want the database to use RDS Optimized Writes later, you can set the parameter to `AUTO` to turn it on\. For information about creating custom parameter groups and setting parameters, see [Working with parameter groups](USER_WorkingWithParamGroups.md)\. - -For information about creating a DB instance, see [Creating an Amazon RDS DB instance](USER_CreateDBInstance.md)\. - -### Console - -When you use the RDS console to create an RDS for MySQL database, you can filter for the DB engine versions and DB instance classes that support RDS Optimized Writes\. After you turn on the filters, you can choose from the available DB engine versions and DB instance classes\. - -To choose a DB engine version that supports RDS Optimized Writes, filter for the RDS for MySQL DB engine versions that support it in **Engine version**, and then choose a version\. - -![\[DB engine version filter for RDS Optimized Writes.\]](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/images/rds-optimized-writes-version-filter.png) - -In the **Instance configuration** section, filter for the DB instance classes that support RDS Optimized Writes, and then choose a DB instance class\. - -![\[DB instance class filter for RDS Optimized Writes.\]](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/images/rds-optimized-writes-class-filter.png) - -After you make these selections, you can choose other settings that meet your requirements and finish creating the RDS for MySQL database with the console\. - -### AWS CLI - -To create a DB instance by using the AWS CLI, use the [create\-db\-instance](https://docs.aws.amazon.com/cli/latest/reference/rds/create-db-instance.html) command\. Make sure the `--engine-version` and `--db-instance-class` values support RDS Optimized Writes\. In addition, make sure the parameter group associated with the DB instance has the `rds.optimized_writes` parameter set to `AUTO`\. This example associates the default parameter group with the DB instance\. - -**Example Creating a DB instance that uses RDS Optimized Writes** -For Linux, macOS, or Unix: - -``` -1. aws rds create-db-instance \ -2. --db-instance-identifier mydbinstance \ -3. --engine mysql \ -4. --engine-version 8.0.30 \ -5. --db-instance-class db.r5b.large \ -6. --master-user-password password \ -7. --master-username admin \ -8. --allocated-storage 200 -``` -For Windows: - -``` -1. aws rds create-db-instance ^ -2. --db-instance-identifier mydbinstance ^ -3. --engine mysql ^ -4. --engine-version 8.0.30 ^ -5. --db-instance-class db.r5b.large ^ -6. --master-user-password password ^ -7. --master-username admin ^ -8. --allocated-storage 200 -``` - -### RDS API - -You can create a DB instance using the [ CreateDBInstance](https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_CreateDBInstance.html) operation\. When you use this operation, make sure the `EngineVersion` and `DBInstanceClass` values support RDS Optimized Writes\. In addition, make sure the parameter group associated with the DB instance has the `rds.optimized_writes` parameter set to `AUTO`\. - -## Limitations for RDS Optimized Writes - -The following limitations apply to RDS Optimized Writes: -+ You can only modify a database to turn on RDS Optimized Writes if the database was created with a DB engine version and DB instance class that support the feature\. In this case, if RDS Optimized Writes is turned off for the database, you can turn it on by setting the `rds.optimized_writes` parameter to `AUTO`\. For more information, see [Using RDS Optimized Writes](#rds-optimized-writes-using)\. -+ You can only modify a database to turn on RDS Optimized Writes if the database was created *after* the feature was released\. The underlying file system format and organization that RDS Optimized Writes needs is incompatible with the file system format of databases created before the feature was released\. By extension, you can't use any snapshots of previously created instances with this feature because the snapshots use the older, incompatible file system\. -**Important** -To convert the old format to the new format, you need to perform a full database migration\. If you want to use this feature on DB instances that were created *before* the feature was released, create a new empty DB instance and manually migrate your older DB instance to the newer DB instance\. You can migrate your older DB instance using the native `mysqldump` tool, replication, or AWS Database Migration Service\. For more information, see [mysqldump — A Database Backup Program](https://dev.mysql.com/doc/refman/8.0/en/mysqldump.html) in the *MySQL 8\.0 Reference Manual*, [Working with MySQL replication in Amazon RDS](USER_MySQL.Replication.md), and the [https://docs.aws.amazon.com/dms/latest/userguide/Welcome.html](https://docs.aws.amazon.com/dms/latest/userguide/Welcome.html)\. For help with migrating using AWS tools, contact support\. -+ When you are restoring an RDS for MySQL database from a snapshot, you can only turn on RDS Optimized Writes for the database if all of the following conditions apply: - + The snapshot was created from a database that supports RDS Optimized Writes\. - + The snapshot was created from a database that was created *after* RDS Optimized Writes was released\. - + The snapshot is restored to a database that supports RDS Optimized Writes\. - + The restored database is associated with a parameter group that has the `rds.optimized_writes` parameter set to `AUTO`\. \ No newline at end of file diff --git a/doc_source/rds-proxy-cfn.md b/doc_source/rds-proxy-cfn.md deleted file mode 100644 index e2f3678..0000000 --- a/doc_source/rds-proxy-cfn.md +++ /dev/null @@ -1,33 +0,0 @@ -# Using RDS Proxy with AWS CloudFormation - - You can use RDS Proxy with AWS CloudFormation\. Doing so helps you to create groups of related resources\. Such a group can include a proxy that can connect to a newly created Amazon RDS DB instance or Aurora DB cluster\. RDS Proxy support in AWS CloudFormation involves two new registry types: `DBProxy` and `DBProxyTargetGroup`\. - - The following listing shows a sample AWS CloudFormation template for RDS Proxy\. - -``` -Resources: - DBProxy: - Type: AWS::RDS::DBProxy - Properties: - DBProxyName: CanaryProxy - EngineFamily: MYSQL - RoleArn: - Fn::ImportValue: SecretReaderRoleArn - Auth: - - {AuthScheme: SECRETS, SecretArn: !ImportValue ProxySecret, IAMAuth: DISABLED} - VpcSubnetIds: - Fn::Split: [",", "Fn::ImportValue": SubnetIds] - - ProxyTargetGroup: - Type: AWS::RDS::DBProxyTargetGroup - Properties: - DBProxyName: CanaryProxy - TargetGroupName: default - DBInstanceIdentifiers: - - Fn::ImportValue: DBInstanceName - DependsOn: DBProxy -``` - - For more information about the resources in this sample, see [https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbproxy.html](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbproxy.html) and [https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbproxytargetgroup.html](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbproxytargetgroup.html)\. - - For more information about the Amazon RDS and Aurora resources that you can create using AWS CloudFormation, see [RDS resource type reference](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/AWS_RDS.html)\. \ No newline at end of file diff --git a/doc_source/rds-proxy-connecting.md b/doc_source/rds-proxy-connecting.md deleted file mode 100644 index e9696c3..0000000 --- a/doc_source/rds-proxy-connecting.md +++ /dev/null @@ -1,92 +0,0 @@ -# Connecting to a database through RDS Proxy - - You connect to an RDS DB instance or Aurora DB cluster through a proxy in generally the same way as you connect directly to the database\. The main difference is that you specify the proxy endpoint instead of the instance or cluster endpoint\. For an Aurora DB cluster, by default all proxy connections have read/write capability and use the writer instance\. If you normally use the reader endpoint for read\-only connections, you can create an additional read\-only endpoint for the proxy and use that endpoint the same way\. For more information, see [Overview of proxy endpoints](rds-proxy-endpoints.md#rds-proxy-endpoints-overview)\. - -**Topics** -+ [Connecting to a proxy using native authentication](#rds-proxy-connecting-native) -+ [Connecting to a proxy using IAM authentication](#rds-proxy-connecting-iam) -+ [Considerations for connecting to a proxy with PostgreSQL](#rds-proxy-connecting-postgresql) - -## Connecting to a proxy using native authentication - - Use the following basic steps to connect to a proxy using native authentication: - -1. Find the proxy endpoint\. In the AWS Management Console, you can find the endpoint on the details page for the corresponding proxy\. With the AWS CLI, you can use the [describe\-db\-proxies](https://docs.aws.amazon.com/cli/latest/reference/rds/describe-db-proxies.html) command\. The following example shows how\. - - ``` - # Add --output text to get output as a simple tab-separated list. - $ aws rds describe-db-proxies --query '*[*].{DBProxyName:DBProxyName,Endpoint:Endpoint}' - [ - [ - { - "Endpoint": "the-proxy.proxy-demo.us-east-1.rds.amazonaws.com", - "DBProxyName": "the-proxy" - }, - { - "Endpoint": "the-proxy-other-secret.proxy-demo.us-east-1.rds.amazonaws.com", - "DBProxyName": "the-proxy-other-secret" - }, - { - "Endpoint": "the-proxy-rds-secret.proxy-demo.us-east-1.rds.amazonaws.com", - "DBProxyName": "the-proxy-rds-secret" - }, - { - "Endpoint": "the-proxy-t3.proxy-demo.us-east-1.rds.amazonaws.com", - "DBProxyName": "the-proxy-t3" - } - ] - ] - ``` - -1. Specify that endpoint as the host parameter in the connection string for your client application\. For example, specify the proxy endpoint as the value for the `mysql -h` option or `psql -h` option\. - -1. Supply the same database user name and password as you usually do\. - -## Connecting to a proxy using IAM authentication - - When you use IAM authentication with RDS Proxy, set up your database users to authenticate with regular user names and passwords\. The IAM authentication applies to RDS Proxy retrieving the user name and password credentials from Secrets Manager\. The connection from RDS Proxy to the underlying database doesn't go through IAM\. - - To connect to RDS Proxy using IAM authentication, follow the same general procedure as for connecting to an RDS DB instance or Aurora cluster using IAM authentication\. For general information about using IAM with RDS and Aurora, see [Security in Amazon RDS](UsingWithRDS.md)\. - - The major differences in IAM usage for RDS Proxy include the following: -+ You don't configure each individual database user with an authorization plugin\. The database users still have regular user names and passwords within the database\. You set up Secrets Manager secrets containing these user names and passwords, and authorize RDS Proxy to retrieve the credentials from Secrets Manager\. -**Important** - The IAM authentication applies to the connection between your client program and the proxy\. The proxy then authenticates to the database using the user name and password credentials retrieved from Secrets Manager\. When you use IAM for the connection to a proxy, make sure that the underlying RDS DB instance or Aurora DB cluster doesn't have IAM enabled\. -+ Instead of the instance, cluster, or reader endpoint, you specify the proxy endpoint\. For details about the proxy endpoint, see [Connecting to your DB instance using IAM authentication](UsingWithRDS.IAMDBAuth.Connecting.md)\. -+ In the direct DB IAM auth case, you selectively pick database users and configure them to be identified with a special auth plugin\. You can then connect to those users using IAM auth\. - - In the proxy use case, you need to provide the proxy with Secrets that contain some user's username and password \(native auth\)\. You then connect to the proxy using IAM auth \(by generating an auth token with the proxy endpoint, not the database endpoint\) and using a username which matches one of the usernames for the secrets you previously provided\. -+ Make sure that you use Transport Layer Security \(TLS\) / Secure Sockets Layer \(SSL\) when connecting to a proxy using IAM authentication\. - - You can grant a specific user access to the proxy by modifying the IAM policy\. An example follows\. - -``` -"Resource": "arn:aws:rds-db:us-east-2:1234567890:dbuser:prx-ABCDEFGHIJKL01234/db_user" -``` - -## Considerations for connecting to a proxy with PostgreSQL - - For PostgreSQL, when a client starts a connection to a PostgreSQL database, it sends a startup message that includes pairs of parameter name and value strings\. For details, see the `StartupMessage` in [PostgreSQL message formats](https://www.postgresql.org/docs/current/protocol-message-formats.html) in the PostgreSQL documentation\. - -When connecting through an RDS proxy, the startup message can include the following currently recognized parameters: -+ `user` -+ `database` -+ `replication` - - The startup message can also include the following additional runtime parameters: -+ `[application\_name](https://www.postgresql.org/docs/current/runtime-config-logging.html#GUC-APPLICATION-NAME) ` -+ `[client\_encoding](https://www.postgresql.org/docs/current/runtime-config-client.html#GUC-CLIENT-ENCODING) ` -+ `[DateStyle](https://www.postgresql.org/docs/current/runtime-config-client.html#GUC-DATESTYLE) ` -+ `[TimeZone](https://www.postgresql.org/docs/current/runtime-config-client.html#GUC-TIMEZONE) ` -+ `[extra\_float\_digits](https://www.postgresql.org/docs/current/runtime-config-client.html#GUC-EXTRA-FLOAT-DIGITS) ` - - For more information about PostgreSQL messaging, see the [Frontend/Backend protocol](https://www.postgresql.org/docs/current/protocol.html) in the PostgreSQL documentation\. - - For PostgreSQL, if you use JDBC we recommend the following to avoid pinning: -+ Set the JDBC connection parameter `assumeMinServerVersion` to at least `9.0` to avoid pinning\. Doing this prevents the JDBC driver from performing an extra round trip during connection startup when it runs `SET extra_float_digits = 3`\. -+ Set the JDBC connection parameter `ApplicationName` to `any/your-application-name` to avoid pinning\. Doing this prevents the JDBC driver from performing an extra round trip during connection startup when it runs `SET application_name = "PostgreSQL JDBC Driver"`\. Note the JDBC parameter is `ApplicationName` but the PostgreSQL `StartupMessage` parameter is `application_name`\. -+ Set the JDBC connection parameter `preferQueryMode` to `extendedForPrepared` to avoid pinning\. The `extendedForPrepared` ensures that the extended mode is used only for prepared statements\. - - The default for the `preferQueryMode` parameter is `extended`, which uses the extended mode for all queries\. The extended mode uses a series of `Prepare`, `Bind`, `Execute`, and `Sync` requests and corresponding responses\. This type of series causes connection pinning in an RDS proxy\. - -For more information, see [Avoiding pinning](rds-proxy-managing.md#rds-proxy-pinning)\. For more information about connecting using JDBC, see [Connecting to the database](https://jdbc.postgresql.org/documentation/head/connect.html) in the PostgreSQL documentation\. \ No newline at end of file diff --git a/doc_source/rds-proxy-endpoints.md b/doc_source/rds-proxy-endpoints.md deleted file mode 100644 index 69298fa..0000000 --- a/doc_source/rds-proxy-endpoints.md +++ /dev/null @@ -1,305 +0,0 @@ -# Working with Amazon RDS Proxy endpoints - - Following, you can learn about endpoints for RDS Proxy and how to use them\. By using endpoints, you can take advantage of the following capabilities: -+ You can use multiple endpoints with a proxy to monitor and troubleshoot connections from different applications independently\. -+ You can use reader endpoints with Aurora DB clusters to improve read scalability and high availability for your query\-intensive applications\. -+ You can use a cross\-VPC endpoint to allow access to databases in one VPC from resources such as Amazon EC2 instances in a different VPC\. - -**Topics** -+ [Overview of proxy endpoints](#rds-proxy-endpoints-overview) -+ [Reader endpoints](#rds-proxy-endpoints-reader-stub) -+ [Accessing Aurora and RDS databases across VPCs](#rds-proxy-cross-vpc) -+ [Creating a proxy endpoint](#rds-proxy-endpoints.CreatingEndpoint) -+ [Viewing proxy endpoints](#rds-proxy-endpoints.DescribingEndpoint) -+ [Modifying a proxy endpoint](#rds-proxy-endpoints.ModifyingEndpoint) -+ [Deleting a proxy endpoint](#rds-proxy-endpoints.DeletingEndpoint) -+ [Limitations for proxy endpoints](#rds-proxy-endpoints-limits) - -## Overview of proxy endpoints - - Working with RDS Proxy endpoints involves the same kinds of procedures as with Aurora DB cluster and reader endpoints and RDS instance endpoints\. If you aren't familiar with RDS endpoints, find more information in [Connecting to a DB instance running the MySQL database engine](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_ConnectToInstance.html) and [Connecting to a DB instance running the PostgreSQL database engine](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_ConnectToPostgreSQLInstance.html)\. - - By default, the endpoint that you connect to when you use RDS Proxy with an Aurora cluster has read/write capability\. As a result, this endpoint sends all requests to the writer instance of the cluster\. All of those connections count against the `max_connections` value for the writer instance\. If your proxy is associated with an Aurora DB cluster, you can create additional read/write or read\-only endpoints for that proxy\. - - You can use a read\-only endpoint with your proxy for read\-only queries\. You do this the same way that you use the reader endpoint for an Aurora provisioned cluster\. Doing so helps you to take advantage of the read scalability of an Aurora cluster with one or more reader DB instances\. You can run more simultaneous queries and make more simultaneous connections by using a read\-only endpoint and adding more reader DB instances to your Aurora cluster as needed\. - - For a proxy endpoint that you create, you can also associate the endpoint with a different virtual private cloud \(VPC\) than the proxy itself uses\. By doing so, you can connect to the proxy from a different VPC, for example a VPC used by a different application within your organization\. - - For information about limits associated with proxy endpoints, see [Limitations for proxy endpoints](#rds-proxy-endpoints-limits)\. - - In the RDS Proxy logs, each entry is prefixed with the name of the associated proxy endpoint\. This name can be the name you specified for a user\-defined endpoint\. Or it can be the special name `default` for read/write requests using the default endpoint of a proxy\. - - Each proxy endpoint has its own set of CloudWatch metrics\. You can monitor the metrics for all endpoints of a proxy\. You can also monitor metrics for a specific endpoint, or for all the read/write or read\-only endpoints of a proxy\. For more information, see [Monitoring RDS Proxy metrics with Amazon CloudWatchMonitoring RDS Proxy with CloudWatch](rds-proxy.monitoring.md)\. - - A proxy endpoint uses the same authentication mechanism as its associated proxy\. RDS Proxy automatically sets up permissions and authorizations for the user\-defined endpoint, consistent with the properties of the associated proxy\. - -## Reader endpoints - - With RDS Proxy, you can create and use reader endpoints\. However, these endpoints only work for proxies associated with Aurora DB clusters\. You might see references to reader endpoints in the AWS Management Console\. If you use the RDS CLI or API, you might see the `TargetRole` attribute with a value of `READ_ONLY`\. You can take advantage of these features by changing the target of a proxy from an RDS DB instance to an Aurora DB cluster\. To learn about reader endpoints, see [Managing connections with Amazon RDS Proxy](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/rds-proxy-.html) in the *Aurora User Guide\.* - -## Accessing Aurora and RDS databases across VPCs - - By default, the components of your RDS and Aurora technology stack are all in the same Amazon VPC\. For example, suppose that an application running on an Amazon EC2 instance connects to an Amazon RDS DB instance or an Aurora DB cluster\. In this case, the application server and database must both be within the same VPC\. - - With RDS Proxy, you can set up access to an Aurora cluster or RDS instance in one VPC from resources such as EC2 instances in another VPC\. For example, your organization might have multiple applications that access the same database resources\. Each application might be in its own VPC\. - - To enable cross\-VPC access, you create a new endpoint for the proxy\. If you aren't familiar with creating proxy endpoints, see [Working with Amazon RDS Proxy endpoints](#rds-proxy-endpoints) for details\. The proxy itself resides in the same VPC as the Aurora DB cluster or RDS instance\. However, the cross\-VPC endpoint resides in the other VPC, along with the other resources such as the EC2 instances\. The cross\-VPC endpoint is associated with subnets and security groups from the same VPC as the EC2 and other resources\. These associations let you connect to the endpoint from the applications that otherwise can't access the database due to the VPC restrictions\. - - The following steps explain how to create and access a cross\-VPC endpoint through RDS Proxy: - -1. Create two VPCs, or choose two VPCs that you already use for Aurora and RDS work\. Each VPC should have its own associated network resources such as an Internet gateway, route tables, subnets, and security groups\. If you only have one VPC, you can consult [Getting started with Amazon RDS](CHAP_GettingStarted.md) for the steps to set up another VPC to use RDS successfully\. You can also examine your existing VPC in the Amazon EC2 console to see what kinds of resources to connect together\. - -1. Create a DB proxy associated with the Aurora DB cluster or RDS instance that you want to connect to\. Follow the procedure in [Creating an RDS Proxy](rds-proxy-setup.md#rds-proxy-creating)\. - -1. On the **Details** page for your proxy in the RDS console, under the **Proxy endpoints** section, choose **Create endpoint**\. Follow the procedure in [Creating a proxy endpoint](#rds-proxy-endpoints.CreatingEndpoint)\. - -1. Choose whether to make the cross\-VPC endpoint read/write or read\-only\. - -1. Instead of accepting the default of the same VPC as the Aurora DB cluster or RDS instance, choose a different VPC\. This VPC must be in the same AWS Region as the VPC where the proxy resides\. - -1. Now instead of accepting the defaults for subnets and security groups from the same VPC as the Aurora DB cluster or RDS instance, make new selections\. Make these based on the subnets and security groups from the VPC that you chose\. - -1. You don't need to change any of the settings for the Secrets Manager secrets\. The same credentials work for all endpoints for your proxy, regardless of which VPC each endpoint is in\. - -1. Wait for the new endpoint to reach the **Available** state\. - -1. Make a note of the full endpoint name\. This is the value ending in `Region_name.rds.amazonaws.com` that you supply as part of the connection string for your database application\. - -1. Access the new endpoint from a resource in the same VPC as the endpoint\. A simple way to test this process is to create a new EC2 instance in this VPC\. Then you can log into the EC2 instance and run the `mysql` or `psql` commands to connect by using the endpoint value in your connection string\. - -## Creating a proxy endpoint - - - -### Console - -**To create a proxy endpoint** - -1. Sign in to the AWS Management Console and open the Amazon RDS console at [https://console\.aws\.amazon\.com/rds/](https://console.aws.amazon.com/rds/)\. - -1. In the navigation pane, choose **Proxies**\. - -1. Click the name of the proxy that you want to create a new endpoint for\. - - The details page for that proxy appears\. - -1. In the **Proxy endpoints** section, choose **Create proxy endpoint**\. - - The **Create proxy endpoint** window appears\. - -1. For **Proxy endpoint name**, enter a descriptive name of your choice\. - -1. For **Target role**, choose whether to make the endpoint read/write or read\-only\. - - Connections that use a read/write endpoint can perform any kind of operation: data definition language \(DDL\) statements, data manipulation language \(DML\) statements, and queries\. These endpoints always connect to the primary instance of the Aurora cluster\. You can use read/write endpoints for general database operations when you only use a single endpoint in your application\. You can also use read/write endpoints for administrative operations, online transaction processing \(OLTP\) applications, and extract\-transform\-load \(ETL\) jobs\. - - Connections that use a read\-only endpoint can only perform queries\. When there are multiple reader instances in the Aurora cluster, RDS Proxy can use a different reader instance for each connection to the endpoint\. That way, a query\-intensive application can take advantage of Aurora's clustering capability\. You can add more query capacity to the cluster by adding more reader DB instances\. These read\-only connections don't impose any overhead on the primary instance of the cluster\. That way, your reporting and analysis queries don't slow down the write operations of your OLTP applications\. - -1. For **Virtual Private Cloud \(VPC\)**, choose the default to access the endpoint from the same EC2 instances or other resources where you normally access the proxy or its associated database\. To set up cross\-VPC access for this proxy, choose a VPC other than the default\. For more information about cross\-VPC access, see [Accessing Aurora and RDS databases across VPCs](#rds-proxy-cross-vpc)\. - -1. For **Subnets**, RDS Proxy fills in the same subnets as the associated proxy by default\. To restrict access to the endpoint so only a portion of the VPC's address range can connect to it, remove one or more subnets\. - -1. For **VPC security group**, you can choose an existing security group or create a new one\. RDS Proxy fills in the same security group or groups as the associated proxy by default\. If the inbound and outbound rules for the proxy are appropriate for this endpoint, you can leave the default choice\. - - If you choose to create a new security group, specify a name for the security group on this page\. Then edit the security group settings from the EC2 console afterward\. - -1. Choose **Create proxy endpoint**\. - -### AWS CLI - - To create a proxy endpoint, use the AWS CLI [create\-db\-proxy\-endpoint](https://docs.aws.amazon.com/cli/latest/reference/rds/create-db-proxy-endpoint.html) command\. - - Include the following required parameters: -+ `--db-proxy-name value` -+ `--db-proxy-endpoint-name value` -+ `--vpc-subnet-ids list_of_ids`\. Separate the subnet IDs with spaces\. You don't specify the ID of the VPC itself\. - - You can also include the following optional parameters: -+ `--target-role { READ_WRITE | READ_ONLY }`\. This parameter defaults to `READ_WRITE`\. The `READ_ONLY` value only has an effect on Aurora provisioned clusters that contain one or more reader DB instances\. When the proxy is associated with an RDS instance or with an Aurora cluster that only contains a writer DB instance, you can't specify `READ_ONLY`\. -+ `--vpc-security-group-ids value`\. Separate the security group IDs with spaces\. If you omit this parameter, RDS Proxy uses the default security group for the VPC\. RDS Proxy determines the VPC based on the subnet IDs that you specify for the `--vpc-subnet-ids` parameter\. - -**Example** - The following example creates a proxy endpoint named `my-endpoint`\. -For Linux, macOS, or Unix: - -``` -aws rds create-db-proxy-endpoint \ - --db-proxy-name my-proxy \ - --db-proxy-endpoint-name my-endpoint \ - --vpc-subnet-ids subnet_id subnet_id subnet_id ... \ - --target-role READ_ONLY \ - --vpc-security-group-ids security_group_id ] -``` -For Windows: - -``` -aws rds create-db-proxy-endpoint ^ - --db-proxy-name my-proxy ^ - --db-proxy-endpoint-name my-endpoint ^ - --vpc-subnet-ids subnet_id_1 subnet_id_2 subnet_id_3 ... ^ - --target-role READ_ONLY ^ - --vpc-security-group-ids security_group_id -``` - -### RDS API - - To create a proxy endpoint, use the RDS API [CreateDBProxyEndpoint](https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_CreateDBProxyEndpoint.html) action\. - -## Viewing proxy endpoints - - - -### Console - -**To view the details for a proxy endpoint** - -1. Sign in to the AWS Management Console and open the Amazon RDS console at [https://console\.aws\.amazon\.com/rds/](https://console.aws.amazon.com/rds/)\. - -1. In the navigation pane, choose **Proxies**\. - -1. In the list, choose the proxy whose endpoint you want to view\. Click the proxy name to view its details page\. - -1. In the **Proxy endpoints** section, choose the endpoint that you want to view\. Click its name to view the details page\. - -1. Examine the parameters whose values you're interested in\. You can check properties such as the following: - + Whether the endpoint is read/write or read\-only\. - + The endpoint address that you use in a database connection string\. - + The VPC, subnets, and security groups associated with the endpoint\. - -### AWS CLI - - To view one or more DB proxy endpoints, use the AWS CLI [describe\-db\-proxy\-endpoints](https://docs.aws.amazon.com/cli/latest/reference/rds/describe-db-proxy-endpoints.html) command\. - - You can include the following optional parameters: -+ `--db-proxy-endpoint-name` -+ `--db-proxy-name` - - The following example describes the `my-endpoint` proxy endpoint\. - -**Example** -For Linux, macOS, or Unix: - -``` -aws rds describe-db-proxy-endpoints \ - --db-proxy-endpoint-name my-endpoint -``` -For Windows: - -``` -aws rds describe-db-proxy-endpoints ^ - --db-proxy-endpoint-name my-endpoint -``` - -### RDS API - - To describe one or more proxy endpoints, use the RDS API [DescribeDBProxyEndpoints](https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_DescribeDBProxyEndpoints.html) operation\. - -## Modifying a proxy endpoint - - - -### Console - -**To modify one or more proxy endpoints** - -1. Sign in to the AWS Management Console and open the Amazon RDS console at [https://console\.aws\.amazon\.com/rds/](https://console.aws.amazon.com/rds/)\. - -1. In the navigation pane, choose **Proxies**\. - -1. In the list, choose the proxy whose endpoint you want to modify\. Click the proxy name to view its details page\. - -1. In the **Proxy endpoints** section, choose the endpoint that you want to modify\. You can select it in the list, or click its name to view the details page\. - -1. On the proxy details page, under the **Proxy endpoints** section, choose **Edit**\. Or on the proxy endpoint details page, for **Actions**, choose **Edit**\. - -1. Change the values of the parameters that you want to modify\. - -1. Choose **Save changes**\. - -### AWS CLI - - To modify a DB proxy endpoint, use the AWS CLI [modify\-db\-proxy\-endpoint](https://docs.aws.amazon.com/cli/latest/reference/rds/modify-db-proxy-endpoint.html) command with the following required parameters: -+ `--db-proxy-endpoint-name` - - Specify changes to the endpoint properties by using one or more of the following parameters: -+ `--new-db-proxy-endpoint-name` -+ `--vpc-security-group-ids`\. Separate the security group IDs with spaces\. - - The following example renames the `my-endpoint` proxy endpoint to `new-endpoint-name`\. - -**Example** -For Linux, macOS, or Unix: - -``` -aws rds modify-db-proxy-endpoint \ - --db-proxy-endpoint-name my-endpoint \ - --new-db-proxy-endpoint-name new-endpoint-name -``` -For Windows: - -``` -aws rds modify-db-proxy-endpoint ^ - --db-proxy-endpoint-name my-endpoint ^ - --new-db-proxy-endpoint-name new-endpoint-name -``` - -### RDS API - - To modify a proxy endpoint, use the RDS API [ModifyDBProxyEndpoint](https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_ModifyDBProxyEndpoint.html) operation\. - -## Deleting a proxy endpoint - - You can delete an endpoint for your proxy using the console as described following\. - -**Note** - You can't delete the default endpoint that RDS Proxy automatically creates for each proxy\. - When you delete a proxy, RDS Proxy automatically deletes all the associated endpoints\. - -### Console - -**To delete a proxy endpoint using the AWS Management Console** - -1. In the navigation pane, choose **Proxies**\. - -1. In the list, choose the proxy whose endpoint you want to endpoint\. Click the proxy name to view its details page\. - -1. In the **Proxy endpoints** section, choose the endpoint that you want to delete\. You can select one or more endpoints in the list, or click the name of a single endpoint to view the details page\. - -1. On the proxy details page, under the **Proxy endpoints** section, choose **Delete**\. Or on the proxy endpoint details page, for **Actions**, choose **Delete**\. - -### AWS CLI - - To delete a proxy endpoint, run the [delete\-db\-proxy\-endpoint](https://docs.aws.amazon.com/cli/latest/reference/rds/delete-db-proxy-endpoint.html) command with the following required parameters: -+ `--db-proxy-endpoint-name` - - The following command deletes the proxy endpoint named `my-endpoint`\. - -For Linux, macOS, or Unix: - -``` -aws rds delete-db-proxy-endpoint \ - --db-proxy-endpoint-name my-endpoint -``` - -For Windows: - -``` -aws rds delete-db-proxy-endpoint ^ - --db-proxy-endpoint-name my-endpoint -``` - -### RDS API - - To delete a proxy endpoint with the RDS API, run the [DeleteDBProxyEndpoint](https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_DeleteDBProxyEndpoint.html) operation\. Specify the name of the proxy endpoint for the `DBProxyEndpointName` parameter\. - -## Limitations for proxy endpoints - - Each proxy has a default endpoint that you can modify but not create or delete\. - - The maximum number of user\-defined endpoints for a proxy is 20\. Thus, a proxy can have up to 21 endpoints: the default endpoint, plus 20 that you create\. - - When you associate additional endpoints with a proxy, RDS Proxy automatically determines which DB instances in your cluster to use for each endpoint\. You can't choose specific instances the way that you can with Aurora custom endpoints\. - - - - Reader endpoints aren't available for Aurora multi\-writer clusters\. \ No newline at end of file diff --git a/doc_source/rds-proxy-managing.md b/doc_source/rds-proxy-managing.md deleted file mode 100644 index a9b3704..0000000 --- a/doc_source/rds-proxy-managing.md +++ /dev/null @@ -1,492 +0,0 @@ -# Managing an RDS Proxy - - Following, you can find an explanation of how to manage RDS Proxy operation and configuration\. These procedures help your application make the most efficient use of database connections and achieve maximum connection reuse\. The more that you can take advantage of connection reuse, the more CPU and memory overhead that you can save\. This in turn reduces latency for your application and enables the database to devote more of its resources to processing application requests\. - -**Topics** -+ [Modifying an RDS Proxy](#rds-proxy-modifying-proxy) -+ [Adding a new database user](#rds-proxy-new-db-user) -+ [Changing the password for a database user](#rds-proxy-changing-db-user-password) -+ [Configuring connection settings](#rds-proxy-connection-pooling-tuning) -+ [Avoiding pinning](#rds-proxy-pinning) -+ [Deleting an RDS Proxy](#rds-proxy-deleting) - -## Modifying an RDS Proxy - - You can change specific settings associated with a proxy after you create the proxy\. You do so by modifying the proxy itself, its associated target group, or both\. Each proxy has an associated target group\. - -### AWS Management Console - -**Important** -The values in the **Client authentication type** and **IAM authentication** fields apply to all Secrets Manager secrets that are associated with this proxy\. To specify different values for each secret, modify your proxy by using the AWS CLI or the API instead\. - -**To modify the settings for a proxy** - -1. Sign in to the AWS Management Console and open the Amazon RDS console at [https://console\.aws\.amazon\.com/rds/](https://console.aws.amazon.com/rds/)\. - -1. In the navigation pane, choose **Proxies**\. - -1. In the list of proxies, choose the proxy whose settings you want to modify or go to its details page\. - -1. For **Actions**, choose **Modify**\. - -1. Enter or choose the properties to modify\. You can modify the following: - + **Proxy identifier** – Rename the proxy by entering a new identifier\. - + **Idle client connection timeout** – Enter a time period for the idle client connection timeout\. - + **IAM role** – Change the IAM role used to retrieve the secrets from Secrets Manager\. - + **Secrets Manager secrets** – Add or remove Secrets Manager secrets\. These secrets correspond to database user names and passwords\. - + **Client authentication type** – \(PostgreSQL only\) Change the type of authentication for client connections to the proxy\. - + **IAM authentication** – Require or disallow IAM authentication for connections to the proxy\. - + **Require Transport Layer Security** – Turn the requirement for Transport layer Security \(TLS\) on or off\. - + **VPC security group** – Add or remove VPC security groups for the proxy to use\. - + **Enable enhanced logging** – Enable or disable enhanced logging\. - -1. Choose **Modify**\. - - If you didn't find the settings listed that you want to change, use the following procedure to update the target group for the proxy\. The *target group *associated with a proxy controls the settings related to the physical database connections\. Each proxy has one associated target group named `default`, which is created automatically along with the proxy\. - - You can only modify the target group from the proxy details page, not from the list on the **Proxies** page\. - -**To modify the settings for a proxy target group** - -1. On the **Proxies** page, go to the details page for a proxy\. - -1. For **Target groups**, choose the `default` link\. Currently, all proxies have a single target group named `default`\. - -1. On the details page for the **default** target group, choose **Modify**\. - -1. Choose new settings for the properties that you can modify: - + **Database** – Choose a different RDS DB instance or Aurora cluster\. - + **Connection pool maximum connections** – Adjust what percentage of the maximum available connections the proxy can use\. - + **Session pinning filters** – \(Optional\) Choose a session pinning filter\. Doing this can help reduce performance issues due to insufficient transaction\-level reuse for connections\. Using this setting requires understanding of application behavior and the circumstances under which RDS Proxy pins a session to a database connection\. Currently, the setting isn't supported for PostgreSQL and the only choice is `EXCLUDE_VARIABLE_SETS`\. - + **Connection borrow timeout** – Adjust the connection borrow timeout interval\. This setting applies when the maximum number of connections is already being used for the proxy\. The setting determines how long the proxy waits for a connection to become available before returning a timeout error\. - + **Initialization query** – \(Optional\) Add an initialization query, or modify the current one\. You can specify one or more SQL statements for the proxy to run when opening each new database connection\. The setting is typically used with `SET` statements to make sure that each connection has identical settings such as time zone and character set\. For multiple statements, use semicolons as the separator\. You can also include multiple variables in a single `SET` statement, such as `SET x=1, y=2`\. Initialization query is not currently supported for PostgreSQL\. - - You can't change certain properties, such as the target group identifier and the database engine\. - -1. Choose **Modify target group**\. - -### AWS CLI - - To modify a proxy using the AWS CLI, use the commands [modify\-db\-proxy](https://docs.aws.amazon.com/cli/latest/reference/rds/modify-db-proxy.html), [modify\-db\-proxy\-target\-group](https://docs.aws.amazon.com/cli/latest/reference/rds/modify-db-proxy-target-group.html), [deregister\-db\-proxy\-targets](https://docs.aws.amazon.com/cli/latest/reference/rds/deregister-db-proxy-targets.html), and [register\-db\-proxy\-targets](https://docs.aws.amazon.com/cli/latest/reference/rds/register-db-proxy-targets.html)\. - - With the `modify-db-proxy` command, you can change properties such as the following: -+ The set of Secrets Manager secrets used by the proxy\. -+ Whether TLS is required\. -+ The idle client timeout\. -+ Whether to log additional information from SQL statements for debugging\. -+ The IAM role used to retrieve Secrets Manager secrets\. -+ The security groups used by the proxy\. - - The following example shows how to rename an existing proxy\. - -``` -aws rds modify-db-proxy --db-proxy-name the-proxy --new-db-proxy-name the_new_name -``` - - To modify connection\-related settings or rename the target group, use the `modify-db-proxy-target-group` command\. Currently, all proxies have a single target group named `default`\. When working with this target group, you specify the name of the proxy and `default` for the name of the target group\. - - The following example shows how to first check the `MaxIdleConnectionsPercent` setting for a proxy and then change it, using the target group\. - -``` -aws rds describe-db-proxy-target-groups --db-proxy-name the-proxy - -{ - "TargetGroups": [ - { - "Status": "available", - "UpdatedDate": "2019-11-30T16:49:30.342Z", - "ConnectionPoolConfig": { - "MaxIdleConnectionsPercent": 50, - "ConnectionBorrowTimeout": 120, - "MaxConnectionsPercent": 100, - "SessionPinningFilters": [] - }, - "TargetGroupName": "default", - "CreatedDate": "2019-11-30T16:49:27.940Z", - "DBProxyName": "the-proxy", - "IsDefault": true - } - ] -} - -aws rds modify-db-proxy-target-group --db-proxy-name the-proxy --target-group-name default --connection-pool-config ' -{ "MaxIdleConnectionsPercent": 75 }' - -{ - "DBProxyTargetGroup": { - "Status": "available", - "UpdatedDate": "2019-12-02T04:09:50.420Z", - "ConnectionPoolConfig": { - "MaxIdleConnectionsPercent": 75, - "ConnectionBorrowTimeout": 120, - "MaxConnectionsPercent": 100, - "SessionPinningFilters": [] - }, - "TargetGroupName": "default", - "CreatedDate": "2019-11-30T16:49:27.940Z", - "DBProxyName": "the-proxy", - "IsDefault": true - } -} -``` - - With the `deregister-db-proxy-targets` and `register-db-proxy-targets` commands, you change which RDS DB instance or Aurora DB cluster the proxy is associated with through its target group\. Currently, each proxy can connect to one RDS DB instance or Aurora DB cluster\. The target group tracks the connection details for all the RDS DB instances in a Multi\-AZ configuration\. Or the target group tracks the connection details for all the DB instances in an Aurora cluster\. - - The following example starts with a proxy that is associated with an Aurora MySQL cluster named `cluster-56-2020-02-25-1399`\. The example shows how to change the proxy so that it can connect to a different cluster named `provisioned-cluster`\. - - When you work with an RDS DB instance, you specify the `--db-instance-identifier` option\. When you work with an Aurora DB cluster, you specify the `--db-cluster-identifier` option instead\. - - The following example modifies an Aurora MySQL proxy\. An Aurora PostgreSQL proxy has port 5432\. - -``` -aws rds describe-db-proxy-targets --db-proxy-name the-proxy - -{ - "Targets": [ - { - "Endpoint": "instance-9814.demo.us-east-1.rds.amazonaws.com", - "Type": "RDS_INSTANCE", - "Port": 3306, - "RdsResourceId": "instance-9814" - }, - { - "Endpoint": "instance-8898.demo.us-east-1.rds.amazonaws.com", - "Type": "RDS_INSTANCE", - "Port": 3306, - "RdsResourceId": "instance-8898" - }, - { - "Endpoint": "instance-1018.demo.us-east-1.rds.amazonaws.com", - "Type": "RDS_INSTANCE", - "Port": 3306, - "RdsResourceId": "instance-1018" - }, - { - "Type": "TRACKED_CLUSTER", - "Port": 0, - "RdsResourceId": "cluster-56-2020-02-25-1399" - }, - { - "Endpoint": "instance-4330.demo.us-east-1.rds.amazonaws.com", - "Type": "RDS_INSTANCE", - "Port": 3306, - "RdsResourceId": "instance-4330" - } - ] -} - -aws rds deregister-db-proxy-targets --db-proxy-name the-proxy --db-cluster-identifier cluster-56-2020-02-25-1399 - -aws rds describe-db-proxy-targets --db-proxy-name the-proxy - -{ - "Targets": [] -} - -aws rds register-db-proxy-targets --db-proxy-name the-proxy --db-cluster-identifier provisioned-cluster - -{ - "DBProxyTargets": [ - { - "Type": "TRACKED_CLUSTER", - "Port": 0, - "RdsResourceId": "provisioned-cluster" - }, - { - "Endpoint": "gkldje.demo.us-east-1.rds.amazonaws.com", - "Type": "RDS_INSTANCE", - "Port": 3306, - "RdsResourceId": "gkldje" - }, - { - "Endpoint": "provisioned-1.demo.us-east-1.rds.amazonaws.com", - "Type": "RDS_INSTANCE", - "Port": 3306, - "RdsResourceId": "provisioned-1" - } - ] -} -``` - -### RDS API - - To modify a proxy using the RDS API, you use the operations [ModifyDBProxy](https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_ModifyDBProxy.html), [ModifyDBProxyTargetGroup](https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_ModifyDBProxyTargetGroup.html), [DeregisterDBProxyTargets](https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_DeregisterDBProxyTargets.html), and [RegisterDBProxyTargets](https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_RegisterDBProxyTargets.html) operations\. - - With `ModifyDBProxy`, you can change properties such as the following: -+ The set of Secrets Manager secrets used by the proxy\. -+ Whether TLS is required\. -+ The idle client timeout\. -+ Whether to log additional information from SQL statements for debugging\. -+ The IAM role used to retrieve Secrets Manager secrets\. -+ The security groups used by the proxy\. - - With `ModifyDBProxyTargetGroup`, you can modify connection\-related settings or rename the target group\. Currently, all proxies have a single target group named `default`\. When working with this target group, you specify the name of the proxy and `default` for the name of the target group\. - - With `DeregisterDBProxyTargets` and `RegisterDBProxyTargets`, you change which RDS DB instance or Aurora DB cluster the proxy is associated with through its target group\. Currently, each proxy can connect to one RDS DB instance or Aurora DB cluster\. The target group tracks the connection details for all the RDS DB instances in a Multi\-AZ configuration, or all the DB instances in an Aurora cluster\. - -## Adding a new database user - - In some cases, you might add a new database user to an RDS DB instance or Aurora cluster that's associated with a proxy\. If so, add or repurpose a Secrets Manager secret to store the credentials for that user\. To do this, choose one of the following options: - -1. Create a new Secrets Manager secret, using the procedure described in [Setting up database credentials in AWS Secrets Manager](rds-proxy-setup.md#rds-proxy-secrets-arns)\. - -1. Update the IAM role to give RDS Proxy access to the new Secrets Manager secret\. To do so, update the resources section of the IAM role policy\. - -1. Modify the RDS Proxy to add the new Secrets Manager secret under **Secrets Manager secrets**\. - -1. If the new user takes the place of an existing one, update the credentials stored in the proxy's Secrets Manager secret for the existing user\. - -If you have you have the run the following command for your PostgreSQL databases: - -``` -REVOKE CONNECT ON DATABASE postgres FROM PUBLIC; -``` - -Grant the `rdsproxyadmin` user the `CONNECT` privilege so the user can monitor connections on the target database\. - -``` -GRANT CONNECT ON DATABASE postgres TO rdsproxyadmin; -``` - -You can also allow other target database users to perform health checks by changing `rdsproxyadmin` to the database user in the command above\. - -## Changing the password for a database user - - In some cases, you might change the password for a database user in an RDS DB instance or Aurora cluster that's associated with a proxy\. If so, update the corresponding Secrets Manager secret with the new password\. - -## Configuring connection settings - -To adjust RDS Proxy's connection pooling, you can modify the following settings: -+ [IdleClientTimeout](#rds-proxy-connection-pooling-tuning.idleclienttimeout) -+ [MaxConnectionsPercent](#rds-proxy-connection-pooling-tuning.maxconnectionspercent) -+ [MaxIdleConnectionsPercent](#rds-proxy-connection-pooling-tuning.maxidleconnectionspercent) -+ [ConnectionBorrowTimeout](#rds-proxy-connection-pooling-tuning.connectionborrowtimeout) - -### IdleClientTimeout - -You can specify how long a client connection can be idle before the proxy can close it\. The default is 1,800 seconds \(30 minutes\)\. - -A client connection is considered *idle* when the application doesn't submit a new request within the specified time after the previous request completed\. The underlying database connection stays open and is returned to the connection pool\. Thus, it's available to be reused for new client connections\. If you want the proxy to proactively remove stale connections, consider lowering the idle client connection timeout\. If your workload establishes frequent connections with the proxy, consider raising the idle client connection timeout to save the cost of establishing connections\. - -This setting is represented by the **Idle client connection timeout** field in the RDS console and the `IdleClientTimeout` setting in the AWS CLI and the API\. To learn how to change the value of the **Idle client connection timeout** field in the RDS console, see [AWS Management Console](#rds-proxy-modifying-proxy.console)\. To learn how to change the value of the `IdleClientTimeout` setting, see the CLI command [modify\-db\-proxy](https://docs.aws.amazon.com/cli/latest/reference/rds/modify-db-proxy.html) or the API operation [ModifyDBProxy](https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_ModifyDBProxy.html)\. - -### MaxConnectionsPercent - -You can limit the number of connections that an RDS Proxy can establish with the target database\. You specify the limit as a percentage of the maximum connections available for your database\. This setting is represented by the **Connection pool maximum connections** field in the RDS console and the `MaxConnectionsPercent` setting in the AWS CLI and the API\. - -The `MaxConnectionsPercent` value is expressed as a percentage of the `max_connections` setting for the RDS DB instance used by the target group\. The proxy doesn't create all of these connections in advance\. This setting reserves the right for the proxy to establish these connections as the workload needs them\. - -For example, for a registered database target with `max_connections` set to 1000, and `MaxConnectionsPercent` set to 95, RDS Proxy sets 950 connections as the upper limit for concurrent connections to that database target\. - -A common side\-effect of your workload reaching the maximum number of allowed database connections is an increase in overall query latency, along with an increase in the `DatabaseConnectionsBorrowLatency` metric\. You can monitor currently used and total allowed database connections by comparing the `DatabaseConnections` and `MaxDatabaseConnectionsAllowed` metrics\. - -When setting this parameter, note the following best practices: -+ Allow sufficient connection headroom for changes in workload pattern\. It is recommended to set the parameter at least 30% above your maximum recent monitored usage\. As RDS Proxy redistributes database connection quotas across multiple nodes, internal capacity changes might require at least 30% headroom for additional connections to avoid increased borrow latencies\. -+ RDS Proxy reserves a certain number of connections for active monitoring to support fast failover, traffic routing and internal operations\. The `MaxDatabaseConnectionsAllowed` metric does not include these reserved connections\. It represents the number of connections available to serve the workload, and can be lower than the value derived from the `MaxConnectionsPercent` setting\. - - Minimal recommended `MaxConnectionsPercent` values - + db\.t3\.small: 30 - + db\.t3\.medium or above: 20 - -To learn how to change the value of the **Connection pool maximum connections** field in the RDS console, see [AWS Management Console](#rds-proxy-modifying-proxy.console)\. To learn how to change the value of the `MaxConnectionsPercent` setting, see the CLI command [modify\-db\-proxy\-target\-group](https://docs.aws.amazon.com/cli/latest/reference/rds/modify-db-proxy-target-group.html) or the API operation [ModifyDBProxyTargetGroup](https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_ModifyDBProxyTargetGroup.html)\. - - For information on database connection limits, see [Maximum number of database connections](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_Limits.html#RDS_Limits.MaxConnections)\. - -### MaxIdleConnectionsPercent - -You can control the number of idle database connections that RDS Proxy can keep in the connection pool\. RDS Proxy considers a database connection in it's pool to be *idle* when there's been no activity on the connection for five minutes\. - -You specify the limit as a percentage of the maximum connections available for your database\. The default value is 50 percent of `MaxConnectionsPercent`, and the upper limit is the value of `MaxConnectionsPercent`\. With a high value, the proxy leaves a high percentage of idle database connections open\. With a low value, the proxy closes a high percentage of idle database connections\. If your workloads are unpredictable, consider setting a high value for `MaxIdleConnectionsPercent`\. Doing so means that RDS Proxy can accommodate surges in activity without opening a lot of new database connections\. - -This setting is represented by the `MaxIdleConnectionsPercent` setting of `DBProxyTargetGroup` in the AWS CLI and the API\. To learn how to change the value of the `MaxIdleConnectionsPercent` setting, see the CLI command [modify\-db\-proxy\-target\-group](https://docs.aws.amazon.com/cli/latest/reference/rds/modify-db-proxy-target-group.html) or the API operation [ModifyDBProxyTargetGroup](https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_ModifyDBProxyTargetGroup.html)\. - -**Note** -RDS Proxy closes database connections some time after 24 hours when they are no longer in use\. The proxy performs this action regardless of the value of the maximum idle connections setting\. - - For information on database connection limits, see [Maximum number of database connections](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_Limits.html#RDS_Limits.MaxConnections)\. - -### ConnectionBorrowTimeout - -You can choose how long RDS Proxy waits for a database connection in the connection pool to become available for use before returning a timeout error\. The default is 120 seconds\. This setting applies when the number of connections is at the maximum, and so no connections are available in the connection pool\. It also applies if no appropriate database instance is available to handle the request because, for example, a failover operation is in process\. Using this setting, you can set the best wait period for your application without having to change the query timeout in your application code\. - -This setting is represented by the **Connection borrow timeout** field in the RDS console or the `ConnectionBorrowTimeout` setting of `DBProxyTargetGroup` in the AWS CLI or API\. To learn how to change the value of the **Connection borrow timeout** field in the RDS console, see [AWS Management Console](#rds-proxy-modifying-proxy.console)\. To learn how to change the value of the `ConnectionBorrowTimeout` setting, see the CLI command [modify\-db\-proxy\-target\-group](https://docs.aws.amazon.com/cli/latest/reference/rds/modify-db-proxy-target-group.html) or the API operation [ModifyDBProxyTargetGroup](https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_ModifyDBProxyTargetGroup.html)\. - -## Avoiding pinning - - Multiplexing is more efficient when database requests don't rely on state information from previous requests\. In that case, RDS Proxy can reuse a connection at the conclusion of each transaction\. Examples of such state information include most variables and configuration parameters that you can change through `SET` or `SELECT` statements\. SQL transactions on a client connection can multiplex between underlying database connections by default\. - - Your connections to the proxy can enter a state known as *pinning*\. When a connection is pinned, each later transaction uses the same underlying database connection until the session ends\. Other client connections also can't reuse that database connection until the session ends\. The session ends when the client connection is dropped\. - - RDS Proxy automatically pins a client connection to a specific DB connection when it detects a session state change that isn't appropriate for other sessions\. Pinning reduces the effectiveness of connection reuse\. If all or almost all of your connections experience pinning, consider modifying your application code or workload to reduce the conditions that cause the pinning\. - - For example, suppose that your application changes a session variable or configuration parameter\. In this case, later statements can rely on the new variable or parameter to be in effect\. Thus, when RDS Proxy processes requests to change session variables or configuration settings, it pins that session to the DB connection\. That way, the session state remains in effect for all later transactions in the same session\. - - For some database engines, this rule doesn't apply to all parameters that you can set\. RDS Proxy tracks certain statements and variables\. Thus RDS Proxy doesn't pin the session when you modify them\. In this case, RDS Proxy only reuses the connection for other sessions that have the same values for those settings\. For details about what RDS Proxy tracks for a database engine, see the following: -+ [What RDS Proxy tracks for RDS for SQL Server databases](#rds-proxy-pinning.sql-server-tracked-vars) -+ [What RDS Proxy tracks for RDS for MariaDB and RDS for MySQL databases](#rds-proxy-pinning.mysql-tracked-vars) - -### What RDS Proxy tracks for RDS for SQL Server databases - -Following are the SQL Server statements that RDS Proxy tracks: -+ `USE` -+ `SET ANSI_NULLS` -+ `SET ANSI_PADDING` -+ `SET ANSI_WARNINGS` -+ `SET ARITHABORT` -+ `SET CONCAT_NULL_YIELDS_NULL` -+ `SET CURSOR_CLOSE_ON_COMMIT` -+ `SET DATEFIRST` -+ `SET DATEFORMAT` -+ `SET LANGUAGE` -+ `SET LOCK_TIMEOUT` -+ `SET NUMERIC_ROUNDABORT` -+ `SET QUOTED_IDENTIFIER` -+ `SET TEXTSIZE` -+ `SET TRANSACTION ISOLATION LEVEL` - -### What RDS Proxy tracks for RDS for MariaDB and RDS for MySQL databases - -Following are the MySQL and MariaDB statements that RDS Proxy tracks: -+ DROP DATABASE -+ DROP SCHEMA -+ USE - -Following are the MySQL and MariaDB variables that RDS Proxy tracks: -+ `AUTOCOMMIT` -+ `AUTO_INCREMENT_INCREMENT` -+ `CHARACTER SET (or CHAR SET)` -+ `CHARACTER_SET_CLIENT` -+ `CHARACTER_SET_DATABASE` -+ `CHARACTER_SET_FILESYSTEM` -+ `CHARACTER_SET_CONNECTION` -+ `CHARACTER_SET_RESULTS` -+ `CHARACTER_SET_SERVER` -+ `COLLATION_CONNECTION` -+ `COLLATION_DATABASE` -+ `COLLATION_SERVER` -+ `INTERACTIVE_TIMEOUT` -+ `NAMES` -+ `NET_WRITE_TIMEOUT` -+ `QUERY_CACHE_TYPE` -+ `SESSION_TRACK_SCHEMA` -+ `SQL_MODE` -+ `TIME_ZONE` -+ `TRANSACTION_ISOLATION (or TX_ISOLATION)` -+ `TRANSACTION_READ_ONLY (or TX_READ_ONLY)` -+ `WAIT_TIMEOUT` - -### Minimizing pinning - - Performance tuning for RDS Proxy involves trying to maximize transaction\-level connection reuse \(multiplexing\) by minimizing pinning\. - -In some cases, RDS Proxy can't be sure that it's safe to reuse a database connection outside of the current session\. In these cases, it keeps the session on the same connection until the session ends\. This fallback behavior is called *pinning*\. - -You can minimize pinning by doing the following: -+ Avoid unnecessary database requests that might cause pinning\. -+ Set variables and configuration settings consistently across all connections\. That way, later sessions are more likely to reuse connections that have those particular settings\. - - However, for PostgreSQL setting a variable leads to session pinning\. -+ For a MySQL engine family database, apply a session pinning filter to the proxy\. You can exempt certain kinds of operations from pinning the session if you know that doing so doesn't affect the correct operation of your application\. -+ See how frequently pinning occurs by monitoring the Amazon CloudWatch metric `DatabaseConnectionsCurrentlySessionPinned`\. For information about this and other CloudWatch metrics, see [Monitoring RDS Proxy metrics with Amazon CloudWatchMonitoring RDS Proxy with CloudWatch](rds-proxy.monitoring.md)\. -+ If you use `SET` statements to perform identical initialization for each client connection, you can do so while preserving transaction\-level multiplexing\. In this case, you move the statements that set up the initial session state into the initialization query used by a proxy\. This property is a string containing one or more SQL statements, separated by semicolons\. - - For example, you can define an initialization query for a proxy that sets certain configuration parameters\. Then, RDS Proxy applies those settings whenever it sets up a new connection for that proxy\. You can remove the corresponding `SET` statements from your application code, so that they don't interfere with transaction\-level multiplexing\. - - For metrics about how often pinning occurs for a proxy, see [Monitoring RDS Proxy metrics with Amazon CloudWatchMonitoring RDS Proxy with CloudWatch](rds-proxy.monitoring.md)\. - -### Conditions that cause pinning for all engine families - - The proxy pins the session to the current connection in the following situations where multiplexing might cause unexpected behavior: -+ Any statement with a text size greater than 16 KB causes the proxy to pin the session\. -+ Prepared statements cause the proxy to pin the session\. This rule applies whether the prepared statement uses SQL text or the binary protocol\. - -### Conditions that cause pinning for RDS for Microsoft SQL Server - - For RDS for SQL Server, the following interactions also cause pinning: -+ Using multiple active result sets \(MARS\)\. For information about MARS, see the [SQL Server](https://docs.microsoft.com/en-us/sql/relational-databases/native-client/features/using-multiple-active-result-sets-mars?view=sql-server-ver16) documentation\. -+ Using distributed transaction coordinator \(DTC\) communication\. -+ Creating temporary tables, transactions, cursors, or prepared statements\. -+ Using the following `SET` statements: - + `SET ANSI_DEFAULTS` - + `SET ANSI_NULL_DFLT` - + `SET ARITHIGNORE` - + `SET DEADLOCK_PRIORITY` - + `SET FIPS_FLAGGER` - + `SET FMTONLY` - + `SET FORCEPLAN` - + `SET IDENTITY_INSERT` - + `SET NOCOUNT` - + `SET NOEXEC` - + `SET OFFSETS` - + `SET PARSEONLY` - + `SET QUERY_GOVERNOR_COST_LIMIT` - + `SET REMOTE_PROC_TRANSACTIONS` - + `SET ROWCOUNT` - + `SET SHOWPLAN_ALL`, `SHOWPLAN_TEXT`, and `SHOWPLAN_XML` - + `SET STATISTICS` - + `SET XACT_ABORT` - -### Conditions that cause pinning for RDS for MariaDB and RDS for MySQL - - For MySQL and MariaDB, the following interactions also cause pinning: -+ Explicit table lock statements `LOCK TABLE`, `LOCK TABLES`, or `FLUSH TABLES WITH READ LOCK` cause the proxy to pin the session\. -+ Creating named locks by using `GET_LOCK` causes the proxy to pin the session\. -+ Setting a user variable or a system variable \(with some exceptions\) causes the proxy to pin the session\. If this situation reduces your connection reuse too much, you can choose for `SET` operations not to cause pinning\. For information about how to do so by setting the session pinning filters property, see [Creating an RDS Proxy](rds-proxy-setup.md#rds-proxy-creating) and [Modifying an RDS Proxy](#rds-proxy-modifying-proxy)\. -+ RDS Proxy does not pin connections when you use SET LOCAL\. -+ Creating a temporary table causes the proxy to pin the session\. That way, the contents of the temporary table are preserved throughout the session regardless of transaction boundaries\. -+ Calling the functions `ROW_COUNT`, `FOUND_ROWS`, and `LAST_INSERT_ID` sometimes causes pinning\. - - Calling stored procedures and stored functions doesn't cause pinning\. RDS Proxy doesn't detect any session state changes resulting from such calls\. Therefore, make sure that your application doesn't change session state inside stored routines and rely on that session state to persist across transactions\. For example, if a stored procedure creates a temporary table that is intended to persist across transactions, that application currently isn't compatible with RDS Proxy\. - - If you have expert knowledge about your application behavior, you can skip the pinning behavior for certain application statements\. To do so, choose the **Session pinning filters** option when creating the proxy\. Currently, you can opt out of session pinning for setting session variables and configuration settings\. - -### Conditions that cause pinning for RDS for PostgreSQL - - For PostgreSQL, the following interactions also cause pinning: -+ Using `SET` commands -+ Using the PostgreSQL extended query protocol such as by using JDBC default settings -+ Creating temporary sequences, tables, or views -+ Declaring cursors -+ Discarding the session state -+ Listening on a notification channel -+ Loading a library module such as `auto_explain` -+ Manipulating sequences using functions such as `nextval` and `setval` -+ Interacting with locks using functions such as `pg_advisory_lock` and `pg_try_advisory_lock` -+ Using prepared statements, setting parameters, or resetting a parameter to its default - -## Deleting an RDS Proxy - - You can delete a proxy if you no longer need it\. You might delete a proxy because the application that was using it is no longer relevant\. Or you might delete a proxy if you take the DB instance or cluster associated with it out of service\. - -### AWS Management Console - -**To delete a proxy** - -1. Sign in to the AWS Management Console and open the Amazon RDS console at [https://console\.aws\.amazon\.com/rds/](https://console.aws.amazon.com/rds/)\. - -1. In the navigation pane, choose **Proxies**\. - -1. Choose the proxy to delete from the list\. - -1. Choose **Delete Proxy**\. - -### AWS CLI - - To delete a DB proxy, use the AWS CLI command [delete\-db\-proxy](https://docs.aws.amazon.com/cli/latest/reference/rds/delete-db-proxy.html)\. To remove related associations, also use the [deregister\-db\-proxy\-targets](https://docs.aws.amazon.com/cli/latest/reference/rds/deregister-db-proxy-targets.html) command\. - -``` -aws rds delete-db-proxy --name proxy_name -``` - -``` -aws rds deregister-db-proxy-targets - --db-proxy-name proxy_name - [--target-group-name target_group_name] - [--target-ids comma_separated_list] # or - [--db-instance-identifiers instance_id] # or - [--db-cluster-identifiers cluster_id] -``` - -### RDS API - - To delete a DB proxy, call the Amazon RDS API function [DeleteDBProxy](https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_DeleteDBProxy.html)\. To delete related items and associations, you also call the functions [DeleteDBProxyTargetGroup](https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_DeleteDBProxyTargetGroup.html) and [DeregisterDBProxyTargets](https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_DeregisterDBProxyTargets.html)\. \ No newline at end of file diff --git a/doc_source/rds-proxy-planning.md b/doc_source/rds-proxy-planning.md deleted file mode 100644 index 9cea74b..0000000 --- a/doc_source/rds-proxy-planning.md +++ /dev/null @@ -1,11 +0,0 @@ -# Planning where to use RDS Proxy - - You can determine which of your DB instances, clusters, and applications might benefit the most from using RDS Proxy\. To do so, consider these factors: -+ Any DB instance or cluster that encounters "too many connections" errors is a good candidate for associating with a proxy\. The proxy enables applications to open many client connections, while the proxy manages a smaller number of long\-lived connections to the DB instance or cluster\. -+ For DB instances or clusters that use smaller AWS instance classes, such as T2 or T3, using a proxy can help avoid out\-of\-memory conditions\. It can also help reduce the CPU overhead for establishing connections\. These conditions can occur when dealing with large numbers of connections\. -+ You can monitor certain Amazon CloudWatch metrics to determine whether a DB instance or cluster is approaching certain types of limit\. These limits are for the number of connections and the memory associated with connection management\. You can also monitor certain CloudWatch metrics to determine whether a DB instance or cluster is handling many short\-lived connections\. Opening and closing such connections can impose performance overhead on your database\. For information about the metrics to monitor, see [Monitoring RDS Proxy metrics with Amazon CloudWatchMonitoring RDS Proxy with CloudWatch](rds-proxy.monitoring.md)\. -+ AWS Lambda functions can also be good candidates for using a proxy\. These functions make frequent short database connections that benefit from connection pooling offered by RDS Proxy\. You can take advantage of any IAM authentication you already have for Lambda functions, instead of managing database credentials in your Lambda application code\. -+ Applications that typically open and close large numbers of database connections and don't have built\-in connection pooling mechanisms are good candidates for using a proxy\. -+ Applications that keep a large number of connections open for long periods are typically good candidates for using a proxy\. Applications in industries such as software as a service \(SaaS\) or ecommerce often minimize the latency for database requests by leaving connections open\. With RDS Proxy, an application can keep more connections open than it can when connecting directly to the DB instance or cluster\. -+ You might not have adopted IAM authentication and Secrets Manager due to the complexity of setting up such authentication for all DB instances and clusters\. If so, you can leave the existing authentication methods in place and delegate the authentication to a proxy\. The proxy can enforce the authentication policies for client connections for particular applications\. You can take advantage of any IAM authentication you already have for Lambda functions, instead of managing database credentials in your Lambda application code\. -+ RDS Proxy can help make applications more resilient and transparent to database failures\. RDS Proxy bypasses Domain Name System \(DNS\) caches to reduce failover times by up to 66% for Amazon RDS Multi\-AZ databases\. RDS Proxy also automatically routes traffic to a new database instance while preserving application connections\. This makes failovers more transparent for applications\. \ No newline at end of file diff --git a/doc_source/rds-proxy-setup.md b/doc_source/rds-proxy-setup.md deleted file mode 100644 index b363257..0000000 --- a/doc_source/rds-proxy-setup.md +++ /dev/null @@ -1,579 +0,0 @@ -# Getting started with RDS Proxy - - In the following sections, you can find how to set up RDS Proxy\. You can also find how to set related security options\. These control who can access each proxy and how each proxy connects to DB instances\. - -**Topics** -+ [Setting up network prerequisites](#rds-proxy-network-prereqs) -+ [Setting up database credentials in AWS Secrets Manager](#rds-proxy-secrets-arns) -+ [Setting up AWS Identity and Access Management \(IAM\) policies](#rds-proxy-iam-setup) -+ [Creating an RDS Proxy](#rds-proxy-creating) -+ [Viewing an RDS Proxy](#rds-proxy-viewing) -+ [Connecting to a database through RDS Proxy](#rds-proxy-connecting) - -## Setting up network prerequisites - - Using RDS Proxy requires you to have a common virtual private cloud \(VPC\) between your Aurora DB cluster or RDS DB instance and RDS Proxy\. This VPC should have a minimum of two subnets that are in different Availability Zones\. Your account can either own these subnets or share them with other accounts\. For information about VPC sharing, see [Work with shared VPCs](https://docs.aws.amazon.com/vpc/latest/userguide/vpc-sharing.html)\. Your client application resources such as Amazon EC2, Lambda, or Amazon ECS can be in the same VPC as the proxy\. Or they can be in a separate VPC from the proxy\. If you successfully connected to any RDS DB instances or Aurora DB clusters, you already have the required network resources\. - -**Topics** -+ [Getting information about your subnets](#rds-proxy-network-prereqs.subnet-info) -+ [Planning for IP address capacity](#rds-proxy-network-prereqs.plan-ip-address) - -### Getting information about your subnets - - The following Linux example shows AWS CLI commands that examine the VPCs and subnets owned by your AWS account\. In particular, you pass subnet IDs as parameters when you create a proxy using the CLI\. - -``` -aws ec2 describe-vpcs -aws ec2 describe-internet-gateways -aws ec2 describe-subnets --query '*[].[VpcId,SubnetId]' --output text | sort -``` - -The following Linux example shows AWS CLI commands to determine the subnet IDs corresponding to a specific Aurora DB cluster or RDS DB instance\. For an Aurora cluster, first you find the ID for one of the associated DB instances\. You can extract the subnet IDs used by that DB instance\. To do so, examine the nested fields within the `DBSubnetGroup` and `Subnets` attributes in the describe output for the DB instance\. You specify some or all of those subnet IDs when setting up a proxy for that database server\. - -``` -$ # Optional first step, only needed if you're starting from an Aurora cluster. Find the ID of any DB instance in the cluster. -$ aws rds describe-db-clusters --db-cluster-identifier my_cluster_id --query '*[].[DBClusterMembers]|[0]|[0][*].DBInstanceIdentifier' --output text -my_instance_id -instance_id_2 -instance_id_3 -... - -$ # From the DB instance, trace through the DBSubnetGroup and Subnets to find the subnet IDs. -$ aws rds describe-db-instances --db-instance-identifier my_instance_id --query '*[].[DBSubnetGroup]|[0]|[0]|[Subnets]|[0]|[*].SubnetIdentifier' --output text -subnet_id_1 -subnet_id_2 -subnet_id_3 -... -``` - -Or you can first find the VPC ID for the DB instance\. Then you can examine the VPC to find its subnets\. The following Linux example shows how\. - -``` -$ # From the DB instance, find the VPC. -$ aws rds describe-db-instances --db-instance-identifier my_instance_id --query '*[].[DBSubnetGroup]|[0]|[0].VpcId' --output text -my_vpc_id - -$ aws ec2 describe-subnets --filters Name=vpc-id,Values=my_vpc_id --query '*[].[SubnetId]' --output text -subnet_id_1 -subnet_id_2 -subnet_id_3 -subnet_id_4 -subnet_id_5 -subnet_id_6 -``` - -### Planning for IP address capacity - -An RDS Proxy automatically adjusts its capacity as needed based on the size and number of DB instances registered with it\. Certain operations might also require additional proxy capacity\. Some examples are increasing the size of a registered database or internal RDS Proxy maintenance operations\. During these operations, your proxy might need more IP addresses to provision the extra capacity\. These additional addresses allow your proxy to scale without affecting your workload\. A lack of free IP addresses in your subnets prevents a proxy from scaling up\. This can lead to higher query latencies or client connection failures\. RDS notifies you through event `RDS-EVENT-0243` when there aren't enough free IP addresses in your subnets\. For information about this event, see [Working with RDS Proxy eventsWorking with RDS Proxy events](rds-proxy.events.md)\. - -Following are the recommended minimum number of IP addresses to leave free in your subnets for your proxy based on DB instance class sizes\. - - -| DB instance class | Minimum free IP addresses | -| --- | --- | -| db\.\*\.xlarge or smaller | 10 | -| db\.\*\.2xlarge | 15 | -| db\.\*\.4xlarge | 25 | -| db\.\*\.8xlarge | 45 | -| db\.\*\.12xlarge | 60 | -| db\.\*\.16xlarge | 75 | -| db\.\*\.24xlarge | 110 | - -These numbers of recommended IP addresses are estimates for a proxy with only the default endpoint\. A proxy with additional endpoints or read replicas might need more free IP addresses\. For each additional endpoint, we recommend that you reserve three more IP addresses\. For each read replica, we recommend that you reserve additional IP addresses as specified in the table based on that read replica's size\. - -**Note** -RDS Proxy never uses more than 215 IP addresses in a VPC\. - -## Setting up database credentials in AWS Secrets Manager - - For each proxy that you create, you first use the Secrets Manager service to store sets of user name and password credentials\. You create a separate Secrets Manager secret for each database user account that the proxy connects to on the RDS DB instance or Aurora DB cluster\. - - In Secrets Manager, you create these secrets with values for the `username` and `password` fields\. Doing so allows the proxy to connect to the corresponding database users on RDS DB instances or Aurora DB clusters that you associate with the proxy\. To do this, you can use the setting **Credentials for other database**, **Credentials for RDS database**, or **Other type of secrets**\. Fill in the appropriate values for the **User name** and **Password** fields, and placeholder values for any other required fields\. The proxy ignores other fields such as **Host** and **Port** if they're present in the secret\. Those details are automatically supplied by the proxy\. - - You can also choose **Other type of secrets**\. In this case, you create the secret with keys named `username` and `password`\. - - Because the secrets used by your proxy aren't tied to a specific database server, you can reuse a secret across multiple proxies\. To do so, use the same credentials across multiple database servers\. For example, you might use the same credentials across a group of development and test servers\. - - To connect through the proxy as a specific user, make sure that the password associated with a secret matches the database password for that user\. If there's a mismatch, you can update the associated secret in Secrets Manager\. In this case, you can still connect to other accounts where the secret credentials and the database passwords do match\. - -**Note** -For RDS for SQL Server, the number of Secrets Manager secrets that you need to create for a proxy depends on the collation that your DB instance uses\. For example, suppose that your DB instance uses case\-sensitive collation\. If your application accepts both "Admin" and "admin," then your proxy needs two separate secrets\. For more information about collation in SQL Server, see the [ Microsoft SQL Server](https://docs.microsoft.com/en-us/sql/relational-databases/collations/collation-and-unicode-support?view=sql-server-ver16) documentation\. - - When you create a proxy through the AWS CLI or RDS API, you specify the Amazon Resource Names \(ARNs\) of the corresponding secrets\. You do so for all the DB user accounts that the proxy can access\. In the AWS Management Console, you choose the secrets by their descriptive names\. - - For instructions about creating secrets in Secrets Manager, see the [Creating a secret](https://docs.aws.amazon.com/secretsmanager/latest/userguide/manage_create-basic-secret.html) page in the Secrets Manager documentation\. Use one of the following techniques: -+ Use [Secrets Manager](http://aws.amazon.com/secrets-manager/) in the console\. -+ To use the CLI to create a Secrets Manager secret for use with RDS Proxy, use a command such as the following\. - - ``` - aws secretsmanager create-secret - --name "secret_name" - --description "secret_description" - --region region_name - --secret-string '{"username":"db_user","password":"db_user_password"}' - ``` - - For example, the following commands create Secrets Manager secrets for two database users, one named `admin` and the other named `app-user`\. - -``` -aws secretsmanager create-secret \ - --name admin_secret_name --description "db admin user" \ - --secret-string '{"username":"admin","password":"choose_your_own_password"}' - -aws secretsmanager create-secret \ - --name proxy_secret_name --description "application user" \ - --secret-string '{"username":"app-user","password":"choose_your_own_password"}' -``` - - To see the secrets owned by your AWS account, use a command such as the following\. - -``` -aws secretsmanager list-secrets -``` - - When you create a proxy using the CLI, you pass the Amazon Resource Names \(ARNs\) of one or more secrets to the `--auth` parameter\. The following Linux example shows how to prepare a report with only the name and ARN of each secret owned by your AWS account\. This example uses the `--output table` parameter that is available in AWS CLI version 2\. If you are using AWS CLI version 1, use `--output text` instead\. - -``` -aws secretsmanager list-secrets --query '*[].[Name,ARN]' --output table -``` - - To verify that you stored the correct credentials and in the right format in a secret, use a command such as the following\. Substitute the short name or the ARN of the secret for `your_secret_name`\. - -``` -aws secretsmanager get-secret-value --secret-id your_secret_name -``` - - The output should include a line displaying a JSON\-encoded value like the following\. - -``` -"SecretString": "{\"username\":\"your_username\",\"password\":\"your_password\"}", -``` - -## Setting up AWS Identity and Access Management \(IAM\) policies - - After you create the secrets in Secrets Manager, you create an IAM policy that can access those secrets\. For general information about using IAM with RDS and Aurora, see [Identity and access management for Amazon RDS](UsingWithRDS.IAM.md)\. - -**Tip** - The following procedure applies if you use the IAM console\. If you use the AWS Management Console for RDS, RDS can create the IAM policy for you automatically\. In that case, you can skip the following procedure\. - -**To create an IAM policy that accesses your Secrets Manager secrets for use with your proxy** - -1. Sign in to the IAM console\. Follow the **Create role** process, as described in [Creating IAM roles](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_create.html), choosing [Creating a role to delegate permissions to an AWS service](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_create_for-service.html)\. - - Choose **AWS service** for the **Trusted entity type**\. Under **Use case**, select **RDS** from **Use cases for other AWS services** dropdown\. Select **RDS \- Add Role to Database**\. - -1. For the new role, perform the **Add inline policy** step\. Use the same general procedures as in [Editing IAM policies](https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies_manage-edit.html)\. Paste the following JSON into the JSON text box\. Substitute your own account ID\. Substitute your AWS Region for `us-east-2`\. Substitute the Amazon Resource Names \(ARNs\) for the secrets that you created, see [ Specifying KMS keys in IAM policy statements](https://docs.aws.amazon.com/kms/latest/developerguide/cmks-in-iam-policies.html)\. For the `kms:Decrypt` action, substitute the ARN of the default AWS KMS key or your own KMS key\. Which one you use depends on which one you used to encrypt the Secrets Manager secrets\. - - ``` - { - "Version": "2012-10-17", - "Statement": [ - { - "Sid": "VisualEditor0", - "Effect": "Allow", - "Action": "secretsmanager:GetSecretValue", - "Resource": [ - "arn:aws:secretsmanager:us-east-2:account_id:secret:secret_name_1", - "arn:aws:secretsmanager:us-east-2:account_id:secret:secret_name_2" - ] - }, - { - "Sid": "VisualEditor1", - "Effect": "Allow", - "Action": "kms:Decrypt", - "Resource": "arn:aws:kms:us-east-2:account_id:key/key_id", - "Condition": { - "StringEquals": { - "kms:ViaService": "secretsmanager.us-east-2.amazonaws.com" - } - } - } - ] - } - ``` - -1. Edit the trust policy for this IAM role\. Paste the following JSON into the JSON text box\. - - ``` - { - "Version": "2012-10-17", - "Statement": [ - { - "Sid": "", - "Effect": "Allow", - "Principal": { - "Service": "rds.amazonaws.com" - }, - "Action": "sts:AssumeRole" - } - ] - } - ``` - - The following commands perform the same operation through the AWS CLI\. - -``` -PREFIX=my_identifier - -aws iam create-role --role-name my_role_name \ - --assume-role-policy-document '{"Version":"2012-10-17","Statement":[{"Effect":"Allow","Principal":{"Service":["rds.amazonaws.com"]},"Action":"sts:AssumeRole"}]}' - -aws iam put-role-policy --role-name my_role_name \ - --policy-name $PREFIX-secret-reader-policy --policy-document '{"Version":"2012-10-17","Statement":[{"Effect":"Allow","Principal":{"Service":["rds.amazonaws.com"]},"Action":"sts:AssumeRole"}]}' - -aws kms create-key --description "$PREFIX-test-key" --policy '{ - "Id":"$PREFIX-kms-policy", - "Version":"2012-10-17", - "Statement": - [ - { - "Sid":"Enable IAM User Permissions", - "Effect":"Allow", - "Principal":{"AWS":"arn:aws:iam::account_id:root"}, - "Action":"kms:*","Resource":"*" - }, - { - "Sid":"Allow access for Key Administrators", - "Effect":"Allow", - "Principal": - { - "AWS": - ["$USER_ARN","arn:aws:iam::account_id:role/Admin"] - }, - "Action": - [ - "kms:Create*", - "kms:Describe*", - "kms:Enable*", - "kms:List*", - "kms:Put*", - "kms:Update*", - "kms:Revoke*", - "kms:Disable*", - "kms:Get*", - "kms:Delete*", - "kms:TagResource", - "kms:UntagResource", - "kms:ScheduleKeyDeletion", - "kms:CancelKeyDeletion" - ], - "Resource":"*" - }, - { - "Sid":"Allow use of the key", - "Effect":"Allow", - "Principal":{"AWS":"$ROLE_ARN"}, - "Action":["kms:Decrypt","kms:DescribeKey"], - "Resource":"*" - } - ] -}' -``` - -## Creating an RDS Proxy - - To manage connections for a specified set of DB instances, you can create a proxy\. You can associate a proxy with an RDS for MariaDB, RDS for Microsoft SQL Server, RDS for MySQL, or RDS for PostgreSQL DB instance\. - -### AWS Management Console - -**To create a proxy** - -1. Sign in to the AWS Management Console and open the Amazon RDS console at [https://console\.aws\.amazon\.com/rds/](https://console.aws.amazon.com/rds/)\. - -1. In the navigation pane, choose **Proxies**\. - -1. Choose **Create proxy**\. - -1. Choose all the settings for your proxy\. - - For **Proxy configuration**, provide information for the following: - + **Engine family**\. This setting determines which database network protocol the proxy recognizes when it interprets network traffic to and from the database\. For RDS for MariaDB or RDS for MySQL, choose **MariaDB and MySQL**\. For RDS for PostgreSQL, choose **PostgreSQL**\. For RDS for SQL Server, choose **SQL Server**\. - + **Proxy identifier**\. Specify a name of your choosing, unique within your AWS account ID and current AWS Region\. - + **Idle client connection timeout**\. Choose a time period that a client connection can be idle before the proxy can close it\. The default is 1,800 seconds \(30 minutes\)\. A client connection is considered idle when the application doesn't submit a new request within the specified time after the previous request completed\. The underlying database connection stays open and is returned to the connection pool\. Thus, it's available to be reused for new client connections\. - - Consider lowering the idle client connection timeout if you want the proxy to proactively remove stale connections\. If your workload is spiking, consider raising the idle client connection timeout to save the cost of establishing connections\. - - For **Target group configuration**, provide information for the following: - + **Database**\. Choose one RDS DB instance or Aurora DB cluster to access through this proxy\. The list only includes DB instances and clusters with compatible database engines, engine versions, and other settings\. If the list is empty, create a new DB instance or cluster that's compatible with RDS Proxy\. To do so, follow the procedure in [Creating an Amazon RDS DB instance](USER_CreateDBInstance.md)\. Then try creating the proxy again\. - + **Connection pool maximum connections**\. Specify a value from 1 through 100\. This setting represents the percentage of the `max_connections` value that RDS Proxy can use for its connections\. If you only intend to use one proxy with this DB instance or cluster, you can set this value to 100\. For details about how RDS Proxy uses this setting, see [MaxConnectionsPercent](rds-proxy-managing.md#rds-proxy-connection-pooling-tuning.maxconnectionspercent)\. - + **Session pinning filters**\. \(Optional\) This is an advanced setting, for troubleshooting performance issues with particular applications\. Currently, the setting isn't supported for PostgreSQL and the only choice is `EXCLUDE_VARIABLE_SETS`\. Choose a filter only if both of following are true: First, your application isn't reusing connections due to certain kinds of SQL statements\. Also, you can verify that reusing connections with those SQL statements doesn't affect application correctness\. For more information, see [Avoiding pinning](rds-proxy-managing.md#rds-proxy-pinning)\. - + **Connection borrow timeout**\. In some cases, you might expect the proxy to sometimes use all available database connections\. In such cases, you can specify how long the proxy waits for a database connection to become available before returning a timeout error\. You can specify a period up to a maximum of five minutes\. This setting only applies when the proxy has the maximum number of connections open and all connections are already in use\. - + **Initialization query**\. \(Optional\) You can specify one or more SQL statements for the proxy to run when opening each new database connection\. The setting is typically used with `SET` statements to make sure that each connection has identical settings such as time zone and character set\. For multiple statements, use semicolons as the separator\. You can also include multiple variables in a single `SET` statement, such as `SET x=1, y=2`\. Initialization query is not currently supported for PostgreSQL\. - - For **Authentication**, provide information for the following: - + **IAM role**\. Choose an IAM role that has permission to access the Secrets Manager secrets that you chose earlier\. You can also choose for the AWS Management Console to create a new IAM role for you and use that\. - + **Secrets Manager secrets**\. Choose at least one Secrets Manager secret that contains database user credentials for the RDS DB instance or Aurora DB cluster to access with this proxy\. - + **Client authentication type**\. Choose the type of authentication the proxy uses for connections from clients\. Your choice applies to all Secrets Manager secrets that you associate with this proxy\. If you need to specify a different client authentication type for each secret, create your proxy by using the AWS CLI or the API instead\. - + **IAM authentication**\. Choose whether to require, allow, or disallow IAM authentication for connections to your proxy\. The allow option is only valid for proxies for RDS for SQL Server\. Your choice applies to all Secrets Manager secrets that you associate with this proxy\. If you need to specify a different IAM authentication for each secret, create your proxy by using the AWS CLI or the API instead\. - - For **Connectivity**, provide information for the following: - + **Require Transport Layer Security**\. Choose this setting if you want the proxy to enforce TLS/SSL for all client connections\. For an encrypted or unencrypted connection to a proxy, the proxy uses the same encryption setting when it makes a connection to the underlying database\. - + **Subnets**\. This field is prepopulated with all the subnets associated with your VPC\. You can remove any subnets that you don't need for this proxy\. You must leave at least two subnets\. - - Provide additional connectivity configuration: - + **VPC security group**\. Choose an existing VPC security group\. You can also choose for the AWS Management Console to create a new security group for you and use that\. You must configure the **Inbound rules** to allow your applications to access the proxy\. You must also configure the **Outbound rules** to allow traffic from your DB targets\. -**Note** -This security group must allow connections from the proxy to the database\. The same security group is used for ingress from your applications to the proxy, and for egress from the proxy to the database\. For example, suppose that you use the same security group for your database and your proxy\. In this case, make sure that you specify that resources in that security group can communicate with other resources in the same security group\. -When using a shared VPC, you can't use the default security group for the VPC, or one that belongs to another account\. Choose a security group that belongs to your account\. If one doesn't exist, create one\. For more information about this limitation, see [ Work with shared VPCs](https://docs.aws.amazon.com/vpc/latest/userguide/vpc-sharing.html#vpc-share-limitations)\. - - \(Optional\) Provide advanced configuration: - + **Enable enhanced logging**\. You can enable this setting to troubleshoot proxy compatibility or performance issues\. - - When this setting is enabled, RDS Proxy includes detailed information about SQL statements in its logs\. This information helps you to debug issues involving SQL behavior or the performance and scalability of the proxy connections\. The debug information includes the text of SQL statements that you submit through the proxy\. Thus, only enable this setting when needed for debugging\. Also, only enable it when you have security measures in place to safeguard any sensitive information that appears in the logs\. - - To minimize overhead associated with your proxy, RDS Proxy automatically turns this setting off 24 hours after you enable it\. Enable it temporarily to troubleshoot a specific issue\. - -1. Choose **Create Proxy**\. - -### AWS CLI - - To create a proxy by using the AWS CLI, call the [create\-db\-proxy](https://docs.aws.amazon.com/cli/latest/reference/rds/create-db-proxy.html) command with the following required parameters: -+ `--db-proxy-name` -+ `--engine-family` -+ `--role-arn` -+ `--auth` -+ `--vpc-subnet-ids` - -The `--engine-family` value is case\-sensitive\. - -**Example** -For Linux, macOS, or Unix: - -``` -aws rds create-db-proxy \ - --db-proxy-name proxy_name \ - --engine-family { MYSQL | POSTGRESQL | SQLSERVER } \ - --auth ProxyAuthenticationConfig_JSON_string \ - --role-arn iam_role \ - --vpc-subnet-ids space_separated_list \ - [--vpc-security-group-ids space_separated_list] \ - [--require-tls | --no-require-tls] \ - [--idle-client-timeout value] \ - [--debug-logging | --no-debug-logging] \ - [--tags comma_separated_list] -``` -For Windows: - -``` -aws rds create-db-proxy ^ - --db-proxy-name proxy_name ^ - --engine-family { MYSQL | POSTGRESQL | SQLSERVER } ^ - --auth ProxyAuthenticationConfig_JSON_string ^ - --role-arn iam_role ^ - --vpc-subnet-ids space_separated_list ^ - [--vpc-security-group-ids space_separated_list] ^ - [--require-tls | --no-require-tls] ^ - [--idle-client-timeout value] ^ - [--debug-logging | --no-debug-logging] ^ - [--tags comma_separated_list] -``` - -The following is an example of the JSON value for the `--auth` option\. This example 
 applies a different client authentication type to each secret\. - -``` -[ - { - "Description": "proxy_description_1", - "UserName": "user_name_1", - "AuthScheme": "SECRETS", - "SecretArn": "arn:aws:kms:us-west-2:123456789123:key/1234abcd-12ab-34cd-56ef-1234567890ab", - "IAMAuth": "DISABLED", - "ClientPasswordAuthType": "POSTGRES_SCRAM_SHA_256" - }, - - { - "Description": "proxy_description_2", - "UserName": "user_name_2", - "AuthScheme": "SECRETS", - "SecretArn": "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890cd", - "IAMAuth": "DISABLED", - "ClientPasswordAuthType": "POSTGRES_MD5" - - }, - - { - "Description": "proxy_description_3", - "UserName": "user_name_2", - "AuthScheme": "SECRETS", - "SecretArn": "arn:aws:kms:us-west-2:111122221111:key/1234abcd-12ab-34cd-56ef-1234567890ef", - "IAMAuth": "REQUIRED" - } - -] -``` - -**Tip** - If you don't already know the subnet IDs to use for the `--vpc-subnet-ids` parameter, see [Setting up network prerequisites](#rds-proxy-network-prereqs) for examples of how to find them\. - -**Note** -The security group must allow access to the database the proxy connects to\. The same security group is used for ingress from your applications to the proxy, and for egress from the proxy to the database\. For example, suppose that you use the same security group for your database and your proxy\. In this case, make sure that you specify that resources in that security group can communicate with other resources in the same security group\. -When using a shared VPC, you can't use the default security group for the VPC, or one that belongs to another account\. Choose a security group that belongs to your account\. If one doesn't exist, create one\. For more information about this limitation, see [Work with shared VPCs](https://docs.aws.amazon.com/vpc/latest/userguide/vpc-sharing.html#vpc-share-limitations)\. - - To create the required information and associations for the proxy, you also use the [register\-db\-proxy\-targets](https://docs.aws.amazon.com/cli/latest/reference/rds/register-db-proxy-targets.html) command\. Specify the target group name `default`\. RDS Proxy automatically creates a target group with this name when you create each proxy\. - -``` -aws rds register-db-proxy-targets - --db-proxy-name value - [--target-group-name target_group_name] - [--db-instance-identifiers space_separated_list] # rds db instances, or - [--db-cluster-identifiers cluster_id] # rds db cluster (all instances), or - [--db-cluster-endpoint endpoint_name] # rds db cluster endpoint (all instances) -``` - -### RDS API - - To create an RDS proxy, call the Amazon RDS API operation [CreateDBProxy](https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_CreateDBProxy.html)\. You pass a parameter with the [AuthConfig](https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_AuthConfig.html) data structure\. - - RDS Proxy automatically creates a target group named `default` when you create each proxy\. You associate an RDS DB instance or Aurora DB cluster with the target group by calling the function [RegisterDBProxyTargets](https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_RegisterDBProxyTargets.html)\. - -## Viewing an RDS Proxy - - After you create one or more RDS proxies, you can view them all\. Doing so makes it possible to examine their configuration details and choose which ones to modify, delete, and so on\. - - Any database applications that use the proxy require the proxy endpoint to use in the connection string\. - -### AWS Management Console - -**To view your proxy** - -1. Sign in to the AWS Management Console and open the Amazon RDS console at [https://console\.aws\.amazon\.com/rds/](https://console.aws.amazon.com/rds/)\. - -1. In the upper\-right corner of the AWS Management Console, choose the AWS Region in which you created the RDS Proxy\. - -1. In the navigation pane, choose **Proxies**\. - -1. Choose the name of an RDS proxy to display its details\. - -1. On the details page, the **Target groups** section shows how the proxy is associated with a specific RDS DB instance or Aurora DB cluster\. You can follow the link to the **default** target group page to see more details about the association between the proxy and the database\. This page is where you see settings that you specified when creating the proxy\. These include maximum connection percentage, connection borrow timeout, engine family, and session pinning filters\. - -### CLI - - To view your proxy using the CLI, use the [describe\-db\-proxies](https://docs.aws.amazon.com/cli/latest/reference/rds/describe-db-proxies.html) command\. By default, it displays all proxies owned by your AWS account\. To see details for a single proxy, specify its name with the `--db-proxy-name` parameter\. - -``` -aws rds describe-db-proxies [--db-proxy-name proxy_name] -``` - - To view the other information associated with the proxy, use the following commands\. - -``` -aws rds describe-db-proxy-target-groups --db-proxy-name proxy_name - -aws rds describe-db-proxy-targets --db-proxy-name proxy_name -``` - - Use the following sequence of commands to see more detail about the things that are associated with the proxy: - -1. To get a list of proxies, run [describe\-db\-proxies](https://docs.aws.amazon.com/cli/latest/reference/rds/describe-db-proxies.html)\. - -1. To show connection parameters such as the maximum percentage of connections that the proxy can use, run [describe\-db\-proxy\-target\-groups](https://docs.aws.amazon.com/cli/latest/reference/rds/describe-db-proxy-target-groups.html) `--db-proxy-name`\. Use the name of the proxy as the parameter value\. - -1. To see the details of the RDS DB instance or Aurora DB cluster associated with the returned target group, run [describe\-db\-proxy\-targets](https://docs.aws.amazon.com/cli/latest/reference/rds/describe-db-proxy-targets.html)\. - -### RDS API - - To view your proxies using the RDS API, use the [DescribeDBProxies](https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_DescribeDBProxies.html) operation\. It returns values of the [DBProxy](https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_DBProxy.html) data type\. - - To see details of the connection settings for the proxy, use the proxy identifiers from this return value with the [DescribeDBProxyTargetGroups](https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_DescribeDBProxyTargetGroups.html) operation\. It returns values of the [DBProxyTargetGroup](https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_DBProxyTargetGroup.html) data type\. - - To see the RDS instance or Aurora DB cluster associated with the proxy, use the [DescribeDBProxyTargets](https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_DescribeDBProxyTargets.html) operation\. It returns values of the [DBProxyTarget](https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_DBProxyTarget.html) data type\. - -## Connecting to a database through RDS Proxy - -You connect to an RDS DB instance through a proxy in generally the same way as you connect directly to the database\. The main difference is that you specify the proxy endpoint instead of the instance endpoint\. For more information, see [Overview of proxy endpoints](rds-proxy-endpoints.md#rds-proxy-endpoints-overview)\. - -**Topics** -+ [Connecting to a proxy using native authentication](#rds-proxy-connecting-native) -+ [Connecting to a proxy using IAM authentication](#rds-proxy-connecting-iam) -+ [Considerations for connecting to a proxy with Microsoft SQL Server](#rds-proxy-connecting-sqlserver) -+ [Considerations for connecting to a proxy with PostgreSQL](#rds-proxy-connecting-postgresql) - -### Connecting to a proxy using native authentication - - Use the following basic steps to connect to a proxy using native authentication: - -1. Find the proxy endpoint\. In the AWS Management Console, you can find the endpoint on the details page for the corresponding proxy\. With the AWS CLI, you can use the [describe\-db\-proxies](https://docs.aws.amazon.com/cli/latest/reference/rds/describe-db-proxies.html) command\. The following example shows how\. - - ``` - # Add --output text to get output as a simple tab-separated list. - $ aws rds describe-db-proxies --query '*[*].{DBProxyName:DBProxyName,Endpoint:Endpoint}' - [ - [ - { - "Endpoint": "the-proxy.proxy-demo.us-east-1.rds.amazonaws.com", - "DBProxyName": "the-proxy" - }, - { - "Endpoint": "the-proxy-other-secret.proxy-demo.us-east-1.rds.amazonaws.com", - "DBProxyName": "the-proxy-other-secret" - }, - { - "Endpoint": "the-proxy-rds-secret.proxy-demo.us-east-1.rds.amazonaws.com", - "DBProxyName": "the-proxy-rds-secret" - }, - { - "Endpoint": "the-proxy-t3.proxy-demo.us-east-1.rds.amazonaws.com", - "DBProxyName": "the-proxy-t3" - } - ] - ] - ``` - -1. Specify that endpoint as the host parameter in the connection string for your client application\. For example, specify the proxy endpoint as the value for the `mysql -h` option or `psql -h` option\. - -1. Supply the same database user name and password as you usually do\. - -### Connecting to a proxy using IAM authentication - - When you use IAM authentication with RDS Proxy, set up your database users to authenticate with regular user names and passwords\. The IAM authentication applies to RDS Proxy retrieving the user name and password credentials from Secrets Manager\. The connection from RDS Proxy to the underlying database doesn't go through IAM\. - - To connect to RDS Proxy using IAM authentication, use the same general connection procedure as for IAM authentication with an RDS DB instance or Aurora cluster\. For general information about using IAM with RDS and Aurora, see [Security in Amazon RDS](UsingWithRDS.md)\. - - The major differences in IAM usage for RDS Proxy include the following: -+ You don't configure each individual database user with an authorization plugin\. The database users still have regular user names and passwords within the database\. You set up Secrets Manager secrets containing these user names and passwords, and authorize RDS Proxy to retrieve the credentials from Secrets Manager\. - - The IAM authentication applies to the connection between your client program and the proxy\. The proxy then authenticates to the database using the user name and password credentials retrieved from Secrets Manager\. -+ Instead of the instance, cluster, or reader endpoint, you specify the proxy endpoint\. For details about the proxy endpoint, see [Connecting to your DB instance using IAM authentication](UsingWithRDS.IAMDBAuth.Connecting.md)\. -+ In the direct database IAM authentication case, you selectively choose database users and configure them to be identified with a special authentication plugin\. You can then connect to those users using IAM authentication\. - - In the proxy use case, you provide the proxy with Secrets that contain some user's user name and password \(native authentication\)\. You then connect to the proxy using IAM authentication\. Here, you do this by generating an authentication token with the proxy endpoint, not the database endpoint\. You also use a user name that matches one of the user names for the secrets that you provided\. -+ Make sure that you use Transport Layer Security \(TLS\)/Secure Sockets Layer \(SSL\) when connecting to a proxy using IAM authentication\. - - You can grant a specific user access to the proxy by modifying the IAM policy\. An example follows\. - -``` -"Resource": "arn:aws:rds-db:us-east-2:1234567890:dbuser:prx-ABCDEFGHIJKL01234/db_user" -``` - -### Considerations for connecting to a proxy with Microsoft SQL Server - -For connecting to a proxy using IAM authentication, you don't use the password field\. Instead, you provide the appropriate token property for each type of database driver in the token field\. For example, use the `accessToken` property for JDBC, or the `sql_copt_ss_access_token` property for ODBC\. Or use the `AccessToken` property for the \.NET SqlClient driver\. You can't use IAM authentication with clients that don't support token properties\. - -Under some conditions, a proxy can't share a database connection and instead pins the connection from your client application to the proxy to a dedicated database connection\. For more information about these conditions, see [Avoiding pinning](rds-proxy-managing.md#rds-proxy-pinning)\. - -### Considerations for connecting to a proxy with PostgreSQL - - For PostgreSQL, when a client starts a connection to a PostgreSQL database, it sends a startup message\. This message includes pairs of parameter name and value strings\. For details, see the `StartupMessage` in [PostgreSQL message formats](https://www.postgresql.org/docs/current/protocol-message-formats.html) in the PostgreSQL documentation\. - -When connecting through an RDS proxy, the startup message can include the following currently recognized parameters: -+ `user` -+ `database` -+ `replication` - - The startup message can also include the following additional runtime parameters: -+ `[application\_name](https://www.postgresql.org/docs/current/runtime-config-logging.html#GUC-APPLICATION-NAME) ` -+ `[client\_encoding](https://www.postgresql.org/docs/current/runtime-config-client.html#GUC-CLIENT-ENCODING) ` -+ `[DateStyle](https://www.postgresql.org/docs/current/runtime-config-client.html#GUC-DATESTYLE) ` -+ `[TimeZone](https://www.postgresql.org/docs/current/runtime-config-client.html#GUC-TIMEZONE) ` -+ `[extra\_float\_digits](https://www.postgresql.org/docs/current/runtime-config-client.html#GUC-EXTRA-FLOAT-DIGITS) ` - - For more information about PostgreSQL messaging, see the [Frontend/Backend protocol](https://www.postgresql.org/docs/current/protocol.html) in the PostgreSQL documentation\. - - For PostgreSQL, if you use JDBC we recommend the following to avoid pinning: -+ Set the JDBC connection parameter `assumeMinServerVersion` to at least `9.0` to avoid pinning\. Doing this prevents the JDBC driver from performing an extra round trip during connection startup when it runs `SET extra_float_digits = 3`\. -+ Set the JDBC connection parameter `ApplicationName` to `any/your-application-name` to avoid pinning\. Doing this prevents the JDBC driver from performing an extra round trip during connection startup when it runs `SET application_name = "PostgreSQL JDBC Driver"`\. Note the JDBC parameter is `ApplicationName` but the PostgreSQL `StartupMessage` parameter is `application_name`\. -+ Set the JDBC connection parameter `preferQueryMode` to `extendedForPrepared` to avoid pinning\. The `extendedForPrepared` ensures that the extended mode is used only for prepared statements\. - - The default for the `preferQueryMode` parameter is `extended`, which uses the extended mode for all queries\. The extended mode uses a series of `Prepare`, `Bind`, `Execute`, and `Sync` requests and corresponding responses\. This type of series causes connection pinning in an RDS proxy\. - -For more information, see [Avoiding pinning](rds-proxy-managing.md#rds-proxy-pinning)\. For more information about connecting using JDBC, see [Connecting to the database](https://jdbc.postgresql.org/documentation/setup/) in the PostgreSQL documentation\. \ No newline at end of file diff --git a/doc_source/rds-proxy.events.md b/doc_source/rds-proxy.events.md deleted file mode 100644 index c2df573..0000000 --- a/doc_source/rds-proxy.events.md +++ /dev/null @@ -1,55 +0,0 @@ -# Working with RDS Proxy events - -An *event* indicates a change in an environment\. This can be an AWS environment or a service or application from a software as a service \(SaaS\) partner\. Or it can be one of your own custom applications or services\. For example, Amazon RDS generates an event when you create or modify an RDS Proxy\. Amazon RDS delivers events to CloudWatch Events and Amazon EventBridge in near\-real time\. Following, you can find a list of RDS Proxy events that you can subscribe to and an example of an RDS Proxy event\. - -For more information about working with events, see the following: -+ For instructions on how to view events by using the AWS Management Console, AWS CLI, or RDS API, see [Viewing Amazon RDS events](USER_ListEvents.md)\. -+ To learn how to configure Amazon RDS to send events to EventBridge, see [Creating a rule that triggers on an Amazon RDS event](rds-cloud-watch-events.md)\. - -## RDS Proxy events - -The following table shows the event category and a list of events when an RDS Proxy is the source type\. - - -| Category | RDS event ID | Message | Notes | -| --- | --- | --- | --- | -| configuration change | RDS\-EVENT\-0204 | RDS modified DB proxy *name*\. | | -| configuration change | RDS\-EVENT\-0207 | RDS modified the end point of the DB proxy *name*\. | | -| configuration change | RDS\-EVENT\-0213 | RDS detected the addition of the DB instance and automatically added it to the target group of the DB proxy *name*\. | | -| configuration change | RDS\-EVENT\-0213 | RDS detected creation of DB instance *name* and automatically added it to target group *name* of DB proxy *name*\. | | -| configuration change | RDS\-EVENT\-0214 | RDS detected deletion of DB instance *name* and automatically removed it from target group *name* of DB proxy *name*\. | | -| configuration change | RDS\-EVENT\-0215 | RDS detected deletion of DB cluster *name* and automatically removed it from target group *name* of DB proxy *name*\. | | -| creation | RDS\-EVENT\-0203 | RDS created DB proxy *name*\. | | -| creation | RDS\-EVENT\-0206 | RDS created endpoint *name* for DB proxy *name*\. | | -| deletion | RDS\-EVENT\-0205 | RDS deleted DB proxy *name*\. | | -| deletion | RDS\-EVENT\-0208 | RDS deleted endpoint *name* for DB proxy *name*\. | | -| failure | RDS\-EVENT\-0243 | RDS failed to provision capacity for proxy *name* because there aren't enough IP addresses available in your subnets: *name*\. To fix the issue, make sure that your subnets have the minimum number of unused IP addresses as recommended in the RDS Proxy documentation\. | To determine the recommended number for your instance class, see [Planning for IP address capacity](rds-proxy-setup.md#rds-proxy-network-prereqs.plan-ip-address)\. | -| failure | RDS\-EVENT\-0275 | RDS throttled some connections to DB proxy \(RDS Proxy\)\. | | - -The following is an example of an RDS Proxy event in JSON format\. The event shows that RDS modified the endpoint named `my-endpoint` of the RDS Proxy named `my-rds-proxy`\. The event ID is RDS\-EVENT\-0207\. - -``` -{ - "version": "0", - "id": "68f6e973-1a0c-d37b-f2f2-94a7f62ffd4e", - "detail-type": "RDS DB Proxy Event", - "source": "aws.rds", - "account": "123456789012", - "time": "2018-09-27T22:36:43Z", - "region": "us-east-1", - "resources": [ - "arn:aws:rds:us-east-1:123456789012:db-proxy:my-rds-proxy" - ], - "detail": { - "EventCategories": [ - "configuration change" - ], - "SourceType": "DB_PROXY", - "SourceArn": "arn:aws:rds:us-east-1:123456789012:db-proxy:my-rds-proxy", - "Date": "2018-09-27T22:36:43.292Z", - "Message": "RDS modified endpoint my-endpoint of DB Proxy my-rds-proxy.", - "SourceIdentifier": "my-endpoint", - "EventID": "RDS-EVENT-0207" - } -} -``` \ No newline at end of file diff --git a/doc_source/rds-proxy.examples.md b/doc_source/rds-proxy.examples.md deleted file mode 100644 index 9bbb837..0000000 --- a/doc_source/rds-proxy.examples.md +++ /dev/null @@ -1,106 +0,0 @@ -# RDS Proxy command\-line examples - - To see how combinations of connection commands and SQL statements interact with RDS Proxy, look at the following examples\. - -**Examples** -+ [Preserving Connections to a MySQL Database Across a Failover](#example-mysql-preserve-connections) -+ [Adjusting the max_connections Setting for an Aurora DB Cluster](#example-adjust-cluster-max-connections) - -**Example Preserving connections to a MySQL database across a failover** - This MySQL example demonstrates how open connections continue working during a failover\. An example is when you reboot a database or it becomes unavailable due to a problem\. This example uses a proxy named `the-proxy` and an Aurora DB cluster with DB instances `instance-8898` and `instance-9814`\. When you run the `failover-db-cluster` command from the Linux command line, the writer instance that the proxy is connected to changes to a different DB instance\. You can see that the DB instance associated with the proxy changes while the connection remains open\. - -``` -$ mysql -h the-proxy.proxy-demo.us-east-1.rds.amazonaws.com -u admin_user -p -Enter password: -... - -mysql> select @@aurora_server_id; -+--------------------+ -| @@aurora_server_id | -+--------------------+ -| instance-9814 | -+--------------------+ -1 row in set (0.01 sec) - -mysql> -[1]+ Stopped mysql -h the-proxy.proxy-demo.us-east-1.rds.amazonaws.com -u admin_user -p -$ # Initially, instance-9814 is the writer. -$ aws rds failover-db-cluster --db-cluster-identifier cluster-56-2019-11-14-1399 -JSON output -$ # After a short time, the console shows that the failover operation is complete. -$ # Now instance-8898 is the writer. -$ fg -mysql -h the-proxy.proxy-demo.us.us-east-1.rds.amazonaws.com -u admin_user -p - -mysql> select @@aurora_server_id; -+--------------------+ -| @@aurora_server_id | -+--------------------+ -| instance-8898 | -+--------------------+ -1 row in set (0.01 sec) - -mysql> -[1]+ Stopped mysql -h the-proxy.proxy-demo.us-east-1.rds.amazonaws.com -u admin_user -p -$ aws rds failover-db-cluster --db-cluster-identifier cluster-56-2019-11-14-1399 -JSON output -$ # After a short time, the console shows that the failover operation is complete. -$ # Now instance-9814 is the writer again. -$ fg -mysql -h the-proxy.proxy-demo.us-east-1.rds.amazonaws.com -u admin_user -p - -mysql> select @@aurora_server_id; -+--------------------+ -| @@aurora_server_id | -+--------------------+ -| instance-9814 | -+--------------------+ -1 row in set (0.01 sec) -+---------------+---------------+ -| Variable_name | Value | -+---------------+---------------+ -| hostname | ip-10-1-3-178 | -+---------------+---------------+ -1 row in set (0.02 sec) -``` - -**Example Adjusting the max\_connections setting for an Aurora DB cluster** - This example demonstrates how you can adjust the `max_connections` setting for an Aurora MySQL DB cluster\. To do so, you create your own DB cluster parameter group based on the default parameter settings for clusters that are compatible with MySQL 5\.7\. You specify a value for the `max_connections` setting, overriding the formula that sets the default value\. You associate the DB cluster parameter group with your DB cluster\. - -``` -export REGION=us-east-1 -export CLUSTER_PARAM_GROUP=rds-proxy-mysql-57-max-connections-demo -export CLUSTER_NAME=rds-proxy-mysql-57 - -aws rds create-db-parameter-group --region $REGION \ - --db-parameter-group-family aurora-mysql5.7 \ - --db-parameter-group-name $CLUSTER_PARAM_GROUP \ - --description "Aurora MySQL 5.7 cluster parameter group for RDS Proxy demo." - -aws rds modify-db-cluster --region $REGION \ - --db-cluster-identifier $CLUSTER_NAME \ - --db-cluster-parameter-group-name $CLUSTER_PARAM_GROUP - -echo "New cluster param group is assigned to cluster:" -aws rds describe-db-clusters --region $REGION \ - --db-cluster-identifier $CLUSTER_NAME \ - --query '*[*].{DBClusterParameterGroup:DBClusterParameterGroup}' - -echo "Current value for max_connections:" -aws rds describe-db-cluster-parameters --region $REGION \ - --db-cluster-parameter-group-name $CLUSTER_PARAM_GROUP \ - --query '*[*].{ParameterName:ParameterName,ParameterValue:ParameterValue}' \ - --output text | grep "^max_connections" - -echo -n "Enter number for max_connections setting: " -read answer - -aws rds modify-db-cluster-parameter-group --region $REGION --db-cluster-parameter-group-name $CLUSTER_PARAM_GROUP \ - --parameters "ParameterName=max_connections,ParameterValue=$$answer,ApplyMethod=immediate" - -echo "Updated value for max_connections:" -aws rds describe-db-cluster-parameters --region $REGION \ - --db-cluster-parameter-group-name $CLUSTER_PARAM_GROUP \ - --query '*[*].{ParameterName:ParameterName,ParameterValue:ParameterValue}' \ - --output text | grep "^max_connections" -``` \ No newline at end of file diff --git a/doc_source/rds-proxy.howitworks.md b/doc_source/rds-proxy.howitworks.md deleted file mode 100644 index cc5fa4b..0000000 --- a/doc_source/rds-proxy.howitworks.md +++ /dev/null @@ -1,118 +0,0 @@ -# RDS Proxy concepts and terminology - - You can simplify connection management for your Amazon RDS DB instances and Amazon Aurora DB clusters by using RDS Proxy\. - - RDS Proxy handles the network traffic between the client application and the database\. It does so in an active way first by understanding the database protocol\. It then adjusts its behavior based on the SQL operations from your application and the result sets from the database\. - - RDS Proxy reduces the memory and CPU overhead for connection management on your database\. The database needs less memory and CPU resources when applications open many simultaneous connections\. It also doesn't require logic in your applications to close and reopen connections that stay idle for a long time\. Similarly, it requires less application logic to reestablish connections in case of a database problem\. - - The infrastructure for RDS Proxy is highly available and deployed over multiple Availability Zones \(AZs\)\. The computation, memory, and storage for RDS Proxy are independent of your RDS DB instances and Aurora DB clusters\. This separation helps lower overhead on your database servers, so that they can devote their resources to serving database workloads\. The RDS Proxy compute resources are serverless, automatically scaling based on your database workload\. - -**Topics** -+ [Overview of RDS Proxy concepts](#rds-proxy-overview) -+ [Connection pooling](#rds-proxy-connection-pooling) -+ [RDS Proxy security](#rds-proxy-security) -+ [Failover](#rds-proxy-failover) -+ [Transactions](#rds-proxy-transactions) - -## Overview of RDS Proxy concepts - - RDS Proxy handles the infrastructure to perform connection pooling and the other features described in the sections that follow\. You see the proxies represented in the RDS console on the **Proxies** page\. - -Each proxy handles connections to a single RDS DB instance or Aurora DB cluster\. The proxy automatically determines the current writer instance for RDS Multi\-AZ DB instances and Aurora provisioned clusters\. - - The connections that a proxy keeps open and available for your database application to use make up the *connection pool*\. - - By default, RDS Proxy can reuse a connection after each transaction in your session\. This transaction\-level reuse is called *multiplexing*\. When RDS Proxy temporarily removes a connection from the connection pool to reuse it, that operation is called *borrowing* the connection\. When it's safe to do so, RDS Proxy returns that connection to the connection pool\. - - In some cases, RDS Proxy can't be sure that it's safe to reuse a database connection outside of the current session\. In these cases, it keeps the session on the same connection until the session ends\. This fallback behavior is called *pinning*\. - - A proxy has a default endpoint\. You connect to this endpoint when you work with an RDS DB instance or Aurora DB cluster\. You do so instead of connecting to the read/write endpoint that connects directly to the instance or cluster\. The special\-purpose endpoints for an Aurora cluster remain available for you to use\. For Aurora DB clusters, you can also create additional read/write and read\-only endpoints\. For more information, see [Overview of proxy endpoints](rds-proxy-endpoints.md#rds-proxy-endpoints-overview)\. - - For example, you can still connect to the cluster endpoint for read/write connections without connection pooling\. You can still connect to the reader endpoint for load\-balanced read\-only connections\. You can still connect to the instance endpoints for diagnosis and troubleshooting of specific DB instances within an Aurora cluster\. If you use other AWS services such as AWS Lambda to connect to RDS databases, change their connection settings to use the proxy endpoint\. For example, you specify the proxy endpoint to allow Lambda functions to access your database while taking advantage of RDS Proxy functionality\. - - Each proxy contains a target group\. This *target group* embodies the RDS DB instance or Aurora DB cluster that the proxy can connect to\. For an Aurora cluster, by default the target group is associated with all the DB instances in that cluster\. That way, the proxy can connect to whichever Aurora DB instance is promoted to be the writer instance in the cluster\. The RDS DB instance associated with a proxy, or the Aurora DB cluster and its instances, are called the *targets* of that proxy\. For convenience, when you create a proxy through the console, RDS Proxy also creates the corresponding target group and registers the associated targets automatically\. - - An *engine family* is a related set of database engines that use the same DB protocol\. You choose the engine family for each proxy that you create\. - -## Connection pooling - - Each proxy performs connection pooling for the writer instance of its associated RDS or Aurora database\. *Connection pooling* is an optimization that reduces the overhead associated with opening and closing connections and with keeping many connections open simultaneously\. This overhead includes memory needed to handle each new connection\. It also involves CPU overhead to close each connection and open a new one\. Examples include Transport Layer Security/Secure Sockets Layer \(TLS/SSL\) handshaking, authentication, negotiating capabilities, and so on\. Connection pooling simplifies your application logic\. You don't need to write application code to minimize the number of simultaneous open connections\. - - Each proxy also performs connection multiplexing, also known as connection reuse\. With *multiplexing*, RDS Proxy performs all the operations for a transaction using one underlying database connection\. RDS then can use a different connection for the next transaction\. You can open many simultaneous connections to the proxy, and the proxy keeps a smaller number of connections open to the DB instance or cluster\. Doing so further minimizes the memory overhead for connections on the database server\. This technique also reduces the chance of "too many connections" errors\. - -## RDS Proxy security - - RDS Proxy uses the existing RDS security mechanisms such as TLS/SSL and AWS Identity and Access Management \(IAM\)\. For general information about those security features, see [Security in Amazon RDS](UsingWithRDS.md)\. Also, make sure to familiarize yourself with how RDS and Aurora work with authentication, authorization, and other areas of security\. - - RDS Proxy can act as an additional layer of security between client applications and the underlying database\. For example, you can connect to the proxy using TLS 1\.2, even if the underlying DB instance supports only TLS 1\.0 or 1\.1\. You can connect to the proxy using an IAM role\. This is so even if the proxy connects to the database using the native user and password authentication method\. By using this technique, you can enforce strong authentication requirements for database applications without a costly migration effort for the DB instances themselves\. - - You store the database credentials used by RDS Proxy in AWS Secrets Manager\. Each database user for the RDS DB instance or Aurora DB cluster accessed by a proxy must have a corresponding secret in Secrets Manager\. You can also set up IAM authentication for users of RDS Proxy\. By doing so, you can enforce IAM authentication for database access even if the databases use native password authentication\. We recommend using these security features instead of embedding database credentials in your application code\. - -### Using TLS/SSL with RDS Proxy - - You can connect to RDS Proxy using the TLS/SSL protocol\. - -**Note** - RDS Proxy uses certificates from the AWS Certificate Manager \(ACM\)\. If you are using RDS Proxy, you don't need to download Amazon RDS certificates or update applications that use RDS Proxy connections\. - - To enforce TLS for all connections between the proxy and your database, you can specify a setting **Require Transport Layer Security** when you create or modify a proxy\. - - RDS Proxy can also ensure that your session uses TLS/SSL between your client and the RDS Proxy endpoint\. To have RDS Proxy do so, specify the requirement on the client side\. SSL session variables are not set for SSL connections to a database using RDS Proxy\. -+ For RDS for MySQL and Aurora MySQL, specify the requirement on the client side with the `--ssl-mode` parameter when you run the `mysql` command\. -+ For Amazon RDS PostgreSQL and Aurora PostgreSQL, specify `sslmode=require` as part of the `conninfo` string when you run the `psql` command\. - - RDS Proxy supports TLS protocol version 1\.0, 1\.1, and 1\.2\. You can connect to the proxy using a higher version of TLS than you use in the underlying database\. - - By default, client programs establish an encrypted connection with RDS Proxy, with further control available through the `--ssl-mode` option\. From the client side, RDS Proxy supports all SSL modes\. - - For the client, the SSL modes are the following: - -**PREFERRED** - SSL is the first choice, but it isn't required\. - -**DISABLED** - No SSL is allowed\. - -**REQUIRED** - Enforce SSL\. - -**VERIFY\_CA** - Enforce SSL and verify the certificate authority \(CA\)\. - -**VERIFY\_IDENTITY** - Enforce SSL and verify the CA and CA hostname\. - - When using a client with `--ssl-mode` `VERIFY_CA` or `VERIFY_IDENTITY`, specify the `--ssl-ca` option pointing to a CA in `.pem` format\. For the `.pem` file to use, download all root CA PEMs from [Amazon Trust Services ](https://www.amazontrust.com/repository/) and place them into a single `.pem` file\. - - RDS Proxy uses wildcard certificates, which apply to a both a domain and its subdomains\. If you use the `mysql` client to connect with SSL mode `VERIFY_IDENTITY`, currently you must use the MySQL 8\.0\-compatible `mysql` command\. - -## Failover - - *Failover* is a high\-availability feature that replaces a database instance with another one when the original instance becomes unavailable\. A failover might happen because of a problem with a database instance\. It might also be part of normal maintenance procedures, such as during a database upgrade\. Failover applies to RDS DB instances in a Multi\-AZ configuration\. Failover applies to Aurora DB clusters with one or more reader instances in addition to the writer instance\. - - Connecting through a proxy makes your application more resilient to database failovers\. When the original DB instance becomes unavailable, RDS Proxy connects to the standby database without dropping idle application connections\. Doing so helps to speed up and simplify the failover process\. The result is faster failover that's less disruptive to your application than a typical reboot or database problem\. - - Without RDS Proxy, a failover involves a brief outage\. During the outage, you can't perform write operations on that database\. Any existing database connections are disrupted, and your application must reopen them\. The database becomes available for new connections and write operations when a read\-only DB instance is promoted in place of one that's unavailable\. - - During DB failovers, RDS Proxy continues to accept connections at the same IP address and automatically directs connections to the new primary DB instance\. Clients connecting through RDS Proxy are not susceptible to the following: -+ Domain Name System \(DNS\) propagation delays on failover\. -+ Local DNS caching\. -+ Connection timeouts\. -+ Uncertainty about which DB instance is the current writer\. -+ Waiting for a query response from a former writer that became unavailable without closing connections\. - - For applications that maintain their own connection pool, going through RDS Proxy means that most connections stay alive during failovers or other disruptions\. Only connections that are in the middle of a transaction or SQL statement are canceled\. RDS Proxy immediately accepts new connections\. When the database writer is unavailable, RDS Proxy queues up incoming requests\. - - For applications that don't maintain their own connection pools, RDS Proxy offers faster connection rates and more open connections\. It offloads the expensive overhead of frequent reconnects from the database\. It does so by reusing database connections maintained in the RDS Proxy connection pool\. This approach is particularly important for TLS connections, where setup costs are significant\. - -## Transactions - - All the statements within a single transaction always use the same underlying database connection\. The connection becomes available for use by a different session when the transaction ends\. Using the transaction as the unit of granularity has the following consequences: -+ Connection reuse can happen after each individual statement when the RDS for MySQL or Aurora MySQL `autocommit` setting is turned on\. -+ Conversely, when the `autocommit` setting is turned off, the first statement you issue in a session begins a new transaction\. For example, suppose that you enter a sequence of `SELECT`, `INSERT`, `UPDATE`, and other data manipulation language \(DML\) statements\. In this case, connection reuse doesn't happen until you issue a `COMMIT`, `ROLLBACK`, or otherwise end the transaction\. -+ Entering a data definition language \(DDL\) statement causes the transaction to end after that statement completes\. - - RDS Proxy detects when a transaction ends through the network protocol used by the database client application\. Transaction detection doesn't rely on keywords such as `COMMIT` or `ROLLBACK` appearing in the text of the SQL statement\. - - In some cases, RDS Proxy might detect a database request that makes it impractical to move your session to a different connection\. In these cases, it turns off multiplexing for that connection the remainder of your session\. The same rule applies if RDS Proxy can't be certain that multiplexing is practical for the session\. This operation is called *pinning*\. For ways to detect and minimize pinning, see [Avoiding pinning](rds-proxy-managing.md#rds-proxy-pinning)\. \ No newline at end of file diff --git a/doc_source/rds-proxy.md b/doc_source/rds-proxy.md deleted file mode 100644 index e0c228f..0000000 --- a/doc_source/rds-proxy.md +++ /dev/null @@ -1,100 +0,0 @@ -# Using Amazon RDS Proxy - - By using Amazon RDS Proxy, you can allow your applications to pool and share database connections to improve their ability to scale\. RDS Proxy makes applications more resilient to database failures by automatically connecting to a standby DB instance while preserving application connections\. By using RDS Proxy, you can also enforce AWS Identity and Access Management \(IAM\) authentication for databases, and securely store credentials in AWS Secrets Manager\. - - Using RDS Proxy, you can handle unpredictable surges in database traffic\. Otherwise, these surges might cause issues due to oversubscribing connections or creating new connections at a fast rate\. RDS Proxy establishes a database connection pool and reuses connections in this pool\. This approach avoids the memory and CPU overhead of opening a new database connection each time\. To protect the database against oversubscription, you can control the number of database connections that are created\. - - RDS Proxy queues or throttles application connections that can't be served immediately from the pool of connections\. Although latencies might increase, your application can continue to scale without abruptly failing or overwhelming the database\. If connection requests exceed the limits you specify, RDS Proxy rejects application connections \(that is, it sheds load\)\. At the same time, it maintains predictable performance for the load that can be served with the available capacity\. - - You can reduce the overhead to process credentials and establish a secure connection for each new connection\. RDS Proxy can handle some of that work on behalf of the database\. - - RDS Proxy is fully compatible with the engine versions that it supports\. You can enable RDS Proxy for most applications with no code changes\. - -**Topics** -+ [Region and version availability](#rds-proxy.RegionVersionAvailability) -+ [Quotas and limitations for RDS Proxy](#rds-proxy.limitations) -+ [Planning where to use RDS Proxy](rds-proxy-planning.md) -+ [RDS Proxy concepts and terminology](rds-proxy.howitworks.md) -+ [Getting started with RDS Proxy](rds-proxy-setup.md) -+ [Managing an RDS Proxy](rds-proxy-managing.md) -+ [Working with Amazon RDS Proxy endpoints](rds-proxy-endpoints.md) -+ [Monitoring RDS Proxy metrics with Amazon CloudWatch](rds-proxy.monitoring.md) -+ [Working with RDS Proxy events](rds-proxy.events.md) -+ [RDS Proxy command\-line examples](rds-proxy.examples.md) -+ [Troubleshooting for RDS Proxy](rds-proxy.troubleshooting.md) -+ [Using RDS Proxy with AWS CloudFormation](rds-proxy-cfn.md) - -## Region and version availability - -Feature availability and support varies across specific versions of each database engine, and across AWS Regions\. For more information on version and Region availability of Amazon RDS with RDS Proxy, see [Amazon RDS Proxy](Concepts.RDS_Fea_Regions_DB-eng.Feature.RDSProxy.md)\. - -## Quotas and limitations for RDS Proxy - - The following quotas and limitations apply to RDS Proxy: -+ You can have up to 20 proxies for each AWS account ID\. If your application requires more proxies, you can request additional proxies by opening a ticket with the AWS Support organization\. -+ Each proxy can have up to 200 associated Secrets Manager secrets\. Thus, each proxy can connect to with up to 200 different user accounts at any given time\. -+ You can create, view, modify, and delete up to 20 endpoints for each proxy\. These endpoints are in addition to the default endpoint that's automatically created for each proxy\. -+ For RDS DB instances in replication configurations, you can associate a proxy only with the writer DB instance, not a read replica\. -+ Your RDS Proxy must be in the same virtual private cloud \(VPC\) as the database\. The proxy can't be publicly accessible, although the database can be\. For example, if you're prototyping on a local host, you can't connect to your RDS Proxy unless you set up dedicated networking\. This is the case because your local host is outside of the proxy's VPC\. -+ You can't use RDS Proxy with a VPC that has its tenancy set to `dedicated`\. -+ If you use RDS Proxy with an RDS DB instance that has IAM authentication enabled, check user authentication\. Users who connect through a proxy must authenticate through sign\-in credentials\. For details about Secrets Manager and IAM support in RDS Proxy, see [Setting up database credentials in AWS Secrets Manager](rds-proxy-setup.md#rds-proxy-secrets-arns) and [Setting up AWS Identity and Access Management \(IAM\) policies](rds-proxy-setup.md#rds-proxy-iam-setup)\. -+ You can't use RDS Proxy with custom DNS when using SSL hostname validation\. -+ Each proxy can be associated with a single target DB instance \. However, you can associate multiple proxies with the same DB instance \. -+ Any statement with a text size greater than 16 KB causes the proxy to pin the session to the current connection\. - -For additional limitations for each DB engine, see the following sections: -+ [Additional limitations for RDS for MariaDB](#rds-proxy.limitations-mdb) -+ [Additional limitations for RDS for Microsoft SQL Server](#rds-proxy.limitations-ms) -+ [Additional limitations for RDS for MySQL](#rds-proxy.limitations-my) -+ [Additional limitations for RDS for PostgreSQL](#rds-proxy.limitations-pg) - -### Additional limitations for RDS for MariaDB - - The following additional limitations apply to RDS Proxy with RDS for MariaDB databases: -+ Currently, all proxies listen on port 3306 for MariaDB\. The proxies still connect to your database using the port that you specified in the database settings\. -+ You can't use RDS Proxy with self\-managed MariaDB databases in Amazon EC2 instances\. -+ You can't use RDS Proxy with an RDS for MariaDB DB instance that has the `read_only` parameter in its DB parameter group set to `1`\. -+ RDS Proxy doesn't support compressed mode\. For example, it doesn't support the compression used by the `--compress` or `-C` options of the `mysql` command\. -+ Some SQL statements and functions can change the connection state without causing pinning\. For the most current pinning behavior, see [Avoiding pinning](rds-proxy-managing.md#rds-proxy-pinning)\. -+ RDS Proxy doesn't support the MariaDB `auth_ed25519` plugin\. -+ RDS Proxy doesn't support Transport Layer Security \(TLS\) version 1\.3 for MariaDB databases\. - -**Important** - For proxies associated with MariaDB databases, don't set the configuration parameter `sql_auto_is_null` to `true` or a nonzero value in the initialization query\. Doing so might cause incorrect application behavior\. - -### Additional limitations for RDS for Microsoft SQL Server - - The following additional limitations apply to RDS Proxy with RDS for Microsoft SQL Server databases: -+ The number of Secrets Manager secrets that you need to create for a proxy depends on the collation that your DB instance uses\. For example, suppose that your DB instance uses case\-sensitive collation\. If your application accepts both "Admin" and "admin," then your proxy needs two separate secrets\. For more information about collation in SQL Server, see the [ Microsoft SQL Server](https://docs.microsoft.com/en-us/sql/relational-databases/collations/collation-and-unicode-support?view=sql-server-ver16) documentation\. -+ RDS Proxy doesn't support connections that use Active Directory\. -+ You can't use IAM authentication with clients that don't support token properties\. For more information, see [Considerations for connecting to a proxy with Microsoft SQL Server](rds-proxy-setup.md#rds-proxy-connecting-sqlserver)\. -+ The results of `@@IDENTITY`, `@@ROWCOUNT`, and `SCOPE_IDENTITY` aren't always accurate\. As a work\-around, retrieve their values in the same session statement to ensure that they return the correct information\. -+ If the connection uses multiple active result sets \(MARS\), RDS Proxy doesn't run the initialization queries\. For information about MARS, see the [ Microsoft SQL Server](https://docs.microsoft.com/en-us/sql/relational-databases/native-client/features/using-multiple-active-result-sets-mars?view=sql-server-ver16) documentation\. - -### Additional limitations for RDS for MySQL - - The following additional limitations apply to RDS Proxy with RDS for MySQL databases: -+ RDS Proxy doesn't support the MySQL `sha256_password` and `caching_sha2_password` authentication plugins\. These plugins implement SHA\-256 hashing for user account passwords\. -+ Currently, all proxies listen on port 3306 for MySQL\. The proxies still connect to your database using the port that you specified in the database settings\. -+ You can't use RDS Proxy with self\-managed MySQL databases in EC2 instances\. -+ You can't use RDS Proxy with an RDS for MySQL DB instance that has the `read_only` parameter in its DB parameter group set to `1`\. -+ RDS Proxy doesn't support MySQL compressed mode\. For example, it doesn't support the compression used by the `--compress` or `-C` options of the `mysql` command\. -+ Some SQL statements and functions such as `SET LOCAL`can change the connection state without causing pinning\. For the most current pinning behavior, see [Avoiding pinning](rds-proxy-managing.md#rds-proxy-pinning)\. - -**Important** - For proxies associated with MySQL databases, don't set the configuration parameter `sql_auto_is_null` to `true` or a nonzero value in the initialization query\. Doing so might cause incorrect application behavior\. - -### Additional limitations for RDS for PostgreSQL - - The following additional limitations apply to RDS Proxy with RDS for PostgreSQL databases: -+ RDS Proxy doesn't support session pinning filters for PostgreSQL\. -+ Currently, all proxies listen on port 5432 for PostgreSQL\. -+ For PostgreSQL, RDS Proxy doesn't currently support canceling a query from a client by issuing a `CancelRequest`\. This is the case, for example, when you cancel a long\-running query in an interactive psql session by using Ctrl\+C\. -+ The results of the PostgreSQL function [lastval](https://www.postgresql.org/docs/current/functions-sequence.html) aren't always accurate\. As a work\-around, use the [INSERT](https://www.postgresql.org/docs/current/sql-insert.html) statement with the `RETURNING` clause\. -+ RDS Proxy doesn't multiplex connections when your client application drivers use the PostgreSQL extended query protocol\. -+ RDS Proxy currently doesn't support streaming replication mode\. - -**Important** -For existing proxies with PostgreSQL databases, if you modify the database authentication to use `SCRAM` only, the proxy becomes unavailable for up to 60 seconds\. To avoid the issue, do one of the following: -Ensure that the database allows both `SCRAM` and `MD5` authentication\. -To use only `SCRAM` authentication, create a new proxy, migrate your application traffic to the new proxy, then delete the proxy previously associated with the database\. \ No newline at end of file diff --git a/doc_source/rds-proxy.monitoring.md b/doc_source/rds-proxy.monitoring.md deleted file mode 100644 index 46355d1..0000000 --- a/doc_source/rds-proxy.monitoring.md +++ /dev/null @@ -1,53 +0,0 @@ -# Monitoring RDS Proxy metrics with Amazon CloudWatch - - You can monitor RDS Proxy by using Amazon CloudWatch\. CloudWatch collects and processes raw data from the proxies into readable, near\-real\-time metrics\. To find these metrics in the CloudWatch console, choose **Metrics**, then choose **RDS**, and choose **Per\-Proxy Metrics**\. For more information, see [Using Amazon CloudWatch metrics](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/working_with_metrics.html) in the Amazon CloudWatch User Guide\. - -**Note** - RDS publishes these metrics for each underlying Amazon EC2 instance associated with a proxy\. A single proxy might be served by more than one EC2 instance\. Use CloudWatch statistics to aggregate the values for a proxy across all the associated instances\. - Some of these metrics might not be visible until after the first successful connection by a proxy\. - - In the RDS Proxy logs, each entry is prefixed with the name of the associated proxy endpoint\. This name can be the name you specified for a user\-defined endpoint, or the special name `default` for read/write requests using the default endpoint of a proxy\. - - All RDS Proxy metrics are in the group `proxy`\. - - Each proxy endpoint has its own CloudWatch metrics\. You can monitor the usage of each proxy endpoint independently\. For more information about proxy endpoints, see [Working with Amazon RDS Proxy endpoints](rds-proxy-endpoints.md)\. - - You can aggregate the values for each metric using one of the following dimension sets\. For example, by using the `ProxyName` dimension set, you can analyze all the traffic for a particular proxy\. By using the other dimension sets, you can split the metrics in different ways\. You can split the metrics based on the different endpoints or target databases of each proxy, or the read/write and read\-only traffic to each database\. -+ Dimension set 1: `ProxyName` -+ Dimension set 2: `ProxyName`, `EndpointName` -+ Dimension set 3: `ProxyName`, `TargetGroup`, `Target` -+ Dimension set 4: `ProxyName`, `TargetGroup`, `TargetRole` - - -| Metric | Description | Valid period | CloudWatch dimension set | -| --- | --- | --- | --- | -| `AvailabilityPercentage` | The percentage of time for which the target group was available in the role indicated by the dimension\. This metric is reported every minute\. The most useful statistic for this metric is `Average`\. | 1 minute | [Dimension set 4](#proxy-dimension-set-4) | -| ClientConnections | The current number of client connections\. This metric is reported every minute\. The most useful statistic for this metric is `Sum`\. | 1 minute | [Dimension set 1](#proxy-dimension-set-1), [Dimension set 2](#proxy-dimension-set-2) | -| ClientConnectionsClosed | The number of client connections closed\. The most useful statistic for this metric is `Sum`\. | 1 minute and above | [Dimension set 1](#proxy-dimension-set-1), [Dimension set 2](#proxy-dimension-set-2) | -| `ClientConnectionsNoTLS` | The current number of client connections without Transport Layer Security \(TLS\)\. This metric is reported every minute\. The most useful statistic for this metric is Sum\. | 1 minute and above | [Dimension set 1](#proxy-dimension-set-1), [Dimension set 2](#proxy-dimension-set-2) | -| `ClientConnectionsReceived` | The number of client connection requests received\. The most useful statistic for this metric is `Sum`\. | 1 minute and above | [Dimension set 1](#proxy-dimension-set-1), [Dimension set 2](#proxy-dimension-set-2) | -| ClientConnectionsSetupFailedAuth | The number of client connection attempts that failed due to misconfigured authentication or TLS\. The most useful statistic for this metric is `Sum`\. | 1 minute and above | [Dimension set 1](#proxy-dimension-set-1), [Dimension set 2](#proxy-dimension-set-2) | -| ClientConnectionsSetupSucceeded | The number of client connections successfully established with any authentication mechanism with or without TLS\. The most useful statistic for this metric is `Sum`\. | 1 minute and above | [Dimension set 1](#proxy-dimension-set-1), [Dimension set 2](#proxy-dimension-set-2) | -| ClientConnectionsTLS | The current number of client connections with TLS\. This metric is reported every minute\. The most useful statistic for this metric is Sum\. | 1 minute and above | [Dimension set 1](#proxy-dimension-set-1), [Dimension set 2](#proxy-dimension-set-2) | -| DatabaseConnectionRequests | The number of requests to create a database connection\. The most useful statistic for this metric is `Sum`\. | 1 minute and above | [Dimension set 1](#proxy-dimension-set-1), [Dimension set 3](#proxy-dimension-set-3), [Dimension set 4](#proxy-dimension-set-4) | -| `DatabaseConnectionRequestsWithTLS` | The number of requests to create a database connection with TLS\. The most useful statistic for this metric is Sum\. | 1 minute and above | [Dimension set 1](#proxy-dimension-set-1), [Dimension set 3](#proxy-dimension-set-3), [Dimension set 4](#proxy-dimension-set-4) | -| DatabaseConnections | The current number of database connections\. This metric is reported every minute\. The most useful statistic for this metric is `Sum`\. | 1 minute | [Dimension set 1](#proxy-dimension-set-1), [Dimension set 3](#proxy-dimension-set-3), [Dimension set 4](#proxy-dimension-set-4) | -| `DatabaseConnectionsBorrowLatency` | The time in microseconds that it takes for the proxy being monitored to get a database connection\. The most useful statistic for this metric is Average\. | 1 minute and above | [Dimension set 1](#proxy-dimension-set-1), [Dimension set 2](#proxy-dimension-set-2) | -| DatabaseConnectionsCurrentlyBorrowed | The current number of database connections in the borrow state\. This metric is reported every minute\. The most useful statistic for this metric is `Sum`\. | 1 minute | [Dimension set 1](#proxy-dimension-set-1), [Dimension set 3](#proxy-dimension-set-3), [Dimension set 4](#proxy-dimension-set-4) | -| DatabaseConnectionsCurrentlyInTransaction | The current number of database connections in a transaction\. This metric is reported every minute\. The most useful statistic for this metric is `Sum`\. | 1 minute | [Dimension set 1](#proxy-dimension-set-1), [Dimension set 3](#proxy-dimension-set-3), [Dimension set 4](#proxy-dimension-set-4) | -| DatabaseConnectionsCurrentlySessionPinned | The current number of database connections currently pinned because of operations in client requests that change session state\. This metric is reported every minute\. The most useful statistic for this metric is `Sum`\. | 1 minute | [Dimension set 1](#proxy-dimension-set-1), [Dimension set 3](#proxy-dimension-set-3), [Dimension set 4](#proxy-dimension-set-4) | -| DatabaseConnectionsSetupFailed | The number of database connection requests that failed\. The most useful statistic for this metric is `Sum`\. | 1 minute and above | [Dimension set 1](#proxy-dimension-set-1), [Dimension set 3](#proxy-dimension-set-3), [Dimension set 4](#proxy-dimension-set-4) | -| DatabaseConnectionsSetupSucceeded | The number of database connections successfully established with or without TLS\. The most useful statistic for this metric is `Sum`\. | 1 minute and above | [Dimension set 1](#proxy-dimension-set-1), [Dimension set 3](#proxy-dimension-set-3), [Dimension set 4](#proxy-dimension-set-4) | -| `DatabaseConnectionsWithTLS` | The current number of database connections with TLS\. This metric is reported every minute\. The most useful statistic for this metric is Sum\. | 1 minute | [Dimension set 1](#proxy-dimension-set-1), [Dimension set 3](#proxy-dimension-set-3), [Dimension set 4](#proxy-dimension-set-4) | -| MaxDatabaseConnectionsAllowed | The maximum number of database connections allowed\. This metric is reported every minute\. The most useful statistic for this metric is `Sum`\. | 1 minute | [Dimension set 1](#proxy-dimension-set-1), [Dimension set 3](#proxy-dimension-set-3), [Dimension set 4](#proxy-dimension-set-4) | -| `QueryDatabaseResponseLatency` | The time in microseconds that the database took to respond to the query\. The most useful statistic for this metric is Average\. | 1 minute and above | [Dimension set 1](#proxy-dimension-set-1), [Dimension set 2](#proxy-dimension-set-2), [Dimension set 3](#proxy-dimension-set-3), [Dimension set 4](#proxy-dimension-set-4) | -| QueryRequests | The number of queries received\. A query including multiple statements is counted as one query\. The most useful statistic for this metric is `Sum`\. | 1 minute and above | [Dimension set 1](#proxy-dimension-set-1), [Dimension set 2](#proxy-dimension-set-2) | -| QueryRequestsNoTLS | The number of queries received from non\-TLS connections\. A query including multiple statements is counted as one query\. The most useful statistic for this metric is Sum\. | 1 minute and above | [Dimension set 1](#proxy-dimension-set-1), [Dimension set 2](#proxy-dimension-set-2) | -| `QueryRequestsTLS` | The number of queries received from TLS connections\. A query including multiple statements is counted as one query\. The most useful statistic for this metric is Sum\. | 1 minute and above | [Dimension set 1](#proxy-dimension-set-1), [Dimension set 2](#proxy-dimension-set-2) | -| QueryResponseLatency | The time in microseconds between getting a query request and the proxy responding to it\. The most useful statistic for this metric is Average\. | 1 minute and above | [Dimension set 1](#proxy-dimension-set-1), [Dimension set 2](#proxy-dimension-set-2) | - - You can find logs of RDS Proxy activity under CloudWatch in the AWS Management Console\. Each proxy has an entry in the **Log groups** page\. - -**Important** - These logs are intended for human consumption for troubleshooting purposes and not for programmatic access\. The format and content of the logs is subject to change\. - In particular, older logs don't contain any prefixes indicating the endpoint for each request\. In newer logs, each entry is prefixed with the name of the associated proxy endpoint\. This name can be the name that you specified for a user\-defined endpoint, or the special name `default` for requests using the default endpoint of a proxy\. \ No newline at end of file diff --git a/doc_source/rds-proxy.troubleshooting.md b/doc_source/rds-proxy.troubleshooting.md deleted file mode 100644 index 73b05ea..0000000 --- a/doc_source/rds-proxy.troubleshooting.md +++ /dev/null @@ -1,128 +0,0 @@ -# Troubleshooting for RDS Proxy - - Following, you can find troubleshooting ideas for some common RDS Proxy issues and information on CloudWatch logs for RDS Proxy\. - - In the RDS Proxy logs, each entry is prefixed with the name of the associated proxy endpoint\. This name can be the name that you specified for a user\-defined endpoint\. Or it can be the special name `default` for read/write requests using the default endpoint of a proxy\. For more information about proxy endpoints, see [Working with Amazon RDS Proxy endpoints](rds-proxy-endpoints.md)\. - -**Topics** -+ [Verifying connectivity for a proxy](#rds-proxy-verifying) -+ [Common issues and solutions](#rds-proxy-diagnosis) - -## Verifying connectivity for a proxy - - You can use the following commands to verify that all components of the connection mechanism can communicate with the other components\. - - Examine the proxy itself using the [describe\-db\-proxies](https://docs.aws.amazon.com/cli/latest/reference/rds/describe-db-proxies.html) command\. Also examine the associated target group using the [describe\-db\-proxy\-target\-groups](https://docs.aws.amazon.com/cli/latest/reference/rds/describe-db-proxy-target-groups.html) command\. Check that the details of the targets match the RDS DB instance or Aurora DB cluster that you intend to associate with the proxy\. Use commands such as the following\. - -``` -aws rds describe-db-proxies --db-proxy-name $DB_PROXY_NAME -aws rds describe-db-proxy-target-groups --db-proxy-name $DB_PROXY_NAME -``` - - To confirm that the proxy can connect to the underlying database, examine the targets specified in the target groups using the [describe\-db\-proxy\-targets](https://docs.aws.amazon.com/cli/latest/reference/rds/describe-db-proxy-targets.html) command\. Use a command such as the following\. - -``` -aws rds describe-db-proxy-targets --db-proxy-name $DB_PROXY_NAME -``` - - The output of the [describe\-db\-proxy\-targets](https://docs.aws.amazon.com/cli/latest/reference/rds/describe-db-proxy-targets.html) command includes a `TargetHealth` field\. You can examine the fields `State`, `Reason`, and `Description` inside `TargetHealth` to check if the proxy can communicate with the underlying DB instance\. -+ A `State` value of `AVAILABLE` indicates that the proxy can connect to the DB instance\. -+ A `State` value of `UNAVAILABLE` indicates a temporary or permanent connection problem\. In this case, examine the `Reason` and `Description` fields\. For example, if `Reason` has a value of `PENDING_PROXY_CAPACITY`, try connecting again after the proxy finishes its scaling operation\. If `Reason` has a value of `UNREACHABLE`, `CONNECTION_FAILED`, or `AUTH_FAILURE`, use the explanation from the `Description` field to help you diagnose the issue\. -+ The `State` field might have a value of `REGISTERING` for a brief time before changing to `AVAILABLE` or `UNAVAILABLE`\. - - If the following Netcat command \(`nc`\) is successful, you can access the proxy endpoint from the EC2 instance or other system where you're logged in\. This command reports failure if you're not in the same VPC as the proxy and the associated database\. You might be able to log directly in to the database without being in the same VPC\. However, you can't log into the proxy unless you're in the same VPC\. - -``` -nc -zx MySQL_proxy_endpoint 3306 - -nc -zx PostgreSQL_proxy_endpoint 5432 -``` - - You can use the following commands to make sure that your EC2 instance has the required properties\. In particular, the VPC for the EC2 instance must be the same as the VPC for the RDS DB instance or Aurora DB cluster that the proxy connects to\. - -``` -aws ec2 describe-instances --instance-ids your_ec2_instance_id -``` - - Examine the Secrets Manager secrets used for the proxy\. - -``` -aws secretsmanager list-secrets -aws secretsmanager get-secret-value --secret-id your_secret_id -``` - - Make sure that the `SecretString` field displayed by `get-secret-value` is encoded as a JSON string that includes `username` and `password` fields\. The following example shows the format of the `SecretString` field\. - -``` -{ - "ARN": "some_arn", - "Name": "some_name", - "VersionId": "some_version_id", - "SecretString": '{"username":"some_username","password":"some_password"}', - "VersionStages": [ "some_stage" ], - "CreatedDate": some_timestamp -} -``` - -## Common issues and solutions - -For possible causes and solutions to some common problems that you might encounter using RDS Proxy, see the following\. - -After running `aws rds describe-db-proxy-targets`, if the `TargetHealth` description states `Proxy does not have any registered credentials`, verify the following: -+ There are credentials registered for the user to access the proxy\. -+ The IAM role to access the proxy secret from Secrets Manager is valid\. -+ The DB proxy is using an authentication method\. - -You might encounter the following RDS events while creating or connecting to a DB proxy\. - - -| Category | RDS event ID | Description | -| --- | --- | --- | -| failure | RDS\-EVENT\-0243 | RDS couldn't provision capacity for the proxy because there aren't enough IP addresses available in your subnets\. To fix the issue, make sure that your subnets have the minimum number of unused IP addresses\. To determine the recommended number for your instance class, see [Planning for IP address capacity](rds-proxy-setup.md#rds-proxy-network-prereqs.plan-ip-address)\. | -| failure | RDS\-EVENT\-0275 | RDS throttled some connections to DB proxy \(RDS Proxy\)\. | - - You might encounter the following issues while creating a new proxy or connecting to a proxy\. - - -| Error | Causes or workarounds | -| --- | --- | -| `403: The security token included in the request is invalid` | Select an existing IAM role instead of choosing to create a new one\. | - - You might encounter the following issues while connecting to a MySQL proxy\. - - -| Error | Causes or workarounds | -| --- | --- | -| ERROR 1040 \(HY000\): Connections rate limit exceeded \(limit\_value\) | The rate of connection requests from the client to the proxy has exceeded the limit\. | -| ERROR 1040 \(HY000\): IAM authentication rate limit exceeded | The number of simultaneous requests with IAM authentication from the client to the proxy has exceeded the limit\. | -| ERROR 1040 \(HY000\): Number simultaneous connections exceeded \(limit\_value\) | The number of simultaneous connection requests from the client to the proxy exceeded the limit\. | -| `ERROR 1045 (28000): Access denied for user 'DB_USER'@'%' (using password: YES)` | Some possible reasons include the following: [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/rds-proxy.troubleshooting.html) | -| ERROR 1105 \(HY000\): Unknown error | An unknown error occurred\. | -| ERROR 1231 \(42000\): Variable ''character\_set\_client'' can't be set to the value of value | The value set for the `character_set_client` parameter is not valid\. For example, the value `ucs2` is not valid because it can crash the MySQL server\. | -| ERROR 3159 \(HY000\): This RDS Proxy requires TLS connections\. | You enabled the setting **Require Transport Layer Security** in the proxy but your connection included the parameter `ssl-mode=DISABLED` in the MySQL client\. Do either of the following: [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/rds-proxy.troubleshooting.html) | -| ERROR 2026 \(HY000\): SSL connection error: Internal Server Error | The TLS handshake to the proxy failed\. Some possible reasons include the following: [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/rds-proxy.troubleshooting.html) | -| ERROR 9501 \(HY000\): Timed\-out waiting to acquire database connection | The proxy timed\-out waiting to acquire a database connection\. Some possible reasons include the following: [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/rds-proxy.troubleshooting.html) | - - You might encounter the following issues while connecting to a PostgreSQL proxy\. - - -| Error | Cause | Solution | -| --- | --- | --- | -| `IAM authentication is allowed only with SSL connections.` | The user tried to connect to the database using IAM authentication with the setting `sslmode=disable` in the PostgreSQL client\. | The user needs to connect to the database using the minimum setting of `sslmode=require` in the PostgreSQL client\. For more information, see the [PostgreSQL SSL support](https://www.postgresql.org/docs/current/libpq-ssl.html) documentation\. | -| `This RDS Proxy requires TLS connections.` | The user enabled the option **Require Transport Layer Security** but tried to connect with `sslmode=disable` in the PostgreSQL client\. | To fix this error, do one of the following: [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/rds-proxy.troubleshooting.html) | -| `IAM authentication failed for user user_name. Check the IAM token for this user and try again.` | This error might be due to the following reasons: [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/rds-proxy.troubleshooting.html) | To fix this error, do the following: [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/rds-proxy.troubleshooting.html) | -| `This RDS proxy has no credentials for the role role_name. Check the credentials for this role and try again.` | There is no Secrets Manager secret for this role\. | Add a Secrets Manager secret for this role\. For more information, see [Setting up AWS Identity and Access Management \(IAM\) policies](rds-proxy-setup.md#rds-proxy-iam-setup)\. | -| `RDS supports only IAM, MD5, or SCRAM authentication.` | The database client being used to connect to the proxy is using an authentication mechanism not currently supported by the proxy\. | If you're not using IAM authentication, use the MD5 or SCRAM password authentication\. | -| `A user name is missing from the connection startup packet. Provide a user name for this connection.` | The database client being used to connect to the proxy isn't sending a user name when trying to establish a connection\. | Make sure to define a user name when setting up a connection to the proxy using the PostgreSQL client of your choice\. | -| `Feature not supported: RDS Proxy supports only version 3.0 of the PostgreSQL messaging protocol.` | The PostgreSQL client used to connect to the proxy uses a protocol older than 3\.0\. | Use a newer PostgreSQL client that supports the 3\.0 messaging protocol\. If you're using the PostgreSQL `psql` CLI, use a version greater than or equal to 7\.4\. | -| `Feature not supported: RDS Proxy currently doesn't support streaming replication mode.` | The PostgreSQL client used to connect to the proxy is trying to use the streaming replication mode, which isn't currently supported by RDS Proxy\. | Turn off the streaming replication mode in the PostgreSQL client being used to connect\. | -| `Feature not supported: RDS Proxy currently doesn't support the option option_name.` | Through the startup message, the PostgreSQL client used to connect to the proxy is requesting an option that isn't currently supported by RDS Proxy\. | Turn off the option being shown as not supported from the message above in the PostgreSQL client being used to connect\. | -| `The IAM authentication failed because of too many competing requests.` | The number of simultaneous requests with IAM authentication from the client to the proxy has exceeded the limit\. | Reduce the rate in which connections using IAM authentication from a PostgreSQL client are established\. | -| `The maximum number of client connections to the proxy exceeded number_value.` | The number of simultaneous connection requests from the client to the proxy exceeded the limit\. | Reduce the number of active connections from PostgreSQL clients to this RDS proxy\. | -| `Rate of connection to proxy exceeded number_value.` | The rate of connection requests from the client to the proxy has exceeded the limit\. | Reduce the rate in which connections from a PostgreSQL client are established\. | -| `The password that was provided for the role role_name is wrong.` | The password for this role doesn't match the Secrets Manager secret\. | Check the secret for this role in Secrets Manager to see if the password is the same as what's being used in your PostgreSQL client\. | -| `The IAM authentication failed for the role role_name. Check the IAM token for this role and try again.` | There is a problem with the IAM token used for IAM authentication\. | Generate a new authentication token and use it in a new connection\. | -| `IAM is allowed only with SSL connections.` | A client tried to connect using IAM authentication, but SSL wasn't enabled\. | Enable SSL in the PostgreSQL client\. | -| `Unknown error.` | An unknown error occurred\. | Reach out to AWS Support to investigate the issue\. | -| `Timed-out waiting to acquire database connection.` | The proxy timed\-out waiting to acquire a database connection\. Some possible reasons include the following: [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/rds-proxy.troubleshooting.html) | Possible solutions are the following: [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/rds-proxy.troubleshooting.html) | -| `Request returned an error: database_error.` | The database connection established from the proxy returned an error\. | The solution depends on the specific database error\. One example is: `Request returned an error: database "your-database-name" does not exist`\. This means that the specified database name doesn't exist on the database server\. Or it means that the user name used as a database name \(if a database name isn't specified\) doesn't exist on the server\. | \ No newline at end of file diff --git a/doc_source/rds-secrets-manager.md b/doc_source/rds-secrets-manager.md deleted file mode 100644 index fd16086..0000000 --- a/doc_source/rds-secrets-manager.md +++ /dev/null @@ -1,519 +0,0 @@ -# Password management with Amazon RDS and AWS Secrets Manager - -Amazon RDS integrates with Secrets Manager to manage master user passwords for your DB instances and Multi\-AZ DB clusters\. - -**Topics** -+ [Overview of managing master user passwords with AWS Secrets Manager](#rds-secrets-manager-overview) -+ [Benefits of managing master user passwords with Secrets Manager](#rds-secrets-manager-benefits) -+ [Permissions required for Secrets Manager integration](#rds-secrets-manager-permissions) -+ [Enforcing RDS management of the master user password in AWS Secrets Manager](#rds-secrets-manager-auth) -+ [Managing the master user password for a DB instance with Secrets Manager](#rds-secrets-manager-db-instance) -+ [Managing the master user password for a Multi\-AZ DB cluster with Secrets Manager](#rds-secrets-manager-db-cluster) -+ [Rotating the master user password secret for a DB instance](#rds-secrets-manager-rotate-db-instance) -+ [Rotating the master user password secret for a Multi\-AZ DB cluster](#rds-secrets-manager-rotate-db-cluster) -+ [Viewing the details about a secret for a DB instance](#rds-secrets-manager-view-db-instance) -+ [Viewing the details about a secret for a Multi\-AZ DB cluster](#rds-secrets-manager-view-db-cluster) -+ [Region and version availability](#rds-secrets-manager-availability) -+ [Limitations for Secrets Manager integration with Amazon RDS](#rds-secrets-manager-limitations) - -## Overview of managing master user passwords with AWS Secrets Manager - -With AWS Secrets Manager, you can replace hard\-coded credentials in your code, including database passwords, with an API call to Secrets Manager to retrieve the secret programmatically\. For more information about Secrets Manager, see [AWS Secrets Manager User Guide](https://docs.aws.amazon.com/secretsmanager/latest/userguide/)\. - -You can specify that RDS manages the master user password in Secrets Manager for an Amazon RDS DB instance or Multi\-AZ DB cluster when you perform one of the following operations: -+ Create the DB instance -+ Create the Multi\-AZ DB cluster -+ Modify the DB instance -+ Modify the Multi\-AZ DB cluster -+ Restore the DB instance from Amazon S3 - -When you specify that RDS manages the master user password in Secrets Manager, RDS generates the password and stores it in Secrets Manager\. You can interact directly with the secret to retrieve the credentials for the master user\. You can also specify a customer managed key to encrypt the secret, or use the KMS key that is provided by Secrets Manager\. - -RDS manages the settings for the secret and rotates the secret every seven days by default\. You can modify some of the settings, such as the rotation schedule after the DB instance creation\. If you delete a DB instance that manages a secret in Secrets Manager, the secret and its associated metadata are also deleted\. - -To connect to a DB instance or Multi\-AZ DB cluster with the credentials in a secret, you can retrieve the secret from Secrets Manager\. For more information, see [ Retrieve secrets from AWS Secrets Manager](https://docs.aws.amazon.com/secretsmanager/latest/userguide/retrieving-secrets.html) and [Connect to a SQL database with credentials in an AWS Secrets Manager secret](https://docs.aws.amazon.com/secretsmanager/latest/userguide/retrieving-secrets_jdbc.html) in the *AWS Secrets Manager User Guide*\. - -## Benefits of managing master user passwords with Secrets Manager - -Managing RDS master user passwords with Secrets Manager provides the following benefits: -+ RDS automatically generates database credentials\. -+ RDS automatically stores and manages database credentials in AWS Secrets Manager\. -+ RDS rotates database credentials regularly, without requiring application changes\. -+ Secrets Manager secures database credentials from human access and plain text view\. -+ Secrets Manager allows retrieval of database credentials in secrets for database connections\. -+ Secrets Manager allows fine\-grained control of access to database credentials in secrets using IAM\. -+ You can optionally separate database encryption from credentials encryption with different KMS keys\. -+ You can eliminate manual management and rotation of database credentials\. -+ You can monitor database credentials easily with AWS CloudTrail and Amazon CloudWatch\. - -For more information about the benefits of Secrets Manager, see [AWS Secrets Manager User Guide](https://docs.aws.amazon.com/secretsmanager/latest/userguide/)\. - -## Permissions required for Secrets Manager integration - -Users must have the required permissions to perform operations related to Secrets Manager integration\. You can create IAM policies that grant permissions to perform specific API operations on the specified resources they need\. You can then attach those policies to the IAM permission sets or roles that require those permissions\. For more information, see [Identity and access management for Amazon RDS](UsingWithRDS.IAM.md)\. - -For create, modify, or restore operations, the user who specifies that Amazon RDS manages the master user password in Secrets Manager must have permissions to perform the following operations: -+ `kms:DescribeKey` -+ `secretsmanager:CreateSecret` -+ `secretsmanager:TagResource` - -For create, modify, or restore operations, the user who specifies the customer managed key to encrypt the secret in Secrets Manager must have permissions to perform the following operations: -+ `kms:Decrypt` -+ `kms:GenerateDataKey` -+ `kms:CreateGrant` - -For modify operations, the user who rotates the master user password in Secrets Manager must have permissions to perform the following operation: -+ `secretsmanager:RotateSecret` - -## Enforcing RDS management of the master user password in AWS Secrets Manager - -You can use IAM condition keys to enforce RDS management of the master user password in AWS Secrets Manager\. The following policy doesn't allow users to create or restore DB instances or DB clusters unless the master user password is managed by RDS in Secrets Manager\. - -``` -{ - "Version": "2012-10-17", - "Statement": [ - { - "Effect": "Deny", - "Action": ["rds:CreateDBInstance", "rds:CreateDBCluster", "rds:RestoreDBInstanceFromS3", "rds:RestoreDBClusterFromS3"], - "Resource": "*", - "Condition": { - "Bool": { - "rds:ManageMasterUserPassword": false - } - } - } - ] -} -``` - -**Note** -This policy enforces password management in AWS Secrets Manager at creation\. However, you can still disable Secrets Manager integration and manually set a master password by modifying the instance\. -To prevent this, include `rds:ModifyDBInstance`, `rds:ModifyDBCluster` in the Action block of the policy\. Be aware, this prevents the user from applying any further modifications to existing instances which do not have Secrets Manager integration enabled\. - -For more information about using condition keys in IAM policies, see [Policy condition keys for Amazon RDS](security_iam_service-with-iam.md#UsingWithRDS.IAM.Conditions) and [Example policies: Using condition keys](security_iam_id-based-policy-examples.md#UsingWithRDS.IAM.Conditions.Examples)\. - -## Managing the master user password for a DB instance with Secrets Manager - -You can configure RDS management of the master user password in Secrets Manager when you perform the following actions: -+ [Creating an Amazon RDS DB instance](USER_CreateDBInstance.md) -+ [Modifying an Amazon RDS DB instance](Overview.DBInstance.Modifying.md) -+ [Restoring a backup into a MySQL DB instance](MySQL.Procedural.Importing.md) - -You can use the RDS console, the AWS CLI, or the RDS API to perform these actions\. - -### Console - -Follow the instructions for creating or modifying a DB instance with the RDS console: -+ [Creating a DB instance](USER_CreateDBInstance.md#USER_CreateDBInstance.Creating) -+ [Modifying an Amazon RDS DB instance](Overview.DBInstance.Modifying.md) -+ [Importing data from Amazon S3 to a new MySQL DB instance](MySQL.Procedural.Importing.md#MySQL.Procedural.Importing.PerformingImport) - -When you use the RDS console to perform one of these operations, you can specify that the master user password is managed by RDS in Secrets Manager\. To do so when you are creating or restoring a DB instance, select **Manage master credentials in AWS Secrets Manager** in **Credential settings**\. When you are modifying a DB instance, select **Manage master credentials in AWS Secrets Manager** in **Settings**\. - -The following image is an example of the **Manage master credentials in AWS Secrets Manager** setting when you are creating or restoring a DB instance\. - -![\[Manage master credentials in AWS Secrets Manager\]](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/images/secrets-manager-credential-settings-db-instance.png) - -When you select this option, RDS generates the master user password and manages it throughout its lifecycle in Secrets Manager\. - -![\[Manage master credentials in AWS Secrets Manager selected\]](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/images/secrets-manager-integration-create-db-instance.png) - -You can choose to encrypt the secret with a KMS key that Secrets Manager provides or with a customer managed key that you create\. After RDS is managing the database credentials for a DB instance, you can't change the KMS key that is used to encrypt the secret\. - -You can choose other settings to meet your requirements\. For more information about the available settings when you are creating a DB instance, see [Settings for DB instances](USER_CreateDBInstance.md#USER_CreateDBInstance.Settings)\. For more information about the available settings when you are modifying a DB instance, see [Settings for DB instances](Overview.DBInstance.Modifying.md#USER_ModifyInstance.Settings)\. - -### AWS CLI - -To manage the master user password with RDS in Secrets Manager, specify the `--manage-master-user-password` option in one of the following AWS CLI commands: -+ [create\-db\-instance](https://docs.aws.amazon.com/cli/latest/reference/rds/create-db-instance.html) -+ [modify\-db\-instance](https://docs.aws.amazon.com/cli/latest/reference/rds/modify-db-instance.html) -+ [restore\-db\-instance\-from\-s3](https://docs.aws.amazon.com/cli/latest/reference/rds/restore-db-instance-from-s3.html) - -When you specify the `--manage-master-user-password` option in these commands, RDS generates the master user password and manages it throughout its lifecycle in Secrets Manager\. - -To encrypt the secret, you can specify a customer managed key or use the default KMS key that is provided by Secrets Manager\. Use the `--master-user-secret-kms-key-id` option to specify a customer managed key\. The AWS KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key\. To use a KMS key in a different AWS account, specify the key ARN or alias ARN\. After RDS is managing the database credentials for a DB instance, you can't change the KMS key that is used to encrypt the secret\. - -You can choose other settings to meet your requirements\. For more information about the available settings when you are creating a DB instance, see [Settings for DB instances](USER_CreateDBInstance.md#USER_CreateDBInstance.Settings)\. For more information about the available settings when you are modifying a DB instance, see [Settings for DB instances](Overview.DBInstance.Modifying.md#USER_ModifyInstance.Settings)\. - -This example creates a DB instance and specifies that RDS manages the master user password in Secrets Manager\. The secret is encrypted using the KMS key that is provided by Secrets Manager\. - -**Example** -For Linux, macOS, or Unix: - -``` -1. aws rds create-db-instance \ -2. --db-instance-identifier mydbinstance \ -3. --engine mysql \ -4. --engine-version 8.0.30 \ -5. --db-instance-class db.r5b.large \ -6. --allocated-storage 200 \ -7. --manage-master-user-password -``` -For Windows: - -``` -1. aws rds create-db-instance ^ -2. --db-instance-identifier mydbinstance ^ -3. --engine mysql ^ -4. --engine-version 8.0.30 ^ -5. --db-instance-class db.r5b.large ^ -6. --allocated-storage 200 ^ -7. --manage-master-user-password -``` - -### RDS API - -To specify that RDS manages the master user password in Secrets Manager, set the `ManageMasterUserPassword` parameter to `true` in one of the following RDS API operations: -+ [CreateDBInstance](https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_CreateDBInstance.html) -+ [ModifyDBInstance](https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_ModifyDBInstance.html) -+ [RestoreDBInstanceFromS3](https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_RestoreDBInstanceFromS3.html) - -When you set the `ManageMasterUserPassword` parameter to `true` in one of these operations, RDS generates the master user password and manages it throughout its lifecycle in Secrets Manager\. - -To encrypt the secret, you can specify a customer managed key or use the default KMS key that is provided by Secrets Manager\. Use the `MasterUserSecretKmsKeyId` parameter to specify a customer managed key\. The AWS KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key\. To use a KMS key in a different AWS account, specify the key ARN or alias ARN\. After RDS is managing the database credentials for a DB instance, you can't change the KMS key that is used to encrypt the secret\. - -## Managing the master user password for a Multi\-AZ DB cluster with Secrets Manager - -You can configure RDS management of the master user password in Secrets Manager when you perform the following actions: -+ [Creating a Multi\-AZ DB cluster](create-multi-az-db-cluster.md) -+ [Modifying a Multi\-AZ DB cluster](modify-multi-az-db-cluster.md) - -You can use the RDS console, the AWS CLI, or the RDS API to perform these actions\. - -### Console - -Follow the instructions for creating or modifying a Multi\-AZ DB cluster with the RDS console: -+ [Creating a DB cluster](create-multi-az-db-cluster.md#create-multi-az-db-cluster-creating) -+ [Modifying a Multi\-AZ DB cluster](modify-multi-az-db-cluster.md) - -When you use the RDS console to perform one of these operations, you can specify that the master user password is managed by RDS in Secrets Manager\. To do so when you are creating a DB cluster, select **Manage master credentials in AWS Secrets Manager** in **Credential settings**\. When you are modifying a DB cluster, select **Manage master credentials in AWS Secrets Manager** in **Settings**\. - -The following image is an example of the **Manage master credentials in AWS Secrets Manager** setting when you are creating a DB cluster\. - -![\[Manage master credentials in AWS Secrets Manager\]](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/images/secrets-manager-credential-settings.png) - -When you select this option, RDS generates the master user password and manages it throughout its lifecycle in Secrets Manager\. - -![\[Manage master credentials in AWS Secrets Manager selected\]](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/images/secrets-manager-integration-create.png) - -You can choose to encrypt the secret with a KMS key that Secrets Manager provides or with a customer managed key that you create\. After RDS is managing the database credentials for a DB cluster, you can't change the KMS key that is used to encrypt the secret\. - -You can choose other settings to meet your requirements\. - -For more information about the available settings when you are creating a Multi\-AZ DB cluster, see [Settings for creating Multi\-AZ DB clusters](create-multi-az-db-cluster.md#create-multi-az-db-cluster-settings)\. For more information about the available settings when you are modifying a Multi\-AZ DB cluster, see [Settings for modifying Multi\-AZ DB clusters](modify-multi-az-db-cluster.md#modify-multi-az-db-cluster-settings)\. - -### AWS CLI - -To specify that RDS manages the master user password in Secrets Manager, specify the `--manage-master-user-password` option in one of the following commands: -+ [create\-db\-cluster](https://docs.aws.amazon.com/cli/latest/reference/rds/create-db-cluster.html) -+ [modify\-db\-cluster](https://docs.aws.amazon.com/cli/latest/reference/rds/modify-db-cluster.html) - -When you specify the `--manage-master-user-password` option in these commands, RDS generates the master user password and manages it throughout its lifecycle in Secrets Manager\. - -To encrypt the secret, you can specify a customer managed key or use the default KMS key that is provided by Secrets Manager\. Use the `--master-user-secret-kms-key-id` option to specify a customer managed key\. The AWS KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key\. To use a KMS key in a different AWS account, specify the key ARN or alias ARN\. After RDS is managing the database credentials for a DB cluster, you can't change the KMS key that is used to encrypt the secret\. - -You can choose other settings to meet your requirements\. - -For more information about the available settings when you are creating a Multi\-AZ DB cluster, see [Settings for creating Multi\-AZ DB clusters](create-multi-az-db-cluster.md#create-multi-az-db-cluster-settings)\. For more information about the available settings when you are modifying a Multi\-AZ DB cluster, see [Settings for modifying Multi\-AZ DB clusters](modify-multi-az-db-cluster.md#modify-multi-az-db-cluster-settings)\. - -This example creates a Multi\-AZ DB cluster and specifies that RDS manages the password in Secrets Manager\. The secret is encrypted using the KMS key that is provided by Secrets Manager\. - -**Example** -For Linux, macOS, or Unix: - -``` - 1. aws rds create-db-cluster \ - 2. --db-cluster-identifier mysql-multi-az-db-cluster \ - 3. --engine mysql \ - 4. --engine-version 8.0.28 \ - 5. --backup-retention-period 1 \ - 6. --allocated-storage 4000 \ - 7. --storage-type io1 \ - 8. --iops 10000 \ - 9. --db-cluster-instance-class db.r6gd.xlarge \ -10. --manage-master-user-password -``` -For Windows: - -``` - 1. aws rds create-db-cluster ^ - 2. --db-cluster-identifier mysql-multi-az-db-cluster ^ - 3. --engine mysql ^ - 4. --engine-version 8.0.28 ^ - 5. --backup-retention-period 1 ^ - 6. --allocated-storage 4000 ^ - 7. --storage-type io1 ^ - 8. --iops 10000 ^ - 9. --db-cluster-instance-class db.r6gd.xlarge ^ -10. --manage-master-user-password -``` - -### RDS API - -To specify that RDS manages the master user password in Secrets Manager, set the `ManageMasterUserPassword` parameter to `true` in one of the following operations: -+ [CreateDBCluster](https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_CreateDBCluster.html) -+ [ModifyDBCluster](https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_ModifyDBCluster.html) - -When you set the `ManageMasterUserPassword` parameter to `true` in one of these operations, RDS generates the master user password and manages it throughout its lifecycle in Secrets Manager\. - -To encrypt the secret, you can specify a customer managed key or use the default KMS key that is provided by Secrets Manager\. Use the `MasterUserSecretKmsKeyId` parameter to specify a customer managed key\. The AWS KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key\. To use a KMS key in a different AWS account, specify the key ARN or alias ARN\. After RDS is managing the database credentials for a DB cluster, you can't change the KMS key that is used to encrypt the secret\. - -## Rotating the master user password secret for a DB instance - -When RDS rotates a master user password secret, Secrets Manager generates a new secret version for the existing secret\. The new version of the secret contains the new master user password\. Amazon RDS changes the master user password for the DB instance to match the password for the new secret version\. - -You can rotate a secret immediately instead of waiting for a scheduled rotation\. To rotate a master user password secret in Secrets Manager, modify the DB instance\. For information about modifying a DB instance, see [Modifying an Amazon RDS DB instance](Overview.DBInstance.Modifying.md)\. - -You can rotate a master user password secret immediately with the RDS console, the AWS CLI, or the RDS API\. - -### Console - -To rotate a master user password secret using the RDS console, modify the DB instance and select **Rotate secret immediately** in **Settings**\. - -![\[Rotate a master user password secret immediately\]](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/images/secrets-manager-integration-rotate.png) - -Follow the instructions for modifying a DB instance with the RDS console in [Modifying an Amazon RDS DB instance](Overview.DBInstance.Modifying.md)\. You must choose **Apply immediately** on the confirmation page\. - -### AWS CLI - -To rotate a master user password secret using the AWS CLI, use the [modify\-db\-instance](https://docs.aws.amazon.com/cli/latest/reference/rds/modify-db-instance.html) command and specify the `--rotate-master-user-password` option\. You must specify the `--apply-immediately` option when you rotate the master password\. - -This example rotates a master user password secret\. - -**Example** -For Linux, macOS, or Unix: - -``` -1. aws rds modify-db-instance \ -2. --db-instance-identifier mydbinstance \ -3. --rotate-master-user-password \ -4. --apply-immediately -``` -For Windows: - -``` -1. aws rds modify-db-instance ^ -2. --db-instance-identifier mydbinstance ^ -3. --rotate-master-user-password ^ -4. --apply-immediately -``` - -### RDS API - -You can rotate a master user password secret using the [ModifyDBInstance](https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_ModifyDBInstance.html) operation and setting the `RotateMasterUserPassword` parameter to `true`\. You must set the `ApplyImmediately` parameter to `true` when you rotate the master password\. - -## Rotating the master user password secret for a Multi\-AZ DB cluster - -When RDS rotates a master user password secret, Secrets Manager generates a new secret version for the existing secret\. The new version of the secret contains the new master user password\. Amazon RDS changes the master user password for the Multi\-AZ DB cluster to match the password for the new secret version\. - -You can rotate a secret immediately instead of waiting for a scheduled rotation\. To rotate a master user password secret in Secrets Manager, modify the Multi\-AZ DB cluster\. For information about modifying a Multi\-AZ DB cluster, see [Modifying a Multi\-AZ DB cluster](modify-multi-az-db-cluster.md)\. - -You can rotate a master user password secret immediately with the RDS console, the AWS CLI, or the RDS API\. - -### Console - -To rotate a master user password secret using the RDS console, modify the Multi\-AZ DB cluster and select **Rotate secret immediately** in **Settings**\. - -![\[Rotate a master user password secret immediately\]](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/images/secrets-manager-integration-rotate-taz-cluster.png) - -Follow the instructions for modifying a Multi\-AZ DB cluster with the RDS console in [Modifying a Multi\-AZ DB cluster](modify-multi-az-db-cluster.md)\. You must choose **Apply immediately** on the confirmation page\. - -### AWS CLI - -To rotate a master user password secret using the AWS CLI, use the [modify\-db\-cluster](https://docs.aws.amazon.com/cli/latest/reference/rds/modify-db-cluster.html) command and specify the `--rotate-master-user-password` option\. You must specify the `--apply-immediately` option when you rotate the master password\. - -This example rotates a master user password secret\. - -**Example** -For Linux, macOS, or Unix: - -``` -1. aws rds modify-db-cluster \ -2. --db-cluster-identifier mydbcluster \ -3. --rotate-master-user-password \ -4. --apply-immediately -``` -For Windows: - -``` -1. aws rds modify-db-cluster ^ -2. --db-cluster-identifier mydbcluster ^ -3. --rotate-master-user-password ^ -4. --apply-immediately -``` - -### RDS API - -You can rotate a master user password secret using the [ModifyDBCluster](https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_ModifyDBCluster.html) operation and setting the `RotateMasterUserPassword` parameter to `true`\. You must set the `ApplyImmediately` parameter to `true` when you rotate the master password\. - -## Viewing the details about a secret for a DB instance - -You can retrieve your secrets using the console \([https://console\.aws\.amazon\.com/secretsmanager/](https://console.aws.amazon.com/secretsmanager/)\) or the AWS CLI \([get\-secret\-value](https://docs.aws.amazon.com/cli/latest/reference/secretsmanager/get-secret-value.html) Secrets Manager command\)\. - -You can find the Amazon Resource Name \(ARN\) of a secret managed by RDS in Secrets Manager with the RDS console, the AWS CLI, or the RDS API\. - -### Console - -**To view the details about a secret managed by RDS in Secrets Manager** - -1. Sign in to the AWS Management Console and open the Amazon RDS console at [https://console\.aws\.amazon\.com/rds/](https://console.aws.amazon.com/rds/)\. - -1. In the navigation pane, choose **Databases**\. - -1. Choose the name of the DB instance to show its details\. - -1. Choose the **Configuration** tab\. - - In **Master Credentials ARN**, you can view the secret ARN\. -![\[View the details about a secret managed by RDS in Secrets Manager\]](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/images/secrets-manager-integration-view-instance.png) - - You can follow the **Manage in Secrets Manager** link to view and manage the secret in the Secrets Manager console\. - -### AWS CLI - -You can use the [describe\-db\-instances](https://docs.aws.amazon.com/cli/latest/reference/rds/describe-db-instances.html) RDS CLI command to find the following information about a secret managed by RDS in Secrets Manager: -+ `SecretArn` – The ARN of the secret -+ `SecretStatus` – The status of the secret - - The possible status values include the following: - + `creating` – The secret is being created\. - + `active` – The secret is available for normal use and rotation\. - + `rotating` – The secret is being rotated\. - + `impaired` – The secret can be used to access database credentials, but it can't be rotated\. A secret might have this status if, for example, permissions are changed so that RDS can no longer access the secret or the KMS key for the secret\. - - When a secret has this status, you can correct the condition that caused the status\. If you correct the condition that caused status, the status remains `impaired` until the next rotation\. Alternatively, you can modify the DB instance to turn off automatic management of database credentials, and then modify the DB instance again to turn on automatic management of database credentials\. To modify the DB instance, use the `--manage-master-user-password` option in the [modify\-db\-instance](https://docs.aws.amazon.com/cli/latest/reference/rds/modify-db-instance.html) command\. -+ `KmsKeyId` – The ARN of the KMS key that is used to encrypt the secret - -Specify the `--db-instance-identifier` option to show output for a specific DB instance\. This example shows the output for a secret that is used by a DB instance\. - -**Example** - -``` -1. aws rds describe-db-instances --db-instance-identifier mydbinstance -``` -Following is sample output for a secret: - -``` -"MasterUserSecret": { - "SecretArn": "arn:aws:secretsmanager:eu-west-1:123456789012:secret:rds!db-033d7456-2c96-450d-9d48-f5de3025e51c-xmJRDx", - "SecretStatus": "active", - "KmsKeyId": "arn:aws:kms:eu-west-1:123456789012:key/0987dcba-09fe-87dc-65ba-ab0987654321" - } -``` - -When you have the secret ARN, you can view details about the secret using the [get\-secret\-value](https://docs.aws.amazon.com/cli/latest/reference/secretsmanager/get-secret-value.html) Secrets Manager CLI command\. - -This example shows the details for the secret in the previous sample output\. - -**Example** -For Linux, macOS, or Unix: - -``` -aws secretsmanager get-secret-value \ - --secret-id 'arn:aws:secretsmanager:eu-west-1:123456789012:secret:rds!db-033d7456-2c96-450d-9d48-f5de3025e51c-xmJRDx' -``` -For Windows: - -``` -aws secretsmanager get-secret-value ^ - --secret-id 'arn:aws:secretsmanager:eu-west-1:123456789012:secret:rds!db-033d7456-2c96-450d-9d48-f5de3025e51c-xmJRDx' -``` - -### RDS API - -You can view the ARN, status, and KMS key for a secret managed by RDS in Secrets Manager by using the [DescribeDBInstances](https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_DescribeDBInstances.html) operation and setting the `DBInstanceIdentifier` parameter to a DB instance identifier\. Details about the secret are included in the output\. - -When you have the secret ARN, you can view details about the secret using the [GetSecretValue](https://docs.aws.amazon.com/secretsmanager/latest/apireference/API_GetSecretValue.html) Secrets Manager operation\. - -## Viewing the details about a secret for a Multi\-AZ DB cluster - -You can retrieve your secrets using the console \([https://console\.aws\.amazon\.com/secretsmanager/](https://console.aws.amazon.com/secretsmanager/)\) or the AWS CLI \([get\-secret\-value](https://docs.aws.amazon.com/cli/latest/reference/secretsmanager/get-secret-value.html) Secrets Manager command\)\. - -You can find the Amazon Resource Name \(ARN\) of a secret managed by RDS in Secrets Manager with the RDS console, the AWS CLI, or the RDS API\. - -### Console - -**To view the details about a secret managed by RDS in Secrets Manager** - -1. Sign in to the AWS Management Console and open the Amazon RDS console at [https://console\.aws\.amazon\.com/rds/](https://console.aws.amazon.com/rds/)\. - -1. In the navigation pane, choose **Databases**\. - -1. Choose the name of the Multi\-AZ DB cluster to show its details\. - -1. Choose the **Configuration** tab\. - - In **Master Credentials ARN**, you can view the secret ARN\. -![\[View the details about a secret managed by RDS in Secrets Manager\]](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/images/secrets-manager-integration-view-taz-cluster.png) - - You can follow the **Manage in Secrets Manager** link to view and manage the secret in the Secrets Manager console\. - -### AWS CLI - -You can use the RDS AWS CLI [describe\-db\-clusters](https://docs.aws.amazon.com/cli/latest/reference/rds/describe-db-clusters.html) command to find the following information about a secret managed by RDS in Secrets Manager: -+ `SecretArn` – The ARN of the secret -+ `SecretStatus` – The status of the secret - - The possible status values include the following: - + `creating` – The secret is being created\. - + `active` – The secret is available for normal use and rotation\. - + `rotating` – The secret is being rotated\. - + `impaired` – The secret can be used to access database credentials, but it can't be rotated\. A secret might have this status if, for example, permissions are changed so that RDS can no longer access the secret or the KMS key for the secret\. - - When a secret has this status, you can correct the condition that caused the status\. If you correct the condition that caused status, the status remains `impaired` until the next rotation\. Alternatively, you can modify the DB cluster to turn off automatic management of database credentials, and then modify the DB cluster again to turn on automatic management of database credentials\. To modify the DB cluster, use the `--manage-master-user-password` option in the [modify\-db\-cluster](https://docs.aws.amazon.com/cli/latest/reference/rds/modify-db-cluster.html) command\. -+ `KmsKeyId` – The ARN of the KMS key that is used to encrypt the secret - -Specify the `--db-cluster-identifier` option to show output for a specific DB cluster\. This example shows the output for a secret that is used by a DB cluster\. - -**Example** - -``` -1. aws rds describe-db-clusters --db-cluster-identifier mydbcluster -``` -The following sample shows the output for a secret: - -``` -"MasterUserSecret": { - "SecretArn": "arn:aws:secretsmanager:eu-west-1:123456789012:secret:rds!cluster-033d7456-2c96-450d-9d48-f5de3025e51c-xmJRDx", - "SecretStatus": "active", - "KmsKeyId": "arn:aws:kms:eu-west-1:123456789012:key/0987dcba-09fe-87dc-65ba-ab0987654321" - } -``` - -When you have the secret ARN, you can view details about the secret using the [get\-secret\-value](https://docs.aws.amazon.com/cli/latest/reference/secretsmanager/get-secret-value.html) Secrets Manager CLI command\. - -This example shows the details for the secret in the previous sample output\. - -**Example** -For Linux, macOS, or Unix: - -``` -aws secretsmanager get-secret-value \ - --secret-id 'arn:aws:secretsmanager:eu-west-1:123456789012:secret:rds!cluster-033d7456-2c96-450d-9d48-f5de3025e51c-xmJRDx' -``` -For Windows: - -``` -aws secretsmanager get-secret-value ^ - --secret-id 'arn:aws:secretsmanager:eu-west-1:123456789012:secret:rds!cluster-033d7456-2c96-450d-9d48-f5de3025e51c-xmJRDx' -``` - -### RDS API - -You can view the ARN, status, and KMS key for a secret managed by RDS in Secrets Manager using the [DescribeDBClusters](https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_DescribeDBClusters.html) RDS operation and setting the `DBClusterIdentifier` parameter to a DB cluster identifier\. Details about the secret are included in the output\. - -When you have the secret ARN, you can view details about the secret using the [GetSecretValue](https://docs.aws.amazon.com/secretsmanager/latest/apireference/API_GetSecretValue.html) Secrets Manager operation\. - -## Region and version availability - -Feature availability and support varies across specific versions of each database engine and across AWS Regions\. For more information about version and Region availability with Secrets Manager integration with Amazon RDS, see [Secrets Manager integration](Concepts.RDS_Fea_Regions_DB-eng.Feature.SecretsManager.md)\. - -## Limitations for Secrets Manager integration with Amazon RDS - -Managing master user passwords with Secrets Manager isn't supported for the following features: -+ For all DB engines except for RDS for SQL Server, creating a read replica when the source DB or DB cluster manages credentials with Secrets Manager -+ Managing master user password with Secrets Manager for a read replica -+ Amazon RDS Blue/Green Deployments -+ Amazon RDS Custom -+ Oracle Data Guard switchover \ No newline at end of file diff --git a/doc_source/rds-security-iam-awsmanpol.md b/doc_source/rds-security-iam-awsmanpol.md deleted file mode 100644 index c8907f0..0000000 --- a/doc_source/rds-security-iam-awsmanpol.md +++ /dev/null @@ -1,108 +0,0 @@ -# AWS managed policies for Amazon RDS - -To add permissions to permission sets and roles, it's easier to use AWS managed policies than to write policies yourself\. It takes time and expertise to [create IAM customer managed policies](https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies_create-console.html) that provide your team with only the permissions they need\. To get started quickly, you can use our AWS managed policies\. These policies cover common use cases and are available in your AWS account\. For more information about AWS managed policies, see [AWS managed policies](https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies_managed-vs-inline.html#aws-managed-policies) in the *IAM User Guide*\. - -AWS services maintain and update AWS managed policies\. You can't change the permissions in AWS managed policies\. Services occasionally add additional permissions to an AWS managed policy to support new features\. This type of update affects all identities \(permission sets and roles\) where the policy is attached\. Services are most likely to update an AWS managed policy when a new feature is launched or when new operations become available\. Services don't remove permissions from an AWS managed policy, so policy updates don't break your existing permissions\. - -Additionally, AWS supports managed policies for job functions that span multiple services\. For example, the `ReadOnlyAccess` AWS managed policy provides read\-only access to all AWS services and resources\. When a service launches a new feature, AWS adds read\-only permissions for new operations and resources\. For a list and descriptions of job function policies, see [AWS managed policies for job functions](https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies_job-functions.html) in the *IAM User Guide*\. - -**Topics** -+ [AWS managed policy: AmazonRDSReadOnlyAccess](#rds-security-iam-awsmanpol-AmazonRDSReadOnlyAccess) -+ [AWS managed policy: AmazonRDSFullAccess](#rds-security-iam-awsmanpol-AmazonRDSFullAccess) -+ [AWS managed policy: AmazonRDSDataFullAccess](#rds-security-iam-awsmanpol-AmazonRDSDataFullAccess) -+ [AWS managed policy: AmazonRDSEnhancedMonitoringRole](#rds-security-iam-awsmanpol-AmazonRDSEnhancedMonitoringRole) -+ [AWS managed policy: AmazonRDSPerformanceInsightsReadOnly](#rds-security-iam-awsmanpol-AmazonRDSPerformanceInsightsReadOnly) -+ [AWS managed policy: AmazonRDSDirectoryServiceAccess](#rds-security-iam-awsmanpol-AmazonRDSDirectoryServiceAccess) -+ [AWS managed policy: AmazonRDSServiceRolePolicy](#rds-security-iam-awsmanpol-AmazonRDSServiceRolePolicy) -+ [AWS managed policy: AmazonRDSCustomServiceRolePolicy](#rds-security-iam-awsmanpol-AmazonRDSCustomServiceRolePolicy) - -## AWS managed policy: AmazonRDSReadOnlyAccess - -This policy allows read\-only access to Amazon RDS through the AWS Management Console\. - -**Permissions details** - -This policy includes the following permissions: -+ `rds` – Allows principals to describe Amazon RDS resources and list the tags for Amazon RDS resources\. -+ `cloudwatch` – Allows principals to get Amazon CloudWatch metric statistics\. -+ `ec2` – Allows principals to describe Availability Zones and networking resources\. -+ `logs` – Allows principals to describe CloudWatch Logs log streams of log groups, and get CloudWatch Logs log events\. -+ `devops-guru` – Allows principals to describe resources that have Amazon DevOps Guru coverage, which is specified either by CloudFormation stack names or resource tags\. - -For more information about this policy, including the JSON policy document, see [AmazonRDSReadOnlyAccess](https://docs.aws.amazon.com/aws-managed-policy/latest/reference/AmazonRDSReadOnlyAccess.html) in the *AWS Managed Policy Reference Guide*\. - -## AWS managed policy: AmazonRDSFullAccess - -This policy provides full access to Amazon RDS through the AWS Management Console\. - -**Permissions details** - -This policy includes the following permissions: -+ `rds` – Allows principals full access to Amazon RDS\. -+ `application-autoscaling` – Allows principals describe and manage Application Auto Scaling scaling targets and policies\. -+ `cloudwatch` – Allows principals get CloudWatch metric statics and manage CloudWatch alarms\. -+ `ec2` – Allows principals to describe Availability Zones and networking resources\. -+ `logs` – Allows principals to describe CloudWatch Logs log streams of log groups, and get CloudWatch Logs log events\. -+ `outposts` – Allows principals to get AWS Outposts instance types\. -+ `pi` – Allows principals to get Performance Insights metrics\. -+ `sns` – Allows principals to Amazon Simple Notification Service \(Amazon SNS\) subscriptions and topics, and to publish Amazon SNS messages\. -+ `devops-guru` – Allows principals to describe resources that have Amazon DevOps Guru coverage, which is specified either by CloudFormation stack names or resource tags\. - -For more information about this policy, including the JSON policy document, see [AmazonRDSFullAccess](https://docs.aws.amazon.com/aws-managed-policy/latest/reference/AmazonRDSFullAccess.html) in the *AWS Managed Policy Reference Guide*\. - -## AWS managed policy: AmazonRDSDataFullAccess - -This policy allows full access to use the Data API and the query editor on Aurora Serverless clusters in a specific AWS account\. This policy allows the AWS account to get the value of a secret from AWS Secrets Manager\. - -You can attach the `AmazonRDSDataFullAccess` policy to your IAM identities\. - -**Permissions details** - -This policy includes the following permissions: -+ `dbqms` – Allows principals to access, create, delete, describe, and update queries\. The Database Query Metadata Service \(`dbqms`\) is an internal\-only service\. It provides your recent and saved queries for the query editor on the AWS Management Console for multiple AWS services, including Amazon RDS\. -+ `rds-data` – Allows principals to run SQL statements on Aurora Serverless databases\. -+ `secretsmanager` – Allows principals to get the value of a secret from AWS Secrets Manager\. - -For more information about this policy, including the JSON policy document, see [AmazonRDSDataFullAccess](https://docs.aws.amazon.com/aws-managed-policy/latest/reference/AmazonRDSDataFullAccess.html) in the *AWS Managed Policy Reference Guide*\. - -## AWS managed policy: AmazonRDSEnhancedMonitoringRole - -This policy provides access to Amazon CloudWatch Logs for Amazon RDS Enhanced Monitoring\. - -**Permissions details** - -This policy includes the following permissions: -+ `logs` – Allows principals to create CloudWatch Logs log groups and retention policies, and to create and describe CloudWatch Logs log streams of log groups\. It also allows principals to put and get CloudWatch Logs log events\. - -For more information about this policy, including the JSON policy document, see [AmazonRDSEnhancedMonitoringRole](https://docs.aws.amazon.com/aws-managed-policy/latest/reference/AmazonRDSEnhancedMonitoringRole.html) in the *AWS Managed Policy Reference Guide*\. - -## AWS managed policy: AmazonRDSPerformanceInsightsReadOnly - -This policy provides read\-only access to Amazon RDS Performance Insights for Amazon RDS DB instances and Amazon Aurora DB clusters\. - -**Permissions details** - -This policy includes the following permissions: -+ `rds` – Allows principals to describe Amazon RDS DB instances and Amazon Aurora DB clusters\. -+ `pi` – Allows principals make calls to the Amazon RDS Performance Insights API and access Performance Insights metrics\. - -For more information about this policy, including the JSON policy document, see [AmazonRDSPerformanceInsightsReadOnly](https://docs.aws.amazon.com/aws-managed-policy/latest/reference/AmazonRDSPerformanceInsightsReadOnly.html) in the *AWS Managed Policy Reference Guide*\. - -## AWS managed policy: AmazonRDSDirectoryServiceAccess - -This policy allows Amazon RDS to make calls to the AWS Directory Service\. - -**Permissions details** - -This policy includes the following permission: -+ `ds` – Allows principals to describe AWS Directory Service directories and control authorization to AWS Directory Service directories\. - -For more information about this policy, including the JSON policy document, see [AmazonRDSDirectoryServiceAccess](https://docs.aws.amazon.com/aws-managed-policy/latest/reference/AmazonRDSDirectoryServiceAccess.html) in the *AWS Managed Policy Reference Guide*\. - -## AWS managed policy: AmazonRDSServiceRolePolicy - -You can't attach the `AmazonRDSServiceRolePolicy` policy to your IAM entities\. This policy is attached to a service\-linked role that allows Amazon RDS to perform actions on your behalf\. For more information, see [Service\-linked role permissions for Amazon RDS](UsingWithRDS.IAM.ServiceLinkedRoles.md#service-linked-role-permissions)\. - -## AWS managed policy: AmazonRDSCustomServiceRolePolicy - -You can't attach the `AmazonRDSCustomServiceRolePolicy` policy to your IAM entities\. This policy is attached to a service\-linked role that allows Amazon RDS to perform actions on your behalf\. For more information, see [Service\-linked role permissions for Amazon RDS Custom](UsingWithRDS.IAM.ServiceLinkedRoles.md#slr-permissions-custom)\. \ No newline at end of file diff --git a/doc_source/securing-mariadb-connections.md b/doc_source/securing-mariadb-connections.md deleted file mode 100644 index 232b4c6..0000000 --- a/doc_source/securing-mariadb-connections.md +++ /dev/null @@ -1,8 +0,0 @@ -# Securing MariaDB DB instance connections - -You can manage the security of your MariaDB DB instances\. - -**Topics** -+ [MariaDB security on Amazon RDS](MariaDB.Concepts.UsersAndPrivileges.md) -+ [Encrypting client connections to MariaDB DB instances with SSL/TLS](mariadb-ssl-connections.md) -+ [Using new SSL/TLS certificates for MariaDB DB instances](ssl-certificate-rotation-mariadb.md) \ No newline at end of file diff --git a/doc_source/securing-mysql-connections.md b/doc_source/securing-mysql-connections.md deleted file mode 100644 index cc6d21b..0000000 --- a/doc_source/securing-mysql-connections.md +++ /dev/null @@ -1,10 +0,0 @@ -# Securing MySQL DB instance connections - -You can manage the security of your MySQL DB instances\. - -**Topics** -+ [MySQL security on Amazon RDS](MysQL.Concepts.UsersAndPrivileges.md) -+ [Using the Password Validation Plugin for RDS for MySQL](MySQL.Concepts.PasswordValidationPlugin.md) -+ [Encrypting client connections to MySQL DB instances with SSL/TLS](mysql-ssl-connections.md) -+ [Using new SSL/TLS certificates for MySQL DB instances](ssl-certificate-rotation-mysql.md) -+ [Using Kerberos authentication for MySQL](mysql-kerberos.md) \ No newline at end of file diff --git a/doc_source/security_iam_id-based-policy-examples.md b/doc_source/security_iam_id-based-policy-examples.md deleted file mode 100644 index 80aaac1..0000000 --- a/doc_source/security_iam_id-based-policy-examples.md +++ /dev/null @@ -1,568 +0,0 @@ -# Identity\-based policy examples for Amazon RDS - -By default, permission sets and roles don't have permission to create or modify Amazon RDS resources\. They also can't perform tasks using the AWS Management Console, AWS CLI, or AWS API\. An administrator must create IAM policies that grant permission sets and roles permission to perform specific API operations on the specified resources they need\. The administrator must then attach those policies to the permission sets or roles that require those permissions\. - -To learn how to create an IAM identity\-based policy using these example JSON policy documents, see [Creating policies on the JSON tab](https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies_create.html#access_policies_create-json-editor) in the *IAM User Guide*\. - -**Topics** -+ [Policy best practices](#security_iam_service-with-iam-policy-best-practices) -+ [Using the Amazon RDS console](#security_iam_id-based-policy-examples-console) -+ [Allow users to view their own permissions](#security_iam_id-based-policy-examples-view-own-permissions) -+ [Allow a user to create DB instances in an AWS account](#security_iam_id-based-policy-examples-create-db-instance-in-account) -+ [Permissions required to use the console](#UsingWithRDS.IAM.RequiredPermissions.Console) -+ [Allow a user to perform any describe action on any RDS resource](#IAMPolicyExamples-RDS-perform-describe-action) -+ [Allow a user to create a DB instance that uses the specified DB parameter group and subnet group](#security_iam_id-based-policy-examples-create-db-instance-specified-groups) -+ [Grant permission for actions on a resource with a specific tag with two different values](#security_iam_id-based-policy-examples-grant-permissions-tags) -+ [Prevent a user from deleting a DB instance](#IAMPolicyExamples-RDS-prevent-db-deletion) -+ [Deny all access to a resource](#IAMPolicyExamples-RDS-deny-all-access) -+ [Example policies: Using condition keys](#UsingWithRDS.IAM.Conditions.Examples) -+ [Specifying conditions: Using custom tags](#UsingWithRDS.IAM.SpecifyingCustomTags) - -## Policy best practices - -Identity\-based policies determine whether someone can create, access, or delete Amazon RDS resources in your account\. These actions can incur costs for your AWS account\. When you create or edit identity\-based policies, follow these guidelines and recommendations: -+ **Get started with AWS managed policies and move toward least\-privilege permissions** – To get started granting permissions to your users and workloads, use the *AWS managed policies* that grant permissions for many common use cases\. They are available in your AWS account\. We recommend that you reduce permissions further by defining AWS customer managed policies that are specific to your use cases\. For more information, see [AWS managed policies](https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies_managed-vs-inline.html#aws-managed-policies) or [AWS managed policies for job functions](https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies_job-functions.html) in the *IAM User Guide*\. -+ **Apply least\-privilege permissions** – When you set permissions with IAM policies, grant only the permissions required to perform a task\. You do this by defining the actions that can be taken on specific resources under specific conditions, also known as *least\-privilege permissions*\. For more information about using IAM to apply permissions, see [ Policies and permissions in IAM](https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies.html) in the *IAM User Guide*\. -+ **Use conditions in IAM policies to further restrict access** – You can add a condition to your policies to limit access to actions and resources\. For example, you can write a policy condition to specify that all requests must be sent using SSL\. You can also use conditions to grant access to service actions if they are used through a specific AWS service, such as AWS CloudFormation\. For more information, see [ IAM JSON policy elements: Condition](https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies_elements_condition.html) in the *IAM User Guide*\. -+ **Use IAM Access Analyzer to validate your IAM policies to ensure secure and functional permissions** – IAM Access Analyzer validates new and existing policies so that the policies adhere to the IAM policy language \(JSON\) and IAM best practices\. IAM Access Analyzer provides more than 100 policy checks and actionable recommendations to help you author secure and functional policies\. For more information, see [IAM Access Analyzer policy validation](https://docs.aws.amazon.com/IAM/latest/UserGuide/access-analyzer-policy-validation.html) in the *IAM User Guide*\. -+ **Require multi\-factor authentication \(MFA\)** – If you have a scenario that requires IAM users or a root user in your AWS account, turn on MFA for additional security\. To require MFA when API operations are called, add MFA conditions to your policies\. For more information, see [ Configuring MFA\-protected API access](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_mfa_configure-api-require.html) in the *IAM User Guide*\. - -For more information about best practices in IAM, see [Security best practices in IAM](https://docs.aws.amazon.com/IAM/latest/UserGuide/best-practices.html) in the *IAM User Guide*\. - -## Using the Amazon RDS console - -To access the Amazon RDS console, you must have a minimum set of permissions\. These permissions must allow you to list and view details about the Amazon RDS resources in your AWS account\. If you create an identity\-based policy that is more restrictive than the minimum required permissions, the console won't function as intended for entities \(users or roles\) with that policy\. - -You don't need to allow minimum console permissions for users that are making calls only to the AWS CLI or the AWS API\. Instead, allow access to only the actions that match the API operation that you're trying to perform\. - -To ensure that those entities can still use the Amazon RDS console, also attach the following AWS managed policy to the entities\. - -``` -AmazonRDSReadOnlyAccess -``` - -For more information, see [Adding permissions to a user](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_users_change-permissions.html#users_change_permissions-add-console) in the *IAM User Guide*\. - -## Allow users to view their own permissions - -This example shows how you might create a policy that allows IAM users to view the inline and managed policies that are attached to their user identity\. This policy includes permissions to complete this action on the console or programmatically using the AWS CLI or AWS API\. - -``` -{ - "Version": "2012-10-17", - "Statement": [ - { - "Sid": "ViewOwnUserInfo", - "Effect": "Allow", - "Action": [ - "iam:GetUserPolicy", - "iam:ListGroupsForUser", - "iam:ListAttachedUserPolicies", - "iam:ListUserPolicies", - "iam:GetUser" - ], - "Resource": ["arn:aws:iam::*:user/${aws:username}"] - }, - { - "Sid": "NavigateInConsole", - "Effect": "Allow", - "Action": [ - "iam:GetGroupPolicy", - "iam:GetPolicyVersion", - "iam:GetPolicy", - "iam:ListAttachedGroupPolicies", - "iam:ListGroupPolicies", - "iam:ListPolicyVersions", - "iam:ListPolicies", - "iam:ListUsers" - ], - "Resource": "*" - } - ] -} -``` - -## Allow a user to create DB instances in an AWS account - -The following is an example policy that allows the user with the ID `123456789012` to create DB instances for your AWS account\. The policy requires that the name of the new DB instance begin with `test`\. The new DB instance must also use the MySQL database engine and the `db.t2.micro` DB instance class\. In addition, the new DB instance must use an option group and a DB parameter group that starts with `default`, and it must use the `default` subnet group\. - -``` -{ - "Version": "2012-10-17", - "Statement": [ - { - "Sid": "AllowCreateDBInstanceOnly", - "Effect": "Allow", - "Action": [ - "rds:CreateDBInstance" - ], - "Resource": [ - "arn:aws:rds:*:123456789012:db:test*", - "arn:aws:rds:*:123456789012:og:default*", - "arn:aws:rds:*:123456789012:pg:default*", - "arn:aws:rds:*:123456789012:subgrp:default" - ], - "Condition": { - "StringEquals": { - "rds:DatabaseEngine": "mysql", - "rds:DatabaseClass": "db.t2.micro" - } - } - } - ] -} -``` - -The policy includes a single statement that specifies the following permissions for the user: -+ The policy allows the user to create a DB instance using the [CreateDBInstance](https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_CreateDBInstance.html) API operation \(this also applies to the [create\-db\-instance](https://docs.aws.amazon.com/cli/latest/reference/rds/create-db-instance.html) AWS CLI command and the AWS Management Console\)\. -+ The `Resource` element specifies that the user can perform actions on or with resources\. You specify resources using an Amazon Resources Name \(ARN\)\. This ARN includes the name of the service that the resource belongs to \(`rds`\), the AWS Region \(`*` indicates any region in this example\), the AWS account number \(`123456789012` is the account number in this example\), and the type of resource\. For more information about creating ARNs, see [Working with Amazon Resource Names \(ARNs\) in Amazon RDS](USER_Tagging.ARN.md)\. - - The `Resource` element in the example specifies the following policy constraints on resources for the user: - + The DB instance identifier for the new DB instance must begin with `test` \(for example, `testCustomerData1`, `test-region2-data`\)\. - + The option group for the new DB instance must begin with `default`\. - + The DB parameter group for the new DB instance must begin with `default`\. - + The subnet group for the new DB instance must be the `default` subnet group\. -+ The `Condition` element specifies that the DB engine must be MySQL and the DB instance class must be `db.t2.micro`\. The `Condition` element specifies the conditions when a policy should take effect\. You can add additional permissions or restrictions by using the `Condition` element\. For more information about specifying conditions, see [Policy condition keys for Amazon RDS](security_iam_service-with-iam.md#UsingWithRDS.IAM.Conditions)\. This example specifies the `rds:DatabaseEngine` and `rds:DatabaseClass` conditions\. For information about the valid condition values for `rds:DatabaseEngine`, see the list under the `Engine` parameter in [CreateDBInstance](https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_CreateDBInstance.html)\. For information about the valid condition values for `rds:DatabaseClass`, see [Supported DB engines for DB instance classes](Concepts.DBInstanceClass.md#Concepts.DBInstanceClass.Support) \. - -The policy doesn't specify the `Principal` element because in an identity\-based policy you don't specify the principal who gets the permission\. When you attach policy to a user, the user is the implicit principal\. When you attach a permission policy to an IAM role, the principal identified in the role's trust policy gets the permissions\. - -To see a list of Amazon RDS actions, see [Actions Defined by Amazon RDS](https://docs.aws.amazon.com/service-authorization/latest/reference/list_amazonrds.html#amazonrds-actions-as-permissions) in the *Service Authorization Reference*\. - -## Permissions required to use the console - -For a user to work with the console, that user must have a minimum set of permissions\. These permissions allow the user to describe the Amazon RDS resources for their AWS account and to provide other related information, including Amazon EC2 security and network information\. - -If you create an IAM policy that is more restrictive than the minimum required permissions, the console doesn't function as intended for users with that IAM policy\. To ensure that those users can still use the console, also attach the `AmazonRDSReadOnlyAccess` managed policy to the user, as described in [Managing access using policies](UsingWithRDS.IAM.md#security_iam_access-manage)\. - -You don't need to allow minimum console permissions for users that are making calls only to the AWS CLI or the Amazon RDS API\. - -The following policy grants full access to all Amazon RDS resources for the root AWS account: - -``` -AmazonRDSFullAccess -``` - -## Allow a user to perform any describe action on any RDS resource - -The following permissions policy grants permissions to a user to run all of the actions that begin with `Describe`\. These actions show information about an RDS resource, such as a DB instance\. The wildcard character \(\*\) in the `Resource` element indicates that the actions are allowed for all Amazon RDS resources owned by the account\. - -``` -{ - "Version": "2012-10-17", - "Statement": [ - { - "Sid": "AllowRDSDescribe", - "Effect": "Allow", - "Action": "rds:Describe*", - "Resource": "*" - } - ] -} -``` - -## Allow a user to create a DB instance that uses the specified DB parameter group and subnet group - -The following permissions policy grants permissions to allow a user to only create a DB instance that must use the `mydbpg` DB parameter group and the `mydbsubnetgroup` DB subnet group\. - -``` -{ - "Version": "2012-10-17", - "Statement": [ - { - "Sid": "VisualEditor0", - "Effect": "Allow", - "Action": "rds:CreateDBInstance", - "Resource": [ - "arn:aws:rds:*:*:pg:mydbpg", - "arn:aws:rds:*:*:subgrp:mydbsubnetgroup" - ] - } - ] -} -``` - -## Grant permission for actions on a resource with a specific tag with two different values - -You can use conditions in your identity\-based policy to control access to Amazon RDS resources based on tags\. The following policy allows permission to perform the `CreateDBSnapshot` API operation on DB instances with either the `stage` tag set to `development` or `test`\. - -``` - 1. { - 2. "Version":"2012-10-17", - 3. "Statement":[ - 4. { - 5. "Sid":"AllowAnySnapshotName", - 6. "Effect":"Allow", - 7. "Action":[ - 8. "rds:CreateDBSnapshot" - 9. ], -10. "Resource":""arn:aws:rds:*:123456789012:snapshot:*"" -11. }, -12. { -13. "Sid":"AllowDevTestToCreateSnapshot", -14. "Effect":"Allow", -15. "Action":[ -16. "rds:CreateDBSnapshot" -17. ], -18. "Resource":"arn:aws:rds:*:123456789012:db:*", -19. "Condition":{ -20. "StringEquals":{ -21. "rds:db-tag/stage":[ -22. "development", -23. "test" -24. ] -25. } -26. } -27. } -28. ] -29. } -``` - -The following policy allows permission to perform the `ModifyDBInstance` API operation on DB instances with either the `stage` tag set to `development` or `test`\. - -``` - 1. { - 2. "Version":"2012-10-17", - 3. "Statement":[ - 4. { - 5. "Sid":"AllowChangingParameterOptionSecurityGroups", - 6. "Effect":"Allow", - 7. "Action":[ - 8. "rds:ModifyDBInstance" - 9. ], -10. "Resource":" [ -11. "arn:aws:rds:*:123456789012:pg:*", -12. "arn:aws:rds:*:123456789012:secgrp:*", -13. "arn:aws:rds:*:123456789012:og:*" -14. ] -15. }, -16. { -17. "Sid":"AllowDevTestToModifyInstance", -18. "Effect":"Allow", -19. "Action":[ -20. "rds:ModifyDBInstance" -21. ], -22. "Resource":"arn:aws:rds:*:123456789012:db:*", -23. "Condition":{ -24. "StringEquals":{ -25. "rds:db-tag/stage":[ -26. "development", -27. "test" -28. ] -29. } -30. } -31. } -32. ] -33. } -``` - -## Prevent a user from deleting a DB instance - -The following permissions policy grants permissions to prevent a user from deleting a specific DB instance\. For example, you might want to deny the ability to delete your production DB instances to any user that is not an administrator\. - -``` -{ - "Version": "2012-10-17", - "Statement": [ - { - "Sid": "DenyDelete1", - "Effect": "Deny", - "Action": "rds:DeleteDBInstance", - "Resource": "arn:aws:rds:us-west-2:123456789012:db:my-mysql-instance" - } - ] -} -``` - -## Deny all access to a resource - -You can explicitly deny access to a resource\. Deny policies take precedence over allow policies\. The following policy explicitly denies a user the ability to manage a resource: - -``` -{ - "Version": "2012-10-17", - "Statement": [ - { - "Effect": "Deny", - "Action": "rds:*", - "Resource": "arn:aws:rds:us-east-1:123456789012:db:mydb" - } - ] -} -``` - -## Example policies: Using condition keys - -Following are examples of how you can use condition keys in Amazon RDS IAM permissions policies\. - -### Example 1: Grant permission to create a DB instance that uses a specific DB engine and isn't MultiAZ - -The following policy uses an RDS condition key and allows a user to create only DB instances that use the MySQL database engine and don't use MultiAZ\. The `Condition` element indicates the requirement that the database engine is MySQL\. - -``` - 1. { - 2. "Version": "2012-10-17", - 3. "Statement": [ - 4. { - 5. "Sid": "AllowMySQLCreate", - 6. "Effect": "Allow", - 7. "Action": "rds:CreateDBInstance", - 8. "Resource": "*", - 9. "Condition": { -10. "StringEquals": { -11. "rds:DatabaseEngine": "mysql" -12. }, -13. "Bool": { -14. "rds:MultiAz": false -15. } -16. } -17. } -18. ] -19. } -``` - -### Example 2: Explicitly deny permission to create DB instances for certain DB instance classes and create DB instances that use Provisioned IOPS - -The following policy explicitly denies permission to create DB instances that use the DB instance classes `r3.8xlarge` and `m4.10xlarge`, which are the largest and most expensive DB instance classes\. This policy also prevents users from creating DB instances that use Provisioned IOPS, which incurs an additional cost\. - -Explicitly denying permission supersedes any other permissions granted\. This ensures that identities to not accidentally get permission that you never want to grant\. - -``` - 1. { - 2. "Version": "2012-10-17", - 3. "Statement": [ - 4. { - 5. "Sid": "DenyLargeCreate", - 6. "Effect": "Deny", - 7. "Action": "rds:CreateDBInstance", - 8. "Resource": "*", - 9. "Condition": { -10. "StringEquals": { -11. "rds:DatabaseClass": [ -12. "db.r3.8xlarge", -13. "db.m4.10xlarge" -14. ] -15. } -16. } -17. }, -18. { -19. "Sid": "DenyPIOPSCreate", -20. "Effect": "Deny", -21. "Action": "rds:CreateDBInstance", -22. "Resource": "*", -23. "Condition": { -24. "NumericNotEquals": { -25. "rds:Piops": "0" -26. } -27. } -28. } -29. ] -30. } -``` - -### Example 3: Limit the set of tag keys and values that can be used to tag a resource - -The following policy uses an RDS condition key and allows the addition of a tag with the key `stage` to be added to a resource with the values `test`, `qa`, and `production`\. - -``` - 1. { - 2. "Version": "2012-10-17", - 3. "Statement": [ - 4. { - 5. "Effect": "Allow", - 6. "Action": [ - 7. "rds:AddTagsToResource", - 8. "rds:RemoveTagsFromResource" - 9. ], -10. "Resource": "*", -11. "Condition": { -12. "streq": { -13. "rds:req-tag/stage": [ -14. "test", -15. "qa", -16. "production" -17. ] -18. } -19. } -20. } -21. ] -22. } -``` - -## Specifying conditions: Using custom tags - -Amazon RDS supports specifying conditions in an IAM policy using custom tags\. - -For example, suppose that you add a tag named `environment` to your DB instances with values such as `beta`, `staging`, `production`, and so on\. If you do, you can create a policy that restricts certain users to DB instances based on the `environment` tag value\. - -**Note** -Custom tag identifiers are case\-sensitive\. - -The following table lists the RDS tag identifiers that you can use in a `Condition` element\. - -[\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/security_iam_id-based-policy-examples.html) - -The syntax for a custom tag condition is as follows: - -`"Condition":{"StringEquals":{"rds:rds-tag-identifier/tag-name": ["value"]} }` - -For example, the following `Condition` element applies to DB instances with a tag named `environment` and a tag value of `production`\. - -` "Condition":{"StringEquals":{"rds:db-tag/environment": ["production"]} } ` - -For information about creating tags, see [Tagging Amazon RDS resources](USER_Tagging.md)\. - -**Important** -If you manage access to your RDS resources using tagging, we recommend that you secure access to the tags for your RDS resources\. You can manage access to tags by creating policies for the `AddTagsToResource` and `RemoveTagsFromResource` actions\. For example, the following policy denies users the ability to add or remove tags for all resources\. You can then create policies to allow specific users to add or remove tags\. - -``` - 1. { - 2. "Version":"2012-10-17", - 3. "Statement":[ - 4. { - 5. "Sid":"DenyTagUpdates", - 6. "Effect":"Deny", - 7. "Action":[ - 8. "rds:AddTagsToResource", - 9. "rds:RemoveTagsFromResource" -10. ], -11. "Resource":"*" -12. } -13. ] -14. } -``` - -To see a list of Amazon RDS actions, see [Actions Defined by Amazon RDS](https://docs.aws.amazon.com/service-authorization/latest/reference/list_amazonrds.html#amazonrds-actions-as-permissions) in the *Service Authorization Reference*\. - -### Example policies: Using custom tags - -Following are examples of how you can use custom tags in Amazon RDS IAM permissions policies\. For more information about adding tags to an Amazon RDS resource, see [Working with Amazon Resource Names \(ARNs\) in Amazon RDS](USER_Tagging.ARN.md)\. - -**Note** -All examples use the us\-west\-2 region and contain fictitious account IDs\. - -#### Example 1: Grant permission for actions on a resource with a specific tag with two different values - -The following policy allows permission to perform the `CreateDBSnapshot` API operation on DB instances with either the `stage` tag set to `development` or `test`\. - -``` - 1. { - 2. "Version":"2012-10-17", - 3. "Statement":[ - 4. { - 5. "Sid":"AllowAnySnapshotName", - 6. "Effect":"Allow", - 7. "Action":[ - 8. "rds:CreateDBSnapshot" - 9. ], -10. "Resource":"arn:aws:rds:*:123456789012:snapshot:*" -11. }, -12. { -13. "Sid":"AllowDevTestToCreateSnapshot", -14. "Effect":"Allow", -15. "Action":[ -16. "rds:CreateDBSnapshot" -17. ], -18. "Resource":"arn:aws:rds:*:123456789012:db:*", -19. "Condition":{ -20. "StringEquals":{ -21. "rds:db-tag/stage":[ -22. "development", -23. "test" -24. ] -25. } -26. } -27. } -28. ] -29. } -``` - -The following policy allows permission to perform the `ModifyDBInstance` API operation on DB instances with either the `stage` tag set to `development` or `test`\. - -``` - 1. { - 2. "Version":"2012-10-17", - 3. "Statement":[ - 4. { - 5. "Sid":"AllowChangingParameterOptionSecurityGroups", - 6. "Effect":"Allow", - 7. "Action":[ - 8. "rds:ModifyDBInstance" - 9. ], -10. "Resource":" [ -11. "arn:aws:rds:*:123456789012:pg:*", -12. "arn:aws:rds:*:123456789012:secgrp:*", -13. "arn:aws:rds:*:123456789012:og:*" -14. ] -15. }, -16. { -17. "Sid":"AllowDevTestToModifyInstance", -18. "Effect":"Allow", -19. "Action":[ -20. "rds:ModifyDBInstance" -21. ], -22. "Resource":"arn:aws:rds:*:123456789012:db:*", -23. "Condition":{ -24. "StringEquals":{ -25. "rds:db-tag/stage":[ -26. "development", -27. "test" -28. ] -29. } -30. } -31. } -32. ] -33. } -``` - -#### Example 2: Explicitly deny permission to create a DB instance that uses specified DB parameter groups - -The following policy explicitly denies permission to create a DB instance that uses DB parameter groups with specific tag values\. You might apply this policy if you require that a specific customer\-created DB parameter group always be used when creating DB instances\. Policies that use `Deny` are most often used to restrict access that was granted by a broader policy\. - -Explicitly denying permission supersedes any other permissions granted\. This ensures that identities to not accidentally get permission that you never want to grant\. - -``` - 1. { - 2. "Version":"2012-10-17", - 3. "Statement":[ - 4. { - 5. "Sid":"DenyProductionCreate", - 6. "Effect":"Deny", - 7. "Action":"rds:CreateDBInstance", - 8. "Resource":"arn:aws:rds:*:123456789012:pg:*", - 9. "Condition":{ -10. "StringEquals":{ -11. "rds:pg-tag/usage":"prod" -12. } -13. } -14. } -15. ] -16. } -``` - -#### Example 3: Grant permission for actions on a DB instance with an instance name that is prefixed with a user name - -The following policy allows permission to call any API \(except to `AddTagsToResource` or `RemoveTagsFromResource`\) on a DB instance that has a DB instance name that is prefixed with the user's name and that has a tag called `stage` equal to `devo` or that has no tag called `stage`\. - -The `Resource` line in the policy identifies a resource by its Amazon Resource Name \(ARN\)\. For more information about using ARNs with Amazon RDS resources, see [Working with Amazon Resource Names \(ARNs\) in Amazon RDS](USER_Tagging.ARN.md)\. - -``` -{ - "Version":"2012-10-17", - "Statement":[ - { - "Sid":"AllowFullDevAccessNoTags", - "Effect":"Allow", - "NotAction":[ - "rds:AddTagsToResource", - "rds:RemoveTagsFromResource" - ], - "Resource":"arn:aws:rds:*:123456789012:db:${aws:username}*", - "Condition":{ - "StringEqualsIfExists":{ - "rds:db-tag/stage":"devo" - } - } - } - ] -} -``` \ No newline at end of file diff --git a/doc_source/security_iam_service-with-iam.md b/doc_source/security_iam_service-with-iam.md deleted file mode 100644 index 62e2a57..0000000 --- a/doc_source/security_iam_service-with-iam.md +++ /dev/null @@ -1,245 +0,0 @@ -# How Amazon RDS works with IAM - -Before you use IAM to manage access to Amazon RDS, you should understand what IAM features are available to use with Amazon RDS\. - - -**IAM features you can use with Amazon RDS** - -| IAM feature | Amazon RDS support | -| --- | --- | -| [Identity\-based policies](#security_iam_service-with-iam-id-based-policies) | Yes | -| [Resource\-based policies](#security_iam_service-with-iam-resource-based-policies) | No | -| [Policy actions](#security_iam_service-with-iam-id-based-policies-actions) | Yes | -| [Policy resources](#security_iam_service-with-iam-id-based-policies-resources) | Yes | -| [Policy condition keys \(service\-specific\)](#UsingWithRDS.IAM.Conditions) | Yes | -| [ACLs](#security_iam_service-with-iam-acls) | No | -| [Attribute\-based access control \(ABAC\) \(tags in policies\)](#security_iam_service-with-iam-tags) | Yes | -| [Temporary credentials](#security_iam_service-with-iam-roles-tempcreds) | Yes | -| [Principal permissions](#security_iam_service-with-iam-principal-permissions) | Yes | -| [Service roles](#security_iam_service-with-iam-roles-service) | Yes | -| [Service\-linked roles](#security_iam_service-with-iam-roles-service-linked) | Yes | - -To get a high\-level view of how Amazon RDS and other AWS services work with IAM, see [AWS services that work with IAM](https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_aws-services-that-work-with-iam.html) in the *IAM User Guide*\. - -**Topics** -+ [Amazon RDS identity\-based policies](#security_iam_service-with-iam-id-based-policies) -+ [Resource\-based policies within Amazon RDS](#security_iam_service-with-iam-resource-based-policies) -+ [Policy actions for Amazon RDS](#security_iam_service-with-iam-id-based-policies-actions) -+ [Policy resources for Amazon RDS](#security_iam_service-with-iam-id-based-policies-resources) -+ [Policy condition keys for Amazon RDS](#UsingWithRDS.IAM.Conditions) -+ [Access control lists \(ACLs\) in Amazon RDS](#security_iam_service-with-iam-acls) -+ [Attribute\-based access control \(ABAC\) in policies with Amazon RDS tags](#security_iam_service-with-iam-tags) -+ [Using temporary credentials with Amazon RDS](#security_iam_service-with-iam-roles-tempcreds) -+ [Cross\-service principal permissions for Amazon RDS](#security_iam_service-with-iam-principal-permissions) -+ [Service roles for Amazon RDS](#security_iam_service-with-iam-roles-service) -+ [Service\-linked roles for Amazon RDS](#security_iam_service-with-iam-roles-service-linked) - -## Amazon RDS identity\-based policies - - -| | | -| --- |--- | -| Supports identity\-based policies | Yes | - -Identity\-based policies are JSON permissions policy documents that you can attach to an identity, such as an IAM user, group of users, or role\. These policies control what actions users and roles can perform, on which resources, and under what conditions\. To learn how to create an identity\-based policy, see [Creating IAM policies](https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies_create.html) in the *IAM User Guide*\. - -With IAM identity\-based policies, you can specify allowed or denied actions and resources as well as the conditions under which actions are allowed or denied\. You can't specify the principal in an identity\-based policy because it applies to the user or role to which it is attached\. To learn about all of the elements that you can use in a JSON policy, see [IAM JSON policy elements reference](https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies_elements.html) in the *IAM User Guide*\. - -### Identity\-based policy examples for Amazon RDS - -To view examples of Amazon RDS identity\-based policies, see [Identity\-based policy examples for Amazon RDS](security_iam_id-based-policy-examples.md)\. - -## Resource\-based policies within Amazon RDS - - -| | | -| --- |--- | -| Supports resource\-based policies | No | - -Resource\-based policies are JSON policy documents that you attach to a resource\. Examples of resource\-based policies are IAM *role trust policies* and Amazon S3 *bucket policies*\. In services that support resource\-based policies, service administrators can use them to control access to a specific resource\. For the resource where the policy is attached, the policy defines what actions a specified principal can perform on that resource and under what conditions\. You must [specify a principal](https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies_elements_principal.html) in a resource\-based policy\. Principals can include accounts, users, roles, federated users, or AWS services\. - -To enable cross\-account access, you can specify an entire account or IAM entities in another account as the principal in a resource\-based policy\. Adding a cross\-account principal to a resource\-based policy is only half of establishing the trust relationship\. When the principal and the resource are in different AWS accounts, an IAM administrator in the trusted account must also grant the principal entity \(user or role\) permission to access the resource\. They grant permission by attaching an identity\-based policy to the entity\. However, if a resource\-based policy grants access to a principal in the same account, no additional identity\-based policy is required\. For more information, see [How IAM roles differ from resource\-based policies ](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_compare-resource-policies.html)in the *IAM User Guide*\. - -## Policy actions for Amazon RDS - - -| | | -| --- |--- | -| Supports policy actions | Yes | - -Administrators can use AWS JSON policies to specify who has access to what\. That is, which **principal** can perform **actions** on what **resources**, and under what **conditions**\. - -The `Action` element of a JSON policy describes the actions that you can use to allow or deny access in a policy\. Policy actions usually have the same name as the associated AWS API operation\. There are some exceptions, such as *permission\-only actions* that don't have a matching API operation\. There are also some operations that require multiple actions in a policy\. These additional actions are called *dependent actions*\. - -Include actions in a policy to grant permissions to perform the associated operation\. - -Policy actions in Amazon RDS use the following prefix before the action: `rds:`\. For example, to grant someone permission to describe DB instances with the Amazon RDS `DescribeDBInstances` API operation, you include the `rds:DescribeDBInstances` action in their policy\. Policy statements must include either an `Action` or `NotAction` element\. Amazon RDS defines its own set of actions that describe tasks that you can perform with this service\. - -To specify multiple actions in a single statement, separate them with commas as follows\. - -``` -"Action": [ - "rds:action1", - "rds:action2" -``` - -You can specify multiple actions using wildcards \(\*\)\. For example, to specify all actions that begin with the word `Describe`, include the following action\. - -``` -"Action": "rds:Describe*" -``` - - - -To see a list of Amazon RDS actions, see [Actions Defined by Amazon RDS](https://docs.aws.amazon.com/service-authorization/latest/reference/list_amazonrds.html#amazonrds-actions-as-permissions) in the *Service Authorization Reference*\. - -## Policy resources for Amazon RDS - - -| | | -| --- |--- | -| Supports policy resources | Yes | - -Administrators can use AWS JSON policies to specify who has access to what\. That is, which **principal** can perform **actions** on what **resources**, and under what **conditions**\. - -The `Resource` JSON policy element specifies the object or objects to which the action applies\. Statements must include either a `Resource` or a `NotResource` element\. As a best practice, specify a resource using its [Amazon Resource Name \(ARN\)](https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html)\. You can do this for actions that support a specific resource type, known as *resource\-level permissions*\. - -For actions that don't support resource\-level permissions, such as listing operations, use a wildcard \(\*\) to indicate that the statement applies to all resources\. - -``` -"Resource": "*" -``` - -The DB instance resource has the following Amazon Resource Name \(ARN\)\. - -``` -arn:${Partition}:rds:${Region}:${Account}:{ResourceType}/${Resource} -``` - -For more information about the format of ARNs, see [Amazon Resource Names \(ARNs\) and AWS service namespaces](https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html)\. - -For example, to specify the `dbtest` DB instance in your statement, use the following ARN\. - -``` -"Resource": "arn:aws:rds:us-west-2:123456789012:db:dbtest" -``` - -To specify all DB instances that belong to a specific account, use the wildcard \(\*\)\. - -``` -"Resource": "arn:aws:rds:us-east-1:123456789012:db:*" -``` - -Some RDS API operations, such as those for creating resources, can't be performed on a specific resource\. In those cases, use the wildcard \(\*\)\. - -``` -"Resource": "*" -``` - -Many Amazon RDS API operations involve multiple resources\. For example, `CreateDBInstance` creates a DB instance\. You can specify that an user must use a specific security group and parameter group when creating a DB instance\. To specify multiple resources in a single statement, separate the ARNs with commas\. - -``` -"Resource": [ - "resource1", - "resource2" -``` - -To see a list of Amazon RDS resource types and their ARNs, see [Resources Defined by Amazon RDS](https://docs.aws.amazon.com/service-authorization/latest/reference/list_amazonrds.html#amazonrds-resources-for-iam-policies) in the *Service Authorization Reference*\. To learn with which actions you can specify the ARN of each resource, see [Actions Defined by Amazon RDS](https://docs.aws.amazon.com/service-authorization/latest/reference/list_amazonrds.html#amazonrds-actions-as-permissions)\. - -## Policy condition keys for Amazon RDS - - -| | | -| --- |--- | -| Supports service\-specific policy condition keys | Yes | - -Administrators can use AWS JSON policies to specify who has access to what\. That is, which **principal** can perform **actions** on what **resources**, and under what **conditions**\. - -The `Condition` element \(or `Condition` *block*\) lets you specify conditions in which a statement is in effect\. The `Condition` element is optional\. You can create conditional expressions that use [condition operators](https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies_elements_condition_operators.html), such as equals or less than, to match the condition in the policy with values in the request\. - -If you specify multiple `Condition` elements in a statement, or multiple keys in a single `Condition` element, AWS evaluates them using a logical `AND` operation\. If you specify multiple values for a single condition key, AWS evaluates the condition using a logical `OR` operation\. All of the conditions must be met before the statement's permissions are granted\. - - You can also use placeholder variables when you specify conditions\. For example, you can grant an IAM user permission to access a resource only if it is tagged with their IAM user name\. For more information, see [IAM policy elements: variables and tags](https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies_variables.html) in the *IAM User Guide*\. - -AWS supports global condition keys and service\-specific condition keys\. To see all AWS global condition keys, see [AWS global condition context keys](https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies_condition-keys.html) in the *IAM User Guide*\. - -Amazon RDS defines its own set of condition keys and also supports using some global condition keys\. To see all AWS global condition keys, see [AWS global condition context keys](https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies_condition-keys.html) in the *IAM User Guide*\. - - - - All RDS API operations support the `aws:RequestedRegion` condition key\. - -To see a list of Amazon RDS condition keys, see [Condition Keys for Amazon RDS](https://docs.aws.amazon.com/service-authorization/latest/reference/list_amazonrds.html#amazonrds-policy-keys) in the *Service Authorization Reference*\. To learn with which actions and resources you can use a condition key, see [Actions Defined by Amazon RDS](https://docs.aws.amazon.com/service-authorization/latest/reference/list_amazonrds.html#amazonrds-actions-as-permissions)\. - -## Access control lists \(ACLs\) in Amazon RDS - - -| | | -| --- |--- | -| Supports access control lists \(ACLs\) | No | - -Access control lists \(ACLs\) control which principals \(account members, users, or roles\) have permissions to access a resource\. ACLs are similar to resource\-based policies, although they do not use the JSON policy document format\. - -## Attribute\-based access control \(ABAC\) in policies with Amazon RDS tags - - -| | | -| --- |--- | -| Supports attribute\-based access control \(ABAC\) tags in policies | Yes | - -Attribute\-based access control \(ABAC\) is an authorization strategy that defines permissions based on attributes\. In AWS, these attributes are called *tags*\. You can attach tags to IAM entities \(users or roles\) and to many AWS resources\. Tagging entities and resources is the first step of ABAC\. Then you design ABAC policies to allow operations when the principal's tag matches the tag on the resource that they are trying to access\. - -ABAC is helpful in environments that are growing rapidly and helps with situations where policy management becomes cumbersome\. - -To control access based on tags, you provide tag information in the [condition element](https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies_elements_condition.html) of a policy using the `aws:ResourceTag/key-name`, `aws:RequestTag/key-name`, or `aws:TagKeys` condition keys\. - -If a service supports all three condition keys for every resource type, then the value is **Yes** for the service\. If a service supports all three condition keys for only some resource types, then the value is **Partial**\. - -For more information about ABAC, see [What is ABAC?](https://docs.aws.amazon.com/IAM/latest/UserGuide/introduction_attribute-based-access-control.html) in the *IAM User Guide*\. To view a tutorial with steps for setting up ABAC, see [Use attribute\-based access control \(ABAC\)](https://docs.aws.amazon.com/IAM/latest/UserGuide/tutorial_attribute-based-access-control.html) in the *IAM User Guide*\. - -For more information about tagging Amazon RDS resources, see [Specifying conditions: Using custom tags](security_iam_id-based-policy-examples.md#UsingWithRDS.IAM.SpecifyingCustomTags)\. To view an example identity\-based policy for limiting access to a resource based on the tags on that resource, see [Grant permission for actions on a resource with a specific tag with two different values](security_iam_id-based-policy-examples.md#security_iam_id-based-policy-examples-grant-permissions-tags)\. - -## Using temporary credentials with Amazon RDS - - -| | | -| --- |--- | -| Supports temporary credentials | Yes | - -Some AWS services don't work when you sign in using temporary credentials\. For additional information, including which AWS services work with temporary credentials, see [AWS services that work with IAM](https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_aws-services-that-work-with-iam.html) in the *IAM User Guide*\. - -You are using temporary credentials if you sign in to the AWS Management Console using any method except a user name and password\. For example, when you access AWS using your company's single sign\-on \(SSO\) link, that process automatically creates temporary credentials\. You also automatically create temporary credentials when you sign in to the console as a user and then switch roles\. For more information about switching roles, see [Switching to a role \(console\)](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_use_switch-role-console.html) in the *IAM User Guide*\. - -You can manually create temporary credentials using the AWS CLI or AWS API\. You can then use those temporary credentials to access AWS\. AWS recommends that you dynamically generate temporary credentials instead of using long\-term access keys\. For more information, see [Temporary security credentials in IAM](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp.html)\. - -## Cross\-service principal permissions for Amazon RDS - - -| | | -| --- |--- | -| Supports principal permissions | Yes | - - When you use an IAM user or role to perform actions in AWS, you are considered a principal\. Policies grant permissions to a principal\. When you use some services, you might perform an action that then triggers another action in a different service\. In this case, you must have permissions to perform both actions\. To see whether an action requires additional dependent actions in a policy, see [Actions, Resources, and Condition Keys for Amazon RDS](https://docs.aws.amazon.com/service-authorization/latest/reference/list_amazonrds.html.html) in the *Service Authorization Reference*\. - -## Service roles for Amazon RDS - - -| | | -| --- |--- | -| Supports service roles | Yes | - - A service role is an [IAM role](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles.html) that a service assumes to perform actions on your behalf\. An IAM administrator can create, modify, and delete a service role from within IAM\. For more information, see [Creating a role to delegate permissions to an AWS service](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_create_for-service.html) in the *IAM User Guide*\. - -**Warning** -Changing the permissions for a service role might break Amazon RDS functionality\. Edit service roles only when Amazon RDS provides guidance to do so\. - -## Service\-linked roles for Amazon RDS - - -| | | -| --- |--- | -| Supports service\-linked roles | Yes | - - A service\-linked role is a type of service role that is linked to an AWS service\. The service can assume the role to perform an action on your behalf\. Service\-linked roles appear in your AWS account and are owned by the service\. An IAM administrator can view, but not edit the permissions for service\-linked roles\. - -For details about using Amazon RDS service\-linked roles, see [Using service\-linked roles for Amazon RDS](UsingWithRDS.IAM.ServiceLinkedRoles.md)\. \ No newline at end of file diff --git a/doc_source/security_iam_troubleshoot.md b/doc_source/security_iam_troubleshoot.md deleted file mode 100644 index 84141b6..0000000 --- a/doc_source/security_iam_troubleshoot.md +++ /dev/null @@ -1,45 +0,0 @@ -# Troubleshooting Amazon RDS identity and access - -Use the following information to help you diagnose and fix common issues that you might encounter when working with Amazon RDS and IAM\. - -**Topics** -+ [I'm not authorized to perform an action in Amazon RDS](#security_iam_troubleshoot-no-permissions) -+ [I'm not authorized to perform iam:PassRole](#security_iam_troubleshoot-passrole) -+ [I want to allow people outside of my AWS account to access my Amazon RDS resources](#security_iam_troubleshoot-cross-account-access) - -## I'm not authorized to perform an action in Amazon RDS - -If the AWS Management Console tells you that you're not authorized to perform an action, then you must contact your administrator for assistance\. Your administrator is the person that provided you with your sign\-in credentials\. - -The following example error occurs when the `mateojackson` user tries to use the console to view details about a *widget* but does not have `rds:GetWidget` permissions\. - -``` -User: arn:aws:iam::123456789012:user/mateojackson is not authorized to perform: rds:GetWidget on resource: my-example-widget -``` - -In this case, Mateo asks his administrator to update his policies to allow him to access the `my-example-widget` resource using the `rds:GetWidget` action\. - -## I'm not authorized to perform iam:PassRole - -If you receive an error that you're not authorized to perform the `iam:PassRole` action, then you must contact your administrator for assistance\. Your administrator is the person that provided you with your sign\-in credentials\. Ask that person to update your policies to allow you to pass a role to Amazon RDS\. - -Some AWS services allow you to pass an existing role to that service, instead of creating a new service role or service\-linked role\. To do this, you must have permissions to pass the role to the service\. - -The following example error occurs when a user named `marymajor` tries to use the console to perform an action in Amazon RDS\. However, the action requires the service to have permissions granted by a service role\. Mary does not have permissions to pass the role to the service\. - -``` -User: arn:aws:iam::123456789012:user/marymajor is not authorized to perform: iam:PassRole -``` - -In this case, Mary asks her administrator to update her policies to allow her to perform the `iam:PassRole` action\. - -## I want to allow people outside of my AWS account to access my Amazon RDS resources - -You can create a role that users in other accounts or people outside of your organization can use to access your resources\. You can specify who is trusted to assume the role\. For services that support resource\-based policies or access control lists \(ACLs\), you can use those policies to grant people access to your resources\. - -To learn more, consult the following: -+ To learn whether Amazon RDS supports these features, see [How Amazon RDS works with IAM](security_iam_service-with-iam.md)\. -+ To learn how to provide access to your resources across AWS accounts that you own, see [Providing access to an IAM user in another AWS account that you own](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_common-scenarios_aws-accounts.html) in the *IAM User Guide*\. -+ To learn how to provide access to your resources to third\-party AWS accounts, see [Providing access to AWS accounts owned by third parties](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_common-scenarios_third-party.html) in the *IAM User Guide*\. -+ To learn how to provide access through identity federation, see [Providing access to externally authenticated users \(identity federation\)](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_common-scenarios_federated-users.html) in the *IAM User Guide*\. -+ To learn the difference between using roles and resource\-based policies for cross\-account access, see [How IAM roles differ from resource\-based policies](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_compare-resource-policies.html) in the *IAM User Guide*\. \ No newline at end of file diff --git a/doc_source/service_code_examples.md b/doc_source/service_code_examples.md deleted file mode 100644 index fdbec56..0000000 --- a/doc_source/service_code_examples.md +++ /dev/null @@ -1,34 +0,0 @@ -# Code examples for Amazon RDS using AWS SDKs - -The following code examples show how to use Amazon RDS with an AWS software development kit \(SDK\)\. - -*Actions* are code excerpts from larger programs and must be run in context\. While actions show you how to call individual service functions, you can see actions in context in their related scenarios and cross\-service examples\. - -*Scenarios* are code examples that show you how to accomplish a specific task by calling multiple functions within the same service\. - -*Cross\-service examples* are sample applications that work across multiple AWS services\. - -For a complete list of AWS SDK developer guides and code examples, see [Using this service with an AWS SDK](CHAP_Tutorials.md#sdk-general-information-section)\. This topic also includes information about getting started and details about previous SDK versions\. - -**Contents** -+ [Actions](service_code_examples_actions.md) - + [Create a DB instance](example_rds_CreateDBInstance_section.md) - + [Create a DB parameter group](example_rds_CreateDBParameterGroup_section.md) - + [Create a snapshot of a DB instance](example_rds_CreateDBSnapshot_section.md) - + [Create an authentication token](example_rds_GenerateRDSAuthToken_section.md) - + [Delete a DB instance](example_rds_DeleteDBInstance_section.md) - + [Delete a DB parameter group](example_rds_DeleteDBParameterGroup_section.md) - + [Describe DB instances](example_rds_DescribeDBInstances_section.md) - + [Describe DB parameter groups](example_rds_DescribeDBParameterGroups_section.md) - + [Describe database engine versions](example_rds_DescribeDBEngineVersions_section.md) - + [Describe options for DB instances](example_rds_DescribeOrderableDBInstanceOptions_section.md) - + [Describe parameters in a DB parameter group](example_rds_DescribeDBParameters_section.md) - + [Describe snapshots of DB instances](example_rds_DescribeDBSnapshots_section.md) - + [Modify a DB instance](example_rds_ModifyDBInstance_section.md) - + [Reboot a DB instance](example_rds_RebootDBInstance_section.md) - + [Retrieve attributes](example_rds_DescribeAccountAttributes_section.md) - + [Update parameters in a DB parameter group](example_rds_ModifyDBParameterGroup_section.md) -+ [Scenarios](service_code_examples_scenarios.md) - + [Get started with DB instances](example_rds_Scenario_GetStartedInstances_section.md) -+ [Cross\-service examples](service_code_examples_cross-service_examples.md) - + [Create an Aurora Serverless work item tracker](example_cross_RDSDataTracker_section.md) \ No newline at end of file diff --git a/doc_source/service_code_examples_actions.md b/doc_source/service_code_examples_actions.md deleted file mode 100644 index fd9429f..0000000 --- a/doc_source/service_code_examples_actions.md +++ /dev/null @@ -1,23 +0,0 @@ -# Actions for Amazon RDS using AWS SDKs - -The following code examples demonstrate how to perform individual Amazon RDS actions with AWS SDKs\. These excerpts call the Amazon RDS API and are not intended to be run in isolation\. Each example includes a link to GitHub, where you can find instructions on how to set up and run the code in context\. - - The following examples include only the most commonly used actions\. For a complete list, see the [Amazon Relational Database Service \(Amazon RDS\) API Reference](https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/Welcome.html)\. - -**Topics** -+ [Create a DB instance](example_rds_CreateDBInstance_section.md) -+ [Create a DB parameter group](example_rds_CreateDBParameterGroup_section.md) -+ [Create a snapshot of a DB instance](example_rds_CreateDBSnapshot_section.md) -+ [Create an authentication token](example_rds_GenerateRDSAuthToken_section.md) -+ [Delete a DB instance](example_rds_DeleteDBInstance_section.md) -+ [Delete a DB parameter group](example_rds_DeleteDBParameterGroup_section.md) -+ [Describe DB instances](example_rds_DescribeDBInstances_section.md) -+ [Describe DB parameter groups](example_rds_DescribeDBParameterGroups_section.md) -+ [Describe database engine versions](example_rds_DescribeDBEngineVersions_section.md) -+ [Describe options for DB instances](example_rds_DescribeOrderableDBInstanceOptions_section.md) -+ [Describe parameters in a DB parameter group](example_rds_DescribeDBParameters_section.md) -+ [Describe snapshots of DB instances](example_rds_DescribeDBSnapshots_section.md) -+ [Modify a DB instance](example_rds_ModifyDBInstance_section.md) -+ [Reboot a DB instance](example_rds_RebootDBInstance_section.md) -+ [Retrieve attributes](example_rds_DescribeAccountAttributes_section.md) -+ [Update parameters in a DB parameter group](example_rds_ModifyDBParameterGroup_section.md) \ No newline at end of file diff --git a/doc_source/service_code_examples_cross-service_examples.md b/doc_source/service_code_examples_cross-service_examples.md deleted file mode 100644 index 2a1843f..0000000 --- a/doc_source/service_code_examples_cross-service_examples.md +++ /dev/null @@ -1,6 +0,0 @@ -# Cross\-service examples for Amazon RDS using AWS SDKs - -The following sample applications use AWS SDKs to combine Amazon RDS with other AWS services\. Each example includes a link to GitHub, where you can find instructions on how to set up and run the application\. - -**Topics** -+ [Create an Aurora Serverless work item tracker](example_cross_RDSDataTracker_section.md) \ No newline at end of file diff --git a/doc_source/service_code_examples_scenarios.md b/doc_source/service_code_examples_scenarios.md deleted file mode 100644 index 38ac071..0000000 --- a/doc_source/service_code_examples_scenarios.md +++ /dev/null @@ -1,6 +0,0 @@ -# Scenarios for Amazon RDS using AWS SDKs - -The following code examples show you how to implement common scenarios in Amazon RDS with AWS SDKs\. These scenarios show you how to accomplish specific tasks by calling multiple functions within Amazon RDS\. Each scenario includes a link to GitHub, where you can find instructions on how to set up and run the code\. - -**Topics** -+ [Get started with DB instances](example_rds_Scenario_GetStartedInstances_section.md) \ No newline at end of file diff --git a/doc_source/sql-statistics.md b/doc_source/sql-statistics.md deleted file mode 100644 index cfb631c..0000000 --- a/doc_source/sql-statistics.md +++ /dev/null @@ -1,18 +0,0 @@ -# SQL statistics for Performance Insights - -*SQL statistics* are performance\-related metrics about SQL queries that are collected by Performance Insights\. Performance Insights gathers statistics for each second that a query is running and for each SQL call\. The SQL statistics are an average for the selected time range\. - -A SQL digest is a composite of all queries having a given pattern but not necessarily having the same literal values\. The digest replaces literal values with a question mark\. For example, `SELECT * FROM emp WHERE lname= ?`\. This digest might consist of the following child queries: - -``` - SELECT * FROM emp WHERE lname = 'Sanchez' - SELECT * FROM emp WHERE lname = 'Olagappan' - SELECT * FROM emp WHERE lname = 'Wu' -``` - -All engines support SQL statistics for digest queries\. - -**Topics** -+ [SQL statistics for MariaDB and MySQL](USER_PerfInsights.UsingDashboard.AnalyzeDBLoad.AdditionalMetrics.MySQL.md) -+ [SQL statistics for Oracle](USER_PerfInsights.UsingDashboard.AnalyzeDBLoad.AdditionalMetrics.Oracle.md) -+ [SQL statistics for RDS PostgreSQL](USER_PerfInsights.UsingDashboard.AnalyzeDBLoad.AdditionalMetrics.PostgreSQL.md) \ No newline at end of file diff --git a/doc_source/ssl-certificate-rotation-mariadb.md b/doc_source/ssl-certificate-rotation-mariadb.md deleted file mode 100644 index 596e461..0000000 --- a/doc_source/ssl-certificate-rotation-mariadb.md +++ /dev/null @@ -1,115 +0,0 @@ -# Using new SSL/TLS certificates for MariaDB DB instances - -As of September 19, 2019, Amazon RDS has published new Certificate Authority \(CA\) certificates for connecting to your RDS DB instances using Secure Socket Layer or Transport Layer Security \(SSL/TLS\)\. Following, you can find information about updating your applications to use the new certificates\. - -This topic can help you to determine whether your applications require certificate verification to connect to your DB instances\. - -**Note** -Some applications are configured to connect to MariaDB only if they can successfully verify the certificate on the server\. For such applications, you must update your client application trust stores to include the new CA certificates\. -You can specify the following SSL modes: `disabled`, `preferred`, and `required`\. When you use the `preferred` SSL mode and the CA certificate doesn't exist or isn't up to date, the connection falls back to not using SSL and still connects successfully\. -We recommend avoiding `preferred` mode\. In `preferred` mode, if the connection encounters an invalid certificate, it stops using encryption and proceeds unencrypted\. - -After you update your CA certificates in the client application trust stores, you can rotate the certificates on your DB instances\. We strongly recommend testing these procedures in a development or staging environment before implementing them in your production environments\. - -For more information about certificate rotation, see [Rotating your SSL/TLS certificate](UsingWithRDS.SSL-certificate-rotation.md)\. For more information about downloading certificates, see [Using SSL/TLS to encrypt a connection to a DB instance](UsingWithRDS.SSL.md)\. For information about using SSL/TLS with MariaDB DB instances, see [Using SSL/TLS with a MariaDB DB instance](mariadb-ssl-connections.md#MariaDB.Concepts.SSLSupport)\. - -**Topics** -+ [Determining whether a client requires certificate verification in order to connect](#ssl-certificate-rotation-mariadb.determining) -+ [Updating your application trust store](#ssl-certificate-rotation-mariadb.updating-trust-store) -+ [Example Java code for establishing SSL connections](#ssl-certificate-rotation-mariadb.java-example) - -## Determining whether a client requires certificate verification in order to connect - -You can check whether JDBC clients and MySQL clients require certificate verification to connect\. - -### JDBC - -The following example with MySQL Connector/J 8\.0 shows one way to check an application's JDBC connection properties to determine whether successful connections require a valid certificate\. For more information on all of the JDBC connection options for MySQL, see [ Configuration properties](https://dev.mysql.com/doc/connector-j/8.0/en/connector-j-reference-configuration-properties.html) in the MySQL documentation\. - -When using the MySQL Connector/J 8\.0, an SSL connection requires verification against the server CA certificate if your connection properties have `sslMode` set to `VERIFY_CA` or `VERIFY_IDENTITY`, as in the following example\. - -``` -Properties properties = new Properties(); -properties.setProperty("sslMode", "VERIFY_IDENTITY"); -properties.put("user", DB_USER); -properties.put("password", DB_PASSWORD); -``` - -**Note** -If you use either the MySQL Java Connector v5\.1\.38 or later, or the MySQL Java Connector v8\.0\.9 or later to connect to your databases, even if you haven't explicitly configured your applications to use SSL/TLS when connecting to your databases, these client drivers default to using SSL/TLS\. In addition, when using SSL/TLS, they perform partial certificate verification and fail to connect if the database server certificate is expired\. - -### MySQL - -The following examples with the MySQL Client show two ways to check a script's MySQL connection to determine whether successful connections require a valid certificate\. For more information on all of the connection options with the MySQL Client, see [ Client\-side configuration for encrypted connections](https://dev.mysql.com/doc/refman/8.0/en/using-encrypted-connections.html#using-encrypted-connections-client-side-configuration) in the MySQL documentation\. - -When using the MySQL 5\.7 or MySQL 8\.0 Client, an SSL connection requires verification against the server CA certificate if for the `--ssl-mode` option you specify `VERIFY_CA` or `VERIFY_IDENTITY`, as in the following example\. - -``` -mysql -h mysql-database.rds.amazonaws.com -uadmin -ppassword --ssl-ca=/tmp/ssl-cert.pem --ssl-mode=VERIFY_CA -``` - -When using the MySQL 5\.6 Client, an SSL connection requires verification against the server CA certificate if you specify the `--ssl-verify-server-cert` option, as in the following example\. - -``` -mysql -h mysql-database.rds.amazonaws.com -uadmin -ppassword --ssl-ca=/tmp/ssl-cert.pem --ssl-verify-server-cert -``` - -## Updating your application trust store - -For information about updating the trust store for MySQL applications, see [Using TLS/SSL with MariaDB Connector/J](https://mariadb.com/kb/en/library/using-tls-ssl-with-mariadb-java-connector/) in the MariaDB documentation\. - -For information about downloading the root certificate, see [Using SSL/TLS to encrypt a connection to a DB instance](UsingWithRDS.SSL.md)\. - -For sample scripts that import certificates, see [Sample script for importing certificates into your trust store](UsingWithRDS.SSL-certificate-rotation.md#UsingWithRDS.SSL-certificate-rotation-sample-script)\. - -**Note** -When you update the trust store, you can retain older certificates in addition to adding the new certificates\. - -If you are using the MariaDB Connector/J JDBC driver in an application, set the following properties in the application\. - -``` -System.setProperty("javax.net.ssl.trustStore", certs); -System.setProperty("javax.net.ssl.trustStorePassword", "password"); -``` - -When you start the application, set the following properties\. - -``` -java -Djavax.net.ssl.trustStore=/path_to_truststore/MyTruststore.jks -Djavax.net.ssl.trustStorePassword=my_truststore_password com.companyName.MyApplication -``` - -## Example Java code for establishing SSL connections - -The following code example shows how to set up the SSL connection using JDBC\. - -``` -private static final String DB_USER = "admin"; - - private static final String DB_USER = "user name"; - private static final String DB_PASSWORD = "password"; - // This key store has only the prod root ca. - private static final String KEY_STORE_FILE_PATH = "file-path-to-keystore"; - private static final String KEY_STORE_PASS = "keystore-password"; - - public static void main(String[] args) throws Exception { - Class.forName("org.mariadb.jdbc.Driver"); - - System.setProperty("javax.net.ssl.trustStore", KEY_STORE_FILE_PATH); - System.setProperty("javax.net.ssl.trustStorePassword", KEY_STORE_PASS); - - Properties properties = new Properties(); - properties.put("user", DB_USER); - properties.put("password", DB_PASSWORD); - - - Connection connection = DriverManager.getConnection("jdbc:mysql://ssl-mariadb-public.cni62e2e7kwh.us-east-1.rds.amazonaws.com:3306?useSSL=true",properties); - Statement stmt=connection.createStatement(); - - ResultSet rs=stmt.executeQuery("SELECT 1 from dual"); - - return; - } -``` - -**Important** -After you have determined that your database connections use SSL/TLS and have updated your application trust store, you can update your database to use the rds\-ca\-2019 certificates\. For instructions, see step 3 in [Updating your CA certificate by modifying your DB instance](UsingWithRDS.SSL-certificate-rotation.md#UsingWithRDS.SSL-certificate-rotation-updating)\. \ No newline at end of file diff --git a/doc_source/ssl-certificate-rotation-mysql.md b/doc_source/ssl-certificate-rotation-mysql.md deleted file mode 100644 index 00db5c5..0000000 --- a/doc_source/ssl-certificate-rotation-mysql.md +++ /dev/null @@ -1,166 +0,0 @@ -# Using new SSL/TLS certificates for MySQL DB instances - -As of September 19, 2019, Amazon RDS has published new Certificate Authority \(CA\) certificates for connecting to your RDS DB instances using Secure Socket Layer or Transport Layer Security \(SSL/TLS\)\. Following, you can find information about updating your applications to use the new certificates\. - -This topic can help you to determine whether any client applications use SSL/TLS to connect to your DB instances\. If they do, you can further check whether those applications require certificate verification to connect\. - -**Note** -Some applications are configured to connect to MySQL DB instances only if they can successfully verify the certificate on the server\. For such applications, you must update your client application trust stores to include the new CA certificates\. -You can specify the following SSL modes: `disabled`, `preferred`, and `required`\. When you use the `preferred` SSL mode and the CA certificate doesn't exist or isn't up to date, the connection falls back to not using SSL and connects without encryption\. -Because these later versions use the OpenSSL protocol, an expired server certificate doesn't prevent successful connections unless the `required` SSL mode is specified\. -We recommend avoiding `preferred` mode\. In `preferred` mode, if the connection encounters an invalid certificate, it stops using encryption and proceeds unencrypted\. - -After you update your CA certificates in the client application trust stores, you can rotate the certificates on your DB instances\. We strongly recommend testing these procedures in a development or staging environment before implementing them in your production environments\. - -For more information about certificate rotation, see [Rotating your SSL/TLS certificate](UsingWithRDS.SSL-certificate-rotation.md)\. For more information about downloading certificates, see [Using SSL/TLS to encrypt a connection to a DB instance](UsingWithRDS.SSL.md)\. For information about using SSL/TLS with MySQL DB instances, see [Using SSL/TLS with a MySQL DB instance](mysql-ssl-connections.md#MySQL.Concepts.SSLSupport)\. - -**Topics** -+ [Determining whether any applications are connecting to your MySQL DB instance using SSL](#ssl-certificate-rotation-mysql.determining-server) -+ [Determining whether a client requires certificate verification to connect](#ssl-certificate-rotation-mysql.determining-client) -+ [Updating your application trust store](#ssl-certificate-rotation-mysql.updating-trust-store) -+ [Example Java code for establishing SSL connections](#ssl-certificate-rotation-mysql.java-example) - -## Determining whether any applications are connecting to your MySQL DB instance using SSL - -If you are using Amazon RDS for MySQL version 5\.7 or 8\.0 and the Performance Schema is enabled, run the following query to check if connections are using SSL/TLS\. For information about enabling the Performance Schema, see [ Performance Schema quick start](https://dev.mysql.com/doc/refman/8.0/en/performance-schema-quick-start.html) in the MySQL documentation\. - -``` -mysql> SELECT id, user, host, connection_type - FROM performance_schema.threads pst - INNER JOIN information_schema.processlist isp - ON pst.processlist_id = isp.id; -``` - -In this sample output, you can see both your own session \(`admin`\) and an application logged in as `webapp1` are using SSL\. - -``` -+----+-----------------+------------------+-----------------+ -| id | user | host | connection_type | -+----+-----------------+------------------+-----------------+ -| 8 | admin | 10.0.4.249:42590 | SSL/TLS | -| 4 | event_scheduler | localhost | NULL | -| 10 | webapp1 | 159.28.1.1:42189 | SSL/TLS | -+----+-----------------+------------------+-----------------+ -3 rows in set (0.00 sec) -``` - -## Determining whether a client requires certificate verification to connect - -You can check whether JDBC clients and MySQL clients require certificate verification to connect\. - -### JDBC - -The following example with MySQL Connector/J 8\.0 shows one way to check an application's JDBC connection properties to determine whether successful connections require a valid certificate\. For more information on all of the JDBC connection options for MySQL, see [ Configuration properties](https://dev.mysql.com/doc/connector-j/8.0/en/connector-j-reference-configuration-properties.html) in the MySQL documentation\. - -When using the MySQL Connector/J 8\.0, an SSL connection requires verification against the server CA certificate if your connection properties have `sslMode` set to `VERIFY_CA` or `VERIFY_IDENTITY`, as in the following example\. - -``` -Properties properties = new Properties(); -properties.setProperty("sslMode", "VERIFY_IDENTITY"); -properties.put("user", DB_USER); -properties.put("password", DB_PASSWORD); -``` - -**Note** -If you use either the MySQL Java Connector v5\.1\.38 or later, or the MySQL Java Connector v8\.0\.9 or later to connect to your databases, even if you haven't explicitly configured your applications to use SSL/TLS when connecting to your databases, these client drivers default to using SSL/TLS\. In addition, when using SSL/TLS, they perform partial certificate verification and fail to connect if the database server certificate is expired\. - -### MySQL - -The following examples with the MySQL Client show two ways to check a script's MySQL connection to determine whether successful connections require a valid certificate\. For more information on all of the connection options with the MySQL Client, see [ Client\-side configuration for encrypted connections](https://dev.mysql.com/doc/refman/8.0/en/using-encrypted-connections.html#using-encrypted-connections-client-side-configuration) in the MySQL documentation\. - -When using the MySQL 5\.7 or MySQL 8\.0 Client, an SSL connection requires verification against the server CA certificate if for the `--ssl-mode` option you specify `VERIFY_CA` or `VERIFY_IDENTITY`, as in the following example\. - -``` -mysql -h mysql-database.rds.amazonaws.com -uadmin -ppassword --ssl-ca=/tmp/ssl-cert.pem --ssl-mode=VERIFY_CA -``` - -When using the MySQL 5\.6 Client, an SSL connection requires verification against the server CA certificate if you specify the `--ssl-verify-server-cert` option, as in the following example\. - -``` -mysql -h mysql-database.rds.amazonaws.com -uadmin -ppassword --ssl-ca=/tmp/ssl-cert.pem --ssl-verify-server-cert -``` - -## Updating your application trust store - -For information about updating the trust store for MySQL applications, see [Installing SSL certificates](https://dev.mysql.com/doc/mysql-monitor/8.0/en/mem-ssl-installation.html) in the MySQL documentation\. - -For information about downloading the root certificate, see [Using SSL/TLS to encrypt a connection to a DB instance](UsingWithRDS.SSL.md)\. - -For sample scripts that import certificates, see [Sample script for importing certificates into your trust store](UsingWithRDS.SSL-certificate-rotation.md#UsingWithRDS.SSL-certificate-rotation-sample-script)\. - -**Note** -When you update the trust store, you can retain older certificates in addition to adding the new certificates\. - -If you are using the mysql JDBC driver in an application, set the following properties in the application\. - -``` -System.setProperty("javax.net.ssl.trustStore", certs); -System.setProperty("javax.net.ssl.trustStorePassword", "password"); -``` - -When you start the application, set the following properties\. - -``` -java -Djavax.net.ssl.trustStore=/path_to_truststore/MyTruststore.jks -Djavax.net.ssl.trustStorePassword=my_truststore_password com.companyName.MyApplication -``` - -## Example Java code for establishing SSL connections - -The following code example shows how to set up the SSL connection that validates the server certificate using JDBC\. - -``` -public class MySQLSSLTest { - - private static final String DB_USER = "username"; - private static final String DB_PASSWORD = "password"; - // This key store has only the prod root ca. - private static final String KEY_STORE_FILE_PATH = "file-path-to-keystore"; - private static final String KEY_STORE_PASS = "keystore-password"; - - public static void test(String[] args) throws Exception { - Class.forName("com.mysql.jdbc.Driver"); - - System.setProperty("javax.net.ssl.trustStore", KEY_STORE_FILE_PATH); - System.setProperty("javax.net.ssl.trustStorePassword", KEY_STORE_PASS); - - Properties properties = new Properties(); - properties.setProperty("sslMode", "VERIFY_IDENTITY"); - properties.put("user", DB_USER); - properties.put("password", DB_PASSWORD); - - - Connection connection = null; - Statement stmt = null; - ResultSet rs = null; - try { - connection = DriverManager.getConnection("jdbc:mysql://mydatabase.123456789012.us-east-1.rds.amazonaws.com:3306",properties); - stmt = connection.createStatement(); - rs=stmt.executeQuery("SELECT 1 from dual"); - } finally { - if (rs != null) { - try { - rs.close(); - } catch (SQLException e) { - } - } - if (stmt != null) { - try { - stmt.close(); - } catch (SQLException e) { - } - } - if (connection != null) { - try { - connection.close(); - } catch (SQLException e) { - e.printStackTrace(); - } - } - } - return; - } - } -``` - -**Important** -After you have determined that your database connections use SSL/TLS and have updated your application trust store, you can update your database to use the rds\-ca\-2019 certificates\. For instructions, see step 3 in [Updating your CA certificate by modifying your DB instance](UsingWithRDS.SSL-certificate-rotation.md#UsingWithRDS.SSL-certificate-rotation-updating)\. \ No newline at end of file diff --git a/doc_source/ssl-certificate-rotation-oracle.md b/doc_source/ssl-certificate-rotation-oracle.md deleted file mode 100644 index 5feb314..0000000 --- a/doc_source/ssl-certificate-rotation-oracle.md +++ /dev/null @@ -1,123 +0,0 @@ -# Updating your applications to use new SSL/TLS certificates - -As of September 19, 2019, Amazon RDS has published new Certificate Authority \(CA\) certificates for connecting to your RDS DB instances using Secure Socket Layer or Transport Layer Security \(SSL/TLS\)\. Following, you can find information about updating your applications to use the new certificates\. - -This topic can help you to determine whether any client applications use SSL/TLS to connect to your DB instances\. - -**Important** -When you change the certificate for an Amazon RDS for Oracle DB instance, only the database listener is restarted\. The DB instance isn't restarted\. Existing database connections are unaffected, but new connections will encounter errors for a brief period while the listener is restarted\. - -**Note** -For client applications that use SSL/TLS to connect to your DB instances, you must update your client application trust stores to include the new CA certificates\. - -After you update your CA certificates in the client application trust stores, you can rotate the certificates on your DB instances\. We strongly recommend testing these procedures in a development or staging environment before implementing them in your production environments\. - -For more information about certificate rotation, see [Rotating your SSL/TLS certificate](UsingWithRDS.SSL-certificate-rotation.md)\. For more information about downloading certificates, see [Using SSL/TLS to encrypt a connection to a DB instance](UsingWithRDS.SSL.md)\. For information about using SSL/TLS with Oracle DB instances, see [Oracle Secure Sockets Layer](Appendix.Oracle.Options.SSL.md)\. - -**Topics** -+ [Finding out whether applications connect using SSL](#ssl-certificate-rotation-oracle.determining) -+ [Updating your application trust store](#ssl-certificate-rotation-oracle.updating-trust-store) -+ [Example Java code for establishing SSL connections](#ssl-certificate-rotation-oracle.java-example) - -## Finding out whether applications connect using SSL - -If your Oracle DB instance uses an option group with the `SSL` option added, you might be using SSL\. Check this by following the instructions in [Listing the options and option settings for an option group](USER_WorkingWithOptionGroups.md#USER_WorkingWithOptionGroups.ListOption)\. For information about the `SSL` option, see [Oracle Secure Sockets Layer](Appendix.Oracle.Options.SSL.md)\. - -Check the listener log to determine whether there are SSL connections\. The following is sample output in a listener log\. - -``` -date time * (CONNECT_DATA=(CID=(PROGRAM=program) -(HOST=host)(USER=user))(SID=sid)) * -(ADDRESS=(PROTOCOL=tcps)(HOST=host)(PORT=port)) * establish * ORCL * 0 -``` - -When `PROTOCOL` has the value `tcps` for an entry, it shows an SSL connection\. However, when `HOST` is `127.0.0.1`, you can ignore the entry\. Connections from `127.0.0.1` are a local management agent on the DB instance\. These connections aren't external SSL connections\. Therefore, you have applications connecting using SSL if you see listener log entries where `PROTOCOL` is `tcps` and `HOST` is *not* `127.0.0.1`\. - -To check the listener log, you can publish the log to Amazon CloudWatch Logs\. For more information, see [Publishing Oracle logs to Amazon CloudWatch Logs](USER_LogAccess.Concepts.Oracle.md#USER_LogAccess.Oracle.PublishtoCloudWatchLogs)\. - -## Updating your application trust store - -You can update the trust store for applications that use SQL\*Plus or JDBC for SSL/TLS connections\. - -### Updating your application trust store for SQL\*Plus - -You can update the trust store for applications that use SQL\*Plus for SSL/TLS connections\. - -**Note** -When you update the trust store, you can retain older certificates in addition to adding the new certificates\. - -**To update the trust store for SQL\*Plus applications** - -1. Download the 2019 root certificate that works for all AWS Regions and put the file in the `ssl_wallet` directory\. - - For information about downloading the root certificate, see [Using SSL/TLS to encrypt a connection to a DB instance](UsingWithRDS.SSL.md)\. - -1. Run the following command to update the Oracle wallet\. - - ``` - prompt>orapki wallet add -wallet $ORACLE_HOME/ssl_wallet -trusted_cert -cert - $ORACLE_HOME/ssl_wallet/rds-ca-2019-root.pem -auto_login_only - ``` - - Replace the file name with the one that you downloaded\. - -1. Run the following command to confirm that the wallet was updated successfully\. - - ``` - prompt>orapki wallet display -wallet $ORACLE_HOME/ssl_wallet - ``` - - Your output should contain the following\. - - ``` - Trusted Certificates: - Subject: CN=Amazon RDS Root 2019 CA,OU=Amazon RDS,O=Amazon Web Services\, Inc.,L=Seattle,ST=Washington,C=US - ``` - -### Updating your application trust store for JDBC - -You can update the trust store for applications that use JDBC for SSL/TLS connections\. - -For information about downloading the root certificate, see [Using SSL/TLS to encrypt a connection to a DB instance](UsingWithRDS.SSL.md)\. - -For sample scripts that import certificates, see [Sample script for importing certificates into your trust store](UsingWithRDS.SSL-certificate-rotation.md#UsingWithRDS.SSL-certificate-rotation-sample-script)\. - -## Example Java code for establishing SSL connections - -The following code example shows how to set up the SSL connection using JDBC\. - -``` -import java.sql.Connection; -import java.sql.DriverManager; -import java.sql.SQLException; -import java.util.Properties; - -public class OracleSslConnectionTest { - private static final String DB_SERVER_NAME = ""; - private static final Integer SSL_PORT = ""; - private static final String DB_SID = ""; - private static final String DB_USER = ""; - private static final String DB_PASSWORD = ""; - // This key store has only the prod root ca. - private static final String KEY_STORE_FILE_PATH = ""; - private static final String KEY_STORE_PASS = ""; - - public static void main(String[] args) throws SQLException { - final Properties properties = new Properties(); - final String connectionString = String.format( - "jdbc:oracle:thin:@(DESCRIPTION=(ADDRESS=(PROTOCOL=TCPS)(HOST=%s)(PORT=%d))(CONNECT_DATA=(SID=%s)))", - DB_SERVER_NAME, SSL_PORT, DB_SID); - properties.put("user", DB_USER); - properties.put("password", DB_PASSWORD); - properties.put("oracle.jdbc.J2EE13Compliant", "true"); - properties.put("javax.net.ssl.trustStore", KEY_STORE_FILE_PATH); - properties.put("javax.net.ssl.trustStoreType", "JKS"); - properties.put("javax.net.ssl.trustStorePassword", KEY_STORE_PASS); - final Connection connection = DriverManager.getConnection(connectionString, properties); - // If no exception, that means handshake has passed, and an SSL connection can be opened - } -} -``` - -**Important** -After you have determined that your database connections use SSL/TLS and have updated your application trust store, you can update your database to use the rds\-ca\-2019 certificates\. For instructions, see step 3 in [Updating your CA certificate by modifying your DB instance](UsingWithRDS.SSL-certificate-rotation.md#UsingWithRDS.SSL-certificate-rotation-updating)\. \ No newline at end of file diff --git a/doc_source/ssl-certificate-rotation-postgresql.md b/doc_source/ssl-certificate-rotation-postgresql.md deleted file mode 100644 index 5dad041..0000000 --- a/doc_source/ssl-certificate-rotation-postgresql.md +++ /dev/null @@ -1,100 +0,0 @@ -# Updating applications to use new SSL/TLS certificates - -Certificates used for Secure Socket Layer or Transport Layer Security \(SSL/TLS\) typically have a set lifetime\. When service providers update their Certificate Authority \(CA\) certificates, clients must update their applications to use the new certificates\. Following, you can find information about how to determine if your client applications use SSL/TLS to connect to your Amazon RDS for PostgreSQL DB instance\. You also find information about how to check if those applications verify the server certificate when they connect\. - -**Note** -A client application that's configured to verify the server certificate before SSL/TLS connection must have a valid CA certificate in the client's trust store\. Update the client trust store when necessary for new certificates\. - -After you update your CA certificates in the client application trust stores, you can rotate the certificates on your DB instances\. We strongly recommend testing these procedures in a nonproduction environment before implementing them in your production environments\. - -For more information about certificate rotation, see [Rotating your SSL/TLS certificate](UsingWithRDS.SSL-certificate-rotation.md)\. For more information about downloading certificates, see [Using SSL/TLS to encrypt a connection to a DB instance](UsingWithRDS.SSL.md)\. For information about using SSL/TLS with PostgreSQL DB instances, see [Using SSL with a PostgreSQL DB instance](PostgreSQL.Concepts.General.SSL.md)\. - -**Topics** -+ [Determining whether applications are connecting to PostgreSQL DB instances using SSL](#ssl-certificate-rotation-postgresql.determining-server) -+ [Determining whether a client requires certificate verification in order to connect](#ssl-certificate-rotation-postgresql.determining-client) -+ [Updating your application trust store](#ssl-certificate-rotation-postgresql.updating-trust-store) -+ [Using SSL/TLS connections for different types of applications](#ssl-certificate-rotation-postgresql.applications) - -## Determining whether applications are connecting to PostgreSQL DB instances using SSL - -Check the DB instance configuration for the value of the `rds.force_ssl` parameter\. By default, the `rds.force_ssl` parameter is set to `0` \(off\) for DB instances using PostgreSQL versions before version 15\. By default, `rds.force_ssl` is set to `1` \(on\) for DB instances using PostgreSQL version 15 and later major versions\. If the `rds.force_ssl` parameter is set to `1` \(on\), clients are required to use SSL/TLS for connections\. For more information about parameter groups, see [Working with parameter groups](USER_WorkingWithParamGroups.md)\. - -If you are using RDS PostgreSQL version 9\.5 or later major version and `rds.force_ssl` is not set to `1` \(on\), query the `pg_stat_ssl` view to check connections using SSL\. For example, the following query returns only SSL connections and information about the clients using SSL\. - -``` -SELECT datname, usename, ssl, client_addr - FROM pg_stat_ssl INNER JOIN pg_stat_activity ON pg_stat_ssl.pid = pg_stat_activity.pid - WHERE ssl is true and usename<>'rdsadmin'; -``` - -Only rows using SSL/TLS connections are displayed with information about the connection\. The following is sample output\. - -``` - datname | usename | ssl | client_addr -----------+---------+-----+------------- - benchdb | pgadmin | t | 53.95.6.13 - postgres | pgadmin | t | 53.95.6.13 -(2 rows) -``` - -This query displays only the current connections at the time of the query\. The absence of results doesn't indicate that no applications are using SSL connections\. Other SSL connections might be established at a different time\. - -## Determining whether a client requires certificate verification in order to connect - -When a client, such as psql or JDBC, is configured with SSL support, the client first tries to connect to the database with SSL by default\. If the client can't connect with SSL, it reverts to connecting without SSL\. The default `sslmode` mode used is different between libpq\-based clients \(such as psql\) and JDBC\. The libpq\-based clients default to `prefer`, where JDBC clients default to `verify-full`\. The certificate on the server is verified only when `sslrootcert` is provided with `sslmode` set to `require`, `verify-ca`, or `verify-full`\. An error is thrown if the certificate is invalid\. - -Use `PGSSLROOTCERT` to verify the certificate with the `PGSSLMODE` environment variable, with `PGSSLMODE` set to `require`, `verify-ca`, or `verify-full`\. - -``` -PGSSLMODE=require PGSSLROOTCERT=/fullpath/rds-ca-2019-root.pem psql -h pgdbidentifier.cxxxxxxxx.us-east-2.rds.amazonaws.com -U masteruser -d postgres -``` - -Use the `sslrootcert` argument to verify the certificate with `sslmode` in connection string format, with `sslmode` set to `require`, `verify-ca`, or `verify-full` to verify the certificate\. - -``` -psql "host=pgdbidentifier.cxxxxxxxx.us-east-2.rds.amazonaws.com sslmode=require sslrootcert=/full/path/rds-ca-2019-root.pem user=masteruser dbname=postgres" -``` - -For example, in the preceding case, if you are using an invalid root certificate, then you see an error similar to the following on your client\. - -``` -psql: SSL error: certificate verify failed -``` - -## Updating your application trust store - -For information about updating the trust store for PostgreSQL applications, see [Secure TCP/IP connections with SSL](https://www.postgresql.org/docs/current/ssl-tcp.html) in the PostgreSQL documentation\. - -For information about downloading the root certificate, see [Using SSL/TLS to encrypt a connection to a DB instance](UsingWithRDS.SSL.md)\. - -For sample scripts that import certificates, see [Sample script for importing certificates into your trust store](UsingWithRDS.SSL-certificate-rotation.md#UsingWithRDS.SSL-certificate-rotation-sample-script)\. - -**Note** -When you update the trust store, you can retain older certificates in addition to adding the new certificates\. - -## Using SSL/TLS connections for different types of applications - -The following provides information about using SSL/TLS connections for different types of applications: -+ **psql** - - The client is invoked from the command line by specifying options either as a connection string or as environment variables\. For SSL/TLS connections, the relevant options are `sslmode` \(environment variable `PGSSLMODE`\), `sslrootcert` \(environment variable `PGSSLROOTCERT`\)\. - - For the complete list of options, see [Parameter key words](https://www.postgresql.org/docs/current/libpq-connect.html#LIBPQ-PARAMKEYWORDS) in the PostgreSQL documentation\. For the complete list of environment variables, see [Environment variables](https://www.postgresql.org/docs/current/libpq-envars.html) in the PostgreSQL documentation\. -+ **pgAdmin** - - This browser\-based client is a more user\-friendly interface for connecting to a PostgreSQL database\. - - For information about configuring connections, see the [pgAdmin documentation](https://www.pgadmin.org/docs/pgadmin4/latest/server_dialog.html)\. -+ **JDBC** - - JDBC enables database connections with Java applications\. - - For general information about connecting to a PostgreSQL database with JDBC, see [Connecting to the database](https://jdbc.postgresql.org/documentation/use/#connecting-to-the-database) in the PostgreSQL JDBC driver documentation\. For information about connecting with SSL/TLS, see [Configuring the client](https://jdbc.postgresql.org/documentation/ssl/#configuring-the-client) in the PostgreSQL JDBC driver documentation\. -+ **Python** - - A popular Python library for connecting to PostgreSQL databases is `psycopg2`\. - - For information about using `psycopg2`, see the [psycopg2 documentation](https://pypi.org/project/psycopg2/)\. For a short tutorial on how to connect to a PostgreSQL database, see [Psycopg2 tutorial](https://wiki.postgresql.org/wiki/Psycopg2_Tutorial)\. You can find information about the options the connect command accepts in [The psycopg2 module content](http://initd.org/psycopg/docs/module.html#module-psycopg2)\. - -**Important** -After you have determined that your database connections use SSL/TLS and have updated your application trust store, you can update your database to use the rds\-ca\-2019 certificates\. For instructions, see step 3 in [Updating your CA certificate by modifying your DB instance](UsingWithRDS.SSL-certificate-rotation.md#UsingWithRDS.SSL-certificate-rotation-updating)\. \ No newline at end of file diff --git a/doc_source/ssl-certificate-rotation-sqlserver.md b/doc_source/ssl-certificate-rotation-sqlserver.md deleted file mode 100644 index e07c889..0000000 --- a/doc_source/ssl-certificate-rotation-sqlserver.md +++ /dev/null @@ -1,120 +0,0 @@ -# Updating applications to connect to Microsoft SQL Server DB instances using new SSL/TLS certificates - -As of September 19, 2019, Amazon RDS has published new Certificate Authority \(CA\) certificates for connecting to your RDS DB instances using Secure Socket Layer or Transport Layer Security \(SSL/TLS\)\. Following, you can find information about updating your applications to use the new certificates\. - -This topic can help you to determine whether any client applications use SSL/TLS to connect to your DB instances\. If they do, you can further check whether those applications require certificate verification to connect\. - -**Note** -Some applications are configured to connect to SQL Server DB instances only if they can successfully verify the certificate on the server\. **** -For such applications, you must update your client application trust stores to include the new CA certificates\. - -After you update your CA certificates in the client application trust stores, you can rotate the certificates on your DB instances\. We strongly recommend testing these procedures in a development or staging environment before implementing them in your production environments\. - -For more information about certificate rotation, see [Rotating your SSL/TLS certificate](UsingWithRDS.SSL-certificate-rotation.md)\. For more information about downloading certificates, see [Using SSL/TLS to encrypt a connection to a DB instance](UsingWithRDS.SSL.md)\. For information about using SSL/TLS with Microsoft SQL Server DB instances, see [Using SSL with a Microsoft SQL Server DB instance](SQLServer.Concepts.General.SSL.Using.md)\. - -**Topics** -+ [Determining whether any applications are connecting to your Microsoft SQL Server DB instance using SSL](#ssl-certificate-rotation-sqlserver.determining-server) -+ [Determining whether a client requires certificate verification in order to connect](#ssl-certificate-rotation-sqlserver.determining-client) -+ [Updating your application trust store](#ssl-certificate-rotation-sqlserver.updating-trust-store) - -## Determining whether any applications are connecting to your Microsoft SQL Server DB instance using SSL - -Check the DB instance configuration for the value of the `rds.force_ssl` parameter\. By default, the `rds.force_ssl` parameter is set to 0 \(off\)\. If the `rds.force_ssl` parameter is set to 1 \(on\), clients are required to use SSL/TLS for connections\. For more information about parameter groups, see [Working with parameter groups](USER_WorkingWithParamGroups.md)\. - -Run the following query to get the current encryption option for all the open connections to a DB instance\. The column `ENCRYPT_OPTION` returns `TRUE` if the connection is encrypted\. - -``` -select SESSION_ID, - ENCRYPT_OPTION, - NET_TRANSPORT, - AUTH_SCHEME - from SYS.DM_EXEC_CONNECTIONS -``` - -This query shows only the current connections\. It doesn't show whether applications that have connected and disconnected in the past have used SSL\. - -## Determining whether a client requires certificate verification in order to connect - -You can check whether different types of clients require certificate verification to connect\. - -**Note** -If you use connectors other than the ones listed, see the specific connector's documentation for information about how it enforces encrypted connections\. For more information, see [Connection modules for Microsoft SQL databases](https://docs.microsoft.com/en-us/sql/connect/sql-connection-libraries?view=sql-server-ver15) in the Microsoft SQL Server documentation\. - -### SQL Server Management Studio - -Check whether encryption is enforced for SQL Server Management Studio connections: - -1. Launch SQL Server Management Studio\. - -1. For **Connect to server**, enter the server information, login user name, and password\. - -1. Choose **Options**\. - -1. Check if **Encrypt connection** is selected in the connect page\. - -For more information about SQL Server Management Studio, see [Use SQL Server Management Studio](http://msdn.microsoft.com/en-us/library/ms174173.aspx)\. - -### Sqlcmd - -The following example with the `sqlcmd` client shows how to check a script's SQL Server connection to determine whether successful connections require a valid certificate\. For more information, see [Connecting with sqlcmd](https://docs.microsoft.com/en-us/sql/connect/odbc/linux-mac/connecting-with-sqlcmd?view=sql-server-ver15) in the Microsoft SQL Server documentation\. - -When using `sqlcmd`, an SSL connection requires verification against the server certificate if you use the `-N` command argument to encrypt connections, as in the following example\. - -``` -$ sqlcmd -N -S dbinstance.rds.amazon.com -d ExampleDB -``` - -**Note** -If `sqlcmd` is invoked with the `-C` option, it trusts the server certificate, even if that doesn't match the client\-side trust store\. - -### ADO\.NET - -In the following example, the application connects using SSL, and the server certificate must be verified\. - -``` -using SQLC = Microsoft.Data.SqlClient; - -... - - static public void Main() - { - using (var connection = new SQLC.SqlConnection( - "Server=tcp:dbinstance.rds.amazon.com;" + - "Database=ExampleDB;User ID=LOGIN_NAME;" + - "Password=YOUR_PASSWORD;" + - "Encrypt=True;TrustServerCertificate=False;" - )) - { - connection.Open(); - ... - } -``` - -### Java - -In the following example, the application connects using SSL, and the server certificate must be verified\. - -``` -String connectionUrl = - "jdbc:sqlserver://dbinstance.rds.amazon.com;" + - "databaseName=ExampleDB;integratedSecurity=true;" + - "encrypt=true;trustServerCertificate=false"; -``` - -To enable SSL encryption for clients that connect using JDBC, you might need to add the Amazon RDS certificate to the Java CA certificate store\. For instructions, see [Configuring the client for encryption](https://docs.microsoft.com/en-us/SQL/connect/jdbc/configuring-the-client-for-ssl-encryption?view=sql-server-2017) in the Microsoft SQL Server documentation\. You can also provide the trusted CA certificate file name directly by appending `trustStore=path-to-certificate-trust-store-file` to the connection string\. - -**Note** -If you use `TrustServerCertificate=true` \(or its equivalent\) in the connection string, the connection process skips the trust chain validation\. In this case, the application connects even if the certificate can't be verified\. Using `TrustServerCertificate=false` enforces certificate validation and is a best practice\. - -## Updating your application trust store - -You can update the trust store for applications that use Microsoft SQL Server\. For instructions, see [Encrypting specific connections](SQLServer.Concepts.General.SSL.Using.md#SQLServer.Concepts.General.SSL.Client)\. Also, see [Configuring the client for encryption](https://docs.microsoft.com/en-us/SQL/connect/jdbc/configuring-the-client-for-ssl-encryption?view=sql-server-2017) in the Microsoft SQL Server documentation\. - -If you are using an operating system other than Microsoft Windows, see the software distribution documentation for SSL/TLS implementation for information about adding a new root CA certificate\. For example, OpenSSL and GnuTLS are popular options\. Use the implementation method to add trust to the RDS root CA certificate\. Microsoft provides instructions for configuring certificates on some systems\. - -For information about downloading the root certificate, see [Using SSL/TLS to encrypt a connection to a DB instance](UsingWithRDS.SSL.md)\. - -For sample scripts that import certificates, see [Sample script for importing certificates into your trust store](UsingWithRDS.SSL-certificate-rotation.md#UsingWithRDS.SSL-certificate-rotation-sample-script)\. - -**Note** -When you update the trust store, you can retain older certificates in addition to adding the new certificates\. \ No newline at end of file diff --git a/doc_source/vpc-interface-endpoints.md b/doc_source/vpc-interface-endpoints.md deleted file mode 100644 index 023edc1..0000000 --- a/doc_source/vpc-interface-endpoints.md +++ /dev/null @@ -1,112 +0,0 @@ -# Amazon RDS API and interface VPC endpoints \(AWS PrivateLink\) - -You can establish a private connection between your VPC and Amazon RDS API endpoints by creating an *interface VPC endpoint*\. Interface endpoints are powered by [AWS PrivateLink](http://aws.amazon.com/privatelink)\. - -AWS PrivateLink enables you to privately access Amazon RDS API operations without an internet gateway, NAT device, VPN connection, or AWS Direct Connect connection\. DB instances in your VPC don't need public IP addresses to communicate with Amazon RDS API endpoints to launch, modify, or terminate DB instances\. Your DB instances also don't need public IP addresses to use any of the available RDS API operations\. Traffic between your VPC and Amazon RDS doesn't leave the Amazon network\. - -Each interface endpoint is represented by one or more elastic network interfaces in your subnets\. For more information on elastic network interfaces, see [Elastic network interfaces](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/using-eni.html) in the *Amazon EC2 User Guide\.* - -For more information about VPC endpoints, see [Interface VPC endpoints \(AWS PrivateLink\)](https://docs.aws.amazon.com/vpc/latest/userguide/vpce-interface.html) in the *Amazon VPC User Guide*\. For more information about RDS API operations, see [Amazon RDS API Reference](https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/)\. - -You don't need an interface VPC endpoint to connect to a DB instance\. For more information, see [Scenarios for accessing a DB instance in a VPC](USER_VPC.Scenarios.md)\. - -## Considerations for VPC endpoints - -Before you set up an interface VPC endpoint for Amazon RDS API endpoints, ensure that you review [Interface endpoint properties and limitations](https://docs.aws.amazon.com/vpc/latest/userguide/vpce-interface.html#vpce-interface-limitations) in the *Amazon VPC User Guide*\. - -All RDS API operations relevant to managing Amazon RDS resources are available from your VPC using AWS PrivateLink\. - -VPC endpoint policies are supported for RDS API endpoints\. By default, full access to RDS API operations is allowed through the endpoint\. For more information, see [Controlling access to services with VPC endpoints](https://docs.aws.amazon.com/vpc/latest/userguide/vpc-endpoints-access.html) in the *Amazon VPC User Guide*\. - -## Availability - -Amazon RDS API currently supports VPC endpoints in the following AWS Regions: -+ US East \(Ohio\) -+ US East \(N\. Virginia\) -+ US West \(N\. California\) -+ US West \(Oregon\) -+ Africa \(Cape Town\) -+ Asia Pacific \(Hong Kong\) -+ Asia Pacific \(Mumbai\) -+ Asia Pacific \(Osaka\) -+ Asia Pacific \(Seoul\) -+ Asia Pacific \(Singapore\) -+ Asia Pacific \(Sydney\) -+ Asia Pacific \(Tokyo\) -+ Canada \(Central\) -+ Europe \(Frankfurt\) -+ Europe \(Ireland\) -+ Europe \(London\) -+ Europe \(Paris\) -+ Europe \(Stockholm\) -+ Europe \(Milan\) -+ Middle East \(Bahrain\) -+ South America \(São Paulo\) -+ China \(Beijing\) -+ China \(Ningxia\) -+ AWS GovCloud \(US\-East\) -+ AWS GovCloud \(US\-West\) - -## Creating an interface VPC endpoint for Amazon RDS API - -You can create a VPC endpoint for the Amazon RDS API using either the Amazon VPC console or the AWS Command Line Interface \(AWS CLI\)\. For more information, see [Creating an interface endpoint](https://docs.aws.amazon.com/vpc/latest/userguide/vpce-interface.html#create-interface-endpoint) in the *Amazon VPC User Guide*\. - -Create a VPC endpoint for Amazon RDS API using the service name `com.amazonaws.region.rds`\. - -Excluding AWS Regions in China, if you enable private DNS for the endpoint, you can make API requests to Amazon RDS with the VPC endpoint using its default DNS name for the AWS Region, for example `rds.us-east-1.amazonaws.com`\. For the China \(Beijing\) and China \(Ningxia\) AWS Regions, you can make API requests with the VPC endpoint using `rds-api.cn-north-1.amazonaws.com.cn` and `rds-api.cn-northwest-1.amazonaws.com.cn`, respectively\. - -For more information, see [Accessing a service through an interface endpoint](https://docs.aws.amazon.com/vpc/latest/userguide/vpce-interface.html#access-service-though-endpoint) in the *Amazon VPC User Guide*\. - -## Creating a VPC endpoint policy for Amazon RDS API - -You can attach an endpoint policy to your VPC endpoint that controls access to Amazon RDS API\. The policy specifies the following information: -+ The principal that can perform actions\. -+ The actions that can be performed\. -+ The resources on which actions can be performed\. - -For more information, see [Controlling access to services with VPC endpoints](https://docs.aws.amazon.com/vpc/latest/userguide/vpc-endpoints-access.html) in the *Amazon VPC User Guide*\. - -**Example: VPC endpoint policy for Amazon RDS API actions** -The following is an example of an endpoint policy for Amazon RDS API\. When attached to an endpoint, this policy grants access to the listed Amazon RDS API actions for all principals on all resources\. - -``` -{ - "Statement":[ - { - "Principal":"*", - "Effect":"Allow", - "Action":[ - "rds:CreateDBInstance", - "rds:ModifyDBInstance", - "rds:CreateDBSnapshot" - ], - "Resource":"*" - } - ] -} -``` - -**Example: VPC endpoint policy that denies all access from a specified AWS account** -The following VPC endpoint policy denies AWS account `123456789012` all access to resources using the endpoint\. The policy allows all actions from other accounts\. - -``` -{ - "Statement": [ - { - "Action": "*", - "Effect": "Allow", - "Resource": "*", - "Principal": "*" - }, - { - "Action": "*", - "Effect": "Deny", - "Resource": "*", - "Principal": { - "AWS": [ - "123456789012" - ] - } - ] -} -``` \ No newline at end of file diff --git a/doc_source/wait-event.clientread.md b/doc_source/wait-event.clientread.md deleted file mode 100644 index fe984b1..0000000 --- a/doc_source/wait-event.clientread.md +++ /dev/null @@ -1,90 +0,0 @@ -# Client:ClientRead - -The `Client:ClientRead` event occurs when RDS for PostgreSQL is waiting to receive data from the client\. - -**Topics** -+ [Supported engine versions](#wait-event.clientread.context.supported) -+ [Context](#wait-event.clientread.context) -+ [Likely causes of increased waits](#wait-event.clientread.causes) -+ [Actions](#wait-event.clientread.actions) - -## Supported engine versions - -This wait event information is supported for RDS for PostgreSQL version 10 and higher\. - -## Context - -An RDS for PostgreSQL DB instance is waiting to receive data from the client\. The RDS for PostgreSQL DB instance must receive the data from the client before it can send more data to the client\. The time that the instance waits before receiving data from the client is a `Client:ClientRead` event\. - -## Likely causes of increased waits - -Common causes for the `Client:ClientRead` event to appear in top waits include the following: - -**Increased network latency** -There might be increased network latency between the RDS for PostgreSQL DB instance and client\. Higher network latency increases the time required for DB instance to receive data from the client\. - -**Increased load on the client** -There might be CPU pressure or network saturation on the client\. An increase in load on the client can delay transmission of data from the client to the RDS for PostgreSQL DB instance\. - -**Excessive network round trips** -A large number of network round trips between the RDS for PostgreSQL DB instance and the client can delay transmission of data from the client to the RDS for PostgreSQL DB instance\. - -**Large copy operation** -During a copy operation, the data is transferred from the client's file system to the RDS for PostgreSQL DB instance\. Sending a large amount of data to the DB instance can delay transmission of data from the client to the DB instance\. - -**Idle client connection** -When a client connects to the RDS for PostgreSQL DB instance in an `idle in transaction` state, the DB instance might wait for the client to send more data or issue a command\. A connection in this state can lead to an increase in `Client:ClientRead` events\. - -**PgBouncer used for connection pooling** -PgBouncer has a low\-level network configuration setting called `pkt_buf`, which is set to 4,096 by default\. If the workload is sending query packets larger than 4,096 bytes through PgBouncer, we recommend increasing the `pkt_buf` setting to 8,192\. If the new setting doesn't decrease the number of `Client:ClientRead` events, we recommend increasing the `pkt_buf` setting to larger values, such as 16,384 or 32,768\. If the query text is large, the larger setting can be particularly helpful\. - -## Actions - -We recommend different actions depending on the causes of your wait event\. - -**Topics** -+ [Place the clients in the same Availability Zone and VPC subnet as the instance](#wait-event.clientread.actions.az-vpc-subnet) -+ [Scale your client](#wait-event.clientread.actions.scale-client) -+ [Use current generation instances](#wait-event.clientread.actions.db-instance-class) -+ [Increase network bandwidth](#wait-event.clientread.actions.increase-network-bandwidth) -+ [Monitor maximums for network performance](#wait-event.clientread.actions.monitor-network-performance) -+ [Monitor for transactions in the "idle in transaction" state](#wait-event.clientread.actions.check-idle-in-transaction) - -### Place the clients in the same Availability Zone and VPC subnet as the instance - -To reduce network latency and increase network throughput, place clients in the same Availability Zone and virtual private cloud \(VPC\) subnet as the RDS for PostgreSQL DB instance\. Make sure that the clients are as geographically close to the DB instance as possible\. - -### Scale your client - -Using Amazon CloudWatch or other host metrics, determine if your client is currently constrained by CPU or network bandwidth, or both\. If the client is constrained, scale your client accordingly\. - -### Use current generation instances - -In some cases, you might not be using a DB instance class that supports jumbo frames\. If you're running your application on Amazon EC2, consider using a current generation instance for the client\. Also, configure the maximum transmission unit \(MTU\) on the client operating system\. This technique might reduce the number of network round trips and increase network throughput\. For more information, see [ Jumbo frames \(9001 MTU\)](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/network_mtu.html#jumbo_frame_instances) in the *Amazon EC2 User Guide for Linux Instances*\. - -For information about DB instance classes, see [DB instance classes](Concepts.DBInstanceClass.md)\. To determine the DB instance class that is equivalent to an Amazon EC2 instance type, place `db.` before the Amazon EC2 instance type name\. For example, the `r5.8xlarge` Amazon EC2 instance is equivalent to the `db.r5.8xlarge` DB instance class\. - -### Increase network bandwidth - -Use `NetworkReceiveThroughput` and `NetworkTransmitThroughput` Amazon CloudWatch metrics to monitor incoming and outgoing network traffic on the DB instance\. These metrics can help you to determine if network bandwidth is sufficient for your workload\. - -If your network bandwidth isn't enough, increase it\. If the AWS client or your DB instance is reaching the network bandwidth limits, the only way to increase the bandwidth is to increase your DB instance size\. For more information, see [DB instance class types](Concepts.DBInstanceClass.md#Concepts.DBInstanceClass.Types)\. - -For more information about CloudWatch metrics, see [Amazon CloudWatch metrics for Amazon RDS](rds-metrics.md)\. - -### Monitor maximums for network performance - -If you are using Amazon EC2 clients, Amazon EC2 provides maximums for network performance metrics, including aggregate inbound and outbound network bandwidth\. It also provides connection tracking to ensure that packets are returned as expected and link\-local services access for services such as the Domain Name System \(DNS\)\. To monitor these maximums, use a current enhanced networking driver and monitor network performance for your client\. - -For more information, see [ Monitor network performance for your Amazon EC2 instance](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/monitoring-network-performance-ena.html) in the *Amazon EC2 User Guide for Linux Instances* and [Monitor network performance for your Amazon EC2 instance](https://docs.aws.amazon.com/AWSEC2/latest/WindowsGuide/monitoring-network-performance-ena.html) in the *Amazon EC2 User Guide for Windows Instances*\. - -### Monitor for transactions in the "idle in transaction" state - -Check whether you have an increasing number of `idle in transaction` connections\. To do this, monitor the `state` column in the `pg_stat_activity` table\. You might be able to identify the connection source by running a query similar to the following\. - -``` -select client_addr, state, count(1) from pg_stat_activity -where state like 'idle in transaction%' -group by 1,2 -order by 3 desc -``` \ No newline at end of file diff --git a/doc_source/wait-event.clientwrite.md b/doc_source/wait-event.clientwrite.md deleted file mode 100644 index 5e52c62..0000000 --- a/doc_source/wait-event.clientwrite.md +++ /dev/null @@ -1,60 +0,0 @@ -# Client:ClientWrite - -The `Client:ClientWrite` event occurs when RDS for PostgreSQL is waiting to write data to the client\. - -**Topics** -+ [Supported engine versions](#wait-event.clientwrite.context.supported) -+ [Context](#wait-event.clientwrite.context) -+ [Likely causes of increased waits](#wait-event.clientwrite.causes) -+ [Actions](#wait-event.clientwrite.actions) - -## Supported engine versions - -This wait event information is supported for RDS for PostgreSQL version 10 and higher\. - -## Context - -A client process must read all of the data received from an RDS for PostgreSQL DB cluster before the cluster can send more data\. The time that the cluster waits before sending more data to the client is a `Client:ClientWrite` event\. - -Reduced network throughput between the RDS for PostgreSQL DB instance and the client can cause this event\. CPU pressure and network saturation on the client can also cause this event\. *CPU pressure* is when the CPU is fully utilized and there are tasks waiting for CPU time\. *Network saturation* is when the network between the database and client is carrying more data than it can handle\. - -## Likely causes of increased waits - -Common causes for the `Client:ClientWrite` event to appear in top waits include the following: - -**Increased network latency** -There might be increased network latency between the RDS for PostgreSQL DB instance and client\. Higher network latency increases the time required for the client to receive the data\. - -**Increased load on the client** -There might be CPU pressure or network saturation on the client\. An increase in load on the client delays the reception of data from the RDS for PostgreSQL DB instance\. - -**Large volume of data sent to the client** -The RDS for PostgreSQL DB instance might be sending a large amount of data to the client\. A client might not be able to receive the data as fast as the cluster is sending it\. Activities such as a copy of a large table can result in an increase in `Client:ClientWrite` events\. - -## Actions - -We recommend different actions depending on the causes of your wait event\. - -**Topics** -+ [Place the clients in the same Availability Zone and VPC subnet as the cluster](#wait-event.clientwrite.actions.az-vpc-subnet) -+ [Use current generation instances](#wait-event.clientwrite.actions.db-instance-class) -+ [Reduce the amount of data sent to the client](#wait-event.clientwrite.actions.reduce-data) -+ [Scale your client](#wait-event.clientwrite.actions.scale-client) - -### Place the clients in the same Availability Zone and VPC subnet as the cluster - -To reduce network latency and increase network throughput, place clients in the same Availability Zone and virtual private cloud \(VPC\) subnet as the RDS for PostgreSQL DB instance\. - -### Use current generation instances - -In some cases, you might not be using a DB instance class that supports jumbo frames\. If you're running your application on Amazon EC2, consider using a current generation instance for the client\. Also, configure the maximum transmission unit \(MTU\) on the client operating system\. This technique might reduce the number of network round trips and increase network throughput\. For more information, see [ Jumbo frames \(9001 MTU\)](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/network_mtu.html#jumbo_frame_instances) in the *Amazon EC2 User Guide for Linux Instances*\. - -For information about DB instance classes, see [DB instance classes](Concepts.DBInstanceClass.md)\. To determine the DB instance class that is equivalent to an Amazon EC2 instance type, place `db.` before the Amazon EC2 instance type name\. For example, the `r5.8xlarge` Amazon EC2 instance is equivalent to the `db.r5.8xlarge` DB instance class\. - -### Reduce the amount of data sent to the client - -When possible, adjust your application to reduce the amount of data that the RDS for PostgreSQL DB instance sends to the client\. Making such adjustments relieves CPU and network contention on the client\. - -### Scale your client - -Using Amazon CloudWatch or other host metrics, determine if your client is currently constrained by CPU or network bandwidth, or both\. If the client is constrained, scale your client accordingly\. \ No newline at end of file diff --git a/doc_source/wait-event.cpu.md b/doc_source/wait-event.cpu.md deleted file mode 100644 index 637f213..0000000 --- a/doc_source/wait-event.cpu.md +++ /dev/null @@ -1,171 +0,0 @@ -# CPU - -This event occurs when a thread is active in CPU or is waiting for CPU\. - -**Topics** -+ [Supported engine versions](#wait-event.cpu.context.supported) -+ [Context](#wait-event.cpu.context) -+ [Likely causes of increased waits](#wait-event.cpu.causes) -+ [Actions](#wait-event.cpu.actions) - -## Supported engine versions - -This wait event information is relevant for all all versions of RDS for PostgreSQL\. - -## Context - -The *central processing unit \(CPU\)* is the component of a computer that runs instructions\. For example, CPU instructions perform arithmetic operations and exchange data in memory\. If a query increases the number of instructions that it performs through the database engine, the time spent running the query increases\. *CPU scheduling* is giving CPU time to a process\. Scheduling is orchestrated by the kernel of the operating system\. - -**Topics** -+ [How to tell when this wait occurs](#wait-event.cpu.when-it-occurs) -+ [DBLoadCPU metric](#wait-event.cpu.context.dbloadcpu) -+ [os\.cpuUtilization metrics](#wait-event.cpu.context.osmetrics) -+ [Likely cause of CPU scheduling](#wait-event.cpu.context.scheduling) - -### How to tell when this wait occurs - -This `CPU` wait event indicates that a backend process is active in CPU or is waiting for CPU\. You know that it's occurring when a query shows the following information: -+ The `pg_stat_activity.state` column has the value `active`\. -+ The `wait_event_type` and `wait_event` columns in `pg_stat_activity` are both `null`\. - -To see the backend processes that are using or waiting on CPU, run the following query\. - -``` -SELECT * -FROM pg_stat_activity -WHERE state = 'active' -AND wait_event_type IS NULL -AND wait_event IS NULL; -``` - -### DBLoadCPU metric - -The Performance Insights metric for CPU is `DBLoadCPU`\. The value for `DBLoadCPU` can differ from the value for the Amazon CloudWatch metric `CPUUtilization`\. The latter metric is collected from the HyperVisor for a database instance\. - -### os\.cpuUtilization metrics - -Performance Insights operating\-system metrics provide detailed information about CPU utilization\. For example, you can display the following metrics: -+ `os.cpuUtilization.nice.avg` -+ `os.cpuUtilization.total.avg` -+ `os.cpuUtilization.wait.avg` -+ `os.cpuUtilization.idle.avg` - -Performance Insights reports the CPU usage by the database engine as `os.cpuUtilization.nice.avg`\. - -### Likely cause of CPU scheduling - - The operating system \(OS\) kernel handles scheduling for the CPU\. When the CPU is *active*, a process might need to wait to get scheduled\. The CPU is active while it's performing computations\. It's also active while it has an idle thread that it's not running, that is, an idle thread that's waiting on memory I/O\. This type of I/O dominates the typical database workload\. - -Processes are likely to wait to get scheduled on a CPU when the following conditions are met: -+ The CloudWatch `CPUUtilization` metric is near 100 percent\. -+ The average load is greater than the number of vCPUs, indicating a heavy load\. You can find the `loadAverageMinute` metric in the OS metrics section in Performance Insights\. - -## Likely causes of increased waits - -When the CPU wait event occurs more than normal, possibly indicating a performance problem, typical causes include the following\. - -**Topics** -+ [Likely causes of sudden spikes](#wait-event.cpu.causes.spikes) -+ [Likely causes of long\-term high frequency](#wait-event.cpu.causes.long-term) -+ [Corner cases](#wait-event.cpu.causes.corner-cases) - -### Likely causes of sudden spikes - -The most likely causes of sudden spikes are as follows: -+ Your application has opened too many simultaneous connections to the database\. This scenario is known as a "connection storm\." -+ Your application workload changed in any of the following ways: - + New queries - + An increase in the size of your dataset - + Index maintenance or creation - + New functions - + New operators - + An increase in parallel query execution -+ Your query execution plans have changed\. In some cases, a change can cause an increase in buffers\. For example, the query is now using a sequential scan when it previously used an index\. In this case, the queries need more CPU to accomplish the same goal\. - -### Likely causes of long\-term high frequency - -The most likely causes of events that recur over a long period: -+ Too many backend processes are running concurrently on CPU\. These processes can be parallel workers\. -+ Queries are performing suboptimally because they need a large number of buffers\. - -### Corner cases - -If none of the likely causes turn out to be actual causes, the following situations might be occurring: -+ The CPU is swapping processes in and out\. -+ The CPU might be managing page table entries if the *huge pages* feature has been turned off\. This memory management feature is turned on by default for all DB instance classes other than micro, small, and medium DB instance classes\. For more information, see [Huge pages for RDS for PostgreSQL ](PostgreSQL.Concepts.General.FeatureSupport.md#PostgreSQL.Concepts.General.FeatureSupport.HugePages)\. - -## Actions - -If the `CPU` wait event dominates database activity, it doesn't necessarily indicate a performance problem\. Respond to this event only when performance degrades\. - -**Topics** -+ [Investigate whether the database is causing the CPU increase](#wait-event.cpu.actions.db-CPU) -+ [Determine whether the number of connections increased](#wait-event.cpu.actions.connections) -+ [Respond to workload changes](#wait-event.cpu.actions.workload) - -### Investigate whether the database is causing the CPU increase - -Examine the `os.cpuUtilization.nice.avg` metric in Performance Insights\. If this value is far less than the CPU usage, nondatabase processes are the main contributor to CPU\. - -### Determine whether the number of connections increased - -Examine the `DatabaseConnections` metric in Amazon CloudWatch\. Your action depends on whether the number increased or decreased during the period of increased CPU wait events\. - -#### The connections increased - -If the number of connections went up, compare the number of backend processes consuming CPU to the number of vCPUs\. The following scenarios are possible: -+ The number of backend processes consuming CPU is less than the number of vCPUs\. - - In this case, the number of connections isn't an issue\. However, you might still try to reduce CPU utilization\. -+ The number of backend processes consuming CPU is greater than the number of vCPUs\. - - In this case, consider the following options: - + Decrease the number of backend processes connected to your database\. For example, implement a connection pooling solution such as RDS Proxy\. To learn more, see [Using Amazon RDS Proxy](rds-proxy.md)\. - + Upgrade your instance size to get a higher number of vCPUs\. - + Redirect some read\-only workloads to reader nodes, if applicable\. - -#### The connections didn't increase - -Examine the `blks_hit` metrics in Performance Insights\. Look for a correlation between an increase in `blks_hit` and CPU usage\. The following scenarios are possible: -+ CPU usage and `blks_hit` are correlated\. - - In this case, find the top SQL statements that are linked to the CPU usage, and look for plan changes\. You can use either of the following techniques: - + Explain the plans manually and compare them to the expected execution plan\. - + Look for an increase in block hits per second and local block hits per second\. In the **Top SQL** section of Performance Insights dashboard, choose **Preferences**\. -+ CPU usage and `blks_hit` aren't correlated\. - - In this case, determine whether any of the following occurs: - + The application is rapidly connecting to and disconnecting from the database\. - - Diagnose this behavior by turning on `log_connections` and `log_disconnections`, then analyzing the PostgreSQL logs\. Consider using the `pgbadger` log analyzer\. For more information, see [https://github.com/darold/pgbadger](https://github.com/darold/pgbadger)\. - + The OS is overloaded\. - - In this case, Performance Insights shows that backend processes are consuming CPU for a longer time than usual\. Look for evidence in the Performance Insights `os.cpuUtilization` metrics or the CloudWatch `CPUUtilization` metric\. If the operating system is overloaded, look at Enhanced Monitoring metrics to diagnose further\. Specifically, look at the process list and the percentage of CPU consumed by each process\. - + Top SQL statements are consuming too much CPU\. - - Examine statements that are linked to the CPU usage to see whether they can use less CPU\. Run an `EXPLAIN` command, and focus on the plan nodes that have the most impact\. Consider using a PostgreSQL execution plan visualizer\. To try out this tool, see [http://explain.dalibo.com/](http://explain.dalibo.com/)\. - -### Respond to workload changes - -If your workload has changed, look for the following types of changes: - -New queries -Check whether the new queries are expected\. If so, ensure that their execution plans and the number of executions per second are expected\. - -An increase in the size of the data set -Determine whether partitioning, if it's not already implemented, might help\. This strategy might reduce the number of pages that a query needs to retrieve\. - -Index maintenance or creation -Check whether the schedule for the maintenance is expected\. A best practice is to schedule maintenance activities outside of peak activities\. - -New functions -Check whether these functions perform as expected during testing\. Specifically, check whether the number of executions per second is expected\. - -New operators -Check whether they perform as expected during the testing\. - -An increase in running parallel queries -Determine whether any of the following situations has occurred: -+ The relations or indexes involved have suddenly grown in size so that they differ significantly from `min_parallel_table_scan_size` or `min_parallel_index_scan_size`\. -+ Recent changes have been made to `parallel_setup_cost` or `parallel_tuple_cost`\. -+ Recent changes have been made to `max_parallel_workers` or `max_parallel_workers_per_gather`\. \ No newline at end of file diff --git a/doc_source/wait-event.iobuffile.md b/doc_source/wait-event.iobuffile.md deleted file mode 100644 index 9e06240..0000000 --- a/doc_source/wait-event.iobuffile.md +++ /dev/null @@ -1,208 +0,0 @@ -# IO:BufFileRead and IO:BufFileWrite - -The `IO:BufFileRead` and `IO:BufFileWrite` events occur when RDS for PostgreSQL creates temporary files\. When operations require more memory than the working memory parameters currently define, they write temporary data to persistent storage\. This operation is sometimes called "spilling to disk\." - -**Topics** -+ [Supported engine versions](#wait-event.iobuffile.context.supported) -+ [Context](#wait-event.iobuffile.context) -+ [Likely causes of increased waits](#wait-event.iobuffile.causes) -+ [Actions](#wait-event.iobuffile.actions) - -## Supported engine versions - -This wait event information is supported for all versions of RDS for PostgreSQL\. - -## Context - -`IO:BufFileRead` and `IO:BufFileWrite` relate to the work memory area and maintenance work memory area\. For more information about these local memory areas, see [Resource Consumption](https://www.postgresql.org/docs/current/runtime-config-resource.html) in the PostgreSQL documentation\. - -The default value for `work_mem` is 4 MB\. If one session performs operations in parallel, each worker handling the parallelism uses 4 MB of memory\. For this reason, set `work_mem` carefully\. If you increase the value too much, a database running many sessions might consume too much memory\. If you set the value too low, RDS for PostgreSQL creates temporary files in local storage\. The disk I/O for these temporary files can reduce performance\. - -If you observe the following sequence of events, your database might be generating temporary files: - -1. Sudden and sharp decreases in availability - -1. Fast recovery for the free space - -You might also see a "chainsaw" pattern\. This pattern can indicate that your database is creating small files constantly\. - -## Likely causes of increased waits - -In general, these wait events are caused by operations that consume more memory than the `work_mem` or `maintenance_work_mem` parameters allocate\. To compensate, the operations write to temporary files\. Common causes for the `IO:BufFileRead` and `IO:BufFileWrite` events include the following: - -**Queries that need more memory than exists in the work memory area** -Queries with the following characteristics use the work memory area: -+ Hash joins -+ `ORDER BY` clause -+ `GROUP BY` clause -+ `DISTINCT` -+ Window functions -+ `CREATE TABLE AS SELECT` -+ Materialized view refresh - -**Statements that need more memory than exists in the maintenance work memory area** -The following statements use the maintenance work memory area: -+ `CREATE INDEX` -+ `CLUSTER` - -## Actions - -We recommend different actions depending on the causes of your wait event\. - -**Topics** -+ [Identify the problem](#wait-event.iobuffile.actions.problem) -+ [Examine your join queries](#wait-event.iobuffile.actions.joins) -+ [Examine your ORDER BY and GROUP BY queries](#wait-event.iobuffile.actions.order-by) -+ [Avoid using the DISTINCT operation](#wait-event.iobuffile.actions.distinct) -+ [Consider using window functions instead of GROUP BY functions](#wait-event.iobuffile.actions.window) -+ [Investigate materialized views and CTAS statements](#wait-event.iobuffile.actions.mv-refresh) -+ [Use pg\_repack when you rebuild indexes](#wait-event.iobuffile.actions.pg_repack) -+ [Increase maintenance\_work\_mem when you cluster tables](#wait-event.iobuffile.actions.cluster) -+ [Tune memory to prevent IO:BufFileRead and IO:BufFileWrite](#wait-event.iobuffile.actions.tuning-memory) - -### Identify the problem - -Assume a situation in which Performance Insights isn't turned on and you suspect that `IO:BufFileRead` and `IO:BufFileWrite` are occurring more frequently than is normal\. To identify the source of the problem, you can set the `log_temp_files` parameter to log all queries that generate more than your specified threshold KB of temporary files\. By default, `log_temp_files` is set to `-1`, which turns off this logging feature\. If you set this parameter to `0`, RDS for PostgreSQL logs all temporary files\. If you set it to is `1024`, RDS for PostgreSQL logs all queries that produce temporary files larger than 1 MB\. For more information about `log_temp_files`, see [Error Reporting and Logging](https://www.postgresql.org/docs/current/runtime-config-logging.html) in the PostgreSQL documentation\. - -### Examine your join queries - -It's likely that your query uses joins\. For example, the following query joins four tables\. - -``` -SELECT * - FROM "order" - INNER JOIN order_item - ON (order.id = order_item.order_id) - INNER JOIN customer - ON (customer.id = order.customer_id) - INNER JOIN customer_address - ON (customer_address.customer_id = customer.id AND - order.customer_address_id = customer_address.id) - WHERE customer.id = 1234567890; -``` - -A possible cause of spikes in temporary file usage is a problem in the query itself\. For example, a broken clause might not filter the joins properly\. Consider the second inner join in the following example\. - -``` -SELECT * - FROM "order" - INNER JOIN order_item - ON (order.id = order_item.order_id) - INNER JOIN customer - ON (customer.id = customer.id) - INNER JOIN customer_address - ON (customer_address.customer_id = customer.id AND - order.customer_address_id = customer_address.id) - WHERE customer.id = 1234567890; -``` - -The preceding query mistakenly joins `customer.id` to `customer.id`, generating a Cartesian product between every customer and every order\. This type of accidental join generates large temporary files\. Depending on the size of the tables, a Cartesian query can even fill up storage\. Your application might have Cartesian joins when the following conditions are met: -+ You see large, sharp decreases in storage availability, followed by fast recovery\. -+ No indexes are being created\. -+ No `CREATE TABLE FROM SELECT` statements are being issued\. -+ No materialized views are being refreshed\. - -To see whether the tables are being joined using the proper keys, inspect your query and object\-relational mapping directives\. Bear in mind that certain queries of your application are not called all the time, and some queries are dynamically generated\. - -### Examine your ORDER BY and GROUP BY queries - -In some cases, an `ORDER BY` clause can result in excessive temporary files\. Consider the following guidelines: -+ Only include columns in an `ORDER BY` clause when they need to be ordered\. This guideline is especially important for queries that return thousands of rows and specify many columns in the `ORDER BY` clause\. -+ Considering creating indexes to accelerate `ORDER BY` clauses when they match columns that have the same ascending or descending order\. Partial indexes are preferable because they are smaller\. Smaller indexes are read and traversed more quickly\. -+ If you create indexes for columns that can accept null values, consider whether you want the null values stored at the end or at the beginning of the indexes\. - - If possible, reduce the number of rows that need to be ordered by filtering the result set\. If you use `WITH` clause statements or subqueries, remember that an inner query generates a result set and passes it to the outside query\. The more rows that a query can filter out, the less ordering the query needs to do\. -+ If you don't need to obtain the full result set, use the `LIMIT` clause\. For example, if you only want the top five rows, a query using the `LIMIT` clause doesn't keep generating results\. In this way, the query requires less memory and temporary files\. - -A query that uses a `GROUP BY` clause can also require temporary files\. `GROUP BY` queries summarize values by using functions such as the following: -+ `COUNT` -+ `AVG` -+ `MIN` -+ `MAX` -+ `SUM` -+ `STDDEV` - -To tune `GROUP BY` queries, follow the recommendations for `ORDER BY` queries\. - -### Avoid using the DISTINCT operation - -If possible, avoid using the `DISTINCT` operation to remove duplicated rows\. The more unnecessary and duplicated rows that your query returns, the more expensive the `DISTINCT` operation becomes\. If possible, add filters in the `WHERE` clause even if you use the same filters for different tables\. Filtering the query and joining correctly improves your performance and reduces resource use\. It also prevents incorrect reports and results\. - -If you need to use `DISTINCT` for multiple rows of a same table, consider creating a composite index\. Grouping multiple columns in an index can improve the time to evaluate distinct rows\. Also, if you use RDS for PostgreSQL version 10 or higher, you can correlate statistics among multiple columns by using the `CREATE STATISTICS` command\. - -### Consider using window functions instead of GROUP BY functions - -Using `GROUP BY`, you change the result set, and then retrieve the aggregated result\. Using window functions, you aggregate data without changing the result set\. A window function uses the `OVER` clause to perform calculations across the sets defined by the query, correlating one row with another\. You can use all the `GROUP BY` functions in window functions, but also use functions such as the following: -+ `RANK` -+ `ARRAY_AGG` -+ `ROW_NUMBER` -+ `LAG` -+ `LEAD` - -To minimize the number of temporary files generated by a window function, remove duplications for the same result set when you need two distinct aggregations\. Consider the following query\. - -``` -SELECT sum(salary) OVER (PARTITION BY dept ORDER BY salary DESC) as sum_salary - , avg(salary) OVER (PARTITION BY dept ORDER BY salary ASC) as avg_salary - FROM empsalary; -``` - -You can rewrite the query with the `WINDOW` clause as follows\. - -``` -SELECT sum(salary) OVER w as sum_salary - , avg(salary) OVER w as_avg_salary - FROM empsalary - WINDOW w AS (PARTITION BY dept ORDER BY salary DESC); -``` - -By default, the RDS for PostgreSQL execution planner consolidates similar nodes so that it doesn't duplicate operations\. However, by using an explicit declaration for the window block, you can maintain the query more easily\. You might also improve performance by preventing duplication\. - -### Investigate materialized views and CTAS statements - -When a materialized view refreshes, it runs a query\. This query can contain an operation such as `GROUP BY`, `ORDER BY`, or `DISTINCT`\. During a refresh, you might observe large numbers of temporary files and the wait events `IO:BufFileWrite` and `IO:BufFileRead`\. Similarly, when you create a table based on a `SELECT` statement, the `CREATE TABLE` statement runs a query\. To reduce the temporary files needed, optimize the query\. - -### Use pg\_repack when you rebuild indexes - -When you create an index, the engine orders the result set\. As tables grow in size, and as values in the indexed column become more diverse, the temporary files require more space\. In most cases, you can't prevent the creation of temporary files for large tables without modifying the maintenance work memory area\. For more information about `maintenance_work_mem`, see [https://www.postgresql.org/docs/current/runtime-config-resource.html](https://www.postgresql.org/docs/current/runtime-config-resource.html) in the PostgreSQL documentation\. - -A possible workaround when recreating a large index is to use the pg\_repack extension\. For more information, see [Reorganize tables in PostgreSQL databases with minimal locks](https://reorg.github.io/pg_repack/) in the pg\_repack documentation\. For information about setting up the extension in your RDS for PostgreSQL DB instance, see [Reducing bloat in tables and indexes with the pg\_repack extension](Appendix.PostgreSQL.CommonDBATasks.Extensions.md#Appendix.PostgreSQL.CommonDBATasks.pg_repack)\. - -### Increase maintenance\_work\_mem when you cluster tables - -The `CLUSTER` command clusters the table specified by *table\_name* based on an existing index specified by *index\_name*\. RDS for PostgreSQL physically recreates the table to match the order of a given index\. - -When magnetic storage was prevalent, clustering was common because storage throughput was limited\. Now that SSD\-based storage is common, clustering is less popular\. However, if you cluster tables, you can still increase performance slightly depending on the table size, index, query, and so on\. - -If you run the `CLUSTER` command and observe the wait events `IO:BufFileWrite` and `IO:BufFileRead`, tune `maintenance_work_mem`\. Increase the memory size to a fairly large amount\. A high value means that the engine can use more memory for the clustering operation\. - -### Tune memory to prevent IO:BufFileRead and IO:BufFileWrite - -In some situations, you need to tune memory\. Your goal is to balance memory across the following areas of consumption using the appropriate parameters, as follows\. -+ The `work_mem` value -+ The memory remaining after discounting the `shared_buffers` value -+ The maximum connections opened and in use, which is limited by `max_connections` - -For more information about tuning memory, see [Resource Consumption](https://www.postgresql.org/docs/current/runtime-config-resource.html) in the PostgreSQL documentation\. - -#### Increase the size of the work memory area - -In some situations, your only option is to increase the memory used by your session\. If your queries are correctly written and are using the correct keys for joins, consider increasing the `work_mem` value\. - -To find out how many temporary files a query generates, set `log_temp_files` to `0`\. If you increase the `work_mem` value to the maximum value identified in the logs, you prevent the query from generating temporary files\. However, `work_mem` sets the maximum per plan node for each connection or parallel worker\. If the database has 5,000 connections, and if each one uses 256 MiB memory, the engine needs 1\.2 TiB of RAM\. Thus, your instance might run out of memory\. - -#### Reserve sufficient memory for the shared buffer pool - -Your database uses memory areas such as the shared buffer pool, not just the work memory area\. Consider the requirements of these additional memory areas before you increase `work_mem`\. - -For example, assume that your RDS for PostgreSQL instance class is db\.r5\.2xlarge\. This class has 64 GiB of memory\. By default, 25 percent of the memory is reserved for the shared buffer pool\. After you subtract the amount allocated to the shared memory area, 16,384 MB remains\. Don't allocate the remaining memory exclusively to the work memory area because the operating system and the engine also require memory\. - -The memory that you can allocate to `work_mem` depends on the instance class\. If you use a larger instance class, more memory is available\. However, in the preceding example, you can't use more than 16 GiB\. Otherwise, your instance becomes unavailable when it runs out of memory\. To recover the instance from the unavailable state, the RDS for PostgreSQL automation services automatically restart\. - -#### Manage the number of connections - -Suppose that your database instance has 5,000 simultaneous connections\. Each connection uses at least 4 MiB of `work_mem`\. The high memory consumption of the connections is likely to degrade performance\. In response, you have the following options: -+ Upgrade to a larger instance class\. -+ Decrease the number of simultaneous database connections by using a connection proxy or pooler\. - -For proxies, consider Amazon RDS Proxy, pgBouncer, or a connection pooler based on your application\. This solution alleviates the CPU load\. It also reduces the risk when all connections require the work memory area\. When fewer database connections exist, you can increase the value of `work_mem`\. In this way, you reduce the occurrence of the `IO:BufFileRead` and `IO:BufFileWrite` wait events\. Also, the queries waiting for the work memory area speed up significantly\. \ No newline at end of file diff --git a/doc_source/wait-event.iodatafileread.md b/doc_source/wait-event.iodatafileread.md deleted file mode 100644 index b29962d..0000000 --- a/doc_source/wait-event.iodatafileread.md +++ /dev/null @@ -1,311 +0,0 @@ -# IO:DataFileRead - -The `IO:DataFileRead` event occurs when a connection waits on a backend process to read a required page from storage because the page isn't available in shared memory\. - -**Topics** -+ [Supported engine versions](#wait-event.iodatafileread.context.supported) -+ [Context](#wait-event.iodatafileread.context) -+ [Likely causes of increased waits](#wait-event.iodatafileread.causes) -+ [Actions](#wait-event.iodatafileread.actions) - -## Supported engine versions - -This wait event information is supported for all versions of RDS for PostgreSQL\. - -## Context - -All queries and data manipulation \(DML\) operations access pages in the buffer pool\. Statements that can induce reads include `SELECT`, `UPDATE`, and `DELETE`\. For example, an `UPDATE` can read pages from tables or indexes\. If the page being requested or updated isn't in the shared buffer pool, this read can lead to the `IO:DataFileRead` event\. - -Because the shared buffer pool is finite, it can fill up\. In this case, requests for pages that aren't in memory force the database to read blocks from disk\. If the `IO:DataFileRead` event occurs frequently, your shared buffer pool might be too small to accommodate your workload\. This problem is acute for `SELECT` queries that read a large number of rows that don't fit in the buffer pool\. For more information about the buffer pool, see [Resource Consumption](https://www.postgresql.org/docs/current/runtime-config-resource.html) in the PostgreSQL documentation\. - -## Likely causes of increased waits - -Common causes for the `IO:DataFileRead` event include the following: - -**Connection spikes** -You might find multiple connections generating the same number of IO:DataFileRead wait events\. In this case, a spike \(sudden and large increase\) in `IO:DataFileRead` events can occur\. - -**SELECT and DML statements performing sequential scans** -Your application might be performing a new operation\. Or an existing operation might change because of a new execution plan\. In such cases, look for tables \(particularly large tables\) that have a greater `seq_scan` value\. Find them by querying `pg_stat_user_tables`\. To track queries that are generating more read operations, use the extension `pg_stat_statements`\. - -**CTAS and CREATE INDEX for large data sets** -A *CTAS* is a `CREATE TABLE AS SELECT` statement\. If you run a CTAS using a large data set as a source, or create an index on a large table, the `IO:DataFileRead` event can occur\. When you create an index, the database might need to read the entire object using a sequential scan\. A CTAS generates `IO:DataFile` reads when pages aren't in memory\. - -**Multiple vacuum workers running at the same time** -Vacuum workers can be triggered manually or automatically\. We recommend adopting an aggressive vacuum strategy\. However, when a table has many updated or deleted rows, the `IO:DataFileRead` waits increase\. After space is reclaimed, the vacuum time spent on `IO:DataFileRead` decreases\. - -**Ingesting large amounts of data** -When your application ingests large amounts of data, `ANALYZE` operations might occur more often\. The `ANALYZE` process can be triggered by an autovacuum launcher or invoked manually\. -The `ANALYZE` operation reads a subset of the table\. The number of pages that must be scanned is calculated by multiplying 30 by the `default_statistics_target` value\. For more information, see the [PostgreSQL documentation](https://www.postgresql.org/docs/current/runtime-config-query.html#GUC-DEFAULT-STATISTICS-TARGET)\. The `default_statistics_target` parameter accepts values between 1 and 10,000, where the default is 100\. - -**Resource starvation** -If instance network bandwidth or CPU are consumed, the `IO:DataFileRead` event might occur more frequently\. - -## Actions - -We recommend different actions depending on the causes of your wait event\. - -**Topics** -+ [Check predicate filters for queries that generate waits](#wait-event.iodatafileread.actions.filters) -+ [Minimize the effect of maintenance operations](#wait-event.iodatafileread.actions.maintenance) -+ [Respond to high numbers of connections](#wait-event.iodatafileread.actions.connections) - -### Check predicate filters for queries that generate waits - -Assume that you identify specific queries that are generating `IO:DataFileRead` wait events\. You might identify them using the following techniques: -+ Performance Insights -+ Catalog views such as the one provided by the extension `pg_stat_statements` -+ The catalog view `pg_stat_all_tables`, if it periodically shows an increased number of physical reads -+ The `pg_statio_all_tables` view, if it shows that `_read` counters are increasing - -We recommend that you determine which filters are used in the predicate \(`WHERE` clause\) of these queries\. Follow these guidelines: -+ Run the `EXPLAIN` command\. In the output, identify which types of scans are used\. A sequential scan doesn't necessarily indicate a problem\. Queries that use sequential scans naturally produce more `IO:DataFileRead` events when compared to queries that use filters\. - - Find out whether the column listed in the `WHERE` clause is indexed\. If not, consider creating an index for this column\. This approach avoids the sequential scans and reduces the `IO:DataFileRead` events\. If a query has restrictive filters and still produces sequential scans, evaluate whether the proper indexes are being used\. -+ Find out whether the query is accessing a very large table\. In some cases, partitioning a table can improve performance, allowing the query to only read necessary partitions\. -+ Examine the cardinality \(total number of rows\) from your join operations\. Note how restrictive the values are that you're passing in the filters for your `WHERE` clause\. If possible, tune your query to reduce the number of rows that are passed in each step of the plan\. - -### Minimize the effect of maintenance operations - -Maintenance operations such as `VACUUM` and `ANALYZE` are important\. We recommend that you don't turn them off because you find `IO:DataFileRead` wait events related to these maintenance operations\. The following approaches can minimize the effect of these operations: -+ Run maintenance operations manually during off\-peak hours\. This technique prevents the database from reaching the threshold for automatic operations\. -+ For very large tables, consider partitioning the table\. This technique reduces the overhead of maintenance operations\. The database only accesses the partitions that require maintenance\. -+ When you ingest large amounts of data, consider disabling the autoanalyze feature\. - -The autovacuum feature is automatically triggered for a table when the following formula is true\. - -``` -pg_stat_user_tables.n_dead_tup > (pg_class.reltuples x autovacuum_vacuum_scale_factor) + autovacuum_vacuum_threshold -``` - -The view `pg_stat_user_tables` and catalog `pg_class` have multiple rows\. One row can correspond to one row in your table\. This formula assumes that the `reltuples` are for a specific table\. The parameters `autovacuum_vacuum_scale_factor` \(0\.20 by default\) and `autovacuum_vacuum_threshold` \(50 tuples by default\) are usually set globally for the whole instance\. However, you can set different values for a specific table\. - -**Topics** -+ [Find tables consuming space unnecessarily](#wait-event.iodatafileread.actions.maintenance.tables) -+ [Find indexes consuming space unnecessarily](#wait-event.iodatafileread.actions.maintenance.indexes) -+ [Find tables that are eligible to be autovacuumed](#wait-event.iodatafileread.actions.maintenance.autovacuumed) - -#### Find tables consuming space unnecessarily - -To find tables consuming space unnecessarily, you can use functions from the PostgreSQL `pgstattuple` extension\. This extension \(module\) is available by default on all RDS for PostgreSQL DB instances and can be instantiated on the instance with the following command\. - -``` -CREATE EXTENSION pgstattuple; -``` - -For more information about this extension, see [pgstattuple](https://www.postgresql.org/docs/current/pgstattuple.html) in the PostgreSQL documentation\. - -The query shown in the listing returns results from tables for which your database user \(role\) has read permissions\. - -``` -SELECT current_database(), schemaname, tblname, bs*tblpages AS real_size, - (tblpages-est_tblpages)*bs AS extra_size, - CASE WHEN tblpages - est_tblpages > 0 - THEN 100 * (tblpages - est_tblpages)/tblpages::float - ELSE 0 - END AS extra_ratio, fillfactor, (tblpages-est_tblpages_ff)*bs AS bloat_size, - CASE WHEN tblpages - est_tblpages_ff > 0 - THEN 100 * (tblpages - est_tblpages_ff)/tblpages::float - ELSE 0 - END AS bloat_ratio, is_na - -- , (pst).free_percent + (pst).dead_tuple_percent AS real_frag -FROM ( - SELECT - ceil( reltuples / ( (bs-page_hdr)/tpl_size ) ) + ceil( toasttuples / 4 ) - AS est_tblpages, - ceil( reltuples / ( (bs-page_hdr)*fillfactor/(tpl_size*100) ) ) + ceil( toasttuples / 4 ) - AS est_tblpages_ff, - tblpages, fillfactor, bs, tblid, schemaname, tblname, heappages, toastpages, is_na - -- , stattuple.pgstattuple(tblid) AS pst - FROM ( - SELECT - ( 4 + tpl_hdr_size + tpl_data_size + (2*ma) - - CASE WHEN tpl_hdr_size%ma = 0 THEN ma ELSE tpl_hdr_size%ma END - - CASE WHEN ceil(tpl_data_size)::int%ma = 0 THEN ma ELSE ceil(tpl_data_size)::int%ma END - ) AS tpl_size, bs - page_hdr AS size_per_block, (heappages + toastpages) AS tblpages, heappages, - toastpages, reltuples, toasttuples, bs, page_hdr, tblid, schemaname, tblname, fillfactor, is_na - FROM ( - SELECT - tbl.oid AS tblid, ns.nspname AS schemaname, tbl.relname AS tblname, tbl.reltuples, - tbl.relpages AS heappages, coalesce(toast.relpages, 0) AS toastpages, - coalesce(toast.reltuples, 0) AS toasttuples, - coalesce(substring( - array_to_string(tbl.reloptions, ' ') - FROM 'fillfactor=([0-9]+)')::smallint, 100) AS fillfactor, - current_setting('block_size')::numeric AS bs, - CASE WHEN version()~'mingw32' OR version()~'64-bit|x86_64|ppc64|ia64|amd64' - THEN 8 - ELSE 4 - END AS ma, - 24 AS page_hdr, - 23 + CASE WHEN MAX(coalesce(null_frac,0)) > 0 THEN ( 7 + count(*) ) / 8 ELSE 0::int END - + CASE WHEN tbl.relhasoids THEN 4 ELSE 0 END AS tpl_hdr_size, - sum( (1-coalesce(s.null_frac, 0)) * coalesce(s.avg_width, 1024) ) AS tpl_data_size, - bool_or(att.atttypid = 'pg_catalog.name'::regtype) - OR count(att.attname) <> count(s.attname) AS is_na - FROM pg_attribute AS att - JOIN pg_class AS tbl ON att.attrelid = tbl.oid - JOIN pg_namespace AS ns ON ns.oid = tbl.relnamespace - LEFT JOIN pg_stats AS s ON s.schemaname=ns.nspname - AND s.tablename = tbl.relname AND s.inherited=false AND s.attname=att.attname - LEFT JOIN pg_class AS toast ON tbl.reltoastrelid = toast.oid - WHERE att.attnum > 0 AND NOT att.attisdropped - AND tbl.relkind = 'r' - GROUP BY 1,2,3,4,5,6,7,8,9,10, tbl.relhasoids - ORDER BY 2,3 - ) AS s - ) AS s2 -) AS s3 ; --- WHERE NOT is_na --- AND tblpages*((pst).free_percent + (pst).dead_tuple_percent)::float4/100 >= 1 -``` - -#### Find indexes consuming space unnecessarily - -To find bloated indexes and estimate the amount of space consumed unnecessarily on the tables for which you have read privileges, you can run the following query\. - -``` --- WARNING: rows with is_na = 't' are known to have bad statistics ("name" type is not supported). --- This query is compatible with PostgreSQL 8.2 and later. - -SELECT current_database(), nspname AS schemaname, tblname, idxname, bs*(relpages)::bigint AS real_size, - bs*(relpages-est_pages)::bigint AS extra_size, - 100 * (relpages-est_pages)::float / relpages AS extra_ratio, - fillfactor, bs*(relpages-est_pages_ff) AS bloat_size, - 100 * (relpages-est_pages_ff)::float / relpages AS bloat_ratio, - is_na - -- , 100-(sub.pst).avg_leaf_density, est_pages, index_tuple_hdr_bm, - -- maxalign, pagehdr, nulldatawidth, nulldatahdrwidth, sub.reltuples, sub.relpages - -- (DEBUG INFO) -FROM ( - SELECT coalesce(1 + - ceil(reltuples/floor((bs-pageopqdata-pagehdr)/(4+nulldatahdrwidth)::float)), 0 - -- ItemIdData size + computed avg size of a tuple (nulldatahdrwidth) - ) AS est_pages, - coalesce(1 + - ceil(reltuples/floor((bs-pageopqdata-pagehdr)*fillfactor/(100*(4+nulldatahdrwidth)::float))), 0 - ) AS est_pages_ff, - bs, nspname, table_oid, tblname, idxname, relpages, fillfactor, is_na - -- , stattuple.pgstatindex(quote_ident(nspname)||'.'||quote_ident(idxname)) AS pst, - -- index_tuple_hdr_bm, maxalign, pagehdr, nulldatawidth, nulldatahdrwidth, reltuples - -- (DEBUG INFO) - FROM ( - SELECT maxalign, bs, nspname, tblname, idxname, reltuples, relpages, relam, table_oid, fillfactor, - ( index_tuple_hdr_bm + - maxalign - CASE -- Add padding to the index tuple header to align on MAXALIGN - WHEN index_tuple_hdr_bm%maxalign = 0 THEN maxalign - ELSE index_tuple_hdr_bm%maxalign - END - + nulldatawidth + maxalign - CASE -- Add padding to the data to align on MAXALIGN - WHEN nulldatawidth = 0 THEN 0 - WHEN nulldatawidth::integer%maxalign = 0 THEN maxalign - ELSE nulldatawidth::integer%maxalign - END - )::numeric AS nulldatahdrwidth, pagehdr, pageopqdata, is_na - -- , index_tuple_hdr_bm, nulldatawidth -- (DEBUG INFO) - FROM ( - SELECT - i.nspname, i.tblname, i.idxname, i.reltuples, i.relpages, i.relam, a.attrelid AS table_oid, - current_setting('block_size')::numeric AS bs, fillfactor, - CASE -- MAXALIGN: 4 on 32bits, 8 on 64bits (and mingw32 ?) - WHEN version() ~ 'mingw32' OR version() ~ '64-bit|x86_64|ppc64|ia64|amd64' THEN 8 - ELSE 4 - END AS maxalign, - /* per page header, fixed size: 20 for 7.X, 24 for others */ - 24 AS pagehdr, - /* per page btree opaque data */ - 16 AS pageopqdata, - /* per tuple header: add IndexAttributeBitMapData if some cols are null-able */ - CASE WHEN max(coalesce(s.null_frac,0)) = 0 - THEN 2 -- IndexTupleData size - ELSE 2 + (( 32 + 8 - 1 ) / 8) - -- IndexTupleData size + IndexAttributeBitMapData size ( max num filed per index + 8 - 1 /8) - END AS index_tuple_hdr_bm, - /* data len: we remove null values save space using it fractionnal part from stats */ - sum( (1-coalesce(s.null_frac, 0)) * coalesce(s.avg_width, 1024)) AS nulldatawidth, - max( CASE WHEN a.atttypid = 'pg_catalog.name'::regtype THEN 1 ELSE 0 END ) > 0 AS is_na - FROM pg_attribute AS a - JOIN ( - SELECT nspname, tbl.relname AS tblname, idx.relname AS idxname, - idx.reltuples, idx.relpages, idx.relam, - indrelid, indexrelid, indkey::smallint[] AS attnum, - coalesce(substring( - array_to_string(idx.reloptions, ' ') - from 'fillfactor=([0-9]+)')::smallint, 90) AS fillfactor - FROM pg_index - JOIN pg_class idx ON idx.oid=pg_index.indexrelid - JOIN pg_class tbl ON tbl.oid=pg_index.indrelid - JOIN pg_namespace ON pg_namespace.oid = idx.relnamespace - WHERE pg_index.indisvalid AND tbl.relkind = 'r' AND idx.relpages > 0 - ) AS i ON a.attrelid = i.indexrelid - JOIN pg_stats AS s ON s.schemaname = i.nspname - AND ((s.tablename = i.tblname AND s.attname = pg_catalog.pg_get_indexdef(a.attrelid, a.attnum, TRUE)) - -- stats from tbl - OR (s.tablename = i.idxname AND s.attname = a.attname)) - -- stats from functional cols - JOIN pg_type AS t ON a.atttypid = t.oid - WHERE a.attnum > 0 - GROUP BY 1, 2, 3, 4, 5, 6, 7, 8, 9 - ) AS s1 - ) AS s2 - JOIN pg_am am ON s2.relam = am.oid WHERE am.amname = 'btree' -) AS sub --- WHERE NOT is_na -ORDER BY 2,3,4; -``` - -#### Find tables that are eligible to be autovacuumed - -To find tables that are eligible to be autovacuumed, run the following query\. - -``` ---This query shows tables that need vacuuming and are eligible candidates. ---The following query lists all tables that are due to be processed by autovacuum. --- During normal operation, this query should return very little. -WITH vbt AS (SELECT setting AS autovacuum_vacuum_threshold - FROM pg_settings WHERE name = 'autovacuum_vacuum_threshold') - , vsf AS (SELECT setting AS autovacuum_vacuum_scale_factor - FROM pg_settings WHERE name = 'autovacuum_vacuum_scale_factor') - , fma AS (SELECT setting AS autovacuum_freeze_max_age - FROM pg_settings WHERE name = 'autovacuum_freeze_max_age') - , sto AS (SELECT opt_oid, split_part(setting, '=', 1) as param, - split_part(setting, '=', 2) as value - FROM (SELECT oid opt_oid, unnest(reloptions) setting FROM pg_class) opt) -SELECT - '"'||ns.nspname||'"."'||c.relname||'"' as relation - , pg_size_pretty(pg_table_size(c.oid)) as table_size - , age(relfrozenxid) as xid_age - , coalesce(cfma.value::float, autovacuum_freeze_max_age::float) autovacuum_freeze_max_age - , (coalesce(cvbt.value::float, autovacuum_vacuum_threshold::float) + - coalesce(cvsf.value::float,autovacuum_vacuum_scale_factor::float) * c.reltuples) - as autovacuum_vacuum_tuples - , n_dead_tup as dead_tuples -FROM pg_class c -JOIN pg_namespace ns ON ns.oid = c.relnamespace -JOIN pg_stat_all_tables stat ON stat.relid = c.oid -JOIN vbt on (1=1) -JOIN vsf ON (1=1) -JOIN fma on (1=1) -LEFT JOIN sto cvbt ON cvbt.param = 'autovacuum_vacuum_threshold' AND c.oid = cvbt.opt_oid -LEFT JOIN sto cvsf ON cvsf.param = 'autovacuum_vacuum_scale_factor' AND c.oid = cvsf.opt_oid -LEFT JOIN sto cfma ON cfma.param = 'autovacuum_freeze_max_age' AND c.oid = cfma.opt_oid -WHERE c.relkind = 'r' -AND nspname <> 'pg_catalog' -AND ( - age(relfrozenxid) >= coalesce(cfma.value::float, autovacuum_freeze_max_age::float) - or - coalesce(cvbt.value::float, autovacuum_vacuum_threshold::float) + - coalesce(cvsf.value::float,autovacuum_vacuum_scale_factor::float) * c.reltuples <= n_dead_tup - -- or 1 = 1 -) -ORDER BY age(relfrozenxid) DES; -``` - -### Respond to high numbers of connections - -When you monitor Amazon CloudWatch, you might find that the `DatabaseConnections` metric spikes\. This increase indicates an increased number of connections to your database\. We recommend the following approach: -+ Limit the number of connections that the application can open with each instance\. If your application has an embedded connection pool feature, set a reasonable number of connections\. Base the number on what the vCPUs in your instance can parallelize effectively\. - - If your application doesn't use a connection pool feature, considering using Amazon RDS Proxy or an alternative\. This approach lets your application open multiple connections with the load balancer\. The balancer can then open a restricted number of connections with the database\. As fewer connections are running in parallel, your DB instance performs less context switching in the kernel\. Queries should progress faster, leading to fewer wait events\. For more information, see [Using Amazon RDS Proxy](rds-proxy.md)\. -+ Whenever possible, take advantage of read replicas for RDS for PostgreSQL\. When your application runs a read\-only operation, send these requests to the read replica\(s\)\. This technique reduces the I/O pressure on the primary \(writer\) node\. -+ Consider scaling up your DB instance\. A higher\-capacity instance class gives more memory, which gives RDS for PostgreSQL a larger shared buffer pool to hold pages\. The larger size also gives the DB instance more vCPUs to handle connections\. More vCPUs are particularly helpful when the operations that are generating `IO:DataFileRead` wait events are writes\. \ No newline at end of file diff --git a/doc_source/wait-event.iowalwrite.md b/doc_source/wait-event.iowalwrite.md deleted file mode 100644 index 36978e9..0000000 --- a/doc_source/wait-event.iowalwrite.md +++ /dev/null @@ -1,61 +0,0 @@ -# IO:WALWrite - - - -**Topics** -+ [Supported engine versions](#wait-event.iowalwrite.context.supported) -+ [Context](#wait-event.iowalwrite.context) -+ [Likely causes of increased waits](#wait-event.iowalwrite.causes) -+ [Actions](#wait-event.iowalwrite.actions) - -## Supported engine versions - -This wait event information is supported for all versions of RDS for PostgreSQL 10 and higher\. - -## Context - -Activity in the database that's generating write\-ahead log data fills up the WAL buffers first and then writes to disk, asynchronously\. The wait event `IO:WALWrite` is generated when the SQL session is waiting for the WAL data to complete writing to disk so that it can release the transaction's COMMIT call\. - -## Likely causes of increased waits - -If this wait event occurs often, you should review your workload and the type of updates that your workload performs and their frequency\. In particular, look for the following types of activity\. - -**Heavy DML activity** -Changing data in database tables doesn't happen instantaneously\. An insert to one table might need to wait for an insert or an update to the same table from another client\. The data manipulation language \(DML\) statements for changing data values \(INSERT, UPDATE, DELETE, COMMIT, ROLLBACK TRANSACTION\) can result in contention that causes the write\-ahead logfile to be waiting for the buffers to be flushed\. This situation is captured in the following Amazon RDS Performance Insights metrics that indicate heavy DML activity\. -+ `tup_inserted` -+ `tup_updated` -+ `tup_deleted` -+ `xcat_rollback` -+ `xact_commit` -For more information about these metrics, see [Performance Insights counters for Amazon RDS for PostgreSQL](USER_PerfInsights_Counters.md#USER_PerfInsights_Counters.PostgreSQL)\. - -**Frequent checkpoint activity** -Frequent checkpoints contribute to larger WAL size\. In RDS for PostgreSQL, full page writes are always "on\." Full page writes help protect against data loss\. However, when checkpointing occurs too frequently, the system can suffer overall performance issues\. This is especially true on systems with heavy DML activity\. In some cases, you might find error messages in your `postgresql.log` stating that “checkpoints are occurring too frequently\." -We recommend that when tuning checkpoints, you carefully balance performance against expected time need to recover in the event of an abnormal shutdown\. - -## Actions - -We recommend the following actions to reduce the numbers of this wait event\. - -**Topics** -+ [Reduce the number of commits](#wait-event.iowalwrite.actions.problem) -+ [Monitor your checkpoints](#wait-event.iowalwrite.actions.monitor) -+ [Scale up IO](#wait-event.iowalwrite.actions.scale-io) - -### Reduce the number of commits - -To reduce the number of commits, you can combine statements into transaction blocks\. Use Amazon RDS Performance Insights to examine the type of queries being run\. You can also move large maintenance operations to off\-peak hours\. For example, create indexes or use `pg_repack` operations during non\-production hours\. - -### Monitor your checkpoints - -There are two parameters that you can monitor to see how frequently your RDS for PostgreSQL DB instance is writing to the WAL file for checkpoints\. -+ `log_checkpoints` – This parameter is set to "on" by default\. It causes a message to get sent to the PostgreSQL log for each checkpoint\. These log messages include the number of buffers written, the time spent writing them, and the number of WAL files added, removed, or recycled for the given checkpoint\. - - For more information about this parameter, see [Error Reporting and Logging](https://www.postgresql.org/docs/current/runtime-config-logging.html#GUC-LOG-CHECKPOINTS) in the PostgreSQL documentation\. -+ `checkpoint_warning` – This parameter sets a threshold value \(in seconds\) for checkpoint frequency above which a warning is generated\. By default, this parameter isn't set\. You can set a value for this parameter to get a warning when your RDS for PostgreSQL DB instance needs to write butters to the WAL file more often than the specified value\. For example, say you set this parameter to 30\. If your RDS for PostgreSQL instance needs to write its buffers to the WAL file more often than every 30 seconds, the warning that "checkpoints are occurring too frequently" is sent to the PostgreSQL log\. This can indicate that your `max_wal_size` value should be increased\. - - For more information, see [Write Ahead Log](https://www.postgresql.org/docs/current/runtime-config-wal.html#RUNTIME-CONFIG-WAL-CHECKPOINTS) in the PostgreSQL documentation\. - -### Scale up IO - -This type of input/output \(IO\) wait event can remediated by scaling the input/output operations per second \(IOPs\) to provide faster IO\. Scaling IO is preferable to scaling CPU, because scaling CPU can result in even more IO contention because the increased CPU can handle more work and thus make the IO bottleneck even worse\. In general, we recommend that you consider tuning your workload before performing scaling operations\. \ No newline at end of file diff --git a/doc_source/wait-event.lockadvisory.md b/doc_source/wait-event.lockadvisory.md deleted file mode 100644 index 3375ef5..0000000 --- a/doc_source/wait-event.lockadvisory.md +++ /dev/null @@ -1,88 +0,0 @@ -# Lock:advisory - -The `Lock:advisory` event occurs when a PostgreSQL application uses a lock to coordinate activity across multiple sessions\. - -**Topics** -+ [Relevant engine versions](#wait-event.lockadvisory.context.supported) -+ [Context](#wait-event.lockadvisory.context) -+ [Causes](#wait-event.lockadvisory.causes) -+ [Actions](#wait-event.lockadvisory.actions) - -## Relevant engine versions - -This wait event information is relevant for RDS for PostgreSQL versions 9\.6 and higher\. - -## Context - -PostgreSQL advisory locks are application\-level, cooperative locks explicitly locked and unlocked by the user's application code\. An application can use PostgreSQL advisory locks to coordinate activity across multiple sessions\. Unlike regular, object\- or row\-level locks, the application has full control over the lifetime of the lock\. For more information, see [Advisory Locks](https://www.postgresql.org/docs/12/explicit-locking.html#ADVISORY-LOCKS) in the PostgreSQL documentation\. - -Advisory locks can be released before a transaction ends or be held by a session across transactions\. This isn't true for implicit, system\-enforced locks, such as an access\-exclusive lock on a table acquired by a `CREATE INDEX` statement\. - -For a description of the functions used to acquire \(lock\) and release \(unlock\) advisory locks, see [Advisory Lock Functions](https://www.postgresql.org/docs/current/functions-admin.html#FUNCTIONS-ADVISORY-LOCKS) in the PostgreSQL documentation\. - -Advisory locks are implemented on top of the regular PostgreSQL locking system and are visible in the `pg_locks` system view\. - -## Causes - -This lock type is exclusively controlled by an application explicitly using it\. Advisory locks that are acquired for each row as part of a query can cause a spike in locks or a long\-term buildup\. - -These effects happen when the query is run in a way that acquires locks on more rows than are returned by the query\. The application must eventually release every lock, but if locks are acquired on rows that aren't returned, the application can't find all of the locks\. - -The following example is from [Advisory Locks](https://www.postgresql.org/docs/12/explicit-locking.html#ADVISORY-LOCKS) in the PostgreSQL documentation\. - -``` -SELECT pg_advisory_lock(id) FROM foo WHERE id > 12345 LIMIT 100; -``` - -In this example, the `LIMIT` clause can only stop the query's output after the rows have already been internally selected and their ID values locked\. This can happen suddenly when a growing data volume causes the planner to choose a different execution plan that wasn't tested during development\. The buildup in this case happens because the application explicitly calls `pg_advisory_unlock` for every ID value that was locked\. However, in this case it can't find the set of locks acquired on rows that weren't returned\. Because the locks are acquired on the session level, they aren't released automatically at the end of the transaction\. - -Another possible cause for spikes in blocked lock attempts is unintended conflicts\. In these conflicts, unrelated parts of the application share the same lock ID space by mistake\. - -## Actions - -Review application usage of advisory locks and detail where and when in the application flow each type of advisory lock is acquired and released\. - -Determine whether a session is acquiring too many locks or a long\-running session isn't releasing locks early enough, leading to a slow buildup of locks\. You can correct a slow buildup of session\-level locks by ending the session using `pg_terminate_backend(pid)`\. - -A client waiting for an advisory lock appears in `pg_stat_activity` with `wait_event_type=Lock` and `wait_event=advisory`\. You can obtain specific lock values by querying the `pg_locks` system view for the same `pid`, looking for `locktype=advisory` and `granted=f`\. - -You can then identify the blocking session by querying `pg_locks` for the same advisory lock having `granted=t`, as shown in the following example\. - -``` -SELECT blocked_locks.pid AS blocked_pid, - blocking_locks.pid AS blocking_pid, - blocked_activity.usename AS blocked_user, - blocking_activity.usename AS blocking_user, - now() - blocked_activity.xact_start AS blocked_transaction_duration, - now() - blocking_activity.xact_start AS blocking_transaction_duration, - concat(blocked_activity.wait_event_type,':',blocked_activity.wait_event) AS blocked_wait_event, - concat(blocking_activity.wait_event_type,':',blocking_activity.wait_event) AS blocking_wait_event, - blocked_activity.state AS blocked_state, - blocking_activity.state AS blocking_state, - blocked_locks.locktype AS blocked_locktype, - blocking_locks.locktype AS blocking_locktype, - blocked_activity.query AS blocked_statement, - blocking_activity.query AS blocking_statement - FROM pg_catalog.pg_locks blocked_locks - JOIN pg_catalog.pg_stat_activity blocked_activity ON blocked_activity.pid = blocked_locks.pid - JOIN pg_catalog.pg_locks blocking_locks - ON blocking_locks.locktype = blocked_locks.locktype - AND blocking_locks.DATABASE IS NOT DISTINCT FROM blocked_locks.DATABASE - AND blocking_locks.relation IS NOT DISTINCT FROM blocked_locks.relation - AND blocking_locks.page IS NOT DISTINCT FROM blocked_locks.page - AND blocking_locks.tuple IS NOT DISTINCT FROM blocked_locks.tuple - AND blocking_locks.virtualxid IS NOT DISTINCT FROM blocked_locks.virtualxid - AND blocking_locks.transactionid IS NOT DISTINCT FROM blocked_locks.transactionid - AND blocking_locks.classid IS NOT DISTINCT FROM blocked_locks.classid - AND blocking_locks.objid IS NOT DISTINCT FROM blocked_locks.objid - AND blocking_locks.objsubid IS NOT DISTINCT FROM blocked_locks.objsubid - AND blocking_locks.pid != blocked_locks.pid - JOIN pg_catalog.pg_stat_activity blocking_activity ON blocking_activity.pid = blocking_locks.pid - WHERE NOT blocked_locks.GRANTED; -``` - -All of the advisory lock API functions have two sets of arguments, either one `bigint` argument or two `integer` arguments: -+ For the API functions with one `bigint` argument, the upper 32 bits are in `pg_locks.classid` and the lower 32 bits are in `pg_locks.objid`\. -+ For the API functions with two `integer` arguments, the first argument is `pg_locks.classid` and the second argument is `pg_locks.objid`\. - -The `pg_locks.objsubid` value indicates which API form was used: `1` means one `bigint` argument; `2` means two `integer` arguments\. \ No newline at end of file diff --git a/doc_source/wait-event.lockextend.md b/doc_source/wait-event.lockextend.md deleted file mode 100644 index 0d6da90..0000000 --- a/doc_source/wait-event.lockextend.md +++ /dev/null @@ -1,75 +0,0 @@ -# Lock:extend - -The `Lock:extend` event occurs when a backend process is waiting to lock a relation to extend it while another process has a lock on that relation for the same purpose\. - -**Topics** -+ [Supported engine versions](#wait-event.lockextend.context.supported) -+ [Context](#wait-event.lockextend.context) -+ [Likely causes of increased waits](#wait-event.lockextend.causes) -+ [Actions](#wait-event.lockextend.actions) - -## Supported engine versions - -This wait event information is supported for all versions of RDS for PostgreSQL\. - -## Context - -The event `Lock:extend` indicates that a backend process is waiting to extend a relation that another backend process holds a lock on while it's extending that relation\. Because only one process at a time can extend a relation, the system generates a `Lock:extend` wait event\. `INSERT`, `COPY`, and `UPDATE` operations can generate this event\. - -## Likely causes of increased waits - -When the `Lock:extend` event appears more than normal, possibly indicating a performance problem, typical causes include the following: - -**Surge in concurrent inserts or updates to the same table ** -There might be an increase in the number of concurrent sessions with queries that insert into or update the same table\. - -**Insufficient network bandwidth** -The network bandwidth on the DB instance might be insufficient for the storage communication needs of the current workload\. This can contribute to storage latency that causes an increase in `Lock:extend` events\. - -## Actions - -We recommend different actions depending on the causes of your wait event\. - -**Topics** -+ [Reduce concurrent inserts and updates to the same relation](#wait-event.lockextend.actions.action1) -+ [Increase network bandwidth](#wait-event.lockextend.actions.increase-network-bandwidth) - -### Reduce concurrent inserts and updates to the same relation - -First, determine whether there's an increase in `tup_inserted` and `tup_updated` metrics and an accompanying increase in this wait event\. If so, check which relations are in high contention for insert and update operations\. To determine this, query the `pg_stat_all_tables` view for the values in `n_tup_ins` and `n_tup_upd` fields\. For information about the `pg_stat_all_tables` view, see [pg\_stat\_all\_tables](https://www.postgresql.org/docs/13/monitoring-stats.html#MONITORING-PG-STAT-ALL-TABLES-VIEW) in the PostgreSQL documentation\. - -To get more information about blocking and blocked queries, query `pg_stat_activity` as in the following example: - -``` -SELECT - blocked.pid, - blocked.usename, - blocked.query, - blocking.pid AS blocking_id, - blocking.query AS blocking_query, - blocking.wait_event AS blocking_wait_event, - blocking.wait_event_type AS blocking_wait_event_type -FROM pg_stat_activity AS blocked -JOIN pg_stat_activity AS blocking ON blocking.pid = ANY(pg_blocking_pids(blocked.pid)) -where -blocked.wait_event = 'extend' -and blocked.wait_event_type = 'Lock'; - - pid | usename | query | blocking_id | blocking_query | blocking_wait_event | blocking_wait_event_type - ------+----------+------------------------------+-------------+------------------------------------------------------------------+---------------------+-------------------------- - 7143 | myuser | insert into tab1 values (1); | 4600 | INSERT INTO tab1 (a) SELECT s FROM generate_series(1,1000000) s; | DataFileExtend | IO -``` - -After you identify relations that contribute to increase `Lock:extend` events, use the following techniques to reduce the contention: -+ Find out whether you can use partitioning to reduce contention for the same table\. Separating inserted or updated tuples into different partitions can reduce contention\. For information about partitioning, see [Managing PostgreSQL partitions with the pg\_partman extension](PostgreSQL_Partitions.md)\. -+ If the wait event is mainly due to update activity, consider reducing the relation's fillfactor value\. This can reduce requests for new blocks during the update\. The fillfactor is a storage parameter for a table that determines the maximum amount of space for packing a table page\. It's expressed as a percentage of the total space for a page\. For more information about the fillfactor parameter, see [CREATE TABLE](https://www.postgresql.org/docs/13/sql-createtable.html) in the PostgreSQL documentation\. -**Important** -We highly recommend that you test your system if you change the fillfactor because changing this value can negatively impact performance, depending on your workload\. - -### Increase network bandwidth - -To see whether there's an increase in write latency, check the `WriteLatency` metric in CloudWatch\. If there is, use the `WriteThroughput` and `ReadThroughput` Amazon CloudWatch metrics to monitor the storage related traffic on the DB instance\. These metrics can help you to determine if network bandwidth is sufficient for the storage activity of your workload\. - -If your network bandwidth isn't enough, increase it\. If your DB instance is reaching the network bandwidth limits, the only way to increase the bandwidth is to increase your DB instance size\. - -For more information about CloudWatch metrics, see [Amazon CloudWatch instance\-level metrics for Amazon RDS](rds-metrics.md#rds-cw-metrics-instance)\. For information about network performance for each DB instance class, see [Amazon CloudWatch instance\-level metrics for Amazon RDS](rds-metrics.md#rds-cw-metrics-instance)\. \ No newline at end of file diff --git a/doc_source/wait-event.lockrelation.md b/doc_source/wait-event.lockrelation.md deleted file mode 100644 index 9a345ac..0000000 --- a/doc_source/wait-event.lockrelation.md +++ /dev/null @@ -1,60 +0,0 @@ -# Lock:Relation - -The `Lock:Relation` event occurs when a query is waiting to acquire a lock on a table or view \(relation\) that's currently locked by another transaction\. - -**Topics** -+ [Supported engine versions](#wait-event.lockrelation.context.supported) -+ [Context](#wait-event.lockrelation.context) -+ [Likely causes of increased waits](#wait-event.lockrelation.causes) -+ [Actions](#wait-event.lockrelation.actions) - -## Supported engine versions - -This wait event information is supported for all versions of RDS for PostgreSQL\. - -## Context - -Most PostgreSQL commands implicitly use locks to control concurrent access to data in tables\. You can also use these locks explicitly in your application code with the `LOCK` command\. Many lock modes aren't compatible with each other, and they can block transactions when they're trying to access the same object\. When this happens, RDS for PostgreSQL generates a `Lock:Relation` event\. Some common examples are the following: -+ Exclusive locks such as `ACCESS EXCLUSIVE` can block all concurrent access\. Data definition language \(DDL\) operations such as `DROP TABLE`, `TRUNCATE`, `VACUUM FULL`, and `CLUSTER` acquire `ACCESS EXCLUSIVE` locks implicitly\. `ACCESS EXCLUSIVE` is also the default lock mode for `LOCK TABLE` statements that don't specify a mode explicitly\. -+ Using `CREATE INDEX (without CONCURRENT)` on a table conflicts with data manipulation language \(DML\) statements `UPDATE`, `DELETE`, and `INSERT`, which acquire `ROW EXCLUSIVE` locks\. - -For more information about table\-level locks and conflicting lock modes, see [Explicit Locking](https://www.postgresql.org/docs/13/explicit-locking.html) in the PostgreSQL documentation\. - -Blocking queries and transactions typically unblock in one of the following ways: -+ Blocking query – The application can cancel the query or the user can end the process\. The engine can also force the query to end because of a session's statement\-timeout or a deadlock detection mechanism\. -+ Blocking transaction – A transaction stops blocking when it runs a `ROLLBACK` or `COMMIT` statement\. Rollbacks also happen automatically when sessions are disconnected by a client or by network issues, or are ended\. Sessions can be ended when the database engine is shut down, when the system is out of memory, and so forth\. - -## Likely causes of increased waits - -When the `Lock:Relation` event occurs more frequently than normal, it can indicate a performance issue\. Typical causes include the following: - -**Increased concurrent sessions with conflicting table locks** -There might be an increase in the number of concurrent sessions with queries that lock the same table with conflicting locking modes\. - -**Maintenance operations** -Health maintenance operations such as `VACUUM` and `ANALYZE` can significantly increase the number of conflicting locks\. `VACUUM FULL` acquires an `ACCESS EXCLUSIVE` lock, and `ANALYSE` acquires a `SHARE UPDATE EXCLUSIVE` lock\. Both types of locks can cause a `Lock:Relation` wait event\. Application data maintenance operations such as refreshing a materialized view can also increase blocked queries and transactions\. - -**Locks on reader instances** -There might be a conflict between the relation locks held by the writer and readers\. Currently, only `ACCESS EXCLUSIVE` relation locks are replicated to reader instances\. However, the `ACCESS EXCLUSIVE` relation lock will conflict with any `ACCESS SHARE` relation locks held by the reader\. This can cause an increase in lock relation wait events on the reader\. - -## Actions - -We recommend different actions depending on the causes of your wait event\. - -**Topics** -+ [Reduce the impact of blocking SQL statements](#wait-event.lockrelation.actions.reduce-blocks) -+ [Minimize the effect of maintenance operations](#wait-event.lockrelation.actions.maintenance) - -### Reduce the impact of blocking SQL statements - -To reduce the impact of blocking SQL statements, modify your application code where possible\. Following are two common techniques for reducing blocks: -+ Use the `NOWAIT` option – Some SQL commands, such as `SELECT` and `LOCK` statements, support this option\. The `NOWAIT` directive cancels the lock\-requesting query if the lock can't be acquired immediately\. This technique can help prevent a blocking session from causing a pile\-up of blocked sessions behind it\. - - For example: Assume that transaction A is waiting on a lock held by transaction B\. Now, if B requests a lock on a table that’s locked by transaction C, transaction A might be blocked until transaction C completes\. But if transaction B uses a `NOWAIT` when it requests the lock on C, it can fail fast and ensure that transaction A doesn't have to wait indefinitely\. -+ Use `SET lock_timeout` – Set a `lock_timeout` value to limit the time a SQL statement waits to acquire a lock on a relation\. If the lock isn't acquired within the timeout specified, the transaction requesting the lock is cancelled\. Set this value at the session level\. - -### Minimize the effect of maintenance operations - -Maintenance operations such as `VACUUM` and `ANALYZE` are important\. We recommend that you don't turn them off because you find `Lock:Relation` wait events related to these maintenance operations\. The following approaches can minimize the effect of these operations: -+ Run maintenance operations manually during off\-peak hours\. -+ To reduce `Lock:Relation` waits caused by autovacuum tasks, perform any needed autovacuum tuning\. For information about tuning autovacuum, see [ Working with PostgreSQL autovacuum on Amazon RDS](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Appendix.PostgreSQL.CommonDBATasks.Autovacuum.html) in the * Amazon RDS User Guide*\. \ No newline at end of file diff --git a/doc_source/wait-event.locktransactionid.md b/doc_source/wait-event.locktransactionid.md deleted file mode 100644 index ee7b774..0000000 --- a/doc_source/wait-event.locktransactionid.md +++ /dev/null @@ -1,79 +0,0 @@ -# Lock:transactionid - -The `Lock:transactionid` event occurs when a transaction is waiting for a row\-level lock\. - -**Topics** -+ [Supported engine versions](#wait-event.locktransactionid.context.supported) -+ [Context](#wait-event.locktransactionid.context) -+ [Likely causes of increased waits](#wait-event.locktransactionid.causes) -+ [Actions](#wait-event.locktransactionid.actions) - -## Supported engine versions - -This wait event information is supported for all versions of RDS for PostgreSQL\. - -## Context - -The event `Lock:transactionid` occurs when a transaction is trying to acquire a row\-level lock that has already been granted to a transaction that is running at the same time\. The session that shows the `Lock:transactionid` wait event is blocked because of this lock\. After the blocking transaction ends in either a `COMMIT` or `ROLLBACK` statement, the blocked transaction can proceed\. - -The multiversion concurrency control semantics of RDS for PostgreSQL guarantee that readers don't block writers and writers don't block readers\. For row\-level conflicts to occur, blocking and blocked transactions must issue conflicting statements of the following types: -+ `UPDATE` -+ `SELECT … FOR UPDATE` -+ `SELECT … FOR KEY SHARE` - -The statement `SELECT … FOR KEY SHARE` is a special case\. The database uses the clause `FOR KEY SHARE` to optimize the performance of referential integrity\. A row\-level lock on a row can block `INSERT`, `UPDATE`, and `DELETE` commands on other tables that reference the row\. - -## Likely causes of increased waits - -When this event appears more than normal, the cause is typically `UPDATE`, `SELECT … FOR UPDATE`, or `SELECT … FOR KEY SHARE` statements combined with the following conditions\. - -**Topics** -+ [High concurrency](#wait-event.locktransactionid.concurrency) -+ [Idle in transaction](#wait-event.locktransactionid.idle) -+ [Long\-running transactions](#wait-event.locktransactionid.long-running) - -### High concurrency - -RDS for PostgreSQL can use granular row\-level locking semantics\. The probability of row\-level conflicts increases when the following conditions are met: -+ A highly concurrent workload contends for the same rows\. -+ Concurrency increases\. - -### Idle in transaction - -Sometimes the `pg_stat_activity.state` column shows the value `idle in transaction`\. This value appears for sessions that have started a transaction, but haven't yet issued a `COMMIT` or `ROLLBACK`\. If the `pg_stat_activity.state` value isn't `active`, the query shown in `pg_stat_activity` is the most recent one to finish running\. The blocking session isn't actively processing a query because an open transaction is holding a lock\. - -If an idle transaction acquired a row\-level lock, it might be preventing other sessions from acquiring it\. This condition leads to frequent occurrence of the wait event `Lock:transactionid`\. To diagnose the issue, examine the output from `pg_stat_activity` and `pg_locks`\. - -### Long\-running transactions - -Transactions that run for a long time get locks for a long time\. These long\-held locks can block other transactions from running\. - -## Actions - -Row\-locking is a conflict among `UPDATE`, `SELECT … FOR UPDATE`, or `SELECT … FOR KEY SHARE` statements\. Before attempting a solution, find out when these statements are running on the same row\. Use this information to choose a strategy described in the following sections\. - -**Topics** -+ [Respond to high concurrency](#wait-event.locktransactionid.actions.problem) -+ [Respond to idle transactions](#wait-event.locktransactionid.actions.find-blocker) -+ [Respond to long\-running transactions](#wait-event.locktransactionid.actions.concurrency) - -### Respond to high concurrency - -If concurrency is the issue, try one of the following techniques: -+ Lower the concurrency in the application\. For example, decrease the number of active sessions\. -+ Implement a connection pool\. To learn how to pool connections with RDS Proxy, see [Using Amazon RDS Proxy](rds-proxy.md)\. -+ Design the application or data model to avoid contending `UPDATE` and `SELECT … FOR UPDATE` statements\. You can also decrease the number of foreign keys accessed by `SELECT … FOR KEY SHARE` statements\. - -### Respond to idle transactions - -If `pg_stat_activity.state` shows `idle in transaction`, use the following strategies: -+ Turn on autocommit wherever possible\. This approach prevents transactions from blocking other transactions while waiting for a `COMMIT` or `ROLLBACK`\. -+ Search for code paths that are missing `COMMIT`, `ROLLBACK`, or `END`\. -+ Make sure that the exception handling logic in your application always has a path to a valid `end of transaction`\. -+ Make sure that your application processes query results after ending the transaction with `COMMIT` or `ROLLBACK`\. - -### Respond to long\-running transactions - -If long\-running transactions are causing the frequent occurrence of `Lock:transactionid`, try the following strategies: -+ Keep row locks out of long\-running transactions\. -+ Limit the length of queries by implementing autocommit whenever possible\. \ No newline at end of file diff --git a/doc_source/wait-event.locktuple.md b/doc_source/wait-event.locktuple.md deleted file mode 100644 index fd14abe..0000000 --- a/doc_source/wait-event.locktuple.md +++ /dev/null @@ -1,116 +0,0 @@ -# Lock:tuple - -The `Lock:tuple` event occurs when a backend process is waiting to acquire a lock on a tuple\. - -**Topics** -+ [Supported engine versions](#wait-event.locktuple.context.supported) -+ [Context](#wait-event.locktuple.context) -+ [Likely causes of increased waits](#wait-event.locktuple.causes) -+ [Actions](#wait-event.locktuple.actions) - -## Supported engine versions - -This wait event information is supported for all versions of RDS for PostgreSQL\. - -## Context - -The event `Lock:tuple` indicates that a backend is waiting to acquire a lock on a tuple while another backend holds a conflicting lock on the same tuple\. The following table illustrates a scenario in which sessions generate the `Lock:tuple` event\. - - -| Time | Session 1 | Session 2 | Session 3 | -| --- | --- | --- | --- | -| t1 | Starts a transaction\. | | | -| t2 | Updates row 1\. | | | -| t3 | | Updates row 1\. The session acquires an exclusive lock on the tuple and then waits for session 1 to release the lock by committing or rolling back\. | | -| t4 | | | Updates row 1\. The session waits for session 2 to release the exclusive lock on the tuple\. | - -Or you can simulate this wait event by using the benchmarking tool `pgbench`\. Configure a high number of concurrent sessions to update the same row in a table with a custom SQL file\. - -To learn more about conflicting lock modes, see [Explicit Locking](https://www.postgresql.org/docs/current/explicit-locking.html) in the PostgreSQL documentation\. To learn more about `pgbench`, see [pgbench](https://www.postgresql.org/docs/current/pgbench.html) in the PostgreSQL documentation\. - -## Likely causes of increased waits - -When this event appears more than normal, possibly indicating a performance problem, typical causes include the following: -+ A high number of concurrent sessions are trying to acquire a conflicting lock for the same tuple by running `UPDATE` or `DELETE` statements\. -+ Highly concurrent sessions are running a `SELECT` statement using the `FOR UPDATE` or `FOR NO KEY UPDATE` lock modes\. -+ Various factors drive application or connection pools to open more sessions to execute the same operations\. As new sessions are trying to modify the same rows, DB load can spike, and `Lock:tuple` can appear\. - -For more information, see [Row\-Level Locks](https://www.postgresql.org/docs/current/explicit-locking.html#LOCKING-ROWS) in the PostgreSQL documentation\. - -## Actions - -We recommend different actions depending on the causes of your wait event\. - -**Topics** -+ [Investigate your application logic](#wait-event.locktuple.actions.problem) -+ [Find the blocker session](#wait-event.locktuple.actions.find-blocker) -+ [Reduce concurrency when it is high](#wait-event.locktuple.actions.concurrency) -+ [Troubleshoot bottlenecks](#wait-event.locktuple.actions.bottlenecks) - -### Investigate your application logic - -Find out whether a blocker session has been in the `idle in transaction` state for long time\. If so, consider ending the blocker session as a short\-term solution\. You can use the `pg_terminate_backend` function\. For more information about this function, see [Server Signaling Functions](https://www.postgresql.org/docs/13/functions-admin.html#FUNCTIONS-ADMIN-SIGNAL) in the PostgreSQL documentation\. - -For a long\-term solution, do the following: -+ Adjust the application logic\. -+ Use the `idle_in_transaction_session_timeout` parameter\. This parameter ends any session with an open transaction that has been idle for longer than the specified amount of time\. For more information, see [Client Connection Defaults](https://www.postgresql.org/docs/current/runtime-config-client.html#GUC-IDLE-IN-TRANSACTION-SESSION-TIMEOUT) in the PostgreSQL documentation\. -+ Use autocommit as much as possible\. For more information, see [SET AUTOCOMMIT](https://www.postgresql.org/docs/current/ecpg-sql-set-autocommit.html) in the PostgreSQL documentation\. - -### Find the blocker session - -While the `Lock:tuple` wait event is occurring, identify the blocker and blocked session by finding out which locks depend on one another\. For more information, see [Lock dependency information](https://wiki.postgresql.org/wiki/Lock_dependency_information) in the PostgreSQL wiki\. - -The following example queries all sessions, filtering on `tuple` and ordering by `wait_time`\. - -``` -SELECT blocked_locks.pid AS blocked_pid, - blocking_locks.pid AS blocking_pid, - blocked_activity.usename AS blocked_user, - blocking_activity.usename AS blocking_user, - now() - blocked_activity.xact_start AS blocked_transaction_duration, - now() - blocking_activity.xact_start AS blocking_transaction_duration, - concat(blocked_activity.wait_event_type,':',blocked_activity.wait_event) AS blocked_wait_event, - concat(blocking_activity.wait_event_type,':',blocking_activity.wait_event) AS blocking_wait_event, - blocked_activity.state AS blocked_state, - blocking_activity.state AS blocking_state, - blocked_locks.locktype AS blocked_locktype, - blocking_locks.locktype AS blocking_locktype, - blocked_activity.query AS blocked_statement, - blocking_activity.query AS blocking_statement - FROM pg_catalog.pg_locks blocked_locks - JOIN pg_catalog.pg_stat_activity blocked_activity ON blocked_activity.pid = blocked_locks.pid - JOIN pg_catalog.pg_locks blocking_locks - ON blocking_locks.locktype = blocked_locks.locktype - AND blocking_locks.DATABASE IS NOT DISTINCT FROM blocked_locks.DATABASE - AND blocking_locks.relation IS NOT DISTINCT FROM blocked_locks.relation - AND blocking_locks.page IS NOT DISTINCT FROM blocked_locks.page - AND blocking_locks.tuple IS NOT DISTINCT FROM blocked_locks.tuple - AND blocking_locks.virtualxid IS NOT DISTINCT FROM blocked_locks.virtualxid - AND blocking_locks.transactionid IS NOT DISTINCT FROM blocked_locks.transactionid - AND blocking_locks.classid IS NOT DISTINCT FROM blocked_locks.classid - AND blocking_locks.objid IS NOT DISTINCT FROM blocked_locks.objid - AND blocking_locks.objsubid IS NOT DISTINCT FROM blocked_locks.objsubid - AND blocking_locks.pid != blocked_locks.pid - JOIN pg_catalog.pg_stat_activity blocking_activity ON blocking_activity.pid = blocking_locks.pid - WHERE NOT blocked_locks.GRANTED; -``` - -### Reduce concurrency when it is high - -The `Lock:tuple` event might occur constantly, especially in a busy workload time\. In this situation, consider reducing the high concurrency for very busy rows\. Often, just a few rows control a queue or the Boolean logic, which makes these rows very busy\. - -You can reduce concurrency by using different approaches based in the business requirement, application logic, and workload type\. For example, you can do the following: -+ Redesign your table and data logic to reduce high concurrency\. -+ Change the application logic to reduce high concurrency at the row level\. -+ Leverage and redesign queries with row\-level locks\. -+ Use the `NOWAIT` clause with retry operations\. -+ Consider using optimistic and hybrid\-locking logic concurrency control\. -+ Consider changing the database isolation level\. - -### Troubleshoot bottlenecks - -The `Lock:tuple` can occur with bottlenecks such as CPU starvation or maximum usage of Amazon EBS bandwidth\. To reduce bottlenecks, consider the following approaches: -+ Scale up your instance class type\. -+ Optimize resource\-intensive queries\. -+ Change the application logic\. -+ Archive data that is rarely accessed\. \ No newline at end of file diff --git a/doc_source/wait-event.lw-lock-manager.md b/doc_source/wait-event.lw-lock-manager.md deleted file mode 100644 index af42dfa..0000000 --- a/doc_source/wait-event.lw-lock-manager.md +++ /dev/null @@ -1,151 +0,0 @@ -# LWLock:lock\_manager \(LWLock:lockmanager\) - -This event occurs when the RDS for PostgreSQL engine maintains the shared lock's memory area to allocate, check, and deallocate a lock when a fast path lock isn't possible\. - -**Topics** -+ [Supported engine versions](#wait-event.lw-lock-manager.context.supported) -+ [Context](#wait-event.lw-lock-manager.context) -+ [Likely causes of increased waits](#wait-event.lw-lock-manager.causes) -+ [Actions](#wait-event.lw-lock-manager.actions) - -## Supported engine versions - -This wait event information is relevant for RDS for PostgreSQL version 9\.6 and higher\. For RDS for PostgreSQL releases older than version 13, the name of this wait event is `LWLock:lock_manager`\. For RDS for PostgreSQL version 13 and higher, the name of this wait event is `LWLock:lockmanager`\. - -## Context - -When you issue a SQL statement, RDS for PostgreSQL records locks to protect the structure, data, and integrity of your database during concurrent operations\. The engine can achieve this goal using a fast path lock or a path lock that isn't fast\. A path lock that isn't fast is more expensive and creates more overhead than a fast path lock\. - -### Fast path locking - -To reduce the overhead of locks that are taken and released frequently, but that rarely conflict, backend processes can use fast path locking\. The database uses this mechanism for locks that meet the following criteria: -+ They use the DEFAULT lock method\. -+ They represent a lock on a database relation rather than a shared relation\. -+ They are weak locks that are unlikely to conflict\. -+ The engine can quickly verify that no conflicting locks can possibly exist\. - -The engine can't use fast path locking when either of the following conditions is true: -+ The lock doesn't meet the preceding criteria\. -+ No more slots are available for the backend process\. - -To tune your queries for fast\-path lockcing, you can use the following query\. - -``` -SELECT count(*), pid, mode, fastpath - FROM pg_locks - WHERE fastpath IS NOT NULL - GROUP BY 4,3,2 - ORDER BY pid, mode; - count | pid | mode | fastpath --------+------+-----------------+---------- -16 | 9185 | AccessShareLock | t -336 | 9185 | AccessShareLock | f -1 | 9185 | ExclusiveLock | t -``` - -The following query shows only the total across the database\. - -``` -SELECT count(*), mode, fastpath - FROM pg_locks - WHERE fastpath IS NOT NULL - GROUP BY 3,2 - ORDER BY mode,1; -count | mode | fastpath --------+-----------------+---------- -16 | AccessShareLock | t -337 | AccessShareLock | f -1 | ExclusiveLock | t -(3 rows) -``` - -For more information about fast path locking, see [fast path](https://github.com/postgres/postgres/blob/master/src/backend/storage/lmgr/README#L70-L76) in the PostgreSQL lock manager README and [pg\-locks](https://www.postgresql.org/docs/9.3/view-pg-locks.html#AEN98195) in the PostgreSQL documentation\. - -### Example of a scaling problem for the lock manager - -In this example, a table named `purchases` stores five years of data, partitioned by day\. Each partition has two indexes\. The following sequence of events occurs: - -1. You query many days worth of data, which requires the database to read many partitions\. - -1. The database creates a lock entry for each partition\. If partition indexes are part of the optimizer access path, the database creates a lock entry for them, too\. - -1. When the number of requested locks entries for the same backend process is higher than 16, which is the value of `FP_LOCK_SLOTS_PER_BACKEND`, the lock manager uses the non–fast path lock method\. - -Modern applications might have hundreds of sessions\. If concurrent sessions are querying the parent without proper partition pruning, the database might create hundreds or even thousands of non–fast path locks\. Typically, when this concurrency is higher than the number of vCPUs, the `LWLock:lock_manager` wait event appears\. - -**Note** -The `LWLock:lock_manager` wait event isn't related to the number of partitions or indexes in a database schema\. Instead, it's related to the number of non–fast path locks that the database must control\. - -## Likely causes of increased waits - -When the `LWLock:lock_manager` wait event occurs more than normal, possibly indicating a performance problem, the most likely causes of sudden spikes are as follows: -+ Concurrent active sessions are running queries that don't use fast path locks\. These sessions also exceed the maximum vCPU\. -+ A large number of concurrent active sessions are accessing a heavily partitioned table\. Each partition has multiple indexes\. -+ The database is experiencing a connection storm\. By default, some applications and connection pool software create more connections when the database is slow\. This practice makes the problem worse\. Tune your connection pool software so that connection storms don't occur\. -+ A large number of sessions query a parent table without pruning partitions\. -+ A data definition language \(DDL\), data manipulation language \(DML\), or a maintenance command exclusively locks either a busy relation or tuples that are frequently accessed or modified\. - -## Actions - -If the `CPU` wait event occurs, it doesn't necessarily indicate a performance problem\. Respond to this event only when performance degrades and this wait event is dominating DB load\. - -**Topics** -+ [Use partition pruning](#wait-event.lw-lock-manager.actions.pruning) -+ [Remove unnecessary indexes](#wait-event.lw-lock-manager.actions.indexes) -+ [Tune your queries for fast path locking](#wait-event.lw-lock-manager.actions.tuning) -+ [Tune for other wait events](#wait-event.lw-lock-manager.actions.other-waits) -+ [Reduce hardware bottlenecks](#wait-event.lw-lock-manager.actions.hw-bottlenecks) -+ [Use a connection pooler](#wait-event.lw-lock-manager.actions.pooler) -+ [Upgrade your RDS for PostgreSQL version](#wait-event.lw-lock-manager.actions.pg-version) - -### Use partition pruning - -*Partition pruning* is a query optimization strategy for declaratively partitioned tables that excludes unneeded partitions from table scans, thereby improving performance\. Partition pruning is turned on by default\. If it is turned off, turn it on as follows\. - -``` -SET enable_partition_pruning = on; -``` - -Queries can take advantage of partition pruning when their `WHERE` clause contains the column used for the partitioning\. For more information, see [Partition Pruning](https://www.postgresql.org/docs/current/ddl-partitioning.html#DDL-PARTITION-PRUNING) in the PostgreSQL documentation\. - -### Remove unnecessary indexes - -Your database might contain unused or rarely used indexes\. If so, consider deleting them\. Do either of the following: -+ Learn how to find unnecessary indexes by reading [Unused Indexes](https://wiki.postgresql.org/wiki/Index_Maintenance#Unused_Indexes) in the PostgreSQL wiki\. -+ Run PG Collector\. This SQL script gathers database information and presents it in a consolidated HTML report\. Check the "Unused indexes" section\. For more information, see [pg\-collector](https://github.com/awslabs/pg-collector) in the AWS Labs GitHub repository\. - -### Tune your queries for fast path locking - -To find out whether your queries use fast path locking, query the `fastpath` column in the `pg_locks` table\. If your queries aren't using fast path locking, try to reduce number of relations per query to fewer than 16\. - -### Tune for other wait events - -If `LWLock:lock_manager` is first or second in the list of top waits, check whether the following wait events also appear in the list: -+ `Lock:Relation` -+ `Lock:transactionid` -+ `Lock:tuple` - -If the preceding events appear high in the list, consider tuning these wait events first\. These events can be a driver for `LWLock:lock_manager`\. - -### Reduce hardware bottlenecks - -You might have a hardware bottleneck, such as CPU starvation or maximum usage of your Amazon EBS bandwidth\. In these cases, consider reducing the hardware bottlenecks\. Consider the following actions: -+ Scale up your instance class\. -+ Optimize queries that consume large amounts of CPU and memory\. -+ Change your application logic\. -+ Archive your data\. - -For more information about CPU, memory, and EBS network bandwidth, see [Amazon RDS Instance Types](https://aws.amazon.com/rds/instance-types/)\. - -### Use a connection pooler - -If your total number of active connections exceeds the maximum vCPU, more OS processes require CPU than your instance type can support\. In this case, consider using or tuning a connection pool\. For more information about the vCPUs for your instance type, see [Amazon RDS Instance Types](https://aws.amazon.com/rds/instance-types/)\. - -For more information about connection pooling, see the following resources: -+ [Using Amazon RDS Proxy](rds-proxy.md) -+ [pgbouncer](http://www.pgbouncer.org/usage.html) -+ [Connection Pools and Data Sources](https://www.postgresql.org/docs/7.4/jdbc-datasource.html) in the *PostgreSQL Documentation* - -### Upgrade your RDS for PostgreSQL version - -If your current version of RDS for PostgreSQL is lower than 12, upgrade to version 12 or higher\. PostgreSQL versions 12 and later have an improved partition mechanism\. For more information about version 12, see [PostgreSQL 12\.0 Release Notes]( https://www.postgresql.org/docs/release/12.0/)\. For more information about upgrading RDS for PostgreSQL, see [Upgrading the PostgreSQL DB engine for Amazon RDS](USER_UpgradeDBInstance.PostgreSQL.md)\. \ No newline at end of file diff --git a/doc_source/wait-event.lwl-buffer-mapping.md b/doc_source/wait-event.lwl-buffer-mapping.md deleted file mode 100644 index 7e66964..0000000 --- a/doc_source/wait-event.lwl-buffer-mapping.md +++ /dev/null @@ -1,69 +0,0 @@ -# LWLock:BufferMapping \(LWLock:buffer\_mapping\) - -This event occurs when a session is waiting to associate a data block with a buffer in the shared buffer pool\. - -**Note** -This event is named `LWLock:BufferMapping` for RDS for PostgreSQL version 13 and higher versions\. For RDS for PostgreSQL version 12 and older versions, this event is named `LWLock:buffer_mapping`\. - -**Topics** -+ [Supported engine versions](#wait-event.lwl-buffer-mapping.context.supported) -+ [Context](#wait-event.lwl-buffer-mapping.context) -+ [Causes](#wait-event.lwl-buffer-mapping.causes) -+ [Actions](#wait-event.lwl-buffer-mapping.actions) - -## Supported engine versions - -This wait event information is relevant for RDS for PostgreSQL version 9\.6 and higher\. - -## Context - -The *shared buffer pool* is a PostgreSQL memory area that holds all pages that are or were being used by processes\. When a process needs a page, it reads the page into the shared buffer pool\. The `shared_buffers` parameter sets the shared buffer size and reserves a memory area to store the table and index pages\. If you change this parameter, make sure to restart the database\. \. - -The `LWLock:buffer_mapping` wait event occurs in the following scenarios: -+ A process searches the buffer table for a page and acquires a shared buffer mapping lock\. -+ A process loads a page into the buffer pool and acquires an exclusive buffer mapping lock\. -+ A process removes a page from the pool and acquires an exclusive buffer mapping lock\. - -## Causes - -When this event appears more than normal, possibly indicating a performance problem, the database is paging in and out of the shared buffer pool\. Typical causes include the following: -+ Large queries -+ Bloated indexes and tables -+ Full table scans -+ A shared pool size that is smaller than the working set - -## Actions - -We recommend different actions depending on the causes of your wait event\. - -**Topics** -+ [Monitor buffer\-related metrics](#wait-event.lwl-buffer-mapping.actions.monitor-metrics) -+ [Assess your indexing strategy](#wait-event.lwl-buffer-mapping.actions.indexes) -+ [Reduce the number of buffers that must be allocated quickly](#wait-event.lwl-buffer-mapping.actions.buffers) - -### Monitor buffer\-related metrics - -When `LWLock:buffer_mapping` waits spike, investigate the buffer hit ratio\. You can use these metrics to get a better understanding of what is happening in the buffer cache\. Examine the following metrics: - -`BufferCacheHitRatio` -This Amazon CloudWatch metric measures the percentage of requests that are served by the buffer cache of a DB instance in your DB instance\. You might see this metric decrease in the lead\-up to the `LWLock:buffer_mapping` wait event\. - -`blks_hit` -This Performance Insights counter metric indicates the number of blocks that were retrieved from the shared buffer pool\. After the `LWLock:buffer_mapping` wait event appears, you might observe a spike in `blks_hit`\. - -`blks_read` -This Performance Insights counter metric indicates the number of blocks that required I/O to be read into the shared buffer pool\. You might observe a spike in `blks_read` in the lead\-up to the `LWLock:buffer_mapping` wait event\. - -### Assess your indexing strategy - -To confirm that your indexing strategy is not degrading performance, check the following: - -Index bloat -Ensure that index and table bloat aren't leading to unnecessary pages being read into the shared buffer\. If your tables contain unused rows, consider archiving the data and removing the rows from the tables\. You can then rebuild the indexes for the resized tables\. - -Indexes for frequently used queries -To determine whether you have the optimal indexes, monitor DB engine metrics in Performance Insights\. The `tup_returned` metric shows the number of rows read\. The `tup_fetched` metric shows the number of rows returned to the client\. If `tup_returned` is significantly larger than `tup_fetched`, the data might not be properly indexed\. Also, your table statistics might not be current\. - -### Reduce the number of buffers that must be allocated quickly - -To reduce the `LWLock:buffer_mapping` wait events, try to reduce the number of buffers that must be allocated quickly\. One strategy is to perform smaller batch operations\. You might be able to achieve smaller batches by partitioning your tables\. \ No newline at end of file diff --git a/doc_source/wait-event.lwlockbuffercontent.md b/doc_source/wait-event.lwlockbuffercontent.md deleted file mode 100644 index bc29dcd..0000000 --- a/doc_source/wait-event.lwlockbuffercontent.md +++ /dev/null @@ -1,58 +0,0 @@ -# LWLock:buffer\_content \(BufferContent\) - -The `LWLock:buffer_content` event occurs when a session is waiting to read or write a data page in memory while another session has that page locked for writing\. In RDS for PostgreSQL 13 and higher, this wait event is called `BufferContent`\. - -**Topics** -+ [Supported engine versions](#wait-event.lwlockbuffercontent.context.supported) -+ [Context](#wait-event.lwlockbuffercontent.context) -+ [Likely causes of increased waits](#wait-event.lwlockbuffercontent.causes) -+ [Actions](#wait-event.lwlockbuffercontent.actions) - -## Supported engine versions - -This wait event information is supported for all versions of RDS for PostgreSQL\. - -## Context - -To read or manipulate data, PostgreSQL accesses it through shared memory buffers\. To read from the buffer, a process gets a lightweight lock \(LWLock\) on the buffer content in shared mode\. To write to the buffer, it gets that lock in exclusive mode\. Shared locks allow other processes to concurrently acquire shared locks on that content\. Exclusive locks prevent other processes from getting any type of lock on it\. - -The `LWLock:buffer_content` \(`BufferContent`\) event indicates that multiple processes are attempting to get a lock on contents of a specific buffer\. - -## Likely causes of increased waits - -When the `LWLock:buffer_content` \(`BufferContent`\) event appears more than normal, possibly indicating a performance problem, typical causes include the following: - -**Increased concurrent updates to the same data** -There might be an increase in the number of concurrent sessions with queries that update the same buffer content\. This contention can be more pronounced on tables with a lot of indexes\. - -**Workload data is not in memory** -When data that the active workload is processing is not in memory, these wait events can increase\. This effect is because processes holding locks can keep them longer while they perform disk I/O operations\. - -**Excessive use of foreign key constraints** -Foreign key constraints can increase the amount of time a process holds onto a buffer content lock\. This effect is because read operations require a shared buffer content lock on the referenced key while that key is being updated\. - -## Actions - -We recommend different actions depending on the causes of your wait event\. You might identify `LWLock:buffer_content` \(`BufferContent`\) events by using Amazon RDS Performance Insights or by querying the view `pg_stat_activity`\. - -**Topics** -+ [Improve in\-memory efficiency](#wait-event.lwlockbuffercontent.actions.in-memory) -+ [Reduce usage of foreign key constraints](#wait-event.lwlockbuffercontent.actions.foreignkey) -+ [Remove unused indexes](#wait-event.lwlockbuffercontent.actions.indexes) -+ [Increase the cache size when using sequences](#wait-event.lwlockbuffercontent.actions.sequences) - -### Improve in\-memory efficiency - -To increase the chance that active workload data is in memory, partition tables or scale up your instance class\. For information about DB instance classes, see [DB instance classes](Concepts.DBInstanceClass.md)\. - -### Reduce usage of foreign key constraints - -Investigate workloads experiencing high numbers of `LWLock:buffer_content` \(`BufferContent`\) wait events for usage of foreign key constraints\. Remove unnecessary foreign key constraints\. - -### Remove unused indexes - -For workloads experiencing high numbers of `LWLock:buffer_content` \(`BufferContent`\) wait events, identify unused indexes and remove them\. - -### Increase the cache size when using sequences - -If your tables uses sequences, increase the cache size to remove contention on sequence pages and index pages\. Each sequence is a single page in shared memory\. The pre\-defined cache is per connection\. This might not be enough to handle the workload when many concurrent sessions are getting a sequence value\. \ No newline at end of file diff --git a/doc_source/wait-event.lwlockbufferio.md b/doc_source/wait-event.lwlockbufferio.md deleted file mode 100644 index 32d7db6..0000000 --- a/doc_source/wait-event.lwlockbufferio.md +++ /dev/null @@ -1,48 +0,0 @@ -# LWLock:BufferIO - -The `LWLock:BufferIO` event occurs when RDS for PostgreSQL is waiting for other processes to finish their input/output \(I/O\) operations when concurrently trying to access a page\. Its purpose is for the same page to be read into the shared buffer\. - -**Topics** -+ [Relevant engine versions](#wait-event.lwlockbufferio.context.supported) -+ [Context](#wait-event.lwlockbufferio.context) -+ [Causes](#wait-event.lwlockbufferio.causes) -+ [Actions](#wait-event.lwlockbufferio.actions) - -## Relevant engine versions - -This wait event information is relevant for all RDS for PostgreSQL versions\. For RDS for PostgreSQL versions earlier than PostgreSQL 14, this wait event type is `lwlock`\. For PostgreSQL 14 and later releases, the wait\_event type is `IPC`\. - -## Context - -Each shared buffer has an I/O lock that is associated with the `LWLock:BufferIO` wait event, each time a block \(or a page\) has to be retrieved outside the shared buffer pool\. - -This lock is used to handle multiple sessions that all require access to the same block\. This block has to be read from outside the shared buffer pool, defined by the `shared_buffers` parameter\. - -As soon as the page is read inside the shared buffer pool, the `LWLock:BufferIO` lock is released\. - -**Note** -The `LWLock:BufferIO` wait event precedes the [IO:DataFileRead](wait-event.iodatafileread.md) wait event\. The `IO:DataFileRead` wait event occurs while data is being read from storage\. - -For more information on lightweight locks, see [Locking Overview](https://github.com/postgres/postgres/blob/65dc30ced64cd17f3800ff1b73ab1d358e92efd8/src/backend/storage/lmgr/README#L20)\. - -## Causes - -Common causes for the `LWLock:BufferIO` event to appear in top waits include the following: -+ Multiple backends or connections trying to access the same page that's also pending an I/O operation -+ The ratio between the size of the shared buffer pool \(defined by the `shared_buffers` parameter\) and the number of buffers needed by the current workload -+ The size of the shared buffer pool not being well balanced with the number of pages being evicted by other operations -+ Large or bloated indexes that require the engine to read more pages than necessary into the shared buffer pool -+ Lack of indexes that forces the DB engine to read more pages from the tables than necessary -+ Checkpoints occurring too frequently or needing to flush too many modified pages -+ Sudden spikes for database connections trying to perform operations on the same page - -## Actions - -We recommend different actions depending on the causes of your wait event: -+ Observe Amazon CloudWatch metrics for correlation between sharp decreases in the `BufferCacheHitRatio` and `LWLock:BufferIO` wait events\. This effect can mean that you have a small shared buffers setting\. You might need to increase it or scale up your DB instance class\. You can split your workload into more reader nodes\. -+ Tune `max_wal_size` and `checkpoint_timeout` based on your workload peak time if you see `LWLock:BufferIO` coinciding with `BufferCacheHitRatio` metric dips\. Then identify which query might be causing it\. -+ Verify whether you have unused indexes, then remove them\. -+ Use partitioned tables \(which also have partitioned indexes\)\. Doing this helps to keep index reordering low and reduces its impact\. -+ Avoid indexing columns unnecessarily\. -+ Prevent sudden database connection spikes by using a connection pool\. -+ Restrict the maximum number of connections to the database as a best practice\. \ No newline at end of file diff --git a/doc_source/wait-event.timeoutpgsleep.md b/doc_source/wait-event.timeoutpgsleep.md deleted file mode 100644 index 8b91400..0000000 --- a/doc_source/wait-event.timeoutpgsleep.md +++ /dev/null @@ -1,25 +0,0 @@ -# Timeout:PgSleep - -The `Timeout:PgSleep` event occurs when a server process has called the `pg_sleep` function and is waiting for the sleep timeout to expire\. - -**Topics** -+ [Supported engine versions](#wait-event.timeoutpgsleep.context.supported) -+ [Likely causes of increased waits](#wait-event.timeoutpgsleep.causes) -+ [Actions](#wait-event.timeoutpgsleep.actions) - -## Supported engine versions - -This wait event information is supported for all versions of RDS for PostgreSQL\. - -## Likely causes of increased waits - -This wait event occurs when an application, stored function, or user issues a SQL statement that calls one of the following functions: -+ `pg_sleep` -+ `pg_sleep_for` -+ `pg_sleep_until` - -The preceding functions delay execution until the specified number of seconds have elapsed\. For example, `SELECT pg_sleep(1)` pauses for 1 second\. For more information, see [Delaying Execution](https://www.postgresql.org/docs/current/functions-datetime.html#FUNCTIONS-DATETIME-DELAY) in the PostgreSQL documentation\. - -## Actions - -Identify the statement that was running the `pg_sleep` function\. Determine if the use of the function is appropriate\. \ No newline at end of file diff --git a/doc_source/wait-event.timeoutvacuumdelay.md b/doc_source/wait-event.timeoutvacuumdelay.md deleted file mode 100644 index c36588c..0000000 --- a/doc_source/wait-event.timeoutvacuumdelay.md +++ /dev/null @@ -1,49 +0,0 @@ -# Timeout:VacuumDelay - -The `Timeout:VacuumDelay` event indicates that the cost limit for vacuum I/O has been exceeded and that the vacuum process has been put to sleep\. Vacuum operations stop for the duration specified in the respective cost delay parameter and then it resumes its work\. For the manual vacuum command, the delay is specified in the `vacuum_cost_delay` parameter\. For the autovacuum daemon, the delay is specified in the `autovacuum_vacuum_cost_delay parameter.` - -**Topics** -+ [Supported engine versions](#wait-event.timeoutvacuumdelay.context.supported) -+ [Context](#wait-event.timeoutvacuumdelay.context) -+ [Likely causes of increased waits](#wait-event.timeoutvacuumdelay.causes) -+ [Actions](#wait-event.timeoutvacuumdelay.actions) - -## Supported engine versions - -This wait event information is supported for all versions of RDS for PostgreSQL\. - -## Context - -PostgreSQL has both an autovacuum daemon and a manual vacuum command\. The autovacuum process is "on" by default for RDS for PostgreSQL DB instances\. The manual vacuum command is used on an as\-needed basis, for example, to purge tables of dead tuples or generate new statistics\. - -When vacuuming is underway, PostgreSQL uses an internal counter to keep track of estimated costs as the system performs various I/O operations\. When the counter reaches the value specified by the cost limit parameter, the process performing the operation sleeps for the brief duration specified in the cost delay parameter\. It then resets the counter and continues operations\. - -The vacuum process has parameters that can be used to regulate resource consumption\. The autovacuum and the manual vacuum command have their own parameters for setting the cost limit value\. They also have their own parameters to specify a cost delay, an amount of time to put the vacuum to sleep when the limit is reached\. In this way, the cost delay parameter works as a throttling mechanism for resource consumption\. In the following lists, you can find description of these parameters\. - -**Parameters that affect throttling of the autovacuum daemon** -+ `[autovacuum\_vacuum\_cost\_limit](https://www.postgresql.org/docs/current/static/runtime-config-autovacuum.html#GUC-AUTOVACUUM-VACUUM-COST-LIMIT)` – Specifies the cost limit value to use in automatic vacuum operations\. Increasing the setting for this parameter allows the vacuum process to use more resources and decreases the `Timeout:VacuumDelay` wait event\. -+ `[autovacuum\_vacuum\_cost\_delay](https://www.postgresql.org/docs/current/static/runtime-config-autovacuum.html#GUC-AUTOVACUUM-VACUUM-COST-DELAY)` – Specifies the cost delay value to use in automatic vacuum operations\. The default value is 2 milliseconds\. Setting the delay parameter to 0 turns off the throttling mechanism and thus, the `Timeout:VacuumDelay` wait event won't appear\. - -For more information, see [Automatic Vacuuming](https://www.postgresql.org/docs/current/runtime-config-autovacuum.html#GUC-AUTOVACUUM-VACUUM-COST-DELAY) in the PostgreSQL documentation\. - -**Parameters that affect throttling of the manual vacuum process** -+ `vacuum_cost_limit` – The threshold at which the vacuuming process is put to sleep\. By default, the limit is 200\. This number represents the accumulated cost estimates for extra I/O needed by various resources\. Increasing this value reduces the number of the `Timeout:VacuumDelay` wait event\. -+ `vacuum_cost_delay` – The amount of time that the vacuum process sleeps when the vacuum cost limit has been reached\. The default setting is 0, which means that this feature is off\. You can set this to an integer value to specify the number of milliseconds to turn on this feature, but we recommend that you leave it at its default setting\. - -For more information about the `vacuum_cost_delay` parameter, see [Resource Consumption](https://www.postgresql.org/docs/current/runtime-config-resource.html#RUNTIME-CONFIG-RESOURCE-VACUUM-COST) in the PostgreSQL documentation\. - -To learn more about how to configure and use the autovacuum with RDS for PostgreSQL, see [Working with the PostgreSQL autovacuum on Amazon RDS for PostgreSQL](Appendix.PostgreSQL.CommonDBATasks.Autovacuum.md)\. - -## Likely causes of increased waits - -The `Timeout:VacuumDelay` is affected by the balance between the cost limit parameter settings \(`vacuum_cost_limit`, `autovacuum_vacuum_cost_limit`\) and the cost delay parameters \(`vacuum_cost_delay`, `autovacuum_vacuum_cost_delay`\) that control the vacuum's sleep duration\. Raising a cost limit parameter value allows more resources to be used by the vacuum before being put to sleep\. That results in fewer `Timeout:VacuumDelay` wait events\. Increasing either of the delay parameters causes the `Timeout:VacuumDelay` wait event to occur more frequently and for longer periods of time\. - -The `autovacuum_max_worker` parameter setting can also increase numbers of the `Timeout:VacuumDelay`\. Each additional autovacuum worker process contributes to the internal counter mechanism, and thus the limit can be reached more quickly than with a single autovacuum worker process\. As the cost limit is reached more quickly, the cost delay is put to effect more frequently, resulting in more `Timeout:VacuumDelay` wait events\. For more information, see [autovacuum\_max\_worker](https://www.postgresql.org/docs/current/runtime-config-autovacuum.html#GUC-AUTOVACUUM-MAX-WORKERS) in the PostgreSQL documentation\. - -Large objects, such as 500GB or larger, also raise this wait event because it can take some time for the vacuum to complete processing large objects\. - -## Actions - -If the vacuum operations complete as expected, no remediation is needed\. In other words, this wait event doesn't necessarily indicate a problem\. It indicates that the vacuum is being put to sleep for the period of time specified in the delay parameter so that resources can be applied to other processes that need to complete\. - -If you want vacuum operations to complete faster, you can lower the delay parameters\. This shortens the time that the vacuum sleeps\. \ No newline at end of file diff --git a/doc_source/working-with-custom-oracle.md b/doc_source/working-with-custom-oracle.md deleted file mode 100644 index c833250..0000000 --- a/doc_source/working-with-custom-oracle.md +++ /dev/null @@ -1,15 +0,0 @@ -# Working with RDS Custom for Oracle - -Following, you can find instructions for creating, managing, and maintaining your RDS Custom for Oracle DB instances\. - -**Topics** -+ [RDS Custom for Oracle workflow](custom-concept.workflow.md) -+ [RDS Custom for Oracle requirements and limitations](custom-reqs-limits.md) -+ [Setting up your environment for Amazon RDS Custom for Oracle](custom-setup-orcl.md) -+ [Working with custom engine versions for Amazon RDS Custom for Oracle](custom-cev.md) -+ [Configuring a DB instance for Amazon RDS Custom for Oracle](custom-creating.md) -+ [Managing an Amazon RDS Custom for Oracle DB instance](custom-managing.md) -+ [Working with Oracle replicas for RDS Custom for Oracle](custom-rr.md) -+ [Backing up and restoring an Amazon RDS Custom for Oracle DB instance](custom-backup.md) -+ [Migrating an on\-premises database to RDS Custom for Oracle](custom-migrating-oracle.md) -+ [Upgrading a DB instance for Amazon RDS Custom for Oracle](custom-upgrading.md) \ No newline at end of file diff --git a/doc_source/working-with-custom-sqlserver.md b/doc_source/working-with-custom-sqlserver.md deleted file mode 100644 index 8fad99d..0000000 --- a/doc_source/working-with-custom-sqlserver.md +++ /dev/null @@ -1,16 +0,0 @@ -# Working with RDS Custom for SQL Server - -Following, you can find instructions for creating, managing, and maintaining your RDS Custom for SQL Server DB instances\. - -**Topics** -+ [RDS Custom for SQL Server workflow](custom-sqlserver.workflow.md) -+ [Requirements and limitations for Amazon RDS Custom for SQL Server](custom-reqs-limits-MS.md) -+ [Setting up your environment for Amazon RDS Custom for SQL Server](custom-setup-sqlserver.md) -+ [Bring Your Own Media with RDS Custom for SQL Server](custom-sqlserver.byom.md) -+ [Working with custom engine versions for RDS Custom for SQL Server](custom-cev-sqlserver.md) -+ [Creating and connecting to a DB instance for Amazon RDS Custom for SQL Server](custom-creating-sqlserver.md) -+ [Managing an Amazon RDS Custom for SQL Server DB instance](custom-managing-sqlserver.md) -+ [Managing a Multi\-AZ deployment for RDS Custom for SQL Server](custom-sqlserver-multiaz.md) -+ [Backing up and restoring an Amazon RDS Custom for SQL Server DB instance](custom-backup-sqlserver.md) -+ [Migrating an on\-premises database to Amazon RDS Custom for SQL Server](custom-migrating.md) -+ [Upgrading a DB instance for Amazon RDS Custom for SQL Server](custom-upgrading-sqlserver.md) \ No newline at end of file diff --git a/doc_source/working-with-events.md b/doc_source/working-with-events.md deleted file mode 100644 index fec59e6..0000000 --- a/doc_source/working-with-events.md +++ /dev/null @@ -1,10 +0,0 @@ -# Monitoring Amazon RDS events - -An *event* indicates a change in an environment\. This can be an AWS environment, an SaaS partner service or application, or a custom application or service\. For descriptions of the RDS events, see [Amazon RDS event categories and event messages](USER_Events.Messages.md)\. - -**Topics** -+ [Overview of events for Amazon RDS](rds-cloudwatch-events.sample.md) -+ [Viewing Amazon RDS events](USER_ListEvents.md) -+ [Working with Amazon RDS event notification](USER_Events.md) -+ [Creating a rule that triggers on an Amazon RDS event](rds-cloud-watch-events.md) -+ [Amazon RDS event categories and event messages](USER_Events.Messages.md) \ No newline at end of file