Network.AWS.RDS.RestoreDBClusterFromSnapshot

Creates a new DB cluster from a DB snapshot or DB cluster snapshot.

If a DB snapshot is specified, the target DB cluster is created from the source DB snapshot with a default configuration and default security group.

If a DB cluster snapshot is specified, 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

rdbcfsDBClusterIdentifier

-> Text

rdbcfsSnapshotIdentifier

-> Text

rdbcfsEngine

-> 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: If supplied, must match the name of an existing DBSubnetGroup. Example: mySubnetgroup
• rdbcfsBacktrackWindow - The target backtrack window, in seconds. To disable backtracking, set this value to 0. Default: 0 Constraints: * If specified, this value must be set to a number from 0 to 259,200 (72 hours).
• rdbcfsAvailabilityZones - Provides the list of EC2 Availability Zones that instances in the restored DB cluster can be created in.
• rdbcfsKMSKeyId - The AWS KMS key identifier to use when restoring an encrypted DB cluster from a DB snapshot or 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 snapshot or DB cluster snapshot in SnapshotIdentifier is encrypted, then the restored DB cluster is encrypted using the KMS key that was used to encrypt the DB snapshot or DB cluster snapshot. * If the DB snapshot or DB cluster snapshot in SnapshotIdentifier is not encrypted, then the restored DB cluster is not encrypted.
• 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.
• rdbcfsEnableIAMDatabaseAuthentication - True to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts, and otherwise false. Default: false
• rdbcfsDBClusterIdentifier - The name of the DB cluster to create from the DB snapshot or DB cluster snapshot. This parameter 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-snapshot-id
• rdbcfsSnapshotIdentifier - The identifier for the DB snapshot or DB cluster snapshot to restore from. You can use either the name or the Amazon Resource Name (ARN) to specify a DB cluster snapshot. However, you can use only the ARN to specify a DB snapshot. Constraints: * Must match the identifier of an existing Snapshot.
• 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

Defined in Network.AWS.RDS.RestoreDBClusterFromSnapshot

Methods

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

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

Data RestoreDBClusterFromSnapshot

Defined in Network.AWS.RDS.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

Defined in Network.AWS.RDS.RestoreDBClusterFromSnapshot

Methods

readsPrec :: Int -> ReadS RestoreDBClusterFromSnapshot

readList :: ReadS [RestoreDBClusterFromSnapshot]

readPrec :: ReadPrec RestoreDBClusterFromSnapshot

readListPrec :: ReadPrec [RestoreDBClusterFromSnapshot]

Show RestoreDBClusterFromSnapshot

Defined in Network.AWS.RDS.RestoreDBClusterFromSnapshot

Methods

showsPrec :: Int -> RestoreDBClusterFromSnapshot -> ShowS

show :: RestoreDBClusterFromSnapshot -> String

showList :: [RestoreDBClusterFromSnapshot] -> ShowS

Generic RestoreDBClusterFromSnapshot

Defined in Network.AWS.RDS.RestoreDBClusterFromSnapshot

Associated Types

type Rep RestoreDBClusterFromSnapshot :: Type -> Type

Methods

from :: RestoreDBClusterFromSnapshot -> Rep RestoreDBClusterFromSnapshot x

to :: Rep RestoreDBClusterFromSnapshot x -> RestoreDBClusterFromSnapshot

Hashable RestoreDBClusterFromSnapshot

Defined in Network.AWS.RDS.RestoreDBClusterFromSnapshot

Methods

hashWithSalt :: Int -> RestoreDBClusterFromSnapshot -> Int

hash :: RestoreDBClusterFromSnapshot -> Int

AWSRequest RestoreDBClusterFromSnapshot

Defined in Network.AWS.RDS.RestoreDBClusterFromSnapshot

Associated Types

type Rs RestoreDBClusterFromSnapshot :: Type

Methods

request :: RestoreDBClusterFromSnapshot -> Request RestoreDBClusterFromSnapshot

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

ToHeaders RestoreDBClusterFromSnapshot

Defined in Network.AWS.RDS.RestoreDBClusterFromSnapshot

Methods

toHeaders :: RestoreDBClusterFromSnapshot -> [Header]

ToPath RestoreDBClusterFromSnapshot

Defined in Network.AWS.RDS.RestoreDBClusterFromSnapshot

Methods

toPath :: RestoreDBClusterFromSnapshot -> ByteString

ToQuery RestoreDBClusterFromSnapshot

Defined in Network.AWS.RDS.RestoreDBClusterFromSnapshot

Methods

toQuery :: RestoreDBClusterFromSnapshot -> QueryString

NFData RestoreDBClusterFromSnapshot

Defined in Network.AWS.RDS.RestoreDBClusterFromSnapshot

Methods

rnf :: RestoreDBClusterFromSnapshot -> ()

type Rep RestoreDBClusterFromSnapshot

Defined in Network.AWS.RDS.RestoreDBClusterFromSnapshot

type Rep RestoreDBClusterFromSnapshot = D1 (MetaData "RestoreDBClusterFromSnapshot" "Network.AWS.RDS.RestoreDBClusterFromSnapshot" "amazonka-rds-1.6.1-GvYb6r2di9RGFKQcoJXq1A" False) (C1 (MetaCons "RestoreDBClusterFromSnapshot'" PrefixI True) (((S1 (MetaSel (Just "_rdbcfsEngineVersion") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 (MetaSel (Just "_rdbcfsDBSubnetGroupName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: S1 (MetaSel (Just "_rdbcfsBacktrackWindow") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Integer)))) :*: ((S1 (MetaSel (Just "_rdbcfsAvailabilityZones") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [Text])) :*: S1 (MetaSel (Just "_rdbcfsKMSKeyId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 (MetaSel (Just "_rdbcfsVPCSecurityGroupIds") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [Text])) :*: S1 (MetaSel (Just "_rdbcfsDatabaseName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))))) :*: ((S1 (MetaSel (Just "_rdbcfsOptionGroupName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 (MetaSel (Just "_rdbcfsTags") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [Tag])) :*: S1 (MetaSel (Just "_rdbcfsPort") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Int)))) :*: ((S1 (MetaSel (Just "_rdbcfsEnableIAMDatabaseAuthentication") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Bool)) :*: S1 (MetaSel (Just "_rdbcfsDBClusterIdentifier") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text)) :*: (S1 (MetaSel (Just "_rdbcfsSnapshotIdentifier") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text) :*: S1 (MetaSel (Just "_rdbcfsEngine") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text))))))

type Rs RestoreDBClusterFromSnapshot

Defined in Network.AWS.RDS.RestoreDBClusterFromSnapshot

type Rs RestoreDBClusterFromSnapshot = RestoreDBClusterFromSnapshotResponse

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: If supplied, must match the name of an existing DBSubnetGroup. Example: mySubnetgroup

rdbcfsBacktrackWindow :: Lens' RestoreDBClusterFromSnapshot (Maybe Integer)

The target backtrack window, in seconds. To disable backtracking, set this value to 0. Default: 0 Constraints: * If specified, this value must be set to a number from 0 to 259,200 (72 hours).

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 AWS KMS key identifier to use when restoring an encrypted DB cluster from a DB snapshot or 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 snapshot or DB cluster snapshot in SnapshotIdentifier is encrypted, then the restored DB cluster is encrypted using the KMS key that was used to encrypt the DB snapshot or DB cluster snapshot. * If the DB snapshot or DB cluster snapshot in SnapshotIdentifier is not encrypted, then the restored DB cluster is not encrypted.

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.

rdbcfsEnableIAMDatabaseAuthentication :: Lens' RestoreDBClusterFromSnapshot (Maybe Bool)

True to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts, and otherwise false. Default: false

rdbcfsDBClusterIdentifier :: Lens' RestoreDBClusterFromSnapshot Text

The name of the DB cluster to create from the DB snapshot or DB cluster snapshot. This parameter 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-snapshot-id

rdbcfsSnapshotIdentifier :: Lens' RestoreDBClusterFromSnapshot Text

The identifier for the DB snapshot or DB cluster snapshot to restore from. You can use either the name or the Amazon Resource Name (ARN) to specify a DB cluster snapshot. However, you can use only the ARN to specify a DB snapshot. Constraints: * Must match the identifier of an existing Snapshot.

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

Arguments

:: Int

rdbcfsrsResponseStatus

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

• rdbcfsrsDBCluster - Undocumented member.
• rdbcfsrsResponseStatus - -- | The response status code.

data RestoreDBClusterFromSnapshotResponse

See: restoreDBClusterFromSnapshotResponse smart constructor.

Instances

Eq RestoreDBClusterFromSnapshotResponse

Defined in Network.AWS.RDS.RestoreDBClusterFromSnapshot

Methods

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

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

Data RestoreDBClusterFromSnapshotResponse

Defined in Network.AWS.RDS.RestoreDBClusterFromSnapshot

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

Defined in Network.AWS.RDS.RestoreDBClusterFromSnapshot

Methods

readsPrec :: Int -> ReadS RestoreDBClusterFromSnapshotResponse

readList :: ReadS [RestoreDBClusterFromSnapshotResponse]

readPrec :: ReadPrec RestoreDBClusterFromSnapshotResponse

readListPrec :: ReadPrec [RestoreDBClusterFromSnapshotResponse]

Show RestoreDBClusterFromSnapshotResponse

Defined in Network.AWS.RDS.RestoreDBClusterFromSnapshot

Methods

showsPrec :: Int -> RestoreDBClusterFromSnapshotResponse -> ShowS

show :: RestoreDBClusterFromSnapshotResponse -> String

showList :: [RestoreDBClusterFromSnapshotResponse] -> ShowS

Generic RestoreDBClusterFromSnapshotResponse

Defined in Network.AWS.RDS.RestoreDBClusterFromSnapshot

Associated Types

type Rep RestoreDBClusterFromSnapshotResponse :: Type -> Type

Methods

from :: RestoreDBClusterFromSnapshotResponse -> Rep RestoreDBClusterFromSnapshotResponse x

to :: Rep RestoreDBClusterFromSnapshotResponse x -> RestoreDBClusterFromSnapshotResponse

NFData RestoreDBClusterFromSnapshotResponse

Defined in Network.AWS.RDS.RestoreDBClusterFromSnapshot

Methods

rnf :: RestoreDBClusterFromSnapshotResponse -> ()

type Rep RestoreDBClusterFromSnapshotResponse

Defined in Network.AWS.RDS.RestoreDBClusterFromSnapshot

type Rep RestoreDBClusterFromSnapshotResponse = D1 (MetaData "RestoreDBClusterFromSnapshotResponse" "Network.AWS.RDS.RestoreDBClusterFromSnapshot" "amazonka-rds-1.6.1-GvYb6r2di9RGFKQcoJXq1A" False) (C1 (MetaCons "RestoreDBClusterFromSnapshotResponse'" PrefixI True) (S1 (MetaSel (Just "_rdbcfsrsDBCluster") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe DBCluster)) :*: S1 (MetaSel (Just "_rdbcfsrsResponseStatus") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Int)))

Response Lenses

rdbcfsrsDBCluster :: Lens' RestoreDBClusterFromSnapshotResponse (Maybe DBCluster)

Undocumented member.

rdbcfsrsResponseStatus :: Lens' RestoreDBClusterFromSnapshotResponse Int

• - | The response status code.