Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

Amazonka.OpsWorksCM.CreateBackup

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

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.

Synopsis

Creating a Request

data CreateBackup Source #

See: newCreateBackup smart constructor.

Constructors

CreateBackup'

Fields

description :: Maybe Text
A user-defined description of the backup.
tags :: Maybe [Tag]
A map that contains tag keys and tag values to attach to an AWS OpsWorks-CM server backup.
- The key cannot be empty.
- The key can be a maximum of 127 characters, and can contain only Unicode letters, numbers, or separators, or the following special characters: + - = . _ : /
- The value can be a maximum 255 characters, and contain only Unicode letters, numbers, or separators, or the following special characters: + - = . _ : /
- Leading and trailing white spaces are trimmed from both the key and value.
- A maximum of 50 user-applied tags is allowed for tag-supported AWS OpsWorks-CM resources.
serverName :: Text
The name of the server that you want to back up.

Instances

Instances details

ToJSON CreateBackup Source #
Instance details Defined in Amazonka.OpsWorksCM.CreateBackup Methods toJSON :: CreateBackup -> Value # toEncoding :: CreateBackup -> Encoding # toJSONList :: [CreateBackup] -> Value # toEncodingList :: [CreateBackup] -> Encoding #
ToHeaders CreateBackup Source #
Instance details Defined in Amazonka.OpsWorksCM.CreateBackup Methods toHeaders :: CreateBackup -> [Header] #
ToPath CreateBackup Source #
Instance details Defined in Amazonka.OpsWorksCM.CreateBackup Methods toPath :: CreateBackup -> ByteString #
ToQuery CreateBackup Source #
Instance details Defined in Amazonka.OpsWorksCM.CreateBackup Methods toQuery :: CreateBackup -> QueryString #
AWSRequest CreateBackup Source #
Instance details Defined in Amazonka.OpsWorksCM.CreateBackup Associated Types type AWSResponse CreateBackup # Methods request :: (Service -> Service) -> CreateBackup -> Request CreateBackup # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy CreateBackup -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse CreateBackup))) #
Generic CreateBackup Source #
Instance details Defined in Amazonka.OpsWorksCM.CreateBackup Associated Types type Rep CreateBackup :: Type -> Type # Methods from :: CreateBackup -> Rep CreateBackup x # to :: Rep CreateBackup x -> CreateBackup #
Read CreateBackup Source #
Instance details Defined in Amazonka.OpsWorksCM.CreateBackup Methods readsPrec :: Int -> ReadS CreateBackup # readList :: ReadS [CreateBackup] # readPrec :: ReadPrec CreateBackup # readListPrec :: ReadPrec [CreateBackup] #
Show CreateBackup Source #
Instance details Defined in Amazonka.OpsWorksCM.CreateBackup Methods showsPrec :: Int -> CreateBackup -> ShowS # show :: CreateBackup -> String # showList :: [CreateBackup] -> ShowS #
NFData CreateBackup Source #
Instance details Defined in Amazonka.OpsWorksCM.CreateBackup Methods rnf :: CreateBackup -> () #
Eq CreateBackup Source #
Instance details Defined in Amazonka.OpsWorksCM.CreateBackup Methods (==) :: CreateBackup -> CreateBackup -> Bool # (/=) :: CreateBackup -> CreateBackup -> Bool #
Hashable CreateBackup Source #
Instance details Defined in Amazonka.OpsWorksCM.CreateBackup Methods hashWithSalt :: Int -> CreateBackup -> Int # hash :: CreateBackup -> Int #
type AWSResponse CreateBackup Source #
Instance details Defined in Amazonka.OpsWorksCM.CreateBackup type AWSResponse CreateBackup = CreateBackupResponse
type Rep CreateBackup Source #
Instance details Defined in Amazonka.OpsWorksCM.CreateBackup type Rep CreateBackup = D1 ('MetaData "CreateBackup" "Amazonka.OpsWorksCM.CreateBackup" "amazonka-opsworks-cm-2.0-4eRKS676FdFBzYMnhnI9o" 'False) (C1 ('MetaCons "CreateBackup'" 'PrefixI 'True) (S1 ('MetaSel ('Just "description") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Tag])) :: S1 ('MetaSel ('Just "serverName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))

newCreateBackup Source #

Arguments

:: Text	`CreateBackup`
-> CreateBackup

Create a value of CreateBackup with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

CreateBackup, createBackup_description - A user-defined description of the backup.

$sel:tags:CreateBackup', createBackup_tags - A map that contains tag keys and tag values to attach to an AWS OpsWorks-CM server backup.

The key cannot be empty.
The key can be a maximum of 127 characters, and can contain only Unicode letters, numbers, or separators, or the following special characters: + - = . _ : /
The value can be a maximum 255 characters, and contain only Unicode letters, numbers, or separators, or the following special characters: + - = . _ : /
Leading and trailing white spaces are trimmed from both the key and value.
A maximum of 50 user-applied tags is allowed for tag-supported AWS OpsWorks-CM resources.

CreateBackup, createBackup_serverName - The name of the server that you want to back up.

Request Lenses

createBackup_description :: Lens' CreateBackup (Maybe Text) Source #

A user-defined description of the backup.

createBackup_tags :: Lens' CreateBackup (Maybe [Tag]) Source #

A map that contains tag keys and tag values to attach to an AWS OpsWorks-CM server backup.

The key cannot be empty.
The key can be a maximum of 127 characters, and can contain only Unicode letters, numbers, or separators, or the following special characters: + - = . _ : /
The value can be a maximum 255 characters, and contain only Unicode letters, numbers, or separators, or the following special characters: + - = . _ : /
Leading and trailing white spaces are trimmed from both the key and value.
A maximum of 50 user-applied tags is allowed for tag-supported AWS OpsWorks-CM resources.

createBackup_serverName :: Lens' CreateBackup Text Source #

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

Destructuring the Response

data CreateBackupResponse Source #

See: newCreateBackupResponse smart constructor.

Constructors

CreateBackupResponse'
Fields backup :: Maybe Backup Backup created by request. httpStatus :: Int The response's http status code.

Instances

Instances details

Generic CreateBackupResponse Source #
Instance details Defined in Amazonka.OpsWorksCM.CreateBackup Associated Types type Rep CreateBackupResponse :: Type -> Type # Methods from :: CreateBackupResponse -> Rep CreateBackupResponse x # to :: Rep CreateBackupResponse x -> CreateBackupResponse #
Read CreateBackupResponse Source #
Instance details Defined in Amazonka.OpsWorksCM.CreateBackup Methods readsPrec :: Int -> ReadS CreateBackupResponse # readList :: ReadS [CreateBackupResponse] # readPrec :: ReadPrec CreateBackupResponse # readListPrec :: ReadPrec [CreateBackupResponse] #
Show CreateBackupResponse Source #
Instance details Defined in Amazonka.OpsWorksCM.CreateBackup Methods showsPrec :: Int -> CreateBackupResponse -> ShowS # show :: CreateBackupResponse -> String # showList :: [CreateBackupResponse] -> ShowS #
NFData CreateBackupResponse Source #
Instance details Defined in Amazonka.OpsWorksCM.CreateBackup Methods rnf :: CreateBackupResponse -> () #
Eq CreateBackupResponse Source #
Instance details Defined in Amazonka.OpsWorksCM.CreateBackup Methods (==) :: CreateBackupResponse -> CreateBackupResponse -> Bool # (/=) :: CreateBackupResponse -> CreateBackupResponse -> Bool #
type Rep CreateBackupResponse Source #
Instance details Defined in Amazonka.OpsWorksCM.CreateBackup type Rep CreateBackupResponse = D1 ('MetaData "CreateBackupResponse" "Amazonka.OpsWorksCM.CreateBackup" "amazonka-opsworks-cm-2.0-4eRKS676FdFBzYMnhnI9o" 'False) (C1 ('MetaCons "CreateBackupResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "backup") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Backup)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newCreateBackupResponse Source #

Arguments

:: Int	`$sel:httpStatus:CreateBackupResponse'`
-> CreateBackupResponse

Create a value of CreateBackupResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:backup:CreateBackupResponse', createBackupResponse_backup - Backup created by request.

$sel:httpStatus:CreateBackupResponse', createBackupResponse_httpStatus - The response's http status code.

Response Lenses

createBackupResponse_backup :: Lens' CreateBackupResponse (Maybe Backup) Source #

Backup created by request.

createBackupResponse_httpStatus :: Lens' CreateBackupResponse Int Source #

The response's http status code.