« blib/lib/Paws/S3/CopyPartResult.pm
↑ Summary
blib/lib/Paws/S3/DeleteBucketAnalyticsConfiguration.pm »
| 1 | # Generated by default/object.tt | ||
| 2 | package Paws::S3::DefaultRetention; | ||
| 3 | use Moose; | ||
| 4 | has Days => (is => 'ro', isa => 'Int'); | ||
| 5 | has Mode => (is => 'ro', isa => 'Str'); | ||
| 6 | has Years => (is => 'ro', isa => 'Int'); | ||
| 7 | |||
| 8 | 1; | ||
| 9 | |||
| 10 | ### main pod documentation begin ### | ||
| 11 | |||
| 12 | =head1 NAME | ||
| 13 | |||
| 14 | Paws::S3::DefaultRetention | ||
| 15 | |||
| 16 | =head1 USAGE | ||
| 17 | |||
| 18 | This class represents one of two things: | ||
| 19 | |||
| 20 | =head3 Arguments in a call to a service | ||
| 21 | |||
| 22 | Use the attributes of this class as arguments to methods. You shouldn't make instances of this class. | ||
| 23 | Each attribute should be used as a named argument in the calls that expect this type of object. | ||
| 24 | |||
| 25 | As an example, if Att1 is expected to be a Paws::S3::DefaultRetention object: | ||
| 26 | |||
| 27 | $service_obj->Method(Att1 => { Days => $value, ..., Years => $value }); | ||
| 28 | |||
| 29 | =head3 Results returned from an API call | ||
| 30 | |||
| 31 | Use accessors for each attribute. If Att1 is expected to be an Paws::S3::DefaultRetention object: | ||
| 32 | |||
| 33 | $result = $service_obj->Method(...); | ||
| 34 | $result->Att1->Days | ||
| 35 | |||
| 36 | =head1 DESCRIPTION | ||
| 37 | |||
| 38 | The container element for specifying the default Object Lock retention | ||
| 39 | settings for new objects placed in the specified bucket. | ||
| 40 | |||
| 41 | =over | ||
| 42 | |||
| 43 | =item * | ||
| 44 | |||
| 45 | The C<DefaultRetention> settings require both a mode and a period. | ||
| 46 | |||
| 47 | =item * | ||
| 48 | |||
| 49 | The C<DefaultRetention> period can be either C<Days> or C<Years> but | ||
| 50 | you must select one. You cannot specify C<Days> and C<Years> at the | ||
| 51 | same time. | ||
| 52 | |||
| 53 | =back | ||
| 54 | |||
| 55 | |||
| 56 | =head1 ATTRIBUTES | ||
| 57 | |||
| 58 | |||
| 59 | =head2 Days => Int | ||
| 60 | |||
| 61 | The number of days that you want to specify for the default retention | ||
| 62 | period. Must be used with C<Mode>. | ||
| 63 | |||
| 64 | |||
| 65 | =head2 Mode => Str | ||
| 66 | |||
| 67 | The default Object Lock retention mode you want to apply to new objects | ||
| 68 | placed in the specified bucket. Must be used with either C<Days> or | ||
| 69 | C<Years>. | ||
| 70 | |||
| 71 | |||
| 72 | =head2 Years => Int | ||
| 73 | |||
| 74 | The number of years that you want to specify for the default retention | ||
| 75 | period. Must be used with C<Mode>. | ||
| 76 | |||
| 77 | |||
| 78 | |||
| 79 | =head1 SEE ALSO | ||
| 80 | |||
| 81 | This class forms part of L<Paws>, describing an object used in L<Paws::S3> | ||
| 82 | |||
| 83 | =head1 BUGS and CONTRIBUTIONS | ||
| 84 | |||
| 85 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 86 | |||
| 87 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 88 | |||
| 89 | =cut | ||
| 90 |