Package com.pulumi.aws.workmail

Class Group

  • public class Group
extends com.pulumi.resources.CustomResource
    Manages an AWS WorkMail Group. ## Example 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.Group;
 import com.pulumi.aws.workmail.GroupArgs;
 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-workmail-org")
             .deleteDirectory(true)
             .build());
 
         var exampleGroup = new Group("exampleGroup", GroupArgs.builder()
             .organizationId(example.organizationId())
             .email(example.defaultMailDomain().applyValue(_defaultMailDomain -> String.format("engineering@%s", _defaultMailDomain)))
             .name("engineering")
             .build());
 
     }
 }
    ## Import ### Identity Schema #### Required * `groupId` - Identifier of the group. * `organizationId` - Identifier of the WorkMail organization where the group is managed. #### Optional * `accountId` (String) AWS account where this resource is managed. * `region` (String) Region where this resource is managed. Using `pulumi import`, import WorkMail Group using `organization_id,group_id`. For example: ```sh $ pulumi import aws:workmail/group:Group example m-1234567890abcdef,S-1-1-12-1234567890-123456789-123456789-1234 ```

    • 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
      Group​(java.lang.String name)  
      Group​(java.lang.String name, GroupArgs args)  
      Group​(java.lang.String name, GroupArgs 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> disabledDate()  
      com.pulumi.core.Output<java.lang.String> email()  
      com.pulumi.core.Output<java.lang.String> enabledDate()  
      static Group get​(java.lang.String name, com.pulumi.core.Output<java.lang.String> id, GroupState 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> groupId()  
      com.pulumi.core.Output<java.lang.Boolean> hiddenFromGlobalAddressList()  
      com.pulumi.core.Output<java.lang.String> name()  
      com.pulumi.core.Output<java.lang.String> organizationId()  
      com.pulumi.core.Output<java.lang.String> region()  
      com.pulumi.core.Output<java.lang.String> state()  

      • 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

      • Group

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

      • Group

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

      • Group

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

      • disabledDate

        public com.pulumi.core.Output<java.lang.String> disabledDate()
        Returns:
        Timestamp when the group was disabled from WorkMail use.

      • email

        public com.pulumi.core.Output<java.lang.String> email()
        Returns:
        Primary email address used to register the group with WorkMail.

      • enabledDate

        public com.pulumi.core.Output<java.lang.String> enabledDate()
        Returns:
        Timestamp when the group was enabled for WorkMail use.

      • groupId

        public com.pulumi.core.Output<java.lang.String> groupId()
        Returns:
        Identifier of the group.

      • hiddenFromGlobalAddressList

        public com.pulumi.core.Output<java.lang.Boolean> hiddenFromGlobalAddressList()
        Returns:
        Whether to hide the group from the global address list.

      • name

        public com.pulumi.core.Output<java.lang.String> name()
        Returns:
        Name of the group.

      • organizationId

        public com.pulumi.core.Output<java.lang.String> organizationId()
        Returns:
        Identifier of the WorkMail organization where the group is managed. The following arguments are optional:

      • 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:
        Current WorkMail state of the group.

      • get

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