Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

Amazonka.RDS.RestoreDBClusterFromS3

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

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.

This action only restores the DB cluster, not the DB instances for that DB cluster. You must invoke the CreateDBInstance action 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 action 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.

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

Synopsis

Creating a Request

data RestoreDBClusterFromS3 Source #

See: newRestoreDBClusterFromS3 smart constructor.

Constructors

RestoreDBClusterFromS3'

Fields

availabilityZones :: Maybe [Text]
A list of Availability Zones (AZs) where instances in the restored DB cluster can be created.
backtrackWindow :: Maybe Integer
The target backtrack window, in seconds. To disable backtracking, set this value to 0.
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).
backupRetentionPeriod :: Maybe Int
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
characterSetName :: Maybe Text
A value that indicates that the restored DB cluster should be associated with the specified CharacterSet.
copyTagsToSnapshot :: Maybe Bool
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.
dbClusterParameterGroupName :: Maybe Text
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.
dbSubnetGroupName :: Maybe Text
A DB subnet group to associate with the restored DB cluster.
Constraints: If supplied, must match the name of an existing DBSubnetGroup.
Example: mydbsubnetgroup
databaseName :: Maybe Text
The database name for the restored DB cluster.
deletionProtection :: Maybe Bool
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 isn't enabled.
domain :: Maybe Text
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.
domainIAMRoleName :: Maybe Text
Specify the name of the IAM role to be used when making API calls to the Directory Service.
enableCloudwatchLogsExports :: Maybe [Text]
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.
Aurora PostgreSQL
Possible value is postgresql.
For more information about exporting CloudWatch Logs for Amazon Aurora, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon Aurora User Guide.
enableIAMDatabaseAuthentication :: Maybe Bool
A value that indicates whether to enable mapping of Amazon Web Services 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.
engineVersion :: Maybe Text
The version number of the database engine to use.
To list all of the available engine versions for aurora (for MySQL 5.6-compatible Aurora), use the following command:
```
aws rds describe-db-engine-versions --engine aurora --query "DBEngineVersions[].EngineVersion"
```
To list all of the available engine versions for aurora-mysql (for MySQL 5.7-compatible and MySQL 8.0-compatible Aurora), use the following command:
```
aws rds describe-db-engine-versions --engine aurora-mysql --query "DBEngineVersions[].EngineVersion"
```
Aurora MySQL
Example: 5.6.10a, 5.6.mysql_aurora.1.19.2, 5.7.mysql_aurora.2.07.1, 8.0.mysql_aurora.3.02.0
kmsKeyId :: Maybe Text
The Amazon Web Services KMS key identifier for an encrypted DB cluster.
The Amazon Web Services 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.
manageMasterUserPassword :: Maybe Bool
A value that indicates whether to manage the master user password with Amazon Web Services Secrets Manager.
For more information, see Password management with Amazon Web Services Secrets Manager in the Amazon RDS User Guide and Password management with Amazon Web Services Secrets Manager in the Amazon Aurora User Guide.
Constraints:
- Can't manage the master user password with Amazon Web Services Secrets Manager if MasterUserPassword is specified.
masterUserPassword :: Maybe Text
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.
masterUserSecretKmsKeyId :: Maybe Text
The Amazon Web Services KMS key identifier to encrypt a secret that is automatically generated and managed in Amazon Web Services Secrets Manager.
This setting is valid only if the master user password is managed by RDS in Amazon Web Services Secrets Manager for the DB cluster.
The Amazon Web Services 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.
networkType :: Maybe Text
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.
optionGroupName :: Maybe Text
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.
port :: Maybe Int
The port number on which the instances in the restored DB cluster accept connections.
Default: 3306
preferredBackupWindow :: Maybe Text
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.
preferredMaintenanceWindow :: Maybe Text
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.
s3Prefix :: Maybe Text
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.
serverlessV2ScalingConfiguration :: Maybe ServerlessV2ScalingConfiguration
storageEncrypted :: Maybe Bool
A value that indicates whether the restored DB cluster is encrypted.
tags :: Maybe [Tag]
vpcSecurityGroupIds :: Maybe [Text]
A list of EC2 VPC security groups to associate with the restored DB cluster.
dbClusterIdentifier :: Text
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
engine :: Text
The name of the database engine to be used for this DB cluster.
Valid Values: aurora (for MySQL 5.6-compatible Aurora) and aurora-mysql (for MySQL 5.7-compatible and MySQL 8.0-compatible Aurora)
masterUsername :: Text
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.
sourceEngine :: Text
The identifier for the database engine that was backed up to create the files stored in the Amazon S3 bucket.
Valid values: mysql
sourceEngineVersion :: Text
The version of the database that the backup files were created from.
MySQL versions 5.5, 5.6, and 5.7 are supported.
Example: 5.6.40, 5.7.28
s3BucketName :: Text
The name of the Amazon S3 bucket that contains the data used to create the Amazon Aurora DB cluster.
s3IngestionRoleArn :: Text
The Amazon Resource Name (ARN) of the Amazon Web Services Identity and Access Management (IAM) role that authorizes Amazon RDS to access the Amazon S3 bucket on your behalf.

Instances

Instances details

ToHeaders RestoreDBClusterFromS3 Source #
Instance details Defined in Amazonka.RDS.RestoreDBClusterFromS3 Methods toHeaders :: RestoreDBClusterFromS3 -> [Header] #
ToPath RestoreDBClusterFromS3 Source #
Instance details Defined in Amazonka.RDS.RestoreDBClusterFromS3 Methods toPath :: RestoreDBClusterFromS3 -> ByteString #
ToQuery RestoreDBClusterFromS3 Source #
Instance details Defined in Amazonka.RDS.RestoreDBClusterFromS3 Methods toQuery :: RestoreDBClusterFromS3 -> QueryString #
AWSRequest RestoreDBClusterFromS3 Source #
Instance details Defined in Amazonka.RDS.RestoreDBClusterFromS3 Associated Types type AWSResponse RestoreDBClusterFromS3 # Methods request :: (Service -> Service) -> RestoreDBClusterFromS3 -> Request RestoreDBClusterFromS3 # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy RestoreDBClusterFromS3 -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse RestoreDBClusterFromS3))) #
Generic RestoreDBClusterFromS3 Source #
Instance details Defined in Amazonka.RDS.RestoreDBClusterFromS3 Associated Types type Rep RestoreDBClusterFromS3 :: Type -> Type # Methods from :: RestoreDBClusterFromS3 -> Rep RestoreDBClusterFromS3 x # to :: Rep RestoreDBClusterFromS3 x -> RestoreDBClusterFromS3 #
Read RestoreDBClusterFromS3 Source #
Instance details Defined in Amazonka.RDS.RestoreDBClusterFromS3 Methods readsPrec :: Int -> ReadS RestoreDBClusterFromS3 # readList :: ReadS [RestoreDBClusterFromS3] # readPrec :: ReadPrec RestoreDBClusterFromS3 # readListPrec :: ReadPrec [RestoreDBClusterFromS3] #
Show RestoreDBClusterFromS3 Source #
Instance details Defined in Amazonka.RDS.RestoreDBClusterFromS3 Methods showsPrec :: Int -> RestoreDBClusterFromS3 -> ShowS # show :: RestoreDBClusterFromS3 -> String # showList :: [RestoreDBClusterFromS3] -> ShowS #
NFData RestoreDBClusterFromS3 Source #
Instance details Defined in Amazonka.RDS.RestoreDBClusterFromS3 Methods rnf :: RestoreDBClusterFromS3 -> () #
Eq RestoreDBClusterFromS3 Source #
Instance details Defined in Amazonka.RDS.RestoreDBClusterFromS3 Methods (==) :: RestoreDBClusterFromS3 -> RestoreDBClusterFromS3 -> Bool # (/=) :: RestoreDBClusterFromS3 -> RestoreDBClusterFromS3 -> Bool #
Hashable RestoreDBClusterFromS3 Source #
Instance details Defined in Amazonka.RDS.RestoreDBClusterFromS3 Methods hashWithSalt :: Int -> RestoreDBClusterFromS3 -> Int # hash :: RestoreDBClusterFromS3 -> Int #
type AWSResponse RestoreDBClusterFromS3 Source #
Instance details Defined in Amazonka.RDS.RestoreDBClusterFromS3 type AWSResponse RestoreDBClusterFromS3 = RestoreDBClusterFromS3Response
type Rep RestoreDBClusterFromS3 Source #
Instance details Defined in Amazonka.RDS.RestoreDBClusterFromS3 type Rep RestoreDBClusterFromS3 = D1 ('MetaData "RestoreDBClusterFromS3" "Amazonka.RDS.RestoreDBClusterFromS3" "amazonka-rds-2.0-3xXyiLHmAvvCXXUIx1uhpP" 'False) (C1 ('MetaCons "RestoreDBClusterFromS3'" 'PrefixI 'True) (((((S1 ('MetaSel ('Just "availabilityZones") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :: S1 ('MetaSel ('Just "backtrackWindow") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Integer))) :: (S1 ('MetaSel ('Just "backupRetentionPeriod") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :: S1 ('MetaSel ('Just "characterSetName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :: ((S1 ('MetaSel ('Just "copyTagsToSnapshot") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :: S1 ('MetaSel ('Just "dbClusterParameterGroupName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "dbSubnetGroupName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "databaseName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))) :: (((S1 ('MetaSel ('Just "deletionProtection") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :: S1 ('MetaSel ('Just "domain") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "domainIAMRoleName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "enableCloudwatchLogsExports") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])))) :: ((S1 ('MetaSel ('Just "enableIAMDatabaseAuthentication") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :: S1 ('MetaSel ('Just "engineVersion") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "kmsKeyId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "manageMasterUserPassword") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :: S1 ('MetaSel ('Just "masterUserPassword") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))))) :: ((((S1 ('MetaSel ('Just "masterUserSecretKmsKeyId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "networkType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "optionGroupName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "port") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)))) :: ((S1 ('MetaSel ('Just "preferredBackupWindow") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "preferredMaintenanceWindow") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "s3Prefix") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "serverlessV2ScalingConfiguration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ServerlessV2ScalingConfiguration)) :: S1 ('MetaSel ('Just "storageEncrypted") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)))))) :: (((S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Tag])) :: S1 ('MetaSel ('Just "vpcSecurityGroupIds") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text]))) :: (S1 ('MetaSel ('Just "dbClusterIdentifier") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: S1 ('MetaSel ('Just "engine") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))) :: ((S1 ('MetaSel ('Just "masterUsername") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: S1 ('MetaSel ('Just "sourceEngine") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)) :: (S1 ('MetaSel ('Just "sourceEngineVersion") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: (S1 ('MetaSel ('Just "s3BucketName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: S1 ('MetaSel ('Just "s3IngestionRoleArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))))))

newRestoreDBClusterFromS3 Source #

Arguments

:: Text	`RestoreDBClusterFromS3`
-> Text	`RestoreDBClusterFromS3`
-> Text	`RestoreDBClusterFromS3`
-> Text	`$sel:sourceEngine:RestoreDBClusterFromS3'`
-> Text	`$sel:sourceEngineVersion:RestoreDBClusterFromS3'`
-> Text	`$sel:s3BucketName:RestoreDBClusterFromS3'`
-> Text	`$sel:s3IngestionRoleArn:RestoreDBClusterFromS3'`
-> RestoreDBClusterFromS3

Create a value of RestoreDBClusterFromS3 with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

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

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

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

RestoreDBClusterFromS3, restoreDBClusterFromS3_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

RestoreDBClusterFromS3, restoreDBClusterFromS3_characterSetName - A value that indicates that the restored DB cluster should be associated with the specified CharacterSet.

RestoreDBClusterFromS3, restoreDBClusterFromS3_copyTagsToSnapshot - 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.

RestoreDBClusterFromS3, restoreDBClusterFromS3_dbClusterParameterGroupName - 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.

RestoreDBClusterFromS3, restoreDBClusterFromS3_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

RestoreDBClusterFromS3, restoreDBClusterFromS3_databaseName - The database name for the restored DB cluster.

RestoreDBClusterFromS3, restoreDBClusterFromS3_deletionProtection - 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 isn't enabled.

RestoreDBClusterFromS3, restoreDBClusterFromS3_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.

$sel:domainIAMRoleName:RestoreDBClusterFromS3', restoreDBClusterFromS3_domainIAMRoleName - Specify the name of the IAM role to be used when making API calls to the Directory Service.

$sel:enableCloudwatchLogsExports:RestoreDBClusterFromS3', restoreDBClusterFromS3_enableCloudwatchLogsExports - 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.

Aurora PostgreSQL

Possible value is postgresql.

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

$sel:enableIAMDatabaseAuthentication:RestoreDBClusterFromS3', restoreDBClusterFromS3_enableIAMDatabaseAuthentication - A value that indicates whether to enable mapping of Amazon Web Services 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.

RestoreDBClusterFromS3, restoreDBClusterFromS3_engineVersion - The version number of the database engine to use.

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

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

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

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

Aurora MySQL

Example: 5.6.10a, 5.6.mysql_aurora.1.19.2, 5.7.mysql_aurora.2.07.1, 8.0.mysql_aurora.3.02.0

RestoreDBClusterFromS3, restoreDBClusterFromS3_kmsKeyId - The Amazon Web Services KMS key identifier for an encrypted DB cluster.

The Amazon Web Services 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.

$sel:manageMasterUserPassword:RestoreDBClusterFromS3', restoreDBClusterFromS3_manageMasterUserPassword - A value that indicates whether to manage the master user password with Amazon Web Services Secrets Manager.

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

Constraints:

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

RestoreDBClusterFromS3, restoreDBClusterFromS3_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.

$sel:masterUserSecretKmsKeyId:RestoreDBClusterFromS3', restoreDBClusterFromS3_masterUserSecretKmsKeyId - The Amazon Web Services KMS key identifier to encrypt a secret that is automatically generated and managed in Amazon Web Services Secrets Manager.

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

The Amazon Web Services 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.

RestoreDBClusterFromS3, restoreDBClusterFromS3_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.

RestoreDBClusterFromS3, restoreDBClusterFromS3_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.

RestoreDBClusterFromS3, restoreDBClusterFromS3_port - The port number on which the instances in the restored DB cluster accept connections.

Default: 3306

RestoreDBClusterFromS3, restoreDBClusterFromS3_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.

RestoreDBClusterFromS3, restoreDBClusterFromS3_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.

RestoreDBClusterFromS3, restoreDBClusterFromS3_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.

RestoreDBClusterFromS3, restoreDBClusterFromS3_serverlessV2ScalingConfiguration - Undocumented member.

RestoreDBClusterFromS3, restoreDBClusterFromS3_storageEncrypted - A value that indicates whether the restored DB cluster is encrypted.

$sel:tags:RestoreDBClusterFromS3', restoreDBClusterFromS3_tags - Undocumented member.

RestoreDBClusterFromS3, restoreDBClusterFromS3_vpcSecurityGroupIds - A list of EC2 VPC security groups to associate with the restored DB cluster.

RestoreDBClusterFromS3, restoreDBClusterFromS3_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

RestoreDBClusterFromS3, restoreDBClusterFromS3_engine - The name of the database engine to be used for this DB cluster.

Valid Values: aurora (for MySQL 5.6-compatible Aurora) and aurora-mysql (for MySQL 5.7-compatible and MySQL 8.0-compatible Aurora)

RestoreDBClusterFromS3, restoreDBClusterFromS3_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.

$sel:sourceEngine:RestoreDBClusterFromS3', restoreDBClusterFromS3_sourceEngine - The identifier for the database engine that was backed up to create the files stored in the Amazon S3 bucket.

Valid values: mysql

$sel:sourceEngineVersion:RestoreDBClusterFromS3', restoreDBClusterFromS3_sourceEngineVersion - The version of the database that the backup files were created from.

MySQL versions 5.5, 5.6, and 5.7 are supported.

Example: 5.6.40, 5.7.28

$sel:s3BucketName:RestoreDBClusterFromS3', restoreDBClusterFromS3_s3BucketName - The name of the Amazon S3 bucket that contains the data used to create the Amazon Aurora DB cluster.

$sel:s3IngestionRoleArn:RestoreDBClusterFromS3', restoreDBClusterFromS3_s3IngestionRoleArn - The Amazon Resource Name (ARN) of the Amazon Web Services Identity and Access Management (IAM) role that authorizes Amazon RDS to access the Amazon S3 bucket on your behalf.

Request Lenses

restoreDBClusterFromS3_availabilityZones :: Lens' RestoreDBClusterFromS3 (Maybe [Text]) Source #

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

restoreDBClusterFromS3_backtrackWindow :: Lens' RestoreDBClusterFromS3 (Maybe Integer) Source #

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

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

restoreDBClusterFromS3_backupRetentionPeriod :: Lens' RestoreDBClusterFromS3 (Maybe Int) Source #

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

restoreDBClusterFromS3_characterSetName :: Lens' RestoreDBClusterFromS3 (Maybe Text) Source #

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

restoreDBClusterFromS3_copyTagsToSnapshot :: Lens' RestoreDBClusterFromS3 (Maybe Bool) Source #

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.

restoreDBClusterFromS3_dbClusterParameterGroupName :: Lens' RestoreDBClusterFromS3 (Maybe Text) Source #

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.

restoreDBClusterFromS3_dbSubnetGroupName :: Lens' RestoreDBClusterFromS3 (Maybe Text) Source #

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

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

Example: mydbsubnetgroup

restoreDBClusterFromS3_databaseName :: Lens' RestoreDBClusterFromS3 (Maybe Text) Source #

The database name for the restored DB cluster.

restoreDBClusterFromS3_deletionProtection :: Lens' RestoreDBClusterFromS3 (Maybe Bool) Source #

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 isn't enabled.

restoreDBClusterFromS3_domain :: Lens' RestoreDBClusterFromS3 (Maybe Text) Source #

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.

restoreDBClusterFromS3_domainIAMRoleName :: Lens' RestoreDBClusterFromS3 (Maybe Text) Source #

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

restoreDBClusterFromS3_enableCloudwatchLogsExports :: Lens' RestoreDBClusterFromS3 (Maybe [Text]) Source #

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.

Aurora PostgreSQL

Possible value is postgresql.

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

restoreDBClusterFromS3_enableIAMDatabaseAuthentication :: Lens' RestoreDBClusterFromS3 (Maybe Bool) Source #

A value that indicates whether to enable mapping of Amazon Web Services 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.

restoreDBClusterFromS3_engineVersion :: Lens' RestoreDBClusterFromS3 (Maybe Text) Source #

The version number of the database engine to use.

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

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

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

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

Aurora MySQL

Example: 5.6.10a, 5.6.mysql_aurora.1.19.2, 5.7.mysql_aurora.2.07.1, 8.0.mysql_aurora.3.02.0

restoreDBClusterFromS3_kmsKeyId :: Lens' RestoreDBClusterFromS3 (Maybe Text) Source #

The Amazon Web Services KMS key identifier for an encrypted DB cluster.

The Amazon Web Services 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.

restoreDBClusterFromS3_manageMasterUserPassword :: Lens' RestoreDBClusterFromS3 (Maybe Bool) Source #

A value that indicates whether to manage the master user password with Amazon Web Services Secrets Manager.

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

Constraints:

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

restoreDBClusterFromS3_masterUserPassword :: Lens' RestoreDBClusterFromS3 (Maybe Text) Source #

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.

restoreDBClusterFromS3_masterUserSecretKmsKeyId :: Lens' RestoreDBClusterFromS3 (Maybe Text) Source #

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

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

The Amazon Web Services 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.

restoreDBClusterFromS3_networkType :: Lens' RestoreDBClusterFromS3 (Maybe Text) Source #

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.

restoreDBClusterFromS3_optionGroupName :: Lens' RestoreDBClusterFromS3 (Maybe Text) Source #

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.

restoreDBClusterFromS3_port :: Lens' RestoreDBClusterFromS3 (Maybe Int) Source #

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

Default: 3306

restoreDBClusterFromS3_preferredBackupWindow :: Lens' RestoreDBClusterFromS3 (Maybe Text) Source #

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.

restoreDBClusterFromS3_preferredMaintenanceWindow :: Lens' RestoreDBClusterFromS3 (Maybe Text) Source #

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.

restoreDBClusterFromS3_s3Prefix :: Lens' RestoreDBClusterFromS3 (Maybe Text) Source #

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.

restoreDBClusterFromS3_serverlessV2ScalingConfiguration :: Lens' RestoreDBClusterFromS3 (Maybe ServerlessV2ScalingConfiguration) Source #

Undocumented member.

restoreDBClusterFromS3_storageEncrypted :: Lens' RestoreDBClusterFromS3 (Maybe Bool) Source #

A value that indicates whether the restored DB cluster is encrypted.

restoreDBClusterFromS3_tags :: Lens' RestoreDBClusterFromS3 (Maybe [Tag]) Source #

Undocumented member.

restoreDBClusterFromS3_vpcSecurityGroupIds :: Lens' RestoreDBClusterFromS3 (Maybe [Text]) Source #

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

restoreDBClusterFromS3_dbClusterIdentifier :: Lens' RestoreDBClusterFromS3 Text Source #

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

restoreDBClusterFromS3_engine :: Lens' RestoreDBClusterFromS3 Text Source #

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

Valid Values: aurora (for MySQL 5.6-compatible Aurora) and aurora-mysql (for MySQL 5.7-compatible and MySQL 8.0-compatible Aurora)

restoreDBClusterFromS3_masterUsername :: Lens' RestoreDBClusterFromS3 Text Source #

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.

restoreDBClusterFromS3_sourceEngine :: Lens' RestoreDBClusterFromS3 Text Source #

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

Valid values: mysql

restoreDBClusterFromS3_sourceEngineVersion :: Lens' RestoreDBClusterFromS3 Text Source #

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

MySQL versions 5.5, 5.6, and 5.7 are supported.

Example: 5.6.40, 5.7.28

restoreDBClusterFromS3_s3BucketName :: Lens' RestoreDBClusterFromS3 Text Source #

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

restoreDBClusterFromS3_s3IngestionRoleArn :: Lens' RestoreDBClusterFromS3 Text Source #

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

Destructuring the Response

data RestoreDBClusterFromS3Response Source #

See: newRestoreDBClusterFromS3Response smart constructor.

Constructors

RestoreDBClusterFromS3Response'
Fields dbCluster :: Maybe DBCluster httpStatus :: Int The response's http status code.

Instances

Instances details

Generic RestoreDBClusterFromS3Response Source #
Instance details Defined in Amazonka.RDS.RestoreDBClusterFromS3 Associated Types type Rep RestoreDBClusterFromS3Response :: Type -> Type # Methods from :: RestoreDBClusterFromS3Response -> Rep RestoreDBClusterFromS3Response x # to :: Rep RestoreDBClusterFromS3Response x -> RestoreDBClusterFromS3Response #
Read RestoreDBClusterFromS3Response Source #
Instance details Defined in Amazonka.RDS.RestoreDBClusterFromS3 Methods readsPrec :: Int -> ReadS RestoreDBClusterFromS3Response # readList :: ReadS [RestoreDBClusterFromS3Response] # readPrec :: ReadPrec RestoreDBClusterFromS3Response # readListPrec :: ReadPrec [RestoreDBClusterFromS3Response] #
Show RestoreDBClusterFromS3Response Source #
Instance details Defined in Amazonka.RDS.RestoreDBClusterFromS3 Methods showsPrec :: Int -> RestoreDBClusterFromS3Response -> ShowS # show :: RestoreDBClusterFromS3Response -> String # showList :: [RestoreDBClusterFromS3Response] -> ShowS #
NFData RestoreDBClusterFromS3Response Source #
Instance details Defined in Amazonka.RDS.RestoreDBClusterFromS3 Methods rnf :: RestoreDBClusterFromS3Response -> () #
Eq RestoreDBClusterFromS3Response Source #
Instance details Defined in Amazonka.RDS.RestoreDBClusterFromS3 Methods (==) :: RestoreDBClusterFromS3Response -> RestoreDBClusterFromS3Response -> Bool # (/=) :: RestoreDBClusterFromS3Response -> RestoreDBClusterFromS3Response -> Bool #
type Rep RestoreDBClusterFromS3Response Source #
Instance details Defined in Amazonka.RDS.RestoreDBClusterFromS3 type Rep RestoreDBClusterFromS3Response = D1 ('MetaData "RestoreDBClusterFromS3Response" "Amazonka.RDS.RestoreDBClusterFromS3" "amazonka-rds-2.0-3xXyiLHmAvvCXXUIx1uhpP" 'False) (C1 ('MetaCons "RestoreDBClusterFromS3Response'" 'PrefixI 'True) (S1 ('MetaSel ('Just "dbCluster") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe DBCluster)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newRestoreDBClusterFromS3Response Source #

Arguments

:: Int	`$sel:httpStatus:RestoreDBClusterFromS3Response'`
-> RestoreDBClusterFromS3Response

Create a value of RestoreDBClusterFromS3Response with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:dbCluster:RestoreDBClusterFromS3Response', restoreDBClusterFromS3Response_dbCluster - Undocumented member.

$sel:httpStatus:RestoreDBClusterFromS3Response', restoreDBClusterFromS3Response_httpStatus - The response's http status code.

Response Lenses

restoreDBClusterFromS3Response_dbCluster :: Lens' RestoreDBClusterFromS3Response (Maybe DBCluster) Source #

Undocumented member.

restoreDBClusterFromS3Response_httpStatus :: Lens' RestoreDBClusterFromS3Response Int Source #

The response's http status code.