Interface ICfnCACertificateProps

Properties for defining a CfnCACertificate.

Namespace: Amazon.CDK.AWS.IoT

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public interface ICfnCACertificateProps

Syntax (vb)

Public Interface ICfnCACertificateProps

Remarks

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

ExampleMetadata: fixture=_generated

Examples

// The code below shows an example of how to instantiate this type.
             // The values are placeholders you should change.
             using Amazon.CDK.AWS.IoT;

             var cfnCACertificateProps = new CfnCACertificateProps {
                 CaCertificatePem = "caCertificatePem",
                 Status = "status",

                 // the properties below are optional
                 AutoRegistrationStatus = "autoRegistrationStatus",
                 CertificateMode = "certificateMode",
                 RegistrationConfig = new RegistrationConfigProperty {
                     RoleArn = "roleArn",
                     TemplateBody = "templateBody",
                     TemplateName = "templateName"
                 },
                 RemoveAutoRegistration = false,
                 Tags = new [] { new CfnTag {
                     Key = "key",
                     Value = "value"
                 } },
                 VerificationCertificatePem = "verificationCertificatePem"
             };

Synopsis

Properties

AutoRegistrationStatus	Whether the CA certificate is configured for auto registration of device certificates.
CaCertificatePem	The certificate data in PEM format.
CertificateMode	The mode of the CA.
RegistrationConfig	Information about the registration configuration.
RemoveAutoRegistration	If true, removes auto registration.
Status	The status of the CA certificate.
Tags	An array of key-value pairs to apply to this resource.
VerificationCertificatePem	The private key verification certificate.

Properties

AutoRegistrationStatus

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

string? AutoRegistrationStatus { get; }

Property Value

string

Remarks

Valid values are "ENABLE" and "DISABLE".

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

CaCertificatePem

The certificate data in PEM format.

string CaCertificatePem { get; }

Property Value

string

Remarks

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

CertificateMode

The mode of the CA.

string? CertificateMode { get; }

Property Value

string

Remarks

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

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

RegistrationConfig

Information about the registration configuration.

object? RegistrationConfig { get; }

Property Value

object

Remarks

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

RemoveAutoRegistration

If true, removes auto registration.

object? RemoveAutoRegistration { get; }

Property Value

object

Remarks

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

Status

The status of the CA certificate.

string Status { get; }

Property Value

string

Remarks

Valid values are "ACTIVE" and "INACTIVE".

See: 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.

ICfnTag[]? Tags { get; }

Property Value

ICfnTag[]

Remarks

For more information, see Tag .

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

VerificationCertificatePem

The private key verification certificate.

string? VerificationCertificatePem { get; }

Property Value

string

Remarks

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