Package com.pulumi.aws.elasticache

Class User

  • public class User
extends com.pulumi.resources.CustomResource
    Provides an ElastiCache user resource. > **Note:** All arguments including the username and passwords will be stored in the raw state as plain-text unless you use the write-only `passwordsWo` argument. ## 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 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("testUserName")
             .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());
 
     }
 }
 
 
     
 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.inputs.UserAuthenticationModeArgs;
 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()
             .authenticationMode(UserAuthenticationModeArgs.builder()
                 .type("iam")
                 .build())
             .userId("testuserid")
             .userName("testuserid")
             .accessString("on ~* +@all")
             .engine("redis")
             .build());
 
     }
 }
 
 
     
 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.inputs.UserAuthenticationModeArgs;
 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()
             .authenticationMode(UserAuthenticationModeArgs.builder()
                 .type("password")
                 .passwords(                
                     "password1",
                     "password2")
                 .build())
             .userId("testUserId")
             .userName("testUserName")
             .accessString("on ~* +@all")
             .engine("redis")
             .build());
 
     }
 }
    ### Using Write-Only Password (Terraform 1.11+) 
     
 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 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("testUserName")
             .accessString("on ~* +@all")
             .engine("redis")
             .passwordsWo(elasticachePassword)
             .passwordsWoVersion(1)
             .build());
 
     }
 }
    ## Import Using `pulumi import`, import ElastiCache users using the `userId`. For example: ```sh $ pulumi import aws:elasticache/user:User my_user userId1 ```

    • 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
      User​(java.lang.String name)  
      User​(java.lang.String name, UserArgs args)  
      User​(java.lang.String name, UserArgs 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> accessString()  
      com.pulumi.core.Output<java.lang.String> arn()  
      com.pulumi.core.Output<UserAuthenticationMode> authenticationMode()  
      com.pulumi.core.Output<java.lang.String> engine()  
      static User get​(java.lang.String name, com.pulumi.core.Output<java.lang.String> id, UserState 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.util.Optional<java.lang.Boolean>> noPasswordRequired()  
      com.pulumi.core.Output<java.util.Optional<java.util.List<java.lang.String>>> passwords()  
      com.pulumi.core.Output<java.util.Optional<java.lang.String>> passwordsWo()  
      com.pulumi.core.Output<java.util.Optional<java.lang.Integer>> passwordsWoVersion()  
      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> userId()  
      com.pulumi.core.Output<java.lang.String> userName()  

      • 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

      • User

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

      • User

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

      • User

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

      • accessString

        public com.pulumi.core.Output<java.lang.String> accessString()
        Returns:
        Access permissions string used for this user. See [Specifying Permissions Using an Access String](https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/Clusters.RBAC.html#Access-string) for more details.

      • arn

        public com.pulumi.core.Output<java.lang.String> arn()
        Returns:
        The ARN of the created ElastiCache User.

      • authenticationMode

        public com.pulumi.core.Output<UserAuthenticationMode> authenticationMode()
        Returns:
        Denotes the user's authentication properties. Detailed below.

      • engine

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

      • noPasswordRequired

        public com.pulumi.core.Output<java.util.Optional<java.lang.Boolean>> noPasswordRequired()
        Returns:
        Indicates a password is not required for this user.

      • passwords

        public com.pulumi.core.Output<java.util.Optional<java.util.List<java.lang.String>>> passwords()
        Returns:
        Passwords used for this user. You can create up to two passwords for each user.

      • passwordsWo

        public com.pulumi.core.Output<java.util.Optional<java.lang.String>> passwordsWo()
        Returns:
        **NOTE:** This field is write-only and its value will not be updated in state as part of read operations. Write-only password for this user. This argument is not stored in state. Conflicts with `passwords` and `authenticationMode`. If set, requires `passwordsWoVersion` to be set.

      • passwordsWoVersion

        public com.pulumi.core.Output<java.util.Optional<java.lang.Integer>> passwordsWoVersion()
        Returns:
        Required when `passwordsWo` is set. Changing this value triggers an update to `passwordsWo`.

      • 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:
        A list of tags to be added to this resource. A tag is a key-value pair.

      • tagsAll

        public com.pulumi.core.Output<java.util.Map<java.lang.String,​java.lang.String>> tagsAll()

      • userId

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

      • userName

        public com.pulumi.core.Output<java.lang.String> userName()
        Returns:
        The username of the user. For IAM authentication, this value must match `userId`. The following arguments are optional:

      • get

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