Package com.pulumi.aws.elasticache

Class UserGroup

  • public class UserGroup
extends com.pulumi.resources.CustomResource
    Provides an ElastiCache user group resource. ## 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 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 test = new User("test", UserArgs.builder()
             .userId("testUserId")
             .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 testUserGroup = new UserGroup("testUserGroup", UserGroupArgs.builder()
             .engine("redis")
             .userGroupId("userGroupId")
             .userIds(test.userId())
             .build());
 
     }
 }
    ## Import Using `pulumi import`, import ElastiCache user groups using the `userGroupId`. For example: ```sh $ pulumi import aws:elasticache/userGroup:UserGroup my_user_group userGoupId1 ```

    • 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
      UserGroup​(java.lang.String name)  
      UserGroup​(java.lang.String name, UserGroupArgs args)  
      UserGroup​(java.lang.String name, UserGroupArgs 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> arn()  
      com.pulumi.core.Output<java.lang.String> engine()  
      static UserGroup get​(java.lang.String name, com.pulumi.core.Output<java.lang.String> id, UserGroupState 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.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.lang.String> userGroupId()  
      com.pulumi.core.Output<java.util.Optional<java.util.List<java.lang.String>>> userIds()  

      • 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

      • UserGroup

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

      • UserGroup

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

      • UserGroup

        public UserGroup​(java.lang.String name,
                 UserGroupArgs 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:
        The ARN that identifies the user group.

      • engine

        public com.pulumi.core.Output<java.lang.String> engine()
        Returns:
        The current supported value are `redis`, `valkey` (case insensitive).

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

      • tags

        public com.pulumi.core.Output<java.util.Optional<java.util.Map<java.lang.String,​java.lang.String>>> tags()
        Returns:
        Key-value map of resource tags. 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.

      • userGroupId

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

      • userIds

        public com.pulumi.core.Output<java.util.Optional<java.util.List<java.lang.String>>> userIds()
        Returns:
        The list of user IDs that belong to the user group.

      • get

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