« blib/lib/Paws/Backup/PutBackupVaultAccessPolicy.pm
↑ Summary
blib/lib/Paws/Backup/RecoveryPointByBackupVault.pm »
| 1 | |||
| 2 | package Paws::Backup::PutBackupVaultNotifications; | ||
| 3 | use Moose; | ||
| 4 | has BackupVaultEvents => (is => 'ro', isa => 'ArrayRef[Str|Undef]', required => 1); | ||
| 5 | has BackupVaultName => (is => 'ro', isa => 'Str', traits => ['ParamInURI'], uri_name => 'backupVaultName', required => 1); | ||
| 6 | has SNSTopicArn => (is => 'ro', isa => 'Str', required => 1); | ||
| 7 | |||
| 8 | use MooseX::ClassAttribute; | ||
| 9 | |||
| 10 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'PutBackupVaultNotifications'); | ||
| 11 | class_has _api_uri => (isa => 'Str', is => 'ro', default => '/backup-vaults/{backupVaultName}/notification-configuration'); | ||
| 12 | class_has _api_method => (isa => 'Str', is => 'ro', default => 'PUT'); | ||
| 13 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::API::Response'); | ||
| 14 | 1; | ||
| 15 | |||
| 16 | ### main pod documentation begin ### | ||
| 17 | |||
| 18 | =head1 NAME | ||
| 19 | |||
| 20 | Paws::Backup::PutBackupVaultNotifications - Arguments for method PutBackupVaultNotifications on L<Paws::Backup> | ||
| 21 | |||
| 22 | =head1 DESCRIPTION | ||
| 23 | |||
| 24 | This class represents the parameters used for calling the method PutBackupVaultNotifications on the | ||
| 25 | L<AWS Backup|Paws::Backup> service. Use the attributes of this class | ||
| 26 | as arguments to method PutBackupVaultNotifications. | ||
| 27 | |||
| 28 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to PutBackupVaultNotifications. | ||
| 29 | |||
| 30 | =head1 SYNOPSIS | ||
| 31 | |||
| 32 | my $backup = Paws->service('Backup'); | ||
| 33 | $backup->PutBackupVaultNotifications( | ||
| 34 | BackupVaultEvents => [ | ||
| 35 | 'BACKUP_JOB_STARTED', | ||
| 36 | ... # values: BACKUP_JOB_STARTED, BACKUP_JOB_COMPLETED, BACKUP_JOB_SUCCESSFUL, BACKUP_JOB_FAILED, BACKUP_JOB_EXPIRED, RESTORE_JOB_STARTED, RESTORE_JOB_COMPLETED, RESTORE_JOB_SUCCESSFUL, RESTORE_JOB_FAILED, COPY_JOB_STARTED, COPY_JOB_SUCCESSFUL, COPY_JOB_FAILED, RECOVERY_POINT_MODIFIED, BACKUP_PLAN_CREATED, BACKUP_PLAN_MODIFIED | ||
| 37 | ], | ||
| 38 | BackupVaultName => 'MyBackupVaultName', | ||
| 39 | SNSTopicArn => 'MyARN', | ||
| 40 | |||
| 41 | ); | ||
| 42 | |||
| 43 | 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. | ||
| 44 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/backup/PutBackupVaultNotifications> | ||
| 45 | |||
| 46 | =head1 ATTRIBUTES | ||
| 47 | |||
| 48 | |||
| 49 | =head2 B<REQUIRED> BackupVaultEvents => ArrayRef[Str|Undef] | ||
| 50 | |||
| 51 | An array of events that indicate the status of jobs to back up | ||
| 52 | resources to the backup vault. | ||
| 53 | |||
| 54 | |||
| 55 | |||
| 56 | =head2 B<REQUIRED> BackupVaultName => Str | ||
| 57 | |||
| 58 | The name of a logical container where backups are stored. Backup vaults | ||
| 59 | are identified by names that are unique to the account used to create | ||
| 60 | them and the AWS Region where they are created. They consist of | ||
| 61 | lowercase letters, numbers, and hyphens. | ||
| 62 | |||
| 63 | |||
| 64 | |||
| 65 | =head2 B<REQUIRED> SNSTopicArn => Str | ||
| 66 | |||
| 67 | The Amazon Resource Name (ARN) that specifies the topic for a backup | ||
| 68 | vaultE<rsquo>s events; for example, | ||
| 69 | C<arn:aws:sns:us-west-2:111122223333:MyVaultTopic>. | ||
| 70 | |||
| 71 | |||
| 72 | |||
| 73 | |||
| 74 | =head1 SEE ALSO | ||
| 75 | |||
| 76 | This class forms part of L<Paws>, documenting arguments for method PutBackupVaultNotifications in L<Paws::Backup> | ||
| 77 | |||
| 78 | =head1 BUGS and CONTRIBUTIONS | ||
| 79 | |||
| 80 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 81 | |||
| 82 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 83 | |||
| 84 | =cut | ||
| 85 |