Package software.amazon.awscdk.services.iot

Class CfnCertificate

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.CfnElement
software.amazon.awscdk.CfnRefElement
software.amazon.awscdk.CfnResource
software.amazon.awscdk.services.iot.CfnCertificate
All Implemented Interfaces:
IInspectable, ICertificateRef, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable
@Generated(value="jsii-pacmak/1.116.0 (build 0eddcff)", date="2025-10-24T13:34:40.059Z") @Stability(Stable) public class CfnCertificate extends CfnResource implements IInspectable, ICertificateRef
Use the AWS::IoT::Certificate resource to declare an AWS IoT X.509 certificate. For information about working with X.509 certificates, see X.509 Client Certificates in the AWS IoT Developer Guide .

Example: 

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.iot.*;
 CfnCertificate cfnCertificate = CfnCertificate.Builder.create(this, "MyCfnCertificate")
         .status("status")
         // the properties below are optional
         .caCertificatePem("caCertificatePem")
         .certificateMode("certificateMode")
         .certificatePem("certificatePem")
         .certificateSigningRequest("certificateSigningRequest")
         .build();

See Also:

  • Field Details

    • CFN_RESOURCE_TYPE_NAME

      @Stability(Stable) public static final String CFN_RESOURCE_TYPE_NAME
      The CloudFormation resource type name for this resource class.

  • Constructor Details

    • CfnCertificate

      protected CfnCertificate(software.amazon.jsii.JsiiObjectRef objRef)

    • CfnCertificate

      protected CfnCertificate(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

    • CfnCertificate

      @Stability(Stable) public CfnCertificate(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull CfnCertificateProps props)
      Parameters:
      scope - Scope in which this resource is defined. This parameter is required.
      id - Construct identifier for this resource (unique in its scope). This parameter is required.
      props - Resource properties. This parameter is required.

  • Method Details

    • fromCertificateArn

      @Stability(Stable) @NotNull public static ICertificateRef fromCertificateArn(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull String arn)
      Creates a new ICertificateRef from an ARN.

      Parameters:
      scope - This parameter is required.
      id - This parameter is required.
      arn - This parameter is required.

    • fromCertificateId

      @Stability(Stable) @NotNull public static ICertificateRef fromCertificateId(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull String certificateId)
      Creates a new ICertificateRef from a certificateId.

      Parameters:
      scope - This parameter is required.
      id - This parameter is required.
      certificateId - This parameter is required.

    • inspect

      @Stability(Stable) public void inspect(@NotNull TreeInspector inspector)
      Examines the CloudFormation resource and discloses attributes.

      Specified by:
      inspect in interface IInspectable
      Parameters:
      inspector - tree inspector to collect and process attributes. This parameter is required.

    • renderProperties

      @Stability(Stable) @NotNull protected Map<String,Object> renderProperties(@NotNull Map<String,Object> props)
      Overrides:
      renderProperties in class CfnResource
      Parameters:
      props - This parameter is required.

    • getAttrArn

      @Stability(Stable) @NotNull public String getAttrArn()
      Returns the Amazon Resource Name (ARN) for the certificate. For example:.

      { "Fn::GetAtt": ["MyCertificate", "Arn"] }

      A value similar to the following is returned:

      arn:aws:iot:ap-southeast-2:123456789012:cert/a1234567b89c012d3e4fg567hij8k9l01mno1p23q45678901rs234567890t1u2

    • getAttrId

      @Stability(Stable) @NotNull public String getAttrId()
      The certificate ID.

    • getCertificateRef

      @Stability(Stable) @NotNull public CertificateReference getCertificateRef()
      A reference to a Certificate resource.
      Specified by:
      getCertificateRef in interface ICertificateRef

    • getCfnProperties

      @Stability(Stable) @NotNull protected Map<String,Object> getCfnProperties()
      Overrides:
      getCfnProperties in class CfnResource

    • getStatus

      @Stability(Stable) @NotNull public String getStatus()
      The status of the certificate.

    • setStatus

      @Stability(Stable) public void setStatus(@NotNull String value)
      The status of the certificate.

    • getCaCertificatePem

      @Stability(Stable) @Nullable public String getCaCertificatePem()
      The CA certificate used to sign the device certificate being registered, not available when CertificateMode is SNI_ONLY.

    • setCaCertificatePem

      @Stability(Stable) public void setCaCertificatePem(@Nullable String value)
      The CA certificate used to sign the device certificate being registered, not available when CertificateMode is SNI_ONLY.

    • getCertificateMode

      @Stability(Stable) @Nullable public String getCertificateMode()
      Specifies which mode of certificate registration to use with this resource.

    • setCertificateMode

      @Stability(Stable) public void setCertificateMode(@Nullable String value)
      Specifies which mode of certificate registration to use with this resource.

    • getCertificatePem

      @Stability(Stable) @Nullable public String getCertificatePem()
      The certificate data in PEM format.

    • setCertificatePem

      @Stability(Stable) public void setCertificatePem(@Nullable String value)
      The certificate data in PEM format.

    • getCertificateSigningRequest

      @Stability(Stable) @Nullable public String getCertificateSigningRequest()
      The certificate signing request (CSR).

    • setCertificateSigningRequest

      @Stability(Stable) public void setCertificateSigningRequest(@Nullable String value)
      The certificate signing request (CSR).