Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

Amazonka.IoT.Types.CertificateDescription

Description

Synopsis

data CertificateDescription = CertificateDescription' {
- caCertificateId :: Maybe Text
- certificateArn :: Maybe Text
- certificateId :: Maybe Text
- certificateMode :: Maybe CertificateMode
- certificatePem :: Maybe Text
- creationDate :: Maybe POSIX
- customerVersion :: Maybe Natural
- generationId :: Maybe Text
- lastModifiedDate :: Maybe POSIX
- ownedBy :: Maybe Text
- previousOwnedBy :: Maybe Text
- status :: Maybe CertificateStatus
- transferData :: Maybe TransferData
- validity :: Maybe CertificateValidity
}
newCertificateDescription :: CertificateDescription
certificateDescription_caCertificateId :: Lens' CertificateDescription (Maybe Text)
certificateDescription_certificateArn :: Lens' CertificateDescription (Maybe Text)
certificateDescription_certificateId :: Lens' CertificateDescription (Maybe Text)
certificateDescription_certificateMode :: Lens' CertificateDescription (Maybe CertificateMode)
certificateDescription_certificatePem :: Lens' CertificateDescription (Maybe Text)
certificateDescription_creationDate :: Lens' CertificateDescription (Maybe UTCTime)
certificateDescription_customerVersion :: Lens' CertificateDescription (Maybe Natural)
certificateDescription_generationId :: Lens' CertificateDescription (Maybe Text)
certificateDescription_lastModifiedDate :: Lens' CertificateDescription (Maybe UTCTime)
certificateDescription_ownedBy :: Lens' CertificateDescription (Maybe Text)
certificateDescription_previousOwnedBy :: Lens' CertificateDescription (Maybe Text)
certificateDescription_status :: Lens' CertificateDescription (Maybe CertificateStatus)
certificateDescription_transferData :: Lens' CertificateDescription (Maybe TransferData)
certificateDescription_validity :: Lens' CertificateDescription (Maybe CertificateValidity)

Documentation

data CertificateDescription Source #

Describes a certificate.

See: newCertificateDescription smart constructor.

Constructors

CertificateDescription'

Fields

caCertificateId :: Maybe Text
The certificate ID of the CA certificate used to sign this certificate.
certificateArn :: Maybe Text
The ARN of the certificate.
certificateId :: Maybe Text
The ID of the certificate.
certificateMode :: Maybe CertificateMode
The mode of the certificate.
DEFAULT: A certificate in DEFAULT mode is either generated by Amazon Web Services IoT Core or registered with an issuer certificate authority (CA) in DEFAULT mode. Devices with certificates in DEFAULT mode aren't required to send the Server Name Indication (SNI) extension when connecting to Amazon Web Services IoT Core. However, to use features such as custom domains and VPC endpoints, we recommend that you use the SNI extension when connecting to Amazon Web Services IoT Core.
SNI_ONLY: A certificate in SNI_ONLY mode is registered without an issuer CA. Devices with certificates in SNI_ONLY mode must send the SNI extension when connecting to Amazon Web Services IoT Core.
For more information about the value for SNI extension, see Transport security in IoT.
certificatePem :: Maybe Text
The certificate data, in PEM format.
creationDate :: Maybe POSIX
The date and time the certificate was created.
customerVersion :: Maybe Natural
The customer version of the certificate.
generationId :: Maybe Text
The generation ID of the certificate.
lastModifiedDate :: Maybe POSIX
The date and time the certificate was last modified.
ownedBy :: Maybe Text
The ID of the Amazon Web Services account that owns the certificate.
previousOwnedBy :: Maybe Text
The ID of the Amazon Web Services account of the previous owner of the certificate.
status :: Maybe CertificateStatus
The status of the certificate.
transferData :: Maybe TransferData
The transfer data.
validity :: Maybe CertificateValidity
When the certificate is valid.

Instances

Instances details

FromJSON CertificateDescription Source #
Instance details Defined in Amazonka.IoT.Types.CertificateDescription Methods parseJSON :: Value -> Parser CertificateDescription # parseJSONList :: Value -> Parser [CertificateDescription] #
Generic CertificateDescription Source #
Instance details Defined in Amazonka.IoT.Types.CertificateDescription Associated Types type Rep CertificateDescription :: Type -> Type # Methods from :: CertificateDescription -> Rep CertificateDescription x # to :: Rep CertificateDescription x -> CertificateDescription #
Read CertificateDescription Source #
Instance details Defined in Amazonka.IoT.Types.CertificateDescription Methods readsPrec :: Int -> ReadS CertificateDescription # readList :: ReadS [CertificateDescription] # readPrec :: ReadPrec CertificateDescription # readListPrec :: ReadPrec [CertificateDescription] #
Show CertificateDescription Source #
Instance details Defined in Amazonka.IoT.Types.CertificateDescription Methods showsPrec :: Int -> CertificateDescription -> ShowS # show :: CertificateDescription -> String # showList :: [CertificateDescription] -> ShowS #
NFData CertificateDescription Source #
Instance details Defined in Amazonka.IoT.Types.CertificateDescription Methods rnf :: CertificateDescription -> () #
Eq CertificateDescription Source #
Instance details Defined in Amazonka.IoT.Types.CertificateDescription Methods (==) :: CertificateDescription -> CertificateDescription -> Bool # (/=) :: CertificateDescription -> CertificateDescription -> Bool #
Hashable CertificateDescription Source #
Instance details Defined in Amazonka.IoT.Types.CertificateDescription Methods hashWithSalt :: Int -> CertificateDescription -> Int # hash :: CertificateDescription -> Int #
type Rep CertificateDescription Source #
Instance details Defined in Amazonka.IoT.Types.CertificateDescription type Rep CertificateDescription = D1 ('MetaData "CertificateDescription" "Amazonka.IoT.Types.CertificateDescription" "amazonka-iot-2.0-6w03vgAfmrM1SG22OsNJXL" 'False) (C1 ('MetaCons "CertificateDescription'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "caCertificateId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "certificateArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "certificateId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :: ((S1 ('MetaSel ('Just "certificateMode") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe CertificateMode)) :: S1 ('MetaSel ('Just "certificatePem") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "creationDate") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :: S1 ('MetaSel ('Just "customerVersion") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural))))) :: ((S1 ('MetaSel ('Just "generationId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "lastModifiedDate") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :: S1 ('MetaSel ('Just "ownedBy") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :: ((S1 ('MetaSel ('Just "previousOwnedBy") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "status") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe CertificateStatus))) :: (S1 ('MetaSel ('Just "transferData") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe TransferData)) :*: S1 ('MetaSel ('Just "validity") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe CertificateValidity)))))))

newCertificateDescription :: CertificateDescription Source #

Create a value of CertificateDescription 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:caCertificateId:CertificateDescription', certificateDescription_caCertificateId - The certificate ID of the CA certificate used to sign this certificate.

$sel:certificateArn:CertificateDescription', certificateDescription_certificateArn - The ARN of the certificate.

$sel:certificateId:CertificateDescription', certificateDescription_certificateId - The ID of the certificate.

$sel:certificateMode:CertificateDescription', certificateDescription_certificateMode - The mode of the certificate.

DEFAULT: A certificate in DEFAULT mode is either generated by Amazon Web Services IoT Core or registered with an issuer certificate authority (CA) in DEFAULT mode. Devices with certificates in DEFAULT mode aren't required to send the Server Name Indication (SNI) extension when connecting to Amazon Web Services IoT Core. However, to use features such as custom domains and VPC endpoints, we recommend that you use the SNI extension when connecting to Amazon Web Services IoT Core.

SNI_ONLY: A certificate in SNI_ONLY mode is registered without an issuer CA. Devices with certificates in SNI_ONLY mode must send the SNI extension when connecting to Amazon Web Services IoT Core.

For more information about the value for SNI extension, see Transport security in IoT.

$sel:certificatePem:CertificateDescription', certificateDescription_certificatePem - The certificate data, in PEM format.

$sel:creationDate:CertificateDescription', certificateDescription_creationDate - The date and time the certificate was created.

$sel:customerVersion:CertificateDescription', certificateDescription_customerVersion - The customer version of the certificate.

$sel:generationId:CertificateDescription', certificateDescription_generationId - The generation ID of the certificate.

$sel:lastModifiedDate:CertificateDescription', certificateDescription_lastModifiedDate - The date and time the certificate was last modified.

$sel:ownedBy:CertificateDescription', certificateDescription_ownedBy - The ID of the Amazon Web Services account that owns the certificate.

$sel:previousOwnedBy:CertificateDescription', certificateDescription_previousOwnedBy - The ID of the Amazon Web Services account of the previous owner of the certificate.

$sel:status:CertificateDescription', certificateDescription_status - The status of the certificate.

$sel:transferData:CertificateDescription', certificateDescription_transferData - The transfer data.

$sel:validity:CertificateDescription', certificateDescription_validity - When the certificate is valid.

certificateDescription_caCertificateId :: Lens' CertificateDescription (Maybe Text) Source #

The certificate ID of the CA certificate used to sign this certificate.

certificateDescription_certificateArn :: Lens' CertificateDescription (Maybe Text) Source #

The ARN of the certificate.

certificateDescription_certificateId :: Lens' CertificateDescription (Maybe Text) Source #

The ID of the certificate.

certificateDescription_certificateMode :: Lens' CertificateDescription (Maybe CertificateMode) Source #

The mode of the certificate.

DEFAULT: A certificate in DEFAULT mode is either generated by Amazon Web Services IoT Core or registered with an issuer certificate authority (CA) in DEFAULT mode. Devices with certificates in DEFAULT mode aren't required to send the Server Name Indication (SNI) extension when connecting to Amazon Web Services IoT Core. However, to use features such as custom domains and VPC endpoints, we recommend that you use the SNI extension when connecting to Amazon Web Services IoT Core.

SNI_ONLY: A certificate in SNI_ONLY mode is registered without an issuer CA. Devices with certificates in SNI_ONLY mode must send the SNI extension when connecting to Amazon Web Services IoT Core.

For more information about the value for SNI extension, see Transport security in IoT.

certificateDescription_certificatePem :: Lens' CertificateDescription (Maybe Text) Source #

The certificate data, in PEM format.

certificateDescription_creationDate :: Lens' CertificateDescription (Maybe UTCTime) Source #

The date and time the certificate was created.

certificateDescription_customerVersion :: Lens' CertificateDescription (Maybe Natural) Source #

The customer version of the certificate.

certificateDescription_generationId :: Lens' CertificateDescription (Maybe Text) Source #

The generation ID of the certificate.

certificateDescription_lastModifiedDate :: Lens' CertificateDescription (Maybe UTCTime) Source #

The date and time the certificate was last modified.

certificateDescription_ownedBy :: Lens' CertificateDescription (Maybe Text) Source #