Package software.amazon.awscdk.services.elasticache

Class CfnUser.Builder

java.lang.Object

software.amazon.awscdk.services.elasticache.CfnUser.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnUser>

Enclosing class:

CfnUser

@Stability(Stable)
public static final class CfnUser.Builder
extends Object
implements software.amazon.jsii.Builder<CfnUser>

A fluent builder for CfnUser.

Method Summary

Modifier and Type	Method	Description
CfnUser.Builder	accessString(String accessString)	Access permissions string used for this user.
CfnUser.Builder	authenticationMode(Object authenticationMode)	Specifies the authentication mode to use.
CfnUser	build()
static CfnUser.Builder	create(software.constructs.Construct scope, String id)
CfnUser.Builder	engine(String engine)	The current supported values are valkey and redis.
CfnUser.Builder	noPasswordRequired(Boolean noPasswordRequired)	Indicates a password is not required for this user.
CfnUser.Builder	noPasswordRequired(IResolvable noPasswordRequired)	Indicates a password is not required for this user.
CfnUser.Builder	passwords(List<String> passwords)	Passwords used for this user.
CfnUser.Builder	tags(List<? extends CfnTag> tags)	The list of tags.
CfnUser.Builder	userId(String userId)	The ID of the user.
CfnUser.Builder	userName(String userName)	The username of the user.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details

create

@Stability(Stable)
public static CfnUser.Builder create(software.constructs.Construct scope,
 String id)

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.

Returns:

a new instance of CfnUser.Builder.

engine

@Stability(Stable)
public CfnUser.Builder engine(String engine)

The current supported values are valkey and redis.

Parameters:

engine - The current supported values are valkey and redis. This parameter is required.

Returns:

this

See Also:

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

userId

@Stability(Stable)
public CfnUser.Builder userId(String userId)

The ID of the user.

Parameters:

userId - The ID of the user. This parameter is required.

Returns:

this

See Also:

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

userName

@Stability(Stable)
public CfnUser.Builder userName(String userName)

The username of the user.

Parameters:

userName - The username of the user. This parameter is required.

Returns:

this

See Also:

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

accessString

@Stability(Stable)
public CfnUser.Builder accessString(String accessString)

Access permissions string used for this user.

Parameters:

accessString - Access permissions string used for this user. This parameter is required.

Returns:

this

See Also:

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

authenticationMode

@Stability(Stable)
public CfnUser.Builder authenticationMode(Object authenticationMode)

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

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

Parameters:

authenticationMode - Specifies the authentication mode to use. Below is an example of the possible JSON values:. This parameter is required.

Returns:

this

See Also:

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

noPasswordRequired

@Stability(Stable)
public CfnUser.Builder noPasswordRequired(Boolean noPasswordRequired)

Indicates a password is not required for this user.

Parameters:

noPasswordRequired - Indicates a password is not required for this user. This parameter is required.

Returns:

this

See Also:

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

noPasswordRequired

@Stability(Stable)
public CfnUser.Builder noPasswordRequired(IResolvable noPasswordRequired)

Indicates a password is not required for this user.

Parameters:

noPasswordRequired - Indicates a password is not required for this user. This parameter is required.

Returns:

this

See Also:

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

passwords

@Stability(Stable)
public CfnUser.Builder passwords(List<String> passwords)

Passwords used for this user.

You can create up to two passwords for each user.

Parameters:

passwords - Passwords used for this user. This parameter is required.

Returns:

this

See Also:

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

tags

@Stability(Stable)
public CfnUser.Builder tags(List<? extends CfnTag> tags)

The list of tags.

Parameters:

tags - The list of tags. This parameter is required.

Returns:

this

See Also:

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

build

@Stability(Stable)
public CfnUser build()

Specified by:

build in interface software.amazon.jsii.Builder<CfnUser>

Returns:

a newly built instance of CfnUser.