Network.AWS.RDS.RestoreDBClusterFromSnapshot

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.

Creating a Request

restoreDBClusterFromSnapshot

Arguments

:: Text

rdcfsDBClusterIdentifier

-> Text

rdcfsSnapshotIdentifier

-> Text

rdcfsEngine

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

• rdcfsEngineVersion
• rdcfsDBSubnetGroupName
• rdcfsAvailabilityZones
• rdcfsKMSKeyId
• rdcfsVPCSecurityGroupIds
• rdcfsDatabaseName
• rdcfsOptionGroupName
• rdcfsTags
• rdcfsPort
• rdcfsDBClusterIdentifier
• rdcfsSnapshotIdentifier
• rdcfsEngine

data RestoreDBClusterFromSnapshot

See: restoreDBClusterFromSnapshot smart constructor.

Instances

Eq RestoreDBClusterFromSnapshot

Methods

(==) :: RestoreDBClusterFromSnapshot -> RestoreDBClusterFromSnapshot -> Bool

(/=) :: RestoreDBClusterFromSnapshot -> RestoreDBClusterFromSnapshot -> Bool

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

Methods

readsPrec :: Int -> ReadS RestoreDBClusterFromSnapshot

readList :: ReadS [RestoreDBClusterFromSnapshot]

readPrec :: ReadPrec RestoreDBClusterFromSnapshot

readListPrec :: ReadPrec [RestoreDBClusterFromSnapshot]

Show RestoreDBClusterFromSnapshot

Methods

showsPrec :: Int -> RestoreDBClusterFromSnapshot -> ShowS

show :: RestoreDBClusterFromSnapshot -> String

showList :: [RestoreDBClusterFromSnapshot] -> ShowS

Generic RestoreDBClusterFromSnapshot

Associated Types

type Rep RestoreDBClusterFromSnapshot :: * -> *

Methods

from :: RestoreDBClusterFromSnapshot -> Rep RestoreDBClusterFromSnapshot x

to :: Rep RestoreDBClusterFromSnapshot x -> RestoreDBClusterFromSnapshot

Hashable RestoreDBClusterFromSnapshot

Methods

hashWithSalt :: Int -> RestoreDBClusterFromSnapshot -> Int

hash :: RestoreDBClusterFromSnapshot -> Int

NFData RestoreDBClusterFromSnapshot

Methods

rnf :: RestoreDBClusterFromSnapshot -> ()

AWSRequest RestoreDBClusterFromSnapshot

Associated Types

type Rs RestoreDBClusterFromSnapshot :: *

Methods

request :: RestoreDBClusterFromSnapshot -> Request RestoreDBClusterFromSnapshot

response :: MonadResource m => Logger -> Service -> Proxy * RestoreDBClusterFromSnapshot -> ClientResponse -> m (Response RestoreDBClusterFromSnapshot)

ToPath RestoreDBClusterFromSnapshot

Methods

toPath :: RestoreDBClusterFromSnapshot -> ByteString

ToHeaders RestoreDBClusterFromSnapshot

Methods

toHeaders :: RestoreDBClusterFromSnapshot -> [Header]

ToQuery RestoreDBClusterFromSnapshot

Methods

toQuery :: RestoreDBClusterFromSnapshot -> QueryString

type Rep RestoreDBClusterFromSnapshot

type Rep RestoreDBClusterFromSnapshot = D1 (MetaData "RestoreDBClusterFromSnapshot" "Network.AWS.RDS.RestoreDBClusterFromSnapshot" "amazonka-rds-1.4.2-JgM977FTRAf6Z65uEqLG2D" False) (C1 (MetaCons "RestoreDBClusterFromSnapshot'" PrefixI True) ((:*:) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "_rdcfsEngineVersion") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) ((:*:) (S1 (MetaSel (Just Symbol "_rdcfsDBSubnetGroupName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) (S1 (MetaSel (Just Symbol "_rdcfsAvailabilityZones") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [Text]))))) ((:*:) (S1 (MetaSel (Just Symbol "_rdcfsKMSKeyId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) ((:*:) (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 "_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 "_rdcfsDBClusterIdentifier") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text)) ((:*:) (S1 (MetaSel (Just Symbol "_rdcfsSnapshotIdentifier") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text)) (S1 (MetaSel (Just Symbol "_rdcfsEngine") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text)))))))

type Rs RestoreDBClusterFromSnapshot

type Rs RestoreDBClusterFromSnapshot = RestoreDBClusterFromSnapshotResponse

Request Lenses

rdcfsEngineVersion :: Lens' RestoreDBClusterFromSnapshot (Maybe Text)

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

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

rdcfsAvailabilityZones :: Lens' RestoreDBClusterFromSnapshot [Text]

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

rdcfsKMSKeyId :: Lens' RestoreDBClusterFromSnapshot (Maybe Text)

The KMS key identifier to use when restoring an encrypted DB cluster from an encrypted 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 not encrypted.

If SnapshotIdentifier refers to a DB cluster snapshot that is not encrypted, and you specify a value for the KmsKeyId parameter, then the restore request is rejected.

rdcfsVPCSecurityGroupIds :: Lens' RestoreDBClusterFromSnapshot [Text]

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

rdcfsDatabaseName :: Lens' RestoreDBClusterFromSnapshot (Maybe Text)

The database name for the restored DB cluster.

rdcfsOptionGroupName :: Lens' RestoreDBClusterFromSnapshot (Maybe Text)

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

rdcfsTags :: Lens' RestoreDBClusterFromSnapshot [Tag]

The tags to be assigned to the restored DB cluster.

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

rdcfsDBClusterIdentifier :: 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'

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

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

Arguments

:: Int

rdcfsrsResponseStatus

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

• rdcfsrsDBCluster
• rdcfsrsResponseStatus

data RestoreDBClusterFromSnapshotResponse

See: restoreDBClusterFromSnapshotResponse smart constructor.

Instances

Eq RestoreDBClusterFromSnapshotResponse

Methods

(==) :: RestoreDBClusterFromSnapshotResponse -> RestoreDBClusterFromSnapshotResponse -> Bool

(/=) :: RestoreDBClusterFromSnapshotResponse -> RestoreDBClusterFromSnapshotResponse -> Bool

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

Methods

readsPrec :: Int -> ReadS RestoreDBClusterFromSnapshotResponse

readList :: ReadS [RestoreDBClusterFromSnapshotResponse]

readPrec :: ReadPrec RestoreDBClusterFromSnapshotResponse

readListPrec :: ReadPrec [RestoreDBClusterFromSnapshotResponse]

Show RestoreDBClusterFromSnapshotResponse

Methods

showsPrec :: Int -> RestoreDBClusterFromSnapshotResponse -> ShowS

show :: RestoreDBClusterFromSnapshotResponse -> String

showList :: [RestoreDBClusterFromSnapshotResponse] -> ShowS

Generic RestoreDBClusterFromSnapshotResponse

Associated Types

type Rep RestoreDBClusterFromSnapshotResponse :: * -> *

Methods

from :: RestoreDBClusterFromSnapshotResponse -> Rep RestoreDBClusterFromSnapshotResponse x

to :: Rep RestoreDBClusterFromSnapshotResponse x -> RestoreDBClusterFromSnapshotResponse

NFData RestoreDBClusterFromSnapshotResponse

Methods

rnf :: RestoreDBClusterFromSnapshotResponse -> ()

type Rep RestoreDBClusterFromSnapshotResponse

type Rep RestoreDBClusterFromSnapshotResponse = D1 (MetaData "RestoreDBClusterFromSnapshotResponse" "Network.AWS.RDS.RestoreDBClusterFromSnapshot" "amazonka-rds-1.4.2-JgM977FTRAf6Z65uEqLG2D" False) (C1 (MetaCons "RestoreDBClusterFromSnapshotResponse'" 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

rdcfsrsDBCluster :: Lens' RestoreDBClusterFromSnapshotResponse (Maybe DBCluster)

Undocumented member.

rdcfsrsResponseStatus :: Lens' RestoreDBClusterFromSnapshotResponse Int

The response status code.