CfnCACertificateProps

class aws_cdk.aws_iot.CfnCACertificateProps(*, ca_certificate_pem, status, auto_registration_status=None, certificate_mode=None, registration_config=None, remove_auto_registration=None, tags=None, verification_certificate_pem=None)

Bases: object

Properties for defining a CfnCACertificate.

Parameters
  • ca_certificate_pem (str) – The certificate data in PEM format.

  • status (str) – The status of the CA certificate. Valid values are “ACTIVE” and “INACTIVE”.

  • auto_registration_status (Optional[str]) – Whether the CA certificate is configured for auto registration of device certificates. Valid values are “ENABLE” and “DISABLE”.

  • certificate_mode (Optional[str]) – The mode of the CA. All the device certificates that are registered using this CA will be registered in the same mode as the CA. For more information about certificate mode for device certificates, see certificate mode . Valid values are “DEFAULT” and “SNI_ONLY”.

  • registration_config (Union[IResolvable, RegistrationConfigProperty, Dict[str, Any], None]) – Information about the registration configuration.

  • remove_auto_registration (Union[bool, IResolvable, None]) – If true, removes auto registration.

  • tags (Optional[Sequence[Union[CfnTag, Dict[str, Any]]]]) – An array of key-value pairs to apply to this resource. For more information, see Tag .

  • verification_certificate_pem (Optional[str]) – The private key verification certificate.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iot-cacertificate.html

ExampleMetadata

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
import aws_cdk.aws_iot as iot

cfn_cACertificate_props = iot.CfnCACertificateProps(
    ca_certificate_pem="caCertificatePem",
    status="status",

    # the properties below are optional
    auto_registration_status="autoRegistrationStatus",
    certificate_mode="certificateMode",
    registration_config=iot.CfnCACertificate.RegistrationConfigProperty(
        role_arn="roleArn",
        template_body="templateBody",
        template_name="templateName"
    ),
    remove_auto_registration=False,
    tags=[CfnTag(
        key="key",
        value="value"
    )],
    verification_certificate_pem="verificationCertificatePem"
)

Attributes

auto_registration_status

Whether the CA certificate is configured for auto registration of device certificates.

Valid values are “ENABLE” and “DISABLE”.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iot-cacertificate.html#cfn-iot-cacertificate-autoregistrationstatus

ca_certificate_pem

The certificate data in PEM format.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iot-cacertificate.html#cfn-iot-cacertificate-cacertificatepem

certificate_mode

The mode of the CA.

All the device certificates that are registered using this CA will be registered in the same mode as the CA. For more information about certificate mode for device certificates, see certificate mode .

Valid values are “DEFAULT” and “SNI_ONLY”.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iot-cacertificate.html#cfn-iot-cacertificate-certificatemode

registration_config

Information about the registration configuration.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iot-cacertificate.html#cfn-iot-cacertificate-registrationconfig

remove_auto_registration

If true, removes auto registration.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iot-cacertificate.html#cfn-iot-cacertificate-removeautoregistration

status

The status of the CA certificate.

Valid values are “ACTIVE” and “INACTIVE”.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iot-cacertificate.html#cfn-iot-cacertificate-status

tags

An array of key-value pairs to apply to this resource.

For more information, see Tag .

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iot-cacertificate.html#cfn-iot-cacertificate-tags

verification_certificate_pem

The private key verification certificate.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iot-cacertificate.html#cfn-iot-cacertificate-verificationcertificatepem