| 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.IoT.RegisterCACertificate
Description
Registers a CA certificate with IoT. This CA certificate can then be used to sign device certificates, which can be then registered with IoT. You can register up to 10 CA certificates per Amazon Web Services account that have the same subject field. This enables you to have up to 10 certificate authorities sign your device certificates. If you have more than one CA certificate registered, make sure you pass the CA certificate when you register your device certificates with the RegisterCertificate action.
Requires permission to access the RegisterCACertificate action.
Synopsis
- data RegisterCACertificate = RegisterCACertificate' {}
- newRegisterCACertificate :: Text -> Text -> RegisterCACertificate
- registerCACertificate_setAsActive :: Lens' RegisterCACertificate (Maybe Bool)
- registerCACertificate_allowAutoRegistration :: Lens' RegisterCACertificate (Maybe Bool)
- registerCACertificate_registrationConfig :: Lens' RegisterCACertificate (Maybe RegistrationConfig)
- registerCACertificate_tags :: Lens' RegisterCACertificate (Maybe [Tag])
- registerCACertificate_caCertificate :: Lens' RegisterCACertificate Text
- registerCACertificate_verificationCertificate :: Lens' RegisterCACertificate Text
- data RegisterCACertificateResponse = RegisterCACertificateResponse' {}
- newRegisterCACertificateResponse :: Int -> RegisterCACertificateResponse
- registerCACertificateResponse_certificateArn :: Lens' RegisterCACertificateResponse (Maybe Text)
- registerCACertificateResponse_certificateId :: Lens' RegisterCACertificateResponse (Maybe Text)
- registerCACertificateResponse_httpStatus :: Lens' RegisterCACertificateResponse Int
Creating a Request
data RegisterCACertificate Source #
The input to the RegisterCACertificate operation.
See: newRegisterCACertificate smart constructor.
Constructors
| RegisterCACertificate' | |
Fields
| |
Instances
newRegisterCACertificate Source #
Arguments
| :: Text | |
| -> Text | |
| -> RegisterCACertificate |
Create a value of RegisterCACertificate 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:setAsActive:RegisterCACertificate', registerCACertificate_setAsActive - A boolean value that specifies if the CA certificate is set to active.
$sel:allowAutoRegistration:RegisterCACertificate', registerCACertificate_allowAutoRegistration - Allows this CA certificate to be used for auto registration of device
certificates.
$sel:registrationConfig:RegisterCACertificate', registerCACertificate_registrationConfig - Information about the registration configuration.
$sel:tags:RegisterCACertificate', registerCACertificate_tags - Metadata which can be used to manage the CA certificate.
For URI Request parameters use format: ...key1=value1&key2=value2...
For the CLI command-line parameter use format: &&tags "key1=value1&key2=value2..."
For the cli-input-json file use format: "tags": "key1=value1&key2=value2..."
$sel:caCertificate:RegisterCACertificate', registerCACertificate_caCertificate - The CA certificate.
$sel:verificationCertificate:RegisterCACertificate', registerCACertificate_verificationCertificate - The private key verification certificate.
Request Lenses
registerCACertificate_setAsActive :: Lens' RegisterCACertificate (Maybe Bool) Source #
A boolean value that specifies if the CA certificate is set to active.
registerCACertificate_allowAutoRegistration :: Lens' RegisterCACertificate (Maybe Bool) Source #
Allows this CA certificate to be used for auto registration of device certificates.
registerCACertificate_registrationConfig :: Lens' RegisterCACertificate (Maybe RegistrationConfig) Source #
Information about the registration configuration.
registerCACertificate_tags :: Lens' RegisterCACertificate (Maybe [Tag]) Source #
Metadata which can be used to manage the CA certificate.
For URI Request parameters use format: ...key1=value1&key2=value2...
For the CLI command-line parameter use format: &&tags "key1=value1&key2=value2..."
For the cli-input-json file use format: "tags": "key1=value1&key2=value2..."
registerCACertificate_caCertificate :: Lens' RegisterCACertificate Text Source #
The CA certificate.
registerCACertificate_verificationCertificate :: Lens' RegisterCACertificate Text Source #
The private key verification certificate.
Destructuring the Response
data RegisterCACertificateResponse Source #
The output from the RegisterCACertificateResponse operation.
See: newRegisterCACertificateResponse smart constructor.
Constructors
| RegisterCACertificateResponse' | |
Fields
| |
Instances
newRegisterCACertificateResponse Source #
Create a value of RegisterCACertificateResponse 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:RegisterCACertificateResponse', registerCACertificateResponse_certificateArn - The CA certificate ARN.
$sel:certificateId:RegisterCACertificateResponse', registerCACertificateResponse_certificateId - The CA certificate identifier.
$sel:httpStatus:RegisterCACertificateResponse', registerCACertificateResponse_httpStatus - The response's http status code.
Response Lenses
registerCACertificateResponse_certificateArn :: Lens' RegisterCACertificateResponse (Maybe Text) Source #
The CA certificate ARN.
registerCACertificateResponse_certificateId :: Lens' RegisterCACertificateResponse (Maybe Text) Source #
The CA certificate identifier.
registerCACertificateResponse_httpStatus :: Lens' RegisterCACertificateResponse Int Source #
The response's http status code.