Package com.pulumi.aws.iot

Class CaCertificate

  • public class CaCertificate
extends com.pulumi.resources.CustomResource
    Creates and manages an AWS IoT CA Certificate. ## Example Usage 
     
 package generated_program;
 
 import com.pulumi.Context;
 import com.pulumi.Pulumi;
 import com.pulumi.core.Output;
 import com.pulumi.tls.PrivateKey;
 import com.pulumi.tls.PrivateKeyArgs;
 import com.pulumi.tls.SelfSignedCert;
 import com.pulumi.tls.SelfSignedCertArgs;
 import com.pulumi.aws.iot.IotFunctions;
 import com.pulumi.aws.iot.inputs.GetRegistrationCodeArgs;
 import com.pulumi.tls.CertRequest;
 import com.pulumi.tls.CertRequestArgs;
 import com.pulumi.tls.LocallySignedCert;
 import com.pulumi.tls.LocallySignedCertArgs;
 import com.pulumi.aws.iot.CaCertificate;
 import com.pulumi.aws.iot.CaCertificateArgs;
 import java.util.ArrayList;
 import java.util.Arrays;
 import java.util.Map;
 import java.io.File;
 import java.nio.file.Files;
 import java.nio.file.Paths;
 
 public class App {
     public static void main(String[] args) {
         Pulumi.run(App::stack);
     }
 
     public static void stack(Context ctx) {
         var caPrivateKey = new PrivateKey("caPrivateKey", PrivateKeyArgs.builder()
             .algorithm("RSA")
             .build());
 
         var ca = new SelfSignedCert("ca", SelfSignedCertArgs.builder()
             .subject(com.pulumi.tls.inputs.SelfSignedCertSubjectArgs.builder()
                 .commonName("example.com")
                 .organization("ACME Examples, Inc")
                 .build())
             .privateKeyPem(caPrivateKey.privateKeyPem())
             .validityPeriodHours(12)
             .allowedUses(            
                 "key_encipherment",
                 "digital_signature",
                 "server_auth")
             .isCaCertificate(true)
             .build());
 
         var verificationPrivateKey = new PrivateKey("verificationPrivateKey", PrivateKeyArgs.builder()
             .algorithm("RSA")
             .build());
 
         final var example = IotFunctions.getRegistrationCode(GetRegistrationCodeArgs.builder()
             .build());
 
         var verification = new CertRequest("verification", CertRequestArgs.builder()
             .subject(com.pulumi.tls.inputs.CertRequestSubjectArgs.builder()
                 .commonName(example.registrationCode())
                 .build())
             .privateKeyPem(verificationPrivateKey.privateKeyPem())
             .build());
 
         var verificationLocallySignedCert = new LocallySignedCert("verificationLocallySignedCert", LocallySignedCertArgs.builder()
             .certRequestPem(verification.certRequestPem())
             .caPrivateKeyPem(caPrivateKey.privateKeyPem())
             .caCertPem(ca.certPem())
             .validityPeriodHours(12)
             .allowedUses(            
                 "key_encipherment",
                 "digital_signature",
                 "server_auth")
             .build());
 
         var exampleCaCertificate = new CaCertificate("exampleCaCertificate", CaCertificateArgs.builder()
             .active(true)
             .caCertificatePem(ca.certPem())
             .verificationCertificatePem(verificationLocallySignedCert.certPem())
             .allowAutoRegistration(true)
             .build());
 
     }
 }

    • Nested Class Summary

      • Nested classes/interfaces inherited from class com.pulumi.resources.CustomResource

        com.pulumi.resources.CustomResource.CustomResourceInternal

      • Nested classes/interfaces inherited from class com.pulumi.resources.Resource

        com.pulumi.resources.Resource.LazyField<T extends java.lang.Object>, com.pulumi.resources.Resource.LazyFields, com.pulumi.resources.Resource.ResourceInternal

    • Field Summary

      • Fields inherited from class com.pulumi.resources.Resource

        childResources, remote

    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      com.pulumi.core.Output<java.lang.Boolean> active()  
      com.pulumi.core.Output<java.lang.Boolean> allowAutoRegistration()  
      com.pulumi.core.Output<java.lang.String> arn()  
      com.pulumi.core.Output<java.lang.String> caCertificatePem()  
      com.pulumi.core.Output<java.util.Optional<java.lang.String>> certificateMode()  
      com.pulumi.core.Output<java.lang.Integer> customerVersion()  
      com.pulumi.core.Output<java.lang.String> generationId()  
      static CaCertificate get​(java.lang.String name, com.pulumi.core.Output<java.lang.String> id, CaCertificateState state, com.pulumi.resources.CustomResourceOptions options)
      Get an existing Host resource's state with the given name, ID, and optional extra properties used to qualify the lookup.
      com.pulumi.core.Output<java.lang.String> region()  
      com.pulumi.core.Output<java.util.Optional<CaCertificateRegistrationConfig>> registrationConfig()  
      com.pulumi.core.Output<java.util.Optional<java.util.Map<java.lang.String,​java.lang.String>>> tags()  
      com.pulumi.core.Output<java.util.Map<java.lang.String,​java.lang.String>> tagsAll()  
      com.pulumi.core.Output<java.util.List<CaCertificateValidity>> validities()  
      com.pulumi.core.Output<java.util.Optional<java.lang.String>> verificationCertificatePem()  

      • Methods inherited from class com.pulumi.resources.CustomResource

        getId, id, idFuture

      • Methods inherited from class com.pulumi.resources.Resource

        getChildResources, getResourceName, getResourceType, getUrn, pulumiChildResources, pulumiResourceName, pulumiResourceType, urn

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    • Constructor Detail

      • CaCertificate

        public CaCertificate​(java.lang.String name)
        Parameters:
        name - The _unique_ name of the resulting resource.

      • CaCertificate

        public CaCertificate​(java.lang.String name,
                     CaCertificateArgs args)
        Parameters:
        name - The _unique_ name of the resulting resource.
        args - The arguments to use to populate this resource's properties.

      • CaCertificate

        public CaCertificate​(java.lang.String name,
                     CaCertificateArgs args,
                     @Nullable
                     com.pulumi.resources.CustomResourceOptions options)
        Parameters:
        name - The _unique_ name of the resulting resource.
        args - The arguments to use to populate this resource's properties.
        options - A bag of options that control this resource's behavior.

    • Method Detail

      • active

        public com.pulumi.core.Output<java.lang.Boolean> active()
        Returns:
        Boolean flag to indicate if the certificate should be active for device authentication.

      • allowAutoRegistration

        public com.pulumi.core.Output<java.lang.Boolean> allowAutoRegistration()
        Returns:
        Boolean flag to indicate if the certificate should be active for device registration.

      • arn

        public com.pulumi.core.Output<java.lang.String> arn()
        Returns:
        The ARN of the created CA certificate.

      • caCertificatePem

        public com.pulumi.core.Output<java.lang.String> caCertificatePem()
        Returns:
        PEM encoded CA certificate.

      • certificateMode

        public com.pulumi.core.Output<java.util.Optional<java.lang.String>> certificateMode()
        Returns:
        The certificate mode in which the CA will be registered. Valid values: `DEFAULT` and `SNI_ONLY`. Default: `DEFAULT`.

      • customerVersion

        public com.pulumi.core.Output<java.lang.Integer> customerVersion()
        Returns:
        The customer version of the CA certificate.

      • generationId

        public com.pulumi.core.Output<java.lang.String> generationId()
        Returns:
        The generation ID of the CA certificate.

      • region

        public com.pulumi.core.Output<java.lang.String> region()
        Returns:
        Region where this resource will be [managed](https://docs.aws.amazon.com/general/latest/gr/rande.html#regional-endpoints). Defaults to the Region set in the provider configuration.

      • registrationConfig

        public com.pulumi.core.Output<java.util.Optional<CaCertificateRegistrationConfig>> registrationConfig()
        Returns:
        Information about the registration configuration. See below.

      • tags

        public com.pulumi.core.Output<java.util.Optional<java.util.Map<java.lang.String,​java.lang.String>>> tags()
        Returns:
        A map of tags to assign to the resource. If configured with a provider `defaultTags` configuration block present, tags with matching keys will overwrite those defined at the provider-level.

      • tagsAll

        public com.pulumi.core.Output<java.util.Map<java.lang.String,​java.lang.String>> tagsAll()
        Returns:
        A map of tags assigned to the resource, including those inherited from the provider `defaultTags` configuration block.

      • validities

        public com.pulumi.core.Output<java.util.List<CaCertificateValidity>> validities()
        Returns:
        When the CA certificate is valid.

      • verificationCertificatePem

        public com.pulumi.core.Output<java.util.Optional<java.lang.String>> verificationCertificatePem()
        Returns:
        PEM encoded verification certificate containing the common name of a registration code. Review [CreateVerificationCSR](https://docs.aws.amazon.com/iot/latest/developerguide/register-CA-cert.html). Required if `certificateMode` is `DEFAULT`.

      • get

        public static CaCertificate get​(java.lang.String name,
                                com.pulumi.core.Output<java.lang.String> id,
                                @Nullable
                                CaCertificateState state,
                                @Nullable
                                com.pulumi.resources.CustomResourceOptions options)
        Get an existing Host resource's state with the given name, ID, and optional extra properties used to qualify the lookup.
        Parameters:
        name - The _unique_ name of the resulting resource.
        id - The _unique_ provider ID of the resource to lookup.
        state -
        options - Optional settings to control the behavior of the CustomResource.