Package com.pulumi.aws.workmail

Class Organization

  • public class Organization
extends com.pulumi.resources.CustomResource
    Manages 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.Organization;
 import com.pulumi.aws.workmail.OrganizationArgs;
 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());
 
     }
 }
    ## Import ### Identity Schema #### Required * `organizationId` - (String) ID of the WorkMail Organization. #### Optional * `accountId` (String) AWS Account where this resource is managed. * `region` (String) Region where this resource is managed. Using `pulumi import`, import WorkMail Organization using the `organizationId`. For example: ```sh $ pulumi import aws:workmail/organization:Organization example m-xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx ``` > **NOTE:** The `kmsKeyArn`, `deleteDirectory`, and `deleteIdentityCenterApplication` attributes are not returned by the AWS API and will not be set after import. Add them back to your configuration manually if needed.

    • 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> arn()  
      com.pulumi.core.Output<java.lang.String> completedDate()  
      com.pulumi.core.Output<java.lang.String> defaultMailDomain()  
      com.pulumi.core.Output<java.util.Optional<java.lang.Boolean>> deleteDirectory()  
      com.pulumi.core.Output<java.util.Optional<java.lang.Boolean>> deleteIdentityCenterApplication()  
      com.pulumi.core.Output<java.lang.String> directoryId()  
      com.pulumi.core.Output<java.lang.String> directoryType()  
      static Organization get​(java.lang.String name, com.pulumi.core.Output<java.lang.String> id, OrganizationState 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> interoperabilityEnabled()  
      com.pulumi.core.Output<java.util.Optional<java.lang.String>> kmsKeyArn()  
      com.pulumi.core.Output<java.lang.String> migrationAdmin()  
      com.pulumi.core.Output<java.lang.String> organizationAlias()  
      com.pulumi.core.Output<java.lang.String> organizationId()  
      com.pulumi.core.Output<java.lang.String> region()  
      com.pulumi.core.Output<java.lang.String> state()  
      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.Optional<OrganizationTimeouts>> timeouts()  

      • 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

      • Organization

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

      • Organization

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

      • Organization

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

      • arn

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

      • completedDate

        public com.pulumi.core.Output<java.lang.String> completedDate()
        Returns:
        Date and time (RFC3339) at which the organization became active.

      • defaultMailDomain

        public com.pulumi.core.Output<java.lang.String> defaultMailDomain()
        Returns:
        Default mail domain for the organization.

      • deleteDirectory

        public com.pulumi.core.Output<java.util.Optional<java.lang.Boolean>> deleteDirectory()
        Returns:
        Whether to delete the AWS Directory Service directory associated with the organization on destroy. To update this value after creation, run `pulumi up` before running `terraform destroy`. Defaults to `false`.

      • deleteIdentityCenterApplication

        public com.pulumi.core.Output<java.util.Optional<java.lang.Boolean>> deleteIdentityCenterApplication()
        Returns:
        Whether to delete the IAM Identity Center application associated with the organization on destroy. To update this value after creation, run `pulumi up` before running `terraform destroy`. Defaults to `false`.

      • directoryId

        public com.pulumi.core.Output<java.lang.String> directoryId()
        Returns:
        ID of an existing directory to associate with the organization. Changing this creates a new resource.

      • directoryType

        public com.pulumi.core.Output<java.lang.String> directoryType()
        Returns:
        Type of the associated directory.

      • interoperabilityEnabled

        public com.pulumi.core.Output<java.lang.Boolean> interoperabilityEnabled()
        Returns:
        Whether to enable interoperability between WorkMail and Microsoft Exchange. Changing this creates a new resource.

      • kmsKeyArn

        public com.pulumi.core.Output<java.util.Optional<java.lang.String>> kmsKeyArn()
        Returns:
        ARN of a customer-managed KMS key to encrypt the organization's data. If omitted, AWS managed keys are used. Changing this creates a new resource.

      • migrationAdmin

        public com.pulumi.core.Output<java.lang.String> migrationAdmin()
        Returns:
        User ID of the migration admin if migration is enabled.

      • organizationAlias

        public com.pulumi.core.Output<java.lang.String> organizationAlias()
        Returns:
        Alias for the organization. Must be unique globally. Changing this creates a new resource. The following arguments are optional:

      • organizationId

        public com.pulumi.core.Output<java.lang.String> organizationId()
        Returns:
        ID of the WorkMail Organization.

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

      • state

        public com.pulumi.core.Output<java.lang.String> state()
        Returns:
        State of the organization.

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

      • get

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