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

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

Network.AWS.RDS.RestoreDBClusterFromSnapshot

Contents

Description

Creates a new DB cluster from a DB cluster snapshot. The target DB cluster is created from the source DB cluster restore point with the same configuration as the original source DB cluster, except that the new DB cluster is created with the default security group.

For more information on Amazon Aurora, see Aurora on Amazon RDS in the Amazon RDS User Guide.

Synopsis

Creating a Request

restoreDBClusterFromSnapshot #

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

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

  • rdbcfsEngineVersion - The version of the database engine to use for the new DB cluster.
  • rdbcfsDBSubnetGroupName - The name of the DB subnet group to use for the new DB cluster. Constraints: Must contain no more than 255 alphanumeric characters, periods, underscores, spaces, or hyphens. Must not be default. Example: mySubnetgroup
  • rdbcfsAvailabilityZones - Provides the list of EC2 Availability Zones that instances in the restored DB cluster can be created in.
  • rdbcfsKMSKeyId - The KMS key identifier to use when restoring an encrypted DB cluster from a DB cluster snapshot. The KMS key identifier is the Amazon Resource Name (ARN) for the KMS encryption key. If you are restoring 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 KMS encryption key. If you do not specify a value for the KmsKeyId parameter, then the following will occur: * If the DB cluster snapshot is encrypted, then the restored DB cluster is encrypted using the KMS key that was used to encrypt the DB cluster snapshot. * If the DB cluster snapshot is not encrypted, then the restored DB cluster is encrypted using the specified encryption key.
  • rdbcfsVPCSecurityGroupIds - A list of VPC security groups that the new DB cluster will belong to.
  • rdbcfsDatabaseName - The database name for the restored DB cluster.
  • rdbcfsOptionGroupName - The name of the option group to use for the restored DB cluster.
  • rdbcfsTags - The tags to be assigned to the restored DB cluster.
  • rdbcfsPort - The port number on which the new DB cluster accepts connections. Constraints: Value must be 1150-65535 Default: The same port as the original DB cluster.
  • rdbcfsDBClusterIdentifier - The name of the DB cluster to create from the DB cluster snapshot. This parameter isn't case-sensitive. Constraints: * Must contain from 1 to 255 alphanumeric characters or hyphens * First character must be a letter * Cannot end with a hyphen or contain two consecutive hyphens Example: my-snapshot-id
  • rdbcfsSnapshotIdentifier - The identifier for the DB cluster snapshot to restore from. Constraints: * Must contain from 1 to 63 alphanumeric characters or hyphens * First character must be a letter * Cannot end with a hyphen or contain two consecutive hyphens
  • rdbcfsEngine - The database engine to use for the new DB cluster. Default: The same as source Constraint: Must be compatible with the engine of the source

data RestoreDBClusterFromSnapshot #

See: restoreDBClusterFromSnapshot smart constructor.

Instances

Eq RestoreDBClusterFromSnapshot # 
Data RestoreDBClusterFromSnapshot # 

Methods

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

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

toConstr :: RestoreDBClusterFromSnapshot -> Constr #

dataTypeOf :: RestoreDBClusterFromSnapshot -> DataType #

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

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

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

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

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

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

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

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

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

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

Read RestoreDBClusterFromSnapshot # 
Show RestoreDBClusterFromSnapshot # 
Generic RestoreDBClusterFromSnapshot # 
Hashable RestoreDBClusterFromSnapshot # 
NFData RestoreDBClusterFromSnapshot # 
AWSRequest RestoreDBClusterFromSnapshot # 
ToQuery RestoreDBClusterFromSnapshot # 
ToPath RestoreDBClusterFromSnapshot # 
ToHeaders RestoreDBClusterFromSnapshot # 
type Rep RestoreDBClusterFromSnapshot # 
type Rep RestoreDBClusterFromSnapshot = D1 (MetaData "RestoreDBClusterFromSnapshot" "Network.AWS.RDS.RestoreDBClusterFromSnapshot" "amazonka-rds-1.4.5-I79yxZdjKNFFGn6ti49zKn" False) (C1 (MetaCons "RestoreDBClusterFromSnapshot'" PrefixI True) ((:*:) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "_rdbcfsEngineVersion") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) ((:*:) (S1 (MetaSel (Just Symbol "_rdbcfsDBSubnetGroupName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) (S1 (MetaSel (Just Symbol "_rdbcfsAvailabilityZones") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [Text]))))) ((:*:) (S1 (MetaSel (Just Symbol "_rdbcfsKMSKeyId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) ((:*:) (S1 (MetaSel (Just Symbol "_rdbcfsVPCSecurityGroupIds") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [Text]))) (S1 (MetaSel (Just Symbol "_rdbcfsDatabaseName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)))))) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "_rdbcfsOptionGroupName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) ((:*:) (S1 (MetaSel (Just Symbol "_rdbcfsTags") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [Tag]))) (S1 (MetaSel (Just Symbol "_rdbcfsPort") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Int))))) ((:*:) (S1 (MetaSel (Just Symbol "_rdbcfsDBClusterIdentifier") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text)) ((:*:) (S1 (MetaSel (Just Symbol "_rdbcfsSnapshotIdentifier") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text)) (S1 (MetaSel (Just Symbol "_rdbcfsEngine") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text)))))))
type Rs RestoreDBClusterFromSnapshot # 

Request Lenses

rdbcfsEngineVersion :: Lens' RestoreDBClusterFromSnapshot (Maybe Text) #

The version of the database engine to use for the new DB cluster.

rdbcfsDBSubnetGroupName :: Lens' RestoreDBClusterFromSnapshot (Maybe Text) #

The name of the DB subnet group to use for the new DB cluster. Constraints: Must contain no more than 255 alphanumeric characters, periods, underscores, spaces, or hyphens. Must not be default. Example: mySubnetgroup

rdbcfsAvailabilityZones :: Lens' RestoreDBClusterFromSnapshot [Text] #

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

rdbcfsKMSKeyId :: Lens' RestoreDBClusterFromSnapshot (Maybe Text) #

The KMS key identifier to use when restoring an encrypted DB cluster from a DB cluster snapshot. The KMS key identifier is the Amazon Resource Name (ARN) for the KMS encryption key. If you are restoring 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 KMS encryption key. If you do not specify a value for the KmsKeyId parameter, then the following will occur: * If the DB cluster snapshot is encrypted, then the restored DB cluster is encrypted using the KMS key that was used to encrypt the DB cluster snapshot. * If the DB cluster snapshot is not encrypted, then the restored DB cluster is encrypted using the specified encryption key.

rdbcfsVPCSecurityGroupIds :: Lens' RestoreDBClusterFromSnapshot [Text] #

A list of VPC security groups that the new DB cluster will belong to.

rdbcfsDatabaseName :: Lens' RestoreDBClusterFromSnapshot (Maybe Text) #

The database name for the restored DB cluster.

rdbcfsOptionGroupName :: Lens' RestoreDBClusterFromSnapshot (Maybe Text) #

The name of the option group to use for the restored DB cluster.

rdbcfsTags :: Lens' RestoreDBClusterFromSnapshot [Tag] #

The tags to be assigned to the restored DB cluster.

rdbcfsPort :: Lens' RestoreDBClusterFromSnapshot (Maybe Int) #

The port number on which the new DB cluster accepts connections. Constraints: Value must be 1150-65535 Default: The same port as the original DB cluster.

rdbcfsDBClusterIdentifier :: Lens' RestoreDBClusterFromSnapshot Text #

The name of the DB cluster to create from the DB cluster snapshot. This parameter isn't case-sensitive. Constraints: * Must contain from 1 to 255 alphanumeric characters or hyphens * First character must be a letter * Cannot end with a hyphen or contain two consecutive hyphens Example: my-snapshot-id

rdbcfsSnapshotIdentifier :: Lens' RestoreDBClusterFromSnapshot Text #

The identifier for the DB cluster snapshot to restore from. Constraints: * Must contain from 1 to 63 alphanumeric characters or hyphens * First character must be a letter * Cannot end with a hyphen or contain two consecutive hyphens

rdbcfsEngine :: Lens' RestoreDBClusterFromSnapshot Text #

The database engine to use for the new DB cluster. Default: The same as source Constraint: Must be compatible with the engine of the source

Destructuring the Response

restoreDBClusterFromSnapshotResponse #

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

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

data RestoreDBClusterFromSnapshotResponse #

See: restoreDBClusterFromSnapshotResponse smart constructor.

Instances

Eq RestoreDBClusterFromSnapshotResponse # 
Data RestoreDBClusterFromSnapshotResponse # 

Methods

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

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

toConstr :: RestoreDBClusterFromSnapshotResponse -> Constr #

dataTypeOf :: RestoreDBClusterFromSnapshotResponse -> DataType #

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

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

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

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

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

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

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

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

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

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

Read RestoreDBClusterFromSnapshotResponse # 
Show RestoreDBClusterFromSnapshotResponse # 
Generic RestoreDBClusterFromSnapshotResponse # 
NFData RestoreDBClusterFromSnapshotResponse # 
type Rep RestoreDBClusterFromSnapshotResponse # 
type Rep RestoreDBClusterFromSnapshotResponse = D1 (MetaData "RestoreDBClusterFromSnapshotResponse" "Network.AWS.RDS.RestoreDBClusterFromSnapshot" "amazonka-rds-1.4.5-I79yxZdjKNFFGn6ti49zKn" False) (C1 (MetaCons "RestoreDBClusterFromSnapshotResponse'" PrefixI True) ((:*:) (S1 (MetaSel (Just Symbol "_rdbcfsrsDBCluster") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe DBCluster))) (S1 (MetaSel (Just Symbol "_rdbcfsrsResponseStatus") NoSourceUnpackedness SourceStrict DecidedUnpack) (Rec0 Int))))

Response Lenses