Creates an Amazon Aurora DB cluster from 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 to an Amazon Aurora MySQL DB Cluster in the Amazon Aurora User Guide.
rds_restore_db_cluster_from_s3(AvailabilityZones, BackupRetentionPeriod,
CharacterSetName, DatabaseName, DBClusterIdentifier,
DBClusterParameterGroupName, VpcSecurityGroupIds, DBSubnetGroupName,
Engine, EngineVersion, Port, MasterUsername, MasterUserPassword,
OptionGroupName, PreferredBackupWindow, PreferredMaintenanceWindow,
Tags, StorageEncrypted, KmsKeyId, EnableIAMDatabaseAuthentication,
SourceEngine, SourceEngineVersion, S3BucketName, S3Prefix,
S3IngestionRoleArn, BacktrackWindow, EnableCloudwatchLogsExports,
DeletionProtection, CopyTagsToSnapshot)A list of Availability Zones (AZs) where instances in the restored DB cluster can be created.
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
A value that indicates that the restored DB cluster should be associated with the specified CharacterSet.
The database name for the restored DB cluster.
[required] The name of the DB cluster to create from the source data in the Amazon S3 bucket. This parameter is 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
The name of the DB cluster parameter group to associate with the
restored DB cluster. If this argument is omitted, default.aurora5.6 is
used.
Constraints:
If supplied, must match the name of an existing DBClusterParameterGroup.
A list of EC2 VPC security groups to associate with the restored DB cluster.
A DB subnet group to associate with the restored DB cluster.
Constraints: If supplied, must match the name of an existing DBSubnetGroup.
Example: mySubnetgroup
[required] The name of the database engine to be used for the restored DB cluster.
Valid Values: aurora, aurora-postgresql
The version number of the database engine to use.
Aurora MySQL
Example: 5.6.10a
Aurora PostgreSQL
Example: 9.6.3
The port number on which the instances in the restored DB cluster accept connections.
Default: 3306
[required] 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.
[required] 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.
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.
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 AWS Region. To see the time blocks available, see Adjusting the Preferred Maintenance 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.
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 AWS 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.
A value that indicates whether the restored DB cluster is encrypted.
The AWS KMS key identifier for an encrypted DB cluster.
The KMS key identifier is the Amazon Resource Name (ARN) for the KMS encryption key. If you are creating a DB cluster with the same AWS account that owns the KMS encryption key used to encrypt the new DB cluster, then you can use the KMS key alias instead of the ARN for the KM encryption key.
If the StorageEncrypted parameter is enabled, and you do not specify a
value for the KmsKeyId parameter, then Amazon RDS will use your
default encryption key. AWS KMS creates the default encryption key for
your AWS account. Your AWS account has a different default encryption
key for each AWS Region.
A value that indicates whether to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts. By default, mapping is disabled.
[required] The identifier for the database engine that was backed up to create the files stored in the Amazon S3 bucket.
Valid values: mysql
[required] The version of the database that the backup files were created from.
MySQL version 5.5 and 5.6 are supported.
Example: 5.6.22
[required] The name of the Amazon S3 bucket that contains the data used to create the Amazon Aurora DB cluster.
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.
[required] The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that authorizes Amazon RDS to access the Amazon S3 bucket on your behalf.
The target backtrack window, in seconds. To disable backtracking, set this value to 0.
Default: 0
Constraints:
If specified, this value must be set to a number from 0 to 259,200 (72 hours).
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. For more information, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon Aurora User Guide.
A value that indicates whether the DB cluster has deletion protection enabled. The database can't be deleted when deletion protection is enabled. By default, deletion protection is disabled.
A value that indicates whether to copy all tags from the restored DB cluster to snapshots of the restored DB cluster. The default is not to copy them.
svc$restore_db_cluster_from_s3(
AvailabilityZones = list(
"string"
),
BackupRetentionPeriod = 123,
CharacterSetName = "string",
DatabaseName = "string",
DBClusterIdentifier = "string",
DBClusterParameterGroupName = "string",
VpcSecurityGroupIds = list(
"string"
),
DBSubnetGroupName = "string",
Engine = "string",
EngineVersion = "string",
Port = 123,
MasterUsername = "string",
MasterUserPassword = "string",
OptionGroupName = "string",
PreferredBackupWindow = "string",
PreferredMaintenanceWindow = "string",
Tags = list(
list(
Key = "string",
Value = "string"
)
),
StorageEncrypted = TRUE|FALSE,
KmsKeyId = "string",
EnableIAMDatabaseAuthentication = TRUE|FALSE,
SourceEngine = "string",
SourceEngineVersion = "string",
S3BucketName = "string",
S3Prefix = "string",
S3IngestionRoleArn = "string",
BacktrackWindow = 123,
EnableCloudwatchLogsExports = list(
"string"
),
DeletionProtection = TRUE|FALSE,
CopyTagsToSnapshot = TRUE|FALSE
)
This action only applies to Aurora DB clusters.