Package software.amazon.awscdk.services.elasticache

Interface CfnUserProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnUserProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.120.0 (build 192dc88)",
           date="2025-12-05T22:26:36.429Z")
@Stability(Stable)
public interface CfnUserProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a CfnUser.

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;
 CfnUserProps cfnUserProps = CfnUserProps.builder()
         .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:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticache-user.html

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnUserProps.Builder	A builder for CfnUserProps
static final class	CfnUserProps.Jsii$Proxy	An implementation for CfnUserProps

Method Summary

Modifier and Type	Method	Description
static CfnUserProps.Builder	builder()
default String	getAccessString()	Access permissions string used for this user.
default Object	getAuthenticationMode()	Specifies the authentication mode to use.
String	getEngine()	The current supported values are valkey and redis.
default Object	getNoPasswordRequired()	Indicates a password is not required for this user.
default List<String>	getPasswords()	Passwords used for this user.
default List<CfnTag>	getTags()	The list of tags.
String	getUserId()	The ID of the user.
String	getUserName()	The username of the user.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getEngine

@Stability(Stable)
@NotNull
String getEngine()

The current supported values are valkey and redis.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticache-user.html#cfn-elasticache-user-engine

getUserId

@Stability(Stable)
@NotNull
String getUserId()

The ID of the user.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticache-user.html#cfn-elasticache-user-userid

getUserName

@Stability(Stable)
@NotNull
String getUserName()

The username of the user.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticache-user.html#cfn-elasticache-user-username

getAccessString

@Stability(Stable)
@Nullable
default String getAccessString()

Access permissions string used for this user.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticache-user.html#cfn-elasticache-user-accessstring

getAuthenticationMode

@Stability(Stable)
@Nullable
default Object getAuthenticationMode()

Specifies the authentication mode to use. Below is an example of the possible JSON values:.

 { Passwords: ["*****", "******"] // If Type is password.
 }
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticache-user.html#cfn-elasticache-user-authenticationmode

getNoPasswordRequired

@Stability(Stable)
@Nullable
default Object getNoPasswordRequired()

Indicates a password is not required for this user.

Returns union: either Boolean or IResolvable

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticache-user.html#cfn-elasticache-user-nopasswordrequired

getPasswords

@Stability(Stable)
@Nullable
default List<String> getPasswords()

Passwords used for this user.

You can create up to two passwords for each user.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticache-user.html#cfn-elasticache-user-passwords

getTags

@Stability(Stable)
@Nullable
default List<CfnTag> getTags()

The list of tags.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticache-user.html#cfn-elasticache-user-tags

builder

@Stability(Stable)
static CfnUserProps.Builder builder()

Returns:

a CfnUserProps.Builder of CfnUserProps