Package com.pulumi.aws.route53domains

Class Domain

  • public class Domain
extends com.pulumi.resources.CustomResource
    Provides a resource to manage a domain. This resource registers, renews and deregisters a domain name. If a domain name's lifecycle is managed outside of Terraform use the `aws.route53domains.RegisteredDomain` resource instead. ## Example Usage 
     
 package generated_program;
 
 import com.pulumi.Context;
 import com.pulumi.Pulumi;
 import com.pulumi.core.Output;
 import com.pulumi.aws.route53domains.Domain;
 import com.pulumi.aws.route53domains.DomainArgs;
 import com.pulumi.aws.route53domains.inputs.DomainAdminContactArgs;
 import com.pulumi.aws.route53domains.inputs.DomainRegistrantContactArgs;
 import com.pulumi.aws.route53domains.inputs.DomainTechContactArgs;
 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 example = new Domain("example", DomainArgs.builder()
             .adminContact(DomainAdminContactArgs.builder()
                 .addressLine1("101 Main Street")
                 .city("San Francisco")
                 .contactType("COMPANY")
                 .countryCode("US")
                 .email("pulumi-acctest@example.com")
                 .fax("+1.4155551234")
                 .firstName("Terraform")
                 .lastName("Team")
                 .organizationName("HashiCorp")
                 .phoneNumber("+1.4155551234")
                 .state("CA")
                 .zipCode("94105")
                 .build())
             .registrantContact(DomainRegistrantContactArgs.builder()
                 .addressLine1("101 Main Street")
                 .city("San Francisco")
                 .contactType("COMPANY")
                 .countryCode("US")
                 .email("pulumi-acctest@example.com")
                 .fax("+1.4155551234")
                 .firstName("Terraform")
                 .lastName("Team")
                 .organizationName("HashiCorp")
                 .phoneNumber("+1.4155551234")
                 .state("CA")
                 .zipCode("94105")
                 .build())
             .techContact(DomainTechContactArgs.builder()
                 .addressLine1("101 Main Street")
                 .city("San Francisco")
                 .contactType("COMPANY")
                 .countryCode("US")
                 .email("pulumi-acctest@example.com")
                 .fax("+1.4155551234")
                 .firstName("Terraform")
                 .lastName("Team")
                 .organizationName("HashiCorp")
                 .phoneNumber("+1.4155551234")
                 .state("CA")
                 .zipCode("94105")
                 .build())
             .domainName("example.com")
             .autoRenew(false)
             .tags(Map.of("Environment", "test"))
             .build());
 
     }
 }
    ## Import Using `pulumi import`, import domains using the `domainName`. For example: ```sh $ pulumi import aws:route53domains/domain:Domain example example.com ```

    • 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

    • Constructor Summary

      Constructors 
      Constructor Description
      Domain​(java.lang.String name)  
      Domain​(java.lang.String name, DomainArgs args)  
      Domain​(java.lang.String name, DomainArgs args, com.pulumi.resources.CustomResourceOptions options)  

    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      com.pulumi.core.Output<java.lang.String> abuseContactEmail()  
      com.pulumi.core.Output<java.lang.String> abuseContactPhone()  
      com.pulumi.core.Output<DomainAdminContact> adminContact()  
      com.pulumi.core.Output<java.lang.Boolean> adminPrivacy()  
      com.pulumi.core.Output<java.lang.Boolean> autoRenew()  
      com.pulumi.core.Output<java.util.List<DomainBillingContact>> billingContacts()  
      com.pulumi.core.Output<java.lang.Boolean> billingPrivacy()  
      com.pulumi.core.Output<java.lang.String> creationDate()  
      com.pulumi.core.Output<java.lang.String> domainName()  
      com.pulumi.core.Output<java.lang.Integer> durationInYears()  
      com.pulumi.core.Output<java.lang.String> expirationDate()  
      static Domain get​(java.lang.String name, com.pulumi.core.Output<java.lang.String> id, DomainState 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> hostedZoneId()  
      com.pulumi.core.Output<java.util.List<DomainNameServer>> nameServers()  
      com.pulumi.core.Output<DomainRegistrantContact> registrantContact()  
      com.pulumi.core.Output<java.lang.Boolean> registrantPrivacy()  
      com.pulumi.core.Output<java.lang.String> registrarName()  
      com.pulumi.core.Output<java.lang.String> registrarUrl()  
      com.pulumi.core.Output<java.util.List<java.lang.String>> statusLists()  
      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<DomainTechContact> techContact()  
      com.pulumi.core.Output<java.lang.Boolean> techPrivacy()  
      com.pulumi.core.Output<java.util.Optional<DomainTimeouts>> timeouts()  
      com.pulumi.core.Output<java.lang.Boolean> transferLock()  
      com.pulumi.core.Output<java.lang.String> updatedDate()  
      com.pulumi.core.Output<java.lang.String> whoisServer()  

      • 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

      • Domain

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

      • Domain

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

      • Domain

        public Domain​(java.lang.String name,
              DomainArgs 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

      • abuseContactEmail

        public com.pulumi.core.Output<java.lang.String> abuseContactEmail()
        Returns:
        Email address to contact to report incorrect contact information for a domain, to report that the domain is being used to send spam, to report that someone is cybersquatting on a domain name, or report some other type of abuse.

      • abuseContactPhone

        public com.pulumi.core.Output<java.lang.String> abuseContactPhone()
        Returns:
        Phone number for reporting abuse.

      • adminContact

        public com.pulumi.core.Output<DomainAdminContact> adminContact()
        Returns:
        Details about the domain administrative contact. See Contact Blocks for more details.

      • adminPrivacy

        public com.pulumi.core.Output<java.lang.Boolean> adminPrivacy()
        Returns:
        Whether domain administrative contact information is concealed from WHOIS queries. Default: `true`.

      • autoRenew

        public com.pulumi.core.Output<java.lang.Boolean> autoRenew()
        Returns:
        Whether the domain registration is set to renew automatically. Default: `true`.

      • billingContacts

        public com.pulumi.core.Output<java.util.List<DomainBillingContact>> billingContacts()
        Returns:
        Details about the domain billing contact. See Contact Blocks for more details.

      • billingPrivacy

        public com.pulumi.core.Output<java.lang.Boolean> billingPrivacy()
        Returns:
        Whether domain billing contact information is concealed from WHOIS queries. Default: `true`.

      • creationDate

        public com.pulumi.core.Output<java.lang.String> creationDate()
        Returns:
        The date when the domain was created as found in the response to a WHOIS query.

      • domainName

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

      • durationInYears

        public com.pulumi.core.Output<java.lang.Integer> durationInYears()
        Returns:
        The number of years that you want to register the domain for. Domains are registered for a minimum of one year. Increasing the duration renews the domain.

      • expirationDate

        public com.pulumi.core.Output<java.lang.String> expirationDate()
        Returns:
        The date when the registration for the domain is set to expire.

      • hostedZoneId

        public com.pulumi.core.Output<java.lang.String> hostedZoneId()
        Returns:
        The ID of the public Route 53 hosted zone created for the domain. This hosted zone is deleted when the domain is deregistered.

      • nameServers

        public com.pulumi.core.Output<java.util.List<DomainNameServer>> nameServers()
        Returns:
        The list of nameservers for the domain. See `nameServer` Blocks for more details.

      • registrantContact

        public com.pulumi.core.Output<DomainRegistrantContact> registrantContact()
        Returns:
        Details about the domain registrant. See Contact Blocks for more details.

      • registrantPrivacy

        public com.pulumi.core.Output<java.lang.Boolean> registrantPrivacy()
        Returns:
        Whether domain registrant contact information is concealed from WHOIS queries. Default: `true`.

      • registrarName

        public com.pulumi.core.Output<java.lang.String> registrarName()
        Returns:
        Name of the registrar of the domain as identified in the registry.

      • registrarUrl

        public com.pulumi.core.Output<java.lang.String> registrarUrl()
        Returns:
        Web address of the registrar.

      • statusLists

        public com.pulumi.core.Output<java.util.List<java.lang.String>> statusLists()
        Returns:
        List of [domain name status codes](https://www.icann.org/resources/pages/epp-status-codes-2014-06-16-en).

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

      • techContact

        public com.pulumi.core.Output<DomainTechContact> techContact()
        Returns:
        Details about the domain technical contact. See Contact Blocks for more details.

      • techPrivacy

        public com.pulumi.core.Output<java.lang.Boolean> techPrivacy()
        Returns:
        Whether domain technical contact information is concealed from WHOIS queries. Default: `true`.

      • timeouts

        public com.pulumi.core.Output<java.util.Optional<DomainTimeouts>> timeouts()

      • transferLock

        public com.pulumi.core.Output<java.lang.Boolean> transferLock()
        Returns:
        Whether the domain is locked for transfer. Default: `true`. > **NOTE:** You must specify the same privacy setting for `adminPrivacy`, `registrantPrivacy` and `techPrivacy`.

      • updatedDate

        public com.pulumi.core.Output<java.lang.String> updatedDate()
        Returns:
        The last updated date of the domain as found in the response to a WHOIS query.

      • whoisServer

        public com.pulumi.core.Output<java.lang.String> whoisServer()
        Returns:
        The fully qualified name of the WHOIS server that can answer the WHOIS query for the domain.

      • get

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