Package com.pulumi.aws.iot

Class DomainConfiguration

  • public class DomainConfiguration
extends com.pulumi.resources.CustomResource
    Creates and manages an AWS IoT domain configuration. ## Example Usage 
     
 package generated_program;
 
 import com.pulumi.Context;
 import com.pulumi.Pulumi;
 import com.pulumi.core.Output;
 import com.pulumi.aws.iot.DomainConfiguration;
 import com.pulumi.aws.iot.DomainConfigurationArgs;
 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 iot = new DomainConfiguration("iot", DomainConfigurationArgs.builder()
             .name("iot-")
             .domainName("iot.example.com")
             .serviceType("DATA")
             .serverCertificateArns(cert.arn())
             .build());
 
     }
 }
    ## Import Using `pulumi import`, import domain configurations using the name. For example: ```sh $ pulumi import aws:iot/domainConfiguration:DomainConfiguration example example ```

    • 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.String> applicationProtocol()  
      com.pulumi.core.Output<java.lang.String> arn()  
      com.pulumi.core.Output<java.lang.String> authenticationType()  
      com.pulumi.core.Output<java.util.Optional<DomainConfigurationAuthorizerConfig>> authorizerConfig()  
      com.pulumi.core.Output<java.lang.String> domainName()  
      com.pulumi.core.Output<java.lang.String> domainType()  
      static DomainConfiguration get​(java.lang.String name, com.pulumi.core.Output<java.lang.String> id, DomainConfigurationState 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> name()  
      com.pulumi.core.Output<java.lang.String> region()  
      com.pulumi.core.Output<java.util.Optional<java.util.List<java.lang.String>>> serverCertificateArns()  
      com.pulumi.core.Output<java.util.Optional<java.lang.String>> serviceType()  
      com.pulumi.core.Output<java.util.Optional<java.lang.String>> status()  
      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<DomainConfigurationTlsConfig> tlsConfig()  
      com.pulumi.core.Output<java.util.Optional<java.lang.String>> validationCertificateArn()  

      • 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

      • DomainConfiguration

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

      • DomainConfiguration

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

      • DomainConfiguration

        public DomainConfiguration​(java.lang.String name,
                           @Nullable
                           DomainConfigurationArgs 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

      • applicationProtocol

        public com.pulumi.core.Output<java.lang.String> applicationProtocol()
        Returns:
        An enumerated string that specifies the application-layer protocol. Valid values are `SECURE_MQTT`, `MQTT_WSS`, `HTTPS` or `DEFAULT`.

      • arn

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

      • authenticationType

        public com.pulumi.core.Output<java.lang.String> authenticationType()
        Returns:
        An enumerated string that specifies the authentication type. Valid values are `CUSTOM_AUTH_X509`, `CUSTOM_AUTH`, `AWS_X509`, `AWS_SIGV4` or `DEFAULT`.

      • authorizerConfig

        public com.pulumi.core.Output<java.util.Optional<DomainConfigurationAuthorizerConfig>> authorizerConfig()
        Returns:
        An object that specifies the authorization service for a domain. See the `authorizerConfig` Block below for details.

      • domainName

        public com.pulumi.core.Output<java.lang.String> domainName()
        Returns:
        Fully-qualified domain name.

      • domainType

        public com.pulumi.core.Output<java.lang.String> domainType()
        Returns:
        The type of the domain.

      • name

        public com.pulumi.core.Output<java.lang.String> name()
        Returns:
        The name of the domain configuration. This value must be unique to a region.

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

      • serverCertificateArns

        public com.pulumi.core.Output<java.util.Optional<java.util.List<java.lang.String>>> serverCertificateArns()
        Returns:
        The ARNs of the certificates that IoT passes to the device during the TLS handshake. Currently you can specify only one certificate ARN. This value is not required for Amazon Web Services-managed domains. When using a custom `domainName`, the cert must include it.

      • serviceType

        public com.pulumi.core.Output<java.util.Optional<java.lang.String>> serviceType()
        Returns:
        The type of service delivered by the endpoint. Note: Amazon Web Services IoT Core currently supports only the `DATA` service type.

      • status

        public com.pulumi.core.Output<java.util.Optional<java.lang.String>> status()
        Returns:
        The status to which the domain configuration should be set. Valid values are `ENABLED` and `DISABLED`.

      • tags

        public com.pulumi.core.Output<java.util.Optional<java.util.Map<java.lang.String,​java.lang.String>>> tags()
        Returns:
        Map of tags to assign to this 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.

      • tlsConfig

        public com.pulumi.core.Output<DomainConfigurationTlsConfig> tlsConfig()
        Returns:
        An object that specifies the TLS configuration for a domain. See the `tlsConfig` Block below for details.

      • validationCertificateArn

        public com.pulumi.core.Output<java.util.Optional<java.lang.String>> validationCertificateArn()
        Returns:
        The certificate used to validate the server certificate and prove domain name ownership. This certificate must be signed by a public certificate authority. This value is not required for Amazon Web Services-managed domains.

      • get

        public static DomainConfiguration get​(java.lang.String name,
                                      com.pulumi.core.Output<java.lang.String> id,
                                      @Nullable
                                      DomainConfigurationState 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.