Skip to content
This repository has been archived by the owner on Jun 15, 2023. It is now read-only.

Commit

Permalink
Documentation updates from the week of 2020-08-21
Browse files Browse the repository at this point in the history
  • Loading branch information
max-webster committed Aug 22, 2020
1 parent 63f7ffb commit f83c1cc
Show file tree
Hide file tree
Showing 25 changed files with 102 additions and 77 deletions.
2 changes: 1 addition & 1 deletion doc_source/Aurora.CreateInstance.md
Original file line number Diff line number Diff line change
Expand Up @@ -304,7 +304,7 @@ The following table contains details about settings that you choose when you cre
| For This Option | Do This |
| --- | --- |
| **Availability zone** | Determine if you want to specify a particular Availability Zone\. For more information about Availability Zones, see [ Regions and Availability Zones ](Concepts.RegionsAndAvailabilityZones.md)\. |
| **Auto minor version upgrade** | Choose **Enable auto minor version upgrade** if you want to enable your Aurora DB cluster to receive preferred minor version upgrades to the DB engine automatically when they become available\. The **Auto minor version upgrade** setting only applies to Aurora PostgreSQL DB clusters\. For more information about engine updates for Aurora PostgreSQL, see [Database Engine Updates for Amazon Aurora PostgreSQL ](AuroraPostgreSQL.Updates.md)\. For more information about engine updates for Aurora MySQL, see [Database Engine Updates for Amazon Aurora MySQL](AuroraMySQL.Updates.md)\. |
| **Auto minor version upgrade** | Choose **Enable auto minor version upgrade** if you want to enable your Aurora DB cluster to receive preferred minor version upgrades to the DB engine automatically when they become available\. The **Auto minor version upgrade** setting applies to botn Aurora PostgreSQL and Aurora MySQL DB clusters\. For Aurora MySQL 1\.x and 2\.x clusters, this setting upgrades the clusters to a maximum version of 1\.22\.2 and 2\.07\.2\. For more information about engine updates for Aurora PostgreSQL, see [Database Engine Updates for Amazon Aurora PostgreSQL ](AuroraPostgreSQL.Updates.md)\. For more information about engine updates for Aurora MySQL, see [Database Engine Updates for Amazon Aurora MySQL](AuroraMySQL.Updates.md)\. |
| **Backtrack** | Applies only to Aurora MySQL\. Choose **Enable Backtrack** to enable backtracking or **Disable Backtrack** to disable backtracking\. Using backtracking, you can rewind a DB cluster to a specific time, without creating a new DB cluster\. It is disabled by default\. If you enable backtracking, also specify the amount of time that you want to be able to backtrack your DB cluster \(the target backtrack window\)\. For more information, see [Backtracking an Aurora DB Cluster](AuroraMySQL.Managing.Backtrack.md)\. |
| Copy tags to snapshots | Choose this option to copy 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](UsingWithRDS.IAMDBAuth.md)\. |
Expand Down
6 changes: 6 additions & 0 deletions doc_source/Aurora.Managing.Clone.md
Original file line number Diff line number Diff line change
Expand Up @@ -466,6 +466,9 @@ The [restore\-db\-cluster\-to\-point\-in\-time](https://docs.aws.amazon.com/cli/
}
```

**Note**
The [restore\-db\-cluster\-to\-point\-in\-time](https://docs.aws.amazon.com/cli/latest/reference/rds/restore-db-cluster-to-point-in-time.html) AWS CLI command only restores the DB cluster, not the DB instances for that DB cluster\. You must invoke the [create\-db\-instance](https://docs.aws.amazon.com/cli/latest/reference/rds/create-db-instance.html) command to create DB instances for the restored DB cluster, specifying the identifier of the restored DB cluster in `--db-cluster-identifier`\. You can create DB instances only after the `restore-db-cluster-to-point-in-time` command has completed and the DB cluster is available\.

##### RDS API<a name="Aurora.Managing.Clone.CrossAccount.cloning.api"></a>

**To clone an Aurora cluster owned by another AWS account using the RDS API**
Expand Down Expand Up @@ -523,6 +526,9 @@ The [restore\-db\-cluster\-to\-point\-in\-time](https://docs.aws.amazon.com/cli/
}
```

**Note**
The [RestoreDBClusterToPointInTime](https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_RestoreDBClusterToPointInTime.html) RDS API operation only restores the DB cluster, not the DB instances for that DB cluster\. You must invoke the [CreateDBInstance](https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_CreateDBInstance.html) RDS API operation to create DB instances for the restored DB cluster, specifying the identifier of the restored DB cluster in `DBClusterIdentifier`\. You can create DB instances only after the `RestoreDBClusterToPointInTime` operation has completed and the DB cluster is available\.

#### Checking If a DB Cluster is a Cross\-Account Clone<a name="Aurora.Managing.Clone.CrossAccount.checking"></a>

The `DBClusters` object identifies whether each cluster is a cross\-account clone\. You can see the clusters that you have permission to clone by using the `include-shared` option when you run the RDS CLI command [https://docs.aws.amazon.com/cli/latest/reference/rds/describe-db-clusters.html](https://docs.aws.amazon.com/cli/latest/reference/rds/describe-db-clusters.html)\. However, you can't see most of the configuration details for such clusters\.
Expand Down
2 changes: 1 addition & 1 deletion doc_source/Aurora.Modifying.md
Original file line number Diff line number Diff line change
Expand Up @@ -140,7 +140,7 @@ The following table contains details about which settings you can modify, the me

| Setting and Description | Method | Scope | Downtime Notes |
| --- | --- | --- | --- |
| **Auto minor version upgrade** Whether you want the DB instance to receive preferred minor engine version upgrades automatically when they become available\. Upgrades are installed only during your scheduled maintenance window\. The **Auto minor version upgrade** setting only applies to Aurora PostgreSQL DB clusters\. For more information about engine updates for Aurora PostgreSQL, see [Database Engine Updates for Amazon Aurora PostgreSQL ](AuroraPostgreSQL.Updates.md)\. For more information about engine updates for Aurora MySQL, see [Database Engine Updates for Amazon Aurora MySQL](AuroraMySQL.Updates.md)\. | Using the AWS Management Console, [Modify a DB Instance in a DB Cluster](#Aurora.Modifying.Instance)\. Using the AWS CLI, run [ `modify-db-instance`](https://docs.aws.amazon.com/cli/latest/reference/rds/modify-db-instance.html) and set the `--auto-minor-version-upgrade\|--no-auto-minor-version-upgrade` option\. Using the RDS API, call [ `ModifyDBInstance`](https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_ModifyDBInstance.html) and set the `AutoMinorVersionUpgrade` parameter\. | The entire DB cluster | An outage doesn't occur during this change\. |
| **Auto minor version upgrade** Whether you want the DB instance to receive preferred minor engine version upgrades automatically when they become available\. Upgrades are installed only during your scheduled maintenance window\. The **Auto minor version upgrade** setting applies to both Aurora PostgreSQL and Aurora MySQL DB clusters\. For Aurora MySQL 1\.x and 2\.x clusters, this setting upgrades the clusters to a maximum version of 1\.22\.2 and 2\.07\.2\. For more information about engine updates for Aurora PostgreSQL, see [Database Engine Updates for Amazon Aurora PostgreSQL ](AuroraPostgreSQL.Updates.md)\. For more information about engine updates for Aurora MySQL, see [Database Engine Updates for Amazon Aurora MySQL](AuroraMySQL.Updates.md)\. | Using the AWS Management Console, [Modify a DB Instance in a DB Cluster](#Aurora.Modifying.Instance)\. Using the AWS CLI, run [ `modify-db-instance`](https://docs.aws.amazon.com/cli/latest/reference/rds/modify-db-instance.html) and set the `--auto-minor-version-upgrade\|--no-auto-minor-version-upgrade` option\. Using the RDS API, call [ `ModifyDBInstance`](https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_ModifyDBInstance.html) and set the `AutoMinorVersionUpgrade` parameter\. | The entire DB cluster | An outage doesn't occur during this change\. |
| **Backup retention period** The number of days that automatic backups are retained\. The minimum value is `1`\. For more information, see [Backups](Aurora.Managing.Backups.md#Aurora.Managing.Backups.Backup)\. | Using the AWS Management Console, [Modifying the DB Cluster by Using the Console, CLI, and API](#Aurora.Modifying.Cluster)\. Using the AWS CLI, run [ `modify-db-cluster`](https://docs.aws.amazon.com/cli/latest/reference/rds/modify-db-cluster.html) and set the `--backup-retention-period` option\. Using the RDS API, call [ `ModifyDBCluster`](https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_ModifyDBCluster.html) and set the `BackupRetentionPeriod` parameter\. | The entire DB cluster | An outage doesn't occur during this change\. |
| **Certificate Authority** The certificate that you want to use\. | Using the AWS Management Console, [Modify a DB Instance in a DB Cluster](#Aurora.Modifying.Instance)\. Using the AWS CLI, run [ `modify-db-instance`](https://docs.aws.amazon.com/cli/latest/reference/rds/modify-db-instance.html) and set the `--ca-certificate-identifier` option\. Using the RDS API, call [ `ModifyDBInstance`](https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_ModifyDBInstance.html) and set the `CACertificateIdentifier` parameter\. | Only the specified DB instance | An outage occurs during this change\. The DB instance is rebooted\. |
| Copy tags to snapshots Select to specify that tags defined for this DB cluster are copied to DB snapshots created from this DB cluster\. For more information, see [Tagging Amazon RDS Resources](USER_Tagging.md)\. | Using the AWS Management Console, [Modifying the DB Cluster by Using the Console, CLI, and API](#Aurora.Modifying.Cluster)\. Using the AWS CLI, run [ `modify-db-cluster`](https://docs.aws.amazon.com/cli/latest/reference/rds/modify-db-cluster.html) and set the `--copy-tags-to-snapshot` or `--no-copy-tags-to-snapshot` option\. Using the RDS API, call [ `ModifyDBCluster`](https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_ModifyDBCluster.html) and set the `CopyTagsToSnapshot` parameter\. | The entire DB cluster | An outage doesn't occur during this change\. |
Expand Down
48 changes: 24 additions & 24 deletions doc_source/Aurora.Status.md
Original file line number Diff line number Diff line change
@@ -1,32 +1,32 @@
# DB Cluster Status<a name="Aurora.Status"></a>

The status of a DB cluster indicates the health of the DB cluster\. You can view the status of a DB cluster by using the Amazon RDS console, the AWS CLI command [describe\-db\-clusters](https://docs.aws.amazon.com/cli/latest/reference/rds/describe-db-clusters.html), or the API operation [DescribeDBClusters](https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_DescribeDBClusters.html)\.
The status of a DB cluster indicates the health of the DB cluster\. You can view the status of a DB cluster by using the Amazon RDS console, the AWS CLI command [describe\-db\-clusters](https://docs.aws.amazon.com/cli/latest/reference/rds/describe-db-clusters.html), or the API operation [DescribeDBClusters](https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_DescribeDBClusters.html)\.

**Note**
Aurora 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 cluster\. Maintenance status is independent of DB cluster status\. For more information on *maintenance status*, see [Applying Updates for a DB Cluster](USER_UpgradeDBInstance.Maintenance.md#USER_UpgradeDBInstance.OSUpgrades)\.
Aurora 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 cluster\. Maintenance status is independent of DB cluster status\. For more information on *maintenance status*, see [Applying Updates for a DB Cluster](USER_UpgradeDBInstance.Maintenance.md#USER_UpgradeDBInstance.OSUpgrades)\.

Find the possible status values for DB clusters in the following table\.


| DB Cluster Status | Description |
| --- | --- |
| **available** | The DB cluster is healthy and available\. |
| **backing\-up** | The DB cluster is currently being backed up\. |
| backtracking | The DB cluster is currently being backtracked\. This status only applies to Aurora MySQL\. |
| **cloning\-failed** | Cloning a DB cluster failed\. |
| **creating** | The DB cluster is being created\. The DB cluster is inaccessible while it is being created\. |
| **deleting** | The DB cluster is being deleted\. |
| **failing\-over** | A failover from the primary instance to an Aurora Replica is being performed\. |
| **inaccessible\-encryption\-credentials** | The AWS KMS key used to encrypt or decrypt the DB cluster can't be accessed\. |
| **maintenance** | Amazon RDS is applying a maintenance update to the DB cluster\. This status is used for DB cluster\-level maintenance that RDS schedules well in advance\. |
| **migrating** | A DB cluster snapshot is being restored to a DB cluster\. |
| **migration\-failed** | A migration failed\. |
| **modifying** | The DB cluster is being modified because of a customer request to modify the DB cluster\. |
| **promoting** | A read replica is being promoted to a standalone DB cluster\. |
| **renaming** | The DB cluster is being renamed because of a customer request to rename it\. |
| **resetting\-master\-credentials** | The master credentials for the DB cluster are being reset because of a customer request to reset them\. |
| **starting** | The DB cluster is starting\. |
| **stopped** | The DB cluster is stopped\. |
| **stopping** | The DB cluster is being stopped\. |
| **update\-iam\-db\-auth** | IAM authorization for the DB cluster is being updated\. |
| **upgrading** | The DB cluster engine version is being upgraded\. |
| DB Cluster Status | Billed | Description |
| --- | --- | --- |
| available | Billed | The DB cluster is healthy and available\. |
| backing\-up | Billed | The DB cluster is currently being backed up\. |
| backtracking | Billed | The DB cluster is currently being backtracked\. This status only applies to Aurora MySQL\. |
| cloning\-failed | Not billed | Cloning a DB cluster failed\. |
| creating | Not billed | The DB cluster is being created\. The DB cluster is inaccessible while it is being created\. |
| deleting | Not billed | The DB cluster is being deleted\. |
| failing\-over | Billed | A failover from the primary instance to an Aurora Replica is being performed\. |
| inaccessible\-encryption\-credentials | Not billed | The AWS KMS key used to encrypt or decrypt the DB cluster can't be accessed\. |
| maintenance | Billed | Amazon RDS is applying a maintenance update to the DB cluster\. This status is used for DB cluster\-level maintenance that RDS schedules well in advance\. |
| migrating | Billed | A DB cluster snapshot is being restored to a DB cluster\. |
| migration\-failed | Not billed | A migration failed\. |
| modifying | Billed | The DB cluster is being modified because of a customer request to modify the DB cluster\. |
| promoting | Billed | A read replica is being promoted to a standalone DB cluster\. |
| renaming | Billed | The DB cluster is being renamed because of a customer request to rename it\. |
| resetting\-master\-credentials | Billed | The master credentials for the DB cluster are being reset because of a customer request to reset them\. |
| starting | Billed for storage | The DB cluster is starting\. |
| stopped | Billed for storage | The DB cluster is stopped\. |
| stopping | Billed for storage | The DB cluster is being stopped\. |
| update\-iam\-db\-auth | Billed | IAM authorization for the DB cluster is being updated\. |
| upgrading | Billed | The DB cluster engine version is being upgraded\. |
2 changes: 1 addition & 1 deletion doc_source/AuroraMySQL.Replication.MySQL.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ Find instructions on how to enable binary logging on the replication source for

| Database Engine | Instructions |
| --- | --- |
| Aurora | **To enable binary logging on an Aurora MySQL DB cluster** Set the `binlog_format` parameter to `ROW`, `STATEMENT`, or `MIXED`\. `MIXED` is recommended unless you have a need for a specific binlog format\. The `binlog_format` parameter is a cluster\-level parameter that is in the default cluster parameter group\. If you are changing the `binlog_format` parameter from `OFF` to another value, then you need to reboot your Aurora DB cluster for the change to take effect\. For more information, see [Amazon Aurora DB Cluster and DB Instance Parameters](USER_WorkingWithParamGroups.md#Aurora.Managing.ParameterGroups) and [Working with DB Parameter Groups and DB Cluster Parameter Groups](USER_WorkingWithParamGroups.md)\. |
| Aurora | **To enable binary logging on an Aurora MySQL DB cluster** Set the `binlog_format` parameter to `ROW`, `STATEMENT`, or `MIXED`\. `MIXED` is recommended unless you have a need for a specific binlog format\. The `binlog_format` parameter is a cluster\-level parameter that is in the default cluster parameter group\. If you are changing the `log_bin` parameter from `OFF` to another value, then you need to reboot your Aurora DB cluster for the change to take effect\. For more information, see [Amazon Aurora DB Cluster and DB Instance Parameters](USER_WorkingWithParamGroups.md#Aurora.Managing.ParameterGroups) and [Working with DB Parameter Groups and DB Cluster Parameter Groups](USER_WorkingWithParamGroups.md)\. |
| RDS MySQL | **To enable binary logging on an Amazon RDS DB instance** You cannot enable binary logging directly for an Amazon RDS DB instance, but you can enable it by doing one of the following: [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/AuroraMySQL.Replication.MySQL.html) |
| MySQL \(external\) | **To set up encrypted replication** To replicate data securely with Aurora MySQL version 5\.6, you can use encrypted replication\. Currently, encrypted replication with an external MySQL database is only supported for Aurora MySQL version 5\.6\. If you don't need to use encrypted replication, you can skip these steps\. The following are prerequisites for using encrypted replication: [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/AuroraMySQL.Replication.MySQL.html) 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\. [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/AuroraMySQL.Replication.MySQL.html) **To enable binary logging on an external MySQL database** [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/AuroraMySQL.Replication.MySQL.html) |

Expand Down
2 changes: 1 addition & 1 deletion doc_source/AuroraMySQL.Updates.1196.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Aurora MySQL Database Engine Updates 2020\-03\-05<a name="AuroraMySQL.Updates.1196"></a>
# Aurora MySQL Database Engine Updates 2020\-03\-05 \(Version 1\.19\.6\)<a name="AuroraMySQL.Updates.1196"></a>

**Version:** 1\.19\.6

Expand Down

0 comments on commit f83c1cc

Please sign in to comment.