Copyright	(c) 2013-2021 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay+amazonka@gmail.com>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None

Amazonka.CertificateManagerPCA.Types.Validity

Description

Synopsis

data Validity = Validity' {
- value :: Natural
- type' :: ValidityPeriodType
}
newValidity :: Natural -> ValidityPeriodType -> Validity
validity_value :: Lens' Validity Natural
validity_type :: Lens' Validity ValidityPeriodType

Documentation

data Validity Source #

Validity specifies the period of time during which a certificate is valid. Validity can be expressed as an explicit date and time when the validity of a certificate starts or expires, or as a span of time after issuance, stated in days, months, or years. For more information, see Validity in RFC 5280.

ACM Private CA API consumes the Validity data type differently in two distinct parameters of the IssueCertificate action. The required parameter IssueCertificate:Validity specifies the end of a certificate's validity period. The optional parameter IssueCertificate:ValidityNotBefore specifies a customized starting time for the validity period.

See: newValidity smart constructor.

Constructors

Validity'

Fields

value :: Natural
A long integer interpreted according to the value of Type, below.
type' :: ValidityPeriodType
Determines how ACM Private CA interprets the Value parameter, an integer. Supported validity types include those listed below. Type definitions with values include a sample input value and the resulting output.
END_DATE: The specific date and time when the certificate will expire, expressed using UTCTime (YYMMDDHHMMSS) or GeneralizedTime (YYYYMMDDHHMMSS) format. When UTCTime is used, if the year field (YY) is greater than or equal to 50, the year is interpreted as 19YY. If the year field is less than 50, the year is interpreted as 20YY.
- Sample input value: 491231235959 (UTCTime format)
- Output expiration date/time: 12/31/2049 23:59:59
ABSOLUTE: The specific date and time when the validity of a certificate will start or expire, expressed in seconds since the Unix Epoch.
- Sample input value: 2524608000
- Output expiration date/time: 01/01/2050 00:00:00
DAYS, MONTHS, YEARS: The relative time from the moment of issuance until the certificate will expire, expressed in days, months, or years.
Example if DAYS, issued on 10/12/2020 at 12:34:54 UTC:
- Sample input value: 90
- Output expiration date: 01/10/2020 12:34:54 UTC
The minimum validity duration for a certificate using relative time (DAYS) is one day. The minimum validity for a certificate using absolute time (ABSOLUTE or END_DATE) is one second.

Instances

Instances details

Eq Validity Source #
Instance details Defined in Amazonka.CertificateManagerPCA.Types.Validity Methods (==) :: Validity -> Validity -> Bool # (/=) :: Validity -> Validity -> Bool #
Read Validity Source #
Instance details Defined in Amazonka.CertificateManagerPCA.Types.Validity Methods readsPrec :: Int -> ReadS Validity # readList :: ReadS [Validity] # readPrec :: ReadPrec Validity # readListPrec :: ReadPrec [Validity] #
Show Validity Source #
Instance details Defined in Amazonka.CertificateManagerPCA.Types.Validity Methods showsPrec :: Int -> Validity -> ShowS # show :: Validity -> String # showList :: [Validity] -> ShowS #
Generic Validity Source #
Instance details Defined in Amazonka.CertificateManagerPCA.Types.Validity Associated Types type Rep Validity :: Type -> Type # Methods from :: Validity -> Rep Validity x # to :: Rep Validity x -> Validity #
NFData Validity Source #
Instance details Defined in Amazonka.CertificateManagerPCA.Types.Validity Methods rnf :: Validity -> () #
Hashable Validity Source #
Instance details Defined in Amazonka.CertificateManagerPCA.Types.Validity Methods hashWithSalt :: Int -> Validity -> Int # hash :: Validity -> Int #
ToJSON Validity Source #
Instance details Defined in Amazonka.CertificateManagerPCA.Types.Validity Methods toJSON :: Validity -> Value # toEncoding :: Validity -> Encoding # toJSONList :: [Validity] -> Value # toEncodingList :: [Validity] -> Encoding #
type Rep Validity Source #
Instance details Defined in Amazonka.CertificateManagerPCA.Types.Validity type Rep Validity = D1 ('MetaData "Validity" "Amazonka.CertificateManagerPCA.Types.Validity" "libZSservicesZSamazonka-certificatemanager-pcaZSamazonka-certificatemanager-pca" 'False) (C1 ('MetaCons "Validity'" 'PrefixI 'True) (S1 ('MetaSel ('Just "value") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Natural) :*: S1 ('MetaSel ('Just "type'") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 ValidityPeriodType)))

newValidity Source #

Arguments

:: Natural	`$sel:value:Validity'`
-> ValidityPeriodType	`$sel:type':Validity'`
-> Validity

Create a value of Validity with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:value:Validity', validity_value - A long integer interpreted according to the value of Type, below.

$sel:type':Validity', validity_type - Determines how ACM Private CA interprets the Value parameter, an integer. Supported validity types include those listed below. Type definitions with values include a sample input value and the resulting output.

END_DATE: The specific date and time when the certificate will expire, expressed using UTCTime (YYMMDDHHMMSS) or GeneralizedTime (YYYYMMDDHHMMSS) format. When UTCTime is used, if the year field (YY) is greater than or equal to 50, the year is interpreted as 19YY. If the year field is less than 50, the year is interpreted as 20YY.

Sample input value: 491231235959 (UTCTime format)
Output expiration date/time: 12/31/2049 23:59:59

ABSOLUTE: The specific date and time when the validity of a certificate will start or expire, expressed in seconds since the Unix Epoch.

Sample input value: 2524608000
Output expiration date/time: 01/01/2050 00:00:00

DAYS, MONTHS, YEARS: The relative time from the moment of issuance until the certificate will expire, expressed in days, months, or years.

Example if DAYS, issued on 10/12/2020 at 12:34:54 UTC:

Sample input value: 90
Output expiration date: 01/10/2020 12:34:54 UTC

The minimum validity duration for a certificate using relative time (DAYS) is one day. The minimum validity for a certificate using absolute time (ABSOLUTE or END_DATE) is one second.

validity_value :: Lens' Validity Natural Source #

A long integer interpreted according to the value of Type, below.

validity_type :: Lens' Validity ValidityPeriodType Source #

Determines how ACM Private CA interprets the Value parameter, an integer. Supported validity types include those listed below. Type definitions with values include a sample input value and the resulting output.

END_DATE: The specific date and time when the certificate will expire, expressed using UTCTime (YYMMDDHHMMSS) or GeneralizedTime (YYYYMMDDHHMMSS) format. When UTCTime is used, if the year field (YY) is greater than or equal to 50, the year is interpreted as 19YY. If the year field is less than 50, the year is interpreted as 20YY.

Sample input value: 491231235959 (UTCTime format)
Output expiration date/time: 12/31/2049 23:59:59

ABSOLUTE: The specific date and time when the validity of a certificate will start or expire, expressed in seconds since the Unix Epoch.

Sample input value: 2524608000
Output expiration date/time: 01/01/2050 00:00:00

DAYS, MONTHS, YEARS: The relative time from the moment of issuance until the certificate will expire, expressed in days, months, or years.

Example if DAYS, issued on 10/12/2020 at 12:34:54 UTC:

Sample input value: 90
Output expiration date: 01/10/2020 12:34:54 UTC

The minimum validity duration for a certificate using relative time (DAYS) is one day. The minimum validity for a certificate using absolute time (ABSOLUTE or END_DATE) is one second.