aws-cdk-lib.aws_iot.CfnCACertificateProps

interface CfnCACertificateProps

LanguageType name
.NETAmazon.CDK.AWS.IoT.CfnCACertificateProps
Gogithub.com/aws/aws-cdk-go/awscdk/v2/awsiot#CfnCACertificateProps
Javasoftware.amazon.awscdk.services.iot.CfnCACertificateProps
Pythonaws_cdk.aws_iot.CfnCACertificateProps
TypeScript aws-cdk-lib » aws_iot » CfnCACertificateProps

Properties for defining a CfnCACertificate.

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_iot as iot } from 'aws-cdk-lib';
const cfnCACertificateProps: iot.CfnCACertificateProps = {
  caCertificatePem: 'caCertificatePem',
  status: 'status',

  // the properties below are optional
  autoRegistrationStatus: 'autoRegistrationStatus',
  certificateMode: 'certificateMode',
  registrationConfig: {
    roleArn: 'roleArn',
    templateBody: 'templateBody',
    templateName: 'templateName',
  },
  removeAutoRegistration: false,
  tags: [{
    key: 'key',
    value: 'value',
  }],
  verificationCertificatePem: 'verificationCertificatePem',
};

Properties

NameTypeDescription
caCertificatePemstringThe certificate data in PEM format.
statusstringThe status of the CA certificate.
autoRegistrationStatus?stringWhether the CA certificate is configured for auto registration of device certificates.
certificateMode?stringThe mode of the CA.
registrationConfig?IResolvable | RegistrationConfigPropertyInformation about the registration configuration.
removeAutoRegistration?boolean | IResolvableIf true, removes auto registration.
tags?CfnTag[]An array of key-value pairs to apply to this resource.
verificationCertificatePem?stringThe private key verification certificate.

caCertificatePem

Type: string

The certificate data in PEM format.


status

Type: string

The status of the CA certificate.

Valid values are "ACTIVE" and "INACTIVE".


autoRegistrationStatus?

Type: string (optional)

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

Valid values are "ENABLE" and "DISABLE".


certificateMode?

Type: string (optional)

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


registrationConfig?

Type: IResolvable | RegistrationConfigProperty (optional)

Information about the registration configuration.


removeAutoRegistration?

Type: boolean | IResolvable (optional)

If true, removes auto registration.


tags?

Type: CfnTag[] (optional)

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

For more information, see Tag .


verificationCertificatePem?

Type: string (optional)

The private key verification certificate.