« blib/lib/Paws/RDS/ModifyDBSnapshot.pm
↑ Summary
blib/lib/Paws/RDS/ModifyDBSnapshotAttributeResult.pm »
| 1 | |||
| 2 | package Paws::RDS::ModifyDBSnapshotAttribute; | ||
| 3 | use Moose; | ||
| 4 | has AttributeName => (is => 'ro', isa => 'Str', required => 1); | ||
| 5 | has DBSnapshotIdentifier => (is => 'ro', isa => 'Str', required => 1); | ||
| 6 | has ValuesToAdd => (is => 'ro', isa => 'ArrayRef[Str|Undef]'); | ||
| 7 | has ValuesToRemove => (is => 'ro', isa => 'ArrayRef[Str|Undef]'); | ||
| 8 | |||
| 9 | use MooseX::ClassAttribute; | ||
| 10 | |||
| 11 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'ModifyDBSnapshotAttribute'); | ||
| 12 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::RDS::ModifyDBSnapshotAttributeResult'); | ||
| 13 | class_has _result_key => (isa => 'Str', is => 'ro', default => 'ModifyDBSnapshotAttributeResult'); | ||
| 14 | 1; | ||
| 15 | |||
| 16 | ### main pod documentation begin ### | ||
| 17 | |||
| 18 | =head1 NAME | ||
| 19 | |||
| 20 | Paws::RDS::ModifyDBSnapshotAttribute - Arguments for method ModifyDBSnapshotAttribute on L<Paws::RDS> | ||
| 21 | |||
| 22 | =head1 DESCRIPTION | ||
| 23 | |||
| 24 | This class represents the parameters used for calling the method ModifyDBSnapshotAttribute on the | ||
| 25 | L<Amazon Relational Database Service|Paws::RDS> service. Use the attributes of this class | ||
| 26 | as arguments to method ModifyDBSnapshotAttribute. | ||
| 27 | |||
| 28 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to ModifyDBSnapshotAttribute. | ||
| 29 | |||
| 30 | =head1 SYNOPSIS | ||
| 31 | |||
| 32 | my $rds = Paws->service('RDS'); | ||
| 33 | # To change DB snapshot attributes | ||
| 34 | # This example adds the specified attribute for the specified DB snapshot. | ||
| 35 | my $ModifyDBSnapshotAttributeResult = $rds->ModifyDBSnapshotAttribute( | ||
| 36 | 'AttributeName' => 'restore', | ||
| 37 | 'DBSnapshotIdentifier' => 'mydbsnapshot', | ||
| 38 | 'ValuesToAdd' => ['all'] | ||
| 39 | ); | ||
| 40 | |||
| 41 | # Results: | ||
| 42 | my $DBSnapshotAttributesResult = | ||
| 43 | $ModifyDBSnapshotAttributeResult->DBSnapshotAttributesResult; | ||
| 44 | |||
| 45 | # Returns a L<Paws::RDS::ModifyDBSnapshotAttributeResult> object. | ||
| 46 | |||
| 47 | 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. | ||
| 48 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/rds/ModifyDBSnapshotAttribute> | ||
| 49 | |||
| 50 | =head1 ATTRIBUTES | ||
| 51 | |||
| 52 | |||
| 53 | =head2 B<REQUIRED> AttributeName => Str | ||
| 54 | |||
| 55 | The name of the DB snapshot attribute to modify. | ||
| 56 | |||
| 57 | To manage authorization for other Amazon Web Services accounts to copy | ||
| 58 | or restore a manual DB snapshot, set this value to C<restore>. | ||
| 59 | |||
| 60 | To view the list of attributes available to modify, use the | ||
| 61 | DescribeDBSnapshotAttributes API action. | ||
| 62 | |||
| 63 | |||
| 64 | |||
| 65 | =head2 B<REQUIRED> DBSnapshotIdentifier => Str | ||
| 66 | |||
| 67 | The identifier for the DB snapshot to modify the attributes for. | ||
| 68 | |||
| 69 | |||
| 70 | |||
| 71 | =head2 ValuesToAdd => ArrayRef[Str|Undef] | ||
| 72 | |||
| 73 | A list of DB snapshot attributes to add to the attribute specified by | ||
| 74 | C<AttributeName>. | ||
| 75 | |||
| 76 | To authorize other Amazon Web Services accounts to copy or restore a | ||
| 77 | manual snapshot, set this list to include one or more Amazon Web | ||
| 78 | Services account IDs, or C<all> to make the manual DB snapshot | ||
| 79 | restorable by any Amazon Web Services account. Do not add the C<all> | ||
| 80 | value for any manual DB snapshots that contain private information that | ||
| 81 | you don't want available to all Amazon Web Services accounts. | ||
| 82 | |||
| 83 | |||
| 84 | |||
| 85 | =head2 ValuesToRemove => ArrayRef[Str|Undef] | ||
| 86 | |||
| 87 | A list of DB snapshot attributes to remove from the attribute specified | ||
| 88 | by C<AttributeName>. | ||
| 89 | |||
| 90 | To remove authorization for other Amazon Web Services accounts to copy | ||
| 91 | or restore a manual snapshot, set this list to include one or more | ||
| 92 | Amazon Web Services account identifiers, or C<all> to remove | ||
| 93 | authorization for any Amazon Web Services account to copy or restore | ||
| 94 | the DB snapshot. If you specify C<all>, an Amazon Web Services account | ||
| 95 | whose account ID is explicitly added to the C<restore> attribute can | ||
| 96 | still copy or restore the manual DB snapshot. | ||
| 97 | |||
| 98 | |||
| 99 | |||
| 100 | |||
| 101 | =head1 SEE ALSO | ||
| 102 | |||
| 103 | This class forms part of L<Paws>, documenting arguments for method ModifyDBSnapshotAttribute in L<Paws::RDS> | ||
| 104 | |||
| 105 | =head1 BUGS and CONTRIBUTIONS | ||
| 106 | |||
| 107 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 108 | |||
| 109 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 110 | |||
| 111 | =cut | ||
| 112 |