Package com.pulumi.aws.elasticache

Class UserGroupAssociation

  • public class UserGroupAssociation
extends com.pulumi.resources.CustomResource
    Associate an existing ElastiCache user and an existing user group. > Pulumi will detect changes in the `aws.elasticache.UserGroup` since `aws.elasticache.UserGroupAssociation` changes the user IDs associated with the user group. You can ignore these changes with the `lifecycle` `ignoreChanges` meta argument as shown in the example. ## Example Usage 
     
 package generated_program;
 
 import com.pulumi.Context;
 import com.pulumi.Pulumi;
 import com.pulumi.core.Output;
 import com.pulumi.aws.elasticache.User;
 import com.pulumi.aws.elasticache.UserArgs;
 import com.pulumi.aws.elasticache.UserGroup;
 import com.pulumi.aws.elasticache.UserGroupArgs;
 import com.pulumi.aws.elasticache.UserGroupAssociation;
 import com.pulumi.aws.elasticache.UserGroupAssociationArgs;
 import com.pulumi.resources.CustomResourceOptions;
 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 default_ = new User("default", UserArgs.builder()
             .userId("defaultUserID")
             .userName("default")
             .accessString("on ~app::* -@all +@read +@hash +@bitmap +@geo -setbit -bitfield -hset -hsetnx -hmset -hincrby -hincrbyfloat -hdel -bitop -geoadd -georadius -georadiusbymember")
             .engine("REDIS")
             .passwords("password123456789")
             .build());
 
         var example = new UserGroup("example", UserGroupArgs.builder()
             .engine("REDIS")
             .userGroupId("userGroupId")
             .userIds(default_.userId())
             .build(), CustomResourceOptions.builder()
                 .ignoreChanges("userIds")
                 .build());
 
         var exampleUser = new User("exampleUser", UserArgs.builder()
             .userId("exampleUserID")
             .userName("exampleuser")
             .accessString("on ~app::* -@all +@read +@hash +@bitmap +@geo -setbit -bitfield -hset -hsetnx -hmset -hincrby -hincrbyfloat -hdel -bitop -geoadd -georadius -georadiusbymember")
             .engine("REDIS")
             .passwords("password123456789")
             .build());
 
         var exampleUserGroupAssociation = new UserGroupAssociation("exampleUserGroupAssociation", UserGroupAssociationArgs.builder()
             .userGroupId(example.userGroupId())
             .userId(exampleUser.userId())
             .build());
 
     }
 }
    ## Import Using `pulumi import`, import ElastiCache user group associations using the `userGroupId` and `userId`. For example: ```sh $ pulumi import aws:elasticache/userGroupAssociation:UserGroupAssociation example userGoupId1,userId ```

    • 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 UserGroupAssociation get​(java.lang.String name, com.pulumi.core.Output<java.lang.String> id, UserGroupAssociationState 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> region()  
      com.pulumi.core.Output<java.lang.String> userGroupId()  
      com.pulumi.core.Output<java.lang.String> userId()  

      • 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

      • UserGroupAssociation

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

      • UserGroupAssociation

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

      • UserGroupAssociation

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

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

      • userGroupId

        public com.pulumi.core.Output<java.lang.String> userGroupId()
        Returns:
        ID of the user group.

      • userId

        public com.pulumi.core.Output<java.lang.String> userId()
        Returns:
        ID of the user to associated with the user group.

      • get

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