Package software.amazon.awscdk.services.elasticache

Class CfnUser

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.CfnElement
software.amazon.awscdk.CfnRefElement
software.amazon.awscdk.CfnResource
software.amazon.awscdk.services.elasticache.CfnUser
All Implemented Interfaces:
IInspectable, IUserRef, IEnvironmentAware, ITaggable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable
@Generated(value="jsii-pacmak/1.120.0 (build 192dc88)", date="2025-12-05T22:26:36.425Z") @Stability(Stable) public class CfnUser extends CfnResource implements IInspectable, IUserRef, ITaggable
For Valkey 7.2 and onwards, or Redis OSS engine version 6.0 and onwards: Creates user. For more information, see Using Role Based Access Control (RBAC) .

Example: 

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.elasticache.*;
 Object authenticationMode;
 CfnUser cfnUser = CfnUser.Builder.create(this, "MyCfnUser")
         .engine("engine")
         .userId("userId")
         .userName("userName")
         // the properties below are optional
         .accessString("accessString")
         .authenticationMode(authenticationMode)
         .noPasswordRequired(false)
         .passwords(List.of("passwords"))
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build();

See Also:

  • Field Details

    • CFN_RESOURCE_TYPE_NAME

      @Stability(Stable) public static final String CFN_RESOURCE_TYPE_NAME
      The CloudFormation resource type name for this resource class.

  • Constructor Details

    • CfnUser

      protected CfnUser(software.amazon.jsii.JsiiObjectRef objRef)

    • CfnUser

      protected CfnUser(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

    • CfnUser

      @Stability(Stable) public CfnUser(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull CfnUserProps props)
      Create a new AWS::ElastiCache::User.

      Parameters:
      scope - Scope in which this resource is defined. This parameter is required.
      id - Construct identifier for this resource (unique in its scope). This parameter is required.
      props - Resource properties. This parameter is required.

  • Method Details

    • arnForUser

      @Stability(Stable) @NotNull public static String arnForUser(@NotNull IUserRef resource)
      Parameters:
      resource - This parameter is required.

    • fromUserArn

      @Stability(Stable) @NotNull public static IUserRef fromUserArn(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull String arn)
      Creates a new IUserRef from an ARN.

      Parameters:
      scope - This parameter is required.
      id - This parameter is required.
      arn - This parameter is required.

    • fromUserId

      @Stability(Stable) @NotNull public static IUserRef fromUserId(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull String userId)
      Creates a new IUserRef from a userId.

      Parameters:
      scope - This parameter is required.
      id - This parameter is required.
      userId - This parameter is required.

    • isCfnUser

      @Stability(Stable) @NotNull public static Boolean isCfnUser(@NotNull Object x)
      Checks whether the given object is a CfnUser.

      Parameters:
      x - This parameter is required.

    • inspect

      @Stability(Stable) public void inspect(@NotNull TreeInspector inspector)
      Examines the CloudFormation resource and discloses attributes.

      Specified by:
      inspect in interface IInspectable
      Parameters:
      inspector - tree inspector to collect and process attributes. This parameter is required.

    • renderProperties

      @Stability(Stable) @NotNull protected Map<String,Object> renderProperties(@NotNull Map<String,Object> props)
      Overrides:
      renderProperties in class CfnResource
      Parameters:
      props - This parameter is required.

    • getAttrArn

      @Stability(Stable) @NotNull public String getAttrArn()
      The Amazon Resource Name (ARN) of the user.

    • getAttrStatus

      @Stability(Stable) @NotNull public String getAttrStatus()
      Indicates the user status.

      Can be "active", "modifying" or "deleting".

    • getCfnProperties

      @Stability(Stable) @NotNull protected Map<String,Object> getCfnProperties()
      Overrides:
      getCfnProperties in class CfnResource

    • getTags

      @Stability(Stable) @NotNull public TagManager getTags()
      Tag Manager which manages the tags for this resource.
      Specified by:
      getTags in interface ITaggable

    • getUserRef

      @Stability(Stable) @NotNull public UserReference getUserRef()
      A reference to a User resource.
      Specified by:
      getUserRef in interface IUserRef

    • getEngine

      @Stability(Stable) @NotNull public String getEngine()
      The current supported values are valkey and redis.

    • setEngine

      @Stability(Stable) public void setEngine(@NotNull String value)
      The current supported values are valkey and redis.

    • getUserId

      @Stability(Stable) @NotNull public String getUserId()
      The ID of the user.

    • setUserId

      @Stability(Stable) public void setUserId(@NotNull String value)
      The ID of the user.

    • getUserName

      @Stability(Stable) @NotNull public String getUserName()
      The username of the user.

    • setUserName

      @Stability(Stable) public void setUserName(@NotNull String value)
      The username of the user.

    • getAccessString

      @Stability(Stable) @Nullable public String getAccessString()
      Access permissions string used for this user.

    • setAccessString

      @Stability(Stable) public void setAccessString(@Nullable String value)
      Access permissions string used for this user.

    • getAuthenticationMode

      @Stability(Stable) @Nullable public Object getAuthenticationMode()
      Specifies the authentication mode to use.

      Below is an example of the possible JSON values:.

    • setAuthenticationMode

      @Stability(Stable) public void setAuthenticationMode(@Nullable Object value)
      Specifies the authentication mode to use.

      Below is an example of the possible JSON values:.

    • getNoPasswordRequired

      @Stability(Stable) @Nullable public Object getNoPasswordRequired()
      Indicates a password is not required for this user.

      Returns union: either Boolean or IResolvable

    • setNoPasswordRequired

      @Stability(Stable) public void setNoPasswordRequired(@Nullable Boolean value)
      Indicates a password is not required for this user.

    • setNoPasswordRequired

      @Stability(Stable) public void setNoPasswordRequired(@Nullable IResolvable value)
      Indicates a password is not required for this user.

    • getPasswords

      @Stability(Stable) @Nullable public List<String> getPasswords()
      Passwords used for this user.

    • setPasswords

      @Stability(Stable) public void setPasswords(@Nullable List<String> value)
      Passwords used for this user.

    • getTagsRaw

      @Stability(Stable) @Nullable public List<CfnTag> getTagsRaw()
      The list of tags.

    • setTagsRaw

      @Stability(Stable) public void setTagsRaw(@Nullable List<CfnTag> value)
      The list of tags.