Network.AWS.OpsWorksCM.CreateBackup

Creates an application-level backup of a server. While the server is in the BACKING_UP state, the server cannot be changed, and no additional backup can be created.

Backups can be created for servers in RUNNING , HEALTHY , and UNHEALTHY states. By default, you can create a maximum of 50 manual backups.

This operation is asynchronous.

A LimitExceededException is thrown when the maximum number of manual backups is reached. An InvalidStateException is thrown when the server is not in any of the following states: RUNNING, HEALTHY, or UNHEALTHY. A ResourceNotFoundException is thrown when the server is not found. A ValidationException is thrown when parameters of the request are not valid.

Creating a Request

createBackup

Arguments

:: Text

cbServerName

-> CreateBackup

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

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

• cbDescription - A user-defined description of the backup.
• cbServerName - The name of the server that you want to back up.

data CreateBackup

See: createBackup smart constructor.

Instances

Eq CreateBackup

Methods

(==) :: CreateBackup -> CreateBackup -> Bool

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

Data CreateBackup

Methods

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

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

toConstr :: CreateBackup -> Constr

dataTypeOf :: CreateBackup -> DataType

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

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

gmapT :: (forall b. Data b => b -> b) -> CreateBackup -> CreateBackup

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

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

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

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

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

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

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

Read CreateBackup

Methods

readsPrec :: Int -> ReadS CreateBackup

readList :: ReadS [CreateBackup]

readPrec :: ReadPrec CreateBackup

readListPrec :: ReadPrec [CreateBackup]

Show CreateBackup

Methods

showsPrec :: Int -> CreateBackup -> ShowS

show :: CreateBackup -> String

showList :: [CreateBackup] -> ShowS

Generic CreateBackup

Associated Types

type Rep CreateBackup :: * -> *

Methods

from :: CreateBackup -> Rep CreateBackup x

to :: Rep CreateBackup x -> CreateBackup

Hashable CreateBackup

Methods

hashWithSalt :: Int -> CreateBackup -> Int

hash :: CreateBackup -> Int

ToJSON CreateBackup

Methods

toJSON :: CreateBackup -> Value

toEncoding :: CreateBackup -> Encoding

toJSONList :: [CreateBackup] -> Value

toEncodingList :: [CreateBackup] -> Encoding

NFData CreateBackup

Methods

rnf :: CreateBackup -> ()

AWSRequest CreateBackup

Associated Types

type Rs CreateBackup :: *

Methods

request :: CreateBackup -> Request CreateBackup

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

ToQuery CreateBackup

Methods

toQuery :: CreateBackup -> QueryString

ToPath CreateBackup

Methods

toPath :: CreateBackup -> ByteString

ToHeaders CreateBackup

Methods

toHeaders :: CreateBackup -> [Header]

type Rep CreateBackup

type Rep CreateBackup = D1 (MetaData "CreateBackup" "Network.AWS.OpsWorksCM.CreateBackup" "amazonka-opsworks-cm-1.5.0-Hc1u21y7vMsK8PFWgko0CT" False) (C1 (MetaCons "CreateBackup'" PrefixI True) ((:*:) (S1 (MetaSel (Just Symbol "_cbDescription") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) (S1 (MetaSel (Just Symbol "_cbServerName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text))))

type Rs CreateBackup

type Rs CreateBackup = CreateBackupResponse

Request Lenses

cbDescription :: Lens' CreateBackup (Maybe Text)

A user-defined description of the backup.

cbServerName :: Lens' CreateBackup Text

The name of the server that you want to back up.

Destructuring the Response

createBackupResponse

Arguments

:: Int

cbrsResponseStatus

-> CreateBackupResponse

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

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

• cbrsBackup - Backup created by request.
• cbrsResponseStatus - -- | The response status code.

data CreateBackupResponse

See: createBackupResponse smart constructor.

Instances

Eq CreateBackupResponse

Methods

(==) :: CreateBackupResponse -> CreateBackupResponse -> Bool

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

Data CreateBackupResponse

Methods

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

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

toConstr :: CreateBackupResponse -> Constr

dataTypeOf :: CreateBackupResponse -> DataType

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

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

gmapT :: (forall b. Data b => b -> b) -> CreateBackupResponse -> CreateBackupResponse

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

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

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

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

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

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

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

Read CreateBackupResponse

Methods

readsPrec :: Int -> ReadS CreateBackupResponse

readList :: ReadS [CreateBackupResponse]

readPrec :: ReadPrec CreateBackupResponse

readListPrec :: ReadPrec [CreateBackupResponse]

Show CreateBackupResponse

Methods

showsPrec :: Int -> CreateBackupResponse -> ShowS

show :: CreateBackupResponse -> String

showList :: [CreateBackupResponse] -> ShowS

Generic CreateBackupResponse

Associated Types

type Rep CreateBackupResponse :: * -> *

Methods

from :: CreateBackupResponse -> Rep CreateBackupResponse x

to :: Rep CreateBackupResponse x -> CreateBackupResponse

NFData CreateBackupResponse

Methods

rnf :: CreateBackupResponse -> ()

type Rep CreateBackupResponse

type Rep CreateBackupResponse = D1 (MetaData "CreateBackupResponse" "Network.AWS.OpsWorksCM.CreateBackup" "amazonka-opsworks-cm-1.5.0-Hc1u21y7vMsK8PFWgko0CT" False) (C1 (MetaCons "CreateBackupResponse'" PrefixI True) ((:*:) (S1 (MetaSel (Just Symbol "_cbrsBackup") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Backup))) (S1 (MetaSel (Just Symbol "_cbrsResponseStatus") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Int))))

Response Lenses

cbrsBackup :: Lens' CreateBackupResponse (Maybe Backup)

Backup created by request.

cbrsResponseStatus :: Lens' CreateBackupResponse Int

• - | The response status code.