| 1 | |||
| 2 | package Paws::Backup::CreateBackupPlan; | ||
| 3 | use Moose; | ||
| 4 | has BackupPlan => (is => 'ro', isa => 'Paws::Backup::BackupPlanInput', required => 1); | ||
| 5 | has BackupPlanTags => (is => 'ro', isa => 'Paws::Backup::Tags'); | ||
| 6 | has CreatorRequestId => (is => 'ro', isa => 'Str'); | ||
| 7 | |||
| 8 | use MooseX::ClassAttribute; | ||
| 9 | |||
| 10 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'CreateBackupPlan'); | ||
| 11 | class_has _api_uri => (isa => 'Str', is => 'ro', default => '/backup/plans/'); | ||
| 12 | class_has _api_method => (isa => 'Str', is => 'ro', default => 'PUT'); | ||
| 13 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::Backup::CreateBackupPlanOutput'); | ||
| 14 | 1; | ||
| 15 | |||
| 16 | ### main pod documentation begin ### | ||
| 17 | |||
| 18 | =head1 NAME | ||
| 19 | |||
| 20 | Paws::Backup::CreateBackupPlan - Arguments for method CreateBackupPlan on L<Paws::Backup> | ||
| 21 | |||
| 22 | =head1 DESCRIPTION | ||
| 23 | |||
| 24 | This class represents the parameters used for calling the method CreateBackupPlan on the | ||
| 25 | L<AWS Backup|Paws::Backup> service. Use the attributes of this class | ||
| 26 | as arguments to method CreateBackupPlan. | ||
| 27 | |||
| 28 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to CreateBackupPlan. | ||
| 29 | |||
| 30 | =head1 SYNOPSIS | ||
| 31 | |||
| 32 | my $backup = Paws->service('Backup'); | ||
| 33 | my $CreateBackupPlanOutput = $backup->CreateBackupPlan( | ||
| 34 | BackupPlan => { | ||
| 35 | BackupPlanName => 'MyBackupPlanName', | ||
| 36 | Rules => [ | ||
| 37 | { | ||
| 38 | RuleName => 'MyBackupRuleName', | ||
| 39 | TargetBackupVaultName => 'MyBackupVaultName', | ||
| 40 | CompletionWindowMinutes => 1, # OPTIONAL | ||
| 41 | CopyActions => [ | ||
| 42 | { | ||
| 43 | DestinationBackupVaultArn => 'MyARN', | ||
| 44 | Lifecycle => { | ||
| 45 | DeleteAfterDays => 1, # OPTIONAL | ||
| 46 | MoveToColdStorageAfterDays => 1, # OPTIONAL | ||
| 47 | }, # OPTIONAL | ||
| 48 | }, | ||
| 49 | ... | ||
| 50 | ], # OPTIONAL | ||
| 51 | EnableContinuousBackup => 1, # OPTIONAL | ||
| 52 | Lifecycle => { | ||
| 53 | DeleteAfterDays => 1, # OPTIONAL | ||
| 54 | MoveToColdStorageAfterDays => 1, # OPTIONAL | ||
| 55 | }, # OPTIONAL | ||
| 56 | RecoveryPointTags => { 'MyTagKey' => 'MyTagValue', }, # OPTIONAL | ||
| 57 | ScheduleExpression => 'MyCronExpression', # OPTIONAL | ||
| 58 | StartWindowMinutes => 1, # OPTIONAL | ||
| 59 | }, | ||
| 60 | ... | ||
| 61 | ], | ||
| 62 | AdvancedBackupSettings => [ | ||
| 63 | { | ||
| 64 | BackupOptions => { 'MyBackupOptionKey' => 'MyBackupOptionValue', } | ||
| 65 | , # OPTIONAL | ||
| 66 | ResourceType => 'MyResourceType', # OPTIONAL | ||
| 67 | }, | ||
| 68 | ... | ||
| 69 | ], # OPTIONAL | ||
| 70 | }, | ||
| 71 | BackupPlanTags => { 'MyTagKey' => 'MyTagValue', }, # OPTIONAL | ||
| 72 | CreatorRequestId => 'Mystring', # OPTIONAL | ||
| 73 | ); | ||
| 74 | |||
| 75 | # Results: | ||
| 76 | my $AdvancedBackupSettings = | ||
| 77 | $CreateBackupPlanOutput->AdvancedBackupSettings; | ||
| 78 | my $BackupPlanArn = $CreateBackupPlanOutput->BackupPlanArn; | ||
| 79 | my $BackupPlanId = $CreateBackupPlanOutput->BackupPlanId; | ||
| 80 | my $CreationDate = $CreateBackupPlanOutput->CreationDate; | ||
| 81 | my $VersionId = $CreateBackupPlanOutput->VersionId; | ||
| 82 | |||
| 83 | # Returns a L<Paws::Backup::CreateBackupPlanOutput> object. | ||
| 84 | |||
| 85 | Values for attributes that are native types (Int, String, Float, etc) can passed as-is (scalar values). Values for complex Types (objects) can be passed as a HashRef. The keys and values of the hashref will be used to instance the underlying object. | ||
| 86 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/backup/CreateBackupPlan> | ||
| 87 | |||
| 88 | =head1 ATTRIBUTES | ||
| 89 | |||
| 90 | |||
| 91 | =head2 B<REQUIRED> BackupPlan => L<Paws::Backup::BackupPlanInput> | ||
| 92 | |||
| 93 | Specifies the body of a backup plan. Includes a C<BackupPlanName> and | ||
| 94 | one or more sets of C<Rules>. | ||
| 95 | |||
| 96 | |||
| 97 | |||
| 98 | =head2 BackupPlanTags => L<Paws::Backup::Tags> | ||
| 99 | |||
| 100 | To help organize your resources, you can assign your own metadata to | ||
| 101 | the resources that you create. Each tag is a key-value pair. The | ||
| 102 | specified tags are assigned to all backups created with this plan. | ||
| 103 | |||
| 104 | |||
| 105 | |||
| 106 | =head2 CreatorRequestId => Str | ||
| 107 | |||
| 108 | Identifies the request and allows failed requests to be retried without | ||
| 109 | the risk of running the operation twice. If the request includes a | ||
| 110 | C<CreatorRequestId> that matches an existing backup plan, that plan is | ||
| 111 | returned. This parameter is optional. | ||
| 112 | |||
| 113 | |||
| 114 | |||
| 115 | |||
| 116 | =head1 SEE ALSO | ||
| 117 | |||
| 118 | This class forms part of L<Paws>, documenting arguments for method CreateBackupPlan in L<Paws::Backup> | ||
| 119 | |||
| 120 | =head1 BUGS and CONTRIBUTIONS | ||
| 121 | |||
| 122 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 123 | |||
| 124 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 125 | |||
| 126 | =cut | ||
| 127 |