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
,ITaggable
,software.amazon.jsii.JsiiSerializable
,software.constructs.IConstruct
,software.constructs.IDependable
@Generated(value="jsii-pacmak/1.104.0 (build e79254c)",
date="2024-11-27T16:50:57.472Z")
@Stability(Stable)
public class CfnUser
extends CfnResource
implements IInspectable, ITaggable
For Valkey 7.2 and onwards, or Redis OSS engine version 6.0 and onwards: Creates 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.*; Object authenticationMode; CfnUser cfnUser = CfnUser.Builder.create(this, "MyCfnUser") .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:
-
Nested Class Summary
Modifier and TypeClassDescriptionstatic interface
Specifies the authentication mode to use.static final class
A fluent builder forCfnUser
.Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject
software.amazon.jsii.JsiiObject.InitializationMode
Nested classes/interfaces inherited from interface software.constructs.IConstruct
software.constructs.IConstruct.Jsii$Default
Nested classes/interfaces inherited from interface software.amazon.awscdk.IInspectable
IInspectable.Jsii$Default, IInspectable.Jsii$Proxy
Nested classes/interfaces inherited from interface software.amazon.awscdk.ITaggable
ITaggable.Jsii$Default, ITaggable.Jsii$Proxy
-
Field Summary
Modifier and TypeFieldDescriptionstatic final String
The CloudFormation resource type name for this resource class. -
Constructor Summary
ModifierConstructorDescriptionprotected
CfnUser
(software.amazon.jsii.JsiiObject.InitializationMode initializationMode) protected
CfnUser
(software.amazon.jsii.JsiiObjectRef objRef) CfnUser
(software.constructs.Construct scope, String id, CfnUserProps props) -
Method Summary
Modifier and TypeMethodDescriptionAccess permissions string used for this user.The Amazon Resource Name (ARN) of the user.Indicates the user status.Specifies the authentication mode to use.The current supported value is redis.Indicates a password is not required for this user.Passwords used for this user.getTags()
Tag Manager which manages the tags for this resource.The list of tags.The ID of the user.The username of the user.void
inspect
(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.renderProperties
(Map<String, Object> props) void
setAccessString
(String value) Access permissions string used for this user.void
setAuthenticationMode
(Object value) Specifies the authentication mode to use.void
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
setTagsRaw
(List<CfnTag> value) The list of tags.void
The ID of the user.void
setUserName
(String value) The username of the user.Methods inherited from class software.amazon.awscdk.CfnResource
addDeletionOverride, addDependency, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, getUpdatedProperties, isCfnResource, obtainDependencies, obtainResourceDependencies, removeDependency, replaceDependency, 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 Details
-
CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.
-
-
Constructor Details
-
CfnUser
protected CfnUser(software.amazon.jsii.JsiiObjectRef objRef) -
CfnUser
protected CfnUser(software.amazon.jsii.JsiiObject.InitializationMode initializationMode) -
CfnUser
@Stability(Stable) public CfnUser(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull CfnUserProps props) - 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.props
- Resource properties. This parameter is required.
-
-
Method Details
-
inspect
Examines the CloudFormation resource and discloses attributes.- Specified by:
inspect
in interfaceIInspectable
- Parameters:
inspector
- tree inspector to collect and process attributes. This parameter is required.
-
renderProperties
@Stability(Stable) @NotNull protected Map<String,Object> renderProperties(@NotNull Map<String, Object> props) - Overrides:
renderProperties
in classCfnResource
- Parameters:
props
- This parameter is required.
-
getAttrArn
The Amazon Resource Name (ARN) of the user. -
getAttrStatus
Indicates the user status.Can be "active", "modifying" or "deleting".
-
getCfnProperties
- Overrides:
getCfnProperties
in classCfnResource
-
getTags
Tag Manager which manages the tags for this resource. -
getEngine
The current supported value is redis. -
setEngine
The current supported value is redis. -
getUserId
The ID of the user. -
setUserId
The ID of the user. -
getUserName
The username of the user. -
setUserName
The username of the user. -
getAccessString
Access permissions string used for this user. -
setAccessString
Access permissions string used for this user. -
getAuthenticationMode
Specifies the authentication mode to use.Below is an example of the possible JSON values:.
-
setAuthenticationMode
Specifies the authentication mode to use.Below is an example of the possible JSON values:.
-
getNoPasswordRequired
Indicates a password is not required for this user. -
setNoPasswordRequired
Indicates a password is not required for this user. -
setNoPasswordRequired
Indicates a password is not required for this user. -
getPasswords
Passwords used for this user. -
setPasswords
Passwords used for this user. -
getTagsRaw
The list of tags. -
setTagsRaw
The list of tags.
-