Request Parameters Response Elements Errors Examples See Also

RestoreDBClusterFromSnapshot

Creates a new DB cluster from a DB snapshot or DB cluster snapshot.

The target DB cluster is created from the source snapshot with a default configuration. If you don't specify a security group, the new DB cluster is associated with the default security group.

You can use the EnableVPCNetworking and EnableInternetAccessGateway parameters together to restore an Aurora PostgreSQL cluster without VPC networking and with internet-based connectivity. These two parameters must always be specified together. Set EnableVPCNetworking to false to disable the VPC network interface (ENI) for the cluster. EnableInternetAccessGateway enables internet-based connectivity through an internet access gateway. IAM database authentication is required and must be enabled using EnableIAMDatabaseAuthentication. Once the cluster is restored, you need to modify the DB cluster to update MasterUserAuthenticationType to iam-db-auth.

You can use the AssociatedRoles parameter to associate one or more AWS Identity and Access Management (IAM) roles with an Aurora DB cluster when you restore it from a snapshot.

Note

This operation only restores the DB cluster, not the DB instances for that DB cluster. You must invoke the CreateDBInstance 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 RestoreDBClusterFromSnapshot operation has completed and the DB cluster is available.

For more information on Amazon Aurora DB clusters, see What is Amazon Aurora? in the Amazon Aurora User Guide.

For more information on Multi-AZ DB clusters, see Multi-AZ DB cluster deployments in the Amazon RDS User Guide.

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

DBClusterIdentifier

The name of the DB cluster to create from the DB snapshot or DB cluster snapshot. This parameter isn't case-sensitive.

Constraints:

Must contain from 1 to 63 letters, numbers, or hyphens
First character must be a letter
Can't end with a hyphen or contain two consecutive hyphens

Example: my-snapshot-id

Valid for: Aurora DB clusters and Multi-AZ DB clusters

Type: String

Required: Yes

Engine

The database engine to use for the new DB cluster.

Default: The same as source

Constraint: Must be compatible with the engine of the source

Valid for: Aurora DB clusters and Multi-AZ DB clusters

Type: String

Required: Yes

SnapshotIdentifier

The identifier for the DB snapshot or DB cluster snapshot to restore from.

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.

Constraints:

Must match the identifier of an existing Snapshot.

Valid for: Aurora DB clusters and Multi-AZ DB clusters

Type: String

Required: Yes

AssociatedRoles.DBClusterAssociatedRole.N

A list of AWS Identity and Access Management (IAM) roles to associate with the DB cluster when it's restored from a snapshot. Each role grants the DB cluster permission to access other Amazon Web Services on your behalf. For each role, specify a role ARN and, optionally, the feature name (such as s3Import, s3Export, or Lambda).

Valid for Cluster Type: Aurora DB clusters only

Type: Array of DBClusterAssociatedRole objects

Array Members: Minimum number of 0 items. Maximum number of 15 items.

Required: No

AvailabilityZones.AvailabilityZone.N

Provides the list of Availability Zones (AZs) where instances in the restored DB cluster can be created.

Valid for: Aurora DB clusters only

Type: Array of strings

Required: No

BacktrackWindow

The target backtrack window, in seconds. To disable backtracking, set this value to 0.

Note

Currently, Backtrack is only supported for Aurora MySQL DB clusters.

Default: 0

Constraints:

If specified, this value must be set to a number from 0 to 259,200 (72 hours).

Valid for: Aurora DB clusters only

Type: Long

Required: No

BackupRetentionPeriod

The number of days for which automated backups are retained. Specify a minimum value of 1.

Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters

Default: Uses existing setting

Constraints:

Must be a value from 1 to 35.

Type: Integer

Required: No

CopyTagsToSnapshot

Specifies whether to copy all tags from the restored DB cluster to snapshots of the restored DB cluster. The default is not to copy them.

Valid for: Aurora DB clusters and Multi-AZ DB clusters

Type: Boolean

Required: No

DatabaseName

The database name for the restored DB cluster.

Valid for: Aurora DB clusters and Multi-AZ DB clusters

Type: String

Required: No

DBClusterInstanceClass

The compute and memory capacity of the each DB instance in the Multi-AZ DB cluster, for example db.m6gd.xlarge. Not all DB instance classes are available in all AWS Regions, or for all database engines.

For the full list of DB instance classes, and availability for your engine, see DB Instance Class in the Amazon RDS User Guide.

Valid for: Multi-AZ DB clusters only

Type: String

Required: No

DBClusterParameterGroupName

The name of the DB cluster parameter group to associate with this DB cluster. If this argument is omitted, the default DB cluster parameter group for the specified engine is used.

Constraints:

If supplied, must match the name of an existing default DB cluster parameter group.
Must be 1 to 255 letters, numbers, or hyphens.
First character must be a letter.
Can't end with a hyphen or contain two consecutive hyphens.

Valid for: Aurora DB clusters and Multi-AZ DB clusters

Type: String

Required: No

DBSubnetGroupName

The name of the DB subnet group to use for the new DB cluster.

Constraints: If supplied, must match the name of an existing DB subnet group.

Example: mydbsubnetgroup

Valid for: Aurora DB clusters and Multi-AZ DB clusters

Type: String

Required: No

DeletionProtection

Specifies whether to enable deletion protection for the DB cluster. The database can't be deleted when deletion protection is enabled. By default, deletion protection isn't enabled.

Valid for: Aurora DB clusters and Multi-AZ DB clusters

Type: Boolean

Required: No

Domain

The Active Directory directory ID to restore the DB cluster in. The domain must be created prior to this operation. Currently, only MySQL, Microsoft SQL Server, Oracle, and PostgreSQL DB instances can be created in an Active Directory Domain.

For more information, see Kerberos Authentication in the Amazon RDS User Guide.

Valid for: Aurora DB clusters only

Type: String

Required: No

DomainIAMRoleName

The name of the IAM role to be used when making API calls to the Directory Service.

Valid for: Aurora DB clusters only

Type: String

Required: No

EnableCloudwatchLogsExports.member.N

The list of logs that the restored DB cluster is to export to Amazon CloudWatch Logs. The values in the list depend on the DB engine being used.

RDS for MySQL

Possible values are error, general, slowquery, and iam-db-auth-error.

RDS for PostgreSQL

Possible values are postgresql, upgrade, and iam-db-auth-error.

Aurora MySQL

Possible values are audit, error, general, instance, slowquery, and iam-db-auth-error.

Aurora PostgreSQL

Possible value are instance, postgresql, and iam-db-auth-error.

For more information about exporting CloudWatch Logs for Amazon RDS, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon RDS User Guide.

For more information about exporting CloudWatch Logs for Amazon Aurora, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon Aurora User Guide.

Valid for: Aurora DB clusters and Multi-AZ DB clusters

Type: Array of strings

Required: No

EnableIAMDatabaseAuthentication

Specifies whether to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts. By default, mapping isn't enabled.

For more information, see IAM Database Authentication in the Amazon Aurora User Guide or IAM database authentication for MariaDB, MySQL, and PostgreSQL in the Amazon RDS User Guide.

Valid for: Aurora DB clusters and Multi-AZ DB clusters

Type: Boolean

Required: No

EnableInternetAccessGateway

Specifies that the restored DB cluster should use internet-based connectivity through an internet access gateway. This allows clients to connect to the cluster over the internet without requiring a VPC.

This parameter must be used together with EnableVPCNetworking set to false. When both parameters are specified, IAM database authentication is required. You must also specify EnableIAMDatabaseAuthentication.

Valid for Cluster Type: Aurora PostgreSQL clusters

Type: Boolean

Required: No

EnablePerformanceInsights

Specifies whether to turn on Performance Insights for the DB cluster.

Type: Boolean

Required: No

EnableVPCNetworking

Specifies whether to enable VPC networking for the restored DB cluster. Set this parameter to false to create a cluster without the VPC network interface (ENI).

This parameter must be used together with EnableInternetAccessGateway. When both parameters are specified, IAM database authentication is required. You must also specify EnableIAMDatabaseAuthentication.

Valid for Cluster Type: Aurora PostgreSQL clusters

Type: Boolean

Required: No

EngineLifecycleSupport

The lifecycle type for this DB cluster.

Note

By default, this value is set to open-source-rds-extended-support, which enrolls your DB cluster into Amazon RDS Extended Support. At the end of standard support, you can avoid charges for Extended Support by setting the value to open-source-rds-extended-support-disabled. In this case, RDS automatically upgrades your restored DB cluster to a higher engine version, if the major engine version is past its end of standard support date.

You can use this setting to enroll your DB cluster into Amazon RDS Extended Support. With RDS Extended Support, you can run the selected major engine version on your DB cluster past the end of standard support for that engine version. For more information, see the following sections:

Amazon Aurora - Amazon RDS Extended Support with Amazon Aurora in the Amazon Aurora User Guide
Amazon RDS - Amazon RDS Extended Support with Amazon RDS in the Amazon RDS User Guide

Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters

Valid Values: open-source-rds-extended-support | open-source-rds-extended-support-disabled

Default: open-source-rds-extended-support

Type: String

Required: No

EngineMode

The DB engine mode of the DB cluster, either provisioned or serverless.

For more information, see CreateDBCluster.

Valid for: Aurora DB clusters only

Type: String

Required: No

EngineVersion

The version of the database engine to use for the new DB cluster. If you don't specify an engine version, the default version for the database engine in the AWS Region is used.

To list all of the available engine versions for Aurora MySQL, use the following command:

aws rds describe-db-engine-versions --engine aurora-mysql --query "DBEngineVersions[].EngineVersion"

To list all of the available engine versions for Aurora PostgreSQL, use the following command:

aws rds describe-db-engine-versions --engine aurora-postgresql --query "DBEngineVersions[].EngineVersion"

To list all of the available engine versions for RDS for MySQL, use the following command:

aws rds describe-db-engine-versions --engine mysql --query "DBEngineVersions[].EngineVersion"

To list all of the available engine versions for RDS for PostgreSQL, use the following command:

aws rds describe-db-engine-versions --engine postgres --query "DBEngineVersions[].EngineVersion"

Aurora MySQL

See Database engine updates for Amazon Aurora MySQL in the Amazon Aurora User Guide.

Aurora PostgreSQL

See Amazon Aurora PostgreSQL releases and engine versions in the Amazon Aurora User Guide.

MySQL

See Amazon RDS for MySQL in the Amazon RDS User Guide.

PostgreSQL

See Amazon RDS for PostgreSQL versions and extensions in the Amazon RDS User Guide.

Valid for: Aurora DB clusters and Multi-AZ DB clusters

Type: String

Required: No

Iops