AWS CDK Reference

Appearance

v2.273.0

Experimental

@aws-cdk/aws-elasticache-alpha is an experimental (alpha) package: its API may change in any release, without a major version bump.

AccessControl Class ​

Access control configuration for ElastiCache users.

Stability
Experimental
Source
lib/user-base.ts

Example ​

ts
const user = new elasticache.IamUser(this, 'User', {
  // set user engine
  engine: elasticache.UserEngine.REDIS,

  // set user id
  userId: 'my-user',

  // set username
  userName: 'my-user',

  // set access string
  accessControl: elasticache.AccessControl.fromAccessString("on ~* +@all"),
});

Initializer ​

ts
new AccessControl()
python
AccessControl()
java
new AccessControl()
csharp
new AccessControl()
go
NewAccessControl()

Properties ​

accessStringstringaccess_stringstraccessStringStringAccessStringstringAccessString*stringrequired#
The access string that defines user's permissions.

Methods ​

fromAccessString(accessString: string): AccessControl // chainable@staticmethod def from_access_string(access_string: str) -> AccessControlpublic static AccessControl fromAccessString(String accessString)public static AccessControl FromAccessString(string accessString)func FromAccessString(AccessString *string) AccessControlstatic#
Create access control from an access string.
1 parameter

Parameters

  • accessStringaccess_stringaccessStringaccessStringAccessString — The access string defining user permissions.