Package com.pulumi.aws.memorydb

Class User

  • public class User
extends com.pulumi.resources.CustomResource
    Provides a MemoryDB User. More information about users and ACL-s can be found in the [MemoryDB User Guide](https://docs.aws.amazon.com/memorydb/latest/devguide/clusters.acls.html). > **Note:** All arguments including the username and passwords will be stored in the raw state as plain-text. ## Example Usage 
     
 package generated_program;
 
 import com.pulumi.Context;
 import com.pulumi.Pulumi;
 import com.pulumi.core.Output;
 import com.pulumi.random.Password;
 import com.pulumi.random.PasswordArgs;
 import com.pulumi.aws.memorydb.User;
 import com.pulumi.aws.memorydb.UserArgs;
 import com.pulumi.aws.memorydb.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 example = new Password("example", PasswordArgs.builder()
             .length(16)
             .build());
 
         var exampleUser = new User("exampleUser", UserArgs.builder()
             .authenticationMode(UserAuthenticationModeArgs.builder()
                 .type("password")
                 .passwords(example.result())
                 .build())
             .userName("my-user")
             .accessString("on ~* &* +@all")
             .build());
 
     }
 }
    ## Import Using `pulumi import`, import a user using the `userName`. For example: ```sh $ pulumi import aws:memorydb/user:User example my-user ``` The `passwords` are not available for imported resources, as this information cannot be read back from the MemoryDB API.

    • 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()  
      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.lang.String> minimumEngineVersion()  
      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> 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.

      • arn

        public com.pulumi.core.Output<java.lang.String> arn()
        Returns:
        ARN of the user. * `authentication_mode[0].password_count` - Number of passwords belonging to the user if `type` is set to `password`.

      • authenticationMode

        public com.pulumi.core.Output<UserAuthenticationMode> authenticationMode()
        Returns:
        Authentication properties for the user. Detailed below.

      • minimumEngineVersion

        public com.pulumi.core.Output<java.lang.String> minimumEngineVersion()
        Returns:
        Minimum engine version supported for the user.

      • 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:
        Map of tags to assign to the resource. 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:
        Map of tags assigned to the resource, including those inherited from the provider `defaultTags` configuration block.

      • userName

        public com.pulumi.core.Output<java.lang.String> userName()
        Returns:
        Name of the MemoryDB user. Up to 40 characters. 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.