Package software.amazon.awscdk.services.iot

Class CfnCACertificate

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.core.Construct
software.amazon.awscdk.core.CfnElement
software.amazon.awscdk.core.CfnRefElement
software.amazon.awscdk.core.CfnResource
software.amazon.awscdk.services.iot.CfnCACertificate
All Implemented Interfaces:
IConstruct, IDependable, IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct
@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)", date="2023-06-19T16:29:57.525Z") @Stability(Stable) public class CfnCACertificate extends CfnResource implements IInspectable
A CloudFormation AWS::IoT::CACertificate.

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();

  • 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 Construct scope, @NotNull String id, @NotNull CfnCACertificateProps props)
      Create a new AWS::IoT::CACertificate.

      Parameters:
      scope -
      • scope in which this resource is defined.
      This parameter is required.
      id -
      • scoped id of the resource.
      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()
      An array of key-value pairs to apply to this resource.

      For more information, see Tag .

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

      Valid values are "ACTIVE" and "INACTIVE".

    • setStatus

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

      Valid values are "ACTIVE" and "INACTIVE".

    • getAutoRegistrationStatus

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

      Valid values are "ENABLE" and "DISABLE".

    • setAutoRegistrationStatus

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

      Valid values are "ENABLE" and "DISABLE".

    • getCertificateMode

      @Stability(Stable) @Nullable public String getCertificateMode()
      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".

    • setCertificateMode

      @Stability(Stable) public void setCertificateMode(@Nullable String value)
      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".

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

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