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.84.0 (build 5404dcf)",
           date="2023-06-19T16:29:56.513Z")
@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();
 

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 value is 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()	AWS::ElastiCache::User.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 value is redis.

getUserId

@Stability(Stable)
@NotNull
String getUserId()

The ID of the user.

getUserName

@Stability(Stable)
@NotNull
String getUserName()

The username of the user.

getAccessString

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

Access permissions string used for this user.

getAuthenticationMode

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

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

 { Type: <iam | no-password-required | password> Passwords: ["*****", "******"] // If Type is password.
 }
 

getNoPasswordRequired

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

Indicates a password is not required for this user.

getPasswords

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

Passwords used for this user.

You can create up to two passwords for each user.

getTags

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

AWS::ElastiCache::User.Tags.

builder

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

Returns:

a CfnUserProps.Builder of CfnUserProps