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.
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"),
});
python
user = elasticache.IamUser(self, "User",
# set user engine
engine=elasticache.UserEngine.REDIS,
# set user id
user_id="my-user",
# set username
user_name="my-user",
# set access string
access_control=elasticache.AccessControl.from_access_string("on ~* +@all")
)
java
IamUser user = IamUser.Builder.create(this, "User")
// set user engine
.engine(UserEngine.REDIS)
// set user id
.userId("my-user")
// set username
.userName("my-user")
// set access string
.accessControl(AccessControl.fromAccessString("on ~* +@all"))
.build();
csharp
// Install: dotnet add package Amazon.CDK.AWS.ElastiCache.Alpha
var user = new IamUser(this, "User", new IamUserProps {
// set user engine
Engine = UserEngine.REDIS,
// set user id
UserId = "my-user",
// set username
UserName = "my-user",
// set access string
AccessControl = AccessControl.FromAccessString("on ~* +@all")
});
go
// Install: go get github.com/aws/aws-cdk-go/awscdkelasticachealpha/v2
user := elasticache.NewIamUser(this, jsii.String("User"), &IamUserProps{
// set user engine
Engine: elasticache.UserEngine_REDIS(),
// set user id
UserId: jsii.String("my-user"),
// set username
UserName: jsii.String("my-user"),
// set access string
AccessControl: elasticache.AccessControl_FromAccessString(jsii.String("on ~* +@all")),
})
Initializer
ts
new AccessControl()
python
AccessControl()
java
new AccessControl()
csharp
new AccessControl()
go
NewAccessControl()
Properties
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.