| 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.Backup.CreateBackupPlan
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' {}
- 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' {}
- newCreateBackupPlanResponse :: Int -> CreateBackupPlanResponse
- createBackupPlanResponse_advancedBackupSettings :: Lens' CreateBackupPlanResponse (Maybe [AdvancedBackupSetting])
- createBackupPlanResponse_backupPlanArn :: Lens' CreateBackupPlanResponse (Maybe Text)
- createBackupPlanResponse_backupPlanId :: Lens' CreateBackupPlanResponse (Maybe Text)
- createBackupPlanResponse_creationDate :: Lens' CreateBackupPlanResponse (Maybe UTCTime)
- createBackupPlanResponse_versionId :: Lens' CreateBackupPlanResponse (Maybe Text)
- createBackupPlanResponse_httpStatus :: Lens' CreateBackupPlanResponse Int
Creating a Request
data CreateBackupPlan Source #
See: newCreateBackupPlan smart constructor.
Constructors
| CreateBackupPlan' | |
Fields
| |
Instances
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.
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.
If used, this parameter must contain 1 to 50 alphanumeric or '-_.' characters.
$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.
If used, this parameter must contain 1 to 50 alphanumeric or '-_.' characters.
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
| |
Instances
newCreateBackupPlanResponse Source #
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:
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.
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.
CreateBackupPlanResponse, createBackupPlanResponse_backupPlanId - Uniquely identifies a backup plan.
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.
CreateBackupPlanResponse, createBackupPlanResponse_versionId - Unique, randomly generated, Unicode, UTF-8 encoded strings that are at
most 1,024 bytes long. They cannot be edited.
$sel:httpStatus:CreateBackupPlanResponse', createBackupPlanResponse_httpStatus - The response's http status code.
Response Lenses
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_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_backupPlanId :: Lens' CreateBackupPlanResponse (Maybe Text) Source #
Uniquely identifies a backup plan.
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_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_httpStatus :: Lens' CreateBackupPlanResponse Int Source #
The response's http status code.