Interface ICfnCertificateProps

Properties for defining a CfnCertificate.

Namespace: Amazon.CDK.AWS.IoT

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public interface ICfnCertificateProps

Syntax (vb)

Public Interface ICfnCertificateProps

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iot-certificate.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 cfnCertificateProps = new CfnCertificateProps {
    Status = "status",

    // the properties below are optional
    CaCertificatePem = "caCertificatePem",
    CertificateMode = "certificateMode",
    CertificatePem = "certificatePem",
    CertificateSigningRequest = "certificateSigningRequest"
};

Synopsis

Properties

CaCertificatePem	The CA certificate used to sign the device certificate being registered, not available when CertificateMode is SNI_ONLY.
CertificateMode	Specifies which mode of certificate registration to use with this resource.
CertificatePem	The certificate data in PEM format.
CertificateSigningRequest	The certificate signing request (CSR).
Status	The status of the certificate.

Properties

CaCertificatePem

The CA certificate used to sign the device certificate being registered, not available when CertificateMode is SNI_ONLY.

virtual string CaCertificatePem { get; }

Property Value

System.String

Remarks

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

CertificateMode

Specifies which mode of certificate registration to use with this resource.

virtual string CertificateMode { get; }

Property Value

System.String

Remarks

Valid options are DEFAULT with CaCertificatePem and CertificatePem, SNI_ONLY with CertificatePem, and Default with CertificateSigningRequest.

DEFAULT : A certificate in DEFAULT mode is either generated by AWS IoT Core or registered with an issuer certificate authority (CA). Devices with certificates in DEFAULT mode aren't required to send the Server Name Indication (SNI) extension when connecting to AWS IoT Core . However, to use features such as custom domains and VPC endpoints, we recommend that you use the SNI extension when connecting to AWS IoT Core .

SNI_ONLY : A certificate in SNI_ONLY mode is registered without an issuer CA. Devices with certificates in SNI_ONLY mode must send the SNI extension when connecting to AWS IoT Core .

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

CertificatePem

The certificate data in PEM format.

virtual string CertificatePem { get; }

Property Value

System.String

Remarks

Requires SNI_ONLY for the certificate mode or the accompanying CACertificatePem for registration.

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

CertificateSigningRequest

The certificate signing request (CSR).

virtual string CertificateSigningRequest { get; }

Property Value

System.String

Remarks

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

Status

The status of the certificate.

string Status { get; }

Property Value

System.String

Remarks

Valid values are ACTIVE, INACTIVE, REVOKED, PENDING_TRANSFER, and PENDING_ACTIVATION.

The status value REGISTER_INACTIVE is deprecated and should not be used.

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