amazonka-rds-1.5.0: Amazon Relational Database Service SDK.

Copyright(c) 2013-2017 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone
LanguageHaskell2010

Network.AWS.RDS.RestoreDBClusterFromS3

Contents

Description

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 from MySQL by Using an Amazon S3 Bucket .

Synopsis

Creating a Request

restoreDBClusterFromS3 Source #

Creates a value of RestoreDBClusterFromS3 with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

  • rdcfsEngineVersion - The version number of the database engine to use. Aurora Example: 5.6.10a
  • rdcfsStorageEncrypted - Specifies whether the restored DB cluster is encrypted.
  • rdcfsDBSubnetGroupName - A DB subnet group to associate with the restored DB cluster. Constraints: If supplied, must match the name of an existing DBSubnetGroup. Example: mySubnetgroup
  • rdcfsPreferredMaintenanceWindow - The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC). Format: ddd:hh24:mi-ddd:hh24:mi Default: A 30-minute window selected at random from an 8-hour block of time per 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 RDS User Guide. Valid Days: Mon, Tue, Wed, Thu, Fri, Sat, Sun Constraints: Minimum 30-minute window.
  • rdcfsAvailabilityZones - A list of EC2 Availability Zones that instances in the restored DB cluster can be created in.
  • rdcfsCharacterSetName - A value that indicates that the restored DB cluster should be associated with the specified CharacterSet.
  • rdcfsKMSKeyId - The 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 true, 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.
  • rdcfsPreferredBackupWindow - The daily time range during which automated backups are created if automated backups are enabled using the BackupRetentionPeriod parameter. Default: A 30-minute window selected at random from an 8-hour block of time per AWS Region. To see the time blocks available, see Adjusting the Preferred Maintenance Window in the Amazon RDS User Guide. Constraints: * Must be in the format hh24:mi-hh24:mi . * Times should be in Universal Coordinated Time (UTC). * Must not conflict with the preferred maintenance window. * Must be at least 30 minutes.
  • rdcfsBackupRetentionPeriod - 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
  • rdcfsVPCSecurityGroupIds - A list of EC2 VPC security groups to associate with the restored DB cluster.
  • rdcfsDatabaseName - The database name for the restored DB cluster.
  • rdcfsDBClusterParameterGroupName - 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.
  • rdcfsS3Prefix - 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.
  • rdcfsOptionGroupName - A value that indicates that the restored DB cluster should be associated with the specified option group. Permanent options cannot be removed from an option group. An option group cannot be removed from a DB cluster once it is associated with a DB cluster.
  • rdcfsTags - Undocumented member.
  • rdcfsPort - The port number on which the instances in the restored DB cluster accept connections. Default: 3306
  • rdcfsEnableIAMDatabaseAuthentication - A Boolean value that is true to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts, and otherwise false. Default: false
  • rdcfsDBClusterIdentifier - The name of the DB cluster to create from the source data in the 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. * Cannot end with a hyphen or contain two consecutive hyphens. Example: my-cluster1
  • rdcfsEngine - The name of the database engine to be used for the restored DB cluster. Valid Values: aurora
  • rdcfsMasterUsername - 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. * Cannot be a reserved word for the chosen database engine.
  • rdcfsMasterUserPassword - 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.
  • rdcfsSourceEngine - The identifier for the database engine that was backed up to create the files stored in the Amazon S3 bucket. Valid values: mysql
  • rdcfsSourceEngineVersion - 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
  • rdcfsS3BucketName - The name of the Amazon S3 bucket that contains the data used to create the Amazon Aurora DB cluster.
  • rdcfsS3IngestionRoleARN - 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.

data RestoreDBClusterFromS3 Source #

See: restoreDBClusterFromS3 smart constructor.

Instances

Eq RestoreDBClusterFromS3 Source # 
Data RestoreDBClusterFromS3 Source # 

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> RestoreDBClusterFromS3 -> c RestoreDBClusterFromS3 #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c RestoreDBClusterFromS3 #

toConstr :: RestoreDBClusterFromS3 -> Constr #

dataTypeOf :: RestoreDBClusterFromS3 -> DataType #

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c RestoreDBClusterFromS3) #

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c RestoreDBClusterFromS3) #

gmapT :: (forall b. Data b => b -> b) -> RestoreDBClusterFromS3 -> RestoreDBClusterFromS3 #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> RestoreDBClusterFromS3 -> r #

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> RestoreDBClusterFromS3 -> r #

gmapQ :: (forall d. Data d => d -> u) -> RestoreDBClusterFromS3 -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> RestoreDBClusterFromS3 -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> RestoreDBClusterFromS3 -> m RestoreDBClusterFromS3 #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> RestoreDBClusterFromS3 -> m RestoreDBClusterFromS3 #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> RestoreDBClusterFromS3 -> m RestoreDBClusterFromS3 #

Read RestoreDBClusterFromS3 Source # 
Show RestoreDBClusterFromS3 Source # 
Generic RestoreDBClusterFromS3 Source # 
Hashable RestoreDBClusterFromS3 Source # 
NFData RestoreDBClusterFromS3 Source # 

Methods

rnf :: RestoreDBClusterFromS3 -> () #

AWSRequest RestoreDBClusterFromS3 Source # 
ToQuery RestoreDBClusterFromS3 Source # 
ToPath RestoreDBClusterFromS3 Source # 
ToHeaders RestoreDBClusterFromS3 Source # 
type Rep RestoreDBClusterFromS3 Source # 
type Rep RestoreDBClusterFromS3 = D1 (MetaData "RestoreDBClusterFromS3" "Network.AWS.RDS.RestoreDBClusterFromS3" "amazonka-rds-1.5.0-4pv5DetELOaBXetw2fB1GM" False) (C1 (MetaCons "RestoreDBClusterFromS3'" PrefixI True) ((:*:) ((:*:) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "_rdcfsEngineVersion") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) ((:*:) (S1 (MetaSel (Just Symbol "_rdcfsStorageEncrypted") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Bool))) (S1 (MetaSel (Just Symbol "_rdcfsDBSubnetGroupName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))))) ((:*:) (S1 (MetaSel (Just Symbol "_rdcfsPreferredMaintenanceWindow") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) ((:*:) (S1 (MetaSel (Just Symbol "_rdcfsAvailabilityZones") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [Text]))) (S1 (MetaSel (Just Symbol "_rdcfsCharacterSetName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)))))) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "_rdcfsKMSKeyId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) ((:*:) (S1 (MetaSel (Just Symbol "_rdcfsPreferredBackupWindow") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) (S1 (MetaSel (Just Symbol "_rdcfsBackupRetentionPeriod") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Int))))) ((:*:) (S1 (MetaSel (Just Symbol "_rdcfsVPCSecurityGroupIds") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [Text]))) ((:*:) (S1 (MetaSel (Just Symbol "_rdcfsDatabaseName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) (S1 (MetaSel (Just Symbol "_rdcfsDBClusterParameterGroupName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))))))) ((:*:) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "_rdcfsS3Prefix") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) ((:*:) (S1 (MetaSel (Just Symbol "_rdcfsOptionGroupName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) (S1 (MetaSel (Just Symbol "_rdcfsTags") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [Tag]))))) ((:*:) (S1 (MetaSel (Just Symbol "_rdcfsPort") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Int))) ((:*:) (S1 (MetaSel (Just Symbol "_rdcfsEnableIAMDatabaseAuthentication") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Bool))) (S1 (MetaSel (Just Symbol "_rdcfsDBClusterIdentifier") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text))))) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "_rdcfsEngine") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text)) ((:*:) (S1 (MetaSel (Just Symbol "_rdcfsMasterUsername") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text)) (S1 (MetaSel (Just Symbol "_rdcfsMasterUserPassword") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text)))) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "_rdcfsSourceEngine") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text)) (S1 (MetaSel (Just Symbol "_rdcfsSourceEngineVersion") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text))) ((:*:) (S1 (MetaSel (Just Symbol "_rdcfsS3BucketName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text)) (S1 (MetaSel (Just Symbol "_rdcfsS3IngestionRoleARN") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text))))))))
type Rs RestoreDBClusterFromS3 Source # 

Request Lenses

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

The version number of the database engine to use. Aurora Example: 5.6.10a

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

Specifies whether the restored DB cluster is encrypted.

rdcfsDBSubnetGroupName :: 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: mySubnetgroup

rdcfsPreferredMaintenanceWindow :: 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 Default: A 30-minute window selected at random from an 8-hour block of time per 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 RDS User Guide. Valid Days: Mon, Tue, Wed, Thu, Fri, Sat, Sun Constraints: Minimum 30-minute window.

rdcfsAvailabilityZones :: Lens' RestoreDBClusterFromS3 [Text] Source #

A list of EC2 Availability Zones that instances in the restored DB cluster can be created in.

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

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

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

The 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 true, 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.

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

The daily time range during which automated backups are created if automated backups are enabled using the BackupRetentionPeriod parameter. Default: A 30-minute window selected at random from an 8-hour block of time per AWS Region. To see the time blocks available, see Adjusting the Preferred Maintenance Window in the Amazon RDS User Guide. Constraints: * Must be in the format hh24:mi-hh24:mi . * Times should be in Universal Coordinated Time (UTC). * Must not conflict with the preferred maintenance window. * Must be at least 30 minutes.

rdcfsBackupRetentionPeriod :: 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

rdcfsVPCSecurityGroupIds :: Lens' RestoreDBClusterFromS3 [Text] Source #

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

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

The database name for the restored DB cluster.

rdcfsDBClusterParameterGroupName :: 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.

rdcfsS3Prefix :: 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.

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

A value that indicates that the restored DB cluster should be associated with the specified option group. Permanent options cannot be removed from an option group. An option group cannot be removed from a DB cluster once it is associated with a DB cluster.

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

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

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

A Boolean value that is true to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts, and otherwise false. Default: false

rdcfsDBClusterIdentifier :: Lens' RestoreDBClusterFromS3 Text Source #

The name of the DB cluster to create from the source data in the 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. * Cannot end with a hyphen or contain two consecutive hyphens. Example: my-cluster1

rdcfsEngine :: Lens' RestoreDBClusterFromS3 Text Source #

The name of the database engine to be used for the restored DB cluster. Valid Values: aurora

rdcfsMasterUsername :: 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. * Cannot be a reserved word for the chosen database engine.

rdcfsMasterUserPassword :: Lens' RestoreDBClusterFromS3 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.

rdcfsSourceEngine :: 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

rdcfsSourceEngineVersion :: Lens' RestoreDBClusterFromS3 Text Source #

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

rdcfsS3BucketName :: Lens' RestoreDBClusterFromS3 Text Source #

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

rdcfsS3IngestionRoleARN :: Lens' RestoreDBClusterFromS3 Text Source #

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.

Destructuring the Response

restoreDBClusterFromS3Response Source #

Creates a value of RestoreDBClusterFromS3Response with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

data RestoreDBClusterFromS3Response Source #

See: restoreDBClusterFromS3Response smart constructor.

Instances

Eq RestoreDBClusterFromS3Response Source # 
Data RestoreDBClusterFromS3Response Source # 

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> RestoreDBClusterFromS3Response -> c RestoreDBClusterFromS3Response #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c RestoreDBClusterFromS3Response #

toConstr :: RestoreDBClusterFromS3Response -> Constr #

dataTypeOf :: RestoreDBClusterFromS3Response -> DataType #

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c RestoreDBClusterFromS3Response) #

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c RestoreDBClusterFromS3Response) #

gmapT :: (forall b. Data b => b -> b) -> RestoreDBClusterFromS3Response -> RestoreDBClusterFromS3Response #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> RestoreDBClusterFromS3Response -> r #

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> RestoreDBClusterFromS3Response -> r #

gmapQ :: (forall d. Data d => d -> u) -> RestoreDBClusterFromS3Response -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> RestoreDBClusterFromS3Response -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> RestoreDBClusterFromS3Response -> m RestoreDBClusterFromS3Response #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> RestoreDBClusterFromS3Response -> m RestoreDBClusterFromS3Response #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> RestoreDBClusterFromS3Response -> m RestoreDBClusterFromS3Response #

Read RestoreDBClusterFromS3Response Source # 
Show RestoreDBClusterFromS3Response Source # 
Generic RestoreDBClusterFromS3Response Source # 
NFData RestoreDBClusterFromS3Response Source # 
type Rep RestoreDBClusterFromS3Response Source # 
type Rep RestoreDBClusterFromS3Response = D1 (MetaData "RestoreDBClusterFromS3Response" "Network.AWS.RDS.RestoreDBClusterFromS3" "amazonka-rds-1.5.0-4pv5DetELOaBXetw2fB1GM" False) (C1 (MetaCons "RestoreDBClusterFromS3Response'" PrefixI True) ((:*:) (S1 (MetaSel (Just Symbol "_rdcfsrsDBCluster") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe DBCluster))) (S1 (MetaSel (Just Symbol "_rdcfsrsResponseStatus") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Int))))

Response Lenses