amazonka-iot-2.0: Amazon IoT 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.IoT.Types.Certificate

Description

 
Synopsis

Documentation

data Certificate Source #

Information about a certificate.

See: newCertificate smart constructor.

Constructors

Certificate' 

Fields

  • certificateArn :: Maybe Text

    The ARN of the certificate.

  • certificateId :: Maybe Text

    The ID of the certificate. (The last part of the certificate ARN contains the certificate ID.)

  • 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.

  • creationDate :: Maybe POSIX

    The date and time the certificate was created.

  • status :: Maybe CertificateStatus

    The status of the certificate.

    The status value REGISTER_INACTIVE is deprecated and should not be used.

Instances

Instances details
FromJSON Certificate Source # 
Instance details

Defined in Amazonka.IoT.Types.Certificate

Generic Certificate Source # 
Instance details

Defined in Amazonka.IoT.Types.Certificate

Associated Types

type Rep Certificate :: Type -> Type #

Read Certificate Source # 
Instance details

Defined in Amazonka.IoT.Types.Certificate

Show Certificate Source # 
Instance details

Defined in Amazonka.IoT.Types.Certificate

NFData Certificate Source # 
Instance details

Defined in Amazonka.IoT.Types.Certificate

Methods

rnf :: Certificate -> () #

Eq Certificate Source # 
Instance details

Defined in Amazonka.IoT.Types.Certificate

Hashable Certificate Source # 
Instance details

Defined in Amazonka.IoT.Types.Certificate

type Rep Certificate Source # 
Instance details

Defined in Amazonka.IoT.Types.Certificate

type Rep Certificate = D1 ('MetaData "Certificate" "Amazonka.IoT.Types.Certificate" "amazonka-iot-2.0-6w03vgAfmrM1SG22OsNJXL" 'False) (C1 ('MetaCons "Certificate'" 'PrefixI 'True) ((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 "creationDate") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :*: S1 ('MetaSel ('Just "status") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe CertificateStatus))))))

newCertificate :: Certificate Source #

Create a value of Certificate 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:certificateArn:Certificate', certificate_certificateArn - The ARN of the certificate.

$sel:certificateId:Certificate', certificate_certificateId - The ID of the certificate. (The last part of the certificate ARN contains the certificate ID.)

$sel:certificateMode:Certificate', certificate_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.

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

$sel:status:Certificate', certificate_status - The status of the certificate.

The status value REGISTER_INACTIVE is deprecated and should not be used.

certificate_certificateId :: Lens' Certificate (Maybe Text) Source #

The ID of the certificate. (The last part of the certificate ARN contains the certificate ID.)

certificate_certificateMode :: Lens' Certificate (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.

certificate_creationDate :: Lens' Certificate (Maybe UTCTime) Source #

The date and time the certificate was created.

certificate_status :: Lens' Certificate (Maybe CertificateStatus) Source #

The status of the certificate.

The status value REGISTER_INACTIVE is deprecated and should not be used.