Package com.pulumi.aws.identitystore

Class GroupMembership

  • public class GroupMembership
extends com.pulumi.resources.CustomResource
    Resource for managing an AWS IdentityStore Group Membership. ## Example Usage 
     
 package generated_program;
 
 import com.pulumi.Context;
 import com.pulumi.Pulumi;
 import com.pulumi.core.Output;
 import com.pulumi.aws.ssoadmin.SsoadminFunctions;
 import com.pulumi.aws.ssoadmin.inputs.GetInstancesArgs;
 import com.pulumi.aws.identitystore.User;
 import com.pulumi.aws.identitystore.UserArgs;
 import com.pulumi.aws.identitystore.inputs.UserNameArgs;
 import com.pulumi.aws.identitystore.Group;
 import com.pulumi.aws.identitystore.GroupArgs;
 import com.pulumi.aws.identitystore.GroupMembership;
 import com.pulumi.aws.identitystore.GroupMembershipArgs;
 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) {
         final var example = SsoadminFunctions.getInstances(GetInstancesArgs.builder()
             .build());
 
         var exampleUser = new User("exampleUser", UserArgs.builder()
             .name(UserNameArgs.builder()
                 .familyName("Doe")
                 .givenName("John")
                 .build())
             .identityStoreId(example.identityStoreIds()[0])
             .displayName("John Doe")
             .userName("john.doe@example.com")
             .build());
 
         var exampleGroup = new Group("exampleGroup", GroupArgs.builder()
             .identityStoreId(example.identityStoreIds()[0])
             .displayName("MyGroup")
             .description("Some group name")
             .build());
 
         var exampleGroupMembership = new GroupMembership("exampleGroupMembership", GroupMembershipArgs.builder()
             .identityStoreId(example.identityStoreIds()[0])
             .groupId(exampleGroup.groupId())
             .memberId(exampleUser.userId())
             .build());
 
     }
 }
    ## Import Using `pulumi import`, import `aws.identitystore.GroupMembership` using the `identity_store_id/membership_id`. For example: ```sh $ pulumi import aws:identitystore/groupMembership:GroupMembership example d-0000000000/00000000-0000-0000-0000-000000000000 ```

    • 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
      static GroupMembership get​(java.lang.String name, com.pulumi.core.Output<java.lang.String> id, GroupMembershipState 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.String> identityStoreId()  
      com.pulumi.core.Output<java.lang.String> memberId()  
      com.pulumi.core.Output<java.lang.String> membershipId()  
      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

      • GroupMembership

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

      • GroupMembership

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

      • GroupMembership

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

      • groupId

        public com.pulumi.core.Output<java.lang.String> groupId()
        Returns:
        The identifier for a group in the Identity Store.

      • identityStoreId

        public com.pulumi.core.Output<java.lang.String> identityStoreId()
        Returns:
        Identity Store ID associated with the Single Sign-On Instance.

      • memberId

        public com.pulumi.core.Output<java.lang.String> memberId()
        Returns:
        The identifier for a user in the Identity Store.

      • membershipId

        public com.pulumi.core.Output<java.lang.String> membershipId()
        Returns:
        The identifier of the newly created group membership in the Identity Store.

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