RestoreDBClusterFromS3 - Amazon Relational Database Service
Request ParametersResponse ElementsErrorsExamplesSee Also
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China (PDF).

RestoreDBClusterFromS3

Creates an Amazon Aurora DB cluster from MySQL data stored in an Amazon S3 bucket. Amazon RDS must be authorized to access the Amazon S3 bucket and the data must be created using the Percona XtraBackup utility as described in Migrating Data from MySQL by Using an Amazon S3 Bucket in the Amazon Aurora User Guide.

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 RestoreDBClusterFromS3 operation has completed and the DB cluster is available.

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

Note

This operation only applies to Aurora DB clusters. The source DB engine must be MySQL.

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 source data in the Amazon S3 bucket. 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-cluster1

Type: String

Required: Yes

Engine

The name of the database engine to be used for this DB cluster.

Valid Values: aurora-mysql (for Aurora MySQL)

Type: String

Required: Yes

MasterUsername

The name of the master user for the restored DB cluster.

Constraints:

  • Must be 1 to 16 letters or numbers.

  • First character must be a letter.

  • Can't be a reserved word for the chosen database engine.

Type: String

Required: Yes

S3BucketName

The name of the Amazon S3 bucket that contains the data used to create the Amazon Aurora DB cluster.

Type: String

Required: Yes

S3IngestionRoleArn

The Amazon Resource Name (ARN) of the Amazon Identity and Access Management (IAM) role that authorizes Amazon RDS to access the Amazon S3 bucket on your behalf.

Type: String

Required: Yes

SourceEngine

The identifier for the database engine that was backed up to create the files stored in the Amazon S3 bucket.

Valid Values: mysql

Type: String

Required: Yes

SourceEngineVersion

The version of the database that the backup files were created from.

MySQL versions 5.7 and 8.0 are supported.

Example: 5.7.40, 8.0.28

Type: String

Required: Yes

AvailabilityZones.AvailabilityZone.N

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

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).

Type: Long

Required: No

BackupRetentionPeriod

The number of days for which automated backups of the restored DB cluster are retained. You must specify a minimum value of 1.

Default: 1

Constraints:

  • Must be a value from 1 to 35

Type: Integer

Required: No

CharacterSetName

A value that indicates that the restored DB cluster should be associated with the specified CharacterSet.

Type: String

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.

Type: Boolean

Required: No

DatabaseName

The database name for the restored DB cluster.

Type: String

Required: No

DBClusterParameterGroupName

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

Constraints:

  • If supplied, must match the name of an existing DBClusterParameterGroup.

Type: String

Required: No

DBSubnetGroupName

A DB subnet group to associate with the restored DB cluster.

Constraints: If supplied, must match the name of an existing DBSubnetGroup.

Example: mydbsubnetgroup

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.

Type: Boolean

Required: No

Domain

Specify the Active Directory directory ID to restore the DB cluster in. The domain must be created prior to this operation.

For Amazon Aurora DB clusters, Amazon RDS can use Kerberos Authentication to authenticate users that connect to the DB cluster. For more information, see Kerberos Authentication in the Amazon Aurora User Guide.

Type: String

Required: No

DomainIAMRoleName

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

Type: String

Required: No

EnableCloudwatchLogsExports.member.N

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

Aurora MySQL

Possible values are audit, error, general, and slowquery.

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

Type: Array of strings

Required: No

EnableIAMDatabaseAuthentication

Specifies whether to enable mapping of Amazon 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.

Type: Boolean

Required: No

EngineVersion

The version number of the database engine to use.

To list all of the available engine versions for aurora-mysql (Aurora MySQL), use the following command:

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

Aurora MySQL

Examples: 5.7.mysql_aurora.2.12.0, 8.0.mysql_aurora.3.04.0

Type: String

Required: No

KmsKeyId

The Amazon KMS key identifier for an encrypted DB cluster.

The Amazon 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 Amazon Web Services account, specify the key ARN or alias ARN.

If the StorageEncrypted parameter is enabled, and you do not specify a value for the KmsKeyId parameter, then Amazon RDS will use your default KMS key. There is a default KMS key for your Amazon Web Services account. Your Amazon Web Services account has a different default KMS key for each Amazon Web Services Region.

Type: String

Required: No

ManageMasterUserPassword

Specifies whether to manage the master user password with Amazon Secrets Manager.

For more information, see Password management with Amazon Secrets Manager in the Amazon RDS User Guide and Password management with Amazon Secrets Manager in the Amazon Aurora User Guide.

Constraints:

  • Can't manage the master user password with Amazon Secrets Manager if MasterUserPassword is specified.

Type: Boolean

Required: No

MasterUserPassword

The password for the master database user. This password can contain any printable ASCII character except "/", """, or "@".

Constraints:

  • Must contain from 8 to 41 characters.

  • Can't be specified if ManageMasterUserPassword is turned on.

Type: String

Required: No

MasterUserSecretKmsKeyId

The Amazon KMS key identifier to encrypt a secret that is automatically generated and managed in Amazon Secrets Manager.

This setting is valid only if the master user password is managed by RDS in Amazon Secrets Manager for the DB cluster.

The Amazon 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 Amazon Web Services account, specify the key ARN or alias ARN.

If you don't specify MasterUserSecretKmsKeyId, then the aws/secretsmanager KMS key is used to encrypt the secret. If the secret is in a different Amazon Web Services account, then you can't use the aws/secretsmanager KMS key to encrypt the secret, and you must use a customer managed KMS key.

There is a default KMS key for your Amazon Web Services account. Your Amazon Web Services account has a different default KMS key for each Amazon Web Services Region.

Type: String

Required: No

NetworkType

The network type of the DB cluster.

Valid Values:

  • IPV4

  • DUAL

The network type is determined by the DBSubnetGroup specified for the DB cluster. A DBSubnetGroup can support only the IPv4 protocol or the IPv4 and the IPv6 protocols (DUAL).

For more information, see Working with a DB instance in a VPC in the Amazon Aurora User Guide.

Type: String

Required: No

OptionGroupName

A value that indicates that the restored DB cluster should be associated with the specified option group.

Permanent options can't be removed from an option group. An option group can't be removed from a DB cluster once it is associated with a DB cluster.

Type: String

Required: No

Port

The port number on which the instances in the restored DB cluster accept connections.

Default: 3306

Type: Integer

Required: No

PreferredBackupWindow

The daily time range during which automated backups are created if automated backups are enabled using the BackupRetentionPeriod parameter.

The default is a 30-minute window selected at random from an 8-hour block of time for each Amazon Web Services Region. To view the time blocks available, see Backup window in the Amazon Aurora User Guide.

Constraints:

  • Must be in the format hh24:mi-hh24:mi.

  • Must be in Universal Coordinated Time (UTC).

  • Must not conflict with the preferred maintenance window.

  • Must be at least 30 minutes.

Type: String

Required: No

PreferredMaintenanceWindow

The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).

Format: ddd:hh24:mi-ddd:hh24:mi

The default is a 30-minute window selected at random from an 8-hour block of time for each Amazon Web Services Region, occurring on a random day of the week. To see the time blocks available, see Adjusting the Preferred Maintenance Window in the Amazon Aurora User Guide.

Valid Days: Mon, Tue, Wed, Thu, Fri, Sat, Sun.

Constraints: Minimum 30-minute window.

Type: String

Required: No

S3Prefix

The prefix for all of the file names that contain the data used to create the Amazon Aurora DB cluster. If you do not specify a SourceS3Prefix value, then the Amazon Aurora DB cluster is created by using all of the files in the Amazon S3 bucket.

Type: String

Required: No

ServerlessV2ScalingConfiguration

Contains the scaling configuration of an Aurora Serverless v2 DB cluster.

For more information, see Using Amazon Aurora Serverless v2 in the Amazon Aurora User Guide.

Type: ServerlessV2ScalingConfiguration object

Required: No

StorageEncrypted

Specifies whether the restored DB cluster is encrypted.

Type: Boolean

Required: No

StorageType

Specifies the storage type to be associated with the DB cluster.

Valid Values: aurora, aurora-iopt1

Default: aurora

Valid for: Aurora DB clusters only

Type: String

Required: No

Tags.Tag.N

A list of tags. For more information, see Tagging Amazon RDS Resources in the Amazon RDS User Guide.

Type: Array of Tag objects

Required: No

VpcSecurityGroupIds.VpcSecurityGroupId.N

A list of EC2 VPC security groups to associate with the restored DB cluster.

Type: Array of strings

Required: No

Response Elements

The following element is returned by the service.

DBCluster

Contains the details of an Amazon Aurora DB cluster or Multi-AZ DB cluster.

For an Amazon Aurora DB cluster, this data type is used as a response element in the operations CreateDBCluster, DeleteDBCluster, DescribeDBClusters, FailoverDBCluster, ModifyDBCluster, PromoteReadReplicaDBCluster, RestoreDBClusterFromS3, RestoreDBClusterFromSnapshot, RestoreDBClusterToPointInTime, StartDBCluster, and StopDBCluster.

For a Multi-AZ DB cluster, this data type is used as a response element in the operations CreateDBCluster, DeleteDBCluster, DescribeDBClusters, FailoverDBCluster, ModifyDBCluster, RebootDBCluster, RestoreDBClusterFromSnapshot, and RestoreDBClusterToPointInTime.

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 deployments with two readable standby DB instances in the Amazon RDS User Guide.

Type: DBCluster object

Errors

For information about the errors that are common to all actions, see Common Errors.

DBClusterAlreadyExistsFault

The user already has a DB cluster with the given identifier.

HTTP Status Code: 400

DBClusterNotFoundFault

DBClusterIdentifier doesn't refer to an existing DB cluster.

HTTP Status Code: 404

DBClusterParameterGroupNotFound

DBClusterParameterGroupName doesn't refer to an existing DB cluster parameter group.

HTTP Status Code: 404

DBClusterQuotaExceededFault

The user attempted to create a new DB cluster and the user has already reached the maximum allowed DB cluster quota.

HTTP Status Code: 403

DBSubnetGroupNotFoundFault

DBSubnetGroupName doesn't refer to an existing DB subnet group.

HTTP Status Code: 404

DomainNotFoundFault

Domain doesn't refer to an existing Active Directory domain.

HTTP Status Code: 404

InsufficientStorageClusterCapacity

There is insufficient storage available for the current action. You might be able to resolve this error by updating your subnet group to use different Availability Zones that have more storage available.

HTTP Status Code: 400

InvalidDBClusterStateFault

The requested operation can't be performed while the cluster is in this state.

HTTP Status Code: 400

InvalidDBSubnetGroupStateFault

The DB subnet group cannot be deleted because it's in use.

HTTP Status Code: 400

InvalidS3BucketFault

The specified Amazon S3 bucket name can't be found or Amazon RDS isn't authorized to access the specified Amazon S3 bucket. Verify the SourceS3BucketName and S3IngestionRoleArn values and try again.

HTTP Status Code: 400

InvalidSubnet

The requested subnet is invalid, or multiple subnets were requested that are not all in a common VPC.

HTTP Status Code: 400

InvalidVPCNetworkStateFault

The DB subnet group doesn't cover all Availability Zones after it's created because of users' change.

HTTP Status Code: 400

KMSKeyNotAccessibleFault

An error occurred accessing an Amazon KMS key.

HTTP Status Code: 400

StorageQuotaExceeded

The request would result in the user exceeding the allowed amount of storage available across all DB instances.

HTTP Status Code: 400

StorageTypeNotSupported

The specified StorageType can't be associated with the DB instance.

HTTP Status Code: 400

Examples

Example

This example illustrates one usage of RestoreDBClusterFromS3.

Sample Request

https://rds.us-east-1.amazonaws.com/
    ?Action=RestoreDBClusterFromS3
    &DBClusterIdentifier=sample-cluster
    &Engine=aurora-mysql
    &S3BucketName=s3-ingestion-sample
    &SourceEngine=mysql
    &SourceEngineVersion=8.0.mysql_aurora.3.04.0
    &MasterUsername=myawsuser
    &MasterUserPassword=<password>
    &S3IngestionRoleArn=arn:aws:iam:123456789012:role/sample-role
    &SignatureMethod=HmacSHA256
    &SignatureVersion=4
    &SnapshotIdentifier=sample-snapshot
    &Version=2014-10-31
    &X-Amz-Algorithm=AWS4-HMAC-SHA256
    &X-Amz-Credential=AKIADQKE4SARGYLE/20230223/us-east-1/rds/aws4_request
    &X-Amz-Date=20230223T165638Z
    &X-Amz-SignedHeaders=content-type;host;user-agent;x-amz-content-sha256;x-amz-date
    &X-Amz-Signature=c59effef9b7b96f6a8dfed7873611df555364594f7f9acf9cd14d353114771fd

Sample Response

<RestoreDBClusterFromS3Response xmlns="http://rds.amazonaws.com/doc/2014-10-31/">
  <RestoreDBClusterFromS3Result>
    <DBCluster>
      <Port>3306</Port>
      <Engine>aurora-mysql</Engine>
      <Status>creating</Status>
      <BackupRetentionPeriod>1</BackupRetentionPeriod>
      <VpcSecurityGroups>
        <VpcSecurityGroupMembership>
          <Status>active</Status>
          <VpcSecurityGroupId>sg-2103dc23</VpcSecurityGroupId>
        </VpcSecurityGroupMembership>
      </VpcSecurityGroups>
      <DBSubnetGroup>default</DBSubnetGroup>
      <EngineVersion>8.0.mysql_aurora.3.04.0</EngineVersion>
      <Endpoint>sample-cluster.cluster-ctrayan0rynq.us-east-1.rds.amazonaws.com</Endpoint>
      <DBClusterParameterGroup>default.aurora5.6</DBClusterParameterGroup>
      <AvailabilityZones>
        <AvailabilityZone>us-east-1a</AvailabilityZone>
        <AvailabilityZone>us-east-1c</AvailabilityZone>
        <AvailabilityZone>us-east-1e</AvailabilityZone>
      </AvailabilityZones>
      <DBClusterIdentifier>sample-cluster</DBClusterIdentifier>
      <PreferredBackupWindow>04:22-04:52</PreferredBackupWindow>
      <PreferredMaintenanceWindow>fri:06:44-fri:07:14</PreferredMaintenanceWindow>
      <DBClusterMembers/>
      <AllocatedStorage>1</AllocatedStorage>
      <MasterUsername>myawsuser</MasterUsername>
    </DBCluster>
  </RestoreDBClusterFromS3Result>
  <ResponseMetadata>
    <RequestId>46d2b228-7681-11e5-3e8b-9b2c0d5d51a9</RequestId>
  </ResponseMetadata>
</RestoreDBClusterFromS3Response>

See Also

For more information about using this API in one of the language-specific Amazon SDKs, see the following: