Experimental
@aws-cdk/aws-elasticache-alpha is an experimental (alpha) package: its API may change in any release, without a major version bump.
IamUserProps Struct
Properties for defining an ElastiCache user with IAM authentication.
| Stability | Experimental |
|---|---|
| Source | lib/iam-user.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"),
});
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")),
})
Properties
accessControlAccessControlaccess_controlAccessControlaccessControlAccessControlAccessControlAccessControlAccessControlAccessControl required #Access control configuration for the user.
engineoptionalUserEngineengineoptionalUserEngineengineoptionalUserEngineEngineoptionalUserEngineEngineoptionalUserEngine #The engine type for the user.
Default: UserEngine.REDIS for NoPasswordUser, UserEngine.VALKEY for all other user types.
Enum options: UserEngine.VALKEY, UserEngine.REDIS.
The ID of the user.
userNameoptionalstringuser_nameoptionalstruserNameoptionalStringUserNameoptionalstringUserNameoptional*string #The name of the user.
Default: Same as userId.