« blib/lib/Paws/Backup/StartBackupJobOutput.pm
↑ Summary
blib/lib/Paws/Backup/StartCopyJobOutput.pm »
| 1 | |||
| 2 | package Paws::Backup::StartCopyJob; | ||
| 3 | use Moose; | ||
| 4 | has DestinationBackupVaultArn => (is => 'ro', isa => 'Str', required => 1); | ||
| 5 | has IamRoleArn => (is => 'ro', isa => 'Str', required => 1); | ||
| 6 | has IdempotencyToken => (is => 'ro', isa => 'Str'); | ||
| 7 | has Lifecycle => (is => 'ro', isa => 'Paws::Backup::Lifecycle'); | ||
| 8 | has RecoveryPointArn => (is => 'ro', isa => 'Str', required => 1); | ||
| 9 | has SourceBackupVaultName => (is => 'ro', isa => 'Str', required => 1); | ||
| 10 | |||
| 11 | use MooseX::ClassAttribute; | ||
| 12 | |||
| 13 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'StartCopyJob'); | ||
| 14 | class_has _api_uri => (isa => 'Str', is => 'ro', default => '/copy-jobs'); | ||
| 15 | class_has _api_method => (isa => 'Str', is => 'ro', default => 'PUT'); | ||
| 16 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::Backup::StartCopyJobOutput'); | ||
| 17 | 1; | ||
| 18 | |||
| 19 | ### main pod documentation begin ### | ||
| 20 | |||
| 21 | =head1 NAME | ||
| 22 | |||
| 23 | Paws::Backup::StartCopyJob - Arguments for method StartCopyJob on L<Paws::Backup> | ||
| 24 | |||
| 25 | =head1 DESCRIPTION | ||
| 26 | |||
| 27 | This class represents the parameters used for calling the method StartCopyJob on the | ||
| 28 | L<AWS Backup|Paws::Backup> service. Use the attributes of this class | ||
| 29 | as arguments to method StartCopyJob. | ||
| 30 | |||
| 31 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to StartCopyJob. | ||
| 32 | |||
| 33 | =head1 SYNOPSIS | ||
| 34 | |||
| 35 | my $backup = Paws->service('Backup'); | ||
| 36 | my $StartCopyJobOutput = $backup->StartCopyJob( | ||
| 37 | DestinationBackupVaultArn => 'MyARN', | ||
| 38 | IamRoleArn => 'MyIAMRoleArn', | ||
| 39 | RecoveryPointArn => 'MyARN', | ||
| 40 | SourceBackupVaultName => 'MyBackupVaultName', | ||
| 41 | IdempotencyToken => 'Mystring', # OPTIONAL | ||
| 42 | Lifecycle => { | ||
| 43 | DeleteAfterDays => 1, # OPTIONAL | ||
| 44 | MoveToColdStorageAfterDays => 1, # OPTIONAL | ||
| 45 | }, # OPTIONAL | ||
| 46 | ); | ||
| 47 | |||
| 48 | # Results: | ||
| 49 | my $CopyJobId = $StartCopyJobOutput->CopyJobId; | ||
| 50 | my $CreationDate = $StartCopyJobOutput->CreationDate; | ||
| 51 | |||
| 52 | # Returns a L<Paws::Backup::StartCopyJobOutput> object. | ||
| 53 | |||
| 54 | 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. | ||
| 55 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/backup/StartCopyJob> | ||
| 56 | |||
| 57 | =head1 ATTRIBUTES | ||
| 58 | |||
| 59 | |||
| 60 | =head2 B<REQUIRED> DestinationBackupVaultArn => Str | ||
| 61 | |||
| 62 | An Amazon Resource Name (ARN) that uniquely identifies a destination | ||
| 63 | backup vault to copy to; for example, | ||
| 64 | C<arn:aws:backup:us-east-1:123456789012:vault:aBackupVault>. | ||
| 65 | |||
| 66 | |||
| 67 | |||
| 68 | =head2 B<REQUIRED> IamRoleArn => Str | ||
| 69 | |||
| 70 | Specifies the IAM role ARN used to copy the target recovery point; for | ||
| 71 | example, C<arn:aws:iam::123456789012:role/S3Access>. | ||
| 72 | |||
| 73 | |||
| 74 | |||
| 75 | =head2 IdempotencyToken => Str | ||
| 76 | |||
| 77 | A customer chosen string that can be used to distinguish between calls | ||
| 78 | to C<StartCopyJob>. | ||
| 79 | |||
| 80 | |||
| 81 | |||
| 82 | =head2 Lifecycle => L<Paws::Backup::Lifecycle> | ||
| 83 | |||
| 84 | |||
| 85 | |||
| 86 | |||
| 87 | |||
| 88 | =head2 B<REQUIRED> RecoveryPointArn => Str | ||
| 89 | |||
| 90 | An ARN that uniquely identifies a recovery point to use for the copy | ||
| 91 | job; for example, | ||
| 92 | arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45. | ||
| 93 | |||
| 94 | |||
| 95 | |||
| 96 | =head2 B<REQUIRED> SourceBackupVaultName => Str | ||
| 97 | |||
| 98 | The name of a logical source container where backups are stored. Backup | ||
| 99 | vaults are identified by names that are unique to the account used to | ||
| 100 | create them and the AWS Region where they are created. They consist of | ||
| 101 | lowercase letters, numbers, and hyphens. | ||
| 102 | |||
| 103 | |||
| 104 | |||
| 105 | |||
| 106 | =head1 SEE ALSO | ||
| 107 | |||
| 108 | This class forms part of L<Paws>, documenting arguments for method StartCopyJob in L<Paws::Backup> | ||
| 109 | |||
| 110 | =head1 BUGS and CONTRIBUTIONS | ||
| 111 | |||
| 112 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 113 | |||
| 114 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 115 | |||
| 116 | =cut | ||
| 117 |