Skip to content

RegisterCACertificateRequest

Source code in docs_src/capo_iot/types/register_ca_certificate_request.py 
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
class RegisterCACertificateRequest(TypedDict, closed=True):
    ca_certificate: "capo_iot.types.certificate_pem.CertificatePem"
    """<p>The CA certificate.</p>"""
    verification_certificate: NotRequired[
        "capo_iot.types.certificate_pem.CertificatePem"
    ]
    """<p>The private key verification certificate. If <code>certificateMode</code> is <code>SNI_ONLY</code>, the <code>verificationCertificate</code> field must be empty. If <code>certificateMode</code> is <code>DEFAULT</code> or not provided, the <code>verificationCertificate</code> field must not be empty. </p>"""
    set_as_active: "capo_iot.types.set_as_active.SetAsActive"
    """<p>A boolean value that specifies if the CA certificate is set to active.</p> <p>Valid values: <code>ACTIVE | INACTIVE</code> </p>"""
    allow_auto_registration: (
        "capo_iot.types.allow_auto_registration.AllowAutoRegistration"
    )
    """<p>Allows this CA certificate to be used for auto registration of device certificates.</p>"""
    registration_config: NotRequired[
        "capo_iot.types.registration_config.RegistrationConfig"
    ]
    """<p>Information about the registration configuration.</p>"""
    tags: NotRequired["capo_iot.types.tag_list.TagList"]
    """<p>Metadata which can be used to manage the CA certificate.</p> <note> <p>For URI Request parameters use format: ...key1=value1&key2=value2...</p> <p>For the CLI command-line parameter use format: &&tags "key1=value1&key2=value2..."</p> <p>For the cli-input-json file use format: "tags": "key1=value1&key2=value2..."</p> </note>"""
    certificate_mode: NotRequired["capo_iot.types.certificate_mode.CertificateMode"]
    """<p>Describes the certificate mode in which the Certificate Authority (CA) will be registered. If the <code>verificationCertificate</code> field is not provided, set <code>certificateMode</code> to be <code>SNI_ONLY</code>. If the <code>verificationCertificate</code> field is provided, set <code>certificateMode</code> to be <code>DEFAULT</code>. When <code>certificateMode</code> is not provided, it defaults to <code>DEFAULT</code>. All the device certificates that are registered using this CA will be registered in the same certificate mode as the CA. For more information about certificate mode for device certificates, see <a href="https://docs.aws.amazon.com/iot/latest/apireference/API_CertificateDescription.html#iot-Type-CertificateDescription-certificateMode"> certificate mode</a>. </p>"""

allow_auto_registration instance-attribute 

allow_auto_registration: AllowAutoRegistration

Allows this CA certificate to be used for auto registration of device certificates.

ca_certificate instance-attribute 

ca_certificate: CertificatePem

The CA certificate.

certificate_mode instance-attribute 

certificate_mode: NotRequired[CertificateMode]

Describes the certificate mode in which the Certificate Authority (CA) will be registered. If the verificationCertificate field is not provided, set certificateMode to be SNI_ONLY. If the verificationCertificate field is provided, set certificateMode to be DEFAULT. When certificateMode is not provided, it defaults to DEFAULT. All the device certificates that are registered using this CA will be registered in the same certificate mode as the CA. For more information about certificate mode for device certificates, see certificate mode.

registration_config instance-attribute 

registration_config: NotRequired[RegistrationConfig]

Information about the registration configuration.

set_as_active instance-attribute 

set_as_active: SetAsActive

A boolean value that specifies if the CA certificate is set to active.

Valid values: ACTIVE | INACTIVE

tags instance-attribute 

tags: NotRequired[TagList]

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

verification_certificate instance-attribute 

verification_certificate: NotRequired[CertificatePem]

The private key verification certificate. If certificateMode is SNI_ONLY, the verificationCertificate field must be empty. If certificateMode is DEFAULT or not provided, the verificationCertificate field must not be empty.