Package com.pulumi.aws.directoryservicedata

Class Group

  • public class Group
extends com.pulumi.resources.CustomResource
    Manages a group in an AWS Directory Service directory. ## Example Usage ### Basic Usage The following example assumes an existing Directory Service directory with Directory Service Data access enabled. 
     
 package generated_program;
 
 import com.pulumi.Context;
 import com.pulumi.Pulumi;
 import com.pulumi.core.Output;
 import com.pulumi.aws.directoryservicedata.Group;
 import com.pulumi.aws.directoryservicedata.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 Group("example", GroupArgs.builder()
             .directoryId("d-1234567890")
             .samAccountName("examplegroup")
             .groupScope("Global")
             .groupType("Security")
             .build());
 
     }
 }
    ## Import ### Identity Schema #### Required * `directoryId` (String) ID of the Directory Service directory where the group is managed. * `samAccountName` (String) SAM account name of the group. #### Optional * `accountId` (String) AWS Account where this resource is managed. * `region` (String) Region where this resource is managed. Using `pulumi import`, import Directory Service Data Group using the directory ID and SAM account name separated by a comma. For example: ```sh $ pulumi import aws:directoryservicedata/group:Group example d-1234567890,example-group ```

    • 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> directoryId()  
      com.pulumi.core.Output<java.lang.String> distinguishedName()  
      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> groupScope()  
      com.pulumi.core.Output<java.lang.String> groupType()  
      com.pulumi.core.Output<java.lang.String> region()  
      com.pulumi.core.Output<java.lang.String> samAccountName()  
      com.pulumi.core.Output<java.lang.String> sid()  

      • 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

      • directoryId

        public com.pulumi.core.Output<java.lang.String> directoryId()
        Returns:
        ID of the Directory that's associated with the group.

      • distinguishedName

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

      • groupScope

        public com.pulumi.core.Output<java.lang.String> groupScope()
        Returns:
        Scope of the AD group. Valid values are `DomainLocal`, `Global`, `Universal`, and `BuiltinLocal`. If omitted, the value is read from AWS. See [AD group scopes](https://learn.microsoft.com/en-us/windows-server/identity/ad-ds/manage/understand-security-groups#group-scope) for scope restrictions.

      • groupType

        public com.pulumi.core.Output<java.lang.String> groupType()
        Returns:
        Type of the AD group. Valid values are `Distribution` and `Security`. If omitted, the value is read from AWS. See [AD group types](https://learn.microsoft.com/en-us/windows-server/identity/ad-ds/manage/understand-security-groups#how-active-directory-security-groups-work).

      • region

        public com.pulumi.core.Output<java.lang.String> region()
        Returns:
        Region where the group is managed. Defaults to the provider region. Changes to `groupScope` and `groupType` in the same apply are sent to AWS as separate requests, with the scope updated first.

      • samAccountName

        public com.pulumi.core.Output<java.lang.String> samAccountName()
        Returns:
        SAM account name of the group. Must be between 1 and 64 characters and must not contain any of the following characters: `: ; | = + " * ? < > / \ , [ ] @`. The following arguments are optional:

      • sid

        public com.pulumi.core.Output<java.lang.String> sid()
        Returns:
        Unique Security identifier (SID) 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.