Package com.pulumi.aws.workmail

Class Domain

  • public class Domain
extends com.pulumi.resources.CustomResource
    Manages a mail domain registered to an AWS WorkMail organization. ## Example Usage ### Basic Usage 
     
 package generated_program;
 
 import com.pulumi.Context;
 import com.pulumi.Pulumi;
 import com.pulumi.core.Output;
 import com.pulumi.aws.workmail.Domain;
 import com.pulumi.aws.workmail.DomainArgs;
 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()
             .organizationId(exampleAwsWorkmailOrganization.id())
             .domainName("example.com")
             .build());
 
     }
 }
    ## Import ### Identity Schema #### Required * `domainName` (String) Mail domain name. * `organizationId` (String) Identifier of the WorkMail organization. #### Optional * `accountId` (String) Account ID where this resource is managed. * `region` (String) Region where this resource is managed. Using `pulumi import`, import WorkMail Domain using `organization_id,domain_name`. For example: ```sh $ pulumi import aws:workmail/domain:Domain example "m-1234567890abcdef0,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> dkimVerificationStatus()  
      com.pulumi.core.Output<java.lang.String> domainName()  
      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.Boolean> isDefault()  
      com.pulumi.core.Output<java.lang.Boolean> isTestDomain()  
      com.pulumi.core.Output<java.lang.String> organizationId()  
      com.pulumi.core.Output<java.lang.String> ownershipVerificationStatus()  
      com.pulumi.core.Output<java.util.List<DomainRecord>> records()  
      com.pulumi.core.Output<java.lang.String> region()  

      • 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

      • dkimVerificationStatus

        public com.pulumi.core.Output<java.lang.String> dkimVerificationStatus()
        Returns:
        DKIM verification status. Values: `PENDING`, `VERIFIED`, `FAILED`.

      • domainName

        public com.pulumi.core.Output<java.lang.String> domainName()
        Returns:
        Mail domain name to register. Changing this forces a new resource.

      • isDefault

        public com.pulumi.core.Output<java.lang.Boolean> isDefault()
        Returns:
        Whether this domain is the default mail domain for the organization.

      • isTestDomain

        public com.pulumi.core.Output<java.lang.Boolean> isTestDomain()
        Returns:
        Whether this is the auto-provisioned test domain.

      • organizationId

        public com.pulumi.core.Output<java.lang.String> organizationId()
        Returns:
        Identifier of the WorkMail organization. Changing this forces a new resource.

      • ownershipVerificationStatus

        public com.pulumi.core.Output<java.lang.String> ownershipVerificationStatus()
        Returns:
        Domain ownership verification status. Values: `PENDING`, `VERIFIED`, `FAILED`.

      • records

        public com.pulumi.core.Output<java.util.List<DomainRecord>> records()
        Returns:
        List of DNS records required for domain verification. See `records` Block below.

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

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