Package com.pulumi.aws.workmail

Class DefaultDomain

  • public class DefaultDomain
extends com.pulumi.resources.CustomResource
    Manages the default mail domain for an AWS WorkMail organization. > **NOTE:** This does not register a domain for WorkMail. This resource requires a verified domain name to be used as default domain for 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.Organization;
 import com.pulumi.aws.workmail.OrganizationArgs;
 import com.pulumi.aws.workmail.DefaultDomain;
 import com.pulumi.aws.workmail.DefaultDomainArgs;
 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 Organization("example", OrganizationArgs.builder()
             .organizationAlias("example-org")
             .build());
 
         var exampleDefaultDomain = new DefaultDomain("exampleDefaultDomain", DefaultDomainArgs.builder()
             .organizationId(example.id())
             .domainName(example.defaultMailDomain())
             .build());
 
     }
 }
    ## Import ### Identity Schema #### Required * `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 Default Domain using the organization ID. For example: ```sh $ pulumi import aws:workmail/defaultDomain:DefaultDomain example "m-1234567890abcdef0" ```

    • 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> domainName()  
      static DefaultDomain get​(java.lang.String name, com.pulumi.core.Output<java.lang.String> id, DefaultDomainState 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> organizationId()  
      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

      • DefaultDomain

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

      • DefaultDomain

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

      • DefaultDomain

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

      • domainName

        public com.pulumi.core.Output<java.lang.String> domainName()
        Returns:
        Mail domain name to set as the default.

      • organizationId

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

      • 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 DefaultDomain get​(java.lang.String name,
                                com.pulumi.core.Output<java.lang.String> id,
                                @Nullable
                                DefaultDomainState 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.