amazonka-transfer-2.0: Amazon Transfer Family SDK.
Copyright(c) 2013-2023 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellSafe-Inferred
LanguageHaskell2010

Amazonka.Transfer.Types.DescribedCertificate

Description

 
Synopsis

Documentation

data DescribedCertificate Source #

Describes the properties of a certificate.

See: newDescribedCertificate smart constructor.

Constructors

DescribedCertificate' 

Fields

Instances

Instances details
FromJSON DescribedCertificate Source # 
Instance details

Defined in Amazonka.Transfer.Types.DescribedCertificate

Generic DescribedCertificate Source # 
Instance details

Defined in Amazonka.Transfer.Types.DescribedCertificate

Associated Types

type Rep DescribedCertificate :: Type -> Type #

Show DescribedCertificate Source # 
Instance details

Defined in Amazonka.Transfer.Types.DescribedCertificate

NFData DescribedCertificate Source # 
Instance details

Defined in Amazonka.Transfer.Types.DescribedCertificate

Methods

rnf :: DescribedCertificate -> () #

Eq DescribedCertificate Source # 
Instance details

Defined in Amazonka.Transfer.Types.DescribedCertificate

Hashable DescribedCertificate Source # 
Instance details

Defined in Amazonka.Transfer.Types.DescribedCertificate

type Rep DescribedCertificate Source # 
Instance details

Defined in Amazonka.Transfer.Types.DescribedCertificate

type Rep DescribedCertificate = D1 ('MetaData "DescribedCertificate" "Amazonka.Transfer.Types.DescribedCertificate" "amazonka-transfer-2.0-JiqKYJwOo427yDlzvkXGLY" 'False) (C1 ('MetaCons "DescribedCertificate'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "activeDate") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :*: (S1 ('MetaSel ('Just "certificate") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (Sensitive Text))) :*: S1 ('MetaSel ('Just "certificateChain") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (Sensitive Text))))) :*: ((S1 ('MetaSel ('Just "certificateId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "description") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "inactiveDate") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :*: S1 ('MetaSel ('Just "notAfterDate") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX))))) :*: ((S1 ('MetaSel ('Just "notBeforeDate") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :*: (S1 ('MetaSel ('Just "serial") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "status") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe CertificateStatusType)))) :*: ((S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (NonEmpty Tag))) :*: S1 ('MetaSel ('Just "type'") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe CertificateType))) :*: (S1 ('MetaSel ('Just "usage") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe CertificateUsageType)) :*: S1 ('MetaSel ('Just "arn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))))

newDescribedCertificate Source #

Create a value of DescribedCertificate 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:activeDate:DescribedCertificate', describedCertificate_activeDate - An optional date that specifies when the certificate becomes active.

$sel:certificate:DescribedCertificate', describedCertificate_certificate - The file name for the certificate.

$sel:certificateChain:DescribedCertificate', describedCertificate_certificateChain - The list of certificates that make up the chain for the certificate.

$sel:certificateId:DescribedCertificate', describedCertificate_certificateId - An array of identifiers for the imported certificates. You use this identifier for working with profiles and partner profiles.

$sel:description:DescribedCertificate', describedCertificate_description - The name or description that's used to identity the certificate.

$sel:inactiveDate:DescribedCertificate', describedCertificate_inactiveDate - An optional date that specifies when the certificate becomes inactive.

$sel:notAfterDate:DescribedCertificate', describedCertificate_notAfterDate - The final date that the certificate is valid.

$sel:notBeforeDate:DescribedCertificate', describedCertificate_notBeforeDate - The earliest date that the certificate is valid.

$sel:serial:DescribedCertificate', describedCertificate_serial - The serial number for the certificate.

$sel:status:DescribedCertificate', describedCertificate_status - The certificate can be either ACTIVE, PENDING_ROTATION, or INACTIVE. PENDING_ROTATION means that this certificate will replace the current certificate when it expires.

$sel:tags:DescribedCertificate', describedCertificate_tags - Key-value pairs that can be used to group and search for certificates.

$sel:type':DescribedCertificate', describedCertificate_type - If a private key has been specified for the certificate, its type is CERTIFICATE_WITH_PRIVATE_KEY. If there is no private key, the type is CERTIFICATE.

$sel:usage:DescribedCertificate', describedCertificate_usage - Specifies whether this certificate is used for signing or encryption.

$sel:arn:DescribedCertificate', describedCertificate_arn - The unique Amazon Resource Name (ARN) for the certificate.

describedCertificate_activeDate :: Lens' DescribedCertificate (Maybe UTCTime) Source #

An optional date that specifies when the certificate becomes active.

describedCertificate_certificateChain :: Lens' DescribedCertificate (Maybe Text) Source #

The list of certificates that make up the chain for the certificate.

describedCertificate_certificateId :: Lens' DescribedCertificate (Maybe Text) Source #

An array of identifiers for the imported certificates. You use this identifier for working with profiles and partner profiles.

describedCertificate_description :: Lens' DescribedCertificate (Maybe Text) Source #

The name or description that's used to identity the certificate.

describedCertificate_inactiveDate :: Lens' DescribedCertificate (Maybe UTCTime) Source #

An optional date that specifies when the certificate becomes inactive.

describedCertificate_notAfterDate :: Lens' DescribedCertificate (Maybe UTCTime) Source #

The final date that the certificate is valid.

describedCertificate_notBeforeDate :: Lens' DescribedCertificate (Maybe UTCTime) Source #

The earliest date that the certificate is valid.

describedCertificate_serial :: Lens' DescribedCertificate (Maybe Text) Source #

The serial number for the certificate.

describedCertificate_status :: Lens' DescribedCertificate (Maybe CertificateStatusType) Source #

The certificate can be either ACTIVE, PENDING_ROTATION, or INACTIVE. PENDING_ROTATION means that this certificate will replace the current certificate when it expires.

describedCertificate_tags :: Lens' DescribedCertificate (Maybe (NonEmpty Tag)) Source #

Key-value pairs that can be used to group and search for certificates.

describedCertificate_type :: Lens' DescribedCertificate (Maybe CertificateType) Source #

If a private key has been specified for the certificate, its type is CERTIFICATE_WITH_PRIVATE_KEY. If there is no private key, the type is CERTIFICATE.

describedCertificate_usage :: Lens' DescribedCertificate (Maybe CertificateUsageType) Source #

Specifies whether this certificate is used for signing or encryption.

describedCertificate_arn :: Lens' DescribedCertificate Text Source #

The unique Amazon Resource Name (ARN) for the certificate.