| 1 | # Generated by default/object.tt | ||
| 2 | package Paws::ACMPCA::Validity; | ||
| 3 | use Moose; | ||
| 4 | has Type => (is => 'ro', isa => 'Str', required => 1); | ||
| 5 | has Value => (is => 'ro', isa => 'Int', required => 1); | ||
| 6 | |||
| 7 | 1; | ||
| 8 | |||
| 9 | ### main pod documentation begin ### | ||
| 10 | |||
| 11 | =head1 NAME | ||
| 12 | |||
| 13 | Paws::ACMPCA::Validity | ||
| 14 | |||
| 15 | =head1 USAGE | ||
| 16 | |||
| 17 | This class represents one of two things: | ||
| 18 | |||
| 19 | =head3 Arguments in a call to a service | ||
| 20 | |||
| 21 | Use the attributes of this class as arguments to methods. You shouldn't make instances of this class. | ||
| 22 | Each attribute should be used as a named argument in the calls that expect this type of object. | ||
| 23 | |||
| 24 | As an example, if Att1 is expected to be a Paws::ACMPCA::Validity object: | ||
| 25 | |||
| 26 | $service_obj->Method(Att1 => { Type => $value, ..., Value => $value }); | ||
| 27 | |||
| 28 | =head3 Results returned from an API call | ||
| 29 | |||
| 30 | Use accessors for each attribute. If Att1 is expected to be an Paws::ACMPCA::Validity object: | ||
| 31 | |||
| 32 | $result = $service_obj->Method(...); | ||
| 33 | $result->Att1->Type | ||
| 34 | |||
| 35 | =head1 DESCRIPTION | ||
| 36 | |||
| 37 | Validity specifies the period of time during which a certificate is | ||
| 38 | valid. Validity can be expressed as an explicit date and time when the | ||
| 39 | validity of a certificate starts or expires, or as a span of time after | ||
| 40 | issuance, stated in days, months, or years. For more information, see | ||
| 41 | Validity (https://tools.ietf.org/html/rfc5280#section-4.1.2.5) in RFC | ||
| 42 | 5280. | ||
| 43 | |||
| 44 | ACM Private CA API consumes the C<Validity> data type differently in | ||
| 45 | two distinct parameters of the C<IssueCertificate> action. The required | ||
| 46 | parameter C<IssueCertificate>:C<Validity> specifies the end of a | ||
| 47 | certificate's validity period. The optional parameter | ||
| 48 | C<IssueCertificate>:C<ValidityNotBefore> specifies a customized | ||
| 49 | starting time for the validity period. | ||
| 50 | |||
| 51 | =head1 ATTRIBUTES | ||
| 52 | |||
| 53 | |||
| 54 | =head2 B<REQUIRED> Type => Str | ||
| 55 | |||
| 56 | Determines how I<ACM Private CA> interprets the C<Value> parameter, an | ||
| 57 | integer. Supported validity types include those listed below. Type | ||
| 58 | definitions with values include a sample input value and the resulting | ||
| 59 | output. | ||
| 60 | |||
| 61 | C<END_DATE>: The specific date and time when the certificate will | ||
| 62 | expire, expressed using UTCTime (YYMMDDHHMMSS) or GeneralizedTime | ||
| 63 | (YYYYMMDDHHMMSS) format. When UTCTime is used, if the year field (YY) | ||
| 64 | is greater than or equal to 50, the year is interpreted as 19YY. If the | ||
| 65 | year field is less than 50, the year is interpreted as 20YY. | ||
| 66 | |||
| 67 | =over | ||
| 68 | |||
| 69 | =item * | ||
| 70 | |||
| 71 | Sample input value: 491231235959 (UTCTime format) | ||
| 72 | |||
| 73 | =item * | ||
| 74 | |||
| 75 | Output expiration date/time: 12/31/2049 23:59:59 | ||
| 76 | |||
| 77 | =back | ||
| 78 | |||
| 79 | C<ABSOLUTE>: The specific date and time when the validity of a | ||
| 80 | certificate will start or expire, expressed in seconds since the Unix | ||
| 81 | Epoch. | ||
| 82 | |||
| 83 | =over | ||
| 84 | |||
| 85 | =item * | ||
| 86 | |||
| 87 | Sample input value: 2524608000 | ||
| 88 | |||
| 89 | =item * | ||
| 90 | |||
| 91 | Output expiration date/time: 01/01/2050 00:00:00 | ||
| 92 | |||
| 93 | =back | ||
| 94 | |||
| 95 | C<DAYS>, C<MONTHS>, C<YEARS>: The relative time from the moment of | ||
| 96 | issuance until the certificate will expire, expressed in days, months, | ||
| 97 | or years. | ||
| 98 | |||
| 99 | Example if C<DAYS>, issued on 10/12/2020 at 12:34:54 UTC: | ||
| 100 | |||
| 101 | =over | ||
| 102 | |||
| 103 | =item * | ||
| 104 | |||
| 105 | Sample input value: 90 | ||
| 106 | |||
| 107 | =item * | ||
| 108 | |||
| 109 | Output expiration date: 01/10/2020 12:34:54 UTC | ||
| 110 | |||
| 111 | =back | ||
| 112 | |||
| 113 | The minimum validity duration for a certificate using relative time | ||
| 114 | (C<DAYS>) is one day. The minimum validity for a certificate using | ||
| 115 | absolute time (C<ABSOLUTE> or C<END_DATE>) is one second. | ||
| 116 | |||
| 117 | |||
| 118 | =head2 B<REQUIRED> Value => Int | ||
| 119 | |||
| 120 | A long integer interpreted according to the value of C<Type>, below. | ||
| 121 | |||
| 122 | |||
| 123 | |||
| 124 | =head1 SEE ALSO | ||
| 125 | |||
| 126 | This class forms part of L<Paws>, describing an object used in L<Paws::ACMPCA> | ||
| 127 | |||
| 128 | =head1 BUGS and CONTRIBUTIONS | ||
| 129 | |||
| 130 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 131 | |||
| 132 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 133 | |||
| 134 | =cut | ||
| 135 |