Package software.amazon.awscdk.cfnpropertymixins.services.elasticache

Interface CfnUserMixinProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnUserMixinProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.127.0 (build 2117ad5)",
           date="2026-03-11T13:19:59.135Z")
@Stability(Stable)
public interface CfnUserMixinProps
extends software.amazon.jsii.JsiiSerializable

Properties for CfnUserPropsMixin.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.cfnpropertymixins.services.elasticache.*;
 Object authenticationMode;
 CfnUserMixinProps cfnUserMixinProps = CfnUserMixinProps.builder()
         .accessString("accessString")
         .authenticationMode(authenticationMode)
         .engine("engine")
         .noPasswordRequired(false)
         .passwords(List.of("passwords"))
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .userId("userId")
         .userName("userName")
         .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	CfnUserMixinProps.Builder	A builder for CfnUserMixinProps
static final class	CfnUserMixinProps.Jsii$Proxy	An implementation for CfnUserMixinProps

Method Summary

Modifier and Type	Method	Description
static CfnUserMixinProps.Builder	builder()
default String	getAccessString()	Access permissions string used for this user.
default Object	getAuthenticationMode()	Specifies the authentication mode to use.
default 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.
default String	getUserId()	The ID of the user.
default String	getUserName()	The username of the user.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

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

getEngine

@Stability(Stable)
@Nullable
default 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

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

getUserId

@Stability(Stable)
@Nullable
default 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)
@Nullable
default 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

builder

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

Returns:

a CfnUserMixinProps.Builder of CfnUserMixinProps