Copyright	(c) 2013-2021 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay+amazonka@gmail.com>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None

Amazonka.Backup.CreateBackupPlan

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Creates a backup plan using a backup plan name and backup rules. A backup plan is a document that contains information that Backup uses to schedule tasks that create recovery points for resources.

If you call CreateBackupPlan with a plan that already exists, you receive an AlreadyExistsException exception.

Synopsis

data CreateBackupPlan = CreateBackupPlan' {
- backupPlanTags :: Maybe (Sensitive (HashMap Text Text))
- creatorRequestId :: Maybe Text
- backupPlan :: BackupPlanInput
}
newCreateBackupPlan :: BackupPlanInput -> CreateBackupPlan
createBackupPlan_backupPlanTags :: Lens' CreateBackupPlan (Maybe (HashMap Text Text))
createBackupPlan_creatorRequestId :: Lens' CreateBackupPlan (Maybe Text)
createBackupPlan_backupPlan :: Lens' CreateBackupPlan BackupPlanInput
data CreateBackupPlanResponse = CreateBackupPlanResponse' {
- versionId :: Maybe Text
- advancedBackupSettings :: Maybe [AdvancedBackupSetting]
- backupPlanId :: Maybe Text
- backupPlanArn :: Maybe Text
- creationDate :: Maybe POSIX
- httpStatus :: Int
}
newCreateBackupPlanResponse :: Int -> CreateBackupPlanResponse
createBackupPlanResponse_versionId :: Lens' CreateBackupPlanResponse (Maybe Text)
createBackupPlanResponse_advancedBackupSettings :: Lens' CreateBackupPlanResponse (Maybe [AdvancedBackupSetting])
createBackupPlanResponse_backupPlanId :: Lens' CreateBackupPlanResponse (Maybe Text)
createBackupPlanResponse_backupPlanArn :: Lens' CreateBackupPlanResponse (Maybe Text)
createBackupPlanResponse_creationDate :: Lens' CreateBackupPlanResponse (Maybe UTCTime)
createBackupPlanResponse_httpStatus :: Lens' CreateBackupPlanResponse Int

Creating a Request

data CreateBackupPlan Source #

See: newCreateBackupPlan smart constructor.

Constructors

CreateBackupPlan'

Fields

backupPlanTags :: Maybe (Sensitive (HashMap Text Text))
To help organize your resources, you can assign your own metadata to the resources that you create. Each tag is a key-value pair. The specified tags are assigned to all backups created with this plan.
creatorRequestId :: Maybe Text
Identifies the request and allows failed requests to be retried without the risk of running the operation twice. If the request includes a CreatorRequestId that matches an existing backup plan, that plan is returned. This parameter is optional.
backupPlan :: BackupPlanInput
Specifies the body of a backup plan. Includes a BackupPlanName and one or more sets of Rules.

Instances

Instances details

Eq CreateBackupPlan Source #
Instance details Defined in Amazonka.Backup.CreateBackupPlan Methods (==) :: CreateBackupPlan -> CreateBackupPlan -> Bool # (/=) :: CreateBackupPlan -> CreateBackupPlan -> Bool #
Show CreateBackupPlan Source #
Instance details Defined in Amazonka.Backup.CreateBackupPlan Methods showsPrec :: Int -> CreateBackupPlan -> ShowS # show :: CreateBackupPlan -> String # showList :: [CreateBackupPlan] -> ShowS #
Generic CreateBackupPlan Source #
Instance details Defined in Amazonka.Backup.CreateBackupPlan Associated Types type Rep CreateBackupPlan :: Type -> Type # Methods from :: CreateBackupPlan -> Rep CreateBackupPlan x # to :: Rep CreateBackupPlan x -> CreateBackupPlan #
NFData CreateBackupPlan Source #
Instance details Defined in Amazonka.Backup.CreateBackupPlan Methods rnf :: CreateBackupPlan -> () #
Hashable CreateBackupPlan Source #
Instance details Defined in Amazonka.Backup.CreateBackupPlan Methods hashWithSalt :: Int -> CreateBackupPlan -> Int # hash :: CreateBackupPlan -> Int #
ToJSON CreateBackupPlan Source #
Instance details Defined in Amazonka.Backup.CreateBackupPlan Methods toJSON :: CreateBackupPlan -> Value # toEncoding :: CreateBackupPlan -> Encoding # toJSONList :: [CreateBackupPlan] -> Value # toEncodingList :: [CreateBackupPlan] -> Encoding #
AWSRequest CreateBackupPlan Source #
Instance details Defined in Amazonka.Backup.CreateBackupPlan Associated Types type AWSResponse CreateBackupPlan # Methods request :: CreateBackupPlan -> Request CreateBackupPlan # response :: MonadResource m => Logger -> Service -> Proxy CreateBackupPlan -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse CreateBackupPlan))) #
ToHeaders CreateBackupPlan Source #
Instance details Defined in Amazonka.Backup.CreateBackupPlan Methods toHeaders :: CreateBackupPlan -> [Header] #
ToPath CreateBackupPlan Source #
Instance details Defined in Amazonka.Backup.CreateBackupPlan Methods toPath :: CreateBackupPlan -> ByteString #
ToQuery CreateBackupPlan Source #
Instance details Defined in Amazonka.Backup.CreateBackupPlan Methods toQuery :: CreateBackupPlan -> QueryString #
type Rep CreateBackupPlan Source #
Instance details Defined in Amazonka.Backup.CreateBackupPlan type Rep CreateBackupPlan = D1 ('MetaData "CreateBackupPlan" "Amazonka.Backup.CreateBackupPlan" "libZSservicesZSamazonka-backupZSamazonka-backup" 'False) (C1 ('MetaCons "CreateBackupPlan'" 'PrefixI 'True) (S1 ('MetaSel ('Just "backupPlanTags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (Sensitive (HashMap Text Text)))) :: (S1 ('MetaSel ('Just "creatorRequestId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "backupPlan") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 BackupPlanInput))))
type AWSResponse CreateBackupPlan Source #
Instance details Defined in Amazonka.Backup.CreateBackupPlan type AWSResponse CreateBackupPlan = CreateBackupPlanResponse

newCreateBackupPlan Source #

Arguments

:: BackupPlanInput	`$sel:backupPlan:CreateBackupPlan'`
-> CreateBackupPlan

Create a value of CreateBackupPlan 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:backupPlanTags:CreateBackupPlan', createBackupPlan_backupPlanTags - To help organize your resources, you can assign your own metadata to the resources that you create. Each tag is a key-value pair. The specified tags are assigned to all backups created with this plan.

$sel:creatorRequestId:CreateBackupPlan', createBackupPlan_creatorRequestId - Identifies the request and allows failed requests to be retried without the risk of running the operation twice. If the request includes a CreatorRequestId that matches an existing backup plan, that plan is returned. This parameter is optional.

$sel:backupPlan:CreateBackupPlan', createBackupPlan_backupPlan - Specifies the body of a backup plan. Includes a BackupPlanName and one or more sets of Rules.

Request Lenses

createBackupPlan_backupPlanTags :: Lens' CreateBackupPlan (Maybe (HashMap Text Text)) Source #

To help organize your resources, you can assign your own metadata to the resources that you create. Each tag is a key-value pair. The specified tags are assigned to all backups created with this plan.

createBackupPlan_creatorRequestId :: Lens' CreateBackupPlan (Maybe Text) Source #

Identifies the request and allows failed requests to be retried without the risk of running the operation twice. If the request includes a CreatorRequestId that matches an existing backup plan, that plan is returned. This parameter is optional.

createBackupPlan_backupPlan :: Lens' CreateBackupPlan BackupPlanInput Source #

Specifies the body of a backup plan. Includes a BackupPlanName and one or more sets of Rules.

Destructuring the Response

data CreateBackupPlanResponse Source #

See: newCreateBackupPlanResponse smart constructor.

Constructors

CreateBackupPlanResponse'

Fields

versionId :: Maybe Text
Unique, randomly generated, Unicode, UTF-8 encoded strings that are at most 1,024 bytes long. They cannot be edited.
advancedBackupSettings :: Maybe [AdvancedBackupSetting]
A list of BackupOptions settings for a resource type. This option is only available for Windows Volume Shadow Copy Service (VSS) backup jobs.
backupPlanId :: Maybe Text
Uniquely identifies a backup plan.
backupPlanArn :: Maybe Text
An Amazon Resource Name (ARN) that uniquely identifies a backup plan; for example, arn:aws:backup:us-east-1:123456789012:plan:8F81F553-3A74-4A3F-B93D-B3360DC80C50.
creationDate :: Maybe POSIX
The date and time that a backup plan is created, in Unix format and Coordinated Universal Time (UTC). The value of CreationDate is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.
httpStatus :: Int
The response's http status code.

Instances

Instances details

Eq CreateBackupPlanResponse Source #
Instance details Defined in Amazonka.Backup.CreateBackupPlan Methods (==) :: CreateBackupPlanResponse -> CreateBackupPlanResponse -> Bool # (/=) :: CreateBackupPlanResponse -> CreateBackupPlanResponse -> Bool #
Read CreateBackupPlanResponse Source #
Instance details Defined in Amazonka.Backup.CreateBackupPlan Methods readsPrec :: Int -> ReadS CreateBackupPlanResponse # readList :: ReadS [CreateBackupPlanResponse] # readPrec :: ReadPrec CreateBackupPlanResponse # readListPrec :: ReadPrec [CreateBackupPlanResponse] #
Show CreateBackupPlanResponse Source #
Instance details Defined in Amazonka.Backup.CreateBackupPlan Methods showsPrec :: Int -> CreateBackupPlanResponse -> ShowS # show :: CreateBackupPlanResponse -> String # showList :: [CreateBackupPlanResponse] -> ShowS #
Generic CreateBackupPlanResponse Source #
Instance details Defined in Amazonka.Backup.CreateBackupPlan Associated Types type Rep CreateBackupPlanResponse :: Type -> Type # Methods from :: CreateBackupPlanResponse -> Rep CreateBackupPlanResponse x # to :: Rep CreateBackupPlanResponse x -> CreateBackupPlanResponse #
NFData CreateBackupPlanResponse Source #
Instance details Defined in Amazonka.Backup.CreateBackupPlan Methods rnf :: CreateBackupPlanResponse -> () #
type Rep CreateBackupPlanResponse Source #
Instance details Defined in Amazonka.Backup.CreateBackupPlan type Rep CreateBackupPlanResponse = D1 ('MetaData "CreateBackupPlanResponse" "Amazonka.Backup.CreateBackupPlan" "libZSservicesZSamazonka-backupZSamazonka-backup" 'False) (C1 ('MetaCons "CreateBackupPlanResponse'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "versionId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "advancedBackupSettings") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [AdvancedBackupSetting])) :: S1 ('MetaSel ('Just "backupPlanId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :: (S1 ('MetaSel ('Just "backupPlanArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "creationDate") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))))

newCreateBackupPlanResponse Source #

Arguments

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

Create a value of CreateBackupPlanResponse 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:versionId:CreateBackupPlanResponse', createBackupPlanResponse_versionId - Unique, randomly generated, Unicode, UTF-8 encoded strings that are at most 1,024 bytes long. They cannot be edited.

$sel:advancedBackupSettings:CreateBackupPlanResponse', createBackupPlanResponse_advancedBackupSettings - A list of BackupOptions settings for a resource type. This option is only available for Windows Volume Shadow Copy Service (VSS) backup jobs.

$sel:backupPlanId:CreateBackupPlanResponse', createBackupPlanResponse_backupPlanId - Uniquely identifies a backup plan.

$sel:backupPlanArn:CreateBackupPlanResponse', createBackupPlanResponse_backupPlanArn - An Amazon Resource Name (ARN) that uniquely identifies a backup plan; for example, arn:aws:backup:us-east-1:123456789012:plan:8F81F553-3A74-4A3F-B93D-B3360DC80C50.

$sel:creationDate:CreateBackupPlanResponse', createBackupPlanResponse_creationDate - The date and time that a backup plan is created, in Unix format and Coordinated Universal Time (UTC). The value of CreationDate is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.

$sel:httpStatus:CreateBackupPlanResponse', createBackupPlanResponse_httpStatus - The response's http status code.

Response Lenses

createBackupPlanResponse_versionId :: Lens' CreateBackupPlanResponse (Maybe Text) Source #

Unique, randomly generated, Unicode, UTF-8 encoded strings that are at most 1,024 bytes long. They cannot be edited.

createBackupPlanResponse_advancedBackupSettings :: Lens' CreateBackupPlanResponse (Maybe [AdvancedBackupSetting]) Source #

A list of BackupOptions settings for a resource type. This option is only available for Windows Volume Shadow Copy Service (VSS) backup jobs.

createBackupPlanResponse_backupPlanId :: Lens' CreateBackupPlanResponse (Maybe Text) Source #

Uniquely identifies a backup plan.

createBackupPlanResponse_backupPlanArn :: Lens' CreateBackupPlanResponse (Maybe Text) Source #

An Amazon Resource Name (ARN) that uniquely identifies a backup plan; for example, arn:aws:backup:us-east-1:123456789012:plan:8F81F553-3A74-4A3F-B93D-B3360DC80C50.

createBackupPlanResponse_creationDate :: Lens' CreateBackupPlanResponse (Maybe UTCTime) Source #

The date and time that a backup plan is created, in Unix format and Coordinated Universal Time (UTC). The value of CreationDate is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.

createBackupPlanResponse_httpStatus :: Lens' CreateBackupPlanResponse Int Source #

The response's http status code.