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, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.67.0 (build 2c027f5)",
           date="2022-09-19T20:26:39.012Z")
 @Stability(value=Stable)
public class CfnUser
extends CfnResource
implements IInspectable

A CloudFormation `AWS::ElastiCache::User`.

For Redis engine version 6.0 onwards: Creates a Redis 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.*;
 CfnUser cfnUser = CfnUser.Builder.create(this, "MyCfnUser")
         .engine("engine")
         .userId("userId")
         .userName("userName")
         // the properties below are optional
         .accessString("accessString")
         .noPasswordRequired(false)
         .passwords(List.of("passwords"))
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CfnUser.Builder A fluent builder for CfnUser.

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.amazon.awscdk.IInspectable

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.constructs.IConstruct

software.constructs.IConstruct.Jsii$Default

Field Summary

Fields

Modifier and Type	Field and Description
static String	CFN_RESOURCE_TYPE_NAME The CloudFormation resource type name for this resource class.

Constructor Summary

Constructors

Modifier	Constructor and Description
	CfnUser(software.constructs.Construct scope, String id, CfnUserProps props) Create a new `AWS::ElastiCache::User`.
protected	CfnUser(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnUser(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
String	getAccessString() Access permissions string used for this user.
String	getAttrArn() The Amazon Resource Name (ARN) of the user.
String	getAttrStatus() Indicates the user status.
protected Map<String,Object>	getCfnProperties()
String	getEngine() The current supported value is redis.
Object	getNoPasswordRequired() Indicates a password is not required for this user.
List<String>	getPasswords() Passwords used for this user.
String	getUserId() The ID of the user.
String	getUserName() The username of the user.
void	inspect(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.
protected Map<String,Object>	renderProperties(Map<String,Object> props)
void	setAccessString(String value) Access permissions string used for this user.
void	setEngine(String value) The current supported value is redis.
void	setNoPasswordRequired(Boolean value) Indicates a password is not required for this user.
void	setNoPasswordRequired(IResolvable value) Indicates a password is not required for this user.
void	setPasswords(List<String> value) Passwords used for this user.
void	setUserId(String value) The ID of the user.
void	setUserName(String value) The username of the user.

Methods inherited from class software.amazon.awscdk.CfnResource

addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, getUpdatedProperties, isCfnResource, shouldSynthesize, toString, validateProperties

Methods inherited from class software.amazon.awscdk.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.constructs.Construct

getNode, isConstruct

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

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

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Field Detail

CFN_RESOURCE_TYPE_NAME

@Stability(value=Stable)
public static final String CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

Constructor Detail

CfnUser

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

CfnUser

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

CfnUser

@Stability(value=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 - - scoped id of the resource. This parameter is required.

props - - resource properties. This parameter is required.

Method Detail

inspect

@Stability(value=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(value=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(value=Stable)
 @NotNull
public String getAttrArn()

The Amazon Resource Name (ARN) of the user.

getAttrStatus

@Stability(value=Stable)
 @NotNull
public String getAttrStatus()

Indicates the user status.

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

getCfnProperties

@Stability(value=Stable)
 @NotNull
protected Map<String,Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getEngine

@Stability(value=Stable)
 @NotNull
public String getEngine()

The current supported value is redis.

setEngine

@Stability(value=Stable)
public void setEngine(@NotNull
                                               String value)

The current supported value is redis.

getUserId

@Stability(value=Stable)
 @NotNull
public String getUserId()

The ID of the user.

setUserId

@Stability(value=Stable)
public void setUserId(@NotNull
                                               String value)

The ID of the user.

getUserName

@Stability(value=Stable)
 @NotNull
public String getUserName()

The username of the user.

setUserName

@Stability(value=Stable)
public void setUserName(@NotNull
                                                 String value)

The username of the user.

getAccessString

@Stability(value=Stable)
 @Nullable
public String getAccessString()

Access permissions string used for this user.

setAccessString

@Stability(value=Stable)
public void setAccessString(@Nullable
                                                     String value)

Access permissions string used for this user.

getNoPasswordRequired

@Stability(value=Stable)
 @Nullable
public Object getNoPasswordRequired()

Indicates a password is not required for this user.

setNoPasswordRequired

@Stability(value=Stable)
public void setNoPasswordRequired(@Nullable
                                                           Boolean value)

Indicates a password is not required for this user.

setNoPasswordRequired

@Stability(value=Stable)
public void setNoPasswordRequired(@Nullable
                                                           IResolvable value)

Indicates a password is not required for this user.

getPasswords

@Stability(value=Stable)
 @Nullable
public List<String> getPasswords()

Passwords used for this user.

You can create up to two passwords for each user.

setPasswords

@Stability(value=Stable)
public void setPasswords(@Nullable
                                                  List<String> value)

Passwords used for this user.

You can create up to two passwords for each user.