Package software.amazon.awscdk.services.iot

Class CfnCACertificate

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.CfnCACertificate
All Implemented Interfaces:
IInspectable, ITaggable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable
@Generated(value="jsii-pacmak/1.103.1 (build bef2dea)", date="2024-09-11T18:01:17.121Z") @Stability(Stable) public class CfnCACertificate extends CfnResource implements IInspectable, ITaggable
Specifies a CA certificate.

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.*;
 CfnCACertificate cfnCACertificate = CfnCACertificate.Builder.create(this, "MyCfnCACertificate")
         .caCertificatePem("caCertificatePem")
         .status("status")
         // the properties below are optional
         .autoRegistrationStatus("autoRegistrationStatus")
         .certificateMode("certificateMode")
         .registrationConfig(RegistrationConfigProperty.builder()
                 .roleArn("roleArn")
                 .templateBody("templateBody")
                 .templateName("templateName")
                 .build())
         .removeAutoRegistration(false)
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .verificationCertificatePem("verificationCertificatePem")
         .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

    • CfnCACertificate

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

    • CfnCACertificate

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

    • CfnCACertificate

      @Stability(Stable) public CfnCACertificate(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull CfnCACertificateProps 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

    • 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 CA certificate. For example:.

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

      A value similar to the following is returned:

      arn:aws:iot:us-east-1:123456789012:cacert/a6be6b84559801927e35a8f901fae08b5971d78d1562e29504ff9663b276a5f5

    • getAttrId

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

    • getCfnProperties

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

    • getTags

      @Stability(Stable) @NotNull public TagManager getTags()
      Tag Manager which manages the tags for this resource.
      Specified by:
      getTags in interface ITaggable

    • getCaCertificatePem

      @Stability(Stable) @NotNull public String getCaCertificatePem()
      The certificate data in PEM format.

    • setCaCertificatePem

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

    • getStatus

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

    • setStatus

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

    • getAutoRegistrationStatus

      @Stability(Stable) @Nullable public String getAutoRegistrationStatus()
      Whether the CA certificate is configured for auto registration of device certificates.

    • setAutoRegistrationStatus

      @Stability(Stable) public void setAutoRegistrationStatus(@Nullable String value)
      Whether the CA certificate is configured for auto registration of device certificates.

    • getCertificateMode

      @Stability(Stable) @Nullable public String getCertificateMode()
      The mode of the CA.

    • setCertificateMode

      @Stability(Stable) public void setCertificateMode(@Nullable String value)
      The mode of the CA.

    • getRegistrationConfig

      @Stability(Stable) @Nullable public Object getRegistrationConfig()
      Information about the registration configuration.

    • setRegistrationConfig

      @Stability(Stable) public void setRegistrationConfig(@Nullable IResolvable value)
      Information about the registration configuration.

    • setRegistrationConfig

      @Stability(Stable) public void setRegistrationConfig(@Nullable CfnCACertificate.RegistrationConfigProperty value)
      Information about the registration configuration.

    • getRemoveAutoRegistration

      @Stability(Stable) @Nullable public Object getRemoveAutoRegistration()
      If true, removes auto registration.

    • setRemoveAutoRegistration

      @Stability(Stable) public void setRemoveAutoRegistration(@Nullable Boolean value)
      If true, removes auto registration.

    • setRemoveAutoRegistration

      @Stability(Stable) public void setRemoveAutoRegistration(@Nullable IResolvable value)
      If true, removes auto registration.

    • getTagsRaw

      @Stability(Stable) @Nullable public List<CfnTag> getTagsRaw()
      An array of key-value pairs to apply to this resource.

    • setTagsRaw

      @Stability(Stable) public void setTagsRaw(@Nullable List<CfnTag> value)
      An array of key-value pairs to apply to this resource.

    • getVerificationCertificatePem

      @Stability(Stable) @Nullable public String getVerificationCertificatePem()
      The private key verification certificate.

    • setVerificationCertificatePem

      @Stability(Stable) public void setVerificationCertificatePem(@Nullable String value)
      The private key verification certificate.